1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
| | # -*- encoding: binary -*-
# frozen_string_literal: false
# This is the process manager of Unicorn. This manages worker
# processes which in turn handle the I/O and application process.
# Listener sockets are started in the master process and shared with
# forked worker children.
#
# Users do not need to know the internals of this class, but reading the
# {source}[https://yhbt.net/unicorn.git/tree/lib/unicorn/http_server.rb]
# is education for programmers wishing to learn how unicorn works.
# See Unicorn::Configurator for information on how to configure unicorn.
class Unicorn::HttpServer
# :stopdoc:
attr_accessor :app, :timeout, :worker_processes,
:before_fork, :after_fork, :before_exec,
:listener_opts, :preload_app,
:orig_app, :config, :ready_pipe, :user,
:default_middleware, :early_hints
attr_writer :after_worker_exit, :after_worker_ready, :worker_exec
attr_reader :pid, :logger
include Unicorn::SocketHelper
include Unicorn::HttpResponse
# all bound listener sockets
# note: this is public used by raindrops, but not recommended for use
# in new projects
LISTENERS = []
# listeners we have yet to bind
NEW_LISTENERS = []
# :startdoc:
# We populate this at startup so we can figure out how to reexecute
# and upgrade the currently running instance of Unicorn
# This Hash is considered a stable interface and changing its contents
# will allow you to switch between different installations of Unicorn
# or even different installations of the same applications without
# downtime. Keys of this constant Hash are described as follows:
#
# * 0 - the path to the unicorn 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 Unicorn.
#
# To change your unicorn executable to a different path without downtime,
# you can set the following in your Unicorn config file, HUP and then
# continue with the traditional USR2 + QUIT upgrade steps:
#
# Unicorn::HttpServer::START_CTX[0] = "/home/bofh/2.3.0/bin/unicorn"
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:
# Creates a working server on host:port (strange things happen if
# port isn't a Number). Use HttpServer::run to start the server and
# HttpServer.run.join to join the thread that's processing
# incoming requests on the socket.
def initialize(app, options = {})
@app = app
@reexec_pid = 0
@default_middleware = true
options = options.dup
@ready_pipe = options.delete(:ready_pipe)
@init_listeners = options[:listeners] ? options[:listeners].dup : []
options[:use_defaults] = true
self.config = Unicorn::Configurator.new(options)
self.listener_opts = {}
@immortal = [] # immortal inherited sockets from systemd
# We use @self_pipe differently in the master and worker processes:
#
# * The master process never closes or reinitializes this once
# initialized. Signal handlers in the master process will write to
# it to wake up the master from IO.select in exactly the same manner
# djb describes in https://cr.yp.to/docs/selfpipe.html
#
# * The workers immediately close the pipe they inherit. See the
# Unicorn::Worker class for the pipe workers use.
@self_pipe = []
@workers = {} # hash maps PIDs to Workers
@sig_queue = [] # signal queue used for self-piping
@pid = nil
# we try inheriting listeners first, so we bind them later.
# we don't write the pid file until we've bound listeners in case
# unicorn was started twice by mistake. Even though our #pid= method
# checks for stale/existing pid files, race conditions are still
# possible (and difficult/non-portable to avoid) and can be likely
# to clobber the pid if the second start was in quick succession
# after the first, so we rely on the listener binding to fail in
# that case. Some tests (in and outside of this source tree) and
# monitoring tools may also rely on pid files existing before we
# attempt to connect to the listener(s)
config.commit!(self, :skip => [:listeners, :pid])
@orig_app = app
# list of signals we care about and trap in master.
@queue_sigs = [
:WINCH, :QUIT, :INT, :TERM, :USR1, :USR2, :HUP, :TTIN, :TTOU ]
@worker_data = if worker_data = ENV['UNICORN_WORKER']
worker_data = worker_data.split(',').map!(&:to_i)
worker_data[1] = worker_data.slice!(1..2).map { |i| IO.for_fd(i) }
worker_data
end
end
# Runs the thing. Returns self so you can run join on it
def start
inherit_listeners!
# this pipe is used to wake us up from select(2) in #join when signals
# are trapped. See trap_deferred.
@self_pipe.replace(Unicorn.pipe)
@master_pid = @worker_data ? Process.ppid : $$
# setup signal handlers before writing pid file in case people get
# trigger happy and send signals as soon as the pid file exists.
# Note that signals don't actually get handled until the #join method
@queue_sigs.each { |sig| trap(sig) { @sig_queue << sig; awaken_master } }
trap(:CHLD) { awaken_master }
# write pid early for Mongrel compatibility if we're not inheriting sockets
# This is needed for compatibility some Monit setups at least.
# This unfortunately has the side effect of clobbering valid PID if
# we upgrade and the upgrade breaks during preload_app==true && build_app!
self.pid = config[:pid]
build_app! if preload_app
bind_new_listeners!
spawn_missing_workers
self
end
# replaces current listener set with +listeners+. This will
# close the socket if it will not exist in the new listener set
def listeners=(listeners)
cur_names, dead_names = [], []
listener_names.each do |name|
if name.start_with?('/')
# mark unlinked sockets as dead so we can rebind them
(File.socket?(name) ? cur_names : dead_names) << name
else
cur_names << name
end
end
set_names = listener_names(listeners)
dead_names.concat(cur_names - set_names).uniq!
dead_names -= @immortal.map { |io| sock_name(io) }
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) }
end
def stdout_path=(path); redirect_io($stdout, path); end
def stderr_path=(path); redirect_io($stderr, path); end
def logger=(obj)
Unicorn::HttpRequest::DEFAULTS["rack.logger"] = @logger = obj
end
def clobber_pid(path)
unlink_pid_safe(@pid) if @pid
if path
fp = begin
tmp = "#{File.dirname(path)}/#{rand}.#$$"
File.open(tmp, File::RDWR|File::CREAT|File::EXCL, 0644)
rescue Errno::EEXIST
retry
end
fp.sync = true
fp.write("#$$\n")
File.rename(fp.path, path)
fp.close
end
end
# sets the path for the PID file of the master process
def pid=(path)
if path
if x = valid_pid?(path)
return path if pid && path == pid && x == $$
if x == @reexec_pid && pid.end_with?('.oldbin')
logger.warn("will not set pid=#{path} while reexec-ed "\
"child is running PID:#{x}")
return
end
raise ArgumentError, "Already running on PID:#{x} " \
"(or pid=#{path} is stale)"
end
end
# rename the old pid if possible
if @pid && path
begin
File.rename(@pid, path)
rescue Errno::ENOENT, Errno::EXDEV
# a user may have accidentally removed the original,
# obviously cross-FS renames don't work, either.
clobber_pid(path)
end
else
clobber_pid(path)
end
@pid = path
end
# add a given address to the +listeners+ set, idempotently
# Allows workers to add a private, per-process listener via the
# after_fork hook. Very useful for debugging and testing.
# +:tries+ may be specified as an option for the number of times
# to retry, and +:delay+ may be specified as the time in seconds
# to delay between retries.
# 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] || {}))
address = config.expand_addr(address)
return if String === address && listener_names.include?(address)
delay = opt[:delay] || 0.5
tries = opt[:tries] || 5
begin
io = bind_listen(address, opt)
logger.info "listening on addr=#{sock_name(io)} fd=#{io.fileno}"
LISTENERS << io
io
rescue Errno::EADDRINUSE => err
logger.error "adding listener failed addr=#{address} (in use)"
raise err if tries == 0
tries -= 1
logger.error "retrying in #{delay} seconds " \
"(#{tries < 0 ? 'infinite' : tries} tries left)"
sleep(delay)
retry
rescue => err
logger.fatal "error adding listener addr=#{address}"
raise err
end
end
# monitors children and receives signals forever
# (or until a termination signal is sent). This handles signals
# one-at-a-time time and we'll happily drop signals in case somebody
# is signalling us too often.
def join
respawn = true
last_check = time_now
proc_name 'master'
logger.info "master process ready" # test_exec.rb relies on this message
if @ready_pipe
begin
@ready_pipe.syswrite($$.to_s)
rescue => e
logger.warn("grandparent died too soon?: #{e.message} (#{e.class})")
end
@ready_pipe = @ready_pipe.close rescue nil
end
begin
reap_all_workers
case @sig_queue.shift
when nil
# avoid murdering workers after our master process (or the
# machine) comes out of suspend/hibernation
if (last_check + @timeout) >= (last_check = time_now)
sleep_time = murder_lazy_workers
else
sleep_time = @timeout/2.0 + 1
@logger.debug("waiting #{sleep_time}s after suspend/hibernation")
end
maintain_worker_count if respawn
master_sleep(sleep_time)
when :QUIT # graceful shutdown
break
when :TERM, :INT # immediate shutdown
stop(false)
break
when :USR1 # rotate logs
logger.info "master reopening logs..."
Unicorn::Util.reopen_logs
logger.info "master done reopening logs"
soft_kill_each_worker(:USR1)
when :USR2 # exec binary, stay alive in case something went wrong
reexec
when :WINCH
if $stdin.tty?
logger.info "SIGWINCH ignored because we're not daemonized"
else
respawn = false
logger.info "gracefully stopping all workers"
soft_kill_each_worker(:QUIT)
self.worker_processes = 0
end
when :TTIN
respawn = true
self.worker_processes += 1
when :TTOU
self.worker_processes -= 1 if self.worker_processes > 0
when :HUP
respawn = true
if config.config_file
load_config!
else # exec binary and exit if there's no config file
logger.info "config_file not present, reexecuting binary"
reexec
end
end
rescue => e
Unicorn.log_error(@logger, "master loop error", e)
end while true
stop # gracefully shutdown all workers on our way out
logger.info "master complete"
unlink_pid_safe(pid) if pid
end
# Terminates all workers, but does not exit master process
def stop(graceful = true)
self.listeners = []
limit = time_now + timeout
until @workers.empty? || time_now > limit
if graceful
soft_kill_each_worker(:QUIT)
else
kill_each_worker(:TERM)
end
sleep(0.1)
reap_all_workers
end
kill_each_worker(:KILL)
end
def rewindable_input
Unicorn::HttpRequest.input_class.method_defined?(:rewind)
end
def rewindable_input=(bool)
Unicorn::HttpRequest.input_class = bool ?
Unicorn::TeeInput : Unicorn::StreamInput
end
def client_body_buffer_size
Unicorn::TeeInput.client_body_buffer_size
end
def client_body_buffer_size=(bytes)
Unicorn::TeeInput.client_body_buffer_size = bytes
end
def check_client_connection
Unicorn::HttpRequest.check_client_connection
end
def check_client_connection=(bool)
Unicorn::HttpRequest.check_client_connection = bool
end
private
# wait for a signal hander to wake us up and then consume the pipe
def master_sleep(sec)
@self_pipe[0].wait(sec) or return
# 11 bytes is the maximum string length which can be embedded within
# the Ruby itself and not require a separate malloc (on 32-bit MRI 1.9+).
# Most reads are only one byte here and uncommon, so it's not worth a
# persistent buffer, either:
@self_pipe[0].read_nonblock(11, exception: false)
end
def awaken_master
return if $$ != @master_pid
# wakeup master process from select
@self_pipe[1].write_nonblock('.', exception: false)
end
# reaps all unreaped workers
def reap_all_workers
begin
wpid, status = Process.waitpid2(-1, Process::WNOHANG)
wpid or return
if @reexec_pid == wpid
logger.error "reaped #{status.inspect} exec()-ed"
@reexec_pid = 0
self.pid = pid.chomp('.oldbin') if pid
proc_name 'master'
else
worker = @workers.delete(wpid) and worker.close rescue nil
@after_worker_exit.call(self, worker, status)
end
rescue Errno::ECHILD
break
end while true
end
# reexecutes the START_CTX with a new binary
def reexec
if @reexec_pid > 0
begin
Process.kill(0, @reexec_pid)
logger.error "reexec-ed child already running PID:#@reexec_pid"
return
rescue Errno::ESRCH
@reexec_pid = 0
end
end
if pid
old_pid = "#{pid}.oldbin"
begin
self.pid = old_pid # clear the path for a new pid file
rescue ArgumentError
logger.error "old PID:#{valid_pid?(old_pid)} running with " \
"existing pid=#{old_pid}, refusing rexec"
return
rescue => e
logger.error "error writing pid=#{old_pid} #{e.class} #{e.message}"
return
end
end
@reexec_pid = fork do
listener_fds = listener_sockets
ENV['UNICORN_FD'] = listener_fds.keys.join(',')
Dir.chdir(START_CTX[:cwd])
cmd = [ START_CTX[0] ].concat(START_CTX[:argv])
# exec(command, hash) works in at least 1.9.1+, but will only be
# required in 1.9.4/2.0.0 at earliest.
cmd << listener_fds
logger.info "executing #{cmd.inspect} (in #{Dir.pwd})"
before_exec.call(self)
exec(*cmd)
end
proc_name 'master (old)'
end
def worker_spawn(worker)
listener_fds = listener_sockets
env = {}
env['UNICORN_FD'] = listener_fds.keys.join(',')
listener_fds[worker.to_io.fileno] = worker.to_io
listener_fds[worker.master.fileno] = worker.master
worker_info = [worker.nr, worker.to_io.fileno, worker.master.fileno]
env['UNICORN_WORKER'] = worker_info.join(',')
Process.spawn(env, START_CTX[0], *START_CTX[:argv], listener_fds)
end
def listener_sockets
listener_fds = {}
LISTENERS.each { |sock| listener_fds[sock.fileno] = sock }
listener_fds
end
# forcibly terminate all workers that haven't checked in in timeout seconds. The timeout is implemented using an unlinked File
def murder_lazy_workers
next_sleep = @timeout - 1
now = time_now.to_i
@workers.dup.each_pair do |wpid, worker|
tick = worker.tick
0 == tick and next # skip workers that haven't processed any clients
diff = now - tick
tmp = @timeout - diff
if tmp >= 0
next_sleep > tmp and next_sleep = tmp
next
end
next_sleep = 0
logger.error "worker=#{worker.nr} PID:#{wpid} timeout " \
"(#{diff}s > #{@timeout}s), killing"
kill_worker(:KILL, wpid) # take no prisoners for timeout violations
end
next_sleep <= 0 ? 1 : next_sleep
end
def after_fork_internal
@self_pipe.each(&:close).clear # this is master-only, now
@ready_pipe.close if @ready_pipe
Unicorn::Configurator::RACKUP.clear
@ready_pipe = @init_listeners = @before_exec = @before_fork = nil
# The OpenSSL PRNG is seeded with only the pid, and apps with frequently
# dying workers can recycle pids
OpenSSL::Random.seed(rand.to_s) if defined?(OpenSSL::Random)
end
def spawn_missing_workers
if @worker_data
worker = Unicorn::Worker.new(*@worker_data)
after_fork_internal
worker_loop(worker)
exit
end
worker_nr = -1
until (worker_nr += 1) == @worker_processes
@workers.value?(worker_nr) and next
worker = Unicorn::Worker.new(worker_nr)
before_fork.call(self, worker)
pid = @worker_exec ? worker_spawn(worker) : fork
unless pid
after_fork_internal
worker_loop(worker)
exit
end
@workers[pid] = worker
worker.atfork_parent
end
rescue => e
@logger.error(e) rescue nil
exit!
end
def maintain_worker_count
(off = @workers.size - worker_processes) == 0 and return
off < 0 and return spawn_missing_workers
@workers.each_value { |w| w.nr >= worker_processes and w.soft_kill(:QUIT) }
end
# if we get any error, try to write something back to the client
# assuming we haven't closed the socket, but don't get hung up
# if the socket is already closed or broken. We'll always ensure
# the socket is closed at the end of this function
def handle_error(client, e)
code = case e
when EOFError,Errno::ECONNRESET,Errno::EPIPE,Errno::ENOTCONN
# client disconnected on us and there's nothing we can do
when Unicorn::RequestURITooLongError
414
when Unicorn::RequestEntityTooLargeError
413
when Unicorn::HttpParserError # try to tell the client they're bad
400
else
Unicorn.log_error(@logger, "app error", e)
500
end
if code
code = err_response(code, @request.response_start_sent)
client.write_nonblock(code, exception: false)
end
client.close
rescue
end
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"
headers.each { |key, value| append_header(buf, key, value) }
buf << (rss ? "\r\nHTTP/1.1 ".freeze : "\r\n".freeze)
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)
end
# once a client is accepted, it is processed in its entirety here
# in 3 easy steps: read request, call app, write app response
def process_client(client, ai)
@request = Unicorn::HttpRequest.new
env = @request.read_headers(client, ai)
if early_hints
env["rack.early_hints"] = lambda do |headers|
e103_response_write(client, headers)
end
end
env["rack.after_reply"] = []
status, headers, body = @app.call(env)
begin
return if @request.hijacked?
if 100 == status.to_i
e100_response_write(client, env)
status, headers, body = @app.call(env)
return if @request.hijacked?
end
@request.headers? or headers = nil
http_response_write(client, status, headers, body, @request)
ensure
body.respond_to?(:close) and body.close
end
unless client.closed? # rack.hijack may've close this for us
client.shutdown # in case of fork() in Rack app
client.close # flush and uncork socket immediately, no keepalive
end
rescue => e
handle_error(client, e)
ensure
env["rack.after_reply"].each(&:call) if env
end
def nuke_listeners!(readers)
# only called from the worker, ordering is important here
tmp = readers.dup
readers.replace([false]) # ensure worker does not continue ASAP
tmp.each { |io| io.close rescue nil } # break out of IO.select
end
# gets rid of stuff the worker has no business keeping track of
# to free some resources and drops all sig handlers.
# traps for USR1, USR2, and HUP may be set in the after_fork Proc
# by the user.
def init_worker_process(worker)
worker.atfork_child
# we'll re-trap :QUIT later for graceful shutdown iff we accept clients
exit_sigs = [ :QUIT, :TERM, :INT ]
exit_sigs.each { |sig| trap(sig) { exit!(0) } }
exit!(0) if (@sig_queue & exit_sigs)[0]
(@queue_sigs - exit_sigs).each { |sig| trap(sig, nil) }
trap(:CHLD, 'DEFAULT')
@sig_queue.clear
proc_name "worker[#{worker.nr}]"
START_CTX.clear
@workers.clear
after_fork.call(self, worker) # can drop perms and create listeners
LISTENERS.each { |sock| sock.close_on_exec = true }
worker.user(*user) if user.kind_of?(Array) && ! worker.switched
@config = nil
build_app! unless preload_app
@after_fork = @listener_opts = @orig_app = nil
readers = LISTENERS.dup
readers << worker
trap(:QUIT) { nuke_listeners!(readers) }
readers
end
def reopen_worker_logs(worker_nr)
logger.info "worker=#{worker_nr} reopening logs..."
Unicorn::Util.reopen_logs
logger.info "worker=#{worker_nr} done reopening logs"
false
rescue => e
logger.error(e) rescue nil
exit!(77) # EX_NOPERM in sysexits.h
end
def prep_readers(readers)
wtr = Unicorn::Waiter.prep_readers(readers)
@timeout *= 500 # to milliseconds for epoll, but halved
wtr
rescue
require_relative 'select_waiter'
@timeout /= 2.0 # halved for IO.select
Unicorn::SelectWaiter.new
end
# runs inside each forked worker, this sits around and waits
# for connections and doesn't die until the parent dies (or is
# given a INT, QUIT, or TERM signal)
def worker_loop(worker)
readers = init_worker_process(worker)
waiter = prep_readers(readers)
reopen = false
# this only works immediately if the master sent us the signal
# (which is the normal case)
trap(:USR1) { reopen = true }
ready = readers.dup
@after_worker_ready.call(self, worker)
begin
reopen = reopen_worker_logs(worker.nr) if reopen
worker.tick = time_now.to_i
while sock = ready.shift
client_ai = sock.accept_nonblock(exception: false)
if client_ai != :wait_readable
process_client(*client_ai)
worker.tick = time_now.to_i
end
break if reopen
end
# timeout so we can .tick and keep parent from SIGKILL-ing us
worker.tick = time_now.to_i
waiter.get_readers(ready, readers, @timeout)
rescue => e
redo if reopen && readers[0]
Unicorn.log_error(@logger, "listen loop error", e) if readers[0]
end while readers[0]
end
# delivers a signal to a worker and fails gracefully if the worker
# is no longer running.
def kill_worker(signal, wpid)
Process.kill(signal, wpid)
rescue Errno::ESRCH
worker = @workers.delete(wpid) and worker.close rescue nil
end
# delivers a signal to each worker
def kill_each_worker(signal)
@workers.keys.each { |wpid| kill_worker(signal, wpid) }
end
def soft_kill_each_worker(signal)
@workers.each_value { |worker| worker.soft_kill(signal) }
end
# unlinks a PID file at given +path+ if it contains the current PID
# still potentially racy without locking the directory (which is
# non-portable and may interact badly with other programs), but the
# window for hitting the race condition is small
def unlink_pid_safe(path)
(File.read(path).to_i == $$ and File.unlink(path)) rescue nil
end
# returns a PID if a given path contains a non-stale PID file,
# nil otherwise.
def valid_pid?(path)
wpid = File.read(path).to_i
wpid <= 0 and return
Process.kill(0, wpid)
wpid
rescue Errno::EPERM
logger.info "pid=#{path} possibly stale, got EPERM signalling PID:#{wpid}"
nil
rescue Errno::ESRCH, Errno::ENOENT
# don't unlink stale pid files, racy without non-portable locking...
end
def load_config!
loaded_app = app
logger.info "reloading config_file=#{config.config_file}"
config[:listeners].replace(@init_listeners)
config.reload
config.commit!(self)
soft_kill_each_worker(:QUIT)
Unicorn::Util.reopen_logs
self.app = @orig_app
build_app! if preload_app
logger.info "done reloading config_file=#{config.config_file}"
rescue StandardError, LoadError, SyntaxError => e
Unicorn.log_error(@logger,
"error reloading config_file=#{config.config_file}", e)
self.app = loaded_app
end
# returns an array of string names for the given listener array
def listener_names(listeners = LISTENERS)
listeners.map { |io| sock_name(io) }
end
def build_app!
if app.respond_to?(:arity) && (app.arity == 0 || app.arity == 2)
if defined?(Gem) && Gem.respond_to?(:refresh)
logger.info "Refreshing Gem list"
Gem.refresh
end
self.app = app.arity == 0 ? app.call : app.call(nil, self)
end
end
def proc_name(tag)
$0 = ([ File.basename(START_CTX[0]), tag
]).concat(START_CTX[:argv]).join(' ')
end
def redirect_io(io, path)
File.open(path, 'ab') { |fp| io.reopen(fp) } if path
io.sync = true
end
def inherit_listeners!
# inherit sockets from parents, they need to be plain Socket objects
inherited = ENV['UNICORN_FD'].to_s.split(',')
immortal = []
# emulate sd_listen_fds() for systemd
sd_pid, sd_fds = ENV.values_at('LISTEN_PID', 'LISTEN_FDS')
if sd_pid.to_i == $$ # n.b. $$ can never be zero
# 3 = SD_LISTEN_FDS_START
immortal = (3...(3 + sd_fds.to_i)).to_a
inherited.concat(immortal)
end
# to ease debugging, we will not unset LISTEN_PID and LISTEN_FDS
inherited.map! do |fd|
io = Socket.for_fd(fd.to_i)
@immortal << io if immortal.include?(fd)
set_server_sockopt(io, listener_opts[sock_name(io)])
logger.info "inherited addr=#{sock_name(io)} fd=#{io.fileno}"
io
end
config_listeners = config[:listeners].dup
LISTENERS.replace(inherited)
# we only use generic Socket objects for aggregate Socket#accept_nonblock
# return value [ Socket, Addrinfo ]. This allows us to avoid having to
# make getpeername(2) syscalls later on to fill in env['REMOTE_ADDR']
config_listeners -= listener_names
if config_listeners.empty? && LISTENERS.empty?
config_listeners << Unicorn::Const::DEFAULT_LISTEN
@init_listeners << Unicorn::Const::DEFAULT_LISTEN
START_CTX[:argv] << "-l#{Unicorn::Const::DEFAULT_LISTEN}"
end
NEW_LISTENERS.replace(config_listeners)
end
# call only after calling inherit_listeners!
# This binds any listeners we did NOT inherit from the parent
def bind_new_listeners!
NEW_LISTENERS.each { |addr| listen(addr) }.clear
raise ArgumentError, "no listeners" if LISTENERS.empty?
end
# try to use the monotonic clock in Ruby >= 2.1, it is immune to clock
# offset adjustments and generates less garbage (Float vs Time object)
begin
Process.clock_gettime(Process::CLOCK_MONOTONIC)
def time_now
Process.clock_gettime(Process::CLOCK_MONOTONIC)
end
rescue NameError, NoMethodError
def time_now # Ruby <= 2.0
Time.now
end
end
end
|