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