[apple/xnu.git] / osfmk / kern / misc_protos.h

/*
 * Copyright (c) 2000-2016 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@
 */
/*
 * @OSF_COPYRIGHT@
 */
/*
 * NOTICE: This file was modified by McAfee Research in 2004 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	_MISC_PROTOS_H_
#define	_MISC_PROTOS_H_

#include <stdarg.h>
#include <string.h>
#include <machine/setjmp.h>
#include <mach/boolean.h>
#include <mach/message.h>
#include <mach/machine/vm_types.h>
#include <ipc/ipc_types.h>
#include <kern/debug.h>

#ifndef MIN
#define MIN(a,b) (((a)<(b))?(a):(b))
#endif /* MIN */
#ifndef MAX
#define MAX(a,b) (((a)>(b))?(a):(b))
#endif  /* MAX */

/* Set a bit in a bit array */
extern void setbit(
	int		which,
	int		*bitmap);

/* Clear a bit in a bit array */
extern void clrbit(
	int		which,
	int		*bitmap);

/* Find the first set bit in a bit array */
extern int ffsbit(
	int		*bitmap);
extern int ffs(
	unsigned int	mask);
extern int ffsll(
	unsigned long long mask);

/* Find the last set bit in a bit array */
extern int fls(
	unsigned int	mask);
extern int flsll(
	unsigned long long mask);

/*
 * Test if indicated bit is set in bit string.
 */
extern int testbit(
	int		which,
	int		*bitmap);

/* Move arbitrarily-aligned data from a user space to kernel space */
extern int copyin(
	const user_addr_t   user_addr,
	char                *kernel_addr,
	vm_size_t           nbytes);

/* Move an aligned 32 or 64-bit word from user space to kernel space
 * using a single read instruction
 *
 * when reading a 32-bit word, the value is 0-extended into the kernel space
 * 64-bit buffer passed as `kernel_addr`
 * (think `*kernel_addr = *(uint32_t *)user_addr`)
 */
extern int copyin_word(
	const user_addr_t   user_addr,
	uint64_t            *kernel_addr,
	vm_size_t           nbytes);

/* Move a NUL-terminated string from a user space to kernel space */
extern int copyinstr(
	const user_addr_t   user_addr,
	char                *kernel_addr,
	vm_size_t           max,
	vm_size_t           *actual);

/* Move arbitrarily-aligned data from a user space to kernel space */
extern int copyinmsg(
	const user_addr_t   user_addr,
	char                *kernel_addr,
	mach_msg_size_t     nbytes);

/* Move arbitrarily-aligned data from a kernel space to user space */
extern int copyout(
	const void      *kernel_addr,
	user_addr_t     user_addr,
	vm_size_t       nbytes);

/* Move arbitrarily-aligned data from a kernel space to user space */
extern int copyoutmsg(
	const char      *kernel_addr,
	user_addr_t     user_addr,
	mach_msg_size_t nbytes);

/* Invalidate copy window(s) cache */
extern void inval_copy_windows(thread_t);
extern void copy_window_fault(thread_t, vm_map_t, int);

extern int copyin_validate(const user_addr_t, uintptr_t, vm_size_t);
extern int copyout_validate(uintptr_t, const user_addr_t, vm_size_t);

extern int sscanf(const char *input, const char *fmt, ...) __scanflike(2,3);

/* sprintf() is being deprecated. Please use snprintf() instead. */ 
extern integer_t sprintf(char *buf, const char *fmt, ...) __deprecated;

extern int printf(const char *format, ...) __printflike(1,2);
extern int vprintf(const char *format, va_list ap);

#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

extern int paniclog_append_noflush(const char *format, ...) __printflike(1,2);

extern int kdb_printf(const char *format, ...) __printflike(1,2);

extern int kdb_log(const char *format, ...) __printflike(1,2);

extern int kdb_printf_unbuffered(const char *format, ...) __printflike(1,2);

extern void printf_init(void);

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

extern void log(int level, char *fmt, ...);

void 
_doprnt(
	const char	*fmt,
	va_list			*argp,
	void			(*putc)(char),
	int			radix);

void
_doprnt_log(
	const char	*fmt,
	va_list			*argp,
	void			(*putc)(char),
	int			radix);

int
__doprnt(
	const char	*fmt,
	va_list			argp,
	void			(*putc)(int, void *),
	void                    *arg,
	int			radix,
	int			is_log);

extern void safe_gets(
	char	*str,
	int	maxlen);

extern void cnputcusr(char);

extern void cnputsusr(char *, int);

extern void conslog_putc(char);

extern void cons_putc_locked(char);

extern void consdebug_putc(char);

extern void consdebug_log(char);

extern void consdebug_putc_unbuffered(char);

extern void cnputc(char);

extern void cnputc_unbuffered(char);

extern void console_write(char *, int);

extern void console_suspend(void);

extern void console_resume(void);

extern int cngetc(void);

extern int cnmaygetc(void);

extern int _setjmp(
	jmp_buf_t	*jmp_buf);

