2 This file is part of GNUnet.
3 (C) 2009, 2010 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.c
23 * @brief mesh service; API for the Mesh. This is used to talk to arbitrary peers
24 * as of 2011-01Jan-06 this is a mockup.
25 * @author Philipp Tölke
28 #include <gnunet_constants.h>
29 #include <gnunet_mesh_service.h>
30 #include <gnunet_core_service.h>
31 #include <gnunet_container_lib.h>
32 #include <gnunet_applications.h>
36 uint32_t id GNUNET_PACKED;
37 struct GNUNET_PeerIdentity initiator;
38 struct GNUNET_PeerIdentity target;
41 static uint32_t current_id = 0;
45 struct GNUNET_MessageHeader hdr;
47 /* followed by another GNUNET_MessageHeader */
53 GNUNET_CONNECTION_TransmitReadyNotify notify;
54 struct GNUNET_MESH_Tunnel *tunnel;
57 struct GNUNET_MESH_Tunnel
59 /* The other peer this tunnel leads to; just unicast for the moment! */
60 struct GNUNET_PeerIdentity peer;
64 /* The handlers and cls for outbound tunnels. Are NULL for inbound tunnels. */
65 GNUNET_MESH_TunnelDisconnectHandler disconnect_handler;
66 GNUNET_MESH_TunnelConnectHandler connect_handler;
69 struct GNUNET_MESH_Handle* handle;
71 /* The application-type requested for this tunnel. Is only needed for pending
74 uint16_t application_type;
76 /* The context of the receive-function. */
80 struct tunnel_list_element
82 struct GNUNET_MESH_Tunnel tunnel;
83 struct tunnel_list_element *next, *prev;
88 struct tunnel_list_element *head, *tail;
91 struct peer_list_element
93 struct GNUNET_PeerIdentity peer;
95 /* how many Message-Types can this peer receive */
96 unsigned int num_types;
98 /* array of message-types */
99 GNUNET_MESH_ApplicationType *types;
101 struct GNUNET_TRANSPORT_ATS_Information atsi;
102 struct peer_list_element *next, *prev;
107 struct peer_list_element *head, *tail;
110 struct GNUNET_MESH_Handle
112 struct GNUNET_CORE_Handle *core;
113 struct GNUNET_MESH_MessageHandler *handlers;
114 struct GNUNET_PeerIdentity myself;
115 unsigned int connected_to_core;
116 struct peer_list connected_peers;
117 struct tunnel_list established_tunnels;
118 struct tunnel_list pending_tunnels;
119 struct tunnel_list pending_by_type_tunnels;
121 GNUNET_MESH_TunnelEndHandler *cleaner;
122 size_t hello_message_size;
123 uint16_t *hello_message;
127 send_end_connect(void* cls,
128 const struct GNUNET_SCHEDULER_TaskContext* tc)
130 if ( (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
133 struct GNUNET_MESH_Tunnel* tunnel = cls;
135 tunnel->connect_handler(tunnel->handler_cls, NULL, NULL);
139 send_self_connect(void* cls,
140 const struct GNUNET_SCHEDULER_TaskContext* tc)
142 if ( (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
145 struct GNUNET_MESH_Tunnel* tunnel = cls;
147 tunnel->connect_handler(tunnel->handler_cls, &tunnel->handle->myself, NULL);
148 GNUNET_SCHEDULER_add_now(send_end_connect, tunnel);
152 call_connect_handler (void *cls,
153 const struct GNUNET_SCHEDULER_TaskContext *tc)
155 if ( (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
158 struct GNUNET_MESH_Tunnel *tunnel = cls;
160 tunnel->connect_handler (tunnel->handler_cls, &tunnel->peer,
162 GNUNET_SCHEDULER_add_now (send_end_connect, tunnel);
166 core_startup (void *cls,
167 struct GNUNET_CORE_Handle *core __attribute__((unused)),
168 const struct GNUNET_PeerIdentity *my_identity,
169 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey __attribute__((unused)))
171 struct GNUNET_MESH_Handle *handle = cls;
172 memcpy (&handle->myself, my_identity, sizeof (struct GNUNET_PeerIdentity));
173 handle->connected_to_core = GNUNET_YES;
177 send_hello_message (void *cls, size_t size, void *buf)
179 if (cls == NULL) return 0;
180 struct GNUNET_MESH_Handle *handle = cls;
181 struct GNUNET_MessageHeader *hdr = buf;
183 size_t sent = sizeof(struct GNUNET_MessageHeader) + handle->hello_message_size;
185 hdr->type = htons(GNUNET_MESSAGE_TYPE_MESH_HELLO);
186 hdr->size = htons(size);
188 memcpy(hdr+1, handle->hello_message, handle->hello_message_size);
194 * Core calls this if we are connected to a new peer.
196 * The peer is added to the connected_peers-list.
200 core_connect (void *cls,
201 const struct GNUNET_PeerIdentity *peer,
202 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
204 struct GNUNET_MESH_Handle *handle = cls;
206 /* Send a hello to this peer */
207 GNUNET_CORE_notify_transmit_ready(handle->core,
210 GNUNET_TIME_UNIT_SECONDS,
212 sizeof(struct GNUNET_MessageHeader) + handle->hello_message_size,
216 /* put the new peer into the list of connected peers */
217 struct peer_list_element *element =
218 GNUNET_malloc (sizeof (struct peer_list_element));
219 memcpy (&element->peer, peer, sizeof (struct GNUNET_PeerIdentity));
222 memcpy (&element->atsi, atsi,
223 sizeof (struct GNUNET_TRANSPORT_ATS_Information));
225 GNUNET_CONTAINER_DLL_insert_after (handle->connected_peers.head,
226 handle->connected_peers.tail,
227 handle->connected_peers.tail, element);
229 struct tunnel_list_element *tunnel = handle->pending_tunnels.head;
230 while (tunnel != NULL)
233 memcmp (&tunnel->tunnel.peer, peer,
234 sizeof (struct GNUNET_PeerIdentity)))
236 struct tunnel_list_element *next = tunnel->next;
237 GNUNET_CONTAINER_DLL_remove (handle->pending_tunnels.head,
238 handle->pending_tunnels.tail, tunnel);
239 GNUNET_CONTAINER_DLL_insert_after (handle->established_tunnels.head,
240 handle->established_tunnels.tail,
241 handle->established_tunnels.tail,
243 tunnel->tunnel.connect_handler (tunnel->tunnel.handler_cls,
245 GNUNET_SCHEDULER_add_now(send_end_connect, tunnel);
249 tunnel = tunnel->next;
254 * Core calls this if we disconnect a peer
256 * Remove this peer from the list of connected peers
257 * Close all tunnels this peer belongs to
260 core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
262 struct GNUNET_MESH_Handle *handle = cls;
264 struct peer_list_element *element = handle->connected_peers.head;
265 while (element != NULL)
268 memcmp (&element->peer, peer, sizeof (struct GNUNET_PeerIdentity)))
270 element = element->next;
274 GNUNET_CONTAINER_DLL_remove (handle->connected_peers.head,
275 handle->connected_peers.tail, element);
276 GNUNET_free_non_null(element->types);
277 GNUNET_free (element);
280 struct tunnel_list_element *telement = handle->established_tunnels.head;
281 while (telement != NULL)
284 memcmp (&telement->tunnel.peer, peer,
285 sizeof (struct GNUNET_PeerIdentity)))
287 /* disconnect tunnels */
288 /* outbound tunnels */
289 if (telement->tunnel.connect_handler != NULL && NULL != telement->tunnel.disconnect_handler)
290 telement->tunnel.disconnect_handler (telement->tunnel.handler_cls,
292 /* inbound tunnels */
293 else if (NULL != handle->cleaner)
294 handle->cleaner (handle->cls, &telement->tunnel,
295 &telement->tunnel.ctx);
297 struct tunnel_list_element *next = telement->next;
298 GNUNET_CONTAINER_DLL_remove (handle->established_tunnels.head,
299 handle->established_tunnels.tail,
301 GNUNET_free (telement);
306 telement = telement->next;
312 * Receive a message from core.
313 * This is a hello-message, containing the application-types the other peer can receive
316 receive_hello (void *cls,
317 const struct GNUNET_PeerIdentity *other,
318 const struct GNUNET_MessageHeader *message,
319 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
321 struct GNUNET_MESH_Handle *handle = cls;
322 uint16_t *num = (uint16_t *) (message + 1);
323 uint16_t *ports = num + 1;
326 struct peer_list_element *element = handle->connected_peers.head;
327 while (element != NULL)
330 memcmp (&element->peer, other, sizeof (struct GNUNET_PeerIdentity)))
332 element = element->next;
335 /* TODO: add, not replace! */
336 element->num_types = *num;
337 element->types = GNUNET_malloc (*num * sizeof (GNUNET_MESH_ApplicationType));
339 for (i = 0; i < *num; i++)
340 element->types[i] = (GNUNET_MESH_ApplicationType)ntohs (ports[i]);
342 struct tunnel_list_element *tunnel = handle->pending_by_type_tunnels.head;
343 while (tunnel != NULL)
345 struct tunnel_list_element *next = tunnel->next;
346 for (i = 0; i < *num; i++)
348 if (ntohs (ports[i]) == tunnel->tunnel.application_type)
350 GNUNET_CONTAINER_DLL_remove (handle->pending_tunnels.head,
351 handle->pending_tunnels.tail,
353 GNUNET_CONTAINER_DLL_insert_after (handle->established_tunnels.
355 handle->established_tunnels.
357 handle->established_tunnels.
359 tunnel->tunnel.connect_handler (tunnel->tunnel.handler_cls,
360 &tunnel->tunnel.peer, atsi);
361 GNUNET_SCHEDULER_add_now (send_end_connect, tunnel);
365 if (ntohs (ports[i]) == tunnel->tunnel.application_type)
368 tunnel = tunnel->next;
374 * Receive a message from core.
377 core_receive (void *cls,
378 const struct GNUNET_PeerIdentity *other,
379 const struct GNUNET_MessageHeader *message,
380 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
382 struct GNUNET_MESH_Handle *handle = cls;
383 struct tunnel_message *tmessage = (struct tunnel_message *) message;
384 struct GNUNET_MessageHeader *rmessage =
385 (struct GNUNET_MessageHeader *) (tmessage + 1);
387 struct GNUNET_MESH_MessageHandler *handler;
389 for (handler = handle->handlers; handler->callback != NULL; handler++)
391 if ( (ntohs (rmessage->type) == handler->type)
392 && ( (handler->expected_size == 0)
393 || (handler->expected_size == ntohs (rmessage->size))) )
399 /* handler->callback handles this message */
401 /* If no handler was found, drop the message but keep the channel open */
402 if (handler->callback == NULL)
405 struct tunnel_list_element *tunnel = handle->established_tunnels.head;
407 while (tunnel != NULL)
409 if (tunnel->tunnel.id.id == tmessage->id.id &&
411 memcmp (&tmessage->id.initiator, &tunnel->tunnel.id.initiator,
412 sizeof (struct GNUNET_PeerIdentity)))
414 memcmp (&tmessage->id.target, &tunnel->tunnel.id.target,
415 sizeof (struct GNUNET_PeerIdentity))))
417 tunnel = tunnel->next;
420 /* if no tunnel was found: create a new inbound tunnel */
423 tunnel = GNUNET_malloc (sizeof (struct tunnel_list_element));
424 tunnel->tunnel.connect_handler = NULL;
425 tunnel->tunnel.disconnect_handler = NULL;
426 tunnel->tunnel.handler_cls = NULL;
427 tunnel->tunnel.ctx = NULL;
428 tunnel->tunnel.handle = handle;
429 memcpy (&tunnel->tunnel.peer, other,
430 sizeof (struct GNUNET_PeerIdentity));
431 memcpy (&tunnel->tunnel.id, &tmessage->id, sizeof (struct tunnel_id));
433 GNUNET_CONTAINER_DLL_insert_after (handle->established_tunnels.head,
434 handle->established_tunnels.tail,
435 handle->established_tunnels.tail,
439 return handler->callback (handle->cls, &tunnel->tunnel,
440 &tunnel->tunnel.ctx, other, rmessage, atsi);
443 struct GNUNET_MESH_Tunnel *
444 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Handle *handle,
445 struct GNUNET_TIME_Relative timeout,
446 GNUNET_MESH_ApplicationType application_type,
447 GNUNET_MESH_TunnelConnectHandler
449 GNUNET_MESH_TunnelDisconnectHandler
453 /* Look in the list of connected peers */
454 struct peer_list_element *element = handle->connected_peers.head;
455 while (element != NULL)
458 for (i = 0; i < element->num_types; i++)
459 if (application_type == element->types[i])
460 return GNUNET_MESH_peer_request_connect_all (handle, timeout, 1,
465 element = element->next;
468 /* Put into pending list */
469 struct tunnel_list_element *tunnel =
470 GNUNET_malloc (sizeof (struct tunnel_list_element));
472 tunnel->tunnel.connect_handler = connect_handler;
473 tunnel->tunnel.disconnect_handler = disconnect_handler;
474 tunnel->tunnel.handler_cls = handler_cls;
475 tunnel->tunnel.ctx = NULL;
476 tunnel->tunnel.handle = handle;
477 memcpy (&tunnel->tunnel.id.initiator, &handle->myself,
478 sizeof (struct GNUNET_PeerIdentity));
479 tunnel->tunnel.id.id = current_id++;
480 tunnel->tunnel.application_type = application_type;
482 GNUNET_CONTAINER_DLL_insert_after (handle->pending_by_type_tunnels.head,
483 handle->pending_by_type_tunnels.tail,
484 handle->pending_by_type_tunnels.tail,
486 return &tunnel->tunnel;
491 struct GNUNET_MESH_Tunnel *
492 GNUNET_MESH_peer_request_connect_all (struct GNUNET_MESH_Handle *handle,
493 struct GNUNET_TIME_Relative timeout,
494 unsigned int num_peers,
495 const struct GNUNET_PeerIdentity *peers,
496 GNUNET_MESH_TunnelConnectHandler
498 GNUNET_MESH_TunnelDisconnectHandler
499 disconnect_handler, void *handler_cls)
504 struct tunnel_list_element *tunnel =
505 GNUNET_malloc (sizeof (struct tunnel_list_element));
507 tunnel->tunnel.connect_handler = connect_handler;
508 tunnel->tunnel.disconnect_handler = disconnect_handler;
509 tunnel->tunnel.handler_cls = handler_cls;
510 tunnel->tunnel.ctx = NULL;
511 tunnel->tunnel.handle = handle;
512 memcpy (&tunnel->tunnel.id.initiator, &handle->myself,
513 sizeof (struct GNUNET_PeerIdentity));
514 memcpy (&tunnel->tunnel.id.target, peers,
515 sizeof (struct GNUNET_PeerIdentity));
516 tunnel->tunnel.id.id = current_id++;
517 memcpy (&tunnel->tunnel.peer, peers, sizeof(struct GNUNET_PeerIdentity));
519 struct peer_list_element *element = handle->connected_peers.head;
520 while (element != NULL)
523 memcmp (&element->peer, peers, sizeof (struct GNUNET_PeerIdentity)))
525 element = element->next;
530 /* we are connected to this peer */
531 GNUNET_CONTAINER_DLL_insert_after (handle->established_tunnels.head,
532 handle->established_tunnels.tail,
533 handle->established_tunnels.tail,
535 GNUNET_SCHEDULER_add_now(call_connect_handler, tunnel);
538 memcmp (peers, &handle->myself,
539 sizeof (struct GNUNET_PeerIdentity)))
541 /* we are the peer */
542 GNUNET_CONTAINER_DLL_insert_after (handle->established_tunnels.head,
543 handle->established_tunnels.tail,
544 handle->established_tunnels.tail,
546 GNUNET_SCHEDULER_add_now(send_self_connect, tunnel);
550 /* we are not connected to this peer */
551 GNUNET_CONTAINER_DLL_insert_after (handle->pending_tunnels.head,
552 handle->pending_tunnels.tail,
553 handle->pending_tunnels.tail,
555 (void) GNUNET_CORE_peer_request_connect (handle->core,
560 return &tunnel->tunnel;
563 const struct GNUNET_PeerIdentity*
564 GNUNET_MESH_get_peer(const struct GNUNET_MESH_Tunnel* tunnel)
566 return &tunnel->peer;
570 core_notify(void* cls, size_t size, void* buf)
572 struct notify_cls *ncls = cls;
573 struct GNUNET_MESH_Tunnel *tunnel = ncls->tunnel;
574 struct tunnel_message* message = buf;
575 void* cbuf = (void*) &message[1];
576 GNUNET_assert(NULL != ncls->notify);
578 size_t sent = ncls->notify(ncls->notify_cls, size - sizeof(struct tunnel_message), cbuf);
582 if (0 == sent) return 0;
584 sent += sizeof(struct tunnel_message);
586 message->hdr.type = htons(GNUNET_MESSAGE_TYPE_MESH);
587 message->hdr.size = htons(sent);
588 memcpy(&message->id, &tunnel->id, sizeof(struct tunnel_id));
594 * Ask the mesh to call "notify" once it is ready to transmit the
595 * given number of bytes to the specified "target". If we are not yet
596 * connected to the specified peer, a call to this function will cause
597 * us to try to establish a connection.
599 * @param tunnel tunnel to use for transmission
600 * @param cork is corking allowed for this transmission?
601 * @param priority how important is the message?
602 * @param maxdelay how long can the message wait?
603 * @param target destination for the message, NULL for multicast to all tunnel targets
604 * @param notify_size how many bytes of buffer space does notify want?
605 * @param notify function to call when buffer space is available;
606 * will be called with NULL on timeout or if the overall queue
607 * for this peer is larger than queue_size and this is currently
608 * the message with the lowest priority
609 * @param notify_cls closure for notify
610 * @return non-NULL if the notify callback was queued,
611 * NULL if we can not even queue the request (insufficient
612 * memory); if NULL is returned, "notify" will NOT be called.
614 struct GNUNET_MESH_TransmitHandle *
615 GNUNET_MESH_notify_transmit_ready (struct
623 const struct GNUNET_PeerIdentity *target __attribute__((unused)),
626 GNUNET_CONNECTION_TransmitReadyNotify
627 notify, void *notify_cls)
629 struct notify_cls *cls = GNUNET_malloc(sizeof(struct notify_cls));
630 cls->notify_cls = notify_cls;
631 GNUNET_assert(NULL != notify);
632 cls->notify = notify;
633 cls->tunnel = tunnel;
634 GNUNET_CORE_notify_transmit_ready(tunnel->handle->core,
639 notify_size + sizeof(struct tunnel_message),
643 /* aborting is not implemented yet */
644 return (struct GNUNET_MESH_TransmitHandle*) 1;
647 void build_hello_message(struct GNUNET_MESH_Handle* handle,
648 const GNUNET_MESH_ApplicationType *stypes)
651 const GNUNET_MESH_ApplicationType *t;
653 for (t = stypes; *t != GNUNET_APPLICATION_TYPE_END; t++, num++);
655 handle->hello_message_size = sizeof(uint16_t) + /* For the number of types */
656 num * sizeof(GNUNET_MESH_ApplicationType); /* For the types */
658 uint16_t *nums = GNUNET_malloc(handle->hello_message_size);
659 GNUNET_MESH_ApplicationType *types = (GNUNET_MESH_ApplicationType*)(nums + 1);
662 memcpy(types, stypes, num*sizeof(GNUNET_MESH_ApplicationType));
664 handle->hello_message = nums;
668 struct GNUNET_MESH_Handle *
669 GNUNET_MESH_connect (const struct
670 GNUNET_CONFIGURATION_Handle
672 GNUNET_MESH_TunnelEndHandler
674 const struct GNUNET_MESH_MessageHandler *handlers,
675 const GNUNET_MESH_ApplicationType *stypes)
677 struct GNUNET_MESH_Handle *ret =
678 GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
680 ret->connected_to_core = GNUNET_NO;
681 ret->connected_peers.head = NULL;
682 ret->connected_peers.tail = NULL;
683 ret->cleaner = cleaner;
686 const struct GNUNET_MESH_MessageHandler *it;
687 unsigned int len = 1;
688 for (it = handlers; it->callback != NULL; it++)
694 GNUNET_malloc (len * sizeof (struct GNUNET_MESH_MessageHandler));
695 memset(ret->handlers, 0, len * sizeof(struct GNUNET_MESH_MessageHandler));
696 memcpy (ret->handlers, handlers,
697 len * sizeof (struct GNUNET_MESH_MessageHandler));
699 build_hello_message(ret, stypes);
701 static const struct GNUNET_CORE_MessageHandler core_handlers[] = {
702 {&core_receive, GNUNET_MESSAGE_TYPE_MESH, 0},
703 {&receive_hello, GNUNET_MESSAGE_TYPE_MESH_HELLO, 0},
707 ret->core = GNUNET_CORE_connect (cfg,
715 GNUNET_NO, NULL, GNUNET_NO, core_handlers);
720 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
722 GNUNET_free (handle->handlers);
723 GNUNET_free (handle->hello_message);
724 GNUNET_CORE_disconnect (handle->core);
726 struct peer_list_element *element = handle->connected_peers.head;
727 while (element != NULL)
729 struct peer_list_element *next = element->next;
730 GNUNET_free_non_null(element->types);
731 GNUNET_free (element);
735 struct tunnel_list_element *tunnel = handle->pending_tunnels.head;
736 while (tunnel != NULL)
738 struct tunnel_list_element *next = tunnel->next;
739 GNUNET_free (tunnel);
742 tunnel = handle->established_tunnels.head;;
743 while (tunnel != NULL)
745 struct tunnel_list_element *next = tunnel->next;
746 GNUNET_free (tunnel);
750 GNUNET_free (handle);
753 /* end of mesh_api.c */