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>
35 uint32_t id GNUNET_PACKED;
36 struct GNUNET_PeerIdentity initiator;
37 struct GNUNET_PeerIdentity target;
40 static uint32_t current_id = 0;
44 struct GNUNET_MessageHeader hdr;
46 /* followed by another GNUNET_MessageHeader */
52 GNUNET_CONNECTION_TransmitReadyNotify notify;
53 struct GNUNET_MESH_Tunnel *tunnel;
56 struct GNUNET_MESH_Tunnel
58 /* The other peer this tunnel leads to; just unicast for the moment! */
59 struct GNUNET_PeerIdentity peer;
63 /* The handlers and cls for outbound tunnels. Are NULL for inbound tunnels. */
64 GNUNET_MESH_TunnelDisconnectHandler disconnect_handler;
65 GNUNET_MESH_TunnelConnectHandler connect_handler;
68 struct GNUNET_MESH_Handle* handle;
70 /* The message-type requested for this tunnel. Is only needed for pending
73 uint16_t message_type;
75 /* The context of the receive-function. */
79 struct tunnel_list_element
81 struct GNUNET_MESH_Tunnel tunnel;
82 struct tunnel_list_element *next, *prev;
87 struct tunnel_list_element *head, *tail;
90 struct peer_list_element
92 struct GNUNET_PeerIdentity peer;
94 /* how many Message-Types can this peer receive */
95 unsigned int num_types;
97 /* array of message-types */
98 GNUNET_MESH_ApplicationType *types;
100 struct GNUNET_TRANSPORT_ATS_Information atsi;
101 struct peer_list_element *next, *prev;
106 struct peer_list_element *head, *tail;
109 struct GNUNET_MESH_Handle
111 struct GNUNET_CORE_Handle *core;
112 struct GNUNET_MESH_MessageHandler *handlers;
113 struct GNUNET_PeerIdentity myself;
114 unsigned int connected_to_core;
115 struct peer_list connected_peers;
116 struct tunnel_list established_tunnels;
117 struct tunnel_list pending_tunnels;
118 struct tunnel_list pending_by_type_tunnels;
120 GNUNET_MESH_TunnelEndHandler *cleaner;
121 size_t hello_message_size;
122 uint16_t *hello_message;
126 send_end_connect(void* cls,
127 const struct GNUNET_SCHEDULER_TaskContext* tc)
129 struct GNUNET_MESH_Tunnel* tunnel = cls;
131 tunnel->connect_handler(tunnel->handler_cls, NULL, NULL);
135 send_self_connect(void* cls,
136 const struct GNUNET_SCHEDULER_TaskContext* tc)
138 struct GNUNET_MESH_Tunnel* tunnel = cls;
140 tunnel->connect_handler(tunnel->handler_cls, &tunnel->handle->myself, NULL);
141 GNUNET_SCHEDULER_add_now(send_end_connect, tunnel);
145 call_connect_handler (void *cls,
146 const struct GNUNET_SCHEDULER_TaskContext *tc)
148 struct GNUNET_MESH_Tunnel *tunnel = cls;
150 tunnel->connect_handler (tunnel->handler_cls, &tunnel->peer,
152 GNUNET_SCHEDULER_add_now (send_end_connect, tunnel);
156 core_startup (void *cls,
157 struct GNUNET_CORE_Handle *core,
158 const struct GNUNET_PeerIdentity *my_identity,
159 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
161 struct GNUNET_MESH_Handle *handle = cls;
162 memcpy (&handle->myself, my_identity, sizeof (struct GNUNET_PeerIdentity));
163 handle->connected_to_core = GNUNET_YES;
167 send_hello_message (void *cls, size_t size, void *buf)
169 if (cls == NULL) return 0;
170 struct GNUNET_MESH_Handle *handle = cls;
171 struct GNUNET_MessageHeader *hdr = buf;
173 size_t sent = sizeof(struct GNUNET_MessageHeader) + handle->hello_message_size;
175 hdr->type = htons(GNUNET_MESSAGE_TYPE_MESH_HELLO);
176 hdr->size = htons(size);
178 memcpy(hdr+1, handle->hello_message, handle->hello_message_size);
184 * Core calls this if we are connected to a new peer.
186 * The peer is added to the connected_peers-list.
190 core_connect (void *cls,
191 const struct GNUNET_PeerIdentity *peer,
192 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
194 struct GNUNET_MESH_Handle *handle = cls;
196 /* Send a hello to this peer */
197 GNUNET_CORE_notify_transmit_ready(handle->core,
200 GNUNET_TIME_UNIT_SECONDS,
202 sizeof(struct GNUNET_MessageHeader) + handle->hello_message_size,
206 /* put the new peer into the list of connected peers */
207 struct peer_list_element *element =
208 GNUNET_malloc (sizeof (struct peer_list_element));
209 memcpy (&element->peer, peer, sizeof (struct GNUNET_PeerIdentity));
212 memcpy (&element->atsi, atsi,
213 sizeof (struct GNUNET_TRANSPORT_ATS_Information));
215 GNUNET_CONTAINER_DLL_insert_after (handle->connected_peers.head,
216 handle->connected_peers.tail,
217 handle->connected_peers.tail, element);
219 struct tunnel_list_element *tunnel = handle->pending_tunnels.head;
220 while (tunnel != NULL)
223 memcmp (&tunnel->tunnel.peer, peer,
224 sizeof (struct GNUNET_PeerIdentity)))
226 struct tunnel_list_element *next = tunnel->next;
227 GNUNET_CONTAINER_DLL_remove (handle->pending_tunnels.head,
228 handle->pending_tunnels.tail, tunnel);
229 GNUNET_CONTAINER_DLL_insert_after (handle->established_tunnels.head,
230 handle->established_tunnels.tail,
231 handle->established_tunnels.tail,
233 tunnel->tunnel.connect_handler (tunnel->tunnel.handler_cls,
235 GNUNET_SCHEDULER_add_now(send_end_connect, tunnel);
239 tunnel = tunnel->next;
244 * Core calls this if we disconnect a peer
246 * Remove this peer from the list of connected peers
247 * Close all tunnels this peer belongs to
250 core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
252 struct GNUNET_MESH_Handle *handle = cls;
254 struct peer_list_element *element = handle->connected_peers.head;
255 while (element != NULL)
258 memcmp (&element->peer, peer, sizeof (struct GNUNET_PeerIdentity)))
260 element = element->next;
264 GNUNET_CONTAINER_DLL_remove (handle->connected_peers.head,
265 handle->connected_peers.tail, element);
266 GNUNET_free_non_null(element->types);
267 GNUNET_free (element);
270 struct tunnel_list_element *telement = handle->established_tunnels.head;
271 while (telement != NULL)
274 memcmp (&telement->tunnel.peer, peer,
275 sizeof (struct GNUNET_PeerIdentity)))
277 /* disconnect tunnels */
278 /* outbound tunnels */
279 if (telement->tunnel.connect_handler != NULL && NULL != telement->tunnel.disconnect_handler)
280 telement->tunnel.disconnect_handler (telement->tunnel.handler_cls,
282 /* inbound tunnels */
283 else if (NULL != handle->cleaner)
284 handle->cleaner (handle->cls, &telement->tunnel,
285 &telement->tunnel.ctx);
287 struct tunnel_list_element *next = telement->next;
288 GNUNET_CONTAINER_DLL_remove (handle->established_tunnels.head,
289 handle->established_tunnels.tail,
291 GNUNET_free (telement);
296 telement = telement->next;
302 * Receive a message from core.
303 * This is a hello-message, containing the message-types the other peer can receive
306 receive_hello (void *cls,
307 const struct GNUNET_PeerIdentity *other,
308 const struct GNUNET_MessageHeader *message,
309 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
311 struct GNUNET_MESH_Handle *handle = cls;
312 uint16_t *num = (uint16_t *) (message + 1);
313 uint16_t *ports = num + 1;
316 struct peer_list_element *element = handle->connected_peers.head;
317 while (element != NULL)
320 memcmp (&element->peer, other, sizeof (struct GNUNET_PeerIdentity)))
322 element = element->next;
325 /* TODO: add, not replace! */
326 /* TODO: if this changes anything: send new hello */
327 element->num_types = *num;
328 element->types = GNUNET_malloc (*num * sizeof (GNUNET_MESH_ApplicationType));
330 for (i = 0; i < *num; i++)
331 element->types[i] = (GNUNET_MESH_ApplicationType)ntohs (ports[i]);
333 struct tunnel_list_element *tunnel = handle->pending_by_type_tunnels.head;
334 while (tunnel != NULL)
336 struct tunnel_list_element *next = tunnel->next;
337 for (i = 0; i < *num; i++)
339 if (ntohs (ports[i]) == tunnel->tunnel.message_type)
341 GNUNET_CONTAINER_DLL_remove (handle->pending_tunnels.head,
342 handle->pending_tunnels.tail,
344 GNUNET_CONTAINER_DLL_insert_after (handle->established_tunnels.
346 handle->established_tunnels.
348 handle->established_tunnels.
350 tunnel->tunnel.connect_handler (tunnel->tunnel.handler_cls,
351 &tunnel->tunnel.peer, atsi);
352 GNUNET_SCHEDULER_add_now (send_end_connect, tunnel);
356 if (ntohs (ports[i]) == tunnel->tunnel.message_type)
359 tunnel = tunnel->next;
365 * Receive a message from core.
368 core_receive (void *cls,
369 const struct GNUNET_PeerIdentity *other,
370 const struct GNUNET_MessageHeader *message,
371 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
373 struct GNUNET_MESH_Handle *handle = cls;
374 struct tunnel_message *tmessage = (struct tunnel_message *) message;
375 struct GNUNET_MessageHeader *rmessage =
376 (struct GNUNET_MessageHeader *) (tmessage + 1);
378 struct GNUNET_MESH_MessageHandler *handler;
380 for (handler = handle->handlers; handler->callback != NULL; handler++)
382 if ( (ntohs (rmessage->type) == handler->type)
383 && ( (handler->expected_size == 0)
384 || (handler->expected_size == ntohs (rmessage->size))) )
390 /* handler->callback handles this message */
392 /* If no handler was found, drop the message but keep the channel open */
393 if (handler->callback == NULL)
396 struct tunnel_list_element *tunnel = handle->established_tunnels.head;
398 while (tunnel != NULL)
400 if (tunnel->tunnel.id.id == tmessage->id.id &&
402 memcmp (&tmessage->id.initiator, &tunnel->tunnel.id.initiator,
403 sizeof (struct GNUNET_PeerIdentity)))
405 memcmp (&tmessage->id.target, &tunnel->tunnel.id.target,
406 sizeof (struct GNUNET_PeerIdentity))))
408 tunnel = tunnel->next;
411 /* if no tunnel was found: create a new inbound tunnel */
414 tunnel = GNUNET_malloc (sizeof (struct tunnel_list_element));
415 tunnel->tunnel.connect_handler = NULL;
416 tunnel->tunnel.disconnect_handler = NULL;
417 tunnel->tunnel.handler_cls = NULL;
418 tunnel->tunnel.ctx = NULL;
419 tunnel->tunnel.handle = handle;
420 memcpy (&tunnel->tunnel.peer, other,
421 sizeof (struct GNUNET_PeerIdentity));
422 memcpy (&tunnel->tunnel.id, &tmessage->id, sizeof (struct tunnel_id));
424 GNUNET_CONTAINER_DLL_insert_after (handle->established_tunnels.head,
425 handle->established_tunnels.tail,
426 handle->established_tunnels.tail,
430 return handler->callback (handle->cls, &tunnel->tunnel,
431 &tunnel->tunnel.ctx, other, rmessage, atsi);
434 struct GNUNET_MESH_Tunnel *
435 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Handle *handle,
436 struct GNUNET_TIME_Relative timeout,
437 GNUNET_MESH_ApplicationType message_type,
438 GNUNET_MESH_TunnelConnectHandler
440 GNUNET_MESH_TunnelDisconnectHandler
444 /* Look in the list of connected peers */
445 struct peer_list_element *element = handle->connected_peers.head;
446 while (element != NULL)
449 for (i = 0; i < element->num_types; i++)
450 if (message_type == element->types[i])
451 return GNUNET_MESH_peer_request_connect_all (handle, timeout, 1,
456 element = element->next;
459 /* Put into pending list */
460 struct tunnel_list_element *tunnel =
461 GNUNET_malloc (sizeof (struct tunnel_list_element));
463 tunnel->tunnel.connect_handler = connect_handler;
464 tunnel->tunnel.disconnect_handler = disconnect_handler;
465 tunnel->tunnel.handler_cls = handler_cls;
466 tunnel->tunnel.ctx = NULL;
467 tunnel->tunnel.handle = handle;
468 memcpy (&tunnel->tunnel.id.initiator, &handle->myself,
469 sizeof (struct GNUNET_PeerIdentity));
470 tunnel->tunnel.id.id = current_id++;
471 tunnel->tunnel.message_type = message_type;
473 GNUNET_CONTAINER_DLL_insert_after (handle->pending_by_type_tunnels.head,
474 handle->pending_by_type_tunnels.tail,
475 handle->pending_by_type_tunnels.tail,
477 return &tunnel->tunnel;
482 struct GNUNET_MESH_Tunnel *
483 GNUNET_MESH_peer_request_connect_all (struct GNUNET_MESH_Handle *handle,
484 struct GNUNET_TIME_Relative timeout,
485 unsigned int num_peers,
486 const struct GNUNET_PeerIdentity *peers,
487 GNUNET_MESH_TunnelConnectHandler
489 GNUNET_MESH_TunnelDisconnectHandler
490 disconnect_handler, void *handler_cls)
495 struct tunnel_list_element *tunnel =
496 GNUNET_malloc (sizeof (struct tunnel_list_element));
498 tunnel->tunnel.connect_handler = connect_handler;
499 tunnel->tunnel.disconnect_handler = disconnect_handler;
500 tunnel->tunnel.handler_cls = handler_cls;
501 tunnel->tunnel.ctx = NULL;
502 tunnel->tunnel.handle = handle;
503 memcpy (&tunnel->tunnel.id.initiator, &handle->myself,
504 sizeof (struct GNUNET_PeerIdentity));
505 memcpy (&tunnel->tunnel.id.target, peers,
506 sizeof (struct GNUNET_PeerIdentity));
507 tunnel->tunnel.id.id = current_id++;
508 memcpy (&tunnel->tunnel.peer, peers, sizeof(struct GNUNET_PeerIdentity));
510 struct peer_list_element *element = handle->connected_peers.head;
511 while (element != NULL)
514 memcmp (&element->peer, peers, sizeof (struct GNUNET_PeerIdentity)))
516 element = element->next;
521 /* we are connected to this peer */
522 GNUNET_CONTAINER_DLL_insert_after (handle->established_tunnels.head,
523 handle->established_tunnels.tail,
524 handle->established_tunnels.tail,
526 GNUNET_SCHEDULER_add_now(call_connect_handler, tunnel);
529 memcmp (peers, &handle->myself,
530 sizeof (struct GNUNET_PeerIdentity)))
532 /* we are the peer */
533 GNUNET_CONTAINER_DLL_insert_after (handle->established_tunnels.head,
534 handle->established_tunnels.tail,
535 handle->established_tunnels.tail,
537 GNUNET_SCHEDULER_add_now(send_self_connect, tunnel);
541 /* we are not connected to this peer */
542 GNUNET_CONTAINER_DLL_insert_after (handle->pending_tunnels.head,
543 handle->pending_tunnels.tail,
544 handle->pending_tunnels.tail,
546 (void) GNUNET_CORE_peer_request_connect (handle->core,
551 return &tunnel->tunnel;
554 const struct GNUNET_PeerIdentity*
555 GNUNET_MESH_get_peer(const struct GNUNET_MESH_Tunnel* tunnel)
557 return &tunnel->peer;
561 core_notify(void* cls, size_t size, void* buf)
563 struct notify_cls *ncls = cls;
564 struct GNUNET_MESH_Tunnel *tunnel = ncls->tunnel;
565 struct tunnel_message* message = buf;
566 void* cbuf = (void*) &message[1];
567 GNUNET_assert(NULL != ncls->notify);
569 size_t sent = ncls->notify(ncls->notify_cls, size - sizeof(struct tunnel_message), cbuf);
573 if (0 == sent) return 0;
575 sent += sizeof(struct tunnel_message);
577 message->hdr.type = htons(GNUNET_MESSAGE_TYPE_MESH);
578 message->hdr.size = htons(sent);
579 memcpy(&message->id, &tunnel->id, sizeof(struct tunnel_id));
585 * Ask the mesh to call "notify" once it is ready to transmit the
586 * given number of bytes to the specified "target". If we are not yet
587 * connected to the specified peer, a call to this function will cause
588 * us to try to establish a connection.
590 * @param tunnel tunnel to use for transmission
591 * @param cork is corking allowed for this transmission?
592 * @param priority how important is the message?
593 * @param maxdelay how long can the message wait?
594 * @param target destination for the message, NULL for multicast to all tunnel targets
595 * @param notify_size how many bytes of buffer space does notify want?
596 * @param notify function to call when buffer space is available;
597 * will be called with NULL on timeout or if the overall queue
598 * for this peer is larger than queue_size and this is currently
599 * the message with the lowest priority
600 * @param notify_cls closure for notify
601 * @return non-NULL if the notify callback was queued,
602 * NULL if we can not even queue the request (insufficient
603 * memory); if NULL is returned, "notify" will NOT be called.
605 struct GNUNET_MESH_TransmitHandle *
606 GNUNET_MESH_notify_transmit_ready (struct
614 const struct GNUNET_PeerIdentity *target,
617 GNUNET_CONNECTION_TransmitReadyNotify
618 notify, void *notify_cls)
620 struct notify_cls *cls = GNUNET_malloc(sizeof(struct notify_cls));
621 cls->notify_cls = notify_cls;
622 GNUNET_assert(NULL != notify);
623 cls->notify = notify;
624 cls->tunnel = tunnel;
625 GNUNET_CORE_notify_transmit_ready(tunnel->handle->core,
630 notify_size + sizeof(struct tunnel_message),
634 /* aborting is not implemented yet */
635 return (struct GNUNET_MESH_TransmitHandle*) 1;
638 void build_hello_message(struct GNUNET_MESH_Handle* handle, int num)
640 handle->hello_message_size = sizeof(uint16_t) + /* For the number of types */
641 num * sizeof(uint16_t); /* For the types */
643 uint16_t *nums = GNUNET_malloc(handle->hello_message_size);
644 uint16_t *types = nums + 1;
649 for(i = 0; i < num; i++)
650 types[i] = handle->handlers[i].type;
652 handle->hello_message = nums;
656 struct GNUNET_MESH_Handle *
657 GNUNET_MESH_connect (const struct
658 GNUNET_CONFIGURATION_Handle
660 GNUNET_MESH_TunnelEndHandler
662 const struct GNUNET_MESH_MessageHandler *handlers,
663 const GNUNET_MESH_ApplicationType *stypes)
665 struct GNUNET_MESH_Handle *ret =
666 GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
668 ret->connected_to_core = GNUNET_NO;
669 ret->connected_peers.head = NULL;
670 ret->connected_peers.tail = NULL;
671 ret->cleaner = cleaner;
674 const struct GNUNET_MESH_MessageHandler *it;
675 unsigned int len = 1;
676 for (it = handlers; it->callback != NULL; it++)
682 GNUNET_malloc (len * sizeof (struct GNUNET_MESH_MessageHandler));
683 memset(ret->handlers, 0, len * sizeof(struct GNUNET_MESH_MessageHandler));
684 memcpy (ret->handlers, handlers,
685 len * sizeof (struct GNUNET_MESH_MessageHandler));
687 build_hello_message(ret, len);
689 const static struct GNUNET_CORE_MessageHandler core_handlers[] = {
690 {&core_receive, GNUNET_MESSAGE_TYPE_MESH, 0},
691 {&receive_hello, GNUNET_MESSAGE_TYPE_MESH_HELLO, 0},
695 ret->core = GNUNET_CORE_connect (cfg,
703 GNUNET_NO, NULL, GNUNET_NO, core_handlers);
708 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
710 GNUNET_free (handle->handlers);
711 GNUNET_free (handle->hello_message);
712 GNUNET_CORE_disconnect (handle->core);
714 struct peer_list_element *element = handle->connected_peers.head;
715 while (element != NULL)
717 struct peer_list_element *next = element->next;
718 GNUNET_free_non_null(element->types);
719 GNUNET_free (element);
723 struct tunnel_list_element *tunnel = handle->pending_tunnels.head;
724 while (tunnel != NULL)
726 struct tunnel_list_element *next = tunnel->next;
727 GNUNET_free (tunnel);
730 tunnel = handle->established_tunnels.head;;
731 while (tunnel != NULL)
733 struct tunnel_list_element *next = tunnel->next;
734 GNUNET_free (tunnel);
738 GNUNET_free (handle);
741 /* end of mesh_api.c */