src/datastore/perf_plugin_datastore.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 perf_plugin_datastore.c
  22  * @brief Profile database plugin directly, focusing on iterators.
  23  * @author Christian Grothoff
  24  */
  25
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_protocols.h"
  29 #include "gnunet_datastore_plugin.h"
  30 #include "gnunet_testing_lib.h"
  31 #include <gauger.h>
  32
  33 /**
  34  * Target datastore size (in bytes).  Realistic sizes are
  35  * more like 16 GB (not the default of 16 MB); however,
  36  * those take too long to run them in the usual "make check"
  37  * sequence.  Hence the value used for shipping is tiny.
  38  */
  39 #define MAX_SIZE 1024LL * 1024 * 16 * 1
  40
  41 #define ITERATIONS 2
  42
  43 /**
  44  * Number of put operations equivalent to 1/10th of MAX_SIZE
  45  */
  46 #define PUT_10 (MAX_SIZE / 32 / 1024 / ITERATIONS)
  47
  48 static char category[256];
  49
  50 static unsigned int hits[PUT_10 / 8 + 1];
  51
  52 static unsigned long long stored_bytes;
  53
  54 static unsigned long long stored_entries;
  55
  56 static unsigned long long stored_ops;
  57
  58 static const char *plugin_name;
  59
  60 static int ok;
  61
  62 enum RunPhase
  63 {
  64   RP_ERROR = 0,
  65   RP_PUT,
  66   RP_REP_GET,
  67   RP_ZA_GET,
  68   RP_EXP_GET,
  69   RP_DONE
  70 };
  71
  72
  73 struct CpsRunContext
  74 {
  75   unsigned int i;
  76   struct GNUNET_TIME_Absolute start;
  77   struct GNUNET_TIME_Absolute end;
  78   const struct GNUNET_CONFIGURATION_Handle *cfg;
  79   struct GNUNET_DATASTORE_PluginFunctions *api;
  80   enum RunPhase phase;
  81   unsigned int cnt;
  82   unsigned int iter;
  83   uint64_t offset;
  84 };
  85
  86
  87 /**
  88  * Function called by plugins to notify us about a
  89  * change in their disk utilization.
  90  *
  91  * @param cls closure (NULL)
  92  * @param delta change in disk utilization,
  93  *        0 for "reset to empty"
  94  */
  95 static void
  96 disk_utilization_change_cb (void *cls, int delta)
  97 {
  98 }
  99
 100
 101 static void
 102 putValue (struct GNUNET_DATASTORE_PluginFunctions *api, int i, int k)
 103 {
 104   char value[65536];
 105   size_t size;
 106   static struct GNUNET_HashCode key;
 107   static int ic;
 108   char *msg;
 109   unsigned int prio;
 110
 111   /* most content is 32k */
 112   size = 32 * 1024;
 113   if (GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 16) == 0)   /* but some of it is less! */
 114     size = 8 + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 32 * 1024);
 115   size = size - (size & 7);     /* always multiple of 8 */
 116
 117   /* generate random key */
 118   key.bits[0] = (unsigned int) GNUNET_TIME_absolute_get ().abs_value;
 119   GNUNET_CRYPTO_hash (&key, sizeof (struct GNUNET_HashCode), &key);
 120   memset (value, i, size);
 121   if (i > 255)
 122     memset (value, i - 255, size / 2);
 123   value[0] = k;
 124   memcpy (&value[4], &i, sizeof (i));
 125   msg = NULL;
 126   prio = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, 100);
 127   if (GNUNET_OK != api->put (api->cls, &key, size, value, 1 + i % 4 /* type */ ,
 128                              prio, i % 4 /* anonymity */ ,
 129                              0 /* replication */ ,
 130                              GNUNET_TIME_relative_to_absolute
 131                              (GNUNET_TIME_relative_multiply
 132                               (GNUNET_TIME_UNIT_MILLISECONDS,
 133                                60 * 60 * 60 * 1000 +
 134                                GNUNET_CRYPTO_random_u32
 135                                (GNUNET_CRYPTO_QUALITY_WEAK, 1000))), &msg))
 136   {
 137     FPRINTF (stderr, "ERROR: `%s'\n", msg);
 138     GNUNET_free_non_null (msg);
 139     return;
 140   }
 141   ic++;
 142   stored_bytes += size;
 143   stored_ops++;
 144   stored_entries++;
 145 }
 146
 147 static void
 148 test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
 149
 150
 151 static int
 152 iterate_zeros (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
 153                const void *data, enum GNUNET_BLOCK_Type type, uint32_t priority,
 154                uint32_t anonymity, struct GNUNET_TIME_Absolute expiration,
 155                uint64_t uid)
 156 {
 157   struct CpsRunContext *crc = cls;
 158   int i;
 159   const char *cdata = data;
 160
 161   GNUNET_assert (key != NULL);
 162   GNUNET_assert (size >= 8);
 163   memcpy (&i, &cdata[4], sizeof (i));
 164   hits[i / 8] |= (1 << (i % 8));
 165
 166   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 167               "Found result %d type=%u, priority=%u, size=%u, expire=%llu\n",
 168               i,
 169               type, priority, size, (unsigned long long) expiration.abs_value);
 170   crc->cnt++;
 171   if (crc->cnt == PUT_10 / 4 - 1)
 172   {
 173     unsigned int bc;
 174
 175     bc = 0;
 176     for (i = 0; i < PUT_10; i++)
 177       if (0 != (hits[i / 8] & (1 << (i % 8))))
 178         bc++;
 179
 180     crc->end = GNUNET_TIME_absolute_get ();
 181     printf ("%s took %llu ms yielding %u/%u items\n",
 182             "Select random zero-anonymity item",
 183             (unsigned long long) (crc->end.abs_value - crc->start.abs_value),
 184             bc, crc->cnt);
 185     if (crc->cnt > 0)
 186       GAUGER (category, "Select random zero-anonymity item",
 187               (crc->end.abs_value - crc->start.abs_value) / crc->cnt,
 188               "ms/item");
 189     memset (hits, 0, sizeof (hits));
 190     crc->phase++;
 191     crc->cnt = 0;
 192     crc->start = GNUNET_TIME_absolute_get ();
 193   }
 194   GNUNET_SCHEDULER_add_now (&test, crc);
 195   return GNUNET_OK;
 196 }
 197
 198
 199 static int
 200 expiration_get (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
 201                 const void *data, enum GNUNET_BLOCK_Type type,
 202                 uint32_t priority, uint32_t anonymity,
 203                 struct GNUNET_TIME_Absolute expiration, uint64_t uid)
 204 {
 205   struct CpsRunContext *crc = cls;
 206   int i;
 207   const char *cdata = data;
 208
 209   GNUNET_assert (size >= 8);
 210   memcpy (&i, &cdata[4], sizeof (i));
 211   hits[i / 8] |= (1 << (i % 8));
 212   crc->cnt++;
 213   if (PUT_10 <= crc->cnt)
 214   {
 215     unsigned int bc;
 216
 217     bc = 0;
 218     for (i = 0; i < PUT_10; i++)
 219       if (0 != (hits[i / 8] & (1 << (i % 8))))
 220         bc++;
 221
 222     crc->end = GNUNET_TIME_absolute_get ();
 223     printf ("%s took %llu ms yielding %u/%u items\n",
 224             "Selecting and deleting by expiration",
 225             (unsigned long long) (crc->end.abs_value - crc->start.abs_value),
 226             bc, (unsigned int) PUT_10);
 227     if (crc->cnt > 0)
 228       GAUGER (category, "Selecting and deleting by expiration",
 229               (crc->end.abs_value - crc->start.abs_value) / crc->cnt,
 230               "ms/item");
 231     memset (hits, 0, sizeof (hits));
 232     if (++crc->iter == ITERATIONS)
 233       crc->phase++;
 234     else
 235       crc->phase = RP_PUT;
 236     crc->cnt = 0;
 237     crc->start = GNUNET_TIME_absolute_get ();
 238   }
 239   GNUNET_SCHEDULER_add_now (&test, crc);
 240   return GNUNET_NO;
 241 }
 242
 243
 244 static int
 245 replication_get (void *cls, const struct GNUNET_HashCode * key, uint32_t size,
 246                  const void *data, enum GNUNET_BLOCK_Type type,
 247                  uint32_t priority, uint32_t anonymity,
 248                  struct GNUNET_TIME_Absolute expiration, uint64_t uid)
 249 {
 250   struct CpsRunContext *crc = cls;
 251   int i;
 252   const char *cdata = data;
 253
 254   GNUNET_assert (NULL != key);
 255   GNUNET_assert (size >= 8);
 256   memcpy (&i, &cdata[4], sizeof (i));
 257   hits[i / 8] |= (1 << (i % 8));
 258   crc->cnt++;
 259   if (PUT_10 <= crc->cnt)
 260   {
 261     unsigned int bc;
 262
 263     bc = 0;
 264     for (i = 0; i < PUT_10; i++)
 265       if (0 != (hits[i / 8] & (1 << (i % 8))))
 266         bc++;
 267
 268     crc->end = GNUNET_TIME_absolute_get ();
 269     printf ("%s took %llu ms yielding %u/%u items\n",
 270             "Selecting random item for replication",
 271             (unsigned long long) (crc->end.abs_value - crc->start.abs_value),
 272             bc, (unsigned int) PUT_10);
 273     if (crc->cnt > 0)
 274       GAUGER (category, "Selecting random item for replication",
 275               (crc->end.abs_value - crc->start.abs_value) / crc->cnt,
 276               "ms/item");
 277     memset (hits, 0, sizeof (hits));
 278     crc->phase++;
 279     crc->offset = 0;
 280     crc->cnt = 0;
 281     crc->start = GNUNET_TIME_absolute_get ();
 282   }
 283
 284   GNUNET_SCHEDULER_add_now (&test, crc);
 285   return GNUNET_OK;
 286 }
 287
 288
 289 /**
 290  * Function called when the service shuts
 291  * down.  Unloads our datastore plugin.
 292  *
 293  * @param api api to unload
 294  * @param cfg configuration to use
 295  */
 296 static void
 297 unload_plugin (struct GNUNET_DATASTORE_PluginFunctions *api,
 298                const struct GNUNET_CONFIGURATION_Handle *cfg)
 299 {
 300   char *name;
 301   char *libname;
 302
 303   if (GNUNET_OK !=
 304       GNUNET_CONFIGURATION_get_value_string (cfg, "DATASTORE", "DATABASE",
 305                                              &name))
 306   {
 307     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 308                 _("No `%s' specified for `%s' in configuration!\n"), "DATABASE",
 309                 "DATASTORE");
 310     return;
 311   }
 312   GNUNET_asprintf (&libname, "libgnunet_plugin_datastore_%s", name);
 313   GNUNET_break (NULL == GNUNET_PLUGIN_unload (libname, api));
 314   GNUNET_free (libname);
 315   GNUNET_free (name);
 316 }
 317
 318
 319
 320 /**
 321  * Last task run during shutdown.  Disconnects us from
 322  * the transport and core.
 323  */
 324 static void
 325 cleaning_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 326 {
 327   struct CpsRunContext *crc = cls;
 328
 329   unload_plugin (crc->api, crc->cfg);
 330   GNUNET_free (crc);
 331 }
 332
 333
 334 static void
 335 test (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 336 {
 337   struct CpsRunContext *crc = cls;
 338   int j;
 339
 340   if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
 341   {
 342     GNUNET_break (0);
 343     crc->phase = RP_ERROR;
 344   }
 345   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 346               "In phase %d, iteration %u\n", crc->phase, crc->cnt);
 347   switch (crc->phase)
 348   {
 349   case RP_ERROR:
 350     GNUNET_break (0);
 351     crc->api->drop (crc->api->cls);
 352     ok = 1;
 353     GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
 354                                         &cleaning_task, crc);
 355     break;
 356   case RP_PUT:
 357     crc->start = GNUNET_TIME_absolute_get ();
 358     for (j = 0; j < PUT_10; j++)
 359       putValue (crc->api, j, crc->i);
 360     crc->end = GNUNET_TIME_absolute_get ();
 361     {
 362       printf ("%s took %llu ms for %llu items\n", "Storing an item",
 363               (unsigned long long) (crc->end.abs_value - crc->start.abs_value),
 364               PUT_10);
 365       if (PUT_10 > 0)
 366         GAUGER (category, "Storing an item",
 367                 (crc->end.abs_value - crc->start.abs_value) / PUT_10,
 368                 "ms/item");
 369     }
 370     crc->i++;
 371     crc->start = GNUNET_TIME_absolute_get ();
 372     crc->phase++;
 373     GNUNET_SCHEDULER_add_now (&test, crc);
 374     break;
 375   case RP_REP_GET:
 376     crc->api->get_replication (crc->api->cls, &replication_get, crc);
 377     break;
 378   case RP_ZA_GET:
 379     crc->api->get_zero_anonymity (crc->api->cls, crc->offset++, 1,
 380                                   &iterate_zeros, crc);
 381     break;
 382   case RP_EXP_GET:
 383     crc->api->get_expiration (crc->api->cls, &expiration_get, crc);
 384     break;
 385   case RP_DONE:
 386     crc->api->drop (crc->api->cls);
 387     ok = 0;
 388     GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
 389                                         &cleaning_task, crc);
 390     break;
 391   }
 392 }
 393
 394
 395 /**
 396  * Load the datastore plugin.
 397  */
 398 static struct GNUNET_DATASTORE_PluginFunctions *
 399 load_plugin (const struct GNUNET_CONFIGURATION_Handle *cfg)
 400 {
 401   static struct GNUNET_DATASTORE_PluginEnvironment env;
 402   struct GNUNET_DATASTORE_PluginFunctions *ret;
 403   char *name;
 404   char *libname;
 405
 406   if (GNUNET_OK !=
 407       GNUNET_CONFIGURATION_get_value_string (cfg, "DATASTORE", "DATABASE",
 408                                              &name))
 409   {
 410     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 411                 _("No `%s' specified for `%s' in configuration!\n"), "DATABASE",
 412                 "DATASTORE");
 413     return NULL;
 414   }
 415   env.cfg = cfg;
 416   env.duc = &disk_utilization_change_cb;
 417   env.cls = NULL;
 418   GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Loading `%s' datastore plugin\n"),
 419               name);
 420   GNUNET_asprintf (&libname, "libgnunet_plugin_datastore_%s", name);
 421   if (NULL == (ret = GNUNET_PLUGIN_load (libname, &env)))
 422   {
 423     FPRINTF (stderr, "Failed to load plugin `%s'!\n", name);
 424     return NULL;
 425   }
 426   GNUNET_free (libname);
 427   GNUNET_free (name);
 428   return ret;
 429 }
 430
 431
 432 static void
 433 run (void *cls, char *const *args, const char *cfgfile,
 434      const struct GNUNET_CONFIGURATION_Handle *c)
 435 {
 436   struct GNUNET_DATASTORE_PluginFunctions *api;
 437   struct CpsRunContext *crc;
 438
 439   api = load_plugin (c);
 440   if (api == NULL)
 441   {
 442     FPRINTF (stderr,
 443              "%s", "Could not initialize plugin, assuming database not configured. Test not run!\n");
 444     return;
 445   }
 446   crc = GNUNET_malloc (sizeof (struct CpsRunContext));
 447   crc->api = api;
 448   crc->cfg = c;
 449   crc->phase = RP_PUT;
 450   ok = 2;
 451   GNUNET_SCHEDULER_add_now (&test, crc);
 452 }
 453
 454
 455 int
 456 main (int argc, char *argv[])
 457 {
 458   char dir_name[128];
 459   char cfg_name[128];
 460   char *const xargv[] = {
 461     "perf-plugin-datastore",
 462     "-c",
 463     cfg_name,
 464     NULL
 465   };
 466   struct GNUNET_GETOPT_CommandLineOption options[] = {
 467     GNUNET_GETOPT_OPTION_END
 468   };
 469
 470   plugin_name = GNUNET_TESTING_get_testname_from_underscore (argv[0]);
 471   GNUNET_snprintf (dir_name, sizeof (dir_name), "/tmp/perf-gnunet-datastore-%s",
 472                    plugin_name);
 473   GNUNET_DISK_directory_remove (dir_name);
 474   GNUNET_log_setup ("perf-plugin-datastore",
 475                     "WARNING",
 476                     NULL);
 477   GNUNET_snprintf (category, sizeof (category), "DATASTORE-%s", plugin_name);
 478   GNUNET_snprintf (cfg_name, sizeof (cfg_name),
 479                    "perf_plugin_datastore_data_%s.conf", plugin_name);
 480   GNUNET_PROGRAM_run ((sizeof (xargv) / sizeof (char *)) - 1, xargv,
 481                       "perf-plugin-datastore", "nohelp", options, &run, NULL);
 482   if (ok != 0)
 483     FPRINTF (stderr, "Missed some testcases: %u\n", ok);
 484   GNUNET_DISK_directory_remove (dir_name);
 485
 486   return ok;
 487 }
 488
 489 /* end of perf_plugin_datastore.c */