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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
16 * @file transport-testing.c
17 * @brief testing lib for transport service
18 * @author Matthias Wachs
19 * @author Christian Grothoff
21 #include "transport-testing.h"
24 #define LOG(kind,...) GNUNET_log_from(kind, "transport-testing", __VA_ARGS__)
27 static struct GNUNET_TRANSPORT_TESTING_PeerContext *
28 find_peer_context (struct GNUNET_TRANSPORT_TESTING_Handle *tth,
29 const struct GNUNET_PeerIdentity *peer)
31 struct GNUNET_TRANSPORT_TESTING_PeerContext *t;
33 for (t = tth->p_head; NULL != t; t = t->next)
34 if (0 == memcmp (&t->id,
36 sizeof (struct GNUNET_PeerIdentity)))
43 * Find any connecting context matching the given pair of peers.
45 * @param p1 first peer
46 * @param p2 second peer
47 * @param cb function to call
48 * @param cb_cls closure for @a cb
51 GNUNET_TRANSPORT_TESTING_find_connecting_context (struct GNUNET_TRANSPORT_TESTING_PeerContext *p1,
52 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2,
53 GNUNET_TRANSPORT_TESTING_ConnectContextCallback cb,
56 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p1->tth;
57 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
58 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
60 for (cc = tth->cc_head; NULL != cc; cc = ccn)
63 if ( (cc->p1 == p1) &&
73 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
79 cx->p1_c = GNUNET_YES;
85 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
87 struct GNUNET_MQ_Handle *mq = cls;
95 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
101 cx->p2_c = GNUNET_YES;
106 clear_p1c (void *cls,
107 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
113 cx->p1_c = GNUNET_NO;
118 clear_p2c (void *cls,
119 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
125 cx->p2_c = GNUNET_NO;
130 notify_connect (void *cls,
131 const struct GNUNET_PeerIdentity *peer,
132 struct GNUNET_MQ_Handle *mq)
134 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cls;
135 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
137 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2;
138 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
139 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
143 p2 = find_peer_context (p->tth,
146 ret = p->nc (p->cb_cls,
153 GNUNET_asprintf (&p2_s,
156 GNUNET_i2s (&p2->id));
158 GNUNET_asprintf (&p2_s,
161 LOG (GNUNET_ERROR_TYPE_DEBUG,
162 "Peers %s connected to peer %u (`%s')\n",
165 GNUNET_i2s (&p->id));
167 /* update flags in connecting contexts */
169 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
173 if (GNUNET_NO == found)
175 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
178 cc->p1_c = GNUNET_YES;
179 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
184 GNUNET_TRANSPORT_TESTING_find_connecting_context (p2,
188 if (GNUNET_NO == found)
190 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
193 cc->p1_c = GNUNET_YES;
194 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
198 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
202 /* update set connected flag for all requests */
203 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
205 if (GNUNET_YES == cc->connected)
207 if ( (GNUNET_YES == cc->p1_c) &&
208 (GNUNET_YES == cc->p2_c) )
210 cc->connected = GNUNET_YES;
211 /* stop trying to connect */
214 GNUNET_SCHEDULER_cancel (cc->tct);
219 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
222 if (NULL != cc->ats_sh)
224 GNUNET_ATS_connectivity_suggest_cancel (cc->ats_sh);
229 /* then notify application */
230 for (cc = tth->cc_head; NULL != cc; cc = ccn)
233 if ( (GNUNET_YES == cc->connected) &&
237 cc->cb = NULL; /* only notify once! */
245 * Offer the current HELLO of P2 to P1.
247 * @param cls our `struct GNUNET_TRANSPORT_TESTING_ConnectRequest`
250 offer_hello (void *cls);
254 notify_disconnect (void *cls,
255 const struct GNUNET_PeerIdentity *peer,
258 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cls;
259 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
261 /* Find PeerContext */
263 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2 = NULL;
264 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
266 p2 = find_peer_context (p->tth,
270 GNUNET_asprintf (&p2_s,
273 GNUNET_i2s (&p2->id));
275 GNUNET_asprintf (&p2_s,
278 LOG (GNUNET_ERROR_TYPE_DEBUG,
279 "Peers %s disconnected from peer %u (`%s')\n",
282 GNUNET_i2s (&p->id));
284 /* notify about disconnect */
291 /* clear MQ, it is now invalid */
292 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
296 /* update set connected flags for all requests */
297 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
301 GNUNET_TRANSPORT_TESTING_find_connecting_context (p2,
305 /* resume connectivity requests as necessary */
306 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
308 if (GNUNET_NO == cc->connected)
310 if ( (GNUNET_YES != cc->p1_c) ||
311 (GNUNET_YES != cc->p2_c) )
313 cc->connected = GNUNET_NO;
314 /* start trying to connect */
315 if ( (NULL == cc->tct) &&
317 cc->tct = GNUNET_SCHEDULER_add_now (&offer_hello,
319 if (NULL == cc->ats_sh)
320 cc->ats_sh = GNUNET_ATS_connectivity_suggest (cc->p1->ats,
329 get_hello (void *cb_cls,
330 const struct GNUNET_MessageHeader *message)
332 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cb_cls;
333 struct GNUNET_PeerIdentity hello_id;
335 GNUNET_assert (GNUNET_OK ==
336 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *) message,
338 GNUNET_assert (0 == memcmp (&hello_id,
341 GNUNET_free_non_null (p->hello);
342 p->hello = (struct GNUNET_HELLO_Message *) GNUNET_copy_message (message);
344 if (NULL != p->start_cb)
346 LOG (GNUNET_ERROR_TYPE_DEBUG,
347 "Peer %u (`%s') successfully started\n",
349 GNUNET_i2s (&p->id));
350 p->start_cb (p->start_cb_cls);
357 * Start a peer with the given configuration
358 * @param tth the testing handle
359 * @param cfgname configuration file
360 * @param peer_id a unique number to identify the peer
361 * @param handlers functions for receiving messages
362 * @param nc connect callback
363 * @param nd disconnect callback
364 * @param cb_cls closure for callback
365 * @param start_cb start callback
366 * @param start_cb_cls closure for callback
367 * @return the peer context
369 struct GNUNET_TRANSPORT_TESTING_PeerContext *
370 GNUNET_TRANSPORT_TESTING_start_peer (struct GNUNET_TRANSPORT_TESTING_Handle *tth,
373 const struct GNUNET_MQ_MessageHandler *handlers,
374 GNUNET_TRANSPORT_NotifyConnecT nc,
375 GNUNET_TRANSPORT_NotifyDisconnecT nd,
377 GNUNET_SCHEDULER_TaskCallback start_cb,
381 struct GNUNET_TRANSPORT_TESTING_PeerContext *p;
382 struct GNUNET_PeerIdentity dummy;
385 if (GNUNET_NO == GNUNET_DISK_file_test (cfgname))
387 LOG (GNUNET_ERROR_TYPE_ERROR,
388 "File not found: `%s'\n",
393 p = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_PeerContext);
397 if (NULL != handlers)
399 for (i=0;NULL != handlers[i].cb;i++) ;
400 p->handlers = GNUNET_new_array (i + 1,
401 struct GNUNET_MQ_MessageHandler);
402 GNUNET_memcpy (p->handlers,
404 i * sizeof (struct GNUNET_MQ_MessageHandler));
410 p->start_cb = start_cb;
411 if (NULL != start_cb_cls)
412 p->start_cb_cls = start_cb_cls;
415 GNUNET_CONTAINER_DLL_insert (tth->p_head,
419 /* Create configuration and call testing lib to modify it */
420 p->cfg = GNUNET_CONFIGURATION_create ();
421 GNUNET_assert (GNUNET_OK ==
422 GNUNET_CONFIGURATION_load (p->cfg, cfgname));
424 GNUNET_TESTING_configuration_create (tth->tl_system,
427 LOG (GNUNET_ERROR_TYPE_ERROR,
428 "Testing library failed to create unique configuration based on `%s'\n",
430 GNUNET_CONFIGURATION_destroy (p->cfg);
436 /* Configure peer with configuration */
437 p->peer = GNUNET_TESTING_peer_configure (tth->tl_system,
444 LOG (GNUNET_ERROR_TYPE_ERROR,
445 "Testing library failed to create unique configuration based on `%s': `%s'\n",
448 GNUNET_TRANSPORT_TESTING_stop_peer (p);
449 GNUNET_free_non_null (emsg);
452 GNUNET_free_non_null (emsg);
453 if (GNUNET_OK != GNUNET_TESTING_peer_start (p->peer))
455 LOG (GNUNET_ERROR_TYPE_ERROR,
456 "Testing library failed to create unique configuration based on `%s'\n",
458 GNUNET_TRANSPORT_TESTING_stop_peer (p);
465 GNUNET_TESTING_peer_get_identity (p->peer,
467 if (0 == memcmp (&dummy,
469 sizeof (struct GNUNET_PeerIdentity)))
471 LOG (GNUNET_ERROR_TYPE_ERROR,
472 "Testing library failed to obtain peer identity for peer %u\n",
474 GNUNET_TRANSPORT_TESTING_stop_peer (p);
477 LOG (GNUNET_ERROR_TYPE_DEBUG,
478 "Peer %u configured with identity `%s'\n",
480 GNUNET_i2s_full (&p->id));
481 p->tmh = GNUNET_TRANSPORT_manipulation_connect (p->cfg);
482 p->th = GNUNET_TRANSPORT_core_connect (p->cfg,
489 if ( (NULL == p->th) ||
492 LOG (GNUNET_ERROR_TYPE_ERROR,
493 "Failed to connect to transport service for peer `%s': `%s'\n",
496 GNUNET_TRANSPORT_TESTING_stop_peer (p);
499 p->ats = GNUNET_ATS_connectivity_init (p->cfg);
502 LOG (GNUNET_ERROR_TYPE_ERROR,
503 "Failed to connect to ATS service for peer `%s': `%s'\n",
506 GNUNET_TRANSPORT_TESTING_stop_peer (p);
509 p->ghh = GNUNET_TRANSPORT_hello_get (p->cfg,
510 GNUNET_TRANSPORT_AC_ANY,
513 GNUNET_assert (NULL != p->ghh);
519 * Stops and restarts the given peer, sleeping (!) for 5s in between.
522 * @param restart_cb callback to call when restarted
523 * @param restart_cb_cls callback closure
524 * @return #GNUNET_OK in success otherwise #GNUNET_SYSERR
527 GNUNET_TRANSPORT_TESTING_restart_peer (struct GNUNET_TRANSPORT_TESTING_PeerContext *p,
528 GNUNET_SCHEDULER_TaskCallback restart_cb,
529 void *restart_cb_cls)
531 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
532 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
535 LOG (GNUNET_ERROR_TYPE_DEBUG,
536 "Stopping peer %u (`%s')\n",
538 GNUNET_i2s (&p->id));
541 GNUNET_TRANSPORT_hello_get_cancel (p->ghh);
546 GNUNET_TRANSPORT_core_disconnect (p->th);
551 GNUNET_TRANSPORT_manipulation_disconnect (p->tmh);
554 for (cc = p->tth->cc_head; NULL != cc; cc = ccn)
557 if ( (cc->p1 == p) ||
559 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
563 GNUNET_ATS_connectivity_done (p->ats);
567 GNUNET_TESTING_peer_stop (p->peer))
569 LOG (GNUNET_ERROR_TYPE_ERROR,
570 "Failed to stop peer %u (`%s')\n",
572 GNUNET_i2s (&p->id));
573 return GNUNET_SYSERR;
578 LOG (GNUNET_ERROR_TYPE_DEBUG,
579 "Restarting peer %u (`%s')\n",
581 GNUNET_i2s (&p->id));
583 if (GNUNET_SYSERR == GNUNET_TESTING_peer_start (p->peer))
585 LOG (GNUNET_ERROR_TYPE_ERROR,
586 "Failed to restart peer %u (`%s')\n",
588 GNUNET_i2s (&p->id));
589 return GNUNET_SYSERR;
592 GNUNET_assert (NULL == p->start_cb);
593 p->start_cb = restart_cb;
594 p->start_cb_cls = restart_cb_cls;
596 p->th = GNUNET_TRANSPORT_core_connect (p->cfg,
603 GNUNET_assert (NULL != p->th);
604 p->ats = GNUNET_ATS_connectivity_init (p->cfg);
605 p->ghh = GNUNET_TRANSPORT_hello_get (p->cfg,
606 GNUNET_TRANSPORT_AC_ANY,
609 GNUNET_assert (NULL != p->ghh);
615 * Shutdown the given peer
620 GNUNET_TRANSPORT_TESTING_stop_peer (struct GNUNET_TRANSPORT_TESTING_PeerContext *p)
622 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
623 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
624 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
626 for (cc = tth->cc_head; NULL != cc; cc = ccn)
629 if ( (cc->p1 == p) ||
631 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
635 GNUNET_TRANSPORT_hello_get_cancel (p->ghh);
640 GNUNET_TRANSPORT_manipulation_disconnect (p->tmh);
645 GNUNET_TRANSPORT_core_disconnect (p->th);
651 GNUNET_TESTING_peer_stop (p->peer))
653 LOG (GNUNET_ERROR_TYPE_DEBUG,
654 "Testing lib failed to stop peer %u (`%s')\n",
656 GNUNET_i2s (&p->id));
658 GNUNET_TESTING_peer_destroy (p->peer);
663 GNUNET_ATS_connectivity_done (p->ats);
666 if (NULL != p->hello)
668 GNUNET_free (p->hello);
673 GNUNET_CONFIGURATION_destroy (p->cfg);
676 if (NULL != p->handlers)
678 GNUNET_free (p->handlers);
681 GNUNET_CONTAINER_DLL_remove (tth->p_head,
684 LOG (GNUNET_ERROR_TYPE_DEBUG,
685 "Peer %u (`%s') stopped\n",
687 GNUNET_i2s (&p->id));
693 * Function called after the HELLO was passed to the
697 hello_offered (void *cls)
699 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc = cls;
702 cc->tct = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
709 * Offer the current HELLO of P2 to P1.
711 * @param cls our `struct GNUNET_TRANSPORT_TESTING_ConnectRequest`
714 offer_hello (void *cls)
716 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc = cls;
717 struct GNUNET_TRANSPORT_TESTING_PeerContext *p1 = cc->p1;
718 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2 = cc->p2;
722 char *p2_s = GNUNET_strdup (GNUNET_i2s (&p2->id));
724 LOG (GNUNET_ERROR_TYPE_DEBUG,
725 "Asking peer %u (`%s') to connect peer %u (`%s'), providing HELLO with %u bytes\n",
727 GNUNET_i2s (&p1->id),
730 GNUNET_HELLO_size (cc->p2->hello));
735 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
737 GNUNET_TRANSPORT_offer_hello (cc->p1->cfg,
738 (const struct GNUNET_MessageHeader *) cc->p2->hello,
745 * Initiate a connection from p1 to p2 by offering p1 p2's HELLO message
747 * Remarks: start_peer's notify_connect callback can be called before.
749 * @param tth transport testing handle
752 * @param cb the callback to call when both peers notified that they are connected
753 * @param cls callback cls
754 * @return a connect request handle
756 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *
757 GNUNET_TRANSPORT_TESTING_connect_peers (struct GNUNET_TRANSPORT_TESTING_PeerContext *p1,
758 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2,
759 GNUNET_SCHEDULER_TaskCallback cb,
762 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p1->tth;
763 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
764 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
767 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
769 if ( (cc->p1 == p1) &&
777 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
787 cc->p1_c = ccn->p1_c;
788 cc->p2_c = ccn->p2_c;
789 cc->connected = ccn->connected;
791 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
794 cc->tct = GNUNET_SCHEDULER_add_now (&offer_hello,
796 cc->ats_sh = GNUNET_ATS_connectivity_suggest (cc->p1->ats,
799 LOG (GNUNET_ERROR_TYPE_DEBUG,
800 "New connect request %p\n",
807 * Cancel the request to connect two peers
808 * Tou MUST cancel the request if you stop the peers before the peers connected succesfully
810 * @param tth transport testing handle
811 * @param cc a connect request handle
814 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc)
816 struct GNUNET_TRANSPORT_TESTING_Handle *tth = cc->p1->tth;
818 LOG (GNUNET_ERROR_TYPE_DEBUG,
819 "Canceling connect request!\n");
822 GNUNET_SCHEDULER_cancel (cc->tct);
827 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
830 if (NULL != cc->ats_sh)
832 GNUNET_ATS_connectivity_suggest_cancel (cc->ats_sh);
835 GNUNET_CONTAINER_DLL_remove (tth->cc_head,
843 * Clean up the transport testing
845 * @param tth transport testing handle
848 GNUNET_TRANSPORT_TESTING_done (struct GNUNET_TRANSPORT_TESTING_Handle *tth)
850 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
851 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ct;
852 struct GNUNET_TRANSPORT_TESTING_PeerContext *p;
853 struct GNUNET_TRANSPORT_TESTING_PeerContext *t;
861 LOG (GNUNET_ERROR_TYPE_ERROR,
862 "Developer forgot to cancel connect request!\n");
863 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
870 LOG (GNUNET_ERROR_TYPE_ERROR,
871 "Developer forgot to stop peer!\n");
872 GNUNET_TRANSPORT_TESTING_stop_peer (p);
875 GNUNET_TESTING_system_destroy (tth->tl_system,
883 * Initialize the transport testing
885 * @return transport testing handle
887 struct GNUNET_TRANSPORT_TESTING_Handle *
888 GNUNET_TRANSPORT_TESTING_init ()
890 struct GNUNET_TRANSPORT_TESTING_Handle *tth;
892 tth = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_Handle);
893 tth->tl_system = GNUNET_TESTING_system_create ("transport-testing",
897 if (NULL == tth->tl_system)
899 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
900 "Failed to initialize testing library!\n");
907 /* end of transport-testing.c */