bsd/libkern/libkern.h

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