2 This file is part of GNUnet.
3 (C) 2010 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 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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file fs/fs_test_lib.c
23 * @brief library routines for testing FS publishing and downloading
24 * with multiple peers; this code is limited to flat files
25 * and no keywords (those functions can be tested with
26 * single-peer setups; this is for testing routing).
27 * @author Christian Grothoff
30 #include "fs_test_lib.h"
31 #include "gnunet_testing_lib.h"
33 #define CONNECT_ATTEMPTS 4
36 * Handle for a daemon started for testing FS.
38 struct GNUNET_FS_TestDaemon
42 * Handle to the file sharing context using this daemon.
44 struct GNUNET_FS_Handle *fs;
47 * Handle to the daemon via testing.
49 struct GNUNET_TESTING_Daemon *daemon;
52 * Note that 'group' will be the same value for all of the
53 * daemons started jointly.
55 struct GNUNET_TESTING_PeerGroup *group;
58 * Configuration for accessing this peer.
60 struct GNUNET_CONFIGURATION_Handle *cfg;
65 struct GNUNET_PeerIdentity id;
68 * Scheduler to use (for publish_cont).
70 struct GNUNET_SCHEDULER_Handle *publish_sched;
73 * Function to call when upload is done.
75 GNUNET_FS_TEST_UriContinuation publish_cont;
78 * Closure for publish_cont.
80 void *publish_cont_cls;
83 * Task to abort publishing (timeout).
85 GNUNET_SCHEDULER_TaskIdentifier publish_timeout_task;
88 * Seed for file generation.
90 uint32_t publish_seed;
93 * Context for current publishing operation.
95 struct GNUNET_FS_PublishContext *publish_context;
100 struct GNUNET_FS_Uri *publish_uri;
103 * Scheduler to use (for download_cont).
105 struct GNUNET_SCHEDULER_Handle *download_sched;
108 * Function to call when download is done.
110 GNUNET_SCHEDULER_Task download_cont;
113 * Closure for download_cont.
115 void *download_cont_cls;
118 * Seed for download verification.
120 uint32_t download_seed;
123 * Task to abort downloading (timeout).
125 GNUNET_SCHEDULER_TaskIdentifier download_timeout_task;
128 * Context for current download operation.
130 struct GNUNET_FS_DownloadContext *download_context;
133 * Verbosity level of the current operation.
141 * Check whether peers successfully shut down.
143 void shutdown_callback (void *cls,
149 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
150 "Shutdown of peers failed!\n");
156 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
157 "All peers successfully shut down!\n");
163 report_uri (void *cls,
164 const struct GNUNET_SCHEDULER_TaskContext *tc)
166 struct GNUNET_FS_TestDaemon *daemon = cls;
167 GNUNET_FS_TEST_UriContinuation cont;
168 struct GNUNET_FS_Uri *uri;
170 GNUNET_FS_publish_stop (daemon->publish_context);
171 daemon->publish_context = NULL;
172 daemon->publish_sched = NULL;
173 cont = daemon->publish_cont;
174 daemon->publish_cont = NULL;
175 uri = daemon->publish_uri;
176 cont (daemon->publish_cont_cls,
178 GNUNET_FS_uri_destroy (uri);
183 report_success (void *cls,
184 const struct GNUNET_SCHEDULER_TaskContext *tc)
186 struct GNUNET_FS_TestDaemon *daemon = cls;
188 GNUNET_FS_download_stop (daemon->download_context, GNUNET_YES);
189 daemon->download_context = NULL;
190 GNUNET_SCHEDULER_add_continuation (daemon->download_sched,
191 daemon->download_cont,
192 daemon->download_cont_cls,
193 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
194 daemon->download_cont = NULL;
195 daemon->download_sched = NULL;
199 progress_cb (void *cls,
200 const struct GNUNET_FS_ProgressInfo *info)
202 struct GNUNET_FS_TestDaemon *daemon = cls;
204 switch (info->status)
206 case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
207 GNUNET_SCHEDULER_cancel (daemon->publish_sched,
208 daemon->publish_timeout_task);
209 daemon->publish_timeout_task = GNUNET_SCHEDULER_NO_TASK;
210 daemon->publish_uri = GNUNET_FS_uri_dup (info->value.publish.specifics.completed.chk_uri);
211 GNUNET_SCHEDULER_add_continuation (daemon->publish_sched,
214 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
216 case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
218 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
219 "Publishing at %llu/%llu bytes\n",
220 (unsigned long long) info->value.publish.completed,
221 (unsigned long long) info->value.publish.size);
223 case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
225 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
226 "Download at %llu/%llu bytes\n",
227 (unsigned long long) info->value.download.completed,
228 (unsigned long long) info->value.download.size);
230 case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
231 GNUNET_SCHEDULER_cancel (daemon->download_sched,
232 daemon->download_timeout_task);
233 daemon->download_timeout_task = GNUNET_SCHEDULER_NO_TASK;
234 GNUNET_SCHEDULER_add_continuation (daemon->download_sched,
237 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
239 case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
240 case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
242 /* FIXME: monitor data correctness during download progress */
243 /* FIXME: do performance reports given sufficient verbosity */
244 /* FIXME: advance timeout task to "immediate" on error */
254 struct GNUNET_SCHEDULER_Handle *sched;
255 struct GNUNET_TIME_Relative timeout;
258 struct GNUNET_FS_TestDaemon **daemons;
259 GNUNET_SCHEDULER_Task cont;
261 struct GNUNET_TESTING_PeerGroup *group;
262 struct GNUNET_CONFIGURATION_Handle *cfg;
263 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
268 notify_running (void *cls,
269 const struct GNUNET_PeerIdentity *id,
270 const struct GNUNET_CONFIGURATION_Handle *cfg,
271 struct GNUNET_TESTING_Daemon *d,
274 struct StartContext *sctx = cls;
279 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
280 _("Failed to start daemon: %s\n"),
285 while (i < sctx->total)
287 if (GNUNET_TESTING_daemon_get (sctx->group,
292 GNUNET_assert (i < sctx->total);
293 GNUNET_assert (sctx->have < sctx->total);
294 GNUNET_assert (sctx->daemons[i]->cfg == NULL);
295 sctx->daemons[i]->cfg = GNUNET_CONFIGURATION_dup (cfg);
296 sctx->daemons[i]->group = sctx->group;
297 sctx->daemons[i]->daemon = d;
298 sctx->daemons[i]->id = *id;
300 if (sctx->have == sctx->total)
302 GNUNET_SCHEDULER_add_continuation (sctx->sched,
305 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
306 GNUNET_CONFIGURATION_destroy (sctx->cfg);
307 GNUNET_SCHEDULER_cancel (sctx->sched,
309 for (i=0;i<sctx->total;i++)
311 sctx->daemons[i]->fs = GNUNET_FS_start (sctx->sched,
312 sctx->daemons[i]->cfg,
316 GNUNET_FS_FLAGS_NONE,
317 GNUNET_FS_OPTIONS_END);
325 start_timeout (void *cls,
326 const struct GNUNET_SCHEDULER_TaskContext *tc)
328 struct StartContext *sctx = cls;
331 GNUNET_TESTING_daemons_stop (sctx->group, GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 30), &shutdown_callback, NULL);
332 for (i=0;i<sctx->total;i++)
335 GNUNET_CONFIGURATION_destroy (sctx->daemons[i]->cfg);
336 GNUNET_free (sctx->daemons[i]);
338 GNUNET_CONFIGURATION_destroy (sctx->cfg);
339 GNUNET_SCHEDULER_add_continuation (sctx->sched,
342 GNUNET_SCHEDULER_REASON_TIMEOUT);
348 * Start daemons for testing.
350 * @param sched scheduler to use
351 * @param template_cfg_file configuration template to use
352 * @param timeout if this operation cannot be completed within the
353 * given period, call the continuation with an error code
354 * @param total number of daemons to start
355 * @param daemons array of 'total' entries to be initialized
356 * (array must already be allocated, will be filled)
357 * @param cont function to call when done
358 * @param cont_cls closure for cont
361 GNUNET_FS_TEST_daemons_start (struct GNUNET_SCHEDULER_Handle *sched,
362 const char *template_cfg_file,
363 struct GNUNET_TIME_Relative timeout,
365 struct GNUNET_FS_TestDaemon **daemons,
366 GNUNET_SCHEDULER_Task cont,
369 struct StartContext *sctx;
372 GNUNET_assert (total > 0);
373 sctx = GNUNET_malloc (sizeof (struct StartContext));
375 sctx->daemons = daemons;
378 sctx->cont_cls = cont_cls;
379 sctx->cfg = GNUNET_CONFIGURATION_create ();
381 GNUNET_CONFIGURATION_load (sctx->cfg,
385 GNUNET_CONFIGURATION_destroy (sctx->cfg);
387 GNUNET_SCHEDULER_add_continuation (sched,
390 GNUNET_SCHEDULER_REASON_TIMEOUT);
393 for (i=0;i<total;i++)
394 daemons[i] = GNUNET_malloc (sizeof (struct GNUNET_FS_TestDaemon));
395 sctx->group = GNUNET_TESTING_daemons_start (sched,
405 sctx->timeout_task = GNUNET_SCHEDULER_add_delayed (sched,
412 struct ConnectContext
414 struct GNUNET_SCHEDULER_Handle *sched;
415 GNUNET_SCHEDULER_Task cont;
420 * Prototype of a function that will be called whenever
421 * two daemons are connected by the testing library.
424 * @param first peer id for first daemon
425 * @param second peer id for the second daemon
426 * @param distance distance between the connected peers
427 * @param first_cfg config for the first daemon
428 * @param second_cfg config for the second daemon
429 * @param first_daemon handle for the first daemon
430 * @param second_daemon handle for the second daemon
431 * @param emsg error message (NULL on success)
434 notify_connection (void *cls,
435 const struct GNUNET_PeerIdentity *first,
436 const struct GNUNET_PeerIdentity *second,
438 const struct GNUNET_CONFIGURATION_Handle *first_cfg,
439 const struct GNUNET_CONFIGURATION_Handle *second_cfg,
440 struct GNUNET_TESTING_Daemon *first_daemon,
441 struct GNUNET_TESTING_Daemon *second_daemon,
444 struct ConnectContext *cc = cls;
447 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
448 _("Failed to connect peers: %s\n"),
450 GNUNET_SCHEDULER_add_continuation (cc->sched,
454 ? GNUNET_SCHEDULER_REASON_TIMEOUT
455 : GNUNET_SCHEDULER_REASON_PREREQ_DONE);
461 * Connect two daemons for testing.
463 * @param sched scheduler to use
464 * @param daemon1 first daemon to connect
465 * @param daemon2 second first daemon to connect
466 * @param timeout if this operation cannot be completed within the
467 * given period, call the continuation with an error code
468 * @param cont function to call when done
469 * @param cont_cls closure for cont
472 GNUNET_FS_TEST_daemons_connect (struct GNUNET_SCHEDULER_Handle *sched,
473 struct GNUNET_FS_TestDaemon *daemon1,
474 struct GNUNET_FS_TestDaemon *daemon2,
475 struct GNUNET_TIME_Relative timeout,
476 GNUNET_SCHEDULER_Task cont,
479 struct ConnectContext *ncc;
481 ncc = GNUNET_malloc (sizeof (struct ConnectContext));
484 ncc->cont_cls = cont_cls;
485 GNUNET_TESTING_daemons_connect (daemon1->daemon,
495 * Obtain peer group used for testing.
497 * @param daemons array with the daemons (must contain at least one)
500 struct GNUNET_TESTING_PeerGroup *
501 GNUNET_FS_TEST_get_group (struct GNUNET_FS_TestDaemon **daemons)
503 return daemons[0]->group;
508 * Stop daemons used for testing.
510 * @param sched scheduler to use
511 * @param total number of daemons to stop
512 * @param daemons array with the daemons (values will be clobbered)
515 GNUNET_FS_TEST_daemons_stop (struct GNUNET_SCHEDULER_Handle *sched,
517 struct GNUNET_FS_TestDaemon **daemons)
520 struct GNUNET_TESTING_PeerGroup *pg;
522 GNUNET_assert (total > 0);
523 pg = daemons[0]->group;
524 for (i=0;i<total;i++)
526 if (daemons[i]->fs != NULL)
527 GNUNET_FS_stop (daemons[i]->fs);
528 if (daemons[i]->cfg != NULL)
529 GNUNET_CONFIGURATION_destroy (daemons[i]->cfg);
530 GNUNET_free (daemons[i]);
533 GNUNET_TESTING_daemons_stop (pg, GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 30), &shutdown_callback, NULL);
538 publish_timeout (void *cls,
539 const struct GNUNET_SCHEDULER_TaskContext *tc)
541 struct GNUNET_FS_TestDaemon *daemon = cls;
542 GNUNET_FS_TEST_UriContinuation cont;
544 cont = daemon->publish_cont;
545 daemon->publish_timeout_task = GNUNET_SCHEDULER_NO_TASK;
546 daemon->publish_cont = NULL;
547 GNUNET_FS_publish_stop (daemon->publish_context);
548 daemon->publish_context = NULL;
549 cont (daemon->publish_cont_cls,
555 file_generator (void *cls,
561 struct GNUNET_FS_TestDaemon *daemon = cls;
566 for (pos=0;pos<max;pos++)
568 mod = (255 - (offset / 1024 / 32));
571 cbuf[pos] = (uint8_t) ((offset * daemon->publish_seed) % mod);
579 * Publish a file at the given daemon.
581 * @param sched scheduler to use
582 * @param daemon where to publish
583 * @param timeout if this operation cannot be completed within the
584 * given period, call the continuation with an error code
585 * @param anonymity option for publication
586 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
587 * GNUNET_SYSERR for simulation
588 * @param size size of the file to publish
589 * @param seed seed to use for file generation
590 * @param verbose how verbose to be in reporting
591 * @param cont function to call when done
592 * @param cont_cls closure for cont
595 GNUNET_FS_TEST_publish (struct GNUNET_SCHEDULER_Handle *sched,
596 struct GNUNET_FS_TestDaemon *daemon,
597 struct GNUNET_TIME_Relative timeout,
602 unsigned int verbose,
603 GNUNET_FS_TEST_UriContinuation cont,
606 GNUNET_assert (daemon->publish_cont == NULL);
607 struct GNUNET_FS_FileInformation *fi;
609 daemon->publish_cont = cont;
610 daemon->publish_cont_cls = cont_cls;
611 daemon->publish_seed = seed;
612 daemon->verbose = verbose;
613 daemon->publish_sched = sched;
614 fi = GNUNET_FS_file_information_create_from_reader (daemon->fs,
624 GNUNET_TIME_relative_to_absolute (GNUNET_TIME_UNIT_HOURS));
625 daemon->publish_context = GNUNET_FS_publish_start (daemon->fs,
628 GNUNET_FS_PUBLISH_OPTION_NONE);
629 daemon->publish_timeout_task = GNUNET_SCHEDULER_add_delayed (sched,
637 download_timeout (void *cls,
638 const struct GNUNET_SCHEDULER_TaskContext *tc)
640 struct GNUNET_FS_TestDaemon *daemon = cls;
642 daemon->download_timeout_task = GNUNET_SCHEDULER_NO_TASK;
643 GNUNET_FS_download_stop (daemon->download_context, GNUNET_YES);
644 daemon->download_context = NULL;
645 GNUNET_SCHEDULER_add_continuation (daemon->download_sched,
646 daemon->download_cont,
647 daemon->download_cont_cls,
648 GNUNET_SCHEDULER_REASON_TIMEOUT);
649 daemon->download_cont = NULL;
650 daemon->download_sched = NULL;
655 * Perform test download.
657 * @param sched scheduler to use
658 * @param daemon which peer to download from
659 * @param timeout if this operation cannot be completed within the
660 * given period, call the continuation with an error code
661 * @param anonymity option for download
662 * @param seed used for file validation
663 * @param uri URI of file to download (CHK/LOC only)
664 * @param verbose how verbose to be in reporting
665 * @param cont function to call when done
666 * @param cont_cls closure for cont
669 GNUNET_FS_TEST_download (struct GNUNET_SCHEDULER_Handle *sched,
670 struct GNUNET_FS_TestDaemon *daemon,
671 struct GNUNET_TIME_Relative timeout,
674 const struct GNUNET_FS_Uri *uri,
675 unsigned int verbose,
676 GNUNET_SCHEDULER_Task cont,
681 GNUNET_assert (daemon->download_cont == NULL);
682 size = GNUNET_FS_uri_chk_get_file_size (uri);
683 daemon->verbose = verbose;
684 daemon->download_sched = sched;
685 daemon->download_cont = cont;
686 daemon->download_cont_cls = cont_cls;
687 daemon->download_seed = seed;
688 daemon->download_context = GNUNET_FS_download_start (daemon->fs,
695 GNUNET_FS_DOWNLOAD_OPTION_NONE,
698 daemon->download_timeout_task = GNUNET_SCHEDULER_add_delayed (sched,
704 /* end of test_fs_lib.c */