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

/*
 * Copyright (c) 2002,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@
 */
/*
 *
 *	File: vm/vm_shared_memory_server.h
 *
 * 	protos and struct definitions for shared library
 *	server and interface
 */

#ifndef _VM_SHARED_MEMORY_SERVER_H_
#define _VM_SHARED_MEMORY_SERVER_H_

#include <sys/appleapiopts.h>

#ifdef __APPLE_API_PRIVATE

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

#include <kern/kern_types.h>

extern mach_port_t      shared_text_region_handle;
extern mach_port_t      shared_data_region_handle;

struct shared_region_task_mappings {
	mach_port_t		text_region;
	vm_size_t		text_size;
	mach_port_t		data_region;
	vm_size_t		data_size;
	vm_offset_t		region_mappings;
	vm_offset_t		client_base;
	vm_offset_t		alternate_base;
	vm_offset_t		alternate_next;
	unsigned int		fs_base;
	unsigned int		system;
	int			flags;
	vm_offset_t		self;
};

#define SHARED_REGION_SYSTEM	0x1 // Default env for system and fs_root
#define SHARED_REGION_FULL	0x2 // Shared regions are full
#define SHARED_REGION_STALE 	0x4 // Indicates no longer in default list


/* defines for default environment, and co-resident systems */

#define ENV_DEFAULT_ROOT	0

typedef	struct shared_region_task_mappings *shared_region_task_mappings_t;
typedef struct shared_region_mapping *shared_region_mapping_t;


#ifdef MACH_KERNEL_PRIVATE

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

extern vm_offset_t     shared_file_mapping_array;

struct loaded_mapping {
	vm_offset_t	mapping_offset;
	vm_size_t	size;
	vm_offset_t	file_offset;
	vm_prot_t	protection;  /* read/write/execute/COW/ZF */
	
	struct loaded_mapping *next;
};

typedef struct loaded_mapping loaded_mapping_t;

struct load_struct {
	queue_chain_t   	links;  
	shared_region_mapping_t	regions_instance;
	int			depth;
	int			file_object;
	vm_offset_t		base_address;
	int			mapping_cnt;
	loaded_mapping_t	*mappings;
        vm_offset_t             file_offset; // start of file we mapped in
};

typedef struct load_struct load_struct_t;
typedef struct load_struct *load_struct_ptr_t;

struct load_file_ele {
	union {
		sf_mapping_t	mapping;
		load_struct_t	element;
	} u;
};

struct shared_file_info {
	mutex_t	    	lock;   /* lock for the structure */
	queue_head_t	*hash;  /* for later perf enhance */
	int		hash_size;
	boolean_t	hash_init;
};

typedef struct shared_file_info shared_file_info_t;

struct shared_region_object_chain {
	shared_region_mapping_t	object_chain_region;
	int			depth;
	struct shared_region_object_chain *next;
};
typedef struct shared_region_object_chain *shared_region_object_chain_t;

/* address space shared region descriptor */
struct shared_region_mapping {
        decl_mutex_data(,       Lock)   /* Synchronization */
	int			ref_count;
	unsigned int		fs_base;
	unsigned int		system;
	mach_port_t		text_region;
	vm_size_t		text_size;
	mach_port_t		data_region;
	vm_size_t		data_size;
	vm_offset_t		region_mappings;
	vm_offset_t		client_base;
	vm_offset_t		alternate_base;
	vm_offset_t		alternate_next;
	int			flags;
	int			depth;
	shared_region_mapping_t default_env_list;
	shared_region_object_chain_t object_chain;
	shared_region_mapping_t self;
	shared_region_mapping_t next;
};

#define shared_region_mapping_lock_init(object)   \
			mutex_init(&(object)->Lock, ETAP_VM_OBJ)
#define shared_region_mapping_lock(object)        mutex_lock(&(object)->Lock)
#define shared_region_mapping_unlock(object)      mutex_unlock(&(object)->Lock)

#else  /* !MACH_KERNEL_PRIVATE */

struct shared_region_mapping ;

#endif /* MACH_KERNEL_PRIVATE */

extern kern_return_t copyin_shared_file(
				vm_offset_t     	mapped_file,
				vm_size_t       	mapped_file_size,
				vm_offset_t     	*base_address,
				int             	map_cnt,
				sf_mapping_t    	*mappings,
				memory_object_control_t		file_control,
				shared_region_task_mappings_t	shared_region,
				int             	*flags);

extern kern_return_t shared_region_mapping_info(
				shared_region_mapping_t	shared_region,
				mach_port_t		*text_region,
				vm_size_t		*text_size,
				mach_port_t		*data_region,
				vm_size_t		*data_size,
				vm_offset_t		*region_mappings,
				vm_offset_t		*client_base,
				vm_offset_t		*alternate_base,
				vm_offset_t		*alternate_next,
				unsigned int		*fs_base,
				unsigned int		*system,
				int			*flags,
				shared_region_mapping_t	*next);

