osfmk/vm/vm_shared_memory_server.h

   1 /*
   2  * Copyright (c) 2002,2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  *
  27  *      File: vm/vm_shared_memory_server.h
  28  *
  29  *      protos and struct definitions for shared library
  30  *      server and interface
  31  */
  32
  33 #ifndef _VM_SHARED_MEMORY_SERVER_H_
  34 #define _VM_SHARED_MEMORY_SERVER_H_
  35
  36 #include <sys/appleapiopts.h>
  37
  38 #ifdef __APPLE_API_PRIVATE
  39
  40 #include <mach/vm_prot.h>
  41 #include <mach/mach_types.h>
  42 #include <mach/shared_memory_server.h>
  43
  44 #include <kern/kern_types.h>
  45
  46 extern mach_port_t      shared_text_region_handle;
  47 extern mach_port_t      shared_data_region_handle;
  48
  49 struct shared_region_task_mappings {
  50         mach_port_t             text_region;
  51         vm_size_t               text_size;
  52         mach_port_t             data_region;
  53         vm_size_t               data_size;
  54         vm_offset_t             region_mappings;
  55         vm_offset_t             client_base;
  56         vm_offset_t             alternate_base;
  57         vm_offset_t             alternate_next;
  58         unsigned int            fs_base;
  59         unsigned int            system;
  60         int                     flags;
  61         vm_offset_t             self;
  62 };
  63
  64 #define SHARED_REGION_SYSTEM    0x1 // Default env for system and fs_root
  65 #define SHARED_REGION_FULL      0x2 // Shared regions are full
  66 #define SHARED_REGION_STALE     0x4 // Indicates no longer in default list
  67
  68
  69 /* defines for default environment, and co-resident systems */
  70
  71 #define ENV_DEFAULT_SYSTEM      0
  72 #define ENV_DEFAULT_ROOT        0
  73
  74 typedef struct shared_region_task_mappings *shared_region_task_mappings_t;
  75 typedef struct shared_region_mapping *shared_region_mapping_t;
  76
  77
  78 #ifdef MACH_KERNEL_PRIVATE
  79
  80 #include <kern/queue.h>
  81 #include <vm/vm_object.h>
  82 #include <vm/memory_object.h>
  83
  84 extern vm_offset_t     shared_file_mapping_array;
  85
  86 struct loaded_mapping {
  87         vm_offset_t     mapping_offset;
  88         vm_size_t       size;
  89         vm_offset_t     file_offset;
  90         vm_prot_t       protection;  /* read/write/execute/COW/ZF */
  91
  92         struct loaded_mapping *next;
  93 };
  94
  95 typedef struct loaded_mapping loaded_mapping_t;
  96
  97 struct load_struct {
  98         queue_chain_t           links;
  99         shared_region_mapping_t regions_instance;
 100         int                     depth;
 101         int                     file_object;
 102         vm_offset_t             base_address;
 103         int                     mapping_cnt;
 104         loaded_mapping_t        *mappings;
 105         vm_offset_t             file_offset; // start of file we mapped in
 106 };
 107
 108 typedef struct load_struct load_struct_t;
 109 typedef struct load_struct *load_struct_ptr_t;
 110
 111 struct load_file_ele {
 112         union {
 113                 sf_mapping_t    mapping;
 114                 load_struct_t   element;
 115         } u;
 116 };
 117
 118 struct shared_file_info {
 119         mutex_t         lock;   /* lock for the structure */
 120         queue_head_t    *hash;  /* for later perf enhance */
 121         int             hash_size;
 122         boolean_t       hash_init;
 123 };
 124
 125 typedef struct shared_file_info shared_file_info_t;
 126
 127 struct shared_region_object_chain {
 128         shared_region_mapping_t object_chain_region;
 129         int                     depth;
 130         struct shared_region_object_chain *next;
 131 };
 132 typedef struct shared_region_object_chain *shared_region_object_chain_t;
 133
 134 /* address space shared region descriptor */
 135 struct shared_region_mapping {
 136         decl_mutex_data(,       Lock)   /* Synchronization */
 137         int                     ref_count;
 138         unsigned int            fs_base;
 139         unsigned int            system;
 140         mach_port_t             text_region;
 141         vm_size_t               text_size;
 142         mach_port_t             data_region;
 143         vm_size_t               data_size;
 144         vm_offset_t             region_mappings;
 145         vm_offset_t             client_base;
 146         vm_offset_t             alternate_base;
 147         vm_offset_t             alternate_next;
 148         int                     flags;
 149         int                     depth;
 150         shared_region_mapping_t default_env_list;
 151         shared_region_object_chain_t object_chain;
 152         shared_region_mapping_t self;
 153         shared_region_mapping_t next;
 154 };
 155
 156 #define shared_region_mapping_lock_init(object)   \
 157                         mutex_init(&(object)->Lock, ETAP_VM_OBJ)
 158 #define shared_region_mapping_lock(object)        mutex_lock(&(object)->Lock)
 159 #define shared_region_mapping_unlock(object)      mutex_unlock(&(object)->Lock)
 160
 161 #else  /* !MACH_KERNEL_PRIVATE */
 162
 163 struct shared_region_mapping ;
 164
 165 #endif /* MACH_KERNEL_PRIVATE */
 166
 167 extern kern_return_t copyin_shared_file(
 168                                 vm_offset_t             mapped_file,
 169                                 vm_size_t               mapped_file_size,
 170                                 vm_offset_t             *base_address,
 171                                 int                     map_cnt,
 172                                 sf_mapping_t            *mappings,
 173                                 memory_object_control_t         file_control,
 174                                 shared_region_task_mappings_t   shared_region,
 175                                 int                     *flags);
 176
 177 extern kern_return_t shared_region_mapping_info(
 178                                 shared_region_mapping_t shared_region,
 179                                 mach_port_t             *text_region,
 180                                 vm_size_t               *text_size,
 181                                 mach_port_t             *data_region,
 182                                 vm_size_t               *data_size,
 183                                 vm_offset_t             *region_mappings,
 184                                 vm_offset_t             *client_base,
 185                                 vm_offset_t             *alternate_base,
 186                                 vm_offset_t             *alternate_next,
 187                                 unsigned int            *fs_base,
 188                                 unsigned int            *system,
 189                                 int                     *flags,
 190                                 shared_region_mapping_t *next);
 191
 192 extern kern_return_t shared_region_mapping_create(
 193                                 mach_port_t             text_region,
 194                                 vm_size_t               text_size,
 195                                 mach_port_t             data_region,
 196                                 vm_size_t               data_size,
 197                                 vm_offset_t             region_mappings,
 198                                 vm_offset_t             client_base,
 199                                 shared_region_mapping_t *shared_region,
 200                                 vm_offset_t             alt_base,
 201                                 vm_offset_t             alt_next);
 202
 203 extern kern_return_t shared_region_mapping_ref(
 204                                 shared_region_mapping_t shared_region);
 205
 206 extern kern_return_t shared_region_mapping_dealloc(
 207                                 shared_region_mapping_t shared_region);
 208
 209 extern kern_return_t shared_region_object_chain_attach(
 210                                 shared_region_mapping_t target_region,
 211                                 shared_region_mapping_t object_chain);
 212
 213 extern kern_return_t vm_get_shared_region(
 214                                 task_t  task,
 215                                 shared_region_mapping_t *shared_region);
 216
 217 extern kern_return_t vm_set_shared_region(
 218                                 task_t  task,
 219                                 shared_region_mapping_t shared_region);
 220
 221 extern shared_region_mapping_t update_default_shared_region(
 222                                 shared_region_mapping_t new_system_region);
 223
 224 extern shared_region_mapping_t lookup_default_shared_region(
 225                                 unsigned int fs_base,
 226                                 unsigned int system);
 227
 228 extern void remove_default_shared_region(
 229                                 shared_region_mapping_t system_region);
 230
 231 extern unsigned int lsf_mapping_pool_gauge();
 232
 233 #endif /* __APPLE_API_PRIVATE */
 234
 235 #endif /* _VM_SHARED_MEMORY_SERVER_H_ */