2 This file is part of GNUnet.
3 Copyright (C) 2010-2015 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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file transport/gnunet-service-transport_clients.c
23 * @brief communication with clients (core service and monitors)
24 * @author Christian Grothoff
27 #include "gnunet-service-transport_blacklist.h"
28 #include "gnunet-service-transport_clients.h"
29 #include "gnunet-service-transport_hello.h"
30 #include "gnunet-service-transport_neighbours.h"
31 #include "gnunet-service-transport_plugins.h"
32 #include "gnunet-service-transport_validation.h"
33 #include "gnunet-service-transport_manipulation.h"
34 #include "gnunet-service-transport.h"
35 #include "transport.h"
39 * How many messages can we have pending for a given client process
40 * before we start to drop incoming messages? We typically should
41 * have only one client and so this would be the primary buffer for
42 * messages, so the number should be chosen rather generously.
44 * The expectation here is that most of the time the queue is large
45 * enough so that a drop is virtually never required. Note that
46 * this value must be about as large as 'TOTAL_MSGS' in the
47 * 'test_transport_api_reliability.c', otherwise that testcase may
50 #define MAX_PENDING (128 * 1024)
54 * Linked list of messages to be transmitted to the client. Each
55 * entry is followed by the actual message.
57 struct ClientMessageQueueEntry
60 * This is a doubly-linked list.
62 struct ClientMessageQueueEntry *next;
65 * This is a doubly-linked list.
67 struct ClientMessageQueueEntry *prev;
72 * Client connected to the transport service.
74 struct TransportClient
78 * This is a doubly-linked list.
80 struct TransportClient *next;
83 * This is a doubly-linked list.
85 struct TransportClient *prev;
88 * Handle to the client.
90 struct GNUNET_SERVER_Client *client;
93 * Linked list of messages yet to be transmitted to
96 struct ClientMessageQueueEntry *message_queue_head;
99 * Tail of linked list of messages yet to be transmitted to the
102 struct ClientMessageQueueEntry *message_queue_tail;
105 * Current transmit request handle.
107 struct GNUNET_SERVER_TransmitHandle *th;
110 * Length of the list of messages pending for this client.
112 unsigned int message_count;
115 * Is this client interested in payload messages?
122 * Context for address to string operations
124 struct AddressToStringContext
127 * This is a doubly-linked list.
129 struct AddressToStringContext *next;
132 * This is a doubly-linked list.
134 struct AddressToStringContext *prev;
137 * Transmission context
139 struct GNUNET_SERVER_TransmitContext* tc;
144 * Client monitoring changes of active addresses or validations
145 * of our neighbours. Which type is being monitored depends on the
146 * DLL this struct is in.
148 struct MonitoringClient
151 * This is a doubly-linked list.
153 struct MonitoringClient *next;
156 * This is a doubly-linked list.
158 struct MonitoringClient *prev;
161 * Handle to the client.
163 struct GNUNET_SERVER_Client *client;
166 * Peer identity to monitor the addresses of.
167 * Zero to monitor all neighrours.
169 struct GNUNET_PeerIdentity peer;
175 * Head of linked list of all clients to this service.
177 static struct TransportClient *clients_head;
180 * Tail of linked list of all clients to this service.
182 static struct TransportClient *clients_tail;
185 * Head of linked list of all pending address iterations
187 static struct AddressToStringContext *a2s_head;
190 * Tail of linked list of all pending address iterations
192 static struct AddressToStringContext *a2s_tail;
195 * Head of linked list of monitoring clients.
197 static struct MonitoringClient *peer_monitoring_clients_head;
200 * Tail of linked list of monitoring clients.
202 static struct MonitoringClient *peer_monitoring_clients_tail;
205 * Head of linked list of validation monitoring clients.
207 static struct MonitoringClient *val_monitoring_clients_head;
210 * Tail of linked list of validation monitoring clients.
212 static struct MonitoringClient *val_monitoring_clients_tail;
215 * Notification context, to send updates on changes to active addresses
218 static struct GNUNET_SERVER_NotificationContext *peer_nc;
221 * Notification context, to send updates on changes to active addresses
224 static struct GNUNET_SERVER_NotificationContext *val_nc;
227 * Notification context, to send updates on changes to active plugin
230 static struct GNUNET_SERVER_NotificationContext *plugin_nc;
233 * Plugin monitoring client we are currently syncing, NULL if all
234 * monitoring clients are in sync.
236 static struct GNUNET_SERVER_Client *sync_client;
239 * Peer identity that is all zeros, used as a way to indicate
240 * "all peers". Used for comparissons.
242 static struct GNUNET_PeerIdentity all_zeros;
246 * Find the internal handle associated with the given client handle.
248 * @param client server's client handle to look up
249 * @return internal client handle
251 static struct TransportClient *
252 lookup_client (struct GNUNET_SERVER_Client *client)
254 return GNUNET_SERVER_client_get_user_context (client,
255 struct TransportClient);
260 * Create the internal handle for the given server client handle.
262 * @param client server's client handle to create our internal handle for
263 * @return fresh internal client handle
265 static struct TransportClient *
266 setup_client (struct GNUNET_SERVER_Client *client)
268 struct TransportClient *tc;
270 GNUNET_assert (NULL == lookup_client (client));
271 tc = GNUNET_new (struct TransportClient);
273 GNUNET_SERVER_client_set_user_context (client, tc);
274 GNUNET_CONTAINER_DLL_insert (clients_head,
277 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
278 "Client %p connected\n",
285 * Find the handle to the monitoring client associated with the given
288 * @param head the head of the client queue to look in
289 * @param client server's client handle to look up
290 * @return handle to the monitoring client
292 static struct MonitoringClient *
293 lookup_monitoring_client (struct MonitoringClient *head,
294 struct GNUNET_SERVER_Client *client)
296 struct MonitoringClient *mc;
298 for (mc = head; NULL != mc; mc = mc->next)
299 if (mc->client == client)
306 * Setup a new monitoring client using the given server client handle and
309 * @param client server's client handle to create our internal handle for
310 * @param peer identity of the peer to monitor the addresses of,
311 * zero to monitor all neighrours.
312 * @return handle to the new monitoring client
314 static struct MonitoringClient *
315 setup_peer_monitoring_client (struct GNUNET_SERVER_Client *client,
316 const struct GNUNET_PeerIdentity *peer)
318 struct MonitoringClient *mc;
320 GNUNET_assert (NULL ==
321 lookup_monitoring_client (peer_monitoring_clients_head,
323 mc = GNUNET_new (struct MonitoringClient);
326 GNUNET_CONTAINER_DLL_insert (peer_monitoring_clients_head,
327 peer_monitoring_clients_tail,
329 GNUNET_SERVER_client_mark_monitor (client);
330 GNUNET_SERVER_notification_context_add (peer_nc,
332 if (0 != memcmp (peer,
334 sizeof (struct GNUNET_PeerIdentity)))
335 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
336 "Client %p started monitoring of the peer `%s'\n",
340 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
341 "Client %p started monitoring all peers\n",
348 * Setup a new monitoring client using the given server client handle and
351 * @param client server's client handle to create our internal handle for
352 * @param peer identity of the peer to monitor the addresses of,
353 * zero to monitor all neighrours.
354 * @return handle to the new monitoring client
356 static struct MonitoringClient *
357 setup_val_monitoring_client (struct GNUNET_SERVER_Client *client,
358 struct GNUNET_PeerIdentity *peer)
360 struct MonitoringClient *mc;
362 GNUNET_assert (NULL ==
363 lookup_monitoring_client (val_monitoring_clients_head,
365 mc = GNUNET_new (struct MonitoringClient);
368 GNUNET_CONTAINER_DLL_insert (val_monitoring_clients_head,
369 val_monitoring_clients_tail,
371 GNUNET_SERVER_notification_context_add (val_nc, client);
373 if (0 != memcmp (peer,
375 sizeof (struct GNUNET_PeerIdentity)))
376 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
377 "Client %p started monitoring of the peer `%s'\n",
381 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
382 "Client %p started monitoring all peers\n",
389 * Function called to notify a client about the socket being ready to
390 * queue more data. @a buf will be NULL and @a size zero if the socket
391 * was closed for writing in the meantime.
394 * @param size number of bytes available in @a buf
395 * @param buf where the callee should write the message
396 * @return number of bytes written to @a buf
399 transmit_to_client_callback (void *cls,
403 struct TransportClient *tc = cls;
404 struct ClientMessageQueueEntry *q;
405 const struct GNUNET_MessageHeader *msg;
413 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
414 "Transmission to client failed, closing connection.\n");
419 while (NULL != (q = tc->message_queue_head))
421 msg = (const struct GNUNET_MessageHeader *) &q[1];
422 msize = ntohs (msg->size);
423 if (msize + tsize > size)
425 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
426 "Transmitting message of type %u to client %p.\n",
429 GNUNET_CONTAINER_DLL_remove (tc->message_queue_head,
430 tc->message_queue_tail,
433 memcpy (&cbuf[tsize], msg, msize);
439 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
441 GNUNET_SERVER_notify_transmit_ready (tc->client, msize,
442 GNUNET_TIME_UNIT_FOREVER_REL,
443 &transmit_to_client_callback, tc);
444 GNUNET_assert (NULL != tc->th);
451 * Queue the given message for transmission to the given client
453 * @param tc target of the message
454 * @param msg message to transmit
455 * @param may_drop #GNUNET_YES if the message can be dropped
458 unicast (struct TransportClient *tc,
459 const struct GNUNET_MessageHeader *msg,
462 struct ClientMessageQueueEntry *q;
470 if ( (tc->message_count >= MAX_PENDING) &&
471 (GNUNET_YES == may_drop) )
473 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
474 "Dropping message of type %u and size %u, have %u/%u messages pending\n",
479 GNUNET_STATISTICS_update (GST_stats,
481 ("# messages dropped due to slow client"), 1,
485 msize = ntohs (msg->size);
486 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
487 q = GNUNET_malloc (sizeof (struct ClientMessageQueueEntry) + msize);
488 memcpy (&q[1], msg, msize);
489 GNUNET_CONTAINER_DLL_insert_tail (tc->message_queue_head,
490 tc->message_queue_tail,
496 GNUNET_SERVER_notify_transmit_ready (tc->client, msize,
497 GNUNET_TIME_UNIT_FOREVER_REL,
498 &transmit_to_client_callback, tc);
499 GNUNET_assert (NULL != tc->th);
504 * Called whenever a client is disconnected. Frees our
505 * resources associated with that client.
507 * @param cls closure, NULL
508 * @param client identification of the client
511 client_disconnect_notification (void *cls,
512 struct GNUNET_SERVER_Client *client)
514 struct TransportClient *tc;
515 struct MonitoringClient *mc;
516 struct ClientMessageQueueEntry *mqe;
520 mc = lookup_monitoring_client (peer_monitoring_clients_head,
524 GNUNET_CONTAINER_DLL_remove (peer_monitoring_clients_head,
525 peer_monitoring_clients_tail,
529 mc = lookup_monitoring_client (val_monitoring_clients_head,
533 GNUNET_CONTAINER_DLL_remove (val_monitoring_clients_head,
534 val_monitoring_clients_tail,
538 tc = lookup_client (client);
541 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
542 "Client %p disconnected, cleaning up.\n",
544 while (NULL != (mqe = tc->message_queue_head))
546 GNUNET_CONTAINER_DLL_remove (tc->message_queue_head,
547 tc->message_queue_tail,
552 GNUNET_CONTAINER_DLL_remove (clients_head,
555 GNUNET_SERVER_client_set_user_context (client, NULL);
558 GNUNET_SERVER_notify_transmit_ready_cancel (tc->th);
561 GNUNET_break (0 == tc->message_count);
567 * Function called for each of our connected neighbours. Notify the
568 * client about the existing neighbour.
570 * @param cls the `struct TransportClient *` to notify
571 * @param peer identity of the neighbour
572 * @param address the address
573 * @param state the current state of the peer
574 * @param state_timeout the time out for the state
575 * @param bandwidth_in inbound bandwidth in NBO
576 * @param bandwidth_out outbound bandwidth in NBO
579 notify_client_about_neighbour (void *cls,
580 const struct GNUNET_PeerIdentity *peer,
581 const struct GNUNET_HELLO_Address *address,
582 enum GNUNET_TRANSPORT_PeerState state,
583 struct GNUNET_TIME_Absolute state_timeout,
584 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
585 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
587 struct TransportClient *tc = cls;
588 struct ConnectInfoMessage cim;
590 if (GNUNET_NO == GST_neighbours_test_connected (peer))
592 cim.header.size = htons (sizeof (struct ConnectInfoMessage));
593 cim.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
595 cim.quota_in = bandwidth_in;
596 cim.quota_out = bandwidth_out;
597 unicast (tc, &cim.header, GNUNET_NO);
602 * Initialize a normal client. We got a start message from this
603 * client, add him to the list of clients for broadcasting of inbound
607 * @param client the client
608 * @param message the start message that was sent
611 clients_handle_start (void *cls,
612 struct GNUNET_SERVER_Client *client,
613 const struct GNUNET_MessageHeader *message)
615 const struct StartMessage *start;
616 const struct GNUNET_MessageHeader *hello;
617 struct TransportClient *tc;
620 tc = lookup_client (client);
623 /* got 'start' twice from the same client, not allowed */
625 GNUNET_SERVER_receive_done (client,
629 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
630 "Client %p sent START\n",
632 start = (const struct StartMessage *) message;
633 options = ntohl (start->options);
634 if ((0 != (1 & options)) &&
636 memcmp (&start->self,
638 sizeof (struct GNUNET_PeerIdentity))))
640 /* client thinks this is a different peer, reject */
642 GNUNET_SERVER_receive_done (client,
646 tc = setup_client (client);
647 tc->send_payload = (0 != (2 & options));
648 hello = GST_hello_get ();
653 GST_neighbours_iterate (¬ify_client_about_neighbour,
655 GNUNET_SERVER_receive_done (client,
661 * Client sent us a HELLO. Process the request.
664 * @param client the client
665 * @param message the HELLO message
668 clients_handle_hello (void *cls,
669 struct GNUNET_SERVER_Client *client,
670 const struct GNUNET_MessageHeader *message)
672 GST_validation_handle_hello (message);
673 GNUNET_SERVER_receive_done (client, GNUNET_OK);
678 * Closure for #handle_send_transmit_continuation()
680 struct SendTransmitContinuationContext
683 * Client that made the request.
685 struct GNUNET_SERVER_Client *client;
688 * Peer that was the target.
690 struct GNUNET_PeerIdentity target;
695 * Function called after the transmission is done. Notify the client that it is
696 * OK to send the next message.
699 * @param success #GNUNET_OK on success, #GNUNET_NO on failure, #GNUNET_SYSERR if we're not connected
700 * @param bytes_payload bytes payload sent
701 * @param bytes_on_wire bytes sent on wire
704 handle_send_transmit_continuation (void *cls,
706 size_t bytes_payload,
707 size_t bytes_on_wire)
709 struct SendTransmitContinuationContext *stcc = cls;
710 struct SendOkMessage send_ok_msg;
712 send_ok_msg.header.size = htons (sizeof (send_ok_msg));
713 send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
714 send_ok_msg.bytes_msg = htonl (bytes_payload);
715 send_ok_msg.bytes_physical = htonl (bytes_on_wire);
716 send_ok_msg.success = htonl (success);
717 send_ok_msg.peer = stcc->target;
718 GST_clients_unicast (stcc->client,
721 GNUNET_SERVER_client_drop (stcc->client);
727 * Client asked for transmission to a peer. Process the request.
730 * @param client the client
731 * @param message the send message that was sent
734 clients_handle_send (void *cls,
735 struct GNUNET_SERVER_Client *client,
736 const struct GNUNET_MessageHeader *message)
738 const struct OutboundMessage *obm;
739 const struct GNUNET_MessageHeader *obmm;
740 struct SendTransmitContinuationContext *stcc;
743 struct TransportClient *tc;
745 tc = lookup_client (client);
748 /* client asked for transmission before 'START' */
750 GNUNET_SERVER_receive_done (client,
755 size = ntohs (message->size);
757 sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
760 GNUNET_SERVER_receive_done (client,
764 obm = (const struct OutboundMessage *) message;
765 obmm = (const struct GNUNET_MessageHeader *) &obm[1];
766 msize = size - sizeof (struct OutboundMessage);
767 if (msize < sizeof (struct GNUNET_MessageHeader))
770 GNUNET_SERVER_receive_done (client,
775 if (GNUNET_NO == GST_neighbours_test_connected (&obm->peer))
777 /* not connected, not allowed to send; can happen due to asynchronous operations */
778 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
779 "Could not send message to peer `%s': not connected\n",
780 GNUNET_i2s (&obm->peer));
781 GNUNET_STATISTICS_update (GST_stats,
783 ("# bytes payload dropped (other peer was not connected)"),
785 GNUNET_SERVER_receive_done (client,
789 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
790 "Received SEND request for `%s' and first message of type %u and total size %u\n",
791 GNUNET_i2s (&obm->peer),
794 GNUNET_SERVER_receive_done (client,
796 stcc = GNUNET_new (struct SendTransmitContinuationContext);
797 stcc->target = obm->peer;
798 stcc->client = client;
799 GNUNET_SERVER_client_keep (client);
800 GST_manipulation_send (&obm->peer,
803 GNUNET_TIME_relative_ntoh (obm->timeout),
804 &handle_send_transmit_continuation,
810 * Handle request connect message
812 * @param cls closure (always NULL)
813 * @param client identification of the client
814 * @param message the actual message
817 clients_handle_request_connect (void *cls,
818 struct GNUNET_SERVER_Client *client,
819 const struct GNUNET_MessageHeader *message)
821 const struct TransportRequestConnectMessage *trcm;
823 trcm = (const struct TransportRequestConnectMessage *) message;
824 GNUNET_break (0 == ntohl (trcm->reserved));
825 GNUNET_STATISTICS_update (GST_stats,
827 ("# REQUEST CONNECT messages received"), 1,
829 if (0 == memcmp (&trcm->peer,
831 sizeof (struct GNUNET_PeerIdentity)))
834 GNUNET_SERVER_receive_done (client,
838 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
839 "Received a request connect message for peer `%s'\n",
840 GNUNET_i2s (&trcm->peer));
841 GST_neighbours_try_connect (&trcm->peer);
842 GNUNET_SERVER_receive_done (client, GNUNET_OK);
847 * Handle request disconnect message
849 * @param cls closure (always NULL)
850 * @param client identification of the client
851 * @param message the actual message
854 clients_handle_request_disconnect (void *cls,
855 struct GNUNET_SERVER_Client *client,
856 const struct GNUNET_MessageHeader *message)
858 const struct TransportRequestDisconnectMessage *trdm;
860 trdm = (const struct TransportRequestDisconnectMessage *) message;
861 GNUNET_break (0 == ntohl (trdm->reserved));
862 GNUNET_STATISTICS_update (GST_stats,
864 ("# REQUEST DISCONNECT messages received"), 1,
866 if (0 == memcmp (&trdm->peer,
868 sizeof (struct GNUNET_PeerIdentity)))
871 GNUNET_SERVER_receive_done (client, GNUNET_OK);
874 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
875 "Received a request disconnect message for peer `%s'\n",
876 GNUNET_i2s (&trdm->peer));
877 (void) GST_neighbours_force_disconnect (&trdm->peer);
878 GNUNET_SERVER_receive_done (client, GNUNET_OK);
883 * Take the given address and append it to the set of results sent back to
884 * the client. This function may be called serveral times for a single
885 * conversion. The last invocation will be with a @a address of
886 * NULL and a @a res of #GNUNET_OK. Thus, to indicate conversion
887 * errors, the callback might be called first with @a address NULL and
888 * @a res being #GNUNET_SYSERR. In that case, there will still be a
889 * subsequent call later with @a address NULL and @a res #GNUNET_OK.
891 * @param cls the transmission context used (`struct GNUNET_SERVER_TransmitContext *`)
892 * @param buf text to transmit (contains the human-readable address, or NULL)
893 * @param res #GNUNET_OK if conversion was successful, #GNUNET_SYSERR on error,
897 transmit_address_to_client (void *cls,
901 struct AddressToStringContext *actx = cls;
902 struct AddressToStringResultMessage *atsm;
906 GNUNET_assert ( (GNUNET_OK == res) ||
907 (GNUNET_SYSERR == res) );
910 len = sizeof (struct AddressToStringResultMessage);
911 atsm = GNUNET_malloc (len);
912 atsm->header.size = ntohs (len);
913 atsm->header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
914 if (GNUNET_OK == res)
916 /* this was the last call, transmit */
917 atsm->res = htonl (GNUNET_OK);
918 atsm->addr_len = htonl (0);
919 GNUNET_SERVER_transmit_context_append_message (actx->tc,
920 (const struct GNUNET_MessageHeader *) atsm);
921 GNUNET_SERVER_transmit_context_run (actx->tc,
922 GNUNET_TIME_UNIT_FOREVER_REL);
923 GNUNET_CONTAINER_DLL_remove (a2s_head,
930 if (GNUNET_SYSERR == res)
932 /* address conversion failed, but there will be more callbacks */
933 atsm->res = htonl (GNUNET_SYSERR);
934 atsm->addr_len = htonl (0);
935 GNUNET_SERVER_transmit_context_append_message (actx->tc,
936 (const struct GNUNET_MessageHeader *) atsm);
941 GNUNET_assert (GNUNET_OK == res);
942 /* succesful conversion, append*/
943 slen = strlen (buf) + 1;
944 len = sizeof (struct AddressToStringResultMessage) + slen;
945 atsm = GNUNET_malloc (len);
946 atsm->header.size = ntohs (len);
947 atsm->header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
948 atsm->res = htonl (GNUNET_YES);
949 atsm->addr_len = htonl (slen);
953 GNUNET_SERVER_transmit_context_append_message (actx->tc,
954 (const struct GNUNET_MessageHeader *) atsm);
960 * Client asked to resolve an address. Process the request.
963 * @param client the client
964 * @param message the resolution request
967 clients_handle_address_to_string (void *cls,
968 struct GNUNET_SERVER_Client *client,
969 const struct GNUNET_MessageHeader *message)
971 const struct AddressLookupMessage *alum;
972 struct GNUNET_TRANSPORT_PluginFunctions *papi;
973 const char *plugin_name;
975 uint32_t address_len;
977 struct GNUNET_SERVER_TransmitContext *tc;
978 struct AddressToStringContext *actx;
979 struct AddressToStringResultMessage atsm;
980 struct GNUNET_TIME_Relative rtimeout;
983 size = ntohs (message->size);
984 if (size < sizeof (struct AddressLookupMessage))
987 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
990 alum = (const struct AddressLookupMessage *) message;
991 address_len = ntohs (alum->addrlen);
992 if (size <= sizeof (struct AddressLookupMessage) + address_len)
995 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
998 address = (const char *) &alum[1];
999 plugin_name = (const char *) &address[address_len];
1000 if ('\0' != plugin_name[size - sizeof (struct AddressLookupMessage) - address_len - 1])
1003 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1006 rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
1007 numeric = ntohs (alum->numeric_only);
1008 tc = GNUNET_SERVER_transmit_context_create (client);
1009 papi = GST_plugins_printer_find (plugin_name);
1012 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1013 "Failed to find plugin `%s'\n",
1015 atsm.header.size = ntohs (sizeof (struct AddressToStringResultMessage));
1016 atsm.header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
1017 atsm.res = htonl (GNUNET_SYSERR);
1018 atsm.addr_len = htonl (0);
1019 GNUNET_SERVER_transmit_context_append_message (tc,
1021 atsm.header.size = ntohs (sizeof (struct AddressToStringResultMessage));
1022 atsm.header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
1023 atsm.res = htonl (GNUNET_OK);
1024 atsm.addr_len = htonl (0);
1025 GNUNET_SERVER_transmit_context_append_message (tc,
1027 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1030 actx = GNUNET_new (struct AddressToStringContext);
1032 GNUNET_CONTAINER_DLL_insert (a2s_head, a2s_tail, actx);
1033 GNUNET_SERVER_disable_receive_done_warning (client);
1034 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1035 "Pretty-printing address of %u bytes using plugin `%s'\n",
1038 papi->address_pretty_printer (papi->cls,
1040 address, address_len,
1043 &transmit_address_to_client,
1049 * Compose #PeerIterateResponseMessage using the given peer and address.
1051 * @param peer identity of the peer
1052 * @param address the address, NULL on disconnect
1053 * @return composed message
1055 static struct PeerIterateResponseMessage *
1056 compose_address_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
1057 const struct GNUNET_HELLO_Address *address)
1059 struct PeerIterateResponseMessage *msg;
1065 GNUNET_assert (NULL != peer);
1066 if (NULL != address)
1068 tlen = strlen (address->transport_name) + 1;
1069 alen = address->address_length;
1076 size = (sizeof (struct PeerIterateResponseMessage) + alen + tlen);
1077 msg = GNUNET_malloc (size);
1078 msg->header.size = htons (size);
1080 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
1081 msg->reserved = htonl (0);
1083 msg->addrlen = htonl (alen);
1084 msg->pluginlen = htonl (tlen);
1086 if (NULL != address)
1088 msg->local_address_info = htonl((uint32_t) address->local_info);
1089 addr = (char *) &msg[1];
1090 memcpy (addr, address->address, alen);
1091 memcpy (&addr[alen], address->transport_name, tlen);
1098 * Compose #PeerIterateResponseMessage using the given peer and address.
1100 * @param peer identity of the peer
1101 * @param address the address, NULL on disconnect
1102 * @return composed message
1104 static struct ValidationIterateResponseMessage *
1105 compose_validation_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
1106 const struct GNUNET_HELLO_Address *address)
1108 struct ValidationIterateResponseMessage *msg;
1114 GNUNET_assert (NULL != peer);
1115 if (NULL != address)
1117 tlen = strlen (address->transport_name) + 1;
1118 alen = address->address_length;
1125 size = (sizeof (struct ValidationIterateResponseMessage) + alen + tlen);
1126 msg = GNUNET_malloc (size);
1127 msg->header.size = htons (size);
1129 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
1130 msg->reserved = htonl (0);
1132 msg->addrlen = htonl (alen);
1133 msg->pluginlen = htonl (tlen);
1135 if (NULL != address)
1137 msg->local_address_info = htonl((uint32_t) address->local_info);
1138 addr = (char *) &msg[1];
1139 memcpy (addr, address->address, alen);
1140 memcpy (&addr[alen], address->transport_name, tlen);
1147 * Context for #send_validation_information() and
1148 * #send_peer_information().
1150 struct IterationContext
1153 * Context to use for the transmission.
1155 struct GNUNET_SERVER_TransmitContext *tc;
1158 * Which peers do we care about?
1160 struct GNUNET_PeerIdentity id;
1163 * #GNUNET_YES if @e id should be ignored because we want all peers.
1170 * Output information of validation entries to the given client.
1172 * @param cls the `struct IterationContext *`
1173 * @param address the address
1174 * @param last_validation point in time when last validation was performed
1175 * @param valid_until point in time how long address is valid
1176 * @param next_validation point in time when next validation will be performed
1177 * @param state state of validation notification
1180 send_validation_information (void *cls,
1181 const struct GNUNET_HELLO_Address *address,
1182 struct GNUNET_TIME_Absolute last_validation,
1183 struct GNUNET_TIME_Absolute valid_until,
1184 struct GNUNET_TIME_Absolute next_validation,
1185 enum GNUNET_TRANSPORT_ValidationState state)
1187 struct IterationContext *pc = cls;
1188 struct ValidationIterateResponseMessage *msg;
1190 if ( (GNUNET_YES != pc->all) &&
1191 (0 != memcmp (&address->peer, &pc->id, sizeof (pc->id))) )
1193 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1194 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1195 GNUNET_i2s (&address->peer),
1196 (NULL != address) ? GST_plugins_a2s (address) : "<none>");
1197 msg = compose_validation_iterate_response_message (&address->peer, address);
1198 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1199 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1200 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1201 msg->state = htonl ((uint32_t) state);
1202 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1208 * Output information of neighbours to the given client.
1210 * @param cls the `struct PeerIterationContext *`
1211 * @param peer identity of the neighbour
1212 * @param address the address
1213 * @param state current state this peer is in
1214 * @param state_timeout timeout for the current state of the peer
1215 * @param bandwidth_in inbound quota in NBO
1216 * @param bandwidth_out outbound quota in NBO
1219 send_peer_information (void *cls,
1220 const struct GNUNET_PeerIdentity *peer,
1221 const struct GNUNET_HELLO_Address *address,
1222 enum GNUNET_TRANSPORT_PeerState state,
1223 struct GNUNET_TIME_Absolute state_timeout,
1224 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1225 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
1227 struct IterationContext *pc = cls;
1228 struct PeerIterateResponseMessage *msg;
1230 if ( (GNUNET_YES != pc->all) &&
1231 (0 != memcmp (peer, &pc->id, sizeof (pc->id))) )
1233 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1234 "Sending information about `%s' using address `%s' in state `%s'\n",
1236 (NULL != address) ? GST_plugins_a2s (address) : "<none>",
1237 GNUNET_TRANSPORT_ps2s (state));
1238 msg = compose_address_iterate_response_message (peer, address);
1239 msg->state = htonl (state);
1240 msg->state_timeout = GNUNET_TIME_absolute_hton(state_timeout);
1241 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1247 * Client asked to obtain information about a specific or all peers
1248 * Process the request.
1251 * @param client the client
1252 * @param message the peer address information request
1255 clients_handle_monitor_peers (void *cls,
1256 struct GNUNET_SERVER_Client *client,
1257 const struct GNUNET_MessageHeader *message)
1259 struct GNUNET_SERVER_TransmitContext *tc;
1260 const struct PeerMonitorMessage *msg;
1261 struct IterationContext pc;
1263 msg = (const struct PeerMonitorMessage *) message;
1264 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1265 (NULL != lookup_monitoring_client (peer_monitoring_clients_head,
1269 GNUNET_SERVER_receive_done (client,
1273 GNUNET_SERVER_disable_receive_done_warning (client);
1274 GNUNET_SERVER_client_mark_monitor (client);
1275 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1277 /* Send initial list */
1278 if (0 == memcmp (&msg->peer,
1280 sizeof (struct GNUNET_PeerIdentity)))
1282 /* iterate over all neighbours */
1283 pc.all = GNUNET_YES;
1288 /* just return one neighbour */
1292 GST_neighbours_iterate (&send_peer_information,
1295 if (GNUNET_YES != ntohl (msg->one_shot))
1297 setup_peer_monitoring_client (client,
1302 GNUNET_SERVER_transmit_context_append_data (tc,
1305 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
1307 GNUNET_SERVER_transmit_context_run (tc,
1308 GNUNET_TIME_UNIT_FOREVER_REL);
1313 * Client asked to obtain information about a specific or all validation
1317 * @param client the client
1318 * @param message the peer address information request
1321 clients_handle_monitor_validation (void *cls,
1322 struct GNUNET_SERVER_Client *client,
1323 const struct GNUNET_MessageHeader *message)
1325 struct GNUNET_SERVER_TransmitContext *tc;
1326 struct PeerMonitorMessage *msg;
1327 struct IterationContext pc;
1329 if (ntohs (message->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST)
1332 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1335 if (ntohs (message->size) != sizeof (struct ValidationMonitorMessage))
1338 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1341 msg = (struct PeerMonitorMessage *) message;
1342 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1343 (NULL != lookup_monitoring_client (val_monitoring_clients_head, client)) )
1346 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1349 GNUNET_SERVER_disable_receive_done_warning (client);
1350 GNUNET_SERVER_client_mark_monitor (client);
1351 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1353 /* Send initial list */
1354 if (0 == memcmp (&msg->peer,
1356 sizeof (struct GNUNET_PeerIdentity)))
1358 /* iterate over all neighbours */
1359 pc.all = GNUNET_YES;
1364 /* just return one neighbour */
1368 GST_validation_iterate (&send_validation_information,
1371 if (GNUNET_YES != ntohl (msg->one_shot))
1373 setup_val_monitoring_client (client, &msg->peer);
1377 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
1378 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
1380 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1385 * Function called by the plugin with information about the
1386 * current sessions managed by the plugin (for monitoring).
1388 * @param cls closure
1389 * @param session session handle this information is about,
1390 * NULL to indicate that we are "in sync" (initial
1391 * iteration complete)
1392 * @param info information about the state of the session,
1393 * NULL if @a session is also NULL and we are
1394 * merely signalling that the initial iteration is over
1397 plugin_session_info_cb (void *cls,
1398 struct Session *session,
1399 const struct GNUNET_TRANSPORT_SessionInfo *info)
1401 struct TransportPluginMonitorMessage *msg;
1402 struct GNUNET_MessageHeader sync;
1409 if (0 == GNUNET_SERVER_notification_context_get_size (plugin_nc))
1411 GST_plugins_monitor_subscribe (NULL,
1415 if ( (NULL == info) &&
1418 /* end of initial iteration */
1419 if (NULL != sync_client)
1421 sync.size = htons (sizeof (struct GNUNET_MessageHeader));
1422 sync.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_SYNC);
1423 GNUNET_SERVER_notification_context_unicast (plugin_nc,
1431 GNUNET_assert (NULL != info);
1432 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1433 "Plugin event for peer %s on transport %s\n",
1434 GNUNET_i2s (&info->address->peer),
1435 info->address->transport_name);
1436 slen = strlen (info->address->transport_name) + 1;
1437 alen = info->address->address_length;
1438 size = sizeof (struct TransportPluginMonitorMessage) + slen + alen;
1439 if (size > UINT16_MAX)
1444 msg = GNUNET_malloc (size);
1445 msg->header.size = htons (size);
1446 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT);
1447 msg->session_state = htons ((uint16_t) info->state);
1448 msg->is_inbound = htons ((int16_t) info->is_inbound);
1449 msg->msgs_pending = htonl (info->num_msg_pending);
1450 msg->bytes_pending = htonl (info->num_bytes_pending);
1451 msg->timeout = GNUNET_TIME_absolute_hton (info->session_timeout);
1452 msg->delay = GNUNET_TIME_absolute_hton (info->receive_delay);
1453 msg->peer = info->address->peer;
1454 msg->session_id = (uint64_t) (intptr_t) session;
1455 msg->plugin_name_len = htons (slen);
1456 msg->plugin_address_len = htons (alen);
1457 name = (char *) &msg[1];
1459 info->address->transport_name,
1463 info->address->address,
1465 if (NULL != sync_client)
1466 GNUNET_SERVER_notification_context_unicast (plugin_nc,
1471 GNUNET_SERVER_notification_context_broadcast (plugin_nc,
1479 * Client asked to obtain information about all plugin connections.
1482 * @param client the client
1483 * @param message the peer address information request
1486 clients_handle_monitor_plugins (void *cls,
1487 struct GNUNET_SERVER_Client *client,
1488 const struct GNUNET_MessageHeader *message)
1490 GNUNET_SERVER_client_mark_monitor (client);
1491 GNUNET_SERVER_disable_receive_done_warning (client);
1492 GNUNET_SERVER_notification_context_add (plugin_nc,
1494 GNUNET_assert (NULL == sync_client);
1495 sync_client = client;
1496 GST_plugins_monitor_subscribe (&plugin_session_info_cb,
1502 * Start handling requests from clients.
1504 * @param server server used to accept clients from.
1507 GST_clients_start (struct GNUNET_SERVER_Handle *server)
1509 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1510 {&clients_handle_start, NULL,
1511 GNUNET_MESSAGE_TYPE_TRANSPORT_START, sizeof (struct StartMessage)},
1512 {&clients_handle_hello, NULL,
1513 GNUNET_MESSAGE_TYPE_HELLO, 0},
1514 {&clients_handle_send, NULL,
1515 GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, 0},
1516 {&clients_handle_request_connect, NULL,
1517 GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT,
1518 sizeof (struct TransportRequestConnectMessage)},
1519 {&clients_handle_request_disconnect, NULL,
1520 GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_DISCONNECT,
1521 sizeof (struct TransportRequestDisconnectMessage)},
1522 {&clients_handle_address_to_string, NULL,
1523 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING, 0},
1524 {&clients_handle_monitor_peers, NULL,
1525 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST,
1526 sizeof (struct PeerMonitorMessage)},
1527 {&clients_handle_monitor_validation, NULL,
1528 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST,
1529 sizeof (struct ValidationMonitorMessage)},
1530 {&GST_blacklist_handle_init, NULL,
1531 GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT,
1532 sizeof (struct GNUNET_MessageHeader)},
1533 {&GST_blacklist_handle_reply, NULL,
1534 GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY,
1535 sizeof (struct BlacklistMessage)},
1536 {&GST_manipulation_set_metric, NULL,
1537 GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC,
1538 sizeof (struct TrafficMetricMessage) },
1539 {&clients_handle_monitor_plugins, NULL,
1540 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_START,
1541 sizeof (struct GNUNET_MessageHeader) },
1544 peer_nc = GNUNET_SERVER_notification_context_create (server, 0);
1545 val_nc = GNUNET_SERVER_notification_context_create (server, 0);
1546 plugin_nc = GNUNET_SERVER_notification_context_create (server, 0);
1547 GNUNET_SERVER_add_handlers (server, handlers);
1548 GNUNET_SERVER_disconnect_notify (server,
1549 &client_disconnect_notification,
1555 * Stop processing clients.
1560 struct AddressToStringContext *cur;
1562 while (NULL != (cur = a2s_head))
1564 GNUNET_SERVER_transmit_context_destroy (cur->tc, GNUNET_NO);
1565 GNUNET_CONTAINER_DLL_remove (a2s_head, a2s_tail, cur);
1568 if (NULL != peer_nc)
1570 GNUNET_SERVER_notification_context_destroy (peer_nc);
1575 GNUNET_SERVER_notification_context_destroy (val_nc);
1578 if (NULL != plugin_nc)
1580 GNUNET_SERVER_notification_context_destroy (plugin_nc);
1587 * Broadcast the given message to all of our clients.
1589 * @param msg message to broadcast
1590 * @param may_drop #GNUNET_YES if the message can be dropped / is payload
1593 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
1596 struct TransportClient *tc;
1598 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1599 "Asked to broadcast message of type %u with %u bytes\n",
1600 (unsigned int) ntohs (msg->type),
1601 (unsigned int) ntohs (msg->size));
1602 for (tc = clients_head; NULL != tc; tc = tc->next)
1604 if ( (GNUNET_YES == may_drop) &&
1605 (GNUNET_YES != tc->send_payload) )
1606 continue; /* skip, this client does not care about payload */
1607 unicast (tc, msg, may_drop);
1613 * Send the given message to a particular client
1615 * @param client target of the message
1616 * @param msg message to transmit
1617 * @param may_drop #GNUNET_YES if the message can be dropped
1620 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
1621 const struct GNUNET_MessageHeader *msg,
1624 struct TransportClient *tc;
1626 tc = lookup_client (client);
1628 return; /* client got disconnected in the meantime, drop message */
1629 unicast (tc, msg, may_drop);
1634 * Broadcast the new active address to all clients monitoring the peer.
1636 * @param peer peer this update is about (never NULL)
1637 * @param address address, NULL on disconnect
1638 * @param state the current state of the peer
1639 * @param state_timeout the time out for the state
1642 GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer,
1643 const struct GNUNET_HELLO_Address *address,
1644 enum GNUNET_TRANSPORT_PeerState state,
1645 struct GNUNET_TIME_Absolute state_timeout)
1647 struct PeerIterateResponseMessage *msg;
1648 struct MonitoringClient *mc;
1650 msg = compose_address_iterate_response_message (peer, address);
1651 msg->state = htonl (state);
1652 msg->state_timeout = GNUNET_TIME_absolute_hton (state_timeout);
1653 for (mc = peer_monitoring_clients_head; NULL != mc; mc = mc->next)
1654 if ((0 == memcmp (&mc->peer, &all_zeros,
1655 sizeof (struct GNUNET_PeerIdentity))) ||
1656 (0 == memcmp (&mc->peer, peer,
1657 sizeof (struct GNUNET_PeerIdentity))))
1658 GNUNET_SERVER_notification_context_unicast (peer_nc,
1667 * Broadcast the new validation changes to all clients monitoring the peer.
1669 * @param peer peer this update is about (never NULL)
1670 * @param address address, NULL on disconnect
1671 * @param last_validation point in time when last validation was performed
1672 * @param valid_until point in time how long address is valid
1673 * @param next_validation point in time when next validation will be performed
1674 * @param state state of validation notification
1677 GST_clients_broadcast_validation_notification (const struct GNUNET_PeerIdentity *peer,
1678 const struct GNUNET_HELLO_Address *address,
1679 struct GNUNET_TIME_Absolute last_validation,
1680 struct GNUNET_TIME_Absolute valid_until,
1681 struct GNUNET_TIME_Absolute next_validation,
1682 enum GNUNET_TRANSPORT_ValidationState state)
1684 struct ValidationIterateResponseMessage *msg;
1685 struct MonitoringClient *mc;
1687 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1688 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1690 (address != NULL) ? GST_plugins_a2s (address) : "<none>");
1691 msg = compose_validation_iterate_response_message (peer, address);
1692 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1693 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1694 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1695 msg->state = htonl ((uint32_t) state);
1696 for (mc = val_monitoring_clients_head; NULL != mc; mc = mc->next)
1697 if ((0 == memcmp (&mc->peer, &all_zeros,
1698 sizeof (struct GNUNET_PeerIdentity))) ||
1699 (0 == memcmp (&mc->peer, peer,
1700 sizeof (struct GNUNET_PeerIdentity))))
1701 GNUNET_SERVER_notification_context_unicast (val_nc,
1709 /* end of file gnunet-service-transport_clients.c */