1 /* 2 * Copyright (c) 2024 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 #pragma once 29 #if defined(__LP64__) 30 #include <mach/mach_types.h> 31 #include <mach/vm_reclaim.h> 32 #include <ptrcheck.h> 33 34 /* 35 * This header exists for the internal implementation in libsyscall/xnu 36 * and for observability with debugging tools. It should _NOT_ be used by 37 * clients. 38 */ 39 40 #define VM_RECLAIM_MAX_BUFFER_SIZE (128ull << 20) 41 #define VM_RECLAIM_MAX_CAPACITY ((VM_RECLAIM_MAX_BUFFER_SIZE - \ 42 offsetof(struct mach_vm_reclaim_ring_s, entries)) / \ 43 sizeof(struct mach_vm_reclaim_entry_s)) 44 45 __BEGIN_DECLS 46 47 typedef struct mach_vm_reclaim_indices_s { 48 _Atomic mach_vm_reclaim_id_t head; 49 _Atomic mach_vm_reclaim_id_t tail; 50 _Atomic mach_vm_reclaim_id_t busy; 51 } *mach_vm_reclaim_indices_t; 52 53 typedef struct mach_vm_reclaim_entry_s { 54 mach_vm_address_t address; 55 uint32_t size; 56 mach_vm_reclaim_action_t behavior; 57 uint8_t _unused[3]; 58 } *mach_vm_reclaim_entry_t; 59 60 /* 61 * Contains the data used for synchronization with the kernel. This structure 62 * should be page-aligned. 63 */ 64 struct mach_vm_reclaim_ring_s { 65 mach_vm_size_t va_in_buffer; 66 mach_vm_size_t last_accounting_given_to_kernel; 67 mach_vm_reclaim_count_t len; 68 mach_vm_reclaim_count_t max_len; 69 struct mach_vm_reclaim_indices_s indices; 70 /* 71 * The ringbuffer entries themselves populate the remainder of this 72 * buffer's vm allocation. 73 * NB: the fields preceding `entries` must be aligned to a multiple of 74 * the entry size. 75 */ 76 struct mach_vm_reclaim_entry_s entries[] __counted_by(len); 77 }; 78 79 __END_DECLS 80 #endif /* __LP64__ */ 81