raptor 0.11.0 → 0.12.0

data/sig/generated/raptor/cluster.rbs

@@ -40,57 +40,85 @@ module Raptor
     # @rbs (Hash[Symbol, untyped] options) -> void
     def self.run: (Hash[Symbol, untyped] options) -> void
 
-    @http2_options: Hash[Symbol, untyped]
+    @bpf_active: bool
 
-    @worker_boot_timeout: Integer
+    @server_port: Integer
 
-    @worker_timeout: Integer
+    @binder: Binder
 
-    @worker_drain_timeout: Integer
+    @on_error: ^(Hash[String, untyped]?, Exception) -> void | nil
 
-    @worker_shutdown_timeout: Integer
+    @launch_argv: Array[String]?
 
-    @stats_file: String?
+    @launch_command: String?
 
-    @pid_file: String?
+    @access_log_io: IO?
 
-    @stdout_file: String?
+    @access_log_file: String?
 
     @stderr_file: String?
 
-    @access_log_file: String?
+    @stdout_file: String?
 
-    @access_log_io: IO?
+    @pid_file: String?
 
-    @launch_command: String?
+    @stats_file: String?
 
-    @launch_argv: Array[String]?
+    @before_refork: Array[Proc]
 
-    @on_error: ^(Hash[String, untyped]?, Exception) -> void | nil
+    @before_worker_shutdown: Array[Proc]
 
-    @binder: Binder
+    @before_worker_boot: Array[Proc]
 
-    @server_port: Integer
+    @before_fork: Array[Proc]
 
-    @app: untyped
+    @worker_shutdown_timeout: Integer
 
-    @shutdown: bool
+    @worker_drain_timeout: Integer
 
-    @workers: Hash[Integer, Integer]
+    @worker_timeout: Integer
 
-    @timed_out: Set[Integer]
+    @worker_boot_timeout: Integer
 
-    @stats: Stats
+    @resp_w: IO?
 
-    @phase: Integer
+    @resp_r: IO?
 
-    @phased_restart_requested: bool
+    @fork_w: IO?
 
-    @phased_restarting: bool
+    @fork_r: IO?
+
+    @seed_vacated_index: Integer?
+
+    @seed_ready: bool
+
+    @seed_pid: Integer?
+
+    @refork_threshold_idx: Integer
+
+    @refork_requested: bool
+
+    @refork_thresholds: Array[Integer]
 
     @hot_restart_requested: bool
 
-    @bpf_active: bool
+    @phased_restarting: bool
+
+    @phased_restart_requested: bool
+
+    @phase: Integer
+
+    @stats: Stats
+
+    @timed_out: Set[Integer]
+
+    @workers: Hash[Integer, Integer]
+
+    @shutdown: bool
+
+    @app: untyped
+
+    @http2_options: Hash[Symbol, untyped]
 
     @http1_options: Hash[Symbol, untyped]
 
@@ -130,6 +158,11 @@ module Raptor
     # @option options [Integer] :worker_timeout seconds to wait for a booted worker to check in before killing it
     # @option options [Integer] :worker_drain_timeout seconds a worker waits for in-flight requests during shutdown before force-killing app threads
     # @option options [Integer] :worker_shutdown_timeout seconds to wait for graceful worker exit before force-killing
+    # @option options [Integer, Array<Integer>, nil] :refork_after request-count threshold(s) at which a warm worker is promoted to a fork source for phased refork; nil or 0 disables. Requires `PR_SET_CHILD_SUBREAPER` (Linux)
+    # @option options [Array<Proc>] :before_fork procs called in the master before every worker fork
+    # @option options [Array<Proc>] :before_worker_boot procs called in each worker before it begins serving
+    # @option options [Array<Proc>] :before_worker_shutdown procs called in each worker before its graceful shutdown
+    # @option options [Array<Proc>] :before_refork procs called in a worker before it transitions to a seed
     # @option options [String, nil] :stats_file path to write per-worker stats JSON, or nil to disable
     # @option options [String, nil] :pid_file path to write the master PID to, or nil to disable
     # @option options [String, nil] :stdout_file path to redirect stdout to, reopened on SIGHUP, or nil to disable
