xnu-4570.20.62.tar.gz

[apple/xnu.git] / iokit / Kernel / IOTimerEventSource.cpp

diff --git a/iokit/Kernel/IOTimerEventSource.cpp b/iokit/Kernel/IOTimerEventSource.cpp
index fc6f7d0918df73921961d25027a266789cfacf3a..bb7acea43efec84572baca882b1cab561810fe2b 100644 (file)
--- a/iokit/Kernel/IOTimerEventSource.cpp
+++ b/iokit/Kernel/IOTimerEventSource.cpp
@@ -1,34 +1,29 @@
 /*
 /*

- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2000, 2009-2010 Apple Inc. All rights reserved.

  *
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * 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.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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_HEADER_END@
- */
-/*
- * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved. 
- *
- * IOTimerEventSource.cpp
- *
- * HISTORY
- * 2-Feb-1999          Joe Liu (jliu) created.
- * 1999-10-14          Godfrey van der Linden(gvdl)
- *             Revamped to use thread_call APIs
- *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 
 #include <sys/cdefs.h>
  */
 
 #include <sys/cdefs.h>


@@ -45,44 +40,234 @@ __END_DECLS
 #include <IOKit/IOWorkLoop.h>
 
 #include <IOKit/IOTimeStamp.h>
 #include <IOKit/IOWorkLoop.h>
 
 #include <IOKit/IOTimeStamp.h>

+#include <IOKit/IOKitDebug.h>
+#if CONFIG_DTRACE
+#include <mach/sdt.h>
+#endif

 
 #define super IOEventSource
 OSDefineMetaClassAndStructors(IOTimerEventSource, IOEventSource)
 
 #define super IOEventSource
 OSDefineMetaClassAndStructors(IOTimerEventSource, IOEventSource)

-OSMetaClassDefineReservedUnused(IOTimerEventSource, 0);
-OSMetaClassDefineReservedUnused(IOTimerEventSource, 1);
-OSMetaClassDefineReservedUnused(IOTimerEventSource, 2);
+OSMetaClassDefineReservedUsed(IOTimerEventSource, 0);
+OSMetaClassDefineReservedUsed(IOTimerEventSource, 1);
+OSMetaClassDefineReservedUsed(IOTimerEventSource, 2);

 OSMetaClassDefineReservedUnused(IOTimerEventSource, 3);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 4);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 5);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 6);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 7);
 
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 3);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 4);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 5);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 6);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 7);
 

-bool IOTimerEventSource::checkForWork() { return false; }
+#if IOKITSTATS
+
+#define IOStatisticsInitializeCounter() \
+do { \
+       IOStatistics::setCounterType(IOEventSource::reserved->counter, kIOStatisticsTimerEventSourceCounter); \
+} while (0)
+
+#define IOStatisticsOpenGate() \
+do { \
+       IOStatistics::countOpenGate(me->IOEventSource::reserved->counter); \
+} while (0)
+
+#define IOStatisticsCloseGate() \
+do { \
+       IOStatistics::countCloseGate(me->IOEventSource::reserved->counter); \
+} while (0)
+
+#define IOStatisticsTimeout() \
+do { \
+       IOStatistics::countTimerTimeout(me->IOEventSource::reserved->counter); \
+} while (0)
+
+#else
+
+#define IOStatisticsInitializeCounter()
+#define IOStatisticsOpenGate()
+#define IOStatisticsCloseGate()
+#define IOStatisticsTimeout()
+
+#endif /* IOKITSTATS */
+
+// 
+// reserved != 0 means IOTimerEventSource::timeoutAndRelease is being used,
+// not a subclassed implementation. 
+//

 
 // Timeout handler function. This function is called by the kernel when
 // the timeout interval expires.
 //
 
 // Timeout handler function. This function is called by the kernel when
 // the timeout interval expires.
 //

