bin/opensrf-perl.pl.in

   1 #!/usr/bin/perl
   2 # ---------------------------------------------------------------
   3 # Copyright (C) 2008-2013 Georgia Public Library Service
   4 # Copyright (C) 2013 Equinox Software, Inc
   5 # Bill Erickson <berick@esilibrary.com>
   6 #
   7 # This program is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU General Public License
   9 # as published by the Free Software Foundation; either version 2
  10 # of the License, or (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 # ---------------------------------------------------------------
  17 use strict; use warnings;
  18 use Getopt::Long;
  19 use Net::Domain qw/hostfqdn/;
  20 use POSIX qw/setsid :sys_wait_h/;
  21 use OpenSRF::Utils::Logger q/$logger/;
  22 use OpenSRF::System;
  23 use OpenSRF::Transport::PeerHandle;
  24 use OpenSRF::Utils::SettingsClient;
  25 use OpenSRF::Transport::Listener;
  26 use OpenSRF::Utils;
  27 use OpenSRF::Utils::Config;
  28
  29 my $opt_service = undef;
  30 my $opt_config = "@CONF_DIR@/opensrf_core.xml";
  31 my $opt_pid_dir = "@PID_DIR@/run/opensrf";
  32 my $opt_no_daemon = 0;
  33 my $opt_settings_pause = 0;
  34 my $opt_localhost = 0;
  35 my $opt_help = 0;
  36 my $opt_shutdown_graceful = 0;
  37 my $opt_shutdown_fast = 0;
  38 my $opt_shutdown_immediate = 0;
  39 my $opt_shutdown_graceful_all = 0;
  40 my $opt_shutdown_fast_all = 0;
  41 my $opt_shutdown_immediate_all = 0;
  42 my $opt_kill_with_fire = 0;
  43 my $opt_signal = ''; # signal name
  44 my $opt_signal_all = 0;
  45 my $opt_signal_timeout = 30;
  46 my $opt_start = 0;
  47 my $opt_stop = 0;
  48 my $opt_restart = 0;
  49 my $opt_start_all = 0;
  50 my $opt_stop_all = 0;
  51 my $opt_restart_all = 0;
  52 my $opt_start_services = 0;
  53 my $opt_stop_services = 0;
  54 my $opt_restart_services = 0;
  55 my $opt_force_clean_process = 0;
  56 my $opt_router_de_register = 0;
  57 my $opt_router_de_register_all = 0;
  58 my $opt_router_re_register = 0;
  59 my $opt_router_re_register_all = 0;
  60 my $opt_reload = 0;
  61 my $opt_reload_all = 0;
  62 my $opt_quiet = 0;
  63 my $opt_diagnostic = 0;
  64 my $opt_ignore_orphans = 0;
  65 my $sclient;
  66 my @perl_services;
  67 my @nonperl_services;
  68 my %max_children_map;
  69 my $hostname = $ENV{OSRF_HOSTNAME} || hostfqdn();
  70
  71 GetOptions(
  72     'service=s' => \$opt_service,
  73     'config=s' => \$opt_config,
  74     'pid-dir=s' => \$opt_pid_dir,
  75     'no-daemon' => \$opt_no_daemon,
  76     'settings-startup-pause=i' => \$opt_settings_pause,
  77     'localhost' => \$opt_localhost,
  78     'help' => \$opt_help,
  79     'quiet' => \$opt_quiet,
  80     'graceful-shutdown' => \$opt_shutdown_graceful,
  81     'fast-shutdown' => \$opt_shutdown_fast,
  82     'immediate-shutdown' => \$opt_shutdown_immediate,
  83     'graceful-shutdown-all' => \$opt_shutdown_graceful_all,
  84     'fast-shutdown-all' => \$opt_shutdown_fast_all,
  85     'immediate-shutdown-all' => \$opt_shutdown_immediate_all,
  86     'kill-with-fire' => \$opt_kill_with_fire,
  87     'force-clean-process' => \$opt_force_clean_process,
  88     'signal-timeout' => \$opt_signal_timeout,
  89     'signal=s' => \$opt_signal,
  90     'signal-all' => \$opt_signal_all,
  91     'start' => \$opt_start,
  92     'stop' => \$opt_stop,
  93     'start-all' => \$opt_start_all,
  94     'stop-all' => \$opt_stop_all,
  95     'restart' => \$opt_restart,
  96     'restart-all' => \$opt_restart_all,
  97     'start-services' => \$opt_start_services,
  98     'stop-services' => \$opt_stop_services,
  99     'restart-services' => \$opt_restart_services,
 100     'router-de-register' => \$opt_router_de_register,
 101     'router-de-register-all' => \$opt_router_de_register_all,
 102     'router-re-register' => \$opt_router_re_register,
 103     'router-re-register-all' => \$opt_router_re_register_all,
 104     'reload' => \$opt_reload,
 105     'reload-all' => \$opt_reload_all,
 106     'diagnostic' => \$opt_diagnostic,
 107     'ignore-orphans' => \$opt_ignore_orphans
 108 );
 109
 110 if ($opt_localhost) {
 111     $hostname = 'localhost';
 112     $ENV{OSRF_HOSTNAME} = $hostname;
 113 }
 114
 115 my $C_COMMAND = "opensrf-c -c $opt_config -x opensrf -p $opt_pid_dir -h $hostname";
 116 my $PY_COMMAND = "opensrf.py -f $opt_config -p $opt_pid_dir ". ($opt_localhost ? '-l' : '');
 117
 118 sub verify_services {
 119     my $service = shift;
 120     return 1 if $service and $service eq 'router';
 121     my @services = (@perl_services, map {$_->{service}} @nonperl_services);
 122     if (@services) {
 123         return 1 unless $service;
 124         return 1 if grep { $_ eq $service } @services;
 125         msg("$service is not configured to run on $hostname");
 126     } else {
 127         msg("No services are configured to run on $hostname");
 128     }
 129     msg("Perhaps you meant to use --localhost?") unless $opt_localhost;
 130     exit;
 131 }
 132
 133 sub do_signal_send {
 134     my $service = shift;
 135     my $signal = shift;
 136
 137     my @pids = get_service_pids_from_file($service);
 138
 139     if (!@pids) {
 140         # no PID files exist.  see if the service is running anyway
 141
 142         @pids = get_service_pids_from_ps($service);
 143         if (!@pids) {
 144             msg("cannot signal $service : no pid file or running process");
 145             return 0;
 146         }
 147     }
 148
 149     for my $pid (@pids) {
 150         if (kill($signal, $pid) == 0) { # no process was signaled.
 151             msg("cannot signal $service: process $pid is not running");
 152             my $pidfile = get_pid_file($service);
 153             unlink $pidfile if $pidfile;
 154             next;
 155         }
 156
 157         msg("sending $signal signal to pid=$pid $service");
 158     }
 159
 160     return 1;
 161 }
 162
 163 # returns 2 if a process should have gone away but did not
 164 # in the case of multiple PIDs (e.g. router), return the
 165 # status of any failures, but not the successes.
 166 sub do_signal_wait {
 167     my $service = shift;
 168     my @pids = get_service_pids_from_file($service);
 169
 170     my $stat = 1;
 171     for my $pid (@pids) {
 172
 173         # to determine whether a process has died, we have to send
 174         # a no-op signal to the PID and check the success of that signal
 175         my $sig_count;
 176         for my $i (1..$opt_signal_timeout) {
 177             $sig_count = kill(0, $pid);
 178             last unless $sig_count;
 179             sleep(1);
 180         }
 181
 182         if ($sig_count) {
 183             msg("timed out waiting on $service pid=$pid to die");
 184             $stat = 2;
 185             next;
 186         }
 187
 188         # cleanup successful. remove the PID file
 189         my $pidfile = get_pid_file($service);
 190         unlink $pidfile if $pidfile;
 191     }
 192
 193     return $stat;
 194 }
 195
 196 sub get_pid_file {
 197     my $service = shift;
 198     return "$opt_pid_dir/$service.pid";
 199 }
 200
 201 # services usually only have 1 pid, but the router will have at least 2
 202 sub get_service_pids_from_file {
 203     my $service = shift;
 204     my $pid_file = get_pid_file($service);
 205     return () unless -e $pid_file;
 206     my @pids = `cat $pid_file`;
 207     s/^\s*|\n//g for @pids;
 208     return @pids;
 209 }
 210
 211 sub get_service_pids_from_ps {
 212     my $service = shift;
 213
 214     my $ps = ($service eq 'router') ?
 215         "ps x | grep 'OpenSRF Router'" :
 216         "ps x | grep 'OpenSRF Listener \\[$service\\]'";
 217
 218     $ps .= " | grep -v grep |  sed 's/^\\s*//' | cut -d' ' -f1";
 219     my @pids = `$ps`;
 220     s/^\s*|\n//g for @pids;
 221
 222     return @pids;
 223 }
 224
 225
 226 sub do_diagnostic {
 227     my $alive = do_init(1);
 228
 229     my @services = get_service_list_from_files(1);
 230     my @conf_services;
 231     if ($alive) {
 232         @conf_services = (@perl_services,
 233             map {$_->{service}} @nonperl_services);
 234         push(@services, @conf_services);
 235     }
 236
 237     my %services;
 238     my $len = 0;
 239     for my $svc (@services) {
 240         $len = length($svc) if length($svc) > $len;
 241         $services{$svc} = 1;
 242     }
 243
 244     for my $svc (sort keys %services) {
 245         my @pf_pids = get_service_pids_from_file($svc);
 246         my @ps_pids = get_service_pids_from_ps($svc);
 247         my $svc_str = sprintf("%-${len}s ", $svc);
 248         my %seen;
 249
 250         unless(@ps_pids or @pf_pids) {
 251             msg("$svc_str is not running");
 252             next;
 253         }
 254
 255         for my $pid (@ps_pids) {
 256             $seen{$pid} = 1;
 257
 258             my $str = "$svc_str [$pid] ";
 259             my $times = `ps -o etime=,cputime= $pid`;
 260             $times =~ s/^\s+|\s+$//g;
 261             my @times = split(/ /, $times);
 262             $str .= sprintf("uptime=%-11s cputime=%-11s ", $times[0], $times[1]);
 263
 264             if ($svc eq 'router') {
 265                 msg($str);
 266             } else {
 267                 my @drones = `pgrep -f "Drone \\[$svc\\]"`;
 268                 my $dcount = scalar(@drones);
 269                 my $dmax = $max_children_map{$svc};
 270                 if (defined($dmax) && $dmax > 0) {
 271                     $str .= "#drones=$dcount/$dmax ";
 272                     $str .= sprintf('%3d%%', (int(($dcount / $dmax) * 100)));
 273                 } else {
 274                     $str .= "#drones=$dcount";
 275                 }
 276                 msg($str);
 277                 msg("\tERR $svc has no running drones.") unless @drones;
 278             }
 279
 280             msg("\tERR $svc [$pid] NOT configured for this host.")
 281                 unless grep {$_ eq $svc} @conf_services
 282                 or $svc eq 'router';
 283
 284             msg("\tERR $svc [$pid] NOT found in PID file.")
 285                 unless grep {$_ eq $pid} @pf_pids;
 286         }
 287
 288         for my $pid (@pf_pids) {
 289             next if $seen{$pid};
 290             msg("\tERR $svc Has PID file entry [$pid], ".
 291                 "which matches no running $svc processes");
 292         }
 293     }
 294 }
 295
 296
 297
 298 sub do_start_router {
 299
 300     my $pidfile = get_pid_file('router');
 301     `opensrf_router $opt_config routers $pidfile`;
 302
 303     sleep 2; # give the router time to fork (probably not need now but w/e)
 304 }
 305
 306 # stop a specific service
 307 sub do_stop {
 308     my ($service, @signals) = @_;
 309     @signals = qw/TERM INT KILL/ unless @signals;
 310     for my $sig (@signals) {
 311         last unless do_signal($service, $sig) == 2;
 312     }
 313     return 1;
 314 }
 315
 316 sub do_init {
 317     my $fail_ok = shift;
 318
 319     OpenSRF::System->bootstrap_client(config_file => $opt_config);
 320
 321     if (!OpenSRF::Transport::PeerHandle->retrieve) {
 322         return 0 if $fail_ok;
 323         die "Unable to bootstrap client for requests\n";
 324     }
 325
 326     load_settings(); # load the settings config if we can
 327
 328     my $sclient = OpenSRF::Utils::SettingsClient->new;
 329     my $apps = $sclient->config_value("activeapps", "appname");
 330
 331     # disconnect the top-level network handle
 332     OpenSRF::Transport::PeerHandle->retrieve->disconnect;
 333
 334     if($apps) {
 335         $apps = [$apps] unless ref $apps;
 336         for my $app (@$apps) {
 337             if (!$sclient->config_value('apps', $app)) {
 338                 msg("Service '$app' is listed for this host, ".
 339                     "but there is no configuration for it in $opt_config");
 340                 next;
 341             }
 342             my $lang = $sclient->config_value('apps', $app, 'language') || '';
 343
 344             $max_children_map{$app} = $sclient->config_value(
 345                 'apps', $app, 'unix_config', 'max_children');
 346
 347             if ($lang =~ /perl/i) {
 348                 push(@perl_services, $app);
 349             } else {
 350                 push(@nonperl_services, {service => $app, lang => $lang});
 351             }
 352         }
 353     }
 354     return 1;
 355 }
 356
 357 # start a specific service
 358 sub do_start {
 359     my $service = shift;
 360
 361     my @pf_pids = get_service_pids_from_file($service);
 362     my @ps_pids = get_service_pids_from_ps($service);
 363
 364     if (@pf_pids) { # had pidfile
 365
 366         if (@ps_pids) {
 367             msg("service $service already running : @ps_pids");
 368             return;
 369
 370         } else { # stale pidfile
 371
 372             my $pidfile = get_pid_file($service);
 373             msg("removing stale pid file $pidfile");
 374             unlink $pidfile;
 375         }
 376
 377     } elsif (@ps_pids and not $opt_ignore_orphans) { # orphan process
 378
 379         if ($opt_force_clean_process) {
 380             msg("service $service pid=@ps_pids is running with no pidfile");
 381             do_signal($service, 'KILL');
 382         } else {
 383             msg("service $service pid=@ps_pids is running with no pidfile! ".
 384                 "use --force-clean-process to automatically kill orphan processes");
 385             return;
 386         }
 387     }
 388
 389     return do_start_router() if $service eq 'router';
 390
 391     load_settings() if $service eq 'opensrf.settings';
 392
 393     if(grep { $_ eq $service } @perl_services) {
 394         return unless do_daemon($service);
 395         OpenSRF::System->run_service($service, $opt_pid_dir);
 396
 397     } else {
 398         # note: we don't daemonize non-perl services, but instead
 399         # assume the controller for other languages manages that.
 400         my ($svc) = grep { $_->{service} eq $service } @nonperl_services;
 401         if ($svc) {
 402             if ($svc->{lang} =~ /c/i) {
 403                 system("$C_COMMAND -a start -s $service");
 404                 return;
 405             } elsif ($svc->{lang} =~ /python/i) {
 406                 system("$PY_COMMAND -a start -s $service");
 407                 return;
 408             }
 409         }
 410     }
 411
 412     # should not get here
 413     return 0;
 414 }
 415
 416
 417 sub do_start_all {
 418     msg("starting router and services for $hostname");
 419     do_start('router');
 420     return do_start_services();
 421 }
 422
 423 sub do_start_services {
 424     msg("starting services for $hostname");
 425
 426     if(grep {$_ eq 'opensrf.settings'} @perl_services) {
 427         do_start('opensrf.settings');
 428         # in batch mode, give opensrf.settings plenty of time to start
 429         # before any non-Perl services try to connect
 430         sleep $opt_settings_pause if $opt_settings_pause;
 431     }
 432
 433     # start Perl services
 434     for my $service (@perl_services) {
 435         do_start($service) unless $service eq 'opensrf.settings';
 436     }
 437
 438     # start each non-perl service individually instead of using the native
 439     # start-all command.  this allows us to test for existing pid files
 440     # and/or running processes on each service before starting.
 441     # it also means each service has to connect-fetch_setting-disconnect
 442     # from jabber, which makes startup slightly slower than native start-all
 443     do_start($_->{service}) for @nonperl_services;
 444
 445     return 1;
 446 }
 447
 448 # signal a single service
 449 sub do_signal {
 450     my $service = shift;
 451     my $signal = shift;
 452     return do_signal_all($signal, $service);
 453 }
 454
 455 # returns the list of running services based on presence of PID files.
 456 # the 'router' service is not included by deault, since it's
 457 # usually treated special.
 458 sub get_service_list_from_files {
 459     my $include_router = shift;
 460     my @services = `ls $opt_pid_dir/*.pid 2> /dev/null`;
 461     s/^\s*|\n//g for @services;
 462     s|.*/(.*)\.pid$|$1| for @services;
 463     return @services if $include_router;
 464     return grep { $_ ne 'router' } @services;
 465 }
 466
 467 sub do_signal_all {
 468     my ($signal, @services) = @_;
 469     @services = get_service_list_from_files() unless @services;
 470
 471     do_signal_send($_, $signal) for @services;
 472
 473     # if user passed a know non-shutdown signal, we're done.
 474     return if $signal =~ /HUP|USR1|USR2/;
 475
 476     do_signal_wait($_) for @services;
 477 }
 478
 479 # pull all opensrf listener and drone PIDs from 'ps',
 480 # kill them all, and remove all pid files
 481 sub do_kill_with_fire {
 482     msg("killing with fire");
 483
 484     my @pids = get_running_pids();
 485     for (@pids) {
 486         next unless $_ =~ /\d+/;
 487         my $proc = `ps -p $_ -o cmd=`;
 488         chomp $proc;
 489         msg("killing with fire pid=$_ $proc");
 490         kill('KILL', $_);
 491     }
 492
 493     # remove all of the pid files
 494     my @files = `ls $opt_pid_dir/*.pid 2> /dev/null`;
 495     s/^\s*|\n//g for @files;
 496     for (@files) {
 497         msg("removing pid file $_");
 498         unlink $_;
 499     }
 500 }
 501
 502 sub get_running_pids {
 503     my @pids;
 504
 505     # start with the listeners, then drones, then routers
 506     my @greps = (
 507         "ps x | grep 'OpenSRF Listener' ",
 508         "ps x | grep 'OpenSRF Drone' ",
 509         "ps x | grep 'OpenSRF Router' "
 510     );
 511
 512     $_ .= "| grep -v grep |  sed 's/^\\s*//' | cut -d' ' -f1" for @greps;
 513
 514     for my $grep (@greps) {
 515         my @spids = `$grep`;
 516         s/^\s*|\n//g for @spids;
 517         push (@pids, @spids);
 518     }
 519
 520     return @pids;
 521 }
 522
 523 sub clear_stale_pids {
 524     my @pidfile_services = get_service_list_from_files(1);
 525     my @running_pids = get_running_pids();
 526
 527     for my $svc (@pidfile_services) {
 528         my @pids = get_service_pids_from_file($svc);
 529         for my $pid (@pids) {
 530             next if grep { $_ eq $pid } @running_pids;
 531             my $pidfile = get_pid_file($svc);
 532             msg("removing stale pid file $pidfile");
 533             unlink $pidfile;
 534         }
 535     }
 536 }
 537
 538 sub do_stop_services {
 539     my @signals = @_;
 540     @signals = qw/TERM INT KILL/ unless @signals;
 541
 542     msg("stopping services for $hostname");
 543     my @services = get_service_list_from_files();
 544
 545     for my $signal (@signals) {
 546         my @redo;
 547
 548         # send the signal to all PIDs
 549         do_signal_send($_, $signal) for @services;
 550
 551         # then wait for them to go away
 552         for my $service (@services) {
 553             push(@redo, $service) if do_signal_wait($service) == 2;
 554         }
 555
 556         @services = @redo;
 557         last unless @services;
 558     }
 559
 560     return 1;
 561 }
 562
 563 sub do_stop_all {
 564     my @signals = @_;
 565     @signals = qw/TERM INT KILL/ unless @signals;
 566
 567     do_stop_services(@signals);
 568
 569     # graceful shutdown requires the presence of the router, so stop the
 570     # router last.  See if it's running first to avoid unnecessary warnings.
 571     do_stop('router', $signals[0]) if get_service_pids_from_file('router');
 572
 573     return 1;
 574 }
 575
 576 # daemonize us.  return true if we're the child, false if parent
 577 sub do_daemon {
 578     return 1 if $opt_no_daemon;
 579     my $service = shift;
 580     my $pid_file = get_pid_file($service);
 581     my $pid = OpenSRF::Utils::safe_fork();
 582     if ($pid) { # parent
 583         msg("starting service pid=$pid $service");
 584         return 0;
 585     }
 586     chdir('/');
 587     setsid();
 588     close STDIN;
 589     close STDOUT;
 590     close STDERR;
 591     open STDIN, '</dev/null';
 592     open STDOUT, '>/dev/null';
 593     open STDERR, '>/dev/null';
 594     `echo $$ > $pid_file`;
 595     return 1;
 596 }
 597
 598 # parses the local settings file
 599 sub load_settings {
 600     my $conf = OpenSRF::Utils::Config->current;
 601     my $cfile = $conf->bootstrap->settings_config;
 602     return unless $cfile;
 603     my $parser = OpenSRF::Utils::SettingsParser->new();
 604     $parser->initialize( $cfile );
 605     $OpenSRF::Utils::SettingsClient::host_config =
 606         $parser->get_server_config($conf->env->hostname);
 607 }
 608
 609 sub msg {
 610     my $m = shift;
 611     print "* $m\n" unless $opt_quiet;
 612 }
 613
 614 sub do_help {
 615     print <<HELP;
 616
 617     Usage: $0 --localhost --start-all
 618
 619     --config <file> [default: @CONF_DIR@/opensrf_core.xml]
 620         OpenSRF configuration file
 621
 622     --pid-dir <dir> [default: @PID_DIR@/run/opensrf]
 623         Directory where process-specific PID files are kept
 624
 625     --settings-startup-pause
 626         How long to give the opensrf.settings server to start up when running
 627         in batch mode (start_all).  The purpose is to give plenty of time for
 628         the settings server to be up and active before any non-Perl services
 629         attempt to connect.
 630
 631     --localhost
 632         Force the hostname to be 'localhost', instead of the fully qualified
 633         domain name for the machine.
 634
 635     --service <service>
 636         Specifies which OpenSRF service to control
 637
 638     --quiet
 639         Do not print informational messages to STDOUT
 640
 641     --no-daemon
 642         Do not detach and run as a daemon process.  Useful for debugging.
 643         Only works for Perl services and only when starting a single service.
 644
 645     --help
 646         Print this help message
 647
 648     --diagnostic
 649         Print information about running services
 650
 651     ==== starting services =====
 652
 653     --start-all
 654         Start the router and all services
 655
 656     --start
 657         Start the service specified by --service
 658
 659     --start-services
 660         Start all services but do not start any routers
 661
 662     --restart-all
 663         Restart the router and all services
 664
 665     --restart
 666         Restart the service specified by --service
 667
 668     --restart-services
 669         Restart all services but do not restart any routers
 670
 671     --force-clean-process
 672         When starting a service, if a service process is already running
 673         but no pidfile exists, kill the service process before starting
 674         the new one. This applies to routers too.
 675
 676     --ignore-orphans
 677         When starting a service, if a service process is already running but
 678         no pidfile exists, ignore the existing process and carry on starting
 679         the new one (i.e., ignore orphans).  This applies to routers too.
 680
 681     ==== stopping services =====
 682
 683     --stop-all
 684         Stop the router and all services.  Services are sent the TERM signal,
 685         followed by the INT signal, followed by the KILL signal.  With each
 686         iteration, the script pauses up to --signal-timeout seconds waiting
 687         for each process to die before sending the next signal.
 688
 689     --stop
 690         Stop the service specified by --service.  See also --stop-all.
 691         If the requested service does not have a matching PID file, an
 692         attempt to locate the PID via 'ps' will be made.
 693
 694     --stop-services
 695         Stop all services but do not stop any routers.  See also --stop-all.
 696
 697     --graceful-shutdown-all
 698         Send TERM signal to all services + router
 699
 700     --graceful-shutdown
 701         Send TERM signal to the service specified by --service
 702
 703     --fast-shutdown-all
 704         Send INT signal to all services + router
 705
 706     --fast-shutdown
 707         Send INT signal to the service specified by --service
 708
 709     --immediate-shutdown-all
 710         Send KILL signal to all services + router
 711
 712     --immediate-shutdown
 713         Send KILL signal to the service specified by --service
 714
 715     --kill-with-fire
 716         Send KILL signal to all running services + routers, regardless of
 717         the presence of a PID file, and remove all PID files indiscriminately.
 718
 719     ==== signaling services =====
 720
 721     --signal-all
 722         Send signal to all services
 723
 724     --signal
 725         Name of signal to send.  If --signal-all is not specified, the
 726         signal will be sent to the service specified by --service.
 727
 728     --signal-timeout
 729         Seconds to wait for a process to die after sending a shutdown signal.
 730         All signals except HUP, USR1, and USR2 are assumed to be shutdown signals.
 731
 732     ==== special signals ====
 733
 734     --router-de-register
 735     --router-de-register-all
 736         Sends a SIGUSR1 signal to the selected service(s), which causes each
 737         service's listener process to send an "unregister" command to all
 738         registered routers.  The --all variant sends the signal to all
 739         running listeners.  The non-(--all) variant requires a --service.
 740
 741     --router-re-register
 742     --router-re-register-all
 743         Sends a SIGUSR2 signal to the selected service(s), which causes each
 744         service's listener process to send a "register" command to all
 745         configured routers.  The --all variant sends the signal to all
 746         running listeners.  The non-(--all) variant requires a --service.
 747
 748     --reload
 749     --reload-all
 750         Sends a SIGHUP signal to the selected service(s).  SIGHUP causes
 751         each listener process to reload its opensrf_core.xml config file
 752         and gracefully re-launch drone processes.  The -all variant sends
 753         the signal to all services.  The non-(-all) variant requires a
 754         --service.
 755 HELP
 756 exit;
 757 }
 758
 759 # we do not verify services for stop/signal actions, since those may
 760 # legitimately be used against services not (or no longer) configured
 761 # to run on the selected host.
 762 do_init() and verify_services($opt_service) if
 763     ($opt_start or
 764     $opt_start_all or
 765     $opt_start_services or
 766     $opt_restart or
 767     $opt_restart_all or
 768     $opt_restart_services) and (
 769         not defined $opt_service or $opt_service ne 'router'
 770     );
 771
 772 # starting services.  do_init() handled above
 773 do_start($opt_service) if $opt_start;
 774 do_stop($opt_service) and do_start($opt_service) if $opt_restart;
 775 do_start_all() if $opt_start_all;
 776 do_start_services() if $opt_start_services;
 777 do_stop_all() and do_start_all() if $opt_restart_all;
 778 do_stop_services() and do_start_services() if $opt_restart_services;
 779
 780 # stopping services
 781 do_stop($opt_service) if $opt_stop;
 782 do_stop_all() if $opt_stop_all;
 783 do_stop_services() if $opt_stop_services;
 784 do_stop($opt_service, 'TERM') if $opt_shutdown_graceful;
 785 do_stop($opt_service, 'INT') if $opt_shutdown_fast;
 786 do_stop($opt_service, 'KILL') if $opt_shutdown_immediate;
 787 do_stop_all('TERM') if $opt_shutdown_graceful_all;
 788 do_stop_all('INT') if $opt_shutdown_fast_all;
 789 do_stop_all('KILL') if $opt_shutdown_immediate_all;
 790 do_kill_with_fire() if $opt_kill_with_fire;
 791
 792 # signaling
 793 $opt_signal = 'USR1' if $opt_router_de_register or $opt_router_de_register_all;
 794 $opt_signal = 'USR2' if $opt_router_re_register or $opt_router_re_register_all;
 795 $opt_signal = 'HUP'  if $opt_reload or $opt_reload_all;
 796
 797 do_signal($opt_service, $opt_signal) if $opt_signal and $opt_service;
 798 do_signal_all($opt_signal) if
 799     $opt_signal_all or
 800     $opt_reload_all or
 801     $opt_router_de_register_all or
 802     $opt_router_re_register_all;
 803
 804 # misc
 805 do_diagnostic() if $opt_diagnostic;
 806
 807
 808 # show help if no action was requested
 809 do_help() if $opt_help or not (
 810     $opt_start or
 811     $opt_start_all or
 812     $opt_start_services or
 813     $opt_stop or
 814     $opt_stop_all or
 815     $opt_stop_services or
 816     $opt_restart or
 817     $opt_restart_all or
 818     $opt_restart_services or
 819     $opt_signal or
 820     $opt_signal_all or
 821     $opt_shutdown_graceful or
 822     $opt_shutdown_graceful_all or
 823     $opt_shutdown_fast or
 824     $opt_shutdown_fast_all or
 825     $opt_shutdown_immediate or
 826     $opt_shutdown_immediate_all or
 827     $opt_kill_with_fire or
 828     $opt_diagnostic
 829 )