xnu-4570.20.62.tar.gz

[apple/xnu.git] / iokit / IOKit / IOWorkLoop.h

diff --git a/iokit/IOKit/IOWorkLoop.h b/iokit/IOKit/IOWorkLoop.h
index 808329adab0a383e54bf5edaee62e719bbac5f3c..afc4979b01214be648781a8047daa22a9a7f3236 100644 (file)
--- a/iokit/IOKit/IOWorkLoop.h
+++ b/iokit/IOKit/IOWorkLoop.h
@@ -1,5 +1,5 @@
 /*
 /*

- * Copyright (c) 1998-2007 Apple Inc. All rights reserved.
+ * Copyright (c) 1998-2009 Apple Inc. All rights reserved.

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 


@@ -25,14 +25,6 @@
  * 
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
  * 
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */

-/*
-Copyright (c) 1998 Apple Computer, Inc.         All rights reserved.
-HISTORY
-    1998-7-13  Godfrey van der Linden(gvdl)
-       Created.
-    1998-10-30 Godfrey van der Linden(gvdl)
-       Converted to C++
-*/

 
 #ifndef __IOKIT_IOWORKLOOP_H
 #define __IOKIT_IOWORKLOOP_H
 
 #ifndef __IOKIT_IOWORKLOOP_H
 #define __IOKIT_IOWORKLOOP_H


@@ -44,6 +36,10 @@ HISTORY
 
 #include <IOKit/system.h>
 
 
 #include <IOKit/system.h>
 

+#if IOKITSTATS
+#include <IOKit/IOStatisticsPrivate.h>
+#endif
+

 class IOEventSource;
 class IOTimerEventSource;
 class IOCommandGate;
 class IOEventSource;
 class IOTimerEventSource;
 class IOCommandGate;


@@ -79,7 +75,8 @@ member function's parameter list.
                               void *arg0, void *arg1,
                               void *arg2, void *arg3);
     enum {
                               void *arg0, void *arg1,
                               void *arg2, void *arg3);
     enum {

-       kPreciousStack = 0x00000001
+       kPreciousStack  = 0x00000001,
+       kTimeLockPanics = 0x00000002,

     };
 
 private:
     };
 
 private:


@@ -87,7 +84,14 @@ private:
     @abstract Static function that calls the threadMain function. 
 */
     static void threadMainContinuation(IOWorkLoop *self);
     @abstract Static function that calls the threadMain function. 
 */
     static void threadMainContinuation(IOWorkLoop *self);

