API improvements

9 files changed, 57 insertions, 29 deletions

diff --git a/src/core/gnunet-service-core.c b/src/core/gnunet-service-core.c
index 0d714be3f..8cb31b82e 100644
--- a/src/core/gnunet-service-core.c
+++ b/src/core/gnunet-service-core.c
@@ -24,21 +24,15 @@
  * @author Christian Grothoff
  *
  * POST-TESTING:
- * - revisit API (which arguments are used, needed)?
- * - add code to send PINGs if we are about to time-out otherwise (?)
- * ? add heuristic to do another send_key in "handle_set_key"
- *   in case previous attempt failed / didn't work / persist
- *   (but don't do it always to avoid storm of SET_KEY's going
- *   back and forth!) --- alternatively, add "status" field
- *   of the other peer to the set key message, that way we'd
- *   know for sure!
- * - check that hostkey used by transport (for HELLOs) is the
- *   same as the hostkey that we are using!
  * - topology management:
  *   + bootstrapping (transport offer hello, plugins)
  *   + internal neighbour selection
- *   + update bandwidth usage statistics
- *   + bandwidth allocation (transport set quota)
+ *   + update (and use!) bandwidth usage statistics
+ *
+ * Considerations for later:
+ * - check that hostkey used by transport (for HELLOs) is the
+ *   same as the hostkey that we are using!
+ * - add code to send PINGs if we are about to time-out otherwise
  * - optimize lookup (many O(n) list traversals
  *   could ideally be changed to O(1) hash map lookups)
  */
@@ -452,7 +446,7 @@ struct Neighbour
    * bandwidth-hogs are sampled at a frequency of about 78s!);
    * may get negative if we have VERY high priority content.
    */
-  long long available_send_window;
+  long long available_send_window; // USE!
 
   /**
    * How much downstream capacity of this peer has been reserved for
@@ -461,7 +455,7 @@ struct Neighbour
    * make sure that this reserved amount of bandwidth is actually
    * available).
    */
-  long long available_recv_window;
+  long long available_recv_window; // USE!
 
   /**
    * How valueable were the messages of this peer recently?
@@ -515,7 +509,7 @@ struct Neighbour
   uint32_t bpm_out_external_limit;
 
   /**
-   * What was our PING challenge number?
+   * What was our PING challenge number (for this peer)?
    */
   uint32_t ping_challenge;
 
