bsd/libkern/libkern.h

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