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

extern struct vm_shared_region *init_task_shared_region;

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

#define PAGE_SIZE_FOR_SR_SLIDE  4096

/* Documentation for the slide info format can be found in the dyld project in
 * the file 'launch-cache/dyld_cache_format.h'. */


typedef struct vm_shared_region_slide_info_entry_v2 *vm_shared_region_slide_info_entry_v2_t;
struct vm_shared_region_slide_info_entry_v2 {
	uint32_t        version;
	uint32_t        page_size;
	uint32_t        page_starts_offset;
	uint32_t        page_starts_count;
	uint32_t        page_extras_offset;
	uint32_t        page_extras_count;
	uint64_t        delta_mask;             // which (contiguous) set of bits contains the delta to the next rebase location
	uint64_t        value_add;
	// uint16_t	page_starts[page_starts_count];
	// uint16_t	page_extras[page_extras_count];
};

#define DYLD_CACHE_SLIDE_PAGE_ATTRS             0xC000  // high bits of uint16_t are flags
#define DYLD_CACHE_SLIDE_PAGE_ATTR_EXTRA        0x8000  // index is into extras array (not starts array)
#define DYLD_CACHE_SLIDE_PAGE_ATTR_NO_REBASE    0x4000  // page has no rebasing
#define DYLD_CACHE_SLIDE_PAGE_ATTR_END          0x8000  // last chain entry for page
#define DYLD_CACHE_SLIDE_PAGE_VALUE             0x3FFF  // bitwise negation of DYLD_CACHE_SLIDE_PAGE_ATTRS
#define DYLD_CACHE_SLIDE_PAGE_OFFSET_SHIFT      2

typedef struct vm_shared_region_slide_info_entry_v3 *vm_shared_region_slide_info_entry_v3_t;
struct vm_shared_region_slide_info_entry_v3 {
	uint32_t        version;                        // currently 3
	uint32_t        page_size;                      // currently 4096 (may also be 16384)
	uint32_t        page_starts_count;
	uint64_t        value_add;
	uint16_t        page_starts[] /* page_starts_count */;
};

#define DYLD_CACHE_SLIDE_V3_PAGE_ATTR_NO_REBASE 0xFFFF  // page has no rebasing


typedef struct vm_shared_region_slide_info_entry_v4 *vm_shared_region_slide_info_entry_v4_t;
struct vm_shared_region_slide_info_entry_v4 {
	uint32_t    version;        // currently 4
	uint32_t    page_size;      // currently 4096 (may also be 16384)
	uint32_t    page_starts_offset;
	uint32_t    page_starts_count;
	uint32_t    page_extras_offset;
	uint32_t    page_extras_count;
	uint64_t    delta_mask;    // which (contiguous) set of bits contains the delta to the next rebase location (0xC0000000)
	uint64_t    value_add;     // base address of cache
	// uint16_t    page_starts[page_starts_count];
	// uint16_t    page_extras[page_extras_count];
};

#define DYLD_CACHE_SLIDE4_PAGE_NO_REBASE           0xFFFF  // page has no rebasing
#define DYLD_CACHE_SLIDE4_PAGE_INDEX               0x7FFF  // index into starts or extras
#define DYLD_CACHE_SLIDE4_PAGE_USE_EXTRA           0x8000  // index is into extras array (not starts array)
#define DYLD_CACHE_SLIDE4_PAGE_EXTRA_END           0x8000  // last chain entry for page


typedef union vm_shared_region_slide_info_entry *vm_shared_region_slide_info_entry_t;
union vm_shared_region_slide_info_entry {
	uint32_t version;
	struct vm_shared_region_slide_info_entry_v2 v2;
	struct vm_shared_region_slide_info_entry_v3 v3;
	struct vm_shared_region_slide_info_entry_v4 v4;
};

#define MIN_SLIDE_INFO_SIZE \
    MIN(sizeof(struct vm_shared_region_slide_info_entry_v2), \
    MIN(sizeof(struct vm_shared_region_slide_info_entry_v3), \
    sizeof(struct vm_shared_region_slide_info_entry_v4)))

/*
 * This is the information used by the shared cache pager for sub-sections
 * which must be modified for relocations and/or pointer authentications
 * before it can be used. The shared_region_pager gets source pages from
 * the shared cache file and modifies them -- see shared_region_pager_data_request().
 *
 * A single pager may be used from multiple shared regions provided:
 * - same si_slide_object, si_start, si_end, si_slide, si_ptrauth and si_jop_key
 * - The size and contents of si_slide_info_entry are the same.
 */
