[XTF 0/4] Add strncmp(), strtol() and strtoul() functions

[XTF 0/4] Add strncmp(), strtol() and strtoul() functions

[Pawel Wieczorkiewicz]

Add FreeBSD's implementation of strtol() and strtoul() functions from:
https://github.com/freebsd/freebsd/blob/master/lib/libc/stdlib/strtoul.c

The FreeBSD code being added as a separate file (common/libc/strtol.c)
is under the BSD 3-clause license. Modification to COPYING file might
be needed.

Also add simple implementation of the strncmp() function.

Paul Semel (1):
  string: add freebds libc implementation of strtol()

Pawel Wieczorkiewicz (3):
  libc, strtol: Add isspace(), isdigit(), isxdigit(), isascii()
  libc, strtol: Add FreeBSD libc implementation of strtoul()
  libc: add strncmp() function

 build/files.mk          |   1 +
 common/lib.c            |   8 --
 common/libc/string.c    |  11 +++
 common/libc/strtol.c    | 201 ++++++++++++++++++++++++++++++++++++++++++++++++
 common/libc/vsnprintf.c |   8 --
 include/xtf/libc.h      |  35 +++++++++
 6 files changed, 248 insertions(+), 16 deletions(-)
 create mode 100644 common/libc/strtol.c

-- 
2.16.6




Amazon Development Center Germany GmbH
Krausenstr. 38
10117 Berlin
Geschaeftsfuehrung: Christian Schlaeger, Jonathan Weiss
Eingetragen am Amtsgericht Charlottenburg unter HRB 149173 B
Sitz: Berlin
Ust-ID: DE 289 237 879

[XTF 1/4] string: add freebds libc implementation of strtol()

[Pawel Wieczorkiewicz]

From: Paul Semel <phentex@amazon.de>

Added freebsd libc implementation of the strtol() function.
Original can be found here :
https://github.com/freebsd/freebsd/blob/master/lib/libc/stdlib/strtol.c

Signed-off-by: Paul Semel <phentex@amazon.de>
---
 build/files.mk       |   1 +
 common/libc/strtol.c | 135 +++++++++++++++++++++++++++++++++++++++++++++++++++
 include/xtf/libc.h   |   2 +
 3 files changed, 138 insertions(+)
 create mode 100644 common/libc/strtol.c

diff --git a/build/files.mk b/build/files.mk
index dfa27e4..ebc36aa 100644
--- a/build/files.mk
+++ b/build/files.mk
@@ -13,6 +13,7 @@ obj-perarch += $(ROOT)/common/lib.o
 obj-perarch += $(ROOT)/common/libc/stdio.o
 obj-perarch += $(ROOT)/common/libc/string.o
 obj-perarch += $(ROOT)/common/libc/vsnprintf.o
+obj-perarch += $(ROOT)/common/libc/strtol.o
 obj-perarch += $(ROOT)/common/report.o
 obj-perarch += $(ROOT)/common/setup.o
 obj-perarch += $(ROOT)/common/xenbus.o
