puma 2.1.1 → 7.2.1

data/lib/puma/single.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative 'runner'
+require_relative 'detect'
+require_relative 'plugin'
+
+module Puma
+  # This class is instantiated by the `Puma::Launcher` and used
+  # to boot and serve a Ruby application when no puma "workers" are needed
+  # i.e. only using "threaded" mode. For example `$ puma -t 1:5`
+  #
+  # At the core of this class is running an instance of `Puma::Server` which
+  # gets created via the `start_server` method from the `Puma::Runner` class
+  # that this inherits from.
+  class Single < Runner
+    # @!attribute [r] stats
+    def stats
+      {
+        started_at: utc_iso8601(@started_at)
+      }.merge(@server&.stats || {}).merge(super)
+    end
+
+    def restart
+      @server&.begin_restart
+    end
+
+    def stop
+      @server&.stop false
+    end
+
+    def halt
+      @server&.halt
+    end
+
+    def stop_blocked
+      log "- Gracefully stopping, waiting for requests to finish"
+      @control&.stop true
+      @server&.stop true
+    end
+
+    def run
+      output_header "single"
+
+      load_and_bind
+
+      Plugins.fire_background
+
+      @launcher.write_state
+
+      start_control
+
+      @server = start_server
+      server_thread = @server.run
+
+      log "Use Ctrl-C to stop"
+
+      warn_ruby_mn_threads
+
+      redirect_io
+
+      @events.fire_after_booted!
+
+      debug_loaded_extensions("Loaded Extensions:") if @log_writer.debug?
+
+      begin
+        server_thread.join
+      rescue Interrupt
+        # Swallow it
+      end
+    end
+  end
+end

data/lib/puma/state_file.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Puma
+
+  # Puma::Launcher uses StateFile to write a yaml file for use with Puma::ControlCLI.
+  #
+  # In previous versions of Puma, YAML was used to read/write the state file.
+  # Since Puma is similar to Bundler/RubyGems in that it may load before one's app
+  # does, minimizing the dependencies that may be shared with the app is desired.
+  #
+  # At present, it only works with numeric and string values.  It is still a valid
+  # yaml file, and the CI tests parse it with Psych.
+  #
+  class StateFile
+
+    ALLOWED_FIELDS = %w!control_url control_auth_token pid running_from!
+
+    def initialize
+      @options = {}
+    end
+
+    def save(path, permission = nil)
+      contents = +"---\n"
+      @options.each do |k,v|
+        next unless ALLOWED_FIELDS.include? k
+        case v
+        when Numeric
+          contents << "#{k}: #{v}\n"
+        when String
+          next if v.strip.empty?
+          contents << (k == 'running_from' || v.to_s.include?(' ') ?
+            "#{k}: \"#{v}\"\n" : "#{k}: #{v}\n")
+        end
+      end
+
+      if permission
+        File.write path, contents, mode: 'wb:UTF-8', perm: permission
+      else
+        File.write path, contents, mode: 'wb:UTF-8'
+      end
+    end
+
+    def load(path)
+      File.read(path).lines.each do |line|
+        next if line.start_with? '#'
+        k,v = line.split ':', 2
+        next unless v && ALLOWED_FIELDS.include?(k)
+        v = v.strip
+        @options[k] =
+          case v
+          when ''              then nil
+          when /\A\d+\z/       then v.to_i
+          when /\A\d+\.\d+\z/  then v.to_f
+          else                      v.gsub(/\A"|"\z/, '')
+          end
+      end
+    end
+
+    ALLOWED_FIELDS.each do |f|
+      define_method f.to_sym do
+        @options[f]
+      end
+
+      define_method :"#{f}=" do |v|
+        @options[f] = v
+      end
+    end
+  end
+end

data/lib/puma/thread_pool.rb

@@ -1,9 +1,35 @@
+# frozen_string_literal: true
+
 require 'thread'
 
+require_relative 'io_buffer'
+
 module Puma
