[apple/xnu.git] / bsd / libkern / libkern.h

/*
 * Copyright (c) 2000-2012 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*-
 * Copyright (c) 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)libkern.h	8.1 (Berkeley) 6/10/93
 */
/*
 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
 * support for mandatory and extensible security protections.  This notice
 * is included in support of clause 2.2 (b) of the Apple Public License,
 * Version 2.0.
 */

#ifndef _LIBKERN_LIBKERN_H_
#define _LIBKERN_LIBKERN_H_

#include <sys/appleapiopts.h>
#include <stdint.h>
#include <stdarg.h>	/* for platform-specific va_list */
#include <string.h>
#include <machine/limits.h>
#include <sys/cdefs.h>
#include <sys/types.h>
#include <mach/vm_param.h>


#ifdef __APPLE_API_OBSOLETE
/* BCD conversions. */
extern u_char const	bcd2bin_data[];
extern u_char const	bin2bcd_data[];

#define	bcd2bin(bcd)	(bcd2bin_data[bcd])
#define	bin2bcd(bin)	(bin2bcd_data[bin])
#endif /* __APPLE_API_OBSOLETE */

#ifdef __APPLE_API_PRIVATE
extern char const	hex2ascii_data[];

#define	hex2ascii(hex)	(hex2ascii_data[hex])
#endif /* __APPLE_API_PRIVATE */

__BEGIN_DECLS
static inline int
imax(int a, int b)
{
	return (a > b ? a : b);
}
static inline int
imin(int a, int b)
{
	return (a < b ? a : b);
}
static inline long
lmax(long a, long b)
{
	return (a > b ? a : b);
}
static inline long
lmin(long a, long b)
{
	return (a < b ? a : b);
}
static inline u_int
max(u_int a, u_int b)
{
	return (a > b ? a : b);
}
static inline u_int
min(u_int a, u_int b)
{
	return (a < b ? a : b);
}
static inline u_int32_t
ulmax(u_int32_t a, u_int32_t b)
{
	return (a > b ? a : b);
}
static inline u_int32_t
ulmin(u_int32_t a, u_int32_t b)
{
	return (a < b ? a : b);
}


/* Prototypes for non-quad routines. */
extern int	ffs(int);
extern u_int32_t	random(void);
extern int	scanc(u_int, u_char *, const u_char *, int);
extern int	skpc(int, int, char *);
extern long	strtol(const char*, char **, int);
extern u_long	strtoul(const char *, char **, int);
extern quad_t	strtoq(const char *, char **, int);
extern u_quad_t strtouq(const char *, char **, int);
extern char	*strsep(char **, const char *);
extern void	*memchr(const void *, int, size_t);
extern void	url_decode(char *str);

int	snprintf(char *, size_t, const char *, ...) __printflike(3,4);

/* sprintf() is being deprecated. Please use snprintf() instead. */
int	sprintf(char *bufp, const char *, ...) __deprecated;
int	sscanf(const char *, char const *, ...) __scanflike(2,3);
int	printf(const char *, ...) __printflike(1,2);

#if KERNEL_PRIVATE
int	_consume_printf_args(int, ...);
#endif

#if CONFIG_NO_PRINTF_STRINGS
#if KERNEL_PRIVATE
#define printf(x, ...)  _consume_printf_args( 0, ## __VA_ARGS__ )
#else
#define printf(x, ...)  do {} while (0)
#endif
#endif

uint16_t	crc16(uint16_t crc, const void *bufp, size_t len);
uint32_t	crc32(uint32_t crc, const void *bufp, size_t len);

int	copystr(const void *kfaddr, void *kdaddr, size_t len, size_t *done);
int	copyinstr(const user_addr_t uaddr, void *kaddr, size_t len, size_t *done);
int	copyoutstr(const void *kaddr, user_addr_t udaddr, size_t len, size_t *done);
int	copyin(const user_addr_t uaddr, void *kaddr, size_t len);
int	copyout(const void *kaddr, user_addr_t udaddr, size_t len);
#if XNU_KERNEL_PRIVATE
extern int copyin_word(const user_addr_t user_addr, uint64_t *kernel_addr, vm_size_t nbytes);
#endif

