chiark / gitweb /
Don't make scary messages just because one key didn't work on a message:
[tripe] / admin.c
diff --git a/admin.c b/admin.c
index 508976f21802652a52191c44c8c1971def0bbd05..c1c2c128aa84b475744be3441fa5d2b64eaf705c 100644 (file)
--- a/admin.c
+++ b/admin.c
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: admin.c,v 1.1 2001/02/03 20:26:37 mdw Exp $
+ * $Id: admin.c,v 1.8 2003/04/06 10:25:17 mdw Exp $
  *
  * Admin interface for configuration
  *
 /*----- Revision history --------------------------------------------------* 
  *
  * $Log: admin.c,v $
+ * Revision 1.8  2003/04/06 10:25:17  mdw
+ * Support Linux TUN/TAP device.  Fix some bugs.
+ *
+ * Revision 1.7  2002/01/13 14:57:33  mdw
+ * Track @lbuf@ and @dstr_vputf@ changes in mLib.
+ *
+ * Revision 1.6  2001/02/19 19:11:09  mdw
+ * Output buffering on admin connections.
+ *
+ * Revision 1.5  2001/02/16 21:22:51  mdw
+ * Support for displaying statistics.  Make client connections blocking, so
+ * that things don't get dropped.  (This might change again if I add
+ * buffering.)
+ *
+ * Revision 1.4  2001/02/06 09:34:53  mdw
+ * Change ERR response to FAIL for consistency with other programs.
+ *
+ * Revision 1.3  2001/02/04 01:17:12  mdw
+ * The `DAEMON' notification to stdout is replaced by a warning.  The
+ * `DAEMON' and `QUIT' command send `OK' on successful completion.  Put
+ * assignment of sequence number in a T(...) guard.
+ *
+ * Revision 1.2  2001/02/03 22:40:29  mdw
+ * Put timer information into the entropy pool when packets are received
+ * and on similar events.  Reseed the generator on the interval timer.
+ *
  * Revision 1.1  2001/02/03 20:26:37  mdw
  * Initial checkin.
  *
@@ -72,6 +98,144 @@ static sig s_term, s_int, s_hup;
 
 #define T_RESOLVE SEC(30)
 
+static void a_destroy(admin */*a*/);
+static void a_lock(admin */*a*/);
+static void a_unlock(admin */*a*/);
+
+/*----- Output functions --------------------------------------------------*/
+
+/* --- @trywrite@ --- *
+ *
+ * Arguments:  @admin *a@ = pointer to an admin block
+ *             @const char *p@ = pointer to buffer to write
+ *             @size_t sz@ = size of data to write
+ *
+ * Returns:    The number of bytes written, or less than zero on error.
+ *
+ * Use:                Attempts to write data to a client.
+ */
+
+static ssize_t trywrite(admin *a, const char *p, size_t sz)
+{
+  ssize_t n, done = 0;
+
+again:
+  if (!sz)
+    return (done);
+  n = write(a->w.fd, p, sz);
+  if (n > 0) {
+    done += n;
+    p += n;
+    sz -= n;
+    goto again;
+  }
+  if (n < 0) {
+    if (errno == EINTR)
+      goto again;
+    if (errno != EAGAIN && errno != EWOULDBLOCK) {
+      a_destroy(a);
+      a_warn("disconnecting admin client due to write errors: %s",
+            strerror(errno));
+      return (-1);
+    }
+  }
+  return (done);
+}
+
+/* --- @dosend@ --- *
+ *
+ * Arguemnts:  @admin *a@ = pointer to an admin block
+ *             @const char *p@ = pointer to buffer to write
+ *             @size_t sz@ = size of data to write
+ *
+ * Returns:    ---
+ *
+ * Use:                Sends data to an admin client.
+ */
+
+static void dosend(admin *a, const char *p, size_t sz)
+{
+  ssize_t n;
+  obuf *o;
+
+  if (a->f & AF_DEAD)
+    return;
+
+  /* --- Try to send the data immediately --- */
+
+  if (!a->o_head) {
+    if ((n = trywrite(a, p, sz)) < 0)
+      return;
+    p += n;
+    sz -= n;
+    if (!sz)
+      return;
+  }
+       
+  /* --- Fill buffers with the data until it's all gone --- */
+
+  o = a->o_tail;
+  if (!o)
+    sel_addfile(&a->w);
+  else if (o->p_in < o->buf + OBUFSZ)
+    goto noalloc;
+
+  do {
+    o = xmalloc(sizeof(obuf));
+    o->next = 0;
+    o->p_in = o->p_out = o->buf;
+    if (a->o_tail)
+      a->o_tail->next = o;
+    else
+      a->o_head = o;
+    a->o_tail = o;
+
+  noalloc:
+    n = o->buf + OBUFSZ - o->p_in;
+    if (n > sz)
+      n = sz;
+    memcpy(o->p_in, p, n);
+    o->p_in += n;
+    p += n;
+    sz -= n;
+  } while (sz);
+}
+
+/* --- @a_flush@ --- *
+ *
+ * Arguments:  @int fd@ = file descriptor
+ *             @unsigned mode@ = what's happening
+ *             @void *v@ = pointer to my admin block
+ *
+ * Returns:    ---
+ *
+ * Use:                Flushes buffers when a client is ready to read again.
+ */
+
+static void a_flush(int fd, unsigned mode, void *v)
+{
+  admin *a = v;
+  obuf *o, *oo;
+  ssize_t n;
+
+  o = a->o_head;
+  while (o) {
+    if ((n = trywrite(a, o->p_out, o->p_in - o->p_out)) < 0)
+      return;
+    o->p_out += n;
+    if (o->p_in < o->p_out)
+      break;
+    oo = o;
+    o = o->next;
+    xfree(oo);
+  }
+  a->o_head = o;
+  if (!o) {
+    a->o_tail = 0;
+    sel_rmfile(&a->w);
+  }
+}
+
 /*----- Utility functions -------------------------------------------------*/
 
 /* --- @a_write@ --- *
@@ -90,9 +254,9 @@ static void a_write(admin *a, const char *fmt, ...)
   va_list ap;
   dstr d = DSTR_INIT;
   va_start(ap, fmt);
-  dstr_vputf(&d, fmt, ap);
+  dstr_vputf(&d, fmt, &ap);
   va_end(ap);
-  write(a->fd, d.buf, d.len);
+  dosend(a, d.buf, d.len);
   dstr_destroy(&d);
 }
 
@@ -109,20 +273,22 @@ static void a_write(admin *a, const char *fmt, ...)
 void a_warn(const char *fmt, ...)
 {
   va_list ap;
-  admin *a;
+  admin *a, *aa;
   dstr d = DSTR_INIT;
 
   if (flags & F_INIT)
     dstr_puts(&d, "WARN ");
   va_start(ap, fmt);
-  dstr_vputf(&d, fmt, ap);
+  dstr_vputf(&d, fmt, &ap);
   va_end(ap);
   if (!(flags & F_INIT))
     moan("%s", d.buf);
   else {
     dstr_putc(&d, '\n');
-    for (a = admins; a; a = a->next)
-      write(a->fd, d.buf, d.len);
+    for (a = admins; a; a = aa) {
+      aa = a->next;
+      dosend(a, d.buf, d.len);
+    }
   }
   dstr_destroy(&d);
 }
@@ -142,13 +308,15 @@ void a_warn(const char *fmt, ...)
 static void a_trace(const char *p, size_t sz, void *v)
 {
   dstr d = DSTR_INIT;
-  admin *a;
+  admin *a, *aa;
 
   dstr_puts(&d, "TRACE ");
   dstr_putm(&d, p, sz);
   dstr_putc(&d, '\n');
-  for (a = admins; a; a = a->next)
-    write(a->fd, d.buf, d.len);
+  for (a = admins; a; a = aa) {
+    aa = a->next;
+    dosend(a, d.buf, d.len);
+  }
   dstr_destroy(&d);  
 }
 #endif
@@ -226,16 +394,19 @@ static void a_sighup(int sig, void *v)
 static void a_resolve(struct hostent *h, void *v)
 {
   admin *a = v;
+
+  a_lock(a);
   T( trace(T_ADMIN, "admin: %u resolved", a->seq); )
+  TIMER;
   sel_rmtimer(&a->t);
   if (!h)
-    a_write(a, "ERR couldn't resolve hostname `%s'\n", a->paddr);
+    a_write(a, "FAIL couldn't resolve hostname `%s'\n", a->paddr);
   else if (p_find(a->pname))
-    a_write(a, "ERR peer `%s' already registered\n", a->pname);
+    a_write(a, "FAIL peer `%s' already registered\n", a->pname);
   else {
     memcpy(&a->peer.sin.sin_addr, h->h_addr, sizeof(struct in_addr));
     if (!p_create(a->pname, &a->peer.sa, a->sasz))
-      a_write(a, "ERR couldn't create peer\n");
+      a_write(a, "FAIL couldn't create peer\n");
     else
       a_write(a, "OK\n");
   }
@@ -243,6 +414,7 @@ static void a_resolve(struct hostent *h, void *v)
   xfree(a->paddr);
   a->pname = 0;
   selbuf_enable(&a->b);
+  a_unlock(a);
 }
 
 /* --- @a_timer@ --- *
@@ -258,13 +430,16 @@ static void a_resolve(struct hostent *h, void *v)
 static void a_timer(struct timeval *tv, void *v)
 {
   admin *a = v;
+
+  a_lock(a);
   T( trace(T_ADMIN, "admin: %u resolver timeout", a->seq); )
   bres_abort(&a->r);
-  a_write(a, "ERR timeout resolving `%s'\n", a->paddr);
+  a_write(a, "FAIL timeout resolving `%s'\n", a->paddr);
   xfree(a->pname);
   xfree(a->paddr);
   a->pname = 0;
   selbuf_enable(&a->b);
+  a_unlock(a);
 }
 
 /* --- @acmd_add@ --- *
@@ -287,7 +462,7 @@ static void acmd_add(admin *a, unsigned ac, char *av[])
   /* --- Make sure someone's not got there already --- */
 
   if (p_find(av[0])) {
-    a_write(a, "ERR peer `%s' already registered\n", av[0]);
+    a_write(a, "FAIL peer `%s' already registered\n", av[0]);
     return;
   }
 
