2 This file is part of GNUnet.
3 (C) 2010, 2011, 2012 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 * 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
31 #include "fs_test_lib.h"
34 #define CONTENT_LIFETIME GNUNET_TIME_UNIT_HOURS
38 * Handle for a publishing operation started for testing FS.
40 struct TestPublishOperation
44 * Handle for the operation to connect to the peer's 'fs' service.
46 struct GNUNET_TESTBED_Operation *fs_op;
49 * Handle to the file sharing context using this daemon.
51 struct GNUNET_FS_Handle *fs;
54 * Function to call when upload is done.
56 GNUNET_FS_TEST_UriContinuation publish_cont;
59 * Closure for publish_cont.
61 void *publish_cont_cls;
64 * Task to abort publishing (timeout).
66 GNUNET_SCHEDULER_TaskIdentifier publish_timeout_task;
69 * Seed for file generation.
71 uint32_t publish_seed;
74 * Context for current publishing operation.
76 struct GNUNET_FS_PublishContext *publish_context;
81 struct GNUNET_FS_Uri *publish_uri;
84 * Name of the temporary file used, or NULL for none.
86 char *publish_tmp_file;
94 * Anonymity level used.
99 * Verbosity level of the current operation.
101 unsigned int verbose;
104 * Are we testing indexing? (YES: index, NO: insert, SYSERR: simulate)
111 * Handle for a download operation started for testing FS.
113 struct TestDownloadOperation
117 * Handle for the operation to connect to the peer's 'fs' service.
119 struct GNUNET_TESTBED_Operation *fs_op;
122 * Handle to the file sharing context using this daemon.
124 struct GNUNET_FS_Handle *fs;
127 * Handle to the daemon via testing.
129 struct GNUNET_TESTING_Daemon *daemon;
132 * Function to call when download is done.
134 GNUNET_SCHEDULER_Task download_cont;
137 * Closure for download_cont.
139 void *download_cont_cls;
144 struct GNUNET_FS_Uri *uri;
147 * Task to abort downloading (timeout).
149 GNUNET_SCHEDULER_TaskIdentifier download_timeout_task;
152 * Context for current download operation.
154 struct GNUNET_FS_DownloadContext *download_context;
162 * Anonymity level used.
167 * Seed for download verification.
169 uint32_t download_seed;
172 * Verbosity level of the current operation.
174 unsigned int verbose;
180 * Task scheduled to report on the completion of our publish operation.
182 * @param cls the publish operation context
183 * @param tc scheduler context (unused)
186 report_uri (void *cls,
187 const struct GNUNET_SCHEDULER_TaskContext *tc)
189 struct TestPublishOperation *po = cls;
191 GNUNET_FS_publish_stop (po->publish_context);
192 GNUNET_TESTBED_operation_done (po->fs_op);
193 po->publish_cont (po->publish_cont_cls,
195 (GNUNET_YES == po->do_index)
196 ? po->publish_tmp_file
198 GNUNET_FS_uri_destroy (po->publish_uri);
199 if (GNUNET_YES != po->do_index)
200 (void) GNUNET_DISK_directory_remove (po->publish_tmp_file);
201 GNUNET_free_non_null (po->publish_tmp_file);
207 * Task scheduled to run when publish operation times out.
209 * @param cls the publish operation context
210 * @param tc scheduler context (unused)
213 publish_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
215 struct TestPublishOperation *po = cls;
217 po->publish_timeout_task = GNUNET_SCHEDULER_NO_TASK;
218 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
219 "Timeout while trying to publish data\n");
220 GNUNET_TESTBED_operation_done (po->fs_op);
221 GNUNET_FS_publish_stop (po->publish_context);
222 po->publish_cont (po->publish_cont_cls, NULL, NULL);
223 (void) GNUNET_DISK_directory_remove (po->publish_tmp_file);
224 GNUNET_free_non_null (po->publish_tmp_file);
230 * Progress callback for file-sharing events while publishing.
232 * @param cls the publish operation context
233 * @param info information about the event
236 publish_progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
238 struct TestPublishOperation *po = cls;
240 switch (info->status)
242 case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
243 GNUNET_SCHEDULER_cancel (po->publish_timeout_task);
244 po->publish_timeout_task = GNUNET_SCHEDULER_NO_TASK;
246 GNUNET_FS_uri_dup (info->value.publish.specifics.completed.chk_uri);
247 GNUNET_SCHEDULER_add_continuation (&report_uri, po,
248 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
250 case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
252 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Publishing at %llu/%llu bytes\n",
253 (unsigned long long) info->value.publish.completed,
254 (unsigned long long) info->value.publish.size);
256 case GNUNET_FS_STATUS_PUBLISH_PROGRESS_DIRECTORY:
258 case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
260 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Download at %llu/%llu bytes\n",
261 (unsigned long long) info->value.download.completed,
262 (unsigned long long) info->value.download.size);
272 * Generate test data for publishing test.
274 * @param cls pointer to uint32_t with publishing seed
275 * @param offset offset to generate data for
276 * @param max maximum number of bytes to generate
277 * @param buf where to write generated data
278 * @param emsg where to store error message (unused)
279 * @return number of bytes written to buf
282 file_generator (void *cls,
288 uint32_t *publish_seed = cls;
297 for (pos = 0; pos < 8; pos++)
298 cbuf[pos] = (uint8_t) (offset >> pos * 8);
299 for (pos = 8; pos < max; pos++)
301 mod = (255 - (offset / 1024 / 32));
304 cbuf[pos] = (uint8_t) ((offset * (*publish_seed)) % mod);
311 * Connect adapter for publishing operation.
313 * @param cls the 'struct TestPublishOperation'
314 * @param cfg configuration of the peer to connect to; will be available until
315 * GNUNET_TESTBED_operation_done() is called on the operation returned
316 * from GNUNET_TESTBED_service_connect()
317 * @return service handle to return in 'op_result', NULL on error
320 publish_connect_adapter (void *cls,
321 const struct GNUNET_CONFIGURATION_Handle *cfg)
323 struct TestPublishOperation *po = cls;
325 return GNUNET_FS_start (cfg,
327 &publish_progress_cb, po,
328 GNUNET_FS_FLAGS_NONE,
329 GNUNET_FS_OPTIONS_END);
334 * Adapter function called to destroy connection to file-sharing service.
336 * @param cls the 'struct GNUNET_FS_Handle'
337 * @param op_result unused (different for publish/download!)
340 fs_disconnect_adapter (void *cls,
343 struct GNUNET_FS_Handle *fs = op_result;
350 * Callback to be called when testbed has connected to the fs service
352 * @param cls the 'struct TestPublishOperation'
353 * @param op the operation that has been finished
354 * @param ca_result the 'struct GNUNET_FS_Handle ' (NULL on error)
355 * @param emsg error message in case the operation has failed; will be NULL if
356 * operation has executed successfully.
359 publish_fs_connect_complete_cb (void *cls,
360 struct GNUNET_TESTBED_Operation *op,
364 struct TestPublishOperation *po = cls;
365 struct GNUNET_FS_FileInformation *fi;
366 struct GNUNET_DISK_FileHandle *fh;
369 char buf[DBLOCK_SIZE];
371 struct GNUNET_FS_BlockOptions bo;
373 if (NULL == ca_result)
375 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to connect to FS for publishing: %s\n", emsg);
376 po->publish_cont (po->publish_cont_cls,
378 GNUNET_TESTBED_operation_done (po->fs_op);
384 bo.expiration_time = GNUNET_TIME_relative_to_absolute (CONTENT_LIFETIME);
385 bo.anonymity_level = po->anonymity;
386 bo.content_priority = 42;
387 bo.replication_level = 1;
388 if (GNUNET_YES == po->do_index)
390 po->publish_tmp_file = GNUNET_DISK_mktemp ("fs-test-publish-index");
391 GNUNET_assert (po->publish_tmp_file != NULL);
392 fh = GNUNET_DISK_file_open (po->publish_tmp_file,
393 GNUNET_DISK_OPEN_WRITE |
394 GNUNET_DISK_OPEN_CREATE,
395 GNUNET_DISK_PERM_USER_READ |
396 GNUNET_DISK_PERM_USER_WRITE);
397 GNUNET_assert (NULL != fh);
399 while (off < po->size)
401 bsize = GNUNET_MIN (sizeof (buf), po->size - off);
403 GNUNET_assert (bsize == file_generator (&po->publish_seed, off, bsize, buf, &em));
404 GNUNET_assert (em == NULL);
405 GNUNET_assert (bsize == GNUNET_DISK_file_write (fh, buf, bsize));
408 GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
409 fi = GNUNET_FS_file_information_create_from_file (po->fs, po,
410 po->publish_tmp_file,
411 NULL, NULL, po->do_index,
416 fi = GNUNET_FS_file_information_create_from_reader (po->fs, po,
418 &file_generator, &po->publish_seed,
422 po->publish_context =
423 GNUNET_FS_publish_start (po->fs, fi, NULL, NULL, NULL,
424 GNUNET_FS_PUBLISH_OPTION_NONE);
429 * Publish a file at the given peer.
431 * @param peer where to publish
432 * @param timeout if this operation cannot be completed within the
433 * given period, call the continuation with an error code
434 * @param anonymity option for publication
435 * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
436 * GNUNET_SYSERR for simulation
437 * @param size size of the file to publish
438 * @param seed seed to use for file generation
439 * @param verbose how verbose to be in reporting
440 * @param cont function to call when done
441 * @param cont_cls closure for cont
444 GNUNET_FS_TEST_publish (struct GNUNET_TESTBED_Peer *peer,
445 struct GNUNET_TIME_Relative timeout, uint32_t anonymity,
446 int do_index, uint64_t size, uint32_t seed,
447 unsigned int verbose,
448 GNUNET_FS_TEST_UriContinuation cont, void *cont_cls)
450 struct TestPublishOperation *po;
452 po = GNUNET_malloc (sizeof (struct TestPublishOperation));
453 po->publish_cont = cont;
454 po->publish_cont_cls = cont_cls;
455 po->publish_seed = seed;
456 po->anonymity = anonymity;
458 po->verbose = verbose;
459 po->do_index = do_index;
460 po->fs_op = GNUNET_TESTBED_service_connect (po,
463 &publish_fs_connect_complete_cb,
465 &publish_connect_adapter,
466 &fs_disconnect_adapter,
468 po->publish_timeout_task =
469 GNUNET_SCHEDULER_add_delayed (timeout, &publish_timeout, po);
473 /* ************************** download ************************ */
477 * Task scheduled to run when download operation times out.
479 * @param cls the download operation context
480 * @param tc scheduler context (unused)
483 download_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
485 struct TestDownloadOperation *dop = cls;
487 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
488 "Timeout while trying to download file\n");
489 dop->download_timeout_task = GNUNET_SCHEDULER_NO_TASK;
490 GNUNET_FS_download_stop (dop->download_context, GNUNET_YES);
491 GNUNET_SCHEDULER_add_continuation (dop->download_cont,
492 dop->download_cont_cls,
493 GNUNET_SCHEDULER_REASON_TIMEOUT);
494 GNUNET_TESTBED_operation_done (dop->fs_op);
495 GNUNET_FS_uri_destroy (dop->uri);
501 * Task scheduled to report on the completion of our download operation.
503 * @param cls the download operation context
504 * @param tc scheduler context (unused)
507 report_success (void *cls,
508 const struct GNUNET_SCHEDULER_TaskContext *tc)
510 struct TestDownloadOperation *dop = cls;
512 GNUNET_FS_download_stop (dop->download_context, GNUNET_YES);
513 GNUNET_SCHEDULER_add_continuation (dop->download_cont,
514 dop->download_cont_cls,
515 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
516 GNUNET_TESTBED_operation_done (dop->fs_op);
517 GNUNET_FS_uri_destroy (dop->uri);
523 * Progress callback for file-sharing events while downloading.
525 * @param cls the download operation context
526 * @param info information about the event
529 download_progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
531 struct TestDownloadOperation *dop = cls;
533 switch (info->status)
535 case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
537 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Download at %llu/%llu bytes\n",
538 (unsigned long long) info->value.download.completed,
539 (unsigned long long) info->value.download.size);
541 case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
542 GNUNET_SCHEDULER_cancel (dop->download_timeout_task);
543 dop->download_timeout_task = GNUNET_SCHEDULER_NO_TASK;
544 GNUNET_SCHEDULER_add_continuation (&report_success, dop,
545 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
547 case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
548 case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
550 /* FIXME: monitor data correctness during download progress */
551 /* FIXME: do performance reports given sufficient verbosity */
552 /* FIXME: advance timeout task to "immediate" on error */
561 * Connect adapter for download operation.
563 * @param cls the 'struct TestDownloadOperation'
564 * @param cfg configuration of the peer to connect to; will be available until
565 * GNUNET_TESTBED_operation_done() is called on the operation returned
566 * from GNUNET_TESTBED_service_connect()
567 * @return service handle to return in 'op_result', NULL on error
570 download_connect_adapter (void *cls,
571 const struct GNUNET_CONFIGURATION_Handle *cfg)
573 struct TestPublishOperation *po = cls;
575 return GNUNET_FS_start (cfg,
577 &download_progress_cb, po,
578 GNUNET_FS_FLAGS_NONE,
579 GNUNET_FS_OPTIONS_END);
584 * Callback to be called when testbed has connected to the fs service
586 * @param cls the 'struct TestPublishOperation'
587 * @param op the operation that has been finished
588 * @param ca_result the 'struct GNUNET_FS_Handle ' (NULL on error)
589 * @param emsg error message in case the operation has failed; will be NULL if
590 * operation has executed successfully.
593 download_fs_connect_complete_cb (void *cls,
594 struct GNUNET_TESTBED_Operation *op,
598 struct TestDownloadOperation *dop = cls;
601 GNUNET_assert (NULL != dop->fs);
602 dop->download_context =
603 GNUNET_FS_download_start (dop->fs, dop->uri, NULL, NULL, NULL, 0, dop->size,
604 dop->anonymity, GNUNET_FS_DOWNLOAD_OPTION_NONE,
610 * Perform test download.
612 * @param peer which peer to download from
613 * @param timeout if this operation cannot be completed within the
614 * given period, call the continuation with an error code
615 * @param anonymity option for download
616 * @param seed used for file validation
617 * @param uri URI of file to download (CHK/LOC only)
618 * @param verbose how verbose to be in reporting
619 * @param cont function to call when done
620 * @param cont_cls closure for cont
623 GNUNET_FS_TEST_download (struct GNUNET_TESTBED_Peer *peer,
624 struct GNUNET_TIME_Relative timeout,
625 uint32_t anonymity, uint32_t seed,
626 const struct GNUNET_FS_Uri *uri, unsigned int verbose,
627 GNUNET_SCHEDULER_Task cont, void *cont_cls)
629 struct TestDownloadOperation *dop;
631 dop = GNUNET_malloc (sizeof (struct TestDownloadOperation));
632 dop->uri = GNUNET_FS_uri_dup (uri);
633 dop->size = GNUNET_FS_uri_chk_get_file_size (uri);
634 dop->verbose = verbose;
635 dop->anonymity = anonymity;
636 dop->download_cont = cont;
637 dop->download_cont_cls = cont_cls;
638 dop->download_seed = seed;
640 dop->fs_op = GNUNET_TESTBED_service_connect (dop,
643 &download_fs_connect_complete_cb,
645 &download_connect_adapter,
646 &fs_disconnect_adapter,
648 dop->download_timeout_task =
649 GNUNET_SCHEDULER_add_delayed (timeout, &download_timeout, dop);
653 /* end of fs_test_lib.c */