2 This file is part of GNUnet.
3 (C) 2010,2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file transport/gnunet-service-transport_clients.c
23 * @brief plugin management API
24 * @author Christian Grothoff
27 #include "gnunet-service-transport_clients.h"
28 #include "gnunet-service-transport_hello.h"
29 #include "gnunet-service-transport_neighbours.h"
30 #include "gnunet-service-transport_plugins.h"
31 #include "gnunet-service-transport_validation.h"
32 #include "gnunet-service-transport.h"
33 #include "transport.h"
36 * How many messages can we have pending for a given client process
37 * before we start to drop incoming messages? We typically should
38 * have only one client and so this would be the primary buffer for
39 * messages, so the number should be chosen rather generously.
41 * The expectation here is that most of the time the queue is large
42 * enough so that a drop is virtually never required. Note that
43 * this value must be about as large as 'TOTAL_MSGS' in the
44 * 'test_transport_api_reliability.c', otherwise that testcase may
47 #define MAX_PENDING (128 * 1024)
51 * Linked list of messages to be transmitted to the client. Each
52 * entry is followed by the actual message.
54 struct ClientMessageQueueEntry
57 * This is a doubly-linked list.
59 struct ClientMessageQueueEntry *next;
62 * This is a doubly-linked list.
64 struct ClientMessageQueueEntry *prev;
69 * Client connected to the transport service.
71 struct TransportClient
75 * This is a doubly-linked list.
77 struct TransportClient *next;
80 * This is a doubly-linked list.
82 struct TransportClient *prev;
85 * Handle to the client.
87 struct GNUNET_SERVER_Client *client;
90 * Linked list of messages yet to be transmitted to
93 struct ClientMessageQueueEntry *message_queue_head;
96 * Tail of linked list of messages yet to be transmitted to the
99 struct ClientMessageQueueEntry *message_queue_tail;
102 * Current transmit request handle.
104 struct GNUNET_CONNECTION_TransmitHandle *th;
107 * Length of the list of messages pending for this client.
109 unsigned int message_count;
115 * Head of linked list of all clients to this service.
117 static struct TransportClient *clients_head;
120 * Tail of linked list of all clients to this service.
122 static struct TransportClient *clients_tail;
126 * Find the internal handle associated with the given client handle
128 * @param client server's client handle to look up
129 * @return internal client handle
131 static struct TransportClient *
132 lookup_client (struct GNUNET_SERVER_Client *client)
134 struct TransportClient *tc;
139 if (tc->client == client)
148 * Create the internal handle for the given server client handle
150 * @param client server's client handle to create our internal handle for
151 * @return fresh internal client handle
153 static struct TransportClient *
154 setup_client (struct GNUNET_SERVER_Client *client)
156 struct TransportClient *tc;
158 tc = GNUNET_malloc (sizeof (struct TransportClient));
160 GNUNET_CONTAINER_DLL_insert (clients_head,
168 * Function called to notify a client about the socket being ready to
169 * queue more data. "buf" will be NULL and "size" zero if the socket
170 * was closed for writing in the meantime.
173 * @param size number of bytes available in buf
174 * @param buf where the callee should write the message
175 * @return number of bytes written to buf
178 transmit_to_client_callback (void *cls,
182 struct TransportClient *tc = cls;
183 struct ClientMessageQueueEntry *q;
184 const struct GNUNET_MessageHeader *msg;
193 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
194 "Transmission to client failed, closing connection.\n");
200 while (NULL != (q = tc->message_queue_head))
202 msg = (const struct GNUNET_MessageHeader *) &q[1];
203 msize = ntohs (msg->size);
204 if (msize + tsize > size)
207 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
208 "Transmitting message of type %u to client.\n",
211 GNUNET_CONTAINER_DLL_remove (tc->message_queue_head,
212 tc->message_queue_tail,
215 memcpy (&cbuf[tsize],
223 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
224 tc->th = GNUNET_SERVER_notify_transmit_ready (tc->client,
226 GNUNET_TIME_UNIT_FOREVER_REL,
227 &transmit_to_client_callback,
229 GNUNET_assert (tc->th != NULL);
236 * Queue the given message for transmission to the given client
238 * @param client target of the message
239 * @param msg message to transmit
240 * @param may_drop GNUNET_YES if the message can be dropped
243 unicast (struct TransportClient *tc,
244 const struct GNUNET_MessageHeader *msg,
247 struct ClientMessageQueueEntry *q;
250 if ( (tc->message_count >= MAX_PENDING) &&
251 (GNUNET_YES == may_drop) )
253 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
254 _("Dropping message of type %u and size %u, have %u/%u messages pending\n"),
259 GNUNET_STATISTICS_update (GST_stats,
260 gettext_noop ("# messages dropped due to slow client"),
265 msize = ntohs (msg->size);
266 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
267 q = GNUNET_malloc (sizeof (struct ClientMessageQueueEntry) + msize);
268 memcpy (&q[1], msg, msize);
269 GNUNET_CONTAINER_DLL_insert_tail (tc->message_queue_head,
270 tc->message_queue_tail,
275 tc->th = GNUNET_SERVER_notify_transmit_ready (tc->client,
277 GNUNET_TIME_UNIT_FOREVER_REL,
278 &transmit_to_client_callback,
280 GNUNET_assert (tc->th != NULL);
285 * Called whenever a client is disconnected. Frees our
286 * resources associated with that client.
289 * @param client identification of the client
292 client_disconnect_notification (void *cls,
293 struct GNUNET_SERVER_Client *client)
295 struct TransportClient *tc;
296 struct ClientMessageQueueEntry *mqe;
300 tc = lookup_client (client);
304 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
305 "Client disconnected, cleaning up.\n");
307 while (NULL != (mqe = tc->message_queue_head))
309 GNUNET_CONTAINER_DLL_remove (tc->message_queue_head,
310 tc->message_queue_tail,
315 GNUNET_CONTAINER_DLL_remove (clients_head,
320 GNUNET_CONNECTION_notify_transmit_ready_cancel (tc->th);
323 GNUNET_break (0 == tc->message_count);
329 * Start handling requests from clients.
331 * @param server server used to accept clients from.
334 GST_clients_start (struct GNUNET_SERVER_Handle *server)
336 GNUNET_SERVER_disconnect_notify (server,
337 &client_disconnect_notification, NULL);
342 * Stop processing clients.
352 * Function called for each of our connected neighbours. Notify the
353 * client about the existing neighbour.
355 * @param cls the 'struct TransportClient' to notify
356 * @param peer identity of the neighbour
357 * @param ats performance data
358 * @param ats_count number of entries in ats (excluding 0-termination)
361 notify_client_about_neighbour (void *cls,
362 const struct GNUNET_PeerIdentity *peer,
363 const struct GNUNET_TRANSPORT_ATS_Information *ats,
366 struct TransportClient *tc = cls;
367 struct ConnectInfoMessage *cim;
370 size = sizeof (struct ConnectInfoMessage) + ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information);
371 GNUNET_assert (size < GNUNET_SERVER_MAX_MESSAGE_SIZE);
372 cim = GNUNET_malloc (size);
373 cim->header.size = htons (size);
374 cim->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
375 cim->ats_count = htonl(ats_count);
379 ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
380 unicast (tc, &cim->header, GNUNET_NO);
386 * Initialize a normal client. We got a start message from this
387 * client, add him to the list of clients for broadcasting of inbound
391 * @param client the client
392 * @param message the start message that was sent
395 GST_clients_handle_start (void *cls,
396 struct GNUNET_SERVER_Client *client,
397 const struct GNUNET_MessageHeader *message)
399 const struct StartMessage *start;
400 struct TransportClient *tc;
402 tc = lookup_client (client);
405 /* got 'start' twice from the same client, not allowed */
407 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
410 start = (const struct StartMessage*) message;
411 if ( (GNUNET_NO != ntohl (start->do_check)) &&
412 (0 != memcmp (&start->self,
414 sizeof (struct GNUNET_PeerIdentity))) )
416 /* client thinks this is a different peer, reject */
417 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
418 _("Rejecting control connection from peer `%s', which is not me!\n"),
419 GNUNET_i2s (&start->self));
420 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
423 tc = setup_client (client);
424 unicast (tc, GST_hello_get(), GNUNET_NO);
425 GST_neighbours_iterate (¬ify_client_about_neighbour, tc);
426 GNUNET_SERVER_receive_done (client, GNUNET_OK);
431 * Client sent us a HELLO. Process the request.
434 * @param client the client
435 * @param message the HELLO message
438 GST_clients_handle_hello (void *cls,
439 struct GNUNET_SERVER_Client *client,
440 const struct GNUNET_MessageHeader *message)
442 GST_validation_handle_hello (message);
443 GNUNET_SERVER_receive_done (client, GNUNET_OK);
448 * Closure for 'handle_send_transmit_continuation'
450 struct SendTransmitContinuationContext
453 * Client that made the request.
455 struct GNUNET_SERVER_Client *client;
458 * Peer that was the target.
460 struct GNUNET_PeerIdentity target;
465 * Function called after the transmission is done. Notify the client that it is
466 * OK to send the next message.
469 * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected
472 handle_send_transmit_continuation (void *cls,
475 struct SendTransmitContinuationContext *stcc = cls;
476 struct SendOkMessage send_ok_msg;
478 send_ok_msg.header.size = htons (sizeof (send_ok_msg));
479 send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
480 send_ok_msg.success = htonl (success);
481 send_ok_msg.latency = GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_FOREVER_REL);
482 send_ok_msg.peer = stcc->target;
483 GST_clients_unicast (stcc->client, &send_ok_msg.header, GNUNET_NO);
484 GNUNET_SERVER_client_drop (stcc->client);
490 * Client asked for transmission to a peer. Process the request.
493 * @param client the client
494 * @param message the send message that was sent
497 GST_clients_handle_send (void *cls,
498 struct GNUNET_SERVER_Client *client,
499 const struct GNUNET_MessageHeader *message)
501 const struct OutboundMessage *obm;
502 const struct GNUNET_MessageHeader *obmm;
503 struct SendTransmitContinuationContext *stcc;
507 size = ntohs (message->size);
508 if (size < sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
511 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
514 obm = (const struct OutboundMessage *) message;
515 obmm = (const struct GNUNET_MessageHeader *) &obm[1];
516 msize = size - sizeof (struct OutboundMessage);
517 if (msize < sizeof (struct GNUNET_MessageHeader))
520 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
523 GNUNET_STATISTICS_update (GST_stats,
524 gettext_noop ("# bytes payload received for other peers"),
528 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
529 "Received `%s' request from client with target `%4s' and first message of type %u and total size %u\n",
531 GNUNET_i2s (&obm->peer),
536 GST_neighbours_test_connected (&obm->peer))
538 /* not connected, not allowed to send; can happen due to asynchronous operations */
539 GNUNET_STATISTICS_update (GST_stats,
540 gettext_noop ("# bytes payload dropped (other peer was not connected)"),
543 GNUNET_SERVER_receive_done (client, GNUNET_OK);
546 GNUNET_SERVER_receive_done (client, GNUNET_OK);
547 stcc = GNUNET_malloc (sizeof (struct SendTransmitContinuationContext));
548 stcc->target = obm->peer;
549 stcc->client = client;
550 GNUNET_SERVER_client_keep (client);
551 GST_neighbours_send (&obm->peer,
553 GNUNET_TIME_relative_ntoh (obm->timeout),
554 &handle_send_transmit_continuation,
560 * Client asked for a quota change for a particular peer. Process the request.
563 * @param client the client
564 * @param message the quota changing message
567 GST_clients_handle_set_quota (void *cls,
568 struct GNUNET_SERVER_Client *client,
569 const struct GNUNET_MessageHeader *message)
571 const struct QuotaSetMessage *qsm;
573 qsm = (const struct QuotaSetMessage *) message;
574 GNUNET_STATISTICS_update (GST_stats,
575 gettext_noop ("# SET QUOTA messages received"),
579 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
580 "Received `%s' request (new quota %u) from client for peer `%4s'\n",
582 (unsigned int) ntohl (qsm->quota.value__),
583 GNUNET_i2s (&qsm->peer));
585 GST_neighbours_set_incoming_quota (&qsm->peer,
587 GNUNET_SERVER_receive_done (client, GNUNET_OK);
592 * Take the given address and append it to the set of results sent back to
595 * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
596 * @param address the resolved name, NULL to indicate the last response
599 transmit_address_to_client (void *cls,
602 struct GNUNET_SERVER_TransmitContext *tc = cls;
606 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
607 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
608 GNUNET_SERVER_transmit_context_run (tc,
609 GNUNET_TIME_UNIT_FOREVER_REL);
612 GNUNET_SERVER_transmit_context_append_data (tc,
613 address, strlen (address) + 1,
614 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
619 * Client asked to resolve an address. Process the request.
622 * @param client the client
623 * @param message the resolution request
626 GST_clients_handle_address_lookup (void *cls,
627 struct GNUNET_SERVER_Client *client,
628 const struct GNUNET_MessageHeader *message)
630 const struct AddressLookupMessage *alum;
631 struct GNUNET_TRANSPORT_PluginFunctions *papi;
632 const char *plugin_name;
634 uint32_t address_len;
636 struct GNUNET_SERVER_TransmitContext *tc;
637 struct GNUNET_TIME_Relative rtimeout;
640 size = ntohs (message->size);
641 if (size < sizeof (struct AddressLookupMessage))
644 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
647 alum = (const struct AddressLookupMessage *) message;
648 address_len = ntohl (alum->addrlen);
649 if (size <= sizeof (struct AddressLookupMessage) + address_len)
652 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
655 address = (const char *) &alum[1];
656 plugin_name = (const char *) &address[address_len];
658 [size - sizeof (struct AddressLookupMessage) - address_len - 1] != '\0')
661 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
664 rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
665 numeric = ntohl (alum->numeric_only);
666 tc = GNUNET_SERVER_transmit_context_create (client);
667 papi = GST_plugins_find (plugin_name);
670 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
671 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
672 GNUNET_SERVER_transmit_context_run (tc, rtimeout);
675 GNUNET_SERVER_disable_receive_done_warning (client);
676 papi->address_pretty_printer (papi->cls,
678 address, address_len,
681 &transmit_address_to_client, tc);
686 * Send an address to the client.
688 * @param cls our 'struct GNUNET_SERVER_TransmitContext' (for sending)
689 * @param public_key public key for the peer, never NULL
690 * @param target peer this change is about, never NULL
691 * @param valid_until until what time do we consider the address valid?
692 * @param validation_block is FOREVER if the address is for an unsupported plugin (from PEERINFO)
693 * is ZERO if the address is considered valid (no validation needed)
694 * is a time in the future if we're currently denying re-validation
695 * @param plugin_name name of the plugin
696 * @param plugin_address binary address
697 * @param plugin_address_len length of address
700 send_address_to_client (void *cls,
701 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *public_key,
702 const struct GNUNET_PeerIdentity *target,
703 struct GNUNET_TIME_Absolute valid_until,
704 struct GNUNET_TIME_Absolute validation_block,
705 const char *plugin_name,
706 const void *plugin_address,
707 size_t plugin_address_len)
709 struct GNUNET_SERVER_TransmitContext *tc = cls;
712 /* FIXME: move to a binary format!!! */
713 GNUNET_asprintf (&addr_buf, "%s --- %s, %s",
714 GST_plugins_a2s (plugin_name,
717 (GNUNET_YES == GST_neighbours_test_connected (target))
720 (GNUNET_TIME_absolute_get_remaining (valid_until).rel_value > 0)
723 transmit_address_to_client (tc, addr_buf);
724 GNUNET_free (addr_buf);
729 * Client asked to obtain information about a peer's addresses.
730 * Process the request.
731 * FIXME: use better name!
734 * @param client the client
735 * @param message the peer address information request
738 GST_clients_handle_peer_address_lookup (void *cls,
739 struct GNUNET_SERVER_Client *client,
740 const struct GNUNET_MessageHeader *message)
742 const struct PeerAddressLookupMessage *peer_address_lookup;
743 struct GNUNET_SERVER_TransmitContext *tc;
745 peer_address_lookup = (const struct PeerAddressLookupMessage *) message;
746 GNUNET_break (ntohl (peer_address_lookup->reserved) == 0);
747 tc = GNUNET_SERVER_transmit_context_create (client);
748 (void) GST_validation_get_addresses (&peer_address_lookup->peer,
750 &send_address_to_client,
752 GNUNET_SERVER_transmit_context_append_data (tc,
754 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
755 GNUNET_SERVER_transmit_context_run (tc,
756 GNUNET_TIME_UNIT_FOREVER_REL);
761 * Output the active address of connected neighbours to the given client.
763 * @param cls the 'struct GNUNET_SERVER_TransmitContext' for transmission to the client
764 * @param neighbour identity of the neighbour
765 * @param ats performance data
766 * @param ats_count number of entries in ats (excluding 0-termination)
769 output_addresses (void *cls,
770 const struct GNUNET_PeerIdentity *neighbour,
771 const struct GNUNET_TRANSPORT_ATS_Information *ats,
774 struct GNUNET_SERVER_TransmitContext *tc = cls;
777 /* FIXME: move to a binary format!!! */
778 GNUNET_asprintf (&addr_buf,
780 GNUNET_i2s(neighbour),
781 GST_plugins_a2s ("FIXME", NULL, 0));
782 transmit_address_to_client (tc, addr_buf);
783 GNUNET_free (addr_buf);
788 * Client asked to obtain information about all actively used addresses.
789 * Process the request. FIXME: use better name!
792 * @param client the client
793 * @param message the peer address information request
796 GST_clients_handle_address_iterate (void *cls,
797 struct GNUNET_SERVER_Client *client,
798 const struct GNUNET_MessageHeader *message)
800 struct GNUNET_SERVER_TransmitContext *tc;
802 GNUNET_SERVER_disable_receive_done_warning (client);
803 tc = GNUNET_SERVER_transmit_context_create (client);
804 GST_neighbours_iterate (&output_addresses,
806 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
807 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY);
808 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
813 * Broadcast the given message to all of our clients.
815 * @param msg message to broadcast
816 * @param may_drop GNUNET_YES if the message can be dropped
819 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
822 struct TransportClient *tc;
824 for (tc = clients_head; tc != NULL; tc = tc->next)
825 unicast (tc, msg, may_drop);
830 * Send the given message to a particular client
832 * @param client target of the message
833 * @param msg message to transmit
834 * @param may_drop GNUNET_YES if the message can be dropped
837 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
838 const struct GNUNET_MessageHeader *msg,
841 struct TransportClient *tc;
843 tc = lookup_client (client);
845 tc = setup_client (client);
846 unicast (tc, msg, may_drop);
850 /* end of file gnunet-service-transport_clients.c */