-  # A simple thread pool management object.
+
+  # Add `Thread#puma_server` and `Thread#puma_server=`
+  Thread.attr_accessor(:puma_server)
+
+  # Internal Docs for A simple thread pool management object.
+  #
+  # Each Puma "worker" has a thread pool to process requests.
+  #
+  # First a connection to a client is made in `Puma::Server`. It is wrapped in a
+  # `Puma::Client` instance and then passed to the `Puma::Reactor` to ensure
+  # the whole request is buffered into memory. Once the request is ready, it is passed into
+  # a thread pool via the `Puma::ThreadPool#<<` operator where it is stored in a `@todo` array.
   #
+  # Each thread in the pool has an internal loop where it pulls a request from the `@todo` array
+  # and processes it.
   class ThreadPool
+    class ForceShutdown < RuntimeError
+    end
+
+    # How long, after raising the ForceShutdown of a thread during
+    # forced shutdown mode, to wait for the thread to try and finish
+    # up its work before leaving the thread to die on the vine.
+    SHUTDOWN_GRACE_TIME = 5 # seconds
+
+    attr_reader :out_of_band_running
 
     # Maintain a minimum of +min+ and maximum of +max+ threads
     # in the pool.
@@ -11,39 +37,97 @@ module Puma
     # The block passed is the work that will be performed in each
     # thread.
     #
-    def initialize(min, max, *extra, &blk)
-      @cond = ConditionVariable.new
-      @mutex = Mutex.new
+    def initialize(name, options = {}, server: nil, &block)
+      @server = server
 
-      @todo = []
+      @not_empty = ConditionVariable.new
+      @not_full = ConditionVariable.new
+      @mutex = Mutex.new
+      @todo = Queue.new
 
+      @backlog_max = 0
       @spawned = 0
       @waiting = 0
 
-      @min = min
-      @max = max
-      @block = blk
-      @extra = extra
+      @name = name
+      @min = Integer(options[:min_threads])
+      @max = Integer(options[:max_threads])
+      # Not an 'exposed' option, options[:pool_shutdown_grace_time] is used in CI
+      # to shorten @shutdown_grace_time from SHUTDOWN_GRACE_TIME. Parallel CI
+      # makes stubbing constants difficult.
+      @shutdown_grace_time = Float(options[:pool_shutdown_grace_time] || SHUTDOWN_GRACE_TIME)
+      @block = block
+      @out_of_band = options[:out_of_band]
+      @out_of_band_running = false
+      @out_of_band_condvar = ConditionVariable.new
+      @before_thread_start = options[:before_thread_start]
+      @before_thread_exit = options[:before_thread_exit]
+      @reaping_time = options[:reaping_time]
+      @auto_trim_time = options[:auto_trim_time]
 
       @shutdown = false
 
       @trim_requested = 0
+      @out_of_band_pending = false
 
       @workers = []
 
       @auto_trim = nil
+      @reaper = nil
 
       @mutex.synchronize do
-        min.times { spawn_thread }
+        @min.times do
+          spawn_thread
+          @not_full.wait(@mutex)
+        end
+      end
+
+      @force_shutdown = false
+      @shutdown_mutex = Mutex.new
+    end
+
+    attr_reader :spawned, :trim_requested, :waiting
+
+    # generate stats hash so as not to perform multiple locks
+    # @return [Hash] hash containing stat info from ThreadPool
+    def stats
+      with_mutex do
+        temp = @backlog_max
+        @backlog_max = 0
+        { backlog: @todo.size,
+          running: @spawned,
+          pool_capacity: @waiting + (@max - @spawned),
+          busy_threads: @spawned - @waiting + @todo.size,
+          backlog_max: temp
+        }
       end
     end
 
-    attr_reader :spawned, :trim_requested
+    def reset_max
+      with_mutex { @backlog_max = 0 }
+    end
 
     # How many objects have yet to be processed by the pool?
     #
     def backlog
-      @mutex.synchronize { @todo.size }
+      with_mutex { @todo.size }
+    end
+
+    # The maximum size of the backlog
+    #
+    def backlog_max
+      with_mutex { @backlog_max }
+    end
+
+    # @!attribute [r] pool_capacity
+    def pool_capacity
+      waiting + (@max - spawned)
+    end
+
+    # @!attribute [r] busy_threads
+    # @version 5.0.0
+    def busy_threads
+      with_mutex { @spawned - @waiting + @todo.size }
     end
 
     # :nodoc:
