src/namestore/plugin_namestore_sqlite.c

   1  /*
   2   * This file is part of GNUnet
   3   * (C) 2009-2013 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 namestore/plugin_namestore_sqlite.c
  23  * @brief sqlite-based namestore backend
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_namestore_plugin.h"
  29 #include "gnunet_namestore_service.h"
  30 #include "namestore.h"
  31 #include <sqlite3.h>
  32
  33 /**
  34  * After how many ms "busy" should a DB operation fail for good?  A
  35  * low value makes sure that we are more responsive to requests
  36  * (especially PUTs).  A high value guarantees a higher success rate
  37  * (SELECTs in iterate can take several seconds despite LIMIT=1).
  38  *
  39  * The default value of 1s should ensure that users do not experience
  40  * huge latencies while at the same time allowing operations to
  41  * succeed with reasonable probability.
  42  */
  43 #define BUSY_TIMEOUT_MS 1000
  44
  45
  46 /**
  47  * Log an error message at log-level 'level' that indicates
  48  * a failure of the command 'cmd' on file 'filename'
  49  * with the message given by strerror(errno).
  50  */
  51 #define LOG_SQLITE(db, level, cmd) do { GNUNET_log_from (level, "namestore-sqlite", _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db->dbh)); } while(0)
  52
  53 #define LOG(kind,...) GNUNET_log_from (kind, "namestore-sqlite", __VA_ARGS__)
  54
  55
  56 /**
  57  * Context for all functions in this plugin.
  58  */
  59 struct Plugin
  60 {
  61
  62   const struct GNUNET_CONFIGURATION_Handle *cfg;
  63
  64   /**
  65    * Database filename.
  66    */
  67   char *fn;
  68
  69   /**
  70    * Native SQLite database handle.
  71    */
  72   sqlite3 *dbh;
  73
  74   /**
  75    * Precompiled SQL for caching a block
  76    */
  77   sqlite3_stmt *cache_block;
  78
  79   /**
  80    * Precompiled SQL for looking up a block
  81    */
  82   sqlite3_stmt *lookup_block;
  83
  84   /**
  85    * Precompiled SQL for removing expired blocks
  86    */
  87   sqlite3_stmt *expire_blocks;
  88
  89   /**
  90    * Precompiled SQL to store records.
  91    */
  92   sqlite3_stmt *store_records;
  93
  94   /**
  95    * Precompiled SQL to deltete existing records.
  96    */
  97   sqlite3_stmt *delete_records;
  98
  99   /**
 100    * Precompiled SQL for iterate records within a zone.
 101    */
 102   sqlite3_stmt *iterate_zone;
 103
 104   /**
 105    * Precompiled SQL for iterate all records within all zones.
 106    */
 107   sqlite3_stmt *iterate_all_zones;
 108
 109   /**
 110    * Precompiled SQL to for reverse lookup based on PKEY.
 111    */
 112   sqlite3_stmt *zone_to_name;
 113
 114 };
 115
 116
 117 /**
 118  * @brief Prepare a SQL statement
 119  *
 120  * @param dbh handle to the database
 121  * @param zSql SQL statement, UTF-8 encoded
 122  * @param ppStmt set to the prepared statement
 123  * @return 0 on success
 124  */
 125 static int
 126 sq_prepare (sqlite3 * dbh, const char *zSql, sqlite3_stmt ** ppStmt)
 127 {
 128   char *dummy;
 129   int result;
 130
 131   result =
 132       sqlite3_prepare_v2 (dbh, zSql, strlen (zSql), ppStmt,
 133                           (const char **) &dummy);
 134   LOG (GNUNET_ERROR_TYPE_DEBUG,
 135        "Prepared `%s' / %p: %d\n", zSql, *ppStmt, result);
 136   return result;
 137 }
 138
 139
 140 /**
 141  * Create our database indices.
 142  *
 143  * @param dbh handle to the database
 144  */
 145 static void
 146 create_indices (sqlite3 * dbh)
 147 {
 148   /* create indices */
 149   if ( (SQLITE_OK !=
 150         sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS ir_query_hash ON ns096blocks (query,expiration_time)",
 151                       NULL, NULL, NULL)) ||
 152        (SQLITE_OK !=
 153         sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS ir_block_expiration ON ns096blocks (expiration_time)",
 154                       NULL, NULL, NULL)) ||
 155        (SQLITE_OK !=
 156         sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS ir_pkey_reverse ON ns096records (zone_private_key,pkey_hash)",
 157                       NULL, NULL, NULL)) ||
 158        (SQLITE_OK !=
 159         sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS ir_pkey_iter ON ns096records (zone_private_key,rvalue)",
 160                       NULL, NULL, NULL)) ||
 161        (SQLITE_OK !=
 162         sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS it_iter ON ns096records (rvalue)",
 163                       NULL, NULL, NULL)) )
 164     LOG (GNUNET_ERROR_TYPE_ERROR,
 165          "Failed to create indices: %s\n", sqlite3_errmsg (dbh));
 166 }
 167
 168
 169 #if 0
 170 #define CHECK(a) GNUNET_break(a)
 171 #define ENULL NULL
 172 #else
 173 #define ENULL &e
 174 #define ENULL_DEFINED 1
 175 #define CHECK(a) if (! a) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "%s\n", e); sqlite3_free(e); }
 176 #endif
 177
 178
 179 /**
 180  * Initialize the database connections and associated
 181  * data structures (create tables and indices
 182  * as needed as well).
 183  *
 184  * @param plugin the plugin context (state for this module)
 185  * @return #GNUNET_OK on success
 186  */
 187 static int
 188 database_setup (struct Plugin *plugin)
 189 {
 190   sqlite3_stmt *stmt;
 191   char *afsdir;
 192 #if ENULL_DEFINED
 193   char *e;
 194 #endif
 195
 196   if (GNUNET_OK !=
 197       GNUNET_CONFIGURATION_get_value_filename (plugin->cfg, "namestore-sqlite",
 198                                                "FILENAME", &afsdir))
 199   {
 200     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
 201                                "namestore-sqlite", "FILENAME");
 202     return GNUNET_SYSERR;
 203   }
 204   if (GNUNET_OK != GNUNET_DISK_file_test (afsdir))
 205   {
 206     if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (afsdir))
 207     {
 208       GNUNET_break (0);
 209       GNUNET_free (afsdir);
 210       return GNUNET_SYSERR;
 211     }
 212   }
 213   /* afsdir should be UTF-8-encoded. If it isn't, it's a bug */
 214   plugin->fn = afsdir;
 215
 216   /* Open database and precompile statements */
 217   if (sqlite3_open (plugin->fn, &plugin->dbh) != SQLITE_OK)
 218   {
 219     LOG (GNUNET_ERROR_TYPE_ERROR,
 220          _("Unable to initialize SQLite: %s.\n"),
 221          sqlite3_errmsg (plugin->dbh));
 222     return GNUNET_SYSERR;
 223   }
 224   CHECK (SQLITE_OK ==
 225          sqlite3_exec (plugin->dbh, "PRAGMA temp_store=MEMORY", NULL, NULL,
 226                        ENULL));
 227   CHECK (SQLITE_OK ==
 228          sqlite3_exec (plugin->dbh, "PRAGMA synchronous=NORMAL", NULL, NULL,
 229                        ENULL));
 230   CHECK (SQLITE_OK ==
 231          sqlite3_exec (plugin->dbh, "PRAGMA legacy_file_format=OFF", NULL, NULL,
 232                        ENULL));
 233   CHECK (SQLITE_OK ==
 234          sqlite3_exec (plugin->dbh, "PRAGMA auto_vacuum=INCREMENTAL", NULL,
 235                        NULL, ENULL));
 236   CHECK (SQLITE_OK ==
 237          sqlite3_exec (plugin->dbh, "PRAGMA encoding=\"UTF-8\"", NULL,
 238                        NULL, ENULL));
 239   CHECK (SQLITE_OK ==
 240          sqlite3_exec (plugin->dbh, "PRAGMA locking_mode=EXCLUSIVE", NULL, NULL,
 241                        ENULL));
 242   CHECK (SQLITE_OK ==
 243          sqlite3_exec (plugin->dbh, "PRAGMA count_changes=OFF", NULL, NULL,
 244                        ENULL));
 245   CHECK (SQLITE_OK ==
 246          sqlite3_exec (plugin->dbh, "PRAGMA page_size=4092", NULL, NULL,
 247                        ENULL));
 248
 249   CHECK (SQLITE_OK == sqlite3_busy_timeout (plugin->dbh, BUSY_TIMEOUT_MS));
 250
 251
 252   /* Create tables */
 253   CHECK (SQLITE_OK ==
 254          sq_prepare (plugin->dbh,
 255                      "SELECT 1 FROM sqlite_master WHERE tbl_name = 'ns096blocks'",
 256                      &stmt));
 257   if ((sqlite3_step (stmt) == SQLITE_DONE) &&
 258       (sqlite3_exec
 259        (plugin->dbh,
 260         "CREATE TABLE ns096blocks ("
 261         " query BLOB NOT NULL DEFAULT '',"
 262         " block BLOB NOT NULL DEFAULT '',"
 263         " expiration_time INT8 NOT NULL DEFAULT 0"
 264         ")",
 265         NULL, NULL, NULL) != SQLITE_OK))
 266   {
 267     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite3_exec");
 268     sqlite3_finalize (stmt);
 269     return GNUNET_SYSERR;
 270   }
 271   sqlite3_finalize (stmt);
 272
 273   CHECK (SQLITE_OK ==
 274          sq_prepare (plugin->dbh,
 275                      "SELECT 1 FROM sqlite_master WHERE tbl_name = 'ns096records'",
 276                      &stmt));
 277   if ((sqlite3_step (stmt) == SQLITE_DONE) &&
 278       (sqlite3_exec
 279        (plugin->dbh,
 280         "CREATE TABLE ns096records ("
 281         " zone_private_key BLOB NOT NULL DEFAULT '',"
 282         " pkey_hash BLOB,"
 283         " rvalue INT8 NOT NULL DEFAULT '',"
 284         " record_count INT NOT NULL DEFAULT 0,"
 285         " record_data BLOB NOT NULL DEFAULT '',"
 286         " label TEXT NOT NULL DEFAULT ''"
 287         ")",
 288         NULL, NULL, NULL) != SQLITE_OK))
 289   {
 290     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite3_exec");
 291     sqlite3_finalize (stmt);
 292     return GNUNET_SYSERR;
 293   }
 294   sqlite3_finalize (stmt);
 295
 296   create_indices (plugin->dbh);
 297
 298   if ((sq_prepare
 299        (plugin->dbh,
 300         "INSERT INTO ns096blocks (query,block,expiration_time) VALUES (?, ?, ?)",
 301         &plugin->cache_block) != SQLITE_OK) ||
 302       (sq_prepare
 303        (plugin->dbh,
 304         "DELETE FROM ns096blocks WHERE expiration_time<?",
 305         &plugin->expire_blocks) != SQLITE_OK) ||
 306       (sq_prepare
 307        (plugin->dbh,
 308         "SELECT block FROM ns096blocks WHERE query=? ORDER BY expiration_time DESC LIMIT 1",
 309         &plugin->lookup_block) != SQLITE_OK) ||
 310       (sq_prepare
 311        (plugin->dbh,
 312         "INSERT INTO ns096records (zone_private_key, pkey_hash, rvalue, record_count, record_data, label)"
 313         " VALUES (?, ?, ?, ?, ?, ?)",
 314         &plugin->store_records) != SQLITE_OK) ||
 315       (sq_prepare
 316        (plugin->dbh,
 317         "DELETE FROM ns096records WHERE zone_private_key=? AND label=?",
 318         &plugin->delete_records) != SQLITE_OK) ||
 319       (sq_prepare
 320        (plugin->dbh,
 321         "SELECT record_count,record_data,label"
 322         " FROM ns096records WHERE zone_private_key=? AND pkey_hash=?",
 323         &plugin->zone_to_name) != SQLITE_OK) ||
 324       (sq_prepare
 325        (plugin->dbh,
 326         "SELECT record_count,record_data,label"
 327         " FROM ns096records WHERE zone_private_key=? ORDER BY rvalue LIMIT 1 OFFSET ?",
 328         &plugin->iterate_zone) != SQLITE_OK) ||
 329       (sq_prepare
 330        (plugin->dbh,
 331         "SELECT record_count,record_data,label,zone_private_key"
 332         " FROM ns096records ORDER BY rvalue LIMIT 1 OFFSET ?",
 333         &plugin->iterate_all_zones) != SQLITE_OK)
 334       )
 335   {
 336     LOG_SQLITE (plugin,GNUNET_ERROR_TYPE_ERROR, "precompiling");
 337     return GNUNET_SYSERR;
 338   }
 339   return GNUNET_OK;
 340 }
 341
 342
 343 /**
 344  * Shutdown database connection and associate data
 345  * structures.
 346  * @param plugin the plugin context (state for this module)
 347  */
 348 static void
 349 database_shutdown (struct Plugin *plugin)
 350 {
 351   int result;
 352   sqlite3_stmt *stmt;
 353
 354   if (NULL != plugin->cache_block)
 355     sqlite3_finalize (plugin->cache_block);
 356   if (NULL != plugin->lookup_block)
 357     sqlite3_finalize (plugin->lookup_block);
 358   if (NULL != plugin->expire_blocks)
 359     sqlite3_finalize (plugin->expire_blocks);
 360   if (NULL != plugin->store_records)
 361     sqlite3_finalize (plugin->store_records);
 362   if (NULL != plugin->delete_records)
 363     sqlite3_finalize (plugin->delete_records);
 364   if (NULL != plugin->iterate_zone)
 365     sqlite3_finalize (plugin->iterate_zone);
 366   if (NULL != plugin->iterate_all_zones)
 367     sqlite3_finalize (plugin->iterate_all_zones);
 368   if (NULL != plugin->zone_to_name)
 369     sqlite3_finalize (plugin->zone_to_name);
 370   result = sqlite3_close (plugin->dbh);
 371   if (result == SQLITE_BUSY)
 372   {
 373     LOG (GNUNET_ERROR_TYPE_WARNING,
 374          _("Tried to close sqlite without finalizing all prepared statements.\n"));
 375     stmt = sqlite3_next_stmt (plugin->dbh, NULL);
 376     while (stmt != NULL)
 377     {
 378       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
 379                        "Closing statement %p\n", stmt);
 380       result = sqlite3_finalize (stmt);
 381       if (result != SQLITE_OK)
 382         GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, "sqlite",
 383                          "Failed to close statement %p: %d\n", stmt, result);
 384       stmt = sqlite3_next_stmt (plugin->dbh, NULL);
 385     }
 386     result = sqlite3_close (plugin->dbh);
 387   }
 388   if (SQLITE_OK != result)
 389     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite3_close");
 390
 391   GNUNET_free_non_null (plugin->fn);
 392 }
 393
 394
 395 /**
 396  * Removes any expired block.
 397  *
 398  * @param plugin the plugin
 399  */
 400 static void
 401 namestore_sqlite_expire_blocks (struct Plugin *plugin)
 402 {
 403   struct GNUNET_TIME_Absolute now;
 404   int n;
 405
 406   now = GNUNET_TIME_absolute_get ();
 407   if (SQLITE_OK != sqlite3_bind_int64 (plugin->expire_blocks,
 408                                        1, now.abs_value_us))
 409   {
 410     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 411                 "sqlite3_bind_XXXX");
 412     if (SQLITE_OK != sqlite3_reset (plugin->expire_blocks))
 413       LOG_SQLITE (plugin,
 414                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 415                   "sqlite3_reset");
 416     return;
 417   }
 418   n = sqlite3_step (plugin->expire_blocks);
 419   if (SQLITE_OK != sqlite3_reset (plugin->expire_blocks))
 420     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 421                 "sqlite3_reset");
 422   switch (n)
 423   {
 424   case SQLITE_DONE:
 425     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite", "Records expired\n");
 426     return;
 427   case SQLITE_BUSY:
 428     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
 429                 "sqlite3_step");
 430     return;
 431   default:
 432     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 433                 "sqlite3_step");
 434     return;
 435   }
 436 }
 437
 438
 439 /**
 440  * Cache a block in the datastore.
 441  *
 442  * @param cls closure (internal context for the plugin)
 443  * @param block block to cache
 444  * @return #GNUNET_OK on success, else #GNUNET_SYSERR
 445  */
 446 static int
 447 namestore_sqlite_cache_block (void *cls,
 448                               const struct GNUNET_NAMESTORE_Block *block)
 449 {
 450   struct Plugin *plugin = cls;
 451   struct GNUNET_HashCode query;
 452   struct GNUNET_TIME_Absolute expiration;
 453   int64_t dval;
 454   size_t block_size;
 455   int n;
 456
 457   namestore_sqlite_expire_blocks (plugin);
 458   GNUNET_CRYPTO_hash (&block->derived_key,
 459                       sizeof (struct GNUNET_CRYPTO_EccPublicSignKey),
 460                       &query);
 461   expiration = GNUNET_TIME_absolute_ntoh (block->expiration_time);
 462   dval = (int64_t) expiration.abs_value_us;
 463   if (dval < 0)
 464     dval = INT64_MAX;
 465   block_size = ntohl (block->purpose.size) +
 466     sizeof (struct GNUNET_CRYPTO_EccPublicSignKey) +
 467     sizeof (struct GNUNET_CRYPTO_EccSignature);
 468   if (block_size > 64 * 65536)
 469   {
 470     GNUNET_break (0);
 471     return GNUNET_SYSERR;
 472   }
 473   if ((SQLITE_OK !=
 474        sqlite3_bind_blob (plugin->cache_block, 1,
 475                           &query, sizeof (struct GNUNET_HashCode),
 476                           SQLITE_STATIC)) ||
 477       (SQLITE_OK !=
 478        sqlite3_bind_blob (plugin->cache_block, 2,
 479                           block, block_size,
 480                           SQLITE_STATIC)) ||
 481       (SQLITE_OK !=
 482        sqlite3_bind_int64 (plugin->cache_block, 3,
 483                            dval)))
 484   {
 485     LOG_SQLITE (plugin,
 486                 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 487                 "sqlite3_bind_XXXX");
 488     if (SQLITE_OK != sqlite3_reset (plugin->cache_block))
 489       LOG_SQLITE (plugin,
 490                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 491                   "sqlite3_reset");
 492     return GNUNET_SYSERR;
 493
 494   }
 495   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 496               "Caching block under derived key `%s'\n",
 497               GNUNET_h2s_full (&query));
 498   n = sqlite3_step (plugin->cache_block);
 499   if (SQLITE_OK != sqlite3_reset (plugin->cache_block))
 500     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 501                 "sqlite3_reset");
 502   switch (n)
 503   {
 504   case SQLITE_DONE:
 505     LOG (GNUNET_ERROR_TYPE_DEBUG,
 506          "Record stored\n");
 507     return GNUNET_OK;
 508   case SQLITE_BUSY:
 509     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
 510                 "sqlite3_step");
 511     return GNUNET_NO;
 512   default:
 513     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 514                 "sqlite3_step");
 515     return GNUNET_SYSERR;
 516   }
 517 }
 518
 519
 520 /**
 521  * Get the block for a particular zone and label in the
 522  * datastore.  Will return at most one result to the iterator.
 523  *
 524  * @param cls closure (internal context for the plugin)
 525  * @param query hash of public key derived from the zone and the label
 526  * @param iter function to call with the result
 527  * @param iter_cls closure for @a iter
 528  * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
 529  */
 530 static int
 531 namestore_sqlite_lookup_block (void *cls,
 532                                const struct GNUNET_HashCode *query,
 533                                GNUNET_NAMESTORE_BlockCallback iter, void *iter_cls)
 534 {
 535   struct Plugin *plugin = cls;
 536   int ret;
 537   int sret;
 538   size_t block_size;
 539   const struct GNUNET_NAMESTORE_Block *block;
 540
 541   if (SQLITE_OK != sqlite3_bind_blob (plugin->lookup_block, 1,
 542                                       query, sizeof (struct GNUNET_HashCode),
 543                                       SQLITE_STATIC))
 544   {
 545     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 546                 "sqlite3_bind_XXXX");
 547     if (SQLITE_OK != sqlite3_reset (plugin->lookup_block))
 548       LOG_SQLITE (plugin,
 549                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 550                   "sqlite3_reset");
 551     return GNUNET_SYSERR;
 552   }
 553   ret = GNUNET_NO;
 554   if (SQLITE_ROW == (sret = sqlite3_step (plugin->lookup_block)))
 555   {
 556     block = sqlite3_column_blob (plugin->lookup_block, 0);
 557     block_size = sqlite3_column_bytes (plugin->lookup_block, 0);
 558     if ( (block_size < sizeof (struct GNUNET_NAMESTORE_Block)) ||
 559          (ntohl (block->purpose.size) +
 560           sizeof (struct GNUNET_CRYPTO_EccPublicSignKey) +
 561           sizeof (struct GNUNET_CRYPTO_EccSignature) != block_size) )
 562     {
 563       GNUNET_break (0);
 564       ret = GNUNET_SYSERR;
 565     }
 566     else
 567     {
 568       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 569                   "Found block under derived key `%s'\n",
 570                   GNUNET_h2s_full (query));
 571       iter (iter_cls, block);
 572       ret = GNUNET_YES;
 573     }
 574   }
 575   else
 576   {
 577     if (SQLITE_DONE != sret)
 578     {
 579       LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite_step");
 580       ret = GNUNET_SYSERR;
 581     }
 582     else
 583     {
 584       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 585                   "No block found under derived key `%s'\n",
 586                   GNUNET_h2s_full (query));
 587     }
 588   }
 589   if (SQLITE_OK != sqlite3_reset (plugin->lookup_block))
 590     LOG_SQLITE (plugin,
 591                 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 592                 "sqlite3_reset");
 593   return ret;
 594 }
 595
 596
 597 /**
 598  * Store a record in the datastore.  Removes any existing record in the
 599  * same zone with the same name.
 600  *
 601  * @param cls closure (internal context for the plugin)
 602  * @param zone_key private key of the zone
 603  * @param label name that is being mapped (at most 255 characters long)
 604  * @param rd_count number of entries in @a rd array
 605  * @param rd array of records with data to store
 606  * @return #GNUNET_OK on success, else #GNUNET_SYSERR
 607  */
 608 static int
 609 namestore_sqlite_store_records (void *cls,
 610                                 const struct GNUNET_CRYPTO_EccPrivateKey *zone_key,
 611                                 const char *label,
 612                                 unsigned int rd_count,
 613                                 const struct GNUNET_NAMESTORE_RecordData *rd)
 614 {
 615   struct Plugin *plugin = cls;
 616   int n;
 617   struct GNUNET_HashCode pkey_hash;
 618   uint64_t rvalue;
 619   size_t data_size;
 620   unsigned int i;
 621
 622   memset (&pkey_hash, 0, sizeof (pkey_hash));
 623   for (i=0;i<rd_count;i++)
 624     if (GNUNET_NAMESTORE_TYPE_PKEY == rd[i].record_type)
 625     {
 626       GNUNET_break (sizeof (struct GNUNET_CRYPTO_EccPublicSignKey) == rd[i].data_size);
 627       GNUNET_CRYPTO_hash (rd[i].data,
 628                           rd[i].data_size,
 629                           &pkey_hash);
 630       break;
 631     }
 632   rvalue = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK, UINT64_MAX);
 633   data_size = GNUNET_NAMESTORE_records_get_size (rd_count, rd);
 634   if (data_size > 64 * 65536)
 635   {
 636     GNUNET_break (0);
 637     return GNUNET_SYSERR;
 638   }
 639   {
 640     char data[data_size];
 641
 642     if (data_size != GNUNET_NAMESTORE_records_serialize (rd_count, rd,
 643                                                          data_size, data))
 644     {
 645       GNUNET_break (0);
 646       return GNUNET_SYSERR;
 647     }
 648
 649     /* First delete 'old' records */
 650     if ((SQLITE_OK != sqlite3_bind_blob (plugin->delete_records, 1,
 651                                          zone_key, sizeof (struct GNUNET_CRYPTO_EccPrivateKey), SQLITE_STATIC)) ||
 652         (SQLITE_OK != sqlite3_bind_text (plugin->delete_records, 2, label, -1, SQLITE_STATIC)))
 653     {
 654       LOG_SQLITE (plugin,
 655                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 656                   "sqlite3_bind_XXXX");
 657       if (SQLITE_OK != sqlite3_reset (plugin->delete_records))
 658         LOG_SQLITE (plugin,
 659                     GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 660                     "sqlite3_reset");
 661       return GNUNET_SYSERR;
 662
 663     }
 664     n = sqlite3_step (plugin->delete_records);
 665     if (SQLITE_OK != sqlite3_reset (plugin->delete_records))
 666       LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 667                   "sqlite3_reset");
 668
 669     if (0 != rd_count)
 670     {
 671       if ((SQLITE_OK != sqlite3_bind_blob (plugin->store_records, 1,
 672                                            zone_key, sizeof (struct GNUNET_CRYPTO_EccPrivateKey), SQLITE_STATIC)) ||
 673           (SQLITE_OK != sqlite3_bind_blob (plugin->store_records, 2,
 674                                            &pkey_hash, sizeof (struct GNUNET_HashCode), SQLITE_STATIC)) ||
 675           (SQLITE_OK != sqlite3_bind_int64 (plugin->store_records, 3, rvalue)) ||
 676           (SQLITE_OK != sqlite3_bind_int (plugin->store_records, 4, rd_count)) ||
 677           (SQLITE_OK != sqlite3_bind_blob (plugin->store_records, 5, data, data_size, SQLITE_STATIC)) ||
 678           (SQLITE_OK != sqlite3_bind_text (plugin->store_records, 6, label, -1, SQLITE_STATIC)))
 679       {
 680         LOG_SQLITE (plugin,
 681                     GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 682                     "sqlite3_bind_XXXX");
 683         if (SQLITE_OK != sqlite3_reset (plugin->store_records))
 684           LOG_SQLITE (plugin,
 685                       GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 686                       "sqlite3_reset");
 687         return GNUNET_SYSERR;
 688       }
 689       n = sqlite3_step (plugin->store_records);
 690       if (SQLITE_OK != sqlite3_reset (plugin->store_records))
 691         LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 692                     "sqlite3_reset");
 693     }
 694   }
 695   switch (n)
 696   {
 697   case SQLITE_DONE:
 698     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite", "Record stored\n");
 699     return GNUNET_OK;
 700   case SQLITE_BUSY:
 701     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
 702                 "sqlite3_step");
 703     return GNUNET_NO;
 704   default:
 705     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 706                 "sqlite3_step");
 707     return GNUNET_SYSERR;
 708   }
 709 }
 710
 711
 712 /**
 713  * The given 'sqlite' statement has been prepared to be run.
 714  * It will return a record which should be given to the iterator.
 715  * Runs the statement and parses the returned record.
 716  *
 717  * @param plugin plugin context
 718  * @param stmt to run (and then clean up)
 719  * @param zone_key private key of the zone
 720  * @param iter iterator to call with the result
 721  * @param iter_cls closure for @a iter
 722  * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
 723  */
 724 static int
 725 get_record_and_call_iterator (struct Plugin *plugin,
 726                               sqlite3_stmt *stmt,
 727                               const struct GNUNET_CRYPTO_EccPrivateKey *zone_key,
 728                               GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
 729 {
 730   unsigned int record_count;
 731   size_t data_size;
 732   const char *data;
 733   const char *label;
 734   int ret;
 735   int sret;
 736
 737   ret = GNUNET_NO;
 738   if (SQLITE_ROW == (sret = sqlite3_step (stmt)))
 739   {
 740     record_count = sqlite3_column_int (stmt, 0);
 741     data_size = sqlite3_column_bytes (stmt, 1);
 742     data = sqlite3_column_blob (stmt, 1);
 743     label = (const char*) sqlite3_column_text (stmt, 2);
 744     if (NULL == zone_key)
 745     {
 746       /* must be "iterate_all_zones", got one extra return value */
 747       if (sizeof (struct GNUNET_CRYPTO_EccPrivateKey) !=
 748           sqlite3_column_bytes (stmt, 3))
 749       {
 750         GNUNET_break (0);
 751         ret = GNUNET_SYSERR;
 752       }
 753       else
 754       {
 755         zone_key = sqlite3_column_blob (stmt, 3);
 756       }
 757     }
 758     if (record_count > 64 * 1024)
 759     {
 760       /* sanity check, don't stack allocate far too much just
 761          because database might contain a large value here */
 762       GNUNET_break (0);
 763       ret = GNUNET_SYSERR;
 764     }
 765     else
 766     {
 767       struct GNUNET_NAMESTORE_RecordData rd[record_count];
 768
 769       if (GNUNET_OK !=
 770           GNUNET_NAMESTORE_records_deserialize (data_size, data,
 771                                                 record_count, rd))
 772       {
 773         GNUNET_break (0);
 774         ret = GNUNET_SYSERR;
 775       }
 776       else if (NULL != zone_key)
 777       {
 778         if (NULL != iter)
 779                 iter (iter_cls, zone_key, label, record_count, rd);
 780         ret = GNUNET_YES;
 781       }
 782     }
 783   }
 784   else
 785   {
 786     if (SQLITE_DONE != sret)
 787       LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite_step");
 788   }
 789   if (SQLITE_OK != sqlite3_reset (stmt))
 790     LOG_SQLITE (plugin,
 791                 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 792                 "sqlite3_reset");
 793   return ret;
 794 }
 795
 796
 797 /**
 798  * Iterate over the results for a particular key and zone in the
 799  * datastore.  Will return at most one result to the iterator.
 800  *
 801  * @param cls closure (internal context for the plugin)
 802  * @param zone hash of public key of the zone, NULL to iterate over all zones
 803  * @param offset offset in the list of all matching records
 804  * @param iter function to call with the result
 805  * @param iter_cls closure for @a iter
 806  * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
 807  */
 808 static int
 809 namestore_sqlite_iterate_records (void *cls,
 810                                   const struct GNUNET_CRYPTO_EccPrivateKey *zone,
 811                                   uint64_t offset,
 812                                   GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
 813 {
 814   struct Plugin *plugin = cls;
 815   sqlite3_stmt *stmt;
 816   int err;
 817
 818   if (NULL == zone)
 819   {
 820     stmt = plugin->iterate_all_zones;
 821     err = (SQLITE_OK != sqlite3_bind_int64 (stmt, 1,
 822                                             offset));
 823   }
 824   else
 825   {
 826     stmt = plugin->iterate_zone;
 827     err = ( (SQLITE_OK != sqlite3_bind_blob (stmt, 1,
 828                                              zone, sizeof (struct GNUNET_CRYPTO_EccPrivateKey),
 829                                              SQLITE_STATIC)) ||
 830             (SQLITE_OK != sqlite3_bind_int64 (stmt, 2,
 831                                               offset)) );
 832   }
 833   if (err)
 834   {
 835     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 836                 "sqlite3_bind_XXXX");
 837     if (SQLITE_OK != sqlite3_reset (stmt))
 838       LOG_SQLITE (plugin,
 839                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 840                   "sqlite3_reset");
 841     return GNUNET_SYSERR;
 842   }
 843   return get_record_and_call_iterator (plugin, stmt, zone, iter, iter_cls);
 844 }
 845
 846
 847 /**
 848  * Look for an existing PKEY delegation record for a given public key.
 849  * Returns at most one result to the iterator.
 850  *
 851  * @param cls closure (internal context for the plugin)
 852  * @param zone private key of the zone to look up in, never NULL
 853  * @param value_zone public key of the target zone (value), never NULL
 854  * @param iter function to call with the result
 855  * @param iter_cls closure for @a iter
 856  * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
 857  */
 858 static int
 859 namestore_sqlite_zone_to_name (void *cls,
 860                                const struct GNUNET_CRYPTO_EccPrivateKey *zone,
 861                                const struct GNUNET_CRYPTO_EccPublicSignKey *value_zone,
 862                                GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
 863 {
 864   struct Plugin *plugin = cls;
 865   sqlite3_stmt *stmt;
 866
 867   stmt = plugin->zone_to_name;
 868   if ( (SQLITE_OK != sqlite3_bind_blob (stmt, 1,
 869                                         zone, sizeof (struct GNUNET_CRYPTO_EccPrivateKey),
 870                                         SQLITE_STATIC)) ||
 871        (SQLITE_OK != sqlite3_bind_blob (stmt, 2,
 872                                         value_zone, sizeof (struct GNUNET_CRYPTO_EccPublicSignKey),
 873                                         SQLITE_STATIC)) )
 874   {
 875     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 876                 "sqlite3_bind_XXXX");
 877     if (SQLITE_OK != sqlite3_reset (stmt))
 878       LOG_SQLITE (plugin,
 879                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 880                   "sqlite3_reset");
 881     return GNUNET_SYSERR;
 882   }
 883   return get_record_and_call_iterator (plugin, stmt, zone, iter, iter_cls);
 884 }
 885
 886
 887 /**
 888  * Entry point for the plugin.
 889  *
 890  * @param cls the "struct GNUNET_NAMESTORE_PluginEnvironment*"
 891  * @return NULL on error, otherwise the plugin context
 892  */
 893 void *
 894 libgnunet_plugin_namestore_sqlite_init (void *cls)
 895 {
 896   static struct Plugin plugin;
 897   const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
 898   struct GNUNET_NAMESTORE_PluginFunctions *api;
 899
 900   if (NULL != plugin.cfg)
 901     return NULL;                /* can only initialize once! */
 902   memset (&plugin, 0, sizeof (struct Plugin));
 903   plugin.cfg = cfg;
 904   if (GNUNET_OK != database_setup (&plugin))
 905   {
 906     database_shutdown (&plugin);
 907     return NULL;
 908   }
 909   api = GNUNET_new (struct GNUNET_NAMESTORE_PluginFunctions);
 910   api->cls = &plugin;
 911   api->cache_block = &namestore_sqlite_cache_block;
 912   api->lookup_block = &namestore_sqlite_lookup_block;
 913   api->store_records = &namestore_sqlite_store_records;
 914   api->iterate_records = &namestore_sqlite_iterate_records;
 915   api->zone_to_name = &namestore_sqlite_zone_to_name;
 916   LOG (GNUNET_ERROR_TYPE_INFO,
 917        _("Sqlite database running\n"));
 918   return api;
 919 }
 920
 921
 922 /**
 923  * Exit point from the plugin.
 924  *
 925  * @param cls the plugin context (as returned by "init")
 926  * @return always NULL
 927  */
 928 void *
 929 libgnunet_plugin_namestore_sqlite_done (void *cls)
 930 {
 931   struct GNUNET_NAMESTORE_PluginFunctions *api = cls;
 932   struct Plugin *plugin = api->cls;
 933
 934   database_shutdown (plugin);
 935   plugin->cfg = NULL;
 936   GNUNET_free (api);
 937   LOG (GNUNET_ERROR_TYPE_DEBUG,
 938        "sqlite plugin is finished\n");
 939   return NULL;
 940 }
 941
 942 /* end of plugin_namestore_sqlite.c */