puma 4.3.12 → 5.0.0.beta1

data/lib/puma/thread_pool.rb

@@ -47,6 +47,7 @@ module Puma
       @shutdown = false
 
       @trim_requested = 0
+      @out_of_band_pending = false
 
       @workers = []
 
@@ -54,7 +55,10 @@ module Puma
       @reaper = nil
 
       @mutex.synchronize do
-        @min.times { spawn_thread }
+        @min.times do
+          spawn_thread
+          @not_full.wait(@mutex)
+        end
       end
 
       @clean_thread_locals = false
@@ -62,6 +66,7 @@ module Puma
 
     attr_reader :spawned, :trim_requested, :waiting
     attr_accessor :clean_thread_locals
+    attr_accessor :out_of_band_hook
 
     def self.clean_thread_locals
       Thread.current.keys.each do |key| # rubocop: disable Performance/HashEachMethods
@@ -72,13 +77,17 @@ module Puma
     # How many objects have yet to be processed by the pool?
     #
     def backlog
-      @mutex.synchronize { @todo.size }
+      with_mutex { @todo.size }
     end
 
     def pool_capacity
       waiting + (@max - spawned)
     end
 
+    def busy_threads
+      with_mutex { @spawned - @waiting + @todo.size }
+    end
+
     # :nodoc:
     #
     # Must be called with @mutex held!
@@ -99,48 +108,37 @@ module Puma
         while true
           work = nil
 
-          continue = true
-
           mutex.synchronize do
             while todo.empty?
               if @trim_requested > 0
                 @trim_requested -= 1
-                continue = false
-                not_full.signal
-                break
-              end
-
-              if @shutdown
-                continue = false
-                break
+                @spawned -= 1
+                @workers.delete th
+                Thread.exit
               end
 
               @waiting += 1
+              if @out_of_band_pending && trigger_out_of_band_hook
+                @out_of_band_pending = false
+              end
               not_full.signal
               not_empty.wait mutex
               @waiting -= 1
             end
 
-            work = todo.shift if continue
+            work = todo.shift
           end
 
-          break unless continue
-
           if @clean_thread_locals
             ThreadPool.clean_thread_locals
           end
 
           begin
-            block.call(work, *extra)
+            @out_of_band_pending = true if block.call(work, *extra)
           rescue Exception => e
             STDERR.puts "Error reached top of thread-pool: #{e.message} (#{e.class})"
           end
         end
-
-        mutex.synchronize do
-          @spawned -= 1
-          @workers.delete th
-        end
       end
 
       @workers << th
@@ -150,9 +148,30 @@ module Puma
 
     private :spawn_thread
 
+    def trigger_out_of_band_hook
+      return false unless out_of_band_hook && out_of_band_hook.any?
+
+      # we execute on idle hook when all threads are free
+      return false unless @spawned == @waiting
+
+      out_of_band_hook.each(&:call)
+      true
+    rescue Exception => e
+      STDERR.puts "Exception calling out_of_band_hook: #{e.message} (#{e.class})"
+      true
+    end
+
+    private :trigger_out_of_band_hook
+
+    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
@@ -193,11 +212,8 @@ module Puma
     # method would not block and another request would be added into the reactor
     # by the server. This would continue until a fully bufferend request
     # makes it through the reactor and can then be processed by the thread pool.
-    #
-    # Returns the current number of busy threads, or +nil+ if shutting down.
-    #
     def wait_until_not_full
-      @mutex.synchronize do
+      with_mutex do
         while true
           return if @shutdown
 
@@ -205,21 +221,40 @@ module Puma
           # is work queued that cannot be handled by waiting
           # threads, then accept more work until we would
           # spin up the max number of threads.
-          busy_threads = @spawned - @waiting + @todo.size
-          return busy_threads if @max > busy_threads
+          return if busy_threads < @max
 
           @not_full.wait @mutex
         end
       end
     end
 
-    # If too many threads are in the pool, tell one to finish go ahead
+    def wait_for_less_busy_worker(delay_s)
+      # Ruby MRI does GVL, this can result
+      # in processing contention when multiple threads
+      # (requests) are running concurrently
+      return unless Puma.mri?
+      return unless delay_s > 0
+
+      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.
     #
     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
           @not_empty.signal
         end
