2 This file is part of GNUnet
3 (C) 2010, 2013 Christian Grothoff (and other contributing authors)
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.
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.
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.
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
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"
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!?).
46 #define PLUGIN_NAME "unix"
49 * How long until we give up on transmitting the welcome message?
51 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
54 * Default "port" to use, if configuration does not specify.
55 * Essentially just a number appended to the UNIX path.
57 #define UNIX_NAT_DEFAULT_PORT 22086
60 #define LOG(kind,...) GNUNET_log_from (kind, "transport-unix",__VA_ARGS__)
63 GNUNET_NETWORK_STRUCT_BEGIN
67 uint32_t options GNUNET_PACKED;
69 uint32_t addrlen GNUNET_PACKED;
74 * UNIX Message-Packet header.
81 struct GNUNET_MessageHeader header;
84 * What is the identity of the sender (GNUNET_hash of public key)
86 struct GNUNET_PeerIdentity sender;
90 GNUNET_NETWORK_STRUCT_END
95 static uint32_t myoptions;
98 * Handle for a session.
102 struct GNUNET_PeerIdentity target;
104 struct Plugin * plugin;
106 struct UnixAddress *addr;
113 * Session timeout task
115 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
119 struct UNIXMessageWrapper
122 * We keep messages in a doubly linked list.
124 struct UNIXMessageWrapper *next;
127 * We keep messages in a doubly linked list.
129 struct UNIXMessageWrapper *prev;
132 * The actual payload (allocated separately right now).
134 struct UNIXMessage * msg;
137 * Session this message belongs to.
139 struct Session *session;
142 * Function to call upon transmission.
144 GNUNET_TRANSPORT_TransmitContinuation cont;
147 * Closure for 'cont'.
152 * Timeout for this message.
154 struct GNUNET_TIME_Absolute timeout;
157 * Number of bytes in 'msg'.
162 * Number of bytes of payload encapsulated in 'msg'.
167 * Priority of the message (ignored, just dragged along in UNIX).
169 unsigned int priority;
174 * Encapsulation of all of the state of the plugin.
186 * Stored in a linked list.
188 struct PeerSession *next;
191 * Pointer to the global plugin struct.
193 struct Plugin *plugin;
196 * To whom are we talking to (set to our identity
197 * if we are still waiting for the welcome message)
199 struct GNUNET_PeerIdentity target;
202 * Address of the other peer (either based on our 'connect'
203 * call or on our 'accept' call).
208 * Length of connect_addr.
213 * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
215 int expecting_welcome;
218 * From which socket do we need to send to this peer?
220 struct GNUNET_NETWORK_Handle *sock;
223 * Queue of messages for this peer, in the case that
224 * we have to await a connection...
226 struct MessageQueue *messages;
232 * Information we keep for each of our listen sockets.
234 struct UNIX_Sock_Info
239 struct GNUNET_NETWORK_Handle *desc;
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
251 * Encapsulation of all of the state of the plugin.
257 * ID of task used to update our addresses when one expires.
259 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
264 GNUNET_SCHEDULER_TaskIdentifier select_task;
267 * Number of bytes we currently have in our write queue.
269 unsigned long long bytes_in_queue;
274 struct GNUNET_TRANSPORT_PluginEnvironment *env;
279 struct GNUNET_CONTAINER_MultiHashMap *session_map;
284 struct GNUNET_NETWORK_FDSet *rs;
289 struct GNUNET_NETWORK_FDSet *ws;
292 * Path of our unix domain socket (/tmp/unix-plugin-PORT)
294 char *unix_socket_path;
297 * Head of queue of messages to transmit.
299 struct UNIXMessageWrapper *msg_head;
302 * Tail of queue of messages to transmit.
304 struct UNIXMessageWrapper *msg_tail;
307 * socket that we transmit all data with
309 struct UNIX_Sock_Info unix_sock;
314 struct GNUNET_ATS_Information ats_network;
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.
324 * Integer to append to unix domain socket.
332 * Increment session timeout due to activity
334 * @param s session for which the timeout should be moved
337 reschedule_session_timeout (struct Session *s);
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.
345 * @param cls the plugin handle
346 * @param tc the scheduling context (for rescheduling this function again)
349 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
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.
358 * @param addr binary address
359 * @param addrlen length of the address
360 * @return string representing the same address
363 unix_address_to_string (void *cls, const void *addr, size_t addrlen);
366 * Re-schedule the main 'select' callback (unix_plugin_select)
369 * @param plugin the plugin context
372 reschedule_select (struct Plugin * plugin)
374 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
376 GNUNET_SCHEDULER_cancel (plugin->select_task);
377 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
379 if (NULL != plugin->msg_head)
381 plugin->select_task =
382 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
383 GNUNET_TIME_UNIT_FOREVER_REL,
386 &unix_plugin_select, plugin);
387 plugin->with_ws = GNUNET_YES;
391 plugin->select_task =
392 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
393 GNUNET_TIME_UNIT_FOREVER_REL,
396 &unix_plugin_select, plugin);
397 plugin->with_ws = GNUNET_NO;
403 * Closure to 'lookup_session_it'.
408 * Location to store the session, if found.
413 * Address we are looking for.
415 const struct UnixAddress *ua;
422 * Function called to find a session by address.
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
430 lookup_session_it (void *cls,
431 const struct GNUNET_HashCode * key,
434 struct LookupCtx *lctx = cls;
435 struct Session *t = value;
437 if (t->addrlen != lctx->ua_len)
443 if (0 == memcmp (t->addr, lctx->ua, lctx->ua_len))
454 * Find an existing session by address.
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
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)
467 struct LookupCtx lctx;
469 GNUNET_assert (NULL != plugin);
470 GNUNET_assert (NULL != sender);
471 GNUNET_assert (NULL != ua);
474 lctx.ua_len = ua_len;
475 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map,
477 &lookup_session_it, &lctx);
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.
487 * @param s session to close down
490 disconnect_session (struct Session *s)
492 struct Plugin *plugin = s->plugin;
493 struct UNIXMessageWrapper *msgw;
494 struct UNIXMessageWrapper *next;
497 LOG (GNUNET_ERROR_TYPE_DEBUG,
498 "Disconnecting session for peer `%s' `%s'\n",
499 GNUNET_i2s (&s->target),
501 plugin->env->session_end (plugin->env->cls, &s->target, s);
503 next = plugin->msg_head;
508 if (msgw->session != s)
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,
514 GNUNET_free (msgw->msg);
516 removed = GNUNET_YES;
518 GNUNET_assert (GNUNET_YES ==
519 GNUNET_CONTAINER_multihashmap_remove (plugin->session_map,
520 &s->target.hashPubKey,
522 GNUNET_STATISTICS_set (plugin->env->stats,
523 "# UNIX sessions active",
524 GNUNET_CONTAINER_multihashmap_size (plugin->session_map),
526 if ((GNUNET_YES == removed) && (NULL == plugin->msg_head))
527 reschedule_select (plugin);
528 if (GNUNET_SCHEDULER_NO_TASK != s->timeout_task)
530 GNUNET_SCHEDULER_cancel (s->timeout_task);
531 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
538 * Actually send out the message, assume we've got the address and
539 * send_handle squared away!
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
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,
567 GNUNET_TRANSPORT_TransmitContinuation cont,
570 struct Plugin *plugin = cls;
574 struct sockaddr_un un;
576 const char *unix_path;
579 GNUNET_assert (NULL != plugin);
580 if (NULL == send_handle)
582 GNUNET_break (0); /* We do not have a send handle */
583 return GNUNET_SYSERR;
585 if ((NULL == addr) || (0 == addrlen))
587 GNUNET_break (0); /* Can never send if we don't have an address */
588 return GNUNET_SYSERR;
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);
603 un.sun_path[0] = '\0';
605 #if HAVE_SOCKADDR_IN_SIN_LEN
606 un.sun_len = (u_char) slen;
608 sb = (struct sockaddr *) &un;
614 sent = GNUNET_NETWORK_socket_sendto (send_handle, msgbuf, msgbuf_size, sb, sbs);
616 if (GNUNET_SYSERR == sent)
618 if ( (EAGAIN == errno) ||
620 return RETRY; /* We have to retry later */
621 if (EMSGSIZE == errno)
624 socklen_t len = sizeof (size);
626 GNUNET_NETWORK_socket_getsockopt ((struct GNUNET_NETWORK_Handle *)
627 send_handle, SOL_SOCKET, SO_SNDBUF, &size,
629 if (size < msgbuf_size)
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 */
641 /* Could not increase buffer size: error, no retry */
642 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
643 return GNUNET_SYSERR;
648 /* Buffer is bigger than message: error, no retry
649 * This should never happen!*/
651 return GNUNET_SYSERR;
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),
661 (sent < 0) ? STRERROR (errno) : "ok");
667 * Closure for 'get_session_it'.
669 struct GetSessionIteratorContext
672 * Location to store the session, if found.
677 * Address information.
682 * Number of bytes in 'address'
689 * Function called to find a session by address.
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
697 get_session_it (void *cls,
698 const struct GNUNET_HashCode *key,
701 struct GetSessionIteratorContext *gsi = cls;
702 struct Session *s = value;
704 if ( (gsi->addrlen == s->addrlen) &&
705 (0 == memcmp (gsi->address, s->addr, s->addrlen)) )
715 * Session was idle for too long, so disconnect it
717 * @param cls the 'struct Session' to disconnect
718 * @param tc scheduler context
721 session_timeout (void *cls,
722 const struct GNUNET_SCHEDULER_TaskContext *tc)
724 struct Session *s = cls;
726 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
727 LOG (GNUNET_ERROR_TYPE_DEBUG,
728 "Session %p was idle for %s, disconnecting\n",
730 GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
732 disconnect_session (s);
737 * Function obtain the network type for a session
739 * @param cls closure ('struct Plugin*')
740 * @param session the session
741 * @return the network type in HBO or GNUNET_SYSERR
743 static enum GNUNET_ATS_Network_Type
744 unix_get_network (void *cls,
745 struct Session *session)
747 GNUNET_assert (NULL != session);
748 return GNUNET_ATS_NET_LOOPBACK;
753 * Creates a new outbound session the transport service will use to send data to the
756 * @param cls the plugin
757 * @param address the address
758 * @return the session or NULL of max connections exceeded
760 static struct Session *
761 unix_plugin_get_session (void *cls,
762 const struct GNUNET_HELLO_Address *address)
764 struct Plugin *plugin = cls;
766 struct GetSessionIteratorContext gsi;
767 struct UnixAddress *ua;
769 uint32_t addr_str_len;
771 GNUNET_assert (NULL != plugin);
772 GNUNET_assert (NULL != address);
774 ua = (struct UnixAddress *) address->address;
775 if ((NULL == address->address) || (0 == address->address_length) ||
776 (sizeof (struct UnixAddress) > address->address_length))
781 addrstr = (char *) &ua[1];
782 addr_str_len = ntohl (ua->addrlen);
783 if (addr_str_len != address->address_length - sizeof (struct UnixAddress))
785 /* This can be a legacy address */
789 if ('\0' != addrstr[addr_str_len - 1])
794 if (strlen (addrstr) + 1 != addr_str_len)
800 /* Check if already existing */
801 gsi.address = (const char *) address->address;
802 gsi.addrlen = address->address_length;
804 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map,
805 &address->peer.hashPubKey,
806 &get_session_it, &gsi);
809 LOG (GNUNET_ERROR_TYPE_DEBUG,
810 "Found existing session\n");
814 /* create a new session */
815 s = GNUNET_malloc (sizeof (struct Session) + address->address_length);
816 s->addr = (struct UnixAddress *) &s[1];
817 s->addrlen = address->address_length;
819 s->inbound = GNUNET_NO;
820 memcpy (s->addr, address->address, address->address_length);
821 memcpy (&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
822 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == s->timeout_task);
823 s->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
826 LOG (GNUNET_ERROR_TYPE_DEBUG,
827 "Creating a new session %p for address `%s'\n",
828 s, unix_address_to_string (NULL, address->address, address->address_length));
829 (void) GNUNET_CONTAINER_multihashmap_put (plugin->session_map,
830 &address->peer.hashPubKey, s,
831 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
832 GNUNET_STATISTICS_set (plugin->env->stats,
833 "# UNIX sessions active",
834 GNUNET_CONTAINER_multihashmap_size (plugin->session_map),
841 * Function that can be used by the transport service to transmit
842 * a message using the plugin. Note that in the case of a
843 * peer disconnecting, the continuation MUST be called
844 * prior to the disconnect notification itself. This function
845 * will be called with this peer's HELLO message to initiate
846 * a fresh connection to another peer.
849 * @param session which session must be used
850 * @param msgbuf the message to transmit
851 * @param msgbuf_size number of bytes in 'msgbuf'
852 * @param priority how important is the message (most plugins will
853 * ignore message priority and just FIFO)
854 * @param to how long to wait at most for the transmission (does not
855 * require plugins to discard the message after the timeout,
856 * just advisory for the desired delay; most plugins will ignore
858 * @param cont continuation to call once the message has
859 * been transmitted (or if the transport is ready
860 * for the next transmission call; or if the
861 * peer disconnected...); can be NULL
862 * @param cont_cls closure for cont
863 * @return number of bytes used (on the physical network, with overheads);
864 * -1 on hard errors (i.e. address invalid); 0 is a legal value
865 * and does NOT mean that the message was not transmitted (DV)
868 unix_plugin_send (void *cls,
869 struct Session *session,
870 const char *msgbuf, size_t msgbuf_size,
871 unsigned int priority,
872 struct GNUNET_TIME_Relative to,
873 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
875 struct Plugin *plugin = cls;
876 struct UNIXMessageWrapper *wrapper;
877 struct UNIXMessage *message;
880 GNUNET_assert (NULL != plugin);
881 GNUNET_assert (NULL != session);
884 GNUNET_CONTAINER_multihashmap_contains_value (plugin->session_map,
885 &session->target.hashPubKey,
888 LOG (GNUNET_ERROR_TYPE_ERROR,
889 "Invalid session for peer `%s' `%s'\n",
890 GNUNET_i2s (&session->target),
891 (const char *) session->addr);
893 return GNUNET_SYSERR;
895 LOG (GNUNET_ERROR_TYPE_DEBUG,
896 "Sending %u bytes with session for peer `%s' `%s'\n",
898 GNUNET_i2s (&session->target),
899 (const char *) session->addr);
900 ssize = sizeof (struct UNIXMessage) + msgbuf_size;
901 message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
902 message->header.size = htons (ssize);
903 message->header.type = htons (0);
904 memcpy (&message->sender, plugin->env->my_identity,
905 sizeof (struct GNUNET_PeerIdentity));
906 memcpy (&message[1], msgbuf, msgbuf_size);
907 reschedule_session_timeout (session);
908 wrapper = GNUNET_malloc (sizeof (struct UNIXMessageWrapper));
909 wrapper->msg = message;
910 wrapper->msgsize = ssize;
911 wrapper->payload = msgbuf_size;
912 wrapper->priority = priority;
913 wrapper->timeout = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), to);
914 wrapper->cont = cont;
915 wrapper->cont_cls = cont_cls;
916 wrapper->session = session;
917 GNUNET_CONTAINER_DLL_insert (plugin->msg_head,
920 plugin->bytes_in_queue += ssize;
921 GNUNET_STATISTICS_set (plugin->env->stats,
922 "# bytes currently in UNIX buffers",
923 plugin->bytes_in_queue,
925 if (GNUNET_NO == plugin->with_ws)
926 reschedule_select (plugin);
932 * Demultiplexer for UNIX messages
934 * @param plugin the main plugin for this transport
935 * @param sender from which peer the message was received
936 * @param currhdr pointer to the header of the message
937 * @param ua address to look for
938 * @param ua_len length of the address
941 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
942 const struct GNUNET_MessageHeader *currhdr,
943 const struct UnixAddress *ua, size_t ua_len)
945 struct Session *s = NULL;
946 struct GNUNET_HELLO_Address * addr;
948 GNUNET_break (ntohl(plugin->ats_network.value) != GNUNET_ATS_NET_UNSPECIFIED);
950 GNUNET_assert (ua_len >= sizeof (struct UnixAddress));
952 LOG (GNUNET_ERROR_TYPE_DEBUG,
953 "Received message from %s\n",
954 unix_address_to_string(NULL, ua, ua_len));
955 GNUNET_STATISTICS_update (plugin->env->stats,
956 "# bytes received via UNIX",
957 ntohs (currhdr->size),
960 addr = GNUNET_HELLO_address_allocate (sender,
964 s = lookup_session (plugin, sender, ua, ua_len);
967 s = unix_plugin_get_session (plugin, addr);
968 s->inbound = GNUNET_YES;
969 /* Notify transport and ATS about new inbound session */
970 plugin->env->session_start (NULL, sender,
971 PLUGIN_NAME, NULL, 0, s, &plugin->ats_network, 1);
973 reschedule_session_timeout (s);
975 plugin->env->receive (plugin->env->cls, sender, currhdr, s,
976 (GNUNET_YES == s->inbound) ? NULL : (const char *) ua,
977 (GNUNET_YES == s->inbound) ? 0 : ua_len);
979 plugin->env->update_address_metrics (plugin->env->cls, sender,
980 (GNUNET_YES == s->inbound) ? NULL : (const char *) ua,
981 (GNUNET_YES == s->inbound) ? 0 : ua_len,
982 s, &plugin->ats_network, 1);
989 * Read from UNIX domain socket (it is ready).
991 * @param plugin the plugin
994 unix_plugin_select_read (struct Plugin *plugin)
996 char buf[65536] GNUNET_ALIGN;
997 struct UnixAddress *ua;
998 struct UNIXMessage *msg;
999 struct GNUNET_PeerIdentity sender;
1000 struct sockaddr_un un;
1006 const struct GNUNET_MessageHeader *currhdr;
1010 addrlen = sizeof (un);
1011 memset (&un, 0, sizeof (un));
1014 GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc, buf, sizeof (buf),
1015 (struct sockaddr *) &un, &addrlen);
1017 if ((GNUNET_SYSERR == ret) && ((errno == EAGAIN) || (errno == ENOBUFS)))
1020 if (ret == GNUNET_SYSERR)
1022 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "recvfrom");
1028 un.sun_path[0] = '/';
1030 LOG (GNUNET_ERROR_TYPE_DEBUG, "Read %d bytes from socket %s\n", ret,
1034 GNUNET_assert (AF_UNIX == (un.sun_family));
1035 ua_len = sizeof (struct UnixAddress) + strlen (&un.sun_path[0]) +1;
1036 ua = GNUNET_malloc (ua_len);
1037 ua->addrlen = htonl (strlen (&un.sun_path[0]) +1);
1038 ua->options = htonl (0);
1039 memcpy (&ua[1], &un.sun_path[0], strlen (&un.sun_path[0]) +1);
1041 msg = (struct UNIXMessage *) buf;
1042 csize = ntohs (msg->header.size);
1043 if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
1045 GNUNET_break_op (0);
1048 msgbuf = (char *) &msg[1];
1049 memcpy (&sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
1051 tsize = csize - sizeof (struct UNIXMessage);
1052 while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
1054 currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
1055 csize = ntohs (currhdr->size);
1056 if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
1057 (csize > tsize - offset))
1059 GNUNET_break_op (0);
1062 unix_demultiplexer (plugin, &sender, currhdr, ua, ua_len);
1070 * Write to UNIX domain socket (it is ready).
1072 * @param plugin the plugin
1075 unix_plugin_select_write (struct Plugin *plugin)
1078 struct UNIXMessageWrapper * msgw;
1080 while (NULL != (msgw = plugin->msg_tail))
1082 if (GNUNET_TIME_absolute_get_remaining (msgw->timeout).rel_value > 0)
1083 break; /* Message is ready for sending */
1084 /* Message has a timeout */
1085 LOG (GNUNET_ERROR_TYPE_DEBUG,
1086 "Timeout for message with %u bytes \n",
1087 (unsigned int) msgw->msgsize);
1088 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
1089 plugin->bytes_in_queue -= msgw->msgsize;
1090 GNUNET_STATISTICS_set (plugin->env->stats,
1091 "# bytes currently in UNIX buffers",
1092 plugin->bytes_in_queue, GNUNET_NO);
1093 GNUNET_STATISTICS_update (plugin->env->stats,
1094 "# UNIX bytes discarded",
1097 if (NULL != msgw->cont)
1098 msgw->cont (msgw->cont_cls,
1099 &msgw->session->target,
1103 GNUNET_free (msgw->msg);
1107 return; /* Nothing to send at the moment */
1109 sent = unix_real_send (plugin,
1110 plugin->unix_sock.desc,
1111 &msgw->session->target,
1112 (const char *) msgw->msg,
1116 msgw->session->addr,
1117 msgw->session->addrlen,
1119 msgw->cont, msgw->cont_cls);
1123 GNUNET_STATISTICS_update (plugin->env->stats,
1124 "# UNIX retry attempts",
1128 if (GNUNET_SYSERR == sent)
1130 /* failed and no retry */
1131 if (NULL != msgw->cont)
1132 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR, msgw->payload, 0);
1134 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
1136 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
1137 plugin->bytes_in_queue -= msgw->msgsize;
1138 GNUNET_STATISTICS_set (plugin->env->stats,
1139 "# bytes currently in UNIX buffers",
1140 plugin->bytes_in_queue, GNUNET_NO);
1141 GNUNET_STATISTICS_update (plugin->env->stats,
1142 "# UNIX bytes discarded",
1146 GNUNET_free (msgw->msg);
1150 /* successfully sent bytes */
1151 GNUNET_break (sent > 0);
1152 GNUNET_CONTAINER_DLL_remove (plugin->msg_head,
1155 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
1156 plugin->bytes_in_queue -= msgw->msgsize;
1157 GNUNET_STATISTICS_set (plugin->env->stats,
1158 "# bytes currently in UNIX buffers",
1159 plugin->bytes_in_queue,
1161 GNUNET_STATISTICS_update (plugin->env->stats,
1162 "# bytes transmitted via UNIX",
1165 if (NULL != msgw->cont)
1166 msgw->cont (msgw->cont_cls, &msgw->session->target,
1170 GNUNET_free (msgw->msg);
1176 * We have been notified that our writeset has something to read. We don't
1177 * know which socket needs to be read, so we have to check each one
1178 * Then reschedule this function to be called again once more is available.
1180 * @param cls the plugin handle
1181 * @param tc the scheduling context (for rescheduling this function again)
1184 unix_plugin_select (void *cls,
1185 const struct GNUNET_SCHEDULER_TaskContext *tc)
1187 struct Plugin *plugin = cls;
1189 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
1190 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
1193 if ((tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY) != 0)
1195 /* Ready to send data */
1196 GNUNET_assert (GNUNET_NETWORK_fdset_isset
1197 (tc->write_ready, plugin->unix_sock.desc));
1198 if (NULL != plugin->msg_head)
1199 unix_plugin_select_write (plugin);
1202 if ((tc->reason & GNUNET_SCHEDULER_REASON_READ_READY) != 0)
1204 /* Ready to receive data */
1205 GNUNET_assert (GNUNET_NETWORK_fdset_isset
1206 (tc->read_ready, plugin->unix_sock.desc));
1207 unix_plugin_select_read (plugin);
1209 reschedule_select (plugin);
1214 * Create a slew of UNIX sockets. If possible, use IPv6 and IPv4.
1216 * @param cls closure for server start, should be a struct Plugin *
1217 * @return number of sockets created or GNUNET_SYSERR on error
1220 unix_transport_server_start (void *cls)
1222 struct Plugin *plugin = cls;
1223 struct sockaddr *serverAddr;
1225 struct sockaddr_un un;
1228 memset (&un, 0, sizeof (un));
1229 un.sun_family = AF_UNIX;
1230 slen = strlen (plugin->unix_socket_path) + 1;
1231 if (slen >= sizeof (un.sun_path))
1232 slen = sizeof (un.sun_path) - 1;
1234 memcpy (un.sun_path, plugin->unix_socket_path, slen);
1235 un.sun_path[slen] = '\0';
1236 slen = sizeof (struct sockaddr_un);
1237 #if HAVE_SOCKADDR_IN_SIN_LEN
1238 un.sun_len = (u_char) slen;
1241 serverAddr = (struct sockaddr *) &un;
1244 un.sun_path[0] = '\0';
1246 plugin->ats_network = plugin->env->get_address_type (plugin->env->cls, serverAddr, addrlen);
1247 plugin->unix_sock.desc =
1248 GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_DGRAM, 0);
1249 if (NULL == plugin->unix_sock.desc)
1251 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
1252 return GNUNET_SYSERR;
1254 if (GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, serverAddr, addrlen, 0)
1257 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
1258 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
1259 plugin->unix_sock.desc = NULL;
1260 return GNUNET_SYSERR;
1262 LOG (GNUNET_ERROR_TYPE_DEBUG, "Bound to `%s'\n", plugin->unix_socket_path);
1263 plugin->rs = GNUNET_NETWORK_fdset_create ();
1264 plugin->ws = GNUNET_NETWORK_fdset_create ();
1265 GNUNET_NETWORK_fdset_zero (plugin->rs);
1266 GNUNET_NETWORK_fdset_zero (plugin->ws);
1267 GNUNET_NETWORK_fdset_set (plugin->rs, plugin->unix_sock.desc);
1268 GNUNET_NETWORK_fdset_set (plugin->ws, plugin->unix_sock.desc);
1270 reschedule_select (plugin);
1277 * Function called for a quick conversion of the binary address to
1278 * a numeric address. Note that the caller must not free the
1279 * address and that the next call to this function is allowed
1280 * to override the address again.
1282 * @param cls closure
1283 * @param addr binary address
1284 * @param addrlen length of the address
1285 * @return string representing the same address
1288 unix_address_to_string (void *cls, const void *addr, size_t addrlen)
1290 static char rbuf[1024];
1291 struct UnixAddress *ua = (struct UnixAddress *) addr;
1293 size_t addr_str_len;
1297 GNUNET_snprintf(rbuf, sizeof (rbuf), "%s", TRANSPORT_SESSION_INBOUND_STRING);
1299 if ((NULL == addr) || (sizeof (struct UnixAddress) > addrlen))
1304 addrstr = (char *) &ua[1];
1305 addr_str_len = ntohl (ua->addrlen);
1307 if (addr_str_len != addrlen - sizeof (struct UnixAddress))
1313 if ('\0' != addrstr[addr_str_len - 1])
1318 if (strlen (addrstr) + 1 != addr_str_len)
1324 GNUNET_snprintf(rbuf, sizeof (rbuf), "%s.%u.%s", PLUGIN_NAME, ntohl (ua->options), addrstr);
1329 * Function that will be called to check if a binary address for this
1330 * plugin is well-formed and corresponds to an address for THIS peer
1331 * (as per our configuration). Naturally, if absolutely necessary,
1332 * plugins can be a bit conservative in their answer, but in general
1333 * plugins should make sure that the address does not redirect
1334 * traffic to a 3rd party that might try to man-in-the-middle our
1337 * @param cls closure, should be our handle to the Plugin
1338 * @param addr pointer to the address
1339 * @param addrlen length of addr
1340 * @return GNUNET_OK if this is a plausible address for this peer
1341 * and transport, GNUNET_SYSERR if not
1345 unix_check_address (void *cls, const void *addr, size_t addrlen)
1347 struct Plugin* plugin = cls;
1348 struct UnixAddress *ua = (struct UnixAddress *) addr;
1350 size_t addr_str_len;
1352 if ((NULL == addr) || (0 == addrlen) || (sizeof (struct UnixAddress) > addrlen))
1355 return GNUNET_SYSERR;
1357 addrstr = (char *) &ua[1];
1358 addr_str_len = ntohl (ua->addrlen);
1359 if ('\0' != addrstr[addr_str_len - 1])
1362 return GNUNET_SYSERR;
1364 if (strlen (addrstr) + 1 != addr_str_len)
1367 return GNUNET_SYSERR;
1370 if (0 == strcmp (plugin->unix_socket_path, addrstr))
1372 return GNUNET_SYSERR;
1377 * Convert the transports address to a nice, human-readable
1380 * @param cls closure
1381 * @param type name of the transport that generated the address
1382 * @param addr one of the addresses of the host, NULL for the last address
1383 * the specific address format depends on the transport
1384 * @param addrlen length of the address
1385 * @param numeric should (IP) addresses be displayed in numeric form?
1386 * @param timeout after how long should we give up?
1387 * @param asc function to call on each string
1388 * @param asc_cls closure for asc
1391 unix_plugin_address_pretty_printer (void *cls, const char *type,
1392 const void *addr, size_t addrlen,
1394 struct GNUNET_TIME_Relative timeout,
1395 GNUNET_TRANSPORT_AddressStringCallback asc,
1398 if ((NULL != addr) && (addrlen > 0))
1400 asc (asc_cls, unix_address_to_string (NULL, addr, addrlen));
1402 else if (0 == addrlen)
1404 asc (asc_cls, TRANSPORT_SESSION_INBOUND_STRING);
1409 asc (asc_cls, "<invalid UNIX address>");
1411 asc (asc_cls, NULL);
1416 * Function called to convert a string address to
1419 * @param cls closure ('struct Plugin*')
1420 * @param addr string address
1421 * @param addrlen length of the address (strlen(addr) + '\0')
1422 * @param buf location to store the buffer
1423 * If the function returns GNUNET_SYSERR, its contents are undefined.
1424 * @param added length of created address
1425 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
1428 unix_string_to_address (void *cls, const char *addr, uint16_t addrlen,
1429 void **buf, size_t *added)
1431 struct UnixAddress *ua;
1438 /* Format unix.options.address */
1443 if ((NULL == addr) || (addrlen == 0))
1446 return GNUNET_SYSERR;
1448 if ('\0' != addr[addrlen - 1])
1451 return GNUNET_SYSERR;
1453 if (strlen (addr) != addrlen - 1)
1456 return GNUNET_SYSERR;
1458 plugin = GNUNET_strdup (addr);
1459 optionstr = strchr (plugin, '.');
1460 if (NULL == optionstr)
1463 GNUNET_free (plugin);
1464 return GNUNET_SYSERR;
1466 optionstr[0] = '\0';
1468 options = atol (optionstr);
1469 address = strchr (optionstr, '.');
1470 if (NULL == address)
1473 GNUNET_free (plugin);
1474 return GNUNET_SYSERR;
1478 if (0 != strcmp(plugin, PLUGIN_NAME))
1481 GNUNET_free (plugin);
1482 return GNUNET_SYSERR;
1485 ua_size = sizeof (struct UnixAddress) + strlen (address) + 1;
1486 ua = GNUNET_malloc (ua_size);
1487 ua->options = htonl (options);
1488 ua->addrlen = htonl (strlen (address) + 1);
1489 memcpy (&ua[1], address, strlen (address) + 1);
1490 GNUNET_free (plugin);
1499 * Notify transport service about address
1501 * @param cls the plugin
1505 address_notification (void *cls,
1506 const struct GNUNET_SCHEDULER_TaskContext *tc)
1508 struct Plugin *plugin = cls;
1510 struct UnixAddress *ua;
1512 len = sizeof (struct UnixAddress) + strlen (plugin->unix_socket_path) + 1;
1513 ua = GNUNET_malloc (len);
1514 ua->options = htonl (myoptions);
1515 ua->addrlen = htonl(strlen (plugin->unix_socket_path) + 1);
1516 memcpy (&ua[1], plugin->unix_socket_path, strlen (plugin->unix_socket_path) + 1);
1518 plugin->address_update_task = GNUNET_SCHEDULER_NO_TASK;
1519 plugin->env->notify_address (plugin->env->cls, GNUNET_YES,
1526 * Increment session timeout due to activity
1528 * @param s session for which the timeout should be moved
1531 reschedule_session_timeout (struct Session *s)
1533 GNUNET_assert (NULL != s);
1534 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != s->timeout_task);
1535 GNUNET_SCHEDULER_cancel (s->timeout_task);
1536 s->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1539 LOG (GNUNET_ERROR_TYPE_DEBUG,
1540 "Timeout rescheduled for session %p set to %s\n",
1542 GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1548 * Function called on sessions to disconnect
1550 * @param cls the plugin (unused)
1551 * @param key peer identity (unused)
1552 * @param value the 'struct Session' to disconnect
1553 * @return GNUNET_YES (always, continue to iterate)
1556 get_session_delete_it (void *cls, const struct GNUNET_HashCode * key, void *value)
1558 struct Session *s = value;
1560 disconnect_session (s);
1566 * Disconnect from a remote node. Clean up session if we have one for this peer
1568 * @param cls closure for this call (should be handle to Plugin)
1569 * @param target the peeridentity of the peer to disconnect
1570 * @return GNUNET_OK on success, GNUNET_SYSERR if the operation failed
1573 unix_disconnect (void *cls,
1574 const struct GNUNET_PeerIdentity *target)
1576 struct Plugin *plugin = cls;
1578 GNUNET_assert (plugin != NULL);
1579 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map,
1580 &target->hashPubKey,
1581 &get_session_delete_it, plugin);
1586 * The exported method. Initializes the plugin and returns a
1587 * struct with the callbacks.
1589 * @param cls the plugin's execution environment
1590 * @return NULL on error, plugin functions otherwise
1593 libgnunet_plugin_transport_unix_init (void *cls)
1595 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1596 unsigned long long port;
1597 struct GNUNET_TRANSPORT_PluginFunctions *api;
1598 struct Plugin *plugin;
1599 int sockets_created;
1601 if (NULL == env->receive)
1603 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1604 initialze the plugin or the API */
1605 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1607 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1608 api->address_to_string = &unix_address_to_string;
1609 api->string_to_address = &unix_string_to_address;
1613 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
1615 port = UNIX_NAT_DEFAULT_PORT;
1616 plugin = GNUNET_malloc (sizeof (struct Plugin));
1617 plugin->port = port;
1619 GNUNET_asprintf (&plugin->unix_socket_path,
1620 "/tmp/unix-plugin-sock.%d",
1623 /* Initialize my flags */
1626 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1629 api->get_session = &unix_plugin_get_session;
1630 api->send = &unix_plugin_send;
1631 api->disconnect = &unix_disconnect;
1632 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1633 api->address_to_string = &unix_address_to_string;
1634 api->check_address = &unix_check_address;
1635 api->string_to_address = &unix_string_to_address;
1636 api->get_network = &unix_get_network;
1637 sockets_created = unix_transport_server_start (plugin);
1638 if (0 == sockets_created)
1639 LOG (GNUNET_ERROR_TYPE_WARNING,
1640 _("Failed to open UNIX listen socket\n"));
1641 plugin->session_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
1642 plugin->address_update_task = GNUNET_SCHEDULER_add_now (&address_notification, plugin);
1648 * Shutdown the plugin.
1650 * @param cls the plugin API returned from the initialization function
1651 * @return NULL (always)
1654 libgnunet_plugin_transport_unix_done (void *cls)
1656 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1657 struct Plugin *plugin = api->cls;
1658 struct UNIXMessageWrapper * msgw;
1659 struct UnixAddress *ua;
1668 len = sizeof (struct UnixAddress) + strlen (plugin->unix_socket_path) + 1;
1669 ua = GNUNET_malloc (len);
1670 ua->options = htonl (myoptions);
1671 ua->addrlen = htonl(strlen (plugin->unix_socket_path) + 1);
1672 memcpy (&ua[1], plugin->unix_socket_path, strlen (plugin->unix_socket_path) + 1);
1674 plugin->env->notify_address (plugin->env->cls, GNUNET_NO,
1677 while (NULL != (msgw = plugin->msg_head))
1679 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
1680 if (msgw->cont != NULL)
1681 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR,
1683 GNUNET_free (msgw->msg);
1687 if (GNUNET_SCHEDULER_NO_TASK != plugin->select_task)
1689 GNUNET_SCHEDULER_cancel (plugin->select_task);
1690 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
1692 if (GNUNET_SCHEDULER_NO_TASK != plugin->address_update_task)
1694 GNUNET_SCHEDULER_cancel (plugin->address_update_task);
1695 plugin->address_update_task = GNUNET_SCHEDULER_NO_TASK;
1697 if (NULL != plugin->unix_sock.desc)
1699 GNUNET_break (GNUNET_OK ==
1700 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
1701 plugin->unix_sock.desc = NULL;
1702 plugin->with_ws = GNUNET_NO;
1704 GNUNET_CONTAINER_multihashmap_iterate (plugin->session_map,
1705 &get_session_delete_it, plugin);
1706 GNUNET_CONTAINER_multihashmap_destroy (plugin->session_map);
1707 if (NULL != plugin->rs)
1708 GNUNET_NETWORK_fdset_destroy (plugin->rs);
1709 if (NULL != plugin->ws)
1710 GNUNET_NETWORK_fdset_destroy (plugin->ws);
1711 GNUNET_free (plugin->unix_socket_path);
1712 GNUNET_free (plugin);
1717 /* end of plugin_transport_unix.c */