extern kern_return_t shared_region_mapping_create(
				mach_port_t		text_region,
				vm_size_t		text_size,
				mach_port_t		data_region,
				vm_size_t		data_size,
				vm_offset_t		region_mappings,
				vm_offset_t		client_base,
				shared_region_mapping_t	*shared_region,
				vm_offset_t		alt_base,
				vm_offset_t		alt_next);

extern kern_return_t shared_region_mapping_ref(
				shared_region_mapping_t	shared_region);

extern kern_return_t shared_region_mapping_dealloc(
				shared_region_mapping_t	shared_region);

__private_extern__ kern_return_t shared_region_mapping_dealloc_lock(
				shared_region_mapping_t	shared_region,
				int need_lock);

extern kern_return_t shared_region_object_chain_attach(
				shared_region_mapping_t	target_region,
				shared_region_mapping_t	object_chain);

extern kern_return_t vm_get_shared_region(
				task_t	task,
				shared_region_mapping_t	*shared_region);

extern kern_return_t vm_set_shared_region(
				task_t	task,
				shared_region_mapping_t	shared_region);

extern shared_region_mapping_t update_default_shared_region(
				shared_region_mapping_t new_system_region);

extern shared_region_mapping_t lookup_default_shared_region(
				unsigned int fs_base,
				unsigned int system);

extern void remove_default_shared_region(
				shared_region_mapping_t system_region);

__private_extern__ void remove_default_shared_region_lock(
				shared_region_mapping_t system_region,
				int need_lock);

extern unsigned int lsf_mapping_pool_gauge();

#endif /* __APPLE_API_PRIVATE */

#endif /* _VM_SHARED_MEMORY_SERVER_H_ */
Commit	Line	Data
9bccf70c A	1	/*
	2	* Copyright (c) 2002,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.
9bccf70c	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
9bccf70c A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
9bccf70c 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.
9bccf70c A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	*
	24	* File: vm/vm_shared_memory_server.h
	25	*
	26	* protos and struct definitions for shared library
	27	* server and interface
	28	*/
	29
	30	#ifndef _VM_SHARED_MEMORY_SERVER_H_
	31	#define _VM_SHARED_MEMORY_SERVER_H_
	32
	33	#include <sys/appleapiopts.h>
	34
	35	#ifdef __APPLE_API_PRIVATE
	36
	37	#include <mach/vm_prot.h>
	38	#include <mach/mach_types.h>
	39	#include <mach/shared_memory_server.h>
	40
	41	#include <kern/kern_types.h>
	42
	43	extern mach_port_t shared_text_region_handle;
	44	extern mach_port_t shared_data_region_handle;
	45
	46	struct shared_region_task_mappings {
	47	mach_port_t text_region;
	48	vm_size_t text_size;
	49	mach_port_t data_region;
	50	vm_size_t data_size;
	51	vm_offset_t region_mappings;
	52	vm_offset_t client_base;
	53	vm_offset_t alternate_base;
	54	vm_offset_t alternate_next;
55e303ae A	55	unsigned int fs_base;
55e303ae A	56	unsigned int system;
9bccf70c A	57	int flags;
	58	vm_offset_t self;
	59	};
	60
55e303ae A	61	#define SHARED_REGION_SYSTEM 0x1 // Default env for system and fs_root
	62	#define SHARED_REGION_FULL 0x2 // Shared regions are full
	63	#define SHARED_REGION_STALE 0x4 // Indicates no longer in default list
	64
	65
	66	/* defines for default environment, and co-resident systems */
	67
	68	#define ENV_DEFAULT_ROOT 0
