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 80 81#ifdef __APPLE_API_OBSOLETE 82/* BCD conversions. */ 83extern u_char const bcd2bin_data[]; 84extern u_char const bin2bcd_data[]; 85 86#define bcd2bin(bcd) (bcd2bin_data[bcd]) 87#define bin2bcd(bin) (bin2bcd_data[bin]) 88#endif /* __APPLE_API_OBSOLETE */ 89 90#ifdef __APPLE_API_PRIVATE 91extern char const hex2ascii_data[]; 92 93#define hex2ascii(hex) (hex2ascii_data[hex]) 94#endif /* __APPLE_API_PRIVATE */ 95 96__BEGIN_DECLS 97static inline int 98imax(int a, int b) 99{ 100 return (a > b ? a : b); 101} 102static inline int 103imin(int a, int b) 104{ 105 return (a < b ? a : b); 106} 107static inline long 108lmax(long a, long b) 109{ 110 return (a > b ? a : b); 111} 112static inline long 113lmin(long a, long b) 114{ 115 return (a < b ? a : b); 116} 117static inline u_int 118max(u_int a, u_int b) 119{ 120 return (a > b ? a : b); 121} 122static inline u_int 123min(u_int a, u_int b) 124{ 125 return (a < b ? a : b); 126} 127static inline u_int32_t 128ulmax(u_int32_t a, u_int32_t b) 129{ 130 return (a > b ? a : b); 131} 132static inline u_int32_t 133ulmin(u_int32_t a, u_int32_t b) 134{ 135 return (a < b ? a : b); 136} 137 138 139 140/* Prototypes for non-quad routines. */ 141extern int ffs(int); 142extern int locc(int, char *, u_int); 143extern u_int32_t random(void); 144extern char *rindex(const char *, int); 145extern int scanc(u_int, u_char *, const u_char *, int); 146extern int skpc(int, int, char *); 147extern long strtol(const char*, char **, int); 148extern u_long strtoul(const char *, char **, int); 149extern quad_t strtoq(const char *, char **, int); 150extern u_quad_t strtouq(const char *, char **, int); 151extern char *strsep(char **stringp, const char *delim); 152 153int snprintf(char *, size_t, const char *, ...) __printflike(3,4); 154 155/* sprintf() is being deprecated. Please use snprintf() instead. */ 156int sprintf(char *bufp, const char *, ...) __deprecated; 157int sscanf(const char *, char const *, ...) __scanflike(2,3); 158int printf(const char *, ...) __printflike(1,2); 159 160#if KERNEL_PRIVATE 161int _consume_printf_args(int, ...); 162#endif 163 164#if CONFIG_NO_PRINTF_STRINGS 165#if KERNEL_PRIVATE 166#define printf(x, ...) _consume_printf_args( 0, ## __VA_ARGS__ ) 167#else 168#define printf(x, ...) do {} while (0) 169#endif 170#endif 171 172uint32_t crc32(uint32_t crc, const void *bufp, size_t len); 173 174int copystr(const void *kfaddr, void *kdaddr, size_t len, size_t *done); 175int copyinstr(const user_addr_t uaddr, void *kaddr, size_t len, size_t *done); 176int copyoutstr(const void *kaddr, user_addr_t udaddr, size_t len, size_t *done); 177int copyin(const user_addr_t uaddr, void *kaddr, size_t len); 178int copyout(const void *kaddr, user_addr_t udaddr, size_t len); 179 180int vsscanf(const char *, char const *, va_list); 181 182extern int vprintf(const char *, va_list); 183extern int vsnprintf(char *, size_t, const char *, va_list); 184 185/* vsprintf() is being deprecated. Please use vsnprintf() instead. */ 186extern int vsprintf(char *bufp, const char *, va_list) __deprecated; 187 188#ifdef KERNEL_PRIVATE 189extern void invalidate_icache(vm_offset_t, unsigned, int); 190extern void flush_dcache(vm_offset_t, unsigned, int); 191#else 192extern void invalidate_icache(vm_offset_t, unsigned, int); 193extern void flush_dcache(vm_offset_t, unsigned, int); 194#endif 195extern void invalidate_icache64(addr64_t, unsigned, int); 196extern void flush_dcache64(addr64_t, unsigned, int); 197 198 199/* 200 * assembly versions of clz... ideally we would just call 201 * __builtin_clz(num), unfortunately this one is ill defined 202 * by gcc for num=0 203 */ 204static __inline__ unsigned int 205clz(unsigned int num) 206{ 207#if __i386__ 208 unsigned int result; 209 __asm__ volatile( 210 "bsrl %1, %0\n\t" 211 "cmovel %2, %0" 212 : "=r" (result) 213 : "rm" (num), "r" (63) 214 ); 215 return 31 ^ result; 216 217#else 218 return num?__builtin_clz(num):__builtin_clz(0); 219#endif 220} 221 222 223__END_DECLS 224 225#endif /* _LIBKERN_LIBKERN_H_ */ 226