diff --git a/common/libc/strtol.c b/common/libc/strtol.c
new file mode 100644
index 0000000..64ce621
--- /dev/null
+++ b/common/libc/strtol.c
@@ -0,0 +1,135 @@
+/*-
+ * Copyright (c) 1990, 1993
+ *  The Regents of the University of California.  All rights reserved.
+ *
+ * Copyright (c) 2011 The FreeBSD Foundation
+ * All rights reserved.
+ * Portions of this software were developed by David Chisnall
+ * under sponsorship from the FreeBSD Foundation.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+/*
+ * Convert a string to a long integer.
+ *
+ * Assumes that the upper and lower case
+ * alphabets and digits are each contiguous.
+ */
+
+#include <xtf/libc.h>
+
+long strtol(const char *nptr, char **endptr, int base)
+{
+    const char *s;
+    unsigned long acc;
+    char c;
+    unsigned long cutoff;
+    int neg, any, cutlim;
+
+    /*
+     * Skip white space and pick up leading +/- sign if any.
+     * If base is 0, allow 0x for hex and 0 for octal, else
+     * assume decimal; if base is already 16, allow 0x.
+     */
+    s = nptr;
+    do {
+        c = *s++;
+    } while ( c == ' ' );
+    if (c == '-') {
+        neg = 1;
+        c = *s++;
+    } else {
+        neg = 0;
+        if (c == '+')
+            c = *s++;
+    }
+    if ((base == 0 || base == 16) &&
+            c == '0' && (*s == 'x' || *s == 'X') &&
+            ((s[1] >= '0' && s[1] <= '9') ||
+             (s[1] >= 'A' && s[1] <= 'F') ||
+             (s[1] >= 'a' && s[1] <= 'f'))) {
+        c = s[1];
+        s += 2;
+        base = 16;
+    }
+    if (base == 0)
+        base = c == '0' ? 8 : 10;
+    acc = any = 0;
+    if (base < 2 || base > 36)
+        goto noconv;
+
+    /*
+     * Compute the cutoff value between legal numbers and illegal
+     * numbers.  That is the largest legal value, divided by the
+     * base.  An input number that is greater than this value, if
+     * followed by a legal input character, is too big.  One that
+     * is equal to this value may be valid or not; the limit
+     * between valid and invalid numbers is then based on the last
+     * digit.  For instance, if the range for longs is
+     * [-2147483648..2147483647] and the input base is 10,
+     * cutoff will be set to 214748364 and cutlim to either
+     * 7 (neg==0) or 8 (neg==1), meaning that if we have accumulated
+     * a value > 214748364, or equal but the next digit is > 7 (or 8),
+     * the number is too big, and we will return a range error.
+     *
+     * Set 'any' if any `digits' consumed; make it negative to indicate
+     * overflow.
+     */
+
+    cutoff = neg ? (unsigned long)-(LONG_MIN + LONG_MAX) + LONG_MAX
+        : LONG_MAX;
+    cutlim = cutoff % base;
+    cutoff /= base;
+    for ( ; ; c = *s++) {
+        if (c >= '0' && c <= '9')
+            c -= '0';
+        else if (c >= 'A' && c <= 'Z')
+            c -= 'A' - 10;
+        else if (c >= 'a' && c <= 'z')
+            c -= 'a' - 10;
+        else
+            break;
+        if (c >= base)
+            break;
+        if (any < 0 || acc > cutoff || (acc == cutoff && c > cutlim))
+            any = -1;
+        else {
+            any = 1;
+            acc *= base;
+            acc += c;
+        }
+    }
+    if (any < 0) {
+        acc = neg ? LONG_MIN : LONG_MAX;
+    } else if (!any) {
+noconv:
+        ;
+    } else if (neg)
+        acc = -acc;
+    if (endptr != NULL)
+        *endptr = (char *)(any ? s - 1 : nptr);
+    return (acc);
+}
diff --git a/include/xtf/libc.h b/include/xtf/libc.h
index 66f834b..f352f7f 100644
--- a/include/xtf/libc.h
+++ b/include/xtf/libc.h
@@ -35,6 +35,8 @@ void *memcpy(void *dst, const void *src, size_t n);
 int memcmp(const void *s1, const void *s2, size_t n);
 #define memcmp(s1, s2, n)           __builtin_memcmp(s1, s2, n)
 
+long strtol(const char *nptr, char **endptr, int base);
+
 size_t strnlen(const char *str, size_t max);
 
 int __printf(3, 0)
-- 
2.16.6




Amazon Development Center Germany GmbH
Krausenstr. 38
10117 Berlin
Geschaeftsfuehrung: Christian Schlaeger, Jonathan Weiss
Eingetragen am Amtsgericht Charlottenburg unter HRB 149173 B
Sitz: Berlin
Ust-ID: DE 289 237 879

[XTF 2/4] libc, strtol: Add isspace(), isdigit(), isxdigit(), isascii()

[Pawel Wieczorkiewicz]