@@ -300,13 +475,13 @@ static void acmd_add(admin *a, unsigned ac, char *av[])
   if (*p) {
     struct servent *s = getservbyname(av[2], "udp");
     if (!s) {
-      a_write(a, "ERR service `%s' not known\n", av[2]);
+      a_write(a, "FAIL service `%s' not known\n", av[2]);
       return;
     }
     pt = ntohs(s->s_port);
   }
   if (pt == 0 || pt >= 65536) {
-    a_write(a, "ERR bad port number %lu\n", pt);
+    a_write(a, "FAIL bad port number %lu\n", pt);
     return;
   }
   a->peer.sin.sin_port = htons(pt);
@@ -315,7 +490,7 @@ static void acmd_add(admin *a, unsigned ac, char *av[])
   
   if (inet_aton(av[1], &a->peer.sin.sin_addr)) {
     if (!p_create(av[0], &a->peer.sa, a->sasz))
-      a_write(a, "ERR couldn't create peer\n");
+      a_write(a, "FAIL couldn't create peer\n");
     else
       a_write(a, "OK\n");
     return;
@@ -372,7 +547,7 @@ static void acmd_trace(admin *a, unsigned ac, char *av[])
              goto tropt_ok;
            }
          }
-         a_write(a, "ERR unknown trace option `%c'\n", *p);
+         a_write(a, "FAIL unknown trace option `%c'\n", *p);
          return;
         tropt_ok:;
          break;
