error msg
[oweals/gnunet.git] / src / transport / transport.h
index dc9e7ce582bb795473f6603fab3de5836f1cbad1..be31f0ad67ae5be0b42e96e370e7e59fe6e924bb 100644 (file)
 #include "gnunet_crypto_lib.h"
 #include "gnunet_time_lib.h"
 #include "gnunet_transport_service.h"
+#include "gnunet_constants.h"
 
-/* Minimum time between to calculations*/
-#define ATS_MIN_INTERVAL  GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS,250)
-#define ATS_EXEC_INTERVAL GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS,1)
+#define DEBUG_TRANSPORT GNUNET_EXTRA_LOGGING
 
-#define DEBUG_ATS GNUNET_NO
-
-struct ATS_info
-{
-       struct GNUNET_CONTAINER_MultiHashMap * peers;
-       struct GNUNET_TIME_Absolute last;
-       struct GNUNET_TIME_Relative min_delta;
-       struct GNUNET_TIME_Relative reg_delta;
-
-       GNUNET_SCHEDULER_TaskIdentifier ats_task;
-};
-
-struct ATS_peer
-{
-       struct GNUNET_PeerIdentity peer;
-};
-
-#define DEBUG_TRANSPORT GNUNET_NO
-#define DEBUG_TRANSPORT_TIMEOUT GNUNET_NO
-#define DEBUG_TRANSPORT_DISCONNECT GNUNET_NO
 
 /**
  * For how long do we allow unused bandwidth
  * from the past to carry over into the future? (in seconds)
  */
-#define MAX_BANDWIDTH_CARRY_S 5
+#define MAX_BANDWIDTH_CARRY_S GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S
 
 /**
  * How often do we (at most) do a full quota
@@ -67,6 +46,44 @@ struct ATS_peer
  */
 #define MIN_QUOTA_REFRESH_TIME 2000
 
+/**
+ * What's the maximum number of sockets transport uses for validation and
+ * neighbors
+ */
+#define DEFAULT_MAX_FDS 256
+
+/**
+ * Maximum frequency for re-evaluating latencies for all transport addresses.
+ */
+#define LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
+
+/**
+ * Maximum frequency for re-evaluating latencies for connected addresses.
+ */
+#define CONNECTED_LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
+
+/**
+ * Similiar to GNUNET_TRANSPORT_NotifyDisconnect but in and out quotas are
+ * included here. These values are not required outside transport_api
+ *
+ * @param cls closure
+ * @param peer the peer that connected
+ * @param ats performance data
+ * @param ats_count number of entries in ats (excluding 0-termination)
+ * @param bandwidth_in inbound bandwidth in NBO
+ * @param bandwidth_out outbound bandwidth in NBO
+ *
+ */
+
+typedef void (*NotifyConnect) (void *cls,
+                              const struct GNUNET_PeerIdentity *peer,
+                              const struct GNUNET_ATS_Information *ats,
+                              uint32_t ats_count,
+                              struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+                              struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
+
+GNUNET_NETWORK_STRUCT_BEGIN
+
 /**
  * Message from the transport service to the library
  * asking to check if both processes agree about this
@@ -81,9 +98,11 @@ struct StartMessage
   struct GNUNET_MessageHeader header;
 
   /**
-   * Should the 'self' field be checked?
+   * 0: no options
+   * 1: The 'self' field should be checked
+   * 2: this client is interested in payload traffic
    */
-  uint32_t do_check;
+  uint32_t options;
 
   /**
    * Identity we think we have.  If it does not match, the
@@ -118,10 +137,14 @@ struct ConnectInfoMessage
   struct GNUNET_PeerIdentity id;
 
   /**
-   * First of the ATS information blocks (we must have at least
-   * one due to the 0-termination requirement).
+   * Current inbound quota for this peer
    */
-  struct GNUNET_TRANSPORT_ATS_Information ats;
+  struct GNUNET_BANDWIDTH_Value32NBO quota_in;
+
+  /**
+   * Current outbound quota for this peer
+   */
+  struct GNUNET_BANDWIDTH_Value32NBO quota_out;
 };
 
 
@@ -162,6 +185,11 @@ struct TransportRequestConnectMessage
    */
   struct GNUNET_MessageHeader header;
 
+  /**
+   * For alignment.
+   */
+  uint32_t reserved;
+
   /**
    * Identity of the peer we would like to connect to.
    */
