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