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