Skip to contentSkip to conversation

xstrtol() fixes

PATCH In review Alejandro Colomar 1 participant 5 messages Jul 19, 2024 Library code

lore
Share & tools
lore
#0 lore raw

cover xstrtol() fixes

Hi Paul,

This patch set --hopefully; writing calls to strtol(3) is a PITA-- fixes the remaining issues I've observed in xstrtol().

Have a lovely day!
Alex

Alejandro Colomar (2):
xstrtol: Correctly handle an invalid base
xstrtol: Add defensive check against undocumented errors

 lib/xstrtol.c | 35 +++++++++++++++++++++--------------
 1 file changed, 21 insertions(+), 14 deletions(-)

Range-diff against v0:

-:  ---------- > 1:  9345449d79 xstrtol: Correctly handle an invalid base
-:  ---------- > 2:  d1836c207a xstrtol: Add defensive check against undocumented errors
Signature · 1 line
2.45.2
#1 lore raw

PATCH 1/2 xstrtol: Correctly handle an invalid base

strtol(3) doesn't set the end pointer if the base is invalid. This allows a caller to differentiate between "invalid base" (what strtoi(3bsd) calls EINVAL) and an "no digits seen" (what strtoi(3bsd) calls ECANCELED) in systems that report EINVAL on no digits seen (POSIX allows this).

	strtol("foo", &e, 0);
	strtol("0", &e, -1);

The former call will set e = nptr.
The latter will leave e untouched.

The caller has no other way to portably differentiate the calls.

The way to differentiate those, thus, is to initialize e = NULL, to allow reading it after the call.

While doing this, change the behavior of this function to only set *endptr if strtol(3) has set it, leaving it untouched otherwise.

Fixes 034a18049cbc (2014-12-20, "assure: new module")
Fixes 64ddc975e72c (2024-07-18, "xstrtol: document and stray less from strtol")
Cc Paul Eggert <[email protected]>
Cc Bruno Haible <[email protected]>
Cc Đoàn Trần Công Danh <[email protected]>
Cc Eli Schwartz <[email protected]>
Cc Sam James <[email protected]>
Cc Serge Hallyn <[email protected]>
Cc Iker Pedrosa <[email protected]>
Cc Michael Vetter <[email protected]>
---
 lib/xstrtol.c | 35 +++++++++++++++++++++--------------
 1 file changed, 21 insertions(+), 14 deletions(-)