@@ -185,8 +218,18 @@ module Raptor
     # @rbs (Array[String] bind_uris, Array[Integer] filenos) -> Hash[String, Array[Integer]]
     def pair_systemd_fds: (Array[String] bind_uris, Array[Integer] filenos) -> Hash[String, Array[Integer]]
 
-    # Forks a new worker process and registers it at the given index.
-    # The worker inherits the cluster's current phase.
+    # Normalises the `refork_after` option into a sorted array of positive
+    # thresholds. Accepts nil, 0, an Integer, or an Array<Integer>; anything
+    # else falls back to an empty array (feature disabled).
+    #
+    # @param value [Integer, Array<Integer>, nil] the raw option value
+    # @return [Array<Integer>]
+    #
+    # @rbs (untyped value) -> Array[Integer]
+    def normalize_refork_thresholds: (untyped value) -> Array[Integer]
+
+    # Forks a new worker process and registers it at the given index,
+    # forking from the seed when one is active and off the master otherwise.
     #
     # @param index [Integer] slot index for this worker in the stats region
     # @return [void]
@@ -194,16 +237,87 @@ module Raptor
     # @rbs (Integer index) -> void
     def spawn_worker: (Integer index) -> void
 
+    # Asks the seed to fork a new worker at the given index, returning the
+    # child pid, or nil when the seed doesn't respond in time.
+    #
+    # @param index [Integer] slot index for the new worker
+    # @return [Integer, nil] the forked worker's pid, or nil on failure
+    #
+    # @rbs (Integer index) -> Integer?
+    def spawn_worker_via_seed: (Integer index) -> Integer?
+
+    # Checks whether a process with the given pid is currently alive.
+    #
+    # @param pid [Integer] the pid to probe
+    # @return [Boolean] true if the process exists
+    #
+    # @rbs (Integer pid) -> bool
+    def pid_alive?: (Integer pid) -> bool
+
     # Reaps any worker processes that have exited, respawning each one
     # unless the cluster is shutting down.
     #
-    # @return [Symbol] :no_children when there are no remaining children, otherwise :reaped
+    # @return [Symbol] :no_children when nothing is left to supervise, otherwise :reaped
     #
     # @rbs () -> Symbol
     def reap_workers: () -> Symbol
 
-    # Stops every worker, escalating from TERM to KILL if any fail to
-    # exit within `worker_shutdown_timeout`.
+    # Records a reaped pid, respawning its worker slot unless the cluster
+    # is shutting down. Clears the seed reference when the seed exits.
+    #
+    # @param pid [Integer] the reaped pid
+    # @param status [Process::Status] the exit status
+    # @return [void]
+    #
+    # @rbs (Integer pid, Process::Status status) -> void
+    def reap_pid: (Integer pid, Process::Status status) -> void
+
+    # Promotes the most-experienced worker to a seed and starts a phased
+    # refork when the next `refork_after` threshold is crossed or a manual
+    # refork was requested via `SIGURG`.
+    #
+    # @return [void]
+    #
+    # @rbs () -> void
+    def check_refork_trigger: () -> void
+
+    # Picks the most-experienced booted worker in the current phase,
+    # returning its slot index and its request count. Returns nil when
+    # no worker qualifies.
+    #
+    # @return [Array<Integer>, nil]
+    #
+    # @rbs () -> Array[Integer]?
+    def pick_refork_candidate: () -> Array[Integer]?
+
+    # Retires the current seed and promotes the given worker into its place,
+    # queueing a phased refork for the remaining workers.
+    #
+    # @param index [Integer] slot index of the worker to promote
+    # @return [void]
+    #
+    # @rbs (Integer index) -> void
+    def promote_worker_to_seed: (Integer index) -> void
+
+    # Terminates the currently-active seed process, if any, and waits for
+    # it to exit. Its seed-forked workers stay attached to the master and
+    # keep serving.
+    #
+    # @return [void]
+    #
+    # @rbs () -> void
+    def retire_current_seed: () -> void
+
+    # Records the seed's readiness when its ready marker has arrived.
+    # Non-blocking.
+    #
+    # @return [void]
+    #
+    # @rbs () -> void
+    def poll_seed_ready: () -> void
+
+    # Stops every worker (and the seed if one is active), escalating
+    # from TERM to KILL if any fail to exit within `worker_shutdown_timeout`.
     #
     # @return [void]
     #