+
+static __inline__ void
+InvokeAction(IOTimerEventSource::Action action, IOTimerEventSource * ts,
+            OSObject * owner, IOWorkLoop * workLoop)
+{
+    bool    trace = (gIOKitTrace & kIOTraceTimers) ? true : false;
+
+    if (trace)
+       IOTimeStampStartConstant(IODBG_TIMES(IOTIMES_ACTION),
+                                VM_KERNEL_ADDRHIDE(action), VM_KERNEL_ADDRHIDE(owner));
+
+    (*action)(owner, ts);
+
+#if CONFIG_DTRACE
+    DTRACE_TMR3(iotescallout__expire, Action, action, OSObject, owner, void, workLoop);
+#endif
+
+    if (trace)
+       IOTimeStampEndConstant(IODBG_TIMES(IOTIMES_ACTION),
+                              VM_KERNEL_UNSLIDE(action), VM_KERNEL_ADDRHIDE(owner));
+}
+

 void IOTimerEventSource::timeout(void *self)
 {
     IOTimerEventSource *me = (IOTimerEventSource *) self;
 
 void IOTimerEventSource::timeout(void *self)
 {
     IOTimerEventSource *me = (IOTimerEventSource *) self;
 

-    if (me->enabled) {
-        Action doit = (Action) me->action;
+    IOStatisticsTimeout();
+
+    if (me->enabled && me->action)
+    {
+        IOWorkLoop *
+        wl = me->workLoop;
+        if (wl)
+        {
+            Action doit;
+            wl->closeGate();
+            IOStatisticsCloseGate();
+            doit = (Action) me->action;
+            if (doit && me->enabled && AbsoluteTime_to_scalar(&me->abstime))
+            {
+                InvokeAction(doit, me, me->owner, me->workLoop);
+            }
+            IOStatisticsOpenGate();
+            wl->openGate();
+        }
+    }
+}

 
 

-        if (doit) {
-            IOTimeStampConstant(IODBG_TIMES(IOTIMES_ACTION),
-                                (unsigned int) doit, (unsigned int) me->owner);
-            me->closeGate();
-            (*doit)(me->owner, me);
-            me->openGate();
+void IOTimerEventSource::timeoutAndRelease(void * self, void * c)
+{
+    IOTimerEventSource *me = (IOTimerEventSource *) self;
+       /* The second parameter (a pointer) gets abused to carry an SInt32, so on LP64, "count"
+          must be cast to "long" before, in order to tell GCC we're not truncating a pointer. */
+       SInt32 count = (SInt32) (long) c;
+
+    IOStatisticsTimeout();
+       
+    if (me->enabled && me->action)
+    {
+        IOWorkLoop *
+        wl = me->reserved->workLoop;
+        if (wl)
+        {
+            Action doit;
+            wl->closeGate();
+            IOStatisticsCloseGate();
+            doit = (Action) me->action;
+            if (doit && (me->reserved->calloutGeneration == count))
+            {
+                InvokeAction(doit, me, me->owner, me->workLoop);
+            }
+            IOStatisticsOpenGate();
+            wl->openGate();

         }
     }
         }
     }

+
+    me->reserved->workLoop->release();
+    me->release();

 }
 
 }
 

