pitchfork 0.14.0 → 0.15.0

data/ext/pitchfork_http/pitchfork_http.rl

@@ -36,12 +36,6 @@ void init_pitchfork_memory_page(VALUE);
 
 static unsigned int MAX_HEADER_LEN = 1024 * (80 + 32); /* same as Mongrel */
 
-/* this is only intended for use with Rainbows! */
-static VALUE set_maxhdrlen(VALUE self, VALUE len)
-{
-  return UINT2NUM(MAX_HEADER_LEN = NUM2UINT(len));
-}
-
 /* keep this small for other servers (e.g. yahns) since every client has one */
 struct http_parser {
   int cs; /* Ragel internal state */
@@ -95,7 +89,7 @@ static inline unsigned int ulong2uint(unsigned long n)
 #define LEN(AT, FPC) (ulong2uint(FPC - buffer) - hp->AT)
 #define MARK(M,FPC) (hp->M = ulong2uint((FPC) - buffer))
 #define PTR_TO(F) (buffer + hp->F)
-#define STR_NEW(M,FPC) rb_str_new(PTR_TO(M), LEN(M, FPC))
+#define STR_NEW(M,FPC) str_new(PTR_TO(M), LEN(M, FPC))
 #define STRIPPED_STR_NEW(M,FPC) stripped_str_new(PTR_TO(M), LEN(M, FPC))
 
 #define HP_FL_TEST(hp,fl) ((hp)->flags & (UH_FL_##fl))
@@ -108,13 +102,29 @@ static int is_lws(char c)
   return (c == ' ' || c == '\t');
 }
 
-static VALUE stripped_str_new(const char *str, long len)
+static inline VALUE str_new(const char *str, long len)
+{
+    VALUE rb_str = rb_str_new(str, len);
+    /* The Rack spec states:
+    > If the string values for CGI keys contain non-ASCII characters, they should use ASCII-8BIT encoding.
+    If they are ASCII, only the server is free to encode them as it wishes.
+    We chose to encode them as UTF-8 as any reasonable application would expect that today, and having the
+    same encoding as literal strings makes for slightly faster comparisons.
+    We'd like to also encode other strings that would be valid UTF-8 into UTF-8, but that would
+    violate the spec, so we leave them in BINARY aka ASCII-8BIT. */
+    if (rb_enc_str_asciionly_p(rb_str)) {
+        RB_ENCODING_SET_INLINED(rb_str, rb_utf8_encindex());
+    }
+    return rb_str;
+}
+
+static inline VALUE stripped_str_new(const char *str, long len)
 {
   long end;
 
   for (end = len - 1; end >= 0 && is_lws(str[end]); end--);
 
-  return rb_str_new(str, end + 1);
+  return str_new(str, end + 1);
 }
 
 /*
@@ -330,24 +340,18 @@ static void write_value(VALUE self, struct http_parser *hp,
   }
   action host { rb_hash_aset(hp->env, g_http_host, STR_NEW(mark, fpc)); }
   action request_uri {
-    VALUE str;
-
     VALIDATE_MAX_URI_LENGTH(LEN(mark, fpc), REQUEST_URI);
-    str = rb_hash_aset(hp->env, g_request_uri, STR_NEW(mark, fpc));
-    /*
-     * "OPTIONS * HTTP/1.1\r\n" is a valid request, but we can't have '*'
-     * in REQUEST_PATH or PATH_INFO or else Rack::Lint will complain
-     */
+    rb_hash_aset(hp->env, g_request_uri, STR_NEW(mark, fpc));
+  }
+  action fragment {
+    VALIDATE_MAX_URI_LENGTH(LEN(mark, fpc), FRAGMENT);
+    VALUE str = rb_hash_aset(hp->env, g_fragment, STR_NEW(mark, fpc));
     if (STR_CSTR_EQ(str, "*")) {
-      str = rb_str_new(NULL, 0);
+      VALUE str = rb_str_new("*", 1);
       rb_hash_aset(hp->env, g_path_info, str);
       rb_hash_aset(hp->env, g_request_path, str);
     }
   }
-  action fragment {
-    VALIDATE_MAX_URI_LENGTH(LEN(mark, fpc), FRAGMENT);
-    rb_hash_aset(hp->env, g_fragment, STR_NEW(mark, fpc));
-  }
   action start_query {MARK(start.query, fpc); }
   action query_string {
     VALIDATE_MAX_URI_LENGTH(LEN(start.query, fpc), QUERY_STRING);
@@ -612,6 +616,12 @@ static VALUE HttpParser_alloc(VALUE klass)
   return TypedData_Make_Struct(klass, struct http_parser, &hp_type, hp);
 }
 
