osfmk/vm/vm_shared_memory_server.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /*
  31  *
  32  *      File: vm/vm_shared_memory_server.h
  33  *
  34  *      protos and struct definitions for shared library
  35  *      server and interface
  36  */
  37
  38 #ifndef _VM_SHARED_MEMORY_SERVER_H_
  39 #define _VM_SHARED_MEMORY_SERVER_H_
  40
  41 #ifdef  KERNEL_PRIVATE
  42
  43 #include <mach/vm_prot.h>
  44 #include <mach/mach_types.h>
  45 #include <mach/shared_memory_server.h>
  46
  47 #include <kern/kern_types.h>
  48
  49 #if DEBUG
  50 extern int shared_region_debug;
  51 #define SHARED_REGION_DEBUG(args)               \
  52         MACRO_BEGIN                             \
  53         if (shared_region_debug) {              \
  54                 kprintf args;                   \
  55         }                                       \
  56         MACRO_END
  57 #else /* DEBUG */
  58 #define SHARED_REGION_DEBUG(args)
  59 #endif /* DEBUG */
  60
  61 extern mach_port_t      shared_text_region_handle;
  62 extern mach_port_t      shared_data_region_handle;
  63
  64 struct shared_region_task_mappings {
  65         mach_port_t             text_region;
  66         vm_size_t               text_size;
  67         mach_port_t             data_region;
  68         vm_size_t               data_size;
  69         vm_offset_t             region_mappings;
  70         vm_offset_t             client_base;
  71         vm_offset_t             alternate_base;
  72         vm_offset_t             alternate_next;
  73         unsigned int            fs_base;
  74         unsigned int            system;
  75         int                     flags;
  76         vm_offset_t             self;
  77 };
  78
  79 #define SHARED_REGION_SYSTEM    0x1 // Default env for system and fs_root
  80 #define SHARED_REGION_FULL      0x2 // Shared regions are full
  81 #define SHARED_REGION_STALE     0x4 // Indicates no longer in default list
  82 #define SHARED_REGION_STANDALONE 0x10 // Shared region is not shared !
  83
  84
  85 /* defines for default environment, and co-resident systems */
  86
  87 #define ENV_DEFAULT_ROOT        0
  88
  89 typedef struct shared_region_task_mappings *shared_region_task_mappings_t;
  90 typedef struct shared_region_mapping *shared_region_mapping_t;
  91
  92 #ifdef MACH_KERNEL_PRIVATE
  93
  94 #include <kern/queue.h>
  95 #include <vm/vm_object.h>
  96 #include <vm/memory_object.h>
  97
  98 extern vm_offset_t     shared_file_mapping_array;
  99
 100 struct loaded_mapping {
 101         vm_offset_t     mapping_offset;
 102         vm_size_t       size;
 103         vm_offset_t     file_offset;
 104         vm_prot_t       protection;  /* read/write/execute/COW/ZF */
 105
 106         struct loaded_mapping *next;
 107 };
 108
 109 typedef struct loaded_mapping loaded_mapping_t;
 110
 111 struct load_struct {
 112         queue_chain_t           links;
 113         shared_region_mapping_t regions_instance;
 114         int                     depth;
 115         int                     file_object;
 116         vm_offset_t             base_address;
 117         int                     mapping_cnt;
 118         loaded_mapping_t        *mappings;
 119         vm_offset_t             file_offset; // start of file we mapped in
 120 };
 121
 122 typedef struct load_struct load_struct_t;
 123 typedef struct load_struct *load_struct_ptr_t;
 124
 125 struct load_file_ele {
 126         union {
 127                 sf_mapping_t    mapping;
 128                 load_struct_t   element;
 129         } u;
 130 };
 131
 132 struct shared_file_info {
 133         mutex_t         lock;   /* lock for the structure */
 134         queue_head_t    *hash;  /* for later perf enhance */
 135         int             hash_size;
 136         boolean_t       hash_init;
 137 };
 138
 139 typedef struct shared_file_info shared_file_info_t;
 140
 141 struct shared_region_object_chain {
 142         shared_region_mapping_t object_chain_region;
 143         int                     depth;
 144         struct shared_region_object_chain *next;
 145 };
 146 typedef struct shared_region_object_chain *shared_region_object_chain_t;
 147
 148 /* address space shared region descriptor */
 149 struct shared_region_mapping {
 150         decl_mutex_data(,       Lock)   /* Synchronization */
 151         int                     ref_count;
 152         unsigned int            fs_base;
 153         unsigned int            system;
 154         mach_port_t             text_region;
 155         vm_size_t               text_size;
 156         mach_port_t             data_region;
 157         vm_size_t               data_size;
 158         vm_offset_t             region_mappings;
 159         vm_offset_t             client_base;
 160         vm_offset_t             alternate_base;
 161         vm_offset_t             alternate_next;
 162         int                     flags;
 163         int                     depth;
 164         shared_region_mapping_t default_env_list;
 165         shared_region_object_chain_t object_chain;
 166         shared_region_mapping_t self;
 167         shared_region_mapping_t next;
 168 };
 169
 170 #define shared_region_mapping_lock_init(object)   \
 171                         mutex_init(&(object)->Lock, 0)
 172 #define shared_region_mapping_lock(object)        mutex_lock(&(object)->Lock)
 173 #define shared_region_mapping_unlock(object)      mutex_unlock(&(object)->Lock)
 174
 175 #else  /* !MACH_KERNEL_PRIVATE */
 176
 177 struct shared_region_mapping ;
 178
 179 #endif /* MACH_KERNEL_PRIVATE */
 180
 181 #define load_file_hash(file_object, size) \
 182                 ((((natural_t)file_object) & 0xffffff) % size)
 183
 184 extern kern_return_t map_shared_file(
 185         int                             map_cnt,
 186         struct shared_file_mapping_np   *mappings,
 187         memory_object_control_t         file_control,
 188         memory_object_size_t            file_size,
 189         shared_region_task_mappings_t   sm_info,
 190         mach_vm_offset_t                base_offset,
 191         mach_vm_offset_t                *slide_p);
 192
 193 extern kern_return_t shared_region_cleanup(
 194         unsigned int                    range_count,
 195         struct shared_region_range_np   *ranges,
 196         shared_region_task_mappings_t   sm_info);
 197
 198 extern kern_return_t shared_region_mapping_info(
 199                                 shared_region_mapping_t shared_region,
 200                                 mach_port_t             *text_region,
 201                                 vm_size_t               *text_size,
 202                                 mach_port_t             *data_region,
 203                                 vm_size_t               *data_size,
 204                                 vm_offset_t             *region_mappings,
 205                                 vm_offset_t             *client_base,
 206                                 vm_offset_t             *alternate_base,
 207                                 vm_offset_t             *alternate_next,
 208                                 unsigned int            *fs_base,
 209                                 unsigned int            *system,
 210                                 int                     *flags,
 211                                 shared_region_mapping_t *next);
 212
 213 extern kern_return_t shared_region_mapping_create(
 214                                 mach_port_t             text_region,
 215                                 vm_size_t               text_size,
 216                                 mach_port_t             data_region,
 217                                 vm_size_t               data_size,
 218                                 vm_offset_t             region_mappings,
 219                                 vm_offset_t             client_base,
 220                                 shared_region_mapping_t *shared_region,
 221                                 vm_offset_t             alt_base,
 222                                 vm_offset_t             alt_next);
 223
 224 extern kern_return_t shared_region_mapping_ref(
 225                                 shared_region_mapping_t shared_region);
 226
 227 extern kern_return_t shared_region_mapping_dealloc(
 228                                 shared_region_mapping_t shared_region);
 229
 230 extern kern_return_t shared_region_object_chain_attach(
 231                                 shared_region_mapping_t target_region,
 232                                 shared_region_mapping_t object_chain);
 233
 234 extern void shared_region_object_chain_detached(
 235         shared_region_mapping_t target_region);
 236
 237 extern kern_return_t vm_get_shared_region(
 238                                 task_t  task,
 239                                 shared_region_mapping_t *shared_region);
 240
 241 extern kern_return_t vm_set_shared_region(
 242                                 task_t  task,
 243                                 shared_region_mapping_t shared_region);
 244
 245 extern shared_region_mapping_t update_default_shared_region(
 246                                 shared_region_mapping_t new_system_region);
 247
 248 extern shared_region_mapping_t lookup_default_shared_region(
 249                                 unsigned int fs_base,
 250                                 unsigned int system);
 251
 252 extern void remove_default_shared_region(
 253                                 shared_region_mapping_t system_region);
 254
 255 __private_extern__ void remove_default_shared_region_lock(
 256                                 shared_region_mapping_t system_region,
 257                                 int need_sfh_lock,
 258                                 int need_drl_lock);
 259
 260 __private_extern__ struct load_struct *lsf_remove_regions_mappings_lock(
 261                                 shared_region_mapping_t region,
 262                                 shared_region_task_mappings_t   sm_info,
 263                                 int need_lock);
 264
 265 extern unsigned int lsf_mapping_pool_gauge(void);
 266
 267 extern kern_return_t shared_file_create_system_region(
 268         shared_region_mapping_t *shared_region);
 269
 270 extern void remove_all_shared_regions(void);
 271
 272 extern void shared_file_boot_time_init(
 273                 unsigned int fs_base,
 274                 unsigned int system);
 275
 276 extern struct load_struct *lsf_remove_regions_mappings(
 277         shared_region_mapping_t region,
 278         shared_region_task_mappings_t   sm_info);
 279
 280 extern void mach_memory_entry_port_release(ipc_port_t port);
 281 extern void mach_destroy_memory_entry(ipc_port_t port);
 282
 283 extern kern_return_t mach_memory_entry_purgable_control(
 284         ipc_port_t      entry_port,
 285         vm_purgable_t   control,
 286         int             *state);
 287
 288 #endif /* KERNEL_PRIVATE */
 289
 290 #endif  /* _VM_SHARED_MEMORY_SERVER_H_ */