chiark / gitweb /
move some code about; rename check_master_queue to check_assign_articles
[inn-innduct.git] / backends / innduct.c
index 1328d372f8d8390cb822f734a2476f044b1c6404..844583eea0b655aafc323693a26cd031804b4ed7 100644 (file)
@@ -1,8 +1,6 @@
 /*
  * TODO
- *  - check all structs initialised
- *  - check all fd watches properly undone
- *  - check all init functions called
+ *  - xperhaps_close
  *  - actually implement badusage
  *  - options for all options
  *  - manpage
@@ -238,6 +236,7 @@ perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.
 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
 
+#define LIST_INIT(l) ((l).hd, list_new((struct list*)&(l)))
 #define LIST_HEAD(l) ((typeof((l).hd))(list_head((struct list*)&(l))))
 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
@@ -275,12 +274,15 @@ static void *conn_write_some_xmits(Conn *conn);
 
 static void xmit_free(XmitDetails *d);
 
+#define SMS(newstate, periods, why) \
+   (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
 static void statemc_setstate(StateMachineState newsms, int periods,
                             const char *forlog, const char *why);
+
 static void statemc_start_flush(const char *why); /* Normal => Flushing */
 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
 
-static void check_master_queue(void);
+static void check_assign_articles(void);
 static void queue_check_input_done(void);
 
 static void statemc_check_flushing_done(void);
@@ -296,7 +298,6 @@ static void search_backlog_file(void);
 static void inputfile_tailing_start(InputFile *ipf);
 static void inputfile_tailing_stop(InputFile *ipf);
 
-static int filemon_init(void);
 static void filemon_start(InputFile *ipf);
 static void filemon_stop(InputFile *ipf);
 static void filemon_callback(InputFile *ipf);
