xref: /xnu-10002.41.9/osfmk/machine/string.h (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions /*
2*699cd480SApple OSS Distributions  * Copyright (c) 2022 Apple Inc. All rights reserved.
3*699cd480SApple OSS Distributions  *
4*699cd480SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*699cd480SApple OSS Distributions  *
6*699cd480SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*699cd480SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*699cd480SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*699cd480SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*699cd480SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*699cd480SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*699cd480SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*699cd480SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*699cd480SApple OSS Distributions  *
15*699cd480SApple OSS Distributions  * Please obtain a copy of the License at
16*699cd480SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*699cd480SApple OSS Distributions  *
18*699cd480SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*699cd480SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*699cd480SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*699cd480SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*699cd480SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*699cd480SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*699cd480SApple OSS Distributions  * limitations under the License.
25*699cd480SApple OSS Distributions  *
26*699cd480SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*699cd480SApple OSS Distributions  */
28*699cd480SApple OSS Distributions 
29*699cd480SApple OSS Distributions #ifndef _MACHINE_STRING_H_
30*699cd480SApple OSS Distributions #define _MACHINE_STRING_H_
31*699cd480SApple OSS Distributions 
32*699cd480SApple OSS Distributions #include <sys/cdefs.h>
33*699cd480SApple OSS Distributions #include <types.h>
34*699cd480SApple OSS Distributions 
35*699cd480SApple OSS Distributions #if defined (__i386__) || defined (__x86_64__)
36*699cd480SApple OSS Distributions #include "i386/string.h"
37*699cd480SApple OSS Distributions #elif defined (__arm__) || defined (__arm64__)
38*699cd480SApple OSS Distributions #include "arm/string.h"
39*699cd480SApple OSS Distributions #else
40*699cd480SApple OSS Distributions #error architecture not supported
41*699cd480SApple OSS Distributions #endif
42*699cd480SApple OSS Distributions 
43*699cd480SApple OSS Distributions /*
44*699cd480SApple OSS Distributions  * Below are prototypes that call into a precise symbol,
45*699cd480SApple OSS Distributions  * and prevent the compiler from using a builtin.
46*699cd480SApple OSS Distributions  */
47*699cd480SApple OSS Distributions 
48*699cd480SApple OSS Distributions /*
49*699cd480SApple OSS Distributions  * Memory functions
50*699cd480SApple OSS Distributions  */
51*699cd480SApple OSS Distributions extern int bcmp_impl(const void *, const void *, size_t) asm("_bcmp");
52*699cd480SApple OSS Distributions extern int memcmp_impl(const void *, const void *, size_t) asm("_memcmp");
53*699cd480SApple OSS Distributions 
54*699cd480SApple OSS Distributions extern void *bzero_impl(void *, const void *, size_t) asm("_bzero");
55*699cd480SApple OSS Distributions extern void *memset_impl(void *, int c, size_t) asm("_memset");
56*699cd480SApple OSS Distributions 
57*699cd480SApple OSS Distributions extern void *memcpy_impl(void *, const void *, size_t) asm("_memcpy");
58*699cd480SApple OSS Distributions extern void *memmove_impl(void *, const void *, size_t) asm("_memmove");
59*699cd480SApple OSS Distributions extern void bcopy_impl(const void *, void *, size_t) asm("_bcopy");
60*699cd480SApple OSS Distributions 
61*699cd480SApple OSS Distributions /*
62*699cd480SApple OSS Distributions  * String functions
63*699cd480SApple OSS Distributions  */
64*699cd480SApple OSS Distributions extern size_t strlen_impl(const char *) asm("_strlen");
65*699cd480SApple OSS Distributions extern size_t strnlen_impl(const char *s, size_t) asm("_strnlen");
66*699cd480SApple OSS Distributions 
67*699cd480SApple OSS Distributions extern int strcmp_impl(const char *, const char *) asm("_strcmp");
68*699cd480SApple OSS Distributions extern int strncmp_impl(const char *, const char *, size_t) asm("_strncmp");
69*699cd480SApple OSS Distributions extern int strcasecmp_impl(const char *, const char *) asm("_strcasecmp");
70*699cd480SApple OSS Distributions extern int strncasecmp_impl(const char *, const char *, size_t) asm("_strncasecmp");
71*699cd480SApple OSS Distributions 
72*699cd480SApple OSS Distributions extern char *strchr_impl(const char *, int) asm("_strchr");
73*699cd480SApple OSS Distributions extern char *strrchr_impl(const char *, int) asm("_strrchr");
74*699cd480SApple OSS Distributions extern char *strnstr_impl(const char *s, const char *, size_t) asm("_strnstr");
75*699cd480SApple OSS Distributions 
76*699cd480SApple OSS Distributions extern size_t strlcat_impl(char *, const char *, size_t) asm("_strlcat");
77*699cd480SApple OSS Distributions extern size_t strlcpy_impl(char *, const char *, size_t) asm("_strlcpy");
78*699cd480SApple OSS Distributions 
79*699cd480SApple OSS Distributions /*
80*699cd480SApple OSS Distributions  * Deprecated functions
81*699cd480SApple OSS Distributions  */
82*699cd480SApple OSS Distributions extern char *strncpy_impl(char *, const char *, size_t) asm("_strncpy");
83*699cd480SApple OSS Distributions extern char *strncat_impl(char *, const char *, size_t) asm("_strncat");
84*699cd480SApple OSS Distributions 
85*699cd480SApple OSS Distributions #if CONFIG_VSPRINTF
86*699cd480SApple OSS Distributions extern char *strcpy_impl(char *, const char *) asm("_strcpy");
87*699cd480SApple OSS Distributions extern char *strcat_impl(char *, const char *) asm("_strcat");
88*699cd480SApple OSS Distributions #endif
89*699cd480SApple OSS Distributions 
90*699cd480SApple OSS Distributions #endif /* _MACHINE_STRING_H_ */
91