Module: OverSIP::Launcher

Extended by:
Logger
Defined in:
lib/oversip/launcher.rb

Constant Summary collapse

READY_PIPE_TIMEOUT = 
6

Constants included from Logger

OverSIP::Logger::SYSLOG_POSIXMQ_MAPPING

Class Method Summary collapse

Methods included from Logger

close, fatal, fg_system_msg2str, init_logger_mq, load_methods, log_id, syslog_system_msg2str, syslog_user_msg2str

Class Method Details

.assert_file_is_writable_readable_deletable(path) ⇒ Object 



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oversip/launcher.rb', line 356

def self.assert_file_is_writable_readable_deletable(path)
  # File already exists.
  if ::File.exist?(path)
    if not ::File.file?(path)
      raise ::OverSIP::Error, "'#{path}' exits and is not a regular file"
    elsif not ::File.readable?(path)
      raise ::OverSIP::Error, "'#{path}' is not readable"
    elsif not ::File.writable?(path)
      raise ::OverSIP::Error, "'#{path}' is not writable"
    end
  end
  # Check if the parent directory is writeable.
  if not ::File.writable? ::File.dirname(path)
    raise ::OverSIP::Error, "directory '#{::File.dirname(path)}' is not writable"
  end
end

.create_pid_file(path) ⇒ Object 



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oversip/launcher.rb', line 335

def self.create_pid_file(path)
  # Check that the PID file is accesible.
  begin
    assert_file_is_writable_readable_deletable(path)
  rescue ::OverSIP::Error => e
    fatal "cannot create PID file: #{e.message}"
  end
  # If the PID file exists (it shouldn't) check if it's stale.
  if wpid = valid_pid?(path) and wpid != $$
    fatal "already running on PID #{wpid} (or '#{path}' is stale)"
  end
  # Delete the PID file if it exists.
  ::File.unlink(path) rescue nil
  # Create the PID file.
  ::File.open(path, "w", 0644) do |f|
    f.syswrite("#$$\n")
  end
  ::OverSIP.pid_file = path
end

.daemonize!(options) ⇒ Object 



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
 
# File 'lib/oversip/launcher.rb', line 10

def self.daemonize!(options)
  $stdin.reopen("/dev/null")

  # grandparent (launcher)  : Reads pipe, exits when master is ready.
  #  \_ parent              : Exits immediately ASAP.
  #      \_ master          : Writes to pipe when ready.

  rd, wr = IO.pipe
  grandparent = $$
  if fork
    wr.close # Grandparent does not write in the ready_pipe.
  else
    rd.close # Parent (so also future master) does not read from the ready_pipe.
    ::Process.setsid
    exit if fork # Parent dies now.
  end

  # I'm grandparent (launcher) process.
  if grandparent == $$
    # Master process will inmediatelly write in the ready_pipe its PID so we get
    # its PID.
    master_pid = nil
    begin
      ::Timeout::timeout(READY_PIPE_TIMEOUT/2) do
        master_pid = rd.gets("\n").to_i rescue nil
      end
    rescue ::Timeout::Error
      fatal "master process didn't notify its PID within #{READY_PIPE_TIMEOUT/2} seconds"
    end
    unless master_pid
      fatal "master process failed to start"
    end

    # This will block until OverSIP::Launcher.run ends succesfully (so master process
    # writes "ok" in the ready_pipe) or until the pipe is closes without writting into it
    # (so the master process has died).
    # It can also occur that master process blocks forever and never writes into the
    # ready pipe neither closes it. In this case a timeout is raised and master process
    # is killed.
    master_ok = nil
    begin
      ::Timeout::timeout(READY_PIPE_TIMEOUT/2) do
        master_ok = (rd.read(2) rescue nil)
      end
    rescue ::Timeout::Error
      begin
        ::Process.kill(:TERM, master_pid)
        10.times do |i|
          sleep 0.05
          ::Process.wait(master_pid, ::Process::WNOHANG) rescue nil
          ::Process.kill(0, master_pid) rescue break
        end
        ::Process.kill(0, master_pid)
        ::Process.kill(:KILL, master_pid) rescue nil
      rescue ::Errno::ESRCH
      end
      fatal "master process is not ready within #{READY_PIPE_TIMEOUT/2} seconds, killing it"
    end
    unless master_ok == "ok"
      fatal "master process failed to start"
    end

    # Grandparent can die now with honor.
    exit 0

    # I'm master process.
  else
    options[:ready_pipe] = wr
  end
