2 This file is part of GNUnet.
3 (C) 2006, 2009 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.
22 * @file transport-testing.c
23 * @brief testing lib for transport service
25 * @author Matthias Wachs
28 #include "transport-testing.h"
30 #define HOSTKEYFILESIZE 914
33 get_host_key (struct GNUNET_TRANSPORT_TESTING_handle *tth)
35 if (tth->hostkey_data == NULL)
37 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
38 "No precomputed hostkeys available\n");
41 if (tth->hostkeys_total > tth->hostkeys_last)
44 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
45 "Used hostkey %u of %u available hostkeys\n",
46 tth->hostkeys_last, tth->hostkeys_total);
47 return &tth->hostkey_data[(tth->hostkeys_last - 1) * HOSTKEYFILESIZE];
49 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
50 "No hostkey available (%u of %u already used)\n",
51 tth->hostkeys_last, tth->hostkeys_total);
55 static struct PeerContext *
56 find_peer_context (struct GNUNET_TRANSPORT_TESTING_handle *tth,
57 const struct GNUNET_PeerIdentity *peer)
59 GNUNET_assert (tth != NULL);
60 struct PeerContext *t = tth->p_head;
64 if (0 == memcmp (&t->id, peer, sizeof (struct GNUNET_PeerIdentity)))
72 struct ConnectingContext *
73 find_connecting_context (struct GNUNET_TRANSPORT_TESTING_handle *tth,
74 struct PeerContext *p1, struct PeerContext *p2)
76 GNUNET_assert (tth != NULL);
77 struct ConnectingContext *cc = tth->cc_head;
81 if ((cc->p1 == p1) && (cc->p2 == p2))
83 if ((cc->p1 == p2) && (cc->p2 == p1))
92 notify_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
93 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
95 struct PeerContext *p = cls;
97 /* Find PeerContext */
98 GNUNET_assert (p != 0);
99 GNUNET_assert (p->tth != NULL);
100 struct PeerContext *p2 = find_peer_context (p->tth, peer);
105 p->nc (p->cb_cls, peer, ats, ats_count);
111 GNUNET_asprintf (&p2_s, "%u (`%s')", p2->no, GNUNET_i2s (&p2->id));
113 GNUNET_asprintf (&p2_s, "`%s'", GNUNET_i2s (peer));
114 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
115 "Peers %s connected to peer %u (`%s')\n", p2_s, p->no,
116 GNUNET_i2s (&p->id));
121 /* Find ConnectingContext */
122 struct ConnectingContext *cc = find_connecting_context (p->tth, p, p2);
128 cc->p1_c = GNUNET_YES;
131 cc->p2_c = GNUNET_YES;
133 if ((cc->p1_c == GNUNET_YES) && (cc->p2_c == GNUNET_YES))
135 cc->cb (cc->p1, cc->p2, cc->cb_cls);
136 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (p->tth, cc);
141 notify_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
143 struct PeerContext *p = cls;
145 /* Find PeerContext */
147 struct PeerContext *p2 = NULL;
151 GNUNET_assert (p->tth != NULL);
152 p2 = find_peer_context (p->tth, peer);
159 GNUNET_asprintf (&p2_s, "%u (`%s')", p2->no, GNUNET_i2s (&p2->id));
161 GNUNET_asprintf (&p2_s, "`%s'", GNUNET_i2s (peer));
162 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
163 "Peers %s disconnected from peer %u (`%s')\n", p2_s, no,
164 GNUNET_i2s (&p->id));
170 p->nd (p->cb_cls, peer);
174 notify_receive (void *cls, const struct GNUNET_PeerIdentity *peer,
175 const struct GNUNET_MessageHeader *message,
176 const struct GNUNET_ATS_Information *ats, uint32_t ats_count)
178 struct PeerContext *p = cls;
183 p->rec (p->cb_cls, peer, message, ats, ats_count);
187 get_hello (void *cb_cls, const struct GNUNET_MessageHeader *message)
189 struct PeerContext *p = cb_cls;
191 GNUNET_assert (message != NULL);
192 GNUNET_assert (GNUNET_OK ==
193 GNUNET_HELLO_get_id ((const struct GNUNET_HELLO_Message *)
197 GNUNET_HELLO_size ((const struct GNUNET_HELLO_Message *) message);
199 GNUNET_free_non_null (p->hello);
200 p->hello = (struct GNUNET_HELLO_Message *) GNUNET_copy_message (message);
203 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
204 "New HELLO for peer %u (`%s') with size %u\n", p->no,
205 GNUNET_i2s (&p->id), size);
208 if (p->start_cb != NULL)
211 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
212 "Peer %u (`%s') successfully started\n", p->no,
213 GNUNET_i2s (&p->id));
215 p->start_cb (p, p->cb_cls);
222 try_connect (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
224 struct ConnectingContext *cc = cls;
225 struct PeerContext *p1 = cc->p1;
226 struct PeerContext *p2 = cc->p2;
228 cc->tct = GNUNET_SCHEDULER_NO_TASK;
229 if ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0)
232 GNUNET_assert (cc != NULL);
233 GNUNET_assert (cc->p1 != NULL);
234 GNUNET_assert (cc->p2 != NULL);
236 char *p2_s = GNUNET_strdup (GNUNET_i2s (&p2->id));
238 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
239 "Asking peer %u (`%s') to connect peer %u (`%s'), providing HELLO with %u bytes\n",
240 p1->no, GNUNET_i2s (&p1->id), p2->no, p2_s,
241 GNUNET_HELLO_size (cc->p2->hello));
244 GNUNET_TRANSPORT_offer_hello (cc->th_p1,
245 (const struct GNUNET_MessageHeader *) cc->
246 p2->hello, NULL, NULL);
247 GNUNET_TRANSPORT_try_connect (cc->th_p1, &p2->id);
250 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &try_connect, cc);
255 * Start a peer with the given configuration
256 * @param rec receive callback
257 * @param nc connect callback
258 * @param nd disconnect callback
259 * @param cb_cls closure for callback
260 * @return the peer context
263 GNUNET_TRANSPORT_TESTING_start_peer (struct GNUNET_TRANSPORT_TESTING_handle
264 *tth, const char *cfgname, int peer_id,
265 GNUNET_TRANSPORT_ReceiveCallback rec,
266 GNUNET_TRANSPORT_NotifyConnect nc,
267 GNUNET_TRANSPORT_NotifyDisconnect nd,
268 GNUNET_TRANSPORT_TESTING_start_cb start_cb,
271 const char *hostkey = NULL;
272 struct GNUNET_DISK_FileHandle *fn;
274 GNUNET_assert (tth != NULL);
275 if (GNUNET_DISK_file_test (cfgname) == GNUNET_NO)
277 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "transport-testing",
278 "File not found: `%s' \n", cfgname);
282 struct PeerContext *p = GNUNET_malloc (sizeof (struct PeerContext));
284 p->cfg = GNUNET_CONFIGURATION_create ();
285 GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
287 if (GNUNET_CONFIGURATION_have_value (p->
288 cfg, "PATHS", "SERVICEHOME"))
289 GNUNET_assert (GNUNET_OK ==
290 GNUNET_CONFIGURATION_get_value_string (p->cfg, "PATHS",
294 if (NULL != p->servicehome)
295 GNUNET_DISK_directory_remove (p->servicehome);
297 hostkey = get_host_key(tth);
301 GNUNET_asprintf (&p->hostkeyfile, "%s/.hostkey", p->servicehome);
302 GNUNET_assert(GNUNET_OK == GNUNET_DISK_directory_create_for_file (p->hostkeyfile));
303 fn = GNUNET_DISK_file_open (p->hostkeyfile,
304 GNUNET_DISK_OPEN_READWRITE |
305 GNUNET_DISK_OPEN_CREATE,
306 GNUNET_DISK_PERM_USER_READ |
307 GNUNET_DISK_PERM_USER_WRITE);
308 GNUNET_assert (fn != NULL);
309 GNUNET_assert (HOSTKEYFILESIZE ==
310 GNUNET_DISK_file_write (fn, hostkey, HOSTKEYFILESIZE));
311 GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fn));
312 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
313 "Wrote hostkey to file: `%s' \n", p->hostkeyfile);
317 GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
318 "gnunet-service-arm", "-c", cfgname,
331 p->start_cb = start_cb;
338 GNUNET_TRANSPORT_connect (p->cfg, NULL, p, ¬ify_receive,
339 ¬ify_connect, ¬ify_disconnect);
340 GNUNET_assert (p->th != NULL);
342 p->ghh = GNUNET_TRANSPORT_get_hello (p->th, &get_hello, p);
343 GNUNET_assert (p->ghh != NULL);
345 GNUNET_CONTAINER_DLL_insert (tth->p_head, tth->p_tail, p);
351 * Restart the given peer
352 * @param tth testing handle
354 * @param cfgname the cfg file used to restart
355 * @return GNUNET_OK in success otherwise GNUNET_SYSERR
358 GNUNET_TRANSPORT_TESTING_restart_peer (struct GNUNET_TRANSPORT_TESTING_handle *tth,
359 struct PeerContext *p,
361 GNUNET_TRANSPORT_TESTING_start_cb restart_cb,
364 struct GNUNET_DISK_FileHandle *fn;
366 GNUNET_assert (tth != NULL);
367 GNUNET_assert (p != NULL);
368 GNUNET_assert (p->hostkeyfile != NULL);
369 GNUNET_assert (p->servicehome != NULL);
373 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
374 "Stopping peer %u (`%s')\n", p->no,
375 GNUNET_i2s (&p->id));
378 GNUNET_TRANSPORT_get_hello_cancel (p->ghh);
382 GNUNET_TRANSPORT_disconnect (p->th);
384 if (NULL != p->arm_proc)
386 if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
387 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
388 GNUNET_OS_process_wait (p->arm_proc);
389 GNUNET_OS_process_close (p->arm_proc);
392 if (p->hello != NULL)
393 GNUNET_free (p->hello);
397 GNUNET_CONFIGURATION_destroy (p->cfg);
403 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
404 "Restarting peer %u (`%s')\n", p->no,
405 GNUNET_i2s (&p->id));
410 if (GNUNET_DISK_file_test (cfgname) == GNUNET_NO)
412 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "transport-testing",
413 "File not found: `%s' \n", cfgname);
417 p->cfg = GNUNET_CONFIGURATION_create ();
418 GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
420 if (! GNUNET_CONFIGURATION_have_value (p->cfg, "PATHS", "SERVICEHOME"))
423 fn = GNUNET_DISK_file_open (p->hostkeyfile,
424 GNUNET_DISK_OPEN_READWRITE |
425 GNUNET_DISK_OPEN_CREATE,
426 GNUNET_DISK_PERM_USER_READ |
427 GNUNET_DISK_PERM_USER_WRITE);
430 if (GNUNET_OK != GNUNET_DISK_file_close (fn))
433 p->arm_proc = GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
434 "gnunet-service-arm", "-c", cfgname,
443 GNUNET_TRANSPORT_connect (p->cfg, NULL, p, ¬ify_receive,
444 ¬ify_connect, ¬ify_disconnect);
445 GNUNET_assert (p->th != NULL);
447 p->start_cb = restart_cb;
450 p->ghh = GNUNET_TRANSPORT_get_hello (p->th, &get_hello, p);
451 GNUNET_assert (p->ghh != NULL);
455 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
456 "Restarting peer %u (`%s') failed, removing peer\n", p->no,
457 GNUNET_i2s (&p->id));
458 GNUNET_TRANSPORT_TESTING_stop_peer (tth,p);
459 return GNUNET_SYSERR;
463 * shutdown the given peer
467 GNUNET_TRANSPORT_TESTING_stop_peer (struct GNUNET_TRANSPORT_TESTING_handle *tth,
468 struct PeerContext *p)
470 GNUNET_assert (p != NULL);
473 GNUNET_TRANSPORT_get_hello_cancel (p->ghh);
477 GNUNET_TRANSPORT_disconnect (p->th);
479 if (NULL != p->arm_proc)
481 if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
482 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
483 GNUNET_OS_process_wait (p->arm_proc);
484 GNUNET_OS_process_close (p->arm_proc);
488 if (p->hostkeyfile != NULL)
490 GNUNET_DISK_directory_remove (p->hostkeyfile);
491 GNUNET_free (p->hostkeyfile);
494 if (p->servicehome != NULL)
496 GNUNET_DISK_directory_remove (p->servicehome);
497 GNUNET_free (p->servicehome);
500 if (p->hello != NULL)
501 GNUNET_free (p->hello);
505 GNUNET_CONFIGURATION_destroy (p->cfg);
508 GNUNET_CONTAINER_DLL_remove (tth->p_head, tth->p_tail, p);
515 * Initiate peer p1 to connect to peer p2
516 * Get peer p2's HELLO and offer it to p1
517 * p1 then tries to connect to p2
520 * @param cb the callback to call when both peers notified that they are connected
521 * @param cb_cls callback cls (or a pointer to the
522 * GNUNET_TRANSPORT_TESTING_ConnectRequest itself if null)
523 * @return connect context
525 GNUNET_TRANSPORT_TESTING_ConnectRequest
526 GNUNET_TRANSPORT_TESTING_connect_peers (struct GNUNET_TRANSPORT_TESTING_handle
527 *tth, struct PeerContext *p1,
528 struct PeerContext *p2,
529 GNUNET_TRANSPORT_TESTING_connect_cb cb,
532 GNUNET_assert (tth != NULL);
534 struct ConnectingContext *cc =
535 GNUNET_malloc (sizeof (struct ConnectingContext));
537 GNUNET_assert (p1 != NULL);
538 GNUNET_assert (p2 != NULL);
552 GNUNET_assert (cc->th_p1 != NULL);
553 GNUNET_assert (cc->th_p2 != NULL);
555 GNUNET_CONTAINER_DLL_insert (tth->cc_head, tth->cc_tail, cc);
557 cc->tct = GNUNET_SCHEDULER_add_now (&try_connect, cc);
558 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
559 "New connect request %X\n", cc);
565 * Cancel the request to connect two peers
566 * Tou MUST cancel the request if you stop the peers before the peers connected succesfully
567 * @param cc a connect request handle
570 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct
571 GNUNET_TRANSPORT_TESTING_handle
573 GNUNET_TRANSPORT_TESTING_ConnectRequest
576 struct ConnectingContext *cc = ccr;
578 GNUNET_assert (tth != NULL);
580 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
581 "Canceling connect request %X!\n", cc);
583 if (cc->tct != GNUNET_SCHEDULER_NO_TASK)
584 GNUNET_SCHEDULER_cancel (cc->tct);
585 cc->tct = GNUNET_SCHEDULER_NO_TASK;
587 GNUNET_CONTAINER_DLL_remove (tth->cc_head, tth->cc_tail, cc);
593 * Clean up the transport testing
594 * @param tth transport testing handle
597 GNUNET_TRANSPORT_TESTING_done (struct GNUNET_TRANSPORT_TESTING_handle *tth)
599 struct ConnectingContext *cc = tth->cc_head;
600 struct ConnectingContext *ct = NULL;
601 struct PeerContext *p = tth->p_head;
602 struct PeerContext *t = NULL;
604 GNUNET_assert (tth != NULL);
606 while (cc != tth->cc_tail)
609 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "transport-testing",
610 "Developer forgot to cancel connect request %X!\n", cc);
611 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
618 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "transport-testing",
619 "Developer forgot to stop peer!\n");
620 GNUNET_TRANSPORT_TESTING_stop_peer (tth, p);
624 GNUNET_free_non_null (tth->hostkey_data);
631 * Initialize the transport testing
632 * @return transport testing handle
634 struct GNUNET_TRANSPORT_TESTING_handle *
635 GNUNET_TRANSPORT_TESTING_init ()
637 struct GNUNET_TRANSPORT_TESTING_handle *tth;
638 struct GNUNET_DISK_FileHandle *fd;
640 uint64_t total_hostkeys;
643 /* prepare hostkeys */
644 tth = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TESTING_handle));
645 tth->hostkey_data = NULL;
646 const char * hostkeys_file = "../../contrib/testing_hostkeys.dat";
647 if (GNUNET_YES != GNUNET_DISK_file_test (hostkeys_file))
649 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
650 _("Could not read hostkeys file!\n"));
654 /* Check hostkey file size, read entire thing into memory */
655 fd = GNUNET_DISK_file_open (hostkeys_file, GNUNET_DISK_OPEN_READ,
656 GNUNET_DISK_PERM_NONE);
659 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open",
665 if (GNUNET_YES != GNUNET_DISK_file_size (hostkeys_file, &fs, GNUNET_YES))
668 if (0 != (fs % HOSTKEYFILESIZE))
670 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "transport-testing",
671 "File size %llu seems incorrect for hostkeys...\n", fs);
675 total_hostkeys = fs / HOSTKEYFILESIZE;
676 tth->hostkey_data = GNUNET_malloc_large (fs);
677 GNUNET_assert (fs == GNUNET_DISK_file_read (fd, tth->hostkey_data, fs));
678 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
679 "Read %llu hostkeys from file\n", total_hostkeys);
680 tth->hostkeys_total = total_hostkeys;
682 GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fd));
690 * Some utility functions
694 * Removes all directory separators from absolute filename
695 * @param file the absolute file name, e.g. as found in argv[0]
696 * @return extracted file name, has to be freed by caller
699 extract_filename (const char *file)
701 char *pch = GNUNET_strdup (file);
703 char *filename = NULL;
706 if (NULL != strstr (pch, "/"))
708 pch = strtok (pch, "/");
711 pch = strtok (NULL, "/");
721 res = GNUNET_strdup (filename);
722 GNUNET_free (backup);
727 * Extracts the test filename from an absolute file name and removes the extension
728 * @param file absolute file name
729 * @param dest where to store result
732 GNUNET_TRANSPORT_TESTING_get_test_name (const char *file, char **dest)
734 char *filename = extract_filename (file);
735 char *backup = filename;
738 if (filename == NULL)
742 filename = strstr (filename, "tes");
743 if (filename == NULL)
747 if (NULL != (dotexe = strstr (filename, ".exe")))
757 /* create filename */
758 GNUNET_asprintf (dest, "%s", filename);
759 GNUNET_free (backup);
764 * Extracts the filename from an absolute file name and removes the extension
765 * @param file absolute file name
766 * @param dest where to store result
769 GNUNET_TRANSPORT_TESTING_get_test_source_name (const char *file, char **dest)
771 char *src = extract_filename (file);
774 split = strstr (src, ".");
779 GNUNET_asprintf (dest, "%s", src);
785 * Extracts the plugin anme from an absolute file name and the test name
786 * @param file absolute file name
787 * @param test test name
788 * @param dest where to store result
791 GNUNET_TRANSPORT_TESTING_get_test_plugin_name (const char *file,
792 const char *test, char **dest)
794 char *e = extract_filename (file);
795 char *t = extract_filename (test);
797 char *filename = NULL;
804 filename = strstr (e, "tes");
805 if (filename == NULL)
809 if (NULL != (dotexe = strstr (filename, ".exe")))
813 filename = strstr (filename, t);
814 if (filename == NULL)
818 filename += strlen (t);
820 GNUNET_asprintf (dest, "%s", filename);
832 * This function takes the filename (e.g. argv[0), removes a "lt-"-prefix and
833 * if existing ".exe"-prefix and adds the peer-number
834 * @param file filename of the test, e.g. argv[0]
835 * @param cfgname where to write the result
836 * @param count peer number
839 GNUNET_TRANSPORT_TESTING_get_config_name (const char *file, char **dest,
842 char *filename = extract_filename (file);
843 char *backup = filename;
846 if (filename == NULL)
850 filename = strstr (filename, "tes");
851 if (filename == NULL)
855 if (NULL != (dotexe = strstr (filename, ".exe")))
865 /* create cfg filename */
866 GNUNET_asprintf (dest, "%s_peer%u.conf", filename, count);
867 GNUNET_free (backup);
872 /* end of transport_testing.h */