1 /* 2 * Copyright (c) 2023 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 * Purgeable spelling rules 30 * It is believed that the correct spelling is 31 * { 'p', 'u', 'r', 'g', 'e', 'a', 'b', 'l', 'e' }. 32 * However, there is one published API that likes to spell it without the 33 * first 'e', vm_purgable_control(). Since we can't change that API, 34 * here are the rules. 35 * All qualifiers defined in vm_purgable.h are spelled without the e. 36 * All other qualifiers are spelled with the e. 37 * Right now, there are remains of the wrong spelling throughout the code, 38 * vm_object_t.purgable for example. We expect to change these on occasion. 39 */ 40 41 #ifndef __VM_PURGEABLE_XNU__ 42 #define __VM_PURGEABLE_XNU__ 43 44 #ifdef XNU_KERNEL_PRIVATE 45 46 #include <kern/queue.h> 47 48 /* the object purger. purges the next eligible object from memory. */ 49 /* returns TRUE if an object was purged, otherwise FALSE. */ 50 boolean_t vm_purgeable_object_purge_one(int force_purge_below_group, int flags); 51 52 /* statistics for purgable objects in all queues */ 53 void vm_purgeable_stats(vm_purgeable_info_t info, task_t target_task); 54 55 #if DEVELOPMENT || DEBUG 56 /* statistics for purgeable object usage in all queues for a task */ 57 kern_return_t vm_purgeable_account(task_t task, pvm_account_info_t acnt_info); 58 #endif /* DEVELOPMENT || DEBUG */ 59 60 uint64_t vm_purgeable_purge_task_owned(task_t task); 61 62 63 #endif /* XNU_KERNEL_PRIVATE */ 64 65 #endif /* __VM_PURGEABLE_XNU__ */ 66