@@ -392,21 +567,20 @@ static void acmd_port(admin *a, unsigned ac, char *av[])
   a_write(a, "INFO %u\nOK\n", p_port());
 }
 
-static void a_destroy(admin */*a*/);
-
 static void acmd_daemon(admin *a, unsigned ac, char *av[])
 {
   if (flags & F_DAEMON)
-    a_write(a, "ERR already running as a daemon\n");
+    a_write(a, "FAIL already running as a daemon\n");
   else {
-    if (a_stdin) {
-      a_write(a_stdin, "WARN becoming a daemon\n");
+    a_warn("becoming a daemon");
+    if (a_stdin)
       a_destroy(a_stdin);
-    }
     if (u_daemon())
-      a_write(a, "ERR error becoming a daemon: %s", strerror(errno));
-    else
+      a_write(a, "FAIL error becoming a daemon: %s", strerror(errno));
+    else {
       flags |= F_DAEMON;
+      a_write(a, "OK\n");
+    }
   }
 }
 
@@ -423,7 +597,7 @@ static void acmd_ifname(admin *a, unsigned ac, char *av[])
   peer *p;
 
   if ((p = p_find(av[0])) == 0)
-    a_write(a, "ERR peer `%s' not found\n", av[0]);
+    a_write(a, "FAIL peer `%s' not found\n", av[0]);
   else
     a_write(a, "INFO %s\nOK\n", p_ifname(p));
 }
@@ -434,7 +608,7 @@ static void acmd_addr(admin *a, unsigned ac, char *av[])
   const addr *ad;
 
   if ((p = p_find(av[0])) == 0)
