2 This file is part of GNUnet.
3 (C) 2010-2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file transport/gnunet-service-transport_clients.c
23 * @brief plugin management API
24 * @author Christian Grothoff
27 #include "gnunet-service-transport_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?
121 * Context for address to string operations
123 struct AddressToStringContext
126 * This is a doubly-linked list.
128 struct AddressToStringContext *next;
131 * This is a doubly-linked list.
133 struct AddressToStringContext *prev;
136 * Transmission context
138 struct GNUNET_SERVER_TransmitContext* tc;
142 * Client monitoring changes of active addresses of our neighbours.
144 struct MonitoringClient
147 * This is a doubly-linked list.
149 struct MonitoringClient *next;
152 * This is a doubly-linked list.
154 struct MonitoringClient *prev;
157 * Handle to the client.
159 struct GNUNET_SERVER_Client *client;
162 * Peer identity to monitor the addresses of.
163 * Zero to monitor all neighrours.
165 struct GNUNET_PeerIdentity peer;
171 * Head of linked list of all clients to this service.
173 static struct TransportClient *clients_head;
176 * Tail of linked list of all clients to this service.
178 static struct TransportClient *clients_tail;
181 * Head of linked list of all pending address iterations
183 struct AddressToStringContext *a2s_head;
186 * Tail of linked list of all pending address iterations
188 struct AddressToStringContext *a2s_tail;
191 * Head of linked list of monitoring clients.
193 static struct MonitoringClient *peer_monitoring_clients_head;
196 * Tail of linked list of monitoring clients.
198 static struct MonitoringClient *peer_monitoring_clients_tail;
201 * Head of linked list of validation monitoring clients.
203 static struct MonitoringClient *val_monitoring_clients_head;
206 * Tail of linked list of validation monitoring clients.
208 static struct MonitoringClient *val_monitoring_clients_tail;
211 * Notification context, to send updates on changes to active addresses
214 static struct GNUNET_SERVER_NotificationContext *peer_nc;
217 * Notification context, to send updates on changes to active addresses
220 static struct GNUNET_SERVER_NotificationContext *val_nc;
223 * Find the internal handle associated with the given client handle
225 * @param client server's client handle to look up
226 * @return internal client handle
228 static struct TransportClient *
229 lookup_client (struct GNUNET_SERVER_Client *client)
231 struct TransportClient *tc;
233 for (tc = clients_head; NULL != tc; tc = tc->next)
234 if (tc->client == client)
241 * Create the internal handle for the given server client handle
243 * @param client server's client handle to create our internal handle for
244 * @return fresh internal client handle
246 static struct TransportClient *
247 setup_client (struct GNUNET_SERVER_Client *client)
249 struct TransportClient *tc;
251 GNUNET_assert (NULL == lookup_client (client));
252 tc = GNUNET_new (struct TransportClient);
254 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
255 "Client %p connected\n",
262 * Find the handle to the monitoring client associated with the given
265 * @param head the head of the client queue to look in
266 * @param client server's client handle to look up
267 * @return handle to the monitoring client
269 static struct MonitoringClient *
270 lookup_monitoring_client (struct MonitoringClient *head,
271 struct GNUNET_SERVER_Client *client)
273 struct MonitoringClient *mc;
275 for (mc = head; NULL != mc; mc = mc->next)
276 if (mc->client == client)
283 * Setup a new monitoring client using the given server client handle and
286 * @param client server's client handle to create our internal handle for
287 * @param peer identity of the peer to monitor the addresses of,
288 * zero to monitor all neighrours.
289 * @return handle to the new monitoring client
291 static struct MonitoringClient *
292 setup_peer_monitoring_client (struct GNUNET_SERVER_Client *client,
293 struct GNUNET_PeerIdentity *peer)
295 struct MonitoringClient *mc;
296 static struct GNUNET_PeerIdentity all_zeros;
298 GNUNET_assert (lookup_monitoring_client (peer_monitoring_clients_head, client) == NULL);
299 mc = GNUNET_new (struct MonitoringClient);
302 GNUNET_CONTAINER_DLL_insert (peer_monitoring_clients_head, peer_monitoring_clients_tail, mc);
303 GNUNET_SERVER_notification_context_add (peer_nc, client);
305 if (0 != memcmp (peer, &all_zeros, sizeof (struct GNUNET_PeerIdentity)))
306 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
307 "Client %p started monitoring of the peer `%s'\n",
308 mc, GNUNET_i2s (peer));
310 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
311 "Client %p started monitoring all peers\n", mc);
316 * Setup a new monitoring client using the given server client handle and
319 * @param client server's client handle to create our internal handle for
320 * @param peer identity of the peer to monitor the addresses of,
321 * zero to monitor all neighrours.
322 * @return handle to the new monitoring client
324 static struct MonitoringClient *
325 setup_val_monitoring_client (struct GNUNET_SERVER_Client *client,
326 struct GNUNET_PeerIdentity *peer)
328 struct MonitoringClient *mc;
329 static struct GNUNET_PeerIdentity all_zeros;
331 GNUNET_assert (lookup_monitoring_client (val_monitoring_clients_head, client) == NULL);
332 mc = GNUNET_new (struct MonitoringClient);
335 GNUNET_CONTAINER_DLL_insert (val_monitoring_clients_head, val_monitoring_clients_tail, mc);
336 GNUNET_SERVER_notification_context_add (val_nc, client);
338 if (0 != memcmp (peer, &all_zeros, sizeof (struct GNUNET_PeerIdentity)))
339 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
340 "Client %p started monitoring of the peer `%s'\n",
341 mc, GNUNET_i2s (peer));
343 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
344 "Client %p started monitoring all peers\n", mc);
350 * Function called to notify a client about the socket being ready to
351 * queue more data. "buf" will be NULL and "size" zero if the socket
352 * was closed for writing in the meantime.
355 * @param size number of bytes available in @a buf
356 * @param buf where the callee should write the message
357 * @return number of bytes written to @a buf
360 transmit_to_client_callback (void *cls, size_t size, void *buf)
362 struct TransportClient *tc = cls;
363 struct ClientMessageQueueEntry *q;
364 const struct GNUNET_MessageHeader *msg;
372 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
373 "Transmission to client failed, closing connection.\n");
378 while (NULL != (q = tc->message_queue_head))
380 msg = (const struct GNUNET_MessageHeader *) &q[1];
381 msize = ntohs (msg->size);
382 if (msize + tsize > size)
384 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
385 "Transmitting message of type %u to client %p.\n",
386 ntohs (msg->type), tc);
387 GNUNET_CONTAINER_DLL_remove (tc->message_queue_head,
388 tc->message_queue_tail,
391 memcpy (&cbuf[tsize], msg, msize);
397 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
399 GNUNET_SERVER_notify_transmit_ready (tc->client, msize,
400 GNUNET_TIME_UNIT_FOREVER_REL,
401 &transmit_to_client_callback, tc);
402 GNUNET_assert (NULL != tc->th);
409 * Queue the given message for transmission to the given client
411 * @param tc target of the message
412 * @param msg message to transmit
413 * @param may_drop #GNUNET_YES if the message can be dropped
416 unicast (struct TransportClient *tc,
417 const struct GNUNET_MessageHeader *msg,
420 struct ClientMessageQueueEntry *q;
429 if ((tc->message_count >= MAX_PENDING) && (GNUNET_YES == may_drop))
431 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
432 _("Dropping message of type %u and size %u, have %u/%u messages pending\n"),
437 GNUNET_STATISTICS_update (GST_stats,
439 ("# messages dropped due to slow client"), 1,
443 msize = ntohs (msg->size);
444 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
445 q = GNUNET_malloc (sizeof (struct ClientMessageQueueEntry) + msize);
446 memcpy (&q[1], msg, msize);
447 GNUNET_CONTAINER_DLL_insert_tail (tc->message_queue_head,
448 tc->message_queue_tail, q);
453 GNUNET_SERVER_notify_transmit_ready (tc->client, msize,
454 GNUNET_TIME_UNIT_FOREVER_REL,
455 &transmit_to_client_callback, tc);
456 GNUNET_assert (NULL != tc->th);
461 * Called whenever a client is disconnected. Frees our
462 * resources associated with that client.
465 * @param client identification of the client
468 client_disconnect_notification (void *cls, struct GNUNET_SERVER_Client *client)
470 struct TransportClient *tc;
471 struct MonitoringClient *mc;
472 struct ClientMessageQueueEntry *mqe;
476 mc = lookup_monitoring_client (peer_monitoring_clients_head, client);
479 GNUNET_CONTAINER_DLL_remove (peer_monitoring_clients_head,
480 peer_monitoring_clients_tail,
484 mc = lookup_monitoring_client (val_monitoring_clients_head, client);
487 GNUNET_CONTAINER_DLL_remove (val_monitoring_clients_head,
488 val_monitoring_clients_tail,
492 tc = lookup_client (client);
495 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
496 "Client %p disconnected, cleaning up.\n", tc);
497 while (NULL != (mqe = tc->message_queue_head))
499 GNUNET_CONTAINER_DLL_remove (tc->message_queue_head, tc->message_queue_tail,
504 GNUNET_CONTAINER_DLL_remove (clients_head, clients_tail, tc);
507 GNUNET_SERVER_notify_transmit_ready_cancel (tc->th);
510 GNUNET_break (0 == tc->message_count);
516 * Function called for each of our connected neighbours. Notify the
517 * client about the existing neighbour.
519 * @param cls the `struct TransportClient *` to notify
520 * @param peer identity of the neighbour
521 * @param address the address
522 * @param state the current state of the peer
523 * @param state_timeout the time out for the state
524 * @param bandwidth_in inbound bandwidth in NBO
525 * @param bandwidth_out outbound bandwidth in NBO
528 notify_client_about_neighbour (void *cls,
529 const struct GNUNET_PeerIdentity *peer,
530 const struct GNUNET_HELLO_Address *address,
531 enum GNUNET_TRANSPORT_PeerState state,
532 struct GNUNET_TIME_Absolute state_timeout,
533 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
534 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
536 struct TransportClient *tc = cls;
537 struct ConnectInfoMessage *cim;
538 size_t size = sizeof (struct ConnectInfoMessage);
539 char buf[size] GNUNET_ALIGN;
541 if (GNUNET_NO == GST_neighbours_test_connected (peer))
544 GNUNET_assert (size < GNUNET_SERVER_MAX_MESSAGE_SIZE);
545 cim = (struct ConnectInfoMessage *) buf;
546 cim->header.size = htons (size);
547 cim->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
549 cim->quota_in = bandwidth_in;
550 cim->quota_out = bandwidth_out;
551 unicast (tc, &cim->header, GNUNET_NO);
556 * Initialize a normal client. We got a start message from this
557 * client, add him to the list of clients for broadcasting of inbound
561 * @param client the client
562 * @param message the start message that was sent
565 clients_handle_start (void *cls, struct GNUNET_SERVER_Client *client,
566 const struct GNUNET_MessageHeader *message)
568 const struct StartMessage *start;
569 struct TransportClient *tc;
572 tc = lookup_client (client);
574 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
575 "Client %p sent START\n", tc);
578 /* got 'start' twice from the same client, not allowed */
579 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
580 "TransportClient %p ServerClient %p sent multiple START messages\n",
583 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
586 start = (const struct StartMessage *) message;
587 options = ntohl (start->options);
588 if ((0 != (1 & options)) &&
590 memcmp (&start->self, &GST_my_identity,
591 sizeof (struct GNUNET_PeerIdentity))))
593 /* client thinks this is a different peer, reject */
594 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
596 ("Rejecting control connection from peer `%s', which is not me!\n"),
597 GNUNET_i2s (&start->self));
598 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
601 tc = setup_client (client);
602 tc->send_payload = (0 != (2 & options));
603 unicast (tc, GST_hello_get (), GNUNET_NO);
604 GST_neighbours_iterate (¬ify_client_about_neighbour, tc);
605 GNUNET_CONTAINER_DLL_insert (clients_head, clients_tail, tc);
606 GNUNET_SERVER_receive_done (client, GNUNET_OK);
611 * Client sent us a HELLO. Process the request.
614 * @param client the client
615 * @param message the HELLO message
618 clients_handle_hello (void *cls, struct GNUNET_SERVER_Client *client,
619 const struct GNUNET_MessageHeader *message)
621 GST_validation_handle_hello (message);
622 GNUNET_SERVER_receive_done (client, GNUNET_OK);
627 * Closure for 'handle_send_transmit_continuation'
629 struct SendTransmitContinuationContext
632 * Client that made the request.
634 struct GNUNET_SERVER_Client *client;
637 * Peer that was the target.
639 struct GNUNET_PeerIdentity target;
644 * Function called after the transmission is done. Notify the client that it is
645 * OK to send the next message.
648 * @param success #GNUNET_OK on success, #GNUNET_NO on failure, #GNUNET_SYSERR if we're not connected
649 * @param bytes_payload bytes payload sent
650 * @param bytes_on_wire bytes sent on wire
653 handle_send_transmit_continuation (void *cls, int success,
654 size_t bytes_payload,
655 size_t bytes_on_wire)
657 struct SendTransmitContinuationContext *stcc = cls;
658 struct SendOkMessage send_ok_msg;
660 if (GNUNET_OK == success)
661 GST_neighbours_notify_payload_sent (&stcc->target, bytes_payload);
663 send_ok_msg.header.size = htons (sizeof (send_ok_msg));
664 send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
665 send_ok_msg.bytes_msg = htonl (bytes_payload);
666 send_ok_msg.bytes_physical = htonl (bytes_on_wire);
667 send_ok_msg.success = htonl (success);
668 send_ok_msg.latency =
669 GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_FOREVER_REL);
670 send_ok_msg.peer = stcc->target;
671 GST_clients_unicast (stcc->client, &send_ok_msg.header, GNUNET_NO);
672 GNUNET_SERVER_client_drop (stcc->client);
678 * Client asked for transmission to a peer. Process the request.
681 * @param client the client
682 * @param message the send message that was sent
685 clients_handle_send (void *cls,
686 struct GNUNET_SERVER_Client *client,
687 const struct GNUNET_MessageHeader *message)
689 const struct OutboundMessage *obm;
690 const struct GNUNET_MessageHeader *obmm;
691 struct SendTransmitContinuationContext *stcc;
694 struct TransportClient *tc;
696 tc = lookup_client (client);
699 /* client asked for transmission before 'START' */
701 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
705 size = ntohs (message->size);
707 sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
710 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
713 obm = (const struct OutboundMessage *) message;
714 obmm = (const struct GNUNET_MessageHeader *) &obm[1];
715 msize = size - sizeof (struct OutboundMessage);
716 if (msize < sizeof (struct GNUNET_MessageHeader))
719 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
723 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
724 "Received `%s' request from client with target `%4s' and first message of type %u and total size %u\n",
726 GNUNET_i2s (&obm->peer),
729 if (GNUNET_NO == GST_neighbours_test_connected (&obm->peer))
731 /* not connected, not allowed to send; can happen due to asynchronous operations */
732 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
733 "Could not send message to peer `%s': not connected\n",
734 GNUNET_i2s (&obm->peer));
735 GNUNET_STATISTICS_update (GST_stats,
737 ("# bytes payload dropped (other peer was not connected)"),
739 GNUNET_SERVER_receive_done (client, GNUNET_OK);
742 GNUNET_SERVER_receive_done (client, GNUNET_OK);
743 stcc = GNUNET_new (struct SendTransmitContinuationContext);
744 stcc->target = obm->peer;
745 stcc->client = client;
746 GNUNET_SERVER_client_keep (client);
747 GST_manipulation_send (&obm->peer, obmm, msize,
748 GNUNET_TIME_relative_ntoh (obm->timeout),
749 &handle_send_transmit_continuation, stcc);
754 * Try to initiate a connection to the given peer if the blacklist
757 * @param cls closure (unused, NULL)
758 * @param peer identity of peer that was tested
759 * @param result #GNUNET_OK if the connection is allowed,
763 try_connect_if_allowed (void *cls,
764 const struct GNUNET_PeerIdentity *peer,
767 if (GNUNET_OK != result)
769 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
770 "Blacklist refuses connection attempt to peer `%s'\n",
772 return; /* not allowed */
774 GST_neighbours_try_connect (peer);
779 * Handle request connect message
781 * @param cls closure (always NULL)
782 * @param client identification of the client
783 * @param message the actual message
786 clients_handle_request_connect (void *cls, struct GNUNET_SERVER_Client *client,
787 const struct GNUNET_MessageHeader *message)
789 const struct TransportRequestConnectMessage *trcm =
790 (const struct TransportRequestConnectMessage *) message;
792 GNUNET_STATISTICS_update (GST_stats,
794 ("# REQUEST CONNECT messages received"), 1,
797 if (0 == memcmp (&trcm->peer, &GST_my_identity,
798 sizeof (struct GNUNET_PeerIdentity)))
801 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
802 "Received a request connect message myself `%s'\n",
803 GNUNET_i2s (&trcm->peer));
807 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
808 "Received a request connect message for peer `%s'\n",
809 GNUNET_i2s (&trcm->peer));
811 (void) GST_blacklist_test_allowed (&trcm->peer, NULL, &try_connect_if_allowed,
814 GNUNET_SERVER_receive_done (client, GNUNET_OK);
819 * Take the given address and append it to the set of results sent back to
822 * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
823 * @param buf text to transmit
826 transmit_address_to_client (void *cls, const char *buf)
828 struct AddressToStringContext *actx = cls;
831 GNUNET_SERVER_transmit_context_append_data (actx->tc, NULL, 0,
832 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
833 GNUNET_SERVER_transmit_context_run (actx->tc, GNUNET_TIME_UNIT_FOREVER_REL);
834 GNUNET_CONTAINER_DLL_remove (a2s_head, a2s_tail, actx);
838 GNUNET_SERVER_transmit_context_append_data (actx->tc, buf, strlen (buf) + 1,
839 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
844 * Client asked to resolve an address. Process the request.
847 * @param client the client
848 * @param message the resolution request
851 clients_handle_address_to_string (void *cls,
852 struct GNUNET_SERVER_Client *client,
853 const struct GNUNET_MessageHeader *message)
855 const struct AddressLookupMessage *alum;
856 struct GNUNET_TRANSPORT_PluginFunctions *papi;
857 const char *plugin_name;
859 uint32_t address_len;
861 struct GNUNET_SERVER_TransmitContext *tc;
862 struct AddressToStringContext *actx;
863 struct GNUNET_TIME_Relative rtimeout;
866 size = ntohs (message->size);
867 if (size < sizeof (struct AddressLookupMessage))
870 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
873 alum = (const struct AddressLookupMessage *) message;
874 address_len = ntohs (alum->addrlen);
875 if (size <= sizeof (struct AddressLookupMessage) + address_len)
878 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
881 address = (const char *) &alum[1];
882 plugin_name = (const char *) &address[address_len];
883 if ('\0' != plugin_name[size - sizeof (struct AddressLookupMessage) - address_len - 1])
886 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
889 rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
890 numeric = ntohs (alum->numeric_only);
891 tc = GNUNET_SERVER_transmit_context_create (client);
892 papi = GST_plugins_printer_find (plugin_name);
895 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
896 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
897 GNUNET_SERVER_transmit_context_run (tc, rtimeout);
900 actx = GNUNET_new (struct AddressToStringContext);
902 GNUNET_CONTAINER_DLL_insert (a2s_head, a2s_tail, actx);
903 GNUNET_SERVER_disable_receive_done_warning (client);
904 papi->address_pretty_printer (papi->cls, plugin_name, address, address_len,
905 numeric, rtimeout, &transmit_address_to_client,
911 * Compose #PeerIterateResponseMessage using the given peer and address.
913 * @param peer identity of the peer
914 * @param address the address, NULL on disconnect
915 * @return composed message
917 static struct PeerIterateResponseMessage *
918 compose_address_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
919 const struct GNUNET_HELLO_Address *address)
921 struct PeerIterateResponseMessage *msg;
927 GNUNET_assert (NULL != peer);
930 tlen = strlen (address->transport_name) + 1;
931 alen = address->address_length;
935 size = (sizeof (struct PeerIterateResponseMessage) + alen + tlen);
936 msg = GNUNET_malloc (size);
937 msg->header.size = htons (size);
939 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
940 msg->reserved = htonl (0);
942 msg->addrlen = htonl (alen);
943 msg->pluginlen = htonl (tlen);
947 msg->local_address_info = htonl((uint32_t) address->local_info);
948 addr = (char *) &msg[1];
949 memcpy (addr, address->address, alen);
950 memcpy (&addr[alen], address->transport_name, tlen);
956 * Compose #PeerIterateResponseMessage using the given peer and address.
958 * @param peer identity of the peer
959 * @param address the address, NULL on disconnect
960 * @return composed message
962 static struct ValidationIterateResponseMessage *
963 compose_validation_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
964 const struct GNUNET_HELLO_Address *address)
966 struct ValidationIterateResponseMessage *msg;
972 GNUNET_assert (NULL != peer);
975 tlen = strlen (address->transport_name) + 1;
976 alen = address->address_length;
980 size = (sizeof (struct ValidationIterateResponseMessage) + alen + tlen);
981 msg = GNUNET_malloc (size);
982 msg->header.size = htons (size);
984 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
985 msg->reserved = htonl (0);
987 msg->addrlen = htonl (alen);
988 msg->pluginlen = htonl (tlen);
992 msg->local_address_info = htonl((uint32_t) address->local_info);
993 addr = (char *) &msg[1];
994 memcpy (addr, address->address, alen);
995 memcpy (&addr[alen], address->transport_name, tlen);
1000 struct IterationContext
1002 struct GNUNET_SERVER_TransmitContext *tc;
1004 struct GNUNET_PeerIdentity id;
1010 * Output information of validation entries to the given client.
1012 * @param cls the 'struct IterationContext'
1013 * @param peer identity of the neighbour
1014 * @param address the address
1015 * @param last_validation point in time when last validation was performed
1016 * @param valid_until point in time how long address is valid
1017 * @param next_validation point in time when next validation will be performed
1018 * @param state state of validation notification
1021 send_validation_information (void *cls,
1022 const struct GNUNET_PeerIdentity *peer,
1023 const struct GNUNET_HELLO_Address *address,
1024 struct GNUNET_TIME_Absolute last_validation,
1025 struct GNUNET_TIME_Absolute valid_until,
1026 struct GNUNET_TIME_Absolute next_validation,
1027 enum GNUNET_TRANSPORT_ValidationState state)
1029 struct IterationContext *pc = cls;
1030 struct ValidationIterateResponseMessage *msg;
1032 if ( (GNUNET_YES == pc->all) ||
1033 (0 == memcmp (peer, &pc->id, sizeof (pc->id))) )
1035 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1036 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1037 GNUNET_i2s(peer), (address != NULL) ? GST_plugins_a2s (address) : "<none>");
1038 msg = compose_validation_iterate_response_message (peer, address);
1039 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1040 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1041 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1042 msg->state = htonl ((uint32_t) state);
1043 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1050 * Output information of neighbours to the given client.
1052 * @param cls the 'struct PeerIterationContext'
1053 * @param peer identity of the neighbour
1054 * @param address the address
1055 * @param state current state this peer is in
1056 * @param state_timeout timeout for the current state of the peer
1057 * @param bandwidth_in inbound quota in NBO
1058 * @param bandwidth_out outbound quota in NBO
1061 send_peer_information (void *cls,
1062 const struct GNUNET_PeerIdentity *peer,
1063 const struct GNUNET_HELLO_Address *address,
1064 enum GNUNET_TRANSPORT_PeerState state,
1065 struct GNUNET_TIME_Absolute state_timeout,
1066 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1067 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
1069 struct IterationContext *pc = cls;
1070 struct PeerIterateResponseMessage *msg;
1072 if ( (GNUNET_YES == pc->all) ||
1073 (0 == memcmp (peer, &pc->id, sizeof (pc->id))) )
1075 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1076 "Sending information about `%s' using address `%s' in state `%s'\n",
1078 (address != NULL) ? GST_plugins_a2s (address) : "<none>",
1079 GNUNET_TRANSPORT_ps2s (state));
1080 msg = compose_address_iterate_response_message (peer, address);
1081 msg->state = htonl (state);
1082 msg->state_timeout = GNUNET_TIME_absolute_hton(state_timeout);
1083 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1091 * Client asked to obtain information about a specific or all peers
1092 * Process the request.
1095 * @param client the client
1096 * @param message the peer address information request
1099 clients_handle_monitor_peers (void *cls, struct GNUNET_SERVER_Client *client,
1100 const struct GNUNET_MessageHeader *message)
1102 static struct GNUNET_PeerIdentity all_zeros;
1103 struct GNUNET_SERVER_TransmitContext *tc;
1104 struct PeerMonitorMessage *msg;
1105 struct IterationContext pc;
1107 if (ntohs (message->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST)
1110 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1113 if (ntohs (message->size) != sizeof (struct PeerMonitorMessage))
1116 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1119 msg = (struct PeerMonitorMessage *) message;
1120 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1121 (NULL != lookup_monitoring_client (peer_monitoring_clients_head, client)) )
1123 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1124 "ServerClient %p tried to start monitoring twice\n",
1127 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1130 GNUNET_SERVER_disable_receive_done_warning (client);
1131 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1133 /* Send initial list */
1134 if (0 == memcmp (&msg->peer, &all_zeros, sizeof (struct GNUNET_PeerIdentity)))
1136 /* iterate over all neighbours */
1137 pc.all = GNUNET_YES;
1142 /* just return one neighbour */
1146 GST_neighbours_iterate (&send_peer_information, &pc);
1148 if (GNUNET_YES != ntohl (msg->one_shot))
1150 setup_peer_monitoring_client (client, &msg->peer);
1154 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
1155 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
1158 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1163 * Client asked to obtain information about a specific or all validation
1167 * @param client the client
1168 * @param message the peer address information request
1171 clients_handle_monitor_validation (void *cls, struct GNUNET_SERVER_Client *client,
1172 const struct GNUNET_MessageHeader *message)
1174 static struct GNUNET_PeerIdentity all_zeros;
1175 struct GNUNET_SERVER_TransmitContext *tc;
1176 struct PeerMonitorMessage *msg;
1177 struct IterationContext pc;
1179 if (ntohs (message->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST)
1182 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1185 if (ntohs (message->size) != sizeof (struct ValidationMonitorMessage))
1188 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1191 msg = (struct PeerMonitorMessage *) message;
1192 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1193 (NULL != lookup_monitoring_client (val_monitoring_clients_head, client)) )
1195 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1196 "ServerClient %p tried to start monitoring twice\n",
1199 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1202 GNUNET_SERVER_disable_receive_done_warning (client);
1203 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1205 /* Send initial list */
1206 if (0 == memcmp (&msg->peer, &all_zeros, sizeof (struct GNUNET_PeerIdentity)))
1208 /* iterate over all neighbours */
1209 pc.all = GNUNET_YES;
1214 /* just return one neighbour */
1219 GST_validation_iterate (&send_validation_information, &pc);
1221 if (GNUNET_YES != ntohl (msg->one_shot))
1223 setup_val_monitoring_client (client, &msg->peer);
1227 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
1228 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
1230 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1234 * Start handling requests from clients.
1236 * @param server server used to accept clients from.
1239 GST_clients_start (struct GNUNET_SERVER_Handle *server)
1241 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1242 {&clients_handle_start, NULL,
1243 GNUNET_MESSAGE_TYPE_TRANSPORT_START, sizeof (struct StartMessage)},
1244 {&clients_handle_hello, NULL,
1245 GNUNET_MESSAGE_TYPE_HELLO, 0},
1246 {&clients_handle_send, NULL,
1247 GNUNET_MESSAGE_TYPE_TRANSPORT_SEND, 0},
1248 {&clients_handle_request_connect, NULL,
1249 GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_CONNECT,
1250 sizeof (struct TransportRequestConnectMessage)},
1251 {&clients_handle_address_to_string, NULL,
1252 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING, 0},
1253 {&clients_handle_monitor_peers, NULL,
1254 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST,
1255 sizeof (struct PeerMonitorMessage)},
1256 {&clients_handle_monitor_validation, NULL,
1257 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST,
1258 sizeof (struct ValidationMonitorMessage)},
1259 {&GST_blacklist_handle_init, NULL,
1260 GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_INIT,
1261 sizeof (struct GNUNET_MessageHeader)},
1262 {&GST_blacklist_handle_reply, NULL,
1263 GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY,
1264 sizeof (struct BlacklistMessage)},
1265 {&GST_manipulation_set_metric, NULL,
1266 GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC, 0},
1269 peer_nc = GNUNET_SERVER_notification_context_create (server, 0);
1270 val_nc = GNUNET_SERVER_notification_context_create (server, 0);
1271 GNUNET_SERVER_add_handlers (server, handlers);
1272 GNUNET_SERVER_disconnect_notify (server, &client_disconnect_notification,
1278 * Stop processing clients.
1283 struct AddressToStringContext *cur;
1285 while (NULL != (cur = a2s_head))
1287 GNUNET_SERVER_transmit_context_destroy (cur->tc, GNUNET_NO);
1288 GNUNET_CONTAINER_DLL_remove (a2s_head, a2s_tail, cur);
1291 if (NULL != peer_nc)
1293 GNUNET_SERVER_notification_context_destroy (peer_nc);
1298 GNUNET_SERVER_notification_context_destroy (val_nc);
1305 * Broadcast the given message to all of our clients.
1307 * @param msg message to broadcast
1308 * @param may_drop #GNUNET_YES if the message can be dropped / is payload
1311 GST_clients_broadcast (const struct GNUNET_MessageHeader *msg, int may_drop)
1313 struct TransportClient *tc;
1315 for (tc = clients_head; NULL != tc; tc = tc->next)
1317 if ((GNUNET_YES == may_drop) && (GNUNET_YES != tc->send_payload))
1318 continue; /* skip, this client does not care about payload */
1319 unicast (tc, msg, may_drop);
1325 * Send the given message to a particular client
1327 * @param client target of the message
1328 * @param msg message to transmit
1329 * @param may_drop #GNUNET_YES if the message can be dropped
1332 GST_clients_unicast (struct GNUNET_SERVER_Client *client,
1333 const struct GNUNET_MessageHeader *msg, int may_drop)
1335 struct TransportClient *tc;
1337 tc = lookup_client (client);
1339 return; /* client got disconnected in the meantime, drop message */
1340 unicast (tc, msg, may_drop);
1345 * Broadcast the new active address to all clients monitoring the peer.
1347 * @param peer peer this update is about (never NULL)
1348 * @param address address, NULL on disconnect
1349 * @param state the current state of the peer
1350 * @param state_timeout the time out for the state
1353 GST_clients_broadcast_peer_notification (const struct GNUNET_PeerIdentity *peer,
1354 const struct GNUNET_HELLO_Address *address,
1355 enum GNUNET_TRANSPORT_PeerState state,
1356 struct GNUNET_TIME_Absolute state_timeout)
1358 struct PeerIterateResponseMessage *msg;
1359 struct MonitoringClient *mc;
1360 static struct GNUNET_PeerIdentity all_zeros;
1361 msg = compose_address_iterate_response_message (peer, address);
1362 msg->state = htonl (state);
1363 msg->state_timeout = GNUNET_TIME_absolute_hton (state_timeout);
1364 mc = peer_monitoring_clients_head;
1367 if ((0 == memcmp (&mc->peer, &all_zeros,
1368 sizeof (struct GNUNET_PeerIdentity))) ||
1369 (0 == memcmp (&mc->peer, peer,
1370 sizeof (struct GNUNET_PeerIdentity))))
1372 GNUNET_SERVER_notification_context_unicast (peer_nc, mc->client,
1373 &msg->header, GNUNET_NO);
1382 * Broadcast the new validation changes to all clients monitoring the peer.
1384 * @param peer peer this update is about (never NULL)
1385 * @param address address, NULL on disconnect
1386 * @param last_validation point in time when last validation was performed
1387 * @param valid_until point in time how long address is valid
1388 * @param next_validation point in time when next validation will be performed
1389 * @param state state of validation notification
1392 GST_clients_broadcast_validation_notification (
1393 const struct GNUNET_PeerIdentity *peer,
1394 const struct GNUNET_HELLO_Address *address,
1395 struct GNUNET_TIME_Absolute last_validation,
1396 struct GNUNET_TIME_Absolute valid_until,
1397 struct GNUNET_TIME_Absolute next_validation,
1398 enum GNUNET_TRANSPORT_ValidationState state)
1400 struct ValidationIterateResponseMessage *msg;
1401 struct MonitoringClient *mc;
1402 static struct GNUNET_PeerIdentity all_zeros;
1404 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1405 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1406 GNUNET_i2s(peer), (address != NULL) ? GST_plugins_a2s (address) : "<none>");
1408 msg = compose_validation_iterate_response_message (peer, address);
1409 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1410 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1411 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1412 msg->state = htonl ((uint32_t) state);
1413 mc = val_monitoring_clients_head;
1416 if ((0 == memcmp (&mc->peer, &all_zeros,
1417 sizeof (struct GNUNET_PeerIdentity))) ||
1418 (0 == memcmp (&mc->peer, peer,
1419 sizeof (struct GNUNET_PeerIdentity))))
1421 GNUNET_SERVER_notification_context_unicast (val_nc, mc->client,
1422 &msg->header, GNUNET_NO);
1431 /* end of file gnunet-service-transport_clients.c */