@@ -53,48 +137,52 @@ module Puma
     def spawn_thread
       @spawned += 1
 
-      th = Thread.new do
+      trigger_before_thread_start_hooks
+      th = Thread.new(@spawned) do |spawned|
+        Puma.set_thread_name '%s tp %03i' % [@name, spawned]
+        # Advertise server into the thread
+        Thread.current.puma_server = @server
+
         todo  = @todo
         block = @block
         mutex = @mutex
-        cond  = @cond
-
-        extra = @extra.map { |i| i.new }
+        not_empty = @not_empty
+        not_full = @not_full
 
         while true
           work = nil
 
-          continue = true
-
           mutex.synchronize do
             while todo.empty?
               if @trim_requested > 0
                 @trim_requested -= 1
-                continue = false
-                break
-              end
-
-              if @shutdown
-                continue = false
-                break
+                @spawned -= 1
+                @workers.delete th
+                not_full.signal
+                trigger_before_thread_exit_hooks
+                Thread.exit
               end
 
               @waiting += 1
-              cond.wait mutex
-              @waiting -= 1
+              if @out_of_band_pending && trigger_out_of_band_hook
+                @out_of_band_pending = false
+              end
+              not_full.signal
+              begin
+                not_empty.wait mutex
+              ensure
+                @waiting -= 1
+              end
             end
 
-            work = todo.pop if continue
+            work = todo.shift
           end
 
-          break unless continue
-
-          block.call(work, *extra)
-        end
-
-        mutex.synchronize do
-          @spawned -= 1
-          @workers.delete th
+          begin
+            @out_of_band_pending = true if block.call(work)
+          rescue Exception => e
+            STDERR.puts "Error reached top of thread-pool: #{e.message} (#{e.class})"
+          end
         end
       end
 
@@ -105,40 +193,126 @@ module Puma
 
     private :spawn_thread
 
+    def trigger_before_thread_start_hooks
+      return unless @before_thread_start&.any?
+
+      @before_thread_start.each do |b|
+        begin
+          b[:block].call
+        rescue Exception => e
+          STDERR.puts "WARNING before_thread_start hook failed with exception (#{e.class}) #{e.message}"
+        end
+      end
+      nil
+    end
+
+    private :trigger_before_thread_start_hooks
+
+    def trigger_before_thread_exit_hooks
+      return unless @before_thread_exit&.any?
+
+      @before_thread_exit.each do |b|
+        begin
+          b[:block].call
+        rescue Exception => e
+          STDERR.puts "WARNING before_thread_exit hook failed with exception (#{e.class}) #{e.message}"
+        end
+      end
+      nil
+    end
+
+    private :trigger_before_thread_exit_hooks
+
+    # @version 5.0.0
+    def trigger_out_of_band_hook
+      return false unless @out_of_band&.any?
+
+      # we execute on idle hook when all threads are free
+      return false unless @spawned == @waiting
+      @out_of_band_running = true
+      @out_of_band.each { |b| b[:block].call }
+      true
+    rescue Exception => e
+      STDERR.puts "Exception calling out_of_band_hook: #{e.message} (#{e.class})"
+      true
+    ensure
+      @out_of_band_running = false
+      @out_of_band_condvar.broadcast
+    end
+
+    private :trigger_out_of_band_hook
+
+    def wait_while_out_of_band_running
+      return unless @out_of_band_running
+
+      with_mutex do
+        @out_of_band_condvar.wait(@mutex) while @out_of_band_running
+      end
+    end
+
+    # @version 5.0.0
+    def with_mutex(&block)
+      @mutex.owned? ?
+        yield :
+        @mutex.synchronize(&block)
+    end
+
     # Add +work+ to the todo list for a Thread to pickup and process.
     def <<(work)
-      @mutex.synchronize do
+      with_mutex do
         if @shutdown
           raise "Unable to add work while shutting down"
         end
 
         @todo << work
+        t = @todo.size
+        @backlog_max = t if t > @backlog_max
 
-        if @waiting == 0 and @spawned < @max
+        if @waiting < @todo.size and @spawned < @max
           spawn_thread
         end
 
-        @cond.signal
+        @not_empty.signal
       end
     end
 
