2 This file is part of GNUnet.
3 (C) 2010,2011,2012 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"
44 * Size of the neighbour hash map.
46 #define NEIGHBOUR_TABLE_SIZE 256
49 * Time we give plugin to transmit DISCONNECT message before the
50 * neighbour entry self-destructs.
52 #define DISCONNECT_SENT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 100)
55 * How often must a peer violate bandwidth quotas before we start
56 * to simply drop its messages?
58 #define QUOTA_VIOLATION_DROP_THRESHOLD 10
61 * How often do we send KEEPALIVE messages to each of our neighbours and measure
62 * the latency with this neighbour?
63 * (idle timeout is 5 minutes or 300 seconds, so with 30s interval we
64 * send 10 keepalives in each interval, so 10 messages would need to be
65 * lost in a row for a disconnect).
67 #define KEEPALIVE_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 30)
70 * How long are we willing to wait for a response from ATS before timing out?
72 #define ATS_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 500)
75 * How long are we willing to wait for an ACK from the other peer before
76 * giving up on our connect operation?
78 #define SETUP_CONNECTION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
81 * How long are we willing to wait for a successful reconnect if
82 * an existing connection went down? Much shorter than the
83 * usual SETUP_CONNECTION_TIMEOUT as we do not inform the
84 * higher layers about the disconnect during this period.
86 #define FAST_RECONNECT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 1)
89 * How long are we willing to wait for a response from the blacklist
90 * subsystem before timing out?
92 #define BLACKLIST_RESPONSE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS, 500)
95 GNUNET_NETWORK_STRUCT_BEGIN
98 * Message a peer sends to another to indicate that it intends to
99 * setup a connection/session for data exchange. A 'SESSION_CONNECT'
100 * should be answered with a 'SESSION_CONNECT_ACK' with the same body
101 * to confirm. A 'SESSION_CONNECT_ACK' should then be followed with
102 * a 'SESSION_ACK'. Once the 'SESSION_ACK' is received, both peers
103 * should be connected.
105 struct SessionConnectMessage
108 * Header of type 'GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT'
109 * or 'GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK'
111 struct GNUNET_MessageHeader header;
116 uint32_t reserved GNUNET_PACKED;
119 * Absolute time at the sender. Only the most recent connect
120 * message implies which session is preferred by the sender.
122 struct GNUNET_TIME_AbsoluteNBO timestamp;
128 * Message we send to the other peer to notify him that we intentionally
129 * are disconnecting (to reduce timeouts). This is just a friendly
130 * notification, peers must not rely on always receiving disconnect
133 struct SessionDisconnectMessage
136 * Header of type 'GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT'
138 struct GNUNET_MessageHeader header;
143 uint32_t reserved GNUNET_PACKED;
146 * Purpose of the signature. Extends over the timestamp.
147 * Purpose should be GNUNET_SIGNATURE_PURPOSE_TRANSPORT_DISCONNECT.
149 struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
152 * Absolute time at the sender. Only the most recent connect
153 * message implies which session is preferred by the sender.
155 struct GNUNET_TIME_AbsoluteNBO timestamp;
158 * Public key of the sender.
160 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
163 * Signature of the peer that sends us the disconnect. Only
164 * valid if the timestamp is AFTER the timestamp from the
165 * corresponding 'CONNECT' message.
167 struct GNUNET_CRYPTO_RsaSignature signature;
171 GNUNET_NETWORK_STRUCT_END
175 * For each neighbour we keep a list of messages
176 * that we still want to transmit to the neighbour.
182 * This is a doubly linked list.
184 struct MessageQueue *next;
187 * This is a doubly linked list.
189 struct MessageQueue *prev;
192 * Function to call once we're done.
194 GST_NeighbourSendContinuation cont;
202 * The message(s) we want to transmit, GNUNET_MessageHeader(s)
203 * stuck together in memory. Allocated at the end of this struct.
205 const char *message_buf;
208 * Size of the message buf
210 size_t message_buf_size;
213 * At what time should we fail?
215 struct GNUNET_TIME_Absolute timeout;
221 * Possible state of a neighbour. Initially, we are S_NOT_CONNECTED.
223 * Then, there are two main paths. If we receive a CONNECT message, we
224 * first run a check against the blacklist and ask ATS for a
225 * suggestion. (S_CONNECT_RECV_ATS). If the blacklist comes back
226 * positive, we give the address to ATS. If ATS makes a suggestion,
227 * we ALSO give that suggestion to the blacklist
228 * (S_CONNECT_RECV_BLACKLIST). Once the blacklist approves the
229 * address we got from ATS, we send our CONNECT_ACK and go to
230 * S_CONNECT_RECV_ACK. If we receive a SESSION_ACK, we go to
231 * S_CONNECTED (and notify everyone about the new connection). If the
232 * operation times out, we go to S_DISCONNECT.
234 * The other case is where we transmit a CONNECT message first. We
235 * start with S_INIT_ATS. If we get an address, we enter
236 * S_INIT_BLACKLIST and check the blacklist. If the blacklist is OK
237 * with the connection, we actually send the CONNECT message and go to
238 * state S_CONNECT_SENT. Once we receive a CONNECT_ACK, we go to
239 * S_CONNECTED (and notify everyone about the new connection and send
240 * back a SESSION_ACK). If the operation times out, we go to
243 * If the session is in trouble (i.e. transport-level disconnect or
244 * timeout), we go to S_RECONNECT_ATS where we ask ATS for a new
245 * address (we don't notify anyone about the disconnect yet). Once we
246 * have a new address, we go to S_RECONNECT_BLACKLIST to check the new
247 * address against the blacklist. If the blacklist approves, we enter
248 * S_RECONNECT_SENT and send a CONNECT message. If we receive a
249 * CONNECT_ACK, we go to S_CONNECTED and nobody noticed that we had
250 * trouble; we also send a SESSION_ACK at this time just in case. If
251 * the operation times out, we go to S_DISCONNECT (and notify everyone
252 * about the lost connection).
254 * If ATS decides to switch addresses while we have a normal
255 * connection, we go to S_CONNECTED_SWITCHING_BLACKLIST to check the
256 * new address against the blacklist. If the blacklist approves, we
257 * go to S_CONNECTED_SWITCHING_CONNECT_SENT and send a
258 * SESSION_CONNECT. If we get a SESSION_ACK back, we switch the
259 * primary connection to the suggested alternative from ATS, go back
260 * to S_CONNECTED and send a SESSION_ACK to the other peer just to be
261 * sure. If the operation times out (or the blacklist disapproves),
262 * we go to S_CONNECTED (and notify ATS that the given alternative
263 * address is "invalid").
265 * Once a session is in S_DISCONNECT, it is cleaned up and then goes
266 * to (S_DISCONNECT_FINISHED). If we receive an explicit disconnect
267 * request, we can go from any state to S_DISCONNECT, possibly after
268 * generating disconnect notifications.
270 * Note that it is quite possible that while we are in any of these
271 * states, we could receive a 'CONNECT' request from the other peer.
272 * We then enter a 'weird' state where we pursue our own primary state
273 * machine (as described above), but with the 'send_connect_ack' flag
274 * set to 1. If our state machine allows us to send a 'CONNECT_ACK'
275 * (because we have an acceptable address), we send the 'CONNECT_ACK'
276 * and set the 'send_connect_ack' to 2. If we then receive a
277 * 'SESSION_ACK', we go to 'S_CONNECTED' (and reset 'send_connect_ack'
284 * fresh peer or completely disconnected
289 * Asked to initiate connection, trying to get address from ATS
294 * Asked to initiate connection, trying to get address approved
300 * Sent CONNECT message to other peer, waiting for CONNECT_ACK
305 * Received a CONNECT, asking ATS about address suggestions.
310 * Received CONNECT from other peer, got an address, checking with blacklist.
312 S_CONNECT_RECV_BLACKLIST,
315 * CONNECT request from other peer was SESSION_ACK'ed, waiting for
321 * Got our CONNECT_ACK/SESSION_ACK, connection is up.
326 * Connection got into trouble, rest of the system still believes
327 * it to be up, but we're getting a new address from ATS.
332 * Connection got into trouble, rest of the system still believes
333 * it to be up; we are checking the new address against the blacklist.
335 S_RECONNECT_BLACKLIST,
338 * Sent CONNECT over new address (either by ATS telling us to switch
339 * addresses or from RECONNECT_ATS); if this fails, we need to tell
340 * the rest of the system about a disconnect.
345 * We have some primary connection, but ATS suggested we switch
346 * to some alternative; we're now checking the alternative against
349 S_CONNECTED_SWITCHING_BLACKLIST,
352 * We have some primary connection, but ATS suggested we switch
353 * to some alternative; we now sent a CONNECT message for the
354 * alternative session to the other peer and waiting for a
355 * CONNECT_ACK to make this our primary connection.
357 S_CONNECTED_SWITCHING_CONNECT_SENT,
360 * Disconnect in progress (we're sending the DISCONNECT message to the
361 * other peer; after that is finished, the state will be cleaned up).
366 * We're finished with the disconnect; clean up state now!
368 S_DISCONNECT_FINISHED
373 * A possible address we could use to communicate with a neighbour.
375 struct NeighbourAddress
379 * Active session for this address.
381 struct Session *session;
384 * Network-level address information.
386 struct GNUNET_HELLO_Address *address;
389 * Timestamp of the 'SESSION_CONNECT' message we sent to the other
390 * peer for this address. Use to check that the ACK is in response
391 * to our most recent 'CONNECT'.
393 struct GNUNET_TIME_Absolute connect_timestamp;
396 * Inbound bandwidth from ATS for this address.
398 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
401 * Outbound bandwidth from ATS for this address.
403 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
406 * Did we tell ATS that this is our 'active' address?
414 * Entry in neighbours.
416 struct NeighbourMapEntry
420 * Head of list of messages we would like to send to this peer;
421 * must contain at most one message per client.
423 struct MessageQueue *messages_head;
426 * Tail of list of messages we would like to send to this peer; must
427 * contain at most one message per client.
429 struct MessageQueue *messages_tail;
432 * Are we currently trying to send a message? If so, which one?
434 struct MessageQueue *is_active;
437 * Primary address we currently use to communicate with the neighbour.
439 struct NeighbourAddress primary_address;
442 * Alternative address currently under consideration for communicating
443 * with the neighbour.
445 struct NeighbourAddress alternative_address;
448 * Identity of this neighbour.
450 struct GNUNET_PeerIdentity id;
453 * Main task that drives this peer (timeouts, keepalives, etc.).
454 * Always runs the 'master_task'.
456 GNUNET_SCHEDULER_TaskIdentifier task;
459 * At what time should we sent the next keep-alive message?
461 struct GNUNET_TIME_Absolute keep_alive_time;
464 * At what time did we sent the last keep-alive message? Used
465 * to calculate round-trip time ("latency").
467 struct GNUNET_TIME_Absolute last_keep_alive_time;
470 * Timestamp we should include in our next CONNECT_ACK message.
471 * (only valid if 'send_connect_ack' is GNUNET_YES). Used to build
472 * our CONNECT_ACK message.
474 struct GNUNET_TIME_Absolute connect_ack_timestamp;
477 * Time where we should cut the connection (timeout) if we don't
478 * make progress in the state machine (or get a KEEPALIVE_RESPONSE
479 * if we are in S_CONNECTED).
481 struct GNUNET_TIME_Absolute timeout;
484 * Latest calculated latency value
486 struct GNUNET_TIME_Relative latency;
489 * Tracker for inbound bandwidth.
491 struct GNUNET_BANDWIDTH_Tracker in_tracker;
494 * How often has the other peer (recently) violated the inbound
495 * traffic limit? Incremented by 10 per violation, decremented by 1
496 * per non-violation (for each time interval).
498 unsigned int quota_violation_count;
501 * The current state of the peer.
506 * Did we sent an KEEP_ALIVE message and are we expecting a response?
508 int expect_latency_response;
511 * Flag to set if we still need to send a CONNECT_ACK message to the other peer
512 * (once we have an address to use and the peer has been allowed by our
513 * blacklist). Set to 1 if we need to send a CONNECT_ACK. Set to 2 if we
514 * did send a CONNECT_ACK and should go to 'S_CONNECTED' upon receiving
515 * a 'SESSION_ACK' (regardless of what our own state machine might say).
517 int send_connect_ack;
523 * Context for blacklist checks and the 'handle_test_blacklist_cont'
524 * function. Stores information about ongoing blacklist checks.
526 struct BlackListCheckContext
530 * We keep blacklist checks in a DLL.
532 struct BlackListCheckContext *next;
535 * We keep blacklist checks in a DLL.
537 struct BlackListCheckContext *prev;
540 * Address that is being checked.
542 struct NeighbourAddress na;
545 * ATS information about the address.
547 struct GNUNET_ATS_Information *ats;
550 * Handle to the ongoing blacklist check.
552 struct GST_BlacklistCheck *bc;
555 * Size of the 'ats' array.
563 * Hash map from peer identities to the respective 'struct NeighbourMapEntry'.
565 static struct GNUNET_CONTAINER_MultiHashMap *neighbours;
568 * We keep blacklist checks in a DLL so that we can find
569 * the 'sessions' in their 'struct NeighbourAddress' if
570 * a session goes down.
572 static struct BlackListCheckContext *bc_head;
575 * We keep blacklist checks in a DLL.
577 static struct BlackListCheckContext *bc_tail;
580 * Closure for connect_notify_cb, disconnect_notify_cb and address_change_cb
582 static void *callback_cls;
585 * Function to call when we connected to a neighbour.
587 static GNUNET_TRANSPORT_NotifyConnect connect_notify_cb;
590 * Function to call when we disconnected from a neighbour.
592 static GNUNET_TRANSPORT_NotifyDisconnect disconnect_notify_cb;
595 * Function to call when we changed an active address of a neighbour.
597 static GNUNET_TRANSPORT_PeerIterateCallback address_change_cb;
600 * counter for connected neighbours
602 static unsigned int neighbours_connected;
605 * Number of bytes we have currently queued for transmission.
607 static unsigned long long bytes_in_send_queue;
611 * Lookup a neighbour entry in the neighbours hash map.
613 * @param pid identity of the peer to look up
614 * @return the entry, NULL if there is no existing record
616 static struct NeighbourMapEntry *
617 lookup_neighbour (const struct GNUNET_PeerIdentity *pid)
619 if (NULL == neighbours)
621 return GNUNET_CONTAINER_multihashmap_get (neighbours, &pid->hashPubKey);
626 * Test if we're connected to the given peer.
628 * @param n neighbour entry of peer to test
629 * @return GNUNET_YES if we are connected, GNUNET_NO if not
632 test_connected (struct NeighbourMapEntry *n)
638 case S_NOT_CONNECTED:
640 case S_INIT_BLACKLIST:
642 case S_CONNECT_RECV_ATS:
643 case S_CONNECT_RECV_BLACKLIST:
644 case S_CONNECT_RECV_ACK:
647 case S_RECONNECT_ATS:
648 case S_RECONNECT_BLACKLIST:
649 case S_RECONNECT_SENT:
650 case S_CONNECTED_SWITCHING_BLACKLIST:
651 case S_CONNECTED_SWITCHING_CONNECT_SENT:
654 case S_DISCONNECT_FINISHED:
660 return GNUNET_SYSERR;
665 * Send information about a new outbound quota to our clients.
667 * @param target affected peer
668 * @param quota new quota
671 send_outbound_quota (const struct GNUNET_PeerIdentity *target,
672 struct GNUNET_BANDWIDTH_Value32NBO quota)
674 struct QuotaSetMessage q_msg;
676 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
677 "Sending outbound quota of %u Bps for peer `%s' to all clients\n",
678 ntohl (quota.value__), GNUNET_i2s (target));
679 q_msg.header.size = htons (sizeof (struct QuotaSetMessage));
680 q_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
682 q_msg.peer = (*target);
683 GST_clients_broadcast (&q_msg.header, GNUNET_NO);
688 * We don't need a given neighbour address any more.
689 * Release its resources and give appropriate notifications
690 * to ATS and other subsystems.
692 * @param na address we are done with; 'na' itself must NOT be 'free'd, only the contents!
695 free_address (struct NeighbourAddress *na)
697 if (GNUNET_YES == na->ats_active)
699 GST_validation_set_address_use (na->address, na->session, GNUNET_NO, __LINE__);
700 GNUNET_ATS_address_in_use (GST_ats, na->address, na->session, GNUNET_NO);
702 na->ats_active = GNUNET_NO;
703 if (NULL != na->address)
705 GNUNET_HELLO_address_free (na->address);
713 * Initialize the 'struct NeighbourAddress'.
715 * @param na neighbour address to initialize
716 * @param address address of the other peer, NULL if other peer
718 * @param session session to use (or NULL, in which case an
719 * address must be setup)
720 * @param bandwidth_in inbound quota to be used when connection is up
721 * @param bandwidth_out outbound quota to be used when connection is up
722 * @param is_active GNUNET_YES to mark this as the active address with ATS
725 set_address (struct NeighbourAddress *na,
726 const struct GNUNET_HELLO_Address *address,
727 struct Session *session,
728 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
729 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
732 struct GNUNET_TRANSPORT_PluginFunctions *papi;
734 if (NULL == (papi = GST_plugins_find (address->transport_name)))
739 if (session == na->session)
741 na->bandwidth_in = bandwidth_in;
742 na->bandwidth_out = bandwidth_out;
743 if (is_active != na->ats_active)
745 na->ats_active = is_active;
746 GNUNET_ATS_address_in_use (GST_ats, na->address, na->session, is_active);
747 GST_validation_set_address_use (na->address, na->session, is_active, __LINE__);
749 if (GNUNET_YES == is_active)
751 /* FIXME: is this the right place to set quotas? */
752 GST_neighbours_set_incoming_quota (&address->peer, bandwidth_in);
753 send_outbound_quota (&address->peer, bandwidth_out);
759 session = papi->get_session (papi->cls, address);
762 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
763 "Failed to obtain new session for peer `%s' and address '%s'\n",
764 GNUNET_i2s (&address->peer), GST_plugins_a2s (address));
765 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
768 na->address = GNUNET_HELLO_address_copy (address);
769 na->bandwidth_in = bandwidth_in;
770 na->bandwidth_out = bandwidth_out;
771 na->session = session;
772 na->ats_active = is_active;
773 if (GNUNET_YES == is_active)
775 /* Telling ATS about new session */
776 GNUNET_ATS_address_update (GST_ats, na->address, na->session, NULL, 0);
777 GNUNET_ATS_address_in_use (GST_ats, na->address, na->session, GNUNET_YES);
778 GST_validation_set_address_use (na->address, na->session, GNUNET_YES, __LINE__);
780 /* FIXME: is this the right place to set quotas? */
781 GST_neighbours_set_incoming_quota (&address->peer, bandwidth_in);
782 send_outbound_quota (&address->peer, bandwidth_out);
788 * Free a neighbour map entry.
790 * @param n entry to free
793 free_neighbour (struct NeighbourMapEntry *n)
795 struct MessageQueue *mq;
796 struct GNUNET_TRANSPORT_PluginFunctions *papi;
798 n->is_active = NULL; /* always free'd by its own continuation! */
800 /* fail messages currently in the queue */
801 while (NULL != (mq = n->messages_head))
803 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
804 if (NULL != mq->cont)
805 mq->cont (mq->cont_cls, GNUNET_SYSERR);
808 /* It is too late to send other peer disconnect notifications, but at
809 least internally we need to get clean... */
810 if (GNUNET_YES == test_connected (n))
812 GNUNET_STATISTICS_set (GST_stats,
813 gettext_noop ("# peers connected"),
814 --neighbours_connected,
816 disconnect_notify_cb (callback_cls, &n->id);
819 /* FIXME-PLUGIN-API: This does not seem to guarantee that all
820 transport sessions eventually get killed due to inactivity; they
821 MUST have their own timeout logic (but at least TCP doesn't have
822 one yet). Are we sure that EVERY 'session' of a plugin is
823 actually cleaned up this way!? Note that if we are switching
824 between two TCP sessions to the same peer, the existing plugin
825 API gives us not even the means to selectively kill only one of
826 them! Killing all sessions like this seems to be very, very
828 if ( (NULL != n->primary_address.address) &&
829 (NULL != (papi = GST_plugins_find (n->primary_address.address->transport_name))) )
830 papi->disconnect (papi->cls, &n->id);
832 n->state = S_DISCONNECT_FINISHED;
834 GNUNET_assert (GNUNET_YES ==
835 GNUNET_CONTAINER_multihashmap_remove (neighbours,
836 &n->id.hashPubKey, n));
838 /* cut transport-level connection */
839 free_address (&n->primary_address);
840 free_address (&n->alternative_address);
842 // FIXME-ATS-API: we might want to be more specific about
843 // which states we do this from in the future (ATS should
844 // have given us a 'suggest_address' handle, and if we have
845 // such a handle, we should cancel the operation here!
846 GNUNET_ATS_suggest_address_cancel (GST_ats, &n->id);
848 if (GNUNET_SCHEDULER_NO_TASK != n->task)
850 GNUNET_SCHEDULER_cancel (n->task);
851 n->task = GNUNET_SCHEDULER_NO_TASK;
853 /* free rest of memory */
859 * Transmit a message using the current session of the given
862 * @param n entry for the recipient
863 * @param msgbuf buffer to transmit
864 * @param msgbuf_size number of bytes in buffer
865 * @param priority transmission priority
866 * @param timeout transmission timeout
867 * @param cont continuation to call when finished (can be NULL)
868 * @param cont_cls closure for cont
871 send_with_session (struct NeighbourMapEntry *n,
872 const char *msgbuf, size_t msgbuf_size,
874 struct GNUNET_TIME_Relative timeout,
875 GNUNET_TRANSPORT_TransmitContinuation cont,
878 struct GNUNET_TRANSPORT_PluginFunctions *papi;
880 GNUNET_assert (n->primary_address.session != NULL);
881 if ( ( (NULL == (papi = GST_plugins_find (n->primary_address.address->transport_name))) ||
882 (-1 == papi->send (papi->cls,
883 n->primary_address.session,
889 cont (cont_cls, &n->id, GNUNET_SYSERR);
890 GNUNET_break (NULL != papi);
895 * Master task run for every neighbour. Performs all of the time-related
896 * activities (keep alive, send next message, disconnect if idle, finish
897 * clean up after disconnect).
899 * @param cls the 'struct NeighbourMapEntry' for which we are running
900 * @param tc scheduler context (unused)
903 master_task (void *cls,
904 const struct GNUNET_SCHEDULER_TaskContext *tc);
908 * Function called when the 'DISCONNECT' message has been sent by the
909 * plugin. Frees the neighbour --- if the entry still exists.
912 * @param target identity of the neighbour that was disconnected
913 * @param result GNUNET_OK if the disconnect got out successfully
916 send_disconnect_cont (void *cls, const struct GNUNET_PeerIdentity *target,
919 struct NeighbourMapEntry *n;
921 n = lookup_neighbour (target);
923 return; /* already gone */
924 if (S_DISCONNECT != n->state)
925 return; /* have created a fresh entry since */
926 n->state = S_DISCONNECT;
927 GNUNET_SCHEDULER_cancel (n->task);
928 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
933 * Transmit a DISCONNECT message to the other peer.
935 * @param n neighbour to send DISCONNECT message.
938 send_disconnect (struct NeighbourMapEntry *n)
940 struct SessionDisconnectMessage disconnect_msg;
942 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
943 "Sending DISCONNECT message to peer `%4s'\n",
944 GNUNET_i2s (&n->id));
945 disconnect_msg.header.size = htons (sizeof (struct SessionDisconnectMessage));
946 disconnect_msg.header.type =
947 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
948 disconnect_msg.reserved = htonl (0);
949 disconnect_msg.purpose.size =
950 htonl (sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) +
951 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
952 sizeof (struct GNUNET_TIME_AbsoluteNBO));
953 disconnect_msg.purpose.purpose =
954 htonl (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
955 disconnect_msg.timestamp =
956 GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get ());
957 disconnect_msg.public_key = GST_my_public_key;
958 GNUNET_assert (GNUNET_OK ==
959 GNUNET_CRYPTO_rsa_sign (GST_my_private_key,
960 &disconnect_msg.purpose,
961 &disconnect_msg.signature));
963 send_with_session (n,
964 (const char *) &disconnect_msg, sizeof (disconnect_msg),
965 UINT32_MAX, GNUNET_TIME_UNIT_FOREVER_REL,
966 &send_disconnect_cont, NULL);
967 GNUNET_STATISTICS_update (GST_stats,
969 ("# DISCONNECT messages sent"), 1,
975 * Disconnect from the given neighbour, clean up the record.
977 * @param n neighbour to disconnect from
980 disconnect_neighbour (struct NeighbourMapEntry *n)
982 /* depending on state, notify neighbour and/or upper layers of this peer
986 case S_NOT_CONNECTED:
988 case S_INIT_BLACKLIST:
989 /* other peer is completely unaware of us, no need to send DISCONNECT */
990 n->state = S_DISCONNECT_FINISHED;
995 n->state = S_DISCONNECT;
997 case S_CONNECT_RECV_ATS:
998 case S_CONNECT_RECV_BLACKLIST:
999 /* we never ACK'ed the other peer's request, no need to send DISCONNECT */
1000 n->state = S_DISCONNECT_FINISHED;
1003 case S_CONNECT_RECV_ACK:
1004 /* we DID ACK the other peer's request, must send DISCONNECT */
1005 send_disconnect (n);
1006 n->state = S_DISCONNECT;
1009 case S_RECONNECT_ATS:
1010 case S_RECONNECT_BLACKLIST:
1011 case S_RECONNECT_SENT:
1012 case S_CONNECTED_SWITCHING_BLACKLIST:
1013 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1014 /* we are currently connected, need to send disconnect and do
1015 internal notifications and update statistics */
1016 send_disconnect (n);
1017 GNUNET_STATISTICS_set (GST_stats,
1018 gettext_noop ("# peers connected"),
1019 --neighbours_connected,
1021 disconnect_notify_cb (callback_cls, &n->id);
1022 n->state = S_DISCONNECT;
1025 /* already disconnected, ignore */
1027 case S_DISCONNECT_FINISHED:
1028 /* already cleaned up, how did we get here!? */
1035 /* schedule timeout to clean up */
1036 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1037 GNUNET_SCHEDULER_cancel (n->task);
1038 n->task = GNUNET_SCHEDULER_add_delayed (DISCONNECT_SENT_TIMEOUT,
1044 * We're done with our transmission attempt, continue processing.
1046 * @param cls the 'struct MessageQueue' of the message
1047 * @param receiver intended receiver
1048 * @param success whether it worked or not
1051 transmit_send_continuation (void *cls,
1052 const struct GNUNET_PeerIdentity *receiver,
1055 struct MessageQueue *mq = cls;
1056 struct NeighbourMapEntry *n;
1058 n = lookup_neighbour (receiver);
1065 if (n->is_active == mq)
1067 /* this is still "our" neighbour, remove us from its queue
1068 and allow it to send the next message now */
1069 n->is_active = NULL;
1070 GNUNET_SCHEDULER_cancel (n->task);
1071 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1073 GNUNET_assert (bytes_in_send_queue >= mq->message_buf_size);
1074 bytes_in_send_queue -= mq->message_buf_size;
1075 GNUNET_STATISTICS_set (GST_stats,
1077 ("# bytes in message queue for other peers"),
1078 bytes_in_send_queue, GNUNET_NO);
1079 if (GNUNET_OK == success)
1080 GNUNET_STATISTICS_update (GST_stats,
1082 ("# messages transmitted to other peers"),
1085 GNUNET_STATISTICS_update (GST_stats,
1087 ("# transmission failures for messages to other peers"),
1089 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1090 "Sending message to `%s' of type %u was a %s\n",
1091 GNUNET_i2s (receiver),
1092 ntohs (((struct GNUNET_MessageHeader *) mq->message_buf)->type),
1093 (success == GNUNET_OK) ? "success" : "FAILURE");
1094 if (NULL != mq->cont)
1095 mq->cont (mq->cont_cls, success);
1101 * Check the message list for the given neighbour and if we can
1102 * send a message, do so. This function should only be called
1103 * if the connection is at least generally ready for transmission.
1104 * While we will only send one message at a time, no bandwidth
1105 * quota management is performed here. If a message was given to
1106 * the plugin, the continuation will automatically re-schedule
1107 * the 'master' task once the next message might be transmitted.
1109 * @param n target peer for which to transmit
1112 try_transmission_to_peer (struct NeighbourMapEntry *n)
1114 struct MessageQueue *mq;
1115 struct GNUNET_TIME_Relative timeout;
1117 if (NULL == n->primary_address.address)
1119 /* no address, why are we here? */
1123 if ((0 == n->primary_address.address->address_length) &&
1124 (NULL == n->primary_address.session))
1126 /* no address, why are we here? */
1130 if (NULL != n->is_active)
1132 /* transmission already pending */
1136 /* timeout messages from the queue that are past their due date */
1137 while (NULL != (mq = n->messages_head))
1139 timeout = GNUNET_TIME_absolute_get_remaining (mq->timeout);
1140 if (timeout.rel_value > 0)
1142 GNUNET_STATISTICS_update (GST_stats,
1144 ("# messages timed out while in transport queue"),
1146 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
1148 transmit_send_continuation (mq, &n->id, GNUNET_SYSERR); /* timeout */
1151 return; /* no more messages */
1152 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
1154 send_with_session (n,
1155 mq->message_buf, mq->message_buf_size,
1156 0 /* priority */, timeout,
1157 &transmit_send_continuation, mq);
1162 * Send keepalive message to the neighbour. Must only be called
1163 * if we are on 'connected' state. Will internally determine
1164 * if a keepalive is truly needed (so can always be called).
1166 * @param n neighbour that went idle and needs a keepalive
1169 send_keepalive (struct NeighbourMapEntry *n)
1171 struct GNUNET_MessageHeader m;
1173 GNUNET_assert (S_CONNECTED == n->state);
1174 if (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time).rel_value > 0)
1175 return; /* no keepalive needed at this time */
1176 m.size = htons (sizeof (struct GNUNET_MessageHeader));
1177 m.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE);
1178 send_with_session (n,
1179 (const void *) &m, sizeof (m),
1180 UINT32_MAX /* priority */,
1181 KEEPALIVE_FREQUENCY,
1183 GNUNET_STATISTICS_update (GST_stats, gettext_noop ("# keepalives sent"), 1,
1185 n->expect_latency_response = GNUNET_YES;
1186 n->last_keep_alive_time = GNUNET_TIME_absolute_get ();
1187 n->keep_alive_time = GNUNET_TIME_relative_to_absolute (KEEPALIVE_FREQUENCY);
1192 * Keep the connection to the given neighbour alive longer,
1193 * we received a KEEPALIVE (or equivalent); send a response.
1195 * @param neighbour neighbour to keep alive (by sending keep alive response)
1198 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour)
1200 struct NeighbourMapEntry *n;
1201 struct GNUNET_MessageHeader m;
1203 if (NULL == (n = lookup_neighbour (neighbour)))
1205 GNUNET_STATISTICS_update (GST_stats,
1207 ("# KEEPALIVE messages discarded (peer unknown)"),
1211 if (NULL == n->primary_address.session)
1213 GNUNET_STATISTICS_update (GST_stats,
1215 ("# KEEPALIVE messages discarded (no session)"),
1219 /* send reply to allow neighbour to measure latency */
1220 m.size = htons (sizeof (struct GNUNET_MessageHeader));
1221 m.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE);
1222 send_with_session(n,
1223 (const void *) &m, sizeof (m),
1224 UINT32_MAX /* priority */,
1225 KEEPALIVE_FREQUENCY,
1231 * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
1232 * latency to this peer. Pass the updated information (existing ats
1233 * plus calculated latency) to ATS.
1235 * @param neighbour neighbour to keep alive
1236 * @param ats performance data
1237 * @param ats_count number of entries in ats
1240 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
1241 const struct GNUNET_ATS_Information *ats,
1244 struct NeighbourMapEntry *n;
1246 struct GNUNET_ATS_Information ats_new[ats_count + 1];
1248 if (NULL == (n = lookup_neighbour (neighbour)))
1250 GNUNET_STATISTICS_update (GST_stats,
1252 ("# KEEPALIVE_RESPONSE messages discarded (not connected)"),
1256 if ( (S_CONNECTED != n->state) ||
1257 (GNUNET_YES != n->expect_latency_response) )
1259 GNUNET_STATISTICS_update (GST_stats,
1261 ("# KEEPALIVE_RESPONSE messages discarded (not expected)"),
1265 n->expect_latency_response = GNUNET_NO;
1266 n->latency = GNUNET_TIME_absolute_get_duration (n->last_keep_alive_time);
1267 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1268 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1269 "Latency for peer `%s' is %llu ms\n",
1270 GNUNET_i2s (&n->id), n->latency.rel_value);
1271 memcpy (ats_new, ats, sizeof (struct GNUNET_ATS_Information) * ats_count);
1272 /* append latency */
1273 ats_new[ats_count].type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
1274 if (n->latency.rel_value > UINT32_MAX)
1275 latency = UINT32_MAX;
1277 latency = n->latency.rel_value;
1278 ats_new[ats_count].value = htonl (latency);
1279 GNUNET_ATS_address_update (GST_ats,
1280 n->primary_address.address,
1281 n->primary_address.session, ats_new,
1287 * We have received a message from the given sender. How long should
1288 * we delay before receiving more? (Also used to keep the peer marked
1291 * @param sender sender of the message
1292 * @param size size of the message
1293 * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
1294 * GNUNET_NO if the neighbour is not connected or violates the quota,
1295 * GNUNET_SYSERR if the connection is not fully up yet
1296 * @return how long to wait before reading more from this sender
1298 struct GNUNET_TIME_Relative
1299 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
1300 *sender, ssize_t size, int *do_forward)
1302 struct NeighbourMapEntry *n;
1303 struct GNUNET_TIME_Relative ret;
1305 if (NULL == neighbours)
1307 *do_forward = GNUNET_NO;
1308 return GNUNET_TIME_UNIT_FOREVER_REL; /* This can happen during shutdown */
1310 if (NULL == (n = lookup_neighbour (sender)))
1312 GST_neighbours_try_connect (sender);
1313 if (NULL == (n = lookup_neighbour (sender)))
1315 GNUNET_STATISTICS_update (GST_stats,
1317 ("# messages discarded due to lack of neighbour record"),
1319 *do_forward = GNUNET_NO;
1320 return GNUNET_TIME_UNIT_ZERO;
1323 if (! test_connected (n))
1325 *do_forward = GNUNET_SYSERR;
1326 return GNUNET_TIME_UNIT_ZERO;
1328 if (GNUNET_YES == GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, size))
1330 n->quota_violation_count++;
1331 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1332 "Bandwidth quota (%u b/s) violation detected (total of %u).\n",
1333 n->in_tracker.available_bytes_per_s__,
1334 n->quota_violation_count);
1335 /* Discount 32k per violation */
1336 GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, -32 * 1024);
1340 if (n->quota_violation_count > 0)
1342 /* try to add 32k back */
1343 GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, 32 * 1024);
1344 n->quota_violation_count--;
1347 if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
1349 GNUNET_STATISTICS_update (GST_stats,
1351 ("# bandwidth quota violations by other peers"),
1353 *do_forward = GNUNET_NO;
1354 return GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT;
1356 *do_forward = GNUNET_YES;
1357 ret = GNUNET_BANDWIDTH_tracker_get_delay (&n->in_tracker, 32 * 1024);
1358 if (ret.rel_value > 0)
1360 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1361 "Throttling read (%llu bytes excess at %u b/s), waiting %llu ms before reading more.\n",
1362 (unsigned long long) n->in_tracker.
1363 consumption_since_last_update__,
1364 (unsigned int) n->in_tracker.available_bytes_per_s__,
1365 (unsigned long long) ret.rel_value);
1366 GNUNET_STATISTICS_update (GST_stats,
1367 gettext_noop ("# ms throttling suggested"),
1368 (int64_t) ret.rel_value, GNUNET_NO);
1375 * Transmit a message to the given target using the active connection.
1377 * @param target destination
1378 * @param msg message to send
1379 * @param msg_size number of bytes in msg
1380 * @param timeout when to fail with timeout
1381 * @param cont function to call when done
1382 * @param cont_cls closure for 'cont'
1385 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
1386 size_t msg_size, struct GNUNET_TIME_Relative timeout,
1387 GST_NeighbourSendContinuation cont, void *cont_cls)
1389 struct NeighbourMapEntry *n;
1390 struct MessageQueue *mq;
1392 /* All ove these cases should never happen; they are all API violations.
1393 But we check anyway, just to be sure. */
1394 if (NULL == (n = lookup_neighbour (target)))
1398 cont (cont_cls, GNUNET_SYSERR);
1401 if (GNUNET_YES != test_connected (n))
1405 cont (cont_cls, GNUNET_SYSERR);
1408 if ((NULL == n->primary_address.session) && (NULL == n->primary_address.address))
1412 cont (cont_cls, GNUNET_SYSERR);
1416 bytes_in_send_queue += msg_size;
1417 GNUNET_STATISTICS_set (GST_stats,
1419 ("# bytes in message queue for other peers"),
1420 bytes_in_send_queue, GNUNET_NO);
1421 mq = GNUNET_malloc (sizeof (struct MessageQueue) + msg_size);
1423 mq->cont_cls = cont_cls;
1424 memcpy (&mq[1], msg, msg_size);
1425 mq->message_buf = (const char *) &mq[1];
1426 mq->message_buf_size = msg_size;
1427 mq->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1428 GNUNET_CONTAINER_DLL_insert_tail (n->messages_head, n->messages_tail, mq);
1429 if (NULL != n->is_active)
1431 GNUNET_SCHEDULER_cancel (n->task);
1432 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1437 * Send a SESSION_CONNECT message via the given address.
1439 * @param na address to use
1442 send_session_connect (struct NeighbourAddress *na)
1444 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1445 struct SessionConnectMessage connect_msg;
1447 if (NULL == (papi = GST_plugins_find (na->address->transport_name)))
1452 if (NULL == na->session)
1453 na->session = papi->get_session (papi->cls, na->address);
1454 if (NULL == na->session)
1459 na->connect_timestamp = GNUNET_TIME_absolute_get ();
1460 connect_msg.header.size = htons (sizeof (struct SessionConnectMessage));
1461 connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT);
1462 connect_msg.reserved = htonl (0);
1463 connect_msg.timestamp = GNUNET_TIME_absolute_hton (na->connect_timestamp);
1464 (void) papi->send (papi->cls,
1466 (const char *) &connect_msg, sizeof (struct SessionConnectMessage),
1468 GNUNET_TIME_UNIT_FOREVER_REL,
1474 * Send a SESSION_CONNECT_ACK message via the given address.
1476 * @param address address to use
1477 * @param session session to use
1478 * @param timestamp timestamp to use for the ACK message
1481 send_session_connect_ack_message (const struct GNUNET_HELLO_Address *address,
1482 struct Session *session,
1483 struct GNUNET_TIME_Absolute timestamp)
1485 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1486 struct SessionConnectMessage connect_msg;
1488 if (NULL == (papi = GST_plugins_find (address->transport_name)))
1493 if (NULL == session)
1494 session = papi->get_session (papi->cls, address);
1495 if (NULL == session)
1500 connect_msg.header.size = htons (sizeof (struct SessionConnectMessage));
1501 connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK);
1502 connect_msg.reserved = htonl (0);
1503 connect_msg.timestamp = GNUNET_TIME_absolute_hton (timestamp);
1504 (void) papi->send (papi->cls,
1506 (const char *) &connect_msg, sizeof (struct SessionConnectMessage),
1508 GNUNET_TIME_UNIT_FOREVER_REL,
1514 * Create a fresh entry in the neighbour map for the given peer
1516 * @param peer peer to create an entry for
1517 * @return new neighbour map entry
1519 static struct NeighbourMapEntry *
1520 setup_neighbour (const struct GNUNET_PeerIdentity *peer)
1522 struct NeighbourMapEntry *n;
1524 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1525 "Creating new neighbour entry for `%s'\n",
1527 n = GNUNET_malloc (sizeof (struct NeighbourMapEntry));
1529 n->state = S_NOT_CONNECTED;
1530 n->latency = GNUNET_TIME_UNIT_FOREVER_REL;
1531 GNUNET_BANDWIDTH_tracker_init (&n->in_tracker,
1532 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
1533 MAX_BANDWIDTH_CARRY_S);
1534 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1535 GNUNET_assert (GNUNET_OK ==
1536 GNUNET_CONTAINER_multihashmap_put (neighbours,
1537 &n->id.hashPubKey, n,
1538 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1544 * Check if the two given addresses are the same.
1545 * Actually only checks if the sessions are non-NULL
1546 * (which they should be) and then if they are identical;
1547 * the actual addresses don't matter if the session
1548 * pointers match anyway, and we must have session pointers
1551 * @param a1 first address to compare
1552 * @param a2 other address to compare
1553 * @return GNUNET_NO if the addresses do not match, GNUNET_YES if they do match
1556 address_matches (const struct NeighbourAddress *a1,
1557 const struct NeighbourAddress *a2)
1559 if ( (NULL == a1->session) ||
1560 (NULL == a2->session) )
1565 return (a1->session == a2->session) ? GNUNET_YES : GNUNET_NO;
1570 * Try to create a connection to the given target (eventually).
1572 * @param target peer to try to connect to
1575 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target)
1577 struct NeighbourMapEntry *n;
1579 if (NULL == neighbours)
1580 return; /* during shutdown, do nothing */
1581 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1582 "Asked to connect to peer `%s'\n",
1583 GNUNET_i2s (target));
1585 memcmp (target, &GST_my_identity, sizeof (struct GNUNET_PeerIdentity)))
1587 /* refuse to connect to myself */
1588 /* FIXME: can this happen? Is this not an API violation? */
1589 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1590 "Refusing to try to connect to myself.\n");
1593 n = lookup_neighbour (target);
1598 case S_NOT_CONNECTED:
1599 /* this should not be possible */
1604 case S_INIT_BLACKLIST:
1605 case S_CONNECT_SENT:
1606 case S_CONNECT_RECV_ATS:
1607 case S_CONNECT_RECV_BLACKLIST:
1608 case S_CONNECT_RECV_ACK:
1609 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1610 "Ignoring request to try to connect to `%s', already trying!\n",
1611 GNUNET_i2s (target));
1612 return; /* already trying */
1614 case S_RECONNECT_ATS:
1615 case S_RECONNECT_BLACKLIST:
1616 case S_RECONNECT_SENT:
1617 case S_CONNECTED_SWITCHING_BLACKLIST:
1618 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1619 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1620 "Ignoring request to try to connect, already connected to `%s'!\n",
1621 GNUNET_i2s (target));
1622 return; /* already connected */
1624 /* get rid of remains, ready to re-try immediately */
1627 case S_DISCONNECT_FINISHED:
1628 /* should not be possible */
1636 n = setup_neighbour (target);
1637 n->state = S_INIT_ATS;
1638 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1639 GNUNET_ATS_suggest_address (GST_ats, target);
1644 * Function called with the result of a blacklist check.
1646 * @param cls closure with the 'struct BlackListCheckContext'
1647 * @param peer peer this check affects
1648 * @param result GNUNET_OK if the address is allowed
1651 handle_test_blacklist_cont (void *cls,
1652 const struct GNUNET_PeerIdentity *peer,
1655 struct BlackListCheckContext *bcc = cls;
1656 struct NeighbourMapEntry *n;
1659 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1660 "Connection to new address of peer `%s' based on blacklist is `%s'\n",
1662 (GNUNET_OK == result) ? "allowed" : "FORBIDDEN");
1663 if (GNUNET_OK == result)
1665 /* valid new address, let ATS know! */
1666 GNUNET_ATS_address_update (GST_ats,
1669 bcc->ats, bcc->ats_count);
1671 if (NULL == (n = lookup_neighbour (peer)))
1672 goto cleanup; /* nobody left to care about new address */
1675 case S_NOT_CONNECTED:
1676 /* this should not be possible */
1681 /* still waiting on ATS suggestion */
1683 case S_INIT_BLACKLIST:
1684 /* check if the address the blacklist was fine with matches
1685 ATS suggestion, if so, we can move on! */
1686 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1687 break; /* result for an address we currently don't care about */
1688 if (GNUNET_OK == result)
1690 n->timeout = GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT);
1691 n->state = S_CONNECT_SENT;
1692 send_session_connect (&n->primary_address);
1693 if (1 == n->send_connect_ack)
1695 n->send_connect_ack = 2;
1696 send_session_connect_ack_message (bcc->na.address,
1698 n->connect_ack_timestamp);
1703 GNUNET_ATS_address_destroyed (GST_ats,
1706 n->state = S_INIT_ATS;
1707 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1708 // FIXME: do we need to ask ATS again for suggestions?
1709 GNUNET_ATS_suggest_address (GST_ats, &n->id);
1712 case S_CONNECT_SENT:
1713 /* waiting on CONNECT_ACK, don't care about blacklist */
1715 case S_CONNECT_RECV_ATS:
1716 /* still waiting on ATS suggestion, don't care about blacklist */
1718 case S_CONNECT_RECV_BLACKLIST:
1719 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1720 break; /* result for an address we currently don't care about */
1721 if (GNUNET_OK == result)
1723 n->timeout = GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT);
1724 n->state = S_CONNECT_RECV_ACK;
1725 send_session_connect_ack_message (bcc->na.address,
1727 n->connect_ack_timestamp);
1728 if (1 == n->send_connect_ack)
1729 n->send_connect_ack = 2;
1733 GNUNET_ATS_address_destroyed (GST_ats,
1736 n->state = S_INIT_ATS;
1737 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1738 // FIXME: do we need to ask ATS again for suggestions?
1739 GNUNET_ATS_suggest_address (GST_ats, &n->id);
1742 case S_CONNECT_RECV_ACK:
1743 /* waiting on SESSION_ACK, don't care about blacklist */
1746 /* already connected, don't care about blacklist */
1748 case S_RECONNECT_ATS:
1749 /* still waiting on ATS suggestion, don't care about blacklist */
1751 case S_RECONNECT_BLACKLIST:
1752 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1753 break; /* result for an address we currently don't care about */
1754 if (GNUNET_OK == result)
1756 send_session_connect (&n->primary_address);
1757 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
1758 n->state = S_RECONNECT_SENT;
1759 if (1 == n->send_connect_ack)
1761 n->send_connect_ack = 2;
1762 send_session_connect_ack_message (bcc->na.address,
1764 n->connect_ack_timestamp);
1769 GNUNET_ATS_address_destroyed (GST_ats,
1772 n->state = S_RECONNECT_ATS;
1773 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1774 // FIXME: do we need to ask ATS again for suggestions?
1775 GNUNET_ATS_suggest_address (GST_ats, &n->id);
1778 case S_RECONNECT_SENT:
1779 /* waiting on CONNECT_ACK, don't care about blacklist */
1781 case S_CONNECTED_SWITCHING_BLACKLIST:
1782 if (GNUNET_YES != address_matches (&bcc->na, &n->alternative_address))
1783 break; /* result for an address we currently don't care about */
1784 if (GNUNET_OK == result)
1786 send_session_connect (&n->alternative_address);
1787 n->state = S_CONNECTED_SWITCHING_CONNECT_SENT;
1791 GNUNET_ATS_address_destroyed (GST_ats,
1794 free_address (&n->alternative_address);
1795 n->state = S_CONNECTED;
1798 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1799 /* waiting on CONNECT_ACK, don't care about blacklist */
1802 /* Nothing to do here, ATS will already do what can be done */
1804 case S_DISCONNECT_FINISHED:
1805 /* should not be possible */
1814 GNUNET_HELLO_address_free (bcc->na.address);
1815 GNUNET_CONTAINER_DLL_remove (bc_head,
1823 * We want to know if connecting to a particular peer via
1824 * a particular address is allowed. Check it!
1826 * @param peer identity of the peer to switch the address for
1827 * @param ts time at which the check was initiated
1828 * @param address address of the other peer, NULL if other peer
1830 * @param session session to use (or NULL)
1831 * @param ats performance data
1832 * @param ats_count number of entries in ats (excluding 0-termination)
1835 check_blacklist (const struct GNUNET_PeerIdentity *peer,
1836 struct GNUNET_TIME_Absolute ts,
1837 const struct GNUNET_HELLO_Address *address,
1838 struct Session *session,
1839 const struct GNUNET_ATS_Information *ats,
1842 struct BlackListCheckContext *bcc;
1843 struct GST_BlacklistCheck *bc;
1846 GNUNET_malloc (sizeof (struct BlackListCheckContext) +
1847 sizeof (struct GNUNET_ATS_Information) * ats_count);
1848 bcc->ats_count = ats_count;
1849 bcc->na.address = GNUNET_HELLO_address_copy (address);
1850 bcc->na.session = session;
1851 bcc->na.connect_timestamp = ts;
1852 bcc->ats = (struct GNUNET_ATS_Information *) &bcc[1];
1853 memcpy (bcc->ats, ats, sizeof (struct GNUNET_ATS_Information) * ats_count);
1854 GNUNET_CONTAINER_DLL_insert (bc_head,
1857 if (NULL != (bc = GST_blacklist_test_allowed (peer,
1858 address->transport_name,
1859 &handle_test_blacklist_cont, bcc)))
1861 /* if NULL == bc, 'cont' was already called and 'bcc' already free'd, so
1862 we must only store 'bc' if 'bc' is non-NULL... */
1867 * We received a 'SESSION_CONNECT' message from the other peer.
1868 * Consider switching to it.
1870 * @param message possibly a 'struct SessionConnectMessage' (check format)
1871 * @param peer identity of the peer to switch the address for
1872 * @param address address of the other peer, NULL if other peer
1874 * @param session session to use (or NULL)
1875 * @param ats performance data
1876 * @param ats_count number of entries in ats (excluding 0-termination)
1879 GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
1880 const struct GNUNET_PeerIdentity *peer,
1881 const struct GNUNET_HELLO_Address *address,
1882 struct Session *session,
1883 const struct GNUNET_ATS_Information *ats,
1886 const struct SessionConnectMessage *scm;
1887 struct NeighbourMapEntry *n;
1888 struct GNUNET_TIME_Absolute ts;
1890 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1891 "Received CONNECT message from peer `%s'\n",
1893 if (ntohs (message->size) != sizeof (struct SessionConnectMessage))
1895 GNUNET_break_op (0);
1898 if (NULL == neighbours)
1899 return; /* we're shutting down */
1900 scm = (const struct SessionConnectMessage *) message;
1901 GNUNET_break_op (0 == ntohl (scm->reserved));
1902 ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
1903 n = lookup_neighbour (peer);
1905 n = setup_neighbour (peer);
1906 n->send_connect_ack = 1;
1907 n->connect_ack_timestamp = ts;
1910 case S_NOT_CONNECTED:
1911 n->state = S_CONNECT_RECV_ATS;
1912 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1913 GNUNET_ATS_suggest_address (GST_ats, peer);
1914 check_blacklist (peer, ts, address, session, ats, ats_count);
1917 case S_INIT_BLACKLIST:
1918 case S_CONNECT_SENT:
1919 case S_CONNECT_RECV_ATS:
1920 case S_CONNECT_RECV_BLACKLIST:
1921 case S_CONNECT_RECV_ACK:
1922 /* It can never hurt to have an alternative address in the above cases,
1923 see if it is allowed */
1924 check_blacklist (peer, ts, address, session, ats, ats_count);
1927 /* we are already connected and can thus send the ACK immediately;
1928 still, it can never hurt to have an alternative address, so also
1929 tell ATS about it */
1930 GNUNET_assert (NULL != n->primary_address.address);
1931 GNUNET_assert (NULL != n->primary_address.session);
1932 n->send_connect_ack = 0;
1933 send_session_connect_ack_message (n->primary_address.address,
1934 n->primary_address.session, ts);
1935 check_blacklist (peer, ts, address, session, ats, ats_count);
1937 case S_RECONNECT_ATS:
1938 case S_RECONNECT_BLACKLIST:
1939 case S_RECONNECT_SENT:
1940 /* It can never hurt to have an alternative address in the above cases,
1941 see if it is allowed */
1942 check_blacklist (peer, ts, address, session, ats, ats_count);
1944 case S_CONNECTED_SWITCHING_BLACKLIST:
1945 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1946 /* we are already connected and can thus send the ACK immediately;
1947 still, it can never hurt to have an alternative address, so also
1948 tell ATS about it */
1949 GNUNET_assert (NULL != n->primary_address.address);
1950 GNUNET_assert (NULL != n->primary_address.session);
1951 n->send_connect_ack = 0;
1952 send_session_connect_ack_message (n->primary_address.address,
1953 n->primary_address.session, ts);
1954 check_blacklist (peer, ts, address, session, ats, ats_count);
1957 /* get rid of remains, ready to re-try */
1959 n = setup_neighbour (peer);
1960 n->state = S_CONNECT_RECV_ATS;
1961 GNUNET_ATS_suggest_address (GST_ats, peer);
1962 check_blacklist (peer, ts, address, session, ats, ats_count);
1964 case S_DISCONNECT_FINISHED:
1965 /* should not be possible */
1977 * For an existing neighbour record, set the active connection to
1978 * use the given address.
1980 * @param peer identity of the peer to switch the address for
1981 * @param address address of the other peer, NULL if other peer
1983 * @param session session to use (or NULL)
1984 * @param ats performance data
1985 * @param ats_count number of entries in ats
1986 * @param bandwidth_in inbound quota to be used when connection is up
1987 * @param bandwidth_out outbound quota to be used when connection is up
1990 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
1991 const struct GNUNET_HELLO_Address *address,
1992 struct Session *session,
1993 const struct GNUNET_ATS_Information *ats,
1995 struct GNUNET_BANDWIDTH_Value32NBO
1997 struct GNUNET_BANDWIDTH_Value32NBO
2000 struct NeighbourMapEntry *n;
2001 struct GNUNET_TRANSPORT_PluginFunctions *papi;
2003 GNUNET_assert (address->transport_name != NULL);
2004 if (NULL == (n = lookup_neighbour (peer)))
2007 /* Obtain an session for this address from plugin */
2008 if (NULL == (papi = GST_plugins_find (address->transport_name)))
2010 /* we don't have the plugin for this address */
2011 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2014 if ((NULL == session) && (0 == address->address_length))
2017 if (strlen (address->transport_name) > 0)
2018 GNUNET_ATS_address_destroyed (GST_ats, address, session);
2021 if (NULL == session)
2022 session = papi->get_session (papi->cls, address);
2023 if (NULL == session)
2025 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2026 "Failed to obtain new session for peer `%s' and address '%s'\n",
2027 GNUNET_i2s (&address->peer), GST_plugins_a2s (address));
2028 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2031 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2032 "ATS tells us to switch to address '%s' for peer `%s'\n",
2033 (address->address_length != 0) ? GST_plugins_a2s (address): "<inbound>",
2037 case S_NOT_CONNECTED:
2042 set_address (&n->primary_address,
2043 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2044 n->state = S_INIT_BLACKLIST;
2045 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2046 check_blacklist (&n->id,
2047 n->connect_ack_timestamp,
2048 address, session, ats, ats_count);
2050 case S_INIT_BLACKLIST:
2051 /* ATS suggests a different address, switch again */
2052 set_address (&n->primary_address,
2053 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2054 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2055 check_blacklist (&n->id,
2056 n->connect_ack_timestamp,
2057 address, session, ats, ats_count);
2059 case S_CONNECT_SENT:
2060 /* ATS suggests a different address, switch again */
2061 set_address (&n->primary_address,
2062 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2063 n->state = S_INIT_BLACKLIST;
2064 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2065 check_blacklist (&n->id,
2066 n->connect_ack_timestamp,
2067 address, session, ats, ats_count);
2069 case S_CONNECT_RECV_ATS:
2070 set_address (&n->primary_address,
2071 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2072 n->state = S_CONNECT_RECV_BLACKLIST;
2073 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2074 check_blacklist (&n->id,
2075 n->connect_ack_timestamp,
2076 address, session, ats, ats_count);
2078 case S_CONNECT_RECV_BLACKLIST:
2079 /* ATS asks us to switch while we were trying to connect; switch to new
2080 address and check blacklist again */
2081 set_address (&n->primary_address,
2082 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2083 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2084 check_blacklist (&n->id,
2085 n->connect_ack_timestamp,
2086 address, session, ats, ats_count);
2089 GNUNET_assert (NULL != n->primary_address.address);
2090 GNUNET_assert (NULL != n->primary_address.session);
2091 if (n->primary_address.session == session)
2093 /* not an address change, just a quota change */
2094 set_address (&n->primary_address,
2095 address, session, bandwidth_in, bandwidth_out, GNUNET_YES);
2098 /* ATS asks us to switch a life connection; see if we can get
2099 a CONNECT_ACK on it before we actually do this! */
2100 set_address (&n->alternative_address,
2101 address, session, bandwidth_in, bandwidth_out, GNUNET_YES);
2102 n->state = S_CONNECTED_SWITCHING_BLACKLIST;
2103 check_blacklist (&n->id,
2104 GNUNET_TIME_absolute_get (),
2105 address, session, ats, ats_count);
2107 case S_RECONNECT_ATS:
2108 set_address (&n->primary_address,
2109 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2110 n->state = S_RECONNECT_BLACKLIST;
2111 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2112 check_blacklist (&n->id,
2113 n->connect_ack_timestamp,
2114 address, session, ats, ats_count);
2116 case S_RECONNECT_BLACKLIST:
2117 /* ATS asks us to switch while we were trying to reconnect; switch to new
2118 address and check blacklist again */
2119 set_address (&n->primary_address,
2120 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2121 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2122 check_blacklist (&n->id,
2123 n->connect_ack_timestamp,
2124 address, session, ats, ats_count);
2126 case S_RECONNECT_SENT:
2127 /* ATS asks us to switch while we were trying to reconnect; switch to new
2128 address and check blacklist again */
2129 set_address (&n->primary_address,
2130 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2131 n->state = S_RECONNECT_BLACKLIST;
2132 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2133 check_blacklist (&n->id,
2134 n->connect_ack_timestamp,
2135 address, session, ats, ats_count);
2137 case S_CONNECTED_SWITCHING_BLACKLIST:
2138 if (n->primary_address.session == session)
2140 /* ATS switches back to still-active session */
2141 free_address (&n->alternative_address);
2142 n->state = S_CONNECTED;
2145 /* ATS asks us to switch a life connection, update blacklist check */
2146 set_address (&n->alternative_address,
2147 address, session, bandwidth_in, bandwidth_out, GNUNET_YES);
2148 check_blacklist (&n->id,
2149 GNUNET_TIME_absolute_get (),
2150 address, session, ats, ats_count);
2152 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2153 if (n->primary_address.session == session)
2155 /* ATS switches back to still-active session */
2156 free_address (&n->alternative_address);
2157 n->state = S_CONNECTED;
2160 /* ATS asks us to switch a life connection, update blacklist check */
2161 set_address (&n->alternative_address,
2162 address, session, bandwidth_in, bandwidth_out, GNUNET_YES);
2163 n->state = S_CONNECTED_SWITCHING_BLACKLIST;
2164 check_blacklist (&n->id,
2165 GNUNET_TIME_absolute_get (),
2166 address, session, ats, ats_count);
2169 /* not going to switch addresses while disconnecting */
2171 case S_DISCONNECT_FINISHED:
2182 * Master task run for every neighbour. Performs all of the time-related
2183 * activities (keep alive, send next message, disconnect if idle, finish
2184 * clean up after disconnect).
2186 * @param cls the 'struct NeighbourMapEntry' for which we are running
2187 * @param tc scheduler context (unused)
2190 master_task (void *cls,
2191 const struct GNUNET_SCHEDULER_TaskContext *tc)
2193 struct NeighbourMapEntry *n = cls;
2194 struct GNUNET_TIME_Relative delay;
2196 n->task = GNUNET_SCHEDULER_NO_TASK;
2197 delay = GNUNET_TIME_absolute_get_remaining (n->timeout);
2200 case S_NOT_CONNECTED:
2201 /* invalid state for master task, clean up */
2203 n->state = S_DISCONNECT_FINISHED;
2207 if (0 == delay.rel_value)
2209 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2210 "Connection to `%s' timed out waiting for ATS to provide address\n",
2211 GNUNET_i2s (&n->id));
2212 n->state = S_DISCONNECT_FINISHED;
2217 case S_INIT_BLACKLIST:
2218 if (0 == delay.rel_value)
2220 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2221 "Connection to `%s' timed out waiting for BLACKLIST to approve address\n",
2222 GNUNET_i2s (&n->id));
2223 n->state = S_DISCONNECT_FINISHED;
2228 case S_CONNECT_SENT:
2229 if (0 == delay.rel_value)
2231 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2232 "Connection to `%s' timed out waiting for other peer to send CONNECT_ACK\n",
2233 GNUNET_i2s (&n->id));
2234 disconnect_neighbour (n);
2238 case S_CONNECT_RECV_ATS:
2239 if (0 == delay.rel_value)
2241 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2242 "Connection to `%s' timed out waiting ATS to provide address to use for CONNECT_ACK\n",
2243 GNUNET_i2s (&n->id));
2244 n->state = S_DISCONNECT_FINISHED;
2249 case S_CONNECT_RECV_BLACKLIST:
2250 if (0 == delay.rel_value)
2252 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2253 "Connection to `%s' timed out waiting BLACKLIST to approve address to use for CONNECT_ACK\n",
2254 GNUNET_i2s (&n->id));
2255 n->state = S_DISCONNECT_FINISHED;
2260 case S_CONNECT_RECV_ACK:
2261 if (0 == delay.rel_value)
2263 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2264 "Connection to `%s' timed out waiting for other peer to send SESSION_ACK\n",
2265 GNUNET_i2s (&n->id));
2266 disconnect_neighbour (n);
2271 if (0 == delay.rel_value)
2273 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2274 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs\n",
2275 GNUNET_i2s (&n->id));
2276 disconnect_neighbour (n);
2279 try_transmission_to_peer (n);
2282 case S_RECONNECT_ATS:
2283 if (0 == delay.rel_value)
2285 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2286 "Connection to `%s' timed out, waiting for ATS replacement address\n",
2287 GNUNET_i2s (&n->id));
2288 disconnect_neighbour (n);
2292 case S_RECONNECT_BLACKLIST:
2293 if (0 == delay.rel_value)
2295 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2296 "Connection to `%s' timed out, waiting for BLACKLIST to approve replacement address\n",
2297 GNUNET_i2s (&n->id));
2298 disconnect_neighbour (n);
2302 case S_RECONNECT_SENT:
2303 if (0 == delay.rel_value)
2305 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2306 "Connection to `%s' timed out, waiting for other peer to CONNECT_ACK replacement address\n",
2307 GNUNET_i2s (&n->id));
2308 disconnect_neighbour (n);
2312 case S_CONNECTED_SWITCHING_BLACKLIST:
2313 if (0 == delay.rel_value)
2315 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2316 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs\n",
2317 GNUNET_i2s (&n->id));
2318 disconnect_neighbour (n);
2321 try_transmission_to_peer (n);
2324 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2325 if (0 == delay.rel_value)
2327 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2328 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs (after trying to CONNECT on alternative address)\n",
2329 GNUNET_i2s (&n->id));
2330 disconnect_neighbour (n);
2333 try_transmission_to_peer (n);
2337 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2338 "Cleaning up connection to `%s' after sending DISCONNECT\n",
2339 GNUNET_i2s (&n->id));
2342 case S_DISCONNECT_FINISHED:
2343 /* how did we get here!? */
2350 delay = GNUNET_TIME_relative_min (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time),
2352 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == n->task);
2353 n->task = GNUNET_SCHEDULER_add_delayed (delay,
2360 * Send a SESSION_ACK message to the neighbour to confirm that we
2361 * got his CONNECT_ACK.
2363 * @param n neighbour to send the SESSION_ACK to
2366 send_session_ack_message (struct NeighbourMapEntry *n)
2368 struct GNUNET_MessageHeader msg;
2370 msg.size = htons (sizeof (struct GNUNET_MessageHeader));
2371 msg.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK);
2372 (void) send_with_session(n,
2373 (const char *) &msg, sizeof (struct GNUNET_MessageHeader),
2374 UINT32_MAX, GNUNET_TIME_UNIT_FOREVER_REL,
2380 * We received a 'SESSION_CONNECT_ACK' message from the other peer.
2381 * Consider switching to it.
2383 * @param message possibly a 'struct SessionConnectMessage' (check format)
2384 * @param peer identity of the peer to switch the address for
2385 * @param address address of the other peer, NULL if other peer
2387 * @param session session to use (or NULL)
2388 * @param ats performance data
2389 * @param ats_count number of entries in ats
2392 GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
2393 const struct GNUNET_PeerIdentity *peer,
2394 const struct GNUNET_HELLO_Address *address,
2395 struct Session *session,
2396 const struct GNUNET_ATS_Information *ats,
2399 const struct SessionConnectMessage *scm;
2400 struct GNUNET_TIME_Absolute ts;
2401 struct NeighbourMapEntry *n;
2403 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2404 "Received CONNECT_ACK message from peer `%s'\n",
2406 if (ntohs (message->size) != sizeof (struct SessionConnectMessage))
2408 GNUNET_break_op (0);
2411 scm = (const struct SessionConnectMessage *) message;
2412 GNUNET_break_op (ntohl (scm->reserved) == 0);
2413 if (NULL == (n = lookup_neighbour (peer)))
2415 GNUNET_STATISTICS_update (GST_stats,
2417 ("# unexpected CONNECT_ACK messages (no peer)"),
2421 ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
2424 case S_NOT_CONNECTED:
2429 case S_INIT_BLACKLIST:
2430 GNUNET_STATISTICS_update (GST_stats,
2432 ("# unexpected CONNECT_ACK messages (not ready)"),
2435 case S_CONNECT_SENT:
2436 if (ts.abs_value != n->primary_address.connect_timestamp.abs_value)
2437 break; /* ACK does not match our original CONNECT message */
2438 n->state = S_CONNECTED;
2439 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2440 GNUNET_STATISTICS_set (GST_stats,
2441 gettext_noop ("# peers connected"),
2442 ++neighbours_connected,
2444 connect_notify_cb (callback_cls, &n->id, ats, ats_count);
2445 set_address (&n->primary_address,
2446 n->primary_address.address,
2447 n->primary_address.session,
2448 n->primary_address.bandwidth_in,
2449 n->primary_address.bandwidth_out,
2451 send_session_ack_message (n);
2453 case S_CONNECT_RECV_ATS:
2454 case S_CONNECT_RECV_BLACKLIST:
2455 case S_CONNECT_RECV_ACK:
2456 GNUNET_STATISTICS_update (GST_stats,
2458 ("# unexpected CONNECT_ACK messages (not ready)"),
2462 /* duplicate CONNECT_ACK, let's answer by duplciate SESSION_ACK just in case */
2463 send_session_ack_message (n);
2465 case S_RECONNECT_ATS:
2466 case S_RECONNECT_BLACKLIST:
2467 /* we didn't expect any CONNECT_ACK, as we are waiting for ATS
2468 to give us a new address... */
2469 GNUNET_STATISTICS_update (GST_stats,
2471 ("# unexpected CONNECT_ACK messages (waiting on ATS)"),
2474 case S_RECONNECT_SENT:
2475 /* new address worked; go back to connected! */
2476 n->state = S_CONNECTED;
2477 send_session_ack_message (n);
2479 case S_CONNECTED_SWITCHING_BLACKLIST:
2480 /* duplicate CONNECT_ACK, let's answer by duplciate SESSION_ACK just in case */
2481 send_session_ack_message (n);
2483 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2484 /* new address worked; adopt it and go back to connected! */
2485 n->state = S_CONNECTED;
2486 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2487 GNUNET_assert (GNUNET_NO == n->alternative_address.ats_active);
2488 set_address (&n->primary_address,
2489 n->alternative_address.address,
2490 n->alternative_address.session,
2491 n->alternative_address.bandwidth_in,
2492 n->alternative_address.bandwidth_out,
2494 free_address (&n->alternative_address);
2495 send_session_ack_message (n);
2498 GNUNET_STATISTICS_update (GST_stats,
2500 ("# unexpected CONNECT_ACK messages (disconnecting)"),
2503 case S_DISCONNECT_FINISHED:
2514 * A session was terminated. Take note; if needed, try to get
2515 * an alternative address from ATS.
2517 * @param peer identity of the peer where the session died
2518 * @param session session that is gone
2521 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
2522 struct Session *session)
2524 struct NeighbourMapEntry *n;
2525 struct BlackListCheckContext *bcc;
2526 struct BlackListCheckContext *bcc_next;
2528 /* make sure to cancel all ongoing blacklist checks involving 'session' */
2530 while (NULL != (bcc = bcc_next))
2532 bcc_next = bcc->next;
2533 if (bcc->na.session == session)
2535 GST_blacklist_test_cancel (bcc->bc);
2536 GNUNET_HELLO_address_free (bcc->na.address);
2537 GNUNET_CONTAINER_DLL_remove (bc_head,
2543 if (NULL == (n = lookup_neighbour (peer)))
2544 return; /* can't affect us */
2545 if (session != n->primary_address.session)
2547 if (session == n->alternative_address.session)
2549 free_address (&n->alternative_address);
2550 if ( (S_CONNECTED_SWITCHING_BLACKLIST == n->state) ||
2551 (S_CONNECTED_SWITCHING_CONNECT_SENT == n->state) )
2552 n->state = S_CONNECTED;
2556 return; /* doesn't affect us further */
2559 n->expect_latency_response = GNUNET_NO;
2563 case S_NOT_CONNECTED:
2571 case S_INIT_BLACKLIST:
2572 case S_CONNECT_SENT:
2573 free_address (&n->primary_address);
2574 n->state = S_INIT_ATS;
2575 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2576 // FIXME: need to ask ATS for suggestions again?
2577 GNUNET_ATS_suggest_address (GST_ats, &n->id);
2579 case S_CONNECT_RECV_ATS:
2580 case S_CONNECT_RECV_BLACKLIST:
2581 case S_CONNECT_RECV_ACK:
2582 /* error on inbound session; free neighbour entirely */
2583 free_address (&n->primary_address);
2587 free_address (&n->primary_address);
2588 n->state = S_RECONNECT_ATS;
2589 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2590 /* FIXME: is this ATS call needed? */
2591 GNUNET_ATS_suggest_address (GST_ats, &n->id);
2593 case S_RECONNECT_ATS:
2594 /* we don't have an address, how can it go down? */
2597 case S_RECONNECT_BLACKLIST:
2598 case S_RECONNECT_SENT:
2599 n->state = S_RECONNECT_ATS;
2600 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2601 // FIXME: need to ask ATS for suggestions again?
2602 GNUNET_ATS_suggest_address (GST_ats, &n->id);
2604 case S_CONNECTED_SWITCHING_BLACKLIST:
2605 /* primary went down while we were checking secondary against
2606 blacklist, adopt secondary as primary */
2607 free_address (&n->primary_address);
2608 n->primary_address = n->alternative_address;
2609 memset (&n->alternative_address, 0, sizeof (struct NeighbourAddress));
2610 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
2611 n->state = S_RECONNECT_BLACKLIST;
2613 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2614 /* primary went down while we were waiting for CONNECT_ACK on secondary;
2615 secondary as primary */
2616 free_address (&n->primary_address);
2617 n->primary_address = n->alternative_address;
2618 memset (&n->alternative_address, 0, sizeof (struct NeighbourAddress));
2619 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
2620 n->state = S_RECONNECT_SENT;
2623 free_address (&n->primary_address);
2625 case S_DISCONNECT_FINISHED:
2632 if (GNUNET_SCHEDULER_NO_TASK != n->task)
2633 GNUNET_SCHEDULER_cancel (n->task);
2634 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
2639 * We received a 'SESSION_ACK' message from the other peer.
2640 * If we sent a 'CONNECT_ACK' last, this means we are now
2641 * connected. Otherwise, do nothing.
2643 * @param message possibly a 'struct SessionConnectMessage' (check format)
2644 * @param peer identity of the peer to switch the address for
2645 * @param address address of the other peer, NULL if other peer
2647 * @param session session to use (or NULL)
2648 * @param ats performance data
2649 * @param ats_count number of entries in ats
2652 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
2653 const struct GNUNET_PeerIdentity *peer,
2654 const struct GNUNET_HELLO_Address *address,
2655 struct Session *session,
2656 const struct GNUNET_ATS_Information *ats,
2659 struct NeighbourMapEntry *n;
2661 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2662 "Received SESSION_ACK message from peer `%s'\n",
2664 if (ntohs (message->size) != sizeof (struct GNUNET_MessageHeader))
2666 GNUNET_break_op (0);
2669 if (NULL == (n = lookup_neighbour (peer)))
2671 /* check if we are in a plausible state for having sent
2672 a CONNECT_ACK. If not, return, otherwise break */
2673 if ( ( (S_CONNECT_RECV_ACK != n->state) &&
2674 (S_CONNECT_SENT != n->state) ) ||
2675 (2 != n->send_connect_ack) )
2677 GNUNET_STATISTICS_update (GST_stats,
2678 gettext_noop ("# unexpected SESSION ACK messages"), 1,
2682 n->state = S_CONNECTED;
2683 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2684 GNUNET_STATISTICS_set (GST_stats,
2685 gettext_noop ("# peers connected"),
2686 ++neighbours_connected,
2688 connect_notify_cb (callback_cls, &n->id, ats, ats_count);
2689 set_address (&n->primary_address,
2690 n->primary_address.address,
2691 n->primary_address.session,
2692 n->primary_address.bandwidth_in,
2693 n->primary_address.bandwidth_out,
2699 * Test if we're connected to the given peer.
2701 * @param target peer to test
2702 * @return GNUNET_YES if we are connected, GNUNET_NO if not
2705 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target)
2707 return test_connected (lookup_neighbour (target));
2712 * Change the incoming quota for the given peer.
2714 * @param neighbour identity of peer to change qutoa for
2715 * @param quota new quota
2718 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
2719 struct GNUNET_BANDWIDTH_Value32NBO quota)
2721 struct NeighbourMapEntry *n;
2723 if (NULL == (n = lookup_neighbour (neighbour)))
2725 GNUNET_STATISTICS_update (GST_stats,
2727 ("# SET QUOTA messages ignored (no such peer)"),
2731 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2732 "Setting inbound quota of %u Bps for peer `%s' to all clients\n",
2733 ntohl (quota.value__), GNUNET_i2s (&n->id));
2734 GNUNET_BANDWIDTH_tracker_update_quota (&n->in_tracker, quota);
2735 if (0 != ntohl (quota.value__))
2737 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting peer `%4s' due to `%s'\n",
2738 GNUNET_i2s (&n->id), "SET_QUOTA");
2739 if (GNUNET_YES == test_connected (n))
2740 GNUNET_STATISTICS_update (GST_stats,
2741 gettext_noop ("# disconnects due to quota of 0"),
2743 disconnect_neighbour (n);
2748 * We received a disconnect message from the given peer,
2749 * validate and process.
2751 * @param peer sender of the message
2752 * @param msg the disconnect message
2755 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
2757 const struct GNUNET_MessageHeader
2760 struct NeighbourMapEntry *n;
2761 const struct SessionDisconnectMessage *sdm;
2764 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2765 "Received DISCONNECT message from peer `%s'\n",
2767 if (ntohs (msg->size) != sizeof (struct SessionDisconnectMessage))
2769 // GNUNET_break_op (0);
2770 GNUNET_STATISTICS_update (GST_stats,
2772 ("# disconnect messages ignored (old format)"), 1,
2776 sdm = (const struct SessionDisconnectMessage *) msg;
2777 if (NULL == (n = lookup_neighbour (peer)))
2778 return; /* gone already */
2779 if (GNUNET_TIME_absolute_ntoh (sdm->timestamp).abs_value <= n->connect_ack_timestamp.abs_value)
2781 GNUNET_STATISTICS_update (GST_stats,
2783 ("# disconnect messages ignored (timestamp)"), 1,
2787 GNUNET_CRYPTO_hash (&sdm->public_key,
2788 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
2790 if (0 != memcmp (peer, &hc, sizeof (struct GNUNET_PeerIdentity)))
2792 GNUNET_break_op (0);
2795 if (ntohl (sdm->purpose.size) !=
2796 sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) +
2797 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
2798 sizeof (struct GNUNET_TIME_AbsoluteNBO))
2800 GNUNET_break_op (0);
2804 GNUNET_CRYPTO_rsa_verify
2805 (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT, &sdm->purpose,
2806 &sdm->signature, &sdm->public_key))
2808 GNUNET_break_op (0);
2811 if (GNUNET_YES == test_connected (n))
2812 GNUNET_STATISTICS_update (GST_stats,
2814 ("# other peer asked to disconnect from us"), 1,
2816 disconnect_neighbour (n);
2821 * Closure for the neighbours_iterate function.
2823 struct IteratorContext
2826 * Function to call on each connected neighbour.
2828 GST_NeighbourIterator cb;
2838 * Call the callback from the closure for each connected neighbour.
2840 * @param cls the 'struct IteratorContext'
2841 * @param key the hash of the public key of the neighbour
2842 * @param value the 'struct NeighbourMapEntry'
2843 * @return GNUNET_OK (continue to iterate)
2846 neighbours_iterate (void *cls, const GNUNET_HashCode * key, void *value)
2848 struct IteratorContext *ic = cls;
2849 struct NeighbourMapEntry *n = value;
2851 if (GNUNET_YES == test_connected (n))
2852 ic->cb (ic->cb_cls, &n->id, NULL, 0, n->primary_address.address);
2858 * Iterate over all connected neighbours.
2860 * @param cb function to call
2861 * @param cb_cls closure for cb
2864 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls)
2866 struct IteratorContext ic;
2868 if (NULL == neighbours)
2869 return; /* can happen during shutdown */
2872 GNUNET_CONTAINER_multihashmap_iterate (neighbours, &neighbours_iterate, &ic);
2877 * If we have an active connection to the given target, it must be shutdown.
2879 * @param target peer to disconnect from
2882 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target)
2884 struct NeighbourMapEntry *n;
2886 if (NULL == (n = lookup_neighbour (target)))
2887 return; /* not active */
2888 if (GNUNET_YES == test_connected (n))
2889 GNUNET_STATISTICS_update (GST_stats,
2891 ("# disconnected from peer upon explicit request"), 1,
2893 disconnect_neighbour (n);
2898 * Obtain current latency information for the given neighbour.
2900 * @param peer to get the latency for
2901 * @return observed latency of the address, FOREVER if the
2902 * the connection is not up
2904 struct GNUNET_TIME_Relative
2905 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer)
2907 struct NeighbourMapEntry *n;
2909 n = lookup_neighbour (peer);
2911 return GNUNET_TIME_UNIT_FOREVER_REL;
2915 case S_RECONNECT_SENT:
2916 case S_RECONNECT_ATS:
2918 case S_NOT_CONNECTED:
2919 case S_INIT_BLACKLIST:
2921 case S_CONNECT_SENT:
2922 case S_CONNECT_RECV_BLACKLIST:
2924 case S_DISCONNECT_FINISHED:
2925 return GNUNET_TIME_UNIT_FOREVER_REL;
2930 return GNUNET_TIME_UNIT_FOREVER_REL;
2935 * Obtain current address information for the given neighbour.
2938 * @return address currently used
2940 struct GNUNET_HELLO_Address *
2941 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer)
2943 struct NeighbourMapEntry *n;
2945 n = lookup_neighbour (peer);
2948 return n->primary_address.address;
2953 * Initialize the neighbours subsystem.
2955 * @param cls closure for callbacks
2956 * @param connect_cb function to call if we connect to a peer
2957 * @param disconnect_cb function to call if we disconnect from a peer
2958 * @param peer_address_cb function to call if we change an active address
2962 GST_neighbours_start (void *cls,
2963 GNUNET_TRANSPORT_NotifyConnect connect_cb,
2964 GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
2965 GNUNET_TRANSPORT_PeerIterateCallback peer_address_cb)
2968 connect_notify_cb = connect_cb;
2969 disconnect_notify_cb = disconnect_cb;
2970 address_change_cb = peer_address_cb;
2971 neighbours = GNUNET_CONTAINER_multihashmap_create (NEIGHBOUR_TABLE_SIZE);
2976 * Disconnect from the given neighbour.
2979 * @param key hash of neighbour's public key (not used)
2980 * @param value the 'struct NeighbourMapEntry' of the neighbour
2981 * @return GNUNET_OK (continue to iterate)
2984 disconnect_all_neighbours (void *cls, const GNUNET_HashCode * key, void *value)
2986 struct NeighbourMapEntry *n = value;
2988 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2989 "Disconnecting peer `%4s', %s\n",
2990 GNUNET_i2s (&n->id), "SHUTDOWN_TASK");
2997 * Cleanup the neighbours subsystem.
3000 GST_neighbours_stop ()
3002 if (NULL == neighbours)
3004 GNUNET_CONTAINER_multihashmap_iterate (neighbours,
3005 &disconnect_all_neighbours,
3007 GNUNET_CONTAINER_multihashmap_destroy (neighbours);
3009 callback_cls = NULL;
3010 connect_notify_cb = NULL;
3011 disconnect_notify_cb = NULL;
3012 address_change_cb = NULL;
3016 /* end of file gnunet-service-transport_neighbours.c */