[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>

#if defined(__arm__) || defined(__arm64__)
#include <arm/arch.h> /* for _ARM_ARCH_* */
#endif

#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 int	ffsll(unsigned long long);
extern int	fls(int);
extern int	flsll(unsigned long long);
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 __printflike(2,3);
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) __printflike(1,0);
extern int	vsnprintf(char *, size_t, const char *, va_list) __printflike(3,0);

#if XNU_KERNEL_PRIVATE
extern int	vprintf_log_locked(const char *, va_list) __printflike(1,0);
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 __printflike(2,0);

#ifdef KERNEL_PRIVATE
#ifdef __arm__
void flush_inner_dcaches(void);
void clean_inner_dcaches(void);
#endif
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)
{
#if (__arm__ || __arm64__)
	// On ARM, clz(0) is defined to return number of bits in the input type
	return __builtin_clz(num);
#else
	// On Intel, clz(0) is undefined
	return num ? __builtin_clz(num) : sizeof(num) * CHAR_BIT;
#endif
}

__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
5ba3f43e A	81	#if defined(__arm__) \|\| defined(__arm64__)
	82	#include <arm/arch.h> /* for _ARM_ARCH_* */
	83	#endif
316670eb	84
9bccf70c	85	#ifdef __APPLE_API_OBSOLETE
1c79356b A	86	/* BCD conversions. */
	87	extern u_char const bcd2bin_data[];
	88	extern u_char const bin2bcd_data[];
1c79356b A	89
	90	#define bcd2bin(bcd) (bcd2bin_data[bcd])
	91	#define bin2bcd(bin) (bin2bcd_data[bin])
9bccf70c	92	#endif /* __APPLE_API_OBSOLETE */
1c79356b	93
9bccf70c A	94	#ifdef __APPLE_API_PRIVATE
	95	extern char const hex2ascii_data[];
	96
	97	#define hex2ascii(hex) (hex2ascii_data[hex])
	98	#endif /* __APPLE_API_PRIVATE */
1c79356b A	99
	100	__BEGIN_DECLS
	101	static inline int
	102	imax(int a, int b)
	103	{
	104	return (a > b ? a : b);
	105	}
	106	static inline int
	107	imin(int a, int b)
	108	{
	109	return (a < b ? a : b);
	110	}
	111	static inline long
	112	lmax(long a, long b)
	113	{
	114	return (a > b ? a : b);
	115	}
	116	static inline long
	117	lmin(long a, long b)
	118	{
	119	return (a < b ? a : b);
	120	}
	121	static inline u_int
	122	max(u_int a, u_int b)
	123	{
	124	return (a > b ? a : b);
	125	}
	126	static inline u_int
	127	min(u_int a, u_int b)
	128	{
	129	return (a < b ? a : b);
	130	}
b0d623f7 A	131	static inline u_int32_t
b0d623f7 A	132	ulmax(u_int32_t a, u_int32_t b)
1c79356b A	133	{
	134	return (a > b ? a : b);
	135	}
b0d623f7 A	136	static inline u_int32_t
b0d623f7 A	137	ulmin(u_int32_t a, u_int32_t b)
1c79356b A	138	{
	139	return (a < b ? a : b);
	140	}
	141
2d21ac55 A	142
2d21ac55 A	143
1c79356b	144	/* Prototypes for non-quad routines. */
91447636	145	extern int ffs(int);
5ba3f43e A	146	extern int ffsll(unsigned long long);
	147	extern int fls(int);
	148	extern int flsll(unsigned long long);
b0d623f7	149	extern u_int32_t random(void);
91447636 A	150	extern int scanc(u_int, u_char , const u_char , int);
	151	extern int skpc(int, int, char *);
	152	extern long strtol(const char, char *, int);
	153	extern u_long strtoul(const char , char *, int);
	154	extern quad_t strtoq(const char , char *, int);
	155	extern u_quad_t strtouq(const char , char *, int);
39236c6e A	156	extern char strsep(char , const char );
39236c6e A	157	extern void memchr(const void , int, size_t);
00867663	158	extern void url_decode(char *str);
91447636	159
2d21ac55 A	160	int snprintf(char , size_t, const char , ...) __printflike(3,4);
	161
	162	/* sprintf() is being deprecated. Please use snprintf() instead. */
