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.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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
57 GNUNET_TRANSPORT_TESTING_PeerContext
60 GNUNET_TRANSPORT_TESTING_PeerContext
62 GNUNET_TRANSPORT_TESTING_ConnectContextCallback
66 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p1->tth;
67 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
68 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
70 for (cc = tth->cc_head; NULL != cc; cc = ccn)
83 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
89 cx->p1_c = GNUNET_YES;
95 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
97 struct GNUNET_MQ_Handle *mq = cls;
105 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
111 cx->p2_c = GNUNET_YES;
116 clear_p1c (void *cls,
117 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
123 cx->p1_c = GNUNET_NO;
128 clear_p2c (void *cls,
129 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cx)
135 cx->p2_c = GNUNET_NO;
140 notify_connect (void *cls,
141 const struct GNUNET_PeerIdentity *peer,
142 struct GNUNET_MQ_Handle *mq)
144 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cls;
145 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
147 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2;
148 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
149 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
153 p2 = find_peer_context (p->tth,
156 ret = p->nc (p->cb_cls,
163 GNUNET_asprintf (&p2_s,
166 GNUNET_i2s (&p2->id));
168 GNUNET_asprintf (&p2_s,
171 LOG (GNUNET_ERROR_TYPE_DEBUG,
172 "Peers %s connected to peer %u (`%s')\n",
175 GNUNET_i2s (&p->id));
177 /* update flags in connecting contexts */
179 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
183 if (GNUNET_NO == found)
185 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
188 cc->p1_c = GNUNET_YES;
189 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
194 GNUNET_TRANSPORT_TESTING_find_connecting_context (p2,
198 if (GNUNET_NO == found)
200 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
203 cc->p1_c = GNUNET_YES;
204 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
208 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
212 /* update set connected flag for all requests */
213 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
215 if (GNUNET_YES == cc->connected)
217 if ((GNUNET_YES == cc->p1_c) &&
218 (GNUNET_YES == cc->p2_c))
220 cc->connected = GNUNET_YES;
221 /* stop trying to connect */
224 GNUNET_SCHEDULER_cancel (cc->tct);
229 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
232 if (NULL != cc->ats_sh)
234 GNUNET_ATS_connectivity_suggest_cancel (cc->ats_sh);
239 /* then notify application */
240 for (cc = tth->cc_head; NULL != cc; cc = ccn)
243 if ((GNUNET_YES == cc->connected) &&
247 cc->cb = NULL; /* only notify once! */
255 * Offer the current HELLO of P2 to P1.
257 * @param cls our `struct GNUNET_TRANSPORT_TESTING_ConnectRequest`
260 offer_hello (void *cls);
264 notify_disconnect (void *cls,
265 const struct GNUNET_PeerIdentity *peer,
268 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cls;
269 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
271 /* Find PeerContext */
273 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2 = NULL;
274 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
276 p2 = find_peer_context (p->tth,
280 GNUNET_asprintf (&p2_s,
283 GNUNET_i2s (&p2->id));
285 GNUNET_asprintf (&p2_s,
288 LOG (GNUNET_ERROR_TYPE_DEBUG,
289 "Peers %s disconnected from peer %u (`%s')\n",
292 GNUNET_i2s (&p->id));
294 /* notify about disconnect */
301 /* clear MQ, it is now invalid */
302 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
306 /* update set connected flags for all requests */
307 GNUNET_TRANSPORT_TESTING_find_connecting_context (p,
311 GNUNET_TRANSPORT_TESTING_find_connecting_context (p2,
315 /* resume connectivity requests as necessary */
316 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
318 if (GNUNET_NO == cc->connected)
320 if ((GNUNET_YES != cc->p1_c) ||
321 (GNUNET_YES != cc->p2_c))
323 cc->connected = GNUNET_NO;
324 /* start trying to connect */
325 if ((NULL == cc->tct) &&
327 cc->tct = GNUNET_SCHEDULER_add_now (&offer_hello,
329 if (NULL == cc->ats_sh)
330 cc->ats_sh = GNUNET_ATS_connectivity_suggest (cc->p1->ats,
339 get_hello (void *cb_cls,
340 const struct GNUNET_MessageHeader *message)
342 struct GNUNET_TRANSPORT_TESTING_PeerContext *p = cb_cls;
343 struct GNUNET_PeerIdentity hello_id;
345 GNUNET_assert (GNUNET_OK ==
346 GNUNET_HELLO_get_id ((const struct
347 GNUNET_HELLO_Message *) message,
349 GNUNET_assert (0 == memcmp (&hello_id,
352 GNUNET_free_non_null (p->hello);
353 p->hello = (struct GNUNET_HELLO_Message *) GNUNET_copy_message (message);
355 if (NULL != p->start_cb)
357 LOG (GNUNET_ERROR_TYPE_DEBUG,
358 "Peer %u (`%s') successfully started\n",
360 GNUNET_i2s (&p->id));
361 p->start_cb (p->start_cb_cls);
368 * Start a peer with the given configuration
369 * @param tth the testing handle
370 * @param cfgname configuration file
371 * @param peer_id a unique number to identify the peer
372 * @param handlers functions for receiving messages
373 * @param nc connect callback
374 * @param nd disconnect callback
375 * @param cb_cls closure for callback
376 * @param start_cb start callback
377 * @param start_cb_cls closure for callback
378 * @return the peer context
380 struct GNUNET_TRANSPORT_TESTING_PeerContext *
381 GNUNET_TRANSPORT_TESTING_start_peer (struct
382 GNUNET_TRANSPORT_TESTING_Handle *tth,
386 GNUNET_MQ_MessageHandler *handlers,
387 GNUNET_TRANSPORT_NotifyConnect nc,
388 GNUNET_TRANSPORT_NotifyDisconnect nd,
390 GNUNET_SCHEDULER_TaskCallback start_cb,
394 struct GNUNET_TRANSPORT_TESTING_PeerContext *p;
395 struct GNUNET_PeerIdentity dummy;
398 if (GNUNET_NO == GNUNET_DISK_file_test (cfgname))
400 LOG (GNUNET_ERROR_TYPE_ERROR,
401 "File not found: `%s'\n",
406 p = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_PeerContext);
410 if (NULL != handlers)
412 for (i = 0; NULL != handlers[i].cb; i++)
414 p->handlers = GNUNET_new_array (i + 1,
415 struct GNUNET_MQ_MessageHandler);
416 GNUNET_memcpy (p->handlers,
418 i * sizeof(struct GNUNET_MQ_MessageHandler));
424 p->start_cb = start_cb;
425 if (NULL != start_cb_cls)
426 p->start_cb_cls = start_cb_cls;
429 GNUNET_CONTAINER_DLL_insert (tth->p_head,
433 /* Create configuration and call testing lib to modify it */
434 p->cfg = GNUNET_CONFIGURATION_create ();
435 GNUNET_assert (GNUNET_OK ==
436 GNUNET_CONFIGURATION_load (p->cfg, cfgname));
438 GNUNET_TESTING_configuration_create (tth->tl_system,
441 LOG (GNUNET_ERROR_TYPE_ERROR,
442 "Testing library failed to create unique configuration based on `%s'\n",
444 GNUNET_CONFIGURATION_destroy (p->cfg);
450 /* Configure peer with configuration */
451 p->peer = GNUNET_TESTING_peer_configure (tth->tl_system,
458 LOG (GNUNET_ERROR_TYPE_ERROR,
459 "Testing library failed to create unique configuration based on `%s': `%s'\n",
462 GNUNET_TRANSPORT_TESTING_stop_peer (p);
463 GNUNET_free_non_null (emsg);
466 GNUNET_free_non_null (emsg);
467 if (GNUNET_OK != GNUNET_TESTING_peer_start (p->peer))
469 LOG (GNUNET_ERROR_TYPE_ERROR,
470 "Testing library failed to create unique configuration based on `%s'\n",
472 GNUNET_TRANSPORT_TESTING_stop_peer (p);
479 GNUNET_TESTING_peer_get_identity (p->peer,
481 if (0 == memcmp (&dummy,
483 sizeof(struct GNUNET_PeerIdentity)))
485 LOG (GNUNET_ERROR_TYPE_ERROR,
486 "Testing library failed to obtain peer identity for peer %u\n",
488 GNUNET_TRANSPORT_TESTING_stop_peer (p);
491 LOG (GNUNET_ERROR_TYPE_DEBUG,
492 "Peer %u configured with identity `%s'\n",
494 GNUNET_i2s_full (&p->id));
495 p->tmh = GNUNET_TRANSPORT_manipulation_connect (p->cfg);
496 p->th = GNUNET_TRANSPORT_core_connect (p->cfg,
503 if ((NULL == p->th) ||
506 LOG (GNUNET_ERROR_TYPE_ERROR,
507 "Failed to connect to transport service for peer `%s': `%s'\n",
510 GNUNET_TRANSPORT_TESTING_stop_peer (p);
513 p->ats = GNUNET_ATS_connectivity_init (p->cfg);
516 LOG (GNUNET_ERROR_TYPE_ERROR,
517 "Failed to connect to ATS service for peer `%s': `%s'\n",
520 GNUNET_TRANSPORT_TESTING_stop_peer (p);
523 p->ghh = GNUNET_TRANSPORT_hello_get (p->cfg,
524 GNUNET_TRANSPORT_AC_ANY,
527 GNUNET_assert (NULL != p->ghh);
533 * Stops and restarts the given peer, sleeping (!) for 5s in between.
536 * @param restart_cb callback to call when restarted
537 * @param restart_cb_cls callback closure
538 * @return #GNUNET_OK in success otherwise #GNUNET_SYSERR
541 GNUNET_TRANSPORT_TESTING_restart_peer (struct
542 GNUNET_TRANSPORT_TESTING_PeerContext *p,
543 GNUNET_SCHEDULER_TaskCallback restart_cb,
544 void *restart_cb_cls)
546 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
547 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
550 LOG (GNUNET_ERROR_TYPE_DEBUG,
551 "Stopping peer %u (`%s')\n",
553 GNUNET_i2s (&p->id));
556 GNUNET_TRANSPORT_hello_get_cancel (p->ghh);
561 GNUNET_TRANSPORT_core_disconnect (p->th);
566 GNUNET_TRANSPORT_manipulation_disconnect (p->tmh);
569 for (cc = p->tth->cc_head; NULL != cc; cc = ccn)
574 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
578 GNUNET_ATS_connectivity_done (p->ats);
582 GNUNET_TESTING_peer_stop (p->peer))
584 LOG (GNUNET_ERROR_TYPE_ERROR,
585 "Failed to stop peer %u (`%s')\n",
587 GNUNET_i2s (&p->id));
588 return GNUNET_SYSERR;
593 LOG (GNUNET_ERROR_TYPE_DEBUG,
594 "Restarting peer %u (`%s')\n",
596 GNUNET_i2s (&p->id));
598 if (GNUNET_SYSERR == GNUNET_TESTING_peer_start (p->peer))
600 LOG (GNUNET_ERROR_TYPE_ERROR,
601 "Failed to restart peer %u (`%s')\n",
603 GNUNET_i2s (&p->id));
604 return GNUNET_SYSERR;
607 GNUNET_assert (NULL == p->start_cb);
608 p->start_cb = restart_cb;
609 p->start_cb_cls = restart_cb_cls;
611 p->th = GNUNET_TRANSPORT_core_connect (p->cfg,
618 GNUNET_assert (NULL != p->th);
619 p->ats = GNUNET_ATS_connectivity_init (p->cfg);
620 p->ghh = GNUNET_TRANSPORT_hello_get (p->cfg,
621 GNUNET_TRANSPORT_AC_ANY,
624 GNUNET_assert (NULL != p->ghh);
630 * Shutdown the given peer
635 GNUNET_TRANSPORT_TESTING_stop_peer (struct
636 GNUNET_TRANSPORT_TESTING_PeerContext *p)
638 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p->tth;
639 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
640 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
642 for (cc = tth->cc_head; NULL != cc; cc = ccn)
647 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
651 GNUNET_TRANSPORT_hello_get_cancel (p->ghh);
656 GNUNET_TRANSPORT_manipulation_disconnect (p->tmh);
661 GNUNET_TRANSPORT_core_disconnect (p->th);
667 GNUNET_TESTING_peer_stop (p->peer))
669 LOG (GNUNET_ERROR_TYPE_DEBUG,
670 "Testing lib failed to stop peer %u (`%s')\n",
672 GNUNET_i2s (&p->id));
674 GNUNET_TESTING_peer_destroy (p->peer);
679 GNUNET_ATS_connectivity_done (p->ats);
682 if (NULL != p->hello)
684 GNUNET_free (p->hello);
689 GNUNET_CONFIGURATION_destroy (p->cfg);
692 if (NULL != p->handlers)
694 GNUNET_free (p->handlers);
697 GNUNET_CONTAINER_DLL_remove (tth->p_head,
700 LOG (GNUNET_ERROR_TYPE_DEBUG,
701 "Peer %u (`%s') stopped\n",
703 GNUNET_i2s (&p->id));
709 * Function called after the HELLO was passed to the
713 hello_offered (void *cls)
715 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc = cls;
718 cc->tct = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS,
725 * Offer the current HELLO of P2 to P1.
727 * @param cls our `struct GNUNET_TRANSPORT_TESTING_ConnectRequest`
730 offer_hello (void *cls)
732 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc = cls;
733 struct GNUNET_TRANSPORT_TESTING_PeerContext *p1 = cc->p1;
734 struct GNUNET_TRANSPORT_TESTING_PeerContext *p2 = cc->p2;
738 char *p2_s = GNUNET_strdup (GNUNET_i2s (&p2->id));
740 LOG (GNUNET_ERROR_TYPE_DEBUG,
741 "Asking peer %u (`%s') to connect peer %u (`%s'), providing HELLO with %u bytes\n",
743 GNUNET_i2s (&p1->id),
746 GNUNET_HELLO_size (cc->p2->hello));
751 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
753 GNUNET_TRANSPORT_offer_hello (cc->p1->cfg,
755 GNUNET_MessageHeader *) cc->p2->hello,
762 * Initiate a connection from p1 to p2 by offering p1 p2's HELLO message
764 * Remarks: start_peer's notify_connect callback can be called before.
766 * @param tth transport testing handle
769 * @param cb the callback to call when both peers notified that they are connected
770 * @param cls callback cls
771 * @return a connect request handle
773 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *
774 GNUNET_TRANSPORT_TESTING_connect_peers (struct
775 GNUNET_TRANSPORT_TESTING_PeerContext *p1,
777 GNUNET_TRANSPORT_TESTING_PeerContext *p2,
778 GNUNET_SCHEDULER_TaskCallback cb,
781 struct GNUNET_TRANSPORT_TESTING_Handle *tth = p1->tth;
782 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
783 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ccn;
786 for (cc = tth->cc_head; NULL != cc; cc = cc->next)
788 if ((cc->p1 == p1) &&
796 cc = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_ConnectRequest);
806 cc->p1_c = ccn->p1_c;
807 cc->p2_c = ccn->p2_c;
808 cc->connected = ccn->connected;
810 GNUNET_CONTAINER_DLL_insert (tth->cc_head,
813 cc->tct = GNUNET_SCHEDULER_add_now (&offer_hello,
815 cc->ats_sh = GNUNET_ATS_connectivity_suggest (cc->p1->ats,
818 LOG (GNUNET_ERROR_TYPE_DEBUG,
819 "New connect request %p\n",
826 * Cancel the request to connect two peers
827 * Tou MUST cancel the request if you stop the peers before the peers connected succesfully
829 * @param tth transport testing handle
830 * @param cc a connect request handle
833 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct
834 GNUNET_TRANSPORT_TESTING_ConnectRequest
837 struct GNUNET_TRANSPORT_TESTING_Handle *tth = cc->p1->tth;
839 LOG (GNUNET_ERROR_TYPE_DEBUG,
840 "Canceling connect request!\n");
843 GNUNET_SCHEDULER_cancel (cc->tct);
848 GNUNET_TRANSPORT_offer_hello_cancel (cc->oh);
851 if (NULL != cc->ats_sh)
853 GNUNET_ATS_connectivity_suggest_cancel (cc->ats_sh);
856 GNUNET_CONTAINER_DLL_remove (tth->cc_head,
864 * Clean up the transport testing
866 * @param tth transport testing handle
869 GNUNET_TRANSPORT_TESTING_done (struct GNUNET_TRANSPORT_TESTING_Handle *tth)
871 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *cc;
872 struct GNUNET_TRANSPORT_TESTING_ConnectRequest *ct;
873 struct GNUNET_TRANSPORT_TESTING_PeerContext *p;
874 struct GNUNET_TRANSPORT_TESTING_PeerContext *t;
882 LOG (GNUNET_ERROR_TYPE_ERROR,
883 "Developer forgot to cancel connect request!\n");
884 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (cc);
891 LOG (GNUNET_ERROR_TYPE_ERROR,
892 "Developer forgot to stop peer!\n");
893 GNUNET_TRANSPORT_TESTING_stop_peer (p);
896 GNUNET_TESTING_system_destroy (tth->tl_system,
904 * Initialize the transport testing
906 * @return transport testing handle
908 struct GNUNET_TRANSPORT_TESTING_Handle *
909 GNUNET_TRANSPORT_TESTING_init ()
911 struct GNUNET_TRANSPORT_TESTING_Handle *tth;
913 tth = GNUNET_new (struct GNUNET_TRANSPORT_TESTING_Handle);
914 tth->tl_system = GNUNET_TESTING_system_create ("transport-testing",
918 if (NULL == tth->tl_system)
920 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
921 "Failed to initialize testing library!\n");
928 /* end of transport-testing.c */