[apple/xnu.git] / osfmk / mach / 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: mach/shared_region.h
 *
 *      protos and struct definitions for shared region
 */

#ifndef _MACH_SHARED_REGION_H_
#define _MACH_SHARED_REGION_H_

#include <sys/cdefs.h>
#include <mach/vm_prot.h>
#include <mach/vm_types.h>
#include <mach/mach_types.h>

#define SHARED_REGION_BASE_I386                 0x90000000ULL
#define SHARED_REGION_SIZE_I386                 0x20000000ULL
#define SHARED_REGION_NESTING_BASE_I386         0x90000000ULL
#define SHARED_REGION_NESTING_SIZE_I386         0x20000000ULL
#define SHARED_REGION_NESTING_MIN_I386          0x00200000ULL
#define SHARED_REGION_NESTING_MAX_I386          0xFFE00000ULL

#define SHARED_REGION_BASE_X86_64               0x00007FFF00000000ULL
#define SHARED_REGION_SIZE_X86_64               0x00000000FFE00000ULL
#define SHARED_REGION_NESTING_BASE_X86_64       0x00007FFF00000000ULL
#define SHARED_REGION_NESTING_SIZE_X86_64       0x00000000FFE00000ULL
#define SHARED_REGION_NESTING_MIN_X86_64        0x0000000000200000ULL
#define SHARED_REGION_NESTING_MAX_X86_64        0xFFFFFFFFFFE00000ULL

#ifdef XNU_KERNEL_PRIVATE
#endif

#define SHARED_REGION_BASE_PPC                  0x90000000ULL
#define SHARED_REGION_SIZE_PPC                  0x20000000ULL
#define SHARED_REGION_NESTING_BASE_PPC          0x90000000ULL
#define SHARED_REGION_NESTING_SIZE_PPC          0x10000000ULL
#define SHARED_REGION_NESTING_MIN_PPC           0x10000000ULL
#define SHARED_REGION_NESTING_MAX_PPC           0x10000000ULL

#define SHARED_REGION_BASE_PPC64                0x00007FFF60000000ULL
#define SHARED_REGION_SIZE_PPC64                0x00000000A0000000ULL
#define SHARED_REGION_NESTING_BASE_PPC64        0x00007FFF60000000ULL
#define SHARED_REGION_NESTING_SIZE_PPC64        0x00000000A0000000ULL
#define SHARED_REGION_NESTING_MIN_PPC64         0x0000000010000000ULL
#define SHARED_REGION_NESTING_MAX_PPC64         0x0000000010000000ULL

#define SHARED_REGION_BASE_ARM                  0x40000000ULL
#define SHARED_REGION_SIZE_ARM                  0x40000000ULL
#define SHARED_REGION_NESTING_BASE_ARM          0x40000000ULL
#define SHARED_REGION_NESTING_SIZE_ARM          0x40000000ULL
#define SHARED_REGION_NESTING_MIN_ARM           ?
#define SHARED_REGION_NESTING_MAX_ARM           ?

#define SHARED_REGION_BASE_ARM64_32             0x1A000000ULL
#define SHARED_REGION_SIZE_ARM64_32             0x40000000ULL
#define SHARED_REGION_NESTING_BASE_ARM64_32     0x1A000000ULL
#define SHARED_REGION_NESTING_SIZE_ARM64_32     0x40000000ULL
#define SHARED_REGION_NESTING_MIN_ARM64_32      ?
#define SHARED_REGION_NESTING_MAX_ARM64_32      ?

#ifdef XNU_KERNEL_PRIVATE
/* ARM64_TODO: move to higher memory */
#endif
#define SHARED_REGION_BASE_ARM64                0x180000000ULL
#define SHARED_REGION_SIZE_ARM64                0x100000000ULL
#define SHARED_REGION_NESTING_BASE_ARM64        SHARED_REGION_BASE_ARM64
#define SHARED_REGION_NESTING_SIZE_ARM64        SHARED_REGION_SIZE_ARM64
#define SHARED_REGION_NESTING_MIN_ARM64         ?
#define SHARED_REGION_NESTING_MAX_ARM64         ?