5ba3f43e	163	int sprintf(char bufp, const char , ...) __deprecated __printflike(2,3);
2d21ac55 A	164	int sscanf(const char , char const , ...) __scanflike(2,3);
	165	int printf(const char *, ...) __printflike(1,2);
	166
b0d623f7 A	167	#if KERNEL_PRIVATE
	168	int _consume_printf_args(int, ...);
	169	#endif
	170
2d21ac55	171	#if CONFIG_NO_PRINTF_STRINGS
b0d623f7 A	172	#if KERNEL_PRIVATE
	173	#define printf(x, ...) _consume_printf_args( 0, ## __VA_ARGS__ )
	174	#else
2d21ac55 A	175	#define printf(x, ...) do {} while (0)
2d21ac55 A	176	#endif
b0d623f7	177	#endif
91447636	178
39037602	179	uint16_t crc16(uint16_t crc, const void *bufp, size_t len);
91447636 A	180	uint32_t crc32(uint32_t crc, const void *bufp, size_t len);
	181
	182	int copystr(const void kfaddr, void kdaddr, size_t len, size_t *done);
	183	int copyinstr(const user_addr_t uaddr, void kaddr, size_t len, size_t done);
	184	int copyoutstr(const void kaddr, user_addr_t udaddr, size_t len, size_t done);
	185	int copyin(const user_addr_t uaddr, void *kaddr, size_t len);
	186	int copyout(const void *kaddr, user_addr_t udaddr, size_t len);
39037602 A	187	#if XNU_KERNEL_PRIVATE
	188	extern int copyin_word(const user_addr_t user_addr, uint64_t *kernel_addr, vm_size_t nbytes);
	189	#endif
91447636	190
2d21ac55 A	191	int vsscanf(const char , char const , va_list);
2d21ac55 A	192
5ba3f43e A	193	extern int vprintf(const char *, va_list) __printflike(1,0);
5ba3f43e A	194	extern int vsnprintf(char , size_t, const char , va_list) __printflike(3,0);
2d21ac55	195
39037602	196	#if XNU_KERNEL_PRIVATE
5ba3f43e	197	extern int vprintf_log_locked(const char *, va_list) __printflike(1,0);
39037602 A	198	extern void osobject_retain(void * object);
	199	extern void osobject_release(void * object);
	200	#endif
	201
2d21ac55	202	/* vsprintf() is being deprecated. Please use vsnprintf() instead. */
5ba3f43e	203	extern int vsprintf(char bufp, const char , va_list) __deprecated __printflike(2,0);
91447636	204
b0d623f7	205	#ifdef KERNEL_PRIVATE
5ba3f43e A	206	#ifdef __arm__
	207	void flush_inner_dcaches(void);
	208	void clean_inner_dcaches(void);
	209	#endif
91447636 A	210	extern void invalidate_icache(vm_offset_t, unsigned, int);
91447636 A	211	extern void flush_dcache(vm_offset_t, unsigned, int);
b0d623f7 A	212	#else
	213	extern void invalidate_icache(vm_offset_t, unsigned, int);
	214	extern void flush_dcache(vm_offset_t, unsigned, int);
	215	#endif
91447636 A	216	extern void invalidate_icache64(addr64_t, unsigned, int);
	217	extern void flush_dcache64(addr64_t, unsigned, int);
	218
2d21ac55	219
39037602	220	static inline int
2d21ac55 A	221	clz(unsigned int num)
2d21ac55 A	222	{
5ba3f43e A	223	#if (__arm__ \|\| __arm64__)
	224	// On ARM, clz(0) is defined to return number of bits in the input type
	225	return __builtin_clz(num);
	226	#else
39037602 A	227	// On Intel, clz(0) is undefined
39037602 A	228	return num ? __builtin_clz(num) : sizeof(num) * CHAR_BIT;
5ba3f43e	229	#endif
2d21ac55 A	230	}
2d21ac55 A	231
1c79356b A	232	__END_DECLS
	233
	234	#endif /* _LIBKERN_LIBKERN_H_ */