osfmk/vm/vm_shared_memory_server.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, 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  *
  30  *      File: vm/vm_shared_memory_server.h
  31  *
  32  *      protos and struct definitions for shared library
  33  *      server and interface
  34  */
  35
  36 #ifndef _VM_SHARED_MEMORY_SERVER_H_
  37 #define _VM_SHARED_MEMORY_SERVER_H_
  38
  39 #ifdef  KERNEL_PRIVATE
  40
  41 #include <mach/vm_prot.h>
  42 #include <mach/mach_types.h>
  43 #include <mach/shared_memory_server.h>
  44
  45 #include <kern/kern_types.h>
  46 #include <kern/macro_help.h>
  47
  48 #if DEBUG
  49 extern int shared_region_debug;
  50 #define SHARED_REGION_DEBUG(args)               \
  51         MACRO_BEGIN                             \
  52         if (shared_region_debug) {              \
  53                 kprintf args;                   \
  54         }                                       \
  55         MACRO_END
  56 #else /* DEBUG */
  57 #define SHARED_REGION_DEBUG(args)
  58 #endif /* DEBUG */
  59
  60 extern int shared_region_trace_level;
  61 #define SHARED_REGION_TRACE_NONE        0       /* no trace */
  62 #define SHARED_REGION_TRACE_ERROR       1       /* trace abnormal events */
  63 #define SHARED_REGION_TRACE_CONFLICT    2       /* trace library conflicts */
  64 #define SHARED_REGION_TRACE_INFO        3       /* trace all events */
  65 #define SHARED_REGION_TRACE(level, args)                \
  66         MACRO_BEGIN                                     \
  67         if (level <= shared_region_trace_level) {       \
  68                 printf args;                            \
  69         }                                               \
  70         MACRO_END
  71
  72 struct shared_region_task_mappings {
  73         mach_port_t             text_region;
  74         vm_size_t               text_size;
  75         mach_port_t             data_region;
  76         vm_size_t               data_size;
  77         vm_offset_t             region_mappings;
  78         vm_offset_t             client_base;
  79         vm_offset_t             alternate_base;
  80         vm_offset_t             alternate_next;
  81         unsigned int            fs_base;
  82         unsigned int            system;
  83         int                     flags;
  84         vm_offset_t             self;
  85 };
  86
  87 #define SHARED_REGION_SYSTEM    0x1 // Default env for system and fs_root
  88 #define SHARED_REGION_FULL      0x2 // Shared regions are full
  89 #define SHARED_REGION_STALE     0x4 // Indicates no longer in default list
  90 #define SHARED_REGION_STANDALONE 0x10 // Shared region is not shared !
  91
  92
  93 /* defines for default environment, and co-resident systems */
  94
  95 #define ENV_DEFAULT_ROOT        0
  96
  97 typedef struct shared_region_task_mappings *shared_region_task_mappings_t;
  98 typedef struct shared_region_mapping *shared_region_mapping_t;
  99
 100 #ifdef MACH_KERNEL_PRIVATE
 101
 102 #include <kern/queue.h>
 103 #include <vm/vm_object.h>
 104 #include <vm/memory_object.h>
 105
 106 extern vm_offset_t     shared_file_mapping_array;
 107
 108 struct loaded_mapping {
 109         vm_offset_t     mapping_offset;
 110         vm_size_t       size;
 111         vm_offset_t     file_offset;
 112         vm_prot_t       protection;  /* read/write/execute/COW/ZF */
 113
 114         struct loaded_mapping *next;
 115 };
 116
 117 typedef struct loaded_mapping loaded_mapping_t;
 118
 119 struct load_struct {
 120         queue_chain_t           links;
 121         shared_region_mapping_t regions_instance;
 122         int                     depth;
 123         int                     file_object;
 124         vm_offset_t             base_address;
 125         int                     mapping_cnt;
 126         loaded_mapping_t        *mappings;
 127         vm_offset_t             file_offset; // start of file we mapped in
 128 };
 129
 130 typedef struct load_struct load_struct_t;
 131 typedef struct load_struct *load_struct_ptr_t;
 132
 133 struct load_file_ele {
 134         union {
 135                 sf_mapping_t    mapping;
 136                 load_struct_t   element;
 137         } u;
 138 };
 139
 140 struct shared_file_info {
 141         mutex_t         lock;   /* lock for the structure */
 142         queue_head_t    *hash;  /* for later perf enhance */
 143         int             hash_size;
 144         boolean_t       hash_init;
 145 };
 146
 147 typedef struct shared_file_info shared_file_info_t;
 148
 149 struct shared_region_object_chain {
 150         shared_region_mapping_t object_chain_region;
 151         int                     depth;
 152         struct shared_region_object_chain *next;
 153 };
 154 typedef struct shared_region_object_chain *shared_region_object_chain_t;
 155
 156 /* address space shared region descriptor */
 157 struct shared_region_mapping {
 158         decl_mutex_data(,       Lock)   /* Synchronization */
 159         unsigned int            ref_count;
 160         unsigned int            fs_base;
 161         unsigned int            system;
 162         mach_port_t             text_region;
 163         vm_size_t               text_size;
 164         mach_port_t             data_region;
 165         vm_size_t               data_size;
 166         vm_offset_t             region_mappings;
 167         vm_offset_t             client_base;
 168         vm_offset_t             alternate_base;
 169         vm_offset_t             alternate_next;
 170         int                     flags;
 171         int                     depth;
 172         shared_region_mapping_t default_env_list;
 173         shared_region_object_chain_t object_chain;
 174         shared_region_mapping_t self;
 175         shared_region_mapping_t next;
 176 };
 177
 178 #define shared_region_mapping_lock_init(object)   \
 179                         mutex_init(&(object)->Lock, 0)
 180 #define shared_region_mapping_lock(object)        mutex_lock(&(object)->Lock)
 181 #define shared_region_mapping_unlock(object)      mutex_unlock(&(object)->Lock)
 182
 183 #else  /* !MACH_KERNEL_PRIVATE */
 184
 185 struct shared_region_mapping ;
 186
 187 #endif /* MACH_KERNEL_PRIVATE */
 188
 189 #define load_file_hash(file_object, size) \
 190                 ((((natural_t)file_object) & 0xffffff) % size)
 191
 192 extern kern_return_t map_shared_file(
 193         int                             map_cnt,
 194         struct shared_file_mapping_np   *mappings,
 195         memory_object_control_t         file_control,
 196         memory_object_size_t            file_size,
 197         shared_region_task_mappings_t   sm_info,
 198         mach_vm_offset_t                base_offset,
 199         mach_vm_offset_t                *slide_p);
 200
 201 extern kern_return_t shared_region_cleanup(
 202         unsigned int                    range_count,
 203         struct shared_region_range_np   *ranges,
 204         shared_region_task_mappings_t   sm_info);
 205
 206 extern kern_return_t shared_region_mapping_info(
 207                                 shared_region_mapping_t shared_region,
 208                                 mach_port_t             *text_region,
 209                                 vm_size_t               *text_size,
 210                                 mach_port_t             *data_region,
 211                                 vm_size_t               *data_size,
 212                                 vm_offset_t             *region_mappings,
 213                                 vm_offset_t             *client_base,
 214                                 vm_offset_t             *alternate_base,
 215                                 vm_offset_t             *alternate_next,
 216                                 unsigned int            *fs_base,
 217                                 unsigned int            *system,
 218                                 int                     *flags,
 219                                 shared_region_mapping_t *next);
 220
 221 extern kern_return_t shared_region_mapping_create(
 222                                 mach_port_t             text_region,
 223                                 vm_size_t               text_size,
 224                                 mach_port_t             data_region,
 225                                 vm_size_t               data_size,
 226                                 vm_offset_t             region_mappings,
 227                                 vm_offset_t             client_base,
 228                                 shared_region_mapping_t *shared_region,
 229                                 vm_offset_t             alt_base,
 230                                 vm_offset_t             alt_next,
 231                                 int                     fs_base,
 232                                 int                     system);
 233
 234 extern kern_return_t shared_region_mapping_ref(
 235                                 shared_region_mapping_t shared_region);
 236
 237 extern kern_return_t shared_region_mapping_dealloc(
 238                                 shared_region_mapping_t shared_region);
 239
 240 extern kern_return_t shared_region_object_chain_attach(
 241                                 shared_region_mapping_t target_region,
 242                                 shared_region_mapping_t object_chain);
 243
 244 extern void shared_region_object_chain_detached(
 245         shared_region_mapping_t target_region);
 246
 247 extern kern_return_t vm_get_shared_region(
 248                                 task_t  task,
 249                                 shared_region_mapping_t *shared_region);
 250
 251 extern kern_return_t vm_set_shared_region(
 252                                 task_t  task,
 253                                 shared_region_mapping_t shared_region);
 254
 255 extern shared_region_mapping_t update_default_shared_region(
 256                                 shared_region_mapping_t new_system_region);
 257
 258 extern shared_region_mapping_t lookup_default_shared_region(
 259                                 unsigned int fs_base,
 260                                 unsigned int system);
 261
 262 extern void remove_default_shared_region(
 263                                 shared_region_mapping_t system_region);
 264
 265 __private_extern__ void remove_default_shared_region_lock(
 266                                 shared_region_mapping_t system_region,
 267                                 int need_sfh_lock,
 268                                 int need_drl_lock);
 269
 270 __private_extern__ struct load_struct *lsf_remove_regions_mappings_lock(
 271                                 shared_region_mapping_t region,
 272                                 shared_region_task_mappings_t   sm_info,
 273                                 int need_lock);
 274
 275 extern unsigned int lsf_mapping_pool_gauge(void);
 276
 277 extern kern_return_t shared_file_create_system_region(
 278         shared_region_mapping_t *shared_region,
 279         int                     fs_base,
 280         int                     system);
 281
 282 extern void remove_all_shared_regions(void);
 283
 284 extern void shared_file_boot_time_init(
 285                 unsigned int fs_base,
 286                 unsigned int system);
 287
 288 extern struct load_struct *lsf_remove_regions_mappings(
 289         shared_region_mapping_t region,
 290         shared_region_task_mappings_t   sm_info);
 291
 292 extern void mach_memory_entry_port_release(ipc_port_t port);
 293 extern void mach_destroy_memory_entry(ipc_port_t port);
 294
 295 extern kern_return_t mach_memory_entry_purgable_control(
 296         ipc_port_t      entry_port,
 297         vm_purgable_t   control,
 298         int             *state);
 299
 300 extern kern_return_t mach_memory_entry_page_op(
 301         ipc_port_t              entry_port,
 302         vm_object_offset_t      offset,
 303         int                     ops,
 304         ppnum_t                 *phys_entry,
 305         int                     *flags);
 306
 307 extern kern_return_t mach_memory_entry_range_op(
 308         ipc_port_t              entry_port,
 309         vm_object_offset_t      offset_beg,
 310         vm_object_offset_t      offset_end,
 311         int                     ops,
 312         int                     *range);
 313
 314 #endif /* KERNEL_PRIVATE */
 315
 316 #endif  /* _VM_SHARED_MEMORY_SERVER_H_ */