2 This file is part of GNUnet.
3 Copyright (C) 2006, 2009, 2015, 2016 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @file transport-testing.c
22 * @brief testing lib for transport service
23 * @author Matthias Wachs
24 * @author Christian Grothoff
26 #include "transport-testing.h"
29 #define LOG(kind,...) GNUNET_log_from(kind, "transport-testing", __VA_ARGS__)
32 static struct GNUNET_TRANSPORT_TESTING_PeerContext *
33 find_peer_context (struct GNUNET_TRANSPORT_TESTING_Handle *tth,
34 const struct GNUNET_PeerIdentity *peer)
36 struct GNUNET_TRANSPORT_TESTING_PeerContext *t;
38 for (t = tth->p_head; NULL != t; t = t->next)
39 if (0 == memcmp (&t->id,
41 sizeof (struct GNUNET_PeerIdentity)))
48 * Find any connecting context matching the given pair of peers.
50 * @param p1 first peer
51 * @param p2 second peer
52 * @param cb function to call
53 * @param cb_cls closure for @a cb
56 GNUNET_TRANSPORT_TESTING_find_connecting_context (struct GNUNET_TRANSPORT_TESTING_PeerContext *p1,
57 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2,
58 GNUNET_TRANSPORT_TESTING_ConnectContextCallback cb,
61 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p1->tth;
62 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
63 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
65 for (cc = tth->cc_head; NULL != cc; cc = ccn)
68 if ( (cc->p1 == p1) &&
78 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
84 cx->p1_c = GNUNET_YES;
90 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
92 struct GNUNET_MQ_Handle *mq = cls;
100 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
106 cx->p2_c = GNUNET_YES;
111 clear_p1c (void *cls,
112 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
118 cx->p1_c = GNUNET_NO;
123 clear_p2c (void *cls,
124 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
130 cx->p2_c = GNUNET_NO;
135 notify_connect (void *cls,
136 const struct GNUNET_PeerIdentity *peer,
137 struct GNUNET_MQ_Handle *mq)
139 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cls;
140 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
142 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2;
143 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
144 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
148 p2 = find_peer_context (p->tth,
151 ret = p->nc (p->cb_cls,
158 GNUNET_asprintf (&p2_s,
161 GNUNET_i2s (&p2->id));
163 GNUNET_asprintf (&p2_s,
166 LOG (GNUNET_ERROR_TYPE_DEBUG,
167 "Peers %s connected to peer %u (`%s')\n",
170 GNUNET_i2s (&p->id));
172 /* update flags in connecting contexts */
174 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
178 if (GNUNET_NO == found)
180 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
183 cc->p1_c = GNUNET_YES;
184 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
189 GNUNET_TRANSPORT_TESTING_find_connecting_context (p2,
193 if (GNUNET_NO == found)
195 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
198 cc->p1_c = GNUNET_YES;
199 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
203 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
207 /* update set connected flag for all requests */
208 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
210 if (GNUNET_YES == cc->connected)
212 if ( (GNUNET_YES == cc->p1_c) &&
213 (GNUNET_YES == cc->p2_c) )
215 cc->connected = GNUNET_YES;
216 /* stop trying to connect */
219 GNUNET_SCHEDULER_cancel (cc->tct);
224 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
227 if (NULL != cc->ats_sh)
229 GNUNET_ATS_connectivity_suggest_cancel (cc->ats_sh);
234 /* then notify application */
235 for (cc = tth->cc_head; NULL != cc; cc = ccn)
238 if ( (GNUNET_YES == cc->connected) &&
242 cc->cb = NULL; /* only notify once! */
250 * Offer the current HELLO of P2 to P1.
252 * @param cls our `struct GNUNET_TRANSPORT_TESTING_ConnectRequest`
255 offer_hello (void *cls);
259 notify_disconnect (void *cls,
260 const struct GNUNET_PeerIdentity *peer,
263 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cls;
264 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
266 /* Find PeerContext */
268 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2 = NULL;
269 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
271 p2 = find_peer_context (p->tth,
275 GNUNET_asprintf (&p2_s,
278 GNUNET_i2s (&p2->id));
280 GNUNET_asprintf (&p2_s,
283 LOG (GNUNET_ERROR_TYPE_DEBUG,
284 "Peers %s disconnected from peer %u (`%s')\n",
287 GNUNET_i2s (&p->id));
289 /* notify about disconnect */
296 /* clear MQ, it is now invalid */
297 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
301 /* update set connected flags for all requests */
302 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
306 GNUNET_TRANSPORT_TESTING_find_connecting_context (p2,
310 /* resume connectivity requests as necessary */
311 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
313 if (GNUNET_NO == cc->connected)
315 if ( (GNUNET_YES != cc->p1_c) ||
316 (GNUNET_YES != cc->p2_c) )
318 cc->connected = GNUNET_NO;
319 /* start trying to connect */
320 if ( (NULL == cc->tct) &&
322 cc->tct = GNUNET_SCHEDULER_add_now (&offer_hello,
324 if (NULL == cc->ats_sh)
325 cc->ats_sh = GNUNET_ATS_connectivity_suggest (cc->p1->ats,
334 get_hello (void *cb_cls,
335 const struct GNUNET_MessageHeader *message)
337 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cb_cls;
338 struct GNUNET_PeerIdentity hello_id;
340 GNUNET_assert (GNUNET_OK ==
341 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) message,
343 GNUNET_assert (0 == memcmp (&hello_id,
346 GNUNET_free_non_null (p->hello);
347 p->hello = (struct GNUNET_HELLO_Message *) GNUNET_copy_message (message);
349 if (NULL != p->start_cb)
351 LOG (GNUNET_ERROR_TYPE_DEBUG,
352 "Peer %u (`%s') successfully started\n",
354 GNUNET_i2s (&p->id));
355 p->start_cb (p->start_cb_cls);
362 * Start a peer with the given configuration
363 * @param tth the testing handle
364 * @param cfgname configuration file
365 * @param peer_id a unique number to identify the peer
366 * @param handlers functions for receiving messages
367 * @param nc connect callback
368 * @param nd disconnect callback
369 * @param cb_cls closure for callback
370 * @param start_cb start callback
371 * @param start_cb_cls closure for callback
372 * @return the peer context
374 struct GNUNET_TRANSPORT_TESTING_PeerContext *
375 GNUNET_TRANSPORT_TESTING_start_peer (struct GNUNET_TRANSPORT_TESTING_Handle *tth,
378 const struct GNUNET_MQ_MessageHandler *handlers,
379 GNUNET_TRANSPORT_NotifyConnecT nc,
380 GNUNET_TRANSPORT_NotifyDisconnecT nd,
382 GNUNET_SCHEDULER_TaskCallback start_cb,
386 struct GNUNET_TRANSPORT_TESTING_PeerContext *p;
387 struct GNUNET_PeerIdentity *dummy;
390 if (GNUNET_NO == GNUNET_DISK_file_test (cfgname))
392 LOG (GNUNET_ERROR_TYPE_ERROR,
393 "File not found: `%s'\n",
398 p = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_PeerContext);
402 if (NULL != handlers)
404 for (i=0;NULL != handlers[i].cb;i++) ;
405 p->handlers = GNUNET_new_array (i + 1,
406 struct GNUNET_MQ_MessageHandler);
407 GNUNET_memcpy (p->handlers,
409 i * sizeof (struct GNUNET_MQ_MessageHandler));
415 p->start_cb = start_cb;
416 p->start_cb_cls = start_cb_cls;
417 GNUNET_CONTAINER_DLL_insert (tth->p_head,
421 /* Create configuration and call testing lib to modify it */
422 p->cfg = GNUNET_CONFIGURATION_create ();
423 GNUNET_assert (GNUNET_OK ==
424 GNUNET_CONFIGURATION_load (p->cfg, cfgname));
426 GNUNET_TESTING_configuration_create (tth->tl_system,
429 LOG (GNUNET_ERROR_TYPE_ERROR,
430 "Testing library failed to create unique configuration based on `%s'\n",
432 GNUNET_CONFIGURATION_destroy (p->cfg);
438 /* Configure peer with configuration */
439 p->peer = GNUNET_TESTING_peer_configure (tth->tl_system,
446 LOG (GNUNET_ERROR_TYPE_ERROR,
447 "Testing library failed to create unique configuration based on `%s': `%s'\n",
450 GNUNET_TRANSPORT_TESTING_stop_peer (p);
451 GNUNET_free_non_null (emsg);
454 GNUNET_free_non_null (emsg);
455 if (GNUNET_OK != GNUNET_TESTING_peer_start (p->peer))
457 LOG (GNUNET_ERROR_TYPE_ERROR,
458 "Testing library failed to create unique configuration based on `%s'\n",
460 GNUNET_TRANSPORT_TESTING_stop_peer (p);
467 GNUNET_TESTING_peer_get_identity (p->peer,
469 if (0 == memcmp (&dummy,
471 sizeof (struct GNUNET_PeerIdentity)))
473 LOG (GNUNET_ERROR_TYPE_ERROR,
474 "Testing library failed to obtain peer identity for peer %u\n",
476 GNUNET_TRANSPORT_TESTING_stop_peer (p);
479 LOG (GNUNET_ERROR_TYPE_DEBUG,
480 "Peer %u configured with identity `%s'\n",
482 GNUNET_i2s_full (&p->id));
483 p->tmh = GNUNET_TRANSPORT_manipulation_connect (p->cfg);
484 p->th = GNUNET_TRANSPORT_core_connect (p->cfg,
491 if ( (NULL == p->th) ||
494 LOG (GNUNET_ERROR_TYPE_ERROR,
495 "Failed to connect to transport service for peer `%s': `%s'\n",
498 GNUNET_TRANSPORT_TESTING_stop_peer (p);
501 p->ats = GNUNET_ATS_connectivity_init (p->cfg);
504 LOG (GNUNET_ERROR_TYPE_ERROR,
505 "Failed to connect to ATS service for peer `%s': `%s'\n",
508 GNUNET_TRANSPORT_TESTING_stop_peer (p);
511 p->ghh = GNUNET_TRANSPORT_hello_get (p->cfg,
512 GNUNET_TRANSPORT_AC_ANY,
515 GNUNET_assert (NULL != p->ghh);
521 * Stops and restarts the given peer, sleeping (!) for 5s in between.
524 * @param restart_cb callback to call when restarted
525 * @param restart_cb_cls callback closure
526 * @return #GNUNET_OK in success otherwise #GNUNET_SYSERR
529 GNUNET_TRANSPORT_TESTING_restart_peer (struct GNUNET_TRANSPORT_TESTING_PeerContext *p,
530 GNUNET_SCHEDULER_TaskCallback restart_cb,
531 void *restart_cb_cls)
533 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
534 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
537 LOG (GNUNET_ERROR_TYPE_DEBUG,
538 "Stopping peer %u (`%s')\n",
540 GNUNET_i2s (&p->id));
543 GNUNET_TRANSPORT_hello_get_cancel (p->ghh);
548 GNUNET_TRANSPORT_core_disconnect (p->th);
553 GNUNET_TRANSPORT_manipulation_disconnect (p->tmh);
556 for (cc = p->tth->cc_head; NULL != cc; cc = ccn)
559 if ( (cc->p1 == p) ||
561 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
565 GNUNET_ATS_connectivity_done (p->ats);
569 GNUNET_TESTING_peer_stop (p->peer))
571 LOG (GNUNET_ERROR_TYPE_ERROR,
572 "Failed to stop peer %u (`%s')\n",
574 GNUNET_i2s (&p->id));
575 return GNUNET_SYSERR;
580 LOG (GNUNET_ERROR_TYPE_DEBUG,
581 "Restarting peer %u (`%s')\n",
583 GNUNET_i2s (&p->id));
585 if (GNUNET_SYSERR == GNUNET_TESTING_peer_start (p->peer))
587 LOG (GNUNET_ERROR_TYPE_ERROR,
588 "Failed to restart peer %u (`%s')\n",
590 GNUNET_i2s (&p->id));
591 return GNUNET_SYSERR;
594 GNUNET_assert (NULL == p->start_cb);
595 p->start_cb = restart_cb;
596 p->start_cb_cls = restart_cb_cls;
598 p->th = GNUNET_TRANSPORT_core_connect (p->cfg,
605 GNUNET_assert (NULL != p->th);
606 p->ats = GNUNET_ATS_connectivity_init (p->cfg);
607 p->ghh = GNUNET_TRANSPORT_hello_get (p->cfg,
608 GNUNET_TRANSPORT_AC_ANY,
611 GNUNET_assert (NULL != p->ghh);
617 * Shutdown the given peer
622 GNUNET_TRANSPORT_TESTING_stop_peer (struct GNUNET_TRANSPORT_TESTING_PeerContext *p)
624 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
625 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
626 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
628 for (cc = tth->cc_head; NULL != cc; cc = ccn)
631 if ( (cc->p1 == p) ||
633 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
637 GNUNET_TRANSPORT_hello_get_cancel (p->ghh);
642 GNUNET_TRANSPORT_manipulation_disconnect (p->tmh);
647 GNUNET_TRANSPORT_core_disconnect (p->th);
653 GNUNET_TESTING_peer_stop (p->peer))
655 LOG (GNUNET_ERROR_TYPE_DEBUG,
656 "Testing lib failed to stop peer %u (`%s')\n",
658 GNUNET_i2s (&p->id));
660 GNUNET_TESTING_peer_destroy (p->peer);
665 GNUNET_ATS_connectivity_done (p->ats);
668 if (NULL != p->hello)
670 GNUNET_free (p->hello);
675 GNUNET_CONFIGURATION_destroy (p->cfg);
678 GNUNET_CONTAINER_DLL_remove (tth->p_head,
681 LOG (GNUNET_ERROR_TYPE_DEBUG,
682 "Peer %u (`%s') stopped\n",
684 GNUNET_i2s (&p->id));
690 * Function called after the HELLO was passed to the
694 hello_offered (void *cls)
696 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc = cls;
699 cc->tct = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
706 * Offer the current HELLO of P2 to P1.
708 * @param cls our `struct GNUNET_TRANSPORT_TESTING_ConnectRequest`
711 offer_hello (void *cls)
713 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc = cls;
714 struct GNUNET_TRANSPORT_TESTING_PeerContext *p1 = cc->p1;
715 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2 = cc->p2;
719 char *p2_s = GNUNET_strdup (GNUNET_i2s (&p2->id));
721 LOG (GNUNET_ERROR_TYPE_DEBUG,
722 "Asking peer %u (`%s') to connect peer %u (`%s'), providing HELLO with %u bytes\n",
724 GNUNET_i2s (&p1->id),
727 GNUNET_HELLO_size (cc->p2->hello));
732 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
734 GNUNET_TRANSPORT_offer_hello (cc->p1->cfg,
735 (const struct GNUNET_MessageHeader *) cc->p2->hello,
742 * Initiate a connection from p1 to p2 by offering p1 p2's HELLO message
744 * Remarks: start_peer's notify_connect callback can be called before.
746 * @param tth transport testing handle
749 * @param cb the callback to call when both peers notified that they are connected
750 * @param cls callback cls
751 * @return a connect request handle
753 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *
754 GNUNET_TRANSPORT_TESTING_connect_peers (struct GNUNET_TRANSPORT_TESTING_PeerContext *p1,
755 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2,
756 GNUNET_SCHEDULER_TaskCallback cb,
759 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p1->tth;
760 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
761 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
764 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
766 if ( (cc->p1 == p1) &&
774 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
784 cc->p1_c = ccn->p1_c;
785 cc->p2_c = ccn->p2_c;
786 cc->connected = ccn->connected;
788 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
791 cc->tct = GNUNET_SCHEDULER_add_now (&offer_hello,
793 cc->ats_sh = GNUNET_ATS_connectivity_suggest (cc->p1->ats,
796 LOG (GNUNET_ERROR_TYPE_DEBUG,
797 "New connect request %p\n",
804 * Cancel the request to connect two peers
805 * Tou MUST cancel the request if you stop the peers before the peers connected succesfully
807 * @param tth transport testing handle
808 * @param cc a connect request handle
811 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc)
813 struct GNUNET_TRANSPORT_TESTING_Handle *tth = cc->p1->tth;
815 LOG (GNUNET_ERROR_TYPE_DEBUG,
816 "Canceling connect request!\n");
819 GNUNET_SCHEDULER_cancel (cc->tct);
824 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
827 if (NULL != cc->ats_sh)
829 GNUNET_ATS_connectivity_suggest_cancel (cc->ats_sh);
832 GNUNET_CONTAINER_DLL_remove (tth->cc_head,
840 * Clean up the transport testing
842 * @param tth transport testing handle
845 GNUNET_TRANSPORT_TESTING_done (struct GNUNET_TRANSPORT_TESTING_Handle *tth)
847 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
848 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ct;
849 struct GNUNET_TRANSPORT_TESTING_PeerContext *p;
850 struct GNUNET_TRANSPORT_TESTING_PeerContext *t;
858 LOG (GNUNET_ERROR_TYPE_ERROR,
859 "Developer forgot to cancel connect request!\n");
860 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
867 LOG (GNUNET_ERROR_TYPE_ERROR,
868 "Developer forgot to stop peer!\n");
869 GNUNET_TRANSPORT_TESTING_stop_peer (p);
872 GNUNET_TESTING_system_destroy (tth->tl_system,
880 * Initialize the transport testing
882 * @return transport testing handle
884 struct GNUNET_TRANSPORT_TESTING_Handle *
885 GNUNET_TRANSPORT_TESTING_init ()
887 struct GNUNET_TRANSPORT_TESTING_Handle *tth;
889 tth = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_Handle);
890 tth->tl_system = GNUNET_TESTING_system_create ("transport-testing",
894 if (NULL == tth->tl_system)
896 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
897 "Failed to initialize testing library!\n");
904 /* end of transport-testing.c */