chiark / gitweb /
argument parsing and logging, etc.
authorIan Jackson <ian@liberator.relativity.greenend.org.uk>
Thu, 8 Apr 2010 01:43:35 +0000 (02:43 +0100)
committerIan Jackson <ian@liberator.relativity.greenend.org.uk>
Thu, 8 Apr 2010 01:43:35 +0000 (02:43 +0100)
backends/innduct.c

index c83a02c..0ce149b 100644 (file)
 
 /*----- configuration options -----*/
 
-static char *feedname, *feedfile;
-static int max_connections, max_queue_per_conn;
-static int connection_setup_timeout, port, try_stream;
-static int inndcomm_flush_timeout;
+static char *sitename, *feedfile;
+static int max_connections=10, max_queue_per_conn=200;
+static int connection_setup_timeout=200, port=119, try_stream=1;
+static int inndcomm_flush_timeout=100, quiet_if_locked=0;
 static const char *remote_host;
 static int reconnect_delay_periods, flushfail_retry_periods, open_wait_periods;
+static const char *inndconffile;
 
 static double accept_proportion;
-static double nocheck_thresh= 0.95;
-static double nocheck_decay= 1-1/100;
+static double nocheck_thresh_pct= 95.0;
+static double nocheck_thresh; /* computed in main from _pct */
+static double nocheck_decay_articles= 100; /* converted to _decay */
+static double nocheck_decay; /* computed in main from _articles */
 static int nocheck, nocheck_reported;
 
 
@@ -279,6 +282,9 @@ static LIST(Article) *queue;
 
 static char *path_ductlock, *path_duct, *path_ductdefer;
 
