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   ntime = (int64_t) now.abs_value;
 207   GNUNET_assert (ntime >= 0);
 208   if ( (SQLITE_OK !=
 209         sqlite3_bind_blob (stmt, 1, key, sizeof (GNUNET_HashCode),
 210                            SQLITE_TRANSIENT)) ||
 211        (SQLITE_OK !=
 212         sqlite3_bind_int (stmt, 2, type)) ||
 213        (SQLITE_OK !=
 214         sqlite3_bind_int64 (stmt, 3, now.abs_value)) )
 215     {
 216       LOG_SQLITE (plugin->dbh,
 217                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 218                   "sqlite3_bind_xxx");
 219       sqlite3_finalize (stmt);
 220       return 0;
 221     }
 222
 223   if (SQLITE_ROW != sqlite3_step (stmt))
 224     {
 225       LOG_SQLITE (plugin->dbh,
 226                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 227                   "sqlite_step");
 228       sqlite3_finalize (stmt);
 229       return 0;
 230     }
 231   total = sqlite3_column_int (stmt, 0);
 232   sqlite3_finalize (stmt);
 233   if ( (total == 0) || (iter == NULL) )
 234     return total;
 235
 236   cnt = 0;
 237   off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, total);
 238   while (cnt < total)
 239     {
 240       off = (off + 1) % total;
 241       GNUNET_snprintf (scratch,
 242                        sizeof(scratch),
 243                        "SELECT value,expire FROM ds090 WHERE key=? AND type=? AND expire >= ? LIMIT 1 OFFSET %u",
 244                        off);
 245       if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
 246         {
 247           GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 248                       _("`%s' failed at %s:%d with error: %s\n"),
 249                       "sq_prepare", __FILE__, __LINE__,
 250                       sqlite3_errmsg (plugin->dbh));
 251           return cnt;
 252         }
 253       if ( (SQLITE_OK !=
 254             sqlite3_bind_blob (stmt, 1, key, sizeof (GNUNET_HashCode),
 255                                SQLITE_TRANSIENT)) ||
 256            (SQLITE_OK !=
 257             sqlite3_bind_int (stmt, 2, type)) ||
 258            (SQLITE_OK !=
 259             sqlite3_bind_int64 (stmt, 3, now.abs_value)) )
 260         {
 261           LOG_SQLITE (plugin->dbh,
 262                       GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 263                       "sqlite3_bind_xxx");
 264           sqlite3_finalize (stmt);
 265           return cnt;
 266         }
 267       if (sqlite3_step (stmt) != SQLITE_ROW)
 268         break;
 269       size = sqlite3_column_bytes (stmt, 0);
 270       dat = sqlite3_column_blob (stmt, 0);
 271       exp.abs_value = sqlite3_column_int64 (stmt, 1);
 272       ntime = (int64_t) exp.abs_value;
 273       if (ntime == INT64_MAX)
 274         exp = GNUNET_TIME_UNIT_FOREVER_ABS;
 275       cnt++;
 276       if (GNUNET_OK != iter (iter_cls,
 277                              exp,
 278                              key,
 279                              size,
 280                              dat,
 281                              type))
 282         {
 283           sqlite3_finalize (stmt);
 284           break;
 285         }
 286       sqlite3_finalize (stmt);
 287     }
 288   return cnt;
 289 }
 290
 291
 292 /**
 293  * Delete the entry with the lowest expiration value
 294  * from the datacache right now.
 295  *
 296  * @param cls closure (our "struct Plugin")
 297  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 298  */
 299 static int
 300 sqlite_plugin_del (void *cls)
 301 {
 302   struct Plugin *plugin = cls;
 303   unsigned int dsize;
 304   unsigned int dtype;
 305   sqlite3_stmt *stmt;
 306   sqlite3_stmt *dstmt;
 307   char blob[65536];
 308   GNUNET_HashCode hc;
 309
 310 #if DEBUG_DATACACHE_SQLITE
 311   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 312               "Processing `%s'\n",
 313               "DEL");
 314 #endif
 315   stmt = NULL;
 316   dstmt = NULL;
 317   if (sq_prepare (plugin->dbh,
 318                    "SELECT type, key, value FROM ds090 ORDER BY expire ASC LIMIT 1",
 319                    &stmt) != SQLITE_OK)
 320     {
 321       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 322                   _("`%s' failed at %s:%d with error: %s\n"),
 323                   "sq_prepare", __FILE__, __LINE__, sqlite3_errmsg (plugin->dbh));
 324       if (stmt != NULL)
 325         (void) sqlite3_finalize (stmt);
 326       return GNUNET_SYSERR;
 327     }
 328   if (SQLITE_ROW != sqlite3_step (stmt))
 329     {
 330       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 331                   _("`%s' failed at %s:%d with error: %s\n"),
 332                   "sqlite3_step", __FILE__, __LINE__,
 333                   sqlite3_errmsg (plugin->dbh));
 334       (void) sqlite3_finalize (stmt);
 335       return GNUNET_SYSERR;
 336     }
 337   dtype = sqlite3_column_int (stmt, 0);
 338   GNUNET_break (sqlite3_column_bytes (stmt, 1) == sizeof (GNUNET_HashCode));
 339   dsize = sqlite3_column_bytes (stmt, 2);
 340   GNUNET_assert (dsize <= sizeof (blob));
 341   memcpy (blob, sqlite3_column_blob (stmt, 2), dsize);
 342   memcpy (&hc, sqlite3_column_blob (stmt, 1), sizeof (GNUNET_HashCode));
 343   if (SQLITE_OK != sqlite3_finalize (stmt))
 344     GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 345                 _("`%s' failed at %s:%d with error: %s\n"),
 346                 "sqlite3_step", __FILE__, __LINE__,
 347                 sqlite3_errmsg (plugin->dbh));
 348   if (sq_prepare (plugin->dbh,
 349                   "DELETE FROM ds090 "
 350                   "WHERE key=? AND value=? AND type=?",
 351                   &dstmt) != SQLITE_OK)
 352     {
 353       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 354                   _("`%s' failed at %s:%d with error: %s\n"),
 355                   "sq_prepare", __FILE__, __LINE__, sqlite3_errmsg (plugin->dbh));
 356       if (stmt != NULL)
 357         (void) sqlite3_finalize (stmt);
 358       return GNUNET_SYSERR;
 359     }
 360   if ( (SQLITE_OK !=
 361         sqlite3_bind_blob (dstmt,
 362                            1, &hc,
 363                            sizeof (GNUNET_HashCode),
 364                            SQLITE_TRANSIENT)) ||
 365        (SQLITE_OK !=
 366         sqlite3_bind_blob (dstmt,
 367                            2, blob,
 368                            dsize,
 369                            SQLITE_TRANSIENT)) ||
 370        (SQLITE_OK !=
 371         sqlite3_bind_int (dstmt, 3, dtype)) )
 372     {
 373       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 374                   _("`%s' failed at %s:%d with error: %s\n"),
 375                   "sqlite3_bind", __FILE__, __LINE__,
 376                   sqlite3_errmsg (plugin->dbh));
 377       (void) sqlite3_finalize (dstmt);
 378       return GNUNET_SYSERR;
 379     }
 380   if (sqlite3_step (dstmt) != SQLITE_DONE)
 381     {
 382       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 383                   _("`%s' failed at %s:%d with error: %s\n"),
 384                   "sqlite3_step", __FILE__, __LINE__,
 385                   sqlite3_errmsg (plugin->dbh));
 386       (void) sqlite3_finalize (dstmt);
 387       return GNUNET_SYSERR;
 388     }
 389   plugin->env->delete_notify (plugin->env->cls,
 390                               &hc,
 391                               dsize + OVERHEAD);
 392   if (SQLITE_OK != sqlite3_finalize (dstmt))
 393     GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 394                 _("`%s' failed at %s:%d with error: %s\n"),
 395                 "sqlite3_finalize", __FILE__, __LINE__,
 396                 sqlite3_errmsg (plugin->dbh));
 397   return GNUNET_OK;
 398 }
 399
 400
 401 /**
 402  * Entry point for the plugin.
 403  *
 404  * @param cls closure (the "struct GNUNET_DATACACHE_PluginEnvironmnet")
 405  * @return the plugin's closure (our "struct Plugin")
 406  */
 407 void *
 408 libgnunet_plugin_datacache_sqlite_init (void *cls)
 409 {
 410   struct GNUNET_DATACACHE_PluginEnvironment *env = cls;
 411   struct GNUNET_DATACACHE_PluginFunctions *api;
 412   struct Plugin *plugin;
 413   char *fn;
 414   char *fn_utf8;
 415   sqlite3 *dbh;
 416   char *emsg;
 417
 418   fn = GNUNET_DISK_mktemp ("gnunet-datacache");
 419   if (fn == NULL)
 420     {
 421       GNUNET_break (0);
 422       return NULL;
 423     }
 424 #ifdef ENABLE_NLS
 425   fn_utf8 = GNUNET_STRINGS_to_utf8 (fn, strlen (fn), nl_langinfo (CODESET));
 426 #else
 427   /* good luck */
 428   fn_utf8 = GNUNET_STRINGS_to_utf8 (fn, strlen (fn), "UTF-8");
 429 #endif
 430   if (SQLITE_OK != sqlite3_open (fn_utf8, &dbh))
 431     {
 432       GNUNET_free (fn);
 433       GNUNET_free (fn_utf8);
 434       return NULL;
 435     }
 436   GNUNET_free (fn);
 437
 438   SQLITE3_EXEC (dbh, "PRAGMA temp_store=MEMORY");
 439   SQLITE3_EXEC (dbh, "PRAGMA locking_mode=EXCLUSIVE");
 440   SQLITE3_EXEC (dbh, "PRAGMA journal_mode=OFF");
 441   SQLITE3_EXEC (dbh, "PRAGMA synchronous=OFF");
 442   SQLITE3_EXEC (dbh, "PRAGMA count_changes=OFF");
 443   SQLITE3_EXEC (dbh, "PRAGMA page_size=4092");
 444   SQLITE3_EXEC (dbh,
 445                 "CREATE TABLE ds090 ("
 446                 "  type INTEGER NOT NULL DEFAULT 0,"
 447                 "  expire INTEGER NOT NULL DEFAULT 0,"
 448                 "  key BLOB NOT NULL DEFAULT '',"
 449                 "  value BLOB NOT NULL DEFAULT '')");
 450   SQLITE3_EXEC (dbh, "CREATE INDEX idx_hashidx ON ds090 (key,type,expire)");
 451   plugin = GNUNET_malloc (sizeof (struct Plugin));
 452   plugin->env = env;
 453   plugin->dbh = dbh;
 454   plugin->fn = fn_utf8;
 455   api = GNUNET_malloc (sizeof (struct GNUNET_DATACACHE_PluginFunctions));
 456   api->cls = plugin;
 457   api->get = &sqlite_plugin_get;
 458   api->put = &sqlite_plugin_put;
 459   api->del = &sqlite_plugin_del;
 460   GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
 461                    "sqlite", _("Sqlite datacache running\n"));
 462   return api;
 463 }
 464 // 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;
 465
 466
 467 /**
 468  * Exit point from the plugin.
 469  *
 470  * @param cls closure (our "struct Plugin")
 471  * @return NULL
 472  */
 473 void *
 474 libgnunet_plugin_datacache_sqlite_done (void *cls)
 475 {
 476   struct GNUNET_DATACACHE_PluginFunctions *api = cls;
 477   struct Plugin *plugin = api->cls;
 478   int result;
 479 #if SQLITE_VERSION_NUMBER >= 3007000
 480   sqlite3_stmt *stmt;
 481 #endif
 482
 483 #if !WINDOWS || defined(__CYGWIN__)
 484   if (0 != UNLINK (plugin->fn))
 485     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 486                               "unlink",
 487                               plugin->fn);
 488   GNUNET_free (plugin->fn);
 489 #endif
 490   result = sqlite3_close (plugin->dbh);
 491 #if SQLITE_VERSION_NUMBER >= 3007000
 492   if (result == SQLITE_BUSY)
 493     {
 494       GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
 495                        "sqlite",
 496                        _("Tried to close sqlite without finalizing all prepared statements.\n"));
 497       stmt = sqlite3_next_stmt(plugin->dbh, NULL);
 498       while (stmt != NULL)
 499         {
 500 #if DEBUG_SQLITE
 501           GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 502                            "sqlite", "Closing statement %p\n", stmt);
 503 #endif
 504           result = sqlite3_finalize(stmt);
 505 #if DEBUG_SQLITE
 506           if (result != SQLITE_OK)
 507             GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
 508                              "sqlite",
 509                              "Failed to close statement %p: %d\n", stmt, result);
 510 #endif
 511           stmt = sqlite3_next_stmt(plugin->dbh, NULL);
 512         }
 513       result = sqlite3_close(plugin->dbh);
 514     }
 515 #endif
 516   if (SQLITE_OK != result)
 517     LOG_SQLITE (plugin->dbh,
 518                 GNUNET_ERROR_TYPE_ERROR,
 519                 "sqlite3_close");
 520
 521 #if WINDOWS && !defined(__CYGWIN__)
 522   if (0 != UNLINK (plugin->fn))
 523     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
 524                               "unlink",
 525                               plugin->fn);
 526   GNUNET_free (plugin->fn);
 527 #endif
 528   GNUNET_free (plugin);
 529   GNUNET_free (api);
 530   return NULL;
 531 }
 532
 533
 534
 535 /* end of plugin_datacache_sqlite.c */
 536