[apple/xnu.git] / osfmk / mach / kmod.h

/*
 * Copyright (c) 2000-2007 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@
 */
/*
 * 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	_MACH_KMOD_H_
#define	_MACH_KMOD_H_

#include <mach/kern_return.h>

#include <sys/cdefs.h>

/***********************************************************************
* kmod_control() commands. 1-5 are long-established. 6-8 are new in
* Leopard and used to reliably get and verify symbol information needed
* to link kexts against the running kernel, or to disable kmod loading
* if such symbol information cannot be found.
***********************************************************************/
#define KMOD_CNTL_START		1	// call kmod's start routine
#define KMOD_CNTL_STOP		2	// call kmod's stop routine
#define KMOD_CNTL_RETAIN	3	// increase a kmod's reference count
#define KMOD_CNTL_RELEASE	4	// decrease a kmod's reference count
#define KMOD_CNTL_GET_CMD	5	// get kmod load cmd from kernel

#define KMOD_CNTL_GET_KERNEL_SYMBOLS  6  // get symfile as data buffer
#define KMOD_CNTL_FREE_LINKEDIT_DATA  7  // refuse to create new kmods
#define KMOD_CNTL_GET_KERNEL_UUID     8  // LC_UUID load command payload
#define KMOD_CNTL_GET_UUID            8  // LC_UUID load command payload
#define KMOD_CNTL_DISABLE_LOAD        9  // refuse to create new kmods

#define KMOD_PACK_IDS(from, to)	(((unsigned long)from << 16) | (unsigned long)to)
#define KMOD_UNPACK_FROM_ID(i)	((unsigned long)i >> 16)
#define KMOD_UNPACK_TO_ID(i)	((unsigned long)i & 0xffff)

typedef int kmod_t;
typedef int kmod_control_flavor_t;
typedef void* kmod_args_t;

#define KMOD_MAX_NAME	64

#pragma pack(4)

/* LP64todo - not 64-bit safe */
typedef struct kmod_reference {
	struct kmod_reference	*next;
	struct kmod_info	*info;
} kmod_reference_t;

#pragma pack()

/**************************************************************************************/
/*	 warning any changes to this structure affect the following macros.	      */	
/**************************************************************************************/

#define KMOD_RETURN_SUCCESS	KERN_SUCCESS
#define KMOD_RETURN_FAILURE	KERN_FAILURE

typedef kern_return_t kmod_start_func_t(struct kmod_info *ki, void *data);
typedef kern_return_t kmod_stop_func_t(struct kmod_info *ki, void *data);

#pragma pack(4)

/* LP64todo - not 64-bit safe */

typedef struct kmod_info {
	struct kmod_info 	*next;
	int			info_version;		// version of this structure
	int			id;
	char			name[KMOD_MAX_NAME];
	char			version[KMOD_MAX_NAME];
	int			reference_count;	// # refs to this 
	kmod_reference_t	*reference_list;	// who this refs
	vm_address_t		address;		// starting address
	vm_size_t		size;			// total size
	vm_size_t		hdr_size;		// unwired hdr size
        kmod_start_func_t	*start;
        kmod_stop_func_t	*stop;
} kmod_info_t;

#pragma pack()

typedef kmod_info_t *kmod_info_array_t;

#define KMOD_INFO_NAME 		kmod_info
#define KMOD_INFO_VERSION	1

