src/transport/plugin_transport_unix.c

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2010-2014 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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, 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 #include "platform.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_hello_lib.h"
  32 #include "gnunet_protocols.h"
  33 #include "gnunet_statistics_service.h"
  34 #include "gnunet_transport_service.h"
  35 #include "gnunet_transport_plugin.h"
  36 #include "transport.h"
  37
  38
  39 /**
  40  * Return code we give on 'send' if we failed to send right now
  41  * but it makes sense to retry later. (Note: we might want to
  42  * move this to the plugin API!?).
  43  */
  44 #define RETRY 0
  45
  46 /**
  47  * Name of the plugin.
  48  */
  49 #define PLUGIN_NAME "unix"
  50
  51 /**
  52  * Options for UNIX Domain addresses.
  53  */
  54 enum UNIX_ADDRESS_OPTIONS
  55 {
  56   /**
  57    * No special options.
  58    */
  59   UNIX_OPTIONS_NONE = 0,
  60
  61   /**
  62    * Linux abstract domain sockets should be used.
  63    */
  64   UNIX_OPTIONS_USE_ABSTRACT_SOCKETS = 1
  65 };
  66
  67
  68 /**
  69  * How long until we give up on transmitting the welcome message?
  70  */
  71 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  72
  73 #define LOG(kind,...) GNUNET_log_from (kind, "transport-unix",__VA_ARGS__)
  74
  75
  76 GNUNET_NETWORK_STRUCT_BEGIN
  77
  78 /**
  79  * Binary format for an UNIX Domain Socket address in GNUnet.
  80  */
  81 struct UnixAddress
  82 {
  83   /**
  84    * Options to use for the address, in NBO
  85    */
  86   uint32_t options GNUNET_PACKED;
  87
  88   /**
  89    * Length of the address (path length), in NBO
  90    */
  91   uint32_t addrlen GNUNET_PACKED;
  92
  93   /* followed by actual path */
  94 };
  95
  96
  97 /**
  98  * UNIX Message-Packet header.
  99  */
 100 struct UNIXMessage
 101 {
 102   /**
 103    * Message header.
 104    */
 105   struct GNUNET_MessageHeader header;
 106
 107   /**
 108    * What is the identity of the sender (GNUNET_hash of public key)
 109    */
 110   struct GNUNET_PeerIdentity sender;
 111
 112 };
 113
 114 GNUNET_NETWORK_STRUCT_END
 115
 116
 117 /**
 118  * Information we track for a message awaiting transmission.
 119  */
 120 struct UNIXMessageWrapper
 121 {
 122   /**
 123    * We keep messages in a doubly linked list.
 124    */
 125   struct UNIXMessageWrapper *next;
 126
 127   /**
 128    * We keep messages in a doubly linked list.
 129    */
 130   struct UNIXMessageWrapper *prev;
 131
 132   /**
 133    * The actual payload (allocated separately right now).
 134    */
 135   struct UNIXMessage *msg;
 136
 137   /**
 138    * Session this message belongs to.
 139    */
 140   struct GNUNET_ATS_Session *session;
 141
 142   /**
 143    * Function to call upon transmission.
 144    */
 145   GNUNET_TRANSPORT_TransmitContinuation cont;
 146
 147   /**
 148    * Closure for @e cont.
 149    */
 150   void *cont_cls;
 151
 152   /**
 153    * Timeout for this message.
 154    */
 155   struct GNUNET_TIME_Absolute timeout;
 156
 157   /**
 158    * Number of bytes in @e msg.
 159    */
 160   size_t msgsize;
 161
 162   /**
 163    * Number of bytes of payload encapsulated in @e msg.
 164    */
 165   size_t payload;
 166
 167   /**
 168    * Priority of the message (ignored, just dragged along in UNIX).
 169    */
 170   unsigned int priority;
 171 };
 172
 173
 174 /**
 175  * Handle for a session.
 176  */
 177 struct GNUNET_ATS_Session
 178 {
 179
 180   /**
 181    * Sessions with pending messages (!) are kept in a DLL.
 182    */
 183   struct GNUNET_ATS_Session *next;
 184
 185   /**
 186    * Sessions with pending messages (!) are kept in a DLL.
 187    */
 188   struct GNUNET_ATS_Session *prev;
 189
 190   /**
 191    * To whom are we talking to (set to our identity
 192    * if we are still waiting for the welcome message).
 193    *
 194    * FIXME: information duplicated with 'peer' in address!
 195    */
 196   struct GNUNET_PeerIdentity target;
 197
 198   /**
 199    * Pointer to the global plugin struct.
 200    */
 201   struct Plugin *plugin;
 202
 203   /**
 204    * Address of the other peer.
 205    */
 206   struct GNUNET_HELLO_Address *address;
 207
 208   /**
 209    * Number of bytes we currently have in our write queue.
 210    */
 211   unsigned long long bytes_in_queue;
 212
 213   /**
 214    * Timeout for this session.
 215    */
 216   struct GNUNET_TIME_Absolute timeout;
 217
 218   /**
 219    * Session timeout task.
 220    */
 221   struct GNUNET_SCHEDULER_Task * timeout_task;
 222
 223   /**
 224    * Number of messages we currently have in our write queue.
 225    */
 226   unsigned int msgs_in_queue;
 227
 228 };
 229
 230
 231 /**
 232  * Encapsulation of all of the state of the plugin.
 233  */
 234 struct Plugin;
 235
 236
 237 /**
 238  * Information we keep for each of our listen sockets.
 239  */
 240 struct UNIX_Sock_Info
 241 {
 242   /**
 243    * The network handle
 244    */
 245   struct GNUNET_NETWORK_Handle *desc;
 246 };
 247
 248
 249 /**
 250  * Encapsulation of all of the state of the plugin.
 251  */
 252 struct Plugin
 253 {
 254
 255   /**
 256    * ID of task used to update our addresses when one expires.
 257    */
 258   struct GNUNET_SCHEDULER_Task * address_update_task;
 259
 260   /**
 261    * ID of read task
 262    */
 263   struct GNUNET_SCHEDULER_Task * read_task;
 264
 265   /**
 266    * ID of write task
 267    */
 268   struct GNUNET_SCHEDULER_Task * write_task;
 269
 270   /**
 271    * Number of bytes we currently have in our write queues.
 272    */
 273   unsigned long long bytes_in_queue;
 274
 275   /**
 276    * Our environment.
 277    */
 278   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 279
 280   /**
 281    * Sessions (map from peer identity to `struct GNUNET_ATS_Session`)
 282    */
 283   struct GNUNET_CONTAINER_MultiPeerMap *session_map;
 284
 285   /**
 286    * Head of queue of messages to transmit.
 287    */
 288   struct UNIXMessageWrapper *msg_head;
 289
 290   /**
 291    * Tail of queue of messages to transmit.
 292    */
 293   struct UNIXMessageWrapper *msg_tail;
 294
 295   /**
 296    * Path of our unix domain socket (/tmp/unix-plugin)
 297    */
 298   char *unix_socket_path;
 299
 300   /**
 301    * Function to call about session status changes.
 302    */
 303   GNUNET_TRANSPORT_SessionInfoCallback sic;
 304
 305   /**
 306    * Closure for @e sic.
 307    */
 308   void *sic_cls;
 309
 310   /**
 311    * socket that we transmit all data with
 312    */
 313   struct UNIX_Sock_Info unix_sock;
 314
 315   /**
 316    * Address options in HBO
 317    */
 318   uint32_t myoptions;
 319
 320   /**
 321    * Are we using an abstract UNIX domain socket?
 322    */
 323   int is_abstract;
 324
 325 };
 326
 327
 328 /**
 329  * If a session monitor is attached, notify it about the new
 330  * session state.
 331  *
 332  * @param plugin our plugin
 333  * @param session session that changed state
 334  * @param state new state of the session
 335  */
 336 static void
 337 notify_session_monitor (struct Plugin *plugin,
 338                         struct GNUNET_ATS_Session *session,
 339                         enum GNUNET_TRANSPORT_SessionState state)
 340 {
 341   struct GNUNET_TRANSPORT_SessionInfo info;
 342
 343   if (NULL == plugin->sic)
 344     return;
 345   memset (&info, 0, sizeof (info));
 346   info.state = state;
 347   info.is_inbound = GNUNET_SYSERR; /* hard to say */
 348   info.num_msg_pending = session->msgs_in_queue;
 349   info.num_bytes_pending = session->bytes_in_queue;
 350   /* info.receive_delay remains zero as this is not supported by UNIX
 351      (cannot selectively not receive from 'some' peer while continuing
 352      to receive from others) */
 353   info.session_timeout = session->timeout;
 354   info.address = session->address;
 355   plugin->sic (plugin->sic_cls,
 356                session,
 357                &info);
 358 }
 359
 360
 361 /**
 362  * Function called for a quick conversion of the binary address to
 363  * a numeric address.  Note that the caller must not free the
 364  * address and that the next call to this function is allowed
 365  * to override the address again.
 366  *
 367  * @param cls closure
 368  * @param addr binary address
 369  * @param addrlen length of the @a addr
 370  * @return string representing the same address
 371  */
 372 static const char *
 373 unix_plugin_address_to_string (void *cls,
 374                                const void *addr,
 375                                size_t addrlen)
 376 {
 377   static char rbuf[1024];
 378   struct UnixAddress *ua = (struct UnixAddress *) addr;
 379   char *addrstr;
 380   size_t addr_str_len;
 381   unsigned int off;
 382
 383   if ((NULL == addr) || (sizeof (struct UnixAddress) > addrlen))
 384   {
 385     GNUNET_break(0);
 386     return NULL;
 387   }
 388   addrstr = (char *) &ua[1];
 389   addr_str_len = ntohl (ua->addrlen);
 390
 391   if (addr_str_len != addrlen - sizeof(struct UnixAddress))
 392   {
 393     GNUNET_break(0);
 394     return NULL;
 395   }
 396   if ('\0' != addrstr[addr_str_len - 1])
 397   {
 398     GNUNET_break(0);
 399     return NULL;
 400   }
 401   if (strlen (addrstr) + 1 != addr_str_len)
 402   {
 403     GNUNET_break(0);
 404     return NULL;
 405   }
 406
 407   off = 0;
 408   if ('\0' == addrstr[0])
 409     off++;
 410   memset (rbuf, 0, sizeof (rbuf));
 411   GNUNET_snprintf (rbuf,
 412                    sizeof (rbuf) - 1,
 413                    "%s.%u.%s%.*s",
 414                    PLUGIN_NAME,
 415                    ntohl (ua->options),
 416                    (off == 1) ? "@" : "",
 417                    (int) (addr_str_len - off),
 418                    &addrstr[off]);
 419   return rbuf;
 420 }
 421
 422
 423 /**
 424  * Functions with this signature are called whenever we need
 425  * to close a session due to a disconnect or failure to
 426  * establish a connection.
 427  *
 428  * @param cls closure with the `struct Plugin *`
 429  * @param session session to close down
 430  * @return #GNUNET_OK on success
 431  */
 432 static int
 433 unix_plugin_session_disconnect (void *cls,
 434                                 struct GNUNET_ATS_Session *session)
 435 {
 436   struct Plugin *plugin = cls;
 437   struct UNIXMessageWrapper *msgw;
 438   struct UNIXMessageWrapper *next;
 439
 440   LOG (GNUNET_ERROR_TYPE_DEBUG,
 441        "Disconnecting session for peer `%s' `%s'\n",
 442        GNUNET_i2s (&session->target),
 443        unix_plugin_address_to_string (NULL,
 444                                       session->address->address,
 445                                       session->address->address_length));
 446   plugin->env->session_end (plugin->env->cls,
 447                             session->address,
 448                             session);
 449   next = plugin->msg_head;
 450   while (NULL != next)
 451   {
 452     msgw = next;
 453     next = msgw->next;
 454     if (msgw->session != session)
 455       continue;
 456     GNUNET_CONTAINER_DLL_remove (plugin->msg_head,
 457                                  plugin->msg_tail,
 458                                  msgw);
 459     session->msgs_in_queue--;
 460     GNUNET_assert (session->bytes_in_queue >= msgw->msgsize);
 461     session->bytes_in_queue -= msgw->msgsize;
 462     GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
 463     plugin->bytes_in_queue -= msgw->msgsize;
 464     if (NULL != msgw->cont)
 465       msgw->cont (msgw->cont_cls,
 466                   &msgw->session->target,
 467                   GNUNET_SYSERR,
 468                   msgw->payload, 0);
 469     GNUNET_free (msgw->msg);
 470     GNUNET_free (msgw);
 471   }
 472   GNUNET_assert (GNUNET_YES ==
 473                  GNUNET_CONTAINER_multipeermap_remove (plugin->session_map,
 474                                                        &session->target,
 475                                                        session));
 476   GNUNET_STATISTICS_set (plugin->env->stats,
 477                          "# UNIX sessions active",
 478                          GNUNET_CONTAINER_multipeermap_size (plugin->session_map),
 479                          GNUNET_NO);
 480   if (NULL != session->timeout_task)
 481   {
 482     GNUNET_SCHEDULER_cancel (session->timeout_task);
 483     session->timeout_task = NULL;
 484     session->timeout = GNUNET_TIME_UNIT_ZERO_ABS;
 485   }
 486   notify_session_monitor (plugin,
 487                           session,
 488                           GNUNET_TRANSPORT_SS_DONE);
 489   GNUNET_HELLO_address_free (session->address);
 490   GNUNET_break (0 == session->bytes_in_queue);
 491   GNUNET_break (0 == session->msgs_in_queue);
 492   GNUNET_free (session);
 493   return GNUNET_OK;
 494 }
 495
 496
 497 /**
 498  * Session was idle for too long, so disconnect it
 499  *
 500  * @param cls the `struct GNUNET_ATS_Session *` to disconnect
 501  * @param tc scheduler context
 502  */
 503 static void
 504 session_timeout (void *cls,
 505                  const struct GNUNET_SCHEDULER_TaskContext *tc)
 506 {
 507   struct GNUNET_ATS_Session *session = cls;
 508   struct GNUNET_TIME_Relative left;
 509
 510   session->timeout_task = NULL;
 511   left = GNUNET_TIME_absolute_get_remaining (session->timeout);
 512   if (0 != left.rel_value_us)
 513   {
 514     /* not actually our turn yet, but let's at least update
 515        the monitor, it may think we're about to die ... */
 516     notify_session_monitor (session->plugin,
 517                             session,
 518                             GNUNET_TRANSPORT_SS_UPDATE);
 519     session->timeout_task = GNUNET_SCHEDULER_add_delayed (left,
 520                                                           &session_timeout,
 521                                                           session);
 522     return;
 523   }
 524   LOG (GNUNET_ERROR_TYPE_DEBUG,
 525        "Session %p was idle for %s, disconnecting\n",
 526        session,
 527        GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 528                                                GNUNET_YES));
 529   unix_plugin_session_disconnect (session->plugin, session);
 530 }
 531
 532
 533 /**
 534  * Increment session timeout due to activity.  We do not immediately
 535  * notify the monitor here as that might generate excessive
 536  * signalling.
 537  *
 538  * @param session session for which the timeout should be rescheduled
 539  */
 540 static void
 541 reschedule_session_timeout (struct GNUNET_ATS_Session *session)
 542 {
 543   GNUNET_assert (NULL != session->timeout_task);
 544   session->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
 545 }
 546
 547
 548 /**
 549  * Convert unix path to a `struct sockaddr_un *`
 550  *
 551  * @param unixpath path to convert
 552  * @param[out] sock_len set to the length of the address
 553  * @return converted unix path
 554  */
 555 static struct sockaddr_un *
 556 unix_address_to_sockaddr (const char *unixpath,
 557                           socklen_t *sock_len)
 558 {
 559   struct sockaddr_un *un;
 560   size_t slen;
 561
 562   GNUNET_assert (0 < strlen (unixpath));        /* sanity check */
 563   un = GNUNET_new (struct sockaddr_un);
 564   un->sun_family = AF_UNIX;
 565   slen = strlen (unixpath);
 566   if (slen >= sizeof (un->sun_path))
 567     slen = sizeof (un->sun_path) - 1;
 568   memcpy (un->sun_path, unixpath, slen);
 569   un->sun_path[slen] = '\0';
 570   slen = sizeof (struct sockaddr_un);
 571 #if HAVE_SOCKADDR_IN_SIN_LEN
 572   un->sun_len = (u_char) slen;
 573 #endif
 574   (*sock_len) = slen;
 575   return un;
 576 }
 577
 578
 579 /**
 580  * Closure to #lookup_session_it().
 581  */
 582 struct LookupCtx
 583 {
 584   /**
 585    * Location to store the session, if found.
 586    */
 587   struct GNUNET_ATS_Session *res;
 588
 589   /**
 590    * Address we are looking for.
 591    */
 592   const struct GNUNET_HELLO_Address *address;
 593 };
 594
 595
 596 /**
 597  * Function called to find a session by address.
 598  *
 599  * @param cls the `struct LookupCtx *`
 600  * @param key peer we are looking for (unused)
 601  * @param value a session
 602  * @return #GNUNET_YES if not found (continue looking), #GNUNET_NO on success
 603  */
 604 static int
 605 lookup_session_it (void *cls,
 606                    const struct GNUNET_PeerIdentity * key,
 607                    void *value)
 608 {
 609   struct LookupCtx *lctx = cls;
 610   struct GNUNET_ATS_Session *session = value;
 611
 612   if (0 == GNUNET_HELLO_address_cmp (lctx->address,
 613                                      session->address))
 614   {
 615     lctx->res = session;
 616     return GNUNET_NO;
 617   }
 618   return GNUNET_YES;
 619 }
 620
 621
 622 /**
 623  * Find an existing session by address.
 624  *
 625  * @param plugin the plugin
 626  * @param address the address to find
 627  * @return NULL if session was not found
 628  */
 629 static struct GNUNET_ATS_Session *
 630 lookup_session (struct Plugin *plugin,
 631                 const struct GNUNET_HELLO_Address *address)
 632 {
 633   struct LookupCtx lctx;
 634
 635   lctx.address = address;
 636   lctx.res = NULL;
 637   GNUNET_CONTAINER_multipeermap_get_multiple (plugin->session_map,
 638                                               &address->peer,
 639                                               &lookup_session_it, &lctx);
 640   return lctx.res;
 641 }
 642
 643
 644 /**
 645  * Function that is called to get the keepalive factor.
 646  * #GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
 647  * calculate the interval between keepalive packets.
 648  *
 649  * @param cls closure with the `struct Plugin`
 650  * @return keepalive factor
 651  */
 652 static unsigned int
 653 unix_plugin_query_keepalive_factor (void *cls)
 654 {
 655   return 3;
 656 }
 657
 658
 659 /**
 660  * Actually send out the message, assume we've got the address and
 661  * send_handle squared away!
 662  *
 663  * @param cls closure
 664  * @param send_handle which handle to send message on
 665  * @param target who should receive this message (ignored by UNIX)
 666  * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
 667  * @param msgbuf_size the size of the @a msgbuf to send
 668  * @param priority how important is the message (ignored by UNIX)
 669  * @param timeout when should we time out (give up) if we can not transmit?
 670  * @param addr the addr to send the message to, needs to be a sockaddr for us
 671  * @param addrlen the len of @a addr
 672  * @param payload bytes payload to send
 673  * @param cont continuation to call once the message has
 674  *        been transmitted (or if the transport is ready
 675  *        for the next transmission call; or if the
 676  *        peer disconnected...)
 677  * @param cont_cls closure for @a cont
 678  * @return on success the number of bytes written, RETRY for retry, -1 on errors
 679  */
 680 static ssize_t
 681 unix_real_send (void *cls,
 682                 struct GNUNET_NETWORK_Handle *send_handle,
 683                 const struct GNUNET_PeerIdentity *target,
 684                 const char *msgbuf,
 685                 size_t msgbuf_size,
 686                 unsigned int priority,
 687                 struct GNUNET_TIME_Absolute timeout,
 688                 const struct UnixAddress *addr,
 689                 size_t addrlen,
 690                 size_t payload,
 691                 GNUNET_TRANSPORT_TransmitContinuation cont,
 692                 void *cont_cls)
 693 {
 694   struct Plugin *plugin = cls;
 695   ssize_t sent;
 696   struct sockaddr_un *un;
 697   socklen_t un_len;
 698   const char *unixpath;
 699
 700   if (NULL == send_handle)
 701   {
 702     GNUNET_break (0); /* We do not have a send handle */
 703     return GNUNET_SYSERR;
 704   }
 705   if ((NULL == addr) || (0 == addrlen))
 706   {
 707     GNUNET_break (0); /* Can never send if we don't have an address */
 708     return GNUNET_SYSERR;
 709   }
 710
 711   /* Prepare address */
 712   unixpath = (const char *)  &addr[1];
 713   if (NULL == (un = unix_address_to_sockaddr (unixpath,
 714                                               &un_len)))
 715   {
 716     GNUNET_break (0);
 717     return -1;
 718   }
 719
 720   if ((GNUNET_YES == plugin->is_abstract) &&
 721       (0 != (UNIX_OPTIONS_USE_ABSTRACT_SOCKETS & ntohl(addr->options) )) )
 722   {
 723     un->sun_path[0] = '\0';
 724   }
 725 resend:
 726   /* Send the data */
 727   sent = GNUNET_NETWORK_socket_sendto (send_handle,
 728                                        msgbuf,
 729                                        msgbuf_size,
 730                                        (const struct sockaddr *) un,
 731                                        un_len);
 732   if (GNUNET_SYSERR == sent)
 733   {
 734     if ( (EAGAIN == errno) ||
 735          (ENOBUFS == errno) )
 736     {
 737       GNUNET_free (un);
 738       return RETRY; /* We have to retry later  */
 739     }
 740     if (EMSGSIZE == errno)
 741     {
 742       socklen_t size = 0;
 743       socklen_t len = sizeof (size);
 744
 745       GNUNET_NETWORK_socket_getsockopt ((struct GNUNET_NETWORK_Handle *)
 746                                         send_handle, SOL_SOCKET, SO_SNDBUF, &size,
 747                                         &len);
 748       if (size < msgbuf_size)
 749       {
 750         LOG (GNUNET_ERROR_TYPE_DEBUG,
 751              "Trying to increase socket buffer size from %u to %u for message size %u\n",
 752              (unsigned int) size,
 753              (unsigned int) ((msgbuf_size / 1000) + 2) * 1000,
 754              (unsigned int) msgbuf_size);
 755         size = ((msgbuf_size / 1000) + 2) * 1000;
 756         if (GNUNET_OK ==
 757             GNUNET_NETWORK_socket_setsockopt ((struct GNUNET_NETWORK_Handle *) send_handle,
 758                                               SOL_SOCKET, SO_SNDBUF,
 759                                               &size, sizeof (size)))
 760           goto resend; /* Increased buffer size, retry sending */
 761         else
 762         {
 763           /* Could not increase buffer size: error, no retry */
 764           GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
 765           GNUNET_free (un);
 766           return GNUNET_SYSERR;
 767         }
 768       }
 769       else
 770       {
 771         /* Buffer is bigger than message:  error, no retry
 772          * This should never happen!*/
 773         GNUNET_break (0);
 774         GNUNET_free (un);
 775         return GNUNET_SYSERR;
 776       }
 777     }
 778   }
 779
 780   LOG (GNUNET_ERROR_TYPE_DEBUG,
 781        "UNIX transmitted %u-byte message to %s (%d: %s)\n",
 782        (unsigned int) msgbuf_size,
 783        GNUNET_a2s ((const struct sockaddr *)un, un_len),
 784        (int) sent,
 785        (sent < 0) ? STRERROR (errno) : "ok");
 786   GNUNET_free (un);
 787   return sent;
 788 }
 789
 790
 791 /**
 792  * Function obtain the network type for a session
 793  *
 794  * @param cls closure ('struct Plugin*')
 795  * @param session the session
 796  * @return the network type in HBO or #GNUNET_SYSERR
 797  */
 798 static enum GNUNET_ATS_Network_Type
 799 unix_plugin_get_network (void *cls,
 800                          struct GNUNET_ATS_Session *session)
 801 {
 802   GNUNET_assert (NULL != session);
 803   return GNUNET_ATS_NET_LOOPBACK;
 804 }
 805
 806
 807 /**
 808  * Function obtain the network type for a session
 809  *
 810  * @param cls closure (`struct Plugin *`)
 811  * @param address the address
 812  * @return the network type
 813  */
 814 static enum GNUNET_ATS_Network_Type
 815 unix_plugin_get_network_for_address (void *cls,
 816                                      const struct GNUNET_HELLO_Address *address)
 817
 818 {
 819   return GNUNET_ATS_NET_LOOPBACK;
 820 }
 821
 822
 823 /**
 824  * Creates a new outbound session the transport service will use to send data to the
 825  * peer
 826  *
 827  * @param cls the plugin
 828  * @param address the address
 829  * @return the session or NULL of max connections exceeded
 830  */
 831 static struct GNUNET_ATS_Session *
 832 unix_plugin_get_session (void *cls,
 833                          const struct GNUNET_HELLO_Address *address)
 834 {
 835   struct Plugin *plugin = cls;
 836   struct GNUNET_ATS_Session *session;
 837   struct UnixAddress *ua;
 838   char * addrstr;
 839   uint32_t addr_str_len;
 840   uint32_t addr_option;
 841
 842   ua = (struct UnixAddress *) address->address;
 843   if ((NULL == address->address) || (0 == address->address_length) ||
 844                 (sizeof (struct UnixAddress) > address->address_length))
 845   {
 846     GNUNET_break (0);
 847     return NULL;
 848   }
 849   addrstr = (char *) &ua[1];
 850   addr_str_len = ntohl (ua->addrlen);
 851   addr_option = ntohl (ua->options);
 852
 853   if ( (0 != (UNIX_OPTIONS_USE_ABSTRACT_SOCKETS & addr_option)) &&
 854     (GNUNET_NO == plugin->is_abstract))
 855   {
 856     return NULL;
 857   }
 858
 859   if (addr_str_len != address->address_length - sizeof (struct UnixAddress))
 860   {
 861     return NULL; /* This can be a legacy address */
 862   }
 863
 864   if ('\0' != addrstr[addr_str_len - 1])
 865   {
 866     GNUNET_break (0);
 867     return NULL;
 868   }
 869   if (strlen (addrstr) + 1 != addr_str_len)
 870   {
 871     GNUNET_break (0);
 872     return NULL;
 873   }
 874
 875   /* Check if a session for this address already exists */
 876   if (NULL != (session = lookup_session (plugin,
 877                                          address)))
 878     {
 879     LOG (GNUNET_ERROR_TYPE_DEBUG,
 880          "Found existing session %p for address `%s'\n",
 881          session,
 882          unix_plugin_address_to_string (NULL,
 883                                         address->address,
 884                                         address->address_length));
 885     return session;
 886   }
 887
 888   /* create a new session */
 889   session = GNUNET_new (struct GNUNET_ATS_Session);
 890   session->target = address->peer;
 891   session->address = GNUNET_HELLO_address_copy (address);
 892   session->plugin = plugin;
 893   session->timeout = GNUNET_TIME_relative_to_absolute (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
 894   session->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
 895                                                         &session_timeout,
 896                                                         session);
 897   LOG (GNUNET_ERROR_TYPE_DEBUG,
 898        "Creating a new session %p for address `%s'\n",
 899        session,
 900        unix_plugin_address_to_string (NULL,
 901                                       address->address,
 902                                       address->address_length));
 903   (void) GNUNET_CONTAINER_multipeermap_put (plugin->session_map,
 904                                             &address->peer, session,
 905                                             GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 906   GNUNET_STATISTICS_set (plugin->env->stats,
 907                          "# UNIX sessions active",
 908                          GNUNET_CONTAINER_multipeermap_size (plugin->session_map),
 909                          GNUNET_NO);
 910   notify_session_monitor (plugin,
 911                           session,
 912                           GNUNET_TRANSPORT_SS_INIT);
 913   notify_session_monitor (plugin,
 914                           session,
 915                           GNUNET_TRANSPORT_SS_UP);
 916   return session;
 917 }
 918
 919
 920 /**
 921  * Function that will be called whenever the transport service wants
 922  * to notify the plugin that a session is still active and in use and
 923  * therefore the session timeout for this session has to be updated
 924  *
 925  * @param cls closure with the `struct Plugin *`
 926  * @param peer which peer was the session for
 927  * @param session which session is being updated
 928  */
 929 static void
 930 unix_plugin_update_session_timeout (void *cls,
 931                                     const struct GNUNET_PeerIdentity *peer,
 932                                     struct GNUNET_ATS_Session *session)
 933 {
 934   struct Plugin *plugin = cls;
 935
 936   if (GNUNET_OK !=
 937       GNUNET_CONTAINER_multipeermap_contains_value (plugin->session_map,
 938                                                     &session->target,
 939                                                     session))
 940   {
 941     GNUNET_break (0);
 942     return;
 943   }
 944   reschedule_session_timeout (session);
 945 }
 946
 947
 948 /**
 949  * Demultiplexer for UNIX messages
 950  *
 951  * @param plugin the main plugin for this transport
 952  * @param sender from which peer the message was received
 953  * @param currhdr pointer to the header of the message
 954  * @param ua address to look for
 955  * @param ua_len length of the address @a ua
 956  */
 957 static void
 958 unix_demultiplexer (struct Plugin *plugin,
 959                     struct GNUNET_PeerIdentity *sender,
 960                     const struct GNUNET_MessageHeader *currhdr,
 961                     const struct UnixAddress *ua,
 962                     size_t ua_len)
 963 {
 964   struct GNUNET_ATS_Session *session;
 965   struct GNUNET_HELLO_Address *address;
 966
 967   GNUNET_assert (ua_len >= sizeof (struct UnixAddress));
 968   LOG (GNUNET_ERROR_TYPE_DEBUG,
 969        "Received message from %s\n",
 970        unix_plugin_address_to_string (NULL, ua, ua_len));
 971   GNUNET_STATISTICS_update (plugin->env->stats,
 972                             "# bytes received via UNIX",
 973                             ntohs (currhdr->size),
 974                             GNUNET_NO);
 975
 976   /* Look for existing session */
 977   address = GNUNET_HELLO_address_allocate (sender,
 978                                            PLUGIN_NAME,
 979                                            ua, ua_len,
 980                                            GNUNET_HELLO_ADDRESS_INFO_NONE); /* UNIX does not have "inbound" sessions */
 981   session = lookup_session (plugin, address);
 982   if (NULL == session)
 983   {
 984     session = unix_plugin_get_session (plugin, address);
 985     /* Notify transport and ATS about new inbound session */
 986     plugin->env->session_start (NULL,
 987                                 session->address,
 988                                 session,
 989                                 GNUNET_ATS_NET_LOOPBACK);
 990   }
 991   else
 992   {
 993     reschedule_session_timeout (session);
 994   }
 995   GNUNET_HELLO_address_free (address);
 996   plugin->env->receive (plugin->env->cls,
 997                         session->address,
 998                         session,
 999                         currhdr);
1000 }
1001
1002
1003 /**
1004  * Read from UNIX domain socket (it is ready).
1005  *
1006  * @param plugin the plugin
1007  */
1008 static void
1009 unix_plugin_do_read (struct Plugin *plugin)
1010 {
1011   char buf[65536] GNUNET_ALIGN;
1012   struct UnixAddress *ua;
1013   struct UNIXMessage *msg;
1014   struct GNUNET_PeerIdentity sender;
1015   struct sockaddr_un un;
1016   socklen_t addrlen;
1017   ssize_t ret;
1018   int offset;
1019   int tsize;
1020   int is_abstract;
1021   char *msgbuf;
1022   const struct GNUNET_MessageHeader *currhdr;
1023   uint16_t csize;
1024   size_t ua_len;
1025
1026   addrlen = sizeof (un);
1027   memset (&un, 0, sizeof (un));
1028   ret = GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc,
1029                                         buf, sizeof (buf),
1030                                         (struct sockaddr *) &un,
1031                                         &addrlen);
1032   if ((GNUNET_SYSERR == ret) && ((errno == EAGAIN) || (errno == ENOBUFS)))
1033     return;
1034   if (GNUNET_SYSERR == ret)
1035   {
1036     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
1037                          "recvfrom");
1038     return;
1039   }
1040   else
1041   {
1042     LOG (GNUNET_ERROR_TYPE_DEBUG,
1043          "Read %d bytes from socket %s\n",
1044          (int) ret,
1045          un.sun_path);
1046   }
1047
1048   GNUNET_assert (AF_UNIX == (un.sun_family));
1049   is_abstract = GNUNET_NO;
1050   if ('\0' == un.sun_path[0])
1051   {
1052     un.sun_path[0] = '@';
1053     is_abstract = GNUNET_YES;
1054   }
1055
1056   ua_len = sizeof (struct UnixAddress) + strlen (un.sun_path) + 1;
1057   ua = GNUNET_malloc (ua_len);
1058   ua->addrlen = htonl (strlen (&un.sun_path[0]) +1);
1059   memcpy (&ua[1], &un.sun_path[0], strlen (un.sun_path) + 1);
1060   if (is_abstract)
1061     ua->options = htonl(UNIX_OPTIONS_USE_ABSTRACT_SOCKETS);
1062   else
1063     ua->options = htonl(UNIX_OPTIONS_NONE);
1064
1065   msg = (struct UNIXMessage *) buf;
1066   csize = ntohs (msg->header.size);
1067   if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
1068   {
1069     GNUNET_break_op (0);
1070     GNUNET_free (ua);
1071     return;
1072   }
1073   msgbuf = (char *) &msg[1];
1074   memcpy (&sender,
1075           &msg->sender,
1076           sizeof (struct GNUNET_PeerIdentity));
1077   offset = 0;
1078   tsize = csize - sizeof (struct UNIXMessage);
1079   while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
1080   {
1081     currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
1082     csize = ntohs (currhdr->size);
1083     if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
1084         (csize > tsize - offset))
1085     {
1086       GNUNET_break_op (0);
1087       break;
1088     }
1089     unix_demultiplexer (plugin, &sender, currhdr, ua, ua_len);
1090     offset += csize;
1091   }
1092   GNUNET_free (ua);
1093 }
1094
1095
1096 /**
1097  * Write to UNIX domain socket (it is ready).
1098  *
1099  * @param plugin handle to the plugin
1100  */
1101 static void
1102 unix_plugin_do_write (struct Plugin *plugin)
1103 {
1104   ssize_t sent = 0;
1105   struct UNIXMessageWrapper *msgw;
1106   struct GNUNET_ATS_Session *session;
1107   int did_delete;
1108
1109   session = NULL;
1110   did_delete = GNUNET_NO;
1111   while (NULL != (msgw = plugin->msg_head))
1112   {
1113     if (GNUNET_TIME_absolute_get_remaining (msgw->timeout).rel_value_us > 0)
1114       break; /* Message is ready for sending */
1115     /* Message has a timeout */
1116     did_delete = GNUNET_YES;
1117     LOG (GNUNET_ERROR_TYPE_DEBUG,
1118          "Timeout for message with %u bytes \n",
1119          (unsigned int) msgw->msgsize);
1120     GNUNET_CONTAINER_DLL_remove (plugin->msg_head,
1121                                  plugin->msg_tail,
1122                                  msgw);
1123     session = msgw->session;
1124     session->msgs_in_queue--;
1125     GNUNET_assert (session->bytes_in_queue >= msgw->msgsize);
1126     session->bytes_in_queue -= msgw->msgsize;
1127     GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
1128     plugin->bytes_in_queue -= msgw->msgsize;
1129     GNUNET_STATISTICS_set (plugin->env->stats,
1130                            "# bytes currently in UNIX buffers",
1131                            plugin->bytes_in_queue,
1132                            GNUNET_NO);
1133     GNUNET_STATISTICS_update (plugin->env->stats,
1134                               "# UNIX bytes discarded",
1135                               msgw->msgsize,
1136                               GNUNET_NO);
1137     if (NULL != msgw->cont)
1138       msgw->cont (msgw->cont_cls,
1139                   &msgw->session->target,
1140                   GNUNET_SYSERR,
1141                   msgw->payload,
1142                   0);
1143     GNUNET_free (msgw->msg);
1144     GNUNET_free (msgw);
1145   }
1146   if (NULL == msgw)
1147   {
1148     if (GNUNET_YES == did_delete)
1149       notify_session_monitor (plugin,
1150                               session,
1151                               GNUNET_TRANSPORT_SS_UPDATE);
1152     return; /* Nothing to send at the moment */
1153   }
1154   session = msgw->session;
1155   sent = unix_real_send (plugin,
1156                          plugin->unix_sock.desc,
1157                          &session->target,
1158                          (const char *) msgw->msg,
1159                          msgw->msgsize,
1160                          msgw->priority,
1161                          msgw->timeout,
1162                          msgw->session->address->address,
1163                          msgw->session->address->address_length,
1164                          msgw->payload,
1165                          msgw->cont, msgw->cont_cls);
1166   if (RETRY == sent)
1167   {
1168     GNUNET_STATISTICS_update (plugin->env->stats,
1169                               "# UNIX retry attempts",
1170                               1, GNUNET_NO);
1171     notify_session_monitor (plugin,
1172                             session,
1173                             GNUNET_TRANSPORT_SS_UPDATE);
1174     return;
1175   }
1176   GNUNET_CONTAINER_DLL_remove (plugin->msg_head,
1177                                plugin->msg_tail,
1178                                msgw);
1179   session->msgs_in_queue--;
1180   GNUNET_assert (session->bytes_in_queue >= msgw->msgsize);
1181   session->bytes_in_queue -= msgw->msgsize;
1182   GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
1183   plugin->bytes_in_queue -= msgw->msgsize;
1184   GNUNET_STATISTICS_set (plugin->env->stats,
1185                          "# bytes currently in UNIX buffers",
1186                          plugin->bytes_in_queue, GNUNET_NO);
1187   notify_session_monitor (plugin,
1188                           session,
1189                           GNUNET_TRANSPORT_SS_UPDATE);
1190   if (GNUNET_SYSERR == sent)
1191   {
1192     /* failed and no retry */
1193     if (NULL != msgw->cont)
1194       msgw->cont (msgw->cont_cls,
1195                   &msgw->session->target,
1196                   GNUNET_SYSERR,
1197                   msgw->payload, 0);
1198     GNUNET_STATISTICS_update (plugin->env->stats,
1199                               "# UNIX bytes discarded",
1200                               msgw->msgsize,
1201                               GNUNET_NO);
1202     GNUNET_free (msgw->msg);
1203     GNUNET_free (msgw);
1204     return;
1205   }
1206   /* successfully sent bytes */
1207   GNUNET_break (sent > 0);
1208   GNUNET_STATISTICS_update (plugin->env->stats,
1209                             "# bytes transmitted via UNIX",
1210                             msgw->msgsize,
1211                             GNUNET_NO);
1212   if (NULL != msgw->cont)
1213     msgw->cont (msgw->cont_cls,
1214                 &msgw->session->target,
1215                 GNUNET_OK,
1216                 msgw->payload,
1217                 msgw->msgsize);
1218   GNUNET_free (msgw->msg);
1219   GNUNET_free (msgw);
1220 }
1221
1222
1223 /**
1224  * We have been notified that our socket has something to read.
1225  * Then reschedule this function to be called again once more is available.
1226  *
1227  * @param cls the plugin handle
1228  * @param tc the scheduling context
1229  */
1230 static void
1231 unix_plugin_select_read (void *cls,
1232                          const struct GNUNET_SCHEDULER_TaskContext *tc)
1233 {
1234   struct Plugin *plugin = cls;
1235
1236   plugin->read_task = NULL;
1237   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1238     return;
1239   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_READ_READY))
1240     unix_plugin_do_read (plugin);
1241   plugin->read_task =
1242     GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
1243                                    plugin->unix_sock.desc,
1244                                    &unix_plugin_select_read, plugin);
1245 }
1246
1247
1248 /**
1249  * We have been notified that our socket is ready to write.
1250  * Then reschedule this function to be called again once more is available.
1251  *
1252  * @param cls the plugin handle
1253  * @param tc the scheduling context
1254  */
1255 static void
1256 unix_plugin_select_write (void *cls,
1257                          const struct GNUNET_SCHEDULER_TaskContext *tc)
1258 {
1259   struct Plugin *plugin = cls;
1260
1261   plugin->write_task = NULL;
1262   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1263     return;
1264   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY))
1265     unix_plugin_do_write (plugin);
1266   if (NULL == plugin->msg_head)
1267     return; /* write queue empty */
1268   plugin->write_task =
1269     GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
1270                                     plugin->unix_sock.desc,
1271                                     &unix_plugin_select_write, plugin);
1272 }
1273
1274
1275 /**
1276  * Function that can be used by the transport service to transmit
1277  * a message using the plugin.   Note that in the case of a
1278  * peer disconnecting, the continuation MUST be called
1279  * prior to the disconnect notification itself.  This function
1280  * will be called with this peer's HELLO message to initiate
1281  * a fresh connection to another peer.
1282  *
1283  * @param cls closure
1284  * @param session which session must be used
1285  * @param msgbuf the message to transmit
1286  * @param msgbuf_size number of bytes in @a msgbuf
1287  * @param priority how important is the message (most plugins will
1288  *                 ignore message priority and just FIFO)
1289  * @param to how long to wait at most for the transmission (does not
1290  *                require plugins to discard the message after the timeout,
1291  *                just advisory for the desired delay; most plugins will ignore
1292  *                this as well)
1293  * @param cont continuation to call once the message has
1294  *        been transmitted (or if the transport is ready
1295  *        for the next transmission call; or if the
1296  *        peer disconnected...); can be NULL
1297  * @param cont_cls closure for @a cont
1298  * @return number of bytes used (on the physical network, with overheads);
1299  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
1300  *         and does NOT mean that the message was not transmitted (DV)
1301  */
1302 static ssize_t
1303 unix_plugin_send (void *cls,
1304                   struct GNUNET_ATS_Session *session,
1305                   const char *msgbuf,
1306                   size_t msgbuf_size,
1307                   unsigned int priority,
1308                   struct GNUNET_TIME_Relative to,
1309                   GNUNET_TRANSPORT_TransmitContinuation cont,
1310                   void *cont_cls)
1311 {
1312   struct Plugin *plugin = cls;
1313   struct UNIXMessageWrapper *wrapper;
1314   struct UNIXMessage *message;
1315   int ssize;
1316
1317   if (GNUNET_OK !=
1318       GNUNET_CONTAINER_multipeermap_contains_value (plugin->session_map,
1319                                                     &session->target,
1320                                                     session))
1321   {
1322     LOG (GNUNET_ERROR_TYPE_ERROR,
1323          "Invalid session for peer `%s' `%s'\n",
1324          GNUNET_i2s (&session->target),
1325          unix_plugin_address_to_string (NULL,
1326                                         session->address->address,
1327                                         session->address->address_length));
1328     GNUNET_break (0);
1329     return GNUNET_SYSERR;
1330   }
1331   LOG (GNUNET_ERROR_TYPE_DEBUG,
1332        "Sending %u bytes with session for peer `%s' `%s'\n",
1333        msgbuf_size,
1334        GNUNET_i2s (&session->target),
1335        unix_plugin_address_to_string (NULL,
1336                                       session->address->address,
1337                                       session->address->address_length));
1338   ssize = sizeof (struct UNIXMessage) + msgbuf_size;
1339   message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
1340   message->header.size = htons (ssize);
1341   message->header.type = htons (0);
1342   memcpy (&message->sender, plugin->env->my_identity,
1343           sizeof (struct GNUNET_PeerIdentity));
1344   memcpy (&message[1], msgbuf, msgbuf_size);
1345   wrapper = GNUNET_new (struct UNIXMessageWrapper);
1346   wrapper->msg = message;
1347   wrapper->msgsize = ssize;
1348   wrapper->payload = msgbuf_size;
1349   wrapper->priority = priority;
1350   wrapper->timeout = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get (),
1351                                                to);
1352   wrapper->cont = cont;
1353   wrapper->cont_cls = cont_cls;
1354   wrapper->session = session;
1355   GNUNET_CONTAINER_DLL_insert_tail (plugin->msg_head,
1356                                     plugin->msg_tail,
1357                                     wrapper);
1358   plugin->bytes_in_queue += ssize;
1359   session->bytes_in_queue += ssize;
1360   session->msgs_in_queue++;
1361   GNUNET_STATISTICS_set (plugin->env->stats,
1362                          "# bytes currently in UNIX buffers",
1363                          plugin->bytes_in_queue,
1364                          GNUNET_NO);
1365   notify_session_monitor (plugin,
1366                           session,
1367                           GNUNET_TRANSPORT_SS_UPDATE);
1368   if (NULL == plugin->write_task)
1369     plugin->write_task =
1370       GNUNET_SCHEDULER_add_write_net (GNUNET_TIME_UNIT_FOREVER_REL,
1371                                       plugin->unix_sock.desc,
1372                                       &unix_plugin_select_write, plugin);
1373   return ssize;
1374 }
1375
1376
1377 /**
1378  * Create a slew of UNIX sockets.  If possible, use IPv6 and IPv4.
1379  *
1380  * @param cls closure for server start, should be a `struct Plugin *`
1381  * @return number of sockets created or #GNUNET_SYSERR on error
1382  */
1383 static int
1384 unix_transport_server_start (void *cls)
1385 {
1386   struct Plugin *plugin = cls;
1387   struct sockaddr_un *un;
1388   socklen_t un_len;
1389
1390   un = unix_address_to_sockaddr (plugin->unix_socket_path,
1391                                  &un_len);
1392   if (GNUNET_YES == plugin->is_abstract)
1393   {
1394     plugin->unix_socket_path[0] = '@';
1395     un->sun_path[0] = '\0';
1396   }
1397   plugin->unix_sock.desc =
1398       GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_DGRAM, 0);
1399   if (NULL == plugin->unix_sock.desc)
1400   {
1401     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
1402     GNUNET_free (un);
1403     return GNUNET_SYSERR;
1404   }
1405   if ('\0' != un->sun_path[0])
1406   {
1407     if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (un->sun_path))
1408     {
1409       LOG (GNUNET_ERROR_TYPE_ERROR, _("Cannot create path to `%s'\n"),
1410           un->sun_path);
1411       GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
1412       plugin->unix_sock.desc = NULL;
1413       GNUNET_free (un);
1414       return GNUNET_SYSERR;
1415     }
1416   }
1417   if (GNUNET_OK !=
1418       GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc,
1419                                   (const struct sockaddr *) un, un_len))
1420   {
1421     GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
1422     LOG (GNUNET_ERROR_TYPE_ERROR, _("Cannot bind to `%s'\n"),
1423         un->sun_path);
1424     GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
1425     plugin->unix_sock.desc = NULL;
1426     GNUNET_free (un);
1427     return GNUNET_SYSERR;
1428   }
1429   LOG (GNUNET_ERROR_TYPE_DEBUG,
1430        "Bound to `%s'\n",
1431        plugin->unix_socket_path);
1432   plugin->read_task =
1433     GNUNET_SCHEDULER_add_read_net (GNUNET_TIME_UNIT_FOREVER_REL,
1434                                    plugin->unix_sock.desc,
1435                                    &unix_plugin_select_read, plugin);
1436   GNUNET_free (un);
1437   return 1;
1438 }
1439
1440
1441 /**
1442  * Function that will be called to check if a binary address for this
1443  * plugin is well-formed and corresponds to an address for THIS peer
1444  * (as per our configuration).  Naturally, if absolutely necessary,
1445  * plugins can be a bit conservative in their answer, but in general
1446  * plugins should make sure that the address does not redirect
1447  * traffic to a 3rd party that might try to man-in-the-middle our
1448  * traffic.
1449  *
1450  * @param cls closure, should be our handle to the Plugin
1451  * @param addr pointer to the address
1452  * @param addrlen length of @a addr
1453  * @return #GNUNET_OK if this is a plausible address for this peer
1454  *         and transport, #GNUNET_SYSERR if not
1455  *
1456  */
1457 static int
1458 unix_plugin_check_address (void *cls,
1459                            const void *addr,
1460                            size_t addrlen)
1461 {
1462   struct Plugin* plugin = cls;
1463   const struct UnixAddress *ua = addr;
1464   char *addrstr;
1465   size_t addr_str_len;
1466
1467   if ( (NULL == addr) ||
1468        (0 == addrlen) ||
1469        (sizeof (struct UnixAddress) > addrlen) )
1470   {
1471     GNUNET_break (0);
1472     return GNUNET_SYSERR;
1473   }
1474   addrstr = (char *) &ua[1];
1475   addr_str_len = ntohl (ua->addrlen);
1476   if ('\0' != addrstr[addr_str_len - 1])
1477   {
1478     GNUNET_break (0);
1479     return GNUNET_SYSERR;
1480   }
1481   if (strlen (addrstr) + 1 != addr_str_len)
1482   {
1483     GNUNET_break (0);
1484     return GNUNET_SYSERR;
1485   }
1486
1487   if (0 == strcmp (plugin->unix_socket_path, addrstr))
1488         return GNUNET_OK;
1489   return GNUNET_SYSERR;
1490 }
1491
1492
1493 /**
1494  * Convert the transports address to a nice, human-readable
1495  * format.
1496  *
1497  * @param cls closure
1498  * @param type name of the transport that generated the address
1499  * @param addr one of the addresses of the host, NULL for the last address
1500  *        the specific address format depends on the transport
1501  * @param addrlen length of the @a addr
1502  * @param numeric should (IP) addresses be displayed in numeric form?
1503  * @param timeout after how long should we give up?
1504  * @param asc function to call on each string
1505  * @param asc_cls closure for @a asc
1506  */
1507 static void
1508 unix_plugin_address_pretty_printer (void *cls, const char *type,
1509                                     const void *addr,
1510                                     size_t addrlen,
1511                                     int numeric,
1512                                     struct GNUNET_TIME_Relative timeout,
1513                                     GNUNET_TRANSPORT_AddressStringCallback asc,
1514                                     void *asc_cls)
1515 {
1516   const char *ret;
1517
1518   if ( (NULL != addr) && (addrlen > 0))
1519     ret = unix_plugin_address_to_string (NULL,
1520                                          addr,
1521                                          addrlen);
1522   else
1523     ret = NULL;
1524   asc (asc_cls,
1525        ret,
1526        (NULL == ret) ? GNUNET_SYSERR : GNUNET_OK);
1527   asc (asc_cls, NULL, GNUNET_OK);
1528 }
1529
1530
1531 /**
1532  * Function called to convert a string address to
1533  * a binary address.
1534  *
1535  * @param cls closure (`struct Plugin *`)
1536  * @param addr string address
1537  * @param addrlen length of the @a addr (strlen(addr) + '\0')
1538  * @param buf location to store the buffer
1539  *        If the function returns #GNUNET_SYSERR, its contents are undefined.
1540  * @param added length of created address
1541  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
1542  */
1543 static int
1544 unix_plugin_string_to_address (void *cls,
1545                                const char *addr,
1546                                uint16_t addrlen,
1547                                void **buf, size_t *added)
1548 {
1549   struct UnixAddress *ua;
1550   char *address;
1551   char *plugin;
1552   char *optionstr;
1553   uint32_t options;
1554   size_t ua_size;
1555
1556   /* Format unix.options.address */
1557   address = NULL;
1558   plugin = NULL;
1559   optionstr = NULL;
1560
1561   if ((NULL == addr) || (addrlen == 0))
1562   {
1563     GNUNET_break (0);
1564     return GNUNET_SYSERR;
1565   }
1566   if ('\0' != addr[addrlen - 1])
1567   {
1568     GNUNET_break (0);
1569     return GNUNET_SYSERR;
1570   }
1571   if (strlen (addr) != addrlen - 1)
1572   {
1573     GNUNET_break (0);
1574     return GNUNET_SYSERR;
1575   }
1576   plugin = GNUNET_strdup (addr);
1577   optionstr = strchr (plugin, '.');
1578   if (NULL == optionstr)
1579   {
1580     GNUNET_break (0);
1581     GNUNET_free (plugin);
1582     return GNUNET_SYSERR;
1583   }
1584   optionstr[0] = '\0';
1585   optionstr++;
1586   options = atol (optionstr);
1587   address = strchr (optionstr, '.');
1588   if (NULL == address)
1589   {
1590     GNUNET_break (0);
1591     GNUNET_free (plugin);
1592     return GNUNET_SYSERR;
1593   }
1594   address[0] = '\0';
1595   address++;
1596   if (0 != strcmp(plugin, PLUGIN_NAME))
1597   {
1598     GNUNET_break (0);
1599     GNUNET_free (plugin);
1600     return GNUNET_SYSERR;
1601   }
1602
1603   ua_size = sizeof (struct UnixAddress) + strlen (address) + 1;
1604   ua = GNUNET_malloc (ua_size);
1605   ua->options = htonl (options);
1606   ua->addrlen = htonl (strlen (address) + 1);
1607   memcpy (&ua[1], address, strlen (address) + 1);
1608   GNUNET_free (plugin);
1609
1610   (*buf) = ua;
1611   (*added) = ua_size;
1612   return GNUNET_OK;
1613 }
1614
1615
1616 /**
1617  * Notify transport service about address
1618  *
1619  * @param cls the plugin
1620  * @param tc unused
1621  */
1622 static void
1623 address_notification (void *cls,
1624                       const struct GNUNET_SCHEDULER_TaskContext *tc)
1625 {
1626   struct Plugin *plugin = cls;
1627   struct GNUNET_HELLO_Address *address;
1628   size_t len;
1629   struct UnixAddress *ua;
1630   char *unix_path;
1631
1632   len = sizeof (struct UnixAddress) + strlen (plugin->unix_socket_path) + 1;
1633   ua = GNUNET_malloc (len);
1634   ua->options = htonl (plugin->myoptions);
1635   ua->addrlen = htonl(strlen (plugin->unix_socket_path) + 1);
1636   unix_path = (char *) &ua[1];
1637   memcpy (unix_path, plugin->unix_socket_path, strlen (plugin->unix_socket_path) + 1);
1638
1639   plugin->address_update_task = NULL;
1640   address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
1641                                            PLUGIN_NAME,
1642                                            ua,
1643                                            len,
1644                                            GNUNET_HELLO_ADDRESS_INFO_NONE);
1645   plugin->env->notify_address (plugin->env->cls,
1646                                GNUNET_YES,
1647                                address);
1648   GNUNET_free (ua);
1649   GNUNET_free (address);
1650 }
1651
1652
1653 /**
1654  * Function called on sessions to disconnect
1655  *
1656  * @param cls the plugin
1657  * @param key peer identity (unused)
1658  * @param value the `struct GNUNET_ATS_Session *` to disconnect
1659  * @return #GNUNET_YES (always, continue to iterate)
1660  */
1661 static int
1662 get_session_delete_it (void *cls,
1663                        const struct GNUNET_PeerIdentity *key,
1664                        void *value)
1665 {
1666   struct Plugin *plugin = cls;
1667   struct GNUNET_ATS_Session *session = value;
1668
1669   unix_plugin_session_disconnect (plugin, session);
1670   return GNUNET_YES;
1671 }
1672
1673
1674 /**
1675  * Disconnect from a remote node.  Clean up session if we have one for this peer
1676  *
1677  * @param cls closure for this call (should be handle to Plugin)
1678  * @param target the peeridentity of the peer to disconnect
1679  * @return #GNUNET_OK on success, #GNUNET_SYSERR if the operation failed
1680  */
1681 static void
1682 unix_plugin_peer_disconnect (void *cls,
1683                              const struct GNUNET_PeerIdentity *target)
1684 {
1685   struct Plugin *plugin = cls;
1686
1687   GNUNET_CONTAINER_multipeermap_get_multiple (plugin->session_map,
1688                                               target,
1689                                               &get_session_delete_it, plugin);
1690 }
1691
1692
1693 /**
1694  * Return information about the given session to the
1695  * monitor callback.
1696  *
1697  * @param cls the `struct Plugin` with the monitor callback (`sic`)
1698  * @param peer peer we send information about
1699  * @param value our `struct GNUNET_ATS_Session` to send information about
1700  * @return #GNUNET_OK (continue to iterate)
1701  */
1702 static int
1703 send_session_info_iter (void *cls,
1704                         const struct GNUNET_PeerIdentity *peer,
1705                         void *value)
1706 {
1707   struct Plugin *plugin = cls;
1708   struct GNUNET_ATS_Session *session = value;
1709
1710   notify_session_monitor (plugin,
1711                           session,
1712                           GNUNET_TRANSPORT_SS_INIT);
1713   notify_session_monitor (plugin,
1714                           session,
1715                           GNUNET_TRANSPORT_SS_UP);
1716   return GNUNET_OK;
1717 }
1718
1719
1720 /**
1721  * Begin monitoring sessions of a plugin.  There can only
1722  * be one active monitor per plugin (i.e. if there are
1723  * multiple monitors, the transport service needs to
1724  * multiplex the generated events over all of them).
1725  *
1726  * @param cls closure of the plugin
1727  * @param sic callback to invoke, NULL to disable monitor;
1728  *            plugin will being by iterating over all active
1729  *            sessions immediately and then enter monitor mode
1730  * @param sic_cls closure for @a sic
1731  */
1732 static void
1733 unix_plugin_setup_monitor (void *cls,
1734                            GNUNET_TRANSPORT_SessionInfoCallback sic,
1735                            void *sic_cls)
1736 {
1737   struct Plugin *plugin = cls;
1738
1739   plugin->sic = sic;
1740   plugin->sic_cls = sic_cls;
1741   if (NULL != sic)
1742   {
1743     GNUNET_CONTAINER_multipeermap_iterate (plugin->session_map,
1744                                            &send_session_info_iter,
1745                                            plugin);
1746     /* signal end of first iteration */
1747     sic (sic_cls, NULL, NULL);
1748   }
1749 }
1750
1751
1752 /**
1753  * The exported method.  Initializes the plugin and returns a
1754  * struct with the callbacks.
1755  *
1756  * @param cls the plugin's execution environment
1757  * @return NULL on error, plugin functions otherwise
1758  */
1759 void *
1760 libgnunet_plugin_transport_unix_init (void *cls)
1761 {
1762   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1763   struct GNUNET_TRANSPORT_PluginFunctions *api;
1764   struct Plugin *plugin;
1765   int sockets_created;
1766
1767   if (NULL == env->receive)
1768   {
1769     /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1770        initialze the plugin or the API */
1771     api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
1772     api->cls = NULL;
1773     api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1774     api->address_to_string = &unix_plugin_address_to_string;
1775     api->string_to_address = &unix_plugin_string_to_address;
1776     return api;
1777   }
1778
1779   plugin = GNUNET_new (struct Plugin);
1780   if (GNUNET_OK !=
1781       GNUNET_CONFIGURATION_get_value_filename (env->cfg,
1782                                                "transport-unix",
1783                                                "UNIXPATH",
1784                                                &plugin->unix_socket_path))
1785   {
1786     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
1787                                "transport-unix",
1788                                "UNIXPATH");
1789     GNUNET_free (plugin);
1790     return NULL;
1791   }
1792
1793   plugin->env = env;
1794
1795   /* Initialize my flags */
1796 #ifdef LINUX
1797   plugin->is_abstract = GNUNET_CONFIGURATION_get_value_yesno (plugin->env->cfg,
1798                                                               "testing",
1799                                                               "USE_ABSTRACT_SOCKETS");
1800 #endif
1801   plugin->myoptions = UNIX_OPTIONS_NONE;
1802   if (GNUNET_YES == plugin->is_abstract)
1803     plugin->myoptions = UNIX_OPTIONS_USE_ABSTRACT_SOCKETS;
1804
1805   api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
1806   api->cls = plugin;
1807   api->get_session = &unix_plugin_get_session;
1808   api->send = &unix_plugin_send;
1809   api->disconnect_peer = &unix_plugin_peer_disconnect;
1810   api->disconnect_session = &unix_plugin_session_disconnect;
1811   api->query_keepalive_factor = &unix_plugin_query_keepalive_factor;
1812   api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1813   api->address_to_string = &unix_plugin_address_to_string;
1814   api->check_address = &unix_plugin_check_address;
1815   api->string_to_address = &unix_plugin_string_to_address;
1816   api->get_network = &unix_plugin_get_network;
1817   api->get_network_for_address = &unix_plugin_get_network_for_address;
1818   api->update_session_timeout = &unix_plugin_update_session_timeout;
1819   api->setup_monitor = &unix_plugin_setup_monitor;
1820   sockets_created = unix_transport_server_start (plugin);
1821   if ((0 == sockets_created) || (GNUNET_SYSERR == sockets_created))
1822   {
1823     LOG (GNUNET_ERROR_TYPE_WARNING,
1824          _("Failed to open UNIX listen socket\n"));
1825     GNUNET_free (api);
1826     GNUNET_free (plugin->unix_socket_path);
1827     GNUNET_free (plugin);
1828     return NULL;
1829   }
1830   plugin->session_map = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1831   plugin->address_update_task = GNUNET_SCHEDULER_add_now (&address_notification,
1832                                                           plugin);
1833   return api;
1834 }
1835
1836
1837 /**
1838  * Shutdown the plugin.
1839  *
1840  * @param cls the plugin API returned from the initialization function
1841  * @return NULL (always)
1842  */
1843 void *
1844 libgnunet_plugin_transport_unix_done (void *cls)
1845 {
1846   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1847   struct Plugin *plugin = api->cls;
1848   struct GNUNET_HELLO_Address *address;
1849   struct UNIXMessageWrapper * msgw;
1850   struct UnixAddress *ua;
1851   size_t len;
1852   struct GNUNET_ATS_Session *session;
1853
1854   if (NULL == plugin)
1855   {
1856     GNUNET_free (api);
1857     return NULL;
1858   }
1859   len = sizeof (struct UnixAddress) + strlen (plugin->unix_socket_path) + 1;
1860   ua = GNUNET_malloc (len);
1861   ua->options = htonl (plugin->myoptions);
1862   ua->addrlen = htonl(strlen (plugin->unix_socket_path) + 1);
1863   memcpy (&ua[1],
1864           plugin->unix_socket_path,
1865           strlen (plugin->unix_socket_path) + 1);
1866   address = GNUNET_HELLO_address_allocate (plugin->env->my_identity,
1867                                            PLUGIN_NAME,
1868                                            ua, len,
1869                                            GNUNET_HELLO_ADDRESS_INFO_NONE);
1870   plugin->env->notify_address (plugin->env->cls,
1871                                GNUNET_NO,
1872                                address);
1873
1874   GNUNET_free (address);
1875   GNUNET_free (ua);
1876
1877   while (NULL != (msgw = plugin->msg_head))
1878   {
1879     GNUNET_CONTAINER_DLL_remove (plugin->msg_head,
1880                                  plugin->msg_tail,
1881                                  msgw);
1882     session = msgw->session;
1883     session->msgs_in_queue--;
1884     GNUNET_assert (session->bytes_in_queue >= msgw->msgsize);
1885     session->bytes_in_queue -= msgw->msgsize;
1886     GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
1887     plugin->bytes_in_queue -= msgw->msgsize;
1888     if (NULL != msgw->cont)
1889       msgw->cont (msgw->cont_cls,
1890                   &msgw->session->target,
1891                   GNUNET_SYSERR,
1892                   msgw->payload, 0);
1893     GNUNET_free (msgw->msg);
1894     GNUNET_free (msgw);
1895   }
1896
1897   if (NULL != plugin->read_task)
1898   {
1899     GNUNET_SCHEDULER_cancel (plugin->read_task);
1900     plugin->read_task = NULL;
1901   }
1902   if (NULL != plugin->write_task)
1903   {
1904     GNUNET_SCHEDULER_cancel (plugin->write_task);
1905     plugin->write_task = NULL;
1906   }
1907   if (NULL != plugin->address_update_task)
1908   {
1909     GNUNET_SCHEDULER_cancel (plugin->address_update_task);
1910     plugin->address_update_task = NULL;
1911   }
1912   if (NULL != plugin->unix_sock.desc)
1913   {
1914     GNUNET_break (GNUNET_OK ==
1915                   GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
1916     plugin->unix_sock.desc = NULL;
1917   }
1918   GNUNET_CONTAINER_multipeermap_iterate (plugin->session_map,
1919                                          &get_session_delete_it,
1920                                          plugin);
1921   GNUNET_CONTAINER_multipeermap_destroy (plugin->session_map);
1922   GNUNET_break (0 == plugin->bytes_in_queue);
1923   GNUNET_free (plugin->unix_socket_path);
1924   GNUNET_free (plugin);
1925   GNUNET_free (api);
1926   return NULL;
1927 }
1928
1929 /* end of plugin_transport_unix.c */