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

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */

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

/* 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);

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

/* Move arbitrarily-aligned data from one array to another */
extern void bcopy(
	const char	*from,
	char		*to,
	vm_size_t	nbytes);

/* Move overlapping, arbitrarily aligned data from one array to another */
/* Not present on all ports */
extern void ovbcopy(
	const char	*from,
	char		*to,
	vm_size_t	nbytes);

extern int bcmp(
		const char *a,
		const char *b,
		vm_size_t len);

/* Zero an arbitrarily aligned array */
extern void bzero(
	char	*from,
	vm_size_t	nbytes);

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

/* Move a NUL-terminated string from a user space to kernel space */
extern boolean_t copyinstr(
	const char	*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 boolean_t copyinmsg(
	const char	*user_addr,
	char		*kernel_addr,
	mach_msg_size_t nbytes);

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

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

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

extern integer_t sprintf(char *buf, const char *fmt, ...);

extern void printf(const char *format, ...);

extern void dbugprintf(const char *format, ...);

extern void kdp_printf(const char *format, ...);

extern void printf_init(void);

extern void panic(const char *string, ...);

extern void panic_init(void);

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

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

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

extern void cnputcusr(char);

extern void conslog_putc(char);

extern void consdebug_putc(char);

extern void cnputc(char);

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);

extern void halt_cpu(void);

extern void halt_all_cpus(
		boolean_t	reboot);

extern void Debugger(
		const char	* message);

extern void delay(
		int		n);

extern char *machine_boot_info(
		char		*buf,
		vm_size_t	buf_len);

/*
 * Machine-dependent routine to fill in an array with up to callstack_max
 * levels of return pc information.
 */
extern void machine_callstack(
		natural_t	*buf,
		vm_size_t	callstack_max);

extern void consider_machine_collect(void);

extern void norma_bootstrap(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);

#endif	/* _MISC_PROTOS_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
e5568f75 A	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.
1c79356b	11	*
e5568f75 A	12	* This Original Code and all software distributed under the License are
e5568f75 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
e5568f75 A	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.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	* @OSF_COPYRIGHT@
	24	*/
	25
	26	#ifndef _MISC_PROTOS_H_
	27	#define _MISC_PROTOS_H_
	28
	29	#include <stdarg.h>
	30	#include <string.h>
	31	#include <machine/setjmp.h>
	32	#include <mach/boolean.h>
	33	#include <mach/message.h>
	34	#include <mach/machine/vm_types.h>
	35	#include <ipc/ipc_types.h>
	36
	37	/* Set a bit in a bit array */
	38	extern void setbit(
	39	int which,
	40	int *bitmap);
	41
	42	/* Clear a bit in a bit array */
	43	extern void clrbit(
	44	int which,
	45	int *bitmap);
	46
	47	/* Find the first set bit in a bit array */
	48	extern int ffsbit(
	49	int *bitmap);
	50	extern int ffs(
	51	unsigned int mask);
	52
	53	/*
	54	* Test if indicated bit is set in bit string.
	55	*/
	56	extern int testbit(
	57	int which,
	58	int *bitmap);
	59
	60	/* Move arbitrarily-aligned data from one array to another */
	61	extern void bcopy(
	62	const char *from,
	63	char *to,
	64	vm_size_t nbytes);
	65
	66	/* Move overlapping, arbitrarily aligned data from one array to another */
	67	/* Not present on all ports */
	68	extern void ovbcopy(
	69	const char *from,
	70	char *to,
	71	vm_size_t nbytes);
	72
	73	extern int bcmp(
	74	const char *a,
	75	const char *b,
	76	vm_size_t len);
	77
	78	/* Zero an arbitrarily aligned array */
	79	extern void bzero(
	80	char *from,
	81	vm_size_t nbytes);
	82
83	/* Move arbitrarily-aligned data from a user space to kernel space */
84	extern boolean_t copyin(
85	const char *user_addr,
86	char *kernel_addr,
87	vm_size_t nbytes);
88
89	/* Move a NUL-terminated string from a user space to kernel space */
90	extern boolean_t copyinstr(
91	const char *user_addr,
92	char *kernel_addr,
93	vm_size_t max,
94	vm_size_t *actual);
95
96	/* Move arbitrarily-aligned data from a user space to kernel space */
97	extern boolean_t copyinmsg(
98	const char *user_addr,
99	char *kernel_addr,
100	mach_msg_size_t nbytes);
101
102	/* Move arbitrarily-aligned data from a kernel space to user space */
103	extern boolean_t copyout(
104	const char *kernel_addr,
105	char *user_addr,
106	vm_size_t nbytes);
107
108	/* Move arbitrarily-aligned data from a kernel space to user space */
109	extern boolean_t copyoutmsg(
110	const char *kernel_addr,
111	char *user_addr,
112	mach_msg_size_t nbytes);
113
114	extern int sscanf(const char input, const char fmt, ...);
115
116	extern integer_t sprintf(char buf, const char fmt, ...);
117
118	extern void printf(const char *format, ...);
119
55e303ae A	120	extern void dbugprintf(const char *format, ...);
55e303ae A	121
9bccf70c A	122	extern void kdp_printf(const char *format, ...);
9bccf70c A	123
1c79356b A	124	extern void printf_init(void);
	125
	126	extern void panic(const char *string, ...);
	127
	128	extern void panic_init(void);
	129
	130	extern void log(int level, char *fmt, ...);
	131
	132	void
	133	_doprnt(
	134	register const char *fmt,
	135	va_list *argp,
	136	void (*putc)(char),
	137	int radix);
9bccf70c A	138	int
	139	__doprnt(
	140	register const char *fmt,
	141	va_list *argp,
	142	void (putc)(int, void ),
	143	void *arg,
	144	int radix);
1c79356b A	145
	146	extern void safe_gets(
	147	char *str,
	148	int maxlen);
	149
	150	extern void cnputcusr(char);
	151
9bccf70c A	152	extern void conslog_putc(char);
	153
	154	extern void consdebug_putc(char);
	155
1c79356b A	156	extern void cnputc(char);
	157
	158	extern int cngetc(void);
	159
	160	extern int cnmaygetc(void);
	161
	162	extern int _setjmp(
	163	jmp_buf_t *jmp_buf);
	164
	165	extern int _longjmp(
	166	jmp_buf_t *jmp_buf,
	167	int value);
	168
	169	extern void bootstrap_create(void);
	170
	171	extern void halt_cpu(void);
	172
	173	extern void halt_all_cpus(
	174	boolean_t reboot);
	175
	176	extern void Debugger(
	177	const char * message);
	178
	179	extern void delay(
	180	int n);
	181
	182	extern char *machine_boot_info(
	183	char *buf,
	184	vm_size_t buf_len);
	185
	186	/*
	187	* Machine-dependent routine to fill in an array with up to callstack_max
	188	* levels of return pc information.
	189	*/
	190	extern void machine_callstack(
	191	natural_t *buf,
	192	vm_size_t callstack_max);
	193
	194	extern void consider_machine_collect(void);
	195
	196	extern void norma_bootstrap(void);
	197
	198	#if DIPC
	199	extern boolean_t no_bootstrap_task(void);
	200	extern ipc_port_t get_root_master_device_port(void);
	201	#endif /* DIPC */
	202
55e303ae A	203	extern kern_return_t kernel_set_special_port(
	204	host_priv_t host_priv,
	205	int which,
	206	ipc_port_t port);
	207
1c79356b	208	#endif /* _MISC_PROTOS_H_ */