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