+// -- work loop delivery
+
+bool IOTimerEventSource::checkForWork()
+{
+    Action doit;
+
+    if (reserved
+     && (reserved->calloutGenerationSignaled == reserved->calloutGeneration)
+     && enabled && (doit = (Action) action))
+    {
+       reserved->calloutGenerationSignaled = ~reserved->calloutGeneration;
+       InvokeAction(doit, this, owner, workLoop);
+    }
+
+    return false;
+}
+
+void IOTimerEventSource::timeoutSignaled(void * self, void * c)
+{
+    IOTimerEventSource *me = (IOTimerEventSource *) self;
+
+    me->reserved->calloutGenerationSignaled = (SInt32)(long) c;
+    if (me->enabled) me->signalWorkAvailable();
+}
+
+// --
+

 void IOTimerEventSource::setTimeoutFunc()
 {
 void IOTimerEventSource::setTimeoutFunc()
 {

-    calloutEntry = (void *) thread_call_allocate((thread_call_func_t) timeout,
-                                                 (thread_call_param_t) this);
+    thread_call_priority_t pri;
+    uint32_t options;
+
+    if (reserved) panic("setTimeoutFunc already %p, %p", this, reserved);
+
+    // reserved != 0 means IOTimerEventSource::timeoutAndRelease is being used,
+    // not a subclassed implementation
+    reserved = IONew(ExpansionData, 1);
+    reserved->calloutGenerationSignaled = ~reserved->calloutGeneration;
+    options = abstime;
+    abstime = 0;
+
+    thread_call_options_t tcoptions = 0;
+    thread_call_func_t    func      = NULL;
+
+    switch (kIOTimerEventSourceOptionsPriorityMask & options)
+    {
+      case kIOTimerEventSourceOptionsPriorityHigh:
+        pri = THREAD_CALL_PRIORITY_HIGH;
+        func = &IOTimerEventSource::timeoutAndRelease;
+        break;
+
+      case kIOTimerEventSourceOptionsPriorityKernel:
+        pri = THREAD_CALL_PRIORITY_KERNEL;
+        func = &IOTimerEventSource::timeoutAndRelease;
+        break;
+
+      case kIOTimerEventSourceOptionsPriorityKernelHigh:
+        pri = THREAD_CALL_PRIORITY_KERNEL_HIGH;
+        func = &IOTimerEventSource::timeoutAndRelease;
+        break;
+
+      case kIOTimerEventSourceOptionsPriorityUser:
+        pri = THREAD_CALL_PRIORITY_USER;
+        func = &IOTimerEventSource::timeoutAndRelease;
+        break;
+
+      case kIOTimerEventSourceOptionsPriorityLow:
+        pri = THREAD_CALL_PRIORITY_LOW;
+        func = &IOTimerEventSource::timeoutAndRelease;
+        break;
+
+      case kIOTimerEventSourceOptionsPriorityWorkLoop:
+        pri = THREAD_CALL_PRIORITY_KERNEL;
+        tcoptions |= THREAD_CALL_OPTIONS_SIGNAL;
+        if (kIOTimerEventSourceOptionsAllowReenter & options) break;
+        func = &IOTimerEventSource::timeoutSignaled;
+        break;
+
+      default:
+        break;
+    }
+
+    assertf(func, "IOTimerEventSource options 0x%x", options);
+    if (!func) return;                                              // init will fail
+
+    if (THREAD_CALL_OPTIONS_SIGNAL & tcoptions) flags |= kActive;
+    else                                        flags |= kPassive;
+
+    if (!(kIOTimerEventSourceOptionsAllowReenter & options)) tcoptions |= THREAD_CALL_OPTIONS_ONCE;
+
+    calloutEntry = (void *) thread_call_allocate_with_options(func,
+        (thread_call_param_t) this, pri, tcoptions);
+    assert(calloutEntry);

 }
 
 bool IOTimerEventSource::init(OSObject *inOwner, Action inAction)
 }
 
 bool IOTimerEventSource::init(OSObject *inOwner, Action inAction)


@@ -94,15 +279,23 @@ bool IOTimerEventSource::init(OSObject *inOwner, Action inAction)
     if (!calloutEntry)
         return false;
 
     if (!calloutEntry)
         return false;
 

+    IOStatisticsInitializeCounter();
+

     return true;
 }
 
     return true;
 }
 

+bool IOTimerEventSource::init(uint32_t options, OSObject *inOwner, Action inAction)
+{
+    abstime = options;
+    return (init(inOwner, inAction));
+}
+

 IOTimerEventSource *
 IOTimerEventSource *

-IOTimerEventSource::timerEventSource(OSObject *inOwner, Action inAction)
+IOTimerEventSource::timerEventSource(uint32_t inOptions, OSObject *inOwner, Action inAction)

 {
     IOTimerEventSource *me = new IOTimerEventSource;
 
 {
     IOTimerEventSource *me = new IOTimerEventSource;
 

-    if (me && !me->init(inOwner, inAction)) {
+    if (me && !me->init(inOptions, inOwner, inAction)) {

         me->release();
         return 0;
     }
         me->release();
         return 0;
     }


@@ -110,20 +303,44 @@ IOTimerEventSource::timerEventSource(OSObject *inOwner, Action inAction)
     return me;
 }
 
     return me;
 }
 

