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"
47 #define LOG(kind,...) GNUNET_log_from (kind, "transport-unix",__VA_ARGS__)
50 * Transport cost to peer, always 1 for UNIX (direct connection)
52 #define UNIX_DIRECT_DISTANCE 1
54 #define DEFAULT_NAT_PORT 0
57 * How long until we give up on transmitting the welcome message?
59 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
62 * Starting port for listening and sending, eventually a config value
64 #define UNIX_NAT_DEFAULT_PORT 22086
66 GNUNET_NETWORK_STRUCT_BEGIN
69 * UNIX Message-Packet header.
76 struct GNUNET_MessageHeader header;
79 * What is the identity of the sender (GNUNET_hash of public key)
81 struct GNUNET_PeerIdentity sender;
87 struct GNUNET_PeerIdentity target;
93 * Session timeout task
95 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
97 struct Plugin * plugin;
100 struct UNIXMessageWrapper
102 struct UNIXMessageWrapper *next;
103 struct UNIXMessageWrapper *prev;
105 struct UNIXMessage * msg;
108 struct GNUNET_TIME_Relative timeout;
109 unsigned int priority;
111 struct Session *session;
112 GNUNET_TRANSPORT_TransmitContinuation cont;
116 /* Forward definition */
127 * Stored in a linked list.
129 struct PeerSession *next;
132 * Pointer to the global plugin struct.
134 struct Plugin *plugin;
137 * To whom are we talking to (set to our identity
138 * if we are still waiting for the welcome message)
140 struct GNUNET_PeerIdentity target;
143 * Address of the other peer (either based on our 'connect'
144 * call or on our 'accept' call).
149 * Length of connect_addr.
154 * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
156 int expecting_welcome;
159 * From which socket do we need to send to this peer?
161 struct GNUNET_NETWORK_Handle *sock;
164 * Queue of messages for this peer, in the case that
165 * we have to await a connection...
167 struct MessageQueue *messages;
172 * Information we keep for each of our listen sockets.
174 struct UNIX_Sock_Info
179 struct GNUNET_NETWORK_Handle *desc;
182 * The port we bound to
189 * Encapsulation of all of the state of the plugin.
196 struct GNUNET_TRANSPORT_PluginEnvironment *env;
201 struct GNUNET_CONTAINER_MultiHashMap *session_map;
204 * ID of task used to update our addresses when one expires.
206 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
211 GNUNET_SCHEDULER_TaskIdentifier select_task;
214 * Integer to append to unix domain socket.
221 struct GNUNET_NETWORK_FDSet *rs;
226 struct GNUNET_NETWORK_FDSet *ws;
231 * socket that we transmit all data with
233 struct UNIX_Sock_Info unix_sock;
236 * Path of our unix domain socket (/tmp/unix-plugin-PORT)
238 char *unix_socket_path;
240 struct UNIXMessageWrapper *msg_head;
241 struct UNIXMessageWrapper *msg_tail;
246 struct GNUNET_ATS_Information ats_network;
248 unsigned int bytes_in_queue;
249 unsigned int bytes_in_sent;
250 unsigned int bytes_in_recv;
251 unsigned int bytes_discarded;
255 * Start session timeout
258 start_session_timeout (struct Session *s);
261 * Increment session timeout due to activity
264 reschedule_session_timeout (struct Session *s);
270 stop_session_timeout (struct Session *s);
274 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
278 reschedule_select (struct Plugin * plugin)
281 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
283 GNUNET_SCHEDULER_cancel (plugin->select_task);
284 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
287 if (NULL != plugin->msg_head)
289 plugin->select_task =
290 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
291 GNUNET_TIME_UNIT_FOREVER_REL,
294 &unix_plugin_select, plugin);
295 plugin->with_ws = GNUNET_YES;
299 plugin->select_task =
300 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
301 GNUNET_TIME_UNIT_FOREVER_REL,
304 &unix_plugin_select, plugin);
305 plugin->with_ws = GNUNET_NO;
312 const struct sockaddr_un *addr;
315 int lookup_session_it (void *cls,
316 const struct GNUNET_HashCode * key,
319 struct LookupCtx *lctx = cls;
320 struct Session *t = value;
322 if (0 == strcmp (t->addr, lctx->addr->sun_path))
331 static struct Session *
332 lookup_session (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender, const struct sockaddr_un *addr)
334 struct LookupCtx lctx;
336 GNUNET_assert (NULL != plugin);
337 GNUNET_assert (NULL != sender);
338 GNUNET_assert (NULL != addr);
343 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &sender->hashPubKey, &lookup_session_it, &lctx);
349 * Functions with this signature are called whenever we need
350 * to close a session due to a disconnect or failure to
351 * establish a connection.
353 * @param s session to close down
356 disconnect_session (struct Session *s)
358 struct UNIXMessageWrapper *msgw;
359 struct UNIXMessageWrapper *next;
360 struct Plugin * plugin = s->plugin;
362 GNUNET_assert (plugin != NULL);
363 GNUNET_assert (s != NULL);
365 LOG (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting session for peer `%s' `%s' \n", GNUNET_i2s (&s->target), s->addr);
366 stop_session_timeout (s);
367 plugin->env->session_end (plugin->env->cls, &s->target, s);
369 msgw = plugin->msg_head;
371 next = plugin->msg_head;
376 if (msgw->session != s)
378 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
379 if (NULL != msgw->cont)
380 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR,
382 GNUNET_free (msgw->msg);
384 removed = GNUNET_YES;
386 if ((GNUNET_YES == removed) && (NULL == plugin->msg_head))
387 reschedule_select (plugin);
389 GNUNET_assert (GNUNET_YES ==
390 GNUNET_CONTAINER_multihashmap_remove(plugin->session_map, &s->target.hashPubKey, s));
392 GNUNET_STATISTICS_set(plugin->env->stats,
393 "# UNIX sessions active",
394 GNUNET_CONTAINER_multihashmap_size(plugin->session_map),
401 get_session_delete_it (void *cls, const struct GNUNET_HashCode * key, void *value)
403 struct Session *s = value;
404 disconnect_session (s);
410 * Disconnect from a remote node. Clean up session if we have one for this peer
412 * @param cls closure for this call (should be handle to Plugin)
413 * @param target the peeridentity of the peer to disconnect
414 * @return GNUNET_OK on success, GNUNET_SYSERR if the operation failed
417 unix_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
419 struct Plugin *plugin = cls;
420 GNUNET_assert (plugin != NULL);
422 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &target->hashPubKey, &get_session_delete_it, plugin);
427 * Shutdown the server process (stop receiving inbound traffic). Maybe
430 * @param cls Handle to the plugin for this transport
432 * @return returns the number of sockets successfully closed,
433 * should equal the number of sockets successfully opened
436 unix_transport_server_stop (void *cls)
438 struct Plugin *plugin = cls;
440 struct UNIXMessageWrapper * msgw = plugin->msg_head;
442 while (NULL != (msgw = plugin->msg_head))
444 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
445 if (msgw->cont != NULL)
446 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR,
448 GNUNET_free (msgw->msg);
452 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
454 GNUNET_SCHEDULER_cancel (plugin->select_task);
455 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
458 if (NULL != plugin->unix_sock.desc)
460 GNUNET_break (GNUNET_OK ==
461 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
462 plugin->unix_sock.desc = NULL;
463 plugin->with_ws = GNUNET_NO;
470 * Actually send out the message, assume we've got the address and
471 * send_handle squared away!
474 * @param send_handle which handle to send message on
475 * @param target who should receive this message (ignored by UNIX)
476 * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
477 * @param msgbuf_size the size of the msgbuf to send
478 * @param priority how important is the message (ignored by UNIX)
479 * @param timeout when should we time out (give up) if we can not transmit?
480 * @param addr the addr to send the message to, needs to be a sockaddr for us
481 * @param addrlen the len of addr
482 * @param cont continuation to call once the message has
483 * been transmitted (or if the transport is ready
484 * for the next transmission call; or if the
485 * peer disconnected...)
486 * @param cont_cls closure for cont
488 * @return the number of bytes written, -1 on errors
491 unix_real_send (void *cls,
492 struct GNUNET_NETWORK_Handle *send_handle,
493 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
494 size_t msgbuf_size, unsigned int priority,
495 struct GNUNET_TIME_Relative timeout, const void *addr,
496 size_t addrlen, GNUNET_TRANSPORT_TransmitContinuation cont,
499 struct Plugin *plugin = cls;
503 struct sockaddr_un un;
506 GNUNET_assert (NULL != plugin);
508 if (send_handle == NULL)
510 /* We do not have a send handle */
513 cont (cont_cls, target, GNUNET_SYSERR, msgbuf_size, 0);
516 if ((addr == NULL) || (addrlen == 0))
518 /* Can never send if we don't have an address */
521 cont (cont_cls, target, GNUNET_SYSERR, msgbuf_size, 0);
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;
546 sent = GNUNET_NETWORK_socket_sendto (send_handle, msgbuf, msgbuf_size, sb, sbs);
548 if ((GNUNET_SYSERR == sent) && ((errno == EAGAIN) || (errno == ENOBUFS)))
550 /* We have to retry later: retry */
554 if ((GNUNET_SYSERR == sent) && (errno == EMSGSIZE))
557 socklen_t len = sizeof (size);
559 GNUNET_NETWORK_socket_getsockopt ((struct GNUNET_NETWORK_Handle *)
560 send_handle, SOL_SOCKET, SO_SNDBUF, &size,
563 if (size < msgbuf_size)
565 LOG (GNUNET_ERROR_TYPE_DEBUG,
566 "Trying to increase socket buffer size from %i to %i for message size %i\n",
568 ((msgbuf_size / 1000) + 2) * 1000,
570 size = ((msgbuf_size / 1000) + 2) * 1000;
571 if (GNUNET_NETWORK_socket_setsockopt
572 ((struct GNUNET_NETWORK_Handle *) send_handle, SOL_SOCKET, SO_SNDBUF,
573 &size, sizeof (size)) == GNUNET_OK)
575 /* Increased buffer size, retry sending */
580 /* Could not increase buffer size: error, no retry */
581 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
587 /* Buffer is bigger than message: error, no retry
588 * This should never happen!*/
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");
599 /* Calling continuation */
602 if (sent == GNUNET_SYSERR)
603 cont (cont_cls, target, GNUNET_SYSERR, msgbuf_size, 0);
605 cont (cont_cls, target, GNUNET_OK, msgbuf_size, msgbuf_size);
608 /* return number of bytes successfully sent */
613 /* That should never happen */
617 /* failed and retry: return 0 */
618 if (GNUNET_SYSERR == sent)
633 get_session_it (void *cls, const struct GNUNET_HashCode * key, void *value)
635 struct gsi_ctx *gsi = cls;
636 struct Session *s = value;
638 LOG (GNUNET_ERROR_TYPE_DEBUG, "Comparing session %s %s\n", gsi->address, s->addr);
639 if ((gsi->addrlen == s->addrlen) &&
640 (0 == memcmp (gsi->address, s->addr, s->addrlen)))
649 * Creates a new outbound session the transport service will use to send data to the
652 * @param cls the plugin
653 * @param address the address
654 * @return the session or NULL of max connections exceeded
656 static struct Session *
657 unix_plugin_get_session (void *cls,
658 const struct GNUNET_HELLO_Address *address)
660 struct Session * s = NULL;
661 struct Plugin *plugin = cls;
665 GNUNET_assert (plugin != NULL);
666 GNUNET_assert (address != NULL);
668 /* Check if already existing */
669 gsi.address = (char *) address->address;
670 gsi.addrlen = address->address_length;
672 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &address->peer.hashPubKey, &get_session_it, &gsi);
675 LOG (GNUNET_ERROR_TYPE_DEBUG, "Found existing session\n");
679 /* Create a new session */
680 s = GNUNET_malloc (sizeof (struct Session) + address->address_length);
682 s->addrlen = address->address_length;
684 memcpy(s->addr, address->address, s->addrlen);
685 memcpy(&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
687 start_session_timeout (s);
689 GNUNET_CONTAINER_multihashmap_put (plugin->session_map,
690 &address->peer.hashPubKey, s,
691 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
693 GNUNET_STATISTICS_set(plugin->env->stats,
694 "# UNIX sessions active",
695 GNUNET_CONTAINER_multihashmap_size(plugin->session_map),
697 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new session\n");
702 * @param cls the plugin handle
703 * @param tc the scheduling context (for rescheduling this function again)
705 * We have been notified that our writeset has something to read. We don't
706 * know which socket needs to be read, so we have to check each one
707 * Then reschedule this function to be called again once more is available.
711 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
714 * Function that can be used by the transport service to transmit
715 * a message using the plugin. Note that in the case of a
716 * peer disconnecting, the continuation MUST be called
717 * prior to the disconnect notification itself. This function
718 * will be called with this peer's HELLO message to initiate
719 * a fresh connection to another peer.
722 * @param session which session must be used
723 * @param msgbuf the message to transmit
724 * @param msgbuf_size number of bytes in 'msgbuf'
725 * @param priority how important is the message (most plugins will
726 * ignore message priority and just FIFO)
727 * @param to how long to wait at most for the transmission (does not
728 * require plugins to discard the message after the timeout,
729 * just advisory for the desired delay; most plugins will ignore
731 * @param cont continuation to call once the message has
732 * been transmitted (or if the transport is ready
733 * for the next transmission call; or if the
734 * peer disconnected...); can be NULL
735 * @param cont_cls closure for cont
736 * @return number of bytes used (on the physical network, with overheads);
737 * -1 on hard errors (i.e. address invalid); 0 is a legal value
738 * and does NOT mean that the message was not transmitted (DV)
741 unix_plugin_send (void *cls,
742 struct Session *session,
743 const char *msgbuf, size_t msgbuf_size,
744 unsigned int priority,
745 struct GNUNET_TIME_Relative to,
746 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
748 struct Plugin *plugin = cls;
749 struct UNIXMessageWrapper *wrapper;
750 struct UNIXMessage *message;
753 GNUNET_assert (plugin != NULL);
754 GNUNET_assert (session != NULL);
756 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_contains_value(plugin->session_map,
757 &session->target.hashPubKey, session))
759 LOG (GNUNET_ERROR_TYPE_ERROR, "Invalid session for peer `%s' `%s'\n",
760 GNUNET_i2s (&session->target),
761 (char *) session->addr);
764 return GNUNET_SYSERR;
766 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending %u bytes with session for peer `%s' `%s'\n",
768 GNUNET_i2s (&session->target),
769 (char *) session->addr);
771 ssize = sizeof (struct UNIXMessage) + msgbuf_size;
772 message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
773 message->header.size = htons (ssize);
774 message->header.type = htons (0);
775 memcpy (&message->sender, plugin->env->my_identity,
776 sizeof (struct GNUNET_PeerIdentity));
777 memcpy (&message[1], msgbuf, msgbuf_size);
779 reschedule_session_timeout (session);
781 wrapper = GNUNET_malloc (sizeof (struct UNIXMessageWrapper));
782 wrapper->msg = message;
783 wrapper->msgsize = ssize;
784 wrapper->priority = priority;
785 wrapper->timeout = to;
786 wrapper->cont = cont;
787 wrapper->cont_cls = cont_cls;
788 wrapper->session = session;
790 GNUNET_CONTAINER_DLL_insert(plugin->msg_head, plugin->msg_tail, wrapper);
792 plugin->bytes_in_queue += ssize;
793 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes currently in UNIX buffers",
794 plugin->bytes_in_queue, GNUNET_NO);
796 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sent %d bytes to `%s'\n", ssize,
797 (char *) session->addr);
798 if (plugin->with_ws == GNUNET_NO)
800 reschedule_select (plugin);
808 * Demultiplexer for UNIX messages
810 * @param plugin the main plugin for this transport
811 * @param sender from which peer the message was received
812 * @param currhdr pointer to the header of the message
813 * @param un the address from which the message was received
814 * @param fromlen the length of the address
817 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
818 const struct GNUNET_MessageHeader *currhdr,
819 const struct sockaddr_un *un, size_t fromlen)
821 struct GNUNET_ATS_Information ats[2];
822 struct Session *s = NULL;
823 struct GNUNET_HELLO_Address * addr;
825 ats[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
826 ats[0].value = htonl (UNIX_DIRECT_DISTANCE);
827 ats[1] = plugin->ats_network;
828 GNUNET_break (ntohl(plugin->ats_network.value) != GNUNET_ATS_NET_UNSPECIFIED);
830 GNUNET_assert (fromlen >= sizeof (struct sockaddr_un));
832 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received message from %s\n",
837 plugin->bytes_in_recv += ntohs(currhdr->size);
838 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes received via UNIX",
839 plugin->bytes_in_recv, GNUNET_NO);
841 addr = GNUNET_HELLO_address_allocate(sender, "unix", un->sun_path, strlen (un->sun_path) + 1);
842 s = lookup_session (plugin, sender, un);
844 s = unix_plugin_get_session (plugin, addr);
845 reschedule_session_timeout (s);
847 plugin->env->receive (plugin->env->cls, sender, currhdr,
848 (const struct GNUNET_ATS_Information *) &ats, 2,
849 s, un->sun_path, strlen (un->sun_path) + 1);
855 unix_plugin_select_read (struct Plugin * plugin)
857 char buf[65536] GNUNET_ALIGN;
858 struct UNIXMessage *msg;
859 struct GNUNET_PeerIdentity sender;
860 struct sockaddr_un un;
866 const struct GNUNET_MessageHeader *currhdr;
869 addrlen = sizeof (un);
870 memset (&un, 0, sizeof (un));
873 GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc, buf, sizeof (buf),
874 (struct sockaddr *) &un, &addrlen);
876 if ((GNUNET_SYSERR == ret) && ((errno == EAGAIN) || (errno == ENOBUFS)))
879 if (ret == GNUNET_SYSERR)
881 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "recvfrom");
887 un.sun_path[0] = '/';
889 LOG (GNUNET_ERROR_TYPE_DEBUG, "Read %d bytes from socket %s\n", ret,
893 GNUNET_assert (AF_UNIX == (un.sun_family));
895 msg = (struct UNIXMessage *) buf;
896 csize = ntohs (msg->header.size);
897 if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
902 msgbuf = (char *) &msg[1];
903 memcpy (&sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
905 tsize = csize - sizeof (struct UNIXMessage);
906 while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
908 currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
909 csize = ntohs (currhdr->size);
910 if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
911 (csize > tsize - offset))
917 unix_demultiplexer (plugin, &sender, currhdr, &un, sizeof (un));
924 unix_plugin_select_write (struct Plugin * plugin)
926 static int retry_counter;
928 struct UNIXMessageWrapper * msgw = plugin->msg_head;
930 sent = unix_real_send (plugin,
931 plugin->unix_sock.desc,
932 &msgw->session->target,
933 (const char *) msgw->msg,
938 msgw->session->addrlen,
939 msgw->cont, msgw->cont_cls);
943 /* failed and retry */
945 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX retry attempt",
946 retry_counter, GNUNET_NO);
950 if (retry_counter > 0 )
952 /* no retry: reset counter */
954 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX retry attempt",
955 retry_counter, GNUNET_NO);
960 /* failed and no retry */
961 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
963 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
964 plugin->bytes_in_queue -= msgw->msgsize;
965 GNUNET_STATISTICS_set (plugin->env->stats, "# bytes currently in UNIX buffers",
966 plugin->bytes_in_queue, GNUNET_NO);
967 plugin->bytes_discarded += msgw->msgsize;
968 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes discarded",
969 plugin->bytes_discarded, GNUNET_NO);
971 GNUNET_free (msgw->msg);
978 /* successfully sent bytes */
979 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
981 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
982 plugin->bytes_in_queue -= msgw->msgsize;
983 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes currently in UNIX buffers",
984 plugin->bytes_in_queue, GNUNET_NO);
985 plugin->bytes_in_sent += msgw->msgsize;
986 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes transmitted via UNIX",
987 plugin->bytes_in_sent, GNUNET_NO);
989 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;
1333 GNUNET_assert( NULL != env->stats);
1336 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
1338 port = UNIX_NAT_DEFAULT_PORT;
1339 plugin = GNUNET_malloc (sizeof (struct Plugin));
1340 plugin->port = port;
1342 GNUNET_asprintf (&plugin->unix_socket_path, "/tmp/unix-plugin-sock.%d",
1345 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1348 api->get_session = &unix_plugin_get_session;
1349 api->send = &unix_plugin_send;
1350 api->disconnect = &unix_disconnect;
1351 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1352 api->address_to_string = &unix_address_to_string;
1353 api->check_address = &unix_check_address;
1354 api->string_to_address = &unix_string_to_address;
1355 sockets_created = unix_transport_server_start (plugin);
1356 if (sockets_created == 0)
1357 LOG (GNUNET_ERROR_TYPE_WARNING, _("Failed to open UNIX sockets\n"));
1359 plugin->session_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
1361 GNUNET_SCHEDULER_add_now (address_notification, plugin);
1366 libgnunet_plugin_transport_unix_done (void *cls)
1368 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1369 struct Plugin *plugin = api->cls;
1377 plugin->env->notify_address (plugin->env->cls, GNUNET_NO,
1378 plugin->unix_socket_path,
1379 strlen (plugin->unix_socket_path) + 1,
1382 unix_transport_server_stop (plugin);
1385 GNUNET_CONTAINER_multihashmap_iterate (plugin->session_map, &get_session_delete_it, plugin);
1386 GNUNET_CONTAINER_multihashmap_destroy (plugin->session_map);
1389 if (NULL != plugin->rs)
1390 GNUNET_NETWORK_fdset_destroy (plugin->rs);
1391 if (NULL != plugin->ws)
1392 GNUNET_NETWORK_fdset_destroy (plugin->ws);
1393 GNUNET_free (plugin->unix_socket_path);
1394 GNUNET_free (plugin);
1399 /* end of plugin_transport_unix.c */