Reduce CPU usage when no isolates need to be profiled.

runtime/vm/thread_interrupter.cc

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #include "vm/simulator.h"
 #include "vm/thread_interrupter.h"
 
 namespace dart {
 
 // Notes:
 //
-// The ThreadInterrupter interrupts all registered threads once per
-// interrupt period (default is every millisecond). While the thread is
+// The ThreadInterrupter interrupts all threads actively running isolates once
+// per interrupt period (default is 1 millisecond). While the thread is
 // interrupted, the thread's interrupt callback is invoked. Callbacks cannot
 // rely on being executed on the interrupted thread.
 //
 // There are two mechanisms used to interrupt a thread. The first, used on OSs
 // with pthreads (Android, Linux, and Mac), is thread specific signal delivery.
 // The second, used on Windows, is explicit suspend and resume thread system
 // calls. Signal delivery forbids taking locks and allocating memory (which
 // takes a lock). Explicit suspend and resume means that the interrupt callback
 // will not be executing on the interrupted thread, making it meaningless to
 // access TLS from within the thread interrupt callback. Combining these
 // limitations, thread interrupt callbacks are forbidden from:
 //
 //   * Accessing TLS.
 //   * Allocating memory.
 //   * Taking a lock.
 //
-// The ThreadInterrupter has a single monitor (monitor_). This monitor guards
-// access to the list of threads registered to receive interrupts (threads_).
+// The ThreadInterrupter has a single monitor (monitor_). This monitor is used
+// to synchronize startup, shutdown, and waking up from a deep sleep.
 //
 // A thread can only register and unregister itself. Each thread has a heap
 // allocated ThreadState. A thread's ThreadState is lazily allocated the first
 // time the thread is registered. A pointer to a thread's ThreadState is stored
 // in the list of threads registered to receive interrupts (threads_) and in
 // thread local storage. When a thread's ThreadState is being modified, the
 // thread local storage pointer is temporarily set to NULL while the
 // modification is occurring. After the ThreadState has been updated, the
 // thread local storage pointer is set again. This has an important side
 // effect: if the thread is interrupted by a signal handler during a ThreadState
 // update the signal handler will immediately return.
 
 DEFINE_FLAG(bool, trace_thread_interrupter, false,
             "Trace thread interrupter");
 
 bool ThreadInterrupter::initialized_ = false;
 bool ThreadInterrupter::shutdown_ = false;
 bool ThreadInterrupter::thread_running_ = false;
 ThreadId ThreadInterrupter::interrupter_thread_id_ = Thread::kInvalidThreadId;
 Monitor* ThreadInterrupter::monitor_ = NULL;
 intptr_t ThreadInterrupter::interrupt_period_ = 1000;
+intptr_t ThreadInterrupter::current_wait_time_ = 0;
 ThreadLocalKey ThreadInterrupter::thread_state_key_ =
     Thread::kUnsetThreadLocalKey;
 
 
 void ThreadInterrupter::InitOnce() {
   ASSERT(!initialized_);
   ASSERT(thread_state_key_ == Thread::kUnsetThreadLocalKey);
   thread_state_key_ = Thread::CreateThreadLocal();
   ASSERT(thread_state_key_ != Thread::kUnsetThreadLocalKey);
   monitor_ = new Monitor();
@@ skipping 28 matching lines @@
     if (shutdown_) {
       // Already shutdown.
       return;
     }
     shutdown_ = true;
     ASSERT(initialized_);
     if (FLAG_trace_thread_interrupter) {
       OS::Print("ThreadInterrupter shutting down.\n");
     }
     while (thread_running_) {
+      // Notify in case of deep sleep.
+      shutdown_ml.Notify();
       shutdown_ml.Wait();

[Ivan Posva, 2014/05/25 12:25:16]

Aren't you waiting on your own notification in this case?

Why do we need to wait for the thread_running_ to change? Since below we are
joining with the thread anyway.

[Cutch, 2014/05/26 06:59:35]

Moved the Notify out of the loop and replaced it with a call to WakeUp.
We only join the thread on Windows (pthreads we create DETACHED). 

     }
     // Join in the interrupter thread. On Windows, a thread's exit-code can
     // leak into the process's exit-code, if exiting 'at same time' as the
     // process ends.
     if (interrupter_thread_id_ != Thread::kInvalidThreadId) {
       Thread::Join(interrupter_thread_id_);
       interrupter_thread_id_ = Thread::kInvalidThreadId;
     }
   }
   if (FLAG_trace_thread_interrupter) {
     OS::Print("ThreadInterrupter shut down.\n");
   }
 }
 
 // Delay between interrupts.
 void ThreadInterrupter::SetInterruptPeriod(intptr_t period) {
   if (shutdown_) {
     return;
   }
   ASSERT(initialized_);
   ASSERT(period > 0);
   interrupt_period_ = period;
 }
 
 