-    a_write(a, "ERR peer `%s' not found\n", av[0]);
+    a_write(a, "FAIL peer `%s' not found\n", av[0]);
   else {
     ad = p_addr(p);
     assert(ad->sa.sa_family == AF_INET);
@@ -444,11 +618,38 @@ static void acmd_addr(admin *a, unsigned ac, char *av[])
   }
 }
 
+static void acmd_stats(admin *a, unsigned ac, char *av[])
+{
+  peer *p;
+  stats *st;
+
+  if ((p = p_find(av[0])) == 0)
+    a_write(a, "FAIL peer `%s' not found\n", av[0]);
+  else {
+    st = p_stats(p);
+    a_write(a, "INFO start-time=%s\n", timestr(st->t_start));
+    a_write(a, "INFO last-packet-time=%s\n", timestr(st->t_last));
+    a_write(a, "INFO packets-in=%lu bytes-in=%lu\n", st->n_in, st->sz_in);
+    a_write(a, "INFO packets-out=%lu bytes-out=%lu\n",
+           st->n_out, st->sz_out);
+    a_write(a, "INFO keyexch-packets-in=%lu keyexch-bytes-in=%lu\n",
+           st->n_kxin, st->sz_kxin);
+    a_write(a, "INFO keyexch-packets-out=%lu keyexch-bytes-out=%lu\n",
+           st->n_kxout, st->sz_kxout);
+    a_write(a, "INFO ip-packets-in=%lu ip-bytes-in=%lu\n",
+           st->n_ipin, st->sz_ipin);
+    a_write(a, "INFO ip-packets-out=%lu ip-bytes-out=%lu\n",
+           st->n_ipout, st->sz_ipout);
+    a_write(a, "INFO rejected-packets=%lu\n", st->n_reject);
+    a_write(a, "OK\n");
+  }
+}
+
 static void acmd_kill(admin *a, unsigned ac, char *av[])
 {
   peer *p;
   if ((p = p_find(av[0])) == 0)
-    a_write(a, "ERR peer `%s' not found\n", av[0]);
+    a_write(a, "FAIL peer `%s' not found\n", av[0]);
   else {
     p_destroy(p);
     a_write(a, "OK\n");
@@ -458,6 +659,7 @@ static void acmd_kill(admin *a, unsigned ac, char *av[])
 static void acmd_quit(admin *a, unsigned ac, char *av[])
 {
   a_warn("closing down on admin request");
+  a_write(a, "OK\n");
   a_quit();
 }
 
@@ -482,6 +684,7 @@ static const acmd acmdtab[] = {
   { "list",    "LIST",                 0,      0,      acmd_list },
   { "ifname",  "IFNAME peer",          1,      1,      acmd_ifname },
   { "addr",    "ADDR peer",            1,      1,      acmd_addr },
+  { "stats",   "STATS peer",           1,      1,      acmd_stats },
   { "kill",    "KILL peer",            1,      1,      acmd_kill },
   { "add",     "ADD peer addr port",   3,      3,      acmd_add },
   { "quit",    "QUIT",                 0,      0,      acmd_quit },
@@ -498,42 +701,109 @@ static void acmd_help(admin *a, unsigned ac, char *av[])
 
 /*----- Connection handling -----------------------------------------------*/
 
-/* --- @a_destroy@ --- *
+/* --- @a_lock@ --- *
  *
  * Arguments:  @admin *a@ = pointer to an admin block
  *
  * Returns:    ---
  *
- * Use:                Destroys an admin block.
+ * Use:                Locks an admin block so that it won't be destroyed
+ *             immediately.
  */
 
-static void a_destroy(admin *a)
+static void a_lock(admin *a) { assert(!(a->f & AF_LOCK)); a->f |= AF_LOCK; }
+
+/* --- @a_unlock@ --- *
+ *
+ * Arguments:  @admin *a@ = pointer to an admin block
+ *
+ * Returns:    ---
+ *
+ * Use:                Unlocks an admin block, allowing its destruction.  This is
+ *             also the second half of @a_destroy@.
+ */
+
+static void a_unlock(admin *a)
 {
-  T( trace(T_ADMIN, "admin: destroying connection %u", a->seq); )
+  assert(a->f & AF_LOCK);
+  if (!(a->f & AF_DEAD)) {
+    a->f &= ~AF_LOCK;
+    return;
+  }
+
+  T( trace(T_ADMIN, "admin: completing destruction of connection %u",
+          a->seq); )
+
   selbuf_destroy(&a->b);
-  if (a->b.reader.fd != a->fd)
-    close(a->b.reader.fd);
-  close(a->fd);
   if (a->pname) {
     xfree(a->pname);
     xfree(a->paddr);
     bres_abort(&a->r);
     sel_rmtimer(&a->t);
   }
+  if (a->b.reader.fd != a->w.fd)
+    close(a->b.reader.fd);
+  close(a->w.fd);
+
+  if (a_stdin == a)
+    a_stdin = 0;
   if (a->next)
     a->next->prev = a->prev;
   if (a->prev)
     a->prev->next = a->next;
   else
     admins = a->next;
-  if (a_stdin == a)
-    a_stdin = 0;
   DESTROY(a);
 }
 
+/* --- @a_destroy@ --- *
+ *
+ * Arguments:  @admin *a@ = pointer to an admin block
+ *
+ * Returns:    ---
+ *
+ * Use:                Destroys an admin block.  This requires a certain amount of
+ *             care.
+ */
+
+static void a_destroy(admin *a)
+{
+  /* --- Don't multiply destroy admin blocks --- */
+
+  if (a->f & AF_DEAD)
+    return;
+
+  /* --- Make sure nobody expects it to work --- */
+
+  a->f |= AF_DEAD;
+  T( trace(T_ADMIN, "admin: destroying connection %u", a->seq); )
+
+  /* --- Free the output buffers --- */
+
+  if (a->o_head) {
+    obuf *o, *oo;
+    sel_rmfile(&a->w);
+    for (o = a->o_head; o; o = oo) {
+      oo = o->next;
+      xfree(o);
+    }
+    a->o_head = 0;
+  }
+
+  /* --- If the block is locked, that's all we can manage --- */
+
+  if (a->f & AF_LOCK) {
+    T( trace(T_ADMIN, "admin: deferring destruction..."); )
+    return;
+  }
+  a->f |= AF_LOCK;
+  a_unlock(a);
+}
+
 /* --- @a_line@ --- *
  *
  * Arguments:  @char *p@ = pointer to the line read
+ *             @size_t len@ = length of the line
  *             @void *vp@ = pointer to my admin block
  *
  * Returns:    ---
@@ -541,13 +811,16 @@ static void a_destroy(admin *a)
  * Use:                Handles a line of input.
  */
 
-static void a_line(char *p, void *vp)
+static void a_line(char *p, size_t len, void *vp)
 {
   admin *a = vp;
   const acmd *c;
   char *av[4];
   size_t ac;
 
+  TIMER;
+  if (a->f & AF_DEAD)
+    return;
   if (!p) {
     a_destroy(a);
     return;
@@ -560,13 +833,16 @@ static void a_line(char *p, void *vp)
     if (strcmp(av[0], c->name) == 0) {
       ac--;
       if (c->argmin > ac || ac > c->argmax)
-       a_write(a, "ERR syntax: %s\n", c->help);
-      else
+       a_write(a, "FAIL syntax: %s\n", c->help);
+      else {
+       a_lock(a);
        c->func(a, ac, av + 1);
+       a_unlock(a);
+      }
       return;
     }
   }
-  a_write(a, "ERR unknown command `%s'\n", av[0]);
+  a_write(a, "FAIL unknown command `%s'\n", av[0]);
 }
 
 /* --- @a_create@ --- *
@@ -581,17 +857,20 @@ static void a_line(char *p, void *vp)
 void a_create(int fd_in, int fd_out)
 {
   admin *a = CREATE(admin);
-  T( static unsigned seq = 0; )
-  a->seq = seq++;
+  T( static unsigned seq = 0;
+     a->seq = seq++; )
   T( trace(T_ADMIN, "admin: accepted connection %u", a->seq); )
   a->pname = 0;
+  a->f = 0;
   if (fd_in == STDIN_FILENO)
     a_stdin = a;
   fdflags(fd_in, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
   if (fd_out != fd_in)
     fdflags(fd_out, O_NONBLOCK, O_NONBLOCK, FD_CLOEXEC, FD_CLOEXEC);
-  a->fd = fd_out;
   selbuf_init(&a->b, &sel, fd_in, a_line, a);
+  sel_initfile(&sel, &a->w, fd_out, SEL_WRITE, a_flush, a);
+  a->o_head = 0;
+  a->o_tail = 0;
   a->next = admins;
   a->prev = 0;
   if (admins)
@@ -692,7 +971,7 @@ again:
     }
     if (!S_ISSOCK(st.st_mode))
       die(EXIT_FAILURE, "object `%s' isn't a socket", sun.sun_path);
-    T( trace(T_ADMIN, "stale socket found; removing it"); )
+    T( trace(T_ADMIN, "admin: stale socket found; removing it"); )
     unlink(sun.sun_path);
     close(fd);
     goto again;