2 This file is part of GNUnet
3 (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 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.
21 * @file transport/plugin_transport_tcp.c
22 * @brief Implementation of the TCP transport service
23 * @author Christian Grothoff
26 #include "gnunet_hello_lib.h"
27 #include "gnunet_constants.h"
28 #include "gnunet_connection_lib.h"
29 #include "gnunet_container_lib.h"
30 #include "gnunet_nat_lib.h"
31 #include "gnunet_os_lib.h"
32 #include "gnunet_protocols.h"
33 #include "gnunet_resolver_service.h"
34 #include "gnunet_server_lib.h"
35 #include "gnunet_service_lib.h"
36 #include "gnunet_signatures.h"
37 #include "gnunet_statistics_service.h"
38 #include "gnunet_transport_service.h"
39 #include "gnunet_transport_plugin.h"
40 #include "transport.h"
42 #define DEBUG_TCP GNUNET_EXTRA_LOGGING
44 #define DEBUG_TCP_NAT GNUNET_EXTRA_LOGGING
46 GNUNET_NETWORK_STRUCT_BEGIN
49 * Initial handshake message for a session.
54 * Type is GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME.
56 struct GNUNET_MessageHeader header;
59 * Identity of the node connecting (TCP client)
61 struct GNUNET_PeerIdentity clientIdentity;
67 * Basically a WELCOME message, but with the purpose
68 * of giving the waiting peer a client handle to use
70 struct TCP_NAT_ProbeMessage
73 * Type is GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE.
75 struct GNUNET_MessageHeader header;
78 * Identity of the sender of the message.
80 struct GNUNET_PeerIdentity clientIdentity;
83 GNUNET_NETWORK_STRUCT_END
86 * Context for sending a NAT probe via TCP.
88 struct TCPProbeContext
92 * Active probes are kept in a DLL.
94 struct TCPProbeContext *next;
97 * Active probes are kept in a DLL.
99 struct TCPProbeContext *prev;
104 struct GNUNET_CONNECTION_Handle *sock;
107 * Message to be sent.
109 struct TCP_NAT_ProbeMessage message;
112 * Handle to the transmission.
114 struct GNUNET_CONNECTION_TransmitHandle *transmit_handle;
117 * Transport plugin handle.
119 struct Plugin *plugin;
123 GNUNET_NETWORK_STRUCT_BEGIN
126 * Network format for IPv4 addresses.
128 struct IPv4TcpAddress
131 * IPv4 address, in network byte order.
133 uint32_t ipv4_addr GNUNET_PACKED;
136 * Port number, in network byte order.
138 uint16_t t4_port GNUNET_PACKED;
144 * Network format for IPv6 addresses.
146 struct IPv6TcpAddress
151 struct in6_addr ipv6_addr GNUNET_PACKED;
154 * Port number, in network byte order.
156 uint16_t t6_port GNUNET_PACKED;
159 GNUNET_NETWORK_STRUCT_END
162 * Encapsulation of all of the state of the plugin.
168 * Information kept for each message that is yet to
171 struct PendingMessage
175 * This is a doubly-linked list.
177 struct PendingMessage *next;
180 * This is a doubly-linked list.
182 struct PendingMessage *prev;
185 * The pending message
190 * Continuation function to call once the message
191 * has been sent. Can be NULL if there is no
192 * continuation to call.
194 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
197 * Closure for transmit_cont.
199 void *transmit_cont_cls;
202 * Timeout value for the pending message.
204 struct GNUNET_TIME_Absolute timeout;
207 * So that the gnunet-service-transport can group messages together,
208 * these pending messages need to accept a message buffer and size
209 * instead of just a GNUNET_MessageHeader.
217 * Session handle for TCP connections.
225 struct SessionHeader header;
228 * Stored in a linked list.
230 struct Session *next;
233 * Pointer to the global plugin struct.
235 struct Plugin *plugin;
238 * The client (used to identify this connection)
240 struct GNUNET_SERVER_Client *client;
243 * Messages currently pending for transmission
244 * to this peer, if any.
246 struct PendingMessage *pending_messages_head;
249 * Messages currently pending for transmission
250 * to this peer, if any.
252 struct PendingMessage *pending_messages_tail;
255 * Handle for pending transmission request.
257 struct GNUNET_CONNECTION_TransmitHandle *transmit_handle;
260 * To whom are we talking to (set to our identity
261 * if we are still waiting for the welcome message)
263 struct GNUNET_PeerIdentity target;
266 * ID of task used to delay receiving more to throttle sender.
268 GNUNET_SCHEDULER_TaskIdentifier receive_delay_task;
271 * Address of the other peer (either based on our 'connect'
272 * call or on our 'accept' call).
277 * Last activity on this connection. Used to select preferred
280 struct GNUNET_TIME_Absolute last_activity;
283 * Length of connect_addr.
288 * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
290 int expecting_welcome;
293 * Was this a connection that was inbound (we accepted)? (GNUNET_YES/GNUNET_NO)
298 * Was this session created using NAT traversal?
303 * ATS network type in NBO
305 uint32_t ats_address_network_type;
310 * Encapsulation of all of the state of the plugin.
317 struct GNUNET_TRANSPORT_PluginEnvironment *env;
322 struct GNUNET_CONNECTION_Handle *lsock;
325 * Our handle to the NAT module.
327 struct GNUNET_NAT_Handle *nat;
330 * List of open TCP sessions.
332 struct Session *sessions;
334 struct GNUNET_CONTAINER_MultiHashMap * sessionmap;
337 * Handle to the network service.
339 struct GNUNET_SERVICE_Context *service;
342 * Handle to the server for this service.
344 struct GNUNET_SERVER_Handle *server;
347 * Copy of the handler array where the closures are
348 * set to this struct's instance.
350 struct GNUNET_SERVER_MessageHandler *handlers;
353 * Map of peers we have tried to contact behind a NAT
355 struct GNUNET_CONTAINER_MultiHashMap *nat_wait_conns;
358 * List of active TCP probes.
360 struct TCPProbeContext *probe_head;
363 * List of active TCP probes.
365 struct TCPProbeContext *probe_tail;
368 * Handle for (DYN)DNS lookup of our external IP.
370 struct GNUNET_RESOLVER_RequestHandle *ext_dns;
373 * How many more TCP sessions are we allowed to open right now?
375 unsigned long long max_connections;
378 * ID of task used to update our addresses when one expires.
380 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
383 * Port that we are actually listening on.
388 * Port that the user said we would have visible to the
397 * Function to check if an inbound connection is acceptable.
398 * Mostly used to limit the total number of open connections
401 * @param cls the 'struct Plugin'
402 * @param ucred credentials, if available, otherwise NULL
403 * @param addr address
404 * @param addrlen length of address
405 * @return GNUNET_YES to allow, GNUNET_NO to deny, GNUNET_SYSERR
406 * for unknown address family (will be denied).
409 plugin_tcp_access_check (void *cls,
410 const struct GNUNET_CONNECTION_Credentials *ucred,
411 const struct sockaddr *addr, socklen_t addrlen)
413 struct Plugin *plugin = cls;
415 if (0 == plugin->max_connections)
417 plugin->max_connections--;
423 * Our external IP address/port mapping has changed.
425 * @param cls closure, the 'struct LocalAddrList'
426 * @param add_remove GNUNET_YES to mean the new public IP address, GNUNET_NO to mean
427 * the previous (now invalid) one
428 * @param addr either the previous or the new public IP address
429 * @param addrlen actual lenght of the address
432 tcp_nat_port_map_callback (void *cls, int add_remove,
433 const struct sockaddr *addr, socklen_t addrlen)
435 struct Plugin *plugin = cls;
436 struct IPv4TcpAddress t4;
437 struct IPv6TcpAddress t6;
441 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
442 "NPMC called with %d for address `%s'\n", add_remove,
443 GNUNET_a2s (addr, addrlen));
444 /* convert 'addr' to our internal format */
445 switch (addr->sa_family)
448 GNUNET_assert (addrlen == sizeof (struct sockaddr_in));
449 t4.ipv4_addr = ((struct sockaddr_in *) addr)->sin_addr.s_addr;
450 t4.t4_port = ((struct sockaddr_in *) addr)->sin_port;
455 GNUNET_assert (addrlen == sizeof (struct sockaddr_in6));
456 memcpy (&t6.ipv6_addr, &((struct sockaddr_in6 *) addr)->sin6_addr,
457 sizeof (struct in6_addr));
458 t6.t6_port = ((struct sockaddr_in6 *) addr)->sin6_port;
466 /* modify our published address list */
467 plugin->env->notify_address (plugin->env->cls, add_remove, arg, args);
472 * Function called for a quick conversion of the binary address to
473 * a numeric address. Note that the caller must not free the
474 * address and that the next call to this function is allowed
475 * to override the address again.
477 * @param cls closure ('struct Plugin*')
478 * @param addr binary address
479 * @param addrlen length of the address
480 * @return string representing the same address
483 tcp_address_to_string (void *cls, const void *addr, size_t addrlen)
485 static char rbuf[INET6_ADDRSTRLEN + 12];
486 char buf[INET6_ADDRSTRLEN];
490 const struct IPv4TcpAddress *t4;
491 const struct IPv6TcpAddress *t6;
495 if (addrlen == sizeof (struct IPv6TcpAddress))
499 port = ntohs (t6->t6_port);
500 memcpy (&a6, &t6->ipv6_addr, sizeof (a6));
503 else if (addrlen == sizeof (struct IPv4TcpAddress))
507 port = ntohs (t4->t4_port);
508 memcpy (&a4, &t4->ipv4_addr, sizeof (a4));
513 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "tcp",
514 _("Unexpected address length: %u bytes\n"),
515 (unsigned int) addrlen);
519 if (NULL == inet_ntop (af, sb, buf, INET6_ADDRSTRLEN))
521 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "inet_ntop");
524 GNUNET_snprintf (rbuf, sizeof (rbuf), (af == AF_INET6) ? "[%s]:%u" : "%s:%u",
531 * Find the session handle for the given client.
533 * @param plugin the plugin
534 * @param client which client to find the session handle for
535 * @return NULL if no matching session exists
537 static struct Session *
538 find_session_by_client (struct Plugin *plugin,
539 const struct GNUNET_SERVER_Client *client)
543 ret = plugin->sessions;
544 while ((ret != NULL) && (client != ret->client))
551 * Create a new session. Also queues a welcome message.
553 * @param plugin the plugin
554 * @param target peer to connect to
555 * @param client client to use
556 * @param is_nat this a NAT session, we should wait for a client to
557 * connect to us from an address, then assign that to
559 * @return new session object
561 static struct Session *
562 create_session (struct Plugin *plugin, const struct GNUNET_PeerIdentity *target,
563 struct GNUNET_SERVER_Client *client, int is_nat)
566 struct PendingMessage *pm;
567 struct WelcomeMessage welcome;
569 if (is_nat != GNUNET_YES)
570 GNUNET_assert (client != NULL);
572 GNUNET_assert (client == NULL);
574 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
575 "Creating new session for peer `%4s'\n",
576 GNUNET_i2s (target));
578 ret = GNUNET_malloc (sizeof (struct Session));
579 ret->last_activity = GNUNET_TIME_absolute_get ();
580 ret->plugin = plugin;
581 ret->is_nat = is_nat;
582 if (is_nat != GNUNET_YES) /* If not a NAT WAIT conn, add it to global list */
584 ret->next = plugin->sessions;
585 plugin->sessions = ret;
587 ret->client = client;
588 ret->target = *target;
589 ret->expecting_welcome = GNUNET_YES;
590 ret->ats_address_network_type = htonl (GNUNET_ATS_NET_UNSPECIFIED);
591 pm = GNUNET_malloc (sizeof (struct PendingMessage) +
592 sizeof (struct WelcomeMessage));
593 pm->msg = (const char *) &pm[1];
594 pm->message_size = sizeof (struct WelcomeMessage);
595 welcome.header.size = htons (sizeof (struct WelcomeMessage));
596 welcome.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME);
597 welcome.clientIdentity = *plugin->env->my_identity;
598 memcpy (&pm[1], &welcome, sizeof (welcome));
599 pm->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
600 GNUNET_STATISTICS_update (plugin->env->stats,
601 gettext_noop ("# bytes currently in TCP buffers"),
602 pm->message_size, GNUNET_NO);
603 GNUNET_CONTAINER_DLL_insert (ret->pending_messages_head,
604 ret->pending_messages_tail, pm);
605 if (is_nat != GNUNET_YES)
606 GNUNET_STATISTICS_update (plugin->env->stats,
607 gettext_noop ("# TCP sessions active"), 1,
614 * If we have pending messages, ask the server to
615 * transmit them (schedule the respective tasks, etc.)
617 * @param session for which session should we do this
620 process_pending_messages (struct Session *session);
624 * Function called to notify a client about the socket
625 * being ready to queue more data. "buf" will be
626 * NULL and "size" zero if the socket was closed for
627 * writing in the meantime.
630 * @param size number of bytes available in buf
631 * @param buf where the callee should write the message
632 * @return number of bytes written to buf
635 do_transmit (void *cls, size_t size, void *buf)
637 struct Session *session = cls;
638 struct GNUNET_PeerIdentity pid;
639 struct Plugin *plugin;
640 struct PendingMessage *pos;
641 struct PendingMessage *hd;
642 struct PendingMessage *tl;
643 struct GNUNET_TIME_Absolute now;
647 GNUNET_assert (session != NULL);
648 session->transmit_handle = NULL;
649 plugin = session->plugin;
653 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
654 "Timeout trying to transmit to peer `%4s', discarding message queue.\n",
655 GNUNET_i2s (&session->target));
657 /* timeout; cancel all messages that have already expired */
661 now = GNUNET_TIME_absolute_get ();
662 while ((NULL != (pos = session->pending_messages_head)) &&
663 (pos->timeout.abs_value <= now.abs_value))
665 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
666 session->pending_messages_tail, pos);
668 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
669 "Failed to transmit %u byte message to `%4s'.\n",
670 pos->message_size, GNUNET_i2s (&session->target));
672 ret += pos->message_size;
673 GNUNET_CONTAINER_DLL_insert_after (hd, tl, tl, pos);
675 /* do this call before callbacks (so that if callbacks destroy
676 * session, they have a chance to cancel actions done by this
678 process_pending_messages (session);
679 pid = session->target;
680 /* no do callbacks and do not use session again since
681 * the callbacks may abort the session */
682 while (NULL != (pos = hd))
684 GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
685 if (pos->transmit_cont != NULL)
686 pos->transmit_cont (pos->transmit_cont_cls, &pid, GNUNET_SYSERR);
689 GNUNET_STATISTICS_update (plugin->env->stats,
690 gettext_noop ("# bytes currently in TCP buffers"),
691 -(int64_t) ret, GNUNET_NO);
692 GNUNET_STATISTICS_update (plugin->env->stats,
694 ("# bytes discarded by TCP (timeout)"), ret,
698 /* copy all pending messages that would fit */
703 while (NULL != (pos = session->pending_messages_head))
705 if (ret + pos->message_size > size)
707 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
708 session->pending_messages_tail, pos);
709 GNUNET_assert (size >= pos->message_size);
710 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
711 "Transmitting message of type %u\n",
712 ntohs (((struct GNUNET_MessageHeader *) pos->msg)->type));
713 /* FIXME: this memcpy can be up to 7% of our total runtime */
714 memcpy (cbuf, pos->msg, pos->message_size);
715 cbuf += pos->message_size;
716 ret += pos->message_size;
717 size -= pos->message_size;
718 GNUNET_CONTAINER_DLL_insert_tail (hd, tl, pos);
720 /* schedule 'continuation' before callbacks so that callbacks that
721 * cancel everything don't cause us to use a session that no longer
723 process_pending_messages (session);
724 session->last_activity = GNUNET_TIME_absolute_get ();
725 pid = session->target;
726 /* we'll now call callbacks that may cancel the session; hence
727 * we should not use 'session' after this point */
728 while (NULL != (pos = hd))
730 GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
731 if (pos->transmit_cont != NULL)
732 pos->transmit_cont (pos->transmit_cont_cls, &pid, GNUNET_OK);
735 GNUNET_assert (hd == NULL);
736 GNUNET_assert (tl == NULL);
738 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp", "Transmitting %u bytes\n",
741 GNUNET_STATISTICS_update (plugin->env->stats,
742 gettext_noop ("# bytes currently in TCP buffers"),
743 -(int64_t) ret, GNUNET_NO);
744 GNUNET_STATISTICS_update (plugin->env->stats,
745 gettext_noop ("# bytes transmitted via TCP"), ret,
752 * If we have pending messages, ask the server to
753 * transmit them (schedule the respective tasks, etc.)
755 * @param session for which session should we do this
758 process_pending_messages (struct Session *session)
760 struct PendingMessage *pm;
762 GNUNET_assert (session->client != NULL);
763 if (session->transmit_handle != NULL)
765 if (NULL == (pm = session->pending_messages_head))
768 session->transmit_handle =
769 GNUNET_SERVER_notify_transmit_ready (session->client, pm->message_size,
770 GNUNET_TIME_absolute_get_remaining
771 (pm->timeout), &do_transmit,
777 * Functions with this signature are called whenever we need
778 * to close a session due to a disconnect or failure to
779 * establish a connection.
781 * @param session session to close down
784 disconnect_session (struct Session *session)
786 struct Session *prev;
788 struct PendingMessage *pm;
791 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
792 "Disconnecting from `%4s' at %s.\n",
793 GNUNET_i2s (&session->target),
794 (session->connect_addr !=
795 NULL) ? tcp_address_to_string (session->plugin,
796 session->connect_addr,
797 session->connect_alen) :
800 /* remove from session list */
802 pos = session->plugin->sessions;
803 while (pos != session)
809 session->plugin->sessions = session->next;
811 prev->next = session->next;
814 if (session->transmit_handle != NULL)
816 GNUNET_CONNECTION_notify_transmit_ready_cancel (session->transmit_handle);
817 session->transmit_handle = NULL;
819 session->plugin->env->session_end (session->plugin->env->cls,
820 &session->target, session);
821 while (NULL != (pm = session->pending_messages_head))
824 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
826 NULL ? "Could not deliver message to `%4s'.\n" :
827 "Could not deliver message to `%4s', notifying.\n",
828 GNUNET_i2s (&session->target));
830 GNUNET_STATISTICS_update (session->plugin->env->stats,
831 gettext_noop ("# bytes currently in TCP buffers"),
832 -(int64_t) pm->message_size, GNUNET_NO);
833 GNUNET_STATISTICS_update (session->plugin->env->stats,
835 ("# bytes discarded by TCP (disconnect)"),
836 pm->message_size, GNUNET_NO);
837 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
838 session->pending_messages_tail, pm);
839 if (NULL != pm->transmit_cont)
840 pm->transmit_cont (pm->transmit_cont_cls, &session->target,
844 GNUNET_break (session->client != NULL);
845 if (session->receive_delay_task != GNUNET_SCHEDULER_NO_TASK)
847 GNUNET_SCHEDULER_cancel (session->receive_delay_task);
848 if (session->client != NULL)
849 GNUNET_SERVER_receive_done (session->client, GNUNET_SYSERR);
851 if (session->client != NULL)
853 GNUNET_SERVER_client_drop (session->client);
854 session->client = NULL;
856 GNUNET_STATISTICS_update (session->plugin->env->stats,
857 gettext_noop ("# TCP sessions active"), -1,
859 GNUNET_free_non_null (session->connect_addr);
860 GNUNET_assert (NULL == session->transmit_handle);
861 GNUNET_free (session);
866 * Given two otherwise equivalent sessions, pick the better one.
868 * @param s1 one session (also default)
869 * @param s2 other session
870 * @return "better" session (more active)
872 static struct Session *
873 select_better_session (struct Session *s1, struct Session *s2)
879 if ((s1->expecting_welcome == GNUNET_NO) &&
880 (s2->expecting_welcome == GNUNET_YES))
882 if ((s1->expecting_welcome == GNUNET_YES) &&
883 (s2->expecting_welcome == GNUNET_NO))
885 if (s1->last_activity.abs_value < s2->last_activity.abs_value)
887 if (s1->last_activity.abs_value > s2->last_activity.abs_value)
889 if ((GNUNET_YES == s1->inbound) && (GNUNET_NO == s2->inbound))
891 if ((GNUNET_NO == s1->inbound) && (GNUNET_YES == s2->inbound))
899 * Function that can be used by the transport service to transmit
900 * a message using the plugin. Note that in the case of a
901 * peer disconnecting, the continuation MUST be called
902 * prior to the disconnect notification itself. This function
903 * will be called with this peer's HELLO message to initiate
904 * a fresh connection to another peer.
907 * @param target who should receive this message
908 * @param msg the message to transmit
909 * @param msgbuf_size number of bytes in 'msg'
910 * @param priority how important is the message (most plugins will
911 * ignore message priority and just FIFO)
912 * @param timeout how long to wait at most for the transmission (does not
913 * require plugins to discard the message after the timeout,
914 * just advisory for the desired delay; most plugins will ignore
916 * @param session which session must be used (or NULL for "any")
917 * @param addr the address to use (can be NULL if the plugin
918 * is "on its own" (i.e. re-use existing TCP connection))
919 * @param addrlen length of the address in bytes
920 * @param force_address GNUNET_YES if the plugin MUST use the given address,
921 * GNUNET_NO means the plugin may use any other address and
922 * GNUNET_SYSERR means that only reliable existing
923 * bi-directional connections should be used (regardless
925 * @param cont continuation to call once the message has
926 * been transmitted (or if the transport is ready
927 * for the next transmission call; or if the
928 * peer disconnected...); can be NULL
929 * @param cont_cls closure for cont
930 * @return number of bytes used (on the physical network, with overheads);
931 * -1 on hard errors (i.e. address invalid); 0 is a legal value
932 * and does NOT mean that the message was not transmitted (DV and NAT)
935 tcp_plugin_send_old (void *cls, const struct GNUNET_PeerIdentity *target,
936 const char *msg, size_t msgbuf_size, uint32_t priority,
937 struct GNUNET_TIME_Relative timeout, struct Session *session,
938 const void *addr, size_t addrlen, int force_address,
939 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
941 struct Plugin *plugin = cls;
942 struct Session *cand_session;
943 struct Session *next;
944 struct PendingMessage *pm;
945 struct GNUNET_CONNECTION_Handle *sa;
949 struct sockaddr_in a4;
950 struct sockaddr_in6 a6;
951 const struct IPv4TcpAddress *t4;
952 const struct IPv6TcpAddress *t6;
953 unsigned int is_natd;
955 GNUNET_STATISTICS_update (plugin->env->stats,
956 gettext_noop ("# bytes TCP was asked to transmit"),
957 msgbuf_size, GNUNET_NO);
958 /* FIXME: we could do this cheaper with a hash table
959 * where we could restrict the iteration to entries that match
960 * the target peer... */
965 next = plugin->sessions;
966 while (NULL != (session = next))
968 next = session->next;
969 GNUNET_assert (session->client != NULL);
971 memcmp (target, &session->target,
972 sizeof (struct GNUNET_PeerIdentity)))
974 if (((GNUNET_SYSERR == force_address) &&
975 (session->expecting_welcome == GNUNET_NO)) ||
976 (GNUNET_NO == force_address))
978 cand_session = select_better_session (cand_session, session);
981 if (GNUNET_SYSERR == force_address)
983 GNUNET_break (GNUNET_YES == force_address);
989 if ((addrlen != session->connect_alen) && (session->is_nat == GNUNET_NO))
991 if ((0 != memcmp (session->connect_addr, addr, addrlen)) &&
992 (session->is_nat == GNUNET_NO))
994 cand_session = select_better_session (cand_session, session);
996 session = cand_session;
998 if ((session == NULL) && (addrlen == 0))
1001 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1002 "Asked to transmit to `%4s' without address and I have no existing connection (failing).\n",
1003 GNUNET_i2s (target));
1005 GNUNET_STATISTICS_update (plugin->env->stats,
1007 ("# bytes discarded by TCP (no address and no connection)"),
1008 msgbuf_size, GNUNET_NO);
1011 if (session == NULL)
1013 if (addrlen == sizeof (struct IPv6TcpAddress))
1015 GNUNET_assert (NULL != addr); /* make static analysis happy */
1018 memset (&a6, 0, sizeof (a6));
1019 #if HAVE_SOCKADDR_IN_SIN_LEN
1020 a6.sin6_len = sizeof (a6);
1022 a6.sin6_family = AF_INET6;
1023 a6.sin6_port = t6->t6_port;
1024 if (t6->t6_port == 0)
1025 is_natd = GNUNET_YES;
1026 memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof (struct in6_addr));
1030 else if (addrlen == sizeof (struct IPv4TcpAddress))
1032 GNUNET_assert (NULL != addr); /* make static analysis happy */
1035 memset (&a4, 0, sizeof (a4));
1036 #if HAVE_SOCKADDR_IN_SIN_LEN
1037 a4.sin_len = sizeof (a4);
1039 a4.sin_family = AF_INET;
1040 a4.sin_port = t4->t4_port;
1041 if (t4->t4_port == 0)
1042 is_natd = GNUNET_YES;
1043 a4.sin_addr.s_addr = t4->ipv4_addr;
1049 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "tcp",
1050 _("Address of unexpected length: %u\n"), addrlen);
1055 if ((is_natd == GNUNET_YES) && (addrlen == sizeof (struct IPv6TcpAddress)))
1056 return -1; /* NAT client only works with IPv4 addresses */
1057 if (0 == plugin->max_connections)
1058 return -1; /* saturated */
1060 if ((is_natd == GNUNET_YES) && (NULL != plugin->nat) &&
1062 GNUNET_CONTAINER_multihashmap_contains (plugin->nat_wait_conns,
1063 &target->hashPubKey)))
1066 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1067 _("Found valid IPv4 NAT address (creating session)!\n"));
1069 session = create_session (plugin, target, NULL, GNUNET_YES);
1070 GNUNET_assert (session != NULL);
1072 /* create new message entry */
1073 pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
1074 /* FIXME: the memset of this malloc can be up to 2% of our total runtime */
1075 pm->msg = (const char *) &pm[1];
1076 memcpy (&pm[1], msg, msgbuf_size);
1077 /* FIXME: this memcpy can be up to 7% of our total run-time
1078 * (for transport service) */
1079 pm->message_size = msgbuf_size;
1080 pm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1081 pm->transmit_cont = cont;
1082 pm->transmit_cont_cls = cont_cls;
1084 /* append pm to pending_messages list */
1085 GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1086 session->pending_messages_tail, pm);
1088 GNUNET_assert (GNUNET_CONTAINER_multihashmap_put
1089 (plugin->nat_wait_conns, &target->hashPubKey, session,
1090 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY) ==
1093 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1094 "Created NAT WAIT connection to `%4s' at `%s'\n",
1095 GNUNET_i2s (target), GNUNET_a2s (sb, sbs));
1097 GNUNET_NAT_run_client (plugin->nat, &a4);
1100 if ((is_natd == GNUNET_YES) &&
1102 GNUNET_CONTAINER_multihashmap_contains (plugin->nat_wait_conns,
1103 &target->hashPubKey)))
1105 /* Only do one NAT punch attempt per peer identity */
1108 sa = GNUNET_CONNECTION_create_from_sockaddr (af, sb, sbs);
1112 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1113 "Failed to create connection to `%4s' at `%s'\n",
1114 GNUNET_i2s (target), GNUNET_a2s (sb, sbs));
1116 GNUNET_STATISTICS_update (plugin->env->stats,
1118 ("# bytes discarded by TCP (failed to connect)"),
1119 msgbuf_size, GNUNET_NO);
1122 GNUNET_assert (0 != plugin->max_connections);
1123 plugin->max_connections--;
1125 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1126 "Asked to transmit to `%4s', creating fresh session using address `%s'.\n",
1127 GNUNET_i2s (target), GNUNET_a2s (sb, sbs));
1130 create_session (plugin, target,
1131 GNUNET_SERVER_connect_socket (plugin->server, sa),
1133 session->connect_addr = GNUNET_malloc (addrlen);
1134 memcpy (session->connect_addr, addr, addrlen);
1135 session->connect_alen = addrlen;
1138 struct GNUNET_ATS_Information ats;
1139 ats = plugin->env->get_address_type (plugin->env->cls, sb ,sbs);
1140 session->ats_address_network_type = ats.value;
1145 else /* session != NULL */
1147 /* check if session is valid */
1148 struct Session *ses = plugin->sessions;
1151 memcmp (target, &session->target, sizeof (struct GNUNET_PeerIdentity)))
1154 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1155 "Got session %p for `%s', but should be for peer `%s'!\n",
1156 session, GNUNET_i2s (&session->target),
1157 GNUNET_h2s (&target->hashPubKey));
1161 while ((ses != NULL) && (ses != session))
1168 GNUNET_assert (session != NULL);
1169 GNUNET_assert (session->client != NULL);
1170 GNUNET_SERVER_client_set_timeout (session->client,
1171 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1172 GNUNET_STATISTICS_update (plugin->env->stats,
1173 gettext_noop ("# bytes currently in TCP buffers"),
1174 msgbuf_size, GNUNET_NO);
1175 /* create new message entry */
1176 pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
1177 pm->msg = (const char *) &pm[1];
1178 memcpy (&pm[1], msg, msgbuf_size);
1179 pm->message_size = msgbuf_size;
1180 pm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1181 pm->transmit_cont = cont;
1182 pm->transmit_cont_cls = cont_cls;
1184 /* append pm to pending_messages list */
1185 GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1186 session->pending_messages_tail, pm);
1188 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1189 "Asked to transmit %u bytes to `%s', added message to list.\n",
1190 msgbuf_size, GNUNET_i2s (target));
1192 process_pending_messages (session);
1197 * Function that can be used by the transport service to transmit
1198 * a message using the plugin. Note that in the case of a
1199 * peer disconnecting, the continuation MUST be called
1200 * prior to the disconnect notification itself. This function
1201 * will be called with this peer's HELLO message to initiate
1202 * a fresh connection to another peer.
1204 * @param cls closure
1205 * @param session which session must be used
1206 * @param msgbuf the message to transmit
1207 * @param msgbuf_size number of bytes in 'msgbuf'
1208 * @param priority how important is the message (most plugins will
1209 * ignore message priority and just FIFO)
1210 * @param to how long to wait at most for the transmission (does not
1211 * require plugins to discard the message after the timeout,
1212 * just advisory for the desired delay; most plugins will ignore
1214 * @param cont continuation to call once the message has
1215 * been transmitted (or if the transport is ready
1216 * for the next transmission call; or if the
1217 * peer disconnected...); can be NULL
1218 * @param cont_cls closure for cont
1219 * @return number of bytes used (on the physical network, with overheads);
1220 * -1 on hard errors (i.e. address invalid); 0 is a legal value
1221 * and does NOT mean that the message was not transmitted (DV)
1224 tcp_plugin_send (void *cls,
1225 struct Session *session,
1226 const char *msgbuf, size_t msgbuf_size,
1227 unsigned int priority,
1228 struct GNUNET_TIME_Relative to,
1229 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
1231 struct Plugin * plugin = cls;
1232 struct PendingMessage *pm;
1234 GNUNET_assert (plugin != NULL);
1235 GNUNET_assert (session != NULL);
1236 GNUNET_assert (session->client != NULL);
1238 GNUNET_SERVER_client_set_timeout (session->client,
1239 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1240 GNUNET_STATISTICS_update (plugin->env->stats,
1241 gettext_noop ("# bytes currently in TCP buffers"),
1242 msgbuf_size, GNUNET_NO);
1243 /* create new message entry */
1244 pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
1245 pm->msg = (const char *) &pm[1];
1246 memcpy (&pm[1], msgbuf, msgbuf_size);
1247 pm->message_size = msgbuf_size;
1248 pm->timeout = GNUNET_TIME_relative_to_absolute (to);
1249 pm->transmit_cont = cont;
1250 pm->transmit_cont_cls = cont_cls;
1252 /* append pm to pending_messages list */
1253 GNUNET_CONTAINER_DLL_insert_tail (session->pending_messages_head,
1254 session->pending_messages_tail, pm);
1256 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1257 "Asked to transmit %u bytes to `%s', added message to list.\n",
1258 msgbuf_size, GNUNET_i2s (&session->target));
1260 process_pending_messages (session);
1268 struct Session * result;
1271 int session_it (void *cls,
1272 const GNUNET_HashCode * key,
1275 struct SessionItCtx * si_ctx = cls;
1276 struct Session * session = value;
1278 if (session->connect_alen != si_ctx->addrlen)
1280 if (0 != memcmp (&session->connect_addr, si_ctx->addr, si_ctx->addrlen))
1283 /* Found existing session */
1284 si_ctx->result = session;
1290 * Create a new session to transmit data to the target
1291 * This session will used to send data to this peer and the plugin will
1292 * notify us by calling the env->session_end function
1294 * @param cls closure
1295 * @param target the neighbour id
1296 * @param addr pointer to the address
1297 * @param addrlen length of addr
1298 * @return the session if the address is valid, NULL otherwise
1300 static struct Session *
1301 tcp_plugin_get_session (void *cls,
1302 const struct GNUNET_HELLO_Address *address)
1304 struct Plugin * plugin = cls;
1305 struct Session * session = NULL;
1310 struct GNUNET_CONNECTION_Handle *sa;
1311 struct sockaddr_in a4;
1312 struct sockaddr_in6 a6;
1313 const struct IPv4TcpAddress *t4;
1314 const struct IPv6TcpAddress *t6;
1315 unsigned int is_natd = GNUNET_NO;
1316 size_t addrlen = address->address_length;
1318 GNUNET_assert (plugin != NULL);
1319 GNUNET_assert (address != NULL);
1321 if (addrlen == sizeof (struct IPv6TcpAddress))
1323 GNUNET_assert (NULL != address->address); /* make static analysis happy */
1324 t6 = address->address;
1326 memset (&a6, 0, sizeof (a6));
1327 #if HAVE_SOCKADDR_IN_SIN_LEN
1328 a6.sin6_len = sizeof (a6);
1330 a6.sin6_family = AF_INET6;
1331 a6.sin6_port = t6->t6_port;
1332 if (t6->t6_port == 0)
1333 is_natd = GNUNET_YES;
1334 memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof (struct in6_addr));
1338 else if (addrlen == sizeof (struct IPv4TcpAddress))
1340 GNUNET_assert (NULL != address->address); /* make static analysis happy */
1341 t4 = address->address;
1343 memset (&a4, 0, sizeof (a4));
1344 #if HAVE_SOCKADDR_IN_SIN_LEN
1345 a4.sin_len = sizeof (a4);
1347 a4.sin_family = AF_INET;
1348 a4.sin_port = t4->t4_port;
1349 if (t4->t4_port == 0)
1350 is_natd = GNUNET_YES;
1351 a4.sin_addr.s_addr = t4->ipv4_addr;
1357 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "tcp",
1358 _("Address of unexpected length: %u\n"), addrlen);
1363 /* look for existing session */
1364 if (GNUNET_CONTAINER_multihashmap_contains(plugin->sessionmap, &address->peer.hashPubKey))
1366 struct SessionItCtx si_ctx;
1368 si_ctx.addrlen = sbs;
1369 GNUNET_CONTAINER_multihashmap_get_multiple(plugin->sessionmap, &address->peer.hashPubKey, &session_it, &si_ctx);
1370 if (si_ctx.result != NULL)
1371 session = si_ctx.result;
1375 if ((is_natd == GNUNET_YES) && (addrlen == sizeof (struct IPv6TcpAddress)))
1376 return NULL; /* NAT client only works with IPv4 addresses */
1378 if (0 == plugin->max_connections)
1379 return NULL; /* saturated */
1381 if ((is_natd == GNUNET_YES) &&
1383 GNUNET_CONTAINER_multihashmap_contains (plugin->nat_wait_conns,
1384 &address->peer.hashPubKey)))
1385 return NULL; /* Only do one NAT punch attempt per peer identity */
1387 if ((is_natd == GNUNET_YES) && (NULL != plugin->nat) &&
1389 GNUNET_CONTAINER_multihashmap_contains (plugin->nat_wait_conns,
1390 &address->peer.hashPubKey)))
1393 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1394 _("Found valid IPv4 NAT address (creating session)!\n"));
1396 session = create_session (plugin, &address->peer, NULL, GNUNET_YES);
1397 GNUNET_assert (session != NULL);
1399 GNUNET_assert (GNUNET_CONTAINER_multihashmap_put
1400 (plugin->nat_wait_conns, &address->peer.hashPubKey, session,
1401 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY) == GNUNET_OK);
1403 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1404 "Created NAT WAIT connection to `%4s' at `%s'\n",
1405 GNUNET_i2s (&session->target), GNUNET_a2s (sb, sbs));
1407 GNUNET_NAT_run_client (plugin->nat, &a4);
1411 /* create new outbound session */
1412 GNUNET_assert (0 != plugin->max_connections);
1413 sa = GNUNET_CONNECTION_create_from_sockaddr (af, sb, sbs);
1417 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1418 "Failed to create connection to `%4s' at `%s'\n",
1419 GNUNET_i2s (&session->target), GNUNET_a2s (sb, sbs));
1423 plugin->max_connections--;
1425 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1426 "Asked to transmit to `%4s', creating fresh session using address `%s'.\n",
1427 GNUNET_i2s (&session->target), GNUNET_a2s (sb, sbs));
1429 session = create_session (plugin,
1431 GNUNET_SERVER_connect_socket (plugin->server, sa),
1433 session->connect_addr = GNUNET_malloc (addrlen);
1434 memcpy (session->connect_addr, address->address, addrlen);
1435 session->connect_alen = addrlen;
1438 struct GNUNET_ATS_Information ats;
1439 ats = plugin->env->get_address_type (plugin->env->cls, sb ,sbs);
1440 session->ats_address_network_type = ats.value;
1445 GNUNET_CONTAINER_multihashmap_put(plugin->sessionmap, &address->peer.hashPubKey, session, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
1447 /* Send TCP Welcome */
1448 process_pending_messages (session);
1455 * Function that can be called to force a disconnect from the
1456 * specified neighbour. This should also cancel all previously
1457 * scheduled transmissions. Obviously the transmission may have been
1458 * partially completed already, which is OK. The plugin is supposed
1459 * to close the connection (if applicable) and no longer call the
1460 * transmit continuation(s).
1462 * Finally, plugin MUST NOT call the services's receive function to
1463 * notify the service that the connection to the specified target was
1464 * closed after a getting this call.
1466 * @param cls closure
1467 * @param target peer for which the last transmission is
1471 tcp_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
1473 struct Plugin *plugin = cls;
1474 struct Session *session;
1475 struct Session *next;
1476 struct PendingMessage *pm;
1479 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1480 "Asked to cancel session with `%4s'\n", GNUNET_i2s (target));
1482 next = plugin->sessions;
1483 while (NULL != (session = next))
1485 next = session->next;
1487 memcmp (target, &session->target, sizeof (struct GNUNET_PeerIdentity)))
1489 pm = session->pending_messages_head;
1492 pm->transmit_cont = NULL;
1493 pm->transmit_cont_cls = NULL;
1496 GNUNET_STATISTICS_update (session->plugin->env->stats,
1498 ("# transport-service disconnect requests for TCP"),
1500 disconnect_session (session);
1506 * Context for address to string conversion.
1508 struct PrettyPrinterContext
1511 * Function to call with the result.
1513 GNUNET_TRANSPORT_AddressStringCallback asc;
1516 * Clsoure for 'asc'.
1521 * Port to add after the IP address.
1528 * Append our port and forward the result.
1530 * @param cls the 'struct PrettyPrinterContext*'
1531 * @param hostname hostname part of the address
1534 append_port (void *cls, const char *hostname)
1536 struct PrettyPrinterContext *ppc = cls;
1539 if (hostname == NULL)
1541 ppc->asc (ppc->asc_cls, NULL);
1545 GNUNET_asprintf (&ret, "%s:%d", hostname, ppc->port);
1546 ppc->asc (ppc->asc_cls, ret);
1552 * Convert the transports address to a nice, human-readable
1555 * @param cls closure
1556 * @param type name of the transport that generated the address
1557 * @param addr one of the addresses of the host, NULL for the last address
1558 * the specific address format depends on the transport
1559 * @param addrlen length of the address
1560 * @param numeric should (IP) addresses be displayed in numeric form?
1561 * @param timeout after how long should we give up?
1562 * @param asc function to call on each string
1563 * @param asc_cls closure for asc
1566 tcp_plugin_address_pretty_printer (void *cls, const char *type,
1567 const void *addr, size_t addrlen,
1569 struct GNUNET_TIME_Relative timeout,
1570 GNUNET_TRANSPORT_AddressStringCallback asc,
1573 struct PrettyPrinterContext *ppc;
1576 struct sockaddr_in a4;
1577 struct sockaddr_in6 a6;
1578 const struct IPv4TcpAddress *t4;
1579 const struct IPv6TcpAddress *t6;
1582 if (addrlen == sizeof (struct IPv6TcpAddress))
1585 memset (&a6, 0, sizeof (a6));
1586 a6.sin6_family = AF_INET6;
1587 a6.sin6_port = t6->t6_port;
1588 memcpy (&a6.sin6_addr, &t6->ipv6_addr, sizeof (struct in6_addr));
1589 port = ntohs (t6->t6_port);
1593 else if (addrlen == sizeof (struct IPv4TcpAddress))
1596 memset (&a4, 0, sizeof (a4));
1597 a4.sin_family = AF_INET;
1598 a4.sin_port = t4->t4_port;
1599 a4.sin_addr.s_addr = t4->ipv4_addr;
1600 port = ntohs (t4->t4_port);
1606 /* invalid address */
1607 GNUNET_break_op (0);
1608 asc (asc_cls, NULL);
1611 ppc = GNUNET_malloc (sizeof (struct PrettyPrinterContext));
1613 ppc->asc_cls = asc_cls;
1615 GNUNET_RESOLVER_hostname_get (sb, sbs, !numeric, timeout, &append_port, ppc);
1620 * Check if the given port is plausible (must be either our listen
1621 * port or our advertised port), or any port if we are behind NAT
1622 * and do not have a port open. If it is neither, we return
1625 * @param plugin global variables
1626 * @param in_port port number to check
1627 * @return GNUNET_OK if port is either open_port or adv_port
1630 check_port (struct Plugin *plugin, uint16_t in_port)
1632 if ((in_port == plugin->adv_port) || (in_port == plugin->open_port))
1634 return GNUNET_SYSERR;
1639 * Function that will be called to check if a binary address for this
1640 * plugin is well-formed and corresponds to an address for THIS peer
1641 * (as per our configuration). Naturally, if absolutely necessary,
1642 * plugins can be a bit conservative in their answer, but in general
1643 * plugins should make sure that the address does not redirect
1644 * traffic to a 3rd party that might try to man-in-the-middle our
1647 * @param cls closure, our 'struct Plugin*'
1648 * @param addr pointer to the address
1649 * @param addrlen length of addr
1650 * @return GNUNET_OK if this is a plausible address for this peer
1651 * and transport, GNUNET_SYSERR if not
1654 tcp_plugin_check_address (void *cls, const void *addr, size_t addrlen)
1656 struct Plugin *plugin = cls;
1657 struct IPv4TcpAddress *v4;
1658 struct IPv6TcpAddress *v6;
1660 if ((addrlen != sizeof (struct IPv4TcpAddress)) &&
1661 (addrlen != sizeof (struct IPv6TcpAddress)))
1663 GNUNET_break_op (0);
1664 return GNUNET_SYSERR;
1666 if (addrlen == sizeof (struct IPv4TcpAddress))
1668 v4 = (struct IPv4TcpAddress *) addr;
1669 if (GNUNET_OK != check_port (plugin, ntohs (v4->t4_port)))
1670 return GNUNET_SYSERR;
1672 GNUNET_NAT_test_address (plugin->nat, &v4->ipv4_addr,
1673 sizeof (struct in_addr)))
1674 return GNUNET_SYSERR;
1678 v6 = (struct IPv6TcpAddress *) addr;
1679 if (IN6_IS_ADDR_LINKLOCAL (&v6->ipv6_addr))
1681 GNUNET_break_op (0);
1682 return GNUNET_SYSERR;
1684 if (GNUNET_OK != check_port (plugin, ntohs (v6->t6_port)))
1685 return GNUNET_SYSERR;
1687 GNUNET_NAT_test_address (plugin->nat, &v6->ipv6_addr,
1688 sizeof (struct in6_addr)))
1689 return GNUNET_SYSERR;
1696 * We've received a nat probe from this peer via TCP. Finish
1697 * creating the client session and resume sending of queued
1700 * @param cls closure
1701 * @param client identification of the client
1702 * @param message the actual message
1705 handle_tcp_nat_probe (void *cls, struct GNUNET_SERVER_Client *client,
1706 const struct GNUNET_MessageHeader *message)
1708 struct Plugin *plugin = cls;
1709 struct Session *session;
1710 const struct TCP_NAT_ProbeMessage *tcp_nat_probe;
1713 struct IPv4TcpAddress *t4;
1714 struct IPv6TcpAddress *t6;
1715 const struct sockaddr_in *s4;
1716 const struct sockaddr_in6 *s6;
1719 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp", "received NAT probe\n");
1721 /* We have received a TCP NAT probe, meaning we (hopefully) initiated
1722 * a connection to this peer by running gnunet-nat-client. This peer
1723 * received the punch message and now wants us to use the new connection
1724 * as the default for that peer. Do so and then send a WELCOME message
1725 * so we can really be connected!
1727 if (ntohs (message->size) != sizeof (struct TCP_NAT_ProbeMessage))
1729 GNUNET_break_op (0);
1730 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1734 tcp_nat_probe = (const struct TCP_NAT_ProbeMessage *) message;
1736 memcmp (&tcp_nat_probe->clientIdentity, plugin->env->my_identity,
1737 sizeof (struct GNUNET_PeerIdentity)))
1739 /* refuse connections from ourselves */
1740 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1745 GNUNET_CONTAINER_multihashmap_get (plugin->nat_wait_conns,
1747 clientIdentity.hashPubKey);
1748 if (session == NULL)
1751 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1752 "Did NOT find session for NAT probe!\n");
1754 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1758 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1759 "Found session for NAT probe!\n");
1761 GNUNET_assert (GNUNET_CONTAINER_multihashmap_remove
1762 (plugin->nat_wait_conns,
1763 &tcp_nat_probe->clientIdentity.hashPubKey,
1764 session) == GNUNET_YES);
1765 if (GNUNET_OK != GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
1768 GNUNET_free (session);
1769 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1773 GNUNET_SERVER_client_keep (client);
1774 session->client = client;
1775 session->last_activity = GNUNET_TIME_absolute_get ();
1776 session->inbound = GNUNET_NO;
1779 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1780 "Found address `%s' for incoming connection\n",
1781 GNUNET_a2s (vaddr, alen));
1783 switch (((const struct sockaddr *) vaddr)->sa_family)
1787 t4 = GNUNET_malloc (sizeof (struct IPv4TcpAddress));
1788 t4->t4_port = s4->sin_port;
1789 t4->ipv4_addr = s4->sin_addr.s_addr;
1790 session->connect_addr = t4;
1791 session->connect_alen = sizeof (struct IPv4TcpAddress);
1795 t6 = GNUNET_malloc (sizeof (struct IPv6TcpAddress));
1796 t6->t6_port = s6->sin6_port;
1797 memcpy (&t6->ipv6_addr, &s6->sin6_addr, sizeof (struct in6_addr));
1798 session->connect_addr = t6;
1799 session->connect_alen = sizeof (struct IPv6TcpAddress);
1802 GNUNET_break_op (0);
1804 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1805 "Bad address for incoming connection!\n");
1807 GNUNET_free (vaddr);
1808 GNUNET_SERVER_client_drop (client);
1809 GNUNET_free (session);
1810 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1813 GNUNET_free (vaddr);
1815 session->next = plugin->sessions;
1816 plugin->sessions = session;
1817 GNUNET_STATISTICS_update (plugin->env->stats,
1818 gettext_noop ("# TCP sessions active"), 1,
1820 process_pending_messages (session);
1821 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1826 * We've received a welcome from this peer via TCP. Possibly create a
1827 * fresh client record and send back our welcome.
1829 * @param cls closure
1830 * @param client identification of the client
1831 * @param message the actual message
1834 handle_tcp_welcome (void *cls, struct GNUNET_SERVER_Client *client,
1835 const struct GNUNET_MessageHeader *message)
1837 struct Plugin *plugin = cls;
1838 const struct WelcomeMessage *wm = (const struct WelcomeMessage *) message;
1839 struct Session *session;
1842 struct IPv4TcpAddress *t4;
1843 struct IPv6TcpAddress *t6;
1844 const struct sockaddr_in *s4;
1845 const struct sockaddr_in6 *s6;
1848 memcmp (&wm->clientIdentity, plugin->env->my_identity,
1849 sizeof (struct GNUNET_PeerIdentity)))
1851 /* refuse connections from ourselves */
1852 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1856 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1857 "Received %s message from `%4s'.\n", "WELCOME",
1858 GNUNET_i2s (&wm->clientIdentity));
1860 GNUNET_STATISTICS_update (plugin->env->stats,
1861 gettext_noop ("# TCP WELCOME messages received"), 1,
1863 session = find_session_by_client (plugin, client);
1865 if (session == NULL)
1868 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1869 "Received %s message from a `%4s', creating new session\n",
1870 "WELCOME", GNUNET_i2s (&wm->clientIdentity));
1872 GNUNET_SERVER_client_keep (client);
1873 session = create_session (plugin, &wm->clientIdentity, client, GNUNET_NO);
1874 session->inbound = GNUNET_YES;
1875 if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
1878 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1879 "Found address `%s' for incoming connection\n",
1880 GNUNET_a2s (vaddr, alen));
1883 if (alen == sizeof (struct sockaddr_in))
1886 t4 = GNUNET_malloc (sizeof (struct IPv4TcpAddress));
1887 t4->t4_port = s4->sin_port;
1888 t4->ipv4_addr = s4->sin_addr.s_addr;
1889 session->connect_addr = t4;
1890 session->connect_alen = sizeof (struct IPv4TcpAddress);
1892 else if (alen == sizeof (struct sockaddr_in6))
1895 t6 = GNUNET_malloc (sizeof (struct IPv6TcpAddress));
1896 t6->t6_port = s6->sin6_port;
1897 memcpy (&t6->ipv6_addr, &s6->sin6_addr, sizeof (struct in6_addr));
1898 session->connect_addr = t6;
1899 session->connect_alen = sizeof (struct IPv6TcpAddress);
1902 struct GNUNET_ATS_Information ats;
1903 ats = plugin->env->get_address_type (plugin->env->cls, vaddr ,alen);
1904 session->ats_address_network_type = ats.value;
1906 GNUNET_free (vaddr);
1911 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1912 "Did not obtain TCP socket address for incoming connection\n");
1915 process_pending_messages (session);
1920 if (GNUNET_OK == GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
1922 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
1923 "Found address `%s' (already have session)\n",
1924 GNUNET_a2s (vaddr, alen));
1925 GNUNET_free (vaddr);
1930 if (session->expecting_welcome != GNUNET_YES)
1932 GNUNET_break_op (0);
1933 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1936 session->last_activity = GNUNET_TIME_absolute_get ();
1937 session->expecting_welcome = GNUNET_NO;
1938 GNUNET_SERVER_client_set_timeout (client,
1939 GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT);
1940 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1945 * Task to signal the server that we can continue
1946 * receiving from the TCP client now.
1948 * @param cls the 'struct Session*'
1949 * @param tc task context (unused)
1952 delayed_done (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1954 struct Session *session = cls;
1955 struct GNUNET_TIME_Relative delay;
1956 struct GNUNET_ATS_Information ats;
1958 session->receive_delay_task = GNUNET_SCHEDULER_NO_TASK;
1960 session->plugin->env->receive (session->plugin->env->cls,
1961 &session->target, NULL, &ats, 0, session,
1963 if (delay.rel_value == 0)
1964 GNUNET_SERVER_receive_done (session->client, GNUNET_OK);
1966 session->receive_delay_task =
1967 GNUNET_SCHEDULER_add_delayed (delay, &delayed_done, session);
1972 * We've received data for this peer via TCP. Unbox,
1973 * compute latency and forward.
1975 * @param cls closure
1976 * @param client identification of the client
1977 * @param message the actual message
1980 handle_tcp_data (void *cls, struct GNUNET_SERVER_Client *client,
1981 const struct GNUNET_MessageHeader *message)
1983 struct Plugin *plugin = cls;
1984 struct Session *session;
1985 struct GNUNET_TIME_Relative delay;
1988 type = ntohs (message->type);
1989 if ((GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME == type) ||
1990 (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE == type))
1992 /* We don't want to propagate WELCOME and NAT Probe messages up! */
1993 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1996 session = find_session_by_client (plugin, client);
1997 if ((NULL == session) || (GNUNET_YES == session->expecting_welcome))
1999 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
2002 session->last_activity = GNUNET_TIME_absolute_get ();
2004 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
2005 "Passing %u bytes of type %u from `%4s' to transport service.\n",
2006 (unsigned int) ntohs (message->size),
2007 (unsigned int) ntohs (message->type),
2008 GNUNET_i2s (&session->target));
2010 GNUNET_STATISTICS_update (plugin->env->stats,
2011 gettext_noop ("# bytes received via TCP"),
2012 ntohs (message->size), GNUNET_NO);
2013 struct GNUNET_ATS_Information distance[2];
2015 distance[0].type = htonl (GNUNET_ATS_QUALITY_NET_DISTANCE);
2016 distance[0].value = htonl (1);
2017 distance[1].type = htonl (GNUNET_ATS_NETWORK_TYPE);
2018 distance[1].value = session->ats_address_network_type;
2019 GNUNET_break (ntohl(session->ats_address_network_type) != GNUNET_ATS_NET_UNSPECIFIED);
2022 plugin->env->receive (plugin->env->cls, &session->target, message,
2023 (const struct GNUNET_ATS_Information *) &distance,
2026 session->inbound) ? NULL : session->connect_addr,
2028 session->inbound) ? 0 : session->connect_alen);
2029 if (delay.rel_value == 0)
2031 GNUNET_SERVER_receive_done (client, GNUNET_OK);
2036 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
2037 "Throttling receiving from `%s' for %llu ms\n",
2038 GNUNET_i2s (&session->target),
2039 (unsigned long long) delay.rel_value);
2041 GNUNET_SERVER_disable_receive_done_warning (client);
2042 session->receive_delay_task =
2043 GNUNET_SCHEDULER_add_delayed (delay, &delayed_done, session);
2049 * Functions with this signature are called whenever a peer
2050 * is disconnected on the network level.
2052 * @param cls closure
2053 * @param client identification of the client
2056 disconnect_notify (void *cls, struct GNUNET_SERVER_Client *client)
2058 struct Plugin *plugin = cls;
2059 struct Session *session;
2063 plugin->max_connections++;
2064 session = find_session_by_client (plugin, client);
2065 if (session == NULL)
2066 return; /* unknown, nothing to do */
2068 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "tcp",
2069 "Destroying session of `%4s' with %s due to network-level disconnect.\n",
2070 GNUNET_i2s (&session->target),
2071 (session->connect_addr !=
2072 NULL) ? tcp_address_to_string (session->plugin,
2073 session->connect_addr,
2074 session->connect_alen) :
2077 GNUNET_STATISTICS_update (session->plugin->env->stats,
2079 ("# network-level TCP disconnect events"), 1,
2081 disconnect_session (session);
2086 * We can now send a probe message, copy into buffer to really send.
2088 * @param cls closure, a struct TCPProbeContext
2089 * @param size max size to copy
2090 * @param buf buffer to copy message to
2091 * @return number of bytes copied into buf
2094 notify_send_probe (void *cls, size_t size, void *buf)
2096 struct TCPProbeContext *tcp_probe_ctx = cls;
2097 struct Plugin *plugin = tcp_probe_ctx->plugin;
2100 tcp_probe_ctx->transmit_handle = NULL;
2101 GNUNET_CONTAINER_DLL_remove (plugin->probe_head, plugin->probe_tail,
2105 GNUNET_CONNECTION_destroy (tcp_probe_ctx->sock, GNUNET_NO);
2106 GNUNET_free (tcp_probe_ctx);
2109 GNUNET_assert (size >= sizeof (tcp_probe_ctx->message));
2110 memcpy (buf, &tcp_probe_ctx->message, sizeof (tcp_probe_ctx->message));
2111 GNUNET_SERVER_connect_socket (tcp_probe_ctx->plugin->server,
2112 tcp_probe_ctx->sock);
2113 ret = sizeof (tcp_probe_ctx->message);
2114 GNUNET_free (tcp_probe_ctx);
2120 * Function called by the NAT subsystem suggesting another peer wants
2121 * to connect to us via connection reversal. Try to connect back to the
2124 * @param cls closure
2125 * @param addr address to try
2126 * @param addrlen number of bytes in addr
2129 try_connection_reversal (void *cls, const struct sockaddr *addr,
2132 struct Plugin *plugin = cls;
2133 struct GNUNET_CONNECTION_Handle *sock;
2134 struct TCPProbeContext *tcp_probe_ctx;
2137 * We have received an ICMP response, ostensibly from a peer
2138 * that wants to connect to us! Send a message to establish a connection.
2140 sock = GNUNET_CONNECTION_create_from_sockaddr (AF_INET, addr, addrlen);
2143 /* failed for some odd reason (out of sockets?); ignore attempt */
2147 /* FIXME: do we need to track these probe context objects so that
2148 * we can clean them up on plugin unload? */
2149 tcp_probe_ctx = GNUNET_malloc (sizeof (struct TCPProbeContext));
2150 tcp_probe_ctx->message.header.size =
2151 htons (sizeof (struct TCP_NAT_ProbeMessage));
2152 tcp_probe_ctx->message.header.type =
2153 htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE);
2154 memcpy (&tcp_probe_ctx->message.clientIdentity, plugin->env->my_identity,
2155 sizeof (struct GNUNET_PeerIdentity));
2156 tcp_probe_ctx->plugin = plugin;
2157 tcp_probe_ctx->sock = sock;
2158 GNUNET_CONTAINER_DLL_insert (plugin->probe_head, plugin->probe_tail,
2160 tcp_probe_ctx->transmit_handle =
2161 GNUNET_CONNECTION_notify_transmit_ready (sock,
2162 ntohs (tcp_probe_ctx->
2163 message.header.size),
2164 GNUNET_TIME_UNIT_FOREVER_REL,
2172 * Entry point for the plugin.
2174 * @param cls closure, the 'struct GNUNET_TRANSPORT_PluginEnvironment*'
2175 * @return the 'struct GNUNET_TRANSPORT_PluginFunctions*' or NULL on error
2178 libgnunet_plugin_transport_tcp_init (void *cls)
2180 static const struct GNUNET_SERVER_MessageHandler my_handlers[] = {
2181 {&handle_tcp_welcome, NULL, GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME,
2182 sizeof (struct WelcomeMessage)},
2183 {&handle_tcp_nat_probe, NULL, GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_NAT_PROBE,
2184 sizeof (struct TCP_NAT_ProbeMessage)},
2185 {&handle_tcp_data, NULL, GNUNET_MESSAGE_TYPE_ALL, 0},
2188 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
2189 struct GNUNET_TRANSPORT_PluginFunctions *api;
2190 struct Plugin *plugin;
2191 struct GNUNET_SERVICE_Context *service;
2192 unsigned long long aport;
2193 unsigned long long bport;
2194 unsigned long long max_connections;
2196 struct GNUNET_TIME_Relative idle_timeout;
2198 struct sockaddr **addrs;
2199 socklen_t *addrlens;
2202 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2205 max_connections = 128;
2209 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp", "PORT",
2210 &bport)) || (bport > 65535) ||
2212 GNUNET_CONFIGURATION_get_value_number (env->cfg, "transport-tcp",
2213 "ADVERTISED-PORT", &aport)) &&
2216 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "tcp",
2218 ("Require valid port number for service `%s' in configuration!\n"),
2228 service = GNUNET_SERVICE_start ("transport-tcp", env->cfg);
2229 if (service == NULL)
2231 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, "tcp",
2232 _("Failed to start service.\n"));
2241 plugin = GNUNET_malloc (sizeof (struct Plugin));
2242 plugin->sessionmap = GNUNET_CONTAINER_multihashmap_create(max_connections);
2243 plugin->max_connections = max_connections;
2244 plugin->open_port = bport;
2245 plugin->adv_port = aport;
2247 plugin->lsock = NULL;
2248 if ((service != NULL) &&
2251 GNUNET_SERVICE_get_server_addresses ("transport-tcp", env->cfg, &addrs,
2255 GNUNET_NAT_register (env->cfg, GNUNET_YES, aport, (unsigned int) ret,
2256 (const struct sockaddr **) addrs, addrlens,
2257 &tcp_nat_port_map_callback,
2258 &try_connection_reversal, plugin);
2262 GNUNET_assert (addrs[ret] != NULL);
2263 GNUNET_free (addrs[ret]);
2265 GNUNET_free_non_null (addrs);
2266 GNUNET_free_non_null (addrlens);
2271 GNUNET_NAT_register (env->cfg, GNUNET_YES, 0, 0, NULL, NULL, NULL,
2272 &try_connection_reversal, plugin);
2274 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
2276 api->send = &tcp_plugin_send_old;
2278 api->send_with_session = &tcp_plugin_send;
2279 api->get_session = &tcp_plugin_get_session;
2281 api->disconnect = &tcp_plugin_disconnect;
2282 api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
2283 api->check_address = &tcp_plugin_check_address;
2284 api->address_to_string = &tcp_address_to_string;
2285 plugin->service = service;
2286 if (service != NULL)
2288 plugin->server = GNUNET_SERVICE_get_server (service);
2293 GNUNET_CONFIGURATION_get_value_time (env->cfg, "transport-tcp",
2294 "TIMEOUT", &idle_timeout))
2296 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "tcp",
2297 _("Failed to find option %s in section %s!\n"),
2298 "TIMEOUT", "transport-tcp");
2299 if (plugin->nat != NULL)
2300 GNUNET_NAT_unregister (plugin->nat);
2301 GNUNET_free (plugin);
2306 GNUNET_SERVER_create_with_sockets (&plugin_tcp_access_check, plugin,
2307 NULL, idle_timeout, GNUNET_YES);
2309 plugin->handlers = GNUNET_malloc (sizeof (my_handlers));
2310 memcpy (plugin->handlers, my_handlers, sizeof (my_handlers));
2312 i < sizeof (my_handlers) / sizeof (struct GNUNET_SERVER_MessageHandler);
2314 plugin->handlers[i].callback_cls = plugin;
2315 GNUNET_SERVER_add_handlers (plugin->server, plugin->handlers);
2316 GNUNET_SERVER_disconnect_notify (plugin->server, &disconnect_notify, plugin);
2317 plugin->nat_wait_conns = GNUNET_CONTAINER_multihashmap_create (16);
2319 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "tcp",
2320 _("TCP transport listening on port %llu\n"), bport);
2322 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "tcp",
2324 ("TCP transport not listening on any port (client only)\n"));
2326 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "tcp",
2328 ("TCP transport advertises itself as being on port %llu\n"),
2335 * Exit point from the plugin.
2338 libgnunet_plugin_transport_tcp_done (void *cls)
2340 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
2341 struct Plugin *plugin = api->cls;
2342 struct Session *session;
2343 struct TCPProbeContext *tcp_probe;
2345 while (NULL != (session = plugin->sessions))
2346 disconnect_session (session);
2347 if (plugin->service != NULL)
2348 GNUNET_SERVICE_stop (plugin->service);
2350 GNUNET_SERVER_destroy (plugin->server);
2351 GNUNET_free (plugin->handlers);
2352 if (plugin->nat != NULL)
2353 GNUNET_NAT_unregister (plugin->nat);
2354 while (NULL != (tcp_probe = plugin->probe_head))
2356 GNUNET_CONTAINER_DLL_remove (plugin->probe_head, plugin->probe_tail,
2358 GNUNET_CONNECTION_destroy (tcp_probe->sock, GNUNET_NO);
2359 GNUNET_free (tcp_probe);
2361 GNUNET_CONTAINER_multihashmap_destroy (plugin->nat_wait_conns);
2362 GNUNET_CONTAINER_multihashmap_destroy (plugin->sessionmap);
2363 GNUNET_free (plugin);
2368 /* end of plugin_transport_tcp.c */