+#ifndef HAVE_RB_HASH_NEW_CAPA
+static inline VALUE rb_hash_new_capa(long capa) {
+    return rb_hash_new();
+}
+#endif
+
 /**
  * call-seq:
  *    parser.new => parser
@@ -624,7 +634,7 @@ static VALUE HttpParser_init(VALUE self)
 
   http_parser_init(hp);
   RB_OBJ_WRITE(self, &hp->buf, rb_str_new(NULL, 0));
-  RB_OBJ_WRITE(self, &hp->env, rb_hash_new());
+  RB_OBJ_WRITE(self, &hp->env, rb_hash_new_capa(32)); // Even the simplest request will have 10 keys
 
   return self;
 }
@@ -1010,8 +1020,6 @@ RUBY_FUNC_EXPORTED void Init_pitchfork_http(void)
    */
   rb_define_const(cHttpParser, "LENGTH_MAX", OFFT2NUM(UH_OFF_T_MAX));
 
-  rb_define_singleton_method(cHttpParser, "max_header_len=", set_maxhdrlen, 1);
-
   init_common_fields();
   SET_GLOBAL(g_http_host, "HOST");
   SET_GLOBAL(g_http_trailer, "TRAILER");

data/lib/pitchfork/chunked.rb

@@ -104,12 +104,15 @@ module Pitchfork
     def call(env)
       status, headers, body = response = @app.call(env)
 
-      if chunkable_version?(env[Rack::SERVER_PROTOCOL]) &&
+      if !env.key?('rack.hijack_io') && # full highjack
+         !headers['rack.hijack'] && # partial hijack
+         body.respond_to?(:each) && # body must be enumerable (i.e. non-streaming)
+          chunkable_version?(env[Rack::SERVER_PROTOCOL]) &&
          !STATUS_WITH_NO_ENTITY_BODY.key?(status.to_i) &&
          !headers[Rack::CONTENT_LENGTH] &&
-         !headers[Rack::TRANSFER_ENCODING]
+         !headers["transfer-encoding"]
 
-        headers[Rack::TRANSFER_ENCODING] = 'chunked'
+        headers["transfer-encoding"] = 'chunked'
         if headers['trailer']
           response[2] = TrailerBody.new(body)
         else

data/lib/pitchfork/configurator.rb

@@ -230,7 +230,7 @@ module Pitchfork
     def listen(address, options = {})
       address = expand_addr(address)
       if String === address
-        [ :umask, :backlog, :sndbuf, :rcvbuf, :tries ].each do |key|
+        [ :umask, :backlog, :sndbuf, :rcvbuf, :tries, :queues, :queues_per_worker].each do |key|
           value = options[key] or next
           Integer === value or
             raise ArgumentError, "not an integer: #{key}=#{value.inspect}"

data/lib/pitchfork/http_parser.rb

@@ -1,4 +1,3 @@
-# -*- encoding: binary -*-
 # frozen_string_literal: true
 # :enddoc:
 # no stable API here

data/lib/pitchfork/http_response.rb

@@ -71,8 +71,10 @@ module Pitchfork
       if hijack
         req.hijacked!
         hijack.call(socket)
-      else
+      elsif body.respond_to?(:each)
         body.each { |chunk| socket.write(chunk) }
+      else
+        body.call(socket)
       end
     end
   end

data/lib/pitchfork/http_server.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'pitchfork/pitchfork_http'
+require 'pitchfork/listeners'
 require 'pitchfork/flock'
 require 'pitchfork/soft_timeout'
 require 'pitchfork/shared_memory'
@@ -79,8 +80,7 @@ module Pitchfork
     attr_accessor :app, :timeout, :timeout_signal, :soft_timeout, :cleanup_timeout, :spawn_timeout, :worker_processes,
                   :before_fork, :after_worker_fork, :after_mold_fork, :before_service_worker_ready, :before_service_worker_exit,
                   :listener_opts, :children,
-                  :orig_app, :config, :ready_pipe,
-                  :default_middleware, :early_hints
+                  :orig_app, :config, :ready_pipe, :early_hints
     attr_writer   :after_worker_exit, :before_worker_exit, :after_worker_ready, :after_request_complete,
                   :refork_condition, :after_worker_timeout, :after_worker_hard_timeout, :after_monitor_ready
 
@@ -91,7 +91,7 @@ module Pitchfork
     # all bound listener sockets
     # note: this is public used by raindrops, but not recommended for use
     # in new projects
