xref: /xnu-11215/tests/epoch_sync_tests.c (revision 94d3b452)
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 #include <sys/sysctl.h>
30 #include <sys/wait.h>
31 
32 #include <darwintest.h>
33 #include <signal.h>
34 
35 
36 T_GLOBAL_META(
37 	T_META_NAMESPACE("xnu.epoch_sync_tests"),
38 	T_META_RADAR_COMPONENT_NAME("xnu"),
39 	T_META_RADAR_COMPONENT_VERSION("scheduler"),
40 	T_META_OWNER("mphalan"));
41 
42 #define TEST_SYSCTL "debug.test.esync_test"
43 T_DECL(epoch_sync_test, "Test Epoch Sync",
44     T_META_REQUIRES_SYSCTL_EQ(TEST_SYSCTL, 0))
45 {
46 	int64_t old = 0;
47 	size_t old_len = sizeof(old);
48 	int64_t new = 10;
49 	size_t new_len = sizeof(new);
50 
51 	int rc = sysctlbyname(TEST_SYSCTL, &old, &old_len, &new, new_len);
52 	T_QUIET; T_ASSERT_POSIX_SUCCESS(rc, "sysctlbyname(" TEST_SYSCTL ")");
53 }
54 
55 #define TIMEOUT 10
56 
57 static void
timeout(__unused int ignored)58 timeout(__unused int ignored)
59 {
60 	T_ASSERT_FAIL("child didn't exit in time");
61 }
62 
63 #define TEST_WAIT_SYSCTL "debug.test.esync_test_wait"
64 T_DECL(epoch_sync_test_wait, "Test Epoch Sync Wait",
65     T_META_REQUIRES_SYSCTL_EQ(TEST_WAIT_SYSCTL, 0))
66 {
67 	int64_t old = 0;
68 	size_t old_len = sizeof(old);
69 	int64_t new = 10;
70 	size_t new_len = sizeof(new);
71 
72 	pid_t pid = fork();
73 	T_ASSERT_POSIX_SUCCESS(pid, "fork");
74 
75 	/* Have the child block in an abortable esync_wait call. */
76 	if (pid == 0) {
77 		int rc = sysctlbyname(TEST_WAIT_SYSCTL, &old, &old_len, &new, new_len);
78 		/*
79 		 * The only way out of this syscall is if the process is killed.
80 		 * So nothing after this point should run.
81 		 */
82 		T_ASSERT_FAIL("Unexpectedly returned from sysctl (%d)", rc);
83 	}
84 
85 	/* Give enough time for the child to block in esync_wait. */
86 	sleep(1);
87 
88 	/* Kill the child. */
89 	int ret = kill(pid, SIGKILL);
90 	T_ASSERT_POSIX_SUCCESS(ret, "killing child");
91 
92 	/* Wait a maximum of TIMEOUT seconds for the child to exit. */
93 	T_ASSERT_NE(signal(SIGALRM, timeout), SIG_ERR, NULL);
94 	T_ASSERT_POSIX_SUCCESS(alarm(TIMEOUT), NULL);
95 
96 	int status = 0;
97 	T_ASSERT_POSIX_SUCCESS(waitpid(pid, &status, 0), "waiting for child");
98 
99 	/* Check that the child was killed. */
100 	T_ASSERT_TRUE(WIFSIGNALED(status), "exited due to signal");
101 	T_ASSERT_EQ(WTERMSIG(status), SIGKILL, "killed with SIGKILL");
102 }
103