pitchfork 0.12.0 → 0.14.0

data/lib/pitchfork/http_server.rb

@@ -1,4 +1,6 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
+
 require 'pitchfork/pitchfork_http'
 require 'pitchfork/flock'
 require 'pitchfork/soft_timeout'
@@ -75,7 +77,7 @@ module Pitchfork
 
     # :stopdoc:
     attr_accessor :app, :timeout, :timeout_signal, :soft_timeout, :cleanup_timeout, :spawn_timeout, :worker_processes,
-                  :before_fork, :after_worker_fork, :after_mold_fork,
+                  :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
@@ -91,33 +93,7 @@ module Pitchfork
     # in new projects
     LISTENERS = []
 
-    NOOP = '.'.freeze
-
-    # :startdoc:
-    # This Hash is considered a stable interface and changing its contents
-    # will allow you to switch between different installations of Pitchfork
-    # or even different installations of the same applications without
-    # downtime.  Keys of this constant Hash are described as follows:
-    #
-    # * 0 - the path to the pitchfork executable
-    # * :argv - a deep copy of the ARGV array the executable originally saw
-    # * :cwd - the working directory of the application, this is where
-    # you originally started Pitchfork.
-    # TODO: Can we get rid of this?
-    START_CTX = {
-      :argv => ARGV.map(&:dup),
-      0 => $0.dup,
-    }
-    # We favor ENV['PWD'] since it is (usually) symlink aware for Capistrano
-    # and like systems
-    START_CTX[:cwd] = begin
-      a = File.stat(pwd = ENV['PWD'])
-      b = File.stat(Dir.pwd)
-      a.ino == b.ino && a.dev == b.dev ? pwd : Dir.pwd
-    rescue
-      Dir.pwd
-    end
-    # :stopdoc:
+    NOOP = '.'
 
     # Creates a working server on host:port (strange things happen if
     # port isn't a Number).  Use HttpServer::run to start the server and
@@ -138,7 +114,7 @@ module Pitchfork
       self.config = Pitchfork::Configurator.new(options)
       self.listener_opts = {}
 
-      proc_name role: 'monitor', status: START_CTX[:argv].join(' ')
+      proc_name role: 'monitor', status: ARGV.join(' ')
 
       # We use @control_socket differently in the master and worker processes:
       #
@@ -171,7 +147,7 @@ module Pitchfork
         :QUIT, :INT, :TERM, :USR2, :TTIN, :TTOU ]
 
       Info.workers_count = worker_processes
-      SharedMemory.preallocate_drops(worker_processes)
+      SharedMemory.preallocate_pages(worker_processes)
     end
 
     # Runs the thing.  Returns self so you can run join on it
@@ -294,7 +270,7 @@ module Pitchfork
     def join
       @respawn = true
 
-      proc_name role: 'monitor', status: START_CTX[:argv].join(' ')
+      proc_name role: 'monitor', status: ARGV.join(' ')
 
       logger.info "master process ready" # test_exec.rb relies on this message
       if @ready_pipe
@@ -372,6 +348,9 @@ module Pitchfork
       when Message::MoldSpawned
         new_mold = @children.update(message)
         logger.info("mold pid=#{new_mold.pid} gen=#{new_mold.generation} spawned")
+      when Message::ServiceSpawned
+        new_service = @children.update(message)
+        logger.info("service pid=#{new_service.pid} gen=#{new_service.generation} spawned")
       when Message::MoldReady
         old_molds = @children.molds
         new_mold = @children.update(message)
@@ -427,6 +406,20 @@ module Pitchfork
       Process.exit
     end
 
+    def service_exit(service)
+      logger.info "service pid=#{service.pid} gen=#{service.generation} exiting"
+      proc_name status: "exiting"
+
+      if @before_service_worker_exit
+        begin
+          @before_service_worker_exit.call(self, service)
+        rescue => error
+          Pitchfork.log_error(logger, "before_service_worker_exit error", error)
+        end
+      end
+      Process.exit
+    end
+
     def rewindable_input
       Pitchfork::HttpParser.input_class.method_defined?(:rewind)
     end
@@ -512,6 +505,7 @@ module Pitchfork
           next
         else # worker is out of time
           next_sleep = 0
+          child.deadline = now + 1
           hard_timeout(child)
         end
       end
@@ -587,6 +581,69 @@ module Pitchfork
       worker
     end
 
