Avoid trying to disconnect a neighbour twice
[oweals/gnunet.git] / src / transport / transport_api.c
index 7fa035c061d795d13acc2230c4486b0569956138..6e47b269ba9217fdb67591b97c0dddef8a939a8d 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2009-2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009-2013 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -84,7 +84,7 @@ struct GNUNET_TRANSPORT_TransmitHandle
    * Task to trigger request timeout if the request is stalled due to
    * congestion.
    */
-  GNUNET_SCHEDULER_TaskIdentifier timeout_task;
+  struct GNUNET_SCHEDULER_Task * timeout_task;
 
   /**
    * How many bytes is our notify callback waiting for?
@@ -171,7 +171,7 @@ struct GNUNET_TRANSPORT_GetHelloHandle
   /**
    * Task for calling the HelloUpdateCallback when we already have a HELLO
    */
-  GNUNET_SCHEDULER_TaskIdentifier notify_task;
+  struct GNUNET_SCHEDULER_Task * notify_task;
 
   /**
    * Closure for @e rec.
@@ -295,7 +295,7 @@ struct GNUNET_TRANSPORT_OfferHelloHandle
   /**
    * Function to call once we are done.
    */
-  GNUNET_SCHEDULER_Task cont;
+  GNUNET_SCHEDULER_TaskCallback cont;
 
   /**
    * Closure for @e cont
@@ -355,7 +355,7 @@ struct GNUNET_TRANSPORT_Handle
    * The current HELLO message for this peer.  Updated
    * whenever transports change their addresses.
    */
-  struct GNUNET_HELLO_Message *my_hello;
+  struct GNUNET_MessageHeader *my_hello;
 
   /**
    * My client connection to the transport service.
@@ -434,7 +434,7 @@ struct GNUNET_TRANSPORT_Handle
   /**
    * ID of the task trying to reconnect to the service.
    */
-  GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
+  struct GNUNET_SCHEDULER_Task * reconnect_task;
 
   /**
    * ID of the task trying to trigger transmission for a peer while
@@ -442,7 +442,7 @@ struct GNUNET_TRANSPORT_Handle
    * messages and the smallest entry in the 'ready_heap' has a time
    * stamp in the future.
    */
