xref: /xnu-8792.61.2/tests/memorystatus_is_assertion.c (revision 42e220869062b56f8d7d0726fd4c88954f87902c)
1*42e22086SApple OSS Distributions #include <stdio.h>
2*42e22086SApple OSS Distributions #include <unistd.h>
3*42e22086SApple OSS Distributions #include <stdlib.h>
4*42e22086SApple OSS Distributions #include <errno.h>
5*42e22086SApple OSS Distributions #include <string.h>
6*42e22086SApple OSS Distributions #include <assert.h>
7*42e22086SApple OSS Distributions #include <signal.h>
8*42e22086SApple OSS Distributions #include <spawn.h>
9*42e22086SApple OSS Distributions #include <spawn_private.h>
10*42e22086SApple OSS Distributions #include <stdint.h>
11*42e22086SApple OSS Distributions #include <sys/sysctl.h>
12*42e22086SApple OSS Distributions #include <sys/spawn_internal.h>
13*42e22086SApple OSS Distributions #include <sys/kern_memorystatus.h>
14*42e22086SApple OSS Distributions #include <mach-o/dyld.h>
15*42e22086SApple OSS Distributions 
16*42e22086SApple OSS Distributions #include <darwintest.h>
17*42e22086SApple OSS Distributions #include <darwintest_utils.h>
18*42e22086SApple OSS Distributions 
19*42e22086SApple OSS Distributions #include "memorystatus_assertion_helpers.h"
20*42e22086SApple OSS Distributions 
21*42e22086SApple OSS Distributions T_GLOBAL_META(
22*42e22086SApple OSS Distributions 	T_META_NAMESPACE("xnu.vm"),
23*42e22086SApple OSS Distributions 	T_META_RADAR_COMPONENT_NAME("xnu"),
24*42e22086SApple OSS Distributions 	T_META_RADAR_COMPONENT_VERSION("VM"),
25*42e22086SApple OSS Distributions 	T_META_CHECK_LEAKS(false)
26*42e22086SApple OSS Distributions 	);
27*42e22086SApple OSS Distributions 
28*42e22086SApple OSS Distributions extern char **environ;
29*42e22086SApple OSS Distributions 
30*42e22086SApple OSS Distributions /*
31*42e22086SApple OSS Distributions  * This test has multiple sub-tests that set and then verify jetsam priority transitions
32*42e22086SApple OSS Distributions  * as though they were driven by assertions. It uses the MEMORYSTATUS_CMD_SET_MEMLIMIT_PROPERTIES
33*42e22086SApple OSS Distributions  * version of the memorystatus_control() system call and specifically tests the use of the
34*42e22086SApple OSS Distributions  * MEMORYSTATUS_SET_PRIORITY_ASSERTION flag.
35*42e22086SApple OSS Distributions  *
36*42e22086SApple OSS Distributions  * The kernel will apply policy that chooses a maximum jetsam priority, resolving conflicts
37*42e22086SApple OSS Distributions  * between an assertion driven priority and clean/dirty transition policy.
38*42e22086SApple OSS Distributions  *
39*42e22086SApple OSS Distributions  * Processes that do not opt into dirty-tracking should behave as they always have.
40*42e22086SApple OSS Distributions  * This is the typical App transition behavior.
41*42e22086SApple OSS Distributions  *
42*42e22086SApple OSS Distributions  * Processes that do opt into dirty-tracking have more complex policy:
43*42e22086SApple OSS Distributions  * For example:
44*42e22086SApple OSS Distributions  * A MAX assertion priority will prevent a dirty process from transitioning to a clean
45*42e22086SApple OSS Distributions  * state if the process opts into idle-exit.
46*42e22086SApple OSS Distributions  *    See: memorystatus_schedule_idle_demotion_locked() where we note that
47*42e22086SApple OSS Distributions  *    the process isn't going to be making the trip to the lower bands.
48*42e22086SApple OSS Distributions  *
49*42e22086SApple OSS Distributions  * But a MAX assertion evaluation will not prevent a clean process from transition to dirty.
50*42e22086SApple OSS Distributions  * Assertion driven priorities should not change memory limits, they are expected to
51*42e22086SApple OSS Distributions  * just change a process's position in the jetsam priority bands.
52*42e22086SApple OSS Distributions  *
53*42e22086SApple OSS Distributions  * MEMORYSTATUS_CMD_xxx requires root (in the absence of entitlement).
54*42e22086SApple OSS Distributions  * Use T_META_ASROOT(true) to accomplish this.
55*42e22086SApple OSS Distributions  *
56*42e22086SApple OSS Distributions  * A note on test strategy.  It is not necessary to spawn a child to test these
57*42e22086SApple OSS Distributions  * assertion calls.   The test can act on itself, that is, it can make calls to
58*42e22086SApple OSS Distributions  * set and relinquish assertion state just like it can make calls to do dirty/clean
59*42e22086SApple OSS Distributions  * transitions.  Of course, in reality, we expect only runningboardd to manipulate
60*42e22086SApple OSS Distributions  * assertion based priorities.
61*42e22086SApple OSS Distributions  */
62*42e22086SApple OSS Distributions 
63*42e22086SApple OSS Distributions /*
64*42e22086SApple OSS Distributions  * New flag to tell kernel this is an assertion driven priority update.
65*42e22086SApple OSS Distributions  */
66*42e22086SApple OSS Distributions #ifndef MEMORYSTATUS_SET_PRIORITY_ASSERTION
67*42e22086SApple OSS Distributions #define MEMORYSTATUS_SET_PRIORITY_ASSERTION 0x1
68*42e22086SApple OSS Distributions #endif
69*42e22086SApple OSS Distributions 
70*42e22086SApple OSS Distributions static void
proc_will_set_clean(pid_t pid)71*42e22086SApple OSS Distributions proc_will_set_clean(pid_t pid)
72*42e22086SApple OSS Distributions {
73*42e22086SApple OSS Distributions 	proc_set_dirty(pid, false);
74*42e22086SApple OSS Distributions 	T_LOG("pid[%d] --> now clean", pid);
75*42e22086SApple OSS Distributions 	return;
76*42e22086SApple OSS Distributions }
77*42e22086SApple OSS Distributions 
78*42e22086SApple OSS Distributions static void
proc_will_set_dirty(pid_t pid)79*42e22086SApple OSS Distributions proc_will_set_dirty(pid_t pid)
80*42e22086SApple OSS Distributions {
81*42e22086SApple OSS Distributions 	proc_set_dirty(pid, true);
82*42e22086SApple OSS Distributions 	T_LOG("pid[%d] --> now dirty", pid);
83*42e22086SApple OSS Distributions 	return;
84*42e22086SApple OSS Distributions }
85*42e22086SApple OSS Distributions 
86*42e22086SApple OSS Distributions #define kJetsamAgingPolicyNone                          (0)
87*42e22086SApple OSS Distributions #define kJetsamAgingPolicyLegacy                        (1)
88*42e22086SApple OSS Distributions #define kJetsamAgingPolicySysProcsReclaimedFirst        (2)
89*42e22086SApple OSS Distributions #define kJetsamAgingPolicyAppsReclaimedFirst            (3)
90*42e22086SApple OSS Distributions #define kJetsamAgingPolicyMax                           kJetsamAgingPolicyAppsReclaimedFirst
91*42e22086SApple OSS Distributions 
92*42e22086SApple OSS Distributions #ifndef kMemorystatusAssertion
93*42e22086SApple OSS Distributions #define kMemorystatusAssertion 0x40
94*42e22086SApple OSS Distributions #endif
95*42e22086SApple OSS Distributions 
96*42e22086SApple OSS Distributions /*
97*42e22086SApple OSS Distributions  * Make repetitive (eg: back-to-back) calls using MEMORYSTATUS_SET_PRIORITY_ASSERTION.
98*42e22086SApple OSS Distributions  * We know that runningboardd may try to relinquish its hold on an assertion priority
99*42e22086SApple OSS Distributions  * when it hasn't first set the assertion priority. The kernel must survive this
100*42e22086SApple OSS Distributions  * pattern even though it might be considered poor behavior on runningboardd's part.
101*42e22086SApple OSS Distributions  * When dirty tracking processes are involved, we are exercising the kernel's
102*42e22086SApple OSS Distributions  * idle-deferred paths. Only assertion state (whether or not assertion state is
103*42e22086SApple OSS Distributions  * set or relinquished) is verified in this round of tests.
104*42e22086SApple OSS Distributions  * Test is invoked three times:
105*42e22086SApple OSS Distributions  *	Scenario 1) as a non-dirty-tracking process  (like a typical app)
106*42e22086SApple OSS Distributions  *		relinquish assertion priority multiple times
107*42e22086SApple OSS Distributions  *		set same assertion priority multiple times.
108*42e22086SApple OSS Distributions  *	Scenario 2) setup a dirty-tracking process that is clean  (like a typical extension)
109*42e22086SApple OSS Distributions  *		relinquish assertion priority multiple times
110*42e22086SApple OSS Distributions  *		set same assertion priority multiple times.
111*42e22086SApple OSS Distributions  *	Scenario 3) setup dirty-tracking process that is dirty  (like a typical extension)
112*42e22086SApple OSS Distributions  *		relinquish assertion priority multiple times
113*42e22086SApple OSS Distributions  *		set same assertion priority multiple times.
114*42e22086SApple OSS Distributions  */
115*42e22086SApple OSS Distributions 
116*42e22086SApple OSS Distributions static void
memorystatus_assertion_test_repetitive(char * test,boolean_t turn_on_dirty_tracking,boolean_t start_clean)117*42e22086SApple OSS Distributions memorystatus_assertion_test_repetitive(char *test, boolean_t turn_on_dirty_tracking, boolean_t start_clean)
118*42e22086SApple OSS Distributions {
119*42e22086SApple OSS Distributions 	int count;
120*42e22086SApple OSS Distributions 	int maxcount = 3;
121*42e22086SApple OSS Distributions 	boolean_t verbose;
122*42e22086SApple OSS Distributions 	uint32_t state;
123*42e22086SApple OSS Distributions 	uint64_t user_data = 0;
124*42e22086SApple OSS Distributions 	pid_t mypid = getpid();
125*42e22086SApple OSS Distributions 
126*42e22086SApple OSS Distributions 	/* these values will remain fixed during testing */
127*42e22086SApple OSS Distributions 	int             active_limit_mb = 35;   /* arbitrary */
128*42e22086SApple OSS Distributions 	int             inactive_limit_mb = 25;  /* arbitrary */
129*42e22086SApple OSS Distributions 
130*42e22086SApple OSS Distributions 	/* these values may vary during test */
131*42e22086SApple OSS Distributions 	int             requestedpriority = 0;
132*42e22086SApple OSS Distributions 	int             assertionpriority = 0;
133*42e22086SApple OSS Distributions 
134*42e22086SApple OSS Distributions 	T_SETUPBEGIN;
135*42e22086SApple OSS Distributions 
136*42e22086SApple OSS Distributions 	requestedpriority =  JETSAM_PRIORITY_UI_SUPPORT;
137*42e22086SApple OSS Distributions 	assertionpriority =  JETSAM_PRIORITY_FOREGROUND;
138*42e22086SApple OSS Distributions 	set_memlimits(mypid, active_limit_mb, inactive_limit_mb, true, true);
139*42e22086SApple OSS Distributions 	set_priority(mypid, requestedpriority, 0, false);
140*42e22086SApple OSS Distributions 
141*42e22086SApple OSS Distributions 	if (turn_on_dirty_tracking) {
142*42e22086SApple OSS Distributions 		proc_track_dirty(mypid, (PROC_DIRTY_TRACK | PROC_DIRTY_ALLOW_IDLE_EXIT | PROC_DIRTY_DEFER));
143*42e22086SApple OSS Distributions 
144*42e22086SApple OSS Distributions 		if (start_clean) {
145*42e22086SApple OSS Distributions 			proc_will_set_clean(mypid);
146*42e22086SApple OSS Distributions 		} else {
147*42e22086SApple OSS Distributions 			proc_will_set_dirty(mypid);
148*42e22086SApple OSS Distributions 		}
149*42e22086SApple OSS Distributions 	} else {
150*42e22086SApple OSS Distributions 		/*
151*42e22086SApple OSS Distributions 		 * Do nothing.
152*42e22086SApple OSS Distributions 		 * Acts like an app with no dirty tracking
153*42e22086SApple OSS Distributions 		 * By default launches in the requested priority and is
154*42e22086SApple OSS Distributions 		 * considered idle because it's below FG band.
155*42e22086SApple OSS Distributions 		 */
156*42e22086SApple OSS Distributions 	}
157*42e22086SApple OSS Distributions 
158*42e22086SApple OSS Distributions 
159*42e22086SApple OSS Distributions 	verbose = false;
160*42e22086SApple OSS Distributions 	(void)get_priority_props(mypid, verbose, NULL, NULL, NULL, NULL);
161*42e22086SApple OSS Distributions 
162*42e22086SApple OSS Distributions 	/* log current setup state */
163*42e22086SApple OSS Distributions 	T_LOG("SETUP STATE COMPLETE: Test %s", test);
164*42e22086SApple OSS Distributions 
165*42e22086SApple OSS Distributions 	T_SETUPEND;
166*42e22086SApple OSS Distributions 
167*42e22086SApple OSS Distributions 	int i;
168*42e22086SApple OSS Distributions 	boolean_t ret;
169*42e22086SApple OSS Distributions 	for (i = 0; i < 2; i++) {
170*42e22086SApple OSS Distributions 		if (i == 1 && turn_on_dirty_tracking) {
171*42e22086SApple OSS Distributions 			T_LOG("Avoid idle-deferred - sleeping for 20");
172*42e22086SApple OSS Distributions 			sleep(20);
173*42e22086SApple OSS Distributions 
174*42e22086SApple OSS Distributions 			if (start_clean) {
175*42e22086SApple OSS Distributions 				proc_will_set_dirty(mypid);
176*42e22086SApple OSS Distributions 			} else {
177*42e22086SApple OSS Distributions 				proc_will_set_clean(mypid);
178*42e22086SApple OSS Distributions 			}
179*42e22086SApple OSS Distributions 
180*42e22086SApple OSS Distributions 			(void)get_priority_props(mypid, verbose, NULL, NULL, NULL, &state);
181*42e22086SApple OSS Distributions 		}
182*42e22086SApple OSS Distributions 
183*42e22086SApple OSS Distributions 		/*
184*42e22086SApple OSS Distributions 		 * Relinquish assertion priority even though we don't
185*42e22086SApple OSS Distributions 		 * currently hold an assertion priority.
186*42e22086SApple OSS Distributions 		 */
187*42e22086SApple OSS Distributions 		for (count = 0; count < maxcount; count++) {
188*42e22086SApple OSS Distributions 			if (relinquish_assertion_priority(mypid, user_data)) {
189*42e22086SApple OSS Distributions 				T_ASSERT_FAIL("relinquish_assertion_priority failed");
190*42e22086SApple OSS Distributions 			}
191*42e22086SApple OSS Distributions 		}
192*42e22086SApple OSS Distributions 
193*42e22086SApple OSS Distributions 		/* Verify assertion state is relinquished */
194*42e22086SApple OSS Distributions 		(void)get_priority_props(mypid, verbose, NULL, NULL, NULL, &state);
195*42e22086SApple OSS Distributions 
196*42e22086SApple OSS Distributions 		ret = verify_assertion_state(state, ASSERTION_STATE_IS_RELINQUISHED);
197*42e22086SApple OSS Distributions 		T_QUIET;
198*42e22086SApple OSS Distributions 		T_ASSERT_TRUE(ret, "verify_assertion_state failed");
199*42e22086SApple OSS Distributions 
200*42e22086SApple OSS Distributions 
201*42e22086SApple OSS Distributions 
202*42e22086SApple OSS Distributions 		/*
203*42e22086SApple OSS Distributions 		 * Set an assertion priority multiple times in a row.
204*42e22086SApple OSS Distributions 		 */
205*42e22086SApple OSS Distributions 		for (count = 0; count < maxcount; count++) {
206*42e22086SApple OSS Distributions 			if (set_assertion_priority(mypid, assertionpriority, user_data) != 0) {
207*42e22086SApple OSS Distributions 				T_ASSERT_FAIL("set_assertion_priority failed");
208*42e22086SApple OSS Distributions 			}
209*42e22086SApple OSS Distributions 		}
210*42e22086SApple OSS Distributions 
211*42e22086SApple OSS Distributions 		/* Verify state holds an assertion priority */
212*42e22086SApple OSS Distributions 		(void)get_priority_props(mypid, verbose, NULL, NULL, NULL, &state);
213*42e22086SApple OSS Distributions 
214*42e22086SApple OSS Distributions 		ret = verify_assertion_state(state, ASSERTION_STATE_IS_SET);
215*42e22086SApple OSS Distributions 		T_QUIET;
216*42e22086SApple OSS Distributions 		T_ASSERT_TRUE(ret, "verify_assertion_state failed");
217*42e22086SApple OSS Distributions 	}
218*42e22086SApple OSS Distributions }
219*42e22086SApple OSS Distributions 
220*42e22086SApple OSS Distributions /*
221*42e22086SApple OSS Distributions  * Process is dirty tracking and opts into pressured exit.
222*42e22086SApple OSS Distributions  */
223*42e22086SApple OSS Distributions static void
memorystatus_assertion_test_allow_idle_exit()224*42e22086SApple OSS Distributions memorystatus_assertion_test_allow_idle_exit()
225*42e22086SApple OSS Distributions {
226*42e22086SApple OSS Distributions 	pid_t mypid = getpid();
227*42e22086SApple OSS Distributions 
228*42e22086SApple OSS Distributions 	/* these values will remain fixed during testing */
229*42e22086SApple OSS Distributions 	int active_limit_mb   = 35; /* arbitrary */
230*42e22086SApple OSS Distributions 	int inactive_limit_mb = 25;  /* arbitrary */
231*42e22086SApple OSS Distributions 
232*42e22086SApple OSS Distributions 	/* these values may vary during test */
233*42e22086SApple OSS Distributions 	int requestedpriority = JETSAM_PRIORITY_UI_SUPPORT;
234*42e22086SApple OSS Distributions 
235*42e22086SApple OSS Distributions 	T_SETUPBEGIN;
236*42e22086SApple OSS Distributions 
237*42e22086SApple OSS Distributions 	set_memlimits(mypid, active_limit_mb, inactive_limit_mb, true, true);
238*42e22086SApple OSS Distributions 	set_priority(mypid, requestedpriority, 0, false);
239*42e22086SApple OSS Distributions 
240*42e22086SApple OSS Distributions 	proc_track_dirty(mypid, (PROC_DIRTY_TRACK | PROC_DIRTY_ALLOW_IDLE_EXIT | PROC_DIRTY_DEFER));
241*42e22086SApple OSS Distributions 
242*42e22086SApple OSS Distributions 	proc_will_set_clean(mypid);
243*42e22086SApple OSS Distributions 
244*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_IDLE_DEFERRED, inactive_limit_mb, 0x0, ASSERTION_STATE_IS_RELINQUISHED, "Clean start");
245*42e22086SApple OSS Distributions 
246*42e22086SApple OSS Distributions 	T_LOG("SETUP STATE COMPLETE");
247*42e22086SApple OSS Distributions 
248*42e22086SApple OSS Distributions 	int g_jetsam_aging_policy = 0;
249*42e22086SApple OSS Distributions 	/*
250*42e22086SApple OSS Distributions 	 * Jetsam aging policy
251*42e22086SApple OSS Distributions 	 * Failure to retrieve is not fatal.
252*42e22086SApple OSS Distributions 	 */
253*42e22086SApple OSS Distributions 	size_t size = sizeof(g_jetsam_aging_policy);
254*42e22086SApple OSS Distributions 	if (sysctlbyname("kern.jetsam_aging_policy", &g_jetsam_aging_policy, &size, NULL, 0) != 0) {
255*42e22086SApple OSS Distributions 		T_LOG(__func__, true, "Unable to retrieve jetsam aging policy (not fatal)");
256*42e22086SApple OSS Distributions 	}
257*42e22086SApple OSS Distributions 
258*42e22086SApple OSS Distributions 	T_SETUPEND;
259*42e22086SApple OSS Distributions 
260*42e22086SApple OSS Distributions 	/*
261*42e22086SApple OSS Distributions 	 * Relinquish assertion priority even though we don't hold it.  No change in state expected.
262*42e22086SApple OSS Distributions 	 */
263*42e22086SApple OSS Distributions 	T_LOG("********Test0 clean: no state change on relinquish");
264*42e22086SApple OSS Distributions 	relinquish_assertion_priority(mypid, 0xF00D);
265*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_IDLE_DEFERRED, inactive_limit_mb, 0xF00D, ASSERTION_STATE_IS_RELINQUISHED, "Test0");
266*42e22086SApple OSS Distributions 
267*42e22086SApple OSS Distributions 	T_LOG("********Test1 clean: deferred now assertion[10]");
268*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_FOREGROUND, 0xFEED);
269*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_FOREGROUND, inactive_limit_mb, 0xFEED, ASSERTION_STATE_IS_SET, "Test1");
270*42e22086SApple OSS Distributions 
271*42e22086SApple OSS Distributions 	/* Test2 */
272*42e22086SApple OSS Distributions 	T_LOG("********Test2 clean:  assertion[10 -> 3]");
273*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_BACKGROUND, 0xFACE);
274*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_BACKGROUND, inactive_limit_mb, 0xFACE, ASSERTION_STATE_IS_SET, "Test2");
275*42e22086SApple OSS Distributions 
276*42e22086SApple OSS Distributions 	/* Test3 */
277*42e22086SApple OSS Distributions 	T_LOG("********Test3 clean: assertion[3 -> 0], but now deferred");
278*42e22086SApple OSS Distributions 	relinquish_assertion_priority(mypid, 0xBEEF);
279*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_IDLE_DEFERRED, inactive_limit_mb, 0xBEEF, ASSERTION_STATE_IS_RELINQUISHED, "Test3");
280*42e22086SApple OSS Distributions 
281*42e22086SApple OSS Distributions 	/* Test4 */
282*42e22086SApple OSS Distributions 	T_LOG("********Test4 clean: deferred now assertion[10]");
283*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_FOREGROUND, 0xFEED);
284*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_FOREGROUND, inactive_limit_mb, 0xFEED, ASSERTION_STATE_IS_SET, "Test4");
285*42e22086SApple OSS Distributions 
286*42e22086SApple OSS Distributions 	T_LOG("Avoid idle-deferred moving forward. Sleeping for 20");
287*42e22086SApple OSS Distributions 	sleep(20);
288*42e22086SApple OSS Distributions 
289*42e22086SApple OSS Distributions 	/* Test5 */
290*42e22086SApple OSS Distributions 	T_LOG("********Test5 dirty: set dirty priority but assertion[10] prevails");
291*42e22086SApple OSS Distributions 	proc_will_set_dirty(mypid);   /* active priority is less than FG*/
292*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_FOREGROUND, active_limit_mb, 0xFEED, ASSERTION_STATE_IS_SET, "Test5");
293*42e22086SApple OSS Distributions 
294*42e22086SApple OSS Distributions 	/* Test6 */
295*42e22086SApple OSS Distributions 	T_LOG("********Test6 dirty: assertion[10 -> 3] but dirty priority prevails");
296*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_BACKGROUND, 0xFEEB);  /* active priority is > BG */
297*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_UI_SUPPORT, active_limit_mb, 0xFEEB, ASSERTION_STATE_IS_SET, "Test6");
298*42e22086SApple OSS Distributions 
299*42e22086SApple OSS Distributions 	/* Test7 */
300*42e22086SApple OSS Distributions 	T_LOG("********Test7 dirty: assertion[3 -> 0] but dirty prevails");
301*42e22086SApple OSS Distributions 	relinquish_assertion_priority(mypid, 0xBEEF);
302*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_UI_SUPPORT, active_limit_mb, 0xBEEF, ASSERTION_STATE_IS_RELINQUISHED, "Test7");
303*42e22086SApple OSS Distributions 
304*42e22086SApple OSS Distributions 
305*42e22086SApple OSS Distributions 	/* Test8 */
306*42e22086SApple OSS Distributions 	T_LOG("********Test8 dirty: assertion[0 -> 10] overrides dirty");
307*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_FOREGROUND, 0xFEED);
308*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_FOREGROUND, active_limit_mb, 0xFEED, ASSERTION_STATE_IS_SET, "Test8");
309*42e22086SApple OSS Distributions 
310*42e22086SApple OSS Distributions 	/* Test9 */
311*42e22086SApple OSS Distributions 	T_LOG("********Test9 dirty wants to go clean, but clean state is prevented as assertion[10] prevails");
312*42e22086SApple OSS Distributions 	proc_will_set_clean(mypid);
313*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_FOREGROUND, active_limit_mb, 0xFEED, ASSERTION_STATE_IS_SET, "Test9");
314*42e22086SApple OSS Distributions 
315*42e22086SApple OSS Distributions 	/* Test10 */
316*42e22086SApple OSS Distributions 	T_LOG("********Test10 dirty goes dirty and stays dirty, and assertion[10] prevails again");
317*42e22086SApple OSS Distributions 	proc_will_set_dirty(mypid);
318*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_FOREGROUND, active_limit_mb, 0xFEED, ASSERTION_STATE_IS_SET, "Test10");
319*42e22086SApple OSS Distributions 
320*42e22086SApple OSS Distributions 	/* Test11 */
321*42e22086SApple OSS Distributions 	T_LOG("********Test11 dirty: assertion[10 -> 3] but dirty prevails");
322*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_BACKGROUND, 0xFACE);
323*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_UI_SUPPORT, active_limit_mb, 0xFACE, ASSERTION_STATE_IS_SET, "Test11");
324*42e22086SApple OSS Distributions 
325*42e22086SApple OSS Distributions 	/* Test12 */
326*42e22086SApple OSS Distributions 	T_LOG("********Test12 dirty: assertion[3 -> 0] but dirty prevails");
327*42e22086SApple OSS Distributions 	relinquish_assertion_priority(mypid, 0xBEEF);
328*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_UI_SUPPORT, active_limit_mb, 0xBEEF, ASSERTION_STATE_IS_RELINQUISHED, "Test12");
329*42e22086SApple OSS Distributions 
330*42e22086SApple OSS Distributions 
331*42e22086SApple OSS Distributions 	/* Test13 */
332*42e22086SApple OSS Distributions 	T_LOG("********Test13 dirty goes clean: both assertion[0] and clean");
333*42e22086SApple OSS Distributions 	proc_will_set_clean(mypid);
334*42e22086SApple OSS Distributions 	if (g_jetsam_aging_policy == kJetsamAgingPolicySysProcsReclaimedFirst) {
335*42e22086SApple OSS Distributions 		/* For sysproc aging policy the daemon should be at idle deferred and with an active memory limit */
336*42e22086SApple OSS Distributions 		(void)check_properties(mypid, JETSAM_PRIORITY_IDLE_DEFERRED, active_limit_mb, 0xBEEF, ASSERTION_STATE_IS_RELINQUISHED, "Test13");
337*42e22086SApple OSS Distributions 	} else {
338*42e22086SApple OSS Distributions 		/* For the legacy aging policy, daemon should be at idle band with inactive memory limit */
339*42e22086SApple OSS Distributions 		(void)check_properties(mypid, JETSAM_PRIORITY_IDLE, inactive_limit_mb, 0xBEEF, ASSERTION_STATE_IS_RELINQUISHED, "Test13");
340*42e22086SApple OSS Distributions 	}
341*42e22086SApple OSS Distributions }
342*42e22086SApple OSS Distributions 
343*42e22086SApple OSS Distributions /*
344*42e22086SApple OSS Distributions  * Process is dirty tracking and does not opt into pressured exit.
345*42e22086SApple OSS Distributions  * This test lives above Foreground.  Assertions will have no affect
346*42e22086SApple OSS Distributions  * except where the assertion priority bumps it above the requested priority.
347*42e22086SApple OSS Distributions  */
348*42e22086SApple OSS Distributions static void
memorystatus_assertion_test_do_not_allow_idle_exit()349*42e22086SApple OSS Distributions memorystatus_assertion_test_do_not_allow_idle_exit()
350*42e22086SApple OSS Distributions {
351*42e22086SApple OSS Distributions 	pid_t mypid = getpid();
352*42e22086SApple OSS Distributions 
353*42e22086SApple OSS Distributions 	/* these values will remain fixed during testing */
354*42e22086SApple OSS Distributions 	int             active_limit_mb = 35;   /* arbitrary */
355*42e22086SApple OSS Distributions 	int             inactive_limit_mb = 25;  /* arbitrary */
356*42e22086SApple OSS Distributions 	int             requestedpriority = JETSAM_PRIORITY_AUDIO_AND_ACCESSORY;
357*42e22086SApple OSS Distributions 
358*42e22086SApple OSS Distributions 	T_SETUPBEGIN;
359*42e22086SApple OSS Distributions 
360*42e22086SApple OSS Distributions 	set_memlimits(mypid, active_limit_mb, inactive_limit_mb, true, true);
361*42e22086SApple OSS Distributions 	set_priority(mypid, requestedpriority, 0, false);
362*42e22086SApple OSS Distributions 	proc_track_dirty(mypid, (PROC_DIRTY_TRACK));
363*42e22086SApple OSS Distributions 
364*42e22086SApple OSS Distributions 	proc_will_set_dirty(mypid);
365*42e22086SApple OSS Distributions 
366*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, active_limit_mb, 0x0, ASSERTION_STATE_IS_RELINQUISHED, "Dirty start");
367*42e22086SApple OSS Distributions 
368*42e22086SApple OSS Distributions 	proc_will_set_clean(mypid);
369*42e22086SApple OSS Distributions 
370*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, inactive_limit_mb, 0x0, ASSERTION_STATE_IS_RELINQUISHED, "Clean transition");
371*42e22086SApple OSS Distributions 
372*42e22086SApple OSS Distributions 	T_LOG("SETUP STATE COMPLETE");
373*42e22086SApple OSS Distributions 
374*42e22086SApple OSS Distributions 	T_SETUPEND;
375*42e22086SApple OSS Distributions 
376*42e22086SApple OSS Distributions 	/*
377*42e22086SApple OSS Distributions 	 * Relinquish assertion priority even though we don't hold it.  No change in state expected.
378*42e22086SApple OSS Distributions 	 */
379*42e22086SApple OSS Distributions 
380*42e22086SApple OSS Distributions 
381*42e22086SApple OSS Distributions 	/* Test0 */
382*42e22086SApple OSS Distributions 	T_LOG("********Test0 clean: no state change on relinquish");
383*42e22086SApple OSS Distributions 	relinquish_assertion_priority(mypid, 0xF00D);
384*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, inactive_limit_mb, 0xF00D, ASSERTION_STATE_IS_RELINQUISHED, "Test0");
385*42e22086SApple OSS Distributions 
386*42e22086SApple OSS Distributions 	/* Test1 */
387*42e22086SApple OSS Distributions 	T_LOG("********Test1 clean: assertion[0 -> 10] but inactive priority prevails");
388*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_FOREGROUND, 0xFEED);
389*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, inactive_limit_mb, 0xFEED, ASSERTION_STATE_IS_SET, "Test1");
390*42e22086SApple OSS Distributions 
391*42e22086SApple OSS Distributions 	/* Test2 */
392*42e22086SApple OSS Distributions 	T_LOG("********Test2 clean:  assertion[10 -> 3] but inactive priority prevails");
393*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_BACKGROUND, 0xFACE);
394*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, inactive_limit_mb, 0xFACE, ASSERTION_STATE_IS_SET, "Test2");
395*42e22086SApple OSS Distributions 
396*42e22086SApple OSS Distributions 	/* Test3 */
397*42e22086SApple OSS Distributions 	T_LOG("********Test3 clean: assertion[3 -> 0], but inactive priority prevails");
398*42e22086SApple OSS Distributions 	relinquish_assertion_priority(mypid, 0xBEEF);
399*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, inactive_limit_mb, 0xBEEF, ASSERTION_STATE_IS_RELINQUISHED, "Test3");
400*42e22086SApple OSS Distributions 
401*42e22086SApple OSS Distributions 	/* Test4 */
402*42e22086SApple OSS Distributions 	T_LOG("********Test4 go dirty: assertion[0] has no affect, active priority prevails");
403*42e22086SApple OSS Distributions 	proc_will_set_dirty(mypid);
404*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, active_limit_mb, 0xBEEF, ASSERTION_STATE_IS_RELINQUISHED, "Test4");
405*42e22086SApple OSS Distributions 
406*42e22086SApple OSS Distributions 	/* Test5 */
407*42e22086SApple OSS Distributions 	T_LOG("********Test5 dirty: assertion[0 -> 10] active priority prevails");
408*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_FOREGROUND, 0xFEED);
409*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, active_limit_mb, 0xFEED, ASSERTION_STATE_IS_SET, "Test5");
410*42e22086SApple OSS Distributions 
411*42e22086SApple OSS Distributions 	/* Test6 */
412*42e22086SApple OSS Distributions 	T_LOG("********Test6 dirty:  assertion[10 -> 3] active priority prevails");
413*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_BACKGROUND, 0xFACE);
414*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, active_limit_mb, 0xFACE, ASSERTION_STATE_IS_SET, "Test6");
415*42e22086SApple OSS Distributions 
416*42e22086SApple OSS Distributions 	/* Test 7 */
417*42e22086SApple OSS Distributions 	T_LOG("********Test7 dirty: assertion[3 -> 0], active priority prevails");
418*42e22086SApple OSS Distributions 	relinquish_assertion_priority(mypid, 0xBEEF);
419*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, active_limit_mb, 0xBEEF, ASSERTION_STATE_IS_RELINQUISHED, "Test7");
420*42e22086SApple OSS Distributions 
421*42e22086SApple OSS Distributions 	/* Test8 */
422*42e22086SApple OSS Distributions 	T_LOG("********Test8 dirty: assertion[0 -> 19], dirty but now assertion[19] prevails");
423*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_CRITICAL, 0xFEED);
424*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_CRITICAL, active_limit_mb, 0xFEED, ASSERTION_STATE_IS_SET, "Test8");
425*42e22086SApple OSS Distributions 
426*42e22086SApple OSS Distributions 
427*42e22086SApple OSS Distributions 	/* Test9 */
428*42e22086SApple OSS Distributions 	T_LOG("********Test9 go clean: inactive priority but assertion[19] prevails");
429*42e22086SApple OSS Distributions 	proc_will_set_clean(mypid);
430*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_CRITICAL, inactive_limit_mb, 0xFEED, ASSERTION_STATE_IS_SET, "Test9");
431*42e22086SApple OSS Distributions 
432*42e22086SApple OSS Distributions 	/* Test10 */
433*42e22086SApple OSS Distributions 	T_LOG("********Test10 clean:  assertion[19 -> 3] inactive limit prevails");
434*42e22086SApple OSS Distributions 	set_assertion_priority(mypid, JETSAM_PRIORITY_BACKGROUND, 0xFACE);
435*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, inactive_limit_mb, 0xFACE, ASSERTION_STATE_IS_SET, "Test10");
436*42e22086SApple OSS Distributions 
437*42e22086SApple OSS Distributions 
438*42e22086SApple OSS Distributions 	/* Test11 */
439*42e22086SApple OSS Distributions 	T_LOG("********Test11 clean:  assertion[3 -> 0] inactive priority still prevails");
440*42e22086SApple OSS Distributions 	relinquish_assertion_priority(mypid, 0xBEEF);
441*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, inactive_limit_mb, 0xBEEF, ASSERTION_STATE_IS_RELINQUISHED, "Test11");
442*42e22086SApple OSS Distributions 
443*42e22086SApple OSS Distributions 	/* Test12 */
444*42e22086SApple OSS Distributions 	T_LOG("********Test12 dirty goes clean: both assertion[0] and clean");
445*42e22086SApple OSS Distributions 	proc_will_set_clean(mypid);
446*42e22086SApple OSS Distributions 	(void)check_properties(mypid, JETSAM_PRIORITY_AUDIO_AND_ACCESSORY, inactive_limit_mb, 0xBEEF, ASSERTION_STATE_IS_RELINQUISHED, "Test12");
447*42e22086SApple OSS Distributions }
448*42e22086SApple OSS Distributions 
449*42e22086SApple OSS Distributions T_DECL(assertion_test_bad_flags, "verify bad flag returns an error", T_META_TIMEOUT(30), T_META_ASROOT(true)) {
450*42e22086SApple OSS Distributions 	int err;
451*42e22086SApple OSS Distributions 	uint32_t flag = 0;
452*42e22086SApple OSS Distributions 
453*42e22086SApple OSS Distributions 	memorystatus_priority_properties_t mjp = { 0 };
454*42e22086SApple OSS Distributions 
455*42e22086SApple OSS Distributions 	mjp.priority = JETSAM_PRIORITY_FOREGROUND;
456*42e22086SApple OSS Distributions 	mjp.user_data = 0;
457*42e22086SApple OSS Distributions 
458*42e22086SApple OSS Distributions 	/*
459*42e22086SApple OSS Distributions 	 * init a bad flag
460*42e22086SApple OSS Distributions 	 */
461*42e22086SApple OSS Distributions 
462*42e22086SApple OSS Distributions 	flag = 0xf;
463*42e22086SApple OSS Distributions 
464*42e22086SApple OSS Distributions 	err = memorystatus_control(MEMORYSTATUS_CMD_SET_PRIORITY_PROPERTIES, getpid(), flag, &mjp, sizeof(mjp));
465*42e22086SApple OSS Distributions 
466*42e22086SApple OSS Distributions 	T_QUIET;
467*42e22086SApple OSS Distributions 	T_ASSERT_POSIX_FAILURE(err, EINVAL, "MEMORYSTATUS_CMD_SET_PRIORITY_PROPERTIES should fail with bad flags (err=%d)", err);
468*42e22086SApple OSS Distributions }
469*42e22086SApple OSS Distributions 
470*42e22086SApple OSS Distributions #if TARGET_OS_OSX
471*42e22086SApple OSS Distributions /*
472*42e22086SApple OSS Distributions  * Idle band deferral, aka aging band/demotion, has been disabled on macOS till
473*42e22086SApple OSS Distributions  * we do the daemon hygiene work on macOS to make sure that processes don't change
474*42e22086SApple OSS Distributions  * their role after spawn e.g. apps opting into dirty-tracking/idle-exit.
475*42e22086SApple OSS Distributions  * The following set of tests rely on PROC_DIRTY_DEFER, aka aging bands, for the tests.
476*42e22086SApple OSS Distributions  */
477*42e22086SApple OSS Distributions #else /* TARGET_OS_OSX */
478*42e22086SApple OSS Distributions 
479*42e22086SApple OSS Distributions T_DECL(assertion_test_repetitive_non_dirty_tracking, "Scenario #1 - repetitive assertion priority on non-dirty-tracking process", T_META_TIMEOUT(60), T_META_ASROOT(true)) {
480*42e22086SApple OSS Distributions 	/*
481*42e22086SApple OSS Distributions 	 * Verify back-to-back assertion calls set assertion state as expected.
482*42e22086SApple OSS Distributions 	 * false --> non-dirty-tracking process (like a typical app)
483*42e22086SApple OSS Distributions 	 * false --> clean/dirty does not apply here
484*42e22086SApple OSS Distributions 	 */
485*42e22086SApple OSS Distributions 
486*42e22086SApple OSS Distributions 	memorystatus_assertion_test_repetitive("Scenario #1", false, false);
487*42e22086SApple OSS Distributions }
488*42e22086SApple OSS Distributions 
489*42e22086SApple OSS Distributions T_DECL(assertion_test_repetitive_dirty_tracking_clean, "Scenario #2 - repetitive assertion priority on clean dirty-tracking process", T_META_TIMEOUT(60), T_META_ASROOT(true)) {
490*42e22086SApple OSS Distributions 	/*
491*42e22086SApple OSS Distributions 	 * Verify back-to-back assertion calls set assertion state as expected.
492*42e22086SApple OSS Distributions 	 * true --> dirty-tracking process (like a typical extension/widget)
493*42e22086SApple OSS Distributions 	 * true --> start clean / inactive
494*42e22086SApple OSS Distributions 	 * This will exercise idle-deferred paths.
495*42e22086SApple OSS Distributions 	 */
496*42e22086SApple OSS Distributions 	memorystatus_assertion_test_repetitive("Scenario #2", true, true);
497*42e22086SApple OSS Distributions }
498*42e22086SApple OSS Distributions 
499*42e22086SApple OSS Distributions T_DECL(assertion_test_repetitive_dirty_tracking_dirty, "Scenario #3 - repetitive assertion priority on dirty dirty-tracking processes", T_META_TIMEOUT(60), T_META_ASROOT(true)) {
500*42e22086SApple OSS Distributions 	/*
501*42e22086SApple OSS Distributions 	 * Verify back-to-back assertion calls set assertion state as expected.
502*42e22086SApple OSS Distributions 	 * true --> dirty-tracking process (like a typical extension/widget)
503*42e22086SApple OSS Distributions 	 * false --> start dirty / active state
504*42e22086SApple OSS Distributions 	 * This will exercise idle-deferred paths.
505*42e22086SApple OSS Distributions 	 */
506*42e22086SApple OSS Distributions 	memorystatus_assertion_test_repetitive("Scenario #3", true, false);
507*42e22086SApple OSS Distributions }
508*42e22086SApple OSS Distributions 
509*42e22086SApple OSS Distributions 
510*42e22086SApple OSS Distributions T_DECL(assertion_test_allow_idle_exit, "set assertion priorities on process supporting idle exit", T_META_TIMEOUT(360), T_META_ASROOT(true)) {
511*42e22086SApple OSS Distributions 	memorystatus_assertion_test_allow_idle_exit();
512*42e22086SApple OSS Distributions }
513*42e22086SApple OSS Distributions 
514*42e22086SApple OSS Distributions T_DECL(assertion_test_do_not_allow_idle_exit, "set assertion priorities on process no idle exit allowed", T_META_TIMEOUT(360), T_META_ASROOT(true)) {
515*42e22086SApple OSS Distributions 	memorystatus_assertion_test_do_not_allow_idle_exit();
516*42e22086SApple OSS Distributions }
517*42e22086SApple OSS Distributions #endif /* TARGET_OS_OSX */
518