@@ -1219,6 +1213,7 @@ process_encrypted_neighbour_queue (struct Neighbour *n)
   n->th =
     GNUNET_TRANSPORT_notify_transmit_ready (transport, &n->peer,
                                             n->encrypted_head->size,
+                                            n->encrypted_head->priority,
                                             GNUNET_TIME_absolute_get_remaining
                                             (n->encrypted_head->deadline),
                                             &notify_encrypted_transmit_ready,
@@ -1372,7 +1367,7 @@ select_messages (struct Neighbour *n,
       /* number of bytes available for transmission at time "t" */
       avail = n->available_send_window;
       t = n->last_asw_update;
-      /* how many bytes have we (hyptothetically) scheduled so far */
+      /* how many bytes have we (hypothetically) scheduled so far */
       off = 0;
       /* maximum time we can wait before transmitting anything
          and still make all of our deadlines */
@@ -1851,7 +1846,7 @@ handle_client_send (void *cls,
       if (NULL ==
           GNUNET_TRANSPORT_notify_transmit_ready (transport,
                                                   &sm->peer,
-                                                  0,
+                                                  0, 0,
                                                   GNUNET_TIME_absolute_get_remaining
                                                   (GNUNET_TIME_absolute_ntoh
                                                    (sm->deadline)),
diff --git a/src/include/gnunet_transport_service.h b/src/include/gnunet_transport_service.h
index 25ca388a7..391a87e9d 100644
--- a/src/include/gnunet_transport_service.h
+++ b/src/include/gnunet_transport_service.h
@@ -168,6 +168,7 @@ struct GNUNET_TRANSPORT_TransmitHandle;
  * @param handle connection to transport service
  * @param target who should receive the message
  * @param size how big is the message we want to transmit?
+ * @param priority how important is the message?
  * @param timeout after how long should we give up (and call
  *        notify with buf NULL and size 0)?
  * @param notify function to call when we are ready to
@@ -182,6 +183,7 @@ struct GNUNET_TRANSPORT_TransmitHandle
                                            *handle,
                                            const struct GNUNET_PeerIdentity
                                            *target, size_t size,
+                                           unsigned int priority,
                                            struct GNUNET_TIME_Relative
                                            timeout,
                                            GNUNET_NETWORK_TransmitReadyNotify
diff --git a/src/transport/gnunet-service-transport.c b/src/transport/gnunet-service-transport.c
index f689b54c0..5a146ebe8 100644
--- a/src/transport/gnunet-service-transport.c
+++ b/src/transport/gnunet-service-transport.c
@@ -214,6 +214,11 @@ struct MessageQueue
    */
   int internal_msg;
 
+  /**
+   * How important is the message?
+   */
+  unsigned int priority;
+  
 };
 
 
@@ -1038,6 +1043,7 @@ try_unvalidated_addresses (struct NeighbourList *n)
       rl->plugin = plugin;
       rl->plugin_handle = plugin->api->send_to (plugin->api->cls,
                                                 &n->id,
+                                                0,
                                                 NULL,
                                                 NULL,
                                                 GNUNET_TIME_UNIT_ZERO,
@@ -1123,6 +1129,7 @@ try_transmission_to_peer (struct NeighbourList *neighbour)
                              rl->plugin_handle,
                              rl,
                              &neighbour->id,
+                             mq->priority,
                              mq->message,
                              GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
                              &transmit_send_continuation, mq);
@@ -1133,12 +1140,14 @@ try_transmission_to_peer (struct NeighbourList *neighbour)
  * Send the specified message to the specified peer.
  *
  * @param client source of the transmission request (can be NULL)
+ * @param priority how important is the message
  * @param msg message to send
  * @param is_internal is this an internal message
  * @param neighbour handle to the neighbour for transmission
  */
 static void
 transmit_to_peer (struct TransportClient *client,
+                  unsigned int priority,
                   const struct GNUNET_MessageHeader *msg,
                   int is_internal, struct NeighbourList *neighbour)
 {
@@ -1174,6 +1183,7 @@ transmit_to_peer (struct TransportClient *client,
   mq->message = m;
   mq->neighbour = neighbour;
   mq->internal_msg = is_internal;
+  mq->priority = priority;
 
   /* find tail */
   mqe = neighbour->messages;
@@ -1259,7 +1269,7 @@ refresh_hello ()
   npos = neighbours;
   while (npos != NULL)
     {
-      transmit_to_peer (NULL,
+      transmit_to_peer (NULL, 0,
                         (const struct GNUNET_MessageHeader *) our_hello,
                         GNUNET_YES, npos);
       npos = npos->next;
@@ -1769,6 +1779,7 @@ check_hello_validated (void *cls,
       if (NULL ==
           tp->api->send_to (tp->api->cls,
                             &va->msg->target,
+                            0,
                             (const struct GNUNET_MessageHeader *) our_hello,
                             &va->msg->header,
                             HELLO_VERIFICATION_TIMEOUT,
@@ -1948,7 +1959,7 @@ process_ping (struct TransportPlugin *plugin,
       GNUNET_break (0);
       return;
     }
-  transmit_to_peer (NULL, &vcr.header, GNUNET_YES, n);
+  transmit_to_peer (NULL, 0, &vcr.header, GNUNET_YES, n);
 }
 
 
@@ -2191,7 +2202,7 @@ setup_new_neighbour (const struct GNUNET_PeerIdentity *peer)
                                                   GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
                                                   GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
                                                   &neighbour_timeout_task, n);
-  transmit_to_peer (NULL,
+  transmit_to_peer (NULL, 0,
                     (const struct GNUNET_MessageHeader *) our_hello,
                     GNUNET_YES, n);
   notify_clients_connect (peer, GNUNET_TIME_UNIT_FOREVER_REL);
@@ -2322,7 +2333,7 @@ plugin_env_receive (void *cls,
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
                   "Sending `%s' message to connecting peer.\n", "ACK");
 #endif
-      transmit_to_peer (NULL, &ack, GNUNET_YES, n);
+      transmit_to_peer (NULL, 0, &ack, GNUNET_YES, n);
       break;
     case GNUNET_MESSAGE_TYPE_TRANSPORT_PING:
       process_ping (plugin, peer, plugin_context, message);
@@ -2515,7 +2526,7 @@ handle_send (void *cls,
               ntohs (obmm->size),
               ntohs (obmm->type), GNUNET_i2s (&obm->peer));
 #endif
-  transmit_to_peer (tc, obmm, GNUNET_NO, n);
+  transmit_to_peer (tc, ntohl(obm->priority), obmm, GNUNET_NO, n);
   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 }
 
diff --git a/src/transport/plugin_transport.h b/src/transport/plugin_transport.h
index 57df9affe..e0f83880a 100644
--- a/src/transport/plugin_transport.h
+++ b/src/transport/plugin_transport.h
@@ -213,6 +213,7 @@ struct GNUNET_TRANSPORT_PluginEnvironment
  *
  * @param cls closure
  * @param target who should receive this message
+ * @param priority how important is the message
  * @param msg1 first message to transmit
  * @param msg2 second message to transmit (can be NULL)
  * @param timeout how long should we try to transmit these?
@@ -225,6 +226,7 @@ typedef void *
   (*GNUNET_TRANSPORT_TransmitToAddressFunction) (void *cls,
                                                  const struct
                                                  GNUNET_PeerIdentity * target,
+                                                 unsigned int priority,
                                                  const struct
                                                  GNUNET_MessageHeader * msg1,
                                                  const struct
@@ -271,6 +273,7 @@ typedef void
  *        scheduled for immediate transmission, the plugin is to
  *        call the continuation with failure immediately
  * @param target who should receive this message
+ * @param priority how important is the message?
  * @param msg the message to transmit
  * @param timeout how long to wait at most for the transmission
  * @param cont continuation to call once the message has
@@ -287,6 +290,7 @@ typedef void *
                                         struct ReadyList * service_context,
                                         const struct GNUNET_PeerIdentity *
                                         target,
+                                        unsigned int priority,
                                         const struct GNUNET_MessageHeader *
                                         msg,
                                         struct GNUNET_TIME_Relative timeout,
diff --git a/src/transport/plugin_transport_tcp.c b/src/transport/plugin_transport_tcp.c
index 1b4a7c103..792f777ed 100644
--- a/src/transport/plugin_transport_tcp.c
+++ b/src/transport/plugin_transport_tcp.c
@@ -632,6 +632,7 @@ process_pending_messages (struct Session *session)
  *
  * @param cls closure
  * @param target who should receive this message
+ * @param priority how important is the message
  * @param msg1 first message to transmit
  * @param msg2 second message to transmit (can be NULL)
  * @param timeout how long should we try to transmit these?
@@ -643,6 +644,7 @@ process_pending_messages (struct Session *session)
 static void *
 tcp_plugin_send_to (void *cls,
                     const struct GNUNET_PeerIdentity *target,
+                    unsigned int priority,
                     const struct GNUNET_MessageHeader *msg1,
                     const struct GNUNET_MessageHeader *msg2,
                     struct GNUNET_TIME_Relative timeout,
@@ -971,6 +973,7 @@ session_try_connect (void *cls,
  * @param service_context value passed to the transport-service
  *        to identify the neighbour
  * @param target who should receive this message
+ * @param priority how important is the message
  * @param msg the message to transmit
  * @param cont continuation to call once the message has
  *        been transmitted (or if the transport is ready
@@ -984,7 +987,8 @@ static void *
 tcp_plugin_send (void *cls,
                  void *plugin_context,
                  struct ReadyList *service_context,
-                 const struct GNUNET_PeerIdentity *target,
+                 const struct GNUNET_PeerIdentity *target,   
+                 unsigned int priority,
                  const struct GNUNET_MessageHeader *msg,
                  struct GNUNET_TIME_Relative timeout,
                  GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
diff --git a/src/transport/plugin_transport_template.c b/src/transport/plugin_transport_template.c
index 1c8b06c61..496e2cf78 100644
--- a/src/transport/plugin_transport_template.c
+++ b/src/transport/plugin_transport_template.c
@@ -139,6 +139,7 @@ struct Plugin
  *
  * @param cls closure
  * @param target who should receive this message
+ * @param priority how important is the message
  * @param msg1 first message to transmit
  * @param msg2 second message to transmit (can be NULL)
  * @param timeout how long until we give up?
@@ -150,6 +151,7 @@ struct Plugin
 static void *
 template_plugin_send_to (void *cls,
                          const struct GNUNET_PeerIdentity *target,
+                         unsigned int priority,
                          const struct GNUNET_MessageHeader *msg1,
                          const struct GNUNET_MessageHeader *msg2,
                          struct GNUNET_TIME_Relative timeout,
@@ -171,6 +173,7 @@ template_plugin_send_to (void *cls,
  * @param service_context value passed to the transport-service
  *        to identify the neighbour
  * @param target who should receive this message
+ * @param priority how important is the message
  * @param msg the message to transmit
  * @param cont continuation to call once the message has
  *        been transmitted (or if the transport is ready
@@ -185,6 +188,7 @@ template_plugin_send (void *cls,
                       void *plugin_context,
                       struct ReadyList *service_context,
                       const struct GNUNET_PeerIdentity *target,
+                      unsigned int priority,
                       const struct GNUNET_MessageHeader *msg,
                       struct GNUNET_TIME_Relative timeout,
                       GNUNET_TRANSPORT_TransmitContinuation cont,
diff --git a/src/transport/test_transport_api.c b/src/transport/test_transport_api.c
index 02c28b09c..6c4e94e04 100644
--- a/src/transport/test_transport_api.c
+++ b/src/transport/test_transport_api.c
@@ -204,7 +204,7 @@ exchange_hello_last (void *cls,
   /* both HELLOs exchanged, get ready to test transmission! */
   GNUNET_TRANSPORT_notify_transmit_ready (p1.th,
                                           &p2.id,
-                                          256, TIMEOUT, &notify_ready, &p1);
+                                          256, 0, TIMEOUT, &notify_ready, &p1);
 }
 
 
diff --git a/src/transport/transport.h b/src/transport/transport.h
index 8e1291005..13dcbb6b8 100644
--- a/src/transport/transport.h
+++ b/src/transport/transport.h
@@ -219,9 +219,9 @@ struct OutboundMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Always zero.
+   * Message priority.
    */
-  uint32_t reserved GNUNET_PACKED;
+  uint32_t priority GNUNET_PACKED;
 
   /**
    * Which peer should receive the message?
diff --git a/src/transport/transport_api.c b/src/transport/transport_api.c
index d38954445..92f8f1f5c 100644
--- a/src/transport/transport_api.c
+++ b/src/transport/transport_api.c
@@ -224,6 +224,11 @@ struct GNUNET_TRANSPORT_TransmitHandle
    */
   size_t notify_size;
 
+  /**
+   * How important is this message?
+   */
+  unsigned int priority;
+
 };
 
 
@@ -1737,7 +1742,7 @@ client_notify_wrapper (void *cls, size_t size, void *buf)
   ret += sizeof (struct OutboundMessage);
   obm->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND);
   obm->header.size = htons (ret);
-  obm->reserved = htonl (0);
+  obm->priority = htonl (ctw->th->priority);
   obm->peer = ctw->th->target;
   GNUNET_free (ctw);
   return ret;
@@ -1754,6 +1759,7 @@ client_notify_wrapper (void *cls, size_t size, void *buf)
  * @param handle connection to transport service
  * @param target who should receive the message
  * @param size how big is the message we want to transmit?
+ * @param priority how important is the message?
  * @param timeout after how long should we give up (and call
  *        notify with buf NULL and size 0)?
  * @param notify function to call when we are ready to
@@ -1768,6 +1774,7 @@ GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
                                         *handle,
                                         const struct GNUNET_PeerIdentity
                                         *target, size_t size,
+                                        unsigned int priority,
                                         struct GNUNET_TIME_Relative timeout,
                                         GNUNET_NETWORK_TransmitReadyNotify
                                         notify, void *notify_cls)
@@ -1798,12 +1805,13 @@ GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle
   ctw->notify_cls = notify_cls;
   ctw->th = th;
   th->handle = handle;
+  th->neighbour = n;
   th->target = *target;
   th->notify = &client_notify_wrapper;
   th->notify_cls = ctw;
-  th->notify_size = size + sizeof (struct OutboundMessage);
   th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
-  th->neighbour = n;
+  th->notify_size = size + sizeof (struct OutboundMessage);
+  th->priority = priority;
   if (NULL == n)
     {
       pos = handle->connect_wait_head;