src/datastore/perf_datastore_api.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2004, 2005, 2006, 2007, 2009, 2011 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  * @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
  35 #include "platform.h"
  36 #include "gnunet_util_lib.h"
  37 #include "gnunet_protocols.h"
  38 #include "gnunet_datastore_service.h"
  39 #include <gauger.h>
  40
  41 #define VERBOSE GNUNET_EXTRA_LOGGING
  42
  43 /**
  44  * How long until we give up on transmitting the message?
  45  */
  46 #define TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
  47
  48 static const char *plugin_name;
  49
  50 static struct GNUNET_DATASTORE_Handle *datastore;
  51
  52 /**
  53  * Target datastore size (in bytes).
  54  */
  55 #define MAX_SIZE 1024LL * 1024 * 4
  56
  57 /**
  58  * Report progress outside of major reports? Should probably be GNUNET_YES if
  59  * size is > 16 MB.
  60  */
  61 #define REPORT_ID GNUNET_YES
  62
  63 /**
  64  * Number of put operations equivalent to 1/3rd of MAX_SIZE
  65  */
  66 #define PUT_10 MAX_SIZE / 32 / 1024 / 3
  67
  68 /**
  69  * Total number of iterations (each iteration doing
  70  * PUT_10 put operations); we report full status every
  71  * 10 iterations.  Abort with CTRL-C.
  72  */
  73 #define ITERATIONS 8
  74
  75
  76 static unsigned long long stored_bytes;
  77
  78 static unsigned long long stored_entries;
  79
  80 static unsigned long long stored_ops;
  81
  82 static struct GNUNET_TIME_Absolute start_time;
  83
  84 static int ok;
  85
  86 enum RunPhase
  87 {
  88   RP_DONE = 0,
  89   RP_PUT,
  90   RP_CUT,
  91   RP_REPORT,
  92   RP_ERROR
  93 };
  94
  95
  96 struct CpsRunContext
  97 {
  98   const struct GNUNET_CONFIGURATION_Handle *cfg;
  99   enum RunPhase phase;
 100   int j;
 101   unsigned long long size;
 102   int i;
 103 };
 104
 105
 106
 107 static void
 108 run_continuation (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 109
 110
 111
 112
 113 static void
 114 check_success (void *cls, int success, const char *msg)
 115 {
 116   struct CpsRunContext *crc = cls;
 117
 118   if (GNUNET_OK != success)
 119   {
 120     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Check success failed: `%s'\n", msg);
 121     crc->phase = RP_ERROR;
 122     GNUNET_SCHEDULER_add_now (&run_continuation, crc);
 123     return;
 124   }
 125 #if REPORT_ID
 126   fprintf (stderr, "I");
 127 #endif
 128   stored_bytes += crc->size;
 129   stored_ops++;
 130   stored_entries++;
 131   crc->j++;
 132   if (crc->j >= PUT_10)
 133   {
 134     crc->j = 0;
 135     crc->i++;
 136     if (crc->i == ITERATIONS)
 137       crc->phase = RP_DONE;
 138     else
 139       crc->phase = RP_CUT;
 140   }
 141   GNUNET_SCHEDULER_add_continuation (&run_continuation, crc,
 142                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 143 }
 144
 145
 146 /**
 147  * Continuation called to notify client about result of the
 148  * operation.
 149  *
 150  * @param cls closure
 151  * @param success GNUNET_SYSERR on failure
 152  * @param msg NULL on success, otherwise an error message
 153  */
 154 static void
 155 remove_next (void *cls, int success, const char *msg)
 156 {
 157   struct CpsRunContext *crc = cls;
 158
 159   if (GNUNET_OK != success)
 160   {
 161     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "remove_next failed: `%s'\n", msg);
 162     crc->phase = RP_ERROR;
 163     GNUNET_SCHEDULER_add_now (&run_continuation, crc);
 164     return;
 165   }
 166 #if REPORT_ID
 167   fprintf (stderr, "D");
 168 #endif
 169   GNUNET_assert (GNUNET_OK == success);
 170   GNUNET_SCHEDULER_add_now (&run_continuation, crc);
 171 }
 172
 173
 174 static void
 175 delete_value (void *cls, const GNUNET_HashCode * key, size_t size,
 176               const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority,
 177               uint32_t anonymity, struct GNUNET_TIME_Absolute expiration,
 178               uint64_t uid)
 179 {
 180   struct CpsRunContext *crc = cls;
 181
 182   GNUNET_assert (NULL != key);
 183   stored_ops++;
 184   stored_bytes -= size;
 185   stored_entries--;
 186   stored_ops++;
 187   if (stored_bytes < MAX_SIZE)
 188     crc->phase = RP_PUT;
 189   GNUNET_assert (NULL !=
 190                  GNUNET_DATASTORE_remove (datastore, key, size, data, 1, 1,
 191                                           TIMEOUT, &remove_next, crc));
 192 }
 193
 194
 195 static void
 196 run_continuation (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 197 {
 198   struct CpsRunContext *crc = cls;
 199   size_t size;
 200   static GNUNET_HashCode key;
 201   static char data[65536];
 202   int i;
 203   int k;
 204   char gstr[128];
 205
 206   ok = (int) crc->phase;
 207   switch (crc->phase)
 208   {
 209   case RP_PUT:
 210     memset (&key, 256 - crc->i, sizeof (GNUNET_HashCode));
 211     i = crc->j;
 212     k = crc->i;
 213     /* most content is 32k */
 214     size = 32 * 1024;
 215     if (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16) == 0) /* but some of it is less! */
 216       size = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 32 * 1024);
 217     crc->size = size = size - (size & 7);       /* always multiple of 8 */
 218     GNUNET_CRYPTO_hash (&key, sizeof (GNUNET_HashCode), &key);
 219     memset (data, i, size);
 220     if (i > 255)
 221       memset (data, i - 255, size / 2);
 222     data[0] = k;
 223     GNUNET_assert (NULL !=
 224                    GNUNET_DATASTORE_put (datastore, 0, &key, size, data, i + 1,
 225                                          GNUNET_CRYPTO_random_u32
 226                                          (GNUNET_CRYPTO_QUALITY_WEAK, 100), i,
 227                                          0,
 228                                          GNUNET_TIME_relative_to_absolute
 229                                          (GNUNET_TIME_relative_multiply
 230                                           (GNUNET_TIME_UNIT_SECONDS,
 231                                            GNUNET_CRYPTO_random_u32
 232                                            (GNUNET_CRYPTO_QUALITY_WEAK, 1000))),
 233                                          1, 1, TIMEOUT, &check_success, crc));
 234     break;
 235   case RP_CUT:
 236     /* trim down below MAX_SIZE again */
 237     GNUNET_assert (NULL !=
 238                    GNUNET_DATASTORE_get_for_replication (datastore, 1, 1,
 239                                                          TIMEOUT, &delete_value,
 240                                                          crc));
 241     break;
 242   case RP_REPORT:
 243     printf (
 244 #if REPORT_ID
 245              "\n"
 246 #endif
 247              "Stored %llu kB / %lluk ops / %llu ops/s\n", stored_bytes / 1024,  /* used size in k */
 248              stored_ops / 1024, /* total operations (in k) */
 249              1000 * stored_ops / (1 +
 250                                   GNUNET_TIME_absolute_get_duration
 251                                   (start_time).rel_value));
 252     crc->phase = RP_PUT;
 253     crc->j = 0;
 254     GNUNET_SCHEDULER_add_continuation (&run_continuation, crc,
 255                                        GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 256     break;
 257   case RP_DONE:
 258     GNUNET_snprintf (gstr, sizeof (gstr), "DATASTORE-%s", plugin_name);
 259     if ((crc->i == ITERATIONS) && (stored_ops > 0))
 260       GAUGER (gstr, "PUT operation duration",
 261               GNUNET_TIME_absolute_get_duration (start_time).rel_value /
 262               stored_ops, "ms/operation");
 263     GNUNET_DATASTORE_disconnect (datastore, GNUNET_YES);
 264     GNUNET_free (crc);
 265     ok = 0;
 266     break;
 267   case RP_ERROR:
 268     GNUNET_DATASTORE_disconnect (datastore, GNUNET_YES);
 269     GNUNET_free (crc);
 270     ok = 1;
 271     break;
 272   default:
 273     GNUNET_assert (0);
 274   }
 275 }
 276
 277
 278 static void
 279 run_tests (void *cls, int success, const char *msg)
 280 {
 281   struct CpsRunContext *crc = cls;
 282
 283   if (success != GNUNET_YES)
 284   {
 285     fprintf (stderr,
 286              "Test 'put' operation failed with error `%s' database likely not setup, skipping test.",
 287              msg);
 288     GNUNET_free (crc);
 289     return;
 290   }
 291   GNUNET_SCHEDULER_add_continuation (&run_continuation, crc,
 292                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 293 }
 294
 295
 296 static void
 297 run (void *cls, char *const *args, const char *cfgfile,
 298      const struct GNUNET_CONFIGURATION_Handle *cfg)
 299 {
 300   struct CpsRunContext *crc;
 301   static GNUNET_HashCode zkey;
 302
 303   datastore = GNUNET_DATASTORE_connect (cfg);
 304   start_time = GNUNET_TIME_absolute_get ();
 305   crc = GNUNET_malloc (sizeof (struct CpsRunContext));
 306   crc->cfg = cfg;
 307   crc->phase = RP_PUT;
 308   if (NULL ==
 309       GNUNET_DATASTORE_put (datastore, 0, &zkey, 4, "TEST",
 310                             GNUNET_BLOCK_TYPE_TEST, 0, 0, 0,
 311                             GNUNET_TIME_relative_to_absolute
 312                             (GNUNET_TIME_UNIT_SECONDS), 0, 1,
 313                             GNUNET_TIME_UNIT_MINUTES, &run_tests, crc))
 314   {
 315     fprintf (stderr, "Test 'put' operation failed.\n");
 316     ok = 1;
 317     GNUNET_free (crc);
 318   }
 319 }
 320
 321
 322 static int
 323 check ()
 324 {
 325   struct GNUNET_OS_Process *proc;
 326   char cfg_name[128];
 327
 328   char *const argv[] = {
 329     "perf-datastore-api",
 330     "-c",
 331     cfg_name,
 332 #if VERBOSE
 333     "-L", "DEBUG",
 334 #endif
 335     NULL
 336   };
 337   struct GNUNET_GETOPT_CommandLineOption options[] = {
 338     GNUNET_GETOPT_OPTION_END
 339   };
 340
 341   GNUNET_snprintf (cfg_name, sizeof (cfg_name),
 342                    "test_datastore_api_data_%s.conf", plugin_name);
 343   proc =
 344       GNUNET_OS_start_process (NULL, NULL, "gnunet-service-arm",
 345                                "gnunet-service-arm",
 346 #if VERBOSE
 347                                "-L", "DEBUG",
 348 #endif
 349                                "-c", cfg_name, NULL);
 350   GNUNET_assert (NULL != proc);
 351   GNUNET_PROGRAM_run ((sizeof (argv) / sizeof (char *)) - 1, argv,
 352                       "perf-datastore-api", "nohelp", options, &run, NULL);
 353   sleep (1);                    /* give datastore chance to process 'DROP' */
 354   if (0 != GNUNET_OS_process_kill (proc, SIGTERM))
 355   {
 356     GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "kill");
 357     ok = 1;
 358   }
 359   GNUNET_OS_process_wait (proc);
 360   GNUNET_OS_process_close (proc);
 361   proc = NULL;
 362   return ok;
 363 }
 364
 365
 366 int
 367 main (int argc, char *argv[])
 368 {
 369   int ret;
 370   char *pos;
 371   char dir_name[128];
 372
 373   sleep (1);
 374   /* determine name of plugin to use */
 375   plugin_name = argv[0];
 376   while (NULL != (pos = strstr (plugin_name, "_")))
 377     plugin_name = pos + 1;
 378   if (NULL != (pos = strstr (plugin_name, ".")))
 379     pos[0] = 0;
 380   else
 381     pos = (char *) plugin_name;
 382
 383   GNUNET_snprintf (dir_name, sizeof (dir_name), "/tmp/test-gnunet-datastore-%s",
 384                    plugin_name);
 385   GNUNET_DISK_directory_remove (dir_name);
 386   GNUNET_log_setup ("perf-datastore-api",
 387 #if VERBOSE
 388                     "DEBUG",
 389 #else
 390                     "WARNING",
 391 #endif
 392                     NULL);
 393   ret = check ();
 394   if (pos != plugin_name)
 395     pos[0] = '.';
 396 #if REPORT_ID
 397   fprintf (stderr, "\n");
 398 #endif
 399   GNUNET_DISK_directory_remove (dir_name);
 400   return ret;
 401 }
 402
 403 /* end of perf_datastore_api.c */