src/transport/plugin_transport_unix.c

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