@@ -169,15 +197,15 @@ struct TransportRequestConnectMessage
 };
 
 /**
- * Message used to set a particular bandwidth quota.  Send TO the
- * service to set an incoming quota, send FROM the service to update
+ * Message used to set a particular bandwidth quota.  Sent TO the
+ * service to set an incoming quota, sent FROM the service to update
  * an outgoing quota.
  */
 struct QuotaSetMessage
 {
 
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
+   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
    */
   struct GNUNET_MessageHeader header;
 
@@ -206,11 +234,6 @@ struct InboundMessage
    */
   struct GNUNET_MessageHeader header;
 
-  /**
-   * Always zero.
-   */
-  uint32_t reserved GNUNET_PACKED;
-
   /**
    * Number of ATS key-value pairs that follow this struct
    * (excluding the 0-terminator).
@@ -222,11 +245,6 @@ struct InboundMessage
    */
   struct GNUNET_PeerIdentity peer;
 
-  /**
-   * First of the ATS information blocks (we must have at least
-   * one due to the 0-termination requirement).
-   */
-  struct GNUNET_TRANSPORT_ATS_Information ats;
 };
 
 
@@ -250,6 +268,18 @@ struct SendOkMessage
    */
   uint32_t success GNUNET_PACKED;
 
+
+  /**
+   * Size of message sent
+   */
+  uint32_t bytes_msg GNUNET_PACKED;
+
+  /**
+   * Size of message sent over wire
+   * Includes plugin and protocol specific overhead
+   */
+  uint32_t bytes_physical GNUNET_PACKED;
+
   /**
    * Latency estimate.
    */
@@ -302,7 +332,7 @@ struct AddressLookupMessage
 {
 
   /**
-   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
+   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
    */
   struct GNUNET_MessageHeader header;
 
@@ -310,23 +340,143 @@ struct AddressLookupMessage
    * Should the conversion use numeric IP addresses (otherwise
    * a reverse DNS lookup is OK -- if applicable).
    */
-  int32_t numeric_only GNUNET_PACKED;
+  int16_t numeric_only GNUNET_PACKED;
+
+  /**
+   * Length of the (binary) address in bytes, in big-endian.
+   */
+  uint16_t addrlen GNUNET_PACKED;
 
   /**
    * timeout to give up.
    */
+  struct GNUNET_TIME_RelativeNBO timeout;
+
+  /* followed by 'addrlen' bytes of the actual address, then
+   * followed by the 0-terminated name of the transport */
+};
+
+
+/**
+ * Message from the library to the transport service
+ * asking for human readable addresses known for a peer.
+ */
+struct PeerAddressLookupMessage
+{
+  /**
+   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * For alignment.
+   */
+  uint32_t reserved;
+
+  /**
+   * timeout to give up.  FIXME: remove in the future.
+   */
+  struct GNUNET_TIME_RelativeNBO timeout;
+
+  /**
+   * The identity of the peer to look up.
+   */
+  struct GNUNET_PeerIdentity peer;
+};
+
+
+/**
+ * Message from the library to the transport service
+ * asking for binary addresses known for a peer.
+ */
+struct AddressIterateMessage
+{
+  /**
+   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * One shot call or continous replies?
+   */
+  uint32_t one_shot;
+
+  /**
+   * timeout to give up.  FIXME: remove in the future
+   */
   struct GNUNET_TIME_AbsoluteNBO timeout;
 
   /**
-   * Length of the (binary) address in bytes, in big-endian.
+   * The identity of the peer to look up.
    */
-  uint32_t addrlen GNUNET_PACKED;
+  struct GNUNET_PeerIdentity peer;
 
-  /* followed by 'addrlen' bytes of the actual address, then
-     followed by the 0-terminated name of the transport */
 };
 
 
+/**
+ * Message from the library to the transport service
+ * asking for binary addresses known for a peer.
+ */
+struct TrafficMetricMessage
+{
+  /**
+   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * SEND, RECEIVE or BOTH?
+   */
+  uint16_t direction;
+
+  /**
+   * Traffic metrics count
+   */
+  uint16_t ats_count;
+
+  /**
+   * The identity of the peer to look up.
+   */
+  struct GNUNET_PeerIdentity peer;
+};
+
+
+/**
+ * Message from the transport service to the library
+ * containing binary addresses known for a peer.
+ * Memory layout:
+ * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
+ */
+struct AddressIterateResponseMessage
+{
+  /**
+   * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE_RESPONSE
+   */
+  struct GNUNET_MessageHeader header;
+
+  /**
+   * For alignment.
+   */
+  uint32_t reserved;
+
+    /**
+   * Peer identity
+   */
+  struct GNUNET_PeerIdentity peer;
+
+  /**
+   * address length
+   */
+  uint32_t addrlen GNUNET_PACKED;
+
+  /**
+   * length of the plugin name
+   */
+  uint32_t pluginlen GNUNET_PACKED;
+
+};
+
 
 /**
  * Change in blacklisting (either request or notification,
@@ -353,7 +503,7 @@ struct BlacklistMessage
   struct GNUNET_PeerIdentity peer;
 
 };
-
+GNUNET_NETWORK_STRUCT_END
 
 /* end of transport.h */
 #endif