-  GNUNET_SCHEDULER_TaskIdentifier quota_task;
+  struct GNUNET_SCHEDULER_Task * quota_task;
 
   /**
    * Delay until we try to reconnect.
@@ -512,7 +512,7 @@ outbound_bw_tracker_update (void *cls)
   if (NULL == n->hn)
     return;
   delay = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker,
-      n->th->notify_size + n->traffic_overhead);
+                                              n->th->notify_size + n->traffic_overhead);
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "New outbound delay %llu us\n",
        GNUNET_STRINGS_relative_time_to_string (delay,
@@ -655,7 +655,8 @@ demultiplexer (void *cls,
       break;
     }
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Receiving (my own) `%s' message, I am `%4s'.\n", "HELLO",
+         "Receiving (my own) HELLO message (%u bytes), I am `%4s'.\n",
+         (unsigned int) size,
          GNUNET_i2s (&me));
     GNUNET_free_non_null (h->my_hello);
     h->my_hello = NULL;
@@ -664,14 +665,13 @@ demultiplexer (void *cls,
       GNUNET_break (0);
       break;
     }
-    h->my_hello = GNUNET_malloc (size);
-    memcpy (h->my_hello, msg, size);
+    h->my_hello = GNUNET_copy_message (msg);
     hwl = h->hwl_head;
     while (NULL != hwl)
     {
       next_hwl = hwl->next;
       hwl->rec (hwl->rec_cls,
-                (const struct GNUNET_MessageHeader *) h->my_hello);
+                h->my_hello);
       hwl = next_hwl;
     }
     break;
@@ -689,8 +689,8 @@ demultiplexer (void *cls,
       break;
     }
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Receiving `%s' message for `%4s'.\n",
-         "CONNECT", GNUNET_i2s (&cim->id));
+         "Receiving CONNECT message for `%4s'.\n",
+         GNUNET_i2s (&cim->id));
     n = neighbour_find (h, &cim->id);
     if (NULL != n)
     {
@@ -699,11 +699,11 @@ demultiplexer (void *cls,
     }
     n = neighbour_add (h, &cim->id);
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Receiving `%s' message for `%4s' with quota %u\n",
-         "CONNECT",
+         "Receiving CONNECT message for `%4s' with quota %u\n",
          GNUNET_i2s (&cim->id),
          ntohl (cim->quota_out.value__));
-    GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker, cim->quota_out);
+    GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker,
+                                           cim->quota_out);
     if (h->nc_cb != NULL)
       h->nc_cb (h->cls, &n->id);
     break;
@@ -716,8 +716,8 @@ demultiplexer (void *cls,
     dim = (const struct DisconnectInfoMessage *) msg;
     GNUNET_break (ntohl (dim->reserved) == 0);
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Receiving `%s' message for `%4s'.\n",
-         "DISCONNECT", GNUNET_i2s (&dim->peer));
+         "Receiving DISCONNECT message for `%4s'.\n",
+         GNUNET_i2s (&dim->peer));
     n = neighbour_find (h, &dim->peer);
     if (NULL == n)
     {
@@ -745,18 +745,19 @@ demultiplexer (void *cls,
 
     if (bytes_physical >= bytes_msg)
     {
-        LOG (GNUNET_ERROR_TYPE_DEBUG,
-             "Overhead for %u byte message: %u\n",
-            bytes_msg, bytes_physical - bytes_msg);
+      LOG (GNUNET_ERROR_TYPE_DEBUG,
+           "Overhead for %u byte message: %u\n",
+           bytes_msg,
+           bytes_physical - bytes_msg);
       n->traffic_overhead += bytes_physical - bytes_msg;
     }
     GNUNET_break (GNUNET_NO == n->is_ready);
     n->is_ready = GNUNET_YES;
     if ((NULL != n->th) && (NULL == n->hn))
     {
-      GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != n->th->timeout_task);
+      GNUNET_assert (NULL != n->th->timeout_task);
       GNUNET_SCHEDULER_cancel (n->th->timeout_task);
-      n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
+      n->th->timeout_task = NULL;
       /* we've been waiting for this (congestion, not quota,
        * caused delayed transmission) */
       n->hn = GNUNET_CONTAINER_heap_insert (h->ready_heap, n, 0);
@@ -764,9 +765,6 @@ demultiplexer (void *cls,
     }
     break;
   case GNUNET_MESSAGE_TYPE_TRANSPORT_RECV:
-    LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Receiving `%s' message.\n",
-         "RECV");
     if (size <
         sizeof (struct InboundMessage) + sizeof (struct GNUNET_MessageHeader))
     {
@@ -793,8 +791,6 @@ demultiplexer (void *cls,
       h->rec (h->cls, &im->peer, imm);
     break;
   case GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA:
-    LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Receiving `%s' message.\n", "SET_QUOTA");
     if (size != sizeof (struct QuotaSetMessage))
     {
       GNUNET_break (0);
@@ -805,16 +801,18 @@ demultiplexer (void *cls,
     if (NULL == n)
       break;
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Receiving `%s' message for `%4s' with quota %u\n",
-         "SET_QUOTA",
+         "Receiving SET_QUOTA message for `%4s' with quota %u\n",
          GNUNET_i2s (&qm->peer),
          ntohl (qm->quota.value__));
-    GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker, qm->quota);
+    GNUNET_BANDWIDTH_tracker_update_quota (&n->out_tracker,
+                                           qm->quota);
     break;
   default:
     LOG (GNUNET_ERROR_TYPE_ERROR,
          _("Received unexpected message of type %u in %s:%u\n"),
-         ntohs (msg->type), __FILE__, __LINE__);
+         ntohs (msg->type),
+         __FILE__,
+         __LINE__);
     GNUNET_break (0);
     break;
   }
