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 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 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 "plugin_datacache.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 key key to store data under
  90  * @param size number of bytes in data
  91  * @param data data to store
  92  * @param type type of the value
  93  * @param discard_time when to discard the value in any case
  94  * @return 0 on error, number of bytes used otherwise
  95  */
  96 static uint32_t
  97 sqlite_plugin_put (void *cls,
  98                    const GNUNET_HashCode * key,
  99                    uint32_t size,
 100                    const char *data,
 101                    uint32_t type,
 102                    struct GNUNET_TIME_Absolute discard_time)
 103 {
 104   struct Plugin *plugin = cls;
 105   sqlite3_stmt *stmt;
 106
 107 #if DEBUG_DATACACHE_SQLITE
 108   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 109               "Processing `%s' of %u bytes with key `%4s' and expiration %llums\n",
 110               "PUT",
 111               (unsigned int) size,
 112               GNUNET_h2s (key),
 113               (unsigned long long) GNUNET_TIME_absolute_get_remaining (discard_time).value);
 114 #endif
 115   if (sq_prepare (plugin->dbh,
 116                   "INSERT INTO ds090 "
 117                   "(type, expire, key, value) "
 118                   "VALUES (?, ?, ?, ?)", &stmt) != SQLITE_OK)
 119     {
 120       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 121                   _("`%s' failed at %s:%d with error: %s\n"),
 122                   "sq_prepare", __FILE__, __LINE__,
 123                   sqlite3_errmsg (plugin->dbh));
 124       return 0;
 125     }
 126   if ( (SQLITE_OK != sqlite3_bind_int (stmt, 1, type)) ||
 127        (SQLITE_OK != sqlite3_bind_int64 (stmt, 2, discard_time.value)) ||
 128        (SQLITE_OK != sqlite3_bind_blob (stmt, 3, key, sizeof (GNUNET_HashCode),
 129                                         SQLITE_TRANSIENT)) ||
 130        (SQLITE_OK != sqlite3_bind_blob (stmt, 4, data, size, SQLITE_TRANSIENT)))
 131     {
 132       LOG_SQLITE (plugin->dbh,
 133                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 134                   "sqlite3_bind_xxx");
 135       sqlite3_finalize (stmt);
 136       return 0;
 137     }
 138   if (SQLITE_DONE != sqlite3_step (stmt))
 139     {
 140       LOG_SQLITE (plugin->dbh,
 141                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 142                   "sqlite3_step");
 143       sqlite3_finalize (stmt);
 144       return 0;
 145     }
 146   if (SQLITE_OK != sqlite3_finalize (stmt))
 147     LOG_SQLITE (plugin->dbh,
 148                 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 149                 "sqlite3_finalize");
 150   return size + OVERHEAD;
 151 }
 152
 153
 154 /**
 155  * Iterate over the results for a particular key
 156  * in the datastore.
 157  *
 158  * @param key
 159  * @param type entries of which type are relevant?
 160  * @param iter maybe NULL (to just count)
 161  * @return the number of results found
 162  */
 163 static unsigned int
 164 sqlite_plugin_get (void *cls,
 165                    const GNUNET_HashCode * key,
 166                    uint32_t type,
 167                    GNUNET_DATACACHE_Iterator iter,
 168                    void *iter_cls)
 169 {
 170   struct Plugin *plugin = cls;
 171   sqlite3_stmt *stmt;
 172   struct GNUNET_TIME_Absolute now;
 173   unsigned int size;
 174   const char *dat;
 175   unsigned int cnt;
 176   unsigned int off;
 177   unsigned int total;
 178   char scratch[256];
 179
 180   now = GNUNET_TIME_absolute_get ();
 181 #if DEBUG_DATACACHE_SQLITE
 182   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 183               "Processing `%s' for key `%4s'\n",
 184               "GET",
 185               GNUNET_h2s (key));
 186 #endif
 187   if (sq_prepare (plugin->dbh,
 188                   "SELECT count(*) FROM ds090 WHERE key=? AND type=? AND expire >= ?",
 189                   &stmt) != SQLITE_OK)
 190     {
 191       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 192                   _("`%s' failed at %s:%d with error: %s\n"),
 193                   "sq_prepare", __FILE__, __LINE__,
 194                   sqlite3_errmsg (plugin->dbh));
 195       return 0;
 196     }
 197   sqlite3_bind_blob (stmt, 1, key, sizeof (GNUNET_HashCode),
 198                      SQLITE_TRANSIENT);
 199   sqlite3_bind_int (stmt, 2, type);
 200   sqlite3_bind_int64 (stmt, 3, now.value);
 201   if (SQLITE_ROW != sqlite3_step (stmt))
 202     {
 203       LOG_SQLITE (plugin->dbh,
 204                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 205                   "sqlite_step");
 206       sqlite3_finalize (stmt);
 207       return 0;
 208     }
 209   total = sqlite3_column_int (stmt, 0);
 210   sqlite3_finalize (stmt);
 211   if ( (total == 0) || (iter == NULL) )
 212     return total;
 213
 214   cnt = 0;
 215   off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, total);
 216   while (cnt < total)
 217     {
 218       off = (off + 1) % total;
 219       GNUNET_snprintf (scratch,
 220                        sizeof(scratch),
 221                        "SELECT value FROM ds090 WHERE key=? AND type=? AND expire >= ? LIMIT 1 OFFSET %u",
 222                        off);
 223       if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
 224         {
 225           GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 226                       _("`%s' failed at %s:%d with error: %s\n"),
 227                       "sq_prepare", __FILE__, __LINE__,
 228                       sqlite3_errmsg (plugin->dbh));
 229           return cnt;
 230         }
 231       sqlite3_bind_blob (stmt, 1, key, sizeof (GNUNET_HashCode),
 232                          SQLITE_TRANSIENT);
 233       sqlite3_bind_int (stmt, 2, type);
 234       sqlite3_bind_int64 (stmt, 3, now.value);
 235       if (sqlite3_step (stmt) != SQLITE_ROW)
 236         break;
 237       size = sqlite3_column_bytes (stmt, 0);
 238       dat = sqlite3_column_blob (stmt, 0);
 239       cnt++;
 240       if (GNUNET_OK != iter (iter_cls,
 241                              key,
 242                              size,
 243                              dat,
 244                              type))
 245         {
 246           sqlite3_finalize (stmt);
 247           break;
 248         }
 249       sqlite3_finalize (stmt);
 250     }
 251   return cnt;
 252 }
 253
 254
 255 /**
 256  * Delete the entry with the lowest expiration value
 257  * from the datacache right now.
 258  *
 259  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 260  */
 261 static int
 262 sqlite_plugin_del (void *cls)
 263 {
 264   struct Plugin *plugin = cls;
 265   unsigned int dsize;
 266   unsigned int dtype;
 267   sqlite3_stmt *stmt;
 268   sqlite3_stmt *dstmt;
 269
 270 #if DEBUG_DATACACHE_SQLITE
 271   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 272               "Processing `%s'\n",
 273               "DEL");
 274 #endif
 275   stmt = NULL;
 276   dstmt = NULL;
 277   if ((sq_prepare (plugin->dbh,
 278                    "SELECT type, key, value FROM ds090 ORDER BY expire ASC LIMIT 1",
 279                    &stmt) != SQLITE_OK) ||
 280       (sq_prepare (plugin->dbh,
 281                    "DELETE FROM ds090 "
 282                    "WHERE key=? AND value=? AND type=?",
 283                    &dstmt) != SQLITE_OK))
 284     {
 285       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 286                   _("`%s' failed at %s:%d with error: %s\n"),
 287                   "sq_prepare", __FILE__, __LINE__, sqlite3_errmsg (plugin->dbh));
 288       if (dstmt != NULL)
 289         sqlite3_finalize (dstmt);
 290       if (stmt != NULL)
 291         sqlite3_finalize (stmt);
 292       return GNUNET_SYSERR;
 293     }
 294   if (SQLITE_ROW != sqlite3_step (stmt))
 295     {
 296       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 297                   _("`%s' failed at %s:%d with error: %s\n"),
 298                   "sqlite3_step", __FILE__, __LINE__,
 299                   sqlite3_errmsg (plugin->dbh));
 300       sqlite3_finalize (dstmt);
 301       sqlite3_finalize (stmt);
 302       return GNUNET_SYSERR;
 303     }
 304   dtype = sqlite3_column_int (stmt, 0);
 305   GNUNET_break (sqlite3_column_bytes (stmt, 1) == sizeof (GNUNET_HashCode));
 306   dsize = sqlite3_column_bytes (stmt, 2);
 307   sqlite3_bind_blob (dstmt,
 308                      1, sqlite3_column_blob (stmt, 1),
 309                      sizeof (GNUNET_HashCode),
 310                      SQLITE_TRANSIENT);
 311   sqlite3_bind_blob (dstmt,
 312                      2, sqlite3_column_blob (stmt, 2),
 313                      dsize,
 314                      SQLITE_TRANSIENT);
 315   sqlite3_bind_int (dstmt, 3, dtype);
 316   if (sqlite3_step (dstmt) != SQLITE_DONE)
 317     {
 318       GNUNET_log (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
 319                   _("`%s' failed at %s:%d with error: %s\n"),
 320                   "sqlite3_step", __FILE__, __LINE__,
 321                   sqlite3_errmsg (plugin->dbh));
 322       sqlite3_finalize (dstmt);
 323       sqlite3_finalize (stmt);
 324       return GNUNET_SYSERR;
 325     }
 326   plugin->env->delete_notify (plugin->env->cls,
 327                               sqlite3_column_blob (stmt, 1),
 328                               dsize + OVERHEAD);
 329   sqlite3_finalize (dstmt);
 330   sqlite3_finalize (stmt);
 331   return GNUNET_OK;
 332 }
 333
 334
 335 /**
 336  * Entry point for the plugin.
 337  */
 338 void *
 339 libgnunet_plugin_datacache_sqlite_init (void *cls)
 340 {
 341   struct GNUNET_DATACACHE_PluginEnvironment *env = cls;
 342   struct GNUNET_DATACACHE_PluginFunctions *api;
 343   struct Plugin *plugin;
 344   char *fn;
 345   char *fn_utf8;
 346   int fd;
 347   sqlite3 *dbh;
 348   char *tmpl;
 349   const char *tmpdir;
 350   char *emsg;
 351
 352   tmpdir = getenv ("TMPDIR");
 353   tmpdir = tmpdir ? tmpdir : "/tmp";
 354
 355 #define TEMPLATE "/gnunet-dstoreXXXXXX"
 356   tmpl = GNUNET_malloc (strlen (tmpdir) + sizeof (TEMPLATE) + 1);
 357   strcpy (tmpl, tmpdir);
 358   strcat (tmpl, TEMPLATE);
 359 #undef TEMPLATE
 360 #ifdef MINGW
 361   fn = (char *) GNUNET_malloc (MAX_PATH + 1);
 362   plibc_conv_to_win_path (tmpl, fn);
 363   GNUNET_free (tmpl);
 364 #else
 365   fn = tmpl;
 366 #endif
 367   fd = mkstemp (fn);
 368   if (fd == -1)
 369     {
 370       GNUNET_break (0);
 371       GNUNET_free (fn);
 372       return NULL;
 373     }
 374   CLOSE (fd);
 375   fn_utf8 = GNUNET_STRINGS_to_utf8 (fn, strlen (fn),
 376 #ifdef ENABLE_NLS
 377                                     nl_langinfo (CODESET)
 378 #else
 379                                     "UTF-8"      /* good luck */
 380 #endif
 381     );
 382   if (SQLITE_OK != sqlite3_open (fn_utf8, &dbh))
 383     {
 384       GNUNET_free (fn);
 385       GNUNET_free (fn_utf8);
 386       return NULL;
 387     }
 388   GNUNET_free (fn);
 389
 390   SQLITE3_EXEC (dbh, "PRAGMA temp_store=MEMORY");
 391   SQLITE3_EXEC (dbh, "PRAGMA synchronous=OFF");
 392   SQLITE3_EXEC (dbh, "PRAGMA count_changes=OFF");
 393   SQLITE3_EXEC (dbh, "PRAGMA page_size=4092");
 394   SQLITE3_EXEC (dbh,
 395                 "CREATE TABLE ds090 ("
 396                 "  type INTEGER NOT NULL DEFAULT 0,"
 397                 "  expire INTEGER NOT NULL DEFAULT 0,"
 398                 "  key BLOB NOT NULL DEFAULT '',"
 399                 "  value BLOB NOT NULL DEFAULT '')");
 400   SQLITE3_EXEC (dbh, "CREATE INDEX idx_hashidx ON ds090 (key,type,expire)");
 401   plugin = GNUNET_malloc (sizeof (struct Plugin));
 402   plugin->env = env;
 403   plugin->dbh = dbh;
 404   plugin->fn = fn_utf8;
 405   api = GNUNET_malloc (sizeof (struct GNUNET_DATACACHE_PluginFunctions));
 406   api->cls = plugin;
 407   api->get = &sqlite_plugin_get;
 408   api->put = &sqlite_plugin_put;
 409   api->del = &sqlite_plugin_del;
 410   GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
 411                    "sqlite", _("Sqlite datacache running\n"));
 412   return api;
 413 }
 414
 415
 416 /**
 417  * Exit point from the plugin.
 418  */
 419 void *
 420 libgnunet_plugin_datacache_sqlite_done (void *cls)
 421 {
 422   struct GNUNET_DATACACHE_PluginFunctions *api = cls;
 423   struct Plugin *plugin = api->cls;
 424
 425   UNLINK (plugin->fn);
 426   GNUNET_free (plugin->fn);
 427   sqlite3_close (plugin->dbh);
 428   GNUNET_free (plugin);
 429   GNUNET_free (api);
 430   return NULL;
 431 }
 432
 433
 434
 435 /* end of plugin_datacache_sqlite.c */
 436