-    LISTENERS = []
+    LISTENERS = Listeners.new
 
     NOOP = '.'
 
@@ -196,6 +196,10 @@ module Pitchfork
     # replaces current listener set with +listeners+.  This will
     # close the socket if it will not exist in the new listener set
     def listeners=(listeners)
+      unless LISTENERS.empty?
+        raise "Listeners can only be initialized once"
+      end
+
       cur_names, dead_names = [], []
       listener_names.each do |name|
         if name.start_with?('/')
@@ -205,19 +209,7 @@ module Pitchfork
           cur_names << name
         end
       end
-      set_names = listener_names(listeners)
-      dead_names.concat(cur_names - set_names).uniq!
-
-      LISTENERS.delete_if do |io|
-        if dead_names.include?(sock_name(io))
-          (io.close rescue nil).nil? # true
-        else
-          set_server_sockopt(io, listener_opts[sock_name(io)])
-          false
-        end
-      end
-
-      (set_names - cur_names).each { |addr| listen(addr) }
+      listener_names(listeners).each { |addr| listen(addr) }
     end
 
     def logger=(obj)
@@ -233,12 +225,16 @@ module Pitchfork
     # A negative value for +:tries+ indicates the listen will be
     # retried indefinitely, this is useful when workers belonging to
     # different masters are spawned during a transparent upgrade.
-    def listen(address, opt = {}.merge(listener_opts[address] || {}))
+    def listen(address, opt = listener_opts[address] || {})
       address = config.expand_addr(address)
       return if String === address && listener_names.include?(address)
 
+      opt = opt.dup
       delay = opt[:delay] || 0.5
       tries = opt[:tries] || 5
+      queues = opt[:queues] ||= 1
+      opt[:reuseport] = true if queues > 1
+
       begin
         io = bind_listen(address, opt)
         unless TCPServer === io || UNIXServer === io
@@ -247,7 +243,7 @@ module Pitchfork
         end
         logger.info "listening on addr=#{sock_name(io)} fd=#{io.fileno}"
         Info.keep_io(io)
-        LISTENERS << io
+        LISTENERS << io unless queues > 1
         io
       rescue Errno::EADDRINUSE => err
         logger.error "adding listener failed addr=#{address} (in use)"
@@ -261,6 +257,29 @@ module Pitchfork
         logger.fatal "error adding listener addr=#{address}"
         raise err
       end
+
+      if queues > 1
+        ios = [io]
+
+        (queues - 1).times do
+          io = bind_listen(address, opt)
+          unless TCPServer === io || UNIXServer === io
+            io.autoclose = false
+            io = server_cast(io)
+          end
+          logger.info "listening on addr=#{sock_name(io)} fd=#{io.fileno} (SO_REUSEPORT)"
+          Info.keep_io(io)
+          ios << io
+        rescue => err
+          logger.fatal "error adding listener addr=#{address}"
+          raise err
+        end
+
+        io = Listeners::Group.new(ios, queues_per_worker: opt[:queues_per_worker] || queues - 1)
+        LISTENERS << io
+      end
+
+      io
     end
 
     # monitors children and receives signals forever
@@ -371,7 +390,8 @@ module Pitchfork
       @respawn = false
       SharedMemory.shutting_down!
       wait_for_pending_workers
-      self.listeners = []
+      LISTENERS.each(&:close).clear
+
       limit = Pitchfork.time_now + timeout
       until @children.empty? || Pitchfork.time_now > limit
         if graceful
@@ -897,7 +917,7 @@ module Pitchfork
 
       @config = nil
       @listener_opts = @orig_app = nil
-      readers = LISTENERS.dup
+      readers = LISTENERS.for_worker(worker.nr)
       readers << worker
       trap(:QUIT) { nuke_listeners!(readers) }
       trap(:TERM) { nuke_listeners!(readers) }

data/lib/pitchfork/listeners.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Pitchfork
+
+  class Listeners
+    class Group
+      def initialize(listeners, queues_per_worker:)
+        @listeners = listeners
+        @queues_per_worker = queues_per_worker
+      end
+
+      def each(&block)
+        @listeners.each(&block)
+      end
+
+      def for_worker(nr)
+        index = nr % @listeners.size
+
+        listeners = @listeners.slice(index..-1) + @listeners.slice(0...index)
+        listeners.take(@queues_per_worker)
+      end
+    end
+
+    include Enumerable
+
+    def initialize(listeners = [])
+      @listeners = listeners
+    end
+
+    def for_worker(nr)
+      ios = []
+      @listeners.each do |listener|
+        if listener.is_a?(Group)
+          ios += listener.for_worker(nr)
+        else
+          ios << listener
+        end
+      end
+      ios
+    end
+
+    def each(&block)
+      @listeners.each do |listener|
+        if listener.is_a?(Group)
+          listener.each(&block)
+        else
+          yield listener
+        end
+      end
+      self
+    end
+
+    def clear
+      @listeners.clear
+    end
+
+    def <<(listener)
+      @listeners << listener
+    end
+
+    def empty?
+      @listeners.empty?
+    end
+  end
+end