typedef struct vm_shared_region_slide_info {
	uint32_t                si_slide;           /* the distance that the file data is relocated */
	bool                    si_slid;
#if __has_feature(ptrauth_calls)
	bool                    si_ptrauth;
	uint64_t                si_jop_key;
	struct vm_shared_region *si_shared_region; /* so we can ref/dealloc for authenticated slide info */
#endif /* __has_feature(ptrauth_calls) */
	mach_vm_address_t       si_slid_address;
	mach_vm_offset_t        si_start;           /* start offset in si_slide_object */
	mach_vm_offset_t        si_end;
	vm_object_t             si_slide_object;    /* The source object for the pages to be modified */
	mach_vm_size_t          si_slide_info_size; /* size of dyld provided relocation information */
	vm_shared_region_slide_info_entry_t si_slide_info_entry; /* dyld provided relocation information */
} *vm_shared_region_slide_info_t;

/*
 * Data structure that represents a unique shared cache region.
 */
struct vm_shared_region {
	uint32_t                sr_ref_count;
	uint32_t                sr_slide;
	queue_chain_t           sr_q;
	void                    *sr_root_dir;
	cpu_type_t              sr_cpu_type;
	cpu_subtype_t           sr_cpu_subtype;
	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;
	thread_call_t           sr_timer_call;
	uuid_t                  sr_uuid;

	bool                    sr_mapping_in_progress;
	bool                    sr_slide_in_progress;
	bool                    sr_64bit;
	bool                    sr_persists;
	bool                    sr_uuid_copied;
	bool                    sr_stale;              /* This region should never be used again. */

#if __has_feature(ptrauth_calls)
	bool                    sr_reslide;            /* Special shared region for suspected attacked processes */
#define NUM_SR_AUTH_SECTIONS 2
	vm_shared_region_slide_info_t sr_auth_section[NUM_SR_AUTH_SECTIONS];
	uint_t                  sr_num_auth_section;
#endif /* __has_feature(ptrauth_calls) */

	uint32_t                sr_images_count;
	struct dyld_uuid_info_64 *sr_images;
};

extern kern_return_t vm_shared_region_slide_page(
	vm_shared_region_slide_info_t si,
	vm_offset_t                   vaddr,
	mach_vm_offset_t              uservaddr,
	uint32_t                      pageIndex,
	uint64_t                      jop_key);
extern uint64_t shared_region_find_key(char *shared_region_id);
#else  /* !MACH_KERNEL_PRIVATE */

struct vm_shared_region;
struct vm_shared_region_slide_info;
struct vm_shared_region_slide_info_entry;
struct slide_info_entry_toc;

#endif /* MACH_KERNEL_PRIVATE */

struct _sr_file_mappings {
	int                     fd;
	uint32_t                mappings_count;
	struct shared_file_mapping_slide_np *mappings;
	uint32_t                slide;
	struct fileproc         *fp;
	struct vnode            *vp;
	memory_object_size_t    file_size;
	memory_object_control_t file_control;
};

extern void vm_shared_region_init(void);
extern kern_return_t vm_shared_region_enter(
	struct _vm_map          *map,
	struct task             *task,
	boolean_t               is_64bit,
	void                    *fsroot,
	cpu_type_t              cpu,
	cpu_subtype_t           cpu_subtype,
	boolean_t               reslide);
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 vm_shared_region_t vm_shared_region_trim_and_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 vm_map_t vm_shared_region_vm_map(
	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,
	cpu_subtype_t           cpu_subtype,
	boolean_t               is_64bit,
	boolean_t               reslide);
extern kern_return_t vm_shared_region_start_address(
	struct vm_shared_region *shared_region,
	mach_vm_offset_t        *start_address);
extern void vm_shared_region_undo_mappings(
	vm_map_t sr_map,
	mach_vm_offset_t sr_base_address,
	struct _sr_file_mappings *srf_mappings,
	struct _sr_file_mappings *srf_mappings_count,
	unsigned int mappings_count);
__attribute__((noinline))
extern kern_return_t vm_shared_region_map_file(
	struct vm_shared_region *shared_region,
	int                     sr_mappings_count,
	struct _sr_file_mappings *sr_mappings);
extern void *vm_shared_region_root_dir(
	struct vm_shared_region *shared_region);
