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

/*
 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_OSREFERENCE_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_LICENSE_OSREFERENCE_HEADER_END@
 */

#ifndef	_MACH_KMOD_H_
#define	_MACH_KMOD_H_

#include <mach/kern_return.h>

#include <sys/cdefs.h>

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

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

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	/*
91447636	2	* Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
8ad349bb	4	* @APPLE_LICENSE_OSREFERENCE_HEADER_START@
1c79356b	5	*
8ad349bb 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
	10	* License may not be used to create, or enable the creation or
	11	* redistribution of, unlawful or unlicensed copies of an Apple operating
	12	* system, or to circumvent, violate, or enable the circumvention or
	13	* violation of, any terms of an Apple operating system software license
	14	* agreement.
	15	*
	16	* Please obtain a copy of the License at
	17	* http://www.opensource.apple.com/apsl/ and read it before using this
	18	* file.
	19	*
	20	* The Original Code and all software distributed under the License are
	21	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	22	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	23	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	25	* Please see the License for the specific language governing rights and
	26	* limitations under the License.
	27	*
	28	* @APPLE_LICENSE_OSREFERENCE_HEADER_END@
1c79356b	29	*/
1c79356b A	30
	31	#ifndef _MACH_KMOD_H_
	32	#define _MACH_KMOD_H_
	33
	34	#include <mach/kern_return.h>
	35
91447636	36	#include <sys/cdefs.h>
9bccf70c	37
1c79356b A	38	#define KMOD_CNTL_START 1 // call kmod's start routine
	39	#define KMOD_CNTL_STOP 2 // call kmod's stop routine
	40	#define KMOD_CNTL_RETAIN 3 // increase a kmod's reference count
	41	#define KMOD_CNTL_RELEASE 4 // decrease a kmod's reference count
	42	#define KMOD_CNTL_GET_CMD 5 // get kmod load cmd from kernel
	43
	44	#define KMOD_PACK_IDS(from, to) (((unsigned long)from << 16) \| (unsigned long)to)
	45	#define KMOD_UNPACK_FROM_ID(i) ((unsigned long)i >> 16)
	46	#define KMOD_UNPACK_TO_ID(i) ((unsigned long)i & 0xffff)
	47
1c79356b A	48	typedef int kmod_t;
	49	typedef int kmod_control_flavor_t;
	50	typedef void* kmod_args_t;
	51
91447636 A	52	#define KMOD_MAX_NAME 64
91447636 A	53
5d5c5d0d	54	#pragma pack(4)
9bccf70c	55
91447636	56	/* LP64todo - not 64-bit safe */
1c79356b A	57	typedef struct kmod_reference {
	58	struct kmod_reference *next;
	59	struct kmod_info *info;
	60	} kmod_reference_t;
	61
5d5c5d0d	62	#pragma pack()
9bccf70c	63
1c79356b A	64	/**************************************************************************************/
	65	/* warning any changes to this structure affect the following macros. */
	66	/**************************************************************************************/
	67
	68	#define KMOD_RETURN_SUCCESS KERN_SUCCESS
	69	#define KMOD_RETURN_FAILURE KERN_FAILURE
	70
	71	typedef kern_return_t kmod_start_func_t(struct kmod_info ki, void data);
	72	typedef kern_return_t kmod_stop_func_t(struct kmod_info ki, void data);
	73
5d5c5d0d	74	#pragma pack(4)
91447636 A	75
	76	/* LP64todo - not 64-bit safe */
	77
1c79356b A	78	typedef struct kmod_info {
	79	struct kmod_info *next;
	80	int info_version; // version of this structure
	81	int id;
	82	char name[KMOD_MAX_NAME];
	83	char version[KMOD_MAX_NAME];
	84	int reference_count; // # refs to this
	85	kmod_reference_t *reference_list; // who this refs
	86	vm_address_t address; // starting address
	87	vm_size_t size; // total size
	88	vm_size_t hdr_size; // unwired hdr size
	89	kmod_start_func_t *start;
	90	kmod_stop_func_t *stop;
	91	} kmod_info_t;
	92