end

.delete_pid_file ⇒ Object 



456
457
458
459
460
 
# File 'lib/oversip/launcher.rb', line 456

def self.delete_pid_file
  return false  unless ::OverSIP.master_pid

  ::File.delete(::OverSIP.pid_file) rescue nil
end

.kill_stud_processes ⇒ Object 



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/oversip/launcher.rb', line 532

def self.kill_stud_processes
  return false  unless ::OverSIP.master_pid

  ::OverSIP.stud_pids.each do |pid|
    begin
      log_system_info "killing stud server with PID #{pid}..."
      ::Process.kill(:TERM, pid)
      10.times do |i|
        sleep 0.05
        ::Process.wait(pid, ::Process::WNOHANG) rescue nil
        ::Process.kill(0, pid) rescue break
      end
      ::Process.kill(0, pid)
      ::Process.kill(:KILL, pid) rescue nil
    rescue ::Errno::ESRCH
    end
  end
end

.kill_syslogger_process ⇒ Object 



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/oversip/launcher.rb', line 463

def self.kill_syslogger_process
  return false  unless ::OverSIP.master_pid

  begin
    ::Process.kill(:TERM, ::OverSIP.syslogger_pid)
    10.times do |i|
      sleep 0.05
      ::Process.wait(::OverSIP.syslogger_pid, ::Process::WNOHANG) rescue nil
      ::Process.kill(0, ::OverSIP.syslogger_pid) rescue break
    end
    ::Process.kill(0, ::OverSIP.syslogger_pid)
    ::Process.kill(:KILL, ::OverSIP.syslogger_pid) rescue nil
  rescue ::Errno::ESRCH
  end
end

.run(options) ⇒ Object 



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
 
# File 'lib/oversip/launcher.rb', line 82

