Link dv transport plugin to libgnunetats (for logging)
[oweals/gnunet.git] / src / dv / plugin_transport_dv.c
1 /*
2      This file is part of GNUnet
3      (C) 2002--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  * @file dv/plugin_transport_dv.c
23  * @brief DV transport service, takes incoming DV requests and deals with
24  * the DV service
25  * @author Nathan Evans
26  * @author Christian Grothoff
27  */
28
29 #include "platform.h"
30 #include "gnunet_util_lib.h"
31 #include "gnunet_protocols.h"
32 #include "gnunet_statistics_service.h"
33 #include "gnunet_dv_service.h"
34 #include "gnunet_transport_service.h"
35 #include "gnunet_transport_plugin.h"
36 #include "dv.h"
37
38
39 #define LOG(kind,...) GNUNET_log_from (kind, "transport-dv",__VA_ARGS__)
40
41 #define PLUGIN_NAME "dv"
42
43 /**
44  * Encapsulation of all of the state of the plugin.
45  */
46 struct Plugin;
47
48
49 /**
50  * An active request for transmission via DV.
51  */
52 struct PendingRequest
53 {
54
55   /**
56    * This is a DLL.
57    */
58   struct PendingRequest *next;
59
60   /**
61    * This is a DLL.
62    */
63   struct PendingRequest *prev;
64
65   /**
66    * Continuation function to call once the transmission buffer
67    * has again space available.  NULL if there is no
68    * continuation to call.
69    */
70   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
71
72   /**
73    * Closure for transmit_cont.
74    */
75   void *transmit_cont_cls;
76
77   /**
78    * Transmission handle from DV client library.
79    */
80   struct GNUNET_DV_TransmitHandle *th;
81
82   /**
83    * Session of this request.
84    */
85   struct Session *session;
86
87 };
88
89
90 /**
91  * Session handle for connections.
92  */
93 struct Session
94 {
95
96   /**
97    * Mandatory session header.
98    */
99   struct SessionHeader header;
100
101   /**
102    * Pointer to the global plugin struct.
103    */
104   struct Plugin *plugin;
105
106   /**
107    * Head of pending requests.
108    */
109   struct PendingRequest *pr_head;
110
111   /**
112    * Tail of pending requests.
113    */
114   struct PendingRequest *pr_tail;
115
116   /**
117    * To whom are we talking to.
118    */
119   struct GNUNET_PeerIdentity sender;
120
121   /**
122    * Current distance to the given peer.
123    */
124   uint32_t distance;
125
126   /**
127    * Current network the next hop peer is located in
128    */
129   uint32_t network;
130
131   /**
132    * Does the transport service know about this session (and we thus
133    * need to call 'session_end' when it is released?)
134    */
135   int active;
136
137 };
138
139
140 /**
141  * Encapsulation of all of the state of the plugin.
142  */
143 struct Plugin
144 {
145   /**
146    * Our environment.
147    */
148   struct GNUNET_TRANSPORT_PluginEnvironment *env;
149
150   /**
151    * Hash map of sessions (active and inactive).
152    */
153   struct GNUNET_CONTAINER_MultiPeerMap *sessions;
154
155   /**
156    * Copy of the handler array where the closures are
157    * set to this struct's instance.
158    */
159   struct GNUNET_SERVER_MessageHandler *handlers;
160
161   /**
162    * Handle to the DV service
163    */
164   struct GNUNET_DV_ServiceHandle *dvh;
165
166   /**
167    * Tokenizer for boxed messages.
168    */
169   struct GNUNET_SERVER_MessageStreamTokenizer *mst;
170
171 };
172
173
174 /**
175  * Notify transport service about the change in distance.
176  *
177  * @param session session where the distance changed
178  */
179 static void
180 notify_distance_change (struct Session *session)
181 {
182   struct Plugin *plugin = session->plugin;
183   struct GNUNET_ATS_Information ats;
184
185   ats.type = htonl ((uint32_t) GNUNET_ATS_QUALITY_NET_DISTANCE);
186   ats.value = htonl (session->distance);
187   plugin->env->update_address_metrics (plugin->env->cls,
188                                        &session->sender,
189                                        NULL, 0,
190                                        session,
191                                        &ats, 1);
192 }
193
194
195 /**
196  * Function called by MST on each message from the box.
197  *
198  * @param cls closure with the 'struct Plugin'
199  * @param client identification of the client (with the 'struct Session')
200  * @param message the actual message
201  * @return GNUNET_OK on success
202  */
203 static int
204 unbox_cb (void *cls,
205           void *client,
206           const struct GNUNET_MessageHeader *message)
207 {
208   struct Plugin *plugin = cls;
209   struct Session *session = client;
210   struct GNUNET_ATS_Information ats;
211
212   ats.type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
213   ats.value = htonl (session->distance);
214   session->active = GNUNET_YES;
215   plugin->env->receive (plugin->env->cls,
216                         &session->sender,
217                         message,
218                         session, "", 0);
219   plugin->env->update_address_metrics (plugin->env->cls,
220                 &session->sender, NULL, 0, session, &ats, 1);
221   return GNUNET_OK;
222 }
223
224
225 /**
226  * Handler for messages received from the DV service.
227  *
228  * @param cls closure with the plugin
229  * @param sender sender of the message
230  * @param distance how far did the message travel
231  * @param msg actual message payload
232  */
233 static void
234 handle_dv_message_received (void *cls,
235                             const struct GNUNET_PeerIdentity *sender,
236                             uint32_t distance,
237                             const struct GNUNET_MessageHeader *msg)
238 {
239   struct Plugin *plugin = cls;
240   struct GNUNET_ATS_Information ats;
241   struct Session *session;
242
243   LOG (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message for peer `%s': new distance %u\n",
244       "DV_MESSAGE_RECEIVED",
245       GNUNET_i2s (sender), distance);
246
247
248   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
249                                                sender);
250   if (NULL == session)
251   {
252     GNUNET_break (0);
253     return;
254   }
255   if (GNUNET_MESSAGE_TYPE_DV_BOX == ntohs (msg->type))
256   {
257     /* need to unbox using MST */
258     GNUNET_SERVER_mst_receive (plugin->mst,
259                                session,
260                                (const char *) &msg[1],
261                                ntohs (msg->size) - sizeof (struct GNUNET_MessageHeader),
262                                GNUNET_YES,
263                                GNUNET_NO);
264     return;
265   }
266   ats.type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
267   ats.value = htonl (distance);
268   session->active = GNUNET_YES;
269   plugin->env->receive (plugin->env->cls, sender,
270                         msg,
271                         session, "", 0);
272   plugin->env->update_address_metrics (plugin->env->cls,
273                                        sender, "", 0, session, &ats, 1);
274 }
275
276
277 /**
278  * Function called if DV starts to be able to talk to a peer.
279  *
280  * @param cls closure with 'struct Plugin'
281  * @param peer newly connected peer
282  * @param distance distance to the peer
283  * @param network the network the next hop is located in
284  */
285 static void
286 handle_dv_connect (void *cls,
287                    const struct GNUNET_PeerIdentity *peer,
288                    uint32_t distance, uint32_t network)
289 {
290   struct Plugin *plugin = cls;
291   struct Session *session;
292   struct GNUNET_ATS_Information ats[2];
293
294   /**
295    * This requires transport plugin to be linked to libgnunetats.
296    * If you remove it, also remove libgnunetats linkage from Makefile.am
297    */
298   LOG (GNUNET_ERROR_TYPE_DEBUG,
299       "Received `%s' message for peer `%s' with next hop in network %s \n",
300       "DV_CONNECT",
301       GNUNET_i2s (peer),
302       GNUNET_ATS_print_network_type (network));
303
304   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
305                                                peer);
306   if (NULL != session)
307   {
308     GNUNET_break (0);
309     session->distance = distance;
310     if (GNUNET_YES == session->active)
311       notify_distance_change (session);
312     return; /* nothing to do */
313   }
314   session = GNUNET_new (struct Session);
315   session->sender = *peer;
316   session->distance = distance;
317   session->network = network;
318   GNUNET_assert (GNUNET_YES ==
319                  GNUNET_CONTAINER_multipeermap_put (plugin->sessions,
320                                                     &session->sender,
321                                                     session,
322                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
323
324   /* Notify transport and ats about new connection */
325   ats[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
326   ats[0].value = htonl (distance);
327   ats[0].type = htonl (GNUNET_ATS_NETWORK_TYPE);
328   ats[0].value = htonl (network);
329   plugin->env->session_start (plugin->env->cls, peer, PLUGIN_NAME, NULL, 0,
330       session, ats, 2);
331 }
332
333
334 /**
335  * Function called if DV distance to a peer is changed.
336  *
337  * @param cls closure with 'struct Plugin'
338  * @param peer connected peer
339  * @param distance new distance to the peer
340  */
341 static void
342 handle_dv_distance_changed (void *cls,
343                             const struct GNUNET_PeerIdentity *peer,
344                             uint32_t distance)
345 {
346   struct Plugin *plugin = cls;
347   struct Session *session;
348
349   LOG (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message for peer `%s': new distance %u\n",
350       "DV_DISTANCE_CHANGED",
351       GNUNET_i2s (peer), distance);
352
353   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
354                                                peer);
355   if (NULL == session)
356   {
357     GNUNET_break (0);
358     /* FIXME */
359     handle_dv_connect (plugin, peer, distance, 0);
360     return;
361   }
362   session->distance = distance;
363   if (GNUNET_YES == session->active)
364     notify_distance_change (session);
365 }
366
367
368 /**
369  * Release session object and clean up associated resources.
370  *
371  * @param session session to clean up
372  */
373 static void
374 free_session (struct Session *session)
375 {
376   struct Plugin *plugin = session->plugin;
377   struct PendingRequest *pr;
378
379   GNUNET_assert (GNUNET_YES ==
380                  GNUNET_CONTAINER_multipeermap_remove (plugin->sessions,
381                                                        &session->sender,
382                                                        session));
383   if (GNUNET_YES == session->active)
384     plugin->env->session_end (plugin->env->cls,
385                               &session->sender,
386                               session);
387   while (NULL != (pr = session->pr_head))
388   {
389     GNUNET_CONTAINER_DLL_remove (session->pr_head,
390                                  session->pr_tail,
391                                  pr);
392     GNUNET_DV_send_cancel (pr->th);
393     pr->th = NULL;
394     if (NULL != pr->transmit_cont)
395       pr->transmit_cont (pr->transmit_cont_cls,
396                          &session->sender,
397                          GNUNET_SYSERR, 0, 0);
398     GNUNET_free (pr);
399   }
400   GNUNET_free (session);
401 }
402
403
404 /**
405  * Function called if DV is no longer able to talk to a peer.
406  *
407  * @param cls closure with 'struct Plugin'
408  * @param peer peer that disconnected
409  */
410 static void
411 handle_dv_disconnect (void *cls,
412                       const struct GNUNET_PeerIdentity *peer)
413 {
414   struct Plugin *plugin = cls;
415   struct Session *session;
416
417   LOG (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message for peer `%s'\n",
418       "DV_DISCONNECT",
419       GNUNET_i2s (peer));
420
421   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
422                                                peer);
423   if (NULL == session)
424     return; /* nothing to do */
425
426   free_session (session);
427 }
428
429
430 /**
431  * Function called once the delivery of a message has been successful.
432  * Clean up the pending request, and call continuations.
433  *
434  * @param cls closure
435  * @param ok GNUNET_OK on success, GNUNET_SYSERR on error
436  */
437 static void
438 send_finished (void *cls,
439                int ok)
440 {
441   struct PendingRequest *pr = cls;
442   struct Session *session = pr->session;
443
444   pr->th = NULL;
445   GNUNET_CONTAINER_DLL_remove (session->pr_head,
446                                session->pr_tail,
447                                pr);
448   if (NULL != pr->transmit_cont)
449     pr->transmit_cont (pr->transmit_cont_cls,
450                        &session->sender,
451                        ok, 0, 0);
452   GNUNET_free (pr);
453 }
454
455
456 /**
457  * Function that can be used by the transport service to transmit
458  * a message using the plugin.
459  *
460  * @param cls closure
461  * @param session the session used
462  * @param priority how important is the message
463  * @param msgbuf the message to transmit
464  * @param msgbuf_size number of bytes in 'msgbuf'
465  * @param timeout when should we time out
466  * @param cont continuation to call once the message has
467  *        been transmitted (or if the transport is ready
468  *        for the next transmission call; or if the
469  *        peer disconnected...)
470  * @param cont_cls closure for cont
471  * @return number of bytes used (on the physical network, with overheads);
472  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
473  *         and does NOT mean that the message was not transmitted (DV)
474  */
475 static ssize_t
476 dv_plugin_send (void *cls,
477                 struct Session *session,
478                 const char *msgbuf, size_t msgbuf_size, unsigned int priority,
479                 struct GNUNET_TIME_Relative timeout,
480                 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
481 {
482   struct PendingRequest *pr;
483   const struct GNUNET_MessageHeader *msg;
484   struct GNUNET_MessageHeader *box;
485
486   box = NULL;
487   msg = (const struct GNUNET_MessageHeader *) msgbuf;
488   if (ntohs (msg->size) != msgbuf_size)
489   {
490     /* need to box */
491     box = GNUNET_malloc (sizeof (struct GNUNET_MessageHeader) + msgbuf_size);
492     box->type = htons (GNUNET_MESSAGE_TYPE_DV_BOX);
493     box->size = htons (sizeof (struct GNUNET_MessageHeader) + msgbuf_size);
494     memcpy (&box[1], msgbuf, msgbuf_size);
495     msg = box;
496   }
497   pr = GNUNET_new (struct PendingRequest);
498   pr->transmit_cont = cont;
499   pr->transmit_cont_cls = cont_cls;
500   pr->session = session;
501   GNUNET_CONTAINER_DLL_insert_tail (session->pr_head,
502                                     session->pr_tail,
503                                     pr);
504   pr->th = GNUNET_DV_send (session->plugin->dvh,
505                            &session->sender,
506                            msg,
507                            &send_finished,
508                            pr);
509   GNUNET_free_non_null (box);
510   return 0; /* DV */
511 }
512
513
514 /**
515  * Function that can be used to force the plugin to disconnect
516  * from the given peer and cancel all previous transmissions
517  * (and their continuations).
518  *
519  * @param cls closure
520  * @param target peer from which to disconnect
521  */
522 static void
523 dv_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
524 {
525   struct Plugin *plugin = cls;
526   struct Session *session;
527   struct PendingRequest *pr;
528
529   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
530                                                target);
531   if (NULL == session)
532     return; /* nothing to do */
533   while (NULL != (pr = session->pr_head))
534   {
535     GNUNET_CONTAINER_DLL_remove (session->pr_head,
536                                  session->pr_tail,
537                                  pr);
538     GNUNET_DV_send_cancel (pr->th);
539     pr->th = NULL;
540     if (NULL != pr->transmit_cont)
541       pr->transmit_cont (pr->transmit_cont_cls,
542                          &session->sender,
543                          GNUNET_SYSERR, 0, 0);
544     GNUNET_free (pr);
545   }
546   session->active = GNUNET_NO;
547 }
548
549
550 /**
551  * Convert the transports address to a nice, human-readable
552  * format.
553  *
554  * @param cls closure
555  * @param type name of the transport that generated the address
556  * @param addr one of the addresses of the host, NULL for the last address
557  *        the specific address format depends on the transport
558  * @param addrlen length of the address
559  * @param numeric should (IP) addresses be displayed in numeric form?
560  * @param timeout after how long should we give up?
561  * @param asc function to call on each string
562  * @param asc_cls closure for asc
563  */
564 static void
565 dv_plugin_address_pretty_printer (void *cls, const char *type, const void *addr,
566                                   size_t addrlen, int numeric,
567                                   struct GNUNET_TIME_Relative timeout,
568                                   GNUNET_TRANSPORT_AddressStringCallback asc,
569                                   void *asc_cls)
570 {
571   if ( (0 == addrlen) &&
572        (0 == strcmp (type, "dv")) )
573     asc (asc_cls, "dv");
574   asc (asc_cls, NULL);
575 }
576
577
578 /**
579  * Convert the DV address to a pretty string.
580  *
581  * @param cls closure
582  * @param addr the (hopefully) DV address
583  * @param addrlen the length of the address
584  *
585  * @return string representing the DV address
586  */
587 static const char *
588 dv_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
589 {
590   if (0 != addrlen)
591   {
592     GNUNET_break (0); /* malformed */
593     return NULL;
594   }
595   return "dv";
596 }
597
598
599 /**
600  * Another peer has suggested an address for this peer and transport
601  * plugin.  Check that this could be a valid address.  This function
602  * is not expected to 'validate' the address in the sense of trying to
603  * connect to it but simply to see if the binary format is technically
604  * legal for establishing a connection to this peer (and make sure that
605  * the address really corresponds to our network connection/settings
606  * and not some potential man-in-the-middle).
607  *
608  * @param cls closure
609  * @param addr pointer to the address
610  * @param addrlen length of addr
611  * @return GNUNET_OK if this is a plausible address for this peer
612  *         and transport, GNUNET_SYSERR if not
613  *
614  */
615 static int
616 dv_plugin_check_address (void *cls, const void *addr, size_t addrlen)
617 {
618   if (0 != addrlen)
619     return GNUNET_SYSERR;
620   return GNUNET_OK;
621 }
622
623
624 /**
625  * Create a new session to transmit data to the target
626  * This session will used to send data to this peer and the plugin will
627  * notify us by calling the env->session_end function
628  *
629  * @param cls the plugin
630  * @param address the address
631  * @return the session if the address is valid, NULL otherwise
632  */
633 static struct Session *
634 dv_get_session (void *cls,
635                 const struct GNUNET_HELLO_Address *address)
636 {
637   struct Plugin *plugin = cls;
638   struct Session *session;
639
640   if (0 != address->address_length)
641     return NULL;
642   session = GNUNET_CONTAINER_multipeermap_get (plugin->sessions,
643                                                &address->peer);
644   if (NULL == session)
645     return NULL; /* not valid right now */
646   session->active = GNUNET_YES;
647   return session;
648 }
649
650
651 /**
652  * Function called to convert a string address to
653  * a binary address.
654  *
655  * @param cls closure ('struct Plugin*')
656  * @param addr string address
657  * @param addrlen length of the address including \0 termination
658  * @param buf location to store the buffer
659  *        If the function returns GNUNET_SYSERR, its contents are undefined.
660  * @param added length of created address
661  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
662  */
663 static int
664 dv_plugin_string_to_address (void *cls,
665                              const char *addr,
666                              uint16_t addrlen,
667                              void **buf,
668                              size_t *added)
669 {
670   if ( (addrlen == 3) &&
671        (0 == strcmp ("dv", addr)) )
672   {
673     *added = 0;
674     return GNUNET_OK;
675   }
676   return GNUNET_SYSERR;
677 }
678
679
680
681 /**
682  * Function to obtain the network type for a session
683  * FIXME: we should probably look at the network type
684  * used by the next hop here.  Or find some other way
685  * to properly allow ATS-DV resource allocation.
686  *
687  * @param cls closure ('struct Plugin*')
688  * @param session the session
689  * @return the network type
690  */
691 static enum GNUNET_ATS_Network_Type
692 dv_get_network (void *cls,
693                 struct Session *session)
694 {
695   GNUNET_assert (NULL != session);
696   return session->network;
697 }
698
699
700 /**
701  * Entry point for the plugin.
702  *
703  * @param cls closure with the plugin environment
704  * @return plugin API
705  */
706 void *
707 libgnunet_plugin_transport_dv_init (void *cls)
708 {
709   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
710   struct GNUNET_TRANSPORT_PluginFunctions *api;
711   struct Plugin *plugin;
712
713   plugin = GNUNET_new (struct Plugin);
714   plugin->env = env;
715   plugin->sessions = GNUNET_CONTAINER_multipeermap_create (1024 * 8, GNUNET_YES);
716   plugin->mst = GNUNET_SERVER_mst_create (&unbox_cb,
717                                           plugin);
718   plugin->dvh = GNUNET_DV_service_connect (env->cfg,
719                                            plugin,
720                                            &handle_dv_connect,
721                                            &handle_dv_distance_changed,
722                                            &handle_dv_disconnect,
723                                            &handle_dv_message_received);
724   if (NULL == plugin->dvh)
725   {
726     GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
727     GNUNET_SERVER_mst_destroy (plugin->mst);
728     GNUNET_free (plugin);
729     return NULL;
730   }
731   api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
732   api->cls = plugin;
733   api->send = &dv_plugin_send;
734   api->disconnect = &dv_plugin_disconnect;
735   api->address_pretty_printer = &dv_plugin_address_pretty_printer;
736   api->check_address = &dv_plugin_check_address;
737   api->address_to_string = &dv_plugin_address_to_string;
738   api->string_to_address = &dv_plugin_string_to_address;
739   api->get_session = &dv_get_session;
740   api->get_network = &dv_get_network;
741   return api;
742 }
743
744
745 /**
746  * Function called to free a session.
747  *
748  * @param cls NULL
749  * @param key unused
750  * @param value session to free
751  * @return GNUNET_OK (continue to iterate)
752  */
753 static int
754 free_session_iterator (void *cls,
755                        const struct GNUNET_PeerIdentity *key,
756                        void *value)
757 {
758   struct Session *session = value;
759
760   free_session (session);
761   return GNUNET_OK;
762 }
763
764
765 /**
766  * Exit point from the plugin.
767  *
768  * @param cls plugin API
769  * @return NULL
770  */
771 void *
772 libgnunet_plugin_transport_dv_done (void *cls)
773 {
774   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
775   struct Plugin *plugin = api->cls;
776
777   GNUNET_DV_service_disconnect (plugin->dvh);
778   GNUNET_CONTAINER_multipeermap_iterate (plugin->sessions,
779                                          &free_session_iterator,
780                                          NULL);
781   GNUNET_CONTAINER_multipeermap_destroy (plugin->sessions);
782   GNUNET_SERVER_mst_destroy (plugin->mst);
783   GNUNET_free (plugin);
784   GNUNET_free (api);
785   return NULL;
786 }
787
788 /* end of plugin_transport_dv.c */