string.h revision cb228fb4a91bdccfd974b8a4f45e2b6002e90728 
1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *  * Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 *  * Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in
12 *    the documentation and/or other materials provided with the
13 *    distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28#ifndef _STRING_H_
29#define _STRING_H_
30
31#include <sys/cdefs.h>
32#include <stddef.h>
33#include <malloc.h>
34
35__BEGIN_DECLS
36
37extern void*  memccpy(void *, const void *, int, size_t);
38extern void*  memchr(const void *, int, size_t) __purefunc;
39extern void*  memrchr(const void *, int, size_t) __purefunc;
40extern int    memcmp(const void *, const void *, size_t) __purefunc;
41extern void*  memcpy(void *, const void *, size_t);
42extern void*  memmove(void *, const void *, size_t);
43extern void*  memset(void *, int, size_t);
44extern void*  memmem(const void *, size_t, const void *, size_t) __purefunc;
45extern void   memswap(void *, void *, size_t);
46
47extern char*  index(const char *, int) __purefunc;
48extern char*  rindex(const char *, int) __purefunc;
49extern char*  strchr(const char *, int) __purefunc;
50extern char*  strrchr(const char *, int) __purefunc;
51
52extern size_t strlen(const char *) __purefunc;
53extern int    strcmp(const char *, const char *) __purefunc;
54extern char*  strcpy(char *, const char *);
55extern char*  strcat(char *, const char *);
56
57extern int    strcasecmp(const char *, const char *) __purefunc;
58extern int    strncasecmp(const char *, const char *, size_t) __purefunc;
59extern char*  strdup(const char *);
60
61extern char*  strstr(const char *, const char *) __purefunc;
62extern char*  strcasestr(const char *haystack, const char *needle) __purefunc;
63extern char*  strtok(char *, const char *);
64extern char*  strtok_r(char *, const char *, char**);
65
66extern char*  strerror(int);
67extern int    strerror_r(int errnum, char *buf, size_t n);
68
69extern size_t strnlen(const char *, size_t) __purefunc;
70extern char*  strncat(char *, const char *, size_t);
71extern char*  strndup(const char *, size_t);
72extern int    strncmp(const char *, const char *, size_t) __purefunc;
73extern char*  strncpy(char *, const char *, size_t);
74
75extern size_t strlcat(char *, const char *, size_t);
76extern size_t strlcpy(char *, const char *, size_t);
77
78extern size_t strcspn(const char *, const char *) __purefunc;
79extern char*  strpbrk(const char *, const char *) __purefunc;
80extern char*  strsep(char **, const char *);
81extern size_t strspn(const char *, const char *);
82
83extern char*  strsignal(int  sig);
84
85extern int    strcoll(const char *, const char *) __purefunc;
86extern size_t strxfrm(char *, const char *, size_t);
87
88#if defined(__BIONIC_FORTIFY_INLINE)
89
90__BIONIC_FORTIFY_INLINE
91void *memcpy (void *dest, const void *src, size_t len) {
92    return __builtin___memcpy_chk(dest, src, len, __builtin_object_size (dest, 0));
93}
94
95__BIONIC_FORTIFY_INLINE
96void *memmove (void *dest, const void *src, size_t len) {
97    return __builtin___memmove_chk(dest, src, len, __builtin_object_size (dest, 0));
98}
99
100__BIONIC_FORTIFY_INLINE
101char *strcpy(char *dest, const char *src) {
102    return __builtin___strcpy_chk(dest, src, __builtin_object_size (dest, 0));
103}
104
105__BIONIC_FORTIFY_INLINE
106char *strncpy(char *dest, const char *src, size_t n) {
107    return __builtin___strncpy_chk(dest, src, n, __builtin_object_size (dest, 0));
108}
109
110__BIONIC_FORTIFY_INLINE
111char *strcat(char *dest, const char *src) {
112    return __builtin___strcat_chk(dest, src, __builtin_object_size (dest, 0));
113}
114
115__BIONIC_FORTIFY_INLINE
116char *strncat(char *dest, const char *src, size_t n) {
117    return __builtin___strncat_chk(dest, src, n, __builtin_object_size (dest, 0));
118}
119
120__BIONIC_FORTIFY_INLINE
121void *memset (void *s, int c, size_t n) {
122    return __builtin___memset_chk(s, c, n, __builtin_object_size (s, 0));
123}
124
125extern size_t __strlcpy_real(char *, const char *, size_t)
126    __asm__(__USER_LABEL_PREFIX__ "strlcpy");
127extern void __strlcpy_error()
128    __attribute__((__error__("strlcpy called with size bigger than buffer")));
129extern size_t __strlcpy_chk(char *, const char *, size_t, size_t);
130
131__BIONIC_FORTIFY_INLINE
132size_t strlcpy(char *dest, const char *src, size_t size) {
133    size_t bos = __builtin_object_size(dest, 0);
134
135    // Compiler doesn't know destination size. Don't call __strlcpy_chk
136    if (bos == (size_t) -1) {
137        return __strlcpy_real(dest, src, size);
138    }
139
140    // Compiler can prove, at compile time, that the passed in size
141    // is always <= the actual object size. Don't call __strlcpy_chk
142    if (__builtin_constant_p(size) && (size <= bos)) {
143        return __strlcpy_real(dest, src, size);
144    }
145
146    // Compiler can prove, at compile time, that the passed in size
147    // is always > the actual object size. Force a compiler error.
148    if (__builtin_constant_p(size) && (size > bos)) {
149        __strlcpy_error();
150    }
151
152    return __strlcpy_chk(dest, src, size, bos);
153}
154
155extern size_t __strlcat_real(char *, const char *, size_t)
156    __asm__(__USER_LABEL_PREFIX__ "strlcat");
157extern void __strlcat_error()
158    __attribute__((__error__("strlcat called with size bigger than buffer")));
159extern size_t __strlcat_chk(char *, const char *, size_t, size_t);
160
161
162__BIONIC_FORTIFY_INLINE
163size_t strlcat(char *dest, const char *src, size_t size) {
164    size_t bos = __builtin_object_size(dest, 0);
165
166    // Compiler doesn't know destination size. Don't call __strlcat_chk
167    if (bos == (size_t) -1) {
168        return __strlcat_real(dest, src, size);
169    }
170
171    // Compiler can prove, at compile time, that the passed in size
172    // is always <= the actual object size. Don't call __strlcat_chk
173    if (__builtin_constant_p(size) && (size <= bos)) {
174        return __strlcat_real(dest, src, size);
175    }
176
177    // Compiler can prove, at compile time, that the passed in size
178    // is always > the actual object size. Force a compiler error.
179    if (__builtin_constant_p(size) && (size > bos)) {
180        __strlcat_error();
181    }
182
183    return __strlcat_chk(dest, src, size, bos);
184}
185
186
187#endif /* defined(__BIONIC_FORTIFY_INLINE) */
188
189__END_DECLS
190
191#endif /* _STRING_H_ */
192