src/datastore/perf_datastore_api.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2004, 2005, 2006, 2007, 2009, 2011, 2015 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19 */
  20 /*
  21  * @file datastore/perf_datastore_api.c
  22  * @brief performance measurement for the datastore implementation
  23  * @author Christian Grothoff
  24  *
  25  * This testcase inserts a bunch of (variable size) data and then
  26  * deletes data until the (reported) database size drops below a given
  27  * threshold.  This is iterated 10 times, with the actual size of the
  28  * content stored and the number of operations performed being printed
  29  * for each iteration.  The code also prints a "I" for every 40 blocks
  30  * inserted and a "D" for every 40 blocks deleted.  The deletion
  31  * strategy uses the "random" iterator.  Priorities and expiration
  32  * dates are set using a pseudo-random value within a realistic range.
  33  */
  34 #include "platform.h"
  35 #include "gnunet_util_lib.h"
  36 #include "gnunet_protocols.h"
  37 #include "gnunet_datastore_service.h"
  38 #include "gnunet_testing_lib.h"
  39 #include <gauger.h>
  40
  41 /**
  42  * How long until we give up on transmitting the message?
  43  */
  44 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
  45
  46 /**
  47  * Target datastore size (in bytes).
  48  */
  49 #define MAX_SIZE (1024LL * 1024 * 4)
  50
  51 /**
  52  * Report progress outside of major reports? Should probably be #GNUNET_YES if
  53  * size is > 16 MB.
  54  */
  55 #define REPORT_ID GNUNET_YES
  56
  57 /**
  58  * Number of put operations equivalent to 1/3rd of #MAX_SIZE
  59  */
  60 #define PUT_10 MAX_SIZE / 32 / 1024 / 3
  61
  62 /**
  63  * Total number of iterations (each iteration doing
  64  * PUT_10 put operations); we report full status every
  65  * 10 iterations.  Abort with CTRL-C.
  66  */
  67 #define ITERATIONS 8
  68
  69 /**
  70  * Total number of iterations to do to go beyond the quota.
  71  * The quota is set to 10 MB or 2.5 times #MAX_SIZE,
  72  * so we got 16 times #MAX_SIZE to be sure to hit it a LOT.
  73  */
  74 #define QUOTA_PUTS (MAX_SIZE / 32 / 1024 * 16LL)
  75
  76
  77 /**
  78  * Number of bytes stored in the datastore in total.
  79  */
  80 static unsigned long long stored_bytes;
  81
  82 /**
  83  * Number of entries stored in the datastore in total.
  84  */
  85 static unsigned long long stored_entries;
  86
  87 /**
  88  * Number of database operations performed.  Inserting
  89  * counts as one operation, deleting as two (as deletion
  90  * requires selecting a value for deletion first).
  91  */
  92 static unsigned long long stored_ops;
  93
  94 /**
  95  * Start time of the benchmark.
  96  */
  97 static struct GNUNET_TIME_Absolute start_time;
  98
  99 /**
 100  * Database backend we use.
 101  */
 102 static const char *plugin_name;
 103
 104 /**
 105  * Handle to the datastore.
 106  */
 107 static struct GNUNET_DATASTORE_Handle *datastore;
 108
 109 /**
 110  * Value we return from #main().
 111  */
 112 static int ok;
 113
 114 /**
 115  * Which phase of the process are we in?
 116  */
 117 enum RunPhase
 118 {
 119   /**
 120    * We are done (shutting down normally).
 121    */
 122   RP_DONE = 0,
 123
 124   /**
 125    * We are adding new entries to the datastore.
 126    */
 127   RP_PUT,
 128
 129   /**
 130    * We are deleting entries from the datastore.
 131    */
 132   RP_CUT,
 133
 134   /**
 135    * We are putting as much as we can to see how the database performs
 136    * when it reaches the quota and has to auto-delete (see #3903).
 137    */
 138   RP_PUT_QUOTA,
 139
 140   /**
 141    * We are generating a report.
 142    */
 143   RP_REPORT,
 144
 145   /**
 146    * Execution failed with some kind of error.
 147    */
 148   RP_ERROR
 149 };
 150
 151
 152 /**
 153  * Closure we give to all of the functions executing the
 154  * benchmark.  Could right now be global, but this allows
 155  * us to theoretically run multiple clients "in parallel".
 156  */
 157 struct CpsRunContext
 158 {
 159   /**
 160    * Execution phase we are in.
 161    */
 162   enum RunPhase phase;
 163
 164   /**
 165    * Size of the value we are currently storing (during #RP_PUT).
 166    */
 167   size_t size;
 168
 169   /**
 170    * Current iteration counter, we are done with the benchmark
 171    * once it hits #ITERATIONS.
 172    */
 173   unsigned int i;
 174
 175   /**
 176    * Counts the number of items put in the current phase.
 177    * Once it hits #PUT_10, we progress to the #RP_CUT phase
 178    * or are done if @e i reaches #ITERATIONS.
 179    */
 180   unsigned int j;
 181 };
 182
 183
 184 /**
 185  * Main state machine.  Executes the next step of the benchmark
 186  * depending on the current state.
 187  *
 188  * @param cls the `struct CpsRunContext`
 189  */
 190 static void
 191 run_continuation (void *cls);
 192
 193
 194 /**
 195  * Continuation called to notify client about result of the insertion
 196  * operation.  Checks for errors, updates our iteration counters and
 197  * continues execution with #run_continuation().
 198  *
 199  * @param cls the `struct CpsRunContext`
 200  * @param success #GNUNET_SYSERR on failure
 201  * @param min_expiration minimum expiration time required for content to be stored
 202  *                by the datacache at this time, zero for unknown
 203  * @param msg NULL on success, otherwise an error message
 204  */
 205 static void
 206 check_success (void *cls,
 207                int success,
 208                struct GNUNET_TIME_Absolute min_expiration,
 209                const char *msg)
 210 {
 211   struct CpsRunContext *crc = cls;
 212
 213 #if REPORT_ID
 214   FPRINTF (stderr, "%s",  (GNUNET_OK == success) ? "I" : "i");
 215 #endif
 216   if (GNUNET_OK != success)
 217   {
 218     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 219                 "Check success failed: `%s'\n",
 220                 msg);
 221     crc->phase = RP_ERROR;
 222     GNUNET_SCHEDULER_add_now (&run_continuation,
 223                               crc);
 224     return;
 225   }
 226   stored_bytes += crc->size;
 227   stored_ops++;
 228   stored_entries++;
 229   crc->j++;
 230   switch (crc->phase)
 231   {
 232   case RP_PUT:
 233     if (crc->j >= PUT_10)
 234     {
 235       crc->j = 0;
 236       crc->i++;
 237       if (crc->i == ITERATIONS)
 238         crc->phase = RP_PUT_QUOTA;
 239       else
 240         crc->phase = RP_CUT;
 241     }
 242     break;
 243   case RP_PUT_QUOTA:
 244     if (crc->j >= QUOTA_PUTS)
 245     {
 246       crc->j = 0;
 247       crc->phase = RP_DONE;
 248     }
 249     break;
 250   default:
 251     GNUNET_assert (0);
 252   }
 253   GNUNET_SCHEDULER_add_now (&run_continuation,
 254                             crc);
 255 }
 256
 257
 258 /**
 259  * Continuation called to notify client about result of the
 260  * deletion operation.  Checks for errors and continues
 261  * execution with #run_continuation().
 262  *
 263  * @param cls the `struct CpsRunContext`
 264  * @param success #GNUNET_SYSERR on failure
 265  * @param min_expiration minimum expiration time required for content to be stored
 266  *                by the datacache at this time, zero for unknown
 267  * @param msg NULL on success, otherwise an error message
 268  */
 269 static void
 270 remove_next (void *cls,
 271              int success,
 272              struct GNUNET_TIME_Absolute min_expiration,
 273              const char *msg)
 274 {
 275   struct CpsRunContext *crc = cls;
 276
 277   if (GNUNET_OK != success)
 278   {
 279     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 280                 "remove_next failed: `%s'\n",
 281                 msg);
 282     crc->phase = RP_ERROR;
 283     GNUNET_SCHEDULER_add_now (&run_continuation,
 284                               crc);
 285     return;
 286   }
 287 #if REPORT_ID
 288   FPRINTF (stderr, "%s",  "D");
 289 #endif
 290   GNUNET_assert (GNUNET_OK == success);
 291   GNUNET_SCHEDULER_add_now (&run_continuation,
 292                             crc);
 293 }
 294
 295
 296 /**
 297  * We have selected a value for deletion, trigger removal.
 298  *
 299  * @param cls the `struct CpsRunContext`
 300  * @param key key for the content
 301  * @param size number of bytes in data
 302  * @param data content stored
 303  * @param type type of the content
 304  * @param priority priority of the content
 305  * @param anonymity anonymity-level for the content
 306  * @param replication replication-level for the content
 307  * @param expiration expiration time for the content
 308  * @param uid unique identifier for the datum;
 309  *        maybe 0 if no unique identifier is available
 310  */
 311 static void
 312 delete_value (void *cls,
 313               const struct GNUNET_HashCode *key,
 314               size_t size,
 315               const void *data,
 316               enum GNUNET_BLOCK_Type type,
 317               uint32_t priority,
 318               uint32_t anonymity,
 319               uint32_t replication,
 320               struct GNUNET_TIME_Absolute expiration,
 321               uint64_t uid)
 322 {
 323   struct CpsRunContext *crc = cls;
 324
 325   GNUNET_assert (NULL != key);
 326   stored_ops++;
 327   stored_bytes -= size;
 328   stored_entries--;
 329   stored_ops++;
 330   if (stored_bytes < MAX_SIZE)
 331     crc->phase = RP_PUT;
 332   GNUNET_assert (NULL !=
 333                  GNUNET_DATASTORE_remove (datastore,
 334                                           key,
 335                                           size,
 336                                           data, 1, 1,
 337                                           &remove_next, crc));
 338 }
 339
 340
 341 /**
 342  * Main state machine.  Executes the next step of the benchmark
 343  * depending on the current state.
 344  *
 345  * @param cls the `struct CpsRunContext`
 346  */
 347 static void
 348 run_continuation (void *cls)
 349 {
 350   struct CpsRunContext *crc = cls;
 351   size_t size;
 352   static struct GNUNET_HashCode key;
 353   static char data[65536];
 354   char gstr[128];
 355
 356   ok = (int) crc->phase;
 357   switch (crc->phase)
 358   {
 359   case RP_PUT:
 360     memset (&key,
 361             256 - crc->i,
 362             sizeof (struct GNUNET_HashCode));
 363     /* most content is 32k */
 364     size = 32 * 1024;
 365     if (0 ==
 366         GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 367                                   16)) /* but some of it is less! */
 368       size = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 369                                        32 * 1024);
 370     crc->size = size = size - (size & 7);       /* always multiple of 8 */
 371     GNUNET_CRYPTO_hash (&key,
 372                         sizeof (struct GNUNET_HashCode),
 373                         &key);
 374     memset (data,
 375             (int) crc->j,
 376             size);
 377     if (crc->j > 255)
 378       memset (data,
 379               (int) (crc->j - 255),
 380               size / 2);
 381     data[0] = crc->i;
 382     GNUNET_assert (NULL !=
 383                    GNUNET_DATASTORE_put (datastore,
 384                                          0,
 385                                          &key,
 386                                          size,
 387                                          data,
 388                                          crc->j + 1,
 389                                          GNUNET_CRYPTO_random_u32
 390                                          (GNUNET_CRYPTO_QUALITY_WEAK, 100),
 391                                          crc->j,
 392                                          0,
 393                                          GNUNET_TIME_relative_to_absolute
 394                                          (GNUNET_TIME_relative_multiply
 395                                           (GNUNET_TIME_UNIT_SECONDS,
 396                                            GNUNET_CRYPTO_random_u32
 397                                            (GNUNET_CRYPTO_QUALITY_WEAK, 1000))),
 398                                          1,
 399                                          1,
 400                                          &check_success, crc));
 401     break;
 402   case RP_CUT:
 403     /* trim down below MAX_SIZE again */
 404     GNUNET_assert (NULL !=
 405                    GNUNET_DATASTORE_get_for_replication (datastore,
 406                                                          1, 1,
 407                                                          &delete_value,
 408                                                          crc));
 409     break;
 410   case RP_REPORT:
 411     printf (
 412 #if REPORT_ID
 413              "\n"
 414 #endif
 415              "Stored %llu kB / %lluk ops / %llu ops/s\n",
 416              stored_bytes / 1024,  /* used size in k */
 417              stored_ops / 1024, /* total operations (in k) */
 418              1000LL * 1000LL * stored_ops / (1 +
 419                                              GNUNET_TIME_absolute_get_duration
 420                                              (start_time).rel_value_us));
 421     crc->phase = RP_PUT;
 422     crc->j = 0;
 423     GNUNET_SCHEDULER_add_now (&run_continuation,
 424                               crc);
 425     break;
 426   case RP_PUT_QUOTA:
 427     memset (&key,
 428             256 - crc->i,
 429             sizeof (struct GNUNET_HashCode));
 430     /* most content is 32k */
 431     size = 32 * 1024;
 432     if (0 ==
 433         GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 434                                   16)) /* but some of it is less! */
 435       size = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
 436                                        32 * 1024);
 437     crc->size = size = size - (size & 7);       /* always multiple of 8 */
 438     GNUNET_CRYPTO_hash (&key,
 439                         sizeof (struct GNUNET_HashCode),
 440                         &key);
 441     memset (data,
 442             (int) crc->j,
 443             size);
 444     if (crc->j > 255)
 445       memset (data,
 446               (int) (crc->j - 255),
 447               size / 2);
 448     data[0] = crc->i;
 449     GNUNET_assert (NULL !=
 450                    GNUNET_DATASTORE_put (datastore,
 451                                          0, /* reservation ID */
 452                                          &key,
 453                                          size,
 454                                          data,
 455                                          crc->j + 1, /* type */
 456                                          GNUNET_CRYPTO_random_u32
 457                                          (GNUNET_CRYPTO_QUALITY_WEAK,
 458                                           100), /* priority */
 459                                          crc->j, /* anonymity */
 460                                          0, /* replication */
 461                                          GNUNET_TIME_relative_to_absolute
 462                                          (GNUNET_TIME_relative_multiply
 463                                           (GNUNET_TIME_UNIT_SECONDS,
 464                                            GNUNET_CRYPTO_random_u32
 465                                            (GNUNET_CRYPTO_QUALITY_WEAK, 1000))),
 466                                          1,
 467                                          1,
 468                                          &check_success, crc));
 469     break;
 470
 471   case RP_DONE:
 472     GNUNET_snprintf (gstr,
 473                      sizeof (gstr),
 474                      "DATASTORE-%s",
 475                      plugin_name);
 476     if ((crc->i == ITERATIONS) && (stored_ops > 0))
 477     {
 478       GAUGER (gstr,
 479               "PUT operation duration",
 480               GNUNET_TIME_absolute_get_duration (start_time).rel_value_us / 1000LL /
 481               stored_ops,
 482               "ms/operation");
 483       fprintf (stdout,
 484                "\nPUT performance: %s for %llu operations\n",
 485                GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration (start_time),
 486                                                        GNUNET_YES),
 487                stored_ops);
 488       fprintf (stdout,
 489                "PUT performance: %llu ms/operation\n",
 490                GNUNET_TIME_absolute_get_duration (start_time).rel_value_us / 1000LL /
 491                stored_ops);
 492     }
 493     GNUNET_DATASTORE_disconnect (datastore,
 494                                  GNUNET_YES);
 495     GNUNET_free (crc);
 496     ok = 0;
 497     break;
 498   case RP_ERROR:
 499     GNUNET_DATASTORE_disconnect (datastore, GNUNET_YES);
 500     GNUNET_free (crc);
 501     ok = 1;
 502     break;
 503   default:
 504     GNUNET_assert (0);
 505   }
 506 }
 507
 508
 509 /**
 510  * Function called with the result of the initial PUT operation.  If
 511  * the PUT succeeded, we start the actual benchmark loop, otherwise we
 512  * bail out with an error.
 513  *
 514  *
 515  * @param cls closure
 516  * @param success #GNUNET_SYSERR on failure
 517  * @param min_expiration minimum expiration time required for content to be stored
 518  *                by the datacache at this time, zero for unknown
 519  * @param msg NULL on success, otherwise an error message
 520  */
 521 static void
 522 run_tests (void *cls,
 523            int success,
 524            struct GNUNET_TIME_Absolute min_expiration,
 525            const char *msg)
 526 {
 527   struct CpsRunContext *crc = cls;
 528
 529   if (success != GNUNET_YES)
 530   {
 531     FPRINTF (stderr,
 532              "Test 'put' operation failed with error `%s' database likely not setup, skipping test.\n",
 533              msg);
 534     GNUNET_DATASTORE_disconnect (datastore,
 535                                  GNUNET_YES);
 536     GNUNET_free (crc);
 537     return;
 538   }
 539   GNUNET_SCHEDULER_add_now (&run_continuation,
 540                             crc);
 541 }
 542
 543
 544 /**
 545  * Beginning of the actual execution of the benchmark.
 546  * Performs a first test operation (PUT) to verify that
 547  * the plugin works at all.
 548  *
 549  * @param cls NULL
 550  * @param cfg configuration to use
 551  * @param peer peer handle (unused)
 552  */
 553 static void
 554 run (void *cls,
 555      const struct GNUNET_CONFIGURATION_Handle *cfg,
 556      struct GNUNET_TESTING_Peer *peer)
 557 {
 558   struct CpsRunContext *crc;
 559   static struct GNUNET_HashCode zkey;
 560
 561   datastore = GNUNET_DATASTORE_connect (cfg);
 562   start_time = GNUNET_TIME_absolute_get ();
 563   crc = GNUNET_new (struct CpsRunContext);
 564   crc->phase = RP_PUT;
 565   if (NULL ==
 566       GNUNET_DATASTORE_put (datastore,
 567                             0,
 568                             &zkey,
 569                             4, "TEST",
 570                             GNUNET_BLOCK_TYPE_TEST,
 571                             0, 0, 0,
 572                             GNUNET_TIME_relative_to_absolute (GNUNET_TIME_UNIT_SECONDS),
 573                             0, 1,
 574                             &run_tests, crc))
 575   {
 576     FPRINTF (stderr,
 577              "%s",
 578              "Test 'put' operation failed.\n");
 579     ok = 1;
 580     GNUNET_free (crc);
 581   }
 582 }
 583
 584
 585 /**
 586  * Entry point into the test. Determines which configuration / plugin
 587  * we are running with based on the name of the binary and starts
 588  * the peer.
 589  *
 590  * @param argc should be 1
 591  * @param argv used to determine plugin / configuration name.
 592  * @return 0 on success
 593  */
 594 int
 595 main (int argc,
 596       char *argv[])
 597 {
 598   char cfg_name[128];
 599
 600   plugin_name = GNUNET_TESTING_get_testname_from_underscore (argv[0]);
 601   GNUNET_snprintf (cfg_name,
 602                    sizeof (cfg_name),
 603                    "test_datastore_api_data_%s.conf",
 604                    plugin_name);
 605   if (0 !=
 606       GNUNET_TESTING_peer_run ("perf-gnunet-datastore",
 607                                cfg_name,
 608                                &run,
 609                                NULL))
 610     return 1;
 611   FPRINTF (stderr, "%s", "\n");
 612   return ok;
 613 }
 614
 615 /* end of perf_datastore_api.c */