xnu-1699.24.8.tar.gz

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

diff --git a/iokit/Kernel/IOTimerEventSource.cpp b/iokit/Kernel/IOTimerEventSource.cpp
index b81757f38b3813d825713bf93eee8b5a7715a2d7..c71feccf0ca8671127a9c85afa0505932709d023 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,6 +40,7 @@ __END_DECLS
 #include <IOKit/IOWorkLoop.h>
 
 #include <IOKit/IOTimeStamp.h>
 #include <IOKit/IOWorkLoop.h>
 
 #include <IOKit/IOTimeStamp.h>

+#include <IOKit/IOKitDebug.h>

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


@@ -57,13 +53,42 @@ OSMetaClassDefineReservedUnused(IOTimerEventSource, 5);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 6);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 7);
 
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 6);
 OSMetaClassDefineReservedUnused(IOTimerEventSource, 7);
 

+#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. 
 //
 
 // 
 // reserved != 0 means IOTimerEventSource::timeoutAndRelease is being used,
 // not a subclassed implementation. 
 //
 

-bool IOTimerEventSource::checkForWork() { return false; }
-

 // 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.
 //


@@ -71,6 +96,8 @@ void IOTimerEventSource::timeout(void *self)
 {
     IOTimerEventSource *me = (IOTimerEventSource *) self;
 
 {
     IOTimerEventSource *me = (IOTimerEventSource *) self;
 

+    IOStatisticsTimeout();
+

     if (me->enabled && me->action)
     {
         IOWorkLoop *
     if (me->enabled && me->action)
     {
         IOWorkLoop *


@@ -79,22 +106,37 @@ void IOTimerEventSource::timeout(void *self)
         {
             Action doit;
             wl->closeGate();
         {
             Action doit;
             wl->closeGate();

+            IOStatisticsCloseGate();

             doit = (Action) me->action;
             if (doit && me->enabled && AbsoluteTime_to_scalar(&me->abstime))
             {
             doit = (Action) me->action;
             if (doit && me->enabled && AbsoluteTime_to_scalar(&me->abstime))
             {

-                IOTimeStampConstant(IODBG_TIMES(IOTIMES_ACTION),
-                                    (unsigned int) doit, (unsigned int) me->owner);
+               bool    trace = (gIOKitTrace & kIOTraceTimers) ? true : false;
+               
+               if (trace)
+                       IOTimeStampStartConstant(IODBG_TIMES(IOTIMES_ACTION),
+                                                                                        (uintptr_t) doit, (uintptr_t) me->owner);
+                               

                 (*doit)(me->owner, me);
                 (*doit)(me->owner, me);

+                
+                               if (trace)
+                       IOTimeStampEndConstant(IODBG_TIMES(IOTIMES_ACTION),
+                                                                                  (uintptr_t) doit, (uintptr_t) me->owner);

             }
             }

+            IOStatisticsOpenGate();

             wl->openGate();
         }
     }
 }
 
             wl->openGate();
         }
     }
 }
 

-void IOTimerEventSource::timeoutAndRelease(void * self, void * count)
+void IOTimerEventSource::timeoutAndRelease(void * self, void * c)

 {
     IOTimerEventSource *me = (IOTimerEventSource *) self;
 {
     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 *
     if (me->enabled && me->action)
     {
         IOWorkLoop *


@@ -103,13 +145,23 @@ void IOTimerEventSource::timeoutAndRelease(void * self, void * count)
         {
             Action doit;
             wl->closeGate();
         {
             Action doit;
             wl->closeGate();

+            IOStatisticsCloseGate();

             doit = (Action) me->action;
             doit = (Action) me->action;

-            if (doit && (me->reserved->calloutGeneration == (SInt32) count))
+            if (doit && (me->reserved->calloutGeneration == count))

             {
             {

-                IOTimeStampConstant(IODBG_TIMES(IOTIMES_ACTION),
-                                    (unsigned int) doit, (unsigned int) me->owner);
+               bool    trace = (gIOKitTrace & kIOTraceTimers) ? true : false;
+               
+               if (trace)
+                       IOTimeStampStartConstant(IODBG_TIMES(IOTIMES_ACTION),
+                                                                                        (uintptr_t) doit, (uintptr_t) me->owner);
+                               

                 (*doit)(me->owner, me);
                 (*doit)(me->owner, me);

+                
+                               if (trace)
+                       IOTimeStampEndConstant(IODBG_TIMES(IOTIMES_ACTION),
+                                                                                  (uintptr_t) doit, (uintptr_t) me->owner);

             }
             }

+            IOStatisticsOpenGate();

             wl->openGate();
         }
     }
             wl->openGate();
         }
     }


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

+    IOStatisticsInitializeCounter();
+

     return true;
 }
 
     return true;
 }
 


@@ -216,11 +270,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;


@@ -233,6 +288,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)
 {


@@ -267,6 +323,7 @@ IOReturn IOTimerEventSource::wakeAtTime(UInt32 inAbstime, UInt32 scale_factor)
     return wakeAtTime(end);
 }
 
     return wakeAtTime(end);
 }
 

+#if !defined(__LP64__)

 IOReturn IOTimerEventSource::wakeAtTime(mach_timespec_t inAbstime)
 {
     AbsoluteTime end, nsecs;
 IOReturn IOTimerEventSource::wakeAtTime(mach_timespec_t inAbstime)
 {
     AbsoluteTime end, nsecs;


@@ -279,6 +336,7 @@ IOReturn IOTimerEventSource::wakeAtTime(mach_timespec_t inAbstime)
 
     return wakeAtTime(end);
 }
 
     return wakeAtTime(end);
 }

+#endif

 
 void IOTimerEventSource::setWorkLoop(IOWorkLoop *inWorkLoop)
 {
 
 void IOTimerEventSource::setWorkLoop(IOWorkLoop *inWorkLoop)
 {


@@ -293,7 +351,7 @@ IOReturn IOTimerEventSource::wakeAtTime(AbsoluteTime inAbstime)
         return kIOReturnNoResources;
 
     abstime = inAbstime;
         return kIOReturnNoResources;
 
     abstime = inAbstime;

-    if ( enabled && AbsoluteTime_to_scalar(&abstime) && workLoop )
+    if ( enabled && AbsoluteTime_to_scalar(&inAbstime) && AbsoluteTime_to_scalar(&abstime) && workLoop )

     {
         if (reserved)
         {
     {
         if (reserved)
         {


@@ -302,14 +360,14 @@ IOReturn IOTimerEventSource::wakeAtTime(AbsoluteTime inAbstime)
             reserved->workLoop = workLoop;
             reserved->calloutGeneration++;
             if (thread_call_enter1_delayed((thread_call_t) calloutEntry, 
             reserved->workLoop = workLoop;
             reserved->calloutGeneration++;
             if (thread_call_enter1_delayed((thread_call_t) calloutEntry, 

-                    (void *) reserved->calloutGeneration, abstime))
+                    (void *) reserved->calloutGeneration, inAbstime))

             {
                 release();
                 workLoop->release();
             }
         }
         else
             {
                 release();
                 workLoop->release();
             }
         }
         else

-            thread_call_enter_delayed((thread_call_t) calloutEntry, abstime);
+            thread_call_enter_delayed((thread_call_t) calloutEntry, inAbstime);

     }
 
     return kIOReturnSuccess;
     }
 
     return kIOReturnSuccess;