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