handle nat_register fail
[oweals/gnunet.git] / src / nat / nat_test.c
index 8a46a96fab392faf016f3d1e13dc2af07cc8658f..866c15e5e16a1d4006c767a3d74fb3bc4f02b3ce 100644 (file)
@@ -28,6 +28,9 @@
 #include "gnunet_nat_lib.h"
 #include "nat.h"
 
+#define LOG(kind,...) GNUNET_log_from (kind, "nat", __VA_ARGS__)
+
+#define NAT_SERVER_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
 
 /**
  * Entry we keep for each incoming connection.
@@ -99,9 +102,9 @@ struct GNUNET_NAT_Test
    * Function to call with success report
    */
   GNUNET_NAT_TestCallback report;
-  
+
   /**
-   * Closure for 'report'.
+   * Closure for @e report.
    */
   void *report_cls;
 
@@ -159,32 +162,32 @@ struct GNUNET_NAT_Test
 
 
 /**
- * Function called from GNUNET_NAT_register whenever someone asks us
+ * Function called from #GNUNET_NAT_register whenever someone asks us
  * to do connection reversal.
  *
- * @param cls closure, our 'struct GNUNET_NAT_Handle'
+ * @param cls closure, our `struct GNUNET_NAT_Handle`
  * @param addr public IP address of the other peer
  * @param addrlen actual lenght of the address
  */
 static void
-reversal_cb (void *cls, 
-            const struct sockaddr *addr,
-            socklen_t addrlen)
+reversal_cb (void *cls,
+             const struct sockaddr *addr,
+             socklen_t addrlen)
 {
   struct GNUNET_NAT_Test *h = cls;
   const struct sockaddr_in *sa;
 
-  if (addrlen != sizeof (struct sockaddr_in))
+  if (sizeof (struct sockaddr_in) != addrlen)
     return;
   sa = (const struct sockaddr_in *) addr;
   if (h->data != sa->sin_port)
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                 "Received connection reversal request for wrong port\n");
-      return; /* wrong port */
-    }
+  {
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Received connection reversal request for wrong port\n");
+    return;                     /* wrong port */
+  }
   /* report success */
-  h->report (h->report_cls, GNUNET_OK);
+  h->report (h->report_cls, GNUNET_OK, NULL);
 }
 
 
@@ -192,37 +195,34 @@ reversal_cb (void *cls,
  * Activity on our incoming socket.  Read data from the
  * incoming connection.
  *
- * @param cls the 'struct NatActivity'
+ * @param cls the `struct GNUNET_NAT_Test`
  * @param tc scheduler context
  */
 static void
 do_udp_read (void *cls,
-            const struct GNUNET_SCHEDULER_TaskContext *tc)
+             const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GNUNET_NAT_Test *tst = cls;
   uint16_t data;
 
-  tst->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
-                                             tst->lsock,
-                                             &do_udp_read,
-                                             tst);
-  if ( (NULL != tc->write_ready) &&
-       (GNUNET_NETWORK_fdset_isset (tc->read_ready, 
-                                   tst->lsock)) &&
-       (sizeof (data) ==
-       GNUNET_NETWORK_socket_recv (tst->lsock,
-                                   &data,
-                                   sizeof (data))) )
-    {
-      if (data == tst->data)
-       tst->report (tst->report_cls, GNUNET_OK);
-      else
-       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                   "Received data mismatches expected value\n");
-    }
+  tst->ltask =
+      GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
+                                     tst->lsock,
+                                     &do_udp_read, tst);
+  if ((NULL != tc->write_ready) &&
+      (GNUNET_NETWORK_fdset_isset (tc->read_ready, tst->lsock)) &&
+      (sizeof (data) ==
+       GNUNET_NETWORK_socket_recv (tst->lsock, &data, sizeof (data))))
+  {
+    if (data == tst->data)
+      tst->report (tst->report_cls, GNUNET_OK, NULL);
+    else
+      LOG (GNUNET_ERROR_TYPE_DEBUG,
+           "Received data mismatches expected value\n");
+  }
   else
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-               "Failed to receive data from inbound connection\n");
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Failed to receive data from inbound connection\n");
 }
 
 