extern kern_return_t vm_shared_region_sliding_valid(uint32_t slide);
extern void vm_commpage_init(void);
extern void vm_commpage_text_init(void);
extern kern_return_t vm_commpage_enter(
	struct _vm_map          *map,
	struct task             *task,
	boolean_t               is64bit);
extern kern_return_t vm_commpage_remove(
	struct _vm_map          *map,
	struct task             *task);
int vm_shared_region_slide(uint32_t,
    mach_vm_offset_t,
    mach_vm_size_t,
    mach_vm_offset_t,
    mach_vm_size_t,
    mach_vm_offset_t,
    memory_object_control_t,
    vm_prot_t);
extern void vm_shared_region_pivot(void);
extern void vm_shared_region_reslide_stale(void);
#if __has_feature(ptrauth_calls)
__attribute__((noinline))
extern kern_return_t vm_shared_region_auth_remap(vm_shared_region_t sr);
#endif /* __has_feature(ptrauth_calls) */
extern void vm_shared_region_reference(vm_shared_region_t sr);

#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@
0a7de745	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. Please obtain a copy of the License at
	10	* http://www.opensource.apple.com/apsl/ and read it before using this
	11	* file.
0a7de745	12	*
2d21ac55 A	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.
0a7de745	20	*
2d21ac55 A	21	* @APPLE_LICENSE_HEADER_END@
	22	*/
	23	/*
	24	*
	25	* File: vm/vm_shared_region.h
	26	*
0a7de745	27	* protos and struct definitions for shared region
2d21ac55 A	28	*/
	29
	30	#ifndef _VM_SHARED_REGION_H_
	31	#define _VM_SHARED_REGION_H_
	32
0a7de745	33	#ifdef KERNEL_PRIVATE
2d21ac55 A	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;
0a7de745 A	49	#define SHARED_REGION_DEBUG(args) \
	50	MACRO_BEGIN \
	51	if (shared_region_debug) { \
	52	kprintf args; \
	53	} \
2d21ac55 A	54	MACRO_END
	55	#else /* DEBUG */
	56	#define SHARED_REGION_DEBUG(args)
	57	#endif /* DEBUG */
	58
	59	extern int shared_region_trace_level;
d9a64523 A	60
	61	extern struct vm_shared_region *init_task_shared_region;
	62
0a7de745 A	63	#define SHARED_REGION_TRACE_NONE_LVL 0 /* no trace */
	64	#define SHARED_REGION_TRACE_ERROR_LVL 1 /* trace abnormal events */
	65	#define SHARED_REGION_TRACE_INFO_LVL 2 /* trace all events */
	66	#define SHARED_REGION_TRACE_DEBUG_LVL 3 /* extra traces for debug */
	67	#define SHARED_REGION_TRACE(level, args) \
	68	MACRO_BEGIN \
	69	if (shared_region_trace_level >= level) { \
	70	printf args; \
	71	} \
2d21ac55 A	72	MACRO_END
2d21ac55 A	73	#define SHARED_REGION_TRACE_NONE(args)
0a7de745 A	74	#define SHARED_REGION_TRACE_ERROR(args) \
	75	MACRO_BEGIN \
	76	SHARED_REGION_TRACE(SHARED_REGION_TRACE_ERROR_LVL, \
	77	args); \
2d21ac55	78	MACRO_END
0a7de745 A	79	#define SHARED_REGION_TRACE_INFO(args) \
	80	MACRO_BEGIN \
	81	SHARED_REGION_TRACE(SHARED_REGION_TRACE_INFO_LVL, \
	82	args); \
2d21ac55	83	MACRO_END
0a7de745 A	84	#define SHARED_REGION_TRACE_DEBUG(args) \
	85	MACRO_BEGIN \
	86	SHARED_REGION_TRACE(SHARED_REGION_TRACE_DEBUG_LVL, \
	87	args); \
2d21ac55 A	88	MACRO_END
	89
	90	typedef struct vm_shared_region *vm_shared_region_t;
	91
	92	#ifdef MACH_KERNEL_PRIVATE
	93
	94	#include <kern/queue.h>
	95	#include <vm/vm_object.h>
	96	#include <vm/memory_object.h>
	97
0a7de745	98	#define PAGE_SIZE_FOR_SR_SLIDE 4096
39037602 A	99
	100	/* Documentation for the slide info format can be found in the dyld project in
	101	* the file 'launch-cache/dyld_cache_format.h'. */
	102