+void ThreadInterrupter::WakeUp() {
+  if (shutdown_) {
+    return;
+  }
+  ASSERT(initialized_);
+  {
+    MonitorLocker ml(monitor_);
+    if (!InDeepSleep()) {
+      // No need to notify, regularly waking up.
+      return;
+    }
+    // Notify the interrupter to wake it from its deep sleep.
+    ml.Notify();
+  }
+}
+
 // Register the currently running thread for interrupts. If the current thread
 // is already registered, callback and data will be updated.
 InterruptableThreadState* ThreadInterrupter::Register(
     ThreadInterruptCallback callback, void* data) {
   if (shutdown_) {
     return NULL;
   }
   ASSERT(initialized_);
   InterruptableThreadState* state = _EnsureThreadStateCreated();
   // Set callback and data.
@@ skipping 76 matching lines @@
 }
 
 
 void ThreadInterruptNoOp(const InterruptedThreadState& state, void* data) {
   // NoOp.
 }
 
 
 class ThreadInterrupterVisitIsolates : public IsolateVisitor {
  public:
-  ThreadInterrupterVisitIsolates() { }
+  ThreadInterrupterVisitIsolates() {
+    profiled_isolate_count_ = 0;
+  }
+
   void VisitIsolate(Isolate* isolate) {
     ASSERT(isolate != NULL);
-    isolate->ProfileInterrupt();
+    profiled_isolate_count_ += isolate->ProfileInterrupt();

[Ivan Posva, 2014/05/25 19:07:48]

Please add a comment in ProfileInterrupt that the result value should contain
how many threads had their stacks sampled as part of the interrupt.

   }
+
+  intptr_t profiled_isolate_count() const {
+    return profiled_isolate_count_;
+  }
+
+  void set_profiled_isolate_count(intptr_t profiled_isolate_count) {
+    profiled_isolate_count_ = profiled_isolate_count;
+  }
+
+ private:
+  intptr_t profiled_isolate_count_;
 };
 
 
 void ThreadInterrupter::ThreadMain(uword parameters) {
   ASSERT(initialized_);
   InstallSignalHandler();
   if (FLAG_trace_thread_interrupter) {
     OS::Print("ThreadInterrupter thread running.\n");
   }
   {
     // Signal to main thread we are ready.
     MonitorLocker startup_ml(monitor_);
     interrupter_thread_id_ = Thread::GetCurrentThreadId();
     thread_running_ = true;
     startup_ml.Notify();
   }
   {
+    ThreadInterrupterVisitIsolates visitor;
+    current_wait_time_ = interrupt_period_;
     MonitorLocker wait_ml(monitor_);
-    ThreadInterrupterVisitIsolates visitor;
     while (!shutdown_) {
+      intptr_t r = wait_ml.WaitMicros(current_wait_time_);
+
+      if ((r == Monitor::kNotified) && InDeepSleep()) {
+        // Woken up from deep sleep.
+        ASSERT(visitor.profiled_isolate_count() == 0);
+        // Return to regular interrupts.
+        current_wait_time_ = interrupt_period_;
+      }
+
+      // Reset count before visiting isolates.
+      visitor.set_profiled_isolate_count(0);
       Isolate::VisitIsolates(&visitor);
-      wait_ml.WaitMicros(interrupt_period_);
+
+      if (visitor.profiled_isolate_count() == 0) {
+        // No isolates were profiled. In order to reduce unnecessary CPU
+        // load, we will wait until we are notified before attempting to
+        // interrupt again.
+        current_wait_time_ = 0;

[Ivan Posva, 2014/05/25 12:25:16]

Please add a comment that a wait time of 0 means indefinitely.

[Cutch, 2014/05/26 06:59:35]

Switched to using Monitor::kNoTimeout which should be clear.

+        continue;
+      }
+
+      ASSERT(current_wait_time_ == interrupt_period_);
     }
   }
   if (FLAG_trace_thread_interrupter) {
     OS::Print("ThreadInterrupter thread exiting.\n");
   }
   {
     // Signal to main thread we are exiting.
     MonitorLocker shutdown_ml(monitor_);
     thread_running_ = false;
     shutdown_ml.Notify();
   }
 }
 
 }  // namespace dart