2 This file is part of GNUnet
3 (C) 2010 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
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"
49 #define LOG(kind,...) GNUNET_log_from (kind, "transport-unix",__VA_ARGS__)
52 * Transport cost to peer, always 1 for UNIX (direct connection)
54 #define UNIX_DIRECT_DISTANCE 1
56 #define DEFAULT_NAT_PORT 0
59 * How long until we give up on transmitting the welcome message?
61 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
64 * Starting port for listening and sending, eventually a config value
66 #define UNIX_NAT_DEFAULT_PORT 22086
68 GNUNET_NETWORK_STRUCT_BEGIN
71 * UNIX Message-Packet header.
78 struct GNUNET_MessageHeader header;
81 * What is the identity of the sender (GNUNET_hash of public key)
83 struct GNUNET_PeerIdentity sender;
89 struct GNUNET_PeerIdentity target;
95 * Session timeout task
97 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
99 struct Plugin * plugin;
102 struct UNIXMessageWrapper
104 struct UNIXMessageWrapper *next;
105 struct UNIXMessageWrapper *prev;
107 struct UNIXMessage * msg;
111 struct GNUNET_TIME_Absolute timeout;
112 unsigned int priority;
114 struct Session *session;
115 GNUNET_TRANSPORT_TransmitContinuation cont;
119 /* Forward definition */
130 * Stored in a linked list.
132 struct PeerSession *next;
135 * Pointer to the global plugin struct.
137 struct Plugin *plugin;
140 * To whom are we talking to (set to our identity
141 * if we are still waiting for the welcome message)
143 struct GNUNET_PeerIdentity target;
146 * Address of the other peer (either based on our 'connect'
147 * call or on our 'accept' call).
152 * Length of connect_addr.
157 * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
159 int expecting_welcome;
162 * From which socket do we need to send to this peer?
164 struct GNUNET_NETWORK_Handle *sock;
167 * Queue of messages for this peer, in the case that
168 * we have to await a connection...
170 struct MessageQueue *messages;
175 * Information we keep for each of our listen sockets.
177 struct UNIX_Sock_Info
182 struct GNUNET_NETWORK_Handle *desc;
185 * The port we bound to
192 * Encapsulation of all of the state of the plugin.
199 struct GNUNET_TRANSPORT_PluginEnvironment *env;
204 struct GNUNET_CONTAINER_MultiHashMap *session_map;
207 * ID of task used to update our addresses when one expires.
209 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
214 GNUNET_SCHEDULER_TaskIdentifier select_task;
217 * Integer to append to unix domain socket.
224 struct GNUNET_NETWORK_FDSet *rs;
229 struct GNUNET_NETWORK_FDSet *ws;
234 * socket that we transmit all data with
236 struct UNIX_Sock_Info unix_sock;
239 * Path of our unix domain socket (/tmp/unix-plugin-PORT)
241 char *unix_socket_path;
243 struct UNIXMessageWrapper *msg_head;
244 struct UNIXMessageWrapper *msg_tail;
249 struct GNUNET_ATS_Information ats_network;
251 unsigned int bytes_in_queue;
252 unsigned int bytes_in_sent;
253 unsigned int bytes_in_recv;
254 unsigned int bytes_discarded;
258 * Start session timeout
261 start_session_timeout (struct Session *s);
264 * Increment session timeout due to activity
267 reschedule_session_timeout (struct Session *s);
273 stop_session_timeout (struct Session *s);
277 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
281 reschedule_select (struct Plugin * plugin)
284 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
286 GNUNET_SCHEDULER_cancel (plugin->select_task);
287 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
290 if (NULL != plugin->msg_head)
292 plugin->select_task =
293 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
294 GNUNET_TIME_UNIT_FOREVER_REL,
297 &unix_plugin_select, plugin);
298 plugin->with_ws = GNUNET_YES;
302 plugin->select_task =
303 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
304 GNUNET_TIME_UNIT_FOREVER_REL,
307 &unix_plugin_select, plugin);
308 plugin->with_ws = GNUNET_NO;
315 const struct sockaddr_un *addr;
318 int lookup_session_it (void *cls,
319 const struct GNUNET_HashCode * key,
322 struct LookupCtx *lctx = cls;
323 struct Session *t = value;
325 if (0 == strcmp (t->addr, lctx->addr->sun_path))
334 static struct Session *
335 lookup_session (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender, const struct sockaddr_un *addr)
337 struct LookupCtx lctx;
339 GNUNET_assert (NULL != plugin);
340 GNUNET_assert (NULL != sender);
341 GNUNET_assert (NULL != addr);
346 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &sender->hashPubKey, &lookup_session_it, &lctx);
352 * Functions with this signature are called whenever we need
353 * to close a session due to a disconnect or failure to
354 * establish a connection.
356 * @param s session to close down
359 disconnect_session (struct Session *s)
361 struct UNIXMessageWrapper *msgw;
362 struct UNIXMessageWrapper *next;
363 struct Plugin * plugin = s->plugin;
365 GNUNET_assert (plugin != NULL);
366 GNUNET_assert (s != NULL);
368 LOG (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting session for peer `%s' `%s' \n", GNUNET_i2s (&s->target), s->addr);
369 stop_session_timeout (s);
370 plugin->env->session_end (plugin->env->cls, &s->target, s);
372 msgw = plugin->msg_head;
374 next = plugin->msg_head;
379 if (msgw->session != s)
381 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
382 if (NULL != msgw->cont)
383 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR,
385 GNUNET_free (msgw->msg);
387 removed = GNUNET_YES;
389 if ((GNUNET_YES == removed) && (NULL == plugin->msg_head))
390 reschedule_select (plugin);
392 GNUNET_assert (GNUNET_YES ==
393 GNUNET_CONTAINER_multihashmap_remove(plugin->session_map, &s->target.hashPubKey, s));
395 GNUNET_STATISTICS_set(plugin->env->stats,
396 "# UNIX sessions active",
397 GNUNET_CONTAINER_multihashmap_size(plugin->session_map),
404 get_session_delete_it (void *cls, const struct GNUNET_HashCode * key, void *value)
406 struct Session *s = value;
407 disconnect_session (s);
413 * Disconnect from a remote node. Clean up session if we have one for this peer
415 * @param cls closure for this call (should be handle to Plugin)
416 * @param target the peeridentity of the peer to disconnect
417 * @return GNUNET_OK on success, GNUNET_SYSERR if the operation failed
420 unix_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
422 struct Plugin *plugin = cls;
423 GNUNET_assert (plugin != NULL);
425 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &target->hashPubKey, &get_session_delete_it, plugin);
430 * Shutdown the server process (stop receiving inbound traffic). Maybe
433 * @param cls Handle to the plugin for this transport
435 * @return returns the number of sockets successfully closed,
436 * should equal the number of sockets successfully opened
439 unix_transport_server_stop (void *cls)
441 struct Plugin *plugin = cls;
442 struct UNIXMessageWrapper * msgw;
444 while (NULL != (msgw = plugin->msg_head))
446 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
447 if (msgw->cont != NULL)
448 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR,
450 GNUNET_free (msgw->msg);
454 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
456 GNUNET_SCHEDULER_cancel (plugin->select_task);
457 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
460 if (NULL != plugin->unix_sock.desc)
462 GNUNET_break (GNUNET_OK ==
463 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
464 plugin->unix_sock.desc = NULL;
465 plugin->with_ws = GNUNET_NO;
472 * Actually send out the message, assume we've got the address and
473 * send_handle squared away!
476 * @param send_handle which handle to send message on
477 * @param target who should receive this message (ignored by UNIX)
478 * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
479 * @param msgbuf_size the size of the msgbuf to send
480 * @param priority how important is the message (ignored by UNIX)
481 * @param timeout when should we time out (give up) if we can not transmit?
482 * @param addr the addr to send the message to, needs to be a sockaddr for us
483 * @param addrlen the len of addr
484 * @param payload bytes payload to send
485 * @param cont continuation to call once the message has
486 * been transmitted (or if the transport is ready
487 * for the next transmission call; or if the
488 * peer disconnected...)
489 * @param cont_cls closure for cont
491 * @return on success : the number of bytes written, 0 n retry, -1 on errors
494 unix_real_send (void *cls,
495 struct GNUNET_NETWORK_Handle *send_handle,
496 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
497 size_t msgbuf_size, unsigned int priority,
498 struct GNUNET_TIME_Absolute timeout,
502 GNUNET_TRANSPORT_TransmitContinuation cont,
505 struct Plugin *plugin = cls;
509 struct sockaddr_un un;
512 GNUNET_assert (NULL != plugin);
514 if (send_handle == NULL)
516 GNUNET_break (0); /* We do not have a send handle */
517 return GNUNET_SYSERR;
519 if ((addr == NULL) || (addrlen == 0))
521 GNUNET_break (0); /* Can never send if we don't have an address */
522 return GNUNET_SYSERR;
525 /* Prepare address */
526 memset (&un, 0, sizeof (un));
527 un.sun_family = AF_UNIX;
528 slen = strlen (addr) + 1;
529 if (slen >= sizeof (un.sun_path))
530 slen = sizeof (un.sun_path) - 1;
531 GNUNET_assert (slen < sizeof (un.sun_path));
532 memcpy (un.sun_path, addr, slen);
533 un.sun_path[slen] = '\0';
534 slen = sizeof (struct sockaddr_un);
536 un.sun_path[0] = '\0';
538 #if HAVE_SOCKADDR_IN_SIN_LEN
539 un.sun_len = (u_char) slen;
541 sb = (struct sockaddr *) &un;
547 sent = GNUNET_NETWORK_socket_sendto (send_handle, msgbuf, msgbuf_size, sb, sbs);
549 if (GNUNET_SYSERR == sent)
553 return RETRY; /* We have to retry later */
555 if (errno == ENOBUFS)
557 return RETRY; /* We have to retry later */
559 if (errno == EMSGSIZE)
562 socklen_t len = sizeof (size);
564 GNUNET_NETWORK_socket_getsockopt ((struct GNUNET_NETWORK_Handle *)
565 send_handle, SOL_SOCKET, SO_SNDBUF, &size,
567 if (size < msgbuf_size)
569 LOG (GNUNET_ERROR_TYPE_DEBUG,
570 "Trying to increase socket buffer size from %i to %i for message size %i\n",
571 size, ((msgbuf_size / 1000) + 2) * 1000, msgbuf_size);
572 size = ((msgbuf_size / 1000) + 2) * 1000;
573 if (GNUNET_OK == GNUNET_NETWORK_socket_setsockopt
574 ((struct GNUNET_NETWORK_Handle *) send_handle, SOL_SOCKET, SO_SNDBUF,
575 &size, sizeof (size)))
576 goto resend; /* Increased buffer size, retry sending */
579 /* Could not increase buffer size: error, no retry */
580 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
581 return GNUNET_SYSERR;
586 /* Buffer is bigger than message: error, no retry
587 * This should never happen!*/
589 return GNUNET_SYSERR;
594 LOG (GNUNET_ERROR_TYPE_DEBUG,
595 "UNIX transmit %u-byte message to %s (%d: %s)\n",
596 (unsigned int) msgbuf_size, GNUNET_a2s (sb, sbs), (int) sent,
597 (sent < 0) ? STRERROR (errno) : "ok");
610 get_session_it (void *cls, const struct GNUNET_HashCode * key, void *value)
612 struct gsi_ctx *gsi = cls;
613 struct Session *s = value;
615 LOG (GNUNET_ERROR_TYPE_DEBUG, "Comparing session %s %s\n", gsi->address, s->addr);
616 if ((gsi->addrlen == s->addrlen) &&
617 (0 == memcmp (gsi->address, s->addr, s->addrlen)))
626 * Creates a new outbound session the transport service will use to send data to the
629 * @param cls the plugin
630 * @param address the address
631 * @return the session or NULL of max connections exceeded
633 static struct Session *
634 unix_plugin_get_session (void *cls,
635 const struct GNUNET_HELLO_Address *address)
637 struct Session * s = NULL;
638 struct Plugin *plugin = cls;
642 GNUNET_assert (plugin != NULL);
643 GNUNET_assert (address != NULL);
645 /* Check if already existing */
646 gsi.address = (char *) address->address;
647 gsi.addrlen = address->address_length;
649 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &address->peer.hashPubKey, &get_session_it, &gsi);
652 LOG (GNUNET_ERROR_TYPE_DEBUG, "Found existing session\n");
656 /* Create a new session */
657 s = GNUNET_malloc (sizeof (struct Session) + address->address_length);
659 s->addrlen = address->address_length;
661 memcpy(s->addr, address->address, s->addrlen);
662 memcpy(&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
664 start_session_timeout (s);
666 GNUNET_CONTAINER_multihashmap_put (plugin->session_map,
667 &address->peer.hashPubKey, s,
668 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
670 GNUNET_STATISTICS_set(plugin->env->stats,
671 "# UNIX sessions active",
672 GNUNET_CONTAINER_multihashmap_size(plugin->session_map),
674 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new session\n");
679 * @param cls the plugin handle
680 * @param tc the scheduling context (for rescheduling this function again)
682 * We have been notified that our writeset has something to read. We don't
683 * know which socket needs to be read, so we have to check each one
684 * Then reschedule this function to be called again once more is available.
688 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
691 * Function that can be used by the transport service to transmit
692 * a message using the plugin. Note that in the case of a
693 * peer disconnecting, the continuation MUST be called
694 * prior to the disconnect notification itself. This function
695 * will be called with this peer's HELLO message to initiate
696 * a fresh connection to another peer.
699 * @param session which session must be used
700 * @param msgbuf the message to transmit
701 * @param msgbuf_size number of bytes in 'msgbuf'
702 * @param priority how important is the message (most plugins will
703 * ignore message priority and just FIFO)
704 * @param to how long to wait at most for the transmission (does not
705 * require plugins to discard the message after the timeout,
706 * just advisory for the desired delay; most plugins will ignore
708 * @param cont continuation to call once the message has
709 * been transmitted (or if the transport is ready
710 * for the next transmission call; or if the
711 * peer disconnected...); can be NULL
712 * @param cont_cls closure for cont
713 * @return number of bytes used (on the physical network, with overheads);
714 * -1 on hard errors (i.e. address invalid); 0 is a legal value
715 * and does NOT mean that the message was not transmitted (DV)
718 unix_plugin_send (void *cls,
719 struct Session *session,
720 const char *msgbuf, size_t msgbuf_size,
721 unsigned int priority,
722 struct GNUNET_TIME_Relative to,
723 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
725 struct Plugin *plugin = cls;
726 struct UNIXMessageWrapper *wrapper;
727 struct UNIXMessage *message;
730 GNUNET_assert (plugin != NULL);
731 GNUNET_assert (session != NULL);
733 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_contains_value(plugin->session_map,
734 &session->target.hashPubKey, session))
736 LOG (GNUNET_ERROR_TYPE_ERROR, "Invalid session for peer `%s' `%s'\n",
737 GNUNET_i2s (&session->target),
738 (char *) session->addr);
741 return GNUNET_SYSERR;
743 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending %u bytes with session for peer `%s' `%s'\n",
745 GNUNET_i2s (&session->target),
746 (char *) session->addr);
748 ssize = sizeof (struct UNIXMessage) + msgbuf_size;
749 message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
750 message->header.size = htons (ssize);
751 message->header.type = htons (0);
752 memcpy (&message->sender, plugin->env->my_identity,
753 sizeof (struct GNUNET_PeerIdentity));
754 memcpy (&message[1], msgbuf, msgbuf_size);
756 reschedule_session_timeout (session);
758 wrapper = GNUNET_malloc (sizeof (struct UNIXMessageWrapper));
759 wrapper->msg = message;
760 wrapper->msgsize = ssize;
761 wrapper->payload = msgbuf_size;
762 wrapper->priority = priority;
763 wrapper->timeout = GNUNET_TIME_absolute_add (GNUNET_TIME_absolute_get(), to);
764 wrapper->cont = cont;
765 wrapper->cont_cls = cont_cls;
766 wrapper->session = session;
768 GNUNET_CONTAINER_DLL_insert(plugin->msg_head, plugin->msg_tail, wrapper);
770 plugin->bytes_in_queue += ssize;
771 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes currently in UNIX buffers",
772 plugin->bytes_in_queue, GNUNET_NO);
774 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sent %d bytes to `%s'\n", ssize,
775 (char *) session->addr);
776 if (plugin->with_ws == GNUNET_NO)
778 reschedule_select (plugin);
786 * Demultiplexer for UNIX messages
788 * @param plugin the main plugin for this transport
789 * @param sender from which peer the message was received
790 * @param currhdr pointer to the header of the message
791 * @param un the address from which the message was received
792 * @param fromlen the length of the address
795 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
796 const struct GNUNET_MessageHeader *currhdr,
797 const struct sockaddr_un *un, size_t fromlen)
799 struct GNUNET_ATS_Information ats[2];
800 struct Session *s = NULL;
801 struct GNUNET_HELLO_Address * addr;
803 ats[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
804 ats[0].value = htonl (UNIX_DIRECT_DISTANCE);
805 ats[1] = plugin->ats_network;
806 GNUNET_break (ntohl(plugin->ats_network.value) != GNUNET_ATS_NET_UNSPECIFIED);
808 GNUNET_assert (fromlen >= sizeof (struct sockaddr_un));
810 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received message from %s\n",
815 plugin->bytes_in_recv += ntohs(currhdr->size);
816 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes received via UNIX",
817 plugin->bytes_in_recv, GNUNET_NO);
819 addr = GNUNET_HELLO_address_allocate(sender, "unix", un->sun_path, strlen (un->sun_path) + 1);
820 s = lookup_session (plugin, sender, un);
822 s = unix_plugin_get_session (plugin, addr);
823 reschedule_session_timeout (s);
825 plugin->env->receive (plugin->env->cls, sender, currhdr,
826 (const struct GNUNET_ATS_Information *) &ats, 2,
827 s, un->sun_path, strlen (un->sun_path) + 1);
833 unix_plugin_select_read (struct Plugin * plugin)
835 char buf[65536] GNUNET_ALIGN;
836 struct UNIXMessage *msg;
837 struct GNUNET_PeerIdentity sender;
838 struct sockaddr_un un;
844 const struct GNUNET_MessageHeader *currhdr;
847 addrlen = sizeof (un);
848 memset (&un, 0, sizeof (un));
851 GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc, buf, sizeof (buf),
852 (struct sockaddr *) &un, &addrlen);
854 if ((GNUNET_SYSERR == ret) && ((errno == EAGAIN) || (errno == ENOBUFS)))
857 if (ret == GNUNET_SYSERR)
859 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "recvfrom");
865 un.sun_path[0] = '/';
867 LOG (GNUNET_ERROR_TYPE_DEBUG, "Read %d bytes from socket %s\n", ret,
871 GNUNET_assert (AF_UNIX == (un.sun_family));
873 msg = (struct UNIXMessage *) buf;
874 csize = ntohs (msg->header.size);
875 if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
880 msgbuf = (char *) &msg[1];
881 memcpy (&sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
883 tsize = csize - sizeof (struct UNIXMessage);
884 while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
886 currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
887 csize = ntohs (currhdr->size);
888 if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
889 (csize > tsize - offset))
895 unix_demultiplexer (plugin, &sender, currhdr, &un, sizeof (un));
902 unix_plugin_select_write (struct Plugin * plugin)
906 struct UNIXMessageWrapper * msgw = plugin->msg_tail;
909 if (GNUNET_TIME_absolute_get_remaining (msgw->timeout).rel_value > 0)
910 break; /* Message is ready for sending */
913 /* Message has a timeout */
914 LOG (GNUNET_ERROR_TYPE_DEBUG,
915 "Timeout for message with %llu bytes \n", msgw->msgsize);
916 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
917 if (NULL != msgw->cont)
918 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR, msgw->payload, 0);
920 plugin->bytes_in_queue -= msgw->msgsize;
921 GNUNET_STATISTICS_set (plugin->env->stats, "# bytes currently in UNIX buffers",
922 plugin->bytes_in_queue, GNUNET_NO);
924 plugin->bytes_discarded += msgw->msgsize;
925 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes discarded",
926 plugin->bytes_discarded, GNUNET_NO);
928 GNUNET_free (msgw->msg);
931 msgw = plugin->msg_tail;
934 return; /* Nothing to send at the moment */
936 sent = unix_real_send (plugin,
937 plugin->unix_sock.desc,
938 &msgw->session->target,
939 (const char *) msgw->msg,
944 msgw->session->addrlen,
946 msgw->cont, msgw->cont_cls);
950 GNUNET_STATISTICS_update (plugin->env->stats,"# UNIX retry attempts",
954 else if (GNUNET_SYSERR == sent)
956 /* failed and no retry */
957 if (NULL != msgw->cont)
958 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR, msgw->payload, 0);
960 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
962 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
963 plugin->bytes_in_queue -= msgw->msgsize;
964 GNUNET_STATISTICS_set (plugin->env->stats, "# bytes currently in UNIX buffers",
965 plugin->bytes_in_queue, GNUNET_NO);
966 plugin->bytes_discarded += msgw->msgsize;
967 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes discarded",
968 plugin->bytes_discarded, GNUNET_NO);
970 GNUNET_free (msgw->msg);
976 /* successfully sent bytes */
977 if (NULL != msgw->cont)
978 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_OK, msgw->payload, msgw->msgsize);
980 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
982 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
983 plugin->bytes_in_queue -= msgw->msgsize;
984 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes currently in UNIX buffers",
985 plugin->bytes_in_queue, GNUNET_NO);
986 plugin->bytes_in_sent += msgw->msgsize;
987 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes transmitted via UNIX",
988 plugin->bytes_in_sent, GNUNET_NO);
990 GNUNET_free (msgw->msg);
998 * We have been notified that our writeset has something to read. We don't
999 * know which socket needs to be read, so we have to check each one
1000 * Then reschedule this function to be called again once more is available.
1002 * @param cls the plugin handle
1003 * @param tc the scheduling context (for rescheduling this function again)
1006 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1008 struct Plugin *plugin = cls;
1010 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
1011 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
1014 if ((tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY) != 0)
1016 /* Ready to send data */
1017 GNUNET_assert (GNUNET_NETWORK_fdset_isset
1018 (tc->write_ready, plugin->unix_sock.desc));
1019 if (plugin->msg_head != NULL)
1020 unix_plugin_select_write (plugin);
1023 if ((tc->reason & GNUNET_SCHEDULER_REASON_READ_READY) != 0)
1025 /* Ready to receive data */
1026 GNUNET_assert (GNUNET_NETWORK_fdset_isset
1027 (tc->read_ready, plugin->unix_sock.desc));
1028 unix_plugin_select_read (plugin);
1031 reschedule_select (plugin);
1036 * Create a slew of UNIX sockets. If possible, use IPv6 and IPv4.
1038 * @param cls closure for server start, should be a struct Plugin *
1039 * @return number of sockets created or GNUNET_SYSERR on error
1042 unix_transport_server_start (void *cls)
1044 struct Plugin *plugin = cls;
1045 struct sockaddr *serverAddr;
1047 struct sockaddr_un un;
1050 memset (&un, 0, sizeof (un));
1051 un.sun_family = AF_UNIX;
1052 slen = strlen (plugin->unix_socket_path) + 1;
1053 if (slen >= sizeof (un.sun_path))
1054 slen = sizeof (un.sun_path) - 1;
1056 memcpy (un.sun_path, plugin->unix_socket_path, slen);
1057 un.sun_path[slen] = '\0';
1058 slen = sizeof (struct sockaddr_un);
1059 #if HAVE_SOCKADDR_IN_SIN_LEN
1060 un.sun_len = (u_char) slen;
1063 serverAddr = (struct sockaddr *) &un;
1066 un.sun_path[0] = '\0';
1068 plugin->ats_network = plugin->env->get_address_type (plugin->env->cls, serverAddr, addrlen);
1069 plugin->unix_sock.desc =
1070 GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_DGRAM, 0);
1071 if (NULL == plugin->unix_sock.desc)
1073 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
1074 return GNUNET_SYSERR;
1076 if (GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, serverAddr, addrlen)
1079 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
1080 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
1081 plugin->unix_sock.desc = NULL;
1082 return GNUNET_SYSERR;
1084 LOG (GNUNET_ERROR_TYPE_DEBUG, "Bound to `%s'\n", plugin->unix_socket_path);
1085 plugin->rs = GNUNET_NETWORK_fdset_create ();
1086 plugin->ws = GNUNET_NETWORK_fdset_create ();
1087 GNUNET_NETWORK_fdset_zero (plugin->rs);
1088 GNUNET_NETWORK_fdset_zero (plugin->ws);
1089 GNUNET_NETWORK_fdset_set (plugin->rs, plugin->unix_sock.desc);
1090 GNUNET_NETWORK_fdset_set (plugin->ws, plugin->unix_sock.desc);
1092 reschedule_select (plugin);
1099 * Function that will be called to check if a binary address for this
1100 * plugin is well-formed and corresponds to an address for THIS peer
1101 * (as per our configuration). Naturally, if absolutely necessary,
1102 * plugins can be a bit conservative in their answer, but in general
1103 * plugins should make sure that the address does not redirect
1104 * traffic to a 3rd party that might try to man-in-the-middle our
1107 * @param cls closure, should be our handle to the Plugin
1108 * @param addr pointer to the address
1109 * @param addrlen length of addr
1110 * @return GNUNET_OK if this is a plausible address for this peer
1111 * and transport, GNUNET_SYSERR if not
1115 unix_check_address (void *cls, const void *addr, size_t addrlen)
1117 LOG (GNUNET_ERROR_TYPE_DEBUG,
1118 "Informing transport service about my address `%s'\n",
1125 * Convert the transports address to a nice, human-readable
1128 * @param cls closure
1129 * @param type name of the transport that generated the address
1130 * @param addr one of the addresses of the host, NULL for the last address
1131 * the specific address format depends on the transport
1132 * @param addrlen length of the address
1133 * @param numeric should (IP) addresses be displayed in numeric form?
1134 * @param timeout after how long should we give up?
1135 * @param asc function to call on each string
1136 * @param asc_cls closure for asc
1139 unix_plugin_address_pretty_printer (void *cls, const char *type,
1140 const void *addr, size_t addrlen,
1142 struct GNUNET_TIME_Relative timeout,
1143 GNUNET_TRANSPORT_AddressStringCallback asc,
1146 if ((NULL != addr) && (addrlen > 0))
1148 asc (asc_cls, (const char *) addr);
1153 asc (asc_cls, "<invalid UNIX address>");
1155 asc (asc_cls, NULL);
1160 * Function called to convert a string address to
1163 * @param cls closure ('struct Plugin*')
1164 * @param addr string address
1165 * @param addrlen length of the address (strlen(addr) + '\0')
1166 * @param buf location to store the buffer
1167 * If the function returns GNUNET_SYSERR, its contents are undefined.
1168 * @param added length of created address
1169 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
1172 unix_string_to_address (void *cls, const char *addr, uint16_t addrlen,
1173 void **buf, size_t *added)
1175 if ((NULL == addr) || (0 == addrlen))
1178 return GNUNET_SYSERR;
1181 if ('\0' != addr[addrlen - 1])
1184 return GNUNET_SYSERR;
1187 if (strlen (addr) != addrlen - 1)
1190 return GNUNET_SYSERR;
1193 (*buf) = strdup (addr);
1194 (*added) = strlen (addr) + 1;
1200 * Function called for a quick conversion of the binary address to
1201 * a numeric address. Note that the caller must not free the
1202 * address and that the next call to this function is allowed
1203 * to override the address again.
1205 * @param cls closure
1206 * @param addr binary address
1207 * @param addrlen length of the address
1208 * @return string representing the same address
1211 unix_address_to_string (void *cls, const void *addr, size_t addrlen)
1213 if ((addr != NULL) && (addrlen > 0))
1214 return (const char *) addr;
1220 * Notify transport service about address
1222 * @param cls the plugin
1226 address_notification (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1228 struct Plugin *plugin = cls;
1230 plugin->env->notify_address (plugin->env->cls, GNUNET_YES,
1231 plugin->unix_socket_path,
1232 strlen (plugin->unix_socket_path) + 1,
1238 * Session was idle, so disconnect it
1241 session_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1243 GNUNET_assert (NULL != cls);
1244 struct Session *s = cls;
1246 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1247 LOG (GNUNET_ERROR_TYPE_DEBUG,
1248 "Session %p was idle for %llu ms, disconnecting\n",
1249 s, (unsigned long long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1250 /* call session destroy function */
1251 disconnect_session(s);
1256 * Start session timeout
1259 start_session_timeout (struct Session *s)
1261 GNUNET_assert (NULL != s);
1262 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == s->timeout_task);
1263 s->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1266 LOG (GNUNET_ERROR_TYPE_DEBUG,
1267 "Timeout for session %p set to %llu ms\n",
1268 s, (unsigned long long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1273 * Increment session timeout due to activity
1276 reschedule_session_timeout (struct Session *s)
1278 GNUNET_assert (NULL != s);
1279 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != s->timeout_task);
1281 GNUNET_SCHEDULER_cancel (s->timeout_task);
1282 s->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1285 LOG (GNUNET_ERROR_TYPE_DEBUG,
1286 "Timeout rescheduled for session %p set to %llu ms\n",
1287 s, (unsigned long long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1295 stop_session_timeout (struct Session *s)
1297 GNUNET_assert (NULL != s);
1299 if (GNUNET_SCHEDULER_NO_TASK != s->timeout_task)
1301 GNUNET_SCHEDULER_cancel (s->timeout_task);
1302 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1303 LOG (GNUNET_ERROR_TYPE_DEBUG,
1304 "Timeout stopped for session %p canceled\n",
1305 s, (unsigned long long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1310 * The exported method. Makes the core api available via a global and
1311 * returns the unix transport API.
1314 libgnunet_plugin_transport_unix_init (void *cls)
1316 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1317 unsigned long long port;
1318 struct GNUNET_TRANSPORT_PluginFunctions *api;
1319 struct Plugin *plugin;
1320 int sockets_created;
1322 if (NULL == env->receive)
1324 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1325 initialze the plugin or the API */
1326 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1328 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1329 api->address_to_string = &unix_address_to_string;
1330 api->string_to_address = &unix_string_to_address;
1334 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
1336 port = UNIX_NAT_DEFAULT_PORT;
1337 plugin = GNUNET_malloc (sizeof (struct Plugin));
1338 plugin->port = port;
1340 GNUNET_asprintf (&plugin->unix_socket_path, "/tmp/unix-plugin-sock.%d",
1343 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1346 api->get_session = &unix_plugin_get_session;
1347 api->send = &unix_plugin_send;
1348 api->disconnect = &unix_disconnect;
1349 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1350 api->address_to_string = &unix_address_to_string;
1351 api->check_address = &unix_check_address;
1352 api->string_to_address = &unix_string_to_address;
1353 sockets_created = unix_transport_server_start (plugin);
1354 if (sockets_created == 0)
1355 LOG (GNUNET_ERROR_TYPE_WARNING, _("Failed to open UNIX sockets\n"));
1357 plugin->session_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
1359 GNUNET_SCHEDULER_add_now (address_notification, plugin);
1364 libgnunet_plugin_transport_unix_done (void *cls)
1366 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1367 struct Plugin *plugin = api->cls;
1375 plugin->env->notify_address (plugin->env->cls, GNUNET_NO,
1376 plugin->unix_socket_path,
1377 strlen (plugin->unix_socket_path) + 1,
1380 unix_transport_server_stop (plugin);
1383 GNUNET_CONTAINER_multihashmap_iterate (plugin->session_map, &get_session_delete_it, plugin);
1384 GNUNET_CONTAINER_multihashmap_destroy (plugin->session_map);
1387 if (NULL != plugin->rs)
1388 GNUNET_NETWORK_fdset_destroy (plugin->rs);
1389 if (NULL != plugin->ws)
1390 GNUNET_NETWORK_fdset_destroy (plugin->ws);
1391 GNUNET_free (plugin->unix_socket_path);
1392 GNUNET_free (plugin);
1397 /* end of plugin_transport_unix.c */