chiark / gitweb /
Backgrounded commands and RELOAD.
[tripe] / tripe.h
diff --git a/tripe.h b/tripe.h
index 9cf7abf3103705250669f86f9b68d1346acb5b7e..a358fb91c1d2a908e4f6d3d40f6a30219e7fb337 100644 (file)
--- a/tripe.h
+++ b/tripe.h
@@ -80,6 +80,7 @@
 #include <mLib/str.h>
 #include <mLib/sub.h>
 #include <mLib/trace.h>
+#include <mLib/tv.h>
 
 #include <catacomb/buf.h>
 
@@ -292,18 +293,45 @@ typedef struct stats {
  * The main structure which glues everything else together.
  */
 
+typedef struct peerspec {
+  char *name;                          /* Peer's name */
+  const tunnel_ops *tops;              /* Tunnel operations */
+  unsigned long t_ka;                  /* Keep alive interval */
+  addr sa;                             /* Socket address to speak to */
+  size_t sasz;                         /* Socket address size */
+} peerspec;
+
 typedef struct peer {
   struct peer *next, *prev;            /* Links to next and previous */
-  char *name;                          /* Name of this peer */
+  struct ping *pings;                  /* Pings we're waiting for */
+  peerspec spec;                       /* Specifications for this peer */
   tunnel *t;                           /* Tunnel for local packets */
   keyset *ks;                          /* List head for keysets */
   buf b;                               /* Buffer for sending packets */
-  addr peer;                           /* Peer socket address */
-  size_t sasz;                         /* Socket address size */
   stats st;                            /* Statistics */
   keyexch kx;                          /* Key exchange protocol block */
+  sel_timer tka;                       /* Timer for keepalives */
 } peer;
 
+typedef struct ping {
+  struct ping *next, *prev;            /* Links to next and previous */
+  peer *p;                             /* Peer so we can free it */
+  unsigned msg;                                /* Kind of response expected */
+  uint32 id;                           /* Id so we can recognize response */
+  octet magic[32];                     /* Some random data */
+  sel_timer t;                         /* Timeout for ping */
+  void (*func)(int /*rc*/, void */*arg*/); /* Function to call when done */
+  void *arg;                           /* Argument for callback */
+} ping;
+
+enum {
+  PING_NONOTIFY = -1,
+  PING_OK = 0,
+  PING_TIMEOUT,
+  PING_PEERDIED,
+  PING_MAX
+};
+
 /* --- Admin structure --- */
 
 #define OBUFSZ 16384u
@@ -314,31 +342,54 @@ typedef struct obuf {
   char buf[OBUFSZ];                    /* The actual buffer */
 } obuf;
 
+typedef struct oqueue {
+  obuf *hd, *tl;                       /* Head and tail pointers */
+} oqueue;
+
+struct admin;
+
+typedef struct admin_bgop {
+  struct admin_bgop *next, *prev;      /* Links to next and previous */
+  struct admin *a;                     /* Owner job */
+  char *tag;                           /* Tag string for messages */
+  void (*cancel)(struct admin_bgop *); /* Destructor function */
+} admin_bgop;
+
+typedef struct admin_addop {
+  admin_bgop bg;                       /* Background operation header */
+  peerspec peer;                       /* Peer pending creation */
+  char *paddr;                         /* Hostname to be resolved */
+  bres_client r;                       /* Background resolver task */
+  sel_timer t;                         /* Timer for resolver */
+} admin_addop;
+
+typedef struct admin_pingop {
+  admin_bgop bg;                       /* Background operation header */
+  ping ping;                           /* Ping pending response */
+  struct timeval pingtime;             /* Time last ping was sent */
+} admin_pingop;  
+
 typedef struct admin {
   struct admin *next, *prev;           /* Links to next and previous */
   unsigned f;                          /* Various useful flags */
 #ifndef NTRACE
   unsigned seq;                                /* Sequence number for tracing */
 #endif
-  char *pname;                         /* Peer name to create */
-  char *paddr;                         /* Address string to resolve */
-  obuf *o_head, *o_tail;               /* Output buffer list */
+  oqueue out;                          /* Output buffer list */
+  oqueue delay;                                /* Delayed output buffer list */
+  admin_bgop *bg;                      /* Backgrounded operations */
   selbuf b;                            /* Line buffer for commands */
   sel_file w;                          /* Selector for write buffering */
-  bres_client r;                       /* Background resolver task */
-  sel_timer t;                         /* Timer for resolver */
-  const tunnel_ops *tops;              /* Tunnel to use */
-  addr peer;                           /* Address to set */
-  size_t sasz;                         /* Size of the address */
 } admin;
 
 #define AF_DEAD 1u                     /* Destroy this admin block */
 #define AF_LOCK 2u                     /* Don't destroy it yet */
 #define AF_NOTE 4u                     /* Catch notifications */
+#define AF_WARN 8u                     /* Catch warning messages */
 #ifndef NTRACE
-  #define AF_TRACE 8u                  /* Catch tracing */
+  #define AF_TRACE 16u                 /* Catch tracing */
 #endif
-#define AF_WARN 16u                    /* Catch warning messages */
+#define AF_CLOSE 32u                   /* Client closed connection */
 
 #ifndef NTRACE
 #  define AF_ALLMSGS (AF_NOTE | AF_TRACE | AF_WARN)
@@ -366,16 +417,16 @@ extern unsigned tr_flags;         /* Trace options flags */
 
 /*----- Key management ----------------------------------------------------*/
 
-/* --- @km_interval@ --- *
+/* --- @km_reload@ --- *
  *
  * Arguments:  ---
  *
  * Returns:    Zero if OK, nonzero to force reloading of keys.
  *
- * Use:                Called on the interval timer to perform various useful jobs.
+ * Use:                Checks the keyrings to see if they need reloading.
  */
 
-extern int km_interval(void);
+extern int km_reload(void);
 
 /* --- @km_init@ --- *
  *
@@ -410,6 +461,7 @@ extern int km_getpubkey(const char */*tag*/, ge */*kpub*/,
 /* --- @kx_start@ --- *
  *
  * Arguments:  @keyexch *kx@ = pointer to key exchange context
+ *             @int forcep@ = nonzero to ignore the quiet timer
  *
  * Returns:    ---
  *
@@ -418,7 +470,7 @@ extern int km_getpubkey(const char */*tag*/, ge */*kpub*/,
  *             this); if no exchange is in progress, one is commenced.
  */
 
