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