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