2 This file is part of GNUnet.
3 Copyright (C) 2010-2015 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file transport/gnunet-service-transport_neighbours.c
23 * @brief neighbour management
24 * @author Christian Grothoff
27 #include "gnunet_ats_service.h"
28 #include "gnunet-service-transport_ats.h"
29 #include "gnunet-service-transport_blacklist.h"
30 #include "gnunet-service-transport_clients.h"
31 #include "gnunet-service-transport_neighbours.h"
32 #include "gnunet-service-transport_manipulation.h"
33 #include "gnunet-service-transport_plugins.h"
34 #include "gnunet-service-transport_validation.h"
35 #include "gnunet-service-transport.h"
36 #include "gnunet_peerinfo_service.h"
37 #include "gnunet_constants.h"
38 #include "transport.h"
42 * Size of the neighbour hash map.
44 #define NEIGHBOUR_TABLE_SIZE 256
47 * Time we give plugin to transmit DISCONNECT message before the
48 * neighbour entry self-destructs.
50 #define DISCONNECT_SENT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 500)
53 * How often must a peer violate bandwidth quotas before we start
54 * to simply drop its messages?
56 #define QUOTA_VIOLATION_DROP_THRESHOLD 10
59 * How long are we willing to wait for a response from ATS before timing out?
61 #define ATS_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
64 * How long are we willing to wait for an ACK from the other peer before
65 * giving up on our connect operation?
67 #define SETUP_CONNECTION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
70 * How long are we willing to wait for a successful reconnect if
71 * an existing connection went down? Much shorter than the
72 * usual SETUP_CONNECTION_TIMEOUT as we do not inform the
73 * higher layers about the disconnect during this period.
75 #define FAST_RECONNECT_TIMEOUT GNUNET_TIME_UNIT_SECONDS
78 * Interval to send utilization data
80 #define UTIL_TRANSMISSION_INTERVAL GNUNET_TIME_UNIT_SECONDS
83 * State describing which kind a reply this neighbour should send
88 * We did not receive a SYN message for this neighbour
93 * The neighbour received a SYN message and has to send a SYN_ACK
99 * The neighbour sent a SYN_ACK message and has to send a ACK
106 GNUNET_NETWORK_STRUCT_BEGIN
109 * Message a peer sends to another to indicate that it intends to
110 * setup a connection/session for data exchange. A 'SESSION_SYN'
111 * should be answered with a 'SESSION_SYN_ACK' with the same body
112 * to confirm. A 'SESSION_SYN_ACK' should then be followed with
113 * a 'ACK'. Once the 'ACK' is received, both peers
114 * should be connected.
116 struct TransportSynMessage
119 * Header of type #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN
120 * or #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN_ACK
122 struct GNUNET_MessageHeader header;
127 uint32_t reserved GNUNET_PACKED;
130 * Absolute time at the sender. Only the most recent connect
131 * message implies which session is preferred by the sender.
133 struct GNUNET_TIME_AbsoluteNBO timestamp;
139 * Message a peer sends to another when connected to indicate that a
140 * session is in use and the peer is still alive or to respond to a keep alive.
141 * A peer sends a message with type #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE
142 * to request a message with #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE.
143 * When the keep alive response with type is received, transport service
144 * will call the respective plugin to update the session timeout
146 struct SessionKeepAliveMessage
149 * Header of type #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE or
150 * #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE.
152 struct GNUNET_MessageHeader header;
155 * A nonce to identify the session the keep alive is used for
157 uint32_t nonce GNUNET_PACKED;
161 * Message we send to the other peer to notify him that we intentionally
162 * are disconnecting (to reduce timeouts). This is just a friendly
163 * notification, peers must not rely on always receiving disconnect
166 struct SessionDisconnectMessage
169 * Header of type #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT
171 struct GNUNET_MessageHeader header;
176 uint32_t reserved GNUNET_PACKED;
179 * Purpose of the signature. Extends over the timestamp.
180 * Purpose should be #GNUNET_SIGNATURE_PURPOSE_TRANSPORT_DISCONNECT.
182 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
185 * Absolute time at the sender. Only the most recent connect
186 * message implies which session is preferred by the sender.
188 struct GNUNET_TIME_AbsoluteNBO timestamp;
191 * Public key of the sender.
193 struct GNUNET_CRYPTO_EddsaPublicKey public_key;
196 * Signature of the peer that sends us the disconnect. Only
197 * valid if the timestamp is AFTER the timestamp from the
198 * corresponding 'SYN' message.
200 struct GNUNET_CRYPTO_EddsaSignature signature;
204 GNUNET_NETWORK_STRUCT_END
208 * For each neighbour we keep a list of messages
209 * that we still want to transmit to the neighbour.
215 * This is a doubly linked list.
217 struct MessageQueue *next;
220 * This is a doubly linked list.
222 struct MessageQueue *prev;
225 * Function to call once we're done.
227 GST_NeighbourSendContinuation cont;
230 * Closure for @e cont
235 * The message(s) we want to transmit, GNUNET_MessageHeader(s)
236 * stuck together in memory. Allocated at the end of this struct.
238 const char *message_buf;
241 * Size of the message buf
243 size_t message_buf_size;
246 * At what time should we fail?
248 struct GNUNET_TIME_Absolute timeout;
254 * A possible address we could use to communicate with a neighbour.
256 struct NeighbourAddress
260 * Active session for this address.
262 struct Session *session;
265 * Network-level address information.
267 struct GNUNET_HELLO_Address *address;
270 * Timestamp of the 'SESSION_CONNECT' message we sent to the other
271 * peer for this address. Use to check that the ACK is in response
272 * to our most recent 'SYN'.
274 struct GNUNET_TIME_Absolute connect_timestamp;
277 * Inbound bandwidth from ATS for this address.
279 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
282 * Outbound bandwidth from ATS for this address.
284 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
287 * Did we tell ATS that this is our 'active' address?
292 * The current nonce sent in the last keep alive messages
294 uint32_t keep_alive_nonce;
299 * Entry in neighbours.
301 struct NeighbourMapEntry
305 * Head of list of messages we would like to send to this peer;
306 * must contain at most one message per client.
308 struct MessageQueue *messages_head;
311 * Tail of list of messages we would like to send to this peer; must
312 * contain at most one message per client.
314 struct MessageQueue *messages_tail;
317 * Are we currently trying to send a message? If so, which one?
319 struct MessageQueue *is_active;
322 * Primary address we currently use to communicate with the neighbour.
324 struct NeighbourAddress primary_address;
327 * Alternative address currently under consideration for communicating
328 * with the neighbour.
330 struct NeighbourAddress alternative_address;
333 * Identity of this neighbour.
335 struct GNUNET_PeerIdentity id;
338 * Main task that drives this peer (timeouts, keepalives, etc.).
339 * Always runs the 'master_task'.
341 struct GNUNET_SCHEDULER_Task *task;
344 * Task to disconnect neighbour after we received a DISCONNECT message
346 struct GNUNET_SCHEDULER_Task *delayed_disconnect_task;
349 * At what time should we sent the next keep-alive message?
351 struct GNUNET_TIME_Absolute keep_alive_time;
354 * At what time did we sent the last keep-alive message? Used
355 * to calculate round-trip time ("latency").
357 struct GNUNET_TIME_Absolute last_keep_alive_time;
360 * Timestamp we should include in our next SYN_ACK message.
361 * (only valid if 'send_connect_ack' is #GNUNET_YES). Used to build
362 * our SYN_ACK message.
364 struct GNUNET_TIME_Absolute connect_ack_timestamp;
367 * ATS address suggest handle
369 struct GNUNET_ATS_ConnectivitySuggestHandle *suggest_handle;
372 * Time where we should cut the connection (timeout) if we don't
373 * make progress in the state machine (or get a KEEPALIVE_RESPONSE
374 * if we are in #S_CONNECTED).
376 struct GNUNET_TIME_Absolute timeout;
379 * Tracker for inbound bandwidth.
381 struct GNUNET_BANDWIDTH_Tracker in_tracker;
384 * How often has the other peer (recently) violated the inbound
385 * traffic limit? Incremented by 10 per violation, decremented by 1
386 * per non-violation (for each time interval).
388 unsigned int quota_violation_count;
391 * The current state of the peer.
393 enum GNUNET_TRANSPORT_PeerState state;
396 * Did we sent an KEEP_ALIVE message and are we expecting a response?
398 int expect_latency_response;
401 * When a peer wants to connect we have to reply to the 1st SYN message
402 * with a SYN_ACK message. But sometime we cannot send this message
403 * immediately since we do not have an address and then we have to remember
404 * to send this message as soon as we have an address.
406 * Flag to set if we still need to send a SYN_ACK message to the other peer
407 * (once we have an address to use and the peer has been allowed by our
408 * blacklist). Initially set to #ACK_UNDEFINED. Set to #ACK_SEND_SYN_ACK
409 * if we need to send a SYN_ACK. Set to #ACK_SEND_ACK if we did
410 * send a SYN_ACK and should go to #S_CONNECTED upon receiving a
411 * 'ACK' (regardless of what our own state machine might say).
413 enum GST_ACK_State ack_state;
416 * Tracking utilization of outbound bandwidth
418 uint32_t util_total_bytes_sent;
421 * Tracking utilization of inbound bandwidth
423 uint32_t util_total_bytes_recv;
426 * Date of last utilization transmission
428 struct GNUNET_TIME_Absolute last_util_transmission;
433 * Context for blacklist checks and the #try_connect_bl_check_cont()
434 * function. Stores information about ongoing blacklist checks.
436 struct BlackListCheckContext
440 * We keep blacklist checks in a DLL.
442 struct BlackListCheckContext *next;
445 * We keep blacklist checks in a DLL.
447 struct BlackListCheckContext *prev;
450 * Address that is being checked.
452 struct NeighbourAddress na;
455 * Handle to the ongoing blacklist check.
457 struct GST_BlacklistCheck *bc;
462 * Hash map from peer identities to the respective `struct NeighbourMapEntry`.
464 static struct GNUNET_CONTAINER_MultiPeerMap *neighbours;
467 * We keep blacklist checks in a DLL so that we can find
468 * the 'sessions' in their 'struct NeighbourAddress' if
469 * a session goes down.
471 static struct BlackListCheckContext *bc_head;
474 * We keep blacklist checks in a DLL.
476 static struct BlackListCheckContext *bc_tail;
479 * List of pending blacklist checks: head
481 static struct BlacklistCheckSwitchContext *pending_bc_head;
484 * List of pending blacklist checks: tail
486 static struct BlacklistCheckSwitchContext *pending_bc_tail;
489 * counter for connected neighbours
491 static unsigned int neighbours_connected;
494 * Number of bytes we have currently queued for transmission.
496 static unsigned long long bytes_in_send_queue;
499 * Task transmitting utilization data
501 static struct GNUNET_SCHEDULER_Task *util_transmission_tk;
505 * Convert the given ACK state to a string.
508 * @return corresponding human-readable string
511 print_ack_state (enum GST_ACK_State s)
516 case ACK_SEND_SYN_ACK:
517 return "SEND_SYN_ACK";
528 * Notify our clients that another peer connected to us.
530 * @param peer the peer that connected
531 * @param bandwidth_in inbound bandwidth in NBO
532 * @param bandwidth_out outbound bandwidth in NBO
535 neighbours_connect_notification (const struct GNUNET_PeerIdentity *peer,
536 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
537 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
539 size_t len = sizeof(struct ConnectInfoMessage);
540 char buf[len] GNUNET_ALIGN;
541 struct ConnectInfoMessage *connect_msg = (struct ConnectInfoMessage *) buf;
543 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
544 "We are now connected to peer `%s'\n",
546 connect_msg->header.size = htons (sizeof(buf));
547 connect_msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
548 connect_msg->id = *peer;
549 connect_msg->quota_in = bandwidth_in;
550 connect_msg->quota_out = bandwidth_out;
551 GST_clients_broadcast (&connect_msg->header, GNUNET_NO);
556 * Notify our clients (and manipulation) that a peer disconnected from
559 * @param peer the peer that disconnected
562 neighbours_disconnect_notification (const struct GNUNET_PeerIdentity *peer)
564 struct DisconnectInfoMessage disconnect_msg;
566 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
567 "Peer `%s' disconnected\n",
569 GST_manipulation_peer_disconnect (peer);
570 disconnect_msg.header.size = htons (sizeof(struct DisconnectInfoMessage));
571 disconnect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
572 disconnect_msg.reserved = htonl (0);
573 disconnect_msg.peer = *peer;
574 GST_clients_broadcast (&disconnect_msg.header,
580 * Notify transport clients that a neighbour peer changed its active
583 * @param peer identity of the peer
584 * @param address address possibly NULL if peer is not connected
585 * @param state current state this peer is in
586 * @param state_timeout timeout for the current state of the peer
587 * @param bandwidth_in bandwidth assigned inbound, 0 on disconnect
588 * @param bandwidth_out bandwidth assigned outbound, 0 on disconnect
591 neighbours_changed_notification (const struct GNUNET_PeerIdentity *peer,
592 const struct GNUNET_HELLO_Address *address,
593 enum GNUNET_TRANSPORT_PeerState state,
594 struct GNUNET_TIME_Absolute state_timeout,
595 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
596 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
598 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
599 "Notifying about change for peer `%s' with address `%s' in state `%s' timing out at %s\n",
601 GST_plugins_a2s (address),
602 GNUNET_TRANSPORT_ps2s (state),
603 GNUNET_STRINGS_absolute_time_to_string (state_timeout));
604 /* FIXME: include bandwidth in notification! */
605 GST_clients_broadcast_peer_notification (peer,
613 * Lookup a neighbour entry in the neighbours hash map.
615 * @param pid identity of the peer to look up
616 * @return the entry, NULL if there is no existing record
618 static struct NeighbourMapEntry *
619 lookup_neighbour (const struct GNUNET_PeerIdentity *pid)
621 if (NULL == neighbours)
623 return GNUNET_CONTAINER_multipeermap_get (neighbours, pid);
628 * Test if we're connected to the given peer.
630 * @param n neighbour entry of peer to test
631 * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
634 test_connected (struct NeighbourMapEntry *n)
638 return GNUNET_TRANSPORT_is_connected (n->state);
643 * Send information about a new outbound quota to our clients.
645 * @param target affected peer
646 * @param quota new quota
649 send_outbound_quota (const struct GNUNET_PeerIdentity *target,
650 struct GNUNET_BANDWIDTH_Value32NBO quota)
652 struct QuotaSetMessage q_msg;
654 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
655 "Sending outbound quota of %u Bps for peer `%s' to all clients\n",
656 ntohl (quota.value__),
657 GNUNET_i2s (target));
658 q_msg.header.size = htons (sizeof (struct QuotaSetMessage));
659 q_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
661 q_msg.peer = (*target);
662 GST_clients_broadcast (&q_msg.header, GNUNET_NO);
667 * We don't need a given neighbour address any more.
668 * Release its resources and give appropriate notifications
669 * to ATS and other subsystems.
671 * @param na address we are done with; @a na itself must NOT be 'free'd, only the contents!
674 free_address (struct NeighbourAddress *na)
676 if (GNUNET_YES == na->ats_active)
677 GST_validation_set_address_use (na->address,
679 if (NULL != na->address)
681 GST_ats_block_address (na->address,
683 GNUNET_HELLO_address_free (na->address);
686 na->bandwidth_in = GNUNET_BANDWIDTH_value_init (0);
687 na->bandwidth_out = GNUNET_BANDWIDTH_value_init (0);
688 na->ats_active = GNUNET_NO;
689 na->keep_alive_nonce = 0;
695 * Master task run for every neighbour. Performs all of the time-related
696 * activities (keep alive, send next message, disconnect if idle, finish
697 * clean up after disconnect).
699 * @param cls the `struct NeighbourMapEntry` for which we are running
700 * @param tc scheduler context (unused)
703 master_task (void *cls,
704 const struct GNUNET_SCHEDULER_TaskContext *tc);
708 * Set net state and state timeout for this neighbour and notify monitoring
710 * @param n the respective neighbour
711 * @param s the new state
712 * @param timeout the new timeout
715 set_state_and_timeout (struct NeighbourMapEntry *n,
716 enum GNUNET_TRANSPORT_PeerState s,
717 struct GNUNET_TIME_Absolute timeout)
719 if (GNUNET_TRANSPORT_is_connected (s) &&
720 ! GNUNET_TRANSPORT_is_connected (n->state) )
722 neighbours_connect_notification (&n->id,
723 n->primary_address.bandwidth_in,
724 n->primary_address.bandwidth_out);
725 GNUNET_STATISTICS_set (GST_stats,
726 gettext_noop ("# peers connected"),
727 ++neighbours_connected,
730 if (! GNUNET_TRANSPORT_is_connected (s) &&
731 GNUNET_TRANSPORT_is_connected (n->state) )
733 GNUNET_STATISTICS_set (GST_stats,
734 gettext_noop ("# peers connected"),
735 --neighbours_connected,
737 neighbours_disconnect_notification (&n->id);
740 if ( (timeout.abs_value_us < n->timeout.abs_value_us) &&
743 /* new timeout is earlier, reschedule master task */
744 GNUNET_SCHEDULER_cancel (n->task);
745 n->task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (timeout),
749 n->timeout = timeout;
750 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
751 "Neighbour `%s' changed state to %s with timeout %s\n",
753 GNUNET_TRANSPORT_ps2s(s),
754 GNUNET_STRINGS_absolute_time_to_string (timeout));
755 neighbours_changed_notification (&n->id,
756 n->primary_address.address,
759 n->primary_address.bandwidth_in,
760 n->primary_address.bandwidth_out);
765 * Initialize the alternative address of a neighbour
767 * @param n the neighbour
768 * @param address address of the other peer, NULL if other peer
770 * @param session session to use (or NULL, in which case an
771 * address must be setup)
772 * @param bandwidth_in inbound quota to be used when connection is up
773 * @param bandwidth_out outbound quota to be used when connection is up
776 set_alternative_address (struct NeighbourMapEntry *n,
777 const struct GNUNET_HELLO_Address *address,
778 struct Session *session,
779 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
780 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
782 struct GNUNET_TRANSPORT_PluginFunctions *papi;
784 if (NULL == (papi = GST_plugins_find (address->transport_name)))
789 if (session == n->alternative_address.session)
791 n->alternative_address.bandwidth_in = bandwidth_in;
792 n->alternative_address.bandwidth_out = bandwidth_out;
795 if (NULL != n->alternative_address.address)
797 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
798 "Replacing existing alternative address with another one\n");
799 free_address (&n->alternative_address);
802 session = papi->get_session (papi->cls,
806 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
807 "Failed to obtain new session for peer `%s' and address '%s'\n",
808 GNUNET_i2s (&address->peer),
809 GST_plugins_a2s (address));
810 GNUNET_STATISTICS_update (GST_stats,
811 gettext_noop ("# session creation failed"),
816 GST_ats_new_session (address,
818 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
819 "Neighbour `%s' configured alternative address %s\n",
821 GST_plugins_a2s(address));
823 n->alternative_address.address = GNUNET_HELLO_address_copy (address);
824 n->alternative_address.bandwidth_in = bandwidth_in;
825 n->alternative_address.bandwidth_out = bandwidth_out;
826 n->alternative_address.session = session;
827 n->alternative_address.ats_active = GNUNET_NO;
828 n->alternative_address.keep_alive_nonce = 0;
833 * Initialize the primary address of a neighbour
835 * @param n the neighbour
836 * @param address address of the other peer, NULL if other peer
838 * @param session session to use (or NULL, in which case an
839 * address must be setup)
840 * @param bandwidth_in inbound quota to be used when connection is up
841 * @param bandwidth_out outbound quota to be used when connection is up
844 set_primary_address (struct NeighbourMapEntry *n,
845 const struct GNUNET_HELLO_Address *address,
846 struct Session *session,
847 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
848 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
850 if (session == n->primary_address.session)
852 GST_validation_set_address_use (n->primary_address.address,
854 if (n->primary_address.bandwidth_in.value__ != bandwidth_in.value__)
856 n->primary_address.bandwidth_in = bandwidth_in;
857 GST_neighbours_set_incoming_quota (&address->peer,
860 if (n->primary_address.bandwidth_out.value__ != bandwidth_out.value__)
862 n->primary_address.bandwidth_out = bandwidth_out;
863 send_outbound_quota (&address->peer,
868 if ( (NULL != n->primary_address.address) &&
869 (0 == GNUNET_HELLO_address_cmp (address,
870 n->primary_address.address)) )
878 GST_ats_block_address (address,
882 if (NULL != n->primary_address.address)
884 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
885 "Replacing existing primary address with another one\n");
886 free_address (&n->primary_address);
888 n->primary_address.address = GNUNET_HELLO_address_copy (address);
889 n->primary_address.bandwidth_in = bandwidth_in;
890 n->primary_address.bandwidth_out = bandwidth_out;
891 n->primary_address.session = session;
892 n->primary_address.keep_alive_nonce = 0;
893 /* subsystems about address use */
894 GST_validation_set_address_use (n->primary_address.address,
896 GST_neighbours_set_incoming_quota (&address->peer,
898 send_outbound_quota (&address->peer,
900 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
901 "Neighbour `%s' switched to address `%s'\n",
903 GST_plugins_a2s(address));
905 neighbours_changed_notification (&n->id,
906 n->primary_address.address,
909 n->primary_address.bandwidth_in,
910 n->primary_address.bandwidth_out);
915 * Clear the primary address of a neighbour since this address is not
916 * valid anymore and notify monitoring about it
918 * @param n the neighbour
921 unset_primary_address (struct NeighbourMapEntry *n)
923 /* Notify monitoring about change */
924 if (NULL == n->primary_address.address)
926 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
927 "Disabling primary address\n");
928 neighbours_changed_notification (&n->id,
929 n->primary_address.address,
932 GNUNET_BANDWIDTH_value_init (0),
933 GNUNET_BANDWIDTH_value_init (0));
934 free_address (&n->primary_address);
939 * Free a neighbour map entry.
941 * @param n entry to free
944 free_neighbour (struct NeighbourMapEntry *n)
946 struct MessageQueue *mq;
948 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
949 "Freeing neighbour state of peer `%s'\n",
950 GNUNET_i2s (&n->id));
951 n->is_active = NULL; /* always free'd by its own continuation! */
953 /* fail messages currently in the queue */
954 while (NULL != (mq = n->messages_head))
956 GNUNET_CONTAINER_DLL_remove (n->messages_head,
959 if (NULL != mq->cont)
960 mq->cont (mq->cont_cls,
962 mq->message_buf_size,
966 /* Mark peer as disconnected */
967 set_state_and_timeout (n,
968 GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED,
969 GNUNET_TIME_UNIT_FOREVER_ABS);
970 /* free addresses and mark as unused */
971 unset_primary_address (n);
973 if (NULL != n->alternative_address.address)
975 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
976 "Cleaning up alternative address\n");
977 free_address (&n->alternative_address);
979 GNUNET_assert (GNUNET_YES ==
980 GNUNET_CONTAINER_multipeermap_remove (neighbours,
983 /* Cancel address requests for this peer */
984 if (NULL != n->suggest_handle)
986 GNUNET_ATS_connectivity_suggest_cancel (n->suggest_handle);
987 n->suggest_handle = NULL;
990 /* Cancel the disconnect task */
991 if (NULL != n->delayed_disconnect_task)
993 GNUNET_SCHEDULER_cancel (n->delayed_disconnect_task);
994 n->delayed_disconnect_task = NULL;
997 /* Cancel the master task */
1000 GNUNET_SCHEDULER_cancel (n->task);
1003 /* free rest of memory */
1009 * Transmit a message using the current session of the given
1012 * @param n entry for the recipient
1013 * @param msgbuf buffer to transmit
1014 * @param msgbuf_size number of bytes in @a msgbuf buffer
1015 * @param priority transmission priority
1016 * @param timeout transmission timeout
1017 * @param use_keepalive_timeout #GNUNET_YES to use plugin-specific keep-alive
1018 * timeout (@a timeout is ignored in that case), #GNUNET_NO otherwise
1019 * @param cont continuation to call when finished (can be NULL)
1020 * @param cont_cls closure for @a cont
1021 * @return timeout (copy of @a timeout or a calculated one if
1022 * @a use_keepalive_timeout is #GNUNET_YES.
1024 static struct GNUNET_TIME_Relative
1025 send_with_session (struct NeighbourMapEntry *n,
1029 struct GNUNET_TIME_Relative timeout,
1030 unsigned int use_keepalive_timeout,
1031 GNUNET_TRANSPORT_TransmitContinuation cont,
1034 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1035 struct GNUNET_TIME_Relative result = GNUNET_TIME_UNIT_FOREVER_REL;
1037 GNUNET_assert (NULL != n->primary_address.session);
1038 if ( ((NULL == (papi = GST_plugins_find (n->primary_address.address->transport_name)) ||
1039 (-1 == papi->send (papi->cls,
1040 n->primary_address.session,
1044 (result = (GNUNET_NO == use_keepalive_timeout) ? timeout :
1045 GNUNET_TIME_relative_divide (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1046 papi->query_keepalive_factor (papi->cls))),
1055 GST_neighbours_notify_data_sent (n->primary_address.address,
1056 n->primary_address.session,
1058 GNUNET_break (NULL != papi);
1064 * Function called when the 'DISCONNECT' message has been sent by the
1065 * plugin. Frees the neighbour --- if the entry still exists.
1068 * @param target identity of the neighbour that was disconnected
1069 * @param result #GNUNET_OK if the disconnect got out successfully
1070 * @param payload bytes payload
1071 * @param physical bytes on wire
1074 send_disconnect_cont (void *cls,
1075 const struct GNUNET_PeerIdentity *target,
1080 struct NeighbourMapEntry *n;
1082 n = lookup_neighbour (target);
1084 return; /* already gone */
1085 if (GNUNET_TRANSPORT_PS_DISCONNECT != n->state)
1086 return; /* have created a fresh entry since */
1087 if (NULL != n->task)
1088 GNUNET_SCHEDULER_cancel (n->task);
1089 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1094 * Transmit a DISCONNECT message to the other peer.
1096 * @param n neighbour to send DISCONNECT message.
1099 send_disconnect (struct NeighbourMapEntry *n)
1101 struct SessionDisconnectMessage disconnect_msg;
1103 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1104 "Sending DISCONNECT message to peer `%4s'\n",
1105 GNUNET_i2s (&n->id));
1106 disconnect_msg.header.size = htons (sizeof (struct SessionDisconnectMessage));
1107 disconnect_msg.header.type =
1108 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
1109 disconnect_msg.reserved = htonl (0);
1110 disconnect_msg.purpose.size =
1111 htonl (sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
1112 sizeof (struct GNUNET_CRYPTO_EddsaPublicKey) +
1113 sizeof (struct GNUNET_TIME_AbsoluteNBO));
1114 disconnect_msg.purpose.purpose =
1115 htonl (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
1116 disconnect_msg.timestamp =
1117 GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get ());
1118 disconnect_msg.public_key = GST_my_identity.public_key;
1119 GNUNET_assert (GNUNET_OK ==
1120 GNUNET_CRYPTO_eddsa_sign (GST_my_private_key,
1121 &disconnect_msg.purpose,
1122 &disconnect_msg.signature));
1124 (void) send_with_session (n,
1126 sizeof (disconnect_msg),
1128 GNUNET_TIME_UNIT_FOREVER_REL,
1130 &send_disconnect_cont,
1132 GNUNET_STATISTICS_update (GST_stats,
1133 gettext_noop ("# DISCONNECT messages sent"),
1140 * Disconnect from the given neighbour, clean up the record.
1142 * @param n neighbour to disconnect from
1145 disconnect_neighbour (struct NeighbourMapEntry *n)
1147 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1148 "Disconnecting from peer %s in state %s\n",
1149 GNUNET_i2s (&n->id),
1150 GNUNET_TRANSPORT_ps2s (n->state));
1151 /* depending on state, notify neighbour and/or upper layers of this peer
1155 case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
1156 case GNUNET_TRANSPORT_PS_INIT_ATS:
1157 /* other peer is completely unaware of us, no need to send DISCONNECT */
1160 case GNUNET_TRANSPORT_PS_SYN_SENT:
1161 send_disconnect (n);
1162 set_state_and_timeout (n,
1163 GNUNET_TRANSPORT_PS_DISCONNECT,
1164 GNUNET_TIME_UNIT_FOREVER_ABS);
1166 case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
1167 /* we never ACK'ed the other peer's request, no need to send DISCONNECT */
1170 case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
1171 /* we DID ACK the other peer's request, must send DISCONNECT */
1172 send_disconnect (n);
1173 set_state_and_timeout (n,
1174 GNUNET_TRANSPORT_PS_DISCONNECT,
1175 GNUNET_TIME_UNIT_FOREVER_ABS);
1177 case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
1178 case GNUNET_TRANSPORT_PS_CONNECTED:
1179 case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
1180 /* we are currently connected, need to send disconnect and do
1181 internal notifications and update statistics */
1182 send_disconnect (n);
1183 set_state_and_timeout (n,
1184 GNUNET_TRANSPORT_PS_DISCONNECT,
1185 GNUNET_TIME_UNIT_FOREVER_ABS);
1187 case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
1188 /* Disconnecting while waiting for an ATS address to reconnect,
1189 * cannot send DISCONNECT */
1192 case GNUNET_TRANSPORT_PS_DISCONNECT:
1193 /* already disconnected, ignore */
1195 case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
1196 /* already cleaned up, how did we get here!? */
1200 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1201 "Unhandled state `%s'\n",
1202 GNUNET_TRANSPORT_ps2s (n->state));
1206 /* schedule timeout to clean up */
1207 if (NULL != n->task)
1208 GNUNET_SCHEDULER_cancel (n->task);
1209 n->task = GNUNET_SCHEDULER_add_delayed (DISCONNECT_SENT_TIMEOUT,
1216 * We're done with our transmission attempt, continue processing.
1218 * @param cls the `struct MessageQueue` of the message
1219 * @param receiver intended receiver
1220 * @param success whether it worked or not
1221 * @param size_payload bytes payload sent
1222 * @param physical bytes sent on wire
1225 transmit_send_continuation (void *cls,
1226 const struct GNUNET_PeerIdentity *receiver,
1227 int success, size_t size_payload, size_t physical)
1229 struct MessageQueue *mq = cls;
1230 struct NeighbourMapEntry *n;
1232 if (NULL == (n = lookup_neighbour (receiver)))
1235 return; /* disconnect or other error while transmitting, can happen */
1237 if (n->is_active == mq)
1239 /* this is still "our" neighbour, remove us from its queue
1240 and allow it to send the next message now */
1241 n->is_active = NULL;
1242 if (NULL != n->task)
1243 GNUNET_SCHEDULER_cancel (n->task);
1244 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1246 if (bytes_in_send_queue < mq->message_buf_size)
1248 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1249 "Bytes_in_send_queue `%u', Message_size %u, result: %s, payload %u, on wire %u\n",
1250 bytes_in_send_queue,
1251 mq->message_buf_size,
1252 (GNUNET_OK == success) ? "OK" : "FAIL",
1259 GNUNET_break (size_payload == mq->message_buf_size);
1260 bytes_in_send_queue -= mq->message_buf_size;
1261 GNUNET_STATISTICS_set (GST_stats,
1263 ("# bytes in message queue for other peers"),
1264 bytes_in_send_queue, GNUNET_NO);
1265 if (GNUNET_OK == success)
1266 GNUNET_STATISTICS_update (GST_stats,
1268 ("# messages transmitted to other peers"),
1271 GNUNET_STATISTICS_update (GST_stats,
1273 ("# transmission failures for messages to other peers"),
1275 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1276 "Sending message to `%s' of type %u with %u bytes was a %s\n",
1277 GNUNET_i2s (receiver),
1278 ntohs (((struct GNUNET_MessageHeader *) mq->message_buf)->type),
1279 mq->message_buf_size,
1280 (success == GNUNET_OK) ? "success" : "FAILURE");
1281 if (NULL != mq->cont)
1282 mq->cont (mq->cont_cls, success, size_payload, physical);
1288 * Check the message list for the given neighbour and if we can
1289 * send a message, do so. This function should only be called
1290 * if the connection is at least generally ready for transmission.
1291 * While we will only send one message at a time, no bandwidth
1292 * quota management is performed here. If a message was given to
1293 * the plugin, the continuation will automatically re-schedule
1294 * the 'master' task once the next message might be transmitted.
1296 * @param n target peer for which to transmit
1299 try_transmission_to_peer (struct NeighbourMapEntry *n)
1301 struct MessageQueue *mq;
1302 struct GNUNET_TIME_Relative timeout;
1304 if (NULL == n->primary_address.address)
1306 /* no address, why are we here? */
1310 if ((0 == n->primary_address.address->address_length) &&
1311 (NULL == n->primary_address.session))
1313 /* no address, why are we here? */
1317 if (NULL != n->is_active)
1319 /* transmission already pending */
1323 /* timeout messages from the queue that are past their due date */
1324 while (NULL != (mq = n->messages_head))
1326 timeout = GNUNET_TIME_absolute_get_remaining (mq->timeout);
1327 if (timeout.rel_value_us > 0)
1329 GNUNET_STATISTICS_update (GST_stats,
1331 ("# messages timed out while in transport queue"),
1333 GNUNET_CONTAINER_DLL_remove (n->messages_head,
1337 transmit_send_continuation (mq,
1340 mq->message_buf_size,
1344 return; /* no more messages */
1345 GNUNET_CONTAINER_DLL_remove (n->messages_head,
1350 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1351 "Giving message with %u bytes to plugin session %p\n",
1352 mq->message_buf_size,
1353 n->primary_address.session);
1354 (void) send_with_session (n,
1356 mq->message_buf_size,
1360 &transmit_send_continuation,
1366 * Send keepalive message to the neighbour. Must only be called
1367 * if we are on 'connected' state or while trying to switch addresses.
1368 * Will internally determine if a keepalive is truly needed (so can
1369 * always be called).
1371 * @param n neighbour that went idle and needs a keepalive
1374 send_keepalive (struct NeighbourMapEntry *n)
1376 struct SessionKeepAliveMessage m;
1377 struct GNUNET_TIME_Relative timeout;
1380 GNUNET_assert ((GNUNET_TRANSPORT_PS_CONNECTED == n->state) ||
1381 (GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT == n->state));
1382 if (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time).rel_value_us > 0)
1383 return; /* no keepalive needed at this time */
1385 nonce = 0; /* 0 indicates 'not set' */
1387 nonce = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_NONCE,
1390 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1391 "Sending KEEPALIVE to peer `%s' with nonce %u\n",
1392 GNUNET_i2s (&n->id),
1394 m.header.size = htons (sizeof (struct SessionKeepAliveMessage));
1395 m.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE);
1396 m.nonce = htonl (nonce);
1398 timeout = send_with_session (n,
1401 UINT32_MAX /* priority */,
1402 GNUNET_TIME_UNIT_FOREVER_REL,
1405 GNUNET_STATISTICS_update (GST_stats,
1406 gettext_noop ("# KEEPALIVES sent"),
1409 n->primary_address.keep_alive_nonce = nonce;
1410 n->expect_latency_response = GNUNET_YES;
1411 n->last_keep_alive_time = GNUNET_TIME_absolute_get ();
1412 n->keep_alive_time = GNUNET_TIME_relative_to_absolute (timeout);
1417 * Keep the connection to the given neighbour alive longer,
1418 * we received a KEEPALIVE (or equivalent); send a response.
1420 * @param neighbour neighbour to keep alive (by sending keep alive response)
1421 * @param m the keep alive message containing the nonce to respond to
1424 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour,
1425 const struct GNUNET_MessageHeader *m)
1427 struct NeighbourMapEntry *n;
1428 const struct SessionKeepAliveMessage *msg_in;
1429 struct SessionKeepAliveMessage msg;
1431 if (sizeof (struct SessionKeepAliveMessage) != ntohs (m->size))
1433 GNUNET_break_op (0);
1437 msg_in = (const struct SessionKeepAliveMessage *) m;
1438 if (NULL == (n = lookup_neighbour (neighbour)))
1440 GNUNET_STATISTICS_update (GST_stats,
1442 ("# KEEPALIVE messages discarded (peer unknown)"),
1446 if (NULL == n->primary_address.session)
1448 GNUNET_STATISTICS_update (GST_stats,
1450 ("# KEEPALIVE messages discarded (no session)"),
1455 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1456 "Received KEEPALIVE request from peer `%s' with nonce %u\n",
1457 GNUNET_i2s (&n->id),
1458 ntohl (msg_in->nonce));
1459 GNUNET_STATISTICS_update (GST_stats,
1460 gettext_noop ("# KEEPALIVES received in good order"),
1464 /* send reply to allow neighbour to measure latency */
1465 msg.header.size = htons (sizeof (struct SessionKeepAliveMessage));
1466 msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE);
1467 msg.nonce = msg_in->nonce;
1468 (void) send_with_session (n,
1470 sizeof (struct SessionKeepAliveMessage),
1471 UINT32_MAX /* priority */,
1472 GNUNET_TIME_UNIT_FOREVER_REL,
1479 * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
1480 * latency to this peer. Pass the updated information (existing ats
1481 * plus calculated latency) to ATS.
1483 * @param neighbour neighbour to keep alive
1484 * @param m the message containing the keep alive response
1487 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
1488 const struct GNUNET_MessageHeader *m)
1490 struct NeighbourMapEntry *n;
1491 const struct SessionKeepAliveMessage *msg;
1492 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1493 struct GNUNET_TIME_Relative latency;
1495 if (sizeof (struct SessionKeepAliveMessage) != ntohs (m->size))
1497 GNUNET_break_op (0);
1501 msg = (const struct SessionKeepAliveMessage *) m;
1502 if (NULL == (n = lookup_neighbour (neighbour)))
1504 GNUNET_STATISTICS_update (GST_stats,
1505 gettext_noop ("# KEEPALIVE_RESPONSE messages discarded (not connected)"),
1510 if ( (GNUNET_TRANSPORT_PS_CONNECTED != n->state) ||
1511 (GNUNET_YES != n->expect_latency_response) )
1513 GNUNET_STATISTICS_update (GST_stats,
1514 gettext_noop ("# KEEPALIVE_RESPONSE messages discarded (not expected)"),
1519 if (NULL == n->primary_address.address)
1521 GNUNET_STATISTICS_update (GST_stats,
1522 gettext_noop ("# KEEPALIVE_RESPONSE messages discarded (address changed)"),
1527 if (n->primary_address.keep_alive_nonce != ntohl (msg->nonce))
1529 if (0 == n->primary_address.keep_alive_nonce)
1530 GNUNET_STATISTICS_update (GST_stats,
1531 gettext_noop ("# KEEPALIVE_RESPONSE messages discarded (no nonce)"),
1535 GNUNET_STATISTICS_update (GST_stats,
1536 gettext_noop ("# KEEPALIVE_RESPONSE messages discarded (wrong nonce)"),
1541 GNUNET_STATISTICS_update (GST_stats,
1542 gettext_noop ("# KEEPALIVE_RESPONSE messages received in good order"),
1547 /* Update session timeout here */
1548 if (NULL != (papi = GST_plugins_find (n->primary_address.address->transport_name)))
1550 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1551 "Updating session for peer `%s' for session %p\n",
1552 GNUNET_i2s (&n->id),
1553 n->primary_address.session);
1554 papi->update_session_timeout (papi->cls,
1556 n->primary_address.session);
1563 n->primary_address.keep_alive_nonce = 0;
1564 n->expect_latency_response = GNUNET_NO;
1565 set_state_and_timeout (n,
1567 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT));
1569 latency = GNUNET_TIME_absolute_get_duration (n->last_keep_alive_time);
1570 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1571 "Received KEEPALIVE_RESPONSE from peer `%s', latency is %s\n",
1572 GNUNET_i2s (&n->id),
1573 GNUNET_STRINGS_relative_time_to_string (latency,
1575 GST_ats_update_delay (n->primary_address.address,
1576 GNUNET_TIME_relative_divide (latency,
1582 * We have received a message from the given sender. How long should
1583 * we delay before receiving more? (Also used to keep the peer marked
1586 * @param sender sender of the message
1587 * @param size size of the message
1588 * @param do_forward set to #GNUNET_YES if the message should be forwarded to clients
1589 * #GNUNET_NO if the neighbour is not connected or violates the quota,
1590 * #GNUNET_SYSERR if the connection is not fully up yet
1591 * @return how long to wait before reading more from this sender
1593 struct GNUNET_TIME_Relative
1594 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity *sender,
1598 struct NeighbourMapEntry *n;
1599 struct GNUNET_TIME_Relative ret;
1601 if (NULL == neighbours)
1603 *do_forward = GNUNET_NO;
1604 return GNUNET_TIME_UNIT_FOREVER_REL; /* This can happen during shutdown */
1606 if (NULL == (n = lookup_neighbour (sender)))
1608 GST_neighbours_try_connect (sender);
1609 if (NULL == (n = lookup_neighbour (sender)))
1611 GNUNET_STATISTICS_update (GST_stats,
1613 ("# messages discarded due to lack of neighbour record"),
1615 *do_forward = GNUNET_NO;
1616 return GNUNET_TIME_UNIT_ZERO;
1619 if (! test_connected (n))
1621 *do_forward = GNUNET_SYSERR;
1622 return GNUNET_TIME_UNIT_ZERO;
1624 if (GNUNET_YES == GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, size))
1626 n->quota_violation_count++;
1627 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1628 "Bandwidth quota (%u b/s) violation detected (total of %u).\n",
1629 n->in_tracker.available_bytes_per_s__,
1630 n->quota_violation_count);
1631 /* Discount 32k per violation */
1632 GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, -32 * 1024);
1636 if (n->quota_violation_count > 0)
1638 /* try to add 32k back */
1639 GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, 32 * 1024);
1640 n->quota_violation_count--;
1643 if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
1645 GNUNET_STATISTICS_update (GST_stats,
1647 ("# bandwidth quota violations by other peers"),
1649 *do_forward = GNUNET_NO;
1650 return GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT;
1652 *do_forward = GNUNET_YES;
1653 ret = GNUNET_BANDWIDTH_tracker_get_delay (&n->in_tracker, 32 * 1024);
1654 if (ret.rel_value_us > 0)
1656 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1657 "Throttling read (%lld bytes excess at %u b/s), waiting %s before reading more.\n",
1658 (long long) n->in_tracker.consumption_since_last_update__,
1659 (unsigned int) n->in_tracker.available_bytes_per_s__,
1660 GNUNET_STRINGS_relative_time_to_string (ret, GNUNET_YES));
1661 GNUNET_STATISTICS_update (GST_stats,
1662 gettext_noop ("# ms throttling suggested"),
1663 (int64_t) ret.rel_value_us / 1000LL,
1671 * Transmit a message to the given target using the active connection.
1673 * @param target destination
1674 * @param msg message to send
1675 * @param msg_size number of bytes in msg
1676 * @param timeout when to fail with timeout
1677 * @param cont function to call when done
1678 * @param cont_cls closure for @a cont
1681 GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
1684 struct GNUNET_TIME_Relative timeout,
1685 GST_NeighbourSendContinuation cont,
1688 struct NeighbourMapEntry *n;
1689 struct MessageQueue *mq;
1691 /* All ove these cases should never happen; they are all API violations.
1692 But we check anyway, just to be sure. */
1693 if (NULL == (n = lookup_neighbour (target)))
1703 if (GNUNET_YES != test_connected (n))
1713 bytes_in_send_queue += msg_size;
1714 GNUNET_STATISTICS_set (GST_stats,
1716 ("# bytes in message queue for other peers"),
1717 bytes_in_send_queue, GNUNET_NO);
1718 mq = GNUNET_malloc (sizeof (struct MessageQueue) + msg_size);
1720 mq->cont_cls = cont_cls;
1721 memcpy (&mq[1], msg, msg_size);
1722 mq->message_buf = (const char *) &mq[1];
1723 mq->message_buf_size = msg_size;
1724 mq->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1726 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1727 "Enqueueing %u bytes to send to peer %s\n",
1729 GNUNET_i2s (target));
1730 GNUNET_CONTAINER_DLL_insert_tail (n->messages_head,
1733 if (NULL != n->task)
1734 GNUNET_SCHEDULER_cancel (n->task);
1735 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1740 * Continuation called from our attempt to transmitted our
1741 * #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN to the specified @a
1742 * target. Continue processing based on the @a result. Specifically,
1743 * if we failed to transmit, discard the address we used.
1746 * @param target which peer received the transmission
1747 * @param result #GNUNET_OK if sending worked
1748 * @param size_payload how many bytes of payload were sent (ignored)
1749 * @param size_on_wire how much bandwidth was consumed on the wire (ignored)
1752 send_session_syn_cont (void *cls,
1753 const struct GNUNET_PeerIdentity *target,
1755 size_t size_payload,
1756 size_t size_on_wire)
1758 struct NeighbourMapEntry *n;
1760 n = lookup_neighbour (target);
1763 /* SYN continuation was called after neighbor was freed,
1764 * for example due to a time out for the state or the session
1765 * used was already terminated: nothing to do here... */
1769 if ( (GNUNET_TRANSPORT_PS_SYN_SENT != n->state) &&
1770 (GNUNET_TRANSPORT_PS_RECONNECT_SENT != n->state) &&
1771 (GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT != n->state))
1773 /* SYN continuation was called after neighbor changed state,
1774 * for example due to a time out for the state or the session
1775 * used was already terminated: nothing to do here... */
1778 if (GNUNET_OK == result)
1781 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1782 _("Failed to send SYN message to peer `%s'\n"),
1783 GNUNET_i2s (target));
1785 case GNUNET_TRANSPORT_PS_SYN_SENT:
1786 /* Remove address and request an additional one */
1787 unset_primary_address (n);
1788 set_state_and_timeout (n,
1789 GNUNET_TRANSPORT_PS_INIT_ATS,
1790 GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT));
1792 case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
1793 /* Remove address and request an additional one */
1794 unset_primary_address (n);
1795 set_state_and_timeout (n,
1796 GNUNET_TRANSPORT_PS_RECONNECT_ATS,
1797 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
1799 case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
1800 /* Remove address and request and go back to primary address */
1801 GNUNET_STATISTICS_update (GST_stats,
1802 gettext_noop ("# Failed attempts to switch addresses (failed to send SYN CONT)"),
1805 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1806 "Switch failed, cleaning up alternative address\n");
1807 free_address (&n->alternative_address);
1808 set_state_and_timeout (n,
1809 GNUNET_TRANSPORT_PS_CONNECTED,
1810 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
1813 disconnect_neighbour (n);
1820 * Send a SYN message via the given address.
1822 * @param na address to use
1825 send_syn (struct NeighbourAddress *na)
1827 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1828 struct TransportSynMessage connect_msg;
1829 struct NeighbourMapEntry *n;
1831 GNUNET_assert (NULL != na->session);
1832 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1833 "Sending SYN message to peer `%s' at %s\n",
1834 GNUNET_i2s (&na->address->peer),
1835 GST_plugins_a2s (na->address));
1837 papi = GST_plugins_find (na->address->transport_name);
1838 GNUNET_assert (NULL != papi);
1839 GNUNET_STATISTICS_update (GST_stats,
1841 ("# SYN messages sent"),
1843 na->connect_timestamp = GNUNET_TIME_absolute_get ();
1844 connect_msg.header.size = htons (sizeof (struct TransportSynMessage));
1845 connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN);
1846 connect_msg.reserved = htonl (0);
1847 connect_msg.timestamp = GNUNET_TIME_absolute_hton (na->connect_timestamp);
1849 papi->send (papi->cls,
1851 (const char *) &connect_msg,
1852 sizeof (struct TransportSynMessage),
1854 SETUP_CONNECTION_TIMEOUT,
1855 &send_session_syn_cont, NULL))
1857 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1858 _("Failed to transmit SYN message to %s\n"),
1859 GST_plugins_a2s (na->address));
1860 n = lookup_neighbour (&na->address->peer);
1867 case GNUNET_TRANSPORT_PS_SYN_SENT:
1868 /* Remove address and request and additional one */
1869 GNUNET_assert (na == &n->primary_address);
1870 unset_primary_address (n);
1871 set_state_and_timeout (n,
1872 GNUNET_TRANSPORT_PS_INIT_ATS,
1873 GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT));
1874 /* Hard failure to send the SYN message with this address:
1875 Destroy address and session */
1877 case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
1878 /* Remove address and request an additional one */
1879 GNUNET_assert (na == &n->primary_address);
1880 unset_primary_address (n);
1881 set_state_and_timeout (n,
1882 GNUNET_TRANSPORT_PS_RECONNECT_ATS,
1883 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
1885 case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
1886 GNUNET_assert (na == &n->alternative_address);
1887 GNUNET_STATISTICS_update (GST_stats,
1888 gettext_noop ("# Failed attempts to switch addresses (failed to send SYN)"),
1891 /* Remove address and request an additional one */
1892 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1893 "Switch failed, cleaning up alternative address\n");
1894 free_address (&n->alternative_address);
1895 set_state_and_timeout (n,
1896 GNUNET_TRANSPORT_PS_CONNECTED,
1897 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
1901 disconnect_neighbour (n);
1906 GST_neighbours_notify_data_sent (na->address,
1908 sizeof (struct TransportSynMessage));
1913 * Continuation called from our attempt to transmitted our
1914 * #GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN_ACK to the specified @a
1915 * target. Continue processing based on the @a result. Specifically,
1916 * if we failed to transmit, discard the address we used.
1919 * @param target which peer received the transmission
1920 * @param result #GNUNET_OK if sending worked
1921 * @param size_payload how many bytes of payload were sent (ignored)
1922 * @param size_on_wire how much bandwidth was consumed on the wire (ignored)
1925 send_session_syn_ack_cont (void *cls,
1926 const struct GNUNET_PeerIdentity *target,
1928 size_t size_payload,
1929 size_t size_on_wire)
1931 struct NeighbourMapEntry *n;
1933 n = lookup_neighbour (target);
1936 /* SYN_ACK continuation was called after neighbor was freed,
1937 * for example due to a time out for the state or the session
1938 * used was already terminated: nothing to do here... */
1942 if (GNUNET_TRANSPORT_PS_SYN_RECV_ACK != n->state)
1944 /* SYN_ACK continuation was called after neighbor changed state,
1945 * for example due to a time out for the state or the session
1946 * used was already terminated: nothing to do here... */
1949 if (GNUNET_OK == result)
1952 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1953 _("Failed to send SYN_ACK message to peer `%s' using address `%s'\n"),
1954 GNUNET_i2s (target),
1955 GST_plugins_a2s (n->primary_address.address));
1957 /* Remove address and request and additional one */
1958 /* FIXME: what if the neighbour's primary address
1959 changed in the meantime? Might want to instead
1960 pass "something" around in closure to be sure. */
1961 unset_primary_address (n);
1962 n->ack_state = ACK_SEND_SYN_ACK;
1963 set_state_and_timeout (n,
1964 GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
1965 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
1970 * Send a SYN_ACK message via the given address.
1972 * @param na address and session to use
1973 * @param timestamp timestamp to use for the ACK message
1974 * @return #GNUNET_SYSERR if sending immediately failed, #GNUNET_OK otherwise
1977 send_syn_ack_message (struct NeighbourAddress *na,
1978 struct GNUNET_TIME_Absolute timestamp)
1980 const struct GNUNET_HELLO_Address *address = na->address;
1981 struct Session *session = na->session;
1982 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1983 struct TransportSynMessage connect_msg;
1984 struct NeighbourMapEntry *n;
1986 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1987 "Sending SYN_ACK to peer `%s'\n",
1988 GNUNET_i2s (&address->peer));
1990 if (NULL == (papi = GST_plugins_find (address->transport_name)))
1995 if (NULL == session)
1996 session = papi->get_session (papi->cls,
1998 if (NULL == session)
2003 GST_ats_new_session (address,
2005 GNUNET_STATISTICS_update (GST_stats,
2007 ("# SYN_ACK messages sent"),
2009 connect_msg.header.size = htons (sizeof (struct TransportSynMessage));
2010 connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_SYN_ACK);
2011 connect_msg.reserved = htonl (0);
2012 connect_msg.timestamp = GNUNET_TIME_absolute_hton (timestamp);
2014 if (GNUNET_SYSERR ==
2015 papi->send (papi->cls,
2017 (const char *) &connect_msg,
2018 sizeof (struct TransportSynMessage),
2020 GNUNET_TIME_UNIT_FOREVER_REL,
2021 &send_session_syn_ack_cont, NULL))
2023 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2024 _("Failed to transmit SYN_ACK message to %s\n"),
2025 GST_plugins_a2s (address));
2027 n = lookup_neighbour (&address->peer);
2033 /* Remove address and request and additional one */
2034 unset_primary_address (n);
2035 n->ack_state = ACK_SEND_SYN_ACK;
2036 set_state_and_timeout (n,
2037 GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
2038 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2045 * Function called by the bandwidth tracker for a peer whenever
2046 * the tracker's state changed such that we need to recalculate
2047 * the delay for flow control. We calculate the latest delay
2048 * and inform the plugin (if applicable).
2050 * @param cls the `struct NeighbourMapEntry` to update calculations for
2053 inbound_bw_tracker_update (void *cls)
2055 struct NeighbourMapEntry *n = cls;
2056 struct GNUNET_TRANSPORT_PluginFunctions *papi;
2057 struct GNUNET_TIME_Relative delay;
2060 if (NULL == n->primary_address.address)
2061 return; /* not active, ignore */
2062 papi = GST_plugins_find (n->primary_address.address->transport_name);
2063 GNUNET_assert (NULL != papi);
2064 if (NULL == papi->update_inbound_delay)
2066 delay = GST_neighbours_calculate_receive_delay (&n->id,
2069 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2070 "New inbound delay for peer `%s' is %llu ms\n",
2071 GNUNET_i2s (&n->id),
2072 delay.rel_value_us / 1000);
2073 papi->update_inbound_delay (papi->cls,
2075 n->primary_address.session,
2081 * Create a fresh entry in the neighbour map for the given peer
2083 * @param peer peer to create an entry for
2084 * @return new neighbour map entry
2086 static struct NeighbourMapEntry *
2087 setup_neighbour (const struct GNUNET_PeerIdentity *peer)
2089 struct NeighbourMapEntry *n;
2091 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2092 "Creating new neighbour entry for `%s'\n",
2094 n = GNUNET_new (struct NeighbourMapEntry);
2096 n->ack_state = ACK_UNDEFINED;
2097 n->last_util_transmission = GNUNET_TIME_absolute_get();
2098 GNUNET_BANDWIDTH_tracker_init (&n->in_tracker,
2099 &inbound_bw_tracker_update,
2101 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
2102 MAX_BANDWIDTH_CARRY_S);
2103 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
2104 set_state_and_timeout (n,
2105 GNUNET_TRANSPORT_PS_NOT_CONNECTED,
2106 GNUNET_TIME_UNIT_FOREVER_ABS);
2107 GNUNET_assert (GNUNET_OK ==
2108 GNUNET_CONTAINER_multipeermap_put (neighbours,
2110 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
2111 n->suggest_handle = GNUNET_ATS_connectivity_suggest (GST_ats_connect,
2119 * Entry in a DLL we use to keep track of pending blacklist checks.
2121 struct BlacklistCheckSwitchContext
2126 struct BlacklistCheckSwitchContext *prev;
2131 struct BlacklistCheckSwitchContext *next;
2134 * Handle to the blacklist check we are performing.
2136 struct GST_BlacklistCheck *blc;
2139 * Address we are asking the blacklist subsystem about.
2141 struct GNUNET_HELLO_Address *address;
2144 * Session we should use in conjunction with @e address, can be NULL.
2146 struct Session *session;
2149 * Inbound bandwidth that was assigned to @e address.
2151 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
2154 * Outbound bandwidth that was assigned to @e address.
2156 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
2161 * Black list check result for try_connect call
2162 * If connection to the peer is allowed request adddress and
2164 * @param cls blc_ctx bl context
2165 * @param peer the peer
2166 * @param result the result
2169 try_connect_bl_check_cont (void *cls,
2170 const struct GNUNET_PeerIdentity *peer,
2173 struct BlacklistCheckSwitchContext *blc_ctx = cls;
2174 struct NeighbourMapEntry *n;
2176 GNUNET_CONTAINER_DLL_remove (pending_bc_head,
2179 GNUNET_free (blc_ctx);
2180 if (GNUNET_OK != result)
2182 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2183 _("Blacklisting disapproved to connect to peer `%s'\n"),
2188 /* Setup a new neighbour */
2189 if (NULL != lookup_neighbour(peer))
2190 return; /* The neighbor was created in the meantime while waited for BL clients */
2192 n = setup_neighbour (peer);
2194 /* Request address suggestions for this peer */
2195 set_state_and_timeout (n,
2196 GNUNET_TRANSPORT_PS_INIT_ATS,
2197 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2202 * Try to create a connection to the given target (eventually).
2204 * @param target peer to try to connect to
2207 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target)
2209 struct NeighbourMapEntry *n;
2210 struct GST_BlacklistCheck *blc;
2211 struct BlacklistCheckSwitchContext *blc_ctx;
2213 if (NULL == neighbours)
2215 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2216 "Asked to connect to peer `%s' during shutdown\n",
2217 GNUNET_i2s (target));
2218 return; /* during shutdown, do nothing */
2220 n = lookup_neighbour (target);
2221 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2222 "Asked to connect to peer `%s' (state: %s)\n",
2223 GNUNET_i2s (target),
2224 (NULL != n) ? GNUNET_TRANSPORT_ps2s(n->state) : "NEW PEER");
2229 case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
2230 /* this should not be possible */
2234 case GNUNET_TRANSPORT_PS_INIT_ATS:
2235 case GNUNET_TRANSPORT_PS_SYN_SENT:
2236 case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
2237 case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
2238 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2239 "Ignoring request to try to connect to `%s', already trying!\n",
2240 GNUNET_i2s (target));
2241 return; /* already trying */
2242 case GNUNET_TRANSPORT_PS_CONNECTED:
2243 case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
2244 case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
2245 case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
2246 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2247 "Ignoring request to try to connect, already connected to `%s'!\n",
2248 GNUNET_i2s (target));
2249 return; /* already connected */
2250 case GNUNET_TRANSPORT_PS_DISCONNECT:
2251 /* get rid of remains, ready to re-try immediately */
2254 case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
2255 /* should not be possible */
2259 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2260 "Unhandled state `%s'\n",
2261 GNUNET_TRANSPORT_ps2s (n->state));
2268 /* Do blacklist check if connecting to this peer is allowed */
2269 blc_ctx = GNUNET_new (struct BlacklistCheckSwitchContext);
2270 GNUNET_CONTAINER_DLL_insert (pending_bc_head,
2275 (blc = GST_blacklist_test_allowed (target,
2277 &try_connect_bl_check_cont,
2286 * We received a 'SYN' message from the other peer.
2287 * Consider switching to it.
2289 * @param message possibly a 'struct TransportSynMessage' (check format)
2290 * @param peer identity of the peer to switch the address for
2291 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
2294 GST_neighbours_handle_session_syn (const struct GNUNET_MessageHeader *message,
2295 const struct GNUNET_PeerIdentity *peer)
2297 const struct TransportSynMessage *scm;
2298 struct NeighbourMapEntry *n;
2299 struct GNUNET_TIME_Absolute ts;
2301 if (ntohs (message->size) != sizeof (struct TransportSynMessage))
2303 GNUNET_break_op (0);
2304 return GNUNET_SYSERR;
2306 GNUNET_STATISTICS_update (GST_stats,
2308 ("# SYN messages received"),
2310 if (NULL == neighbours)
2312 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2313 _("SYN request from peer `%s' ignored due impending shutdown\n"),
2315 return GNUNET_OK; /* we're shutting down */
2317 scm = (const struct TransportSynMessage *) message;
2318 GNUNET_break_op (0 == ntohl (scm->reserved));
2319 ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
2320 n = lookup_neighbour (peer);
2323 /* This is a new neighbour and set to not connected */
2324 n = setup_neighbour (peer);
2327 /* Remember this SYN message in neighbour */
2328 n->ack_state = ACK_SEND_SYN_ACK;
2329 n->connect_ack_timestamp = ts;
2331 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2332 "Received SYN for peer `%s' in state %s/%s\n",
2334 GNUNET_TRANSPORT_ps2s (n->state),
2335 print_ack_state (n->ack_state));
2339 case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
2340 /* Request an address from ATS to send SYN_ACK to this peer */
2341 set_state_and_timeout (n,
2342 GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
2343 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2345 case GNUNET_TRANSPORT_PS_INIT_ATS:
2346 /* SYN message takes priority over us asking ATS for address:
2347 * Wait for ATS to suggest an address and send SYN_ACK */
2348 set_state_and_timeout (n,
2349 GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
2350 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2352 case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
2353 /* We already wait for an address to send an SYN_ACK */
2355 case GNUNET_TRANSPORT_PS_SYN_SENT:
2356 case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
2357 /* Send ACK immediately */
2358 n->ack_state = ACK_SEND_ACK;
2359 send_syn_ack_message (&n->primary_address,
2362 case GNUNET_TRANSPORT_PS_CONNECTED:
2363 /* we are already connected and can thus send the ACK immediately */
2364 GNUNET_assert (NULL != n->primary_address.address);
2365 GNUNET_assert (NULL != n->primary_address.session);
2366 n->ack_state = ACK_SEND_ACK;
2367 send_syn_ack_message (&n->primary_address,
2370 case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
2371 /* We wait for ATS address suggestion */
2373 case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
2374 /* We received a SYN message while waiting for a SYN_ACK in fast
2375 * reconnect. Send SYN_ACK immediately */
2376 n->ack_state = ACK_SEND_ACK;
2377 send_syn_ack_message (&n->primary_address,
2378 n->connect_ack_timestamp);
2380 case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
2381 /* We are already connected and can thus send the ACK immediately;
2382 still, it can never hurt to have an alternative address, so also
2383 tell ATS about it */
2384 GNUNET_assert (NULL != n->primary_address.address);
2385 GNUNET_assert (NULL != n->primary_address.session);
2386 n->ack_state = ACK_SEND_ACK;
2387 send_syn_ack_message (&n->primary_address,
2390 case GNUNET_TRANSPORT_PS_DISCONNECT:
2391 /* Get rid of remains and re-try */
2393 n = setup_neighbour (peer);
2394 /* Remember the SYN time stamp for ACK message */
2395 n->ack_state = ACK_SEND_SYN_ACK;
2396 n->connect_ack_timestamp = ts;
2397 /* Request an address for the peer */
2398 set_state_and_timeout (n,
2399 GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
2400 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2402 case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
2403 /* should not be possible */
2407 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2408 "Unhandled state `%s'\n",
2409 GNUNET_TRANSPORT_ps2s (n->state));
2411 return GNUNET_SYSERR;
2418 * Check if the given @a address is the same that we are already
2419 * using for the respective neighbour. If so, update the bandwidth
2420 * assignment and possibly the session and return #GNUNET_OK.
2421 * If the new address is different from what the neighbour is
2422 * using right now, return #GNUNET_NO.
2424 * @param address address of the other peer,
2425 * @param session session to use or NULL if transport should initiate a session
2426 * @param bandwidth_in inbound quota to be used when connection is up,
2427 * 0 to disconnect from peer
2428 * @param bandwidth_out outbound quota to be used when connection is up,
2429 * 0 to disconnect from peer
2430 * @return #GNUNET_OK if we were able to just update the bandwidth and session,
2431 * #GNUNET_NO if more extensive changes are required (address changed)
2434 try_run_fast_ats_update (const struct GNUNET_HELLO_Address *address,
2435 struct Session *session,
2436 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
2437 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
2439 struct NeighbourMapEntry *n;
2441 n = lookup_neighbour (&address->peer);
2443 (NULL == n->primary_address.address) ||
2444 (0 != GNUNET_HELLO_address_cmp (address,
2445 n->primary_address.address)) )
2447 /* We are not really switching addresses, but merely adjusting
2448 session and/or bandwidth, can do fast ATS update! */
2449 if (session != n->primary_address.session)
2451 /* switch to a different session, but keeping same address; could
2452 happen if there is a 2nd inbound connection */
2453 n->primary_address.session = session;
2455 n->primary_address.bandwidth_in = bandwidth_in;
2456 n->primary_address.bandwidth_out = bandwidth_out;
2457 GST_neighbours_set_incoming_quota (&address->peer,
2459 send_outbound_quota (&address->peer,
2466 * We've been asked to switch addresses, and just now got the result
2467 * from the blacklist check to see if this is allowed.
2469 * @param cls the `struct BlacklistCheckSwitchContext` with
2470 * the information about the future address
2471 * @param peer the peer we may switch addresses on
2472 * @param result #GNUNET_NO if we are not allowed to use the new
2476 switch_address_bl_check_cont (void *cls,
2477 const struct GNUNET_PeerIdentity *peer,
2480 struct BlacklistCheckSwitchContext *blc_ctx = cls;
2481 struct GNUNET_TRANSPORT_PluginFunctions *papi;
2482 struct NeighbourMapEntry *n;
2484 if (result == GNUNET_NO)
2486 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2487 "Blacklist denied to switch to suggested address `%s' session %p for peer `%s'\n",
2488 GST_plugins_a2s (blc_ctx->address),
2490 GNUNET_i2s (&blc_ctx->address->peer));
2491 GNUNET_STATISTICS_update (GST_stats,
2492 "# ATS suggestions ignored (blacklist denied)",
2495 /* FIXME: tell plugin to force killing session here and now
2496 (note: _proper_ plugin API for this does not yet exist) */
2497 GST_ats_block_address (blc_ctx->address,
2502 papi = GST_plugins_find (blc_ctx->address->transport_name);
2503 GNUNET_assert (NULL != papi);
2505 if (NULL == blc_ctx->session)
2507 /* need to create a session, ATS only gave us an address */
2508 blc_ctx->session = papi->get_session (papi->cls,
2510 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2511 "Obtained new session for peer `%s' and address '%s': %p\n",
2512 GNUNET_i2s (&blc_ctx->address->peer),
2513 GST_plugins_a2s (blc_ctx->address),
2515 if (NULL != blc_ctx->session)
2516 GST_ats_new_session (blc_ctx->address,
2519 if (NULL == blc_ctx->session)
2521 /* session creation failed, bad!, fail! */
2522 GNUNET_STATISTICS_update (GST_stats,
2523 "# ATS suggestions ignored (failed to create session)",
2526 /* No session could be obtained, remove blacklist check and clean up */
2527 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2528 "Failed to obtain new session for peer `%s' and address '%s'\n",
2529 GNUNET_i2s (&blc_ctx->address->peer),
2530 GST_plugins_a2s (blc_ctx->address));
2531 GST_ats_block_address (blc_ctx->address,
2536 /* We did this check already before going into blacklist, but
2537 it is theoretically possible that the situation changed in
2538 the meantime, hence we check again here */
2540 try_run_fast_ats_update (blc_ctx->address,
2542 blc_ctx->bandwidth_in,
2543 blc_ctx->bandwidth_out))
2544 goto cleanup; /* was just a minor update, we're done */
2546 /* check if we also need to setup the neighbour entry */
2547 if (NULL == (n = lookup_neighbour (peer)))
2549 n = setup_neighbour (peer);
2550 n->state = GNUNET_TRANSPORT_PS_INIT_ATS;
2553 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2554 "Peer `%s' switches to address `%s'\n",
2555 GNUNET_i2s (&blc_ctx->address->peer),
2556 GST_plugins_a2s (blc_ctx->address));
2560 case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
2562 GST_ats_block_address (blc_ctx->address,
2566 case GNUNET_TRANSPORT_PS_INIT_ATS:
2567 /* We requested an address and ATS suggests one:
2568 * set primary address and send SYN message*/
2569 set_primary_address (n,
2572 blc_ctx->bandwidth_in,
2573 blc_ctx->bandwidth_out);
2574 if (ACK_SEND_SYN_ACK == n->ack_state)
2576 /* Send pending SYN_ACK message */
2577 n->ack_state = ACK_SEND_ACK;
2578 send_syn_ack_message (&n->primary_address,
2579 n->connect_ack_timestamp);
2581 set_state_and_timeout (n,
2582 GNUNET_TRANSPORT_PS_SYN_SENT,
2583 GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2584 send_syn (&n->primary_address);
2586 case GNUNET_TRANSPORT_PS_SYN_SENT:
2587 /* ATS suggested a new address while waiting for an SYN_ACK:
2588 * Switch and send new SYN */
2589 /* ATS suggests a different address, switch again */
2590 set_primary_address (n,
2593 blc_ctx->bandwidth_in,
2594 blc_ctx->bandwidth_out);
2595 if (ACK_SEND_SYN_ACK == n->ack_state)
2597 /* Send pending SYN_ACK message */
2598 n->ack_state = ACK_SEND_ACK;
2599 send_syn_ack_message (&n->primary_address,
2600 n->connect_ack_timestamp);
2602 set_state_and_timeout (n,
2603 GNUNET_TRANSPORT_PS_SYN_SENT,
2604 GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2605 send_syn (&n->primary_address);
2607 case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
2608 /* We requested an address and ATS suggests one:
2609 * set primary address and send SYN_ACK message*/
2610 set_primary_address (n,
2613 blc_ctx->bandwidth_in,
2614 blc_ctx->bandwidth_out);
2615 /* Send an ACK message as a response to the SYN msg */
2616 set_state_and_timeout (n,
2617 GNUNET_TRANSPORT_PS_SYN_RECV_ACK,
2618 GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2619 send_syn_ack_message (&n->primary_address,
2620 n->connect_ack_timestamp);
2621 if ( (ACK_SEND_SYN_ACK == n->ack_state) ||
2622 (ACK_UNDEFINED == n->ack_state) )
2623 n->ack_state = ACK_SEND_ACK;
2625 case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
2626 /* ATS asks us to switch while we were trying to connect; switch to new
2627 address and check blacklist again */
2628 if ( (ACK_SEND_SYN_ACK == n->ack_state) )
2630 n->ack_state = ACK_SEND_ACK;
2631 send_syn_ack_message (&n->primary_address,
2632 n->connect_ack_timestamp);
2634 set_primary_address (n,
2637 blc_ctx->bandwidth_in,
2638 blc_ctx->bandwidth_out);
2639 set_state_and_timeout (n,
2640 GNUNET_TRANSPORT_PS_SYN_RECV_ACK,
2641 GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2643 case GNUNET_TRANSPORT_PS_CONNECTED:
2644 GNUNET_assert (NULL != n->primary_address.address);
2645 GNUNET_assert (NULL != n->primary_address.session);
2646 GNUNET_break (n->primary_address.session != blc_ctx->session);
2647 /* ATS asks us to switch a life connection; see if we can get
2648 a SYN_ACK on it before we actually do this! */
2649 set_alternative_address (n,
2652 blc_ctx->bandwidth_in,
2653 blc_ctx->bandwidth_out);
2654 set_state_and_timeout (n,
2655 GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT,
2656 GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2657 GNUNET_STATISTICS_update (GST_stats,
2658 gettext_noop ("# Attempts to switch addresses"),
2661 send_syn (&n->alternative_address);
2663 case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
2664 set_primary_address (n,
2667 blc_ctx->bandwidth_in,
2668 blc_ctx->bandwidth_out);
2669 if (ACK_SEND_SYN_ACK == n->ack_state)
2671 /* Send pending SYN_ACK message */
2672 n->ack_state = ACK_SEND_ACK;
2673 send_syn_ack_message (&n->primary_address,
2674 n->connect_ack_timestamp);
2676 set_state_and_timeout (n,
2677 GNUNET_TRANSPORT_PS_RECONNECT_SENT,
2678 GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT));
2679 send_syn (&n->primary_address);
2681 case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
2682 /* ATS asks us to switch while we were trying to reconnect; switch to new
2683 address and send SYN again */
2684 set_primary_address (n,
2687 blc_ctx->bandwidth_in,
2688 blc_ctx->bandwidth_out);
2689 set_state_and_timeout (n,
2690 GNUNET_TRANSPORT_PS_RECONNECT_SENT,
2691 GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT));
2692 send_syn (&n->primary_address);
2694 case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
2695 if ( (0 == GNUNET_HELLO_address_cmp (n->primary_address.address,
2696 blc_ctx->address)) &&
2697 (n->primary_address.session == blc_ctx->session) )
2699 /* ATS switches back to still-active session */
2700 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2701 "ATS double-switched, cleaning up alternative address\n");
2702 free_address (&n->alternative_address);
2703 set_state_and_timeout (n,
2704 GNUNET_TRANSPORT_PS_CONNECTED,
2708 /* ATS asks us to switch a life connection, send */
2709 set_alternative_address (n,
2712 blc_ctx->bandwidth_in,
2713 blc_ctx->bandwidth_out);
2714 set_state_and_timeout (n,
2715 GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT,
2716 GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
2717 send_syn (&n->alternative_address);
2719 case GNUNET_TRANSPORT_PS_DISCONNECT:
2720 /* not going to switch addresses while disconnecting */
2721 GNUNET_STATISTICS_update (GST_stats,
2722 "# ATS suggestion ignored (disconnecting)",
2726 case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
2730 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2731 "Unhandled state `%s'\n",
2732 GNUNET_TRANSPORT_ps2s (n->state));
2737 GNUNET_CONTAINER_DLL_remove (pending_bc_head,
2740 GNUNET_HELLO_address_free (blc_ctx->address);
2741 GNUNET_free (blc_ctx);
2746 * For the given peer, switch to this address.
2748 * Before accepting this addresses and actively using it, a blacklist check
2751 * If any check fails or the suggestion can somehow not be followed, we
2752 * MUST call #GST_ats_block_address() to tell ATS that the suggestion
2753 * could not be satisfied and force ATS to do something else.
2755 * @param address address of the other peer,
2756 * @param session session to use or NULL if transport should initiate a session
2757 * @param bandwidth_in inbound quota to be used when connection is up,
2758 * 0 to disconnect from peer
2759 * @param bandwidth_out outbound quota to be used when connection is up,
2760 * 0 to disconnect from peer
2763 GST_neighbours_switch_to_address (const struct GNUNET_HELLO_Address *address,
2764 struct Session *session,
2765 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
2766 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
2768 struct GST_BlacklistCheck *blc;
2769 struct BlacklistCheckSwitchContext *blc_ctx;
2771 GNUNET_assert (NULL != address->transport_name);
2773 try_run_fast_ats_update (address,
2779 /* Check if plugin is available */
2780 if (NULL == (GST_plugins_find (address->transport_name)))
2782 /* we don't have the plugin for this address */
2784 GST_ats_block_address (address,
2788 if ((NULL == session) &&
2789 (GNUNET_HELLO_address_check_option (address,
2790 GNUNET_HELLO_ADDRESS_INFO_INBOUND)))
2792 /* This is a inbound address and we do not have a session to use! */
2794 GST_ats_block_address (address,
2799 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2800 "ATS suggests address '%s' for peer `%s' at %u/%u speed\n",
2801 GST_plugins_a2s (address),
2802 GNUNET_i2s (&address->peer),
2803 (unsigned int) ntohl (bandwidth_in.value__),
2804 (unsigned int) ntohl (bandwidth_out.value__));
2806 /* Perform blacklist check */
2807 blc_ctx = GNUNET_new (struct BlacklistCheckSwitchContext);
2808 blc_ctx->address = GNUNET_HELLO_address_copy (address);
2809 blc_ctx->session = session;
2810 blc_ctx->bandwidth_in = bandwidth_in;
2811 blc_ctx->bandwidth_out = bandwidth_out;
2812 GNUNET_CONTAINER_DLL_insert (pending_bc_head,
2815 if (NULL != (blc = GST_blacklist_test_allowed (&address->peer,
2816 address->transport_name,
2817 &switch_address_bl_check_cont,
2826 * Function called to send network utilization data to ATS for
2827 * each active connection.
2830 * @param key peer we send utilization data for
2831 * @param value the `struct NeighbourMapEntry *` with data to send
2832 * @return #GNUNET_OK (continue to iterate)
2835 send_utilization_data (void *cls,
2836 const struct GNUNET_PeerIdentity *key,
2839 struct NeighbourMapEntry *n = value;
2842 struct GNUNET_TIME_Relative delta;
2844 if ( (GNUNET_YES != test_connected (n)) ||
2845 (NULL == n->primary_address.address) )
2847 delta = GNUNET_TIME_absolute_get_difference (n->last_util_transmission,
2848 GNUNET_TIME_absolute_get ());
2850 if ((0 != n->util_total_bytes_recv) && (0 != delta.rel_value_us))
2851 bps_in = (1000LL * 1000LL * n->util_total_bytes_recv) / (delta.rel_value_us);
2853 if ((0 != n->util_total_bytes_sent) && (0 != delta.rel_value_us))
2854 bps_out = (1000LL * 1000LL * n->util_total_bytes_sent) / delta.rel_value_us;
2856 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2857 "`%s' total: received %u Bytes/s, sent %u Bytes/s\n",
2861 GST_ats_update_utilization (n->primary_address.address,
2864 n->util_total_bytes_recv = 0;
2865 n->util_total_bytes_sent = 0;
2866 n->last_util_transmission = GNUNET_TIME_absolute_get ();
2872 * Task transmitting utilization in a regular interval
2874 * @param cls the 'struct NeighbourMapEntry' for which we are running
2875 * @param tc scheduler context (unused)
2878 utilization_transmission (void *cls,
2879 const struct GNUNET_SCHEDULER_TaskContext *tc)
2881 util_transmission_tk = NULL;
2882 GNUNET_CONTAINER_multipeermap_iterate (neighbours,
2883 &send_utilization_data,
2885 util_transmission_tk
2886 = GNUNET_SCHEDULER_add_delayed (UTIL_TRANSMISSION_INTERVAL,
2887 &utilization_transmission,
2893 * Track information about data we received from the
2894 * given address (used to notify ATS about our utilization
2895 * of allocated resources).
2897 * @param address the address we got data from
2898 * @param message the message we received (really only the size is used)
2901 GST_neighbours_notify_data_recv (const struct GNUNET_HELLO_Address *address,
2902 const struct GNUNET_MessageHeader *message)
2904 struct NeighbourMapEntry *n;
2906 n = lookup_neighbour (&address->peer);
2909 n->util_total_bytes_recv += ntohs (message->size);
2914 * Track information about data we transmitted using the given @a
2915 * address and @a session (used to notify ATS about our utilization of
2916 * allocated resources).
2918 * @param address the address we transmitted data to
2919 * @param session session we used to transmit data
2920 * @param message the message we sent (really only the size is used)
2923 GST_neighbours_notify_data_sent (const struct GNUNET_HELLO_Address *address,
2924 struct Session *session,
2927 struct NeighbourMapEntry *n;
2929 n = lookup_neighbour (&address->peer);
2932 if (n->primary_address.session != session)
2934 n->util_total_bytes_sent += size;
2939 * Master task run for every neighbour. Performs all of the time-related
2940 * activities (keep alive, send next message, disconnect if idle, finish
2941 * clean up after disconnect).
2943 * @param cls the 'struct NeighbourMapEntry' for which we are running
2944 * @param tc scheduler context (unused)
2947 master_task (void *cls,
2948 const struct GNUNET_SCHEDULER_TaskContext *tc)
2950 struct NeighbourMapEntry *n = cls;
2951 struct GNUNET_TIME_Relative delay;
2954 delay = GNUNET_TIME_absolute_get_remaining (n->timeout);
2955 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2956 "Master task runs for neighbour `%s' in state %s with timeout in %s\n",
2957 GNUNET_i2s (&n->id),
2958 GNUNET_TRANSPORT_ps2s(n->state),
2959 GNUNET_STRINGS_relative_time_to_string (delay,
2963 case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
2964 /* invalid state for master task, clean up */
2968 case GNUNET_TRANSPORT_PS_INIT_ATS:
2969 if (0 == delay.rel_value_us)
2971 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2972 "Connection to `%s' timed out waiting for ATS to provide address\n",
2973 GNUNET_i2s (&n->id));
2978 case GNUNET_TRANSPORT_PS_SYN_SENT:
2979 if (0 == delay.rel_value_us)
2981 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2982 "Connection to `%s' timed out waiting for other peer to send SYN_ACK\n",
2983 GNUNET_i2s (&n->id));
2984 /* Remove address and request and additional one */
2985 unset_primary_address (n);
2986 set_state_and_timeout (n,
2987 GNUNET_TRANSPORT_PS_INIT_ATS,
2988 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
2992 case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
2993 if (0 == delay.rel_value_us)
2995 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2996 "Connection to `%s' timed out waiting ATS to provide address to use for SYN_ACK\n",
2997 GNUNET_i2s (&n->id));
3002 case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
3003 if (0 == delay.rel_value_us)
3005 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3006 "Connection to `%s' timed out waiting for other peer to send ACK\n",
3007 GNUNET_i2s (&n->id));
3008 disconnect_neighbour (n);
3012 case GNUNET_TRANSPORT_PS_CONNECTED:
3013 if (0 == delay.rel_value_us)
3015 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3016 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs\n",
3017 GNUNET_i2s (&n->id));
3018 disconnect_neighbour (n);
3021 try_transmission_to_peer (n);
3024 case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
3025 if (0 == delay.rel_value_us)
3027 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3028 "Connection to `%s' timed out, waiting for ATS replacement address\n",
3029 GNUNET_i2s (&n->id));
3030 disconnect_neighbour (n);
3034 case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
3035 if (0 == delay.rel_value_us)
3037 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3038 "Connection to `%s' timed out, waiting for other peer to SYN_ACK replacement address\n",
3039 GNUNET_i2s (&n->id));
3040 disconnect_neighbour (n);
3044 case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
3045 if (0 == delay.rel_value_us)
3047 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3048 "Switch failed, cleaning up alternative address\n");
3049 free_address (&n->alternative_address);
3050 set_state_and_timeout (n,
3051 GNUNET_TRANSPORT_PS_CONNECTED,
3052 GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT));
3054 try_transmission_to_peer (n);
3057 case GNUNET_TRANSPORT_PS_DISCONNECT:
3058 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3059 "Cleaning up connection to `%s' after sending DISCONNECT\n",
3060 GNUNET_i2s (&n->id));
3063 case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
3064 /* how did we get here!? */
3068 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3069 "Unhandled state `%s'\n",
3070 GNUNET_TRANSPORT_ps2s (n->state));
3074 delay = GNUNET_TIME_absolute_get_remaining (n->timeout);
3075 if ( (GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT == n->state) ||
3076 (GNUNET_TRANSPORT_PS_CONNECTED == n->state) )
3078 /* if we are *now* in one of the two states, we're sending
3079 keep alive messages, so we need to consider the keepalive
3080 delay, not just the connection timeout */
3081 delay = GNUNET_TIME_relative_min (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time),
3084 if (NULL == n->task)
3085 n->task = GNUNET_SCHEDULER_add_delayed (delay,
3092 * Send a ACK message to the neighbour to confirm that we
3095 * @param n neighbour to send the ACK to
3098 send_session_ack_message (struct NeighbourMapEntry *n)
3100 struct GNUNET_MessageHeader msg;
3102 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3103 "Sending ACK message to peer `%s'\n",
3104 GNUNET_i2s (&n->id));
3106 msg.size = htons (sizeof (struct GNUNET_MessageHeader));
3107 msg.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK);
3108 (void) send_with_session (n,
3110 sizeof (struct GNUNET_MessageHeader),
3112 GNUNET_TIME_UNIT_FOREVER_REL,
3119 * We received a 'SESSION_SYN_ACK' message from the other peer.
3120 * Consider switching to it.
3122 * @param message possibly a `struct SessionConnectMessage` (check format)
3123 * @param peer identity of the peer to switch the address for
3124 * @param address address of the other peer, NULL if other peer
3126 * @param session session to use (or NULL)
3127 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
3130 GST_neighbours_handle_session_syn_ack (const struct GNUNET_MessageHeader *message,
3131 const struct GNUNET_HELLO_Address *address,
3132 struct Session *session)
3134 const struct TransportSynMessage *scm;
3135 struct GNUNET_TIME_Absolute ts;
3136 struct NeighbourMapEntry *n;
3138 if (ntohs (message->size) != sizeof (struct TransportSynMessage))
3140 GNUNET_break_op (0);
3141 return GNUNET_SYSERR;
3143 GNUNET_STATISTICS_update (GST_stats,
3145 ("# SYN_ACK messages received"),
3147 scm = (const struct TransportSynMessage *) message;
3148 GNUNET_break_op (ntohl (scm->reserved) == 0);
3149 if (NULL == (n = lookup_neighbour (&address->peer)))
3151 GNUNET_STATISTICS_update (GST_stats,
3153 ("# unexpected SYN_ACK messages (no peer)"),
3155 return GNUNET_SYSERR;
3157 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3158 "Received SYN_ACK message from peer `%s' in state %s/%s\n",
3159 GNUNET_i2s (&address->peer),
3160 GNUNET_TRANSPORT_ps2s (n->state),
3161 print_ack_state (n->ack_state));
3162 ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
3165 case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
3168 return GNUNET_SYSERR;
3169 case GNUNET_TRANSPORT_PS_INIT_ATS:
3170 GNUNET_STATISTICS_update (GST_stats,
3171 gettext_noop ("# unexpected SYN_ACK messages (not ready)"),
3175 case GNUNET_TRANSPORT_PS_SYN_SENT:
3176 if (ts.abs_value_us != n->primary_address.connect_timestamp.abs_value_us)
3178 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3179 "SYN_ACK ignored as the timestamp does not match our SYN request\n");
3182 set_state_and_timeout (n,
3183 GNUNET_TRANSPORT_PS_CONNECTED,
3184 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT));
3185 set_primary_address (n,
3186 n->primary_address.address,
3187 n->primary_address.session,
3188 n->primary_address.bandwidth_in,
3189 n->primary_address.bandwidth_out);
3190 send_session_ack_message (n);
3192 case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
3193 case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
3194 GNUNET_STATISTICS_update (GST_stats,
3195 gettext_noop ("# unexpected SYN_ACK messages (not ready)"),
3199 case GNUNET_TRANSPORT_PS_CONNECTED:
3200 /* duplicate SYN_ACK, let's answer by duplicate ACK just in case */
3201 send_session_ack_message (n);
3203 case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
3204 /* we didn't expect any SYN_ACK, as we are waiting for ATS
3205 to give us a new address... */
3206 GNUNET_STATISTICS_update (GST_stats,
3207 gettext_noop ("# unexpected SYN_ACK messages (waiting on ATS)"),
3211 case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
3212 /* Reconnecting with new address address worked; go back to connected! */
3213 set_state_and_timeout (n,
3214 GNUNET_TRANSPORT_PS_CONNECTED,
3215 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT));
3216 send_session_ack_message (n);
3218 case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
3219 /* new address worked; adopt it and go back to connected! */
3220 set_state_and_timeout (n,
3221 GNUNET_TRANSPORT_PS_CONNECTED,
3222 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT));
3223 GNUNET_break (GNUNET_NO == n->alternative_address.ats_active);
3225 /* Set primary addresses */
3226 set_primary_address (n,
3227 n->alternative_address.address,
3228 n->alternative_address.session,
3229 n->alternative_address.bandwidth_in,
3230 n->alternative_address.bandwidth_out);
3231 GNUNET_STATISTICS_update (GST_stats,
3232 gettext_noop ("# Successful attempts to switch addresses"),
3236 GNUNET_HELLO_address_free (n->alternative_address.address);
3237 memset (&n->alternative_address,
3239 sizeof (n->alternative_address));
3240 send_session_ack_message (n);
3242 case GNUNET_TRANSPORT_PS_DISCONNECT:
3243 GNUNET_STATISTICS_update (GST_stats,
3245 ("# unexpected SYN_ACK messages (disconnecting)"),
3247 return GNUNET_SYSERR;
3248 case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
3252 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3253 "Unhandled state `%s'\n",
3254 GNUNET_TRANSPORT_ps2s (n->state));
3256 return GNUNET_SYSERR;
3263 * A session was terminated. Take note; if needed, try to get
3264 * an alternative address from ATS.
3266 * @param peer identity of the peer where the session died
3267 * @param session session that is gone
3268 * @return #GNUNET_YES if this was a session used, #GNUNET_NO if
3269 * this session was not in use
3272 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
3273 struct Session *session)
3275 struct NeighbourMapEntry *n;
3276 struct BlackListCheckContext *bcc;
3277 struct BlackListCheckContext *bcc_next;
3279 /* make sure to cancel all ongoing blacklist checks involving 'session' */
3281 while (NULL != (bcc = bcc_next))
3283 bcc_next = bcc->next;
3284 if (bcc->na.session == session)
3286 if (NULL != bcc->bc)
3287 GST_blacklist_test_cancel (bcc->bc);
3288 GNUNET_HELLO_address_free (bcc->na.address);
3289 GNUNET_CONTAINER_DLL_remove (bc_head,
3295 if (NULL == (n = lookup_neighbour (peer)))
3296 return GNUNET_NO; /* can't affect us */
3297 if (session != n->primary_address.session)
3299 /* Free alternative address */
3300 if (session == n->alternative_address.session)
3302 if (GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT == n->state)
3303 set_state_and_timeout (n,
3304 GNUNET_TRANSPORT_PS_CONNECTED,
3306 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3307 "Session died, cleaning up alternative address\n");
3308 free_address (&n->alternative_address);
3310 return GNUNET_NO; /* doesn't affect us further */
3313 n->expect_latency_response = GNUNET_NO;
3314 /* The session for neighbour's primary address died */
3317 case GNUNET_TRANSPORT_PS_NOT_CONNECTED:
3321 case GNUNET_TRANSPORT_PS_INIT_ATS:
3325 case GNUNET_TRANSPORT_PS_SYN_SENT:
3326 /* The session used to send the SYN terminated:
3327 * this implies a connect error*/
3328 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3329 "Failed to send SYN in %s with `%s' %p: session terminated\n",
3331 GST_plugins_a2s (n->primary_address.address),
3332 n->primary_address.session,
3335 /* Destroy the address since it cannot be used */
3336 unset_primary_address (n);
3337 set_state_and_timeout (n,
3338 GNUNET_TRANSPORT_PS_INIT_ATS,
3339 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
3341 case GNUNET_TRANSPORT_PS_SYN_RECV_ATS:
3342 case GNUNET_TRANSPORT_PS_SYN_RECV_ACK:
3343 /* error on inbound session; free neighbour entirely */
3346 case GNUNET_TRANSPORT_PS_CONNECTED:
3347 /* Our primary connection died, try a fast reconnect */
3348 unset_primary_address (n);
3349 set_state_and_timeout (n,
3350 GNUNET_TRANSPORT_PS_RECONNECT_ATS,
3351 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
3353 case GNUNET_TRANSPORT_PS_RECONNECT_ATS:
3354 /* we don't have an address, how can it go down? */
3357 case GNUNET_TRANSPORT_PS_RECONNECT_SENT:
3358 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3359 "Failed to send SYN in %s with `%s' %p: session terminated\n",
3361 GST_plugins_a2s (n->primary_address.address),
3362 n->primary_address.session,
3364 /* Destroy the address since it cannot be used */
3365 unset_primary_address (n);
3366 set_state_and_timeout (n,
3367 GNUNET_TRANSPORT_PS_RECONNECT_ATS,
3368 GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT));
3370 case GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT:
3371 /* primary went down while we were waiting for SYN_ACK on secondary;
3372 secondary as primary */
3374 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3375 "Connection `%s' %p to peer `%s' was terminated while switching, "
3376 "switching to alternative address `%s' %p\n",
3377 GST_plugins_a2s (n->primary_address.address),
3378 n->primary_address.session,
3380 GST_plugins_a2s (n->alternative_address.address),
3381 n->alternative_address.session);
3383 /* Destroy the inbound address since it cannot be used */
3384 free_address (&n->primary_address);
3385 n->primary_address = n->alternative_address;
3386 memset (&n->alternative_address,
3388 sizeof (struct NeighbourAddress));
3389 set_state_and_timeout (n,
3390 GNUNET_TRANSPORT_PS_RECONNECT_SENT,
3391 GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT));
3393 case GNUNET_TRANSPORT_PS_DISCONNECT:
3394 unset_primary_address (n);
3396 case GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED:
3397 /* neighbour was freed and plugins told to terminate session */
3400 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3401 "Unhandled state `%s'\n",
3402 GNUNET_TRANSPORT_ps2s (n->state));
3406 if (NULL != n->task)
3407 GNUNET_SCHEDULER_cancel (n->task);
3408 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
3414 * We received a 'ACK' message from the other peer.
3415 * If we sent a 'SYN_ACK' last, this means we are now
3416 * connected. Otherwise, do nothing.
3418 * @param message possibly a 'struct SessionConnectMessage' (check format)
3419 * @param address address of the other peer
3420 * @param session session to use (or NULL)
3421 * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
3424 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
3425 const struct GNUNET_HELLO_Address *address,
3426 struct Session *session)
3428 struct NeighbourMapEntry *n;
3430 if (ntohs (message->size) != sizeof (struct GNUNET_MessageHeader))
3432 GNUNET_break_op (0);
3433 return GNUNET_SYSERR;
3435 GNUNET_STATISTICS_update (GST_stats,
3436 gettext_noop ("# ACK messages received"),
3439 if (NULL == (n = lookup_neighbour (&address->peer)))
3441 GNUNET_break_op (0);
3442 return GNUNET_SYSERR;
3444 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3445 "Received ACK for peer `%s' in state %s/%s\n",
3446 GNUNET_i2s (&address->peer),
3447 GNUNET_TRANSPORT_ps2s (n->state),
3448 print_ack_state (n->ack_state));
3450 /* Check if we are in a plausible state for having sent
3451 a SYN_ACK. If not, return, otherwise break.
3453 The remote peers sends a ACK as a response for a SYN_ACK
3457 - If a remote peer has sent a SYN, we responded with a SYN_ACK and
3458 now wait for the ACK to finally be connected
3459 - If we sent a SYN_ACK to this peer before */
3461 if ( (GNUNET_TRANSPORT_PS_SYN_RECV_ACK != n->state) &&
3462 (ACK_SEND_ACK != n->ack_state))
3464 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
3465 "Received unexpected ACK message from peer `%s' in state %s/%s\n",
3466 GNUNET_i2s (&address->peer),
3467 GNUNET_TRANSPORT_ps2s (n->state),
3468 print_ack_state (n->ack_state));
3470 GNUNET_STATISTICS_update (GST_stats,
3471 gettext_noop ("# unexpected ACK messages"), 1,
3475 if (GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT == n->state)
3477 /* We tried to switch addresses while being connect. We explicitly wait
3478 * for a SYN_ACK before going to GNUNET_TRANSPORT_PS_CONNECTED,
3479 * so we do not want to set the address as in use! */
3482 set_state_and_timeout (n,
3483 GNUNET_TRANSPORT_PS_CONNECTED,
3484 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT));
3486 /* Reset backoff for primary address */
3487 GST_ats_block_reset (n->primary_address.address,
3488 n->primary_address.session);
3494 * Test if we're connected to the given peer.
3496 * @param target peer to test
3497 * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
3500 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target)
3502 return test_connected (lookup_neighbour (target));
3507 * Change the incoming quota for the given peer.
3509 * @param neighbour identity of peer to change qutoa for
3510 * @param quota new quota
3513 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
3514 struct GNUNET_BANDWIDTH_Value32NBO quota)
3516 struct NeighbourMapEntry *n;
3518 if (NULL == (n = lookup_neighbour (neighbour)))
3520 GNUNET_STATISTICS_update (GST_stats,
3522 ("# SET QUOTA messages ignored (no such peer)"),
3526 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3527 "Setting inbound quota of %u Bps for peer `%s' to all clients\n",
3528 ntohl (quota.value__), GNUNET_i2s (&n->id));
3529 GNUNET_BANDWIDTH_tracker_update_quota (&n->in_tracker, quota);
3530 if (0 != ntohl (quota.value__))
3532 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3533 "Disconnecting peer `%4s' due to SET_QUOTA\n",
3534 GNUNET_i2s (&n->id));
3535 if (GNUNET_YES == test_connected (n))
3536 GNUNET_STATISTICS_update (GST_stats,
3537 gettext_noop ("# disconnects due to quota of 0"),
3539 disconnect_neighbour (n);
3544 * Task to asynchronously run #free_neighbour().
3546 * @param cls the `struct NeighbourMapEntry` to free
3550 delayed_disconnect (void *cls,
3551 const struct GNUNET_SCHEDULER_TaskContext* tc)
3553 struct NeighbourMapEntry *n = cls;
3555 n->delayed_disconnect_task = NULL;
3556 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3557 "Disconnecting by request from peer %s\n",
3558 GNUNET_i2s (&n->id));
3564 * We received a disconnect message from the given peer,
3565 * validate and process.
3567 * @param peer sender of the message
3568 * @param msg the disconnect message
3571 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity *peer,
3572 const struct GNUNET_MessageHeader *msg)
3574 struct NeighbourMapEntry *n;
3575 const struct SessionDisconnectMessage *sdm;
3577 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3578 "Received DISCONNECT message from peer `%s'\n",
3580 if (ntohs (msg->size) != sizeof (struct SessionDisconnectMessage))
3582 GNUNET_break_op (0);
3583 GNUNET_STATISTICS_update (GST_stats,
3585 ("# disconnect messages ignored (malformed)"), 1,
3589 GNUNET_STATISTICS_update (GST_stats,
3591 ("# DISCONNECT messages received"),
3593 sdm = (const struct SessionDisconnectMessage *) msg;
3594 if (NULL == (n = lookup_neighbour (peer)))
3599 if (GNUNET_TIME_absolute_ntoh (sdm->timestamp).abs_value_us <= n->connect_ack_timestamp.abs_value_us)
3601 GNUNET_STATISTICS_update (GST_stats,
3602 gettext_noop ("# disconnect messages ignored (timestamp)"),
3607 if (0 != memcmp (peer,
3609 sizeof (struct GNUNET_PeerIdentity)))
3611 GNUNET_break_op (0);
3614 if (ntohl (sdm->purpose.size) !=
3615 sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
3616 sizeof (struct GNUNET_CRYPTO_EddsaPublicKey) +
3617 sizeof (struct GNUNET_TIME_AbsoluteNBO))
3619 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3620 "DISCONNECT message from peer `%s' has invalid size\n",
3622 GNUNET_break_op (0);
3626 GNUNET_CRYPTO_eddsa_verify (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT,
3631 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3632 "DISCONNECT message from peer `%s' cannot be verified \n",
3634 GNUNET_break_op (0);
3637 n->delayed_disconnect_task = GNUNET_SCHEDULER_add_now (&delayed_disconnect, n);
3642 * Closure for the #neighbours_iterate() function.
3644 struct IteratorContext
3647 * Function to call on each connected neighbour.
3649 GST_NeighbourIterator cb;
3652 * Closure for @e cb.
3659 * Call the callback from the closure for each neighbour.
3661 * @param cls the `struct IteratorContext`
3662 * @param key the hash of the public key of the neighbour
3663 * @param value the `struct NeighbourMapEntry`
3664 * @return #GNUNET_OK (continue to iterate)
3667 neighbours_iterate (void *cls,
3668 const struct GNUNET_PeerIdentity *key,
3671 struct IteratorContext *ic = cls;
3672 struct NeighbourMapEntry *n = value;
3673 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
3674 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
3676 if (NULL != n->primary_address.address)
3678 bandwidth_in = n->primary_address.bandwidth_in;
3679 bandwidth_out = n->primary_address.bandwidth_out;
3683 bandwidth_in = GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT;
3684 bandwidth_out = GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT;
3688 n->primary_address.address,
3691 bandwidth_in, bandwidth_out);
3697 * Iterate over all connected neighbours.
3699 * @param cb function to call
3700 * @param cb_cls closure for cb
3703 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls)
3705 struct IteratorContext ic;
3707 if (NULL == neighbours)
3708 return; /* can happen during shutdown */
3711 GNUNET_CONTAINER_multipeermap_iterate (neighbours,
3712 &neighbours_iterate,
3718 * If we have an active connection to the given target, it must be shutdown.
3720 * @param target peer to disconnect from
3723 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target)
3725 struct NeighbourMapEntry *n;
3727 if (NULL == (n = lookup_neighbour (target)))
3728 return; /* not active */
3729 if (GNUNET_YES == test_connected (n))
3730 GNUNET_STATISTICS_update (GST_stats,
3731 gettext_noop ("# disconnected from peer upon explicit request"),
3734 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
3735 "Forced disconnect from peer %s\n",
3736 GNUNET_i2s (target));
3737 disconnect_neighbour (n);
3742 * Obtain current address information for the given neighbour.
3745 * @return address currently used
3747 struct GNUNET_HELLO_Address *
3748 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer)
3750 struct NeighbourMapEntry *n;
3752 n = lookup_neighbour (peer);
3755 return n->primary_address.address;
3760 * Initialize the neighbours subsystem.
3762 * @param max_fds maximum number of fds to use
3765 GST_neighbours_start (unsigned int max_fds)
3767 neighbours = GNUNET_CONTAINER_multipeermap_create (NEIGHBOUR_TABLE_SIZE,
3769 util_transmission_tk = GNUNET_SCHEDULER_add_delayed (UTIL_TRANSMISSION_INTERVAL,
3770 &utilization_transmission,
3776 * Disconnect from the given neighbour.
3779 * @param key hash of neighbour's public key (not used)
3780 * @param value the 'struct NeighbourMapEntry' of the neighbour
3781 * @return #GNUNET_OK (continue to iterate)
3784 disconnect_all_neighbours (void *cls,
3785 const struct GNUNET_PeerIdentity *key,
3788 struct NeighbourMapEntry *n = value;
3790 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3791 "Disconnecting peer `%4s' during shutdown\n",
3792 GNUNET_i2s (&n->id));
3799 * Cleanup the neighbours subsystem.
3802 GST_neighbours_stop ()
3804 struct BlacklistCheckSwitchContext *cur;
3805 struct BlacklistCheckSwitchContext *next;
3807 if (NULL == neighbours)
3809 if (NULL != util_transmission_tk)
3811 GNUNET_SCHEDULER_cancel (util_transmission_tk);
3812 util_transmission_tk = NULL;
3814 GNUNET_CONTAINER_multipeermap_iterate (neighbours,
3815 &disconnect_all_neighbours,
3817 GNUNET_CONTAINER_multipeermap_destroy (neighbours);
3819 next = pending_bc_head;
3820 for (cur = next; NULL != cur; cur = next)
3823 GNUNET_CONTAINER_DLL_remove (pending_bc_head,
3827 if (NULL != cur->blc)
3829 GST_blacklist_test_cancel (cur->blc);
3832 if (NULL != cur->address)
3833 GNUNET_HELLO_address_free (cur->address);
3839 /* end of file gnunet-service-transport_neighbours.c */