xnu-2782.1.97.tar.gz

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

diff --git a/iokit/Kernel/IOTimerEventSource.cpp b/iokit/Kernel/IOTimerEventSource.cpp
index 3c86e67090c91405814dfb5e706466d57ede6579..df939da91c0fe02d1ef4eaf4804f99cd78c0d0ee 100644 (file)
--- a/iokit/Kernel/IOTimerEventSource.cpp
+++ b/iokit/Kernel/IOTimerEventSource.cpp
@@ -1,16 +1,19 @@
 /*
 /*

- * 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@
- * 
- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
+ * @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
  * 
  * 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. Please obtain a copy of the License at
- * http://www.opensource.apple.com/apsl/ and read it before using this
- * file.
+ * 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
  * 
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER


@@ -20,18 +23,7 @@
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * 
  * 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>


@@ -48,6 +40,10 @@ __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)


@@ -60,7 +56,41 @@ OSMetaClassDefineReservedUnused(IOTimerEventSource, 5);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 6);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 7);
 
 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.


@@ -69,22 +99,92 @@ void IOTimerEventSource::timeout(void *self)
 {
     IOTimerEventSource *me = (IOTimerEventSource *) 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))
+            {
+               bool    trace = (gIOKitTrace & kIOTraceTimers) ? true : false;
+               
+               if (trace)
+                       IOTimeStampStartConstant(IODBG_TIMES(IOTIMES_ACTION),
+                                                                                        VM_KERNEL_UNSLIDE(doit), (uintptr_t) me->owner);
+                               
+                (*doit)(me->owner, me);
+#if CONFIG_DTRACE
+               DTRACE_TMR3(iotescallout__expire, Action, doit, OSObject, me->owner, void, me->workLoop);
+#endif
+                
+                               if (trace)
+                       IOTimeStampEndConstant(IODBG_TIMES(IOTIMES_ACTION),
+                                                                                  VM_KERNEL_UNSLIDE(doit), (uintptr_t) me->owner);
+            }
+            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))
+            {
+               bool    trace = (gIOKitTrace & kIOTraceTimers) ? true : false;
+               
+               if (trace)
+                       IOTimeStampStartConstant(IODBG_TIMES(IOTIMES_ACTION),
+                                                                                        VM_KERNEL_UNSLIDE(doit), (uintptr_t) me->owner);
+                               
+                (*doit)(me->owner, me);
+#if CONFIG_DTRACE
+               DTRACE_TMR3(iotescallout__expire, Action, doit, OSObject, me->owner, void, me->workLoop);
+#endif
+                
+                               if (trace)
+                       IOTimeStampEndConstant(IODBG_TIMES(IOTIMES_ACTION),
+                                                                                  VM_KERNEL_UNSLIDE(doit), (uintptr_t) me->owner);
+            }
+            IOStatisticsOpenGate();
+            wl->openGate();

         }
     }
         }
     }

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

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

-    calloutEntry = (void *) thread_call_allocate((thread_call_func_t) timeout,
+    // reserved != 0 means IOTimerEventSource::timeoutAndRelease is being used,
+    // not a subclassed implementation
+    reserved = IONew(ExpansionData, 1);
+    calloutEntry = (void *) thread_call_allocate((thread_call_func_t) &IOTimerEventSource::timeoutAndRelease,

                                                  (thread_call_param_t) this);
 }
 
                                                  (thread_call_param_t) this);
 }
 


@@ -97,6 +197,8 @@ bool IOTimerEventSource::init(OSObject *inOwner, Action inAction)
     if (!calloutEntry)
         return false;
 
     if (!calloutEntry)
         return false;
 

+    IOStatisticsInitializeCounter();
+

     return true;
 }
 
     return true;
 }
 


@@ -106,7 +208,7 @@ IOTimerEventSource::timerEventSource(OSObject *inOwner, Action inAction)
     IOTimerEventSource *me = new IOTimerEventSource;
 
     if (me && !me->init(inOwner, inAction)) {
     IOTimerEventSource *me = new IOTimerEventSource;
 
     if (me && !me->init(inOwner, inAction)) {

-        me->free();
+        me->release();

         return 0;
     }
 
         return 0;
     }
 


@@ -120,13 +222,23 @@ void IOTimerEventSource::free()
         thread_call_free((thread_call_t) calloutEntry);    
     }
 
         thread_call_free((thread_call_t) calloutEntry);    
     }
 

+    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)
+    {
+        release();
+        workLoop->release();
+    }

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


@@ -138,13 +250,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)
+    {
+        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)


@@ -160,11 +279,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;


@@ -177,6 +297,7 @@ IOReturn IOTimerEventSource::setTimeout(mach_timespec_t interval)
 
     return wakeAtTime(end);
 }
 
     return wakeAtTime(end);
 }

+#endif

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


@@ -190,7 +311,7 @@ IOReturn IOTimerEventSource::setTimeout(AbsoluteTime interval)
 
 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)


@@ -203,26 +324,35 @@ 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)
 {


@@ -230,8 +360,24 @@ IOReturn IOTimerEventSource::wakeAtTime(AbsoluteTime inAbstime)
         return kIOReturnNoResources;
 
     abstime = inAbstime;
         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 )
+    {
+        if (reserved)
+        {
+            retain();
+            workLoop->retain();
+            reserved->workLoop = workLoop;
+            reserved->calloutGeneration++;
+            if (thread_call_enter1_delayed((thread_call_t) calloutEntry, 
+                    (void *)(uintptr_t) reserved->calloutGeneration, inAbstime))
+            {
+                release();
+                workLoop->release();
+            }
+        }
+        else
+            thread_call_enter_delayed((thread_call_t) calloutEntry, inAbstime);
+    }

 
     return kIOReturnSuccess;
 }
 
     return kIOReturnSuccess;
 }