puma 6.4.3 → 8.0.2

data/lib/puma/thread_pool.rb

@@ -3,8 +3,13 @@
 require 'thread'
 
 require_relative 'io_buffer'
+require_relative 'server_plugin_control'
 
 module Puma
+
+  # 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.
@@ -20,37 +25,90 @@ module Puma
     class ForceShutdown < RuntimeError
     end
 
+    class ProcessorThread
+      attr_accessor :thread
+      attr_writer :marked_as_io_thread
+
+      def initialize(pool)
+        @pool = pool
+        @thread = nil
+        @marked_as_io_thread = false
+      end
+
+      def mark_as_io_thread!
+        unless @marked_as_io_thread
+          @marked_as_io_thread = true
+
+          # Immediately signal the pool that it can spawn a new thread
+          # if there's some work in the queue.
+          @pool.spawn_thread_if_needed
+        end
+      end
+
+      def marked_as_io_thread?
+        @marked_as_io_thread
+      end
+
+      def alive?
+        @thread&.alive?
+      end
+
+      def join(...)
+        @thread.join(...)
+      end
+
+      def kill(...)
+        @thread.kill(...)
+      end
+
+      def [](key)
+        @thread[key]
+      end
+
+      def raise(...)
+        @thread.raise(...)
+      end
+    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.
     #
     # The block passed is the work that will be performed in each
     # thread.
     #
-    def initialize(name, options = {}, &block)
+    def initialize(name, options = {}, server: nil, &block)
+      @server = server
+
       @not_empty = ConditionVariable.new
       @not_full = ConditionVariable.new
       @mutex = Mutex.new
+      @todo = Queue.new
 
-      @todo = []
-
+      @backlog_max = 0
       @spawned = 0
       @waiting = 0
 
       @name = name
       @min = Integer(options[:min_threads])
       @max = Integer(options[:max_threads])
+      @max_io_threads = Integer(options[:max_io_threads] || 0)
+
       # 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)
+      @shutdown_debug = options[:shutdown_debug]
       @block = block
       @out_of_band = options[:out_of_band]
-      @clean_thread_locals = options[:clean_thread_locals]
+      @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]
@@ -61,7 +119,7 @@ module Puma
       @trim_requested = 0
       @out_of_band_pending = false
 
-      @workers = []
+      @processors = []
 
       @auto_trim = nil
       @reaper = nil
@@ -78,22 +136,43 @@ module Puma
     end
 
     attr_reader :spawned, :trim_requested, :waiting
+    attr_accessor :min, :max
 
-    def self.clean_thread_locals
-      Thread.current.keys.each do |key| # rubocop: disable Style/HashEachMethods
-        Thread.current[key] = nil unless key == :__recursive_key__
+    # 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: pool_capacity,
+          busy_threads: @spawned - @waiting + @todo.size,
+          io_threads: @processors.count(&:marked_as_io_thread?),
+          backlog_max: temp
+        }
       end
     end
 
+    def reset_max
+      with_mutex { @backlog_max = 0 }
+    end
+
     # How many objects have yet to be processed by the pool?
     #
     def backlog
       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)
+      (waiting + (@max - spawned)).clamp(0, Float::INFINITY)
     end
 
     # @!attribute [r] busy_threads
@@ -110,8 +189,12 @@ module Puma
       @spawned += 1
 
       trigger_before_thread_start_hooks
-      th = Thread.new(@spawned) do |spawned|
+      processor = ProcessorThread.new(self)
+      processor.thread = Thread.new(processor, @spawned) do |processor, 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
@@ -122,11 +205,23 @@ module Puma
           work = nil
 
           mutex.synchronize do
+            if processor.marked_as_io_thread?
+              if @processors.count { |t| !t.marked_as_io_thread? } < @max
+                # We're not at max processor threads, so the io thread can rejoin the normal population.
+                processor.marked_as_io_thread = false
+              else
+                # We're already at max threads, so we exit the extra io thread.
+                @processors.delete(processor)
+                trigger_before_thread_exit_hooks
+                Thread.exit
+              end
+            end
+
             while todo.empty?
               if @trim_requested > 0
                 @trim_requested -= 1
                 @spawned -= 1
-                @workers.delete th
+                @processors.delete(processor)
                 not_full.signal
                 trigger_before_thread_exit_hooks
                 Thread.exit
@@ -147,21 +242,17 @@ module Puma
             work = todo.shift
           end
 