-    # If too many threads are in the pool, tell one to finish go ahead
+    # If there are any free threads in the pool, tell one to go ahead
     # and exit. If +force+ is true, then a trim request is requested
     # even if all threads are being utilized.
     #
     def trim(force=false)
-      @mutex.synchronize do
-        if (force or @waiting > 0) and @spawned - @trim_requested > @min
+      with_mutex do
+        free = @waiting - @todo.size
+        if (force or free > 0) and @spawned - @trim_requested > @min
           @trim_requested += 1
-          @cond.signal
+          @not_empty.signal
         end
       end
     end
 
-    class AutoTrim
-      def initialize(pool, timeout)
+    # If there are dead threads in the pool make them go away while decreasing
+    # spawned counter so that new healthy threads could be created again.
+    def reap
+      with_mutex do
+        dead_workers = @workers.reject(&:alive?)
+
+        dead_workers.each do |worker|
+          worker.kill
+          @spawned -= 1
+        end
+
+        @workers.delete_if do |w|
+          dead_workers.include?(w)
+        end
+      end
+    end
+
+    class Automaton
+      def initialize(pool, timeout, thread_name, message)
         @pool = pool
         @timeout = timeout
+        @thread_name = thread_name
+        @message = message
         @running = false
       end
 
@@ -146,8 +320,9 @@ module Puma
         @running = true
 
         @thread = Thread.new do
+          Puma.set_thread_name @thread_name
           while @running
-            @pool.trim
+            @pool.public_send(@message)
             sleep @timeout
           end
         end
@@ -159,24 +334,75 @@ module Puma
       end
     end
 
-    def auto_trim!(timeout=5)
-      @auto_trim = AutoTrim.new(self, timeout)
+    def auto_trim!(timeout=@auto_trim_time)
+      @auto_trim = Automaton.new(self, timeout, "#{@name} tp trim", :trim)
       @auto_trim.start!
     end
 
+    def auto_reap!(timeout=@reaping_time)
+      @reaper = Automaton.new(self, timeout, "#{@name} tp reap", :reap)
+      @reaper.start!
+    end
+
+    # Allows ThreadPool::ForceShutdown to be raised within the
+    # provided block if the thread is forced to shutdown during execution.
+    def with_force_shutdown
+      t = Thread.current
+      @shutdown_mutex.synchronize do
+        raise ForceShutdown if @force_shutdown
+        t[:with_force_shutdown] = true
+      end
+      yield
+    ensure
+      t[:with_force_shutdown] = false
+    end
+
     # Tell all threads in the pool to exit and wait for them to finish.
+    # Wait +timeout+ seconds then raise +ForceShutdown+ in remaining threads.
+    # Next, wait an extra +@shutdown_grace_time+ seconds then force-kill remaining
+    # threads. Finally, wait 1 second for remaining threads to exit.
     #
-    def shutdown
-      @mutex.synchronize do
+    def shutdown(timeout=-1)
+      threads = with_mutex do
         @shutdown = true
-        @cond.broadcast
-
-        @auto_trim.stop if @auto_trim
+        @trim_requested = @spawned
+        @not_empty.broadcast
+        @not_full.broadcast
+
+        @auto_trim&.stop
+        @reaper&.stop
+        # dup workers so that we join them all safely
+        @workers.dup
       end
 
-      # Use this instead of #each so that we don't stop in the middle
-      # of each and see a mutated object mid #each
-      @workers.first.join until @workers.empty?
+      if timeout == -1
+        # Wait for threads to finish without force shutdown.
+        threads.each(&:join)
+      else
+        join = ->(inner_timeout) do
+          start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          threads.reject! do |t|
+            elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
+            t.join inner_timeout - elapsed
+          end
+        end
+
+        # Wait +timeout+ seconds for threads to finish.
+        join.call(timeout)
+
+        # If threads are still running, raise ForceShutdown and wait to finish.
+        @shutdown_mutex.synchronize do
+          @force_shutdown = true
+          threads.each do |t|
+            t.raise ForceShutdown if t[:with_force_shutdown]
+          end
+        end
+        join.call(@shutdown_grace_time)
+
+        # If threads are _still_ running, forcefully kill them and wait to finish.
+        threads.each(&:kill)
+        join.call(1)
+      end
 
       @spawned = 0
       @workers = []