6d2010ae	103
39037602 A	104	typedef struct vm_shared_region_slide_info_entry_v2 *vm_shared_region_slide_info_entry_v2_t;
39037602 A	105	struct vm_shared_region_slide_info_entry_v2 {
0a7de745 A	106	uint32_t version;
	107	uint32_t page_size;
	108	uint32_t page_starts_offset;
	109	uint32_t page_starts_count;
	110	uint32_t page_extras_offset;
	111	uint32_t page_extras_count;
	112	uint64_t delta_mask; // which (contiguous) set of bits contains the delta to the next rebase location
	113	uint64_t value_add;
39037602 A	114	// uint16_t page_starts[page_starts_count];
	115	// uint16_t page_extras[page_extras_count];
	116	};
	117
0a7de745 A	118	#define DYLD_CACHE_SLIDE_PAGE_ATTRS 0xC000 // high bits of uint16_t are flags
	119	#define DYLD_CACHE_SLIDE_PAGE_ATTR_EXTRA 0x8000 // index is into extras array (not starts array)
	120	#define DYLD_CACHE_SLIDE_PAGE_ATTR_NO_REBASE 0x4000 // page has no rebasing
	121	#define DYLD_CACHE_SLIDE_PAGE_ATTR_END 0x8000 // last chain entry for page
	122	#define DYLD_CACHE_SLIDE_PAGE_VALUE 0x3FFF // bitwise negation of DYLD_CACHE_SLIDE_PAGE_ATTRS
	123	#define DYLD_CACHE_SLIDE_PAGE_OFFSET_SHIFT 2
39037602	124
d9a64523	125	typedef struct vm_shared_region_slide_info_entry_v3 *vm_shared_region_slide_info_entry_v3_t;
0a7de745 A	126	struct vm_shared_region_slide_info_entry_v3 {
	127	uint32_t version; // currently 3
	128	uint32_t page_size; // currently 4096 (may also be 16384)
	129	uint32_t page_starts_count;
	130	uint64_t value_add;
	131	uint16_t page_starts[] /* page_starts_count */;
d9a64523 A	132	};
d9a64523 A	133
0a7de745	134	#define DYLD_CACHE_SLIDE_V3_PAGE_ATTR_NO_REBASE 0xFFFF // page has no rebasing
d9a64523 A	135
	136
	137	typedef struct vm_shared_region_slide_info_entry_v4 *vm_shared_region_slide_info_entry_v4_t;
	138	struct vm_shared_region_slide_info_entry_v4 {
0a7de745 A	139	uint32_t version; // currently 4
	140	uint32_t page_size; // currently 4096 (may also be 16384)
	141	uint32_t page_starts_offset;
	142	uint32_t page_starts_count;
	143	uint32_t page_extras_offset;
	144	uint32_t page_extras_count;
	145	uint64_t delta_mask; // which (contiguous) set of bits contains the delta to the next rebase location (0xC0000000)
	146	uint64_t value_add; // base address of cache
	147	// uint16_t page_starts[page_starts_count];
	148	// uint16_t page_extras[page_extras_count];
d9a64523 A	149	};
	150
	151	#define DYLD_CACHE_SLIDE4_PAGE_NO_REBASE 0xFFFF // page has no rebasing
	152	#define DYLD_CACHE_SLIDE4_PAGE_INDEX 0x7FFF // index into starts or extras
	153	#define DYLD_CACHE_SLIDE4_PAGE_USE_EXTRA 0x8000 // index is into extras array (not starts array)
	154	#define DYLD_CACHE_SLIDE4_PAGE_EXTRA_END 0x8000 // last chain entry for page
	155
	156
	157