+    def service_loop(service)
+      readers = init_service_process(service)
+      waiter = prep_readers(readers)
+
+      ready = readers.dup
+
+      if @before_service_worker_ready
+        begin
+          @before_service_worker_ready.call(self, service)
+        rescue => error
+          Pitchfork.log_error(logger, "before_service_worker_ready", error)
+          Process.exit(1)
+        end
+      end
+
+      proc_name status: "ready"
+
+      while readers[0]
+        begin
+          service.update_deadline(@timeout)
+          while sock = ready.shift
+            # Pitchfork::Worker#accept_nonblock is not like accept(2) at all,
+            # but that will return false
+            client = sock.accept_nonblock(exception: false)
+
+            case client
+            when false, :wait_readable
+              # no message, keep looping
+            end
+
+            service.update_deadline(@timeout)
+          end
+
+          # timeout so we can update .deadline and keep parent from SIGKILL-ing us
+          service.update_deadline(@timeout)
+
+
+          waiter.get_readers(ready, readers, @timeout * 500) # to milliseconds, but halved
+        rescue => e
+          Pitchfork.log_error(@logger, "listen loop error", e) if readers[0]
+        end
+      end
+    end
+
+    def spawn_service(service, detach:)
+      logger.info("service gen=#{service.generation} spawning...")
+
+      # We set the deadline before spawning the child so that if for some
+      # reason it gets stuck before reaching the worker loop,
+      # the monitor process will kill it.
+      service.update_deadline(@spawn_timeout)
+      @before_fork&.call(self)
+      fork_sibling("spawn_service") do
+        service.pid = Process.pid
+
+        after_fork_internal
+        service_loop(service)
+        service_exit(service)
+      end
+
+      service
+    end
+
     def spawn_initial_mold
       mold = Worker.new(nil)
       mold.create_socketpair!
@@ -603,6 +660,21 @@ module Pitchfork
     end
 
     def spawn_missing_workers
+      if @before_service_worker_ready && !@children.service
+        service = Pitchfork::Service.new
+        if REFORKING_AVAILABLE
+          service.generation = @children.mold&.generation || 0
+
+          unless @children.mold&.spawn_service(service)
+            @logger.error("Failed to send a spawn_service command")
+          end
+        else
+          spawn_service(service, detach: false)
+        end
+
+        @children.register_service(service)
+      end
+
       worker_nr = -1
       until (worker_nr += 1) == @worker_processes
         if @children.nr_alive?(worker_nr)
@@ -640,9 +712,18 @@ module Pitchfork
     end
 
     def maintain_worker_count
-      (off = @children.workers_count - worker_processes) == 0 and return
-      off < 0 and return spawn_missing_workers
-      @children.each_worker { |w| w.nr >= worker_processes and w.soft_kill(:TERM) }
+      off = @children.workers_count - worker_processes
+      off -= 1 if @before_service_worker_ready && !@children.service
+
+      if off < 0
+        spawn_missing_workers
+      elsif off > 0
+        @children.each_worker do |worker|
+          if worker.nr >= worker_processes
+            worker.soft_kill(:TERM)
+          end
+        end
+      end
     end
 
     def restart_outdated_workers
@@ -655,6 +736,16 @@ module Pitchfork
       max_pending_workers = (worker_processes * 0.1).ceil
       workers_to_restart = max_pending_workers - @children.restarting_workers_count
 
+      if service = @children.service
+        if service.outdated?
+          if service.soft_kill(:TERM)
+            logger.info("Sent SIGTERM to service pid=#{service.pid} gen=#{service.generation}")
+          else
+            logger.info("Failed to send SIGTERM to service pid=#{service.pid} gen=#{service.generation}")
+          end
+        end
+      end
+
       if workers_to_restart > 0
         outdated_workers = @children.workers.select { |w| !w.exiting? && w.generation < @children.mold.generation }
         outdated_workers.each do |worker|
@@ -696,21 +787,17 @@ module Pitchfork
 
     def e103_response_write(client, headers)
       rss = @request.response_start_sent
-      buf = rss ? "103 Early Hints\r\n" : "HTTP/1.1 103 Early Hints\r\n"
+      buf = (rss ? "103 Early Hints\r\n" : "HTTP/1.1 103 Early Hints\r\n").b
       headers.each { |key, value| append_header(buf, key, value) }
