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