-          if @clean_thread_locals
-            ThreadPool.clean_thread_locals
-          end
-
           begin
-            @out_of_band_pending = true if block.call(work)
+            @out_of_band_pending = true if block.call(processor, work)
           rescue Exception => e
             STDERR.puts "Error reached top of thread-pool: #{e.message} (#{e.class})"
           end
         end
       end
 
-      @workers << th
+      @processors << processor
 
-      th
+      processor
     end
 
     private :spawn_thread
@@ -171,7 +262,7 @@ module Puma
 
       @before_thread_start.each do |b|
         begin
-          b.call
+          b[:block].call(ServerPluginControl.new(@server))
         rescue Exception => e
           STDERR.puts "WARNING before_thread_start hook failed with exception (#{e.class}) #{e.message}"
         end
@@ -186,7 +277,7 @@ module Puma
 
       @before_thread_exit.each do |b|
         begin
-          b.call
+          b[:block].call
         rescue Exception => e
           STDERR.puts "WARNING before_thread_exit hook failed with exception (#{e.class}) #{e.message}"
         end
@@ -202,16 +293,27 @@ module Puma
 
       # we execute on idle hook when all threads are free
       return false unless @spawned == @waiting
-
-      @out_of_band.each(&:call)
+      @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? ?
@@ -219,6 +321,16 @@ module Puma
         @mutex.synchronize(&block)
     end
 
+    # :nodoc:
+    #
+    # Must be called with @mutex held!
+    #
+    def can_spawn_processor?
+      io_processors_count = @processors.count(&:marked_as_io_thread?)
+      extra_io_processors_count = io_processors_count > @max_io_threads ? io_processors_count - @max_io_threads : 0
+      (@spawned - io_processors_count) < (@max - extra_io_processors_count)
+    end
+
     # Add +work+ to the todo list for a Thread to pickup and process.
     def <<(work)
       with_mutex do
@@ -227,78 +339,26 @@ module Puma
         end
 
         @todo << work
+        t = @todo.size
+        @backlog_max = t if t > @backlog_max
 
-        if @waiting < @todo.size and @spawned < @max
+        if @waiting < @todo.size and can_spawn_processor?
           spawn_thread
         end
 
         @not_empty.signal
       end
+      self
     end
 
-    # This method is used by `Puma::Server` to let the server know when
-    # the thread pool can pull more requests from the socket and
-    # pass to the reactor.
-    #
-    # The general idea is that the thread pool can only work on a fixed
-    # number of requests at the same time. If it is already processing that
-    # number of requests then it is at capacity. If another Puma process has
-    # spare capacity, then the request can be left on the socket so the other
-    # worker can pick it up and process it.
-    #
-    # For example: if there are 5 threads, but only 4 working on
-    # requests, this method will not wait and the `Puma::Server`
-    # can pull a request right away.
-    #
-    # If there are 5 threads and all 5 of them are busy, then it will
-    # pause here, and wait until the `not_full` condition variable is
-    # signaled, usually this indicates that a request has been processed.
-    #
-    # It's important to note that even though the server might accept another
-    # request, it might not be added to the `@todo` array right away.
-    # For example if a slow client has only sent a header, but not a body
-    # then the `@todo` array would stay the same size as the reactor works
-    # to try to buffer the request. In that scenario the next call to this
-    # method would not block and another request would be added into the reactor
-    # by the server. This would continue until a fully buffered request
-    # makes it through the reactor and can then be processed by the thread pool.
-    def wait_until_not_full
+    def spawn_thread_if_needed # :nodoc:
       with_mutex do
-        while true
-          return if @shutdown
-
-          # If we can still spin up new threads and there
-          # is work queued that cannot be handled by waiting
-          # threads, then accept more work until we would
-          # spin up the max number of threads.
-          return if busy_threads < @max
-
-          @not_full.wait @mutex
+        if @waiting < @todo.size and can_spawn_processor?
+          spawn_thread
         end
       end
     end
 
-    # @version 5.0.0
-    def wait_for_less_busy_worker(delay_s)
-      return unless delay_s && delay_s > 0
-
-      # Ruby MRI does GVL, this can result
-      # in processing contention when multiple threads
-      # (requests) are running concurrently
-      return unless Puma.mri?
-
-      with_mutex do
-        return if @shutdown
-
-        # do not delay, if we are not busy
-        return unless busy_threads > 0
-
-        # this will be signaled once a request finishes,
-        # which can happen earlier than delay
-        @not_full.wait @mutex, delay_s
-      end
-    end
-
     # 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.