@@ -229,7 +264,7 @@ module Puma
     # 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
-      @mutex.synchronize do
+      with_mutex do
         dead_workers = @workers.reject(&:alive?)
 
         dead_workers.each do |worker|
@@ -281,10 +316,14 @@ module Puma
     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 +grace+ seconds then force-kill remaining threads.
+    # Finally, wait +kill_grace+ seconds for remaining threads to exit.
     #
     def shutdown(timeout=-1)
-      threads = @mutex.synchronize do
+      threads = with_mutex do
         @shutdown = true
+        @trim_requested = @spawned
         @not_empty.broadcast
         @not_full.broadcast
 
@@ -298,27 +337,26 @@ module Puma
         # Wait for threads to finish without force shutdown.
         threads.each(&:join)
       else
-        # Wait for threads to finish after n attempts (+timeout+).
-        # If threads are still running, it will forcefully kill them.
-        timeout.times do
-          threads.delete_if do |t|
-            t.join 1
-          end
-
-          if threads.empty?
-            break
-          else
-            sleep 1
+        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.
         threads.each do |t|
           t.raise ForceShutdown
         end
+        join.call(SHUTDOWN_GRACE_TIME)
 
-        threads.each do |t|
-          t.join SHUTDOWN_GRACE_TIME
-        end
+        # If threads are _still_ running, forcefully kill them and wait to finish.
+        threads.each(&:kill)
+        join.call(1)
       end
 
       @spawned = 0

data/lib/puma.rb

@@ -20,6 +20,10 @@ module Puma
   end
 
   def self.stats
+    @get_stats.stats.to_json
+  end
+
+  def self.stats_hash
     @get_stats.stats
   end
 

data/lib/rack/handler/puma.rb

@@ -30,8 +30,6 @@ module Rack
         end
 
         conf = ::Puma::Configuration.new(options, default_options) do |user_config, file_config, default_config|
-          user_config.quiet
-
           if options.delete(:Verbose)
             app = Rack::CommonLogger.new(app, STDOUT)
           end
@@ -61,7 +59,7 @@ module Rack
         conf
       end
 
-      def self.run(app, options = {})
+      def self.run(app, **options)
         conf   = self.config(app, options)
 
         events = options.delete(:Silent) ? ::Puma::Events.strings : ::Puma::Events.stdio

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 4.3.12
+  version: 5.0.0.beta1
 platform: ruby
 authors:
 - Evan Phoenix
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 1980-01-01 00:00:00.000000000 Z
+date: 2020-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -45,15 +45,22 @@ files:
 - bin/pumactl
 - docs/architecture.md
 - docs/deployment.md
+- docs/fork_worker.md
 - docs/images/puma-connection-flow-no-reactor.png
 - docs/images/puma-connection-flow.png
 - docs/images/puma-general-arch.png
+- docs/jungle/README.md
+- docs/jungle/rc.d/README.md
+- docs/jungle/rc.d/puma
+- docs/jungle/rc.d/puma.conf
+- docs/jungle/upstart/README.md
+- docs/jungle/upstart/puma-manager.conf
+- docs/jungle/upstart/puma.conf
 - docs/nginx.md
 - docs/plugins.md
 - docs/restart.md
 - docs/signals.md
 - docs/systemd.md
-- docs/tcp_mode.md
 - ext/puma_http11/PumaHttp11Service.java
 - ext/puma_http11/ext_help.h
 - ext/puma_http11/extconf.rb
@@ -62,11 +69,9 @@ files:
 - ext/puma_http11/http11_parser.java.rl
 - ext/puma_http11/http11_parser.rl
 - ext/puma_http11/http11_parser_common.rl
-- ext/puma_http11/io_buffer.c
 - ext/puma_http11/mini_ssl.c
 - ext/puma_http11/org/jruby/puma/Http11.java
 - ext/puma_http11/org/jruby/puma/Http11Parser.java
-- ext/puma_http11/org/jruby/puma/IOBuffer.java
 - ext/puma_http11/org/jruby/puma/MiniSSL.java
 - ext/puma_http11/puma_http11.c
 - lib/puma.rb
