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