osfmk/vm/vm_map_store.c

   1 /*
   2  * Copyright (c) 2009 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_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. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 #include <kern/backtrace.h>
  30 #include <mach/sdt.h>
  31 #include <vm/vm_map_store.h>
  32 #include <vm/vm_pageout.h> /* for vm_debug_events */
  33
  34 #if MACH_ASSERT
  35 boolean_t
  36 first_free_is_valid_store( vm_map_t map )
  37 {
  38         return first_free_is_valid_ll( map );
  39 }
  40 #endif
  41
  42 boolean_t
  43 vm_map_store_has_RB_support( struct vm_map_header *hdr )
  44 {
  45         if ((void*)hdr->rb_head_store.rbh_root == (void*)(int)SKIP_RB_TREE) {
  46                 return FALSE;
  47         }
  48         return TRUE;
  49 }
  50
  51 void
  52 vm_map_store_init( struct vm_map_header *hdr )
  53 {
  54         vm_map_store_init_ll( hdr );
  55 #ifdef VM_MAP_STORE_USE_RB
  56         if (vm_map_store_has_RB_support( hdr )) {
  57                 vm_map_store_init_rb( hdr );
  58         }
  59 #endif
  60 }
  61
  62 boolean_t
  63 vm_map_store_lookup_entry(
  64         vm_map_t                map,
  65         vm_map_offset_t         address,
  66         vm_map_entry_t          *entry)         /* OUT */
  67 {
  68 #ifdef VM_MAP_STORE_USE_LL
  69         return vm_map_store_lookup_entry_ll( map, address, entry );
  70 #elif defined VM_MAP_STORE_USE_RB
  71         if (vm_map_store_has_RB_support( &map->hdr )) {
  72                 return vm_map_store_lookup_entry_rb( map, address, entry );
  73         } else {
  74                 panic("VM map lookups need RB tree support.\n");
  75                 return FALSE; /* For compiler warning.*/
  76         }
  77 #endif
  78 }
  79
  80 void
  81 vm_map_store_update( vm_map_t map, vm_map_entry_t entry, int update_type )
  82 {
  83         switch (update_type) {
  84         case VM_MAP_ENTRY_CREATE:
  85                 break;
  86         case VM_MAP_ENTRY_DELETE:
  87                 if ((map->holelistenabled == FALSE) && ((entry) == (map)->first_free)) {
  88                         (map)->first_free = vm_map_to_entry(map);
  89                 }
  90                 if ((entry) == (map)->hint) {
  91                         (map)->hint = vm_map_to_entry(map);
  92                 }
  93                 break;
  94         default:
  95                 break;
  96         }
  97 }
  98
  99 /*
 100  *      vm_map_entry_{un,}link:
 101  *
 102  *      Insert/remove entries from maps (or map copies).
 103  *      The _vm_map_store_entry_{un,}link variants are used at
 104  *      some places where updating first_free is not needed &
 105  *      copy maps are being modified. Also note the first argument
 106  *      is the map header.
 107  *      Modifying the vm_map_store_entry_{un,}link functions to
 108  *      deal with these call sites made the interface confusing
 109  *      and clunky.
 110  */
 111
 112 void
 113 _vm_map_store_entry_link( struct vm_map_header * mapHdr, vm_map_entry_t after_where, vm_map_entry_t entry)
 114 {
 115         assert(entry->vme_start < entry->vme_end);
 116         if (__improbable(vm_debug_events)) {
 117                 DTRACE_VM4(map_entry_link, vm_map_t, (char *)mapHdr - sizeof(lck_rw_t), vm_map_entry_t, entry, vm_address_t, entry->links.start, vm_address_t, entry->links.end);
 118         }
 119
 120         vm_map_store_entry_link_ll(mapHdr, after_where, entry);
 121 #ifdef VM_MAP_STORE_USE_RB
 122         if (vm_map_store_has_RB_support( mapHdr )) {
 123                 vm_map_store_entry_link_rb(mapHdr, after_where, entry);
 124         }
 125 #endif
 126 #if MAP_ENTRY_INSERTION_DEBUG
 127         backtrace(&entry->vme_insertion_bt[0],
 128             (sizeof(entry->vme_insertion_bt) / sizeof(uintptr_t)), NULL);
 129 #endif
 130 }
 131
 132 void
 133 vm_map_store_entry_link(
 134         vm_map_t                map,
 135         vm_map_entry_t          after_where,
 136         vm_map_entry_t          entry,
 137         vm_map_kernel_flags_t   vmk_flags)
 138 {
 139         vm_map_t VMEL_map;
 140         vm_map_entry_t VMEL_entry;
 141         VMEL_map = (map);
 142         VMEL_entry = (entry);
 143
 144         _vm_map_store_entry_link(&VMEL_map->hdr, after_where, VMEL_entry);
 145         if (VMEL_map->disable_vmentry_reuse == TRUE) {
 146                 UPDATE_HIGHEST_ENTRY_END( VMEL_map, VMEL_entry);
 147         } else {
 148                 update_first_free_ll(VMEL_map, VMEL_map->first_free);
 149 #ifdef VM_MAP_STORE_USE_RB
 150                 if (vm_map_store_has_RB_support( &VMEL_map->hdr )) {
 151                         update_first_free_rb(VMEL_map, entry, TRUE);
 152                 }
 153 #endif
 154         }
 155 #if PMAP_CS
 156         (void) vm_map_entry_cs_associate(map, entry, vmk_flags);
 157 #else /* PMAP_CS */
 158         (void) vmk_flags;
 159 #endif /* PMAP_CS */
 160 }
 161
 162 void
 163 _vm_map_store_entry_unlink( struct vm_map_header * mapHdr, vm_map_entry_t entry)
 164 {
 165         if (__improbable(vm_debug_events)) {
 166                 DTRACE_VM4(map_entry_unlink, vm_map_t, (char *)mapHdr - sizeof(lck_rw_t), vm_map_entry_t, entry, vm_address_t, entry->links.start, vm_address_t, entry->links.end);
 167         }
 168
 169         vm_map_store_entry_unlink_ll(mapHdr, entry);
 170 #ifdef VM_MAP_STORE_USE_RB
 171         if (vm_map_store_has_RB_support( mapHdr )) {
 172                 vm_map_store_entry_unlink_rb(mapHdr, entry);
 173         }
 174 #endif
 175 }
 176
 177 void
 178 vm_map_store_entry_unlink( vm_map_t map, vm_map_entry_t entry)
 179 {
 180         vm_map_t VMEU_map;
 181         vm_map_entry_t VMEU_entry = NULL;
 182         vm_map_entry_t VMEU_first_free = NULL;
 183         VMEU_map = (map);
 184         VMEU_entry = (entry);
 185
 186         if (map->holelistenabled == FALSE) {
 187                 if (VMEU_entry->vme_start <= VMEU_map->first_free->vme_start) {
 188                         VMEU_first_free = VMEU_entry->vme_prev;
 189                 } else {
 190                         VMEU_first_free = VMEU_map->first_free;
 191                 }
 192         }
 193         _vm_map_store_entry_unlink(&VMEU_map->hdr, VMEU_entry);
 194         vm_map_store_update( map, entry, VM_MAP_ENTRY_DELETE);
 195         update_first_free_ll(VMEU_map, VMEU_first_free);
 196 #ifdef VM_MAP_STORE_USE_RB
 197         if (vm_map_store_has_RB_support( &VMEU_map->hdr )) {
 198                 update_first_free_rb(VMEU_map, entry, FALSE);
 199         }
 200 #endif
 201 }
 202
 203 void
 204 vm_map_store_copy_reset( vm_map_copy_t copy, vm_map_entry_t entry)
 205 {
 206         int nentries = copy->cpy_hdr.nentries;
 207         vm_map_store_copy_reset_ll(copy, entry, nentries);
 208 #ifdef VM_MAP_STORE_USE_RB
 209         if (vm_map_store_has_RB_support( &copy->c_u.hdr )) {
 210                 vm_map_store_copy_reset_rb(copy, entry, nentries);
 211         }
 212 #endif
 213 }
 214
 215 void
 216 vm_map_store_update_first_free( vm_map_t map, vm_map_entry_t first_free_entry, boolean_t new_entry_creation)
 217 {
 218         update_first_free_ll(map, first_free_entry);
 219 #ifdef VM_MAP_STORE_USE_RB
 220         if (vm_map_store_has_RB_support( &map->hdr )) {
 221                 update_first_free_rb(map, first_free_entry, new_entry_creation);
 222         }
 223 #endif
 224 }