/*
This file is part of GNUnet.
- (C) 2010,2011 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 Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
- 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.
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
#include "gnunet_statistics_service.h"
#include "gnunet_transport_service.h"
+#include "gnunet_transport_plugin.h"
+#include "gnunet-service-transport.h"
+#include "transport.h"
#include "gnunet_util_lib.h"
-// TODO:
-// - have a way to access the currently 'connected' session
-// (for sending and to notice disconnect of it!)
-// - have a way to access/update bandwidth/quota information per peer
-// (for CostReport/TrafficReport callbacks)
-
-
/**
* Initialize the neighbours subsystem.
*
- * @param cls closure for callbacks
- * @param connect_cb function to call if we connect to a peer
- * @param disconnect_cb function to call if we disconnect from a peer
+ * @param max_fds maximum number of fds to use
*/
-void
-GST_neighbours_start (void *cls,
- GNUNET_TRANSPORT_NotifyConnect connect_cb,
- GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
+void
+GST_neighbours_start (unsigned int max_fds);
/**
/**
- * Try to create a connection to the given target (eventually).
+ * Test if we're connected to the given peer.
*
- * @param target peer to try to connect to
+ * @param target peer to test
+ * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
+ */
+int
+GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
+
+
+/**
+ * Function called after the transmission is done.
+ *
+ * @param cls closure
+ * @param success #GNUNET_OK on success, #GNUNET_NO on failure, #GNUNET_SYSERR if we're not connected
+ * @param bytes_payload how much payload was transmitted
+ * @param bytes_on_wire how many bytes were used on the wire
+ */
+typedef void
+(*GST_NeighbourSendContinuation) (void *cls,
+ int success,
+ size_t bytes_payload,
+ size_t bytes_on_wire);
+
+
+/**
+ * Transmit a message to the given target using the active connection.
+ *
+ * @param target destination
+ * @param msg message to send
+ * @param msg_size number of bytes in @a msg
+ * @param timeout when to fail with timeout
+ * @param cont function to call when done
+ * @param cont_cls closure for @a cont
*/
void
-GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
+GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
+ const void *msg,
+ size_t msg_size,
+ struct GNUNET_TIME_Relative timeout,
+ GST_NeighbourSendContinuation cont, void *cont_cls);
/**
- * Test if we're connected to the given peer.
- *
- * @param target peer to test
- * @return GNUNET_YES if we are connected, GNUNET_NO if not
+ * We have received a message from the given sender.
+ * How long should we delay before receiving more?
+ * (Also used to keep the peer marked as live).
+ *
+ * @param sender sender of the message
+ * @param size size of the message
+ * @param do_forward set to #GNUNET_YES if the message should be forwarded to clients
+ * #GNUNET_NO if the neighbour is not connected or violates the quota
+ * @return how long to wait before reading more from this sender
*/
-int
-GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
+struct GNUNET_TIME_Relative
+GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity *sender,
+ ssize_t size,
+ int *do_forward);
+
+
+/**
+ * Keep the connection to the given neighbour alive longer,
+ * we received a KEEPALIVE (or equivalent); send a response.
+ *
+ * @param neighbour neighbour to keep alive (by sending keep alive response)
+ * @param m the keep alive message containing the nonce to respond to
+ */
+void
+GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour,
+ const struct GNUNET_MessageHeader *m);
+
+
+/**
+ * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
+ * latency to this peer. Pass the updated information (existing ats
+ * plus calculated latency) to ATS.
+ *
+ * @param neighbour neighbour to keep alive
+ * @param m the message containing the keep alive response
+ */
+void
+GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
+ const struct GNUNET_MessageHeader *m);
/**
/**
- * Function called for each connected neighbour.
+ * Function called for each neighbour.
*
* @param cls closure
- * @param neighbour identity of the neighbour
+ * @param peer identity of the neighbour
+ * @param address the address of the neighbour
+ * @param state current state the peer is in
+ * @param state_timeout timeout for this state
+ * @param bandwidth_in inbound quota in NBO
+ * @param bandwidth_out outbound quota in NBO
*/
-typedef void (*GST_NeighbourIterator)(void *cls,
- const struct GNUNET_PeerIdentity *neighbour);
+typedef void
+(*GST_NeighbourIterator) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_HELLO_Address *address,
+ enum GNUNET_TRANSPORT_PeerState state,
+ struct GNUNET_TIME_Absolute state_timeout,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
/**
* Iterate over all connected neighbours.
*
- * @param cb function to call
- * @param cb_cls closure for cb
+ * @param cb function to call
+ * @param cb_cls closure for @a cb
+ */
+void
+GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
+
+
+/**
+ * A session was terminated. Take note.
+ *
+ * @param peer identity of the peer where the session died
+ * @param session session that is gone
+ * @return #GNUNET_YES if this was a session used, #GNUNET_NO if
+ * this session was not in use
+ */
+int
+GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
+ struct GNUNET_ATS_Session *session);
+
+
+/**
+ * Track information about data we received from the
+ * given address (used to notify ATS about our utilization
+ * of allocated resources).
+ *
+ * @param address the address we got data from
+ * @param message the message we received (really only the size is used)
+ */
+void
+GST_neighbours_notify_data_recv (const struct GNUNET_HELLO_Address *address,
+ const struct GNUNET_MessageHeader *message);
+
+
+/**
+ * Track information about data we transmitted using the given @a
+ * address and @a session (used to notify ATS about our utilization of
+ * allocated resources).
+ *
+ * @param address the address we transmitted data to
+ * @param session session we used to transmit data
+ * @param message the message we sent (really only the size is used)
+ */
+void
+GST_neighbours_notify_data_sent (const struct GNUNET_HELLO_Address *address,
+ struct GNUNET_ATS_Session *session,
+ size_t size);
+
+
+/**
+ * For an existing neighbour record, set the active connection to
+ * use the given address.
+ *
+ * @param address address of the other peer to start using
+ * @param session session to use (or NULL)
+ * @param bandwidth_in inbound quota to be used when connection is up
+ * @param bandwidth_out outbound quota to be used when connection is up
*/
void
-GST_neighbours_iterate (GST_NeighbourIterator cb,
- void *cb_cls);
+GST_neighbours_switch_to_address (const struct GNUNET_HELLO_Address *address,
+ struct GNUNET_ATS_Session *session,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
/**
- * We have received a PONG. Update lifeness of the neighbour.
+ * We received a 'SESSION_CONNECT' message from the other peer.
+ * Consider switching to it.
*
- * @param sender peer sending the PONG
- * @param hdr the PONG message (presumably)
- * @param plugin_name name of transport that delivered the PONG
- * @param sender_address address of the other peer, NULL if other peer
- * connected to us
- * @param sender_address_len number of bytes in sender_address
- * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
+ * @param message possibly a 'struct GNUNET_ATS_SessionConnectMessage' (check format)
+ * @param peer identity of the peer to switch the address for
+ * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
*/
int
-GST_neighbours_handle_pong (const struct GNUNET_PeerIdentity *sender,
- const struct GNUNET_MessageHeader *hdr,
- const char *plugin_name,
- const void *sender_address,
- size_t sender_address_len);
+GST_neighbours_handle_session_syn (const struct GNUNET_MessageHeader *message,
+ const struct GNUNET_PeerIdentity *peer);
/**
- * We have received a CONNECT. Set the peer to connected.
+ * We received a 'SESSION_CONNECT_ACK' message from the other peer.
+ * Consider switching to it.
*
- * @param sender peer sending the PONG
- * @param hdr the PONG message (presumably)
- * @param plugin_name name of transport that delivered the PONG
- * @param sender_address address of the other peer, NULL if other peer
- * connected to us
- * @param sender_address_len number of bytes in sender_address
- * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
+ * @param message possibly a `struct GNUNET_ATS_SessionConnectMessage` (check format)
+ * @param address address of the other peer
+ * @param session session to use (or NULL)
+ * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
*/
int
-GST_neighbours_handle_connect (const struct GNUNET_PeerIdentity *sender,
- const struct GNUNET_MessageHeader *hdr,
- const char *plugin_name,
- const void *sender_address,
- size_t sender_address_len);
+GST_neighbours_handle_session_syn_ack (const struct GNUNET_MessageHeader *message,
+ const struct GNUNET_HELLO_Address *address,
+ struct GNUNET_ATS_Session *session);
/**
- * We have received a DISCONNECT. Set the peer to disconnected.
+ * We received a 'SESSION_ACK' message from the other peer.
+ * If we sent a 'CONNECT_ACK' last, this means we are now
+ * connected. Otherwise, do nothing.
*
- * @param sender peer sending the PONG
- * @param hdr the PONG message (presumably)
- * @param plugin_name name of transport that delivered the PONG
- * @param sender_address address of the other peer, NULL if other peer
- * connected to us
- * @param sender_address_len number of bytes in sender_address
- * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
+ * @param message possibly a 'struct GNUNET_ATS_SessionConnectMessage' (check format)
+ * @param address address of the other peer
+ * @param session session to use (or NULL)
+ * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
*/
int
-GST_neighbours_handle_disconnect (const struct GNUNET_PeerIdentity *sender,
- const struct GNUNET_MessageHeader *hdr,
- const char *plugin_name,
- const void *sender_address,
- size_t sender_address_len);
+GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
+ const struct GNUNET_HELLO_Address *address,
+ struct GNUNET_ATS_Session *session);
+
+
+/**
+ * Obtain current address information for the given neighbour.
+ *
+ * @param peer
+ * @return address currently used
+ */
+const struct GNUNET_HELLO_Address *
+GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
+
+
+/**
+ * We received a quoat message from the given peer,
+ * validate and process.
+ *
+ * @param peer sender of the message
+ * @param msg the quota message
+ */
+void
+GST_neighbours_handle_quota_message (const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_MessageHeader *msg);
+
+
+/**
+ * We received a disconnect message from the given peer,
+ * validate and process.
+ *
+ * @param peer sender of the message
+ * @param msg the disconnect message
+ */
+void
+GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_MessageHeader *msg);
#endif
projects / oweals / gnunet.git / blobdiff