1 /*
2 * Created by Jarrad Cisco on 09/28/2022.
3 * Copyright © 2022 Apple. All rights reserved.
4 *
5 * Functional tests for VM compressor/swap.
6 */
7 #include <sys/sysctl.h>
8 #include <darwintest.h>
9 #include <darwintest_utils.h>
10 #include <TargetConditionals.h>
11
12 #include <mach/mach.h>
13 #include <mach/mach_host.h> /* host_statistics */
14 #include <vm/vm_compressor_info.h>
15
16 T_GLOBAL_META(
17 T_META_NAMESPACE("xnu.vm"),
18 T_META_RADAR_COMPONENT_NAME("xnu"),
19 T_META_RADAR_COMPONENT_VERSION("VM"),
20 T_META_ASROOT(NO),
21 T_META_RUN_CONCURRENTLY(true));
22
23 T_DECL(swap_enabled,
24 "Check that Swap is successfully enabled",
25 T_META_ENABLED(TARGET_OS_OSX), T_META_TAG_VM_PREFERRED)
26 {
27 int swap_enabled;
28 size_t len = sizeof(swap_enabled);
29 int rc = sysctlbyname("vm.swap_enabled", &swap_enabled, &len, NULL, 0);
30 T_QUIET; T_ASSERT_POSIX_SUCCESS(rc, "Failed to query sysctl `vm.swap_enabled`");
31 T_EXPECT_EQ(swap_enabled, 1, "Check that vm.swap_enabled is set");
32 }
33
34
35 T_DECL(host_statistics_q_lens, "Check that the compressor queue lens sysctl works",
36 T_META_REQUIRES_SYSCTL_EQ("kern.development", 1))
37 {
38 struct vm_compressor_q_lens d;
39 mach_msg_type_number_t vm_qlen_count = VM_COMPRESSOR_Q_LENS_COUNT;
40 kern_return_t kr = host_statistics64(mach_host_self(), HOST_VM_COMPRESSOR_Q_LENS, (host_info64_t)&d, &vm_qlen_count);
41 T_ASSERT_MACH_SUCCESS(kr, "host_statistics64(HOST_VM_COMPRESSOR_Q_LENS)");
42 T_EXPECT_EQ(vm_qlen_count, (uint32_t)VM_COMPRESSOR_Q_LENS_COUNT, "check output is the expected length");
43 }
44
45 size_t read_big_sysctl(const int *mib, size_t mib_len, const char* name, char **buf);
46
47 size_t
read_big_sysctl(const int * mib,size_t mib_len,const char * name,char ** buf)48 read_big_sysctl(const int *mib, size_t mib_len, const char* name, char **buf)
49 {
50 size_t len = 0;
51 int rc = sysctl(mib, mib_len, NULL, &len, NULL, 0);
52 T_ASSERT_POSIX_SUCCESS(rc, "query size of sysctl `%s`(%zu)", name, mib_len);
53 T_ASSERT_GT(len, (size_t)0, "sysctl got size 0");
54 len += 4096; /* allocate a bit extra in case the size changed between the two calls */
55 *buf = (char*)malloc(len);
56 T_ASSERT_NE_PTR((void*)*buf, NULL, "allocation for sysctl %zu", len);
57 rc = sysctl(mib, mib_len, *buf, &len, NULL, 0);
58 T_ASSERT_POSIX_SUCCESS(rc, "query of sysctl `%s`", name);
59 return len;
60 }
61
62 size_t
get_sysctl_mib(const char * ctl_name,int * mib,size_t mib_sz)63 get_sysctl_mib(const char* ctl_name, int* mib, size_t mib_sz)
64 {
65 size_t mib_size = mib_sz;
66 int rc = sysctlnametomib(ctl_name, mib, &mib_size);
67 T_ASSERT_POSIX_SUCCESS(rc, "query name mib `%s` got %zu", ctl_name, mib_size);
68 return mib_size;
69 }
70
71 T_DECL(sysctl_c_segments, "Check that the sysctl that dumps all the c_segments works correctly",
72 T_META_REQUIRES_SYSCTL_EQ("kern.development", 1))
73 {
74 int mib[CTL_MAXNAME] = {0};
75 size_t mib_len = get_sysctl_mib("vm.compressor_segments", mib, CTL_MAXNAME);
76 char *buf = NULL;
77 size_t sz = read_big_sysctl(mib, mib_len, "vm.compressor_segments", &buf);
78
79 size_t offset = 0;
80 T_ASSERT_GE_ULONG(sz, sizeof(uint32_t), "got buffer shorter than the magic value");
81 uint32_t hdr_magic = *((uint32_t*)buf);
82 T_ASSERT_EQ_UINT(hdr_magic, VM_C_SEGMENT_INFO_MAGIC, "match magic value");
83 offset += sizeof(uint32_t);
84 while (offset < sz) {
85 // read next c_segment
86 T_QUIET; T_ASSERT_LE(offset + sizeof(struct c_segment_info), sz, "unexpected offset for c_segment_info");
87 const struct c_segment_info* cseg = (const struct c_segment_info*)(buf + offset);
88 offset += sizeof(struct c_segment_info);
89 // read it's slots
90 T_QUIET; T_ASSERT_LE(offset + cseg->csi_slots_len * sizeof(struct c_slot_info), sz, "unexpected offset for c_slot_info");
91 offset += cseg->csi_slots_len * sizeof(struct c_slot_info);
92 }
93 }
94
95 T_DECL(sysctl_vm_object_dump, "Check that the sysctl that dumps the metadata of a vm_object works correctly",
96 T_META_REQUIRES_SYSCTL_EQ("kern.development", 1))
97 {
98 int mib[CTL_MAXNAME] = {0};
99 size_t mib_len = get_sysctl_mib("vm.task_vm_objects_slotmap", mib, CTL_MAXNAME);
100 mib[mib_len++] = getpid();
101
102 char *buf = NULL;
103 size_t sz = read_big_sysctl(mib, mib_len, "vm.compressor_segments.<pid>", &buf);
104
105 size_t offset = 0;
106 T_ASSERT_GE_ULONG(sz, sizeof(uint32_t), "got buffer shorter than the magic value");
107 uint32_t hdr_magic = *((uint32_t*)buf);
108 T_ASSERT_EQ_UINT(hdr_magic, VM_MAP_ENTRY_INFO_MAGIC, "match magic value");
109 offset += sizeof(uint32_t);
110
111 T_ASSERT_LE(offset + sizeof(struct vm_map_info_hdr), sz, "vm_map_info_hdr size");
112 struct vm_map_info_hdr* hdr = (struct vm_map_info_hdr*)(buf + offset);
113 for (int i = 0; i < hdr->vmi_nentries; ++i) {
114 T_QUIET; T_ASSERT_LE(offset + sizeof(struct vm_map_entry_info), sz, "vm_map_entry_info size");
115 offset += sizeof(struct vm_map_entry_info);
116 }
117 }
118