Home | History | Annotate | Line # | Download | only in libkern
libkern.h revision 1.82.8.5
      1 /*	$NetBSD: libkern.h,v 1.82.8.5 2014/02/14 18:38:15 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)) __unused;
     47 LIBKERN_INLINE int imin __P((int, int)) __unused;
     48 LIBKERN_INLINE u_int max __P((u_int, u_int)) __unused;
     49 LIBKERN_INLINE u_int min __P((u_int, u_int)) __unused;
     50 LIBKERN_INLINE long lmax __P((long, long)) __unused;
     51 LIBKERN_INLINE long lmin __P((long, long)) __unused;
     52 LIBKERN_INLINE u_long ulmax __P((u_long, u_long)) __unused;
     53 LIBKERN_INLINE u_long ulmin __P((u_long, u_long)) __unused;
     54 LIBKERN_INLINE int abs __P((int)) __unused;
     55 
     56 LIBKERN_INLINE int isspace __P((int)) __unused;
     57 LIBKERN_INLINE int isascii __P((int)) __unused;
     58 LIBKERN_INLINE int isupper __P((int)) __unused;
     59 LIBKERN_INLINE int islower __P((int)) __unused;
     60 LIBKERN_INLINE int isalpha __P((int)) __unused;
     61 LIBKERN_INLINE int isdigit __P((int)) __unused;
     62 LIBKERN_INLINE int isxdigit __P((int)) __unused;
     63 LIBKERN_INLINE int toupper __P((int)) __unused;
     64 LIBKERN_INLINE int tolower __P((int)) __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 #define	__NULL_STMT		do { } while (/* CONSTCOND */ 0)
    176 
    177 #define _KASSERTSTR "kernel %sassertion \"%s\" failed: file \"%s\", line %d "
    178 
    179 
    180 #ifdef NDEBUG						/* tradition! */
    181 #define	assert(e)	((void)0)
    182 #else
    183 #ifdef __STDC__
    184 #define	assert(e)	(__predict_true((e)) ? (void)0 :		    \
    185 			    __kernassert(_KASSERTSTR, __FILE__, __LINE__, #e))
    186 #else
    187 #define	assert(e)	(__predict_true((e)) ? (void)0 :		    \
    188 			    __kernassert(_KASSERTSTR, __FILE__, __LINE__, "e"))
    189 #endif
    190 #endif
    191 
    192 #ifdef __COVERITY__
    193 #ifndef DIAGNOSTIC
    194 #define DIAGNOSTIC
    195 #endif
    196 #endif
    197 
    198 #define	CTASSERT(x)		__CTASSERT(x)
    199 
    200 #ifndef DIAGNOSTIC
    201 #define _DIAGASSERT(a)	(void)0
    202 #ifdef lint
    203 #define	KASSERTMSG(e, msg, ...)	/* NOTHING */
    204 #define	KASSERT(e)		/* NOTHING */
    205 #else /* !lint */
    206 #define	KASSERTMSG(e, msg, ...)	((void)0)
    207 #define	KASSERT(e)		((void)0)
    208 #endif /* !lint */
    209 #else /* DIAGNOSTIC */
    210 #define _DIAGASSERT(a)	assert(a)
    211 #define	KASSERTMSG(e, msg, ...)					\
    212 	(__predict_true((e)) ? (void)0				\
    213 	    : __kernassert(_KASSERTSTR msg, "diagnostic ", #e,	\
    214 		    __FILE__, __LINE__, ## __VA_ARGS__ ))
    215 #ifdef __STDC__
    216 #define	KASSERT(e)	(__predict_true((e)) ? (void)0 :		    \
    217 			    __kernassert(_KASSERTSTR, "diagnostic ", __FILE__, __LINE__, #e))
    218 #else
    219 #define	KASSERT(e)	(__predict_true((e)) ? (void)0 :		    \
    220 			    __kernassert(_KASSERTSTR, "diagnostic ", __FILE__, __LINE__,"e"))
    221 #endif
    222 #endif
    223 
    224 #ifndef DEBUG
    225 #ifdef lint
    226 #define	KDASSERTMSG(e, msg, ...) /* NOTHING */
    227 #define	KDASSERT(e)		/* NOTHING */
    228 #else /* lint */
    229 #define	KDASSERTMSG(e, msg, ...) ((void)0)
    230 #define	KDASSERT(e)		((void)0)
    231 #endif /* lint */
    232 #else
    233 #define	KDASSERTMSG(e, msg, ...)				\
    234 	(__predict_true((e)) ? (void)0				\
    235 	    : __kernassert(_KASSERTSTR msg, "debuggin ", #e,	\
    236 		    __FILE__, __LINE__, ## __VA_ARGS__ ))
    237 #ifdef __STDC__
    238 #define	KDASSERT(e)	(__predict_true((e)) ? (void)0 :		    \
    239 			    __kernassert(_KASSERTSTR, "debugging ", __FILE__, __LINE__, #e))
    240 #else
    241 #define	KDASSERT(e)	(__predict_true((e)) ? (void)0 :		    \
    242 			    __kernassert(_KASSERTSTR, "debugging ", __FILE__, __LINE__, "e"))
    243 #endif
    244 #endif
    245 /*
    246  * XXX: For compatibility we use SMALL_RANDOM by default.
    247  */
    248 #define SMALL_RANDOM
    249 
    250 #ifndef offsetof
    251 #define	offsetof(type, member) \
    252     ((size_t)(unsigned long)(&(((type *)0)->member)))
    253 #endif
    254 
    255 #define	MTPRNG_RLEN		624
    256 struct mtprng_state {
    257 	unsigned int mt_idx;
    258 	uint32_t mt_elem[MTPRNG_RLEN];
    259 	uint32_t mt_count;
    260 	uint32_t mt_sparse[3];
    261 };
    262 
    263 /* Prototypes for non-quad routines. */
    264 /* XXX notyet #ifdef _STANDALONE */
    265 int	 bcmp __P((const void *, const void *, size_t));
    266 void 	 bcopy __P((const void *, void *, size_t));
    267 void	 bzero __P((void *, size_t));
    268 /* #endif */
    269 
    270 /* Prototypes for which GCC built-ins exist. */
    271 void	*memcpy __P((void *, const void *, size_t));
    272 int	 memcmp __P((const void *, const void *, size_t));
    273 void	*memset __P((void *, int, size_t));
    274 #if __GNUC_PREREQ__(2, 95) && (__GNUC_PREREQ__(4, 0) || !defined(__vax__))
    275 #define	memcpy(d, s, l)		__builtin_memcpy(d, s, l)
    276 #define	memcmp(a, b, l)		__builtin_memcmp(a, b, l)
    277 #endif
    278 #if __GNUC_PREREQ__(2, 95) && !defined(__vax__)
    279 #define	memset(d, v, l)		__builtin_memset(d, v, l)
    280 #endif
    281 
    282 char	*strcpy __P((char *, const char *));
    283 int	 strcmp __P((const char *, const char *));
    284 size_t	 strlen __P((const char *));
    285 char	*strsep(char **, const char *);
    286 #if __GNUC_PREREQ__(2, 95)
    287 #define	strcpy(d, s)		__builtin_strcpy(d, s)
    288 #define	strcmp(a, b)		__builtin_strcmp(a, b)
    289 #define	strlen(a)		__builtin_strlen(a)
    290 #endif
    291 
    292 /* Functions for which we always use built-ins. */
    293 #ifdef __GNUC__
    294 #define	alloca(s)		__builtin_alloca(s)
    295 #endif
    296 
    297 /* These exist in GCC 3.x, but we don't bother. */
    298 char	*strcat __P((char *, const char *));
    299 char	*strncpy __P((char *, const char *, size_t));
    300 int	 strncmp __P((const char *, const char *, size_t));
    301 char	*strchr __P((const char *, int));
    302 char	*strrchr __P((const char *, int));
    303 
    304 char	*strstr __P((const char *, const char *));
    305 
    306 /*
    307  * ffs is an instruction on vax.
    308  */
    309 int	 ffs __P((int));
    310 #if __GNUC_PREREQ__(2, 95) && (!defined(__vax__) || __GNUC_PREREQ__(4,1))
    311 #define	ffs(x)		__builtin_ffs(x)
    312 #endif
    313 
    314 void	 __kernassert (const char *, ...);
    315 unsigned int
    316 	bcdtobin __P((unsigned int));
    317 unsigned int
    318 	bintobcd __P((unsigned int));
    319 u_int32_t
    320 	inet_addr __P((const char *));
    321 struct in_addr;
    322 int	inet_aton __P((const char *, struct in_addr *));
    323 char	*intoa __P((u_int32_t));
    324 #define inet_ntoa(a) intoa((a).s_addr)
    325 void	*memchr __P((const void *, int, size_t));
    326 void	*memmove __P((void *, const void *, size_t));
    327 int	 pmatch __P((const char *, const char *, const char **));
    328 u_int32_t arc4random __P((void));
    329 void	 arc4randbytes __P((void *, size_t));
    330 #ifndef SMALL_RANDOM
    331 void	 srandom __P((unsigned long));
    332 char	*initstate __P((unsigned long, char *, size_t));
    333 char	*setstate __P((char *));
    334 #endif /* SMALL_RANDOM */
    335 long	 random __P((void));
    336 void	 mtprng_init32(struct mtprng_state *, uint32_t);
    337 void	 mtprng_initarray(struct mtprng_state *, const uint32_t *, size_t);
    338 uint32_t mtprng_rawrandom(struct mtprng_state *);
    339 uint32_t mtprng_random(struct mtprng_state *);
    340 int	 scanc __P((u_int, const u_char *, const u_char *, int));
    341 int	 skpc __P((int, size_t, u_char *));
    342 int	 strcasecmp __P((const char *, const char *));
    343 size_t	 strlcpy __P((char *, const char *, size_t));
    344 size_t	 strlcat __P((char *, const char *, size_t));
    345 int	 strncasecmp __P((const char *, const char *, size_t));
    346 u_long	 strtoul __P((const char *, char **, int));
    347 uint32_t crc32(uint32_t, const uint8_t *, size_t);
    348 long long strtoll __P((const char *, char **, int));
    349 unsigned long long strtoull __P((const char *, char **, int));
    350 uintmax_t strtoumax __P((const char *, char **, int));
    351 unsigned int	popcount(unsigned int);
    352 unsigned int	popcountl(unsigned long);
    353 unsigned int	popcountll(unsigned long long);
    354 unsigned int	popcount32(uint32_t);
    355 unsigned int	popcount64(uint64_t);
    356 #endif /* !_LIB_LIBKERN_LIBKERN_H_ */
    357