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;
693 * At what time did we receive the message?
695 struct GNUNET_TIME_Absolute send_time;
698 * Unique ID, for logging.
700 unsigned long long uuid;
705 * Function called after the transmission is done. Notify the client that it is
706 * OK to send the next message.
709 * @param success #GNUNET_OK on success, #GNUNET_NO on failure, #GNUNET_SYSERR if we're not connected
710 * @param bytes_payload bytes payload sent
711 * @param bytes_on_wire bytes sent on wire
714 handle_send_transmit_continuation (void *cls,
716 size_t bytes_payload,
717 size_t bytes_on_wire)
719 struct SendTransmitContinuationContext *stcc = cls;
720 struct SendOkMessage send_ok_msg;
721 struct GNUNET_TIME_Relative delay;
722 const struct GNUNET_HELLO_Address *addr;
724 delay = GNUNET_TIME_absolute_get_duration (stcc->send_time);
725 addr = GST_neighbour_get_current_address (&stcc->target);
726 if (delay.rel_value_us > GNUNET_CONSTANTS_LATENCY_WARN.rel_value_us)
727 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
728 "It took us %s to send %u/%u bytes to %s (%d, %s)\n",
729 GNUNET_STRINGS_relative_time_to_string (delay,
731 (unsigned int) bytes_payload,
732 (unsigned int) bytes_on_wire,
733 GNUNET_i2s (&stcc->target),
735 (NULL != addr) ? addr->transport_name : "%");
737 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
738 "It took us %s to send %u/%u bytes to %s (%d, %s)\n",
739 GNUNET_STRINGS_relative_time_to_string (delay,
741 (unsigned int) bytes_payload,
742 (unsigned int) bytes_on_wire,
743 GNUNET_i2s (&stcc->target),
745 (NULL != addr) ? addr->transport_name : "%");
747 if (GST_neighbours_test_connected (&stcc->target))
749 /* Only send confirmation if we are still connected */
750 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
751 "Sending SEND_OK for transmission request %llu\n",
753 send_ok_msg.header.size = htons (sizeof (send_ok_msg));
754 send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
755 send_ok_msg.bytes_msg = htonl (bytes_payload);
756 send_ok_msg.bytes_physical = htonl (bytes_on_wire);
757 send_ok_msg.success = htonl (success);
758 send_ok_msg.peer = stcc->target;
759 GST_clients_unicast (stcc->client,
763 GNUNET_SERVER_client_drop (stcc->client);
769 * Client asked for transmission to a peer. Process the request.
772 * @param client the client
773 * @param message the send message that was sent
776 clients_handle_send (void *cls,
777 struct GNUNET_SERVER_Client *client,
778 const struct GNUNET_MessageHeader *message)
780 static unsigned long long uuid_gen;
781 const struct OutboundMessage *obm;
782 const struct GNUNET_MessageHeader *obmm;
783 struct SendTransmitContinuationContext *stcc;
786 struct TransportClient *tc;
788 tc = lookup_client (client);
791 /* client asked for transmission before 'START' */
793 GNUNET_SERVER_receive_done (client,
798 size = ntohs (message->size);
800 sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
803 GNUNET_SERVER_receive_done (client,
807 obm = (const struct OutboundMessage *) message;
808 obmm = (const struct GNUNET_MessageHeader *) &obm[1];
809 msize = size - sizeof (struct OutboundMessage);
810 if (msize < sizeof (struct GNUNET_MessageHeader))
813 GNUNET_SERVER_receive_done (client,
818 if (GNUNET_NO == GST_neighbours_test_connected (&obm->peer))
820 /* not connected, not allowed to send; can happen due to asynchronous operations */
821 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
822 "Could not send message to peer `%s': not connected\n",
823 GNUNET_i2s (&obm->peer));
824 GNUNET_STATISTICS_update (GST_stats,
826 ("# bytes payload dropped (other peer was not connected)"),
828 GNUNET_SERVER_receive_done (client,
832 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
833 "Received SEND request %llu for `%s' and first message of type %u and total size %u\n",
835 GNUNET_i2s (&obm->peer),
838 GNUNET_SERVER_receive_done (client,
840 stcc = GNUNET_new (struct SendTransmitContinuationContext);
841 stcc->target = obm->peer;
842 stcc->client = client;
843 stcc->send_time = GNUNET_TIME_absolute_get ();
844 stcc->uuid = uuid_gen++;
845 GNUNET_SERVER_client_keep (client);
846 GST_manipulation_send (&obm->peer,
849 GNUNET_TIME_relative_ntoh (obm->timeout),
850 &handle_send_transmit_continuation,
856 * Handle request connect message
858 * @param cls closure (always NULL)
859 * @param client identification of the client
860 * @param message the actual message
863 clients_handle_request_connect (void *cls,
864 struct GNUNET_SERVER_Client *client,
865 const struct GNUNET_MessageHeader *message)
867 const struct TransportRequestConnectMessage *trcm;
869 trcm = (const struct TransportRequestConnectMessage *) message;
870 GNUNET_break (0 == ntohl (trcm->reserved));
871 GNUNET_STATISTICS_update (GST_stats,
873 ("# REQUEST CONNECT messages received"), 1,
875 if (0 == memcmp (&trcm->peer,
877 sizeof (struct GNUNET_PeerIdentity)))
880 GNUNET_SERVER_receive_done (client,
884 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
885 "Received a request connect message for peer `%s'\n",
886 GNUNET_i2s (&trcm->peer));
887 GST_neighbours_try_connect (&trcm->peer);
888 GNUNET_SERVER_receive_done (client, GNUNET_OK);
893 * Take the given address and append it to the set of results sent back to
894 * the client. This function may be called serveral times for a single
895 * conversion. The last invocation will be with a @a address of
896 * NULL and a @a res of #GNUNET_OK. Thus, to indicate conversion
897 * errors, the callback might be called first with @a address NULL and
898 * @a res being #GNUNET_SYSERR. In that case, there will still be a
899 * subsequent call later with @a address NULL and @a res #GNUNET_OK.
901 * @param cls the transmission context used (`struct GNUNET_SERVER_TransmitContext *`)
902 * @param buf text to transmit (contains the human-readable address, or NULL)
903 * @param res #GNUNET_OK if conversion was successful, #GNUNET_SYSERR on error,
907 transmit_address_to_client (void *cls,
911 struct AddressToStringContext *actx = cls;
912 struct AddressToStringResultMessage *atsm;
916 GNUNET_assert ( (GNUNET_OK == res) ||
917 (GNUNET_SYSERR == res) );
920 len = sizeof (struct AddressToStringResultMessage);
921 atsm = GNUNET_malloc (len);
922 atsm->header.size = ntohs (len);
923 atsm->header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
924 if (GNUNET_OK == res)
926 /* this was the last call, transmit */
927 atsm->res = htonl (GNUNET_OK);
928 atsm->addr_len = htonl (0);
929 GNUNET_SERVER_transmit_context_append_message (actx->tc,
930 (const struct GNUNET_MessageHeader *) atsm);
931 GNUNET_SERVER_transmit_context_run (actx->tc,
932 GNUNET_TIME_UNIT_FOREVER_REL);
933 GNUNET_CONTAINER_DLL_remove (a2s_head,
940 if (GNUNET_SYSERR == res)
942 /* address conversion failed, but there will be more callbacks */
943 atsm->res = htonl (GNUNET_SYSERR);
944 atsm->addr_len = htonl (0);
945 GNUNET_SERVER_transmit_context_append_message (actx->tc,
946 (const struct GNUNET_MessageHeader *) atsm);
951 GNUNET_assert (GNUNET_OK == res);
952 /* succesful conversion, append*/
953 slen = strlen (buf) + 1;
954 len = sizeof (struct AddressToStringResultMessage) + slen;
955 atsm = GNUNET_malloc (len);
956 atsm->header.size = ntohs (len);
957 atsm->header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
958 atsm->res = htonl (GNUNET_YES);
959 atsm->addr_len = htonl (slen);
963 GNUNET_SERVER_transmit_context_append_message (actx->tc,
964 (const struct GNUNET_MessageHeader *) atsm);
970 * Client asked to resolve an address. Process the request.
973 * @param client the client
974 * @param message the resolution request
977 clients_handle_address_to_string (void *cls,
978 struct GNUNET_SERVER_Client *client,
979 const struct GNUNET_MessageHeader *message)
981 const struct AddressLookupMessage *alum;
982 struct GNUNET_TRANSPORT_PluginFunctions *papi;
983 const char *plugin_name;
985 uint32_t address_len;
987 struct GNUNET_SERVER_TransmitContext *tc;
988 struct AddressToStringContext *actx;
989 struct AddressToStringResultMessage atsm;
990 struct GNUNET_TIME_Relative rtimeout;
993 size = ntohs (message->size);
994 if (size < sizeof (struct AddressLookupMessage))
997 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1000 alum = (const struct AddressLookupMessage *) message;
1001 address_len = ntohs (alum->addrlen);
1002 if (size <= sizeof (struct AddressLookupMessage) + address_len)
1005 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1008 address = (const char *) &alum[1];
1009 plugin_name = (const char *) &address[address_len];
1010 if ('\0' != plugin_name[size - sizeof (struct AddressLookupMessage) - address_len - 1])
1013 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1016 rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
1017 numeric = ntohs (alum->numeric_only);
1018 tc = GNUNET_SERVER_transmit_context_create (client);
1019 papi = GST_plugins_printer_find (plugin_name);
1022 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
1023 "Failed to find plugin `%s'\n",
1025 atsm.header.size = ntohs (sizeof (struct AddressToStringResultMessage));
1026 atsm.header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
1027 atsm.res = htonl (GNUNET_SYSERR);
1028 atsm.addr_len = htonl (0);
1029 GNUNET_SERVER_transmit_context_append_message (tc,
1031 atsm.header.size = ntohs (sizeof (struct AddressToStringResultMessage));
1032 atsm.header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
1033 atsm.res = htonl (GNUNET_OK);
1034 atsm.addr_len = htonl (0);
1035 GNUNET_SERVER_transmit_context_append_message (tc,
1037 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1040 actx = GNUNET_new (struct AddressToStringContext);
1042 GNUNET_CONTAINER_DLL_insert (a2s_head, a2s_tail, actx);
1043 GNUNET_SERVER_disable_receive_done_warning (client);
1044 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1045 "Pretty-printing address of %u bytes using plugin `%s'\n",
1048 papi->address_pretty_printer (papi->cls,
1050 address, address_len,
1053 &transmit_address_to_client,
1059 * Compose #PeerIterateResponseMessage using the given peer and address.
1061 * @param peer identity of the peer
1062 * @param address the address, NULL on disconnect
1063 * @return composed message
1065 static struct PeerIterateResponseMessage *
1066 compose_address_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
1067 const struct GNUNET_HELLO_Address *address)
1069 struct PeerIterateResponseMessage *msg;
1075 GNUNET_assert (NULL != peer);
1076 if (NULL != address)
1078 tlen = strlen (address->transport_name) + 1;
1079 alen = address->address_length;
1086 size = (sizeof (struct PeerIterateResponseMessage) + alen + tlen);
1087 msg = GNUNET_malloc (size);
1088 msg->header.size = htons (size);
1090 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
1091 msg->reserved = htonl (0);
1093 msg->addrlen = htonl (alen);
1094 msg->pluginlen = htonl (tlen);
1096 if (NULL != address)
1098 msg->local_address_info = htonl((uint32_t) address->local_info);
1099 addr = (char *) &msg[1];
1100 memcpy (addr, address->address, alen);
1101 memcpy (&addr[alen], address->transport_name, tlen);
1108 * Compose #PeerIterateResponseMessage using the given peer and address.
1110 * @param peer identity of the peer
1111 * @param address the address, NULL on disconnect
1112 * @return composed message
1114 static struct ValidationIterateResponseMessage *
1115 compose_validation_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
1116 const struct GNUNET_HELLO_Address *address)
1118 struct ValidationIterateResponseMessage *msg;
1124 GNUNET_assert (NULL != peer);
1125 if (NULL != address)
1127 tlen = strlen (address->transport_name) + 1;
1128 alen = address->address_length;
1135 size = (sizeof (struct ValidationIterateResponseMessage) + alen + tlen);
1136 msg = GNUNET_malloc (size);
1137 msg->header.size = htons (size);
1139 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
1140 msg->reserved = htonl (0);
1142 msg->addrlen = htonl (alen);
1143 msg->pluginlen = htonl (tlen);
1145 if (NULL != address)
1147 msg->local_address_info = htonl((uint32_t) address->local_info);
1148 addr = (char *) &msg[1];
1149 memcpy (addr, address->address, alen);
1150 memcpy (&addr[alen], address->transport_name, tlen);
1157 * Context for #send_validation_information() and
1158 * #send_peer_information().
1160 struct IterationContext
1163 * Context to use for the transmission.
1165 struct GNUNET_SERVER_TransmitContext *tc;
1168 * Which peers do we care about?
1170 struct GNUNET_PeerIdentity id;
1173 * #GNUNET_YES if @e id should be ignored because we want all peers.
1180 * Output information of validation entries to the given client.
1182 * @param cls the `struct IterationContext *`
1183 * @param address the address
1184 * @param last_validation point in time when last validation was performed
1185 * @param valid_until point in time how long address is valid
1186 * @param next_validation point in time when next validation will be performed
1187 * @param state state of validation notification
1190 send_validation_information (void *cls,
1191 const struct GNUNET_HELLO_Address *address,
1192 struct GNUNET_TIME_Absolute last_validation,
1193 struct GNUNET_TIME_Absolute valid_until,
1194 struct GNUNET_TIME_Absolute next_validation,
1195 enum GNUNET_TRANSPORT_ValidationState state)
1197 struct IterationContext *pc = cls;
1198 struct ValidationIterateResponseMessage *msg;
1200 if ( (GNUNET_YES != pc->all) &&
1201 (0 != memcmp (&address->peer, &pc->id, sizeof (pc->id))) )
1203 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1204 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1205 GNUNET_i2s (&address->peer),
1206 (NULL != address) ? GST_plugins_a2s (address) : "<none>");
1207 msg = compose_validation_iterate_response_message (&address->peer, address);
1208 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1209 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1210 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1211 msg->state = htonl ((uint32_t) state);
1212 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1218 * Output information of neighbours to the given client.
1220 * @param cls the `struct PeerIterationContext *`
1221 * @param peer identity of the neighbour
1222 * @param address the address
1223 * @param state current state this peer is in
1224 * @param state_timeout timeout for the current state of the peer
1225 * @param bandwidth_in inbound quota in NBO
1226 * @param bandwidth_out outbound quota in NBO
1229 send_peer_information (void *cls,
1230 const struct GNUNET_PeerIdentity *peer,
1231 const struct GNUNET_HELLO_Address *address,
1232 enum GNUNET_TRANSPORT_PeerState state,
1233 struct GNUNET_TIME_Absolute state_timeout,
1234 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1235 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
1237 struct IterationContext *pc = cls;
1238 struct PeerIterateResponseMessage *msg;
1240 if ( (GNUNET_YES != pc->all) &&
1241 (0 != memcmp (peer, &pc->id, sizeof (pc->id))) )
1243 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1244 "Sending information about `%s' using address `%s' in state `%s'\n",
1246 (NULL != address) ? GST_plugins_a2s (address) : "<none>",
1247 GNUNET_TRANSPORT_ps2s (state));
1248 msg = compose_address_iterate_response_message (peer, address);
1249 msg->state = htonl (state);
1250 msg->state_timeout = GNUNET_TIME_absolute_hton(state_timeout);
1251 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1257 * Client asked to obtain information about a specific or all peers
1258 * Process the request.
1261 * @param client the client
1262 * @param message the peer address information request
1265 clients_handle_monitor_peers (void *cls,
1266 struct GNUNET_SERVER_Client *client,
1267 const struct GNUNET_MessageHeader *message)
1269 struct GNUNET_SERVER_TransmitContext *tc;
1270 const struct PeerMonitorMessage *msg;
1271 struct IterationContext pc;
1273 msg = (const struct PeerMonitorMessage *) message;
1274 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1275 (NULL != lookup_monitoring_client (peer_monitoring_clients_head,
1279 GNUNET_SERVER_receive_done (client,
1283 GNUNET_SERVER_disable_receive_done_warning (client);
1284 GNUNET_SERVER_client_mark_monitor (client);
1285 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1287 /* Send initial list */
1288 if (0 == memcmp (&msg->peer,
1290 sizeof (struct GNUNET_PeerIdentity)))
1292 /* iterate over all neighbours */
1293 pc.all = GNUNET_YES;
1298 /* just return one neighbour */
1302 GST_neighbours_iterate (&send_peer_information,
1305 if (GNUNET_YES != ntohl (msg->one_shot))
1307 setup_peer_monitoring_client (client,
1312 GNUNET_SERVER_transmit_context_append_data (tc,
1315 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
1317 GNUNET_SERVER_transmit_context_run (tc,
1318 GNUNET_TIME_UNIT_FOREVER_REL);
1323 * Client asked to obtain information about a specific or all validation
1327 * @param client the client
1328 * @param message the peer address information request
1331 clients_handle_monitor_validation (void *cls,
1332 struct GNUNET_SERVER_Client *client,
1333 const struct GNUNET_MessageHeader *message)
1335 struct GNUNET_SERVER_TransmitContext *tc;
1336 struct PeerMonitorMessage *msg;
1337 struct IterationContext pc;
1339 if (ntohs (message->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST)
1342 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1345 if (ntohs (message->size) != sizeof (struct ValidationMonitorMessage))
1348 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1351 msg = (struct PeerMonitorMessage *) message;
1352 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1353 (NULL != lookup_monitoring_client (val_monitoring_clients_head, client)) )
1356 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1359 GNUNET_SERVER_disable_receive_done_warning (client);
1360 GNUNET_SERVER_client_mark_monitor (client);
1361 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1363 /* Send initial list */
1364 if (0 == memcmp (&msg->peer,
1366 sizeof (struct GNUNET_PeerIdentity)))
1368 /* iterate over all neighbours */
1369 pc.all = GNUNET_YES;
1374 /* just return one neighbour */
1378 GST_validation_iterate (&send_validation_information,
1381 if (GNUNET_YES != ntohl (msg->one_shot))
1383 setup_val_monitoring_client (client, &msg->peer);
1387 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
1388 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
1390 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1395 * Function called by the plugin with information about the
1396 * current sessions managed by the plugin (for monitoring).
1398 * @param cls closure
1399 * @param session session handle this information is about,
1400 * NULL to indicate that we are "in sync" (initial
1401 * iteration complete)
1402 * @param info information about the state of the session,
1403 * NULL if @a session is also NULL and we are
1404 * merely signalling that the initial iteration is over
1407 plugin_session_info_cb (void *cls,
1408 struct GNUNET_ATS_Session *session,
1409 const struct GNUNET_TRANSPORT_SessionInfo *info)
1411 struct TransportPluginMonitorMessage *msg;
1412 struct GNUNET_MessageHeader sync;
1419 if (0 == GNUNET_SERVER_notification_context_get_size (plugin_nc))
1421 GST_plugins_monitor_subscribe (NULL,
1425 if ( (NULL == info) &&
1428 /* end of initial iteration */
1429 if (NULL != sync_client)
1431 sync.size = htons (sizeof (struct GNUNET_MessageHeader));
1432 sync.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_SYNC);
1433 GNUNET_SERVER_notification_context_unicast (plugin_nc,
1441 GNUNET_assert (NULL != info);
1442 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1443 "Plugin event for peer %s on transport %s\n",
1444 GNUNET_i2s (&info->address->peer),
1445 info->address->transport_name);
1446 slen = strlen (info->address->transport_name) + 1;
1447 alen = info->address->address_length;
1448 size = sizeof (struct TransportPluginMonitorMessage) + slen + alen;
1449 if (size > UINT16_MAX)
1454 msg = GNUNET_malloc (size);
1455 msg->header.size = htons (size);
1456 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT);
1457 msg->session_state = htons ((uint16_t) info->state);
1458 msg->is_inbound = htons ((int16_t) info->is_inbound);
1459 msg->msgs_pending = htonl (info->num_msg_pending);
1460 msg->bytes_pending = htonl (info->num_bytes_pending);
1461 msg->timeout = GNUNET_TIME_absolute_hton (info->session_timeout);
1462 msg->delay = GNUNET_TIME_absolute_hton (info->receive_delay);
1463 msg->peer = info->address->peer;
1464 msg->session_id = (uint64_t) (intptr_t) session;
1465 msg->plugin_name_len = htons (slen);
1466 msg->plugin_address_len = htons (alen);
1467 name = (char *) &msg[1];
1469 info->address->transport_name,
1473 info->address->address,
1475 if (NULL != sync_client)
1476 GNUNET_SERVER_notification_context_unicast (plugin_nc,
1481 GNUNET_SERVER_notification_context_broadcast (plugin_nc,
1489 * Client asked to obtain information about all plugin connections.
1492 * @param client the client
1493 * @param message the peer address information request
1496 clients_handle_monitor_plugins (void *cls,
1497 struct GNUNET_SERVER_Client *client,
1498 const struct GNUNET_MessageHeader *message)
1500 GNUNET_SERVER_client_mark_monitor (client);
1501 GNUNET_SERVER_disable_receive_done_warning (client);
1502 GNUNET_SERVER_notification_context_add (plugin_nc,
1504 GNUNET_assert (NULL == sync_client);
1505 sync_client = client;
1506 GST_plugins_monitor_subscribe (&plugin_session_info_cb,
1512 * Start handling requests from clients.
1514 * @param server server used to accept clients from.
1517 GST_clients_start (struct GNUNET_SERVER_Handle *server)
1519 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1520 {&clients_handle_start, NULL,
1521 GNUNET_MESSAGE_TYPE_TRANSPORT_START, sizeof (struct StartMessage)},
1522 {&clients_handle_hello, NULL,
1523 GNUNET_MESSAGE_TYPE_HELLO, 0},
1524 {&clients_handle_send, NULL,
1525 GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, 0},
1526 {&clients_handle_request_connect, NULL,
1527 GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT,
1528 sizeof (struct TransportRequestConnectMessage)},
1529 {&clients_handle_address_to_string, NULL,
1530 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING, 0},
1531 {&clients_handle_monitor_peers, NULL,
1532 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST,
1533 sizeof (struct PeerMonitorMessage)},
1534 {&clients_handle_monitor_validation, NULL,
1535 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST,
1536 sizeof (struct ValidationMonitorMessage)},
1537 {&GST_blacklist_handle_init, NULL,
1538 GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT,
1539 sizeof (struct GNUNET_MessageHeader)},
1540 {&GST_blacklist_handle_reply, NULL,
1541 GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY,
1542 sizeof (struct BlacklistMessage)},
1543 {&GST_manipulation_set_metric, NULL,
1544 GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC,
1545 sizeof (struct TrafficMetricMessage) },
1546 {&clients_handle_monitor_plugins, NULL,
1547 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_START,
1548 sizeof (struct GNUNET_MessageHeader) },
1551 peer_nc = GNUNET_SERVER_notification_context_create (server, 0);
1552 val_nc = GNUNET_SERVER_notification_context_create (server, 0);
1553 plugin_nc = GNUNET_SERVER_notification_context_create (server, 0);
1554 GNUNET_SERVER_add_handlers (server, handlers);
1555 GNUNET_SERVER_disconnect_notify (server,
1556 &client_disconnect_notification,
1562 * Stop processing clients.
1567 struct AddressToStringContext *cur;
1569 while (NULL != (cur = a2s_head))
1571 GNUNET_SERVER_transmit_context_destroy (cur->tc, GNUNET_NO);
1572 GNUNET_CONTAINER_DLL_remove (a2s_head, a2s_tail, cur);
1575 if (NULL != peer_nc)
1577 GNUNET_SERVER_notification_context_destroy (peer_nc);
1582 GNUNET_SERVER_notification_context_destroy (val_nc);
1585 if (NULL != plugin_nc)
1587 GNUNET_SERVER_notification_context_destroy (plugin_nc);
1594 * Broadcast the given message to all of our clients.
1596 * @param msg message to broadcast
1597 * @param may_drop #GNUNET_YES if the message can be dropped / is payload
1600 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
1603 struct TransportClient *tc;
1605 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1606 "Asked to broadcast message of type %u with %u bytes\n",
1607 (unsigned int) ntohs (msg->type),
1608 (unsigned int) ntohs (msg->size));
1609 for (tc = clients_head; NULL != tc; tc = tc->next)
1611 if ( (GNUNET_YES == may_drop) &&
1612 (GNUNET_YES != tc->send_payload) )
1613 continue; /* skip, this client does not care about payload */
1614 unicast (tc, msg, may_drop);
1620 * Send the given message to a particular client
1622 * @param client target of the message
1623 * @param msg message to transmit
1624 * @param may_drop #GNUNET_YES if the message can be dropped
1627 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
1628 const struct GNUNET_MessageHeader *msg,
1631 struct TransportClient *tc;
1633 tc = lookup_client (client);
1635 return; /* client got disconnected in the meantime, drop message */
1636 unicast (tc, msg, may_drop);
1641 * Broadcast the new active address to all clients monitoring the peer.
1643 * @param peer peer this update is about (never NULL)
1644 * @param address address, NULL on disconnect
1645 * @param state the current state of the peer
1646 * @param state_timeout the time out for the state
1649 GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer,
1650 const struct GNUNET_HELLO_Address *address,
1651 enum GNUNET_TRANSPORT_PeerState state,
1652 struct GNUNET_TIME_Absolute state_timeout)
1654 struct PeerIterateResponseMessage *msg;
1655 struct MonitoringClient *mc;
1657 msg = compose_address_iterate_response_message (peer, address);
1658 msg->state = htonl (state);
1659 msg->state_timeout = GNUNET_TIME_absolute_hton (state_timeout);
1660 for (mc = peer_monitoring_clients_head; NULL != mc; mc = mc->next)
1661 if ((0 == memcmp (&mc->peer, &all_zeros,
1662 sizeof (struct GNUNET_PeerIdentity))) ||
1663 (0 == memcmp (&mc->peer, peer,
1664 sizeof (struct GNUNET_PeerIdentity))))
1665 GNUNET_SERVER_notification_context_unicast (peer_nc,
1674 * Broadcast the new validation changes to all clients monitoring the peer.
1676 * @param peer peer this update is about (never NULL)
1677 * @param address address, NULL on disconnect
1678 * @param last_validation point in time when last validation was performed
1679 * @param valid_until point in time how long address is valid
1680 * @param next_validation point in time when next validation will be performed
1681 * @param state state of validation notification
1684 GST_clients_broadcast_validation_notification (const struct GNUNET_PeerIdentity *peer,
1685 const struct GNUNET_HELLO_Address *address,
1686 struct GNUNET_TIME_Absolute last_validation,
1687 struct GNUNET_TIME_Absolute valid_until,
1688 struct GNUNET_TIME_Absolute next_validation,
1689 enum GNUNET_TRANSPORT_ValidationState state)
1691 struct ValidationIterateResponseMessage *msg;
1692 struct MonitoringClient *mc;
1694 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1695 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1697 (address != NULL) ? GST_plugins_a2s (address) : "<none>");
1698 msg = compose_validation_iterate_response_message (peer, address);
1699 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1700 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1701 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1702 msg->state = htonl ((uint32_t) state);
1703 for (mc = val_monitoring_clients_head; NULL != mc; mc = mc->next)
1704 if ((0 == memcmp (&mc->peer, &all_zeros,
1705 sizeof (struct GNUNET_PeerIdentity))) ||
1706 (0 == memcmp (&mc->peer, peer,
1707 sizeof (struct GNUNET_PeerIdentity))))
1708 GNUNET_SERVER_notification_context_unicast (val_nc,
1716 /* end of file gnunet-service-transport_clients.c */