-
+       
+/*! @function eventSourcePerformsWork
+       @abstract Checks if the event source passed in overrides checkForWork() to perform any work.
+IOWorkLoop uses this to determine if the event source should be polled in runEventSources() or not.
+       @param inEventSource The event source to check.
+*/
+       bool eventSourcePerformsWork(IOEventSource *inEventSource);
+       

 protected:
 
 /*! @typedef maintCommandEnum
 protected:
 
 /*! @typedef maintCommandEnum


@@ -138,6 +142,14 @@ protected:
 */    
     struct ExpansionData {
        IOOptionBits options;
 */    
     struct ExpansionData {
        IOOptionBits options;

+       IOEventSource *passiveEventChain;
+#if IOKITSTATS
+       struct IOWorkLoopCounter *counter;
+#else
+       void *iokitstatsReserved;
+#endif
+        uint64_t lockInterval;
+        uint64_t lockTime;

     };
 
 /*! @var reserved
     };
 
 /*! @var reserved


@@ -157,7 +169,7 @@ protected:
 <br><br>
        If the client has some outstanding requests on an event they will never be informed of completion.  If an external thread is blocked on any of the event sources they will be awakened with a KERN_INTERUPTED status. 
 */
 <br><br>
        If the client has some outstanding requests on an event they will never be informed of completion.  If an external thread is blocked on any of the event sources they will be awakened with a KERN_INTERUPTED status. 
 */

-    virtual void free();
+    virtual void free() APPLE_KEXT_OVERRIDE;

 
 /*! @function threadMain
     @discussion Work loop threads main function.  This function consists of 3
 
 /*! @function threadMain
     @discussion Work loop threads main function.  This function consists of 3


@@ -189,7 +201,7 @@ public:
     @discussion Initializes an instance of the workloop.  This method creates and initializes the signaling semaphore, the controller gate lock, and spawns the thread that will continue executing.
     @result Returns true if initialized successfully, false otherwise. 
 */
     @discussion Initializes an instance of the workloop.  This method creates and initializes the signaling semaphore, the controller gate lock, and spawns the thread that will continue executing.
     @result Returns true if initialized successfully, false otherwise. 
 */

-    virtual bool init();
+    virtual bool init() APPLE_KEXT_OVERRIDE;

 
 /*! @function getThread
     @abstract Gets the workThread.
 
 /*! @function getThread
     @abstract Gets the workThread.


@@ -237,13 +249,13 @@ public:
 
 /*! @function enableAllInterrupts
     @abstract Calls enable() in all interrupt event sources.
 
 /*! @function enableAllInterrupts
     @abstract Calls enable() in all interrupt event sources.

-    @discussion For all event sources (ES) for which IODynamicCast(IOInterruptEventSource, ES) is valid, in eventChain call enable() function.  See IOEventSource::enable().
+    @discussion For all event sources (ES) for which OSDynamicCast(IOInterruptEventSource, ES) is valid, in eventChain call enable() function.  See IOEventSource::enable().

 */
     virtual void enableAllInterrupts() const;
 
 /*! @function disableAllInterrupts
     @abstract Calls disable() in all interrupt event sources.
 */
     virtual void enableAllInterrupts() const;
 
 /*! @function disableAllInterrupts
     @abstract Calls disable() in all interrupt event sources.

-    @discussion For all event sources (ES) for which IODynamicCast(IOInterruptEventSource, ES) is valid,  in eventChain call disable() function.  See IOEventSource::disable().
+    @discussion For all event sources (ES) for which OSDynamicCast(IOInterruptEventSource, ES) is valid,  in eventChain call disable() function.  See IOEventSource::disable().

 */
     virtual void disableAllInterrupts() const;
 
 */
     virtual void disableAllInterrupts() const;
 


@@ -252,6 +264,10 @@ protected:
     // Internal APIs used by event sources to control the thread
     friend class IOEventSource;
     friend class IOTimerEventSource;
     // Internal APIs used by event sources to control the thread
     friend class IOEventSource;
     friend class IOTimerEventSource;

+    friend class IOCommandGate;
+#if IOKITSTATS
+    friend class IOStatistics;
+#endif

     virtual void signalWorkAvailable();
     virtual void openGate();
     virtual void closeGate();
     virtual void signalWorkAvailable();
     virtual void openGate();
     virtual void closeGate();


@@ -297,10 +313,21 @@ public:
 */
     virtual bool runEventSources();
 
 */
     virtual bool runEventSources();
 

+/*! @function setMaximumLockTime
+    @discussion For diagnostics use in DEVELOPMENT kernels, set a time interval which if the work loop lock is held for this time or greater, IOWorkLoop will panic or log a backtrace.
+    @param interval An absolute time interval, eg. created with clock_interval_to_absolutetime_interval().
+    @param options Pass IOWorkLoop::kTimeLockPanics to panic when the time is exceeded, otherwise a log will be generated with OSReportWithBacktrace().
+*/
+    void setMaximumLockTime(uint64_t interval, uint32_t options);
+

 protected:
     // Internal APIs used by event sources to control the thread
     virtual int sleepGate(void *event, AbsoluteTime deadline, UInt32 interuptibleType);
 
 protected:
     // Internal APIs used by event sources to control the thread
     virtual int sleepGate(void *event, AbsoluteTime deadline, UInt32 interuptibleType);
 

+#if XNU_KERNEL_PRIVATE
+    void lockTime(void);
+#endif /* XNU_KERNEL_PRIVATE */
+

 protected:
 #if __LP64__
     OSMetaClassDeclareReservedUnused(IOWorkLoop, 0);
 protected:
 #if __LP64__
     OSMetaClassDeclareReservedUnused(IOWorkLoop, 0);