xref: /xnu-8792.61.2/tests/posix_spawnattr_set_crash_behavior_np.c (revision 42e220869062b56f8d7d0726fd4c88954f87902c)
1 #include <stdio.h>
2 #include <sys/sysctl.h>
3 #include <spawn_private.h>
4 #include <signal.h>
5 #include <sys/reason.h>
6 
7 #ifdef T_NAMESPACE
8 #undef T_NAMESPACE
9 #endif
10 #include <darwintest.h>
11 #include <darwintest_utils.h>
12 
13 T_GLOBAL_META(
14 	T_META_RADAR_COMPONENT_NAME("xnu"),
15 	T_META_RADAR_COMPONENT_VERSION("spawn"),
16 	T_META_NAMESPACE("xnu.spawn"));
17 
18 extern char **environ;
19 
20 #define SYSCTL_CRASH_BEHAVIOR_TEST_MODE "kern.crash_behavior_test_mode=1"
21 #define SYSCTL_CRASH_BEHAVIOR_WOULD_PANIC "kern.crash_behavior_test_would_panic"
22 
23 #define TEST_REASON_CODE 5
24 
25 static void
_do_set_crash_behavior_test(char * child_mode,int signal,uint32_t flags,bool expect_panic)26 _do_set_crash_behavior_test(char *child_mode, int signal, uint32_t flags, bool expect_panic)
27 {
28 	bool should_wait = (strcmp(child_mode, "wait") == 0);
29 	bool reason = (strcmp(child_mode, "reason") == 0);
30 	bool dirty = (strcmp(child_mode, "dirty") == 0);
31 	bool shutdown = (strcmp(child_mode, "clean") == 0) || dirty;
32 	uint64_t deadline = mach_continuous_time();
33 
34 	// 0. clear SYSCTL_CRASH_BEHAVIOR_WOULD_PANIC
35 	int would_panic = 0;
36 	size_t length = sizeof(would_panic);
37 	int ret = sysctlbyname(SYSCTL_CRASH_BEHAVIOR_WOULD_PANIC, NULL, 0, &would_panic, length);
38 	T_ASSERT_POSIX_SUCCESS(ret, "Clearing SYSCTL_CRASH_BEHAVIOR_WOULD_PANIC");
39 
40 	// 1. posix_spawn a child process
41 	char *test_program = "./posix_spawnattr_set_crash_behavior_np_child";
42 	char *child_args[3];
43 
44 	posix_spawnattr_t attrs;
45 	posix_spawnattr_init(&attrs);
46 
47 	ret = posix_spawnattr_set_crash_behavior_np(&attrs, flags);
48 	T_ASSERT_POSIX_ZERO(ret, "posix_spawnattr_set_crash_behavior_np");
49 
50 
51 	if (should_wait) {
52 		// For the purpose of the test we set the deadline to be now to avoid
53 		// making the test wait
54 		ret = posix_spawnattr_set_crash_behavior_deadline_np(&attrs, deadline, flags);
55 		T_ASSERT_POSIX_ZERO(ret, "posix_spawnattr_set_crash_behavior_deadline_np: %lld", deadline);
56 	}
57 
58 	child_args[0] = test_program;
59 	child_args[1] = child_mode;
60 	child_args[2] = NULL;
61 
62 	pid_t child_pid = 0;
63 	ret = posix_spawn(&child_pid, child_args[0], NULL, &attrs, &child_args[0], environ);
64 	T_ASSERT_POSIX_ZERO(ret, "posix_spawn");
65 	posix_spawnattr_destroy(&attrs);
66 
67 	if (should_wait) {
68 		while (mach_continuous_time() <= deadline) {
69 			usleep(1);
70 		}
71 	}
72 
73 	if (signal != 0) {
74 		ret = kill(child_pid, signal);
75 		T_ASSERT_POSIX_SUCCESS(ret, "kill(%d, %d)", child_pid, signal);
76 	}
77 
78 	if (reason) {
79 		ret = terminate_with_reason(child_pid, OS_REASON_TEST, TEST_REASON_CODE,
80 		    "Test forcing crash", OS_REASON_FLAG_CONSISTENT_FAILURE | OS_REASON_FLAG_NO_CRASH_REPORT);
81 		T_ASSERT_POSIX_SUCCESS(ret, "terminate_with_reason(%d)", child_pid);
82 	}
83 
84 	if (dirty) {
85 		ret = proc_set_dirty(child_pid, true);
86 		T_ASSERT_POSIX_SUCCESS(ret, "proc_set_dirty(%d)", child_pid);
87 	}
88 
89 	if (shutdown) {
90 		ret = proc_terminate(child_pid, &signal);
91 		T_ASSERT_POSIX_SUCCESS(ret, "proc_terminate(%d, %d)", child_pid, signal);
92 	}
93 
94 	// 2. Wait for the child to exit
95 	int child_status;
96 	ret = wait4(-1, &child_status, 0, NULL);
97 	T_ASSERT_POSIX_SUCCESS(ret, "wait4");
98 
99 	// 3. Check if we would have panic'ed
100 	would_panic = 0;
101 	length = sizeof(would_panic);
102 	ret = sysctlbyname(SYSCTL_CRASH_BEHAVIOR_WOULD_PANIC, &would_panic, &length, NULL, 0);
103 	T_ASSERT_POSIX_SUCCESS(ret, "SYSCTL_CRASH_BEHAVIOR_WOULD_PANIC");
104 
105 	T_EXPECT_EQ(would_panic, expect_panic, NULL);
106 }
107 
108 T_DECL(set_crash_behavior_panic_on_crash_with_crash,
109     "set_crash_behavior_panic_on_crash_with_crash",
110     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
111     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
112 	_do_set_crash_behavior_test("crash", 0, POSIX_SPAWN_PANIC_ON_CRASH, true);
113 }
114 
115 T_DECL(set_crash_behavior_panic_on_crash_with_exit,
116     "set_crash_behavior_panic_on_crash_with_exit",
117     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
118     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
119 	_do_set_crash_behavior_test("exit", 0, POSIX_SPAWN_PANIC_ON_CRASH, false);
120 }
121 
122 T_DECL(set_crash_behavior_panic_on_crash_with_success,
123     "set_crash_behavior_panic_on_crash_with_success",
124     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
125     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
126 	_do_set_crash_behavior_test("success", 0, POSIX_SPAWN_PANIC_ON_CRASH, false);
127 }
128 
129 T_DECL(set_crash_behavior_panic_on_nonzero_with_crash,
130     "set_crash_behavior_panic_on_nonzero_with_crash",
131     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
132     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
133 	_do_set_crash_behavior_test("crash", 0, POSIX_SPAWN_PANIC_ON_NON_ZERO_EXIT, false);
134 }
135 
136 T_DECL(set_crash_behavior_panic_on_nonzero_with_exit,
137     "set_crash_behavior_panic_on_nonzero_with_exit",
138     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
139     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
140 	_do_set_crash_behavior_test("exit", 0, POSIX_SPAWN_PANIC_ON_NON_ZERO_EXIT, true);
141 }
142 
143 T_DECL(set_crash_behavior_panic_on_nonzero_with_success,
144     "set_crash_behavior_panic_on_nonzero_with_success",
145     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
146     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
147 	_do_set_crash_behavior_test("success", 0, POSIX_SPAWN_PANIC_ON_NON_ZERO_EXIT, false);
148 }
149 
150 T_DECL(set_crash_behavior_panic_on_crash_cancelled,
151     "set_crash_behavior_panic_on_crash_cancelled",
152     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
153     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
154 	_do_set_crash_behavior_test("wait", SIGUSR1, POSIX_SPAWN_PANIC_ON_CRASH, false);
155 }
156 
157 T_DECL(set_crash_behavior_panic_on_crash_sigterm,
158     "set_crash_behavior_panic_on_crash_sigterm",
159     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
160     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
161 	_do_set_crash_behavior_test("spin", SIGTERM, POSIX_SPAWN_PANIC_ON_CRASH, false);
162 }
163 
164 T_DECL(set_crash_behavior_panic_on_crash_sigkill,
165     "set_crash_behavior_panic_on_crash_sigkill",
166     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
167     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
168 	_do_set_crash_behavior_test("spin", SIGKILL, POSIX_SPAWN_PANIC_ON_CRASH, false);
169 }
170 
171 T_DECL(set_crash_behavior_panic_on_crash_terminate_with_reason,
172     "set_crash_behavior_panic_on_crash_terminate_with_reason",
173     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
174     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
175 	_do_set_crash_behavior_test("reason", 0, POSIX_SPAWN_PANIC_ON_CRASH, true);
176 }
177 
178 T_DECL(set_crash_behavior_panic_on_crash_proc_terminate_clean,
179     "set_crash_behavior_panic_on_crash_proc_terminate_clean",
180     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
181     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
182 	_do_set_crash_behavior_test("clean", 0, POSIX_SPAWN_PANIC_ON_CRASH, false);
183 }
184 
185 T_DECL(set_crash_behavior_panic_on_crash_proc_terminate_dirty,
186     "set_crash_behavior_panic_on_crash_proc_terminate_dirty",
187     T_META_SYSCTL_INT(SYSCTL_CRASH_BEHAVIOR_TEST_MODE),
188     T_META_REQUIRES_SYSCTL_EQ("kern.development", 1)) {
189 	_do_set_crash_behavior_test("dirty", 0, POSIX_SPAWN_PANIC_ON_CRASH, false);
190 }
191