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->cfg, "PATHS", "SERVICEHOME"))
288 GNUNET_assert (GNUNET_OK ==
289 GNUNET_CONFIGURATION_get_value_string (p->cfg, "PATHS",
293 if (NULL != p->servicehome)
294 GNUNET_DISK_directory_remove (p->servicehome);
296 hostkey = get_host_key (tth);
300 GNUNET_asprintf (&p->hostkeyfile, "%s/.hostkey", p->servicehome);
301 GNUNET_assert (GNUNET_OK ==
302 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
359 *tth, struct PeerContext *p,
361 GNUNET_TRANSPORT_TESTING_start_cb
362 restart_cb, void *cb_cls)
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, GNUNET_i2s (&p->id));
377 GNUNET_TRANSPORT_get_hello_cancel (p->ghh);
381 GNUNET_TRANSPORT_disconnect (p->th);
383 if (NULL != p->arm_proc)
385 if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
386 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
387 GNUNET_OS_process_wait (p->arm_proc);
388 GNUNET_OS_process_close (p->arm_proc);
391 if (p->hello != NULL)
392 GNUNET_free (p->hello);
396 GNUNET_CONFIGURATION_destroy (p->cfg);
402 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
403 "Restarting peer %u (`%s')\n", p->no, GNUNET_i2s (&p->id));
408 if (GNUNET_DISK_file_test (cfgname) == GNUNET_NO)
410 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "transport-testing",
411 "File not found: `%s' \n", cfgname);
415 p->cfg = GNUNET_CONFIGURATION_create ();
416 GNUNET_assert (GNUNET_OK == GNUNET_CONFIGURATION_load (p->cfg, cfgname));
418 if (!GNUNET_CONFIGURATION_have_value (p->cfg, "PATHS", "SERVICEHOME"))
421 fn = GNUNET_DISK_file_open (p->hostkeyfile,
422 GNUNET_DISK_OPEN_READWRITE |
423 GNUNET_DISK_OPEN_CREATE,
424 GNUNET_DISK_PERM_USER_READ |
425 GNUNET_DISK_PERM_USER_WRITE);
428 if (GNUNET_OK != GNUNET_DISK_file_close (fn))
432 GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
433 "gnunet-service-arm", "-c", cfgname,
442 GNUNET_TRANSPORT_connect (p->cfg, NULL, p, ¬ify_receive,
443 ¬ify_connect, ¬ify_disconnect);
444 GNUNET_assert (p->th != NULL);
446 p->start_cb = restart_cb;
449 p->ghh = GNUNET_TRANSPORT_get_hello (p->th, &get_hello, p);
450 GNUNET_assert (p->ghh != NULL);
454 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
455 "Restarting peer %u (`%s') failed, removing peer\n", p->no,
456 GNUNET_i2s (&p->id));
457 GNUNET_TRANSPORT_TESTING_stop_peer (tth, p);
458 return GNUNET_SYSERR;
462 * shutdown the given peer
466 GNUNET_TRANSPORT_TESTING_stop_peer (struct GNUNET_TRANSPORT_TESTING_handle *tth,
467 struct PeerContext *p)
469 GNUNET_assert (p != NULL);
472 GNUNET_TRANSPORT_get_hello_cancel (p->ghh);
476 GNUNET_TRANSPORT_disconnect (p->th);
478 if (NULL != p->arm_proc)
480 if (0 != GNUNET_OS_process_kill (p->arm_proc, SIGTERM))
481 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
482 GNUNET_OS_process_wait (p->arm_proc);
483 GNUNET_OS_process_close (p->arm_proc);
487 if (p->hostkeyfile != NULL)
489 GNUNET_DISK_directory_remove (p->hostkeyfile);
490 GNUNET_free (p->hostkeyfile);
493 if (p->servicehome != NULL)
495 GNUNET_DISK_directory_remove (p->servicehome);
496 GNUNET_free (p->servicehome);
499 if (p->hello != NULL)
500 GNUNET_free (p->hello);
504 GNUNET_CONFIGURATION_destroy (p->cfg);
507 GNUNET_CONTAINER_DLL_remove (tth->p_head, tth->p_tail, p);
514 * Initiate peer p1 to connect to peer p2
515 * Get peer p2's HELLO and offer it to p1
516 * p1 then tries to connect to p2
519 * @param cb the callback to call when both peers notified that they are connected
520 * @param cb_cls callback cls (or a pointer to the
521 * GNUNET_TRANSPORT_TESTING_ConnectRequest itself if null)
522 * @return connect context
524 GNUNET_TRANSPORT_TESTING_ConnectRequest
525 GNUNET_TRANSPORT_TESTING_connect_peers (struct GNUNET_TRANSPORT_TESTING_handle
526 *tth, struct PeerContext *p1,
527 struct PeerContext *p2,
528 GNUNET_TRANSPORT_TESTING_connect_cb cb,
531 GNUNET_assert (tth != NULL);
533 struct ConnectingContext *cc =
534 GNUNET_malloc (sizeof (struct ConnectingContext));
536 GNUNET_assert (p1 != NULL);
537 GNUNET_assert (p2 != NULL);
551 GNUNET_assert (cc->th_p1 != NULL);
552 GNUNET_assert (cc->th_p2 != NULL);
554 GNUNET_CONTAINER_DLL_insert (tth->cc_head, tth->cc_tail, cc);
556 cc->tct = GNUNET_SCHEDULER_add_now (&try_connect, cc);
557 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
558 "New connect request %X\n", cc);
564 * Cancel the request to connect two peers
565 * Tou MUST cancel the request if you stop the peers before the peers connected succesfully
566 * @param cc a connect request handle
569 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (struct
570 GNUNET_TRANSPORT_TESTING_handle
572 GNUNET_TRANSPORT_TESTING_ConnectRequest
575 struct ConnectingContext *cc = ccr;
577 GNUNET_assert (tth != NULL);
579 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
580 "Canceling connect request %X!\n", cc);
582 if (cc->tct != GNUNET_SCHEDULER_NO_TASK)
583 GNUNET_SCHEDULER_cancel (cc->tct);
584 cc->tct = GNUNET_SCHEDULER_NO_TASK;
586 GNUNET_CONTAINER_DLL_remove (tth->cc_head, tth->cc_tail, cc);
592 * Clean up the transport testing
593 * @param tth transport testing handle
596 GNUNET_TRANSPORT_TESTING_done (struct GNUNET_TRANSPORT_TESTING_handle *tth)
598 struct ConnectingContext *cc = tth->cc_head;
599 struct ConnectingContext *ct = NULL;
600 struct PeerContext *p = tth->p_head;
601 struct PeerContext *t = NULL;
603 GNUNET_assert (tth != NULL);
605 while (cc != tth->cc_tail)
608 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "transport-testing",
609 "Developer forgot to cancel connect request %X!\n", cc);
610 GNUNET_TRANSPORT_TESTING_connect_peers_cancel (tth, cc);
617 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "transport-testing",
618 "Developer forgot to stop peer!\n");
619 GNUNET_TRANSPORT_TESTING_stop_peer (tth, p);
623 GNUNET_free_non_null (tth->hostkey_data);
630 * Initialize the transport testing
631 * @return transport testing handle
633 struct GNUNET_TRANSPORT_TESTING_handle *
634 GNUNET_TRANSPORT_TESTING_init ()
636 struct GNUNET_TRANSPORT_TESTING_handle *tth;
637 struct GNUNET_DISK_FileHandle *fd;
639 uint64_t total_hostkeys;
642 /* prepare hostkeys */
643 tth = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_TESTING_handle));
644 tth->hostkey_data = NULL;
645 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, _("Could not read hostkeys file!\n"));
653 /* Check hostkey file size, read entire thing into memory */
654 fd = GNUNET_DISK_file_open (hostkeys_file, GNUNET_DISK_OPEN_READ,
655 GNUNET_DISK_PERM_NONE);
658 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", hostkeys_file);
663 if (GNUNET_YES != GNUNET_DISK_file_size (hostkeys_file, &fs, GNUNET_YES))
666 if (0 != (fs % HOSTKEYFILESIZE))
668 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "transport-testing",
669 "File size %llu seems incorrect for hostkeys...\n", fs);
673 total_hostkeys = fs / HOSTKEYFILESIZE;
674 tth->hostkey_data = GNUNET_malloc_large (fs);
675 GNUNET_assert (fs == GNUNET_DISK_file_read (fd, tth->hostkey_data, fs));
676 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "transport-testing",
677 "Read %llu hostkeys from file\n", total_hostkeys);
678 tth->hostkeys_total = total_hostkeys;
680 GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fd));
688 * Some utility functions
692 * Removes all directory separators from absolute filename
693 * @param file the absolute file name, e.g. as found in argv[0]
694 * @return extracted file name, has to be freed by caller
697 extract_filename (const char *file)
699 char *pch = GNUNET_strdup (file);
701 char *filename = NULL;
704 if (NULL != strstr (pch, "/"))
706 pch = strtok (pch, "/");
709 pch = strtok (NULL, "/");
719 res = GNUNET_strdup (filename);
720 GNUNET_free (backup);
725 * Extracts the test filename from an absolute file name and removes the extension
726 * @param file absolute file name
727 * @param dest where to store result
730 GNUNET_TRANSPORT_TESTING_get_test_name (const char *file, char **dest)
732 char *filename = extract_filename (file);
733 char *backup = filename;
736 if (filename == NULL)
740 filename = strstr (filename, "tes");
741 if (filename == NULL)
745 if (NULL != (dotexe = strstr (filename, ".exe")))
755 /* create filename */
756 GNUNET_asprintf (dest, "%s", filename);
757 GNUNET_free (backup);
762 * Extracts the filename from an absolute file name and removes the extension
763 * @param file absolute file name
764 * @param dest where to store result
767 GNUNET_TRANSPORT_TESTING_get_test_source_name (const char *file, char **dest)
769 char *src = extract_filename (file);
772 split = strstr (src, ".");
777 GNUNET_asprintf (dest, "%s", src);
783 * Extracts the plugin anme from an absolute file name and the test name
784 * @param file absolute file name
785 * @param test test name
786 * @param dest where to store result
789 GNUNET_TRANSPORT_TESTING_get_test_plugin_name (const char *file,
790 const char *test, char **dest)
792 char *e = extract_filename (file);
793 char *t = extract_filename (test);
795 char *filename = NULL;
802 filename = strstr (e, "tes");
803 if (filename == NULL)
807 if (NULL != (dotexe = strstr (filename, ".exe")))
811 filename = strstr (filename, t);
812 if (filename == NULL)
816 filename += strlen (t);
818 GNUNET_asprintf (dest, "%s", filename);
830 * This function takes the filename (e.g. argv[0), removes a "lt-"-prefix and
831 * if existing ".exe"-prefix and adds the peer-number
832 * @param file filename of the test, e.g. argv[0]
833 * @param cfgname where to write the result
834 * @param count peer number
837 GNUNET_TRANSPORT_TESTING_get_config_name (const char *file, char **dest,
840 char *filename = extract_filename (file);
841 char *backup = filename;
844 if (filename == NULL)
848 filename = strstr (filename, "tes");
849 if (filename == NULL)
853 if (NULL != (dotexe = strstr (filename, ".exe")))
863 /* create cfg filename */
864 GNUNET_asprintf (dest, "%s_peer%u.conf", filename, count);
865 GNUNET_free (backup);
870 /* end of transport_testing.h */