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?
70 * Must be rather small, otherwise a partially successful HELLO
71 * validation (some addresses working) might not be available
72 * before a client's request for a connection fails for good.
73 * Besides, if a single request to an address takes a long time,
74 * then the peer is unlikely worthwhile anyway.
76 #define HELLO_VERIFICATION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
79 * How often do we re-add (cheaper) plugins to our list of plugins
80 * to try for a given connected peer?
82 #define PLUGIN_RETRY_FREQUENCY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
85 * After how long do we expire an address in a HELLO
86 * that we just validated? This value is also used
87 * for our own addresses when we create a HELLO.
89 #define HELLO_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 12)
93 * Entry in linked list of network addresses.
98 * This is a linked list.
100 struct AddressList *next;
103 * The address, actually a pointer to the end
104 * of this struct. Do not free!
109 * How long until we auto-expire this address (unless it is
110 * re-confirmed by the transport)?
112 struct GNUNET_TIME_Absolute expires;
123 * Entry in linked list of all of our plugins.
125 struct TransportPlugin
129 * This is a linked list.
131 struct TransportPlugin *next;
134 * API of the transport as returned by the plugin's
135 * initialization function.
137 struct GNUNET_TRANSPORT_PluginFunctions *api;
140 * Short name for the plugin (i.e. "tcp").
145 * Name of the library (i.e. "gnunet_plugin_transport_tcp").
150 * List of our known addresses for this transport.
152 struct AddressList *addresses;
155 * Environment this transport service is using
158 struct GNUNET_TRANSPORT_PluginEnvironment env;
161 * ID of task that is used to clean up expired addresses.
163 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
167 * Set to GNUNET_YES if we need to scrap the existing
168 * list of "addresses" and start fresh when we receive
169 * the next address update from a transport. Set to
170 * GNUNET_NO if we should just add the new address
171 * to the list and wait for the commit call.
176 struct NeighbourList;
179 * For each neighbour we keep a list of messages
180 * that we still want to transmit to the neighbour.
186 * This is a linked list.
188 struct MessageQueue *next;
191 * The message we want to transmit.
193 struct GNUNET_MessageHeader *message;
196 * Client responsible for queueing the message;
197 * used to check that a client has not two messages
198 * pending for the same target. Can be NULL.
200 struct TransportClient *client;
203 * Neighbour this entry belongs to.
205 struct NeighbourList *neighbour;
208 * Plugin that we used for the transmission.
209 * NULL until we scheduled a transmission.
211 struct TransportPlugin *plugin;
214 * Internal message of the transport system that should not be
215 * included in the usual SEND-SEND_OK transmission confirmation
216 * traffic management scheme. Typically, "internal_msg" will
217 * be set whenever "client" is NULL (but it is not strictly
223 * How important is the message?
225 unsigned int priority;
231 * For a given Neighbour, which plugins are available
232 * to talk to this peer and what are their costs?
238 * This is a linked list.
240 struct ReadyList *next;
243 * Which of our transport plugins does this entry
246 struct TransportPlugin *plugin;
249 * Neighbour this entry belongs to.
251 struct NeighbourList *neighbour;
254 * What was the last latency observed for this plugin
255 * and peer? Invalid if connected is GNUNET_NO.
257 struct GNUNET_TIME_Relative latency;
260 * If we did not successfully transmit a message to the
261 * given peer via this connection during the specified
262 * time, we should consider the connection to be dead.
263 * This is used in the case that a TCP transport simply
264 * stalls writing to the stream but does not formerly
265 * get a signal that the other peer died.
267 struct GNUNET_TIME_Absolute timeout;
270 * Is this plugin currently connected? The first time
271 * we transmit or send data to a peer via a particular
272 * plugin, we set this to GNUNET_YES. If we later get
273 * an error (disconnect notification or transmission
274 * failure), we set it back to GNUNET_NO. Each time the
275 * value is set to GNUNET_YES, we increment the
276 * "connect_attempts" counter. If that one reaches a
277 * particular threshold, we consider the plugin to not
278 * be working properly at this time for the given peer
279 * and remove it from the eligible list.
284 * How often have we tried to connect using this plugin?
286 unsigned int connect_attempts;
289 * Is this plugin ready to transmit to the specific
290 * target? GNUNET_NO if not. Initially, all plugins
291 * are marked ready. If a transmission is in progress,
292 * "transmit_ready" is set to GNUNET_NO.
300 * Entry in linked list of all of our current neighbours.
306 * This is a linked list.
308 struct NeighbourList *next;
311 * Which of our transports is connected to this peer
312 * and what is their status?
314 struct ReadyList *plugins;
317 * List of messages we would like to send to this peer;
318 * must contain at most one message per client.
320 struct MessageQueue *messages;
323 * Identity of this neighbour.
325 struct GNUNET_PeerIdentity id;
328 * ID of task scheduled to run when this peer is about to
329 * time out (will free resources associated with the peer).
331 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
334 * How long until we should consider this peer dead
335 * (if we don't receive another message in the
338 struct GNUNET_TIME_Absolute peer_timeout;
341 * At what time did we reset last_received last?
343 struct GNUNET_TIME_Absolute last_quota_update;
346 * At what time should we try to again add plugins to
349 struct GNUNET_TIME_Absolute retry_plugins_time;
352 * How many bytes have we received since the "last_quota_update"
355 uint64_t last_received;
358 * Global quota for inbound traffic for the neighbour in bytes/ms.
363 * How often has the other peer (recently) violated the
364 * inbound traffic limit? Incremented by 10 per violation,
365 * decremented by 1 per non-violation (for each
368 unsigned int quota_violation_count;
371 * Have we seen an ACK from this neighbour in the past?
372 * (used to make up a fake ACK for clients connecting after
373 * the neighbour connected to us).
381 * Linked list of messages to be transmitted to
382 * the client. Each entry is followed by the
385 struct ClientMessageQueueEntry
388 * This is a linked list.
390 struct ClientMessageQueueEntry *next;
395 * Client connected to the transport service.
397 struct TransportClient
401 * This is a linked list.
403 struct TransportClient *next;
406 * Handle to the client.
408 struct GNUNET_SERVER_Client *client;
411 * Linked list of messages yet to be transmitted to
414 struct ClientMessageQueueEntry *message_queue_head;
417 * Tail of linked list of messages yet to be transmitted to the
420 struct ClientMessageQueueEntry *message_queue_tail;
423 * Is a call to "transmit_send_continuation" pending? If so, we
424 * must not free this struct (even if the corresponding client
425 * disconnects) and instead only remove it from the linked list and
426 * set the "client" field to NULL.
431 * Length of the list of messages pending for this client.
433 unsigned int message_count;
439 * For each HELLO, we may have to validate multiple addresses;
440 * each address gets its own request entry.
442 struct ValidationAddress
445 * This is a linked list.
447 struct ValidationAddress *next;
450 * Name of the transport.
452 char *transport_name;
455 * When should this validated address expire?
457 struct GNUNET_TIME_Absolute expiration;
460 * Length of the address we are validating.
465 * Challenge number we used.
470 * Set to GNUNET_YES if the challenge was met,
471 * GNUNET_SYSERR if we know it failed, GNUNET_NO
472 * if we are waiting on a response.
479 * Entry in linked list of all HELLOs awaiting validation.
481 struct ValidationList
485 * This is a linked list.
487 struct ValidationList *next;
490 * Linked list with one entry per address from the HELLO
491 * that needs to be validated.
493 struct ValidationAddress *addresses;
496 * The public key of the peer.
498 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded publicKey;
501 * When does this record time-out? (assuming the
502 * challenge goes unanswered)
504 struct GNUNET_TIME_Absolute timeout;
510 * HELLOs awaiting validation.
512 static struct ValidationList *pending_validations;
517 static struct GNUNET_HELLO_Message *our_hello;
520 * "version" of "our_hello". Used to see if a given
521 * neighbour has already been sent the latest version
522 * of our HELLO message.
524 static unsigned int our_hello_version;
529 static struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
534 static struct GNUNET_PeerIdentity my_identity;
539 static struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;
544 struct GNUNET_SCHEDULER_Handle *sched;
549 const struct GNUNET_CONFIGURATION_Handle *cfg;
552 * Linked list of all clients to this service.
554 static struct TransportClient *clients;
557 * All loaded plugins.
559 static struct TransportPlugin *plugins;
564 static struct GNUNET_SERVER_Handle *server;
567 * All known neighbours and their HELLOs.
569 static struct NeighbourList *neighbours;
572 * Number of neighbours we'd like to have.
574 static uint32_t max_connect_per_transport;
578 * Find an entry in the neighbour list for a particular peer.
580 * @return NULL if not found.
582 static struct NeighbourList *
583 find_neighbour (const struct GNUNET_PeerIdentity *key)
585 struct NeighbourList *head = neighbours;
586 while ((head != NULL) &&
587 (0 != memcmp (key, &head->id, sizeof (struct GNUNET_PeerIdentity))))
594 * Find an entry in the transport list for a particular transport.
596 * @return NULL if not found.
598 static struct TransportPlugin *
599 find_transport (const char *short_name)
601 struct TransportPlugin *head = plugins;
602 while ((head != NULL) && (0 != strcmp (short_name, head->short_name)))
609 * Update the quota values for the given neighbour now.
612 update_quota (struct NeighbourList *n)
614 struct GNUNET_TIME_Relative delta;
618 delta = GNUNET_TIME_absolute_get_duration (n->last_quota_update);
619 if (delta.value < MIN_QUOTA_REFRESH_TIME)
620 return; /* not enough time passed for doing quota update */
621 allowed = delta.value * n->quota_in;
622 if (n->last_received < allowed)
624 remaining = allowed - n->last_received;
626 remaining /= n->quota_in;
629 if (remaining > MAX_BANDWIDTH_CARRY)
630 remaining = MAX_BANDWIDTH_CARRY;
631 n->last_received = 0;
632 n->last_quota_update = GNUNET_TIME_absolute_get ();
633 n->last_quota_update.value -= remaining;
634 if (n->quota_violation_count > 0)
635 n->quota_violation_count--;
639 n->last_received -= allowed;
640 n->last_quota_update = GNUNET_TIME_absolute_get ();
641 if (n->last_received > allowed)
643 /* more than twice the allowed rate! */
644 n->quota_violation_count += 10;
651 * Function called to notify a client about the socket
652 * being ready to queue more data. "buf" will be
653 * NULL and "size" zero if the socket was closed for
654 * writing in the meantime.
657 * @param size number of bytes available in buf
658 * @param buf where the callee should write the message
659 * @return number of bytes written to buf
662 transmit_to_client_callback (void *cls, size_t size, void *buf)
664 struct TransportClient *client = cls;
665 struct ClientMessageQueueEntry *q;
668 const struct GNUNET_MessageHeader *msg;
669 struct GNUNET_CONNECTION_TransmitHandle *th;
674 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
675 "Transmission to client failed, closing connection.\n");
676 /* fatal error with client, free message queue! */
677 while (NULL != (q = client->message_queue_head))
679 client->message_queue_head = q->next;
682 client->message_queue_tail = NULL;
683 client->message_count = 0;
688 while (NULL != (q = client->message_queue_head))
690 msg = (const struct GNUNET_MessageHeader *) &q[1];
691 msize = ntohs (msg->size);
692 if (msize + tsize > size)
695 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
696 "Transmitting message of type %u to client.\n",
699 client->message_queue_head = q->next;
701 client->message_queue_tail = NULL;
702 memcpy (&cbuf[tsize], msg, msize);
705 client->message_count--;
709 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
710 th = GNUNET_SERVER_notify_transmit_ready (client->client,
712 GNUNET_TIME_UNIT_FOREVER_REL,
713 &transmit_to_client_callback,
715 GNUNET_assert (th != NULL);
722 * Send the specified message to the specified client. Since multiple
723 * messages may be pending for the same client at a time, this code
724 * makes sure that no message is lost.
726 * @param client client to transmit the message to
727 * @param msg the message to send
728 * @param may_drop can this message be dropped if the
729 * message queue for this client is getting far too large?
732 transmit_to_client (struct TransportClient *client,
733 const struct GNUNET_MessageHeader *msg, int may_drop)
735 struct ClientMessageQueueEntry *q;
737 struct GNUNET_CONNECTION_TransmitHandle *th;
739 if ((client->message_count >= MAX_PENDING) && (GNUNET_YES == may_drop))
741 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
743 ("Dropping message, have %u messages pending (%u is the soft limit)\n"),
744 client->message_count, MAX_PENDING);
745 /* TODO: call to statistics... */
748 client->message_count++;
749 msize = ntohs (msg->size);
750 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
751 q = GNUNET_malloc (sizeof (struct ClientMessageQueueEntry) + msize);
752 memcpy (&q[1], msg, msize);
753 /* append to message queue */
754 if (client->message_queue_tail == NULL)
756 client->message_queue_tail = q;
760 client->message_queue_tail->next = q;
761 client->message_queue_tail = q;
763 if (client->message_queue_head == NULL)
765 client->message_queue_head = q;
766 th = GNUNET_SERVER_notify_transmit_ready (client->client,
768 GNUNET_TIME_UNIT_FOREVER_REL,
769 &transmit_to_client_callback,
771 GNUNET_assert (th != NULL);
777 * Find alternative plugins for communication.
779 * @param neighbour for which neighbour should we try to find
783 try_alternative_plugins (struct NeighbourList *neighbour)
785 struct ReadyList *rl;
787 if ((neighbour->plugins != NULL) &&
788 (neighbour->retry_plugins_time.value >
789 GNUNET_TIME_absolute_get ().value))
790 return; /* don't try right now */
791 neighbour->retry_plugins_time
792 = GNUNET_TIME_relative_to_absolute (PLUGIN_RETRY_FREQUENCY);
794 rl = neighbour->plugins;
797 if (rl->connect_attempts > 0)
798 rl->connect_attempts--; /* amnesty */
806 * The peer specified by the given neighbour has timed-out or a plugin
807 * has disconnected. We may either need to do nothing (other plugins
808 * still up), or trigger a full disconnect and clean up. This
809 * function updates our state and do the necessary notifications.
810 * Also notifies our clients that the neighbour is now officially
813 * @param n the neighbour list entry for the peer
814 * @param check should we just check if all plugins
815 * disconnected or must we ask all plugins to
819 disconnect_neighbour (struct NeighbourList *n,
824 * Check the ready list for the given neighbour and
825 * if a plugin is ready for transmission (and if we
826 * have a message), do so!
828 * @param neighbour target peer for which to check the plugins
831 try_transmission_to_peer (struct NeighbourList *neighbour);
835 * Function called by the GNUNET_TRANSPORT_TransmitFunction
836 * upon "completion" of a send request. This tells the API
837 * that it is now legal to send another message to the given
840 * @param cls closure, identifies the entry on the
841 * message queue that was transmitted and the
842 * client responsible for queueing the message
843 * @param target the peer receiving the message
844 * @param result GNUNET_OK on success, if the transmission
845 * failed, we should not tell the client to transmit
849 transmit_send_continuation (void *cls,
850 const struct GNUNET_PeerIdentity *target,
853 struct MessageQueue *mq = cls;
854 struct ReadyList *rl;
855 struct SendOkMessage send_ok_msg;
856 struct NeighbourList *n;
858 GNUNET_assert (mq != NULL);
860 GNUNET_assert (n != NULL);
862 memcmp (&n->id, target,
863 sizeof (struct GNUNET_PeerIdentity)));
865 while ((rl != NULL) && (rl->plugin != mq->plugin))
867 GNUNET_assert (rl != NULL);
868 if (result == GNUNET_OK)
870 rl->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
874 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
875 "Transmission to peer `%s' failed, marking connection as down.\n",
877 rl->connected = GNUNET_NO;
879 if (!mq->internal_msg)
880 rl->transmit_ready = GNUNET_YES;
881 if (mq->client != NULL)
883 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
884 "Notifying client %p about failed transission to peer `%4s'.\n",
887 send_ok_msg.header.size = htons (sizeof (send_ok_msg));
888 send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
889 send_ok_msg.success = htonl (result);
890 send_ok_msg.peer = n->id;
891 transmit_to_client (mq->client, &send_ok_msg.header, GNUNET_NO);
893 GNUNET_free (mq->message);
895 /* one plugin just became ready again, try transmitting
896 another message (if available) */
897 if (result == GNUNET_OK)
898 try_transmission_to_peer (n);
900 disconnect_neighbour (n, GNUNET_YES);
905 * Check the ready list for the given neighbour and
906 * if a plugin is ready for transmission (and if we
907 * have a message), do so!
910 try_transmission_to_peer (struct NeighbourList *neighbour)
912 struct ReadyList *pos;
913 struct GNUNET_TIME_Relative min_latency;
914 struct ReadyList *rl;
915 struct MessageQueue *mq;
916 struct GNUNET_TIME_Absolute now;
918 if (neighbour->messages == NULL)
919 return; /* nothing to do */
920 try_alternative_plugins (neighbour);
921 min_latency = GNUNET_TIME_UNIT_FOREVER_REL;
923 mq = neighbour->messages;
924 now = GNUNET_TIME_absolute_get ();
925 pos = neighbour->plugins;
928 /* set plugins that are inactive for a long time back to disconnected */
929 if ((pos->timeout.value < now.value) && (pos->connected == GNUNET_YES))
932 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
933 "Marking long-time inactive connection to `%4s' as down.\n",
934 GNUNET_i2s (&neighbour->id));
936 pos->connected = GNUNET_NO;
938 if (((GNUNET_YES == pos->transmit_ready) ||
939 (mq->internal_msg)) &&
940 (pos->connect_attempts < MAX_CONNECT_RETRY) &&
941 ((rl == NULL) || (min_latency.value > pos->latency.value)))
944 min_latency = pos->latency;
951 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
952 "No plugin ready to transmit message\n");
954 return; /* nobody ready */
956 if (GNUNET_NO == rl->connected)
958 rl->connect_attempts++;
959 rl->connected = GNUNET_YES;
961 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
962 "Establishing fresh connection with `%4s' via plugin `%s'\n",
963 GNUNET_i2s (&neighbour->id), rl->plugin->short_name);
966 neighbour->messages = mq->next;
967 mq->plugin = rl->plugin;
968 if (!mq->internal_msg)
969 rl->transmit_ready = GNUNET_NO;
971 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
972 "Giving message of type `%u' for `%4s' to plugin `%s'\n",
973 ntohs (mq->message->type),
974 GNUNET_i2s (&neighbour->id), rl->plugin->short_name);
976 rl->plugin->api->send (rl->plugin->api->cls,
980 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
981 &transmit_send_continuation, mq);
986 * Send the specified message to the specified peer.
988 * @param client source of the transmission request (can be NULL)
989 * @param priority how important is the message
990 * @param msg message to send
991 * @param is_internal is this an internal message
992 * @param neighbour handle to the neighbour for transmission
995 transmit_to_peer (struct TransportClient *client,
996 unsigned int priority,
997 const struct GNUNET_MessageHeader *msg,
998 int is_internal, struct NeighbourList *neighbour)
1000 struct MessageQueue *mq;
1001 struct MessageQueue *mqe;
1002 struct GNUNET_MessageHeader *m;
1005 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1006 _("Sending message of type %u to peer `%4s'\n"),
1007 ntohs (msg->type), GNUNET_i2s (&neighbour->id));
1011 /* check for duplicate submission */
1012 mq = neighbour->messages;
1015 if (mq->client == client)
1017 /* client transmitted to same peer twice
1018 before getting SendOk! */
1025 mq = GNUNET_malloc (sizeof (struct MessageQueue));
1026 mq->client = client;
1027 m = GNUNET_malloc (ntohs (msg->size));
1028 memcpy (m, msg, ntohs (msg->size));
1030 mq->neighbour = neighbour;
1031 mq->internal_msg = is_internal;
1032 mq->priority = priority;
1035 mqe = neighbour->messages;
1037 while (mqe->next != NULL)
1042 neighbour->messages = mq;
1043 try_transmission_to_peer (neighbour);
1056 struct GeneratorContext
1058 struct TransportPlugin *plug_pos;
1059 struct AddressList *addr_pos;
1060 struct GNUNET_TIME_Absolute expiration;
1068 address_generator (void *cls, size_t max, void *buf)
1070 struct GeneratorContext *gc = cls;
1073 while ((gc->addr_pos == NULL) && (gc->plug_pos != NULL))
1075 gc->plug_pos = gc->plug_pos->next;
1076 gc->addr_pos = (gc->plug_pos != NULL) ? gc->plug_pos->addresses : NULL;
1078 if (NULL == gc->plug_pos)
1080 ret = GNUNET_HELLO_add_address (gc->plug_pos->short_name,
1083 gc->addr_pos->addrlen, buf, max);
1084 gc->addr_pos = gc->addr_pos->next;
1090 * Construct our HELLO message from all of the addresses of
1091 * all of the transports.
1096 struct GNUNET_HELLO_Message *hello;
1097 struct TransportClient *cpos;
1098 struct NeighbourList *npos;
1099 struct GeneratorContext gc;
1102 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1103 "Refreshing my `%s'\n",
1106 gc.plug_pos = plugins;
1107 gc.addr_pos = plugins != NULL ? plugins->addresses : NULL;
1108 gc.expiration = GNUNET_TIME_relative_to_absolute (HELLO_ADDRESS_EXPIRATION);
1109 hello = GNUNET_HELLO_create (&my_public_key, &address_generator, &gc);
1111 while (cpos != NULL)
1113 transmit_to_client (cpos,
1114 (const struct GNUNET_MessageHeader *) hello,
1119 GNUNET_free_non_null (our_hello);
1121 our_hello_version++;
1122 GNUNET_PEERINFO_add_peer (cfg, sched, &my_identity, our_hello);
1124 while (npos != NULL)
1127 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1128 "Transmitting updated `%s' to neighbour `%4s'\n",
1130 GNUNET_i2s(&npos->id));
1132 transmit_to_peer (NULL, 0,
1133 (const struct GNUNET_MessageHeader *) our_hello,
1141 * Task used to clean up expired addresses for a plugin.
1143 * @param cls closure
1147 expire_address_task (void *cls,
1148 const struct GNUNET_SCHEDULER_TaskContext *tc);
1152 * Update the list of addresses for this plugin,
1153 * expiring those that are past their expiration date.
1155 * @param plugin addresses of which plugin should be recomputed?
1156 * @param fresh set to GNUNET_YES if a new address was added
1157 * and we need to regenerate the HELLO even if nobody
1161 update_addresses (struct TransportPlugin *plugin, int fresh)
1163 struct GNUNET_TIME_Relative min_remaining;
1164 struct GNUNET_TIME_Relative remaining;
1165 struct GNUNET_TIME_Absolute now;
1166 struct AddressList *pos;
1167 struct AddressList *prev;
1168 struct AddressList *next;
1171 if (plugin->address_update_task != GNUNET_SCHEDULER_NO_TASK)
1172 GNUNET_SCHEDULER_cancel (plugin->env.sched, plugin->address_update_task);
1173 plugin->address_update_task = GNUNET_SCHEDULER_NO_TASK;
1174 now = GNUNET_TIME_absolute_get ();
1175 min_remaining = GNUNET_TIME_UNIT_FOREVER_REL;
1176 expired = GNUNET_NO;
1178 pos = plugin->addresses;
1182 if (pos->expires.value < now.value)
1184 expired = GNUNET_YES;
1186 plugin->addresses = pos->next;
1188 prev->next = pos->next;
1193 remaining = GNUNET_TIME_absolute_get_remaining (pos->expires);
1194 if (remaining.value < min_remaining.value)
1195 min_remaining = remaining;
1201 if (expired || fresh)
1203 if (min_remaining.value < GNUNET_TIME_UNIT_FOREVER_REL.value)
1204 plugin->address_update_task
1205 = GNUNET_SCHEDULER_add_delayed (plugin->env.sched,
1207 &expire_address_task, plugin);
1213 * Task used to clean up expired addresses for a plugin.
1215 * @param cls closure
1219 expire_address_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1221 struct TransportPlugin *plugin = cls;
1222 plugin->address_update_task = GNUNET_SCHEDULER_NO_TASK;
1223 update_addresses (plugin, GNUNET_NO);
1228 * Function that must be called by each plugin to notify the
1229 * transport service about the addresses under which the transport
1230 * provided by the plugin can be reached.
1232 * @param cls closure
1233 * @param name name of the transport that generated the address
1234 * @param addr one of the addresses of the host, NULL for the last address
1235 * the specific address format depends on the transport
1236 * @param addrlen length of the address
1237 * @param expires when should this address automatically expire?
1240 plugin_env_notify_address (void *cls,
1244 struct GNUNET_TIME_Relative expires)
1246 struct TransportPlugin *p = cls;
1247 struct AddressList *al;
1248 struct GNUNET_TIME_Absolute abex;
1250 abex = GNUNET_TIME_relative_to_absolute (expires);
1251 GNUNET_assert (p == find_transport (name));
1256 if ((addrlen == al->addrlen) && (0 == memcmp (addr, &al[1], addrlen)))
1258 if (al->expires.value < abex.value)
1265 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1266 "Plugin `%s' informs us about a new address `%s'\n", name,
1267 GNUNET_a2s(addr, addrlen));
1269 al = GNUNET_malloc (sizeof (struct AddressList) + addrlen);
1271 al->next = p->addresses;
1274 al->addrlen = addrlen;
1275 memcpy (&al[1], addr, addrlen);
1276 update_addresses (p, GNUNET_YES);
1281 * Notify all of our clients about a peer connecting.
1284 notify_clients_connect (const struct GNUNET_PeerIdentity *peer,
1285 struct GNUNET_TIME_Relative latency)
1287 struct ConnectInfoMessage cim;
1288 struct TransportClient *cpos;
1291 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1292 "Informing clients about peer `%4s' connecting to us\n",
1295 cim.header.size = htons (sizeof (struct ConnectInfoMessage));
1296 cim.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
1297 cim.quota_out = htonl (GNUNET_CONSTANTS_DEFAULT_BPM_IN_OUT / (60*1000));
1298 cim.latency = GNUNET_TIME_relative_hton (latency);
1299 memcpy (&cim.id, peer, sizeof (struct GNUNET_PeerIdentity));
1301 while (cpos != NULL)
1303 transmit_to_client (cpos, &cim.header, GNUNET_NO);
1310 * Notify all of our clients about a peer disconnecting.
1313 notify_clients_disconnect (const struct GNUNET_PeerIdentity *peer)
1315 struct DisconnectInfoMessage dim;
1316 struct TransportClient *cpos;
1319 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1320 "Informing clients about peer `%4s' disconnecting\n",
1323 dim.header.size = htons (sizeof (struct DisconnectInfoMessage));
1324 dim.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT);
1325 dim.reserved = htonl (0);
1326 memcpy (&dim.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1328 while (cpos != NULL)
1330 transmit_to_client (cpos, &dim.header, GNUNET_NO);
1337 * Copy any validated addresses to buf.
1339 * @return 0 once all addresses have been
1343 list_validated_addresses (void *cls, size_t max, void *buf)
1345 struct ValidationAddress **va = cls;
1348 while ((NULL != *va) && ((*va)->ok != GNUNET_YES))
1352 ret = GNUNET_HELLO_add_address ((*va)->transport_name,
1354 &(*va)[1], (*va)->addr_len, buf, max);
1361 * HELLO validation cleanup task.
1364 cleanup_validation (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1366 struct ValidationAddress *va;
1367 struct ValidationList *pos;
1368 struct ValidationList *prev;
1369 struct GNUNET_TIME_Absolute now;
1370 struct GNUNET_TIME_Absolute first;
1371 struct GNUNET_HELLO_Message *hello;
1372 struct GNUNET_PeerIdentity pid;
1373 struct NeighbourList *n;
1376 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1377 "HELLO validation cleanup background task running...\n");
1379 now = GNUNET_TIME_absolute_get ();
1381 pos = pending_validations;
1384 if (pos->timeout.value < now.value)
1387 pending_validations = pos->next;
1389 prev->next = pos->next;
1390 va = pos->addresses;
1391 hello = GNUNET_HELLO_create (&pos->publicKey,
1392 &list_validated_addresses, &va);
1393 GNUNET_CRYPTO_hash (&pos->publicKey,
1395 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1398 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1399 "Creating persistent `%s' message for peer `%4s' based on confirmed addresses.\n",
1400 "HELLO", GNUNET_i2s (&pid));
1402 GNUNET_PEERINFO_add_peer (cfg, sched, &pid, hello);
1403 n = find_neighbour (&pid);
1405 try_transmission_to_peer (n);
1406 GNUNET_free (hello);
1407 while (NULL != (va = pos->addresses))
1409 pos->addresses = va->next;
1410 GNUNET_free (va->transport_name);
1415 pos = pending_validations;
1424 /* finally, reschedule cleanup if needed; list is
1425 ordered by timeout, so we need the last element... */
1426 if (NULL != pending_validations)
1428 first = pending_validations->timeout;
1429 pos = pending_validations;
1432 first = GNUNET_TIME_absolute_min (first, pos->timeout);
1435 GNUNET_SCHEDULER_add_delayed (sched,
1436 GNUNET_TIME_absolute_get_remaining (first),
1437 &cleanup_validation, NULL);
1445 * Function that will be called if we receive a validation
1446 * of an address challenge that we transmitted to another
1447 * peer. Note that the validation should only be considered
1448 * acceptable if the challenge matches AND if the sender
1449 * address is at least a plausible address for this peer
1450 * (otherwise we may be seeing a MiM attack).
1452 * @param cls closure
1453 * @param name name of the transport that generated the address
1454 * @param peer who responded to our challenge
1455 * @param challenge the challenge number we presumably used
1456 * @param sender_addr string describing our sender address (as observed
1457 * by the other peer in human-readable format)
1460 plugin_env_notify_validation (void *cls,
1462 const struct GNUNET_PeerIdentity *peer,
1464 const char *sender_addr)
1466 unsigned int not_done;
1468 struct ValidationList *pos;
1469 struct ValidationAddress *va;
1470 struct GNUNET_PeerIdentity id;
1472 pos = pending_validations;
1475 GNUNET_CRYPTO_hash (&pos->publicKey,
1477 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1480 memcmp (peer, &id, sizeof (struct GNUNET_PeerIdentity)))
1486 /* TODO: call statistics (unmatched PONG) */
1487 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1489 ("Received validation response but have no record of any validation request for `%4s'. Ignoring.\n"),
1494 matched = GNUNET_NO;
1495 va = pos->addresses;
1498 if (va->challenge == challenge)
1501 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1502 "Confirmed validity of address, peer `%4s' has address `%s'.\n",
1504 GNUNET_a2s ((const struct sockaddr*) &va[1],
1507 GNUNET_log (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
1508 _("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"),
1511 va->ok = GNUNET_YES;
1513 GNUNET_TIME_relative_to_absolute (HELLO_ADDRESS_EXPIRATION);
1514 matched = GNUNET_YES;
1516 if (va->ok != GNUNET_YES)
1520 if (GNUNET_NO == matched)
1522 /* TODO: call statistics (unmatched PONG) */
1523 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1525 ("Received `%s' message but have no record of a matching `%s' message. Ignoring.\n"),
1531 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1532 "All addresses validated, will now construct `%s' for `%4s'.\n",
1536 pos->timeout.value = 0;
1537 GNUNET_SCHEDULER_add_with_priority (sched,
1538 GNUNET_SCHEDULER_PRIORITY_IDLE,
1539 &cleanup_validation, NULL);
1544 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1545 "Still waiting for %u additional `%s' messages before constructing `%s' for `%4s'.\n",
1555 struct CheckHelloValidatedContext
1558 * Plugin for which we are validating.
1560 struct TransportPlugin *plugin;
1563 * Hello that we are validating.
1565 struct GNUNET_HELLO_Message *hello;
1568 * Validation list being build.
1570 struct ValidationList *e;
1573 * Context for peerinfo iteration.
1574 * NULL after we are done processing peerinfo's information.
1576 struct GNUNET_PEERINFO_IteratorContext *piter;
1582 * Append the given address to the list of entries
1583 * that need to be validated.
1586 run_validation (void *cls,
1588 struct GNUNET_TIME_Absolute expiration,
1589 const void *addr, size_t addrlen)
1591 struct ValidationList *e = cls;
1592 struct TransportPlugin *tp;
1593 struct ValidationAddress *va;
1594 struct GNUNET_PeerIdentity id;
1596 tp = find_transport (tname);
1599 GNUNET_log (GNUNET_ERROR_TYPE_INFO |
1600 GNUNET_ERROR_TYPE_BULK,
1602 ("Transport `%s' not loaded, will not try to validate peer address using this transport.\n"),
1606 GNUNET_CRYPTO_hash (&e->publicKey,
1608 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1610 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1611 "Scheduling validation of address `%s' via `%s' for `%4s'\n",
1612 GNUNET_a2s(addr, addrlen),
1616 va = GNUNET_malloc (sizeof (struct ValidationAddress) + addrlen);
1617 va->next = e->addresses;
1619 va->transport_name = GNUNET_strdup (tname);
1620 va->addr_len = addrlen;
1621 va->challenge = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1623 memcpy (&va[1], addr, addrlen);
1629 * Check if addresses in validated hello "h" overlap with
1630 * those in "chvc->hello" and update "chvc->hello" accordingly,
1631 * removing those addresses that have already been validated.
1634 check_hello_validated (void *cls,
1635 const struct GNUNET_PeerIdentity *peer,
1636 const struct GNUNET_HELLO_Message *h,
1639 struct CheckHelloValidatedContext *chvc = cls;
1640 struct ValidationAddress *va;
1641 struct TransportPlugin *tp;
1643 struct GNUNET_PeerIdentity apeer;
1645 first_call = GNUNET_NO;
1646 if (chvc->e == NULL)
1649 first_call = GNUNET_YES;
1650 chvc->e = GNUNET_malloc (sizeof (struct ValidationList));
1651 GNUNET_assert (GNUNET_OK ==
1652 GNUNET_HELLO_get_key (h != NULL ? h : chvc->hello,
1653 &chvc->e->publicKey));
1655 GNUNET_TIME_relative_to_absolute (HELLO_VERIFICATION_TIMEOUT);
1656 chvc->e->next = pending_validations;
1657 pending_validations = chvc->e;
1661 GNUNET_HELLO_iterate_new_addresses (chvc->hello,
1663 GNUNET_TIME_absolute_get (),
1664 &run_validation, chvc->e);
1666 else if (GNUNET_YES == first_call)
1668 /* no existing HELLO, all addresses are new */
1669 GNUNET_HELLO_iterate_addresses (chvc->hello,
1670 GNUNET_NO, &run_validation, chvc->e);
1673 return; /* wait for next call */
1674 /* finally, transmit validation attempts */
1675 GNUNET_assert (GNUNET_OK ==
1676 GNUNET_HELLO_get_id (chvc->hello,
1679 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1680 "Ready to validate addresses from `%s' message for peer `%4s'\n",
1681 "HELLO", GNUNET_i2s (&apeer));
1683 va = chvc->e->addresses;
1687 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1688 "Establishing `%s' connection to validate `%s' address `%s' of `%4s'\n",
1691 GNUNET_a2s ((const struct sockaddr*) &va[1],
1693 GNUNET_i2s (&apeer));
1695 tp = find_transport (va->transport_name);
1696 GNUNET_assert (tp != NULL);
1698 tp->api->validate (tp->api->cls,
1701 HELLO_VERIFICATION_TIMEOUT,
1704 va->ok = GNUNET_SYSERR;
1707 GNUNET_SCHEDULER_add_delayed (sched,
1708 GNUNET_TIME_absolute_get_remaining (chvc->e->timeout),
1709 &cleanup_validation, NULL);
1715 * Process HELLO-message.
1717 * @param plugin transport involved, may be NULL
1718 * @param message the actual message
1719 * @return GNUNET_OK if the HELLO was well-formed, GNUNET_SYSERR otherwise
1722 process_hello (struct TransportPlugin *plugin,
1723 const struct GNUNET_MessageHeader *message)
1725 struct ValidationList *e;
1727 struct GNUNET_PeerIdentity target;
1728 const struct GNUNET_HELLO_Message *hello;
1729 struct CheckHelloValidatedContext *chvc;
1730 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded publicKey;
1732 hsize = ntohs (message->size);
1733 if ((ntohs (message->type) != GNUNET_MESSAGE_TYPE_HELLO) ||
1734 (hsize < sizeof (struct GNUNET_MessageHeader)))
1737 return GNUNET_SYSERR;
1739 /* first, check if load is too high */
1740 if (GNUNET_OS_load_cpu_get (cfg) > 100)
1742 /* TODO: call to stats? */
1745 hello = (const struct GNUNET_HELLO_Message *) message;
1746 if (GNUNET_OK != GNUNET_HELLO_get_key (hello, &publicKey))
1748 GNUNET_break_op (0);
1749 return GNUNET_SYSERR;
1751 GNUNET_CRYPTO_hash (&publicKey,
1752 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
1753 &target.hashPubKey);
1755 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1756 "Processing `%s' message for `%4s'\n",
1757 "HELLO", GNUNET_i2s (&target));
1759 /* check if a HELLO for this peer is already on the validation list */
1760 e = pending_validations;
1763 if (0 == memcmp (&e->publicKey,
1766 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded)))
1768 /* TODO: call to stats? */
1770 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1771 "`%s' message for peer `%4s' is already pending; ignoring new message\n",
1772 "HELLO", GNUNET_i2s (&target));
1778 chvc = GNUNET_malloc (sizeof (struct CheckHelloValidatedContext) + hsize);
1779 chvc->plugin = plugin;
1780 chvc->hello = (struct GNUNET_HELLO_Message *) &chvc[1];
1781 memcpy (chvc->hello, hello, hsize);
1782 /* finally, check if HELLO was previously validated
1783 (continuation will then schedule actual validation) */
1784 chvc->piter = GNUNET_PEERINFO_iterate (cfg,
1788 HELLO_VERIFICATION_TIMEOUT,
1789 &check_hello_validated, chvc);
1795 * The peer specified by the given neighbour has timed-out or a plugin
1796 * has disconnected. We may either need to do nothing (other plugins
1797 * still up), or trigger a full disconnect and clean up. This
1798 * function updates our state and do the necessary notifications.
1799 * Also notifies our clients that the neighbour is now officially
1802 * @param n the neighbour list entry for the peer
1803 * @param check should we just check if all plugins
1804 * disconnected or must we ask all plugins to
1808 disconnect_neighbour (struct NeighbourList *n,
1811 struct ReadyList *rpos;
1812 struct NeighbourList *npos;
1813 struct NeighbourList *nprev;
1814 struct MessageQueue *mq;
1816 if (GNUNET_YES == check)
1819 while (NULL != rpos)
1821 if (GNUNET_YES == rpos->connected)
1822 return; /* still connected */
1828 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1829 "Disconnecting from `%4s'\n",
1830 GNUNET_i2s(&n->id));
1832 /* remove n from neighbours list */
1835 while ((npos != NULL) && (npos != n))
1840 GNUNET_assert (npos != NULL);
1842 neighbours = n->next;
1844 nprev->next = n->next;
1846 /* notify all clients about disconnect */
1847 notify_clients_disconnect (&n->id);
1849 /* clean up all plugins, cancel connections and pending transmissions */
1850 while (NULL != (rpos = n->plugins))
1852 n->plugins = rpos->next;
1853 GNUNET_assert (rpos->neighbour == n);
1854 if (GNUNET_YES == rpos->connected)
1855 rpos->plugin->api->disconnect (rpos->plugin->api->cls,
1860 /* free all messages on the queue */
1861 while (NULL != (mq = n->messages))
1863 n->messages = mq->next;
1864 GNUNET_assert (mq->neighbour == n);
1867 if (n->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1868 GNUNET_SCHEDULER_cancel (sched,
1870 /* finally, free n itself */
1876 * Add an entry for each of our transport plugins
1877 * (that are able to send) to the list of plugins
1878 * for this neighbour.
1880 * @param neighbour to initialize
1883 add_plugins (struct NeighbourList *neighbour)
1885 struct TransportPlugin *tp;
1886 struct ReadyList *rl;
1888 neighbour->retry_plugins_time
1889 = GNUNET_TIME_relative_to_absolute (PLUGIN_RETRY_FREQUENCY);
1893 if (tp->api->send != NULL)
1895 rl = GNUNET_malloc (sizeof (struct ReadyList));
1896 rl->next = neighbour->plugins;
1897 neighbour->plugins = rl;
1899 rl->neighbour = neighbour;
1900 rl->transmit_ready = GNUNET_YES;
1908 neighbour_timeout_task (void *cls,
1909 const struct GNUNET_SCHEDULER_TaskContext *tc)
1911 struct NeighbourList *n = cls;
1914 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1915 "Neighbour `%4s' has timed out!\n",
1916 GNUNET_i2s(&n->id));
1918 n->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1919 disconnect_neighbour (n, GNUNET_NO);
1924 * Create a fresh entry in our neighbour list for the given peer.
1925 * Will try to transmit our current HELLO to the new neighbour. Also
1926 * notifies our clients about the new "connection".
1928 * @param peer the peer for which we create the entry
1929 * @return the new neighbour list entry
1931 static struct NeighbourList *
1932 setup_new_neighbour (const struct GNUNET_PeerIdentity *peer)
1934 struct NeighbourList *n;
1937 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1938 "Setting up new neighbour `%4s', sending our HELLO to introduce ourselves\n",
1941 GNUNET_assert (our_hello != NULL);
1942 n = GNUNET_malloc (sizeof (struct NeighbourList));
1943 n->next = neighbours;
1946 n->last_quota_update = GNUNET_TIME_absolute_get ();
1948 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1949 n->quota_in = (GNUNET_CONSTANTS_DEFAULT_BPM_IN_OUT + 59999) / (60 * 1000);
1951 n->timeout_task = GNUNET_SCHEDULER_add_delayed (sched,
1952 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1953 &neighbour_timeout_task, n);
1954 transmit_to_peer (NULL, 0,
1955 (const struct GNUNET_MessageHeader *) our_hello,
1957 notify_clients_connect (peer, GNUNET_TIME_UNIT_FOREVER_REL);
1963 * Function called by the plugin for each received message.
1964 * Update data volumes, possibly notify plugins about
1965 * reducing the rate at which they read from the socket
1966 * and generally forward to our receive callback.
1968 * @param cls the "struct TransportPlugin *" we gave to the plugin
1969 * @param latency estimated latency for communicating with the
1971 * @param peer (claimed) identity of the other peer
1972 * @param message the message, NULL if peer was disconnected
1973 * @return the new service_context that the plugin should use
1974 * for future receive calls for messages from this
1978 plugin_env_receive (void *cls,
1979 struct GNUNET_TIME_Relative latency,
1980 const struct GNUNET_PeerIdentity *peer,
1981 const struct GNUNET_MessageHeader *message)
1983 const struct GNUNET_MessageHeader ack = {
1984 htons (sizeof (struct GNUNET_MessageHeader)),
1985 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_ACK)
1987 struct ReadyList *service_context;
1988 struct TransportPlugin *plugin = cls;
1989 struct TransportClient *cpos;
1990 struct InboundMessage *im;
1992 struct NeighbourList *n;
1994 n = find_neighbour (peer);
1997 if (message == NULL)
1998 return; /* disconnect of peer already marked down */
1999 n = setup_new_neighbour (peer);
2001 service_context = n->plugins;
2002 while ( (service_context != NULL) &&
2003 (plugin != service_context->plugin) )
2004 service_context = service_context->next;
2005 GNUNET_assert ((plugin->api->send == NULL) ||
2006 (service_context != NULL));
2007 if (message == NULL)
2010 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
2011 "Receive failed from `%4s', triggering disconnect\n",
2012 GNUNET_i2s(&n->id));
2014 /* TODO: call stats */
2015 if (service_context != NULL)
2016 service_context->connected = GNUNET_NO;
2017 disconnect_neighbour (n, GNUNET_YES);
2021 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
2022 "Processing message of type `%u' received by plugin...\n",
2023 ntohs (message->type));
2025 if (service_context != NULL)
2027 if (service_context->connected == GNUNET_NO)
2029 service_context->connected = GNUNET_YES;
2030 service_context->transmit_ready = GNUNET_YES;
2031 service_context->connect_attempts++;
2033 service_context->timeout
2034 = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2035 service_context->latency = latency;
2037 /* update traffic received amount ... */
2038 msize = ntohs (message->size);
2039 n->last_received += msize;
2040 GNUNET_SCHEDULER_cancel (sched, n->timeout_task);
2042 GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
2044 GNUNET_SCHEDULER_add_delayed (sched,
2045 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
2046 &neighbour_timeout_task, n);
2048 if (n->quota_violation_count > QUOTA_VIOLATION_DROP_THRESHOLD)
2050 /* dropping message due to frequent inbound volume violations! */
2051 GNUNET_log (GNUNET_ERROR_TYPE_WARNING |
2052 GNUNET_ERROR_TYPE_BULK,
2054 ("Dropping incoming message due to repeated bandwidth quota violations.\n"));
2055 /* TODO: call stats */
2056 GNUNET_assert ( (service_context == NULL) ||
2057 (NULL != service_context->neighbour) );
2060 switch (ntohs (message->type))
2062 case GNUNET_MESSAGE_TYPE_HELLO:
2064 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2065 "Receiving `%s' message from `%4s'.\n", "HELLO",
2068 process_hello (plugin, message);
2070 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2071 "Sending `%s' message to connecting peer `%4s'.\n", "ACK",
2074 transmit_to_peer (NULL, 0, &ack, GNUNET_YES, n);
2076 case GNUNET_MESSAGE_TYPE_TRANSPORT_ACK:
2077 n->saw_ack = GNUNET_YES;
2078 /* intentional fall-through! */
2081 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2082 "Received message of type %u from `%4s', sending to all clients.\n",
2083 ntohs (message->type),
2086 /* transmit message to all clients */
2087 im = GNUNET_malloc (sizeof (struct InboundMessage) + msize);
2088 im->header.size = htons (sizeof (struct InboundMessage) + msize);
2089 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
2090 im->latency = GNUNET_TIME_relative_hton (latency);
2092 memcpy (&im[1], message, msize);
2095 while (cpos != NULL)
2097 transmit_to_client (cpos, &im->header, GNUNET_YES);
2102 GNUNET_assert ( (service_context == NULL) ||
2103 (NULL != service_context->neighbour) );
2108 * Handle START-message. This is the first message sent to us
2109 * by any client which causes us to add it to our list.
2111 * @param cls closure (always NULL)
2112 * @param client identification of the client
2113 * @param message the actual message
2116 handle_start (void *cls,
2117 struct GNUNET_SERVER_Client *client,
2118 const struct GNUNET_MessageHeader *message)
2120 struct TransportClient *c;
2121 struct ConnectInfoMessage cim;
2122 struct NeighbourList *n;
2123 struct InboundMessage *im;
2124 struct GNUNET_MessageHeader *ack;
2127 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2128 "Received `%s' request from client\n", "START");
2133 if (c->client == client)
2135 /* client already on our list! */
2137 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2142 c = GNUNET_malloc (sizeof (struct TransportClient));
2146 if (our_hello != NULL)
2149 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2150 "Sending our own `%s' to new client\n",
2153 transmit_to_client (c,
2154 (const struct GNUNET_MessageHeader *) our_hello,
2156 /* tell new client about all existing connections */
2157 cim.header.size = htons (sizeof (struct ConnectInfoMessage));
2158 cim.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
2159 cim.quota_out = htonl (GNUNET_CONSTANTS_DEFAULT_BPM_IN_OUT / (60 * 1000));
2160 cim.latency = GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_ZERO); /* FIXME? */
2161 im = GNUNET_malloc (sizeof (struct InboundMessage) +
2162 sizeof (struct GNUNET_MessageHeader));
2163 im->header.size = htons (sizeof (struct InboundMessage) +
2164 sizeof (struct GNUNET_MessageHeader));
2165 im->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_RECV);
2166 im->latency = GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_ZERO); /* FIXME? */
2167 ack = (struct GNUNET_MessageHeader *) &im[1];
2168 ack->size = htons (sizeof (struct GNUNET_MessageHeader));
2169 ack->type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_ACK);
2170 for (n = neighbours; n != NULL; n = n->next)
2173 transmit_to_client (c, &cim.header, GNUNET_NO);
2177 transmit_to_client (c, &im->header, GNUNET_NO);
2182 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2187 * Handle HELLO-message.
2189 * @param cls closure (always NULL)
2190 * @param client identification of the client
2191 * @param message the actual message
2194 handle_hello (void *cls,
2195 struct GNUNET_SERVER_Client *client,
2196 const struct GNUNET_MessageHeader *message)
2201 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2202 "Received `%s' request from client\n", "HELLO");
2204 ret = process_hello (NULL, message);
2205 GNUNET_SERVER_receive_done (client, ret);
2210 * Handle SEND-message.
2212 * @param cls closure (always NULL)
2213 * @param client identification of the client
2214 * @param message the actual message
2217 handle_send (void *cls,
2218 struct GNUNET_SERVER_Client *client,
2219 const struct GNUNET_MessageHeader *message)
2221 struct TransportClient *tc;
2222 struct NeighbourList *n;
2223 const struct OutboundMessage *obm;
2224 const struct GNUNET_MessageHeader *obmm;
2228 size = ntohs (message->size);
2230 sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
2233 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2236 obm = (const struct OutboundMessage *) message;
2238 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2239 "Received `%s' request from client with target `%4s'\n",
2240 "SEND", GNUNET_i2s (&obm->peer));
2242 obmm = (const struct GNUNET_MessageHeader *) &obm[1];
2243 msize = ntohs (obmm->size);
2244 if (size != msize + sizeof (struct OutboundMessage))
2247 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2250 n = find_neighbour (&obm->peer);
2252 n = setup_new_neighbour (&obm->peer);
2254 while ((tc != NULL) && (tc->client != client))
2258 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2259 "Client asked to transmit %u-byte message of type %u to `%4s'\n",
2261 ntohs (obmm->type), GNUNET_i2s (&obm->peer));
2263 transmit_to_peer (tc, ntohl(obm->priority), obmm, GNUNET_NO, n);
2264 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2269 * Handle SET_QUOTA-message.
2271 * @param cls closure (always NULL)
2272 * @param client identification of the client
2273 * @param message the actual message
2276 handle_set_quota (void *cls,
2277 struct GNUNET_SERVER_Client *client,
2278 const struct GNUNET_MessageHeader *message)
2280 const struct QuotaSetMessage *qsm =
2281 (const struct QuotaSetMessage *) message;
2282 struct NeighbourList *n;
2283 struct TransportPlugin *p;
2284 struct ReadyList *rl;
2287 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2288 "Received `%s' request from client for peer `%4s'\n",
2289 "SET_QUOTA", GNUNET_i2s (&qsm->peer));
2291 n = find_neighbour (&qsm->peer);
2294 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2298 if (n->quota_in < ntohl (qsm->quota_in))
2299 n->last_quota_update = GNUNET_TIME_absolute_get ();
2300 n->quota_in = ntohl (qsm->quota_in);
2305 p->api->set_receive_quota (p->api->cls,
2306 &qsm->peer, ntohl (qsm->quota_in));
2309 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2314 * Handle TRY_CONNECT-message.
2316 * @param cls closure (always NULL)
2317 * @param client identification of the client
2318 * @param message the actual message
2321 handle_try_connect (void *cls,
2322 struct GNUNET_SERVER_Client *client,
2323 const struct GNUNET_MessageHeader *message)
2325 const struct TryConnectMessage *tcm;
2327 tcm = (const struct TryConnectMessage *) message;
2329 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2330 "Received `%s' request from client %p asking to connect to `%4s'\n",
2333 GNUNET_i2s (&tcm->peer));
2335 if (NULL == find_neighbour (&tcm->peer))
2336 setup_new_neighbour (&tcm->peer);
2339 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
2340 "Client asked to connect to `%4s', but connection already exists\n",
2342 GNUNET_i2s (&tcm->peer));
2344 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2348 transmit_address_to_client (void *cls, const char *address)
2350 struct GNUNET_SERVER_TransmitContext *tc = cls;
2353 if (NULL == address)
2356 slen = strlen (address) + 1;
2357 GNUNET_SERVER_transmit_context_append (tc, address, slen,
2358 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
2359 if (NULL == address)
2360 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
2364 * Handle AddressLookup-message.
2366 * @param cls closure (always NULL)
2367 * @param client identification of the client
2368 * @param message the actual message
2371 handle_address_lookup (void *cls,
2372 struct GNUNET_SERVER_Client *client,
2373 const struct GNUNET_MessageHeader *message)
2375 const struct AddressLookupMessage *alum;
2376 struct TransportPlugin *lsPlugin;
2377 const char *nameTransport;
2378 const char *address;
2380 struct GNUNET_SERVER_TransmitContext *tc;
2382 size = ntohs (message->size);
2383 if (size < sizeof(struct AddressLookupMessage))
2385 GNUNET_break_op (0);
2386 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2389 alum = (const struct AddressLookupMessage *) message;
2390 uint32_t addressLen = ntohl(alum->addrlen);
2391 if (size <= sizeof(struct AddressLookupMessage) + addressLen)
2393 GNUNET_break_op (0);
2394 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2397 address = (const char *)&alum[1];
2398 nameTransport = (const char*)&address[addressLen];
2399 if (nameTransport [size - sizeof (struct AddressLookupMessage) - addressLen -1] != '\0')
2401 GNUNET_break_op (0);
2402 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2405 struct GNUNET_TIME_Absolute timeout= GNUNET_TIME_absolute_ntoh(alum->timeout);
2406 struct GNUNET_TIME_Relative rtimeout = GNUNET_TIME_absolute_get_remaining(timeout);
2407 lsPlugin = find_transport(nameTransport);
2408 if (NULL == lsPlugin)
2410 tc = GNUNET_SERVER_transmit_context_create (client);
2411 GNUNET_SERVER_transmit_context_append (tc, NULL, 0, GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
2412 GNUNET_SERVER_transmit_context_run (tc, rtimeout);
2415 tc = GNUNET_SERVER_transmit_context_create (client);
2416 lsPlugin->api->address_pretty_printer(cls, nameTransport,
2417 address, addressLen, GNUNET_YES, rtimeout, &transmit_address_to_client, tc);
2421 * List of handlers for the messages understood by this
2424 static struct GNUNET_SERVER_MessageHandler handlers[] = {
2425 {&handle_start, NULL,
2426 GNUNET_MESSAGE_TYPE_TRANSPORT_START, 0},
2427 {&handle_hello, NULL,
2428 GNUNET_MESSAGE_TYPE_HELLO, 0},
2429 {&handle_send, NULL,
2430 GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, 0},
2431 {&handle_set_quota, NULL,
2432 GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA, sizeof (struct QuotaSetMessage)},
2433 {&handle_try_connect, NULL,
2434 GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT,
2435 sizeof (struct TryConnectMessage)},
2436 {&handle_address_lookup, NULL,
2437 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP,
2444 * Setup the environment for this plugin.
2447 create_environment (struct TransportPlugin *plug)
2449 plug->env.cfg = cfg;
2450 plug->env.sched = sched;
2451 plug->env.my_public_key = &my_public_key;
2452 plug->env.my_private_key = my_private_key;
2453 plug->env.my_identity = &my_identity;
2454 plug->env.cls = plug;
2455 plug->env.receive = &plugin_env_receive;
2456 plug->env.notify_address = &plugin_env_notify_address;
2457 plug->env.notify_validation = &plugin_env_notify_validation;
2458 plug->env.default_quota_in = (GNUNET_CONSTANTS_DEFAULT_BPM_IN_OUT + 59999) / (60 * 1000);
2459 plug->env.max_connections = max_connect_per_transport;
2464 * Start the specified transport (load the plugin).
2467 start_transport (struct GNUNET_SERVER_Handle *server, const char *name)
2469 struct TransportPlugin *plug;
2472 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2473 _("Loading `%s' transport plugin\n"), name);
2474 GNUNET_asprintf (&libname, "libgnunet_plugin_transport_%s", name);
2475 plug = GNUNET_malloc (sizeof (struct TransportPlugin));
2476 create_environment (plug);
2477 plug->short_name = GNUNET_strdup (name);
2478 plug->lib_name = libname;
2479 plug->next = plugins;
2481 plug->api = GNUNET_PLUGIN_load (libname, &plug->env);
2482 if (plug->api == NULL)
2484 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2485 _("Failed to load transport plugin for `%s'\n"), name);
2486 GNUNET_free (plug->short_name);
2487 plugins = plug->next;
2488 GNUNET_free (libname);
2495 * Called whenever a client is disconnected. Frees our
2496 * resources associated with that client.
2498 * @param cls closure
2499 * @param client identification of the client
2502 client_disconnect_notification (void *cls,
2503 struct GNUNET_SERVER_Client *client)
2505 struct TransportClient *pos;
2506 struct TransportClient *prev;
2507 struct ClientMessageQueueEntry *mqe;
2510 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
2511 "Client disconnected, cleaning up.\n");
2515 while ((pos != NULL) && (pos->client != client))
2522 while (NULL != (mqe = pos->message_queue_head))
2524 pos->message_queue_head = mqe->next;
2527 pos->message_queue_head = NULL;
2529 clients = pos->next;
2531 prev->next = pos->next;
2532 if (GNUNET_YES == pos->tcs_pending)
2542 * Function called when the service shuts down. Unloads our plugins.
2544 * @param cls closure, unused
2545 * @param tc task context (unused)
2548 unload_plugins (void *cls,
2549 const struct GNUNET_SCHEDULER_TaskContext *tc)
2551 struct TransportPlugin *plug;
2552 struct AddressList *al;
2555 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
2556 "Transport service is unloading plugins...\n");
2558 while (NULL != (plug = plugins))
2560 plugins = plug->next;
2561 GNUNET_break (NULL == GNUNET_PLUGIN_unload (plug->lib_name, plug->api));
2562 GNUNET_free (plug->lib_name);
2563 GNUNET_free (plug->short_name);
2564 while (NULL != (al = plug->addresses))
2566 plug->addresses = al->next;
2571 if (my_private_key != NULL)
2572 GNUNET_CRYPTO_rsa_key_free (my_private_key);
2573 GNUNET_free_non_null (our_hello);
2578 * Initiate transport service.
2580 * @param cls closure
2581 * @param s scheduler to use
2582 * @param serv the initialized server
2583 * @param c configuration to use
2587 struct GNUNET_SCHEDULER_Handle *s,
2588 struct GNUNET_SERVER_Handle *serv,
2589 const struct GNUNET_CONFIGURATION_Handle *c)
2594 unsigned long long tneigh;
2599 /* parse configuration */
2601 GNUNET_CONFIGURATION_get_value_number (c,
2606 GNUNET_CONFIGURATION_get_value_filename (c,
2608 "HOSTKEY", &keyfile)))
2610 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2612 ("Transport service is lacking key configuration settings. Exiting.\n"));
2613 GNUNET_SCHEDULER_shutdown (s);
2616 max_connect_per_transport = (uint32_t) tneigh;
2617 my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
2618 GNUNET_free (keyfile);
2619 if (my_private_key == NULL)
2621 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
2623 ("Transport service could not access hostkey. Exiting.\n"));
2624 GNUNET_SCHEDULER_shutdown (s);
2627 GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
2628 GNUNET_CRYPTO_hash (&my_public_key,
2629 sizeof (my_public_key), &my_identity.hashPubKey);
2630 /* setup notification */
2632 GNUNET_SERVER_disconnect_notify (server,
2633 &client_disconnect_notification, NULL);
2634 /* load plugins... */
2637 GNUNET_CONFIGURATION_get_value_string (c,
2638 "TRANSPORT", "PLUGINS", &plugs))
2640 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2641 _("Starting transport plugins `%s'\n"), plugs);
2642 pos = strtok (plugs, " ");
2645 start_transport (server, pos);
2647 pos = strtok (NULL, " ");
2649 GNUNET_free (plugs);
2651 GNUNET_SCHEDULER_add_delayed (sched,
2652 GNUNET_TIME_UNIT_FOREVER_REL,
2653 &unload_plugins, NULL);
2657 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
2658 _("Transport service ready.\n"));
2660 /* process client requests */
2661 GNUNET_SERVER_add_handlers (server, handlers);
2666 * The main function for the transport service.
2668 * @param argc number of arguments from the command line
2669 * @param argv command line arguments
2670 * @return 0 ok, 1 on error
2673 main (int argc, char *const *argv)
2675 return (GNUNET_OK ==
2676 GNUNET_SERVICE_run (argc,
2679 GNUNET_SERVICE_OPTION_NONE,
2680 &run, NULL)) ? 0 : 1;
2683 /* end of gnunet-service-transport.c */