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;
109 struct GNUNET_TIME_Relative timeout;
110 unsigned int priority;
112 struct Session *session;
113 GNUNET_TRANSPORT_TransmitContinuation cont;
117 /* Forward definition */
128 * Stored in a linked list.
130 struct PeerSession *next;
133 * Pointer to the global plugin struct.
135 struct Plugin *plugin;
138 * To whom are we talking to (set to our identity
139 * if we are still waiting for the welcome message)
141 struct GNUNET_PeerIdentity target;
144 * Address of the other peer (either based on our 'connect'
145 * call or on our 'accept' call).
150 * Length of connect_addr.
155 * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
157 int expecting_welcome;
160 * From which socket do we need to send to this peer?
162 struct GNUNET_NETWORK_Handle *sock;
165 * Queue of messages for this peer, in the case that
166 * we have to await a connection...
168 struct MessageQueue *messages;
173 * Information we keep for each of our listen sockets.
175 struct UNIX_Sock_Info
180 struct GNUNET_NETWORK_Handle *desc;
183 * The port we bound to
190 * Encapsulation of all of the state of the plugin.
197 struct GNUNET_TRANSPORT_PluginEnvironment *env;
202 struct GNUNET_CONTAINER_MultiHashMap *session_map;
205 * ID of task used to update our addresses when one expires.
207 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
212 GNUNET_SCHEDULER_TaskIdentifier select_task;
215 * Integer to append to unix domain socket.
222 struct GNUNET_NETWORK_FDSet *rs;
227 struct GNUNET_NETWORK_FDSet *ws;
232 * socket that we transmit all data with
234 struct UNIX_Sock_Info unix_sock;
237 * Path of our unix domain socket (/tmp/unix-plugin-PORT)
239 char *unix_socket_path;
241 struct UNIXMessageWrapper *msg_head;
242 struct UNIXMessageWrapper *msg_tail;
247 struct GNUNET_ATS_Information ats_network;
249 unsigned int bytes_in_queue;
250 unsigned int bytes_in_sent;
251 unsigned int bytes_in_recv;
252 unsigned int bytes_discarded;
256 * Start session timeout
259 start_session_timeout (struct Session *s);
262 * Increment session timeout due to activity
265 reschedule_session_timeout (struct Session *s);
271 stop_session_timeout (struct Session *s);
275 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
279 reschedule_select (struct Plugin * plugin)
282 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
284 GNUNET_SCHEDULER_cancel (plugin->select_task);
285 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
288 if (NULL != plugin->msg_head)
290 plugin->select_task =
291 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
292 GNUNET_TIME_UNIT_FOREVER_REL,
295 &unix_plugin_select, plugin);
296 plugin->with_ws = GNUNET_YES;
300 plugin->select_task =
301 GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_DEFAULT,
302 GNUNET_TIME_UNIT_FOREVER_REL,
305 &unix_plugin_select, plugin);
306 plugin->with_ws = GNUNET_NO;
313 const struct sockaddr_un *addr;
316 int lookup_session_it (void *cls,
317 const struct GNUNET_HashCode * key,
320 struct LookupCtx *lctx = cls;
321 struct Session *t = value;
323 if (0 == strcmp (t->addr, lctx->addr->sun_path))
332 static struct Session *
333 lookup_session (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender, const struct sockaddr_un *addr)
335 struct LookupCtx lctx;
337 GNUNET_assert (NULL != plugin);
338 GNUNET_assert (NULL != sender);
339 GNUNET_assert (NULL != addr);
344 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &sender->hashPubKey, &lookup_session_it, &lctx);
350 * Functions with this signature are called whenever we need
351 * to close a session due to a disconnect or failure to
352 * establish a connection.
354 * @param s session to close down
357 disconnect_session (struct Session *s)
359 struct UNIXMessageWrapper *msgw;
360 struct UNIXMessageWrapper *next;
361 struct Plugin * plugin = s->plugin;
363 GNUNET_assert (plugin != NULL);
364 GNUNET_assert (s != NULL);
366 LOG (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting session for peer `%s' `%s' \n", GNUNET_i2s (&s->target), s->addr);
367 stop_session_timeout (s);
368 plugin->env->session_end (plugin->env->cls, &s->target, s);
370 msgw = plugin->msg_head;
372 next = plugin->msg_head;
377 if (msgw->session != s)
379 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
380 if (NULL != msgw->cont)
381 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR,
383 GNUNET_free (msgw->msg);
385 removed = GNUNET_YES;
387 if ((GNUNET_YES == removed) && (NULL == plugin->msg_head))
388 reschedule_select (plugin);
390 GNUNET_assert (GNUNET_YES ==
391 GNUNET_CONTAINER_multihashmap_remove(plugin->session_map, &s->target.hashPubKey, s));
393 GNUNET_STATISTICS_set(plugin->env->stats,
394 "# UNIX sessions active",
395 GNUNET_CONTAINER_multihashmap_size(plugin->session_map),
402 get_session_delete_it (void *cls, const struct GNUNET_HashCode * key, void *value)
404 struct Session *s = value;
405 disconnect_session (s);
411 * Disconnect from a remote node. Clean up session if we have one for this peer
413 * @param cls closure for this call (should be handle to Plugin)
414 * @param target the peeridentity of the peer to disconnect
415 * @return GNUNET_OK on success, GNUNET_SYSERR if the operation failed
418 unix_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
420 struct Plugin *plugin = cls;
421 GNUNET_assert (plugin != NULL);
423 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &target->hashPubKey, &get_session_delete_it, plugin);
428 * Shutdown the server process (stop receiving inbound traffic). Maybe
431 * @param cls Handle to the plugin for this transport
433 * @return returns the number of sockets successfully closed,
434 * should equal the number of sockets successfully opened
437 unix_transport_server_stop (void *cls)
439 struct Plugin *plugin = cls;
441 struct UNIXMessageWrapper * msgw = plugin->msg_head;
443 while (NULL != (msgw = plugin->msg_head))
445 GNUNET_CONTAINER_DLL_remove (plugin->msg_head, plugin->msg_tail, msgw);
446 if (msgw->cont != NULL)
447 msgw->cont (msgw->cont_cls, &msgw->session->target, GNUNET_SYSERR,
449 GNUNET_free (msgw->msg);
453 if (plugin->select_task != GNUNET_SCHEDULER_NO_TASK)
455 GNUNET_SCHEDULER_cancel (plugin->select_task);
456 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
459 if (NULL != plugin->unix_sock.desc)
461 GNUNET_break (GNUNET_OK ==
462 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc));
463 plugin->unix_sock.desc = NULL;
464 plugin->with_ws = GNUNET_NO;
471 * Actually send out the message, assume we've got the address and
472 * send_handle squared away!
475 * @param send_handle which handle to send message on
476 * @param target who should receive this message (ignored by UNIX)
477 * @param msgbuf one or more GNUNET_MessageHeader(s) strung together
478 * @param msgbuf_size the size of the msgbuf to send
479 * @param priority how important is the message (ignored by UNIX)
480 * @param timeout when should we time out (give up) if we can not transmit?
481 * @param addr the addr to send the message to, needs to be a sockaddr for us
482 * @param addrlen the len of addr
483 * @param payload bytes payload to send
484 * @param cont continuation to call once the message has
485 * been transmitted (or if the transport is ready
486 * for the next transmission call; or if the
487 * peer disconnected...)
488 * @param cont_cls closure for cont
490 * @return the number of bytes written, -1 on errors
493 unix_real_send (void *cls,
494 struct GNUNET_NETWORK_Handle *send_handle,
495 const struct GNUNET_PeerIdentity *target, const char *msgbuf,
496 size_t msgbuf_size, unsigned int priority,
497 struct GNUNET_TIME_Relative timeout,
501 GNUNET_TRANSPORT_TransmitContinuation cont,
504 struct Plugin *plugin = cls;
508 struct sockaddr_un un;
511 GNUNET_assert (NULL != plugin);
513 if (send_handle == NULL)
515 /* We do not have a send handle */
518 cont (cont_cls, target, GNUNET_SYSERR, payload, 0);
521 if ((addr == NULL) || (addrlen == 0))
523 /* Can never send if we don't have an address */
526 cont (cont_cls, target, GNUNET_SYSERR, payload, 0);
530 /* Prepare address */
531 memset (&un, 0, sizeof (un));
532 un.sun_family = AF_UNIX;
533 slen = strlen (addr) + 1;
534 if (slen >= sizeof (un.sun_path))
535 slen = sizeof (un.sun_path) - 1;
536 GNUNET_assert (slen < sizeof (un.sun_path));
537 memcpy (un.sun_path, addr, slen);
538 un.sun_path[slen] = '\0';
539 slen = sizeof (struct sockaddr_un);
541 un.sun_path[0] = '\0';
543 #if HAVE_SOCKADDR_IN_SIN_LEN
544 un.sun_len = (u_char) slen;
546 sb = (struct sockaddr *) &un;
551 sent = GNUNET_NETWORK_socket_sendto (send_handle, msgbuf, msgbuf_size, sb, sbs);
553 if ((GNUNET_SYSERR == sent) && ((errno == EAGAIN) || (errno == ENOBUFS)))
555 /* We have to retry later: retry */
559 if ((GNUNET_SYSERR == sent) && (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,
568 if (size < msgbuf_size)
570 LOG (GNUNET_ERROR_TYPE_DEBUG,
571 "Trying to increase socket buffer size from %i to %i for message size %i\n",
573 ((msgbuf_size / 1000) + 2) * 1000,
575 size = ((msgbuf_size / 1000) + 2) * 1000;
576 if (GNUNET_NETWORK_socket_setsockopt
577 ((struct GNUNET_NETWORK_Handle *) send_handle, SOL_SOCKET, SO_SNDBUF,
578 &size, sizeof (size)) == GNUNET_OK)
580 /* Increased buffer size, retry sending */
585 /* Could not increase buffer size: error, no retry */
586 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "setsockopt");
592 /* Buffer is bigger than message: error, no retry
593 * This should never happen!*/
599 LOG (GNUNET_ERROR_TYPE_DEBUG,
600 "UNIX transmit %u-byte message to %s (%d: %s)\n",
601 (unsigned int) msgbuf_size, GNUNET_a2s (sb, sbs), (int) sent,
602 (sent < 0) ? STRERROR (errno) : "ok");
604 /* Calling continuation */
607 if (sent == GNUNET_SYSERR)
608 cont (cont_cls, target, GNUNET_SYSERR, payload, 0);
610 cont (cont_cls, target, GNUNET_OK, payload, msgbuf_size);
613 /* return number of bytes successfully sent */
618 /* That should never happen */
622 /* failed and retry: return 0 */
623 if (GNUNET_SYSERR == sent)
638 get_session_it (void *cls, const struct GNUNET_HashCode * key, void *value)
640 struct gsi_ctx *gsi = cls;
641 struct Session *s = value;
643 LOG (GNUNET_ERROR_TYPE_DEBUG, "Comparing session %s %s\n", gsi->address, s->addr);
644 if ((gsi->addrlen == s->addrlen) &&
645 (0 == memcmp (gsi->address, s->addr, s->addrlen)))
654 * Creates a new outbound session the transport service will use to send data to the
657 * @param cls the plugin
658 * @param address the address
659 * @return the session or NULL of max connections exceeded
661 static struct Session *
662 unix_plugin_get_session (void *cls,
663 const struct GNUNET_HELLO_Address *address)
665 struct Session * s = NULL;
666 struct Plugin *plugin = cls;
670 GNUNET_assert (plugin != NULL);
671 GNUNET_assert (address != NULL);
673 /* Check if already existing */
674 gsi.address = (char *) address->address;
675 gsi.addrlen = address->address_length;
677 GNUNET_CONTAINER_multihashmap_get_multiple (plugin->session_map, &address->peer.hashPubKey, &get_session_it, &gsi);
680 LOG (GNUNET_ERROR_TYPE_DEBUG, "Found existing session\n");
684 /* Create a new session */
685 s = GNUNET_malloc (sizeof (struct Session) + address->address_length);
687 s->addrlen = address->address_length;
689 memcpy(s->addr, address->address, s->addrlen);
690 memcpy(&s->target, &address->peer, sizeof (struct GNUNET_PeerIdentity));
692 start_session_timeout (s);
694 GNUNET_CONTAINER_multihashmap_put (plugin->session_map,
695 &address->peer.hashPubKey, s,
696 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
698 GNUNET_STATISTICS_set(plugin->env->stats,
699 "# UNIX sessions active",
700 GNUNET_CONTAINER_multihashmap_size(plugin->session_map),
702 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new session\n");
707 * @param cls the plugin handle
708 * @param tc the scheduling context (for rescheduling this function again)
710 * We have been notified that our writeset has something to read. We don't
711 * know which socket needs to be read, so we have to check each one
712 * Then reschedule this function to be called again once more is available.
716 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
719 * Function that can be used by the transport service to transmit
720 * a message using the plugin. Note that in the case of a
721 * peer disconnecting, the continuation MUST be called
722 * prior to the disconnect notification itself. This function
723 * will be called with this peer's HELLO message to initiate
724 * a fresh connection to another peer.
727 * @param session which session must be used
728 * @param msgbuf the message to transmit
729 * @param msgbuf_size number of bytes in 'msgbuf'
730 * @param priority how important is the message (most plugins will
731 * ignore message priority and just FIFO)
732 * @param to how long to wait at most for the transmission (does not
733 * require plugins to discard the message after the timeout,
734 * just advisory for the desired delay; most plugins will ignore
736 * @param cont continuation to call once the message has
737 * been transmitted (or if the transport is ready
738 * for the next transmission call; or if the
739 * peer disconnected...); can be NULL
740 * @param cont_cls closure for cont
741 * @return number of bytes used (on the physical network, with overheads);
742 * -1 on hard errors (i.e. address invalid); 0 is a legal value
743 * and does NOT mean that the message was not transmitted (DV)
746 unix_plugin_send (void *cls,
747 struct Session *session,
748 const char *msgbuf, size_t msgbuf_size,
749 unsigned int priority,
750 struct GNUNET_TIME_Relative to,
751 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
753 struct Plugin *plugin = cls;
754 struct UNIXMessageWrapper *wrapper;
755 struct UNIXMessage *message;
758 GNUNET_assert (plugin != NULL);
759 GNUNET_assert (session != NULL);
761 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_contains_value(plugin->session_map,
762 &session->target.hashPubKey, session))
764 LOG (GNUNET_ERROR_TYPE_ERROR, "Invalid session for peer `%s' `%s'\n",
765 GNUNET_i2s (&session->target),
766 (char *) session->addr);
769 return GNUNET_SYSERR;
771 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sending %u bytes with session for peer `%s' `%s'\n",
773 GNUNET_i2s (&session->target),
774 (char *) session->addr);
776 ssize = sizeof (struct UNIXMessage) + msgbuf_size;
777 message = GNUNET_malloc (sizeof (struct UNIXMessage) + msgbuf_size);
778 message->header.size = htons (ssize);
779 message->header.type = htons (0);
780 memcpy (&message->sender, plugin->env->my_identity,
781 sizeof (struct GNUNET_PeerIdentity));
782 memcpy (&message[1], msgbuf, msgbuf_size);
784 reschedule_session_timeout (session);
786 wrapper = GNUNET_malloc (sizeof (struct UNIXMessageWrapper));
787 wrapper->msg = message;
788 wrapper->msgsize = ssize;
789 wrapper->payload = msgbuf_size;
790 wrapper->priority = priority;
791 wrapper->timeout = to;
792 wrapper->cont = cont;
793 wrapper->cont_cls = cont_cls;
794 wrapper->session = session;
796 GNUNET_CONTAINER_DLL_insert(plugin->msg_head, plugin->msg_tail, wrapper);
798 plugin->bytes_in_queue += ssize;
799 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes currently in UNIX buffers",
800 plugin->bytes_in_queue, GNUNET_NO);
802 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sent %d bytes to `%s'\n", ssize,
803 (char *) session->addr);
804 if (plugin->with_ws == GNUNET_NO)
806 reschedule_select (plugin);
814 * Demultiplexer for UNIX messages
816 * @param plugin the main plugin for this transport
817 * @param sender from which peer the message was received
818 * @param currhdr pointer to the header of the message
819 * @param un the address from which the message was received
820 * @param fromlen the length of the address
823 unix_demultiplexer (struct Plugin *plugin, struct GNUNET_PeerIdentity *sender,
824 const struct GNUNET_MessageHeader *currhdr,
825 const struct sockaddr_un *un, size_t fromlen)
827 struct GNUNET_ATS_Information ats[2];
828 struct Session *s = NULL;
829 struct GNUNET_HELLO_Address * addr;
831 ats[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
832 ats[0].value = htonl (UNIX_DIRECT_DISTANCE);
833 ats[1] = plugin->ats_network;
834 GNUNET_break (ntohl(plugin->ats_network.value) != GNUNET_ATS_NET_UNSPECIFIED);
836 GNUNET_assert (fromlen >= sizeof (struct sockaddr_un));
838 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received message from %s\n",
843 plugin->bytes_in_recv += ntohs(currhdr->size);
844 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes received via UNIX",
845 plugin->bytes_in_recv, GNUNET_NO);
847 addr = GNUNET_HELLO_address_allocate(sender, "unix", un->sun_path, strlen (un->sun_path) + 1);
848 s = lookup_session (plugin, sender, un);
850 s = unix_plugin_get_session (plugin, addr);
851 reschedule_session_timeout (s);
853 plugin->env->receive (plugin->env->cls, sender, currhdr,
854 (const struct GNUNET_ATS_Information *) &ats, 2,
855 s, un->sun_path, strlen (un->sun_path) + 1);
861 unix_plugin_select_read (struct Plugin * plugin)
863 char buf[65536] GNUNET_ALIGN;
864 struct UNIXMessage *msg;
865 struct GNUNET_PeerIdentity sender;
866 struct sockaddr_un un;
872 const struct GNUNET_MessageHeader *currhdr;
875 addrlen = sizeof (un);
876 memset (&un, 0, sizeof (un));
879 GNUNET_NETWORK_socket_recvfrom (plugin->unix_sock.desc, buf, sizeof (buf),
880 (struct sockaddr *) &un, &addrlen);
882 if ((GNUNET_SYSERR == ret) && ((errno == EAGAIN) || (errno == ENOBUFS)))
885 if (ret == GNUNET_SYSERR)
887 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "recvfrom");
893 un.sun_path[0] = '/';
895 LOG (GNUNET_ERROR_TYPE_DEBUG, "Read %d bytes from socket %s\n", ret,
899 GNUNET_assert (AF_UNIX == (un.sun_family));
901 msg = (struct UNIXMessage *) buf;
902 csize = ntohs (msg->header.size);
903 if ((csize < sizeof (struct UNIXMessage)) || (csize > ret))
908 msgbuf = (char *) &msg[1];
909 memcpy (&sender, &msg->sender, sizeof (struct GNUNET_PeerIdentity));
911 tsize = csize - sizeof (struct UNIXMessage);
912 while (offset + sizeof (struct GNUNET_MessageHeader) <= tsize)
914 currhdr = (struct GNUNET_MessageHeader *) &msgbuf[offset];
915 csize = ntohs (currhdr->size);
916 if ((csize < sizeof (struct GNUNET_MessageHeader)) ||
917 (csize > tsize - offset))
923 unix_demultiplexer (plugin, &sender, currhdr, &un, sizeof (un));
930 unix_plugin_select_write (struct Plugin * plugin)
932 static int retry_counter;
934 struct UNIXMessageWrapper * msgw = plugin->msg_head;
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 /* failed and retry */
952 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX retry attempt",
953 retry_counter, GNUNET_NO);
957 if (retry_counter > 0 )
959 /* no retry: reset counter */
961 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX retry attempt",
962 retry_counter, GNUNET_NO);
967 /* failed and no retry */
968 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
970 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
971 plugin->bytes_in_queue -= msgw->msgsize;
972 GNUNET_STATISTICS_set (plugin->env->stats, "# bytes currently in UNIX buffers",
973 plugin->bytes_in_queue, GNUNET_NO);
974 plugin->bytes_discarded += msgw->msgsize;
975 GNUNET_STATISTICS_set (plugin->env->stats,"# UNIX bytes discarded",
976 plugin->bytes_discarded, GNUNET_NO);
978 GNUNET_free (msgw->msg);
985 /* successfully sent bytes */
986 GNUNET_CONTAINER_DLL_remove(plugin->msg_head, plugin->msg_tail, msgw);
988 GNUNET_assert (plugin->bytes_in_queue >= msgw->msgsize);
989 plugin->bytes_in_queue -= msgw->msgsize;
990 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes currently in UNIX buffers",
991 plugin->bytes_in_queue, GNUNET_NO);
992 plugin->bytes_in_sent += msgw->msgsize;
993 GNUNET_STATISTICS_set (plugin->env->stats,"# bytes transmitted via UNIX",
994 plugin->bytes_in_sent, GNUNET_NO);
996 GNUNET_free (msgw->msg);
1005 * We have been notified that our writeset has something to read. We don't
1006 * know which socket needs to be read, so we have to check each one
1007 * Then reschedule this function to be called again once more is available.
1009 * @param cls the plugin handle
1010 * @param tc the scheduling context (for rescheduling this function again)
1013 unix_plugin_select (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1015 struct Plugin *plugin = cls;
1017 plugin->select_task = GNUNET_SCHEDULER_NO_TASK;
1018 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
1021 if ((tc->reason & GNUNET_SCHEDULER_REASON_WRITE_READY) != 0)
1023 /* Ready to send data */
1024 GNUNET_assert (GNUNET_NETWORK_fdset_isset
1025 (tc->write_ready, plugin->unix_sock.desc));
1026 if (plugin->msg_head != NULL)
1027 unix_plugin_select_write (plugin);
1030 if ((tc->reason & GNUNET_SCHEDULER_REASON_READ_READY) != 0)
1032 /* Ready to receive data */
1033 GNUNET_assert (GNUNET_NETWORK_fdset_isset
1034 (tc->read_ready, plugin->unix_sock.desc));
1035 unix_plugin_select_read (plugin);
1038 reschedule_select (plugin);
1043 * Create a slew of UNIX sockets. If possible, use IPv6 and IPv4.
1045 * @param cls closure for server start, should be a struct Plugin *
1046 * @return number of sockets created or GNUNET_SYSERR on error
1049 unix_transport_server_start (void *cls)
1051 struct Plugin *plugin = cls;
1052 struct sockaddr *serverAddr;
1054 struct sockaddr_un un;
1057 memset (&un, 0, sizeof (un));
1058 un.sun_family = AF_UNIX;
1059 slen = strlen (plugin->unix_socket_path) + 1;
1060 if (slen >= sizeof (un.sun_path))
1061 slen = sizeof (un.sun_path) - 1;
1063 memcpy (un.sun_path, plugin->unix_socket_path, slen);
1064 un.sun_path[slen] = '\0';
1065 slen = sizeof (struct sockaddr_un);
1066 #if HAVE_SOCKADDR_IN_SIN_LEN
1067 un.sun_len = (u_char) slen;
1070 serverAddr = (struct sockaddr *) &un;
1073 un.sun_path[0] = '\0';
1075 plugin->ats_network = plugin->env->get_address_type (plugin->env->cls, serverAddr, addrlen);
1076 plugin->unix_sock.desc =
1077 GNUNET_NETWORK_socket_create (AF_UNIX, SOCK_DGRAM, 0);
1078 if (NULL == plugin->unix_sock.desc)
1080 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
1081 return GNUNET_SYSERR;
1083 if (GNUNET_NETWORK_socket_bind (plugin->unix_sock.desc, serverAddr, addrlen)
1086 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
1087 GNUNET_NETWORK_socket_close (plugin->unix_sock.desc);
1088 plugin->unix_sock.desc = NULL;
1089 return GNUNET_SYSERR;
1091 LOG (GNUNET_ERROR_TYPE_DEBUG, "Bound to `%s'\n", plugin->unix_socket_path);
1092 plugin->rs = GNUNET_NETWORK_fdset_create ();
1093 plugin->ws = GNUNET_NETWORK_fdset_create ();
1094 GNUNET_NETWORK_fdset_zero (plugin->rs);
1095 GNUNET_NETWORK_fdset_zero (plugin->ws);
1096 GNUNET_NETWORK_fdset_set (plugin->rs, plugin->unix_sock.desc);
1097 GNUNET_NETWORK_fdset_set (plugin->ws, plugin->unix_sock.desc);
1099 reschedule_select (plugin);
1106 * Function that will be called to check if a binary address for this
1107 * plugin is well-formed and corresponds to an address for THIS peer
1108 * (as per our configuration). Naturally, if absolutely necessary,
1109 * plugins can be a bit conservative in their answer, but in general
1110 * plugins should make sure that the address does not redirect
1111 * traffic to a 3rd party that might try to man-in-the-middle our
1114 * @param cls closure, should be our handle to the Plugin
1115 * @param addr pointer to the address
1116 * @param addrlen length of addr
1117 * @return GNUNET_OK if this is a plausible address for this peer
1118 * and transport, GNUNET_SYSERR if not
1122 unix_check_address (void *cls, const void *addr, size_t addrlen)
1124 LOG (GNUNET_ERROR_TYPE_DEBUG,
1125 "Informing transport service about my address `%s'\n",
1132 * Convert the transports address to a nice, human-readable
1135 * @param cls closure
1136 * @param type name of the transport that generated the address
1137 * @param addr one of the addresses of the host, NULL for the last address
1138 * the specific address format depends on the transport
1139 * @param addrlen length of the address
1140 * @param numeric should (IP) addresses be displayed in numeric form?
1141 * @param timeout after how long should we give up?
1142 * @param asc function to call on each string
1143 * @param asc_cls closure for asc
1146 unix_plugin_address_pretty_printer (void *cls, const char *type,
1147 const void *addr, size_t addrlen,
1149 struct GNUNET_TIME_Relative timeout,
1150 GNUNET_TRANSPORT_AddressStringCallback asc,
1153 if ((NULL != addr) && (addrlen > 0))
1155 asc (asc_cls, (const char *) addr);
1160 asc (asc_cls, "<invalid UNIX address>");
1162 asc (asc_cls, NULL);
1167 * Function called to convert a string address to
1170 * @param cls closure ('struct Plugin*')
1171 * @param addr string address
1172 * @param addrlen length of the address (strlen(addr) + '\0')
1173 * @param buf location to store the buffer
1174 * If the function returns GNUNET_SYSERR, its contents are undefined.
1175 * @param added length of created address
1176 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
1179 unix_string_to_address (void *cls, const char *addr, uint16_t addrlen,
1180 void **buf, size_t *added)
1182 if ((NULL == addr) || (0 == addrlen))
1185 return GNUNET_SYSERR;
1188 if ('\0' != addr[addrlen - 1])
1191 return GNUNET_SYSERR;
1194 if (strlen (addr) != addrlen - 1)
1197 return GNUNET_SYSERR;
1200 (*buf) = strdup (addr);
1201 (*added) = strlen (addr) + 1;
1207 * Function called for a quick conversion of the binary address to
1208 * a numeric address. Note that the caller must not free the
1209 * address and that the next call to this function is allowed
1210 * to override the address again.
1212 * @param cls closure
1213 * @param addr binary address
1214 * @param addrlen length of the address
1215 * @return string representing the same address
1218 unix_address_to_string (void *cls, const void *addr, size_t addrlen)
1220 if ((addr != NULL) && (addrlen > 0))
1221 return (const char *) addr;
1227 * Notify transport service about address
1229 * @param cls the plugin
1233 address_notification (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1235 struct Plugin *plugin = cls;
1237 plugin->env->notify_address (plugin->env->cls, GNUNET_YES,
1238 plugin->unix_socket_path,
1239 strlen (plugin->unix_socket_path) + 1,
1245 * Session was idle, so disconnect it
1248 session_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1250 GNUNET_assert (NULL != cls);
1251 struct Session *s = cls;
1253 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1254 LOG (GNUNET_ERROR_TYPE_DEBUG,
1255 "Session %p was idle for %llu ms, disconnecting\n",
1256 s, (unsigned long long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1257 /* call session destroy function */
1258 disconnect_session(s);
1263 * Start session timeout
1266 start_session_timeout (struct Session *s)
1268 GNUNET_assert (NULL != s);
1269 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == s->timeout_task);
1270 s->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1273 LOG (GNUNET_ERROR_TYPE_DEBUG,
1274 "Timeout for session %p set to %llu ms\n",
1275 s, (unsigned long long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1280 * Increment session timeout due to activity
1283 reschedule_session_timeout (struct Session *s)
1285 GNUNET_assert (NULL != s);
1286 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != s->timeout_task);
1288 GNUNET_SCHEDULER_cancel (s->timeout_task);
1289 s->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT,
1292 LOG (GNUNET_ERROR_TYPE_DEBUG,
1293 "Timeout rescheduled for session %p set to %llu ms\n",
1294 s, (unsigned long long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1302 stop_session_timeout (struct Session *s)
1304 GNUNET_assert (NULL != s);
1306 if (GNUNET_SCHEDULER_NO_TASK != s->timeout_task)
1308 GNUNET_SCHEDULER_cancel (s->timeout_task);
1309 s->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1310 LOG (GNUNET_ERROR_TYPE_DEBUG,
1311 "Timeout stopped for session %p canceled\n",
1312 s, (unsigned long long) GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT.rel_value);
1317 * The exported method. Makes the core api available via a global and
1318 * returns the unix transport API.
1321 libgnunet_plugin_transport_unix_init (void *cls)
1323 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1324 unsigned long long port;
1325 struct GNUNET_TRANSPORT_PluginFunctions *api;
1326 struct Plugin *plugin;
1327 int sockets_created;
1329 if (NULL == env->receive)
1331 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
1332 initialze the plugin or the API */
1333 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1335 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1336 api->address_to_string = &unix_address_to_string;
1337 api->string_to_address = &unix_string_to_address;
1340 GNUNET_assert( NULL != env->stats);
1343 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-unix", "PORT",
1345 port = UNIX_NAT_DEFAULT_PORT;
1346 plugin = GNUNET_malloc (sizeof (struct Plugin));
1347 plugin->port = port;
1349 GNUNET_asprintf (&plugin->unix_socket_path, "/tmp/unix-plugin-sock.%d",
1352 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1355 api->get_session = &unix_plugin_get_session;
1356 api->send = &unix_plugin_send;
1357 api->disconnect = &unix_disconnect;
1358 api->address_pretty_printer = &unix_plugin_address_pretty_printer;
1359 api->address_to_string = &unix_address_to_string;
1360 api->check_address = &unix_check_address;
1361 api->string_to_address = &unix_string_to_address;
1362 sockets_created = unix_transport_server_start (plugin);
1363 if (sockets_created == 0)
1364 LOG (GNUNET_ERROR_TYPE_WARNING, _("Failed to open UNIX sockets\n"));
1366 plugin->session_map = GNUNET_CONTAINER_multihashmap_create (10, GNUNET_NO);
1368 GNUNET_SCHEDULER_add_now (address_notification, plugin);
1373 libgnunet_plugin_transport_unix_done (void *cls)
1375 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1376 struct Plugin *plugin = api->cls;
1384 plugin->env->notify_address (plugin->env->cls, GNUNET_NO,
1385 plugin->unix_socket_path,
1386 strlen (plugin->unix_socket_path) + 1,
1389 unix_transport_server_stop (plugin);
1392 GNUNET_CONTAINER_multihashmap_iterate (plugin->session_map, &get_session_delete_it, plugin);
1393 GNUNET_CONTAINER_multihashmap_destroy (plugin->session_map);
1396 if (NULL != plugin->rs)
1397 GNUNET_NETWORK_fdset_destroy (plugin->rs);
1398 if (NULL != plugin->ws)
1399 GNUNET_NETWORK_fdset_destroy (plugin->ws);
1400 GNUNET_free (plugin->unix_socket_path);
1401 GNUNET_free (plugin);
1406 /* end of plugin_transport_unix.c */