1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _SYS_LIBKERN_H_
33#define _SYS_LIBKERN_H_
34
35#include <sys/types.h>
36#ifdef _KERNEL
37#include <sys/systm.h>
38#endif
39#include <sys/kassert.h>
40
41#ifndef LIBKERN_INLINE
42#define LIBKERN_INLINE static __inline
43#define LIBKERN_BODY
44#endif
45
46/* BCD conversions. */
47extern u_char const bcd2bin_data[];
48extern u_char const bin2bcd_data[];
49extern char const hex2ascii_data[];
50
51#define LIBKERN_LEN_BCD2BIN 154
52#define LIBKERN_LEN_BIN2BCD 100
53#define LIBKERN_LEN_HEX2ASCII 36
54
55static inline u_char
56bcd2bin(int bcd)
57{
58
59 KASSERT(bcd >= 0 && bcd < LIBKERN_LEN_BCD2BIN,
60 ("invalid bcd %d", bcd));
61 return (bcd2bin_data[bcd]);
62}
63
64static inline u_char
65bin2bcd(int bin)
66{
67
68 KASSERT(bin >= 0 && bin < LIBKERN_LEN_BIN2BCD,
69 ("invalid bin %d", bin));
70 return (bin2bcd_data[bin]);
71}
72
73static inline char
74hex2ascii(int hex)
75{
76
77 KASSERT(hex >= 0 && hex < LIBKERN_LEN_HEX2ASCII,
78 ("invalid hex %d", hex));
79 return (hex2ascii_data[hex]);
80}
81
82static inline bool
83validbcd(int bcd)
84{
85
86 return (bcd == 0 || (bcd > 0 && bcd <= 0x99 && bcd2bin_data[bcd] != 0));
87}
88static __inline int imax(int a, int b) { return (a > b ? a : b); }
89static __inline int imin(int a, int b) { return (a < b ? a : b); }
90static __inline long lmax(long a, long b) { return (a > b ? a : b); }
91static __inline long lmin(long a, long b) { return (a < b ? a : b); }
92static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
93static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
94static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
95static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
96static __inline u_quad_t uqmax(u_quad_t a, u_quad_t b) { return (a > b ? a : b); }
97static __inline u_quad_t uqmin(u_quad_t a, u_quad_t b) { return (a < b ? a : b); }
98static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
99static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
100static __inline __uintmax_t ummax(__uintmax_t a, __uintmax_t b)
101{
102
103 return (a > b ? a : b);
104}
105static __inline __uintmax_t ummin(__uintmax_t a, __uintmax_t b)
106{
107
108 return (a < b ? a : b);
109}
110static __inline off_t omax(off_t a, off_t b) { return (a > b ? a : b); }
111static __inline off_t omin(off_t a, off_t b) { return (a < b ? a : b); }
112static __inline int abs(int a) { return (a < 0 ? -a : a); }
113static __inline long labs(long a) { return (a < 0 ? -a : a); }
114static __inline int64_t abs64(int64_t a) { return (a < 0 ? -a : a); }
115static __inline quad_t qabs(quad_t a) { return (a < 0 ? -a : a); }
116
117#ifndef RANDOM_FENESTRASX
118#define ARC4_ENTR_NONE 0 /* Don't have entropy yet. */
119#define ARC4_ENTR_HAVE 1 /* Have entropy. */
120#define ARC4_ENTR_SEED 2 /* Reseeding. */
121extern int arc4rand_iniseed_state;
122#endif
123
124/* Prototypes for non-quad routines. */
125struct malloc_type;
126uint32_t arc4random(void);
127void arc4random_buf(void *, size_t);
128uint32_t arc4random_uniform(uint32_t);
129void arc4rand(void *, u_int, int);
130int timingsafe_bcmp(const void *, const void *, size_t);
131void *bsearch(const void *, const void *, size_t,
132 size_t, int (*)(const void *, const void *));
133
134/*
135 * MHTODO: remove the 'HAVE_INLINE_FOO' defines once use of these flags has
136 * been purged everywhere. For now we provide them unconditionally.
137 */
138#define HAVE_INLINE_FFS
139#define HAVE_INLINE_FFSL
140#define HAVE_INLINE_FFSLL
141#define HAVE_INLINE_FLS
142#define HAVE_INLINE_FLSL
143#define HAVE_INLINE_FLSLL
144
145static __inline __pure2 int
146ffs(int mask)
147{
148
149 return (__builtin_ffs((u_int)mask));
150}
151
152static __inline __pure2 int
153ffsl(long mask)
154{
155
156 return (__builtin_ffsl((u_long)mask));
157}
158
159static __inline __pure2 int
160ffsll(long long mask)
161{
162
163 return (__builtin_ffsll((unsigned long long)mask));
164}
165
166static __inline __pure2 int
167fls(int mask)
168{
169
170 return (mask == 0 ? 0 :
171 8 * sizeof(mask) - __builtin_clz((u_int)mask));
172}
173
174static __inline __pure2 int
175flsl(long mask)
176{
177
178 return (mask == 0 ? 0 :
179 8 * sizeof(mask) - __builtin_clzl((u_long)mask));
180}
181
182static __inline __pure2 int
183flsll(long long mask)
184{
185
186 return (mask == 0 ? 0 :
187 8 * sizeof(mask) - __builtin_clzll((unsigned long long)mask));
188}
189
190static __inline __pure2 int
191ilog2_int(int n)
192{
193
194 KASSERT(n != 0, ("ilog argument must be nonzero"));
195 return (8 * sizeof(n) - 1 - __builtin_clz((u_int)n));
196}
197
198static __inline __pure2 int
199ilog2_long(long n)
200{
201
202 KASSERT(n != 0, ("ilog argument must be nonzero"));
203 return (8 * sizeof(n) - 1 - __builtin_clzl((u_long)n));
204}
205
206static __inline __pure2 int
207ilog2_long_long(long long n)
208{
209
210 KASSERT(n != 0, ("ilog argument must be nonzero"));
211 return (8 * sizeof(n) - 1 -
212 __builtin_clzll((unsigned long long)n));
213}
214
215#define ilog2_var(n) \
216 _Generic((n), \
217 default: ilog2_int, \
218 long: ilog2_long, \
219 unsigned long: ilog2_long, \
220 long long: ilog2_long_long, \
221 unsigned long long: ilog2_long_long \
222 )(n)
223
224#define ilog2_const(n) \
225 (8 * (int)sizeof(unsigned long long) - 1 - \
226 __builtin_clzll(n))
227
228#define ilog2(n) (__builtin_constant_p(n) ? ilog2_const(n) : ilog2_var(n))
229#define rounddown_pow_of_two(n) ((__typeof(n))1 << ilog2(n))
230#define order_base_2(n) ilog2(2*(n)-1)
231#define roundup_pow_of_two(n) ((__typeof(n))1 << order_base_2(n))
232
233#define bitcount64(x) __bitcount64((uint64_t)(x))
234#define bitcount32(x) __bitcount32((uint32_t)(x))
235#define bitcount16(x) __bitcount16((uint16_t)(x))
236#define bitcountl(x) __bitcountl((u_long)(x))
237#define bitcount(x) __bitcount((u_int)(x))
238
239int fnmatch(const char *, const char *, int);
240int locc(int, char *, u_int);
241void *memchr(const void *s, int c, size_t n);
242void *memcchr(const void *s, int c, size_t n);
243void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
244void qsort(void *base, size_t nmemb, size_t size,
245 int (*compar)(const void *, const void *));
246void qsort_r(void *base, size_t nmemb, size_t size,
247 int (*compar)(const void *, const void *, void *), void *thunk);
248u_long random(void);
249int scanc(u_int, const u_char *, const u_char *, int);
250int strcasecmp(const char *, const char *);
251char *strcasestr(const char *, const char *);
252char *strcat(char * __restrict, const char * __restrict);
253char *strchr(const char *, int);
254char *strchrnul(const char *, int);
255int strcmp(const char *, const char *);
256char *strcpy(char * __restrict, const char * __restrict);
257char *strdup_flags(const char *__restrict, struct malloc_type *, int);
258size_t strcspn(const char *, const char *) __pure;
259char *strdup(const char *__restrict, struct malloc_type *);
260char *strncat(char *, const char *, size_t);
261char *strndup(const char *__restrict, size_t, struct malloc_type *);
262size_t strlcat(char *, const char *, size_t);
263size_t strlcpy(char *, const char *, size_t);
264size_t strlen(const char *);
265int strncasecmp(const char *, const char *, size_t);
266int strncmp(const char *, const char *, size_t);
267char *strncpy(char * __restrict, const char * __restrict, size_t);
268size_t strnlen(const char *, size_t);
269char *strnstr(const char *, const char *, size_t);
270char *strrchr(const char *, int);
271char *strsep(char **, const char *delim);
272size_t strspn(const char *, const char *);
273char *strstr(const char *, const char *);
274int strvalid(const char *, size_t);
275
276#ifdef SAN_NEEDS_INTERCEPTORS
277#ifndef SAN_INTERCEPTOR
278#define SAN_INTERCEPTOR(func) \
279 __CONCAT(SAN_INTERCEPTOR_PREFIX, __CONCAT(_, func))
280#endif
281char *SAN_INTERCEPTOR(strcpy)(char *, const char *);
282int SAN_INTERCEPTOR(strcmp)(const char *, const char *);
283size_t SAN_INTERCEPTOR(strlen)(const char *);
284#ifndef SAN_RUNTIME
285#define strcpy(d, s) SAN_INTERCEPTOR(strcpy)((d), (s))
286#define strcmp(s1, s2) SAN_INTERCEPTOR(strcmp)((s1), (s2))
287#define strlen(s) SAN_INTERCEPTOR(strlen)(s)
288#endif /* !SAN_RUNTIME */
289#else /* !SAN_NEEDS_INTERCEPTORS */
290#define strcpy(d, s) __builtin_strcpy((d), (s))
291#define strcmp(s1, s2) __builtin_strcmp((s1), (s2))
292#define strlen(s) __builtin_strlen((s))
293#endif /* SAN_NEEDS_INTERCEPTORS */
294
295static __inline char *
296index(const char *p, int ch)
297{
298
299 return (strchr(p, ch));
300}
301
302static __inline char *
303rindex(const char *p, int ch)
304{
305
306 return (strrchr(p, ch));
307}
308
309static __inline int64_t
310signed_extend64(uint64_t bitmap, int lsb, int width)
311{
312
313 return ((int64_t)(bitmap << (63 - lsb - (width - 1)))) >>
314 (63 - (width - 1));
315}
316
317static __inline int32_t
318signed_extend32(uint32_t bitmap, int lsb, int width)
319{
320
321 return ((int32_t)(bitmap << (31 - lsb - (width - 1)))) >>
322 (31 - (width - 1));
323}
324
325/* fnmatch() return values. */
326#define FNM_NOMATCH 1 /* Match failed. */
327
328/* fnmatch() flags. */
329#define FNM_NOESCAPE 0x01 /* Disable backslash escaping. */
330#define FNM_PATHNAME 0x02 /* Slash must be matched by slash. */
331#define FNM_PERIOD 0x04 /* Period must be matched by period. */
332#define FNM_LEADING_DIR 0x08 /* Ignore /<tail> after Imatch. */
333#define FNM_CASEFOLD 0x10 /* Case insensitive search. */
334#define FNM_IGNORECASE FNM_CASEFOLD
335#define FNM_FILE_NAME FNM_PATHNAME
336
337// zig patch: ssp/ssp.h header and __ssp_real were added in FreeBSD 15
338#if __FreeBSD_version >= 1500500
339#if !defined(_KERNEL) && __has_include(<ssp/ssp.h>)
340#include <ssp/ssp.h> /* __ssp_real */
341#else
342#define __ssp_real(fun) fun
343#endif
344#endif
345
346#endif /* !_SYS_LIBKERN_H_ */