2 This file is part of GNUnet
3 (C) 2009 Christian Grothoff (and other contributing authors)
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.
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file datastore/plugin_datastore_sqlite.c
23 * @brief sqlite-based datastore backend
24 * @author Christian Grothoff
28 #include "gnunet_statistics_service.h"
29 #include "plugin_datastore.h"
32 #define DEBUG_SQLITE GNUNET_YES
35 * After how many payload-changing operations
36 * do we sync our statistics?
38 #define MAX_STAT_SYNC_LAG 50
40 #define QUOTA_STAT_NAME gettext_noop ("file-sharing datastore utilization (in bytes)")
44 * Die with an error message that indicates
45 * a failure of the command 'cmd' with the message given
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)
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).
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)
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"
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"
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"
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"
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"
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"
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"
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"
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).
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.
99 #define BUSY_TIMEOUT_MS 250
103 * Context for all functions in this plugin.
108 * Our execution environment.
110 struct GNUNET_DATASTORE_PluginEnvironment *env;
118 * Native SQLite database handle.
123 * Precompiled SQL for update.
125 sqlite3_stmt *updPrio;
128 * Precompiled SQL for insertion.
130 sqlite3_stmt *insertContent;
133 * Handle to the statistics service.
135 struct GNUNET_STATISTICS_Handle *statistics;
138 * How much data are we currently storing
141 unsigned long long payload;
144 * Number of updates that were made to the
145 * payload value since we last synchronized
146 * it with the statistics service.
148 unsigned int lastSync;
151 * Should the database be dropped on shutdown?
153 int drop_on_shutdown;
158 * @brief Prepare a SQL statement
160 * @param zSql SQL statement, UTF-8 encoded
163 sq_prepare (sqlite3 * dbh, const char *zSql,
164 sqlite3_stmt ** ppStmt)
167 return sqlite3_prepare (dbh,
169 strlen (zSql), ppStmt, (const char **) &dummy);
174 * Create our database indices.
177 create_indices (sqlite3 * dbh)
181 "CREATE INDEX idx_hash ON gn080 (hash)", NULL, NULL, NULL);
183 "CREATE INDEX idx_hash_vhash ON gn080 (hash,vhash)", NULL,
185 sqlite3_exec (dbh, "CREATE INDEX idx_prio ON gn080 (prio)", NULL, NULL,
187 sqlite3_exec (dbh, "CREATE INDEX idx_expire ON gn080 (expire)", NULL, NULL,
189 sqlite3_exec (dbh, "CREATE INDEX idx_comb3 ON gn080 (prio,anonLevel)", NULL,
191 sqlite3_exec (dbh, "CREATE INDEX idx_comb4 ON gn080 (prio,hash,anonLevel)",
193 sqlite3_exec (dbh, "CREATE INDEX idx_comb7 ON gn080 (expire,hash)", NULL,
200 #define CHECK(a) GNUNET_break(a)
204 #define ENULL_DEFINED 1
205 #define CHECK(a) if (! a) { GNUNET_log(GNUNET_ERROR_TYPE_ERRROR, "%s\n", e); sqlite3_free(e); }
212 * Initialize the database connections and associated
213 * data structures (create tables and indices
214 * as needed as well).
216 * @return GNUNET_OK on success
219 database_setup (struct GNUNET_CONFIGURATION_Handle *cfg,
220 struct Plugin *plugin)
229 GNUNET_CONFIGURATION_get_value_filename (cfg,
234 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
236 _("Option `%s' in section `%s' missing in configuration!\n"),
239 return GNUNET_SYSERR;
241 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (afsdir))
244 GNUNET_free (afsdir);
245 return GNUNET_SYSERR;
247 plugin->fn = GNUNET_STRINGS_to_utf8 (afsdir, strlen (afsdir),
249 nl_langinfo (CODESET)
251 "UTF-8" /* good luck */
254 GNUNET_free (afsdir);
256 /* Open database and precompile statements */
257 if (sqlite3_open (plugin->fn, &plugin->dbh) != SQLITE_OK)
259 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
261 _("Unable to initialize SQLite: %s.\n"),
262 sqlite3_errmsg (plugin->dbh));
263 return GNUNET_SYSERR;
266 sqlite3_exec (plugin->dbh,
267 "PRAGMA temp_store=MEMORY", NULL, NULL, ENULL));
269 sqlite3_exec (plugin->dbh,
270 "PRAGMA synchronous=OFF", NULL, NULL, ENULL));
272 sqlite3_exec (plugin->dbh,
273 "PRAGMA count_changes=OFF", NULL, NULL, ENULL));
275 sqlite3_exec (plugin->dbh, "PRAGMA page_size=4092", NULL, NULL, ENULL));
277 CHECK (SQLITE_OK == sqlite3_busy_timeout (plugin->dbh, BUSY_TIMEOUT_MS));
280 /* We have to do it here, because otherwise precompiling SQL might fail */
282 sq_prepare (plugin->dbh,
283 "SELECT 1 FROM sqlite_master WHERE tbl_name = 'gn080'",
285 if ( (sqlite3_step (stmt) == SQLITE_DONE) &&
286 (sqlite3_exec (plugin->dbh,
287 "CREATE TABLE gn080 ("
288 " size INT4 NOT NULL DEFAULT 0,"
289 " type INT4 NOT NULL DEFAULT 0,"
290 " prio INT4 NOT NULL DEFAULT 0,"
291 " anonLevel INT4 NOT NULL DEFAULT 0,"
292 " expire INT8 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) )
298 LOG_SQLITE (plugin, NULL,
299 GNUNET_ERROR_TYPE_ERROR,
301 sqlite3_finalize (stmt);
302 return GNUNET_SYSERR;
304 sqlite3_finalize (stmt);
305 create_indices (plugin->dbh);
308 sq_prepare (plugin->dbh,
309 "SELECT 1 FROM sqlite_master WHERE tbl_name = 'gn071'",
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) )
318 LOG_SQLITE (plugin, NULL,
319 GNUNET_ERROR_TYPE_ERROR, "sqlite3_exec");
320 sqlite3_finalize (stmt);
321 return GNUNET_SYSERR;
323 sqlite3_finalize (stmt);
325 if ((sq_prepare (plugin->dbh,
326 "UPDATE gn080 SET prio = prio + ?, expire = MAX(expire,?) WHERE "
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))
335 LOG_SQLITE (plugin, NULL,
336 GNUNET_ERROR_TYPE_ERROR, "precompiling");
337 return GNUNET_SYSERR;
344 * Synchronize our utilization statistics with the
345 * statistics service.
348 sync_stats (struct Plugin *plugin)
350 GNUNET_STATISTICS_set (plugin->statistics,
354 plugin->lastSync = 0;
359 * Shutdown database connection and associate data
363 database_shutdown (struct Plugin *plugin)
365 if (plugin->lastSync > 0)
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);
377 * Get an estimate of how much space the database is
379 * @return number of bytes used on disk
381 static unsigned long long sqlite_plugin_get_size (void *cls)
383 struct Plugin *plugin = cls;
384 return plugin->payload;
389 * Delete the database entry with the given
393 delete_by_rowid (struct Plugin* plugin,
394 unsigned long long rid)
398 if (sq_prepare (plugin->dbh,
399 "DELETE FROM gn080 WHERE _ROWID_ = ?", &stmt) != SQLITE_OK)
401 LOG_SQLITE (plugin, NULL,
402 GNUNET_ERROR_TYPE_ERROR |
403 GNUNET_ERROR_TYPE_BULK, "sq_prepare");
404 return GNUNET_SYSERR;
406 sqlite3_bind_int64 (stmt, 1, rid);
407 if (SQLITE_DONE != sqlite3_step (stmt))
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;
415 sqlite3_finalize (stmt);
421 * Context for the universal iterator.
426 * Type of a function that will prepare
427 * the next iteration.
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
436 typedef int (*PrepareFunction)(void *cls,
437 struct NextContext *nc);
441 * Context we keep for the "next request" callback.
448 struct Plugin *plugin;
451 * Function to call on the next value.
461 * Function to call to prepare the next
464 PrepareFunction prep;
472 * Statement that the iterator will get the data
473 * from (updated or set by prep).
478 * Row ID of the last result.
480 unsigned long long last_rowid;
483 * Key of the last result.
485 GNUNET_HashCode lastKey;
488 * Expiration time of the last value visited.
490 struct GNUNET_TIME_Absolute lastExpiration;
493 * Priority of the last value visited.
495 unsigned int lastPriority;
498 * Number of results processed so far.
503 * Set to GNUNET_YES if we must stop now.
510 * Continuation of "sqlite_next_request".
512 * @param cls the next context
515 sqlite_next_request_cont (void *cls,
516 const struct GNUNET_SCHEDULER_TaskContext *tc)
518 static struct GNUNET_TIME_Absolute zero;
519 struct NextContext * nc= cls;
520 struct Plugin *plugin;
521 unsigned long long rowid;
526 unsigned int priority;
527 unsigned int anonymity;
528 struct GNUNET_TIME_Absolute expiration;
529 const GNUNET_HashCode *key;
534 if ( (GNUNET_YES == nc->end_it) ||
535 (GNUNET_OK != (nc->prep(nc->prep_cls,
539 nc->iter (nc->iter_cls,
540 NULL, NULL, 0, NULL, 0, 0, 0,
542 nc->prep (nc->prep_cls, NULL);
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))
553 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
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");
562 "DELETE FROM gn080 WHERE NOT LENGTH(hash) = ?",
563 &stmtd) != SQLITE_OK)
565 LOG_SQLITE (nc->plugin, NULL,
566 GNUNET_ERROR_TYPE_ERROR |
567 GNUNET_ERROR_TYPE_BULK,
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");
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);
596 ret = nc->iter (nc->iter_cls,
606 if (ret == GNUNET_SYSERR)
608 nc->end_it = GNUNET_YES;
611 if ( (ret == GNUNET_NO) &&
612 (GNUNET_OK == delete_by_rowid (plugin, rowid)) )
614 plugin->payload -= (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
616 if (plugin->lastSync >= MAX_STAT_SYNC_LAG)
623 * Function invoked on behalf of a "PluginIterator"
624 * asking the database plugin to call the iterator
625 * with the next item.
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).
635 sqlite_next_request (void *next_cls,
638 struct NextContext * nc= next_cls;
640 if (GNUNET_YES == end_it)
641 nc->end_it = GNUNET_YES;
642 GNUNET_SCHEDULER_add_continuation (nc->plugin->env->sched,
644 &sqlite_next_request_cont,
646 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
652 * Store an item in the datastore.
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
666 sqlite_plugin_put (void *cls,
667 const GNUNET_HashCode * key,
673 struct GNUNET_TIME_Absolute expiration,
676 struct Plugin *plugin = cls;
679 GNUNET_HashCode vhash;
682 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
684 "Storing in database block with type %u/key `%s'/priority %u/expiration %llu (%lld).\n",
688 (unsigned long long) GNUNET_TIME_absolute_get_remaining (expiration).value,
689 (long long) expiration.value);
691 GNUNET_CRYPTO_hash (data, size, &vhash);
692 stmt = plugin->insertContent;
693 if ((SQLITE_OK != sqlite3_bind_int (stmt, 1, size)) ||
694 (SQLITE_OK != sqlite3_bind_int (stmt, 2, type)) ||
695 (SQLITE_OK != sqlite3_bind_int (stmt, 3, priority)) ||
696 (SQLITE_OK != sqlite3_bind_int (stmt, 4, anonymity)) ||
697 (SQLITE_OK != sqlite3_bind_int64 (stmt, 5, (sqlite3_int64) expiration.value)) ||
699 sqlite3_bind_blob (stmt, 6, key, sizeof (GNUNET_HashCode),
700 SQLITE_TRANSIENT)) ||
702 sqlite3_bind_blob (stmt, 7, &vhash, sizeof (GNUNET_HashCode),
705 sqlite3_bind_blob (stmt, 8, data, size,
710 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_bind_XXXX");
711 if (SQLITE_OK != sqlite3_reset (stmt))
712 LOG_SQLITE (plugin, NULL,
713 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
714 return GNUNET_SYSERR;
716 n = sqlite3_step (stmt);
717 if (n != SQLITE_DONE)
719 if (n == SQLITE_BUSY)
721 LOG_SQLITE (plugin, msg,
722 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
723 sqlite3_reset (stmt);
727 LOG_SQLITE (plugin, msg,
728 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
729 sqlite3_reset (stmt);
730 return GNUNET_SYSERR;
732 if (SQLITE_OK != sqlite3_reset (stmt))
733 LOG_SQLITE (plugin, NULL,
734 GNUNET_ERROR_TYPE_ERROR |
735 GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
737 plugin->payload += size + GNUNET_DATASTORE_ENTRY_OVERHEAD;
738 if (plugin->lastSync >= MAX_STAT_SYNC_LAG)
745 * Update the priority for a particular key in the datastore. If
746 * the expiration time in value is different than the time found in
747 * the datastore, the higher value should be kept. For the
748 * anonymity level, the lower value is to be used. The specified
749 * priority should be added to the existing priority, ignoring the
752 * Note that it is possible for multiple values to match this put.
753 * In that case, all of the respective values are updated.
755 * @param uid unique identifier of the datum
756 * @param delta by how much should the priority
757 * change? If priority + delta < 0 the
758 * priority should be set to 0 (never go
760 * @param expire new expiration time should be the
761 * MAX of any existing expiration time and
763 * @param msg set to an error message
764 * @return GNUNET_OK on success
767 sqlite_plugin_update (void *cls,
769 int delta, struct GNUNET_TIME_Absolute expire,
772 struct Plugin *plugin = cls;
775 sqlite3_bind_int (plugin->updPrio, 1, delta);
776 sqlite3_bind_int64 (plugin->updPrio, 2, expire.value);
777 sqlite3_bind_int64 (plugin->updPrio, 3, uid);
778 n = sqlite3_step (plugin->updPrio);
780 LOG_SQLITE (plugin, msg,
781 GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
785 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
789 sqlite3_reset (plugin->updPrio);
791 if (n == SQLITE_BUSY)
793 return n == SQLITE_OK ? GNUNET_OK : GNUNET_SYSERR;
799 sqlite3_stmt *stmt_1;
800 sqlite3_stmt *stmt_2;
804 int limit_nonanonymous;
810 iter_next_prepare (void *cls,
811 struct NextContext *nc)
813 struct IterContext *ic = cls;
814 struct Plugin *plugin;
820 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
821 "Asked to clean up iterator state.\n");
823 sqlite3_finalize (ic->stmt_1);
824 sqlite3_finalize (ic->stmt_2);
825 return GNUNET_SYSERR;
827 sqlite3_reset (ic->stmt_1);
828 sqlite3_reset (ic->stmt_2);
833 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
834 "Restricting to results larger than the last priority %u\n",
837 sqlite3_bind_int (ic->stmt_1, 1, nc->lastPriority);
838 sqlite3_bind_int (ic->stmt_2, 1, nc->lastPriority);
843 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
844 "Restricting to results larger than the last expiration %llu\n",
845 (unsigned long long) nc->lastExpiration.value);
847 sqlite3_bind_int64 (ic->stmt_1, 1, nc->lastExpiration.value);
848 sqlite3_bind_int64 (ic->stmt_2, 1, nc->lastExpiration.value);
851 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
852 "Restricting to results larger than the last key `%s'\n",
853 GNUNET_h2s(&nc->lastKey));
855 sqlite3_bind_blob (ic->stmt_1, 2,
857 sizeof (GNUNET_HashCode),
859 if (SQLITE_ROW == (ret = sqlite3_step (ic->stmt_1)))
862 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
863 "Result found using iterator 1\n");
865 nc->stmt = ic->stmt_1;
868 if (ret != SQLITE_DONE)
870 LOG_SQLITE (plugin, NULL,
871 GNUNET_ERROR_TYPE_ERROR |
872 GNUNET_ERROR_TYPE_BULK,
874 return GNUNET_SYSERR;
876 if (SQLITE_OK != sqlite3_reset (ic->stmt_1))
877 LOG_SQLITE (plugin, NULL,
878 GNUNET_ERROR_TYPE_ERROR |
879 GNUNET_ERROR_TYPE_BULK,
881 if (SQLITE_ROW == (ret = sqlite3_step (ic->stmt_2)))
884 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
885 "Result found using iterator 2\n");
887 nc->stmt = ic->stmt_2;
890 if (ret != SQLITE_DONE)
892 LOG_SQLITE (plugin, NULL,
893 GNUNET_ERROR_TYPE_ERROR |
894 GNUNET_ERROR_TYPE_BULK,
896 return GNUNET_SYSERR;
898 if (SQLITE_OK != sqlite3_reset (ic->stmt_2))
899 LOG_SQLITE (plugin, NULL,
900 GNUNET_ERROR_TYPE_ERROR |
901 GNUNET_ERROR_TYPE_BULK,
904 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
905 "No result found using either iterator\n");
912 * Call a method for each key in the database and
913 * call the callback method on it.
915 * @param type entries of which type should be considered?
916 * @param iter function to call on each matching value;
917 * will be called once with a NULL value at the end
918 * @param iter_cls closure for iter
919 * @return the number of results processed,
920 * GNUNET_SYSERR on error
923 basic_iter (struct Plugin *plugin,
928 int limit_nonanonymous,
929 const char *stmt_str_1,
930 const char *stmt_str_2,
934 static struct GNUNET_TIME_Absolute zero;
935 struct NextContext *nc;
936 struct IterContext *ic;
937 sqlite3_stmt *stmt_1;
938 sqlite3_stmt *stmt_2;
941 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
942 "At %llu, using queries `%s' and `%s'\n",
943 (unsigned long long) GNUNET_TIME_absolute_get ().value,
947 if (sq_prepare (plugin->dbh, stmt_str_1, &stmt_1) != SQLITE_OK)
949 LOG_SQLITE (plugin, NULL,
950 GNUNET_ERROR_TYPE_ERROR |
951 GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
952 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
955 if (sq_prepare (plugin->dbh, stmt_str_2, &stmt_2) != SQLITE_OK)
957 LOG_SQLITE (plugin, NULL,
958 GNUNET_ERROR_TYPE_ERROR |
959 GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
960 sqlite3_finalize (stmt_1);
961 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
964 nc = GNUNET_malloc (sizeof(struct NextContext) +
965 sizeof(struct IterContext));
968 nc->iter_cls = iter_cls;
970 ic = (struct IterContext*) &nc[1];
975 ic->is_prio = is_prio;
976 ic->is_migr = is_migr;
977 ic->limit_nonanonymous = limit_nonanonymous;
978 nc->prep = &iter_next_prepare;
982 nc->lastPriority = 0;
983 nc->lastExpiration.value = 0;
984 memset (&nc->lastKey, 0, sizeof (GNUNET_HashCode));
988 nc->lastPriority = 0x7FFFFFFF;
989 nc->lastExpiration.value = 0x7FFFFFFFFFFFFFFFLL;
990 memset (&nc->lastKey, 255, sizeof (GNUNET_HashCode));
992 sqlite_next_request (nc, GNUNET_NO);
997 * Select a subset of the items in the datastore and call
998 * the given iterator for each of them.
1000 * @param type entries of which type should be considered?
1001 * Use 0 for any type.
1002 * @param iter function to call on each matching value;
1003 * will be called once with a NULL value at the end
1004 * @param iter_cls closure for iter
1007 sqlite_plugin_iter_low_priority (void *cls,
1009 PluginIterator iter,
1014 GNUNET_YES, GNUNET_YES,
1015 GNUNET_NO, GNUNET_NO,
1016 SELECT_IT_LOW_PRIORITY_1,
1017 SELECT_IT_LOW_PRIORITY_2,
1023 * Select a subset of the items in the datastore and call
1024 * the given iterator for each of them.
1026 * @param type entries of which type should be considered?
1027 * Use 0 for any type.
1028 * @param iter function to call on each matching value;
1029 * will be called once with a NULL value at the end
1030 * @param iter_cls closure for iter
1033 sqlite_plugin_iter_zero_anonymity (void *cls,
1035 PluginIterator iter,
1038 struct GNUNET_TIME_Absolute now;
1042 now = GNUNET_TIME_absolute_get ();
1043 GNUNET_asprintf (&q1, SELECT_IT_NON_ANONYMOUS_1,
1044 (unsigned long long) now.value);
1045 GNUNET_asprintf (&q2, SELECT_IT_NON_ANONYMOUS_2,
1046 (unsigned long long) now.value);
1049 GNUNET_NO, GNUNET_YES,
1050 GNUNET_NO, GNUNET_YES,
1061 * Select a subset of the items in the datastore and call
1062 * the given iterator for each of them.
1064 * @param type entries of which type should be considered?
1065 * Use 0 for any type.
1066 * @param iter function to call on each matching value;
1067 * will be called once with a NULL value at the end
1068 * @param iter_cls closure for iter
1071 sqlite_plugin_iter_ascending_expiration (void *cls,
1073 PluginIterator iter,
1076 struct GNUNET_TIME_Absolute now;
1080 now = GNUNET_TIME_absolute_get ();
1081 GNUNET_asprintf (&q1, SELECT_IT_EXPIRATION_TIME_1,
1082 (unsigned long long) 0*now.value);
1083 GNUNET_asprintf (&q2, SELECT_IT_EXPIRATION_TIME_2,
1084 (unsigned long long) 0*now.value);
1087 GNUNET_YES, GNUNET_NO,
1088 GNUNET_NO, GNUNET_NO,
1097 * Select a subset of the items in the datastore and call
1098 * the given iterator for each of them.
1100 * @param type entries of which type should be considered?
1101 * Use 0 for any type.
1102 * @param iter function to call on each matching value;
1103 * will be called once with a NULL value at the end
1104 * @param iter_cls closure for iter
1107 sqlite_plugin_iter_migration_order (void *cls,
1109 PluginIterator iter,
1112 struct GNUNET_TIME_Absolute now;
1115 now = GNUNET_TIME_absolute_get ();
1116 GNUNET_asprintf (&q, SELECT_IT_MIGRATION_ORDER_2,
1117 (unsigned long long) now.value);
1120 GNUNET_NO, GNUNET_NO,
1121 GNUNET_YES, GNUNET_NO,
1122 SELECT_IT_MIGRATION_ORDER_1,
1130 all_next_prepare (void *cls,
1131 struct NextContext *nc)
1133 struct Plugin *plugin;
1139 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1140 "Asked to clean up iterator state.\n");
1142 return GNUNET_SYSERR;
1144 plugin = nc->plugin;
1145 if (SQLITE_ROW == (ret = sqlite3_step (nc->stmt)))
1149 if (ret != SQLITE_DONE)
1151 LOG_SQLITE (plugin, NULL,
1152 GNUNET_ERROR_TYPE_ERROR |
1153 GNUNET_ERROR_TYPE_BULK,
1155 return GNUNET_SYSERR;
1162 * Select a subset of the items in the datastore and call
1163 * the given iterator for each of them.
1165 * @param type entries of which type should be considered?
1166 * Use 0 for any type.
1167 * @param iter function to call on each matching value;
1168 * will be called once with a NULL value at the end
1169 * @param iter_cls closure for iter
1172 sqlite_plugin_iter_all_now (void *cls,
1174 PluginIterator iter,
1177 static struct GNUNET_TIME_Absolute zero;
1178 struct Plugin *plugin = cls;
1179 struct NextContext *nc;
1182 if (sq_prepare (plugin->dbh,
1183 "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080",
1184 &stmt) != SQLITE_OK)
1186 LOG_SQLITE (plugin, NULL,
1187 GNUNET_ERROR_TYPE_ERROR |
1188 GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
1189 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1192 nc = GNUNET_malloc (sizeof(struct NextContext));
1193 nc->plugin = plugin;
1195 nc->iter_cls = iter_cls;
1197 nc->prep = &all_next_prepare;
1198 nc->prep_cls = NULL;
1199 sqlite_next_request (nc, GNUNET_NO);
1203 struct GetNextContext
1210 GNUNET_HashCode key;
1211 GNUNET_HashCode vhash;
1216 get_next_prepare (void *cls,
1217 struct NextContext *nc)
1219 struct GetNextContext *gnc = cls;
1226 sqlite3_finalize (gnc->stmt);
1227 return GNUNET_SYSERR;
1229 if (nc->count == gnc->total)
1231 if (nc->count + gnc->off == gnc->total)
1234 limit_off = gnc->off;
1238 sqlite3_reset (nc->stmt);
1239 ret = sqlite3_bind_blob (nc->stmt,
1242 sizeof (GNUNET_HashCode),
1244 if ((gnc->have_vhash) && (ret == SQLITE_OK))
1245 ret = sqlite3_bind_blob (nc->stmt,
1248 sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1249 if ((gnc->type != 0) && (ret == SQLITE_OK))
1250 ret = sqlite3_bind_int (nc->stmt, sqoff++, gnc->type);
1251 if (ret == SQLITE_OK)
1252 ret = sqlite3_bind_int64 (nc->stmt, sqoff++, nc->last_rowid + 1);
1253 if (ret == SQLITE_OK)
1254 ret = sqlite3_bind_int (nc->stmt, sqoff++, limit_off);
1255 if (ret != SQLITE_OK)
1256 return GNUNET_SYSERR;
1257 if (SQLITE_ROW != sqlite3_step (nc->stmt))
1264 * Iterate over the results for a particular key
1267 * @param cls closure
1268 * @param key maybe NULL (to match all entries)
1269 * @param vhash hash of the value, maybe NULL (to
1270 * match all values that have the right key).
1271 * Note that for DBlocks there is no difference
1272 * betwen key and vhash, but for other blocks
1274 * @param type entries of which type are relevant?
1275 * Use 0 for any type.
1276 * @param iter function to call on each matching value;
1277 * will be called once with a NULL value at the end
1278 * @param iter_cls closure for iter
1281 sqlite_plugin_get (void *cls,
1282 const GNUNET_HashCode * key,
1283 const GNUNET_HashCode * vhash,
1285 PluginIterator iter, void *iter_cls)
1287 static struct GNUNET_TIME_Absolute zero;
1288 struct Plugin *plugin = cls;
1289 struct GetNextContext *gpc;
1290 struct NextContext *nc;
1297 GNUNET_assert (iter != NULL);
1300 sqlite_plugin_iter_low_priority (cls, type, iter, iter_cls);
1303 GNUNET_snprintf (scratch, 256,
1304 "SELECT count(*) FROM gn080 WHERE hash=:1%s%s",
1305 vhash == NULL ? "" : " AND vhash=:2",
1306 type == 0 ? "" : (vhash ==
1307 NULL) ? " AND type=:2" : " AND type=:3");
1308 if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
1310 LOG_SQLITE (plugin, NULL,
1311 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite_prepare");
1312 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1316 ret = sqlite3_bind_blob (stmt,
1318 key, sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1319 if ((vhash != NULL) && (ret == SQLITE_OK))
1320 ret = sqlite3_bind_blob (stmt,
1323 sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1324 if ((type != 0) && (ret == SQLITE_OK))
1325 ret = sqlite3_bind_int (stmt, sqoff++, type);
1326 if (SQLITE_OK != ret)
1328 LOG_SQLITE (plugin, NULL,
1329 GNUNET_ERROR_TYPE_ERROR, "sqlite_bind");
1330 sqlite3_reset (stmt);
1331 sqlite3_finalize (stmt);
1332 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1335 ret = sqlite3_step (stmt);
1336 if (ret != SQLITE_ROW)
1338 LOG_SQLITE (plugin, NULL,
1339 GNUNET_ERROR_TYPE_ERROR| GNUNET_ERROR_TYPE_BULK,
1341 sqlite3_reset (stmt);
1342 sqlite3_finalize (stmt);
1343 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1346 total = sqlite3_column_int (stmt, 0);
1347 sqlite3_reset (stmt);
1348 sqlite3_finalize (stmt);
1351 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1355 GNUNET_snprintf (scratch, 256,
1356 "SELECT size, type, prio, anonLevel, expire, hash, value, _ROWID_ "
1357 "FROM gn080 WHERE hash=:1%s%s AND _ROWID_ >= :%d "
1358 "ORDER BY _ROWID_ ASC LIMIT 1 OFFSET :d",
1359 vhash == NULL ? "" : " AND vhash=:2",
1360 type == 0 ? "" : (vhash ==
1361 NULL) ? " AND type=:2" : " AND type=:3",
1363 if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
1365 LOG_SQLITE (plugin, NULL,
1366 GNUNET_ERROR_TYPE_ERROR |
1367 GNUNET_ERROR_TYPE_BULK, "sqlite_prepare");
1368 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1371 nc = GNUNET_malloc (sizeof(struct NextContext) +
1372 sizeof(struct GetNextContext));
1373 nc->plugin = plugin;
1375 nc->iter_cls = iter_cls;
1377 gpc = (struct GetNextContext*) &nc[1];
1381 gpc->stmt = stmt; /* alias used for freeing at the end! */
1384 gpc->have_vhash = GNUNET_YES;
1385 gpc->vhash = *vhash;
1387 gpc->off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, total);
1388 nc->prep = &get_next_prepare;
1390 sqlite_next_request (nc, GNUNET_NO);
1398 sqlite_plugin_drop (void *cls)
1400 struct Plugin *plugin = cls;
1401 plugin->drop_on_shutdown = GNUNET_YES;
1406 * Callback function to process statistic values.
1408 * @param cls closure
1409 * @param subsystem name of subsystem that created the statistic
1410 * @param name the name of the datum
1411 * @param value the current value
1412 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
1413 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
1416 process_stat_in (void *cls,
1417 const char *subsystem,
1419 unsigned long long value,
1422 struct Plugin *plugin = cls;
1423 plugin->payload += value;
1429 * Entry point for the plugin.
1432 libgnunet_plugin_datastore_sqlite_init (void *cls)
1434 static struct Plugin plugin;
1435 struct GNUNET_DATASTORE_PluginEnvironment *env = cls;
1436 struct GNUNET_DATASTORE_PluginFunctions *api;
1438 if (plugin.env != NULL)
1439 return NULL; /* can only initialize once! */
1440 memset (&plugin, 0, sizeof(struct Plugin));
1442 plugin.statistics = GNUNET_STATISTICS_create (env->sched,
1445 GNUNET_STATISTICS_get (plugin.statistics,
1448 GNUNET_TIME_UNIT_MINUTES,
1453 database_setup (env->cfg, &plugin))
1455 database_shutdown (&plugin);
1458 api = GNUNET_malloc (sizeof (struct GNUNET_DATASTORE_PluginFunctions));
1460 api->get_size = &sqlite_plugin_get_size;
1461 api->put = &sqlite_plugin_put;
1462 api->next_request = &sqlite_next_request;
1463 api->get = &sqlite_plugin_get;
1464 api->update = &sqlite_plugin_update;
1465 api->iter_low_priority = &sqlite_plugin_iter_low_priority;
1466 api->iter_zero_anonymity = &sqlite_plugin_iter_zero_anonymity;
1467 api->iter_ascending_expiration = &sqlite_plugin_iter_ascending_expiration;
1468 api->iter_migration_order = &sqlite_plugin_iter_migration_order;
1469 api->iter_all_now = &sqlite_plugin_iter_all_now;
1470 api->drop = &sqlite_plugin_drop;
1471 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
1472 "sqlite", _("Sqlite database running\n"));
1478 * Exit point from the plugin.
1481 libgnunet_plugin_datastore_sqlite_done (void *cls)
1484 struct GNUNET_DATASTORE_PluginFunctions *api = cls;
1485 struct Plugin *plugin = api->cls;
1488 if (plugin->drop_on_shutdown)
1489 fn = GNUNET_strdup (plugin->fn);
1490 database_shutdown (plugin);
1492 plugin->payload = 0;
1496 if (0 != UNLINK(fn))
1497 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
1505 /* end of plugin_datastore_sqlite.c */