def self.run(options)
  configuration = ::OverSIP.configuration

  # Store the master process PID.
  ::OverSIP.master_pid = $$

  begin
    # Inmediatelly write into the ready_pipe so grandparent process reads it
    # and knowns which PID we have.
    ready_pipe = options.delete(:ready_pipe)
    ready_pipe.write($$.to_s + "\n") if ready_pipe

    # I'm master process.
    if syslogger_pid = fork
      ::OverSIP.syslogger_pid = syslogger_pid
      log_system_info "starting syslogger process (PID #{syslogger_pid})..."
      ::OverSIP::Logger.load_methods

      # Load all the libraries for the master process.
      require "oversip/master_process.rb"

      ::OverSIP::TLS.module_init
      ::OverSIP::SIP.module_init
      ::OverSIP::SIP::RFC3263.module_init
      ::OverSIP::WebSocket::WsFraming.class_init
      ::OverSIP::WebSocket::WsApp.class_init

    # I'm the syslogger process.
    else
      # Close the pipe in the syslogger process.
      ready_pipe.close rescue nil
      ready_pipe = nil

      require "oversip/syslogger_process.rb"
      ::OverSIP::SysLoggerProcess.run options
      exit
    end

    ::EM.run do

      log_system_info "using Ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE} revision #{RUBY_REVISION}) [#{RUBY_PLATFORM}]"
      log_system_info "using EventMachine-LE #{::EM::VERSION}"
      log_system_info "starting event reactor..."

      # DNS resolver.
      ::OverSIP::SIP::RFC3263.run

      if configuration[:sip][:sip_udp]
        # SIP UDP IPv4 server.
        if configuration[:sip][:enable_ipv4]
          ::OverSIP::SIP::Launcher.run true, :ipv4, configuration[:sip][:listen_ipv4],
                                        configuration[:sip][:listen_port], :udp
        end

        # SIP IPv6 UDP server.
        if configuration[:sip][:enable_ipv6]
          ::OverSIP::SIP::Launcher.run true, :ipv6, configuration[:sip][:listen_ipv6],
                                        configuration[:sip][:listen_port], :udp
        end
      end

      if configuration[:sip][:sip_tcp]
        # SIP IPv4 TCP server.
        if configuration[:sip][:enable_ipv4]
          ::OverSIP::SIP::Launcher.run true, :ipv4, configuration[:sip][:listen_ipv4],
                                        configuration[:sip][:listen_port], :tcp
        end

        # SIP IPv6 TCP server.
        if configuration[:sip][:enable_ipv6]
          ::OverSIP::SIP::Launcher.run true, :ipv6, configuration[:sip][:listen_ipv6],
                                        configuration[:sip][:listen_port], :tcp
        end
      end

      if configuration[:sip][:sip_tls]
        unless configuration[:sip][:use_tls_tunnel]
          # SIP IPv4 TLS server (native).
          if configuration[:sip][:enable_ipv4]
            ::OverSIP::SIP::Launcher.run true, :ipv4, configuration[:sip][:listen_ipv4],
                                          configuration[:sip][:listen_port_tls], :tls
          end

          # SIP IPv6 TLS server (native).
          if configuration[:sip][:enable_ipv6]
            ::OverSIP::SIP::Launcher.run true, :ipv6, configuration[:sip][:listen_ipv6],
                                          configuration[:sip][:listen_port_tls], :tls
          end
        else
          # SIP IPv4 TLS server (Stud).
          if configuration[:sip][:enable_ipv4]
            ::OverSIP::SIP::Launcher.run true, :ipv4, "127.0.0.1",
                                          configuration[:sip][:listen_port_tls_tunnel], :tls_tunnel,
                                          configuration[:sip][:listen_ipv4],
                                          configuration[:sip][:listen_port_tls]
            ::OverSIP::SIP::Launcher.run false, :ipv4, configuration[:sip][:listen_ipv4],
                                          configuration[:sip][:listen_port_tls], :tls

            # Spawn a Stud process.
            spawn_stud_process options,
                               configuration[:sip][:listen_ipv4], configuration[:sip][:listen_port_tls],
                               "127.0.0.1", configuration[:sip][:listen_port_tls_tunnel],
                               ssl = false
          end

          # SIP IPv6 TLS server (Stud).
          if configuration[:sip][:enable_ipv6]
            ::OverSIP::SIP::Launcher.run true, :ipv6, "::1",
                                          configuration[:sip][:listen_port_tls_tunnel], :tls_tunnel,
                                          configuration[:sip][:listen_ipv6],
                                          configuration[:sip][:listen_port_tls]
            ::OverSIP::SIP::Launcher.run false, :ipv6, configuration[:sip][:listen_ipv6],
                                          configuration[:sip][:listen_port_tls], :tls

            # Spawn a Stud process.
            spawn_stud_process options,
                               configuration[:sip][:listen_ipv6], configuration[:sip][:listen_port_tls],
                               "::1", configuration[:sip][:listen_port_tls_tunnel],
                               ssl = false
          end
        end
      end

      if configuration[:websocket][:sip_ws]
        # WebSocket IPv4 TCP SIP server.
        if configuration[:websocket][:enable_ipv4]
          ::OverSIP::WebSocket::Launcher.run true, :ipv4, configuration[:websocket][:listen_ipv4],
                                                    configuration[:websocket][:listen_port], :tcp,
                                                    ::OverSIP::WebSocket::WS_SIP_PROTOCOL
        end

        # WebSocket IPv6 TCP SIP server.
        if configuration[:websocket][:enable_ipv6]
          ::OverSIP::WebSocket::Launcher.run true, :ipv6, configuration[:websocket][:listen_ipv6],
                                                    configuration[:websocket][:listen_port], :tcp,
                                                    ::OverSIP::WebSocket::WS_SIP_PROTOCOL
        end
      end

      if configuration[:websocket][:sip_wss]
        unless configuration[:websocket][:use_tls_tunnel]
          # WebSocket IPv4 TLS SIP server (native).
          if configuration[:websocket][:enable_ipv4]
            ::OverSIP::WebSocket::Launcher.run true, :ipv4, configuration[:websocket][:listen_ipv4],
                                          configuration[:websocket][:listen_port_tls], :tls,
                                          ::OverSIP::WebSocket::WS_SIP_PROTOCOL
          end

          # WebSocket IPv6 TLS SIP server (native).
          if configuration[:websocket][:enable_ipv6]
            ::OverSIP::WebSocket::Launcher.run true, :ipv6, configuration[:websocket][:listen_ipv6],
                                          configuration[:websocket][:listen_port_tls], :tls,
                                          ::OverSIP::WebSocket::WS_SIP_PROTOCOL
          end
        else
          # WebSocket IPv4 TLS SIP server (Stud).
          if configuration[:websocket][:enable_ipv4]
            ::OverSIP::WebSocket::Launcher.run true, :ipv4, "127.0.0.1",
                                          configuration[:websocket][:listen_port_tls_tunnel], :tls_tunnel,
                                          ::OverSIP::WebSocket::WS_SIP_PROTOCOL,
                                          configuration[:websocket][:listen_ipv4],
                                          configuration[:websocket][:listen_port_tls]
            ::OverSIP::WebSocket::Launcher.run false, :ipv4, configuration[:websocket][:listen_ipv4],
                                          configuration[:websocket][:listen_port_tls], :tls,
                                          ::OverSIP::WebSocket::WS_SIP_PROTOCOL

            # Spawn a Stud process.
            spawn_stud_process options,
                               configuration[:websocket][:listen_ipv4], configuration[:websocket][:listen_port_tls],
                               "127.0.0.1", configuration[:websocket][:listen_port_tls_tunnel],
                               ssl = true
          end

          # WebSocket IPv6 TLS SIP server (Stud).
          if configuration[:sip][:enable_ipv6]
            ::OverSIP::WebSocket::Launcher.run true, :ipv6, "::1",
                                          configuration[:websocket][:listen_port_tls_tunnel], :tls_tunnel,
                                          ::OverSIP::WebSocket::WS_SIP_PROTOCOL,
                                          configuration[:websocket][:listen_ipv6],
                                          configuration[:websocket][:listen_port_tls]
            ::OverSIP::WebSocket::Launcher.run false, :ipv6, configuration[:websocket][:listen_ipv6],
                                          configuration[:websocket][:listen_port_tls], :tls,
                                          ::OverSIP::WebSocket::WS_SIP_PROTOCOL

            # Spawn a Stud process.
            spawn_stud_process options,
                               configuration[:websocket][:listen_ipv6], configuration[:websocket][:listen_port_tls],
                               "::1", configuration[:websocket][:listen_port_tls_tunnel],
                               ssl = true
          end
        end
      end


      # TEST: WebSocket Autobahn server.
      #if configuration[:websocket][:sip_ws]
      #  if configuration[:websocket][:enable_ipv4]
      #    ::OverSIP::WebSocket::Launcher.run true, :ipv4, configuration[:websocket][:listen_ipv4],
      #                                        9001, :tcp,
      #                                        ::OverSIP::WebSocket::WS_AUTOBAHN_PROTOCOL
      #  end
      #end
      #
      #if configuration[:websocket][:sip_wss]
      #  if configuration[:websocket][:enable_ipv4]
      #    ::OverSIP::WebSocket::Launcher.run true, :ipv4, configuration[:websocket][:listen_ipv4],
      #                                        9002, :tls,
      #                                        ::OverSIP::WebSocket::WS_AUTOBAHN_PROTOCOL
      #  end
      #end


      # Change process permissions if requested.
      set_user_group(options[:user], options[:group])

      # Create PID file.
      create_pid_file(options[:pid_file])

      log_system_info "reactor running"
      log_system_info "master process (PID #{$$}) ready"
      log_system_info "#{::OverSIP::PROGRAM_NAME} #{::OverSIP::VERSION} running in background"

      # Write "ok" into the ready_pipe so grandparent process (launcher)
      # exits with status 0.
      if ready_pipe
        ready_pipe.write("ok")
        ready_pipe.close rescue nil
        ready_pipe = nil
      end

      # Stop writting into standard output/error.
      $stdout.reopen("/dev/null")
      $stderr.reopen("/dev/null")
      ::OverSIP.daemonized = true

      ::OverSIP::Logger.load_methods

      ::EM.error_handler do |e|
        log_system_error "error raised during event loop and rescued by EM.error_handler:"
        log_system_error e
      end

      trap_signals

    end  # ::EM.run

  rescue => e
    fatal e
  end

