blob: c15fe4acb606e0ff465cca4c251910848e36766e [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)
Josh Gao16d9ba82017-06-30 13:20:28 -070070extern "C++" char* strchrnul(char* _Nonnull, int) __RENAME(strchrnul) __attribute_pure__ __INTRODUCED_IN(24);
71extern "C++" const char* strchrnul(const char* _Nonnull, int) __RENAME(strchrnul) __attribute_pure__ __INTRODUCED_IN(24);
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)
Josh Gao16d9ba82017-06-30 13:20:28 -0700145extern "C++" char* basename(char* _Nonnull) __RENAME(__gnu_basename) __INTRODUCED_IN(23);
146extern "C++" const char* basename(const char* _Nonnull) __RENAME(__gnu_basename) __INTRODUCED_IN(23);
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 IV19710f72017-04-05 13:24:05 -0700171void* memcpy(void* _Nonnull __restrict const dst __pass_object_size0, const void* _Nonnull __restrict src, size_t copy_amount)
172 __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800173 return __builtin___memcpy_chk(dst, src, copy_amount, __bos0(dst));
174}
175
176__BIONIC_FORTIFY_INLINE
George Burgess IV19710f72017-04-05 13:24:05 -0700177void* memmove(void* const _Nonnull dst __pass_object_size0, const void* _Nonnull src, size_t len)
178 __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800179 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
George Burgess IV19710f72017-04-05 13:24:05 -0700185char* stpcpy(char* _Nonnull __restrict const dst __pass_object_size, const char* _Nonnull __restrict src)
186 __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800187 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
George Burgess IV19710f72017-04-05 13:24:05 -0700193char* strcpy(char* _Nonnull __restrict const dst __pass_object_size, const char* _Nonnull __restrict src)
194 __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800195 return __builtin___strcpy_chk(dst, src, __bos(dst));
196}
George Burgess IV7cc779f2017-02-09 00:00:31 -0800197
198__BIONIC_FORTIFY_INLINE
George Burgess IV19710f72017-04-05 13:24:05 -0700199char* strcat(char* _Nonnull __restrict const dst __pass_object_size, const char* _Nonnull __restrict src)
200 __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800201 return __builtin___strcat_chk(dst, src, __bos(dst));
202}
203
204__BIONIC_FORTIFY_INLINE
George Burgess IV19710f72017-04-05 13:24:05 -0700205char* strncat(char* const _Nonnull __restrict dst __pass_object_size, const char* _Nonnull __restrict src, size_t n)
206 __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800207 return __builtin___strncat_chk(dst, src, n, __bos(dst));
208}
209
210__BIONIC_FORTIFY_INLINE
George Burgess IV19710f72017-04-05 13:24:05 -0700211void* memset(void* const _Nonnull s __pass_object_size0, int c, size_t n) __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800212 return __builtin___memset_chk(s, c, n, __bos0(s));
213}
Dan Albert9c2094f2017-02-14 19:28:18 -0800214#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR1__ */
George Burgess IV7cc779f2017-02-09 00:00:31 -0800215
216
217#if defined(__clang__)
218
219#define __error_if_overflows_dst(name, dst, n, what) \
220 __enable_if(__bos0(dst) != __BIONIC_FORTIFY_UNKNOWN_SIZE && \
221 __bos0(dst) < (n), "selected when the buffer is too small") \
222 __errorattr(#name " called with " what " bigger than buffer")
223
224/*
225 * N.B. _Nonnull isn't necessary on params, since these functions just emit
226 * errors.
227 */
228__BIONIC_ERROR_FUNCTION_VISIBILITY
229void* memcpy(void* dst, const void* src, size_t copy_amount) __overloadable
230 __error_if_overflows_dst(memcpy, dst, copy_amount, "size");
231
232__BIONIC_ERROR_FUNCTION_VISIBILITY
233void* memmove(void *dst, const void* src, size_t len) __overloadable
234 __error_if_overflows_dst(memmove, dst, len, "size");
235
236__BIONIC_ERROR_FUNCTION_VISIBILITY
237void* memset(void* s, int c, size_t n) __overloadable
238 __error_if_overflows_dst(memset, s, n, "size");
239
240__BIONIC_ERROR_FUNCTION_VISIBILITY
241char* stpcpy(char* dst, const char* src) __overloadable
242 __error_if_overflows_dst(stpcpy, dst, __builtin_strlen(src), "string");
243
244__BIONIC_ERROR_FUNCTION_VISIBILITY
245char* strcpy(char* dst, const char* src) __overloadable
246 __error_if_overflows_dst(strcpy, dst, __builtin_strlen(src), "string");
Nick Kralevich0a230152012-06-04 15:20:25 -0700247
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800248#if __ANDROID_API__ >= __ANDROID_API_M__
Nick Kralevich0a230152012-06-04 15:20:25 -0700249__BIONIC_FORTIFY_INLINE
George Burgess IV7cc779f2017-02-09 00:00:31 -0800250void* memchr(const void* const _Nonnull s __pass_object_size, int c, size_t n)
251 __overloadable {
Daniel Micay4ae77362015-04-17 18:16:57 -0400252 size_t bos = __bos(s);
253
George Burgess IV7cc779f2017-02-09 00:00:31 -0800254 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
255 return __builtin_memchr(s, c, n);
256 }
257
258 return __memchr_chk(s, c, n, bos);
259}
260
261__BIONIC_FORTIFY_INLINE
262void* memrchr(const void* const _Nonnull s __pass_object_size, int c, size_t n)
263 __overloadable {
264 size_t bos = __bos(s);
265
266 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
267 return __call_bypassing_fortify(memrchr)(s, c, n);
268 }
269
270 return __memrchr_chk(s, c, n, bos);
271}
272#endif /* __ANDROID_API__ >= __ANDROID_API_M__ */
273
274#if __ANDROID_API__ >= __ANDROID_API_L__
275__BIONIC_FORTIFY_INLINE
George Burgess IV19710f72017-04-05 13:24:05 -0700276char* stpncpy(char* __restrict const _Nonnull dst __pass_object_size, const char* __restrict const _Nonnull src __pass_object_size, size_t n)
277 __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800278 size_t bos_dst = __bos(dst);
279 size_t bos_src = __bos(src);
280
281 /* Ignore dst size checks; they're handled in strncpy_chk */
282 if (bos_src == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
283 return __builtin___stpncpy_chk(dst, src, n, bos_dst);
284 }
285
286 return __stpncpy_chk2(dst, src, n, bos_dst, bos_src);
287}
George Burgess IV7cc779f2017-02-09 00:00:31 -0800288
George Burgess IV7cc779f2017-02-09 00:00:31 -0800289__BIONIC_FORTIFY_INLINE
George Burgess IV19710f72017-04-05 13:24:05 -0700290char* strncpy(char* __restrict const _Nonnull dst __pass_object_size, const char* __restrict const _Nonnull src __pass_object_size, size_t n)
291 __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800292 size_t bos_dst = __bos(dst);
293 size_t bos_src = __bos(src);
294
295 /* Ignore dst size checks; they're handled in strncpy_chk */
296 if (bos_src == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
297 return __builtin___strncpy_chk(dst, src, n, bos_dst);
298 }
299
300 return __strncpy_chk2(dst, src, n, bos_dst, bos_src);
301}
Dan Albert9c2094f2017-02-14 19:28:18 -0800302#endif /* __ANDROID_API__ >= __ANDROID_API_L__ */
George Burgess IV7cc779f2017-02-09 00:00:31 -0800303
Dan Albert9c2094f2017-02-14 19:28:18 -0800304#if __ANDROID_API__ >= __ANDROID_API_J_MR1__
George Burgess IV7cc779f2017-02-09 00:00:31 -0800305__BIONIC_FORTIFY_INLINE
George Burgess IV19710f72017-04-05 13:24:05 -0700306size_t strlcpy(char* const _Nonnull __restrict dst __pass_object_size, const char *_Nonnull __restrict src, size_t size)
307 __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800308 size_t bos = __bos(dst);
309
310 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
311 return __call_bypassing_fortify(strlcpy)(dst, src, size);
312 }
313
314 return __strlcpy_chk(dst, src, size, bos);
315}
316
317__BIONIC_FORTIFY_INLINE
George Burgess IV19710f72017-04-05 13:24:05 -0700318size_t strlcat(char* const _Nonnull __restrict dst __pass_object_size, const char* _Nonnull __restrict src, size_t size)
319 __overloadable {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800320 size_t bos = __bos(dst);
321
322 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
323 return __call_bypassing_fortify(strlcat)(dst, src, size);
324 }
325
326 return __strlcat_chk(dst, src, size, bos);
327}
328
329/*
330 * If we can evaluate the size of s at compile-time, just call __builtin_strlen
331 * on it directly. This makes it way easier for compilers to fold things like
332 * strlen("Foo") into a constant, as users would expect. -1ULL is chosen simply
333 * because it's large.
334 */
335__BIONIC_FORTIFY_INLINE
336size_t strlen(const char* const _Nonnull s __pass_object_size)
337 __overloadable __enable_if(__builtin_strlen(s) != -1ULL,
338 "enabled if s is a known good string.") {
339 return __builtin_strlen(s);
340}
341
342__BIONIC_FORTIFY_INLINE
George Burgess IV156d5a82017-02-10 13:56:22 -0800343size_t strlen(const char* const _Nonnull s __pass_object_size0)
George Burgess IV7cc779f2017-02-09 00:00:31 -0800344 __overloadable {
345 size_t bos = __bos0(s);
346
347 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
348 return __builtin_strlen(s);
349 }
350
351 // return __builtin_strlen(s);
352 return __strlen_chk(s, bos);
353}
354#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR1__ */
355
356#if __ANDROID_API__ >= __ANDROID_API_J_MR2__
357__BIONIC_FORTIFY_INLINE
George Burgess IVbce9a7d2017-04-03 18:03:36 -0700358char* strchr(const char* const _Nonnull s __pass_object_size, int c)
George Burgess IV7cc779f2017-02-09 00:00:31 -0800359 __overloadable {
George Burgess IVbce9a7d2017-04-03 18:03:36 -0700360 size_t bos = __bos(s);
George Burgess IV7cc779f2017-02-09 00:00:31 -0800361
362 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
363 return __builtin_strchr(s, c);
364 }
365
George Burgess IV7cc779f2017-02-09 00:00:31 -0800366 return __strchr_chk(s, c, bos);
367}
368
369__BIONIC_FORTIFY_INLINE
370char* strrchr(const char* const _Nonnull s __pass_object_size, int c)
371 __overloadable {
372 size_t bos = __bos(s);
373
374 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
375 return __builtin_strrchr(s, c);
376 }
377
378 return __strrchr_chk(s, c, bos);
379}
380#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR2__ */
381
Dan Albert9c2094f2017-02-14 19:28:18 -0800382#if __ANDROID_API__ >= __ANDROID_API_J_MR1__
George Burgess IV7cc779f2017-02-09 00:00:31 -0800383/* In *many* cases, memset(foo, sizeof(foo), 0) is a mistake where the user has
384 * flipped the size + value arguments. However, there may be cases (e.g. with
385 * macros) where it's okay for the size to fold to zero. We should warn on this,
386 * but we should also provide a FORTIFY'ed escape hatch.
387 */
388__BIONIC_ERROR_FUNCTION_VISIBILITY
George Burgess IV19710f72017-04-05 13:24:05 -0700389void* memset(void* _Nonnull s, int c, size_t n, struct __bionic_zero_size_is_okay_t ok)
George Burgess IV7cc779f2017-02-09 00:00:31 -0800390 __overloadable
391 __error_if_overflows_dst(memset, s, n, "size");
392
393__BIONIC_FORTIFY_INLINE
George Burgess IV19710f72017-04-05 13:24:05 -0700394void* memset(void* const _Nonnull s __pass_object_size0, int c, size_t n, struct __bionic_zero_size_is_okay_t ok __attribute__((unused)))
George Burgess IV7cc779f2017-02-09 00:00:31 -0800395 __overloadable {
396 return __builtin___memset_chk(s, c, n, __bos0(s));
397}
398
399extern struct __bionic_zero_size_is_okay_t __bionic_zero_size_is_okay;
400/* We verify that `c` is non-zero, because as pointless as memset(foo, 0, 0) is,
401 * flipping size + count will do nothing.
402 */
403__BIONIC_ERROR_FUNCTION_VISIBILITY
404void* memset(void* _Nonnull s, int c, size_t n) __overloadable
405 __enable_if(c && !n, "selected when we'll set zero bytes")
406 __RENAME_CLANG(memset)
407 __warnattr_real("will set 0 bytes; maybe the arguments got flipped? "
408 "(Add __bionic_zero_size_is_okay as a fourth argument "
409 "to silence this.)");
Dan Albert9c2094f2017-02-14 19:28:18 -0800410#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR1__ */
George Burgess IV7cc779f2017-02-09 00:00:31 -0800411
412#undef __error_zero_size
413#undef __error_if_overflows_dst
414#else // defined(__clang__)
George Burgess IV31e5a352017-04-18 18:28:19 -0700415extern char* __strncpy_real(char* __restrict, const char*, size_t) __RENAME(strncpy);
George Burgess IV7cc779f2017-02-09 00:00:31 -0800416extern void* __memrchr_real(const void*, int, size_t) __RENAME(memrchr);
417extern size_t __strlcpy_real(char* __restrict, const char* __restrict, size_t)
418 __RENAME(strlcpy);
419extern size_t __strlcat_real(char* __restrict, const char* __restrict, size_t)
420 __RENAME(strlcat);
421
422__errordecl(__memchr_buf_size_error, "memchr called with size bigger than buffer");
423__errordecl(__memrchr_buf_size_error, "memrchr called with size bigger than buffer");
424
425#if __ANDROID_API__ >= __ANDROID_API_M__
426__BIONIC_FORTIFY_INLINE
427void* memchr(const void *_Nonnull s __pass_object_size, int c, size_t n) {
428 size_t bos = __bos(s);
429
Daniel Micay4ae77362015-04-17 18:16:57 -0400430 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
431 return __builtin_memchr(s, c, n);
432 }
433
434 if (__builtin_constant_p(n) && (n > bos)) {
435 __memchr_buf_size_error();
436 }
437
438 if (__builtin_constant_p(n) && (n <= bos)) {
439 return __builtin_memchr(s, c, n);
440 }
Daniel Micay4ae77362015-04-17 18:16:57 -0400441
442 return __memchr_chk(s, c, n, bos);
443}
444
445__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700446void* memrchr(const void* s, int c, size_t n) {
Daniel Micay4ae77362015-04-17 18:16:57 -0400447 size_t bos = __bos(s);
448
Daniel Micay4ae77362015-04-17 18:16:57 -0400449 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
450 return __memrchr_real(s, c, n);
451 }
452
453 if (__builtin_constant_p(n) && (n > bos)) {
454 __memrchr_buf_size_error();
455 }
456
457 if (__builtin_constant_p(n) && (n <= bos)) {
458 return __memrchr_real(s, c, n);
459 }
Daniel Micay4ae77362015-04-17 18:16:57 -0400460
461 return __memrchr_chk(s, c, n, bos);
462}
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800463#endif /* __ANDROID_API__ >= __ANDROID_API_M__ */
Daniel Micay4ae77362015-04-17 18:16:57 -0400464
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800465#if __ANDROID_API__ >= __ANDROID_API_L__
Christopher Ferris950a58e2014-04-04 14:38:18 -0700466__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700467char* stpncpy(char* _Nonnull __restrict dst, const char* _Nonnull __restrict src, size_t n) {
468 size_t bos_dst = __bos(dst);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700469 size_t bos_src = __bos(src);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700470
471 if (bos_src == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700472 return __builtin___stpncpy_chk(dst, src, n, bos_dst);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700473 }
474
475 if (__builtin_constant_p(n) && (n <= bos_src)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700476 return __builtin___stpncpy_chk(dst, src, n, bos_dst);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700477 }
478
479 size_t slen = __builtin_strlen(src);
480 if (__builtin_constant_p(slen)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700481 return __builtin___stpncpy_chk(dst, src, n, bos_dst);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700482 }
483
Elliott Hughes5470c182016-07-22 11:36:17 -0700484 return __stpncpy_chk2(dst, src, n, bos_dst, bos_src);
Christopher Ferris950a58e2014-04-04 14:38:18 -0700485}
486
Nick Kralevich0a230152012-06-04 15:20:25 -0700487__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700488char* strncpy(char* _Nonnull __restrict dst, const char* _Nonnull __restrict src, size_t n) {
489 size_t bos_dst = __bos(dst);
Nick Kralevich93501d32013-08-28 10:47:43 -0700490 size_t bos_src = __bos(src);
Nick Kralevich93501d32013-08-28 10:47:43 -0700491
492 if (bos_src == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
George Burgess IV7cc779f2017-02-09 00:00:31 -0800493 return __strncpy_real(dst, src, n);
Nick Kralevich93501d32013-08-28 10:47:43 -0700494 }
495
Nick Kralevichd13c2b12013-09-27 13:21:24 -0700496 if (__builtin_constant_p(n) && (n <= bos_src)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700497 return __builtin___strncpy_chk(dst, src, n, bos_dst);
Nick Kralevichd13c2b12013-09-27 13:21:24 -0700498 }
499
Nick Kralevich93501d32013-08-28 10:47:43 -0700500 size_t slen = __builtin_strlen(src);
501 if (__builtin_constant_p(slen)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700502 return __builtin___strncpy_chk(dst, src, n, bos_dst);
Nick Kralevich93501d32013-08-28 10:47:43 -0700503 }
504
Elliott Hughes5470c182016-07-22 11:36:17 -0700505 return __strncpy_chk2(dst, src, n, bos_dst, bos_src);
Nick Kralevich0a230152012-06-04 15:20:25 -0700506}
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800507#endif /* __ANDROID_API__ >= __ANDROID_API_L__ */
Nick Kralevich0a230152012-06-04 15:20:25 -0700508
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800509#if __ANDROID_API__ >= __ANDROID_API_J_MR1__
Nick Kralevich0a230152012-06-04 15:20:25 -0700510__BIONIC_FORTIFY_INLINE
George Burgess IV19710f72017-04-05 13:24:05 -0700511size_t strlcpy(char* _Nonnull __restrict dst __pass_object_size, const char* _Nonnull __restrict src, size_t size) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700512 size_t bos = __bos(dst);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700513
514 // Compiler doesn't know destination size. Don't call __strlcpy_chk
Nick Kralevich9b6cc222012-07-13 14:46:36 -0700515 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700516 return __strlcpy_real(dst, src, size);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700517 }
518
519 // Compiler can prove, at compile time, that the passed in size
520 // is always <= the actual object size. Don't call __strlcpy_chk
521 if (__builtin_constant_p(size) && (size <= bos)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700522 return __strlcpy_real(dst, src, size);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700523 }
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700524
Elliott Hughes5470c182016-07-22 11:36:17 -0700525 return __strlcpy_chk(dst, src, size, bos);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700526}
527
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700528__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700529size_t strlcat(char* _Nonnull __restrict dst, const char* _Nonnull __restrict src, size_t size) {
530 size_t bos = __bos(dst);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700531
532 // Compiler doesn't know destination size. Don't call __strlcat_chk
Nick Kralevich9b6cc222012-07-13 14:46:36 -0700533 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700534 return __strlcat_real(dst, src, size);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700535 }
536
537 // Compiler can prove, at compile time, that the passed in size
538 // is always <= the actual object size. Don't call __strlcat_chk
539 if (__builtin_constant_p(size) && (size <= bos)) {
Elliott Hughes5470c182016-07-22 11:36:17 -0700540 return __strlcat_real(dst, src, size);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700541 }
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700542
Elliott Hughes5470c182016-07-22 11:36:17 -0700543 return __strlcat_chk(dst, src, size, bos);
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700544}
545
Nick Kralevich260bf8c2012-07-13 11:27:06 -0700546__BIONIC_FORTIFY_INLINE
George Burgess IV7cc779f2017-02-09 00:00:31 -0800547size_t strlen(const char* _Nonnull s) __overloadable {
Nick Kralevich9020fd52013-04-30 11:31:35 -0700548 size_t bos = __bos(s);
Nick Kralevich9b6cc222012-07-13 14:46:36 -0700549
550 // Compiler doesn't know destination size. Don't call __strlen_chk
551 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Nick Kralevicha44e9af2013-01-17 15:41:33 -0800552 return __builtin_strlen(s);
553 }
554
555 size_t slen = __builtin_strlen(s);
556 if (__builtin_constant_p(slen)) {
557 return slen;
Nick Kralevich260bf8c2012-07-13 11:27:06 -0700558 }
Nick Kralevich9b6cc222012-07-13 14:46:36 -0700559
Nick Kralevich260bf8c2012-07-13 11:27:06 -0700560 return __strlen_chk(s, bos);
561}
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800562#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR1__ */
Nick Kralevich8df49ad2012-06-13 16:57:27 -0700563
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800564#if __ANDROID_API__ >= __ANDROID_API_J_MR2__
Nick Kralevich049e5832012-11-30 15:15:58 -0800565__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700566char* strchr(const char* _Nonnull s, int c) {
Nick Kralevich9020fd52013-04-30 11:31:35 -0700567 size_t bos = __bos(s);
Nick Kralevich049e5832012-11-30 15:15:58 -0800568
569 // Compiler doesn't know destination size. Don't call __strchr_chk
570 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Nick Kralevicha44e9af2013-01-17 15:41:33 -0800571 return __builtin_strchr(s, c);
572 }
573
574 size_t slen = __builtin_strlen(s);
575 if (__builtin_constant_p(slen) && (slen < bos)) {
576 return __builtin_strchr(s, c);
Nick Kralevich049e5832012-11-30 15:15:58 -0800577 }
578
579 return __strchr_chk(s, c, bos);
580}
581
Nick Kralevich9a4d3052012-12-03 10:36:13 -0800582__BIONIC_FORTIFY_INLINE
Elliott Hughes5470c182016-07-22 11:36:17 -0700583char* strrchr(const char* _Nonnull s, int c) {
Nick Kralevich3b2e6bc2013-04-30 14:19:23 -0700584 size_t bos = __bos(s);
Nick Kralevich9a4d3052012-12-03 10:36:13 -0800585
586 // Compiler doesn't know destination size. Don't call __strrchr_chk
587 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
Nick Kralevicha44e9af2013-01-17 15:41:33 -0800588 return __builtin_strrchr(s, c);
589 }
590
591 size_t slen = __builtin_strlen(s);
592 if (__builtin_constant_p(slen) && (slen < bos)) {
593 return __builtin_strrchr(s, c);
Nick Kralevich9a4d3052012-12-03 10:36:13 -0800594 }
595
596 return __strrchr_chk(s, c, bos);
597}
Elliott Hughes5bc78c82016-11-16 11:35:43 -0800598#endif /* __ANDROID_API__ >= __ANDROID_API_J_MR2__ */
George Burgess IV7cc779f2017-02-09 00:00:31 -0800599#endif /* defined(__clang__) */
Elliott Hughes890c8ed2013-03-22 10:58:55 -0700600#endif /* defined(__BIONIC_FORTIFY) */
Nick Kralevich0a230152012-06-04 15:20:25 -0700601
George Burgess IVbd3d2082017-04-04 17:34:02 -0700602/* Const-correct overloads. Placed after FORTIFY so we call those functions, if possible. */
603#if defined(__cplusplus) && defined(__clang__)
604/*
605 * Use two enable_ifs so these overloads don't conflict with + are preferred over libcxx's. This can
606 * be reduced to 1 after libcxx recognizes that we have const-correct overloads.
607 */
608#define __prefer_this_overload __enable_if(true, "preferred overload") __enable_if(true, "")
609extern "C++" {
610inline __always_inline
611void* __bionic_memchr(const void* const _Nonnull s __pass_object_size, int c, size_t n) {
612 return memchr(s, c, n);
613}
614
615inline __always_inline
616const void* memchr(const void* const _Nonnull s __pass_object_size, int c, size_t n)
617 __prefer_this_overload {
618 return __bionic_memchr(s, c, n);
619}
620
621inline __always_inline
622void* memchr(void* const _Nonnull s __pass_object_size, int c, size_t n) __prefer_this_overload {
623 return __bionic_memchr(s, c, n);
624}
625
626inline __always_inline
627char* __bionic_strchr(const char* const _Nonnull s __pass_object_size, int c) {
628 return strchr(s, c);
629}
630
631inline __always_inline
632const char* strchr(const char* const _Nonnull s __pass_object_size, int c)
633 __prefer_this_overload {
634 return __bionic_strchr(s, c);
635}
636
637inline __always_inline
638char* strchr(char* const _Nonnull s __pass_object_size, int c)
639 __prefer_this_overload {
640 return __bionic_strchr(s, c);
641}
642
643inline __always_inline
644char* __bionic_strrchr(const char* const _Nonnull s __pass_object_size, int c) {
645 return strrchr(s, c);
646}
647
648inline __always_inline
649const char* strrchr(const char* const _Nonnull s __pass_object_size, int c) __prefer_this_overload {
650 return __bionic_strrchr(s, c);
651}
652
653inline __always_inline
654char* strrchr(char* const _Nonnull s __pass_object_size, int c) __prefer_this_overload {
655 return __bionic_strrchr(s, c);
656}
657
658/* Functions with no FORTIFY counterpart. */
659inline __always_inline
660char* __bionic_strstr(const char* _Nonnull h, const char* _Nonnull n) { return strstr(h, n); }
661
662inline __always_inline
663const char* strstr(const char* _Nonnull h, const char* _Nonnull n) __prefer_this_overload {
664 return __bionic_strstr(h, n);
665}
666
667inline __always_inline
668char* strstr(char* _Nonnull h, const char* _Nonnull n) __prefer_this_overload {
669 return __bionic_strstr(h, n);
670}
671
672inline __always_inline
673char* __bionic_strpbrk(const char* _Nonnull h, const char* _Nonnull n) { return strpbrk(h, n); }
674
675inline __always_inline
676char* strpbrk(char* _Nonnull h, const char* _Nonnull n) __prefer_this_overload {
677 return __bionic_strpbrk(h, n);
678}
679
680inline __always_inline
681const char* strpbrk(const char* _Nonnull h, const char* _Nonnull n) __prefer_this_overload {
682 return __bionic_strpbrk(h, n);
683}
684}
685#undef __prefer_this_overload
686#endif
687
Elliott Hughes5470c182016-07-22 11:36:17 -0700688#if defined(__clang__)
689#pragma clang diagnostic pop
690#endif
691
The Android Open Source Project1dc9e472009-03-03 19:28:35 -0800692__END_DECLS
693
Elliott Hughes09c39d62014-08-19 14:30:30 -0700694#endif /* _STRING_H */