-      buf << (rss ? "\r\nHTTP/1.1 ".freeze : "\r\n".freeze)
+      buf << (rss ? "\r\nHTTP/1.1 " : "\r\n")
       client.write(buf)
     end
 
     def e100_response_write(client, env)
-      # We use String#freeze to avoid allocations under Ruby 2.1+
-      # Not many users hit this code path, so it's better to reduce the
-      # constant table sizes even for Ruby 2.0 users who'll hit extra
-      # allocations here.
       client.write(@request.response_start_sent ?
-                   "100 Continue\r\n\r\nHTTP/1.1 ".freeze :
-                   "HTTP/1.1 100 Continue\r\n\r\n".freeze)
-      env.delete('HTTP_EXPECT'.freeze)
+                   "100 Continue\r\n\r\nHTTP/1.1 " :
+                   "HTTP/1.1 100 Continue\r\n\r\n")
+      env.delete('HTTP_EXPECT')
     end
 
     # once a client is accepted, it is processed in its entirety here
@@ -720,7 +807,11 @@ module Pitchfork
       @request = Pitchfork::HttpParser.new
       env = @request.read(client)
 
-      proc_name status: "requests: #{worker.requests_count}, processing: #{env["PATH_INFO"]}"
+      status = "requests: #{worker.requests_count}, processing: #{env["PATH_INFO"]}"
+      if request_id = env["HTTP_X_REQUEST_ID"]
+        status += ", request_id: #{request_id}"
+      end
+      proc_name status: status
 
       env["pitchfork.worker"] = worker
       timeout_handler.rack_env = env
@@ -814,6 +905,18 @@ module Pitchfork
       readers
     end
 
+    def init_service_process(service)
+      proc_name role: "(gen:#{service.generation}) mold", status: "init"
+      LISTENERS.each(&:close) # Don't appear as listening to incoming requests
+      service.register_to_master(@control_socket[1])
+      readers = [service]
+      trap(:QUIT) { nuke_listeners!(readers) }
+      trap(:TERM) { nuke_listeners!(readers) }
+      trap(:INT) { nuke_listeners!(readers); exit!(0) }
+      proc_name role: "(gen:#{service.generation}) service", status: "ready"
+      readers
+    end
+
     def init_mold_process(mold)
       proc_name role: "(gen:#{mold.generation}) mold", status: "init"
       after_mold_fork.call(self, mold)
@@ -827,7 +930,7 @@ module Pitchfork
 
     if Pitchfork.const_defined?(:Waiter)
       def prep_readers(readers)
-        Pitchfork::Waiter.prep_readers(readers)
+        Pitchfork::Info.keep_io(Pitchfork::Waiter.prep_readers(readers))
       end
     else
       require_relative 'select_waiter'
@@ -855,24 +958,25 @@ module Pitchfork
             # Pitchfork::Worker#accept_nonblock is not like accept(2) at all,
             # but that will return false
             client = sock.accept_nonblock(exception: false)
-            client = false if client == :wait_readable
-            if client
-              case client
-              when Message::PromoteWorker
-                if Info.fork_safe?
-                  spawn_mold(worker)
-                else
-                  logger.error("worker=#{worker.nr} gen=#{worker.generation} is no longer fork safe, can't refork")
-                end
-              when Message
-                worker.update(client)
+
+            case client
+            when false, :wait_readable
+              # no message, keep looping
+            when Message::PromoteWorker
+              if Info.fork_safe?
+                spawn_mold(worker)
               else
-                request_env = process_client(client, worker, prepare_timeout(worker))
-                @after_request_complete&.call(self, worker, request_env)
-                worker.increment_requests_count
+                logger.error("worker=#{worker.nr} gen=#{worker.generation} is no longer fork safe, can't refork")
               end
-              worker.update_deadline(@timeout)
+            when Message
+              worker.update(client)
+            else
+              request_env = process_client(client, worker, prepare_timeout(worker))
+              worker.increment_requests_count
+              @after_request_complete&.call(self, worker, request_env)
             end
+
+            worker.update_deadline(@timeout)
           end
 
           # timeout so we can update .deadline and keep parent from SIGKILL-ing us
@@ -955,6 +1059,22 @@ module Pitchfork
               rescue => error
                 raise BootFailure, error.message
               end