+#define _thread_call_cancel(tc)   ((kActive & flags) ? thread_call_cancel_wait((tc)) : thread_call_cancel((tc)))
+
+IOTimerEventSource *
+IOTimerEventSource::timerEventSource(OSObject *inOwner, Action inAction)
+{
+    return (IOTimerEventSource::timerEventSource(
+                kIOTimerEventSourceOptionsPriorityKernelHigh,
+                inOwner, inAction));
+}
+

 void IOTimerEventSource::free()
 {
     if (calloutEntry) {
 void IOTimerEventSource::free()
 {
     if (calloutEntry) {

+        __assert_only bool freed;
+

         cancelTimeout();
         cancelTimeout();

-        thread_call_free((thread_call_t) calloutEntry);    
+
+        freed = thread_call_free((thread_call_t) calloutEntry);
+        assert(freed);

     }
 
     }
 

+    if (reserved)
+        IODelete(reserved, ExpansionData, 1);
+

     super::free();
 }
 
 void IOTimerEventSource::cancelTimeout()
 {
     super::free();
 }
 
 void IOTimerEventSource::cancelTimeout()
 {

-    thread_call_cancel((thread_call_t) calloutEntry);
+    if (reserved)
+        reserved->calloutGeneration++;
+    bool active = _thread_call_cancel((thread_call_t) calloutEntry);

     AbsoluteTime_to_scalar(&abstime) = 0;
     AbsoluteTime_to_scalar(&abstime) = 0;

+    if (active && reserved && (kPassive & flags))
+    {
+        release();
+        workLoop->release();
+    }

 }
 
 void IOTimerEventSource::enable()
 }
 
 void IOTimerEventSource::enable()


@@ -135,13 +352,20 @@ void IOTimerEventSource::enable()
 
 void IOTimerEventSource::disable()
 {
 
 void IOTimerEventSource::disable()
 {

-    thread_call_cancel((thread_call_t) calloutEntry);
+    if (reserved)
+        reserved->calloutGeneration++;
+    bool active = _thread_call_cancel((thread_call_t) calloutEntry);

     super::disable();
     super::disable();

+    if (active && reserved && (kPassive & flags))
+    {
+        release();
+        workLoop->release();
+    }

 }
 
 IOReturn IOTimerEventSource::setTimeoutTicks(UInt32 ticks)
 {
 }
 
 IOReturn IOTimerEventSource::setTimeoutTicks(UInt32 ticks)
 {

-    return setTimeout(ticks, NSEC_PER_SEC/hz);
+    return setTimeout(ticks, kTickScale);

 }
 
 IOReturn IOTimerEventSource::setTimeoutMS(UInt32 ms)
 }
 
 IOReturn IOTimerEventSource::setTimeoutMS(UInt32 ms)


@@ -157,11 +381,12 @@ IOReturn IOTimerEventSource::setTimeoutUS(UInt32 us)
 IOReturn IOTimerEventSource::setTimeout(UInt32 interval, UInt32 scale_factor)
 {
     AbsoluteTime end;
 IOReturn IOTimerEventSource::setTimeout(UInt32 interval, UInt32 scale_factor)
 {
     AbsoluteTime end;

-    
+

     clock_interval_to_deadline(interval, scale_factor, &end);
     return wakeAtTime(end);
 }
 
     clock_interval_to_deadline(interval, scale_factor, &end);
     return wakeAtTime(end);
 }
 

+#if !defined(__LP64__)

 IOReturn IOTimerEventSource::setTimeout(mach_timespec_t interval)
 {
     AbsoluteTime end, nsecs;
 IOReturn IOTimerEventSource::setTimeout(mach_timespec_t interval)
 {
     AbsoluteTime end, nsecs;


@@ -174,20 +399,27 @@ IOReturn IOTimerEventSource::setTimeout(mach_timespec_t interval)
 
     return wakeAtTime(end);
 }
 
     return wakeAtTime(end);
 }

+#endif

 
 IOReturn IOTimerEventSource::setTimeout(AbsoluteTime interval)
 {
     AbsoluteTime end;
 
 IOReturn IOTimerEventSource::setTimeout(AbsoluteTime interval)
 {
     AbsoluteTime end;

+    clock_absolutetime_interval_to_deadline(interval, &end);
+    return wakeAtTime(end);
+}

 
 

-    clock_get_uptime(&end);
-    ADD_ABSOLUTETIME(&end, &interval);
+IOReturn IOTimerEventSource::setTimeout(uint32_t options,
+                                       AbsoluteTime abstime, AbsoluteTime leeway)
+{
+    AbsoluteTime end;
+    clock_continuoustime_interval_to_deadline(abstime, &end);
+    return wakeAtTime(options, end, leeway);

 
 

-    return wakeAtTime(end);

 }
 
 IOReturn IOTimerEventSource::wakeAtTimeTicks(UInt32 ticks)
 {
 }
 
 IOReturn IOTimerEventSource::wakeAtTimeTicks(UInt32 ticks)
 {

-    return wakeAtTime(ticks, NSEC_PER_SEC/hz);
+    return wakeAtTime(ticks, kTickScale);

 }
 
 IOReturn IOTimerEventSource::wakeAtTimeMS(UInt32 ms)
 }
 
 IOReturn IOTimerEventSource::wakeAtTimeMS(UInt32 ms)


