1 /*-
2 * Copyright (c) 1992, 1993
3 * The Regents of the University of California. 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 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * @(#)libkern.h 8.1 (Berkeley) 6/10/93
30 * $FreeBSD$
31 */
32
33 #ifndef _SYS_LIBKERN_H_
34 #define _SYS_LIBKERN_H_
35
36 #include <sys/cdefs.h>
37 #include <sys/types.h>
38 #ifdef _KERNEL
39 #include <sys/systm.h>
40 #endif
41
42 #ifndef LIBKERN_INLINE
43 #define LIBKERN_INLINE static __inline
44 #define LIBKERN_BODY
45 #endif
46
47 /* BCD conversions. */
48 extern u_char const bcd2bin_data[];
49 extern u_char const bin2bcd_data[];
50 extern char const hex2ascii_data[];
51
52 #define bcd2bin(bcd) (bcd2bin_data[bcd])
53 #define bin2bcd(bin) (bin2bcd_data[bin])
54 #define hex2ascii(hex) (hex2ascii_data[hex])
55
56 static inline bool
validbcd(int bcd)57 validbcd(int bcd)
58 {
59
60 return (bcd == 0 || (bcd > 0 && bcd <= 0x99 && bcd2bin_data[bcd] != 0));
61 }
62
imax(int a,int b)63 static __inline int imax(int a, int b) { return (a > b ? a : b); }
imin(int a,int b)64 static __inline int imin(int a, int b) { return (a < b ? a : b); }
lmax(long a,long b)65 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
lmin(long a,long b)66 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
max(u_int a,u_int b)67 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
min(u_int a,u_int b)68 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
qmax(quad_t a,quad_t b)69 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
qmin(quad_t a,quad_t b)70 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
uqmax(u_quad_t a,u_quad_t b)71 static __inline u_quad_t uqmax(u_quad_t a, u_quad_t b) { return (a > b ? a : b); }
uqmin(u_quad_t a,u_quad_t b)72 static __inline u_quad_t uqmin(u_quad_t a, u_quad_t b) { return (a < b ? a : b); }
ulmax(u_long a,u_long b)73 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
ulmin(u_long a,u_long b)74 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
ummax(__uintmax_t a,__uintmax_t b)75 static __inline __uintmax_t ummax(__uintmax_t a, __uintmax_t b)
76 {
77
78 return (a > b ? a : b);
79 }
ummin(__uintmax_t a,__uintmax_t b)80 static __inline __uintmax_t ummin(__uintmax_t a, __uintmax_t b)
81 {
82
83 return (a < b ? a : b);
84 }
omax(off_t a,off_t b)85 static __inline off_t omax(off_t a, off_t b) { return (a > b ? a : b); }
omin(off_t a,off_t b)86 static __inline off_t omin(off_t a, off_t b) { return (a < b ? a : b); }
87
abs(int a)88 static __inline int abs(int a) { return (a < 0 ? -a : a); }
labs(long a)89 static __inline long labs(long a) { return (a < 0 ? -a : a); }
qabs(quad_t a)90 static __inline quad_t qabs(quad_t a) { return (a < 0 ? -a : a); }
91
92 #define ARC4_ENTR_NONE 0 /* Don't have entropy yet. */
93 #define ARC4_ENTR_HAVE 1 /* Have entropy. */
94 #define ARC4_ENTR_SEED 2 /* Reseeding. */
95 extern int arc4rand_iniseed_state;
96
97 /* Prototypes for non-quad routines. */
98 struct malloc_type;
99 uint32_t arc4random(void);
100 void arc4rand(void *ptr, u_int len, int reseed);
101 int bcmp(const void *, const void *, size_t);
102 int timingsafe_bcmp(const void *, const void *, size_t);
103 void *bsearch(const void *, const void *, size_t,
104 size_t, int (*)(const void *, const void *));
105 #ifndef HAVE_INLINE_FFS
106 int ffs(int);
107 #endif
108 #ifndef HAVE_INLINE_FFSL
109 int ffsl(long);
110 #endif
111 #ifndef HAVE_INLINE_FFSLL
112 int ffsll(long long);
113 #endif
114 #ifndef HAVE_INLINE_FLS
115 int fls(int);
116 #endif
117 #ifndef HAVE_INLINE_FLSL
118 int flsl(long);
119 #endif
120 #ifndef HAVE_INLINE_FLSLL
121 int flsll(long long);
122 #endif
123 #define bitcount64(x) __bitcount64((uint64_t)(x))
124 #define bitcount32(x) __bitcount32((uint32_t)(x))
125 #define bitcount16(x) __bitcount16((uint16_t)(x))
126 #define bitcountl(x) __bitcountl((u_long)(x))
127 #define bitcount(x) __bitcount((u_int)(x))
128
129 int fnmatch(const char *, const char *, int);
130 int locc(int, char *, u_int);
131 void *memchr(const void *s, int c, size_t n);
132 void *memcchr(const void *s, int c, size_t n);
133 int memcmp(const void *b1, const void *b2, size_t len);
134 void *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
135 void qsort(void *base, size_t nmemb, size_t size,
136 int (*compar)(const void *, const void *));
137 void qsort_r(void *base, size_t nmemb, size_t size, void *thunk,
138 int (*compar)(void *, const void *, const void *));
139 u_long random(void);
140 int scanc(u_int, const u_char *, const u_char *, int);
141 void srandom(u_long);
142 int strcasecmp(const char *, const char *);
143 char *strcat(char * __restrict, const char * __restrict);
144 char *strchr(const char *, int);
145 int strcmp(const char *, const char *);
146 char *strcpy(char * __restrict, const char * __restrict);
147 size_t strcspn(const char * __restrict, const char * __restrict) __pure;
148 char *strdup(const char *__restrict, struct malloc_type *);
149 char *strncat(char *, const char *, size_t);
150 char *strndup(const char *__restrict, size_t, struct malloc_type *);
151 size_t strlcat(char *, const char *, size_t);
152 size_t strlcpy(char *, const char *, size_t);
153 size_t strlen(const char *);
154 int strncasecmp(const char *, const char *, size_t);
155 int strncmp(const char *, const char *, size_t);
156 char *strncpy(char * __restrict, const char * __restrict, size_t);
157 size_t strnlen(const char *, size_t);
158 char *strrchr(const char *, int);
159 char *strsep(char **, const char *delim);
160 size_t strspn(const char *, const char *);
161 char *strstr(const char *, const char *);
162 int strvalid(const char *, size_t);
163
164 extern const uint32_t crc32_tab[];
165
166 static __inline uint32_t
crc32_raw(const void * buf,size_t size,uint32_t crc)167 crc32_raw(const void *buf, size_t size, uint32_t crc)
168 {
169 const uint8_t *p = (const uint8_t *)buf;
170
171 while (size--)
172 crc = crc32_tab[(crc ^ *p++) & 0xFF] ^ (crc >> 8);
173 return (crc);
174 }
175
176 static __inline uint32_t
crc32(const void * buf,size_t size)177 crc32(const void *buf, size_t size)
178 {
179 uint32_t crc;
180
181 crc = crc32_raw(buf, size, ~0U);
182 return (crc ^ ~0U);
183 }
184
185 uint32_t
186 calculate_crc32c(uint32_t crc32c, const unsigned char *buffer,
187 unsigned int length);
188 #ifdef _KERNEL
189 #if defined(__amd64__) || defined(__i386__)
190 uint32_t sse42_crc32c(uint32_t, const unsigned char *, unsigned);
191 #endif
192 #if defined(__aarch64__)
193 uint32_t armv8_crc32c(uint32_t, const unsigned char *, unsigned int);
194 #endif
195 #endif
196
197
198 LIBKERN_INLINE void *memset(void *, int, size_t);
199 #ifdef LIBKERN_BODY
200 LIBKERN_INLINE void *
memset(void * b,int c,size_t len)201 memset(void *b, int c, size_t len)
202 {
203 char *bb;
204
205 if (c == 0)
206 bzero(b, len);
207 else
208 for (bb = (char *)b; len--; )
209 *bb++ = c;
210 return (b);
211 }
212 #endif
213
214 static __inline char *
index(const char * p,int ch)215 index(const char *p, int ch)
216 {
217
218 return (strchr(p, ch));
219 }
220
221 static __inline char *
rindex(const char * p,int ch)222 rindex(const char *p, int ch)
223 {
224
225 return (strrchr(p, ch));
226 }
227
228 /* fnmatch() return values. */
229 #define FNM_NOMATCH 1 /* Match failed. */
230
231 /* fnmatch() flags. */
232 #define FNM_NOESCAPE 0x01 /* Disable backslash escaping. */
233 #define FNM_PATHNAME 0x02 /* Slash must be matched by slash. */
234 #define FNM_PERIOD 0x04 /* Period must be matched by period. */
235 #define FNM_LEADING_DIR 0x08 /* Ignore /<tail> after Imatch. */
236 #define FNM_CASEFOLD 0x10 /* Case insensitive search. */
237 #define FNM_IGNORECASE FNM_CASEFOLD
238 #define FNM_FILE_NAME FNM_PATHNAME
239
240 #endif /* !_SYS_LIBKERN_H_ */
241