blob: 0cbd61c3f63ce1cdab24703a8566f72836c3ac01 [file] [log] [blame]
The Android Open Source Project1dc9e472009-03-03 19:28:35 -08001/*
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 */
Elliott Hughes09c39d62014-08-19 14:30:30 -070028
29#ifndef _STRING_H
30#define _STRING_H
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080031
32#include <sys/cdefs.h>
33#include <stddef.h>
Dan Albertdfb5ce42014-07-09 22:51:34 +000034#include <xlocale.h>
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080035
Josh Gaoc3cec272016-04-07 13:39:49 -070036#include <bits/strcasecmp.h>
37
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080038__BEGIN_DECLS
39
Elliott Hughes5470c182016-07-22 11:36:17 -070040#if defined(__clang__)
41#pragma clang diagnostic push
42#pragma clang diagnostic ignored "-Wnullability-completeness"
43#endif
44
Elliott Hughes76f89162015-01-26 13:34:58 -080045#if defined(__USE_BSD)
46#include <strings.h>
47#endif
48
Elliott Hughes5470c182016-07-22 11:36:17 -070049void* memccpy(void* _Nonnull __restrict, const void* _Nonnull __restrict, int, size_t);
George Burgess IV7cc779f2017-02-09 00:00:31 -080050void* memchr(const void* _Nonnull, int, size_t) __attribute_pure__ __overloadable
51 __RENAME_CLANG(memchr);
52void* memrchr(const void* _Nonnull, int, size_t) __attribute_pure__ __overloadable
53 __RENAME_CLANG(memrchr);
Elliott Hughes95fa0612016-09-28 12:29:52 -070054int memcmp(const void* _Nonnull, const void* _Nonnull, size_t) __attribute_pure__;
George Burgess IV7cc779f2017-02-09 00:00:31 -080055void* memcpy(void* _Nonnull __restrict, const void* _Nonnull __restrict, size_t)
56 __overloadable __RENAME_CLANG(memcpy);
Elliott Hughes3cfb52a2015-02-18 21:29:13 -080057#if defined(__USE_GNU)
Elliott Hughes5470c182016-07-22 11:36:17 -070058void* mempcpy(void* _Nonnull __restrict, const void* _Nonnull __restrict, size_t) __INTRODUCED_IN(23);
Elliott Hughes3cfb52a2015-02-18 21:29:13 -080059#endif
George Burgess IV7cc779f2017-02-09 00:00:31 -080060void* memmove(void* _Nonnull, const void* _Nonnull, size_t) __overloadable
61 __RENAME_CLANG(memmove);
62void* memset(void* _Nonnull, int, size_t) __overloadable __RENAME_CLANG(memset);
Elliott Hughes95fa0612016-09-28 12:29:52 -070063void* memmem(const void* _Nonnull, size_t, const void* _Nonnull, size_t) __attribute_pure__;
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080064
George Burgess IV7cc779f2017-02-09 00:00:31 -080065char* strchr(const char* _Nonnull, int) __attribute_pure__ __overloadable
66 __RENAME_CLANG(strchr);
Elliott Hughes5470c182016-07-22 11:36:17 -070067char* __strchr_chk(const char* _Nonnull, int, size_t) __INTRODUCED_IN(18);
Elliott Hughes7ac3c122015-08-26 09:59:29 -070068#if defined(__USE_GNU)
69#if defined(__cplusplus)
Elliott Hughes95fa0612016-09-28 12:29:52 -070070extern "C++" char* strchrnul(char* _Nonnull, int) __RENAME(strchrnul) __attribute_pure__;
71extern "C++" const char* strchrnul(const char* _Nonnull, int) __RENAME(strchrnul) __attribute_pure__;
Elliott Hughes7ac3c122015-08-26 09:59:29 -070072#else
Elliott Hughes95fa0612016-09-28 12:29:52 -070073char* strchrnul(const char* _Nonnull, int) __attribute_pure__ __INTRODUCED_IN(24);
Elliott Hughes7ac3c122015-08-26 09:59:29 -070074#endif
75#endif
Pavel Chupin3c4b50f2013-07-26 16:50:11 +040076
George Burgess IV7cc779f2017-02-09 00:00:31 -080077char* strrchr(const char* _Nonnull, int) __attribute_pure__ __overloadable
78 __RENAME_CLANG(strrchr);
Elliott Hughes5470c182016-07-22 11:36:17 -070079char* __strrchr_chk(const char* _Nonnull, int, size_t) __INTRODUCED_IN(18);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080080
George Burgess IV7cc779f2017-02-09 00:00:31 -080081size_t strlen(const char* _Nonnull) __attribute_pure__ __overloadable
82 __RENAME_CLANG(strlen);
Elliott Hughes5470c182016-07-22 11:36:17 -070083size_t __strlen_chk(const char* _Nonnull, size_t) __INTRODUCED_IN(17);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080084
George Burgess IV7cc779f2017-02-09 00:00:31 -080085int strcmp(const char* _Nonnull, const char* _Nonnull) __attribute_pure__;
86char* stpcpy(char* _Nonnull __restrict, const char* _Nonnull __restrict)
87 __overloadable __RENAME_CLANG(stpcpy) __INTRODUCED_IN(21);
88char* strcpy(char* _Nonnull __restrict, const char* _Nonnull __restrict)
89 __overloadable __RENAME_CLANG(strcpy);
90char* strcat(char* _Nonnull __restrict, const char* _Nonnull __restrict)
91 __overloadable __RENAME_CLANG(strcat);
Elliott Hughes5470c182016-07-22 11:36:17 -070092char* strdup(const char* _Nonnull);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080093
Elliott Hughes95fa0612016-09-28 12:29:52 -070094char* strstr(const char* _Nonnull, const char* _Nonnull) __attribute_pure__;
95char* strcasestr(const char* _Nonnull, const char* _Nonnull) __attribute_pure__;
Elliott Hughes5470c182016-07-22 11:36:17 -070096char* strtok(char* __restrict, const char* _Nonnull __restrict);
97char* strtok_r(char* __restrict, const char* _Nonnull __restrict, char** _Nonnull __restrict);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -080098
Elliott Hughes5470c182016-07-22 11:36:17 -070099char* strerror(int);
100char* strerror_l(int, locale_t) __INTRODUCED_IN(23);
Dan Albert8b154b12017-02-14 16:33:06 -0800101#if defined(__USE_GNU) && __ANDROID_API__ >= 23
Elliott Hughes5470c182016-07-22 11:36:17 -0700102char* strerror_r(int, char*, size_t) __RENAME(__gnu_strerror_r) __INTRODUCED_IN(23);
Elliott Hughes416d7dd2014-08-18 17:28:32 -0700103#else /* POSIX */
Elliott Hughes5470c182016-07-22 11:36:17 -0700104int strerror_r(int, char*, size_t);
Elliott Hughes416d7dd2014-08-18 17:28:32 -0700105#endif
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800106
Elliott Hughes95fa0612016-09-28 12:29:52 -0700107size_t strnlen(const char* _Nonnull, size_t) __attribute_pure__;
George Burgess IV7cc779f2017-02-09 00:00:31 -0800108char* strncat(char* _Nonnull __restrict, const char* _Nonnull __restrict, size_t)
109 __overloadable __RENAME_CLANG(strncat);
Elliott Hughes5470c182016-07-22 11:36:17 -0700110char* strndup(const char* _Nonnull, size_t);
Elliott Hughes95fa0612016-09-28 12:29:52 -0700111int strncmp(const char* _Nonnull, const char* _Nonnull, size_t) __attribute_pure__;
George Burgess IV7cc779f2017-02-09 00:00:31 -0800112char* stpncpy(char* _Nonnull __restrict, const char* _Nonnull __restrict, size_t)
113 __overloadable __RENAME_CLANG(stpncpy) __INTRODUCED_IN(21);
114char* strncpy(char* _Nonnull __restrict, const char* _Nonnull __restrict, size_t)
115 __overloadable __RENAME_CLANG(strncpy);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800116
George Burgess IV7cc779f2017-02-09 00:00:31 -0800117size_t strlcat(char* _Nonnull __restrict, const char* _Nonnull __restrict, size_t)
118 __overloadable __RENAME_CLANG(strlcat);
119size_t strlcpy(char* _Nonnull __restrict, const char* _Nonnull __restrict, size_t)
120 __overloadable __RENAME_CLANG(strlcpy);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800121
Elliott Hughes95fa0612016-09-28 12:29:52 -0700122size_t strcspn(const char* _Nonnull, const char* _Nonnull) __attribute_pure__;
123char* strpbrk(const char* _Nonnull, const char* _Nonnull) __attribute_pure__;
Elliott Hughes5470c182016-07-22 11:36:17 -0700124char* strsep(char** _Nonnull __restrict, const char* _Nonnull __restrict);
125size_t strspn(const char* _Nonnull, const char* _Nonnull);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800126
Elliott Hughes5470c182016-07-22 11:36:17 -0700127char* strsignal(int);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800128
Elliott Hughes95fa0612016-09-28 12:29:52 -0700129int strcoll(const char* _Nonnull, const char* _Nonnull) __attribute_pure__;
Elliott Hughes5470c182016-07-22 11:36:17 -0700130size_t strxfrm(char* __restrict, const char* _Nonnull __restrict, size_t);
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800131
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800132#if __ANDROID_API__ >= __ANDROID_API_L__
Elliott Hughes95fa0612016-09-28 12:29:52 -0700133int strcoll_l(const char* _Nonnull, const char* _Nonnull, locale_t) __attribute_pure__ __INTRODUCED_IN(21);
Elliott Hughes5470c182016-07-22 11:36:17 -0700134size_t strxfrm_l(char* __restrict, const char* _Nonnull __restrict, size_t, locale_t) __INTRODUCED_IN(21);
Josh Gao6cd9fb02016-09-23 14:06:05 -0700135#else
136// Implemented as static inlines before 21.
137#endif
Dan Albertdfb5ce42014-07-09 22:51:34 +0000138
Josh Gaoeb9b9252015-11-03 18:46:02 -0800139#if defined(__USE_GNU) && !defined(basename)
Elliott Hughes09c39d62014-08-19 14:30:30 -0700140/*
141 * glibc has a basename in <string.h> that's different to the POSIX one in <libgen.h>.
142 * It doesn't modify its argument, and in C++ it's const-correct.
143 */
144#if defined(__cplusplus)
Dan Albertbaa2a972015-08-13 16:58:50 -0700145extern "C++" char* basename(char* _Nonnull) __RENAME(__gnu_basename);
146extern "C++" const char* basename(const char* _Nonnull) __RENAME(__gnu_basename);
Elliott Hughes09c39d62014-08-19 14:30:30 -0700147#else
Elliott Hughes5470c182016-07-22 11:36:17 -0700148char* basename(const char* _Nonnull) __RENAME(__gnu_basename) __INTRODUCED_IN(23);
Elliott Hughes09c39d62014-08-19 14:30:30 -0700149#endif
Elliott Hughes09c39d62014-08-19 14:30:30 -0700150#endif
151
Elliott Hughes5470c182016-07-22 11:36:17 -0700152void* __memchr_chk(const void* _Nonnull, int, size_t, size_t) __INTRODUCED_IN(23);
Elliott Hughes5470c182016-07-22 11:36:17 -0700153void* __memrchr_chk(const void* _Nonnull, int, size_t, size_t) __INTRODUCED_IN(23);
Elliott Hughes5470c182016-07-22 11:36:17 -0700154char* __stpncpy_chk2(char* _Nonnull __restrict, const char* _Nonnull __restrict, size_t, size_t, size_t)
Josh Gao14adff12016-04-29 12:00:55 -0700155 __INTRODUCED_IN(21);
Elliott Hughes5470c182016-07-22 11:36:17 -0700156char* __strncpy_chk2(char* _Nonnull __restrict, const char* _Nonnull __restrict, size_t, size_t, size_t)
Josh Gao14adff12016-04-29 12:00:55 -0700157 __INTRODUCED_IN(21);
Elliott Hughes5470c182016-07-22 11:36:17 -0700158size_t __strlcpy_chk(char* _Nonnull __restrict, const char* _Nonnull __restrict, size_t, size_t) __INTRODUCED_IN(17);
Elliott Hughes5470c182016-07-22 11:36:17 -0700159size_t __strlcat_chk(char* _Nonnull __restrict, const char* _Nonnull __restrict, size_t, size_t) __INTRODUCED_IN(17);
Dan Albert658727e2014-10-07 11:10:36 -0700160
George Burgess IV7cc779f2017-02-09 00:00:31 -0800161/* Only used with FORTIFY, but some headers that need it undef FORTIFY, so we
162 * have the definition out here.
163 */
164struct __bionic_zero_size_is_okay_t {};
165
Elliott Hughes890c8ed2013-03-22 10:58:55 -0700166#if defined(__BIONIC_FORTIFY)
George Burgess IV7cc779f2017-02-09 00:00:31 -0800167// These can share their implementation between gcc and clang with minimal
168// trickery...
169#if __ANDROID_API__ >= __ANDROID_API_J_MR1__
170__BIONIC_FORTIFY_INLINE
George Burgess IV156d5a82017-02-10 13:56:22 -0800171void* memcpy(void* _Nonnull __restrict const dst __pass_object_size0,
George Burgess IV7cc779f2017-02-09 00:00:31 -0800172 const void* _Nonnull __restrict src, size_t copy_amount) __overloadable {
173 return __builtin___memcpy_chk(dst, src, copy_amount, __bos0(dst));
174}
175
176__BIONIC_FORTIFY_INLINE
George Burgess IV156d5a82017-02-10 13:56:22 -0800177void* memmove(void* const _Nonnull dst __pass_object_size0,
George Burgess IV7cc779f2017-02-09 00:00:31 -0800178 const void* _Nonnull src, size_t len) __overloadable {
179 return __builtin___memmove_chk(dst, src, len, __bos0(dst));
180}
181#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR1__ */
182
183#if __ANDROID_API__ >= __ANDROID_API_L__
184__BIONIC_FORTIFY_INLINE
185char* stpcpy(char* _Nonnull __restrict const dst __pass_object_size,
186 const char* _Nonnull __restrict src) __overloadable {
187 return __builtin___stpcpy_chk(dst, src, __bos(dst));
188}
189#endif /* __ANDROID_API__ >= __ANDROID_API_L__ */
190
191#if __ANDROID_API__ >= __ANDROID_API_J_MR1__
192__BIONIC_FORTIFY_INLINE
193char* strcpy(char* _Nonnull __restrict const dst __pass_object_size,
194 const char* _Nonnull __restrict src) __overloadable {
195 return __builtin___strcpy_chk(dst, src, __bos(dst));
196}
George Burgess IV7cc779f2017-02-09 00:00:31 -0800197
198__BIONIC_FORTIFY_INLINE
199char* strcat(char* _Nonnull __restrict const dst __pass_object_size,
200 const char* _Nonnull __restrict src) __overloadable {
201 return __builtin___strcat_chk(dst, src, __bos(dst));
202}
203
204__BIONIC_FORTIFY_INLINE
205char* strncat(char* const _Nonnull __restrict dst __pass_object_size,
206 const char* _Nonnull __restrict src, size_t n) __overloadable {
207 return __builtin___strncat_chk(dst, src, n, __bos(dst));
208}
209
210__BIONIC_FORTIFY_INLINE
George Burgess IV156d5a82017-02-10 13:56:22 -0800211void* memset(void* const _Nonnull s __pass_object_size0, int c, size_t n)
George Burgess IV7cc779f2017-02-09 00:00:31 -0800212 __overloadable {
213 return __builtin___memset_chk(s, c, n, __bos0(s));
214}
Dan Albert9c2094f2017-02-14 19:28:18 -0800215#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR1__ */
George Burgess IV7cc779f2017-02-09 00:00:31 -0800216
217
218#if defined(__clang__)
219
220#define __error_if_overflows_dst(name, dst, n, what) \
221 __enable_if(__bos0(dst) != __BIONIC_FORTIFY_UNKNOWN_SIZE && \
222 __bos0(dst) < (n), "selected when the buffer is too small") \
223 __errorattr(#name " called with " what " bigger than buffer")
224
225/*
226 * N.B. _Nonnull isn't necessary on params, since these functions just emit
227 * errors.
228 */
229__BIONIC_ERROR_FUNCTION_VISIBILITY
230void* memcpy(void* dst, const void* src, size_t copy_amount) __overloadable
231 __error_if_overflows_dst(memcpy, dst, copy_amount, "size");
232
233__BIONIC_ERROR_FUNCTION_VISIBILITY
234void* memmove(void *dst, const void* src, size_t len) __overloadable
235 __error_if_overflows_dst(memmove, dst, len, "size");
236
237__BIONIC_ERROR_FUNCTION_VISIBILITY
238void* memset(void* s, int c, size_t n) __overloadable
239 __error_if_overflows_dst(memset, s, n, "size");
240
241__BIONIC_ERROR_FUNCTION_VISIBILITY
242char* stpcpy(char* dst, const char* src) __overloadable
243 __error_if_overflows_dst(stpcpy, dst, __builtin_strlen(src), "string");
244
245__BIONIC_ERROR_FUNCTION_VISIBILITY
246char* strcpy(char* dst, const char* src) __overloadable
247 __error_if_overflows_dst(strcpy, dst, __builtin_strlen(src), "string");
Nick Kralevich0a230152012-06-04 15:20:25 -0700248
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800249#if __ANDROID_API__ >= __ANDROID_API_M__
Nick Kralevich0a230152012-06-04 15:20:25 -0700250__BIONIC_FORTIFY_INLINE
George Burgess IV7cc779f2017-02-09 00:00:31 -0800251void* memchr(const void* const _Nonnull s __pass_object_size, int c, size_t n)
252 __overloadable {
Daniel Micay4ae77362015-04-17 18:16:57 -0400253 size_t bos = __bos(s);
254
George Burgess IV7cc779f2017-02-09 00:00:31 -0800255 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
256 return __builtin_memchr(s, c, n);
257 }
258
259 return __memchr_chk(s, c, n, bos);
260}
261
262__BIONIC_FORTIFY_INLINE
263void* memrchr(const void* const _Nonnull s __pass_object_size, int c, size_t n)
264 __overloadable {
265 size_t bos = __bos(s);
266
267 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
268 return __call_bypassing_fortify(memrchr)(s, c, n);
269 }
270
271 return __memrchr_chk(s, c, n, bos);
272}
273#endif /* __ANDROID_API__ >= __ANDROID_API_M__ */
274
275#if __ANDROID_API__ >= __ANDROID_API_L__
276__BIONIC_FORTIFY_INLINE
277char* stpncpy(char* __restrict const _Nonnull dst __pass_object_size,
278 const char* __restrict const _Nonnull src __pass_object_size,
279 size_t n) __overloadable {
280 size_t bos_dst = __bos(dst);
281 size_t bos_src = __bos(src);
282
283 /* Ignore dst size checks; they're handled in strncpy_chk */
284 if (bos_src == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
285 return __builtin___stpncpy_chk(dst, src, n, bos_dst);
286 }
287
288 return __stpncpy_chk2(dst, src, n, bos_dst, bos_src);
289}
George Burgess IV7cc779f2017-02-09 00:00:31 -0800290
George Burgess IV7cc779f2017-02-09 00:00:31 -0800291__BIONIC_FORTIFY_INLINE
292char* strncpy(char* __restrict const _Nonnull dst __pass_object_size,
293 const char* __restrict const _Nonnull src __pass_object_size,
294 size_t n) __overloadable {
295 size_t bos_dst = __bos(dst);
296 size_t bos_src = __bos(src);
297
298 /* Ignore dst size checks; they're handled in strncpy_chk */
299 if (bos_src == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
300 return __builtin___strncpy_chk(dst, src, n, bos_dst);
301 }
302
303 return __strncpy_chk2(dst, src, n, bos_dst, bos_src);
304}
Dan Albert9c2094f2017-02-14 19:28:18 -0800305#endif /* __ANDROID_API__ >= __ANDROID_API_L__ */
George Burgess IV7cc779f2017-02-09 00:00:31 -0800306
Dan Albert9c2094f2017-02-14 19:28:18 -0800307#if __ANDROID_API__ >= __ANDROID_API_J_MR1__
George Burgess IV7cc779f2017-02-09 00:00:31 -0800308__BIONIC_FORTIFY_INLINE
309size_t strlcpy(char* const _Nonnull __restrict dst __pass_object_size,
310 const char *_Nonnull __restrict src, size_t size) __overloadable {
311 size_t bos = __bos(dst);
312
313 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
314 return __call_bypassing_fortify(strlcpy)(dst, src, size);
315 }
316
317 return __strlcpy_chk(dst, src, size, bos);
318}
319
320__BIONIC_FORTIFY_INLINE
321size_t strlcat(char* const _Nonnull __restrict dst __pass_object_size,
322 const char* _Nonnull __restrict src, size_t size) __overloadable {
323 size_t bos = __bos(dst);
324
325 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
326 return __call_bypassing_fortify(strlcat)(dst, src, size);
327 }
328
329 return __strlcat_chk(dst, src, size, bos);
330}
331
332/*
333 * If we can evaluate the size of s at compile-time, just call __builtin_strlen
334 * on it directly. This makes it way easier for compilers to fold things like
335 * strlen("Foo") into a constant, as users would expect. -1ULL is chosen simply
336 * because it's large.
337 */
338__BIONIC_FORTIFY_INLINE
339size_t strlen(const char* const _Nonnull s __pass_object_size)
340 __overloadable __enable_if(__builtin_strlen(s) != -1ULL,
341 "enabled if s is a known good string.") {
342 return __builtin_strlen(s);
343}
344
345__BIONIC_FORTIFY_INLINE
George Burgess IV156d5a82017-02-10 13:56:22 -0800346size_t strlen(const char* const _Nonnull s __pass_object_size0)
George Burgess IV7cc779f2017-02-09 00:00:31 -0800347 __overloadable {
348 size_t bos = __bos0(s);
349
350 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
351 return __builtin_strlen(s);
352 }
353
354 // return __builtin_strlen(s);
355 return __strlen_chk(s, bos);
356}
357#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR1__ */
358
359#if __ANDROID_API__ >= __ANDROID_API_J_MR2__
360__BIONIC_FORTIFY_INLINE
George Burgess IVbce9a7d2017-04-03 18:03:36 -0700361char* strchr(const char* const _Nonnull s __pass_object_size, int c)
George Burgess IV7cc779f2017-02-09 00:00:31 -0800362 __overloadable {
George Burgess IVbce9a7d2017-04-03 18:03:36 -0700363 size_t bos = __bos(s);
George Burgess IV7cc779f2017-02-09 00:00:31 -0800364
365 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
366 return __builtin_strchr(s, c);
367 }
368
369 // return __builtin_strchr(s, c);
370 return __strchr_chk(s, c, bos);
371}
372
373__BIONIC_FORTIFY_INLINE
374char* strrchr(const char* const _Nonnull s __pass_object_size, int c)
375 __overloadable {
376 size_t bos = __bos(s);
377
378 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
379 return __builtin_strrchr(s, c);
380 }
381
382 return __strrchr_chk(s, c, bos);
383}
384#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR2__ */
385
Dan Albert9c2094f2017-02-14 19:28:18 -0800386#if __ANDROID_API__ >= __ANDROID_API_J_MR1__
George Burgess IV7cc779f2017-02-09 00:00:31 -0800387/* In *many* cases, memset(foo, sizeof(foo), 0) is a mistake where the user has
388 * flipped the size + value arguments. However, there may be cases (e.g. with
389 * macros) where it's okay for the size to fold to zero. We should warn on this,
390 * but we should also provide a FORTIFY'ed escape hatch.
391 */
392__BIONIC_ERROR_FUNCTION_VISIBILITY
393void* memset(void* _Nonnull s, int c, size_t n,
394 struct __bionic_zero_size_is_okay_t ok)
395 __overloadable
396 __error_if_overflows_dst(memset, s, n, "size");
397
398__BIONIC_FORTIFY_INLINE
George Burgess IV156d5a82017-02-10 13:56:22 -0800399void* memset(void* const _Nonnull s __pass_object_size0, int c, size_t n,
George Burgess IV7cc779f2017-02-09 00:00:31 -0800400 struct __bionic_zero_size_is_okay_t ok __attribute__((unused)))
401 __overloadable {
402 return __builtin___memset_chk(s, c, n, __bos0(s));
403}
404
405extern struct __bionic_zero_size_is_okay_t __bionic_zero_size_is_okay;
406/* We verify that `c` is non-zero, because as pointless as memset(foo, 0, 0) is,
407 * flipping size + count will do nothing.
408 */
409__BIONIC_ERROR_FUNCTION_VISIBILITY
410void* memset(void* _Nonnull s, int c, size_t n) __overloadable
411 __enable_if(c && !n, "selected when we'll set zero bytes")
412 __RENAME_CLANG(memset)
413 __warnattr_real("will set 0 bytes; maybe the arguments got flipped? "
414 "(Add __bionic_zero_size_is_okay as a fourth argument "
415 "to silence this.)");
Dan Albert9c2094f2017-02-14 19:28:18 -0800416#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR1__ */
George Burgess IV7cc779f2017-02-09 00:00:31 -0800417
418#undef __error_zero_size
419#undef __error_if_overflows_dst
420#else // defined(__clang__)
421extern char* __strncpy_real(char* __restrict, const char*, size_t) __RENAME(strcpy);
422extern void* __memrchr_real(const void*, int, size_t) __RENAME(memrchr);
423extern size_t __strlcpy_real(char* __restrict, const char* __restrict, size_t)
424 __RENAME(strlcpy);
425extern size_t __strlcat_real(char* __restrict, const char* __restrict, size_t)
426 __RENAME(strlcat);
427
428__errordecl(__memchr_buf_size_error, "memchr called with size bigger than buffer");
429__errordecl(__memrchr_buf_size_error, "memrchr called with size bigger than buffer");
430
431#if __ANDROID_API__ >= __ANDROID_API_M__
432__BIONIC_FORTIFY_INLINE
433void* memchr(const void *_Nonnull s __pass_object_size, int c, size_t n) {
434 size_t bos = __bos(s);
435
Daniel Micay4ae77362015-04-17 18:16:57 -0400436 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
437 return __builtin_memchr(s, c, n);
438 }
439
440 if (__builtin_constant_p(n) && (n > bos)) {
441 __memchr_buf_size_error();
442 }
443
444 if (__builtin_constant_p(n) && (n <= bos)) {
445 return __builtin_memchr(s, c, n);
446 }
Daniel Micay4ae77362015-04-17 18:16:57 -0400447
448 return __memchr_chk(s, c, n, bos);
449}
450
451__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700452void* memrchr(const void* s, int c, size_t n) {
Daniel Micay4ae77362015-04-17 18:16:57 -0400453 size_t bos = __bos(s);
454
Daniel Micay4ae77362015-04-17 18:16:57 -0400455 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
456 return __memrchr_real(s, c, n);
457 }
458
459 if (__builtin_constant_p(n) && (n > bos)) {
460 __memrchr_buf_size_error();
461 }
462
463 if (__builtin_constant_p(n) && (n <= bos)) {
464 return __memrchr_real(s, c, n);
465 }
Daniel Micay4ae77362015-04-17 18:16:57 -0400466
467 return __memrchr_chk(s, c, n, bos);
468}
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800469#endif /* __ANDROID_API__ >= __ANDROID_API_M__ */
Daniel Micay4ae77362015-04-17 18:16:57 -0400470
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800471#if __ANDROID_API__ >= __ANDROID_API_L__
Christopher Ferris950a58e2014-04-04 14:38:18 -0700472__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700473char* stpncpy(char* _Nonnull __restrict dst, const char* _Nonnull __restrict src, size_t n) {
474 size_t bos_dst = __bos(dst);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700475 size_t bos_src = __bos(src);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700476
477 if (bos_src == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700478 return __builtin___stpncpy_chk(dst, src, n, bos_dst);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700479 }
480
481 if (__builtin_constant_p(n) && (n <= bos_src)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700482 return __builtin___stpncpy_chk(dst, src, n, bos_dst);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700483 }
484
485 size_t slen = __builtin_strlen(src);
486 if (__builtin_constant_p(slen)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700487 return __builtin___stpncpy_chk(dst, src, n, bos_dst);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700488 }
489
Elliott Hughes5470c182016-07-22 11:36:17 -0700490 return __stpncpy_chk2(dst, src, n, bos_dst, bos_src);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700491}
492
Nick Kralevich0a230152012-06-04 15:20:25 -0700493__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700494char* strncpy(char* _Nonnull __restrict dst, const char* _Nonnull __restrict src, size_t n) {
495 size_t bos_dst = __bos(dst);
Nick Kralevich93501d32013-08-28 10:47:43 -0700496 size_t bos_src = __bos(src);
Nick Kralevich93501d32013-08-28 10:47:43 -0700497
498 if (bos_src == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800499 return __strncpy_real(dst, src, n);
Nick Kralevich93501d32013-08-28 10:47:43 -0700500 }
501
Nick Kralevichd13c2b12013-09-27 13:21:24 -0700502 if (__builtin_constant_p(n) && (n <= bos_src)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700503 return __builtin___strncpy_chk(dst, src, n, bos_dst);
Nick Kralevichd13c2b12013-09-27 13:21:24 -0700504 }
505
Nick Kralevich93501d32013-08-28 10:47:43 -0700506 size_t slen = __builtin_strlen(src);
507 if (__builtin_constant_p(slen)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700508 return __builtin___strncpy_chk(dst, src, n, bos_dst);
Nick Kralevich93501d32013-08-28 10:47:43 -0700509 }
510
Elliott Hughes5470c182016-07-22 11:36:17 -0700511 return __strncpy_chk2(dst, src, n, bos_dst, bos_src);
Nick Kralevich0a230152012-06-04 15:20:25 -0700512}
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800513#endif /* __ANDROID_API__ >= __ANDROID_API_L__ */
Nick Kralevich0a230152012-06-04 15:20:25 -0700514
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800515#if __ANDROID_API__ >= __ANDROID_API_J_MR1__
Nick Kralevich0a230152012-06-04 15:20:25 -0700516__BIONIC_FORTIFY_INLINE
George Burgess IV7cc779f2017-02-09 00:00:31 -0800517size_t strlcpy(char* _Nonnull __restrict dst __pass_object_size,
518 const char* _Nonnull __restrict src, size_t size) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700519 size_t bos = __bos(dst);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700520
521 // Compiler doesn't know destination size. Don't call __strlcpy_chk
Nick Kralevich9b6cc222012-07-13 14:46:36 -0700522 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700523 return __strlcpy_real(dst, src, size);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700524 }
525
526 // Compiler can prove, at compile time, that the passed in size
527 // is always <= the actual object size. Don't call __strlcpy_chk
528 if (__builtin_constant_p(size) && (size <= bos)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700529 return __strlcpy_real(dst, src, size);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700530 }
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700531
Elliott Hughes5470c182016-07-22 11:36:17 -0700532 return __strlcpy_chk(dst, src, size, bos);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700533}
534
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700535__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700536size_t strlcat(char* _Nonnull __restrict dst, const char* _Nonnull __restrict src, size_t size) {
537 size_t bos = __bos(dst);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700538
539 // Compiler doesn't know destination size. Don't call __strlcat_chk
Nick Kralevich9b6cc222012-07-13 14:46:36 -0700540 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700541 return __strlcat_real(dst, src, size);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700542 }
543
544 // Compiler can prove, at compile time, that the passed in size
545 // is always <= the actual object size. Don't call __strlcat_chk
546 if (__builtin_constant_p(size) && (size <= bos)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700547 return __strlcat_real(dst, src, size);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700548 }
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700549
Elliott Hughes5470c182016-07-22 11:36:17 -0700550 return __strlcat_chk(dst, src, size, bos);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700551}
552
Nick Kralevich260bf8c2012-07-13 11:27:06 -0700553__BIONIC_FORTIFY_INLINE
George Burgess IV7cc779f2017-02-09 00:00:31 -0800554size_t strlen(const char* _Nonnull s) __overloadable {
Nick Kralevich9020fd52013-04-30 11:31:35 -0700555 size_t bos = __bos(s);
Nick Kralevich9b6cc222012-07-13 14:46:36 -0700556
557 // Compiler doesn't know destination size. Don't call __strlen_chk
558 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Nick Kralevicha44e9af2013-01-17 15:41:33 -0800559 return __builtin_strlen(s);
560 }
561
562 size_t slen = __builtin_strlen(s);
563 if (__builtin_constant_p(slen)) {
564 return slen;
Nick Kralevich260bf8c2012-07-13 11:27:06 -0700565 }
Nick Kralevich9b6cc222012-07-13 14:46:36 -0700566
Nick Kralevich260bf8c2012-07-13 11:27:06 -0700567 return __strlen_chk(s, bos);
568}
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800569#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR1__ */
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700570
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800571#if __ANDROID_API__ >= __ANDROID_API_J_MR2__
Nick Kralevich049e5832012-11-30 15:15:58 -0800572__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700573char* strchr(const char* _Nonnull s, int c) {
Nick Kralevich9020fd52013-04-30 11:31:35 -0700574 size_t bos = __bos(s);
Nick Kralevich049e5832012-11-30 15:15:58 -0800575
576 // Compiler doesn't know destination size. Don't call __strchr_chk
577 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Nick Kralevicha44e9af2013-01-17 15:41:33 -0800578 return __builtin_strchr(s, c);
579 }
580
581 size_t slen = __builtin_strlen(s);
582 if (__builtin_constant_p(slen) && (slen < bos)) {
583 return __builtin_strchr(s, c);
Nick Kralevich049e5832012-11-30 15:15:58 -0800584 }
585
586 return __strchr_chk(s, c, bos);
587}
588
Nick Kralevich9a4d3052012-12-03 10:36:13 -0800589__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700590char* strrchr(const char* _Nonnull s, int c) {
Nick Kralevich3b2e6bc2013-04-30 14:19:23 -0700591 size_t bos = __bos(s);
Nick Kralevich9a4d3052012-12-03 10:36:13 -0800592
593 // Compiler doesn't know destination size. Don't call __strrchr_chk
594 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Nick Kralevicha44e9af2013-01-17 15:41:33 -0800595 return __builtin_strrchr(s, c);
596 }
597
598 size_t slen = __builtin_strlen(s);
599 if (__builtin_constant_p(slen) && (slen < bos)) {
600 return __builtin_strrchr(s, c);
Nick Kralevich9a4d3052012-12-03 10:36:13 -0800601 }
602
603 return __strrchr_chk(s, c, bos);
604}
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800605#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR2__ */
George Burgess IV7cc779f2017-02-09 00:00:31 -0800606#endif /* defined(__clang__) */
Elliott Hughes890c8ed2013-03-22 10:58:55 -0700607#endif /* defined(__BIONIC_FORTIFY) */
Nick Kralevich0a230152012-06-04 15:20:25 -0700608
Elliott Hughes5470c182016-07-22 11:36:17 -0700609#if defined(__clang__)
610#pragma clang diagnostic pop
611#endif
612
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800613__END_DECLS
614
Elliott Hughes09c39d62014-08-19 14:30:30 -0700615#endif /* _STRING_H */