sys/sys/libkern.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   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.1 (Berkeley) 6/10/93
  32  */
  33
  34 #ifndef _SYS_LIBKERN_H_
  35 #define _SYS_LIBKERN_H_
  36
  37 #include <sys/cdefs.h>
  38 #include <sys/types.h>
  39 #ifdef _KERNEL
  40 #include <sys/systm.h>
  41 #endif
  42
  43 #ifndef LIBKERN_INLINE
  44 #define LIBKERN_INLINE  static __inline
  45 #define LIBKERN_BODY
  46 #endif
  47
  48 /* BCD conversions. */
  49 extern u_char const     bcd2bin_data[];
  50 extern u_char const     bin2bcd_data[];
  51 extern char const       hex2ascii_data[];
  52
  53 #define LIBKERN_LEN_BCD2BIN     154
  54 #define LIBKERN_LEN_BIN2BCD     100
  55 #define LIBKERN_LEN_HEX2ASCII   36
  56
  57 static inline u_char
  58 bcd2bin(int bcd)
  59 {
  60
  61         KASSERT(bcd >= 0 && bcd < LIBKERN_LEN_BCD2BIN,
  62             ("invalid bcd %d", bcd));
  63         return (bcd2bin_data[bcd]);
  64 }
  65
  66 static inline u_char
  67 bin2bcd(int bin)
  68 {
  69
  70         KASSERT(bin >= 0 && bin < LIBKERN_LEN_BIN2BCD,
  71             ("invalid bin %d", bin));
  72         return (bin2bcd_data[bin]);
  73 }
  74
  75 static inline char
  76 hex2ascii(int hex)
  77 {
  78
  79         KASSERT(hex >= 0 && hex < LIBKERN_LEN_HEX2ASCII,
  80             ("invalid hex %d", hex));
  81         return (hex2ascii_data[hex]);
  82 }
  83
  84 static inline bool
  85 validbcd(int bcd)
  86 {
  87
  88         return (bcd == 0 || (bcd > 0 && bcd <= 0x99 && bcd2bin_data[bcd] != 0));
  89 }
  90 static __inline int imax(int a, int b) { return (a > b ? a : b); }
  91 static __inline int imin(int a, int b) { return (a < b ? a : b); }
  92 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
  93 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
  94 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
  95 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
  96 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
  97 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
  98 static __inline u_quad_t uqmax(u_quad_t a, u_quad_t b) { return (a > b ? a : b); }
  99 static __inline u_quad_t uqmin(u_quad_t a, u_quad_t b) { return (a < b ? a : b); }
 100 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
 101 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
 102 static __inline __uintmax_t ummax(__uintmax_t a, __uintmax_t b)
 103 {
 104
 105         return (a > b ? a : b);
 106 }
 107 static __inline __uintmax_t ummin(__uintmax_t a, __uintmax_t b)
 108 {
 109
 110         return (a < b ? a : b);
 111 }
 112 static __inline off_t omax(off_t a, off_t b) { return (a > b ? a : b); }
 113 static __inline off_t omin(off_t a, off_t b) { return (a < b ? a : b); }
 114 static __inline int abs(int a) { return (a < 0 ? -a : a); }
 115 static __inline long labs(long a) { return (a < 0 ? -a : a); }
 116 static __inline quad_t qabs(quad_t a) { return (a < 0 ? -a : a); }
 117
 118 #ifndef RANDOM_FENESTRASX
 119 #define ARC4_ENTR_NONE  0       /* Don't have entropy yet. */
 120 #define ARC4_ENTR_HAVE  1       /* Have entropy. */
 121 #define ARC4_ENTR_SEED  2       /* Reseeding. */
 122 extern int arc4rand_iniseed_state;
 123 #endif
 124
 125 /* Prototypes for non-quad routines. */
 126 struct malloc_type;
 127 uint32_t arc4random(void);
 128 void     arc4random_buf(void *, size_t);
 129 uint32_t arc4random_uniform(uint32_t);
 130 void     arc4rand(void *, u_int, int);
 131 int      timingsafe_bcmp(const void *, const void *, size_t);
 132 void    *bsearch(const void *, const void *, size_t,
 133             size_t, int (*)(const void *, const void *));
 134
 135 /*
 136  * MHTODO: remove the 'HAVE_INLINE_FOO' defines once use of these flags has
 137  * been purged everywhere. For now we provide them unconditionally.
 138  */
 139 #define HAVE_INLINE_FFS
 140 #define HAVE_INLINE_FFSL
 141 #define HAVE_INLINE_FFSLL
 142 #define HAVE_INLINE_FLS
 143 #define HAVE_INLINE_FLSL
 144 #define HAVE_INLINE_FLSLL
 145
 146 static __inline __pure2 int
 147 ffs(int mask)
 148 {
 149
 150         return (__builtin_ffs((u_int)mask));
 151 }
 152
 153 static __inline __pure2 int
 154 ffsl(long mask)
 155 {
 156
 157         return (__builtin_ffsl((u_long)mask));
 158 }
 159
 160 static __inline __pure2 int
 161 ffsll(long long mask)
 162 {
 163
 164         return (__builtin_ffsll((unsigned long long)mask));
 165 }
 166
 167 static __inline __pure2 int
 168 fls(int mask)
 169 {
 170
 171         return (mask == 0 ? 0 :
 172             8 * sizeof(mask) - __builtin_clz((u_int)mask));
 173 }
 174
 175 static __inline __pure2 int
 176 flsl(long mask)
 177 {
 178
 179         return (mask == 0 ? 0 :
 180             8 * sizeof(mask) - __builtin_clzl((u_long)mask));
 181 }
 182
 183 static __inline __pure2 int
 184 flsll(long long mask)
 185 {
 186
 187         return (mask == 0 ? 0 :
 188             8 * sizeof(mask) - __builtin_clzll((unsigned long long)mask));
 189 }
 190
 191 #define bitcount64(x)   __bitcount64((uint64_t)(x))
 192 #define bitcount32(x)   __bitcount32((uint32_t)(x))
 193 #define bitcount16(x)   __bitcount16((uint16_t)(x))
 194 #define bitcountl(x)    __bitcountl((u_long)(x))
 195 #define bitcount(x)     __bitcount((u_int)(x))
 196
 197 int      fnmatch(const char *, const char *, int);
 198 int      locc(int, char *, u_int);
 199 void    *memchr(const void *s, int c, size_t n);
 200 void    *memcchr(const void *s, int c, size_t n);
 201 void    *memmem(const void *l, size_t l_len, const void *s, size_t s_len);
 202 void     qsort(void *base, size_t nmemb, size_t size,
 203             int (*compar)(const void *, const void *));
 204 void     qsort_r(void *base, size_t nmemb, size_t size,
 205             int (*compar)(const void *, const void *, void *), void *thunk);
 206 u_long   random(void);
 207 int      scanc(u_int, const u_char *, const u_char *, int);
 208 int      strcasecmp(const char *, const char *);
 209 char    *strcasestr(const char *, const char *);
 210 char    *strcat(char * __restrict, const char * __restrict);
 211 char    *strchr(const char *, int);
 212 char    *strchrnul(const char *, int);
 213 int      strcmp(const char *, const char *);
 214 char    *strcpy(char * __restrict, const char * __restrict);
 215 char    *strdup_flags(const char *__restrict, struct malloc_type *, int);
 216 size_t   strcspn(const char *, const char *) __pure;
 217 char    *strdup(const char *__restrict, struct malloc_type *);
 218 char    *strncat(char *, const char *, size_t);
 219 char    *strndup(const char *__restrict, size_t, struct malloc_type *);
 220 size_t   strlcat(char *, const char *, size_t);
 221 size_t   strlcpy(char *, const char *, size_t);
 222 size_t   strlen(const char *);
 223 int      strncasecmp(const char *, const char *, size_t);
 224 int      strncmp(const char *, const char *, size_t);
 225 char    *strncpy(char * __restrict, const char * __restrict, size_t);
 226 size_t   strnlen(const char *, size_t);
 227 char    *strnstr(const char *, const char *, size_t);
 228 char    *strrchr(const char *, int);
 229 char    *strsep(char **, const char *delim);
 230 size_t   strspn(const char *, const char *);
 231 char    *strstr(const char *, const char *);
 232 int      strvalid(const char *, size_t);
 233
 234 #ifdef SAN_NEEDS_INTERCEPTORS
 235 #ifndef SAN_INTERCEPTOR
 236 #define SAN_INTERCEPTOR(func)   \
 237         __CONCAT(SAN_INTERCEPTOR_PREFIX, __CONCAT(_, func))
 238 #endif
 239 char    *SAN_INTERCEPTOR(strcpy)(char *, const char *);
 240 int     SAN_INTERCEPTOR(strcmp)(const char *, const char *);
 241 size_t  SAN_INTERCEPTOR(strlen)(const char *);
 242 #ifndef SAN_RUNTIME
 243 #define strcpy(d, s)    SAN_INTERCEPTOR(strcpy)((d), (s))
 244 #define strcmp(s1, s2)  SAN_INTERCEPTOR(strcmp)((s1), (s2))
 245 #define strlen(s)       SAN_INTERCEPTOR(strlen)(s)
 246 #endif /* !SAN_RUNTIME */
 247 #else /* !SAN_NEEDS_INTERCEPTORS */
 248 #define strcpy(d, s)    __builtin_strcpy((d), (s))
 249 #define strcmp(s1, s2)  __builtin_strcmp((s1), (s2))
 250 #define strlen(s)       __builtin_strlen((s))
 251 #endif /* SAN_NEEDS_INTERCEPTORS */
 252
 253 static __inline char *
 254 index(const char *p, int ch)
 255 {
 256
 257         return (strchr(p, ch));
 258 }
 259
 260 static __inline char *
 261 rindex(const char *p, int ch)
 262 {
 263
 264         return (strrchr(p, ch));
 265 }
 266
 267 static __inline int64_t
 268 signed_extend64(uint64_t bitmap, int lsb, int width)
 269 {
 270
 271         return ((int64_t)(bitmap << (63 - lsb - (width - 1)))) >>
 272             (63 - (width - 1));
 273 }
 274
 275 static __inline int32_t
 276 signed_extend32(uint32_t bitmap, int lsb, int width)
 277 {
 278
 279         return ((int32_t)(bitmap << (31 - lsb - (width - 1)))) >>
 280             (31 - (width - 1));
 281 }
 282
 283 /* fnmatch() return values. */
 284 #define FNM_NOMATCH     1       /* Match failed. */
 285
 286 /* fnmatch() flags. */
 287 #define FNM_NOESCAPE    0x01    /* Disable backslash escaping. */
 288 #define FNM_PATHNAME    0x02    /* Slash must be matched by slash. */
 289 #define FNM_PERIOD      0x04    /* Period must be matched by period. */
 290 #define FNM_LEADING_DIR 0x08    /* Ignore /<tail> after Imatch. */
 291 #define FNM_CASEFOLD    0x10    /* Case insensitive search. */
 292 #define FNM_IGNORECASE  FNM_CASEFOLD
 293 #define FNM_FILE_NAME   FNM_PATHNAME
 294
 295 #endif /* !_SYS_LIBKERN_H_ */