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 2, 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_connection_lib.h"
28 #include "gnunet_container_lib.h"
29 #include "gnunet_os_lib.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_resolver_service.h"
32 #include "gnunet_server_lib.h"
33 #include "gnunet_service_lib.h"
34 #include "gnunet_signatures.h"
35 #include "gnunet_statistics_service.h"
36 #include "gnunet_transport_service.h"
37 #include "plugin_transport.h"
38 #include "transport.h"
40 #define DEBUG_TCP GNUNET_NO
43 * How long until we give up on transmitting the welcome message?
45 #define HOSTNAME_RESOLVE_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
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 * Network format for IPv4 addresses.
72 * IPv4 address, in network byte order.
77 * Port number, in network byte order.
85 * Network format for IPv6 addresses.
92 unsigned char ipv6_addr[16];
95 * Port number, in network byte order.
103 * Encapsulation of all of the state of the plugin.
109 * Information kept for each message that is yet to
112 struct PendingMessage
116 * This is a doubly-linked list.
118 struct PendingMessage *next;
121 * This is a doubly-linked list.
123 struct PendingMessage *prev;
126 * The pending message
131 * Continuation function to call once the message
132 * has been sent. Can be NULL if there is no
133 * continuation to call.
135 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
138 * Closure for transmit_cont.
140 void *transmit_cont_cls;
143 * Timeout value for the pending message.
145 struct GNUNET_TIME_Absolute timeout;
148 * So that the gnunet-service-transport can group messages together,
149 * these pending messages need to accept a message buffer and size
150 * instead of just a GNUNET_MessageHeader.
158 * Session handle for TCP connections.
164 * Stored in a linked list.
166 struct Session *next;
169 * Pointer to the global plugin struct.
171 struct Plugin *plugin;
174 * The client (used to identify this connection)
176 struct GNUNET_SERVER_Client *client;
179 * Messages currently pending for transmission
180 * to this peer, if any.
182 struct PendingMessage *pending_messages_head;
185 * Messages currently pending for transmission
186 * to this peer, if any.
188 struct PendingMessage *pending_messages_tail;
191 * Handle for pending transmission request.
193 struct GNUNET_CONNECTION_TransmitHandle *transmit_handle;
196 * To whom are we talking to (set to our identity
197 * if we are still waiting for the welcome message)
199 struct GNUNET_PeerIdentity target;
202 * ID of task used to delay receiving more to throttle sender.
204 GNUNET_SCHEDULER_TaskIdentifier receive_delay_task;
207 * Address of the other peer (either based on our 'connect'
208 * call or on our 'accept' call).
213 * Last activity on this connection. Used to select preferred
216 struct GNUNET_TIME_Absolute last_activity;
219 * Length of connect_addr.
224 * Are we still expecting the welcome message? (GNUNET_YES/GNUNET_NO)
226 int expecting_welcome;
229 * Was this a connection that was inbound (we accepted)? (GNUNET_YES/GNUNET_NO)
237 * Encapsulation of all of the state of the plugin.
244 struct GNUNET_TRANSPORT_PluginEnvironment *env;
249 struct GNUNET_CONNECTION_Handle *lsock;
252 * List of open TCP sessions.
254 struct Session *sessions;
257 * Handle to the network service.
259 struct GNUNET_SERVICE_Context *service;
262 * Handle to the server for this service.
264 struct GNUNET_SERVER_Handle *server;
267 * Copy of the handler array where the closures are
268 * set to this struct's instance.
270 struct GNUNET_SERVER_MessageHandler *handlers;
273 * Handle for request of hostname resolution, non-NULL if pending.
275 struct GNUNET_RESOLVER_RequestHandle *hostname_dns;
278 * ID of task used to update our addresses when one expires.
280 GNUNET_SCHEDULER_TaskIdentifier address_update_task;
283 * Port that we are actually listening on.
288 * Port that the user said we would have visible to the
299 * Function called for a quick conversion of the binary address to
300 * a numeric address. Note that the caller must not free the
301 * address and that the next call to this function is allowed
302 * to override the address again.
304 * @param cls closure ('struct Plugin*')
305 * @param addr binary address
306 * @param addrlen length of the address
307 * @return string representing the same address
310 tcp_address_to_string (void *cls,
314 static char rbuf[INET6_ADDRSTRLEN + 12];
315 char buf[INET6_ADDRSTRLEN];
319 const struct IPv4TcpAddress *t4;
320 const struct IPv6TcpAddress *t6;
324 if (addrlen == sizeof (struct IPv6TcpAddress))
328 port = ntohs (t6->t6_port);
329 memcpy (&a6, t6->ipv6_addr, sizeof (a6));
332 else if (addrlen == sizeof (struct IPv4TcpAddress))
336 port = ntohs (t4->t_port);
337 memcpy (&a4, &t4->ipv4_addr, sizeof (a4));
345 inet_ntop (af, sb, buf, INET6_ADDRSTRLEN);
346 GNUNET_snprintf (rbuf,
348 (af == AF_INET6) ? "[%s]:%u" : "%s:%u",
356 * Find the session handle for the given client.
358 * @return NULL if no matching session exists
360 static struct Session *
361 find_session_by_client (struct Plugin *plugin,
362 const struct GNUNET_SERVER_Client *client)
366 ret = plugin->sessions;
367 while ((ret != NULL) && (client != ret->client))
374 * Create a new session. Also queues a welcome message.
377 * @param target peer to connect to
378 * @param client client to use
379 * @return new session object
381 static struct Session *
382 create_session (struct Plugin *plugin,
383 const struct GNUNET_PeerIdentity *target,
384 struct GNUNET_SERVER_Client *client)
387 struct PendingMessage *pm;
388 struct WelcomeMessage welcome;
390 GNUNET_assert (client != NULL);
392 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
394 "Creating new session for peer `%4s'\n",
395 GNUNET_i2s (target));
397 ret = GNUNET_malloc (sizeof (struct Session));
398 ret->last_activity = GNUNET_TIME_absolute_get ();
399 ret->plugin = plugin;
400 ret->next = plugin->sessions;
401 plugin->sessions = ret;
402 ret->client = client;
403 ret->target = *target;
404 ret->expecting_welcome = GNUNET_YES;
405 pm = GNUNET_malloc (sizeof (struct PendingMessage) + sizeof (struct WelcomeMessage));
406 pm->msg = (const char*) &pm[1];
407 pm->message_size = sizeof (struct WelcomeMessage);
408 welcome.header.size = htons (sizeof (struct WelcomeMessage));
409 welcome.header.type = htons (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME);
410 welcome.clientIdentity = *plugin->env->my_identity;
411 memcpy (&pm[1], &welcome, sizeof (welcome));
412 pm->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
413 GNUNET_STATISTICS_update (plugin->env->stats,
414 gettext_noop ("# bytes currently in TCP buffers"),
417 GNUNET_CONTAINER_DLL_insert (ret->pending_messages_head,
418 ret->pending_messages_tail,
420 GNUNET_STATISTICS_update (plugin->env->stats,
421 gettext_noop ("# TCP sessions active"),
429 * If we have pending messages, ask the server to
430 * transmit them (schedule the respective tasks, etc.)
432 * @param session for which session should we do this
434 static void process_pending_messages (struct Session *session);
438 * Function called to notify a client about the socket
439 * being ready to queue more data. "buf" will be
440 * NULL and "size" zero if the socket was closed for
441 * writing in the meantime.
444 * @param size number of bytes available in buf
445 * @param buf where the callee should write the message
446 * @return number of bytes written to buf
449 do_transmit (void *cls, size_t size, void *buf)
451 struct Session *session = cls;
452 struct GNUNET_PeerIdentity pid;
453 struct Plugin *plugin;
454 struct PendingMessage *pos;
455 struct PendingMessage *hd;
456 struct PendingMessage *tl;
457 struct GNUNET_TIME_Absolute now;
461 session->transmit_handle = NULL;
462 plugin = session->plugin;
466 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
468 "Timeout trying to transmit to peer `%4s', discarding message queue.\n",
469 GNUNET_i2s (&session->target));
471 /* timeout; cancel all messages that have already expired */
475 now = GNUNET_TIME_absolute_get ();
476 while ( (NULL != (pos = session->pending_messages_head)) &&
477 (pos->timeout.value <= now.value) )
479 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
480 session->pending_messages_tail,
483 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
485 "Failed to transmit %u byte message to `%4s'.\n",
487 GNUNET_i2s (&session->target));
489 ret += pos->message_size;
490 GNUNET_CONTAINER_DLL_insert_after (hd, tl, tl, pos);
492 /* do this call before callbacks (so that if callbacks destroy
493 session, they have a chance to cancel actions done by this
495 process_pending_messages (session);
496 pid = session->target;
497 /* no do callbacks and do not use session again since
498 the callbacks may abort the session */
499 while (NULL != (pos = hd))
501 GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
502 if (pos->transmit_cont != NULL)
503 pos->transmit_cont (pos->transmit_cont_cls,
504 &pid, GNUNET_SYSERR);
507 GNUNET_STATISTICS_update (plugin->env->stats,
508 gettext_noop ("# bytes currently in TCP buffers"),
511 GNUNET_STATISTICS_update (plugin->env->stats,
512 gettext_noop ("# bytes discarded by TCP (timeout)"),
517 /* copy all pending messages that would fit */
522 while (NULL != (pos = session->pending_messages_head))
524 if (ret + pos->message_size > size)
526 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
527 session->pending_messages_tail,
529 GNUNET_assert (size >= pos->message_size);
530 memcpy (cbuf, pos->msg, pos->message_size);
531 cbuf += pos->message_size;
532 ret += pos->message_size;
533 size -= pos->message_size;
534 GNUNET_CONTAINER_DLL_insert_after (hd, tl, tl, pos);
536 /* schedule 'continuation' before callbacks so that callbacks that
537 cancel everything don't cause us to use a session that no longer
539 process_pending_messages (session);
540 session->last_activity = GNUNET_TIME_absolute_get ();
541 pid = session->target;
542 /* we'll now call callbacks that may cancel the session; hence
543 we should not use 'session' after this point */
544 while (NULL != (pos = hd))
546 GNUNET_CONTAINER_DLL_remove (hd, tl, pos);
547 if (pos->transmit_cont != NULL)
548 pos->transmit_cont (pos->transmit_cont_cls,
552 GNUNET_assert (hd == NULL);
553 GNUNET_assert (tl == NULL);
555 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
556 "tcp", "Transmitting %u bytes\n", ret);
558 GNUNET_STATISTICS_update (plugin->env->stats,
559 gettext_noop ("# bytes currently in TCP buffers"),
562 GNUNET_STATISTICS_update (plugin->env->stats,
563 gettext_noop ("# bytes transmitted via TCP"),
571 * If we have pending messages, ask the server to
572 * transmit them (schedule the respective tasks, etc.)
574 * @param session for which session should we do this
577 process_pending_messages (struct Session *session)
579 struct PendingMessage *pm;
581 GNUNET_assert (session->client != NULL);
582 if (session->transmit_handle != NULL)
584 if (NULL == (pm = session->pending_messages_head))
586 session->transmit_handle
587 = GNUNET_SERVER_notify_transmit_ready (session->client,
589 GNUNET_TIME_absolute_get_remaining
591 &do_transmit, session);
596 * Functions with this signature are called whenever we need
597 * to close a session due to a disconnect or failure to
598 * establish a connection.
600 * @param session session to close down
603 disconnect_session (struct Session *session)
605 struct Session *prev;
607 struct PendingMessage *pm;
610 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
612 "Disconnecting from `%4s' at %s (session %p).\n",
613 GNUNET_i2s (&session->target),
614 (session->connect_addr != NULL) ?
615 tcp_address_to_string (session->plugin,
616 session->connect_addr,
617 session->connect_alen) : "*",
620 /* remove from session list */
622 pos = session->plugin->sessions;
623 while (pos != session)
629 session->plugin->sessions = session->next;
631 prev->next = session->next;
632 session->plugin->env->session_end (session->plugin->env->cls,
636 if (session->transmit_handle != NULL)
638 GNUNET_CONNECTION_notify_transmit_ready_cancel
639 (session->transmit_handle);
640 session->transmit_handle = NULL;
642 while (NULL != (pm = session->pending_messages_head))
645 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
647 pm->transmit_cont != NULL
648 ? "Could not deliver message to `%4s'.\n"
650 "Could not deliver message to `%4s', notifying.\n",
651 GNUNET_i2s (&session->target));
653 GNUNET_STATISTICS_update (session->plugin->env->stats,
654 gettext_noop ("# bytes currently in TCP buffers"),
655 - (int64_t) pm->message_size,
657 GNUNET_STATISTICS_update (session->plugin->env->stats,
658 gettext_noop ("# bytes discarded by TCP (disconnect)"),
661 GNUNET_CONTAINER_DLL_remove (session->pending_messages_head,
662 session->pending_messages_tail,
664 if (NULL != pm->transmit_cont)
665 pm->transmit_cont (pm->transmit_cont_cls,
666 &session->target, GNUNET_SYSERR);
669 GNUNET_break (session->client != NULL);
670 if (session->receive_delay_task != GNUNET_SCHEDULER_NO_TASK)
672 GNUNET_SCHEDULER_cancel (session->plugin->env->sched,
673 session->receive_delay_task);
674 GNUNET_SERVER_receive_done (session->client,
677 GNUNET_SERVER_client_drop (session->client);
678 GNUNET_STATISTICS_update (session->plugin->env->stats,
679 gettext_noop ("# TCP sessions active"),
682 GNUNET_free_non_null (session->connect_addr);
683 GNUNET_free (session);
688 * Given two otherwise equivalent sessions, pick the better one.
690 * @param s1 one session (also default)
691 * @param s2 other session
692 * @return "better" session (more active)
694 static struct Session *
695 select_better_session (struct Session *s1,
702 if ( (s1->expecting_welcome == GNUNET_NO) &&
703 (s2->expecting_welcome == GNUNET_YES) )
705 if ( (s1->expecting_welcome == GNUNET_YES) &&
706 (s2->expecting_welcome == GNUNET_NO) )
708 if (s1->last_activity.value < s2->last_activity.value)
710 if (s1->last_activity.value > s2->last_activity.value)
712 if ( (GNUNET_YES == s1->inbound) &&
713 (GNUNET_NO == s2->inbound) )
715 if ( (GNUNET_NO == s1->inbound) &&
716 (GNUNET_YES == s2->inbound) )
723 * Function that can be used by the transport service to transmit
724 * a message using the plugin. Note that in the case of a
725 * peer disconnecting, the continuation MUST be called
726 * prior to the disconnect notification itself. This function
727 * will be called with this peer's HELLO message to initiate
728 * a fresh connection to another peer.
731 * @param target who should receive this message
732 * @param msg the message to transmit
733 * @param msgbuf_size number of bytes in 'msg'
734 * @param priority how important is the message (most plugins will
735 * ignore message priority and just FIFO)
736 * @param timeout how long to wait at most for the transmission (does not
737 * require plugins to discard the message after the timeout,
738 * just advisory for the desired delay; most plugins will ignore
740 * @param session which session must be used (or NULL for "any")
741 * @param addr the address to use (can be NULL if the plugin
742 * is "on its own" (i.e. re-use existing TCP connection))
743 * @param addrlen length of the address in bytes
744 * @param force_address GNUNET_YES if the plugin MUST use the given address,
745 * GNUNET_NO means the plugin may use any other address and
746 * GNUNET_SYSERR means that only reliable existing
747 * bi-directional connections should be used (regardless
749 * @param cont continuation to call once the message has
750 * been transmitted (or if the transport is ready
751 * for the next transmission call; or if the
752 * peer disconnected...); can be NULL
753 * @param cont_cls closure for cont
754 * @return number of bytes used (on the physical network, with overheads);
755 * -1 on hard errors (i.e. address invalid); 0 is a legal value
756 * and does NOT mean that the message was not transmitted (DV)
759 tcp_plugin_send (void *cls,
760 const struct GNUNET_PeerIdentity *target,
764 struct GNUNET_TIME_Relative timeout,
765 struct Session *session,
769 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
771 struct Plugin *plugin = cls;
772 struct Session *cand_session;
773 struct Session *next;
774 struct PendingMessage *pm;
775 struct GNUNET_CONNECTION_Handle *sa;
779 struct sockaddr_in a4;
780 struct sockaddr_in6 a6;
781 const struct IPv4TcpAddress *t4;
782 const struct IPv6TcpAddress *t6;
784 GNUNET_STATISTICS_update (plugin->env->stats,
785 gettext_noop ("# bytes TCP was asked to transmit"),
788 /* FIXME: we could do this cheaper with a hash table
789 where we could restrict the iteration to entries that match
790 the target peer... */
794 next = plugin->sessions;
795 while (NULL != (session = next))
797 next = session->next;
798 GNUNET_assert (session->client != NULL);
799 if (0 != memcmp (target,
801 sizeof (struct GNUNET_PeerIdentity)))
803 if ( ( (GNUNET_SYSERR == force_address) &&
804 (session->expecting_welcome == GNUNET_NO) ) ||
805 (GNUNET_NO == force_address) )
807 cand_session = select_better_session (cand_session,
811 if (GNUNET_SYSERR == force_address)
813 GNUNET_break (GNUNET_YES == force_address);
819 if (session->inbound == GNUNET_YES)
821 if (addrlen != session->connect_alen)
823 if (0 != memcmp (session->connect_addr,
827 cand_session = select_better_session (cand_session,
830 session = cand_session;
832 if ( (session == NULL) &&
836 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
838 "Asked to transmit to `%4s' without address and I have no existing connection (failing).\n",
839 GNUNET_i2s (target));
841 GNUNET_STATISTICS_update (plugin->env->stats,
842 gettext_noop ("# bytes discarded by TCP (no address and no connection)"),
849 if (addrlen == sizeof (struct IPv6TcpAddress))
853 memset (&a6, 0, sizeof (a6));
854 #if HAVE_SOCKADDR_IN_SIN_LEN
855 a6.sin6_len = sizeof (a6);
857 a6.sin6_family = AF_INET6;
858 a6.sin6_port = t6->t6_port;
859 memcpy (a6.sin6_addr.s6_addr,
865 else if (addrlen == sizeof (struct IPv4TcpAddress))
869 memset (&a4, 0, sizeof (a4));
870 #if HAVE_SOCKADDR_IN_SIN_LEN
871 a4.sin_len = sizeof (a4);
873 a4.sin_family = AF_INET;
874 a4.sin_port = t4->t_port;
875 a4.sin_addr.s_addr = t4->ipv4_addr;
884 sa = GNUNET_CONNECTION_create_from_sockaddr (plugin->env->sched,
886 GNUNET_SERVER_MAX_MESSAGE_SIZE);
890 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
892 "Failed to create connection to `%4s' at `%s'\n",
894 GNUNET_a2s (sb, sbs));
896 GNUNET_STATISTICS_update (plugin->env->stats,
897 gettext_noop ("# bytes discarded by TCP (failed to connect)"),
903 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
905 "Asked to transmit to `%4s', creating fresh session using address `%s'.\n",
907 GNUNET_a2s (sb, sbs));
909 session = create_session (plugin,
911 GNUNET_SERVER_connect_socket (plugin->server,
913 session->connect_addr = GNUNET_malloc (addrlen);
914 memcpy (session->connect_addr,
917 session->connect_alen = addrlen;
919 GNUNET_assert (session != NULL);
920 GNUNET_assert (session->client != NULL);
921 GNUNET_STATISTICS_update (plugin->env->stats,
922 gettext_noop ("# bytes currently in TCP buffers"),
925 /* create new message entry */
926 pm = GNUNET_malloc (sizeof (struct PendingMessage) + msgbuf_size);
927 pm->msg = (const char*) &pm[1];
928 memcpy (&pm[1], msg, msgbuf_size);
929 pm->message_size = msgbuf_size;
930 pm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
931 pm->transmit_cont = cont;
932 pm->transmit_cont_cls = cont_cls;
934 /* append pm to pending_messages list */
935 GNUNET_CONTAINER_DLL_insert_after (session->pending_messages_head,
936 session->pending_messages_tail,
937 session->pending_messages_tail,
940 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
942 "Asked to transmit %u bytes to `%s', added message to list.\n",
944 GNUNET_i2s (target));
946 process_pending_messages (session);
952 * Function that can be called to force a disconnect from the
953 * specified neighbour. This should also cancel all previously
954 * scheduled transmissions. Obviously the transmission may have been
955 * partially completed already, which is OK. The plugin is supposed
956 * to close the connection (if applicable) and no longer call the
957 * transmit continuation(s).
959 * Finally, plugin MUST NOT call the services's receive function to
960 * notify the service that the connection to the specified target was
961 * closed after a getting this call.
964 * @param target peer for which the last transmission is
968 tcp_plugin_disconnect (void *cls,
969 const struct GNUNET_PeerIdentity *target)
971 struct Plugin *plugin = cls;
972 struct Session *session;
973 struct Session *next;
974 struct PendingMessage *pm;
977 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
979 "Asked to cancel session with `%4s'\n",
980 GNUNET_i2s (target));
982 next = plugin->sessions;
983 while (NULL != (session = next))
985 next = session->next;
986 if (0 != memcmp (target,
988 sizeof (struct GNUNET_PeerIdentity)))
990 pm = session->pending_messages_head;
993 pm->transmit_cont = NULL;
994 pm->transmit_cont_cls = NULL;
997 disconnect_session (session);
1003 * Context for address to string conversion.
1005 struct PrettyPrinterContext
1008 * Function to call with the result.
1010 GNUNET_TRANSPORT_AddressStringCallback asc;
1013 * Clsoure for 'asc'.
1018 * Port to add after the IP address.
1025 * Append our port and forward the result.
1027 * @param cls the 'struct PrettyPrinterContext*'
1028 * @param hostname hostname part of the address
1031 append_port (void *cls, const char *hostname)
1033 struct PrettyPrinterContext *ppc = cls;
1036 if (hostname == NULL)
1038 ppc->asc (ppc->asc_cls, NULL);
1042 GNUNET_asprintf (&ret, "%s:%d", hostname, ppc->port);
1043 ppc->asc (ppc->asc_cls, ret);
1049 * Convert the transports address to a nice, human-readable
1052 * @param cls closure
1053 * @param type name of the transport that generated the address
1054 * @param addr one of the addresses of the host, NULL for the last address
1055 * the specific address format depends on the transport
1056 * @param addrlen length of the address
1057 * @param numeric should (IP) addresses be displayed in numeric form?
1058 * @param timeout after how long should we give up?
1059 * @param asc function to call on each string
1060 * @param asc_cls closure for asc
1063 tcp_plugin_address_pretty_printer (void *cls,
1068 struct GNUNET_TIME_Relative timeout,
1069 GNUNET_TRANSPORT_AddressStringCallback asc,
1072 struct Plugin *plugin = cls;
1073 struct PrettyPrinterContext *ppc;
1076 struct sockaddr_in a4;
1077 struct sockaddr_in6 a6;
1078 const struct IPv4TcpAddress *t4;
1079 const struct IPv6TcpAddress *t6;
1082 if (addrlen == sizeof (struct IPv6TcpAddress))
1085 memset (&a6, 0, sizeof (a6));
1086 a6.sin6_family = AF_INET6;
1087 a6.sin6_port = t6->t6_port;
1088 memcpy (a6.sin6_addr.s6_addr,
1091 port = ntohs (t6->t6_port);
1095 else if (addrlen == sizeof (struct IPv4TcpAddress))
1098 memset (&a4, 0, sizeof (a4));
1099 a4.sin_family = AF_INET;
1100 a4.sin_port = t4->t_port;
1101 a4.sin_addr.s_addr = t4->ipv4_addr;
1102 port = ntohs (t4->t_port);
1108 /* invalid address */
1109 GNUNET_break_op (0);
1110 asc (asc_cls, NULL);
1113 ppc = GNUNET_malloc (sizeof (struct PrettyPrinterContext));
1115 ppc->asc_cls = asc_cls;
1117 GNUNET_RESOLVER_hostname_get (plugin->env->sched,
1121 !numeric, timeout, &append_port, ppc);
1126 * Check if the given port is plausible (must be either
1127 * our listen port or our advertised port). If it is
1128 * neither, we return one of these two ports at random.
1130 * @param plugin global variables
1131 * @param in_port port number to check
1132 * @return either in_port or a more plausible port
1135 check_port (struct Plugin *plugin, uint16_t in_port)
1137 if ((in_port == plugin->adv_port) || (in_port == plugin->open_port))
1139 return (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1141 ? plugin->open_port : plugin->adv_port;
1146 * Another peer has suggested an address for this peer and transport
1147 * plugin. Check that this could be a valid address. This function
1148 * is not expected to 'validate' the address in the sense of trying to
1149 * connect to it but simply to see if the binary format is technically
1150 * legal for establishing a connection.
1152 * @param cls closure, our 'struct Plugin*'
1153 * @param addr pointer to the address
1154 * @param addrlen length of addr
1155 * @return GNUNET_OK if this is a plausible address for this peer
1156 * and transport, GNUNET_SYSERR if not
1159 tcp_plugin_check_address (void *cls, void *addr, size_t addrlen)
1161 struct Plugin *plugin = cls;
1162 struct IPv4TcpAddress *v4;
1163 struct IPv6TcpAddress *v6;
1165 if ((addrlen != sizeof (struct IPv4TcpAddress)) &&
1166 (addrlen != sizeof (struct IPv6TcpAddress)))
1168 GNUNET_break_op (0);
1169 return GNUNET_SYSERR;
1171 if (addrlen == sizeof (struct IPv4TcpAddress))
1173 v4 = (struct IPv4TcpAddress *) addr;
1174 v4->t_port = htons (check_port (plugin, ntohs (v4->t_port)));
1178 v6 = (struct IPv6TcpAddress *) addr;
1179 if (IN6_IS_ADDR_LINKLOCAL (v6->ipv6_addr))
1181 GNUNET_break_op (0);
1182 return GNUNET_SYSERR;
1184 v6->t6_port = htons (check_port (plugin, ntohs (v6->t6_port)));
1191 * We've received a welcome from this peer via TCP. Possibly create a
1192 * fresh client record and send back our welcome.
1194 * @param cls closure
1195 * @param client identification of the client
1196 * @param message the actual message
1199 handle_tcp_welcome (void *cls,
1200 struct GNUNET_SERVER_Client *client,
1201 const struct GNUNET_MessageHeader *message)
1203 struct Plugin *plugin = cls;
1204 const struct WelcomeMessage *wm = (const struct WelcomeMessage *) message;
1205 struct Session *session;
1208 struct IPv4TcpAddress *t4;
1209 struct IPv6TcpAddress *t6;
1210 const struct sockaddr_in *s4;
1211 const struct sockaddr_in6 *s6;
1215 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1217 "Received %s message from a `%4s/%p'.\n",
1219 GNUNET_i2s (&wm->clientIdentity), client);
1221 GNUNET_STATISTICS_update (plugin->env->stats,
1222 gettext_noop ("# TCP WELCOME messages received"),
1225 session = find_session_by_client (plugin, client);
1226 if (session == NULL)
1228 GNUNET_SERVER_client_keep (client);
1229 session = create_session (plugin,
1230 &wm->clientIdentity, client);
1231 session->inbound = GNUNET_YES;
1233 GNUNET_SERVER_client_get_address (client, &vaddr, &alen))
1236 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1238 "Found address `%s' for incoming connection %p\n",
1239 GNUNET_a2s (vaddr, alen),
1242 if (alen == sizeof (struct sockaddr_in))
1245 t4 = GNUNET_malloc (sizeof (struct IPv4TcpAddress));
1246 t4->t_port = s4->sin_port;
1247 t4->ipv4_addr = s4->sin_addr.s_addr;
1248 session->connect_addr = t4;
1249 session->connect_alen = sizeof (struct IPv4TcpAddress);
1251 else if (alen == sizeof (struct sockaddr_in6))
1254 t6 = GNUNET_malloc (sizeof (struct IPv6TcpAddress));
1255 t6->t6_port = s6->sin6_port;
1256 memcpy (t6->ipv6_addr,
1257 s6->sin6_addr.s6_addr,
1259 session->connect_addr = t6;
1260 session->connect_alen = sizeof (struct IPv6TcpAddress);
1262 GNUNET_free (vaddr);
1267 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1269 "Did not obtain TCP socket address for incoming connection\n");
1273 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1275 "Creating new session %p for connection %p\n",
1278 process_pending_messages (session);
1280 if (session->expecting_welcome != GNUNET_YES)
1282 GNUNET_break_op (0);
1283 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1286 session->last_activity = GNUNET_TIME_absolute_get ();
1287 session->expecting_welcome = GNUNET_NO;
1288 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1293 * Task to signal the server that we can continue
1294 * receiving from the TCP client now.
1296 * @param cls the 'struct Session*'
1297 * @param tc task context (unused)
1300 delayed_done (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1302 struct Session *session = cls;
1303 struct GNUNET_TIME_Relative delay;
1305 session->receive_delay_task = GNUNET_SCHEDULER_NO_TASK;
1306 delay = session->plugin->env->receive (session->plugin->env->cls,
1311 if (delay.value == 0)
1312 GNUNET_SERVER_receive_done (session->client, GNUNET_OK);
1314 session->receive_delay_task =
1315 GNUNET_SCHEDULER_add_delayed (session->plugin->env->sched,
1316 delay, &delayed_done, session);
1321 * We've received data for this peer via TCP. Unbox,
1322 * compute latency and forward.
1324 * @param cls closure
1325 * @param client identification of the client
1326 * @param message the actual message
1329 handle_tcp_data (void *cls,
1330 struct GNUNET_SERVER_Client *client,
1331 const struct GNUNET_MessageHeader *message)
1333 struct Plugin *plugin = cls;
1334 struct Session *session;
1335 struct GNUNET_TIME_Relative delay;
1337 if (GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME == ntohs(message->type))
1339 /* We don't want to propagate WELCOME messages up! */
1340 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1343 session = find_session_by_client (plugin, client);
1344 if ( (NULL == session) || (GNUNET_NO != session->expecting_welcome))
1346 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1349 session->last_activity = GNUNET_TIME_absolute_get ();
1351 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1353 "Passing %u bytes of type %u from `%4s' to transport service.\n",
1354 (unsigned int) ntohs (message->size),
1355 (unsigned int) ntohs (message->type),
1356 GNUNET_i2s (&session->target));
1358 GNUNET_STATISTICS_update (plugin->env->stats,
1359 gettext_noop ("# bytes received via TCP"),
1360 ntohs (message->size),
1362 delay = plugin->env->receive (plugin->env->cls, &session->target, message, 1,
1364 (GNUNET_YES == session->inbound) ? NULL : session->connect_addr,
1365 (GNUNET_YES == session->inbound) ? 0 : session->connect_alen);
1366 if (delay.value == 0)
1367 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1369 session->receive_delay_task =
1370 GNUNET_SCHEDULER_add_delayed (session->plugin->env->sched,
1371 delay, &delayed_done, session);
1376 * Handlers for the various TCP messages.
1378 static struct GNUNET_SERVER_MessageHandler my_handlers[] = {
1379 {&handle_tcp_welcome, NULL, GNUNET_MESSAGE_TYPE_TRANSPORT_TCP_WELCOME,
1380 sizeof (struct WelcomeMessage)},
1381 {&handle_tcp_data, NULL, GNUNET_MESSAGE_TYPE_ALL, 0},
1387 * Functions with this signature are called whenever a peer
1388 * is disconnected on the network level.
1390 * @param cls closure
1391 * @param client identification of the client
1394 disconnect_notify (void *cls,
1395 struct GNUNET_SERVER_Client *client)
1397 struct Plugin *plugin = cls;
1398 struct Session *session;
1402 session = find_session_by_client (plugin, client);
1403 if (session == NULL)
1404 return; /* unknown, nothing to do */
1406 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1408 "Destroying session of `%4s' with %s (%p) due to network-level disconnect.\n",
1409 GNUNET_i2s (&session->target),
1410 (session->connect_addr != NULL) ?
1411 tcp_address_to_string (session->plugin,
1412 session->connect_addr,
1413 session->connect_alen) : "*",
1416 disconnect_session (session);
1421 * Add the IP of our network interface to the list of
1422 * our external IP addresses.
1424 * @param cls the 'struct Plugin*'
1425 * @param name name of the interface
1426 * @param isDefault do we think this may be our default interface
1427 * @param addr address of the interface
1428 * @param addrlen number of bytes in addr
1429 * @return GNUNET_OK to continue iterating
1432 process_interfaces (void *cls,
1435 const struct sockaddr *addr, socklen_t addrlen)
1437 struct Plugin *plugin = cls;
1439 struct IPv4TcpAddress t4;
1440 struct IPv6TcpAddress t6;
1444 af = addr->sa_family;
1447 t4.ipv4_addr = ((struct sockaddr_in *) addr)->sin_addr.s_addr;
1448 t4.t_port = htons (plugin->adv_port);
1452 else if (af == AF_INET6)
1454 if (IN6_IS_ADDR_LINKLOCAL (((struct sockaddr_in6 *) addr)->sin6_addr.s6_addr))
1456 /* skip link local addresses */
1459 memcpy (t6.ipv6_addr,
1460 ((struct sockaddr_in6 *) addr)->sin6_addr.s6_addr,
1462 t6.t6_port = htons (plugin->adv_port);
1471 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO |
1472 GNUNET_ERROR_TYPE_BULK,
1474 _("Found address `%s' (%s)\n"),
1475 GNUNET_a2s (addr, addrlen), name);
1476 plugin->env->notify_address (plugin->env->cls,
1478 arg, args, GNUNET_TIME_UNIT_FOREVER_REL);
1484 * Function called by the resolver for each address obtained from DNS
1485 * for our own hostname. Add the addresses to the list of our
1486 * external IP addresses.
1488 * @param cls closure
1489 * @param addr one of the addresses of the host, NULL for the last address
1490 * @param addrlen length of the address
1493 process_hostname_ips (void *cls,
1494 const struct sockaddr *addr, socklen_t addrlen)
1496 struct Plugin *plugin = cls;
1500 plugin->hostname_dns = NULL;
1503 process_interfaces (plugin, "<hostname>", GNUNET_YES, addr, addrlen);
1508 * Entry point for the plugin.
1510 * @param cls closure, the 'struct GNUNET_TRANSPORT_PluginEnvironment*'
1511 * @return the 'struct GNUNET_TRANSPORT_PluginFunctions*' or NULL on error
1514 libgnunet_plugin_transport_tcp_init (void *cls)
1516 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
1517 struct GNUNET_TRANSPORT_PluginFunctions *api;
1518 struct Plugin *plugin;
1519 struct GNUNET_SERVICE_Context *service;
1520 unsigned long long aport;
1521 unsigned long long bport;
1524 service = GNUNET_SERVICE_start ("transport-tcp", env->sched, env->cfg);
1525 if (service == NULL)
1527 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
1530 ("Failed to start service for `%s' transport plugin.\n"),
1536 GNUNET_CONFIGURATION_get_value_number (env->cfg,
1542 GNUNET_CONFIGURATION_get_value_number (env->cfg,
1545 &aport)) && (aport > 65535)))
1547 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
1550 ("Require valid port number for service `%s' in configuration!\n"),
1552 GNUNET_SERVICE_stop (service);
1557 plugin = GNUNET_malloc (sizeof (struct Plugin));
1558 plugin->open_port = bport;
1559 plugin->adv_port = aport;
1561 plugin->lsock = NULL;
1562 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
1564 api->send = &tcp_plugin_send;
1565 api->disconnect = &tcp_plugin_disconnect;
1566 api->address_pretty_printer = &tcp_plugin_address_pretty_printer;
1567 api->check_address = &tcp_plugin_check_address;
1568 api->address_to_string = &tcp_address_to_string;
1569 plugin->service = service;
1570 plugin->server = GNUNET_SERVICE_get_server (service);
1571 plugin->handlers = GNUNET_malloc (sizeof (my_handlers));
1572 memcpy (plugin->handlers, my_handlers, sizeof (my_handlers));
1575 sizeof (my_handlers) / sizeof (struct GNUNET_SERVER_MessageHandler);
1577 plugin->handlers[i].callback_cls = plugin;
1578 GNUNET_SERVER_add_handlers (plugin->server, plugin->handlers);
1580 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
1581 "tcp", _("TCP transport listening on port %llu\n"), bport);
1583 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
1585 _("TCP transport advertises itself as being on port %llu\n"),
1587 GNUNET_SERVER_disconnect_notify (plugin->server,
1590 /* FIXME: do the two calls below periodically again and
1591 not just once (since the info we get might change...) */
1592 GNUNET_OS_network_interfaces_list (&process_interfaces, plugin);
1593 plugin->hostname_dns = GNUNET_RESOLVER_hostname_resolve (env->sched,
1596 HOSTNAME_RESOLVE_TIMEOUT,
1597 &process_hostname_ips,
1604 * Exit point from the plugin.
1607 libgnunet_plugin_transport_tcp_done (void *cls)
1609 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
1610 struct Plugin *plugin = api->cls;
1611 struct Session *session;
1613 while (NULL != (session = plugin->sessions))
1614 disconnect_session (session);
1615 if (NULL != plugin->hostname_dns)
1617 GNUNET_RESOLVER_request_cancel (plugin->hostname_dns);
1618 plugin->hostname_dns = NULL;
1620 GNUNET_SERVICE_stop (plugin->service);
1621 GNUNET_free (plugin->handlers);
1622 GNUNET_free (plugin);
1627 /* end of plugin_transport_tcp.c */