xref: /xnu-11417.140.69/tests/exception_ports_info.c (revision 43a90889846e00bfb5cf1d255cdc0a701a1e05a4)
1 #include <darwintest.h>
2 #include <mach/mach.h>
3 #include <mach/mach_types.h>
4 #include <mach/task.h>
5 #include <mach/thread_act.h>
6 #include <mach_debug/ipc_info.h>
7 
8 T_GLOBAL_META(
9 	T_META_NAMESPACE("xnu.ipc"),
10 	T_META_RADAR_COMPONENT_NAME("xnu"),
11 	T_META_RADAR_COMPONENT_VERSION("IPC"),
12 	T_META_RUN_CONCURRENTLY(true),
13 	T_META_TAG_VM_PREFERRED);
14 
15 T_DECL(exception_ports_info, "Test {task, thread}_get_exception_ports_info")
16 {
17 	kern_return_t kr;
18 	mach_port_t exc_port1, exc_port2, exc_port3;
19 
20 	mach_msg_type_number_t count = EXC_TYPES_COUNT;
21 	exception_mask_t masks[EXC_TYPES_COUNT];
22 	ipc_info_port_t ports_info[EXC_TYPES_COUNT];
23 	exception_behavior_t behaviors[EXC_TYPES_COUNT];
24 	thread_state_flavor_t flavors[EXC_TYPES_COUNT];
25 
26 	mach_msg_type_number_t count2 = EXC_TYPES_COUNT;
27 	exception_mask_t masks2[EXC_TYPES_COUNT];
28 	mach_port_t ports[EXC_TYPES_COUNT];
29 	exception_behavior_t behaviors2[EXC_TYPES_COUNT];
30 	thread_state_flavor_t flavors2[EXC_TYPES_COUNT];
31 
32 	unsigned int exc_port1_kotype = 0, exc_port1_kaddr = 0;
33 	unsigned int exc_port2_kotype = 0, exc_port2_kaddr = 0;
34 	unsigned int kotype = 0, kobject = 0, exc_port3_kotype = 0, exc_port3_kaddr = 0;
35 	boolean_t found_exc_port1 = false;
36 	boolean_t found_exc_port2 = false;
37 	boolean_t found_exc_port3 = false;
38 
39 	ipc_info_space_t info_space;
40 	ipc_info_name_array_t table;
41 	ipc_info_tree_name_array_t tree;
42 	mach_msg_type_number_t tblcnt = 0, treecnt = 0;
43 
44 	/* Create the mach port the exception messages will be sent to. */
45 	kr = mach_port_allocate(mach_task_self(), MACH_PORT_RIGHT_RECEIVE, &exc_port1);
46 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "Allocated mach exception port");
47 	kr = mach_port_allocate(mach_task_self(), MACH_PORT_RIGHT_RECEIVE, &exc_port2);
48 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "Allocated mach exception port");
49 	kr = mach_port_allocate(mach_task_self(), MACH_PORT_RIGHT_RECEIVE, &exc_port3);
50 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "Allocated mach exception port");
51 
52 	/*
53 	 * Insert a send right into the exception port that the kernel will use to
54 	 * send the exception thread the exception messages.
55 	 */
56 	kr = mach_port_insert_right(mach_task_self(), exc_port1, exc_port1, MACH_MSG_TYPE_MAKE_SEND);
57 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "Inserted a SEND right into the exception port");
58 	kr = mach_port_insert_right(mach_task_self(), exc_port2, exc_port2, MACH_MSG_TYPE_MAKE_SEND);
59 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "Inserted a SEND right into the exception port");
60 	kr = mach_port_insert_right(mach_task_self(), exc_port3, exc_port3, MACH_MSG_TYPE_MAKE_SEND);
61 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "Inserted a SEND right into the exception port");
62 
63 	T_LOG("exc_port1: 0x%x", exc_port1);
64 	T_LOG("exc_port2: 0x%x", exc_port2);
65 	T_LOG("exc_port3: 0x%x", exc_port3);
66 
67 	/* Tell the kernel what port to send exceptions to. */
68 	kr = task_set_exception_ports(
69 		mach_task_self(),
70 		EXC_MASK_GUARD,
71 		exc_port1,
72 		(exception_behavior_t)(EXCEPTION_STATE_IDENTITY | MACH_EXCEPTION_CODES),
73 		THREAD_STATE_NONE);
74 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "Set the exception port to my custom handler");
75 
76 	kr = task_set_exception_ports(
77 		mach_task_self(),
78 		EXC_MASK_RPC_ALERT,  /* why can't be EXC_CRASH or EXC_MASK_CORPSE_NOTIFY ? */
79 		exc_port2,
80 		(exception_behavior_t)(EXCEPTION_STATE_IDENTITY | MACH_EXCEPTION_CODES),
81 		THREAD_STATE_NONE);
82 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "Set the exception port to my custom handler");
83 
84 	kr = task_set_exception_ports(
85 		mach_task_self(),
86 		EXC_MASK_RESOURCE | EXC_MASK_BREAKPOINT | EXC_MASK_SYSCALL,
87 		exc_port3,
88 		(exception_behavior_t)(EXCEPTION_STATE_IDENTITY | MACH_EXCEPTION_CODES),
89 		THREAD_STATE_NONE);
90 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "Set the exception port to my custom handler");
91 
92 	/* now, get exception ports info */
93 	kr = thread_get_exception_ports(mach_thread_self(), EXC_MASK_ALL, masks2, &count2, ports, behaviors2, flavors2);
94 	T_EXPECT_MACH_SUCCESS(kr, "thread_get_exception_ports(): 0x%x", kr);
95 	T_EXPECT_EQ(count2, 0, "should have 0 exception ports");
96 
97 	kr = thread_get_exception_ports_info(mach_thread_self(), EXC_MASK_ALL, masks, &count, ports_info, behaviors, flavors);
98 	T_EXPECT_MACH_SUCCESS(kr, "thread_get_exception_ports_info(): 0x%x", kr);
99 	T_EXPECT_EQ(count, 0, "should have 0 exception ports");
100 
101 	count = EXC_TYPES_COUNT;
102 	count2 = EXC_TYPES_COUNT;
103 
104 	kr = task_get_exception_ports_info(mach_task_self(), EXC_MASK_ALL, masks, &count, ports_info, behaviors, flavors);
105 	T_EXPECT_MACH_SUCCESS(kr, "task_get_exception_ports_info(): 0x%x", kr);
106 	T_EXPECT_EQ(count, 4, "should have 4 masks"); /* Returns 3 if one exc_port registers for EXC_CRASH */
107 
108 	/* get exception ports */
109 	kr = task_get_exception_ports(mach_task_self(), EXC_MASK_ALL, masks2, &count2, ports, behaviors2, flavors2);
110 	T_EXPECT_MACH_SUCCESS(kr, "task_get_exception_ports(): 0x%x", kr);
111 
112 	for (int i = 0; i < count2; i++) {
113 		T_LOG("exception port name: 0x%x", ports[i]);
114 	}
115 	T_EXPECT_EQ(count, count2, "should return same mask count");
116 
117 	kr = memcmp(masks, masks2, count * sizeof(exception_mask_t));
118 	T_EXPECT_EQ(kr, 0, "masks should be the same");
119 
120 	kr = memcmp(behaviors, behaviors2, count * sizeof(exception_behavior_t));
121 	T_EXPECT_EQ(kr, 0, "behaviors should be the same");
122 
123 	kr = memcmp(flavors, flavors, count * sizeof(thread_state_flavor_t));
124 	T_EXPECT_EQ(kr, 0, "flavors should be the same");
125 
126 	kr = mach_port_kernel_object(mach_task_self(), mach_task_self(), &kotype, &kobject);
127 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "mach_port_kernel_object(): 0x%x", kr);
128 	T_LOG("task_self kobject: 0x%x", kobject);
129 
130 	T_QUIET; T_EXPECT_MACH_SUCCESS(mach_port_space_info(mach_task_self(), &info_space, &table,
131 	    &tblcnt, &tree, &treecnt), "mach_port_space_info(): 0x%x", kr);
132 
133 	for (int i = 0; i < tblcnt; i++) {
134 		if (table[i].iin_name == exc_port1) {
135 			exc_port1_kaddr = table[i].iin_object;
136 		}
137 		if (table[i].iin_name == exc_port2) {
138 			exc_port2_kaddr = table[i].iin_object;
139 		}
140 		if (table[i].iin_name == exc_port3) {
141 			exc_port3_kaddr = table[i].iin_object;
142 		}
143 	}
144 
145 	T_LOG("exc_port_1_kaddr: 0x%x", exc_port1_kaddr);
146 	T_LOG("exc_port_2_kaddr: 0x%x", exc_port2_kaddr);
147 	T_LOG("exc_port_3_kaddr: 0x%x", exc_port3_kaddr);
148 
149 	for (int i = 0; i < count; i++) {
150 		T_LOG("ports_info[%d].iip_port_object: 0x%x", i, ports_info[i].iip_port_object);
151 
152 		if (ports_info[i].iip_port_object == exc_port1_kaddr) {
153 			T_EXPECT_NE(ports_info[i].iip_port_object, 0,
154 			    "on debug/kernel, port object should be non-zero: 0x%x", ports_info[i].iip_port_object);
155 			T_EXPECT_EQ(ports_info[i].iip_receiver_object, kobject,
156 			    "receiver object should match task self kobject: 0x%x", ports_info[i].iip_receiver_object);
157 			T_EXPECT_EQ(masks[i], EXC_MASK_GUARD, "check if mask for exc_port1 is correct");
158 			found_exc_port1 = true;
159 		}
160 		if (ports_info[i].iip_port_object == exc_port2_kaddr) {
161 			T_EXPECT_NE(ports_info[i].iip_port_object, 0,
162 			    "on debug/kernel, port object should be non-zero: 0x%x", ports_info[i].iip_port_object);
163 			T_EXPECT_EQ(ports_info[i].iip_receiver_object, kobject,
164 			    "receiver object should match task self kobject: 0x%x", ports_info[i].iip_receiver_object);
165 			T_EXPECT_EQ(masks[i], EXC_MASK_RPC_ALERT, "check if mask for exc_port2 is correct");
166 			found_exc_port2 = true;
167 		}
168 		if (ports_info[i].iip_port_object == exc_port3_kaddr) {
169 			T_EXPECT_NE(ports_info[i].iip_port_object, 0,
170 			    "on debug/kernel, port object should be non-zero: 0x%x", ports_info[i].iip_port_object);
171 			T_EXPECT_EQ(ports_info[i].iip_receiver_object, kobject,
172 			    "receiver object should match task self kobject: 0x%x", ports_info[i].iip_receiver_object);
173 			T_EXPECT_EQ(masks[i], EXC_MASK_RESOURCE | EXC_MASK_BREAKPOINT | EXC_MASK_SYSCALL, "check if mask for exc_port3 is correct");
174 			found_exc_port3 = true;
175 		}
176 	}
177 
178 	T_EXPECT_TRUE(found_exc_port1, "should find exc_port1");
179 	T_EXPECT_TRUE(found_exc_port2, "should find exc_port2");
180 	T_EXPECT_TRUE(found_exc_port3, "should find exc_port3");
181 }
182