2 This file is part of GNUnet.
3 (C) 2010-2013 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 * - "address_change_cb" is NEVER invoked; when should we call this one exactly?
28 * - TEST, TEST, TEST...
31 #include "gnunet_ats_service.h"
32 #include "gnunet-service-transport_neighbours.h"
33 #include "gnunet-service-transport_plugins.h"
34 #include "gnunet-service-transport_validation.h"
35 #include "gnunet-service-transport_clients.h"
36 #include "gnunet-service-transport.h"
37 #include "gnunet_peerinfo_service.h"
38 #include "gnunet-service-transport_blacklist.h"
39 #include "gnunet_constants.h"
40 #include "transport.h"
45 * Size of the neighbour hash map.
47 #define NEIGHBOUR_TABLE_SIZE 256
50 * Time we give plugin to transmit DISCONNECT message before the
51 * neighbour entry self-destructs.
53 #define DISCONNECT_SENT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 100)
56 * How often must a peer violate bandwidth quotas before we start
57 * to simply drop its messages?
59 #define QUOTA_VIOLATION_DROP_THRESHOLD 10
62 * How often do we send KEEPALIVE messages to each of our neighbours and measure
63 * the latency with this neighbour?
64 * (idle timeout is 5 minutes or 300 seconds, so with 100s interval we
65 * send 3 keepalives in each interval, so 3 messages would need to be
66 * lost in a row for a disconnect).
68 #define KEEPALIVE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 100)
71 * How long are we willing to wait for a response from ATS before timing out?
73 #define ATS_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 5000)
76 * How long are we willing to wait for an ACK from the other peer before
77 * giving up on our connect operation?
79 #define SETUP_CONNECTION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
82 * How long are we willing to wait for a successful reconnect if
83 * an existing connection went down? Much shorter than the
84 * usual SETUP_CONNECTION_TIMEOUT as we do not inform the
85 * higher layers about the disconnect during this period.
87 #define FAST_RECONNECT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
90 * How long are we willing to wait for a response from the blacklist
91 * subsystem before timing out?
93 #define BLACKLIST_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 500)
96 * Interval to send utilization data
98 #define UTIL_TRANSMISSION_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
100 GNUNET_NETWORK_STRUCT_BEGIN
103 * Message a peer sends to another to indicate that it intends to
104 * setup a connection/session for data exchange. A 'SESSION_CONNECT'
105 * should be answered with a 'SESSION_CONNECT_ACK' with the same body
106 * to confirm. A 'SESSION_CONNECT_ACK' should then be followed with
107 * a 'SESSION_ACK'. Once the 'SESSION_ACK' is received, both peers
108 * should be connected.
110 struct SessionConnectMessage
113 * Header of type 'GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT'
114 * or 'GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK'
116 struct GNUNET_MessageHeader header;
121 uint32_t reserved GNUNET_PACKED;
124 * Absolute time at the sender. Only the most recent connect
125 * message implies which session is preferred by the sender.
127 struct GNUNET_TIME_AbsoluteNBO timestamp;
133 * Message we send to the other peer to notify him that we intentionally
134 * are disconnecting (to reduce timeouts). This is just a friendly
135 * notification, peers must not rely on always receiving disconnect
138 struct SessionDisconnectMessage
141 * Header of type 'GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT'
143 struct GNUNET_MessageHeader header;
148 uint32_t reserved GNUNET_PACKED;
151 * Purpose of the signature. Extends over the timestamp.
152 * Purpose should be GNUNET_SIGNATURE_PURPOSE_TRANSPORT_DISCONNECT.
154 struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
157 * Absolute time at the sender. Only the most recent connect
158 * message implies which session is preferred by the sender.
160 struct GNUNET_TIME_AbsoluteNBO timestamp;
163 * Public key of the sender.
165 struct GNUNET_CRYPTO_EddsaPublicKey public_key;
168 * Signature of the peer that sends us the disconnect. Only
169 * valid if the timestamp is AFTER the timestamp from the
170 * corresponding 'CONNECT' message.
172 struct GNUNET_CRYPTO_EddsaSignature signature;
176 GNUNET_NETWORK_STRUCT_END
180 * For each neighbour we keep a list of messages
181 * that we still want to transmit to the neighbour.
187 * This is a doubly linked list.
189 struct MessageQueue *next;
192 * This is a doubly linked list.
194 struct MessageQueue *prev;
197 * Function to call once we're done.
199 GST_NeighbourSendContinuation cont;
207 * The message(s) we want to transmit, GNUNET_MessageHeader(s)
208 * stuck together in memory. Allocated at the end of this struct.
210 const char *message_buf;
213 * Size of the message buf
215 size_t message_buf_size;
218 * At what time should we fail?
220 struct GNUNET_TIME_Absolute timeout;
226 * Possible state of a neighbour. Initially, we are S_NOT_CONNECTED.
228 * Then, there are two main paths. If we receive a CONNECT message, we
229 * first run a check against the blacklist (S_CONNECT_RECV_BLACKLIST_INBOUND).
230 * If this check is successful, we give the inbound address to ATS.
231 * After the check we ask ATS for a suggestion (S_CONNECT_RECV_ATS).
232 * If ATS makes a suggestion, we ALSO give that suggestion to the blacklist
233 * (S_CONNECT_RECV_BLACKLIST). Once the blacklist approves the
234 * address we got from ATS, we send our CONNECT_ACK and go to
235 * S_CONNECT_RECV_ACK. If we receive a SESSION_ACK, we go to
236 * S_CONNECTED (and notify everyone about the new connection). If the
237 * operation times out, we go to S_DISCONNECT.
239 * The other case is where we transmit a CONNECT message first. We
240 * start with S_INIT_ATS. If we get an address, we enter
241 * S_INIT_BLACKLIST and check the blacklist. If the blacklist is OK
242 * with the connection, we actually send the CONNECT message and go to
243 * state S_CONNECT_SENT. Once we receive a CONNECT_ACK, we go to
244 * S_CONNECTED (and notify everyone about the new connection and send
245 * back a SESSION_ACK). If the operation times out, we go to
248 * If the session is in trouble (i.e. transport-level disconnect or
249 * timeout), we go to S_RECONNECT_ATS where we ask ATS for a new
250 * address (we don't notify anyone about the disconnect yet). Once we
251 * have a new address, we go to S_RECONNECT_BLACKLIST to check the new
252 * address against the blacklist. If the blacklist approves, we enter
253 * S_RECONNECT_SENT and send a CONNECT message. If we receive a
254 * CONNECT_ACK, we go to S_CONNECTED and nobody noticed that we had
255 * trouble; we also send a SESSION_ACK at this time just in case. If
256 * the operation times out, we go to S_DISCONNECT (and notify everyone
257 * about the lost connection).
259 * If ATS decides to switch addresses while we have a normal
260 * connection, we go to S_CONNECTED_SWITCHING_BLACKLIST to check the
261 * new address against the blacklist. If the blacklist approves, we
262 * go to S_CONNECTED_SWITCHING_CONNECT_SENT and send a
263 * SESSION_CONNECT. If we get a SESSION_ACK back, we switch the
264 * primary connection to the suggested alternative from ATS, go back
265 * to S_CONNECTED and send a SESSION_ACK to the other peer just to be
266 * sure. If the operation times out (or the blacklist disapproves),
267 * we go to S_CONNECTED (and notify ATS that the given alternative
268 * address is "invalid").
270 * Once a session is in S_DISCONNECT, it is cleaned up and then goes
271 * to (S_DISCONNECT_FINISHED). If we receive an explicit disconnect
272 * request, we can go from any state to S_DISCONNECT, possibly after
273 * generating disconnect notifications.
275 * Note that it is quite possible that while we are in any of these
276 * states, we could receive a 'CONNECT' request from the other peer.
277 * We then enter a 'weird' state where we pursue our own primary state
278 * machine (as described above), but with the 'send_connect_ack' flag
279 * set to 1. If our state machine allows us to send a 'CONNECT_ACK'
280 * (because we have an acceptable address), we send the 'CONNECT_ACK'
281 * and set the 'send_connect_ack' to 2. If we then receive a
282 * 'SESSION_ACK', we go to 'S_CONNECTED' (and reset 'send_connect_ack'
289 * fresh peer or completely disconnected
294 * Asked to initiate connection, trying to get address from ATS
299 * Asked to initiate connection, trying to get address approved
305 * Sent CONNECT message to other peer, waiting for CONNECT_ACK
310 * Received a CONNECT, do a blacklist check for inbound address
312 S_CONNECT_RECV_BLACKLIST_INBOUND,
315 * Received a CONNECT, asking ATS about address suggestions.
320 * Received CONNECT from other peer, got an address, checking with blacklist.
322 S_CONNECT_RECV_BLACKLIST,
325 * CONNECT request from other peer was SESSION_ACK'ed, waiting for
331 * Got our CONNECT_ACK/SESSION_ACK, connection is up.
336 * Connection got into trouble, rest of the system still believes
337 * it to be up, but we're getting a new address from ATS.
342 * Connection got into trouble, rest of the system still believes
343 * it to be up; we are checking the new address against the blacklist.
345 S_RECONNECT_BLACKLIST,
348 * Sent CONNECT over new address (either by ATS telling us to switch
349 * addresses or from RECONNECT_ATS); if this fails, we need to tell
350 * the rest of the system about a disconnect.
355 * We have some primary connection, but ATS suggested we switch
356 * to some alternative; we're now checking the alternative against
359 S_CONNECTED_SWITCHING_BLACKLIST,
362 * We have some primary connection, but ATS suggested we switch
363 * to some alternative; we now sent a CONNECT message for the
364 * alternative session to the other peer and waiting for a
365 * CONNECT_ACK to make this our primary connection.
367 S_CONNECTED_SWITCHING_CONNECT_SENT,
370 * Disconnect in progress (we're sending the DISCONNECT message to the
371 * other peer; after that is finished, the state will be cleaned up).
376 * We're finished with the disconnect; and are cleaning up the state
377 * now! We put the struct into this state when we are really in the
378 * task that calls 'free' on it and are about to remove the record
379 * from the map. We should never find a 'struct NeighbourMapEntry'
380 * in this state in the map. Accessing a 'struct NeighbourMapEntry'
381 * in this state virtually always means using memory that has been
382 * freed (the exception being the cleanup code in 'free_neighbour').
384 S_DISCONNECT_FINISHED
389 * A possible address we could use to communicate with a neighbour.
391 struct NeighbourAddress
395 * Active session for this address.
397 struct Session *session;
400 * Network-level address information.
402 struct GNUNET_HELLO_Address *address;
405 * Timestamp of the 'SESSION_CONNECT' message we sent to the other
406 * peer for this address. Use to check that the ACK is in response
407 * to our most recent 'CONNECT'.
409 struct GNUNET_TIME_Absolute connect_timestamp;
412 * Inbound bandwidth from ATS for this address.
414 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
417 * Outbound bandwidth from ATS for this address.
419 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
422 * Did we tell ATS that this is our 'active' address?
430 * Entry in neighbours.
432 struct NeighbourMapEntry
436 * Head of list of messages we would like to send to this peer;
437 * must contain at most one message per client.
439 struct MessageQueue *messages_head;
442 * Tail of list of messages we would like to send to this peer; must
443 * contain at most one message per client.
445 struct MessageQueue *messages_tail;
448 * Are we currently trying to send a message? If so, which one?
450 struct MessageQueue *is_active;
453 * Primary address we currently use to communicate with the neighbour.
455 struct NeighbourAddress primary_address;
458 * Alternative address currently under consideration for communicating
459 * with the neighbour.
461 struct NeighbourAddress alternative_address;
464 * Identity of this neighbour.
466 struct GNUNET_PeerIdentity id;
469 * Main task that drives this peer (timeouts, keepalives, etc.).
470 * Always runs the 'master_task'.
472 GNUNET_SCHEDULER_TaskIdentifier task;
475 * At what time should we sent the next keep-alive message?
477 struct GNUNET_TIME_Absolute keep_alive_time;
480 * At what time did we sent the last keep-alive message? Used
481 * to calculate round-trip time ("latency").
483 struct GNUNET_TIME_Absolute last_keep_alive_time;
486 * Timestamp we should include in our next CONNECT_ACK message.
487 * (only valid if 'send_connect_ack' is GNUNET_YES). Used to build
488 * our CONNECT_ACK message.
490 struct GNUNET_TIME_Absolute connect_ack_timestamp;
493 * ATS address suggest handle
495 struct GNUNET_ATS_SuggestHandle *suggest_handle;
498 * Time where we should cut the connection (timeout) if we don't
499 * make progress in the state machine (or get a KEEPALIVE_RESPONSE
500 * if we are in S_CONNECTED).
502 struct GNUNET_TIME_Absolute timeout;
505 * Latest calculated latency value
507 struct GNUNET_TIME_Relative latency;
510 * Tracker for inbound bandwidth.
512 struct GNUNET_BANDWIDTH_Tracker in_tracker;
515 * How often has the other peer (recently) violated the inbound
516 * traffic limit? Incremented by 10 per violation, decremented by 1
517 * per non-violation (for each time interval).
519 unsigned int quota_violation_count;
522 * The current state of the peer.
527 * Did we sent an KEEP_ALIVE message and are we expecting a response?
529 int expect_latency_response;
532 * Flag to set if we still need to send a CONNECT_ACK message to the other peer
533 * (once we have an address to use and the peer has been allowed by our
534 * blacklist). Set to 1 if we need to send a CONNECT_ACK. Set to 2 if we
535 * did send a CONNECT_ACK and should go to 'S_CONNECTED' upon receiving
536 * a 'SESSION_ACK' (regardless of what our own state machine might say).
538 int send_connect_ack;
541 * Tracking utilization of outbound bandwidth
543 uint32_t util_payload_bytes_sent;
546 * Tracking utilization of inbound bandwidth
548 uint32_t util_payload_bytes_recv;
551 * Tracking utilization of outbound bandwidth
553 uint32_t util_total_bytes_sent;
556 * Tracking utilization of inbound bandwidth
558 uint32_t util_total_bytes_recv;
561 * Date of last utilization transmission
563 struct GNUNET_TIME_Absolute last_util_transmission;
568 * Context for blacklist checks and the 'handle_test_blacklist_cont'
569 * function. Stores information about ongoing blacklist checks.
571 struct BlackListCheckContext
575 * We keep blacklist checks in a DLL.
577 struct BlackListCheckContext *next;
580 * We keep blacklist checks in a DLL.
582 struct BlackListCheckContext *prev;
585 * Address that is being checked.
587 struct NeighbourAddress na;
590 * Handle to the ongoing blacklist check.
592 struct GST_BlacklistCheck *bc;
597 * Hash map from peer identities to the respective 'struct NeighbourMapEntry'.
599 static struct GNUNET_CONTAINER_MultiPeerMap *neighbours;
602 * We keep blacklist checks in a DLL so that we can find
603 * the 'sessions' in their 'struct NeighbourAddress' if
604 * a session goes down.
606 static struct BlackListCheckContext *bc_head;
609 * We keep blacklist checks in a DLL.
611 static struct BlackListCheckContext *bc_tail;
614 * Closure for #connect_notify_cb, #disconnect_notify_cb and #address_change_cb
616 static void *callback_cls;
619 * Function to call when we connected to a neighbour.
621 static NotifyConnect connect_notify_cb;
624 * Function to call when we disconnected from a neighbour.
626 static GNUNET_TRANSPORT_NotifyDisconnect disconnect_notify_cb;
629 * Function to call when we changed an active address of a neighbour.
631 static GNUNET_TRANSPORT_PeerIterateCallback address_change_cb;
634 * counter for connected neighbours
636 static unsigned int neighbours_connected;
639 * Number of bytes we have currently queued for transmission.
641 static unsigned long long bytes_in_send_queue;
644 * Task transmitting utilization data
646 static GNUNET_SCHEDULER_TaskIdentifier util_transmission_tk;
650 * Lookup a neighbour entry in the neighbours hash map.
652 * @param pid identity of the peer to look up
653 * @return the entry, NULL if there is no existing record
655 static struct NeighbourMapEntry *
656 lookup_neighbour (const struct GNUNET_PeerIdentity *pid)
658 if (NULL == neighbours)
660 return GNUNET_CONTAINER_multipeermap_get (neighbours, pid);
665 print_state (int state)
670 case S_NOT_CONNECTED:
671 return "S_NOT_CONNECTED";
674 case S_INIT_BLACKLIST:
675 return "S_INIT_BLACKLIST";
677 return "S_CONNECT_SENT";
678 case S_CONNECT_RECV_BLACKLIST_INBOUND:
679 return "S_CONNECT_RECV_BLACKLIST_INBOUND";
680 case S_CONNECT_RECV_ATS:
681 return "S_CONNECT_RECV_ATS";
682 case S_CONNECT_RECV_BLACKLIST:
683 return "S_CONNECT_RECV_BLACKLIST";
684 case S_CONNECT_RECV_ACK:
685 return "S_CONNECT_RECV_ACK";
687 return "S_CONNECTED";
688 case S_RECONNECT_ATS:
689 return "S_RECONNECT_ATS";
690 case S_RECONNECT_BLACKLIST:
691 return "S_RECONNECT_BLACKLIST";
692 case S_RECONNECT_SENT:
693 return "S_RECONNECT_SENT";
694 case S_CONNECTED_SWITCHING_BLACKLIST:
695 return "S_CONNECTED_SWITCHING_BLACKLIST";
696 case S_CONNECTED_SWITCHING_CONNECT_SENT:
697 return "S_CONNECTED_SWITCHING_CONNECT_SENT";
699 return "S_DISCONNECT";
700 case S_DISCONNECT_FINISHED:
701 return "S_DISCONNECT_FINISHED";
709 * Test if we're connected to the given peer.
711 * @param n neighbour entry of peer to test
712 * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
715 test_connected (struct NeighbourMapEntry *n)
721 case S_NOT_CONNECTED:
723 case S_INIT_BLACKLIST:
725 case S_CONNECT_RECV_BLACKLIST_INBOUND:
726 case S_CONNECT_RECV_ATS:
727 case S_CONNECT_RECV_BLACKLIST:
728 case S_CONNECT_RECV_ACK:
731 case S_RECONNECT_ATS:
732 case S_RECONNECT_BLACKLIST:
733 case S_RECONNECT_SENT:
734 case S_CONNECTED_SWITCHING_BLACKLIST:
735 case S_CONNECTED_SWITCHING_CONNECT_SENT:
738 case S_DISCONNECT_FINISHED:
741 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
742 "Unhandled state `%s' \n",
743 print_state (n->state));
747 return GNUNET_SYSERR;
751 * Send information about a new outbound quota to our clients.
753 * @param target affected peer
754 * @param quota new quota
757 send_outbound_quota (const struct GNUNET_PeerIdentity *target,
758 struct GNUNET_BANDWIDTH_Value32NBO quota)
760 struct QuotaSetMessage q_msg;
762 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
763 "Sending outbound quota of %u Bps for peer `%s' to all clients\n",
764 ntohl (quota.value__), GNUNET_i2s (target));
765 q_msg.header.size = htons (sizeof (struct QuotaSetMessage));
766 q_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
768 q_msg.peer = (*target);
769 GST_clients_broadcast (&q_msg.header, GNUNET_NO);
774 * We don't need a given neighbour address any more.
775 * Release its resources and give appropriate notifications
776 * to ATS and other subsystems.
778 * @param na address we are done with; 'na' itself must NOT be 'free'd, only the contents!
781 free_address (struct NeighbourAddress *na)
783 if (GNUNET_YES == na->ats_active)
785 GST_validation_set_address_use (na->address, na->session, GNUNET_NO, __LINE__);
786 GNUNET_ATS_address_in_use (GST_ats, na->address, na->session, GNUNET_NO);
787 address_change_cb (NULL, &na->address->peer, NULL);
790 na->ats_active = GNUNET_NO;
791 if (NULL != na->address)
793 GNUNET_HELLO_address_free (na->address);
801 * Initialize the 'struct NeighbourAddress'.
803 * @param na neighbour address to initialize
804 * @param address address of the other peer, NULL if other peer
806 * @param session session to use (or NULL, in which case an
807 * address must be setup)
808 * @param bandwidth_in inbound quota to be used when connection is up
809 * @param bandwidth_out outbound quota to be used when connection is up
810 * @param is_active #GNUNET_YES to mark this as the active address with ATS
813 set_address (struct NeighbourAddress *na,
814 const struct GNUNET_HELLO_Address *address,
815 struct Session *session,
816 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
817 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
820 struct GNUNET_TRANSPORT_PluginFunctions *papi;
821 if (NULL == (papi = GST_plugins_find (address->transport_name)))
826 if (session == na->session)
828 na->bandwidth_in = bandwidth_in;
829 na->bandwidth_out = bandwidth_out;
830 if (is_active != na->ats_active)
832 na->ats_active = is_active;
833 GNUNET_ATS_address_in_use (GST_ats, na->address, na->session, is_active);
834 GST_validation_set_address_use (na->address, na->session, is_active, __LINE__);
836 address_change_cb (NULL, &address->peer, address);
838 if (GNUNET_YES == is_active)
840 /* FIXME: is this the right place to set quotas? */
841 GST_neighbours_set_incoming_quota (&address->peer, bandwidth_in);
842 send_outbound_quota (&address->peer, bandwidth_out);
848 session = papi->get_session (papi->cls, address);
851 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
852 "Failed to obtain new session for peer `%s' and address '%s'\n",
853 GNUNET_i2s (&address->peer), GST_plugins_a2s (address));
854 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
857 na->address = GNUNET_HELLO_address_copy (address);
858 na->bandwidth_in = bandwidth_in;
859 na->bandwidth_out = bandwidth_out;
860 na->session = session;
861 na->ats_active = is_active;
862 if (GNUNET_YES == is_active)
864 /* Telling ATS about new session */
865 GNUNET_ATS_address_in_use (GST_ats, na->address, na->session, GNUNET_YES);
866 GST_validation_set_address_use (na->address, na->session, GNUNET_YES, __LINE__);
867 address_change_cb (NULL, &address->peer, address);
868 /* FIXME: is this the right place to set quotas? */
869 GST_neighbours_set_incoming_quota (&address->peer, bandwidth_in);
870 send_outbound_quota (&address->peer, bandwidth_out);
876 * Free a neighbour map entry.
878 * @param n entry to free
879 * @param keep_sessions GNUNET_NO to tell plugin to terminate sessions,
880 * GNUNET_YES to keep all sessions
883 free_neighbour (struct NeighbourMapEntry *n, int keep_sessions)
885 struct MessageQueue *mq;
886 struct GNUNET_TRANSPORT_PluginFunctions *papi;
887 struct GNUNET_HELLO_Address *backup_primary;
889 n->is_active = NULL; /* always free'd by its own continuation! */
891 /* fail messages currently in the queue */
892 while (NULL != (mq = n->messages_head))
894 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
895 if (NULL != mq->cont)
896 mq->cont (mq->cont_cls, GNUNET_SYSERR, mq->message_buf_size, 0);
899 /* It is too late to send other peer disconnect notifications, but at
900 least internally we need to get clean... */
901 if (GNUNET_YES == test_connected (n))
903 GNUNET_STATISTICS_set (GST_stats,
904 gettext_noop ("# peers connected"),
905 --neighbours_connected,
907 disconnect_notify_cb (callback_cls, &n->id);
909 n->state = S_DISCONNECT_FINISHED;
911 if (NULL != n->primary_address.address)
913 backup_primary = GNUNET_HELLO_address_copy(n->primary_address.address);
916 backup_primary = NULL;
918 /* free addresses and mark as unused */
919 free_address (&n->primary_address);
920 free_address (&n->alternative_address);
922 /* FIXME-PLUGIN-API: This does not seem to guarantee that all
923 transport sessions eventually get killed due to inactivity; they
924 MUST have their own timeout logic (but at least TCP doesn't have
925 one yet). Are we sure that EVERY 'session' of a plugin is
926 actually cleaned up this way!? Note that if we are switching
927 between two TCP sessions to the same peer, the existing plugin
928 API gives us not even the means to selectively kill only one of
929 them! Killing all sessions like this seems to be very, very
932 /* cut transport-level connection */
933 if ((GNUNET_NO == keep_sessions) &&
934 (NULL != backup_primary) &&
935 (NULL != (papi = GST_plugins_find (backup_primary->transport_name))))
936 papi->disconnect (papi->cls, &n->id);
938 GNUNET_free_non_null (backup_primary);
940 GNUNET_assert (GNUNET_YES ==
941 GNUNET_CONTAINER_multipeermap_remove (neighbours,
944 // FIXME-ATS-API: we might want to be more specific about
945 // which states we do this from in the future (ATS should
946 // have given us a 'suggest_address' handle, and if we have
947 // such a handle, we should cancel the operation here!
948 if (NULL != n->suggest_handle)
950 GNUNET_ATS_suggest_address_cancel (GST_ats, &n->id);
951 n->suggest_handle = NULL;
954 if (GNUNET_SCHEDULER_NO_TASK != n->task)
956 GNUNET_SCHEDULER_cancel (n->task);
957 n->task = GNUNET_SCHEDULER_NO_TASK;
959 /* free rest of memory */
964 * Transmit a message using the current session of the given
967 * @param n entry for the recipient
968 * @param msgbuf buffer to transmit
969 * @param msgbuf_size number of bytes in buffer
970 * @param priority transmission priority
971 * @param timeout transmission timeout
972 * @param cont continuation to call when finished (can be NULL)
973 * @param cont_cls closure for cont
976 send_with_session (struct NeighbourMapEntry *n,
977 const char *msgbuf, size_t msgbuf_size,
979 struct GNUNET_TIME_Relative timeout,
980 GNUNET_TRANSPORT_TransmitContinuation cont,
983 struct GNUNET_TRANSPORT_PluginFunctions *papi;
985 GNUNET_assert (n->primary_address.session != NULL);
986 if ( ((NULL == (papi = GST_plugins_find (n->primary_address.address->transport_name)) ||
987 (-1 == papi->send (papi->cls,
988 n->primary_address.session,
992 cont, cont_cls)))) &&
994 cont (cont_cls, &n->id, GNUNET_SYSERR, msgbuf_size, 0);
995 GST_neighbours_notify_data_sent (&n->id,
996 n->primary_address.address, n->primary_address.session, msgbuf_size);
997 GNUNET_break (NULL != papi);
1002 * Master task run for every neighbour. Performs all of the time-related
1003 * activities (keep alive, send next message, disconnect if idle, finish
1004 * clean up after disconnect).
1006 * @param cls the 'struct NeighbourMapEntry' for which we are running
1007 * @param tc scheduler context (unused)
1010 master_task (void *cls,
1011 const struct GNUNET_SCHEDULER_TaskContext *tc);
1015 * Function called when the 'DISCONNECT' message has been sent by the
1016 * plugin. Frees the neighbour --- if the entry still exists.
1019 * @param target identity of the neighbour that was disconnected
1020 * @param result #GNUNET_OK if the disconnect got out successfully
1021 * @param payload bytes payload
1022 * @param physical bytes physical
1025 send_disconnect_cont (void *cls, const struct GNUNET_PeerIdentity *target,
1026 int result, size_t payload, size_t physical)
1028 struct NeighbourMapEntry *n;
1030 n = lookup_neighbour (target);
1032 return; /* already gone */
1033 if (S_DISCONNECT != n->state)
1034 return; /* have created a fresh entry since */
1035 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1036 GNUNET_SCHEDULER_cancel (n->task);
1037 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1042 * Transmit a DISCONNECT message to the other peer.
1044 * @param n neighbour to send DISCONNECT message.
1047 send_disconnect (struct NeighbourMapEntry *n)
1049 struct SessionDisconnectMessage disconnect_msg;
1051 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1052 "Sending DISCONNECT message to peer `%4s'\n",
1053 GNUNET_i2s (&n->id));
1054 disconnect_msg.header.size = htons (sizeof (struct SessionDisconnectMessage));
1055 disconnect_msg.header.type =
1056 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
1057 disconnect_msg.reserved = htonl (0);
1058 disconnect_msg.purpose.size =
1059 htonl (sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
1060 sizeof (struct GNUNET_CRYPTO_EddsaPublicKey) +
1061 sizeof (struct GNUNET_TIME_AbsoluteNBO));
1062 disconnect_msg.purpose.purpose =
1063 htonl (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
1064 disconnect_msg.timestamp =
1065 GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get ());
1066 disconnect_msg.public_key = GST_my_identity.public_key;
1067 GNUNET_assert (GNUNET_OK ==
1068 GNUNET_CRYPTO_eddsa_sign (GST_my_private_key,
1069 &disconnect_msg.purpose,
1070 &disconnect_msg.signature));
1072 send_with_session (n,
1073 (const char *) &disconnect_msg, sizeof (disconnect_msg),
1074 UINT32_MAX, GNUNET_TIME_UNIT_FOREVER_REL,
1075 &send_disconnect_cont, NULL);
1076 GNUNET_STATISTICS_update (GST_stats,
1078 ("# DISCONNECT messages sent"), 1,
1084 * Disconnect from the given neighbour, clean up the record.
1086 * @param n neighbour to disconnect from
1089 disconnect_neighbour (struct NeighbourMapEntry *n)
1091 /* depending on state, notify neighbour and/or upper layers of this peer
1095 case S_NOT_CONNECTED:
1097 case S_INIT_BLACKLIST:
1098 /* other peer is completely unaware of us, no need to send DISCONNECT */
1099 n->state = S_DISCONNECT_FINISHED;
1100 free_neighbour (n, GNUNET_NO);
1102 case S_CONNECT_SENT:
1103 send_disconnect (n);
1104 n->state = S_DISCONNECT;
1106 case S_CONNECT_RECV_BLACKLIST_INBOUND:
1107 case S_CONNECT_RECV_ATS:
1108 case S_CONNECT_RECV_BLACKLIST:
1109 /* we never ACK'ed the other peer's request, no need to send DISCONNECT */
1110 n->state = S_DISCONNECT_FINISHED;
1111 free_neighbour (n, GNUNET_NO);
1113 case S_CONNECT_RECV_ACK:
1114 /* we DID ACK the other peer's request, must send DISCONNECT */
1115 send_disconnect (n);
1116 n->state = S_DISCONNECT;
1119 case S_RECONNECT_BLACKLIST:
1120 case S_RECONNECT_SENT:
1121 case S_CONNECTED_SWITCHING_BLACKLIST:
1122 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1123 /* we are currently connected, need to send disconnect and do
1124 internal notifications and update statistics */
1125 send_disconnect (n);
1126 GNUNET_STATISTICS_set (GST_stats,
1127 gettext_noop ("# peers connected"),
1128 --neighbours_connected,
1130 disconnect_notify_cb (callback_cls, &n->id);
1131 n->state = S_DISCONNECT;
1133 case S_RECONNECT_ATS:
1134 /* ATS address request timeout, disconnect without sending disconnect message */
1135 GNUNET_STATISTICS_set (GST_stats,
1136 gettext_noop ("# peers connected"),
1137 --neighbours_connected,
1139 disconnect_notify_cb (callback_cls, &n->id);
1140 n->state = S_DISCONNECT;
1143 /* already disconnected, ignore */
1145 case S_DISCONNECT_FINISHED:
1146 /* already cleaned up, how did we get here!? */
1150 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1151 "Unhandled state `%s'\n",
1152 print_state (n->state));
1156 /* schedule timeout to clean up */
1157 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1158 GNUNET_SCHEDULER_cancel (n->task);
1159 n->task = GNUNET_SCHEDULER_add_delayed (DISCONNECT_SENT_TIMEOUT,
1165 * We're done with our transmission attempt, continue processing.
1167 * @param cls the 'struct MessageQueue' of the message
1168 * @param receiver intended receiver
1169 * @param success whether it worked or not
1170 * @param size_payload bytes payload sent
1171 * @param physical bytes sent on wire
1174 transmit_send_continuation (void *cls,
1175 const struct GNUNET_PeerIdentity *receiver,
1176 int success, size_t size_payload, size_t physical)
1178 struct MessageQueue *mq = cls;
1179 struct NeighbourMapEntry *n;
1181 if (NULL == (n = lookup_neighbour (receiver)))
1184 return; /* disconnect or other error while transmitting, can happen */
1186 if (n->is_active == mq)
1188 /* this is still "our" neighbour, remove us from its queue
1189 and allow it to send the next message now */
1190 n->is_active = NULL;
1191 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1192 GNUNET_SCHEDULER_cancel (n->task);
1193 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1195 if (bytes_in_send_queue < mq->message_buf_size)
1197 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1198 "Bytes_in_send_queue `%u', Message_size %u, result: %s, payload %u, on wire %u\n",
1199 bytes_in_send_queue, mq->message_buf_size,
1200 (GNUNET_OK == success) ? "OK" : "FAIL",
1201 size_payload, physical);
1206 GNUNET_break (size_payload == mq->message_buf_size);
1207 bytes_in_send_queue -= mq->message_buf_size;
1208 GNUNET_STATISTICS_set (GST_stats,
1210 ("# bytes in message queue for other peers"),
1211 bytes_in_send_queue, GNUNET_NO);
1212 if (GNUNET_OK == success)
1213 GNUNET_STATISTICS_update (GST_stats,
1215 ("# messages transmitted to other peers"),
1218 GNUNET_STATISTICS_update (GST_stats,
1220 ("# transmission failures for messages to other peers"),
1222 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1223 "Sending message to `%s' of type %u was a %s\n",
1224 GNUNET_i2s (receiver),
1225 ntohs (((struct GNUNET_MessageHeader *) mq->message_buf)->type),
1226 (success == GNUNET_OK) ? "success" : "FAILURE");
1227 if (NULL != mq->cont)
1228 mq->cont (mq->cont_cls, success, size_payload, physical);
1234 * Check the message list for the given neighbour and if we can
1235 * send a message, do so. This function should only be called
1236 * if the connection is at least generally ready for transmission.
1237 * While we will only send one message at a time, no bandwidth
1238 * quota management is performed here. If a message was given to
1239 * the plugin, the continuation will automatically re-schedule
1240 * the 'master' task once the next message might be transmitted.
1242 * @param n target peer for which to transmit
1245 try_transmission_to_peer (struct NeighbourMapEntry *n)
1247 struct MessageQueue *mq;
1248 struct GNUNET_TIME_Relative timeout;
1250 if (NULL == n->primary_address.address)
1252 /* no address, why are we here? */
1256 if ((0 == n->primary_address.address->address_length) &&
1257 (NULL == n->primary_address.session))
1259 /* no address, why are we here? */
1263 if (NULL != n->is_active)
1265 /* transmission already pending */
1269 /* timeout messages from the queue that are past their due date */
1270 while (NULL != (mq = n->messages_head))
1272 timeout = GNUNET_TIME_absolute_get_remaining (mq->timeout);
1273 if (timeout.rel_value_us > 0)
1275 GNUNET_STATISTICS_update (GST_stats,
1277 ("# messages timed out while in transport queue"),
1279 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
1281 transmit_send_continuation (mq, &n->id, GNUNET_SYSERR, mq->message_buf_size, 0); /* timeout */
1284 return; /* no more messages */
1285 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
1287 send_with_session (n,
1288 mq->message_buf, mq->message_buf_size,
1289 0 /* priority */, timeout,
1290 &transmit_send_continuation, mq);
1295 * Send keepalive message to the neighbour. Must only be called
1296 * if we are on 'connected' state or while trying to switch addresses.
1297 * Will internally determine if a keepalive is truly needed (so can
1298 * always be called).
1300 * @param n neighbour that went idle and needs a keepalive
1303 send_keepalive (struct NeighbourMapEntry *n)
1305 struct GNUNET_MessageHeader m;
1307 GNUNET_assert ((S_CONNECTED == n->state) ||
1308 (S_CONNECTED_SWITCHING_BLACKLIST == n->state) ||
1309 (S_CONNECTED_SWITCHING_CONNECT_SENT));
1310 if (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time).rel_value_us > 0)
1311 return; /* no keepalive needed at this time */
1312 m.size = htons (sizeof (struct GNUNET_MessageHeader));
1313 m.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE);
1314 send_with_session (n,
1315 (const void *) &m, sizeof (m),
1316 UINT32_MAX /* priority */,
1317 KEEPALIVE_FREQUENCY,
1319 GNUNET_STATISTICS_update (GST_stats, gettext_noop ("# keepalives sent"), 1,
1321 n->expect_latency_response = GNUNET_YES;
1322 n->last_keep_alive_time = GNUNET_TIME_absolute_get ();
1323 n->keep_alive_time = GNUNET_TIME_relative_to_absolute (KEEPALIVE_FREQUENCY);
1328 * Keep the connection to the given neighbour alive longer,
1329 * we received a KEEPALIVE (or equivalent); send a response.
1331 * @param neighbour neighbour to keep alive (by sending keep alive response)
1334 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour)
1336 struct NeighbourMapEntry *n;
1337 struct GNUNET_MessageHeader m;
1339 if (NULL == (n = lookup_neighbour (neighbour)))
1341 GNUNET_STATISTICS_update (GST_stats,
1343 ("# KEEPALIVE messages discarded (peer unknown)"),
1347 if (NULL == n->primary_address.session)
1349 GNUNET_STATISTICS_update (GST_stats,
1351 ("# KEEPALIVE messages discarded (no session)"),
1355 /* send reply to allow neighbour to measure latency */
1356 m.size = htons (sizeof (struct GNUNET_MessageHeader));
1357 m.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE);
1358 send_with_session(n,
1359 (const void *) &m, sizeof (m),
1360 UINT32_MAX /* priority */,
1361 KEEPALIVE_FREQUENCY,
1367 * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
1368 * latency to this peer. Pass the updated information (existing ats
1369 * plus calculated latency) to ATS.
1371 * @param neighbour neighbour to keep alive
1374 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour)
1376 struct NeighbourMapEntry *n;
1378 struct GNUNET_ATS_Information ats;
1380 if (NULL == (n = lookup_neighbour (neighbour)))
1382 GNUNET_STATISTICS_update (GST_stats,
1384 ("# KEEPALIVE_RESPONSE messages discarded (not connected)"),
1388 if ( (S_CONNECTED != n->state) ||
1389 (GNUNET_YES != n->expect_latency_response) )
1391 GNUNET_STATISTICS_update (GST_stats,
1393 ("# KEEPALIVE_RESPONSE messages discarded (not expected)"),
1397 n->expect_latency_response = GNUNET_NO;
1398 n->latency = GNUNET_TIME_absolute_get_duration (n->last_keep_alive_time);
1399 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1400 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1401 "Latency for peer `%s' is %s\n",
1402 GNUNET_i2s (&n->id),
1403 GNUNET_STRINGS_relative_time_to_string (n->latency,
1405 /* append latency */
1406 ats.type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
1407 if (n->latency.rel_value_us > UINT32_MAX)
1408 latency = UINT32_MAX;
1410 latency = n->latency.rel_value_us;
1411 ats.value = htonl (latency);
1412 GST_ats_update_metrics (&n->id,
1413 n->primary_address.address,
1414 n->primary_address.session,
1420 * We have received a message from the given sender. How long should
1421 * we delay before receiving more? (Also used to keep the peer marked
1424 * @param sender sender of the message
1425 * @param size size of the message
1426 * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
1427 * GNUNET_NO if the neighbour is not connected or violates the quota,
1428 * GNUNET_SYSERR if the connection is not fully up yet
1429 * @return how long to wait before reading more from this sender
1431 struct GNUNET_TIME_Relative
1432 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
1433 *sender, ssize_t size, int *do_forward)
1435 struct NeighbourMapEntry *n;
1436 struct GNUNET_TIME_Relative ret;
1438 if (NULL == neighbours)
1440 *do_forward = GNUNET_NO;
1441 return GNUNET_TIME_UNIT_FOREVER_REL; /* This can happen during shutdown */
1443 if (NULL == (n = lookup_neighbour (sender)))
1445 GST_neighbours_try_connect (sender);
1446 if (NULL == (n = lookup_neighbour (sender)))
1448 GNUNET_STATISTICS_update (GST_stats,
1450 ("# messages discarded due to lack of neighbour record"),
1452 *do_forward = GNUNET_NO;
1453 return GNUNET_TIME_UNIT_ZERO;
1456 if (! test_connected (n))
1458 *do_forward = GNUNET_SYSERR;
1459 return GNUNET_TIME_UNIT_ZERO;
1461 if (GNUNET_YES == GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, size))
1463 n->quota_violation_count++;
1464 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1465 "Bandwidth quota (%u b/s) violation detected (total of %u).\n",
1466 n->in_tracker.available_bytes_per_s__,
1467 n->quota_violation_count);
1468 /* Discount 32k per violation */
1469 GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, -32 * 1024);
1473 if (n->quota_violation_count > 0)
1475 /* try to add 32k back */
1476 GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, 32 * 1024);
1477 n->quota_violation_count--;
1480 if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
1482 GNUNET_STATISTICS_update (GST_stats,
1484 ("# bandwidth quota violations by other peers"),
1486 *do_forward = GNUNET_NO;
1487 return GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT;
1489 *do_forward = GNUNET_YES;
1490 ret = GNUNET_BANDWIDTH_tracker_get_delay (&n->in_tracker, 32 * 1024);
1491 if (ret.rel_value_us > 0)
1493 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1494 "Throttling read (%llu bytes excess at %u b/s), waiting %s before reading more.\n",
1495 (unsigned long long) n->in_tracker.
1496 consumption_since_last_update__,
1497 (unsigned int) n->in_tracker.available_bytes_per_s__,
1498 GNUNET_STRINGS_relative_time_to_string (ret, GNUNET_YES));
1499 GNUNET_STATISTICS_update (GST_stats,
1500 gettext_noop ("# ms throttling suggested"),
1501 (int64_t) ret.rel_value_us / 1000LL,
1509 * Transmit a message to the given target using the active connection.
1511 * @param target destination
1512 * @param msg message to send
1513 * @param msg_size number of bytes in msg
1514 * @param timeout when to fail with timeout
1515 * @param cont function to call when done
1516 * @param cont_cls closure for 'cont'
1519 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
1520 size_t msg_size, struct GNUNET_TIME_Relative timeout,
1521 GST_NeighbourSendContinuation cont, void *cont_cls)
1523 struct NeighbourMapEntry *n;
1524 struct MessageQueue *mq;
1526 /* All ove these cases should never happen; they are all API violations.
1527 But we check anyway, just to be sure. */
1528 if (NULL == (n = lookup_neighbour (target)))
1532 cont (cont_cls, GNUNET_SYSERR, msg_size, 0);
1535 if (GNUNET_YES != test_connected (n))
1539 cont (cont_cls, GNUNET_SYSERR, msg_size, 0);
1542 bytes_in_send_queue += msg_size;
1543 GNUNET_STATISTICS_set (GST_stats,
1545 ("# bytes in message queue for other peers"),
1546 bytes_in_send_queue, GNUNET_NO);
1547 mq = GNUNET_malloc (sizeof (struct MessageQueue) + msg_size);
1549 mq->cont_cls = cont_cls;
1550 memcpy (&mq[1], msg, msg_size);
1551 mq->message_buf = (const char *) &mq[1];
1552 mq->message_buf_size = msg_size;
1553 mq->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1554 GNUNET_CONTAINER_DLL_insert_tail (n->messages_head, n->messages_tail, mq);
1555 if ( (NULL != n->is_active) ||
1556 ( (NULL == n->primary_address.session) && (NULL == n->primary_address.address)) )
1558 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1559 GNUNET_SCHEDULER_cancel (n->task);
1560 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1565 * Send a SESSION_CONNECT message via the given address.
1567 * @param na address to use
1570 send_session_connect (struct NeighbourAddress *na)
1572 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1573 struct SessionConnectMessage connect_msg;
1575 if (NULL == (papi = GST_plugins_find (na->address->transport_name)))
1580 if (NULL == na->session)
1581 na->session = papi->get_session (papi->cls, na->address);
1582 if (NULL == na->session)
1587 na->connect_timestamp = GNUNET_TIME_absolute_get ();
1588 connect_msg.header.size = htons (sizeof (struct SessionConnectMessage));
1589 connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT);
1590 connect_msg.reserved = htonl (0);
1591 connect_msg.timestamp = GNUNET_TIME_absolute_hton (na->connect_timestamp);
1592 (void) papi->send (papi->cls,
1594 (const char *) &connect_msg, sizeof (struct SessionConnectMessage),
1596 GNUNET_TIME_UNIT_FOREVER_REL,
1598 GST_neighbours_notify_data_sent (&na->address->peer,
1599 na->address, na->session, sizeof (struct SessionConnectMessage));
1605 * Send a SESSION_CONNECT_ACK message via the given address.
1607 * @param address address to use
1608 * @param session session to use
1609 * @param timestamp timestamp to use for the ACK message
1612 send_session_connect_ack_message (const struct GNUNET_HELLO_Address *address,
1613 struct Session *session,
1614 struct GNUNET_TIME_Absolute timestamp)
1616 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1617 struct SessionConnectMessage connect_msg;
1619 if (NULL == (papi = GST_plugins_find (address->transport_name)))
1624 if (NULL == session)
1625 session = papi->get_session (papi->cls, address);
1626 if (NULL == session)
1631 connect_msg.header.size = htons (sizeof (struct SessionConnectMessage));
1632 connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK);
1633 connect_msg.reserved = htonl (0);
1634 connect_msg.timestamp = GNUNET_TIME_absolute_hton (timestamp);
1635 (void) papi->send (papi->cls,
1637 (const char *) &connect_msg, sizeof (struct SessionConnectMessage),
1639 GNUNET_TIME_UNIT_FOREVER_REL,
1646 * Create a fresh entry in the neighbour map for the given peer
1648 * @param peer peer to create an entry for
1649 * @return new neighbour map entry
1651 static struct NeighbourMapEntry *
1652 setup_neighbour (const struct GNUNET_PeerIdentity *peer)
1654 struct NeighbourMapEntry *n;
1656 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1657 "Creating new neighbour entry for `%s'\n",
1659 n = GNUNET_new (struct NeighbourMapEntry);
1661 n->state = S_NOT_CONNECTED;
1662 n->latency = GNUNET_TIME_UNIT_FOREVER_REL;
1663 n->last_util_transmission = GNUNET_TIME_absolute_get();
1664 n->util_payload_bytes_recv = 0;
1665 n->util_payload_bytes_sent = 0;
1666 n->util_total_bytes_recv = 0;
1667 n->util_total_bytes_sent = 0;
1668 GNUNET_BANDWIDTH_tracker_init (&n->in_tracker,
1669 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
1670 MAX_BANDWIDTH_CARRY_S);
1671 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1672 GNUNET_assert (GNUNET_OK ==
1673 GNUNET_CONTAINER_multipeermap_put (neighbours,
1675 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1681 * Check if the two given addresses are the same.
1682 * Actually only checks if the sessions are non-NULL
1683 * (which they should be) and then if they are identical;
1684 * the actual addresses don't matter if the session
1685 * pointers match anyway, and we must have session pointers
1688 * @param a1 first address to compare
1689 * @param a2 other address to compare
1690 * @return GNUNET_NO if the addresses do not match, GNUNET_YES if they do match
1693 address_matches (const struct NeighbourAddress *a1,
1694 const struct NeighbourAddress *a2)
1696 if ( (NULL == a1->session) ||
1697 (NULL == a2->session) )
1702 return (a1->session == a2->session) ? GNUNET_YES : GNUNET_NO;
1707 * Try to create a connection to the given target (eventually).
1709 * @param target peer to try to connect to
1712 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target)
1714 struct NeighbourMapEntry *n;
1716 if (NULL == neighbours)
1718 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1719 "Asked to connect to peer `%s' during shutdown\n",
1720 GNUNET_i2s (target));
1721 return; /* during shutdown, do nothing */
1723 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1724 "Asked to connect to peer `%s'\n",
1725 GNUNET_i2s (target));
1726 if (0 == memcmp (target, &GST_my_identity, sizeof (struct GNUNET_PeerIdentity)))
1728 /* refuse to connect to myself */
1729 /* FIXME: can this happen? Is this not an API violation? */
1730 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1731 "Refusing to try to connect to myself.\n");
1734 n = lookup_neighbour (target);
1739 case S_NOT_CONNECTED:
1740 /* this should not be possible */
1742 free_neighbour (n, GNUNET_NO);
1745 case S_INIT_BLACKLIST:
1746 case S_CONNECT_SENT:
1747 case S_CONNECT_RECV_BLACKLIST_INBOUND:
1748 case S_CONNECT_RECV_ATS:
1749 case S_CONNECT_RECV_BLACKLIST:
1750 case S_CONNECT_RECV_ACK:
1751 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1752 "Ignoring request to try to connect to `%s', already trying!\n",
1753 GNUNET_i2s (target));
1754 return; /* already trying */
1756 case S_RECONNECT_ATS:
1757 case S_RECONNECT_BLACKLIST:
1758 case S_RECONNECT_SENT:
1759 case S_CONNECTED_SWITCHING_BLACKLIST:
1760 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1761 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1762 "Ignoring request to try to connect, already connected to `%s'!\n",
1763 GNUNET_i2s (target));
1764 return; /* already connected */
1766 /* get rid of remains, ready to re-try immediately */
1767 free_neighbour (n, GNUNET_NO);
1769 case S_DISCONNECT_FINISHED:
1770 /* should not be possible */
1773 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1774 "Unhandled state `%s'\n",
1775 print_state (n->state));
1777 free_neighbour (n, GNUNET_NO);
1781 n = setup_neighbour (target);
1782 n->state = S_INIT_ATS;
1783 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1785 GNUNET_ATS_reset_backoff (GST_ats, target);
1786 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, target);
1791 * Function called with the result of a blacklist check.
1793 * @param cls closure with the 'struct BlackListCheckContext'
1794 * @param peer peer this check affects
1795 * @param result GNUNET_OK if the address is allowed
1798 handle_test_blacklist_cont (void *cls,
1799 const struct GNUNET_PeerIdentity *peer,
1802 struct BlackListCheckContext *bcc = cls;
1803 struct NeighbourMapEntry *n;
1806 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1807 "Connection to new address of peer `%s' based on blacklist is `%s'\n",
1809 (GNUNET_OK == result) ? "allowed" : "FORBIDDEN");
1810 if (NULL == (n = lookup_neighbour (peer)))
1811 goto cleanup; /* nobody left to care about new address */
1814 case S_NOT_CONNECTED:
1815 /* this should not be possible */
1817 free_neighbour (n, GNUNET_NO);
1820 /* still waiting on ATS suggestion */
1822 case S_INIT_BLACKLIST:
1823 /* check if the address the blacklist was fine with matches
1824 ATS suggestion, if so, we can move on! */
1825 if ( (GNUNET_OK == result) &&
1826 (1 == n->send_connect_ack) )
1828 n->send_connect_ack = 2;
1829 send_session_connect_ack_message (bcc->na.address,
1831 n->connect_ack_timestamp);
1833 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1834 break; /* result for an address we currently don't care about */
1835 if (GNUNET_OK == result)
1837 n->timeout = GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT);
1838 n->state = S_CONNECT_SENT;
1839 send_session_connect (&n->primary_address);
1843 // FIXME: should also possibly destroy session with plugin!?
1844 GNUNET_ATS_address_destroyed (GST_ats,
1847 free_address (&n->primary_address);
1848 n->state = S_INIT_ATS;
1849 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1850 // FIXME: do we need to ask ATS again for suggestions?
1851 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
1854 case S_CONNECT_SENT:
1855 /* waiting on CONNECT_ACK, send ACK if one is pending */
1856 if ( (GNUNET_OK == result) &&
1857 (1 == n->send_connect_ack) )
1859 n->send_connect_ack = 2;
1860 send_session_connect_ack_message (n->primary_address.address,
1861 n->primary_address.session,
1862 n->connect_ack_timestamp);
1865 case S_CONNECT_RECV_BLACKLIST_INBOUND:
1866 if (GNUNET_OK == result)
1867 GST_ats_add_address (bcc->na.address, bcc->na.session);
1869 n->state = S_CONNECT_RECV_ATS;
1870 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1871 GNUNET_ATS_reset_backoff (GST_ats, peer);
1872 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, peer);
1874 case S_CONNECT_RECV_ATS:
1875 /* still waiting on ATS suggestion, don't care about blacklist */
1877 case S_CONNECT_RECV_BLACKLIST:
1878 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1879 break; /* result for an address we currently don't care about */
1880 if (GNUNET_OK == result)
1882 n->timeout = GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT);
1883 n->state = S_CONNECT_RECV_ACK;
1884 send_session_connect_ack_message (bcc->na.address,
1886 n->connect_ack_timestamp);
1887 if (1 == n->send_connect_ack)
1888 n->send_connect_ack = 2;
1892 // FIXME: should also possibly destroy session with plugin!?
1893 GNUNET_ATS_address_destroyed (GST_ats,
1896 free_address (&n->primary_address);
1897 n->state = S_INIT_ATS;
1898 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1899 // FIXME: do we need to ask ATS again for suggestions?
1900 GNUNET_ATS_reset_backoff (GST_ats, peer);
1901 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
1904 case S_CONNECT_RECV_ACK:
1905 /* waiting on SESSION_ACK, send ACK if one is pending */
1906 if ( (GNUNET_OK == result) &&
1907 (1 == n->send_connect_ack) )
1909 n->send_connect_ack = 2;
1910 send_session_connect_ack_message (n->primary_address.address,
1911 n->primary_address.session,
1912 n->connect_ack_timestamp);
1916 /* already connected, don't care about blacklist */
1918 case S_RECONNECT_ATS:
1919 /* still waiting on ATS suggestion, don't care about blacklist */
1921 case S_RECONNECT_BLACKLIST:
1922 if ( (GNUNET_OK == result) &&
1923 (1 == n->send_connect_ack) )
1925 n->send_connect_ack = 2;
1926 send_session_connect_ack_message (bcc->na.address,
1928 n->connect_ack_timestamp);
1930 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1931 break; /* result for an address we currently don't care about */
1932 if (GNUNET_OK == result)
1934 send_session_connect (&n->primary_address);
1935 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
1936 n->state = S_RECONNECT_SENT;
1940 GNUNET_ATS_address_destroyed (GST_ats,
1943 n->state = S_RECONNECT_ATS;
1944 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1945 // FIXME: do we need to ask ATS again for suggestions?
1946 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
1949 case S_RECONNECT_SENT:
1950 /* waiting on CONNECT_ACK, don't care about blacklist */
1951 if ( (GNUNET_OK == result) &&
1952 (1 == n->send_connect_ack) )
1954 n->send_connect_ack = 2;
1955 send_session_connect_ack_message (n->primary_address.address,
1956 n->primary_address.session,
1957 n->connect_ack_timestamp);
1960 case S_CONNECTED_SWITCHING_BLACKLIST:
1961 if (GNUNET_YES != address_matches (&bcc->na, &n->alternative_address))
1962 break; /* result for an address we currently don't care about */
1963 if (GNUNET_OK == result)
1965 send_session_connect (&n->alternative_address);
1966 n->state = S_CONNECTED_SWITCHING_CONNECT_SENT;
1970 GNUNET_ATS_address_destroyed (GST_ats,
1973 free_address (&n->alternative_address);
1974 n->state = S_CONNECTED;
1977 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1978 /* waiting on CONNECT_ACK, don't care about blacklist */
1979 if ( (GNUNET_OK == result) &&
1980 (1 == n->send_connect_ack) )
1982 n->send_connect_ack = 2;
1983 send_session_connect_ack_message (n->primary_address.address,
1984 n->primary_address.session,
1985 n->connect_ack_timestamp);
1989 /* Nothing to do here, ATS will already do what can be done */
1991 case S_DISCONNECT_FINISHED:
1992 /* should not be possible */
1996 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1997 "Unhandled state `%s'\n",
1998 print_state (n->state));
2000 free_neighbour (n, GNUNET_NO);
2004 GNUNET_HELLO_address_free (bcc->na.address);
2005 GNUNET_CONTAINER_DLL_remove (bc_head,
2013 * We want to know if connecting to a particular peer via
2014 * a particular address is allowed. Check it!
2016 * @param peer identity of the peer to switch the address for
2017 * @param ts time at which the check was initiated
2018 * @param address address of the other peer, NULL if other peer
2020 * @param session session to use (or NULL)
2023 check_blacklist (const struct GNUNET_PeerIdentity *peer,
2024 struct GNUNET_TIME_Absolute ts,
2025 const struct GNUNET_HELLO_Address *address,
2026 struct Session *session)
2028 struct BlackListCheckContext *bcc;
2029 struct GST_BlacklistCheck *bc;
2031 bcc = GNUNET_malloc (sizeof (struct BlackListCheckContext));
2032 bcc->na.address = GNUNET_HELLO_address_copy (address);
2033 bcc->na.session = session;
2034 bcc->na.connect_timestamp = ts;
2035 GNUNET_CONTAINER_DLL_insert (bc_head,
2038 if (NULL != (bc = GST_blacklist_test_allowed (peer,
2039 address->transport_name,
2040 &handle_test_blacklist_cont, bcc)))
2042 /* if NULL == bc, 'cont' was already called and 'bcc' already free'd, so
2043 we must only store 'bc' if 'bc' is non-NULL... */
2048 * We received a 'SESSION_CONNECT' message from the other peer.
2049 * Consider switching to it.
2051 * @param message possibly a 'struct SessionConnectMessage' (check format)
2052 * @param peer identity of the peer to switch the address for
2053 * @param address address of the other peer, NULL if other peer
2055 * @param session session to use (or NULL)
2058 GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
2059 const struct GNUNET_PeerIdentity *peer,
2060 const struct GNUNET_HELLO_Address *address,
2061 struct Session *session)
2063 const struct SessionConnectMessage *scm;
2064 struct NeighbourMapEntry *n;
2065 struct GNUNET_TIME_Absolute ts;
2067 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2068 "Received CONNECT message from peer `%s'\n",
2071 if (ntohs (message->size) != sizeof (struct SessionConnectMessage))
2073 GNUNET_break_op (0);
2076 if (NULL == neighbours)
2077 return; /* we're shutting down */
2078 scm = (const struct SessionConnectMessage *) message;
2079 GNUNET_break_op (0 == ntohl (scm->reserved));
2080 ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
2081 n = lookup_neighbour (peer);
2083 n = setup_neighbour (peer);
2084 n->send_connect_ack = 1;
2085 n->connect_ack_timestamp = ts;
2089 case S_NOT_CONNECTED:
2090 n->state = S_CONNECT_RECV_BLACKLIST_INBOUND;
2091 /* Do a blacklist check for the new address */
2092 check_blacklist (peer, ts, address, session);
2095 /* CONNECT message takes priority over us asking ATS for address */
2096 n->state = S_CONNECT_RECV_BLACKLIST_INBOUND;
2098 case S_INIT_BLACKLIST:
2099 case S_CONNECT_SENT:
2100 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2101 case S_CONNECT_RECV_ATS:
2102 case S_CONNECT_RECV_BLACKLIST:
2103 case S_CONNECT_RECV_ACK:
2104 /* It can never hurt to have an alternative address in the above cases,
2105 see if it is allowed */
2106 check_blacklist (peer, ts, address, session);
2109 /* we are already connected and can thus send the ACK immediately;
2110 still, it can never hurt to have an alternative address, so also
2111 tell ATS about it */
2112 GNUNET_assert (NULL != n->primary_address.address);
2113 GNUNET_assert (NULL != n->primary_address.session);
2114 n->send_connect_ack = 0;
2115 send_session_connect_ack_message (n->primary_address.address,
2116 n->primary_address.session, ts);
2117 check_blacklist (peer, ts, address, session);
2119 case S_RECONNECT_ATS:
2120 case S_RECONNECT_BLACKLIST:
2121 case S_RECONNECT_SENT:
2122 /* It can never hurt to have an alternative address in the above cases,
2123 see if it is allowed */
2124 check_blacklist (peer, ts, address, session);
2126 case S_CONNECTED_SWITCHING_BLACKLIST:
2127 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2128 /* we are already connected and can thus send the ACK immediately;
2129 still, it can never hurt to have an alternative address, so also
2130 tell ATS about it */
2131 GNUNET_assert (NULL != n->primary_address.address);
2132 GNUNET_assert (NULL != n->primary_address.session);
2133 n->send_connect_ack = 0;
2134 send_session_connect_ack_message (n->primary_address.address,
2135 n->primary_address.session, ts);
2136 check_blacklist (peer, ts, address, session);
2139 /* get rid of remains without terminating sessions, ready to re-try */
2140 free_neighbour (n, GNUNET_YES);
2141 n = setup_neighbour (peer);
2142 n->state = S_CONNECT_RECV_ATS;
2143 GNUNET_ATS_reset_backoff (GST_ats, peer);
2144 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, peer);
2146 case S_DISCONNECT_FINISHED:
2147 /* should not be possible */
2151 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2152 "Unhandled state `%s'\n",
2153 print_state (n->state));
2155 free_neighbour (n, GNUNET_NO);
2162 * For an existing neighbour record, set the active connection to
2163 * use the given address.
2165 * @param peer identity of the peer to switch the address for
2166 * @param address address of the other peer, NULL if other peer
2168 * @param session session to use (or NULL)
2169 * @param ats performance data
2170 * @param ats_count number of entries in ats
2171 * @param bandwidth_in inbound quota to be used when connection is up,
2172 * 0 to disconnect from peer
2173 * @param bandwidth_out outbound quota to be used when connection is up,
2174 * 0 to disconnect from peer
2177 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
2178 const struct GNUNET_HELLO_Address *address,
2179 struct Session *session,
2180 const struct GNUNET_ATS_Information *ats,
2182 struct GNUNET_BANDWIDTH_Value32NBO
2184 struct GNUNET_BANDWIDTH_Value32NBO
2187 struct NeighbourMapEntry *n;
2188 struct GNUNET_TRANSPORT_PluginFunctions *papi;
2190 GNUNET_assert (address->transport_name != NULL);
2191 if (NULL == (n = lookup_neighbour (peer)))
2194 /* Obtain an session for this address from plugin */
2195 if (NULL == (papi = GST_plugins_find (address->transport_name)))
2197 /* we don't have the plugin for this address */
2198 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2201 if ((NULL == session) && (0 == address->address_length))
2204 if (strlen (address->transport_name) > 0)
2205 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2209 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2210 "ATS tells us to switch to address '%s' session %p for "
2211 "peer `%s' in state %s (quota in/out %u %u )\n",
2212 (address->address_length != 0) ? GST_plugins_a2s (address): "<inbound>",
2215 print_state (n->state),
2216 ntohl (bandwidth_in.value__),
2217 ntohl (bandwidth_out.value__));
2219 if (NULL == session)
2221 session = papi->get_session (papi->cls, address);
2222 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2223 "Obtained new session for peer `%s' and address '%s': %p\n",
2224 GNUNET_i2s (&address->peer), GST_plugins_a2s (address), session);
2226 if (NULL == session)
2228 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2229 "Failed to obtain new session for peer `%s' and address '%s'\n",
2230 GNUNET_i2s (&address->peer), GST_plugins_a2s (address));
2231 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2236 case S_NOT_CONNECTED:
2238 free_neighbour (n, GNUNET_NO);
2241 set_address (&n->primary_address,
2242 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2243 n->state = S_INIT_BLACKLIST;
2244 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2245 check_blacklist (&n->id,
2246 n->connect_ack_timestamp,
2249 case S_INIT_BLACKLIST:
2250 /* ATS suggests a different address, switch again */
2251 set_address (&n->primary_address,
2252 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2253 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2254 check_blacklist (&n->id,
2255 n->connect_ack_timestamp,
2258 case S_CONNECT_SENT:
2259 /* ATS suggests a different address, switch again */
2260 set_address (&n->primary_address,
2261 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2262 n->state = S_INIT_BLACKLIST;
2263 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2264 check_blacklist (&n->id,
2265 n->connect_ack_timestamp,
2268 case S_CONNECT_RECV_ATS:
2269 set_address (&n->primary_address,
2270 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2271 n->state = S_CONNECT_RECV_BLACKLIST;
2272 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2273 check_blacklist (&n->id,
2274 n->connect_ack_timestamp,
2277 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2278 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2279 check_blacklist (&n->id,
2280 n->connect_ack_timestamp,
2283 case S_CONNECT_RECV_BLACKLIST:
2284 case S_CONNECT_RECV_ACK:
2285 /* ATS asks us to switch while we were trying to connect; switch to new
2286 address and check blacklist again */
2287 set_address (&n->primary_address,
2288 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2289 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2290 check_blacklist (&n->id,
2291 n->connect_ack_timestamp,
2295 GNUNET_assert (NULL != n->primary_address.address);
2296 GNUNET_assert (NULL != n->primary_address.session);
2297 if (n->primary_address.session == session)
2299 /* not an address change, just a quota change */
2300 set_address (&n->primary_address,
2301 address, session, bandwidth_in, bandwidth_out, GNUNET_YES);
2304 /* ATS asks us to switch a life connection; see if we can get
2305 a CONNECT_ACK on it before we actually do this! */
2306 set_address (&n->alternative_address,
2307 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2308 n->state = S_CONNECTED_SWITCHING_BLACKLIST;
2309 check_blacklist (&n->id,
2310 GNUNET_TIME_absolute_get (),
2313 case S_RECONNECT_ATS:
2314 set_address (&n->primary_address,
2315 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2316 n->state = S_RECONNECT_BLACKLIST;
2317 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2318 check_blacklist (&n->id,
2319 n->connect_ack_timestamp,
2322 case S_RECONNECT_BLACKLIST:
2323 /* ATS asks us to switch while we were trying to reconnect; switch to new
2324 address and check blacklist again */
2325 set_address (&n->primary_address,
2326 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2327 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2328 check_blacklist (&n->id,
2329 n->connect_ack_timestamp,
2332 case S_RECONNECT_SENT:
2333 /* ATS asks us to switch while we were trying to reconnect; switch to new
2334 address and check blacklist again */
2335 set_address (&n->primary_address,
2336 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2337 n->state = S_RECONNECT_BLACKLIST;
2338 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2339 check_blacklist (&n->id,
2340 n->connect_ack_timestamp,
2343 case S_CONNECTED_SWITCHING_BLACKLIST:
2344 if (n->primary_address.session == session)
2346 /* ATS switches back to still-active session */
2347 free_address (&n->alternative_address);
2348 n->state = S_CONNECTED;
2351 /* ATS asks us to switch a life connection, update blacklist check */
2352 set_address (&n->alternative_address,
2353 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2354 check_blacklist (&n->id,
2355 GNUNET_TIME_absolute_get (),
2358 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2359 if (n->primary_address.session == session)
2361 /* ATS switches back to still-active session */
2362 free_address (&n->alternative_address);
2363 n->state = S_CONNECTED;
2366 /* ATS asks us to switch a life connection, update blacklist check */
2367 set_address (&n->alternative_address,
2368 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2369 n->state = S_CONNECTED_SWITCHING_BLACKLIST;
2370 check_blacklist (&n->id,
2371 GNUNET_TIME_absolute_get (),
2375 /* not going to switch addresses while disconnecting */
2377 case S_DISCONNECT_FINISHED:
2381 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2382 "Unhandled state `%s'\n",
2383 print_state (n->state));
2391 send_utilization_data (void *cls,
2392 const struct GNUNET_PeerIdentity *key,
2395 struct NeighbourMapEntry *n = value;
2396 struct GNUNET_ATS_Information atsi[4];
2398 uint32_t bps_pl_out;
2401 struct GNUNET_TIME_Relative delta;
2403 delta = GNUNET_TIME_absolute_get_difference (n->last_util_transmission,
2404 GNUNET_TIME_absolute_get ());
2408 if ((0 != n->util_payload_bytes_recv) && (0 != delta.rel_value_us))
2409 bps_pl_in = (1000LL * 1000LL * n->util_payload_bytes_recv) / (delta.rel_value_us);
2411 if ((0 != n->util_payload_bytes_sent) && (0 != delta.rel_value_us))
2412 bps_pl_out = (1000LL * 1000LL * n->util_payload_bytes_sent) / delta.rel_value_us;
2413 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2414 "`%s' payload: received %u Bytes/s, sent %u Bytes/s\n",
2419 if ((0 != n->util_total_bytes_recv) && (0 != delta.rel_value_us))
2420 bps_in = (1000LL * 1000LL * n->util_total_bytes_recv) / (delta.rel_value_us);
2422 if ((0 != n->util_total_bytes_sent) && (0 != delta.rel_value_us))
2423 bps_out = (1000LL * 1000LL * n->util_total_bytes_sent) / delta.rel_value_us;
2426 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2427 "`%s' total: received %u Bytes/s, sent %u Bytes/s\n",
2431 atsi[0].type = htonl (GNUNET_ATS_UTILIZATION_OUT);
2432 atsi[0].value = htonl (bps_out);
2433 atsi[1].type = htonl (GNUNET_ATS_UTILIZATION_IN);
2434 atsi[1].value = htonl (bps_in);
2436 atsi[2].type = htonl (GNUNET_ATS_UTILIZATION_PAYLOAD_OUT);
2437 atsi[2].value = htonl (bps_pl_out);
2438 atsi[3].type = htonl (GNUNET_ATS_UTILIZATION_PAYLOAD_IN);
2439 atsi[3].value = htonl (bps_pl_in);
2441 GST_ats_update_metrics (key, n->primary_address.address,
2442 n->primary_address.session, atsi, 4);
2443 n->util_payload_bytes_recv = 0;
2444 n->util_payload_bytes_sent = 0;
2445 n->util_total_bytes_recv = 0;
2446 n->util_total_bytes_sent = 0;
2447 n->last_util_transmission = GNUNET_TIME_absolute_get();
2453 * Task transmitting utilization in a regular interval
2455 * @param cls the 'struct NeighbourMapEntry' for which we are running
2456 * @param tc scheduler context (unused)
2459 utilization_transmission (void *cls,
2460 const struct GNUNET_SCHEDULER_TaskContext *tc)
2462 util_transmission_tk = GNUNET_SCHEDULER_NO_TASK;
2464 if (0 < GNUNET_CONTAINER_multipeermap_size (neighbours))
2465 GNUNET_CONTAINER_multipeermap_iterate (neighbours, send_utilization_data, NULL);
2467 util_transmission_tk = GNUNET_SCHEDULER_add_delayed (UTIL_TRANSMISSION_INTERVAL,
2468 utilization_transmission, NULL);
2473 GST_neighbours_notify_data_recv (const struct GNUNET_PeerIdentity *peer,
2474 const struct GNUNET_HELLO_Address *address,
2475 struct Session *session,
2476 const struct GNUNET_MessageHeader *message)
2478 struct NeighbourMapEntry *n;
2479 n = lookup_neighbour (peer);
2484 n->util_total_bytes_recv += ntohs(message->size);
2488 GST_neighbours_notify_payload_recv (const struct GNUNET_PeerIdentity *peer,
2489 const struct GNUNET_HELLO_Address *address,
2490 struct Session *session,
2491 const struct GNUNET_MessageHeader *message)
2493 struct NeighbourMapEntry *n;
2494 n = lookup_neighbour (peer);
2499 n->util_payload_bytes_recv += ntohs(message->size);
2504 GST_neighbours_notify_data_sent (const struct GNUNET_PeerIdentity *peer,
2505 const struct GNUNET_HELLO_Address *address,
2506 struct Session *session,
2509 struct NeighbourMapEntry *n;
2510 n = lookup_neighbour (peer);
2513 if (n->primary_address.session != session)
2515 n->util_total_bytes_sent += size;
2519 GST_neighbours_notify_payload_sent (const struct GNUNET_PeerIdentity *peer,
2522 struct NeighbourMapEntry *n;
2523 n = lookup_neighbour (peer);
2528 n->util_payload_bytes_sent += size;
2533 * Master task run for every neighbour. Performs all of the time-related
2534 * activities (keep alive, send next message, disconnect if idle, finish
2535 * clean up after disconnect).
2537 * @param cls the 'struct NeighbourMapEntry' for which we are running
2538 * @param tc scheduler context (unused)
2541 master_task (void *cls,
2542 const struct GNUNET_SCHEDULER_TaskContext *tc)
2544 struct NeighbourMapEntry *n = cls;
2545 struct GNUNET_TIME_Relative delay;
2547 n->task = GNUNET_SCHEDULER_NO_TASK;
2548 delay = GNUNET_TIME_absolute_get_remaining (n->timeout);
2549 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2550 "Master task runs for neighbour `%s' in state %s with timeout in %s\n",
2551 GNUNET_i2s (&n->id),
2552 print_state(n->state),
2553 GNUNET_STRINGS_relative_time_to_string (delay,
2557 case S_NOT_CONNECTED:
2558 /* invalid state for master task, clean up */
2560 n->state = S_DISCONNECT_FINISHED;
2561 free_neighbour (n, GNUNET_NO);
2564 if (0 == delay.rel_value_us)
2566 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2567 "Connection to `%s' timed out waiting for ATS to provide address\n",
2568 GNUNET_i2s (&n->id));
2569 n->state = S_DISCONNECT_FINISHED;
2570 free_neighbour (n, GNUNET_NO);
2574 case S_INIT_BLACKLIST:
2575 if (0 == delay.rel_value_us)
2577 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2578 "Connection to `%s' timed out waiting for BLACKLIST to approve address\n",
2579 GNUNET_i2s (&n->id));
2580 n->state = S_DISCONNECT_FINISHED;
2581 free_neighbour (n, GNUNET_NO);
2585 case S_CONNECT_SENT:
2586 if (0 == delay.rel_value_us)
2588 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2589 "Connection to `%s' timed out waiting for other peer to send CONNECT_ACK\n",
2590 GNUNET_i2s (&n->id));
2591 disconnect_neighbour (n);
2595 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2596 if (0 == delay.rel_value_us)
2598 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2599 "Connection to `%s' timed out waiting BLACKLIST to approve address to use for received CONNECT\n",
2600 GNUNET_i2s (&n->id));
2601 n->state = S_DISCONNECT_FINISHED;
2602 free_neighbour (n, GNUNET_NO);
2606 case S_CONNECT_RECV_ATS:
2607 if (0 == delay.rel_value_us)
2609 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2610 "Connection to `%s' timed out waiting ATS to provide address to use for CONNECT_ACK\n",
2611 GNUNET_i2s (&n->id));
2612 n->state = S_DISCONNECT_FINISHED;
2613 free_neighbour (n, GNUNET_NO);
2617 case S_CONNECT_RECV_BLACKLIST:
2618 if (0 == delay.rel_value_us)
2620 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2621 "Connection to `%s' timed out waiting BLACKLIST to approve address to use for CONNECT_ACK\n",
2622 GNUNET_i2s (&n->id));
2623 n->state = S_DISCONNECT_FINISHED;
2624 free_neighbour (n, GNUNET_NO);
2628 case S_CONNECT_RECV_ACK:
2629 if (0 == delay.rel_value_us)
2631 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2632 "Connection to `%s' timed out waiting for other peer to send SESSION_ACK\n",
2633 GNUNET_i2s (&n->id));
2634 disconnect_neighbour (n);
2639 if (0 == delay.rel_value_us)
2641 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2642 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs\n",
2643 GNUNET_i2s (&n->id));
2644 disconnect_neighbour (n);
2647 try_transmission_to_peer (n);
2650 case S_RECONNECT_ATS:
2651 if (0 == delay.rel_value_us)
2653 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2654 "Connection to `%s' timed out, waiting for ATS replacement address\n",
2655 GNUNET_i2s (&n->id));
2656 disconnect_neighbour (n);
2660 case S_RECONNECT_BLACKLIST:
2661 if (0 == delay.rel_value_us)
2663 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2664 "Connection to `%s' timed out, waiting for BLACKLIST to approve replacement address\n",
2665 GNUNET_i2s (&n->id));
2666 disconnect_neighbour (n);
2670 case S_RECONNECT_SENT:
2671 if (0 == delay.rel_value_us)
2673 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2674 "Connection to `%s' timed out, waiting for other peer to CONNECT_ACK replacement address\n",
2675 GNUNET_i2s (&n->id));
2676 disconnect_neighbour (n);
2680 case S_CONNECTED_SWITCHING_BLACKLIST:
2681 if (0 == delay.rel_value_us)
2683 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2684 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs\n",
2685 GNUNET_i2s (&n->id));
2686 disconnect_neighbour (n);
2689 try_transmission_to_peer (n);
2692 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2693 if (0 == delay.rel_value_us)
2695 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2696 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs (after trying to CONNECT on alternative address)\n",
2697 GNUNET_i2s (&n->id));
2698 disconnect_neighbour (n);
2701 try_transmission_to_peer (n);
2705 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2706 "Cleaning up connection to `%s' after sending DISCONNECT\n",
2707 GNUNET_i2s (&n->id));
2708 free_neighbour (n, GNUNET_NO);
2710 case S_DISCONNECT_FINISHED:
2711 /* how did we get here!? */
2715 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2716 "Unhandled state `%s'\n",
2717 print_state (n->state));
2721 if ( (S_CONNECTED_SWITCHING_CONNECT_SENT == n->state) ||
2722 (S_CONNECTED_SWITCHING_BLACKLIST == n->state) ||
2723 (S_CONNECTED == n->state) )
2725 /* if we are *now* in one of these three states, we're sending
2726 keep alive messages, so we need to consider the keepalive
2727 delay, not just the connection timeout */
2728 delay = GNUNET_TIME_relative_min (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time),
2731 if (GNUNET_SCHEDULER_NO_TASK == n->task)
2732 n->task = GNUNET_SCHEDULER_add_delayed (delay,
2739 * Send a SESSION_ACK message to the neighbour to confirm that we
2740 * got his CONNECT_ACK.
2742 * @param n neighbour to send the SESSION_ACK to
2745 send_session_ack_message (struct NeighbourMapEntry *n)
2747 struct GNUNET_MessageHeader msg;
2749 msg.size = htons (sizeof (struct GNUNET_MessageHeader));
2750 msg.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK);
2751 (void) send_with_session(n,
2752 (const char *) &msg, sizeof (struct GNUNET_MessageHeader),
2753 UINT32_MAX, GNUNET_TIME_UNIT_FOREVER_REL,
2759 * We received a 'SESSION_CONNECT_ACK' message from the other peer.
2760 * Consider switching to it.
2762 * @param message possibly a 'struct SessionConnectMessage' (check format)
2763 * @param peer identity of the peer to switch the address for
2764 * @param address address of the other peer, NULL if other peer
2766 * @param session session to use (or NULL)
2769 GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
2770 const struct GNUNET_PeerIdentity *peer,
2771 const struct GNUNET_HELLO_Address *address,
2772 struct Session *session)
2774 const struct SessionConnectMessage *scm;
2775 struct GNUNET_TIME_Absolute ts;
2776 struct NeighbourMapEntry *n;
2778 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2779 "Received CONNECT_ACK message from peer `%s'\n",
2782 if (ntohs (message->size) != sizeof (struct SessionConnectMessage))
2784 GNUNET_break_op (0);
2787 scm = (const struct SessionConnectMessage *) message;
2788 GNUNET_break_op (ntohl (scm->reserved) == 0);
2789 if (NULL == (n = lookup_neighbour (peer)))
2791 GNUNET_STATISTICS_update (GST_stats,
2793 ("# unexpected CONNECT_ACK messages (no peer)"),
2797 ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
2800 case S_NOT_CONNECTED:
2802 free_neighbour (n, GNUNET_NO);
2805 case S_INIT_BLACKLIST:
2806 GNUNET_STATISTICS_update (GST_stats,
2808 ("# unexpected CONNECT_ACK messages (not ready)"),
2811 case S_CONNECT_SENT:
2812 if (ts.abs_value_us != n->primary_address.connect_timestamp.abs_value_us)
2813 break; /* ACK does not match our original CONNECT message */
2814 n->state = S_CONNECTED;
2815 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2816 GNUNET_STATISTICS_set (GST_stats,
2817 gettext_noop ("# peers connected"),
2818 ++neighbours_connected,
2820 connect_notify_cb (callback_cls, &n->id,
2821 n->primary_address.bandwidth_in,
2822 n->primary_address.bandwidth_out);
2823 /* Tell ATS that the outbound session we created to send CONNECT was successfull */
2824 GST_ats_add_address (n->primary_address.address, n->primary_address.session);
2825 set_address (&n->primary_address,
2826 n->primary_address.address,
2827 n->primary_address.session,
2828 n->primary_address.bandwidth_in,
2829 n->primary_address.bandwidth_out,
2831 send_session_ack_message (n);
2833 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2834 case S_CONNECT_RECV_ATS:
2835 case S_CONNECT_RECV_BLACKLIST:
2836 case S_CONNECT_RECV_ACK:
2837 GNUNET_STATISTICS_update (GST_stats,
2839 ("# unexpected CONNECT_ACK messages (not ready)"),
2843 /* duplicate CONNECT_ACK, let's answer by duplciate SESSION_ACK just in case */
2844 send_session_ack_message (n);
2846 case S_RECONNECT_ATS:
2847 case S_RECONNECT_BLACKLIST:
2848 /* we didn't expect any CONNECT_ACK, as we are waiting for ATS
2849 to give us a new address... */
2850 GNUNET_STATISTICS_update (GST_stats,
2852 ("# unexpected CONNECT_ACK messages (waiting on ATS)"),
2855 case S_RECONNECT_SENT:
2856 /* new address worked; go back to connected! */
2857 n->state = S_CONNECTED;
2858 send_session_ack_message (n);
2860 case S_CONNECTED_SWITCHING_BLACKLIST:
2861 /* duplicate CONNECT_ACK, let's answer by duplciate SESSION_ACK just in case */
2862 send_session_ack_message (n);
2864 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2865 /* new address worked; adopt it and go back to connected! */
2866 n->state = S_CONNECTED;
2867 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2868 GNUNET_break (GNUNET_NO == n->alternative_address.ats_active);
2870 GST_ats_add_address (n->alternative_address.address, n->alternative_address.session);
2871 set_address (&n->primary_address,
2872 n->alternative_address.address,
2873 n->alternative_address.session,
2874 n->alternative_address.bandwidth_in,
2875 n->alternative_address.bandwidth_out,
2877 free_address (&n->alternative_address);
2878 send_session_ack_message (n);
2881 GNUNET_STATISTICS_update (GST_stats,
2883 ("# unexpected CONNECT_ACK messages (disconnecting)"),
2886 case S_DISCONNECT_FINISHED:
2890 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2891 "Unhandled state `%s'\n",
2892 print_state (n->state));
2900 * A session was terminated. Take note; if needed, try to get
2901 * an alternative address from ATS.
2903 * @param peer identity of the peer where the session died
2904 * @param session session that is gone
2905 * @return GNUNET_YES if this was a session used, GNUNET_NO if
2906 * this session was not in use
2909 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
2910 struct Session *session)
2912 struct NeighbourMapEntry *n;
2913 struct BlackListCheckContext *bcc;
2914 struct BlackListCheckContext *bcc_next;
2916 /* make sure to cancel all ongoing blacklist checks involving 'session' */
2918 while (NULL != (bcc = bcc_next))
2920 bcc_next = bcc->next;
2921 if (bcc->na.session == session)
2923 GST_blacklist_test_cancel (bcc->bc);
2924 GNUNET_HELLO_address_free (bcc->na.address);
2925 GNUNET_CONTAINER_DLL_remove (bc_head,
2931 if (NULL == (n = lookup_neighbour (peer)))
2932 return GNUNET_NO; /* can't affect us */
2933 if (session != n->primary_address.session)
2935 if (session == n->alternative_address.session)
2937 free_address (&n->alternative_address);
2938 if ( (S_CONNECTED_SWITCHING_BLACKLIST == n->state) ||
2939 (S_CONNECTED_SWITCHING_CONNECT_SENT == n->state) )
2940 n->state = S_CONNECTED;
2944 return GNUNET_NO; /* doesn't affect us further */
2947 n->expect_latency_response = GNUNET_NO;
2950 case S_NOT_CONNECTED:
2952 free_neighbour (n, GNUNET_NO);
2956 free_neighbour (n, GNUNET_NO);
2958 case S_INIT_BLACKLIST:
2959 case S_CONNECT_SENT:
2960 free_address (&n->primary_address);
2961 n->state = S_INIT_ATS;
2962 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2963 // FIXME: need to ask ATS for suggestions again?
2964 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
2966 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2967 case S_CONNECT_RECV_ATS:
2968 case S_CONNECT_RECV_BLACKLIST:
2969 case S_CONNECT_RECV_ACK:
2970 /* error on inbound session; free neighbour entirely */
2971 free_address (&n->primary_address);
2972 free_neighbour (n, GNUNET_NO);
2975 free_address (&n->primary_address);
2976 n->state = S_RECONNECT_ATS;
2977 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2978 /* FIXME: is this ATS call needed? */
2979 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
2981 case S_RECONNECT_ATS:
2982 /* we don't have an address, how can it go down? */
2985 case S_RECONNECT_BLACKLIST:
2986 case S_RECONNECT_SENT:
2987 n->state = S_RECONNECT_ATS;
2988 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2989 // FIXME: need to ask ATS for suggestions again?
2990 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
2992 case S_CONNECTED_SWITCHING_BLACKLIST:
2993 /* primary went down while we were checking secondary against
2994 blacklist, adopt secondary as primary */
2995 free_address (&n->primary_address);
2996 n->primary_address = n->alternative_address;
2997 memset (&n->alternative_address, 0, sizeof (struct NeighbourAddress));
2998 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
2999 n->state = S_RECONNECT_BLACKLIST;
3001 case S_CONNECTED_SWITCHING_CONNECT_SENT:
3002 /* primary went down while we were waiting for CONNECT_ACK on secondary;
3003 secondary as primary */
3004 free_address (&n->primary_address);
3005 n->primary_address = n->alternative_address;
3006 memset (&n->alternative_address, 0, sizeof (struct NeighbourAddress));
3007 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
3008 n->state = S_RECONNECT_SENT;
3011 free_address (&n->primary_address);
3013 case S_DISCONNECT_FINISHED:
3014 /* neighbour was freed and plugins told to terminate session */
3018 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3019 "Unhandled state `%s'\n",
3020 print_state (n->state));
3024 if (GNUNET_SCHEDULER_NO_TASK != n->task)
3025 GNUNET_SCHEDULER_cancel (n->task);
3026 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
3032 * We received a 'SESSION_ACK' message from the other peer.
3033 * If we sent a 'CONNECT_ACK' last, this means we are now
3034 * connected. Otherwise, do nothing.
3036 * @param message possibly a 'struct SessionConnectMessage' (check format)
3037 * @param peer identity of the peer to switch the address for
3038 * @param address address of the other peer, NULL if other peer
3040 * @param session session to use (or NULL)
3043 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
3044 const struct GNUNET_PeerIdentity *peer,
3045 const struct GNUNET_HELLO_Address *address,
3046 struct Session *session)
3048 struct NeighbourMapEntry *n;
3050 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3051 "Received SESSION_ACK message from peer `%s'\n",
3053 if (ntohs (message->size) != sizeof (struct GNUNET_MessageHeader))
3055 GNUNET_break_op (0);
3058 if (NULL == (n = lookup_neighbour (peer)))
3060 /* check if we are in a plausible state for having sent
3061 a CONNECT_ACK. If not, return, otherwise break */
3062 if ( ( (S_CONNECT_RECV_ACK != n->state) &&
3063 (S_CONNECT_SENT != n->state) ) ||
3064 (2 != n->send_connect_ack) )
3066 GNUNET_STATISTICS_update (GST_stats,
3067 gettext_noop ("# unexpected SESSION ACK messages"), 1,
3071 n->state = S_CONNECTED;
3072 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
3073 GNUNET_STATISTICS_set (GST_stats,
3074 gettext_noop ("# peers connected"),
3075 ++neighbours_connected,
3077 connect_notify_cb (callback_cls, &n->id,
3078 n->primary_address.bandwidth_in,
3079 n->primary_address.bandwidth_out);
3081 GST_ats_add_address (n->primary_address.address, n->primary_address.session);
3082 set_address (&n->primary_address,
3083 n->primary_address.address,
3084 n->primary_address.session,
3085 n->primary_address.bandwidth_in,
3086 n->primary_address.bandwidth_out,
3092 * Test if we're connected to the given peer.
3094 * @param target peer to test
3095 * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
3098 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target)
3100 return test_connected (lookup_neighbour (target));
3105 * Change the incoming quota for the given peer.
3107 * @param neighbour identity of peer to change qutoa for
3108 * @param quota new quota
3111 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
3112 struct GNUNET_BANDWIDTH_Value32NBO quota)
3114 struct NeighbourMapEntry *n;
3116 if (NULL == (n = lookup_neighbour (neighbour)))
3118 GNUNET_STATISTICS_update (GST_stats,
3120 ("# SET QUOTA messages ignored (no such peer)"),
3124 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3125 "Setting inbound quota of %u Bps for peer `%s' to all clients\n",
3126 ntohl (quota.value__), GNUNET_i2s (&n->id));
3127 GNUNET_BANDWIDTH_tracker_update_quota (&n->in_tracker, quota);
3128 if (0 != ntohl (quota.value__))
3130 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting peer `%4s' due to `%s'\n",
3131 GNUNET_i2s (&n->id), "SET_QUOTA");
3132 if (GNUNET_YES == test_connected (n))
3133 GNUNET_STATISTICS_update (GST_stats,
3134 gettext_noop ("# disconnects due to quota of 0"),
3136 disconnect_neighbour (n);
3141 * We received a disconnect message from the given peer,
3142 * validate and process.
3144 * @param peer sender of the message
3145 * @param msg the disconnect message
3148 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
3150 const struct GNUNET_MessageHeader
3153 struct NeighbourMapEntry *n;
3154 const struct SessionDisconnectMessage *sdm;
3156 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3157 "Received DISCONNECT message from peer `%s'\n",
3159 if (ntohs (msg->size) != sizeof (struct SessionDisconnectMessage))
3161 // GNUNET_break_op (0);
3162 GNUNET_STATISTICS_update (GST_stats,
3164 ("# disconnect messages ignored (old format)"), 1,
3168 sdm = (const struct SessionDisconnectMessage *) msg;
3169 if (NULL == (n = lookup_neighbour (peer)))
3170 return; /* gone already */
3171 if (GNUNET_TIME_absolute_ntoh (sdm->timestamp).abs_value_us <= n->connect_ack_timestamp.abs_value_us)
3173 GNUNET_STATISTICS_update (GST_stats,
3175 ("# disconnect messages ignored (timestamp)"), 1,
3179 if (0 != memcmp (peer, &sdm->public_key, sizeof (struct GNUNET_PeerIdentity)))
3181 GNUNET_break_op (0);
3184 if (ntohl (sdm->purpose.size) !=
3185 sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
3186 sizeof (struct GNUNET_CRYPTO_EddsaPublicKey) +
3187 sizeof (struct GNUNET_TIME_AbsoluteNBO))
3189 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
3190 "%s message from peer `%s' has invalid size \n",
3193 GNUNET_break_op (0);
3197 GNUNET_CRYPTO_eddsa_verify
3198 (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT, &sdm->purpose,
3199 &sdm->signature, &sdm->public_key))
3201 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
3202 "%s message from peer `%s' cannot be verified \n",
3205 GNUNET_break_op (0);
3208 if (GNUNET_YES == test_connected (n))
3209 GNUNET_STATISTICS_update (GST_stats,
3211 ("# other peer asked to disconnect from us"), 1,
3213 disconnect_neighbour (n);
3218 * Closure for the neighbours_iterate function.
3220 struct IteratorContext
3223 * Function to call on each connected neighbour.
3225 GST_NeighbourIterator cb;
3235 * Call the callback from the closure for each connected neighbour.
3237 * @param cls the 'struct IteratorContext'
3238 * @param key the hash of the public key of the neighbour
3239 * @param value the 'struct NeighbourMapEntry'
3240 * @return GNUNET_OK (continue to iterate)
3243 neighbours_iterate (void *cls, const struct GNUNET_PeerIdentity * key, void *value)
3245 struct IteratorContext *ic = cls;
3246 struct NeighbourMapEntry *n = value;
3248 if (GNUNET_YES == test_connected (n))
3250 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
3251 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
3253 if (NULL != n->primary_address.address)
3255 bandwidth_in = n->primary_address.bandwidth_in;
3256 bandwidth_out = n->primary_address.bandwidth_out;
3260 bandwidth_in = GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT;
3261 bandwidth_out = GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT;
3264 ic->cb (ic->cb_cls, &n->id,
3265 n->primary_address.address,
3266 bandwidth_in, bandwidth_out);
3273 * Iterate over all connected neighbours.
3275 * @param cb function to call
3276 * @param cb_cls closure for cb
3279 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls)
3281 struct IteratorContext ic;
3283 if (NULL == neighbours)
3284 return; /* can happen during shutdown */
3287 GNUNET_CONTAINER_multipeermap_iterate (neighbours, &neighbours_iterate, &ic);
3292 * If we have an active connection to the given target, it must be shutdown.
3294 * @param target peer to disconnect from
3297 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target)
3299 struct NeighbourMapEntry *n;
3301 if (NULL == (n = lookup_neighbour (target)))
3302 return; /* not active */
3303 if (GNUNET_YES == test_connected (n))
3304 GNUNET_STATISTICS_update (GST_stats,
3306 ("# disconnected from peer upon explicit request"), 1,
3308 disconnect_neighbour (n);
3313 * Obtain current latency information for the given neighbour.
3315 * @param peer to get the latency for
3316 * @return observed latency of the address, FOREVER if the
3317 * the connection is not up
3319 struct GNUNET_TIME_Relative
3320 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer)
3322 struct NeighbourMapEntry *n;
3324 n = lookup_neighbour (peer);
3326 return GNUNET_TIME_UNIT_FOREVER_REL;
3330 case S_CONNECTED_SWITCHING_CONNECT_SENT:
3331 case S_CONNECTED_SWITCHING_BLACKLIST:
3332 case S_RECONNECT_SENT:
3333 case S_RECONNECT_ATS:
3334 case S_RECONNECT_BLACKLIST:
3336 case S_NOT_CONNECTED:
3337 case S_INIT_BLACKLIST:
3339 case S_CONNECT_RECV_BLACKLIST_INBOUND:
3340 case S_CONNECT_RECV_ATS:
3341 case S_CONNECT_RECV_BLACKLIST:
3342 case S_CONNECT_RECV_ACK:
3343 case S_CONNECT_SENT:
3345 case S_DISCONNECT_FINISHED:
3346 return GNUNET_TIME_UNIT_FOREVER_REL;
3348 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
3349 "Unhandled state `%s'\n",
3350 print_state (n->state));
3354 return GNUNET_TIME_UNIT_FOREVER_REL;
3359 * Obtain current address information for the given neighbour.
3362 * @return address currently used
3364 struct GNUNET_HELLO_Address *
3365 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer)
3367 struct NeighbourMapEntry *n;
3369 n = lookup_neighbour (peer);
3372 return n->primary_address.address;
3377 * Initialize the neighbours subsystem.
3379 * @param cls closure for callbacks
3380 * @param connect_cb function to call if we connect to a peer
3381 * @param disconnect_cb function to call if we disconnect from a peer
3382 * @param peer_address_cb function to call if we change an active address
3384 * @param max_fds maximum number of fds to use
3387 GST_neighbours_start (void *cls,
3388 NotifyConnect connect_cb,
3389 GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
3390 GNUNET_TRANSPORT_PeerIterateCallback peer_address_cb,
3391 unsigned int max_fds)
3394 connect_notify_cb = connect_cb;
3395 disconnect_notify_cb = disconnect_cb;
3396 address_change_cb = peer_address_cb;
3397 neighbours = GNUNET_CONTAINER_multipeermap_create (NEIGHBOUR_TABLE_SIZE, GNUNET_NO);
3398 util_transmission_tk = GNUNET_SCHEDULER_add_delayed (UTIL_TRANSMISSION_INTERVAL,
3399 utilization_transmission, NULL);
3404 * Disconnect from the given neighbour.
3407 * @param key hash of neighbour's public key (not used)
3408 * @param value the 'struct NeighbourMapEntry' of the neighbour
3409 * @return #GNUNET_OK (continue to iterate)
3412 disconnect_all_neighbours (void *cls,
3413 const struct GNUNET_PeerIdentity *key,
3416 struct NeighbourMapEntry *n = value;
3418 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3419 "Disconnecting peer `%4s', %s\n",
3420 GNUNET_i2s (&n->id), "SHUTDOWN_TASK");
3421 n->state = S_DISCONNECT_FINISHED;
3422 free_neighbour (n, GNUNET_NO);
3428 * Cleanup the neighbours subsystem.
3431 GST_neighbours_stop ()
3433 if (NULL == neighbours)
3435 if (GNUNET_SCHEDULER_NO_TASK != util_transmission_tk)
3437 GNUNET_SCHEDULER_cancel (util_transmission_tk);
3438 util_transmission_tk = GNUNET_SCHEDULER_NO_TASK;
3441 GNUNET_CONTAINER_multipeermap_iterate (neighbours,
3442 &disconnect_all_neighbours,
3444 GNUNET_CONTAINER_multipeermap_destroy (neighbours);
3446 callback_cls = NULL;
3447 connect_notify_cb = NULL;
3448 disconnect_notify_cb = NULL;
3449 address_change_cb = NULL;
3453 /* end of file gnunet-service-transport_neighbours.c */