@@ -99,29 +104,20 @@ files:
 - lib/puma/server.rb
 - lib/puma/single.rb
 - lib/puma/state_file.rb
-- lib/puma/tcp_logger.rb
 - lib/puma/thread_pool.rb
 - lib/puma/util.rb
 - lib/rack/handler/puma.rb
-- tools/docker/Dockerfile
-- tools/jungle/README.md
-- tools/jungle/init.d/README.md
-- tools/jungle/init.d/puma
-- tools/jungle/init.d/run-puma
-- tools/jungle/rc.d/README.md
-- tools/jungle/rc.d/puma
-- tools/jungle/rc.d/puma.conf
-- tools/jungle/upstart/README.md
-- tools/jungle/upstart/puma-manager.conf
-- tools/jungle/upstart/puma.conf
+- tools/Dockerfile
 - tools/trickletest.rb
 homepage: http://puma.io
 licenses:
 - BSD-3-Clause
 metadata:
-  msys2_mingw_dependencies: openssl
+  bug_tracker_uri: https://github.com/puma/puma/issues
   changelog_uri: https://github.com/puma/puma/blob/master/History.md
-post_install_message:
+  homepage_uri: http://puma.io
+  source_code_uri: https://github.com/puma/puma
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -132,12 +128,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.26
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for
   Ruby/Rack applications

data/docs/tcp_mode.md

@@ -1,96 +0,0 @@
-# TCP mode
-
-Puma also could be used as a TCP server to process incoming TCP
-connections.
-
-
-## Configuration
-
-TCP mode can be enabled with CLI option `--tcp-mode`:
-
-```
-$ puma --tcp-mode
-```
-
-Default ip and port to listen to are `0.0.0.0` and `9292`. You can configure
-them with `--port` and `--bind` options:
-
-```
-$ puma --tcp-mode --bind tcp://127.0.0.1:9293
-$ puma --tcp-mode --port 9293
-```
-
-TCP mode could be set with a configuration file as well with `tcp_mode`
-and `tcp_mode!` methods:
-
-```
-# config/puma.rb
-tcp_mode
-```
-
-When Puma starts in the TCP mode it prints the corresponding message:
-
-```
-puma --tcp-mode
-Puma starting in single mode...
-...
-* Mode: Lopez Express (tcp)
-```
-
-
-## How to declare an application
-
-An application to process TCP connections should be declared as a
-callable object which accepts `env` and `socket` arguments.
-
-`env` argument is a Hash with following structure:
-
-```ruby
-{ "thread" => {}, "REMOTE_ADDR" => "127.0.0.1:51133", "log" => "#<Proc:0x000..." }
-```
-
-It consists of:
-* `thread` - a Hash for each thread in the thread pool that could be
-  used to store information between requests
-* `REMOTE_ADDR` - a client ip address
-* `log` - a proc object to write something down
-
-`log` object could be used this way:
-
-```ruby
-env['log'].call('message to log')
-#> 19/Oct/2019 20:28:53 - 127.0.0.1:51266 - message to log
-```
-
-
-## Example of an application
-
-Let's look at an example of a simple application which just echoes
-incoming string:
-
-```ruby
-# config/puma.rb
-app do |env, socket|
-  s = socket.gets
-  socket.puts "Echo #{s}"
-end
-```
-
-We can easily access the TCP server with `telnet` command and receive an
-echo:
-
-```shell
-telnet 0.0.0.0 9293
-Trying 0.0.0.0...
-Connected to 0.0.0.0.
-Escape character is '^]'.
-sssss
-Echo sssss
-^CConnection closed by foreign host.
-```
-
-
-## Socket management
-
-After the application finishes, Puma closes the socket. In order to
-prevent this, the application should set `env['detach'] = true`.

data/ext/puma_http11/io_buffer.c

