/*
- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2000, 2009-2010 Apple Inc. All rights reserved.
*
- * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
- * This file contains Original Code and/or Modifications of Original Code
- * as defined in and that are subject to the Apple Public Source License
- * Version 2.0 (the 'License'). You may not use this file except in
- * compliance with the License. The rights granted to you under the
- * License may not be used to create, or enable the creation or
- * redistribution of, unlawful or unlicensed copies of an Apple operating
- * system, or to circumvent, violate, or enable the circumvention or
- * violation of, any terms of an Apple operating system software license
- * agreement.
- *
- * Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
- *
- * The Original Code and all software distributed under the License are
- * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
- * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
- * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
- * Please see the License for the specific language governing rights and
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
* limitations under the License.
- *
- * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
#include <libkern/OSDebug.h>
#include <IOKit/IOWorkLoop.h>
#include <IOKit/IOReturn.h>
#include <IOKit/IOTimeStamp.h>
+#include <IOKit/IOKitDebug.h>
#define super IOEventSource
OSDefineMetaClassAndStructors(IOCommandGate, IOEventSource)
+#if __LP64__
OSMetaClassDefineReservedUnused(IOCommandGate, 0);
+#else
+OSMetaClassDefineReservedUsed(IOCommandGate, 0);
+#endif
OSMetaClassDefineReservedUnused(IOCommandGate, 1);
OSMetaClassDefineReservedUnused(IOCommandGate, 2);
OSMetaClassDefineReservedUnused(IOCommandGate, 3);
OSMetaClassDefineReservedUnused(IOCommandGate, 6);
OSMetaClassDefineReservedUnused(IOCommandGate, 7);
-bool IOCommandGate::checkForWork() { return false; }
+#if IOKITSTATS
+
+#define IOStatisticsInitializeCounter() \
+do { \
+ IOStatistics::setCounterType(IOEventSource::reserved->counter, kIOStatisticsCommandGateCounter); \
+} while (0)
+
+#define IOStatisticsActionCall() \
+do { \
+ IOStatistics::countCommandGateActionCall(IOEventSource::reserved->counter); \
+} while (0)
+
+#else
+
+#define IOStatisticsInitializeCounter()
+#define IOStatisticsActionCall()
+
+#endif /* IOKITSTATS */
bool IOCommandGate::init(OSObject *inOwner, Action inAction)
{
- return super::init(inOwner, (IOEventSource::Action) inAction);
+ bool res = super::init(inOwner, (IOEventSource::Action) inAction);
+ if (res) {
+ IOStatisticsInitializeCounter();
+ }
+
+ return res;
}
IOCommandGate *
/* virtual */ void IOCommandGate::free()
{
- setWorkLoop(0);
+ if (workLoop) setWorkLoop(0);
super::free();
}
+enum
+{
+ kSleepersRemoved = 0x00000001,
+ kSleepersWaitEnabled = 0x00000002,
+ kSleepersActions = 0x00000100,
+ kSleepersActionsMask = 0xffffff00,
+};
+
/* virtual */ void IOCommandGate::setWorkLoop(IOWorkLoop *inWorkLoop)
{
- uintptr_t *sleepersP = (uintptr_t *) &reserved;
- if (!inWorkLoop && workLoop) { // tearing down
- closeGate();
- *sleepersP |= 1;
- while (*sleepersP >> 1) {
+ IOWorkLoop * wl;
+ uintptr_t * sleepersP = (uintptr_t *) &reserved;
+ bool defer;
+
+ if (!inWorkLoop && (wl = workLoop)) { // tearing down
+ wl->closeGate();
+ *sleepersP |= kSleepersRemoved;
+ while (*sleepersP & kSleepersWaitEnabled) {
thread_wakeup_with_result(&enabled, THREAD_INTERRUPTED);
sleepGate(sleepersP, THREAD_UNINT);
}
- *sleepersP = 0;
- openGate();
+ *sleepersP &= ~kSleepersWaitEnabled;
+ defer = (0 != (kSleepersActionsMask & *sleepersP));
+ if (!defer)
+ {
+ super::setWorkLoop(0);
+ *sleepersP &= ~kSleepersRemoved;
+ }
+ wl->openGate();
+ return;
}
- else
super::setWorkLoop(inWorkLoop);
}
void *arg0, void *arg1,
void *arg2, void *arg3)
{
+ IOWorkLoop * wl;
+ uintptr_t * sleepersP;
+
if (!inAction)
return kIOReturnBadArgument;
-
- IOTimeStampConstant(IODBG_CMDQ(IOCMDQ_ACTION),
- (unsigned int) inAction, (unsigned int) owner);
+ if (!(wl = workLoop))
+ return kIOReturnNotReady;
// closeGate is recursive needn't worry if we already hold the lock.
- closeGate();
+ wl->closeGate();
+ sleepersP = (uintptr_t *) &reserved;
// If the command gate is disabled and we aren't on the workloop thread
// itself then sleep until we get enabled.
IOReturn res;
- if (!workLoop->onThread()) {
- while (!enabled) {
- uintptr_t *sleepersP = (uintptr_t *) &reserved;
-
- *sleepersP += 2;
- IOReturn res = sleepGate(&enabled, THREAD_ABORTSAFE);
- *sleepersP -= 2;
-
- bool wakeupTearDown = (*sleepersP & 1);
- if (res || wakeupTearDown) {
- openGate();
+ if (!wl->onThread())
+ {
+ while (!enabled)
+ {
+ IOReturn sleepResult = kIOReturnSuccess;
+ if (workLoop)
+ {
+ *sleepersP |= kSleepersWaitEnabled;
+ sleepResult = wl->sleepGate(&enabled, THREAD_INTERRUPTIBLE);
+ *sleepersP &= ~kSleepersWaitEnabled;
+ }
+ bool wakeupTearDown = (!workLoop || (0 != (*sleepersP & kSleepersRemoved)));
+ if ((kIOReturnSuccess != sleepResult) || wakeupTearDown) {
+ wl->openGate();
if (wakeupTearDown)
- commandWakeup(sleepersP); // No further resources used
+ wl->wakeupGate(sleepersP, false); // No further resources used
return kIOReturnAborted;
}
}
}
+ bool trace = ( gIOKitTrace & kIOTraceCommandGates ) ? true : false;
+
+ if (trace) IOTimeStampStartConstant(IODBG_CMDQ(IOCMDQ_ACTION),
+ VM_KERNEL_UNSLIDE(inAction), (uintptr_t) owner);
+
+ IOStatisticsActionCall();
+
// Must be gated and on the work loop or enabled
+
+ *sleepersP += kSleepersActions;
res = (*inAction)(owner, arg0, arg1, arg2, arg3);
- openGate();
+ *sleepersP -= kSleepersActions;
+
+ if (trace) IOTimeStampEndConstant(IODBG_CMDQ(IOCMDQ_ACTION),
+ VM_KERNEL_UNSLIDE(inAction), (uintptr_t) owner);
+ if (kSleepersRemoved == ((kSleepersActionsMask|kSleepersRemoved) & *sleepersP))
+ {
+ // no actions outstanding
+ *sleepersP &= ~kSleepersRemoved;
+ super::setWorkLoop(0);
+ }
+
+ wl->openGate();
+
return res;
}
void *arg2, void *arg3)
{
IOReturn res;
+ IOWorkLoop * wl;
if (!inAction)
return kIOReturnBadArgument;
+ if (!(wl = workLoop))
+ return kIOReturnNotReady;
// Try to close the gate if can't get return immediately.
- if (!tryCloseGate())
+ if (!wl->tryCloseGate())
return kIOReturnCannotLock;
// If the command gate is disabled then sleep until we get a wakeup
- if (!workLoop->onThread() && !enabled)
+ if (!wl->onThread() && !enabled)
res = kIOReturnNotPermitted;
else {
- IOTimeStampConstant(IODBG_CMDQ(IOCMDQ_ACTION),
- (unsigned int) inAction, (unsigned int) owner);
-
- res = (*inAction)(owner, arg0, arg1, arg2, arg3);
+
+ bool trace = ( gIOKitTrace & kIOTraceCommandGates ) ? true : false;
+
+ if (trace)
+ IOTimeStampStartConstant(IODBG_CMDQ(IOCMDQ_ACTION),
+ VM_KERNEL_UNSLIDE(inAction), (uintptr_t) owner);
+
+ IOStatisticsActionCall();
+
+ res = (*inAction)(owner, arg0, arg1, arg2, arg3);
+
+ if (trace)
+ IOTimeStampEndConstant(IODBG_CMDQ(IOCMDQ_ACTION),
+ VM_KERNEL_UNSLIDE(inAction), (uintptr_t) owner);
}
- openGate();
+ wl->openGate();
return res;
}
return sleepGate(event, interruptible);
}
+IOReturn IOCommandGate::commandSleep(void *event, AbsoluteTime deadline, UInt32 interruptible)
+{
+ if (!workLoop->inGate())
+ return kIOReturnNotPermitted;
+
+ return sleepGate(event, deadline, interruptible);
+}
+
void IOCommandGate::commandWakeup(void *event, bool oneThread)
{
wakeupGate(event, oneThread);
projects / apple / xnu.git / blobdiff