xref: /xnu-10002.41.9/iokit/Kernel/IOPerfControl.cpp (revision 699cd48037512bf4380799317ca44ca453c82f57)
1*699cd480SApple OSS Distributions /*
2*699cd480SApple OSS Distributions  * Copyright (c) 2017 Apple Inc. All rights reserved.
3*699cd480SApple OSS Distributions  */
4*699cd480SApple OSS Distributions 
5*699cd480SApple OSS Distributions #include <IOKit/perfcontrol/IOPerfControl.h>
6*699cd480SApple OSS Distributions 
7*699cd480SApple OSS Distributions #include <stdatomic.h>
8*699cd480SApple OSS Distributions 
9*699cd480SApple OSS Distributions #include <kern/thread_group.h>
10*699cd480SApple OSS Distributions 
11*699cd480SApple OSS Distributions #undef super
12*699cd480SApple OSS Distributions #define super OSObject
13*699cd480SApple OSS Distributions OSDefineMetaClassAndStructors(IOPerfControlClient, OSObject);
14*699cd480SApple OSS Distributions 
15*699cd480SApple OSS Distributions static IOPerfControlClient::IOPerfControlClientShared *_Atomic gIOPerfControlClientShared;
16*699cd480SApple OSS Distributions 
17*699cd480SApple OSS Distributions bool
init(IOService * driver,uint64_t maxWorkCapacity)18*699cd480SApple OSS Distributions IOPerfControlClient::init(IOService *driver, uint64_t maxWorkCapacity)
19*699cd480SApple OSS Distributions {
20*699cd480SApple OSS Distributions 	// TODO: Remove this limit and implement dynamic table growth if workloads are found that exceed this
21*699cd480SApple OSS Distributions 	if (maxWorkCapacity > kMaxWorkTableNumEntries) {
22*699cd480SApple OSS Distributions 		maxWorkCapacity = kMaxWorkTableNumEntries;
23*699cd480SApple OSS Distributions 	}
24*699cd480SApple OSS Distributions 
25*699cd480SApple OSS Distributions 	if (!super::init()) {
26*699cd480SApple OSS Distributions 		return false;
27*699cd480SApple OSS Distributions 	}
28*699cd480SApple OSS Distributions 
29*699cd480SApple OSS Distributions 	shared = atomic_load_explicit(&gIOPerfControlClientShared, memory_order_acquire);
30*699cd480SApple OSS Distributions 	if (shared == nullptr) {
31*699cd480SApple OSS Distributions 		IOPerfControlClient::IOPerfControlClientShared *expected = shared;
32*699cd480SApple OSS Distributions 		shared = kalloc_type(IOPerfControlClientShared, Z_WAITOK);
33*699cd480SApple OSS Distributions 		if (!shared) {
34*699cd480SApple OSS Distributions 			return false;
35*699cd480SApple OSS Distributions 		}
36*699cd480SApple OSS Distributions 
37*699cd480SApple OSS Distributions 		atomic_init(&shared->maxDriverIndex, 0);
38*699cd480SApple OSS Distributions 
39*699cd480SApple OSS Distributions 		shared->interface = PerfControllerInterface{
40*699cd480SApple OSS Distributions 			.version = PERFCONTROL_INTERFACE_VERSION_NONE,
41*699cd480SApple OSS Distributions 			.registerDevice =
42*699cd480SApple OSS Distributions 		    [](IOService *device) {
43*699cd480SApple OSS Distributions 			    return kIOReturnSuccess;
44*699cd480SApple OSS Distributions 		    },
45*699cd480SApple OSS Distributions 			.unregisterDevice =
46*699cd480SApple OSS Distributions 			    [](IOService *device) {
47*699cd480SApple OSS Distributions 				    return kIOReturnSuccess;
48*699cd480SApple OSS Distributions 			    },
49*699cd480SApple OSS Distributions 			.workCanSubmit =
50*699cd480SApple OSS Distributions 			    [](IOService *device, PerfControllerInterface::WorkState *state, WorkSubmitArgs *args) {
51*699cd480SApple OSS Distributions 				    return false;
52*699cd480SApple OSS Distributions 			    },
53*699cd480SApple OSS Distributions 			.workSubmit =
54*699cd480SApple OSS Distributions 			    [](IOService *device, uint64_t token, PerfControllerInterface::WorkState *state, WorkSubmitArgs *args) {
55*699cd480SApple OSS Distributions 			    },
56*699cd480SApple OSS Distributions 			.workBegin =
57*699cd480SApple OSS Distributions 			    [](IOService *device, uint64_t token, PerfControllerInterface::WorkState *state, WorkBeginArgs *args) {
58*699cd480SApple OSS Distributions 			    },
59*699cd480SApple OSS Distributions 			.workEnd =
60*699cd480SApple OSS Distributions 			    [](IOService *device, uint64_t token, PerfControllerInterface::WorkState *state, WorkEndArgs *args, bool done) {
61*699cd480SApple OSS Distributions 			    },
62*699cd480SApple OSS Distributions 			.workUpdate =
63*699cd480SApple OSS Distributions 			    [](IOService *device, uint64_t token, PerfControllerInterface::WorkState *state, WorkUpdateArgs *args) {
64*699cd480SApple OSS Distributions 			    },
65*699cd480SApple OSS Distributions 		};
66*699cd480SApple OSS Distributions 
67*699cd480SApple OSS Distributions 		shared->interfaceLock = IOLockAlloc();
68*699cd480SApple OSS Distributions 		if (!shared->interfaceLock) {
69*699cd480SApple OSS Distributions 			goto shared_init_error;
70*699cd480SApple OSS Distributions 		}
71*699cd480SApple OSS Distributions 
72*699cd480SApple OSS Distributions 		shared->deviceRegistrationList = OSSet::withCapacity(4);
73*699cd480SApple OSS Distributions 		if (!shared->deviceRegistrationList) {
74*699cd480SApple OSS Distributions 			goto shared_init_error;
75*699cd480SApple OSS Distributions 		}
76*699cd480SApple OSS Distributions 
77*699cd480SApple OSS Distributions 		if (!atomic_compare_exchange_strong_explicit(&gIOPerfControlClientShared, &expected, shared, memory_order_acq_rel,
78*699cd480SApple OSS Distributions 		    memory_order_acquire)) {
79*699cd480SApple OSS Distributions 			IOLockFree(shared->interfaceLock);
80*699cd480SApple OSS Distributions 			shared->deviceRegistrationList->release();
81*699cd480SApple OSS Distributions 			kfree_type(IOPerfControlClientShared, shared);
82*699cd480SApple OSS Distributions 			shared = expected;
83*699cd480SApple OSS Distributions 		}
84*699cd480SApple OSS Distributions 	}
85*699cd480SApple OSS Distributions 	workTable = NULL;
86*699cd480SApple OSS Distributions 	workTableLock = NULL;
87*699cd480SApple OSS Distributions 
88*699cd480SApple OSS Distributions 	// Note: driverIndex is not guaranteed to be unique if maxDriverIndex wraps around. It is intended for debugging only.
89*699cd480SApple OSS Distributions 	driverIndex = atomic_fetch_add_explicit(&shared->maxDriverIndex, 1, memory_order_relaxed) + 1;
90*699cd480SApple OSS Distributions 
91*699cd480SApple OSS Distributions 	// + 1 since index 0 is unused for kIOPerfControlClientWorkUntracked
92*699cd480SApple OSS Distributions 	workTableLength = maxWorkCapacity + 1;
93*699cd480SApple OSS Distributions 	assertf(workTableLength <= kWorkTableMaxSize, "%zu exceeds max allowed capacity of %zu", workTableLength, kWorkTableMaxSize);
94*699cd480SApple OSS Distributions 	if (maxWorkCapacity > 0) {
95*699cd480SApple OSS Distributions 		workTable = kalloc_type(WorkTableEntry, workTableLength, Z_WAITOK_ZERO);
96*699cd480SApple OSS Distributions 		if (!workTable) {
97*699cd480SApple OSS Distributions 			goto error;
98*699cd480SApple OSS Distributions 		}
99*699cd480SApple OSS Distributions 		workTableNextIndex = 1;
100*699cd480SApple OSS Distributions 
101*699cd480SApple OSS Distributions 		workTableLock = IOSimpleLockAlloc();
102*699cd480SApple OSS Distributions 		if (!workTableLock) {
103*699cd480SApple OSS Distributions 			goto error;
104*699cd480SApple OSS Distributions 		}
105*699cd480SApple OSS Distributions 	}
106*699cd480SApple OSS Distributions 
107*699cd480SApple OSS Distributions 	bzero(&clientData, sizeof(clientData));
108*699cd480SApple OSS Distributions 
109*699cd480SApple OSS Distributions 	return true;
110*699cd480SApple OSS Distributions 
111*699cd480SApple OSS Distributions error:
112*699cd480SApple OSS Distributions 	if (workTable) {
113*699cd480SApple OSS Distributions 		kfree_type(WorkTableEntry, workTableLength, workTable);
114*699cd480SApple OSS Distributions 		workTable = NULL;
115*699cd480SApple OSS Distributions 	}
116*699cd480SApple OSS Distributions 	if (workTableLock) {
117*699cd480SApple OSS Distributions 		IOSimpleLockFree(workTableLock);
118*699cd480SApple OSS Distributions 		workTableLock = NULL;
119*699cd480SApple OSS Distributions 	}
120*699cd480SApple OSS Distributions 	return false;
121*699cd480SApple OSS Distributions shared_init_error:
122*699cd480SApple OSS Distributions 	if (shared) {
123*699cd480SApple OSS Distributions 		if (shared->interfaceLock) {
124*699cd480SApple OSS Distributions 			IOLockFree(shared->interfaceLock);
125*699cd480SApple OSS Distributions 		}
126*699cd480SApple OSS Distributions 		if (shared->deviceRegistrationList) {
127*699cd480SApple OSS Distributions 			shared->deviceRegistrationList->release();
128*699cd480SApple OSS Distributions 		}
129*699cd480SApple OSS Distributions 		kfree_type(IOPerfControlClientShared, shared);
130*699cd480SApple OSS Distributions 		shared = nullptr;
131*699cd480SApple OSS Distributions 	}
132*699cd480SApple OSS Distributions 	return false;
133*699cd480SApple OSS Distributions }
134*699cd480SApple OSS Distributions 
135*699cd480SApple OSS Distributions void
free()136*699cd480SApple OSS Distributions IOPerfControlClient::free()
137*699cd480SApple OSS Distributions {
138*699cd480SApple OSS Distributions 	if (workTable) {
139*699cd480SApple OSS Distributions 		kfree_type(WorkTableEntry, workTableLength, workTable);
140*699cd480SApple OSS Distributions 	}
141*699cd480SApple OSS Distributions 	if (workTableLock) {
142*699cd480SApple OSS Distributions 		IOSimpleLockFree(workTableLock);
143*699cd480SApple OSS Distributions 	}
144*699cd480SApple OSS Distributions 	super::free();
145*699cd480SApple OSS Distributions }
146*699cd480SApple OSS Distributions 
147*699cd480SApple OSS Distributions IOPerfControlClient *
copyClient(IOService * driver,uint64_t maxWorkCapacity)148*699cd480SApple OSS Distributions IOPerfControlClient::copyClient(IOService *driver, uint64_t maxWorkCapacity)
149*699cd480SApple OSS Distributions {
150*699cd480SApple OSS Distributions 	IOPerfControlClient *client = new IOPerfControlClient;
151*699cd480SApple OSS Distributions 	if (!client || !client->init(driver, maxWorkCapacity)) {
152*699cd480SApple OSS Distributions 		panic("could not create IOPerfControlClient");
153*699cd480SApple OSS Distributions 	}
154*699cd480SApple OSS Distributions 	return client;
155*699cd480SApple OSS Distributions }
156*699cd480SApple OSS Distributions 
157*699cd480SApple OSS Distributions /* Convert the per driver token into a globally unique token for the performance
158*699cd480SApple OSS Distributions  * controller's consumption. This is achieved by setting the driver's unique
159*699cd480SApple OSS Distributions  * index onto the high order bits. The performance controller is shared between
160*699cd480SApple OSS Distributions  * all drivers and must track all instances separately, while each driver has
161*699cd480SApple OSS Distributions  * its own token table, so this step is needed to avoid token collisions between
162*699cd480SApple OSS Distributions  * drivers.
163*699cd480SApple OSS Distributions  */
164*699cd480SApple OSS Distributions inline uint64_t
tokenToGlobalUniqueToken(uint64_t token)165*699cd480SApple OSS Distributions IOPerfControlClient::tokenToGlobalUniqueToken(uint64_t token)
166*699cd480SApple OSS Distributions {
167*699cd480SApple OSS Distributions 	return token | (static_cast<uint64_t>(driverIndex) << kWorkTableIndexBits);
168*699cd480SApple OSS Distributions }
169*699cd480SApple OSS Distributions 
170*699cd480SApple OSS Distributions /* With this implementation, tokens returned to the driver differ from tokens
171*699cd480SApple OSS Distributions  * passed to the performance controller. This implementation has the nice
172*699cd480SApple OSS Distributions  * property that tokens returns to the driver will aways be between 1 and
173*699cd480SApple OSS Distributions  * the value of maxWorkCapacity passed by the driver to copyClient. The tokens
174*699cd480SApple OSS Distributions  * the performance controller sees will match on the lower order bits and have
175*699cd480SApple OSS Distributions  * the driver index set on the high order bits.
176*699cd480SApple OSS Distributions  */
177*699cd480SApple OSS Distributions uint64_t
allocateToken(thread_group * thread_group)178*699cd480SApple OSS Distributions IOPerfControlClient::allocateToken(thread_group *thread_group)
179*699cd480SApple OSS Distributions {
180*699cd480SApple OSS Distributions 	uint64_t token = kIOPerfControlClientWorkUntracked;
181*699cd480SApple OSS Distributions 
182*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
183*699cd480SApple OSS Distributions 	auto s = IOSimpleLockLockDisableInterrupt(workTableLock);
184*699cd480SApple OSS Distributions 
185*699cd480SApple OSS Distributions 	uint64_t num_tries = 0;
186*699cd480SApple OSS Distributions 	size_t index = workTableNextIndex;
187*699cd480SApple OSS Distributions 	// - 1 since entry 0 is for kIOPerfControlClientWorkUntracked
188*699cd480SApple OSS Distributions 	while (num_tries < workTableLength - 1) {
189*699cd480SApple OSS Distributions 		if (workTable[index].thread_group == nullptr) {
190*699cd480SApple OSS Distributions 			thread_group_retain(thread_group);
191*699cd480SApple OSS Distributions 			workTable[index].thread_group = thread_group;
192*699cd480SApple OSS Distributions 			token = index;
193*699cd480SApple OSS Distributions 			// next integer between 1 and workTableLength - 1
194*699cd480SApple OSS Distributions 			workTableNextIndex = (index % (workTableLength - 1)) + 1;
195*699cd480SApple OSS Distributions 			break;
196*699cd480SApple OSS Distributions 		}
197*699cd480SApple OSS Distributions 		// next integer between 1 and workTableLength - 1
198*699cd480SApple OSS Distributions 		index = (index % (workTableLength - 1)) + 1;
199*699cd480SApple OSS Distributions 		num_tries += 1;
200*699cd480SApple OSS Distributions 	}
201*699cd480SApple OSS Distributions #if (DEVELOPMENT || DEBUG)
202*699cd480SApple OSS Distributions 	if (token == kIOPerfControlClientWorkUntracked) {
203*699cd480SApple OSS Distributions 		/* When investigating a panic here, first check that the driver is not leaking tokens.
204*699cd480SApple OSS Distributions 		 * If the driver is not leaking tokens and maximum is less than kMaxWorkTableNumEntries,
205*699cd480SApple OSS Distributions 		 * the driver should be modified to pass a larger value to copyClient.
206*699cd480SApple OSS Distributions 		 * If the driver is not leaking tokens and maximum is equal to kMaxWorkTableNumEntries,
207*699cd480SApple OSS Distributions 		 * this code will have to be modified to support dynamic table growth to support larger
208*699cd480SApple OSS Distributions 		 * numbers of tokens.
209*699cd480SApple OSS Distributions 		 */
210*699cd480SApple OSS Distributions 		panic("Tokens allocated for this device exceeded maximum of %zu.",
211*699cd480SApple OSS Distributions 		    workTableLength - 1); // - 1 since entry 0 is for kIOPerfControlClientWorkUntracked
212*699cd480SApple OSS Distributions 	}
213*699cd480SApple OSS Distributions #endif
214*699cd480SApple OSS Distributions 
215*699cd480SApple OSS Distributions 	IOSimpleLockUnlockEnableInterrupt(workTableLock, s);
216*699cd480SApple OSS Distributions #endif
217*699cd480SApple OSS Distributions 
218*699cd480SApple OSS Distributions 	return token;
219*699cd480SApple OSS Distributions }
220*699cd480SApple OSS Distributions 
221*699cd480SApple OSS Distributions void
deallocateToken(uint64_t token)222*699cd480SApple OSS Distributions IOPerfControlClient::deallocateToken(uint64_t token)
223*699cd480SApple OSS Distributions {
224*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
225*699cd480SApple OSS Distributions 	assertf(token != kIOPerfControlClientWorkUntracked, "Attempt to deallocate token kIOPerfControlClientWorkUntracked\n");
226*699cd480SApple OSS Distributions 	assertf(token <= workTableLength, "Attempt to deallocate token %llu which is greater than the table size of %zu\n", token, workTableLength);
227*699cd480SApple OSS Distributions 	auto s = IOSimpleLockLockDisableInterrupt(workTableLock);
228*699cd480SApple OSS Distributions 
229*699cd480SApple OSS Distributions 	auto &entry = workTable[token];
230*699cd480SApple OSS Distributions 	auto *thread_group = entry.thread_group;
231*699cd480SApple OSS Distributions 	bzero(&entry, sizeof(entry));
232*699cd480SApple OSS Distributions 	workTableNextIndex = token;
233*699cd480SApple OSS Distributions 
234*699cd480SApple OSS Distributions 	IOSimpleLockUnlockEnableInterrupt(workTableLock, s);
235*699cd480SApple OSS Distributions 
236*699cd480SApple OSS Distributions 	// This can call into the performance controller if the last reference is dropped here. Are we sure
237*699cd480SApple OSS Distributions 	// the driver isn't holding any locks? If not, we may want to async this to another context.
238*699cd480SApple OSS Distributions 	thread_group_release(thread_group);
239*699cd480SApple OSS Distributions #endif
240*699cd480SApple OSS Distributions }
241*699cd480SApple OSS Distributions 
242*699cd480SApple OSS Distributions IOPerfControlClient::WorkTableEntry *
getEntryForToken(uint64_t token)243*699cd480SApple OSS Distributions IOPerfControlClient::getEntryForToken(uint64_t token)
244*699cd480SApple OSS Distributions {
245*699cd480SApple OSS Distributions 	if (token == kIOPerfControlClientWorkUntracked) {
246*699cd480SApple OSS Distributions 		return nullptr;
247*699cd480SApple OSS Distributions 	}
248*699cd480SApple OSS Distributions 
249*699cd480SApple OSS Distributions 	if (token >= workTableLength) {
250*699cd480SApple OSS Distributions 		panic("Invalid work token (%llu): index out of bounds.", token);
251*699cd480SApple OSS Distributions 	}
252*699cd480SApple OSS Distributions 
253*699cd480SApple OSS Distributions 	WorkTableEntry *entry = &workTable[token];
254*699cd480SApple OSS Distributions 	assertf(entry->thread_group, "Invalid work token: %llu", token);
255*699cd480SApple OSS Distributions 	return entry;
256*699cd480SApple OSS Distributions }
257*699cd480SApple OSS Distributions 
258*699cd480SApple OSS Distributions void
markEntryStarted(uint64_t token,bool started)259*699cd480SApple OSS Distributions IOPerfControlClient::markEntryStarted(uint64_t token, bool started)
260*699cd480SApple OSS Distributions {
261*699cd480SApple OSS Distributions 	if (token == kIOPerfControlClientWorkUntracked) {
262*699cd480SApple OSS Distributions 		return;
263*699cd480SApple OSS Distributions 	}
264*699cd480SApple OSS Distributions 
265*699cd480SApple OSS Distributions 	if (token >= workTableLength) {
266*699cd480SApple OSS Distributions 		panic("Invalid work token (%llu): index out of bounds.", token);
267*699cd480SApple OSS Distributions 	}
268*699cd480SApple OSS Distributions 
269*699cd480SApple OSS Distributions 	workTable[token].started = started;
270*699cd480SApple OSS Distributions }
271*699cd480SApple OSS Distributions 
272*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
273*699cd480SApple OSS Distributions 
274*699cd480SApple OSS Distributions static struct thread_group *
threadGroupForDextService(IOService * device)275*699cd480SApple OSS Distributions threadGroupForDextService(IOService *device)
276*699cd480SApple OSS Distributions {
277*699cd480SApple OSS Distributions 	assert(device);
278*699cd480SApple OSS Distributions 
279*699cd480SApple OSS Distributions 	if (!device->hasUserServer()) {
280*699cd480SApple OSS Distributions 		return NULL;
281*699cd480SApple OSS Distributions 	}
282*699cd480SApple OSS Distributions 
283*699cd480SApple OSS Distributions 	// Devices associated with a dext driver, must be called from dext
284*699cd480SApple OSS Distributions 	// context to ensure that thread_group reference is valid.
285*699cd480SApple OSS Distributions 	thread_t thread = current_thread();
286*699cd480SApple OSS Distributions 	assert(get_threadtask(thread) != kernel_task);
287*699cd480SApple OSS Distributions 	struct thread_group * thread_group = thread_group_get(thread);
288*699cd480SApple OSS Distributions 	assert(thread_group != nullptr);
289*699cd480SApple OSS Distributions 	return thread_group;
290*699cd480SApple OSS Distributions }
291*699cd480SApple OSS Distributions 
292*699cd480SApple OSS Distributions #endif /* CONFIG_THREAD_GROUPS */
293*699cd480SApple OSS Distributions 
294*699cd480SApple OSS Distributions IOReturn
registerDevice(IOService * driver,IOService * device)295*699cd480SApple OSS Distributions IOPerfControlClient::registerDevice(IOService *driver, IOService *device)
296*699cd480SApple OSS Distributions {
297*699cd480SApple OSS Distributions 	IOReturn ret = kIOReturnSuccess;
298*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
299*699cd480SApple OSS Distributions 	IOLockLock(shared->interfaceLock);
300*699cd480SApple OSS Distributions 
301*699cd480SApple OSS Distributions 	clientData.device = device;
302*699cd480SApple OSS Distributions 
303*699cd480SApple OSS Distributions 	if (device) {
304*699cd480SApple OSS Distributions 		struct thread_group *dext_thread_group = threadGroupForDextService(device);
305*699cd480SApple OSS Distributions 		if (dext_thread_group) {
306*699cd480SApple OSS Distributions 			if (clientData.driverState.has_target_thread_group) {
307*699cd480SApple OSS Distributions 				panic("driverState has already been initialized");
308*699cd480SApple OSS Distributions 			}
309*699cd480SApple OSS Distributions 			clientData.driverState.has_target_thread_group = true;
310*699cd480SApple OSS Distributions 			clientData.driverState.target_thread_group_id = thread_group_get_id(dext_thread_group);
311*699cd480SApple OSS Distributions 			clientData.driverState.target_thread_group_data = thread_group_get_machine_data(dext_thread_group);
312*699cd480SApple OSS Distributions 
313*699cd480SApple OSS Distributions 			clientData.target_thread_group = dext_thread_group;
314*699cd480SApple OSS Distributions 			thread_group_retain(dext_thread_group);
315*699cd480SApple OSS Distributions 		}
316*699cd480SApple OSS Distributions 	}
317*699cd480SApple OSS Distributions 
318*699cd480SApple OSS Distributions 	if (shared->interface.version >= PERFCONTROL_INTERFACE_VERSION_3) {
319*699cd480SApple OSS Distributions 		ret = shared->interface.registerDriverDevice(driver, device, &clientData.driverState);
320*699cd480SApple OSS Distributions 	} else if (shared->interface.version >= PERFCONTROL_INTERFACE_VERSION_1) {
321*699cd480SApple OSS Distributions 		ret = shared->interface.registerDevice(device);
322*699cd480SApple OSS Distributions 	} else {
323*699cd480SApple OSS Distributions 		shared->deviceRegistrationList->setObject(this);
324*699cd480SApple OSS Distributions 	}
325*699cd480SApple OSS Distributions 
326*699cd480SApple OSS Distributions 	IOLockUnlock(shared->interfaceLock);
327*699cd480SApple OSS Distributions #endif
328*699cd480SApple OSS Distributions 	return ret;
329*699cd480SApple OSS Distributions }
330*699cd480SApple OSS Distributions 
331*699cd480SApple OSS Distributions void
unregisterDevice(IOService * driver,IOService * device)332*699cd480SApple OSS Distributions IOPerfControlClient::unregisterDevice(IOService *driver, IOService *device)
333*699cd480SApple OSS Distributions {
334*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
335*699cd480SApple OSS Distributions 	IOLockLock(shared->interfaceLock);
336*699cd480SApple OSS Distributions 
337*699cd480SApple OSS Distributions 	if (shared->interface.version >= PERFCONTROL_INTERFACE_VERSION_3) {
338*699cd480SApple OSS Distributions 		shared->interface.unregisterDriverDevice(driver, device, &clientData.driverState);
339*699cd480SApple OSS Distributions 	} else if (shared->interface.version >= PERFCONTROL_INTERFACE_VERSION_1) {
340*699cd480SApple OSS Distributions 		shared->interface.unregisterDevice(device);
341*699cd480SApple OSS Distributions 	} else {
342*699cd480SApple OSS Distributions 		shared->deviceRegistrationList->removeObject(this);
343*699cd480SApple OSS Distributions 	}
344*699cd480SApple OSS Distributions 
345*699cd480SApple OSS Distributions 	if (clientData.driverState.has_target_thread_group) {
346*699cd480SApple OSS Distributions 		thread_group_release(clientData.target_thread_group);
347*699cd480SApple OSS Distributions 		clientData.target_thread_group = nullptr;
348*699cd480SApple OSS Distributions 
349*699cd480SApple OSS Distributions 		clientData.driverState.has_target_thread_group = false;
350*699cd480SApple OSS Distributions 		clientData.driverState.target_thread_group_id = ~0ull;
351*699cd480SApple OSS Distributions 		clientData.driverState.target_thread_group_data = nullptr;
352*699cd480SApple OSS Distributions 	}
353*699cd480SApple OSS Distributions 
354*699cd480SApple OSS Distributions 	clientData.device = nullptr;
355*699cd480SApple OSS Distributions 
356*699cd480SApple OSS Distributions 	IOLockUnlock(shared->interfaceLock);
357*699cd480SApple OSS Distributions #endif
358*699cd480SApple OSS Distributions }
359*699cd480SApple OSS Distributions 
360*699cd480SApple OSS Distributions uint64_t
workSubmit(IOService * device,WorkSubmitArgs * args)361*699cd480SApple OSS Distributions IOPerfControlClient::workSubmit(IOService *device, WorkSubmitArgs *args)
362*699cd480SApple OSS Distributions {
363*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
364*699cd480SApple OSS Distributions 	auto *thread_group = thread_group_get(current_thread());
365*699cd480SApple OSS Distributions 	if (!thread_group) {
366*699cd480SApple OSS Distributions 		return kIOPerfControlClientWorkUntracked;
367*699cd480SApple OSS Distributions 	}
368*699cd480SApple OSS Distributions 
369*699cd480SApple OSS Distributions 	PerfControllerInterface::WorkState state{
370*699cd480SApple OSS Distributions 		.thread_group_id = thread_group_get_id(thread_group),
371*699cd480SApple OSS Distributions 		.thread_group_data = thread_group_get_machine_data(thread_group),
372*699cd480SApple OSS Distributions 		.work_data = nullptr,
373*699cd480SApple OSS Distributions 		.work_data_size = 0,
374*699cd480SApple OSS Distributions 		.started = false,
375*699cd480SApple OSS Distributions 		.driver_state = &clientData.driverState
376*699cd480SApple OSS Distributions 	};
377*699cd480SApple OSS Distributions 	if (!shared->interface.workCanSubmit(device, &state, args)) {
378*699cd480SApple OSS Distributions 		return kIOPerfControlClientWorkUntracked;
379*699cd480SApple OSS Distributions 	}
380*699cd480SApple OSS Distributions 
381*699cd480SApple OSS Distributions 	uint64_t token = allocateToken(thread_group);
382*699cd480SApple OSS Distributions 	if (token != kIOPerfControlClientWorkUntracked) {
383*699cd480SApple OSS Distributions 		state.work_data = &workTable[token].perfcontrol_data;
384*699cd480SApple OSS Distributions 		state.work_data_size = sizeof(workTable[token].perfcontrol_data);
385*699cd480SApple OSS Distributions 		shared->interface.workSubmit(device, tokenToGlobalUniqueToken(token), &state, args);
386*699cd480SApple OSS Distributions 	}
387*699cd480SApple OSS Distributions 	return token;
388*699cd480SApple OSS Distributions #else
389*699cd480SApple OSS Distributions 	return kIOPerfControlClientWorkUntracked;
390*699cd480SApple OSS Distributions #endif
391*699cd480SApple OSS Distributions }
392*699cd480SApple OSS Distributions 
393*699cd480SApple OSS Distributions uint64_t
workSubmitAndBegin(IOService * device,WorkSubmitArgs * submitArgs,WorkBeginArgs * beginArgs)394*699cd480SApple OSS Distributions IOPerfControlClient::workSubmitAndBegin(IOService *device, WorkSubmitArgs *submitArgs, WorkBeginArgs *beginArgs)
395*699cd480SApple OSS Distributions {
396*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
397*699cd480SApple OSS Distributions 	auto *thread_group = thread_group_get(current_thread());
398*699cd480SApple OSS Distributions 	if (!thread_group) {
399*699cd480SApple OSS Distributions 		return kIOPerfControlClientWorkUntracked;
400*699cd480SApple OSS Distributions 	}
401*699cd480SApple OSS Distributions 
402*699cd480SApple OSS Distributions 	PerfControllerInterface::WorkState state{
403*699cd480SApple OSS Distributions 		.thread_group_id = thread_group_get_id(thread_group),
404*699cd480SApple OSS Distributions 		.thread_group_data = thread_group_get_machine_data(thread_group),
405*699cd480SApple OSS Distributions 		.work_data = nullptr,
406*699cd480SApple OSS Distributions 		.work_data_size = 0,
407*699cd480SApple OSS Distributions 		.started = false,
408*699cd480SApple OSS Distributions 		.driver_state = &clientData.driverState
409*699cd480SApple OSS Distributions 	};
410*699cd480SApple OSS Distributions 	if (!shared->interface.workCanSubmit(device, &state, submitArgs)) {
411*699cd480SApple OSS Distributions 		return kIOPerfControlClientWorkUntracked;
412*699cd480SApple OSS Distributions 	}
413*699cd480SApple OSS Distributions 
414*699cd480SApple OSS Distributions 	uint64_t token = allocateToken(thread_group);
415*699cd480SApple OSS Distributions 	if (token != kIOPerfControlClientWorkUntracked) {
416*699cd480SApple OSS Distributions 		auto &entry = workTable[token];
417*699cd480SApple OSS Distributions 		state.work_data = &entry.perfcontrol_data;
418*699cd480SApple OSS Distributions 		state.work_data_size = sizeof(workTable[token].perfcontrol_data);
419*699cd480SApple OSS Distributions 		shared->interface.workSubmit(device, tokenToGlobalUniqueToken(token), &state, submitArgs);
420*699cd480SApple OSS Distributions 		state.started = true;
421*699cd480SApple OSS Distributions 		shared->interface.workBegin(device, tokenToGlobalUniqueToken(token), &state, beginArgs);
422*699cd480SApple OSS Distributions 		markEntryStarted(token, true);
423*699cd480SApple OSS Distributions 	}
424*699cd480SApple OSS Distributions 	return token;
425*699cd480SApple OSS Distributions #else
426*699cd480SApple OSS Distributions 	return kIOPerfControlClientWorkUntracked;
427*699cd480SApple OSS Distributions #endif
428*699cd480SApple OSS Distributions }
429*699cd480SApple OSS Distributions 
430*699cd480SApple OSS Distributions void
workBegin(IOService * device,uint64_t token,WorkBeginArgs * args)431*699cd480SApple OSS Distributions IOPerfControlClient::workBegin(IOService *device, uint64_t token, WorkBeginArgs *args)
432*699cd480SApple OSS Distributions {
433*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
434*699cd480SApple OSS Distributions 	WorkTableEntry *entry = getEntryForToken(token);
435*699cd480SApple OSS Distributions 	if (entry == nullptr) {
436*699cd480SApple OSS Distributions 		return;
437*699cd480SApple OSS Distributions 	}
438*699cd480SApple OSS Distributions 
439*699cd480SApple OSS Distributions 	assertf(!entry->started, "Work for token %llu was already started", token);
440*699cd480SApple OSS Distributions 
441*699cd480SApple OSS Distributions 	PerfControllerInterface::WorkState state{
442*699cd480SApple OSS Distributions 		.thread_group_id = thread_group_get_id(entry->thread_group),
443*699cd480SApple OSS Distributions 		.thread_group_data = thread_group_get_machine_data(entry->thread_group),
444*699cd480SApple OSS Distributions 		.work_data = &entry->perfcontrol_data,
445*699cd480SApple OSS Distributions 		.work_data_size = sizeof(entry->perfcontrol_data),
446*699cd480SApple OSS Distributions 		.started = true,
447*699cd480SApple OSS Distributions 		.driver_state = &clientData.driverState
448*699cd480SApple OSS Distributions 	};
449*699cd480SApple OSS Distributions 	shared->interface.workBegin(device, tokenToGlobalUniqueToken(token), &state, args);
450*699cd480SApple OSS Distributions 	markEntryStarted(token, true);
451*699cd480SApple OSS Distributions #endif
452*699cd480SApple OSS Distributions }
453*699cd480SApple OSS Distributions 
454*699cd480SApple OSS Distributions void
workEnd(IOService * device,uint64_t token,WorkEndArgs * args,bool done)455*699cd480SApple OSS Distributions IOPerfControlClient::workEnd(IOService *device, uint64_t token, WorkEndArgs *args, bool done)
456*699cd480SApple OSS Distributions {
457*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
458*699cd480SApple OSS Distributions 	WorkTableEntry *entry = getEntryForToken(token);
459*699cd480SApple OSS Distributions 	if (entry == nullptr) {
460*699cd480SApple OSS Distributions 		return;
461*699cd480SApple OSS Distributions 	}
462*699cd480SApple OSS Distributions 
463*699cd480SApple OSS Distributions 	PerfControllerInterface::WorkState state{
464*699cd480SApple OSS Distributions 		.thread_group_id = thread_group_get_id(entry->thread_group),
465*699cd480SApple OSS Distributions 		.thread_group_data = thread_group_get_machine_data(entry->thread_group),
466*699cd480SApple OSS Distributions 		.work_data = &entry->perfcontrol_data,
467*699cd480SApple OSS Distributions 		.work_data_size = sizeof(entry->perfcontrol_data),
468*699cd480SApple OSS Distributions 		.started = entry->started,
469*699cd480SApple OSS Distributions 		.driver_state = &clientData.driverState
470*699cd480SApple OSS Distributions 	};
471*699cd480SApple OSS Distributions 	shared->interface.workEnd(device, tokenToGlobalUniqueToken(token), &state, args, done);
472*699cd480SApple OSS Distributions 
473*699cd480SApple OSS Distributions 	if (done) {
474*699cd480SApple OSS Distributions 		deallocateToken(token);
475*699cd480SApple OSS Distributions 	} else {
476*699cd480SApple OSS Distributions 		markEntryStarted(token, false);
477*699cd480SApple OSS Distributions 	}
478*699cd480SApple OSS Distributions #endif
479*699cd480SApple OSS Distributions }
480*699cd480SApple OSS Distributions 
481*699cd480SApple OSS Distributions static _Atomic uint64_t unique_work_context_id = 1ull;
482*699cd480SApple OSS Distributions 
483*699cd480SApple OSS Distributions class IOPerfControlWorkContext : public OSObject
484*699cd480SApple OSS Distributions {
485*699cd480SApple OSS Distributions 	OSDeclareDefaultStructors(IOPerfControlWorkContext);
486*699cd480SApple OSS Distributions 
487*699cd480SApple OSS Distributions public:
488*699cd480SApple OSS Distributions 	uint64_t id;
489*699cd480SApple OSS Distributions 	struct thread_group *thread_group;
490*699cd480SApple OSS Distributions 	bool started;
491*699cd480SApple OSS Distributions 	uint8_t perfcontrol_data[32];
492*699cd480SApple OSS Distributions 
493*699cd480SApple OSS Distributions 	bool init() override;
494*699cd480SApple OSS Distributions 	void reset();
495*699cd480SApple OSS Distributions 	void free() override;
496*699cd480SApple OSS Distributions };
497*699cd480SApple OSS Distributions 
498*699cd480SApple OSS Distributions OSDefineMetaClassAndStructors(IOPerfControlWorkContext, OSObject);
499*699cd480SApple OSS Distributions 
500*699cd480SApple OSS Distributions bool
init()501*699cd480SApple OSS Distributions IOPerfControlWorkContext::init()
502*699cd480SApple OSS Distributions {
503*699cd480SApple OSS Distributions 	if (!super::init()) {
504*699cd480SApple OSS Distributions 		return false;
505*699cd480SApple OSS Distributions 	}
506*699cd480SApple OSS Distributions 	id = atomic_fetch_add_explicit(&unique_work_context_id, 1, memory_order_relaxed) + 1;
507*699cd480SApple OSS Distributions 	reset();
508*699cd480SApple OSS Distributions 	return true;
509*699cd480SApple OSS Distributions }
510*699cd480SApple OSS Distributions 
511*699cd480SApple OSS Distributions void
reset()512*699cd480SApple OSS Distributions IOPerfControlWorkContext::reset()
513*699cd480SApple OSS Distributions {
514*699cd480SApple OSS Distributions 	thread_group = nullptr;
515*699cd480SApple OSS Distributions 	started = false;
516*699cd480SApple OSS Distributions 	bzero(perfcontrol_data, sizeof(perfcontrol_data));
517*699cd480SApple OSS Distributions }
518*699cd480SApple OSS Distributions 
519*699cd480SApple OSS Distributions void
free()520*699cd480SApple OSS Distributions IOPerfControlWorkContext::free()
521*699cd480SApple OSS Distributions {
522*699cd480SApple OSS Distributions 	assertf(thread_group == nullptr, "IOPerfControlWorkContext ID %llu being released without calling workEnd!\n", id);
523*699cd480SApple OSS Distributions 	super::free();
524*699cd480SApple OSS Distributions }
525*699cd480SApple OSS Distributions 
526*699cd480SApple OSS Distributions OSObject *
copyWorkContext()527*699cd480SApple OSS Distributions IOPerfControlClient::copyWorkContext()
528*699cd480SApple OSS Distributions {
529*699cd480SApple OSS Distributions 	IOPerfControlWorkContext *context = new IOPerfControlWorkContext;
530*699cd480SApple OSS Distributions 
531*699cd480SApple OSS Distributions 	if (context == nullptr) {
532*699cd480SApple OSS Distributions 		return nullptr;
533*699cd480SApple OSS Distributions 	}
534*699cd480SApple OSS Distributions 
535*699cd480SApple OSS Distributions 	if (!context->init()) {
536*699cd480SApple OSS Distributions 		context->free();
537*699cd480SApple OSS Distributions 		return nullptr;
538*699cd480SApple OSS Distributions 	}
539*699cd480SApple OSS Distributions 
540*699cd480SApple OSS Distributions 	return context;
541*699cd480SApple OSS Distributions }
542*699cd480SApple OSS Distributions 
543*699cd480SApple OSS Distributions bool
workSubmitAndBeginWithContext(IOService * device,OSObject * context,WorkSubmitArgs * submitArgs,WorkBeginArgs * beginArgs)544*699cd480SApple OSS Distributions IOPerfControlClient::workSubmitAndBeginWithContext(IOService *device, OSObject *context, WorkSubmitArgs *submitArgs, WorkBeginArgs *beginArgs)
545*699cd480SApple OSS Distributions {
546*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
547*699cd480SApple OSS Distributions 
548*699cd480SApple OSS Distributions 	if (workSubmitWithContext(device, context, submitArgs) == false) {
549*699cd480SApple OSS Distributions 		return false;
550*699cd480SApple OSS Distributions 	}
551*699cd480SApple OSS Distributions 
552*699cd480SApple OSS Distributions 	IOPerfControlWorkContext *work_context = OSDynamicCast(IOPerfControlWorkContext, context);
553*699cd480SApple OSS Distributions 
554*699cd480SApple OSS Distributions 	PerfControllerInterface::WorkState state{
555*699cd480SApple OSS Distributions 		.thread_group_id = thread_group_get_id(work_context->thread_group),
556*699cd480SApple OSS Distributions 		.thread_group_data = thread_group_get_machine_data(work_context->thread_group),
557*699cd480SApple OSS Distributions 		.work_data = &work_context->perfcontrol_data,
558*699cd480SApple OSS Distributions 		.work_data_size = sizeof(work_context->perfcontrol_data),
559*699cd480SApple OSS Distributions 		.started = true,
560*699cd480SApple OSS Distributions 		.driver_state = &clientData.driverState
561*699cd480SApple OSS Distributions 	};
562*699cd480SApple OSS Distributions 
563*699cd480SApple OSS Distributions 	shared->interface.workBegin(device, work_context->id, &state, beginArgs);
564*699cd480SApple OSS Distributions 
565*699cd480SApple OSS Distributions 	work_context->started = true;
566*699cd480SApple OSS Distributions 
567*699cd480SApple OSS Distributions 	return true;
568*699cd480SApple OSS Distributions #else
569*699cd480SApple OSS Distributions 	return false;
570*699cd480SApple OSS Distributions #endif
571*699cd480SApple OSS Distributions }
572*699cd480SApple OSS Distributions 
573*699cd480SApple OSS Distributions bool
workSubmitWithContext(IOService * device,OSObject * context,WorkSubmitArgs * args)574*699cd480SApple OSS Distributions IOPerfControlClient::workSubmitWithContext(IOService *device, OSObject *context, WorkSubmitArgs *args)
575*699cd480SApple OSS Distributions {
576*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
577*699cd480SApple OSS Distributions 	IOPerfControlWorkContext *work_context = OSDynamicCast(IOPerfControlWorkContext, context);
578*699cd480SApple OSS Distributions 
579*699cd480SApple OSS Distributions 	if (work_context == nullptr) {
580*699cd480SApple OSS Distributions 		return false;
581*699cd480SApple OSS Distributions 	}
582*699cd480SApple OSS Distributions 
583*699cd480SApple OSS Distributions 	auto *thread_group = thread_group_get(current_thread());
584*699cd480SApple OSS Distributions 	assert(thread_group != nullptr);
585*699cd480SApple OSS Distributions 
586*699cd480SApple OSS Distributions 	assertf(!work_context->started, "IOPerfControlWorkContext ID %llu was already started", work_context->id);
587*699cd480SApple OSS Distributions 	assertf(work_context->thread_group == nullptr, "IOPerfControlWorkContext ID %llu has already taken a refcount on TG 0x%p \n", work_context->id, (void *)(work_context->thread_group));
588*699cd480SApple OSS Distributions 
589*699cd480SApple OSS Distributions 	PerfControllerInterface::WorkState state{
590*699cd480SApple OSS Distributions 		.thread_group_id = thread_group_get_id(thread_group),
591*699cd480SApple OSS Distributions 		.thread_group_data = thread_group_get_machine_data(thread_group),
592*699cd480SApple OSS Distributions 		.work_data = nullptr,
593*699cd480SApple OSS Distributions 		.work_data_size = 0,
594*699cd480SApple OSS Distributions 		.started = false,
595*699cd480SApple OSS Distributions 		.driver_state = &clientData.driverState
596*699cd480SApple OSS Distributions 	};
597*699cd480SApple OSS Distributions 	if (!shared->interface.workCanSubmit(device, &state, args)) {
598*699cd480SApple OSS Distributions 		return false;
599*699cd480SApple OSS Distributions 	}
600*699cd480SApple OSS Distributions 
601*699cd480SApple OSS Distributions 	work_context->thread_group = thread_group_retain(thread_group);
602*699cd480SApple OSS Distributions 
603*699cd480SApple OSS Distributions 	state.work_data = &work_context->perfcontrol_data;
604*699cd480SApple OSS Distributions 	state.work_data_size = sizeof(work_context->perfcontrol_data);
605*699cd480SApple OSS Distributions 
606*699cd480SApple OSS Distributions 	shared->interface.workSubmit(device, work_context->id, &state, args);
607*699cd480SApple OSS Distributions 
608*699cd480SApple OSS Distributions 	return true;
609*699cd480SApple OSS Distributions #else
610*699cd480SApple OSS Distributions 	return false;
611*699cd480SApple OSS Distributions #endif
612*699cd480SApple OSS Distributions }
613*699cd480SApple OSS Distributions 
614*699cd480SApple OSS Distributions void
workUpdateWithContext(IOService * device,OSObject * context,WorkUpdateArgs * args)615*699cd480SApple OSS Distributions IOPerfControlClient::workUpdateWithContext(IOService *device, OSObject *context, WorkUpdateArgs *args)
616*699cd480SApple OSS Distributions {
617*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
618*699cd480SApple OSS Distributions 	IOPerfControlWorkContext *work_context = OSDynamicCast(IOPerfControlWorkContext, context);
619*699cd480SApple OSS Distributions 
620*699cd480SApple OSS Distributions 	if (work_context == nullptr) {
621*699cd480SApple OSS Distributions 		return;
622*699cd480SApple OSS Distributions 	}
623*699cd480SApple OSS Distributions 
624*699cd480SApple OSS Distributions 	if (work_context->thread_group == nullptr) {
625*699cd480SApple OSS Distributions 		// This Work Context has not taken a refcount on a TG
626*699cd480SApple OSS Distributions 		return;
627*699cd480SApple OSS Distributions 	}
628*699cd480SApple OSS Distributions 
629*699cd480SApple OSS Distributions 	PerfControllerInterface::WorkState state{
630*699cd480SApple OSS Distributions 		.thread_group_id = thread_group_get_id(work_context->thread_group),
631*699cd480SApple OSS Distributions 		.thread_group_data = thread_group_get_machine_data(work_context->thread_group),
632*699cd480SApple OSS Distributions 		.work_data = &work_context->perfcontrol_data,
633*699cd480SApple OSS Distributions 		.work_data_size = sizeof(work_context->perfcontrol_data),
634*699cd480SApple OSS Distributions 		.driver_state = &clientData.driverState
635*699cd480SApple OSS Distributions 	};
636*699cd480SApple OSS Distributions 	shared->interface.workUpdate(device, work_context->id, &state, args);
637*699cd480SApple OSS Distributions #endif
638*699cd480SApple OSS Distributions }
639*699cd480SApple OSS Distributions 
640*699cd480SApple OSS Distributions void
workBeginWithContext(IOService * device,OSObject * context,WorkBeginArgs * args)641*699cd480SApple OSS Distributions IOPerfControlClient::workBeginWithContext(IOService *device, OSObject *context, WorkBeginArgs *args)
642*699cd480SApple OSS Distributions {
643*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
644*699cd480SApple OSS Distributions 	IOPerfControlWorkContext *work_context = OSDynamicCast(IOPerfControlWorkContext, context);
645*699cd480SApple OSS Distributions 
646*699cd480SApple OSS Distributions 	if (work_context == nullptr) {
647*699cd480SApple OSS Distributions 		return;
648*699cd480SApple OSS Distributions 	}
649*699cd480SApple OSS Distributions 
650*699cd480SApple OSS Distributions 	if (work_context->thread_group == nullptr) {
651*699cd480SApple OSS Distributions 		// This Work Context has not taken a refcount on a TG
652*699cd480SApple OSS Distributions 		return;
653*699cd480SApple OSS Distributions 	}
654*699cd480SApple OSS Distributions 
655*699cd480SApple OSS Distributions 	assertf(!work_context->started, "IOPerfControlWorkContext %llu was already started", work_context->id);
656*699cd480SApple OSS Distributions 
657*699cd480SApple OSS Distributions 	PerfControllerInterface::WorkState state{
658*699cd480SApple OSS Distributions 		.thread_group_id = thread_group_get_id(work_context->thread_group),
659*699cd480SApple OSS Distributions 		.thread_group_data = thread_group_get_machine_data(work_context->thread_group),
660*699cd480SApple OSS Distributions 		.work_data = &work_context->perfcontrol_data,
661*699cd480SApple OSS Distributions 		.work_data_size = sizeof(work_context->perfcontrol_data),
662*699cd480SApple OSS Distributions 		.started = true,
663*699cd480SApple OSS Distributions 		.driver_state = &clientData.driverState
664*699cd480SApple OSS Distributions 	};
665*699cd480SApple OSS Distributions 	shared->interface.workBegin(device, work_context->id, &state, args);
666*699cd480SApple OSS Distributions 
667*699cd480SApple OSS Distributions 	work_context->started = true;
668*699cd480SApple OSS Distributions #endif
669*699cd480SApple OSS Distributions }
670*699cd480SApple OSS Distributions 
671*699cd480SApple OSS Distributions void
workEndWithContext(IOService * device,OSObject * context,WorkEndArgs * args,bool done)672*699cd480SApple OSS Distributions IOPerfControlClient::workEndWithContext(IOService *device, OSObject *context, WorkEndArgs *args, bool done)
673*699cd480SApple OSS Distributions {
674*699cd480SApple OSS Distributions #if CONFIG_THREAD_GROUPS
675*699cd480SApple OSS Distributions 	IOPerfControlWorkContext *work_context = OSDynamicCast(IOPerfControlWorkContext, context);
676*699cd480SApple OSS Distributions 
677*699cd480SApple OSS Distributions 	if (work_context == nullptr) {
678*699cd480SApple OSS Distributions 		return;
679*699cd480SApple OSS Distributions 	}
680*699cd480SApple OSS Distributions 
681*699cd480SApple OSS Distributions 	if (work_context->thread_group == nullptr) {
682*699cd480SApple OSS Distributions 		return;
683*699cd480SApple OSS Distributions 	}
684*699cd480SApple OSS Distributions 
685*699cd480SApple OSS Distributions 	PerfControllerInterface::WorkState state{
686*699cd480SApple OSS Distributions 		.thread_group_id = thread_group_get_id(work_context->thread_group),
687*699cd480SApple OSS Distributions 		.thread_group_data = thread_group_get_machine_data(work_context->thread_group),
688*699cd480SApple OSS Distributions 		.work_data = &work_context->perfcontrol_data,
689*699cd480SApple OSS Distributions 		.work_data_size = sizeof(work_context->perfcontrol_data),
690*699cd480SApple OSS Distributions 		.started = work_context->started,
691*699cd480SApple OSS Distributions 		.driver_state = &clientData.driverState
692*699cd480SApple OSS Distributions 	};
693*699cd480SApple OSS Distributions 
694*699cd480SApple OSS Distributions 	shared->interface.workEnd(device, work_context->id, &state, args, done);
695*699cd480SApple OSS Distributions 
696*699cd480SApple OSS Distributions 	if (done) {
697*699cd480SApple OSS Distributions 		thread_group_release(work_context->thread_group);
698*699cd480SApple OSS Distributions 		work_context->reset();
699*699cd480SApple OSS Distributions 	} else {
700*699cd480SApple OSS Distributions 		work_context->started = false;
701*699cd480SApple OSS Distributions 	}
702*699cd480SApple OSS Distributions 
703*699cd480SApple OSS Distributions 	return;
704*699cd480SApple OSS Distributions #else
705*699cd480SApple OSS Distributions 	return;
706*699cd480SApple OSS Distributions #endif
707*699cd480SApple OSS Distributions }
708*699cd480SApple OSS Distributions 
709*699cd480SApple OSS Distributions IOReturn
registerPerformanceController(PerfControllerInterface * pci)710*699cd480SApple OSS Distributions IOPerfControlClient::registerPerformanceController(PerfControllerInterface *pci)
711*699cd480SApple OSS Distributions {
712*699cd480SApple OSS Distributions 	IOReturn result = kIOReturnError;
713*699cd480SApple OSS Distributions 
714*699cd480SApple OSS Distributions 	IOLockLock(shared->interfaceLock);
715*699cd480SApple OSS Distributions 
716*699cd480SApple OSS Distributions 	if (shared->interface.version == PERFCONTROL_INTERFACE_VERSION_NONE) {
717*699cd480SApple OSS Distributions 		shared->interface.version = pci->version;
718*699cd480SApple OSS Distributions 
719*699cd480SApple OSS Distributions 		if (pci->version >= PERFCONTROL_INTERFACE_VERSION_1) {
720*699cd480SApple OSS Distributions 			assert(pci->registerDevice && pci->unregisterDevice && pci->workCanSubmit && pci->workSubmit && pci->workBegin && pci->workEnd);
721*699cd480SApple OSS Distributions 			shared->interface.registerDevice = pci->registerDevice;
722*699cd480SApple OSS Distributions 			shared->interface.unregisterDevice = pci->unregisterDevice;
723*699cd480SApple OSS Distributions 			shared->interface.workCanSubmit = pci->workCanSubmit;
724*699cd480SApple OSS Distributions 			shared->interface.workSubmit = pci->workSubmit;
725*699cd480SApple OSS Distributions 			shared->interface.workBegin = pci->workBegin;
726*699cd480SApple OSS Distributions 			shared->interface.workEnd = pci->workEnd;
727*699cd480SApple OSS Distributions 		}
728*699cd480SApple OSS Distributions 
729*699cd480SApple OSS Distributions 		if (pci->version >= PERFCONTROL_INTERFACE_VERSION_2) {
730*699cd480SApple OSS Distributions 			if (pci->workUpdate != nullptr) {
731*699cd480SApple OSS Distributions 				shared->interface.workUpdate = pci->workUpdate;
732*699cd480SApple OSS Distributions 			}
733*699cd480SApple OSS Distributions 		}
734*699cd480SApple OSS Distributions 
735*699cd480SApple OSS Distributions 		if (pci->version >= PERFCONTROL_INTERFACE_VERSION_3) {
736*699cd480SApple OSS Distributions 			assert(pci->registerDriverDevice && pci->unregisterDriverDevice);
737*699cd480SApple OSS Distributions 			shared->interface.registerDriverDevice = pci->registerDriverDevice;
738*699cd480SApple OSS Distributions 			shared->interface.unregisterDriverDevice = pci->unregisterDriverDevice;
739*699cd480SApple OSS Distributions 		}
740*699cd480SApple OSS Distributions 
741*699cd480SApple OSS Distributions 		result = kIOReturnSuccess;
742*699cd480SApple OSS Distributions 
743*699cd480SApple OSS Distributions 		OSObject *obj;
744*699cd480SApple OSS Distributions 		while ((obj = shared->deviceRegistrationList->getAnyObject())) {
745*699cd480SApple OSS Distributions 			IOPerfControlClient *client = OSDynamicCast(IOPerfControlClient, obj);
746*699cd480SApple OSS Distributions 			IOPerfControlClientData *clientData = client->getClientData();
747*699cd480SApple OSS Distributions 			if (clientData && clientData->device) {
748*699cd480SApple OSS Distributions 				if (pci->version >= PERFCONTROL_INTERFACE_VERSION_3) {
749*699cd480SApple OSS Distributions 					pci->registerDriverDevice(clientData->device->getProvider(), clientData->device, &(clientData->driverState));
750*699cd480SApple OSS Distributions 				} else if (pci->version >= PERFCONTROL_INTERFACE_VERSION_1) {
751*699cd480SApple OSS Distributions 					pci->registerDevice(clientData->device);
752*699cd480SApple OSS Distributions 				}
753*699cd480SApple OSS Distributions 			}
754*699cd480SApple OSS Distributions 			shared->deviceRegistrationList->removeObject(obj);
755*699cd480SApple OSS Distributions 		}
756*699cd480SApple OSS Distributions 	}
757*699cd480SApple OSS Distributions 
758*699cd480SApple OSS Distributions 	IOLockUnlock(shared->interfaceLock);
759*699cd480SApple OSS Distributions 
760*699cd480SApple OSS Distributions 	return result;
761*699cd480SApple OSS Distributions }
762