osfmk/vm/vm_shared_region.h

   1 /*
   2  * Copyright (c) 2007 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   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.
  12  *
  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.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  *
  25  *      File: vm/vm_shared_region.h
  26  *
  27  *      protos and struct definitions for shared region
  28  */
  29
  30 #ifndef _VM_SHARED_REGION_H_
  31 #define _VM_SHARED_REGION_H_
  32
  33 #ifdef  KERNEL_PRIVATE
  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;
  49 #define SHARED_REGION_DEBUG(args)               \
  50         MACRO_BEGIN                             \
  51         if (shared_region_debug) {              \
  52                 kprintf args;                   \
  53         }                                       \
  54         MACRO_END
  55 #else /* DEBUG */
  56 #define SHARED_REGION_DEBUG(args)
  57 #endif /* DEBUG */
  58
  59 extern int shared_region_trace_level;
  60 #define SHARED_REGION_TRACE_NONE_LVL            0 /* no trace */
  61 #define SHARED_REGION_TRACE_ERROR_LVL           1 /* trace abnormal events */
  62 #define SHARED_REGION_TRACE_INFO_LVL            2 /* trace all events */
  63 #define SHARED_REGION_TRACE_DEBUG_LVL           3 /* extra traces for debug */
  64 #define SHARED_REGION_TRACE(level, args)                \
  65         MACRO_BEGIN                                     \
  66         if (shared_region_trace_level >= level) {       \
  67                 printf args;                            \
  68         }                                               \
  69         MACRO_END
  70 #define SHARED_REGION_TRACE_NONE(args)
  71 #define SHARED_REGION_TRACE_ERROR(args)                         \
  72         MACRO_BEGIN                                             \
  73         SHARED_REGION_TRACE(SHARED_REGION_TRACE_ERROR_LVL,      \
  74                             args);                              \
  75         MACRO_END
  76 #define SHARED_REGION_TRACE_INFO(args)                          \
  77         MACRO_BEGIN                                             \
  78         SHARED_REGION_TRACE(SHARED_REGION_TRACE_INFO_LVL,       \
  79                             args);                              \
  80         MACRO_END
  81 #define SHARED_REGION_TRACE_DEBUG(args)                         \
  82         MACRO_BEGIN                                             \
  83         SHARED_REGION_TRACE(SHARED_REGION_TRACE_DEBUG_LVL,      \
  84                             args);                              \
  85         MACRO_END
  86
  87 typedef struct vm_shared_region *vm_shared_region_t;
  88
  89 #ifdef MACH_KERNEL_PRIVATE
  90
  91 #include <kern/queue.h>
  92 #include <vm/vm_object.h>
  93 #include <vm/memory_object.h>
  94
  95 #define PAGE_SIZE_FOR_SR_SLIDE  4096
  96
  97 /* Documentation for the slide info format can be found in the dyld project in
  98  * the file 'launch-cache/dyld_cache_format.h'. */
  99
 100 typedef struct vm_shared_region_slide_info_entry_v1 *vm_shared_region_slide_info_entry_v1_t;
 101 struct vm_shared_region_slide_info_entry_v1 {
 102         uint32_t        version;
 103         uint32_t        toc_offset;     // offset from start of header to table-of-contents
 104         uint32_t        toc_count;      // number of entries in toc (same as number of pages in r/w mapping)
 105         uint32_t        entry_offset;
 106         uint32_t        entry_count;
 107         // uint16_t     toc[toc_count];
 108         // entrybitmap  entries[entries_count];
 109 };
 110
 111 #define NBBY    8
 112 #define NUM_SLIDING_BITMAPS_PER_PAGE    (0x1000/sizeof(int)/NBBY) /*128*/
 113 typedef struct slide_info_entry_toc     *slide_info_entry_toc_t;
 114 struct slide_info_entry_toc {
 115         uint8_t entry[NUM_SLIDING_BITMAPS_PER_PAGE];
 116 };
 117
 118 typedef struct vm_shared_region_slide_info_entry_v2 *vm_shared_region_slide_info_entry_v2_t;
 119 struct vm_shared_region_slide_info_entry_v2 {
 120         uint32_t        version;
 121         uint32_t        page_size;
 122         uint32_t        page_starts_offset;
 123         uint32_t        page_starts_count;
 124         uint32_t        page_extras_offset;
 125         uint32_t        page_extras_count;
 126         uint64_t        delta_mask;             // which (contiguous) set of bits contains the delta to the next rebase location
 127         uint64_t        value_add;
 128         // uint16_t     page_starts[page_starts_count];
 129         // uint16_t     page_extras[page_extras_count];
 130 };
 131
 132 #define DYLD_CACHE_SLIDE_PAGE_ATTRS             0xC000  // high bits of uint16_t are flags
 133 #define DYLD_CACHE_SLIDE_PAGE_ATTR_EXTRA        0x8000  // index is into extras array (not starts array)
 134 #define DYLD_CACHE_SLIDE_PAGE_ATTR_NO_REBASE    0x4000  // page has no rebasing
 135 #define DYLD_CACHE_SLIDE_PAGE_ATTR_END          0x8000  // last chain entry for page
 136 #define DYLD_CACHE_SLIDE_PAGE_VALUE             0x3FFF  // bitwise negation of DYLD_CACHE_SLIDE_PAGE_ATTRS
 137 #define DYLD_CACHE_SLIDE_PAGE_OFFSET_SHIFT      2
 138
 139 typedef union vm_shared_region_slide_info_entry *vm_shared_region_slide_info_entry_t;
 140 union vm_shared_region_slide_info_entry {
 141         uint32_t        version;
 142         struct vm_shared_region_slide_info_entry_v1     v1;
 143         struct vm_shared_region_slide_info_entry_v2     v2;
 144 };
 145
 146 typedef struct vm_shared_region_slide_info *vm_shared_region_slide_info_t;
 147 struct vm_shared_region_slide_info {
 148         mach_vm_offset_t        start;
 149         mach_vm_offset_t        end;
 150         uint32_t                slide;
 151         vm_object_t             slide_object;
 152         mach_vm_size_t          slide_info_size;
 153         vm_shared_region_slide_info_entry_t     slide_info_entry;
 154 };
 155
 156 /* address space shared region descriptor */
 157 struct vm_shared_region {
 158         uint32_t                sr_ref_count;
 159         queue_chain_t           sr_q;
 160         void                    *sr_root_dir;
 161         cpu_type_t              sr_cpu_type;
 162         boolean_t               sr_64bit;
 163         boolean_t               sr_mapping_in_progress;
 164         boolean_t               sr_slide_in_progress;
 165         boolean_t               sr_persists;
 166         boolean_t               sr_slid;
 167         ipc_port_t              sr_mem_entry;
 168         mach_vm_offset_t        sr_first_mapping;
 169         mach_vm_offset_t        sr_base_address;
 170         mach_vm_size_t          sr_size;
 171         mach_vm_offset_t        sr_pmap_nesting_start;
 172         mach_vm_size_t          sr_pmap_nesting_size;
 173         thread_call_t           sr_timer_call;
 174         struct vm_shared_region_slide_info sr_slide_info;
 175         uuid_t                  sr_uuid;
 176         boolean_t               sr_uuid_copied;
 177 };
 178
 179 extern kern_return_t vm_shared_region_slide_page(vm_shared_region_slide_info_t si,
 180         vm_offset_t     vaddr,
 181         uint32_t pageIndex);
 182 extern vm_shared_region_slide_info_t vm_shared_region_get_slide_info(vm_shared_region_t sr);
 183 #else  /* !MACH_KERNEL_PRIVATE */
 184
 185 struct vm_shared_region;
 186 struct vm_shared_region_slide_info;
 187 struct vm_shared_region_slide_info_entry;
 188 struct slide_info_entry_toc;
 189
 190 #endif /* MACH_KERNEL_PRIVATE */
 191
 192 extern void vm_shared_region_init(void);
 193 extern kern_return_t vm_shared_region_enter(
 194         struct _vm_map          *map,
 195         struct task             *task,
 196         boolean_t               is_64bit,
 197         void                    *fsroot,
 198         cpu_type_t              cpu);
 199 extern kern_return_t vm_shared_region_remove(
 200         struct _vm_map          *map,
 201         struct task             *task);
 202 extern vm_shared_region_t vm_shared_region_get(
 203         struct task             *task);
 204 extern void vm_shared_region_deallocate(
 205         struct vm_shared_region *shared_region);
 206 extern mach_vm_offset_t vm_shared_region_base_address(
 207         struct vm_shared_region *shared_region);
 208 extern mach_vm_size_t vm_shared_region_size(
 209         struct vm_shared_region *shared_region);
 210 extern ipc_port_t vm_shared_region_mem_entry(
 211         struct vm_shared_region *shared_region);
 212 extern uint32_t vm_shared_region_get_slide(
 213         vm_shared_region_t      shared_region);
 214 extern void vm_shared_region_set(
 215         struct task             *task,
 216         struct vm_shared_region *new_shared_region);
 217 extern vm_shared_region_t vm_shared_region_lookup(
 218         void                    *root_dir,
 219         cpu_type_t              cpu,
 220         boolean_t               is_64bit);
 221 extern kern_return_t vm_shared_region_start_address(
 222         struct vm_shared_region *shared_region,
 223         mach_vm_offset_t        *start_address);
 224 extern void vm_shared_region_undo_mappings(
 225                         vm_map_t sr_map,
 226                         mach_vm_offset_t sr_base_address,
 227                         struct shared_file_mapping_np *mappings,
 228                         unsigned int mappings_count);
 229 extern kern_return_t vm_shared_region_map_file(
 230         struct vm_shared_region *shared_region,
 231         unsigned int            mappings_count,
 232         struct shared_file_mapping_np *mappings,
 233         memory_object_control_t file_control,
 234         memory_object_size_t    file_size,
 235         void                    *root_dir,
 236         uint32_t                slide,
 237         user_addr_t             slide_start,
 238         user_addr_t             slide_size);
 239 extern kern_return_t vm_shared_region_sliding_valid(uint32_t slide);
 240 extern kern_return_t vm_shared_region_slide_sanity_check(vm_shared_region_t sr);
 241 extern kern_return_t vm_shared_region_slide_init(vm_shared_region_t sr,
 242                 mach_vm_size_t slide_info_size,
 243                 mach_vm_offset_t start,
 244                 mach_vm_size_t size,
 245                 uint32_t slide,
 246                 memory_object_control_t);
 247 extern void* vm_shared_region_get_slide_info_entry(vm_shared_region_t sr);
 248 extern void vm_commpage_init(void);
 249 extern void vm_commpage_text_init(void);
 250 extern kern_return_t vm_commpage_enter(
 251         struct _vm_map          *map,
 252         struct task             *task,
 253         boolean_t               is64bit);
 254 extern kern_return_t vm_commpage_remove(
 255         struct _vm_map          *map,
 256         struct task             *task);
 257 int vm_shared_region_slide(uint32_t,
 258         mach_vm_offset_t,
 259         mach_vm_size_t,
 260         mach_vm_offset_t,
 261         mach_vm_size_t,
 262         memory_object_control_t);
 263
 264 #endif /* KERNEL_PRIVATE */
 265
 266 #endif  /* _VM_SHARED_REGION_H_ */