+            when Message::SpawnService
+              retries = 1
+              begin
+                spawn_service(Service.new(generation: mold.generation), detach: true)
+              rescue ForkFailure
+                if retries > 0
+                  @logger.fatal("mold pid=#{mold.pid} gen=#{mold.generation} Failed to spawn a service. Retrying.")
+                  retries -= 1
+                  retry
+                else
+                  @logger.fatal("mold pid=#{mold.pid} gen=#{mold.generation} Failed to spawn a service twice in a row. Corrupted mold process?")
+                  Process.exit(1)
+                end
+              rescue => error
+                raise BootFailure, error.message
+              end
             else
               logger.error("Unexpected mold message #{message.inspect}")
             end
@@ -1001,7 +1121,7 @@ module Pitchfork
       @proctitle_role = role if role
       @proctitle_status = status if status
 
-      Process.setproctitle("#{File.basename(START_CTX[0])} #{@proctitle_role} - #{@proctitle_status}")
+      Process.setproctitle("#{File.basename($PROGRAM_NAME)} #{@proctitle_role} - #{@proctitle_status}")
     end
 
     def bind_listeners!
@@ -1009,7 +1129,6 @@ module Pitchfork
       if listeners.empty?
         listeners << Pitchfork::Const::DEFAULT_LISTEN
         @init_listeners << Pitchfork::Const::DEFAULT_LISTEN
-        START_CTX[:argv] << "-l#{Pitchfork::Const::DEFAULT_LISTEN}"
       end
       listeners.each { |addr| listen(addr) }
       raise ArgumentError, "no listeners" if LISTENERS.empty?

data/lib/pitchfork/launcher.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 
 # :enddoc:
 $stdout.sync = $stderr.sync = true

data/lib/pitchfork/message.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 
 # :stopdoc:
 module Pitchfork
@@ -121,12 +122,16 @@ module Pitchfork
 
   Message = Class.new(Struct)
   class Message
-    SpawnWorker = Message.new(:nr)
-    WorkerSpawned = Message.new(:nr, :pid, :generation, :pipe)
-    PromoteWorker = Message.new(:generation)
-    MoldSpawned = Message.new(:nr, :pid, :generation, :pipe)
-    MoldReady = Message.new(:nr, :pid, :generation)
+    SpawnWorker = new(:nr)
+    WorkerSpawned = new(:nr, :pid, :generation, :pipe)
+    PromoteWorker = new(:generation)
 
-    SoftKill = Message.new(:signum)
+    MoldSpawned = new(:nr, :pid, :generation, :pipe)
+    MoldReady = new(:nr, :pid, :generation)
+
+    SpawnService = new(:_) # Struct.new requires at least 1 member on Ruby < 3.3
+    ServiceSpawned = new(:pid, :generation, :pipe)
+
+    SoftKill = new(:signum)
   end
 end

data/lib/pitchfork/select_waiter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Pitchfork
   # fallback for non-Linux and Linux <4.5 systems w/o EPOLLEXCLUSIVE
   class SelectWaiter # :nodoc:

data/lib/pitchfork/shared_memory.rb

@@ -1,40 +1,38 @@
 # frozen_string_literal: true
 
-require 'raindrops'
-
 module Pitchfork
   module SharedMemory
     extend self
 
-    PER_DROP = Raindrops::PAGE_SIZE / Raindrops::SIZE
     CURRENT_GENERATION_OFFSET = 0
     SHUTDOWN_OFFSET = 1
     MOLD_TICK_OFFSET = 2
     MOLD_PROMOTION_TICK_OFFSET = 3
-    WORKER_TICK_OFFSET = 4
+    SERVICE_TICK_OFFSET = 4
+    WORKER_TICK_OFFSET = 5
 
-    DROPS = [Raindrops.new(PER_DROP)]
+    PAGES = [MemoryPage.new(MemoryPage::SLOTS)]
 
     def current_generation
-      DROPS[0][CURRENT_GENERATION_OFFSET]
+      PAGES[0][CURRENT_GENERATION_OFFSET]
     end
 
     def current_generation=(value)
-      DROPS[0][CURRENT_GENERATION_OFFSET] = value
+      PAGES[0][CURRENT_GENERATION_OFFSET] = value
     end
 
     def shutting_down!
-      DROPS[0][SHUTDOWN_OFFSET] = 1
+      PAGES[0][SHUTDOWN_OFFSET] = 1
     end
 
     def shutting_down?