@@ -230,12 +230,12 @@ do_udp_read (void *cls,
  * Activity on our incoming socket.  Read data from the
  * incoming connection.
  *
- * @param cls the 'struct NatActivity'
+ * @param cls the `struct NatActivity`
  * @param tc scheduler context
  */
 static void
 do_read (void *cls,
-        const struct GNUNET_SCHEDULER_TaskContext *tc)
+         const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct NatActivity *na = cls;
   struct GNUNET_NAT_Test *tst;
@@ -243,26 +243,21 @@ do_read (void *cls,
 
   na->rtask = GNUNET_SCHEDULER_NO_TASK;
   tst = na->h;
-  GNUNET_CONTAINER_DLL_remove (tst->na_head,
-                              tst->na_tail,
-                              na);
-  if ( (NULL != tc->write_ready) &&
-       (GNUNET_NETWORK_fdset_isset (tc->read_ready, 
-                                   na->sock)) &&
-       (sizeof (data) ==
-       GNUNET_NETWORK_socket_recv (na->sock,
-                                   &data,
-                                   sizeof (data))) )
-    {
-      if (data == tst->data)
-       tst->report (tst->report_cls, GNUNET_OK);
-      else
-       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-                   "Received data mismatches expected value\n");
-    }
+  GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, na);
+  if ((NULL != tc->write_ready) &&
+      (GNUNET_NETWORK_fdset_isset (tc->read_ready, na->sock)) &&
+      (sizeof (data) ==
+       GNUNET_NETWORK_socket_recv (na->sock, &data, sizeof (data))))
+  {
+    if (data == tst->data)
+      tst->report (tst->report_cls, GNUNET_OK, NULL);
+    else
+      LOG (GNUNET_ERROR_TYPE_DEBUG,
+           "Received data does not match expected value\n");
+  }
   else
-    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-               "Failed to receive data from inbound connection\n");
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+         "Failed to receive data from inbound connection\n");
   GNUNET_NETWORK_socket_close (na->sock);
   GNUNET_free (na);
 }
@@ -272,12 +267,12 @@ do_read (void *cls,
  * Activity on our listen socket. Accept the
  * incoming connection.
  *
- * @param cls the 'struct GNUNET_NAT_Test'
+ * @param cls the `struct GNUNET_NAT_Test`
  * @param tc scheduler context
  */
 static void
 do_accept (void *cls,
-          const struct GNUNET_SCHEDULER_TaskContext *tc)
+           const struct GNUNET_SCHEDULER_TaskContext *tc)
 {
   struct GNUNET_NAT_Test *tst = cls;
   struct GNUNET_NETWORK_Handle *s;
@@ -285,29 +280,26 @@ do_accept (void *cls,
 
   tst->ltask = GNUNET_SCHEDULER_NO_TASK;
   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
-    return; 
-  tst->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
-                                             tst->lsock,
-                                             &do_accept,
-                                             tst);
+    return;
+  tst->ltask =
+      GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL, tst->lsock,
+                                     &do_accept, tst);
   s = GNUNET_NETWORK_socket_accept (tst->lsock, NULL, NULL);
   if (NULL == s)
-    {
-      GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO, "accept");
-      return; /* odd error */
-    }
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "Got an inbound connection, waiting for data\n");
-  wl = GNUNET_malloc (sizeof (struct NatActivity));
+  {
+    GNUNET_log_strerror (GNUNET_ERROR_TYPE_INFO, "accept");
+    return;                     /* odd error */
+  }
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Got an inbound connection, waiting for data\n");
+  wl = GNUNET_new (struct NatActivity);
   wl->sock = s;
   wl->h = tst;
