src/transport/plugin_transport_unix.c

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