2 This file is part of GNUnet.
3 (C) 2011 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 mesh/mesh_api_new.c
23 * @brief mesh api: client implementation of mesh service
24 * @author Bartlomiej Polot
31 * - API CALL DEFINITIONS
38 #if 0 /* keep Emacsens' auto-indent happy */
45 #include "gnunet_common.h"
46 #include "gnunet_client_lib.h"
47 #include "gnunet_util_lib.h"
48 #include "gnunet_peer_lib.h"
49 #include "gnunet_mesh_service_new.h"
51 #include "mesh_protocol.h"
53 /******************************************************************************/
54 /************************ DATA STRUCTURES ****************************/
55 /******************************************************************************/
58 * Opaque handle to the service.
60 struct GNUNET_MESH_Handle {
62 * Handle to the server connection, to send messages later
64 struct GNUNET_CLIENT_Connection *client;
67 * Set of handlers used for processing incoming messages in the tunnels
69 const struct GNUNET_MESH_MessageHandler *message_handlers;
73 * Set of applications that should be claimed to be offered at this node.
74 * Note that this is just informative, the appropiate handlers must be
75 * registered independently and the mapping is up to the developer of the
78 const GNUNET_MESH_ApplicationType *applications;
82 * Double linked list of the tunnels this client is connected to.
84 struct GNUNET_MESH_Tunnel *tunnels_head;
85 struct GNUNET_MESH_Tunnel *tunnels_tail;
88 * tid of the next tunnel to create (to avoid reusing IDs often)
90 MESH_TunnelNumber next_tid;
93 * Callback for tunnel disconnection
95 GNUNET_MESH_TunnelEndHandler *cleaner;
98 * Handle to cancel pending transmissions in case of disconnection
100 struct GNUNET_CLIENT_TransmitHandle *th;
103 * Closure for all the handlers given by the client
109 * Opaque handle to a tunnel.
111 struct GNUNET_MESH_Tunnel {
116 struct GNUNET_MESH_Tunnel *next;
117 struct GNUNET_MESH_Tunnel *prev;
120 * Local ID of the tunnel
122 MESH_TunnelNumber tid;
125 * Owner of the tunnel
127 GNUNET_PEER_Id owner;
130 * Callback to execute when peers connect to the tunnel
132 GNUNET_MESH_TunnelConnectHandler connect_handler;
135 * Callback to execute when peers disconnect to the tunnel
137 GNUNET_MESH_TunnelDisconnectHandler disconnect_handler;
140 * All peers added to the tunnel
142 GNUNET_PEER_Id *peers;
145 * Closure for the connect/disconnect handlers
150 * Handle to the mesh this tunnel belongs to
152 struct GNUNET_MESH_Handle *mesh;
155 struct GNUNET_MESH_TransmitHandle {
159 /******************************************************************************/
160 /*********************** AUXILIARY FUNCTIONS *************************/
161 /******************************************************************************/
164 * Get the tunnel handler for the tunnel specified by id from the given handle
165 * @param h Mesh handle
166 * @param tid ID of the wanted tunnel
167 * @return handle to the required tunnel or NULL if not found
169 static struct GNUNET_MESH_Tunnel *
170 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
172 struct GNUNET_MESH_Tunnel *t;
176 if (t->tid == tid) return t;
183 /******************************************************************************/
184 /************************ SEND CALLBACKS ****************************/
185 /******************************************************************************/
189 * Function called to send a connect message to the service, specifying the
190 * types and applications that the client is interested in.
191 * "buf" will be NULL and "size" zero if the socket was closed for writing in
194 * @param cls closure, the mesh handle
195 * @param size number of bytes available in buf
196 * @param buf where the callee should write the connect message
197 * @return number of bytes written to buf
200 send_connect_packet (void *cls, size_t size, void *buf)
202 struct GNUNET_MESH_Handle *h = cls;
203 struct GNUNET_MESH_ClientConnect *msg;
206 GNUNET_MESH_ApplicationType *apps;
210 if (0 == size || buf == NULL) {
211 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
212 "Send connect packet: buffer size 0 or buffer invalid\n");
213 // FIXME: disconnect, reconnect, retry!
216 if (sizeof(struct GNUNET_MessageHeader) > size) {
217 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
218 "Send connect packet: buffer size too small\n");
219 // FIXME: disconnect, reconnect, retry!
222 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
223 "Send connect packet: %lu bytes buffer\n",
225 msg = (struct GNUNET_MESH_ClientConnect *) buf;
226 msg->header.type = htons(GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
228 for (ntypes = 0, types = NULL; ntypes < h->n_handlers; ntypes++) {
229 types = GNUNET_realloc(types, sizeof(uint16_t) * (ntypes + 1));
230 types[ntypes] = h->message_handlers[ntypes].type;
233 for(napps = 0, apps = NULL; napps < h->n_applications; napps++) {
234 apps = GNUNET_realloc(apps,
235 sizeof(GNUNET_MESH_ApplicationType) *
237 apps[napps] = h->applications[napps];
240 msg->header.size = htons(sizeof(struct GNUNET_MESH_ClientConnect) +
241 sizeof(uint16_t) * ntypes +
242 sizeof(GNUNET_MESH_ApplicationType) * napps);
244 memcpy(&msg[1], types, sizeof(uint16_t) * ntypes);
245 memcpy(&msg[1] + sizeof(uint16_t) * ntypes,
247 sizeof(GNUNET_MESH_ApplicationType) * napps);
248 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
249 "Sent %lu bytes long message %d types and %d apps\n",
250 ntohs(msg->header.size),
254 msg->applications = htons(napps);
255 msg->types = htons(ntypes);
257 return ntohs(msg->header.size);
262 * Function called to send a create tunnel message, specifying the tunnel
263 * number chosen by the client.
264 * "buf" will be NULL and "size" zero if the socket was closed for
265 * writing in the meantime.
267 * @param cls closure, the tunnel handle
268 * @param size number of bytes available in buf
269 * @param buf where the callee should write the create tunnel message
270 * @return number of bytes written to buf
273 send_tunnel_create_packet (void *cls, size_t size, void *buf)
275 struct GNUNET_MESH_Tunnel *t = cls;
276 struct GNUNET_MESH_Handle *h;
277 struct GNUNET_MESH_TunnelMessage *msg;
281 if (0 == size || buf == NULL) {
282 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
283 "Send connect packet: buffer size 0 or buffer invalid\n");
284 // FIXME: disconnect, reconnect, retry!
287 if (sizeof(struct GNUNET_MessageHeader) > size) {
288 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
289 "Send connect packet: buffer size too small\n");
290 // FIXME: disconnect, reconnect, retry!
293 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
294 "Send connect packet: %lu bytes buffer\n",
296 msg = (struct GNUNET_MESH_TunnelMessage *) buf;
297 msg->header.type = htons(GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
299 msg->header.size = htons(sizeof(struct GNUNET_MESH_TunnelMessage));
300 msg->tunnel_id = htonl(t->tid);
302 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
303 "Sent %lu bytes long message\n",
304 ntohs(msg->header.size));
306 return ntohs(msg->header.size);
310 /******************************************************************************/
311 /*********************** RECEIVE HANDLERS ****************************/
312 /******************************************************************************/
315 * Process the new tunnel notification and add it to the tunnels in the handle
317 * @param h The mesh handle
318 * @param msg A message with the details of the new incoming tunnel
321 process_tunnel_create(struct GNUNET_MESH_Handle *h,
322 const struct GNUNET_MESH_TunnelMessage *msg)
324 struct GNUNET_MESH_Tunnel *t;
325 MESH_TunnelNumber tid;
327 tid = ntohl(msg->tunnel_id);
328 if (tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_MARK) {
329 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
330 "MESH: received an incoming tunnel with tid in local range (%X)\n",
333 return; //FIXME abort? reconnect?
335 t = GNUNET_malloc(sizeof(struct GNUNET_MESH_Tunnel));
345 * Process the new peer event and notify the upper level of it
347 * @param h The mesh handle
348 * @param msg A message with the details of the peer event
351 process_peer_event(struct GNUNET_MESH_Handle *h,
352 const struct GNUNET_MESH_PeerControl *msg)
354 struct GNUNET_MESH_Tunnel *t;
357 size = ntohs(msg->header.size);
358 if (size != sizeof(struct GNUNET_MESH_PeerControl)) {
362 t = retrieve_tunnel(h, ntohl(msg->tunnel_id));
367 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_CONNECTED == msg->header.type) {
368 if (NULL != t->connect_handler) {
369 t->connect_handler(t->cls, &msg->peer, NULL); /* FIXME atsi */
372 if (NULL != t->disconnect_handler) {
373 t->disconnect_handler(t->cls, &msg->peer);
380 * Process the incoming data packets
382 * @param h The mesh handle
383 * @param msh A message encapsulating the data
386 process_incoming_data(struct GNUNET_MESH_Handle *h,
387 const struct GNUNET_MessageHeader *message)
389 const struct GNUNET_MessageHeader *payload;
390 const struct GNUNET_MESH_MessageHandler *handler;
391 const struct GNUNET_PeerIdentity *peer;
392 struct GNUNET_MESH_Unicast *ucast;
393 struct GNUNET_MESH_Multicast *mcast;
394 struct GNUNET_MESH_ToOrigin *to_orig;
395 struct GNUNET_MESH_Tunnel *t;
399 type = ntohs(message->type);
401 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
402 ucast = (struct GNUNET_MESH_Unicast *) message;
403 t = retrieve_tunnel(h, ntohl(ucast->tid));
404 payload = (struct GNUNET_MessageHeader *) &ucast[1];
407 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
408 mcast = (struct GNUNET_MESH_Multicast *) message;
409 t = retrieve_tunnel(h, ntohl(mcast->tid));
410 payload = (struct GNUNET_MessageHeader *) &mcast[1];
413 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
414 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
415 t = retrieve_tunnel(h, ntohl(to_orig->tid));
416 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
417 peer = &to_orig->sender;
427 for (i = 0; i < h->n_handlers; i++) {
428 handler = &h->message_handlers[i];
429 if (handler->type == type) {
430 if (GNUNET_OK == handler->callback (h->cls,
432 NULL, /* FIXME ctx */
435 NULL)) /* FIXME atsi */
437 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
438 "MESH: callback completed successfully\n");
440 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
441 "MESH: callback caused disconnection\n");
442 GNUNET_MESH_disconnect(h);
451 * Function to process all messages received from the service
454 * @param msg message received, NULL on timeout or fatal error
457 msg_received (void *cls, const struct GNUNET_MessageHeader * msg)
459 struct GNUNET_MESH_Handle *h = cls;
466 switch (ntohs(msg->type)) {
467 /* Notify of a new incoming tunnel */
468 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
469 process_tunnel_create(h, (struct GNUNET_MESH_TunnelMessage *)msg);
471 /* Notify of a new peer or a peer disconnect in the tunnel*/
472 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_CONNECTED:
473 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DISCONNECTED:
474 process_peer_event(h, (struct GNUNET_MESH_PeerControl *)msg);
476 /* Notify of a new data packet in the tunnel */
477 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
478 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
479 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
480 process_incoming_data(h, msg);
482 /* We shouldn't get any other packages, log and ignore */
484 GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
485 "MESH: unsolicited message form service (type %d)\n",
489 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
490 "received a message from mesh\n");
491 GNUNET_CLIENT_receive (h->client,
494 GNUNET_TIME_UNIT_FOREVER_REL);
498 /******************************************************************************/
499 /********************** API CALL DEFINITIONS *************************/
500 /******************************************************************************/
503 * Connect to the mesh service.
505 * @param cfg configuration to use
506 * @param cls closure for the various callbacks that follow
507 * (including handlers in the handlers array)
508 * @param cleaner function called when an *inbound* tunnel is destroyed
509 * @param handlers callbacks for messages we care about, NULL-terminated
510 * note that the mesh is allowed to drop notifications about
511 * inbound messages if the client does not process them fast
512 * enough (for this notification type, a bounded queue is used)
513 * @param stypes Application Types the client claims to offer
514 * @return handle to the mesh service
515 * NULL on error (in this case, init is never called)
517 struct GNUNET_MESH_Handle *
518 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
520 GNUNET_MESH_TunnelEndHandler cleaner,
521 const struct GNUNET_MESH_MessageHandler *handlers,
522 const GNUNET_MESH_ApplicationType *stypes)
524 struct GNUNET_MESH_Handle *h;
527 h = GNUNET_malloc(sizeof(struct GNUNET_MESH_Handle));
529 h->cleaner = cleaner;
530 h->client = GNUNET_CLIENT_connect("mesh", cfg);
531 GNUNET_CLIENT_receive (h->client,
534 GNUNET_TIME_UNIT_FOREVER_REL);
535 if(h->client == NULL) {
541 h->message_handlers = handlers;
542 h->applications = stypes;
543 h->next_tid = 0x80000000;
545 for(h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++);
546 for(h->n_applications = 0; stypes[h->n_applications]; h->n_applications++);
548 size = sizeof(struct GNUNET_MESH_ClientConnect);
549 size += h->n_handlers * sizeof(uint16_t);
550 size += h->n_applications * sizeof(GNUNET_MESH_ApplicationType);
552 h->th = GNUNET_CLIENT_notify_transmit_ready(h->client,
554 GNUNET_TIME_UNIT_FOREVER_REL,
556 &send_connect_packet,
564 * Disconnect from the mesh service.
566 * @param handle connection to mesh to disconnect
569 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
571 if (NULL != handle->th) {
572 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
574 if (NULL != handle->client) {
575 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
582 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
585 * @param h mesh handle
586 * @param connect_handler function to call when peers are actually connected
587 * @param disconnect_handler function to call when peers are disconnected
588 * @param handler_cls closure for connect/disconnect handlers
590 struct GNUNET_MESH_Tunnel *
591 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
592 GNUNET_MESH_TunnelConnectHandler
594 GNUNET_MESH_TunnelDisconnectHandler
598 struct GNUNET_MESH_Tunnel *tunnel;
600 GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
601 "MESH: Creating new tunnel\n");
602 tunnel = GNUNET_malloc(sizeof(struct GNUNET_MESH_Tunnel));
604 tunnel->connect_handler = connect_handler;
605 tunnel->disconnect_handler = disconnect_handler;
606 tunnel->cls = handler_cls;
608 tunnel->tid = h->next_tid++;
609 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_MARK; // keep in range
611 h->th = GNUNET_CLIENT_notify_transmit_ready(h->client,
612 sizeof(struct GNUNET_MESH_TunnelMessage),
613 GNUNET_TIME_UNIT_FOREVER_REL,
615 &send_tunnel_create_packet,
623 * Request that a peer should be added to the tunnel. The existing
624 * connect handler will be called ONCE with either success or failure.
626 * @param tunnel handle to existing tunnel
627 * @param timeout how long to try to establish a connection
628 * @param peer peer to add
631 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
632 struct GNUNET_TIME_Relative timeout,
633 const struct GNUNET_PeerIdentity *peer)
635 static GNUNET_PEER_Id peer_id;
637 peer_id = GNUNET_PEER_intern(peer);
639 /* FIXME ACTUALLY DO STUFF */
640 tunnel->peers = &peer_id;
641 tunnel->connect_handler(tunnel->cls, peer, NULL);
647 * Request that a peer should be removed from the tunnel. The existing
648 * disconnect handler will be called ONCE if we were connected.
650 * @param tunnel handle to existing tunnel
651 * @param peer peer to remove
654 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
655 const struct GNUNET_PeerIdentity *peer)
657 /* FIXME ACTUALLY DO STUFF */
658 tunnel->peers = NULL;
659 tunnel->disconnect_handler(tunnel->cls, peer);
665 * Request that the mesh should try to connect to a peer supporting the given
668 * @param tunnel handle to existing tunnel
669 * @param timeout how long to try to establish a connection
670 * @param app_type application type that must be supported by the peer (MESH
671 * should discover peer in proximity handling this type)
674 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
675 struct GNUNET_TIME_Relative timeout,
676 GNUNET_MESH_ApplicationType
684 * Ask the mesh to call "notify" once it is ready to transmit the
685 * given number of bytes to the specified "target". If we are not yet
686 * connected to the specified peer, a call to this function will cause
687 * us to try to establish a connection.
689 * @param tunnel tunnel to use for transmission
690 * @param cork is corking allowed for this transmission?
691 * @param priority how important is the message?
692 * @param maxdelay how long can the message wait?
693 * @param target destination for the message,
694 * NULL for multicast to all tunnel targets
695 * @param notify_size how many bytes of buffer space does notify want?
696 * @param notify function to call when buffer space is available;
697 * will be called with NULL on timeout or if the overall queue
698 * for this peer is larger than queue_size and this is currently
699 * the message with the lowest priority
700 * @param notify_cls closure for notify
701 * @return non-NULL if the notify callback was queued,
702 * NULL if we can not even queue the request (insufficient
703 * memory); if NULL is returned, "notify" will NOT be called.
705 struct GNUNET_MESH_TransmitHandle *
706 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel,
709 struct GNUNET_TIME_Relative maxdelay,
710 const struct GNUNET_PeerIdentity *target,
712 GNUNET_CONNECTION_TransmitReadyNotify
716 struct GNUNET_MESH_TransmitHandle *handle;
718 handle = GNUNET_malloc(sizeof(struct GNUNET_MESH_TransmitHandle));
724 #if 0 /* keep Emacsens' auto-indent happy */