2 This file is part of GNUnet.
3 (C) 2010-2014 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 struct TransportClient *tc;
619 tc = lookup_client (client);
620 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
621 "Client %p sent START\n", tc);
624 /* got 'start' twice from the same client, not allowed */
626 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
629 start = (const struct StartMessage *) message;
630 options = ntohl (start->options);
631 if ((0 != (1 & options)) &&
633 memcmp (&start->self, &GST_my_identity,
634 sizeof (struct GNUNET_PeerIdentity))))
636 /* client thinks this is a different peer, reject */
638 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
641 tc = setup_client (client);
642 tc->send_payload = (0 != (2 & options));
646 GST_neighbours_iterate (¬ify_client_about_neighbour, tc);
647 GNUNET_SERVER_receive_done (client, GNUNET_OK);
652 * Client sent us a HELLO. Process the request.
655 * @param client the client
656 * @param message the HELLO message
659 clients_handle_hello (void *cls,
660 struct GNUNET_SERVER_Client *client,
661 const struct GNUNET_MessageHeader *message)
663 GST_validation_handle_hello (message);
664 GNUNET_SERVER_receive_done (client, GNUNET_OK);
669 * Closure for #handle_send_transmit_continuation()
671 struct SendTransmitContinuationContext
674 * Client that made the request.
676 struct GNUNET_SERVER_Client *client;
679 * Peer that was the target.
681 struct GNUNET_PeerIdentity target;
686 * Function called after the transmission is done. Notify the client that it is
687 * OK to send the next message.
690 * @param success #GNUNET_OK on success, #GNUNET_NO on failure, #GNUNET_SYSERR if we're not connected
691 * @param bytes_payload bytes payload sent
692 * @param bytes_on_wire bytes sent on wire
695 handle_send_transmit_continuation (void *cls,
697 size_t bytes_payload,
698 size_t bytes_on_wire)
700 struct SendTransmitContinuationContext *stcc = cls;
701 struct SendOkMessage send_ok_msg;
703 if (GNUNET_OK == success)
704 GST_neighbours_notify_payload_sent (&stcc->target,
706 send_ok_msg.header.size = htons (sizeof (send_ok_msg));
707 send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
708 send_ok_msg.bytes_msg = htonl (bytes_payload);
709 send_ok_msg.bytes_physical = htonl (bytes_on_wire);
710 send_ok_msg.success = htonl (success);
711 send_ok_msg.peer = stcc->target;
712 GST_clients_unicast (stcc->client,
715 GNUNET_SERVER_client_drop (stcc->client);
721 * Client asked for transmission to a peer. Process the request.
724 * @param client the client
725 * @param message the send message that was sent
728 clients_handle_send (void *cls,
729 struct GNUNET_SERVER_Client *client,
730 const struct GNUNET_MessageHeader *message)
732 const struct OutboundMessage *obm;
733 const struct GNUNET_MessageHeader *obmm;
734 struct SendTransmitContinuationContext *stcc;
737 struct TransportClient *tc;
739 tc = lookup_client (client);
742 /* client asked for transmission before 'START' */
744 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
748 size = ntohs (message->size);
750 sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
753 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
756 obm = (const struct OutboundMessage *) message;
757 obmm = (const struct GNUNET_MessageHeader *) &obm[1];
758 msize = size - sizeof (struct OutboundMessage);
759 if (msize < sizeof (struct GNUNET_MessageHeader))
762 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
766 if (GNUNET_NO == GST_neighbours_test_connected (&obm->peer))
768 /* not connected, not allowed to send; can happen due to asynchronous operations */
769 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
770 "Could not send message to peer `%s': not connected\n",
771 GNUNET_i2s (&obm->peer));
772 GNUNET_STATISTICS_update (GST_stats,
774 ("# bytes payload dropped (other peer was not connected)"),
776 GNUNET_SERVER_receive_done (client, GNUNET_OK);
779 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
780 "Received `%s' request from client with target `%4s' and first message of type %u and total size %u\n",
782 GNUNET_i2s (&obm->peer),
785 GNUNET_SERVER_receive_done (client, GNUNET_OK);
786 stcc = GNUNET_new (struct SendTransmitContinuationContext);
787 stcc->target = obm->peer;
788 stcc->client = client;
789 GNUNET_SERVER_client_keep (client);
790 GST_manipulation_send (&obm->peer, obmm, msize,
791 GNUNET_TIME_relative_ntoh (obm->timeout),
792 &handle_send_transmit_continuation, stcc);
797 * Try to initiate a connection to the given peer if the blacklist
800 * @param cls closure (unused, NULL)
801 * @param peer identity of peer that was tested
802 * @param result #GNUNET_OK if the connection is allowed,
806 try_connect_if_allowed (void *cls,
807 const struct GNUNET_PeerIdentity *peer,
810 if (GNUNET_OK != result)
812 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
813 _("Blacklist refuses connection attempt to peer `%s'\n"),
815 return; /* not allowed */
817 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
818 "Blacklist allows connection attempt to peer `%s'\n",
821 GST_neighbours_try_connect (peer);
826 * Handle request connect message
828 * @param cls closure (always NULL)
829 * @param client identification of the client
830 * @param message the actual message
833 clients_handle_request_connect (void *cls,
834 struct GNUNET_SERVER_Client *client,
835 const struct GNUNET_MessageHeader *message)
837 const struct TransportRequestConnectMessage *trcm;
839 trcm = (const struct TransportRequestConnectMessage *) message;
840 GNUNET_break (0 == ntohl (trcm->reserved));
841 GNUNET_STATISTICS_update (GST_stats,
843 ("# REQUEST CONNECT messages received"), 1,
845 if (0 == memcmp (&trcm->peer,
847 sizeof (struct GNUNET_PeerIdentity)))
850 GNUNET_SERVER_receive_done (client, GNUNET_OK);
853 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
854 "Received a request connect message for peer `%s'\n",
855 GNUNET_i2s (&trcm->peer));
856 (void) GST_blacklist_test_allowed (&trcm->peer,
858 &try_connect_if_allowed,
860 GNUNET_SERVER_receive_done (client, GNUNET_OK);
865 * Handle request disconnect message
867 * @param cls closure (always NULL)
868 * @param client identification of the client
869 * @param message the actual message
872 clients_handle_request_disconnect (void *cls,
873 struct GNUNET_SERVER_Client *client,
874 const struct GNUNET_MessageHeader *message)
876 const struct TransportRequestDisconnectMessage *trdm;
878 trdm = (const struct TransportRequestDisconnectMessage *) message;
879 GNUNET_break (0 == ntohl (trdm->reserved));
880 GNUNET_STATISTICS_update (GST_stats,
882 ("# REQUEST DISCONNECT messages received"), 1,
884 if (0 == memcmp (&trdm->peer,
886 sizeof (struct GNUNET_PeerIdentity)))
889 GNUNET_SERVER_receive_done (client, GNUNET_OK);
892 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
893 "Received a request disconnect message for peer `%s'\n",
894 GNUNET_i2s (&trdm->peer));
895 (void) GST_neighbours_force_disconnect (&trdm->peer);
896 GNUNET_SERVER_receive_done (client, GNUNET_OK);
901 * Take the given address and append it to the set of results sent back to
902 * the client. This function may be called serveral times for a single
903 * conversion. The last invocation will be with a @a address of
904 * NULL and a @a res of #GNUNET_OK. Thus, to indicate conversion
905 * errors, the callback might be called first with @a address NULL and
906 * @a res being #GNUNET_SYSERR. In that case, there will still be a
907 * subsequent call later with @a address NULL and @a res #GNUNET_OK.
909 * @param cls the transmission context used (`struct GNUNET_SERVER_TransmitContext *`)
910 * @param buf text to transmit (contains the human-readable address, or NULL)
911 * @param res #GNUNET_OK if conversion was successful, #GNUNET_SYSERR on error,
915 transmit_address_to_client (void *cls,
919 struct AddressToStringContext *actx = cls;
920 struct AddressToStringResultMessage *atsm;
924 GNUNET_assert ( (GNUNET_OK == res) ||
925 (GNUNET_SYSERR == res) );
928 len = sizeof (struct AddressToStringResultMessage);
929 atsm = GNUNET_malloc (len);
930 atsm->header.size = ntohs (len);
931 atsm->header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
932 if (GNUNET_OK == res)
934 /* this was the last call, transmit */
935 atsm->res = htonl (GNUNET_OK);
936 atsm->addr_len = htonl (0);
937 GNUNET_SERVER_transmit_context_append_message (actx->tc,
938 (const struct GNUNET_MessageHeader *) atsm);
939 GNUNET_SERVER_transmit_context_run (actx->tc,
940 GNUNET_TIME_UNIT_FOREVER_REL);
941 GNUNET_CONTAINER_DLL_remove (a2s_head,
948 if (GNUNET_SYSERR == res)
950 /* address conversion failed, but there will be more callbacks */
951 atsm->res = htonl (GNUNET_SYSERR);
952 atsm->addr_len = htonl (0);
953 GNUNET_SERVER_transmit_context_append_message (actx->tc,
954 (const struct GNUNET_MessageHeader *) atsm);
959 GNUNET_assert (GNUNET_OK == res);
960 /* succesful conversion, append*/
961 slen = strlen (buf) + 1;
962 len = sizeof (struct AddressToStringResultMessage) + slen;
963 atsm = GNUNET_malloc (len);
964 atsm->header.size = ntohs (len);
965 atsm->header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
966 atsm->res = htonl (GNUNET_YES);
967 atsm->addr_len = htonl (slen);
971 GNUNET_SERVER_transmit_context_append_message (actx->tc,
972 (const struct GNUNET_MessageHeader *) atsm);
978 * Client asked to resolve an address. Process the request.
981 * @param client the client
982 * @param message the resolution request
985 clients_handle_address_to_string (void *cls,
986 struct GNUNET_SERVER_Client *client,
987 const struct GNUNET_MessageHeader *message)
989 const struct AddressLookupMessage *alum;
990 struct GNUNET_TRANSPORT_PluginFunctions *papi;
991 const char *plugin_name;
993 uint32_t address_len;
995 struct GNUNET_SERVER_TransmitContext *tc;
996 struct AddressToStringContext *actx;
997 struct AddressToStringResultMessage atsm;
998 struct GNUNET_TIME_Relative rtimeout;
1001 size = ntohs (message->size);
1002 if (size < sizeof (struct AddressLookupMessage))
1005 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1008 alum = (const struct AddressLookupMessage *) message;
1009 address_len = ntohs (alum->addrlen);
1010 if (size <= sizeof (struct AddressLookupMessage) + address_len)
1013 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1016 address = (const char *) &alum[1];
1017 plugin_name = (const char *) &address[address_len];
1018 if ('\0' != plugin_name[size - sizeof (struct AddressLookupMessage) - address_len - 1])
1021 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1024 rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
1025 numeric = ntohs (alum->numeric_only);
1026 tc = GNUNET_SERVER_transmit_context_create (client);
1027 papi = GST_plugins_printer_find (plugin_name);
1030 atsm.header.size = ntohs (sizeof (struct AddressToStringResultMessage));
1031 atsm.header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
1032 atsm.res = htonl (GNUNET_SYSERR);
1033 atsm.addr_len = htonl (0);
1034 GNUNET_SERVER_transmit_context_append_message (tc,
1036 atsm.header.size = ntohs (sizeof (struct AddressToStringResultMessage));
1037 atsm.header.type = ntohs (GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
1038 atsm.res = htonl (GNUNET_OK);
1039 atsm.addr_len = htonl (0);
1040 GNUNET_SERVER_transmit_context_append_message (tc,
1042 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1045 actx = GNUNET_new (struct AddressToStringContext);
1047 GNUNET_CONTAINER_DLL_insert (a2s_head, a2s_tail, actx);
1048 GNUNET_SERVER_disable_receive_done_warning (client);
1049 papi->address_pretty_printer (papi->cls,
1051 address, address_len,
1054 &transmit_address_to_client,
1060 * Compose #PeerIterateResponseMessage using the given peer and address.
1062 * @param peer identity of the peer
1063 * @param address the address, NULL on disconnect
1064 * @return composed message
1066 static struct PeerIterateResponseMessage *
1067 compose_address_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
1068 const struct GNUNET_HELLO_Address *address)
1070 struct PeerIterateResponseMessage *msg;
1076 GNUNET_assert (NULL != peer);
1077 if (NULL != address)
1079 tlen = strlen (address->transport_name) + 1;
1080 alen = address->address_length;
1087 size = (sizeof (struct PeerIterateResponseMessage) + alen + tlen);
1088 msg = GNUNET_malloc (size);
1089 msg->header.size = htons (size);
1091 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
1092 msg->reserved = htonl (0);
1094 msg->addrlen = htonl (alen);
1095 msg->pluginlen = htonl (tlen);
1097 if (NULL != address)
1099 msg->local_address_info = htonl((uint32_t) address->local_info);
1100 addr = (char *) &msg[1];
1101 memcpy (addr, address->address, alen);
1102 memcpy (&addr[alen], address->transport_name, tlen);
1109 * Compose #PeerIterateResponseMessage using the given peer and address.
1111 * @param peer identity of the peer
1112 * @param address the address, NULL on disconnect
1113 * @return composed message
1115 static struct ValidationIterateResponseMessage *
1116 compose_validation_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
1117 const struct GNUNET_HELLO_Address *address)
1119 struct ValidationIterateResponseMessage *msg;
1125 GNUNET_assert (NULL != peer);
1126 if (NULL != address)
1128 tlen = strlen (address->transport_name) + 1;
1129 alen = address->address_length;
1136 size = (sizeof (struct ValidationIterateResponseMessage) + alen + tlen);
1137 msg = GNUNET_malloc (size);
1138 msg->header.size = htons (size);
1140 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
1141 msg->reserved = htonl (0);
1143 msg->addrlen = htonl (alen);
1144 msg->pluginlen = htonl (tlen);
1146 if (NULL != address)
1148 msg->local_address_info = htonl((uint32_t) address->local_info);
1149 addr = (char *) &msg[1];
1150 memcpy (addr, address->address, alen);
1151 memcpy (&addr[alen], address->transport_name, tlen);
1158 * Context for #send_validation_information() and
1159 * #send_peer_information().
1161 struct IterationContext
1164 * Context to use for the transmission.
1166 struct GNUNET_SERVER_TransmitContext *tc;
1169 * Which peers do we care about?
1171 struct GNUNET_PeerIdentity id;
1174 * #GNUNET_YES if @e id should be ignored because we want all peers.
1181 * Output information of validation entries to the given client.
1183 * @param cls the `struct IterationContext *`
1184 * @param address the address
1185 * @param last_validation point in time when last validation was performed
1186 * @param valid_until point in time how long address is valid
1187 * @param next_validation point in time when next validation will be performed
1188 * @param state state of validation notification
1191 send_validation_information (void *cls,
1192 const struct GNUNET_HELLO_Address *address,
1193 struct GNUNET_TIME_Absolute last_validation,
1194 struct GNUNET_TIME_Absolute valid_until,
1195 struct GNUNET_TIME_Absolute next_validation,
1196 enum GNUNET_TRANSPORT_ValidationState state)
1198 struct IterationContext *pc = cls;
1199 struct ValidationIterateResponseMessage *msg;
1201 if ( (GNUNET_YES != pc->all) &&
1202 (0 != memcmp (&address->peer, &pc->id, sizeof (pc->id))) )
1204 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1205 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1206 GNUNET_i2s (&address->peer),
1207 (NULL != address) ? GST_plugins_a2s (address) : "<none>");
1208 msg = compose_validation_iterate_response_message (&address->peer, address);
1209 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1210 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1211 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1212 msg->state = htonl ((uint32_t) state);
1213 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1219 * Output information of neighbours to the given client.
1221 * @param cls the `struct PeerIterationContext *`
1222 * @param peer identity of the neighbour
1223 * @param address the address
1224 * @param state current state this peer is in
1225 * @param state_timeout timeout for the current state of the peer
1226 * @param bandwidth_in inbound quota in NBO
1227 * @param bandwidth_out outbound quota in NBO
1230 send_peer_information (void *cls,
1231 const struct GNUNET_PeerIdentity *peer,
1232 const struct GNUNET_HELLO_Address *address,
1233 enum GNUNET_TRANSPORT_PeerState state,
1234 struct GNUNET_TIME_Absolute state_timeout,
1235 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1236 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
1238 struct IterationContext *pc = cls;
1239 struct PeerIterateResponseMessage *msg;
1241 if ( (GNUNET_YES != pc->all) &&
1242 (0 != memcmp (peer, &pc->id, sizeof (pc->id))) )
1244 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1245 "Sending information about `%s' using address `%s' in state `%s'\n",
1247 (NULL != address) ? GST_plugins_a2s (address) : "<none>",
1248 GNUNET_TRANSPORT_ps2s (state));
1249 msg = compose_address_iterate_response_message (peer, address);
1250 msg->state = htonl (state);
1251 msg->state_timeout = GNUNET_TIME_absolute_hton(state_timeout);
1252 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1258 * Client asked to obtain information about a specific or all peers
1259 * Process the request.
1262 * @param client the client
1263 * @param message the peer address information request
1266 clients_handle_monitor_peers (void *cls,
1267 struct GNUNET_SERVER_Client *client,
1268 const struct GNUNET_MessageHeader *message)
1270 struct GNUNET_SERVER_TransmitContext *tc;
1271 const struct PeerMonitorMessage *msg;
1272 struct IterationContext pc;
1274 msg = (const struct PeerMonitorMessage *) message;
1275 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1276 (NULL != lookup_monitoring_client (peer_monitoring_clients_head,
1280 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
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, &pc);
1304 if (GNUNET_YES != ntohl (msg->one_shot))
1306 setup_peer_monitoring_client (client, &msg->peer);
1310 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
1311 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
1314 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1319 * Client asked to obtain information about a specific or all validation
1323 * @param client the client
1324 * @param message the peer address information request
1327 clients_handle_monitor_validation (void *cls,
1328 struct GNUNET_SERVER_Client *client,
1329 const struct GNUNET_MessageHeader *message)
1331 struct GNUNET_SERVER_TransmitContext *tc;
1332 struct PeerMonitorMessage *msg;
1333 struct IterationContext pc;
1335 if (ntohs (message->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST)
1338 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1341 if (ntohs (message->size) != sizeof (struct ValidationMonitorMessage))
1344 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1347 msg = (struct PeerMonitorMessage *) message;
1348 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1349 (NULL != lookup_monitoring_client (val_monitoring_clients_head, client)) )
1352 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1355 GNUNET_SERVER_disable_receive_done_warning (client);
1356 GNUNET_SERVER_client_mark_monitor (client);
1357 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1359 /* Send initial list */
1360 if (0 == memcmp (&msg->peer,
1362 sizeof (struct GNUNET_PeerIdentity)))
1364 /* iterate over all neighbours */
1365 pc.all = GNUNET_YES;
1370 /* just return one neighbour */
1374 GST_validation_iterate (&send_validation_information,
1377 if (GNUNET_YES != ntohl (msg->one_shot))
1379 setup_val_monitoring_client (client, &msg->peer);
1383 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
1384 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
1386 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1391 * Function called by the plugin with information about the
1392 * current sessions managed by the plugin (for monitoring).
1394 * @param cls closure
1395 * @param session session handle this information is about,
1396 * NULL to indicate that we are "in sync" (initial
1397 * iteration complete)
1398 * @param info information about the state of the session,
1399 * NULL if @a session is also NULL and we are
1400 * merely signalling that the initial iteration is over
1403 plugin_session_info_cb (void *cls,
1404 struct Session *session,
1405 const struct GNUNET_TRANSPORT_SessionInfo *info)
1407 struct TransportPluginMonitorMessage *msg;
1408 struct GNUNET_MessageHeader sync;
1415 if (0 == GNUNET_SERVER_notification_context_get_size (plugin_nc))
1417 fprintf (stderr, "UNSUB!\n");
1418 GST_plugins_monitor_subscribe (NULL, NULL);
1421 if ( (NULL == info) &&
1424 /* end of initial iteration */
1425 if (NULL != sync_client)
1427 sync.size = htons (sizeof (struct GNUNET_MessageHeader));
1428 sync.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_SYNC);
1429 GNUNET_SERVER_notification_context_unicast (plugin_nc,
1437 GNUNET_assert (NULL != info);
1438 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1439 "Plugin event for peer %s on transport %s\n",
1440 GNUNET_i2s (&info->address->peer),
1441 info->address->transport_name);
1442 slen = strlen (info->address->transport_name) + 1;
1443 alen = info->address->address_length;
1444 size = sizeof (struct TransportPluginMonitorMessage) + slen + alen;
1445 if (size > UINT16_MAX)
1450 msg = GNUNET_malloc (size);
1451 msg->header.size = htons (size);
1452 msg->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT);
1453 msg->session_state = htons ((uint16_t) info->state);
1454 msg->is_inbound = htons ((int16_t) info->is_inbound);
1455 msg->msgs_pending = htonl (info->num_msg_pending);
1456 msg->bytes_pending = htonl (info->num_bytes_pending);
1457 msg->timeout = GNUNET_TIME_absolute_hton (info->session_timeout);
1458 msg->delay = GNUNET_TIME_absolute_hton (info->receive_delay);
1459 msg->peer = info->address->peer;
1460 msg->session_id = (uint64_t) (intptr_t) session;
1461 msg->plugin_name_len = htons (slen);
1462 msg->plugin_address_len = htons (alen);
1463 name = (char *) &msg[1];
1464 memcpy (name, info->address->transport_name, slen);
1466 memcpy (addr, info->address->address, alen);
1467 if (NULL != sync_client)
1468 GNUNET_SERVER_notification_context_unicast (plugin_nc,
1473 GNUNET_SERVER_notification_context_broadcast (plugin_nc,
1481 * Client asked to obtain information about all plugin connections.
1484 * @param client the client
1485 * @param message the peer address information request
1488 clients_handle_monitor_plugins (void *cls,
1489 struct GNUNET_SERVER_Client *client,
1490 const struct GNUNET_MessageHeader *message)
1492 GNUNET_SERVER_client_mark_monitor (client);
1493 GNUNET_SERVER_disable_receive_done_warning (client);
1494 GNUNET_SERVER_notification_context_add (plugin_nc, client);
1495 sync_client = client;
1496 GST_plugins_monitor_subscribe (&plugin_session_info_cb, NULL);
1501 * Start handling requests from clients.
1503 * @param server server used to accept clients from.
1506 GST_clients_start (struct GNUNET_SERVER_Handle *server)
1508 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1509 {&clients_handle_start, NULL,
1510 GNUNET_MESSAGE_TYPE_TRANSPORT_START, sizeof (struct StartMessage)},
1511 {&clients_handle_hello, NULL,
1512 GNUNET_MESSAGE_TYPE_HELLO, 0},
1513 {&clients_handle_send, NULL,
1514 GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, 0},
1515 {&clients_handle_request_connect, NULL,
1516 GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT,
1517 sizeof (struct TransportRequestConnectMessage)},
1518 {&clients_handle_request_disconnect, NULL,
1519 GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_DISCONNECT,
1520 sizeof (struct TransportRequestDisconnectMessage)},
1521 {&clients_handle_address_to_string, NULL,
1522 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING, 0},
1523 {&clients_handle_monitor_peers, NULL,
1524 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST,
1525 sizeof (struct PeerMonitorMessage)},
1526 {&clients_handle_monitor_validation, NULL,
1527 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST,
1528 sizeof (struct ValidationMonitorMessage)},
1529 {&GST_blacklist_handle_init, NULL,
1530 GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT,
1531 sizeof (struct GNUNET_MessageHeader)},
1532 {&GST_blacklist_handle_reply, NULL,
1533 GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY,
1534 sizeof (struct BlacklistMessage)},
1535 {&GST_manipulation_set_metric, NULL,
1536 GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC, 0},
1537 {&clients_handle_monitor_plugins, NULL,
1538 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_START,
1539 sizeof (struct GNUNET_MessageHeader) },
1542 peer_nc = GNUNET_SERVER_notification_context_create (server, 0);
1543 val_nc = GNUNET_SERVER_notification_context_create (server, 0);
1544 plugin_nc = GNUNET_SERVER_notification_context_create (server, 0);
1545 GNUNET_SERVER_add_handlers (server, handlers);
1546 GNUNET_SERVER_disconnect_notify (server,
1547 &client_disconnect_notification,
1553 * Stop processing clients.
1558 struct AddressToStringContext *cur;
1560 while (NULL != (cur = a2s_head))
1562 GNUNET_SERVER_transmit_context_destroy (cur->tc, GNUNET_NO);
1563 GNUNET_CONTAINER_DLL_remove (a2s_head, a2s_tail, cur);
1566 if (NULL != peer_nc)
1568 GNUNET_SERVER_notification_context_destroy (peer_nc);
1573 GNUNET_SERVER_notification_context_destroy (val_nc);
1576 if (NULL != plugin_nc)
1578 GNUNET_SERVER_notification_context_destroy (plugin_nc);
1585 * Broadcast the given message to all of our clients.
1587 * @param msg message to broadcast
1588 * @param may_drop #GNUNET_YES if the message can be dropped / is payload
1591 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg,
1594 struct TransportClient *tc;
1596 for (tc = clients_head; NULL != tc; tc = tc->next)
1598 if ( (GNUNET_YES == may_drop) &&
1599 (GNUNET_YES != tc->send_payload) )
1600 continue; /* skip, this client does not care about payload */
1601 unicast (tc, msg, may_drop);
1607 * Send the given message to a particular client
1609 * @param client target of the message
1610 * @param msg message to transmit
1611 * @param may_drop #GNUNET_YES if the message can be dropped
1614 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
1615 const struct GNUNET_MessageHeader *msg,
1618 struct TransportClient *tc;
1620 tc = lookup_client (client);
1622 return; /* client got disconnected in the meantime, drop message */
1623 unicast (tc, msg, may_drop);
1628 * Broadcast the new active address to all clients monitoring the peer.
1630 * @param peer peer this update is about (never NULL)
1631 * @param address address, NULL on disconnect
1632 * @param state the current state of the peer
1633 * @param state_timeout the time out for the state
1636 GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer,
1637 const struct GNUNET_HELLO_Address *address,
1638 enum GNUNET_TRANSPORT_PeerState state,
1639 struct GNUNET_TIME_Absolute state_timeout)
1641 struct PeerIterateResponseMessage *msg;
1642 struct MonitoringClient *mc;
1644 msg = compose_address_iterate_response_message (peer, address);
1645 msg->state = htonl (state);
1646 msg->state_timeout = GNUNET_TIME_absolute_hton (state_timeout);
1647 for (mc = peer_monitoring_clients_head; NULL != mc; mc = mc->next)
1648 if ((0 == memcmp (&mc->peer, &all_zeros,
1649 sizeof (struct GNUNET_PeerIdentity))) ||
1650 (0 == memcmp (&mc->peer, peer,
1651 sizeof (struct GNUNET_PeerIdentity))))
1652 GNUNET_SERVER_notification_context_unicast (peer_nc,
1661 * Broadcast the new validation changes to all clients monitoring the peer.
1663 * @param peer peer this update is about (never NULL)
1664 * @param address address, NULL on disconnect
1665 * @param last_validation point in time when last validation was performed
1666 * @param valid_until point in time how long address is valid
1667 * @param next_validation point in time when next validation will be performed
1668 * @param state state of validation notification
1671 GST_clients_broadcast_validation_notification (const struct GNUNET_PeerIdentity *peer,
1672 const struct GNUNET_HELLO_Address *address,
1673 struct GNUNET_TIME_Absolute last_validation,
1674 struct GNUNET_TIME_Absolute valid_until,
1675 struct GNUNET_TIME_Absolute next_validation,
1676 enum GNUNET_TRANSPORT_ValidationState state)
1678 struct ValidationIterateResponseMessage *msg;
1679 struct MonitoringClient *mc;
1681 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1682 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1684 (address != NULL) ? GST_plugins_a2s (address) : "<none>");
1685 msg = compose_validation_iterate_response_message (peer, address);
1686 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1687 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1688 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1689 msg->state = htonl ((uint32_t) state);
1690 for (mc = val_monitoring_clients_head; NULL != mc; mc = mc->next)
1691 if ((0 == memcmp (&mc->peer, &all_zeros,
1692 sizeof (struct GNUNET_PeerIdentity))) ||
1693 (0 == memcmp (&mc->peer, peer,
1694 sizeof (struct GNUNET_PeerIdentity))))
1695 GNUNET_SERVER_notification_context_unicast (val_nc,
1703 /* end of file gnunet-service-transport_clients.c */