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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, 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, GNUNET_SYSERR);
754 size = ntohs (message->size);
756 sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
759 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
762 obm = (const struct OutboundMessage *) message;
763 obmm = (const struct GNUNET_MessageHeader *) &obm[1];
764 msize = size - sizeof (struct OutboundMessage);
765 if (msize < sizeof (struct GNUNET_MessageHeader))
768 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
772 if (GNUNET_NO == GST_neighbours_test_connected (&obm->peer))
774 /* not connected, not allowed to send; can happen due to asynchronous operations */
775 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
776 "Could not send message to peer `%s': not connected\n",
777 GNUNET_i2s (&obm->peer));
778 GNUNET_STATISTICS_update (GST_stats,
780 ("# bytes payload dropped (other peer was not connected)"),
782 GNUNET_SERVER_receive_done (client, GNUNET_OK);
785 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
786 "Received `%s' request from client with target `%4s' and first message of type %u and total size %u\n",
788 GNUNET_i2s (&obm->peer),
791 GNUNET_SERVER_receive_done (client, GNUNET_OK);
792 stcc = GNUNET_new (struct SendTransmitContinuationContext);
793 stcc->target = obm->peer;
794 stcc->client = client;
795 GNUNET_SERVER_client_keep (client);
796 GST_manipulation_send (&obm->peer, obmm, msize,
797 GNUNET_TIME_relative_ntoh (obm->timeout),
798 &handle_send_transmit_continuation, stcc);
803 * Handle request connect message
805 * @param cls closure (always NULL)
806 * @param client identification of the client
807 * @param message the actual message
810 clients_handle_request_connect (void *cls,
811 struct GNUNET_SERVER_Client *client,
812 const struct GNUNET_MessageHeader *message)
814 const struct TransportRequestConnectMessage *trcm;
816 trcm = (const struct TransportRequestConnectMessage *) message;
817 GNUNET_break (0 == ntohl (trcm->reserved));
818 GNUNET_STATISTICS_update (GST_stats,
820 ("# REQUEST CONNECT messages received"), 1,
822 if (0 == memcmp (&trcm->peer,
824 sizeof (struct GNUNET_PeerIdentity)))
827 GNUNET_SERVER_receive_done (client, GNUNET_OK);
830 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
831 "Received a request connect message for peer `%s'\n",
832 GNUNET_i2s (&trcm->peer));
833 GST_neighbours_try_connect (&trcm->peer);
834 GNUNET_SERVER_receive_done (client, GNUNET_OK);
839 * Handle request disconnect message
841 * @param cls closure (always NULL)
842 * @param client identification of the client
843 * @param message the actual message
846 clients_handle_request_disconnect (void *cls,
847 struct GNUNET_SERVER_Client *client,
848 const struct GNUNET_MessageHeader *message)
850 const struct TransportRequestDisconnectMessage *trdm;
852 trdm = (const struct TransportRequestDisconnectMessage *) message;
853 GNUNET_break (0 == ntohl (trdm->reserved));
854 GNUNET_STATISTICS_update (GST_stats,
856 ("# REQUEST DISCONNECT messages received"), 1,
858 if (0 == memcmp (&trdm->peer,
860 sizeof (struct GNUNET_PeerIdentity)))
863 GNUNET_SERVER_receive_done (client, GNUNET_OK);
866 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
867 "Received a request disconnect message for peer `%s'\n",
868 GNUNET_i2s (&trdm->peer));
869 (void) GST_neighbours_force_disconnect (&trdm->peer);
870 GNUNET_SERVER_receive_done (client, GNUNET_OK);
875 * Take the given address and append it to the set of results sent back to
876 * the client. This function may be called serveral times for a single
877 * conversion. The last invocation will be with a @a address of
878 * NULL and a @a res of #GNUNET_OK. Thus, to indicate conversion
879 * errors, the callback might be called first with @a address NULL and
880 * @a res being #GNUNET_SYSERR. In that case, there will still be a
881 * subsequent call later with @a address NULL and @a res #GNUNET_OK.
883 * @param cls the transmission context used (`struct GNUNET_SERVER_TransmitContext *`)
884 * @param buf text to transmit (contains the human-readable address, or NULL)
885 * @param res #GNUNET_OK if conversion was successful, #GNUNET_SYSERR on error,
889 transmit_address_to_client (void *cls,
893 struct AddressToStringContext *actx = cls;
894 struct AddressToStringResultMessage *atsm;
898 GNUNET_assert ( (GNUNET_OK == res) ||
899 (GNUNET_SYSERR == res) );
902 len = sizeof (struct AddressToStringResultMessage);
903 atsm = GNUNET_malloc (len);
904 atsm->header.size = ntohs (len);
905 atsm->header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
906 if (GNUNET_OK == res)
908 /* this was the last call, transmit */
909 atsm->res = htonl (GNUNET_OK);
910 atsm->addr_len = htonl (0);
911 GNUNET_SERVER_transmit_context_append_message (actx->tc,
912 (const struct GNUNET_MessageHeader *) atsm);
913 GNUNET_SERVER_transmit_context_run (actx->tc,
914 GNUNET_TIME_UNIT_FOREVER_REL);
915 GNUNET_CONTAINER_DLL_remove (a2s_head,
922 if (GNUNET_SYSERR == res)
924 /* address conversion failed, but there will be more callbacks */
925 atsm->res = htonl (GNUNET_SYSERR);
926 atsm->addr_len = htonl (0);
927 GNUNET_SERVER_transmit_context_append_message (actx->tc,
928 (const struct GNUNET_MessageHeader *) atsm);
933 GNUNET_assert (GNUNET_OK == res);
934 /* succesful conversion, append*/
935 slen = strlen (buf) + 1;
936 len = sizeof (struct AddressToStringResultMessage) + slen;
937 atsm = GNUNET_malloc (len);
938 atsm->header.size = ntohs (len);
939 atsm->header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
940 atsm->res = htonl (GNUNET_YES);
941 atsm->addr_len = htonl (slen);
945 GNUNET_SERVER_transmit_context_append_message (actx->tc,
946 (const struct GNUNET_MessageHeader *) atsm);
952 * Client asked to resolve an address. Process the request.
955 * @param client the client
956 * @param message the resolution request
959 clients_handle_address_to_string (void *cls,
960 struct GNUNET_SERVER_Client *client,
961 const struct GNUNET_MessageHeader *message)
963 const struct AddressLookupMessage *alum;
964 struct GNUNET_TRANSPORT_PluginFunctions *papi;
965 const char *plugin_name;
967 uint32_t address_len;
969 struct GNUNET_SERVER_TransmitContext *tc;
970 struct AddressToStringContext *actx;
971 struct AddressToStringResultMessage atsm;
972 struct GNUNET_TIME_Relative rtimeout;
975 size = ntohs (message->size);
976 if (size < sizeof (struct AddressLookupMessage))
979 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
982 alum = (const struct AddressLookupMessage *) message;
983 address_len = ntohs (alum->addrlen);
984 if (size <= sizeof (struct AddressLookupMessage) + address_len)
987 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
990 address = (const char *) &alum[1];
991 plugin_name = (const char *) &address[address_len];
992 if ('\0' != plugin_name[size - sizeof (struct AddressLookupMessage) - address_len - 1])
995 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
998 rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
999 numeric = ntohs (alum->numeric_only);
1000 tc = GNUNET_SERVER_transmit_context_create (client);
1001 papi = GST_plugins_printer_find (plugin_name);
1004 atsm.header.size = ntohs (sizeof (struct AddressToStringResultMessage));
1005 atsm.header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
1006 atsm.res = htonl (GNUNET_SYSERR);
1007 atsm.addr_len = htonl (0);
1008 GNUNET_SERVER_transmit_context_append_message (tc,
1010 atsm.header.size = ntohs (sizeof (struct AddressToStringResultMessage));
1011 atsm.header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
1012 atsm.res = htonl (GNUNET_OK);
1013 atsm.addr_len = htonl (0);
1014 GNUNET_SERVER_transmit_context_append_message (tc,
1016 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1019 actx = GNUNET_new (struct AddressToStringContext);
1021 GNUNET_CONTAINER_DLL_insert (a2s_head, a2s_tail, actx);
1022 GNUNET_SERVER_disable_receive_done_warning (client);
1023 papi->address_pretty_printer (papi->cls,
1025 address, address_len,
1028 &transmit_address_to_client,
1034 * Compose #PeerIterateResponseMessage using the given peer and address.
1036 * @param peer identity of the peer
1037 * @param address the address, NULL on disconnect
1038 * @return composed message
1040 static struct PeerIterateResponseMessage *
1041 compose_address_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
1042 const struct GNUNET_HELLO_Address *address)
1044 struct PeerIterateResponseMessage *msg;
1050 GNUNET_assert (NULL != peer);
1051 if (NULL != address)
1053 tlen = strlen (address->transport_name) + 1;
1054 alen = address->address_length;
1061 size = (sizeof (struct PeerIterateResponseMessage) + alen + tlen);
1062 msg = GNUNET_malloc (size);
1063 msg->header.size = htons (size);
1065 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
1066 msg->reserved = htonl (0);
1068 msg->addrlen = htonl (alen);
1069 msg->pluginlen = htonl (tlen);
1071 if (NULL != address)
1073 msg->local_address_info = htonl((uint32_t) address->local_info);
1074 addr = (char *) &msg[1];
1075 memcpy (addr, address->address, alen);
1076 memcpy (&addr[alen], address->transport_name, tlen);
1083 * Compose #PeerIterateResponseMessage using the given peer and address.
1085 * @param peer identity of the peer
1086 * @param address the address, NULL on disconnect
1087 * @return composed message
1089 static struct ValidationIterateResponseMessage *
1090 compose_validation_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
1091 const struct GNUNET_HELLO_Address *address)
1093 struct ValidationIterateResponseMessage *msg;
1099 GNUNET_assert (NULL != peer);
1100 if (NULL != address)
1102 tlen = strlen (address->transport_name) + 1;
1103 alen = address->address_length;
1110 size = (sizeof (struct ValidationIterateResponseMessage) + alen + tlen);
1111 msg = GNUNET_malloc (size);
1112 msg->header.size = htons (size);
1114 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
1115 msg->reserved = htonl (0);
1117 msg->addrlen = htonl (alen);
1118 msg->pluginlen = htonl (tlen);
1120 if (NULL != address)
1122 msg->local_address_info = htonl((uint32_t) address->local_info);
1123 addr = (char *) &msg[1];
1124 memcpy (addr, address->address, alen);
1125 memcpy (&addr[alen], address->transport_name, tlen);
1132 * Context for #send_validation_information() and
1133 * #send_peer_information().
1135 struct IterationContext
1138 * Context to use for the transmission.
1140 struct GNUNET_SERVER_TransmitContext *tc;
1143 * Which peers do we care about?
1145 struct GNUNET_PeerIdentity id;
1148 * #GNUNET_YES if @e id should be ignored because we want all peers.
1155 * Output information of validation entries to the given client.
1157 * @param cls the `struct IterationContext *`
1158 * @param address the address
1159 * @param last_validation point in time when last validation was performed
1160 * @param valid_until point in time how long address is valid
1161 * @param next_validation point in time when next validation will be performed
1162 * @param state state of validation notification
1165 send_validation_information (void *cls,
1166 const struct GNUNET_HELLO_Address *address,
1167 struct GNUNET_TIME_Absolute last_validation,
1168 struct GNUNET_TIME_Absolute valid_until,
1169 struct GNUNET_TIME_Absolute next_validation,
1170 enum GNUNET_TRANSPORT_ValidationState state)
1172 struct IterationContext *pc = cls;
1173 struct ValidationIterateResponseMessage *msg;
1175 if ( (GNUNET_YES != pc->all) &&
1176 (0 != memcmp (&address->peer, &pc->id, sizeof (pc->id))) )
1178 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1179 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1180 GNUNET_i2s (&address->peer),
1181 (NULL != address) ? GST_plugins_a2s (address) : "<none>");
1182 msg = compose_validation_iterate_response_message (&address->peer, address);
1183 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1184 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1185 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1186 msg->state = htonl ((uint32_t) state);
1187 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1193 * Output information of neighbours to the given client.
1195 * @param cls the `struct PeerIterationContext *`
1196 * @param peer identity of the neighbour
1197 * @param address the address
1198 * @param state current state this peer is in
1199 * @param state_timeout timeout for the current state of the peer
1200 * @param bandwidth_in inbound quota in NBO
1201 * @param bandwidth_out outbound quota in NBO
1204 send_peer_information (void *cls,
1205 const struct GNUNET_PeerIdentity *peer,
1206 const struct GNUNET_HELLO_Address *address,
1207 enum GNUNET_TRANSPORT_PeerState state,
1208 struct GNUNET_TIME_Absolute state_timeout,
1209 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1210 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
1212 struct IterationContext *pc = cls;
1213 struct PeerIterateResponseMessage *msg;
1215 if ( (GNUNET_YES != pc->all) &&
1216 (0 != memcmp (peer, &pc->id, sizeof (pc->id))) )
1218 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1219 "Sending information about `%s' using address `%s' in state `%s'\n",
1221 (NULL != address) ? GST_plugins_a2s (address) : "<none>",
1222 GNUNET_TRANSPORT_ps2s (state));
1223 msg = compose_address_iterate_response_message (peer, address);
1224 msg->state = htonl (state);
1225 msg->state_timeout = GNUNET_TIME_absolute_hton(state_timeout);
1226 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1232 * Client asked to obtain information about a specific or all peers
1233 * Process the request.
1236 * @param client the client
1237 * @param message the peer address information request
1240 clients_handle_monitor_peers (void *cls,
1241 struct GNUNET_SERVER_Client *client,
1242 const struct GNUNET_MessageHeader *message)
1244 struct GNUNET_SERVER_TransmitContext *tc;
1245 const struct PeerMonitorMessage *msg;
1246 struct IterationContext pc;
1248 msg = (const struct PeerMonitorMessage *) message;
1249 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1250 (NULL != lookup_monitoring_client (peer_monitoring_clients_head,
1254 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1257 GNUNET_SERVER_disable_receive_done_warning (client);
1258 GNUNET_SERVER_client_mark_monitor (client);
1259 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1261 /* Send initial list */
1262 if (0 == memcmp (&msg->peer,
1264 sizeof (struct GNUNET_PeerIdentity)))
1266 /* iterate over all neighbours */
1267 pc.all = GNUNET_YES;
1272 /* just return one neighbour */
1276 GST_neighbours_iterate (&send_peer_information, &pc);
1278 if (GNUNET_YES != ntohl (msg->one_shot))
1280 setup_peer_monitoring_client (client, &msg->peer);
1284 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
1285 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
1288 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1293 * Client asked to obtain information about a specific or all validation
1297 * @param client the client
1298 * @param message the peer address information request
1301 clients_handle_monitor_validation (void *cls,
1302 struct GNUNET_SERVER_Client *client,
1303 const struct GNUNET_MessageHeader *message)
1305 struct GNUNET_SERVER_TransmitContext *tc;
1306 struct PeerMonitorMessage *msg;
1307 struct IterationContext pc;
1309 if (ntohs (message->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST)
1312 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1315 if (ntohs (message->size) != sizeof (struct ValidationMonitorMessage))
1318 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1321 msg = (struct PeerMonitorMessage *) message;
1322 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1323 (NULL != lookup_monitoring_client (val_monitoring_clients_head, client)) )
1326 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1329 GNUNET_SERVER_disable_receive_done_warning (client);
1330 GNUNET_SERVER_client_mark_monitor (client);
1331 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1333 /* Send initial list */
1334 if (0 == memcmp (&msg->peer,
1336 sizeof (struct GNUNET_PeerIdentity)))
1338 /* iterate over all neighbours */
1339 pc.all = GNUNET_YES;
1344 /* just return one neighbour */
1348 GST_validation_iterate (&send_validation_information,
1351 if (GNUNET_YES != ntohl (msg->one_shot))
1353 setup_val_monitoring_client (client, &msg->peer);
1357 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
1358 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
1360 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1365 * Function called by the plugin with information about the
1366 * current sessions managed by the plugin (for monitoring).
1368 * @param cls closure
1369 * @param session session handle this information is about,
1370 * NULL to indicate that we are "in sync" (initial
1371 * iteration complete)
1372 * @param info information about the state of the session,
1373 * NULL if @a session is also NULL and we are
1374 * merely signalling that the initial iteration is over
1377 plugin_session_info_cb (void *cls,
1378 struct Session *session,
1379 const struct GNUNET_TRANSPORT_SessionInfo *info)
1381 struct TransportPluginMonitorMessage *msg;
1382 struct GNUNET_MessageHeader sync;
1389 if (0 == GNUNET_SERVER_notification_context_get_size (plugin_nc))
1391 fprintf (stderr, "UNSUB!\n");
1392 GST_plugins_monitor_subscribe (NULL, NULL);
1395 if ( (NULL == info) &&
1398 /* end of initial iteration */
1399 if (NULL != sync_client)
1401 sync.size = htons (sizeof (struct GNUNET_MessageHeader));
1402 sync.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_SYNC);
1403 GNUNET_SERVER_notification_context_unicast (plugin_nc,
1411 GNUNET_assert (NULL != info);
1412 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1413 "Plugin event for peer %s on transport %s\n",
1414 GNUNET_i2s (&info->address->peer),
1415 info->address->transport_name);
1416 slen = strlen (info->address->transport_name) + 1;
1417 alen = info->address->address_length;
1418 size = sizeof (struct TransportPluginMonitorMessage) + slen + alen;
1419 if (size > UINT16_MAX)
1424 msg = GNUNET_malloc (size);
1425 msg->header.size = htons (size);
1426 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT);
1427 msg->session_state = htons ((uint16_t) info->state);
1428 msg->is_inbound = htons ((int16_t) info->is_inbound);
1429 msg->msgs_pending = htonl (info->num_msg_pending);
1430 msg->bytes_pending = htonl (info->num_bytes_pending);
1431 msg->timeout = GNUNET_TIME_absolute_hton (info->session_timeout);
1432 msg->delay = GNUNET_TIME_absolute_hton (info->receive_delay);
1433 msg->peer = info->address->peer;
1434 msg->session_id = (uint64_t) (intptr_t) session;
1435 msg->plugin_name_len = htons (slen);
1436 msg->plugin_address_len = htons (alen);
1437 name = (char *) &msg[1];
1438 memcpy (name, info->address->transport_name, slen);
1440 memcpy (addr, info->address->address, alen);
1441 if (NULL != sync_client)
1442 GNUNET_SERVER_notification_context_unicast (plugin_nc,
1447 GNUNET_SERVER_notification_context_broadcast (plugin_nc,
1455 * Client asked to obtain information about all plugin connections.
1458 * @param client the client
1459 * @param message the peer address information request
1462 clients_handle_monitor_plugins (void *cls,
1463 struct GNUNET_SERVER_Client *client,
1464 const struct GNUNET_MessageHeader *message)
1466 GNUNET_SERVER_client_mark_monitor (client);
1467 GNUNET_SERVER_disable_receive_done_warning (client);
1468 GNUNET_SERVER_notification_context_add (plugin_nc, client);
1469 sync_client = client;
1470 GST_plugins_monitor_subscribe (&plugin_session_info_cb, NULL);
1475 * Start handling requests from clients.
1477 * @param server server used to accept clients from.
1480 GST_clients_start (struct GNUNET_SERVER_Handle *server)
1482 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1483 {&clients_handle_start, NULL,
1484 GNUNET_MESSAGE_TYPE_TRANSPORT_START, sizeof (struct StartMessage)},
1485 {&clients_handle_hello, NULL,
1486 GNUNET_MESSAGE_TYPE_HELLO, 0},
1487 {&clients_handle_send, NULL,
1488 GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, 0},
1489 {&clients_handle_request_connect, NULL,
1490 GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT,
1491 sizeof (struct TransportRequestConnectMessage)},
1492 {&clients_handle_request_disconnect, NULL,
1493 GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_DISCONNECT,
1494 sizeof (struct TransportRequestDisconnectMessage)},
1495 {&clients_handle_address_to_string, NULL,
1496 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING, 0},
1497 {&clients_handle_monitor_peers, NULL,
1498 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST,
1499 sizeof (struct PeerMonitorMessage)},
1500 {&clients_handle_monitor_validation, NULL,
1501 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST,
1502 sizeof (struct ValidationMonitorMessage)},
1503 {&GST_blacklist_handle_init, NULL,
1504 GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT,
1505 sizeof (struct GNUNET_MessageHeader)},
1506 {&GST_blacklist_handle_reply, NULL,
1507 GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY,
1508 sizeof (struct BlacklistMessage)},
1509 {&GST_manipulation_set_metric, NULL,
1510 GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC, 0},
1511 {&clients_handle_monitor_plugins, NULL,
1512 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_START,
1513 sizeof (struct GNUNET_MessageHeader) },
1516 peer_nc = GNUNET_SERVER_notification_context_create (server, 0);
1517 val_nc = GNUNET_SERVER_notification_context_create (server, 0);
1518 plugin_nc = GNUNET_SERVER_notification_context_create (server, 0);
1519 GNUNET_SERVER_add_handlers (server, handlers);
1520 GNUNET_SERVER_disconnect_notify (server,
1521 &client_disconnect_notification,
1527 * Stop processing clients.
1532 struct AddressToStringContext *cur;
1534 while (NULL != (cur = a2s_head))
1536 GNUNET_SERVER_transmit_context_destroy (cur->tc, GNUNET_NO);
1537 GNUNET_CONTAINER_DLL_remove (a2s_head, a2s_tail, cur);
1540 if (NULL != peer_nc)
1542 GNUNET_SERVER_notification_context_destroy (peer_nc);
1547 GNUNET_SERVER_notification_context_destroy (val_nc);
1550 if (NULL != plugin_nc)
1552 GNUNET_SERVER_notification_context_destroy (plugin_nc);
1559 * Broadcast the given message to all of our clients.
1561 * @param msg message to broadcast
1562 * @param may_drop #GNUNET_YES if the message can be dropped / is payload
1565 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
1568 struct TransportClient *tc;
1570 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1571 "Asked to broadcast message of type %u with %u bytes\n",
1572 (unsigned int) ntohs (msg->type),
1573 (unsigned int) ntohs (msg->size));
1574 for (tc = clients_head; NULL != tc; tc = tc->next)
1576 if ( (GNUNET_YES == may_drop) &&
1577 (GNUNET_YES != tc->send_payload) )
1578 continue; /* skip, this client does not care about payload */
1579 unicast (tc, msg, may_drop);
1585 * Send the given message to a particular client
1587 * @param client target of the message
1588 * @param msg message to transmit
1589 * @param may_drop #GNUNET_YES if the message can be dropped
1592 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
1593 const struct GNUNET_MessageHeader *msg,
1596 struct TransportClient *tc;
1598 tc = lookup_client (client);
1600 return; /* client got disconnected in the meantime, drop message */
1601 unicast (tc, msg, may_drop);
1606 * Broadcast the new active address to all clients monitoring the peer.
1608 * @param peer peer this update is about (never NULL)
1609 * @param address address, NULL on disconnect
1610 * @param state the current state of the peer
1611 * @param state_timeout the time out for the state
1614 GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer,
1615 const struct GNUNET_HELLO_Address *address,
1616 enum GNUNET_TRANSPORT_PeerState state,
1617 struct GNUNET_TIME_Absolute state_timeout)
1619 struct PeerIterateResponseMessage *msg;
1620 struct MonitoringClient *mc;
1622 msg = compose_address_iterate_response_message (peer, address);
1623 msg->state = htonl (state);
1624 msg->state_timeout = GNUNET_TIME_absolute_hton (state_timeout);
1625 for (mc = peer_monitoring_clients_head; NULL != mc; mc = mc->next)
1626 if ((0 == memcmp (&mc->peer, &all_zeros,
1627 sizeof (struct GNUNET_PeerIdentity))) ||
1628 (0 == memcmp (&mc->peer, peer,
1629 sizeof (struct GNUNET_PeerIdentity))))
1630 GNUNET_SERVER_notification_context_unicast (peer_nc,
1639 * Broadcast the new validation changes to all clients monitoring the peer.
1641 * @param peer peer this update is about (never NULL)
1642 * @param address address, NULL on disconnect
1643 * @param last_validation point in time when last validation was performed
1644 * @param valid_until point in time how long address is valid
1645 * @param next_validation point in time when next validation will be performed
1646 * @param state state of validation notification
1649 GST_clients_broadcast_validation_notification (const struct GNUNET_PeerIdentity *peer,
1650 const struct GNUNET_HELLO_Address *address,
1651 struct GNUNET_TIME_Absolute last_validation,
1652 struct GNUNET_TIME_Absolute valid_until,
1653 struct GNUNET_TIME_Absolute next_validation,
1654 enum GNUNET_TRANSPORT_ValidationState state)
1656 struct ValidationIterateResponseMessage *msg;
1657 struct MonitoringClient *mc;
1659 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1660 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1662 (address != NULL) ? GST_plugins_a2s (address) : "<none>");
1663 msg = compose_validation_iterate_response_message (peer, address);
1664 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1665 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1666 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1667 msg->state = htonl ((uint32_t) state);
1668 for (mc = val_monitoring_clients_head; NULL != mc; mc = mc->next)
1669 if ((0 == memcmp (&mc->peer, &all_zeros,
1670 sizeof (struct GNUNET_PeerIdentity))) ||
1671 (0 == memcmp (&mc->peer, peer,
1672 sizeof (struct GNUNET_PeerIdentity))))
1673 GNUNET_SERVER_notification_context_unicast (val_nc,
1681 /* end of file gnunet-service-transport_clients.c */