@@ -835,7 +833,7 @@ timeout_request_due_to_congestion (void *cls,
   struct GNUNET_TRANSPORT_TransmitHandle *th = cls;
   struct Neighbour *n = th->neighbour;
 
-  n->th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
+  n->th->timeout_task = NULL;
   GNUNET_assert (th == n->th);
   GNUNET_assert (NULL == n->hn);
   n->th = NULL;
@@ -878,11 +876,14 @@ transport_notify_ready (void *cls, size_t size, void *buf)
   /* first send control messages */
   while ((NULL != (th = h->control_head)) && (th->notify_size <= size))
   {
-    GNUNET_CONTAINER_DLL_remove (h->control_head, h->control_tail, th);
+    GNUNET_CONTAINER_DLL_remove (h->control_head,
+                                 h->control_tail,
+                                 th);
     nret = th->notify (th->notify_cls, size, &cbuf[ret]);
     LOG (GNUNET_ERROR_TYPE_DEBUG,
          "Added %u bytes of control message at %u\n",
-         nret, ret);
+         nret,
+         ret);
     GNUNET_free (th);
     ret += nret;
     size -= nret;
@@ -897,7 +898,7 @@ transport_notify_ready (void *cls, size_t size, void *buf)
       /* peer not ready, wait for notification! */
       GNUNET_assert (n == GNUNET_CONTAINER_heap_remove_root (h->ready_heap));
       n->hn = NULL;
-      GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == n->th->timeout_task);
+      GNUNET_assert (NULL == n->th->timeout_task);
       n->th->timeout_task =
           GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
                                         (n->th->timeout),
