src/datastore/plugin_datastore_sqlite.c

   1  /*
   2      This file is part of GNUnet
   3      (C) 2009 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 2, 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 datastore/plugin_datastore_sqlite.c
  23  * @brief sqlite-based datastore backend
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_statistics_service.h"
  29 #include "plugin_datastore.h"
  30 #include <sqlite3.h>
  31
  32 #define DEBUG_SQLITE GNUNET_YES
  33
  34 /**
  35  * After how many payload-changing operations
  36  * do we sync our statistics?
  37  */
  38 #define MAX_STAT_SYNC_LAG 50
  39
  40 #define QUOTA_STAT_NAME gettext_noop ("file-sharing datastore utilization (in bytes)")
  41
  42
  43 /**
  44  * Die with an error message that indicates
  45  * a failure of the command 'cmd' with the message given
  46  * by strerror(errno).
  47  */
  48 #define DIE_SQLITE(db, cmd) do { GNUNET_log_from(GNUNET_ERROR_TYPE_ERROR, "sqlite", _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db->dbh)); abort(); } while(0)
  49
  50 /**
  51  * Log an error message at log-level 'level' that indicates
  52  * a failure of the command 'cmd' on file 'filename'
  53  * with the message given by strerror(errno).
  54  */
  55 #define LOG_SQLITE(db, msg, level, cmd) do { GNUNET_log_from (level, "sqlite", _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db->dbh)); if (msg != NULL) GNUNET_asprintf(msg, _("`%s' failed with error: %s\n"), cmd, sqlite3_errmsg(db->dbh)); } while(0)
  56
  57 #define SELECT_IT_LOW_PRIORITY_1 \
  58   "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (prio = ? AND hash > ?) "\
  59   "ORDER BY hash ASC LIMIT 1"
  60
  61 #define SELECT_IT_LOW_PRIORITY_2 \
  62   "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (prio > ?) "\
  63   "ORDER BY prio ASC, hash ASC LIMIT 1"
  64
  65 #define SELECT_IT_NON_ANONYMOUS_1 \
  66   "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (prio = ? AND hash < ? AND anonLevel = 0 AND expire > %llu) "\
  67   " ORDER BY hash DESC LIMIT 1"
  68
  69 #define SELECT_IT_NON_ANONYMOUS_2 \
  70   "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (prio < ? AND anonLevel = 0 AND expire > %llu)"\
  71   " ORDER BY prio DESC, hash DESC LIMIT 1"
  72
  73 #define SELECT_IT_EXPIRATION_TIME_1 \
  74   "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (expire = ? AND hash > ?) "\
  75   " ORDER BY hash ASC LIMIT 1"
  76
  77 #define SELECT_IT_EXPIRATION_TIME_2 \
  78   "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (expire > ?) "\
  79   " ORDER BY expire ASC, hash ASC LIMIT 1"
  80
  81 #define SELECT_IT_MIGRATION_ORDER_1 \
  82   "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (expire = ? AND hash < ?) "\
  83   " ORDER BY hash DESC LIMIT 1"
  84
  85 #define SELECT_IT_MIGRATION_ORDER_2 \
  86   "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (expire < ? AND expire > %llu) "\
  87   " ORDER BY expire DESC, hash DESC LIMIT 1"
  88
  89 /**
  90  * After how many ms "busy" should a DB operation fail for good?
  91  * A low value makes sure that we are more responsive to requests
  92  * (especially PUTs).  A high value guarantees a higher success
  93  * rate (SELECTs in iterate can take several seconds despite LIMIT=1).
  94  *
  95  * The default value of 250ms should ensure that users do not experience
  96  * huge latencies while at the same time allowing operations to succeed
  97  * with reasonable probability.
  98  */
  99 #define BUSY_TIMEOUT_MS 250
 100
 101
 102 /**
 103  * Context for all functions in this plugin.
 104  */
 105 struct Plugin
 106 {
 107   /**
 108    * Our execution environment.
 109    */
 110   struct GNUNET_DATASTORE_PluginEnvironment *env;
 111
 112   /**
 113    * Database filename.
 114    */
 115   char *fn;
 116
 117   /**
 118    * Native SQLite database handle.
 119    */
 120   sqlite3 *dbh;
 121
 122   /**
 123    * Precompiled SQL for update.
 124    */
 125   sqlite3_stmt *updPrio;
 126
 127   /**
 128    * Precompiled SQL for insertion.
 129    */
 130   sqlite3_stmt *insertContent;
 131
 132   /**
 133    * Handle to the statistics service.
 134    */
 135   struct GNUNET_STATISTICS_Handle *statistics;
 136
 137   /**
 138    * How much data are we currently storing
 139    * in the database?
 140    */
 141   unsigned long long payload;
 142
 143   /**
 144    * Number of updates that were made to the
 145    * payload value since we last synchronized
 146    * it with the statistics service.
 147    */
 148   unsigned int lastSync;
 149
 150   /**
 151    * Should the database be dropped on shutdown?
 152    */
 153   int drop_on_shutdown;
 154 };
 155
 156
 157 /**
 158  * @brief Prepare a SQL statement
 159  *
 160  * @param zSql SQL statement, UTF-8 encoded
 161  */
 162 static int
 163 sq_prepare (sqlite3 * dbh, const char *zSql,
 164             sqlite3_stmt ** ppStmt)
 165 {
 166   char *dummy;
 167   return sqlite3_prepare (dbh,
 168                           zSql,
 169                           strlen (zSql), ppStmt, (const char **) &dummy);
 170 }
 171
 172
 173 /**
 174  * Create our database indices.
 175  */
 176 static void
 177 create_indices (sqlite3 * dbh)
 178 {
 179   /* create indices */
 180   sqlite3_exec (dbh,
 181                 "CREATE INDEX idx_hash ON gn080 (hash)", NULL, NULL, NULL);
 182   sqlite3_exec (dbh,
 183                 "CREATE INDEX idx_hash_vhash ON gn080 (hash,vhash)", NULL,
 184                 NULL, NULL);
 185   sqlite3_exec (dbh, "CREATE INDEX idx_prio ON gn080 (prio)", NULL, NULL,
 186                 NULL);
 187   sqlite3_exec (dbh, "CREATE INDEX idx_expire ON gn080 (expire)", NULL, NULL,
 188                 NULL);
 189   sqlite3_exec (dbh, "CREATE INDEX idx_comb3 ON gn080 (prio,anonLevel)", NULL,
 190                 NULL, NULL);
 191   sqlite3_exec (dbh, "CREATE INDEX idx_comb4 ON gn080 (prio,hash,anonLevel)",
 192                 NULL, NULL, NULL);
 193   sqlite3_exec (dbh, "CREATE INDEX idx_comb7 ON gn080 (expire,hash)", NULL,
 194                 NULL, NULL);
 195 }
 196
 197
 198
 199 #if 1
 200 #define CHECK(a) GNUNET_break(a)
 201 #define ENULL NULL
 202 #else
 203 #define ENULL &e
 204 #define ENULL_DEFINED 1
 205 #define CHECK(a) if (! a) { GNUNET_log(GNUNET_ERROR_TYPE_ERRROR, "%s\n", e); sqlite3_free(e); }
 206 #endif
 207
 208
 209
 210
 211 /**
 212  * Initialize the database connections and associated
 213  * data structures (create tables and indices
 214  * as needed as well).
 215  *
 216  * @return GNUNET_OK on success
 217  */
 218 static int
 219 database_setup (struct GNUNET_CONFIGURATION_Handle *cfg,
 220                 struct Plugin *plugin)
 221 {
 222   sqlite3_stmt *stmt;
 223   char *afsdir;
 224 #if ENULL_DEFINED
 225   char *e;
 226 #endif
 227
 228   if (GNUNET_OK !=
 229       GNUNET_CONFIGURATION_get_value_filename (cfg,
 230                                                "datastore-sqlite",
 231                                                "FILENAME",
 232                                                &afsdir))
 233     {
 234       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
 235                        "sqlite",
 236                        _("Option `%s' in section `%s' missing in configuration!\n"),
 237                        "FILENAME",
 238                        "datastore-sqlite");
 239       return GNUNET_SYSERR;
 240     }
 241   if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (afsdir))
 242     {
 243       GNUNET_break (0);
 244       GNUNET_free (afsdir);
 245       return GNUNET_SYSERR;
 246     }
 247   plugin->fn = GNUNET_STRINGS_to_utf8 (afsdir, strlen (afsdir),
 248 #ifdef ENABLE_NLS
 249                                               nl_langinfo (CODESET)
 250 #else
 251                                               "UTF-8"   /* good luck */
 252 #endif
 253                                               );
 254   GNUNET_free (afsdir);
 255
 256   /* Open database and precompile statements */
 257   if (sqlite3_open (plugin->fn, &plugin->dbh) != SQLITE_OK)
 258     {
 259       GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
 260                        "sqlite",
 261                        _("Unable to initialize SQLite: %s.\n"),
 262                        sqlite3_errmsg (plugin->dbh));
 263       return GNUNET_SYSERR;
 264     }
 265   CHECK (SQLITE_OK ==
 266          sqlite3_exec (plugin->dbh,
 267                        "PRAGMA temp_store=MEMORY", NULL, NULL, ENULL));
 268   CHECK (SQLITE_OK ==
 269          sqlite3_exec (plugin->dbh,
 270                        "PRAGMA synchronous=OFF", NULL, NULL, ENULL));
 271   CHECK (SQLITE_OK ==
 272          sqlite3_exec (plugin->dbh,
 273                        "PRAGMA count_changes=OFF", NULL, NULL, ENULL));
 274   CHECK (SQLITE_OK ==
 275          sqlite3_exec (plugin->dbh, "PRAGMA page_size=4092", NULL, NULL, ENULL));
 276
 277   CHECK (SQLITE_OK == sqlite3_busy_timeout (plugin->dbh, BUSY_TIMEOUT_MS));
 278
 279
 280   /* We have to do it here, because otherwise precompiling SQL might fail */
 281   CHECK (SQLITE_OK ==
 282          sq_prepare (plugin->dbh,
 283                      "SELECT 1 FROM sqlite_master WHERE tbl_name = 'gn080'",
 284                      &stmt));
 285   if ( (sqlite3_step (stmt) == SQLITE_DONE) &&
 286        (sqlite3_exec (plugin->dbh,
 287                       "CREATE TABLE gn080 ("
 288                       "  size INTEGER NOT NULL DEFAULT 0,"
 289                       "  type INTEGER NOT NULL DEFAULT 0,"
 290                       "  prio INTEGER NOT NULL DEFAULT 0,"
 291                       "  anonLevel INTEGER NOT NULL DEFAULT 0,"
 292                       "  expire INTEGER NOT NULL DEFAULT 0,"
 293                       "  hash TEXT NOT NULL DEFAULT '',"
 294                       "  vhash TEXT NOT NULL DEFAULT '',"
 295                       "  value BLOB NOT NULL DEFAULT '')", NULL, NULL,
 296                       NULL) != SQLITE_OK) )
 297     {
 298       LOG_SQLITE (plugin, NULL,
 299                   GNUNET_ERROR_TYPE_ERROR,
 300                   "sqlite3_exec");
 301       sqlite3_finalize (stmt);
 302       return GNUNET_SYSERR;
 303     }
 304   sqlite3_finalize (stmt);
 305   create_indices (plugin->dbh);
 306
 307   CHECK (SQLITE_OK ==
 308          sq_prepare (plugin->dbh,
 309                      "SELECT 1 FROM sqlite_master WHERE tbl_name = 'gn071'",
 310                      &stmt));
 311   if ( (sqlite3_step (stmt) == SQLITE_DONE) &&
 312        (sqlite3_exec (plugin->dbh,
 313                       "CREATE TABLE gn071 ("
 314                       "  key TEXT NOT NULL DEFAULT '',"
 315                       "  value INTEGER NOT NULL DEFAULT 0)", NULL, NULL,
 316                       NULL) != SQLITE_OK) )
 317     {
 318       LOG_SQLITE (plugin, NULL,
 319                   GNUNET_ERROR_TYPE_ERROR, "sqlite3_exec");
 320       sqlite3_finalize (stmt);
 321       return GNUNET_SYSERR;
 322     }
 323   sqlite3_finalize (stmt);
 324
 325   if ((sq_prepare (plugin->dbh,
 326                    "UPDATE gn080 SET prio = prio + ?, expire = MAX(expire,?) WHERE "
 327                    "_ROWID_ = ?",
 328                    &plugin->updPrio) != SQLITE_OK) ||
 329       (sq_prepare (plugin->dbh,
 330                    "INSERT INTO gn080 (size, type, prio, "
 331                    "anonLevel, expire, hash, vhash, value) VALUES "
 332                    "(?, ?, ?, ?, ?, ?, ?, ?)",
 333                    &plugin->insertContent) != SQLITE_OK))
 334     {
 335       LOG_SQLITE (plugin, NULL,
 336                   GNUNET_ERROR_TYPE_ERROR, "precompiling");
 337       return GNUNET_SYSERR;
 338     }
 339   return GNUNET_OK;
 340 }
 341
 342
 343 /**
 344  * Synchronize our utilization statistics with the
 345  * statistics service.
 346  */
 347 static void
 348 sync_stats (struct Plugin *plugin)
 349 {
 350   GNUNET_STATISTICS_set (plugin->statistics,
 351                          QUOTA_STAT_NAME,
 352                          plugin->payload,
 353                          GNUNET_YES);
 354   plugin->lastSync = 0;
 355 }
 356
 357
 358 /**
 359  * Shutdown database connection and associate data
 360  * structures.
 361  */
 362 static void
 363 database_shutdown (struct Plugin *plugin)
 364 {
 365   if (plugin->lastSync > 0)
 366     sync_stats (plugin);
 367   if (plugin->updPrio != NULL)
 368     sqlite3_finalize (plugin->updPrio);
 369   if (plugin->insertContent != NULL)
 370     sqlite3_finalize (plugin->insertContent);
 371   sqlite3_close (plugin->dbh);
 372   GNUNET_free_non_null (plugin->fn);
 373 }
 374
 375
 376 /**
 377  * Get an estimate of how much space the database is
 378  * currently using.
 379  * @return number of bytes used on disk
 380  */
 381 static unsigned long long sqlite_plugin_get_size (void *cls)
 382 {
 383   struct Plugin *plugin = cls;
 384   return plugin->payload;
 385 }
 386
 387
 388 /**
 389  * Delete the database entry with the given
 390  * row identifier.
 391  */
 392 static int
 393 delete_by_rowid (struct Plugin* plugin,
 394                  unsigned long long rid)
 395 {
 396   sqlite3_stmt *stmt;
 397
 398   if (sq_prepare (plugin->dbh,
 399                   "DELETE FROM gn080 WHERE _ROWID_ = ?", &stmt) != SQLITE_OK)
 400     {
 401       LOG_SQLITE (plugin, NULL,
 402                   GNUNET_ERROR_TYPE_ERROR |
 403                   GNUNET_ERROR_TYPE_BULK, "sq_prepare");
 404       return GNUNET_SYSERR;
 405     }
 406   sqlite3_bind_int64 (stmt, 1, rid);
 407   if (SQLITE_DONE != sqlite3_step (stmt))
 408     {
 409       LOG_SQLITE (plugin, NULL,
 410                   GNUNET_ERROR_TYPE_ERROR |
 411                   GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
 412       sqlite3_finalize (stmt);
 413       return GNUNET_SYSERR;
 414     }
 415   sqlite3_finalize (stmt);
 416   return GNUNET_OK;
 417 }
 418
 419
 420 /**
 421  * Context for the universal iterator.
 422  */
 423 struct NextContext;
 424
 425 /**
 426  * Type of a function that will prepare
 427  * the next iteration.
 428  *
 429  * @param cls closure
 430  * @param nc the next context; NULL for the last
 431  *         call which gives the callback a chance to
 432  *         clean up the closure
 433  * @return GNUNET_OK on success, GNUNET_NO if there are
 434  *         no more values, GNUNET_SYSERR on error
 435  */
 436 typedef int (*PrepareFunction)(void *cls,
 437                                struct NextContext *nc);
 438
 439
 440 /**
 441  * Context we keep for the "next request" callback.
 442  */
 443 struct NextContext
 444 {
 445   /**
 446    * Internal state.
 447    */
 448   struct Plugin *plugin;
 449
 450   /**
 451    * Function to call on the next value.
 452    */
 453   PluginIterator iter;
 454
 455   /**
 456    * Closure for iter.
 457    */
 458   void *iter_cls;
 459
 460   /**
 461    * Function to call to prepare the next
 462    * iteration.
 463    */
 464   PrepareFunction prep;
 465
 466   /**
 467    * Closure for prep.
 468    */
 469   void *prep_cls;
 470
 471   /**
 472    * Statement that the iterator will get the data
 473    * from (updated or set by prep).
 474    */
 475   sqlite3_stmt *stmt;
 476
 477   /**
 478    * Row ID of the last result.
 479    */
 480   unsigned long long last_rowid;
 481
 482   /**
 483    * Key of the last result.
 484    */
 485   GNUNET_HashCode lastKey;
 486
 487   /**
 488    * Expiration time of the last value visited.
 489    */
 490   struct GNUNET_TIME_Absolute lastExpiration;
 491
 492   /**
 493    * Priority of the last value visited.
 494    */
 495   unsigned int lastPriority;
 496
 497   /**
 498    * Number of results processed so far.
 499    */
 500   unsigned int count;
 501
 502   /**
 503    * Set to GNUNET_YES if we must stop now.
 504    */
 505   int end_it;
 506 };
 507
 508
 509 /**
 510  * Continuation of "sqlite_next_request".
 511  *
 512  * @param cls the next context
 513  */
 514 static void
 515 sqlite_next_request_cont (void *cls,
 516                           const struct GNUNET_SCHEDULER_TaskContext *tc)
 517 {
 518   static struct GNUNET_TIME_Absolute zero;
 519   struct NextContext * nc= cls;
 520   struct Plugin *plugin;
 521   unsigned long long rowid;
 522   sqlite3_stmt *stmtd;
 523   int ret;
 524   unsigned int type;
 525   unsigned int size;
 526   unsigned int priority;
 527   unsigned int anonymity;
 528   struct GNUNET_TIME_Absolute expiration;
 529   const GNUNET_HashCode *key;
 530   const void *data;
 531
 532
 533   plugin = nc->plugin;
 534   if ( (GNUNET_YES == nc->end_it) ||
 535        (GNUNET_OK != (nc->prep(nc->prep_cls,
 536                                nc))) )
 537     {
 538     END:
 539       nc->iter (nc->iter_cls,
 540                 NULL, NULL, 0, NULL, 0, 0, 0,
 541                 zero, 0);
 542       nc->prep (nc->prep_cls, NULL);
 543       GNUNET_free (nc);
 544       return;
 545     }
 546
 547   rowid = sqlite3_column_int64 (nc->stmt, 7);
 548   nc->last_rowid = rowid;
 549   type = sqlite3_column_int (nc->stmt, 1);
 550   size = sqlite3_column_bytes (nc->stmt, 6);
 551   if (sqlite3_column_bytes (nc->stmt, 5) != sizeof (GNUNET_HashCode))
 552     {
 553       GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
 554                        "sqlite",
 555                        _("Invalid data in database.  Trying to fix (by deletion).\n"));
 556       if (SQLITE_OK != sqlite3_reset (nc->stmt))
 557         LOG_SQLITE (nc->plugin, NULL,
 558                     GNUNET_ERROR_TYPE_ERROR |
 559                     GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
 560       if (sq_prepare
 561           (nc->plugin->dbh,
 562            "DELETE FROM gn080 WHERE NOT LENGTH(hash) = ?",
 563            &stmtd) != SQLITE_OK)
 564         {
 565           LOG_SQLITE (nc->plugin, NULL,
 566                       GNUNET_ERROR_TYPE_ERROR |
 567                       GNUNET_ERROR_TYPE_BULK,
 568                       "sq_prepare");
 569           goto END;
 570         }
 571
 572       if (SQLITE_OK != sqlite3_bind_int (stmtd, 1, sizeof (GNUNET_HashCode)))
 573         LOG_SQLITE (nc->plugin, NULL,
 574                     GNUNET_ERROR_TYPE_ERROR |
 575                     GNUNET_ERROR_TYPE_BULK, "sqlite3_bind_int");
 576       if (SQLITE_DONE != sqlite3_step (stmtd))
 577         LOG_SQLITE (nc->plugin, NULL,
 578                     GNUNET_ERROR_TYPE_ERROR |
 579                     GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
 580       if (SQLITE_OK != sqlite3_finalize (stmtd))
 581         LOG_SQLITE (nc->plugin, NULL,
 582                     GNUNET_ERROR_TYPE_ERROR |
 583                     GNUNET_ERROR_TYPE_BULK, "sqlite3_finalize");
 584       goto END;
 585     }
 586
 587   priority = sqlite3_column_int (nc->stmt, 2);
 588   anonymity = sqlite3_column_int (nc->stmt, 3);
 589   expiration.value = sqlite3_column_int64 (nc->stmt, 4);
 590   key = sqlite3_column_blob (nc->stmt, 5);
 591   nc->lastPriority = priority;
 592   nc->lastExpiration = expiration;
 593   memcpy (&nc->lastKey, key, sizeof(GNUNET_HashCode));
 594   data = sqlite3_column_blob (nc->stmt, 6);
 595   nc->count++;
 596   ret = nc->iter (nc->iter_cls,
 597                   nc,
 598                   key,
 599                   size,
 600                   data,
 601                   type,
 602                   priority,
 603                   anonymity,
 604                   expiration,
 605                   rowid);
 606   if (ret == GNUNET_SYSERR)
 607     {
 608       nc->end_it = GNUNET_YES;
 609       return;
 610     }
 611   if ( (ret == GNUNET_NO) &&
 612        (GNUNET_OK == delete_by_rowid (plugin, rowid)) )
 613     {
 614       plugin->payload -= (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
 615       plugin->lastSync++;
 616       if (plugin->lastSync >= MAX_STAT_SYNC_LAG)
 617         sync_stats (plugin);
 618     }
 619 }
 620
 621
 622 /**
 623  * Function invoked on behalf of a "PluginIterator"
 624  * asking the database plugin to call the iterator
 625  * with the next item.
 626  *
 627  * @param next_cls whatever argument was given
 628  *        to the PluginIterator as "next_cls".
 629  * @param end_it set to GNUNET_YES if we
 630  *        should terminate the iteration early
 631  *        (iterator should be still called once more
 632  *         to signal the end of the iteration).
 633  */
 634 static void
 635 sqlite_next_request (void *next_cls,
 636                      int end_it)
 637 {
 638   struct NextContext * nc= next_cls;
 639
 640   if (GNUNET_YES == end_it)
 641     nc->end_it = GNUNET_YES;
 642   GNUNET_SCHEDULER_add_continuation (nc->plugin->env->sched,
 643                                      GNUNET_NO,
 644                                      &sqlite_next_request_cont,
 645                                      nc,
 646                                      GNUNET_SCHEDULER_REASON_PREREQ_DONE);
 647 }
 648
 649
 650
 651 /**
 652  * Store an item in the datastore.
 653  *
 654  * @param cls closure
 655  * @param key key for the item
 656  * @param size number of bytes in data
 657  * @param data content stored
 658  * @param type type of the content
 659  * @param priority priority of the content
 660  * @param anonymity anonymity-level for the content
 661  * @param expiration expiration time for the content
 662  * @param msg set to an error message
 663  * @return GNUNET_OK on success
 664  */
 665 static int
 666 sqlite_plugin_put (void *cls,
 667                    const GNUNET_HashCode * key,
 668                    uint32_t size,
 669                    const void *data,
 670                    uint32_t type,
 671                    uint32_t priority,
 672                    uint32_t anonymity,
 673                    struct GNUNET_TIME_Absolute expiration,
 674                    char ** msg)
 675 {
 676   struct Plugin *plugin = cls;
 677   int n;
 678   sqlite3_stmt *stmt;
 679   GNUNET_HashCode vhash;
 680
 681 #if DEBUG_SQLITE
 682   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 683                    "sqlite",
 684                    "Storing in database block with type %u/key `%s'/priority %u/expiration %llu.\n",
 685                    type,
 686                    GNUNET_h2s(key),
 687                    priority,
 688                    GNUNET_TIME_absolute_get_remaining (expiration).value);
 689 #endif
 690   GNUNET_CRYPTO_hash (data, size, &vhash);
 691   stmt = plugin->insertContent;
 692   if ((SQLITE_OK != sqlite3_bind_int (stmt, 1, size)) ||
 693       (SQLITE_OK != sqlite3_bind_int (stmt, 2, type)) ||
 694       (SQLITE_OK != sqlite3_bind_int (stmt, 3, priority)) ||
 695       (SQLITE_OK != sqlite3_bind_int (stmt, 4, anonymity)) ||
 696       (SQLITE_OK != sqlite3_bind_int64 (stmt, 5, (sqlite3_int64) expiration.value)) ||
 697       (SQLITE_OK !=
 698        sqlite3_bind_blob (stmt, 6, key, sizeof (GNUNET_HashCode),
 699                           SQLITE_TRANSIENT)) ||
 700       (SQLITE_OK !=
 701        sqlite3_bind_blob (stmt, 7, &vhash, sizeof (GNUNET_HashCode),
 702                           SQLITE_TRANSIENT))
 703       || (SQLITE_OK !=
 704           sqlite3_bind_blob (stmt, 8, data, size,
 705                              SQLITE_TRANSIENT)))
 706     {
 707       LOG_SQLITE (plugin,
 708                   msg,
 709                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_bind_XXXX");
 710       if (SQLITE_OK != sqlite3_reset (stmt))
 711         LOG_SQLITE (plugin, NULL,
 712                     GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
 713       return GNUNET_SYSERR;
 714     }
 715   n = sqlite3_step (stmt);
 716   if (n != SQLITE_DONE)
 717     {
 718       if (n == SQLITE_BUSY)
 719         {
 720           LOG_SQLITE (plugin, msg,
 721                       GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
 722           sqlite3_reset (stmt);
 723           GNUNET_break (0);
 724           return GNUNET_NO;
 725         }
 726       LOG_SQLITE (plugin, msg,
 727                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
 728       sqlite3_reset (stmt);
 729       return GNUNET_SYSERR;
 730     }
 731   if (SQLITE_OK != sqlite3_reset (stmt))
 732     LOG_SQLITE (plugin, NULL,
 733                 GNUNET_ERROR_TYPE_ERROR |
 734                 GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
 735   plugin->lastSync++;
 736   plugin->payload += size + GNUNET_DATASTORE_ENTRY_OVERHEAD;
 737   if (plugin->lastSync >= MAX_STAT_SYNC_LAG)
 738     sync_stats (plugin);
 739   return GNUNET_OK;
 740 }
 741
 742
 743 /**
 744  * Update the priority for a particular key in the datastore.  If
 745  * the expiration time in value is different than the time found in
 746  * the datastore, the higher value should be kept.  For the
 747  * anonymity level, the lower value is to be used.  The specified
 748  * priority should be added to the existing priority, ignoring the
 749  * priority in value.
 750  *
 751  * Note that it is possible for multiple values to match this put.
 752  * In that case, all of the respective values are updated.
 753  *
 754  * @param uid unique identifier of the datum
 755  * @param delta by how much should the priority
 756  *     change?  If priority + delta < 0 the
 757  *     priority should be set to 0 (never go
 758  *     negative).
 759  * @param expire new expiration time should be the
 760  *     MAX of any existing expiration time and
 761  *     this value
 762  * @param msg set to an error message
 763  * @return GNUNET_OK on success
 764  */
 765 static int
 766 sqlite_plugin_update (void *cls,
 767                       uint64_t uid,
 768                       int delta, struct GNUNET_TIME_Absolute expire,
 769                       char **msg)
 770 {
 771   struct Plugin *plugin = cls;
 772   int n;
 773
 774   sqlite3_bind_int (plugin->updPrio, 1, delta);
 775   sqlite3_bind_int64 (plugin->updPrio, 2, expire.value);
 776   sqlite3_bind_int64 (plugin->updPrio, 3, uid);
 777   n = sqlite3_step (plugin->updPrio);
 778   if (n != SQLITE_OK)
 779     LOG_SQLITE (plugin, msg,
 780                 GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
 781                 "sqlite3_step");
 782 #if DEBUG_SQLITE
 783   else
 784     GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 785                      "sqlite",
 786                      "Block updated\n");
 787 #endif
 788   sqlite3_reset (plugin->updPrio);
 789
 790   if (n == SQLITE_BUSY)
 791     return GNUNET_NO;
 792   return n == SQLITE_OK ? GNUNET_OK : GNUNET_SYSERR;
 793 }
 794
 795
 796 struct IterContext
 797 {
 798   sqlite3_stmt *stmt_1;
 799   sqlite3_stmt *stmt_2;
 800   int is_asc;
 801   int is_prio;
 802   int is_migr;
 803   int limit_nonanonymous;
 804   uint32_t type;
 805 };
 806
 807
 808 static int
 809 iter_next_prepare (void *cls,
 810                    struct NextContext *nc)
 811 {
 812   struct IterContext *ic = cls;
 813   struct Plugin *plugin;
 814   int ret;
 815
 816   if (nc == NULL)
 817     {
 818 #if DEBUG_SQLITE
 819       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 820                   "Asked to clean up iterator state.\n");
 821 #endif
 822       sqlite3_finalize (ic->stmt_1);
 823       sqlite3_finalize (ic->stmt_2);
 824       return GNUNET_SYSERR;
 825     }
 826   sqlite3_reset (ic->stmt_1);
 827   sqlite3_reset (ic->stmt_2);
 828   plugin = nc->plugin;
 829   if (ic->is_prio)
 830     {
 831 #if DEBUG_SQLITE
 832       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 833                   "Restricting to results larger than the last priority %u\n",
 834                   nc->lastPriority);
 835 #endif
 836       sqlite3_bind_int (ic->stmt_1, 1, nc->lastPriority);
 837       sqlite3_bind_int (ic->stmt_2, 1, nc->lastPriority);
 838     }
 839   else
 840     {
 841 #if DEBUG_SQLITE
 842       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 843                   "Restricting to results larger than the last expiration %llu\n",
 844                   (unsigned long long) nc->lastExpiration.value);
 845 #endif
 846       sqlite3_bind_int64 (ic->stmt_1, 1, nc->lastExpiration.value);
 847       sqlite3_bind_int64 (ic->stmt_2, 1, nc->lastExpiration.value);
 848     }
 849 #if DEBUG_SQLITE
 850   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 851               "Restricting to results larger than the last key `%s'\n",
 852               GNUNET_h2s(&nc->lastKey));
 853 #endif
 854   sqlite3_bind_blob (ic->stmt_1, 2,
 855                      &nc->lastKey,
 856                      sizeof (GNUNET_HashCode),
 857                      SQLITE_TRANSIENT);
 858   if (SQLITE_ROW == (ret = sqlite3_step (ic->stmt_1)))
 859     {
 860 #if DEBUG_SQLITE
 861       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 862                   "Result found using iterator 1\n");
 863 #endif
 864       nc->stmt = ic->stmt_1;
 865       return GNUNET_OK;
 866     }
 867   if (ret != SQLITE_DONE)
 868     {
 869       LOG_SQLITE (plugin, NULL,
 870                   GNUNET_ERROR_TYPE_ERROR |
 871                   GNUNET_ERROR_TYPE_BULK,
 872                   "sqlite3_step");
 873       return GNUNET_SYSERR;
 874     }
 875   if (SQLITE_OK != sqlite3_reset (ic->stmt_1))
 876     LOG_SQLITE (plugin, NULL,
 877                 GNUNET_ERROR_TYPE_ERROR |
 878                 GNUNET_ERROR_TYPE_BULK,
 879                 "sqlite3_reset");
 880   if (SQLITE_ROW == (ret = sqlite3_step (ic->stmt_2)))
 881     {
 882 #if DEBUG_SQLITE
 883       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 884                   "Result found using iterator 2\n");
 885 #endif
 886       nc->stmt = ic->stmt_2;
 887       return GNUNET_OK;
 888     }
 889   if (ret != SQLITE_DONE)
 890     {
 891       LOG_SQLITE (plugin, NULL,
 892                   GNUNET_ERROR_TYPE_ERROR |
 893                   GNUNET_ERROR_TYPE_BULK,
 894                   "sqlite3_step");
 895       return GNUNET_SYSERR;
 896     }
 897   if (SQLITE_OK != sqlite3_reset (ic->stmt_2))
 898     LOG_SQLITE (plugin, NULL,
 899                 GNUNET_ERROR_TYPE_ERROR |
 900                 GNUNET_ERROR_TYPE_BULK,
 901                 "sqlite3_reset");
 902 #if DEBUG_SQLITE
 903   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 904               "No result found using either iterator\n");
 905 #endif
 906   return GNUNET_NO;
 907 }
 908
 909
 910 /**
 911  * Call a method for each key in the database and
 912  * call the callback method on it.
 913  *
 914  * @param type entries of which type should be considered?
 915  * @param iter function to call on each matching value;
 916  *        will be called once with a NULL value at the end
 917  * @param iter_cls closure for iter
 918  * @return the number of results processed,
 919  *         GNUNET_SYSERR on error
 920  */
 921 static void
 922 basic_iter (struct Plugin *plugin,
 923             uint32_t type,
 924             int is_asc,
 925             int is_prio,
 926             int is_migr,
 927             int limit_nonanonymous,
 928             const char *stmt_str_1,
 929             const char *stmt_str_2,
 930             PluginIterator iter,
 931             void *iter_cls)
 932 {
 933   static struct GNUNET_TIME_Absolute zero;
 934   struct NextContext *nc;
 935   struct IterContext *ic;
 936   sqlite3_stmt *stmt_1;
 937   sqlite3_stmt *stmt_2;
 938
 939 #if DEBUG_SQLITE
 940   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 941               "At %llu, using queries `%s' and `%s'\n",
 942               (unsigned long long) GNUNET_TIME_absolute_get ().value,
 943               stmt_str_1,
 944               stmt_str_2);
 945 #endif
 946   if (sq_prepare (plugin->dbh, stmt_str_1, &stmt_1) != SQLITE_OK)
 947     {
 948       LOG_SQLITE (plugin, NULL,
 949                   GNUNET_ERROR_TYPE_ERROR |
 950                   GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
 951       iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
 952       return;
 953     }
 954   if (sq_prepare (plugin->dbh, stmt_str_2, &stmt_2) != SQLITE_OK)
 955     {
 956       LOG_SQLITE (plugin, NULL,
 957                   GNUNET_ERROR_TYPE_ERROR |
 958                   GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
 959       sqlite3_finalize (stmt_1);
 960       iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
 961       return;
 962     }
 963   nc = GNUNET_malloc (sizeof(struct NextContext) +
 964                       sizeof(struct IterContext));
 965   nc->plugin = plugin;
 966   nc->iter = iter;
 967   nc->iter_cls = iter_cls;
 968   nc->stmt = NULL;
 969   ic = (struct IterContext*) &nc[1];
 970   ic->stmt_1 = stmt_1;
 971   ic->stmt_2 = stmt_2;
 972   ic->type = type;
 973   ic->is_asc = is_asc;
 974   ic->is_prio = is_prio;
 975   ic->is_migr = is_migr;
 976   ic->limit_nonanonymous = limit_nonanonymous;
 977   nc->prep = &iter_next_prepare;
 978   nc->prep_cls = ic;
 979   if (is_asc)
 980     {
 981       nc->lastPriority = 0;
 982       nc->lastExpiration.value = 0;
 983       memset (&nc->lastKey, 0, sizeof (GNUNET_HashCode));
 984     }
 985   else
 986     {
 987       nc->lastPriority = 0x7FFFFFFF;
 988       nc->lastExpiration.value = 0x7FFFFFFFFFFFFFFFLL;
 989       memset (&nc->lastKey, 255, sizeof (GNUNET_HashCode));
 990     }
 991   sqlite_next_request (nc, GNUNET_NO);
 992 }
 993
 994
 995 /**
 996  * Select a subset of the items in the datastore and call
 997  * the given iterator for each of them.
 998  *
 999  * @param type entries of which type should be considered?
1000  *        Use 0 for any type.
1001  * @param iter function to call on each matching value;
1002  *        will be called once with a NULL value at the end
1003  * @param iter_cls closure for iter
1004  */
1005 static void
1006 sqlite_plugin_iter_low_priority (void *cls,
1007                                  uint32_t type,
1008                                  PluginIterator iter,
1009                                  void *iter_cls)
1010 {
1011   basic_iter (cls,
1012               type,
1013               GNUNET_YES, GNUNET_YES,
1014               GNUNET_NO, GNUNET_NO,
1015               SELECT_IT_LOW_PRIORITY_1,
1016               SELECT_IT_LOW_PRIORITY_2,
1017               iter, iter_cls);
1018 }
1019
1020
1021 /**
1022  * Select a subset of the items in the datastore and call
1023  * the given iterator for each of them.
1024  *
1025  * @param type entries of which type should be considered?
1026  *        Use 0 for any type.
1027  * @param iter function to call on each matching value;
1028  *        will be called once with a NULL value at the end
1029  * @param iter_cls closure for iter
1030  */
1031 static void
1032 sqlite_plugin_iter_zero_anonymity (void *cls,
1033                                    uint32_t type,
1034                                    PluginIterator iter,
1035                                    void *iter_cls)
1036 {
1037   struct GNUNET_TIME_Absolute now;
1038   char *q1;
1039   char *q2;
1040
1041   now = GNUNET_TIME_absolute_get ();
1042   GNUNET_asprintf (&q1, SELECT_IT_NON_ANONYMOUS_1,
1043                    (unsigned long long) now.value);
1044   GNUNET_asprintf (&q2, SELECT_IT_NON_ANONYMOUS_2,
1045                    (unsigned long long) now.value);
1046   basic_iter (cls,
1047               type,
1048               GNUNET_NO, GNUNET_YES,
1049               GNUNET_NO, GNUNET_YES,
1050               q1,
1051               q2,
1052               iter, iter_cls);
1053   GNUNET_free (q1);
1054   GNUNET_free (q2);
1055 }
1056
1057
1058
1059 /**
1060  * Select a subset of the items in the datastore and call
1061  * the given iterator for each of them.
1062  *
1063  * @param type entries of which type should be considered?
1064  *        Use 0 for any type.
1065  * @param iter function to call on each matching value;
1066  *        will be called once with a NULL value at the end
1067  * @param iter_cls closure for iter
1068  */
1069 static void
1070 sqlite_plugin_iter_ascending_expiration (void *cls,
1071                                          uint32_t type,
1072                                          PluginIterator iter,
1073                                          void *iter_cls)
1074 {
1075   struct GNUNET_TIME_Absolute now;
1076   char *q1;
1077   char *q2;
1078
1079   now = GNUNET_TIME_absolute_get ();
1080   GNUNET_asprintf (&q1, SELECT_IT_EXPIRATION_TIME_1,
1081                    (unsigned long long) 0*now.value);
1082   GNUNET_asprintf (&q2, SELECT_IT_EXPIRATION_TIME_2,
1083                    (unsigned long long) 0*now.value);
1084   basic_iter (cls,
1085               type,
1086               GNUNET_YES, GNUNET_NO,
1087               GNUNET_NO, GNUNET_NO,
1088               q1, q2,
1089               iter, iter_cls);
1090   GNUNET_free (q1);
1091   GNUNET_free (q2);
1092 }
1093
1094
1095 /**
1096  * Select a subset of the items in the datastore and call
1097  * the given iterator for each of them.
1098  *
1099  * @param type entries of which type should be considered?
1100  *        Use 0 for any type.
1101  * @param iter function to call on each matching value;
1102  *        will be called once with a NULL value at the end
1103  * @param iter_cls closure for iter
1104  */
1105 static void
1106 sqlite_plugin_iter_migration_order (void *cls,
1107                                     uint32_t type,
1108                                     PluginIterator iter,
1109                                     void *iter_cls)
1110 {
1111   struct GNUNET_TIME_Absolute now;
1112   char *q;
1113
1114   now = GNUNET_TIME_absolute_get ();
1115   GNUNET_asprintf (&q, SELECT_IT_MIGRATION_ORDER_2,
1116                    (unsigned long long) now.value);
1117   basic_iter (cls,
1118               type,
1119               GNUNET_NO, GNUNET_NO,
1120               GNUNET_YES, GNUNET_NO,
1121               SELECT_IT_MIGRATION_ORDER_1,
1122               q,
1123               iter, iter_cls);
1124   GNUNET_free (q);
1125 }
1126
1127
1128 static int
1129 all_next_prepare (void *cls,
1130                   struct NextContext *nc)
1131 {
1132   struct Plugin *plugin;
1133   int ret;
1134
1135   if (nc == NULL)
1136     {
1137 #if DEBUG_SQLITE
1138       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1139                   "Asked to clean up iterator state.\n");
1140 #endif
1141       return GNUNET_SYSERR;
1142     }
1143   plugin = nc->plugin;
1144   if (SQLITE_ROW == (ret = sqlite3_step (nc->stmt)))
1145     {
1146       return GNUNET_OK;
1147     }
1148   if (ret != SQLITE_DONE)
1149     {
1150       LOG_SQLITE (plugin, NULL,
1151                   GNUNET_ERROR_TYPE_ERROR |
1152                   GNUNET_ERROR_TYPE_BULK,
1153                   "sqlite3_step");
1154       return GNUNET_SYSERR;
1155     }
1156   return GNUNET_NO;
1157 }
1158
1159
1160 /**
1161  * Select a subset of the items in the datastore and call
1162  * the given iterator for each of them.
1163  *
1164  * @param type entries of which type should be considered?
1165  *        Use 0 for any type.
1166  * @param iter function to call on each matching value;
1167  *        will be called once with a NULL value at the end
1168  * @param iter_cls closure for iter
1169  */
1170 static void
1171 sqlite_plugin_iter_all_now (void *cls,
1172                             uint32_t type,
1173                             PluginIterator iter,
1174                             void *iter_cls)
1175 {
1176   static struct GNUNET_TIME_Absolute zero;
1177   struct Plugin *plugin = cls;
1178   struct NextContext *nc;
1179   sqlite3_stmt *stmt;
1180
1181   if (sq_prepare (plugin->dbh,
1182                   "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080",
1183                   &stmt) != SQLITE_OK)
1184     {
1185       LOG_SQLITE (plugin, NULL,
1186                   GNUNET_ERROR_TYPE_ERROR |
1187                   GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
1188       iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1189       return;
1190     }
1191   nc = GNUNET_malloc (sizeof(struct NextContext));
1192   nc->plugin = plugin;
1193   nc->iter = iter;
1194   nc->iter_cls = iter_cls;
1195   nc->stmt = stmt;
1196   nc->prep = &all_next_prepare;
1197   nc->prep_cls = NULL;
1198   sqlite_next_request (nc, GNUNET_NO);
1199 }
1200
1201
1202 struct GetNextContext
1203 {
1204   int total;
1205   int off;
1206   int have_vhash;
1207   unsigned int type;
1208   sqlite3_stmt *stmt;
1209   GNUNET_HashCode key;
1210   GNUNET_HashCode vhash;
1211 };
1212
1213
1214 static int
1215 get_next_prepare (void *cls,
1216                   struct NextContext *nc)
1217 {
1218   struct GetNextContext *gnc = cls;
1219   int sqoff;
1220   int ret;
1221   int limit_off;
1222
1223   if (nc == NULL)
1224     {
1225       sqlite3_finalize (gnc->stmt);
1226       return GNUNET_SYSERR;
1227     }
1228   if (nc->count == gnc->total)
1229     return GNUNET_NO;
1230   if (nc->count + gnc->off == gnc->total)
1231     nc->last_rowid = 0;
1232   if (nc->count == 0)
1233     limit_off = gnc->off;
1234   else
1235     limit_off = 0;
1236   sqoff = 1;
1237   sqlite3_reset (nc->stmt);
1238   ret = sqlite3_bind_blob (nc->stmt,
1239                            sqoff++,
1240                            &gnc->key,
1241                            sizeof (GNUNET_HashCode),
1242                            SQLITE_TRANSIENT);
1243   if ((gnc->have_vhash) && (ret == SQLITE_OK))
1244     ret = sqlite3_bind_blob (nc->stmt,
1245                              sqoff++,
1246                              &gnc->vhash,
1247                              sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1248   if ((gnc->type != 0) && (ret == SQLITE_OK))
1249     ret = sqlite3_bind_int (nc->stmt, sqoff++, gnc->type);
1250   if (ret == SQLITE_OK)
1251     ret = sqlite3_bind_int64 (nc->stmt, sqoff++, nc->last_rowid + 1);
1252   if (ret == SQLITE_OK)
1253     ret = sqlite3_bind_int (nc->stmt, sqoff++, limit_off);
1254   if (ret != SQLITE_OK)
1255     return GNUNET_SYSERR;
1256   if (SQLITE_ROW != sqlite3_step (nc->stmt))
1257     return GNUNET_NO;
1258   return GNUNET_OK;
1259 }
1260
1261
1262 /**
1263  * Iterate over the results for a particular key
1264  * in the datastore.
1265  *
1266  * @param cls closure
1267  * @param key maybe NULL (to match all entries)
1268  * @param vhash hash of the value, maybe NULL (to
1269  *        match all values that have the right key).
1270  *        Note that for DBlocks there is no difference
1271  *        betwen key and vhash, but for other blocks
1272  *        there may be!
1273  * @param type entries of which type are relevant?
1274  *     Use 0 for any type.
1275  * @param iter function to call on each matching value;
1276  *        will be called once with a NULL value at the end
1277  * @param iter_cls closure for iter
1278  */
1279 static void
1280 sqlite_plugin_get (void *cls,
1281                    const GNUNET_HashCode * key,
1282                    const GNUNET_HashCode * vhash,
1283                    uint32_t type,
1284                    PluginIterator iter, void *iter_cls)
1285 {
1286   static struct GNUNET_TIME_Absolute zero;
1287   struct Plugin *plugin = cls;
1288   struct GetNextContext *gpc;
1289   struct NextContext *nc;
1290   int ret;
1291   int total;
1292   sqlite3_stmt *stmt;
1293   char scratch[256];
1294   int sqoff;
1295
1296   GNUNET_assert (iter != NULL);
1297   if (key == NULL)
1298     {
1299       sqlite_plugin_iter_low_priority (cls, type, iter, iter_cls);
1300       return;
1301     }
1302   GNUNET_snprintf (scratch, 256,
1303                    "SELECT count(*) FROM gn080 WHERE hash=:1%s%s",
1304                    vhash == NULL ? "" : " AND vhash=:2",
1305                    type == 0 ? "" : (vhash ==
1306                                      NULL) ? " AND type=:2" : " AND type=:3");
1307   if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
1308     {
1309       LOG_SQLITE (plugin, NULL,
1310                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite_prepare");
1311       iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1312       return;
1313     }
1314   sqoff = 1;
1315   ret = sqlite3_bind_blob (stmt,
1316                            sqoff++,
1317                            key, sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1318   if ((vhash != NULL) && (ret == SQLITE_OK))
1319     ret = sqlite3_bind_blob (stmt,
1320                              sqoff++,
1321                              vhash,
1322                              sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1323   if ((type != 0) && (ret == SQLITE_OK))
1324     ret = sqlite3_bind_int (stmt, sqoff++, type);
1325   if (SQLITE_OK != ret)
1326     {
1327       LOG_SQLITE (plugin, NULL,
1328                   GNUNET_ERROR_TYPE_ERROR, "sqlite_bind");
1329       sqlite3_reset (stmt);
1330       sqlite3_finalize (stmt);
1331       iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1332       return;
1333     }
1334   ret = sqlite3_step (stmt);
1335   if (ret != SQLITE_ROW)
1336     {
1337       LOG_SQLITE (plugin, NULL,
1338                   GNUNET_ERROR_TYPE_ERROR| GNUNET_ERROR_TYPE_BULK,
1339                   "sqlite_step");
1340       sqlite3_reset (stmt);
1341       sqlite3_finalize (stmt);
1342       iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1343       return;
1344     }
1345   total = sqlite3_column_int (stmt, 0);
1346   sqlite3_reset (stmt);
1347   sqlite3_finalize (stmt);
1348   if (0 == total)
1349     {
1350       iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1351       return;
1352     }
1353
1354   GNUNET_snprintf (scratch, 256,
1355                    "SELECT size, type, prio, anonLevel, expire, hash, value, _ROWID_ "
1356                    "FROM gn080 WHERE hash=:1%s%s AND _ROWID_ >= :%d "
1357                    "ORDER BY _ROWID_ ASC LIMIT 1 OFFSET :d",
1358                    vhash == NULL ? "" : " AND vhash=:2",
1359                    type == 0 ? "" : (vhash ==
1360                                      NULL) ? " AND type=:2" : " AND type=:3",
1361                    sqoff, sqoff + 1);
1362   if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
1363     {
1364       LOG_SQLITE (plugin, NULL,
1365                   GNUNET_ERROR_TYPE_ERROR |
1366                   GNUNET_ERROR_TYPE_BULK, "sqlite_prepare");
1367       iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1368       return;
1369     }
1370   nc = GNUNET_malloc (sizeof(struct NextContext) +
1371                       sizeof(struct GetNextContext));
1372   nc->plugin = plugin;
1373   nc->iter = iter;
1374   nc->iter_cls = iter_cls;
1375   nc->stmt = stmt;
1376   gpc = (struct GetNextContext*) &nc[1];
1377   gpc->total = total;
1378   gpc->type = type;
1379   gpc->key = *key;
1380   gpc->stmt = stmt; /* alias used for freeing at the end! */
1381   if (NULL != vhash)
1382     {
1383       gpc->have_vhash = GNUNET_YES;
1384       gpc->vhash = *vhash;
1385     }
1386   gpc->off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, total);
1387   nc->prep = &get_next_prepare;
1388   nc->prep_cls = gpc;
1389   sqlite_next_request (nc, GNUNET_NO);
1390 }
1391
1392
1393 /**
1394  * Drop database.
1395  */
1396 static void
1397 sqlite_plugin_drop (void *cls)
1398 {
1399   struct Plugin *plugin = cls;
1400   plugin->drop_on_shutdown = GNUNET_YES;
1401 }
1402
1403
1404 /**
1405  * Callback function to process statistic values.
1406  *
1407  * @param cls closure
1408  * @param subsystem name of subsystem that created the statistic
1409  * @param name the name of the datum
1410  * @param value the current value
1411  * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
1412  * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
1413  */
1414 static int
1415 process_stat_in (void *cls,
1416                  const char *subsystem,
1417                  const char *name,
1418                  unsigned long long value,
1419                  int is_persistent)
1420 {
1421   struct Plugin *plugin = cls;
1422   plugin->payload += value;
1423   return GNUNET_OK;
1424 }
1425
1426
1427 /**
1428  * Entry point for the plugin.
1429  */
1430 void *
1431 libgnunet_plugin_datastore_sqlite_init (void *cls)
1432 {
1433   static struct Plugin plugin;
1434   struct GNUNET_DATASTORE_PluginEnvironment *env = cls;
1435   struct GNUNET_DATASTORE_PluginFunctions *api;
1436
1437   if (plugin.env != NULL)
1438     return NULL; /* can only initialize once! */
1439   memset (&plugin, 0, sizeof(struct Plugin));
1440   plugin.env = env;
1441   plugin.statistics = GNUNET_STATISTICS_create (env->sched,
1442                                                 "sqlite",
1443                                                 env->cfg);
1444   GNUNET_STATISTICS_get (plugin.statistics,
1445                          "sqlite",
1446                          QUOTA_STAT_NAME,
1447                          GNUNET_TIME_UNIT_MINUTES,
1448                          NULL,
1449                          &process_stat_in,
1450                          &plugin);
1451   if (GNUNET_OK !=
1452       database_setup (env->cfg, &plugin))
1453     {
1454       database_shutdown (&plugin);
1455       return NULL;
1456     }
1457   api = GNUNET_malloc (sizeof (struct GNUNET_DATASTORE_PluginFunctions));
1458   api->cls = &plugin;
1459   api->get_size = &sqlite_plugin_get_size;
1460   api->put = &sqlite_plugin_put;
1461   api->next_request = &sqlite_next_request;
1462   api->get = &sqlite_plugin_get;
1463   api->update = &sqlite_plugin_update;
1464   api->iter_low_priority = &sqlite_plugin_iter_low_priority;
1465   api->iter_zero_anonymity = &sqlite_plugin_iter_zero_anonymity;
1466   api->iter_ascending_expiration = &sqlite_plugin_iter_ascending_expiration;
1467   api->iter_migration_order = &sqlite_plugin_iter_migration_order;
1468   api->iter_all_now = &sqlite_plugin_iter_all_now;
1469   api->drop = &sqlite_plugin_drop;
1470   GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
1471                    "sqlite", _("Sqlite database running\n"));
1472   return api;
1473 }
1474
1475
1476 /**
1477  * Exit point from the plugin.
1478  */
1479 void *
1480 libgnunet_plugin_datastore_sqlite_done (void *cls)
1481 {
1482   char *fn;
1483   struct GNUNET_DATASTORE_PluginFunctions *api = cls;
1484   struct Plugin *plugin = api->cls;
1485
1486   fn = NULL;
1487   if (plugin->drop_on_shutdown)
1488     fn = GNUNET_strdup (plugin->fn);
1489   database_shutdown (plugin);
1490   plugin->env = NULL;
1491   plugin->payload = 0;
1492   GNUNET_free (api);
1493   if (fn != NULL)
1494     {
1495       if (0 != UNLINK(fn))
1496         GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
1497                                   "unlink",
1498                                   fn);
1499       GNUNET_free (fn);
1500     }
1501   return NULL;
1502 }
1503
1504 /* end of plugin_datastore_sqlite.c */