[apple/xnu.git] / osfmk / vm / vm_shared_region.h

/*
 * Copyright (c) 2007 Apple Inc. All rights reserved.
 *
 * @APPLE_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. 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_HEADER_END@
 */
/*
 *
 *	File: vm/vm_shared_region.h
 *
 * 	protos and struct definitions for shared region
 */

#ifndef _VM_SHARED_REGION_H_
#define _VM_SHARED_REGION_H_

#ifdef	KERNEL_PRIVATE

#include <mach/vm_prot.h>
#include <mach/mach_types.h>
#include <mach/shared_region.h>

#include <kern/kern_types.h>
#include <kern/macro_help.h>

#include <vm/vm_map.h>

extern int shared_region_version;
extern int shared_region_persistence;

#if DEBUG
extern int shared_region_debug;
#define SHARED_REGION_DEBUG(args)		\
	MACRO_BEGIN				\
	if (shared_region_debug) {		\
		kprintf args;			\
	}					\
	MACRO_END
#else /* DEBUG */
#define SHARED_REGION_DEBUG(args)
#endif /* DEBUG */

extern int shared_region_trace_level;
#define SHARED_REGION_TRACE_NONE_LVL		0 /* no trace */
#define SHARED_REGION_TRACE_ERROR_LVL		1 /* trace abnormal events */
#define SHARED_REGION_TRACE_INFO_LVL		2 /* trace all events */
#define SHARED_REGION_TRACE_DEBUG_LVL		3 /* extra traces for debug */
#define SHARED_REGION_TRACE(level, args)		\
	MACRO_BEGIN					\
	if (shared_region_trace_level >= level) {	\
		printf args;				\
	}						\
	MACRO_END
#define SHARED_REGION_TRACE_NONE(args)
#define SHARED_REGION_TRACE_ERROR(args)				\
	MACRO_BEGIN						\
	SHARED_REGION_TRACE(SHARED_REGION_TRACE_ERROR_LVL,	\
			    args);				\
	MACRO_END
#define SHARED_REGION_TRACE_INFO(args)				\
	MACRO_BEGIN						\
	SHARED_REGION_TRACE(SHARED_REGION_TRACE_INFO_LVL,	\
			    args);				\
	MACRO_END
#define SHARED_REGION_TRACE_DEBUG(args)				\
	MACRO_BEGIN						\
	SHARED_REGION_TRACE(SHARED_REGION_TRACE_DEBUG_LVL,	\
			    args);				\
	MACRO_END

typedef struct vm_shared_region *vm_shared_region_t;

#ifdef MACH_KERNEL_PRIVATE

#include <kern/queue.h>
#include <vm/vm_object.h>
#include <vm/memory_object.h>

/* address space shared region descriptor */
struct vm_shared_region {
	uint32_t		sr_ref_count;
	void			*sr_root_dir;
	cpu_type_t		sr_cpu_type;
	boolean_t		sr_64bit;
	boolean_t		sr_mapping_in_progress;
	boolean_t		sr_persists;
	ipc_port_t		sr_mem_entry;
	mach_vm_offset_t	sr_first_mapping;
	mach_vm_offset_t	sr_base_address;
	mach_vm_size_t		sr_size;
	mach_vm_offset_t	sr_pmap_nesting_start;
	mach_vm_size_t		sr_pmap_nesting_size;
	queue_chain_t		sr_q;
};

#else  /* !MACH_KERNEL_PRIVATE */

struct vm_shared_region;

#endif /* MACH_KERNEL_PRIVATE */

extern void vm_shared_region_init(void);
extern kern_return_t vm_shared_region_enter(
	struct _vm_map		*map,
	struct task		*task,
	void			*fsroot,
	cpu_type_t		cpu);
extern kern_return_t vm_shared_region_remove(
	struct _vm_map		*map,
	struct task		*task);
extern vm_shared_region_t vm_shared_region_get(
	struct task		*task);
extern void vm_shared_region_deallocate(
	struct vm_shared_region	*shared_region);
extern mach_vm_offset_t vm_shared_region_base_address(
	struct vm_shared_region	*shared_region);
extern mach_vm_size_t vm_shared_region_size(
	struct vm_shared_region	*shared_region);
extern ipc_port_t vm_shared_region_mem_entry(
	struct vm_shared_region	*shared_region);
extern void vm_shared_region_set(
	struct task		*task,
	struct vm_shared_region	*new_shared_region);
extern vm_shared_region_t vm_shared_region_lookup(
	void			*root_dir,
	cpu_type_t		cpu,
	boolean_t		is_64bit);
extern kern_return_t vm_shared_region_start_address(
	struct vm_shared_region	*shared_region,
	mach_vm_offset_t	*start_address);
extern kern_return_t vm_shared_region_map_file(
	struct vm_shared_region	*shared_region,
	unsigned int		mappings_count,
	struct shared_file_mapping_np *mappings,
	memory_object_control_t	file_control,
	memory_object_size_t	file_size,
	void			*root_dir);

extern void vm_commpage_init(void);
extern kern_return_t vm_commpage_enter(
	struct _vm_map		*map,
	struct task		*task);
extern kern_return_t vm_commpage_remove(
	struct _vm_map		*map,
	struct task		*task);

#endif /* KERNEL_PRIVATE */