extern int _longjmp(
	jmp_buf_t	*jmp_buf,
	int		value);

extern void bootstrap_create(void);

#if	DIPC
extern boolean_t	no_bootstrap_task(void);
extern ipc_port_t	get_root_master_device_port(void);
#endif	/* DIPC */

extern kern_return_t	kernel_set_special_port(
		host_priv_t	host_priv,
		int 		which,
		ipc_port_t	port);

extern kern_return_t	kernel_get_special_port(
		host_priv_t	host_priv,
		int 		which,
		ipc_port_t	*portp);

user_addr_t get_useraddr(void);

/* symbol lookup */
struct kmod_info_t;

extern uint64_t early_random(void);

#endif	/* _MISC_PROTOS_H_ */
Commit	Line	Data
1c79356b	1	/*
5ba3f43e	2	* Copyright (c) 2000-2016 Apple Inc. All rights reserved.
1c79356b	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	* @OSF_COPYRIGHT@
	30	*/
2d21ac55 A	31	/*
	32	* NOTICE: This file was modified by McAfee Research in 2004 to introduce
	33	* support for mandatory and extensible security protections. This notice
	34	* is included in support of clause 2.2 (b) of the Apple Public License,
	35	* Version 2.0.
	36	*/
1c79356b A	37
	38	#ifndef _MISC_PROTOS_H_
	39	#define _MISC_PROTOS_H_
	40
	41	#include <stdarg.h>
	42	#include <string.h>
	43	#include <machine/setjmp.h>
	44	#include <mach/boolean.h>
	45	#include <mach/message.h>
	46	#include <mach/machine/vm_types.h>
	47	#include <ipc/ipc_types.h>
91447636	48	#include <kern/debug.h>
1c79356b	49
2d21ac55 A	50	#ifndef MIN
	51	#define MIN(a,b) (((a)<(b))?(a):(b))
	52	#endif /* MIN */
	53	#ifndef MAX
	54	#define MAX(a,b) (((a)>(b))?(a):(b))
	55	#endif /* MAX */
	56
1c79356b A	57	/* Set a bit in a bit array */
	58	extern void setbit(
	59	int which,
	60	int *bitmap);
	61
	62	/* Clear a bit in a bit array */
	63	extern void clrbit(
	64	int which,
	65	int *bitmap);
	66
	67	/* Find the first set bit in a bit array */
	68	extern int ffsbit(
	69	int *bitmap);
	70	extern int ffs(
	71	unsigned int mask);
5ba3f43e A	72	extern int ffsll(
	73	unsigned long long mask);
	74
	75	/* Find the last set bit in a bit array */
	76	extern int fls(
	77	unsigned int mask);
	78	extern int flsll(
	79	unsigned long long mask);
1c79356b A	80
	81	/*
	82	* Test if indicated bit is set in bit string.
	83	*/
	84	extern int testbit(
	85	int which,
	86	int *bitmap);
	87
1c79356b	88	/* Move arbitrarily-aligned data from a user space to kernel space */
91447636 A	89	extern int copyin(
	90	const user_addr_t user_addr,
	91	char *kernel_addr,
	92	vm_size_t nbytes);
1c79356b	93
39037602 A	94	/* Move an aligned 32 or 64-bit word from user space to kernel space
	95	* using a single read instruction
	96	*
	97	* when reading a 32-bit word, the value is 0-extended into the kernel space
	98	* 64-bit buffer passed as `kernel_addr`
	99	* (think `kernel_addr = (uint32_t *)user_addr`)
	100	*/
	101	extern int copyin_word(
	102	const user_addr_t user_addr,
	103	uint64_t *kernel_addr,
	104	vm_size_t nbytes);
	105
1c79356b	106	/* Move a NUL-terminated string from a user space to kernel space */
91447636 A	107	extern int copyinstr(
	108	const user_addr_t user_addr,
	109	char *kernel_addr,
	110	vm_size_t max,
	111	vm_size_t *actual);
1c79356b A	112
1c79356b A	113	/* Move arbitrarily-aligned data from a user space to kernel space */
91447636 A	114	extern int copyinmsg(
	115	const user_addr_t user_addr,
	116	char *kernel_addr,
	117	mach_msg_size_t nbytes);
1c79356b A	118
1c79356b A	119	/* Move arbitrarily-aligned data from a kernel space to user space */
91447636	120	extern int copyout(
2d21ac55	121	const void *kernel_addr,
91447636 A	122	user_addr_t user_addr,
91447636 A	123	vm_size_t nbytes);
1c79356b A	124
1c79356b A	125	/* Move arbitrarily-aligned data from a kernel space to user space */
91447636 A	126	extern int copyoutmsg(
	127	const char *kernel_addr,
	128	user_addr_t user_addr,
1c79356b A	129	mach_msg_size_t nbytes);
1c79356b A	130
0c530ab8	131	/* Invalidate copy window(s) cache */
6d2010ae A	132	extern void inval_copy_windows(thread_t);
6d2010ae A	133	extern void copy_window_fault(thread_t, vm_map_t, int);
0c530ab8	134
316670eb A	135	extern int copyin_validate(const user_addr_t, uintptr_t, vm_size_t);
	136	extern int copyout_validate(uintptr_t, const user_addr_t, vm_size_t);
	137
