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 INTEGER NOT NULL DEFAULT 0,"
289 " type INTEGER NOT NULL DEFAULT 0,"
290 " prio INTEGER NOT NULL DEFAULT 0,"
291 " anonLevel INTEGER NOT NULL DEFAULT 0,"
292 " expire INTEGER 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 * Expiration time of the last value visited.
485 struct GNUNET_TIME_Absolute lastExpiration;
488 * Priority of the last value visited.
490 unsigned int lastPriority;
493 * Number of results processed so far.
498 * Set to GNUNET_YES if we must stop now.
505 * Function invoked on behalf of a "PluginIterator"
506 * asking the database plugin to call the iterator
507 * with the next item.
509 * @param next_cls whatever argument was given
510 * to the PluginIterator as "next_cls".
511 * @param end_it set to GNUNET_YES if we
512 * should terminate the iteration early
513 * (iterator should be still called once more
514 * to signal the end of the iteration).
517 sqlite_next_request (void *next_cls,
520 static struct GNUNET_TIME_Absolute zero;
521 struct NextContext * nc= next_cls;
522 struct Plugin *plugin = nc->plugin;
523 unsigned long long rowid;
528 unsigned int priority;
529 unsigned int anonymity;
530 struct GNUNET_TIME_Absolute expiration;
531 const GNUNET_HashCode *key;
534 sqlite3_reset (nc->stmt);
535 if ( (GNUNET_YES == end_it) ||
536 (GNUNET_YES == nc->end_it) ||
537 (GNUNET_OK != (nc->prep(nc->prep_cls,
539 (SQLITE_ROW != sqlite3_step (nc->stmt)) )
542 nc->iter (nc->iter_cls,
543 NULL, NULL, 0, NULL, 0, 0, 0,
545 nc->prep (nc->prep_cls, NULL);
550 rowid = sqlite3_column_int64 (nc->stmt, 7);
551 nc->last_rowid = rowid;
552 type = sqlite3_column_int (nc->stmt, 1);
553 size = sqlite3_column_bytes (nc->stmt, 6);
554 if (sqlite3_column_bytes (nc->stmt, 5) != sizeof (GNUNET_HashCode))
556 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
558 _("Invalid data in database. Trying to fix (by deletion).\n"));
559 if (SQLITE_OK != sqlite3_reset (nc->stmt))
560 LOG_SQLITE (nc->plugin, NULL,
561 GNUNET_ERROR_TYPE_ERROR |
562 GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
565 "DELETE FROM gn080 WHERE NOT LENGTH(hash) = ?",
566 &stmtd) != SQLITE_OK)
568 LOG_SQLITE (nc->plugin, NULL,
569 GNUNET_ERROR_TYPE_ERROR |
570 GNUNET_ERROR_TYPE_BULK,
575 if (SQLITE_OK != sqlite3_bind_int (stmtd, 1, sizeof (GNUNET_HashCode)))
576 LOG_SQLITE (nc->plugin, NULL,
577 GNUNET_ERROR_TYPE_ERROR |
578 GNUNET_ERROR_TYPE_BULK, "sqlite3_bind_int");
579 if (SQLITE_DONE != sqlite3_step (stmtd))
580 LOG_SQLITE (nc->plugin, NULL,
581 GNUNET_ERROR_TYPE_ERROR |
582 GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
583 if (SQLITE_OK != sqlite3_finalize (stmtd))
584 LOG_SQLITE (nc->plugin, NULL,
585 GNUNET_ERROR_TYPE_ERROR |
586 GNUNET_ERROR_TYPE_BULK, "sqlite3_finalize");
590 priority = sqlite3_column_int (nc->stmt, 2);
591 nc->lastPriority = priority;
592 anonymity = sqlite3_column_int (nc->stmt, 3);
593 expiration.value = sqlite3_column_int64 (nc->stmt, 4);
594 nc->lastExpiration = expiration;
595 key = sqlite3_column_blob (nc->stmt, 5);
596 data = sqlite3_column_blob (nc->stmt, 6);
598 ret = nc->iter (nc->iter_cls,
608 if (ret == GNUNET_SYSERR)
610 nc->end_it = GNUNET_YES;
613 if ( (ret == GNUNET_NO) &&
614 (GNUNET_OK == delete_by_rowid (plugin, rowid)) )
616 plugin->payload -= (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
618 if (plugin->lastSync >= MAX_STAT_SYNC_LAG)
625 * Store an item in the datastore.
628 * @param key key for the item
629 * @param size number of bytes in data
630 * @param data content stored
631 * @param type type of the content
632 * @param priority priority of the content
633 * @param anonymity anonymity-level for the content
634 * @param expiration expiration time for the content
635 * @param msg set to an error message
636 * @return GNUNET_OK on success
639 sqlite_plugin_put (void *cls,
640 const GNUNET_HashCode * key,
646 struct GNUNET_TIME_Absolute expiration,
649 struct Plugin *plugin = cls;
652 GNUNET_HashCode vhash;
655 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
657 "Storing in database block with type %u/key `%s'/priority %u/expiration %llu.\n",
661 GNUNET_TIME_absolute_get_remaining (expiration).value);
663 GNUNET_CRYPTO_hash (data, size, &vhash);
664 stmt = plugin->insertContent;
665 if ((SQLITE_OK != sqlite3_bind_int (stmt, 1, size)) ||
666 (SQLITE_OK != sqlite3_bind_int (stmt, 2, type)) ||
667 (SQLITE_OK != sqlite3_bind_int (stmt, 3, priority)) ||
668 (SQLITE_OK != sqlite3_bind_int (stmt, 4, anonymity)) ||
669 (SQLITE_OK != sqlite3_bind_int64 (stmt, 5, expiration.value)) ||
671 sqlite3_bind_blob (stmt, 6, key, sizeof (GNUNET_HashCode),
672 SQLITE_TRANSIENT)) ||
674 sqlite3_bind_blob (stmt, 7, &vhash, sizeof (GNUNET_HashCode),
677 sqlite3_bind_blob (stmt, 8, data, size,
682 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_bind_XXXX");
683 if (SQLITE_OK != sqlite3_reset (stmt))
684 LOG_SQLITE (plugin, NULL,
685 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
686 return GNUNET_SYSERR;
689 n = sqlite3_step (stmt);
690 if (n != SQLITE_DONE)
692 if (n == SQLITE_BUSY)
694 LOG_SQLITE (plugin, msg,
695 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
696 sqlite3_reset (stmt);
700 LOG_SQLITE (plugin, msg,
701 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
702 sqlite3_reset (stmt);
703 return GNUNET_SYSERR;
705 if (SQLITE_OK != sqlite3_reset (stmt))
706 LOG_SQLITE (plugin, NULL,
707 GNUNET_ERROR_TYPE_ERROR |
708 GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
710 plugin->payload += size + GNUNET_DATASTORE_ENTRY_OVERHEAD;
711 if (plugin->lastSync >= MAX_STAT_SYNC_LAG)
714 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
716 "done writing content\n");
723 * Update the priority for a particular key in the datastore. If
724 * the expiration time in value is different than the time found in
725 * the datastore, the higher value should be kept. For the
726 * anonymity level, the lower value is to be used. The specified
727 * priority should be added to the existing priority, ignoring the
730 * Note that it is possible for multiple values to match this put.
731 * In that case, all of the respective values are updated.
733 * @param uid unique identifier of the datum
734 * @param delta by how much should the priority
735 * change? If priority + delta < 0 the
736 * priority should be set to 0 (never go
738 * @param expire new expiration time should be the
739 * MAX of any existing expiration time and
741 * @param msg set to an error message
742 * @return GNUNET_OK on success
745 sqlite_plugin_update (void *cls,
746 unsigned long long uid,
747 int delta, struct GNUNET_TIME_Absolute expire,
750 struct Plugin *plugin = cls;
753 sqlite3_bind_int (plugin->updPrio, 1, delta);
754 sqlite3_bind_int64 (plugin->updPrio, 2, expire.value);
755 sqlite3_bind_int64 (plugin->updPrio, 3, uid);
756 n = sqlite3_step (plugin->updPrio);
758 LOG_SQLITE (plugin, msg,
759 GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
763 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
767 sqlite3_reset (plugin->updPrio);
769 if (n == SQLITE_BUSY)
771 return n == SQLITE_OK ? GNUNET_OK : GNUNET_SYSERR;
777 sqlite3_stmt *stmt_1;
778 sqlite3_stmt *stmt_2;
782 int limit_nonanonymous;
789 iter_next_prepare (void *cls,
790 struct NextContext *nc)
792 struct IterContext *ic = cls;
793 struct Plugin *plugin = nc->plugin;
798 sqlite3_finalize (ic->stmt_1);
799 sqlite3_finalize (ic->stmt_2);
800 return GNUNET_SYSERR;
804 sqlite3_bind_int (ic->stmt_1, 1, nc->lastPriority);
805 sqlite3_bind_int (ic->stmt_2, 1, nc->lastPriority);
809 sqlite3_bind_int64 (ic->stmt_1, 1, nc->lastExpiration.value);
810 sqlite3_bind_int64 (ic->stmt_2, 1, nc->lastExpiration.value);
812 sqlite3_bind_blob (ic->stmt_1, 2,
814 sizeof (GNUNET_HashCode),
816 if (SQLITE_ROW == (ret = sqlite3_step (ic->stmt_1)))
818 nc->stmt = ic->stmt_1;
821 if (ret != SQLITE_DONE)
823 LOG_SQLITE (plugin, NULL,
824 GNUNET_ERROR_TYPE_ERROR |
825 GNUNET_ERROR_TYPE_BULK,
827 return GNUNET_SYSERR;
829 if (SQLITE_OK != sqlite3_reset (ic->stmt_1))
830 LOG_SQLITE (plugin, NULL,
831 GNUNET_ERROR_TYPE_ERROR |
832 GNUNET_ERROR_TYPE_BULK,
834 if (SQLITE_ROW == (ret = sqlite3_step (ic->stmt_2)))
836 nc->stmt = ic->stmt_2;
839 if (ret != SQLITE_DONE)
841 LOG_SQLITE (plugin, NULL,
842 GNUNET_ERROR_TYPE_ERROR |
843 GNUNET_ERROR_TYPE_BULK,
845 return GNUNET_SYSERR;
847 if (SQLITE_OK != sqlite3_reset (ic->stmt_2))
848 LOG_SQLITE (plugin, NULL,
849 GNUNET_ERROR_TYPE_ERROR |
850 GNUNET_ERROR_TYPE_BULK,
857 * Call a method for each key in the database and
858 * call the callback method on it.
860 * @param type entries of which type should be considered?
861 * @param iter function to call on each matching value;
862 * will be called once with a NULL value at the end
863 * @param iter_cls closure for iter
864 * @return the number of results processed,
865 * GNUNET_SYSERR on error
868 basic_iter (struct Plugin *plugin,
873 int limit_nonanonymous,
874 const char *stmt_str_1,
875 const char *stmt_str_2,
879 static struct GNUNET_TIME_Absolute zero;
880 struct NextContext *nc;
881 struct IterContext *ic;
882 sqlite3_stmt *stmt_1;
883 sqlite3_stmt *stmt_2;
885 if (sq_prepare (plugin->dbh, stmt_str_1, &stmt_1) != SQLITE_OK)
887 LOG_SQLITE (plugin, NULL,
888 GNUNET_ERROR_TYPE_ERROR |
889 GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
890 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
893 if (sq_prepare (plugin->dbh, stmt_str_2, &stmt_2) != SQLITE_OK)
895 LOG_SQLITE (plugin, NULL,
896 GNUNET_ERROR_TYPE_ERROR |
897 GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
898 sqlite3_finalize (stmt_1);
899 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
902 nc = GNUNET_malloc (sizeof(struct NextContext) +
903 sizeof(struct IterContext));
906 nc->iter_cls = iter_cls;
908 ic = (struct IterContext*) &nc[1];
913 ic->is_prio = is_prio;
914 ic->is_migr = is_migr;
915 ic->limit_nonanonymous = limit_nonanonymous;
916 nc->prep = &iter_next_prepare;
920 nc->lastPriority = 0;
921 nc->lastExpiration.value = 0;
922 memset (&ic->key, 0, sizeof (GNUNET_HashCode));
926 nc->lastPriority = 0x7FFFFFFF;
927 nc->lastExpiration.value = 0x7FFFFFFFFFFFFFFFLL;
928 memset (&ic->key, 255, sizeof (GNUNET_HashCode));
930 sqlite_next_request (nc, GNUNET_NO);
935 * Select a subset of the items in the datastore and call
936 * the given iterator for each of them.
938 * @param type entries of which type should be considered?
939 * Use 0 for any type.
940 * @param iter function to call on each matching value;
941 * will be called once with a NULL value at the end
942 * @param iter_cls closure for iter
945 sqlite_plugin_iter_low_priority (void *cls,
952 GNUNET_YES, GNUNET_YES,
953 GNUNET_NO, GNUNET_NO,
954 SELECT_IT_LOW_PRIORITY_1,
955 SELECT_IT_LOW_PRIORITY_2,
961 * Select a subset of the items in the datastore and call
962 * the given iterator for each of them.
964 * @param type entries of which type should be considered?
965 * Use 0 for any type.
966 * @param iter function to call on each matching value;
967 * will be called once with a NULL value at the end
968 * @param iter_cls closure for iter
971 sqlite_plugin_iter_zero_anonymity (void *cls,
978 GNUNET_NO, GNUNET_YES,
979 GNUNET_NO, GNUNET_YES,
980 SELECT_IT_NON_ANONYMOUS_1,
981 SELECT_IT_NON_ANONYMOUS_2,
988 * Select a subset of the items in the datastore and call
989 * the given iterator for each of them.
991 * @param type entries of which type should be considered?
992 * Use 0 for any type.
993 * @param iter function to call on each matching value;
994 * will be called once with a NULL value at the end
995 * @param iter_cls closure for iter
998 sqlite_plugin_iter_ascending_expiration (void *cls,
1000 PluginIterator iter,
1003 struct GNUNET_TIME_Absolute now;
1007 now = GNUNET_TIME_absolute_get ();
1008 GNUNET_asprintf (&q1, SELECT_IT_EXPIRATION_TIME_1,
1010 GNUNET_asprintf (&q2, SELECT_IT_EXPIRATION_TIME_2,
1014 GNUNET_YES, GNUNET_NO,
1015 GNUNET_NO, GNUNET_NO,
1024 * Select a subset of the items in the datastore and call
1025 * the given iterator for each of them.
1027 * @param type entries of which type should be considered?
1028 * Use 0 for any type.
1029 * @param iter function to call on each matching value;
1030 * will be called once with a NULL value at the end
1031 * @param iter_cls closure for iter
1034 sqlite_plugin_iter_migration_order (void *cls,
1036 PluginIterator iter,
1039 struct GNUNET_TIME_Absolute now;
1042 now = GNUNET_TIME_absolute_get ();
1043 GNUNET_asprintf (&q, SELECT_IT_MIGRATION_ORDER_2,
1047 GNUNET_NO, GNUNET_NO,
1048 GNUNET_YES, GNUNET_NO,
1049 SELECT_IT_MIGRATION_ORDER_1,
1058 * Select a subset of the items in the datastore and call
1059 * the given iterator for each of them.
1061 * @param type entries of which type should be considered?
1062 * Use 0 for any type.
1063 * @param iter function to call on each matching value;
1064 * will be called once with a NULL value at the end
1065 * @param iter_cls closure for iter
1068 sqlite_plugin_iter_all_now (void *cls,
1070 PluginIterator iter,
1073 static struct GNUNET_TIME_Absolute zero;
1074 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1078 struct GetNextContext
1085 GNUNET_HashCode key;
1086 GNUNET_HashCode vhash;
1091 get_next_prepare (void *cls,
1092 struct NextContext *nc)
1094 struct GetNextContext *gnc = cls;
1101 sqlite3_finalize (gnc->stmt);
1102 return GNUNET_SYSERR;
1104 if (nc->count == gnc->total)
1106 if (nc->count + gnc->off == gnc->total)
1109 limit_off = gnc->off;
1113 ret = sqlite3_bind_blob (nc->stmt,
1116 sizeof (GNUNET_HashCode),
1118 if ((gnc->have_vhash) && (ret == SQLITE_OK))
1119 ret = sqlite3_bind_blob (nc->stmt,
1122 sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1123 if ((gnc->type != 0) && (ret == SQLITE_OK))
1124 ret = sqlite3_bind_int (nc->stmt, sqoff++, gnc->type);
1125 if (ret == SQLITE_OK)
1126 ret = sqlite3_bind_int64 (nc->stmt, sqoff++, nc->last_rowid + 1);
1127 if (ret == SQLITE_OK)
1128 ret = sqlite3_bind_int (nc->stmt, sqoff++, limit_off);
1129 if (ret != SQLITE_OK)
1130 return GNUNET_SYSERR;
1131 if (SQLITE_ROW != sqlite3_step (nc->stmt))
1138 * Iterate over the results for a particular key
1141 * @param cls closure
1142 * @param key maybe NULL (to match all entries)
1143 * @param vhash hash of the value, maybe NULL (to
1144 * match all values that have the right key).
1145 * Note that for DBlocks there is no difference
1146 * betwen key and vhash, but for other blocks
1148 * @param type entries of which type are relevant?
1149 * Use 0 for any type.
1150 * @param iter function to call on each matching value;
1151 * will be called once with a NULL value at the end
1152 * @param iter_cls closure for iter
1155 sqlite_plugin_get (void *cls,
1156 const GNUNET_HashCode * key,
1157 const GNUNET_HashCode * vhash,
1159 PluginIterator iter, void *iter_cls)
1161 static struct GNUNET_TIME_Absolute zero;
1162 struct Plugin *plugin = cls;
1163 struct GetNextContext *gpc;
1164 struct NextContext *nc;
1171 GNUNET_assert (iter != NULL);
1174 sqlite_plugin_iter_low_priority (cls, type, iter, iter_cls);
1177 GNUNET_snprintf (scratch, 256,
1178 "SELECT count(*) FROM gn080 WHERE hash=:1%s%s",
1179 vhash == NULL ? "" : " AND vhash=:2",
1180 type == 0 ? "" : (vhash ==
1181 NULL) ? " AND type=:2" : " AND type=:3");
1182 if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
1184 LOG_SQLITE (plugin, NULL,
1185 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite_prepare");
1186 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1190 ret = sqlite3_bind_blob (stmt,
1192 key, sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1193 if ((vhash != NULL) && (ret == SQLITE_OK))
1194 ret = sqlite3_bind_blob (stmt,
1197 sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1198 if ((type != 0) && (ret == SQLITE_OK))
1199 ret = sqlite3_bind_int (stmt, sqoff++, type);
1200 if (SQLITE_OK != ret)
1202 LOG_SQLITE (plugin, NULL,
1203 GNUNET_ERROR_TYPE_ERROR, "sqlite_bind");
1204 sqlite3_reset (stmt);
1205 sqlite3_finalize (stmt);
1206 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1209 ret = sqlite3_step (stmt);
1210 if (ret != SQLITE_ROW)
1212 LOG_SQLITE (plugin, NULL,
1213 GNUNET_ERROR_TYPE_ERROR| GNUNET_ERROR_TYPE_BULK,
1215 sqlite3_reset (stmt);
1216 sqlite3_finalize (stmt);
1217 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1220 total = sqlite3_column_int (stmt, 0);
1221 sqlite3_reset (stmt);
1222 sqlite3_finalize (stmt);
1225 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1229 GNUNET_snprintf (scratch, 256,
1230 "SELECT size, type, prio, anonLevel, expire, hash, value, _ROWID_ "
1231 "FROM gn080 WHERE hash=:1%s%s AND _ROWID_ >= :%d "
1232 "ORDER BY _ROWID_ ASC LIMIT 1 OFFSET :d",
1233 vhash == NULL ? "" : " AND vhash=:2",
1234 type == 0 ? "" : (vhash ==
1235 NULL) ? " AND type=:2" : " AND type=:3",
1237 if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
1239 LOG_SQLITE (plugin, NULL,
1240 GNUNET_ERROR_TYPE_ERROR |
1241 GNUNET_ERROR_TYPE_BULK, "sqlite_prepare");
1242 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, zero, 0);
1245 nc = GNUNET_malloc (sizeof(struct NextContext) +
1246 sizeof(struct GetNextContext));
1247 nc->plugin = plugin;
1249 nc->iter_cls = iter_cls;
1251 gpc = (struct GetNextContext*) &nc[1];
1255 gpc->stmt = stmt; /* alias used for freeing at the end! */
1258 gpc->have_vhash = GNUNET_YES;
1259 gpc->vhash = *vhash;
1261 gpc->off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, total);
1262 nc->prep = &get_next_prepare;
1264 sqlite_next_request (nc, GNUNET_NO);
1272 sqlite_plugin_drop (void *cls)
1274 struct Plugin *plugin = cls;
1275 plugin->drop_on_shutdown = GNUNET_YES;
1280 * Callback function to process statistic values.
1282 * @param cls closure
1283 * @param subsystem name of subsystem that created the statistic
1284 * @param name the name of the datum
1285 * @param value the current value
1286 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
1287 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
1290 process_stat_in (void *cls,
1291 const char *subsystem,
1293 unsigned long long value,
1296 struct Plugin *plugin = cls;
1297 plugin->payload += value;
1303 * Entry point for the plugin.
1306 libgnunet_plugin_datastore_sqlite_init (void *cls)
1308 static struct Plugin plugin;
1309 struct GNUNET_DATASTORE_PluginEnvironment *env = cls;
1310 struct GNUNET_DATASTORE_PluginFunctions *api;
1312 if (plugin.env != NULL)
1313 return NULL; /* can only initialize once! */
1314 memset (&plugin, 0, sizeof(struct Plugin));
1316 plugin.statistics = GNUNET_STATISTICS_create (env->sched,
1319 GNUNET_STATISTICS_get (plugin.statistics,
1322 GNUNET_TIME_UNIT_MINUTES,
1327 database_setup (env->cfg, &plugin))
1329 database_shutdown (&plugin);
1332 api = GNUNET_malloc (sizeof (struct GNUNET_DATASTORE_PluginFunctions));
1334 api->get_size = &sqlite_plugin_get_size;
1335 api->put = &sqlite_plugin_put;
1336 api->next_request = &sqlite_next_request;
1337 api->get = &sqlite_plugin_get;
1338 api->update = &sqlite_plugin_update;
1339 api->iter_low_priority = &sqlite_plugin_iter_low_priority;
1340 api->iter_zero_anonymity = &sqlite_plugin_iter_zero_anonymity;
1341 api->iter_ascending_expiration = &sqlite_plugin_iter_ascending_expiration;
1342 api->iter_migration_order = &sqlite_plugin_iter_migration_order;
1343 api->iter_all_now = &sqlite_plugin_iter_all_now;
1344 api->drop = &sqlite_plugin_drop;
1345 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
1346 "sqlite", _("Sqlite database running\n"));
1352 * Exit point from the plugin.
1355 libgnunet_plugin_datastore_sqlite_done (void *cls)
1358 struct GNUNET_DATASTORE_PluginFunctions *api = cls;
1359 struct Plugin *plugin = api->cls;
1362 if (plugin->drop_on_shutdown)
1363 fn = GNUNET_strdup (plugin->fn);
1364 database_shutdown (plugin);
1366 plugin->payload = 0;
1370 if (0 != UNLINK(fn))
1371 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
1379 /* end of plugin_datastore_sqlite.c */