#endif	/* _VM_SHARED_REGION_H_ */
Commit	Line	Data
2d21ac55 A	1	/*
	2	* Copyright (c) 2007 Apple Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	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. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
	12	*
	13	* The Original Code and all software distributed under the License are
	14	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	15	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	16	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	18	* Please see the License for the specific language governing rights and
	19	* limitations under the License.
	20	*
	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
	23	/*
	24	*
	25	* File: vm/vm_shared_region.h
	26	*
	27	* protos and struct definitions for shared region
	28	*/
	29
	30	#ifndef _VM_SHARED_REGION_H_
	31	#define _VM_SHARED_REGION_H_
	32
	33	#ifdef KERNEL_PRIVATE
	34
	35	#include <mach/vm_prot.h>
	36	#include <mach/mach_types.h>
	37	#include <mach/shared_region.h>
	38
	39	#include <kern/kern_types.h>
	40	#include <kern/macro_help.h>
	41
	42	#include <vm/vm_map.h>
	43
	44	extern int shared_region_version;
	45	extern int shared_region_persistence;
	46
	47	#if DEBUG
	48	extern int shared_region_debug;
	49	#define SHARED_REGION_DEBUG(args) \
	50	MACRO_BEGIN \
	51	if (shared_region_debug) { \
	52	kprintf args; \
	53	} \
	54	MACRO_END
	55	#else /* DEBUG */
	56	#define SHARED_REGION_DEBUG(args)
	57	#endif /* DEBUG */
	58
	59	extern int shared_region_trace_level;
	60	#define SHARED_REGION_TRACE_NONE_LVL 0 /* no trace */
	61	#define SHARED_REGION_TRACE_ERROR_LVL 1 /* trace abnormal events */
	62	#define SHARED_REGION_TRACE_INFO_LVL 2 /* trace all events */
	63	#define SHARED_REGION_TRACE_DEBUG_LVL 3 /* extra traces for debug */
	64	#define SHARED_REGION_TRACE(level, args) \
65	MACRO_BEGIN \
66	if (shared_region_trace_level >= level) { \
67	printf args; \
68	} \
69	MACRO_END
70	#define SHARED_REGION_TRACE_NONE(args)
71	#define SHARED_REGION_TRACE_ERROR(args) \
72	MACRO_BEGIN \
73	SHARED_REGION_TRACE(SHARED_REGION_TRACE_ERROR_LVL, \
74	args); \
75	MACRO_END
76	#define SHARED_REGION_TRACE_INFO(args) \
77	MACRO_BEGIN \
78	SHARED_REGION_TRACE(SHARED_REGION_TRACE_INFO_LVL, \
79	args); \
80	MACRO_END
81	#define SHARED_REGION_TRACE_DEBUG(args) \
82	MACRO_BEGIN \
83	SHARED_REGION_TRACE(SHARED_REGION_TRACE_DEBUG_LVL, \
84	args); \
85	MACRO_END
86
87	typedef struct vm_shared_region *vm_shared_region_t;
88
89	#ifdef MACH_KERNEL_PRIVATE
90
91	#include <kern/queue.h>
92	#include <vm/vm_object.h>
93	#include <vm/memory_object.h>
94
95	/* address space shared region descriptor */
96	struct vm_shared_region {
97	uint32_t sr_ref_count;
98	void *sr_root_dir;
99	cpu_type_t sr_cpu_type;
100	boolean_t sr_64bit;
101	boolean_t sr_mapping_in_progress;
102	boolean_t sr_persists;
103	ipc_port_t sr_mem_entry;
104	mach_vm_offset_t sr_first_mapping;
105	mach_vm_offset_t sr_base_address;
106	mach_vm_size_t sr_size;
107	mach_vm_offset_t sr_pmap_nesting_start;
108	mach_vm_size_t sr_pmap_nesting_size;
109	queue_chain_t sr_q;
110	};
111
112	#else /* !MACH_KERNEL_PRIVATE */
113
114	struct vm_shared_region;
115
116	#endif /* MACH_KERNEL_PRIVATE */
117
118	extern void vm_shared_region_init(void);
119	extern kern_return_t vm_shared_region_enter(
120	struct _vm_map *map,
121	struct task *task,
122	void *fsroot,
123	cpu_type_t cpu);
124	extern kern_return_t vm_shared_region_remove(
125	struct _vm_map *map,
126	struct task *task);
127	extern vm_shared_region_t vm_shared_region_get(
128	struct task *task);
129	extern void vm_shared_region_deallocate(
130	struct vm_shared_region *shared_region);
131	extern mach_vm_offset_t vm_shared_region_base_address(
132	struct vm_shared_region *shared_region);
133	extern mach_vm_size_t vm_shared_region_size(
134	struct vm_shared_region *shared_region);
135	extern ipc_port_t vm_shared_region_mem_entry(
136	struct vm_shared_region *shared_region);
137	extern void vm_shared_region_set(
138	struct task *task,
139	struct vm_shared_region *new_shared_region);
140	extern vm_shared_region_t vm_shared_region_lookup(
141	void *root_dir,
142	cpu_type_t cpu,
143	boolean_t is_64bit);
144	extern kern_return_t vm_shared_region_start_address(
145	struct vm_shared_region *shared_region,
146	mach_vm_offset_t *start_address);
147	extern kern_return_t vm_shared_region_map_file(
148	struct vm_shared_region *shared_region,
149	unsigned int mappings_count,
150	struct shared_file_mapping_np *mappings,
151	memory_object_control_t file_control,
152	memory_object_size_t file_size,
153	void *root_dir);
154
155	extern void vm_commpage_init(void);
156	extern kern_return_t vm_commpage_enter(
157	struct _vm_map *map,
158	struct task *task);
159	extern kern_return_t vm_commpage_remove(
160	struct _vm_map *map,
161	struct task *task);
162
163	#endif /* KERNEL_PRIVATE */
164
165	#endif /* _VM_SHARED_REGION_H_ */