1 /* 2 * Copyright (c) 2004-2020 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 #include <vm/vm_options.h> 37 38 #ifdef __cplusplus 39 extern "C" { 40 #endif 41 42 /* 43 * This file contains various type definitions and routine prototypes 44 * that are needed to avoid compilation warnings for VM code (in osfmk, 45 * default_pager and bsd). 46 * Most of these should eventually go into more appropriate header files. 47 * 48 * Include it after all other header files since it doesn't include any 49 * type definitions and it works around some conflicts with other header 50 * files. 51 */ 52 53 54 /* 55 * osfmk 56 */ 57 #ifndef _IPC_IPC_PORT_H_ 58 extern mach_port_name_t ipc_port_copyout_send( 59 ipc_port_t sright, 60 ipc_space_t space); 61 extern mach_port_name_t ipc_port_copyout_send_pinned( 62 ipc_port_t sright, 63 ipc_space_t space); 64 extern kern_return_t mach_port_deallocate_kernel( 65 ipc_space_t space, 66 mach_port_name_t name, 67 natural_t kotype); 68 #endif /* _IPC_IPC_PORT_H_ */ 69 70 #ifndef _KERN_IPC_TT_H_ 71 72 #define port_name_to_task(name) port_name_to_task_kernel(name) 73 74 extern task_t port_name_to_task_kernel( 75 mach_port_name_t name); 76 extern task_t port_name_to_task_read( 77 mach_port_name_t name); 78 extern task_t port_name_to_task_name( 79 mach_port_name_t name); 80 extern void ipc_port_release_send( 81 ipc_port_t port); 82 #endif /* _KERN_IPC_TT_H_ */ 83 84 extern ipc_space_t get_task_ipcspace( 85 task_t t); 86 87 #if CONFIG_MEMORYSTATUS 88 extern int max_task_footprint_mb; /* Per-task limit on physical memory consumption in megabytes */ 89 #endif /* CONFIG_MEMORYSTATUS */ 90 91 /* Some loose-ends VM stuff */ 92 93 extern const vm_size_t msg_ool_size_small; 94 95 extern kern_return_t vm_tests(void); 96 extern void consider_machine_adjust(void); 97 extern vm_map_offset_t get_map_min(vm_map_t); 98 extern vm_map_offset_t get_map_max(vm_map_t); 99 extern vm_map_size_t get_vmmap_size(vm_map_t); 100 extern int get_task_page_size(task_t); 101 #if CONFIG_COREDUMP 102 extern int get_vmmap_entries(vm_map_t); 103 #endif 104 extern int get_map_nentries(vm_map_t); 105 106 extern vm_map_offset_t vm_map_page_mask(vm_map_t); 107 108 #if MACH_ASSERT 109 extern void vm_map_pmap_set_process( 110 vm_map_t map, 111 int pid, 112 char *procname); 113 extern void vm_map_pmap_check_ledgers( 114 pmap_t pmap, 115 ledger_t ledger, 116 int pid, 117 char *procname); 118 #endif /* MACH_ASSERT */ 119 120 #if CONFIG_COREDUMP 121 extern boolean_t coredumpok(vm_map_t map, mach_vm_offset_t va); 122 #endif 123 124 #if XNU_PLATFORM_MacOSX 125 /* 126 * VM routines that used to be published to 127 * user space, and are now restricted to the kernel. 128 * 129 * They should eventually go away entirely - 130 * to be replaced with standard vm_map() and 131 * vm_deallocate() calls. 132 */ 133 extern kern_return_t vm_region_object_create 134 ( 135 vm_map_t target_task, 136 vm_size_t size, 137 ipc_port_t *object_handle 138 ); 139 #endif /* XNU_PLATFORM_MacOSX */ 140 141 #if CONFIG_CODE_DECRYPTION 142 #define VM_MAP_DEBUG_APPLE_PROTECT MACH_ASSERT 143 #if VM_MAP_DEBUG_APPLE_PROTECT 144 extern int vm_map_debug_apple_protect; 145 #endif /* VM_MAP_DEBUG_APPLE_PROTECT */ 146 struct pager_crypt_info; 147 extern kern_return_t vm_map_apple_protected( 148 vm_map_t map, 149 vm_map_offset_t start, 150 vm_map_offset_t end, 151 vm_object_offset_t crypto_backing_offset, 152 struct pager_crypt_info *crypt_info, 153 uint32_t cryptid); 154 #endif /* CONFIG_CODE_DECRYPTION */ 155 156 struct vm_shared_region_slide_info; 157 158 #if __has_feature(ptrauth_calls) 159 extern void shared_region_key_alloc( 160 char *shared_region_id, 161 bool inherit, 162 uint64_t inherited_key); 163 extern void shared_region_key_dealloc( 164 char *shared_region_id); 165 extern uint64_t generate_jop_key(void); 166 #endif /* __has_feature(ptrauth_calls) */ 167 extern bool vm_shared_region_is_reslide(struct task *task); 168 169 struct vnode; 170 extern memory_object_t swapfile_pager_setup(struct vnode *vp); 171 extern memory_object_control_t swapfile_pager_control(memory_object_t mem_obj); 172 173 #if __arm64__ || (__ARM_ARCH_7K__ >= 2) 174 #define SIXTEENK_PAGE_SIZE 0x4000 175 #define SIXTEENK_PAGE_MASK 0x3FFF 176 #define SIXTEENK_PAGE_SHIFT 14 177 #endif /* __arm64__ || (__ARM_ARCH_7K__ >= 2) */ 178 179 #define FOURK_PAGE_SIZE 0x1000 180 #define FOURK_PAGE_MASK 0xFFF 181 #define FOURK_PAGE_SHIFT 12 182 183 #if __arm64__ 184 extern unsigned int page_shift_user32; 185 #endif /* __arm64__ */ 186 187 /* 188 * bsd 189 */ 190 struct vnode; 191 192 extern void vnode_setswapmount(struct vnode *); 193 extern int64_t vnode_getswappin_avail(struct vnode *); 194 195 #if CHECK_CS_VALIDATION_BITMAP 196 /* used by the vnode_pager_cs_validation_bitmap routine*/ 197 #define CS_BITMAP_SET 1 198 #define CS_BITMAP_CLEAR 2 199 #define CS_BITMAP_CHECK 3 200 201 #endif /* CHECK_CS_VALIDATION_BITMAP */ 202 203 extern kern_return_t vnode_pager_init( 204 memory_object_t, 205 memory_object_control_t, 206 memory_object_cluster_size_t); 207 208 #if CONFIG_IOSCHED 209 extern kern_return_t vnode_pager_get_object_devvp( 210 memory_object_t, 211 uintptr_t *); 212 #endif 213 214 /* 215 * Functions defined in ubc_subr.c used by the vm code 216 */ 217 extern kern_return_t ubc_cs_check_validation_bitmap( 218 struct vnode *vp, 219 memory_object_offset_t offset, 220 int optype); 221 extern int ubc_map( 222 struct vnode *vp, 223 int flags); 224 extern void ubc_unmap( 225 struct vnode *vp); 226 227 228 extern void device_pager_reference(memory_object_t); 229 extern void device_pager_deallocate(memory_object_t); 230 extern kern_return_t device_pager_init(memory_object_t, 231 memory_object_control_t, 232 memory_object_cluster_size_t); 233 extern kern_return_t device_pager_terminate(memory_object_t); 234 extern kern_return_t device_pager_data_request(memory_object_t, 235 memory_object_offset_t, 236 memory_object_cluster_size_t, 237 vm_prot_t, 238 memory_object_fault_info_t); 239 extern kern_return_t device_pager_data_return(memory_object_t, 240 memory_object_offset_t, 241 memory_object_cluster_size_t, 242 memory_object_offset_t *, 243 int *, 244 boolean_t, 245 boolean_t, 246 int); 247 extern kern_return_t device_pager_data_initialize(memory_object_t, 248 memory_object_offset_t, 249 memory_object_cluster_size_t); 250 extern kern_return_t device_pager_map(memory_object_t, vm_prot_t); 251 extern kern_return_t device_pager_last_unmap(memory_object_t); 252 253 extern kern_return_t pager_map_to_phys_contiguous( 254 memory_object_control_t object, 255 memory_object_offset_t offset, 256 addr64_t base_vaddr, 257 vm_size_t size); 258 259 struct macx_triggers_args; 260 261 extern int macx_swapinfo( 262 memory_object_size_t *total_p, 263 memory_object_size_t *avail_p, 264 vm_size_t *pagesize_p, 265 boolean_t *encrypted_p); 266 267 268 struct proc; 269 struct proc *current_proc(void); 270 extern int cs_allow_invalid(struct proc *p); 271 extern int cs_invalid_page(addr64_t vaddr, boolean_t *cs_killed); 272 273 #define CS_VALIDATE_TAINTED 0x00000001 274 #define CS_VALIDATE_NX 0x00000002 275 extern boolean_t cs_validate_range(struct vnode *vp, 276 memory_object_t pager, 277 memory_object_offset_t offset, 278 const void *data, 279 vm_size_t size, 280 unsigned *result); 281 extern void cs_validate_page( 282 struct vnode *vp, 283 memory_object_t pager, 284 memory_object_offset_t offset, 285 const void *data, 286 int *validated_p, 287 int *tainted_p, 288 int *nx_p); 289 290 291 extern kern_return_t mach_memory_entry_purgable_control( 292 ipc_port_t entry_port, 293 vm_purgable_t control, 294 int *state); 295 296 extern unsigned int vmtc_total; /* total # of text page corruptions detected */ 297 298 extern kern_return_t revalidate_text_page(task_t, vm_map_offset_t); 299 300 #define VM_TOGGLE_CLEAR 0 301 #define VM_TOGGLE_SET 1 302 #define VM_TOGGLE_GETVALUE 999 303 int vm_toggle_entry_reuse(int, int*); 304 305 #define SWAP_WRITE 0x00000000 /* Write buffer (pseudo flag). */ 306 #define SWAP_READ 0x00000001 /* Read buffer. */ 307 #define SWAP_ASYNC 0x00000002 /* Start I/O, do not wait. */ 308 309 void do_fastwake_warmup_all(void); 310 311 #if CONFIG_JETSAM 312 extern int proc_get_memstat_priority(struct proc*, boolean_t); 313 #endif /* CONFIG_JETSAM */ 314 315 /* the object purger. purges the next eligible object from memory. */ 316 /* returns TRUE if an object was purged, otherwise FALSE. */ 317 boolean_t vm_purgeable_object_purge_one_unlocked(int force_purge_below_group); 318 void vm_owned_objects_disown(task_t task); 319 void vm_object_wired_page_update_ledgers( 320 vm_object_t object, 321 int64_t wired_delta); 322 323 struct trim_list { 324 uint64_t tl_offset; 325 uint64_t tl_length; 326 struct trim_list *tl_next; 327 }; 328 329 #define MAX_SWAPFILENAME_LEN 1024 330 #define SWAPFILENAME_INDEX_LEN 2 /* Doesn't include the terminating NULL character */ 331 332 extern char swapfilename[MAX_SWAPFILENAME_LEN + 1]; 333 334 struct vm_counters { 335 unsigned int do_collapse_compressor; 336 unsigned int do_collapse_compressor_pages; 337 unsigned int do_collapse_terminate; 338 unsigned int do_collapse_terminate_failure; 339 unsigned int should_cow_but_wired; 340 unsigned int create_upl_extra_cow; 341 unsigned int create_upl_extra_cow_pages; 342 unsigned int create_upl_lookup_failure_write; 343 unsigned int create_upl_lookup_failure_copy; 344 }; 345 extern struct vm_counters vm_counters; 346 347 #if CONFIG_SECLUDED_MEMORY 348 struct vm_page_secluded_data { 349 int eligible_for_secluded; 350 int grab_success_free; 351 int grab_success_other; 352 int grab_failure_locked; 353 int grab_failure_state; 354 int grab_failure_realtime; 355 int grab_failure_dirty; 356 int grab_for_iokit; 357 int grab_for_iokit_success; 358 }; 359 extern struct vm_page_secluded_data vm_page_secluded; 360 361 extern int num_tasks_can_use_secluded_mem; 362 363 /* boot-args */ 364 365 __enum_decl(secluded_filecache_mode_t, uint8_t, { 366 /* 367 * SECLUDED_FILECACHE_NONE: 368 * + no file contents in secluded pool 369 */ 370 SECLUDED_FILECACHE_NONE = 0, 371 /* 372 * SECLUDED_FILECACHE_APPS 373 * + no files from / 374 * + files from /Applications/ are OK 375 * + files from /Applications/Camera are not OK 376 * + no files that are open for write 377 */ 378 SECLUDED_FILECACHE_APPS = 1, 379 /* 380 * SECLUDED_FILECACHE_RDONLY 381 * + all read-only files OK, except: 382 * + dyld_shared_cache_arm64* 383 * + Camera 384 * + mediaserverd 385 * + cameracaptured 386 */ 387 SECLUDED_FILECACHE_RDONLY = 2, 388 }); 389 390 extern secluded_filecache_mode_t secluded_for_filecache; 391 extern bool secluded_for_apps; 392 extern bool secluded_for_iokit; 393 394 extern uint64_t vm_page_secluded_drain(void); 395 extern void memory_object_mark_eligible_for_secluded( 396 memory_object_control_t control, 397 boolean_t eligible_for_secluded); 398 399 #endif /* CONFIG_SECLUDED_MEMORY */ 400 401 extern void memory_object_mark_for_realtime( 402 memory_object_control_t control, 403 bool for_realtime); 404 405 #define MAX_PAGE_RANGE_QUERY (1ULL * 1024 * 1024 * 1024) /* 1 GB */ 406 407 extern uint64_t vm_purge_filebacked_pagers(void); 408 409 #define roundup(x, y) ((((x) % (y)) == 0) ? \ 410 (x) : ((x) + ((y) - ((x) % (y))))) 411 412 #define rounddown(x, y) (((x)/(y))*(y)) 413 414 #ifdef __cplusplus 415 } 416 #endif 417 418 /* 419 * Flags for the VM swapper/reclaimer. 420 * Used by vm_swap_consider_defragment() 421 * to force defrag/reclaim by the swap 422 * GC thread. 423 */ 424 #define VM_SWAP_FLAGS_NONE 0 425 #define VM_SWAP_FLAGS_FORCE_DEFRAG 1 426 #define VM_SWAP_FLAGS_FORCE_RECLAIM 2 427 428 #if __arm64__ 429 /* 430 * Flags to control the behavior of 431 * the legacy footprint entitlement. 432 */ 433 #define LEGACY_FOOTPRINT_ENTITLEMENT_IGNORE (1) 434 #define LEGACY_FOOTPRINT_ENTITLEMENT_IOS11_ACCT (2) 435 #define LEGACY_FOOTPRINT_ENTITLEMENT_LIMIT_INCREASE (3) 436 437 #endif /* __arm64__ */ 438 439 #if DEVELOPMENT || DEBUG 440 struct proc; 441 extern struct proc *current_proc(void); 442 extern int proc_pid(struct proc *); 443 extern const char *proc_best_name(struct proc *); 444 struct thread; 445 extern uint64_t thread_tid(struct thread *); 446 extern int debug4k_filter; 447 extern int debug4k_proc_filter; 448 extern char debug4k_proc_name[]; 449 extern const char *debug4k_category_name[]; 450 451 #define __DEBUG4K(category, fmt, ...) \ 452 MACRO_BEGIN \ 453 int __category = (category); \ 454 struct thread *__t = NULL; \ 455 struct proc *__p = NULL; \ 456 const char *__pname = "?"; \ 457 boolean_t __do_log = FALSE; \ 458 \ 459 if ((1 << __category) & debug4k_filter) { \ 460 __do_log = TRUE; \ 461 } else if (((1 << __category) & debug4k_proc_filter) && \ 462 debug4k_proc_name[0] != '\0') { \ 463 __p = current_proc(); \ 464 if (__p != NULL) { \ 465 __pname = proc_best_name(__p); \ 466 } \ 467 if (!strcmp(debug4k_proc_name, __pname)) { \ 468 __do_log = TRUE; \ 469 } \ 470 } \ 471 if (__do_log) { \ 472 if (__p == NULL) { \ 473 __p = current_proc(); \ 474 if (__p != NULL) { \ 475 __pname = proc_best_name(__p); \ 476 } \ 477 } \ 478 __t = current_thread(); \ 479 printf("DEBUG4K(%s) %d[%s] %p(0x%llx) %s:%d: " fmt, \ 480 debug4k_category_name[__category], \ 481 __p ? proc_pid(__p) : 0, \ 482 __pname, \ 483 __t, \ 484 thread_tid(__t), \ 485 __FUNCTION__, \ 486 __LINE__, \ 487 ##__VA_ARGS__); \ 488 } \ 489 MACRO_END 490 491 #define __DEBUG4K_ERROR 0 492 #define __DEBUG4K_LIFE 1 493 #define __DEBUG4K_LOAD 2 494 #define __DEBUG4K_FAULT 3 495 #define __DEBUG4K_COPY 4 496 #define __DEBUG4K_SHARE 5 497 #define __DEBUG4K_ADJUST 6 498 #define __DEBUG4K_PMAP 7 499 #define __DEBUG4K_MEMENTRY 8 500 #define __DEBUG4K_IOKIT 9 501 #define __DEBUG4K_UPL 10 502 #define __DEBUG4K_EXC 11 503 #define __DEBUG4K_VFS 12 504 505 #define DEBUG4K_ERROR(...) __DEBUG4K(__DEBUG4K_ERROR, ##__VA_ARGS__) 506 #define DEBUG4K_LIFE(...) __DEBUG4K(__DEBUG4K_LIFE, ##__VA_ARGS__) 507 #define DEBUG4K_LOAD(...) __DEBUG4K(__DEBUG4K_LOAD, ##__VA_ARGS__) 508 #define DEBUG4K_FAULT(...) __DEBUG4K(__DEBUG4K_FAULT, ##__VA_ARGS__) 509 #define DEBUG4K_COPY(...) __DEBUG4K(__DEBUG4K_COPY, ##__VA_ARGS__) 510 #define DEBUG4K_SHARE(...) __DEBUG4K(__DEBUG4K_SHARE, ##__VA_ARGS__) 511 #define DEBUG4K_ADJUST(...) __DEBUG4K(__DEBUG4K_ADJUST, ##__VA_ARGS__) 512 #define DEBUG4K_PMAP(...) __DEBUG4K(__DEBUG4K_PMAP, ##__VA_ARGS__) 513 #define DEBUG4K_MEMENTRY(...) __DEBUG4K(__DEBUG4K_MEMENTRY, ##__VA_ARGS__) 514 #define DEBUG4K_IOKIT(...) __DEBUG4K(__DEBUG4K_IOKIT, ##__VA_ARGS__) 515 #define DEBUG4K_UPL(...) __DEBUG4K(__DEBUG4K_UPL, ##__VA_ARGS__) 516 #define DEBUG4K_EXC(...) __DEBUG4K(__DEBUG4K_EXC, ##__VA_ARGS__) 517 #define DEBUG4K_VFS(...) __DEBUG4K(__DEBUG4K_VFS, ##__VA_ARGS__) 518 519 #else /* DEVELOPMENT || DEBUG */ 520 521 #define DEBUG4K_ERROR(...) 522 #define DEBUG4K_LIFE(...) 523 #define DEBUG4K_LOAD(...) 524 #define DEBUG4K_FAULT(...) 525 #define DEBUG4K_COPY(...) 526 #define DEBUG4K_SHARE(...) 527 #define DEBUG4K_ADJUST(...) 528 #define DEBUG4K_PMAP(...) 529 #define DEBUG4K_MEMENTRY(...) 530 #define DEBUG4K_IOKIT(...) 531 #define DEBUG4K_UPL(...) 532 #define DEBUG4K_EXC(...) 533 #define DEBUG4K_VFS(...) 534 535 #endif /* DEVELOPMENT || DEBUG */ 536 537 538 __enum_decl(vm_object_destroy_reason_t, uint8_t, { 539 VM_OBJECT_DESTROY_UNKNOWN_REASON = 0, 540 VM_OBJECT_DESTROY_RECLAIM = 1, 541 VM_OBJECT_DESTROY_UNMOUNT = 2, 542 VM_OBJECT_DESTROY_FORCED_UNMOUNT = 3, 543 VM_OBJECT_DESTROY_UNGRAFT = 4, 544 VM_OBJECT_DESTROY_PAGER = 5, 545 VM_OBJECT_DESTROY_MAX = 5, 546 }); 547 _Static_assert(VM_OBJECT_DESTROY_MAX < 8, "Need to fit in `no_pager_reason`'s number of bits"); 548 549 /* From vm_resident.c */ 550 void vm_update_darkwake_mode(boolean_t); 551 552 #if FBDP_DEBUG_OBJECT_NO_PAGER 553 extern kern_return_t memory_object_mark_as_tracked( 554 memory_object_control_t control, 555 bool new_value, 556 bool *old_value); 557 #endif /* FBDP_DEBUG_OBJECT_NO_PAGER */ 558 559 #endif /* _VM_VM_PROTOS_H_ */ 560 561 #endif /* XNU_KERNEL_PRIVATE */ 562