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 client server's client handle to look up
266 * @return handle to the monitoring client
268 static struct MonitoringClient *
269 lookup_monitoring_client (struct MonitoringClient *head,
270 struct GNUNET_SERVER_Client *client)
272 struct MonitoringClient *mc;
274 for (mc = head; NULL != mc; mc = mc->next)
275 if (mc->client == client)
282 * Setup a new monitoring client using the given server client handle and
285 * @param client server's client handle to create our internal handle for
286 * @param peer identity of the peer to monitor the addresses of,
287 * zero to monitor all neighrours.
288 * @return handle to the new monitoring client
290 static struct MonitoringClient *
291 setup_peer_monitoring_client (struct GNUNET_SERVER_Client *client,
292 struct GNUNET_PeerIdentity *peer)
294 struct MonitoringClient *mc;
295 static struct GNUNET_PeerIdentity all_zeros;
297 GNUNET_assert (lookup_monitoring_client (peer_monitoring_clients_head, client) == NULL);
298 mc = GNUNET_new (struct MonitoringClient);
301 GNUNET_CONTAINER_DLL_insert (peer_monitoring_clients_head, peer_monitoring_clients_tail, mc);
302 GNUNET_SERVER_notification_context_add (peer_nc, client);
304 if (0 != memcmp (peer, &all_zeros, sizeof (struct GNUNET_PeerIdentity)))
305 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
306 "Client %p started monitoring of the peer `%s'\n",
307 mc, GNUNET_i2s (peer));
309 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
310 "Client %p started monitoring all peers\n", mc);
315 * Setup a new monitoring client using the given server client handle and
318 * @param client server's client handle to create our internal handle for
319 * @param peer identity of the peer to monitor the addresses of,
320 * zero to monitor all neighrours.
321 * @return handle to the new monitoring client
323 static struct MonitoringClient *
324 setup_val_monitoring_client (struct GNUNET_SERVER_Client *client,
325 struct GNUNET_PeerIdentity *peer)
327 struct MonitoringClient *mc;
328 static struct GNUNET_PeerIdentity all_zeros;
330 GNUNET_assert (lookup_monitoring_client (val_monitoring_clients_head, client) == NULL);
331 mc = GNUNET_new (struct MonitoringClient);
334 GNUNET_CONTAINER_DLL_insert (val_monitoring_clients_head, val_monitoring_clients_tail, mc);
335 GNUNET_SERVER_notification_context_add (val_nc, client);
337 if (0 != memcmp (peer, &all_zeros, sizeof (struct GNUNET_PeerIdentity)))
338 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
339 "Client %p started monitoring of the peer `%s'\n",
340 mc, GNUNET_i2s (peer));
342 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
343 "Client %p started monitoring all peers\n", mc);
349 * Function called to notify a client about the socket being ready to
350 * queue more data. "buf" will be NULL and "size" zero if the socket
351 * was closed for writing in the meantime.
354 * @param size number of bytes available in @a buf
355 * @param buf where the callee should write the message
356 * @return number of bytes written to @a buf
359 transmit_to_client_callback (void *cls, size_t size, void *buf)
361 struct TransportClient *tc = cls;
362 struct ClientMessageQueueEntry *q;
363 const struct GNUNET_MessageHeader *msg;
371 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
372 "Transmission to client failed, closing connection.\n");
377 while (NULL != (q = tc->message_queue_head))
379 msg = (const struct GNUNET_MessageHeader *) &q[1];
380 msize = ntohs (msg->size);
381 if (msize + tsize > size)
383 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
384 "Transmitting message of type %u to client %p.\n",
385 ntohs (msg->type), tc);
386 GNUNET_CONTAINER_DLL_remove (tc->message_queue_head,
387 tc->message_queue_tail,
390 memcpy (&cbuf[tsize], msg, msize);
396 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
398 GNUNET_SERVER_notify_transmit_ready (tc->client, msize,
399 GNUNET_TIME_UNIT_FOREVER_REL,
400 &transmit_to_client_callback, tc);
401 GNUNET_assert (NULL != tc->th);
408 * Queue the given message for transmission to the given client
410 * @param tc target of the message
411 * @param msg message to transmit
412 * @param may_drop #GNUNET_YES if the message can be dropped
415 unicast (struct TransportClient *tc,
416 const struct GNUNET_MessageHeader *msg,
419 struct ClientMessageQueueEntry *q;
428 if ((tc->message_count >= MAX_PENDING) && (GNUNET_YES == may_drop))
430 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
431 _("Dropping message of type %u and size %u, have %u/%u messages pending\n"),
436 GNUNET_STATISTICS_update (GST_stats,
438 ("# messages dropped due to slow client"), 1,
442 msize = ntohs (msg->size);
443 GNUNET_assert (msize >= sizeof (struct GNUNET_MessageHeader));
444 q = GNUNET_malloc (sizeof (struct ClientMessageQueueEntry) + msize);
445 memcpy (&q[1], msg, msize);
446 GNUNET_CONTAINER_DLL_insert_tail (tc->message_queue_head,
447 tc->message_queue_tail, q);
452 GNUNET_SERVER_notify_transmit_ready (tc->client, msize,
453 GNUNET_TIME_UNIT_FOREVER_REL,
454 &transmit_to_client_callback, tc);
455 GNUNET_assert (NULL != tc->th);
460 * Called whenever a client is disconnected. Frees our
461 * resources associated with that client.
464 * @param client identification of the client
467 client_disconnect_notification (void *cls, struct GNUNET_SERVER_Client *client)
469 struct TransportClient *tc;
470 struct MonitoringClient *mc;
471 struct ClientMessageQueueEntry *mqe;
475 mc = lookup_monitoring_client (peer_monitoring_clients_head, client);
478 GNUNET_CONTAINER_DLL_remove (peer_monitoring_clients_head,
479 peer_monitoring_clients_tail,
483 mc = lookup_monitoring_client (val_monitoring_clients_head, client);
486 GNUNET_CONTAINER_DLL_remove (val_monitoring_clients_head,
487 val_monitoring_clients_tail,
491 tc = lookup_client (client);
494 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
495 "Client %p disconnected, cleaning up.\n", tc);
496 while (NULL != (mqe = tc->message_queue_head))
498 GNUNET_CONTAINER_DLL_remove (tc->message_queue_head, tc->message_queue_tail,
503 GNUNET_CONTAINER_DLL_remove (clients_head, clients_tail, tc);
506 GNUNET_SERVER_notify_transmit_ready_cancel (tc->th);
509 GNUNET_break (0 == tc->message_count);
515 * Function called for each of our connected neighbours. Notify the
516 * client about the existing neighbour.
518 * @param cls the `struct TransportClient *` to notify
519 * @param peer identity of the neighbour
520 * @param address the address
521 * @param state the current state of the peer
522 * @param state_timeout the time out for the state
523 * @param bandwidth_in inbound bandwidth in NBO
524 * @param bandwidth_out outbound bandwidth in NBO
527 notify_client_about_neighbour (void *cls,
528 const struct GNUNET_PeerIdentity *peer,
529 const struct GNUNET_HELLO_Address *address,
530 enum GNUNET_TRANSPORT_PeerState state,
531 struct GNUNET_TIME_Absolute state_timeout,
532 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
533 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
535 struct TransportClient *tc = cls;
536 struct ConnectInfoMessage *cim;
537 size_t size = sizeof (struct ConnectInfoMessage);
538 char buf[size] GNUNET_ALIGN;
540 if (GNUNET_NO == GST_neighbours_test_connected (peer))
543 GNUNET_assert (size < GNUNET_SERVER_MAX_MESSAGE_SIZE);
544 cim = (struct ConnectInfoMessage *) buf;
545 cim->header.size = htons (size);
546 cim->header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT);
548 cim->quota_in = bandwidth_in;
549 cim->quota_out = bandwidth_out;
550 unicast (tc, &cim->header, GNUNET_NO);
555 * Initialize a normal client. We got a start message from this
556 * client, add him to the list of clients for broadcasting of inbound
560 * @param client the client
561 * @param message the start message that was sent
564 clients_handle_start (void *cls, struct GNUNET_SERVER_Client *client,
565 const struct GNUNET_MessageHeader *message)
567 const struct StartMessage *start;
568 struct TransportClient *tc;
571 tc = lookup_client (client);
573 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
574 "Client %p sent START\n", tc);
577 /* got 'start' twice from the same client, not allowed */
578 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
579 "TransportClient %p ServerClient %p sent multiple START messages\n",
582 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
585 start = (const struct StartMessage *) message;
586 options = ntohl (start->options);
587 if ((0 != (1 & options)) &&
589 memcmp (&start->self, &GST_my_identity,
590 sizeof (struct GNUNET_PeerIdentity))))
592 /* client thinks this is a different peer, reject */
593 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
595 ("Rejecting control connection from peer `%s', which is not me!\n"),
596 GNUNET_i2s (&start->self));
597 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
600 tc = setup_client (client);
601 tc->send_payload = (0 != (2 & options));
602 unicast (tc, GST_hello_get (), GNUNET_NO);
603 GST_neighbours_iterate (¬ify_client_about_neighbour, tc);
604 GNUNET_CONTAINER_DLL_insert (clients_head, clients_tail, tc);
605 GNUNET_SERVER_receive_done (client, GNUNET_OK);
610 * Client sent us a HELLO. Process the request.
613 * @param client the client
614 * @param message the HELLO message
617 clients_handle_hello (void *cls, struct GNUNET_SERVER_Client *client,
618 const struct GNUNET_MessageHeader *message)
620 GST_validation_handle_hello (message);
621 GNUNET_SERVER_receive_done (client, GNUNET_OK);
626 * Closure for 'handle_send_transmit_continuation'
628 struct SendTransmitContinuationContext
631 * Client that made the request.
633 struct GNUNET_SERVER_Client *client;
636 * Peer that was the target.
638 struct GNUNET_PeerIdentity target;
643 * Function called after the transmission is done. Notify the client that it is
644 * OK to send the next message.
647 * @param success #GNUNET_OK on success, #GNUNET_NO on failure, #GNUNET_SYSERR if we're not connected
648 * @param bytes_payload bytes payload sent
649 * @param bytes_on_wire bytes sent on wire
652 handle_send_transmit_continuation (void *cls, int success,
653 size_t bytes_payload,
654 size_t bytes_on_wire)
656 struct SendTransmitContinuationContext *stcc = cls;
657 struct SendOkMessage send_ok_msg;
659 if (GNUNET_OK == success)
660 GST_neighbours_notify_payload_sent (&stcc->target, bytes_payload);
662 send_ok_msg.header.size = htons (sizeof (send_ok_msg));
663 send_ok_msg.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK);
664 send_ok_msg.bytes_msg = htonl (bytes_payload);
665 send_ok_msg.bytes_physical = htonl (bytes_on_wire);
666 send_ok_msg.success = htonl (success);
667 send_ok_msg.latency =
668 GNUNET_TIME_relative_hton (GNUNET_TIME_UNIT_FOREVER_REL);
669 send_ok_msg.peer = stcc->target;
670 GST_clients_unicast (stcc->client, &send_ok_msg.header, GNUNET_NO);
671 GNUNET_SERVER_client_drop (stcc->client);
677 * Client asked for transmission to a peer. Process the request.
680 * @param client the client
681 * @param message the send message that was sent
684 clients_handle_send (void *cls,
685 struct GNUNET_SERVER_Client *client,
686 const struct GNUNET_MessageHeader *message)
688 const struct OutboundMessage *obm;
689 const struct GNUNET_MessageHeader *obmm;
690 struct SendTransmitContinuationContext *stcc;
693 struct TransportClient *tc;
695 tc = lookup_client (client);
698 /* client asked for transmission before 'START' */
700 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
704 size = ntohs (message->size);
706 sizeof (struct OutboundMessage) + sizeof (struct GNUNET_MessageHeader))
709 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
712 obm = (const struct OutboundMessage *) message;
713 obmm = (const struct GNUNET_MessageHeader *) &obm[1];
714 msize = size - sizeof (struct OutboundMessage);
715 if (msize < sizeof (struct GNUNET_MessageHeader))
718 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
722 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
723 "Received `%s' request from client with target `%4s' and first message of type %u and total size %u\n",
725 GNUNET_i2s (&obm->peer),
728 if (GNUNET_NO == GST_neighbours_test_connected (&obm->peer))
730 /* not connected, not allowed to send; can happen due to asynchronous operations */
731 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
732 "Could not send message to peer `%s': not connected\n",
733 GNUNET_i2s (&obm->peer));
734 GNUNET_STATISTICS_update (GST_stats,
736 ("# bytes payload dropped (other peer was not connected)"),
738 GNUNET_SERVER_receive_done (client, GNUNET_OK);
741 GNUNET_SERVER_receive_done (client, GNUNET_OK);
742 stcc = GNUNET_new (struct SendTransmitContinuationContext);
743 stcc->target = obm->peer;
744 stcc->client = client;
745 GNUNET_SERVER_client_keep (client);
746 GST_manipulation_send (&obm->peer, obmm, msize,
747 GNUNET_TIME_relative_ntoh (obm->timeout),
748 &handle_send_transmit_continuation, stcc);
753 * Try to initiate a connection to the given peer if the blacklist
756 * @param cls closure (unused, NULL)
757 * @param peer identity of peer that was tested
758 * @param result #GNUNET_OK if the connection is allowed,
762 try_connect_if_allowed (void *cls,
763 const struct GNUNET_PeerIdentity *peer,
766 if (GNUNET_OK != result)
768 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
769 "Blacklist refuses connection attempt to peer `%s'\n",
771 return; /* not allowed */
773 GST_neighbours_try_connect (peer);
778 * Handle request connect message
780 * @param cls closure (always NULL)
781 * @param client identification of the client
782 * @param message the actual message
785 clients_handle_request_connect (void *cls, struct GNUNET_SERVER_Client *client,
786 const struct GNUNET_MessageHeader *message)
788 const struct TransportRequestConnectMessage *trcm =
789 (const struct TransportRequestConnectMessage *) message;
791 GNUNET_STATISTICS_update (GST_stats,
793 ("# REQUEST CONNECT messages received"), 1,
796 if (0 == memcmp (&trcm->peer, &GST_my_identity,
797 sizeof (struct GNUNET_PeerIdentity)))
800 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
801 "Received a request connect message myself `%s'\n",
802 GNUNET_i2s (&trcm->peer));
806 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
807 "Received a request connect message for peer `%s'\n",
808 GNUNET_i2s (&trcm->peer));
810 (void) GST_blacklist_test_allowed (&trcm->peer, NULL, &try_connect_if_allowed,
813 GNUNET_SERVER_receive_done (client, GNUNET_OK);
818 * Take the given address and append it to the set of results sent back to
821 * @param cls the transmission context used ('struct GNUNET_SERVER_TransmitContext*')
822 * @param buf text to transmit
825 transmit_address_to_client (void *cls, const char *buf)
827 struct AddressToStringContext *actx = cls;
830 GNUNET_SERVER_transmit_context_append_data (actx->tc, NULL, 0,
831 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
832 GNUNET_SERVER_transmit_context_run (actx->tc, GNUNET_TIME_UNIT_FOREVER_REL);
833 GNUNET_CONTAINER_DLL_remove (a2s_head, a2s_tail, actx);
837 GNUNET_SERVER_transmit_context_append_data (actx->tc, buf, strlen (buf) + 1,
838 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
843 * Client asked to resolve an address. Process the request.
846 * @param client the client
847 * @param message the resolution request
850 clients_handle_address_to_string (void *cls,
851 struct GNUNET_SERVER_Client *client,
852 const struct GNUNET_MessageHeader *message)
854 const struct AddressLookupMessage *alum;
855 struct GNUNET_TRANSPORT_PluginFunctions *papi;
856 const char *plugin_name;
858 uint32_t address_len;
860 struct GNUNET_SERVER_TransmitContext *tc;
861 struct AddressToStringContext *actx;
862 struct GNUNET_TIME_Relative rtimeout;
865 size = ntohs (message->size);
866 if (size < sizeof (struct AddressLookupMessage))
869 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
872 alum = (const struct AddressLookupMessage *) message;
873 address_len = ntohs (alum->addrlen);
874 if (size <= sizeof (struct AddressLookupMessage) + address_len)
877 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
880 address = (const char *) &alum[1];
881 plugin_name = (const char *) &address[address_len];
882 if ('\0' != plugin_name[size - sizeof (struct AddressLookupMessage) - address_len - 1])
885 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
888 rtimeout = GNUNET_TIME_relative_ntoh (alum->timeout);
889 numeric = ntohs (alum->numeric_only);
890 tc = GNUNET_SERVER_transmit_context_create (client);
891 papi = GST_plugins_printer_find (plugin_name);
894 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
895 GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY);
896 GNUNET_SERVER_transmit_context_run (tc, rtimeout);
899 actx = GNUNET_new (struct AddressToStringContext);
901 GNUNET_CONTAINER_DLL_insert (a2s_head, a2s_tail, actx);
902 GNUNET_SERVER_disable_receive_done_warning (client);
903 papi->address_pretty_printer (papi->cls, plugin_name, address, address_len,
904 numeric, rtimeout, &transmit_address_to_client,
910 * Compose #PeerIterateResponseMessage using the given peer and address.
912 * @param peer identity of the peer
913 * @param address the address, NULL on disconnect
914 * @return composed message
916 static struct PeerIterateResponseMessage *
917 compose_address_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
918 const struct GNUNET_HELLO_Address *address)
920 struct PeerIterateResponseMessage *msg;
926 GNUNET_assert (NULL != peer);
929 tlen = strlen (address->transport_name) + 1;
930 alen = address->address_length;
934 size = (sizeof (struct PeerIterateResponseMessage) + alen + tlen);
935 msg = GNUNET_malloc (size);
936 msg->header.size = htons (size);
938 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
939 msg->reserved = htonl (0);
941 msg->addrlen = htonl (alen);
942 msg->pluginlen = htonl (tlen);
946 msg->local_address_info = htonl((uint32_t) address->local_info);
947 addr = (char *) &msg[1];
948 memcpy (addr, address->address, alen);
949 memcpy (&addr[alen], address->transport_name, tlen);
955 * Compose #PeerIterateResponseMessage using the given peer and address.
957 * @param peer identity of the peer
958 * @param address the address, NULL on disconnect
959 * @return composed message
961 static struct ValidationIterateResponseMessage *
962 compose_validation_iterate_response_message (const struct GNUNET_PeerIdentity *peer,
963 const struct GNUNET_HELLO_Address *address)
965 struct ValidationIterateResponseMessage *msg;
971 GNUNET_assert (NULL != peer);
974 tlen = strlen (address->transport_name) + 1;
975 alen = address->address_length;
979 size = (sizeof (struct ValidationIterateResponseMessage) + alen + tlen);
980 msg = GNUNET_malloc (size);
981 msg->header.size = htons (size);
983 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE);
984 msg->reserved = htonl (0);
986 msg->addrlen = htonl (alen);
987 msg->pluginlen = htonl (tlen);
991 msg->local_address_info = htonl((uint32_t) address->local_info);
992 addr = (char *) &msg[1];
993 memcpy (addr, address->address, alen);
994 memcpy (&addr[alen], address->transport_name, tlen);
999 struct IterationContext
1001 struct GNUNET_SERVER_TransmitContext *tc;
1003 struct GNUNET_PeerIdentity id;
1009 * Output information of neighbours to the given client.
1011 * @param cls the 'struct PeerIterationContext'
1012 * @param peer identity of the neighbour
1013 * @param address the address
1014 * @param state current state this peer is in
1015 * @param state_timeout timeout for the current state of the peer
1016 * @param bandwidth_in inbound quota in NBO
1017 * @param bandwidth_out outbound quota in NBO
1020 send_validation_information (void *cls,
1021 const struct GNUNET_PeerIdentity *peer,
1022 const struct GNUNET_HELLO_Address *address,
1023 struct GNUNET_TIME_Absolute last_validation,
1024 struct GNUNET_TIME_Absolute valid_until,
1025 struct GNUNET_TIME_Absolute next_validation,
1026 enum GNUNET_TRANSPORT_ValidationState state)
1028 struct IterationContext *pc = cls;
1029 struct ValidationIterateResponseMessage *msg;
1031 if ( (GNUNET_YES == pc->all) ||
1032 (0 == memcmp (peer, &pc->id, sizeof (pc->id))) )
1034 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1035 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1036 GNUNET_i2s(peer), (address != NULL) ? GST_plugins_a2s (address) : "<none>");
1037 msg = compose_validation_iterate_response_message (peer, address);
1038 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1039 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1040 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1041 msg->state = htonl ((uint32_t) state);
1042 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1049 * Output information of neighbours to the given client.
1051 * @param cls the 'struct PeerIterationContext'
1052 * @param peer identity of the neighbour
1053 * @param address the address
1054 * @param state current state this peer is in
1055 * @param state_timeout timeout for the current state of the peer
1056 * @param bandwidth_in inbound quota in NBO
1057 * @param bandwidth_out outbound quota in NBO
1060 send_peer_information (void *cls,
1061 const struct GNUNET_PeerIdentity *peer,
1062 const struct GNUNET_HELLO_Address *address,
1063 enum GNUNET_TRANSPORT_PeerState state,
1064 struct GNUNET_TIME_Absolute state_timeout,
1065 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1066 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out)
1068 struct IterationContext *pc = cls;
1069 struct PeerIterateResponseMessage *msg;
1071 if ( (GNUNET_YES == pc->all) ||
1072 (0 == memcmp (peer, &pc->id, sizeof (pc->id))) )
1074 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1075 "Sending information about `%s' using address `%s' in state `%s'\n",
1077 (address != NULL) ? GST_plugins_a2s (address) : "<none>",
1078 GNUNET_TRANSPORT_ps2s (state));
1079 msg = compose_address_iterate_response_message (peer, address);
1080 msg->state = htonl (state);
1081 msg->state_timeout = GNUNET_TIME_absolute_hton(state_timeout);
1082 GNUNET_SERVER_transmit_context_append_message (pc->tc, &msg->header);
1090 * Client asked to obtain information about a specific or all peers
1091 * Process the request.
1094 * @param client the client
1095 * @param message the peer address information request
1098 clients_handle_monitor_peers (void *cls, struct GNUNET_SERVER_Client *client,
1099 const struct GNUNET_MessageHeader *message)
1101 static struct GNUNET_PeerIdentity all_zeros;
1102 struct GNUNET_SERVER_TransmitContext *tc;
1103 struct PeerMonitorMessage *msg;
1104 struct IterationContext pc;
1106 if (ntohs (message->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST)
1109 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1112 if (ntohs (message->size) != sizeof (struct PeerMonitorMessage))
1115 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1118 msg = (struct PeerMonitorMessage *) message;
1119 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1120 (NULL != lookup_monitoring_client (peer_monitoring_clients_head, client)) )
1122 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1123 "ServerClient %p tried to start monitoring twice\n",
1126 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1129 GNUNET_SERVER_disable_receive_done_warning (client);
1130 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1132 /* Send initial list */
1133 if (0 == memcmp (&msg->peer, &all_zeros, sizeof (struct GNUNET_PeerIdentity)))
1135 /* iterate over all neighbours */
1136 pc.all = GNUNET_YES;
1141 /* just return one neighbour */
1145 GST_neighbours_iterate (&send_peer_information, &pc);
1147 if (GNUNET_YES != ntohl (msg->one_shot))
1149 setup_peer_monitoring_client (client, &msg->peer);
1153 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
1154 GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE);
1157 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
1162 * Client asked to obtain information about a specific or all validation
1166 * @param client the client
1167 * @param message the peer address information request
1170 clients_handle_monitor_validation (void *cls, struct GNUNET_SERVER_Client *client,
1171 const struct GNUNET_MessageHeader *message)
1173 static struct GNUNET_PeerIdentity all_zeros;
1174 struct GNUNET_SERVER_TransmitContext *tc;
1175 struct PeerMonitorMessage *msg;
1176 struct IterationContext pc;
1178 if (ntohs (message->type) != GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST)
1181 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1184 if (ntohs (message->size) != sizeof (struct ValidationMonitorMessage))
1187 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1190 msg = (struct PeerMonitorMessage *) message;
1191 if ( (GNUNET_YES != ntohl (msg->one_shot)) &&
1192 (NULL != lookup_monitoring_client (val_monitoring_clients_head, client)) )
1194 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
1195 "ServerClient %p tried to start monitoring twice\n",
1198 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1201 GNUNET_SERVER_disable_receive_done_warning (client);
1202 pc.tc = tc = GNUNET_SERVER_transmit_context_create (client);
1204 /* Send initial list */
1205 if (0 == memcmp (&msg->peer, &all_zeros, sizeof (struct GNUNET_PeerIdentity)))
1207 /* iterate over all neighbours */
1208 pc.all = GNUNET_YES;
1213 /* just return one neighbour */
1218 GST_validation_iterate (&send_validation_information, &pc);
1220 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_PEER_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 active address 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 state the current state of the peer
1387 * @param state_timeout the time out for the state
1390 GST_clients_broadcast_validation_notification (
1391 const struct GNUNET_PeerIdentity *peer,
1392 const struct GNUNET_HELLO_Address *address,
1393 struct GNUNET_TIME_Absolute last_validation,
1394 struct GNUNET_TIME_Absolute valid_until,
1395 struct GNUNET_TIME_Absolute next_validation,
1396 enum GNUNET_TRANSPORT_ValidationState state)
1398 struct ValidationIterateResponseMessage *msg;
1399 struct MonitoringClient *mc;
1400 static struct GNUNET_PeerIdentity all_zeros;
1402 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1403 "Sending information about for validation entry for peer `%s' using address `%s'\n",
1404 GNUNET_i2s(peer), (address != NULL) ? GST_plugins_a2s (address) : "<none>");
1406 msg = compose_validation_iterate_response_message (peer, address);
1407 msg->last_validation = GNUNET_TIME_absolute_hton(last_validation);
1408 msg->valid_until = GNUNET_TIME_absolute_hton(valid_until);
1409 msg->next_validation = GNUNET_TIME_absolute_hton(next_validation);
1410 msg->state = htonl ((uint32_t) state);
1411 mc = val_monitoring_clients_head;
1414 if ((0 == memcmp (&mc->peer, &all_zeros,
1415 sizeof (struct GNUNET_PeerIdentity))) ||
1416 (0 == memcmp (&mc->peer, peer,
1417 sizeof (struct GNUNET_PeerIdentity))))
1419 GNUNET_SERVER_notification_context_unicast (val_nc, mc->client,
1420 &msg->header, GNUNET_NO);
1429 /* end of file gnunet-service-transport_clients.c */