/* * Copyright (c) 2000-2018 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_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. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. * * 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_OSREFERENCE_LICENSE_HEADER_END@ */ /* * @OSF_COPYRIGHT@ * */ #ifndef _MACH_VM_TYPES_H_ #define _MACH_VM_TYPES_H_ #include #include #include #include __BEGIN_DECLS typedef vm_offset_t pointer_t __kernel_ptr_semantics; typedef vm_offset_t vm_address_t __kernel_ptr_semantics; /* * We use addr64_t for 64-bit addresses that are used on both * 32 and 64-bit machines. On PPC, they are passed and returned as * two adjacent 32-bit GPRs. We use addr64_t in places where * common code must be useable both on 32 and 64-bit machines. */ typedef uint64_t addr64_t; /* Basic effective address */ /* * We use reg64_t for addresses that are 32 bits on a 32-bit * machine, and 64 bits on a 64-bit machine, but are always * passed and returned in a single GPR on PPC. This type * cannot be used in generic 32-bit c, since on a 64-bit * machine the upper half of the register will be ignored * by the c compiler in 32-bit mode. In c, we can only use the * type in prototypes of functions that are written in and called * from assembly language. This type is basically a comment. */ typedef uint32_t reg64_t; /* * To minimize the use of 64-bit fields, we keep some physical * addresses (that are page aligned) as 32-bit page numbers. * This limits the physical address space to 16TB of RAM. */ typedef uint32_t ppnum_t __kernel_ptr_semantics; /* Physical page number */ #define PPNUM_MAX UINT32_MAX #ifdef KERNEL_PRIVATE __options_decl(vm_map_create_options_t, uint32_t, { VM_MAP_CREATE_DEFAULT = 0x00000000, VM_MAP_CREATE_PAGEABLE = 0x00000001, VM_MAP_CREATE_CORPSE_FOOTPRINT = 0x00000002, VM_MAP_CREATE_DISABLE_HOLELIST = 0x00000004, VM_MAP_CREATE_NEVER_FAULTS = 0x00000008, /* Denote that we're creating this map as part of a fork() */ VM_MAP_CREATE_VIA_FORK = 0x00000010, }); /* * Use specifically typed null structures for these in * other parts of the kernel to enable compiler warnings * about type mismatches, etc... Otherwise, these would * be void*. */ typedef struct pmap *pmap_t; typedef struct _vm_map *vm_map_t, *vm_map_read_t, *vm_map_inspect_t; typedef struct vm_object *vm_object_t; typedef struct vm_object_fault_info *vm_object_fault_info_t; typedef struct upl *upl_t; typedef struct vm_map_copy *vm_map_copy_t; typedef struct vm_named_entry *vm_named_entry_t; typedef struct vm_page *vm_page_t; /* * A generation ID for vm_maps, which increments monotonically. * These IDs are not globally unique among VM maps, however. Instead, * IDs represent 'independent' VM map lineages: maps interrelated via * fork() identify with the same ID. */ typedef const void *vm_map_serial_t; #define PMAP_NULL ((pmap_t) NULL) #define VM_OBJECT_NULL ((vm_object_t) NULL) #define VM_MAP_COPY_NULL ((vm_map_copy_t) NULL) #define VM_MAP_SERIAL_NONE ((vm_map_serial_t)-1) /* Denotes 'special'/one-off kernel-managed objects that don't belong to a parent map */ #define VM_MAP_SERIAL_SPECIAL ((vm_map_serial_t)-2) #else /* KERNEL_PRIVATE */ typedef mach_port_t vm_map_t, vm_map_read_t, vm_map_inspect_t; typedef mach_port_t upl_t; typedef mach_port_t vm_named_entry_t; #endif /* KERNEL_PRIVATE */ typedef mach_vm_offset_t *mach_vm_offset_list_t; #ifdef KERNEL #define VM_MAP_NULL ((vm_map_t) NULL) #define VM_MAP_INSPECT_NULL ((vm_map_inspect_t) NULL) #define VM_MAP_READ_NULL ((vm_map_read_t) NULL) #define UPL_NULL ((upl_t) NULL) #define VM_NAMED_ENTRY_NULL ((vm_named_entry_t) NULL) #else #define VM_MAP_NULL ((vm_map_t) 0) #define VM_MAP_INSPECT_NULL ((vm_map_inspect_t) 0) #define VM_MAP_READ_NULL ((vm_map_read_t) 0) #define UPL_NULL ((upl_t) 0) #define VM_NAMED_ENTRY_NULL ((vm_named_entry_t) 0) #endif /* * Evolving definitions, likely to change. */ typedef uint64_t vm_object_offset_t; typedef uint64_t vm_object_size_t; /*! * @typedef mach_vm_range_t * * @brief * Pair of a min/max address used to denote a memory region. * * @discussion * @c min_address must be smaller or equal to @c max_address. */ typedef struct mach_vm_range { mach_vm_offset_t min_address; mach_vm_offset_t max_address; } *mach_vm_range_t; /*! * @enum mach_vm_range_flavor_t * * @brief * A flavor for the mach_vm_range_create() call. * * @const MACH_VM_RANGE_FLAVOR_V1 * The recipe is an array of @c mach_vm_range_recipe_v1_t. */ __enum_decl(mach_vm_range_flavor_t, uint32_t, { MACH_VM_RANGE_FLAVOR_INVALID, MACH_VM_RANGE_FLAVOR_V1, }); /*! * @enum mach_vm_range_flags_t * * @brief * Flags used to alter the behavior of a Mach VM Range. */ __options_decl(mach_vm_range_flags_t, uint64_t, { MACH_VM_RANGE_NONE = 0x000000000000, }); /*! * @enum mach_vm_range_tag_t * * @brief * A tag to denote the semantics of a given Mach VM Range. * * @const MACH_VM_RANGE_DEFAULT * The tag associated with the general VA space usable * before the shared cache. * Such a range can't be made by userspace. * * @const MACH_VM_RANGE_DATA * The tag associated with the anonymous randomly slid * range of data heap optionally made when a process is created. * Such a range can't be made by userspace. * * @const MACH_VM_RANGE_FIXED * The tag associated with ranges that are made available * for @c VM_FLAGS_FIXED allocations, but that the VM will never * autonomously serve from a @c VM_FLAGS_ANYWHERE kind of request. * This really create a delegated piece of VA that can be carved out * in the way userspace sees fit. */ __enum_decl(mach_vm_range_tag_t, uint16_t, { MACH_VM_RANGE_DEFAULT, MACH_VM_RANGE_DATA, MACH_VM_RANGE_FIXED, }); #pragma pack(1) typedef struct { mach_vm_range_flags_t flags: 48; mach_vm_range_tag_t range_tag : 8; uint8_t vm_tag : 8; struct mach_vm_range range; } mach_vm_range_recipe_v1_t; #pragma pack() #define MACH_VM_RANGE_FLAVOR_DEFAULT MACH_VM_RANGE_FLAVOR_V1 typedef mach_vm_range_recipe_v1_t mach_vm_range_recipe_t; typedef uint8_t *mach_vm_range_recipes_raw_t; #ifdef PRIVATE typedef struct { uint64_t rtfabstime; // mach_continuous_time at start of fault uint64_t rtfduration; // fault service duration uint64_t rtfaddr; // fault address uint64_t rtfpc; // userspace program counter of thread incurring the fault uint64_t rtftid; // thread ID uint64_t rtfupid; // process identifier uint64_t rtftype; // fault type } vm_rtfault_record_t; #endif /* PRIVATE */ #ifdef XNU_KERNEL_PRIVATE #define VM_TAG_ACTIVE_UPDATE 1 typedef uint16_t vm_tag_t; #define VM_TAG_NAME_LEN_MAX 0x7F #define VM_TAG_NAME_LEN_SHIFT 0 #define VM_TAG_UNLOAD 0x0100 #define VM_TAG_KMOD 0x0200 #if !KASAN && (DEBUG || DEVELOPMENT) /* * To track the utilization of memory at every kalloc callsite, zone tagging * allocates an array of stats (of size VM_TAG_SIZECLASSES), one for each * size class exposed by kalloc. * * If VM_TAG_SIZECLASSES is modified ensure that z_tags_sizeclass * has sufficient bits to represent all values (max value exclusive). */ #define VM_TAG_SIZECLASSES 36 // must be multiple of 64 #define VM_MAX_TAG_VALUE 1536 #else #define VM_TAG_SIZECLASSES 0 #define VM_MAX_TAG_VALUE 256 #endif #define ARRAY_COUNT(a) (sizeof((a)) / sizeof((a)[0])) struct vm_allocation_total { vm_tag_t tag; uint64_t total; }; struct vm_allocation_zone_total { vm_size_t vazt_total; vm_size_t vazt_peak; }; typedef struct vm_allocation_zone_total vm_allocation_zone_total_t; struct vm_allocation_site { uint64_t total; #if DEBUG || DEVELOPMENT uint64_t peak; #endif /* DEBUG || DEVELOPMENT */ uint64_t mapped; int16_t refcount; vm_tag_t tag; uint16_t flags; uint16_t subtotalscount; struct vm_allocation_total subtotals[0]; /* char name[0]; -- this is placed after subtotals, see KA_NAME() */ }; typedef struct vm_allocation_site vm_allocation_site_t; extern int vmrtf_extract(uint64_t, boolean_t, unsigned long, void *, unsigned long *); extern unsigned int vmrtfaultinfo_bufsz(void); #endif /* XNU_KERNEL_PRIVATE */ __END_DECLS #endif /* _MACH_VM_TYPES_H_ */