Avoid freezing objects that don't benefit from it
[unicorn.git] / lib / unicorn.rb
blob4cc5c2d62c4a8883b28f2e262fec7253931a1686
1 # -*- encoding: binary -*-
3 require 'fcntl'
4 require 'unicorn/socket_helper'
5 autoload :Rack, 'rack'
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'
18   Z = '' # the stock empty string we use everywhere...
19   Z.force_encoding(Encoding::BINARY) if Z.respond_to?(:force_encoding)
20   Z.freeze
22   class << self
23     def run(app, options = {})
24       HttpServer.new(app, options).start.join
25     end
26   end
28   # This is the process manager of Unicorn. This manages worker
29   # processes which in turn handle the I/O and application process.
30   # Listener sockets are started in the master process and shared with
31   # forked worker children.
33   class HttpServer < Struct.new(:listener_opts, :timeout, :worker_processes,
34                                 :before_fork, :after_fork, :before_exec,
35                                 :logger, :pid, :app, :preload_app,
36                                 :reexec_pid, :orig_app, :init_listeners,
37                                 :master_pid, :config)
38     include ::Unicorn::SocketHelper
40     # prevents IO objects in here from being GC-ed
41     IO_PURGATORY = []
43     # all bound listener sockets
44     LISTENERS = []
46     # This hash maps PIDs to Workers
47     WORKERS = {}
49     # See: http://cr.yp.to/docs/selfpipe.html
50     SELF_PIPE = []
52     # signal queue used for self-piping
53     SIG_QUEUE = []
55     # constant lookups are faster and we're single-threaded/non-reentrant
56     REQUEST = HttpRequest.new
58     # We populate this at startup so we can figure out how to reexecute
59     # and upgrade the currently running instance of Unicorn
60     START_CTX = {
61       :argv => ARGV.map { |arg| arg.dup },
62       # don't rely on Dir.pwd here since it's not symlink-aware, and
63       # symlink dirs are the default with Capistrano...
64       :cwd => `/bin/sh -c pwd`.chomp("\n"),
65       0 => $0.dup,
66     }
68     class Worker < Struct.new(:nr, :tmp)
69       # worker objects may be compared to just plain numbers
70       def ==(other_nr)
71         self.nr == other_nr
72       end
73     end
75     # Creates a working server on host:port (strange things happen if
76     # port isn't a Number).  Use HttpServer::run to start the server and
77     # HttpServer.run.join to join the thread that's processing
78     # incoming requests on the socket.
79     def initialize(app, options = {})
80       self.app = app
81       self.reexec_pid = 0
82       self.init_listeners = options[:listeners] ? options[:listeners].dup : []
83       self.config = Configurator.new(options.merge(:use_defaults => true))
84       self.listener_opts = {}
85       config.commit!(self, :skip => [:listeners, :pid])
86       self.orig_app = app
87     end
89     # Runs the thing.  Returns self so you can run join on it
90     def start
91       BasicSocket.do_not_reverse_lookup = true
93       # inherit sockets from parents, they need to be plain Socket objects
94       # before they become UNIXServer or TCPServer
95       inherited = ENV['UNICORN_FD'].to_s.split(/,/).map do |fd|
96         io = Socket.for_fd(fd.to_i)
97         set_server_sockopt(io, listener_opts[sock_name(io)])
98         IO_PURGATORY << io
99         logger.info "inherited addr=#{sock_name(io)} fd=#{fd}"
100         server_cast(io)
101       end
103       config_listeners = config[:listeners].dup
104       LISTENERS.replace(inherited)
106       # we start out with generic Socket objects that get cast to either
107       # TCPServer or UNIXServer objects; but since the Socket objects
108       # share the same OS-level file descriptor as the higher-level *Server
109       # objects; we need to prevent Socket objects from being garbage-collected
110       config_listeners -= listener_names
111       if config_listeners.empty? && LISTENERS.empty?
112         config_listeners << Unicorn::Const::DEFAULT_LISTEN
113       end
114       config_listeners.each { |addr| listen(addr) }
115       raise ArgumentError, "no listeners" if LISTENERS.empty?
116       self.pid = config[:pid]
117       self.master_pid = $$
118       build_app! if preload_app
119       maintain_worker_count
120       self
121     end
123     # replaces current listener set with +listeners+.  This will
124     # close the socket if it will not exist in the new listener set
125     def listeners=(listeners)
126       cur_names, dead_names = [], []
127       listener_names.each do |name|
128         if "/" == name[0..0]
129           # mark unlinked sockets as dead so we can rebind them
130           (File.socket?(name) ? cur_names : dead_names) << name
131         else
132           cur_names << name
133         end
134       end
135       set_names = listener_names(listeners)
136       dead_names.concat(cur_names - set_names).uniq!
138       LISTENERS.delete_if do |io|
139         if dead_names.include?(sock_name(io))
140           IO_PURGATORY.delete_if do |pio|
141             pio.fileno == io.fileno && (pio.close rescue nil).nil? # true
142           end
143           (io.close rescue nil).nil? # true
144         else
145           set_server_sockopt(io, listener_opts[sock_name(io)])
146           false
147         end
148       end
150       (set_names - cur_names).each { |addr| listen(addr) }
151     end
153     def stdout_path=(path); redirect_io($stdout, path); end
154     def stderr_path=(path); redirect_io($stderr, path); end
156     alias_method :set_pid, :pid=
157     undef_method :pid=
159     # sets the path for the PID file of the master process
160     def pid=(path)
161       if path
162         if x = valid_pid?(path)
163           return path if pid && path == pid && x == $$
164           raise ArgumentError, "Already running on PID:#{x} " \
165                                "(or pid=#{path} is stale)"
166         end
167       end
168       unlink_pid_safe(pid) if pid
169       File.open(path, 'wb') { |fp| fp.syswrite("#$$\n") } if path
170       self.set_pid(path)
171     end
173     # add a given address to the +listeners+ set, idempotently
174     # Allows workers to add a private, per-process listener via the
175     # after_fork hook.  Very useful for debugging and testing.
176     def listen(address, opt = {}.merge(listener_opts[address] || {}))
177       return if String === address && listener_names.include?(address)
179       delay, tries = 0.5, 5
180       begin
181         io = bind_listen(address, opt)
182         unless TCPServer === io || UNIXServer === io
183           IO_PURGATORY << io
184           io = server_cast(io)
185         end
186         logger.info "listening on addr=#{sock_name(io)} fd=#{io.fileno}"
187         LISTENERS << io
188         return io
189       rescue Errno::EADDRINUSE => err
190         logger.error "adding listener failed addr=#{address} (in use)"
191         raise err if tries == 0
192         tries -= 1
193         logger.error "retrying in #{delay} seconds (#{tries} tries left)"
194         sleep(delay)
195         retry
196       end
197     end
199     # monitors children and receives signals forever
200     # (or until a termination signal is sent).  This handles signals
201     # one-at-a-time time and we'll happily drop signals in case somebody
202     # is signalling us too often.
203     def join
204       # this pipe is used to wake us up from select(2) in #join when signals
205       # are trapped.  See trap_deferred
206       init_self_pipe!
207       respawn = true
209       QUEUE_SIGS.each { |sig| trap_deferred(sig) }
210       trap(:CHLD) { |sig_nr| awaken_master }
211       proc_name 'master'
212       logger.info "master process ready" # test_exec.rb relies on this message
213       begin
214         loop do
215           reap_all_workers
216           case SIG_QUEUE.shift
217           when nil
218             murder_lazy_workers
219             maintain_worker_count if respawn
220             master_sleep
221           when :QUIT # graceful shutdown
222             break
223           when :TERM, :INT # immediate shutdown
224             stop(false)
225             break
226           when :USR1 # rotate logs
227             logger.info "master reopening logs..."
228             Unicorn::Util.reopen_logs
229             logger.info "master done reopening logs"
230             kill_each_worker(:USR1)
231           when :USR2 # exec binary, stay alive in case something went wrong
232             reexec
233           when :WINCH
234             if Process.ppid == 1 || Process.getpgrp != $$
235               respawn = false
236               logger.info "gracefully stopping all workers"
237               kill_each_worker(:QUIT)
238             else
239               logger.info "SIGWINCH ignored because we're not daemonized"
240             end
241           when :TTIN
242             self.worker_processes += 1
243           when :TTOU
244             self.worker_processes -= 1 if self.worker_processes > 0
245           when :HUP
246             respawn = true
247             if config.config_file
248               load_config!
249               redo # immediate reaping since we may have QUIT workers
250             else # exec binary and exit if there's no config file
251               logger.info "config_file not present, reexecuting binary"
252               reexec
253               break
254             end
255           end
256         end
257       rescue Errno::EINTR
258         retry
259       rescue Object => e
260         logger.error "Unhandled master loop exception #{e.inspect}."
261         logger.error e.backtrace.join("\n")
262         retry
263       end
264       stop # gracefully shutdown all workers on our way out
265       logger.info "master complete"
266       unlink_pid_safe(pid) if pid
267     end
269     # Terminates all workers, but does not exit master process
270     def stop(graceful = true)
271       self.listeners = []
272       kill_each_worker(graceful ? :QUIT : :TERM)
273       timeleft = timeout
274       step = 0.2
275       reap_all_workers
276       until WORKERS.empty?
277         sleep(step)
278         reap_all_workers
279         (timeleft -= step) > 0 and next
280         kill_each_worker(:KILL)
281       end
282     end
284     private
286     # list of signals we care about and trap in master.
287     QUEUE_SIGS = [ :WINCH, :QUIT, :INT, :TERM, :USR1, :USR2, :HUP,
288                    :TTIN, :TTOU ]
290     # defer a signal for later processing in #join (master process)
291     def trap_deferred(signal)
292       trap(signal) do |sig_nr|
293         if SIG_QUEUE.size < 5
294           SIG_QUEUE << signal
295           awaken_master
296         else
297           logger.error "ignoring SIG#{signal}, queue=#{SIG_QUEUE.inspect}"
298         end
299       end
300     end
302     # wait for a signal hander to wake us up and then consume the pipe
303     # Wake up every second anyways to run murder_lazy_workers
304     def master_sleep
305       begin
306         ready = IO.select([SELF_PIPE.first], nil, nil, 1) or return
307         ready.first && ready.first.first or return
308         loop { SELF_PIPE.first.read_nonblock(Const::CHUNK_SIZE) }
309       rescue Errno::EAGAIN, Errno::EINTR
310       end
311     end
313     def awaken_master
314       begin
315         SELF_PIPE.last.write_nonblock('.') # wakeup master process from select
316       rescue Errno::EAGAIN, Errno::EINTR
317         # pipe is full, master should wake up anyways
318         retry
319       end
320     end
322     # reaps all unreaped workers
323     def reap_all_workers
324       begin
325         loop do
326           wpid, status = Process.waitpid2(-1, Process::WNOHANG)
327           wpid or break
328           if reexec_pid == wpid
329             logger.error "reaped #{status.inspect} exec()-ed"
330             self.reexec_pid = 0
331             self.pid = pid.chomp('.oldbin') if pid
332             proc_name 'master'
333           else
334             worker = WORKERS.delete(wpid) and worker.tmp.close rescue nil
335             logger.info "reaped #{status.inspect} " \
336                         "worker=#{worker.nr rescue 'unknown'}"
337           end
338         end
339       rescue Errno::ECHILD
340       end
341     end
343     # reexecutes the START_CTX with a new binary
344     def reexec
345       if reexec_pid > 0
346         begin
347           Process.kill(0, reexec_pid)
348           logger.error "reexec-ed child already running PID:#{reexec_pid}"
349           return
350         rescue Errno::ESRCH
351           reexec_pid = 0
352         end
353       end
355       if pid
356         old_pid = "#{pid}.oldbin"
357         prev_pid = pid.dup
358         begin
359           self.pid = old_pid  # clear the path for a new pid file
360         rescue ArgumentError
361           logger.error "old PID:#{valid_pid?(old_pid)} running with " \
362                        "existing pid=#{old_pid}, refusing rexec"
363           return
364         rescue Object => e
365           logger.error "error writing pid=#{old_pid} #{e.class} #{e.message}"
366           return
367         end
368       end
370       self.reexec_pid = fork do
371         listener_fds = LISTENERS.map { |sock| sock.fileno }
372         ENV['UNICORN_FD'] = listener_fds.join(',')
373         Dir.chdir(START_CTX[:cwd])
374         cmd = [ START_CTX[0] ].concat(START_CTX[:argv])
376         # avoid leaking FDs we don't know about, but let before_exec
377         # unset FD_CLOEXEC, if anything else in the app eventually
378         # relies on FD inheritence.
379         (3..1024).each do |io|
380           next if listener_fds.include?(io)
381           io = IO.for_fd(io) rescue nil
382           io or next
383           IO_PURGATORY << io
384           io.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
385         end
386         logger.info "executing #{cmd.inspect} (in #{Dir.pwd})"
387         before_exec.call(self)
388         exec(*cmd)
389       end
390       proc_name 'master (old)'
391     end
393     # forcibly terminate all workers that haven't checked in in timeout
394     # seconds.  The timeout is implemented using an unlinked File
395     # shared between the parent process and each worker.  The worker
396     # runs File#chmod to modify the ctime of the File.  If the ctime
397     # is stale for >timeout seconds, then we'll kill the corresponding
398     # worker.
399     def murder_lazy_workers
400       diff = stat = nil
401       WORKERS.dup.each_pair do |wpid, worker|
402         stat = begin
403           worker.tmp.stat
404         rescue => e
405           logger.warn "worker=#{worker.nr} PID:#{wpid} stat error: #{e.inspect}"
406           kill_worker(:QUIT, wpid)
407           next
408         end
409         stat.mode == 0100000 and next
410         (diff = (Time.now - stat.ctime)) <= timeout and next
411         logger.error "worker=#{worker.nr} PID:#{wpid} timeout " \
412                      "(#{diff}s > #{timeout}s), killing"
413         kill_worker(:KILL, wpid) # take no prisoners for timeout violations
414       end
415     end
417     def spawn_missing_workers
418       (0...worker_processes).each do |worker_nr|
419         WORKERS.values.include?(worker_nr) and next
420         begin
421           Dir.chdir(START_CTX[:cwd])
422         rescue Errno::ENOENT => err
423           logger.fatal "#{err.inspect} (#{START_CTX[:cwd]})"
424           SIG_QUEUE << :QUIT # forcibly emulate SIGQUIT
425           return
426         end
427         worker = Worker.new(worker_nr, Unicorn::Util.tmpio)
428         before_fork.call(self, worker)
429         WORKERS[fork { worker_loop(worker) }] = worker
430       end
431     end
433     def maintain_worker_count
434       (off = WORKERS.size - worker_processes) == 0 and return
435       off < 0 and return spawn_missing_workers
436       WORKERS.dup.each_pair { |wpid,w|
437         w.nr >= worker_processes and kill_worker(:QUIT, wpid) rescue nil
438       }
439     end
441     # once a client is accepted, it is processed in its entirety here
442     # in 3 easy steps: read request, call app, write app response
443     def process_client(client)
444       client.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
445       response = app.call(env = REQUEST.read(client))
447       if 100 == response.first.to_i
448         client.write(Const::EXPECT_100_RESPONSE)
449         env.delete(Const::HTTP_EXPECT)
450         response = app.call(env)
451       end
452       HttpResponse.write(client, response, HttpRequest::PARSER.headers?)
453     # if we get any error, try to write something back to the client
454     # assuming we haven't closed the socket, but don't get hung up
455     # if the socket is already closed or broken.  We'll always ensure
456     # the socket is closed at the end of this function
457     rescue EOFError,Errno::ECONNRESET,Errno::EPIPE,Errno::EINVAL,Errno::EBADF
458       client.write_nonblock(Const::ERROR_500_RESPONSE) rescue nil
459       client.close rescue nil
460     rescue HttpParserError # try to tell the client they're bad
461       client.write_nonblock(Const::ERROR_400_RESPONSE) rescue nil
462       client.close rescue nil
463     rescue Object => e
464       client.write_nonblock(Const::ERROR_500_RESPONSE) rescue nil
465       client.close rescue nil
466       logger.error "Read error: #{e.inspect}"
467       logger.error e.backtrace.join("\n")
468     end
470     # gets rid of stuff the worker has no business keeping track of
471     # to free some resources and drops all sig handlers.
472     # traps for USR1, USR2, and HUP may be set in the after_fork Proc
473     # by the user.
474     def init_worker_process(worker)
475       QUEUE_SIGS.each { |sig| trap(sig, nil) }
476       trap(:CHLD, 'DEFAULT')
477       SIG_QUEUE.clear
478       proc_name "worker[#{worker.nr}]"
479       START_CTX.clear
480       init_self_pipe!
481       WORKERS.values.each { |other| other.tmp.close rescue nil }
482       WORKERS.clear
483       LISTENERS.each { |sock| sock.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC) }
484       worker.tmp.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
485       after_fork.call(self, worker) # can drop perms
486       self.timeout /= 2.0 # halve it for select()
487       build_app! unless preload_app
488     end
490     def reopen_worker_logs(worker_nr)
491       logger.info "worker=#{worker_nr} reopening logs..."
492       Unicorn::Util.reopen_logs
493       logger.info "worker=#{worker_nr} done reopening logs"
494       init_self_pipe!
495     end
497     # runs inside each forked worker, this sits around and waits
498     # for connections and doesn't die until the parent dies (or is
499     # given a INT, QUIT, or TERM signal)
500     def worker_loop(worker)
501       ppid = master_pid
502       init_worker_process(worker)
503       nr = 0 # this becomes negative if we need to reopen logs
504       alive = worker.tmp # tmp is our lifeline to the master process
505       ready = LISTENERS
506       t = ti = 0
508       # closing anything we IO.select on will raise EBADF
509       trap(:USR1) { nr = -65536; SELF_PIPE.first.close rescue nil }
510       trap(:QUIT) { alive = nil; LISTENERS.each { |s| s.close rescue nil } }
511       [:TERM, :INT].each { |sig| trap(sig) { exit!(0) } } # instant shutdown
512       logger.info "worker=#{worker.nr} ready"
514       begin
515         nr < 0 and reopen_worker_logs(worker.nr)
516         nr = 0
518         # we're a goner in timeout seconds anyways if alive.chmod
519         # breaks, so don't trap the exception.  Using fchmod() since
520         # futimes() is not available in base Ruby and I very strongly
521         # prefer temporary files to be unlinked for security,
522         # performance and reliability reasons, so utime is out.  No-op
523         # changes with chmod doesn't update ctime on all filesystems; so
524         # we change our counter each and every time (after process_client
525         # and before IO.select).
526         t == (ti = Time.now.to_i) or alive.chmod(t = ti)
528         ready.each do |sock|
529           begin
530             process_client(sock.accept_nonblock)
531             nr += 1
532             t == (ti = Time.now.to_i) or alive.chmod(t = ti)
533           rescue Errno::EAGAIN, Errno::ECONNABORTED
534           end
535           break if nr < 0
536         end
538         # make the following bet: if we accepted clients this round,
539         # we're probably reasonably busy, so avoid calling select()
540         # and do a speculative accept_nonblock on ready listeners
541         # before we sleep again in select().
542         redo unless nr == 0 # (nr < 0) => reopen logs
544         ppid == Process.ppid or return
545         alive.chmod(t = 0)
546         begin
547           # timeout used so we can detect parent death:
548           ret = IO.select(LISTENERS, nil, SELF_PIPE, timeout) or redo
549           ready = ret.first
550         rescue Errno::EINTR
551           ready = LISTENERS
552         rescue Errno::EBADF
553           nr < 0 or return
554         end
555       rescue Object => e
556         if alive
557           logger.error "Unhandled listen loop exception #{e.inspect}."
558           logger.error e.backtrace.join("\n")
559         end
560       end while alive
561     end
563     # delivers a signal to a worker and fails gracefully if the worker
564     # is no longer running.
565     def kill_worker(signal, wpid)
566       begin
567         Process.kill(signal, wpid)
568       rescue Errno::ESRCH
569         worker = WORKERS.delete(wpid) and worker.tmp.close rescue nil
570       end
571     end
573     # delivers a signal to each worker
574     def kill_each_worker(signal)
575       WORKERS.keys.each { |wpid| kill_worker(signal, wpid) }
576     end
578     # unlinks a PID file at given +path+ if it contains the current PID
579     # useful as an at_exit handler.
580     def unlink_pid_safe(path)
581       (File.read(path).to_i == $$ and File.unlink(path)) rescue nil
582     end
584     # returns a PID if a given path contains a non-stale PID file,
585     # nil otherwise.
586     def valid_pid?(path)
587       if File.exist?(path) && (wpid = File.read(path).to_i) > 1
588         begin
589           Process.kill(0, wpid)
590           return wpid
591         rescue Errno::ESRCH
592         end
593       end
594       nil
595     end
597     def load_config!
598       begin
599         logger.info "reloading config_file=#{config.config_file}"
600         config[:listeners].replace(init_listeners)
601         config.reload
602         config.commit!(self)
603         kill_each_worker(:QUIT)
604         Unicorn::Util.reopen_logs
605         self.app = orig_app
606         build_app! if preload_app
607         logger.info "done reloading config_file=#{config.config_file}"
608       rescue Object => e
609         logger.error "error reloading config_file=#{config.config_file}: " \
610                      "#{e.class} #{e.message}"
611       end
612     end
614     # returns an array of string names for the given listener array
615     def listener_names(listeners = LISTENERS)
616       listeners.map { |io| sock_name(io) }
617     end
619     def build_app!
620       if app.respond_to?(:arity) && app.arity == 0
621         if defined?(Gem) && Gem.respond_to?(:refresh)
622           logger.info "Refreshing Gem list"
623           Gem.refresh
624         end
625         self.app = app.call
626       end
627     end
629     def proc_name(tag)
630       $0 = ([ File.basename(START_CTX[0]), tag
631             ]).concat(START_CTX[:argv]).join(' ')
632     end
634     def redirect_io(io, path)
635       File.open(path, 'ab') { |fp| io.reopen(fp) } if path
636       io.sync = true
637     end
639     def init_self_pipe!
640       SELF_PIPE.each { |io| io.close rescue nil }
641       SELF_PIPE.replace(IO.pipe)
642       SELF_PIPE.each { |io| io.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC) }
643     end
645   end