2 This file is part of GNUnet.
3 Copyright (C) 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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
23 #include "gnunet_util_lib.h"
25 #include "gnunet_statistics_service.h"
28 #include "cadet_protocol.h" /* GNUNET_CADET_Data is shared */
30 #include "gnunet-service-cadet_local.h"
31 #include "gnunet-service-cadet_channel.h"
34 #include "gnunet-service-cadet_tunnel.h"
35 #include "gnunet-service-cadet_peer.h"
37 #define LOG(level, ...) GNUNET_log_from(level,"cadet-loc",__VA_ARGS__)
39 /******************************************************************************/
40 /******************************** STRUCTS **********************************/
41 /******************************************************************************/
44 * Struct containing information about a client of the service
46 * TODO: add a list of 'waiting' ports
53 struct CadetClient *next;
58 struct CadetClient *prev;
61 * Tunnels that belong to this client, indexed by local id
63 struct GNUNET_CONTAINER_MultiHashMap32 *own_channels;
66 * Tunnels this client has accepted, indexed by incoming local id
68 struct GNUNET_CONTAINER_MultiHashMap32 *incoming_channels;
71 * Channel ID for the next incoming channel.
73 CADET_ChannelNumber next_chid;
76 * Handle to communicate with the client
78 struct GNUNET_SERVER_Client *handle;
81 * Ports that this client has declared interest in.
82 * Indexed by port, contains *Client.
84 struct GNUNET_CONTAINER_MultiHashMap32 *ports;
87 * Whether the client is active or shutting down (don't send confirmations
88 * to a client that is shutting down.
93 * ID of the client, mainly for debug messages
98 /******************************************************************************/
99 /******************************* GLOBALS ***********************************/
100 /******************************************************************************/
103 * Global handle to the statistics service.
105 extern struct GNUNET_STATISTICS_Handle *stats;
108 * Handle to server lib.
110 static struct GNUNET_SERVER_Handle *server_handle;
113 * DLL with all the clients, head.
115 static struct CadetClient *clients_head;
118 * DLL with all the clients, tail.
120 static struct CadetClient *clients_tail;
123 * Next ID to assign to a client.
125 unsigned int next_client_id;
128 * All ports clients of this peer have opened.
130 static struct GNUNET_CONTAINER_MultiHashMap32 *ports;
133 * Notification context, to send messages to local clients.
135 static struct GNUNET_SERVER_NotificationContext *nc;
138 /******************************************************************************/
139 /******************************** STATIC ***********************************/
140 /******************************************************************************/
143 * Remove client's ports from the global hashmap on disconnect.
145 * @param cls Closure (unused).
147 * @param value Client structure.
149 * @return GNUNET_OK, keep iterating.
152 client_release_ports (void *cls,
158 res = GNUNET_CONTAINER_multihashmap32_remove (ports, key, value);
159 if (GNUNET_YES != res)
162 LOG (GNUNET_ERROR_TYPE_WARNING,
163 "Port %u by client %p was not registered.\n",
171 * Iterator for deleting each channel whose client endpoint disconnected.
173 * @param cls Closure (client that has disconnected).
174 * @param key The local channel id (used to access the hashmap).
175 * @param value The value stored at the key (channel to destroy).
177 * @return GNUNET_OK, keep iterating.
180 channel_destroy_iterator (void *cls,
184 struct CadetChannel *ch = value;
185 struct CadetClient *c = cls;
187 LOG (GNUNET_ERROR_TYPE_DEBUG,
188 " Channel %s destroy, due to client %s shutdown.\n",
189 GCCH_2s (ch), GML_2s (c));
191 GCCH_handle_local_destroy (ch, c, key < GNUNET_CADET_LOCAL_CHANNEL_ID_SERV);
197 * Unregister data and free memory for a client.
199 * @param c Client to destroy. No longer valid after call.
202 client_destroy (struct CadetClient *c)
204 LOG (GNUNET_ERROR_TYPE_INFO, " client destroy: %p/%u\n", c, c->id);
205 GNUNET_SERVER_client_drop (c->handle);
206 c->shutting_down = GNUNET_YES;
208 if (NULL != c->own_channels)
210 GNUNET_CONTAINER_multihashmap32_iterate (c->own_channels,
211 &channel_destroy_iterator, c);
212 GNUNET_CONTAINER_multihashmap32_destroy (c->own_channels);
214 if (NULL != c->incoming_channels)
216 GNUNET_CONTAINER_multihashmap32_iterate (c->incoming_channels,
217 &channel_destroy_iterator, c);
218 GNUNET_CONTAINER_multihashmap32_destroy (c->incoming_channels);
220 if (NULL != c->ports)
222 GNUNET_CONTAINER_multihashmap32_iterate (c->ports,
223 &client_release_ports, c);
224 GNUNET_CONTAINER_multihashmap32_destroy (c->ports);
227 GNUNET_CONTAINER_DLL_remove (clients_head, clients_tail, c);
228 GNUNET_STATISTICS_update (stats, "# clients", -1, GNUNET_NO);
229 GNUNET_SERVER_client_set_user_context (c->handle, NULL);
234 * Create a client record, register data and initialize memory.
236 * @param client Client's handle.
238 static struct CadetClient *
239 client_new (struct GNUNET_SERVER_Client *client)
241 struct CadetClient *c;
243 GNUNET_SERVER_client_keep (client);
244 GNUNET_SERVER_notification_context_add (nc, client);
246 c = GNUNET_new (struct CadetClient);
248 c->id = next_client_id++; /* overflow not important: just for debug */
249 c->next_chid = GNUNET_CADET_LOCAL_CHANNEL_ID_SERV;
251 c->own_channels = GNUNET_CONTAINER_multihashmap32_create (32);
252 c->incoming_channels = GNUNET_CONTAINER_multihashmap32_create (32);
254 GNUNET_SERVER_client_set_user_context (client, c);
255 GNUNET_CONTAINER_DLL_insert (clients_head, clients_tail, c);
256 GNUNET_STATISTICS_update (stats, "# clients", +1, GNUNET_NO);
258 LOG (GNUNET_ERROR_TYPE_INFO, " client created: %p/%u\n", c, c->id);
264 /******************************************************************************/
265 /******************************** HANDLES ***********************************/
266 /******************************************************************************/
269 * Handler for client connection.
271 * @param cls Closure (unused).
272 * @param client Client handler.
275 handle_client_connect (void *cls, struct GNUNET_SERVER_Client *client)
277 LOG (GNUNET_ERROR_TYPE_INFO, "Client connected: %p\n", client);
281 (void) client_new (client);
286 * Handler for client disconnection
289 * @param client identification of the client; NULL
290 * for the last call when the server is destroyed
293 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
295 struct CadetClient *c;
297 LOG (GNUNET_ERROR_TYPE_INFO, "Client disconnected: %p\n", client);
299 c = GML_client_get (client);
302 LOG (GNUNET_ERROR_TYPE_DEBUG, "matching client found (%u, %p)\n",
308 LOG (GNUNET_ERROR_TYPE_DEBUG, " disconnecting client's context NULL\n");
315 * Handler for new clients
318 * @param client identification of the client
319 * @param message the actual message, which includes messages the client wants
322 handle_new_client (void *cls, struct GNUNET_SERVER_Client *client,
323 const struct GNUNET_MessageHeader *message)
325 struct GNUNET_CADET_ClientConnect *cc_msg;
326 struct CadetClient *c;
331 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
332 LOG (GNUNET_ERROR_TYPE_INFO, "new client registering %p\n", client);
334 /* Check data sanity */
335 size = ntohs (message->size);
336 if (size < sizeof (struct GNUNET_CADET_ClientConnect))
339 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
342 size -= sizeof (struct GNUNET_CADET_ClientConnect); /* Array size */
343 if (0 != (size % sizeof (uint32_t)))
346 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
349 size /= sizeof (uint32_t); /* Number of ports */
350 cc_msg = (struct GNUNET_CADET_ClientConnect *) message;
352 /* Retrieve client structure */
353 c = GNUNET_SERVER_client_get_user_context (client, struct CadetClient);
357 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
361 LOG (GNUNET_ERROR_TYPE_INFO, " client %u has %u ports\n", c-> id, size);
366 p = (uint32_t *) &cc_msg[1];
367 c->ports = GNUNET_CONTAINER_multihashmap32_create (size);
368 for (i = 0; i < size; i++)
371 LOG (GNUNET_ERROR_TYPE_INFO, " port: %u\n", u32);
373 /* store in client's hashmap */
374 GNUNET_CONTAINER_multihashmap32_put (c->ports, u32, c,
375 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
376 /* store in global hashmap */
377 /* FIXME only allow one client to have the port open,
378 * have a backup hashmap with waiting clients */
379 GNUNET_CONTAINER_multihashmap32_put (ports, u32, c,
380 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
384 GNUNET_SERVER_receive_done (client, GNUNET_OK);
385 LOG (GNUNET_ERROR_TYPE_DEBUG, "new regitering processed\n");
390 * Handler for requests of new tunnels
392 * @param cls Closure.
393 * @param client Identification of the client.
394 * @param message The actual message.
397 handle_channel_create (void *cls, struct GNUNET_SERVER_Client *client,
398 const struct GNUNET_MessageHeader *message)
400 struct CadetClient *c;
402 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
403 LOG (GNUNET_ERROR_TYPE_DEBUG, "new channel requested\n");
405 /* Sanity check for client registration */
406 if (NULL == (c = GML_client_get (client)))
409 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
412 LOG (GNUNET_ERROR_TYPE_DEBUG, " by client %u\n", c->id);
414 /* Message size sanity check */
415 if (sizeof (struct GNUNET_CADET_ChannelMessage) != ntohs (message->size))
418 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
423 GCCH_handle_local_create (c,
424 (struct GNUNET_CADET_ChannelMessage *) message))
426 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
430 GNUNET_SERVER_receive_done (client, GNUNET_OK);
436 * Handler for requests of deleting tunnels
439 * @param client identification of the client
440 * @param message the actual message
443 handle_channel_destroy (void *cls, struct GNUNET_SERVER_Client *client,
444 const struct GNUNET_MessageHeader *message)
446 struct GNUNET_CADET_ChannelMessage *msg;
447 struct CadetClient *c;
448 struct CadetChannel *ch;
449 CADET_ChannelNumber chid;
451 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a DESTROY CHANNEL from client!\n");
453 /* Sanity check for client registration */
454 if (NULL == (c = GML_client_get (client)))
457 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
460 LOG (GNUNET_ERROR_TYPE_DEBUG, " by client %u\n", c->id);
462 /* Message sanity check */
463 if (sizeof (struct GNUNET_CADET_ChannelMessage) != ntohs (message->size))
466 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
470 msg = (struct GNUNET_CADET_ChannelMessage *) message;
472 /* Retrieve tunnel */
473 chid = ntohl (msg->channel_id);
474 ch = GML_channel_get (c, chid);
476 LOG (GNUNET_ERROR_TYPE_INFO, "Client %u is destroying channel %X\n",
481 LOG (GNUNET_ERROR_TYPE_WARNING, " channel %X not found\n", chid);
482 GNUNET_STATISTICS_update (stats,
483 "# client destroy messages on unknown channel",
485 GNUNET_SERVER_receive_done (client, GNUNET_OK);
489 GCCH_handle_local_destroy (ch, c, chid < GNUNET_CADET_LOCAL_CHANNEL_ID_SERV);
491 GNUNET_SERVER_receive_done (client, GNUNET_OK);
497 * Handler for client traffic
500 * @param client identification of the client
501 * @param message the actual message
504 handle_data (void *cls, struct GNUNET_SERVER_Client *client,
505 const struct GNUNET_MessageHeader *message)
507 const struct GNUNET_MessageHeader *payload;
508 struct GNUNET_CADET_LocalData *msg;
509 struct CadetClient *c;
510 struct CadetChannel *ch;
511 CADET_ChannelNumber chid;
514 size_t payload_claimed_size;
517 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
518 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
519 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got data from a client\n");
521 /* Sanity check for client registration */
522 if (NULL == (c = GML_client_get (client)))
525 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
529 /* Sanity check for message size */
530 message_size = ntohs (message->size);
531 if (sizeof (struct GNUNET_CADET_LocalData)
532 + sizeof (struct GNUNET_MessageHeader) > message_size
533 || GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE < message_size)
536 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
540 /* Sanity check for payload size */
541 payload_size = message_size - sizeof (struct GNUNET_CADET_LocalData);
542 msg = (struct GNUNET_CADET_LocalData *) message;
543 payload = (struct GNUNET_MessageHeader *) &msg[1];
544 payload_claimed_size = ntohs (payload->size);
545 if (sizeof (struct GNUNET_MessageHeader) > payload_claimed_size
546 || GNUNET_CONSTANTS_MAX_CADET_MESSAGE_SIZE < payload_claimed_size
547 || payload_claimed_size > payload_size)
549 LOG (GNUNET_ERROR_TYPE_WARNING,
550 "client claims to send %u bytes in %u payload\n",
551 payload_claimed_size, payload_size);
553 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
557 chid = ntohl (msg->id);
558 LOG (GNUNET_ERROR_TYPE_DEBUG, " %u bytes (%u payload) by client %u\n",
559 payload_size, payload_claimed_size, c->id);
561 /* Channel exists? */
562 fwd = chid < GNUNET_CADET_LOCAL_CHANNEL_ID_SERV;
563 ch = GML_channel_get (c, chid);
566 GNUNET_STATISTICS_update (stats,
567 "# client data messages on unknown channel",
569 GNUNET_SERVER_receive_done (client, GNUNET_OK);
573 if (GNUNET_OK != GCCH_handle_local_data (ch, c, fwd, payload, payload_size))
575 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
579 LOG (GNUNET_ERROR_TYPE_DEBUG, "receive done OK\n");
580 GNUNET_SERVER_receive_done (client, GNUNET_OK);
587 * Handler for client's ACKs for payload traffic.
589 * @param cls Closure (unused).
590 * @param client Identification of the client.
591 * @param message The actual message.
594 handle_ack (void *cls, struct GNUNET_SERVER_Client *client,
595 const struct GNUNET_MessageHeader *message)
597 struct GNUNET_CADET_LocalAck *msg;
598 struct CadetChannel *ch;
599 struct CadetClient *c;
600 CADET_ChannelNumber chid;
603 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
604 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a local ACK\n");
606 /* Sanity check for client registration */
607 if (NULL == (c = GML_client_get (client)))
610 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
613 LOG (GNUNET_ERROR_TYPE_DEBUG, " by client %u\n", c->id);
615 msg = (struct GNUNET_CADET_LocalAck *) message;
617 /* Channel exists? */
618 chid = ntohl (msg->channel_id);
619 LOG (GNUNET_ERROR_TYPE_DEBUG, " on channel %X\n", chid);
620 ch = GML_channel_get (c, chid);
621 LOG (GNUNET_ERROR_TYPE_DEBUG, " -- ch %p\n", ch);
624 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %X unknown.\n", chid);
625 LOG (GNUNET_ERROR_TYPE_DEBUG, " for client %u.\n", c->id);
626 GNUNET_STATISTICS_update (stats,
627 "# client ack messages on unknown channel",
629 GNUNET_SERVER_receive_done (client, GNUNET_OK);
633 /* If client is root, the ACK is going FWD, therefore this is "BCK ACK". */
634 /* If client is dest, the ACK is going BCK, therefore this is "FWD ACK" */
635 fwd = chid >= GNUNET_CADET_LOCAL_CHANNEL_ID_SERV;
637 GCCH_handle_local_ack (ch, fwd);
638 GNUNET_SERVER_receive_done (client, GNUNET_OK);
645 * Iterator over all peers to send a monitoring client info about each peer.
647 * @param cls Closure ().
648 * @param peer Peer ID (tunnel remote peer).
649 * @param value Peer info.
651 * @return #GNUNET_YES, to keep iterating.
654 get_all_peers_iterator (void *cls,
655 const struct GNUNET_PeerIdentity * peer,
658 struct GNUNET_SERVER_Client *client = cls;
659 struct CadetPeer *p = value;
660 struct GNUNET_CADET_LocalInfoPeer msg;
662 msg.header.size = htons (sizeof (msg));
663 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
664 msg.destination = *peer;
665 msg.paths = htons (GCP_count_paths (p));
666 msg.tunnel = htons (NULL != GCP_get_tunnel (p));
668 LOG (GNUNET_ERROR_TYPE_DEBUG, "sending info about peer %s\n",
671 GNUNET_SERVER_notification_context_unicast (nc, client,
672 &msg.header, GNUNET_NO);
678 * Iterator over all peers to dump info for each peer.
680 * @param cls Closure (unused).
681 * @param peer Peer ID (tunnel remote peer).
682 * @param value Peer info.
684 * @return #GNUNET_YES, to keep iterating.
687 show_peer_iterator (void *cls,
688 const struct GNUNET_PeerIdentity * peer,
691 struct CadetPeer *p = value;
692 struct CadetTunnel *t;
694 GCP_debug (p, GNUNET_ERROR_TYPE_ERROR);
696 t = GCP_get_tunnel (p);
698 GCT_debug (t, GNUNET_ERROR_TYPE_ERROR);
700 LOG (GNUNET_ERROR_TYPE_ERROR, "\n");
707 * Iterator over all paths of a peer to build an InfoPeer message.
709 * Message contains blocks of peers, first not included.
711 * @param cls Closure (message to build).
712 * @param peer Peer this path is towards.
713 * @param path Path itself
714 * @return #GNUNET_YES if should keep iterating.
715 * #GNUNET_NO otherwise.
718 path_info_iterator (void *cls,
719 struct CadetPeer *peer,
720 struct CadetPeerPath *path)
722 struct GNUNET_CADET_LocalInfoPeer *resp = cls;
723 struct GNUNET_PeerIdentity *id;
728 msg_size = ntohs (resp->header.size);
729 path_size = sizeof (struct GNUNET_PeerIdentity) * (path->length - 1);
731 LOG (GNUNET_ERROR_TYPE_DEBUG, "Info Path %u\n", path->length);
732 if (msg_size + path_size > UINT16_MAX)
734 LOG (GNUNET_ERROR_TYPE_WARNING, "path too long for info message\n");
738 i = msg_size - sizeof (struct GNUNET_CADET_LocalInfoPeer);
739 i = i / sizeof (struct GNUNET_PeerIdentity);
741 /* Set id to the address of the first free peer slot. */
742 id = (struct GNUNET_PeerIdentity *) &resp[1];
745 /* Don't copy first peers.
746 * First peer is always the local one.
747 * Last peer is always the destination (leave as 0, EOL).
749 for (i = 0; i < path->length - 1; i++)
751 GNUNET_PEER_resolve (path->peers[i + 1], &id[i]);
752 LOG (GNUNET_ERROR_TYPE_DEBUG, " %s\n", GNUNET_i2s (&id[i]));
755 resp->header.size = htons (msg_size + path_size);
762 * Handler for client's INFO PEERS request.
764 * @param cls Closure (unused).
765 * @param client Identification of the client.
766 * @param message The actual message.
769 handle_get_peers (void *cls, struct GNUNET_SERVER_Client *client,
770 const struct GNUNET_MessageHeader *message)
772 struct CadetClient *c;
773 struct GNUNET_MessageHeader reply;
775 /* Sanity check for client registration */
776 if (NULL == (c = GML_client_get (client)))
779 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
783 LOG (GNUNET_ERROR_TYPE_DEBUG,
784 "Received get peers request from client %u (%p)\n",
787 GCP_iterate_all (get_all_peers_iterator, client);
788 reply.size = htons (sizeof (reply));
789 reply.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS);
790 GNUNET_SERVER_notification_context_unicast (nc, client, &reply, GNUNET_NO);
792 LOG (GNUNET_ERROR_TYPE_DEBUG,
793 "Get peers request from client %u completed\n", c->id);
794 GNUNET_SERVER_receive_done (client, GNUNET_OK);
799 * Handler for client's SHOW_PEER request.
801 * @param cls Closure (unused).
802 * @param client Identification of the client.
803 * @param message The actual message.
806 handle_show_peer (void *cls, struct GNUNET_SERVER_Client *client,
807 const struct GNUNET_MessageHeader *message)
809 const struct GNUNET_CADET_LocalInfo *msg;
810 struct GNUNET_CADET_LocalInfoPeer *resp;
812 struct CadetClient *c;
813 unsigned char cbuf[64 * 1024];
815 /* Sanity check for client registration */
816 if (NULL == (c = GML_client_get (client)))
819 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
823 msg = (struct GNUNET_CADET_LocalInfo *) message;
824 resp = (struct GNUNET_CADET_LocalInfoPeer *) cbuf;
825 LOG (GNUNET_ERROR_TYPE_INFO,
826 "Received peer info request from client %u for peer %s\n",
827 c->id, GNUNET_i2s_full (&msg->peer));
829 resp->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER);
830 resp->header.size = htons (sizeof (struct GNUNET_CADET_LocalInfoPeer));
831 resp->destination = msg->peer;
832 p = GCP_get (&msg->peer, GNUNET_NO);
835 /* We don't know the peer */
837 LOG (GNUNET_ERROR_TYPE_INFO, "Peer %s unknown\n",
838 GNUNET_i2s_full (&msg->peer));
839 resp->paths = htons (0);
840 resp->tunnel = htons (NULL != GCP_get_tunnel (p));
842 GNUNET_SERVER_notification_context_unicast (nc, client,
845 GNUNET_SERVER_receive_done (client, GNUNET_OK);
849 resp->paths = htons (GCP_count_paths (p));
850 resp->tunnel = htons (NULL != GCP_get_tunnel (p));
851 GCP_iterate_paths (p, &path_info_iterator, resp);
853 GNUNET_SERVER_notification_context_unicast (nc, c->handle,
854 &resp->header, GNUNET_NO);
856 LOG (GNUNET_ERROR_TYPE_INFO, "Show peer request from client %u completed.\n");
857 GNUNET_SERVER_receive_done (client, GNUNET_OK);
862 * Iterator over all tunnels to send a monitoring client info about each tunnel.
864 * @param cls Closure ().
865 * @param peer Peer ID (tunnel remote peer).
866 * @param value Tunnel info.
868 * @return #GNUNET_YES, to keep iterating.
871 get_all_tunnels_iterator (void *cls,
872 const struct GNUNET_PeerIdentity * peer,
875 struct GNUNET_SERVER_Client *client = cls;
876 struct CadetTunnel *t = value;
877 struct GNUNET_CADET_LocalInfoTunnel msg;
879 msg.header.size = htons (sizeof (msg));
880 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
881 msg.destination = *peer;
882 msg.channels = htonl (GCT_count_channels (t));
883 msg.connections = htonl (GCT_count_any_connections (t));
884 msg.cstate = htons ((uint16_t) GCT_get_cstate (t));
885 msg.estate = htons ((uint16_t) GCT_get_estate (t));
887 LOG (GNUNET_ERROR_TYPE_DEBUG, "sending info about tunnel ->%s\n",
890 GNUNET_SERVER_notification_context_unicast (nc, client,
891 &msg.header, GNUNET_NO);
897 * Handler for client's INFO TUNNELS request.
899 * @param cls Closure (unused).
900 * @param client Identification of the client.
901 * @param message The actual message.
904 handle_get_tunnels (void *cls, struct GNUNET_SERVER_Client *client,
905 const struct GNUNET_MessageHeader *message)
907 struct CadetClient *c;
908 struct GNUNET_MessageHeader reply;
910 /* Sanity check for client registration */
911 if (NULL == (c = GML_client_get (client)))
914 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
918 LOG (GNUNET_ERROR_TYPE_DEBUG,
919 "Received get tunnels request from client %u (%p)\n",
922 GCT_iterate_all (get_all_tunnels_iterator, client);
923 reply.size = htons (sizeof (reply));
924 reply.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS);
925 GNUNET_SERVER_notification_context_unicast (nc, client, &reply, GNUNET_NO);
927 LOG (GNUNET_ERROR_TYPE_DEBUG,
928 "Get tunnels request from client %u completed\n", c->id);
929 GNUNET_SERVER_receive_done (client, GNUNET_OK);
934 iter_connection (void *cls, struct CadetConnection *c)
936 struct GNUNET_CADET_LocalInfoTunnel *msg = cls;
937 struct GNUNET_CADET_Hash *h = (struct GNUNET_CADET_Hash *) &msg[1];
939 h[msg->connections] = *(GCC_get_id (c));
944 iter_channel (void *cls, struct CadetChannel *ch)
946 struct GNUNET_CADET_LocalInfoTunnel *msg = cls;
947 struct GNUNET_HashCode *h = (struct GNUNET_HashCode *) &msg[1];
948 CADET_ChannelNumber *chn = (CADET_ChannelNumber *) &h[msg->connections];
950 chn[msg->channels] = htonl (GCCH_get_id (ch));
956 * Handler for client's SHOW_TUNNEL request.
958 * @param cls Closure (unused).
959 * @param client Identification of the client.
960 * @param message The actual message.
963 handle_show_tunnel (void *cls, struct GNUNET_SERVER_Client *client,
964 const struct GNUNET_MessageHeader *message)
966 const struct GNUNET_CADET_LocalInfo *msg;
967 struct GNUNET_CADET_LocalInfoTunnel *resp;
968 struct CadetClient *c;
969 struct CadetTunnel *t;
974 /* Sanity check for client registration */
975 if (NULL == (c = GML_client_get (client)))
978 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
982 msg = (struct GNUNET_CADET_LocalInfo *) message;
983 LOG (GNUNET_ERROR_TYPE_DEBUG,
984 "Received tunnel info request from client %u for tunnel %s\n",
985 c->id, GNUNET_i2s_full(&msg->peer));
987 t = GCP_get_tunnel (GCP_get (&msg->peer, GNUNET_NO));
990 /* We don't know the tunnel */
991 struct GNUNET_CADET_LocalInfoTunnel warn;
993 LOG (GNUNET_ERROR_TYPE_INFO, "Tunnel %s unknown %u\n",
994 GNUNET_i2s_full(&msg->peer), sizeof (warn));
995 warn.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
996 warn.header.size = htons (sizeof (warn));
997 warn.destination = msg->peer;
998 warn.channels = htonl (0);
999 warn.connections = htonl (0);
1000 warn.cstate = htons (0);
1001 warn.estate = htons (0);
1003 GNUNET_SERVER_notification_context_unicast (nc, client,
1006 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1010 /* Initialize context */
1011 ch_n = GCT_count_channels (t);
1012 c_n = GCT_count_any_connections (t);
1014 size = sizeof (struct GNUNET_CADET_LocalInfoTunnel);
1015 size += c_n * sizeof (struct GNUNET_CADET_Hash);
1016 size += ch_n * sizeof (CADET_ChannelNumber);
1018 resp = GNUNET_malloc (size);
1019 resp->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL);
1020 resp->header.size = htons (size);
1021 GCT_iterate_connections (t, &iter_connection, resp);
1022 GCT_iterate_channels (t, &iter_channel, resp);
1023 /* Do not interleave with iterators, iter_channel needs conn in HBO */
1024 resp->destination = msg->peer;
1025 resp->connections = htonl (resp->connections);
1026 resp->channels = htonl (resp->channels);
1027 resp->cstate = htons (GCT_get_cstate (t));
1028 resp->estate = htons (GCT_get_estate (t));
1029 GNUNET_SERVER_notification_context_unicast (nc, c->handle,
1030 &resp->header, GNUNET_NO);
1033 LOG (GNUNET_ERROR_TYPE_DEBUG,
1034 "Show tunnel request from client %u completed. %u conn, %u ch\n",
1036 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1041 * Handler for client's INFO_DUMP request.
1043 * @param cls Closure (unused).
1044 * @param client Identification of the client.
1045 * @param message The actual message.
1048 handle_info_dump (void *cls, struct GNUNET_SERVER_Client *client,
1049 const struct GNUNET_MessageHeader *message)
1051 struct CadetClient *c;
1053 /* Sanity check for client registration */
1054 if (NULL == (c = GML_client_get (client)))
1057 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1061 LOG (GNUNET_ERROR_TYPE_INFO, "Received dump info request from client %u\n",
1063 LOG (GNUNET_ERROR_TYPE_ERROR,
1064 "*************************** DUMP START ***************************\n");
1066 for (c = clients_head; NULL != c; c = c->next)
1068 LOG (GNUNET_ERROR_TYPE_ERROR, "Client %u (%p), handle: %p\n",
1069 c->id, c, c->handle);
1070 if (NULL != c->ports)
1071 LOG (GNUNET_ERROR_TYPE_ERROR, "\t%3u ports registered\n",
1072 GNUNET_CONTAINER_multihashmap32_size (c->ports));
1074 LOG (GNUNET_ERROR_TYPE_ERROR, "\t no ports registered\n");
1075 LOG (GNUNET_ERROR_TYPE_ERROR, "\t%3u own channles\n",
1076 GNUNET_CONTAINER_multihashmap32_size (c->own_channels));
1077 LOG (GNUNET_ERROR_TYPE_ERROR, "\t%3u incoming channles\n",
1078 GNUNET_CONTAINER_multihashmap32_size (c->incoming_channels));
1080 LOG (GNUNET_ERROR_TYPE_ERROR, "***************************\n");
1081 GCP_iterate_all (&show_peer_iterator, NULL);
1083 LOG (GNUNET_ERROR_TYPE_ERROR,
1084 "**************************** DUMP END ****************************\n");
1086 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1091 * Functions to handle messages from clients
1093 static struct GNUNET_SERVER_MessageHandler client_handlers[] = {
1094 {&handle_new_client, NULL, GNUNET_MESSAGE_TYPE_CADET_LOCAL_CONNECT, 0},
1095 {&handle_channel_create, NULL, GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE,
1096 sizeof (struct GNUNET_CADET_ChannelMessage)},
1097 {&handle_channel_destroy, NULL, GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY,
1098 sizeof (struct GNUNET_CADET_ChannelMessage)},
1099 {&handle_data, NULL, GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA, 0},
1100 {&handle_ack, NULL, GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK,
1101 sizeof (struct GNUNET_CADET_LocalAck)},
1102 {&handle_get_peers, NULL, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEERS,
1103 sizeof (struct GNUNET_MessageHeader)},
1104 {&handle_show_peer, NULL, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_PEER,
1105 sizeof (struct GNUNET_CADET_LocalInfo)},
1106 {&handle_get_tunnels, NULL, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNELS,
1107 sizeof (struct GNUNET_MessageHeader)},
1108 {&handle_show_tunnel, NULL, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_TUNNEL,
1109 sizeof (struct GNUNET_CADET_LocalInfo)},
1110 {&handle_info_dump, NULL, GNUNET_MESSAGE_TYPE_CADET_LOCAL_INFO_DUMP,
1111 sizeof (struct GNUNET_MessageHeader)},
1117 /******************************************************************************/
1118 /******************************** API ***********************************/
1119 /******************************************************************************/
1122 * Initialize server subsystem.
1124 * @param handle Server handle.
1127 GML_init (struct GNUNET_SERVER_Handle *handle)
1129 LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1130 server_handle = handle;
1131 GNUNET_SERVER_suspend (server_handle);
1132 ports = GNUNET_CONTAINER_multihashmap32_create (32);
1137 * Install server (service) handlers and start listening to clients.
1142 GNUNET_SERVER_add_handlers (server_handle, client_handlers);
1143 GNUNET_SERVER_connect_notify (server_handle, &handle_client_connect, NULL);
1144 GNUNET_SERVER_disconnect_notify (server_handle, &handle_client_disconnect,
1146 nc = GNUNET_SERVER_notification_context_create (server_handle, 1);
1148 clients_head = NULL;
1149 clients_tail = NULL;
1151 GNUNET_SERVER_resume (server_handle);
1161 struct CadetClient *c;
1163 for (c = clients_head; NULL != clients_head; c = clients_head)
1168 GNUNET_SERVER_notification_context_destroy (nc);
1176 * Get a channel from a client.
1178 * @param c Client to check.
1179 * @param chid Channel ID, must be local (> 0x800...).
1181 * @return non-NULL if channel exists in the clients lists
1183 struct CadetChannel *
1184 GML_channel_get (struct CadetClient *c, CADET_ChannelNumber chid)
1186 struct GNUNET_CONTAINER_MultiHashMap32 *map;
1188 if (0 == (chid & GNUNET_CADET_LOCAL_CHANNEL_ID_CLI))
1190 GNUNET_break_op (0);
1191 LOG (GNUNET_ERROR_TYPE_DEBUG, "CHID %X not a local chid\n", chid);
1195 if (chid >= GNUNET_CADET_LOCAL_CHANNEL_ID_SERV)
1196 map = c->incoming_channels;
1197 else if (chid >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
1198 map = c->own_channels;
1207 LOG (GNUNET_ERROR_TYPE_DEBUG,
1208 "Client %s does no t have a valid map for CHID %X\n",
1212 return GNUNET_CONTAINER_multihashmap32_get (map, chid);
1217 * Add a channel to a client
1219 * @param client Client.
1220 * @param chid Channel ID.
1221 * @param ch Channel.
1224 GML_channel_add (struct CadetClient *client,
1226 struct CadetChannel *ch)
1228 if (chid >= GNUNET_CADET_LOCAL_CHANNEL_ID_SERV)
1229 GNUNET_CONTAINER_multihashmap32_put (client->incoming_channels, chid, ch,
1230 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
1231 else if (chid >= GNUNET_CADET_LOCAL_CHANNEL_ID_CLI)
1232 GNUNET_CONTAINER_multihashmap32_put (client->own_channels, chid, ch,
1233 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
1240 * Remove a channel from a client.
1242 * @param client Client.
1243 * @param chid Channel ID.
1244 * @param ch Channel.
1247 GML_channel_remove (struct CadetClient *client,
1249 struct CadetChannel *ch)
1251 if (GNUNET_CADET_LOCAL_CHANNEL_ID_SERV <= chid)
1252 GNUNET_break (GNUNET_YES ==
1253 GNUNET_CONTAINER_multihashmap32_remove (client->incoming_channels,
1255 else if (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI <= chid)
1256 GNUNET_break (GNUNET_YES ==
1257 GNUNET_CONTAINER_multihashmap32_remove (client->own_channels,
1265 * Get the tunnel's next free local channel ID.
1269 * @return LID of a channel free to use.
1272 GML_get_next_chid (struct CadetClient *c)
1274 CADET_ChannelNumber chid;
1276 while (NULL != GML_channel_get (c, c->next_chid))
1278 LOG (GNUNET_ERROR_TYPE_DEBUG, "Channel %u exists...\n", c->next_chid);
1279 c->next_chid = (c->next_chid + 1) | GNUNET_CADET_LOCAL_CHANNEL_ID_SERV;
1281 chid = c->next_chid;
1282 c->next_chid = (c->next_chid + 1) | GNUNET_CADET_LOCAL_CHANNEL_ID_SERV;
1289 * Check if client has registered with the service and has not disconnected
1291 * @param client the client to check
1293 * @return non-NULL if client exists in the global DLL
1295 struct CadetClient *
1296 GML_client_get (struct GNUNET_SERVER_Client *client)
1300 return GNUNET_SERVER_client_get_user_context (client, struct CadetClient);
1304 * Find a client that has opened a port
1306 * @param port Port to check.
1308 * @return non-NULL if a client has the port.
1310 struct CadetClient *
1311 GML_client_get_by_port (uint32_t port)
1313 return GNUNET_CONTAINER_multihashmap32_get (ports, port);
1318 * Deletes a channel from a client (either owner or destination).
1320 * @param c Client whose tunnel to delete.
1321 * @param ch Channel which should be deleted.
1322 * @param id Channel ID.
1325 GML_client_delete_channel (struct CadetClient *c,
1326 struct CadetChannel *ch,
1327 CADET_ChannelNumber id)
1331 if (GNUNET_CADET_LOCAL_CHANNEL_ID_SERV <= id)
1333 res = GNUNET_CONTAINER_multihashmap32_remove (c->incoming_channels,
1335 if (GNUNET_YES != res)
1336 LOG (GNUNET_ERROR_TYPE_DEBUG, "client_delete_channel dest KO\n");
1338 else if (GNUNET_CADET_LOCAL_CHANNEL_ID_CLI <= id)
1340 res = GNUNET_CONTAINER_multihashmap32_remove (c->own_channels,
1342 if (GNUNET_YES != res)
1343 LOG (GNUNET_ERROR_TYPE_DEBUG, "client_delete_tunnel root KO\n");
1352 * Build a local ACK message and send it to a local client, if needed.
1354 * If the client was already allowed to send data, do nothing.
1356 * @param c Client to whom send the ACK.
1357 * @param id Channel ID to use
1360 GML_send_ack (struct CadetClient *c, CADET_ChannelNumber id)
1362 struct GNUNET_CADET_LocalAck msg;
1364 LOG (GNUNET_ERROR_TYPE_DEBUG,
1365 "send local %s ack on %X towards %p\n",
1366 id < GNUNET_CADET_LOCAL_CHANNEL_ID_SERV ? "FWD" : "BCK", id, c);
1368 msg.header.size = htons (sizeof (msg));
1369 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_ACK);
1370 msg.channel_id = htonl (id);
1371 GNUNET_SERVER_notification_context_unicast (nc,
1381 * Notify the client that a new incoming channel was created.
1383 * @param c Client to notify.
1384 * @param id Channel ID.
1385 * @param port Channel's destination port.
1386 * @param opt Options (bit array).
1387 * @param peer Origin peer.
1390 GML_send_channel_create (struct CadetClient *c,
1391 uint32_t id, uint32_t port, uint32_t opt,
1392 const struct GNUNET_PeerIdentity *peer)
1394 struct GNUNET_CADET_ChannelMessage msg;
1396 msg.header.size = htons (sizeof (msg));
1397 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_CREATE);
1398 msg.channel_id = htonl (id);
1399 msg.port = htonl (port);
1400 msg.opt = htonl (opt);
1402 GNUNET_SERVER_notification_context_unicast (nc, c->handle,
1403 &msg.header, GNUNET_NO);
1408 * Build a local channel NACK message and send it to a local client.
1410 * @param c Client to whom send the NACK.
1411 * @param id Channel ID to use
1414 GML_send_channel_nack (struct CadetClient *c, CADET_ChannelNumber id)
1416 struct GNUNET_CADET_LocalAck msg;
1418 LOG (GNUNET_ERROR_TYPE_DEBUG,
1419 "send local nack on %X towards %p\n",
1422 msg.header.size = htons (sizeof (msg));
1423 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_NACK);
1424 msg.channel_id = htonl (id);
1425 GNUNET_SERVER_notification_context_unicast (nc,
1433 * Notify a client that a channel is no longer valid.
1436 * @param id ID of the channel that is destroyed.
1439 GML_send_channel_destroy (struct CadetClient *c, uint32_t id)
1441 struct GNUNET_CADET_ChannelMessage msg;
1448 if (GNUNET_YES == c->shutting_down)
1450 msg.header.size = htons (sizeof (msg));
1451 msg.header.type = htons (GNUNET_MESSAGE_TYPE_CADET_CHANNEL_DESTROY);
1452 msg.channel_id = htonl (id);
1453 msg.port = htonl (0);
1454 memset (&msg.peer, 0, sizeof (msg.peer));
1455 msg.opt = htonl (0);
1456 GNUNET_SERVER_notification_context_unicast (nc, c->handle,
1457 &msg.header, GNUNET_NO);
1462 * Modify the cadet message ID from global to local and send to client.
1464 * @param c Client to send to.
1465 * @param msg Message to modify and send.
1466 * @param id Channel ID to use (c can be both owner and client).
1469 GML_send_data (struct CadetClient *c,
1470 const struct GNUNET_CADET_Data *msg,
1471 CADET_ChannelNumber id)
1473 struct GNUNET_CADET_LocalData *copy;
1474 uint16_t size = ntohs (msg->header.size) - sizeof (struct GNUNET_CADET_Data);
1475 char cbuf[size + sizeof (struct GNUNET_CADET_LocalData)];
1477 if (size < sizeof (struct GNUNET_MessageHeader))
1479 GNUNET_break_op (0);
1487 copy = (struct GNUNET_CADET_LocalData *) cbuf;
1488 memcpy (©[1], &msg[1], size);
1489 copy->header.size = htons (sizeof (struct GNUNET_CADET_LocalData) + size);
1490 copy->header.type = htons (GNUNET_MESSAGE_TYPE_CADET_LOCAL_DATA);
1491 copy->id = htonl (id);
1492 GNUNET_SERVER_notification_context_unicast (nc, c->handle,
1493 ©->header, GNUNET_NO);
1498 * Get the static string to represent a client.
1502 * @return Static string for the client.
1505 GML_2s (const struct CadetClient *c)
1507 static char buf[32];
1509 SPRINTF (buf, "%u", c->id);