+#define SMS(newstate, periods, why) \
+   (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
+
 static StateMachineState sms;
 static FILE *defer;
 static InputFile *main_input_file, *old_input_file;
@@ -293,6 +299,8 @@ static int filemon_init(void);
 static void filemon_setfile(int mainfeed_fd, const char *mainfeed_path);
 static void filemon_callback(void);
 
+static void statemc_setstate(StateMachineState newsms, int periods,
+                            const char *forlog, const char *why);
 
 /*========== utility functions etc. ==========*/
 
@@ -349,6 +357,61 @@ static int xwaitpid(pid_t *pid, const char *what) {
   return status;
 }
 
+/*========== logging ==========*/
+
+static void logcore(int sysloglevel, const char *fmt, ...)
+     __attribute__((printf,2,3))
+static void logcore(int sysloglevel, const char *fmt, ...) {
+  va_list al;
+  va_start(al,fmt);
+  if (become_daemon) {
+    vsyslog(sysloglevel,fmt,al);
+  } else {
+    vfprintf(stderr,fmt,al);
+    putc('\n',stderr);
+  }
+}
+
+static void logv(int sysloglevel, const char *pfx, int errnoval,
+                int exitstatus, const char *fmt, va_list al)
+     __attribute__((printf,4,0))
+static void logv(int sysloglevel, const char *pfx, int errnoval,
+                int exitstatus, const char *fmt, va_list al) {
+  char msgbuf[256];
+  vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
+  msgbuf[sizeof(msgbuf)-1]= 0;
+
+  if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
+    sysloglevel= LOG_ERR; /* run by wrong user, probably */
+
+  logcore(sysloglevel, "<%s>%s: %s%s%s",
+        sitename, pfx, msgbuf,
+        errnoval>=0 ? ": " : "",
+        errnoval>=0 ? strerror(errnoval) : "");
+}
+
+#define logwrap(fn, pfx, sysloglevel, errno, estatus)  \
+  static void fn(const char *fmt, ...)                 \
+      __attribute__((printf,1,2));                     \
+  static void fn(const char *fmt, ...) {               \
+    va_list al;                                                \
+    va_start(al,fmt);                                  \
+    logv(sysloglevel, pfx, errno, estatus, fmt, al);   \
+  }
+
+logwrap(sysdie,   " critical", LOG_CRIT,   errno, 16);
+logwrap(die,      " critical", LOG_CRIT,   -1,    16);
+
+logwrap(sysfatal, " fatal",    LOG_ERR,    errno, 12);
+logwrap(fatal,    " fatal",    LOG_ERR,    -1,    12);
+
+logwrap(syswarn,  " warning",  LOG_WARN,   errno, 0);
+logwrap(warn,     " warning",  LOG_WARN,   -1,    0);
+
+logwrap(notice,   "",          LOG_NOTICE, -1,    0);
+logwrap(info,     " info",     LOG_INFO,   -1,    0);
+
+
 /*========== making new connections ==========*/
 
 static int connecting_sockets[2]= {-1,-1};
@@ -380,7 +443,8 @@ static void connect_attempt_discard(void) {
 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
   Conn *conn= 0;
 
-  conn= xcalloc(sizeof(*conn));
+  conn= xmalloc(sizeof(*conn));
+  memset(conn,0,sizeof(*conn));
 
   DECL_MSG_CMSG(msg);
   struct cmsghdr *h= 0;
@@ -440,7 +504,7 @@ static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
   case CONNCHILD_ESTATUS_STREAM:    conn->stream= 1;   break;
   case CONNCHILD_ESTATUS_NOSTREAM:  conn->stream= 0;   break;
   default:
-    die("connect: child gave unexpected exit status %d", es);
+    fatal("connect: child gave unexpected exit status %d", es);
   }
 
   set nonblocking;
@@ -484,29 +548,29 @@ static void connect_start() {
     if (NNTPconnect(remote_host, port, &cn_from, &cn_to, buf) < 0) {
       if (buf[0]) {
        sanitise_inplace(buf);
-       die("connect: rejected: %s", buf);
+       fatal("connect: rejected: %s", buf);
       } else {
-       sysdie("connect: connection attempt failed");
+       sysfatal("connect: connection attempt failed");
       }
     }
     if (NNTPsendpassword(remote_host, cn_from, cn_to) < 0)
-      sysdie("connect: authentication failed");
+      sysfatal("connect: authentication failed");
     if (try_stream) {
       if (fputs("MODE STREAM\r\n", cn_to) ||
          fflush(cn_to))
-       sysdie("connect: could not send MODE STREAM");
+       sysfatal("connect: could not send MODE STREAM");
       buf[sizeof(buf)-1]= 0;
       if (!fgets(buf, sizeof(buf)-1, cn_from)) {
        if (ferror(cn_from))
-         sysdie("connect: could not read response to MODE STREAM");
+         sysfatal("connect: could not read response to MODE STREAM");
        else
-         die("connect: connection close in response to MODE STREAM");
+         fatal("connect: connection close in response to MODE STREAM");
       }
       int l= strlen(buf);
       assert(l>=1);
       if (buf[-1]!='\n') {
        sanitise_inplace(buf);
-       die("connect: response to MODE STREAM is too long: %.100s...",
+       fatal("connect: response to MODE STREAM is too long: %.100s...",
            remote_host, buf);
       }
       l--;  if (l>0 && buf[1-]=='\r') l--;
@@ -515,7 +579,7 @@ static void connect_start() {
       int rcode= strtoul(buf,&ep,10);
       if (ep != buf[3]) {
        sanitise_inplace(buf);
-       die("connect: bad response to MODE STREAM: %.50s", buf);
+       fatal("connect: bad response to MODE STREAM: %.50s", buf);
       }
       switch (rcode) {
       case 203:
@@ -953,7 +1017,7 @@ static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_event ev,
     GET_ARTICLE;
     if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
        || fflush(defer))
-      sysdie("write to defer file %s",path_ductdefer);
+      sysfatal("write to defer file %s",path_ductdefer);
     article_done(conn, art, RC_deferred);
     break;
 
@@ -969,8 +1033,11 @@ static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_event ev,
 static void feedfile_eof(InputFile *ipf) {
   assert(ipf != main_input_file); /* promised by tailing_try_read */
   assert(ipf == old_input_file);
-  assert(sms==sm_SEPARATED1 || sms==sm_DROPPING1);
-  sms++;
+
+  if (sms==sm_SEPARATED1) SMS(SEPARATED2, 0, "eof on old feed file");
+  else if (sms==sm_DROPPING1) SMS(DROPPING2, 0, "eof on dead feed file");
+  else abort();
+  
   inputfile_tailing_stop(ipf);
   if (main_input_file)
     inputfile_tailing_start(main_input_file);
@@ -980,7 +1047,7 @@ static InputFile *open_input_file(const char *path) {
   int fd= open(path, O_RDONLY);
   if (fd<0) {
     if (errno==ENOENT) return 0;
-    sysdie("unable to open input file %s", path);
+    sysfatal("unable to open input file %s", path);
   }
 
   InputFile *ipf= xmalloc(sizeof(InputFile));
@@ -1336,7 +1403,7 @@ static void open_defer(void) {
 
   assert(!defer);
   defer= fopen(path_ductdefer, "a+");
-  if (!defer) sysdie("could not open defer file %s", path_ductdefer);
+  if (!defer) sysfatal("could not open defer file %s", path_ductdefer);
 
   /* truncate away any half-written records */
 
@@ -1372,7 +1439,8 @@ static void open_defer(void) {
         " shrinking by %ld bytes from %ld to %ld",
         path_ductdefer, orgsize - truncto, orgsize, truncto);
 
-    if (fflush(defer)) sysdie("could not flush defer file %s", path_ductdefer);
+    if (fflush(defer))
+      sysfatal("could not flush defer file %s", path_ductdefer);
     if (ftruncate(fileno(defer), truncto))
       sysdie("could not truncate defer file %s", path_ductdefer);
 
@@ -1412,7 +1480,7 @@ static void statemc_init(void) {
   open_defer();
 
   int lockfd= open(path_ductlock, O_CREAT|O_RDWR, 0600);
-  if (lockfd<0) sysdie("open lockfile %s", path_ductlock);
+  if (lockfd<0) sysfatal("open lockfile %s", path_ductlock);
 
   struct flock fl;
   memset(&fl,0,sizeof(fl));
@@ -1420,8 +1488,10 @@ static void statemc_init(void) {
   fl.l_whence= SEEK_SET;
   r= fcntl(lockfd, F_SETLK, &fl);
   if (r==-1) {
-    if (errno==EACCES || errno==EAGAIN)
-      die("another duct holds the lockfile");
+    if (errno==EACCES || errno==EAGAIN) {
+      if (quiet_if_locked) exit(0);
+      fatal("another duct holds the lockfile");
+    }
     sysdie("fcntl F_SETLK lockfile %s", path_ductlock);
   }
 
@@ -1453,18 +1523,16 @@ static void statemc_init(void) {
       spawn_inndcomm_flush(); /* => Flushing, sets sms to sm_FLUSHING */
     } else {
       /* F!=D => Separated */
-      sms= sm_SEPARATED;
+      SMS(SEPARATED1, 0, "found both old and current feed files");
       startup_set_input_file(file_d);
     }
   } else { /*!file_d*/
-    sms= sm_WAITING;
-    sm_period_counter= open_wait_periods;
+    SMS(WAITING, open_wait_periods, "no feed file currently exists");
   }
 }
 
 static void statemc_poll(void) {
-  if (sms==sm_WAITING)
-    statemc_waiting_poll();
+  if (sms==sm_WAITING) { statemc_waiting_poll(); return; }
 
   if (!sm_period_counter) return;
   sm_period_counter--;
@@ -1473,7 +1541,7 @@ static void statemc_poll(void) {
   if (sm_period_counter) return;
   switch (sms) {
   case sm_WAITING:
-    die("timed out waiting for innd to create feed file %s", feedfile);
+    fatal("timed out waiting for innd to create feed file %s", feedfile);
   case sm_FLUSHFAIL:
     spawn_inndcomm_flush(void);
     break;
@@ -1486,7 +1554,7 @@ static void statemc_waiting_poll(void) {
   InputFile *file_f= open_input_file(feedfile);
   if (!file_f) return;
   startup_set_input_file(file_d);
-  sms= sm_NORMAL;
+  SMS(NORMAL, 0, "found and opened feed file");
 }
 
 static void startup_set_input_file(InputFile *f) {
@@ -1506,14 +1574,14 @@ static void *statemc_check_oldinput_done(oop_source *lp,
   r= fstat(fileno(defer), &stab);
   if (r) sysdie("check defer file %s", path_defer);
 
-  if (fclose(defer)) sysdie("could not close defer file %s", path_defer);
+  if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
   defer= 0;
 
   char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
                           (unsigned long)now.tv_sec,
                           (unsigned long)stab.st_ino);
   if (link(path_defer, path_backlog))
-    sysdie("could not install defer file %s as backlog file %s",
+    sysfatal("could not install defer file %s as backlog file %s",
           path_defer, backlog);
   if (unlink(path_defer))
     sysdie("could not unlink old defer link %s to backlog file %s",
@@ -1534,8 +1602,18 @@ static void *statemc_check_oldinput_done(oop_source *lp,
   old_input_file= 0;
 
   notice("flush complete");
+  SMS(NORMAL, 0, "flush complete");
+}
 
-  sms= sm_NORMAL;
+static void statemc_setstate(StateMachineState newsms, int periods,
+                            const char *forlog, const char *why) {
+  sms= newsms;
+  sm_period_counter= periods;
+  if (periods) {
+    info("%s[%d] %s",periods,forlog,why);
+  } else {
+    info("%s %s",forlog,why);
+  }
 }
 
 /*========== flushing the feed ==========*/
@@ -1560,7 +1638,7 @@ static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
       warn("feed has been dropped by innd, finishing up");
       old_input_file= main_input_file;
       main_input_file= 0;
-      sms= sm_DROPPING1;
+      SMS(DROPPING1, 0, "dropped by innd");
       return OOP_CONTINUE;
 
     case 0:
@@ -1568,7 +1646,7 @@ static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
       main_input_file= open_input_file(feedfile);
       if (!main_input_file)
        die("flush succeeded but feedfile %s does not exist!", feedfile);
-      sms= sm_SEPARATED1;
+      SMS(SEPARATED1, 0, "feed file missing");
       return OOP_CONTINUE;
 
     default:
@@ -1584,8 +1662,7 @@ static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
   }
 
  failed:
-  sm_period_counter= flushfail_retry_periods;
-  sms= sm_FLUSHFAIL;;
+  SMS(FLUSHFAIL, flushfail_retry_periods, "flush failed, will retry");
 }
 
 static void inndcommfail(const char *what) {
@@ -1604,7 +1681,7 @@ void spawn_inndcomm_flush(void) {
   inndcomm_child= xfork();
 
   if (!inndcomm_child) {
-    static char flushargv[2]= { feedname, 0 };
+    static char flushargv[2]= { sitename, 0 };
     char *reply;
 
     close(pipefds[0]);
@@ -1623,7 +1700,7 @@ void spawn_inndcomm_flush(void) {
   int sentinel_fd= pipefds[0];
   on_fd_read_except(sentinel_fd, inndcomm_event);
 
-  sms= sm_FLUSHING;
+  SMS(FLUSHING, 0, "flush is in progress");
 }
 
 /*========== main program ==========*/
@@ -1679,10 +1756,216 @@ EVERY(period, {PERIOD_SECONDS,0}, {
   check_master_queue();
 });
 
-main {
+
+/*========== option parsing ==========*/
+
+enum OptFlags {
+  of_seconds= 001000u;
+  of_boolean= 002000u;
+};
+
+typedef struct Option Option;
+typedef void OptionParser(const Option*, const char *val);
+
+struct Option {
+  int short;
+  const char *long;
+  void *store;
+  OptionParser *fn;
+  int noarg;
+};
+
+void op_integer(const Option *o, const char *val) {
+  char *ep;
+  errno= 0;
+  unsigned long ul= strtoul(val,&ep,10);
+  if (*ep || ep==val || errno || ul>INT_MAX)
+    badusage("bad integer value for %s",o->long);
+  int *store= o->store;
+  *store= ul;
+}
+
+void op_double(const Option *o, const char *val) {
+  int *store= o->store;
+  char *ep;
+  errno= 0;
+  *store= strtod(val, &ep);
+  if (*ep || ep==val || errno)
+    badusage("bad floating point value for %s",o->long);
+}
+
+void op_string(const Option *o, const char *val) {
+  char **store= o->store;
+  free(*store);
+  *store= val;
+}
+
+void op_seconds(const Option *o, const char *val) {
+  int *store= o->store;
+  char *ep;
+  
+  double v= strtod(val,&ep);
+  if (ep==val) badusage("bad time/duration value for %s",o->long);
+
+  if (!*ep || !strcmp(ep,"s")) unit= 1;
+  else if (!strcmp(ep,"m")) unit= 60;
+  else if (!strcmp(ep,"h")) unit= 3600;
+  else if (!strcmp(ep,"d")) unit= 86400;
+  else badusage("bad units %s for time/duration value for %s",ep,o->long);
+
+  v *= unit;
+  v= ceil(v);
+  if (v > INT_MAX) badusage("time/duration value for %s out of range",o->long);
+  *store= v;
+}
+
+void op_periods_rndup(const Option *o, const char *val) {
+  int *store= o->store;
+  op_seconds(o,val);
+  *store += PERIOD_SECONDS-1;
+  *store /= PERIOD_SECONDS;
+}
+
+void op_periods_booltrue(const Option *o, const char *val) {
+  int *store= o->store;
+  *store= 1;
+}
+void op_periods_boolfalse(const Option *o, const char *val) {
+  int *store= o->store;
+  *store= 0;
+}
+
+static const Option options[]= {
+{ 0, "max-connections",       &max_connections           op_integer          },
+{ 0, "streaming",             &try_stream,               op_booltrue,  1     },
+{ 0, "no-streaming",          &try_stream,               op_boolfalse, 1     },
+{'h',"host",                  &remote_host,              op_string           },
+{'P',"port",                  &port                      op_integer          },
+{ 0, "inndconf",              &inndconffile,             op_string           },
+{'f',"feedfile",              &feedfile,                 op_string           },
+{'q',"quiet-multiple",        &quiet_if_locked,          op_booltrue,  1     },
+{ 0, "no-quiet-multiple",     &quiet_if_locked,          op_boolfalse, 1     },
+{'d',"daemon",                &become_daemon,            op_booltrue,  1     },
+{ 0, "no-daemon",             &become_daemon,            op_boolfalse, 1     },
+
+{ 0, "no-check-proportion",   &nocheck_thresh_pct,       op_double           },
+{ 0, "no-check-filter",       &nocheck_decay_articles,   op_double           },
+
+{ 0, "max-queue-size",        &max_queue_per_conn        op_integer          },
+{ 0, "reconnect-interval",    &reconnect_delay_periods,  op_periods_rndup    },
+{ 0, "flush-retry-interval",  &flushfail_retry_periods,  op_periods_rndup    },
+{ 0, "feedfile-open-timeout", &open_wait_periods,        op_periods_rndup    },
+{ 0, "connection-timeout",    &connection_timeout,       op_seconds          },
+{ 0, "inndcomm-timeout",      &inndcomm_flush_timeout,   op_seconds          },
+};
+
+int main(int argc, char **argv) {
+  const char *arg;
+  
+  for (;;) {
+    arg= *++argv;
+    if (!arg) break;
+    if (*arg != '-') break;
+    if (!strcmp(arg,"--")) { arg= *++argv; break; }
+    int a;
+    while ((a= *++arg)) {
+      const Option *o;
+      if (a=='-') {
+       arg++;
+       char *equals= strchr(arg,'=');
+       int len= equals ? (equals - arg) : strlen(arg);
+       for (o=options; o->long; o++)
+         if (strlen(o->long) == len && !memcmp(o->long,arg,len))
+           goto found_long;
+       badusage("unknown long option --%s",arg);
+      found_long:
+       if (o->noarg) {
+         if (equals) badusage("option --%s does not take a value",o->long);
+         arg= 0;
+       } else if (equals) {
+         arg= equals+1;
+       } else {
+         arg= *++argv;
+         if (!arg) badusage("option --%s needs a value",o->long);
+       }
+       o->fn(o, arg);
+       break; /* eaten the whole argument now */
+      }
+      for (o=options; o->long; o++)
+       if (a == o->short)
+         goto found_short;
+      badusage("unknown short option -%c",a);
+    found_short:
+      if (o->noarg) {
+       o->fn(o,0);
+      } else {
+       if (!*++arg) {
+         arg= *++argv;
+         if (!arg) badusage("option -%c needs a value",o->short);
+       }
+       o->fn(o,arg);
+       break; /* eaten the whole argument now */
+      }
+    }
+  }
+
+  if (!arg) badusage("need site name argument");
+  if (*++argv) badusage("too many non-option arguments");
+  sitename= arg;
+
+  if (nocheck_thresh_pct < 0 || nocheck_thresh_pct > 100)
+    badusage("nocheck threshold percentage must be between 0..100");
+  nocheck_thresh= nocheck_thresh_pct * 0.01;
+
+  if (nocheck_decay_articles < 0.1)
+    badusage("nocheck decay articles must be at least 0.1");
+  nocheck_decay= 1 - 1/nocheck_decay_articles;
+  
+  innconf_read(inndconffile);
+
+  if (!feedfile)
+    feedfile= xasprintf("%s/%s",pathoutgoing,sitename);
+  else if (!feedfile[0])
+    badusage("feed filename must be nonempty");
+  else if (feedfile[strlen(feedfile)-1]=='/')
+    feedfile= xasprintf("%s%s",feedfile,sitename);
+  
   if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
     sysdie("could not ignore SIGPIPE");
-  if (!filemon_init())
+
+  if (become_daemon) {
+    for (i=3; i<255; i++)
+      /* do this now before we open syslog, etc. */
+      close(i);
+    openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
+
+    int null= open("/dev/null",O_RDWR);
+    if (null<0) sysdie("failed to open /dev/null");
+    dup2(null,0);
+    dup2(null,1);
+    dup2(null,2);
+    close(null);
+    
+    pid_t child1= xfork("daemonise first fork");
+    if (child1) _exit(0);
+
+    pid_t sid= setsid();
+    if (sid != child1) sysdie("setsid failed");
+
+    pid_t child2= xfork("daemonise second fork");
+    if (child2) _exit(0);
+  }
+
+  notice("starting");
+
+  if (!filemon_init()) {
+    warn("no file monitoring available, polling");
     filepoll_schedule();
+  }
+
   period_schedule();
-};
+
+  statemc_init();
+
+  loop->execute.
+}