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