@@ -317,16 +377,12 @@ module Puma
     # spawned counter so that new healthy threads could be created again.
     def reap
       with_mutex do
-        dead_workers = @workers.reject(&:alive?)
+        @processors, dead_processors = @processors.partition(&:alive?)
 
-        dead_workers.each do |worker|
-          worker.kill
+        dead_processors.each do |processor|
+          processor.kill
           @spawned -= 1
         end
-
-        @workers.delete_if do |w|
-          dead_workers.include?(w)
-        end
       end
     end
 
@@ -358,12 +414,12 @@ module Puma
     end
 
     def auto_trim!(timeout=@auto_trim_time)
-      @auto_trim = Automaton.new(self, timeout, "#{@name} threadpool trimmer", :trim)
+      @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} threadpool reaper", :reap)
+      @reaper = Automaton.new(self, timeout, "#{@name} tp reap", :reap)
       @reaper.start!
     end
 
@@ -385,7 +441,7 @@ module Puma
     # Next, wait an extra +@shutdown_grace_time+ seconds then force-kill remaining
     # threads. Finally, wait 1 second for remaining threads to exit.
     #
-    def shutdown(timeout=-1)
+    def shutdown(timeout)
       threads = with_mutex do
         @shutdown = true
         @trim_requested = @spawned
@@ -394,8 +450,12 @@ module Puma
 
         @auto_trim&.stop
         @reaper&.stop
-        # dup workers so that we join them all safely
-        @workers.dup
+        # dup processors so that we join them all safely
+        @processors.dup
+      end
+
+      if @shutdown_debug == true
+        shutdown_debug("Shutdown initiated")
       end
 
       if timeout == -1
@@ -405,13 +465,16 @@ module Puma
         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
+            remaining = inner_timeout - (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start)
+            remaining > 0 && t.join(remaining)
           end
         end
 
         # Wait +timeout+ seconds for threads to finish.
         join.call(timeout)
+        if @shutdown_debug == :on_force && !threads.empty?
+          shutdown_debug("Shutdown timeout exceeded")
+        end
 
         # If threads are still running, raise ForceShutdown and wait to finish.
         @shutdown_mutex.synchronize do
@@ -421,6 +484,9 @@ module Puma
           end
         end
         join.call(@shutdown_grace_time)
+        if @shutdown_debug == :on_force && !threads.empty?
+          shutdown_debug("Shutdown grace timeout exceeded")
+        end
 
         # If threads are _still_ running, forcefully kill them and wait to finish.
         threads.each(&:kill)
@@ -428,7 +494,24 @@ module Puma
       end
 
       @spawned = 0
-      @workers = []
+      @processors = []
+    end
+
+    private
+
+    def shutdown_debug(message)
+      pid = Process.pid
+      threads = Thread.list
+
+      $stdout.syswrite "#{pid}: #{message}\n"
+      $stdout.syswrite "#{pid}: === Begin thread backtrace dump ===\n"
+
+      threads.each_with_index do |thread, index|
+        $stdout.syswrite "#{pid}: Thread #{index + 1}/#{threads.size}: #{thread.inspect}\n"
+        $stdout.syswrite "#{pid}: #{(thread.backtrace || []).join("\n#{pid}: ")}\n\n"
+      end
+
+      $stdout.syswrite "#{pid}: === End thread backtrace dump ===\n"
     end
   end
 end

data/lib/puma/util.rb

@@ -10,13 +10,6 @@ module Puma
       IO.pipe
     end
 
-    # An instance method on Thread has been provided to address https://bugs.ruby-lang.org/issues/13632,
-    # which currently effects some older versions of Ruby: 2.2.7 2.2.8 2.2.9 2.2.10 2.3.4 2.4.1
-    # Additional context: https://github.com/puma/puma/pull/1345
-    def purge_interrupt_queue
-      Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
-    end
-
     # Escapes and unescapes a URI escaped string with
     # +encoding+. +encoding+ will be the target encoding of the string
     # returned, and it defaults to UTF-8

data/lib/puma.rb

@@ -75,4 +75,14 @@ module Puma
   def self.set_thread_name(name)
     Thread.current.name = "puma #{name}"
   end
