rename sscanf -> ksscanf
[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  * $DragonFly: src/sys/sys/libkern.h,v 1.12 2006/12/13 21:58:52 dillon Exp $
36  */
37
38 #ifndef _SYS_LIBKERN_H_
39 #define _SYS_LIBKERN_H_
40
41 #if !defined(_KERNEL)
42 #error "This file should not be included by userland programs."
43 #else
44
45 #ifndef _SYS_CDEFS_H_
46 #include <sys/cdefs.h>
47 #endif
48 #ifndef _SYS_TYPES_H_
49 #include <sys/types.h>
50 #endif
51 #ifndef _SYS_SYSTM_H_
52 #include <sys/systm.h>
53 #endif
54
55 /* BCD conversions. */
56 extern u_char const     bcd2bin_data[];
57 extern u_char const     bin2bcd_data[];
58 extern char const       hex2ascii_data[];
59
60 #define bcd2bin(bcd)    (bcd2bin_data[bcd])
61 #define bin2bcd(bin)    (bin2bcd_data[bin])
62 #define hex2ascii(hex)  (hex2ascii_data[hex])
63
64 static __inline int imax(int a, int b) { return (a > b ? a : b); }
65 static __inline int imin(int a, int b) { return (a < b ? a : b); }
66 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
67 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
68 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
69 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
70 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
71 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
72 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
73 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
74
75 /* Prototypes for non-quad routines. */
76 u_int32_t karc4random (void);
77 int      bcmp (const void *, const void *, size_t);
78 #ifndef HAVE_INLINE_FFS
79 int      ffs (int);
80 #endif
81 #ifndef HAVE_INLINE_FLS
82 int      fls (int);
83 #endif
84 int      locc (int, char *, u_int);
85 void     kqsort (void *base, size_t nmemb, size_t size,
86                     int (*compar)(const void *, const void *));
87 u_long   krandom (void);
88 char    *index (const char *, int);
89 char    *rindex (const char *, int);
90 int      scanc (u_int, const u_char *, const u_char *, int);
91 int      skpc (int, int, char *);
92 void     skrandom (u_long);
93 char    *strcat (char * __restrict, const char * __restrict);
94 int      strcmp (const char *, const char *);
95 char    *strcpy (char * __restrict, const char * __restrict);
96 size_t   strlcat (char *, const char *, size_t);
97 size_t   strlcpy (char *, const char *, size_t);
98 size_t   strlen (const char *);
99 int      strncmp (const char *, const char *, size_t);
100 char    *strncpy (char * __restrict, const char * __restrict, size_t);
101 int     _kfnmatch(const char *, const char *, int, int);
102
103 /*
104  * memset can't be an inline, it is used by gcc-4.x directly.
105  */
106 void    *memset(void *b, int c, size_t len);
107
108 static __inline int
109 kfnmatch(const char *pattern, const char *string, int flags)
110 {
111         return(_kfnmatch(pattern, string, flags, 0));
112 }
113
114 static __inline int
115 memcmp(const void *b1, const void *b2, size_t len)
116 {
117         return (bcmp(b1, b2, len));
118 }
119
120 /* kfnmatch() return values. */
121 #define FNM_NOMATCH     1       /* Match failed. */
122
123 /* kfnmatch() flags. */
124 #define FNM_NOESCAPE    0x01    /* Disable backslash escaping. */
125 #define FNM_PATHNAME    0x02    /* Slash must be matched by slash. */
126 #define FNM_PERIOD      0x04    /* Period must be matched by period. */
127 #define FNM_LEADING_DIR 0x08    /* Ignore /<tail> after Imatch. */
128 #define FNM_CASEFOLD    0x10    /* Case insensitive search. */
129 #define FNM_IGNORECASE  FNM_CASEFOLD
130 #define FNM_FILE_NAME   FNM_PATHNAME
131
132 #endif  /* _KERNEL */
133 #endif  /* !_SYS_LIBKERN_H_ */