@@ -229,6 +343,23 @@ module Raptor
     # @rbs () -> void
     def perform_phased_restart: () -> void
 
+    # Blocks until the freshly-promoted seed has signalled readiness,
+    # or times out and clears the seed reference. No-op when no seed is
+    # being promoted.
+    #
+    # @return [void]
+    #
+    # @rbs () -> void
+    def wait_for_seed_ready: () -> void
+
+    # Spawns a replacement worker for the slot the seed vacated when
+    # it was promoted, returning the slot index it filled.
+    #
+    # @return [Integer, nil] the filled slot index, or nil if none was vacated
+    #
+    # @rbs () -> Integer?
+    def fill_vacated_seed_slot: () -> Integer?
+
     # Re-execs the master process with a fresh boot of the same Raptor
     # invocation, handing the new master its listening sockets so accepted
     # connections continue to be served across the swap.
@@ -238,11 +369,10 @@ module Raptor
     # @rbs () -> void
     def perform_hot_restart: () -> void
 
-    # Runs the full server stack inside a worker process.
-    #
-    # Sets up and coordinates the reactor, server, ractor pool, thread pool,
-    # and stats thread, running until a shutdown signal is received or a
-    # critical component fails.
+    # Runs a worker process's full server stack until a shutdown signal is
+    # received or a critical component fails. On `SIGURG` the worker drains
+    # and transitions into a seed loop that forks replacement workers on
+    # master's request.
     #
     # @param index [Integer] slot index for this worker in the stats region
     # @param phase [Integer] the cluster phase this worker was forked at
@@ -251,6 +381,15 @@ module Raptor
     # @rbs (Integer index, Integer phase) -> void
     def run_worker: (Integer index, Integer phase) -> void
 
+    # Runs the seed's fork loop, forking a replacement worker for each
+    # slot index the master asks for.
+    #
+    # @param index [Integer] the seed's original slot index
+    # @return [void]
+    #
+    # @rbs (Integer index) -> void
+    def run_seed_loop: (Integer index) -> void
+
     # Shuts down the worker's application thread pool, force-killing the
     # underlying threads if in-flight requests have not finished within
     # `worker_drain_timeout` seconds.

data/sig/generated/raptor/reuseport_bpf.rbs

@@ -52,5 +52,14 @@ module Raptor
     #
     # @rbs (Integer backlog) -> void
     def self.update_load: (Integer backlog) -> void
+
+    # Marks a worker's slot as unavailable by parking its load at the
+    # sentinel maximum so the BPF program's least-loaded pick skips it.
+    #
+    # @param worker_index [Integer] slot index for the worker to mark
+    # @return [void]
+    #
+    # @rbs (Integer worker_index) -> void
+    def self.mark_unavailable: (Integer worker_index) -> void
   end
 end

data/sig/generated/raptor/server.rbs

@@ -82,11 +82,17 @@ module Raptor
     # @rbs () -> Thread
     def run: () -> Thread
 
-    # Gracefully shuts down the server.
+    # Stops the accept loop and, when `drain_accept_queue` is enabled,
+    # dispatches every connection already in the kernel accept queue. Leaves
+    # the listening sockets open so they can be handed to replacement workers.
     #
-    # Stops accepting new connections and closes all listening sockets. When
-    # `drain_accept_queue` is enabled, dispatches every connection already in
-    # the kernel accept queue before closing the listeners.
+    # @return [void]
+    #
+    # @rbs () -> void
+    def stop_accepting: () -> void
+
+    # Gracefully shuts down the server, stopping the accept loop and closing
+    # all listening sockets.
     #
     # @return [void]
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raptor
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Joshua Young