bsd/libkern/libkern.h

   1 /*
   2  * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*-
  29  * Copyright (c) 1992, 1993
  30  *      The Regents of the University of California.  All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. All advertising materials mentioning features or use of this software
  41  *    must display the following acknowledgement:
  42  *      This product includes software developed by the University of
  43  *      California, Berkeley and its contributors.
  44  * 4. Neither the name of the University nor the names of its contributors
  45  *    may be used to endorse or promote products derived from this software
  46  *    without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  58  * SUCH DAMAGE.
  59  *
  60  *      @(#)libkern.h   8.1 (Berkeley) 6/10/93
  61  */
  62 /*
  63  * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
  64  * support for mandatory and extensible security protections.  This notice
  65  * is included in support of clause 2.2 (b) of the Apple Public License,
  66  * Version 2.0.
  67  */
  68
  69 #ifndef _LIBKERN_LIBKERN_H_
  70 #define _LIBKERN_LIBKERN_H_
  71
  72 #include <sys/appleapiopts.h>
  73 #include <stdint.h>
  74 #include <stdarg.h>     /* for platform-specific va_list */
  75 #include <string.h>
  76 #include <sys/cdefs.h>
  77 #include <sys/types.h>
  78 #include <mach/vm_param.h>
  79 #if __arm__
  80 #include <arm/arch.h> /* for _ARM_ARCH_* */
  81 #endif
  82
  83 #ifdef __APPLE_API_OBSOLETE
  84 /* BCD conversions. */
  85 extern u_char const     bcd2bin_data[];
  86 extern u_char const     bin2bcd_data[];
  87
  88 #define bcd2bin(bcd)    (bcd2bin_data[bcd])
  89 #define bin2bcd(bin)    (bin2bcd_data[bin])
  90 #endif /* __APPLE_API_OBSOLETE */
  91
  92 #ifdef __APPLE_API_PRIVATE
  93 extern char const       hex2ascii_data[];
  94
  95 #define hex2ascii(hex)  (hex2ascii_data[hex])
  96 #endif /* __APPLE_API_PRIVATE */
  97
  98 __BEGIN_DECLS
  99 static inline int
 100 imax(int a, int b)
 101 {
 102         return (a > b ? a : b);
 103 }
 104 static inline int
 105 imin(int a, int b)
 106 {
 107         return (a < b ? a : b);
 108 }
 109 static inline long
 110 lmax(long a, long b)
 111 {
 112         return (a > b ? a : b);
 113 }
 114 static inline long
 115 lmin(long a, long b)
 116 {
 117         return (a < b ? a : b);
 118 }
 119 static inline u_int
 120 max(u_int a, u_int b)
 121 {
 122         return (a > b ? a : b);
 123 }
 124 static inline u_int
 125 min(u_int a, u_int b)
 126 {
 127         return (a < b ? a : b);
 128 }
 129 static inline u_long
 130 ulmax(u_long a, u_long b)
 131 {
 132         return (a > b ? a : b);
 133 }
 134 static inline u_long
 135 ulmin(u_long a, u_long b)
 136 {
 137         return (a < b ? a : b);
 138 }
 139
 140
 141
 142 /* Prototypes for non-quad routines. */
 143 extern int      ffs(int);
 144 extern int      locc(int, char *, u_int);
 145 extern u_long   random(void);
 146 extern char     *rindex(const char *, int);
 147 extern int      scanc(u_int, u_char *, const u_char *, int);
 148 extern int      skpc(int, int, char *);
 149 extern long     strtol(const char*, char **, int);
 150 extern u_long   strtoul(const char *, char **, int);
 151 extern quad_t   strtoq(const char *, char **, int);
 152 extern u_quad_t strtouq(const char *, char **, int);
 153 extern char     *strsep(char **stringp, const char *delim);
 154
 155 int     snprintf(char *, size_t, const char *, ...) __printflike(3,4);
 156
 157 /* sprintf() is being deprecated. Please use snprintf() instead. */
 158 int     sprintf(char *bufp, const char *, ...) __deprecated;
 159 int     sscanf(const char *, char const *, ...) __scanflike(2,3);
 160 int     printf(const char *, ...) __printflike(1,2);
 161
 162 #if CONFIG_NO_PRINTF_STRINGS
 163 #define printf(x, ...)  do {} while (0)
 164 #endif
 165
 166 uint32_t        crc32(uint32_t crc, const void *bufp, size_t len);
 167
 168 int     copystr(const void *kfaddr, void *kdaddr, size_t len, size_t *done);
 169 int     copyinstr(const user_addr_t uaddr, void *kaddr, size_t len, size_t *done);
 170 int     copyoutstr(const void *kaddr, user_addr_t udaddr, size_t len, size_t *done);
 171 int     copyin(const user_addr_t uaddr, void *kaddr, size_t len);
 172 int     copyout(const void *kaddr, user_addr_t udaddr, size_t len);
 173
 174 int vsscanf(const char *, char const *, va_list);
 175
 176 extern int      vprintf(const char *, va_list);
 177 extern int      vsnprintf(char *, size_t, const char *, va_list);
 178
 179 /* vsprintf() is being deprecated. Please use vsnprintf() instead. */
 180 extern int      vsprintf(char *bufp, const char *, va_list) __deprecated;
 181
 182 extern void invalidate_icache(vm_offset_t, unsigned, int);
 183 extern void flush_dcache(vm_offset_t, unsigned, int);
 184 extern void invalidate_icache64(addr64_t, unsigned, int);
 185 extern void flush_dcache64(addr64_t, unsigned, int);
 186
 187
 188 /*
 189  * assembly versions of clz... ideally we would just call
 190  * __builtin_clz(num), unfortunately this one is ill defined
 191  * by gcc for num=0
 192  */
 193 static __inline__ unsigned int
 194 clz(unsigned int num)
 195 {
 196 #if __ppc__
 197         unsigned int result;
 198         __asm__ volatile(
 199                 "cntlzw %0, %1"
 200                 : "=r" (result)
 201                 : "r" (num)
 202         );
 203         return result;
 204
 205 #elif __i386__
 206         unsigned int result;
 207         __asm__ volatile(
 208                 "bsrl   %1, %0\n\t"
 209                 "cmovel %2, %0"
 210                 : "=r" (result)
 211                 : "rm" (num), "r" (63)
 212         );
 213         return 31 ^ result;
 214
 215 #elif __arm__ && !__thumb__ && defined(_ARM_ARCH_5)
 216         unsigned int result;
 217         __asm__ volatile(
 218                 "clz %0, %1"
 219                 : "=r" (result)
 220                 : "r" (num)
 221         );
 222
 223         return result;
 224 #else
 225         return num?__builtin_clz(num):__builtin_clz(0);
 226 #endif
 227 }
 228
 229
 230 __END_DECLS
 231
 232 #endif /* _LIBKERN_LIBKERN_H_ */