#define KMOD_DECL(name, version)							\
	static kmod_start_func_t name ## _module_start;					\
	static kmod_stop_func_t  name ## _module_stop;					\
	kmod_info_t KMOD_INFO_NAME = { 0, KMOD_INFO_VERSION, -1,			\
				       { #name }, { version }, -1, 0, 0, 0, 0,		\
			               name ## _module_start,		\
			               name ## _module_stop };

#define KMOD_EXPLICIT_DECL(name, version, start, stop)					\
	kmod_info_t KMOD_INFO_NAME = { 0, KMOD_INFO_VERSION, -1,			\
				       { #name }, { version }, -1, 0, 0, 0, 0,		\
			               start, stop };

// the following is useful for libaries that don't need their own start and stop functions
#define KMOD_LIB_DECL(name, version)							\
	kmod_info_t KMOD_INFO_NAME = { 0, KMOD_INFO_VERSION, -1,			\
				       { #name }, { version }, -1, 0, 0, 0, 0,		\
			               kmod_default_start,				\
				       kmod_default_stop };


// *************************************************************************************
// kmod kernel to user commands
// *************************************************************************************

#define KMOD_LOAD_EXTENSION_PACKET		1
#define KMOD_LOAD_WITH_DEPENDENCIES_PACKET	2

// for generic packets
#define KMOD_IOKIT_START_RANGE_PACKET		0x1000
#define KMOD_IOKIT_END_RANGE_PACKET		0x1fff

typedef struct kmod_load_extension_cmd {
	int	type;
	char	name[KMOD_MAX_NAME];
} kmod_load_extension_cmd_t;

typedef struct kmod_load_with_dependencies_cmd {
	int	type;
	char	name[KMOD_MAX_NAME];
	char	dependencies[1][KMOD_MAX_NAME];
} kmod_load_with_dependencies_cmd_t;

typedef struct kmod_generic_cmd {
	int	type;
	char	data[1];
} kmod_generic_cmd_t;

#ifdef	KERNEL_PRIVATE

extern kmod_info_t *kmod_lookupbyname(const char * name);
extern kmod_info_t *kmod_lookupbyid(kmod_t id);
extern kmod_info_t *kmod_lookupbyaddress(vm_address_t address);
extern int kmod_lookupidbyaddress_locked(vm_address_t address);

extern kmod_info_t *kmod_lookupbyname_locked(const char * name);
extern kmod_info_t *kmod_lookupbyid_locked(kmod_t id);
extern kmod_start_func_t kmod_default_start;
extern kmod_stop_func_t  kmod_default_stop;

__BEGIN_DECLS
extern void kmod_init(void) __attribute__((section("__TEXT, initcode")));

extern kern_return_t kmod_create_fake(const char *name, const char *version);
extern kern_return_t kmod_create_fake_with_address(const char *name, const char *version, 
                                                    vm_address_t address, vm_size_t size,
                                                    int * return_id);
extern kern_return_t kmod_destroy_fake(kmod_t id);

extern kern_return_t kmod_load_extension(char *name);
extern kern_return_t kmod_load_extension_with_dependencies(char *name, char **dependencies);
extern kern_return_t kmod_send_generic(int type, void *data, int size);

extern kern_return_t kmod_initialize_cpp(kmod_info_t *info);
extern kern_return_t kmod_finalize_cpp(kmod_info_t *info);

void record_kext_unload(kmod_t kmod_id);
void dump_kext_info(int (*printf_func)(const char *fmt, ...));

extern void kmod_dump(vm_offset_t *addr, unsigned int dump_cnt);
__END_DECLS

#endif	/* KERNEL_PRIVATE */

#endif	/* _MACH_KMOD_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2007 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 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28	/*
	29	* NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
	30	* support for mandatory and extensible security protections. This notice
	31	* is included in support of clause 2.2 (b) of the Apple Public License,
	32	* Version 2.0.
1c79356b	33	*/
1c79356b A	34
	35	#ifndef _MACH_KMOD_H_
	36	#define _MACH_KMOD_H_
	37
	38	#include <mach/kern_return.h>
	39
91447636	40	#include <sys/cdefs.h>
9bccf70c	41
2d21ac55 A	42	/***********************************************************************
	43	* kmod_control() commands. 1-5 are long-established. 6-8 are new in
	44	* Leopard and used to reliably get and verify symbol information needed
	45	* to link kexts against the running kernel, or to disable kmod loading
	46	* if such symbol information cannot be found.
	47	***********************************************************************/
1c79356b A	48	#define KMOD_CNTL_START 1 // call kmod's start routine
	49	#define KMOD_CNTL_STOP 2 // call kmod's stop routine
	50	#define KMOD_CNTL_RETAIN 3 // increase a kmod's reference count
	51	#define KMOD_CNTL_RELEASE 4 // decrease a kmod's reference count
	52	#define KMOD_CNTL_GET_CMD 5 // get kmod load cmd from kernel
	53
2d21ac55 A	54	#define KMOD_CNTL_GET_KERNEL_SYMBOLS 6 // get symfile as data buffer
	55	#define KMOD_CNTL_FREE_LINKEDIT_DATA 7 // refuse to create new kmods
	56	#define KMOD_CNTL_GET_KERNEL_UUID 8 // LC_UUID load command payload
	57	#define KMOD_CNTL_GET_UUID 8 // LC_UUID load command payload
	58	#define KMOD_CNTL_DISABLE_LOAD 9 // refuse to create new kmods
	59
1c79356b A	60	#define KMOD_PACK_IDS(from, to) (((unsigned long)from << 16) \| (unsigned long)to)
	61	#define KMOD_UNPACK_FROM_ID(i) ((unsigned long)i >> 16)
	62	#define KMOD_UNPACK_TO_ID(i) ((unsigned long)i & 0xffff)
	63
1c79356b A	64	typedef int kmod_t;
	65	typedef int kmod_control_flavor_t;
	66	typedef void* kmod_args_t;
	67
91447636 A	68	#define KMOD_MAX_NAME 64
91447636 A	69
0c530ab8	70	#pragma pack(4)
9bccf70c	71
91447636	72	/* LP64todo - not 64-bit safe */
1c79356b A	73	typedef struct kmod_reference {
	74	struct kmod_reference *next;
	75	struct kmod_info *info;
	76	} kmod_reference_t;
	77
0c530ab8	78	#pragma pack()
9bccf70c	79
1c79356b A	80	/**************************************************************************************/
	81	/* warning any changes to this structure affect the following macros. */
	82	/**************************************************************************************/
	83
	84	#define KMOD_RETURN_SUCCESS KERN_SUCCESS
	85	#define KMOD_RETURN_FAILURE KERN_FAILURE
	86
	87	typedef kern_return_t kmod_start_func_t(struct kmod_info ki, void data);
	88	typedef kern_return_t kmod_stop_func_t(struct kmod_info ki, void data);
	89
0c530ab8	90	#pragma pack(4)
91447636 A	91
	92	/* LP64todo - not 64-bit safe */
	93
1c79356b A	94	typedef struct kmod_info {
	95	struct kmod_info *next;
	96	int info_version; // version of this structure
	97	int id;
	98	char name[KMOD_MAX_NAME];
	99	char version[KMOD_MAX_NAME];
	100	int reference_count; // # refs to this
	101	kmod_reference_t *reference_list; // who this refs
	102	vm_address_t address; // starting address
	103	vm_size_t size; // total size
	104	vm_size_t hdr_size; // unwired hdr size
	105	kmod_start_func_t *start;
	106	kmod_stop_func_t *stop;
	107	} kmod_info_t;
	108
0c530ab8	109	#pragma pack()
9bccf70c	110
1c79356b A	111	typedef kmod_info_t *kmod_info_array_t;
	112
	113	#define KMOD_INFO_NAME kmod_info
	114	#define KMOD_INFO_VERSION 1
	115
	116	#define KMOD_DECL(name, version) \
	117	static kmod_start_func_t name ## _module_start; \
	118	static kmod_stop_func_t name ## _module_stop; \
	119	kmod_info_t KMOD_INFO_NAME = { 0, KMOD_INFO_VERSION, -1, \
	120	{ #name }, { version }, -1, 0, 0, 0, 0, \
	121	name ## _module_start, \
	122	name ## _module_stop };
	123
	124	#define KMOD_EXPLICIT_DECL(name, version, start, stop) \
	125	kmod_info_t KMOD_INFO_NAME = { 0, KMOD_INFO_VERSION, -1, \
	126	{ #name }, { version }, -1, 0, 0, 0, 0, \
	127	start, stop };
	128
	129	// the following is useful for libaries that don't need their own start and stop functions
	130	#define KMOD_LIB_DECL(name, version) \
	131	kmod_info_t KMOD_INFO_NAME = { 0, KMOD_INFO_VERSION, -1, \
	132	{ #name }, { version }, -1, 0, 0, 0, 0, \
	133	kmod_default_start, \
	134	kmod_default_stop };
	135
	136
	137	// *************************************************************************************
	138	// kmod kernel to user commands
	139	// *************************************************************************************
	140
	141	#define KMOD_LOAD_EXTENSION_PACKET 1
	142	#define KMOD_LOAD_WITH_DEPENDENCIES_PACKET 2
	143
	144	// for generic packets
	145	#define KMOD_IOKIT_START_RANGE_PACKET 0x1000
	146	#define KMOD_IOKIT_END_RANGE_PACKET 0x1fff
	147
	148	typedef struct kmod_load_extension_cmd {
	149	int type;
	150	char name[KMOD_MAX_NAME];
	151	} kmod_load_extension_cmd_t;
	152
	153	typedef struct kmod_load_with_dependencies_cmd {
	154	int type;
	155	char name[KMOD_MAX_NAME];
	156	char dependencies[1][KMOD_MAX_NAME];
	157	} kmod_load_with_dependencies_cmd_t;
	158
	159	typedef struct kmod_generic_cmd {
	160	int type;
	161	char data[1];
	162	} kmod_generic_cmd_t;
	163
91447636	164	#ifdef KERNEL_PRIVATE
1c79356b	165
0b4e3aa0	166	extern kmod_info_t kmod_lookupbyname(const char name);
1c79356b	167	extern kmod_info_t *kmod_lookupbyid(kmod_t id);
2d21ac55 A	168	extern kmod_info_t *kmod_lookupbyaddress(vm_address_t address);
2d21ac55 A	169	extern int kmod_lookupidbyaddress_locked(vm_address_t address);
1c79356b	170
9bccf70c A	171	extern kmod_info_t kmod_lookupbyname_locked(const char name);
9bccf70c A	172	extern kmod_info_t *kmod_lookupbyid_locked(kmod_t id);
91447636 A	173	extern kmod_start_func_t kmod_default_start;
	174	extern kmod_stop_func_t kmod_default_stop;
	175
	176	__BEGIN_DECLS
2d21ac55	177	extern void kmod_init(void) __attribute__((section("__TEXT, initcode")));
91447636 A	178
	179	extern kern_return_t kmod_create_fake(const char name, const char version);
	180	extern kern_return_t kmod_create_fake_with_address(const char name, const char version,
	181	vm_address_t address, vm_size_t size,
	182	int * return_id);
	183	extern kern_return_t kmod_destroy_fake(kmod_t id);
9bccf70c	184
1c79356b A	185	extern kern_return_t kmod_load_extension(char *name);
	186	extern kern_return_t kmod_load_extension_with_dependencies(char name, char *dependencies);
	187	extern kern_return_t kmod_send_generic(int type, void *data, int size);
	188
1c79356b A	189	extern kern_return_t kmod_initialize_cpp(kmod_info_t *info);
	190	extern kern_return_t kmod_finalize_cpp(kmod_info_t *info);
	191
c910b4d9 A	192	void record_kext_unload(kmod_t kmod_id);
	193	void dump_kext_info(int (printf_func)(const char fmt, ...));
	194
91447636 A	195	extern void kmod_dump(vm_offset_t *addr, unsigned int dump_cnt);
91447636 A	196	__END_DECLS
9bccf70c	197
91447636	198	#endif /* KERNEL_PRIVATE */
9bccf70c	199
1c79356b	200	#endif /* _MACH_KMOD_H_ */