9bccf70c A	69
	70	typedef struct shared_region_task_mappings *shared_region_task_mappings_t;
	71	typedef struct shared_region_mapping *shared_region_mapping_t;
	72
	73
	74	#ifdef MACH_KERNEL_PRIVATE
	75
	76	#include <kern/queue.h>
	77	#include <vm/vm_object.h>
	78	#include <vm/memory_object.h>
	79
	80	extern vm_offset_t shared_file_mapping_array;
	81
	82	struct loaded_mapping {
	83	vm_offset_t mapping_offset;
	84	vm_size_t size;
	85	vm_offset_t file_offset;
	86	vm_prot_t protection; /* read/write/execute/COW/ZF */
	87
	88	struct loaded_mapping *next;
	89	};
	90
	91	typedef struct loaded_mapping loaded_mapping_t;
	92
	93	struct load_struct {
	94	queue_chain_t links;
	95	shared_region_mapping_t regions_instance;
	96	int depth;
	97	int file_object;
	98	vm_offset_t base_address;
	99	int mapping_cnt;
	100	loaded_mapping_t *mappings;
55e303ae	101	vm_offset_t file_offset; // start of file we mapped in
9bccf70c A	102	};
	103
	104	typedef struct load_struct load_struct_t;
	105	typedef struct load_struct *load_struct_ptr_t;
	106
	107	struct load_file_ele {
	108	union {
	109	sf_mapping_t mapping;
	110	load_struct_t element;
	111	} u;
	112	};
	113
	114	struct shared_file_info {
	115	mutex_t lock; /* lock for the structure */
	116	queue_head_t hash; / for later perf enhance */
	117	int hash_size;
	118	boolean_t hash_init;
	119	};
	120
	121	typedef struct shared_file_info shared_file_info_t;
	122
	123	struct shared_region_object_chain {
	124	shared_region_mapping_t object_chain_region;
	125	int depth;
	126	struct shared_region_object_chain *next;
	127	};
	128	typedef struct shared_region_object_chain *shared_region_object_chain_t;
	129
	130	/* address space shared region descriptor */
	131	struct shared_region_mapping {
	132	decl_mutex_data(, Lock) /* Synchronization */
	133	int ref_count;
55e303ae A	134	unsigned int fs_base;
55e303ae A	135	unsigned int system;
9bccf70c A	136	mach_port_t text_region;
	137	vm_size_t text_size;
	138	mach_port_t data_region;
	139	vm_size_t data_size;
	140	vm_offset_t region_mappings;
	141	vm_offset_t client_base;
	142	vm_offset_t alternate_base;
	143	vm_offset_t alternate_next;
	144	int flags;
	145	int depth;
55e303ae	146	shared_region_mapping_t default_env_list;
9bccf70c A	147	shared_region_object_chain_t object_chain;
	148	shared_region_mapping_t self;
	149	shared_region_mapping_t next;
	150	};
	151
	152	#define shared_region_mapping_lock_init(object) \
	153	mutex_init(&(object)->Lock, ETAP_VM_OBJ)
	154	#define shared_region_mapping_lock(object) mutex_lock(&(object)->Lock)
	155	#define shared_region_mapping_unlock(object) mutex_unlock(&(object)->Lock)
	156
	157	#else /* !MACH_KERNEL_PRIVATE */
	158
	159	struct shared_region_mapping ;
	160
	161	#endif /* MACH_KERNEL_PRIVATE */
	162
	163	extern kern_return_t copyin_shared_file(
	164	vm_offset_t mapped_file,
	165	vm_size_t mapped_file_size,
	166	vm_offset_t *base_address,
	167	int map_cnt,
	168	sf_mapping_t *mappings,
	169	memory_object_control_t file_control,
	170	shared_region_task_mappings_t shared_region,
	171	int *flags);
	172
	173	extern kern_return_t shared_region_mapping_info(
	174	shared_region_mapping_t shared_region,
	175	mach_port_t *text_region,
	176	vm_size_t *text_size,
	177	mach_port_t *data_region,
	178	vm_size_t *data_size,
	179	vm_offset_t *region_mappings,
	180	vm_offset_t *client_base,
	181	vm_offset_t *alternate_base,
	182	vm_offset_t *alternate_next,
55e303ae A	183	unsigned int *fs_base,
55e303ae A	184	unsigned int *system,
9bccf70c A	185	int *flags,
	186	shared_region_mapping_t *next);
	187
	188	extern kern_return_t shared_region_mapping_create(
	189	mach_port_t text_region,
	190	vm_size_t text_size,
	191	mach_port_t data_region,
	192	vm_size_t data_size,
	193	vm_offset_t region_mappings,
	194	vm_offset_t client_base,
	195	shared_region_mapping_t *shared_region,
	196	vm_offset_t alt_base,
	197	vm_offset_t alt_next);
	198
	199	extern kern_return_t shared_region_mapping_ref(
	200	shared_region_mapping_t shared_region);
	201
	202	extern kern_return_t shared_region_mapping_dealloc(
	203	shared_region_mapping_t shared_region);
	204
55e303ae A	205	__private_extern__ kern_return_t shared_region_mapping_dealloc_lock(
	206	shared_region_mapping_t shared_region,
	207	int need_lock);
	208
9bccf70c A	209	extern kern_return_t shared_region_object_chain_attach(
	210	shared_region_mapping_t target_region,
	211	shared_region_mapping_t object_chain);
	212
	213	extern kern_return_t vm_get_shared_region(
	214	task_t task,
	215	shared_region_mapping_t *shared_region);
	216
	217	extern kern_return_t vm_set_shared_region(
	218	task_t task,
	219	shared_region_mapping_t shared_region);
	220
55e303ae A	221	extern shared_region_mapping_t update_default_shared_region(
	222	shared_region_mapping_t new_system_region);
	223
	224	extern shared_region_mapping_t lookup_default_shared_region(
	225	unsigned int fs_base,
	226	unsigned int system);
	227
	228	extern void remove_default_shared_region(
	229	shared_region_mapping_t system_region);
	230
	231	__private_extern__ void remove_default_shared_region_lock(
	232	shared_region_mapping_t system_region,
	233	int need_lock);
	234
9bccf70c A	235	extern unsigned int lsf_mapping_pool_gauge();
	236
	237	#endif /* __APPLE_API_PRIVATE */
	238
	239	#endif /* _VM_SHARED_MEMORY_SERVER_H_ */