int vsscanf(const char *, char const *, va_list);

extern int	vprintf(const char *, va_list);
extern int	vsnprintf(char *, size_t, const char *, va_list);

#if XNU_KERNEL_PRIVATE
extern int	vprintf_log_locked(const char *, va_list);
extern void	osobject_retain(void * object);
extern void	osobject_release(void * object);
#endif

/* vsprintf() is being deprecated. Please use vsnprintf() instead. */
extern int	vsprintf(char *bufp, const char *, va_list) __deprecated;

#ifdef KERNEL_PRIVATE
extern void invalidate_icache(vm_offset_t, unsigned, int);
extern void flush_dcache(vm_offset_t, unsigned, int);
#else
extern void invalidate_icache(vm_offset_t, unsigned, int);
extern void flush_dcache(vm_offset_t, unsigned, int);
#endif
extern void invalidate_icache64(addr64_t, unsigned, int);
extern void flush_dcache64(addr64_t, unsigned, int);


static inline int
clz(unsigned int num)
{
	// On Intel, clz(0) is undefined
	return num ? __builtin_clz(num) : sizeof(num) * CHAR_BIT;
}

__END_DECLS

#endif /* _LIBKERN_LIBKERN_H_ */
Commit	Line	Data
1c79356b	1	/*
39236c6e	2	* Copyright (c) 2000-2012 Apple Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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	*/
2d21ac55 A	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	*/
1c79356b A	68
	69	#ifndef _LIBKERN_LIBKERN_H_
	70	#define _LIBKERN_LIBKERN_H_
	71
9bccf70c	72	#include <sys/appleapiopts.h>
91447636	73	#include <stdint.h>
2d21ac55	74	#include <stdarg.h> /* for platform-specific va_list */
91447636	75	#include <string.h>
39037602	76	#include <machine/limits.h>
1c79356b A	77	#include <sys/cdefs.h>
1c79356b A	78	#include <sys/types.h>
91447636	79	#include <mach/vm_param.h>
1c79356b	80
316670eb	81
9bccf70c	82	#ifdef __APPLE_API_OBSOLETE
1c79356b A	83	/* BCD conversions. */
	84	extern u_char const bcd2bin_data[];
	85	extern u_char const bin2bcd_data[];
1c79356b A	86
	87	#define bcd2bin(bcd) (bcd2bin_data[bcd])
	88	#define bin2bcd(bin) (bin2bcd_data[bin])
9bccf70c	89	#endif /* __APPLE_API_OBSOLETE */
1c79356b	90
9bccf70c A	91	#ifdef __APPLE_API_PRIVATE
	92	extern char const hex2ascii_data[];
	93
	94	#define hex2ascii(hex) (hex2ascii_data[hex])
	95	#endif /* __APPLE_API_PRIVATE */
1c79356b A	96
	97	__BEGIN_DECLS
	98	static inline int
	99	imax(int a, int b)
	100	{
	101	return (a > b ? a : b);
	102	}
	103	static inline int
	104	imin(int a, int b)
	105	{
	106	return (a < b ? a : b);
	107	}
	108	static inline long
	109	lmax(long a, long b)
	110	{
	111	return (a > b ? a : b);
	112	}
	113	static inline long
	114	lmin(long a, long b)
	115	{
	116	return (a < b ? a : b);
	117	}
	118	static inline u_int
	119	max(u_int a, u_int b)
	120	{
	121	return (a > b ? a : b);
	122	}
	123	static inline u_int
	124	min(u_int a, u_int b)
	125	{
	126	return (a < b ? a : b);
	127	}
b0d623f7 A	128	static inline u_int32_t
b0d623f7 A	129	ulmax(u_int32_t a, u_int32_t b)
1c79356b A	130	{
	131	return (a > b ? a : b);
	132	}
b0d623f7 A	133	static inline u_int32_t
b0d623f7 A	134	ulmin(u_int32_t a, u_int32_t b)
1c79356b A	135	{
	136	return (a < b ? a : b);
	137	}
	138
