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