39037602 A	158	typedef union vm_shared_region_slide_info_entry *vm_shared_region_slide_info_entry_t;
39037602 A	159	union vm_shared_region_slide_info_entry {
f427ee49 A	160	uint32_t version;
	161	struct vm_shared_region_slide_info_entry_v2 v2;
	162	struct vm_shared_region_slide_info_entry_v3 v3;
0a7de745	163	struct vm_shared_region_slide_info_entry_v4 v4;
39037602 A	164	};
39037602 A	165
f427ee49 A	166	#define MIN_SLIDE_INFO_SIZE \
	167	MIN(sizeof(struct vm_shared_region_slide_info_entry_v2), \
	168	MIN(sizeof(struct vm_shared_region_slide_info_entry_v3), \
	169	sizeof(struct vm_shared_region_slide_info_entry_v4)))
	170
	171	/*
	172	* This is the information used by the shared cache pager for sub-sections
	173	* which must be modified for relocations and/or pointer authentications
	174	* before it can be used. The shared_region_pager gets source pages from
	175	* the shared cache file and modifies them -- see shared_region_pager_data_request().
	176	*
	177	* A single pager may be used from multiple shared regions provided:
	178	* - same si_slide_object, si_start, si_end, si_slide, si_ptrauth and si_jop_key
	179	* - The size and contents of si_slide_info_entry are the same.
	180	*/
	181	typedef struct vm_shared_region_slide_info {
	182	uint32_t si_slide; /* the distance that the file data is relocated */
	183	bool si_slid;
	184	#if __has_feature(ptrauth_calls)
	185	bool si_ptrauth;
	186	uint64_t si_jop_key;
	187	struct vm_shared_region si_shared_region; / so we can ref/dealloc for authenticated slide info */
	188	#endif /* __has_feature(ptrauth_calls) */
	189	mach_vm_address_t si_slid_address;
	190	mach_vm_offset_t si_start; /* start offset in si_slide_object */
	191	mach_vm_offset_t si_end;
	192	vm_object_t si_slide_object; /* The source object for the pages to be modified */
	193	mach_vm_size_t si_slide_info_size; /* size of dyld provided relocation information */
	194	vm_shared_region_slide_info_entry_t si_slide_info_entry; /* dyld provided relocation information */
	195	} *vm_shared_region_slide_info_t;
6d2010ae	196
f427ee49 A	197	/*
	198	* Data structure that represents a unique shared cache region.
	199	*/
39236c6e	200	struct vm_shared_region {
0a7de745	201	uint32_t sr_ref_count;
f427ee49	202	uint32_t sr_slide;
0a7de745 A	203	queue_chain_t sr_q;
	204	void *sr_root_dir;
	205	cpu_type_t sr_cpu_type;
	206	cpu_subtype_t sr_cpu_subtype;
0a7de745 A	207	ipc_port_t sr_mem_entry;
	208	mach_vm_offset_t sr_first_mapping;
	209	mach_vm_offset_t sr_base_address;
	210	mach_vm_size_t sr_size;
	211	mach_vm_offset_t sr_pmap_nesting_start;
	212	mach_vm_size_t sr_pmap_nesting_size;
	213	thread_call_t sr_timer_call;
0a7de745	214	uuid_t sr_uuid;
f427ee49 A	215
	216	bool sr_mapping_in_progress;
	217	bool sr_slide_in_progress;
	218	bool sr_64bit;
	219	bool sr_persists;
	220	bool sr_uuid_copied;
	221	bool sr_stale; /* This region should never be used again. */
	222
	223	#if __has_feature(ptrauth_calls)
	224	bool sr_reslide; /* Special shared region for suspected attacked processes */
	225	#define NUM_SR_AUTH_SECTIONS 2
	226	vm_shared_region_slide_info_t sr_auth_section[NUM_SR_AUTH_SECTIONS];
	227	uint_t sr_num_auth_section;
	228	#endif /* __has_feature(ptrauth_calls) */
	229
0a7de745	230	uint32_t sr_images_count;
d9a64523	231	struct dyld_uuid_info_64 *sr_images;
39236c6e	232	};
6d2010ae	233
f427ee49 A	234	extern kern_return_t vm_shared_region_slide_page(
	235	vm_shared_region_slide_info_t si,
	236	vm_offset_t vaddr,
	237	mach_vm_offset_t uservaddr,
	238	uint32_t pageIndex,
	239	uint64_t jop_key);
	240	extern uint64_t shared_region_find_key(char *shared_region_id);
2d21ac55 A	241	#else /* !MACH_KERNEL_PRIVATE */
	242
	243	struct vm_shared_region;
6d2010ae A	244	struct vm_shared_region_slide_info;
	245	struct vm_shared_region_slide_info_entry;
	246	struct slide_info_entry_toc;
2d21ac55 A	247
	248	#endif /* MACH_KERNEL_PRIVATE */
	249
f427ee49 A	250	struct _sr_file_mappings {
	251	int fd;
	252	uint32_t mappings_count;
	253	struct shared_file_mapping_slide_np *mappings;
	254	uint32_t slide;
	255	struct fileproc *fp;
	256	struct vnode *vp;
	257	memory_object_size_t file_size;
	258	memory_object_control_t file_control;
	259	};
	260
