xref: /xnu-10002.81.5/bsd/sys/kern_memorystatus_notify.h (revision 5e3eaea39dcf651e66cb99ba7d70e32cc4a99587)
1 /*
2  * Copyright (c) 2006-2018 Apple Computer, 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 #ifndef SYS_MEMORYSTATUS_NOTIFY_H
30 #define SYS_MEMORYSTATUS_NOTIFY_H
31 
32 #include <stdint.h>
33 #include <sys/proc.h>
34 #include <sys/param.h>
35 
36 #if VM_PRESSURE_EVENTS
37 
38 extern vm_pressure_level_t memorystatus_vm_pressure_level;
39 extern boolean_t memorystatus_hwm_candidates;
40 extern unsigned int memorystatus_sustained_pressure_maximum_band;
41 
42 boolean_t memorystatus_warn_process(const proc_t p, __unused boolean_t is_active, __unused boolean_t is_fatal, boolean_t exceeded);
43 int memorystatus_send_note(int event_code, void *data, uint32_t data_length);
44 void memorystatus_send_low_swap_note(void);
45 void consider_vm_pressure_events(void);
46 void memorystatus_notify_init(void);
47 
48 #if CONFIG_MEMORYSTATUS
49 
50 int memorystatus_low_mem_privileged_listener(uint32_t op_flags);
51 int memorystatus_send_pressure_note(int pid);
52 boolean_t memorystatus_is_foreground_locked(proc_t p);
53 boolean_t memorystatus_bg_pressure_eligible(proc_t p);
54 void memorystatus_proc_flags_unsafe(void * v, boolean_t *is_dirty, boolean_t *is_dirty_tracked, boolean_t *allow_idle_exit);
55 extern void memorystatus_issue_fg_band_notify(void);
56 
57 #endif /* CONFIG_MEMORYSTATUS */
58 
59 #if DEBUG
60 #define VM_PRESSURE_DEBUG(cond, format, ...)      \
61 do {                                              \
62 if (cond) { printf(format, ##__VA_ARGS__); } \
63 } while(0)
64 #else
65 #define VM_PRESSURE_DEBUG(cond, format, ...)
66 #endif
67 
68 #endif /* VM_PRESSURE_EVENTS */
69 
70 #endif /* SYS_MEMORYSTATUS_NOTIFY_H */
71