2 * This file is part of GNUnet
3 * Copyright (C) 2009, 2011 GNUnet e.V.
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.
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.
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., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
22 * @file datastore/plugin_datastore_sqlite.c
23 * @brief sqlite-based datastore backend
24 * @author Christian Grothoff
28 #include "gnunet_datastore_plugin.h"
33 * We allocate items on the stack at times. To prevent a stack
34 * overflow, we impose a limit on the maximum size for the data per
35 * item. 64k should be enough.
37 #define MAX_ITEM_SIZE 65536
40 * After how many ms "busy" should a DB operation fail for good?
41 * A low value makes sure that we are more responsive to requests
42 * (especially PUTs). A high value guarantees a higher success
43 * rate (SELECTs in iterate can take several seconds despite LIMIT=1).
45 * The default value of 250ms should ensure that users do not experience
46 * huge latencies while at the same time allowing operations to succeed
47 * with reasonable probability.
49 #define BUSY_TIMEOUT_MS 250
53 * Log an error message at log-level 'level' that indicates
54 * a failure of the command 'cmd' on file 'filename'
55 * with the message given by strerror(errno).
57 #define LOG_SQLITE(db, level, cmd) do { GNUNET_log_from (level, "sqlite", _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db->dbh)); } while(0)
61 * Log an error message at log-level 'level' that indicates
62 * a failure of the command 'cmd' on file 'filename'
63 * with the message given by strerror(errno).
65 #define LOG_SQLITE_MSG(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)); GNUNET_asprintf(msg, _("`%s' failed at %s:%u with error: %s"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db->dbh)); } while(0)
70 * Context for all functions in this plugin.
75 * Our execution environment.
77 struct GNUNET_DATASTORE_PluginEnvironment *env;
85 * Native SQLite database handle.
90 * Precompiled SQL for deletion.
95 * Precompiled SQL for update.
97 sqlite3_stmt *updPrio;
100 * Get maximum repl value in database.
102 sqlite3_stmt *maxRepl;
105 * Precompiled SQL for replication decrement.
107 sqlite3_stmt *updRepl;
110 * Precompiled SQL for replication selection.
112 sqlite3_stmt *selRepl;
115 * Precompiled SQL for expiration selection.
117 sqlite3_stmt *selExpi;
120 * Precompiled SQL for expiration selection.
122 sqlite3_stmt *selZeroAnon;
125 * Precompiled SQL for insertion.
127 sqlite3_stmt *insertContent;
130 * Should the database be dropped on shutdown?
132 int drop_on_shutdown;
138 * @brief Prepare a SQL statement
140 * @param dbh handle to the database
141 * @param zSql SQL statement, UTF-8 encoded
142 * @param ppStmt set to the prepared statement
143 * @return 0 on success
146 sq_prepare (sqlite3 *dbh,
148 sqlite3_stmt **ppStmt)
154 sqlite3_prepare_v2 (dbh, zSql, strlen (zSql), ppStmt,
155 (const char **) &dummy);
156 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
157 "Prepared `%s' / %p: %d\n", zSql, *ppStmt, result);
163 * Create our database indices.
165 * @param dbh handle to the database
168 create_indices (sqlite3 * dbh)
172 sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS idx_hash ON gn090 (hash)",
173 NULL, NULL, NULL)) ||
176 "CREATE INDEX IF NOT EXISTS idx_hash_vhash ON gn090 (hash,vhash)",
177 NULL, NULL, NULL)) ||
180 "CREATE INDEX IF NOT EXISTS idx_expire_repl ON gn090 (expire ASC,repl DESC)",
181 NULL, NULL, NULL)) ||
184 "CREATE INDEX IF NOT EXISTS idx_comb ON gn090 (anonLevel ASC,expire ASC,prio,type,hash)",
185 NULL, NULL, NULL)) ||
188 "CREATE INDEX IF NOT EXISTS idx_anon_type_hash ON gn090 (anonLevel ASC,type,hash)",
189 NULL, NULL, NULL)) ||
192 "CREATE INDEX IF NOT EXISTS idx_expire ON gn090 (expire ASC)",
193 NULL, NULL, NULL)) ||
196 "CREATE INDEX IF NOT EXISTS idx_repl_rvalue ON gn090 (repl,rvalue)",
197 NULL, NULL, NULL)) ||
200 "CREATE INDEX IF NOT EXISTS idx_repl ON gn090 (repl DESC)",
202 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "sqlite",
203 "Failed to create indices: %s\n", sqlite3_errmsg (dbh));
208 #define CHECK(a) GNUNET_break(a)
212 #define ENULL_DEFINED 1
213 #define CHECK(a) if (! (a)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "%s\n", e); sqlite3_free(e); }
218 * Initialize the database connections and associated
219 * data structures (create tables and indices
220 * as needed as well).
222 * @param cfg our configuration
223 * @param plugin the plugin context (state for this module)
224 * @return #GNUNET_OK on success
227 database_setup (const struct GNUNET_CONFIGURATION_Handle *cfg,
228 struct Plugin *plugin)
238 GNUNET_CONFIGURATION_get_value_filename (cfg, "datastore-sqlite",
239 "FILENAME", &afsdir))
241 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
242 "datastore-sqlite", "FILENAME");
243 return GNUNET_SYSERR;
245 if (GNUNET_OK != GNUNET_DISK_file_test (afsdir))
247 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (afsdir))
250 GNUNET_free (afsdir);
251 return GNUNET_SYSERR;
253 /* database is new or got deleted, reset payload to zero! */
254 plugin->env->duc (plugin->env->cls, 0);
256 /* afsdir should be UTF-8-encoded. If it isn't, it's a bug */
259 /* Open database and precompile statements */
260 if (sqlite3_open (plugin->fn, &plugin->dbh) != SQLITE_OK)
262 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR, "sqlite",
263 _("Unable to initialize SQLite: %s.\n"),
264 sqlite3_errmsg (plugin->dbh));
265 return GNUNET_SYSERR;
268 sqlite3_exec (plugin->dbh, "PRAGMA temp_store=MEMORY", NULL, NULL,
271 sqlite3_exec (plugin->dbh, "PRAGMA synchronous=OFF", NULL, NULL,
274 sqlite3_exec (plugin->dbh, "PRAGMA legacy_file_format=OFF", NULL, NULL,
277 sqlite3_exec (plugin->dbh, "PRAGMA auto_vacuum=INCREMENTAL", NULL,
280 sqlite3_exec (plugin->dbh, "PRAGMA locking_mode=EXCLUSIVE", NULL, NULL,
283 sqlite3_exec (plugin->dbh, "PRAGMA page_size=4092", NULL, NULL,
286 CHECK (SQLITE_OK == sqlite3_busy_timeout (plugin->dbh, BUSY_TIMEOUT_MS));
289 /* We have to do it here, because otherwise precompiling SQL might fail */
291 sq_prepare (plugin->dbh,
292 "SELECT 1 FROM sqlite_master WHERE tbl_name = 'gn090'",
295 /* FIXME: SQLite does not have unsigned integers! This is ok for the type column because
296 * we only test equality on it and can cast it to/from uint32_t. For repl, prio, and anonLevel
297 * we do math or inequality tests, so we can't handle the entire range of uint32_t.
298 * This will also cause problems for expiration times after 294247-01-10-04:00:54 UTC.
300 if ((sqlite3_step (stmt) == SQLITE_DONE) &&
303 "CREATE TABLE gn090 (" " repl INT4 NOT NULL DEFAULT 0,"
304 " type INT4 NOT NULL DEFAULT 0," " prio INT4 NOT NULL DEFAULT 0,"
305 " anonLevel INT4 NOT NULL DEFAULT 0,"
306 " expire INT8 NOT NULL DEFAULT 0," " rvalue INT8 NOT NULL,"
307 " hash TEXT NOT NULL DEFAULT ''," " vhash TEXT NOT NULL DEFAULT '',"
308 " value BLOB NOT NULL DEFAULT '')", NULL, NULL, NULL) != SQLITE_OK))
310 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite3_exec");
311 sqlite3_finalize (stmt);
312 return GNUNET_SYSERR;
314 sqlite3_finalize (stmt);
315 create_indices (plugin->dbh);
320 "SET prio = prio + ?, expire = MAX(expire,?) WHERE _ROWID_ = ?",
321 &plugin->updPrio) != SQLITE_OK) ||
324 "UPDATE gn090 " "SET repl = MAX (0, repl - 1) WHERE _ROWID_ = ?",
325 &plugin->updRepl) != SQLITE_OK) ||
328 "SELECT type,prio,anonLevel,expire,hash,value,_ROWID_ " "FROM gn090 "
329 #if SQLITE_VERSION_NUMBER >= 3007000
330 "INDEXED BY idx_repl_rvalue "
332 "WHERE repl=?2 AND " " (rvalue>=?1 OR "
333 " NOT EXISTS (SELECT 1 FROM gn090 "
334 #if SQLITE_VERSION_NUMBER >= 3007000
335 "INDEXED BY idx_repl_rvalue "
337 "WHERE repl=?2 AND rvalue>=?1 LIMIT 1) ) "
338 "ORDER BY rvalue ASC LIMIT 1", &plugin->selRepl) != SQLITE_OK) ||
339 (sq_prepare (plugin->dbh, "SELECT MAX(repl) FROM gn090"
340 #if SQLITE_VERSION_NUMBER >= 3007000
341 " INDEXED BY idx_repl_rvalue"
343 "", &plugin->maxRepl) != SQLITE_OK) ||
346 "SELECT type,prio,anonLevel,expire,hash,value,_ROWID_ " "FROM gn090 "
347 #if SQLITE_VERSION_NUMBER >= 3007000
348 "INDEXED BY idx_expire "
350 "WHERE NOT EXISTS (SELECT 1 FROM gn090 WHERE expire < ?1 LIMIT 1) OR (expire < ?1) "
351 "ORDER BY expire ASC LIMIT 1", &plugin->selExpi) != SQLITE_OK) ||
354 "SELECT type,prio,anonLevel,expire,hash,value,_ROWID_ " "FROM gn090 "
355 #if SQLITE_VERSION_NUMBER >= 3007000
356 "INDEXED BY idx_anon_type_hash "
358 "WHERE (anonLevel = 0 AND type=?1) "
359 "ORDER BY hash DESC LIMIT 1 OFFSET ?2",
360 &plugin->selZeroAnon) != SQLITE_OK) ||
363 "INSERT INTO gn090 (repl, type, prio, anonLevel, expire, rvalue, hash, vhash, value) "
364 "VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)",
365 &plugin->insertContent) != SQLITE_OK) ||
367 (plugin->dbh, "DELETE FROM gn090 WHERE _ROWID_ = ?",
368 &plugin->delRow) != SQLITE_OK))
370 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "precompiling");
371 return GNUNET_SYSERR;
379 * Shutdown database connection and associate data
382 * @param plugin the plugin context (state for this module)
385 database_shutdown (struct Plugin *plugin)
389 #if SQLITE_VERSION_NUMBER >= 3007000
393 if (plugin->delRow != NULL)
394 sqlite3_finalize (plugin->delRow);
395 if (plugin->updPrio != NULL)
396 sqlite3_finalize (plugin->updPrio);
397 if (plugin->updRepl != NULL)
398 sqlite3_finalize (plugin->updRepl);
399 if (plugin->selRepl != NULL)
400 sqlite3_finalize (plugin->selRepl);
401 if (plugin->maxRepl != NULL)
402 sqlite3_finalize (plugin->maxRepl);
403 if (plugin->selExpi != NULL)
404 sqlite3_finalize (plugin->selExpi);
405 if (plugin->selZeroAnon != NULL)
406 sqlite3_finalize (plugin->selZeroAnon);
407 if (plugin->insertContent != NULL)
408 sqlite3_finalize (plugin->insertContent);
409 result = sqlite3_close (plugin->dbh);
410 #if SQLITE_VERSION_NUMBER >= 3007000
411 if (result == SQLITE_BUSY)
413 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, "sqlite",
415 ("Tried to close sqlite without finalizing all prepared statements.\n"));
416 stmt = sqlite3_next_stmt (plugin->dbh, NULL);
419 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
420 "Closing statement %p\n", stmt);
421 result = sqlite3_finalize (stmt);
422 if (result != SQLITE_OK)
423 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, "sqlite",
424 "Failed to close statement %p: %d\n", stmt, result);
425 stmt = sqlite3_next_stmt (plugin->dbh, NULL);
427 result = sqlite3_close (plugin->dbh);
430 if (SQLITE_OK != result)
431 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite3_close");
433 GNUNET_free_non_null (plugin->fn);
438 * Delete the database entry with the given
441 * @param plugin the plugin context (state for this module)
442 * @param rid the ID of the row to delete
445 delete_by_rowid (struct Plugin *plugin,
446 unsigned long long rid)
448 if (SQLITE_OK != sqlite3_bind_int64 (plugin->delRow, 1, rid))
450 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
451 "sqlite3_bind_XXXX");
452 if (SQLITE_OK != sqlite3_reset (plugin->delRow))
454 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
456 return GNUNET_SYSERR;
458 if (SQLITE_DONE != sqlite3_step (plugin->delRow))
460 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
462 if (SQLITE_OK != sqlite3_reset (plugin->delRow))
464 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
466 return GNUNET_SYSERR;
468 if (SQLITE_OK != sqlite3_reset (plugin->delRow))
469 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
476 * Store an item in the datastore.
479 * @param key key for the item
480 * @param size number of bytes in @a data
481 * @param data content stored
482 * @param type type of the content
483 * @param priority priority of the content
484 * @param anonymity anonymity-level for the content
485 * @param replication replication-level for the content
486 * @param expiration expiration time for the content
487 * @param cont continuation called with success or failure status
488 * @param cont_cls continuation closure
491 sqlite_plugin_put (void *cls,
492 const struct GNUNET_HashCode *key,
495 enum GNUNET_BLOCK_Type type,
498 uint32_t replication,
499 struct GNUNET_TIME_Absolute expiration,
503 struct Plugin *plugin = cls;
507 struct GNUNET_HashCode vhash;
511 if (size > MAX_ITEM_SIZE)
513 cont (cont_cls, key, size, GNUNET_SYSERR, _("Data too large"));
516 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
517 "Storing in database block with type %u/key `%s'/priority %u/expiration in %s (%s).\n",
521 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (expiration),
523 GNUNET_STRINGS_absolute_time_to_string (expiration));
524 GNUNET_CRYPTO_hash (data, size, &vhash);
525 stmt = plugin->insertContent;
526 rvalue = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK, UINT64_MAX);
527 if ((SQLITE_OK != sqlite3_bind_int (stmt, 1, replication)) ||
528 (SQLITE_OK != sqlite3_bind_int (stmt, 2, type)) ||
529 (SQLITE_OK != sqlite3_bind_int (stmt, 3, priority)) ||
530 (SQLITE_OK != sqlite3_bind_int (stmt, 4, anonymity)) ||
531 (SQLITE_OK != sqlite3_bind_int64 (stmt, 5, expiration.abs_value_us)) ||
532 (SQLITE_OK != sqlite3_bind_int64 (stmt, 6, rvalue)) ||
534 sqlite3_bind_blob (stmt, 7, key, sizeof (struct GNUNET_HashCode),
535 SQLITE_TRANSIENT)) ||
537 sqlite3_bind_blob (stmt, 8, &vhash, sizeof (struct GNUNET_HashCode),
538 SQLITE_TRANSIENT)) ||
539 (SQLITE_OK != sqlite3_bind_blob (stmt, 9, data, size, SQLITE_TRANSIENT)))
541 LOG_SQLITE_MSG (plugin, &msg, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
542 "sqlite3_bind_XXXX");
543 if (SQLITE_OK != sqlite3_reset (stmt))
545 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
547 cont (cont_cls, key, size, GNUNET_SYSERR, msg);
548 GNUNET_free_non_null(msg);
551 n = sqlite3_step (stmt);
555 plugin->env->duc (plugin->env->cls, size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
556 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
557 "Stored new entry (%u bytes)\n",
558 size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
563 LOG_SQLITE_MSG (plugin, &msg, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
568 LOG_SQLITE_MSG (plugin, &msg, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
570 if (SQLITE_OK != sqlite3_reset (stmt))
572 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
574 database_shutdown (plugin);
575 database_setup (plugin->env->cfg, plugin);
576 cont (cont_cls, key, size, GNUNET_SYSERR, msg);
577 GNUNET_free_non_null(msg);
580 if (SQLITE_OK != sqlite3_reset (stmt))
581 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
583 cont (cont_cls, key, size, ret, msg);
584 GNUNET_free_non_null(msg);
589 * Update the priority for a particular key in the datastore. If
590 * the expiration time in value is different than the time found in
591 * the datastore, the higher value should be kept. For the
592 * anonymity level, the lower value is to be used. The specified
593 * priority should be added to the existing priority, ignoring the
596 * Note that it is possible for multiple values to match this put.
597 * In that case, all of the respective values are updated.
599 * @param cls the plugin context (state for this module)
600 * @param uid unique identifier of the datum
601 * @param delta by how much should the priority
603 * @param expire new expiration time should be the
604 * MAX of any existing expiration time and
606 * @param cont continuation called with success or failure status
607 * @param cons_cls continuation closure
610 sqlite_plugin_update (void *cls,
613 struct GNUNET_TIME_Absolute expire,
614 PluginUpdateCont cont,
617 struct Plugin *plugin = cls;
621 if ((SQLITE_OK != sqlite3_bind_int (plugin->updPrio, 1, delta)) ||
622 (SQLITE_OK != sqlite3_bind_int64 (plugin->updPrio, 2, expire.abs_value_us))
623 || (SQLITE_OK != sqlite3_bind_int64 (plugin->updPrio, 3, uid)))
625 LOG_SQLITE_MSG (plugin, &msg, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
626 "sqlite3_bind_XXXX");
627 if (SQLITE_OK != sqlite3_reset (plugin->updPrio))
629 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
631 cont (cont_cls, GNUNET_SYSERR, msg);
632 GNUNET_free_non_null(msg);
635 n = sqlite3_step (plugin->updPrio);
636 if (SQLITE_OK != sqlite3_reset (plugin->updPrio))
637 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
642 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite", "Block updated\n");
643 cont (cont_cls, GNUNET_OK, NULL);
646 LOG_SQLITE_MSG (plugin, &msg,
647 GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
649 cont (cont_cls, GNUNET_NO, msg);
650 GNUNET_free_non_null(msg);
653 LOG_SQLITE_MSG (plugin, &msg, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
655 cont (cont_cls, GNUNET_SYSERR, msg);
656 GNUNET_free_non_null(msg);
663 * Execute statement that gets a row and call the callback
664 * with the result. Resets the statement afterwards.
666 * @param plugin the plugin
667 * @param stmt the statement
668 * @param proc processor to call
669 * @param proc_cls closure for @a proc
672 execute_get (struct Plugin *plugin,
674 PluginDatumProcessor proc,
678 struct GNUNET_TIME_Absolute expiration;
679 unsigned long long rowid;
683 n = sqlite3_step (stmt);
687 size = sqlite3_column_bytes (stmt, 5);
688 rowid = sqlite3_column_int64 (stmt, 6);
689 if (sqlite3_column_bytes (stmt, 4) != sizeof (struct GNUNET_HashCode))
691 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, "sqlite",
692 _("Invalid data in database. Trying to fix (by deletion).\n"));
693 if (SQLITE_OK != sqlite3_reset (stmt))
695 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
697 if (GNUNET_OK == delete_by_rowid (plugin, rowid))
698 plugin->env->duc (plugin->env->cls,
699 -(size + GNUNET_DATASTORE_ENTRY_OVERHEAD));
702 expiration.abs_value_us = sqlite3_column_int64 (stmt, 3);
703 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
704 "Found reply in database with expiration %s\n",
705 GNUNET_STRINGS_absolute_time_to_string (expiration));
706 ret = proc (proc_cls, sqlite3_column_blob (stmt, 4) /* key */ ,
707 size, sqlite3_column_blob (stmt, 5) /* data */ ,
708 sqlite3_column_int (stmt, 0) /* type */ ,
709 sqlite3_column_int (stmt, 1) /* priority */ ,
710 sqlite3_column_int (stmt, 2) /* anonymity */ ,
712 if (SQLITE_OK != sqlite3_reset (stmt))
714 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
716 if ((GNUNET_NO == ret) && (GNUNET_OK == delete_by_rowid (plugin, rowid)))
717 plugin->env->duc (plugin->env->cls,
718 -(size + GNUNET_DATASTORE_ENTRY_OVERHEAD));
721 /* database must be empty */
722 if (SQLITE_OK != sqlite3_reset (stmt))
724 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
731 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
733 if (SQLITE_OK != sqlite3_reset (stmt))
735 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
738 database_shutdown (plugin);
739 database_setup (plugin->env->cfg, plugin);
742 if (SQLITE_OK != sqlite3_reset (stmt))
743 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
745 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
750 * Select a subset of the items in the datastore and call
751 * the given processor for the item.
753 * @param cls our plugin context
754 * @param offset offset of the result (modulo num-results);
755 * specific ordering does not matter for the offset
756 * @param type entries of which type should be considered?
757 * Use 0 for any type.
758 * @param proc function to call on each matching value;
759 * will be called once with a NULL value at the end
760 * @param proc_cls closure for @a proc
763 sqlite_plugin_get_zero_anonymity (void *cls, uint64_t offset,
764 enum GNUNET_BLOCK_Type type,
765 PluginDatumProcessor proc, void *proc_cls)
767 struct Plugin *plugin = cls;
770 GNUNET_assert (type != GNUNET_BLOCK_TYPE_ANY);
771 stmt = plugin->selZeroAnon;
772 if ((SQLITE_OK != sqlite3_bind_int (stmt, 1, type)) ||
773 (SQLITE_OK != sqlite3_bind_int64 (stmt, 2, offset)))
775 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
776 "sqlite3_bind_XXXX");
777 if (SQLITE_OK != sqlite3_reset (stmt))
779 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
781 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
784 execute_get (plugin, stmt, proc, proc_cls);
789 * Get results for a particular key in the datastore.
792 * @param offset offset (mod count).
793 * @param key key to match, never NULL
794 * @param vhash hash of the value, maybe NULL (to
795 * match all values that have the right key).
796 * Note that for DBlocks there is no difference
797 * betwen key and vhash, but for other blocks
799 * @param type entries of which type are relevant?
800 * Use 0 for any type.
801 * @param proc function to call on each matching value;
802 * will be called once with a NULL value at the end
803 * @param proc_cls closure for @a proc
806 sqlite_plugin_get_key (void *cls,
808 const struct GNUNET_HashCode *key,
809 const struct GNUNET_HashCode *vhash,
810 enum GNUNET_BLOCK_Type type,
811 PluginDatumProcessor proc,
814 struct Plugin *plugin = cls;
822 GNUNET_assert (proc != NULL);
823 GNUNET_assert (key != NULL);
824 GNUNET_snprintf (scratch, sizeof (scratch),
825 "SELECT count(*) FROM gn090 WHERE hash=?%s%s",
826 vhash == NULL ? "" : " AND vhash=?",
827 type == 0 ? "" : " AND type=?");
828 if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
830 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
832 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
837 sqlite3_bind_blob (stmt, sqoff++, key, sizeof (struct GNUNET_HashCode),
839 if ((vhash != NULL) && (ret == SQLITE_OK))
841 sqlite3_bind_blob (stmt, sqoff++, vhash, sizeof (struct GNUNET_HashCode),
843 if ((type != 0) && (ret == SQLITE_OK))
844 ret = sqlite3_bind_int (stmt, sqoff++, type);
845 if (SQLITE_OK != ret)
847 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite_bind");
848 sqlite3_finalize (stmt);
849 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
852 ret = sqlite3_step (stmt);
853 if (ret != SQLITE_ROW)
855 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
857 sqlite3_finalize (stmt);
858 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
861 total = sqlite3_column_int (stmt, 0);
862 sqlite3_finalize (stmt);
865 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
868 limit_off = (int) (offset % total);
871 GNUNET_snprintf (scratch, sizeof (scratch),
872 "SELECT type, prio, anonLevel, expire, hash, value, _ROWID_ "
873 "FROM gn090 WHERE hash=?%s%s "
874 "ORDER BY _ROWID_ ASC LIMIT 1 OFFSET ?",
875 vhash == NULL ? "" : " AND vhash=?",
876 type == 0 ? "" : " AND type=?");
877 if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
879 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
881 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
885 ret = sqlite3_bind_blob (stmt, sqoff++, key,
886 sizeof (struct GNUNET_HashCode),
888 if ((vhash != NULL) && (ret == SQLITE_OK))
889 ret = sqlite3_bind_blob (stmt, sqoff++, vhash,
890 sizeof (struct GNUNET_HashCode),
892 if ((type != 0) && (ret == SQLITE_OK))
893 ret = sqlite3_bind_int (stmt, sqoff++, type);
894 if (ret == SQLITE_OK)
895 ret = sqlite3_bind_int64 (stmt, sqoff++, limit_off);
896 if (ret != SQLITE_OK)
899 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
901 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
904 execute_get (plugin, stmt, proc, proc_cls);
905 sqlite3_finalize (stmt);
910 * Context for #repl_proc() function.
916 * Function to call for the result (or the NULL).
918 PluginDatumProcessor proc;
921 * Closure for @e proc.
931 * Yes if UID was set.
938 * Wrapper for the processor for #sqlite_plugin_get_replication().
939 * Decrements the replication counter and calls the original
943 * @param key key for the content
944 * @param size number of bytes in @a data
945 * @param data content stored
946 * @param type type of the content
947 * @param priority priority of the content
948 * @param anonymity anonymity-level for the content
949 * @param expiration expiration time for the content
950 * @param uid unique identifier for the datum;
951 * maybe 0 if no unique identifier is available
952 * @return #GNUNET_OK for normal return,
953 * #GNUNET_NO to delete the item
956 repl_proc (void *cls,
957 const struct GNUNET_HashCode *key,
960 enum GNUNET_BLOCK_Type type,
963 struct GNUNET_TIME_Absolute expiration,
966 struct ReplCtx *rc = cls;
969 ret = rc->proc (rc->proc_cls,
979 rc->have_uid = GNUNET_YES;
986 * Get a random item for replication. Returns a single random item
987 * from those with the highest replication counters. The item's
988 * replication counter is decremented by one IF it was positive before.
989 * Call @a proc with all values ZERO or NULL if the datastore is empty.
992 * @param proc function to call the value (once only).
993 * @param proc_cls closure for @a proc
996 sqlite_plugin_get_replication (void *cls, PluginDatumProcessor proc,
999 struct Plugin *plugin = cls;
1005 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
1006 "Getting random block based on replication order.\n");
1007 rc.have_uid = GNUNET_NO;
1009 rc.proc_cls = proc_cls;
1010 stmt = plugin->maxRepl;
1011 if (SQLITE_ROW != sqlite3_step (stmt))
1013 if (SQLITE_OK != sqlite3_reset (stmt))
1015 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1018 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1021 repl = sqlite3_column_int (stmt, 0);
1022 if (SQLITE_OK != sqlite3_reset (stmt))
1023 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1025 stmt = plugin->selRepl;
1026 rvalue = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK, UINT64_MAX);
1027 if (SQLITE_OK != sqlite3_bind_int64 (stmt, 1, rvalue))
1029 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1030 "sqlite3_bind_XXXX");
1031 if (SQLITE_OK != sqlite3_reset (stmt))
1033 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1035 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1038 if (SQLITE_OK != sqlite3_bind_int (stmt, 2, repl))
1040 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1041 "sqlite3_bind_XXXX");
1042 if (SQLITE_OK != sqlite3_reset (stmt))
1044 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1046 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1049 execute_get (plugin, stmt, &repl_proc, &rc);
1050 if (GNUNET_YES == rc.have_uid)
1052 if (SQLITE_OK != sqlite3_bind_int64 (plugin->updRepl, 1, rc.uid))
1055 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1056 "sqlite3_bind_XXXX");
1057 if (SQLITE_OK != sqlite3_reset (plugin->updRepl))
1059 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1063 if (SQLITE_DONE != sqlite3_step (plugin->updRepl))
1065 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1067 if (SQLITE_OK != sqlite3_reset (plugin->updRepl))
1069 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1076 * Get a random item that has expired or has low priority.
1077 * Call @a proc with all values ZERO or NULL if the datastore is empty.
1079 * @param cls closure
1080 * @param proc function to call the value (once only).
1081 * @param proc_cls closure for @a proc
1084 sqlite_plugin_get_expiration (void *cls, PluginDatumProcessor proc,
1087 struct Plugin *plugin = cls;
1089 struct GNUNET_TIME_Absolute now;
1091 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
1092 "Getting random block based on expiration and priority order.\n");
1093 now = GNUNET_TIME_absolute_get ();
1094 stmt = plugin->selExpi;
1095 if (SQLITE_OK != sqlite3_bind_int64 (stmt, 1, now.abs_value_us))
1097 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1098 "sqlite3_bind_XXXX");
1099 if (SQLITE_OK != sqlite3_reset (stmt))
1101 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1103 proc (proc_cls, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1106 execute_get (plugin, stmt, proc, proc_cls);
1111 * Get all of the keys in the datastore.
1113 * @param cls closure
1114 * @param proc function to call on each key
1115 * @param proc_cls closure for @a proc
1118 sqlite_plugin_get_keys (void *cls,
1119 PluginKeyProcessor proc,
1122 struct Plugin *plugin = cls;
1123 const struct GNUNET_HashCode *key;
1127 GNUNET_assert (proc != NULL);
1128 if (sq_prepare (plugin->dbh, "SELECT hash FROM gn090", &stmt) != SQLITE_OK)
1130 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
1132 proc (proc_cls, NULL, 0);
1135 while (SQLITE_ROW == (ret = sqlite3_step (stmt)))
1137 key = sqlite3_column_blob (stmt, 0);
1138 if (sizeof (struct GNUNET_HashCode) == sqlite3_column_bytes (stmt, 0))
1139 proc (proc_cls, key, 1);
1143 if (SQLITE_DONE != ret)
1144 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite_step");
1145 sqlite3_finalize (stmt);
1146 proc (proc_cls, NULL, 0);
1153 * @param cls our plugin context
1156 sqlite_plugin_drop (void *cls)
1158 struct Plugin *plugin = cls;
1160 plugin->drop_on_shutdown = GNUNET_YES;
1165 * Get an estimate of how much space the database is
1168 * @param cls the `struct Plugin`
1169 * @return the size of the database on disk (estimate)
1172 sqlite_plugin_estimate_size (void *cls, unsigned long long *estimate)
1174 struct Plugin *plugin = cls;
1183 if (NULL == estimate)
1185 if (SQLITE_VERSION_NUMBER < 3006000)
1187 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, "datastore-sqlite",
1189 ("sqlite version to old to determine size, assuming zero\n"));
1193 CHECK (SQLITE_OK == sqlite3_exec (plugin->dbh, "VACUUM", NULL, NULL, ENULL));
1195 sqlite3_exec (plugin->dbh, "PRAGMA auto_vacuum=INCREMENTAL", NULL,
1197 CHECK (SQLITE_OK == sq_prepare (plugin->dbh, "PRAGMA page_count", &stmt));
1198 if (SQLITE_ROW == sqlite3_step (stmt))
1199 pages = sqlite3_column_int64 (stmt, 0);
1202 sqlite3_finalize (stmt);
1203 CHECK (SQLITE_OK == sq_prepare (plugin->dbh, "PRAGMA page_size", &stmt));
1204 CHECK (SQLITE_ROW == sqlite3_step (stmt));
1205 page_size = sqlite3_column_int64 (stmt, 0);
1206 sqlite3_finalize (stmt);
1207 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1209 ("Using sqlite page utilization to estimate payload (%llu pages of size %llu bytes)\n"),
1210 (unsigned long long) pages, (unsigned long long) page_size);
1211 *estimate = pages * page_size;
1216 * Entry point for the plugin.
1218 * @param cls the `struct GNUNET_DATASTORE_PluginEnvironment *`
1219 * @return NULL on error, othrewise the plugin context
1222 libgnunet_plugin_datastore_sqlite_init (void *cls)
1224 static struct Plugin plugin;
1225 struct GNUNET_DATASTORE_PluginEnvironment *env = cls;
1226 struct GNUNET_DATASTORE_PluginFunctions *api;
1228 if (plugin.env != NULL)
1229 return NULL; /* can only initialize once! */
1230 memset (&plugin, 0, sizeof (struct Plugin));
1232 if (GNUNET_OK != database_setup (env->cfg, &plugin))
1234 database_shutdown (&plugin);
1237 api = GNUNET_new (struct GNUNET_DATASTORE_PluginFunctions);
1239 api->estimate_size = &sqlite_plugin_estimate_size;
1240 api->put = &sqlite_plugin_put;
1241 api->update = &sqlite_plugin_update;
1242 api->get_key = &sqlite_plugin_get_key;
1243 api->get_replication = &sqlite_plugin_get_replication;
1244 api->get_expiration = &sqlite_plugin_get_expiration;
1245 api->get_zero_anonymity = &sqlite_plugin_get_zero_anonymity;
1246 api->get_keys = &sqlite_plugin_get_keys;
1247 api->drop = &sqlite_plugin_drop;
1248 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "sqlite",
1249 _("Sqlite database running\n"));
1255 * Exit point from the plugin.
1257 * @param cls the plugin context (as returned by "init")
1258 * @return always NULL
1261 libgnunet_plugin_datastore_sqlite_done (void *cls)
1264 struct GNUNET_DATASTORE_PluginFunctions *api = cls;
1265 struct Plugin *plugin = api->cls;
1267 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
1268 "sqlite plugin is done\n");
1270 if (plugin->drop_on_shutdown)
1271 fn = GNUNET_strdup (plugin->fn);
1272 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
1273 "Shutting down database\n");
1274 database_shutdown (plugin);
1279 if (0 != UNLINK (fn))
1280 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
1283 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
1284 "sqlite plugin is finished\n");
1288 /* end of plugin_datastore_sqlite.c */