puma 7.0.4 → 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,6 +25,51 @@ 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.
@@ -33,7 +83,9 @@ module Puma
     # 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
@@ -46,10 +98,13 @@ module Puma
       @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]
       @out_of_band_running = false
@@ -64,7 +119,7 @@ module Puma
       @trim_requested = 0
       @out_of_band_pending = false
 
-      @workers = []
+      @processors = []
 
       @auto_trim = nil
       @reaper = nil
@@ -81,6 +136,7 @@ module Puma
     end
 
     attr_reader :spawned, :trim_requested, :waiting
+    attr_accessor :min, :max
 
     # generate stats hash so as not to perform multiple locks
     # @return [Hash] hash containing stat info from ThreadPool
@@ -90,8 +146,9 @@ module Puma
         @backlog_max = 0
         { backlog: @todo.size,
           running: @spawned,
-          pool_capacity: @waiting + (@max - @spawned),
+          pool_capacity: pool_capacity,
           busy_threads: @spawned - @waiting + @todo.size,
+          io_threads: @processors.count(&:marked_as_io_thread?),
           backlog_max: temp
         }
       end
@@ -115,7 +172,7 @@ module Puma
 
     # @!attribute [r] pool_capacity
     def pool_capacity
-      waiting + (@max - spawned)
+      (waiting + (@max - spawned)).clamp(0, Float::INFINITY)
     end
 
     # @!attribute [r] busy_threads
@@ -132,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
@@ -144,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
@@ -170,16 +243,16 @@ module Puma
           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
@@ -189,7 +262,7 @@ module Puma
 
       @before_thread_start.each do |b|
         begin
-          b[:block].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
@@ -248,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
@@ -259,12 +342,21 @@ module Puma
         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
+
+    def spawn_thread_if_needed # :nodoc:
+      with_mutex do
+        if @waiting < @todo.size and can_spawn_processor?
+          spawn_thread
+        end
+      end
     end
 
     # If there are any free threads in the pool, tell one to go ahead
@@ -285,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
 
@@ -353,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
@@ -362,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
@@ -373,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
@@ -389,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)
@@ -396,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/rack/handler/puma.rb

@@ -109,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

data/tools/Dockerfile

@@ -1,18 +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}
 
-RUN apt-get update && apt-get install -y ragel
+# Set BUNDLE_FROZEN=false if you need to update Gemfile.lock during a build.
+ARG BUNDLE_FROZEN=true
 
-# throw errors if Gemfile has been modified since Gemfile.lock
-RUN bundle config --global frozen 1
+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"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 7.0.4
+  version: 8.0.2
 platform: ruby
 authors:
 - Evan Phoenix
@@ -43,13 +43,21 @@ files:
 - bin/puma
 - bin/puma-wild
 - bin/pumactl
+- docs/5.0-Upgrade.md
+- docs/6.0-Upgrade.md
+- docs/7.0-Upgrade.md
+- docs/8.0-Upgrade.md
 - docs/architecture.md
 - docs/compile_options.md
 - docs/deployment.md
 - docs/fork_worker.md
+- docs/grpc.md
+- docs/images/favicon.svg
 - docs/images/puma-connection-flow-no-reactor.png
 - docs/images/puma-connection-flow.png
 - docs/images/puma-general-arch.png
+- docs/images/running-puma.svg
+- docs/images/standard-logo.svg
 - docs/java_options.md
 - docs/jungle/README.md
 - docs/jungle/rc.d/README.md
@@ -66,7 +74,6 @@ files:
 - docs/testing_benchmarks_local_files.md
 - docs/testing_test_rackup_ci_files.md
 - ext/puma_http11/PumaHttp11Service.java
-- ext/puma_http11/ext_help.h
 - ext/puma_http11/extconf.rb
 - ext/puma_http11/http11_parser.c
 - ext/puma_http11/http11_parser.h
@@ -75,6 +82,7 @@ files:
 - ext/puma_http11/http11_parser_common.rl
 - ext/puma_http11/mini_ssl.c
 - ext/puma_http11/no_ssl/PumaHttp11Service.java
+- ext/puma_http11/org/jruby/puma/EnvKey.java
 - ext/puma_http11/org/jruby/puma/Http11.java
 - ext/puma_http11/org/jruby/puma/Http11Parser.java
 - ext/puma_http11/org/jruby/puma/MiniSSL.java
@@ -84,6 +92,7 @@ files:
 - lib/puma/binder.rb
 - lib/puma/cli.rb
 - lib/puma/client.rb
+- lib/puma/client_env.rb
 - lib/puma/cluster.rb
 - lib/puma/cluster/worker.rb
 - lib/puma/cluster/worker_handle.rb
@@ -112,10 +121,11 @@ files:
 - lib/puma/rack/urlmap.rb
 - lib/puma/rack_default.rb
 - lib/puma/reactor.rb
-- lib/puma/request.rb
+- lib/puma/response.rb
 - lib/puma/runner.rb
 - lib/puma/sd_notify.rb
 - lib/puma/server.rb
+- lib/puma/server_plugin_control.rb
 - lib/puma/single.rb
 - lib/puma/state_file.rb
 - lib/puma/thread_pool.rb
@@ -128,10 +138,11 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/puma/puma/issues
-  changelog_uri: https://github.com/puma/puma/blob/master/History.md
+  changelog_uri: https://github.com/puma/puma/blob/main/History.md
   homepage_uri: https://puma.io
   source_code_uri: https://github.com/puma/puma
   rubygems_mfa_required: 'true'
+  msys2_mingw_dependencies: openssl
 rdoc_options: []
 require_paths:
 - lib
@@ -146,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A Ruby/Rack web server built for parallelism.
 test_files: []

data/ext/puma_http11/ext_help.h

@@ -1,15 +0,0 @@
-#ifndef ext_help_h
-#define ext_help_h
-
-#define RAISE_NOT_NULL(T) if(T == NULL) rb_raise(rb_eArgError, "%s", "NULL found for " # T " when shouldn't be.");
-#define DATA_GET(from,type,data_type,name) TypedData_Get_Struct(from,type,data_type,name); RAISE_NOT_NULL(name);
-#define REQUIRE_TYPE(V, T) if(TYPE(V) != T) rb_raise(rb_eTypeError, "%s", "Wrong argument type for " # V " required " # T);
-#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
-
-#ifdef DEBUG
-#define TRACE()  fprintf(stderr, "> %s:%d:%s\n", __FILE__, __LINE__, __FUNCTION__)
-#else
-#define TRACE() 
-#endif
-
-#endif