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;
564 * Date of last utilization transmission
566 struct GNUNET_TIME_Absolute last_util_transmission;
571 * Context for blacklist checks and the 'handle_test_blacklist_cont'
572 * function. Stores information about ongoing blacklist checks.
574 struct BlackListCheckContext
578 * We keep blacklist checks in a DLL.
580 struct BlackListCheckContext *next;
583 * We keep blacklist checks in a DLL.
585 struct BlackListCheckContext *prev;
588 * Address that is being checked.
590 struct NeighbourAddress na;
593 * Handle to the ongoing blacklist check.
595 struct GST_BlacklistCheck *bc;
600 * Hash map from peer identities to the respective 'struct NeighbourMapEntry'.
602 static struct GNUNET_CONTAINER_MultiPeerMap *neighbours;
605 * We keep blacklist checks in a DLL so that we can find
606 * the 'sessions' in their 'struct NeighbourAddress' if
607 * a session goes down.
609 static struct BlackListCheckContext *bc_head;
612 * We keep blacklist checks in a DLL.
614 static struct BlackListCheckContext *bc_tail;
617 * Closure for connect_notify_cb, disconnect_notify_cb and address_change_cb
619 static void *callback_cls;
622 * Function to call when we connected to a neighbour.
624 static NotifyConnect connect_notify_cb;
627 * Function to call when we disconnected from a neighbour.
629 static GNUNET_TRANSPORT_NotifyDisconnect disconnect_notify_cb;
632 * Function to call when we changed an active address of a neighbour.
634 static GNUNET_TRANSPORT_PeerIterateCallback address_change_cb;
637 * counter for connected neighbours
639 static unsigned int neighbours_connected;
642 * Number of bytes we have currently queued for transmission.
644 static unsigned long long bytes_in_send_queue;
647 * Task transmitting utilization data
649 static GNUNET_SCHEDULER_TaskIdentifier util_transmission_tk;
653 * Lookup a neighbour entry in the neighbours hash map.
655 * @param pid identity of the peer to look up
656 * @return the entry, NULL if there is no existing record
658 static struct NeighbourMapEntry *
659 lookup_neighbour (const struct GNUNET_PeerIdentity *pid)
661 if (NULL == neighbours)
663 return GNUNET_CONTAINER_multipeermap_get (neighbours, pid);
667 print_state (int state)
672 case S_NOT_CONNECTED:
673 return "S_NOT_CONNECTED";
676 case S_INIT_BLACKLIST:
677 return "S_INIT_BLACKLIST";
679 return "S_CONNECT_SENT";
680 case S_CONNECT_RECV_BLACKLIST_INBOUND:
681 return "S_CONNECT_RECV_BLACKLIST_INBOUND";
682 case S_CONNECT_RECV_ATS:
683 return "S_CONNECT_RECV_ATS";
684 case S_CONNECT_RECV_BLACKLIST:
685 return "S_CONNECT_RECV_BLACKLIST";
686 case S_CONNECT_RECV_ACK:
687 return "S_CONNECT_RECV_ACK";
689 return "S_CONNECTED";
690 case S_RECONNECT_ATS:
691 return "S_RECONNECT_ATS";
692 case S_RECONNECT_BLACKLIST:
693 return "S_RECONNECT_BLACKLIST";
694 case S_RECONNECT_SENT:
695 return "S_RECONNECT_SENT";
696 case S_CONNECTED_SWITCHING_BLACKLIST:
697 return "S_CONNECTED_SWITCHING_BLACKLIST";
698 case S_CONNECTED_SWITCHING_CONNECT_SENT:
699 return "S_CONNECTED_SWITCHING_CONNECT_SENT";
701 return "S_DISCONNECT";
702 case S_DISCONNECT_FINISHED:
703 return "S_DISCONNECT_FINISHED";
711 * Test if we're connected to the given peer.
713 * @param n neighbour entry of peer to test
714 * @return GNUNET_YES if we are connected, GNUNET_NO if not
717 test_connected (struct NeighbourMapEntry *n)
723 case S_NOT_CONNECTED:
725 case S_INIT_BLACKLIST:
727 case S_CONNECT_RECV_BLACKLIST_INBOUND:
728 case S_CONNECT_RECV_ATS:
729 case S_CONNECT_RECV_BLACKLIST:
730 case S_CONNECT_RECV_ACK:
733 case S_RECONNECT_ATS:
734 case S_RECONNECT_BLACKLIST:
735 case S_RECONNECT_SENT:
736 case S_CONNECTED_SWITCHING_BLACKLIST:
737 case S_CONNECTED_SWITCHING_CONNECT_SENT:
740 case S_DISCONNECT_FINISHED:
743 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",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);
910 n->state = S_DISCONNECT_FINISHED;
912 if (NULL != n->primary_address.address)
914 backup_primary = GNUNET_HELLO_address_copy(n->primary_address.address);
917 backup_primary = NULL;
919 /* free addresses and mark as unused */
920 free_address (&n->primary_address);
921 free_address (&n->alternative_address);
923 /* FIXME-PLUGIN-API: This does not seem to guarantee that all
924 transport sessions eventually get killed due to inactivity; they
925 MUST have their own timeout logic (but at least TCP doesn't have
926 one yet). Are we sure that EVERY 'session' of a plugin is
927 actually cleaned up this way!? Note that if we are switching
928 between two TCP sessions to the same peer, the existing plugin
929 API gives us not even the means to selectively kill only one of
930 them! Killing all sessions like this seems to be very, very
933 /* cut transport-level connection */
934 if ((GNUNET_NO == keep_sessions) &&
935 (NULL != backup_primary) &&
936 (NULL != (papi = GST_plugins_find (backup_primary->transport_name))))
937 papi->disconnect (papi->cls, &n->id);
939 GNUNET_free_non_null (backup_primary);
941 GNUNET_assert (GNUNET_YES ==
942 GNUNET_CONTAINER_multipeermap_remove (neighbours,
945 // FIXME-ATS-API: we might want to be more specific about
946 // which states we do this from in the future (ATS should
947 // have given us a 'suggest_address' handle, and if we have
948 // such a handle, we should cancel the operation here!
949 if (NULL != n->suggest_handle)
951 GNUNET_ATS_suggest_address_cancel (GST_ats, &n->id);
952 n->suggest_handle = NULL;
955 if (GNUNET_SCHEDULER_NO_TASK != n->task)
957 GNUNET_SCHEDULER_cancel (n->task);
958 n->task = GNUNET_SCHEDULER_NO_TASK;
960 /* free rest of memory */
965 * Transmit a message using the current session of the given
968 * @param n entry for the recipient
969 * @param msgbuf buffer to transmit
970 * @param msgbuf_size number of bytes in buffer
971 * @param priority transmission priority
972 * @param timeout transmission timeout
973 * @param cont continuation to call when finished (can be NULL)
974 * @param cont_cls closure for cont
977 send_with_session (struct NeighbourMapEntry *n,
978 const char *msgbuf, size_t msgbuf_size,
980 struct GNUNET_TIME_Relative timeout,
981 GNUNET_TRANSPORT_TransmitContinuation cont,
984 struct GNUNET_TRANSPORT_PluginFunctions *papi;
986 GNUNET_assert (n->primary_address.session != NULL);
987 if ( ((NULL == (papi = GST_plugins_find (n->primary_address.address->transport_name)) ||
988 (-1 == papi->send (papi->cls,
989 n->primary_address.session,
993 cont, cont_cls)))) &&
995 cont (cont_cls, &n->id, GNUNET_SYSERR, msgbuf_size, 0);
996 GNUNET_break (NULL != papi);
1001 * Master task run for every neighbour. Performs all of the time-related
1002 * activities (keep alive, send next message, disconnect if idle, finish
1003 * clean up after disconnect).
1005 * @param cls the 'struct NeighbourMapEntry' for which we are running
1006 * @param tc scheduler context (unused)
1009 master_task (void *cls,
1010 const struct GNUNET_SCHEDULER_TaskContext *tc);
1014 * Function called when the 'DISCONNECT' message has been sent by the
1015 * plugin. Frees the neighbour --- if the entry still exists.
1018 * @param target identity of the neighbour that was disconnected
1019 * @param result GNUNET_OK if the disconnect got out successfully
1020 * @param payload bytes payload
1021 * @param physical bytes physical
1024 send_disconnect_cont (void *cls, const struct GNUNET_PeerIdentity *target,
1025 int result, size_t payload, size_t physical)
1027 struct NeighbourMapEntry *n;
1029 n = lookup_neighbour (target);
1031 return; /* already gone */
1032 if (S_DISCONNECT != n->state)
1033 return; /* have created a fresh entry since */
1034 n->state = S_DISCONNECT;
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, "Unhandled state `%s' \n",print_state (n->state));
1154 /* schedule timeout to clean up */
1155 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1156 GNUNET_SCHEDULER_cancel (n->task);
1157 n->task = GNUNET_SCHEDULER_add_delayed (DISCONNECT_SENT_TIMEOUT,
1163 * We're done with our transmission attempt, continue processing.
1165 * @param cls the 'struct MessageQueue' of the message
1166 * @param receiver intended receiver
1167 * @param success whether it worked or not
1168 * @param size_payload bytes payload sent
1169 * @param physical bytes sent on wire
1172 transmit_send_continuation (void *cls,
1173 const struct GNUNET_PeerIdentity *receiver,
1174 int success, size_t size_payload, size_t physical)
1176 struct MessageQueue *mq = cls;
1177 struct NeighbourMapEntry *n;
1179 if (NULL == (n = lookup_neighbour (receiver)))
1182 return; /* disconnect or other error while transmitting, can happen */
1184 if (n->is_active == mq)
1186 /* this is still "our" neighbour, remove us from its queue
1187 and allow it to send the next message now */
1188 n->is_active = NULL;
1189 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1190 GNUNET_SCHEDULER_cancel (n->task);
1191 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1193 if (bytes_in_send_queue < mq->message_buf_size)
1195 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1196 "Bytes_in_send_queue `%u', Message_size %u, result: %s, payload %u, on wire %u\n",
1197 bytes_in_send_queue, mq->message_buf_size,
1198 (GNUNET_OK == success) ? "OK" : "FAIL",
1199 size_payload, physical);
1204 GNUNET_break (size_payload == mq->message_buf_size);
1205 bytes_in_send_queue -= mq->message_buf_size;
1206 GNUNET_STATISTICS_set (GST_stats,
1208 ("# bytes in message queue for other peers"),
1209 bytes_in_send_queue, GNUNET_NO);
1210 if (GNUNET_OK == success)
1211 GNUNET_STATISTICS_update (GST_stats,
1213 ("# messages transmitted to other peers"),
1216 GNUNET_STATISTICS_update (GST_stats,
1218 ("# transmission failures for messages to other peers"),
1220 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1221 "Sending message to `%s' of type %u was a %s\n",
1222 GNUNET_i2s (receiver),
1223 ntohs (((struct GNUNET_MessageHeader *) mq->message_buf)->type),
1224 (success == GNUNET_OK) ? "success" : "FAILURE");
1225 if (NULL != mq->cont)
1226 mq->cont (mq->cont_cls, success, size_payload, physical);
1232 * Check the message list for the given neighbour and if we can
1233 * send a message, do so. This function should only be called
1234 * if the connection is at least generally ready for transmission.
1235 * While we will only send one message at a time, no bandwidth
1236 * quota management is performed here. If a message was given to
1237 * the plugin, the continuation will automatically re-schedule
1238 * the 'master' task once the next message might be transmitted.
1240 * @param n target peer for which to transmit
1243 try_transmission_to_peer (struct NeighbourMapEntry *n)
1245 struct MessageQueue *mq;
1246 struct GNUNET_TIME_Relative timeout;
1248 if (NULL == n->primary_address.address)
1250 /* no address, why are we here? */
1254 if ((0 == n->primary_address.address->address_length) &&
1255 (NULL == n->primary_address.session))
1257 /* no address, why are we here? */
1261 if (NULL != n->is_active)
1263 /* transmission already pending */
1267 /* timeout messages from the queue that are past their due date */
1268 while (NULL != (mq = n->messages_head))
1270 timeout = GNUNET_TIME_absolute_get_remaining (mq->timeout);
1271 if (timeout.rel_value_us > 0)
1273 GNUNET_STATISTICS_update (GST_stats,
1275 ("# messages timed out while in transport queue"),
1277 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
1279 transmit_send_continuation (mq, &n->id, GNUNET_SYSERR, mq->message_buf_size, 0); /* timeout */
1282 return; /* no more messages */
1283 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
1285 send_with_session (n,
1286 mq->message_buf, mq->message_buf_size,
1287 0 /* priority */, timeout,
1288 &transmit_send_continuation, mq);
1293 * Send keepalive message to the neighbour. Must only be called
1294 * if we are on 'connected' state or while trying to switch addresses.
1295 * Will internally determine if a keepalive is truly needed (so can
1296 * always be called).
1298 * @param n neighbour that went idle and needs a keepalive
1301 send_keepalive (struct NeighbourMapEntry *n)
1303 struct GNUNET_MessageHeader m;
1305 GNUNET_assert ((S_CONNECTED == n->state) ||
1306 (S_CONNECTED_SWITCHING_BLACKLIST == n->state) ||
1307 (S_CONNECTED_SWITCHING_CONNECT_SENT));
1308 if (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time).rel_value_us > 0)
1309 return; /* no keepalive needed at this time */
1310 m.size = htons (sizeof (struct GNUNET_MessageHeader));
1311 m.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE);
1312 send_with_session (n,
1313 (const void *) &m, sizeof (m),
1314 UINT32_MAX /* priority */,
1315 KEEPALIVE_FREQUENCY,
1317 GNUNET_STATISTICS_update (GST_stats, gettext_noop ("# keepalives sent"), 1,
1319 n->expect_latency_response = GNUNET_YES;
1320 n->last_keep_alive_time = GNUNET_TIME_absolute_get ();
1321 n->keep_alive_time = GNUNET_TIME_relative_to_absolute (KEEPALIVE_FREQUENCY);
1326 * Keep the connection to the given neighbour alive longer,
1327 * we received a KEEPALIVE (or equivalent); send a response.
1329 * @param neighbour neighbour to keep alive (by sending keep alive response)
1332 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour)
1334 struct NeighbourMapEntry *n;
1335 struct GNUNET_MessageHeader m;
1337 if (NULL == (n = lookup_neighbour (neighbour)))
1339 GNUNET_STATISTICS_update (GST_stats,
1341 ("# KEEPALIVE messages discarded (peer unknown)"),
1345 if (NULL == n->primary_address.session)
1347 GNUNET_STATISTICS_update (GST_stats,
1349 ("# KEEPALIVE messages discarded (no session)"),
1353 /* send reply to allow neighbour to measure latency */
1354 m.size = htons (sizeof (struct GNUNET_MessageHeader));
1355 m.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE);
1356 send_with_session(n,
1357 (const void *) &m, sizeof (m),
1358 UINT32_MAX /* priority */,
1359 KEEPALIVE_FREQUENCY,
1365 * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
1366 * latency to this peer. Pass the updated information (existing ats
1367 * plus calculated latency) to ATS.
1369 * @param neighbour neighbour to keep alive
1372 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour)
1374 struct NeighbourMapEntry *n;
1376 struct GNUNET_ATS_Information ats;
1378 if (NULL == (n = lookup_neighbour (neighbour)))
1380 GNUNET_STATISTICS_update (GST_stats,
1382 ("# KEEPALIVE_RESPONSE messages discarded (not connected)"),
1386 if ( (S_CONNECTED != n->state) ||
1387 (GNUNET_YES != n->expect_latency_response) )
1389 GNUNET_STATISTICS_update (GST_stats,
1391 ("# KEEPALIVE_RESPONSE messages discarded (not expected)"),
1395 n->expect_latency_response = GNUNET_NO;
1396 n->latency = GNUNET_TIME_absolute_get_duration (n->last_keep_alive_time);
1397 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1398 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1399 "Latency for peer `%s' is %s\n",
1400 GNUNET_i2s (&n->id),
1401 GNUNET_STRINGS_relative_time_to_string (n->latency,
1403 /* append latency */
1404 ats.type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
1405 if (n->latency.rel_value_us > UINT32_MAX)
1406 latency = UINT32_MAX;
1408 latency = n->latency.rel_value_us;
1409 ats.value = htonl (latency);
1410 GST_ats_update_metrics (&n->id,
1411 n->primary_address.address,
1412 n->primary_address.session,
1418 * We have received a message from the given sender. How long should
1419 * we delay before receiving more? (Also used to keep the peer marked
1422 * @param sender sender of the message
1423 * @param size size of the message
1424 * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
1425 * GNUNET_NO if the neighbour is not connected or violates the quota,
1426 * GNUNET_SYSERR if the connection is not fully up yet
1427 * @return how long to wait before reading more from this sender
1429 struct GNUNET_TIME_Relative
1430 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
1431 *sender, ssize_t size, int *do_forward)
1433 struct NeighbourMapEntry *n;
1434 struct GNUNET_TIME_Relative ret;
1436 if (NULL == neighbours)
1438 *do_forward = GNUNET_NO;
1439 return GNUNET_TIME_UNIT_FOREVER_REL; /* This can happen during shutdown */
1441 if (NULL == (n = lookup_neighbour (sender)))
1443 GST_neighbours_try_connect (sender);
1444 if (NULL == (n = lookup_neighbour (sender)))
1446 GNUNET_STATISTICS_update (GST_stats,
1448 ("# messages discarded due to lack of neighbour record"),
1450 *do_forward = GNUNET_NO;
1451 return GNUNET_TIME_UNIT_ZERO;
1454 if (! test_connected (n))
1456 *do_forward = GNUNET_SYSERR;
1457 return GNUNET_TIME_UNIT_ZERO;
1459 if (GNUNET_YES == GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, size))
1461 n->quota_violation_count++;
1462 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1463 "Bandwidth quota (%u b/s) violation detected (total of %u).\n",
1464 n->in_tracker.available_bytes_per_s__,
1465 n->quota_violation_count);
1466 /* Discount 32k per violation */
1467 GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, -32 * 1024);
1471 if (n->quota_violation_count > 0)
1473 /* try to add 32k back */
1474 GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, 32 * 1024);
1475 n->quota_violation_count--;
1478 if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
1480 GNUNET_STATISTICS_update (GST_stats,
1482 ("# bandwidth quota violations by other peers"),
1484 *do_forward = GNUNET_NO;
1485 return GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT;
1487 *do_forward = GNUNET_YES;
1488 ret = GNUNET_BANDWIDTH_tracker_get_delay (&n->in_tracker, 32 * 1024);
1489 if (ret.rel_value_us > 0)
1491 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1492 "Throttling read (%llu bytes excess at %u b/s), waiting %s before reading more.\n",
1493 (unsigned long long) n->in_tracker.
1494 consumption_since_last_update__,
1495 (unsigned int) n->in_tracker.available_bytes_per_s__,
1496 GNUNET_STRINGS_relative_time_to_string (ret, GNUNET_YES));
1497 GNUNET_STATISTICS_update (GST_stats,
1498 gettext_noop ("# ms throttling suggested"),
1499 (int64_t) ret.rel_value_us / 1000LL,
1507 * Transmit a message to the given target using the active connection.
1509 * @param target destination
1510 * @param msg message to send
1511 * @param msg_size number of bytes in msg
1512 * @param timeout when to fail with timeout
1513 * @param cont function to call when done
1514 * @param cont_cls closure for 'cont'
1517 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
1518 size_t msg_size, struct GNUNET_TIME_Relative timeout,
1519 GST_NeighbourSendContinuation cont, void *cont_cls)
1521 struct NeighbourMapEntry *n;
1522 struct MessageQueue *mq;
1524 /* All ove these cases should never happen; they are all API violations.
1525 But we check anyway, just to be sure. */
1526 if (NULL == (n = lookup_neighbour (target)))
1530 cont (cont_cls, GNUNET_SYSERR, msg_size, 0);
1533 if (GNUNET_YES != test_connected (n))
1537 cont (cont_cls, GNUNET_SYSERR, msg_size, 0);
1540 bytes_in_send_queue += msg_size;
1541 GNUNET_STATISTICS_set (GST_stats,
1543 ("# bytes in message queue for other peers"),
1544 bytes_in_send_queue, GNUNET_NO);
1545 mq = GNUNET_malloc (sizeof (struct MessageQueue) + msg_size);
1547 mq->cont_cls = cont_cls;
1548 memcpy (&mq[1], msg, msg_size);
1549 mq->message_buf = (const char *) &mq[1];
1550 mq->message_buf_size = msg_size;
1551 mq->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1552 GNUNET_CONTAINER_DLL_insert_tail (n->messages_head, n->messages_tail, mq);
1553 if ( (NULL != n->is_active) ||
1554 ( (NULL == n->primary_address.session) && (NULL == n->primary_address.address)) )
1556 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1557 GNUNET_SCHEDULER_cancel (n->task);
1558 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1563 * Send a SESSION_CONNECT message via the given address.
1565 * @param na address to use
1568 send_session_connect (struct NeighbourAddress *na)
1570 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1571 struct SessionConnectMessage connect_msg;
1573 if (NULL == (papi = GST_plugins_find (na->address->transport_name)))
1578 if (NULL == na->session)
1579 na->session = papi->get_session (papi->cls, na->address);
1580 if (NULL == na->session)
1585 na->connect_timestamp = GNUNET_TIME_absolute_get ();
1586 connect_msg.header.size = htons (sizeof (struct SessionConnectMessage));
1587 connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT);
1588 connect_msg.reserved = htonl (0);
1589 connect_msg.timestamp = GNUNET_TIME_absolute_hton (na->connect_timestamp);
1590 (void) papi->send (papi->cls,
1592 (const char *) &connect_msg, sizeof (struct SessionConnectMessage),
1594 GNUNET_TIME_UNIT_FOREVER_REL,
1601 * Send a SESSION_CONNECT_ACK message via the given address.
1603 * @param address address to use
1604 * @param session session to use
1605 * @param timestamp timestamp to use for the ACK message
1608 send_session_connect_ack_message (const struct GNUNET_HELLO_Address *address,
1609 struct Session *session,
1610 struct GNUNET_TIME_Absolute timestamp)
1612 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1613 struct SessionConnectMessage connect_msg;
1615 if (NULL == (papi = GST_plugins_find (address->transport_name)))
1620 if (NULL == session)
1621 session = papi->get_session (papi->cls, address);
1622 if (NULL == session)
1627 connect_msg.header.size = htons (sizeof (struct SessionConnectMessage));
1628 connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK);
1629 connect_msg.reserved = htonl (0);
1630 connect_msg.timestamp = GNUNET_TIME_absolute_hton (timestamp);
1631 (void) papi->send (papi->cls,
1633 (const char *) &connect_msg, sizeof (struct SessionConnectMessage),
1635 GNUNET_TIME_UNIT_FOREVER_REL,
1642 * Create a fresh entry in the neighbour map for the given peer
1644 * @param peer peer to create an entry for
1645 * @return new neighbour map entry
1647 static struct NeighbourMapEntry *
1648 setup_neighbour (const struct GNUNET_PeerIdentity *peer)
1650 struct NeighbourMapEntry *n;
1652 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1653 "Creating new neighbour entry for `%s'\n",
1655 n = GNUNET_malloc (sizeof (struct NeighbourMapEntry));
1657 n->state = S_NOT_CONNECTED;
1658 n->latency = GNUNET_TIME_UNIT_FOREVER_REL;
1659 n->last_util_transmission = GNUNET_TIME_absolute_get();
1660 n->util_payload_bytes_recv = 0;
1661 n->util_payload_bytes_sent = 0;
1662 n->util_total_bytes_recv = 0;
1663 n->util_total_bytes_sent = 0;
1664 GNUNET_BANDWIDTH_tracker_init (&n->in_tracker,
1665 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
1666 MAX_BANDWIDTH_CARRY_S);
1667 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1668 GNUNET_assert (GNUNET_OK ==
1669 GNUNET_CONTAINER_multipeermap_put (neighbours,
1671 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1677 * Check if the two given addresses are the same.
1678 * Actually only checks if the sessions are non-NULL
1679 * (which they should be) and then if they are identical;
1680 * the actual addresses don't matter if the session
1681 * pointers match anyway, and we must have session pointers
1684 * @param a1 first address to compare
1685 * @param a2 other address to compare
1686 * @return GNUNET_NO if the addresses do not match, GNUNET_YES if they do match
1689 address_matches (const struct NeighbourAddress *a1,
1690 const struct NeighbourAddress *a2)
1692 if ( (NULL == a1->session) ||
1693 (NULL == a2->session) )
1698 return (a1->session == a2->session) ? GNUNET_YES : GNUNET_NO;
1703 * Try to create a connection to the given target (eventually).
1705 * @param target peer to try to connect to
1708 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target)
1710 struct NeighbourMapEntry *n;
1712 if (NULL == neighbours)
1714 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1715 "Asked to connect to peer `%s' during shutdown\n",
1716 GNUNET_i2s (target));
1717 return; /* during shutdown, do nothing */
1719 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1720 "Asked to connect to peer `%s'\n",
1721 GNUNET_i2s (target));
1722 if (0 == memcmp (target, &GST_my_identity, sizeof (struct GNUNET_PeerIdentity)))
1724 /* refuse to connect to myself */
1725 /* FIXME: can this happen? Is this not an API violation? */
1726 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1727 "Refusing to try to connect to myself.\n");
1730 n = lookup_neighbour (target);
1735 case S_NOT_CONNECTED:
1736 /* this should not be possible */
1738 free_neighbour (n, GNUNET_NO);
1741 case S_INIT_BLACKLIST:
1742 case S_CONNECT_SENT:
1743 case S_CONNECT_RECV_BLACKLIST_INBOUND:
1744 case S_CONNECT_RECV_ATS:
1745 case S_CONNECT_RECV_BLACKLIST:
1746 case S_CONNECT_RECV_ACK:
1747 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1748 "Ignoring request to try to connect to `%s', already trying!\n",
1749 GNUNET_i2s (target));
1750 return; /* already trying */
1752 case S_RECONNECT_ATS:
1753 case S_RECONNECT_BLACKLIST:
1754 case S_RECONNECT_SENT:
1755 case S_CONNECTED_SWITCHING_BLACKLIST:
1756 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1757 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1758 "Ignoring request to try to connect, already connected to `%s'!\n",
1759 GNUNET_i2s (target));
1760 return; /* already connected */
1762 /* get rid of remains, ready to re-try immediately */
1763 free_neighbour (n, GNUNET_NO);
1765 case S_DISCONNECT_FINISHED:
1766 /* should not be possible */
1769 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
1771 free_neighbour (n, GNUNET_NO);
1775 n = setup_neighbour (target);
1776 n->state = S_INIT_ATS;
1777 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1779 GNUNET_ATS_reset_backoff (GST_ats, target);
1780 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, target);
1785 * Function called with the result of a blacklist check.
1787 * @param cls closure with the 'struct BlackListCheckContext'
1788 * @param peer peer this check affects
1789 * @param result GNUNET_OK if the address is allowed
1792 handle_test_blacklist_cont (void *cls,
1793 const struct GNUNET_PeerIdentity *peer,
1796 struct BlackListCheckContext *bcc = cls;
1797 struct NeighbourMapEntry *n;
1800 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1801 "Connection to new address of peer `%s' based on blacklist is `%s'\n",
1803 (GNUNET_OK == result) ? "allowed" : "FORBIDDEN");
1804 if (NULL == (n = lookup_neighbour (peer)))
1805 goto cleanup; /* nobody left to care about new address */
1808 case S_NOT_CONNECTED:
1809 /* this should not be possible */
1811 free_neighbour (n, GNUNET_NO);
1814 /* still waiting on ATS suggestion */
1816 case S_INIT_BLACKLIST:
1817 /* check if the address the blacklist was fine with matches
1818 ATS suggestion, if so, we can move on! */
1819 if ( (GNUNET_OK == result) &&
1820 (1 == n->send_connect_ack) )
1822 n->send_connect_ack = 2;
1823 send_session_connect_ack_message (bcc->na.address,
1825 n->connect_ack_timestamp);
1827 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1828 break; /* result for an address we currently don't care about */
1829 if (GNUNET_OK == result)
1831 n->timeout = GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT);
1832 n->state = S_CONNECT_SENT;
1833 send_session_connect (&n->primary_address);
1837 // FIXME: should also possibly destroy session with plugin!?
1838 GNUNET_ATS_address_destroyed (GST_ats,
1841 free_address (&n->primary_address);
1842 n->state = S_INIT_ATS;
1843 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1844 // FIXME: do we need to ask ATS again for suggestions?
1845 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
1848 case S_CONNECT_SENT:
1849 /* waiting on CONNECT_ACK, send ACK if one is pending */
1850 if ( (GNUNET_OK == result) &&
1851 (1 == n->send_connect_ack) )
1853 n->send_connect_ack = 2;
1854 send_session_connect_ack_message (n->primary_address.address,
1855 n->primary_address.session,
1856 n->connect_ack_timestamp);
1859 case S_CONNECT_RECV_BLACKLIST_INBOUND:
1860 if (GNUNET_OK == result)
1861 GST_ats_add_address (bcc->na.address, bcc->na.session);
1863 n->state = S_CONNECT_RECV_ATS;
1864 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1865 GNUNET_ATS_reset_backoff (GST_ats, peer);
1866 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, peer);
1868 case S_CONNECT_RECV_ATS:
1869 /* still waiting on ATS suggestion, don't care about blacklist */
1871 case S_CONNECT_RECV_BLACKLIST:
1872 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1873 break; /* result for an address we currently don't care about */
1874 if (GNUNET_OK == result)
1876 n->timeout = GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT);
1877 n->state = S_CONNECT_RECV_ACK;
1878 send_session_connect_ack_message (bcc->na.address,
1880 n->connect_ack_timestamp);
1881 if (1 == n->send_connect_ack)
1882 n->send_connect_ack = 2;
1886 // FIXME: should also possibly destroy session with plugin!?
1887 GNUNET_ATS_address_destroyed (GST_ats,
1890 free_address (&n->primary_address);
1891 n->state = S_INIT_ATS;
1892 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1893 // FIXME: do we need to ask ATS again for suggestions?
1894 GNUNET_ATS_reset_backoff (GST_ats, peer);
1895 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
1898 case S_CONNECT_RECV_ACK:
1899 /* waiting on SESSION_ACK, send ACK if one is pending */
1900 if ( (GNUNET_OK == result) &&
1901 (1 == n->send_connect_ack) )
1903 n->send_connect_ack = 2;
1904 send_session_connect_ack_message (n->primary_address.address,
1905 n->primary_address.session,
1906 n->connect_ack_timestamp);
1910 /* already connected, don't care about blacklist */
1912 case S_RECONNECT_ATS:
1913 /* still waiting on ATS suggestion, don't care about blacklist */
1915 case S_RECONNECT_BLACKLIST:
1916 if ( (GNUNET_OK == result) &&
1917 (1 == n->send_connect_ack) )
1919 n->send_connect_ack = 2;
1920 send_session_connect_ack_message (bcc->na.address,
1922 n->connect_ack_timestamp);
1924 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1925 break; /* result for an address we currently don't care about */
1926 if (GNUNET_OK == result)
1928 send_session_connect (&n->primary_address);
1929 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
1930 n->state = S_RECONNECT_SENT;
1934 GNUNET_ATS_address_destroyed (GST_ats,
1937 n->state = S_RECONNECT_ATS;
1938 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1939 // FIXME: do we need to ask ATS again for suggestions?
1940 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
1943 case S_RECONNECT_SENT:
1944 /* waiting on CONNECT_ACK, don't care about blacklist */
1945 if ( (GNUNET_OK == result) &&
1946 (1 == n->send_connect_ack) )
1948 n->send_connect_ack = 2;
1949 send_session_connect_ack_message (n->primary_address.address,
1950 n->primary_address.session,
1951 n->connect_ack_timestamp);
1954 case S_CONNECTED_SWITCHING_BLACKLIST:
1955 if (GNUNET_YES != address_matches (&bcc->na, &n->alternative_address))
1956 break; /* result for an address we currently don't care about */
1957 if (GNUNET_OK == result)
1959 send_session_connect (&n->alternative_address);
1960 n->state = S_CONNECTED_SWITCHING_CONNECT_SENT;
1964 GNUNET_ATS_address_destroyed (GST_ats,
1967 free_address (&n->alternative_address);
1968 n->state = S_CONNECTED;
1971 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1972 /* waiting on CONNECT_ACK, don't care about blacklist */
1973 if ( (GNUNET_OK == result) &&
1974 (1 == n->send_connect_ack) )
1976 n->send_connect_ack = 2;
1977 send_session_connect_ack_message (n->primary_address.address,
1978 n->primary_address.session,
1979 n->connect_ack_timestamp);
1983 /* Nothing to do here, ATS will already do what can be done */
1985 case S_DISCONNECT_FINISHED:
1986 /* should not be possible */
1990 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
1992 free_neighbour (n, GNUNET_NO);
1996 GNUNET_HELLO_address_free (bcc->na.address);
1997 GNUNET_CONTAINER_DLL_remove (bc_head,
2005 * We want to know if connecting to a particular peer via
2006 * a particular address is allowed. Check it!
2008 * @param peer identity of the peer to switch the address for
2009 * @param ts time at which the check was initiated
2010 * @param address address of the other peer, NULL if other peer
2012 * @param session session to use (or NULL)
2015 check_blacklist (const struct GNUNET_PeerIdentity *peer,
2016 struct GNUNET_TIME_Absolute ts,
2017 const struct GNUNET_HELLO_Address *address,
2018 struct Session *session)
2020 struct BlackListCheckContext *bcc;
2021 struct GST_BlacklistCheck *bc;
2023 bcc = GNUNET_malloc (sizeof (struct BlackListCheckContext));
2024 bcc->na.address = GNUNET_HELLO_address_copy (address);
2025 bcc->na.session = session;
2026 bcc->na.connect_timestamp = ts;
2027 GNUNET_CONTAINER_DLL_insert (bc_head,
2030 if (NULL != (bc = GST_blacklist_test_allowed (peer,
2031 address->transport_name,
2032 &handle_test_blacklist_cont, bcc)))
2034 /* if NULL == bc, 'cont' was already called and 'bcc' already free'd, so
2035 we must only store 'bc' if 'bc' is non-NULL... */
2040 * We received a 'SESSION_CONNECT' message from the other peer.
2041 * Consider switching to it.
2043 * @param message possibly a 'struct SessionConnectMessage' (check format)
2044 * @param peer identity of the peer to switch the address for
2045 * @param address address of the other peer, NULL if other peer
2047 * @param session session to use (or NULL)
2050 GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
2051 const struct GNUNET_PeerIdentity *peer,
2052 const struct GNUNET_HELLO_Address *address,
2053 struct Session *session)
2055 const struct SessionConnectMessage *scm;
2056 struct NeighbourMapEntry *n;
2057 struct GNUNET_TIME_Absolute ts;
2059 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2060 "Received CONNECT message from peer `%s'\n",
2063 if (ntohs (message->size) != sizeof (struct SessionConnectMessage))
2065 GNUNET_break_op (0);
2068 if (NULL == neighbours)
2069 return; /* we're shutting down */
2070 scm = (const struct SessionConnectMessage *) message;
2071 GNUNET_break_op (0 == ntohl (scm->reserved));
2072 ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
2073 n = lookup_neighbour (peer);
2075 n = setup_neighbour (peer);
2076 n->send_connect_ack = 1;
2077 n->connect_ack_timestamp = ts;
2081 case S_NOT_CONNECTED:
2082 n->state = S_CONNECT_RECV_BLACKLIST_INBOUND;
2083 /* Do a blacklist check for the new address */
2084 check_blacklist (peer, ts, address, session);
2087 /* CONNECT message takes priority over us asking ATS for address */
2088 n->state = S_CONNECT_RECV_BLACKLIST_INBOUND;
2090 case S_INIT_BLACKLIST:
2091 case S_CONNECT_SENT:
2092 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2093 case S_CONNECT_RECV_ATS:
2094 case S_CONNECT_RECV_BLACKLIST:
2095 case S_CONNECT_RECV_ACK:
2096 /* It can never hurt to have an alternative address in the above cases,
2097 see if it is allowed */
2098 check_blacklist (peer, ts, address, session);
2101 /* we are already connected and can thus send the ACK immediately;
2102 still, it can never hurt to have an alternative address, so also
2103 tell ATS about it */
2104 GNUNET_assert (NULL != n->primary_address.address);
2105 GNUNET_assert (NULL != n->primary_address.session);
2106 n->send_connect_ack = 0;
2107 send_session_connect_ack_message (n->primary_address.address,
2108 n->primary_address.session, ts);
2109 check_blacklist (peer, ts, address, session);
2111 case S_RECONNECT_ATS:
2112 case S_RECONNECT_BLACKLIST:
2113 case S_RECONNECT_SENT:
2114 /* It can never hurt to have an alternative address in the above cases,
2115 see if it is allowed */
2116 check_blacklist (peer, ts, address, session);
2118 case S_CONNECTED_SWITCHING_BLACKLIST:
2119 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2120 /* we are already connected and can thus send the ACK immediately;
2121 still, it can never hurt to have an alternative address, so also
2122 tell ATS about it */
2123 GNUNET_assert (NULL != n->primary_address.address);
2124 GNUNET_assert (NULL != n->primary_address.session);
2125 n->send_connect_ack = 0;
2126 send_session_connect_ack_message (n->primary_address.address,
2127 n->primary_address.session, ts);
2128 check_blacklist (peer, ts, address, session);
2131 /* get rid of remains without terminating sessions, ready to re-try */
2132 free_neighbour (n, GNUNET_YES);
2133 n = setup_neighbour (peer);
2134 n->state = S_CONNECT_RECV_ATS;
2135 GNUNET_ATS_reset_backoff (GST_ats, peer);
2136 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, peer);
2138 case S_DISCONNECT_FINISHED:
2139 /* should not be possible */
2143 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
2145 free_neighbour (n, GNUNET_NO);
2152 * For an existing neighbour record, set the active connection to
2153 * use the given address.
2155 * @param peer identity of the peer to switch the address for
2156 * @param address address of the other peer, NULL if other peer
2158 * @param session session to use (or NULL)
2159 * @param ats performance data
2160 * @param ats_count number of entries in ats
2161 * @param bandwidth_in inbound quota to be used when connection is up,
2162 * 0 to disconnect from peer
2163 * @param bandwidth_out outbound quota to be used when connection is up,
2164 * 0 to disconnect from peer
2167 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
2168 const struct GNUNET_HELLO_Address *address,
2169 struct Session *session,
2170 const struct GNUNET_ATS_Information *ats,
2172 struct GNUNET_BANDWIDTH_Value32NBO
2174 struct GNUNET_BANDWIDTH_Value32NBO
2177 struct NeighbourMapEntry *n;
2178 struct GNUNET_TRANSPORT_PluginFunctions *papi;
2180 GNUNET_assert (address->transport_name != NULL);
2181 if (NULL == (n = lookup_neighbour (peer)))
2184 /* Obtain an session for this address from plugin */
2185 if (NULL == (papi = GST_plugins_find (address->transport_name)))
2187 /* we don't have the plugin for this address */
2188 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2191 if ((NULL == session) && (0 == address->address_length))
2194 if (strlen (address->transport_name) > 0)
2195 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2199 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2200 "ATS tells us to switch to address '%s' session %p for "
2201 "peer `%s' in state %s (quota in/out %u %u )\n",
2202 (address->address_length != 0) ? GST_plugins_a2s (address): "<inbound>",
2205 print_state (n->state),
2206 ntohl (bandwidth_in.value__),
2207 ntohl (bandwidth_out.value__));
2209 if (NULL == session)
2211 session = papi->get_session (papi->cls, address);
2212 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2213 "Obtained new session for peer `%s' and address '%s': %p\n",
2214 GNUNET_i2s (&address->peer), GST_plugins_a2s (address), session);
2216 if (NULL == session)
2218 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2219 "Failed to obtain new session for peer `%s' and address '%s'\n",
2220 GNUNET_i2s (&address->peer), GST_plugins_a2s (address));
2221 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2226 case S_NOT_CONNECTED:
2228 free_neighbour (n, GNUNET_NO);
2231 set_address (&n->primary_address,
2232 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2233 n->state = S_INIT_BLACKLIST;
2234 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2235 check_blacklist (&n->id,
2236 n->connect_ack_timestamp,
2239 case S_INIT_BLACKLIST:
2240 /* ATS suggests a different address, switch again */
2241 set_address (&n->primary_address,
2242 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2243 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2244 check_blacklist (&n->id,
2245 n->connect_ack_timestamp,
2248 case S_CONNECT_SENT:
2249 /* ATS suggests a different address, switch again */
2250 set_address (&n->primary_address,
2251 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2252 n->state = S_INIT_BLACKLIST;
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_RECV_ATS:
2259 set_address (&n->primary_address,
2260 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2261 n->state = S_CONNECT_RECV_BLACKLIST;
2262 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2263 check_blacklist (&n->id,
2264 n->connect_ack_timestamp,
2267 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2268 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2269 check_blacklist (&n->id,
2270 n->connect_ack_timestamp,
2273 case S_CONNECT_RECV_BLACKLIST:
2274 case S_CONNECT_RECV_ACK:
2275 /* ATS asks us to switch while we were trying to connect; switch to new
2276 address and check blacklist again */
2277 set_address (&n->primary_address,
2278 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2279 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2280 check_blacklist (&n->id,
2281 n->connect_ack_timestamp,
2285 GNUNET_assert (NULL != n->primary_address.address);
2286 GNUNET_assert (NULL != n->primary_address.session);
2287 if (n->primary_address.session == session)
2289 /* not an address change, just a quota change */
2290 set_address (&n->primary_address,
2291 address, session, bandwidth_in, bandwidth_out, GNUNET_YES);
2294 /* ATS asks us to switch a life connection; see if we can get
2295 a CONNECT_ACK on it before we actually do this! */
2296 set_address (&n->alternative_address,
2297 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2298 n->state = S_CONNECTED_SWITCHING_BLACKLIST;
2299 check_blacklist (&n->id,
2300 GNUNET_TIME_absolute_get (),
2303 case S_RECONNECT_ATS:
2304 set_address (&n->primary_address,
2305 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2306 n->state = S_RECONNECT_BLACKLIST;
2307 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2308 check_blacklist (&n->id,
2309 n->connect_ack_timestamp,
2312 case S_RECONNECT_BLACKLIST:
2313 /* ATS asks us to switch while we were trying to reconnect; switch to new
2314 address and check blacklist again */
2315 set_address (&n->primary_address,
2316 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
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_SENT:
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->state = S_RECONNECT_BLACKLIST;
2328 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2329 check_blacklist (&n->id,
2330 n->connect_ack_timestamp,
2333 case S_CONNECTED_SWITCHING_BLACKLIST:
2334 if (n->primary_address.session == session)
2336 /* ATS switches back to still-active session */
2337 free_address (&n->alternative_address);
2338 n->state = S_CONNECTED;
2341 /* ATS asks us to switch a life connection, update blacklist check */
2342 set_address (&n->alternative_address,
2343 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2344 check_blacklist (&n->id,
2345 GNUNET_TIME_absolute_get (),
2348 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2349 if (n->primary_address.session == session)
2351 /* ATS switches back to still-active session */
2352 free_address (&n->alternative_address);
2353 n->state = S_CONNECTED;
2356 /* ATS asks us to switch a life connection, update blacklist check */
2357 set_address (&n->alternative_address,
2358 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2359 n->state = S_CONNECTED_SWITCHING_BLACKLIST;
2360 check_blacklist (&n->id,
2361 GNUNET_TIME_absolute_get (),
2365 /* not going to switch addresses while disconnecting */
2367 case S_DISCONNECT_FINISHED:
2371 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
2378 send_utilization_data (void *cls,
2379 const struct GNUNET_PeerIdentity *key,
2382 struct NeighbourMapEntry *n = value;
2383 struct GNUNET_ATS_Information atsi[4];
2385 uint32_t bps_pl_out;
2388 struct GNUNET_TIME_Relative delta;
2390 delta = GNUNET_TIME_absolute_get_difference(n->last_util_transmission, GNUNET_TIME_absolute_get());
2393 if (0 != n->util_payload_bytes_recv)
2394 bps_pl_in = (1000LL * 1000LL * n->util_payload_bytes_recv) / (delta.rel_value_us);
2396 if (0 != n->util_payload_bytes_sent)
2397 bps_pl_out = (1000LL * 1000LL * n->util_payload_bytes_sent) / delta.rel_value_us;
2398 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' payload: received %u Bytes/s, sent %u Bytes/s \n",
2399 GNUNET_i2s (key), bps_pl_in, bps_pl_out);
2402 if (0 != n->util_total_bytes_recv)
2403 bps_in = (1000LL * 1000LL * n->util_total_bytes_recv) / (delta.rel_value_us);
2405 if (0 != n->util_total_bytes_sent)
2406 bps_out = (1000LL * 1000LL * n->util_total_bytes_sent) / delta.rel_value_us;
2409 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' total: received %u Bytes/s, sent %u Bytes/s \n",
2410 GNUNET_i2s (key), bps_in, bps_out);
2412 atsi[0].type = htonl (GNUNET_ATS_UTILIZATION_OUT);
2413 atsi[0].value = htonl (bps_out);
2414 atsi[1].type = htonl (GNUNET_ATS_UTILIZATION_IN);
2415 atsi[1].value = htonl (bps_in);
2417 atsi[2].type = htonl (GNUNET_ATS_UTILIZATION_PAYLOAD_OUT);
2418 atsi[2].value = htonl (bps_pl_out);
2419 atsi[3].type = htonl (GNUNET_ATS_UTILIZATION_PAYLOAD_IN);
2420 atsi[3].value = htonl (bps_pl_in);
2422 GST_ats_update_metrics (key, n->primary_address.address,
2423 n->primary_address.session, atsi, 4);
2424 n->util_payload_bytes_recv = 0;
2425 n->util_payload_bytes_sent = 0;
2426 n->util_total_bytes_recv = 0;
2427 n->util_total_bytes_sent = 0;
2428 n->last_util_transmission = GNUNET_TIME_absolute_get();
2433 * Task transmitting utilization in a regular interval
2435 * @param cls the 'struct NeighbourMapEntry' for which we are running
2436 * @param tc scheduler context (unused)
2439 utilization_transmission (void *cls,
2440 const struct GNUNET_SCHEDULER_TaskContext *tc)
2442 util_transmission_tk = GNUNET_SCHEDULER_NO_TASK;
2444 if (0 < GNUNET_CONTAINER_multipeermap_size (neighbours))
2445 GNUNET_CONTAINER_multipeermap_iterate (neighbours, send_utilization_data, NULL);
2447 util_transmission_tk = GNUNET_SCHEDULER_add_delayed (UTIL_TRANSMISSION_INTERVAL,
2448 utilization_transmission, NULL);
2453 GST_neighbours_notify_data_recv (const struct GNUNET_PeerIdentity *peer,
2454 const struct GNUNET_HELLO_Address *address,
2455 struct Session *session,
2456 const struct GNUNET_MessageHeader *message)
2458 struct NeighbourMapEntry *n;
2459 n = lookup_neighbour (peer);
2464 n->util_total_bytes_recv += ntohs(message->size);
2468 GST_neighbours_notify_payload_recv (const struct GNUNET_PeerIdentity *peer,
2469 const struct GNUNET_HELLO_Address *address,
2470 struct Session *session,
2471 const struct GNUNET_MessageHeader *message)
2473 struct NeighbourMapEntry *n;
2474 n = lookup_neighbour (peer);
2479 n->util_payload_bytes_recv += ntohs(message->size);
2484 GST_neighbours_notify_data_sent (const struct GNUNET_PeerIdentity *peer,
2487 struct NeighbourMapEntry *n;
2488 n = lookup_neighbour (peer);
2493 n->util_total_bytes_sent += size;
2497 GST_neighbours_notify_payload_sent (const struct GNUNET_PeerIdentity *peer,
2500 struct NeighbourMapEntry *n;
2501 n = lookup_neighbour (peer);
2506 n->util_payload_bytes_sent += size;
2511 * Master task run for every neighbour. Performs all of the time-related
2512 * activities (keep alive, send next message, disconnect if idle, finish
2513 * clean up after disconnect).
2515 * @param cls the 'struct NeighbourMapEntry' for which we are running
2516 * @param tc scheduler context (unused)
2519 master_task (void *cls,
2520 const struct GNUNET_SCHEDULER_TaskContext *tc)
2522 struct NeighbourMapEntry *n = cls;
2523 struct GNUNET_TIME_Relative delay;
2525 n->task = GNUNET_SCHEDULER_NO_TASK;
2526 delay = GNUNET_TIME_absolute_get_remaining (n->timeout);
2527 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2528 "Master task runs for neighbour `%s' in state %s with timeout in %s\n",
2529 GNUNET_i2s (&n->id),
2530 print_state(n->state),
2531 GNUNET_STRINGS_relative_time_to_string (delay,
2535 case S_NOT_CONNECTED:
2536 /* invalid state for master task, clean up */
2538 n->state = S_DISCONNECT_FINISHED;
2539 free_neighbour (n, GNUNET_NO);
2542 if (0 == delay.rel_value_us)
2544 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2545 "Connection to `%s' timed out waiting for ATS to provide address\n",
2546 GNUNET_i2s (&n->id));
2547 n->state = S_DISCONNECT_FINISHED;
2548 free_neighbour (n, GNUNET_NO);
2552 case S_INIT_BLACKLIST:
2553 if (0 == delay.rel_value_us)
2555 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2556 "Connection to `%s' timed out waiting for BLACKLIST to approve address\n",
2557 GNUNET_i2s (&n->id));
2558 n->state = S_DISCONNECT_FINISHED;
2559 free_neighbour (n, GNUNET_NO);
2563 case S_CONNECT_SENT:
2564 if (0 == delay.rel_value_us)
2566 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2567 "Connection to `%s' timed out waiting for other peer to send CONNECT_ACK\n",
2568 GNUNET_i2s (&n->id));
2569 disconnect_neighbour (n);
2573 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2574 if (0 == delay.rel_value_us)
2576 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2577 "Connection to `%s' timed out waiting BLACKLIST to approve address to use for received CONNECT\n",
2578 GNUNET_i2s (&n->id));
2579 n->state = S_DISCONNECT_FINISHED;
2580 free_neighbour (n, GNUNET_NO);
2584 case S_CONNECT_RECV_ATS:
2585 if (0 == delay.rel_value_us)
2587 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2588 "Connection to `%s' timed out waiting ATS to provide address to use for CONNECT_ACK\n",
2589 GNUNET_i2s (&n->id));
2590 n->state = S_DISCONNECT_FINISHED;
2591 free_neighbour (n, GNUNET_NO);
2595 case S_CONNECT_RECV_BLACKLIST:
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 CONNECT_ACK\n",
2600 GNUNET_i2s (&n->id));
2601 n->state = S_DISCONNECT_FINISHED;
2602 free_neighbour (n, GNUNET_NO);
2606 case S_CONNECT_RECV_ACK:
2607 if (0 == delay.rel_value_us)
2609 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2610 "Connection to `%s' timed out waiting for other peer to send SESSION_ACK\n",
2611 GNUNET_i2s (&n->id));
2612 disconnect_neighbour (n);
2617 if (0 == delay.rel_value_us)
2619 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2620 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs\n",
2621 GNUNET_i2s (&n->id));
2622 disconnect_neighbour (n);
2625 try_transmission_to_peer (n);
2628 case S_RECONNECT_ATS:
2629 if (0 == delay.rel_value_us)
2631 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2632 "Connection to `%s' timed out, waiting for ATS replacement address\n",
2633 GNUNET_i2s (&n->id));
2634 disconnect_neighbour (n);
2638 case S_RECONNECT_BLACKLIST:
2639 if (0 == delay.rel_value_us)
2641 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2642 "Connection to `%s' timed out, waiting for BLACKLIST to approve replacement address\n",
2643 GNUNET_i2s (&n->id));
2644 disconnect_neighbour (n);
2648 case S_RECONNECT_SENT:
2649 if (0 == delay.rel_value_us)
2651 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2652 "Connection to `%s' timed out, waiting for other peer to CONNECT_ACK replacement address\n",
2653 GNUNET_i2s (&n->id));
2654 disconnect_neighbour (n);
2658 case S_CONNECTED_SWITCHING_BLACKLIST:
2659 if (0 == delay.rel_value_us)
2661 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2662 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs\n",
2663 GNUNET_i2s (&n->id));
2664 disconnect_neighbour (n);
2667 try_transmission_to_peer (n);
2670 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2671 if (0 == delay.rel_value_us)
2673 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2674 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs (after trying to CONNECT on alternative address)\n",
2675 GNUNET_i2s (&n->id));
2676 disconnect_neighbour (n);
2679 try_transmission_to_peer (n);
2683 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2684 "Cleaning up connection to `%s' after sending DISCONNECT\n",
2685 GNUNET_i2s (&n->id));
2686 free_neighbour (n, GNUNET_NO);
2688 case S_DISCONNECT_FINISHED:
2689 /* how did we get here!? */
2693 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
2697 if ( (S_CONNECTED_SWITCHING_CONNECT_SENT == n->state) ||
2698 (S_CONNECTED_SWITCHING_BLACKLIST == n->state) ||
2699 (S_CONNECTED == n->state) )
2701 /* if we are *now* in one of these three states, we're sending
2702 keep alive messages, so we need to consider the keepalive
2703 delay, not just the connection timeout */
2704 delay = GNUNET_TIME_relative_min (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time),
2707 if (GNUNET_SCHEDULER_NO_TASK == n->task)
2708 n->task = GNUNET_SCHEDULER_add_delayed (delay,
2715 * Send a SESSION_ACK message to the neighbour to confirm that we
2716 * got his CONNECT_ACK.
2718 * @param n neighbour to send the SESSION_ACK to
2721 send_session_ack_message (struct NeighbourMapEntry *n)
2723 struct GNUNET_MessageHeader msg;
2725 msg.size = htons (sizeof (struct GNUNET_MessageHeader));
2726 msg.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK);
2727 (void) send_with_session(n,
2728 (const char *) &msg, sizeof (struct GNUNET_MessageHeader),
2729 UINT32_MAX, GNUNET_TIME_UNIT_FOREVER_REL,
2735 * We received a 'SESSION_CONNECT_ACK' message from the other peer.
2736 * Consider switching to it.
2738 * @param message possibly a 'struct SessionConnectMessage' (check format)
2739 * @param peer identity of the peer to switch the address for
2740 * @param address address of the other peer, NULL if other peer
2742 * @param session session to use (or NULL)
2745 GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
2746 const struct GNUNET_PeerIdentity *peer,
2747 const struct GNUNET_HELLO_Address *address,
2748 struct Session *session)
2750 const struct SessionConnectMessage *scm;
2751 struct GNUNET_TIME_Absolute ts;
2752 struct NeighbourMapEntry *n;
2754 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2755 "Received CONNECT_ACK message from peer `%s'\n",
2758 if (ntohs (message->size) != sizeof (struct SessionConnectMessage))
2760 GNUNET_break_op (0);
2763 scm = (const struct SessionConnectMessage *) message;
2764 GNUNET_break_op (ntohl (scm->reserved) == 0);
2765 if (NULL == (n = lookup_neighbour (peer)))
2767 GNUNET_STATISTICS_update (GST_stats,
2769 ("# unexpected CONNECT_ACK messages (no peer)"),
2773 ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
2776 case S_NOT_CONNECTED:
2778 free_neighbour (n, GNUNET_NO);
2781 case S_INIT_BLACKLIST:
2782 GNUNET_STATISTICS_update (GST_stats,
2784 ("# unexpected CONNECT_ACK messages (not ready)"),
2787 case S_CONNECT_SENT:
2788 if (ts.abs_value_us != n->primary_address.connect_timestamp.abs_value_us)
2789 break; /* ACK does not match our original CONNECT message */
2790 n->state = S_CONNECTED;
2791 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2792 GNUNET_STATISTICS_set (GST_stats,
2793 gettext_noop ("# peers connected"),
2794 ++neighbours_connected,
2796 connect_notify_cb (callback_cls, &n->id,
2797 n->primary_address.bandwidth_in,
2798 n->primary_address.bandwidth_out);
2799 /* Tell ATS that the outbound session we created to send CONNECT was successfull */
2800 GST_ats_add_address (n->primary_address.address, n->primary_address.session);
2801 set_address (&n->primary_address,
2802 n->primary_address.address,
2803 n->primary_address.session,
2804 n->primary_address.bandwidth_in,
2805 n->primary_address.bandwidth_out,
2807 send_session_ack_message (n);
2809 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2810 case S_CONNECT_RECV_ATS:
2811 case S_CONNECT_RECV_BLACKLIST:
2812 case S_CONNECT_RECV_ACK:
2813 GNUNET_STATISTICS_update (GST_stats,
2815 ("# unexpected CONNECT_ACK messages (not ready)"),
2819 /* duplicate CONNECT_ACK, let's answer by duplciate SESSION_ACK just in case */
2820 send_session_ack_message (n);
2822 case S_RECONNECT_ATS:
2823 case S_RECONNECT_BLACKLIST:
2824 /* we didn't expect any CONNECT_ACK, as we are waiting for ATS
2825 to give us a new address... */
2826 GNUNET_STATISTICS_update (GST_stats,
2828 ("# unexpected CONNECT_ACK messages (waiting on ATS)"),
2831 case S_RECONNECT_SENT:
2832 /* new address worked; go back to connected! */
2833 n->state = S_CONNECTED;
2834 send_session_ack_message (n);
2836 case S_CONNECTED_SWITCHING_BLACKLIST:
2837 /* duplicate CONNECT_ACK, let's answer by duplciate SESSION_ACK just in case */
2838 send_session_ack_message (n);
2840 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2841 /* new address worked; adopt it and go back to connected! */
2842 n->state = S_CONNECTED;
2843 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2844 GNUNET_break (GNUNET_NO == n->alternative_address.ats_active);
2846 GST_ats_add_address (n->alternative_address.address, n->alternative_address.session);
2847 set_address (&n->primary_address,
2848 n->alternative_address.address,
2849 n->alternative_address.session,
2850 n->alternative_address.bandwidth_in,
2851 n->alternative_address.bandwidth_out,
2853 free_address (&n->alternative_address);
2854 send_session_ack_message (n);
2857 GNUNET_STATISTICS_update (GST_stats,
2859 ("# unexpected CONNECT_ACK messages (disconnecting)"),
2862 case S_DISCONNECT_FINISHED:
2866 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
2874 * A session was terminated. Take note; if needed, try to get
2875 * an alternative address from ATS.
2877 * @param peer identity of the peer where the session died
2878 * @param session session that is gone
2879 * @return GNUNET_YES if this was a session used, GNUNET_NO if
2880 * this session was not in use
2883 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
2884 struct Session *session)
2886 struct NeighbourMapEntry *n;
2887 struct BlackListCheckContext *bcc;
2888 struct BlackListCheckContext *bcc_next;
2890 /* make sure to cancel all ongoing blacklist checks involving 'session' */
2892 while (NULL != (bcc = bcc_next))
2894 bcc_next = bcc->next;
2895 if (bcc->na.session == session)
2897 GST_blacklist_test_cancel (bcc->bc);
2898 GNUNET_HELLO_address_free (bcc->na.address);
2899 GNUNET_CONTAINER_DLL_remove (bc_head,
2905 if (NULL == (n = lookup_neighbour (peer)))
2906 return GNUNET_NO; /* can't affect us */
2907 if (session != n->primary_address.session)
2909 if (session == n->alternative_address.session)
2911 free_address (&n->alternative_address);
2912 if ( (S_CONNECTED_SWITCHING_BLACKLIST == n->state) ||
2913 (S_CONNECTED_SWITCHING_CONNECT_SENT == n->state) )
2914 n->state = S_CONNECTED;
2918 return GNUNET_NO; /* doesn't affect us further */
2921 n->expect_latency_response = GNUNET_NO;
2924 case S_NOT_CONNECTED:
2926 free_neighbour (n, GNUNET_NO);
2930 free_neighbour (n, GNUNET_NO);
2932 case S_INIT_BLACKLIST:
2933 case S_CONNECT_SENT:
2934 free_address (&n->primary_address);
2935 n->state = S_INIT_ATS;
2936 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2937 // FIXME: need to ask ATS for suggestions again?
2938 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
2940 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2941 case S_CONNECT_RECV_ATS:
2942 case S_CONNECT_RECV_BLACKLIST:
2943 case S_CONNECT_RECV_ACK:
2944 /* error on inbound session; free neighbour entirely */
2945 free_address (&n->primary_address);
2946 free_neighbour (n, GNUNET_NO);
2949 free_address (&n->primary_address);
2950 n->state = S_RECONNECT_ATS;
2951 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2952 /* FIXME: is this ATS call needed? */
2953 n->suggest_handle = GNUNET_ATS_suggest_address (GST_ats, &n->id);
2955 case S_RECONNECT_ATS:
2956 /* we don't have an address, how can it go down? */
2959 case S_RECONNECT_BLACKLIST:
2960 case S_RECONNECT_SENT:
2961 n->state = S_RECONNECT_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_CONNECTED_SWITCHING_BLACKLIST:
2967 /* primary went down while we were checking secondary against
2968 blacklist, adopt secondary as primary */
2969 free_address (&n->primary_address);
2970 n->primary_address = n->alternative_address;
2971 memset (&n->alternative_address, 0, sizeof (struct NeighbourAddress));
2972 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
2973 n->state = S_RECONNECT_BLACKLIST;
2975 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2976 /* primary went down while we were waiting for CONNECT_ACK on secondary;
2977 secondary as primary */
2978 free_address (&n->primary_address);
2979 n->primary_address = n->alternative_address;
2980 memset (&n->alternative_address, 0, sizeof (struct NeighbourAddress));
2981 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
2982 n->state = S_RECONNECT_SENT;
2985 free_address (&n->primary_address);
2987 case S_DISCONNECT_FINISHED:
2988 /* neighbour was freed and plugins told to terminate session */
2992 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
2996 if (GNUNET_SCHEDULER_NO_TASK != n->task)
2997 GNUNET_SCHEDULER_cancel (n->task);
2998 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
3004 * We received a 'SESSION_ACK' message from the other peer.
3005 * If we sent a 'CONNECT_ACK' last, this means we are now
3006 * connected. Otherwise, do nothing.
3008 * @param message possibly a 'struct SessionConnectMessage' (check format)
3009 * @param peer identity of the peer to switch the address for
3010 * @param address address of the other peer, NULL if other peer
3012 * @param session session to use (or NULL)
3015 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
3016 const struct GNUNET_PeerIdentity *peer,
3017 const struct GNUNET_HELLO_Address *address,
3018 struct Session *session)
3020 struct NeighbourMapEntry *n;
3022 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3023 "Received SESSION_ACK message from peer `%s'\n",
3025 if (ntohs (message->size) != sizeof (struct GNUNET_MessageHeader))
3027 GNUNET_break_op (0);
3030 if (NULL == (n = lookup_neighbour (peer)))
3032 /* check if we are in a plausible state for having sent
3033 a CONNECT_ACK. If not, return, otherwise break */
3034 if ( ( (S_CONNECT_RECV_ACK != n->state) &&
3035 (S_CONNECT_SENT != n->state) ) ||
3036 (2 != n->send_connect_ack) )
3038 GNUNET_STATISTICS_update (GST_stats,
3039 gettext_noop ("# unexpected SESSION ACK messages"), 1,
3043 n->state = S_CONNECTED;
3044 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
3045 GNUNET_STATISTICS_set (GST_stats,
3046 gettext_noop ("# peers connected"),
3047 ++neighbours_connected,
3049 connect_notify_cb (callback_cls, &n->id,
3050 n->primary_address.bandwidth_in,
3051 n->primary_address.bandwidth_out);
3053 GST_ats_add_address (n->primary_address.address, n->primary_address.session);
3054 set_address (&n->primary_address,
3055 n->primary_address.address,
3056 n->primary_address.session,
3057 n->primary_address.bandwidth_in,
3058 n->primary_address.bandwidth_out,
3064 * Test if we're connected to the given peer.
3066 * @param target peer to test
3067 * @return GNUNET_YES if we are connected, GNUNET_NO if not
3070 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target)
3072 return test_connected (lookup_neighbour (target));
3077 * Change the incoming quota for the given peer.
3079 * @param neighbour identity of peer to change qutoa for
3080 * @param quota new quota
3083 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
3084 struct GNUNET_BANDWIDTH_Value32NBO quota)
3086 struct NeighbourMapEntry *n;
3088 if (NULL == (n = lookup_neighbour (neighbour)))
3090 GNUNET_STATISTICS_update (GST_stats,
3092 ("# SET QUOTA messages ignored (no such peer)"),
3096 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3097 "Setting inbound quota of %u Bps for peer `%s' to all clients\n",
3098 ntohl (quota.value__), GNUNET_i2s (&n->id));
3099 GNUNET_BANDWIDTH_tracker_update_quota (&n->in_tracker, quota);
3100 if (0 != ntohl (quota.value__))
3102 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting peer `%4s' due to `%s'\n",
3103 GNUNET_i2s (&n->id), "SET_QUOTA");
3104 if (GNUNET_YES == test_connected (n))
3105 GNUNET_STATISTICS_update (GST_stats,
3106 gettext_noop ("# disconnects due to quota of 0"),
3108 disconnect_neighbour (n);
3113 * We received a disconnect message from the given peer,
3114 * validate and process.
3116 * @param peer sender of the message
3117 * @param msg the disconnect message
3120 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
3122 const struct GNUNET_MessageHeader
3125 struct NeighbourMapEntry *n;
3126 const struct SessionDisconnectMessage *sdm;
3127 struct GNUNET_HashCode hc;
3129 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3130 "Received DISCONNECT message from peer `%s'\n",
3132 if (ntohs (msg->size) != sizeof (struct SessionDisconnectMessage))
3134 // GNUNET_break_op (0);
3135 GNUNET_STATISTICS_update (GST_stats,
3137 ("# disconnect messages ignored (old format)"), 1,
3141 sdm = (const struct SessionDisconnectMessage *) msg;
3142 if (NULL == (n = lookup_neighbour (peer)))
3143 return; /* gone already */
3144 if (GNUNET_TIME_absolute_ntoh (sdm->timestamp).abs_value_us <= n->connect_ack_timestamp.abs_value_us)
3146 GNUNET_STATISTICS_update (GST_stats,
3148 ("# disconnect messages ignored (timestamp)"), 1,
3152 GNUNET_CRYPTO_hash (&sdm->public_key,
3153 sizeof (struct GNUNET_CRYPTO_EddsaPublicKey),
3155 if (0 != memcmp (peer, &hc, sizeof (struct GNUNET_PeerIdentity)))
3157 GNUNET_break_op (0);
3160 if (ntohl (sdm->purpose.size) !=
3161 sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
3162 sizeof (struct GNUNET_CRYPTO_EddsaPublicKey) +
3163 sizeof (struct GNUNET_TIME_AbsoluteNBO))
3165 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
3166 "%s message from peer `%s' has invalid size \n",
3169 GNUNET_break_op (0);
3173 GNUNET_CRYPTO_eddsa_verify
3174 (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT, &sdm->purpose,
3175 &sdm->signature, &sdm->public_key))
3177 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
3178 "%s message from peer `%s' cannot be verified \n",
3181 GNUNET_break_op (0);
3184 if (GNUNET_YES == test_connected (n))
3185 GNUNET_STATISTICS_update (GST_stats,
3187 ("# other peer asked to disconnect from us"), 1,
3189 disconnect_neighbour (n);
3194 * Closure for the neighbours_iterate function.
3196 struct IteratorContext
3199 * Function to call on each connected neighbour.
3201 GST_NeighbourIterator cb;
3211 * Call the callback from the closure for each connected neighbour.
3213 * @param cls the 'struct IteratorContext'
3214 * @param key the hash of the public key of the neighbour
3215 * @param value the 'struct NeighbourMapEntry'
3216 * @return GNUNET_OK (continue to iterate)
3219 neighbours_iterate (void *cls, const struct GNUNET_PeerIdentity * key, void *value)
3221 struct IteratorContext *ic = cls;
3222 struct NeighbourMapEntry *n = value;
3224 if (GNUNET_YES == test_connected (n))
3226 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
3227 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
3229 if (NULL != n->primary_address.address)
3231 bandwidth_in = n->primary_address.bandwidth_in;
3232 bandwidth_out = n->primary_address.bandwidth_out;
3236 bandwidth_in = GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT;
3237 bandwidth_out = GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT;
3240 ic->cb (ic->cb_cls, &n->id,
3241 n->primary_address.address,
3242 bandwidth_in, bandwidth_out);
3249 * Iterate over all connected neighbours.
3251 * @param cb function to call
3252 * @param cb_cls closure for cb
3255 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls)
3257 struct IteratorContext ic;
3259 if (NULL == neighbours)
3260 return; /* can happen during shutdown */
3263 GNUNET_CONTAINER_multipeermap_iterate (neighbours, &neighbours_iterate, &ic);
3268 * If we have an active connection to the given target, it must be shutdown.
3270 * @param target peer to disconnect from
3273 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target)
3275 struct NeighbourMapEntry *n;
3277 if (NULL == (n = lookup_neighbour (target)))
3278 return; /* not active */
3279 if (GNUNET_YES == test_connected (n))
3280 GNUNET_STATISTICS_update (GST_stats,
3282 ("# disconnected from peer upon explicit request"), 1,
3284 disconnect_neighbour (n);
3289 * Obtain current latency information for the given neighbour.
3291 * @param peer to get the latency for
3292 * @return observed latency of the address, FOREVER if the
3293 * the connection is not up
3295 struct GNUNET_TIME_Relative
3296 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer)
3298 struct NeighbourMapEntry *n;
3300 n = lookup_neighbour (peer);
3302 return GNUNET_TIME_UNIT_FOREVER_REL;
3306 case S_CONNECTED_SWITCHING_CONNECT_SENT:
3307 case S_CONNECTED_SWITCHING_BLACKLIST:
3308 case S_RECONNECT_SENT:
3309 case S_RECONNECT_ATS:
3310 case S_RECONNECT_BLACKLIST:
3312 case S_NOT_CONNECTED:
3313 case S_INIT_BLACKLIST:
3315 case S_CONNECT_RECV_BLACKLIST_INBOUND:
3316 case S_CONNECT_RECV_ATS:
3317 case S_CONNECT_RECV_BLACKLIST:
3318 case S_CONNECT_RECV_ACK:
3319 case S_CONNECT_SENT:
3321 case S_DISCONNECT_FINISHED:
3322 return GNUNET_TIME_UNIT_FOREVER_REL;
3324 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
3328 return GNUNET_TIME_UNIT_FOREVER_REL;
3333 * Obtain current address information for the given neighbour.
3336 * @return address currently used
3338 struct GNUNET_HELLO_Address *
3339 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer)
3341 struct NeighbourMapEntry *n;
3343 n = lookup_neighbour (peer);
3346 return n->primary_address.address;
3351 * Initialize the neighbours subsystem.
3353 * @param cls closure for callbacks
3354 * @param connect_cb function to call if we connect to a peer
3355 * @param disconnect_cb function to call if we disconnect from a peer
3356 * @param peer_address_cb function to call if we change an active address
3358 * @param max_fds maximum number of fds to use
3361 GST_neighbours_start (void *cls,
3362 NotifyConnect connect_cb,
3363 GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
3364 GNUNET_TRANSPORT_PeerIterateCallback peer_address_cb,
3365 unsigned int max_fds)
3368 connect_notify_cb = connect_cb;
3369 disconnect_notify_cb = disconnect_cb;
3370 address_change_cb = peer_address_cb;
3371 neighbours = GNUNET_CONTAINER_multipeermap_create (NEIGHBOUR_TABLE_SIZE, GNUNET_NO);
3372 util_transmission_tk = GNUNET_SCHEDULER_add_delayed (UTIL_TRANSMISSION_INTERVAL,
3373 utilization_transmission, NULL);
3378 * Disconnect from the given neighbour.
3381 * @param key hash of neighbour's public key (not used)
3382 * @param value the 'struct NeighbourMapEntry' of the neighbour
3383 * @return GNUNET_OK (continue to iterate)
3386 disconnect_all_neighbours (void *cls,
3387 const struct GNUNET_PeerIdentity *key,
3390 struct NeighbourMapEntry *n = value;
3392 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3393 "Disconnecting peer `%4s', %s\n",
3394 GNUNET_i2s (&n->id), "SHUTDOWN_TASK");
3395 n->state = S_DISCONNECT_FINISHED;
3396 free_neighbour (n, GNUNET_NO);
3402 * Cleanup the neighbours subsystem.
3405 GST_neighbours_stop ()
3407 if (NULL == neighbours)
3409 if (GNUNET_SCHEDULER_NO_TASK != util_transmission_tk)
3411 GNUNET_SCHEDULER_cancel (util_transmission_tk);
3412 util_transmission_tk = GNUNET_SCHEDULER_NO_TASK;
3415 GNUNET_CONTAINER_multipeermap_iterate (neighbours,
3416 &disconnect_all_neighbours,
3418 GNUNET_CONTAINER_multipeermap_destroy (neighbours);
3420 callback_cls = NULL;
3421 connect_notify_cb = NULL;
3422 disconnect_notify_cb = NULL;
3423 address_change_cb = NULL;
3427 /* end of file gnunet-service-transport_neighbours.c */