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