#if defined(__i386__)
#define SHARED_REGION_BASE                      SHARED_REGION_BASE_I386
#define SHARED_REGION_SIZE                      SHARED_REGION_SIZE_I386
#define SHARED_REGION_NESTING_BASE              SHARED_REGION_NESTING_BASE_I386
#define SHARED_REGION_NESTING_SIZE              SHARED_REGION_NESTING_SIZE_I386
#define SHARED_REGION_NESTING_MIN               SHARED_REGION_NESTING_MIN_I386
#define SHARED_REGION_NESTING_MAX               SHARED_REGION_NESTING_MAX_I386
#elif defined(__x86_64__)
#define SHARED_REGION_BASE                      SHARED_REGION_BASE_X86_64
#define SHARED_REGION_SIZE                      SHARED_REGION_SIZE_X86_64
#define SHARED_REGION_NESTING_BASE              SHARED_REGION_NESTING_BASE_X86_64
#define SHARED_REGION_NESTING_SIZE              SHARED_REGION_NESTING_SIZE_X86_64
#define SHARED_REGION_NESTING_MIN               SHARED_REGION_NESTING_MIN_X86_64
#define SHARED_REGION_NESTING_MAX               SHARED_REGION_NESTING_MAX_X86_64
#elif defined(__arm__)
#define SHARED_REGION_BASE                      SHARED_REGION_BASE_ARM
#define SHARED_REGION_SIZE                      SHARED_REGION_SIZE_ARM
#define SHARED_REGION_NESTING_BASE              SHARED_REGION_NESTING_BASE_ARM
#define SHARED_REGION_NESTING_SIZE              SHARED_REGION_NESTING_SIZE_ARM
#define SHARED_REGION_NESTING_MIN               SHARED_REGION_NESTING_MIN_ARM
#define SHARED_REGION_NESTING_MAX               SHARED_REGION_NESTING_MAX_ARM
#elif defined(__arm64__) && !defined(__LP64__)
#define SHARED_REGION_BASE                      SHARED_REGION_BASE_ARM64_32
#define SHARED_REGION_SIZE                      SHARED_REGION_SIZE_ARM64_32
#define SHARED_REGION_NESTING_BASE              SHARED_REGION_NESTING_BASE_ARM64_32
#define SHARED_REGION_NESTING_SIZE              SHARED_REGION_NESTING_SIZE_ARM64_32
#define SHARED_REGION_NESTING_MIN               SHARED_REGION_NESTING_MIN_ARM64_32
#define SHARED_REGION_NESTING_MAX               SHARED_REGION_NESTING_MAX_ARM64_32
#elif defined(__arm64__) && defined(__LP64__)
#define SHARED_REGION_BASE                      SHARED_REGION_BASE_ARM64
#define SHARED_REGION_SIZE                      SHARED_REGION_SIZE_ARM64
#define SHARED_REGION_NESTING_BASE              SHARED_REGION_NESTING_BASE_ARM64
#define SHARED_REGION_NESTING_SIZE              SHARED_REGION_NESTING_SIZE_ARM64
#define SHARED_REGION_NESTING_MIN               SHARED_REGION_NESTING_MIN_ARM64
#define SHARED_REGION_NESTING_MAX               SHARED_REGION_NESTING_MAX_ARM64
#endif

#ifdef KERNEL_PRIVATE

/*
 * This is routine sets  the current source of power.
 * Arguments:
 * 0 if it is external source (connected to power )
 * 1 if it is internal power source ie battery
 */

void post_sys_powersource(int);

#endif /* KERNEL_PRIVATE */
/*
 * The shared_region_* declarations are a private interface between dyld and the kernel.
 */

/*
 * This is used by legacy shared_region_map_and_slide_np() interface.
 * We build a shared_file_mapping_slide_np from this.
 */
struct shared_file_mapping_np {
	mach_vm_address_t       sfm_address;
	mach_vm_size_t          sfm_size;
	mach_vm_offset_t        sfm_file_offset;
	vm_prot_t               sfm_max_prot;
	vm_prot_t               sfm_init_prot;
};

struct shared_file_mapping_slide_np {
	mach_vm_address_t       sms_address;     /* address at which to create mapping */
	mach_vm_size_t          sms_size;        /* size of region to map */
	mach_vm_offset_t        sms_file_offset; /* offset into file to be mapped */
	user_addr_t             sms_slide_size;  /* size of data at sms_slide_start */
	user_addr_t             sms_slide_start; /* address from which to get relocation data */
	vm_prot_t               sms_max_prot;    /* protections, plus flags, see below */
	vm_prot_t               sms_init_prot;
};
struct shared_file_np {
	int                     sf_fd;             /* file to be mapped into shared region */
	uint32_t                sf_mappings_count; /* number of mappings */
	uint32_t                sf_slide;          /* distance in bytes of the slide */
};