5d5c5d0d	93	#pragma pack()
9bccf70c	94
1c79356b A	95	typedef kmod_info_t *kmod_info_array_t;
	96
	97	#define KMOD_INFO_NAME kmod_info
	98	#define KMOD_INFO_VERSION 1
	99
	100	#define KMOD_DECL(name, version) \
	101	static kmod_start_func_t name ## _module_start; \
	102	static kmod_stop_func_t name ## _module_stop; \
	103	kmod_info_t KMOD_INFO_NAME = { 0, KMOD_INFO_VERSION, -1, \
	104	{ #name }, { version }, -1, 0, 0, 0, 0, \
	105	name ## _module_start, \
	106	name ## _module_stop };
	107
	108	#define KMOD_EXPLICIT_DECL(name, version, start, stop) \
	109	kmod_info_t KMOD_INFO_NAME = { 0, KMOD_INFO_VERSION, -1, \
	110	{ #name }, { version }, -1, 0, 0, 0, 0, \
	111	start, stop };
	112
	113	// the following is useful for libaries that don't need their own start and stop functions
	114	#define KMOD_LIB_DECL(name, version) \
	115	kmod_info_t KMOD_INFO_NAME = { 0, KMOD_INFO_VERSION, -1, \
	116	{ #name }, { version }, -1, 0, 0, 0, 0, \
	117	kmod_default_start, \
	118	kmod_default_stop };
	119
	120
	121	// *************************************************************************************
	122	// kmod kernel to user commands
	123	// *************************************************************************************
	124
	125	#define KMOD_LOAD_EXTENSION_PACKET 1
	126	#define KMOD_LOAD_WITH_DEPENDENCIES_PACKET 2
	127
	128	// for generic packets
	129	#define KMOD_IOKIT_START_RANGE_PACKET 0x1000
	130	#define KMOD_IOKIT_END_RANGE_PACKET 0x1fff
	131
	132	typedef struct kmod_load_extension_cmd {
	133	int type;
	134	char name[KMOD_MAX_NAME];
	135	} kmod_load_extension_cmd_t;
	136
	137	typedef struct kmod_load_with_dependencies_cmd {
	138	int type;
	139	char name[KMOD_MAX_NAME];
	140	char dependencies[1][KMOD_MAX_NAME];
	141	} kmod_load_with_dependencies_cmd_t;
	142
	143	typedef struct kmod_generic_cmd {
	144	int type;
	145	char data[1];
	146	} kmod_generic_cmd_t;
	147
91447636	148	#ifdef KERNEL_PRIVATE
1c79356b	149
0b4e3aa0	150	extern kmod_info_t kmod_lookupbyname(const char name);
1c79356b A	151	extern kmod_info_t *kmod_lookupbyid(kmod_t id);
1c79356b A	152
9bccf70c A	153	extern kmod_info_t kmod_lookupbyname_locked(const char name);
9bccf70c A	154	extern kmod_info_t *kmod_lookupbyid_locked(kmod_t id);
91447636 A	155	extern kmod_start_func_t kmod_default_start;
	156	extern kmod_stop_func_t kmod_default_stop;
	157
	158	__BEGIN_DECLS
	159	extern void kmod_init(void);
	160
	161	extern kern_return_t kmod_create_fake(const char name, const char version);
	162	extern kern_return_t kmod_create_fake_with_address(const char name, const char version,
	163	vm_address_t address, vm_size_t size,
	164	int * return_id);
	165	extern kern_return_t kmod_destroy_fake(kmod_t id);
9bccf70c	166
1c79356b A	167	extern kern_return_t kmod_load_extension(char *name);
	168	extern kern_return_t kmod_load_extension_with_dependencies(char name, char *dependencies);
	169	extern kern_return_t kmod_send_generic(int type, void *data, int size);
	170
1c79356b A	171	extern kern_return_t kmod_initialize_cpp(kmod_info_t *info);
	172	extern kern_return_t kmod_finalize_cpp(kmod_info_t *info);
	173
91447636 A	174	extern void kmod_dump(vm_offset_t *addr, unsigned int dump_cnt);
91447636 A	175	__END_DECLS
9bccf70c	176
91447636	177	#endif /* KERNEL_PRIVATE */
9bccf70c	178
1c79356b	179	#endif /* _MACH_KMOD_H_ */