bsd/libkern/libkern.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*-
  24  * Copyright (c) 1992, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  *
  27  * Redistribution and use in source and binary forms, with or without
  28  * modification, are permitted provided that the following conditions
  29  * are met:
  30  * 1. Redistributions of source code must retain the above copyright
  31  *    notice, this list of conditions and the following disclaimer.
  32  * 2. Redistributions in binary form must reproduce the above copyright
  33  *    notice, this list of conditions and the following disclaimer in the
  34  *    documentation and/or other materials provided with the distribution.
  35  * 3. All advertising materials mentioning features or use of this software
  36  *    must display the following acknowledgement:
  37  *      This product includes software developed by the University of
  38  *      California, Berkeley and its contributors.
  39  * 4. Neither the name of the University nor the names of its contributors
  40  *    may be used to endorse or promote products derived from this software
  41  *    without specific prior written permission.
  42  *
  43  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  44  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  45  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  46  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  47  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  48  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  49  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  51  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  52  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  53  * SUCH DAMAGE.
  54  *
  55  *      @(#)libkern.h   8.1 (Berkeley) 6/10/93
  56  */
  57
  58 #ifndef _LIBKERN_LIBKERN_H_
  59 #define _LIBKERN_LIBKERN_H_
  60
  61 #include <sys/appleapiopts.h>
  62 #include <stdint.h>
  63 #include <string.h>
  64 #include <sys/cdefs.h>
  65 #include <sys/types.h>
  66 #include <mach/vm_param.h>
  67
  68 #ifdef __APPLE_API_OBSOLETE
  69 /* BCD conversions. */
  70 extern u_char const     bcd2bin_data[];
  71 extern u_char const     bin2bcd_data[];
  72
  73 #define bcd2bin(bcd)    (bcd2bin_data[bcd])
  74 #define bin2bcd(bin)    (bin2bcd_data[bin])
  75 #endif /* __APPLE_API_OBSOLETE */
  76
  77 #ifdef __APPLE_API_PRIVATE
  78 extern char const       hex2ascii_data[];
  79
  80 #define hex2ascii(hex)  (hex2ascii_data[hex])
  81 #endif /* __APPLE_API_PRIVATE */
  82
  83 __BEGIN_DECLS
  84 static inline int
  85 imax(int a, int b)
  86 {
  87         return (a > b ? a : b);
  88 }
  89 static inline int
  90 imin(int a, int b)
  91 {
  92         return (a < b ? a : b);
  93 }
  94 static inline long
  95 lmax(long a, long b)
  96 {
  97         return (a > b ? a : b);
  98 }
  99 static inline long
 100 lmin(long a, long b)
 101 {
 102         return (a < b ? a : b);
 103 }
 104 static inline u_int
 105 max(u_int a, u_int b)
 106 {
 107         return (a > b ? a : b);
 108 }
 109 static inline u_int
 110 min(u_int a, u_int b)
 111 {
 112         return (a < b ? a : b);
 113 }
 114 static inline u_long
 115 ulmax(u_long a, u_long b)
 116 {
 117         return (a > b ? a : b);
 118 }
 119 static inline u_long
 120 ulmin(u_long a, u_long b)
 121 {
 122         return (a < b ? a : b);
 123 }
 124
 125 /* Prototypes for non-quad routines. */
 126 extern int      ffs(int);
 127 extern int      locc(int, char *, u_int);
 128 extern u_long   random(void);
 129 extern char     *rindex(const char *, int);
 130 extern int      scanc(u_int, u_char *, const u_char *, int);
 131 extern int      skpc(int, int, char *);
 132 extern long     strtol(const char*, char **, int);
 133 extern u_long   strtoul(const char *, char **, int);
 134 extern quad_t   strtoq(const char *, char **, int);
 135 extern u_quad_t strtouq(const char *, char **, int);
 136
 137 int     snprintf(char *, size_t, const char *, ...);
 138 int     sprintf(char *bufp, const char *, ...);
 139 int     sscanf(const char *, char const *, ...);
 140 void printf(const char *, ...);
 141
 142 uint32_t        crc32(uint32_t crc, const void *bufp, size_t len);
 143
 144 int     copystr(const void *kfaddr, void *kdaddr, size_t len, size_t *done);
 145 int     copyinstr(const user_addr_t uaddr, void *kaddr, size_t len, size_t *done);
 146 int     copyoutstr(const void *kaddr, user_addr_t udaddr, size_t len, size_t *done);
 147 int     copyin(const user_addr_t uaddr, void *kaddr, size_t len);
 148 int     copyout(const void *kaddr, user_addr_t udaddr, size_t len);
 149
 150 int vsscanf(const char *, char const *, __darwin_va_list);
 151 extern int      vsnprintf(char *, size_t, const char *, __darwin_va_list);
 152 extern int      vsprintf(char *bufp, const char *, __darwin_va_list);
 153
 154 extern void invalidate_icache(vm_offset_t, unsigned, int);
 155 extern void flush_dcache(vm_offset_t, unsigned, int);
 156 extern void invalidate_icache64(addr64_t, unsigned, int);
 157 extern void flush_dcache64(addr64_t, unsigned, int);
 158
 159 __END_DECLS
 160
 161 #endif /* _LIBKERN_LIBKERN_H_ */