Merge pull request #263 from olleolleolle/feature/add-more-signals

Perform a VM-wide thread stack trace dump on USR2

lib/hutch/waiter.rb

@@ -1,10 +1,24 @@
 require 'hutch/logging'
 
 module Hutch
+  # Signal-handling class.
+  #
+  # Currently, the signal USR2 performs a thread dump,
+  # while QUIT, TERM and INT all perform a graceful shutdown.
   class Waiter
     include Logging
 
-    SHUTDOWN_SIGNALS = %w(QUIT TERM INT).keep_if { |s| Signal.list.keys.include? s }.freeze
+    class ContinueProcessingSignals < RuntimeError
+    end
+
+    def self.supported_signals_of(list)
+      list.keep_if { |s| Signal.list.keys.include? s }
+    end
+
+    SHUTDOWN_SIGNALS = supported_signals_of(%w(QUIT TERM INT)).freeze
+    # We have chosen a JRuby-supported signal
+    USER_SIGNALS = supported_signals_of(%w(USR2)).freeze
+    REGISTERED_SIGNALS = (SHUTDOWN_SIGNALS + USER_SIGNALS).freeze
 
     def self.wait_until_signaled
       new.wait_until_signaled
@@ -14,28 +28,75 @@ def wait_until_signaled
       self.sig_read, self.sig_write = IO.pipe
 
       register_signal_handlers
-      wait_for_signal
 
-      sig = sig_read.gets.strip.downcase
-      logger.info "caught sig#{sig}, stopping hutch..."
+      begin
+        wait_for_signal
+
+        sig = sig_read.gets.strip
+        handle_signal(sig)
+      rescue ContinueProcessingSignals
+        retry
+      end
+    end
+
+    def handle_signal(sig)
+      raise ContinueProcessingSignals unless REGISTERED_SIGNALS.include?(sig)
+      if user_signal?(sig)
+        handle_user_signal(sig)
+      else
+        handle_shutdown_signal(sig)
+      end
+    end
+
+    # @raises ContinueProcessingSignals
+    def handle_user_signal(sig)
+      case sig
+      when 'USR2' then log_thread_backtraces
+      else raise "Assertion failed - unhandled signal: #{sig.inspect}"
+      end
+      raise ContinueProcessingSignals
+    end
+
+    def handle_shutdown_signal(sig)
+      logger.info "caught SIG#{sig}, stopping hutch..."
     end
 
     private
 
+    def log_thread_backtraces
+      logger.info 'Requested a VM-wide thread stack trace dump...'
+      Thread.list.each do |thread|
+        logger.info "Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}"
+        logger.info backtrace_for(thread)
+      end
+    end
+
+    def backtrace_for(thread)
+      if thread.backtrace
+        thread.backtrace.join("\n")
+      else
+        '<no backtrace available>'
+      end
+    end
+
     attr_accessor :sig_read, :sig_write
 
     def wait_for_signal
       IO.select([sig_read])
     end
 
     def register_signal_handlers
-      SHUTDOWN_SIGNALS.each do |sig|
+      REGISTERED_SIGNALS.each do |sig|
         # This needs to be reentrant, so we queue up signals to be handled
         # in the run loop, rather than acting on signals here
         trap(sig) do
           sig_write.puts(sig)
         end
       end
     end
+
+    def user_signal?(sig)
+      USER_SIGNALS.include?(sig)
+    end
   end
 end

spec/hutch/waiter_spec.rb

@@ -20,7 +20,7 @@ def start_kill_thread(signal)
       context "a #{signal} signal is received" do
         it "logs that hutch is stopping" do
           expect(Hutch::Logging.logger).to receive(:info)
-            .with("caught sig#{signal.downcase}, stopping hutch...")
+            .with("caught SIG#{signal}, stopping hutch...")
 
           start_kill_thread(signal)
           described_class.wait_until_signaled