payloads/libpayload/libc/string.c

   1 /*
   2  * This file is part of the libpayload project.
   3  *
   4  * Copyright (C) 2007 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2008 Advanced Micro Devices, Inc.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  */
  30
  31 #include <libpayload.h>
  32
  33 /**
  34  * Calculate the length of a fixed-size string.
  35  *
  36  * @param str The input string.
  37  * @param maxlen Return at most maxlen characters as length of the string.
  38  * @return The length of the string, not including the final NUL character.
  39  *         The maximum length returned is maxlen.
  40  */
  41 size_t strnlen(const char *str, size_t maxlen)
  42 {
  43         size_t len = 0;
  44
  45         /* NULL and empty strings have length 0. */
  46         if (!str)
  47                 return 0;
  48
  49         /* Loop until we find a NUL character, or maxlen is reached. */
  50         while ((*str++ != '\0') && (len < maxlen))
  51                 len++;
  52
  53         return len;
  54 }
  55
  56 /**
  57  * Calculate the length of a string.
  58  *
  59  * @param str The input string.
  60  * @return The length of the string, not including the final NUL character.
  61  */
  62 size_t strlen(const char *str)
  63 {
  64         size_t len = 0;
  65
  66         /* NULL and empty strings have length 0. */
  67         if (!str)
  68                 return 0;
  69
  70         /* Loop until we find a NUL character. */
  71         while (*str++ != '\0')
  72                 len++;
  73
  74         return len;
  75 }
  76
  77 /**
  78  * Compare two strings.
  79  *
  80  * @param s1 The first string.
  81  * @param s2 The second string.
  82  * @return Returns a value less than zero, if s1 is shorter than s2. Returns
  83  *         zero, if s1 equals s2. Returns a value greater than zero, if
  84  *         s1 is longer than s2.
  85  */
  86 int strcmp(const char *s1, const char *s2)
  87 {
  88         char c1, c2;
  89
  90         /* Set c1 == c2, so that we can enter the while loop. */
  91         c1 = 0;
  92         c2 = 0;
  93
  94         /* Compare characters until they differ, or one of the strings ends. */
  95         while (c1 == c2) {
  96                 /* Read the next character from each string. */
  97                 c1 = *s1++;
  98                 c2 = *s2++;
  99
 100                 /* Return something negative (if s1 is shorter than s2), or
 101                    zero (if s1 equals s2). */
 102                 if (c1 == '\0')
 103                         return c1 - c2;
 104         }
 105
 106         /* Return something positive (if s1 is longer than s2), or zero (if s1
 107            and s2 are equal). */
 108         return c1 - c2;
 109 }
 110
 111 /**
 112  * Compare two strings with fixed length.
 113  *
 114  * @param s1 The first string.
 115  * @param s2 The second string.
 116  * @param maxlen Return at most maxlen characters as length of the string.
 117  * @return A non-zero value if s1 and s2 differ, or zero if s1 equals s2.
 118  */
 119 int strncmp(const char *s1, const char *s2, size_t maxlen)
 120 {
 121         int i;
 122
 123         for (i = 0; i < maxlen; i++) {
 124                 if (s1[i] != s2[i])
 125                         return s1[i] - s2[i];
 126         }
 127
 128         return 0;
 129 }
 130
 131 /**
 132  * Copy a string with a maximum length.
 133  *
 134  * @param d The destination memory.
 135  * @param s The source string.
 136  * @param n Copy at most n characters as length of the string.
 137  * @return A pointer to the destination memory.
 138  */
 139 char *strncpy(char *d, const char *s, size_t n)
 140 {
 141         /* Use +1 to get the NUL terminator. */
 142         int max = n > strlen(s) + 1 ? strlen(s) + 1 : n;
 143         int i;
 144
 145         for (i = 0; i < max; i++)
 146                 d[i] = (char)s[i];
 147
 148         return d;
 149 }
 150
 151 /**
 152  * Copy a string.
 153  *
 154  * @param d The destination memory.
 155  * @param s The source string.
 156  * @return A pointer to the destination memory.
 157  */
 158 char *strcpy(char *d, const char *s)
 159 {
 160         return strncpy(d, s, strlen(s) + 1);
 161 }
 162
 163 /**
 164  * Concatenates two strings with a maximum length.
 165  *
 166  * @param d The destination string.
 167  * @param s The source string.
 168  * @param n Not more than n characters from s will be appended to d.
 169  * @return A pointer to the destination string.
 170  */
 171 char *strncat(char *d, const char *s, size_t n)
 172 {
 173         char *p = d + strlen(d);
 174         int sl = strlen(s);
 175         int max = n > sl ? sl : n;
 176         // int max = n > strlen(s) ? strlen(s) : n;
 177         int i;
 178
 179         for (i = 0; i < max; i++)
 180                 p[i] = s[i];
 181
 182         p[i] = '\0';
 183         return d;
 184 }
 185
 186 /**
 187  * Concatenates two strings with a maximum length.
 188  *
 189  * @param d The destination string.
 190  * @param s The source string.
 191  * @param n Not more than n characters from s will be appended to d.
 192  * @return A pointer to the destination string.
 193  */
 194 size_t strlcat(char *d, const char *s, size_t n)
 195 {
 196         int sl = strlen(s);
 197         int dl = strlen(d);
 198
 199         char *p = d + dl;
 200         int max = n > (sl + dl) ? sl : (n - dl - 1);
 201         int i;
 202
 203         for (i = 0; i < max; i++)
 204                 p[i] = s[i];
 205
 206         p[i] = '\0';
 207         return max;
 208 }
 209
 210 /**
 211  * Find a character in a string.
 212  *
 213  * @param s The string.
 214  * @param c The character.
 215  * @return A pointer to the first occurence of the character in the
 216  * string, or NULL if the character was not encountered within the string.
 217  */
 218 char *strchr(const char *s, int c)
 219 {
 220         char *p = (char *)s;
 221
 222         for (; *p != 0; p++) {
 223                 if (*p == c)
 224                         return p;
 225         }
 226
 227         return NULL;
 228 }
 229
 230 /**
 231  * Find a character in a string.
 232  *
 233  * @param s The string.
 234  * @param c The character.
 235  * @return A pointer to the last occurence of the character in the
 236  * string, or NULL if the character was not encountered within the string.
 237  */
 238
 239 char *strrchr(const char *s, int c)
 240 {
 241         char *p = (char *)s + strlen(s);
 242
 243         for (; p >= s; p--) {
 244                 if (*p == c)
 245                         return p;
 246         }
 247
 248         return NULL;
 249 }
 250
 251 /**
 252  * Duplicate a string.
 253  *
 254  * @param s The string to duplicate.
 255  * @return A pointer to the copy of the original string.
 256  */
 257 char *strdup(const char *s)
 258 {
 259         int n = strlen(s);
 260         char *p = malloc(n + 1);
 261
 262         if (p != NULL) {
 263                 strncpy(p, s, n);
 264                 p[n] = 0;
 265         }
 266         return p;
 267 }
 268
 269 /**
 270  * Find a substring within a string.
 271  *
 272  * @param h The haystack string.
 273  * @param n The needle string (substring).
 274  * @return A pointer to the first occurence of the substring in
 275  * the string, or NULL if the substring was not encountered within the string.
 276  */
 277 char *strstr(const char *h, const char *n)
 278 {
 279         int hn = strlen(h);
 280         int nn = strlen(n);
 281         int i;
 282
 283         for (i = 0; i <= hn - nn; i++)
 284                 if (!memcmp(&h[i], n, nn))
 285                         return (char *)&h[i];
 286
 287         return NULL;
 288 }
 289
 290 /**
 291  * Separate strings.
 292  *
 293  * @param stringp reference of the string to separate.
 294  * @param delim string containing all delimiters.
 295  * @return Token string.
 296  */
 297 char *strsep(char **stringp, const char *delim)
 298 {
 299         char *walk, *token;
 300
 301         if (!stringp || !*stringp || !**stringp)
 302                 return NULL;
 303
 304         token = walk = *stringp;
 305
 306         /* Walk, search for delimiters */
 307         while(*walk && !strchr(delim, *walk))
 308                 walk++;
 309
 310         if (*walk) {
 311                 /* NUL terminate */
 312                 *walk = '\0';
 313                 walk++;
 314         }
 315
 316         *stringp = walk;
 317
 318         return token;
 319 }
 320
 321 /* Check that a character is in the valid range for the
 322    given base
 323 */
 324
 325 static int _valid(char ch, int base)
 326 {
 327         char end = (base > 9) ? '9' : '0' + (base - 1);
 328
 329         /* all bases will be some subset of the 0-9 range */
 330
 331         if (ch >= '0' && ch <= end)
 332                 return 1;
 333
 334         /* Bases > 11 will also have to match in the a-z range */
 335
 336         if (base > 11) {
 337                 if (tolower(ch) >= 'a' &&
 338                     tolower(ch) <= 'a' + (base - 11))
 339                         return 1;
 340         }
 341
 342         return 0;
 343 }
 344
 345 /* Return the "value" of the character in the given base */
 346
 347 static int _offset(char ch, int base)
 348 {
 349         if (ch >= '0' && ch <= '9')
 350                 return ch - '0';
 351         else
 352                 return tolower(ch) - 'a';
 353 }
 354
 355 /**
 356  * Convert the initial portion of a string into an unsigned int
 357  * @param ptr A pointer to the string to convert
 358  * @param endptr A pointer to the unconverted part of the string
 359  * @param base The base of the number to convert, or 0 for auto
 360  * @return An unsigned integer representation of the string
 361  */
 362
 363 unsigned int strtoul(const char *ptr, char **endptr, int base)
 364 {
 365         int ret = 0;
 366
 367         if (endptr != NULL)
 368                 *endptr = (char *) ptr;
 369
 370         /* Purge whitespace */
 371
 372         for( ; *ptr && isspace(*ptr); ptr++);
 373
 374         if (!*ptr)
 375                 return 0;
 376
 377         /* Determine the base */
 378
 379         if (base == 0) {
 380                 if (ptr[0] == '0' && (ptr[1] == 'x' || ptr[1] == 'X'))
 381                         base = 16;
 382                 else if (ptr[0] == '0') {
 383                         base = 8;
 384                         ptr++;
 385                 }
 386                 else
 387                         base = 10;
 388         }
 389
 390         /* Base 16 allows the 0x on front - so skip over it */
 391
 392         if (base == 16) {
 393                 if (ptr[0] == '0' && (ptr[1] == 'x' || ptr[1] == 'X'))
 394                         ptr += 2;
 395         }
 396
 397         /* If the first character isn't valid, then don't
 398          * bother */
 399
 400         if (!*ptr || !_valid(*ptr, base))
 401                 return 0;
 402
 403         for( ; *ptr && _valid(*ptr, base); ptr++)
 404                 ret = (ret * base) + _offset(*ptr, base);
 405
 406         if (endptr != NULL)
 407                 *endptr = (char *) ptr;
 408
 409         return ret;
 410 }
 411
 412