/*
 * Extensions to sfm_max_prot that identify how to handle each mapping.
 * These must not interfere with normal prot assignments.
 *
 * VM_PROT_COW    - copy on write pages
 *
 * VM_PROT_ZF     - zero fill pages
 *
 * VM_PROT_SLIDE  - file pages which require relocation and, on arm64e, signing
 *                  these will be unique per shared region.
 *
 * VM_PROT_NOAUTH - file pages which don't require signing. When combined
 *                  with VM_PROT_SLIDE, pages are shareable across different
 *                  shared regions which map the same file with the same relocation info.
 */
#define VM_PROT_COW                      0x08
#define VM_PROT_ZF                       0x10
#define VM_PROT_SLIDE                    0x20
#define VM_PROT_NOAUTH                   0x40
#define VM_PROT_TRANSLATED_ALLOW_EXECUTE 0x80

#ifndef KERNEL

__BEGIN_DECLS
int     shared_region_check_np(uint64_t *startaddress);
int     shared_region_map_np(int fd,
    uint32_t mappingCount,
    const struct shared_file_mapping_np *mappings);
int     shared_region_slide_np(void);
__END_DECLS

#endif /* !KERNEL */

#endif /* _MACH_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: mach/shared_region.h
	26	*
0a7de745	27	* protos and struct definitions for shared region
2d21ac55 A	28	*/
	29
	30	#ifndef _MACH_SHARED_REGION_H_
	31	#define _MACH_SHARED_REGION_H_
	32
	33	#include <sys/cdefs.h>
	34	#include <mach/vm_prot.h>
	35	#include <mach/vm_types.h>
	36	#include <mach/mach_types.h>
	37
0a7de745 A	38	#define SHARED_REGION_BASE_I386 0x90000000ULL
	39	#define SHARED_REGION_SIZE_I386 0x20000000ULL
	40	#define SHARED_REGION_NESTING_BASE_I386 0x90000000ULL
	41	#define SHARED_REGION_NESTING_SIZE_I386 0x20000000ULL
	42	#define SHARED_REGION_NESTING_MIN_I386 0x00200000ULL
	43	#define SHARED_REGION_NESTING_MAX_I386 0xFFE00000ULL
	44
	45	#define SHARED_REGION_BASE_X86_64 0x00007FFF00000000ULL
	46	#define SHARED_REGION_SIZE_X86_64 0x00000000FFE00000ULL
	47	#define SHARED_REGION_NESTING_BASE_X86_64 0x00007FFF00000000ULL
	48	#define SHARED_REGION_NESTING_SIZE_X86_64 0x00000000FFE00000ULL
	49	#define SHARED_REGION_NESTING_MIN_X86_64 0x0000000000200000ULL
	50	#define SHARED_REGION_NESTING_MAX_X86_64 0xFFFFFFFFFFE00000ULL
	51
f427ee49 A	52	#ifdef XNU_KERNEL_PRIVATE
	53	#endif
	54
0a7de745 A	55	#define SHARED_REGION_BASE_PPC 0x90000000ULL
	56	#define SHARED_REGION_SIZE_PPC 0x20000000ULL
	57	#define SHARED_REGION_NESTING_BASE_PPC 0x90000000ULL
	58	#define SHARED_REGION_NESTING_SIZE_PPC 0x10000000ULL
	59	#define SHARED_REGION_NESTING_MIN_PPC 0x10000000ULL
	60	#define SHARED_REGION_NESTING_MAX_PPC 0x10000000ULL
	61
	62	#define SHARED_REGION_BASE_PPC64 0x00007FFF60000000ULL
	63	#define SHARED_REGION_SIZE_PPC64 0x00000000A0000000ULL
	64	#define SHARED_REGION_NESTING_BASE_PPC64 0x00007FFF60000000ULL
	65	#define SHARED_REGION_NESTING_SIZE_PPC64 0x00000000A0000000ULL
	66	#define SHARED_REGION_NESTING_MIN_PPC64 0x0000000010000000ULL
	67	#define SHARED_REGION_NESTING_MAX_PPC64 0x0000000010000000ULL
	68
