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"
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, 500)
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 GNUNET_NETWORK_STRUCT_BEGIN
99 * Message a peer sends to another to indicate that it intends to
100 * setup a connection/session for data exchange. A 'SESSION_CONNECT'
101 * should be answered with a 'SESSION_CONNECT_ACK' with the same body
102 * to confirm. A 'SESSION_CONNECT_ACK' should then be followed with
103 * a 'SESSION_ACK'. Once the 'SESSION_ACK' is received, both peers
104 * should be connected.
106 struct SessionConnectMessage
109 * Header of type 'GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT'
110 * or 'GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK'
112 struct GNUNET_MessageHeader header;
117 uint32_t reserved GNUNET_PACKED;
120 * Absolute time at the sender. Only the most recent connect
121 * message implies which session is preferred by the sender.
123 struct GNUNET_TIME_AbsoluteNBO timestamp;
129 * Message we send to the other peer to notify him that we intentionally
130 * are disconnecting (to reduce timeouts). This is just a friendly
131 * notification, peers must not rely on always receiving disconnect
134 struct SessionDisconnectMessage
137 * Header of type 'GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT'
139 struct GNUNET_MessageHeader header;
144 uint32_t reserved GNUNET_PACKED;
147 * Purpose of the signature. Extends over the timestamp.
148 * Purpose should be GNUNET_SIGNATURE_PURPOSE_TRANSPORT_DISCONNECT.
150 struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
153 * Absolute time at the sender. Only the most recent connect
154 * message implies which session is preferred by the sender.
156 struct GNUNET_TIME_AbsoluteNBO timestamp;
159 * Public key of the sender.
161 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded public_key;
164 * Signature of the peer that sends us the disconnect. Only
165 * valid if the timestamp is AFTER the timestamp from the
166 * corresponding 'CONNECT' message.
168 struct GNUNET_CRYPTO_RsaSignature signature;
172 GNUNET_NETWORK_STRUCT_END
176 * For each neighbour we keep a list of messages
177 * that we still want to transmit to the neighbour.
183 * This is a doubly linked list.
185 struct MessageQueue *next;
188 * This is a doubly linked list.
190 struct MessageQueue *prev;
193 * Function to call once we're done.
195 GST_NeighbourSendContinuation cont;
203 * The message(s) we want to transmit, GNUNET_MessageHeader(s)
204 * stuck together in memory. Allocated at the end of this struct.
206 const char *message_buf;
209 * Size of the message buf
211 size_t message_buf_size;
214 * At what time should we fail?
216 struct GNUNET_TIME_Absolute timeout;
222 * Possible state of a neighbour. Initially, we are S_NOT_CONNECTED.
224 * Then, there are two main paths. If we receive a CONNECT message, we
225 * first run a check against the blacklist (S_CONNECT_RECV_BLACKLIST_INBOUND).
226 * If this check is successful, we give the inbound address to ATS.
227 * After the check we ask ATS for a suggestion (S_CONNECT_RECV_ATS).
228 * If ATS makes a suggestion, we ALSO give that suggestion to the blacklist
229 * (S_CONNECT_RECV_BLACKLIST). Once the blacklist approves the
230 * address we got from ATS, we send our CONNECT_ACK and go to
231 * S_CONNECT_RECV_ACK. If we receive a SESSION_ACK, we go to
232 * S_CONNECTED (and notify everyone about the new connection). If the
233 * operation times out, we go to S_DISCONNECT.
235 * The other case is where we transmit a CONNECT message first. We
236 * start with S_INIT_ATS. If we get an address, we enter
237 * S_INIT_BLACKLIST and check the blacklist. If the blacklist is OK
238 * with the connection, we actually send the CONNECT message and go to
239 * state S_CONNECT_SENT. Once we receive a CONNECT_ACK, we go to
240 * S_CONNECTED (and notify everyone about the new connection and send
241 * back a SESSION_ACK). If the operation times out, we go to
244 * If the session is in trouble (i.e. transport-level disconnect or
245 * timeout), we go to S_RECONNECT_ATS where we ask ATS for a new
246 * address (we don't notify anyone about the disconnect yet). Once we
247 * have a new address, we go to S_RECONNECT_BLACKLIST to check the new
248 * address against the blacklist. If the blacklist approves, we enter
249 * S_RECONNECT_SENT and send a CONNECT message. If we receive a
250 * CONNECT_ACK, we go to S_CONNECTED and nobody noticed that we had
251 * trouble; we also send a SESSION_ACK at this time just in case. If
252 * the operation times out, we go to S_DISCONNECT (and notify everyone
253 * about the lost connection).
255 * If ATS decides to switch addresses while we have a normal
256 * connection, we go to S_CONNECTED_SWITCHING_BLACKLIST to check the
257 * new address against the blacklist. If the blacklist approves, we
258 * go to S_CONNECTED_SWITCHING_CONNECT_SENT and send a
259 * SESSION_CONNECT. If we get a SESSION_ACK back, we switch the
260 * primary connection to the suggested alternative from ATS, go back
261 * to S_CONNECTED and send a SESSION_ACK to the other peer just to be
262 * sure. If the operation times out (or the blacklist disapproves),
263 * we go to S_CONNECTED (and notify ATS that the given alternative
264 * address is "invalid").
266 * Once a session is in S_DISCONNECT, it is cleaned up and then goes
267 * to (S_DISCONNECT_FINISHED). If we receive an explicit disconnect
268 * request, we can go from any state to S_DISCONNECT, possibly after
269 * generating disconnect notifications.
271 * Note that it is quite possible that while we are in any of these
272 * states, we could receive a 'CONNECT' request from the other peer.
273 * We then enter a 'weird' state where we pursue our own primary state
274 * machine (as described above), but with the 'send_connect_ack' flag
275 * set to 1. If our state machine allows us to send a 'CONNECT_ACK'
276 * (because we have an acceptable address), we send the 'CONNECT_ACK'
277 * and set the 'send_connect_ack' to 2. If we then receive a
278 * 'SESSION_ACK', we go to 'S_CONNECTED' (and reset 'send_connect_ack'
285 * fresh peer or completely disconnected
290 * Asked to initiate connection, trying to get address from ATS
295 * Asked to initiate connection, trying to get address approved
301 * Sent CONNECT message to other peer, waiting for CONNECT_ACK
306 * Received a CONNECT, do a blacklist check for inbound address
308 S_CONNECT_RECV_BLACKLIST_INBOUND,
311 * Received a CONNECT, asking ATS about address suggestions.
316 * Received CONNECT from other peer, got an address, checking with blacklist.
318 S_CONNECT_RECV_BLACKLIST,
321 * CONNECT request from other peer was SESSION_ACK'ed, waiting for
327 * Got our CONNECT_ACK/SESSION_ACK, connection is up.
332 * Connection got into trouble, rest of the system still believes
333 * it to be up, but we're getting a new address from ATS.
338 * Connection got into trouble, rest of the system still believes
339 * it to be up; we are checking the new address against the blacklist.
341 S_RECONNECT_BLACKLIST,
344 * Sent CONNECT over new address (either by ATS telling us to switch
345 * addresses or from RECONNECT_ATS); if this fails, we need to tell
346 * the rest of the system about a disconnect.
351 * We have some primary connection, but ATS suggested we switch
352 * to some alternative; we're now checking the alternative against
355 S_CONNECTED_SWITCHING_BLACKLIST,
358 * We have some primary connection, but ATS suggested we switch
359 * to some alternative; we now sent a CONNECT message for the
360 * alternative session to the other peer and waiting for a
361 * CONNECT_ACK to make this our primary connection.
363 S_CONNECTED_SWITCHING_CONNECT_SENT,
366 * Disconnect in progress (we're sending the DISCONNECT message to the
367 * other peer; after that is finished, the state will be cleaned up).
372 * We're finished with the disconnect; and are cleaning up the state
373 * now! We put the struct into this state when we are really in the
374 * task that calls 'free' on it and are about to remove the record
375 * from the map. We should never find a 'struct NeighbourMapEntry'
376 * in this state in the map. Accessing a 'struct NeighbourMapEntry'
377 * in this state virtually always means using memory that has been
378 * freed (the exception being the cleanup code in 'free_neighbour').
380 S_DISCONNECT_FINISHED
385 * A possible address we could use to communicate with a neighbour.
387 struct NeighbourAddress
391 * Active session for this address.
393 struct Session *session;
396 * Network-level address information.
398 struct GNUNET_HELLO_Address *address;
401 * Timestamp of the 'SESSION_CONNECT' message we sent to the other
402 * peer for this address. Use to check that the ACK is in response
403 * to our most recent 'CONNECT'.
405 struct GNUNET_TIME_Absolute connect_timestamp;
408 * Inbound bandwidth from ATS for this address.
410 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
413 * Outbound bandwidth from ATS for this address.
415 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
418 * Did we tell ATS that this is our 'active' address?
426 * Entry in neighbours.
428 struct NeighbourMapEntry
432 * Head of list of messages we would like to send to this peer;
433 * must contain at most one message per client.
435 struct MessageQueue *messages_head;
438 * Tail of list of messages we would like to send to this peer; must
439 * contain at most one message per client.
441 struct MessageQueue *messages_tail;
444 * Are we currently trying to send a message? If so, which one?
446 struct MessageQueue *is_active;
449 * Primary address we currently use to communicate with the neighbour.
451 struct NeighbourAddress primary_address;
454 * Alternative address currently under consideration for communicating
455 * with the neighbour.
457 struct NeighbourAddress alternative_address;
460 * Identity of this neighbour.
462 struct GNUNET_PeerIdentity id;
465 * Main task that drives this peer (timeouts, keepalives, etc.).
466 * Always runs the 'master_task'.
468 GNUNET_SCHEDULER_TaskIdentifier task;
471 * At what time should we sent the next keep-alive message?
473 struct GNUNET_TIME_Absolute keep_alive_time;
476 * At what time did we sent the last keep-alive message? Used
477 * to calculate round-trip time ("latency").
479 struct GNUNET_TIME_Absolute last_keep_alive_time;
482 * Timestamp we should include in our next CONNECT_ACK message.
483 * (only valid if 'send_connect_ack' is GNUNET_YES). Used to build
484 * our CONNECT_ACK message.
486 struct GNUNET_TIME_Absolute connect_ack_timestamp;
489 * Time where we should cut the connection (timeout) if we don't
490 * make progress in the state machine (or get a KEEPALIVE_RESPONSE
491 * if we are in S_CONNECTED).
493 struct GNUNET_TIME_Absolute timeout;
496 * Latest calculated latency value
498 struct GNUNET_TIME_Relative latency;
501 * Tracker for inbound bandwidth.
503 struct GNUNET_BANDWIDTH_Tracker in_tracker;
506 * How often has the other peer (recently) violated the inbound
507 * traffic limit? Incremented by 10 per violation, decremented by 1
508 * per non-violation (for each time interval).
510 unsigned int quota_violation_count;
513 * The current state of the peer.
518 * Did we sent an KEEP_ALIVE message and are we expecting a response?
520 int expect_latency_response;
523 * Flag to set if we still need to send a CONNECT_ACK message to the other peer
524 * (once we have an address to use and the peer has been allowed by our
525 * blacklist). Set to 1 if we need to send a CONNECT_ACK. Set to 2 if we
526 * did send a CONNECT_ACK and should go to 'S_CONNECTED' upon receiving
527 * a 'SESSION_ACK' (regardless of what our own state machine might say).
529 int send_connect_ack;
535 * Context for blacklist checks and the 'handle_test_blacklist_cont'
536 * function. Stores information about ongoing blacklist checks.
538 struct BlackListCheckContext
542 * We keep blacklist checks in a DLL.
544 struct BlackListCheckContext *next;
547 * We keep blacklist checks in a DLL.
549 struct BlackListCheckContext *prev;
552 * Address that is being checked.
554 struct NeighbourAddress na;
557 * ATS information about the address.
559 struct GNUNET_ATS_Information *ats;
562 * Handle to the ongoing blacklist check.
564 struct GST_BlacklistCheck *bc;
567 * Size of the 'ats' array.
575 * Hash map from peer identities to the respective 'struct NeighbourMapEntry'.
577 static struct GNUNET_CONTAINER_MultiHashMap *neighbours;
580 * We keep blacklist checks in a DLL so that we can find
581 * the 'sessions' in their 'struct NeighbourAddress' if
582 * a session goes down.
584 static struct BlackListCheckContext *bc_head;
587 * We keep blacklist checks in a DLL.
589 static struct BlackListCheckContext *bc_tail;
592 * Closure for connect_notify_cb, disconnect_notify_cb and address_change_cb
594 static void *callback_cls;
597 * Function to call when we connected to a neighbour.
599 static NotifyConnect connect_notify_cb;
602 * Function to call when we disconnected from a neighbour.
604 static GNUNET_TRANSPORT_NotifyDisconnect disconnect_notify_cb;
607 * Function to call when we changed an active address of a neighbour.
609 static GNUNET_TRANSPORT_PeerIterateCallback address_change_cb;
612 * counter for connected neighbours
614 static unsigned int neighbours_connected;
617 * Number of bytes we have currently queued for transmission.
619 static unsigned long long bytes_in_send_queue;
623 * Lookup a neighbour entry in the neighbours hash map.
625 * @param pid identity of the peer to look up
626 * @return the entry, NULL if there is no existing record
628 static struct NeighbourMapEntry *
629 lookup_neighbour (const struct GNUNET_PeerIdentity *pid)
631 if (NULL == neighbours)
633 return GNUNET_CONTAINER_multihashmap_get (neighbours, &pid->hashPubKey);
637 print_state (int state)
642 case S_NOT_CONNECTED:
643 return "S_NOT_CONNECTED";
646 case S_INIT_BLACKLIST:
647 return "S_INIT_BLACKLIST";
649 return "S_CONNECT_SENT";
650 case S_CONNECT_RECV_BLACKLIST_INBOUND:
651 return "S_CONNECT_RECV_BLACKLIST_INBOUND";
652 case S_CONNECT_RECV_ATS:
653 return "S_CONNECT_RECV_ATS";
654 case S_CONNECT_RECV_BLACKLIST:
655 return "S_CONNECT_RECV_BLACKLIST";
656 case S_CONNECT_RECV_ACK:
657 return "S_CONNECT_RECV_ACK";
659 return "S_CONNECTED";
660 case S_RECONNECT_ATS:
661 return "S_RECONNECT_ATS";
662 case S_RECONNECT_BLACKLIST:
663 return "S_RECONNECT_BLACKLIST";
664 case S_RECONNECT_SENT:
665 return "S_RECONNECT_SENT";
666 case S_CONNECTED_SWITCHING_BLACKLIST:
667 return "S_CONNECTED_SWITCHING_BLACKLIST";
668 case S_CONNECTED_SWITCHING_CONNECT_SENT:
669 return "S_CONNECTED_SWITCHING_CONNECT_SENT";
671 return "S_DISCONNECT";
672 case S_DISCONNECT_FINISHED:
673 return "S_DISCONNECT_FINISHED";
681 * Test if we're connected to the given peer.
683 * @param n neighbour entry of peer to test
684 * @return GNUNET_YES if we are connected, GNUNET_NO if not
687 test_connected (struct NeighbourMapEntry *n)
693 case S_NOT_CONNECTED:
695 case S_INIT_BLACKLIST:
697 case S_CONNECT_RECV_BLACKLIST_INBOUND:
698 case S_CONNECT_RECV_ATS:
699 case S_CONNECT_RECV_BLACKLIST:
700 case S_CONNECT_RECV_ACK:
703 case S_RECONNECT_ATS:
704 case S_RECONNECT_BLACKLIST:
705 case S_RECONNECT_SENT:
706 case S_CONNECTED_SWITCHING_BLACKLIST:
707 case S_CONNECTED_SWITCHING_CONNECT_SENT:
710 case S_DISCONNECT_FINISHED:
713 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
717 return GNUNET_SYSERR;
721 * Send information about a new outbound quota to our clients.
723 * @param target affected peer
724 * @param quota new quota
727 send_outbound_quota (const struct GNUNET_PeerIdentity *target,
728 struct GNUNET_BANDWIDTH_Value32NBO quota)
730 struct QuotaSetMessage q_msg;
732 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
733 "Sending outbound quota of %u Bps for peer `%s' to all clients\n",
734 ntohl (quota.value__), GNUNET_i2s (target));
735 q_msg.header.size = htons (sizeof (struct QuotaSetMessage));
736 q_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA);
738 q_msg.peer = (*target);
739 GST_clients_broadcast (&q_msg.header, GNUNET_NO);
744 * We don't need a given neighbour address any more.
745 * Release its resources and give appropriate notifications
746 * to ATS and other subsystems.
748 * @param na address we are done with; 'na' itself must NOT be 'free'd, only the contents!
751 free_address (struct NeighbourAddress *na)
753 if (GNUNET_YES == na->ats_active)
755 GST_validation_set_address_use (na->address, na->session, GNUNET_NO, __LINE__);
756 GNUNET_ATS_address_in_use (GST_ats, na->address, na->session, GNUNET_NO);
757 address_change_cb (NULL, &na->address->peer, NULL);
760 na->ats_active = GNUNET_NO;
761 if (NULL != na->address)
763 GNUNET_HELLO_address_free (na->address);
771 * Initialize the 'struct NeighbourAddress'.
773 * @param na neighbour address to initialize
774 * @param address address of the other peer, NULL if other peer
776 * @param session session to use (or NULL, in which case an
777 * address must be setup)
778 * @param bandwidth_in inbound quota to be used when connection is up
779 * @param bandwidth_out outbound quota to be used when connection is up
780 * @param is_active GNUNET_YES to mark this as the active address with ATS
783 set_address (struct NeighbourAddress *na,
784 const struct GNUNET_HELLO_Address *address,
785 struct Session *session,
786 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
787 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
790 struct GNUNET_TRANSPORT_PluginFunctions *papi;
791 if (NULL == (papi = GST_plugins_find (address->transport_name)))
796 if (session == na->session)
798 na->bandwidth_in = bandwidth_in;
799 na->bandwidth_out = bandwidth_out;
800 if (is_active != na->ats_active)
802 na->ats_active = is_active;
803 GNUNET_ATS_address_in_use (GST_ats, na->address, na->session, is_active);
804 GST_validation_set_address_use (na->address, na->session, is_active, __LINE__);
806 address_change_cb (NULL, &address->peer, address);
808 if (GNUNET_YES == is_active)
810 /* FIXME: is this the right place to set quotas? */
811 GST_neighbours_set_incoming_quota (&address->peer, bandwidth_in);
812 send_outbound_quota (&address->peer, bandwidth_out);
818 session = papi->get_session (papi->cls, address);
821 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
822 "Failed to obtain new session for peer `%s' and address '%s'\n",
823 GNUNET_i2s (&address->peer), GST_plugins_a2s (address));
824 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
827 na->address = GNUNET_HELLO_address_copy (address);
828 na->bandwidth_in = bandwidth_in;
829 na->bandwidth_out = bandwidth_out;
830 na->session = session;
831 na->ats_active = is_active;
832 if (GNUNET_YES == is_active)
834 /* Telling ATS about new session */
835 GNUNET_ATS_address_in_use (GST_ats, na->address, na->session, GNUNET_YES);
836 GST_validation_set_address_use (na->address, na->session, GNUNET_YES, __LINE__);
837 address_change_cb (NULL, &address->peer, address);
838 /* FIXME: is this the right place to set quotas? */
839 GST_neighbours_set_incoming_quota (&address->peer, bandwidth_in);
840 send_outbound_quota (&address->peer, bandwidth_out);
846 * Free a neighbour map entry.
848 * @param n entry to free
849 * @param keep_sessions GNUNET_NO to tell plugin to terminate sessions,
850 * GNUNET_YES to keep all sessions
853 free_neighbour (struct NeighbourMapEntry *n, int keep_sessions)
855 struct MessageQueue *mq;
856 struct GNUNET_TRANSPORT_PluginFunctions *papi;
857 struct GNUNET_HELLO_Address *backup_primary;
859 n->is_active = NULL; /* always free'd by its own continuation! */
861 /* fail messages currently in the queue */
862 while (NULL != (mq = n->messages_head))
864 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
865 if (NULL != mq->cont)
866 mq->cont (mq->cont_cls, GNUNET_SYSERR, mq->message_buf_size, 0);
869 /* It is too late to send other peer disconnect notifications, but at
870 least internally we need to get clean... */
871 if (GNUNET_YES == test_connected (n))
873 GNUNET_STATISTICS_set (GST_stats,
874 gettext_noop ("# peers connected"),
875 --neighbours_connected,
877 disconnect_notify_cb (callback_cls, &n->id);
880 n->state = S_DISCONNECT_FINISHED;
882 if (NULL != n->primary_address.address)
883 backup_primary = GNUNET_HELLO_address_copy(n->primary_address.address);
885 backup_primary = NULL;
887 /* free addresses and mark as unused */
888 free_address (&n->primary_address);
889 free_address (&n->alternative_address);
891 /* FIXME-PLUGIN-API: This does not seem to guarantee that all
892 transport sessions eventually get killed due to inactivity; they
893 MUST have their own timeout logic (but at least TCP doesn't have
894 one yet). Are we sure that EVERY 'session' of a plugin is
895 actually cleaned up this way!? Note that if we are switching
896 between two TCP sessions to the same peer, the existing plugin
897 API gives us not even the means to selectively kill only one of
898 them! Killing all sessions like this seems to be very, very
901 /* cut transport-level connection */
902 if ((GNUNET_NO == keep_sessions) &&
903 (NULL != backup_primary) &&
904 (NULL != (papi = GST_plugins_find (backup_primary->transport_name))))
905 papi->disconnect (papi->cls, &n->id);
907 GNUNET_free_non_null (backup_primary);
909 GNUNET_assert (GNUNET_YES ==
910 GNUNET_CONTAINER_multihashmap_remove (neighbours,
911 &n->id.hashPubKey, n));
913 // FIXME-ATS-API: we might want to be more specific about
914 // which states we do this from in the future (ATS should
915 // have given us a 'suggest_address' handle, and if we have
916 // such a handle, we should cancel the operation here!
917 GNUNET_ATS_suggest_address_cancel (GST_ats, &n->id);
919 if (GNUNET_SCHEDULER_NO_TASK != n->task)
921 GNUNET_SCHEDULER_cancel (n->task);
922 n->task = GNUNET_SCHEDULER_NO_TASK;
924 /* free rest of memory */
929 * Transmit a message using the current session of the given
932 * @param n entry for the recipient
933 * @param msgbuf buffer to transmit
934 * @param msgbuf_size number of bytes in buffer
935 * @param priority transmission priority
936 * @param timeout transmission timeout
937 * @param cont continuation to call when finished (can be NULL)
938 * @param cont_cls closure for cont
941 send_with_session (struct NeighbourMapEntry *n,
942 const char *msgbuf, size_t msgbuf_size,
944 struct GNUNET_TIME_Relative timeout,
945 GNUNET_TRANSPORT_TransmitContinuation cont,
948 struct GNUNET_TRANSPORT_PluginFunctions *papi;
950 GNUNET_assert (n->primary_address.session != NULL);
951 if ( ((NULL == (papi = GST_plugins_find (n->primary_address.address->transport_name)) ||
952 (-1 == papi->send (papi->cls,
953 n->primary_address.session,
957 cont, cont_cls)))) &&
959 cont (cont_cls, &n->id, GNUNET_SYSERR, msgbuf_size, 0);
960 GNUNET_break (NULL != papi);
965 * Master task run for every neighbour. Performs all of the time-related
966 * activities (keep alive, send next message, disconnect if idle, finish
967 * clean up after disconnect).
969 * @param cls the 'struct NeighbourMapEntry' for which we are running
970 * @param tc scheduler context (unused)
973 master_task (void *cls,
974 const struct GNUNET_SCHEDULER_TaskContext *tc);
978 * Function called when the 'DISCONNECT' message has been sent by the
979 * plugin. Frees the neighbour --- if the entry still exists.
982 * @param target identity of the neighbour that was disconnected
983 * @param result GNUNET_OK if the disconnect got out successfully
984 * @param payload bytes payload
985 * @param physical bytes physical
988 send_disconnect_cont (void *cls, const struct GNUNET_PeerIdentity *target,
989 int result, size_t payload, size_t physical)
991 struct NeighbourMapEntry *n;
993 n = lookup_neighbour (target);
995 return; /* already gone */
996 if (S_DISCONNECT != n->state)
997 return; /* have created a fresh entry since */
998 n->state = S_DISCONNECT;
999 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1000 GNUNET_SCHEDULER_cancel (n->task);
1001 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1006 * Transmit a DISCONNECT message to the other peer.
1008 * @param n neighbour to send DISCONNECT message.
1011 send_disconnect (struct NeighbourMapEntry *n)
1013 struct SessionDisconnectMessage disconnect_msg;
1015 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1016 "Sending DISCONNECT message to peer `%4s'\n",
1017 GNUNET_i2s (&n->id));
1018 disconnect_msg.header.size = htons (sizeof (struct SessionDisconnectMessage));
1019 disconnect_msg.header.type =
1020 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
1021 disconnect_msg.reserved = htonl (0);
1022 disconnect_msg.purpose.size =
1023 htonl (sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) +
1024 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
1025 sizeof (struct GNUNET_TIME_AbsoluteNBO));
1026 disconnect_msg.purpose.purpose =
1027 htonl (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT);
1028 disconnect_msg.timestamp =
1029 GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get ());
1030 disconnect_msg.public_key = GST_my_public_key;
1031 GNUNET_assert (GNUNET_OK ==
1032 GNUNET_CRYPTO_rsa_sign (GST_my_private_key,
1033 &disconnect_msg.purpose,
1034 &disconnect_msg.signature));
1036 send_with_session (n,
1037 (const char *) &disconnect_msg, sizeof (disconnect_msg),
1038 UINT32_MAX, GNUNET_TIME_UNIT_FOREVER_REL,
1039 &send_disconnect_cont, NULL);
1040 GNUNET_STATISTICS_update (GST_stats,
1042 ("# DISCONNECT messages sent"), 1,
1048 * Disconnect from the given neighbour, clean up the record.
1050 * @param n neighbour to disconnect from
1053 disconnect_neighbour (struct NeighbourMapEntry *n)
1055 /* depending on state, notify neighbour and/or upper layers of this peer
1059 case S_NOT_CONNECTED:
1061 case S_INIT_BLACKLIST:
1062 /* other peer is completely unaware of us, no need to send DISCONNECT */
1063 n->state = S_DISCONNECT_FINISHED;
1064 free_neighbour (n, GNUNET_NO);
1066 case S_CONNECT_SENT:
1067 send_disconnect (n);
1068 n->state = S_DISCONNECT;
1070 case S_CONNECT_RECV_BLACKLIST_INBOUND:
1071 case S_CONNECT_RECV_ATS:
1072 case S_CONNECT_RECV_BLACKLIST:
1073 /* we never ACK'ed the other peer's request, no need to send DISCONNECT */
1074 n->state = S_DISCONNECT_FINISHED;
1075 free_neighbour (n, GNUNET_NO);
1077 case S_CONNECT_RECV_ACK:
1078 /* we DID ACK the other peer's request, must send DISCONNECT */
1079 send_disconnect (n);
1080 n->state = S_DISCONNECT;
1083 case S_RECONNECT_BLACKLIST:
1084 case S_RECONNECT_SENT:
1085 case S_CONNECTED_SWITCHING_BLACKLIST:
1086 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1087 /* we are currently connected, need to send disconnect and do
1088 internal notifications and update statistics */
1089 send_disconnect (n);
1090 GNUNET_STATISTICS_set (GST_stats,
1091 gettext_noop ("# peers connected"),
1092 --neighbours_connected,
1094 disconnect_notify_cb (callback_cls, &n->id);
1095 n->state = S_DISCONNECT;
1097 case S_RECONNECT_ATS:
1098 /* ATS address request timeout, disconnect without sending disconnect message */
1099 GNUNET_STATISTICS_set (GST_stats,
1100 gettext_noop ("# peers connected"),
1101 --neighbours_connected,
1103 disconnect_notify_cb (callback_cls, &n->id);
1104 n->state = S_DISCONNECT;
1107 /* already disconnected, ignore */
1109 case S_DISCONNECT_FINISHED:
1110 /* already cleaned up, how did we get here!? */
1114 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
1118 /* schedule timeout to clean up */
1119 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1120 GNUNET_SCHEDULER_cancel (n->task);
1121 n->task = GNUNET_SCHEDULER_add_delayed (DISCONNECT_SENT_TIMEOUT,
1127 * We're done with our transmission attempt, continue processing.
1129 * @param cls the 'struct MessageQueue' of the message
1130 * @param receiver intended receiver
1131 * @param success whether it worked or not
1132 * @param size_payload bytes payload sent
1133 * @param physical bytes sent on wire
1136 transmit_send_continuation (void *cls,
1137 const struct GNUNET_PeerIdentity *receiver,
1138 int success, size_t size_payload, size_t physical)
1140 struct MessageQueue *mq = cls;
1141 struct NeighbourMapEntry *n;
1143 if (NULL == (n = lookup_neighbour (receiver)))
1146 return; /* disconnect or other error while transmitting, can happen */
1148 if (n->is_active == mq)
1150 /* this is still "our" neighbour, remove us from its queue
1151 and allow it to send the next message now */
1152 n->is_active = NULL;
1153 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1154 GNUNET_SCHEDULER_cancel (n->task);
1155 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1157 if (bytes_in_send_queue < mq->message_buf_size)
1159 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1160 "Bytes_in_send_queue `%u', Message_size %u, result: %s, payload %u, on wire %u\n",
1161 bytes_in_send_queue, mq->message_buf_size,
1162 (GNUNET_OK == success) ? "OK" : "FAIL",
1163 size_payload, physical);
1168 GNUNET_break (size_payload == mq->message_buf_size);
1169 bytes_in_send_queue -= mq->message_buf_size;
1170 GNUNET_STATISTICS_set (GST_stats,
1172 ("# bytes in message queue for other peers"),
1173 bytes_in_send_queue, GNUNET_NO);
1174 if (GNUNET_OK == success)
1175 GNUNET_STATISTICS_update (GST_stats,
1177 ("# messages transmitted to other peers"),
1180 GNUNET_STATISTICS_update (GST_stats,
1182 ("# transmission failures for messages to other peers"),
1184 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1185 "Sending message to `%s' of type %u was a %s\n",
1186 GNUNET_i2s (receiver),
1187 ntohs (((struct GNUNET_MessageHeader *) mq->message_buf)->type),
1188 (success == GNUNET_OK) ? "success" : "FAILURE");
1189 if (NULL != mq->cont)
1190 mq->cont (mq->cont_cls, success, size_payload, physical);
1196 * Check the message list for the given neighbour and if we can
1197 * send a message, do so. This function should only be called
1198 * if the connection is at least generally ready for transmission.
1199 * While we will only send one message at a time, no bandwidth
1200 * quota management is performed here. If a message was given to
1201 * the plugin, the continuation will automatically re-schedule
1202 * the 'master' task once the next message might be transmitted.
1204 * @param n target peer for which to transmit
1207 try_transmission_to_peer (struct NeighbourMapEntry *n)
1209 struct MessageQueue *mq;
1210 struct GNUNET_TIME_Relative timeout;
1212 if (NULL == n->primary_address.address)
1214 /* no address, why are we here? */
1218 if ((0 == n->primary_address.address->address_length) &&
1219 (NULL == n->primary_address.session))
1221 /* no address, why are we here? */
1225 if (NULL != n->is_active)
1227 /* transmission already pending */
1231 /* timeout messages from the queue that are past their due date */
1232 while (NULL != (mq = n->messages_head))
1234 timeout = GNUNET_TIME_absolute_get_remaining (mq->timeout);
1235 if (timeout.rel_value > 0)
1237 GNUNET_STATISTICS_update (GST_stats,
1239 ("# messages timed out while in transport queue"),
1241 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
1243 transmit_send_continuation (mq, &n->id, GNUNET_SYSERR, mq->message_buf_size, 0); /* timeout */
1246 return; /* no more messages */
1247 GNUNET_CONTAINER_DLL_remove (n->messages_head, n->messages_tail, mq);
1249 send_with_session (n,
1250 mq->message_buf, mq->message_buf_size,
1251 0 /* priority */, timeout,
1252 &transmit_send_continuation, mq);
1257 * Send keepalive message to the neighbour. Must only be called
1258 * if we are on 'connected' state or while trying to switch addresses.
1259 * Will internally determine if a keepalive is truly needed (so can
1260 * always be called).
1262 * @param n neighbour that went idle and needs a keepalive
1265 send_keepalive (struct NeighbourMapEntry *n)
1267 struct GNUNET_MessageHeader m;
1269 GNUNET_assert ((S_CONNECTED == n->state) ||
1270 (S_CONNECTED_SWITCHING_BLACKLIST == n->state) ||
1271 (S_CONNECTED_SWITCHING_CONNECT_SENT));
1272 if (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time).rel_value > 0)
1273 return; /* no keepalive needed at this time */
1274 m.size = htons (sizeof (struct GNUNET_MessageHeader));
1275 m.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE);
1276 send_with_session (n,
1277 (const void *) &m, sizeof (m),
1278 UINT32_MAX /* priority */,
1279 KEEPALIVE_FREQUENCY,
1281 GNUNET_STATISTICS_update (GST_stats, gettext_noop ("# keepalives sent"), 1,
1283 n->expect_latency_response = GNUNET_YES;
1284 n->last_keep_alive_time = GNUNET_TIME_absolute_get ();
1285 n->keep_alive_time = GNUNET_TIME_relative_to_absolute (KEEPALIVE_FREQUENCY);
1290 * Keep the connection to the given neighbour alive longer,
1291 * we received a KEEPALIVE (or equivalent); send a response.
1293 * @param neighbour neighbour to keep alive (by sending keep alive response)
1296 GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour)
1298 struct NeighbourMapEntry *n;
1299 struct GNUNET_MessageHeader m;
1301 if (NULL == (n = lookup_neighbour (neighbour)))
1303 GNUNET_STATISTICS_update (GST_stats,
1305 ("# KEEPALIVE messages discarded (peer unknown)"),
1309 if (NULL == n->primary_address.session)
1311 GNUNET_STATISTICS_update (GST_stats,
1313 ("# KEEPALIVE messages discarded (no session)"),
1317 /* send reply to allow neighbour to measure latency */
1318 m.size = htons (sizeof (struct GNUNET_MessageHeader));
1319 m.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_KEEPALIVE_RESPONSE);
1320 send_with_session(n,
1321 (const void *) &m, sizeof (m),
1322 UINT32_MAX /* priority */,
1323 KEEPALIVE_FREQUENCY,
1329 * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
1330 * latency to this peer. Pass the updated information (existing ats
1331 * plus calculated latency) to ATS.
1333 * @param neighbour neighbour to keep alive
1334 * @param ats performance data
1335 * @param ats_count number of entries in ats
1338 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
1339 const struct GNUNET_ATS_Information *ats,
1342 struct NeighbourMapEntry *n;
1344 struct GNUNET_ATS_Information ats_new[ats_count + 1];
1346 if (NULL == (n = lookup_neighbour (neighbour)))
1348 GNUNET_STATISTICS_update (GST_stats,
1350 ("# KEEPALIVE_RESPONSE messages discarded (not connected)"),
1354 if ( (S_CONNECTED != n->state) ||
1355 (GNUNET_YES != n->expect_latency_response) )
1357 GNUNET_STATISTICS_update (GST_stats,
1359 ("# KEEPALIVE_RESPONSE messages discarded (not expected)"),
1363 n->expect_latency_response = GNUNET_NO;
1364 n->latency = GNUNET_TIME_absolute_get_duration (n->last_keep_alive_time);
1365 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1366 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1367 "Latency for peer `%s' is %llu ms\n",
1368 GNUNET_i2s (&n->id), n->latency.rel_value);
1369 memcpy (ats_new, ats, sizeof (struct GNUNET_ATS_Information) * ats_count);
1370 /* append latency */
1371 ats_new[ats_count].type = htonl (GNUNET_ATS_QUALITY_NET_DELAY);
1372 if (n->latency.rel_value > UINT32_MAX)
1373 latency = UINT32_MAX;
1375 latency = n->latency.rel_value;
1376 ats_new[ats_count].value = htonl (latency);
1377 GNUNET_ATS_address_update (GST_ats,
1378 n->primary_address.address,
1379 n->primary_address.session, ats_new,
1385 * We have received a message from the given sender. How long should
1386 * we delay before receiving more? (Also used to keep the peer marked
1389 * @param sender sender of the message
1390 * @param size size of the message
1391 * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
1392 * GNUNET_NO if the neighbour is not connected or violates the quota,
1393 * GNUNET_SYSERR if the connection is not fully up yet
1394 * @return how long to wait before reading more from this sender
1396 struct GNUNET_TIME_Relative
1397 GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
1398 *sender, ssize_t size, int *do_forward)
1400 struct NeighbourMapEntry *n;
1401 struct GNUNET_TIME_Relative ret;
1403 if (NULL == neighbours)
1405 *do_forward = GNUNET_NO;
1406 return GNUNET_TIME_UNIT_FOREVER_REL; /* This can happen during shutdown */
1408 if (NULL == (n = lookup_neighbour (sender)))
1410 GST_neighbours_try_connect (sender);
1411 if (NULL == (n = lookup_neighbour (sender)))
1413 GNUNET_STATISTICS_update (GST_stats,
1415 ("# messages discarded due to lack of neighbour record"),
1417 *do_forward = GNUNET_NO;
1418 return GNUNET_TIME_UNIT_ZERO;
1421 if (! test_connected (n))
1423 *do_forward = GNUNET_SYSERR;
1424 return GNUNET_TIME_UNIT_ZERO;
1426 if (GNUNET_YES == GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, size))
1428 n->quota_violation_count++;
1429 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1430 "Bandwidth quota (%u b/s) violation detected (total of %u).\n",
1431 n->in_tracker.available_bytes_per_s__,
1432 n->quota_violation_count);
1433 /* Discount 32k per violation */
1434 GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, -32 * 1024);
1438 if (n->quota_violation_count > 0)
1440 /* try to add 32k back */
1441 GNUNET_BANDWIDTH_tracker_consume (&n->in_tracker, 32 * 1024);
1442 n->quota_violation_count--;
1445 if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
1447 GNUNET_STATISTICS_update (GST_stats,
1449 ("# bandwidth quota violations by other peers"),
1451 *do_forward = GNUNET_NO;
1452 return GNUNET_CONSTANTS_QUOTA_VIOLATION_TIMEOUT;
1454 *do_forward = GNUNET_YES;
1455 ret = GNUNET_BANDWIDTH_tracker_get_delay (&n->in_tracker, 32 * 1024);
1456 if (ret.rel_value > 0)
1458 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1459 "Throttling read (%llu bytes excess at %u b/s), waiting %llu ms before reading more.\n",
1460 (unsigned long long) n->in_tracker.
1461 consumption_since_last_update__,
1462 (unsigned int) n->in_tracker.available_bytes_per_s__,
1463 (unsigned long long) ret.rel_value);
1464 GNUNET_STATISTICS_update (GST_stats,
1465 gettext_noop ("# ms throttling suggested"),
1466 (int64_t) ret.rel_value, GNUNET_NO);
1473 * Transmit a message to the given target using the active connection.
1475 * @param target destination
1476 * @param msg message to send
1477 * @param msg_size number of bytes in msg
1478 * @param timeout when to fail with timeout
1479 * @param cont function to call when done
1480 * @param cont_cls closure for 'cont'
1483 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
1484 size_t msg_size, struct GNUNET_TIME_Relative timeout,
1485 GST_NeighbourSendContinuation cont, void *cont_cls)
1487 struct NeighbourMapEntry *n;
1488 struct MessageQueue *mq;
1490 /* All ove these cases should never happen; they are all API violations.
1491 But we check anyway, just to be sure. */
1492 if (NULL == (n = lookup_neighbour (target)))
1496 cont (cont_cls, GNUNET_SYSERR, msg_size, 0);
1499 if (GNUNET_YES != test_connected (n))
1503 cont (cont_cls, GNUNET_SYSERR, msg_size, 0);
1506 bytes_in_send_queue += msg_size;
1507 GNUNET_STATISTICS_set (GST_stats,
1509 ("# bytes in message queue for other peers"),
1510 bytes_in_send_queue, GNUNET_NO);
1511 mq = GNUNET_malloc (sizeof (struct MessageQueue) + msg_size);
1513 mq->cont_cls = cont_cls;
1514 memcpy (&mq[1], msg, msg_size);
1515 mq->message_buf = (const char *) &mq[1];
1516 mq->message_buf_size = msg_size;
1517 mq->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1518 GNUNET_CONTAINER_DLL_insert_tail (n->messages_head, n->messages_tail, mq);
1519 if ( (NULL != n->is_active) ||
1520 ( (NULL == n->primary_address.session) && (NULL == n->primary_address.address)) )
1522 if (GNUNET_SCHEDULER_NO_TASK != n->task)
1523 GNUNET_SCHEDULER_cancel (n->task);
1524 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1529 * Send a SESSION_CONNECT message via the given address.
1531 * @param na address to use
1534 send_session_connect (struct NeighbourAddress *na)
1536 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1537 struct SessionConnectMessage connect_msg;
1539 if (NULL == (papi = GST_plugins_find (na->address->transport_name)))
1544 if (NULL == na->session)
1545 na->session = papi->get_session (papi->cls, na->address);
1546 if (NULL == na->session)
1551 na->connect_timestamp = GNUNET_TIME_absolute_get ();
1552 connect_msg.header.size = htons (sizeof (struct SessionConnectMessage));
1553 connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT);
1554 connect_msg.reserved = htonl (0);
1555 connect_msg.timestamp = GNUNET_TIME_absolute_hton (na->connect_timestamp);
1556 (void) papi->send (papi->cls,
1558 (const char *) &connect_msg, sizeof (struct SessionConnectMessage),
1560 GNUNET_TIME_UNIT_FOREVER_REL,
1567 * Send a SESSION_CONNECT_ACK message via the given address.
1569 * @param address address to use
1570 * @param session session to use
1571 * @param timestamp timestamp to use for the ACK message
1574 send_session_connect_ack_message (const struct GNUNET_HELLO_Address *address,
1575 struct Session *session,
1576 struct GNUNET_TIME_Absolute timestamp)
1578 struct GNUNET_TRANSPORT_PluginFunctions *papi;
1579 struct SessionConnectMessage connect_msg;
1581 if (NULL == (papi = GST_plugins_find (address->transport_name)))
1586 if (NULL == session)
1587 session = papi->get_session (papi->cls, address);
1588 if (NULL == session)
1593 connect_msg.header.size = htons (sizeof (struct SessionConnectMessage));
1594 connect_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_CONNECT_ACK);
1595 connect_msg.reserved = htonl (0);
1596 connect_msg.timestamp = GNUNET_TIME_absolute_hton (timestamp);
1597 (void) papi->send (papi->cls,
1599 (const char *) &connect_msg, sizeof (struct SessionConnectMessage),
1601 GNUNET_TIME_UNIT_FOREVER_REL,
1608 * Create a fresh entry in the neighbour map for the given peer
1610 * @param peer peer to create an entry for
1611 * @return new neighbour map entry
1613 static struct NeighbourMapEntry *
1614 setup_neighbour (const struct GNUNET_PeerIdentity *peer)
1616 struct NeighbourMapEntry *n;
1618 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1619 "Creating new neighbour entry for `%s'\n",
1621 n = GNUNET_malloc (sizeof (struct NeighbourMapEntry));
1623 n->state = S_NOT_CONNECTED;
1624 n->latency = GNUNET_TIME_UNIT_FOREVER_REL;
1625 GNUNET_BANDWIDTH_tracker_init (&n->in_tracker,
1626 GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT,
1627 MAX_BANDWIDTH_CARRY_S);
1628 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
1629 GNUNET_assert (GNUNET_OK ==
1630 GNUNET_CONTAINER_multihashmap_put (neighbours,
1631 &n->id.hashPubKey, n,
1632 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
1638 * Check if the two given addresses are the same.
1639 * Actually only checks if the sessions are non-NULL
1640 * (which they should be) and then if they are identical;
1641 * the actual addresses don't matter if the session
1642 * pointers match anyway, and we must have session pointers
1645 * @param a1 first address to compare
1646 * @param a2 other address to compare
1647 * @return GNUNET_NO if the addresses do not match, GNUNET_YES if they do match
1650 address_matches (const struct NeighbourAddress *a1,
1651 const struct NeighbourAddress *a2)
1653 if ( (NULL == a1->session) ||
1654 (NULL == a2->session) )
1659 return (a1->session == a2->session) ? GNUNET_YES : GNUNET_NO;
1664 * Try to create a connection to the given target (eventually).
1666 * @param target peer to try to connect to
1669 GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target)
1671 struct NeighbourMapEntry *n;
1673 if (NULL == neighbours)
1674 return; /* during shutdown, do nothing */
1675 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1676 "Asked to connect to peer `%s'\n",
1677 GNUNET_i2s (target));
1679 memcmp (target, &GST_my_identity, sizeof (struct GNUNET_PeerIdentity)))
1681 /* refuse to connect to myself */
1682 /* FIXME: can this happen? Is this not an API violation? */
1683 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1684 "Refusing to try to connect to myself.\n");
1687 n = lookup_neighbour (target);
1692 case S_NOT_CONNECTED:
1693 /* this should not be possible */
1695 free_neighbour (n, GNUNET_NO);
1698 case S_INIT_BLACKLIST:
1699 case S_CONNECT_SENT:
1700 case S_CONNECT_RECV_BLACKLIST_INBOUND:
1701 case S_CONNECT_RECV_ATS:
1702 case S_CONNECT_RECV_BLACKLIST:
1703 case S_CONNECT_RECV_ACK:
1704 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1705 "Ignoring request to try to connect to `%s', already trying!\n",
1706 GNUNET_i2s (target));
1707 return; /* already trying */
1709 case S_RECONNECT_ATS:
1710 case S_RECONNECT_BLACKLIST:
1711 case S_RECONNECT_SENT:
1712 case S_CONNECTED_SWITCHING_BLACKLIST:
1713 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1714 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1715 "Ignoring request to try to connect, already connected to `%s'!\n",
1716 GNUNET_i2s (target));
1717 return; /* already connected */
1719 /* get rid of remains, ready to re-try immediately */
1720 free_neighbour (n, GNUNET_NO);
1722 case S_DISCONNECT_FINISHED:
1723 /* should not be possible */
1726 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
1728 free_neighbour (n, GNUNET_NO);
1732 n = setup_neighbour (target);
1733 n->state = S_INIT_ATS;
1734 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1736 GNUNET_ATS_reset_backoff (GST_ats, target);
1737 GNUNET_ATS_suggest_address (GST_ats, target);
1742 * Function called with the result of a blacklist check.
1744 * @param cls closure with the 'struct BlackListCheckContext'
1745 * @param peer peer this check affects
1746 * @param result GNUNET_OK if the address is allowed
1749 handle_test_blacklist_cont (void *cls,
1750 const struct GNUNET_PeerIdentity *peer,
1753 struct BlackListCheckContext *bcc = cls;
1754 struct NeighbourMapEntry *n;
1757 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1758 "Connection to new address of peer `%s' based on blacklist is `%s'\n",
1760 (GNUNET_OK == result) ? "allowed" : "FORBIDDEN");
1761 if (NULL == (n = lookup_neighbour (peer)))
1762 goto cleanup; /* nobody left to care about new address */
1765 case S_NOT_CONNECTED:
1766 /* this should not be possible */
1768 free_neighbour (n, GNUNET_NO);
1771 /* still waiting on ATS suggestion */
1773 case S_INIT_BLACKLIST:
1774 /* check if the address the blacklist was fine with matches
1775 ATS suggestion, if so, we can move on! */
1776 if ( (GNUNET_OK == result) &&
1777 (1 == n->send_connect_ack) )
1779 n->send_connect_ack = 2;
1780 send_session_connect_ack_message (bcc->na.address,
1782 n->connect_ack_timestamp);
1784 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1785 break; /* result for an address we currently don't care about */
1786 if (GNUNET_OK == result)
1788 n->timeout = GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT);
1789 n->state = S_CONNECT_SENT;
1790 send_session_connect (&n->primary_address);
1794 // FIXME: should also possibly destroy session with plugin!?
1795 GNUNET_ATS_address_destroyed (GST_ats,
1798 free_address (&n->primary_address);
1799 n->state = S_INIT_ATS;
1800 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1801 // FIXME: do we need to ask ATS again for suggestions?
1802 GNUNET_ATS_suggest_address (GST_ats, &n->id);
1805 case S_CONNECT_SENT:
1806 /* waiting on CONNECT_ACK, send ACK if one is pending */
1807 if ( (GNUNET_OK == result) &&
1808 (1 == n->send_connect_ack) )
1810 n->send_connect_ack = 2;
1811 send_session_connect_ack_message (n->primary_address.address,
1812 n->primary_address.session,
1813 n->connect_ack_timestamp);
1816 case S_CONNECT_RECV_BLACKLIST_INBOUND:
1817 if (GNUNET_OK == result)
1819 /* valid new address, let ATS know! */
1820 GNUNET_ATS_address_add (GST_ats,
1823 bcc->ats, bcc->ats_count);
1825 n->state = S_CONNECT_RECV_ATS;
1826 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1827 GNUNET_ATS_reset_backoff (GST_ats, peer);
1828 GNUNET_ATS_suggest_address (GST_ats, peer);
1830 case S_CONNECT_RECV_ATS:
1831 /* still waiting on ATS suggestion, don't care about blacklist */
1833 case S_CONNECT_RECV_BLACKLIST:
1834 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1835 break; /* result for an address we currently don't care about */
1836 if (GNUNET_OK == result)
1838 n->timeout = GNUNET_TIME_relative_to_absolute (SETUP_CONNECTION_TIMEOUT);
1839 n->state = S_CONNECT_RECV_ACK;
1840 send_session_connect_ack_message (bcc->na.address,
1842 n->connect_ack_timestamp);
1843 if (1 == n->send_connect_ack)
1844 n->send_connect_ack = 2;
1848 // FIXME: should also possibly destroy session with plugin!?
1849 GNUNET_ATS_address_destroyed (GST_ats,
1852 free_address (&n->primary_address);
1853 n->state = S_INIT_ATS;
1854 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1855 // FIXME: do we need to ask ATS again for suggestions?
1856 GNUNET_ATS_reset_backoff (GST_ats, peer);
1857 GNUNET_ATS_suggest_address (GST_ats, &n->id);
1860 case S_CONNECT_RECV_ACK:
1861 /* waiting on SESSION_ACK, send ACK if one is pending */
1862 if ( (GNUNET_OK == result) &&
1863 (1 == n->send_connect_ack) )
1865 n->send_connect_ack = 2;
1866 send_session_connect_ack_message (n->primary_address.address,
1867 n->primary_address.session,
1868 n->connect_ack_timestamp);
1872 /* already connected, don't care about blacklist */
1874 case S_RECONNECT_ATS:
1875 /* still waiting on ATS suggestion, don't care about blacklist */
1877 case S_RECONNECT_BLACKLIST:
1878 if ( (GNUNET_OK == result) &&
1879 (1 == n->send_connect_ack) )
1881 n->send_connect_ack = 2;
1882 send_session_connect_ack_message (bcc->na.address,
1884 n->connect_ack_timestamp);
1886 if (GNUNET_YES != address_matches (&bcc->na, &n->primary_address))
1887 break; /* result for an address we currently don't care about */
1888 if (GNUNET_OK == result)
1890 send_session_connect (&n->primary_address);
1891 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
1892 n->state = S_RECONNECT_SENT;
1896 GNUNET_ATS_address_destroyed (GST_ats,
1899 n->state = S_RECONNECT_ATS;
1900 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
1901 // FIXME: do we need to ask ATS again for suggestions?
1902 GNUNET_ATS_suggest_address (GST_ats, &n->id);
1905 case S_RECONNECT_SENT:
1906 /* waiting on CONNECT_ACK, don't care about blacklist */
1907 if ( (GNUNET_OK == result) &&
1908 (1 == n->send_connect_ack) )
1910 n->send_connect_ack = 2;
1911 send_session_connect_ack_message (n->primary_address.address,
1912 n->primary_address.session,
1913 n->connect_ack_timestamp);
1916 case S_CONNECTED_SWITCHING_BLACKLIST:
1917 if (GNUNET_YES != address_matches (&bcc->na, &n->alternative_address))
1918 break; /* result for an address we currently don't care about */
1919 if (GNUNET_OK == result)
1921 send_session_connect (&n->alternative_address);
1922 n->state = S_CONNECTED_SWITCHING_CONNECT_SENT;
1926 GNUNET_ATS_address_destroyed (GST_ats,
1929 free_address (&n->alternative_address);
1930 n->state = S_CONNECTED;
1933 case S_CONNECTED_SWITCHING_CONNECT_SENT:
1934 /* waiting on CONNECT_ACK, don't care about blacklist */
1935 if ( (GNUNET_OK == result) &&
1936 (1 == n->send_connect_ack) )
1938 n->send_connect_ack = 2;
1939 send_session_connect_ack_message (n->primary_address.address,
1940 n->primary_address.session,
1941 n->connect_ack_timestamp);
1945 /* Nothing to do here, ATS will already do what can be done */
1947 case S_DISCONNECT_FINISHED:
1948 /* should not be possible */
1952 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
1954 free_neighbour (n, GNUNET_NO);
1958 GNUNET_HELLO_address_free (bcc->na.address);
1959 GNUNET_CONTAINER_DLL_remove (bc_head,
1967 * We want to know if connecting to a particular peer via
1968 * a particular address is allowed. Check it!
1970 * @param peer identity of the peer to switch the address for
1971 * @param ts time at which the check was initiated
1972 * @param address address of the other peer, NULL if other peer
1974 * @param session session to use (or NULL)
1975 * @param ats performance data
1976 * @param ats_count number of entries in ats (excluding 0-termination)
1979 check_blacklist (const struct GNUNET_PeerIdentity *peer,
1980 struct GNUNET_TIME_Absolute ts,
1981 const struct GNUNET_HELLO_Address *address,
1982 struct Session *session,
1983 const struct GNUNET_ATS_Information *ats,
1986 struct BlackListCheckContext *bcc;
1987 struct GST_BlacklistCheck *bc;
1990 GNUNET_malloc (sizeof (struct BlackListCheckContext) +
1991 sizeof (struct GNUNET_ATS_Information) * ats_count);
1992 bcc->ats_count = ats_count;
1993 bcc->na.address = GNUNET_HELLO_address_copy (address);
1994 bcc->na.session = session;
1995 bcc->na.connect_timestamp = ts;
1996 bcc->ats = (struct GNUNET_ATS_Information *) &bcc[1];
1997 memcpy (bcc->ats, ats, sizeof (struct GNUNET_ATS_Information) * ats_count);
1998 GNUNET_CONTAINER_DLL_insert (bc_head,
2001 if (NULL != (bc = GST_blacklist_test_allowed (peer,
2002 address->transport_name,
2003 &handle_test_blacklist_cont, bcc)))
2005 /* if NULL == bc, 'cont' was already called and 'bcc' already free'd, so
2006 we must only store 'bc' if 'bc' is non-NULL... */
2011 * We received a 'SESSION_CONNECT' message from the other peer.
2012 * Consider switching to it.
2014 * @param message possibly a 'struct SessionConnectMessage' (check format)
2015 * @param peer identity of the peer to switch the address for
2016 * @param address address of the other peer, NULL if other peer
2018 * @param session session to use (or NULL)
2019 * @param ats performance data
2020 * @param ats_count number of entries in ats (excluding 0-termination)
2023 GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
2024 const struct GNUNET_PeerIdentity *peer,
2025 const struct GNUNET_HELLO_Address *address,
2026 struct Session *session,
2027 const struct GNUNET_ATS_Information *ats,
2030 const struct SessionConnectMessage *scm;
2031 struct NeighbourMapEntry *n;
2032 struct GNUNET_TIME_Absolute ts;
2034 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2035 "Received CONNECT message from peer `%s'\n",
2038 if (ntohs (message->size) != sizeof (struct SessionConnectMessage))
2040 GNUNET_break_op (0);
2043 if (NULL == neighbours)
2044 return; /* we're shutting down */
2045 scm = (const struct SessionConnectMessage *) message;
2046 GNUNET_break_op (0 == ntohl (scm->reserved));
2047 ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
2048 n = lookup_neighbour (peer);
2050 n = setup_neighbour (peer);
2051 n->send_connect_ack = 1;
2052 n->connect_ack_timestamp = ts;
2056 case S_NOT_CONNECTED:
2057 n->state = S_CONNECT_RECV_BLACKLIST_INBOUND;
2058 /* Do a blacklist check for the new address */
2059 check_blacklist (peer, ts, address, session, ats, ats_count);
2062 /* CONNECT message takes priority over us asking ATS for address */
2063 n->state = S_CONNECT_RECV_BLACKLIST_INBOUND;
2065 case S_INIT_BLACKLIST:
2066 case S_CONNECT_SENT:
2067 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2068 case S_CONNECT_RECV_ATS:
2069 case S_CONNECT_RECV_BLACKLIST:
2070 case S_CONNECT_RECV_ACK:
2071 /* It can never hurt to have an alternative address in the above cases,
2072 see if it is allowed */
2073 check_blacklist (peer, ts, address, session, ats, ats_count);
2076 /* we are already connected and can thus send the ACK immediately;
2077 still, it can never hurt to have an alternative address, so also
2078 tell ATS about it */
2079 GNUNET_assert (NULL != n->primary_address.address);
2080 GNUNET_assert (NULL != n->primary_address.session);
2081 n->send_connect_ack = 0;
2082 send_session_connect_ack_message (n->primary_address.address,
2083 n->primary_address.session, ts);
2084 check_blacklist (peer, ts, address, session, ats, ats_count);
2086 case S_RECONNECT_ATS:
2087 case S_RECONNECT_BLACKLIST:
2088 case S_RECONNECT_SENT:
2089 /* It can never hurt to have an alternative address in the above cases,
2090 see if it is allowed */
2091 check_blacklist (peer, ts, address, session, ats, ats_count);
2093 case S_CONNECTED_SWITCHING_BLACKLIST:
2094 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2095 /* we are already connected and can thus send the ACK immediately;
2096 still, it can never hurt to have an alternative address, so also
2097 tell ATS about it */
2098 GNUNET_assert (NULL != n->primary_address.address);
2099 GNUNET_assert (NULL != n->primary_address.session);
2100 n->send_connect_ack = 0;
2101 send_session_connect_ack_message (n->primary_address.address,
2102 n->primary_address.session, ts);
2103 check_blacklist (peer, ts, address, session, ats, ats_count);
2106 /* get rid of remains without terminating sessions, ready to re-try */
2107 free_neighbour (n, GNUNET_YES);
2108 n = setup_neighbour (peer);
2109 n->state = S_CONNECT_RECV_ATS;
2110 GNUNET_ATS_reset_backoff (GST_ats, peer);
2111 GNUNET_ATS_suggest_address (GST_ats, peer);
2113 case S_DISCONNECT_FINISHED:
2114 /* should not be possible */
2118 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
2120 free_neighbour (n, GNUNET_NO);
2127 * For an existing neighbour record, set the active connection to
2128 * use the given address.
2130 * @param peer identity of the peer to switch the address for
2131 * @param address address of the other peer, NULL if other peer
2133 * @param session session to use (or NULL)
2134 * @param ats performance data
2135 * @param ats_count number of entries in ats
2136 * @param bandwidth_in inbound quota to be used when connection is up
2137 * @param bandwidth_out outbound quota to be used when connection is up
2140 GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
2141 const struct GNUNET_HELLO_Address *address,
2142 struct Session *session,
2143 const struct GNUNET_ATS_Information *ats,
2145 struct GNUNET_BANDWIDTH_Value32NBO
2147 struct GNUNET_BANDWIDTH_Value32NBO
2150 struct NeighbourMapEntry *n;
2151 struct GNUNET_TRANSPORT_PluginFunctions *papi;
2153 GNUNET_assert (address->transport_name != NULL);
2154 if (NULL == (n = lookup_neighbour (peer)))
2157 /* Obtain an session for this address from plugin */
2158 if (NULL == (papi = GST_plugins_find (address->transport_name)))
2160 /* we don't have the plugin for this address */
2161 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2164 if ((NULL == session) && (0 == address->address_length))
2167 if (strlen (address->transport_name) > 0)
2168 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2172 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2173 "ATS tells us to switch to address '%s' session %p for "
2174 "peer `%s' in state %s (quota in/out %u %u )\n",
2175 (address->address_length != 0) ? GST_plugins_a2s (address): "<inbound>",
2178 print_state (n->state),
2179 ntohl (bandwidth_in.value__),
2180 ntohl (bandwidth_out.value__));
2182 if (NULL == session)
2184 session = papi->get_session (papi->cls, address);
2185 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2186 "Obtained new session for peer `%s' and address '%s': %p\n",
2187 GNUNET_i2s (&address->peer), GST_plugins_a2s (address), session);
2189 if (NULL == session)
2191 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2192 "Failed to obtain new session for peer `%s' and address '%s'\n",
2193 GNUNET_i2s (&address->peer), GST_plugins_a2s (address));
2194 GNUNET_ATS_address_destroyed (GST_ats, address, NULL);
2199 case S_NOT_CONNECTED:
2201 free_neighbour (n, GNUNET_NO);
2204 set_address (&n->primary_address,
2205 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2206 n->state = S_INIT_BLACKLIST;
2207 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2208 check_blacklist (&n->id,
2209 n->connect_ack_timestamp,
2210 address, session, ats, ats_count);
2212 case S_INIT_BLACKLIST:
2213 /* ATS suggests a different address, switch again */
2214 set_address (&n->primary_address,
2215 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2216 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2217 check_blacklist (&n->id,
2218 n->connect_ack_timestamp,
2219 address, session, ats, ats_count);
2221 case S_CONNECT_SENT:
2222 /* ATS suggests a different address, switch again */
2223 set_address (&n->primary_address,
2224 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2225 n->state = S_INIT_BLACKLIST;
2226 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2227 check_blacklist (&n->id,
2228 n->connect_ack_timestamp,
2229 address, session, ats, ats_count);
2231 case S_CONNECT_RECV_ATS:
2232 set_address (&n->primary_address,
2233 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2234 n->state = S_CONNECT_RECV_BLACKLIST;
2235 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2236 check_blacklist (&n->id,
2237 n->connect_ack_timestamp,
2238 address, session, ats, ats_count);
2240 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2241 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2242 check_blacklist (&n->id,
2243 n->connect_ack_timestamp,
2244 address, session, ats, ats_count);
2246 case S_CONNECT_RECV_BLACKLIST:
2247 case S_CONNECT_RECV_ACK:
2248 /* ATS asks us to switch while we were trying to connect; switch to new
2249 address and check blacklist again */
2250 set_address (&n->primary_address,
2251 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2252 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2253 check_blacklist (&n->id,
2254 n->connect_ack_timestamp,
2255 address, session, ats, ats_count);
2258 GNUNET_assert (NULL != n->primary_address.address);
2259 GNUNET_assert (NULL != n->primary_address.session);
2260 if (n->primary_address.session == session)
2262 /* not an address change, just a quota change */
2263 set_address (&n->primary_address,
2264 address, session, bandwidth_in, bandwidth_out, GNUNET_YES);
2267 /* ATS asks us to switch a life connection; see if we can get
2268 a CONNECT_ACK on it before we actually do this! */
2269 set_address (&n->alternative_address,
2270 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2271 n->state = S_CONNECTED_SWITCHING_BLACKLIST;
2272 check_blacklist (&n->id,
2273 GNUNET_TIME_absolute_get (),
2274 address, session, ats, ats_count);
2276 case S_RECONNECT_ATS:
2277 set_address (&n->primary_address,
2278 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2279 n->state = S_RECONNECT_BLACKLIST;
2280 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2281 check_blacklist (&n->id,
2282 n->connect_ack_timestamp,
2283 address, session, ats, ats_count);
2285 case S_RECONNECT_BLACKLIST:
2286 /* ATS asks us to switch while we were trying to reconnect; switch to new
2287 address and check blacklist again */
2288 set_address (&n->primary_address,
2289 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2290 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2291 check_blacklist (&n->id,
2292 n->connect_ack_timestamp,
2293 address, session, ats, ats_count);
2295 case S_RECONNECT_SENT:
2296 /* ATS asks us to switch while we were trying to reconnect; switch to new
2297 address and check blacklist again */
2298 set_address (&n->primary_address,
2299 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2300 n->state = S_RECONNECT_BLACKLIST;
2301 n->timeout = GNUNET_TIME_relative_to_absolute (BLACKLIST_RESPONSE_TIMEOUT);
2302 check_blacklist (&n->id,
2303 n->connect_ack_timestamp,
2304 address, session, ats, ats_count);
2306 case S_CONNECTED_SWITCHING_BLACKLIST:
2307 if (n->primary_address.session == session)
2309 /* ATS switches back to still-active session */
2310 free_address (&n->alternative_address);
2311 n->state = S_CONNECTED;
2314 /* ATS asks us to switch a life connection, update blacklist check */
2315 set_address (&n->alternative_address,
2316 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2317 check_blacklist (&n->id,
2318 GNUNET_TIME_absolute_get (),
2319 address, session, ats, ats_count);
2321 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2322 if (n->primary_address.session == session)
2324 /* ATS switches back to still-active session */
2325 free_address (&n->alternative_address);
2326 n->state = S_CONNECTED;
2329 /* ATS asks us to switch a life connection, update blacklist check */
2330 set_address (&n->alternative_address,
2331 address, session, bandwidth_in, bandwidth_out, GNUNET_NO);
2332 n->state = S_CONNECTED_SWITCHING_BLACKLIST;
2333 check_blacklist (&n->id,
2334 GNUNET_TIME_absolute_get (),
2335 address, session, ats, ats_count);
2338 /* not going to switch addresses while disconnecting */
2340 case S_DISCONNECT_FINISHED:
2344 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
2352 * Master task run for every neighbour. Performs all of the time-related
2353 * activities (keep alive, send next message, disconnect if idle, finish
2354 * clean up after disconnect).
2356 * @param cls the 'struct NeighbourMapEntry' for which we are running
2357 * @param tc scheduler context (unused)
2360 master_task (void *cls,
2361 const struct GNUNET_SCHEDULER_TaskContext *tc)
2363 struct NeighbourMapEntry *n = cls;
2364 struct GNUNET_TIME_Relative delay;
2366 n->task = GNUNET_SCHEDULER_NO_TASK;
2367 delay = GNUNET_TIME_absolute_get_remaining (n->timeout);
2368 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2369 "Master task runs for neighbour `%s' in state %s with timeout in %llu ms\n",
2370 GNUNET_i2s (&n->id),
2371 print_state(n->state),
2372 (unsigned long long) delay.rel_value);
2375 case S_NOT_CONNECTED:
2376 /* invalid state for master task, clean up */
2378 n->state = S_DISCONNECT_FINISHED;
2379 free_neighbour (n, GNUNET_NO);
2382 if (0 == delay.rel_value)
2384 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2385 "Connection to `%s' timed out waiting for ATS to provide address\n",
2386 GNUNET_i2s (&n->id));
2387 n->state = S_DISCONNECT_FINISHED;
2388 free_neighbour (n, GNUNET_NO);
2392 case S_INIT_BLACKLIST:
2393 if (0 == delay.rel_value)
2395 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2396 "Connection to `%s' timed out waiting for BLACKLIST to approve address\n",
2397 GNUNET_i2s (&n->id));
2398 n->state = S_DISCONNECT_FINISHED;
2399 free_neighbour (n, GNUNET_NO);
2403 case S_CONNECT_SENT:
2404 if (0 == delay.rel_value)
2406 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2407 "Connection to `%s' timed out waiting for other peer to send CONNECT_ACK\n",
2408 GNUNET_i2s (&n->id));
2409 disconnect_neighbour (n);
2413 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2414 if (0 == delay.rel_value)
2416 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2417 "Connection to `%s' timed out waiting BLACKLIST to approve address to use for received CONNECT\n",
2418 GNUNET_i2s (&n->id));
2419 n->state = S_DISCONNECT_FINISHED;
2420 free_neighbour (n, GNUNET_NO);
2424 case S_CONNECT_RECV_ATS:
2425 if (0 == delay.rel_value)
2427 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2428 "Connection to `%s' timed out waiting ATS to provide address to use for CONNECT_ACK\n",
2429 GNUNET_i2s (&n->id));
2430 n->state = S_DISCONNECT_FINISHED;
2431 free_neighbour (n, GNUNET_NO);
2435 case S_CONNECT_RECV_BLACKLIST:
2436 if (0 == delay.rel_value)
2438 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2439 "Connection to `%s' timed out waiting BLACKLIST to approve address to use for CONNECT_ACK\n",
2440 GNUNET_i2s (&n->id));
2441 n->state = S_DISCONNECT_FINISHED;
2442 free_neighbour (n, GNUNET_NO);
2446 case S_CONNECT_RECV_ACK:
2447 if (0 == delay.rel_value)
2449 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2450 "Connection to `%s' timed out waiting for other peer to send SESSION_ACK\n",
2451 GNUNET_i2s (&n->id));
2452 disconnect_neighbour (n);
2457 if (0 == delay.rel_value)
2459 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2460 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs\n",
2461 GNUNET_i2s (&n->id));
2462 disconnect_neighbour (n);
2465 try_transmission_to_peer (n);
2468 case S_RECONNECT_ATS:
2469 if (0 == delay.rel_value)
2471 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2472 "Connection to `%s' timed out, waiting for ATS replacement address\n",
2473 GNUNET_i2s (&n->id));
2474 disconnect_neighbour (n);
2478 case S_RECONNECT_BLACKLIST:
2479 if (0 == delay.rel_value)
2481 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2482 "Connection to `%s' timed out, waiting for BLACKLIST to approve replacement address\n",
2483 GNUNET_i2s (&n->id));
2484 disconnect_neighbour (n);
2488 case S_RECONNECT_SENT:
2489 if (0 == delay.rel_value)
2491 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2492 "Connection to `%s' timed out, waiting for other peer to CONNECT_ACK replacement address\n",
2493 GNUNET_i2s (&n->id));
2494 disconnect_neighbour (n);
2498 case S_CONNECTED_SWITCHING_BLACKLIST:
2499 if (0 == delay.rel_value)
2501 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2502 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs\n",
2503 GNUNET_i2s (&n->id));
2504 disconnect_neighbour (n);
2507 try_transmission_to_peer (n);
2510 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2511 if (0 == delay.rel_value)
2513 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2514 "Connection to `%s' timed out, missing KEEPALIVE_RESPONSEs (after trying to CONNECT on alternative address)\n",
2515 GNUNET_i2s (&n->id));
2516 disconnect_neighbour (n);
2519 try_transmission_to_peer (n);
2523 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2524 "Cleaning up connection to `%s' after sending DISCONNECT\n",
2525 GNUNET_i2s (&n->id));
2526 free_neighbour (n, GNUNET_NO);
2528 case S_DISCONNECT_FINISHED:
2529 /* how did we get here!? */
2533 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
2537 if ( (S_CONNECTED_SWITCHING_CONNECT_SENT == n->state) ||
2538 (S_CONNECTED_SWITCHING_BLACKLIST == n->state) ||
2539 (S_CONNECTED == n->state) )
2541 /* if we are *now* in one of these three states, we're sending
2542 keep alive messages, so we need to consider the keepalive
2543 delay, not just the connection timeout */
2544 delay = GNUNET_TIME_relative_min (GNUNET_TIME_absolute_get_remaining (n->keep_alive_time),
2547 if (GNUNET_SCHEDULER_NO_TASK == n->task)
2548 n->task = GNUNET_SCHEDULER_add_delayed (delay,
2555 * Send a SESSION_ACK message to the neighbour to confirm that we
2556 * got his CONNECT_ACK.
2558 * @param n neighbour to send the SESSION_ACK to
2561 send_session_ack_message (struct NeighbourMapEntry *n)
2563 struct GNUNET_MessageHeader msg;
2565 msg.size = htons (sizeof (struct GNUNET_MessageHeader));
2566 msg.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_ACK);
2567 (void) send_with_session(n,
2568 (const char *) &msg, sizeof (struct GNUNET_MessageHeader),
2569 UINT32_MAX, GNUNET_TIME_UNIT_FOREVER_REL,
2575 * We received a 'SESSION_CONNECT_ACK' message from the other peer.
2576 * Consider switching to it.
2578 * @param message possibly a 'struct SessionConnectMessage' (check format)
2579 * @param peer identity of the peer to switch the address for
2580 * @param address address of the other peer, NULL if other peer
2582 * @param session session to use (or NULL)
2583 * @param ats performance data
2584 * @param ats_count number of entries in ats
2587 GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
2588 const struct GNUNET_PeerIdentity *peer,
2589 const struct GNUNET_HELLO_Address *address,
2590 struct Session *session,
2591 const struct GNUNET_ATS_Information *ats,
2594 const struct SessionConnectMessage *scm;
2595 struct GNUNET_TIME_Absolute ts;
2596 struct NeighbourMapEntry *n;
2598 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2599 "Received CONNECT_ACK message from peer `%s'\n",
2602 if (ntohs (message->size) != sizeof (struct SessionConnectMessage))
2604 GNUNET_break_op (0);
2607 scm = (const struct SessionConnectMessage *) message;
2608 GNUNET_break_op (ntohl (scm->reserved) == 0);
2609 if (NULL == (n = lookup_neighbour (peer)))
2611 GNUNET_STATISTICS_update (GST_stats,
2613 ("# unexpected CONNECT_ACK messages (no peer)"),
2617 ts = GNUNET_TIME_absolute_ntoh (scm->timestamp);
2620 case S_NOT_CONNECTED:
2622 free_neighbour (n, GNUNET_NO);
2625 case S_INIT_BLACKLIST:
2626 GNUNET_STATISTICS_update (GST_stats,
2628 ("# unexpected CONNECT_ACK messages (not ready)"),
2631 case S_CONNECT_SENT:
2632 if (ts.abs_value != n->primary_address.connect_timestamp.abs_value)
2633 break; /* ACK does not match our original CONNECT message */
2634 n->state = S_CONNECTED;
2635 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2636 GNUNET_STATISTICS_set (GST_stats,
2637 gettext_noop ("# peers connected"),
2638 ++neighbours_connected,
2640 connect_notify_cb (callback_cls, &n->id, ats, ats_count,
2641 n->primary_address.bandwidth_in,
2642 n->primary_address.bandwidth_out);
2643 /* Tell ATS that the outbound session we created to send CONNECT was successfull */
2644 GNUNET_ATS_address_add (GST_ats,
2645 n->primary_address.address,
2646 n->primary_address.session,
2648 set_address (&n->primary_address,
2649 n->primary_address.address,
2650 n->primary_address.session,
2651 n->primary_address.bandwidth_in,
2652 n->primary_address.bandwidth_out,
2654 send_session_ack_message (n);
2656 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2657 case S_CONNECT_RECV_ATS:
2658 case S_CONNECT_RECV_BLACKLIST:
2659 case S_CONNECT_RECV_ACK:
2660 GNUNET_STATISTICS_update (GST_stats,
2662 ("# unexpected CONNECT_ACK messages (not ready)"),
2666 /* duplicate CONNECT_ACK, let's answer by duplciate SESSION_ACK just in case */
2667 send_session_ack_message (n);
2669 case S_RECONNECT_ATS:
2670 case S_RECONNECT_BLACKLIST:
2671 /* we didn't expect any CONNECT_ACK, as we are waiting for ATS
2672 to give us a new address... */
2673 GNUNET_STATISTICS_update (GST_stats,
2675 ("# unexpected CONNECT_ACK messages (waiting on ATS)"),
2678 case S_RECONNECT_SENT:
2679 /* new address worked; go back to connected! */
2680 n->state = S_CONNECTED;
2681 send_session_ack_message (n);
2683 case S_CONNECTED_SWITCHING_BLACKLIST:
2684 /* duplicate CONNECT_ACK, let's answer by duplciate SESSION_ACK just in case */
2685 send_session_ack_message (n);
2687 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2688 /* new address worked; adopt it and go back to connected! */
2689 n->state = S_CONNECTED;
2690 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2691 GNUNET_break (GNUNET_NO == n->alternative_address.ats_active);
2692 GNUNET_ATS_address_add(GST_ats,
2693 n->alternative_address.address,
2694 n->alternative_address.session,
2696 set_address (&n->primary_address,
2697 n->alternative_address.address,
2698 n->alternative_address.session,
2699 n->alternative_address.bandwidth_in,
2700 n->alternative_address.bandwidth_out,
2702 free_address (&n->alternative_address);
2703 send_session_ack_message (n);
2706 GNUNET_STATISTICS_update (GST_stats,
2708 ("# unexpected CONNECT_ACK messages (disconnecting)"),
2711 case S_DISCONNECT_FINISHED:
2715 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
2723 * A session was terminated. Take note; if needed, try to get
2724 * an alternative address from ATS.
2726 * @param peer identity of the peer where the session died
2727 * @param session session that is gone
2728 * @return GNUNET_YES if this was a session used, GNUNET_NO if
2729 * this session was not in use
2732 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
2733 struct Session *session)
2735 struct NeighbourMapEntry *n;
2736 struct BlackListCheckContext *bcc;
2737 struct BlackListCheckContext *bcc_next;
2739 /* make sure to cancel all ongoing blacklist checks involving 'session' */
2741 while (NULL != (bcc = bcc_next))
2743 bcc_next = bcc->next;
2744 if (bcc->na.session == session)
2746 GST_blacklist_test_cancel (bcc->bc);
2747 GNUNET_HELLO_address_free (bcc->na.address);
2748 GNUNET_CONTAINER_DLL_remove (bc_head,
2754 if (NULL == (n = lookup_neighbour (peer)))
2755 return GNUNET_NO; /* can't affect us */
2756 if (session != n->primary_address.session)
2758 if (session == n->alternative_address.session)
2760 free_address (&n->alternative_address);
2761 if ( (S_CONNECTED_SWITCHING_BLACKLIST == n->state) ||
2762 (S_CONNECTED_SWITCHING_CONNECT_SENT == n->state) )
2763 n->state = S_CONNECTED;
2767 return GNUNET_NO; /* doesn't affect us further */
2770 n->expect_latency_response = GNUNET_NO;
2773 case S_NOT_CONNECTED:
2775 free_neighbour (n, GNUNET_NO);
2779 free_neighbour (n, GNUNET_NO);
2781 case S_INIT_BLACKLIST:
2782 case S_CONNECT_SENT:
2783 free_address (&n->primary_address);
2784 n->state = S_INIT_ATS;
2785 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2786 // FIXME: need to ask ATS for suggestions again?
2787 GNUNET_ATS_suggest_address (GST_ats, &n->id);
2789 case S_CONNECT_RECV_BLACKLIST_INBOUND:
2790 case S_CONNECT_RECV_ATS:
2791 case S_CONNECT_RECV_BLACKLIST:
2792 case S_CONNECT_RECV_ACK:
2793 /* error on inbound session; free neighbour entirely */
2794 free_address (&n->primary_address);
2795 free_neighbour (n, GNUNET_NO);
2798 free_address (&n->primary_address);
2799 n->state = S_RECONNECT_ATS;
2800 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2801 /* FIXME: is this ATS call needed? */
2802 GNUNET_ATS_suggest_address (GST_ats, &n->id);
2804 case S_RECONNECT_ATS:
2805 /* we don't have an address, how can it go down? */
2808 case S_RECONNECT_BLACKLIST:
2809 case S_RECONNECT_SENT:
2810 n->state = S_RECONNECT_ATS;
2811 n->timeout = GNUNET_TIME_relative_to_absolute (ATS_RESPONSE_TIMEOUT);
2812 // FIXME: need to ask ATS for suggestions again?
2813 GNUNET_ATS_suggest_address (GST_ats, &n->id);
2815 case S_CONNECTED_SWITCHING_BLACKLIST:
2816 /* primary went down while we were checking secondary against
2817 blacklist, adopt secondary as primary */
2818 free_address (&n->primary_address);
2819 n->primary_address = n->alternative_address;
2820 memset (&n->alternative_address, 0, sizeof (struct NeighbourAddress));
2821 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
2822 n->state = S_RECONNECT_BLACKLIST;
2824 case S_CONNECTED_SWITCHING_CONNECT_SENT:
2825 /* primary went down while we were waiting for CONNECT_ACK on secondary;
2826 secondary as primary */
2827 free_address (&n->primary_address);
2828 n->primary_address = n->alternative_address;
2829 memset (&n->alternative_address, 0, sizeof (struct NeighbourAddress));
2830 n->timeout = GNUNET_TIME_relative_to_absolute (FAST_RECONNECT_TIMEOUT);
2831 n->state = S_RECONNECT_SENT;
2834 free_address (&n->primary_address);
2836 case S_DISCONNECT_FINISHED:
2837 /* neighbour was freed and plugins told to terminate session */
2841 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
2845 if (GNUNET_SCHEDULER_NO_TASK != n->task)
2846 GNUNET_SCHEDULER_cancel (n->task);
2847 n->task = GNUNET_SCHEDULER_add_now (&master_task, n);
2853 * We received a 'SESSION_ACK' message from the other peer.
2854 * If we sent a 'CONNECT_ACK' last, this means we are now
2855 * connected. Otherwise, do nothing.
2857 * @param message possibly a 'struct SessionConnectMessage' (check format)
2858 * @param peer identity of the peer to switch the address for
2859 * @param address address of the other peer, NULL if other peer
2861 * @param session session to use (or NULL)
2862 * @param ats performance data
2863 * @param ats_count number of entries in ats
2866 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
2867 const struct GNUNET_PeerIdentity *peer,
2868 const struct GNUNET_HELLO_Address *address,
2869 struct Session *session,
2870 const struct GNUNET_ATS_Information *ats,
2873 struct NeighbourMapEntry *n;
2875 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2876 "Received SESSION_ACK message from peer `%s'\n",
2878 if (ntohs (message->size) != sizeof (struct GNUNET_MessageHeader))
2880 GNUNET_break_op (0);
2883 if (NULL == (n = lookup_neighbour (peer)))
2885 /* check if we are in a plausible state for having sent
2886 a CONNECT_ACK. If not, return, otherwise break */
2887 if ( ( (S_CONNECT_RECV_ACK != n->state) &&
2888 (S_CONNECT_SENT != n->state) ) ||
2889 (2 != n->send_connect_ack) )
2891 GNUNET_STATISTICS_update (GST_stats,
2892 gettext_noop ("# unexpected SESSION ACK messages"), 1,
2896 n->state = S_CONNECTED;
2897 n->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2898 GNUNET_STATISTICS_set (GST_stats,
2899 gettext_noop ("# peers connected"),
2900 ++neighbours_connected,
2902 connect_notify_cb (callback_cls, &n->id, ats, ats_count,
2903 n->primary_address.bandwidth_in,
2904 n->primary_address.bandwidth_out);
2905 GNUNET_ATS_address_add(GST_ats,
2906 n->primary_address.address,
2907 n->primary_address.session,
2909 set_address (&n->primary_address,
2910 n->primary_address.address,
2911 n->primary_address.session,
2912 n->primary_address.bandwidth_in,
2913 n->primary_address.bandwidth_out,
2919 * Test if we're connected to the given peer.
2921 * @param target peer to test
2922 * @return GNUNET_YES if we are connected, GNUNET_NO if not
2925 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target)
2927 return test_connected (lookup_neighbour (target));
2932 * Change the incoming quota for the given peer.
2934 * @param neighbour identity of peer to change qutoa for
2935 * @param quota new quota
2938 GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
2939 struct GNUNET_BANDWIDTH_Value32NBO quota)
2941 struct NeighbourMapEntry *n;
2943 if (NULL == (n = lookup_neighbour (neighbour)))
2945 GNUNET_STATISTICS_update (GST_stats,
2947 ("# SET QUOTA messages ignored (no such peer)"),
2951 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2952 "Setting inbound quota of %u Bps for peer `%s' to all clients\n",
2953 ntohl (quota.value__), GNUNET_i2s (&n->id));
2954 GNUNET_BANDWIDTH_tracker_update_quota (&n->in_tracker, quota);
2955 if (0 != ntohl (quota.value__))
2957 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting peer `%4s' due to `%s'\n",
2958 GNUNET_i2s (&n->id), "SET_QUOTA");
2959 if (GNUNET_YES == test_connected (n))
2960 GNUNET_STATISTICS_update (GST_stats,
2961 gettext_noop ("# disconnects due to quota of 0"),
2963 disconnect_neighbour (n);
2968 * We received a disconnect message from the given peer,
2969 * validate and process.
2971 * @param peer sender of the message
2972 * @param msg the disconnect message
2975 GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
2977 const struct GNUNET_MessageHeader
2980 struct NeighbourMapEntry *n;
2981 const struct SessionDisconnectMessage *sdm;
2982 struct GNUNET_HashCode hc;
2984 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2985 "Received DISCONNECT message from peer `%s'\n",
2987 if (ntohs (msg->size) != sizeof (struct SessionDisconnectMessage))
2989 // GNUNET_break_op (0);
2990 GNUNET_STATISTICS_update (GST_stats,
2992 ("# disconnect messages ignored (old format)"), 1,
2996 sdm = (const struct SessionDisconnectMessage *) msg;
2997 if (NULL == (n = lookup_neighbour (peer)))
2998 return; /* gone already */
2999 if (GNUNET_TIME_absolute_ntoh (sdm->timestamp).abs_value <= n->connect_ack_timestamp.abs_value)
3001 GNUNET_STATISTICS_update (GST_stats,
3003 ("# disconnect messages ignored (timestamp)"), 1,
3007 GNUNET_CRYPTO_hash (&sdm->public_key,
3008 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
3010 if (0 != memcmp (peer, &hc, sizeof (struct GNUNET_PeerIdentity)))
3012 GNUNET_break_op (0);
3015 if (ntohl (sdm->purpose.size) !=
3016 sizeof (struct GNUNET_CRYPTO_RsaSignaturePurpose) +
3017 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
3018 sizeof (struct GNUNET_TIME_AbsoluteNBO))
3020 GNUNET_break_op (0);
3024 GNUNET_CRYPTO_rsa_verify
3025 (GNUNET_MESSAGE_TYPE_TRANSPORT_SESSION_DISCONNECT, &sdm->purpose,
3026 &sdm->signature, &sdm->public_key))
3028 GNUNET_break_op (0);
3031 if (GNUNET_YES == test_connected (n))
3032 GNUNET_STATISTICS_update (GST_stats,
3034 ("# other peer asked to disconnect from us"), 1,
3036 disconnect_neighbour (n);
3041 * Closure for the neighbours_iterate function.
3043 struct IteratorContext
3046 * Function to call on each connected neighbour.
3048 GST_NeighbourIterator cb;
3058 * Call the callback from the closure for each connected neighbour.
3060 * @param cls the 'struct IteratorContext'
3061 * @param key the hash of the public key of the neighbour
3062 * @param value the 'struct NeighbourMapEntry'
3063 * @return GNUNET_OK (continue to iterate)
3066 neighbours_iterate (void *cls, const struct GNUNET_HashCode * key, void *value)
3068 struct IteratorContext *ic = cls;
3069 struct NeighbourMapEntry *n = value;
3071 if (GNUNET_YES == test_connected (n))
3073 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
3074 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
3076 if (NULL != n->primary_address.address)
3078 bandwidth_in = n->primary_address.bandwidth_in;
3079 bandwidth_out = n->primary_address.bandwidth_out;
3083 bandwidth_in = GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT;
3084 bandwidth_out = GNUNET_CONSTANTS_DEFAULT_BW_IN_OUT;
3087 ic->cb (ic->cb_cls, &n->id, NULL, 0,
3088 n->primary_address.address,
3089 bandwidth_in, bandwidth_out);
3096 * Iterate over all connected neighbours.
3098 * @param cb function to call
3099 * @param cb_cls closure for cb
3102 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls)
3104 struct IteratorContext ic;
3106 if (NULL == neighbours)
3107 return; /* can happen during shutdown */
3110 GNUNET_CONTAINER_multihashmap_iterate (neighbours, &neighbours_iterate, &ic);
3115 * If we have an active connection to the given target, it must be shutdown.
3117 * @param target peer to disconnect from
3120 GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target)
3122 struct NeighbourMapEntry *n;
3124 if (NULL == (n = lookup_neighbour (target)))
3125 return; /* not active */
3126 if (GNUNET_YES == test_connected (n))
3127 GNUNET_STATISTICS_update (GST_stats,
3129 ("# disconnected from peer upon explicit request"), 1,
3131 disconnect_neighbour (n);
3136 * Obtain current latency information for the given neighbour.
3138 * @param peer to get the latency for
3139 * @return observed latency of the address, FOREVER if the
3140 * the connection is not up
3142 struct GNUNET_TIME_Relative
3143 GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer)
3145 struct NeighbourMapEntry *n;
3147 n = lookup_neighbour (peer);
3149 return GNUNET_TIME_UNIT_FOREVER_REL;
3153 case S_CONNECTED_SWITCHING_CONNECT_SENT:
3154 case S_CONNECTED_SWITCHING_BLACKLIST:
3155 case S_RECONNECT_SENT:
3156 case S_RECONNECT_ATS:
3157 case S_RECONNECT_BLACKLIST:
3159 case S_NOT_CONNECTED:
3160 case S_INIT_BLACKLIST:
3162 case S_CONNECT_RECV_BLACKLIST_INBOUND:
3163 case S_CONNECT_RECV_ATS:
3164 case S_CONNECT_RECV_BLACKLIST:
3165 case S_CONNECT_RECV_ACK:
3166 case S_CONNECT_SENT:
3168 case S_DISCONNECT_FINISHED:
3169 return GNUNET_TIME_UNIT_FOREVER_REL;
3171 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unhandled state `%s' \n",print_state (n->state));
3175 return GNUNET_TIME_UNIT_FOREVER_REL;
3180 * Obtain current address information for the given neighbour.
3183 * @return address currently used
3185 struct GNUNET_HELLO_Address *
3186 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer)
3188 struct NeighbourMapEntry *n;
3190 n = lookup_neighbour (peer);
3193 return n->primary_address.address;
3198 * Initialize the neighbours subsystem.
3200 * @param cls closure for callbacks
3201 * @param connect_cb function to call if we connect to a peer
3202 * @param disconnect_cb function to call if we disconnect from a peer
3203 * @param peer_address_cb function to call if we change an active address
3207 GST_neighbours_start (void *cls,
3208 NotifyConnect connect_cb,
3209 GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
3210 GNUNET_TRANSPORT_PeerIterateCallback peer_address_cb)
3213 connect_notify_cb = connect_cb;
3214 disconnect_notify_cb = disconnect_cb;
3215 address_change_cb = peer_address_cb;
3216 neighbours = GNUNET_CONTAINER_multihashmap_create (NEIGHBOUR_TABLE_SIZE, GNUNET_NO);
3221 * Disconnect from the given neighbour.
3224 * @param key hash of neighbour's public key (not used)
3225 * @param value the 'struct NeighbourMapEntry' of the neighbour
3226 * @return GNUNET_OK (continue to iterate)
3229 disconnect_all_neighbours (void *cls, const struct GNUNET_HashCode * key, void *value)
3231 struct NeighbourMapEntry *n = value;
3233 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
3234 "Disconnecting peer `%4s', %s\n",
3235 GNUNET_i2s (&n->id), "SHUTDOWN_TASK");
3236 n->state = S_DISCONNECT_FINISHED;
3237 free_neighbour (n, GNUNET_NO);
3243 * Cleanup the neighbours subsystem.
3246 GST_neighbours_stop ()
3248 if (NULL == neighbours)
3250 GNUNET_CONTAINER_multihashmap_iterate (neighbours,
3251 &disconnect_all_neighbours,
3253 GNUNET_CONTAINER_multihashmap_destroy (neighbours);
3255 callback_cls = NULL;
3256 connect_notify_cb = NULL;
3257 disconnect_notify_cb = NULL;
3258 address_change_cb = NULL;
3262 /* end of file gnunet-service-transport_neighbours.c */