Check that you are not present in trail twice
[oweals/gnunet.git] / src / transport / transport_api.c
index f6f608dfbd7bdf054e4687b946d44abe85794159..3c57a83a0f2b5f1854602ac4f3c982a0d7fdd7c0 100644 (file)
@@ -195,18 +195,36 @@ struct GNUNET_TRANSPORT_TryConnectHandle
    */
   struct GNUNET_TRANSPORT_TryConnectHandle *next;
 
+  /**
+   *
+   */
   struct GNUNET_PeerIdentity pid;
 
+  /**
+   *
+   */
   struct GNUNET_TRANSPORT_Handle *th;
 
+  /**
+   *
+   */
   struct GNUNET_TRANSPORT_TransmitHandle *tth;
 
+  /**
+   *
+   */
   GNUNET_TRANSPORT_TryConnectCallback cb;
 
   /**
    * Closure for @e cb.
    */
   void *cb_cls;
+
+  /**
+   *
+   */
+  int connect;
+
 };
 
 
@@ -225,10 +243,19 @@ struct GNUNET_TRANSPORT_OfferHelloHandle
    */
   struct GNUNET_TRANSPORT_OfferHelloHandle *next;
 
+  /**
+   *
+   */
   struct GNUNET_TRANSPORT_Handle *th;
 
+  /**
+   *
+   */
   struct GNUNET_TRANSPORT_TransmitHandle *tth;
 
+  /**
+   *
+   */
   GNUNET_SCHEDULER_Task cont;
 
   /**
@@ -236,6 +263,9 @@ struct GNUNET_TRANSPORT_OfferHelloHandle
    */
   void *cls;
 
+  /**
+   *
+   */
   struct GNUNET_MessageHeader *msg;
 };
 
@@ -267,6 +297,11 @@ struct GNUNET_TRANSPORT_Handle
    */
   GNUNET_TRANSPORT_NotifyDisconnect nd_cb;
 
+  /**
+   * function to call on excess bandwidth events
+   */
+  GNUNET_TRANSPORT_NotifyExcessBandwidth neb_cb;
+
   /**
    * Head of DLL of control messages.
    */
@@ -378,7 +413,6 @@ struct GNUNET_TRANSPORT_Handle
 };
 
 
-
 /**
  * Schedule the task to send one message, either from the control
  * list or the peer message queues  to the service.
@@ -414,25 +448,50 @@ neighbour_find (struct GNUNET_TRANSPORT_Handle *h,
 }
 
 
-
+/**
+ * The outbound quota has changed in a way that may require
+ * us to reset the timeout.  Update the timeout.
+ *
+ * @param cls the `struct Neighbour` for which the timeout changed
+ */
 static void
 outbound_bw_tracker_update (void *cls)
 {
   struct Neighbour *n = cls;
   struct GNUNET_TIME_Relative delay;
+
   if (NULL == n->hn)
     return;
-
   delay = GNUNET_BANDWIDTH_tracker_get_delay (&n->out_tracker,
       n->th->notify_size + n->traffic_overhead);
-  LOG(GNUNET_ERROR_TYPE_DEBUG,
-      "New outbound delay %llu us\n",delay.rel_value_us);
+  LOG (GNUNET_ERROR_TYPE_DEBUG,
+       "New outbound delay %llu us\n",
+       GNUNET_STRINGS_relative_time_to_string (delay,
+                                               GNUNET_NO));
   GNUNET_CONTAINER_heap_update_cost (n->h->ready_heap,
       n->hn, delay.rel_value_us);
   schedule_transmission (n->h);
 }
 
 
+/**
+ * Function called by the bandwidth tracker if we have excess
+ * bandwidth.
+ *
+ * @param cls the `struct Neighbour` that has excess bandwidth
+ */
+static void
+notify_excess_cb (void *cls)
+{
+  struct Neighbour *n = cls;
+  struct GNUNET_TRANSPORT_Handle *h = n->h;
+
+  if (NULL != h->neb_cb)
+    h->neb_cb (h->cls,
+               &n->id);
+}
+
+
 /**
  * Add neighbour to our list
  *
@@ -452,10 +511,12 @@ neighbour_add (struct GNUNET_TRANSPORT_Handle *h,
   n->h = h;
   n->is_ready = GNUNET_YES;
   n->traffic_overhead = 0;
-  GNUNET_BANDWIDTH_tracker_init (&n->out_tracker,
-                                 outbound_bw_tracker_update, n,
-                                 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
-                                 MAX_BANDWIDTH_CARRY_S);
+  GNUNET_BANDWIDTH_tracker_init2 (&n->out_tracker,
+                                  &outbound_bw_tracker_update, n,
+                                  GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
+                                  MAX_BANDWIDTH_CARRY_S,
+                                  &notify_excess_cb,
+                                  n);
   GNUNET_assert (GNUNET_OK ==
                  GNUNET_CONTAINER_multipeermap_put (h->neighbours,
                                                     &n->id, n,
@@ -488,11 +549,11 @@ neighbour_delete (void *cls,
   GNUNET_assert (GNUNET_YES ==
                  GNUNET_CONTAINER_multipeermap_remove (handle->neighbours, key,
                                                        n));
+  GNUNET_BANDWIDTH_tracker_notification_stop (&n->out_tracker);
   GNUNET_free (n);
   return GNUNET_YES;
 }
 
-static int reconnecting;
 
 /**
  * Function we use for handling incoming messages.
@@ -501,7 +562,8 @@ static int reconnecting;
  * @param msg message received, NULL on timeout or fatal error
  */
 static void
-demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
+demultiplexer (void *cls,
+               const struct GNUNET_MessageHeader *msg)
 {
   struct GNUNET_TRANSPORT_Handle *h = cls;
   const struct DisconnectInfoMessage *dim;
@@ -519,7 +581,7 @@ demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
   uint32_t bytes_physical;
 
   GNUNET_assert (NULL != h->client);
-  if (GNUNET_YES == reconnecting)
+  if (GNUNET_YES == h->reconnecting)
   {
     return;
   }
@@ -527,7 +589,7 @@ demultiplexer (void *cls, const struct GNUNET_MessageHeader *msg)
   {
     LOG (GNUNET_ERROR_TYPE_DEBUG,
          "Error receiving from transport service, disconnecting temporarily.\n");
-    reconnecting = GNUNET_YES;
+    h->reconnecting = GNUNET_YES;
     disconnect_and_schedule_reconnect (h);
     return;
   }
@@ -1027,7 +1089,7 @@ reconnect (void *cls,
   GNUNET_assert (NULL == h->client);
   GNUNET_assert (NULL == h->control_head);
   GNUNET_assert (NULL == h->control_tail);
-  reconnecting = GNUNET_NO;
+  h->reconnecting = GNUNET_NO;
   h->client = GNUNET_CLIENT_connect ("transport", h->cfg);
 
   GNUNET_assert (NULL != h->client);
@@ -1100,7 +1162,6 @@ cancel_control_transmit (struct GNUNET_TRANSPORT_Handle *th,
 }
 
 
-
 /**
  * Send REQUEST_CONNECT message to the service.
  *
@@ -1115,7 +1176,7 @@ send_try_connect (void *cls, size_t size, void *buf)
   struct GNUNET_TRANSPORT_TryConnectHandle *tch = cls;
   struct TransportRequestConnectMessage msg;
 
-  if (buf == NULL)
+  if (NULL == buf)
   {
     if (NULL != tch->cb)
       tch->cb (tch->cb_cls, GNUNET_SYSERR);
@@ -1134,7 +1195,7 @@ send_try_connect (void *cls, size_t size, void *buf)
   GNUNET_assert (size >= sizeof (struct TransportRequestConnectMessage));
   msg.header.size = htons (sizeof (struct TransportRequestConnectMessage));
   msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT);
-  msg.reserved = htonl (0);
+  msg.connect = htonl (tch->connect);
   msg.peer = tch->pid;
   memcpy (buf, &msg, sizeof (msg));
   if (NULL != tch->cb)
@@ -1144,6 +1205,7 @@ send_try_connect (void *cls, size_t size, void *buf)
   return sizeof (struct TransportRequestConnectMessage);
 }
 
+
 /**
  * Ask the transport service to establish a connection to
  * the given peer.
@@ -1162,19 +1224,22 @@ GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
                               GNUNET_TRANSPORT_TryConnectCallback cb,
                               void *cb_cls)
 {
-  struct GNUNET_TRANSPORT_TryConnectHandle *tch = NULL;
+  struct GNUNET_TRANSPORT_TryConnectHandle *tch;
 
   if (NULL == handle->client)
-      return NULL;
+    return NULL;
   tch = GNUNET_new (struct GNUNET_TRANSPORT_TryConnectHandle);
   tch->th = handle;
   tch->pid = *(target);
   tch->cb = cb;
   tch->cb_cls = cb_cls;
+  tch->connect = GNUNET_YES;
   tch->tth = schedule_control_transmit (handle,
                                         sizeof (struct TransportRequestConnectMessage),
                                         &send_try_connect, tch);
-  GNUNET_CONTAINER_DLL_insert(handle->tc_head, handle->tc_tail, tch);
+  GNUNET_CONTAINER_DLL_insert (handle->tc_head,
+                               handle->tc_tail,
+                               tch);
   return tch;
 }
 
@@ -1189,6 +1254,7 @@ void
 GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch)
 {
   struct GNUNET_TRANSPORT_Handle *th;
+  GNUNET_assert (GNUNET_YES == tch->connect);
 
   th = tch->th;
   cancel_control_transmit (th, tch->tth);
@@ -1196,6 +1262,64 @@ GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *t
   GNUNET_free (tch);
 }
 
+
+/**
+ * Ask the transport service to shutdown a connection to
+ * the given peer.
+ *
+ * @param handle connection to transport service
+ * @param target who we should try to connect to
+ * @param cb callback to be called when request was transmitted to transport
+ *         service
+ * @param cb_cls closure for the callback @a cb
+ * @return a `struct GNUNET_TRANSPORT_TryConnectHandle` handle or
+ *         NULL on failure (cb will not be called)
+ */
+struct GNUNET_TRANSPORT_TryConnectHandle *
+GNUNET_TRANSPORT_try_disconnect (struct GNUNET_TRANSPORT_Handle *handle,
+                                 const struct GNUNET_PeerIdentity *target,
+                                 GNUNET_TRANSPORT_TryConnectCallback cb,
+                                 void *cb_cls)
+{
+  struct GNUNET_TRANSPORT_TryConnectHandle *tch;
+
+  if (NULL == handle->client)
+    return NULL;
+  tch = GNUNET_new (struct GNUNET_TRANSPORT_TryConnectHandle);
+  tch->th = handle;
+  tch->pid = *(target);
+  tch->cb = cb;
+  tch->cb_cls = cb_cls;
+  tch->connect = GNUNET_NO;
+  tch->tth = schedule_control_transmit (handle,
+                                        sizeof (struct TransportRequestConnectMessage),
+                                        &send_try_connect, tch);
+  GNUNET_CONTAINER_DLL_insert (handle->tc_head,
+                               handle->tc_tail,
+                               tch);
+  return tch;
+}
+
+
+/**
+ * Cancel the request to transport to try a disconnect
+ * Callback will not be called
+ *
+ * @param tch the handle to cancel
+ */
+void
+GNUNET_TRANSPORT_try_disconnect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch)
+{
+  struct GNUNET_TRANSPORT_Handle *th;
+
+  GNUNET_assert (GNUNET_NO == tch->connect);
+  th = tch->th;
+  cancel_control_transmit (th, tch->tth);
+  GNUNET_CONTAINER_DLL_remove (th->tc_head, th->tc_tail, tch);
+  GNUNET_free (tch);
+}
+
+
 /**
  * Send HELLO message to the service.
  *
@@ -1334,7 +1458,6 @@ GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
 }
 
 
-
 /**
  * Offer the transport service the HELLO of another peer.  Note that
  * the transport service may just ignore this message if the HELLO is
@@ -1505,6 +1628,7 @@ GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh)
  * @param rec receive function to call
  * @param nc function to call on connect events
  * @param nd function to call on disconnect events
+ * @return NULL on error
  */
 struct GNUNET_TRANSPORT_Handle *
 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
@@ -1512,6 +1636,33 @@ GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
                           GNUNET_TRANSPORT_ReceiveCallback rec,
                           GNUNET_TRANSPORT_NotifyConnect nc,
                           GNUNET_TRANSPORT_NotifyDisconnect nd)