@@ -391,7 +392,7 @@ struct InputFile {
   oop_readable_call *readable_callback;
   void *readable_callback_user;
 
-  int fd;
+  int fd; /* may be 0, meaning closed */
   Filemon_Perfile *filemon;
 
   oop_read *rd;
@@ -436,7 +437,8 @@ static const char *sms_names[]= {
 
 struct Conn {
   ISNODE(Conn);
-  int fd, max_queue, stream, quitting;
+  int fd; /* may be 0, meaning closed (during construction/destruction) */
+  int max_queue, stream, quitting;
   int since_activity; /* periods */
   ArticleList waiting; /* not yet told peer */
   ArticleList priority; /* peer says send it now */
@@ -447,24 +449,22 @@ struct Conn {
 };
 
 
-/*----- operational variables -----*/
+/*----- general operational variables -----*/
 
+/* main initialises */
 static oop_source *loop;
-
-static int until_connect;
 static ConnList conns;
 static ArticleList queue;
-
 static char *path_lock, *path_flushing, *path_defer, *globpat_backlog;
 
-#define SMS(newstate, periods, why) \
-   (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
-
+/* statemc_init initialises */
 static StateMachineState sms;
 static FILE *defer;
 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
-static int sm_period_counter, until_backlog_nextscan;
+static int sm_period_counter;
 
+/* initialisation to 0 is good */
+static int until_connect, until_backlog_nextscan;
 static double accept_proportion;
 static int nocheck, nocheck_reported;
 
@@ -675,15 +675,114 @@ static int isewouldblock(int errnoval) {
   return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
 }
 
-/*========== making new connections ==========*/
+/*========== management of connections ==========*/
 
 static void conn_dispose(Conn *conn) {
   if (!conn) return;
+  if (conn->fd) {
+    loop->cancel_fd(loop, conn->fd, OOP_WRITE);
+    loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
+  }
   perhaps_close(&conn->fd);
   free(conn);
   until_connect= reconnect_delay_periods;
 }
 
+static void *conn_exception(oop_source *lp, int fd,
+                           oop_event ev, void *conn_v) {
+  Conn *conn= conn_v;
+  unsigned char ch;
+  assert(fd == conn->fd);
+  assert(ev == OOP_EXCEPTION);
+  int r= read(conn->fd, &ch, 1);
+  if (r<0) connfail(conn,"read failed: %s",strerror(errno));
+  else connfail(conn,"exceptional condition on socket (peer sent urgent"
+               " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
+  return OOP_CONTINUE;
+}  
+
+static void vconnfail(Conn *conn, const char *fmt, va_list al) {
+  int requeue[art_MaxState];
+
+  Article *art;
+  while ((art= LIST_REMHEAD(conn->priority))) LIST_ADDTAIL(queue, art);
+  while ((art= LIST_REMHEAD(conn->waiting))) LIST_ADDTAIL(queue, art);
+  while ((art= LIST_REMHEAD(conn->sent))) {
+    requeue[art->state]++;
+    if (art->state==art_Unsolicited) art->state= art_Unchecked;
+    LIST_ADDTAIL(queue,art);
+  }
+
+  int i;
+  XmitDetails *d;
+  for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
+    xmit_free(d);
+
+  char *m= xvasprintf(fmt,al);
+  warn("C%d connection failed (requeueing " RCI_TRIPLE_FMT_BASE "): %s",
+       conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
+  free(m);
+
+  LIST_REMOVE(conns,conn);
+  conn_dispose(conn);
+  check_assign_articles();
+}
+
+static void connfail(Conn *conn, const char *fmt, ...) {
+  va_list al;
+  va_start(al,fmt);
+  vconnfail(conn,fmt,al);
+  va_end(al);
+}
+
+static void check_idle_conns(void) {
+  Conn *conn;
+  for (conn=LIST_HEAD(conns); conn; conn=LIST_NEXT(conn))
+    conn->since_activity++;
+ search_again:
+  for (conn=LIST_HEAD(conns); conn; conn=LIST_NEXT(conn)) {
+    if (conn->since_activity <= need_activity_periods) continue;
+
+    /* We need to shut this down */
+    if (conn->quitting)
+      connfail(conn,"timed out waiting for response to QUIT");
+    else if (conn->sent.count)
+      connfail(conn,"timed out waiting for responses");
+    else if (conn->waiting.count || conn->priority.count)
+      connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
+    else if (conn->xmitu)
+      connfail(conn,"peer has been sending responses"
+              " before receiving our commands!");
+    else {
+      static const char quitcmd[]= "QUIT\r\n";
+      int todo= sizeof(quitcmd)-1;
+      const char *p= quitcmd;
+      for (;;) {
+       int r= write(conn->fd, p, todo);
+       if (r<0) {
+         if (isewouldblock(errno))
+           connfail(conn, "blocked writing QUIT to idle connection");
+         else
+           connfail(conn, "failed to write QUIT to idle connection: %s",
+                    strerror(errno));
+         break;
+       }
+       assert(r<=todo);
+       todo -= r;
+       if (!todo) {
+         conn->quitting= 1;
+         conn->since_activity= 0;
+         debug("C%d is idle, quitting", conn->fd);
+         break;
+       }
+      }
+    }
+    goto search_again;
+  }
+}  
+
+/*---------- making new connections ----------*/
+
 static int connecting_sockets[2]= {-1,-1};
 static pid_t connecting_child;
 
@@ -728,16 +827,18 @@ static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
     if (got != -1) {
       assert(got==connecting_child);
       connecting_child= 0;
-      if (WIFEXITED(status) &&
-         (WEXITSTATUS(status) != 0 &&
-          WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
-          WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)) {
-       /* child already reported the problem */
+      if (WIFEXITED(status)) {
+       if (WEXITSTATUS(status) != 0 &&
+           WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
+           WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
+         /* child already reported the problem */;
+       else
+         warn("connect: connection child exited code %d but no cmsg",
+              WEXITSTATUS(status));
       } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
        warn("connect: connection attempt timed out");
-      } else if (!WIFEXITED(status)) {
+      } else {
        report_child_status("connect", status);
-       /* that's probably the root cause then */
       }
     } else {
       /* child is still running apparently, report the socket problem */
@@ -745,8 +846,10 @@ static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
        syswarn("connect: read from child socket failed");
       else if (e == OOP_EXCEPTION)
        warn("connect: unexpected exception on child socket");
-      else
+      else if (!rs)
        warn("connect: unexpected EOF on child socket");
+      else
+       fatal("connect: unexpected lack of cmsg from child");
     }
     goto x;
   }
@@ -761,9 +864,10 @@ static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
   CHK(len,   CMSG_LEN(sizeof(conn->fd)));
 #undef CHK
 
-  if (CMSG_NXTHDR(&msg,h)) { die("connect: child sent many cmsgs"); goto x; }
+  if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
 
   memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
+  loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
 
   int status;
   pid_t got= waitpid(connecting_child, &status, 0);
@@ -781,12 +885,16 @@ static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
   }
 
   /* Phew! */
+  LIST_INIT(conn->waiting);
+  LIST_INIT(conn->priority);
+  LIST_INIT(conn->sent);
   setnonblock(conn->fd, 1);
   conn->max_queue= conn->stream ? max_queue_per_conn : 1;
-  LIST_ADDHEAD(conns, conn);
   notice("C%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
+  LIST_ADDHEAD(conns, conn);
+
   connect_attempt_discard();
-  check_master_queue();
+  check_assign_articles();
   return 0;
 
  x:
@@ -890,55 +998,9 @@ static void connect_start(void) {
   connect_attempt_discard();
 }
 
-static void check_idle_conns(void) {
-  Conn *conn;
-  for (conn=LIST_HEAD(conns); conn; conn=LIST_NEXT(conn))
-    conn->since_activity++;
- search_again:
-  for (conn=LIST_HEAD(conns); conn; conn=LIST_NEXT(conn)) {
-    if (conn->since_activity <= need_activity_periods) continue;
-
-    /* We need to shut this down */
-    if (conn->quitting)
-      connfail(conn,"timed out waiting for response to QUIT");
-    else if (conn->sent.count)
-      connfail(conn,"timed out waiting for responses");
-    else if (conn->waiting.count || conn->priority.count)
-      connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
-    else if (conn->xmitu)
-      connfail(conn,"peer has been sending responses"
-              " before receiving our commands!");
-    else {
-      static const char quitcmd[]= "QUIT\r\n";
-      int todo= sizeof(quitcmd)-1;
-      const char *p= quitcmd;
-      for (;;) {
-       int r= write(conn->fd, p, todo);
-       if (r<0) {
-         if (isewouldblock(errno))
-           connfail(conn, "blocked writing QUIT to idle connection");
-         else
-           connfail(conn, "failed to write QUIT to idle connection: %s",
-                    strerror(errno));
-         break;
-       }
-       assert(r<=todo);
-       todo -= r;
-       if (!todo) {
-         conn->quitting= 1;
-         conn->since_activity= 0;
-         debug("C%d is idle, quitting", conn->fd);
-         break;
-       }
-      }
-    }
-    goto search_again;
-  }
-}  
-
-/*========== overall control of article flow ==========*/
+/*---------- assigning articles to conns, and transmitting ----------*/
 
-static void check_master_queue(void) {
+static void check_assign_articles(void) {
   for (;;) {
     if (!queue.count)
       break;
@@ -1008,40 +1070,6 @@ static void conn_maybe_write(Conn *conn)  {
   }
 }
 
-static void vconnfail(Conn *conn, const char *fmt, va_list al) {
-  int requeue[art_MaxState];
-
-  Article *art;
-  while ((art= LIST_REMHEAD(conn->priority))) LIST_ADDTAIL(queue, art);
-  while ((art= LIST_REMHEAD(conn->waiting))) LIST_ADDTAIL(queue, art);
-  while ((art= LIST_REMHEAD(conn->sent))) {
-    requeue[art->state]++;
-    if (art->state==art_Unsolicited) art->state= art_Unchecked;
-    LIST_ADDTAIL(queue,art);
-  }
-
-  int i;
-  XmitDetails *d;
-  for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
-    xmit_free(d);
-
-  char *m= xvasprintf(fmt,al);
-  warn("C%d connection failed (requeueing " RCI_TRIPLE_FMT_BASE "): %s",
-       conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
-  free(m);
-
-  LIST_REMOVE(conns,conn);
-  conn_dispose(conn);
-  check_master_queue();
-}
-
-static void connfail(Conn *conn, const char *fmt, ...) {
-  va_list al;
-  va_start(al,fmt);
-  vconnfail(conn,fmt,al);
-  va_end(al);
-}
-
 /*========== article transmission ==========*/
 
 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
@@ -1261,6 +1289,8 @@ static void article_done(Conn *conn, Article *art, int whichcount) {
   else if (whichcount == RC_unwanted) update_nocheck(0);
 
   InputFile *ipf= art->ipf;
+  assert(ipf->fd);
+
   while (art->blanklen) {
     static const char spaces[]=
       "                                                                "
@@ -1281,11 +1311,10 @@ static void article_done(Conn *conn, Article *art, int whichcount) {
 
   ipf->inprogress--;
   assert(ipf->inprogress >= 0);
+  free(art);
 
   if (!ipf->inprogress && ipf != main_input_file)
     queue_check_input_done();
-
-  free(art);
 }
 
 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_event ev,
@@ -1378,7 +1407,7 @@ static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_event ev,
   }
 
   conn_maybe_write(conn);
-  check_master_queue();
+  check_assign_articles();
   return OOP_CONTINUE;
 }
 
@@ -1389,9 +1418,10 @@ static void feedfile_eof(InputFile *ipf) {
   assert(ipf != main_input_file); /* promised by tailing_try_read */
 
   inputfile_tailing_stop(ipf);
-  assert(ipf->fd >= 0);
+  assert(ipf->fd > 0);
+fixme do not close fd do something else because art_done needs it to blank entries;
   if (close(ipf->fd)) sysdie("could not close input file %s", ipf->path);
-  ipf->fd= -1;
+  ipf->fd= 0;
 
   if (ipf == flushing_input_file) {
     assert(sms==sm_SEPARATED || sms==sm_DROPPING);
@@ -1410,6 +1440,7 @@ static InputFile *open_input_file(const char *path) {
     if (errno==ENOENT) return 0;
     sysfatal("unable to open input file %s", path);
   }
+  assert(fd>0);
 
   InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
   memset(ipf,0,sizeof(*ipf));
@@ -1420,14 +1451,16 @@ static InputFile *open_input_file(const char *path) {
   return ipf;
 }
 
-static void close_input_file(InputFile *ipf) {
+static void close_input_file(InputFile *ipf) { /* does not free */
   assert(!ipf->readable_callback); /* must have had ->on_cancel */
   assert(!ipf->filemon); /* must have had inputfile_tailing_stop */
   assert(!ipf->rd); /* must have had inputfile_tailing_stop */
   assert(!ipf->inprogress); /* no dangling pointers pointing here */
 
-  if (ipf->fd >= 0)
+  if (ipf->fd) {
     if (close(ipf->fd)) sysdie("could not close input file %s", ipf->path);
+    ipf->fd= 0;
+  }
 }
 
 
@@ -1507,12 +1540,12 @@ static void *feedfile_got_article(oop_source *lp, oop_read *rd,
   ipf->readcount_ok++;
 
   art= xmalloc(sizeof(*art) - 1 + midlen + 1);
-  art->offset= ipf->offset;
-  art->blanklen= recsz;
-  art->midlen= midlen;
   art->state= art_Unchecked;
+  art->midlen= midlen;
   art->ipf= ipf;  ipf->inprogress++;
   art->token= TextToToken(tokentextbuf);
+  art->offset= ipf->offset;
+  art->blanklen= recsz;
   strcpy(art->messageid, space+1);
   LIST_ADDTAIL(queue, art);
 
@@ -1520,7 +1553,7 @@ static void *feedfile_got_article(oop_source *lp, oop_read *rd,
       ipf->offset >= target_max_feedfile_size)
     statemc_start_flush("feed file size");
 
-  check_master_queue();
+  check_assign_articles();
   return OOP_CONTINUE;
 }
 
@@ -1574,10 +1607,10 @@ static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
        errno=EAGAIN;
        return -1;
       } else if (ipf==flushing_input_file) {
-       assert(ipf->fd>=0);
+       assert(ipf->fd);
        assert(sms==sm_SEPARATED || sms==sm_DROPPING);
       } else if (ipf==backlog_input_file) {
-       assert(ipf->fd>=0);
+       assert(ipf->fd);
       } else {
        abort();
       }
@@ -1708,7 +1741,7 @@ static const oop_rd_style feedfile_rdstyle= {
 };
 
 static void inputfile_tailing_start(InputFile *ipf) {
-  assert(!ipf->fd);
+  assert(!ipf->rd);
   ipf->readable.on_readable= tailing_on_readable;
   ipf->readable.on_cancel=   tailing_on_cancel;
   ipf->readable.try_read=    tailing_try_read;
@@ -1727,7 +1760,7 @@ static void inputfile_tailing_start(InputFile *ipf) {
 }
 
 static void inputfile_tailing_stop(InputFile *ipf) {
-  assert(ipf->fd);
+  assert(ipf->rd);
   oop_rd_cancel(ipf->rd);
   oop_rd_delete(ipf->rd);
   ipf->rd= 0;
@@ -1794,7 +1827,7 @@ static void inputfile_tailing_stop(InputFile *ipf) {
      |          V             |     |              V
      |     =============      V     V                    ============
      |      SEPARATED-1       |     |              DROPPING-1
-     |      flsh->fd>=0       |     |              flsh->fd>=0
+     |      flsh->fd>0        |     |              flsh->fd>0
      |     [Separated]        |     |             [Dropping]
      |      main F idle       |     |              main none
      |      old D tail        |     |              old D tail
@@ -1804,7 +1837,7 @@ static void inputfile_tailing_stop(InputFile *ipf) {
      |          V             |     |               V
      |     ===============    |     |             ===============
      |      SEPARATED-2       |     |              DROPPING-2
-     |      flsh->fd==-1      |     V              flsh->fd==-1
+     |      flsh->fd==0       |     V              flsh->fd==0
      |     [Finishing]        |     |             [Dropping]
      |      main F tail              |     `.             main none
      |      old D closed      |       `.           old D closed
@@ -1976,7 +2009,7 @@ static void statemc_period_poll(void) {
 static int inputfile_is_done(InputFile *ipf) {
   if (!ipf) return 0;
   if (ipf->inprogress) return 0; /* new article in the meantime */
-  if (ipf->fd >= 0); return 0; /* not had EOF */
+  if (ipf->fd) return 0; /* not had EOF */
   return 1;
 }
 
@@ -2078,7 +2111,7 @@ static void statemc_setstate(StateMachineState newsms, int periods,
     if (!main_input_file) xtra= "-ABSENT";
     break;
   case sm_SEPARATED: case sm_DROPPING:
-    xtra= flushing_input_file->fd >= 0 ? "-1" : "-2";
+    xtra= flushing_input_file->fd ? "-1" : "-2";
     break;
   default:;
   }
@@ -2388,9 +2421,8 @@ void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
 
 static void postfork_inputfile(InputFile *ipf) {
   if (!ipf) return;
-  assert(ipf->fd >= 0);
-  close(ipf->fd);
-  ipf->fd= -1;
+  assert(ipf->fd);
+  perhaps_close(&ipf->fd);
 }
 
 static void postfork_stdio(FILE *f) {
@@ -2455,7 +2487,7 @@ EVERY(period, -1,0, {
   poll_backlog_file();
   if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
   statemc_period_poll();
-  check_master_queue();
+  check_assign_articles();
   check_idle_conns();
 });
 
@@ -2690,6 +2722,9 @@ int main(int argc, char **argv) {
 
   notice("starting");
 
+  LIST_INIT(conns);
+  LIST_INIT(queue);
+
   if (!filemon_method_init()) {
     warn("no file monitoring available, polling");
     filepoll_schedule();