- remove explicit keepalive rest
[oweals/gnunet.git] / src / mesh / gnunet-service-mesh_peer.c
1 /*
2      This file is part of GNUnet.
3      (C) 2013 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21
22 #include "platform.h"
23 #include "gnunet_util_lib.h"
24
25 #include "gnunet_transport_service.h"
26 #include "gnunet_core_service.h"
27 #include "gnunet_statistics_service.h"
28
29 #include "mesh_protocol.h"
30
31 #include "gnunet-service-mesh_peer.h"
32 #include "gnunet-service-mesh_dht.h"
33 #include "gnunet-service-mesh_connection.h"
34 #include "gnunet-service-mesh_tunnel.h"
35 #include "mesh_path.h"
36
37 #define LOG(level, ...) GNUNET_log_from (level,"mesh-p2p",__VA_ARGS__)
38
39 /******************************************************************************/
40 /********************************   STRUCTS  **********************************/
41 /******************************************************************************/
42
43 /**
44  * Struct containing info about a queued transmission to this peer
45  */
46 struct MeshPeerQueue
47 {
48     /**
49       * DLL next
50       */
51   struct MeshPeerQueue *next;
52
53     /**
54       * DLL previous
55       */
56   struct MeshPeerQueue *prev;
57
58     /**
59      * Peer this transmission is directed to.
60      */
61   struct MeshPeer *peer;
62
63     /**
64      * Connection this message belongs to.
65      */
66   struct MeshConnection *c;
67
68     /**
69      * Is FWD in c?
70      */
71   int fwd;
72
73     /**
74      * Pointer to info stucture used as cls.
75      */
76   void *cls;
77
78     /**
79      * Type of message
80      */
81   uint16_t type;
82
83     /**
84      * Size of the message
85      */
86   size_t size;
87
88     /**
89      * Set when this message starts waiting for CORE.
90      */
91   struct GNUNET_TIME_Absolute start_waiting;
92
93     /**
94      * Function to call on sending.
95      */
96   GMP_sent callback;
97
98     /**
99      * Closure for callback.
100      */
101   void *callback_cls;
102 };
103
104 /**
105  * Struct containing all information regarding a given peer
106  */
107 struct MeshPeer
108 {
109     /**
110      * ID of the peer
111      */
112   GNUNET_PEER_Id id;
113
114     /**
115      * Last time we heard from this peer
116      */
117   struct GNUNET_TIME_Absolute last_contact;
118
119     /**
120      * Paths to reach the peer, ordered by ascending hop count
121      */
122   struct MeshPeerPath *path_head;
123
124     /**
125      * Paths to reach the peer, ordered by ascending hop count
126      */
127   struct MeshPeerPath *path_tail;
128
129     /**
130      * Handle to stop the DHT search for paths to this peer
131      */
132   struct GMD_search_handle *search_h;
133
134     /**
135      * Tunnel to this peer, if any.
136      */
137   struct MeshTunnel3 *tunnel;
138
139     /**
140      * Connections that go through this peer, indexed by tid;
141      */
142   struct GNUNET_CONTAINER_MultiHashMap *connections;
143
144     /**
145      * Handle for queued transmissions
146      */
147   struct GNUNET_CORE_TransmitHandle *core_transmit;
148
149   /**
150    * Transmission queue to core DLL head
151    */
152   struct MeshPeerQueue *queue_head;
153
154   /**
155    * Transmission queue to core DLL tail
156    */
157   struct MeshPeerQueue *queue_tail;
158
159   /**
160    * How many messages are in the queue to this peer.
161    */
162   unsigned int queue_n;
163
164   /**
165    * Hello message.
166    */
167   struct GNUNET_HELLO_Message* hello;
168 };
169
170
171 /******************************************************************************/
172 /*******************************   GLOBALS  ***********************************/
173 /******************************************************************************/
174
175 /**
176  * Global handle to the statistics service.
177  */
178 extern struct GNUNET_STATISTICS_Handle *stats;
179
180 /**
181  * Local peer own ID (full value).
182  */
183 extern struct GNUNET_PeerIdentity my_full_id;
184
185 /**
186  * Local peer own ID (short)
187  */
188 extern GNUNET_PEER_Id myid;
189
190 /**
191  * Peers known, indexed by PeerIdentity (MeshPeer).
192  */
193 static struct GNUNET_CONTAINER_MultiPeerMap *peers;
194
195 /**
196  * How many peers do we want to remember?
197  */
198 static unsigned long long max_peers;
199
200 /**
201  * Percentage of messages that will be dropped (for test purposes only).
202  */
203 static unsigned long long drop_percent;
204
205 /**
206  * Handle to communicate with core.
207  */
208 static struct GNUNET_CORE_Handle *core_handle;
209
210 /**
211  * Handle to try to start new connections.
212  */
213 static struct GNUNET_TRANSPORT_Handle *transport_handle;
214
215 /******************************************************************************/
216 /***************************** CORE CALLBACKS *********************************/
217 /******************************************************************************/
218
219
220 /**
221  * Iterator to notify all connections of a broken link. Mark connections
222  * to destroy after all traffic has been sent.
223  *
224  * @param cls Closure (peer disconnected).
225  * @param key Current key code (peer id).
226  * @param value Value in the hash map (connection).
227  *
228  * @return #GNUNET_YES to continue to iterate.
229  */
230 static int
231 notify_broken (void *cls,
232                const struct GNUNET_HashCode *key,
233                void *value)
234 {
235   struct MeshPeer *peer = cls;
236   struct MeshConnection *c = value;
237
238   LOG (GNUNET_ERROR_TYPE_DEBUG, "  notifying %s due to %s\n",
239        GMC_2s (c), GMP_2s (peer));
240   GMC_notify_broken (c, peer);
241
242   return GNUNET_YES;
243 }
244
245
246 /**
247  * Remove the direct path to the peer.
248  *
249  * @param peer Peer to remove the direct path from.
250  *
251  */
252 static struct MeshPeerPath *
253 pop_direct_path (struct MeshPeer *peer)
254 {
255   struct MeshPeerPath *iter;
256
257   for (iter = peer->path_head; NULL != iter; iter = iter->next)
258   {
259     if (2 <= iter->length)
260     {
261       GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, iter);
262       return iter;
263     }
264   }
265   return NULL;
266 }
267
268
269
270 /**
271  * Method called whenever a given peer connects.
272  *
273  * @param cls closure
274  * @param peer peer identity this notification is about
275  */
276 static void
277 core_connect (void *cls, const struct GNUNET_PeerIdentity *peer)
278 {
279   struct MeshPeer *mp;
280   struct MeshPeerPath *path;
281   char own_id[16];
282
283   strncpy (own_id, GNUNET_i2s (&my_full_id), 15);
284   mp = GMP_get (peer);
285   if (myid == mp->id)
286   {
287     LOG (GNUNET_ERROR_TYPE_INFO, "CONNECTED %s (self)\n", own_id);
288     path = path_new (1);
289   }
290   else
291   {
292     LOG (GNUNET_ERROR_TYPE_DEBUG, "CONNECTED %s <= %s\n",
293          own_id, GNUNET_i2s (peer));
294     path = path_new (2);
295     path->peers[1] = mp->id;
296     GNUNET_PEER_change_rc (mp->id, 1);
297     GNUNET_STATISTICS_update (stats, "# peers", 1, GNUNET_NO);
298   }
299   path->peers[0] = myid;
300   GNUNET_PEER_change_rc (myid, 1);
301   GMP_add_path (mp, path, GNUNET_YES);
302
303   mp->connections = GNUNET_CONTAINER_multihashmap_create (32, GNUNET_YES);
304   return;
305 }
306
307
308 /**
309  * Method called whenever a peer disconnects.
310  *
311  * @param cls closure
312  * @param peer peer identity this notification is about
313  */
314 static void
315 core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
316 {
317   struct MeshPeer *p;
318   struct MeshPeerPath *direct_path;
319   char own_id[16];
320
321   strncpy (own_id, GNUNET_i2s (&my_full_id), 15);
322   p = GNUNET_CONTAINER_multipeermap_get (peers, peer);
323   if (NULL == p)
324   {
325     GNUNET_break (0);
326     return;
327   }
328   if (myid == p->id)
329     LOG (GNUNET_ERROR_TYPE_INFO, "DISCONNECTED %s (self)\n", own_id);
330   else
331     LOG (GNUNET_ERROR_TYPE_DEBUG, "DISCONNECTED %s <= %s\n",
332          own_id, GNUNET_i2s (peer));
333   direct_path = pop_direct_path (p);
334   GNUNET_CONTAINER_multihashmap_iterate (p->connections, &notify_broken, p);
335   GNUNET_CONTAINER_multihashmap_destroy (p->connections);
336   p->connections = NULL;
337   if (NULL != p->core_transmit)
338     {
339       GNUNET_CORE_notify_transmit_ready_cancel (p->core_transmit);
340       p->core_transmit = NULL;
341     }
342   GNUNET_STATISTICS_update (stats, "# peers", -1, GNUNET_NO);
343
344   path_destroy (direct_path);
345   return;
346 }
347
348
349 /**
350  * Functions to handle messages from core
351  */
352 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
353   {&GMC_handle_create, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE, 0},
354   {&GMC_handle_confirm, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK,
355     sizeof (struct GNUNET_MESH_ConnectionACK)},
356   {&GMC_handle_broken, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN,
357     sizeof (struct GNUNET_MESH_ConnectionBroken)},
358   {&GMC_handle_destroy, GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY,
359     sizeof (struct GNUNET_MESH_ConnectionDestroy)},
360   {&GMC_handle_ack, GNUNET_MESSAGE_TYPE_MESH_ACK,
361     sizeof (struct GNUNET_MESH_ACK)},
362   {&GMC_handle_poll, GNUNET_MESSAGE_TYPE_MESH_POLL,
363     sizeof (struct GNUNET_MESH_Poll)},
364   {&GMC_handle_encrypted, GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED, 0},
365   {&GMC_handle_kx, GNUNET_MESSAGE_TYPE_MESH_KX, 0},
366   {NULL, 0, 0}
367 };
368
369
370 /**
371  * To be called on core init/fail.
372  *
373  * @param cls Closure (config)
374  * @param identity the public identity of this peer
375  */
376 static void
377 core_init (void *cls,
378            const struct GNUNET_PeerIdentity *identity)
379 {
380   const struct GNUNET_CONFIGURATION_Handle *c = cls;
381   static int i = 0;
382
383   LOG (GNUNET_ERROR_TYPE_DEBUG, "Core init\n");
384   if (0 != memcmp (identity, &my_full_id, sizeof (my_full_id)))
385   {
386     LOG (GNUNET_ERROR_TYPE_ERROR, _("Wrong CORE service\n"));
387     LOG (GNUNET_ERROR_TYPE_ERROR, " core id %s\n", GNUNET_i2s (identity));
388     LOG (GNUNET_ERROR_TYPE_ERROR, " my id %s\n", GNUNET_i2s (&my_full_id));
389     GNUNET_CORE_disconnect (core_handle);
390     core_handle = GNUNET_CORE_connect (c, /* Main configuration */
391                                        NULL,      /* Closure passed to MESH functions */
392                                        &core_init,        /* Call core_init once connected */
393                                        &core_connect,     /* Handle connects */
394                                        &core_disconnect,  /* remove peers on disconnects */
395                                        NULL,      /* Don't notify about all incoming messages */
396                                        GNUNET_NO, /* For header only in notification */
397                                        NULL,      /* Don't notify about all outbound messages */
398                                        GNUNET_NO, /* For header-only out notification */
399                                        core_handlers);    /* Register these handlers */
400     if (10 < i++)
401       GNUNET_abort();
402   }
403   GML_start ();
404   return;
405 }
406
407 /**
408   * Core callback to write a pre-constructed data packet to core buffer
409   *
410   * @param cls Closure (MeshTransmissionDescriptor with data in "data" member).
411   * @param size Number of bytes available in buf.
412   * @param buf Where the to write the message.
413   *
414   * @return number of bytes written to buf
415   */
416 static size_t
417 send_core_data_raw (void *cls, size_t size, void *buf)
418 {
419   struct GNUNET_MessageHeader *msg = cls;
420   size_t total_size;
421
422   GNUNET_assert (NULL != msg);
423   total_size = ntohs (msg->size);
424
425   if (total_size > size)
426   {
427     GNUNET_break (0);
428     return 0;
429   }
430   memcpy (buf, msg, total_size);
431   GNUNET_free (cls);
432   return total_size;
433 }
434
435
436 /**
437  * Function to send a create connection message to a peer.
438  *
439  * @param c Connection to create.
440  * @param size number of bytes available in buf
441  * @param buf where the callee should write the message
442  * @return number of bytes written to buf
443  */
444 static size_t
445 send_core_connection_create (struct MeshConnection *c, size_t size, void *buf)
446 {
447   struct GNUNET_MESH_ConnectionCreate *msg;
448   struct GNUNET_PeerIdentity *peer_ptr;
449   const struct MeshPeerPath *p = GMC_get_path (c);
450   size_t size_needed;
451   int i;
452
453   if (NULL == p)
454     return 0;
455
456   LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION CREATE...\n");
457   size_needed =
458       sizeof (struct GNUNET_MESH_ConnectionCreate) +
459       p->length * sizeof (struct GNUNET_PeerIdentity);
460
461   if (size < size_needed || NULL == buf)
462   {
463     GNUNET_break (0);
464     return 0;
465   }
466   msg = (struct GNUNET_MESH_ConnectionCreate *) buf;
467   msg->header.size = htons (size_needed);
468   msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE);
469   msg->cid = *GMC_get_id (c);
470
471   peer_ptr = (struct GNUNET_PeerIdentity *) &msg[1];
472   for (i = 0; i < p->length; i++)
473   {
474     GNUNET_PEER_resolve (p->peers[i], peer_ptr++);
475   }
476
477   LOG (GNUNET_ERROR_TYPE_DEBUG,
478        "CONNECTION CREATE (%u bytes long) sent!\n",
479        size_needed);
480   return size_needed;
481 }
482
483
484 /**
485  * Creates a path ack message in buf and frees all unused resources.
486  *
487  * @param c Connection to send an ACK on.
488  * @param size number of bytes available in buf
489  * @param buf where the callee should write the message
490  *
491  * @return number of bytes written to buf
492  */
493 static size_t
494 send_core_connection_ack (struct MeshConnection *c, size_t size, void *buf)
495 {
496   struct GNUNET_MESH_ConnectionACK *msg = buf;
497
498   LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending CONNECTION ACK...\n");
499   if (sizeof (struct GNUNET_MESH_ConnectionACK) > size)
500   {
501     GNUNET_break (0);
502     return 0;
503   }
504   msg->header.size = htons (sizeof (struct GNUNET_MESH_ConnectionACK));
505   msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK);
506   msg->cid = *GMC_get_id (c);
507
508   LOG (GNUNET_ERROR_TYPE_DEBUG, "CONNECTION ACK sent!\n");
509   return sizeof (struct GNUNET_MESH_ConnectionACK);
510 }
511
512
513 /******************************************************************************/
514 /********************************   STATIC  ***********************************/
515 /******************************************************************************/
516
517
518 /**
519  * Get priority for a queued message.
520  *
521  * @param q Queued message
522  *
523  * @return CORE priority to use.
524  */
525 static enum GNUNET_CORE_Priority
526 get_priority (struct MeshPeerQueue *q)
527 {
528   enum GNUNET_CORE_Priority low;
529   enum GNUNET_CORE_Priority high;
530
531   if (NULL == q)
532   {
533     GNUNET_break (0);
534     return GNUNET_CORE_PRIO_BACKGROUND;
535   }
536
537   /* Relayed traffic has lower priority, our own traffic has higher */
538   if (NULL == q->c || GNUNET_NO == GMC_is_origin (q->c, q->fwd))
539   {
540     low = GNUNET_CORE_PRIO_BEST_EFFORT;
541     high = GNUNET_CORE_PRIO_URGENT;
542   }
543   else
544   {
545     low = GNUNET_CORE_PRIO_URGENT;
546     high = GNUNET_CORE_PRIO_CRITICAL_CONTROL;
547   }
548
549   /* Bulky payload has lower priority, control traffic has higher. */
550   if (GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED == q->type)
551     return low;
552   else
553     return high;
554 }
555
556
557 /**
558  * Iterator over tunnel hash map entries to destroy the tunnel during shutdown.
559  *
560  * @param cls closure
561  * @param key current key code
562  * @param value value in the hash map
563  * @return #GNUNET_YES if we should continue to iterate,
564  *         #GNUNET_NO if not.
565  */
566 static int
567 shutdown_tunnel (void *cls,
568                  const struct GNUNET_PeerIdentity *key,
569                  void *value)
570 {
571   struct MeshPeer *p = value;
572   struct MeshTunnel3 *t = p->tunnel;
573
574   if (NULL != t)
575     GMT_destroy (t);
576   return GNUNET_YES;
577 }
578
579
580 /**
581  * Destroy the peer_info and free any allocated resources linked to it
582  *
583  * @param peer The peer_info to destroy.
584  *
585  * @return GNUNET_OK on success
586  */
587 static int
588 peer_destroy (struct MeshPeer *peer)
589 {
590   struct GNUNET_PeerIdentity id;
591   struct MeshPeerPath *p;
592   struct MeshPeerPath *nextp;
593
594   GNUNET_PEER_resolve (peer->id, &id);
595   GNUNET_PEER_change_rc (peer->id, -1);
596
597   LOG (GNUNET_ERROR_TYPE_WARNING, "destroying peer %s\n", GNUNET_i2s (&id));
598
599   if (GNUNET_YES !=
600     GNUNET_CONTAINER_multipeermap_remove (peers, &id, peer))
601   {
602     GNUNET_break (0);
603     LOG (GNUNET_ERROR_TYPE_WARNING, " not in peermap!!\n");
604   }
605   if (NULL != peer->search_h)
606   {
607     GMD_search_stop (peer->search_h);
608   }
609   p = peer->path_head;
610   while (NULL != p)
611   {
612     nextp = p->next;
613     GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, p);
614     path_destroy (p);
615     p = nextp;
616   }
617   GMT_destroy_empty (peer->tunnel);
618   GNUNET_free (peer);
619   return GNUNET_OK;
620 }
621
622
623 /**
624  * Returns if peer is used (has a tunnel or is neighbor).
625  *
626  * @param peer Peer to check.
627  *
628  * @return #GNUNET_YES if peer is in use.
629  */
630 static int
631 peer_is_used (struct MeshPeer *peer)
632 {
633   struct MeshPeerPath *p;
634
635   if (NULL != peer->tunnel)
636     return GNUNET_YES;
637
638   for (p = peer->path_head; NULL != p; p = p->next)
639   {
640     if (p->length < 3)
641       return GNUNET_YES;
642   }
643     return GNUNET_NO;
644 }
645
646
647 /**
648  * Iterator over all the peers to get the oldest timestamp.
649  *
650  * @param cls Closure (unsued).
651  * @param key ID of the peer.
652  * @param value Peer_Info of the peer.
653  */
654 static int
655 peer_get_oldest (void *cls,
656                  const struct GNUNET_PeerIdentity *key,
657                  void *value)
658 {
659   struct MeshPeer *p = value;
660   struct GNUNET_TIME_Absolute *abs = cls;
661
662   /* Don't count active peers */
663   if (GNUNET_YES == peer_is_used (p))
664     return GNUNET_YES;
665
666   if (abs->abs_value_us < p->last_contact.abs_value_us)
667     abs->abs_value_us = p->last_contact.abs_value_us;
668
669   return GNUNET_YES;
670 }
671
672
673 /**
674  * Iterator over all the peers to remove the oldest entry.
675  *
676  * @param cls Closure (unsued).
677  * @param key ID of the peer.
678  * @param value Peer_Info of the peer.
679  */
680 static int
681 peer_timeout (void *cls,
682               const struct GNUNET_PeerIdentity *key,
683               void *value)
684 {
685   struct MeshPeer *p = value;
686   struct GNUNET_TIME_Absolute *abs = cls;
687
688   LOG (GNUNET_ERROR_TYPE_WARNING,
689        "peer %s timeout\n", GNUNET_i2s (key));
690
691   if (p->last_contact.abs_value_us == abs->abs_value_us &&
692       GNUNET_NO == peer_is_used (p))
693   {
694     peer_destroy (p);
695     return GNUNET_NO;
696   }
697     return GNUNET_YES;
698 }
699
700
701 /**
702  * Delete oldest unused peer.
703  */
704 static void
705 peer_delete_oldest (void)
706 {
707   struct GNUNET_TIME_Absolute abs;
708
709   abs = GNUNET_TIME_UNIT_FOREVER_ABS;
710
711   GNUNET_CONTAINER_multipeermap_iterate (peers,
712                                          &peer_get_oldest,
713                                          &abs);
714   GNUNET_CONTAINER_multipeermap_iterate (peers,
715                                          &peer_timeout,
716                                          &abs);
717 }
718
719
720 /**
721  * Choose the best (yet unused) path towards a peer,
722  * considering the tunnel properties.
723  *
724  * @param peer The destination peer.
725  *
726  * @return Best current known path towards the peer, if any.
727  */
728 static struct MeshPeerPath *
729 peer_get_best_path (const struct MeshPeer *peer)
730 {
731   struct MeshPeerPath *best_p;
732   struct MeshPeerPath *p;
733   unsigned int best_cost;
734   unsigned int cost;
735
736   best_cost = UINT_MAX;
737   best_p = NULL;
738   for (p = peer->path_head; NULL != p; p = p->next)
739   {
740     if (GNUNET_YES == GMT_is_path_used (peer->tunnel, p))
741       continue; /* If path is already in use, skip it. */
742
743     if (GNUNET_NO == path_is_valid (p))
744       continue; /* Don't use invalid paths. */
745
746     if ((cost = GMT_get_path_cost (peer->tunnel, p)) < best_cost)
747     {
748       best_cost = cost;
749       best_p = p;
750     }
751   }
752   return best_p;
753 }
754
755
756 static int
757 queue_is_sendable (struct MeshPeerQueue *q)
758 {
759   /* Is PID-independent? */
760   switch (q->type)
761   {
762     case GNUNET_MESSAGE_TYPE_MESH_ACK:
763     case GNUNET_MESSAGE_TYPE_MESH_POLL:
764     case GNUNET_MESSAGE_TYPE_MESH_KX:
765     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
766     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
767     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
768     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
769     case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
770       return GNUNET_YES;
771
772     case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
773       break;
774
775     default:
776       GNUNET_break (0);
777   }
778
779   if (GMC_is_sendable (q->c, q->fwd))
780     return GNUNET_YES;
781
782   return GNUNET_NO;
783 }
784
785
786 /**
787  * Get first sendable message.
788  *
789  * @param peer The destination peer.
790  *
791  * @return Best current known path towards the peer, if any.
792  */
793 static struct MeshPeerQueue *
794 peer_get_first_message (const struct MeshPeer *peer)
795 {
796   struct MeshPeerQueue *q;
797
798   for (q = peer->queue_head; NULL != q; q = q->next)
799   {
800     if (queue_is_sendable (q))
801       return q;
802   }
803
804   return NULL;
805 }
806
807
808 /**
809  * Function to process paths received for a new peer addition. The recorded
810  * paths form the initial tunnel, which can be optimized later.
811  * Called on each result obtained for the DHT search.
812  *
813  * @param cls closure
814  * @param path
815  */
816 static void
817 search_handler (void *cls, const struct MeshPeerPath *path)
818 {
819   struct MeshPeer *peer = cls;
820   unsigned int connection_count;
821
822   GMP_add_path_to_all (path, GNUNET_NO);
823
824   /* Count connections */
825   connection_count = GMT_count_connections (peer->tunnel);
826
827   /* If we already have 3 (or more (?!)) connections, it's enough */
828   if (3 <= connection_count)
829     return;
830
831   if (MESH_TUNNEL3_SEARCHING == GMT_get_cstate (peer->tunnel))
832   {
833     LOG (GNUNET_ERROR_TYPE_DEBUG, " ... connect!\n");
834     GMP_connect (peer);
835   }
836   return;
837 }
838
839
840
841 /**
842  * Core callback to write a queued packet to core buffer
843  *
844  * @param cls Closure (peer info).
845  * @param size Number of bytes available in buf.
846  * @param buf Where the to write the message.
847  *
848  * @return number of bytes written to buf
849  */
850 static size_t
851 queue_send (void *cls, size_t size, void *buf)
852 {
853   struct MeshPeer *peer = cls;
854   struct MeshConnection *c;
855   struct MeshPeerQueue *queue;
856   const struct GNUNET_PeerIdentity *dst_id;
857   size_t data_size;
858
859   peer->core_transmit = NULL;
860   LOG (GNUNET_ERROR_TYPE_DEBUG, "* Queue send towards %s (max %u)\n",
861        GMP_2s (peer), size);
862
863   if (NULL == buf || 0 == size)
864   {
865     LOG (GNUNET_ERROR_TYPE_DEBUG, "* Buffer size 0.\n");
866     return 0;
867   }
868
869   /* Initialize */
870   queue = peer_get_first_message (peer);
871   if (NULL == queue)
872   {
873     GNUNET_break (0); /* Core tmt_rdy should've been canceled */
874     return 0;
875   }
876   c = queue->c;
877
878   dst_id = GNUNET_PEER_resolve2 (peer->id);
879   LOG (GNUNET_ERROR_TYPE_DEBUG, "*   on connection %s\n", GMC_2s (c));
880   /* Check if buffer size is enough for the message */
881   if (queue->size > size)
882   {
883     LOG (GNUNET_ERROR_TYPE_WARNING, "not enough room (%u vs %u), reissue\n",
884          queue->size, size);
885     peer->core_transmit =
886       GNUNET_CORE_notify_transmit_ready (core_handle,
887                                          GNUNET_NO, get_priority (queue),
888                                          GNUNET_TIME_UNIT_FOREVER_REL,
889                                          dst_id,
890                                          queue->size,
891                                          &queue_send,
892                                          peer);
893     return 0;
894   }
895   LOG (GNUNET_ERROR_TYPE_DEBUG, "*   size %u ok\n", queue->size);
896
897   /* Fill buf */
898   switch (queue->type)
899   {
900     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
901     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
902     case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
903     case GNUNET_MESSAGE_TYPE_MESH_KX:
904     case GNUNET_MESSAGE_TYPE_MESH_ACK:
905     case GNUNET_MESSAGE_TYPE_MESH_POLL:
906       LOG (GNUNET_ERROR_TYPE_DEBUG, "*   raw: %s\n", GM_m2s (queue->type));
907       data_size = send_core_data_raw (queue->cls, size, buf);
908       break;
909     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
910       LOG (GNUNET_ERROR_TYPE_DEBUG, "*   path create\n");
911       if (GMC_is_origin (c, GNUNET_YES))
912         data_size = send_core_connection_create (queue->c, size, buf);
913       else
914         data_size = send_core_data_raw (queue->cls, size, buf);
915       break;
916     case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
917       LOG (GNUNET_ERROR_TYPE_DEBUG, "*   path ack\n");
918       if (GMC_is_origin (c, GNUNET_NO) ||
919           GMC_is_origin (c, GNUNET_YES))
920         data_size = send_core_connection_ack (queue->c, size, buf);
921       else
922         data_size = send_core_data_raw (queue->cls, size, buf);
923       break;
924     case GNUNET_MESSAGE_TYPE_MESH_DATA:
925     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_CREATE:
926     case GNUNET_MESSAGE_TYPE_MESH_CHANNEL_DESTROY:
927       /* This should be encapsulted */
928       GNUNET_break (0);
929       data_size = 0;
930       break;
931     default:
932       GNUNET_break (0);
933       LOG (GNUNET_ERROR_TYPE_WARNING, "*   type unknown: %u\n", queue->type);
934       data_size = 0;
935   }
936
937   if (0 < drop_percent &&
938       GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 101) < drop_percent)
939   {
940     LOG (GNUNET_ERROR_TYPE_WARNING, "DD %s on connection\n",
941          GM_m2s (queue->type), GMC_2s (c));
942     data_size = 0;
943   }
944   else
945   {
946     LOG (GNUNET_ERROR_TYPE_INFO,
947         "ss %s on connection %s (%p) %s (size %u)\n",
948         GM_m2s (queue->type), GMC_2s (c), c, GM_f2s (queue->fwd), data_size);
949   }
950
951   /* Free queue, but cls was freed by send_core_* */
952   GMP_queue_destroy (queue, GNUNET_NO);
953
954   /* If more data in queue, send next */
955   queue = peer_get_first_message (peer);
956   if (NULL != queue)
957   {
958     LOG (GNUNET_ERROR_TYPE_DEBUG, "*   more data!\n");
959     if (NULL == peer->core_transmit)
960     {
961       peer->core_transmit =
962           GNUNET_CORE_notify_transmit_ready (core_handle,
963                                              GNUNET_NO, get_priority (queue),
964                                              GNUNET_TIME_UNIT_FOREVER_REL,
965                                              dst_id,
966                                              queue->size,
967                                              &queue_send,
968                                              peer);
969       queue->start_waiting = GNUNET_TIME_absolute_get ();
970     }
971     else
972     {
973       LOG (GNUNET_ERROR_TYPE_DEBUG,
974                   "*   tmt rdy called somewhere else\n");
975     }
976 //     GMC_start_poll (); FIXME needed?
977   }
978   else
979   {
980 //     GMC_stop_poll(); FIXME needed?
981   }
982
983   LOG (GNUNET_ERROR_TYPE_DEBUG, "*  Return %d\n", data_size);
984   return data_size;
985 }
986
987
988 /******************************************************************************/
989 /********************************    API    ***********************************/
990 /******************************************************************************/
991
992
993 /**
994  * Free a transmission that was already queued with all resources
995  * associated to the request.
996  *
997  * @param queue Queue handler to cancel.
998  * @param clear_cls Is it necessary to free associated cls?
999  */
1000 void
1001 GMP_queue_destroy (struct MeshPeerQueue *queue, int clear_cls)
1002 {
1003   struct MeshPeer *peer;
1004
1005   peer = queue->peer;
1006
1007   if (GNUNET_YES == clear_cls)
1008   {
1009     LOG (GNUNET_ERROR_TYPE_DEBUG, "#   queue destroy type %s\n",
1010                 GM_m2s (queue->type));
1011     switch (queue->type)
1012     {
1013       case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_DESTROY:
1014         LOG (GNUNET_ERROR_TYPE_INFO, "destroying a DESTROY message\n");
1015         /* fall through */
1016       case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_ACK:
1017       case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_CREATE:
1018       case GNUNET_MESSAGE_TYPE_MESH_CONNECTION_BROKEN:
1019       case GNUNET_MESSAGE_TYPE_MESH_KEEPALIVE:
1020       case GNUNET_MESSAGE_TYPE_MESH_KX:
1021       case GNUNET_MESSAGE_TYPE_MESH_ENCRYPTED:
1022       case GNUNET_MESSAGE_TYPE_MESH_ACK:
1023       case GNUNET_MESSAGE_TYPE_MESH_POLL:
1024         GNUNET_free_non_null (queue->cls);
1025         break;
1026
1027       default:
1028         GNUNET_break (0);
1029         LOG (GNUNET_ERROR_TYPE_ERROR, "#   type %s unknown!\n",
1030                     GM_m2s (queue->type));
1031     }
1032   }
1033   GNUNET_CONTAINER_DLL_remove (peer->queue_head, peer->queue_tail, queue);
1034
1035   if (queue->type != GNUNET_MESSAGE_TYPE_MESH_ACK &&
1036       queue->type != GNUNET_MESSAGE_TYPE_MESH_POLL)
1037   {
1038     peer->queue_n--;
1039   }
1040
1041   if (NULL != queue->callback)
1042   {
1043     LOG (GNUNET_ERROR_TYPE_DEBUG, "#   Calling callback\n");
1044     queue->callback (queue->callback_cls,
1045                      queue->c, queue->type,
1046                      queue->fwd, queue->size,
1047                      GNUNET_TIME_absolute_get_duration (queue->start_waiting));
1048   }
1049
1050   GNUNET_free (queue);
1051 }
1052
1053
1054 /**
1055  * @brief Queue and pass message to core when possible.
1056  *
1057  * @param peer Peer towards which to queue the message.
1058  * @param cls Closure (@c type dependant). It will be used by queue_send to
1059  *            build the message to be sent if not already prebuilt.
1060  * @param type Type of the message, 0 for a raw message.
1061  * @param size Size of the message.
1062  * @param c Connection this message belongs to (can be NULL).
1063  * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
1064  * @param cont Continuation to be called once CORE has taken the message.
1065  * @param cont_cls Closure for @c cont.
1066  *
1067  * @return Handle to cancel the message before it is sent. Once cont is called
1068  *         message has been sent and therefore the handle is no longer valid.
1069  */
1070 struct MeshPeerQueue *
1071 GMP_queue_add (struct MeshPeer *peer, void *cls, uint16_t type, size_t size,
1072                struct MeshConnection *c, int fwd,
1073                GMP_sent cont, void *cont_cls)
1074 {
1075   struct MeshPeerQueue *queue;
1076   int priority;
1077   int call_core;
1078
1079   LOG (GNUNET_ERROR_TYPE_INFO, "qq %s on connection %s (%p) %s towards %s (size %u)\n",
1080        GM_m2s (type), GMC_2s (c), c, GM_f2s (fwd), GMP_2s(peer), size);
1081
1082   if (NULL == peer->connections)
1083   {
1084     /* We are not connected to this peer, ignore request. */
1085     LOG (GNUNET_ERROR_TYPE_DEBUG, "WARNING %s not a neighbor\n", GMP_2s (peer));
1086     GNUNET_STATISTICS_update (stats, "# messages dropped due to wrong hop", 1,
1087                               GNUNET_NO);
1088     return NULL;
1089   }
1090
1091   priority = 0;
1092
1093   if (GNUNET_MESSAGE_TYPE_MESH_POLL == type ||
1094       GNUNET_MESSAGE_TYPE_MESH_ACK == type)
1095   {
1096     priority = 100;
1097   }
1098
1099   LOG (GNUNET_ERROR_TYPE_DEBUG, "priority %d\n", priority);
1100
1101   call_core = NULL == c ? GNUNET_YES : GMC_is_sendable (c, fwd);
1102   queue = GNUNET_new (struct MeshPeerQueue);
1103   queue->cls = cls;
1104   queue->type = type;
1105   queue->size = size;
1106   queue->peer = peer;
1107   queue->c = c;
1108   queue->fwd = fwd;
1109   queue->callback = cont;
1110   queue->callback_cls = cont_cls;
1111   if (100 > priority)
1112   {
1113     GNUNET_CONTAINER_DLL_insert_tail (peer->queue_head, peer->queue_tail, queue);
1114     peer->queue_n++;
1115   }
1116   else
1117   {
1118     GNUNET_CONTAINER_DLL_insert (peer->queue_head, peer->queue_tail, queue);
1119     call_core = GNUNET_YES;
1120   }
1121
1122   if (NULL == peer->core_transmit && GNUNET_YES == call_core)
1123   {
1124     LOG (GNUNET_ERROR_TYPE_DEBUG,
1125                 "calling core tmt rdy towards %s for %u bytes\n",
1126                 GMP_2s (peer), size);
1127     peer->core_transmit =
1128         GNUNET_CORE_notify_transmit_ready (core_handle,
1129                                            GNUNET_NO, get_priority (queue),
1130                                            GNUNET_TIME_UNIT_FOREVER_REL,
1131                                            GNUNET_PEER_resolve2 (peer->id),
1132                                            size,
1133                                            &queue_send,
1134                                            peer);
1135     queue->start_waiting = GNUNET_TIME_absolute_get ();
1136   }
1137   else
1138   {
1139     LOG (GNUNET_ERROR_TYPE_DEBUG,
1140                 "core tmt rdy towards %s already called\n",
1141                 GMP_2s (peer));
1142
1143   }
1144   return queue;
1145 }
1146
1147
1148 /**
1149  * Cancel all queued messages to a peer that belong to a certain connection.
1150  *
1151  * @param peer Peer towards whom to cancel.
1152  * @param c Connection whose queued messages to cancel. Might be destroyed by
1153  *          the sent continuation call.
1154  */
1155 void
1156 GMP_queue_cancel (struct MeshPeer *peer, struct MeshConnection *c)
1157 {
1158   struct MeshPeerQueue *q;
1159   struct MeshPeerQueue *next;
1160   struct MeshPeerQueue *prev;
1161
1162   for (q = peer->queue_head; NULL != q; q = next)
1163   {
1164     prev = q->prev;
1165     if (q->c == c)
1166     {
1167       LOG (GNUNET_ERROR_TYPE_DEBUG, "GMP_cancel_queue %s\n", GM_m2s (q->type));
1168       GMP_queue_destroy (q, GNUNET_YES);
1169
1170       /* Get next from prev, q->next might be already freed:
1171        * queue destroy -> callback -> GMC_destroy -> cancel_queues -> here
1172        */
1173       if (NULL == prev)
1174         next = peer->queue_head;
1175       else
1176         next = prev->next;
1177     }
1178     else
1179     {
1180       next = q->next;
1181     }
1182   }
1183   if (NULL == peer->queue_head)
1184   {
1185     if (NULL != peer->core_transmit)
1186     {
1187       GNUNET_CORE_notify_transmit_ready_cancel (peer->core_transmit);
1188       peer->core_transmit = NULL;
1189     }
1190   }
1191 }
1192
1193
1194 /**
1195  * Get the first transmittable message for a connection.
1196  *
1197  * @param peer Neighboring peer.
1198  * @param c Connection.
1199  *
1200  * @return First transmittable message.
1201  */
1202 static struct MeshPeerQueue *
1203 connection_get_first_message (struct MeshPeer *peer, struct MeshConnection *c)
1204 {
1205   struct MeshPeerQueue *q;
1206
1207   for (q = peer->queue_head; NULL != q; q = q->next)
1208   {
1209     if (q->c != c)
1210       continue;
1211     if (queue_is_sendable (q))
1212     {
1213       LOG (GNUNET_ERROR_TYPE_DEBUG, "  sendable!!\n");
1214       return q;
1215     }
1216     LOG (GNUNET_ERROR_TYPE_DEBUG, "  not sendable\n");
1217   }
1218
1219   return NULL;
1220 }
1221
1222
1223 void
1224 GMP_queue_unlock (struct MeshPeer *peer, struct MeshConnection *c)
1225 {
1226   struct MeshPeerQueue *q;
1227   size_t size;
1228
1229   if (NULL != peer->core_transmit)
1230   {
1231     LOG (GNUNET_ERROR_TYPE_DEBUG, "  already unlocked!\n");
1232     return; /* Already unlocked */
1233   }
1234
1235   q = connection_get_first_message (peer, c);
1236   if (NULL == q)
1237   {
1238     LOG (GNUNET_ERROR_TYPE_DEBUG, "  queue empty!\n");
1239     return; /* Nothing to transmit */
1240   }
1241
1242   size = q->size;
1243   peer->core_transmit =
1244       GNUNET_CORE_notify_transmit_ready (core_handle,
1245                                          GNUNET_NO, get_priority (q),
1246                                          GNUNET_TIME_UNIT_FOREVER_REL,
1247                                          GNUNET_PEER_resolve2 (peer->id),
1248                                          size,
1249                                          &queue_send,
1250                                          peer);
1251 }
1252
1253
1254 /**
1255  * Initialize the peer subsystem.
1256  *
1257  * @param c Configuration.
1258  */
1259 void
1260 GMP_init (const struct GNUNET_CONFIGURATION_Handle *c)
1261 {
1262   LOG (GNUNET_ERROR_TYPE_DEBUG, "init\n");
1263   peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
1264   if (GNUNET_OK !=
1265       GNUNET_CONFIGURATION_get_value_number (c, "MESH", "MAX_PEERS",
1266                                              &max_peers))
1267   {
1268     GNUNET_log_config_invalid (GNUNET_ERROR_TYPE_WARNING,
1269                                "MESH", "MAX_PEERS", "USING DEFAULT");
1270     max_peers = 1000;
1271   }
1272
1273   if (GNUNET_OK !=
1274       GNUNET_CONFIGURATION_get_value_number (c, "MESH", "DROP_PERCENT",
1275                                              &drop_percent))
1276   {
1277     drop_percent = 0;
1278   }
1279   else
1280   {
1281     LOG (GNUNET_ERROR_TYPE_WARNING, "**************************************\n");
1282     LOG (GNUNET_ERROR_TYPE_WARNING, "Mesh is running with DROP enabled.\n");
1283     LOG (GNUNET_ERROR_TYPE_WARNING, "This is NOT a good idea!\n");
1284     LOG (GNUNET_ERROR_TYPE_WARNING, "Remove DROP_PERCENT from config file.\n");
1285     LOG (GNUNET_ERROR_TYPE_WARNING, "**************************************\n");
1286   }
1287
1288   core_handle = GNUNET_CORE_connect (c, /* Main configuration */
1289                                      NULL,      /* Closure passed to MESH functions */
1290                                      &core_init,        /* Call core_init once connected */
1291                                      &core_connect,     /* Handle connects */
1292                                      &core_disconnect,  /* remove peers on disconnects */
1293                                      NULL,      /* Don't notify about all incoming messages */
1294                                      GNUNET_NO, /* For header only in notification */
1295                                      NULL,      /* Don't notify about all outbound messages */
1296                                      GNUNET_NO, /* For header-only out notification */
1297                                      core_handlers);    /* Register these handlers */
1298   if (GNUNET_YES !=
1299     GNUNET_CONFIGURATION_get_value_yesno (c, "MESH", "DISABLE_TRY_CONNECT"))
1300   {
1301     transport_handle = GNUNET_TRANSPORT_connect (c, &my_full_id, NULL, /* cls */
1302                                                  /* Notify callbacks */
1303                                                  NULL, NULL, NULL);
1304
1305   }
1306
1307
1308   if (NULL == core_handle)
1309   {
1310     GNUNET_break (0);
1311     GNUNET_SCHEDULER_shutdown ();
1312     return;
1313   }
1314
1315 }
1316
1317 /**
1318  * Shut down the peer subsystem.
1319  */
1320 void
1321 GMP_shutdown (void)
1322 {
1323   GNUNET_CONTAINER_multipeermap_iterate (peers, &shutdown_tunnel, NULL);
1324
1325   if (core_handle != NULL)
1326   {
1327     GNUNET_CORE_disconnect (core_handle);
1328     core_handle = NULL;
1329   }
1330   if (transport_handle != NULL)
1331   {
1332     GNUNET_TRANSPORT_disconnect (transport_handle);
1333     transport_handle = NULL;
1334   }
1335   GNUNET_PEER_change_rc (myid, -1);
1336 }
1337
1338 /**
1339  * Retrieve the MeshPeer stucture associated with the peer, create one
1340  * and insert it in the appropriate structures if the peer is not known yet.
1341  *
1342  * @param peer_id Full identity of the peer.
1343  *
1344  * @return Existing or newly created peer structure.
1345  */
1346 struct MeshPeer *
1347 GMP_get (const struct GNUNET_PeerIdentity *peer_id)
1348 {
1349   struct MeshPeer *peer;
1350
1351   peer = GNUNET_CONTAINER_multipeermap_get (peers, peer_id);
1352   if (NULL == peer)
1353   {
1354     peer = GNUNET_new (struct MeshPeer);
1355     if (GNUNET_CONTAINER_multipeermap_size (peers) > max_peers)
1356     {
1357       peer_delete_oldest ();
1358     }
1359         GNUNET_CONTAINER_multipeermap_put (peers, peer_id, peer,
1360                                            GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1361         peer->id = GNUNET_PEER_intern (peer_id);
1362   }
1363   peer->last_contact = GNUNET_TIME_absolute_get();
1364
1365   return peer;
1366 }
1367
1368
1369 /**
1370  * Retrieve the MeshPeer stucture associated with the peer, create one
1371  * and insert it in the appropriate structures if the peer is not known yet.
1372  *
1373  * @param peer Short identity of the peer.
1374  *
1375  * @return Existing or newly created peer structure.
1376  */
1377 struct MeshPeer *
1378 GMP_get_short (const GNUNET_PEER_Id peer)
1379 {
1380   return GMP_get (GNUNET_PEER_resolve2 (peer));
1381 }
1382
1383
1384 /**
1385  * Try to connect to a peer on transport level.
1386  *
1387  * @param cls Closure (peer).
1388  * @param tc TaskContext.
1389  */
1390 static void
1391 try_connect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1392 {
1393   struct MeshPeer *peer = cls;
1394
1395   if (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
1396     return;
1397
1398   GNUNET_TRANSPORT_try_connect (transport_handle,
1399                                 GNUNET_PEER_resolve2 (peer->id), NULL, NULL);
1400 }
1401
1402
1403 /**
1404  * Try to establish a new connection to this peer (in its tunnel).
1405  * If the peer doesn't have any path to it yet, try to get one.
1406  * If the peer already has some path, send a CREATE CONNECTION towards it.
1407  *
1408  * @param peer Peer to connect to.
1409  */
1410 void
1411 GMP_connect (struct MeshPeer *peer)
1412 {
1413   struct MeshTunnel3 *t;
1414   struct MeshPeerPath *p;
1415   struct MeshConnection *c;
1416   int rerun_search;
1417
1418   LOG (GNUNET_ERROR_TYPE_DEBUG, "peer_connect towards %s\n", GMP_2s (peer));
1419
1420   /* If we have a current hello, try to connect using it. */
1421   GMP_try_connect (peer);
1422
1423   t = peer->tunnel;
1424   c = NULL;
1425   rerun_search = GNUNET_NO;
1426
1427   if (NULL != peer->path_head)
1428   {
1429     LOG (GNUNET_ERROR_TYPE_DEBUG, "  some path exists\n");
1430     p = peer_get_best_path (peer);
1431     if (NULL != p)
1432     {
1433       LOG (GNUNET_ERROR_TYPE_DEBUG, "  %u hops\n", p->length);
1434       c = GMT_use_path (t, p);
1435       if (NULL == c)
1436       {
1437         /* This case can happen when the path includes a first hop that is
1438          * not yet known to be connected.
1439          *
1440          * This happens quite often during testing when running mesh
1441          * under valgrind: core connect notifications come very late and the
1442          * DHT result has already come and created a valid path.
1443          * In this case, the peer->connections hashmap will be NULL and
1444          * tunnel_use_path will not be able to create a connection from that
1445          * path.
1446          *
1447          * Re-running the DHT GET should give core time to callback.
1448          *
1449          * GMT_use_path -> GMC_new -> register_neighbors takes care of
1450          * updating statistics about this issue.
1451          */
1452         rerun_search = GNUNET_YES;
1453       }
1454       else
1455       {
1456         GMC_send_create (c);
1457         return;
1458       }
1459     }
1460     else
1461     {
1462       LOG (GNUNET_ERROR_TYPE_DEBUG, "  but is NULL, all paths are in use\n");
1463     }
1464   }
1465
1466   if (NULL != peer->search_h && GNUNET_YES == rerun_search)
1467   {
1468     GMD_search_stop (peer->search_h);
1469     peer->search_h = NULL;
1470     LOG (GNUNET_ERROR_TYPE_DEBUG,
1471          "  Stopping DHT GET for peer %s\n",
1472          GMP_2s (peer));
1473   }
1474
1475   if (NULL == peer->search_h)
1476   {
1477     const struct GNUNET_PeerIdentity *id;
1478
1479     id = GNUNET_PEER_resolve2 (peer->id);
1480     LOG (GNUNET_ERROR_TYPE_DEBUG,
1481                 "  Starting DHT GET for peer %s\n", GMP_2s (peer));
1482     peer->search_h = GMD_search (id, &search_handler, peer);
1483     if (MESH_TUNNEL3_NEW == GMT_get_cstate (t))
1484       GMT_change_cstate (t, MESH_TUNNEL3_SEARCHING);
1485   }
1486 }
1487
1488
1489 /**
1490  * Chech whether there is a direct (core level)  connection to peer.
1491  *
1492  * @param peer Peer to check.
1493  *
1494  * @return #GNUNET_YES if there is a direct connection.
1495  */
1496 int
1497 GMP_is_neighbor (const struct MeshPeer *peer)
1498 {
1499   struct MeshPeerPath *path;
1500
1501   if (NULL == peer->connections)
1502     return GNUNET_NO;
1503
1504   for (path = peer->path_head; NULL != path; path = path->next)
1505   {
1506     if (3 > path->length)
1507       return GNUNET_YES;
1508   }
1509
1510   /* Is not a neighbor but connections is not NULL, probably disconnecting */
1511   return GNUNET_NO;
1512 }
1513
1514
1515 /**
1516  * Create and initialize a new tunnel towards a peer, in case it has none.
1517  * In case the peer already has a tunnel, nothing is done.
1518  *
1519  * Does not generate any traffic, just creates the local data structures.
1520  *
1521  * @param peer Peer towards which to create the tunnel.
1522  */
1523 void
1524 GMP_add_tunnel (struct MeshPeer *peer)
1525 {
1526   if (NULL != peer->tunnel)
1527     return;
1528   peer->tunnel = GMT_new (peer);
1529 }
1530
1531
1532 /**
1533  * Add a connection to a neighboring peer.
1534  *
1535  * Store that the peer is the first hop of the connection in one
1536  * direction and that on peer disconnect the connection must be
1537  * notified and destroyed, for it will no longer be valid.
1538  *
1539  * @param peer Peer to add connection to.
1540  * @param c Connection to add.
1541  *
1542  * @return GNUNET_OK on success.
1543  */
1544 int
1545 GMP_add_connection (struct MeshPeer *peer,
1546                     struct MeshConnection *c)
1547 {
1548   int result;
1549   LOG (GNUNET_ERROR_TYPE_DEBUG, "adding connection %s\n", GMC_2s (c));
1550   LOG (GNUNET_ERROR_TYPE_DEBUG, "to peer %s\n", GMP_2s (peer));
1551
1552   if (NULL == peer->connections)
1553   {
1554     GNUNET_break (0);
1555     LOG (GNUNET_ERROR_TYPE_DEBUG,
1556          "Peer %s is not a neighbor!\n",
1557          GMP_2s (peer));
1558     return GNUNET_SYSERR;
1559   }
1560   LOG (GNUNET_ERROR_TYPE_DEBUG,
1561        "peer %s ok, has %u connections.\n",
1562        GMP_2s (peer), GNUNET_CONTAINER_multihashmap_size (peer->connections));
1563   result = GNUNET_CONTAINER_multihashmap_put (peer->connections,
1564                                               GMC_get_h (c),
1565                                               c,
1566                                               GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
1567   LOG (GNUNET_ERROR_TYPE_DEBUG,
1568        " now has %u connections.\n",
1569        GNUNET_CONTAINER_multihashmap_size (peer->connections));
1570   LOG (GNUNET_ERROR_TYPE_DEBUG, "result %u\n", result);
1571
1572   return result;
1573 }
1574
1575
1576 /**
1577  * Add the path to the peer and update the path used to reach it in case this
1578  * is the shortest.
1579  *
1580  * @param peer Destination peer to add the path to.
1581  * @param path New path to add. Last peer must be the peer in arg 1.
1582  *             Path will be either used of freed if already known.
1583  * @param trusted Do we trust that this path is real?
1584  *
1585  * @return path if path was taken, pointer to existing duplicate if exists
1586  *         NULL on error.
1587  */
1588 struct MeshPeerPath *
1589 GMP_add_path (struct MeshPeer *peer, struct MeshPeerPath *path,
1590               int trusted)
1591 {
1592   struct MeshPeerPath *aux;
1593   unsigned int l;
1594   unsigned int l2;
1595
1596   LOG (GNUNET_ERROR_TYPE_DEBUG, "adding path [%u] to peer %s\n",
1597        path->length, GMP_2s (peer));
1598
1599   if ((NULL == peer) || (NULL == path))
1600   {
1601     GNUNET_break (0);
1602     path_destroy (path);
1603     return NULL;
1604   }
1605   if (path->peers[path->length - 1] != peer->id)
1606   {
1607     GNUNET_break (0);
1608     path_destroy (path);
1609     return NULL;
1610   }
1611   if (2 >= path->length && GNUNET_NO == trusted)
1612   {
1613     /* Only allow CORE to tell us about direct paths */
1614     path_destroy (path);
1615     return NULL;
1616   }
1617   for (l = 1; l < path->length; l++)
1618   {
1619     if (path->peers[l] == myid)
1620     {
1621       LOG (GNUNET_ERROR_TYPE_DEBUG, " shortening path by %u\n", l);
1622       for (l2 = 0; l2 < path->length - l; l2++)
1623       {
1624         path->peers[l2] = path->peers[l + l2];
1625       }
1626       path->length -= l;
1627       l = 1;
1628       path->peers = GNUNET_realloc (path->peers,
1629                                     path->length * sizeof (GNUNET_PEER_Id));
1630     }
1631   }
1632
1633   LOG (GNUNET_ERROR_TYPE_DEBUG, " final length: %u\n", path->length);
1634
1635   l = path_get_length (path);
1636   if (0 == l)
1637   {
1638     path_destroy (path);
1639     return NULL;
1640   }
1641
1642   GNUNET_assert (peer->id == path->peers[path->length - 1]);
1643   for (aux = peer->path_head; aux != NULL; aux = aux->next)
1644   {
1645     l2 = path_get_length (aux);
1646     if (l2 > l)
1647     {
1648       LOG (GNUNET_ERROR_TYPE_DEBUG, "  added\n");
1649       GNUNET_CONTAINER_DLL_insert_before (peer->path_head,
1650                                           peer->path_tail, aux, path);
1651       if (NULL != peer->tunnel && 3 < GMT_count_connections (peer->tunnel))
1652       {
1653         GMP_connect (peer);
1654       }
1655       return path;
1656     }
1657     else
1658     {
1659       if (l2 == l && memcmp (path->peers, aux->peers, l) == 0)
1660       {
1661         LOG (GNUNET_ERROR_TYPE_DEBUG, "  already known\n");
1662         path_destroy (path);
1663         return aux;
1664       }
1665     }
1666   }
1667   GNUNET_CONTAINER_DLL_insert_tail (peer->path_head, peer->path_tail,
1668                                     path);
1669   LOG (GNUNET_ERROR_TYPE_DEBUG, "  added last\n");
1670   if (NULL != peer->tunnel && 3 < GMT_count_connections (peer->tunnel))
1671   {
1672     GMP_connect (peer);
1673   }
1674   return path;
1675 }
1676
1677
1678 /**
1679  * Add the path to the origin peer and update the path used to reach it in case
1680  * this is the shortest.
1681  * The path is given in peer_info -> destination, therefore we turn the path
1682  * upside down first.
1683  *
1684  * @param peer Peer to add the path to, being the origin of the path.
1685  * @param path New path to add after being inversed.
1686  *             Path will be either used or freed.
1687  * @param trusted Do we trust that this path is real?
1688  *
1689  * @return path if path was taken, pointer to existing duplicate if exists
1690  *         NULL on error.
1691  */
1692 struct MeshPeerPath *
1693 GMP_add_path_to_origin (struct MeshPeer *peer,
1694                         struct MeshPeerPath *path,
1695                         int trusted)
1696 {
1697   if (NULL == path)
1698     return NULL;
1699   path_invert (path);
1700   return GMP_add_path (peer, path, trusted);
1701 }
1702
1703
1704 /**
1705  * Adds a path to the info of all the peers in the path
1706  *
1707  * @param p Path to process.
1708  * @param confirmed Whether we know if the path works or not.
1709  */
1710 void
1711 GMP_add_path_to_all (const struct MeshPeerPath *p, int confirmed)
1712 {
1713   unsigned int i;
1714
1715   /* TODO: invert and add */
1716   for (i = 0; i < p->length && p->peers[i] != myid; i++) /* skip'em */ ;
1717   for (i++; i < p->length; i++)
1718   {
1719     struct MeshPeer *aux;
1720     struct MeshPeerPath *copy;
1721
1722     aux = GMP_get_short (p->peers[i]);
1723     copy = path_duplicate (p);
1724     copy->length = i + 1;
1725     GMP_add_path (aux, copy, p->length < 3 ? GNUNET_NO : confirmed);
1726   }
1727 }
1728
1729
1730 /**
1731  * Remove any path to the peer that has the extact same peers as the one given.
1732  *
1733  * @param peer Peer to remove the path from.
1734  * @param path Path to remove. Is always destroyed .
1735  */
1736 void
1737 GMP_remove_path (struct MeshPeer *peer, struct MeshPeerPath *path)
1738 {
1739   struct MeshPeerPath *iter;
1740   struct MeshPeerPath *next;
1741
1742   GNUNET_assert (myid == path->peers[0]);
1743   GNUNET_assert (peer->id == path->peers[path->length - 1]);
1744
1745   for (iter = peer->path_head; NULL != iter; iter = next)
1746   {
1747     next = iter->next;
1748     if (0 == memcmp (path->peers, iter->peers,
1749                      sizeof (GNUNET_PEER_Id) * path->length))
1750     {
1751       GNUNET_CONTAINER_DLL_remove (peer->path_head, peer->path_tail, iter);
1752       path_destroy (iter);
1753       if (path == iter)
1754         return;
1755     }
1756   }
1757   path_destroy (path);
1758 }
1759
1760
1761 /**
1762  * Remove a connection from a neighboring peer.
1763  *
1764  * @param peer Peer to remove connection from.
1765  * @param c Connection to remove.
1766  *
1767  * @return GNUNET_OK on success.
1768  */
1769 int
1770 GMP_remove_connection (struct MeshPeer *peer,
1771                        const struct MeshConnection *c)
1772 {
1773   LOG (GNUNET_ERROR_TYPE_DEBUG, "removing connection %s\n", GMC_2s (c));
1774   LOG (GNUNET_ERROR_TYPE_DEBUG, "from peer %s\n", GMP_2s (peer));
1775
1776   if (NULL == peer || NULL == peer->connections)
1777   {
1778     LOG (GNUNET_ERROR_TYPE_DEBUG,
1779          "Peer %s is not a neighbor!\n",
1780          GMP_2s (peer));
1781     return GNUNET_SYSERR;
1782   }
1783   LOG (GNUNET_ERROR_TYPE_DEBUG,
1784        "peer %s ok, has %u connections.\n",
1785        GMP_2s (peer), GNUNET_CONTAINER_multihashmap_size (peer->connections));
1786
1787   return GNUNET_CONTAINER_multihashmap_remove (peer->connections,
1788                                                GMC_get_h (c),
1789                                                c);
1790 }
1791
1792 /**
1793  * Start the DHT search for new paths towards the peer: we don't have
1794  * enough good connections.
1795  *
1796  * @param peer Destination peer.
1797  */
1798 void
1799 GMP_start_search (struct MeshPeer *peer)
1800 {
1801   if (NULL != peer->search_h)
1802   {
1803     GNUNET_break (0);
1804     return;
1805   }
1806
1807   peer->search_h = GMD_search (GMP_get_id (peer), &search_handler, peer);
1808 }
1809
1810
1811 /**
1812  * Stop the DHT search for new paths towards the peer: we already have
1813  * enough good connections.
1814  *
1815  * @param peer Destination peer.
1816  */
1817 void
1818 GMP_stop_search (struct MeshPeer *peer)
1819 {
1820   if (NULL == peer->search_h)
1821   {
1822     GNUNET_break (0);
1823     return;
1824   }
1825
1826   GMD_search_stop (peer->search_h);
1827   peer->search_h = NULL;
1828 }
1829
1830
1831 /**
1832  * Get the Full ID of a peer.
1833  *
1834  * @param peer Peer to get from.
1835  *
1836  * @return Full ID of peer.
1837  */
1838 const struct GNUNET_PeerIdentity *
1839 GMP_get_id (const struct MeshPeer *peer)
1840 {
1841   return GNUNET_PEER_resolve2 (peer->id);
1842 }
1843
1844
1845 /**
1846  * Get the Short ID of a peer.
1847  *
1848  * @param peer Peer to get from.
1849  *
1850  * @return Short ID of peer.
1851  */
1852 GNUNET_PEER_Id
1853 GMP_get_short_id (const struct MeshPeer *peer)
1854 {
1855   return peer->id;
1856 }
1857
1858
1859 /**
1860  * Set tunnel.
1861  *
1862  * @param peer Peer.
1863  * @param t Tunnel.
1864  */
1865 void
1866 GMP_set_tunnel (struct MeshPeer *peer, struct MeshTunnel3 *t)
1867 {
1868   peer->tunnel = t;
1869 }
1870
1871
1872 /**
1873  * Get the tunnel towards a peer.
1874  *
1875  * @param peer Peer to get from.
1876  *
1877  * @return Tunnel towards peer.
1878  */
1879 struct MeshTunnel3 *
1880 GMP_get_tunnel (const struct MeshPeer *peer)
1881 {
1882   return peer->tunnel;
1883 }
1884
1885
1886 /**
1887  * Set the hello message.
1888  *
1889  * @param peer Peer whose message to set.
1890  * @param hello Hello message.
1891  */
1892 void
1893 GMP_set_hello (struct MeshPeer *peer, const struct GNUNET_HELLO_Message *hello)
1894 {
1895   struct GNUNET_HELLO_Message *old;
1896   size_t size;
1897
1898   LOG (GNUNET_ERROR_TYPE_DEBUG, "set hello for %s\n", GMP_2s (peer));
1899   if (NULL == hello)
1900     return;
1901
1902   old = GMP_get_hello (peer);
1903   if (NULL == old)
1904   {
1905     size = GNUNET_HELLO_size (hello);
1906     LOG (GNUNET_ERROR_TYPE_DEBUG, " new (%u bytes)\n", size);
1907     peer->hello = GNUNET_malloc (size);
1908     memcpy (peer->hello, hello, size);
1909   }
1910   else
1911   {
1912     peer->hello = GNUNET_HELLO_merge (old, hello);
1913     LOG (GNUNET_ERROR_TYPE_DEBUG, " merge into %p (%u bytes)\n",
1914          peer->hello, GNUNET_HELLO_size (hello));
1915     GNUNET_free (old);
1916   }
1917 }
1918
1919
1920 /**
1921  * Get the hello message.
1922  *
1923  * @param peer Peer whose message to get.
1924  *
1925  * @return Hello message.
1926  */
1927 struct GNUNET_HELLO_Message *
1928 GMP_get_hello (struct MeshPeer *peer)
1929 {
1930   struct GNUNET_TIME_Absolute expiration;
1931   struct GNUNET_TIME_Relative remaining;
1932
1933   if (NULL == peer->hello)
1934     return NULL;
1935
1936   expiration = GNUNET_HELLO_get_last_expiration (peer->hello);
1937   remaining = GNUNET_TIME_absolute_get_remaining (expiration);
1938   if (0 == remaining.rel_value_us)
1939   {
1940     LOG (GNUNET_ERROR_TYPE_DEBUG, " get - hello expired on %s\n",
1941          GNUNET_STRINGS_absolute_time_to_string (expiration));
1942     GNUNET_free (peer->hello);
1943     peer->hello = NULL;
1944   }
1945   return peer->hello;
1946 }
1947
1948
1949 /**
1950  * Try to connect to a peer on TRANSPORT level.
1951  *
1952  * @param peer Peer to whom to connect.
1953  */
1954 void
1955 GMP_try_connect (struct MeshPeer *peer)
1956 {
1957   struct GNUNET_HELLO_Message *hello;
1958   struct GNUNET_MessageHeader *mh;
1959
1960   if (NULL == transport_handle)
1961     return;
1962
1963   hello = GMP_get_hello (peer);
1964   if (NULL == hello)
1965     return;
1966
1967   mh = GNUNET_HELLO_get_header (hello);
1968   GNUNET_TRANSPORT_offer_hello (transport_handle, mh, try_connect, peer);
1969 }
1970
1971
1972 /**
1973  * Count the number of known paths toward the peer.
1974  *
1975  * @param peer Peer to get path info.
1976  *
1977  * @return Number of known paths.
1978  */
1979 unsigned int
1980 GMP_count_paths (const struct MeshPeer *peer)
1981 {
1982   struct MeshPeerPath *iter;
1983   unsigned int i;
1984
1985   for (iter = peer->path_head, i = 0; NULL != iter; iter = iter->next)
1986     i++;
1987
1988   return i;
1989 }
1990
1991
1992 /**
1993  * Iterate all known peers.
1994  *
1995  * @param iter Iterator.
1996  * @param cls Closure for @c iter.
1997  */
1998 void
1999 GMP_iterate_all (GNUNET_CONTAINER_PeerMapIterator iter, void *cls)
2000 {
2001   GNUNET_CONTAINER_multipeermap_iterate (peers, iter, cls);
2002 }
2003
2004
2005 /**
2006  * Get the static string for a peer ID.
2007  *
2008  * @param peer Peer.
2009  *
2010  * @return Static string for it's ID.
2011  */
2012 const char *
2013 GMP_2s (const struct MeshPeer *peer)
2014 {
2015   if (NULL == peer)
2016     return "(NULL)";
2017   return GNUNET_i2s (GNUNET_PEER_resolve2 (peer->id));
2018 }