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_util_lib.h"
31 #include "gnunet_hello_lib.h"
32 #include "gnunet_protocols.h"
33 #include "gnunet_statistics_service.h"
34 #include "gnunet_transport_service.h"
35 #include "gnunet_transport_plugin.h"
36 #include "transport.h"
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_MultiPeerMap *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);
353 * Function called for a quick conversion of the binary address to
354 * a numeric address. Note that the caller must not free the
355 * address and that the next call to this function is allowed
356 * to override the address again.
359 * @param addr binary address
360 * @param addrlen length of the address
361 * @return string representing the same address
364 unix_address_to_string (void *cls, const void *addr, size_t addrlen)
366 static char rbuf[1024];
367 struct UnixAddress *ua = (struct UnixAddress *) addr;
371 if ((NULL == addr) || (sizeof (struct UnixAddress) > addrlen))
376 addrstr = (char *) &ua[1];
377 addr_str_len = ntohl (ua->addrlen);
379 if (addr_str_len != addrlen - sizeof(struct UnixAddress))
385 if ('\0' != addrstr[addr_str_len - 1])
390 if (strlen (addrstr) + 1 != addr_str_len)
396 GNUNET_snprintf (rbuf, sizeof(rbuf), "%s.%u.%s", PLUGIN_NAME,
397 ntohl (ua->options), addrstr);
402 static struct sockaddr_un *
403 unix_address_to_sockaddr (const char *unixpath,
406 struct sockaddr_un *un;
409 GNUNET_assert (0 < strlen (unixpath)); /* sanity check */
410 un = GNUNET_new (struct sockaddr_un);
411 un->sun_family = AF_UNIX;
412 slen = strlen (unixpath);
413 if (slen >= sizeof (un->sun_path))
414 slen = sizeof (un->sun_path) - 1;
415 memcpy (un->sun_path, unixpath, slen);
416 un->sun_path[slen] = '\0';
417 slen = sizeof (struct sockaddr_un);
418 #if HAVE_SOCKADDR_IN_SIN_LEN
419 un->sun_len = (u_char) slen;
427 * Re-schedule the main 'select' callback (unix_plugin_select)
430 * @param plugin the plugin context
433 reschedule_select (struct Plugin * plugin)
435 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
437 GNUNET_SCHEDULER_cancel (plugin->select_task);
438 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
440 if (NULL != plugin->msg_head)
442 plugin->select_task =
443 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
444 GNUNET_TIME_UNIT_FOREVER_REL,
447 &unix_plugin_select, plugin);
448 plugin->with_ws = GNUNET_YES;
452 plugin->select_task =
453 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
454 GNUNET_TIME_UNIT_FOREVER_REL,
457 &unix_plugin_select, plugin);
458 plugin->with_ws = GNUNET_NO;
464 * Closure to #lookup_session_it.
469 * Location to store the session, if found.
474 * Address we are looking for.
476 const struct UnixAddress *ua;
479 * Number of bytes in @e ua
486 * Function called to find a session by address.
488 * @param cls the 'struct LookupCtx'
489 * @param key peer we are looking for (unused)
490 * @param value a session
491 * @return #GNUNET_YES if not found (continue looking), #GNUNET_NO on success
494 lookup_session_it (void *cls,
495 const struct GNUNET_PeerIdentity * key,
498 struct LookupCtx *lctx = cls;
499 struct Session *t = value;
501 if (t->addrlen != lctx->ua_len)
507 if (0 == memcmp (t->addr, lctx->ua, lctx->ua_len))
518 * Find an existing session by address.
520 * @param plugin the plugin
521 * @param sender for which peer should the session be?
522 * @param ua address to look for
523 * @param ua_len length of the address
524 * @return NULL if session was not found
526 static struct Session *
527 lookup_session (struct Plugin *plugin,
528 const struct GNUNET_PeerIdentity *sender,
529 const struct UnixAddress *ua, size_t ua_len)
531 struct LookupCtx lctx;
535 lctx.ua_len = ua_len;
536 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->session_map,
538 &lookup_session_it, &lctx);
544 * Functions with this signature are called whenever we need
545 * to close a session due to a disconnect or failure to
546 * establish a connection.
548 * @param cls closure with the `struct Plugin`
549 * @param s session to close down
550 * @return #GNUNET_OK on success
553 unix_session_disconnect (void *cls,
556 struct Plugin *plugin = cls;
557 struct UNIXMessageWrapper *msgw;
558 struct UNIXMessageWrapper *next;
561 LOG (GNUNET_ERROR_TYPE_DEBUG,
562 "Disconnecting session for peer `%s' `%s'\n",
563 GNUNET_i2s (&s->target),
565 plugin->env->session_end (plugin->env->cls, &s->target, s);
567 next = plugin->msg_head;
572 if (msgw->session != s)
574 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
575 if (NULL != msgw->cont)
576 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR,
578 GNUNET_free (msgw->msg);
580 removed = GNUNET_YES;
582 GNUNET_assert (GNUNET_YES ==
583 GNUNET_CONTAINER_multipeermap_remove (plugin->session_map,
586 GNUNET_STATISTICS_set (plugin->env->stats,
587 "# UNIX sessions active",
588 GNUNET_CONTAINER_multipeermap_size (plugin->session_map),
590 if ((GNUNET_YES == removed) && (NULL == plugin->msg_head))
591 reschedule_select (plugin);
592 if (GNUNET_SCHEDULER_NO_TASK != s->timeout_task)
594 GNUNET_SCHEDULER_cancel (s->timeout_task);
595 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
603 * Function that is called to get the keepalive factor.
604 * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
605 * calculate the interval between keepalive packets.
607 * @param cls closure with the `struct Plugin`
608 * @return keepalive factor
611 unix_query_keepalive_factor (void *cls)
618 * Actually send out the message, assume we've got the address and
619 * send_handle squared away!
622 * @param send_handle which handle to send message on
623 * @param target who should receive this message (ignored by UNIX)
624 * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
625 * @param msgbuf_size the size of the msgbuf to send
626 * @param priority how important is the message (ignored by UNIX)
627 * @param timeout when should we time out (give up) if we can not transmit?
628 * @param addr the addr to send the message to, needs to be a sockaddr for us
629 * @param addrlen the len of @a addr
630 * @param payload bytes payload to send
631 * @param cont continuation to call once the message has
632 * been transmitted (or if the transport is ready
633 * for the next transmission call; or if the
634 * peer disconnected...)
635 * @param cont_cls closure for @a cont
636 * @return on success the number of bytes written, RETRY for retry, -1 on errors
639 unix_real_send (void *cls,
640 struct GNUNET_NETWORK_Handle *send_handle,
641 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
642 size_t msgbuf_size, unsigned int priority,
643 struct GNUNET_TIME_Absolute timeout,
644 const struct UnixAddress *addr,
647 GNUNET_TRANSPORT_TransmitContinuation cont,
650 struct Plugin *plugin = cls;
652 struct sockaddr_un *un;
654 const char *unixpath;
656 GNUNET_assert (NULL != plugin);
657 if (NULL == send_handle)
659 GNUNET_break (0); /* We do not have a send handle */
660 return GNUNET_SYSERR;
662 if ((NULL == addr) || (0 == addrlen))
664 GNUNET_break (0); /* Can never send if we don't have an address */
665 return GNUNET_SYSERR;
668 /* Prepare address */
669 unixpath = (const char *) &addr[1];
670 if (NULL == (un = unix_address_to_sockaddr (unixpath, &un_len)))
678 sent = GNUNET_NETWORK_socket_sendto (send_handle, msgbuf, msgbuf_size,
679 (const struct sockaddr *) un, un_len);
680 if (GNUNET_SYSERR == sent)
682 if ( (EAGAIN == errno) ||
686 return RETRY; /* We have to retry later */
688 if (EMSGSIZE == errno)
691 socklen_t len = sizeof (size);
693 GNUNET_NETWORK_socket_getsockopt ((struct GNUNET_NETWORK_Handle *)
694 send_handle, SOL_SOCKET, SO_SNDBUF, &size,
696 if (size < msgbuf_size)
698 LOG (GNUNET_ERROR_TYPE_DEBUG,
699 "Trying to increase socket buffer size from %i to %i for message size %i\n",
700 size, ((msgbuf_size / 1000) + 2) * 1000, msgbuf_size);
701 size = ((msgbuf_size / 1000) + 2) * 1000;
702 if (GNUNET_OK == GNUNET_NETWORK_socket_setsockopt
703 ((struct GNUNET_NETWORK_Handle *) send_handle, SOL_SOCKET, SO_SNDBUF,
704 &size, sizeof (size)))
705 goto resend; /* Increased buffer size, retry sending */
708 /* Could not increase buffer size: error, no retry */
709 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
711 return GNUNET_SYSERR;
716 /* Buffer is bigger than message: error, no retry
717 * This should never happen!*/
720 return GNUNET_SYSERR;
725 LOG (GNUNET_ERROR_TYPE_DEBUG,
726 "UNIX transmit %u-byte message to %s (%d: %s)\n",
727 (unsigned int) msgbuf_size,
728 GNUNET_a2s ((const struct sockaddr *)un, un_len),
730 (sent < 0) ? STRERROR (errno) : "ok");
737 * Closure for 'get_session_it'.
739 struct GetSessionIteratorContext
742 * Location to store the session, if found.
747 * Address information.
752 * Number of bytes in @e address
759 * Function called to find a session by address.
761 * @param cls the 'struct LookupCtx'
762 * @param key peer we are looking for (unused)
763 * @param value a session
764 * @return #GNUNET_YES if not found (continue looking), #GNUNET_NO on success
767 get_session_it (void *cls,
768 const struct GNUNET_PeerIdentity *key,
771 struct GetSessionIteratorContext *gsi = cls;
772 struct Session *s = value;
774 if ((GNUNET_NO == s->inbound) && (gsi->addrlen == s->addrlen) &&
775 (0 == memcmp (gsi->address, s->addr, s->addrlen)) )
785 * Session was idle for too long, so disconnect it
787 * @param cls the 'struct Session' to disconnect
788 * @param tc scheduler context
791 session_timeout (void *cls,
792 const struct GNUNET_SCHEDULER_TaskContext *tc)
794 struct Session *s = cls;
796 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
797 LOG (GNUNET_ERROR_TYPE_DEBUG,
798 "Session %p was idle for %s, disconnecting\n",
800 GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
802 unix_session_disconnect (s->plugin, s);
807 * Function obtain the network type for a session
809 * @param cls closure ('struct Plugin*')
810 * @param session the session
811 * @return the network type in HBO or #GNUNET_SYSERR
813 static enum GNUNET_ATS_Network_Type
814 unix_get_network (void *cls,
815 struct Session *session)
817 GNUNET_assert (NULL != session);
818 return GNUNET_ATS_NET_LOOPBACK;
823 * Creates a new outbound session the transport service will use to send data to the
826 * @param cls the plugin
827 * @param address the address
828 * @return the session or NULL of max connections exceeded
830 static struct Session *
831 unix_plugin_get_session (void *cls,
832 const struct GNUNET_HELLO_Address *address)
834 struct Plugin *plugin = cls;
836 struct GetSessionIteratorContext gsi;
837 struct UnixAddress *ua;
839 uint32_t addr_str_len;
841 GNUNET_assert (NULL != plugin);
842 GNUNET_assert (NULL != address);
844 ua = (struct UnixAddress *) address->address;
845 if ((NULL == address->address) || (0 == address->address_length) ||
846 (sizeof (struct UnixAddress) > address->address_length))
851 addrstr = (char *) &ua[1];
852 addr_str_len = ntohl (ua->addrlen);
853 if (addr_str_len != address->address_length - sizeof (struct UnixAddress))
855 /* This can be a legacy address */
859 if ('\0' != addrstr[addr_str_len - 1])
864 if (strlen (addrstr) + 1 != addr_str_len)
870 /* Check if already existing */
871 gsi.address = (const char *) address->address;
872 gsi.addrlen = address->address_length;
874 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->session_map,
876 &get_session_it, &gsi);
879 LOG (GNUNET_ERROR_TYPE_DEBUG,
880 "Found existing session\n");
884 /* create a new session */
885 s = GNUNET_malloc (sizeof (struct Session) + address->address_length);
886 s->addr = (struct UnixAddress *) &s[1];
887 s->addrlen = address->address_length;
889 s->inbound = GNUNET_NO;
890 memcpy (s->addr, address->address, address->address_length);
891 memcpy (&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
892 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == s->timeout_task);
893 s->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
896 LOG (GNUNET_ERROR_TYPE_DEBUG,
897 "Creating a new session %p for address `%s'\n",
898 s, unix_address_to_string (NULL, address->address, address->address_length));
899 (void) GNUNET_CONTAINER_multipeermap_put (plugin->session_map,
901 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
902 GNUNET_STATISTICS_set (plugin->env->stats,
903 "# UNIX sessions active",
904 GNUNET_CONTAINER_multipeermap_size (plugin->session_map),
910 unix_plugin_update_session_timeout (void *cls,
911 const struct GNUNET_PeerIdentity *peer,
912 struct Session *session)
918 * Function that can be used by the transport service to transmit
919 * a message using the plugin. Note that in the case of a
920 * peer disconnecting, the continuation MUST be called
921 * prior to the disconnect notification itself. This function
922 * will be called with this peer's HELLO message to initiate
923 * a fresh connection to another peer.
926 * @param session which session must be used
927 * @param msgbuf the message to transmit
928 * @param msgbuf_size number of bytes in @a msgbuf
929 * @param priority how important is the message (most plugins will
930 * ignore message priority and just FIFO)
931 * @param to how long to wait at most for the transmission (does not
932 * require plugins to discard the message after the timeout,
933 * just advisory for the desired delay; most plugins will ignore
935 * @param cont continuation to call once the message has
936 * been transmitted (or if the transport is ready
937 * for the next transmission call; or if the
938 * peer disconnected...); can be NULL
939 * @param cont_cls closure for @a cont
940 * @return number of bytes used (on the physical network, with overheads);
941 * -1 on hard errors (i.e. address invalid); 0 is a legal value
942 * and does NOT mean that the message was not transmitted (DV)
945 unix_plugin_send (void *cls,
946 struct Session *session,
947 const char *msgbuf, size_t msgbuf_size,
948 unsigned int priority,
949 struct GNUNET_TIME_Relative to,
950 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
952 struct Plugin *plugin = cls;
953 struct UNIXMessageWrapper *wrapper;
954 struct UNIXMessage *message;
958 GNUNET_CONTAINER_multipeermap_contains_value (plugin->session_map,
962 LOG (GNUNET_ERROR_TYPE_ERROR,
963 "Invalid session for peer `%s' `%s'\n",
964 GNUNET_i2s (&session->target),
965 (const char *) session->addr);
967 return GNUNET_SYSERR;
969 LOG (GNUNET_ERROR_TYPE_DEBUG,
970 "Sending %u bytes with session for peer `%s' `%s'\n",
972 GNUNET_i2s (&session->target),
973 (const char *) session->addr);
974 ssize = sizeof (struct UNIXMessage) + msgbuf_size;
975 message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
976 message->header.size = htons (ssize);
977 message->header.type = htons (0);
978 memcpy (&message->sender, plugin->env->my_identity,
979 sizeof (struct GNUNET_PeerIdentity));
980 memcpy (&message[1], msgbuf, msgbuf_size);
981 reschedule_session_timeout (session);
982 wrapper = GNUNET_new (struct UNIXMessageWrapper);
983 wrapper->msg = message;
984 wrapper->msgsize = ssize;
985 wrapper->payload = msgbuf_size;
986 wrapper->priority = priority;
987 wrapper->timeout = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), to);
988 wrapper->cont = cont;
989 wrapper->cont_cls = cont_cls;
990 wrapper->session = session;
991 GNUNET_CONTAINER_DLL_insert (plugin->msg_head,
994 plugin->bytes_in_queue += ssize;
995 GNUNET_STATISTICS_set (plugin->env->stats,
996 "# bytes currently in UNIX buffers",
997 plugin->bytes_in_queue,
999 if (GNUNET_NO == plugin->with_ws)
1000 reschedule_select (plugin);
1006 * Demultiplexer for UNIX messages
1008 * @param plugin the main plugin for this transport
1009 * @param sender from which peer the message was received
1010 * @param currhdr pointer to the header of the message
1011 * @param ua address to look for
1012 * @param ua_len length of the address @a ua
1015 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
1016 const struct GNUNET_MessageHeader *currhdr,
1017 const struct UnixAddress *ua, size_t ua_len)
1019 struct Session *s = NULL;
1020 struct GNUNET_HELLO_Address * addr;
1022 GNUNET_break (ntohl(plugin->ats_network.value) != GNUNET_ATS_NET_UNSPECIFIED);
1023 GNUNET_assert (ua_len >= sizeof (struct UnixAddress));
1024 LOG (GNUNET_ERROR_TYPE_DEBUG,
1025 "Received message from %s\n",
1026 unix_address_to_string(NULL, ua, ua_len));
1027 GNUNET_STATISTICS_update (plugin->env->stats,
1028 "# bytes received via UNIX",
1029 ntohs (currhdr->size),
1032 addr = GNUNET_HELLO_address_allocate (sender,
1036 s = lookup_session (plugin, sender, ua, ua_len);
1039 s = unix_plugin_get_session (plugin, addr);
1040 s->inbound = GNUNET_YES;
1041 /* Notify transport and ATS about new inbound session */
1042 plugin->env->session_start (NULL, sender,
1043 PLUGIN_NAME, ua, ua_len, s, &plugin->ats_network, 1);
1045 reschedule_session_timeout (s);
1047 plugin->env->receive (plugin->env->cls, sender, currhdr, s,
1048 (GNUNET_YES == s->inbound) ? NULL : (const char *) ua,
1049 (GNUNET_YES == s->inbound) ? 0 : ua_len);
1051 plugin->env->update_address_metrics (plugin->env->cls, sender,
1052 (GNUNET_YES == s->inbound) ? NULL : (const char *) ua,
1053 (GNUNET_YES == s->inbound) ? 0 : ua_len,
1054 s, &plugin->ats_network, 1);
1061 * Read from UNIX domain socket (it is ready).
1063 * @param plugin the plugin
1066 unix_plugin_select_read (struct Plugin *plugin)
1068 char buf[65536] GNUNET_ALIGN;
1069 struct UnixAddress *ua;
1070 struct UNIXMessage *msg;
1071 struct GNUNET_PeerIdentity sender;
1072 struct sockaddr_un un;
1078 const struct GNUNET_MessageHeader *currhdr;
1082 addrlen = sizeof (un);
1083 memset (&un, 0, sizeof (un));
1086 GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc, buf, sizeof (buf),
1087 (struct sockaddr *) &un, &addrlen);
1089 if ((GNUNET_SYSERR == ret) && ((errno == EAGAIN) || (errno == ENOBUFS)))
1092 if (ret == GNUNET_SYSERR)
1094 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "recvfrom");
1099 LOG (GNUNET_ERROR_TYPE_DEBUG,
1100 "Read %d bytes from socket %s\n",
1105 GNUNET_assert (AF_UNIX == (un.sun_family));
1106 ua_len = sizeof (struct UnixAddress) + strlen (un.sun_path) + 1;
1107 ua = GNUNET_malloc (ua_len);
1108 ua->addrlen = htonl (strlen (&un.sun_path[0]) +1);
1109 ua->options = htonl (0);
1110 memcpy (&ua[1], &un.sun_path[0], strlen (un.sun_path) + 1);
1112 msg = (struct UNIXMessage *) buf;
1113 csize = ntohs (msg->header.size);
1114 if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
1116 GNUNET_break_op (0);
1120 msgbuf = (char *) &msg[1];
1121 memcpy (&sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
1123 tsize = csize - sizeof (struct UNIXMessage);
1124 while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
1126 currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
1127 csize = ntohs (currhdr->size);
1128 if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
1129 (csize > tsize - offset))
1131 GNUNET_break_op (0);
1134 unix_demultiplexer (plugin, &sender, currhdr, ua, ua_len);
1142 * Write to UNIX domain socket (it is ready).
1144 * @param plugin the plugin
1147 unix_plugin_select_write (struct Plugin *plugin)
1150 struct UNIXMessageWrapper * msgw;
1152 while (NULL != (msgw = plugin->msg_tail))
1154 if (GNUNET_TIME_absolute_get_remaining (msgw->timeout).rel_value_us > 0)
1155 break; /* Message is ready for sending */
1156 /* Message has a timeout */
1157 LOG (GNUNET_ERROR_TYPE_DEBUG,
1158 "Timeout for message with %u bytes \n",
1159 (unsigned int) msgw->msgsize);
1160 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
1161 plugin->bytes_in_queue -= msgw->msgsize;
1162 GNUNET_STATISTICS_set (plugin->env->stats,
1163 "# bytes currently in UNIX buffers",
1164 plugin->bytes_in_queue, GNUNET_NO);
1165 GNUNET_STATISTICS_update (plugin->env->stats,
1166 "# UNIX bytes discarded",
1169 if (NULL != msgw->cont)
1170 msgw->cont (msgw->cont_cls,
1171 &msgw->session->target,
1175 GNUNET_free (msgw->msg);
1179 return; /* Nothing to send at the moment */
1181 sent = unix_real_send (plugin,
1182 plugin->unix_sock.desc,
1183 &msgw->session->target,
1184 (const char *) msgw->msg,
1188 msgw->session->addr,
1189 msgw->session->addrlen,
1191 msgw->cont, msgw->cont_cls);
1195 GNUNET_STATISTICS_update (plugin->env->stats,
1196 "# UNIX retry attempts",
1200 if (GNUNET_SYSERR == sent)
1202 /* failed and no retry */
1203 if (NULL != msgw->cont)
1204 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR, msgw->payload, 0);
1206 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
1208 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
1209 plugin->bytes_in_queue -= msgw->msgsize;
1210 GNUNET_STATISTICS_set (plugin->env->stats,
1211 "# bytes currently in UNIX buffers",
1212 plugin->bytes_in_queue, GNUNET_NO);
1213 GNUNET_STATISTICS_update (plugin->env->stats,
1214 "# UNIX bytes discarded",
1218 GNUNET_free (msgw->msg);
1222 /* successfully sent bytes */
1223 GNUNET_break (sent > 0);
1224 GNUNET_CONTAINER_DLL_remove (plugin->msg_head,
1227 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
1228 plugin->bytes_in_queue -= msgw->msgsize;
1229 GNUNET_STATISTICS_set (plugin->env->stats,
1230 "# bytes currently in UNIX buffers",
1231 plugin->bytes_in_queue,
1233 GNUNET_STATISTICS_update (plugin->env->stats,
1234 "# bytes transmitted via UNIX",
1237 if (NULL != msgw->cont)
1238 msgw->cont (msgw->cont_cls, &msgw->session->target,
1242 GNUNET_free (msgw->msg);
1248 * We have been notified that our writeset has something to read. We don't
1249 * know which socket needs to be read, so we have to check each one
1250 * Then reschedule this function to be called again once more is available.
1252 * @param cls the plugin handle
1253 * @param tc the scheduling context (for rescheduling this function again)
1256 unix_plugin_select (void *cls,
1257 const struct GNUNET_SCHEDULER_TaskContext *tc)
1259 struct Plugin *plugin = cls;
1261 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
1262 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
1265 if ((tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY) != 0)
1267 /* Ready to send data */
1268 GNUNET_assert (GNUNET_NETWORK_fdset_isset
1269 (tc->write_ready, plugin->unix_sock.desc));
1270 if (NULL != plugin->msg_head)
1271 unix_plugin_select_write (plugin);
1274 if ((tc->reason & GNUNET_SCHEDULER_REASON_READ_READY) != 0)
1276 /* Ready to receive data */
1277 GNUNET_assert (GNUNET_NETWORK_fdset_isset
1278 (tc->read_ready, plugin->unix_sock.desc));
1279 unix_plugin_select_read (plugin);
1281 reschedule_select (plugin);
1286 * Create a slew of UNIX sockets. If possible, use IPv6 and IPv4.
1288 * @param cls closure for server start, should be a struct Plugin *
1289 * @return number of sockets created or #GNUNET_SYSERR on error
1292 unix_transport_server_start (void *cls)
1294 struct Plugin *plugin = cls;
1295 struct sockaddr_un *un;
1298 un = unix_address_to_sockaddr (plugin->unix_socket_path, &un_len);
1299 plugin->ats_network = plugin->env->get_address_type (plugin->env->cls, (const struct sockaddr *) un, un_len);
1300 plugin->unix_sock.desc =
1301 GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_DGRAM, 0);
1302 if (NULL == plugin->unix_sock.desc)
1304 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
1305 return GNUNET_SYSERR;
1308 GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, (const struct sockaddr *) un, un_len))
1310 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
1311 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
1312 plugin->unix_sock.desc = NULL;
1314 return GNUNET_SYSERR;
1316 LOG (GNUNET_ERROR_TYPE_DEBUG, "Bound to `%s'\n", plugin->unix_socket_path);
1317 plugin->rs = GNUNET_NETWORK_fdset_create ();
1318 plugin->ws = GNUNET_NETWORK_fdset_create ();
1319 GNUNET_NETWORK_fdset_zero (plugin->rs);
1320 GNUNET_NETWORK_fdset_zero (plugin->ws);
1321 GNUNET_NETWORK_fdset_set (plugin->rs, plugin->unix_sock.desc);
1322 GNUNET_NETWORK_fdset_set (plugin->ws, plugin->unix_sock.desc);
1324 reschedule_select (plugin);
1331 * Function that will be called to check if a binary address for this
1332 * plugin is well-formed and corresponds to an address for THIS peer
1333 * (as per our configuration). Naturally, if absolutely necessary,
1334 * plugins can be a bit conservative in their answer, but in general
1335 * plugins should make sure that the address does not redirect
1336 * traffic to a 3rd party that might try to man-in-the-middle our
1339 * @param cls closure, should be our handle to the Plugin
1340 * @param addr pointer to the address
1341 * @param addrlen length of addr
1342 * @return GNUNET_OK if this is a plausible address for this peer
1343 * and transport, GNUNET_SYSERR if not
1347 unix_check_address (void *cls, const void *addr, size_t addrlen)
1349 struct Plugin* plugin = cls;
1350 struct UnixAddress *ua = (struct UnixAddress *) addr;
1352 size_t addr_str_len;
1354 if ((NULL == addr) || (0 == addrlen) || (sizeof (struct UnixAddress) > addrlen))
1357 return GNUNET_SYSERR;
1359 addrstr = (char *) &ua[1];
1360 addr_str_len = ntohl (ua->addrlen);
1361 if ('\0' != addrstr[addr_str_len - 1])
1364 return GNUNET_SYSERR;
1366 if (strlen (addrstr) + 1 != addr_str_len)
1369 return GNUNET_SYSERR;
1372 if (0 == strcmp (plugin->unix_socket_path, addrstr))
1374 return GNUNET_SYSERR;
1379 * Convert the transports address to a nice, human-readable
1382 * @param cls closure
1383 * @param type name of the transport that generated the address
1384 * @param addr one of the addresses of the host, NULL for the last address
1385 * the specific address format depends on the transport
1386 * @param addrlen length of the @a addr
1387 * @param numeric should (IP) addresses be displayed in numeric form?
1388 * @param timeout after how long should we give up?
1389 * @param asc function to call on each string
1390 * @param asc_cls closure for @a asc
1393 unix_plugin_address_pretty_printer (void *cls, const char *type,
1394 const void *addr, size_t addrlen,
1396 struct GNUNET_TIME_Relative timeout,
1397 GNUNET_TRANSPORT_AddressStringCallback asc,
1400 if ((NULL != addr) && (addrlen > 0))
1402 asc (asc_cls, unix_address_to_string (NULL, addr, addrlen));
1404 else if (0 == addrlen)
1406 asc (asc_cls, TRANSPORT_SESSION_INBOUND_STRING);
1411 asc (asc_cls, "<invalid UNIX address>");
1413 asc (asc_cls, NULL);
1418 * Function called to convert a string address to
1421 * @param cls closure ('struct Plugin*')
1422 * @param addr string address
1423 * @param addrlen length of the @a addr (strlen(addr) + '\0')
1424 * @param buf location to store the buffer
1425 * If the function returns #GNUNET_SYSERR, its contents are undefined.
1426 * @param added length of created address
1427 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
1430 unix_string_to_address (void *cls,
1431 const char *addr, uint16_t addrlen,
1432 void **buf, size_t *added)
1434 struct UnixAddress *ua;
1441 /* Format unix.options.address */
1446 if ((NULL == addr) || (addrlen == 0))
1449 return GNUNET_SYSERR;
1451 if ('\0' != addr[addrlen - 1])
1454 return GNUNET_SYSERR;
1456 if (strlen (addr) != addrlen - 1)
1459 return GNUNET_SYSERR;
1461 plugin = GNUNET_strdup (addr);
1462 optionstr = strchr (plugin, '.');
1463 if (NULL == optionstr)
1466 GNUNET_free (plugin);
1467 return GNUNET_SYSERR;
1469 optionstr[0] = '\0';
1471 options = atol (optionstr);
1472 address = strchr (optionstr, '.');
1473 if (NULL == address)
1476 GNUNET_free (plugin);
1477 return GNUNET_SYSERR;
1481 if (0 != strcmp(plugin, PLUGIN_NAME))
1484 GNUNET_free (plugin);
1485 return GNUNET_SYSERR;
1488 ua_size = sizeof (struct UnixAddress) + strlen (address) + 1;
1489 ua = GNUNET_malloc (ua_size);
1490 ua->options = htonl (options);
1491 ua->addrlen = htonl (strlen (address) + 1);
1492 memcpy (&ua[1], address, strlen (address) + 1);
1493 GNUNET_free (plugin);
1502 * Notify transport service about address
1504 * @param cls the plugin
1508 address_notification (void *cls,
1509 const struct GNUNET_SCHEDULER_TaskContext *tc)
1511 struct Plugin *plugin = cls;
1513 struct UnixAddress *ua;
1515 len = sizeof (struct UnixAddress) + strlen (plugin->unix_socket_path) + 1;
1516 ua = GNUNET_malloc (len);
1517 ua->options = htonl (myoptions);
1518 ua->addrlen = htonl(strlen (plugin->unix_socket_path) + 1);
1519 memcpy (&ua[1], plugin->unix_socket_path, strlen (plugin->unix_socket_path) + 1);
1521 plugin->address_update_task = GNUNET_SCHEDULER_NO_TASK;
1522 plugin->env->notify_address (plugin->env->cls, GNUNET_YES,
1529 * Increment session timeout due to activity
1531 * @param s session for which the timeout should be moved
1534 reschedule_session_timeout (struct Session *s)
1536 GNUNET_assert (NULL != s);
1537 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != s->timeout_task);
1538 GNUNET_SCHEDULER_cancel (s->timeout_task);
1539 s->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1542 LOG (GNUNET_ERROR_TYPE_DEBUG,
1543 "Timeout rescheduled for session %p set to %s\n",
1545 GNUNET_STRINGS_relative_time_to_string (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1551 * Function called on sessions to disconnect
1553 * @param cls the plugin
1554 * @param key peer identity (unused)
1555 * @param value the 'struct Session' to disconnect
1556 * @return #GNUNET_YES (always, continue to iterate)
1559 get_session_delete_it (void *cls,
1560 const struct GNUNET_PeerIdentity *key,
1563 struct Plugin *plugin = cls;
1564 struct Session *s = value;
1566 unix_session_disconnect (plugin, s);
1572 * Disconnect from a remote node. Clean up session if we have one for this peer
1574 * @param cls closure for this call (should be handle to Plugin)
1575 * @param target the peeridentity of the peer to disconnect
1576 * @return #GNUNET_OK on success, #GNUNET_SYSERR if the operation failed
1579 unix_peer_disconnect (void *cls,
1580 const struct GNUNET_PeerIdentity *target)
1582 struct Plugin *plugin = cls;
1584 GNUNET_assert (plugin != NULL);
1585 GNUNET_CONTAINER_multipeermap_get_multiple (plugin->session_map,
1587 &get_session_delete_it, plugin);
1592 * The exported method. Initializes the plugin and returns a
1593 * struct with the callbacks.
1595 * @param cls the plugin's execution environment
1596 * @return NULL on error, plugin functions otherwise
1599 libgnunet_plugin_transport_unix_init (void *cls)
1601 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1602 unsigned long long port;
1603 struct GNUNET_TRANSPORT_PluginFunctions *api;
1604 struct Plugin *plugin;
1605 int sockets_created;
1607 if (NULL == env->receive)
1609 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1610 initialze the plugin or the API */
1611 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
1613 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1614 api->address_to_string = &unix_address_to_string;
1615 api->string_to_address = &unix_string_to_address;
1619 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
1621 port = UNIX_NAT_DEFAULT_PORT;
1622 plugin = GNUNET_new (struct Plugin);
1623 plugin->port = port;
1625 GNUNET_asprintf (&plugin->unix_socket_path,
1626 "/tmp/unix-plugin-sock.%d",
1629 /* Initialize my flags */
1632 api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
1635 api->get_session = &unix_plugin_get_session;
1636 api->send = &unix_plugin_send;
1637 api->disconnect_peer = &unix_peer_disconnect;
1638 api->disconnect_session = &unix_session_disconnect;
1639 api->query_keepalive_factor = &unix_query_keepalive_factor;
1640 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1641 api->address_to_string = &unix_address_to_string;
1642 api->check_address = &unix_check_address;
1643 api->string_to_address = &unix_string_to_address;
1644 api->get_network = &unix_get_network;
1645 api->update_session_timeout = &unix_plugin_update_session_timeout;
1646 sockets_created = unix_transport_server_start (plugin);
1647 if (0 == sockets_created)
1648 LOG (GNUNET_ERROR_TYPE_WARNING,
1649 _("Failed to open UNIX listen socket\n"));
1650 plugin->session_map = GNUNET_CONTAINER_multipeermap_create (10, GNUNET_NO);
1651 plugin->address_update_task = GNUNET_SCHEDULER_add_now (&address_notification, plugin);
1657 * Shutdown the plugin.
1659 * @param cls the plugin API returned from the initialization function
1660 * @return NULL (always)
1663 libgnunet_plugin_transport_unix_done (void *cls)
1665 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1666 struct Plugin *plugin = api->cls;
1667 struct UNIXMessageWrapper * msgw;
1668 struct UnixAddress *ua;
1677 len = sizeof (struct UnixAddress) + strlen (plugin->unix_socket_path) + 1;
1678 ua = GNUNET_malloc (len);
1679 ua->options = htonl (myoptions);
1680 ua->addrlen = htonl(strlen (plugin->unix_socket_path) + 1);
1681 memcpy (&ua[1], plugin->unix_socket_path, strlen (plugin->unix_socket_path) + 1);
1683 plugin->env->notify_address (plugin->env->cls, GNUNET_NO,
1686 while (NULL != (msgw = plugin->msg_head))
1688 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
1689 if (msgw->cont != NULL)
1690 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR,
1692 GNUNET_free (msgw->msg);
1696 if (GNUNET_SCHEDULER_NO_TASK != plugin->select_task)
1698 GNUNET_SCHEDULER_cancel (plugin->select_task);
1699 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
1701 if (GNUNET_SCHEDULER_NO_TASK != plugin->address_update_task)
1703 GNUNET_SCHEDULER_cancel (plugin->address_update_task);
1704 plugin->address_update_task = GNUNET_SCHEDULER_NO_TASK;
1706 if (NULL != plugin->unix_sock.desc)
1708 GNUNET_break (GNUNET_OK ==
1709 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
1710 plugin->unix_sock.desc = NULL;
1711 plugin->with_ws = GNUNET_NO;
1713 GNUNET_CONTAINER_multipeermap_iterate (plugin->session_map,
1714 &get_session_delete_it, plugin);
1715 GNUNET_CONTAINER_multipeermap_destroy (plugin->session_map);
1716 if (NULL != plugin->rs)
1717 GNUNET_NETWORK_fdset_destroy (plugin->rs);
1718 if (NULL != plugin->ws)
1719 GNUNET_NETWORK_fdset_destroy (plugin->ws);
1720 GNUNET_free (plugin->unix_socket_path);
1721 GNUNET_free (plugin);
1726 /* end of plugin_transport_unix.c */