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)
96 cx->p2_c = GNUNET_YES;
101 clear_p1c (void *cls,
102 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
108 cx->p1_c = GNUNET_NO;
113 clear_p2c (void *cls,
114 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
120 cx->p2_c = GNUNET_NO;
125 notify_connect (void *cls,
126 const struct GNUNET_PeerIdentity *peer)
128 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cls;
129 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
131 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2;
132 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
133 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
136 p2 = find_peer_context (p->tth,
143 GNUNET_asprintf (&p2_s,
146 GNUNET_i2s (&p2->id));
148 GNUNET_asprintf (&p2_s,
151 LOG (GNUNET_ERROR_TYPE_DEBUG,
152 "Peers %s connected to peer %u (`%s')\n",
155 GNUNET_i2s (&p->id));
157 /* update flags in connecting contexts */
159 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
163 if (GNUNET_NO == found)
165 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
168 cc->p1_c = GNUNET_YES;
169 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
174 GNUNET_TRANSPORT_TESTING_find_connecting_context (p2,
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,
188 /* update set connected flag for all requests */
189 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
191 if (GNUNET_YES == cc->connected)
193 if ( (GNUNET_YES == cc->p1_c) &&
194 (GNUNET_YES == cc->p2_c) )
196 cc->connected = GNUNET_YES;
197 /* stop trying to connect */
200 GNUNET_SCHEDULER_cancel (cc->tct);
205 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
208 if (NULL != cc->ats_sh)
210 GNUNET_ATS_connectivity_suggest_cancel (cc->ats_sh);
215 /* then notify application */
216 for (cc = tth->cc_head; NULL != cc; cc = ccn)
219 if ( (GNUNET_YES == cc->connected) &&
223 cc->cb = NULL; /* only notify once! */
230 * Offer the current HELLO of P2 to P1.
232 * @param cls our `struct GNUNET_TRANSPORT_TESTING_ConnectRequest`
235 offer_hello (void *cls);
239 notify_disconnect (void *cls,
240 const struct GNUNET_PeerIdentity *peer)
242 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cls;
243 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
245 /* Find PeerContext */
247 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2 = NULL;
248 struct TRANSPORT_TESTING_SendJob *sj;
249 struct TRANSPORT_TESTING_SendJob *sjn;
250 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
252 p2 = find_peer_context (p->tth,
256 GNUNET_asprintf (&p2_s,
259 GNUNET_i2s (&p2->id));
261 GNUNET_asprintf (&p2_s,
264 LOG (GNUNET_ERROR_TYPE_DEBUG,
265 "Peers %s disconnected from peer %u (`%s')\n",
268 GNUNET_i2s (&p->id));
270 /* notify about disconnect */
276 /* abort all transmissions this disconnected pair is involved in */
277 for (sj = tth->sj_head; NULL != sj; sj = sjn)
280 if ( ( (sj->sender == p2) &&
281 (sj->receiver == p) ) ||
282 ( (sj->receiver == p2) &&
283 (sj->sender == p) ) )
285 GNUNET_CONTAINER_DLL_remove (tth->sj_head,
288 GNUNET_TRANSPORT_notify_transmit_ready_cancel (sj->th);
292 /* update set connected flags for all requests */
293 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
297 GNUNET_TRANSPORT_TESTING_find_connecting_context (p2,
301 /* resume connectivity requests as necessary */
302 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
304 if (GNUNET_NO == cc->connected)
306 if ( (GNUNET_YES != cc->p1_c) ||
307 (GNUNET_YES != cc->p2_c) )
309 cc->connected = GNUNET_NO;
310 /* start trying to connect */
311 if ( (NULL == cc->tct) &&
313 cc->tct = GNUNET_SCHEDULER_add_now (&offer_hello,
315 if (NULL == cc->ats_sh)
316 cc->ats_sh = GNUNET_ATS_connectivity_suggest (cc->p1->ats,
325 notify_receive (void *cls,
326 const struct GNUNET_PeerIdentity *peer,
327 const struct GNUNET_MessageHeader *message)
329 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cls;
341 get_hello (void *cb_cls,
342 const struct GNUNET_MessageHeader *message)
344 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cb_cls;
345 struct GNUNET_PeerIdentity hello_id;
347 GNUNET_assert (GNUNET_OK ==
348 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) message,
350 GNUNET_assert (0 == memcmp (&hello_id,
353 GNUNET_free_non_null (p->hello);
354 p->hello = (struct GNUNET_HELLO_Message *) GNUNET_copy_message (message);
356 if (NULL != p->start_cb)
358 LOG (GNUNET_ERROR_TYPE_DEBUG,
359 "Peer %u (`%s') successfully started\n",
361 GNUNET_i2s (&p->id));
370 * Start a peer with the given configuration
371 * @param tth the testing handle
372 * @param cfgname configuration file
373 * @param peer_id a unique number to identify the peer
374 * @param rec receive callback
375 * @param nc connect callback
376 * @param nd disconnect callback
377 * @param cb_cls closure for callback
378 * @param start_cb start callback
379 * @param start_cb_cls closure for callback
380 * @return the peer context
382 struct GNUNET_TRANSPORT_TESTING_PeerContext *
383 GNUNET_TRANSPORT_TESTING_start_peer (struct GNUNET_TRANSPORT_TESTING_Handle *tth,
386 GNUNET_TRANSPORT_ReceiveCallback rec,
387 GNUNET_TRANSPORT_NotifyConnect nc,
388 GNUNET_TRANSPORT_NotifyDisconnect nd,
390 GNUNET_TRANSPORT_TESTING_StartCallback start_cb,
394 struct GNUNET_TRANSPORT_TESTING_PeerContext *p;
395 struct GNUNET_PeerIdentity *dummy;
397 if (GNUNET_NO == GNUNET_DISK_file_test (cfgname))
399 LOG (GNUNET_ERROR_TYPE_ERROR,
400 "File not found: `%s'\n",
405 p = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_PeerContext);
414 p->start_cb = start_cb;
415 p->start_cb_cls = start_cb_cls;
416 GNUNET_CONTAINER_DLL_insert (tth->p_head,
420 /* Create configuration and call testing lib to modify it */
421 p->cfg = GNUNET_CONFIGURATION_create ();
422 GNUNET_assert (GNUNET_OK ==
423 GNUNET_CONFIGURATION_load (p->cfg, cfgname));
425 GNUNET_TESTING_configuration_create (tth->tl_system,
428 LOG (GNUNET_ERROR_TYPE_ERROR,
429 "Testing library failed to create unique configuration based on `%s'\n",
431 GNUNET_CONFIGURATION_destroy (p->cfg);
437 /* Configure peer with configuration */
438 p->peer = GNUNET_TESTING_peer_configure (tth->tl_system,
445 LOG (GNUNET_ERROR_TYPE_ERROR,
446 "Testing library failed to create unique configuration based on `%s': `%s'\n",
449 GNUNET_TRANSPORT_TESTING_stop_peer (p);
450 GNUNET_free_non_null (emsg);
453 GNUNET_free_non_null (emsg);
454 if (GNUNET_OK != GNUNET_TESTING_peer_start (p->peer))
456 LOG (GNUNET_ERROR_TYPE_ERROR,
457 "Testing library failed to create unique configuration based on `%s'\n",
459 GNUNET_TRANSPORT_TESTING_stop_peer (p);
466 GNUNET_TESTING_peer_get_identity (p->peer,
468 if (0 == memcmp (&dummy,
470 sizeof (struct GNUNET_PeerIdentity)))
472 LOG (GNUNET_ERROR_TYPE_ERROR,
473 "Testing library failed to obtain peer identity for peer %u\n",
475 GNUNET_TRANSPORT_TESTING_stop_peer (p);
478 LOG (GNUNET_ERROR_TYPE_DEBUG,
479 "Peer %u configured with identity `%s'\n",
481 GNUNET_i2s_full (&p->id));
483 p->th = GNUNET_TRANSPORT_connect (p->cfg,
491 LOG (GNUNET_ERROR_TYPE_ERROR,
492 "Failed to connect to transport service for peer `%s': `%s'\n",
495 GNUNET_TRANSPORT_TESTING_stop_peer (p);
498 p->ats = GNUNET_ATS_connectivity_init (p->cfg);
501 LOG (GNUNET_ERROR_TYPE_ERROR,
502 "Failed to connect to ATS service for peer `%s': `%s'\n",
505 GNUNET_TRANSPORT_TESTING_stop_peer (p);
508 p->ghh = GNUNET_TRANSPORT_get_hello (p->cfg,
511 GNUNET_assert (p->ghh != NULL);
517 * Stops and restarts the given peer, sleeping (!) for 5s in between.
520 * @param restart_cb callback to call when restarted
521 * @param restart_cb_cls callback closure
522 * @return #GNUNET_OK in success otherwise #GNUNET_SYSERR
525 GNUNET_TRANSPORT_TESTING_restart_peer (struct GNUNET_TRANSPORT_TESTING_PeerContext *p,
526 GNUNET_TRANSPORT_TESTING_StartCallback restart_cb,
527 void *restart_cb_cls)
529 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
530 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
533 LOG (GNUNET_ERROR_TYPE_DEBUG,
534 "Stopping peer %u (`%s')\n",
536 GNUNET_i2s (&p->id));
539 GNUNET_TRANSPORT_get_hello_cancel (p->ghh);
544 GNUNET_TRANSPORT_disconnect (p->th);
547 for (cc = p->tth->cc_head; NULL != cc; cc = ccn)
550 if ( (cc->p1 == p) ||
552 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
556 GNUNET_ATS_connectivity_done (p->ats);
560 GNUNET_TESTING_peer_stop (p->peer))
562 LOG (GNUNET_ERROR_TYPE_ERROR,
563 "Failed to stop peer %u (`%s')\n",
565 GNUNET_i2s (&p->id));
566 return GNUNET_SYSERR;
571 LOG (GNUNET_ERROR_TYPE_DEBUG,
572 "Restarting peer %u (`%s')\n",
574 GNUNET_i2s (&p->id));
576 if (GNUNET_SYSERR == GNUNET_TESTING_peer_start (p->peer))
578 LOG (GNUNET_ERROR_TYPE_ERROR,
579 "Failed to restart peer %u (`%s')\n",
581 GNUNET_i2s (&p->id));
582 return GNUNET_SYSERR;
585 GNUNET_assert (NULL == p->start_cb);
586 p->start_cb = restart_cb;
587 p->start_cb_cls = restart_cb_cls;
589 p->th = GNUNET_TRANSPORT_connect (p->cfg,
595 GNUNET_assert (NULL != p->th);
596 p->ats = GNUNET_ATS_connectivity_init (p->cfg);
597 p->ghh = GNUNET_TRANSPORT_get_hello (p->cfg,
600 GNUNET_assert (NULL != p->ghh);
606 * Shutdown the given peer
611 GNUNET_TRANSPORT_TESTING_stop_peer (struct GNUNET_TRANSPORT_TESTING_PeerContext *p)
613 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
614 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
615 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
617 for (cc = tth->cc_head; NULL != cc; cc = ccn)
620 if ( (cc->p1 == p) ||
622 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
626 GNUNET_TRANSPORT_get_hello_cancel (p->ghh);
631 GNUNET_TRANSPORT_disconnect (p->th);
637 GNUNET_TESTING_peer_stop (p->peer))
639 LOG (GNUNET_ERROR_TYPE_DEBUG,
640 "Testing lib failed to stop peer %u (`%s')\n",
642 GNUNET_i2s (&p->id));
644 GNUNET_TESTING_peer_destroy (p->peer);
649 GNUNET_ATS_connectivity_done (p->ats);
652 if (NULL != p->hello)
654 GNUNET_free (p->hello);
659 GNUNET_CONFIGURATION_destroy (p->cfg);
662 GNUNET_CONTAINER_DLL_remove (tth->p_head,
665 LOG (GNUNET_ERROR_TYPE_DEBUG,
666 "Peer %u (`%s') stopped\n",
668 GNUNET_i2s (&p->id));
674 * Function called after the HELLO was passed to the
678 hello_offered (void *cls)
680 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc = cls;
683 cc->tct = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
690 * Offer the current HELLO of P2 to P1.
692 * @param cls our `struct GNUNET_TRANSPORT_TESTING_ConnectRequest`
695 offer_hello (void *cls)
697 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc = cls;
698 struct GNUNET_TRANSPORT_TESTING_PeerContext *p1 = cc->p1;
699 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2 = cc->p2;
703 char *p2_s = GNUNET_strdup (GNUNET_i2s (&p2->id));
705 LOG (GNUNET_ERROR_TYPE_DEBUG,
706 "Asking peer %u (`%s') to connect peer %u (`%s'), providing HELLO with %u bytes\n",
708 GNUNET_i2s (&p1->id),
711 GNUNET_HELLO_size (cc->p2->hello));
716 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
718 GNUNET_TRANSPORT_offer_hello (cc->p1->cfg,
719 (const struct GNUNET_MessageHeader *) cc->p2->hello,
726 * Initiate a connection from p1 to p2 by offering p1 p2's HELLO message
728 * Remarks: start_peer's notify_connect callback can be called before.
730 * @param tth transport testing handle
733 * @param cb the callback to call when both peers notified that they are connected
734 * @param cls callback cls
735 * @return a connect request handle
737 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *
738 GNUNET_TRANSPORT_TESTING_connect_peers (struct GNUNET_TRANSPORT_TESTING_PeerContext *p1,
739 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2,
740 GNUNET_SCHEDULER_TaskCallback cb,
743 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p1->tth;
744 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
745 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
748 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
750 if ( (cc->p1 == p1) &&
758 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
768 cc->p1_c = ccn->p1_c;
769 cc->p2_c = ccn->p2_c;
770 cc->connected = ccn->connected;
772 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
775 cc->tct = GNUNET_SCHEDULER_add_now (&offer_hello,
777 cc->ats_sh = GNUNET_ATS_connectivity_suggest (cc->p1->ats,
780 LOG (GNUNET_ERROR_TYPE_DEBUG,
781 "New connect request %p\n",
788 * Cancel the request to connect two peers
789 * Tou MUST cancel the request if you stop the peers before the peers connected succesfully
791 * @param tth transport testing handle
792 * @param cc a connect request handle
795 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc)
797 struct GNUNET_TRANSPORT_TESTING_Handle *tth = cc->p1->tth;
799 LOG (GNUNET_ERROR_TYPE_DEBUG,
800 "Canceling connect request!\n");
803 GNUNET_SCHEDULER_cancel (cc->tct);
808 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
811 if (NULL != cc->ats_sh)
813 GNUNET_ATS_connectivity_suggest_cancel (cc->ats_sh);
816 GNUNET_CONTAINER_DLL_remove (tth->cc_head,
824 * Clean up the transport testing
826 * @param tth transport testing handle
829 GNUNET_TRANSPORT_TESTING_done (struct GNUNET_TRANSPORT_TESTING_Handle *tth)
831 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
832 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ct;
833 struct GNUNET_TRANSPORT_TESTING_PeerContext *p;
834 struct GNUNET_TRANSPORT_TESTING_PeerContext *t;
842 LOG (GNUNET_ERROR_TYPE_ERROR,
843 "Developer forgot to cancel connect request!\n");
844 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
851 LOG (GNUNET_ERROR_TYPE_ERROR,
852 "Developer forgot to stop peer!\n");
853 GNUNET_TRANSPORT_TESTING_stop_peer (p);
856 GNUNET_TESTING_system_destroy (tth->tl_system,
864 * Initialize the transport testing
866 * @return transport testing handle
868 struct GNUNET_TRANSPORT_TESTING_Handle *
869 GNUNET_TRANSPORT_TESTING_init ()
871 struct GNUNET_TRANSPORT_TESTING_Handle *tth;
873 tth = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_Handle);
874 tth->tl_system = GNUNET_TESTING_system_create ("transport-testing",
878 if (NULL == tth->tl_system)
880 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
881 "Failed to initialize testing library!\n");
888 /* end of transport-testing.c */