2 This file is part of GNUnet.
3 (C) 2009 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 2, 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.c
23 * @brief low-level P2P messaging
24 * @author Christian Grothoff
27 * - if we do not receive an ACK in response to our
28 * HELLO, retransmit HELLO!
31 #include "gnunet_client_lib.h"
32 #include "gnunet_constants.h"
33 #include "gnunet_getopt_lib.h"
34 #include "gnunet_hello_lib.h"
35 #include "gnunet_os_lib.h"
36 #include "gnunet_peerinfo_service.h"
37 #include "gnunet_plugin_lib.h"
38 #include "gnunet_protocols.h"
39 #include "gnunet_service_lib.h"
40 #include "gnunet_signatures.h"
41 #include "plugin_transport.h"
42 #include "transport.h"
45 * How many messages can we have pending for a given client process
46 * before we start to drop incoming messages? We typically should
47 * have only one client and so this would be the primary buffer for
48 * messages, so the number should be chosen rather generously.
50 * The expectation here is that most of the time the queue is large
51 * enough so that a drop is virtually never required.
53 #define MAX_PENDING 128
56 * How often should we try to reconnect to a peer using a particular
57 * transport plugin before giving up? Note that the plugin may be
58 * added back to the list after PLUGIN_RETRY_FREQUENCY expires.
60 #define MAX_CONNECT_RETRY 3
63 * How often must a peer violate bandwidth quotas before we start
64 * to simply drop its messages?
66 #define QUOTA_VIOLATION_DROP_THRESHOLD 100
69 * How long until a HELLO verification attempt should time out?
71 #define HELLO_VERIFICATION_TIMEOUT GNUNET_TIME_UNIT_MINUTES
74 * How often do we re-add (cheaper) plugins to our list of plugins
75 * to try for a given connected peer?
77 #define PLUGIN_RETRY_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
80 * After how long do we expire an address in a HELLO
81 * that we just validated? This value is also used
82 * for our own addresses when we create a HELLO.
84 #define HELLO_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 12)
88 * Entry in linked list of network addresses.
93 * This is a linked list.
95 struct AddressList *next;
98 * The address, actually a pointer to the end
99 * of this struct. Do not free!
104 * How long until we auto-expire this address (unless it is
105 * re-confirmed by the transport)?
107 struct GNUNET_TIME_Absolute expires;
118 * Entry in linked list of all of our plugins.
120 struct TransportPlugin
124 * This is a linked list.
126 struct TransportPlugin *next;
129 * API of the transport as returned by the plugin's
130 * initialization function.
132 struct GNUNET_TRANSPORT_PluginFunctions *api;
135 * Short name for the plugin (i.e. "tcp").
140 * Name of the library (i.e. "gnunet_plugin_transport_tcp").
145 * List of our known addresses for this transport.
147 struct AddressList *addresses;
150 * Environment this transport service is using
153 struct GNUNET_TRANSPORT_PluginEnvironment env;
156 * ID of task that is used to clean up expired addresses.
158 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
162 * Set to GNUNET_YES if we need to scrap the existing
163 * list of "addresses" and start fresh when we receive
164 * the next address update from a transport. Set to
165 * GNUNET_NO if we should just add the new address
166 * to the list and wait for the commit call.
171 struct NeighbourList;
174 * For each neighbour we keep a list of messages
175 * that we still want to transmit to the neighbour.
181 * This is a linked list.
183 struct MessageQueue *next;
186 * The message we want to transmit.
188 struct GNUNET_MessageHeader *message;
191 * Client responsible for queueing the message;
192 * used to check that a client has not two messages
193 * pending for the same target. Can be NULL.
195 struct TransportClient *client;
198 * Neighbour this entry belongs to.
200 struct NeighbourList *neighbour;
203 * Plugin that we used for the transmission.
204 * NULL until we scheduled a transmission.
206 struct TransportPlugin *plugin;
209 * Internal message of the transport system that should not be
210 * included in the usual SEND-SEND_OK transmission confirmation
211 * traffic management scheme. Typically, "internal_msg" will
212 * be set whenever "client" is NULL (but it is not strictly
218 * How important is the message?
220 unsigned int priority;
226 * For a given Neighbour, which plugins are available
227 * to talk to this peer and what are their costs?
233 * This is a linked list.
235 struct ReadyList *next;
238 * Which of our transport plugins does this entry
241 struct TransportPlugin *plugin;
244 * Neighbour this entry belongs to.
246 struct NeighbourList *neighbour;
249 * Opaque handle (specific to the plugin) for the
250 * connection to our target; can be NULL.
255 * What was the last latency observed for this plugin
256 * and peer? Invalid if connected is GNUNET_NO.
258 struct GNUNET_TIME_Relative latency;
261 * If we did not successfully transmit a message to the
262 * given peer via this connection during the specified
263 * time, we should consider the connection to be dead.
264 * This is used in the case that a TCP transport simply
265 * stalls writing to the stream but does not formerly
266 * get a signal that the other peer died.
268 struct GNUNET_TIME_Absolute timeout;
271 * Is this plugin currently connected? The first time
272 * we transmit or send data to a peer via a particular
273 * plugin, we set this to GNUNET_YES. If we later get
274 * an error (disconnect notification or transmission
275 * failure), we set it back to GNUNET_NO. Each time the
276 * value is set to GNUNET_YES, we increment the
277 * "connect_attempts" counter. If that one reaches a
278 * particular threshold, we consider the plugin to not
279 * be working properly at this time for the given peer
280 * and remove it from the eligible list.
285 * How often have we tried to connect using this plugin?
287 unsigned int connect_attempts;
290 * Is this plugin ready to transmit to the specific
291 * target? GNUNET_NO if not. Initially, all plugins
292 * are marked ready. If a transmission is in progress,
293 * "transmit_ready" is set to GNUNET_NO.
301 * Entry in linked list of all of our current neighbours.
307 * This is a linked list.
309 struct NeighbourList *next;
312 * Which of our transports is connected to this peer
313 * and what is their status?
315 struct ReadyList *plugins;
318 * List of messages we would like to send to this peer;
319 * must contain at most one message per client.
321 struct MessageQueue *messages;
324 * Identity of this neighbour.
326 struct GNUNET_PeerIdentity id;
329 * ID of task scheduled to run when this peer is about to
330 * time out (will free resources associated with the peer).
332 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
335 * How long until we should consider this peer dead
336 * (if we don't receive another message in the
339 struct GNUNET_TIME_Absolute peer_timeout;
342 * At what time did we reset last_received last?
344 struct GNUNET_TIME_Absolute last_quota_update;
347 * At what time should we try to again add plugins to
350 struct GNUNET_TIME_Absolute retry_plugins_time;
353 * How many bytes have we received since the "last_quota_update"
356 uint64_t last_received;
359 * Global quota for inbound traffic for the neighbour in bytes/ms.
364 * How often has the other peer (recently) violated the
365 * inbound traffic limit? Incremented by 10 per violation,
366 * decremented by 1 per non-violation (for each
369 unsigned int quota_violation_count;
372 * Have we seen an ACK from this neighbour in the past?
373 * (used to make up a fake ACK for clients connecting after
374 * the neighbour connected to us).
382 * Linked list of messages to be transmitted to
383 * the client. Each entry is followed by the
386 struct ClientMessageQueueEntry
389 * This is a linked list.
391 struct ClientMessageQueueEntry *next;
396 * Client connected to the transport service.
398 struct TransportClient
402 * This is a linked list.
404 struct TransportClient *next;
407 * Handle to the client.
409 struct GNUNET_SERVER_Client *client;
412 * Linked list of messages yet to be transmitted to
415 struct ClientMessageQueueEntry *message_queue_head;
418 * Tail of linked list of messages yet to be transmitted to the
421 struct ClientMessageQueueEntry *message_queue_tail;
424 * Is a call to "transmit_send_continuation" pending? If so, we
425 * must not free this struct (even if the corresponding client
426 * disconnects) and instead only remove it from the linked list and
427 * set the "client" field to NULL.
432 * Length of the list of messages pending for this client.
434 unsigned int message_count;
440 * For each HELLO, we may have to validate multiple addresses;
441 * each address gets its own request entry.
443 struct ValidationAddress
446 * This is a linked list.
448 struct ValidationAddress *next;
451 * Name of the transport.
453 char *transport_name;
456 * When should this validated address expire?
458 struct GNUNET_TIME_Absolute expiration;
461 * Length of the address we are validating.
466 * Challenge number we used.
471 * Set to GNUNET_YES if the challenge was met,
472 * GNUNET_SYSERR if we know it failed, GNUNET_NO
473 * if we are waiting on a response.
480 * Entry in linked list of all HELLOs awaiting validation.
482 struct ValidationList
486 * This is a linked list.
488 struct ValidationList *next;
491 * Linked list with one entry per address from the HELLO
492 * that needs to be validated.
494 struct ValidationAddress *addresses;
497 * The public key of the peer.
499 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded publicKey;
502 * When does this record time-out? (assuming the
503 * challenge goes unanswered)
505 struct GNUNET_TIME_Absolute timeout;
511 * HELLOs awaiting validation.
513 static struct ValidationList *pending_validations;
518 static struct GNUNET_HELLO_Message *our_hello;
521 * "version" of "our_hello". Used to see if a given
522 * neighbour has already been sent the latest version
523 * of our HELLO message.
525 static unsigned int our_hello_version;
530 static struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
535 static struct GNUNET_PeerIdentity my_identity;
540 static struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;
545 struct GNUNET_SCHEDULER_Handle *sched;
550 const struct GNUNET_CONFIGURATION_Handle *cfg;
553 * Linked list of all clients to this service.
555 static struct TransportClient *clients;
558 * All loaded plugins.
560 static struct TransportPlugin *plugins;
565 static struct GNUNET_SERVER_Handle *server;
568 * All known neighbours and their HELLOs.
570 static struct NeighbourList *neighbours;
573 * Number of neighbours we'd like to have.
575 static uint32_t max_connect_per_transport;
579 * Find an entry in the neighbour list for a particular peer.
581 * @return NULL if not found.
583 static struct NeighbourList *
584 find_neighbour (const struct GNUNET_PeerIdentity *key)
586 struct NeighbourList *head = neighbours;
587 while ((head != NULL) &&
588 (0 != memcmp (key, &head->id, sizeof (struct GNUNET_PeerIdentity))))
595 * Find an entry in the transport list for a particular transport.
597 * @return NULL if not found.
599 static struct TransportPlugin *
600 find_transport (const char *short_name)
602 struct TransportPlugin *head = plugins;
603 while ((head != NULL) && (0 != strcmp (short_name, head->short_name)))
610 * Update the quota values for the given neighbour now.
613 update_quota (struct NeighbourList *n)
615 struct GNUNET_TIME_Relative delta;
619 delta = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
620 if (delta.value < MIN_QUOTA_REFRESH_TIME)
621 return; /* not enough time passed for doing quota update */
622 allowed = delta.value * n->quota_in;
623 if (n->last_received < allowed)
625 remaining = allowed - n->last_received;
627 remaining /= n->quota_in;
630 if (remaining > MAX_BANDWIDTH_CARRY)
631 remaining = MAX_BANDWIDTH_CARRY;
632 n->last_received = 0;
633 n->last_quota_update = GNUNET_TIME_absolute_get ();
634 n->last_quota_update.value -= remaining;
635 if (n->quota_violation_count > 0)
636 n->quota_violation_count--;
640 n->last_received -= allowed;
641 n->last_quota_update = GNUNET_TIME_absolute_get ();
642 if (n->last_received > allowed)
644 /* more than twice the allowed rate! */
645 n->quota_violation_count += 10;
652 * Function called to notify a client about the socket
653 * being ready to queue more data. "buf" will be
654 * NULL and "size" zero if the socket was closed for
655 * writing in the meantime.
658 * @param size number of bytes available in buf
659 * @param buf where the callee should write the message
660 * @return number of bytes written to buf
663 transmit_to_client_callback (void *cls, size_t size, void *buf)
665 struct TransportClient *client = cls;
666 struct ClientMessageQueueEntry *q;
669 const struct GNUNET_MessageHeader *msg;
670 struct GNUNET_NETWORK_TransmitHandle *th;
675 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
676 "Transmission to client failed, closing connection.\n");
677 /* fatal error with client, free message queue! */
678 while (NULL != (q = client->message_queue_head))
680 client->message_queue_head = q->next;
683 client->message_queue_tail = NULL;
684 client->message_count = 0;
689 while (NULL != (q = client->message_queue_head))
691 msg = (const struct GNUNET_MessageHeader *) &q[1];
692 msize = ntohs (msg->size);
693 if (msize + tsize > size)
695 client->message_queue_head = q->next;
697 client->message_queue_tail = NULL;
698 memcpy (&cbuf[tsize], msg, msize);
701 client->message_count--;
703 GNUNET_assert (tsize > 0);
706 th = GNUNET_SERVER_notify_transmit_ready (client->client,
708 GNUNET_TIME_UNIT_FOREVER_REL,
709 &transmit_to_client_callback,
711 GNUNET_assert (th != NULL);
718 * Send the specified message to the specified client. Since multiple
719 * messages may be pending for the same client at a time, this code
720 * makes sure that no message is lost.
722 * @param client client to transmit the message to
723 * @param msg the message to send
724 * @param may_drop can this message be dropped if the
725 * message queue for this client is getting far too large?
728 transmit_to_client (struct TransportClient *client,
729 const struct GNUNET_MessageHeader *msg, int may_drop)
731 struct ClientMessageQueueEntry *q;
733 struct GNUNET_NETWORK_TransmitHandle *th;
735 if ((client->message_count >= MAX_PENDING) && (GNUNET_YES == may_drop))
737 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
739 ("Dropping message, have %u messages pending (%u is the soft limit)\n"),
740 client->message_count, MAX_PENDING);
741 /* TODO: call to statistics... */
744 client->message_count++;
745 msize = ntohs (msg->size);
746 q = GNUNET_malloc (sizeof (struct ClientMessageQueueEntry) + msize);
747 memcpy (&q[1], msg, msize);
748 /* append to message queue */
749 if (client->message_queue_tail == NULL)
751 client->message_queue_tail = q;
755 client->message_queue_tail->next = q;
756 client->message_queue_tail = q;
758 if (client->message_queue_head == NULL)
760 client->message_queue_head = q;
761 th = GNUNET_SERVER_notify_transmit_ready (client->client,
763 GNUNET_TIME_UNIT_FOREVER_REL,
764 &transmit_to_client_callback,
766 GNUNET_assert (th != NULL);
772 * Find alternative plugins for communication.
774 * @param neighbour for which neighbour should we try to find
778 try_alternative_plugins (struct NeighbourList *neighbour)
780 struct ReadyList *rl;
782 if ((neighbour->plugins != NULL) &&
783 (neighbour->retry_plugins_time.value >
784 GNUNET_TIME_absolute_get ().value))
785 return; /* don't try right now */
786 neighbour->retry_plugins_time
787 = GNUNET_TIME_relative_to_absolute (PLUGIN_RETRY_FREQUENCY);
789 rl = neighbour->plugins;
792 if (rl->connect_attempts > 0)
793 rl->connect_attempts--; /* amnesty */
801 * The peer specified by the given neighbour has timed-out or a plugin
802 * has disconnected. We may either need to do nothing (other plugins
803 * still up), or trigger a full disconnect and clean up. This
804 * function updates our state and do the necessary notifications.
805 * Also notifies our clients that the neighbour is now officially
808 * @param n the neighbour list entry for the peer
809 * @param check should we just check if all plugins
810 * disconnected or must we ask all plugins to
814 disconnect_neighbour (struct NeighbourList *n,
819 * Check the ready list for the given neighbour and
820 * if a plugin is ready for transmission (and if we
821 * have a message), do so!
823 * @param neighbour target peer for which to check the plugins
826 try_transmission_to_peer (struct NeighbourList *neighbour);
830 * Function called by the GNUNET_TRANSPORT_TransmitFunction
831 * upon "completion" of a send request. This tells the API
832 * that it is now legal to send another message to the given
835 * @param cls closure, identifies the entry on the
836 * message queue that was transmitted and the
837 * client responsible for queueing the message
838 * @param rl identifies plugin used for the transmission for
839 * this neighbour; needs to be re-enabled for
840 * future transmissions
841 * @param target the peer receiving the message
842 * @param result GNUNET_OK on success, if the transmission
843 * failed, we should not tell the client to transmit
847 transmit_send_continuation (void *cls,
848 struct ReadyList *rl,
849 const struct GNUNET_PeerIdentity *target,
852 struct MessageQueue *mq = cls;
853 struct SendOkMessage send_ok_msg;
854 struct NeighbourList *n;
856 GNUNET_assert (mq != NULL);
858 GNUNET_assert (n != NULL);
860 memcmp (&n->id, target,
861 sizeof (struct GNUNET_PeerIdentity)));
865 while ((rl != NULL) && (rl->plugin != mq->plugin))
867 GNUNET_assert (rl != NULL);
869 if (result == GNUNET_OK)
871 rl->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
875 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
876 "Transmission to peer `%s' failed, marking connection as down.\n",
878 rl->connected = GNUNET_NO;
879 rl->plugin_handle = NULL;
881 if (!mq->internal_msg)
882 rl->transmit_ready = GNUNET_YES;
883 if (mq->client != NULL)
885 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
886 "Notifying client %p about failed transission to peer `%4s'.\n",
889 send_ok_msg.header.size = htons (sizeof (send_ok_msg));
890 send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
891 send_ok_msg.success = htonl (result);
892 send_ok_msg.peer = n->id;
893 transmit_to_client (mq->client, &send_ok_msg.header, GNUNET_NO);
895 GNUNET_free (mq->message);
897 /* one plugin just became ready again, try transmitting
898 another message (if available) */
899 if (result == GNUNET_OK)
900 try_transmission_to_peer (n);
902 disconnect_neighbour (n, GNUNET_YES);
907 * Check the ready list for the given neighbour and
908 * if a plugin is ready for transmission (and if we
909 * have a message), do so!
912 try_transmission_to_peer (struct NeighbourList *neighbour)
914 struct ReadyList *pos;
915 struct GNUNET_TIME_Relative min_latency;
916 struct ReadyList *rl;
917 struct MessageQueue *mq;
918 struct GNUNET_TIME_Absolute now;
920 if (neighbour->messages == NULL)
921 return; /* nothing to do */
922 try_alternative_plugins (neighbour);
923 min_latency = GNUNET_TIME_UNIT_FOREVER_REL;
925 mq = neighbour->messages;
926 now = GNUNET_TIME_absolute_get ();
927 pos = neighbour->plugins;
930 /* set plugins that are inactive for a long time back to disconnected */
931 if ((pos->timeout.value < now.value) && (pos->connected == GNUNET_YES))
934 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
935 "Marking long-time inactive connection to `%4s' as down.\n",
936 GNUNET_i2s (&neighbour->id));
938 pos->connected = GNUNET_NO;
940 if (((GNUNET_YES == pos->transmit_ready) ||
941 (mq->internal_msg)) &&
942 (pos->connect_attempts < MAX_CONNECT_RETRY) &&
943 ((rl == NULL) || (min_latency.value > pos->latency.value)))
946 min_latency = pos->latency;
953 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
954 "No plugin ready to transmit message\n");
956 return; /* nobody ready */
958 if (GNUNET_NO == rl->connected)
960 rl->connect_attempts++;
961 rl->connected = GNUNET_YES;
963 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
964 "Establishing fresh connection with `%4s' via plugin `%s'\n",
965 GNUNET_i2s (&neighbour->id), rl->plugin->short_name);
968 neighbour->messages = mq->next;
969 mq->plugin = rl->plugin;
970 if (!mq->internal_msg)
971 rl->transmit_ready = GNUNET_NO;
973 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
974 "Giving message of type `%u' for `%4s' to plugin `%s'\n",
975 ntohs (mq->message->type),
976 GNUNET_i2s (&neighbour->id), rl->plugin->short_name);
979 = rl->plugin->api->send (rl->plugin->api->cls,
985 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
986 &transmit_send_continuation, mq);
991 * Send the specified message to the specified peer.
993 * @param client source of the transmission request (can be NULL)
994 * @param priority how important is the message
995 * @param msg message to send
996 * @param is_internal is this an internal message
997 * @param neighbour handle to the neighbour for transmission
1000 transmit_to_peer (struct TransportClient *client,
1001 unsigned int priority,
1002 const struct GNUNET_MessageHeader *msg,
1003 int is_internal, struct NeighbourList *neighbour)
1005 struct MessageQueue *mq;
1006 struct MessageQueue *mqe;
1007 struct GNUNET_MessageHeader *m;
1010 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1011 _("Sending message of type %u to peer `%4s'\n"),
1012 ntohs (msg->type), GNUNET_i2s (&neighbour->id));
1016 /* check for duplicate submission */
1017 mq = neighbour->messages;
1020 if (mq->client == client)
1022 /* client transmitted to same peer twice
1023 before getting SendOk! */
1030 mq = GNUNET_malloc (sizeof (struct MessageQueue));
1031 mq->client = client;
1032 m = GNUNET_malloc (ntohs (msg->size));
1033 memcpy (m, msg, ntohs (msg->size));
1035 mq->neighbour = neighbour;
1036 mq->internal_msg = is_internal;
1037 mq->priority = priority;
1040 mqe = neighbour->messages;
1042 while (mqe->next != NULL)
1047 neighbour->messages = mq;
1048 try_transmission_to_peer (neighbour);
1061 struct GeneratorContext
1063 struct TransportPlugin *plug_pos;
1064 struct AddressList *addr_pos;
1065 struct GNUNET_TIME_Absolute expiration;
1073 address_generator (void *cls, size_t max, void *buf)
1075 struct GeneratorContext *gc = cls;
1078 while ((gc->addr_pos == NULL) && (gc->plug_pos != NULL))
1080 gc->plug_pos = gc->plug_pos->next;
1081 gc->addr_pos = (gc->plug_pos != NULL) ? gc->plug_pos->addresses : NULL;
1083 if (NULL == gc->plug_pos)
1085 ret = GNUNET_HELLO_add_address (gc->plug_pos->short_name,
1088 gc->addr_pos->addrlen, buf, max);
1089 gc->addr_pos = gc->addr_pos->next;
1095 * Construct our HELLO message from all of the addresses of
1096 * all of the transports.
1101 struct GNUNET_HELLO_Message *hello;
1102 struct TransportClient *cpos;
1103 struct NeighbourList *npos;
1104 struct GeneratorContext gc;
1107 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1108 "Refreshing my `%s'\n",
1111 gc.plug_pos = plugins;
1112 gc.addr_pos = plugins != NULL ? plugins->addresses : NULL;
1113 gc.expiration = GNUNET_TIME_relative_to_absolute (HELLO_ADDRESS_EXPIRATION);
1114 hello = GNUNET_HELLO_create (&my_public_key, &address_generator, &gc);
1116 while (cpos != NULL)
1118 transmit_to_client (cpos,
1119 (const struct GNUNET_MessageHeader *) hello,
1124 GNUNET_free_non_null (our_hello);
1126 our_hello_version++;
1128 while (npos != NULL)
1131 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1132 "Transmitting updated `%s' to neighbour `%4s'\n",
1134 GNUNET_i2s(&npos->id));
1136 transmit_to_peer (NULL, 0,
1137 (const struct GNUNET_MessageHeader *) our_hello,
1145 * Task used to clean up expired addresses for a plugin.
1147 * @param cls closure
1151 expire_address_task (void *cls,
1152 const struct GNUNET_SCHEDULER_TaskContext *tc);
1156 * Update the list of addresses for this plugin,
1157 * expiring those that are past their expiration date.
1159 * @param plugin addresses of which plugin should be recomputed?
1160 * @param fresh set to GNUNET_YES if a new address was added
1161 * and we need to regenerate the HELLO even if nobody
1165 update_addresses (struct TransportPlugin *plugin, int fresh)
1167 struct GNUNET_TIME_Relative min_remaining;
1168 struct GNUNET_TIME_Relative remaining;
1169 struct GNUNET_TIME_Absolute now;
1170 struct AddressList *pos;
1171 struct AddressList *prev;
1172 struct AddressList *next;
1175 if (plugin->address_update_task != GNUNET_SCHEDULER_NO_TASK)
1176 GNUNET_SCHEDULER_cancel (plugin->env.sched, plugin->address_update_task);
1177 plugin->address_update_task = GNUNET_SCHEDULER_NO_TASK;
1178 now = GNUNET_TIME_absolute_get ();
1179 min_remaining = GNUNET_TIME_UNIT_FOREVER_REL;
1180 expired = GNUNET_NO;
1182 pos = plugin->addresses;
1186 if (pos->expires.value < now.value)
1188 expired = GNUNET_YES;
1190 plugin->addresses = pos->next;
1192 prev->next = pos->next;
1197 remaining = GNUNET_TIME_absolute_get_remaining (pos->expires);
1198 if (remaining.value < min_remaining.value)
1199 min_remaining = remaining;
1205 if (expired || fresh)
1207 if (min_remaining.value < GNUNET_TIME_UNIT_FOREVER_REL.value)
1208 plugin->address_update_task
1209 = GNUNET_SCHEDULER_add_delayed (plugin->env.sched,
1211 GNUNET_SCHEDULER_PRIORITY_IDLE,
1212 GNUNET_SCHEDULER_NO_TASK,
1214 &expire_address_task, plugin);
1220 * Task used to clean up expired addresses for a plugin.
1222 * @param cls closure
1226 expire_address_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1228 struct TransportPlugin *plugin = cls;
1229 plugin->address_update_task = GNUNET_SCHEDULER_NO_TASK;
1230 update_addresses (plugin, GNUNET_NO);
1235 * Function that must be called by each plugin to notify the
1236 * transport service about the addresses under which the transport
1237 * provided by the plugin can be reached.
1239 * @param cls closure
1240 * @param name name of the transport that generated the address
1241 * @param addr one of the addresses of the host, NULL for the last address
1242 * the specific address format depends on the transport
1243 * @param addrlen length of the address
1244 * @param expires when should this address automatically expire?
1247 plugin_env_notify_address (void *cls,
1251 struct GNUNET_TIME_Relative expires)
1253 struct TransportPlugin *p = cls;
1254 struct AddressList *al;
1255 struct GNUNET_TIME_Absolute abex;
1257 abex = GNUNET_TIME_relative_to_absolute (expires);
1258 GNUNET_assert (p == find_transport (name));
1263 if ((addrlen == al->addrlen) && (0 == memcmp (addr, &al[1], addrlen)))
1265 if (al->expires.value < abex.value)
1272 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1273 "Plugin `%s' informs us about a new address `%s'\n", name,
1274 GNUNET_a2s(addr, addrlen));
1276 al = GNUNET_malloc (sizeof (struct AddressList) + addrlen);
1278 al->next = p->addresses;
1281 al->addrlen = addrlen;
1282 memcpy (&al[1], addr, addrlen);
1283 update_addresses (p, GNUNET_YES);
1290 struct LookupHelloContext
1292 GNUNET_TRANSPORT_AddressCallback iterator;
1302 lookup_address_callback (void *cls,
1304 struct GNUNET_TIME_Absolute expiration,
1305 const void *addr, size_t addrlen)
1307 struct LookupHelloContext *lhc = cls;
1308 lhc->iterator (lhc->iterator_cls, tname, addr, addrlen);
1317 lookup_hello_callback (void *cls,
1318 const struct GNUNET_PeerIdentity *peer,
1319 const struct GNUNET_HELLO_Message *h, uint32_t trust)
1321 struct LookupHelloContext *lhc = cls;
1325 lhc->iterator (lhc->iterator_cls, NULL, NULL, 0);
1331 GNUNET_HELLO_iterate_addresses (h,
1332 GNUNET_NO, &lookup_address_callback, lhc);
1337 * Function that allows a transport to query the known
1338 * network addresses for a given peer.
1340 * @param cls closure
1341 * @param timeout after how long should we time out?
1342 * @param target which peer are we looking for?
1343 * @param iter function to call for each known address
1344 * @param iter_cls closure for iter
1347 plugin_env_lookup_address (void *cls,
1348 struct GNUNET_TIME_Relative timeout,
1349 const struct GNUNET_PeerIdentity *target,
1350 GNUNET_TRANSPORT_AddressCallback iter,
1353 struct LookupHelloContext *lhc;
1355 lhc = GNUNET_malloc (sizeof (struct LookupHelloContext));
1356 lhc->iterator = iter;
1357 lhc->iterator_cls = iter_cls;
1358 GNUNET_PEERINFO_for_all (cfg,
1360 target, 0, timeout, &lookup_hello_callback, &lhc);
1365 * Notify all of our clients about a peer connecting.
1368 notify_clients_connect (const struct GNUNET_PeerIdentity *peer,
1369 struct GNUNET_TIME_Relative latency)
1371 struct ConnectInfoMessage cim;
1372 struct TransportClient *cpos;
1375 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1376 "Informing clients about peer `%4s' connecting to us\n",
1379 cim.header.size = htons (sizeof (struct ConnectInfoMessage));
1380 cim.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
1381 cim.quota_out = htonl (GNUNET_CONSTANTS_DEFAULT_BPM_IN_OUT / (60*1000));
1382 cim.latency = GNUNET_TIME_relative_hton (latency);
1383 memcpy (&cim.id, peer, sizeof (struct GNUNET_PeerIdentity));
1385 while (cpos != NULL)
1387 transmit_to_client (cpos, &cim.header, GNUNET_NO);
1394 * Notify all of our clients about a peer disconnecting.
1397 notify_clients_disconnect (const struct GNUNET_PeerIdentity *peer)
1399 struct DisconnectInfoMessage dim;
1400 struct TransportClient *cpos;
1403 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1404 "Informing clients about peer `%4s' disconnecting\n",
1407 dim.header.size = htons (sizeof (struct DisconnectInfoMessage));
1408 dim.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
1409 dim.reserved = htonl (0);
1410 memcpy (&dim.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1412 while (cpos != NULL)
1414 transmit_to_client (cpos, &dim.header, GNUNET_NO);
1421 * Copy any validated addresses to buf.
1423 * @return 0 once all addresses have been
1427 list_validated_addresses (void *cls, size_t max, void *buf)
1429 struct ValidationAddress **va = cls;
1432 while ((NULL != *va) && ((*va)->ok != GNUNET_YES))
1436 ret = GNUNET_HELLO_add_address ((*va)->transport_name,
1438 &(*va)[1], (*va)->addr_len, buf, max);
1445 * HELLO validation cleanup task.
1448 cleanup_validation (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1450 struct ValidationAddress *va;
1451 struct ValidationList *pos;
1452 struct ValidationList *prev;
1453 struct GNUNET_TIME_Absolute now;
1454 struct GNUNET_HELLO_Message *hello;
1455 struct GNUNET_PeerIdentity pid;
1456 struct NeighbourList *n;
1459 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1460 "HELLO validation cleanup background task running...\n");
1462 now = GNUNET_TIME_absolute_get ();
1464 pos = pending_validations;
1467 if (pos->timeout.value < now.value)
1470 pending_validations = pos->next;
1472 prev->next = pos->next;
1473 va = pos->addresses;
1474 hello = GNUNET_HELLO_create (&pos->publicKey,
1475 &list_validated_addresses, &va);
1476 GNUNET_CRYPTO_hash (&pos->publicKey,
1478 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1481 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1482 "Creating persistent `%s' message for peer `%4s' based on confirmed addresses.\n",
1483 "HELLO", GNUNET_i2s (&pid));
1485 GNUNET_PEERINFO_add_peer (cfg, sched, &pid, hello);
1486 n = find_neighbour (&pid);
1488 try_transmission_to_peer (n);
1489 GNUNET_free (hello);
1490 while (NULL != (va = pos->addresses))
1492 pos->addresses = va->next;
1493 GNUNET_free (va->transport_name);
1498 pos = pending_validations;
1507 /* finally, reschedule cleanup if needed; list is
1508 ordered by timeout, so we need the last element... */
1509 pos = pending_validations;
1510 while ((pos != NULL) && (pos->next != NULL))
1513 GNUNET_SCHEDULER_add_delayed (sched,
1515 GNUNET_SCHEDULER_PRIORITY_IDLE,
1516 GNUNET_SCHEDULER_NO_TASK,
1517 GNUNET_TIME_absolute_get_remaining
1518 (pos->timeout), &cleanup_validation, NULL);
1525 * Function that will be called if we receive a validation
1526 * of an address challenge that we transmitted to another
1527 * peer. Note that the validation should only be considered
1528 * acceptable if the challenge matches AND if the sender
1529 * address is at least a plausible address for this peer
1530 * (otherwise we may be seeing a MiM attack).
1532 * @param cls closure
1533 * @param name name of the transport that generated the address
1534 * @param peer who responded to our challenge
1535 * @param challenge the challenge number we presumably used
1536 * @param sender_addr string describing our sender address (as observed
1537 * by the other peer in human-readable format)
1540 plugin_env_notify_validation (void *cls,
1542 const struct GNUNET_PeerIdentity *peer,
1544 const char *sender_addr)
1548 struct ValidationList *pos;
1549 struct ValidationAddress *va;
1550 struct GNUNET_PeerIdentity id;
1552 pos = pending_validations;
1555 GNUNET_CRYPTO_hash (&pos->publicKey,
1557 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1560 memcmp (peer, &id, sizeof (struct GNUNET_PeerIdentity)))
1566 /* TODO: call statistics (unmatched PONG) */
1567 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1569 ("Received validation response but have no record of any validation request for `%4s'. Ignoring.\n"),
1573 all_done = GNUNET_YES;
1574 matched = GNUNET_NO;
1575 va = pos->addresses;
1578 if (va->challenge == challenge)
1581 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1582 "Confirmed validity of peer address.\n");
1584 GNUNET_log (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
1585 _("Another peer saw us using the address `%s' via `%s'. If this is not plausible, this address should be listed in the configuration as implausible to avoid MiM attacks.\n"),
1588 va->ok = GNUNET_YES;
1590 GNUNET_TIME_relative_to_absolute (HELLO_ADDRESS_EXPIRATION);
1591 matched = GNUNET_YES;
1593 if (va->ok != GNUNET_YES)
1594 all_done = GNUNET_NO;
1597 if (GNUNET_NO == matched)
1599 /* TODO: call statistics (unmatched PONG) */
1600 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1602 ("Received `%s' message but have no record of a matching `%s' message. Ignoring.\n"),
1605 if (GNUNET_YES == all_done)
1607 pos->timeout.value = 0;
1608 GNUNET_SCHEDULER_add_delayed (sched,
1610 GNUNET_SCHEDULER_PRIORITY_IDLE,
1611 GNUNET_SCHEDULER_NO_TASK,
1612 GNUNET_TIME_UNIT_ZERO,
1613 &cleanup_validation, NULL);
1618 struct CheckHelloValidatedContext
1621 * Plugin for which we are validating.
1623 struct TransportPlugin *plugin;
1626 * Hello that we are validating.
1628 struct GNUNET_HELLO_Message *hello;
1631 * Validation list being build.
1633 struct ValidationList *e;
1639 * Append the given address to the list of entries
1640 * that need to be validated.
1643 run_validation (void *cls,
1645 struct GNUNET_TIME_Absolute expiration,
1646 const void *addr, size_t addrlen)
1648 struct ValidationList *e = cls;
1649 struct TransportPlugin *tp;
1650 struct ValidationAddress *va;
1651 struct GNUNET_PeerIdentity id;
1653 tp = find_transport (tname);
1656 GNUNET_log (GNUNET_ERROR_TYPE_INFO |
1657 GNUNET_ERROR_TYPE_BULK,
1659 ("Transport `%s' not loaded, will not try to validate peer address using this transport.\n"),
1663 GNUNET_CRYPTO_hash (&e->publicKey,
1665 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1667 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1668 "Scheduling validation of address `%s' via `%s' for `%4s'\n",
1669 GNUNET_a2s(addr, addrlen),
1673 va = GNUNET_malloc (sizeof (struct ValidationAddress) + addrlen);
1674 va->next = e->addresses;
1676 va->transport_name = GNUNET_strdup (tname);
1677 va->addr_len = addrlen;
1678 va->challenge = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1680 memcpy (&va[1], addr, addrlen);
1686 * Check if addresses in validated hello "h" overlap with
1687 * those in "chvc->hello" and update "chvc->hello" accordingly,
1688 * removing those addresses that have already been validated.
1691 check_hello_validated (void *cls,
1692 const struct GNUNET_PeerIdentity *peer,
1693 const struct GNUNET_HELLO_Message *h,
1696 struct CheckHelloValidatedContext *chvc = cls;
1697 struct ValidationAddress *va;
1698 struct TransportPlugin *tp;
1700 struct GNUNET_PeerIdentity apeer;
1702 first_call = GNUNET_NO;
1703 if (chvc->e == NULL)
1705 first_call = GNUNET_YES;
1706 chvc->e = GNUNET_malloc (sizeof (struct ValidationList));
1707 GNUNET_assert (GNUNET_OK ==
1708 GNUNET_HELLO_get_key (h != NULL ? h : chvc->hello,
1709 &chvc->e->publicKey));
1711 GNUNET_TIME_relative_to_absolute (HELLO_VERIFICATION_TIMEOUT);
1712 chvc->e->next = pending_validations;
1713 pending_validations = chvc->e;
1717 GNUNET_HELLO_iterate_new_addresses (chvc->hello,
1719 GNUNET_TIME_absolute_get (),
1720 &run_validation, chvc->e);
1722 else if (GNUNET_YES == first_call)
1724 /* no existing HELLO, all addresses are new */
1725 GNUNET_HELLO_iterate_addresses (chvc->hello,
1726 GNUNET_NO, &run_validation, chvc->e);
1729 return; /* wait for next call */
1730 /* finally, transmit validation attempts */
1731 GNUNET_assert (GNUNET_OK ==
1732 GNUNET_HELLO_get_id (chvc->hello,
1734 va = chvc->e->addresses;
1738 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1739 "Establishing `%s' connection to validate `%s' of `%4s'\n",
1742 GNUNET_i2s (&apeer));
1744 tp = find_transport (va->transport_name);
1745 GNUNET_assert (tp != NULL);
1747 tp->api->validate (tp->api->cls,
1750 HELLO_VERIFICATION_TIMEOUT,
1753 va->ok = GNUNET_SYSERR;
1756 if (chvc->e->next == NULL)
1757 GNUNET_SCHEDULER_add_delayed (sched,
1759 GNUNET_SCHEDULER_PRIORITY_IDLE,
1760 GNUNET_SCHEDULER_NO_TASK,
1761 GNUNET_TIME_absolute_get_remaining
1762 (chvc->e->timeout), &cleanup_validation,
1769 * Process HELLO-message.
1771 * @param plugin transport involved, may be NULL
1772 * @param message the actual message
1773 * @return GNUNET_OK if the HELLO was well-formed, GNUNET_SYSERR otherwise
1776 process_hello (struct TransportPlugin *plugin,
1777 const struct GNUNET_MessageHeader *message)
1779 struct ValidationList *e;
1781 struct GNUNET_PeerIdentity target;
1782 const struct GNUNET_HELLO_Message *hello;
1783 struct CheckHelloValidatedContext *chvc;
1784 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded publicKey;
1786 hsize = ntohs (message->size);
1787 if ((ntohs (message->type) != GNUNET_MESSAGE_TYPE_HELLO) ||
1788 (hsize < sizeof (struct GNUNET_MessageHeader)))
1791 return GNUNET_SYSERR;
1793 /* first, check if load is too high */
1794 if (GNUNET_OS_load_cpu_get (cfg) > 100)
1796 /* TODO: call to stats? */
1799 hello = (const struct GNUNET_HELLO_Message *) message;
1800 if (GNUNET_OK != GNUNET_HELLO_get_key (hello, &publicKey))
1802 GNUNET_break_op (0);
1803 return GNUNET_SYSERR;
1805 GNUNET_CRYPTO_hash (&publicKey,
1806 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1807 &target.hashPubKey);
1809 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1810 "Processing `%s' message for `%4s'\n",
1811 "HELLO", GNUNET_i2s (&target));
1813 /* check if a HELLO for this peer is already on the validation list */
1814 e = pending_validations;
1817 if (0 == memcmp (&e->publicKey,
1820 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded)))
1822 /* TODO: call to stats? */
1824 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1825 "`%s' message for peer `%4s' is already pending; ignoring new message\n",
1826 "HELLO", GNUNET_i2s (&target));
1832 chvc = GNUNET_malloc (sizeof (struct CheckHelloValidatedContext) + hsize);
1833 chvc->plugin = plugin;
1834 chvc->hello = (struct GNUNET_HELLO_Message *) &chvc[1];
1835 memcpy (chvc->hello, hello, hsize);
1836 /* finally, check if HELLO was previously validated
1837 (continuation will then schedule actual validation) */
1838 GNUNET_PEERINFO_for_all (cfg,
1842 HELLO_VERIFICATION_TIMEOUT,
1843 &check_hello_validated, chvc);
1849 * The peer specified by the given neighbour has timed-out or a plugin
1850 * has disconnected. We may either need to do nothing (other plugins
1851 * still up), or trigger a full disconnect and clean up. This
1852 * function updates our state and do the necessary notifications.
1853 * Also notifies our clients that the neighbour is now officially
1856 * @param n the neighbour list entry for the peer
1857 * @param check should we just check if all plugins
1858 * disconnected or must we ask all plugins to
1862 disconnect_neighbour (struct NeighbourList *n,
1865 struct ReadyList *rpos;
1866 struct NeighbourList *npos;
1867 struct NeighbourList *nprev;
1868 struct MessageQueue *mq;
1870 if (GNUNET_YES == check)
1873 while (NULL != rpos)
1875 if (GNUNET_YES == rpos->connected)
1876 return; /* still connected */
1882 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1883 "Disconnecting from `%4s'\n",
1884 GNUNET_i2s(&n->id));
1886 /* remove n from neighbours list */
1889 while ((npos != NULL) && (npos != n))
1894 GNUNET_assert (npos != NULL);
1896 neighbours = n->next;
1898 nprev->next = n->next;
1900 /* notify all clients about disconnect */
1901 notify_clients_disconnect (&n->id);
1903 /* clean up all plugins, cancel connections and pending transmissions */
1904 while (NULL != (rpos = n->plugins))
1906 n->plugins = rpos->next;
1907 GNUNET_assert (rpos->neighbour == n);
1908 if (GNUNET_YES == rpos->connected)
1909 rpos->plugin->api->cancel (rpos->plugin->api->cls,
1910 rpos->plugin_handle,
1916 /* free all messages on the queue */
1917 while (NULL != (mq = n->messages))
1919 n->messages = mq->next;
1920 GNUNET_assert (mq->neighbour == n);
1923 if (n->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1924 GNUNET_SCHEDULER_cancel (sched,
1926 /* finally, free n itself */
1932 * Add an entry for each of our transport plugins
1933 * (that are able to send) to the list of plugins
1934 * for this neighbour.
1936 * @param neighbour to initialize
1939 add_plugins (struct NeighbourList *neighbour)
1941 struct TransportPlugin *tp;
1942 struct ReadyList *rl;
1944 neighbour->retry_plugins_time
1945 = GNUNET_TIME_relative_to_absolute (PLUGIN_RETRY_FREQUENCY);
1949 if (tp->api->send != NULL)
1951 rl = GNUNET_malloc (sizeof (struct ReadyList));
1952 rl->next = neighbour->plugins;
1953 neighbour->plugins = rl;
1955 rl->neighbour = neighbour;
1956 rl->transmit_ready = GNUNET_YES;
1964 neighbour_timeout_task (void *cls,
1965 const struct GNUNET_SCHEDULER_TaskContext *tc)
1967 struct NeighbourList *n = cls;
1970 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1971 "Neighbour `%4s' has timed out!\n",
1972 GNUNET_i2s(&n->id));
1974 n->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1975 disconnect_neighbour (n, GNUNET_NO);
1980 * Create a fresh entry in our neighbour list for the given peer.
1981 * Will try to transmit our current HELLO to the new neighbour. Also
1982 * notifies our clients about the new "connection".
1984 * @param peer the peer for which we create the entry
1985 * @return the new neighbour list entry
1987 static struct NeighbourList *
1988 setup_new_neighbour (const struct GNUNET_PeerIdentity *peer)
1990 struct NeighbourList *n;
1993 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1994 "Setting up new neighbour `%4s', sending our HELLO to introduce ourselves\n",
1997 GNUNET_assert (our_hello != NULL);
1998 n = GNUNET_malloc (sizeof (struct NeighbourList));
1999 n->next = neighbours;
2002 n->last_quota_update = GNUNET_TIME_absolute_get ();
2004 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2005 n->quota_in = (GNUNET_CONSTANTS_DEFAULT_BPM_IN_OUT + 59999) / (60 * 1000);
2007 n->timeout_task = GNUNET_SCHEDULER_add_delayed (sched,
2009 GNUNET_SCHEDULER_PRIORITY_IDLE,
2010 GNUNET_SCHEDULER_NO_TASK,
2011 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
2012 &neighbour_timeout_task, n);
2013 transmit_to_peer (NULL, 0,
2014 (const struct GNUNET_MessageHeader *) our_hello,
2016 notify_clients_connect (peer, GNUNET_TIME_UNIT_FOREVER_REL);
2022 * Function called by the plugin for each received message.
2023 * Update data volumes, possibly notify plugins about
2024 * reducing the rate at which they read from the socket
2025 * and generally forward to our receive callback.
2027 * @param plugin_context value to pass to this plugin
2028 * to respond to the given peer (use is optional,
2029 * but may speed up processing)
2030 * @param service_context value passed to the transport-service
2031 * to identify the neighbour; will be NULL on the first
2032 * call for a given peer
2033 * @param latency estimated latency for communicating with the
2035 * @param peer (claimed) identity of the other peer
2036 * @param message the message, NULL if peer was disconnected
2037 * @return the new service_context that the plugin should use
2038 * for future receive calls for messages from this
2041 static struct ReadyList *
2042 plugin_env_receive (void *cls,
2043 void *plugin_context,
2044 struct ReadyList *service_context,
2045 struct GNUNET_TIME_Relative latency,
2046 const struct GNUNET_PeerIdentity *peer,
2047 const struct GNUNET_MessageHeader *message)
2049 const struct GNUNET_MessageHeader ack = {
2050 htons (sizeof (struct GNUNET_MessageHeader)),
2051 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_ACK)
2053 struct TransportPlugin *plugin = cls;
2054 struct TransportClient *cpos;
2055 struct InboundMessage *im;
2057 struct NeighbourList *n;
2059 if (service_context != NULL)
2061 n = service_context->neighbour;
2062 GNUNET_assert (n != NULL);
2066 n = find_neighbour (peer);
2069 if (message == NULL)
2070 return NULL; /* disconnect of peer already marked down */
2071 n = setup_new_neighbour (peer);
2073 service_context = n->plugins;
2074 while ((service_context != NULL) && (plugin != service_context->plugin))
2075 service_context = service_context->next;
2076 GNUNET_assert ((plugin->api->send == NULL) ||
2077 (service_context != NULL));
2079 if (message == NULL)
2082 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
2083 "Receive failed from `%4s', triggering disconnect\n",
2084 GNUNET_i2s(&n->id));
2086 /* TODO: call stats */
2087 if ((service_context != NULL) &&
2088 (service_context->plugin_handle == plugin_context))
2090 service_context->connected = GNUNET_NO;
2091 service_context->plugin_handle = NULL;
2093 disconnect_neighbour (n, GNUNET_YES);
2097 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
2098 "Processing message of type `%u' received by plugin...\n",
2099 ntohs (message->type));
2101 if (service_context != NULL)
2103 if (service_context->connected == GNUNET_NO)
2105 service_context->connected = GNUNET_YES;
2106 service_context->transmit_ready = GNUNET_YES;
2107 service_context->connect_attempts++;
2109 service_context->timeout
2110 = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2111 service_context->plugin_handle = plugin_context;
2112 service_context->latency = latency;
2114 /* update traffic received amount ... */
2115 msize = ntohs (message->size);
2116 n->last_received += msize;
2117 GNUNET_SCHEDULER_cancel (sched, n->timeout_task);
2119 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2121 GNUNET_SCHEDULER_add_delayed (sched, GNUNET_NO,
2122 GNUNET_SCHEDULER_PRIORITY_IDLE,
2123 GNUNET_SCHEDULER_NO_TASK,
2124 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
2125 &neighbour_timeout_task, n);
2127 if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
2129 /* dropping message due to frequent inbound volume violations! */
2130 GNUNET_log (GNUNET_ERROR_TYPE_WARNING |
2131 GNUNET_ERROR_TYPE_BULK,
2133 ("Dropping incoming message due to repeated bandwidth quota violations.\n"));
2134 /* TODO: call stats */
2135 GNUNET_assert ( (service_context == NULL) ||
2136 (NULL != service_context->neighbour) );
2137 return service_context;
2139 switch (ntohs (message->type))
2141 case GNUNET_MESSAGE_TYPE_HELLO:
2143 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2144 "Receiving `%s' message from `%4s'.\n", "HELLO",
2147 process_hello (plugin, message);
2149 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2150 "Sending `%s' message to connecting peer `%4s'.\n", "ACK",
2153 transmit_to_peer (NULL, 0, &ack, GNUNET_YES, n);
2155 case GNUNET_MESSAGE_TYPE_TRANSPORT_ACK:
2156 n->saw_ack = GNUNET_YES;
2157 /* intentional fall-through! */
2160 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2161 "Received message of type %u from `%4s', sending to all clients.\n",
2162 ntohs (message->type),
2165 /* transmit message to all clients */
2166 im = GNUNET_malloc (sizeof (struct InboundMessage) + msize);
2167 im->header.size = htons (sizeof (struct InboundMessage) + msize);
2168 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
2169 im->latency = GNUNET_TIME_relative_hton (latency);
2171 memcpy (&im[1], message, msize);
2174 while (cpos != NULL)
2176 transmit_to_client (cpos, &im->header, GNUNET_YES);
2181 GNUNET_assert (NULL != service_context->neighbour);
2182 return service_context;
2187 * Handle START-message. This is the first message sent to us
2188 * by any client which causes us to add it to our list.
2190 * @param cls closure (always NULL)
2191 * @param client identification of the client
2192 * @param message the actual message
2195 handle_start (void *cls,
2196 struct GNUNET_SERVER_Client *client,
2197 const struct GNUNET_MessageHeader *message)
2199 struct TransportClient *c;
2200 struct ConnectInfoMessage cim;
2201 struct NeighbourList *n;
2202 struct InboundMessage *im;
2203 struct GNUNET_MessageHeader *ack;
2206 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2207 "Received `%s' request from client\n", "START");
2212 if (c->client == client)
2214 /* client already on our list! */
2216 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2221 c = GNUNET_malloc (sizeof (struct TransportClient));
2225 if (our_hello != NULL)
2228 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2229 "Sending our own `%s' to new client\n",
2232 transmit_to_client (c,
2233 (const struct GNUNET_MessageHeader *) our_hello,
2235 /* tell new client about all existing connections */
2236 cim.header.size = htons (sizeof (struct ConnectInfoMessage));
2237 cim.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
2238 cim.quota_out = htonl (GNUNET_CONSTANTS_DEFAULT_BPM_IN_OUT / (60 * 1000));
2239 cim.latency = GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_ZERO); /* FIXME? */
2240 im = GNUNET_malloc (sizeof (struct InboundMessage) +
2241 sizeof (struct GNUNET_MessageHeader));
2242 im->header.size = htons (sizeof (struct InboundMessage) +
2243 sizeof (struct GNUNET_MessageHeader));
2244 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
2245 im->latency = GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_ZERO); /* FIXME? */
2246 ack = (struct GNUNET_MessageHeader *) &im[1];
2247 ack->size = htons (sizeof (struct GNUNET_MessageHeader));
2248 ack->type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_ACK);
2249 for (n = neighbours; n != NULL; n = n->next)
2252 transmit_to_client (c, &cim.header, GNUNET_NO);
2256 transmit_to_client (c, &im->header, GNUNET_NO);
2261 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2266 * Handle HELLO-message.
2268 * @param cls closure (always NULL)
2269 * @param client identification of the client
2270 * @param message the actual message
2273 handle_hello (void *cls,
2274 struct GNUNET_SERVER_Client *client,
2275 const struct GNUNET_MessageHeader *message)
2280 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2281 "Received `%s' request from client\n", "HELLO");
2283 ret = process_hello (NULL, message);
2284 GNUNET_SERVER_receive_done (client, ret);
2289 * Handle SEND-message.
2291 * @param cls closure (always NULL)
2292 * @param client identification of the client
2293 * @param message the actual message
2296 handle_send (void *cls,
2297 struct GNUNET_SERVER_Client *client,
2298 const struct GNUNET_MessageHeader *message)
2300 struct TransportClient *tc;
2301 struct NeighbourList *n;
2302 const struct OutboundMessage *obm;
2303 const struct GNUNET_MessageHeader *obmm;
2307 size = ntohs (message->size);
2309 sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
2312 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2315 obm = (const struct OutboundMessage *) message;
2317 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2318 "Received `%s' request from client with target `%4s'\n",
2319 "SEND", GNUNET_i2s (&obm->peer));
2321 obmm = (const struct GNUNET_MessageHeader *) &obm[1];
2322 msize = ntohs (obmm->size);
2323 if (size != msize + sizeof (struct OutboundMessage))
2326 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2329 n = find_neighbour (&obm->peer);
2331 n = setup_new_neighbour (&obm->peer);
2333 while ((tc != NULL) && (tc->client != client))
2337 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2338 "Client asked to transmit %u-byte message of type %u to `%4s'\n",
2340 ntohs (obmm->type), GNUNET_i2s (&obm->peer));
2342 transmit_to_peer (tc, ntohl(obm->priority), obmm, GNUNET_NO, n);
2343 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2348 * Handle SET_QUOTA-message.
2350 * @param cls closure (always NULL)
2351 * @param client identification of the client
2352 * @param message the actual message
2355 handle_set_quota (void *cls,
2356 struct GNUNET_SERVER_Client *client,
2357 const struct GNUNET_MessageHeader *message)
2359 const struct QuotaSetMessage *qsm =
2360 (const struct QuotaSetMessage *) message;
2361 struct NeighbourList *n;
2362 struct TransportPlugin *p;
2363 struct ReadyList *rl;
2366 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2367 "Received `%s' request from client for peer `%4s'\n",
2368 "SET_QUOTA", GNUNET_i2s (&qsm->peer));
2370 n = find_neighbour (&qsm->peer);
2373 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2377 if (n->quota_in < ntohl (qsm->quota_in))
2378 n->last_quota_update = GNUNET_TIME_absolute_get ();
2379 n->quota_in = ntohl (qsm->quota_in);
2384 p->api->set_receive_quota (p->api->cls,
2385 &qsm->peer, ntohl (qsm->quota_in));
2388 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2393 * Handle TRY_CONNECT-message.
2395 * @param cls closure (always NULL)
2396 * @param client identification of the client
2397 * @param message the actual message
2400 handle_try_connect (void *cls,
2401 struct GNUNET_SERVER_Client *client,
2402 const struct GNUNET_MessageHeader *message)
2404 const struct TryConnectMessage *tcm;
2406 tcm = (const struct TryConnectMessage *) message;
2408 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2409 "Received `%s' request from client %p asking to connect to `%4s'\n",
2412 GNUNET_i2s (&tcm->peer));
2414 if (NULL == find_neighbour (&tcm->peer))
2415 setup_new_neighbour (&tcm->peer);
2418 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2419 "Client asked to connect to `%4s', but connection already exists\n",
2421 GNUNET_i2s (&tcm->peer));
2423 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2428 * List of handlers for the messages understood by this
2431 static struct GNUNET_SERVER_MessageHandler handlers[] = {
2432 {&handle_start, NULL,
2433 GNUNET_MESSAGE_TYPE_TRANSPORT_START, 0},
2434 {&handle_hello, NULL,
2435 GNUNET_MESSAGE_TYPE_HELLO, 0},
2436 {&handle_send, NULL,
2437 GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, 0},
2438 {&handle_set_quota, NULL,
2439 GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA, sizeof (struct QuotaSetMessage)},
2440 {&handle_try_connect, NULL,
2441 GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT,
2442 sizeof (struct TryConnectMessage)},
2448 * Setup the environment for this plugin.
2451 create_environment (struct TransportPlugin *plug)
2453 plug->env.cfg = cfg;
2454 plug->env.sched = sched;
2455 plug->env.my_public_key = &my_public_key;
2456 plug->env.my_private_key = my_private_key;
2457 plug->env.my_identity = &my_identity;
2458 plug->env.cls = plug;
2459 plug->env.receive = &plugin_env_receive;
2460 plug->env.lookup = &plugin_env_lookup_address;
2461 plug->env.notify_address = &plugin_env_notify_address;
2462 plug->env.notify_validation = &plugin_env_notify_validation;
2463 plug->env.default_quota_in = (GNUNET_CONSTANTS_DEFAULT_BPM_IN_OUT + 59999) / (60 * 1000);
2464 plug->env.max_connections = max_connect_per_transport;
2469 * Start the specified transport (load the plugin).
2472 start_transport (struct GNUNET_SERVER_Handle *server, const char *name)
2474 struct TransportPlugin *plug;
2477 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2478 _("Loading `%s' transport plugin\n"), name);
2479 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", name);
2480 plug = GNUNET_malloc (sizeof (struct TransportPlugin));
2481 create_environment (plug);
2482 plug->short_name = GNUNET_strdup (name);
2483 plug->lib_name = libname;
2484 plug->next = plugins;
2486 plug->api = GNUNET_PLUGIN_load (libname, &plug->env);
2487 if (plug->api == NULL)
2489 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2490 _("Failed to load transport plugin for `%s'\n"), name);
2491 GNUNET_free (plug->short_name);
2492 plugins = plug->next;
2493 GNUNET_free (libname);
2500 * Called whenever a client is disconnected. Frees our
2501 * resources associated with that client.
2503 * @param cls closure
2504 * @param client identification of the client
2507 client_disconnect_notification (void *cls,
2508 struct GNUNET_SERVER_Client *client)
2510 struct TransportClient *pos;
2511 struct TransportClient *prev;
2512 struct ClientMessageQueueEntry *mqe;
2515 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
2516 "Client disconnected, cleaning up.\n");
2520 while ((pos != NULL) && (pos->client != client))
2527 while (NULL != (mqe = pos->message_queue_head))
2529 pos->message_queue_head = mqe->next;
2532 pos->message_queue_head = NULL;
2534 clients = pos->next;
2536 prev->next = pos->next;
2537 if (GNUNET_YES == pos->tcs_pending)
2547 * Initiate transport service.
2549 * @param cls closure
2550 * @param s scheduler to use
2551 * @param serv the initialized server
2552 * @param c configuration to use
2556 struct GNUNET_SCHEDULER_Handle *s,
2557 struct GNUNET_SERVER_Handle *serv,
2558 const struct GNUNET_CONFIGURATION_Handle *c)
2563 unsigned long long tneigh;
2568 /* parse configuration */
2570 GNUNET_CONFIGURATION_get_value_number (c,
2575 GNUNET_CONFIGURATION_get_value_filename (c,
2577 "HOSTKEY", &keyfile)))
2579 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2581 ("Transport service is lacking key configuration settings. Exiting.\n"));
2582 GNUNET_SCHEDULER_shutdown (s);
2585 max_connect_per_transport = (uint32_t) tneigh;
2586 my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
2587 GNUNET_free (keyfile);
2588 if (my_private_key == NULL)
2590 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2592 ("Transport service could not access hostkey. Exiting.\n"));
2593 GNUNET_SCHEDULER_shutdown (s);
2596 GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
2597 GNUNET_CRYPTO_hash (&my_public_key,
2598 sizeof (my_public_key), &my_identity.hashPubKey);
2599 /* setup notification */
2601 GNUNET_SERVER_disconnect_notify (server,
2602 &client_disconnect_notification, NULL);
2603 /* load plugins... */
2606 GNUNET_CONFIGURATION_get_value_string (c,
2607 "TRANSPORT", "PLUGINS", &plugs))
2609 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2610 _("Starting transport plugins `%s'\n"), plugs);
2611 pos = strtok (plugs, " ");
2614 start_transport (server, pos);
2616 pos = strtok (NULL, " ");
2618 GNUNET_free (plugs);
2623 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2624 _("Transport service ready.\n"));
2626 /* process client requests */
2627 GNUNET_SERVER_add_handlers (server, handlers);
2632 * Function called when the service shuts
2633 * down. Unloads our plugins.
2635 * @param cls closure
2636 * @param cfg configuration to use
2639 unload_plugins (void *cls,
2640 const struct GNUNET_CONFIGURATION_Handle *cfg)
2642 struct TransportPlugin *plug;
2643 struct AddressList *al;
2646 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2647 "Transport service is unloading plugins...\n");
2649 while (NULL != (plug = plugins))
2651 plugins = plug->next;
2652 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
2653 GNUNET_free (plug->lib_name);
2654 GNUNET_free (plug->short_name);
2655 while (NULL != (al = plug->addresses))
2657 plug->addresses = al->next;
2662 if (my_private_key != NULL)
2663 GNUNET_CRYPTO_rsa_key_free (my_private_key);
2664 GNUNET_free_non_null (our_hello);
2669 * The main function for the transport service.
2671 * @param argc number of arguments from the command line
2672 * @param argv command line arguments
2673 * @return 0 ok, 1 on error
2676 main (int argc, char *const *argv)
2678 return (GNUNET_OK ==
2679 GNUNET_SERVICE_run (argc,
2682 &run, NULL, &unload_plugins, NULL)) ? 0 : 1;
2685 /* end of gnunet-service-transport.c */