815e595101d6e5fb34c717692ecb87c482a6e34b
[dragonfly.git] / sys / sys / libkern.h
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  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *      @(#)libkern.h   8.1 (Berkeley) 6/10/93
34  * $FreeBSD: src/sys/sys/libkern.h,v 1.20.2.2 2001/09/30 21:12:54 luigi Exp $
35  */
36
37 #ifndef _SYS_LIBKERN_H_
38 #define _SYS_LIBKERN_H_
39
40 #if !defined(_KERNEL)
41 #error "This file should not be included by userland programs."
42 #else
43
44 /*
45  * Hacks to prevent conflicts with standard header files
46  */
47
48 #ifndef _SYS_CDEFS_H_
49 #include <sys/cdefs.h>
50 #endif
51 #ifndef _SYS_TYPES_H_
52 #include <sys/types.h>
53 #endif
54 #ifndef _SYS_SYSTM_H_
55 #include <sys/systm.h>
56 #endif
57
58 /* BCD conversions. */
59 extern u_char const     bcd2bin_data[];
60 extern u_char const     bin2bcd_data[];
61 extern char const       hex2ascii_data[];
62
63 #define bcd2bin(bcd)    (bcd2bin_data[bcd])
64 #define bin2bcd(bin)    (bin2bcd_data[bin])
65 #define hex2ascii(hex)  (hex2ascii_data[hex])
66
67 /*
68  * Number of bytes needed for hexadecimal representation
69  * plus trailing \0
70  */
71 #define HEX_NCPYLEN(s) (s * 3)
72
73 static __inline int imax(int a, int b) { return (a > b ? a : b); }
74 static __inline int imin(int a, int b) { return (a < b ? a : b); }
75 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
76 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
77 static __inline u_int umax(u_int a, u_int b) { return (a > b ? a : b); }
78 static __inline u_int umin(u_int a, u_int b) { return (a < b ? a : b); }
79 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
80 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
81 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
82 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
83 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
84 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
85 static __inline u_int64_t u64max(u_int64_t a, u_int64_t b) { return (a > b ? a : b); }
86 static __inline u_int64_t u64min(u_int64_t a, u_int64_t b) { return (a < b ? a : b); }
87 static __inline int64_t i64max(int64_t a, int64_t b) { return (a > b ? a : b); }
88 static __inline int64_t i64min(int64_t a, int64_t b) { return (a < b ? a : b); }
89 static __inline size_t szmax(size_t a, size_t b) { return (a > b ? a : b); }
90 static __inline size_t szmin(size_t a, size_t b) { return (a < b ? a : b); }
91
92 static __inline int abs(int a) { return (a < 0 ? -a : a); }
93 static __inline long labs(long a) { return (a < 0 ? -a : a); }
94 static __inline quad_t qabs(quad_t a) { return (a < 0 ? -a : a); }
95
96 /* Prototypes for non-quad routines. */
97 u_int32_t karc4random (void);
98 void    karc4rand (void *, size_t);
99 int      bcmp (const void *, const void *, size_t);
100 void    *kbsearch (const void *, const void *, size_t,
101                      size_t, int (*)(const void *, const void *));
102 #ifndef HAVE_INLINE_FFS
103 int      ffs (int);
104 #endif
105 #ifndef HAVE_INLINE_FFSL
106 int      ffsl (long);
107 #endif
108 #ifndef HAVE_INLINE_FLS
109 int      fls (int);
110 #endif
111 #ifndef HAVE_INLINE_FLSL
112 int      flsl(long);
113 #endif
114 int      locc (int, char *, u_int);
115 void     kqsort (void *base, size_t nmemb, size_t size,
116                     int (*compar)(const void *, const void *));
117 void     kqsort_r(void *base, size_t nmemb, size_t size, void *thunk,
118                     int (*compar)(void *, const void *, const void *));
119 u_long   krandom (void);
120 char    *index (const char *, int);
121 char    *rindex (const char *, int);
122 int      scanc (u_int, const u_char *, const u_char *, int);
123 int      skpc (int, int, char *);
124 void     skrandom (u_long);
125 char    *strcat (char * __restrict, const char * __restrict);
126 int      strcmp (const char *, const char *);
127 int      strcasecmp (const char *, const char *);
128 char    *strcpy (char * __restrict, const char * __restrict);
129 size_t   strlcat (char *, const char *, size_t);
130 size_t   strlcpy (char *, const char *, size_t);
131 size_t   strlen (const char *);
132 int      strncmp (const char *, const char *, size_t);
133 int      strncasecmp (const char *, const char *, size_t);
134 char    *strncpy (char * __restrict, const char * __restrict, size_t);
135 char    *strsep(char **, const char *);
136 char    *strstr(const char *, const char *);
137 int     _kfnmatch(const char *, const char *, int, int);
138 void *  memcchr(const void *, int, size_t);
139 char *  hexncpy(const u_char *, int, char *, int, const char *);
140
141 /*
142  * memset can't be an inline, it is used by gcc-4.x directly.
143  */
144 void    *memset(void *b, int c, size_t len);
145 void    *memmove(void *s1, const void *s2, size_t n);
146
147
148 static __inline int
149 kfnmatch(const char *pattern, const char *string, int flags)
150 {
151         return(_kfnmatch(pattern, string, flags, 0));
152 }
153
154 static __inline int
155 memcmp(const void *b1, const void *b2, size_t len)
156 {
157         return (bcmp(b1, b2, len));
158 }
159
160 static __inline char *
161 strchr(const char *p, int ch)
162 {
163         return (index(p, ch));
164 }
165
166 static __inline char *
167 strrchr(const char *p, int ch)
168 {
169         return (rindex(p, ch));
170 }
171
172 /* kfnmatch() return values. */
173 #define FNM_NOMATCH     1       /* Match failed. */
174
175 /* kfnmatch() flags. */
176 #define FNM_NOESCAPE    0x01    /* Disable backslash escaping. */
177 #define FNM_PATHNAME    0x02    /* Slash must be matched by slash. */
178 #define FNM_PERIOD      0x04    /* Period must be matched by period. */
179 #define FNM_LEADING_DIR 0x08    /* Ignore /<tail> after Imatch. */
180 #define FNM_CASEFOLD    0x10    /* Case insensitive search. */
181 #define FNM_IGNORECASE  FNM_CASEFOLD
182 #define FNM_FILE_NAME   FNM_PATHNAME
183
184 #endif  /* _KERNEL */
185 #endif  /* !_SYS_LIBKERN_H_ */