These ctype.h derived helper functions simplify strtol() code and will
help simplify strtoul().

Signed-off-by: Pawel Wieczorkiewicz <wipawel@amazon.de>
---
 common/lib.c            |  8 --------
 common/libc/strtol.c    |  9 +++------
 common/libc/vsnprintf.c |  8 --------
 include/xtf/libc.h      | 29 +++++++++++++++++++++++++++++
 4 files changed, 32 insertions(+), 22 deletions(-)

diff --git a/common/lib.c b/common/lib.c
index acf4da1..7381a3a 100644
--- a/common/lib.c
+++ b/common/lib.c
@@ -3,14 +3,6 @@
 #include <xtf/hypercall.h>
 #include <xtf/xenstore.h>
 
-#ifndef isdigit
-/* Avoid pulling in all of ctypes just for this. */
-static int isdigit(int c)
-{
-    return c >= '0' && c <= '9';
-}
-#endif
-
 void __noreturn panic(const char *fmt, ...)
 {
     va_list args;
diff --git a/common/libc/strtol.c b/common/libc/strtol.c
index 64ce621..f85ac7a 100644
--- a/common/libc/strtol.c
+++ b/common/libc/strtol.c
@@ -57,7 +57,7 @@ long strtol(const char *nptr, char **endptr, int base)
     s = nptr;
     do {
         c = *s++;
-    } while ( c == ' ' );
+    } while ( isspace(c) );
     if (c == '-') {
         neg = 1;
         c = *s++;
@@ -67,10 +67,7 @@ long strtol(const char *nptr, char **endptr, int base)
             c = *s++;
     }
     if ((base == 0 || base == 16) &&
-            c == '0' && (*s == 'x' || *s == 'X') &&
-            ((s[1] >= '0' && s[1] <= '9') ||
-             (s[1] >= 'A' && s[1] <= 'F') ||
-             (s[1] >= 'a' && s[1] <= 'f'))) {
+            c == '0' && (*s == 'x' || *s == 'X') && isxdigit(s[1])) {
         c = s[1];
         s += 2;
         base = 16;
@@ -104,7 +101,7 @@ long strtol(const char *nptr, char **endptr, int base)
     cutlim = cutoff % base;
     cutoff /= base;
     for ( ; ; c = *s++) {
-        if (c >= '0' && c <= '9')
+        if (isdigit(c))
             c -= '0';
         else if (c >= 'A' && c <= 'Z')
             c -= 'A' - 10;
diff --git a/common/libc/vsnprintf.c b/common/libc/vsnprintf.c
index a49fd30..495c0a5 100644
--- a/common/libc/vsnprintf.c
+++ b/common/libc/vsnprintf.c
@@ -2,14 +2,6 @@
 #include <xtf/libc.h>
 #include <xtf/compiler.h>
 
-#ifndef isdigit
-/* Avoid pulling in all of ctypes just for this. */
-static int isdigit(int c)
-{
-    return c >= '0' && c <= '9';
-}
-#endif
-
 /*
  * The subset of formatting supported:
  *
diff --git a/include/xtf/libc.h b/include/xtf/libc.h
index f352f7f..0caa7d3 100644
--- a/include/xtf/libc.h
+++ b/include/xtf/libc.h
@@ -56,6 +56,35 @@ bool arch_fmt_pointer(
     char **str, char *end, const char **fmt_ptr, const void *arg,
     int width, int precision, unsigned int flags);
 
+#ifndef isspace
+static inline int isspace(int c)
+{
+    return c == ' ' || c == '\t';
+}
+#endif
+
+#ifndef isdigit
+static inline int isdigit(int c)
+{
+    return c >= '0' && c <= '9';
+}
+#endif
+
+#ifndef isxdigit
+static inline int isxdigit(int c)
+{
+    return (isdigit(c) || (c >= 'A' && c <= 'F') ||
+           (c >= 'a' && c <= 'f'));
+}
+#endif
+
+#ifndef isascii
+static inline int isascii(int c)
+{
+    return c >= 0 && c <= 127;
+}
+#endif
+
 #endif /* XTF_LIBC_H */
 
 /*
-- 
2.16.6




Amazon Development Center Germany GmbH
Krausenstr. 38
10117 Berlin
Geschaeftsfuehrung: Christian Schlaeger, Jonathan Weiss
Eingetragen am Amtsgericht Charlottenburg unter HRB 149173 B
Sitz: Berlin
Ust-ID: DE 289 237 879

[XTF 3/4] libc, strtol: Add FreeBSD libc implementation of strtoul()

[Pawel Wieczorkiewicz]

The function was derived from:
https://github.com/freebsd/freebsd/blob/master/lib/libc/stdlib/strtoul.c

Sligthly modified to use ctypes helpers and ignore locale.

Signed-off-by: Pawel Wieczorkiewicz <wipawel@amazon.de>
---
 common/libc/strtol.c | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 include/xtf/libc.h   |  1 +
 2 files changed, 70 insertions(+)

diff --git a/common/libc/strtol.c b/common/libc/strtol.c
index f85ac7a..66ba787 100644
--- a/common/libc/strtol.c
+++ b/common/libc/strtol.c
@@ -130,3 +130,72 @@ long strtol(const char *nptr, char **endptr, int base)
         *endptr = (char *)(any ? s - 1 : nptr);
     return (acc);
 }
+
+/*
+ * Convert a string to an unsigned long integer.
+ *
+ * Ignores `locale' stuff. Assumes that the upper and lower case
+ * alphabets and digits are each contiguous.
+ */
+unsigned long strtoul(const char *nptr, char **endptr, int base)
+{
+    const char *s = nptr;
+    unsigned long acc;
+    unsigned char c;
+    unsigned long cutoff;
+    int neg = 0, any, cutlim;
+
+    /*
+     * See strtol for comments as to the logic used.
+     */
+    do {
+        c = *s++;
+    } while (isspace(c));
+    if (c == '-') {
+        neg = 1;
+        c = *s++;
+    } else if (c == '+')
+        c = *s++;
+    if ((base == 0 || base == 16) &&
+            c == '0' && (*s == 'x' || *s == 'X') && isxdigit(s[1])) {
+        c = s[1];
+        s += 2;
+        base = 16;
+    }
+    if (base == 0)
+        base = c == '0' ? 8 : 10;
+    acc = any = 0;
+    if (base < 2 || base > 36)
+        goto noconv;
+
+    cutoff = (unsigned long)ULONG_MAX / (unsigned long)base;
+    cutlim = (unsigned long)ULONG_MAX % (unsigned long)base;
+    for ( ; ; c = *s++) {
+        if (isdigit(c))
+            c -= '0';
+        else if (c >= 'A' && c <= 'Z')
+            c -= 'A' - 10;
+        else if (c >= 'a' && c <= 'z')
+            c -= 'a' - 10;
+        else
+            break;
+        if (c >= base)
+            break;
+        if (any < 0 || acc > cutoff || (acc == cutoff && c > cutlim))
+            any = -1;
+        else {
+            any = 1;
+            acc *= base;
+            acc += c;
+        }
+    }
+    if (any < 0) {
+        acc = ULONG_MAX;
+    } else if (!any) {
+noconv: ;
+    } else if (neg)
+        acc = -acc;
+    if (endptr != NULL)
+        *endptr = (char *)(any ? s - 1 : nptr);
+    return (acc);
+}
diff --git a/include/xtf/libc.h b/include/xtf/libc.h
index 0caa7d3..75f193b 100644
--- a/include/xtf/libc.h
+++ b/include/xtf/libc.h
@@ -36,6 +36,7 @@ int memcmp(const void *s1, const void *s2, size_t n);
 #define memcmp(s1, s2, n)           __builtin_memcmp(s1, s2, n)
 
 long strtol(const char *nptr, char **endptr, int base);
+unsigned long strtoul(const char *nptr, char **endptr, int base);
 
 size_t strnlen(const char *str, size_t max);
 
-- 
2.16.6




Amazon Development Center Germany GmbH
Krausenstr. 38
10117 Berlin
Geschaeftsfuehrung: Christian Schlaeger, Jonathan Weiss
Eingetragen am Amtsgericht Charlottenburg unter HRB 149173 B
Sitz: Berlin
Ust-ID: DE 289 237 879

[XTF 4/4] libc: add strncmp() function

[Pawel Wieczorkiewicz]

Signed-off-by: Pawel Wieczorkiewicz <wipawel@amazon.de>
---
 common/libc/string.c | 11 +++++++++++
 include/xtf/libc.h   |  3 +++
 2 files changed, 14 insertions(+)

diff --git a/common/libc/string.c b/common/libc/string.c
index 5c25e27..d81e324 100644
--- a/common/libc/string.c
+++ b/common/libc/string.c
@@ -56,6 +56,17 @@ int (strcmp)(const char *_s1, const char *_s2)
     return (s1 < s2) ? -1 : (s1 > s2);
 }
 
+int (strncmp)(const char *_s1, const char *_s2, size_t n)
+{
+    size_t ctr;
+    for (ctr = 0; ctr < n; ctr++) {
+        if (_s1[ctr] != _s2[ctr])
+            return (int)(_s1[ctr] - _s2[ctr]);
+    }
+
+    return 0;
+}
+
 void *(memset)(void *s, int c, size_t n)
 {
     char *p = s;
diff --git a/include/xtf/libc.h b/include/xtf/libc.h
index 75f193b..c3783a8 100644
--- a/include/xtf/libc.h
+++ b/include/xtf/libc.h
@@ -26,6 +26,9 @@ char *strncpy(char *dst, const char *src, size_t n);
 int strcmp(const char *s1, const char *s2);
 #define strcmp(s1, s2)              __builtin_strcmp(s1, s2)
 
+int strncmp(const char *s1, const char *s2, size_t n);
+#define strncmp(s1, s2, n)          __builtin_strncmp(s1, s2, n)
+
 void *memset(void *s, int c, size_t n);
 #define memset(d, c, n)             __builtin_memset(d, c, n)
 
-- 
2.16.6




Amazon Development Center Germany GmbH
Krausenstr. 38
10117 Berlin
Geschaeftsfuehrung: Christian Schlaeger, Jonathan Weiss
Eingetragen am Amtsgericht Charlottenburg unter HRB 149173 B
Sitz: Berlin
Ust-ID: DE 289 237 879

Re: [XTF 0/4] Add strncmp(), strtol() and strtoul() functions

[Julien Grall]

On 23/04/2020 11:19, Pawel Wieczorkiewicz wrote:
> Add FreeBSD's implementation of strtol() and strtoul() functions from:
> https://github.com/freebsd/freebsd/blob/master/lib/libc/stdlib/strtoul.c

I would suggest to specify the baseline used in each commit. This will 
allows us to track any changes that was made afterwards (even if it 
seems unlikely) in the FreeBSD code base.


> 
> The FreeBSD code being added as a separate file (common/libc/strtol.c)
> is under the BSD 3-clause license. Modification to COPYING file might
> be needed.
> 
> Also add simple implementation of the strncmp() function.
> 
> Paul Semel (1):
>    string: add freebds libc implementation of strtol()
> 
> Pawel Wieczorkiewicz (3):
>    libc, strtol: Add isspace(), isdigit(), isxdigit(), isascii()
>    libc, strtol: Add FreeBSD libc implementation of strtoul()
>    libc: add strncmp() function
> 
>   build/files.mk          |   1 +
>   common/lib.c            |   8 --
>   common/libc/string.c    |  11 +++
>   common/libc/strtol.c    | 201 ++++++++++++++++++++++++++++++++++++++++++++++++
>   common/libc/vsnprintf.c |   8 --
>   include/xtf/libc.h      |  35 +++++++++
>   6 files changed, 248 insertions(+), 16 deletions(-)
>   create mode 100644 common/libc/strtol.c
> 

-- 
Julien Grall