lib/xstrtol.c +21 -14
index c3145171f3..592673557f 100644
@@ -71,9 +71,7 @@ strtol_error
 __xstrtol (char const *nptr, char **endptr, int base,
            __strtol_t *val, char const *valid_suffixes)
 {
-  char *t_ptr;
-  char **p = endptr ? endptr : &t_ptr;
-  *p = (char *) nptr;
+  char *e = NULL;
 
   if (! TYPE_SIGNED (__strtol_t))
     {
@@ -82,14 +80,21 @@ __xstrtol (char const *nptr, char **endptr, int base,
       while (isspace (ch))
         ch = *++q;
       if (ch == '-')
-        return LONGINT_INVALID;
+        {
+          if (endptr)
+            *endptr = (char *) nptr;
+          return LONGINT_INVALID;
+        }
     }
 
   errno = 0;
-  __strtol_t tmp = __strtol (nptr, p, base);
+  __strtol_t tmp = __strtol (nptr, &e, base);
   strtol_error err = LONGINT_OK;
 
-  if (*p == nptr)
+  if (endptr && e)
+    *endptr = e;
+
+  if (e == nptr)
     {
       /* If there is no number but there is a valid suffix, assume the
          number is 1.  The string is invalid otherwise.  */
@@ -113,19 +118,19 @@ __xstrtol (char const *nptr, char **endptr, int base,
       return err;
     }
 
-  if (**p != '\0')
+  if (*e != '\0')
     {
       int xbase = 1024;
       int suffixes = 1;
       strtol_error overflow;
 
-      if (!strchr (valid_suffixes, **p))
+      if (!strchr (valid_suffixes, *e))
         {
           *val = tmp;
           return err | LONGINT_INVALID_SUFFIX_CHAR;
         }
 
-      switch (**p)
+      switch (*e)
         {
         case 'E': case 'G': case 'g': case 'k': case 'K': case 'M': case 'm':
         case 'P': case 'Q': case 'R': case 'T': case 't': case 'Y': case 'Z':
@@ -138,10 +143,10 @@ __xstrtol (char const *nptr, char **endptr, int base,
              power-of-1024.  */
 
           if (strchr (valid_suffixes, '0'))
-            switch (p[0][1])
+            switch (e[1])
               {
               case 'i':
-                if (p[0][2] == 'B')
+                if (e[2] == 'B')
                   suffixes += 2;
                 break;
 
@@ -153,7 +158,7 @@ __xstrtol (char const *nptr, char **endptr, int base,
               }
         }
 
-      switch (**p)
+      switch (*e)
         {
         case 'b':
           overflow = bkm_scale (&tmp, 512);
@@ -224,8 +229,10 @@ __xstrtol (char const *nptr, char **endptr, int base,
         }
 
       err |= overflow;
-      *p += suffixes;
-      if (**p)
+      e += suffixes;
+      if (endptr)
+        *endptr = e;
+      if (*e)
         err |= LONGINT_INVALID_SUFFIX_CHAR;
     }
 
Signature · 1 line
2.45.2
#2 lore raw

Re: [PATCH v1 1/2] xstrtol: Correctly handle an invalid base

Hi Paul,

Quoted 14 lines · Alejandro Colomar

strtol(3) doesn't set the end pointer if the base is invalid. This allows a caller to differentiate between "invalid base" (what strtoi(3bsd) calls EINVAL) and an "no digits seen" (what strtoi(3bsd) calls ECANCELED) in systems that report EINVAL on no digits seen (POSIX allows this).

	strtol("foo", &e, 0);
	strtol("0", &e, -1);

The former call will set e = nptr.
The latter will leave e untouched.

The caller has no other way to portably differentiate the calls.

Quoted 7 lines

The way to differentiate those, thus, is to initialize e = NULL, to allow reading it after the call.

While doing this, change the behavior of this function to only set *endptr if strtol(3) has set it, leaving it untouched otherwise.

Fixes 034a18049cbc (2014-12-20, "assure: new module")

Self-correction: I had a typo while running git-blame(1), which led me to not find that the assure() call already existed --as assert()-- before your commit, Paul.

It was actually introduced in 3af47ca3f67 (1994-12-20, ".").

Please amend the Fixes tags to:

	Fixes: 3af47ca3f67 (1994-12-20, ".")
	Fixes: 64ddc975e72c (2024-07-18, "xstrtol: document and stray less from strtol")

Sorry for the confusion!

Cheers,
Alex

Quoted 116 lines
Fixes 64ddc975e72c (2024-07-18, "xstrtol: document and stray less from strtol")
Cc Paul Eggert <[email protected]>
Cc Bruno Haible <[email protected]>
Cc Đoàn Trần Công Danh <[email protected]>
Cc Eli Schwartz <[email protected]>
Cc Sam James <[email protected]>
Cc Serge Hallyn <[email protected]>
Cc Iker Pedrosa <[email protected]>
Cc Michael Vetter <[email protected]>
---
 lib/xstrtol.c | 35 +++++++++++++++++++++--------------
 1 file changed, 21 insertions(+), 14 deletions(-)
lib/xstrtol.c +21 -14
index c3145171f3..592673557f 100644
@@ -71,9 +71,7 @@ strtol_error
 __xstrtol (char const *nptr, char **endptr, int base,
            __strtol_t *val, char const *valid_suffixes)
 {
-  char *t_ptr;
-  char **p = endptr ? endptr : &t_ptr;
-  *p = (char *) nptr;
+  char *e = NULL;
 
   if (! TYPE_SIGNED (__strtol_t))
     {
@@ -82,14 +80,21 @@ __xstrtol (char const *nptr, char **endptr, int base,
       while (isspace (ch))
         ch = *++q;
       if (ch == '-')
-        return LONGINT_INVALID;
+        {
+          if (endptr)
+            *endptr = (char *) nptr;
+          return LONGINT_INVALID;
+        }
     }
 
   errno = 0;
-  __strtol_t tmp = __strtol (nptr, p, base);
+  __strtol_t tmp = __strtol (nptr, &e, base);
   strtol_error err = LONGINT_OK;
 
-  if (*p == nptr)
+  if (endptr && e)
+    *endptr = e;
+
+  if (e == nptr)
     {
       /* If there is no number but there is a valid suffix, assume the
          number is 1.  The string is invalid otherwise.  */
@@ -113,19 +118,19 @@ __xstrtol (char const *nptr, char **endptr, int base,
       return err;
     }
 
-  if (**p != '\0')
+  if (*e != '\0')
     {
       int xbase = 1024;
       int suffixes = 1;
       strtol_error overflow;
 
-      if (!strchr (valid_suffixes, **p))
+      if (!strchr (valid_suffixes, *e))
         {
           *val = tmp;
           return err | LONGINT_INVALID_SUFFIX_CHAR;
         }
 
-      switch (**p)
+      switch (*e)
         {
         case 'E': case 'G': case 'g': case 'k': case 'K': case 'M': case 'm':
         case 'P': case 'Q': case 'R': case 'T': case 't': case 'Y': case 'Z':
@@ -138,10 +143,10 @@ __xstrtol (char const *nptr, char **endptr, int base,
              power-of-1024.  */
 
           if (strchr (valid_suffixes, '0'))
-            switch (p[0][1])
+            switch (e[1])
               {
               case 'i':
-                if (p[0][2] == 'B')
+                if (e[2] == 'B')
                   suffixes += 2;
                 break;
 
@@ -153,7 +158,7 @@ __xstrtol (char const *nptr, char **endptr, int base,
               }
         }
 
-      switch (**p)
+      switch (*e)
         {
         case 'b':
           overflow = bkm_scale (&tmp, 512);
@@ -224,8 +229,10 @@ __xstrtol (char const *nptr, char **endptr, int base,
         }
 
       err |= overflow;
-      *p += suffixes;
-      if (**p)
+      e += suffixes;
+      if (endptr)
+        *endptr = e;
+      if (*e)
         err |= LONGINT_INVALID_SUFFIX_CHAR;
     }
 
Signature · 1 line
2.45.2
Signature · 1 line
<https://www.alejandro-colomar.es/>
#3 lore raw

Re: [PATCH v1 1/2] xstrtol: Correctly handle an invalid base

Quoted 29 lines · Alejandro Colomar

Hi Paul,

Quoted 14 lines · Alejandro Colomar

strtol(3) doesn't set the end pointer if the base is invalid. This allows a caller to differentiate between "invalid base" (what strtoi(3bsd) calls EINVAL) and an "no digits seen" (what strtoi(3bsd) calls ECANCELED) in systems that report EINVAL on no digits seen (POSIX allows this).

	strtol("foo", &e, 0);
	strtol("0", &e, -1);

The former call will set e = nptr.
The latter will leave e untouched.

The caller has no other way to portably differentiate the calls.

Quoted 7 lines

The way to differentiate those, thus, is to initialize e = NULL, to allow reading it after the call.

While doing this, change the behavior of this function to only set *endptr if strtol(3) has set it, leaving it untouched otherwise.

Fixes 034a18049cbc (2014-12-20, "assure: new module")

Self-correction: I had a typo while running git-blame(1), which led me to not find that the assure() call already existed --as assert()-- before your commit, Paul.

Quoted 5 lines

It was actually introduced in 3af47ca3f67 (1994-12-20, ".").

Please amend the Fixes tags to:

	Fixes: 3af47ca3f67 (1994-12-20, ".")

Oops; For consistency, use 12 chars:

		3af47ca3f672
Quoted 128 lines
	Fixes: 64ddc975e72c (2024-07-18, "xstrtol: document and stray less from strtol")

Sorry for the confusion!

Cheers,
Alex

Quoted 116 lines
Fixes 64ddc975e72c (2024-07-18, "xstrtol: document and stray less from strtol")
Cc Paul Eggert <[email protected]>
Cc Bruno Haible <[email protected]>
Cc Đoàn Trần Công Danh <[email protected]>
Cc Eli Schwartz <[email protected]>
Cc Sam James <[email protected]>
Cc Serge Hallyn <[email protected]>
Cc Iker Pedrosa <[email protected]>
Cc Michael Vetter <[email protected]>
---
 lib/xstrtol.c | 35 +++++++++++++++++++++--------------
 1 file changed, 21 insertions(+), 14 deletions(-)
lib/xstrtol.c +21 -14
index c3145171f3..592673557f 100644
@@ -71,9 +71,7 @@ strtol_error
 __xstrtol (char const *nptr, char **endptr, int base,
            __strtol_t *val, char const *valid_suffixes)
 {
-  char *t_ptr;
-  char **p = endptr ? endptr : &t_ptr;
-  *p = (char *) nptr;
+  char *e = NULL;
 
   if (! TYPE_SIGNED (__strtol_t))
     {
@@ -82,14 +80,21 @@ __xstrtol (char const *nptr, char **endptr, int base,
       while (isspace (ch))
         ch = *++q;
       if (ch == '-')
-        return LONGINT_INVALID;
+        {
+          if (endptr)
+            *endptr = (char *) nptr;
+          return LONGINT_INVALID;
+        }
     }
 
   errno = 0;
-  __strtol_t tmp = __strtol (nptr, p, base);
+  __strtol_t tmp = __strtol (nptr, &e, base);
   strtol_error err = LONGINT_OK;
 
-  if (*p == nptr)
+  if (endptr && e)
+    *endptr = e;
+
+  if (e == nptr)
     {
       /* If there is no number but there is a valid suffix, assume the
          number is 1.  The string is invalid otherwise.  */
@@ -113,19 +118,19 @@ __xstrtol (char const *nptr, char **endptr, int base,
       return err;
     }
 
-  if (**p != '\0')
+  if (*e != '\0')
     {
       int xbase = 1024;
       int suffixes = 1;
       strtol_error overflow;
 
-      if (!strchr (valid_suffixes, **p))
+      if (!strchr (valid_suffixes, *e))
         {
           *val = tmp;
           return err | LONGINT_INVALID_SUFFIX_CHAR;
         }
 
-      switch (**p)
+      switch (*e)
         {
         case 'E': case 'G': case 'g': case 'k': case 'K': case 'M': case 'm':
         case 'P': case 'Q': case 'R': case 'T': case 't': case 'Y': case 'Z':
@@ -138,10 +143,10 @@ __xstrtol (char const *nptr, char **endptr, int base,
              power-of-1024.  */
 
           if (strchr (valid_suffixes, '0'))
-            switch (p[0][1])
+            switch (e[1])
               {
               case 'i':
-                if (p[0][2] == 'B')
+                if (e[2] == 'B')
                   suffixes += 2;
                 break;
 
@@ -153,7 +158,7 @@ __xstrtol (char const *nptr, char **endptr, int base,
               }
         }
 
-      switch (**p)
+      switch (*e)
         {
         case 'b':
           overflow = bkm_scale (&tmp, 512);
@@ -224,8 +229,10 @@ __xstrtol (char const *nptr, char **endptr, int base,
         }
 
       err |= overflow;
-      *p += suffixes;
-      if (**p)
+      e += suffixes;
+      if (endptr)
+        *endptr = e;
+      if (*e)
         err |= LONGINT_INVALID_SUFFIX_CHAR;
     }
 
Signature · 1 line
2.45.2
Signature · 1 line
<https://www.alejandro-colomar.es/>
Signature · 1 line
<https://www.alejandro-colomar.es/>
#4 lore raw

PATCH 2/2 xstrtol: Add defensive check against undocumented errors

In reply to Alejandro Colomar

strtod(3) calls malloc(3) in some systems. While strtol(3) doesn't, let's be cautious and write code that would be safe under a theoretical implementation of strtol(3) that could ENOMEM (and let's assume we don't know what 'e' will look like after such an error).

Some attempt of defensive error handling had been added in 790855e18a1d, but it was wrong, since it was assuming e!=nptr on such a case, which is not a reasonable assumption.

Fixes 790855e18a1d (2003-10-14, "Handle invalid suffixes and overflow independently, so that ...")
Cc Paul Eggert <[email protected]>
Cc Bruno Haible <[email protected]>
Cc Đoàn Trần Công Danh <[email protected]>
Cc Eli Schwartz <[email protected]>
Cc Sam James <[email protected]>
Cc Serge Hallyn <[email protected]>
Cc Iker Pedrosa <[email protected]>
Cc Michael Vetter <[email protected]>
---
 lib/xstrtol.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
lib/xstrtol.c +1 -1
index 592673557f..faa7b9fd4c 100644
@@ -94,7 +94,7 @@ __xstrtol (char const *nptr, char **endptr, int base,
   if (endptr && e)
     *endptr = e;
 
-  if (e == nptr)
+  if (e == nptr && (errno == 0 || errno == EINVAL))
     {
       /* If there is no number but there is a valid suffix, assume the
          number is 1.  The string is invalid otherwise.  */
Signature · 1 line
2.45.2