2d21ac55 A	139
2d21ac55 A	140
1c79356b	141	/* Prototypes for non-quad routines. */
91447636	142	extern int ffs(int);
b0d623f7	143	extern u_int32_t random(void);
91447636 A	144	extern int scanc(u_int, u_char , const u_char , int);
	145	extern int skpc(int, int, char *);
	146	extern long strtol(const char, char *, int);
	147	extern u_long strtoul(const char , char *, int);
	148	extern quad_t strtoq(const char , char *, int);
	149	extern u_quad_t strtouq(const char , char *, int);
39236c6e A	150	extern char strsep(char , const char );
39236c6e A	151	extern void memchr(const void , int, size_t);
00867663	152	extern void url_decode(char *str);
91447636	153
2d21ac55 A	154	int snprintf(char , size_t, const char , ...) __printflike(3,4);
	155
	156	/* sprintf() is being deprecated. Please use snprintf() instead. */
	157	int sprintf(char bufp, const char , ...) __deprecated;
	158	int sscanf(const char , char const , ...) __scanflike(2,3);
	159	int printf(const char *, ...) __printflike(1,2);
	160
b0d623f7 A	161	#if KERNEL_PRIVATE
	162	int _consume_printf_args(int, ...);
	163	#endif
	164
2d21ac55	165	#if CONFIG_NO_PRINTF_STRINGS
b0d623f7 A	166	#if KERNEL_PRIVATE
	167	#define printf(x, ...) _consume_printf_args( 0, ## __VA_ARGS__ )
	168	#else
2d21ac55 A	169	#define printf(x, ...) do {} while (0)
2d21ac55 A	170	#endif
b0d623f7	171	#endif
91447636	172
39037602	173	uint16_t crc16(uint16_t crc, const void *bufp, size_t len);
91447636 A	174	uint32_t crc32(uint32_t crc, const void *bufp, size_t len);
	175
	176	int copystr(const void kfaddr, void kdaddr, size_t len, size_t *done);
	177	int copyinstr(const user_addr_t uaddr, void kaddr, size_t len, size_t done);
	178	int copyoutstr(const void kaddr, user_addr_t udaddr, size_t len, size_t done);
	179	int copyin(const user_addr_t uaddr, void *kaddr, size_t len);
	180	int copyout(const void *kaddr, user_addr_t udaddr, size_t len);
39037602 A	181	#if XNU_KERNEL_PRIVATE
	182	extern int copyin_word(const user_addr_t user_addr, uint64_t *kernel_addr, vm_size_t nbytes);
	183	#endif
91447636	184
2d21ac55 A	185	int vsscanf(const char , char const , va_list);
	186
	187	extern int vprintf(const char *, va_list);
	188	extern int vsnprintf(char , size_t, const char , va_list);
	189
39037602 A	190	#if XNU_KERNEL_PRIVATE
	191	extern int vprintf_log_locked(const char *, va_list);
	192	extern void osobject_retain(void * object);
	193	extern void osobject_release(void * object);
	194	#endif
	195
2d21ac55 A	196	/* vsprintf() is being deprecated. Please use vsnprintf() instead. */
2d21ac55 A	197	extern int vsprintf(char bufp, const char , va_list) __deprecated;
91447636	198
b0d623f7	199	#ifdef KERNEL_PRIVATE
91447636 A	200	extern void invalidate_icache(vm_offset_t, unsigned, int);
91447636 A	201	extern void flush_dcache(vm_offset_t, unsigned, int);
b0d623f7 A	202	#else
	203	extern void invalidate_icache(vm_offset_t, unsigned, int);
	204	extern void flush_dcache(vm_offset_t, unsigned, int);
	205	#endif
91447636 A	206	extern void invalidate_icache64(addr64_t, unsigned, int);
	207	extern void flush_dcache64(addr64_t, unsigned, int);
	208
2d21ac55	209
39037602	210	static inline int
2d21ac55 A	211	clz(unsigned int num)
2d21ac55 A	212	{
39037602 A	213	// On Intel, clz(0) is undefined
39037602 A	214	return num ? __builtin_clz(num) : sizeof(num) * CHAR_BIT;
2d21ac55 A	215	}
2d21ac55 A	216
1c79356b A	217	__END_DECLS
	218
	219	#endif /* _LIBKERN_LIBKERN_H_ */