/*
This file is part of GNUnet.
- (C) 2009 Christian Grothoff (and other contributing authors)
+ (C) 2009, 2010, 2011 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
#endif
#endif
-#include "gnunet_bandwidth_lib.h"
-#include "gnunet_configuration_lib.h"
-#include "gnunet_crypto_lib.h"
-#include "gnunet_connection_lib.h"
-#include "gnunet_scheduler_lib.h"
-#include "gnunet_time_lib.h"
+#include "gnunet_util_lib.h"
+#include "gnunet_ats_service.h"
/**
* Version number of the transport API.
#define GNUNET_TRANSPORT_VERSION 0x00000000
-/**
- * Enum defining all known property types for ATS Enum values are used
- * in the GNUNET_TRANSPORT_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 .. 4.294.967.295]
- *
- * To keep the elements ordered
- * 1..1024 : Values with a relation to cost
- * 1025..2048 : Values with a relation to quality
- * 2049..3072 : Values with a relation to availability
- *
- */
-enum GNUNET_TRANSPORT_ATS_Property
-{
-
- /**
- * End of the array.
- */
- GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR = 0,
-
- /* Cost related values */
- /* =================== */
-
- /**
- * Volume based cost in financial units to transmit data
- *
- * Note: This value is not bound to a specific currency or unit and only
- * used locally.
- * "cent" just refers the smallest amount of money in the respective
- * currency.
- *
- * Unit: [cent/MB]
- *
- * Interpretation: less is better
- *
- * Examples:
- * LAN: 0 [cent/MB]
- * 2G : 10 [cent/MB]
- */
- GNUNET_TRANSPORT_ATS_COST_FINANCIAL_PER_VOLUME = 1,
-
- /**
- * Time based cost in financial units to transmit data
- *
- * Note: This value is not bound to a specific currency or unit and only
- * used locally.
- * "cent" just refers the smallest amount of money in the respective
- * currency.
- *
- * Unit: [cent/h]
- *
- * Interpretation: less is better
- *
- * Examples:
- * LAN : 0 [cent/h]
- * Dialup: 10 [cent/h]
- */
- GNUNET_TRANSPORT_ATS_COST_FINANCIAL_PER_TIME = 2,
-
- /**
- * Computational costs
- *
- * Effort of preparing data to be sent with this transport
- * Includes encoding, encryption and conversion of data
- * Partial values can be summed up: c_sum = c_enc + c_enc + c_conv
- * Resulting values depend on local system properties, e.g. CPU
- *
- * Unit: [ms/GB]
- *
- * Interpretation: less is better
- *
- * Examples:
- *
- * HTTPS with AES CBC-256: 7,382
- * HTTPS with AES CBC-128: 5,279
- * HTTPS with RC4-1024: 2,652
- */
- GNUNET_TRANSPORT_ATS_COST_COMPUTATIONAL = 3,
-
- /**
- * Energy consumption
- *
- * Energy consumption using this transport when sending with a certain
- * power at a certain bitrate. This is only an approximation based on:
- * Energy consumption E = P / D
- *
- * with:
- * Power P in Watt (J/s)
- * Datarate D in MBit/s
- *
- * Conversion between power P and dBm used by WLAN in radiotap's dBm TX power:
- *
- * Lp(dbm) = 10 log10 (P/ 1mW)
- *
- * => P = 1 mW * 10^(Lp(dbm)/10)
- *
- * Unit: [mJ/MB]
- *
- * Interpretation: less is better
- *
- * Examples:
- *
- * LAN: 0
- * WLAN: 89 (600 mW @ 802.11g /w 54 MBit/s)
- * Bluetooth: 267 (100 mW @ BT2.0 EDR /w 3 MBit/s)
- */
- GNUNET_TRANSPORT_ATS_COST_ENERGY_CONSUMPTION = 4,
-
- /**
- * Connect cost
- * How many bytes are transmitted to initiate a new connection using
- * this transport?
- *
- * Unit: [bytes]
- *
- * Interpretation: less is better
- *
- * Examples:
- *
- * UDP (No connection) :
- * 0 bytes
- * TCP (TCP 3-Way handshake):
- * 220 bytes Ethernet, 172 bytes TCP/IP, 122 bytes TCP
- * HTTP (TCP + Header) :
- * 477 bytes Ethernet, 429 bytes TCP/IP, 374 bytes TCP, 278 bytes HTTP
- * HTTPS HTTP+TLS Handshake:
- * 2129 bytes Ethernet, 1975 bytes TCP/IP, 1755 bytes TCP, 1403 bytes HTTPS
- *
- * */
- GNUNET_TRANSPORT_ATS_COST_CONNECT = 5,
-
- /**
- * Bandwidth cost
- *
- * How many bandwidth is available to consume?
- * Used to calculate which impact sending data with this transport has
- *
- * Unit: [kB/s]
- *
- * Interpretation: more is better
- *
- * Examples:
- * LAN: 12,800 (100 MBit/s)
- * WLAN: 6,912 (54 MBit/s)
- * Dial-up: 8 (64 Kbit/s)
- *
- */
- GNUNET_TRANSPORT_ATS_COST_BANDWITH_AVAILABLE = 6,
-
- /**
- * Network overhead
- *
- * How many bytes are sent over the wire 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]
- */
- GNUNET_TRANSPORT_ATS_COST_NETWORK_OVERHEAD = 7,
-
-
- /* Quality related values */
- /* ====================== */
-
- /* Physical layer quality properties */
-
- /**
- * Signal strength on physical layer
- *
- * Unit: [dBm]
- */
- GNUNET_TRANSPORT_ATS_QUALITY_PHY_SIGNAL_STRENGTH = 1025,
-
- /**
- * Collision rate on physical layer
- *
- * Unit: [B/s]
- */
- GNUNET_TRANSPORT_ATS_QUALITY_PHY_COLLISION_RATE = 1026,
-
- /**
- * Error rate on physical layer
- *
- * Unit: [B/s]
- */
- GNUNET_TRANSPORT_ATS_QUALITY_PHY_ERROR_RATE = 1027,
-
- /* Network layer quality properties */
-
- /**
- * Delay
- * Time between when the time packet is sent and the packet arrives
- *
- * Unit: [ms]
- *
- * Examples:
- *
- * LAN : 1
- * WLAN : 2
- * Dialup: 500
- */
- GNUNET_TRANSPORT_ATS_QUALITY_NET_DELAY = 1028,
-
- /**
- * Jitter
- * Time variations of the delay
- * 1st derivative of a delay function
- *
- * Unit: [ms]
- */
- GNUNET_TRANSPORT_ATS_QUALITY_NET_JITTER = 1029,
-
- /**
- * Error rate on network layer
- *
- * Unit: [B/s]
- *
- * Examples:
- *
- * LAN : 0
- * WLAN : 400
- * Bluetooth : 100
- * Note: This numbers are just assumptions as an example, not
- * measured or somehow determined
- */
- GNUNET_TRANSPORT_ATS_QUALITY_NET_ERRORRATE = 1030,
-
- /**
- * Drop rate on network layer
- * Bytes actively dismissed by a network component during transmission
- * Reasons for dropped data can be full queues, congestion, quota violations...
- *
- * Unit: [B/s]
- *
- * Examples:
- *
- * LAN : 0
- * WLAN : 400
- * Bluetooth : 100
- * Note: This numbers are just assumptions as an example, not
- * measured or somehow determined
- */
- GNUNET_TRANSPORT_ATS_QUALITY_NET_DROPRATE = 1031,
-
- /**
- * Loss rate on network layer
- * Bytes lost during transmission
- * Reasons can be collisions, ...
- *
- * Unit: [B/s]
- *
- * Examples:
- *
- * LAN : 0
- * WLAN : 40
- * Bluetooth : 10
- * Note: This numbers are just assumptions as an example, not measured
- * or somehow determined
- */
- GNUNET_TRANSPORT_ATS_QUALITY_NET_LOSSRATE = 1032,
-
- /**
- * Throughput on network layer
- *
- * Unit: [kB/s]
- *
- * Examples:
- *
- * LAN : 3400
- * WLAN : 1200
- * Dialup: 4
- *
- */
- GNUNET_TRANSPORT_ATS_QUALITY_NET_THROUGHPUT = 1033,
-
- /**
- * Distance on network layer
- *
- * Unit: []
- */
- GNUNET_TRANSPORT_ATS_QUALITY_NET_DISTANCE = 1034,
-
-
- /* Availability related values */
- /* =========================== */
-
- /**
- * Is a peer reachable?
- */
- GNUNET_TRANSPORT_ATS_AVAILABILITY_REACHABLE = 2048,
-
- /**
- * Is there a connection established to a peer using this transport
- */
- GNUNET_TRANSPORT_ATS_AVAILABILITY_CONNECTED = 2049
-};
-
-
-/**
- * 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_TRANSPORT_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_TRANSPORT_ATS_Information
-{
- /**
- * ATS property type, in network byte order.
- */
- uint32_t type;
-
- /**
- * ATS property value, in network byte order.
- */
- uint32_t value;
-};
-
-
-
/**
* Function called by the transport for each received message.
*
* @param peer (claimed) identity of the other peer
* @param message the message
* @param ats performance data
- * @param ats_count number of entries in ats (excluding 0-termination)
+ * @param ats_count number of entries in ats
*/
typedef void (*GNUNET_TRANSPORT_ReceiveCallback) (void *cls,
const struct
GNUNET_MessageHeader *
message,
const struct
- GNUNET_TRANSPORT_ATS_Information
- * ats, uint32_t ats_count);
+ GNUNET_ATS_Information * ats,
+ uint32_t ats_count);
/**
const struct GNUNET_PeerIdentity
* peer,
const struct
- GNUNET_TRANSPORT_ATS_Information
- * ats, uint32_t ats_count);
+ GNUNET_ATS_Information * ats,
+ uint32_t ats_count);
/**
* Function called to notify transport users that another
/**
- * Function to call with a binary format of an address
+ * Function to call with a textual representation of an address.
+ * This function will be called several times with different possible
+ * textual representations, and a last time with NULL to signal the end
+ * of the iteration.
*
* @param cls closure
- * @param address NULL on error, otherwise 0-terminated printable UTF-8 string
+ * @param address NULL on error or end of iteration,
+ * otherwise 0-terminated printable UTF-8 string
*/
-typedef void (*GNUNET_TRANSPORT_AddressLookUpCallback) (void *cls,
- const char *address);
+typedef void (*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls,
+ const char *address);
/**
* Function to call with a binary format of an address
*
* @param cls closure
- * @param peer peer identity
- * @param transport transport plugin
- * @param addr address
- * @param addrlen address length
+ * @param peer peer this update is about (never NULL)
+ * @param address address, NULL for disconnect notification in monitor mode
*/
-typedef void (*GNUNET_TRANSPORT_AddressLookUpBinaryCallback) (void *cls,
- const struct
- GNUNET_PeerIdentity
- * peer,
- const char
- *transport,
- const void *addr,
- size_t addrlen);
+typedef void (*GNUNET_TRANSPORT_PeerIterateCallback) (void *cls,
+ const struct
+ GNUNET_PeerIdentity *
+ peer,
+ const struct
+ GNUNET_HELLO_Address *
+ address);
/**
const struct GNUNET_PeerIdentity *target);
-/**
- * Set the share of incoming/outgoing bandwidth for the given
- * peer to the specified amount.
- *
- * @param handle connection to transport service
- * @param target who's bandwidth quota is being changed
- * @param quota_in incoming bandwidth quota
- * @param quota_out outgoing bandwidth quota
- */
-void
-GNUNET_TRANSPORT_set_quota (struct GNUNET_TRANSPORT_Handle *handle,
- const struct GNUNET_PeerIdentity *target,
- struct GNUNET_BANDWIDTH_Value32NBO quota_in,
- struct GNUNET_BANDWIDTH_Value32NBO quota_out);
-
-
/**
* Opaque handle for a transmission-ready request.
*/
* @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 priority how important is the message? @deprecated - remove?
* @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
/**
* Handle to cancel a pending address lookup.
- */
-struct GNUNET_TRANSPORT_AddressLookupContext;
+ */
+struct GNUNET_TRANSPORT_AddressToStringContext;
/**
*
* @param cfg configuration to use
* @param address address to convert (binary format)
- * @param addressLen number of bytes in address
* @param numeric should (IP) addresses be displayed in numeric form
* (otherwise do reverse DNS lookup)
- * @param nameTrans name of the transport to which the address belongs
* @param timeout how long is the lookup allowed to take at most
* @param aluc function to call with the results
* @param aluc_cls closure for aluc
* @return handle to cancel the operation, NULL on error
*/
-struct GNUNET_TRANSPORT_AddressLookupContext *
-GNUNET_TRANSPORT_address_lookup (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const char *address, size_t addressLen,
- int numeric, const char *nameTrans,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_TRANSPORT_AddressLookUpCallback aluc,
- void *aluc_cls);
+struct GNUNET_TRANSPORT_AddressToStringContext *
+GNUNET_TRANSPORT_address_to_string (const struct GNUNET_CONFIGURATION_Handle
+ *cfg,
+ const struct GNUNET_HELLO_Address *address,
+ int numeric,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_TRANSPORT_AddressToStringCallback
+ aluc, void *aluc_cls);
/**
* @param alc handle for the request to cancel
*/
void
-GNUNET_TRANSPORT_address_lookup_cancel (struct GNUNET_TRANSPORT_AddressLookupContext *alc);
-
-
-/**
- * Handle to cancel a pending address lookup.
- */
-struct GNUNET_TRANSPORT_AddressLookupContext;
+GNUNET_TRANSPORT_address_to_string_cancel (struct
+ GNUNET_TRANSPORT_AddressToStringContext
+ *alc);
/**
- * Return all the known addresses for a peer. FIXME: document better!
- * FIXME: use better name!
+ * Return all the known addresses for a specific peer or all peers.
+ * Returns continuously all address if one_shot is set to GNUNET_NO
+ *
+ * CHANGE: Returns the address(es) that we are currently using for this
+ * peer. Upon completion, the 'AddressLookUpCallback' is called one more
+ * time with 'NULL' for the address and the peer. After this, the operation must no
+ * longer be explicitly cancelled.
*
* @param cfg configuration to use
- * @param peer peer identity to look up the addresses of
+ * @param peer peer identity to look up the addresses of, CHANGE: allow NULL for all (connected) peers
+ * @param one_shot GNUNET_YES to return the current state and then end (with NULL+NULL),
+ * GNUNET_NO to monitor the set of addresses used (continuously, must be explicitly canceled, NOT implemented yet!)
* @param timeout how long is the lookup allowed to take at most
* @param peer_address_callback function to call with the results
* @param peer_address_callback_cls closure for peer_address_callback
*/
-struct GNUNET_TRANSPORT_PeerAddressLookupContext *
-GNUNET_TRANSPORT_peer_address_lookup (const struct GNUNET_CONFIGURATION_Handle
- *cfg,
- const struct GNUNET_PeerIdentity *peer,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_TRANSPORT_AddressLookUpCallback
- peer_address_callback,
- void *peer_address_callback_cls);
+struct GNUNET_TRANSPORT_PeerIterateContext *
+GNUNET_TRANSPORT_peer_get_active_addresses (const struct
+ GNUNET_CONFIGURATION_Handle *cfg,
+ const struct GNUNET_PeerIdentity
+ *peer, int one_shot,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_TRANSPORT_PeerIterateCallback
+ peer_address_callback,
+ void *peer_address_callback_cls);
/**
* @param alc handle for the request to cancel
*/
void
-GNUNET_TRANSPORT_peer_address_lookup_cancel (struct GNUNET_TRANSPORT_PeerAddressLookupContext *alc);
-
-
-/**
- * Return all the known addresses. FIXME: document better!
- * FIXME: use better name! FIXME: extend API to allow cancellation!
- *
- * @param cfg configuration to use
- * @param timeout how long is the lookup allowed to take at most
- * @param peer_address_callback function to call with the results
- * @param peer_address_callback_cls closure for peer_address_callback
- */
-void
-GNUNET_TRANSPORT_address_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_TRANSPORT_AddressLookUpBinaryCallback
- peer_address_callback,
- void *peer_address_callback_cls);
+GNUNET_TRANSPORT_peer_get_active_addresses_cancel (struct
+ GNUNET_TRANSPORT_PeerIterateContext
+ *alc);
/**
*
* @param cls closure
* @param pid peer to approve or disapproave
- * @return GNUNET_OK if the connection is allowed
+ * @return GNUNET_OK if the connection is allowed, GNUNET_SYSERR if not
*/
typedef int (*GNUNET_TRANSPORT_BlacklistCallback) (void *cls,
const struct
projects / oweals / gnunet.git / blobdiff