-consistently use struct GNUNET_HashCode
[oweals/gnunet.git] / src / transport / plugin_transport_unix.c
1 /*
2      This file is part of GNUnet
3      (C) 2010 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 transport/plugin_transport_unix.c
23  * @brief Transport plugin using unix domain sockets (!)
24  *        Clearly, can only be used locally on Unix/Linux hosts...
25  *        ONLY INTENDED FOR TESTING!!!
26  * @author Christian Grothoff
27  * @author Nathan Evans
28  */
29
30 #include "platform.h"
31 #include "gnunet_hello_lib.h"
32 #include "gnunet_connection_lib.h"
33 #include "gnunet_container_lib.h"
34 #include "gnunet_os_lib.h"
35 #include "gnunet_peerinfo_service.h"
36 #include "gnunet_protocols.h"
37 #include "gnunet_resolver_service.h"
38 #include "gnunet_server_lib.h"
39 #include "gnunet_signatures.h"
40 #include "gnunet_statistics_service.h"
41 #include "gnunet_transport_service.h"
42 #include "gnunet_transport_plugin.h"
43 #include "transport.h"
44
45 #define MAX_PROBES 20
46
47 /*
48  * Transport cost to peer, always 1 for UNIX (direct connection)
49  */
50 #define UNIX_DIRECT_DISTANCE 1
51
52 #define DEFAULT_NAT_PORT 0
53
54 /**
55  * How long until we give up on transmitting the welcome message?
56  */
57 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
58
59 /**
60  * Starting port for listening and sending, eventually a config value
61  */
62 #define UNIX_NAT_DEFAULT_PORT 22086
63
64 GNUNET_NETWORK_STRUCT_BEGIN
65
66 /**
67  * UNIX Message-Packet header.
68  */
69 struct UNIXMessage
70 {
71   /**
72    * Message header.
73    */
74   struct GNUNET_MessageHeader header;
75
76   /**
77    * What is the identity of the sender (GNUNET_hash of public key)
78    */
79   struct GNUNET_PeerIdentity sender;
80
81 };
82
83 struct Session
84 {
85   void *addr;
86   size_t addrlen;
87   struct GNUNET_PeerIdentity target;
88
89   /**
90    * Session timeout task
91    */
92   GNUNET_SCHEDULER_TaskIdentifier timeout_task;
93
94   struct Plugin * plugin;
95 };
96
97 struct UNIXMessageWrapper
98 {
99   struct UNIXMessageWrapper *next;
100   struct UNIXMessageWrapper *prev;
101
102   struct UNIXMessage * msg;
103   size_t msgsize;
104
105   struct GNUNET_TIME_Relative timeout;
106   unsigned int priority;
107
108   struct Session *session;
109   GNUNET_TRANSPORT_TransmitContinuation cont;
110   void *cont_cls;
111 };
112
113 /* Forward definition */
114 struct Plugin;
115
116
117 /**
118  * UNIX NAT "Session"
119  */
120 struct PeerSession
121 {
122
123   /**
124    * Stored in a linked list.
125    */
126   struct PeerSession *next;
127
128   /**
129    * Pointer to the global plugin struct.
130    */
131   struct Plugin *plugin;
132
133   /**
134    * To whom are we talking to (set to our identity
135    * if we are still waiting for the welcome message)
136    */
137   struct GNUNET_PeerIdentity target;
138
139   /**
140    * Address of the other peer (either based on our 'connect'
141    * call or on our 'accept' call).
142    */
143   void *connect_addr;
144
145   /**
146    * Length of connect_addr.
147    */
148   size_t connect_alen;
149
150   /**
151    * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
152    */
153   int expecting_welcome;
154
155   /**
156    * From which socket do we need to send to this peer?
157    */
158   struct GNUNET_NETWORK_Handle *sock;
159
160   /*
161    * Queue of messages for this peer, in the case that
162    * we have to await a connection...
163    */
164   struct MessageQueue *messages;
165
166 };
167
168 /**
169  * Information we keep for each of our listen sockets.
170  */
171 struct UNIX_Sock_Info
172 {
173   /**
174    * The network handle
175    */
176   struct GNUNET_NETWORK_Handle *desc;
177
178   /**
179    * The port we bound to
180    */
181   uint16_t port;
182 };
183
184
185 /**
186  * Encapsulation of all of the state of the plugin.
187  */
188 struct Plugin
189 {
190   /**
191    * Our environment.
192    */
193   struct GNUNET_TRANSPORT_PluginEnvironment *env;
194
195   /**
196    * Sessions
197    */
198   struct GNUNET_CONTAINER_MultiHashMap *session_map;
199
200   /**
201    * ID of task used to update our addresses when one expires.
202    */
203   GNUNET_SCHEDULER_TaskIdentifier address_update_task;
204
205   /**
206    * ID of select task
207    */
208   GNUNET_SCHEDULER_TaskIdentifier select_task;
209
210   /**
211    * Integer to append to unix domain socket.
212    */
213   uint16_t port;
214
215   /**
216    * FD Read set
217    */
218   struct GNUNET_NETWORK_FDSet *rs;
219
220   /**
221    * FD Write set
222    */
223   struct GNUNET_NETWORK_FDSet *ws;
224
225   int with_ws;
226
227   /**
228    * socket that we transmit all data with
229    */
230   struct UNIX_Sock_Info unix_sock;
231
232   /**
233    * Path of our unix domain socket (/tmp/unix-plugin-PORT)
234    */
235   char *unix_socket_path;
236
237   struct UNIXMessageWrapper *msg_head;
238   struct UNIXMessageWrapper *msg_tail;
239
240   /**
241    * ATS network
242    */
243   struct GNUNET_ATS_Information ats_network;
244
245   unsigned int bytes_in_queue;
246   unsigned int bytes_in_sent;
247   unsigned int bytes_in_recv;
248   unsigned int bytes_discarded;
249 };
250
251 /**
252  * Start session timeout
253  */
254 static void
255 start_session_timeout (struct Session *s);
256
257 /**
258  * Increment session timeout due to activity
259  */
260 static void
261 reschedule_session_timeout (struct Session *s);
262
263 /**
264  * Cancel timeout
265  */
266 static void
267 stop_session_timeout (struct Session *s);
268
269
270 static void
271 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
272
273
274 static void
275 reschedule_select (struct Plugin * plugin)
276 {
277
278   if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
279   {
280     GNUNET_SCHEDULER_cancel (plugin->select_task);
281     plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
282   }
283
284   if (NULL != plugin->msg_head)
285   {
286     plugin->select_task =
287       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
288                                    GNUNET_TIME_UNIT_FOREVER_REL,
289                                    plugin->rs,
290                                    plugin->ws,
291                                    &unix_plugin_select, plugin);
292     plugin->with_ws = GNUNET_YES;
293   }
294   else
295   {
296     plugin->select_task =
297       GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
298                                    GNUNET_TIME_UNIT_FOREVER_REL,
299                                    plugin->rs,
300                                    NULL,
301                                    &unix_plugin_select, plugin);
302     plugin->with_ws = GNUNET_NO;
303   }
304 }
305
306 struct LookupCtx
307 {
308   struct Session *s;
309   const struct sockaddr_un *addr;
310 };
311
312 int lookup_session_it (void *cls,
313                        const struct GNUNET_HashCode * key,
314                        void *value)
315 {
316   struct LookupCtx *lctx = cls;
317   struct Session *t = value;
318
319   if (0 == strcmp (t->addr, lctx->addr->sun_path))
320   {
321     lctx->s = t;
322     return GNUNET_NO;
323   }
324   return GNUNET_YES;
325 }
326
327
328 static struct Session *
329 lookup_session (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender, const struct sockaddr_un *addr)
330 {
331   struct LookupCtx lctx;
332
333   GNUNET_assert (NULL != plugin);
334   GNUNET_assert (NULL != sender);
335   GNUNET_assert (NULL != addr);
336
337   lctx.s = NULL;
338   lctx.addr = addr;
339
340   GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &sender->hashPubKey, &lookup_session_it, &lctx);
341
342   return lctx.s;
343 }
344
345 /**
346  * Functions with this signature are called whenever we need
347  * to close a session due to a disconnect or failure to
348  * establish a connection.
349  *
350  * @param s session to close down
351  */
352 static void
353 disconnect_session (struct Session *s)
354 {
355   struct UNIXMessageWrapper *msgw;
356   struct UNIXMessageWrapper *next;
357   struct Plugin * plugin = s->plugin;
358   int removed;
359   GNUNET_assert (plugin != NULL);
360   GNUNET_assert (s != NULL);
361
362   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting session for peer `%s' `%s' \n", GNUNET_i2s (&s->target), s->addr);
363   stop_session_timeout (s);
364   plugin->env->session_end (plugin->env->cls, &s->target, s);
365
366   msgw = plugin->msg_head;
367   removed = GNUNET_NO;
368   next = plugin->msg_head;
369   while (NULL != next)
370   {
371     msgw = next;
372     next = msgw->next;
373     if (msgw->session != s)
374       continue;
375     GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
376     if (NULL != msgw->cont)
377       msgw->cont (msgw->cont_cls,  &msgw->session->target, GNUNET_SYSERR);
378     GNUNET_free (msgw->msg);
379     GNUNET_free (msgw);
380     removed = GNUNET_YES;    
381   }
382   if ((GNUNET_YES == removed) && (NULL == plugin->msg_head))
383     reschedule_select (plugin);
384
385   GNUNET_assert (GNUNET_YES ==
386                  GNUNET_CONTAINER_multihashmap_remove(plugin->session_map, &s->target.hashPubKey, s));
387
388   GNUNET_STATISTICS_set(plugin->env->stats,
389                         "# UNIX sessions active",
390                         GNUNET_CONTAINER_multihashmap_size(plugin->session_map),
391                         GNUNET_NO);
392
393   GNUNET_free (s);
394 }
395
396 static int
397 get_session_delete_it (void *cls, const struct GNUNET_HashCode * key, void *value)
398 {
399   struct Session *s = value;
400   disconnect_session (s);
401   return GNUNET_YES;
402 }
403
404
405 /**
406  * Disconnect from a remote node.  Clean up session if we have one for this peer
407  *
408  * @param cls closure for this call (should be handle to Plugin)
409  * @param target the peeridentity of the peer to disconnect
410  * @return GNUNET_OK on success, GNUNET_SYSERR if the operation failed
411  */
412 static void
413 unix_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
414 {
415   struct Plugin *plugin = cls;
416   GNUNET_assert (plugin != NULL);
417
418   GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &target->hashPubKey, &get_session_delete_it, plugin);
419   return;
420 }
421
422 /**
423  * Shutdown the server process (stop receiving inbound traffic). Maybe
424  * restarted later!
425  *
426  * @param cls Handle to the plugin for this transport
427  *
428  * @return returns the number of sockets successfully closed,
429  *         should equal the number of sockets successfully opened
430  */
431 static int
432 unix_transport_server_stop (void *cls)
433 {
434   struct Plugin *plugin = cls;
435
436   struct UNIXMessageWrapper * msgw = plugin->msg_head;
437
438   while (NULL != (msgw = plugin->msg_head))
439   {
440     GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
441     if (msgw->cont != NULL)
442       msgw->cont (msgw->cont_cls,  &msgw->session->target, GNUNET_SYSERR);
443     GNUNET_free (msgw->msg);
444     GNUNET_free (msgw);
445   }
446
447   if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
448   {
449     GNUNET_SCHEDULER_cancel (plugin->select_task);
450     plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
451   }
452
453   if (NULL != plugin->unix_sock.desc)
454   {
455     GNUNET_break (GNUNET_OK ==
456                   GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
457     plugin->unix_sock.desc = NULL;
458     plugin->with_ws = GNUNET_NO;
459   }
460   return GNUNET_OK;
461 }
462
463
464 /**
465  * Actually send out the message, assume we've got the address and
466  * send_handle squared away!
467  *
468  * @param cls closure
469  * @param send_handle which handle to send message on
470  * @param target who should receive this message (ignored by UNIX)
471  * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
472  * @param msgbuf_size the size of the msgbuf to send
473  * @param priority how important is the message (ignored by UNIX)
474  * @param timeout when should we time out (give up) if we can not transmit?
475  * @param addr the addr to send the message to, needs to be a sockaddr for us
476  * @param addrlen the len of addr
477  * @param cont continuation to call once the message has
478  *        been transmitted (or if the transport is ready
479  *        for the next transmission call; or if the
480  *        peer disconnected...)
481  * @param cont_cls closure for cont
482  *
483  * @return the number of bytes written, -1 on errors
484  */
485 static ssize_t
486 unix_real_send (void *cls,
487                 struct GNUNET_NETWORK_Handle *send_handle,
488                 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
489                 size_t msgbuf_size, unsigned int priority,
490                 struct GNUNET_TIME_Relative timeout, const void *addr,
491                 size_t addrlen, GNUNET_TRANSPORT_TransmitContinuation cont,
492                 void *cont_cls)
493 {
494   struct Plugin *plugin = cls;
495   ssize_t sent;
496   const void *sb;
497   size_t sbs;
498   struct sockaddr_un un;
499   size_t slen;
500   int retry;
501
502   GNUNET_assert (NULL != plugin);
503
504   if (send_handle == NULL)
505   {
506     /* We do not have a send handle */
507     GNUNET_break (0);
508     if (cont != NULL)
509       cont (cont_cls, target, GNUNET_SYSERR);
510     return -1;
511   }
512   if ((addr == NULL) || (addrlen == 0))
513   {
514     /* Can never send if we don't have an address */
515     GNUNET_break (0);
516     if (cont != NULL)
517       cont (cont_cls, target, GNUNET_SYSERR);
518     return -1;
519   }
520
521   /* Prepare address */
522   memset (&un, 0, sizeof (un));
523   un.sun_family = AF_UNIX;
524   slen = strlen (addr) + 1;
525   if (slen >= sizeof (un.sun_path))
526     slen = sizeof (un.sun_path) - 1;
527   GNUNET_assert (slen < sizeof (un.sun_path));
528   memcpy (un.sun_path, addr, slen);
529   un.sun_path[slen] = '\0';
530   slen = sizeof (struct sockaddr_un);
531 #if LINUX
532   un.sun_path[0] = '\0';
533 #endif
534 #if HAVE_SOCKADDR_IN_SIN_LEN
535   un.sun_len = (u_char) slen;
536 #endif
537   sb = (struct sockaddr *) &un;
538   sbs = slen;
539
540   /* Send the data */
541   sent = 0;
542   retry = GNUNET_NO;
543   sent = GNUNET_NETWORK_socket_sendto (send_handle, msgbuf, msgbuf_size, sb, sbs);
544
545   if ((GNUNET_SYSERR == sent) && ((errno == EAGAIN) || (errno == ENOBUFS)))
546   {
547     /* We have to retry later: retry */
548     return 0;
549   }
550
551   if ((GNUNET_SYSERR == sent) && (errno == EMSGSIZE))
552   {
553     socklen_t size = 0;
554     socklen_t len = sizeof (size);
555
556     GNUNET_NETWORK_socket_getsockopt ((struct GNUNET_NETWORK_Handle *)
557                                       send_handle, SOL_SOCKET, SO_SNDBUF, &size,
558                                       &len);
559
560     if (size < msgbuf_size)
561     {
562       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
563                   "Trying to increase socket buffer size from %i to %i for message size %i\n",
564                   size,
565                   ((msgbuf_size / 1000) + 2) * 1000,
566                   msgbuf_size);
567       size = ((msgbuf_size / 1000) + 2) * 1000;
568       if (GNUNET_NETWORK_socket_setsockopt
569           ((struct GNUNET_NETWORK_Handle *) send_handle, SOL_SOCKET, SO_SNDBUF,
570            &size, sizeof (size)) == GNUNET_OK)
571       {
572         /* Increased buffer size, retry sending */
573         return 0;
574       }
575       else
576       {
577         /* Could not increase buffer size: error, no retry */
578         GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
579         return -1;
580       }
581     }
582     else
583     {
584       /* Buffer is bigger than message:  error, no retry
585        * This should never happen!*/
586       GNUNET_break (0);
587       return -1;
588     }
589   }
590
591   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
592               "UNIX transmit %u-byte message to %s (%d: %s)\n",
593               (unsigned int) msgbuf_size, GNUNET_a2s (sb, sbs), (int) sent,
594               (sent < 0) ? STRERROR (errno) : "ok");
595
596   /* Calling continuation */
597   if (cont != NULL)
598   {
599     if ((sent == GNUNET_SYSERR) && (retry == GNUNET_NO))
600       cont (cont_cls, target, GNUNET_SYSERR);
601     if (sent > 0)
602       cont (cont_cls, target, GNUNET_OK);
603   }
604
605   /* return number of bytes successfully sent */
606   if (sent > 0)
607     return sent;
608   if (sent == 0)
609   {
610     /* That should never happen */
611     GNUNET_break (0);
612     return -1;
613   }
614   /* failed and retry: return 0 */
615   if ((GNUNET_SYSERR == sent) && (retry == GNUNET_YES))
616     return 0;
617   /* failed and no retry: return -1 */
618   if ((GNUNET_SYSERR == sent) && (retry == GNUNET_NO))
619     return -1;
620   /* default */
621   return -1;
622 }
623
624 struct gsi_ctx
625 {
626   char *address;
627   size_t addrlen;
628   struct Session *res;
629 };
630
631
632 static int
633 get_session_it (void *cls, const struct GNUNET_HashCode * key, void *value)
634 {
635   struct gsi_ctx *gsi = cls;
636   struct Session *s = value;
637
638   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Comparing session %s %s\n", gsi->address, s->addr);
639   if ((gsi->addrlen == s->addrlen) &&
640       (0 == memcmp (gsi->address, s->addr, s->addrlen)))
641   {
642     gsi->res = s;
643     return GNUNET_NO;
644   }
645   return GNUNET_YES;
646 }
647
648 /**
649  * Creates a new outbound session the transport service will use to send data to the
650  * peer
651  *
652  * @param cls the plugin
653  * @param address the address
654  * @return the session or NULL of max connections exceeded
655  */
656 static struct Session *
657 unix_plugin_get_session (void *cls,
658                   const struct GNUNET_HELLO_Address *address)
659 {
660   struct Session * s = NULL;
661   struct Plugin *plugin = cls;
662   struct gsi_ctx gsi;
663
664   /* Checks */
665   GNUNET_assert (plugin != NULL);
666   GNUNET_assert (address != NULL);
667
668   /* Check if already existing */
669   gsi.address = (char *) address->address;
670   gsi.addrlen = address->address_length;
671   gsi.res = NULL;
672   GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &address->peer.hashPubKey, &get_session_it, &gsi);
673   if (gsi.res != NULL)
674   {
675     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Found existing session\n");
676     return gsi.res;
677   }
678
679   /* Create a new session */
680   s = GNUNET_malloc (sizeof (struct Session) + address->address_length);
681   s->addr = &s[1];
682   s->addrlen = address->address_length;
683   s->plugin = plugin;
684   memcpy(s->addr, address->address, s->addrlen);
685   memcpy(&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
686
687   start_session_timeout (s);
688
689   GNUNET_CONTAINER_multihashmap_put (plugin->session_map,
690       &address->peer.hashPubKey, s,
691       GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
692
693   GNUNET_STATISTICS_set(plugin->env->stats,
694                         "# UNIX sessions active",
695                         GNUNET_CONTAINER_multihashmap_size(plugin->session_map),
696                         GNUNET_NO);
697   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Creating new session\n");
698   return s;
699 }
700
701 /*
702  * @param cls the plugin handle
703  * @param tc the scheduling context (for rescheduling this function again)
704  *
705  * We have been notified that our writeset has something to read.  We don't
706  * know which socket needs to be read, so we have to check each one
707  * Then reschedule this function to be called again once more is available.
708  *
709  */
710 static void
711 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
712
713 /**
714  * Function that can be used by the transport service to transmit
715  * a message using the plugin.   Note that in the case of a
716  * peer disconnecting, the continuation MUST be called
717  * prior to the disconnect notification itself.  This function
718  * will be called with this peer's HELLO message to initiate
719  * a fresh connection to another peer.
720  *
721  * @param cls closure
722  * @param session which session must be used
723  * @param msgbuf the message to transmit
724  * @param msgbuf_size number of bytes in 'msgbuf'
725  * @param priority how important is the message (most plugins will
726  *                 ignore message priority and just FIFO)
727  * @param to how long to wait at most for the transmission (does not
728  *                require plugins to discard the message after the timeout,
729  *                just advisory for the desired delay; most plugins will ignore
730  *                this as well)
731  * @param cont continuation to call once the message has
732  *        been transmitted (or if the transport is ready
733  *        for the next transmission call; or if the
734  *        peer disconnected...); can be NULL
735  * @param cont_cls closure for cont
736  * @return number of bytes used (on the physical network, with overheads);
737  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
738  *         and does NOT mean that the message was not transmitted (DV)
739  */
740 static ssize_t
741 unix_plugin_send (void *cls,
742                   struct Session *session,
743                   const char *msgbuf, size_t msgbuf_size,
744                   unsigned int priority,
745                   struct GNUNET_TIME_Relative to,
746                   GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
747 {
748   struct Plugin *plugin = cls;
749   struct UNIXMessageWrapper *wrapper;
750   struct UNIXMessage *message;
751   int ssize;
752
753   GNUNET_assert (plugin != NULL);
754   GNUNET_assert (session != NULL);
755
756   if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_contains_value(plugin->session_map,
757       &session->target.hashPubKey, session))
758   {
759     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid session for peer `%s' `%s'\n",
760                 GNUNET_i2s (&session->target),
761                 (char *) session->addr);
762     GNUNET_break (0);
763
764     return GNUNET_SYSERR;
765   }
766
767   ssize = sizeof (struct UNIXMessage) + msgbuf_size;
768   message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
769   message->header.size = htons (ssize);
770   message->header.type = htons (0);
771   memcpy (&message->sender, plugin->env->my_identity,
772           sizeof (struct GNUNET_PeerIdentity));
773   memcpy (&message[1], msgbuf, msgbuf_size);
774
775   reschedule_session_timeout (session);
776
777   wrapper = GNUNET_malloc (sizeof (struct UNIXMessageWrapper));
778   wrapper->msg = message;
779   wrapper->msgsize = ssize;
780   wrapper->priority = priority;
781   wrapper->timeout = to;
782   wrapper->cont = cont;
783   wrapper->cont_cls = cont_cls;
784   wrapper->session = session;
785
786   GNUNET_CONTAINER_DLL_insert(plugin->msg_head, plugin->msg_tail, wrapper);
787
788   plugin->bytes_in_queue += ssize;
789   GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes in send queue",
790       plugin->bytes_in_queue, GNUNET_NO);
791
792   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Sent %d bytes to `%s'\n", ssize,
793               (char *) session->addr);
794   if (plugin->with_ws == GNUNET_NO)
795   {
796     reschedule_select (plugin);
797   }
798   return ssize;
799 }
800
801
802 /**
803  * Demultiplexer for UNIX messages
804  *
805  * @param plugin the main plugin for this transport
806  * @param sender from which peer the message was received
807  * @param currhdr pointer to the header of the message
808  * @param un the address from which the message was received
809  * @param fromlen the length of the address
810  */
811 static void
812 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
813                     const struct GNUNET_MessageHeader *currhdr,
814                     const struct sockaddr_un *un, size_t fromlen)
815 {
816   struct GNUNET_ATS_Information ats[2];
817   struct Session *s = NULL;
818   struct GNUNET_HELLO_Address * addr;
819
820   ats[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
821   ats[0].value = htonl (UNIX_DIRECT_DISTANCE);
822   ats[1] = plugin->ats_network;
823   GNUNET_break (ntohl(plugin->ats_network.value) != GNUNET_ATS_NET_UNSPECIFIED);
824
825   GNUNET_assert (fromlen >= sizeof (struct sockaddr_un));
826
827   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received message from %s\n",
828               un->sun_path);
829
830   plugin->bytes_in_recv += ntohs(currhdr->size);
831   GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes received",
832       plugin->bytes_in_recv, GNUNET_NO);
833
834   addr = GNUNET_HELLO_address_allocate(sender, "unix", un->sun_path, strlen (un->sun_path) + 1);
835   s = lookup_session (plugin, sender, un);
836   if (NULL == s)
837     s = unix_plugin_get_session (plugin, addr);
838   reschedule_session_timeout (s);
839
840   plugin->env->receive (plugin->env->cls, sender, currhdr,
841                         (const struct GNUNET_ATS_Information *) &ats, 2,
842                         s, un->sun_path, strlen (un->sun_path) + 1);
843   GNUNET_free (addr);
844 }
845
846
847 static void
848 unix_plugin_select_read (struct Plugin * plugin)
849 {
850   char buf[65536] GNUNET_ALIGN;
851   struct UNIXMessage *msg;
852   struct GNUNET_PeerIdentity sender;
853   struct sockaddr_un un;
854   socklen_t addrlen;
855   ssize_t ret;
856   int offset;
857   int tsize;
858   char *msgbuf;
859   const struct GNUNET_MessageHeader *currhdr;
860   uint16_t csize;
861
862   addrlen = sizeof (un);
863   memset (&un, 0, sizeof (un));
864
865   ret =
866       GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc, buf, sizeof (buf),
867                                       (struct sockaddr *) &un, &addrlen);
868
869   if ((GNUNET_SYSERR == ret) && ((errno == EAGAIN) || (errno == ENOBUFS)))
870     return;
871
872   if (ret == GNUNET_SYSERR)
873   {
874     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "recvfrom");
875     return;
876   }
877   else
878   {
879 #if LINUX
880     un.sun_path[0] = '/';
881 #endif
882     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Read %d bytes from socket %s\n", ret,
883                 &un.sun_path[0]);
884   }
885
886   GNUNET_assert (AF_UNIX == (un.sun_family));
887
888   msg = (struct UNIXMessage *) buf;
889   csize = ntohs (msg->header.size);
890   if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
891   {
892     GNUNET_break_op (0);
893     return;
894   }
895   msgbuf = (char *) &msg[1];
896   memcpy (&sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
897   offset = 0;
898   tsize = csize - sizeof (struct UNIXMessage);
899   while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
900   {
901     currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
902     csize = ntohs (currhdr->size);
903     if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
904         (csize > tsize - offset))
905     {
906       GNUNET_break_op (0);
907       break;
908     }
909
910     unix_demultiplexer (plugin, &sender, currhdr, &un, sizeof (un));
911     offset += csize;
912   }
913 }
914
915
916 static void
917 unix_plugin_select_write (struct Plugin * plugin)
918 {
919   static int retry_counter;
920   int sent = 0;
921   struct UNIXMessageWrapper * msgw = plugin->msg_head;
922
923   sent = unix_real_send (plugin,
924                          plugin->unix_sock.desc,
925                          &msgw->session->target,
926                          (const char *) msgw->msg,
927                          msgw->msgsize,
928                          msgw->priority,
929                          msgw->timeout,
930                          msgw->session->addr,
931                          msgw->session->addrlen,
932                          msgw->cont, msgw->cont_cls);
933
934   if (sent == 0)
935   {
936     /* failed and retry */
937     retry_counter++;
938     GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX retry attempt",
939         retry_counter, GNUNET_NO);
940     return;
941   }
942
943   if (retry_counter > 0 )
944   {
945     /* no retry: reset counter */
946     retry_counter = 0;
947     GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX retry attempt",
948         retry_counter, GNUNET_NO);
949   }
950
951   if (sent == -1)
952   {
953     /* failed and no retry */
954     GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
955
956     GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
957     plugin->bytes_in_queue -= msgw->msgsize;
958     GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes in send queue",
959         plugin->bytes_in_queue, GNUNET_NO);
960     plugin->bytes_discarded += msgw->msgsize;
961     GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes discarded",
962         plugin->bytes_discarded, GNUNET_NO);
963
964     GNUNET_free (msgw->msg);
965     GNUNET_free (msgw);
966     return;
967   }
968
969   if (sent > 0)
970   {
971     /* successfully sent bytes */
972     GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
973
974     GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
975     plugin->bytes_in_queue -= msgw->msgsize;
976     GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes in send queue",
977         plugin->bytes_in_queue, GNUNET_NO);
978     plugin->bytes_in_sent += msgw->msgsize;
979     GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes sent",
980         plugin->bytes_in_sent, GNUNET_NO);
981
982     GNUNET_free (msgw->msg);
983     GNUNET_free (msgw);
984     return;
985   }
986
987 }
988
989
990 /**
991  * We have been notified that our writeset has something to read.  We don't
992  * know which socket needs to be read, so we have to check each one
993  * Then reschedule this function to be called again once more is available.
994  *
995  * @param cls the plugin handle
996  * @param tc the scheduling context (for rescheduling this function again)
997  */
998 static void
999 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1000 {
1001   struct Plugin *plugin = cls;
1002
1003   plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
1004   if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
1005     return;
1006
1007   if ((tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY) != 0)
1008   {
1009     /* Ready to send data */
1010     GNUNET_assert (GNUNET_NETWORK_fdset_isset
1011                    (tc->write_ready, plugin->unix_sock.desc));
1012     if (plugin->msg_head != NULL)
1013       unix_plugin_select_write (plugin);
1014   }
1015
1016   if ((tc->reason & GNUNET_SCHEDULER_REASON_READ_READY) != 0)
1017   {
1018     /* Ready to receive data */
1019     GNUNET_assert (GNUNET_NETWORK_fdset_isset
1020                    (tc->read_ready, plugin->unix_sock.desc));
1021     unix_plugin_select_read (plugin);
1022   }
1023
1024   reschedule_select (plugin);
1025 }
1026
1027
1028 /**
1029  * Create a slew of UNIX sockets.  If possible, use IPv6 and IPv4.
1030  *
1031  * @param cls closure for server start, should be a struct Plugin *
1032  * @return number of sockets created or GNUNET_SYSERR on error
1033  */
1034 static int
1035 unix_transport_server_start (void *cls)
1036 {
1037   struct Plugin *plugin = cls;
1038   struct sockaddr *serverAddr;
1039   socklen_t addrlen;
1040   struct sockaddr_un un;
1041   size_t slen;
1042
1043   memset (&un, 0, sizeof (un));
1044   un.sun_family = AF_UNIX;
1045   slen = strlen (plugin->unix_socket_path) + 1;
1046   if (slen >= sizeof (un.sun_path))
1047     slen = sizeof (un.sun_path) - 1;
1048
1049   memcpy (un.sun_path, plugin->unix_socket_path, slen);
1050   un.sun_path[slen] = '\0';
1051   slen = sizeof (struct sockaddr_un);
1052 #if HAVE_SOCKADDR_IN_SIN_LEN
1053   un.sun_len = (u_char) slen;
1054 #endif
1055
1056   serverAddr = (struct sockaddr *) &un;
1057   addrlen = slen;
1058 #if LINUX
1059   un.sun_path[0] = '\0';
1060 #endif
1061   plugin->ats_network = plugin->env->get_address_type (plugin->env->cls, serverAddr, addrlen);
1062   plugin->unix_sock.desc =
1063       GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_DGRAM, 0);
1064   if (NULL == plugin->unix_sock.desc)
1065   {
1066     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
1067     return GNUNET_SYSERR;
1068   }
1069   if (GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, serverAddr, addrlen)
1070       != GNUNET_OK)
1071   {
1072     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
1073     GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
1074     plugin->unix_sock.desc = NULL;
1075     return GNUNET_SYSERR;
1076   }
1077   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "unix", "Bound to `%s'\n",
1078                    &un.sun_path[0]);
1079   plugin->rs = GNUNET_NETWORK_fdset_create ();
1080   plugin->ws = GNUNET_NETWORK_fdset_create ();
1081   GNUNET_NETWORK_fdset_zero (plugin->rs);
1082   GNUNET_NETWORK_fdset_zero (plugin->ws);
1083   GNUNET_NETWORK_fdset_set (plugin->rs, plugin->unix_sock.desc);
1084   GNUNET_NETWORK_fdset_set (plugin->ws, plugin->unix_sock.desc);
1085
1086   reschedule_select (plugin);
1087
1088   return 1;
1089 }
1090
1091
1092 /**
1093  * Function that will be called to check if a binary address for this
1094  * plugin is well-formed and corresponds to an address for THIS peer
1095  * (as per our configuration).  Naturally, if absolutely necessary,
1096  * plugins can be a bit conservative in their answer, but in general
1097  * plugins should make sure that the address does not redirect
1098  * traffic to a 3rd party that might try to man-in-the-middle our
1099  * traffic.
1100  *
1101  * @param cls closure, should be our handle to the Plugin
1102  * @param addr pointer to the address
1103  * @param addrlen length of addr
1104  * @return GNUNET_OK if this is a plausible address for this peer
1105  *         and transport, GNUNET_SYSERR if not
1106  *
1107  */
1108 static int
1109 unix_check_address (void *cls, const void *addr, size_t addrlen)
1110 {
1111   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1112               "Informing transport service about my address `%s'\n",
1113               (char *) addr);
1114   return GNUNET_OK;
1115 }
1116
1117
1118 /**
1119  * Convert the transports address to a nice, human-readable
1120  * format.
1121  *
1122  * @param cls closure
1123  * @param type name of the transport that generated the address
1124  * @param addr one of the addresses of the host, NULL for the last address
1125  *        the specific address format depends on the transport
1126  * @param addrlen length of the address
1127  * @param numeric should (IP) addresses be displayed in numeric form?
1128  * @param timeout after how long should we give up?
1129  * @param asc function to call on each string
1130  * @param asc_cls closure for asc
1131  */
1132 static void
1133 unix_plugin_address_pretty_printer (void *cls, const char *type,
1134                                     const void *addr, size_t addrlen,
1135                                     int numeric,
1136                                     struct GNUNET_TIME_Relative timeout,
1137                                     GNUNET_TRANSPORT_AddressStringCallback asc,
1138                                     void *asc_cls)
1139 {
1140   if ((NULL != addr) && (addrlen > 0))
1141   {
1142     asc (asc_cls, (const char *) addr);
1143   }
1144   else
1145   {
1146     GNUNET_break (0);
1147     asc (asc_cls, "<invalid UNIX address>");
1148   }
1149   asc (asc_cls, NULL);
1150 }
1151
1152
1153 /**
1154  * Function called to convert a string address to
1155  * a binary address.
1156  *
1157  * @param cls closure ('struct Plugin*')
1158  * @param addr string address
1159  * @param addrlen length of the address (strlen(addr) + '\0')
1160  * @param buf location to store the buffer
1161  *        If the function returns GNUNET_SYSERR, its contents are undefined.
1162  * @param added length of created address
1163  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
1164  */
1165 static int
1166 unix_string_to_address (void *cls, const char *addr, uint16_t addrlen,
1167     void **buf, size_t *added)
1168 {
1169   if ((NULL == addr) || (0 == addrlen))
1170   {
1171     GNUNET_break (0);
1172     return GNUNET_SYSERR;
1173   }
1174
1175   if ('\0' != addr[addrlen - 1])
1176   {
1177     GNUNET_break (0);
1178     return GNUNET_SYSERR;
1179   }
1180
1181   if (strlen (addr) != addrlen - 1)
1182   {
1183     GNUNET_break (0);
1184     return GNUNET_SYSERR;
1185   }
1186
1187   (*buf) = strdup (addr);
1188   (*added) = strlen (addr) + 1;
1189   return GNUNET_OK;
1190 }
1191
1192
1193 /**
1194  * Function called for a quick conversion of the binary address to
1195  * a numeric address.  Note that the caller must not free the
1196  * address and that the next call to this function is allowed
1197  * to override the address again.
1198  *
1199  * @param cls closure
1200  * @param addr binary address
1201  * @param addrlen length of the address
1202  * @return string representing the same address
1203  */
1204 static const char *
1205 unix_address_to_string (void *cls, const void *addr, size_t addrlen)
1206 {
1207   if ((addr != NULL) && (addrlen > 0))
1208     return (const char *) addr;
1209   return NULL;
1210 }
1211
1212
1213 /**
1214  * Notify transport service about address
1215  *
1216  * @param cls the plugin
1217  * @param tc unused
1218  */
1219 static void
1220 address_notification (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1221 {
1222   struct Plugin *plugin = cls;
1223
1224   plugin->env->notify_address (plugin->env->cls, GNUNET_YES,
1225                                plugin->unix_socket_path,
1226                                strlen (plugin->unix_socket_path) + 1);
1227 }
1228
1229
1230 /**
1231  * Session was idle, so disconnect it
1232  */
1233 static void
1234 session_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1235 {
1236   GNUNET_assert (NULL != cls);
1237   struct Session *s = cls;
1238
1239   s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1240
1241   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Session %p was idle for %llu, disconnecting\n",
1242       s, GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1243
1244   /* call session destroy function */
1245   disconnect_session(s);
1246
1247 }
1248
1249 /**
1250  * Start session timeout
1251  */
1252 static void
1253 start_session_timeout (struct Session *s)
1254 {
1255   GNUNET_assert (NULL != s);
1256   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == s->timeout_task);
1257
1258   s->timeout_task =  GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1259                                                    &session_timeout,
1260                                                    s);
1261
1262   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Timeout for session %p set to %llu\n",
1263       s, GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1264 }
1265
1266 /**
1267  * Increment session timeout due to activity
1268  */
1269 static void
1270 reschedule_session_timeout (struct Session *s)
1271 {
1272   GNUNET_assert (NULL != s);
1273   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != s->timeout_task);
1274
1275   GNUNET_SCHEDULER_cancel (s->timeout_task);
1276   s->timeout_task =  GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1277                                                    &session_timeout,
1278                                                    s);
1279
1280   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Timeout rescheduled for session %p set to %llu\n",
1281       s, GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1282 }
1283
1284 /**
1285  * Cancel timeout
1286  */
1287 static void
1288 stop_session_timeout (struct Session *s)
1289 {
1290   GNUNET_assert (NULL != s);
1291
1292   if (GNUNET_SCHEDULER_NO_TASK != s->timeout_task)
1293   {
1294     GNUNET_SCHEDULER_cancel (s->timeout_task);
1295     s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1296
1297     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Timeout rescheduled for session %p canceled\n",
1298       s, GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1299   }
1300   else
1301   {
1302     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Timeout for session %p was not active\n",
1303       s);
1304   }
1305 }
1306
1307
1308 /**
1309  * The exported method. Makes the core api available via a global and
1310  * returns the unix transport API.
1311  */
1312 void *
1313 libgnunet_plugin_transport_unix_init (void *cls)
1314 {
1315   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1316   unsigned long long port;
1317   struct GNUNET_TRANSPORT_PluginFunctions *api;
1318   struct Plugin *plugin;
1319   int sockets_created;
1320
1321   if (NULL == env->receive)
1322   {
1323     /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1324        initialze the plugin or the API */
1325     api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1326     api->cls = NULL;
1327     api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1328     api->address_to_string = &unix_address_to_string;
1329     api->string_to_address = &unix_string_to_address;
1330     return api;
1331   }
1332   GNUNET_assert( NULL != env->stats);
1333
1334   if (GNUNET_OK !=
1335       GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
1336                                              &port))
1337     port = UNIX_NAT_DEFAULT_PORT;
1338   plugin = GNUNET_malloc (sizeof (struct Plugin));
1339   plugin->port = port;
1340   plugin->env = env;
1341   GNUNET_asprintf (&plugin->unix_socket_path, "/tmp/unix-plugin-sock.%d",
1342                    plugin->port);
1343
1344   api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1345   api->cls = plugin;
1346
1347   api->get_session = &unix_plugin_get_session;
1348   api->send = &unix_plugin_send;
1349   api->disconnect = &unix_disconnect;
1350   api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1351   api->address_to_string = &unix_address_to_string;
1352   api->check_address = &unix_check_address;
1353   api->string_to_address = &unix_string_to_address;
1354   sockets_created = unix_transport_server_start (plugin);
1355   if (sockets_created == 0)
1356     GNUNET_log (GNUNET_ERROR_TYPE_WARNING, _("Failed to open UNIX sockets\n"));
1357
1358   plugin->session_map = GNUNET_CONTAINER_multihashmap_create(10);
1359
1360   GNUNET_SCHEDULER_add_now (address_notification, plugin);
1361   return api;
1362 }
1363
1364 void *
1365 libgnunet_plugin_transport_unix_done (void *cls)
1366 {
1367   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1368   struct Plugin *plugin = api->cls;
1369
1370   if (NULL == plugin)
1371   {
1372     GNUNET_free (api);
1373     return NULL;
1374   }
1375   unix_transport_server_stop (plugin);
1376
1377   GNUNET_CONTAINER_multihashmap_iterate (plugin->session_map, &get_session_delete_it, plugin);
1378   GNUNET_CONTAINER_multihashmap_destroy (plugin->session_map);
1379
1380   if (NULL != plugin->rs)
1381     GNUNET_NETWORK_fdset_destroy (plugin->rs);
1382   if (NULL != plugin->ws)
1383     GNUNET_NETWORK_fdset_destroy (plugin->ws);
1384   GNUNET_free (plugin->unix_socket_path);
1385   GNUNET_free (plugin);
1386   GNUNET_free (api);
1387   return NULL;
1388 }
1389
1390 /* end of plugin_transport_unix.c */