src/transport/plugin_transport_unix.c

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