+
+  # Shows deprecated warning for renamed methods.
+  # @example
+  #   Puma.deprecate_method_change :on_booted, __callee__, __method__
+  #
+  def self.deprecate_method_change(method_old, method_caller, method_new)
+    if method_old == method_caller
+      warn "Use '#{method_new}', '#{method_caller}' is deprecated and will be removed in v8"
+    end
+  end
 end

data/lib/rack/handler/puma.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
-# This module is used as an 'include' file in code at bottom of file
 module Puma
+
+  # This module is used as an 'include' file in code at bottom of file. It loads
+  # into either `Rackup::Handler::Puma` or `Rack::Handler::Puma`.
+
   module RackHandler
     DEFAULT_OPTIONS = {
       :Verbose => false,
@@ -29,7 +32,7 @@ module Puma
 
       @events = options[:events] || ::Puma::Events.new
 
-      conf = ::Puma::Configuration.new(options, default_options.merge({events: @events})) do |user_config, file_config, default_config|
+      conf = ::Puma::Configuration.new(options, default_options.merge({ events: @events })) do |user_config, file_config, default_config|
         if options.delete(:Verbose)
           begin
             require 'rack/commonlogger'  # Rack 1.x
@@ -69,7 +72,7 @@ module Puma
 
       log_writer = options.delete(:Silent) ? ::Puma::LogWriter.strings : ::Puma::LogWriter.stdio
 
-      launcher = ::Puma::Launcher.new(conf, :log_writer => log_writer, events: @events)
+      launcher = ::Puma::Launcher.new(conf, log_writer: log_writer, events: @events)
 
       yield launcher if block_given?
       begin
@@ -93,9 +96,9 @@ module Puma
     def set_host_port_to_config(host, port, config)
       config.clear_binds! if host || port
 
-      if host && (host[0,1] == '.' || host[0,1] == '/')
+      if host&.start_with? '.', '/', '@'
         config.bind "unix://#{host}"
-      elsif host && host =~ /^ssl:\/\//
+      elsif host&.start_with? 'ssl://'
         uri = URI.parse(host)
         uri.port ||= port || ::Puma::Configuration::DEFAULTS[:tcp_port]
         config.bind uri.to_s
@@ -106,7 +109,7 @@ module Puma
         end
 
         if port
-          host ||= ::Puma::Configuration::DEFAULTS[:tcp_host]
+          host ||= ::Puma::Configuration.default_tcp_host
           config.port port, host
         end
       end
@@ -115,7 +118,7 @@ module Puma
 end
 
 # rackup was removed in Rack 3, it is now a separate gem
-if Object.const_defined? :Rackup
+if Object.const_defined?(:Rackup) && ::Rackup.const_defined?(:Handler)
   module Rackup
     module Handler
       module Puma
@@ -127,7 +130,7 @@ if Object.const_defined? :Rackup
     end
   end
 else
-  do_register = Object.const_defined?(:Rack) && Rack.release < '3'
+  do_register = Object.const_defined?(:Rack) && ::Rack.release < '3'
   module Rack
     module Handler
       module Puma

data/tools/Dockerfile

@@ -1,16 +1,26 @@
 # Use this Dockerfile to create minimal reproductions of issues
+# Build (MRI): docker build -f tools/Dockerfile .
+# Build (JRuby): docker build -f tools/Dockerfile --build-arg RUBY_IMAGE=jruby:9.4 .
 
-FROM ruby:3.2
+ARG RUBY_IMAGE=ruby:latest
+FROM ${RUBY_IMAGE}
 
-# throw errors if Gemfile has been modified since Gemfile.lock
-RUN bundle config --global frozen 1
+# Set BUNDLE_FROZEN=false if you need to update Gemfile.lock during a build.
+ARG BUNDLE_FROZEN=true
+
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends ragel procps git \
+  && rm -rf /var/lib/apt/lists/*
+
+# Only freeze Bundler and compile native extensions when using MRI.
+RUN if [ "$(ruby -e 'print RUBY_ENGINE')" = "ruby" ] && [ "${BUNDLE_FROZEN}" = "true" ]; then bundle config --global frozen 1; fi
 
 WORKDIR /usr/src/app
 
 COPY . .
 
 RUN bundle install
-RUN bundle exec rake compile
+RUN if [ "$(ruby -e 'print RUBY_ENGINE')" = "ruby" ]; then bundle exec rake compile; fi
 
 EXPOSE 9292
-CMD bundle exec bin/puma test/rackup/hello.ru
+CMD ["bundle", "exec", "bin/puma", "test/rackup/hello.ru"]