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