data/lib/pitchfork/socket_helper.rb

@@ -26,6 +26,8 @@ module Pitchfork
       :tcp_nodelay => true,
     }
 
+    private
+
     # configure platform-specific options (only tested on Linux 2.6 so far)
     def accf_arg(af_name)
       [ af_name, nil ].pack('a16a240')
@@ -64,7 +66,7 @@ module Pitchfork
       elsif respond_to?(:accf_arg)
         name = opt[:accept_filter]
         name = DEFAULTS[:accept_filter] if name.nil?
-        sock.listen(opt[:backlog])
+        sock.listen(compute_backlog(opt))
         got = (sock.getsockopt(:SOL_SOCKET, :SO_ACCEPTFILTER) rescue nil).to_s
         arg = accf_arg(name)
         begin
@@ -89,11 +91,19 @@ module Pitchfork
         sock.setsockopt(:SOL_SOCKET, :SO_SNDBUF, sndbuf) if sndbuf
         log_buffer_sizes(sock, " after: ")
       end
-      sock.listen(opt[:backlog])
+      sock.listen(compute_backlog(opt))
     rescue => e
       Pitchfork.log_error(logger, "#{sock_name(sock)} #{opt.inspect}", e)
     end
 
+    def compute_backlog(opt)
+      backlog = opt[:backlog]
+      if backlog > 0 && opt[:queues]
+        return backlog / opt[:queues]
+      end
+      backlog
+    end
+
     def log_buffer_sizes(sock, pfx = '')
       rcvbuf = sock.getsockopt(:SOL_SOCKET, :SO_RCVBUF).int
       sndbuf = sock.getsockopt(:SOL_SOCKET, :SO_SNDBUF).int

data/lib/pitchfork/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Pitchfork
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
   module Const
     UNICORN_VERSION = '6.1.0'
   end

data/lib/pitchfork/worker.rb

@@ -110,11 +110,6 @@ module Pitchfork
       @to_io.to_io
     end
 
-    # master fakes SIGQUIT using this
-    def quit # :nodoc:
-      @master = @master.close if @master
-    end
-
     def master=(socket)
       @master = MessageSocket.new(socket)
     end

data/pitchfork.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 2.5.0"
 
-  s.add_dependency(%q<rack>, '>= 2.0')
+  s.add_dependency('rack', '>= 2.0')
+  s.add_dependency('logger')
 
   # Note: To avoid ambiguity, we intentionally avoid the SPDX-compatible
   # 'Ruby' here since Ruby 1.9.3 switched to BSD-2-Clause, but we

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pitchfork
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Jean Boussier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   `pitchfork` is a preforking HTTP server for Rack applications designed
   to minimize memory usage by maximizing Copy-on-Write performance.
@@ -45,7 +59,6 @@ files:
 - COPYING
 - Dockerfile
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -94,6 +107,7 @@ files:
 - lib/pitchfork/http_server.rb
 - lib/pitchfork/info.rb
 - lib/pitchfork/launcher.rb
+- lib/pitchfork/listeners.rb
 - lib/pitchfork/mem_info.rb
 - lib/pitchfork/message.rb
 - lib/pitchfork/refork_condition.rb
@@ -127,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Rack HTTP server for fast clients and Unix

data/Gemfile.lock

@@ -1,32 +0,0 @@
-PATH
-  remote: .
-  specs:
-    pitchfork (0.14.0)
-      rack (>= 2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.22.2)
-    nio4r (2.7.0)
-    puma (6.4.2)
-      nio4r (~> 2.0)
-    rack (3.0.11)
-    rake (13.0.6)
-    rake-compiler (1.2.1)
-      rake
-
-PLATFORMS
-  aarch64-linux
-  arm64-darwin
-  x86_64-linux
-
-DEPENDENCIES
-  minitest
-  pitchfork!
-  puma
-  rake
-  rake-compiler
-
-BUNDLED WITH
-   2.3.27