/*
* 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
/*
* Note the shared region size here seems odd for x86.
* The size is chosen to end the address space at a boundary
* that the arm64 pmap uses for pmap->max. We use this
* limit to prevent problems with Rosetta. Given how large
* the region is now, the few fewer megabytes shouldn't matter.
*/
#define SHARED_REGION_BASE_X86_64 0x00007FF800000000ULL
#define SHARED_REGION_SIZE_X86_64 0x00000007FE000000ULL
#define SHARED_REGION_NESTING_BASE_X86_64 0x00007FF800000000ULL
#define SHARED_REGION_NESTING_SIZE_X86_64 0x00000007FE000000ULL
#define SHARED_REGION_NESTING_MIN_X86_64 0x0000000000200000ULL
#define SHARED_REGION_NESTING_MAX_X86_64 0xFFFFFFFFFFE00000ULL
#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 0x88000000ULL /* up to 0xA2000000 */
#define SHARED_REGION_NESTING_BASE_ARM64_32 0x1A000000ULL
#define SHARED_REGION_NESTING_SIZE_ARM64_32 0x88000000ULL
#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 0x180000000ULL
#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);
/*
* RSR interfaces for use by APFS
*/
extern boolean_t (*rsr_check_vnode)(void *vnode);
extern uint32_t rsr_get_version(void);
extern void rsr_bump_version(void);
#endif /* KERNEL_PRIVATE */
/*
* The shared_region_* declarations are a private interface between dyld and the kernel.
*/
/*
* This was used for the no longer present shared_region_map_and_slide_np() interface.
* The struct got used by other external projects to represent shared cache info, so
* it's left behind for now.
*/
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 {
/* address at which to create mapping */
mach_vm_address_t sms_address __kernel_data_semantics;
/* size of region to map */
mach_vm_size_t sms_size;
/* offset into file to be mapped */
mach_vm_offset_t sms_file_offset __kernel_data_semantics;
/* size of data at sms_slide_start */
user_addr_t sms_slide_size;
/* address from which to get relocation data */
user_addr_t sms_slide_start;
/* protections, plus flags, see below */
vm_prot_t sms_max_prot;
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_ */