Implement long options, running instance control and component dependency checking

git-svn-id: file:///svnroot/gsc/trunk@254 d2de0444-eb31-0410-8365-af798a554d48

1 files changed, 362 insertions, 50 deletions

diff --git a/jabberd/main.c b/jabberd/main.c
index e2a00ac..476abd8 100644
--- a/jabberd/main.c
+++ b/jabberd/main.c
@@ -30,3 +30,5 @@ int x_argc;
 char **x_argv;
-char *pidfile;
+char *pidfile = STATEDIR "/jabberd.pid";
+char *ctlfile = STATEDIR "/.jabberd.ctl";
+char *statfile = STATEDIR "/.jabberd.stat";
 unsigned long shutdown_timeout = 5;
@@ -133,13 +135,23 @@ usage ()
 {
-  printf ("usage: jabberd [-Dfehv][-c config][-p pidfile]\n");
+  printf ("usage: jabberd [-Dfehv][-c config][-r tag [tag...]]\n");
   printf ("jabberd -- A dispatcher program for jabber 2.x\n");
   printf ("\n");
-  printf ("Options:\n");
-  printf ("  -c FILE     use this configuration file\n");
-  printf ("  -D          increase debugging level\n");
-  printf ("  -f          run in foreground mode (implies -e)\n");
-  printf ("  -e          use standard error for diagnostics output\n");
-  printf ("  -h          display this help list\n");
-  printf ("  -p FILE     write master process ID to FILE\n");
-  printf ("  -v          display program version\n");
+  printf ("General-purpose options:\n");
+  printf ("  -c, --config-file=FILE     use this configuration file\n");
+  printf ("  -D, --debug                increase debugging level\n");
+  printf ("  -e, --stderr               use standard error for diagnostics output\n");
+  printf ("  -f, --foreground           run in foreground mode (implies -e)\n");
+  printf ("  --force                    start up even if another copy seems to be running\n");
+  
+  printf ("\nControlling running instance:\n");
+  printf ("  --status                   display status information\n");
+  printf ("  --stop                     stop the running copy\n");
+  printf ("  --reload, --hup            reload the running copy\n");
+  printf ("  -r, --restart tag [tag...] restart named components\n");
+
+  printf ("\nInformational options:\n");
+  printf ("  -h, --help                 display this help list\n");
+  printf ("  -v, --version              display program version\n");
+
+
   printf ("\n");
@@ -358,2 +370,14 @@ cfg_pidfile (struct cfg_file *file, char *kw, char *val, void *unused)
 void
+cfg_ctlfile (struct cfg_file *file, char *kw, char *val, void *unused)
+{
+  ctlfile = strdup (val);
+}
+
+void
+cfg_statfile (struct cfg_file *file, char *kw, char *val, void *unused)
+{
+  ctlfile = strdup (val);
+}
+
+void
 cfg_umask (struct cfg_file *file, char *kw, char *val, void *unused)
@@ -392,3 +416,4 @@ cfg_prog (struct cfg_file *file, char *kw, char *val, void *unused)
 
-struct exec_rec {
+struct transport_rec
+{
   char *tag;
@@ -397,2 +422,4 @@ struct exec_rec {
   int retr[2];
+  int depc;
+  char **depv;
 };
@@ -400,5 +427,5 @@ struct exec_rec {
 static void
-cfg_exec_command (struct cfg_file *file, char *kw, char *val, void *data)
+cfg_transport_command (struct cfg_file *file, char *kw, char *val, void *data)
 {
-  struct exec_rec *prec = data;
+  struct transport_rec *prec = data;
   prec->command = strdup (val);
@@ -407,5 +434,5 @@ cfg_exec_command (struct cfg_file *file, char *kw, char *val, void *data)
 void
-cfg_exec_facility (struct cfg_file *file, char *kw, char *val, void *data)
+cfg_transport_facility (struct cfg_file *file, char *kw, char *val, void *data)
 {
-  struct exec_rec *prec = data;
+  struct transport_rec *prec = data;
   if (str_to_facility (val, &prec->facility))
@@ -416,5 +443,5 @@ cfg_exec_facility (struct cfg_file *file, char *kw, char *val, void *data)
 void
-cfg_exec_stdout (struct cfg_file *file, char *kw, char *val, void *data)
+cfg_transport_stdout (struct cfg_file *file, char *kw, char *val, void *data)
 {
-  struct exec_rec *prec = data;
+  struct transport_rec *prec = data;
   if (str_to_priority (val, &prec->retr[RETR_OUT]))
@@ -425,5 +452,5 @@ cfg_exec_stdout (struct cfg_file *file, char *kw, char *val, void *data)
 void
-cfg_exec_stderr (struct cfg_file *file, char *kw, char *val, void *data)
+cfg_transport_stderr (struct cfg_file *file, char *kw, char *val, void *data)
 {
-  struct exec_rec *prec = data;
+  struct transport_rec *prec = data;
   if (str_to_priority (val, &prec->retr[RETR_ERR]))
@@ -434,3 +461,15 @@ cfg_exec_stderr (struct cfg_file *file, char *kw, char *val, void *data)
 void
-cfg_exec (struct cfg_file *file, char *kw, char *val, void *unused)
+cfg_transport_depend (struct cfg_file *file, char *kw, char *val, void *data)
+{
+  struct transport_rec *prec = data;
+  int rc;
+  if (rc = argcv_get (val, NULL, NULL, &prec->depc, &prec->depv))
+    {
+      logmsg (LOG_ERR, "%s:%u: cannot split dependency line: %s",
+	      config_file, file->line, strerror (rc));
+    }
+}
+
+void
+cfg_transport (struct cfg_file *file, char *kw, char *val, void *unused)
 {
@@ -440,8 +479,9 @@ cfg_exec (struct cfg_file *file, char *kw, char *val, void *unused)
   
-  struct exec_rec rec; 
+  struct transport_rec rec; 
   static struct kw_handler kwtab[] = {
-    { "command", cfg_exec_command },
-    { "stdout", cfg_exec_stdout },
-    { "stderr", cfg_exec_stderr },
-    { "facility", cfg_exec_facility },
+    { "command", cfg_transport_command },
+    { "stdout", cfg_transport_stdout },
+    { "stderr", cfg_transport_stderr },
+    { "facility", cfg_transport_facility },
+    { "depend", cfg_transport_depend },
     { NULL }
@@ -461,5 +501,6 @@ cfg_exec (struct cfg_file *file, char *kw, char *val, void *unused)
     }
-  register_prog (rec.tag, argv, rec.retr);
+  register_transport (rec.tag, argv, rec.retr, rec.depv);
   free (rec.tag);
   free (rec.command);
+  argcv_free (rec.depc, rec.depv);
   argcv_free (argc, argv);
@@ -484,5 +525,8 @@ struct kw_handler kw_handler[] = {
   { "pidfile", cfg_pidfile },
+  { "ctlfile", cfg_ctlfile },
+  { "statfile", cfg_statfile },
   { "umask", cfg_umask },
   { "prog", cfg_prog },
-  { "exec", cfg_exec },
+  { "transport", cfg_transport },
+  { "exec", cfg_transport },
   { "shutdown-timeout", cfg_shutdown_timeout },
@@ -518,14 +562,49 @@ pidfile_write ()
 {
-  if (pidfile)
+  FILE *fp = fopen (pidfile, "w");
+  if (!fp)
+    {
+      logmsg (LOG_CRIT, "cannot open pidfile `%s' for writing: %s",
+	      pidfile, strerror (errno));
+      return;
+    }
+  fprintf (fp, "%lu\n", (unsigned long) getpid ());
+  fclose (fp);
+}
+
+pid_t
+pidfile_read (int must_exist)
+{
+  int c;
+  pid_t n = 0;
+  FILE *fp = fopen (pidfile, "r");
+  if (!fp)
     {
-      FILE *fp = fopen (pidfile, "w");
-      if (!fp)
+      if (must_exist && errno != ENOENT)
+	logmsg (LOG_ERR, "cannot open pid file `%s': %s",
+		pidfile,
+		strerror (errno));
+      return -1;
+    }
+
+  while ((c = fgetc (fp)) != EOF)
+    {
+      if (isdigit (c))
+	n = n * 10 + c - '0';
+      else if (c == '\n')
+	break;
+      else
 	{
-	  logmsg (LOG_CRIT, "cannot open pidfile `%s' for writing: %s",
-		  pidfile, strerror (errno));
-	  return;
+	  logmsg (LOG_ERR, "unexpected character %#03o in pidfile `%s'",
+		  c, pidfile);
+	  return -1;
 	}
-      fprintf (fp, "%lu\n", (unsigned long) getpid ());
-      fclose (fp);
     }
+  fclose (fp);
+  if (kill (n, 0))
+    {
+      logmsg (LOG_ERR, "Cannot signal master process %lu: %s",
+	      (unsigned long) n, strerror (errno));
+      return -1;
+    }
+  return n;
 }
@@ -535,3 +614,3 @@ pidfile_remove ()
 {
-  if (pidfile && unlink (pidfile))
+  if (unlink (pidfile))
     logmsg (LOG_ERR, "cannot remove pidfile `%s': %s",
@@ -549,3 +628,3 @@ switch_to_privs (uid_t uid, gid_t gid)
   struct group_list *gp;
-  
+ 
   if (uid == 0)
@@ -690,5 +769,7 @@ priv_setup ()
 
-#define ACTION_CONT    0
-#define ACTION_STOP    1
-#define ACTION_RESTART 2
+#define ACTION_CONT       0
+#define ACTION_STOP       1
+#define ACTION_RESTART    2
+#define ACTION_COMPRELOAD 3
+#define ACTION_DUMPSTATS  4
 
@@ -728,2 +809,11 @@ sig_handler(int sig)
       got_alarm = 1;
+      break;
+
+    case SIGUSR1:
+      action = ACTION_COMPRELOAD;
+      break;
+
+    case SIGUSR2:
+      action = ACTION_DUMPSTATS;
+      break;
     }
@@ -741,2 +831,4 @@ signal_setup (RETSIGTYPE (*sf)(int))
   signal (SIGALRM, sf);
+  signal (SIGUSR1, sf);
+  signal (SIGUSR2, sf);
 }
@@ -750,2 +842,164 @@ syslog_setup ()
 
+
+void
+stop_components ()
+{
+  FILE *fp;
+  size_t size = 0;
+  char *buf = NULL;
+  
+  logmsg (LOG_INFO, "stopping components");
+  
+  fp = fopen (ctlfile, "r");
+  if (!fp)
+    {
+      logmsg (LOG_ERR, "cannot open control file `%s': %s",
+	      ctlfile, strerror (errno));
+      return;
+    }
+  if (unlink (ctlfile))
+    {
+      logmsg (LOG_ERR, "cannot open control file `%s': %s",
+	      ctlfile, strerror (errno));
+      fclose (fp);
+      return;
+    }
+  
+  while (getline (&buf, &size, fp) > 0)
+    {
+      size_t len = strlen (buf);
+      if (len == 0)
+	continue;
+      if (buf[len-1] == '\n')
+	buf[len-1] = 0;
+      progman_stop_component (buf);
+    }
+
+  free (buf);
+  fclose (fp);
+}
+
+int
+request_restart_components (char **argv)
+{
+  FILE *fp;
+  pid_t pid = pidfile_read (1);
+
+  if (pid == -1)
+    return 1;
+
+  fp = fopen (ctlfile, "w");
+  if (!fp)
+    {
+      logmsg (LOG_ERR, "cannot open control file `%s': %s",
+	      ctlfile, strerror (errno));
+      return 1;
+    }
+  for (; *argv; argv++)
+    fprintf (fp, "%s\n", *argv);
+  fclose (fp);
+
+  kill (pid, SIGUSR1);
+  return 0;
+}
+
+
+int
+jabberd_reload ()
+{
+  pid_t pid = pidfile_read (1);
+
+  if (pid == -1)
+    {
+      logmsg (LOG_CRIT, "jabberd is not running");
+      return 1;
+    }
+  
+  logmsg (LOG_INFO,  "reloading jabberd at PID %lu", (unsigned long) pid);
+  return kill (pid, SIGHUP) ? 2 : 0;
+}
+      
+int
+jabberd_status ()
+{
+  FILE *fp;
+  pid_t pid = pidfile_read (0);
+  int i;
+  
+  if (pid == -1)
+    {
+      logmsg (LOG_INFO, "jabberd is not running");
+      return 1;
+    }
+  
+  if (kill (pid, SIGUSR2))
+    {
+      logmsg (LOG_INFO,
+	      "jabberd is not running, but a pidfile is found (pid %lu)\n",
+	      (unsigned long) pid);
+      return 1;
+    }
+  logmsg (LOG_INFO, "jabberd is running; PID %lu",
+	  (unsigned long) pid);
+
+  for (i = 0; i < access (statfile, R_OK); i++)
+    sleep (1);
+  
+  fp = fopen (statfile, "r");
+  if (!fp)
+    logmsg (LOG_ERR, "cannot open statfile `%s': %s",
+	    statfile, strerror (errno));
+  else
+    {
+      char c;
+
+      if (unlink (statfile))
+	logmsg (LOG_ERR, "cannot unlink statfile `%s': %s",
+		statfile, strerror (errno));
+      while ((c = fgetc (fp)) != EOF)
+	fputc (c, stdout);
+      fclose (fp);
+    }
+  return 0;
+}
+
+int
+jabberd_stop ()
+{
+  pid_t pid = pidfile_read (1);
+
+  if (pid == -1)
+    {
+      logmsg (LOG_CRIT, "jabberd is not running");
+      return 1;
+    }
+  
+  logmsg (LOG_INFO,  "stopping jabberd at PID %lu", (unsigned long) pid);
+  return kill (pid, SIGTERM) ? 2 : 0;
+}
+
+
+enum {
+  OPTION_RELOAD = 256,
+  OPTION_STATUS,
+  OPTION_STOP,
+  OPTION_FORCE
+};
+
+struct option options[] = {
+  { "config-file", required_argument, NULL, 'c' },
+  { "debug", no_argument, NULL, 'D' },
+  { "foreground", no_argument, NULL, 'f' },
+  { "stderr", no_argument, NULL, 'e' },
+  { "help", no_argument, NULL, 'h' },
+  { "restart-module", no_argument, NULL, 'r' },
+  { "reload", no_argument, NULL, OPTION_RELOAD },
+  { "hup", no_argument, NULL, OPTION_RELOAD },
+  { "status", no_argument, NULL, OPTION_STATUS },
+  { "stop", no_argument, NULL, OPTION_STOP },
+  { "version", no_argument, NULL, 'v' },
+  { "force", no_argument, NULL, OPTION_FORCE },
+  { NULL }
+};
+  
 int
@@ -754,5 +1008,8 @@ main(int argc, char **argv)
   int c;
-
+  int mode = 0;
+  pid_t pid;
+  int force = 0;
+  
   progname = argv[0];
-  while ((c = getopt(argc, argv, "c:Dfehp:v")) != EOF)
+  while ((c = getopt_long (argc, argv, "c:Dfehrv", options, NULL)) != EOF)
     {
@@ -779,6 +1036,2 @@ main(int argc, char **argv)
 
-	case 'p':
-	  pidfile = optarg;
-	  break;
-
 	case 'v':
@@ -786,2 +1039,14 @@ main(int argc, char **argv)
 	  exit (0);
+
+	case 'r':
+	case OPTION_RELOAD:
+	case OPTION_STATUS:
+	case OPTION_STOP:
+	  log_to_stderr = 1;
+	  mode = c;
+	  break;
+
+	case OPTION_FORCE:
+	  force = 1;
+	  break;
 	  
@@ -793,3 +1058,3 @@ main(int argc, char **argv)
 
-  if (argc != optind)
+  if (argc != optind && mode != 'r')
     {
@@ -807,2 +1072,37 @@ main(int argc, char **argv)
 
+  switch (mode)
+    {
+    case 'r':
+      priv_setup ();
+      umask (jabberd_umask);
+      exit (request_restart_components (argv + optind));
+      
+    case OPTION_RELOAD:
+      exit (jabberd_reload ());
+      
+    case OPTION_STATUS:
+      exit (jabberd_status ());
+      
+    case OPTION_STOP:
+      exit (jabberd_stop ());
+
+    default:
+      priv_setup ();
+      umask (jabberd_umask);
+    }
+
+  if (!force)
+    {
+      pid = pidfile_read (0);
+      if (pid != -1)
+	{
+	  logmsg (LOG_ALERT,
+		  "jabberd seems to be already running at pid %lu",
+		  (unsigned long) pid);
+	  logmsg (LOG_INFO,
+		  "use --status to verify or --force to start up anyway");
+	  exit (1);
+	}
+    }  
+  
   if (argv[0][0] == '/')
@@ -813,6 +1113,6 @@ main(int argc, char **argv)
   else
-    logmsg (LOG_NOTICE, "jabberd not started as an absolute pathname; SIGHUP will not work");
+    logmsg (LOG_NOTICE,
+	    "jabberd not started as an absolute pathname; "
+	    "SIGHUP will not work");
   
-  priv_setup ();
-  umask (jabberd_umask);
   logmsg (LOG_NOTICE, "jabberd started");
@@ -843,2 +1143,14 @@ main(int argc, char **argv)
 	}
+      switch (action)
+	{
+	case ACTION_COMPRELOAD:
+	  stop_components ();
+	  action = ACTION_CONT;
+	  break;
+
+	case ACTION_DUMPSTATS:
+	  progman_dump_stats (statfile);
+	  action = ACTION_CONT;
+	  break;
+	}
     }