kernel - Add fuwordadd32(), fuwordadd64()
[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. 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: src/sys/sys/libkern.h,v 1.20.2.2 2001/09/30 21:12:54 luigi Exp $
31  */
32
33 #ifndef _SYS_LIBKERN_H_
34 #define _SYS_LIBKERN_H_
35
36 #if !defined(_KERNEL)
37 #error "This file should not be included by userland programs."
38 #else
39
40 /*
41  * Hacks to prevent conflicts with standard header files
42  */
43
44 #ifndef _SYS_CDEFS_H_
45 #include <sys/cdefs.h>
46 #endif
47 #ifndef _SYS_TYPES_H_
48 #include <sys/types.h>
49 #endif
50 #ifndef _SYS_SYSTM_H_
51 #include <sys/systm.h>
52 #endif
53
54 /* BCD conversions. */
55 extern u_char const     bcd2bin_data[];
56 extern u_char const     bin2bcd_data[];
57 extern char const       hex2ascii_data[];
58
59 #define bcd2bin(bcd)    (bcd2bin_data[bcd])
60 #define bin2bcd(bin)    (bin2bcd_data[bin])
61 #define hex2ascii(hex)  (hex2ascii_data[hex])
62
63 /*
64  * Number of bytes needed for hexadecimal representation
65  * plus trailing \0
66  */
67 #define HEX_NCPYLEN(s)  (s * 3)
68
69 static __inline int imax(int a, int b) { return (a > b ? a : b); }
70 static __inline int imin(int a, int b) { return (a < b ? a : b); }
71 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
72 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
73 static __inline u_int umax(u_int a, u_int b) { return (a > b ? a : b); }
74 static __inline u_int umin(u_int a, u_int b) { return (a < b ? a : b); }
75 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
76 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
77 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
78 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
79 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
80 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
81 static __inline u_int64_t u64max(u_int64_t a, u_int64_t b) { return (a > b ? a : b); }
82 static __inline u_int64_t u64min(u_int64_t a, u_int64_t b) { return (a < b ? a : b); }
83 static __inline int64_t i64max(int64_t a, int64_t b) { return (a > b ? a : b); }
84 static __inline int64_t i64min(int64_t a, int64_t b) { return (a < b ? a : b); }
85 static __inline size_t szmax(size_t a, size_t b) { return (a > b ? a : b); }
86 static __inline size_t szmin(size_t a, size_t b) { return (a < b ? a : b); }
87
88 static __inline int abs(int a) { return (a < 0 ? -a : a); }
89 static __inline long labs(long a) { return (a < 0 ? -a : a); }
90 static __inline quad_t qabs(quad_t a) { return (a < 0 ? -a : a); }
91
92 /* Prototypes for non-quad routines. */
93 uint32_t karc4random(void);
94 void     karc4rand(void *, size_t);
95 void     arc4_init_pcpu(int cpuid);
96 int      bcmp(const void *, const void *, size_t);
97 void    *kbsearch(const void *, const void *, size_t,
98                      size_t, int (*)(const void *, const void *));
99 #ifndef HAVE_INLINE_FFS
100 int      ffs(int);
101 #endif
102 #ifndef HAVE_INLINE_FFSL
103 int      ffsl(long);
104 #endif
105 #ifndef HAVE_INLINE_FLS
106 int      fls(int);
107 #endif
108 #ifndef HAVE_INLINE_FLSL
109 int      flsl(long);
110 #endif
111 #ifndef HAVE_INLINE_FLSLL
112 int      flsll(long long);
113 #endif
114 void     kqsort(void *base, size_t nmemb, size_t size,
115                     int (*compar)(const void *, const void *));
116 void     kqsort_r(void *base, size_t nmemb, size_t size, void *thunk,
117                     int (*compar)(void *, const void *, const void *));
118 u_long   krandom(void);
119 char    *index(const char *, int);
120 char    *rindex(const char *, int);
121 int      scanc(u_int, const u_char *, const u_char *, int);
122 int      skpc(int, int, char *);
123 void     skrandom(u_long);
124 char    *strcat(char * __restrict, const char * __restrict);
125 char    *strncat(char * __restrict, const char * __restrict, size_t);
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 size_t   strnlen(const char *, size_t);
136 char    *strsep(char **, const char *);
137 char    *strstr(const char *, const char *);
138 int      _kfnmatch(const char *, const char *, int, int);
139 void    *memcchr(const void *, int, size_t);
140 char    *hexncpy(const u_char *, int, char *, int, const char *);
141
142 /*
143  * memset can't be an inline, it is used by gcc-4.x directly.
144  */
145 void    *memset(void *, int, size_t);
146 void    *memmove(void *, const void *, size_t);
147
148
149 static __inline int
150 kfnmatch(const char *pattern, const char *string, int flags)
151 {
152         return(_kfnmatch(pattern, string, flags, 0));
153 }
154
155 static __inline int
156 memcmp(const void *b1, const void *b2, size_t len)
157 {
158         return (bcmp(b1, b2, len));
159 }
160
161 static __inline char *
162 strchr(const char *p, int ch)
163 {
164         return (index(p, ch));
165 }
166
167 static __inline char *
168 strrchr(const char *p, int ch)
169 {
170         return (rindex(p, ch));
171 }
172
173 /* kfnmatch() return values. */
174 #define FNM_NOMATCH     1       /* Match failed. */
175
176 /* kfnmatch() flags. */
177 #define FNM_NOESCAPE    0x01    /* Disable backslash escaping. */
178 #define FNM_PATHNAME    0x02    /* Slash must be matched by slash. */
179 #define FNM_PERIOD      0x04    /* Period must be matched by period. */
180 #define FNM_LEADING_DIR 0x08    /* Ignore /<tail> after Imatch. */
181 #define FNM_CASEFOLD    0x10    /* Case insensitive search. */
182 #define FNM_IGNORECASE  FNM_CASEFOLD
183 #define FNM_FILE_NAME   FNM_PATHNAME
184
185 #endif  /* _KERNEL */
186 #endif  /* !_SYS_LIBKERN_H_ */