libkern.h revision 1.64 1 /* $NetBSD: libkern.h,v 1.64 2006/08/25 19:07:44 matt Exp $ */
2
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 * @(#)libkern.h 8.2 (Berkeley) 8/5/94
32 */
33
34 #ifndef _LIB_LIBKERN_LIBKERN_H_
35 #define _LIB_LIBKERN_LIBKERN_H_
36
37 #include <sys/types.h>
38 #include <sys/inttypes.h>
39 #include <sys/null.h>
40
41 #ifndef LIBKERN_INLINE
42 #define LIBKERN_INLINE static __inline
43 #define LIBKERN_BODY
44 #endif
45
46 LIBKERN_INLINE int imax __P((int, int)) __attribute__ ((unused));
47 LIBKERN_INLINE int imin __P((int, int)) __attribute__ ((unused));
48 LIBKERN_INLINE u_int max __P((u_int, u_int)) __attribute__ ((unused));
49 LIBKERN_INLINE u_int min __P((u_int, u_int)) __attribute__ ((unused));
50 LIBKERN_INLINE long lmax __P((long, long)) __attribute__ ((unused));
51 LIBKERN_INLINE long lmin __P((long, long)) __attribute__ ((unused));
52 LIBKERN_INLINE u_long ulmax __P((u_long, u_long)) __attribute__ ((unused));
53 LIBKERN_INLINE u_long ulmin __P((u_long, u_long)) __attribute__ ((unused));
54 LIBKERN_INLINE int abs __P((int)) __attribute__ ((unused));
55
56 LIBKERN_INLINE int isspace __P((int)) __attribute__((__unused__));
57 LIBKERN_INLINE int isascii __P((int)) __attribute__((__unused__));
58 LIBKERN_INLINE int isupper __P((int)) __attribute__((__unused__));
59 LIBKERN_INLINE int islower __P((int)) __attribute__((__unused__));
60 LIBKERN_INLINE int isalpha __P((int)) __attribute__((__unused__));
61 LIBKERN_INLINE int isdigit __P((int)) __attribute__((__unused__));
62 LIBKERN_INLINE int isxdigit __P((int)) __attribute__((__unused__));
63 LIBKERN_INLINE int toupper __P((int)) __attribute__((__unused__));
64 LIBKERN_INLINE int tolower __P((int)) __attribute__((__unused__));
65
66 #ifdef LIBKERN_BODY
67 LIBKERN_INLINE int
68 imax(int a, int b)
69 {
70 return (a > b ? a : b);
71 }
72 LIBKERN_INLINE int
73 imin(int a, int b)
74 {
75 return (a < b ? a : b);
76 }
77 LIBKERN_INLINE long
78 lmax(long a, long b)
79 {
80 return (a > b ? a : b);
81 }
82 LIBKERN_INLINE long
83 lmin(long a, long b)
84 {
85 return (a < b ? a : b);
86 }
87 LIBKERN_INLINE u_int
88 max(u_int a, u_int b)
89 {
90 return (a > b ? a : b);
91 }
92 LIBKERN_INLINE u_int
93 min(u_int a, u_int b)
94 {
95 return (a < b ? a : b);
96 }
97 LIBKERN_INLINE u_long
98 ulmax(u_long a, u_long b)
99 {
100 return (a > b ? a : b);
101 }
102 LIBKERN_INLINE u_long
103 ulmin(u_long a, u_long b)
104 {
105 return (a < b ? a : b);
106 }
107
108 LIBKERN_INLINE int
109 abs(int j)
110 {
111 return(j < 0 ? -j : j);
112 }
113
114 LIBKERN_INLINE int
115 isspace(int ch)
116 {
117 return (ch == ' ' || (ch >= '\t' && ch <= '\r'));
118 }
119
120 LIBKERN_INLINE int
121 isascii(int ch)
122 {
123 return ((ch & ~0x7f) == 0);
124 }
125
126 LIBKERN_INLINE int
127 isupper(int ch)
128 {
129 return (ch >= 'A' && ch <= 'Z');
130 }
131
132 LIBKERN_INLINE int
133 islower(int ch)
134 {
135 return (ch >= 'a' && ch <= 'z');
136 }
137
138 LIBKERN_INLINE int
139 isalpha(int ch)
140 {
141 return (isupper(ch) || islower(ch));
142 }
143
144 LIBKERN_INLINE int
145 isdigit(int ch)
146 {
147 return (ch >= '0' && ch <= '9');
148 }
149
150 LIBKERN_INLINE int
151 isxdigit(int ch)
152 {
153 return (isdigit(ch) ||
154 (ch >= 'A' && ch <= 'F') ||
155 (ch >= 'a' && ch <= 'f'));
156 }
157
158 LIBKERN_INLINE int
159 toupper(int ch)
160 {
161 if (islower(ch))
162 return (ch - 0x20);
163 return (ch);
164 }
165
166 LIBKERN_INLINE int
167 tolower(int ch)
168 {
169 if (isupper(ch))
170 return (ch + 0x20);
171 return (ch);
172 }
173 #endif
174
175 /*
176 * Return the number of elements in a statically-allocated array,
177 * __x.
178 */
179 #define __arraycount(__x) (sizeof(__x) / sizeof(__x[0]))
180 #define __NULL_STMT do { } while (/* CONSTCOND */ 0)
181
182 /* __BIT(n): nth bit, where __BIT(0) == 0x1. */
183 #define __BIT(__n) (((__n) == 32) ? 0 : ((uint32_t)1 << (__n)))
184
185 /* __BITS(m, n): bits m through n, m < n. */
186 #define __BITS(__m, __n) \
187 ((__BIT(MAX((__m), (__n)) + 1) - 1) ^ (__BIT(MIN((__m), (__n))) - 1))
188
189 /* find least significant bit that is set */
190 #define __LOWEST_SET_BIT(__mask) ((((__mask) - 1) & (__mask)) ^ (__mask))
191
192 #define SHIFTOUT(__x, __mask) (((__x) & (__mask)) / __LOWEST_SET_BIT(__mask))
193 #define SHIFTIN(__x, __mask) ((__x) * __LOWEST_SET_BIT(__mask))
194 #define SHIFTOUT_MASK(__mask) SHIFTOUT((__mask), (__mask))
195
196 #ifdef NDEBUG /* tradition! */
197 #define assert(e) ((void)0)
198 #else
199 #ifdef __STDC__
200 #define assert(e) (__predict_true((e)) ? (void)0 : \
201 __assert("", __FILE__, __LINE__, #e))
202 #else
203 #define assert(e) (__predict_true((e)) ? (void)0 : \
204 __assert("", __FILE__, __LINE__, "e"))
205 #endif
206 #endif
207
208 #ifdef __COVERITY__
209 #ifndef DIAGNOSTIC
210 #define DIAGNOSTIC
211 #endif
212 #endif
213
214 #ifndef DIAGNOSTIC
215 #define _DIAGASSERT(a) (void)0
216 #ifdef lint
217 #define KASSERT(e) /* NOTHING */
218 #else /* !lint */
219 #define KASSERT(e) ((void)0)
220 #endif /* !lint */
221 #else /* DIAGNOSTIC */
222 #define _DIAGASSERT(a) assert(a)
223 #ifdef __STDC__
224 #define KASSERT(e) (__predict_true((e)) ? (void)0 : \
225 __assert("diagnostic ", __FILE__, __LINE__, #e))
226 #else
227 #define KASSERT(e) (__predict_true((e)) ? (void)0 : \
228 __assert("diagnostic ", __FILE__, __LINE__, "e"))
229 #endif
230 #endif
231
232 #ifndef DEBUG
233 #ifdef lint
234 #define KDASSERT(e) /* NOTHING */
235 #else /* lint */
236 #define KDASSERT(e) ((void)0)
237 #endif /* lint */
238 #else
239 #ifdef __STDC__
240 #define KDASSERT(e) (__predict_true((e)) ? (void)0 : \
241 __assert("debugging ", __FILE__, __LINE__, #e))
242 #else
243 #define KDASSERT(e) (__predict_true((e)) ? (void)0 : \
244 __assert("debugging ", __FILE__, __LINE__, "e"))
245 #endif
246 #endif
247 /*
248 * XXX: For compatibility we use SMALL_RANDOM by default.
249 */
250 #define SMALL_RANDOM
251
252 #ifndef offsetof
253 #define offsetof(type, member) \
254 ((size_t)(unsigned long)(&(((type *)0)->member)))
255 #endif
256
257 /* Prototypes for non-quad routines. */
258 /* XXX notyet #ifdef _STANDALONE */
259 int bcmp __P((const void *, const void *, size_t));
260 void bzero __P((void *, size_t));
261 /* #endif */
262
263 /* Prototypes for which GCC built-ins exist. */
264 void *memcpy __P((void *, const void *, size_t));
265 int memcmp __P((const void *, const void *, size_t));
266 void *memset __P((void *, int, size_t));
267 #if __GNUC_PREREQ__(2, 95) && (__GNUC_PREREQ__(4, 0) || !defined(__vax__))
268 #define memcpy(d, s, l) __builtin_memcpy(d, s, l)
269 #define memcmp(a, b, l) __builtin_memcmp(a, b, l)
270 #endif
271 #if __GNUC_PREREQ__(2, 95) && !defined(__vax__)
272 #define memset(d, v, l) __builtin_memset(d, v, l)
273 #endif
274
275 char *strcpy __P((char *, const char *));
276 int strcmp __P((const char *, const char *));
277 size_t strlen __P((const char *));
278 char *strsep(char **, const char *);
279 #if __GNUC_PREREQ__(2, 95)
280 #define strcpy(d, s) __builtin_strcpy(d, s)
281 #define strcmp(a, b) __builtin_strcmp(a, b)
282 #define strlen(a) __builtin_strlen(a)
283 #endif
284
285 /* Functions for which we always use built-ins. */
286 #ifdef __GNUC__
287 #define alloca(s) __builtin_alloca(s)
288 #endif
289
290 /* These exist in GCC 3.x, but we don't bother. */
291 char *strcat __P((char *, const char *));
292 char *strncpy __P((char *, const char *, size_t));
293 int strncmp __P((const char *, const char *, size_t));
294 char *strchr __P((const char *, int));
295 char *strrchr __P((const char *, int));
296
297 char *strstr __P((const char *, const char *));
298
299 /*
300 * ffs is an instruction on vax.
301 */
302 int ffs __P((int));
303 #if __GNUC_PREREQ__(2, 95) && !defined(__vax__)
304 #define ffs(x) __builtin_ffs(x)
305 #endif
306
307 void __assert __P((const char *, const char *, int, const char *))
308 __attribute__((__noreturn__));
309 unsigned int
310 bcdtobin __P((unsigned int));
311 unsigned int
312 bintobcd __P((unsigned int));
313 u_int32_t
314 inet_addr __P((const char *));
315 struct in_addr;
316 int inet_aton __P((const char *, struct in_addr *));
317 char *intoa __P((u_int32_t));
318 #define inet_ntoa(a) intoa((a).s_addr)
319 void *memchr __P((const void *, int, size_t));
320 void *memmove __P((void *, const void *, size_t));
321 int pmatch __P((const char *, const char *, const char **));
322 u_int32_t arc4random __P((void));
323 void arc4randbytes __P((void *, size_t));
324 #ifndef SMALL_RANDOM
325 void srandom __P((unsigned long));
326 char *initstate __P((unsigned long, char *, size_t));
327 char *setstate __P((char *));
328 #endif /* SMALL_RANDOM */
329 long random __P((void));
330 int scanc __P((u_int, const u_char *, const u_char *, int));
331 int skpc __P((int, size_t, u_char *));
332 int strcasecmp __P((const char *, const char *));
333 size_t strlcpy __P((char *, const char *, size_t));
334 size_t strlcat __P((char *, const char *, size_t));
335 int strncasecmp __P((const char *, const char *, size_t));
336 u_long strtoul __P((const char *, char **, int));
337 uintmax_t strtoumax __P((const char *, char **, int));
338 #endif /* !_LIB_LIBKERN_LIBKERN_H_ */
339