/* * Copyright (c) 2000-2020 Apple Computer, Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. * * Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ /* * @OSF_COPYRIGHT@ */ /* * Mach Operating System * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University * All Rights Reserved. * * Permission to use, copy, modify and distribute this software and its * documentation is hereby granted, provided that both the copyright * notice and this permission notice appear in all copies of the * software, derivative works or modified versions, and any portions * thereof, and that both notices appear in supporting documentation. * * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. * * Carnegie Mellon requests users of this software to return to * * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU * School of Computer Science * Carnegie Mellon University * Pittsburgh PA 15213-3890 * * any improvements or extensions that they make and grant Carnegie Mellon * the rights to redistribute these changes. */ /* */ /* * File: vm/vm_page.h * Author: Avadis Tevanian, Jr., Michael Wayne Young * Date: 1985 * * Resident memory system definitions. */ #ifndef _VM_VM_PAGE_H_ #define _VM_VM_PAGE_H_ #include #include #include #include #include #include #include /* for VMP_CS_BITS... */ #include #if defined(__LP64__) /* * in order to make the size of a vm_page_t 64 bytes (cache line size for both arm64 and x86_64) * we'll keep the next_m pointer packed... as long as the kernel virtual space where we allocate * vm_page_t's from doesn't span more then 256 Gbytes, we're safe. There are live tests in the * vm_page_t array allocation and the zone init code to determine if we can safely pack and unpack * pointers from the 2 ends of these spaces */ typedef uint32_t vm_page_packed_t; struct vm_page_packed_queue_entry { vm_page_packed_t next; /* next element */ vm_page_packed_t prev; /* previous element */ }; typedef struct vm_page_packed_queue_entry *vm_page_queue_t; typedef struct vm_page_packed_queue_entry vm_page_queue_head_t; typedef struct vm_page_packed_queue_entry vm_page_queue_chain_t; typedef struct vm_page_packed_queue_entry *vm_page_queue_entry_t; typedef vm_page_packed_t vm_page_object_t; #else // __LP64__ /* * we can't do the packing trick on 32 bit architectures * so just turn the macros into noops. */ typedef struct vm_page *vm_page_packed_t; #define vm_page_queue_t queue_t #define vm_page_queue_head_t queue_head_t #define vm_page_queue_chain_t queue_chain_t #define vm_page_queue_entry_t queue_entry_t #define vm_page_object_t vm_object_t #endif // __LP64__ #include #include #include #include #include /* pages of compressed data */ #define VM_PAGE_COMPRESSOR_COUNT os_atomic_load(&compressor_object->resident_page_count, relaxed) /* * Management of resident (logical) pages. * * A small structure is kept for each resident * page, indexed by page number. Each structure * is an element of several lists: * * A hash table bucket used to quickly * perform object/offset lookups * * A list of all pages for a given object, * so they can be quickly deactivated at * time of deallocation. * * An ordered list of pages due for pageout. * * In addition, the structure contains the object * and offset to which this page belongs (for pageout), * and sundry status bits. * * Fields in this structure are locked either by the lock on the * object that the page belongs to (O) or by the lock on the page * queues (P). [Some fields require that both locks be held to * change that field; holding either lock is sufficient to read.] */ #define VM_PAGE_NULL ((vm_page_t) 0) extern char vm_page_inactive_states[]; extern char vm_page_pageable_states[]; extern char vm_page_non_speculative_pageable_states[]; extern char vm_page_active_or_inactive_states[]; #define VM_PAGE_INACTIVE(m) (vm_page_inactive_states[m->vmp_q_state]) #define VM_PAGE_PAGEABLE(m) (vm_page_pageable_states[m->vmp_q_state]) #define VM_PAGE_NON_SPECULATIVE_PAGEABLE(m) (vm_page_non_speculative_pageable_states[m->vmp_q_state]) #define VM_PAGE_ACTIVE_OR_INACTIVE(m) (vm_page_active_or_inactive_states[m->vmp_q_state]) #define VM_PAGE_NOT_ON_Q 0 /* page is not present on any queue, nor is it wired... mainly a transient state */ #define VM_PAGE_IS_WIRED 1 /* page is currently wired */ #define VM_PAGE_USED_BY_COMPRESSOR 2 /* page is in use by the compressor to hold compressed data */ #define VM_PAGE_ON_FREE_Q 3 /* page is on the main free queue */ #define VM_PAGE_ON_FREE_LOCAL_Q 4 /* page is on one of the per-CPU free queues */ #define VM_PAGE_ON_FREE_LOPAGE_Q 5 /* page is on the lopage pool free list */ #define VM_PAGE_ON_THROTTLED_Q 6 /* page is on the throttled queue... we stash anonymous pages here when not paging */ #define VM_PAGE_ON_PAGEOUT_Q 7 /* page is on one of the pageout queues (internal/external) awaiting processing */ #define VM_PAGE_ON_SPECULATIVE_Q 8 /* page is on one of the speculative queues */ #define VM_PAGE_ON_ACTIVE_LOCAL_Q 9 /* page has recently been created and is being held in one of the per-CPU local queues */ #define VM_PAGE_ON_ACTIVE_Q 10 /* page is in global active queue */ #define VM_PAGE_ON_INACTIVE_INTERNAL_Q 11 /* page is on the inactive internal queue a.k.a. anonymous queue */ #define VM_PAGE_ON_INACTIVE_EXTERNAL_Q 12 /* page in on the inactive external queue a.k.a. file backed queue */ #define VM_PAGE_ON_INACTIVE_CLEANED_Q 13 /* page has been cleaned to a backing file and is ready to be stolen */ #define VM_PAGE_ON_SECLUDED_Q 14 /* page is on secluded queue */ #define VM_PAGE_Q_STATE_LAST_VALID_VALUE 14 /* we currently use 4 bits for the state... don't let this go beyond 15 */ #define VM_PAGE_Q_STATE_ARRAY_SIZE (VM_PAGE_Q_STATE_LAST_VALID_VALUE+1) /* * The structure itself. See the block comment above for what (O) and (P) mean. */ #define vmp_pageq vmp_q_un.vmp_q_pageq #define vmp_snext vmp_q_un.vmp_q_snext struct vm_page { union { vm_page_queue_chain_t vmp_q_pageq; /* queue info for FIFO queue or free list (P) */ struct vm_page *vmp_q_snext; } vmp_q_un; vm_page_queue_chain_t vmp_listq; /* all pages in same object (O) */ vm_page_queue_chain_t vmp_specialq; /* anonymous pages in the special queues (P) */ vm_object_offset_t vmp_offset; /* offset into that object (O,P) */ vm_page_object_t vmp_object; /* which object am I in (O&P) */ /* * The following word of flags used to be protected by the "page queues" lock. * That's no longer true and what lock, if any, is needed may depend on the * value of vmp_q_state. * * We use 'vmp_wire_count' to store the local queue id if local queues are enabled. * See the comments at 'vm_page_queues_remove' as to why this is safe to do. */ #define VM_PAGE_SPECIAL_Q_EMPTY (0) #define VM_PAGE_SPECIAL_Q_BG (1) #define VM_PAGE_SPECIAL_Q_DONATE (2) #define VM_PAGE_SPECIAL_Q_FG (3) #define vmp_local_id vmp_wire_count unsigned int vmp_wire_count:16, /* how many wired down maps use me? (O&P) */ vmp_q_state:4, /* which q is the page on (P) */ vmp_on_specialq:2, vmp_gobbled:1, /* page used internally (P) */ vmp_laundry:1, /* page is being cleaned now (P)*/ vmp_no_cache:1, /* page is not to be cached and should */ /* be reused ahead of other pages (P) */ vmp_private:1, /* Page should not be returned to the free list (P) */ vmp_reference:1, /* page has been used (P) */ vmp_lopage:1, vmp_realtime:1, /* page used by realtime thread */ #if !CONFIG_TRACK_UNMODIFIED_ANON_PAGES vmp_unused_page_bits:3; #else /* ! CONFIG_TRACK_UNMODIFIED_ANON_PAGES */ vmp_unmodified_ro:1, /* Tracks if an anonymous page is modified after a decompression (O&P).*/ vmp_unused_page_bits:2; #endif /* ! CONFIG_TRACK_UNMODIFIED_ANON_PAGES */ /* * MUST keep the 2 32 bit words used as bit fields * separated since the compiler has a nasty habit * of using 64 bit loads and stores on them as * if they were a single 64 bit field... since * they are protected by 2 different locks, this * is a real problem */ vm_page_packed_t vmp_next_m; /* VP bucket link (O) */ /* * The following word of flags is protected by the "VM object" lock. * * IMPORTANT: the "vmp_pmapped", "vmp_xpmapped" and "vmp_clustered" bits can be modified while holding the * VM object "shared" lock + the page lock provided through the pmap_lock_phys_page function. * This is done in vm_fault_enter() and the CONSUME_CLUSTERED macro. * It's also ok to modify them behind just the VM object "exclusive" lock. */ unsigned int vmp_busy:1, /* page is in transit (O) */ vmp_wanted:1, /* someone is waiting for page (O) */ vmp_tabled:1, /* page is in VP table (O) */ vmp_hashed:1, /* page is in vm_page_buckets[] (O) + the bucket lock */ vmp_fictitious:1, /* Physical page doesn't exist (O) */ vmp_clustered:1, /* page is not the faulted page (O) or (O-shared AND pmap_page) */ vmp_pmapped:1, /* page has at some time been entered into a pmap (O) or */ /* (O-shared AND pmap_page) */ vmp_xpmapped:1, /* page has been entered with execute permission (O) or */ /* (O-shared AND pmap_page) */ vmp_wpmapped:1, /* page has been entered at some point into a pmap for write (O) */ vmp_free_when_done:1, /* page is to be freed once cleaning is completed (O) */ vmp_absent:1, /* Data has been requested, but is not yet available (O) */ vmp_error:1, /* Data manager was unable to provide data due to error (O) */ vmp_dirty:1, /* Page must be cleaned (O) */ vmp_cleaning:1, /* Page clean has begun (O) */ vmp_precious:1, /* Page is precious; data must be returned even if clean (O) */ vmp_overwriting:1, /* Request to unlock has been made without having data. (O) */ /* [See vm_fault_page_overwrite] */ vmp_restart:1, /* Page was pushed higher in shadow chain by copy_call-related pagers */ /* start again at top of chain */ vmp_unusual:1, /* Page is absent, error, restart or page locked */ vmp_cs_validated:VMP_CS_BITS, /* code-signing: page was checked */ vmp_cs_tainted:VMP_CS_BITS, /* code-signing: page is tainted */ vmp_cs_nx:VMP_CS_BITS, /* code-signing: page is nx */ vmp_reusable:1, vmp_written_by_kernel:1; /* page was written by kernel (i.e. decompressed) */ #if !defined(__arm64__) ppnum_t vmp_phys_page; /* Physical page number of the page */ #endif }; extern vm_page_t vm_pages; extern vm_page_t vm_page_array_beginning_addr; extern vm_page_t vm_page_array_ending_addr; #if defined(__arm64__) extern unsigned int vm_first_phys_ppnum; struct vm_page_with_ppnum { struct vm_page vm_page_wo_ppnum; ppnum_t vmp_phys_page; }; typedef struct vm_page_with_ppnum *vm_page_with_ppnum_t; static inline ppnum_t VM_PAGE_GET_PHYS_PAGE(vm_page_t m) { if (m >= vm_page_array_beginning_addr && m < vm_page_array_ending_addr) { /* real pages in vm_pages array */ return (ppnum_t)((uintptr_t)(m - vm_page_array_beginning_addr) + vm_first_phys_ppnum); } else { return ((vm_page_with_ppnum_t)m)->vmp_phys_page; /* pages in vm_page_zone */ } } #define VM_PAGE_SET_PHYS_PAGE(m, ppnum) \ MACRO_BEGIN \ if ((m) < vm_page_array_beginning_addr || (m) >= vm_page_array_ending_addr) \ ((vm_page_with_ppnum_t)(m))->vmp_phys_page = ppnum; \ assert(ppnum == VM_PAGE_GET_PHYS_PAGE(m)); \ MACRO_END #define VM_PAGE_GET_COLOR(m) (VM_PAGE_GET_PHYS_PAGE(m) & vm_color_mask) #else /* defined(__arm64__) */ struct vm_page_with_ppnum { struct vm_page vm_page_with_ppnum; }; typedef struct vm_page_with_ppnum *vm_page_with_ppnum_t; #define VM_PAGE_GET_PHYS_PAGE(page) (page)->vmp_phys_page #define VM_PAGE_SET_PHYS_PAGE(page, ppnum) \ MACRO_BEGIN \ (page)->vmp_phys_page = ppnum; \ MACRO_END #define VM_PAGE_GET_CLUMP(m) ((VM_PAGE_GET_PHYS_PAGE(m)) >> vm_clump_shift) #define VM_PAGE_GET_COLOR(m) ((VM_PAGE_GET_CLUMP(m)) & vm_color_mask) #endif /* defined(__arm64__) */ #if defined(__LP64__) /* * Parameters for pointer packing * * * VM Pages pointers might point to: * * 1. VM_PAGE_PACKED_ALIGNED aligned kernel globals, * * 2. VM_PAGE_PACKED_ALIGNED aligned heap allocated vm pages * * 3. entries in the vm_pages array (whose entries aren't VM_PAGE_PACKED_ALIGNED * aligned). * * * The current scheme uses 31 bits of storage and 6 bits of shift using the * VM_PACK_POINTER() scheme for (1-2), and packs (3) as an index within the * vm_pages array, setting the top bit (VM_PAGE_PACKED_FROM_ARRAY). * * This scheme gives us a reach of 128G from VM_MIN_KERNEL_AND_KEXT_ADDRESS. */ #define VM_VPLQ_ALIGNMENT 128 #define VM_PAGE_PACKED_PTR_ALIGNMENT 64 /* must be a power of 2 */ #define VM_PAGE_PACKED_ALIGNED __attribute__((aligned(VM_PAGE_PACKED_PTR_ALIGNMENT))) #define VM_PAGE_PACKED_PTR_BITS 31 #define VM_PAGE_PACKED_PTR_SHIFT 6 #define VM_PAGE_PACKED_PTR_BASE ((uintptr_t)VM_MIN_KERNEL_AND_KEXT_ADDRESS) #define VM_PAGE_PACKED_FROM_ARRAY 0x80000000 static inline vm_page_packed_t vm_page_pack_ptr(uintptr_t p) { if (p >= (uintptr_t)vm_page_array_beginning_addr && p < (uintptr_t)vm_page_array_ending_addr) { ptrdiff_t diff = (vm_page_t)p - vm_page_array_beginning_addr; assert((vm_page_t)p == &vm_pages[diff]); return (vm_page_packed_t)(diff | VM_PAGE_PACKED_FROM_ARRAY); } VM_ASSERT_POINTER_PACKABLE(p, VM_PAGE_PACKED_PTR); vm_offset_t packed = VM_PACK_POINTER(p, VM_PAGE_PACKED_PTR); return CAST_DOWN_EXPLICIT(vm_page_packed_t, packed); } static inline uintptr_t vm_page_unpack_ptr(uintptr_t p) { extern unsigned int vm_pages_count; if (p >= VM_PAGE_PACKED_FROM_ARRAY) { p &= ~VM_PAGE_PACKED_FROM_ARRAY; assert(p < (uintptr_t)vm_pages_count); return (uintptr_t)&vm_pages[p]; } return VM_UNPACK_POINTER(p, VM_PAGE_PACKED_PTR); } #define VM_PAGE_PACK_PTR(p) vm_page_pack_ptr((uintptr_t)(p)) #define VM_PAGE_UNPACK_PTR(p) vm_page_unpack_ptr((uintptr_t)(p)) #define VM_OBJECT_PACK(o) ((vm_page_object_t)VM_PACK_POINTER((uintptr_t)(o), VM_PAGE_PACKED_PTR)) #define VM_OBJECT_UNPACK(p) ((vm_object_t)VM_UNPACK_POINTER(p, VM_PAGE_PACKED_PTR)) #define VM_PAGE_OBJECT(p) VM_OBJECT_UNPACK((p)->vmp_object) #define VM_PAGE_PACK_OBJECT(o) VM_OBJECT_PACK(o) #define VM_PAGE_ZERO_PAGEQ_ENTRY(p) \ MACRO_BEGIN \ (p)->vmp_snext = 0; \ MACRO_END #define VM_PAGE_CONVERT_TO_QUEUE_ENTRY(p) VM_PAGE_PACK_PTR(p) /* * Macro: vm_page_queue_init * Function: * Initialize the given queue. * Header: * void vm_page_queue_init(q) * vm_page_queue_t q; \* MODIFIED *\ */ #define vm_page_queue_init(q) \ MACRO_BEGIN \ VM_ASSERT_POINTER_PACKABLE((vm_offset_t)(q), VM_PAGE_PACKED_PTR); \ (q)->next = VM_PAGE_PACK_PTR(q); \ (q)->prev = VM_PAGE_PACK_PTR(q); \ MACRO_END /* * Macro: vm_page_queue_enter * Function: * Insert a new element at the tail of the vm_page queue. * Header: * void vm_page_queue_enter(q, elt, field) * queue_t q; * vm_page_t elt; * is the list field in vm_page_t * * This macro's arguments have to match the generic "queue_enter()" macro which is * what is used for this on 32 bit kernels. */ #define vm_page_queue_enter(head, elt, field) \ MACRO_BEGIN \ vm_page_packed_t __pck_elt = VM_PAGE_PACK_PTR(elt); \ vm_page_packed_t __pck_head = VM_PAGE_PACK_PTR(head); \ vm_page_packed_t __pck_prev = (head)->prev; \ \ if (__pck_head == __pck_prev) { \ (head)->next = __pck_elt; \ } else { \ vm_page_t __prev; \ __prev = (vm_page_t)VM_PAGE_UNPACK_PTR(__pck_prev); \ __prev->field.next = __pck_elt; \ } \ (elt)->field.prev = __pck_prev; \ (elt)->field.next = __pck_head; \ (head)->prev = __pck_elt; \ MACRO_END #if defined(__x86_64__) /* * These are helper macros for vm_page_queue_enter_clump to assist * with conditional compilation (release / debug / development) */ #if DEVELOPMENT || DEBUG #define __DEBUG_CHECK_BUDDIES(__prev, __p, field) \ MACRO_BEGIN \ if (__prev != NULL) { \ assert(__p == (vm_page_t)VM_PAGE_UNPACK_PTR(__prev->next)); \ assert(__prev == (vm_page_queue_entry_t)VM_PAGE_UNPACK_PTR(__p->field.prev)); \ } \ MACRO_END #define __DEBUG_VERIFY_LINKS(__first, __n_free, __last_next) \ MACRO_BEGIN \ unsigned int __i; \ vm_page_queue_entry_t __tmp; \ for (__i = 0, __tmp = __first; __i < __n_free; __i++) { \ __tmp = (vm_page_queue_entry_t)VM_PAGE_UNPACK_PTR(__tmp->next); \ } \ assert(__tmp == __last_next); \ MACRO_END #define __DEBUG_STAT_INCREMENT_INRANGE vm_clump_inrange++ #define __DEBUG_STAT_INCREMENT_INSERTS vm_clump_inserts++ #define __DEBUG_STAT_INCREMENT_PROMOTES(__n_free) vm_clump_promotes+=__n_free #else #define __DEBUG_CHECK_BUDDIES(__prev, __p, field) #define __DEBUG_VERIFY_LINKS(__first, __n_free, __last_next) #define __DEBUG_STAT_INCREMENT_INRANGE #define __DEBUG_STAT_INCREMENT_INSERTS #define __DEBUG_STAT_INCREMENT_PROMOTES(__n_free) #endif /* if DEVELOPMENT || DEBUG */ #endif /* * Macro: vm_page_queue_enter_first * Function: * Insert a new element at the head of the vm_page queue. * Header: * void queue_enter_first(q, elt, , field) * queue_t q; * vm_page_t elt; * is the linkage field in vm_page * * This macro's arguments have to match the generic "queue_enter_first()" macro which is * what is used for this on 32 bit kernels. */ #define vm_page_queue_enter_first(head, elt, field) \ MACRO_BEGIN \ vm_page_packed_t __pck_next = (head)->next; \ vm_page_packed_t __pck_head = VM_PAGE_PACK_PTR(head); \ vm_page_packed_t __pck_elt = VM_PAGE_PACK_PTR(elt); \ \ if (__pck_head == __pck_next) { \ (head)->prev = __pck_elt; \ } else { \ vm_page_t __next; \ __next = (vm_page_t)VM_PAGE_UNPACK_PTR(__pck_next); \ __next->field.prev = __pck_elt; \ } \ \ (elt)->field.next = __pck_next; \ (elt)->field.prev = __pck_head; \ (head)->next = __pck_elt; \ MACRO_END /* * Macro: vm_page_queue_remove * Function: * Remove an arbitrary page from a vm_page queue. * Header: * void vm_page_queue_remove(q, qe, field) * arguments as in vm_page_queue_enter * * This macro's arguments have to match the generic "queue_enter()" macro which is * what is used for this on 32 bit kernels. */ #define vm_page_queue_remove(head, elt, field) \ MACRO_BEGIN \ vm_page_packed_t __pck_next = (elt)->field.next; \ vm_page_packed_t __pck_prev = (elt)->field.prev; \ vm_page_t __next = (vm_page_t)VM_PAGE_UNPACK_PTR(__pck_next); \ vm_page_t __prev = (vm_page_t)VM_PAGE_UNPACK_PTR(__pck_prev); \ \ if ((void *)(head) == (void *)__next) { \ (head)->prev = __pck_prev; \ } else { \ __next->field.prev = __pck_prev; \ } \ \ if ((void *)(head) == (void *)__prev) { \ (head)->next = __pck_next; \ } else { \ __prev->field.next = __pck_next; \ } \ \ (elt)->field.next = 0; \ (elt)->field.prev = 0; \ MACRO_END /* * Macro: vm_page_queue_remove_first * * Function: * Remove and return the entry at the head of a vm_page queue. * * Header: * vm_page_queue_remove_first(head, entry, field) * N.B. entry is returned by reference * * This macro's arguments have to match the generic "queue_remove_first()" macro which is * what is used for this on 32 bit kernels. */ #define vm_page_queue_remove_first(head, entry, field) \ MACRO_BEGIN \ vm_page_packed_t __pck_head = VM_PAGE_PACK_PTR(head); \ vm_page_packed_t __pck_next; \ vm_page_t __next; \ \ (entry) = (vm_page_t)VM_PAGE_UNPACK_PTR((head)->next); \ __pck_next = (entry)->field.next; \ __next = (vm_page_t)VM_PAGE_UNPACK_PTR(__pck_next); \ \ if (__pck_head == __pck_next) { \ (head)->prev = __pck_head; \ } else { \ __next->field.prev = __pck_head; \ } \ \ (head)->next = __pck_next; \ (entry)->field.next = 0; \ (entry)->field.prev = 0; \ MACRO_END #if defined(__x86_64__) /* * Macro: vm_page_queue_remove_first_with_clump * Function: * Remove and return the entry at the head of the free queue * end is set to 1 to indicate that we just returned the last page in a clump * * Header: * vm_page_queue_remove_first_with_clump(head, entry, end) * entry is returned by reference * end is returned by reference */ #define vm_page_queue_remove_first_with_clump(head, entry, end) \ MACRO_BEGIN \ vm_page_packed_t __pck_head = VM_PAGE_PACK_PTR(head); \ vm_page_packed_t __pck_next; \ vm_page_t __next; \ \ (entry) = (vm_page_t)VM_PAGE_UNPACK_PTR((head)->next); \ __pck_next = (entry)->vmp_pageq.next; \ __next = (vm_page_t)VM_PAGE_UNPACK_PTR(__pck_next); \ \ (end) = 0; \ if (__pck_head == __pck_next) { \ (head)->prev = __pck_head; \ (end) = 1; \ } else { \ __next->vmp_pageq.prev = __pck_head; \ if (VM_PAGE_GET_CLUMP(entry) != VM_PAGE_GET_CLUMP(__next)) { \ (end) = 1; \ } \ } \ \ (head)->next = __pck_next; \ (entry)->vmp_pageq.next = 0; \ (entry)->vmp_pageq.prev = 0; \ MACRO_END #endif /* * Macro: vm_page_queue_end * Function: * Tests whether a new entry is really the end of * the queue. * Header: * boolean_t vm_page_queue_end(q, qe) * vm_page_queue_t q; * vm_page_queue_entry_t qe; */ #define vm_page_queue_end(q, qe) ((q) == (qe)) /* * Macro: vm_page_queue_empty * Function: * Tests whether a queue is empty. * Header: * boolean_t vm_page_queue_empty(q) * vm_page_queue_t q; */ #define vm_page_queue_empty(q) vm_page_queue_end((q), ((vm_page_queue_entry_t)vm_page_queue_first(q))) /* * Macro: vm_page_queue_first * Function: * Returns the first entry in the queue, * Header: * uintpr_t vm_page_queue_first(q) * vm_page_queue_t q; \* IN *\ */ #define vm_page_queue_first(q) (VM_PAGE_UNPACK_PTR((q)->next)) /* * Macro: vm_page_queue_last * Function: * Returns the last entry in the queue. * Header: * vm_page_queue_entry_t queue_last(q) * queue_t q; \* IN *\ */ #define vm_page_queue_last(q) (VM_PAGE_UNPACK_PTR((q)->prev)) /* * Macro: vm_page_queue_next * Function: * Returns the entry after an item in the queue. * Header: * uintpr_t vm_page_queue_next(qc) * vm_page_queue_t qc; */ #define vm_page_queue_next(qc) (VM_PAGE_UNPACK_PTR((qc)->next)) /* * Macro: vm_page_queue_prev * Function: * Returns the entry before an item in the queue. * Header: * uinptr_t vm_page_queue_prev(qc) * vm_page_queue_t qc; */ #define vm_page_queue_prev(qc) (VM_PAGE_UNPACK_PTR((qc)->prev)) /* * Macro: vm_page_queue_iterate * Function: * iterate over each item in a vm_page queue. * Generates a 'for' loop, setting elt to * each item in turn (by reference). * Header: * vm_page_queue_iterate(q, elt, field) * queue_t q; * vm_page_t elt; * is the chain field in vm_page_t */ #define vm_page_queue_iterate(head, elt, field) \ for ((elt) = (vm_page_t)vm_page_queue_first(head); \ !vm_page_queue_end((head), (vm_page_queue_entry_t)(elt)); \ (elt) = (vm_page_t)vm_page_queue_next(&(elt)->field)) \ #else // LP64 #define VM_VPLQ_ALIGNMENT 128 #define VM_PAGE_PACKED_PTR_ALIGNMENT sizeof(vm_offset_t) #define VM_PAGE_PACKED_ALIGNED #define VM_PAGE_PACKED_PTR_BITS 32 #define VM_PAGE_PACKED_PTR_SHIFT 0 #define VM_PAGE_PACKED_PTR_BASE 0 #define VM_PAGE_PACKED_FROM_ARRAY 0 #define VM_PAGE_PACK_PTR(p) (p) #define VM_PAGE_UNPACK_PTR(p) ((uintptr_t)(p)) #define VM_OBJECT_PACK(o) ((vm_page_object_t)(o)) #define VM_OBJECT_UNPACK(p) ((vm_object_t)(p)) #define VM_PAGE_PACK_OBJECT(o) VM_OBJECT_PACK(o) #define VM_PAGE_OBJECT(p) VM_OBJECT_UNPACK((p)->vmp_object) #define VM_PAGE_ZERO_PAGEQ_ENTRY(p) \ MACRO_BEGIN \ (p)->vmp_pageq.next = 0; \ (p)->vmp_pageq.prev = 0; \ MACRO_END #define VM_PAGE_CONVERT_TO_QUEUE_ENTRY(p) ((queue_entry_t)(p)) #define vm_page_remque remque #define vm_page_enqueue_tail enqueue_tail #define vm_page_queue_init queue_init #define vm_page_queue_enter(h, e, f) queue_enter(h, e, vm_page_t, f) #define vm_page_queue_enter_first(h, e, f) queue_enter_first(h, e, vm_page_t, f) #define vm_page_queue_remove(h, e, f) queue_remove(h, e, vm_page_t, f) #define vm_page_queue_remove_first(h, e, f) queue_remove_first(h, e, vm_page_t, f) #define vm_page_queue_end queue_end #define vm_page_queue_empty queue_empty #define vm_page_queue_first queue_first #define vm_page_queue_last queue_last #define vm_page_queue_next queue_next #define vm_page_queue_prev queue_prev #define vm_page_queue_iterate(h, e, f) queue_iterate(h, e, vm_page_t, f) #endif // __LP64__ /* * VM_PAGE_MIN_SPECULATIVE_AGE_Q through vm_page_max_speculative_age_q * represents a set of aging bins that are 'protected'... * * VM_PAGE_SPECULATIVE_AGED_Q is a list of the speculative pages that have * not yet been 'claimed' but have been aged out of the protective bins * this occurs in vm_page_speculate when it advances to the next bin * and discovers that it is still occupied... at that point, all of the * pages in that bin are moved to the VM_PAGE_SPECULATIVE_AGED_Q. the pages * in that bin are all guaranteed to have reached at least the maximum age * we allow for a protected page... they can be older if there is no * memory pressure to pull them from the bin, or there are no new speculative pages * being generated to push them out. * this list is the one that vm_pageout_scan will prefer when looking * for pages to move to the underweight free list * * vm_page_max_speculative_age_q * VM_PAGE_SPECULATIVE_Q_AGE_MS * defines the amount of time a speculative page is normally * allowed to live in the 'protected' state (i.e. not available * to be stolen if vm_pageout_scan is running and looking for * pages)... however, if the total number of speculative pages * in the protected state exceeds our limit (defined in vm_pageout.c) * and there are none available in VM_PAGE_SPECULATIVE_AGED_Q, then * vm_pageout_scan is allowed to steal pages from the protected * bucket even if they are underage. * * vm_pageout_scan is also allowed to pull pages from a protected * bin if the bin has reached the "age of consent" we've set */ #define VM_PAGE_RESERVED_SPECULATIVE_AGE_Q 40 #define VM_PAGE_DEFAULT_MAX_SPECULATIVE_AGE_Q 10 #define VM_PAGE_MIN_SPECULATIVE_AGE_Q 1 #define VM_PAGE_SPECULATIVE_AGED_Q 0 #define VM_PAGE_SPECULATIVE_Q_AGE_MS 500 struct vm_speculative_age_q { /* * memory queue for speculative pages via clustered pageins */ vm_page_queue_head_t age_q; mach_timespec_t age_ts; } VM_PAGE_PACKED_ALIGNED; extern struct vm_speculative_age_q vm_page_queue_speculative[]; extern int speculative_steal_index; extern int speculative_age_index; extern unsigned int vm_page_speculative_q_age_ms; extern unsigned int vm_page_max_speculative_age_q; typedef struct vm_locks_array { char pad __attribute__ ((aligned(64))); lck_mtx_t vm_page_queue_lock2 __attribute__ ((aligned(64))); lck_mtx_t vm_page_queue_free_lock2 __attribute__ ((aligned(64))); char pad2 __attribute__ ((aligned(64))); } vm_locks_array_t; #define VM_PAGE_WIRED(m) ((m)->vmp_q_state == VM_PAGE_IS_WIRED) #define NEXT_PAGE(m) ((m)->vmp_snext) #define NEXT_PAGE_PTR(m) (&(m)->vmp_snext) /* * XXX The unusual bit should not be necessary. Most of the bit * XXX fields above really want to be masks. */ /* * For debugging, this macro can be defined to perform * some useful check on a page structure. * INTENTIONALLY left as a no-op so that the * current call-sites can be left intact for future uses. */ #define VM_PAGE_CHECK(mem) \ MACRO_BEGIN \ MACRO_END /* Page coloring: * * The free page list is actually n lists, one per color, * where the number of colors is a function of the machine's * cache geometry set at system initialization. To disable * coloring, set vm_colors to 1 and vm_color_mask to 0. * The boot-arg "colors" may be used to override vm_colors. * Note that there is little harm in having more colors than needed. */ #define MAX_COLORS 128 #define DEFAULT_COLORS 32 extern unsigned int vm_colors; /* must be in range 1..MAX_COLORS */ extern unsigned int vm_color_mask; /* must be (vm_colors-1) */ extern unsigned int vm_cache_geometry_colors; /* optimal #colors based on cache geometry */ /* * Wired memory is a very limited resource and we can't let users exhaust it * and deadlock the entire system. We enforce the following limits: * * vm_per_task_user_wire_limit * how much memory can be user-wired in one user task * * vm_global_user_wire_limit (default: same as vm_per_task_user_wire_limit) * how much memory can be user-wired in all user tasks * * These values are set to defaults based on the number of pages managed * by the VM system. They can be overriden via sysctls. * See kmem_set_user_wire_limits for details on the default values. * * Regardless of the amount of memory in the system, we never reserve * more than VM_NOT_USER_WIREABLE_MAX bytes as unlockable. */ #if defined(__LP64__) #define VM_NOT_USER_WIREABLE_MAX (32ULL*1024*1024*1024) /* 32GB */ #else #define VM_NOT_USER_WIREABLE_MAX (1UL*1024*1024*1024) /* 1GB */ #endif /* __LP64__ */ extern vm_map_size_t vm_per_task_user_wire_limit; extern vm_map_size_t vm_global_user_wire_limit; extern uint64_t vm_add_wire_count_over_global_limit; extern uint64_t vm_add_wire_count_over_user_limit; /* * Each pageable resident page falls into one of three lists: * * free * Available for allocation now. The free list is * actually an array of lists, one per color. * inactive * Not referenced in any map, but still has an * object/offset-page mapping, and may be dirty. * This is the list of pages that should be * paged out next. There are actually two * inactive lists, one for pages brought in from * disk or other backing store, and another * for "zero-filled" pages. See vm_pageout_scan() * for the distinction and usage. * active * A list of pages which have been placed in * at least one physical map. This list is * ordered, in LRU-like fashion. */ #define VPL_LOCK_SPIN 1 struct vpl { vm_page_queue_head_t vpl_queue; unsigned int vpl_count; unsigned int vpl_internal_count; unsigned int vpl_external_count; lck_spin_t vpl_lock; }; extern struct vpl * /* __zpercpu */ vm_page_local_q; extern unsigned int vm_page_local_q_soft_limit; extern unsigned int vm_page_local_q_hard_limit; extern vm_locks_array_t vm_page_locks; extern vm_page_queue_head_t vm_lopage_queue_free; /* low memory free queue */ extern vm_page_queue_head_t vm_page_queue_active; /* active memory queue */ extern vm_page_queue_head_t vm_page_queue_inactive; /* inactive memory queue for normal pages */ #if CONFIG_SECLUDED_MEMORY extern vm_page_queue_head_t vm_page_queue_secluded; /* reclaimable pages secluded for Camera */ #endif /* CONFIG_SECLUDED_MEMORY */ extern vm_page_queue_head_t vm_page_queue_cleaned; /* clean-queue inactive memory */ extern vm_page_queue_head_t vm_page_queue_anonymous; /* inactive memory queue for anonymous pages */ extern vm_page_queue_head_t vm_page_queue_throttled; /* memory queue for throttled pageout pages */ extern queue_head_t vm_objects_wired; extern lck_spin_t vm_objects_wired_lock; #define VM_PAGE_DONATE_DISABLED 0 #define VM_PAGE_DONATE_ENABLED 1 extern uint32_t vm_page_donate_mode; extern bool vm_page_donate_queue_ripe; #define VM_PAGE_BACKGROUND_TARGET_MAX 50000 #define VM_PAGE_BG_DISABLED 0 #define VM_PAGE_BG_ENABLED 1 extern vm_page_queue_head_t vm_page_queue_background; extern uint64_t vm_page_background_promoted_count; extern uint32_t vm_page_background_count; extern uint32_t vm_page_background_target; extern uint32_t vm_page_background_internal_count; extern uint32_t vm_page_background_external_count; extern uint32_t vm_page_background_mode; extern uint32_t vm_page_background_exclude_external; extern vm_page_queue_head_t vm_page_queue_donate; extern uint32_t vm_page_donate_count; extern uint32_t vm_page_donate_target_low; extern uint32_t vm_page_donate_target_high; #define VM_PAGE_DONATE_TARGET_LOWWATER (100) #define VM_PAGE_DONATE_TARGET_HIGHWATER ((unsigned int)(atop_64(max_mem) / 8)) extern vm_offset_t first_phys_addr; /* physical address for first_page */ extern vm_offset_t last_phys_addr; /* physical address for last_page */ extern unsigned int vm_page_free_count; /* How many pages are free? (sum of all colors) */ extern unsigned int vm_page_active_count; /* How many pages are active? */ extern unsigned int vm_page_inactive_count; /* How many pages are inactive? */ extern unsigned int vm_page_kernelcache_count; /* How many pages are used for the kernelcache? */ extern unsigned int vm_page_realtime_count; /* How many pages are used by realtime threads? */ #if CONFIG_SECLUDED_MEMORY extern unsigned int vm_page_secluded_count; /* How many pages are secluded? */ extern unsigned int vm_page_secluded_count_free; /* how many of them are free? */ extern unsigned int vm_page_secluded_count_inuse; /* how many of them are in use? */ /* * We keep filling the secluded pool with new eligible pages and * we can overshoot our target by a lot. * When there's memory pressure, vm_pageout_scan() will re-balance the queues, * pushing the extra secluded pages to the active or free queue. * Since these "over target" secluded pages are actually "available", jetsam * should consider them as such, so make them visible to jetsam via the * "vm_page_secluded_count_over_target" counter and update it whenever we * update vm_page_secluded_count or vm_page_secluded_target. */ extern unsigned int vm_page_secluded_count_over_target; #define VM_PAGE_SECLUDED_COUNT_OVER_TARGET_UPDATE() \ MACRO_BEGIN \ if (vm_page_secluded_count > vm_page_secluded_target) { \ vm_page_secluded_count_over_target = \ (vm_page_secluded_count - vm_page_secluded_target); \ } else { \ vm_page_secluded_count_over_target = 0; \ } \ MACRO_END #define VM_PAGE_SECLUDED_COUNT_OVER_TARGET() vm_page_secluded_count_over_target #else /* CONFIG_SECLUDED_MEMORY */ #define VM_PAGE_SECLUDED_COUNT_OVER_TARGET_UPDATE() \ MACRO_BEGIN \ MACRO_END #define VM_PAGE_SECLUDED_COUNT_OVER_TARGET() 0 #endif /* CONFIG_SECLUDED_MEMORY */ extern unsigned int vm_page_cleaned_count; /* How many pages are in the clean queue? */ extern unsigned int vm_page_throttled_count;/* How many inactives are throttled */ extern unsigned int vm_page_speculative_count; /* How many speculative pages are unclaimed? */ extern unsigned int vm_page_pageable_internal_count; extern unsigned int vm_page_pageable_external_count; extern unsigned int vm_page_xpmapped_external_count; /* How many pages are mapped executable? */ extern unsigned int vm_page_external_count; /* How many pages are file-backed? */ extern unsigned int vm_page_internal_count; /* How many pages are anonymous? */ extern unsigned int vm_page_wire_count; /* How many pages are wired? */ extern unsigned int vm_page_wire_count_initial; /* How many pages wired at startup */ extern unsigned int vm_page_wire_count_on_boot; /* even earlier than _initial */ extern unsigned int vm_page_free_target; /* How many do we want free? */ extern unsigned int vm_page_free_min; /* When to wakeup pageout */ extern unsigned int vm_page_throttle_limit; /* When to throttle new page creation */ extern unsigned int vm_page_inactive_target;/* How many do we want inactive? */ #if CONFIG_SECLUDED_MEMORY extern unsigned int vm_page_secluded_target;/* How many do we want secluded? */ #endif /* CONFIG_SECLUDED_MEMORY */ extern unsigned int vm_page_anonymous_min; /* When it's ok to pre-clean */ extern unsigned int vm_page_free_reserved; /* How many pages reserved to do pageout */ extern unsigned int vm_page_gobble_count; extern unsigned int vm_page_stolen_count; /* Count of stolen pages not acccounted in zones */ extern unsigned int vm_page_kern_lpage_count; /* Count of large pages used in early boot */ #if DEVELOPMENT || DEBUG extern unsigned int vm_page_speculative_used; #endif extern unsigned int vm_page_purgeable_count;/* How many pages are purgeable now ? */ extern unsigned int vm_page_purgeable_wired_count;/* How many purgeable pages are wired now ? */ extern uint64_t vm_page_purged_count; /* How many pages got purged so far ? */ extern unsigned int vm_page_free_wanted; /* how many threads are waiting for memory */ extern unsigned int vm_page_free_wanted_privileged; /* how many VM privileged threads are waiting for memory */ #if CONFIG_SECLUDED_MEMORY extern unsigned int vm_page_free_wanted_secluded; /* how many threads are waiting for secluded memory */ #endif /* CONFIG_SECLUDED_MEMORY */ extern const ppnum_t vm_page_fictitious_addr; /* (fake) phys_addr of fictitious pages */ extern const ppnum_t vm_page_guard_addr; /* (fake) phys_addr of guard pages */ extern boolean_t vm_page_deactivate_hint; extern int vm_compressor_mode; /* * Defaults to true, so highest memory is used first. */ extern boolean_t vm_himemory_mode; extern boolean_t vm_lopage_needed; extern uint32_t vm_lopage_free_count; extern uint32_t vm_lopage_free_limit; extern uint32_t vm_lopage_lowater; extern boolean_t vm_lopage_refill; extern uint64_t max_valid_dma_address; extern ppnum_t max_valid_low_ppnum; /* * Prototypes for functions exported by this module. */ extern void vm_page_init_local_q(unsigned int num_cpus); extern void vm_page_create( ppnum_t start, ppnum_t end); extern void vm_page_create_retired( ppnum_t pn); extern boolean_t vm_page_created( vm_page_t page); extern void vm_free_delayed_pages(void); extern vm_page_t vm_page_alloc( vm_object_t object, vm_object_offset_t offset); extern void vm_page_reactivate_all_throttled(void); extern void vm_pressure_response(void); #define AVAILABLE_NON_COMPRESSED_MEMORY (vm_page_active_count + vm_page_inactive_count + vm_page_free_count + vm_page_speculative_count) #define AVAILABLE_MEMORY (AVAILABLE_NON_COMPRESSED_MEMORY + VM_PAGE_COMPRESSOR_COUNT) #if CONFIG_JETSAM #define VM_CHECK_MEMORYSTATUS \ memorystatus_update_available_page_count( \ vm_page_pageable_external_count + \ vm_page_free_count + \ VM_PAGE_SECLUDED_COUNT_OVER_TARGET() + \ (VM_DYNAMIC_PAGING_ENABLED() ? 0 : vm_page_purgeable_count) \ ) #else /* CONFIG_JETSAM */ #if !XNU_TARGET_OS_OSX #define VM_CHECK_MEMORYSTATUS do {} while(0) #else /* !XNU_TARGET_OS_OSX */ #define VM_CHECK_MEMORYSTATUS memorystatus_update_available_page_count(AVAILABLE_NON_COMPRESSED_MEMORY) #endif /* !XNU_TARGET_OS_OSX */ #endif /* CONFIG_JETSAM */ #define vm_page_queue_lock (vm_page_locks.vm_page_queue_lock2) #define vm_page_queue_free_lock (vm_page_locks.vm_page_queue_free_lock2) #ifdef MACH_KERNEL_PRIVATE static inline void vm_page_lock_queues(void) { lck_mtx_lock(&vm_page_queue_lock); } static inline boolean_t vm_page_trylock_queues(void) { boolean_t ret; ret = lck_mtx_try_lock(&vm_page_queue_lock); return ret; } static inline void vm_page_unlock_queues(void) { lck_mtx_unlock(&vm_page_queue_lock); } static inline void vm_page_lockspin_queues(void) { lck_mtx_lock_spin(&vm_page_queue_lock); } static inline boolean_t vm_page_trylockspin_queues(void) { boolean_t ret; ret = lck_mtx_try_lock_spin(&vm_page_queue_lock); return ret; } extern void kdp_vm_page_sleep_find_owner( event64_t wait_event, thread_waitinfo_t *waitinfo); #endif /* MACH_KERNEL_PRIVATE */ extern unsigned int vm_max_delayed_work_limit; #if CONFIG_SECLUDED_MEMORY extern uint64_t secluded_shutoff_trigger; extern uint64_t secluded_shutoff_headroom; extern void start_secluded_suppression(task_t); extern void stop_secluded_suppression(task_t); #endif /* CONFIG_SECLUDED_MEMORY */ #endif /* _VM_VM_PAGE_H_ */