-      DROPS[0][SHUTDOWN_OFFSET] > 0
+      PAGES[0][SHUTDOWN_OFFSET] > 0
     end
 
     class Field
       def initialize(offset)
-        @drop = DROPS.fetch(offset / PER_DROP)
-        @offset = offset % PER_DROP
+        @drop = PAGES.fetch(offset / MemoryPage::SLOTS)
+        @offset = offset % MemoryPage::SLOTS
       end
 
       def value
@@ -54,6 +52,10 @@ module Pitchfork
       self[MOLD_PROMOTION_TICK_OFFSET]
     end
 
+    def service_deadline
+      self[SERVICE_TICK_OFFSET]
+    end
+
     def worker_deadline(worker_nr)
       self[WORKER_TICK_OFFSET + worker_nr]
     end
@@ -67,9 +69,9 @@ module Pitchfork
     #
     # However this doesn't account for TTIN signals that increase the
     # number of workers, but we should probably remove that feature too.
-    def preallocate_drops(workers_count)
-      0.upto(((WORKER_TICK_OFFSET + workers_count) / PER_DROP.to_f).ceil) do |i|
-        DROPS[i] ||= Raindrops.new(PER_DROP)
+    def preallocate_pages(workers_count)
+      0.upto(((WORKER_TICK_OFFSET + workers_count) / MemoryPage::SLOTS.to_f).ceil) do |i|
+        PAGES[i] ||= MemoryPage.new(MemoryPage::SLOTS)
       end
     end
   end

data/lib/pitchfork/socket_helper.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 # :enddoc:
 require 'socket'
 
@@ -71,7 +72,7 @@ module Pitchfork
         rescue => e
           logger.error("#{sock_name(sock)} " \
                        "failed to set accept_filter=#{name} (#{e.inspect})")
-          logger.error("perhaps accf_http(9) needs to be loaded".freeze)
+          logger.error("perhaps accf_http(9) needs to be loaded")
         end if arg != got
       end
     end

data/lib/pitchfork/stream_input.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 
 module Pitchfork
   # When processing uploads, pitchfork may expose a StreamInput object under
@@ -17,7 +18,7 @@ module Pitchfork
       @socket = socket
       @parser = request
       @buf = request.buf
-      @rbuf = ''
+      @rbuf = +''
       @bytes_read = 0
       filter_body(@rbuf, @buf) unless @buf.empty?
     end
@@ -41,7 +42,7 @@ module Pitchfork
     # ios.read(length [, buffer]) will return immediately if there is
     # any data and only block when nothing is available (providing
     # IO#readpartial semantics).
-    def read(length = nil, rv = '')
+    def read(length = nil, rv = ''.b)
       if length
         if length <= @rbuf.size
           length < 0 and raise ArgumentError, "negative length #{length} given"
@@ -79,16 +80,16 @@ module Pitchfork
     # unlike IO#gets.
     def gets(sep = $/)
       if sep.nil?
-        read_all(rv = '')
+        read_all(rv = ''.b)
         return rv.empty? ? nil : rv
       end
       re = /\A(.*?#{Regexp.escape(sep)})/
 
       begin
-        @rbuf.sub!(re, '') and return $1
+        @rbuf.sub!(re, ''.b) and return $1
         return @rbuf.empty? ? nil : @rbuf.slice!(0, @rbuf.size) if eof?
         @socket.readpartial(@@io_chunk_size, @buf) or eof!
-        filter_body(once = '', @buf)
+        filter_body(once = ''.b, @buf)
         @rbuf << once
       end while true
     end

data/lib/pitchfork/tee_input.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 
 module Pitchfork
   # Acts like tee(1) on an input input to provide a input-like stream
@@ -42,7 +43,7 @@ module Pitchfork
       @len = request.content_length
       super
       @tmp = @len && @len <= @@client_body_buffer_size ?
-             StringIO.new("") : new_tmpio
+             StringIO.new.binmode : new_tmpio
     end
 
     # :call-seq:
@@ -121,7 +122,7 @@ module Pitchfork
 
     # consumes the stream of the socket
     def consume!
-      junk = ""
+      junk = "".b
       nil while read(@@io_chunk_size, junk)
     end
 

data/lib/pitchfork/tmpio.rb

@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# frozen_string_literal: true
 # :stopdoc:
 require 'tmpdir'
 

data/lib/pitchfork/version.rb

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