2d21ac55	138	extern int sscanf(const char input, const char fmt, ...) __scanflike(2,3);
0c530ab8	139
2d21ac55 A	140	/* sprintf() is being deprecated. Please use snprintf() instead. */
2d21ac55 A	141	extern integer_t sprintf(char buf, const char fmt, ...) __deprecated;
1c79356b	142
2d21ac55	143	extern int printf(const char *format, ...) __printflike(1,2);
39037602	144	extern int vprintf(const char *format, va_list ap);
1c79356b	145
b0d623f7 A	146	#if KERNEL_PRIVATE
	147	int _consume_printf_args(int, ...);
	148	#endif
	149
	150	#if CONFIG_NO_PRINTF_STRINGS
	151	#if KERNEL_PRIVATE
	152	#define printf(x, ...) _consume_printf_args( 0, ## __VA_ARGS__ )
	153	#else
	154	#define printf(x, ...) do {} while (0)
	155	#endif
	156	#endif
	157
5ba3f43e A	158	extern int paniclog_append_noflush(const char *format, ...) __printflike(1,2);
5ba3f43e A	159
2d21ac55	160	extern int kdb_printf(const char *format, ...) __printflike(1,2);
9bccf70c	161
c910b4d9 A	162	extern int kdb_log(const char *format, ...) __printflike(1,2);
c910b4d9 A	163
b0d623f7 A	164	extern int kdb_printf_unbuffered(const char *format, ...) __printflike(1,2);
b0d623f7 A	165
1c79356b A	166	extern void printf_init(void);
1c79356b A	167
593a1d5f A	168	extern int snprintf(char , size_t, const char , ...) __printflike(3,4);
593a1d5f A	169
1c79356b A	170	extern void log(int level, char *fmt, ...);
	171
	172	void
	173	_doprnt(
39037602	174	const char *fmt,
1c79356b A	175	va_list *argp,
	176	void (*putc)(char),
	177	int radix);
3e170ce0 A	178
	179	void
	180	_doprnt_log(
39037602	181	const char *fmt,
3e170ce0 A	182	va_list *argp,
	183	void (*putc)(char),
	184	int radix);
	185
9bccf70c A	186	int
9bccf70c A	187	__doprnt(
39037602	188	const char *fmt,
b0d623f7	189	va_list argp,
9bccf70c A	190	void (putc)(int, void ),
9bccf70c A	191	void *arg,
3e170ce0 A	192	int radix,
3e170ce0 A	193	int is_log);
1c79356b A	194
	195	extern void safe_gets(
	196	char *str,
	197	int maxlen);
	198
	199	extern void cnputcusr(char);
	200
5ba3f43e A	201	extern void cnputsusr(char *, int);
5ba3f43e A	202
9bccf70c A	203	extern void conslog_putc(char);
9bccf70c A	204
6d2010ae A	205	extern void cons_putc_locked(char);
6d2010ae A	206
9bccf70c A	207	extern void consdebug_putc(char);
9bccf70c A	208
c910b4d9 A	209	extern void consdebug_log(char);
c910b4d9 A	210
b0d623f7 A	211	extern void consdebug_putc_unbuffered(char);
b0d623f7 A	212
1c79356b A	213	extern void cnputc(char);
1c79356b A	214
b0d623f7 A	215	extern void cnputc_unbuffered(char);
b0d623f7 A	216
39037602 A	217	extern void console_write(char *, int);
	218
	219	extern void console_suspend(void);
	220
	221	extern void console_resume(void);
	222
1c79356b A	223	extern int cngetc(void);
	224
	225	extern int cnmaygetc(void);
	226
	227	extern int _setjmp(
	228	jmp_buf_t *jmp_buf);
	229
	230	extern int _longjmp(
	231	jmp_buf_t *jmp_buf,
	232	int value);
	233
	234	extern void bootstrap_create(void);
	235
1c79356b A	236	#if DIPC
	237	extern boolean_t no_bootstrap_task(void);
	238	extern ipc_port_t get_root_master_device_port(void);
	239	#endif /* DIPC */
	240
55e303ae A	241	extern kern_return_t kernel_set_special_port(
	242	host_priv_t host_priv,
	243	int which,
	244	ipc_port_t port);
	245
39037602 A	246	extern kern_return_t kernel_get_special_port(
	247	host_priv_t host_priv,
	248	int which,
	249	ipc_port_t *portp);
	250
2d21ac55 A	251	user_addr_t get_useraddr(void);
	252
	253	/* symbol lookup */
	254	struct kmod_info_t;
	255
316670eb A	256	extern uint64_t early_random(void);
316670eb A	257
1c79356b	258	#endif /* _MISC_PROTOS_H_ */