[PATCH] Numerous fixes to kernel-doc info in source files.
[linux-2.6.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  * * Sat Feb 09 2002, Jason Thomas <jason@topic.com.au>,
18  *                    Matthew Hawkins <matt@mh.dropbear.id.au>
19  * -  Kissed strtok() goodbye
20  */
21
22 #include <linux/types.h>
23 #include <linux/string.h>
24 #include <linux/ctype.h>
25 #include <linux/module.h>
26
27 #ifndef __HAVE_ARCH_STRNICMP
28 /**
29  * strnicmp - Case insensitive, length-limited string comparison
30  * @s1: One string
31  * @s2: The other string
32  * @len: the maximum number of characters to compare
33  */
34 int strnicmp(const char *s1, const char *s2, size_t len)
35 {
36         /* Yes, Virginia, it had better be unsigned */
37         unsigned char c1, c2;
38
39         c1 = c2 = 0;
40         if (len) {
41                 do {
42                         c1 = *s1;
43                         c2 = *s2;
44                         s1++;
45                         s2++;
46                         if (!c1)
47                                 break;
48                         if (!c2)
49                                 break;
50                         if (c1 == c2)
51                                 continue;
52                         c1 = tolower(c1);
53                         c2 = tolower(c2);
54                         if (c1 != c2)
55                                 break;
56                 } while (--len);
57         }
58         return (int)c1 - (int)c2;
59 }
60 EXPORT_SYMBOL(strnicmp);
61 #endif
62
63 #ifndef __HAVE_ARCH_STRCPY
64 /**
65  * strcpy - Copy a %NUL terminated string
66  * @dest: Where to copy the string to
67  * @src: Where to copy the string from
68  */
69 #undef strcpy
70 char *strcpy(char *dest, const char *src)
71 {
72         char *tmp = dest;
73
74         while ((*dest++ = *src++) != '\0')
75                 /* nothing */;
76         return tmp;
77 }
78 EXPORT_SYMBOL(strcpy);
79 #endif
80
81 #ifndef __HAVE_ARCH_STRNCPY
82 /**
83  * strncpy - Copy a length-limited, %NUL-terminated string
84  * @dest: Where to copy the string to
85  * @src: Where to copy the string from
86  * @count: The maximum number of bytes to copy
87  *
88  * The result is not %NUL-terminated if the source exceeds
89  * @count bytes.
90  *
91  * In the case where the length of @src is less than  that  of
92  * count, the remainder of @dest will be padded with %NUL.
93  *
94  */
95 char *strncpy(char *dest, const char *src, size_t count)
96 {
97         char *tmp = dest;
98
99         while (count) {
100                 if ((*tmp = *src) != 0)
101                         src++;
102                 tmp++;
103                 count--;
104         }
105         return dest;
106 }
107 EXPORT_SYMBOL(strncpy);
108 #endif
109
110 #ifndef __HAVE_ARCH_STRLCPY
111 /**
112  * strlcpy - Copy a %NUL terminated string into a sized buffer
113  * @dest: Where to copy the string to
114  * @src: Where to copy the string from
115  * @size: size of destination buffer
116  *
117  * Compatible with *BSD: the result is always a valid
118  * NUL-terminated string that fits in the buffer (unless,
119  * of course, the buffer size is zero). It does not pad
120  * out the result like strncpy() does.
121  */
122 size_t strlcpy(char *dest, const char *src, size_t size)
123 {
124         size_t ret = strlen(src);
125
126         if (size) {
127                 size_t len = (ret >= size) ? size - 1 : ret;
128                 memcpy(dest, src, len);
129                 dest[len] = '\0';
130         }
131         return ret;
132 }
133 EXPORT_SYMBOL(strlcpy);
134 #endif
135
136 #ifndef __HAVE_ARCH_STRCAT
137 /**
138  * strcat - Append one %NUL-terminated string to another
139  * @dest: The string to be appended to
140  * @src: The string to append to it
141  */
142 #undef strcat
143 char *strcat(char *dest, const char *src)
144 {
145         char *tmp = dest;
146
147         while (*dest)
148                 dest++;
149         while ((*dest++ = *src++) != '\0')
150                 ;
151         return tmp;
152 }
153 EXPORT_SYMBOL(strcat);
154 #endif
155
156 #ifndef __HAVE_ARCH_STRNCAT
157 /**
158  * strncat - Append a length-limited, %NUL-terminated string to another
159  * @dest: The string to be appended to
160  * @src: The string to append to it
161  * @count: The maximum numbers of bytes to copy
162  *
163  * Note that in contrast to strncpy(), strncat() ensures the result is
164  * terminated.
165  */
166 char *strncat(char *dest, const char *src, size_t count)
167 {
168         char *tmp = dest;
169
170         if (count) {
171                 while (*dest)
172                         dest++;
173                 while ((*dest++ = *src++) != 0) {
174                         if (--count == 0) {
175                                 *dest = '\0';
176                                 break;
177                         }
178                 }
179         }
180         return tmp;
181 }
182 EXPORT_SYMBOL(strncat);
183 #endif
184
185 #ifndef __HAVE_ARCH_STRLCAT
186 /**
187  * strlcat - Append a length-limited, %NUL-terminated string to another
188  * @dest: The string to be appended to
189  * @src: The string to append to it
190  * @count: The size of the destination buffer.
191  */
192 size_t strlcat(char *dest, const char *src, size_t count)
193 {
194         size_t dsize = strlen(dest);
195         size_t len = strlen(src);
196         size_t res = dsize + len;
197
198         /* This would be a bug */
199         BUG_ON(dsize >= count);
200
201         dest += dsize;
202         count -= dsize;
203         if (len >= count)
204                 len = count-1;
205         memcpy(dest, src, len);
206         dest[len] = 0;
207         return res;
208 }
209 EXPORT_SYMBOL(strlcat);
210 #endif
211
212 #ifndef __HAVE_ARCH_STRCMP
213 /**
214  * strcmp - Compare two strings
215  * @cs: One string
216  * @ct: Another string
217  */
218 #undef strcmp
219 int strcmp(const char *cs, const char *ct)
220 {
221         signed char __res;
222
223         while (1) {
224                 if ((__res = *cs - *ct++) != 0 || !*cs++)
225                         break;
226         }
227         return __res;
228 }
229 EXPORT_SYMBOL(strcmp);
230 #endif
231
232 #ifndef __HAVE_ARCH_STRNCMP
233 /**
234  * strncmp - Compare two length-limited strings
235  * @cs: One string
236  * @ct: Another string
237  * @count: The maximum number of bytes to compare
238  */
239 int strncmp(const char *cs, const char *ct, size_t count)
240 {
241         signed char __res = 0;
242
243         while (count) {
244                 if ((__res = *cs - *ct++) != 0 || !*cs++)
245                         break;
246                 count--;
247         }
248         return __res;
249 }
250 EXPORT_SYMBOL(strncmp);
251 #endif
252
253 #ifndef __HAVE_ARCH_STRCHR
254 /**
255  * strchr - Find the first occurrence of a character in a string
256  * @s: The string to be searched
257  * @c: The character to search for
258  */
259 char *strchr(const char *s, int c)
260 {
261         for (; *s != (char)c; ++s)
262                 if (*s == '\0')
263                         return NULL;
264         return (char *)s;
265 }
266 EXPORT_SYMBOL(strchr);
267 #endif
268
269 #ifndef __HAVE_ARCH_STRRCHR
270 /**
271  * strrchr - Find the last occurrence of a character in a string
272  * @s: The string to be searched
273  * @c: The character to search for
274  */
275 char *strrchr(const char *s, int c)
276 {
277        const char *p = s + strlen(s);
278        do {
279            if (*p == (char)c)
280                return (char *)p;
281        } while (--p >= s);
282        return NULL;
283 }
284 EXPORT_SYMBOL(strrchr);
285 #endif
286
287 #ifndef __HAVE_ARCH_STRNCHR
288 /**
289  * strnchr - Find a character in a length limited string
290  * @s: The string to be searched
291  * @count: The number of characters to be searched
292  * @c: The character to search for
293  */
294 char *strnchr(const char *s, size_t count, int c)
295 {
296         for (; count-- && *s != '\0'; ++s)
297                 if (*s == (char)c)
298                         return (char *)s;
299         return NULL;
300 }
301 EXPORT_SYMBOL(strnchr);
302 #endif
303
304 /**
305  * strstrip - Removes leading and trailing whitespace from @s.
306  * @s: The string to be stripped.
307  *
308  * Note that the first trailing whitespace is replaced with a %NUL-terminator
309  * in the given string @s. Returns a pointer to the first non-whitespace
310  * character in @s.
311  */
312 char *strstrip(char *s)
313 {
314         size_t size;
315         char *end;
316
317         size = strlen(s);
318
319         if (!size)
320                 return s;
321
322         end = s + size - 1;
323         while (end >= s && isspace(*end))
324                 end--;
325         *(end + 1) = '\0';
326
327         while (*s && isspace(*s))
328                 s++;
329
330         return s;
331 }
332 EXPORT_SYMBOL(strstrip);
333
334 #ifndef __HAVE_ARCH_STRLEN
335 /**
336  * strlen - Find the length of a string
337  * @s: The string to be sized
338  */
339 size_t strlen(const char *s)
340 {
341         const char *sc;
342
343         for (sc = s; *sc != '\0'; ++sc)
344                 /* nothing */;
345         return sc - s;
346 }
347 EXPORT_SYMBOL(strlen);
348 #endif
349
350 #ifndef __HAVE_ARCH_STRNLEN
351 /**
352  * strnlen - Find the length of a length-limited string
353  * @s: The string to be sized
354  * @count: The maximum number of bytes to search
355  */
356 size_t strnlen(const char *s, size_t count)
357 {
358         const char *sc;
359
360         for (sc = s; count-- && *sc != '\0'; ++sc)
361                 /* nothing */;
362         return sc - s;
363 }
364 EXPORT_SYMBOL(strnlen);
365 #endif
366
367 #ifndef __HAVE_ARCH_STRSPN
368 /**
369  * strspn - Calculate the length of the initial substring of @s which only contain letters in @accept
370  * @s: The string to be searched
371  * @accept: The string to search for
372  */
373 size_t strspn(const char *s, const char *accept)
374 {
375         const char *p;
376         const char *a;
377         size_t count = 0;
378
379         for (p = s; *p != '\0'; ++p) {
380                 for (a = accept; *a != '\0'; ++a) {
381                         if (*p == *a)
382                                 break;
383                 }
384                 if (*a == '\0')
385                         return count;
386                 ++count;
387         }
388         return count;
389 }
390
391 EXPORT_SYMBOL(strspn);
392 #endif
393
394 #ifndef __HAVE_ARCH_STRCSPN
395 /**
396  * strcspn - Calculate the length of the initial substring of @s which does not contain letters in @reject
397  * @s: The string to be searched
398  * @reject: The string to avoid
399  */
400 size_t strcspn(const char *s, const char *reject)
401 {
402         const char *p;
403         const char *r;
404         size_t count = 0;
405
406         for (p = s; *p != '\0'; ++p) {
407                 for (r = reject; *r != '\0'; ++r) {
408                         if (*p == *r)
409                                 return count;
410                 }
411                 ++count;
412         }
413         return count;
414 }
415 EXPORT_SYMBOL(strcspn);
416 #endif
417
418 #ifndef __HAVE_ARCH_STRPBRK
419 /**
420  * strpbrk - Find the first occurrence of a set of characters
421  * @cs: The string to be searched
422  * @ct: The characters to search for
423  */
424 char *strpbrk(const char *cs, const char *ct)
425 {
426         const char *sc1, *sc2;
427
428         for (sc1 = cs; *sc1 != '\0'; ++sc1) {
429                 for (sc2 = ct; *sc2 != '\0'; ++sc2) {
430                         if (*sc1 == *sc2)
431                                 return (char *)sc1;
432                 }
433         }
434         return NULL;
435 }
436 EXPORT_SYMBOL(strpbrk);
437 #endif
438
439 #ifndef __HAVE_ARCH_STRSEP
440 /**
441  * strsep - Split a string into tokens
442  * @s: The string to be searched
443  * @ct: The characters to search for
444  *
445  * strsep() updates @s to point after the token, ready for the next call.
446  *
447  * It returns empty tokens, too, behaving exactly like the libc function
448  * of that name. In fact, it was stolen from glibc2 and de-fancy-fied.
449  * Same semantics, slimmer shape. ;)
450  */
451 char *strsep(char **s, const char *ct)
452 {
453         char *sbegin = *s;
454         char *end;
455
456         if (sbegin == NULL)
457                 return NULL;
458
459         end = strpbrk(sbegin, ct);
460         if (end)
461                 *end++ = '\0';
462         *s = end;
463         return sbegin;
464 }
465 EXPORT_SYMBOL(strsep);
466 #endif
467
468 #ifndef __HAVE_ARCH_MEMSET
469 /**
470  * memset - Fill a region of memory with the given value
471  * @s: Pointer to the start of the area.
472  * @c: The byte to fill the area with
473  * @count: The size of the area.
474  *
475  * Do not use memset() to access IO space, use memset_io() instead.
476  */
477 void *memset(void *s, int c, size_t count)
478 {
479         char *xs = s;
480
481         while (count--)
482                 *xs++ = c;
483         return s;
484 }
485 EXPORT_SYMBOL(memset);
486 #endif
487
488 #ifndef __HAVE_ARCH_MEMCPY
489 /**
490  * memcpy - Copy one area of memory to another
491  * @dest: Where to copy to
492  * @src: Where to copy from
493  * @count: The size of the area.
494  *
495  * You should not use this function to access IO space, use memcpy_toio()
496  * or memcpy_fromio() instead.
497  */
498 void *memcpy(void *dest, const void *src, size_t count)
499 {
500         char *tmp = dest;
501         const char *s = src;
502
503         while (count--)
504                 *tmp++ = *s++;
505         return dest;
506 }
507 EXPORT_SYMBOL(memcpy);
508 #endif
509
510 #ifndef __HAVE_ARCH_MEMMOVE
511 /**
512  * memmove - Copy one area of memory to another
513  * @dest: Where to copy to
514  * @src: Where to copy from
515  * @count: The size of the area.
516  *
517  * Unlike memcpy(), memmove() copes with overlapping areas.
518  */
519 void *memmove(void *dest, const void *src, size_t count)
520 {
521         char *tmp;
522         const char *s;
523
524         if (dest <= src) {
525                 tmp = dest;
526                 s = src;
527                 while (count--)
528                         *tmp++ = *s++;
529         } else {
530                 tmp = dest;
531                 tmp += count;
532                 s = src;
533                 s += count;
534                 while (count--)
535                         *--tmp = *--s;
536         }
537         return dest;
538 }
539 EXPORT_SYMBOL(memmove);
540 #endif
541
542 #ifndef __HAVE_ARCH_MEMCMP
543 /**
544  * memcmp - Compare two areas of memory
545  * @cs: One area of memory
546  * @ct: Another area of memory
547  * @count: The size of the area.
548  */
549 #undef memcmp
550 int memcmp(const void *cs, const void *ct, size_t count)
551 {
552         const unsigned char *su1, *su2;
553         int res = 0;
554
555         for (su1 = cs, su2 = ct; 0 < count; ++su1, ++su2, count--)
556                 if ((res = *su1 - *su2) != 0)
557                         break;
558         return res;
559 }
560 EXPORT_SYMBOL(memcmp);
561 #endif
562
563 #ifndef __HAVE_ARCH_MEMSCAN
564 /**
565  * memscan - Find a character in an area of memory.
566  * @addr: The memory area
567  * @c: The byte to search for
568  * @size: The size of the area.
569  *
570  * returns the address of the first occurrence of @c, or 1 byte past
571  * the area if @c is not found
572  */
573 void *memscan(void *addr, int c, size_t size)
574 {
575         unsigned char *p = addr;
576
577         while (size) {
578                 if (*p == c)
579                         return (void *)p;
580                 p++;
581                 size--;
582         }
583         return (void *)p;
584 }
585 EXPORT_SYMBOL(memscan);
586 #endif
587
588 #ifndef __HAVE_ARCH_STRSTR
589 /**
590  * strstr - Find the first substring in a %NUL terminated string
591  * @s1: The string to be searched
592  * @s2: The string to search for
593  */
594 char *strstr(const char *s1, const char *s2)
595 {
596         int l1, l2;
597
598         l2 = strlen(s2);
599         if (!l2)
600                 return (char *)s1;
601         l1 = strlen(s1);
602         while (l1 >= l2) {
603                 l1--;
604                 if (!memcmp(s1, s2, l2))
605                         return (char *)s1;
606                 s1++;
607         }
608         return NULL;
609 }
610 EXPORT_SYMBOL(strstr);
611 #endif
612
613 #ifndef __HAVE_ARCH_MEMCHR
614 /**
615  * memchr - Find a character in an area of memory.
616  * @s: The memory area
617  * @c: The byte to search for
618  * @n: The size of the area.
619  *
620  * returns the address of the first occurrence of @c, or %NULL
621  * if @c is not found
622  */
623 void *memchr(const void *s, int c, size_t n)
624 {
625         const unsigned char *p = s;
626         while (n-- != 0) {
627                 if ((unsigned char)c == *p++) {
628                         return (void *)(p - 1);
629                 }
630         }
631         return NULL;
632 }
633 EXPORT_SYMBOL(memchr);
634 #endif