sys/lib/libkern/libkern.h

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