src/datacache/plugin_datacache_sqlite.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2006, 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 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 datacache/plugin_datacache_sqlite.c
  23  * @brief sqlite for an implementation of a database backend for the datacache
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_datacache_plugin.h"
  29 #include <sqlite3.h>
  30
  31 #define DEBUG_DATACACHE_SQLITE GNUNET_NO
  32
  33 /**
  34  * How much overhead do we assume per entry in the
  35  * datacache?
  36  */
  37 #define OVERHEAD (sizeof(GNUNET_HashCode) + 32)
  38
  39 /**
  40  * Context for all functions in this plugin.
  41  */
  42 struct Plugin
  43 {
  44   /**
  45    * Our execution environment.
  46    */
  47   struct GNUNET_DATACACHE_PluginEnvironment *env;
  48
  49   /**
  50    * Handle to the sqlite database.
  51    */
  52   sqlite3 *dbh;
  53
  54   /**
  55    * Filename used for the DB.
  56    */
  57   char *fn;
  58 };
  59
  60
  61 /**
  62  * Log an error message at log-level 'level' that indicates
  63  * a failure of the command 'cmd' on file 'filename'
  64  * with the message given by strerror(errno).
  65  */
  66 #define LOG_SQLITE(db, level, cmd) do { GNUNET_log(level, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db)); } while(0)
  67
  68
  69 #define SQLITE3_EXEC(db, cmd) do { emsg = NULL; if (SQLITE_OK != sqlite3_exec(db, cmd, NULL, NULL, &emsg)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, _("`%s' failed at %s:%d with error: %s\n"), "sqlite3_exec", __FILE__, __LINE__, emsg); sqlite3_free(emsg); } } while(0)
  70
  71
  72 /**
  73  * @brief Prepare a SQL statement
  74  */
  75 static int
  76 sq_prepare (sqlite3 * dbh, const char *zSql,    /* SQL statement, UTF-8 encoded */
  77             sqlite3_stmt ** ppStmt)
  78 {                               /* OUT: Statement handle */
  79   char *dummy;
  80   return sqlite3_prepare (dbh,
  81                           zSql,
  82                           strlen (zSql), ppStmt, (const char **) &dummy);
  83 }
  84
  85
  86 /**
  87  * Store an item in the datastore.
  88  *
  89  * @param cls closure (our "struct Plugin")
  90  * @param key key to store data under
  91  * @param size number of bytes in data
  92  * @param data data to store
  93  * @param type type of the value
  94  * @param discard_time when to discard the value in any case
  95  * @return 0 on error, number of bytes used otherwise
  96  */
  97 static size_t
  98 sqlite_plugin_put (void *cls,
  99                    const GNUNET_HashCode * key,
 100                    size_t size,
 101                    const char *data,
 102                    enum GNUNET_BLOCK_Type type,
 103                    struct GNUNET_TIME_Absolute discard_time)
 104 {
 105   struct Plugin *plugin = cls;
 106   sqlite3_stmt *stmt;
 107   int64_t dval;
 108
 109 #if DEBUG_DATACACHE_SQLITE
 110   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 111               "Processing `%s' of %u bytes with key `%4s' and expiration %llums\n",
 112               "PUT",
 113               (unsigned int) size,
 114               GNUNET_h2s (key),
 115               (unsigned long long) GNUNET_TIME_absolute_get_remaining (discard_time).rel_value);
 116 #endif
 117   dval = (int64_t) discard_time.abs_value;
 118   if (dval < 0)
 119     dval = INT64_MAX;
 120   if (sq_prepare (plugin->dbh,
 121                   "INSERT INTO ds090 "
 122                   "(type, expire, key, value) "
 123                   "VALUES (?, ?, ?, ?)", &stmt) != SQLITE_OK)
 124     {
 125       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 126                   _("`%s' failed at %s:%d with error: %s\n"),
 127                   "sq_prepare", __FILE__, __LINE__,
 128                   sqlite3_errmsg (plugin->dbh));
 129       return 0;
 130     }
 131   if ( (SQLITE_OK != sqlite3_bind_int (stmt, 1, type)) ||
 132        (SQLITE_OK != sqlite3_bind_int64 (stmt, 2, dval)) ||
 133        (SQLITE_OK != sqlite3_bind_blob (stmt, 3, key, sizeof (GNUNET_HashCode),
 134                                         SQLITE_TRANSIENT)) ||
 135        (SQLITE_OK != sqlite3_bind_blob (stmt, 4, data, size, SQLITE_TRANSIENT)))
 136     {
 137       LOG_SQLITE (plugin->dbh,
 138                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 139                   "sqlite3_bind_xxx");
 140       sqlite3_finalize (stmt);
 141       return 0;
 142     }
 143   if (SQLITE_DONE != sqlite3_step (stmt))
 144     {
 145       LOG_SQLITE (plugin->dbh,
 146                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 147                   "sqlite3_step");
 148       sqlite3_finalize (stmt);
 149       return 0;
 150     }
 151   if (SQLITE_OK != sqlite3_finalize (stmt))
 152     LOG_SQLITE (plugin->dbh,
 153                 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 154                 "sqlite3_finalize");
 155   return size + OVERHEAD;
 156 }
 157
 158
 159 /**
 160  * Iterate over the results for a particular key
 161  * in the datastore.
 162  *
 163  * @param cls closure (our "struct Plugin")
 164  * @param key
 165  * @param type entries of which type are relevant?
 166  * @param iter maybe NULL (to just count)
 167  * @param iter_cls closure for iter
 168  * @return the number of results found
 169  */
 170 static unsigned int
 171 sqlite_plugin_get (void *cls,
 172                    const GNUNET_HashCode * key,
 173                    enum GNUNET_BLOCK_Type type,
 174                    GNUNET_DATACACHE_Iterator iter,
 175                    void *iter_cls)
 176 {
 177   struct Plugin *plugin = cls;
 178   sqlite3_stmt *stmt;
 179   struct GNUNET_TIME_Absolute now;
 180   struct GNUNET_TIME_Absolute exp;
 181   unsigned int size;
 182   const char *dat;
 183   unsigned int cnt;
 184   unsigned int off;
 185   unsigned int total;
 186   char scratch[256];
 187   int64_t ntime;
 188
 189   now = GNUNET_TIME_absolute_get ();
 190 #if DEBUG_DATACACHE_SQLITE
 191   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 192               "Processing `%s' for key `%4s'\n",
 193               "GET",
 194               GNUNET_h2s (key));
 195 #endif
 196   if (sq_prepare (plugin->dbh,
 197                   "SELECT count(*) FROM ds090 WHERE key=? AND type=? AND expire >= ?",
 198                   &stmt) != SQLITE_OK)
 199     {
 200       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 201                   _("`%s' failed at %s:%d with error: %s\n"),
 202                   "sq_prepare", __FILE__, __LINE__,
 203                   sqlite3_errmsg (plugin->dbh));
 204       return 0;
 205     }
 206   sqlite3_bind_blob (stmt, 1, key, sizeof (GNUNET_HashCode),
 207                      SQLITE_TRANSIENT);
 208   sqlite3_bind_int (stmt, 2, type);
 209   ntime = (int64_t) now.abs_value;
 210   GNUNET_assert (ntime >= 0);
 211   sqlite3_bind_int64 (stmt, 3, now.abs_value);
 212   if (SQLITE_ROW != sqlite3_step (stmt))
 213     {
 214       LOG_SQLITE (plugin->dbh,
 215                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 216                   "sqlite_step");
 217       sqlite3_finalize (stmt);
 218       return 0;
 219     }
 220   total = sqlite3_column_int (stmt, 0);
 221   sqlite3_finalize (stmt);
 222   if ( (total == 0) || (iter == NULL) )
 223     return total;
 224
 225   cnt = 0;
 226   off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, total);
 227   while (cnt < total)
 228     {
 229       off = (off + 1) % total;
 230       GNUNET_snprintf (scratch,
 231                        sizeof(scratch),
 232                        "SELECT value,expire FROM ds090 WHERE key=? AND type=? AND expire >= ? LIMIT 1 OFFSET %u",
 233                        off);
 234       if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
 235         {
 236           GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 237                       _("`%s' failed at %s:%d with error: %s\n"),
 238                       "sq_prepare", __FILE__, __LINE__,
 239                       sqlite3_errmsg (plugin->dbh));
 240           return cnt;
 241         }
 242       sqlite3_bind_blob (stmt, 1, key, sizeof (GNUNET_HashCode),
 243                          SQLITE_TRANSIENT);
 244       sqlite3_bind_int (stmt, 2, type);
 245       sqlite3_bind_int64 (stmt, 3, now.abs_value);
 246       if (sqlite3_step (stmt) != SQLITE_ROW)
 247         break;
 248       size = sqlite3_column_bytes (stmt, 0);
 249       dat = sqlite3_column_blob (stmt, 0);
 250       exp.abs_value = sqlite3_column_int64 (stmt, 1);
 251       ntime = (int64_t) exp.abs_value;
 252       if (ntime == INT64_MAX)
 253         exp = GNUNET_TIME_UNIT_FOREVER_ABS;
 254       cnt++;
 255       if (GNUNET_OK != iter (iter_cls,
 256                              exp,
 257                              key,
 258                              size,
 259                              dat,
 260                              type))
 261         {
 262           sqlite3_finalize (stmt);
 263           break;
 264         }
 265       sqlite3_finalize (stmt);
 266     }
 267   return cnt;
 268 }
 269
 270
 271 /**
 272  * Delete the entry with the lowest expiration value
 273  * from the datacache right now.
 274  *
 275  * @param cls closure (our "struct Plugin")
 276  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 277  */
 278 static int
 279 sqlite_plugin_del (void *cls)
 280 {
 281   struct Plugin *plugin = cls;
 282   unsigned int dsize;
 283   unsigned int dtype;
 284   sqlite3_stmt *stmt;
 285   sqlite3_stmt *dstmt;
 286   char blob[65536];
 287   GNUNET_HashCode hc;
 288
 289 #if DEBUG_DATACACHE_SQLITE
 290   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 291               "Processing `%s'\n",
 292               "DEL");
 293 #endif
 294   stmt = NULL;
 295   dstmt = NULL;
 296   if (sq_prepare (plugin->dbh,
 297                    "SELECT type, key, value FROM ds090 ORDER BY expire ASC LIMIT 1",
 298                    &stmt) != SQLITE_OK)
 299     {
 300       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 301                   _("`%s' failed at %s:%d with error: %s\n"),
 302                   "sq_prepare", __FILE__, __LINE__, sqlite3_errmsg (plugin->dbh));
 303       if (stmt != NULL)
 304         (void) sqlite3_finalize (stmt);
 305       return GNUNET_SYSERR;
 306     }
 307   if (SQLITE_ROW != sqlite3_step (stmt))
 308     {
 309       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 310                   _("`%s' failed at %s:%d with error: %s\n"),
 311                   "sqlite3_step", __FILE__, __LINE__,
 312                   sqlite3_errmsg (plugin->dbh));
 313       (void) sqlite3_finalize (stmt);
 314       return GNUNET_SYSERR;
 315     }
 316   dtype = sqlite3_column_int (stmt, 0);
 317   GNUNET_break (sqlite3_column_bytes (stmt, 1) == sizeof (GNUNET_HashCode));
 318   dsize = sqlite3_column_bytes (stmt, 2);
 319   GNUNET_assert (dsize <= sizeof (blob));
 320   memcpy (blob, sqlite3_column_blob (stmt, 2), dsize);
 321   memcpy (&hc, sqlite3_column_blob (stmt, 1), sizeof (GNUNET_HashCode));
 322   if (SQLITE_OK != sqlite3_finalize (stmt))
 323     GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 324                 _("`%s' failed at %s:%d with error: %s\n"),
 325                 "sqlite3_step", __FILE__, __LINE__,
 326                 sqlite3_errmsg (plugin->dbh));
 327   if (sq_prepare (plugin->dbh,
 328                   "DELETE FROM ds090 "
 329                   "WHERE key=? AND value=? AND type=?",
 330                   &dstmt) != SQLITE_OK)
 331     {
 332       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 333                   _("`%s' failed at %s:%d with error: %s\n"),
 334                   "sq_prepare", __FILE__, __LINE__, sqlite3_errmsg (plugin->dbh));
 335       if (stmt != NULL)
 336         (void) sqlite3_finalize (stmt);
 337       return GNUNET_SYSERR;
 338     }
 339   if ( (SQLITE_OK !=
 340         sqlite3_bind_blob (dstmt,
 341                            1, &hc,
 342                            sizeof (GNUNET_HashCode),
 343                            SQLITE_TRANSIENT)) ||
 344        (SQLITE_OK !=
 345         sqlite3_bind_blob (dstmt,
 346                            2, blob,
 347                            dsize,
 348                            SQLITE_TRANSIENT)) ||
 349        (SQLITE_OK !=
 350         sqlite3_bind_int (dstmt, 3, dtype)) )
 351     {
 352       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 353                   _("`%s' failed at %s:%d with error: %s\n"),
 354                   "sqlite3_bind", __FILE__, __LINE__,
 355                   sqlite3_errmsg (plugin->dbh));
 356       (void) sqlite3_finalize (dstmt);
 357       return GNUNET_SYSERR;
 358     }
 359   if (sqlite3_step (dstmt) != SQLITE_DONE)
 360     {
 361       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 362                   _("`%s' failed at %s:%d with error: %s\n"),
 363                   "sqlite3_step", __FILE__, __LINE__,
 364                   sqlite3_errmsg (plugin->dbh));
 365       (void) sqlite3_finalize (dstmt);
 366       return GNUNET_SYSERR;
 367     }
 368   plugin->env->delete_notify (plugin->env->cls,
 369                               &hc,
 370                               dsize + OVERHEAD);
 371   if (SQLITE_OK != sqlite3_finalize (dstmt))
 372     GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 373                 _("`%s' failed at %s:%d with error: %s\n"),
 374                 "sqlite3_finalize", __FILE__, __LINE__,
 375                 sqlite3_errmsg (plugin->dbh));
 376   return GNUNET_OK;
 377 }
 378
 379
 380 /**
 381  * Entry point for the plugin.
 382  *
 383  * @param cls closure (the "struct GNUNET_DATACACHE_PluginEnvironmnet")
 384  * @return the plugin's closure (our "struct Plugin")
 385  */
 386 void *
 387 libgnunet_plugin_datacache_sqlite_init (void *cls)
 388 {
 389   struct GNUNET_DATACACHE_PluginEnvironment *env = cls;
 390   struct GNUNET_DATACACHE_PluginFunctions *api;
 391   struct Plugin *plugin;
 392   char *fn;
 393   char *fn_utf8;
 394   sqlite3 *dbh;
 395   char *emsg;
 396
 397   fn = GNUNET_DISK_mktemp ("gnunet-datacache");
 398   if (fn == NULL)
 399     {
 400       GNUNET_break (0);
 401       return NULL;
 402     }
 403 #ifdef ENABLE_NLS
 404   fn_utf8 = GNUNET_STRINGS_to_utf8 (fn, strlen (fn), nl_langinfo (CODESET));
 405 #else
 406   /* good luck */
 407   fn_utf8 = GNUNET_STRINGS_to_utf8 (fn, strlen (fn), "UTF-8");
 408 #endif
 409   if (SQLITE_OK != sqlite3_open (fn_utf8, &dbh))
 410     {
 411       GNUNET_free (fn);
 412       GNUNET_free (fn_utf8);
 413       return NULL;
 414     }
 415   GNUNET_free (fn);
 416
 417   SQLITE3_EXEC (dbh, "PRAGMA temp_store=MEMORY");
 418   SQLITE3_EXEC (dbh, "PRAGMA locking_mode=EXCLUSIVE");
 419   SQLITE3_EXEC (dbh, "PRAGMA journal_mode=OFF");
 420   SQLITE3_EXEC (dbh, "PRAGMA synchronous=OFF");
 421   SQLITE3_EXEC (dbh, "PRAGMA count_changes=OFF");
 422   SQLITE3_EXEC (dbh, "PRAGMA page_size=4092");
 423   SQLITE3_EXEC (dbh,
 424                 "CREATE TABLE ds090 ("
 425                 "  type INTEGER NOT NULL DEFAULT 0,"
 426                 "  expire INTEGER NOT NULL DEFAULT 0,"
 427                 "  key BLOB NOT NULL DEFAULT '',"
 428                 "  value BLOB NOT NULL DEFAULT '')");
 429   SQLITE3_EXEC (dbh, "CREATE INDEX idx_hashidx ON ds090 (key,type,expire)");
 430   plugin = GNUNET_malloc (sizeof (struct Plugin));
 431   plugin->env = env;
 432   plugin->dbh = dbh;
 433   plugin->fn = fn_utf8;
 434   api = GNUNET_malloc (sizeof (struct GNUNET_DATACACHE_PluginFunctions));
 435   api->cls = plugin;
 436   api->get = &sqlite_plugin_get;
 437   api->put = &sqlite_plugin_put;
 438   api->del = &sqlite_plugin_del;
 439   GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
 440                    "sqlite", _("Sqlite datacache running\n"));
 441   return api;
 442 }
 443 // explain SELECT type FROM gn090 WHERE NOT EXISTS (SELECT 1 from gn090 WHERE expire < 42 LIMIT 1) OR expire < 42 ORDER BY repl DESC, Random() LIMIT 1;
 444
 445
 446 /**
 447  * Exit point from the plugin.
 448  *
 449  * @param cls closure (our "struct Plugin")
 450  * @return NULL
 451  */
 452 void *
 453 libgnunet_plugin_datacache_sqlite_done (void *cls)
 454 {
 455   struct GNUNET_DATACACHE_PluginFunctions *api = cls;
 456   struct Plugin *plugin = api->cls;
 457   int result;
 458 #if SQLITE_VERSION_NUMBER >= 3007000
 459   sqlite3_stmt *stmt;
 460 #endif
 461
 462 #if !WINDOWS || defined(__CYGWIN__)
 463   if (0 != UNLINK (plugin->fn))
 464     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 465                               "unlink",
 466                               plugin->fn);
 467   GNUNET_free (plugin->fn);
 468 #endif
 469   result = sqlite3_close (plugin->dbh);
 470 #if SQLITE_VERSION_NUMBER >= 3007000
 471   if (result == SQLITE_BUSY)
 472     {
 473       GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
 474                        "sqlite",
 475                        _("Tried to close sqlite without finalizing all prepared statements.\n"));
 476       stmt = sqlite3_next_stmt(plugin->dbh, NULL);
 477       while (stmt != NULL)
 478         {
 479 #if DEBUG_SQLITE
 480           GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 481                            "sqlite", "Closing statement %p\n", stmt);
 482 #endif
 483           result = sqlite3_finalize(stmt);
 484 #if DEBUG_SQLITE
 485           if (result != SQLITE_OK)
 486             GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 487                              "sqlite",
 488                              "Failed to close statement %p: %d\n", stmt, result);
 489 #endif
 490           stmt = sqlite3_next_stmt(plugin->dbh, NULL);
 491         }
 492       result = sqlite3_close(plugin->dbh);
 493     }
 494 #endif
 495   if (SQLITE_OK != result)
 496     LOG_SQLITE (plugin->dbh,
 497                 GNUNET_ERROR_TYPE_ERROR,
 498                 "sqlite3_close");
 499
 500 #if WINDOWS && !defined(__CYGWIN__)
 501   if (0 != UNLINK (plugin->fn))
 502     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 503                               "unlink",
 504                               plugin->fn);
 505   GNUNET_free (plugin->fn);
 506 #endif
 507   GNUNET_free (plugin);
 508   GNUNET_free (api);
 509   return NULL;
 510 }
 511
 512
 513
 514 /* end of plugin_datacache_sqlite.c */
 515