-extern void kx_start(keyexch */*kx*/);
+extern void kx_start(keyexch */*kx*/, int /*forcep*/);
 
 /* --- @kx_message@ --- *
  *
@@ -736,6 +788,37 @@ extern buf *p_txstart(peer */*p*/, unsigned /*msg*/);
 
 extern void p_txend(peer */*p*/);
 
+/* --- @p_pingsend@ --- *
+ *
+ * Arguments:  @peer *p@ = destination peer
+ *             @ping *pg@ = structure to fill in
+ *             @unsigned type@ = message type
+ *             @unsigned long timeout@ = how long to wait before giving up
+ *             @void (*func)(int, void *)@ = callback function
+ *             @void *arg@ = argument for callback
+ *
+ * Returns:    Zero if successful, nonzero if it failed.
+ *
+ * Use:                Sends a ping to a peer.  Call @func@ with a nonzero argument
+ *             if we get an answer within the timeout, or zero if no answer.
+ */
+
+extern int p_pingsend(peer */*p*/, ping */*pg*/, unsigned /*type*/,
+                     unsigned long /*timeout*/,
+                     void (*/*func*/)(int, void *), void */*arg*/);
+
+/* --- @p_pingdone@ --- *
+ *
+ * Arguments:  @ping *p@ = ping structure
+ *             @int rc@ = return code to pass on
+ *
+ * Returns:    ---
+ *
+ * Use:                Disposes of a ping structure, maybe sending a notification.
+ */
+
+extern void p_pingdone(ping */*p*/, int /*rc*/);
+
 /* --- @p_tun@ --- *
  *
  * Arguments:  @peer *p@ = pointer to peer block
@@ -748,6 +831,17 @@ extern void p_txend(peer */*p*/);
 
 extern void p_tun(peer */*p*/, buf */*b*/);
 
+/* --- @p_keyreload@ --- *
+ *
+ * Arguments:  ---
+ *
+ * Returns:    ---
+ *
+ * Use:                Forces a check of the daemon's keyring files.
+ */
+
+extern void p_keyreload(void);
+
 /* --- @p_interval@ --- *
  *
  * Arguments:  ---
@@ -809,10 +903,7 @@ unsigned p_port(void);
 
 /* --- @p_create@ --- *
  *
- * Arguments:  @const char *name@ = name for this peer
- *             @const tunnel_ops *tops@ = tunnel to use
- *             @struct sockaddr *sa@ = socket address of peer
- *             @size_t sz@ = size of socket address
+ * Arguments:  @peerspec *spec@ = information about this peer
  *
  * Returns:    Pointer to the peer block, or null if it failed.
  *
@@ -820,8 +911,7 @@ unsigned p_port(void);
  *             by this point.
  */
 
-extern peer *p_create(const char */*name*/, const tunnel_ops */*tops*/,
-                     struct sockaddr */*sa*/, size_t /*sz*/);
+extern peer *p_create(peerspec */*spec*/);
 
 /* --- @p_name@ --- *
  *