94ff46dc A	69	#define SHARED_REGION_BASE_ARM 0x40000000ULL
	70	#define SHARED_REGION_SIZE_ARM 0x40000000ULL
	71	#define SHARED_REGION_NESTING_BASE_ARM 0x40000000ULL
	72	#define SHARED_REGION_NESTING_SIZE_ARM 0x40000000ULL
0a7de745 A	73	#define SHARED_REGION_NESTING_MIN_ARM ?
0a7de745 A	74	#define SHARED_REGION_NESTING_MAX_ARM ?
2d21ac55	75
cb323159 A	76	#define SHARED_REGION_BASE_ARM64_32 0x1A000000ULL
	77	#define SHARED_REGION_SIZE_ARM64_32 0x40000000ULL
	78	#define SHARED_REGION_NESTING_BASE_ARM64_32 0x1A000000ULL
	79	#define SHARED_REGION_NESTING_SIZE_ARM64_32 0x40000000ULL
	80	#define SHARED_REGION_NESTING_MIN_ARM64_32 ?
	81	#define SHARED_REGION_NESTING_MAX_ARM64_32 ?
d9a64523	82
fe8ab488 A	83	#ifdef XNU_KERNEL_PRIVATE
	84	/* ARM64_TODO: move to higher memory */
	85	#endif
0a7de745 A	86	#define SHARED_REGION_BASE_ARM64 0x180000000ULL
0a7de745 A	87	#define SHARED_REGION_SIZE_ARM64 0x100000000ULL
f427ee49 A	88	#define SHARED_REGION_NESTING_BASE_ARM64 SHARED_REGION_BASE_ARM64
f427ee49 A	89	#define SHARED_REGION_NESTING_SIZE_ARM64 SHARED_REGION_SIZE_ARM64
0a7de745 A	90	#define SHARED_REGION_NESTING_MIN_ARM64 ?
0a7de745 A	91	#define SHARED_REGION_NESTING_MAX_ARM64 ?
fe8ab488	92
b0d623f7	93	#if defined(__i386__)
0a7de745 A	94	#define SHARED_REGION_BASE SHARED_REGION_BASE_I386
	95	#define SHARED_REGION_SIZE SHARED_REGION_SIZE_I386
	96	#define SHARED_REGION_NESTING_BASE SHARED_REGION_NESTING_BASE_I386
	97	#define SHARED_REGION_NESTING_SIZE SHARED_REGION_NESTING_SIZE_I386
	98	#define SHARED_REGION_NESTING_MIN SHARED_REGION_NESTING_MIN_I386
	99	#define SHARED_REGION_NESTING_MAX SHARED_REGION_NESTING_MAX_I386
b0d623f7	100	#elif defined(__x86_64__)
0a7de745 A	101	#define SHARED_REGION_BASE SHARED_REGION_BASE_X86_64
	102	#define SHARED_REGION_SIZE SHARED_REGION_SIZE_X86_64
	103	#define SHARED_REGION_NESTING_BASE SHARED_REGION_NESTING_BASE_X86_64
	104	#define SHARED_REGION_NESTING_SIZE SHARED_REGION_NESTING_SIZE_X86_64
	105	#define SHARED_REGION_NESTING_MIN SHARED_REGION_NESTING_MIN_X86_64
	106	#define SHARED_REGION_NESTING_MAX SHARED_REGION_NESTING_MAX_X86_64
5ba3f43e	107	#elif defined(__arm__)
0a7de745 A	108	#define SHARED_REGION_BASE SHARED_REGION_BASE_ARM
	109	#define SHARED_REGION_SIZE SHARED_REGION_SIZE_ARM
	110	#define SHARED_REGION_NESTING_BASE SHARED_REGION_NESTING_BASE_ARM
	111	#define SHARED_REGION_NESTING_SIZE SHARED_REGION_NESTING_SIZE_ARM
	112	#define SHARED_REGION_NESTING_MIN SHARED_REGION_NESTING_MIN_ARM
	113	#define SHARED_REGION_NESTING_MAX SHARED_REGION_NESTING_MAX_ARM
cb323159 A	114	#elif defined(__arm64__) && !defined(__LP64__)
	115	#define SHARED_REGION_BASE SHARED_REGION_BASE_ARM64_32
	116	#define SHARED_REGION_SIZE SHARED_REGION_SIZE_ARM64_32
	117	#define SHARED_REGION_NESTING_BASE SHARED_REGION_NESTING_BASE_ARM64_32
	118	#define SHARED_REGION_NESTING_SIZE SHARED_REGION_NESTING_SIZE_ARM64_32
	119	#define SHARED_REGION_NESTING_MIN SHARED_REGION_NESTING_MIN_ARM64_32
	120	#define SHARED_REGION_NESTING_MAX SHARED_REGION_NESTING_MAX_ARM64_32
