osfmk/vm/vm_protos.h

   1 /*
   2  * Copyright (c) 2004-2007 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 #ifdef  XNU_KERNEL_PRIVATE
  30
  31 #ifndef _VM_VM_PROTOS_H_
  32 #define _VM_VM_PROTOS_H_
  33
  34 #include <mach/mach_types.h>
  35 #include <kern/kern_types.h>
  36
  37 /*
  38  * This file contains various type definitions and routine prototypes
  39  * that are needed to avoid compilation warnings for VM code (in osfmk,
  40  * default_pager and bsd).
  41  * Most of these should eventually go into more appropriate header files.
  42  *
  43  * Include it after all other header files since it doesn't include any
  44  * type definitions and it works around some conflicts with other header
  45  * files.
  46  */
  47
  48 /*
  49  * iokit
  50  */
  51 extern kern_return_t device_data_action(
  52         int                     device_handle,
  53         ipc_port_t              device_pager,
  54         vm_prot_t               protection,
  55         vm_object_offset_t      offset,
  56         vm_size_t               size);
  57
  58 extern kern_return_t device_close(
  59         int     device_handle);
  60
  61 /*
  62  * default_pager
  63  */
  64 extern int start_def_pager(
  65         char *bs_device);
  66 extern int default_pager_init_flag;
  67
  68 /*
  69  * osfmk
  70  */
  71 #ifndef _KERN_IPC_TT_H_ /* XXX FBDP */
  72 /* these should be exported cleanly from OSFMK since BSD needs them */
  73 extern ipc_port_t convert_task_to_port(
  74         task_t          task);
  75 extern ipc_port_t convert_thread_to_port(
  76         thread_t                thread);
  77 extern ipc_port_t convert_task_name_to_port(
  78         task_name_t     task_name);
  79 #endif /* _KERN_IPC_TT_H_ */
  80 #ifndef _IPC_IPC_PORT_H_
  81 extern mach_port_name_t ipc_port_copyout_send(
  82         ipc_port_t      sright,
  83         ipc_space_t     space);
  84 extern task_t port_name_to_task(
  85         mach_port_name_t name);
  86 #endif /* _IPC_IPC_PORT_H_ */
  87
  88 extern ipc_space_t  get_task_ipcspace(
  89         task_t t);
  90
  91 /* Some loose-ends VM stuff */
  92
  93 extern vm_map_t         kalloc_map;
  94 extern vm_size_t        msg_ool_size_small;
  95 extern vm_map_t         zone_map;
  96
  97 extern void consider_machine_adjust(void);
  98 extern pmap_t get_map_pmap(vm_map_t);
  99 extern vm_map_offset_t get_map_min(vm_map_t);
 100 extern vm_map_offset_t get_map_max(vm_map_t);
 101 extern vm_map_size_t get_vmmap_size(vm_map_t);
 102 extern int get_vmmap_entries(vm_map_t);
 103
 104 extern boolean_t coredumpok(vm_map_t map, vm_offset_t va);
 105
 106 /*
 107  * VM routines that used to be published to
 108  * user space, and are now restricted to the kernel.
 109  *
 110  * They should eventually go away entirely -
 111  * to be replaced with standard vm_map() and
 112  * vm_deallocate() calls.
 113  */
 114
 115 extern kern_return_t vm_upl_map
 116 (
 117         vm_map_t target_task,
 118         upl_t upl,
 119         vm_address_t *address
 120 );
 121
 122 extern kern_return_t vm_upl_unmap
 123 (
 124         vm_map_t target_task,
 125         upl_t upl
 126 );
 127
 128 extern kern_return_t vm_region_object_create
 129 (
 130         vm_map_t target_task,
 131         vm_size_t size,
 132         ipc_port_t *object_handle
 133 );
 134
 135 extern mach_vm_offset_t mach_get_vm_start(vm_map_t);
 136 extern mach_vm_offset_t mach_get_vm_end(vm_map_t);
 137
 138 /*
 139  * Legacy routines to get the start and end for a vm_map_t.  They
 140  * return them in the vm_offset_t format.  So, they should only be
 141  * called on maps that are the same size as the kernel map for
 142  * accurate results.
 143  */
 144 extern vm_offset_t get_vm_start(vm_map_t);
 145 extern vm_offset_t get_vm_end(vm_map_t);
 146
 147 #ifdef __i386__
 148 extern kern_return_t vm_map_apple_protected(
 149         vm_map_t        map,
 150         vm_map_offset_t start,
 151         vm_map_offset_t end);
 152 extern void apple_protect_pager_bootstrap(void);
 153 extern memory_object_t apple_protect_pager_setup(vm_object_t backing_object);
 154 extern void apple_protect_pager_map(memory_object_t mem_obj);
 155 #endif  /* __i386__ */
 156
 157
 158 /*
 159  * bsd
 160  */
 161 struct vnode;
 162 extern void vnode_pager_shutdown(void);
 163 extern void *upl_get_internal_page_list(
 164         upl_t upl);
 165 #ifndef _VNODE_PAGER_
 166 typedef int pager_return_t;
 167 extern pager_return_t   vnode_pagein(
 168         struct vnode *, upl_t,
 169         vm_offset_t, vm_object_offset_t,
 170         vm_size_t, int, int *);
 171 extern pager_return_t   vnode_pageout(
 172         struct vnode *, upl_t,
 173         vm_offset_t, vm_object_offset_t,
 174         vm_size_t, int, int *);
 175 extern memory_object_t vnode_pager_setup(
 176         struct vnode *, memory_object_t);
 177 extern vm_object_offset_t vnode_pager_get_filesize(
 178         struct vnode *);
 179 extern kern_return_t vnode_pager_get_pathname(
 180         struct vnode    *vp,
 181         char            *pathname,
 182         vm_size_t       *length_p);
 183 extern kern_return_t vnode_pager_get_filename(
 184         struct vnode    *vp,
 185         const char      **filename);
 186 extern kern_return_t vnode_pager_get_cs_blobs(
 187         struct vnode    *vp,
 188         void            **blobs);
 189
 190 #endif /* _VNODE_PAGER_ */
 191 extern void vnode_pager_bootstrap(void) __attribute__((section("__TEXT, initcode")));
 192 extern kern_return_t
 193 vnode_pager_data_unlock(
 194         memory_object_t         mem_obj,
 195         memory_object_offset_t  offset,
 196         vm_size_t               size,
 197         vm_prot_t               desired_access);
 198 extern kern_return_t vnode_pager_init(
 199         memory_object_t,
 200         memory_object_control_t,
 201         vm_size_t);
 202 extern kern_return_t vnode_pager_get_object_size(
 203         memory_object_t,
 204         memory_object_offset_t *);
 205 extern kern_return_t vnode_pager_get_object_pathname(
 206         memory_object_t mem_obj,
 207         char            *pathname,
 208         vm_size_t       *length_p);
 209 extern kern_return_t vnode_pager_get_object_filename(
 210         memory_object_t mem_obj,
 211         const char      **filename);
 212 extern kern_return_t vnode_pager_get_object_cs_blobs(
 213         memory_object_t mem_obj,
 214         void            **blobs);
 215 extern kern_return_t vnode_pager_data_request(
 216         memory_object_t,
 217         memory_object_offset_t,
 218         vm_size_t,
 219         vm_prot_t,
 220         memory_object_fault_info_t);
 221 extern kern_return_t vnode_pager_data_return(
 222         memory_object_t,
 223         memory_object_offset_t,
 224         vm_size_t,
 225         memory_object_offset_t *,
 226         int *,
 227         boolean_t,
 228         boolean_t,
 229         int);
 230 extern kern_return_t vnode_pager_data_initialize(
 231         memory_object_t,
 232         memory_object_offset_t,
 233         vm_size_t);
 234 extern void vnode_pager_reference(
 235         memory_object_t         mem_obj);
 236 extern kern_return_t vnode_pager_synchronize(
 237         memory_object_t         mem_obj,
 238         memory_object_offset_t  offset,
 239         vm_size_t               length,
 240         vm_sync_t               sync_flags);
 241 extern kern_return_t vnode_pager_unmap(
 242         memory_object_t         mem_obj);
 243 extern void vnode_pager_deallocate(
 244         memory_object_t);
 245 extern kern_return_t vnode_pager_terminate(
 246         memory_object_t);
 247 extern void vnode_pager_vrele(
 248         struct vnode *vp);
 249 extern void vnode_pager_release_from_cache(
 250         int     *);
 251 extern void ubc_unmap(
 252         struct vnode *vp);
 253
 254 extern void   dp_memory_object_reference(memory_object_t);
 255 extern void   dp_memory_object_deallocate(memory_object_t);
 256 #ifndef _memory_object_server_
 257 extern kern_return_t   dp_memory_object_init(memory_object_t,
 258                                              memory_object_control_t,
 259                                              vm_size_t);
 260 extern  kern_return_t dp_memory_object_terminate(memory_object_t);
 261 extern  kern_return_t   dp_memory_object_data_request(memory_object_t,
 262                                                       memory_object_offset_t,
 263                                                       vm_size_t,
 264                                                       vm_prot_t,
 265                                                       memory_object_fault_info_t);
 266 extern kern_return_t dp_memory_object_data_return(memory_object_t,
 267                                                     memory_object_offset_t,
 268                                                     vm_size_t,
 269                                                     vm_size_t *,
 270                                                     int *,
 271                                                     boolean_t,
 272                                                     boolean_t,
 273                                                     int);
 274 extern kern_return_t dp_memory_object_data_initialize(memory_object_t,
 275                                                       memory_object_offset_t,
 276                                                       vm_size_t);
 277 extern kern_return_t dp_memory_object_data_unlock(memory_object_t,
 278                                                   memory_object_offset_t,
 279                                                   vm_size_t,
 280                                                   vm_prot_t);
 281 extern kern_return_t dp_memory_object_synchronize(memory_object_t,
 282                                                   memory_object_offset_t,
 283                                                   vm_size_t,
 284                                                   vm_sync_t);
 285 extern kern_return_t dp_memory_object_unmap(memory_object_t);
 286 #endif /* _memory_object_server_ */
 287 #ifndef _memory_object_default_server_
 288 extern kern_return_t default_pager_memory_object_create(
 289         memory_object_default_t,
 290         vm_size_t,
 291         memory_object_t *);
 292 #endif /* _memory_object_default_server_ */
 293
 294 extern void   device_pager_reference(memory_object_t);
 295 extern void   device_pager_deallocate(memory_object_t);
 296 extern kern_return_t   device_pager_init(memory_object_t,
 297                                          memory_object_control_t,
 298                                          vm_size_t);
 299 extern  kern_return_t device_pager_terminate(memory_object_t);
 300 extern  kern_return_t   device_pager_data_request(memory_object_t,
 301                                                   memory_object_offset_t,
 302                                                   vm_size_t,
 303                                                   vm_prot_t,
 304                                                   memory_object_fault_info_t);
 305 extern kern_return_t device_pager_data_return(memory_object_t,
 306                                               memory_object_offset_t,
 307                                               vm_size_t,
 308                                               memory_object_offset_t *,
 309                                               int *,
 310                                               boolean_t,
 311                                               boolean_t,
 312                                               int);
 313 extern kern_return_t device_pager_data_initialize(memory_object_t,
 314                                                   memory_object_offset_t,
 315                                                   vm_size_t);
 316 extern kern_return_t device_pager_data_unlock(memory_object_t,
 317                                               memory_object_offset_t,
 318                                               vm_size_t,
 319                                               vm_prot_t);
 320 extern kern_return_t device_pager_synchronize(memory_object_t,
 321                                               memory_object_offset_t,
 322                                               vm_size_t,
 323                                               vm_sync_t);
 324 extern kern_return_t device_pager_unmap(memory_object_t);
 325 extern kern_return_t device_pager_populate_object(
 326         memory_object_t         device,
 327         memory_object_offset_t  offset,
 328         ppnum_t                 page_num,
 329         vm_size_t               size);
 330 extern memory_object_t device_pager_setup(
 331         memory_object_t,
 332         int,
 333         vm_size_t,
 334         int);
 335 extern void device_pager_bootstrap(void) __attribute__((section("__TEXT, initcode")));
 336
 337 extern kern_return_t memory_object_create_named(
 338         memory_object_t pager,
 339         memory_object_offset_t  size,
 340         memory_object_control_t         *control);
 341
 342
 343 extern int macx_swapinfo(
 344         memory_object_size_t    *total_p,
 345         memory_object_size_t    *avail_p,
 346         vm_size_t               *pagesize_p,
 347         boolean_t               *encrypted_p);
 348
 349 extern void log_stack_execution_failure(addr64_t vaddr, vm_prot_t prot);
 350 extern int cs_invalid_page(void);
 351 extern boolean_t cs_validate_page(void *blobs,
 352                                   memory_object_offset_t offset,
 353                                   const void *data,
 354                                   boolean_t *tainted);
 355
 356 extern kern_return_t mach_memory_entry_purgable_control(
 357         ipc_port_t      entry_port,
 358         vm_purgable_t   control,
 359         int             *state);
 360
 361 extern kern_return_t mach_memory_entry_page_op(
 362         ipc_port_t              entry_port,
 363         vm_object_offset_t      offset,
 364         int                     ops,
 365         ppnum_t                 *phys_entry,
 366         int                     *flags);
 367
 368 extern kern_return_t mach_memory_entry_range_op(
 369         ipc_port_t              entry_port,
 370         vm_object_offset_t      offset_beg,
 371         vm_object_offset_t      offset_end,
 372         int                     ops,
 373         int                     *range);
 374
 375 extern void mach_memory_entry_port_release(ipc_port_t port);
 376 extern void mach_destroy_memory_entry(ipc_port_t port);
 377 extern kern_return_t mach_memory_entry_allocate(
 378         struct vm_named_entry **user_entry_p,
 379         ipc_port_t *user_handle_p);
 380
 381 extern void vm_paging_map_init(void);
 382
 383 #endif  /* _VM_VM_PROTOS_H_ */
 384
 385 #endif  /* XNU_KERNEL_PRIVATE */