1*4f1223e8SApple OSS Distributions /*
2*4f1223e8SApple OSS Distributions * Tests to validate that:
3*4f1223e8SApple OSS Distributions * - we can schedule threads on all hw.ncpus cores according to _os_cpu_number
4*4f1223e8SApple OSS Distributions * - we can schedule threads on all hw.cpuclusters clusters according to _os_cpu_cluster_number
5*4f1223e8SApple OSS Distributions * - the cluster id returned by _os_cpu_cluster_number aligns with mappings from IORegistry
6*4f1223e8SApple OSS Distributions *
7*4f1223e8SApple OSS Distributions * <rdar://problem/29545645>
8*4f1223e8SApple OSS Distributions * <rdar://problem/30445216>
9*4f1223e8SApple OSS Distributions *
10*4f1223e8SApple OSS Distributions * xcrun -sdk macosx.internal clang -o cpucount cpucount.c -ldarwintest -framework IOKit -framework CoreFoundation -g -Weverything
11*4f1223e8SApple OSS Distributions * xcrun -sdk iphoneos.internal clang -arch arm64 -o cpucount-ios cpucount.c -ldarwintest -framework IOKit -framework CoreFoundation -g -Weverything
12*4f1223e8SApple OSS Distributions * xcrun -sdk macosx.internal clang -o cpucount cpucount.c -ldarwintest -framework IOKit -framework CoreFoundation -arch arm64e -Weverything
13*4f1223e8SApple OSS Distributions */
14*4f1223e8SApple OSS Distributions
15*4f1223e8SApple OSS Distributions #include <darwintest.h>
16*4f1223e8SApple OSS Distributions #include "test_utils.h"
17*4f1223e8SApple OSS Distributions
18*4f1223e8SApple OSS Distributions #include <stdio.h>
19*4f1223e8SApple OSS Distributions #include <stdlib.h>
20*4f1223e8SApple OSS Distributions #include <unistd.h>
21*4f1223e8SApple OSS Distributions #include <pthread.h>
22*4f1223e8SApple OSS Distributions #include <sys/commpage.h>
23*4f1223e8SApple OSS Distributions #include <sys/sysctl.h>
24*4f1223e8SApple OSS Distributions #include <sys/proc_info.h>
25*4f1223e8SApple OSS Distributions #include <libproc.h>
26*4f1223e8SApple OSS Distributions
27*4f1223e8SApple OSS Distributions #include <CoreFoundation/CoreFoundation.h>
28*4f1223e8SApple OSS Distributions #include <IOKit/IOKitLib.h>
29*4f1223e8SApple OSS Distributions
30*4f1223e8SApple OSS Distributions #include <mach/mach.h>
31*4f1223e8SApple OSS Distributions #include <mach/mach_time.h>
32*4f1223e8SApple OSS Distributions #include <machine/cpu_capabilities.h>
33*4f1223e8SApple OSS Distributions
34*4f1223e8SApple OSS Distributions #include <os/tsd.h> /* private header for _os_cpu_number, _os_cpu_cluster_number */
35*4f1223e8SApple OSS Distributions
36*4f1223e8SApple OSS Distributions T_GLOBAL_META(
37*4f1223e8SApple OSS Distributions T_META_RUN_CONCURRENTLY(false),
38*4f1223e8SApple OSS Distributions T_META_BOOTARGS_SET("enable_skstb=1"),
39*4f1223e8SApple OSS Distributions T_META_CHECK_LEAKS(false),
40*4f1223e8SApple OSS Distributions T_META_ASROOT(true),
41*4f1223e8SApple OSS Distributions T_META_ALL_VALID_ARCHS(true),
42*4f1223e8SApple OSS Distributions T_META_RADAR_COMPONENT_NAME("xnu"),
43*4f1223e8SApple OSS Distributions T_META_RADAR_COMPONENT_VERSION("scheduler"),
44*4f1223e8SApple OSS Distributions T_META_OWNER("jarrad"),
45*4f1223e8SApple OSS Distributions T_META_TAG_VM_NOT_PREFERRED
46*4f1223e8SApple OSS Distributions );
47*4f1223e8SApple OSS Distributions
48*4f1223e8SApple OSS Distributions #define KERNEL_BOOTARGS_MAX_SIZE 1024
49*4f1223e8SApple OSS Distributions static char kernel_bootargs[KERNEL_BOOTARGS_MAX_SIZE];
50*4f1223e8SApple OSS Distributions
51*4f1223e8SApple OSS Distributions #define KERNEL_VERSION_MAX_SIZE 1024
52*4f1223e8SApple OSS Distributions static char kernel_version[KERNEL_VERSION_MAX_SIZE];
53*4f1223e8SApple OSS Distributions
54*4f1223e8SApple OSS Distributions static mach_timebase_info_data_t timebase_info;
55*4f1223e8SApple OSS Distributions
56*4f1223e8SApple OSS Distributions // Source: libktrace:corefoundation_helpers.c
57*4f1223e8SApple OSS Distributions
58*4f1223e8SApple OSS Distributions static void
dict_number_internal(CFDictionaryRef dict,CFStringRef key,void * dst_out,CFNumberType nbr_type)59*4f1223e8SApple OSS Distributions dict_number_internal(CFDictionaryRef dict, CFStringRef key, void *dst_out, CFNumberType nbr_type)
60*4f1223e8SApple OSS Distributions {
61*4f1223e8SApple OSS Distributions bool success;
62*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_NOTNULL(dict, "dict must not be null");
63*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_NOTNULL(key, " key must not be null");
64*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_NOTNULL(dst_out, "dst out must not be null");
65*4f1223e8SApple OSS Distributions
66*4f1223e8SApple OSS Distributions CFTypeRef val = CFDictionaryGetValue(dict, key);
67*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_NOTNULL(val, "unable to get value for key %s", CFStringGetCStringPtr(key, kCFStringEncodingASCII));
68*4f1223e8SApple OSS Distributions
69*4f1223e8SApple OSS Distributions CFTypeID type = CFGetTypeID(val);
70*4f1223e8SApple OSS Distributions if (type == CFNumberGetTypeID()) {
71*4f1223e8SApple OSS Distributions CFNumberRef val_nbr = (CFNumberRef)val;
72*4f1223e8SApple OSS Distributions success = CFNumberGetValue(val_nbr, nbr_type, dst_out);
73*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_TRUE(success, "dictionary number at key '%s' is not the right type", CFStringGetCStringPtr(key, kCFStringEncodingASCII));
74*4f1223e8SApple OSS Distributions } else if (type == CFDataGetTypeID()) {
75*4f1223e8SApple OSS Distributions CFDataRef val_data = (CFDataRef)val;
76*4f1223e8SApple OSS Distributions size_t raw_size = (size_t)CFDataGetLength(val_data);
77*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_EQ(raw_size, (size_t)4, "cannot convert CFData of size %zu to number", raw_size);
78*4f1223e8SApple OSS Distributions CFDataGetBytes(val_data, CFRangeMake(0, (CFIndex)raw_size), dst_out);
79*4f1223e8SApple OSS Distributions } else {
80*4f1223e8SApple OSS Distributions T_ASSERT_FAIL("dictionary value at key '%s' should be a number or data", CFStringGetCStringPtr(key, kCFStringEncodingASCII));
81*4f1223e8SApple OSS Distributions }
82*4f1223e8SApple OSS Distributions }
83*4f1223e8SApple OSS Distributions
84*4f1223e8SApple OSS Distributions static void
dict_uint32(CFDictionaryRef dict,CFStringRef key,uint32_t * dst_out)85*4f1223e8SApple OSS Distributions dict_uint32(CFDictionaryRef dict, CFStringRef key, uint32_t *dst_out)
86*4f1223e8SApple OSS Distributions {
87*4f1223e8SApple OSS Distributions dict_number_internal(dict, key, dst_out, kCFNumberSInt32Type);
88*4f1223e8SApple OSS Distributions }
89*4f1223e8SApple OSS Distributions
90*4f1223e8SApple OSS Distributions static uint64_t
abs_to_nanos(uint64_t abs)91*4f1223e8SApple OSS Distributions abs_to_nanos(uint64_t abs)
92*4f1223e8SApple OSS Distributions {
93*4f1223e8SApple OSS Distributions return abs * timebase_info.numer / timebase_info.denom;
94*4f1223e8SApple OSS Distributions }
95*4f1223e8SApple OSS Distributions
96*4f1223e8SApple OSS Distributions static int32_t
get_csw_count(void)97*4f1223e8SApple OSS Distributions get_csw_count(void)
98*4f1223e8SApple OSS Distributions {
99*4f1223e8SApple OSS Distributions struct proc_taskinfo taskinfo;
100*4f1223e8SApple OSS Distributions int rv;
101*4f1223e8SApple OSS Distributions
102*4f1223e8SApple OSS Distributions rv = proc_pidinfo(getpid(), PROC_PIDTASKINFO, 0, &taskinfo, sizeof(taskinfo));
103*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "PROC_PIDTASKINFO");
104*4f1223e8SApple OSS Distributions
105*4f1223e8SApple OSS Distributions return taskinfo.pti_csw;
106*4f1223e8SApple OSS Distributions }
107*4f1223e8SApple OSS Distributions
108*4f1223e8SApple OSS Distributions // noinline hopefully keeps the optimizer from hoisting it out of the loop
109*4f1223e8SApple OSS Distributions // until rdar://68253516 is fixed.
110*4f1223e8SApple OSS Distributions __attribute__((noinline))
111*4f1223e8SApple OSS Distributions static uint32_t
fixed_os_cpu_number(void)112*4f1223e8SApple OSS Distributions fixed_os_cpu_number(void)
113*4f1223e8SApple OSS Distributions {
114*4f1223e8SApple OSS Distributions uint32_t cpu_number = _os_cpu_number();
115*4f1223e8SApple OSS Distributions return cpu_number;
116*4f1223e8SApple OSS Distributions }
117*4f1223e8SApple OSS Distributions
118*4f1223e8SApple OSS Distributions static unsigned int
commpage_cpu_cluster_number(void)119*4f1223e8SApple OSS Distributions commpage_cpu_cluster_number(void)
120*4f1223e8SApple OSS Distributions {
121*4f1223e8SApple OSS Distributions uint8_t cpu_number = (uint8_t)fixed_os_cpu_number();
122*4f1223e8SApple OSS Distributions volatile uint8_t *cpu_to_cluster = COMM_PAGE_SLOT(uint8_t, CPU_TO_CLUSTER);
123*4f1223e8SApple OSS Distributions return (unsigned int)*(cpu_to_cluster + cpu_number);
124*4f1223e8SApple OSS Distributions }
125*4f1223e8SApple OSS Distributions
126*4f1223e8SApple OSS Distributions static void
cpucount_setup(void)127*4f1223e8SApple OSS Distributions cpucount_setup(void)
128*4f1223e8SApple OSS Distributions {
129*4f1223e8SApple OSS Distributions int rv;
130*4f1223e8SApple OSS Distributions kern_return_t kr;
131*4f1223e8SApple OSS Distributions
132*4f1223e8SApple OSS Distributions T_SETUPBEGIN;
133*4f1223e8SApple OSS Distributions
134*4f1223e8SApple OSS Distributions setvbuf(stdout, NULL, _IONBF, 0);
135*4f1223e8SApple OSS Distributions setvbuf(stderr, NULL, _IONBF, 0);
136*4f1223e8SApple OSS Distributions
137*4f1223e8SApple OSS Distributions /* Validate what kind of kernel we're on */
138*4f1223e8SApple OSS Distributions size_t kernel_version_size = sizeof(kernel_version);
139*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.version", kernel_version, &kernel_version_size, NULL, 0);
140*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "kern.version");
141*4f1223e8SApple OSS Distributions
142*4f1223e8SApple OSS Distributions T_LOG("kern.version: %s\n", kernel_version);
143*4f1223e8SApple OSS Distributions
144*4f1223e8SApple OSS Distributions /* Double check that darwintest set the boot arg we requested */
145*4f1223e8SApple OSS Distributions size_t kernel_bootargs_size = sizeof(kernel_bootargs);
146*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.bootargs", kernel_bootargs, &kernel_bootargs_size, NULL, 0);
147*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "kern.bootargs");
148*4f1223e8SApple OSS Distributions
149*4f1223e8SApple OSS Distributions T_LOG("kern.bootargs: %s\n", kernel_bootargs);
150*4f1223e8SApple OSS Distributions
151*4f1223e8SApple OSS Distributions if (NULL == strstr(kernel_bootargs, "enable_skstb=1")) {
152*4f1223e8SApple OSS Distributions T_ASSERT_FAIL("enable_skstb=1 boot-arg is missing");
153*4f1223e8SApple OSS Distributions }
154*4f1223e8SApple OSS Distributions
155*4f1223e8SApple OSS Distributions kr = mach_timebase_info(&timebase_info);
156*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "mach_timebase_info");
157*4f1223e8SApple OSS Distributions
158*4f1223e8SApple OSS Distributions struct sched_param param = {.sched_priority = 63};
159*4f1223e8SApple OSS Distributions
160*4f1223e8SApple OSS Distributions rv = pthread_setschedparam(pthread_self(), SCHED_FIFO, ¶m);
161*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "pthread_setschedparam");
162*4f1223e8SApple OSS Distributions
163*4f1223e8SApple OSS Distributions T_SETUPEND;
164*4f1223e8SApple OSS Distributions }
165*4f1223e8SApple OSS Distributions
166*4f1223e8SApple OSS Distributions
167*4f1223e8SApple OSS Distributions T_DECL(count_cpus,
168*4f1223e8SApple OSS Distributions "Tests we can schedule bound threads on all hw.ncpus cores and that _os_cpu_number matches",
169*4f1223e8SApple OSS Distributions XNU_T_META_SOC_SPECIFIC)
170*4f1223e8SApple OSS Distributions {
171*4f1223e8SApple OSS Distributions int rv;
172*4f1223e8SApple OSS Distributions
173*4f1223e8SApple OSS Distributions cpucount_setup();
174*4f1223e8SApple OSS Distributions
175*4f1223e8SApple OSS Distributions int bound_cpu_out = 0;
176*4f1223e8SApple OSS Distributions size_t bound_cpu_out_size = sizeof(bound_cpu_out);
177*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cpu", &bound_cpu_out, &bound_cpu_out_size, NULL, 0);
178*4f1223e8SApple OSS Distributions
179*4f1223e8SApple OSS Distributions if (rv == -1) {
180*4f1223e8SApple OSS Distributions if (errno == ENOENT) {
181*4f1223e8SApple OSS Distributions T_ASSERT_FAIL("kern.sched_thread_bind_cpu doesn't exist, must set enable_skstb=1 boot-arg on development kernel");
182*4f1223e8SApple OSS Distributions }
183*4f1223e8SApple OSS Distributions if (errno == EPERM) {
184*4f1223e8SApple OSS Distributions T_ASSERT_FAIL("must run as root");
185*4f1223e8SApple OSS Distributions }
186*4f1223e8SApple OSS Distributions }
187*4f1223e8SApple OSS Distributions
188*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "read kern.sched_thread_bind_cpu");
189*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_EQ(bound_cpu_out, -1, "kern.sched_thread_bind_cpu should exist, start unbound");
190*4f1223e8SApple OSS Distributions
191*4f1223e8SApple OSS Distributions uint32_t sysctl_ncpu = 0;
192*4f1223e8SApple OSS Distributions size_t ncpu_size = sizeof(sysctl_ncpu);
193*4f1223e8SApple OSS Distributions rv = sysctlbyname("hw.ncpu", &sysctl_ncpu, &ncpu_size, NULL, 0);
194*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "sysctlbyname(hw.ncpu)");
195*4f1223e8SApple OSS Distributions
196*4f1223e8SApple OSS Distributions T_LOG("hw.ncpu: %2d\n", sysctl_ncpu);
197*4f1223e8SApple OSS Distributions
198*4f1223e8SApple OSS Distributions T_ASSERT_GT(sysctl_ncpu, 0, "at least one CPU exists");
199*4f1223e8SApple OSS Distributions
200*4f1223e8SApple OSS Distributions for (uint32_t cpu_to_bind = 0; cpu_to_bind < sysctl_ncpu; cpu_to_bind++) {
201*4f1223e8SApple OSS Distributions int32_t before_csw_count = get_csw_count();
202*4f1223e8SApple OSS Distributions T_LOG("(csw %4d) attempting to bind to cpu %2d\n", before_csw_count, cpu_to_bind);
203*4f1223e8SApple OSS Distributions
204*4f1223e8SApple OSS Distributions uint64_t start = mach_absolute_time();
205*4f1223e8SApple OSS Distributions
206*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cpu", NULL, 0, &cpu_to_bind, sizeof(cpu_to_bind));
207*4f1223e8SApple OSS Distributions
208*4f1223e8SApple OSS Distributions uint64_t end = mach_absolute_time();
209*4f1223e8SApple OSS Distributions
210*4f1223e8SApple OSS Distributions if (rv == -1 && errno == ENOTSUP) {
211*4f1223e8SApple OSS Distributions T_SKIP("Binding is available, but this process doesn't support binding (e.g. Rosetta on Aruba)");
212*4f1223e8SApple OSS Distributions }
213*4f1223e8SApple OSS Distributions
214*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "kern.sched_thread_bind_cpu(%u)", cpu_to_bind);
215*4f1223e8SApple OSS Distributions
216*4f1223e8SApple OSS Distributions uint32_t os_cpu_number_reported = fixed_os_cpu_number();
217*4f1223e8SApple OSS Distributions
218*4f1223e8SApple OSS Distributions bound_cpu_out = 0;
219*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cpu", &bound_cpu_out, &bound_cpu_out_size, NULL, 0);
220*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "read kern.sched_thread_bind_cpu");
221*4f1223e8SApple OSS Distributions
222*4f1223e8SApple OSS Distributions T_QUIET; T_EXPECT_EQ((int)cpu_to_bind, bound_cpu_out,
223*4f1223e8SApple OSS Distributions "should report bound cpu id matching requested bind target");
224*4f1223e8SApple OSS Distributions
225*4f1223e8SApple OSS Distributions uint64_t delta_abs = end - start;
226*4f1223e8SApple OSS Distributions uint64_t delta_ns = abs_to_nanos(delta_abs);
227*4f1223e8SApple OSS Distributions
228*4f1223e8SApple OSS Distributions int32_t after_csw_count = get_csw_count();
229*4f1223e8SApple OSS Distributions
230*4f1223e8SApple OSS Distributions T_LOG("(csw %4d) bound to cpu %2d in %f milliseconds\n",
231*4f1223e8SApple OSS Distributions after_csw_count, cpu_to_bind,
232*4f1223e8SApple OSS Distributions ((double)delta_ns / 1000000.0));
233*4f1223e8SApple OSS Distributions
234*4f1223e8SApple OSS Distributions if (cpu_to_bind > 0) {
235*4f1223e8SApple OSS Distributions T_QUIET; T_EXPECT_LT(before_csw_count, after_csw_count,
236*4f1223e8SApple OSS Distributions "should have had to context switch to execute the bind");
237*4f1223e8SApple OSS Distributions }
238*4f1223e8SApple OSS Distributions
239*4f1223e8SApple OSS Distributions T_LOG("cpu %2d reported id %2d\n",
240*4f1223e8SApple OSS Distributions cpu_to_bind, os_cpu_number_reported);
241*4f1223e8SApple OSS Distributions
242*4f1223e8SApple OSS Distributions T_QUIET;
243*4f1223e8SApple OSS Distributions T_EXPECT_EQ(cpu_to_bind, os_cpu_number_reported,
244*4f1223e8SApple OSS Distributions "should report same CPU number as was bound to");
245*4f1223e8SApple OSS Distributions }
246*4f1223e8SApple OSS Distributions
247*4f1223e8SApple OSS Distributions int unbind = -1; /* pass -1 in order to unbind the thread */
248*4f1223e8SApple OSS Distributions
249*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cpu", NULL, 0, &unbind, sizeof(unbind));
250*4f1223e8SApple OSS Distributions
251*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "kern.sched_thread_bind_cpu(%u)", unbind);
252*4f1223e8SApple OSS Distributions
253*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cpu", &bound_cpu_out, &bound_cpu_out_size, NULL, 0);
254*4f1223e8SApple OSS Distributions
255*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "read kern.sched_thread_bind_cpu");
256*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_EQ(bound_cpu_out, -1, "thread should be unbound at the end");
257*4f1223e8SApple OSS Distributions
258*4f1223e8SApple OSS Distributions T_PASS("test has run threads on all CPUS");
259*4f1223e8SApple OSS Distributions }
260*4f1223e8SApple OSS Distributions
261*4f1223e8SApple OSS Distributions T_DECL(count_clusters,
262*4f1223e8SApple OSS Distributions "Tests we can schedule bound threads on all cpu clusters and that _os_cpu_cluster_number matches",
263*4f1223e8SApple OSS Distributions XNU_T_META_SOC_SPECIFIC,
264*4f1223e8SApple OSS Distributions #if __x86_64__
265*4f1223e8SApple OSS Distributions T_META_ENABLED(false /* rdar://133956403 */)
266*4f1223e8SApple OSS Distributions #else
267*4f1223e8SApple OSS Distributions T_META_ENABLED(true)
268*4f1223e8SApple OSS Distributions #endif
269*4f1223e8SApple OSS Distributions )
270*4f1223e8SApple OSS Distributions {
271*4f1223e8SApple OSS Distributions int rv;
272*4f1223e8SApple OSS Distributions
273*4f1223e8SApple OSS Distributions cpucount_setup();
274*4f1223e8SApple OSS Distributions
275*4f1223e8SApple OSS Distributions uint8_t cpuclusters = COMM_PAGE_READ(uint8_t, CPU_CLUSTERS);
276*4f1223e8SApple OSS Distributions T_LOG("cpuclusters: %2d\n", cpuclusters);
277*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_GT(cpuclusters, 0, "at least one CPU cluster exists");
278*4f1223e8SApple OSS Distributions if (cpuclusters == 1) {
279*4f1223e8SApple OSS Distributions T_SKIP("Test is unsupported on non-AMP platforms");
280*4f1223e8SApple OSS Distributions }
281*4f1223e8SApple OSS Distributions
282*4f1223e8SApple OSS Distributions uint32_t sysctl_ncpu = 0;
283*4f1223e8SApple OSS Distributions size_t ncpu_size = sizeof(sysctl_ncpu);
284*4f1223e8SApple OSS Distributions rv = sysctlbyname("hw.ncpu", &sysctl_ncpu, &ncpu_size, NULL, 0);
285*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "sysctlbyname(hw.ncpu)");
286*4f1223e8SApple OSS Distributions T_LOG("hw.ncpu: %2d\n", sysctl_ncpu);
287*4f1223e8SApple OSS Distributions
288*4f1223e8SApple OSS Distributions uint64_t recommended_cores = 0;
289*4f1223e8SApple OSS Distributions size_t recommended_cores_size = sizeof(recommended_cores);
290*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_recommended_cores", &recommended_cores, &recommended_cores_size, NULL, 0);
291*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "sysctlbyname(kern.sched_recommended_cores)");
292*4f1223e8SApple OSS Distributions T_LOG("kern.sched_recommended_cores: %llu", recommended_cores);
293*4f1223e8SApple OSS Distributions if ((uint32_t)__builtin_popcountll(recommended_cores) != sysctl_ncpu) {
294*4f1223e8SApple OSS Distributions T_SKIP("Missing recommended cores");
295*4f1223e8SApple OSS Distributions }
296*4f1223e8SApple OSS Distributions
297*4f1223e8SApple OSS Distributions int bound_cluster_out = 0;
298*4f1223e8SApple OSS Distributions size_t bound_cluster_out_size = sizeof(bound_cluster_out);
299*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cluster_id", &bound_cluster_out, &bound_cluster_out_size, NULL, 0);
300*4f1223e8SApple OSS Distributions
301*4f1223e8SApple OSS Distributions if (rv == -1) {
302*4f1223e8SApple OSS Distributions if (errno == ENOENT) {
303*4f1223e8SApple OSS Distributions T_ASSERT_FAIL("kern.sched_thread_bind_cluster_id doesn't exist, must set enable_skstb=1 boot-arg on development kernel");
304*4f1223e8SApple OSS Distributions }
305*4f1223e8SApple OSS Distributions if (errno == EPERM) {
306*4f1223e8SApple OSS Distributions T_ASSERT_FAIL("must run as root");
307*4f1223e8SApple OSS Distributions }
308*4f1223e8SApple OSS Distributions }
309*4f1223e8SApple OSS Distributions
310*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "read kern.sched_thread_bind_cluster_id");
311*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_EQ(bound_cluster_out, -1, "kern.sched_thread_bind_cluster_id should exist, start unbound");
312*4f1223e8SApple OSS Distributions
313*4f1223e8SApple OSS Distributions for (uint32_t cluster_to_bind = 0; cluster_to_bind < cpuclusters; cluster_to_bind++) {
314*4f1223e8SApple OSS Distributions int32_t before_csw_count = get_csw_count();
315*4f1223e8SApple OSS Distributions T_LOG("(csw %4d) attempting to bind to cluster %2d\n", before_csw_count, cluster_to_bind);
316*4f1223e8SApple OSS Distributions
317*4f1223e8SApple OSS Distributions uint64_t start = mach_absolute_time();
318*4f1223e8SApple OSS Distributions
319*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cluster_id", NULL, 0, &cluster_to_bind, sizeof(cluster_to_bind));
320*4f1223e8SApple OSS Distributions
321*4f1223e8SApple OSS Distributions uint64_t end = mach_absolute_time();
322*4f1223e8SApple OSS Distributions
323*4f1223e8SApple OSS Distributions if (rv == -1 && errno == ENOTSUP) {
324*4f1223e8SApple OSS Distributions T_SKIP("Binding is available, but this process doesn't support binding (e.g. Rosetta on Aruba)");
325*4f1223e8SApple OSS Distributions }
326*4f1223e8SApple OSS Distributions
327*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "kern.sched_thread_bind_cluster_id(%u)", cluster_to_bind);
328*4f1223e8SApple OSS Distributions
329*4f1223e8SApple OSS Distributions T_LOG("CPU ID: %d", fixed_os_cpu_number());
330*4f1223e8SApple OSS Distributions
331*4f1223e8SApple OSS Distributions #if TARGET_CPU_X86_64
332*4f1223e8SApple OSS Distributions T_LOG("_os_cpu_cluster_number unsupported under x86.");
333*4f1223e8SApple OSS Distributions #else
334*4f1223e8SApple OSS Distributions unsigned int os_cluster_number_reported = _os_cpu_cluster_number();
335*4f1223e8SApple OSS Distributions T_LOG("OS reported cluster number: %2d\n",
336*4f1223e8SApple OSS Distributions os_cluster_number_reported);
337*4f1223e8SApple OSS Distributions T_QUIET; T_EXPECT_EQ(cluster_to_bind, os_cluster_number_reported,
338*4f1223e8SApple OSS Distributions "_os_cpu_cluster_number should report same cluster number as was bound to");
339*4f1223e8SApple OSS Distributions #endif
340*4f1223e8SApple OSS Distributions
341*4f1223e8SApple OSS Distributions unsigned int commpage_cluster_number_reported = commpage_cpu_cluster_number();
342*4f1223e8SApple OSS Distributions T_LOG("Comm Page reported cluster number: %u", commpage_cluster_number_reported);
343*4f1223e8SApple OSS Distributions T_EXPECT_EQ(commpage_cluster_number_reported, cluster_to_bind, "comm page cluster number matches commpage for this CPU");
344*4f1223e8SApple OSS Distributions
345*4f1223e8SApple OSS Distributions bound_cluster_out = 0;
346*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cluster_id", &bound_cluster_out, &bound_cluster_out_size, NULL, 0);
347*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "read kern.sched_thread_bind_cluster_id");
348*4f1223e8SApple OSS Distributions
349*4f1223e8SApple OSS Distributions T_QUIET; T_EXPECT_EQ((int)cluster_to_bind, bound_cluster_out,
350*4f1223e8SApple OSS Distributions "bound cluster id matches requested bind target");
351*4f1223e8SApple OSS Distributions
352*4f1223e8SApple OSS Distributions uint64_t delta_abs = end - start;
353*4f1223e8SApple OSS Distributions uint64_t delta_ns = abs_to_nanos(delta_abs);
354*4f1223e8SApple OSS Distributions
355*4f1223e8SApple OSS Distributions int32_t after_csw_count = get_csw_count();
356*4f1223e8SApple OSS Distributions
357*4f1223e8SApple OSS Distributions T_LOG("(csw %4d) bound to cluster %2d in %f milliseconds\n",
358*4f1223e8SApple OSS Distributions after_csw_count, cluster_to_bind,
359*4f1223e8SApple OSS Distributions ((double)delta_ns / 1000000.0));
360*4f1223e8SApple OSS Distributions
361*4f1223e8SApple OSS Distributions if (cluster_to_bind > 0) {
362*4f1223e8SApple OSS Distributions T_QUIET; T_EXPECT_LT(before_csw_count, after_csw_count,
363*4f1223e8SApple OSS Distributions "should have had to context switch to execute the bind");
364*4f1223e8SApple OSS Distributions }
365*4f1223e8SApple OSS Distributions }
366*4f1223e8SApple OSS Distributions
367*4f1223e8SApple OSS Distributions int unbind = -1; /* pass -1 in order to unbind the thread */
368*4f1223e8SApple OSS Distributions
369*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cluster_id", NULL, 0, &unbind, sizeof(unbind));
370*4f1223e8SApple OSS Distributions
371*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "kern.sched_thread_bind_cluster_id(%u)", unbind);
372*4f1223e8SApple OSS Distributions
373*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cluster_id", &bound_cluster_out, &bound_cluster_out_size, NULL, 0);
374*4f1223e8SApple OSS Distributions
375*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "read kern.sched_thread_bind_cluster_id");
376*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_EQ(bound_cluster_out, -1, "thread should be unbound at the end");
377*4f1223e8SApple OSS Distributions
378*4f1223e8SApple OSS Distributions T_PASS("test has run threads on all clusters");
379*4f1223e8SApple OSS Distributions }
380*4f1223e8SApple OSS Distributions
381*4f1223e8SApple OSS Distributions T_DECL(check_cpu_topology,
382*4f1223e8SApple OSS Distributions "Verify _os_cpu_cluster_number(), _os_cpu_number() against IORegistry",
383*4f1223e8SApple OSS Distributions XNU_T_META_SOC_SPECIFIC,
384*4f1223e8SApple OSS Distributions T_META_ENABLED(TARGET_CPU_ARM || TARGET_CPU_ARM64))
385*4f1223e8SApple OSS Distributions {
386*4f1223e8SApple OSS Distributions int rv;
387*4f1223e8SApple OSS Distributions uint32_t cpu_id, cluster_id;
388*4f1223e8SApple OSS Distributions kern_return_t kr;
389*4f1223e8SApple OSS Distributions io_iterator_t cpus_iter = 0;
390*4f1223e8SApple OSS Distributions io_service_t cpus_service = 0;
391*4f1223e8SApple OSS Distributions io_service_t cpu_service = 0;
392*4f1223e8SApple OSS Distributions CFDictionaryRef match = NULL;
393*4f1223e8SApple OSS Distributions
394*4f1223e8SApple OSS Distributions cpucount_setup();
395*4f1223e8SApple OSS Distributions
396*4f1223e8SApple OSS Distributions int bound_cpu_out = 0;
397*4f1223e8SApple OSS Distributions size_t bound_cpu_out_size = sizeof(bound_cpu_out);
398*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cpu", &bound_cpu_out, &bound_cpu_out_size, NULL, 0);
399*4f1223e8SApple OSS Distributions
400*4f1223e8SApple OSS Distributions if (rv == -1) {
401*4f1223e8SApple OSS Distributions if (errno == ENOENT) {
402*4f1223e8SApple OSS Distributions T_FAIL("kern.sched_thread_bind_cpu doesn't exist, must set enable_skstb=1 boot-arg on development kernel");
403*4f1223e8SApple OSS Distributions }
404*4f1223e8SApple OSS Distributions if (errno == EPERM) {
405*4f1223e8SApple OSS Distributions T_FAIL("must run as root");
406*4f1223e8SApple OSS Distributions }
407*4f1223e8SApple OSS Distributions }
408*4f1223e8SApple OSS Distributions
409*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "read kern.sched_thread_bind_cpu");
410*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_EQ(bound_cpu_out, -1, "kern.sched_thread_bind_cpu should exist, start unbound");
411*4f1223e8SApple OSS Distributions
412*4f1223e8SApple OSS Distributions match = IOServiceNameMatching("cpus");
413*4f1223e8SApple OSS Distributions cpus_service = IOServiceGetMatchingService(kIOMainPortDefault, match);
414*4f1223e8SApple OSS Distributions match = NULL; // consumes reference to match
415*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_NE(cpus_service, (io_service_t)0, "Failed get cpus IOService");
416*4f1223e8SApple OSS Distributions
417*4f1223e8SApple OSS Distributions kr = IORegistryEntryGetChildIterator(cpus_service, "IODeviceTree", &cpus_iter);
418*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "IORegistryEntryGetChildIterator");
419*4f1223e8SApple OSS Distributions
420*4f1223e8SApple OSS Distributions while ((cpu_service = IOIteratorNext(cpus_iter)) != 0) {
421*4f1223e8SApple OSS Distributions CFMutableDictionaryRef props = NULL;
422*4f1223e8SApple OSS Distributions kr = IORegistryEntryCreateCFProperties(cpu_service, &props, kCFAllocatorDefault, 0);
423*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "IORegistryEntryCreateCFProperties");
424*4f1223e8SApple OSS Distributions
425*4f1223e8SApple OSS Distributions dict_uint32(props, CFSTR("logical-cpu-id"), &cpu_id);
426*4f1223e8SApple OSS Distributions T_LOG("IORegistry logical cpu id: %u", cpu_id);
427*4f1223e8SApple OSS Distributions dict_uint32(props, CFSTR("logical-cluster-id"), &cluster_id);
428*4f1223e8SApple OSS Distributions T_LOG("IORegistry logical cpu cluster id: %u", cluster_id);
429*4f1223e8SApple OSS Distributions
430*4f1223e8SApple OSS Distributions T_LOG("Binding thread to cpu %u", cpu_id);
431*4f1223e8SApple OSS Distributions rv = sysctlbyname("kern.sched_thread_bind_cpu", NULL, 0, &cpu_id, sizeof(cpu_id));
432*4f1223e8SApple OSS Distributions if (rv == -1 && errno == ENOTSUP) {
433*4f1223e8SApple OSS Distributions T_SKIP("Binding is available, but this process doesn't support binding (e.g. Rosetta on Aruba)");
434*4f1223e8SApple OSS Distributions }
435*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(rv, "kern.sched_thread_bind_cpu(%u)", cpu_id);
436*4f1223e8SApple OSS Distributions
437*4f1223e8SApple OSS Distributions unsigned int os_cpu_number_reported = fixed_os_cpu_number();
438*4f1223e8SApple OSS Distributions T_EXPECT_EQ(os_cpu_number_reported, cpu_id, "_os_cpu_number matches IORegistry entry for this CPU");
439*4f1223e8SApple OSS Distributions unsigned int os_cluster_number_reported = _os_cpu_cluster_number();
440*4f1223e8SApple OSS Distributions T_EXPECT_EQ(os_cluster_number_reported, cluster_id, "_os_cpu_cluster_number matches IORegistry entry for this CPU");
441*4f1223e8SApple OSS Distributions unsigned int commpage_cluster_number_reported = commpage_cpu_cluster_number();
442*4f1223e8SApple OSS Distributions T_EXPECT_EQ(commpage_cluster_number_reported, cluster_id, "comm page cluster number matches IORegistry entry for this CPU");
443*4f1223e8SApple OSS Distributions
444*4f1223e8SApple OSS Distributions CFRelease(props);
445*4f1223e8SApple OSS Distributions IOObjectRelease(cpu_service);
446*4f1223e8SApple OSS Distributions }
447*4f1223e8SApple OSS Distributions T_PASS("All cluster IDs match with IORegistry");
448*4f1223e8SApple OSS Distributions }
449*4f1223e8SApple OSS Distributions
450*4f1223e8SApple OSS Distributions T_DECL(hw_perflevels_order_and_cpu_counts,
451*4f1223e8SApple OSS Distributions "check that perflevel sysctls return the correct order and with expected cpu counts",
452*4f1223e8SApple OSS Distributions XNU_T_META_SOC_SPECIFIC)
453*4f1223e8SApple OSS Distributions {
454*4f1223e8SApple OSS Distributions int ret;
455*4f1223e8SApple OSS Distributions char sysctlname[256];
456*4f1223e8SApple OSS Distributions
457*4f1223e8SApple OSS Distributions /* Check perflevel count */
458*4f1223e8SApple OSS Distributions int level_count = 0;
459*4f1223e8SApple OSS Distributions ret = sysctlbyname("hw.nperflevels", &level_count, &(size_t){ sizeof(level_count) }, NULL, 0);
460*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "hw.nperflevels");
461*4f1223e8SApple OSS Distributions T_EXPECT_GE(level_count, 1, "valid hw.nperflevels: %d", level_count);
462*4f1223e8SApple OSS Distributions
463*4f1223e8SApple OSS Distributions /* Check perflevel names */
464*4f1223e8SApple OSS Distributions char perflevel_name[level_count][128];
465*4f1223e8SApple OSS Distributions int efficient_pos = -1;
466*4f1223e8SApple OSS Distributions int performance_pos = -1;
467*4f1223e8SApple OSS Distributions int standard_pos = -1;
468*4f1223e8SApple OSS Distributions for (int p = 0; p < level_count; p++) {
469*4f1223e8SApple OSS Distributions snprintf(sysctlname, sizeof(sysctlname), "hw.perflevel%d.name", p);
470*4f1223e8SApple OSS Distributions ret = sysctlbyname(sysctlname, perflevel_name[p], &(size_t){ sizeof(perflevel_name[p]) }, NULL, 0);
471*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, sysctlname);
472*4f1223e8SApple OSS Distributions if (strcmp(perflevel_name[p], "Efficiency") == 0) {
473*4f1223e8SApple OSS Distributions efficient_pos = p;
474*4f1223e8SApple OSS Distributions } else if (strcmp(perflevel_name[p], "Performance") == 0) {
475*4f1223e8SApple OSS Distributions performance_pos = p;
476*4f1223e8SApple OSS Distributions } else if (strcmp(perflevel_name[p], "Standard") == 0) {
477*4f1223e8SApple OSS Distributions standard_pos = p;
478*4f1223e8SApple OSS Distributions }
479*4f1223e8SApple OSS Distributions }
480*4f1223e8SApple OSS Distributions T_ASSERT_TRUE((efficient_pos >= 0) || (performance_pos >= 0) || (standard_pos >= 0),
481*4f1223e8SApple OSS Distributions "valid perflevels detected (\"Efficient\" %d, \"Performance\" %d, \"Standard\" %d)",
482*4f1223e8SApple OSS Distributions efficient_pos, performance_pos, standard_pos);
483*4f1223e8SApple OSS Distributions if (standard_pos >= 0) {
484*4f1223e8SApple OSS Distributions T_ASSERT_EQ(level_count, 1, "single \"Standard\" perflevel");
485*4f1223e8SApple OSS Distributions }
486*4f1223e8SApple OSS Distributions if (efficient_pos >= 0) {
487*4f1223e8SApple OSS Distributions T_ASSERT_EQ(efficient_pos, level_count - 1, "\"Efficiency\" is the highest index perflevel");
488*4f1223e8SApple OSS Distributions }
489*4f1223e8SApple OSS Distributions if (performance_pos >= 0) {
490*4f1223e8SApple OSS Distributions T_ASSERT_EQ(performance_pos, 0, "\"Performance\" is the lowest index perflevel");
491*4f1223e8SApple OSS Distributions }
492*4f1223e8SApple OSS Distributions
493*4f1223e8SApple OSS Distributions /*
494*4f1223e8SApple OSS Distributions * Check that certain variants of CPU counts sum up to the expected total
495*4f1223e8SApple OSS Distributions * across all perflevels.
496*4f1223e8SApple OSS Distributions */
497*4f1223e8SApple OSS Distributions const int num_cpu_count_variants = 2;
498*4f1223e8SApple OSS Distributions char *cpu_count_variants[num_cpu_count_variants] = {"physicalcpu_max", "logicalcpu_max"};
499*4f1223e8SApple OSS Distributions for (int v = 0; v < num_cpu_count_variants; v++) {
500*4f1223e8SApple OSS Distributions unsigned int total_amount = 0;
501*4f1223e8SApple OSS Distributions snprintf(sysctlname, sizeof(sysctlname), "hw.%s", cpu_count_variants[v]);
502*4f1223e8SApple OSS Distributions ret = sysctlbyname(sysctlname, &total_amount, &(size_t){ sizeof(total_amount) }, NULL, 0);
503*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, sysctlname);
504*4f1223e8SApple OSS Distributions unsigned int amount_from_perflevels = 0;
505*4f1223e8SApple OSS Distributions for (int p = 0; p < level_count; p++) {
506*4f1223e8SApple OSS Distributions unsigned int perflevel_amount = 0;
507*4f1223e8SApple OSS Distributions snprintf(sysctlname, sizeof(sysctlname), "hw.perflevel%d.%s", p, cpu_count_variants[v]);
508*4f1223e8SApple OSS Distributions ret = sysctlbyname(sysctlname, &perflevel_amount, &(size_t){ sizeof(perflevel_amount) }, NULL, 0);
509*4f1223e8SApple OSS Distributions T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, sysctlname);
510*4f1223e8SApple OSS Distributions amount_from_perflevels += perflevel_amount;
511*4f1223e8SApple OSS Distributions }
512*4f1223e8SApple OSS Distributions T_EXPECT_EQ(total_amount, amount_from_perflevels, "all %u %s accounted for", total_amount, cpu_count_variants[v]);
513*4f1223e8SApple OSS Distributions }
514*4f1223e8SApple OSS Distributions }
515