d9a64523	121	#elif defined(__arm64__) && defined(__LP64__)
0a7de745 A	122	#define SHARED_REGION_BASE SHARED_REGION_BASE_ARM64
	123	#define SHARED_REGION_SIZE SHARED_REGION_SIZE_ARM64
	124	#define SHARED_REGION_NESTING_BASE SHARED_REGION_NESTING_BASE_ARM64
	125	#define SHARED_REGION_NESTING_SIZE SHARED_REGION_NESTING_SIZE_ARM64
	126	#define SHARED_REGION_NESTING_MIN SHARED_REGION_NESTING_MIN_ARM64
	127	#define SHARED_REGION_NESTING_MAX SHARED_REGION_NESTING_MAX_ARM64
b0d623f7 A	128	#endif
	129
	130	#ifdef KERNEL_PRIVATE
	131
	132	/*
	133	* This is routine sets the current source of power.
	134	* Arguments:
	135	* 0 if it is external source (connected to power )
	136	* 1 if it is internal power source ie battery
	137	*/
	138
	139	void post_sys_powersource(int);
	140
	141	#endif /* KERNEL_PRIVATE */
0a7de745	142	/*
f427ee49 A	143	* The shared_region_* declarations are a private interface between dyld and the kernel.
	144	*/
	145
	146	/*
	147	* This is used by legacy shared_region_map_and_slide_np() interface.
	148	* We build a shared_file_mapping_slide_np from this.
2d21ac55 A	149	*/
2d21ac55 A	150	struct shared_file_mapping_np {
0a7de745 A	151	mach_vm_address_t sfm_address;
	152	mach_vm_size_t sfm_size;
	153	mach_vm_offset_t sfm_file_offset;
	154	vm_prot_t sfm_max_prot;
	155	vm_prot_t sfm_init_prot;
2d21ac55	156	};
f427ee49 A	157
	158	struct shared_file_mapping_slide_np {
	159	mach_vm_address_t sms_address; /* address at which to create mapping */
	160	mach_vm_size_t sms_size; /* size of region to map */
	161	mach_vm_offset_t sms_file_offset; /* offset into file to be mapped */
	162	user_addr_t sms_slide_size; /* size of data at sms_slide_start */
	163	user_addr_t sms_slide_start; /* address from which to get relocation data */
	164	vm_prot_t sms_max_prot; /* protections, plus flags, see below */
	165	vm_prot_t sms_init_prot;
	166	};
	167	struct shared_file_np {
	168	int sf_fd; /* file to be mapped into shared region */
	169	uint32_t sf_mappings_count; /* number of mappings */
	170	uint32_t sf_slide; /* distance in bytes of the slide */
	171	};
	172
	173	/*
	174	* Extensions to sfm_max_prot that identify how to handle each mapping.
	175	* These must not interfere with normal prot assignments.
	176	*
	177	* VM_PROT_COW - copy on write pages
	178	*
	179	* VM_PROT_ZF - zero fill pages
	180	*
	181	* VM_PROT_SLIDE - file pages which require relocation and, on arm64e, signing
	182	* these will be unique per shared region.
	183	*
	184	* VM_PROT_NOAUTH - file pages which don't require signing. When combined
	185	* with VM_PROT_SLIDE, pages are shareable across different
	186	* shared regions which map the same file with the same relocation info.
	187	*/
	188	#define VM_PROT_COW 0x08
	189	#define VM_PROT_ZF 0x10
	190	#define VM_PROT_SLIDE 0x20
	191	#define VM_PROT_NOAUTH 0x40
	192	#define VM_PROT_TRANSLATED_ALLOW_EXECUTE 0x80
2d21ac55 A	193
	194	#ifndef KERNEL
	195
	196	__BEGIN_DECLS
0a7de745 A	197	int shared_region_check_np(uint64_t *startaddress);
	198	int shared_region_map_np(int fd,
	199	uint32_t mappingCount,
	200	const struct shared_file_mapping_np *mappings);
	201	int shared_region_slide_np(void);
2d21ac55 A	202	__END_DECLS
	203
	204	#endif /* !KERNEL */
	205
	206	#endif /* _MACH_SHARED_REGION_H_ */