-  wl->rtask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
-                                            wl->sock,
-                                            &do_read,
-                                            wl);
-  GNUNET_CONTAINER_DLL_insert (tst->na_head,
-                              tst->na_tail,
-                              wl);
+  wl->rtask =
+    GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
+                                   wl->sock,
+                                   &do_read, wl);
+  GNUNET_CONTAINER_DLL_insert (tst->na_head, tst->na_tail, wl);
 }
 
 
@@ -315,16 +307,16 @@ do_accept (void *cls,
  * Address-callback, used to send message to gnunet-nat-server.
  *
  * @param cls closure
- * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean
+ * @param add_remove #GNUNET_YES to mean the new public IP address, #GNUNET_NO to mean
  *     the previous (now invalid) one
  * @param addr either the previous or the new public IP address
- * @param addrlen actual lenght of the address
+ * @param addrlen actual length of the @a addr
  */
-static void 
+static void
 addr_cb (void *cls,
-        int add_remove,
-        const struct sockaddr *addr,
-        socklen_t addrlen)
+         int add_remove,
+         const struct sockaddr *addr,
+         socklen_t addrlen)
 {
   struct GNUNET_NAT_Test *h = cls;
   struct ClientActivity *ca;
@@ -335,37 +327,38 @@ addr_cb (void *cls,
   if (GNUNET_YES != add_remove)
     return;
   if (addrlen != sizeof (struct sockaddr_in))
-    return; /* ignore IPv6 here */
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
-             "Asking gnunet-nat-server to connect to `%s'\n",
-             GNUNET_a2s (addr, addrlen));
-  sa = (const struct sockaddr_in*) addr;
-  msg.header.size = htons (sizeof(struct GNUNET_NAT_TestMessage));
+  {
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+        "NAT test ignores IPv6 address `%s' returned from NAT library\n",
+        GNUNET_a2s (addr, addrlen));
+    return;                     /* ignore IPv6 here */
+  }
+  LOG (GNUNET_ERROR_TYPE_INFO,
+       "Asking gnunet-nat-server to connect to `%s'\n",
+       GNUNET_a2s (addr, addrlen));
+  sa = (const struct sockaddr_in *) addr;
+  msg.header.size = htons (sizeof (struct GNUNET_NAT_TestMessage));
   msg.header.type = htons (GNUNET_MESSAGE_TYPE_NAT_TEST);
   msg.dst_ipv4 = sa->sin_addr.s_addr;
   msg.dport = sa->sin_port;
   msg.data = h->data;
   msg.is_tcp = htonl ((uint32_t) h->is_tcp);
 
-  client = GNUNET_CLIENT_connect ("gnunet-nat-server",
-                                 h->cfg);
+  client = GNUNET_CLIENT_connect ("gnunet-nat-server", h->cfg);
   if (NULL == client)
-    {
-      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                 _("Failed to connect to `gnunet-nat-server'\n"));
-      return;
-    }
-  ca = GNUNET_malloc (sizeof (struct ClientActivity));
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                _("Failed to connect to `gnunet-nat-server'\n"));
+    return;
+  }
+  ca = GNUNET_new (struct ClientActivity);
   ca->client = client;
-  GNUNET_CONTAINER_DLL_insert (h->ca_head,
-                              h->ca_tail,
-                              ca);
+  GNUNET_CONTAINER_DLL_insert (h->ca_head, h->ca_tail, ca);
   GNUNET_break (GNUNET_OK ==
-               GNUNET_CLIENT_transmit_and_get_response (client,
-                                                        &msg.header,
-                                                        GNUNET_TIME_UNIT_SECONDS,
-                                                        GNUNET_YES,
-                                                        NULL, NULL));
+                GNUNET_CLIENT_transmit_and_get_response (client, &msg.header,
+                                                         NAT_SERVER_TIMEOUT,
+                                                         GNUNET_YES, NULL,
+                                                         NULL));
 }
 
 