2d21ac55 A	261	extern void vm_shared_region_init(void);
2d21ac55 A	262	extern kern_return_t vm_shared_region_enter(
0a7de745 A	263	struct _vm_map *map,
	264	struct task *task,
	265	boolean_t is_64bit,
	266	void *fsroot,
	267	cpu_type_t cpu,
f427ee49 A	268	cpu_subtype_t cpu_subtype,
f427ee49 A	269	boolean_t reslide);
2d21ac55	270	extern kern_return_t vm_shared_region_remove(
0a7de745 A	271	struct _vm_map *map,
0a7de745 A	272	struct task *task);
2d21ac55	273	extern vm_shared_region_t vm_shared_region_get(
0a7de745	274	struct task *task);
d9a64523	275	extern vm_shared_region_t vm_shared_region_trim_and_get(
0a7de745	276	struct task *task);
2d21ac55	277	extern void vm_shared_region_deallocate(
0a7de745	278	struct vm_shared_region *shared_region);
2d21ac55	279	extern mach_vm_offset_t vm_shared_region_base_address(
0a7de745	280	struct vm_shared_region *shared_region);
2d21ac55	281	extern mach_vm_size_t vm_shared_region_size(
0a7de745	282	struct vm_shared_region *shared_region);
2d21ac55	283	extern ipc_port_t vm_shared_region_mem_entry(
0a7de745	284	struct vm_shared_region *shared_region);
d9a64523	285	extern vm_map_t vm_shared_region_vm_map(
0a7de745	286	struct vm_shared_region *shared_region);
2d21ac55	287	extern void vm_shared_region_set(
0a7de745 A	288	struct task *task,
0a7de745 A	289	struct vm_shared_region *new_shared_region);
2d21ac55	290	extern vm_shared_region_t vm_shared_region_lookup(
0a7de745 A	291	void *root_dir,
	292	cpu_type_t cpu,
	293	cpu_subtype_t cpu_subtype,
f427ee49 A	294	boolean_t is_64bit,
f427ee49 A	295	boolean_t reslide);
2d21ac55	296	extern kern_return_t vm_shared_region_start_address(
0a7de745 A	297	struct vm_shared_region *shared_region,
0a7de745 A	298	mach_vm_offset_t *start_address);
6d2010ae	299	extern void vm_shared_region_undo_mappings(
0a7de745 A	300	vm_map_t sr_map,
0a7de745 A	301	mach_vm_offset_t sr_base_address,
f427ee49 A	302	struct _sr_file_mappings *srf_mappings,
f427ee49 A	303	struct _sr_file_mappings *srf_mappings_count,
0a7de745	304	unsigned int mappings_count);
f427ee49	305	__attribute__((noinline))
2d21ac55	306	extern kern_return_t vm_shared_region_map_file(
0a7de745	307	struct vm_shared_region *shared_region,
f427ee49 A	308	int sr_mappings_count,
f427ee49 A	309	struct _sr_file_mappings *sr_mappings);
2a1bd2d3 A	310	extern void *vm_shared_region_root_dir(
2a1bd2d3 A	311	struct vm_shared_region *shared_region);
6d2010ae	312	extern kern_return_t vm_shared_region_sliding_valid(uint32_t slide);
2d21ac55	313	extern void vm_commpage_init(void);
316670eb	314	extern void vm_commpage_text_init(void);
2d21ac55	315	extern kern_return_t vm_commpage_enter(
0a7de745 A	316	struct _vm_map *map,
	317	struct task *task,
	318	boolean_t is64bit);
2d21ac55	319	extern kern_return_t vm_commpage_remove(
0a7de745 A	320	struct _vm_map *map,
	321	struct task *task);
	322	int vm_shared_region_slide(uint32_t,
	323	mach_vm_offset_t,
	324	mach_vm_size_t,
	325	mach_vm_offset_t,
	326	mach_vm_size_t,
	327	mach_vm_offset_t,
f427ee49 A	328	memory_object_control_t,
	329	vm_prot_t);
	330	extern void vm_shared_region_pivot(void);
	331	extern void vm_shared_region_reslide_stale(void);
	332	#if __has_feature(ptrauth_calls)
	333	__attribute__((noinline))
	334	extern kern_return_t vm_shared_region_auth_remap(vm_shared_region_t sr);
	335	#endif /* __has_feature(ptrauth_calls) */
	336	extern void vm_shared_region_reference(vm_shared_region_t sr);
2d21ac55 A	337
	338	#endif /* KERNEL_PRIVATE */
	339
0a7de745	340	#endif /* _VM_SHARED_REGION_H_ */