/*
This file is part of GNUnet.
- (C) 2010-2015 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2010-2015 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
#include "gnunet_util_lib.h"
#include "gnunet_hello_lib.h"
-/**
- * Number of network types supported by ATS
- */
-#define GNUNET_ATS_NetworkTypeCount 6
-
-
/**
* Types of networks (with separate quotas) we support.
*/
* Bluetooth LAN
*/
GNUNET_ATS_NET_BT = 5
-};
-
/**
- * ATS network types as array initializer
+ * Number of network types supported by ATS
*/
-#define GNUNET_ATS_NetworkType { GNUNET_ATS_NET_UNSPECIFIED, GNUNET_ATS_NET_LOOPBACK, GNUNET_ATS_NET_LAN, GNUNET_ATS_NET_WAN, GNUNET_ATS_NET_WLAN, GNUNET_ATS_NET_BT }
+#define GNUNET_ATS_NetworkTypeCount 6
+};
/**
*/
#define GNUNET_ATS_MaxBandwidthString "unlimited"
-/**
- * Number of property types supported by ATS
- */
-#define GNUNET_ATS_PropertyCount 11
-
/**
- * Enum defining all known property types for ATS Enum values are used
- * in the GNUNET_ATS_Information struct as
- * (key,value)-pairs.
- *
- * Cost are always stored in uint32_t, so all units used to define costs
- * have to be normalized to fit in uint32_t [0 .. UINT32_MAX-1]
- *
- * UINT32_MAX is reserved for uninitialized values #GNUNET_ATS_VALUE_UNDEFINED
+ * ATS performance characteristics for an address.
*/
-enum GNUNET_ATS_Property
+struct GNUNET_ATS_Properties
{
- /**
- * End of the array.
- * @deprecated
- */
- GNUNET_ATS_ARRAY_TERMINATOR = 0,
-
/**
* Actual traffic on this connection from this peer to the other peer.
- * Includes transport overhead
+ * Includes transport overhead.
*
* Unit: [bytes/second]
*/
- GNUNET_ATS_UTILIZATION_OUT,
+ uint32_t utilization_out;
/**
* Actual traffic on this connection from the other peer to this peer.
- * Includes transport overhead
+ * Includes transport overhead.
*
* Unit: [bytes/second]
*/
- GNUNET_ATS_UTILIZATION_IN,
+ uint32_t utilization_in;
/**
- * Actual traffic on this connection from this peer to the other peer.
- * Only payload from layers > transport
- *
- * Unit: [bytes/second]
+ * Which network scope does the respective address belong to?
+ * This property does not change.
*/
- GNUNET_ATS_UTILIZATION_PAYLOAD_OUT,
+ enum GNUNET_ATS_Network_Type scope;
/**
- * Actual traffic on this connection from the other peer to this peer.
- * Only payload from layers > transport
- *
- * Unit: [bytes/second]
+ * Distance on network layer (required for distance-vector routing)
+ * in hops. Zero for direct connections (i.e. plain TCP/UDP).
*/
- GNUNET_ATS_UTILIZATION_PAYLOAD_IN,
+ unsigned int distance;
/**
- * Is this address located in WAN, LAN or a loopback address
- * Value is element of GNUNET_ATS_Network_Type
+ * Delay. Time between when the time packet is sent and the packet
+ * arrives. FOREVER if we did not measure yet.
*/
- GNUNET_ATS_NETWORK_TYPE,
+ struct GNUNET_TIME_Relative delay;
+
+};
+
+
+/**
+ * ATS performance characteristics for an address in
+ * network byte order (for IPC).
+ */
+struct GNUNET_ATS_PropertiesNBO
+{
/**
- * Delay
- * Time between when the time packet is sent and the packet arrives
- *
- * Unit: [microseconds]
- *
- * Examples:
+ * Actual traffic on this connection from this peer to the other peer.
+ * Includes transport overhead.
*
- * LAN : 1
- * WLAN : 2
- * Dialup: 500
+ * Unit: [bytes/second]
*/
- GNUNET_ATS_QUALITY_NET_DELAY,
+ uint32_t utilization_out GNUNET_PACKED;
/**
- * Distance on network layer (required for distance-vector routing).
+ * Actual traffic on this connection from the other peer to this peer.
+ * Includes transport overhead.
*
- * Unit: [DV-hops]
+ * Unit: [bytes/second]
*/
- GNUNET_ATS_QUALITY_NET_DISTANCE,
+ uint32_t utilization_in GNUNET_PACKED;
/**
- * Network overhead on WAN (Wide-Area Network)
- *
- * How many bytes are sent on the WAN when 1 kilobyte (1024 bytes)
- * of application data is transmitted?
- * A factor used with connect cost, bandwidth cost and energy cost
- * to describe the overhead produced by the transport protocol
- *
- * Unit: [bytes/kb]
- *
- * Interpretation: less is better
- *
- * Examples:
- *
- * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
- * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
- * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
- * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
+ * Which network scope does the respective address belong to?
+ * This property does not change.
*/
- GNUNET_ATS_COST_WAN,
+ uint32_t scope GNUNET_PACKED;
/**
- * Network overhead on LAN (Local-Area Network)
- *
- * How many bytes are sent on the LAN when 1 kilobyte (1024 bytes)
- * of application data is transmitted?
- * A factor used with connect cost, bandwidth cost and energy cost
- * to describe the overhead produced by the transport protocol
- *
- * Unit: [bytes/kb]
- *
- * Interpretation: less is better
- *
- * Examples:
- *
- * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
- * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
- * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
- * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
+ * Distance on network layer (required for distance-vector routing)
+ * in hops. Zero for direct connections (i.e. plain TCP/UDP).
*/
- GNUNET_ATS_COST_LAN,
+ uint32_t distance GNUNET_PACKED;
/**
- * Network overhead on WLAN (Wireless Local Area Network)
- *
- * How many bytes are sent on the LAN when 1 kilobyte (1024 bytes)
- * of application data is transmitted?
- * A factor used with connect cost, bandwidth cost and energy cost
- * to describe the overhead produced by the transport protocol
- *
- * Unit: [bytes/kb]
- *
- * Interpretation: less is better
- *
- * Examples:
- *
- * TCP/IPv4 over Ethernet: 1024 + 38 + 20 + 20 = 1102 [bytes/kb]
- * TCP/IPv6 over Ethernet: 1024 + 38 + 20 + 40 = 1122 [bytes/kb]
- * UDP/IPv4 over Ethernet: 1024 + 38 + 20 + 8 = 1090 [bytes/kb]
- * UDP/IPv6 over Ethernet: 1024 + 38 + 40 + 8 = 1110 [bytes/kb]
+ * Delay. Time between when the time packet is sent and the packet
+ * arrives. FOREVER if we did not measure yet.
*/
- GNUNET_ATS_COST_WLAN
+ struct GNUNET_TIME_RelativeNBO delay;
};
-/**
- * Number of ATS quality properties
- */
-#define GNUNET_ATS_QualityPropertiesCount 2
-
-/**
- * ATS quality properties as array initializer
- */
-#define GNUNET_ATS_QualityProperties { GNUNET_ATS_QUALITY_NET_DELAY, GNUNET_ATS_QUALITY_NET_DISTANCE }
-/**
- * ATS quality properties as string array initializer
- */
-#define GNUNET_ATS_QualityPropertiesString {"Delay", "Distance"}
+/* ********************* LAN Characterization library ************************ */
+/* Note: these functions do not really communicate with the ATS service */
-GNUNET_NETWORK_STRUCT_BEGIN
/**
- * struct used to communicate the transport's properties like cost and
- * quality of service as well as high-level constraints on resource
- * consumption.
- *
- * +---+
- * +-----------+ Constraints | | Plugin properties +---------+
- * | Highlevel |------------> |ATS| <------------------|Transport|
- * | Component | ATS struct | | ATS struct | Plugin |
- * +-----------+ | | +---------+
- * +---+
+ * Convert ATS properties from host to network byte order.
*
- * This structure will be used by transport plugins to communicate
- * costs to ATS or by higher level components to tell ATS their
- * constraints. Always a pair of (GNUNET_ATS_Property,
- * uint32_t value). Value is always uint32_t, so all units used to
- * define costs have to be normalized to fit uint32_t.
+ * @param nbo[OUT] value written
+ * @param hbo value read
*/
-struct GNUNET_ATS_Information
-{
- /**
- * ATS property type, in network byte order.
- */
- uint32_t type GNUNET_PACKED;
-
- /**
- * ATS property value, in network byte order.
- */
- uint32_t value GNUNET_PACKED;
-};
-GNUNET_NETWORK_STRUCT_END
+void
+GNUNET_ATS_properties_hton (struct GNUNET_ATS_PropertiesNBO *nbo,
+ const struct GNUNET_ATS_Properties *hbo);
-/* ********************* LAN Characterization library ************************ */
-/* Note: these functions do not really communicate with the ATS service */
-
/**
- * Convert a ATS property to a string
+ * Convert ATS properties from network to host byte order.
*
- * @param type the property type
- * @return a string or NULL if invalid
+ * @param hbo[OUT] value written
+ * @param nbo value read
*/
-const char *
-GNUNET_ATS_print_property_type (enum GNUNET_ATS_Property type);
+void
+GNUNET_ATS_properties_ntoh (struct GNUNET_ATS_Properties *hbo,
+ const struct GNUNET_ATS_PropertiesNBO *nbo);
+
/**
*
* @param ch handle
* @param peer identity of the peer we need an address for
+ * TODO: add argument to allow client to express 'strength's of request
* @return suggestion handle, NULL if request is already pending
- */
+ */
struct GNUNET_ATS_ConnectivitySuggestHandle *
GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch,
const struct GNUNET_PeerIdentity *peer);
/**
* Opaque session handle, defined by plugins. Contents not known to ATS.
+ * FIXME: This violates our naming conventions.
*/
struct Session;
* and address preferences as determined by ATS.
*
* @param cls closure
- * @param address suggested address (including peer identity of the peer)
+ * @param peer for which we suggest an address, NULL if ATS connection died
+ * @param address suggested address (including peer identity of the peer),
+ * may be NULL to signal disconnect from peer
* @param session session to use, NULL to establish a new outgoing session
* @param bandwidth_out assigned outbound bandwidth for the connection,
- * 0 to disconnect
+ * 0 to signal disconnect
* @param bandwidth_in assigned inbound bandwidth for the connection,
- * 0 to disconnect
+ * 0 to signal disconnect
*/
typedef void
(*GNUNET_ATS_AddressSuggestionCallback) (void *cls,
- const struct GNUNET_PeerIdentity *peer,
- const struct GNUNET_HELLO_Address *address,
- struct Session *session,
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_HELLO_Address *address,
+ struct Session *session,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
/**
GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
-/**
- * We would like to reset the address suggestion block time for this
- * peer.
- *
- * @param sh handle
- * @param peer identity of the peer we want to reset
- */
-void
-GNUNET_ATS_reset_backoff (struct GNUNET_ATS_SchedulingHandle *sh,
- const struct GNUNET_PeerIdentity *peer);
-
-
-/**
- * Test if a address and a session is known to ATS.
- *
- * @param sh the scheduling handle
- * @param address the address
- * @param session the session
- * @return #GNUNET_YES or #GNUNET_NO
- */
-int
-GNUNET_ATS_session_known (struct GNUNET_ATS_SchedulingHandle *sh,
- const struct GNUNET_HELLO_Address *address,
- struct Session *session);
-
-
/**
* Handle used within ATS to track an address.
*/
* @param sh handle
* @param address the address
* @param session session handle (if available, i.e. for incoming connections)
- * @param ats performance data for the address
- * @param ats_count number of performance records in @a ats
+ * @param prop performance data for the address
* @return handle to the address representation inside ATS, NULL
* on error (i.e. ATS knows this exact address already, or
* address is invalid)
GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
const struct GNUNET_HELLO_Address *address,
struct Session *session,
- const struct GNUNET_ATS_Information *ats,
- uint32_t ats_count);
+ const struct GNUNET_ATS_Properties *prop);
/**
* suggest to switch addresses.
*
* @param ar address record to update information for
- * @param ats performance data for the address
- * @param ats_count number of performance records in @a ats
+ * @param prop performance data for the address
*/
void
GNUNET_ATS_address_update (struct GNUNET_ATS_AddressRecord *ar,
- const struct GNUNET_ATS_Information *ats,
- uint32_t ats_count);
-
-
-/**
- * An address is now in use, or not used any more.
- *
- * @param ar address record for which to toggle the flag
- * @param in_use #GNUNET_YES if this address is now used, #GNUNET_NO
- * if address is not used any more
- */
-void
-GNUNET_ATS_address_set_in_use (struct GNUNET_ATS_AddressRecord *ar,
- int in_use);
+ const struct GNUNET_ATS_Properties *prop);
/**
* Signature of a function that is called with QoS information about an address.
*
* @param cls closure
- * @param address the address, NULL if ATS service was disconnected
+ * @param address the address, NULL if ATS service was disconnected or
+ * when the iteration is completed in the case of
+ * #GNUNET_ATS_performance_list_addresses()
* @param address_active #GNUNET_YES if this address is actively used
* to maintain a connection to a peer;
* #GNUNET_NO if the address is not actively used;
* #GNUNET_SYSERR if this address is no longer available for ATS
* @param bandwidth_out assigned outbound bandwidth for the connection
* @param bandwidth_in assigned inbound bandwidth for the connection
- * @param ats performance data for the address (as far as known)
- * @param ats_count number of performance records in @a ats
+ * @param prop performance data for the address
*/
typedef void
(*GNUNET_ATS_AddressInformationCallback) (void *cls,
int address_active,
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
- const struct GNUNET_ATS_Information *ats,
- uint32_t ats_count);
+ const struct GNUNET_ATS_Properties *prop);
/**
void *addr_info_cb_cls);
-
/**
* Get information about addresses known to the ATS subsystem.
*
* @param handle the performance handle to use
* @param peer peer idm can be NULL for all peers
- * @param all GNUNET_YES to get information about all addresses or GNUNET_NO to
+ * @param all #GNUNET_YES to get information about all addresses or #GNUNET_NO to
* get only address currently used
* @param infocb callback to call with the addresses,
* will callback with address == NULL when done
* @param infocb_cls closure for @a infocb
- * @return ats performance context
+ * @return handle to abort the operation
*/
struct GNUNET_ATS_AddressListHandle *
GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *handle,
*/
typedef void
(*GNUNET_ATS_ReservationCallback) (void *cls,
- const struct GNUNET_PeerIdentity * peer,
+ const struct GNUNET_PeerIdentity *peer,
int32_t amount,
struct GNUNET_TIME_Relative res_delay);
* @param amount reserve N bytes for receiving, negative
* amounts can be used to undo a (recent) reservation;
* @param rcb function to call with the resulting reservation information
- * @param rcb_cls closure for info
+ * @param rcb_cls closure for @a rcb
* @return NULL on error
* @deprecated will be replaced soon
*/
struct GNUNET_ATS_ReservationContext *
GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
- const struct GNUNET_PeerIdentity *peer, int32_t amount,
- GNUNET_ATS_ReservationCallback rcb, void *rcb_cls);
+ const struct GNUNET_PeerIdentity *peer,
+ int32_t amount,
+ GNUNET_ATS_ReservationCallback rcb,
+ void *rcb_cls);
/**
void
GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc);
+
/**
* Number of preference types supported by ATS
*/
/**
* ATS preference types as string array initializer
*/
-#define GNUNET_ATS_PreferenceTypeString {"END", "BANDWIDTH", "LATENCY"}
+#define GNUNET_ATS_PreferenceTypeString {"BANDWIDTH", "LATENCY", "END" }
/**
* Enum defining all known preference categories.
enum GNUNET_ATS_PreferenceKind
{
- /**
- * End of preference list.
- */
- GNUNET_ATS_PREFERENCE_END = 0,
-
/**
* Change the peer's bandwidth value (value per byte of bandwidth in
* the goal function) to the given amount. The argument is followed
* by a double value giving the desired value (can be negative).
* Preference changes are forgotten if peers disconnect.
*/
- GNUNET_ATS_PREFERENCE_BANDWIDTH,
+ GNUNET_ATS_PREFERENCE_BANDWIDTH = 0,
/**
* Change the peer's latency value to the given amount. The
* the inverse of the latency in microseconds (minimum: 1
* microsecond) multiplied by the latency preferences.
*/
- GNUNET_ATS_PREFERENCE_LATENCY
+ GNUNET_ATS_PREFERENCE_LATENCY = 1,
+
+ /**
+ * End of preference list.
+ */
+ GNUNET_ATS_PREFERENCE_END = 2
+
};
+
/**
* Convert a GNUNET_ATS_PreferenceType to a string
*
* @return a string or NULL if invalid
*/
const char *
-GNUNET_ATS_print_preference_type (uint32_t type);
+GNUNET_ATS_print_preference_type (enum GNUNET_ATS_PreferenceKind type);
/**
* Change preferences for the given peer. Preference changes are forgotten if peers
* disconnect.
*
- * @param ph performance handle
- * @param peer identifies the peer
- * @param ... 0-terminated specification of the desired changes
+ * @param ph performance handle @param peer identifies the peer
+ * @param ... #GNUNET_ATS_PREFERENCE_END-terminated specification of the
+ * desired changes
*/
void
GNUNET_ATS_performance_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
- const struct GNUNET_PeerIdentity *peer, ...);
+ const struct GNUNET_PeerIdentity *peer,
+ ...);
/**
* @param ph performance handle
* @param scope the time interval this valid for: [now - scope .. now]
* @param peer identifies the peer
- * @param ... 0-terminated specification of the desired changes
+ * @param ... #GNUNET_ATS_PREFERENCE_END-terminated specification of the desired changes
*/
void
GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
- const struct GNUNET_PeerIdentity *peer,
- const struct GNUNET_TIME_Relative scope, ...);
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_TIME_Relative scope,
+ ...);
#endif
/* end of file gnunet-service-transport_ats.h */
projects / oweals / gnunet.git / blobdiff