@@ -1,155 +0,0 @@
-#define RSTRING_NOT_MODIFIED 1
-#include "ruby.h"
-
-#include <sys/types.h>
-
-struct buf_int {
-  uint8_t* top;
-  uint8_t* cur;
-
-  size_t size;
-};
-
-#define BUF_DEFAULT_SIZE 4096
-#define BUF_TOLERANCE 32
-
-static void buf_free(struct buf_int* internal) {
-  xfree(internal->top);
-  xfree(internal);
-}
-
-static VALUE buf_alloc(VALUE self) {
-  VALUE buf;
-  struct buf_int* internal;
-
-  buf = Data_Make_Struct(self, struct buf_int, 0, buf_free, internal);
-
-  internal->size = BUF_DEFAULT_SIZE;
-  internal->top = ALLOC_N(uint8_t, BUF_DEFAULT_SIZE);
-  internal->cur = internal->top;
-
-  return buf;
-}
-
-static VALUE buf_append(VALUE self, VALUE str) {
-  struct buf_int* b;
-  size_t used, str_len, new_size;
-
-  Data_Get_Struct(self, struct buf_int, b);
-
-  used = b->cur - b->top;
-
-  StringValue(str);
-  str_len = RSTRING_LEN(str);
-
-  new_size = used + str_len;
-
-  if(new_size > b->size) {
-    size_t n = b->size + (b->size / 2);
-    uint8_t* top;
-    uint8_t* old;
-
-    new_size = (n > new_size ? n : new_size + BUF_TOLERANCE);
-
-    top = ALLOC_N(uint8_t, new_size);
-    old = b->top;
-    memcpy(top, old, used);
-    b->top = top;
-    b->cur = top + used;
-    b->size = new_size;
-    xfree(old);
-  }
-
-  memcpy(b->cur, RSTRING_PTR(str), str_len);
-  b->cur += str_len;
-
-  return self;
-}
-
-static VALUE buf_append2(int argc, VALUE* argv, VALUE self) {
-  struct buf_int* b;
-  size_t used, new_size;
-  int i;
-  VALUE str;
-
-  Data_Get_Struct(self, struct buf_int, b);
-
-  used = b->cur - b->top;
-  new_size = used;
-
-  for(i = 0; i < argc; i++) {
-    StringValue(argv[i]);
-
-    str = argv[i];
-
-    new_size += RSTRING_LEN(str);
-  }
-
-  if(new_size > b->size) {
-    size_t n = b->size + (b->size / 2);
-    uint8_t* top;
-    uint8_t* old;
-
-    new_size = (n > new_size ? n : new_size + BUF_TOLERANCE);
-
-    top = ALLOC_N(uint8_t, new_size);
-    old = b->top;
-    memcpy(top, old, used);
-    b->top = top;
-    b->cur = top + used;
-    b->size = new_size;
-    xfree(old);
-  }
-
-  for(i = 0; i < argc; i++) {
-    long str_len;
-    str = argv[i];
-    str_len = RSTRING_LEN(str);
-    memcpy(b->cur, RSTRING_PTR(str), str_len);
-    b->cur += str_len;
-  }
-
-  return self;
-}
-
-static VALUE buf_to_str(VALUE self) {
-  struct buf_int* b;
-  Data_Get_Struct(self, struct buf_int, b);
-
-  return rb_str_new((const char*)(b->top), b->cur - b->top);
-}
-
-static VALUE buf_used(VALUE self) {
-  struct buf_int* b;
-  Data_Get_Struct(self, struct buf_int, b);
-
-  return INT2FIX(b->cur - b->top);
-}
-
-static VALUE buf_capa(VALUE self) {
-  struct buf_int* b;
-  Data_Get_Struct(self, struct buf_int, b);
-
-  return INT2FIX(b->size);
-}
-
-static VALUE buf_reset(VALUE self) {
-  struct buf_int* b;
-  Data_Get_Struct(self, struct buf_int, b);
-
-  b->cur = b->top;
-  return self;
-}
-
-void Init_io_buffer(VALUE puma) {
-  VALUE buf = rb_define_class_under(puma, "IOBuffer", rb_cObject);
-
-  rb_define_alloc_func(buf, buf_alloc);
-  rb_define_method(buf, "<<", buf_append, 1);
-  rb_define_method(buf, "append", buf_append2, -1);
-  rb_define_method(buf, "to_str", buf_to_str, 0);
-  rb_define_method(buf, "to_s", buf_to_str, 0);
-  rb_define_method(buf, "used", buf_used, 0);
-  rb_define_method(buf, "capacity", buf_capa, 0);
-  rb_define_method(buf, "reset", buf_reset, 0);
-}