string: Add strchrnul()
[oweals/u-boot.git] / lib / string.c
1 /*
2  *  linux/lib/string.c
3  *
4  *  Copyright (C) 1991, 1992  Linus Torvalds
5  */
6
7 /*
8  * stupid library routines.. The optimized versions should generally be found
9  * as inline code in <asm-xx/string.h>
10  *
11  * These are buggy as well..
12  *
13  * * Fri Jun 25 1999, Ingo Oeser <ioe@informatik.tu-chemnitz.de>
14  * -  Added strsep() which will replace strtok() soon (because strsep() is
15  *    reentrant and should be faster). Use only strsep() in new code, please.
16  */
17
18 #include <linux/types.h>
19 #include <linux/string.h>
20 #include <linux/ctype.h>
21 #include <malloc.h>
22
23
24 /**
25  * strncasecmp - Case insensitive, length-limited string comparison
26  * @s1: One string
27  * @s2: The other string
28  * @len: the maximum number of characters to compare
29  */
30 int strncasecmp(const char *s1, const char *s2, size_t len)
31 {
32         /* Yes, Virginia, it had better be unsigned */
33         unsigned char c1, c2;
34
35         c1 = 0; c2 = 0;
36         if (len) {
37                 do {
38                         c1 = *s1; c2 = *s2;
39                         s1++; s2++;
40                         if (!c1)
41                                 break;
42                         if (!c2)
43                                 break;
44                         if (c1 == c2)
45                                 continue;
46                         c1 = tolower(c1);
47                         c2 = tolower(c2);
48                         if (c1 != c2)
49                                 break;
50                 } while (--len);
51         }
52         return (int)c1 - (int)c2;
53 }
54
55 /**
56  * strcasecmp - Case insensitive string comparison
57  * @s1: One string
58  * @s2: The other string
59  */
60 int strcasecmp(const char *s1, const char *s2)
61 {
62         return strncasecmp(s1, s2, -1U);
63 }
64
65 char * ___strtok;
66
67 #ifndef __HAVE_ARCH_STRCPY
68 /**
69  * strcpy - Copy a %NUL terminated string
70  * @dest: Where to copy the string to
71  * @src: Where to copy the string from
72  */
73 char * strcpy(char * dest,const char *src)
74 {
75         char *tmp = dest;
76
77         while ((*dest++ = *src++) != '\0')
78                 /* nothing */;
79         return tmp;
80 }
81 #endif
82
83 #ifndef __HAVE_ARCH_STRNCPY
84 /**
85  * strncpy - Copy a length-limited, %NUL-terminated string
86  * @dest: Where to copy the string to
87  * @src: Where to copy the string from
88  * @count: The maximum number of bytes to copy
89  *
90  * Note that unlike userspace strncpy, this does not %NUL-pad the buffer.
91  * However, the result is not %NUL-terminated if the source exceeds
92  * @count bytes.
93  */
94 char * strncpy(char * dest,const char *src,size_t count)
95 {
96         char *tmp = dest;
97
98         while (count-- && (*dest++ = *src++) != '\0')
99                 /* nothing */;
100
101         return tmp;
102 }
103 #endif
104
105 #ifndef __HAVE_ARCH_STRLCPY
106 /**
107  * strlcpy - Copy a C-string into a sized buffer
108  * @dest: Where to copy the string to
109  * @src: Where to copy the string from
110  * @size: size of destination buffer
111  *
112  * Compatible with *BSD: the result is always a valid
113  * NUL-terminated string that fits in the buffer (unless,
114  * of course, the buffer size is zero). It does not pad
115  * out the result like strncpy() does.
116  */
117 size_t strlcpy(char *dest, const char *src, size_t size)
118 {
119         size_t ret = strlen(src);
120
121         if (size) {
122                 size_t len = (ret >= size) ? size - 1 : ret;
123                 memcpy(dest, src, len);
124                 dest[len] = '\0';
125         }
126         return ret;
127 }
128 #endif
129
130 #ifndef __HAVE_ARCH_STRCAT
131 /**
132  * strcat - Append one %NUL-terminated string to another
133  * @dest: The string to be appended to
134  * @src: The string to append to it
135  */
136 char * strcat(char * dest, const char * src)
137 {
138         char *tmp = dest;
139
140         while (*dest)
141                 dest++;
142         while ((*dest++ = *src++) != '\0')
143                 ;
144
145         return tmp;
146 }
147 #endif
148
149 #ifndef __HAVE_ARCH_STRNCAT
150 /**
151  * strncat - Append a length-limited, %NUL-terminated string to another
152  * @dest: The string to be appended to
153  * @src: The string to append to it
154  * @count: The maximum numbers of bytes to copy
155  *
156  * Note that in contrast to strncpy, strncat ensures the result is
157  * terminated.
158  */
159 char * strncat(char *dest, const char *src, size_t count)
160 {
161         char *tmp = dest;
162
163         if (count) {
164                 while (*dest)
165                         dest++;
166                 while ((*dest++ = *src++)) {
167                         if (--count == 0) {
168                                 *dest = '\0';
169                                 break;
170                         }
171                 }
172         }
173
174         return tmp;
175 }
176 #endif
177
178 #ifndef __HAVE_ARCH_STRCMP
179 /**
180  * strcmp - Compare two strings
181  * @cs: One string
182  * @ct: Another string
183  */
184 int strcmp(const char * cs,const char * ct)
185 {
186         register signed char __res;
187
188         while (1) {
189                 if ((__res = *cs - *ct++) != 0 || !*cs++)
190                         break;
191         }
192
193         return __res;
194 }
195 #endif
196
197 #ifndef __HAVE_ARCH_STRNCMP
198 /**
199  * strncmp - Compare two length-limited strings
200  * @cs: One string
201  * @ct: Another string
202  * @count: The maximum number of bytes to compare
203  */
204 int strncmp(const char * cs,const char * ct,size_t count)
205 {
206         register signed char __res = 0;
207
208         while (count) {
209                 if ((__res = *cs - *ct++) != 0 || !*cs++)
210                         break;
211                 count--;
212         }
213
214         return __res;
215 }
216 #endif
217
218 #ifndef __HAVE_ARCH_STRCHR
219 /**
220  * strchr - Find the first occurrence of a character in a string
221  * @s: The string to be searched
222  * @c: The character to search for
223  */
224 char * strchr(const char * s, int c)
225 {
226         for(; *s != (char) c; ++s)
227                 if (*s == '\0')
228                         return NULL;
229         return (char *) s;
230 }
231 #endif
232
233 const char *strchrnul(const char *s, int c)
234 {
235         for (; *s != (char)c; ++s)
236                 if (*s == '\0')
237                         break;
238         return s;
239 }
240
241 #ifndef __HAVE_ARCH_STRRCHR
242 /**
243  * strrchr - Find the last occurrence of a character in a string
244  * @s: The string to be searched
245  * @c: The character to search for
246  */
247 char * strrchr(const char * s, int c)
248 {
249        const char *p = s + strlen(s);
250        do {
251            if (*p == (char)c)
252                return (char *)p;
253        } while (--p >= s);
254        return NULL;
255 }
256 #endif
257
258 #ifndef __HAVE_ARCH_STRLEN
259 /**
260  * strlen - Find the length of a string
261  * @s: The string to be sized
262  */
263 size_t strlen(const char * s)
264 {
265         const char *sc;
266
267         for (sc = s; *sc != '\0'; ++sc)
268                 /* nothing */;
269         return sc - s;
270 }
271 #endif
272
273 #ifndef __HAVE_ARCH_STRNLEN
274 /**
275  * strnlen - Find the length of a length-limited string
276  * @s: The string to be sized
277  * @count: The maximum number of bytes to search
278  */
279 size_t strnlen(const char * s, size_t count)
280 {
281         const char *sc;
282
283         for (sc = s; count-- && *sc != '\0'; ++sc)
284                 /* nothing */;
285         return sc - s;
286 }
287 #endif
288
289 #ifndef __HAVE_ARCH_STRDUP
290 char * strdup(const char *s)
291 {
292         char *new;
293
294         if ((s == NULL) ||
295             ((new = malloc (strlen(s) + 1)) == NULL) ) {
296                 return NULL;
297         }
298
299         strcpy (new, s);
300         return new;
301 }
302 #endif
303
304 #ifndef __HAVE_ARCH_STRSPN
305 /**
306  * strspn - Calculate the length of the initial substring of @s which only
307  *      contain letters in @accept
308  * @s: The string to be searched
309  * @accept: The string to search for
310  */
311 size_t strspn(const char *s, const char *accept)
312 {
313         const char *p;
314         const char *a;
315         size_t count = 0;
316
317         for (p = s; *p != '\0'; ++p) {
318                 for (a = accept; *a != '\0'; ++a) {
319                         if (*p == *a)
320                                 break;
321                 }
322                 if (*a == '\0')
323                         return count;
324                 ++count;
325         }
326
327         return count;
328 }
329 #endif
330
331 #ifndef __HAVE_ARCH_STRPBRK
332 /**
333  * strpbrk - Find the first occurrence of a set of characters
334  * @cs: The string to be searched
335  * @ct: The characters to search for
336  */
337 char * strpbrk(const char * cs,const char * ct)
338 {
339         const char *sc1,*sc2;
340
341         for( sc1 = cs; *sc1 != '\0'; ++sc1) {
342                 for( sc2 = ct; *sc2 != '\0'; ++sc2) {
343                         if (*sc1 == *sc2)
344                                 return (char *) sc1;
345                 }
346         }
347         return NULL;
348 }
349 #endif
350
351 #ifndef __HAVE_ARCH_STRTOK
352 /**
353  * strtok - Split a string into tokens
354  * @s: The string to be searched
355  * @ct: The characters to search for
356  *
357  * WARNING: strtok is deprecated, use strsep instead.
358  */
359 char * strtok(char * s,const char * ct)
360 {
361         char *sbegin, *send;
362
363         sbegin  = s ? s : ___strtok;
364         if (!sbegin) {
365                 return NULL;
366         }
367         sbegin += strspn(sbegin,ct);
368         if (*sbegin == '\0') {
369                 ___strtok = NULL;
370                 return( NULL );
371         }
372         send = strpbrk( sbegin, ct);
373         if (send && *send != '\0')
374                 *send++ = '\0';
375         ___strtok = send;
376         return (sbegin);
377 }
378 #endif
379
380 #ifndef __HAVE_ARCH_STRSEP
381 /**
382  * strsep - Split a string into tokens
383  * @s: The string to be searched
384  * @ct: The characters to search for
385  *
386  * strsep() updates @s to point after the token, ready for the next call.
387  *
388  * It returns empty tokens, too, behaving exactly like the libc function
389  * of that name. In fact, it was stolen from glibc2 and de-fancy-fied.
390  * Same semantics, slimmer shape. ;)
391  */
392 char * strsep(char **s, const char *ct)
393 {
394         char *sbegin = *s, *end;
395
396         if (sbegin == NULL)
397                 return NULL;
398
399         end = strpbrk(sbegin, ct);
400         if (end)
401                 *end++ = '\0';
402         *s = end;
403
404         return sbegin;
405 }
406 #endif
407
408 #ifndef __HAVE_ARCH_STRSWAB
409 /**
410  * strswab - swap adjacent even and odd bytes in %NUL-terminated string
411  * s: address of the string
412  *
413  * returns the address of the swapped string or NULL on error. If
414  * string length is odd, last byte is untouched.
415  */
416 char *strswab(const char *s)
417 {
418         char *p, *q;
419
420         if ((NULL == s) || ('\0' == *s)) {
421                 return (NULL);
422         }
423
424         for (p=(char *)s, q=p+1; (*p != '\0') && (*q != '\0'); p+=2, q+=2) {
425                 char  tmp;
426
427                 tmp = *p;
428                 *p  = *q;
429                 *q  = tmp;
430         }
431
432         return (char *) s;
433 }
434 #endif
435
436 #ifndef __HAVE_ARCH_MEMSET
437 /**
438  * memset - Fill a region of memory with the given value
439  * @s: Pointer to the start of the area.
440  * @c: The byte to fill the area with
441  * @count: The size of the area.
442  *
443  * Do not use memset() to access IO space, use memset_io() instead.
444  */
445 void * memset(void * s,int c,size_t count)
446 {
447         unsigned long *sl = (unsigned long *) s;
448         char *s8;
449
450 #if !CONFIG_IS_ENABLED(TINY_MEMSET)
451         unsigned long cl = 0;
452         int i;
453
454         /* do it one word at a time (32 bits or 64 bits) while possible */
455         if ( ((ulong)s & (sizeof(*sl) - 1)) == 0) {
456                 for (i = 0; i < sizeof(*sl); i++) {
457                         cl <<= 8;
458                         cl |= c & 0xff;
459                 }
460                 while (count >= sizeof(*sl)) {
461                         *sl++ = cl;
462                         count -= sizeof(*sl);
463                 }
464         }
465 #endif  /* fill 8 bits at a time */
466         s8 = (char *)sl;
467         while (count--)
468                 *s8++ = c;
469
470         return s;
471 }
472 #endif
473
474 #ifndef __HAVE_ARCH_MEMCPY
475 /**
476  * memcpy - Copy one area of memory to another
477  * @dest: Where to copy to
478  * @src: Where to copy from
479  * @count: The size of the area.
480  *
481  * You should not use this function to access IO space, use memcpy_toio()
482  * or memcpy_fromio() instead.
483  */
484 void * memcpy(void *dest, const void *src, size_t count)
485 {
486         unsigned long *dl = (unsigned long *)dest, *sl = (unsigned long *)src;
487         char *d8, *s8;
488
489         if (src == dest)
490                 return dest;
491
492         /* while all data is aligned (common case), copy a word at a time */
493         if ( (((ulong)dest | (ulong)src) & (sizeof(*dl) - 1)) == 0) {
494                 while (count >= sizeof(*dl)) {
495                         *dl++ = *sl++;
496                         count -= sizeof(*dl);
497                 }
498         }
499         /* copy the reset one byte at a time */
500         d8 = (char *)dl;
501         s8 = (char *)sl;
502         while (count--)
503                 *d8++ = *s8++;
504
505         return dest;
506 }
507 #endif
508
509 #ifndef __HAVE_ARCH_MEMMOVE
510 /**
511  * memmove - Copy one area of memory to another
512  * @dest: Where to copy to
513  * @src: Where to copy from
514  * @count: The size of the area.
515  *
516  * Unlike memcpy(), memmove() copes with overlapping areas.
517  */
518 void * memmove(void * dest,const void *src,size_t count)
519 {
520         char *tmp, *s;
521
522         if (dest <= src) {
523                 memcpy(dest, src, count);
524         } else {
525                 tmp = (char *) dest + count;
526                 s = (char *) src + count;
527                 while (count--)
528                         *--tmp = *--s;
529                 }
530
531         return dest;
532 }
533 #endif
534
535 #ifndef __HAVE_ARCH_MEMCMP
536 /**
537  * memcmp - Compare two areas of memory
538  * @cs: One area of memory
539  * @ct: Another area of memory
540  * @count: The size of the area.
541  */
542 int memcmp(const void * cs,const void * ct,size_t count)
543 {
544         const unsigned char *su1, *su2;
545         int res = 0;
546
547         for( su1 = cs, su2 = ct; 0 < count; ++su1, ++su2, count--)
548                 if ((res = *su1 - *su2) != 0)
549                         break;
550         return res;
551 }
552 #endif
553
554 #ifndef __HAVE_ARCH_MEMSCAN
555 /**
556  * memscan - Find a character in an area of memory.
557  * @addr: The memory area
558  * @c: The byte to search for
559  * @size: The size of the area.
560  *
561  * returns the address of the first occurrence of @c, or 1 byte past
562  * the area if @c is not found
563  */
564 void * memscan(void * addr, int c, size_t size)
565 {
566         unsigned char * p = (unsigned char *) addr;
567
568         while (size) {
569                 if (*p == c)
570                         return (void *) p;
571                 p++;
572                 size--;
573         }
574         return (void *) p;
575 }
576 #endif
577
578 #ifndef __HAVE_ARCH_STRSTR
579 /**
580  * strstr - Find the first substring in a %NUL terminated string
581  * @s1: The string to be searched
582  * @s2: The string to search for
583  */
584 char * strstr(const char * s1,const char * s2)
585 {
586         int l1, l2;
587
588         l2 = strlen(s2);
589         if (!l2)
590                 return (char *) s1;
591         l1 = strlen(s1);
592         while (l1 >= l2) {
593                 l1--;
594                 if (!memcmp(s1,s2,l2))
595                         return (char *) s1;
596                 s1++;
597         }
598         return NULL;
599 }
600 #endif
601
602 #ifndef __HAVE_ARCH_MEMCHR
603 /**
604  * memchr - Find a character in an area of memory.
605  * @s: The memory area
606  * @c: The byte to search for
607  * @n: The size of the area.
608  *
609  * returns the address of the first occurrence of @c, or %NULL
610  * if @c is not found
611  */
612 void *memchr(const void *s, int c, size_t n)
613 {
614         const unsigned char *p = s;
615         while (n-- != 0) {
616                 if ((unsigned char)c == *p++) {
617                         return (void *)(p-1);
618                 }
619         }
620         return NULL;
621 }
622
623 #endif
624 #ifndef __HAVE_ARCH_MEMCHR_INV
625 static void *check_bytes8(const u8 *start, u8 value, unsigned int bytes)
626 {
627         while (bytes) {
628                 if (*start != value)
629                         return (void *)start;
630                 start++;
631                 bytes--;
632         }
633         return NULL;
634 }
635 /**
636  * memchr_inv - Find an unmatching character in an area of memory.
637  * @start: The memory area
638  * @c: Find a character other than c
639  * @bytes: The size of the area.
640  *
641  * returns the address of the first character other than @c, or %NULL
642  * if the whole buffer contains just @c.
643  */
644 void *memchr_inv(const void *start, int c, size_t bytes)
645 {
646         u8 value = c;
647         u64 value64;
648         unsigned int words, prefix;
649
650         if (bytes <= 16)
651                 return check_bytes8(start, value, bytes);
652
653         value64 = value;
654         value64 |= value64 << 8;
655         value64 |= value64 << 16;
656         value64 |= value64 << 32;
657
658         prefix = (unsigned long)start % 8;
659         if (prefix) {
660                 u8 *r;
661
662                 prefix = 8 - prefix;
663                 r = check_bytes8(start, value, prefix);
664                 if (r)
665                         return r;
666                 start += prefix;
667                 bytes -= prefix;
668         }
669
670         words = bytes / 8;
671
672         while (words) {
673                 if (*(u64 *)start != value64)
674                         return check_bytes8(start, value, 8);
675                 start += 8;
676                 words--;
677         }
678
679         return check_bytes8(start, value, bytes % 8);
680 }
681 #endif