xnu-4903.221.2.tar.gz

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

diff --git a/iokit/IOKit/IOWorkLoop.h b/iokit/IOKit/IOWorkLoop.h
index e248a9b3bd7cabf0fb78de278045c88f1c556d2f..c62c13216ce4616c32199a3a3b0d356be031396d 100644 (file)
--- a/iokit/IOKit/IOWorkLoop.h
+++ b/iokit/IOKit/IOWorkLoop.h
@@ -74,8 +74,14 @@ member function's parameter list.
     typedef IOReturn (*Action)(OSObject *target,
                               void *arg0, void *arg1,
                               void *arg2, void *arg3);
+
+#ifdef __BLOCKS__
+    typedef IOReturn (^ActionBlock)();
+#endif /* __BLOCKS__ */
+
     enum {
-       kPreciousStack = 0x00000001
+       kPreciousStack  = 0x00000001,
+       kTimeLockPanics = 0x00000002,
     };
 
 private:
@@ -142,14 +148,13 @@ protected:
     struct ExpansionData {
        IOOptionBits options;
        IOEventSource *passiveEventChain;
-#if DEBUG
-       void * allocationBacktrace[16];
-#endif /* DEBUG */
 #if IOKITSTATS
        struct IOWorkLoopCounter *counter;
 #else
        void *iokitstatsReserved;
 #endif
+        uint64_t lockInterval;
+        uint64_t lockTime;
     };
 
 /*! @var reserved
@@ -169,7 +174,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. 
 */
-    virtual void free();
+    virtual void free() APPLE_KEXT_OVERRIDE;
 
 /*! @function threadMain
     @discussion Work loop threads main function.  This function consists of 3
@@ -201,7 +206,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. 
 */
-    virtual bool init();
+    virtual bool init() APPLE_KEXT_OVERRIDE;
 
 /*! @function getThread
     @abstract Gets the workThread.
@@ -264,6 +269,7 @@ protected:
     // 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
@@ -291,6 +297,16 @@ public:
                               void *arg0 = 0, void *arg1 = 0,
                               void *arg2 = 0, void *arg3 = 0);
 
+#ifdef __BLOCKS__
+/*! @function runAction
+    @abstract Single thread a call to an action with the work-loop.
+    @discussion Client function that causes the given action to be called in a single threaded manner.  Beware: the work-loop's gate is recursive and runAction can cause direct or indirect re-entrancy.  When executing on a client's thread, runAction will sleep until the work-loop's gate opens for execution of client actions, the action is single threaded against all other work-loop event sources.
+    @param action Block to be executed in work-loop context.
+    @result Returns the result of the action block.
+*/
+    IOReturn runActionBlock(ActionBlock action);
+#endif /* __BLOCKS__ */
+
 /*! @function runEventSources
     @discussion Consists of the inner 2 loops of the threadMain function(qv).
     The outer loop terminates when there is no more work, and the inside loop
@@ -312,10 +328,21 @@ public:
 */
     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);
 
+#if XNU_KERNEL_PRIVATE
+    void lockTime(void);
+#endif /* XNU_KERNEL_PRIVATE */
+
 protected:
 #if __LP64__
     OSMetaClassDeclareReservedUnused(IOWorkLoop, 0);