xref: /freebsd/sys/sys/libkern.h (revision 41840d75)
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 int imax(int a, int b) { return (a > b ? a : b); }
57 static __inline int imin(int a, int b) { return (a < b ? a : b); }
58 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
59 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
60 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
61 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
62 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
63 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
64 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
65 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
66 static __inline off_t omax(off_t a, off_t b) { return (a > b ? a : b); }
67 static __inline off_t omin(off_t a, off_t b) { return (a < b ? a : b); }
68 
69 static __inline int abs(int a) { return (a < 0 ? -a : a); }
70 static __inline long labs(long a) { return (a < 0 ? -a : a); }
71 static __inline quad_t qabs(quad_t a) { return (a < 0 ? -a : a); }
72 
73 #define	ARC4_ENTR_NONE	0	/* Don't have entropy yet. */
74 #define	ARC4_ENTR_HAVE	1	/* Have entropy. */
75 #define	ARC4_ENTR_SEED	2	/* Reseeding. */
76 extern int arc4rand_iniseed_state;
77 
78 /* Prototypes for non-quad routines. */
79 struct malloc_type;
80 uint32_t arc4random(void);
81 void	 arc4rand(void *ptr, u_int len, int reseed);
82 int	 bcmp(const void *, const void *, size_t);
83 void	*bsearch(const void *, const void *, size_t,
84 	    size_t, int (*)(const void *, const void *));
85 #ifndef	HAVE_INLINE_FFS
86 int	 ffs(int);
87 #endif
88 #ifndef	HAVE_INLINE_FFSL
89 int	 ffsl(long);
90 #endif
91 #ifndef	HAVE_INLINE_FLS
92 int	 fls(int);
93 #endif
94 #ifndef	HAVE_INLINE_FLSL
95 int	 flsl(long);
96 #endif
97 #ifndef	HAVE_INLINE_FLSLL
98 int	 flsll(long long);
99 #endif
100 
101 int	 fnmatch(const char *, const char *, int);
102 int	 locc(int, char *, u_int);
103 void	*memchr(const void *s, int c, size_t n);
104 void	*memcchr(const void *s, int c, size_t n);
105 int	 memcmp(const void *b1, const void *b2, size_t len);
106 void	 qsort(void *base, size_t nmemb, size_t size,
107 	    int (*compar)(const void *, const void *));
108 void	 qsort_r(void *base, size_t nmemb, size_t size, void *thunk,
109 	    int (*compar)(void *, const void *, const void *));
110 u_long	 random(void);
111 int	 scanc(u_int, const u_char *, const u_char *, int);
112 void	 srandom(u_long);
113 int	 strcasecmp(const char *, const char *);
114 char	*strcat(char * __restrict, const char * __restrict);
115 char	*strchr(const char *, int);
116 int	 strcmp(const char *, const char *);
117 char	*strcpy(char * __restrict, const char * __restrict);
118 size_t	 strcspn(const char * __restrict, const char * __restrict) __pure;
119 char	*strdup(const char *__restrict, struct malloc_type *);
120 size_t	 strlcat(char *, const char *, size_t);
121 size_t	 strlcpy(char *, const char *, size_t);
122 size_t	 strlen(const char *);
123 int	 strncasecmp(const char *, const char *, size_t);
124 int	 strncmp(const char *, const char *, size_t);
125 char	*strncpy(char * __restrict, const char * __restrict, size_t);
126 size_t	 strnlen(const char *, size_t);
127 char	*strrchr(const char *, int);
128 char	*strsep(char **, const char *delim);
129 size_t	 strspn(const char *, const char *);
130 char	*strstr(const char *, const char *);
131 int	 strvalid(const char *, size_t);
132 
133 extern const uint32_t crc32_tab[];
134 
135 static __inline uint32_t
136 crc32_raw(const void *buf, size_t size, uint32_t crc)
137 {
138 	const uint8_t *p = (const uint8_t *)buf;
139 
140 	while (size--)
141 		crc = crc32_tab[(crc ^ *p++) & 0xFF] ^ (crc >> 8);
142 	return (crc);
143 }
144 
145 static __inline uint32_t
146 crc32(const void *buf, size_t size)
147 {
148 	uint32_t crc;
149 
150 	crc = crc32_raw(buf, size, ~0U);
151 	return (crc ^ ~0U);
152 }
153 
154 uint32_t
155 calculate_crc32c(uint32_t crc32c, const unsigned char *buffer,
156     unsigned int length);
157 
158 
159 LIBKERN_INLINE void *memset(void *, int, size_t);
160 #ifdef LIBKERN_BODY
161 LIBKERN_INLINE void *
162 memset(void *b, int c, size_t len)
163 {
164 	char *bb;
165 
166 	if (c == 0)
167 		bzero(b, len);
168 	else
169 		for (bb = (char *)b; len--; )
170 			*bb++ = c;
171 	return (b);
172 }
173 #endif
174 
175 static __inline char *
176 index(const char *p, int ch)
177 {
178 
179 	return (strchr(p, ch));
180 }
181 
182 static __inline char *
183 rindex(const char *p, int ch)
184 {
185 
186 	return (strrchr(p, ch));
187 }
188 
189 /* fnmatch() return values. */
190 #define	FNM_NOMATCH	1	/* Match failed. */
191 
192 /* fnmatch() flags. */
193 #define	FNM_NOESCAPE	0x01	/* Disable backslash escaping. */
194 #define	FNM_PATHNAME	0x02	/* Slash must be matched by slash. */
195 #define	FNM_PERIOD	0x04	/* Period must be matched by period. */
196 #define	FNM_LEADING_DIR	0x08	/* Ignore /<tail> after Imatch. */
197 #define	FNM_CASEFOLD	0x10	/* Case insensitive search. */
198 #define	FNM_IGNORECASE	FNM_CASEFOLD
199 #define	FNM_FILE_NAME	FNM_PATHNAME
200 
201 #endif /* !_SYS_LIBKERN_H_ */
202