end

.set_user_group(user, group) ⇒ Object 



480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/oversip/launcher.rb', line 480

def self.set_user_group(user, group)
  uid = ::Etc.getpwnam(user).uid  if user
  gid = ::Etc.getgrnam(group).gid  if group
  if uid or gid
    if gid && ::Process.egid != gid
      ::Process.initgroups(user, gid)  if user
      ::Process::GID.change_privilege(gid)
    end
    if uid
      ::Process.euid != uid and ::Process::UID.change_privilege(uid)
    end
  end
end

.spawn_stud_process(options, listen_ip, listen_port, bg_ip, bg_port, ssl = false) ⇒ Object 



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
 
# File 'lib/oversip/launcher.rb', line 495

def self.spawn_stud_process(options, listen_ip, listen_port, bg_ip, bg_port, ssl=false)
  stud_user_group = ""
  stud_user_group << "-u #{options[:user]}" if options[:user]
  stud_user_group << " -g #{options[:group]}" if options[:group]
  ssl_option = ( ssl ? "--ssl" : "" )

  bin_dir = ::File.join(::File.absolute_path(::File.dirname(__FILE__)), "../../bin/")
  stdout_file = "/tmp/stud.#{listen_ip}:#{listen_port}.out"

  ::Dir.chdir(bin_dir) do
    pid = POSIX::Spawn.spawn "./oversip_stud #{stud_user_group} #{ssl_option} -f '#{listen_ip},#{listen_port}' -b '#{bg_ip},#{bg_port}' -n 2 -s --daemon --write-proxy #{::OverSIP.configuration[:tls][:full_cert]}", :out => stdout_file, :err => "/dev/null"
    Process.waitpid(pid)
  end

  # Get the PID of the daemonized stud process.
  stdout = ::File.read stdout_file
  pid = nil
  stdout.each_line do |line|
    pid = line.split(" ")[4]
    if pid
      pid = pid.gsub(/\./,"").to_i
      break  if pid > 0
    end
  end
  ::File.delete stdout_file  rescue nil

  unless pid
    fatal "error spawning stud server"
  end

  ::OverSIP.stud_pids ||= []
  ::OverSIP.stud_pids << pid

  log_system_info "spawned stud server (PID #{pid}) listening into #{listen_ip} : #{listen_port}"