@@ -200,35 +432,77 @@ IOReturn IOTimerEventSource::wakeAtTimeUS(UInt32 us)
     return wakeAtTime(us, kMicrosecondScale);
 }
 
     return wakeAtTime(us, kMicrosecondScale);
 }
 

-IOReturn IOTimerEventSource::wakeAtTime(UInt32 abstime, UInt32 scale_factor)
+IOReturn IOTimerEventSource::wakeAtTime(UInt32 inAbstime, UInt32 scale_factor)

 {
     AbsoluteTime end;
 {
     AbsoluteTime end;

-    clock_interval_to_absolutetime_interval(abstime, scale_factor, &end);
+    clock_interval_to_absolutetime_interval(inAbstime, scale_factor, &end);

 
     return wakeAtTime(end);
 }
 
 
     return wakeAtTime(end);
 }
 

-IOReturn IOTimerEventSource::wakeAtTime(mach_timespec_t abstime)
+#if !defined(__LP64__)
+IOReturn IOTimerEventSource::wakeAtTime(mach_timespec_t inAbstime)

 {
     AbsoluteTime end, nsecs;
 
     clock_interval_to_absolutetime_interval
 {
     AbsoluteTime end, nsecs;
 
     clock_interval_to_absolutetime_interval

-        (abstime.tv_nsec, kNanosecondScale, &nsecs);
+        (inAbstime.tv_nsec, kNanosecondScale, &nsecs);

     clock_interval_to_absolutetime_interval
     clock_interval_to_absolutetime_interval

-        (abstime.tv_sec, kSecondScale, &end);
+        (inAbstime.tv_sec, kSecondScale, &end);

     ADD_ABSOLUTETIME(&end, &nsecs);
 
     return wakeAtTime(end);
 }
     ADD_ABSOLUTETIME(&end, &nsecs);
 
     return wakeAtTime(end);
 }

+#endif
+
+void IOTimerEventSource::setWorkLoop(IOWorkLoop *inWorkLoop)
+{
+    super::setWorkLoop(inWorkLoop);
+    if ( enabled && AbsoluteTime_to_scalar(&abstime) && workLoop )
+        wakeAtTime(abstime);
+}

 
 IOReturn IOTimerEventSource::wakeAtTime(AbsoluteTime inAbstime)
 
 IOReturn IOTimerEventSource::wakeAtTime(AbsoluteTime inAbstime)

+{
+    return wakeAtTime(0, inAbstime, 0);
+}
+
+IOReturn IOTimerEventSource::wakeAtTime(uint32_t options, AbsoluteTime inAbstime, AbsoluteTime leeway)

 {
     if (!action)
         return kIOReturnNoResources;
 
     abstime = inAbstime;
 {
     if (!action)
         return kIOReturnNoResources;
 
     abstime = inAbstime;

-    if ( enabled && AbsoluteTime_to_scalar(&abstime) )
-        thread_call_enter_delayed((thread_call_t) calloutEntry, abstime);
+    if ( enabled && AbsoluteTime_to_scalar(&inAbstime) && AbsoluteTime_to_scalar(&abstime) && workLoop )
+    {
+        uint32_t tcoptions = 0;
+
+        if (kIOTimeOptionsWithLeeway & options) tcoptions |= THREAD_CALL_DELAY_LEEWAY;
+        if (kIOTimeOptionsContinuous & options) tcoptions |= THREAD_CALL_CONTINUOUS;
+
+        if (reserved)
+        {
+           if (kPassive & flags)
+           {
+               retain();
+               workLoop->retain();
+           }
+            reserved->workLoop = workLoop;
+            reserved->calloutGeneration++;
+            if (thread_call_enter_delayed_with_leeway((thread_call_t) calloutEntry,
+                    (void *)(uintptr_t) reserved->calloutGeneration, inAbstime, leeway, tcoptions)
+              && (kPassive & flags))
+            {
+                release();
+                workLoop->release();
+            }
+        }
+        else
+        {
+            thread_call_enter_delayed_with_leeway((thread_call_t) calloutEntry,
+                    NULL, inAbstime, leeway, tcoptions);
+        }
+    }

 
     return kIOReturnSuccess;
 }
 
     return kIOReturnSuccess;
 }