lib/unicorn.rb

   1 # -*- encoding: binary -*-
   2
   3 require 'fcntl'
   4 require 'unicorn/socket_helper'
   5 autoload :Rack, 'rack'
   6
   7 # Unicorn module containing all of the classes (include C extensions) for running
   8 # a Unicorn web server.  It contains a minimalist HTTP server with just enough
   9 # functionality to service web application requests fast as possible.
  10 module Unicorn
  11   autoload :Const, 'unicorn/const'
  12   autoload :HttpRequest, 'unicorn/http_request'
  13   autoload :HttpResponse, 'unicorn/http_response'
  14   autoload :Configurator, 'unicorn/configurator'
  15   autoload :TeeInput, 'unicorn/tee_input'
  16   autoload :Util, 'unicorn/util'
  17
  18   class << self
  19     def run(app, options = {})
  20       HttpServer.new(app, options).start.join
  21     end
  22   end
  23
  24   # This is the process manager of Unicorn. This manages worker
  25   # processes which in turn handle the I/O and application process.
  26   # Listener sockets are started in the master process and shared with
  27   # forked worker children.
  28
  29   class HttpServer < Struct.new(:listener_opts, :timeout, :worker_processes,
  30                                 :before_fork, :after_fork, :before_exec,
  31                                 :logger, :pid, :app, :preload_app,
  32                                 :reexec_pid, :orig_app, :init_listeners,
  33                                 :master_pid, :config)
  34     include ::Unicorn::SocketHelper
  35
  36     # prevents IO objects in here from being GC-ed
  37     IO_PURGATORY = []
  38
  39     # all bound listener sockets
  40     LISTENERS = []
  41
  42     # This hash maps PIDs to Workers
  43     WORKERS = {}
  44
  45     # We use SELF_PIPE differently in the master and worker processes:
  46     #
  47     # * The master process never closes or reinitializes this once
  48     # initialized.  Signal handlers in the master process will write to
  49     # it to wake up the master from IO.select in exactly the same manner
  50     # djb describes in http://cr.yp.to/docs/selfpipe.html
  51     #
  52     # * The workers immediately close the pipe they inherit from the
  53     # master and replace it with a new pipe after forking.  This new
  54     # pipe is also used to wakeup from IO.select from inside (worker)
  55     # signal handlers.  However, workers *close* the pipe descriptors in
  56     # the signal handlers to raise EBADF in IO.select instead of writing
  57     # like we do in the master.  We cannot easily use the reader set for
  58     # IO.select because LISTENERS is already that set, and it's extra
  59     # work (and cycles) to distinguish the pipe FD from the reader set
  60     # once IO.select returns.  So we're lazy and just close the pipe when
  61     # a (rare) signal arrives in the worker and reinitialize the pipe later.
  62     SELF_PIPE = []
  63
  64     # signal queue used for self-piping
  65     SIG_QUEUE = []
  66
  67     # constant lookups are faster and we're single-threaded/non-reentrant
  68     REQUEST = HttpRequest.new
  69
  70     # We populate this at startup so we can figure out how to reexecute
  71     # and upgrade the currently running instance of Unicorn
  72     # This Hash is considered a stable interface and changing its contents
  73     # will allow you to switch between different installations of Unicorn
  74     # or even different installations of the same applications without
  75     # downtime.  Keys of this constant Hash are described as follows:
  76     #
  77     # * 0 - the path to the unicorn/unicorn_rails executable
  78     # * :argv - a deep copy of the ARGV array the executable originally saw
  79     # * :cwd - the working directory of the application, this is where
  80     # you originally started Unicorn.
  81     #
  82     # The following example may be used in your Unicorn config file to
  83     # change your working directory during a config reload (HUP) without
  84     # upgrading or restarting:
  85     #
  86     #   Dir.chdir(Unicorn::HttpServer::START_CTX[:cwd] = path)
  87     #
  88     # To change your unicorn executable to a different path without downtime,
  89     # you can set the following in your Unicorn config file, HUP and then
  90     # continue with the traditional USR2 + QUIT upgrade steps:
  91     #
  92     #   Unicorn::HttpServer::START_CTX[0] = "/home/bofh/1.9.2/bin/unicorn"
  93     START_CTX = {
  94       :argv => ARGV.map { |arg| arg.dup },
  95       :cwd => lambda {
  96           # favor ENV['PWD'] since it is (usually) symlink aware for
  97           # Capistrano and like systems
  98           begin
  99             a = File.stat(pwd = ENV['PWD'])
 100             b = File.stat(Dir.pwd)
 101             a.ino == b.ino && a.dev == b.dev ? pwd : Dir.pwd
 102           rescue
 103             Dir.pwd
 104           end
 105         }.call,
 106       0 => $0.dup,
 107     }
 108
 109     # This class and its members can be considered a stable interface
 110     # and will not change in a backwards-incompatible fashion between
 111     # releases of Unicorn.  You may need to access it in the
 112     # before_fork/after_fork hooks.  See the Unicorn::Configurator RDoc
 113     # for examples.
 114     class Worker < Struct.new(:nr, :tmp)
 115
 116       autoload :Etc, 'etc'
 117
 118       # worker objects may be compared to just plain numbers
 119       def ==(other_nr)
 120         self.nr == other_nr
 121       end
 122
 123       # Changes the worker process to the specified +user+ and +group+
 124       # This is only intended to be called from within the worker
 125       # process from the +after_fork+ hook.  This should be called in
 126       # the +after_fork+ hook after any priviledged functions need to be
 127       # run (e.g. to set per-worker CPU affinity, niceness, etc)
 128       #
 129       # Any and all errors raised within this method will be propagated
 130       # directly back to the caller (usually the +after_fork+ hook.
 131       # These errors commonly include ArgumentError for specifying an
 132       # invalid user/group and Errno::EPERM for insufficient priviledges
 133       def user(user, group = nil)
 134         # we do not protect the caller, checking Process.euid == 0 is
 135         # insufficient because modern systems have fine-grained
 136         # capabilities.  Let the caller handle any and all errors.
 137         uid = Etc.getpwnam(user).uid
 138         gid = Etc.getgrnam(group).gid if group
 139         tmp.chown(uid, gid)
 140         if gid && Process.egid != gid
 141           Process.initgroups(user, gid)
 142           Process::GID.change_privilege(gid)
 143         end
 144         Process.euid != uid and Process::UID.change_privilege(uid)
 145       end
 146
 147     end
 148
 149     # Creates a working server on host:port (strange things happen if
 150     # port isn't a Number).  Use HttpServer::run to start the server and
 151     # HttpServer.run.join to join the thread that's processing
 152     # incoming requests on the socket.
 153     def initialize(app, options = {})
 154       self.app = app
 155       self.reexec_pid = 0
 156       self.init_listeners = options[:listeners] ? options[:listeners].dup : []
 157       self.config = Configurator.new(options.merge(:use_defaults => true))
 158       self.listener_opts = {}
 159
 160       # we try inheriting listeners first, so we bind them later.
 161       # we don't write the pid file until we've bound listeners in case
 162       # unicorn was started twice by mistake.  Even though our #pid= method
 163       # checks for stale/existing pid files, race conditions are still
 164       # possible (and difficult/non-portable to avoid) and can be likely
 165       # to clobber the pid if the second start was in quick succession
 166       # after the first, so we rely on the listener binding to fail in
 167       # that case.  Some tests (in and outside of this source tree) and
 168       # monitoring tools may also rely on pid files existing before we
 169       # attempt to connect to the listener(s)
 170       config.commit!(self, :skip => [:listeners, :pid])
 171       self.orig_app = app
 172     end
 173
 174     # Runs the thing.  Returns self so you can run join on it
 175     def start
 176       BasicSocket.do_not_reverse_lookup = true
 177
 178       # inherit sockets from parents, they need to be plain Socket objects
 179       # before they become UNIXServer or TCPServer
 180       inherited = ENV['UNICORN_FD'].to_s.split(/,/).map do |fd|
 181         io = Socket.for_fd(fd.to_i)
 182         set_server_sockopt(io, listener_opts[sock_name(io)])
 183         IO_PURGATORY << io
 184         logger.info "inherited addr=#{sock_name(io)} fd=#{fd}"
 185         server_cast(io)
 186       end
 187
 188       config_listeners = config[:listeners].dup
 189       LISTENERS.replace(inherited)
 190
 191       # we start out with generic Socket objects that get cast to either
 192       # TCPServer or UNIXServer objects; but since the Socket objects
 193       # share the same OS-level file descriptor as the higher-level *Server
 194       # objects; we need to prevent Socket objects from being garbage-collected
 195       config_listeners -= listener_names
 196       if config_listeners.empty? && LISTENERS.empty?
 197         config_listeners << Unicorn::Const::DEFAULT_LISTEN
 198         init_listeners << Unicorn::Const::DEFAULT_LISTEN
 199         START_CTX[:argv] << "-l#{Unicorn::Const::DEFAULT_LISTEN}"
 200       end
 201       config_listeners.each { |addr| listen(addr) }
 202       raise ArgumentError, "no listeners" if LISTENERS.empty?
 203       self.pid = config[:pid]
 204       self.master_pid = $$
 205       build_app! if preload_app
 206       maintain_worker_count
 207       self
 208     end
 209
 210     # replaces current listener set with +listeners+.  This will
 211     # close the socket if it will not exist in the new listener set
 212     def listeners=(listeners)
 213       cur_names, dead_names = [], []
 214       listener_names.each do |name|
 215         if ?/ == name[0]
 216           # mark unlinked sockets as dead so we can rebind them
 217           (File.socket?(name) ? cur_names : dead_names) << name
 218         else
 219           cur_names << name
 220         end
 221       end
 222       set_names = listener_names(listeners)
 223       dead_names.concat(cur_names - set_names).uniq!
 224
 225       LISTENERS.delete_if do |io|
 226         if dead_names.include?(sock_name(io))
 227           IO_PURGATORY.delete_if do |pio|
 228             pio.fileno == io.fileno && (pio.close rescue nil).nil? # true
 229           end
 230           (io.close rescue nil).nil? # true
 231         else
 232           set_server_sockopt(io, listener_opts[sock_name(io)])
 233           false
 234         end
 235       end
 236
 237       (set_names - cur_names).each { |addr| listen(addr) }
 238     end
 239
 240     def stdout_path=(path); redirect_io($stdout, path); end
 241     def stderr_path=(path); redirect_io($stderr, path); end
 242
 243     alias_method :set_pid, :pid=
 244     undef_method :pid=
 245
 246     # sets the path for the PID file of the master process
 247     def pid=(path)
 248       if path
 249         if x = valid_pid?(path)
 250           return path if pid && path == pid && x == $$
 251           raise ArgumentError, "Already running on PID:#{x} " \
 252                                "(or pid=#{path} is stale)"
 253         end
 254       end
 255       unlink_pid_safe(pid) if pid
 256
 257       if path
 258         fp = begin
 259           tmp = "#{File.dirname(path)}/#{rand}.#$$"
 260           File.open(tmp, File::RDWR|File::CREAT|File::EXCL, 0644)
 261         rescue Errno::EEXIST
 262           retry
 263         end
 264         fp.syswrite("#$$\n")
 265         File.rename(fp.path, path)
 266         fp.close
 267       end
 268       self.set_pid(path)
 269     end
 270
 271     # add a given address to the +listeners+ set, idempotently
 272     # Allows workers to add a private, per-process listener via the
 273     # after_fork hook.  Very useful for debugging and testing.
 274     # +:tries+ may be specified as an option for the number of times
 275     # to retry, and +:delay+ may be specified as the time in seconds
 276     # to delay between retries.
 277     # A negative value for +:tries+ indicates the listen will be
 278     # retried indefinitely, this is useful when workers belonging to
 279     # different masters are spawned during a transparent upgrade.
 280     def listen(address, opt = {}.merge(listener_opts[address] || {}))
 281       address = config.expand_addr(address)
 282       return if String === address && listener_names.include?(address)
 283
 284       delay = opt[:delay] || 0.5
 285       tries = opt[:tries] || 5
 286       begin
 287         io = bind_listen(address, opt)
 288         unless TCPServer === io || UNIXServer === io
 289           IO_PURGATORY << io
 290           io = server_cast(io)
 291         end
 292         logger.info "listening on addr=#{sock_name(io)} fd=#{io.fileno}"
 293         LISTENERS << io
 294         return io
 295       rescue Errno::EADDRINUSE => err
 296         logger.error "adding listener failed addr=#{address} (in use)"
 297         raise err if tries == 0
 298         tries -= 1
 299         logger.error "retrying in #{delay} seconds " \
 300                      "(#{tries < 0 ? 'infinite' : tries} tries left)"
 301         sleep(delay)
 302         retry
 303       end
 304     end
 305
 306     # monitors children and receives signals forever
 307     # (or until a termination signal is sent).  This handles signals
 308     # one-at-a-time time and we'll happily drop signals in case somebody
 309     # is signalling us too often.
 310     def join
 311       # this pipe is used to wake us up from select(2) in #join when signals
 312       # are trapped.  See trap_deferred
 313       init_self_pipe!
 314       respawn = true
 315       last_check = Time.now
 316
 317       QUEUE_SIGS.each { |sig| trap_deferred(sig) }
 318       trap(:CHLD) { |sig_nr| awaken_master }
 319       proc_name 'master'
 320       logger.info "master process ready" # test_exec.rb relies on this message
 321       begin
 322         loop do
 323           reap_all_workers
 324           case SIG_QUEUE.shift
 325           when nil
 326             # avoid murdering workers after our master process (or the
 327             # machine) comes out of suspend/hibernation
 328             if (last_check + timeout) >= (last_check = Time.now)
 329               murder_lazy_workers
 330             end
 331             maintain_worker_count if respawn
 332             master_sleep
 333           when :QUIT # graceful shutdown
 334             break
 335           when :TERM, :INT # immediate shutdown
 336             stop(false)
 337             break
 338           when :USR1 # rotate logs
 339             logger.info "master reopening logs..."
 340             Unicorn::Util.reopen_logs
 341             logger.info "master done reopening logs"
 342             kill_each_worker(:USR1)
 343           when :USR2 # exec binary, stay alive in case something went wrong
 344             reexec
 345           when :WINCH
 346             if Process.ppid == 1 || Process.getpgrp != $$
 347               respawn = false
 348               logger.info "gracefully stopping all workers"
 349               kill_each_worker(:QUIT)
 350             else
 351               logger.info "SIGWINCH ignored because we're not daemonized"
 352             end
 353           when :TTIN
 354             self.worker_processes += 1
 355           when :TTOU
 356             self.worker_processes -= 1 if self.worker_processes > 0
 357           when :HUP
 358             respawn = true
 359             if config.config_file
 360               load_config!
 361               redo # immediate reaping since we may have QUIT workers
 362             else # exec binary and exit if there's no config file
 363               logger.info "config_file not present, reexecuting binary"
 364               reexec
 365               break
 366             end
 367           end
 368         end
 369       rescue Errno::EINTR
 370         retry
 371       rescue Object => e
 372         logger.error "Unhandled master loop exception #{e.inspect}."
 373         logger.error e.backtrace.join("\n")
 374         retry
 375       end
 376       stop # gracefully shutdown all workers on our way out
 377       logger.info "master complete"
 378       unlink_pid_safe(pid) if pid
 379     end
 380
 381     # Terminates all workers, but does not exit master process
 382     def stop(graceful = true)
 383       self.listeners = []
 384       limit = Time.now + timeout
 385       until WORKERS.empty? || Time.now > limit
 386         kill_each_worker(graceful ? :QUIT : :TERM)
 387         sleep(0.1)
 388         reap_all_workers
 389       end
 390       kill_each_worker(:KILL)
 391     end
 392
 393     private
 394
 395     # list of signals we care about and trap in master.
 396     QUEUE_SIGS = [ :WINCH, :QUIT, :INT, :TERM, :USR1, :USR2, :HUP,
 397                    :TTIN, :TTOU ]
 398
 399     # defer a signal for later processing in #join (master process)
 400     def trap_deferred(signal)
 401       trap(signal) do |sig_nr|
 402         if SIG_QUEUE.size < 5
 403           SIG_QUEUE << signal
 404           awaken_master
 405         else
 406           logger.error "ignoring SIG#{signal}, queue=#{SIG_QUEUE.inspect}"
 407         end
 408       end
 409     end
 410
 411     # wait for a signal hander to wake us up and then consume the pipe
 412     # Wake up every second anyways to run murder_lazy_workers
 413     def master_sleep
 414       begin
 415         ready = IO.select([SELF_PIPE.first], nil, nil, 1) or return
 416         ready.first && ready.first.first or return
 417         loop { SELF_PIPE.first.read_nonblock(Const::CHUNK_SIZE) }
 418       rescue Errno::EAGAIN, Errno::EINTR
 419       end
 420     end
 421
 422     def awaken_master
 423       begin
 424         SELF_PIPE.last.write_nonblock('.') # wakeup master process from select
 425       rescue Errno::EAGAIN, Errno::EINTR
 426         # pipe is full, master should wake up anyways
 427         retry
 428       end
 429     end
 430
 431     # reaps all unreaped workers
 432     def reap_all_workers
 433       begin
 434         loop do
 435           wpid, status = Process.waitpid2(-1, Process::WNOHANG)
 436           wpid or break
 437           if reexec_pid == wpid
 438             logger.error "reaped #{status.inspect} exec()-ed"
 439             self.reexec_pid = 0
 440             self.pid = pid.chomp('.oldbin') if pid
 441             proc_name 'master'
 442           else
 443             worker = WORKERS.delete(wpid) and worker.tmp.close rescue nil
 444             logger.info "reaped #{status.inspect} " \
 445                         "worker=#{worker.nr rescue 'unknown'}"
 446           end
 447         end
 448       rescue Errno::ECHILD
 449       end
 450     end
 451
 452     # reexecutes the START_CTX with a new binary
 453     def reexec
 454       if reexec_pid > 0
 455         begin
 456           Process.kill(0, reexec_pid)
 457           logger.error "reexec-ed child already running PID:#{reexec_pid}"
 458           return
 459         rescue Errno::ESRCH
 460           self.reexec_pid = 0
 461         end
 462       end
 463
 464       if pid
 465         old_pid = "#{pid}.oldbin"
 466         prev_pid = pid.dup
 467         begin
 468           self.pid = old_pid  # clear the path for a new pid file
 469         rescue ArgumentError
 470           logger.error "old PID:#{valid_pid?(old_pid)} running with " \
 471                        "existing pid=#{old_pid}, refusing rexec"
 472           return
 473         rescue Object => e
 474           logger.error "error writing pid=#{old_pid} #{e.class} #{e.message}"
 475           return
 476         end
 477       end
 478
 479       self.reexec_pid = fork do
 480         listener_fds = LISTENERS.map { |sock| sock.fileno }
 481         ENV['UNICORN_FD'] = listener_fds.join(',')
 482         Dir.chdir(START_CTX[:cwd])
 483         cmd = [ START_CTX[0] ].concat(START_CTX[:argv])
 484
 485         # avoid leaking FDs we don't know about, but let before_exec
 486         # unset FD_CLOEXEC, if anything else in the app eventually
 487         # relies on FD inheritence.
 488         (3..1024).each do |io|
 489           next if listener_fds.include?(io)
 490           io = IO.for_fd(io) rescue nil
 491           io or next
 492           IO_PURGATORY << io
 493           io.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
 494         end
 495         logger.info "executing #{cmd.inspect} (in #{Dir.pwd})"
 496         before_exec.call(self)
 497         exec(*cmd)
 498       end
 499       proc_name 'master (old)'
 500     end
 501
 502     # forcibly terminate all workers that haven't checked in in timeout
 503     # seconds.  The timeout is implemented using an unlinked File
 504     # shared between the parent process and each worker.  The worker
 505     # runs File#chmod to modify the ctime of the File.  If the ctime
 506     # is stale for >timeout seconds, then we'll kill the corresponding
 507     # worker.
 508     def murder_lazy_workers
 509       WORKERS.dup.each_pair do |wpid, worker|
 510         (diff = (Time.now - worker.tmp.stat.ctime)) <= timeout and next
 511         logger.error "worker=#{worker.nr} PID:#{wpid} timeout " \
 512                      "(#{diff}s > #{timeout}s), killing"
 513         kill_worker(:KILL, wpid) # take no prisoners for timeout violations
 514       end
 515     end
 516
 517     def spawn_missing_workers
 518       (0...worker_processes).each do |worker_nr|
 519         WORKERS.values.include?(worker_nr) and next
 520         worker = Worker.new(worker_nr, Unicorn::Util.tmpio)
 521         before_fork.call(self, worker)
 522         WORKERS[fork { worker_loop(worker) }] = worker
 523       end
 524     end
 525
 526     def maintain_worker_count
 527       (off = WORKERS.size - worker_processes) == 0 and return
 528       off < 0 and return spawn_missing_workers
 529       WORKERS.dup.each_pair { |wpid,w|
 530         w.nr >= worker_processes and kill_worker(:QUIT, wpid) rescue nil
 531       }
 532     end
 533
 534     # if we get any error, try to write something back to the client
 535     # assuming we haven't closed the socket, but don't get hung up
 536     # if the socket is already closed or broken.  We'll always ensure
 537     # the socket is closed at the end of this function
 538     def handle_error(client, e)
 539       msg = case e
 540       when EOFError,Errno::ECONNRESET,Errno::EPIPE,Errno::EINVAL,Errno::EBADF
 541         Const::ERROR_500_RESPONSE
 542       when HttpParserError # try to tell the client they're bad
 543         Const::ERROR_400_RESPONSE
 544       else
 545         logger.error "Read error: #{e.inspect}"
 546         logger.error e.backtrace.join("\n")
 547         Const::ERROR_500_RESPONSE
 548       end
 549       client.write_nonblock(msg)
 550       client.close
 551       rescue
 552         nil
 553     end
 554
 555     # once a client is accepted, it is processed in its entirety here
 556     # in 3 easy steps: read request, call app, write app response
 557     def process_client(client)
 558       client.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
 559       response = app.call(env = REQUEST.read(client))
 560
 561       if 100 == response.first.to_i
 562         client.write(Const::EXPECT_100_RESPONSE)
 563         env.delete(Const::HTTP_EXPECT)
 564         response = app.call(env)
 565       end
 566       HttpResponse.write(client, response, HttpRequest::PARSER.headers?)
 567     rescue => e
 568       handle_error(client, e)
 569     end
 570
 571     # gets rid of stuff the worker has no business keeping track of
 572     # to free some resources and drops all sig handlers.
 573     # traps for USR1, USR2, and HUP may be set in the after_fork Proc
 574     # by the user.
 575     def init_worker_process(worker)
 576       QUEUE_SIGS.each { |sig| trap(sig, nil) }
 577       trap(:CHLD, 'DEFAULT')
 578       SIG_QUEUE.clear
 579       proc_name "worker[#{worker.nr}]"
 580       START_CTX.clear
 581       init_self_pipe!
 582       WORKERS.values.each { |other| other.tmp.close rescue nil }
 583       WORKERS.clear
 584       LISTENERS.each { |sock| sock.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC) }
 585       worker.tmp.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
 586       after_fork.call(self, worker) # can drop perms
 587       self.timeout /= 2.0 # halve it for select()
 588       build_app! unless preload_app
 589     end
 590
 591     def reopen_worker_logs(worker_nr)
 592       logger.info "worker=#{worker_nr} reopening logs..."
 593       Unicorn::Util.reopen_logs
 594       logger.info "worker=#{worker_nr} done reopening logs"
 595       init_self_pipe!
 596     end
 597
 598     # runs inside each forked worker, this sits around and waits
 599     # for connections and doesn't die until the parent dies (or is
 600     # given a INT, QUIT, or TERM signal)
 601     def worker_loop(worker)
 602       ppid = master_pid
 603       init_worker_process(worker)
 604       nr = 0 # this becomes negative if we need to reopen logs
 605       alive = worker.tmp # tmp is our lifeline to the master process
 606       ready = LISTENERS
 607
 608       # closing anything we IO.select on will raise EBADF
 609       trap(:USR1) { nr = -65536; SELF_PIPE.first.close rescue nil }
 610       trap(:QUIT) { alive = nil; LISTENERS.each { |s| s.close rescue nil } }
 611       [:TERM, :INT].each { |sig| trap(sig) { exit!(0) } } # instant shutdown
 612       logger.info "worker=#{worker.nr} ready"
 613       m = 0
 614
 615       begin
 616         nr < 0 and reopen_worker_logs(worker.nr)
 617         nr = 0
 618
 619         # we're a goner in timeout seconds anyways if alive.chmod
 620         # breaks, so don't trap the exception.  Using fchmod() since
 621         # futimes() is not available in base Ruby and I very strongly
 622         # prefer temporary files to be unlinked for security,
 623         # performance and reliability reasons, so utime is out.  No-op
 624         # changes with chmod doesn't update ctime on all filesystems; so
 625         # we change our counter each and every time (after process_client
 626         # and before IO.select).
 627         alive.chmod(m = 0 == m ? 1 : 0)
 628
 629         ready.each do |sock|
 630           begin
 631             process_client(sock.accept_nonblock)
 632             nr += 1
 633             alive.chmod(m = 0 == m ? 1 : 0)
 634           rescue Errno::EAGAIN, Errno::ECONNABORTED
 635           end
 636           break if nr < 0
 637         end
 638
 639         # make the following bet: if we accepted clients this round,
 640         # we're probably reasonably busy, so avoid calling select()
 641         # and do a speculative accept_nonblock on ready listeners
 642         # before we sleep again in select().
 643         redo unless nr == 0 # (nr < 0) => reopen logs
 644
 645         ppid == Process.ppid or return
 646         alive.chmod(m = 0 == m ? 1 : 0)
 647         begin
 648           # timeout used so we can detect parent death:
 649           ret = IO.select(LISTENERS, nil, SELF_PIPE, timeout) or redo
 650           ready = ret.first
 651         rescue Errno::EINTR
 652           ready = LISTENERS
 653         rescue Errno::EBADF
 654           nr < 0 or return
 655         end
 656       rescue Object => e
 657         if alive
 658           logger.error "Unhandled listen loop exception #{e.inspect}."
 659           logger.error e.backtrace.join("\n")
 660         end
 661       end while alive
 662     end
 663
 664     # delivers a signal to a worker and fails gracefully if the worker
 665     # is no longer running.
 666     def kill_worker(signal, wpid)
 667       begin
 668         Process.kill(signal, wpid)
 669       rescue Errno::ESRCH
 670         worker = WORKERS.delete(wpid) and worker.tmp.close rescue nil
 671       end
 672     end
 673
 674     # delivers a signal to each worker
 675     def kill_each_worker(signal)
 676       WORKERS.keys.each { |wpid| kill_worker(signal, wpid) }
 677     end
 678
 679     # unlinks a PID file at given +path+ if it contains the current PID
 680     # still potentially racy without locking the directory (which is
 681     # non-portable and may interact badly with other programs), but the
 682     # window for hitting the race condition is small
 683     def unlink_pid_safe(path)
 684       (File.read(path).to_i == $$ and File.unlink(path)) rescue nil
 685     end
 686
 687     # returns a PID if a given path contains a non-stale PID file,
 688     # nil otherwise.
 689     def valid_pid?(path)
 690       wpid = File.read(path).to_i
 691       wpid <= 0 and return nil
 692       begin
 693         Process.kill(0, wpid)
 694         return wpid
 695       rescue Errno::ESRCH
 696         # don't unlink stale pid files, racy without non-portable locking...
 697       end
 698       rescue Errno::ENOENT
 699     end
 700
 701     def load_config!
 702       begin
 703         logger.info "reloading config_file=#{config.config_file}"
 704         config[:listeners].replace(init_listeners)
 705         config.reload
 706         config.commit!(self)
 707         kill_each_worker(:QUIT)
 708         Unicorn::Util.reopen_logs
 709         self.app = orig_app
 710         build_app! if preload_app
 711         logger.info "done reloading config_file=#{config.config_file}"
 712       rescue Object => e
 713         logger.error "error reloading config_file=#{config.config_file}: " \
 714                      "#{e.class} #{e.message}"
 715       end
 716     end
 717
 718     # returns an array of string names for the given listener array
 719     def listener_names(listeners = LISTENERS)
 720       listeners.map { |io| sock_name(io) }
 721     end
 722
 723     def build_app!
 724       if app.respond_to?(:arity) && app.arity == 0
 725         if defined?(Gem) && Gem.respond_to?(:refresh)
 726           logger.info "Refreshing Gem list"
 727           Gem.refresh
 728         end
 729         self.app = app.call
 730       end
 731     end
 732
 733     def proc_name(tag)
 734       $0 = ([ File.basename(START_CTX[0]), tag
 735             ]).concat(START_CTX[:argv]).join(' ')
 736     end
 737
 738     def redirect_io(io, path)
 739       File.open(path, 'ab') { |fp| io.reopen(fp) } if path
 740       io.sync = true
 741     end
 742
 743     def init_self_pipe!
 744       SELF_PIPE.each { |io| io.close rescue nil }
 745       SELF_PIPE.replace(IO.pipe)
 746       SELF_PIPE.each { |io| io.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC) }
 747     end
 748
 749   end
 750 end