src/fs/fs_test_lib.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010, 2011, 2012 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  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
  28  */
  29 #include "platform.h"
  30 #include "fs_api.h"
  31 #include "fs_test_lib.h"
  32
  33
  34 #define CONTENT_LIFETIME GNUNET_TIME_UNIT_HOURS
  35
  36
  37 /**
  38  * Handle for a publishing operation started for testing FS.
  39  */
  40 struct TestPublishOperation
  41 {
  42
  43   /**
  44    * Handle for the operation to connect to the peer's 'fs' service.
  45    */
  46   struct GNUNET_TESTBED_Operation *fs_op;
  47
  48   /**
  49    * Handle to the file sharing context using this daemon.
  50    */
  51   struct GNUNET_FS_Handle *fs;
  52
  53   /**
  54    * Function to call when upload is done.
  55    */
  56   GNUNET_FS_TEST_UriContinuation publish_cont;
  57
  58   /**
  59    * Closure for publish_cont.
  60    */
  61   void *publish_cont_cls;
  62
  63   /**
  64    * Task to abort publishing (timeout).
  65    */
  66   GNUNET_SCHEDULER_TaskIdentifier publish_timeout_task;
  67
  68   /**
  69    * Seed for file generation.
  70    */
  71   uint32_t publish_seed;
  72
  73   /**
  74    * Context for current publishing operation.
  75    */
  76   struct GNUNET_FS_PublishContext *publish_context;
  77
  78   /**
  79    * Result URI.
  80    */
  81   struct GNUNET_FS_Uri *publish_uri;
  82
  83   /**
  84    * Name of the temporary file used, or NULL for none.
  85    */
  86   char *publish_tmp_file;
  87
  88   /**
  89    * Size of the file.
  90    */
  91   uint64_t size;
  92
  93   /**
  94    * Anonymity level used.
  95    */
  96   uint32_t anonymity;
  97
  98   /**
  99    * Verbosity level of the current operation.
 100    */
 101   unsigned int verbose;
 102
 103   /**
 104    * Are we testing indexing? (YES: index, NO: insert, SYSERR: simulate)
 105    */
 106   int do_index;
 107 };
 108
 109
 110 /**
 111  * Handle for a download operation started for testing FS.
 112  */
 113 struct TestDownloadOperation
 114 {
 115
 116   /**
 117    * Handle for the operation to connect to the peer's 'fs' service.
 118    */
 119   struct GNUNET_TESTBED_Operation *fs_op;
 120
 121   /**
 122    * Handle to the file sharing context using this daemon.
 123    */
 124   struct GNUNET_FS_Handle *fs;
 125
 126   /**
 127    * Handle to the daemon via testing.
 128    */
 129   struct GNUNET_TESTING_Daemon *daemon;
 130
 131   /**
 132    * Function to call when download is done.
 133    */
 134   GNUNET_SCHEDULER_Task download_cont;
 135
 136   /**
 137    * Closure for download_cont.
 138    */
 139   void *download_cont_cls;
 140
 141   /**
 142    * URI to download.
 143    */
 144   struct GNUNET_FS_Uri *uri;
 145
 146   /**
 147    * Task to abort downloading (timeout).
 148    */
 149   GNUNET_SCHEDULER_TaskIdentifier download_timeout_task;
 150
 151   /**
 152    * Context for current download operation.
 153    */
 154   struct GNUNET_FS_DownloadContext *download_context;
 155
 156   /**
 157    * Size of the file.
 158    */
 159   uint64_t size;
 160
 161   /**
 162    * Anonymity level used.
 163    */
 164   uint32_t anonymity;
 165
 166   /**
 167    * Seed for download verification.
 168    */
 169   uint32_t download_seed;
 170
 171   /**
 172    * Verbosity level of the current operation.
 173    */
 174   unsigned int verbose;
 175
 176 };
 177
 178
 179 /**
 180  * Task scheduled to report on the completion of our publish operation.
 181  *
 182  * @param cls the publish operation context
 183  * @param tc scheduler context (unused)
 184  */
 185 static void
 186 report_uri (void *cls,
 187             const struct GNUNET_SCHEDULER_TaskContext *tc)
 188 {
 189   struct TestPublishOperation *po = cls;
 190
 191   GNUNET_FS_publish_stop (po->publish_context);
 192   GNUNET_TESTBED_operation_done (po->fs_op);
 193   po->publish_cont (po->publish_cont_cls,
 194                     po->publish_uri,
 195                     (GNUNET_YES == po->do_index)
 196                     ? po->publish_tmp_file
 197                     : NULL);
 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);
 202   GNUNET_free (po);
 203 }
 204
 205
 206 /**
 207  * Task scheduled to run when publish operation times out.
 208  *
 209  * @param cls the publish operation context
 210  * @param tc scheduler context (unused)
 211  */
 212 static void
 213 publish_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 214 {
 215   struct TestPublishOperation *po = cls;
 216
 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);
 225   GNUNET_free (po);
 226 }
 227
 228
 229 /**
 230  * Progress callback for file-sharing events while publishing.
 231  *
 232  * @param cls the publish operation context
 233  * @param info information about the event
 234  */
 235 static void *
 236 publish_progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
 237 {
 238   struct TestPublishOperation *po = cls;
 239
 240   switch (info->status)
 241   {
 242   case GNUNET_FS_STATUS_PUBLISH_COMPLETED:
 243     GNUNET_SCHEDULER_cancel (po->publish_timeout_task);
 244     po->publish_timeout_task = GNUNET_SCHEDULER_NO_TASK;
 245     po->publish_uri =
 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);
 249     break;
 250   case GNUNET_FS_STATUS_PUBLISH_PROGRESS:
 251     if (po->verbose)
 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);
 255     break;
 256   case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
 257     if (po->verbose)
 258       GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Download at %llu/%llu bytes\n",
 259                   (unsigned long long) info->value.download.completed,
 260                   (unsigned long long) info->value.download.size);
 261     break;
 262   default:
 263     break;
 264   }
 265   return NULL;
 266 }
 267
 268
 269 /**
 270  * Generate test data for publishing test.
 271  *
 272  * @param cls pointer to uint32_t with publishing seed
 273  * @param offset offset to generate data for
 274  * @param max maximum number of bytes to generate
 275  * @param buf where to write generated data
 276  * @param emsg where to store error message (unused)
 277  * @return number of bytes written to buf
 278  */
 279 static size_t
 280 file_generator (void *cls,
 281                 uint64_t offset,
 282                 size_t max,
 283                 void *buf,
 284                 char **emsg)
 285 {
 286   uint32_t *publish_seed = cls;
 287   uint64_t pos;
 288   uint8_t *cbuf = buf;
 289   int mod;
 290
 291   if (emsg != NULL)
 292     *emsg = NULL;
 293   if (buf == NULL)
 294     return 0;
 295   for (pos = 0; pos < 8; pos++)
 296     cbuf[pos] = (uint8_t) (offset >> pos * 8);
 297   for (pos = 8; pos < max; pos++)
 298   {
 299     mod = (255 - (offset / 1024 / 32));
 300     if (mod == 0)
 301       mod = 1;
 302     cbuf[pos] = (uint8_t) ((offset * (*publish_seed)) % mod);
 303   }
 304   return max;
 305 }
 306
 307
 308 /**
 309  * Connect adapter for publishing operation.
 310  *
 311  * @param cls the 'struct TestPublishOperation'
 312  * @param cfg configuration of the peer to connect to; will be available until
 313  *          GNUNET_TESTBED_operation_done() is called on the operation returned
 314  *          from GNUNET_TESTBED_service_connect()
 315  * @return service handle to return in 'op_result', NULL on error
 316  */
 317 static void *
 318 publish_connect_adapter (void *cls,
 319                          const struct GNUNET_CONFIGURATION_Handle *cfg)
 320 {
 321   struct TestPublishOperation *po = cls;
 322
 323   return GNUNET_FS_start (cfg,
 324                           "fs-test-publish",
 325                           &publish_progress_cb, po,
 326                           GNUNET_FS_FLAGS_NONE,
 327                           GNUNET_FS_OPTIONS_END);
 328 }
 329
 330
 331 /**
 332  * Adapter function called to destroy connection to file-sharing service.
 333  *
 334  * @param cls the 'struct GNUNET_FS_Handle'
 335  * @param op_result unused (different for publish/download!)
 336  */
 337 static void
 338 fs_disconnect_adapter (void *cls,
 339                        void *op_result)
 340 {
 341   struct GNUNET_FS_Handle *fs = op_result;
 342
 343   GNUNET_FS_stop (fs);
 344 }
 345
 346
 347 /**
 348  * Callback to be called when testbed has connected to the fs service
 349  *
 350  * @param cls the 'struct TestPublishOperation'
 351  * @param op the operation that has been finished
 352  * @param ca_result the 'struct GNUNET_FS_Handle ' (NULL on error)
 353  * @param emsg error message in case the operation has failed; will be NULL if
 354  *          operation has executed successfully.
 355  */
 356 static void
 357 publish_fs_connect_complete_cb (void *cls,
 358                                 struct GNUNET_TESTBED_Operation *op,
 359                                 void *ca_result,
 360                                 const char *emsg)
 361 {
 362   struct TestPublishOperation *po = cls;
 363   struct GNUNET_FS_FileInformation *fi;
 364   struct GNUNET_DISK_FileHandle *fh;
 365   char *em;
 366   uint64_t off;
 367   char buf[DBLOCK_SIZE];
 368   size_t bsize;
 369   struct GNUNET_FS_BlockOptions bo;
 370
 371   if (NULL == ca_result)
 372     {
 373       GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Failed to connect to FS for publishing: %s\n", emsg);
 374       po->publish_cont (po->publish_cont_cls,
 375                         NULL, NULL);
 376       GNUNET_TESTBED_operation_done (po->fs_op);
 377       GNUNET_free (po);
 378       return;
 379     }
 380   po->fs = ca_result;
 381
 382   bo.expiration_time = GNUNET_TIME_relative_to_absolute (CONTENT_LIFETIME);
 383   bo.anonymity_level = po->anonymity;
 384   bo.content_priority = 42;
 385   bo.replication_level = 1;
 386   if (GNUNET_YES == po->do_index)
 387   {
 388     po->publish_tmp_file = GNUNET_DISK_mktemp ("fs-test-publish-index");
 389     GNUNET_assert (po->publish_tmp_file != NULL);
 390     fh = GNUNET_DISK_file_open (po->publish_tmp_file,
 391                                 GNUNET_DISK_OPEN_WRITE |
 392                                 GNUNET_DISK_OPEN_CREATE,
 393                                 GNUNET_DISK_PERM_USER_READ |
 394                                 GNUNET_DISK_PERM_USER_WRITE);
 395     GNUNET_assert (NULL != fh);
 396     off = 0;
 397     while (off < po->size)
 398     {
 399       bsize = GNUNET_MIN (sizeof (buf), po->size - off);
 400       emsg = NULL;
 401       GNUNET_assert (bsize == file_generator (&po->publish_seed, off, bsize, buf, &em));
 402       GNUNET_assert (em == NULL);
 403       GNUNET_assert (bsize == GNUNET_DISK_file_write (fh, buf, bsize));
 404       off += bsize;
 405     }
 406     GNUNET_assert (GNUNET_OK == GNUNET_DISK_file_close (fh));
 407     fi = GNUNET_FS_file_information_create_from_file (po->fs, po,
 408                                                       po->publish_tmp_file,
 409                                                       NULL, NULL, po->do_index,
 410                                                       &bo);
 411   }
 412   else
 413   {
 414     fi = GNUNET_FS_file_information_create_from_reader (po->fs, po,
 415                                                         po->size,
 416                                                         &file_generator, &po->publish_seed,
 417                                                         NULL, NULL,
 418                                                         po->do_index, &bo);
 419   }
 420   po->publish_context =
 421     GNUNET_FS_publish_start (po->fs, fi, NULL, NULL, NULL,
 422                              GNUNET_FS_PUBLISH_OPTION_NONE);
 423 }
 424
 425
 426 /**
 427  * Publish a file at the given peer.
 428  *
 429  * @param peer where to publish
 430  * @param timeout if this operation cannot be completed within the
 431  *                given period, call the continuation with an error code
 432  * @param anonymity option for publication
 433  * @param do_index GNUNET_YES for index, GNUNET_NO for insertion,
 434  *                GNUNET_SYSERR for simulation
 435  * @param size size of the file to publish
 436  * @param seed seed to use for file generation
 437  * @param verbose how verbose to be in reporting
 438  * @param cont function to call when done
 439  * @param cont_cls closure for cont
 440  */
 441 void
 442 GNUNET_FS_TEST_publish (struct GNUNET_TESTBED_Peer *peer,
 443                         struct GNUNET_TIME_Relative timeout, uint32_t anonymity,
 444                         int do_index, uint64_t size, uint32_t seed,
 445                         unsigned int verbose,
 446                         GNUNET_FS_TEST_UriContinuation cont, void *cont_cls)
 447 {
 448   struct TestPublishOperation *po;
 449
 450   po = GNUNET_malloc (sizeof (struct TestPublishOperation));
 451   po->publish_cont = cont;
 452   po->publish_cont_cls = cont_cls;
 453   po->publish_seed = seed;
 454   po->anonymity = anonymity;
 455   po->size = size;
 456   po->verbose = verbose;
 457   po->do_index = do_index;
 458   po->fs_op = GNUNET_TESTBED_service_connect (po,
 459                                               peer,
 460                                               "fs",
 461                                               &publish_fs_connect_complete_cb,
 462                                               po,
 463                                               &publish_connect_adapter,
 464                                               &fs_disconnect_adapter,
 465                                               po);
 466   po->publish_timeout_task =
 467       GNUNET_SCHEDULER_add_delayed (timeout, &publish_timeout, po);
 468 }
 469
 470
 471 /* ************************** download ************************ */
 472
 473
 474 /**
 475  * Task scheduled to run when download operation times out.
 476  *
 477  * @param cls the download operation context
 478  * @param tc scheduler context (unused)
 479  */
 480 static void
 481 download_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 482 {
 483   struct TestDownloadOperation *dop = cls;
 484
 485   GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 486               "Timeout while trying to download file\n");
 487   dop->download_timeout_task = GNUNET_SCHEDULER_NO_TASK;
 488   GNUNET_FS_download_stop (dop->download_context, GNUNET_YES);
 489   GNUNET_SCHEDULER_add_continuation (dop->download_cont,
 490                                      dop->download_cont_cls,
 491                                      GNUNET_SCHEDULER_REASON_TIMEOUT);
 492   GNUNET_TESTBED_operation_done (dop->fs_op);
 493   GNUNET_FS_uri_destroy (dop->uri);
 494   GNUNET_free (dop);
 495 }
 496
 497
 498 /**
 499  * Task scheduled to report on the completion of our download operation.
 500  *
 501  * @param cls the download operation context
 502  * @param tc scheduler context (unused)
 503  */
 504 static void
 505 report_success (void *cls,
 506                 const struct GNUNET_SCHEDULER_TaskContext *tc)
 507 {
 508   struct TestDownloadOperation *dop = cls;
 509
 510   GNUNET_FS_download_stop (dop->download_context, GNUNET_YES);
 511   GNUNET_SCHEDULER_add_continuation (dop->download_cont,
 512                                      dop->download_cont_cls,
 513                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 514   GNUNET_TESTBED_operation_done (dop->fs_op);
 515   GNUNET_FS_uri_destroy (dop->uri);
 516   GNUNET_free (dop);
 517 }
 518
 519
 520 /**
 521  * Progress callback for file-sharing events while downloading.
 522  *
 523  * @param cls the download operation context
 524  * @param info information about the event
 525  */
 526 static void *
 527 download_progress_cb (void *cls, const struct GNUNET_FS_ProgressInfo *info)
 528 {
 529   struct TestDownloadOperation *dop = cls;
 530
 531   switch (info->status)
 532   {
 533   case GNUNET_FS_STATUS_DOWNLOAD_PROGRESS:
 534     if (dop->verbose)
 535       GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Download at %llu/%llu bytes\n",
 536                   (unsigned long long) info->value.download.completed,
 537                   (unsigned long long) info->value.download.size);
 538     break;
 539   case GNUNET_FS_STATUS_DOWNLOAD_COMPLETED:
 540     GNUNET_SCHEDULER_cancel (dop->download_timeout_task);
 541     dop->download_timeout_task = GNUNET_SCHEDULER_NO_TASK;
 542     GNUNET_SCHEDULER_add_continuation (&report_success, dop,
 543                                        GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 544     break;
 545   case GNUNET_FS_STATUS_DOWNLOAD_ACTIVE:
 546   case GNUNET_FS_STATUS_DOWNLOAD_INACTIVE:
 547     break;
 548     /* FIXME: monitor data correctness during download progress */
 549     /* FIXME: do performance reports given sufficient verbosity */
 550     /* FIXME: advance timeout task to "immediate" on error */
 551   default:
 552     break;
 553   }
 554   return NULL;
 555 }
 556
 557
 558 /**
 559  * Connect adapter for download operation.
 560  *
 561  * @param cls the 'struct TestDownloadOperation'
 562  * @param cfg configuration of the peer to connect to; will be available until
 563  *          GNUNET_TESTBED_operation_done() is called on the operation returned
 564  *          from GNUNET_TESTBED_service_connect()
 565  * @return service handle to return in 'op_result', NULL on error
 566  */
 567 static void *
 568 download_connect_adapter (void *cls,
 569                          const struct GNUNET_CONFIGURATION_Handle *cfg)
 570 {
 571   struct TestPublishOperation *po = cls;
 572
 573   return GNUNET_FS_start (cfg,
 574                           "fs-test-download",
 575                           &download_progress_cb, po,
 576                           GNUNET_FS_FLAGS_NONE,
 577                           GNUNET_FS_OPTIONS_END);
 578 }
 579
 580
 581 /**
 582  * Callback to be called when testbed has connected to the fs service
 583  *
 584  * @param cls the 'struct TestPublishOperation'
 585  * @param op the operation that has been finished
 586  * @param ca_result the 'struct GNUNET_FS_Handle ' (NULL on error)
 587  * @param emsg error message in case the operation has failed; will be NULL if
 588  *          operation has executed successfully.
 589  */
 590 static void
 591 download_fs_connect_complete_cb (void *cls,
 592                                  struct GNUNET_TESTBED_Operation *op,
 593                                  void *ca_result,
 594                                  const char *emsg)
 595 {
 596   struct TestDownloadOperation *dop = cls;
 597
 598   dop->fs = ca_result;
 599   GNUNET_assert (NULL != dop->fs);
 600   dop->download_context =
 601     GNUNET_FS_download_start (dop->fs, dop->uri, NULL, NULL, NULL, 0, dop->size,
 602                               dop->anonymity, GNUNET_FS_DOWNLOAD_OPTION_NONE,
 603                               NULL, NULL);
 604 }
 605
 606
 607 /**
 608  * Perform test download.
 609  *
 610  * @param peer which peer to download from
 611  * @param timeout if this operation cannot be completed within the
 612  *                given period, call the continuation with an error code
 613  * @param anonymity option for download
 614  * @param seed used for file validation
 615  * @param uri URI of file to download (CHK/LOC only)
 616  * @param verbose how verbose to be in reporting
 617  * @param cont function to call when done
 618  * @param cont_cls closure for cont
 619  */
 620 void
 621 GNUNET_FS_TEST_download (struct GNUNET_TESTBED_Peer *peer,
 622                          struct GNUNET_TIME_Relative timeout,
 623                          uint32_t anonymity, uint32_t seed,
 624                          const struct GNUNET_FS_Uri *uri, unsigned int verbose,
 625                          GNUNET_SCHEDULER_Task cont, void *cont_cls)
 626 {
 627   struct TestDownloadOperation *dop;
 628
 629   dop = GNUNET_malloc (sizeof (struct TestDownloadOperation));
 630   dop->uri = GNUNET_FS_uri_dup (uri);
 631   dop->size = GNUNET_FS_uri_chk_get_file_size (uri);
 632   dop->verbose = verbose;
 633   dop->anonymity = anonymity;
 634   dop->download_cont = cont;
 635   dop->download_cont_cls = cont_cls;
 636   dop->download_seed = seed;
 637
 638   dop->fs_op = GNUNET_TESTBED_service_connect (dop,
 639                                                peer,
 640                                                "fs",
 641                                                &download_fs_connect_complete_cb,
 642                                                dop,
 643                                                &download_connect_adapter,
 644                                                &fs_disconnect_adapter,
 645                                                dop);
 646   dop->download_timeout_task =
 647       GNUNET_SCHEDULER_add_delayed (timeout, &download_timeout, dop);
 648 }
 649
 650
 651 /* end of fs_test_lib.c */