@@ -963,7 +964,7 @@ schedule_transmission_task (void *cls,
   struct GNUNET_TRANSPORT_TransmitHandle *th;
   struct Neighbour *n;
 
-  h->quota_task = GNUNET_SCHEDULER_NO_TASK;
+  h->quota_task = NULL;
   GNUNET_assert (NULL != h->client);
   /* destroy all requests that have timed out */
   while ((NULL != (n = GNUNET_CONTAINER_heap_peek (h->ready_heap))) &&
@@ -1018,10 +1019,10 @@ schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
   struct Neighbour *n;
 
   GNUNET_assert (NULL != h->client);
-  if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
+  if (h->quota_task != NULL)
   {
     GNUNET_SCHEDULER_cancel (h->quota_task);
-    h->quota_task = GNUNET_SCHEDULER_NO_TASK;
+    h->quota_task = NULL;
   }
   if (NULL != h->control_head)
     delay = GNUNET_TIME_UNIT_ZERO;
@@ -1053,7 +1054,8 @@ schedule_transmission (struct GNUNET_TRANSPORT_Handle *h)
  * @return a `struct GNUNET_TRANSPORT_TransmitHandle`
  */
 static struct GNUNET_TRANSPORT_TransmitHandle *
-schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h, size_t size,
+schedule_control_transmit (struct GNUNET_TRANSPORT_Handle *h,
+                           size_t size,
                            GNUNET_TRANSPORT_TransmitReadyNotify notify,
                            void *notify_cls)
 {
@@ -1091,13 +1093,11 @@ send_start (void *cls, size_t size, void *buf)
   {
     /* Can only be shutdown, just give up */
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Shutdown while trying to transmit `%s' request.\n",
-         "START");
+         "Shutdown while trying to transmit START request.\n");
     return 0;
   }
   LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Transmitting `%s' request.\n",
-       "START");
+       "Transmitting START request.\n");
   GNUNET_assert (size >= sizeof (struct StartMessage));
   s.header.size = htons (sizeof (struct StartMessage));
   s.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_START);
@@ -1127,7 +1127,7 @@ reconnect (void *cls,
 {
   struct GNUNET_TRANSPORT_Handle *h = cls;
 
-  h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
+  h->reconnect_task = NULL;
   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
   {
     /* shutdown, just give up */
@@ -1158,7 +1158,7 @@ disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
 {
   struct GNUNET_TRANSPORT_TransmitHandle *th;
 
-  GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
+  GNUNET_assert (h->reconnect_task == NULL);
   if (NULL != h->cth)
   {
     GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
@@ -1174,10 +1174,10 @@ disconnect_and_schedule_reconnect (struct GNUNET_TRANSPORT_Handle *h)
   /* Forget about all neighbours that we used to be connected to */
   GNUNET_CONTAINER_multipeermap_iterate (h->neighbours,
                                          &neighbour_delete, h);
-  if (h->quota_task != GNUNET_SCHEDULER_NO_TASK)
+  if (h->quota_task != NULL)
   {
     GNUNET_SCHEDULER_cancel (h->quota_task);
-    h->quota_task = GNUNET_SCHEDULER_NO_TASK;
+    h->quota_task = NULL;
   }
   while ((NULL != (th = h->control_head)))
   {
@@ -1477,7 +1477,9 @@ send_hello (void *cls, size_t size, void *buf)
  * @return number of bytes copied to @a buf
  */
 static size_t
-send_metric (void *cls, size_t size, void *buf)
+send_metric (void *cls,
+             size_t size,
+             void *buf)
 {
   struct TrafficMetricMessage *msg = cls;
   uint16_t ssize;
@@ -1485,14 +1487,12 @@ send_metric (void *cls, size_t size, void *buf)
   if (NULL == buf)
   {
     LOG (GNUNET_ERROR_TYPE_DEBUG,
-         "Timeout while trying to transmit `%s' request.\n",
-         "TRAFFIC_METRIC");
+         "Timeout while trying to transmit TRAFFIC_METRIC request.\n");
     GNUNET_free (msg);
     return 0;
   }
   LOG (GNUNET_ERROR_TYPE_DEBUG,
-       "Transmitting `%s' request.\n",
-       "TRAFFIC_METRIC");
+       "Transmitting TRAFFIC_METRIC request.\n");
   ssize = ntohs (msg->header.size);
   GNUNET_assert (size >= ssize);
   memcpy (buf, msg, ssize);
@@ -1506,56 +1506,35 @@ send_metric (void *cls, size_t size, void *buf)
  *
  * @param handle transport handle
  * @param peer the peer to set the metric for
- * @param inbound set inbound direction (#GNUNET_YES or #GNUNET_NO)
- * @param outbound set outbound direction (#GNUNET_YES or #GNUNET_NO)
- * @param ats the metric as ATS information
- * @param ats_count the number of metrics
+ * @param prop the performance metrics to set
+ * @param delay_in inbound delay to introduce
+ * @param delay_out outbound delay to introduce
  *
- * Supported ATS values:
- * #GNUNET_ATS_QUALITY_NET_DELAY  (value in ms)
- * #GNUNET_ATS_QUALITY_NET_DISTANCE (value in count(hops))
- *
- * Example:
- * To enforce a delay of 10 ms for peer p1 in sending direction use:
- * <code>
- * struct GNUNET_ATS_Information ats;
- * ats.type = ntohl (GNUNET_ATS_QUALITY_NET_DELAY);
- * ats.value = ntohl (10);
- * GNUNET_TRANSPORT_set_traffic_metric (th, p1, TM_SEND, &ats, 1);
- * </code>
- * Note:
- * Delay restrictions in receiving direction will be enforced with
- * 1 message delay.
+ * Note: Delay restrictions in receiving direction will be enforced
+ * with one message delay.
  */
 void
 GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
-                                     const struct GNUNET_PeerIdentity *peer,
-                                     int inbound,
-                                     int outbound,
-                                     const struct GNUNET_ATS_Information *ats,
-                                     size_t ats_count)
+                                    const struct GNUNET_PeerIdentity *peer,
+                                    const struct GNUNET_ATS_Properties *prop,
+                                     struct GNUNET_TIME_Relative delay_in,
+                                     struct GNUNET_TIME_Relative delay_out)
 {
   struct TrafficMetricMessage *msg;
 
-  GNUNET_assert ((outbound == GNUNET_YES) || (outbound == GNUNET_NO));
-  GNUNET_assert ((inbound == GNUNET_YES) || (inbound == GNUNET_NO));
-  if ((GNUNET_NO == inbound) && (GNUNET_NO == outbound))
-    return;
-  if (0 == ats_count)
-    return;
-
-  size_t len = sizeof (struct TrafficMetricMessage) +
-    ats_count * sizeof (struct GNUNET_ATS_Information);
-
-  msg = GNUNET_malloc (len);
-  msg->header.size = htons (len);
+  msg = GNUNET_new (struct TrafficMetricMessage);
+  msg->header.size = htons (sizeof (struct TrafficMetricMessage));
   msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC);
-  msg->direction = htons (0 + outbound + 2 * inbound);
-  msg->ats_count = htons (ats_count);
-  msg->peer = (*peer);
-  memcpy (&msg[1], ats, ats_count * sizeof (struct GNUNET_ATS_Information));
-  schedule_control_transmit (handle, len,
-                             &send_metric, msg);
+  msg->reserved = htonl (0);
+  msg->peer = *peer;
+  GNUNET_ATS_properties_hton (&msg->properties,
+                              prop);
+  msg->delay_in = GNUNET_TIME_relative_hton (delay_in);
+  msg->delay_out = GNUNET_TIME_relative_hton (delay_out);
+  schedule_control_transmit (handle,
+                             sizeof (struct TrafficMetricMessage),
+                             &send_metric,
+                             msg);
 }
 
 
@@ -1577,7 +1556,7 @@ GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
 struct GNUNET_TRANSPORT_OfferHelloHandle *
 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
                               const struct GNUNET_MessageHeader *hello,
-                              GNUNET_SCHEDULER_Task cont, void *cls)
+                              GNUNET_SCHEDULER_TaskCallback cont, void *cls)
 {
   struct GNUNET_TRANSPORT_OfferHelloHandle *ohh;
   struct GNUNET_MessageHeader *msg;
@@ -1663,10 +1642,10 @@ call_hello_update_cb_async (void *cls,
   struct GNUNET_TRANSPORT_GetHelloHandle *ghh = cls;
 
   GNUNET_assert (NULL != ghh->handle->my_hello);
-  GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != ghh->notify_task);
-  ghh->notify_task = GNUNET_SCHEDULER_NO_TASK;
+  GNUNET_assert (NULL != ghh->notify_task);
+  ghh->notify_task = NULL;
   ghh->rec (ghh->rec_cls,
-            (const struct GNUNET_MessageHeader *) ghh->handle->my_hello);
+            ghh->handle->my_hello);
 }
 
 
@@ -1694,7 +1673,7 @@ GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
   hwl->rec_cls = rec_cls;
   hwl->handle = handle;
   GNUNET_CONTAINER_DLL_insert (handle->hwl_head, handle->hwl_tail, hwl);
-  if (handle->my_hello != NULL)
+  if (NULL != handle->my_hello)
     hwl->notify_task = GNUNET_SCHEDULER_add_now (&call_hello_update_cb_async,
                                                  hwl);
   return hwl;
@@ -1711,7 +1690,7 @@ GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh)
 {
   struct GNUNET_TRANSPORT_Handle *handle = ghh->handle;
 
-  if (GNUNET_SCHEDULER_NO_TASK != ghh->notify_task)
+  if (NULL != ghh->notify_task)
     GNUNET_SCHEDULER_cancel (ghh->notify_task);
   GNUNET_CONTAINER_DLL_remove (handle->hwl_head, handle->hwl_tail, ghh);
   GNUNET_free (ghh);
@@ -1810,20 +1789,20 @@ GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "Transport disconnect called!\n");
   /* this disconnects all neighbours... */
-  if (handle->reconnect_task == GNUNET_SCHEDULER_NO_TASK)
+  if (handle->reconnect_task == NULL)
     disconnect_and_schedule_reconnect (handle);
   /* and now we stop trying to connect again... */
-  if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
+  if (handle->reconnect_task != NULL)
   {
     GNUNET_SCHEDULER_cancel (handle->reconnect_task);
-    handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
+    handle->reconnect_task = NULL;
   }
   GNUNET_CONTAINER_multipeermap_destroy (handle->neighbours);
   handle->neighbours = NULL;
-  if (handle->quota_task != GNUNET_SCHEDULER_NO_TASK)
+  if (handle->quota_task != NULL)
   {
     GNUNET_SCHEDULER_cancel (handle->quota_task);
-    handle->quota_task = GNUNET_SCHEDULER_NO_TASK;
+    handle->quota_task = NULL;
   }
   GNUNET_free_non_null (handle->my_hello);
   handle->my_hello = NULL;
@@ -1926,9 +1905,9 @@ GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct GNUNET_TRANSPORT_TransmitH
   }
   else
   {
-    GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != th->timeout_task);
+    GNUNET_assert (NULL != th->timeout_task);
     GNUNET_SCHEDULER_cancel (th->timeout_task);
-    th->timeout_task = GNUNET_SCHEDULER_NO_TASK;
+    th->timeout_task = NULL;
   }
   GNUNET_free (th);
 }