end

.terminate(error = false) ⇒ Object 



435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/oversip/launcher.rb', line 435

def self.terminate error=false
  unless error
    log_system_info "exiting, thank you for tasting #{::OverSIP::PROGRAM_NAME}"
  end

  # Kill Stud processes.
  kill_stud_processes

  # Wait a bit so pending log messages in the Posix MQ can be queued.
  sleep 0.05
  delete_pid_file
  ::OverSIP::Logger.close

  # Fill the syslogger process.
  kill_syslogger_process

  # Exit by preventing any exception.
  exit!( error ? false : true )
end

.trap_signals ⇒ Object 



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
 
# File 'lib/oversip/launcher.rb', line 393

def self.trap_signals
  # This should never occur, but maybe if I've missed trapping a signal.
  at_exit do
    log_system_crit "exiting due to an unknown cause ($! = #{$!.inspect})..."
    terminate
  end

  # Signals that cause OverSIP to terminate.
  exit_signals = [:TERM, :QUIT]
  exit_signals.each do |signal|
    trap signal do
      log_system_notice "#{signal} signal received, exiting..."
      terminate
    end
  end

  # Signals that must be ignored.
  ignore_signals = [:ALRM, :INT, :PIPE, :POLL, :PROF, :USR1, :USR2, :VTALRM, :WINCH]
  ignore_signals.each do |signal|
    begin
      trap signal do
        log_system_notice "#{signal.to_s.upcase} signal received, ignored"
      end
    rescue ::ArgumentError
      log_system_notice "cannot trap signal #{signal.to_s.upcase}, it could not exist in this system, ignoring it"
    end
  end

  # Signal HUP reloads logic.
  # TODO: Reload proxies (so purge DNS cache in all of them), reload websocket policy.
  trap :HUP do
    log_system_info "HUP signal received, reloading logic..."
    ::OverSIP::Config.reload_logic
  end

  # Signal CHLD is sent by syslogger process if it dies.
  trap :CHLD do
    # TODO: This won't be logged since syslogger process has died!
    log_system_crit "CHLD signal received, syslogger process could be death"
  end
end

.valid_pid?(path) ⇒ Boolean

Returns a PID if a given path contains a non-stale PID file, false otherwise.

Returns:

  • (Boolean) 


376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oversip/launcher.rb', line 376

def self.valid_pid?(path)
  begin
    wpid = ::File.read(path).to_i
    wpid <= 0 and return false
    # If the process exists return its PID.
    ::Process.kill(0, wpid)
    return wpid
  # If the process exists but we don't have permissions over it, return its PID.
  rescue ::Errno::EPERM
    return wpid
  # If the PID file (path) doesn't exist or the process is not running return false.
  rescue ::Errno::ENOENT, ::Errno::ESRCH
    return false
  end
end