/*
This file is part of GNUnet.
- Copyright (C) 2010-2015 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2010-2015 GNUnet e.V.
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Affero General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
- * @file include/gnunet_ats_service.h
- * @brief automatic transport selection and outbound bandwidth determination
+ * @file
+ * Automatic transport selection and outbound bandwidth determination
+ *
* @author Christian Grothoff
* @author Matthias Wachs
+ *
+ * @defgroup ats ATS service
+ * Automatic Transport Selection and outbound bandwidth determination
+ *
+ * @see [Documentation](https://gnunet.org/ats-subsystem)
+ *
+ * @{
*/
#ifndef GNUNET_ATS_SERVICE_H
#define GNUNET_ATS_SERVICE_H
#include "gnunet_util_lib.h"
#include "gnunet_hello_lib.h"
-/**
- * Types of networks (with separate quotas) we support.
- */
-enum GNUNET_ATS_Network_Type
-{
- /**
- * Category of last resort.
- */
- GNUNET_ATS_NET_UNSPECIFIED = 0,
-
- /**
- * Loopback (same host).
- */
- GNUNET_ATS_NET_LOOPBACK = 1,
-
- /**
- * Local area network.
- */
- GNUNET_ATS_NET_LAN = 2,
-
- /**
- * Wide area network (i.e. Internet)
- */
- GNUNET_ATS_NET_WAN = 3,
-
- /**
- * Wireless LAN (i.e. 802.11abgn)
- */
- GNUNET_ATS_NET_WLAN = 4,
-
- /**
- * Bluetooth LAN
- */
- GNUNET_ATS_NET_BT = 5
-
-/**
- * Number of network types supported by ATS
- */
-#define GNUNET_ATS_NetworkTypeCount 6
-
-};
-
/**
* Default bandwidth assigned to a network : 64 KB/s
/**
- * 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
+ * Delay. Time between when the time packet is sent and the packet
+ * arrives. FOREVER if we did not measure yet.
*/
- GNUNET_ATS_ARRAY_TERMINATOR = 0,
+ struct GNUNET_TIME_Relative delay;
/**
* 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 = 1,
+ 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 = 2,
+ uint32_t utilization_in;
/**
- * Is this address located in WAN, LAN or a loopback address
- * Value is element of GNUNET_ATS_Network_Type
+ * Distance on network layer (required for distance-vector routing)
+ * in hops. Zero for direct connections (i.e. plain TCP/UDP).
*/
- GNUNET_ATS_NETWORK_TYPE = 3,
+ unsigned int distance;
/**
- * Delay
- * Time between when the time packet is sent and the packet arrives
- *
- * Unit: [microseconds]
- *
- * Examples:
- *
- * LAN : 1
- * WLAN : 2
- * Dialup: 500
+ * Which network scope does the respective address belong to?
+ * This property does not change.
*/
- GNUNET_ATS_QUALITY_NET_DELAY = 4,
-
- /**
- * Distance on network layer (required for distance-vector routing).
- *
- * Unit: [DV-hops]
- */
- GNUNET_ATS_QUALITY_NET_DISTANCE = 5
-
-/**
- * Number of property types supported by ATS
- */
-#define GNUNET_ATS_PropertyCount 6
-
+ enum GNUNET_NetworkType scope;
};
/**
- * Number of ATS quality properties
+ * ATS performance characteristics for an address in
+ * network byte order (for IPC).
*/
-#define GNUNET_ATS_QualityPropertiesCount 2
+struct GNUNET_ATS_PropertiesNBO
+{
-/**
- * ATS quality properties as array initializer
- */
-#define GNUNET_ATS_QualityProperties { GNUNET_ATS_QUALITY_NET_DELAY, GNUNET_ATS_QUALITY_NET_DISTANCE }
+ /**
+ * Actual traffic on this connection from this peer to the other peer.
+ * Includes transport overhead.
+ *
+ * Unit: [bytes/second]
+ */
+ uint32_t utilization_out GNUNET_PACKED;
-/**
- * ATS quality properties as string array initializer
- */
-#define GNUNET_ATS_QualityPropertiesString {"Delay", "Distance"}
+ /**
+ * Actual traffic on this connection from the other peer to this peer.
+ * Includes transport overhead.
+ *
+ * Unit: [bytes/second]
+ */
+ uint32_t utilization_in GNUNET_PACKED;
-GNUNET_NETWORK_STRUCT_BEGIN
+ /**
+ * Which network scope does the respective address belong to?
+ * This property does not change.
+ */
+ uint32_t scope GNUNET_PACKED;
-/**
- * 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 |
- * +-----------+ | | +---------+
- * +---+
- *
- * 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.
- */
-struct GNUNET_ATS_Information
-{
/**
- * ATS property type, in network byte order.
+ * Distance on network layer (required for distance-vector routing)
+ * in hops. Zero for direct connections (i.e. plain TCP/UDP).
*/
- uint32_t type GNUNET_PACKED;
+ uint32_t distance GNUNET_PACKED;
/**
- * ATS property value, in network byte order.
+ * Delay. Time between when the time packet is sent and the packet
+ * arrives. FOREVER if we did not measure yet.
*/
- uint32_t value GNUNET_PACKED;
+ struct GNUNET_TIME_RelativeNBO delay;
+
};
-GNUNET_NETWORK_STRUCT_END
+
/* ********************* LAN Characterization library ************************ */
/* Note: these functions do not really communicate with the ATS service */
-/**
- * Convert a ATS property to a string
- *
- * @param type the property type
- * @return a string or NULL if invalid
- */
-const char *
-GNUNET_ATS_print_property_type (enum GNUNET_ATS_Property type);
-
-
-/**
- * Convert a `enum GNUNET_ATS_Network_Type` to a string
- *
- * @param net the network type
- * @return a string or NULL if invalid
- */
-const char *
-GNUNET_ATS_print_network_type (enum GNUNET_ATS_Network_Type net);
-
-
-/**
- * Handle for the LAN Characterization library.
- */
-struct GNUNET_ATS_InterfaceScanner;
-
-
-/**
- * Returns where the address is located: loopback, LAN or WAN.
- *
- * @param is handle from #GNUNET_ATS_interface_scanner_init()
- * @param addr address
- * @param addrlen address length
- * @return type of the network the address belongs to
- */
-enum GNUNET_ATS_Network_Type
-GNUNET_ATS_scanner_address_get_type (struct GNUNET_ATS_InterfaceScanner *is,
- const struct sockaddr *addr,
- socklen_t addrlen);
-
/**
- * Initialize the ATS address characterization client handle.
+ * Convert ATS properties from host to network byte order.
*
- * @return scanner handle, NULL on error
+ * @param nbo[OUT] value written
+ * @param hbo value read
*/
-struct GNUNET_ATS_InterfaceScanner *
-GNUNET_ATS_scanner_init (void);
+void
+GNUNET_ATS_properties_hton (struct GNUNET_ATS_PropertiesNBO *nbo,
+ const struct GNUNET_ATS_Properties *hbo);
/**
- * Terminate interface scanner.
+ * Convert ATS properties from network to host byte order.
*
- * @param is scanner we are done with
+ * @param hbo[OUT] value written
+ * @param nbo value read
*/
void
-GNUNET_ATS_scanner_done (struct GNUNET_ATS_InterfaceScanner *is);
+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
+ * @param strength how urgent is the need for such a suggestion
* @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);
+ const struct GNUNET_PeerIdentity *peer,
+ uint32_t strength);
/**
/**
* Opaque session handle, defined by plugins. Contents not known to ATS.
*/
-struct Session;
+struct GNUNET_ATS_Session;
+
/**
* Signature of a function called by ATS with the current bandwidth
- * and address preferences as determined by ATS.
+ * and address preferences as determined by ATS. If our connection
+ * to ATS dies and thus all suggestions become invalid, this function
+ * is called ONCE with all arguments (except @a cls) being NULL/0.
*
* @param cls closure
* @param peer for which we suggest an address, NULL if ATS connection died
*/
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 GNUNET_ATS_Session *session,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
/**
GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh);
-/**
- * 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)
struct GNUNET_ATS_AddressRecord *
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);
+ struct GNUNET_ATS_Session *session,
+ const struct GNUNET_ATS_Properties *prop);
/**
*/
void
GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
- struct Session *session);
+ struct GNUNET_ATS_Session *session);
/**
- * A session was destroyed, disassociate it from the
- * given address record. If this was an incoming
- * addess, destroy the address as well.
+ * A @a session was destroyed, disassociate it from the given address
+ * record. If this was an incoming addess, destroys the address as
+ * well.
*
* @param ar address record to update information for
* @param session session handle
*/
int
GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar,
- struct Session *session);
+ struct GNUNET_ATS_Session *session);
/**
* 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);
+ 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 ph 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
* 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,
+GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *ph,
const struct GNUNET_PeerIdentity *peer,
int all,
GNUNET_ATS_AddressInformationCallback infocb,
/**
* Cancel a pending address listing operation
*
- * @param handle the `struct GNUNET_ATS_AddressListHandle` handle to cancel
+ * @param alh the `struct GNUNET_ATS_AddressListHandle` handle to cancel
*/
void
-GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *handle);
+GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandle *alh);
/**
void
GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc);
-/**
- * Number of preference types supported by ATS
- */
-#define GNUNET_ATS_PreferenceCount 3
/**
* ATS preference types as array initializer
*/
-#define GNUNET_ATS_PreferenceType {GNUNET_ATS_PREFERENCE_END, GNUNET_ATS_PREFERENCE_BANDWIDTH, GNUNET_ATS_PREFERENCE_LATENCY}
+#define GNUNET_ATS_PreferenceType {GNUNET_ATS_PREFERENCE_BANDWIDTH, GNUNET_ATS_PREFERENCE_LATENCY, GNUNET_ATS_PREFERENCE_END}
/**
* 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,
* @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,
...);
#endif
+
+/** @} */ /* end of group */
+
/* end of file gnunet-service-transport_ats.h */
projects / oweals / gnunet.git / blobdiff