mirror of
https://github.com/freebsd/freebsd-src.git
synced 2026-10-28 11:25:21 +01:00
Faraz Vahedi
d08296c7ab
Several standard library functions are specified to return an unqualified pointer while accepting a pointer to a potentially const-qualified object. N3020 addresses this behaviour, discarding qualifiers due to incompatible pointer types, by introducing qualifier-preserving macros for the affected set of standard library functions. Add `__qualsel()` helper to `<sys/cdefs.h>`, implemented using the generic selection, and define qualifier-preserving macros for that set of functions in `<string.h>`, `<wchar.h>`, and `<stdlib.h>`. Macros are gated on `_STDC_VERSION__ >= 202311L && !__cplusplus`, therefore there is no behavioural change for earlier C modes or C++ translation units. The kernel is likewise unaffected, as it does not include userland headers. As function-like macros, they are transparent except at a call site where the address-of operator is applied, the macro is suppressed via `#undef`, or the identifier appears in parenthesised form; all of which cause the underlying function designator to be used instead. Reviewed by: fuz Approved by: fuz (mentor) MFC after: 1 month Pull Request: https://github.com/freebsd/freebsd-src/pull/2288
237 lines
7.7 KiB
C
237 lines
7.7 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*
|
|
* Copyright (c) 1990, 1993
|
|
* The Regents of the University of California. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the University nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef _STRING_H_
|
|
#define _STRING_H_
|
|
|
|
#include <sys/cdefs.h>
|
|
#include <sys/_null.h>
|
|
#include <sys/_types.h>
|
|
|
|
/*
|
|
* Prototype functions which were historically defined in <string.h>, but
|
|
* are required by POSIX to be prototyped in <strings.h>.
|
|
*/
|
|
#if __BSD_VISIBLE
|
|
#include <strings.h>
|
|
#endif
|
|
|
|
#ifndef _SIZE_T_DECLARED
|
|
typedef __size_t size_t;
|
|
#define _SIZE_T_DECLARED
|
|
#endif
|
|
|
|
#if !defined(_STANDALONE) && defined(_FORTIFY_SOURCE) && _FORTIFY_SOURCE > 0
|
|
#include <ssp/string.h>
|
|
#endif
|
|
|
|
__BEGIN_DECLS
|
|
#if __XSI_VISIBLE >= 600 || __ISO_C_VISIBLE >= 2023
|
|
void *memccpy(void * __restrict, const void * __restrict, int, size_t);
|
|
#endif
|
|
void *memchr(const void *, int, size_t) __pure;
|
|
#if __BSD_VISIBLE
|
|
void *memrchr(const void *, int, size_t) __pure;
|
|
#endif
|
|
int memcmp(const void *, const void *, size_t) __pure;
|
|
void *(memcpy)(void * __restrict, const void * __restrict, size_t);
|
|
#if __BSD_VISIBLE
|
|
void *memmem(const void *, size_t, const void *, size_t) __pure;
|
|
#endif
|
|
void *(memmove)(void *, const void *, size_t);
|
|
#if __BSD_VISIBLE
|
|
void *(mempcpy)(void * __restrict, const void * __restrict, size_t);
|
|
#endif
|
|
void *(memset)(void *, int, size_t);
|
|
#if __BSD_VISIBLE || __ISO_C_VISIBLE >= 2023
|
|
void *memset_explicit(void *, int, size_t);
|
|
#endif
|
|
#if __POSIX_VISIBLE >= 200809
|
|
char *(stpcpy)(char * __restrict, const char * __restrict);
|
|
char *(stpncpy)(char * __restrict, const char * __restrict, size_t);
|
|
#endif
|
|
#if __BSD_VISIBLE
|
|
char *strcasestr(const char *, const char *) __pure;
|
|
#endif
|
|
char *(strcat)(char * __restrict, const char * __restrict);
|
|
char *strchr(const char *, int) __pure;
|
|
#if __BSD_VISIBLE
|
|
char *strchrnul(const char*, int) __pure;
|
|
int strverscmp(const char *, const char *) __pure;
|
|
#endif
|
|
int strcmp(const char *, const char *) __pure;
|
|
int strcoll(const char *, const char *);
|
|
char *(strcpy)(char * __restrict, const char * __restrict);
|
|
size_t strcspn(const char *, const char *) __pure;
|
|
#if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE || __ISO_C_VISIBLE >= 2023
|
|
char *strdup(const char *) __malloc_like;
|
|
#endif
|
|
char *strerror(int);
|
|
#if __POSIX_VISIBLE >= 200112
|
|
int strerror_r(int, char *, size_t);
|
|
#endif
|
|
#if __BSD_VISIBLE
|
|
size_t (strlcat)(char * __restrict, const char * __restrict, size_t);
|
|
size_t (strlcpy)(char * __restrict, const char * __restrict, size_t);
|
|
#endif
|
|
size_t strlen(const char *) __pure;
|
|
#if __BSD_VISIBLE
|
|
|
|
#ifndef _MODE_T_DECLARED
|
|
typedef __mode_t mode_t;
|
|
#define _MODE_T_DECLARED
|
|
#endif
|
|
|
|
void strmode(mode_t, char *);
|
|
#endif
|
|
char *(strncat)(char * __restrict, const char * __restrict, size_t);
|
|
int strncmp(const char *, const char *, size_t) __pure;
|
|
char *(strncpy)(char * __restrict, const char * __restrict, size_t);
|
|
#if __POSIX_VISIBLE >= 200809 || __ISO_C_VISIBLE >= 2023
|
|
char *strndup(const char *, size_t) __malloc_like;
|
|
#endif
|
|
#if __POSIX_VISIBLE >= 200809
|
|
size_t strnlen(const char *, size_t) __pure;
|
|
#endif
|
|
#if __BSD_VISIBLE
|
|
char *strnstr(const char *, const char *, size_t) __pure;
|
|
#endif
|
|
char *strpbrk(const char *, const char *) __pure;
|
|
char *strrchr(const char *, int) __pure;
|
|
#if __BSD_VISIBLE
|
|
char *strsep(char **, const char *);
|
|
#endif
|
|
#if __POSIX_VISIBLE >= 200809
|
|
char *strsignal(int);
|
|
#endif
|
|
size_t strspn(const char *, const char *) __pure;
|
|
char *strstr(const char *, const char *) __pure;
|
|
char *strtok(char * __restrict, const char * __restrict);
|
|
#if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE >= 500
|
|
char *strtok_r(char *, const char *, char **);
|
|
#endif
|
|
size_t strxfrm(char * __restrict, const char * __restrict, size_t);
|
|
#if __BSD_VISIBLE
|
|
|
|
#ifndef _SWAB_DECLARED
|
|
#define _SWAB_DECLARED
|
|
|
|
#ifndef _SSIZE_T_DECLARED
|
|
typedef __ssize_t ssize_t;
|
|
#define _SSIZE_T_DECLARED
|
|
#endif /* _SIZE_T_DECLARED */
|
|
|
|
void swab(const void * __restrict, void * __restrict, ssize_t);
|
|
#endif /* _SWAB_DECLARED */
|
|
|
|
int timingsafe_bcmp(const void *, const void *, size_t);
|
|
int timingsafe_memcmp(const void *, const void *, size_t);
|
|
|
|
#if __has_builtin(__builtin_alloca)
|
|
#define strdupa(_Str) (__extension__({ \
|
|
const char *_Str1; \
|
|
size_t _Len; \
|
|
char *_Copy; \
|
|
\
|
|
_Str1 = (_Str); \
|
|
_Len = strlen(_Str1) + 1; \
|
|
_Copy = (char *)__builtin_alloca(_Len); \
|
|
memcpy(_Copy, _Str1, _Len); \
|
|
_Copy; \
|
|
}))
|
|
|
|
#define strndupa(_Str, _Maxlen) (__extension__({ \
|
|
const char *_Str1; \
|
|
char *_Copy; \
|
|
size_t _Len; \
|
|
\
|
|
_Str1 = (_Str); \
|
|
_Len = strnlen((_Str1), (_Maxlen)); \
|
|
_Copy = __builtin_alloca(_Len + 1); \
|
|
(void)memcpy(_Copy, _Str1, _Len); \
|
|
_Copy[_Len] = '\0'; \
|
|
_Copy; \
|
|
}))
|
|
#endif
|
|
|
|
#endif /* __BSD_VISIBLE */
|
|
|
|
#if __POSIX_VISIBLE >= 200112 || defined(_XLOCALE_H_)
|
|
#include <xlocale/_string.h>
|
|
#endif
|
|
|
|
#if __EXT1_VISIBLE
|
|
|
|
#ifndef _RSIZE_T_DEFINED
|
|
#define _RSIZE_T_DEFINED
|
|
typedef size_t rsize_t;
|
|
#endif
|
|
|
|
#ifndef _ERRNO_T_DEFINED
|
|
#define _ERRNO_T_DEFINED
|
|
typedef int errno_t;
|
|
#endif
|
|
|
|
/* ISO/IEC 9899:2011 K.3.7.4.1.1 */
|
|
errno_t memset_s(void *, rsize_t, int, rsize_t);
|
|
#endif /* __EXT1_VISIBLE */
|
|
__END_DECLS
|
|
|
|
#if defined(__qualsel) && !defined(__cplusplus) && \
|
|
defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L
|
|
#define memchr(b, c, n) __qualsel((b), \
|
|
(const void *)(memchr)((b), (c), (n)), (memchr)((b), (c), (n)))
|
|
#define strchr(s, c) __qualsel((s), \
|
|
(const char *)(strchr)((s), (c)), (strchr)((s), (c)))
|
|
#define strpbrk(s, charset) __qualsel((s), \
|
|
(const char *)(strpbrk)((s), (charset)), (strpbrk)((s), (charset)))
|
|
#define strrchr(s, c) __qualsel((s), \
|
|
(const char *)(strrchr)((s), (c)), (strrchr)((s), (c)))
|
|
#define strstr(s, find) __qualsel((s), \
|
|
(const char *)(strstr)((s), (find)), (strstr)((s), (find)))
|
|
#if __BSD_VISIBLE
|
|
#define memmem(b, blen, pat, plen) __qualsel((b), \
|
|
(const void *)(memmem)((b), (blen), (pat), (plen)), \
|
|
(memmem)((b), (blen), (pat), (plen)))
|
|
#define memrchr(b, c, n) __qualsel((b), \
|
|
(const void *)(memrchr)((b), (c), (n)), (memrchr)((b), (c), (n)))
|
|
#define strcasestr(s, find) __qualsel((s), \
|
|
(const char *)(strcasestr)((s), (find)), (strcasestr)((s), (find)))
|
|
#define strchrnul(s, c) __qualsel((s), \
|
|
(const char *)(strchrnul)((s), (c)), (strchrnul)((s), (c)))
|
|
#define strnstr(s, find, slen) __qualsel((s), \
|
|
(const char *)(strnstr)((s), (find), (slen)), \
|
|
(strnstr)((s), (find), (slen)))
|
|
#endif /* __BSD_VISIBLE */
|
|
#endif
|
|
|
|
#endif /* _STRING_H_ */
|