@@ -374,24 +367,24 @@ addr_cb (void *cls,
  * given configuration (IPv4-only).
  *
  * @param cfg configuration for the NAT traversal
- * @param is_tcp GNUNET_YES to test TCP, GNUNET_NO to test UDP
+ * @param is_tcp #GNUNET_YES to test TCP, #GNUNET_NO to test UDP
  * @param bnd_port port to bind to, 0 for connection reversal
  * @param adv_port externally advertised port to use
  * @param report function to call with the result of the test
- * @param report_cls closure for report
+ * @param report_cls closure for @a report
  * @return handle to cancel NAT test
  */
 struct GNUNET_NAT_Test *
 GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                      int is_tcp,
-                      uint16_t bnd_port,
-                      uint16_t adv_port,
-                      GNUNET_NAT_TestCallback report,
-                      void *report_cls)
+                       int is_tcp,
+                       uint16_t bnd_port,
+                       uint16_t adv_port,
+                       GNUNET_NAT_TestCallback report,
+                       void *report_cls)
 {
   struct GNUNET_NAT_Test *ret;
   struct sockaddr_in sa;
-  const struct sockaddr *addrs[] = { (const struct sockaddr*) &sa };
+  const struct sockaddr *addrs[] = { (const struct sockaddr *) &sa };
   const socklen_t addrlens[] = { sizeof (sa) };
 
   memset (&sa, 0, sizeof (sa));
@@ -400,63 +393,72 @@ GNUNET_NAT_test_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
 #if HAVE_SOCKADDR_IN_SIN_LEN
   sa.sin_len = sizeof (sa);
 #endif
-  
-  ret = GNUNET_malloc (sizeof (struct GNUNET_NAT_Test));
+
+  ret = GNUNET_new (struct GNUNET_NAT_Test);
   ret->cfg = cfg;
   ret->is_tcp = is_tcp;
   ret->data = bnd_port;
   ret->adv_port = adv_port;
   ret->report = report;
   ret->report_cls = report_cls;
-  if (bnd_port == 0)
-    {      
-      ret->nat = GNUNET_NAT_register (cfg, is_tcp,
-                                     0, 
-                                     0, NULL, NULL,
-                                     &addr_cb, &reversal_cb, ret);
-    }
+  if (0 == bnd_port)
+  {
+    ret->nat =
+        GNUNET_NAT_register (cfg, is_tcp, 0, 0, NULL, NULL, &addr_cb,
+                             &reversal_cb, ret);
+  }
   else
+  {
+    ret->lsock =
+        GNUNET_NETWORK_socket_create (AF_INET,
+                                      (is_tcp ==
+                                       GNUNET_YES) ? SOCK_STREAM : SOCK_DGRAM,
+                                      0);
+    if ((ret->lsock == NULL) ||
+        (GNUNET_OK !=
+         GNUNET_NETWORK_socket_bind (ret->lsock, (const struct sockaddr *) &sa,
+                                     sizeof (sa))))
+    {
+      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+                  _("Failed to create listen socket bound to `%s' for NAT test: %s\n"),
+                  GNUNET_a2s ((const struct sockaddr *) &sa, sizeof (sa)),
+                  STRERROR (errno));
+      if (NULL != ret->lsock)
+        GNUNET_NETWORK_socket_close (ret->lsock);
+      GNUNET_free (ret);
+      return NULL;
+    }
+    if (GNUNET_YES == is_tcp)
     {
-      ret->lsock = GNUNET_NETWORK_socket_create (AF_INET, 
-                                                (is_tcp==GNUNET_YES) 
-                                                ? SOCK_STREAM 
-                                                : SOCK_DGRAM, 0);
-      if ( (ret->lsock == NULL) ||
-          (GNUNET_OK != GNUNET_NETWORK_socket_bind (ret->lsock,
-                                                    (const struct sockaddr*) &sa,
-                                                    sizeof (sa))) )
-       {
-         GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
-                     _("Failed to create listen socket bound to `%s' for NAT test: %s\n"),
-                     GNUNET_a2s ((const struct sockaddr*)&sa,
-                                 sizeof(sa)),
-                     STRERROR (errno));
-         if (NULL != ret->lsock)
-           GNUNET_NETWORK_socket_close (ret->lsock);
-         GNUNET_free (ret);
-         return NULL;
-       }
-      if (GNUNET_YES == is_tcp)
-       {
-         GNUNET_break (GNUNET_OK ==
-                       GNUNET_NETWORK_socket_listen (ret->lsock, 5));
-         ret->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
-                                                     ret->lsock,
-                                                     &do_accept,
-                                                     ret);
-       }
-      else
-       {
-         ret->ltask = GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
-                                                    ret->lsock,
-                                                    &do_udp_read,
-                                                    ret);
-       }
-      ret->nat = GNUNET_NAT_register (cfg, is_tcp,
-                                     adv_port, 
-                                     1, addrs, addrlens,
-                                     &addr_cb, NULL, ret);
+      GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_listen (ret->lsock, 5));
+      ret->ltask =
+          GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
+                                         ret->lsock, &do_accept, ret);
     }
