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         uintptr_t               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         uintptr_t     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 #if CONFIG_CODE_DECRYPTION
 139 struct pager_crypt_info;
 140 extern kern_return_t vm_map_apple_protected(
 141                                             vm_map_t    map,
 142                                             vm_map_offset_t     start,
 143                                             vm_map_offset_t     end,
 144                                             struct pager_crypt_info *crypt_info);
 145 extern void apple_protect_pager_bootstrap(void);
 146 extern memory_object_t apple_protect_pager_setup(vm_object_t backing_object,
 147                                                  struct pager_crypt_info *crypt_info);
 148 #endif  /* CONFIG_CODE_DECRYPTION */
 149
 150 struct vnode;
 151 extern void swapfile_pager_bootstrap(void);
 152 extern memory_object_t swapfile_pager_setup(struct vnode *vp);
 153 extern memory_object_control_t swapfile_pager_control(memory_object_t mem_obj);
 154
 155
 156 /*
 157  * bsd
 158  */
 159 struct vnode;
 160 extern void vnode_pager_shutdown(void);
 161 extern void *upl_get_internal_page_list(
 162         upl_t upl);
 163
 164 typedef int pager_return_t;
 165 extern pager_return_t   vnode_pagein(
 166         struct vnode *, upl_t,
 167         upl_offset_t, vm_object_offset_t,
 168         upl_size_t, int, int *);
 169 extern pager_return_t   vnode_pageout(
 170         struct vnode *, upl_t,
 171         upl_offset_t, vm_object_offset_t,
 172         upl_size_t, int, int *);
 173 extern uint32_t vnode_trim (struct vnode *, int64_t offset, unsigned long len);
 174 extern memory_object_t vnode_pager_setup(
 175         struct vnode *, memory_object_t);
 176 extern vm_object_offset_t vnode_pager_get_filesize(
 177         struct vnode *);
 178 extern uint32_t vnode_pager_isinuse(
 179         struct vnode *);
 180 extern boolean_t vnode_pager_isSSD(
 181         struct vnode *);
 182 extern void vnode_pager_throttle(
 183         void);
 184 extern uint32_t vnode_pager_return_hard_throttle_limit(
 185         struct vnode *,
 186         uint32_t     *,
 187         uint32_t);
 188 extern kern_return_t vnode_pager_get_pathname(
 189         struct vnode    *vp,
 190         char            *pathname,
 191         vm_size_t       *length_p);
 192 extern kern_return_t vnode_pager_get_filename(
 193         struct vnode    *vp,
 194         const char      **filename);
 195 extern kern_return_t vnode_pager_get_cs_blobs(
 196         struct vnode    *vp,
 197         void            **blobs);
 198
 199 #if CHECK_CS_VALIDATION_BITMAP
 200 /* used by the vnode_pager_cs_validation_bitmap routine*/
 201 #define CS_BITMAP_SET   1
 202 #define CS_BITMAP_CLEAR 2
 203 #define CS_BITMAP_CHECK 3
 204
 205 #endif /* CHECK_CS_VALIDATION_BITMAP */
 206
 207 extern void vnode_pager_bootstrap(void) __attribute__((section("__TEXT, initcode")));
 208 extern kern_return_t
 209 vnode_pager_data_unlock(
 210         memory_object_t         mem_obj,
 211         memory_object_offset_t  offset,
 212         memory_object_size_t            size,
 213         vm_prot_t               desired_access);
 214 extern kern_return_t vnode_pager_init(
 215         memory_object_t,
 216         memory_object_control_t,
 217         memory_object_cluster_size_t);
 218 extern kern_return_t vnode_pager_get_object_size(
 219         memory_object_t,
 220         memory_object_offset_t *);
 221 extern kern_return_t vnode_pager_get_isinuse(
 222         memory_object_t,
 223         uint32_t *);
 224 extern kern_return_t vnode_pager_get_isSSD(
 225         memory_object_t,
 226         boolean_t *);
 227 extern kern_return_t vnode_pager_check_hard_throttle(
 228         memory_object_t,
 229         uint32_t *,
 230         uint32_t);
 231 extern kern_return_t vnode_pager_get_object_pathname(
 232         memory_object_t mem_obj,
 233         char            *pathname,
 234         vm_size_t       *length_p);
 235 extern kern_return_t vnode_pager_get_object_filename(
 236         memory_object_t mem_obj,
 237         const char      **filename);
 238 extern kern_return_t vnode_pager_get_object_cs_blobs(
 239         memory_object_t mem_obj,
 240         void            **blobs);
 241
 242 #if CHECK_CS_VALIDATION_BITMAP
 243 extern kern_return_t vnode_pager_cs_check_validation_bitmap(
 244         memory_object_t mem_obj,
 245         memory_object_offset_t  offset,
 246         int             optype);
 247 #endif /*CHECK_CS_VALIDATION_BITMAP*/
 248
 249 extern  kern_return_t ubc_cs_check_validation_bitmap (
 250         struct vnode *vp,
 251         memory_object_offset_t offset,
 252         int optype);
 253
 254 extern kern_return_t vnode_pager_data_request(
 255         memory_object_t,
 256         memory_object_offset_t,
 257         memory_object_cluster_size_t,
 258         vm_prot_t,
 259         memory_object_fault_info_t);
 260 extern kern_return_t vnode_pager_data_return(
 261         memory_object_t,
 262         memory_object_offset_t,
 263         memory_object_cluster_size_t,
 264         memory_object_offset_t *,
 265         int *,
 266         boolean_t,
 267         boolean_t,
 268         int);
 269 extern kern_return_t vnode_pager_data_initialize(
 270         memory_object_t,
 271         memory_object_offset_t,
 272         memory_object_cluster_size_t);
 273 extern void vnode_pager_reference(
 274         memory_object_t         mem_obj);
 275 extern kern_return_t vnode_pager_synchronize(
 276         memory_object_t         mem_obj,
 277         memory_object_offset_t  offset,
 278         memory_object_size_t            length,
 279         vm_sync_t               sync_flags);
 280 extern kern_return_t vnode_pager_map(
 281         memory_object_t         mem_obj,
 282         vm_prot_t               prot);
 283 extern kern_return_t vnode_pager_last_unmap(
 284         memory_object_t         mem_obj);
 285 extern void vnode_pager_deallocate(
 286         memory_object_t);
 287 extern kern_return_t vnode_pager_terminate(
 288         memory_object_t);
 289 extern void vnode_pager_vrele(
 290         struct vnode *vp);
 291 extern void vnode_pager_release_from_cache(
 292         int     *);
 293 extern int  ubc_map(
 294         struct vnode *vp,
 295         int flags);
 296 extern void ubc_unmap(
 297         struct vnode *vp);
 298
 299 struct vm_map_entry;
 300 extern struct vm_object *find_vnode_object(struct vm_map_entry *entry);
 301
 302 extern void   dp_memory_object_reference(memory_object_t);
 303 extern void   dp_memory_object_deallocate(memory_object_t);
 304 #ifndef _memory_object_server_
 305 extern kern_return_t   dp_memory_object_init(memory_object_t,
 306                                              memory_object_control_t,
 307                                              memory_object_cluster_size_t);
 308 extern  kern_return_t dp_memory_object_terminate(memory_object_t);
 309 extern  kern_return_t   dp_memory_object_data_request(memory_object_t,
 310                                                       memory_object_offset_t,
 311                                                       memory_object_cluster_size_t,
 312                                                       vm_prot_t,
 313                                                       memory_object_fault_info_t);
 314 extern kern_return_t dp_memory_object_data_return(memory_object_t,
 315                                                     memory_object_offset_t,
 316                                                     memory_object_cluster_size_t,
 317                                                     memory_object_offset_t *,
 318                                                     int *,
 319                                                     boolean_t,
 320                                                     boolean_t,
 321                                                     int);
 322 extern kern_return_t dp_memory_object_data_initialize(memory_object_t,
 323                                                       memory_object_offset_t,
 324                                                       memory_object_cluster_size_t);
 325 extern kern_return_t dp_memory_object_data_unlock(memory_object_t,
 326                                                   memory_object_offset_t,
 327                                                   memory_object_size_t,
 328                                                   vm_prot_t);
 329 extern kern_return_t dp_memory_object_synchronize(memory_object_t,
 330                                                   memory_object_offset_t,
 331                                                   memory_object_size_t,
 332                                                   vm_sync_t);
 333 extern kern_return_t dp_memory_object_map(memory_object_t,
 334                                           vm_prot_t);
 335 extern kern_return_t dp_memory_object_last_unmap(memory_object_t);
 336 #endif /* _memory_object_server_ */
 337 #ifndef _memory_object_default_server_
 338 extern kern_return_t default_pager_memory_object_create(
 339         memory_object_default_t,
 340         vm_size_t,
 341         memory_object_t *);
 342 #endif /* _memory_object_default_server_ */
 343
 344 #if CONFIG_FREEZE
 345 extern unsigned int default_pager_swap_pages_free(void);
 346 #endif
 347
 348 extern void   device_pager_reference(memory_object_t);
 349 extern void   device_pager_deallocate(memory_object_t);
 350 extern kern_return_t   device_pager_init(memory_object_t,
 351                                          memory_object_control_t,
 352                                          memory_object_cluster_size_t);
 353 extern  kern_return_t device_pager_terminate(memory_object_t);
 354 extern  kern_return_t   device_pager_data_request(memory_object_t,
 355                                                   memory_object_offset_t,
 356                                                   memory_object_cluster_size_t,
 357                                                   vm_prot_t,
 358                                                   memory_object_fault_info_t);
 359 extern kern_return_t device_pager_data_return(memory_object_t,
 360                                               memory_object_offset_t,
 361                                               memory_object_cluster_size_t,
 362                                               memory_object_offset_t *,
 363                                               int *,
 364                                               boolean_t,
 365                                               boolean_t,
 366                                               int);
 367 extern kern_return_t device_pager_data_initialize(memory_object_t,
 368                                                   memory_object_offset_t,
 369                                                   memory_object_cluster_size_t);
 370 extern kern_return_t device_pager_data_unlock(memory_object_t,
 371                                               memory_object_offset_t,
 372                                               memory_object_size_t,
 373                                               vm_prot_t);
 374 extern kern_return_t device_pager_synchronize(memory_object_t,
 375                                               memory_object_offset_t,
 376                                               memory_object_size_t,
 377                                               vm_sync_t);
 378 extern kern_return_t device_pager_map(memory_object_t, vm_prot_t);
 379 extern kern_return_t device_pager_last_unmap(memory_object_t);
 380 extern kern_return_t device_pager_populate_object(
 381         memory_object_t         device,
 382         memory_object_offset_t  offset,
 383         ppnum_t                 page_num,
 384         vm_size_t               size);
 385 extern memory_object_t device_pager_setup(
 386         memory_object_t,
 387         uintptr_t,
 388         vm_size_t,
 389         int);
 390 extern void device_pager_bootstrap(void) __attribute__((section("__TEXT, initcode")));
 391
 392 extern kern_return_t memory_object_create_named(
 393         memory_object_t pager,
 394         memory_object_offset_t  size,
 395         memory_object_control_t         *control);
 396
 397 struct macx_triggers_args;
 398 extern int mach_macx_triggers(
 399         struct macx_triggers_args       *args);
 400
 401 extern int macx_swapinfo(
 402         memory_object_size_t    *total_p,
 403         memory_object_size_t    *avail_p,
 404         vm_size_t               *pagesize_p,
 405         boolean_t               *encrypted_p);
 406
 407 extern void log_stack_execution_failure(addr64_t vaddr, vm_prot_t prot);
 408 extern void log_unnest_badness(vm_map_t, vm_map_offset_t, vm_map_offset_t);
 409
 410 extern int cs_allow_invalid(struct proc *p);
 411 extern int cs_invalid_page(addr64_t vaddr);
 412 extern boolean_t cs_validate_page(void *blobs,
 413                                   memory_object_offset_t offset,
 414                                   const void *data,
 415                                   boolean_t *tainted);
 416
 417 extern kern_return_t mach_memory_entry_purgable_control(
 418         ipc_port_t      entry_port,
 419         vm_purgable_t   control,
 420         int             *state);
 421
 422 extern kern_return_t mach_memory_entry_page_op(
 423         ipc_port_t              entry_port,
 424         vm_object_offset_t      offset,
 425         int                     ops,
 426         ppnum_t                 *phys_entry,
 427         int                     *flags);
 428
 429 extern kern_return_t mach_memory_entry_range_op(
 430         ipc_port_t              entry_port,
 431         vm_object_offset_t      offset_beg,
 432         vm_object_offset_t      offset_end,
 433         int                     ops,
 434         int                     *range);
 435
 436 extern void mach_memory_entry_port_release(ipc_port_t port);
 437 extern void mach_destroy_memory_entry(ipc_port_t port);
 438 extern kern_return_t mach_memory_entry_allocate(
 439         struct vm_named_entry **user_entry_p,
 440         ipc_port_t *user_handle_p);
 441
 442 extern void vm_paging_map_init(void);
 443
 444 extern int macx_backing_store_compaction(int flags);
 445 extern unsigned int mach_vm_ctl_page_free_wanted(void);
 446
 447 extern void no_paging_space_action(void);
 448
 449 #define VM_TOGGLE_CLEAR         0
 450 #define VM_TOGGLE_SET           1
 451 #define VM_TOGGLE_GETVALUE      999
 452 int vm_toggle_entry_reuse(int, int*);
 453 #endif  /* _VM_VM_PROTOS_H_ */
 454
 455 #endif  /* XNU_KERNEL_PRIVATE */