+{
+  return GNUNET_TRANSPORT_connect2 (cfg, self, cls,
+                                    rec, nc, nd, NULL);
+}
+
+
+/**
+ * Connect to the transport service.  Note that the connection may
+ * complete (or fail) asynchronously.
+ *
+ * @param cfg configuration to use
+ * @param self our own identity (API should check that it matches
+ *             the identity found by transport), or NULL (no check)
+ * @param cls closure for the callbacks
+ * @param rec receive function to call
+ * @param nc function to call on connect events
+ * @param nd function to call on disconnect events
+ * @param neb function to call if we have excess bandwidth to a peer
+ * @return NULL on error
+ */
+struct GNUNET_TRANSPORT_Handle *
+GNUNET_TRANSPORT_connect2 (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                           const struct GNUNET_PeerIdentity *self, void *cls,
+                           GNUNET_TRANSPORT_ReceiveCallback rec,
+                           GNUNET_TRANSPORT_NotifyConnect nc,
+                           GNUNET_TRANSPORT_NotifyDisconnect nd,
+                           GNUNET_TRANSPORT_NotifyExcessBandwidth neb)
 {
   struct GNUNET_TRANSPORT_Handle *ret;
 
@@ -1526,6 +1677,7 @@ GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
   ret->rec = rec;
   ret->nc_cb = nc;
   ret->nd_cb = nd;
+  ret->neb_cb = neb;
   ret->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
   LOG (GNUNET_ERROR_TYPE_DEBUG,
        "Connecting to transport service.\n");
@@ -1574,10 +1726,10 @@ GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle)
   }
   GNUNET_free_non_null (handle->my_hello);
   handle->my_hello = NULL;
-  GNUNET_assert (handle->tc_head == NULL);
-  GNUNET_assert (handle->tc_tail == NULL);
-  GNUNET_assert (handle->hwl_head == NULL);
-  GNUNET_assert (handle->hwl_tail == NULL);
+  GNUNET_assert (NULL == handle->tc_head);
+  GNUNET_assert (NULL == handle->tc_tail);
+  GNUNET_assert (NULL == handle->hwl_head);
+  GNUNET_assert (NULL == handle->hwl_tail);
   GNUNET_CONTAINER_heap_destroy (handle->ready_heap);
   handle->ready_heap = NULL;
   GNUNET_free (handle);