+    else
+    {
+      ret->ltask =
+          GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
+                                         ret->lsock, &do_udp_read, ret);
+    }
+    LOG (GNUNET_ERROR_TYPE_DEBUG,
+        "NAT test listens on port %u (%s)\n",
+        bnd_port,
+        (GNUNET_YES == is_tcp) ? "tcp" : "udp");
+    ret->nat = GNUNET_NAT_register (cfg, is_tcp, adv_port, 1, addrs, addrlens,
+                             &addr_cb, NULL, ret);
+    if (NULL == ret->nat)
+    {
+      LOG (GNUNET_ERROR_TYPE_ERROR,
+          _("NAT test failed to start NAT library\n"));
+      if (GNUNET_SCHEDULER_NO_TASK != ret->ltask)
+        GNUNET_SCHEDULER_cancel (ret->ltask);
+      if (NULL != ret->lsock)
+        GNUNET_NETWORK_socket_close (ret->lsock);
+      GNUNET_free (ret);
+      return NULL;
+    }
+  }
   return ret;
 }
 
@@ -472,23 +474,21 @@ GNUNET_NAT_test_stop (struct GNUNET_NAT_Test *tst)
   struct NatActivity *pos;
   struct ClientActivity *cpos;
 
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "Stopping NAT test\n");
   while (NULL != (cpos = tst->ca_head))
-    {
-      GNUNET_CONTAINER_DLL_remove (tst->ca_head,
-                                  tst->ca_tail,
-                                  cpos);
-      GNUNET_CLIENT_disconnect (cpos->client, GNUNET_NO);  
-      GNUNET_free (cpos);
-    }
+  {
+    GNUNET_CONTAINER_DLL_remove (tst->ca_head, tst->ca_tail, cpos);
+    GNUNET_CLIENT_disconnect (cpos->client);
+    GNUNET_free (cpos);
+  }
   while (NULL != (pos = tst->na_head))
-    {
-      GNUNET_CONTAINER_DLL_remove (tst->na_head,
-                                  tst->na_tail,
-                                  pos);
-      GNUNET_SCHEDULER_cancel (pos->rtask);
-      GNUNET_NETWORK_socket_close (pos->sock);
-      GNUNET_free (pos);
-    }
+  {
+    GNUNET_CONTAINER_DLL_remove (tst->na_head, tst->na_tail, pos);
+    GNUNET_SCHEDULER_cancel (pos->rtask);
+    GNUNET_NETWORK_socket_close (pos->sock);
+    GNUNET_free (pos);
+  }
   if (GNUNET_SCHEDULER_NO_TASK != tst->ltask)
     GNUNET_SCHEDULER_cancel (tst->ltask);
   if (NULL != tst->lsock)