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)")
43 * Log an error message at log-level 'level' that indicates
44 * a failure of the command 'cmd' on file 'filename'
45 * with the message given by strerror(errno).
47 #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"), cmd, sqlite3_errmsg(db->dbh)); } while(0)
49 #define SELECT_IT_LOW_PRIORITY_1 \
50 "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (prio = ? AND hash > ?) "\
51 "ORDER BY hash ASC LIMIT 1"
53 #define SELECT_IT_LOW_PRIORITY_2 \
54 "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (prio > ?) "\
55 "ORDER BY prio ASC, hash ASC LIMIT 1"
57 #define SELECT_IT_NON_ANONYMOUS_1 \
58 "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (prio = ? AND hash < ? AND anonLevel = 0 AND expire > %llu) "\
59 " ORDER BY hash DESC LIMIT 1"
61 #define SELECT_IT_NON_ANONYMOUS_2 \
62 "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (prio < ? AND anonLevel = 0 AND expire > %llu)"\
63 " ORDER BY prio DESC, hash DESC LIMIT 1"
65 #define SELECT_IT_EXPIRATION_TIME_1 \
66 "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (expire = ? AND hash > ?) "\
67 " ORDER BY hash ASC LIMIT 1"
69 #define SELECT_IT_EXPIRATION_TIME_2 \
70 "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (expire > ?) "\
71 " ORDER BY expire ASC, hash ASC LIMIT 1"
73 #define SELECT_IT_MIGRATION_ORDER_1 \
74 "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (expire = ? AND hash < ?) "\
75 " ORDER BY hash DESC LIMIT 1"
77 #define SELECT_IT_MIGRATION_ORDER_2 \
78 "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080 WHERE (expire < ? AND expire > %llu) "\
79 " ORDER BY expire DESC, hash DESC LIMIT 1"
82 * After how many ms "busy" should a DB operation fail for good?
83 * A low value makes sure that we are more responsive to requests
84 * (especially PUTs). A high value guarantees a higher success
85 * rate (SELECTs in iterate can take several seconds despite LIMIT=1).
87 * The default value of 250ms should ensure that users do not experience
88 * huge latencies while at the same time allowing operations to succeed
89 * with reasonable probability.
91 #define BUSY_TIMEOUT_MS 250
95 * Context for all functions in this plugin.
100 * Our execution environment.
102 struct GNUNET_DATASTORE_PluginEnvironment *env;
110 * Native SQLite database handle.
115 * Precompiled SQL for update.
117 sqlite3_stmt *updPrio;
120 * Precompiled SQL for insertion.
122 sqlite3_stmt *insertContent;
125 * Handle to the statistics service.
127 struct GNUNET_STATISTICS_Handle *statistics;
130 * How much data are we currently storing
133 unsigned long long payload;
136 * Number of updates that were made to the
137 * payload value since we last synchronized
138 * it with the statistics service.
140 unsigned int lastSync;
143 * Should the database be dropped on shutdown?
145 int drop_on_shutdown;
150 * @brief Prepare a SQL statement
152 * @param dbh handle to the database
153 * @param zSql SQL statement, UTF-8 encoded
154 * @param ppStmt set to the prepared statement
155 * @return 0 on success
158 sq_prepare (sqlite3 * dbh, const char *zSql,
159 sqlite3_stmt ** ppStmt)
162 return sqlite3_prepare (dbh,
164 strlen (zSql), ppStmt, (const char **) &dummy);
169 * Create our database indices.
171 * @param dbh handle to the database
174 create_indices (sqlite3 * dbh)
178 "CREATE INDEX idx_hash ON gn080 (hash)", NULL, NULL, NULL);
180 "CREATE INDEX idx_hash_vhash ON gn080 (hash,vhash)", NULL,
182 sqlite3_exec (dbh, "CREATE INDEX idx_prio ON gn080 (prio)", NULL, NULL,
184 sqlite3_exec (dbh, "CREATE INDEX idx_expire ON gn080 (expire)", NULL, NULL,
186 sqlite3_exec (dbh, "CREATE INDEX idx_comb3 ON gn080 (prio,anonLevel)", NULL,
188 sqlite3_exec (dbh, "CREATE INDEX idx_comb4 ON gn080 (prio,hash,anonLevel)",
190 sqlite3_exec (dbh, "CREATE INDEX idx_comb7 ON gn080 (expire,hash)", NULL,
197 #define CHECK(a) GNUNET_break(a)
201 #define ENULL_DEFINED 1
202 #define CHECK(a) if (! a) { GNUNET_log(GNUNET_ERROR_TYPE_ERRROR, "%s\n", e); sqlite3_free(e); }
209 * Initialize the database connections and associated
210 * data structures (create tables and indices
211 * as needed as well).
213 * @param cfg our configuration
214 * @param plugin the plugin context (state for this module)
215 * @return GNUNET_OK on success
218 database_setup (const struct GNUNET_CONFIGURATION_Handle *cfg,
219 struct Plugin *plugin)
228 GNUNET_CONFIGURATION_get_value_filename (cfg,
233 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
235 _("Option `%s' in section `%s' missing in configuration!\n"),
238 return GNUNET_SYSERR;
240 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (afsdir))
243 GNUNET_free (afsdir);
244 return GNUNET_SYSERR;
246 plugin->fn = GNUNET_STRINGS_to_utf8 (afsdir, strlen (afsdir),
248 nl_langinfo (CODESET)
250 "UTF-8" /* good luck */
253 GNUNET_free (afsdir);
255 /* Open database and precompile statements */
256 if (sqlite3_open (plugin->fn, &plugin->dbh) != SQLITE_OK)
258 GNUNET_log_from (GNUNET_ERROR_TYPE_ERROR,
260 _("Unable to initialize SQLite: %s.\n"),
261 sqlite3_errmsg (plugin->dbh));
262 return GNUNET_SYSERR;
265 sqlite3_exec (plugin->dbh,
266 "PRAGMA temp_store=MEMORY", NULL, NULL, ENULL));
268 sqlite3_exec (plugin->dbh,
269 "PRAGMA synchronous=OFF", NULL, NULL, ENULL));
271 sqlite3_exec (plugin->dbh,
272 "PRAGMA count_changes=OFF", NULL, NULL, ENULL));
274 sqlite3_exec (plugin->dbh, "PRAGMA page_size=4092", NULL, NULL, ENULL));
276 CHECK (SQLITE_OK == sqlite3_busy_timeout (plugin->dbh, BUSY_TIMEOUT_MS));
279 /* We have to do it here, because otherwise precompiling SQL might fail */
281 sq_prepare (plugin->dbh,
282 "SELECT 1 FROM sqlite_master WHERE tbl_name = 'gn080'",
284 if ( (sqlite3_step (stmt) == SQLITE_DONE) &&
285 (sqlite3_exec (plugin->dbh,
286 "CREATE TABLE gn080 ("
287 " size INT4 NOT NULL DEFAULT 0,"
288 " type INT4 NOT NULL DEFAULT 0,"
289 " prio INT4 NOT NULL DEFAULT 0,"
290 " anonLevel INT4 NOT NULL DEFAULT 0,"
291 " expire INT8 NOT NULL DEFAULT 0,"
292 " hash TEXT NOT NULL DEFAULT '',"
293 " vhash TEXT NOT NULL DEFAULT '',"
294 " value BLOB NOT NULL DEFAULT '')", NULL, NULL,
295 NULL) != SQLITE_OK) )
297 LOG_SQLITE (plugin, NULL,
298 GNUNET_ERROR_TYPE_ERROR,
300 sqlite3_finalize (stmt);
301 return GNUNET_SYSERR;
303 sqlite3_finalize (stmt);
304 create_indices (plugin->dbh);
307 sq_prepare (plugin->dbh,
308 "SELECT 1 FROM sqlite_master WHERE tbl_name = 'gn071'",
310 if ( (sqlite3_step (stmt) == SQLITE_DONE) &&
311 (sqlite3_exec (plugin->dbh,
312 "CREATE TABLE gn071 ("
313 " key TEXT NOT NULL DEFAULT '',"
314 " value INTEGER NOT NULL DEFAULT 0)", NULL, NULL,
315 NULL) != SQLITE_OK) )
317 LOG_SQLITE (plugin, NULL,
318 GNUNET_ERROR_TYPE_ERROR, "sqlite3_exec");
319 sqlite3_finalize (stmt);
320 return GNUNET_SYSERR;
322 sqlite3_finalize (stmt);
324 if ((sq_prepare (plugin->dbh,
325 "UPDATE gn080 SET prio = prio + ?, expire = MAX(expire,?) WHERE "
327 &plugin->updPrio) != SQLITE_OK) ||
328 (sq_prepare (plugin->dbh,
329 "INSERT INTO gn080 (size, type, prio, "
330 "anonLevel, expire, hash, vhash, value) VALUES "
331 "(?, ?, ?, ?, ?, ?, ?, ?)",
332 &plugin->insertContent) != SQLITE_OK))
334 LOG_SQLITE (plugin, NULL,
335 GNUNET_ERROR_TYPE_ERROR, "precompiling");
336 return GNUNET_SYSERR;
343 * Synchronize our utilization statistics with the
344 * statistics service.
345 * @param plugin the plugin context (state for this module)
348 sync_stats (struct Plugin *plugin)
350 GNUNET_STATISTICS_set (plugin->statistics,
354 plugin->lastSync = 0;
359 * Shutdown database connection and associate data
361 * @param plugin the plugin context (state for this module)
364 database_shutdown (struct Plugin *plugin)
366 if (plugin->lastSync > 0)
368 if (plugin->updPrio != NULL)
369 sqlite3_finalize (plugin->updPrio);
370 if (plugin->insertContent != NULL)
371 sqlite3_finalize (plugin->insertContent);
372 sqlite3_close (plugin->dbh);
373 GNUNET_free_non_null (plugin->fn);
378 * Get an estimate of how much space the database is
381 * @param cls our plugin context
382 * @return number of bytes used on disk
384 static unsigned long long sqlite_plugin_get_size (void *cls)
386 struct Plugin *plugin = cls;
387 return plugin->payload;
392 * Delete the database entry with the given
395 * @param plugin the plugin context (state for this module)
396 * @param rid the ID of the row to delete
399 delete_by_rowid (struct Plugin* plugin,
400 unsigned long long rid)
404 if (sq_prepare (plugin->dbh,
405 "DELETE FROM gn080 WHERE _ROWID_ = ?", &stmt) != SQLITE_OK)
407 LOG_SQLITE (plugin, NULL,
408 GNUNET_ERROR_TYPE_ERROR |
409 GNUNET_ERROR_TYPE_BULK, "sq_prepare");
410 return GNUNET_SYSERR;
412 sqlite3_bind_int64 (stmt, 1, rid);
413 if (SQLITE_DONE != sqlite3_step (stmt))
415 LOG_SQLITE (plugin, NULL,
416 GNUNET_ERROR_TYPE_ERROR |
417 GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
418 sqlite3_finalize (stmt);
419 return GNUNET_SYSERR;
421 sqlite3_finalize (stmt);
427 * Context for the universal iterator.
432 * Type of a function that will prepare
433 * the next iteration.
436 * @param nc the next context; NULL for the last
437 * call which gives the callback a chance to
438 * clean up the closure
439 * @return GNUNET_OK on success, GNUNET_NO if there are
440 * no more values, GNUNET_SYSERR on error
442 typedef int (*PrepareFunction)(void *cls,
443 struct NextContext *nc);
447 * Context we keep for the "next request" callback.
454 struct Plugin *plugin;
457 * Function to call on the next value.
467 * Function to call to prepare the next
470 PrepareFunction prep;
478 * Statement that the iterator will get the data
479 * from (updated or set by prep).
484 * Row ID of the last result.
486 unsigned long long last_rowid;
489 * Key of the last result.
491 GNUNET_HashCode lastKey;
494 * Expiration time of the last value visited.
496 struct GNUNET_TIME_Absolute lastExpiration;
499 * Priority of the last value visited.
501 unsigned int lastPriority;
504 * Number of results processed so far.
509 * Set to GNUNET_YES if we must stop now.
516 * Continuation of "sqlite_next_request".
518 * @param cls the next context
519 * @param tc the task context (unused)
522 sqlite_next_request_cont (void *cls,
523 const struct GNUNET_SCHEDULER_TaskContext *tc)
525 struct NextContext * nc= cls;
526 struct Plugin *plugin;
527 unsigned long long rowid;
532 unsigned int priority;
533 unsigned int anonymity;
534 struct GNUNET_TIME_Absolute expiration;
535 const GNUNET_HashCode *key;
540 if ( (GNUNET_YES == nc->end_it) ||
541 (GNUNET_OK != (nc->prep(nc->prep_cls,
545 nc->iter (nc->iter_cls,
546 NULL, NULL, 0, NULL, 0, 0, 0,
547 GNUNET_TIME_UNIT_ZERO_ABS, 0);
548 nc->prep (nc->prep_cls, NULL);
553 rowid = sqlite3_column_int64 (nc->stmt, 7);
554 nc->last_rowid = rowid;
555 type = sqlite3_column_int (nc->stmt, 1);
556 size = sqlite3_column_bytes (nc->stmt, 6);
557 if (sqlite3_column_bytes (nc->stmt, 5) != sizeof (GNUNET_HashCode))
559 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
561 _("Invalid data in database. Trying to fix (by deletion).\n"));
562 if (SQLITE_OK != sqlite3_reset (nc->stmt))
563 LOG_SQLITE (nc->plugin, NULL,
564 GNUNET_ERROR_TYPE_ERROR |
565 GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
568 "DELETE FROM gn080 WHERE NOT LENGTH(hash) = ?",
569 &stmtd) != SQLITE_OK)
571 LOG_SQLITE (nc->plugin, NULL,
572 GNUNET_ERROR_TYPE_ERROR |
573 GNUNET_ERROR_TYPE_BULK,
578 if (SQLITE_OK != sqlite3_bind_int (stmtd, 1, sizeof (GNUNET_HashCode)))
579 LOG_SQLITE (nc->plugin, NULL,
580 GNUNET_ERROR_TYPE_ERROR |
581 GNUNET_ERROR_TYPE_BULK, "sqlite3_bind_int");
582 if (SQLITE_DONE != sqlite3_step (stmtd))
583 LOG_SQLITE (nc->plugin, NULL,
584 GNUNET_ERROR_TYPE_ERROR |
585 GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
586 if (SQLITE_OK != sqlite3_finalize (stmtd))
587 LOG_SQLITE (nc->plugin, NULL,
588 GNUNET_ERROR_TYPE_ERROR |
589 GNUNET_ERROR_TYPE_BULK, "sqlite3_finalize");
593 priority = sqlite3_column_int (nc->stmt, 2);
594 anonymity = sqlite3_column_int (nc->stmt, 3);
595 expiration.value = sqlite3_column_int64 (nc->stmt, 4);
596 key = sqlite3_column_blob (nc->stmt, 5);
597 nc->lastPriority = priority;
598 nc->lastExpiration = expiration;
599 memcpy (&nc->lastKey, key, sizeof(GNUNET_HashCode));
600 data = sqlite3_column_blob (nc->stmt, 6);
602 ret = nc->iter (nc->iter_cls,
612 if (ret == GNUNET_SYSERR)
614 nc->end_it = GNUNET_YES;
618 if (ret == GNUNET_NO)
619 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
621 "Asked to remove entry %llu (%u bytes)\n",
622 (unsigned long long) rowid,
623 size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
625 if ( (ret == GNUNET_NO) &&
626 (GNUNET_OK == delete_by_rowid (plugin, rowid)) )
628 plugin->payload -= (size + GNUNET_DATASTORE_ENTRY_OVERHEAD);
631 if (ret == GNUNET_NO)
632 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
634 "Removed entry %llu (%u bytes), new payload is %llu\n",
635 (unsigned long long) rowid,
636 size + GNUNET_DATASTORE_ENTRY_OVERHEAD,
637 (unsigned long long) plugin->payload);
639 if (plugin->lastSync >= MAX_STAT_SYNC_LAG)
646 * Function invoked on behalf of a "PluginIterator"
647 * asking the database plugin to call the iterator
648 * with the next item.
650 * @param next_cls whatever argument was given
651 * to the PluginIterator as "next_cls".
652 * @param end_it set to GNUNET_YES if we
653 * should terminate the iteration early
654 * (iterator should be still called once more
655 * to signal the end of the iteration).
658 sqlite_next_request (void *next_cls,
661 struct NextContext * nc= next_cls;
663 if (GNUNET_YES == end_it)
664 nc->end_it = GNUNET_YES;
665 GNUNET_SCHEDULER_add_continuation (nc->plugin->env->sched,
667 &sqlite_next_request_cont,
669 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
675 * Store an item in the datastore.
678 * @param key key for the item
679 * @param size number of bytes in data
680 * @param data content stored
681 * @param type type of the content
682 * @param priority priority of the content
683 * @param anonymity anonymity-level for the content
684 * @param expiration expiration time for the content
685 * @param msg set to an error message
686 * @return GNUNET_OK on success
689 sqlite_plugin_put (void *cls,
690 const GNUNET_HashCode * key,
696 struct GNUNET_TIME_Absolute expiration,
699 struct Plugin *plugin = cls;
702 GNUNET_HashCode vhash;
705 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
707 "Storing in database block with type %u/key `%s'/priority %u/expiration %llu (%lld).\n",
711 (unsigned long long) GNUNET_TIME_absolute_get_remaining (expiration).value,
712 (long long) expiration.value);
714 GNUNET_CRYPTO_hash (data, size, &vhash);
715 stmt = plugin->insertContent;
716 if ((SQLITE_OK != sqlite3_bind_int (stmt, 1, size)) ||
717 (SQLITE_OK != sqlite3_bind_int (stmt, 2, type)) ||
718 (SQLITE_OK != sqlite3_bind_int (stmt, 3, priority)) ||
719 (SQLITE_OK != sqlite3_bind_int (stmt, 4, anonymity)) ||
720 (SQLITE_OK != sqlite3_bind_int64 (stmt, 5, (sqlite3_int64) expiration.value)) ||
722 sqlite3_bind_blob (stmt, 6, key, sizeof (GNUNET_HashCode),
723 SQLITE_TRANSIENT)) ||
725 sqlite3_bind_blob (stmt, 7, &vhash, sizeof (GNUNET_HashCode),
728 sqlite3_bind_blob (stmt, 8, data, size,
733 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_bind_XXXX");
734 if (SQLITE_OK != sqlite3_reset (stmt))
735 LOG_SQLITE (plugin, NULL,
736 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
737 return GNUNET_SYSERR;
739 n = sqlite3_step (stmt);
740 if (n != SQLITE_DONE)
742 if (n == SQLITE_BUSY)
744 LOG_SQLITE (plugin, msg,
745 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
746 sqlite3_reset (stmt);
750 LOG_SQLITE (plugin, msg,
751 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_step");
752 sqlite3_reset (stmt);
753 return GNUNET_SYSERR;
755 if (SQLITE_OK != sqlite3_reset (stmt))
756 LOG_SQLITE (plugin, NULL,
757 GNUNET_ERROR_TYPE_ERROR |
758 GNUNET_ERROR_TYPE_BULK, "sqlite3_reset");
760 plugin->payload += size + GNUNET_DATASTORE_ENTRY_OVERHEAD;
762 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
764 "Stored new entry (%u bytes), new payload is %llu\n",
765 size + GNUNET_DATASTORE_ENTRY_OVERHEAD,
766 (unsigned long long) plugin->payload);
768 if (plugin->lastSync >= MAX_STAT_SYNC_LAG)
775 * Update the priority for a particular key in the datastore. If
776 * the expiration time in value is different than the time found in
777 * the datastore, the higher value should be kept. For the
778 * anonymity level, the lower value is to be used. The specified
779 * priority should be added to the existing priority, ignoring the
782 * Note that it is possible for multiple values to match this put.
783 * In that case, all of the respective values are updated.
785 * @param cls the plugin context (state for this module)
786 * @param uid unique identifier of the datum
787 * @param delta by how much should the priority
788 * change? If priority + delta < 0 the
789 * priority should be set to 0 (never go
791 * @param expire new expiration time should be the
792 * MAX of any existing expiration time and
794 * @param msg set to an error message
795 * @return GNUNET_OK on success
798 sqlite_plugin_update (void *cls,
800 int delta, struct GNUNET_TIME_Absolute expire,
803 struct Plugin *plugin = cls;
806 sqlite3_bind_int (plugin->updPrio, 1, delta);
807 sqlite3_bind_int64 (plugin->updPrio, 2, expire.value);
808 sqlite3_bind_int64 (plugin->updPrio, 3, uid);
809 n = sqlite3_step (plugin->updPrio);
810 if (n != SQLITE_DONE)
811 LOG_SQLITE (plugin, msg,
812 GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
816 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
820 sqlite3_reset (plugin->updPrio);
822 if (n == SQLITE_BUSY)
824 return n == SQLITE_DONE ? GNUNET_OK : GNUNET_SYSERR;
829 * Internal context for an iteration.
836 sqlite3_stmt *stmt_1;
841 sqlite3_stmt *stmt_2;
861 int limit_nonanonymous;
864 * Desired type for blocks returned by this iterator.
871 * Prepare our SQL query to obtain the next record from the database.
873 * @param cls our "struct IterContext"
874 * @param nc NULL to terminate the iteration, otherwise our context for
875 * getting the next result.
876 * @return GNUNET_OK on success, GNUNET_NO if there are no more results,
877 * GNUNET_SYSERR on error (or end of iteration)
880 iter_next_prepare (void *cls,
881 struct NextContext *nc)
883 struct IterContext *ic = cls;
884 struct Plugin *plugin;
890 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
891 "Asked to clean up iterator state.\n");
893 sqlite3_finalize (ic->stmt_1);
894 sqlite3_finalize (ic->stmt_2);
895 return GNUNET_SYSERR;
897 sqlite3_reset (ic->stmt_1);
898 sqlite3_reset (ic->stmt_2);
903 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
904 "Restricting to results larger than the last priority %u\n",
907 sqlite3_bind_int (ic->stmt_1, 1, nc->lastPriority);
908 sqlite3_bind_int (ic->stmt_2, 1, nc->lastPriority);
913 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
914 "Restricting to results larger than the last expiration %llu\n",
915 (unsigned long long) nc->lastExpiration.value);
917 sqlite3_bind_int64 (ic->stmt_1, 1, nc->lastExpiration.value);
918 sqlite3_bind_int64 (ic->stmt_2, 1, nc->lastExpiration.value);
921 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
922 "Restricting to results larger than the last key `%s'\n",
923 GNUNET_h2s(&nc->lastKey));
925 sqlite3_bind_blob (ic->stmt_1, 2,
927 sizeof (GNUNET_HashCode),
929 if (SQLITE_ROW == (ret = sqlite3_step (ic->stmt_1)))
932 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
933 "Result found using iterator 1\n");
935 nc->stmt = ic->stmt_1;
938 if (ret != SQLITE_DONE)
940 LOG_SQLITE (plugin, NULL,
941 GNUNET_ERROR_TYPE_ERROR |
942 GNUNET_ERROR_TYPE_BULK,
944 return GNUNET_SYSERR;
946 if (SQLITE_OK != sqlite3_reset (ic->stmt_1))
947 LOG_SQLITE (plugin, NULL,
948 GNUNET_ERROR_TYPE_ERROR |
949 GNUNET_ERROR_TYPE_BULK,
951 if (SQLITE_ROW == (ret = sqlite3_step (ic->stmt_2)))
954 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
955 "Result found using iterator 2\n");
957 nc->stmt = ic->stmt_2;
960 if (ret != SQLITE_DONE)
962 LOG_SQLITE (plugin, NULL,
963 GNUNET_ERROR_TYPE_ERROR |
964 GNUNET_ERROR_TYPE_BULK,
966 return GNUNET_SYSERR;
968 if (SQLITE_OK != sqlite3_reset (ic->stmt_2))
969 LOG_SQLITE (plugin, NULL,
970 GNUNET_ERROR_TYPE_ERROR |
971 GNUNET_ERROR_TYPE_BULK,
974 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
975 "No result found using either iterator\n");
982 * Call a method for each key in the database and
983 * call the callback method on it.
985 * @param plugin our plugin context
986 * @param type entries of which type should be considered?
987 * @param is_asc are we iterating in ascending order?
988 * @param is_prio are we iterating by priority (otherwise by expiration)
989 * @param is_migr are we iterating in migration order?
990 * @param limit_nonanonymous are we restricting results to those with anonymity
992 * @param stmt_str_1 first SQL statement to execute
993 * @param stmt_str_2 SQL statement to execute to get "more" results (inner iteration)
994 * @param iter function to call on each matching value;
995 * will be called once with a NULL value at the end
996 * @param iter_cls closure for iter
999 basic_iter (struct Plugin *plugin,
1004 int limit_nonanonymous,
1005 const char *stmt_str_1,
1006 const char *stmt_str_2,
1007 PluginIterator iter,
1010 struct NextContext *nc;
1011 struct IterContext *ic;
1012 sqlite3_stmt *stmt_1;
1013 sqlite3_stmt *stmt_2;
1016 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1017 "At %llu, using queries `%s' and `%s'\n",
1018 (unsigned long long) GNUNET_TIME_absolute_get ().value,
1022 if (sq_prepare (plugin->dbh, stmt_str_1, &stmt_1) != SQLITE_OK)
1024 LOG_SQLITE (plugin, NULL,
1025 GNUNET_ERROR_TYPE_ERROR |
1026 GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
1027 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1030 if (sq_prepare (plugin->dbh, stmt_str_2, &stmt_2) != SQLITE_OK)
1032 LOG_SQLITE (plugin, NULL,
1033 GNUNET_ERROR_TYPE_ERROR |
1034 GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
1035 sqlite3_finalize (stmt_1);
1036 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1039 nc = GNUNET_malloc (sizeof(struct NextContext) +
1040 sizeof(struct IterContext));
1041 nc->plugin = plugin;
1043 nc->iter_cls = iter_cls;
1045 ic = (struct IterContext*) &nc[1];
1046 ic->stmt_1 = stmt_1;
1047 ic->stmt_2 = stmt_2;
1049 ic->is_asc = is_asc;
1050 ic->is_prio = is_prio;
1051 ic->is_migr = is_migr;
1052 ic->limit_nonanonymous = limit_nonanonymous;
1053 nc->prep = &iter_next_prepare;
1057 nc->lastPriority = 0;
1058 nc->lastExpiration.value = 0;
1059 memset (&nc->lastKey, 0, sizeof (GNUNET_HashCode));
1063 nc->lastPriority = 0x7FFFFFFF;
1064 nc->lastExpiration.value = 0x7FFFFFFFFFFFFFFFLL;
1065 memset (&nc->lastKey, 255, sizeof (GNUNET_HashCode));
1067 sqlite_next_request (nc, GNUNET_NO);
1072 * Select a subset of the items in the datastore and call
1073 * the given iterator for each of them.
1075 * @param cls our plugin context
1076 * @param type entries of which type should be considered?
1077 * Use 0 for any type.
1078 * @param iter function to call on each matching value;
1079 * will be called once with a NULL value at the end
1080 * @param iter_cls closure for iter
1083 sqlite_plugin_iter_low_priority (void *cls,
1085 PluginIterator iter,
1090 GNUNET_YES, GNUNET_YES,
1091 GNUNET_NO, GNUNET_NO,
1092 SELECT_IT_LOW_PRIORITY_1,
1093 SELECT_IT_LOW_PRIORITY_2,
1099 * Select a subset of the items in the datastore and call
1100 * the given iterator for each of them.
1102 * @param cls our plugin context
1103 * @param type entries of which type should be considered?
1104 * Use 0 for any type.
1105 * @param iter function to call on each matching value;
1106 * will be called once with a NULL value at the end
1107 * @param iter_cls closure for iter
1110 sqlite_plugin_iter_zero_anonymity (void *cls,
1112 PluginIterator iter,
1115 struct GNUNET_TIME_Absolute now;
1119 now = GNUNET_TIME_absolute_get ();
1120 GNUNET_asprintf (&q1, SELECT_IT_NON_ANONYMOUS_1,
1121 (unsigned long long) now.value);
1122 GNUNET_asprintf (&q2, SELECT_IT_NON_ANONYMOUS_2,
1123 (unsigned long long) now.value);
1126 GNUNET_NO, GNUNET_YES,
1127 GNUNET_NO, GNUNET_YES,
1138 * Select a subset of the items in the datastore and call
1139 * the given iterator for each of them.
1141 * @param cls our plugin context
1142 * @param type entries of which type should be considered?
1143 * Use 0 for any type.
1144 * @param iter function to call on each matching value;
1145 * will be called once with a NULL value at the end
1146 * @param iter_cls closure for iter
1149 sqlite_plugin_iter_ascending_expiration (void *cls,
1151 PluginIterator iter,
1154 struct GNUNET_TIME_Absolute now;
1158 now = GNUNET_TIME_absolute_get ();
1159 GNUNET_asprintf (&q1, SELECT_IT_EXPIRATION_TIME_1,
1160 (unsigned long long) 0*now.value);
1161 GNUNET_asprintf (&q2, SELECT_IT_EXPIRATION_TIME_2,
1162 (unsigned long long) 0*now.value);
1165 GNUNET_YES, GNUNET_NO,
1166 GNUNET_NO, GNUNET_NO,
1175 * Select a subset of the items in the datastore and call
1176 * the given iterator for each of them.
1178 * @param cls our plugin context
1179 * @param type entries of which type should be considered?
1180 * Use 0 for any type.
1181 * @param iter function to call on each matching value;
1182 * will be called once with a NULL value at the end
1183 * @param iter_cls closure for iter
1186 sqlite_plugin_iter_migration_order (void *cls,
1188 PluginIterator iter,
1191 struct GNUNET_TIME_Absolute now;
1194 now = GNUNET_TIME_absolute_get ();
1195 GNUNET_asprintf (&q, SELECT_IT_MIGRATION_ORDER_2,
1196 (unsigned long long) now.value);
1199 GNUNET_NO, GNUNET_NO,
1200 GNUNET_YES, GNUNET_NO,
1201 SELECT_IT_MIGRATION_ORDER_1,
1209 * Call sqlite using the already prepared query to get
1212 * @param cls not used
1213 * @param nc context with the prepared query
1214 * @return GNUNET_OK on success, GNUNET_SYSERR on error, GNUNET_NO if
1215 * there are no more results
1218 all_next_prepare (void *cls,
1219 struct NextContext *nc)
1221 struct Plugin *plugin;
1227 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1228 "Asked to clean up iterator state.\n");
1230 return GNUNET_SYSERR;
1232 plugin = nc->plugin;
1233 if (SQLITE_ROW == (ret = sqlite3_step (nc->stmt)))
1237 if (ret != SQLITE_DONE)
1239 LOG_SQLITE (plugin, NULL,
1240 GNUNET_ERROR_TYPE_ERROR |
1241 GNUNET_ERROR_TYPE_BULK,
1243 return GNUNET_SYSERR;
1250 * Select a subset of the items in the datastore and call
1251 * the given iterator for each of them.
1253 * @param cls our plugin context
1254 * @param type entries of which type should be considered?
1255 * Use 0 for any type.
1256 * @param iter function to call on each matching value;
1257 * will be called once with a NULL value at the end
1258 * @param iter_cls closure for iter
1261 sqlite_plugin_iter_all_now (void *cls,
1263 PluginIterator iter,
1266 struct Plugin *plugin = cls;
1267 struct NextContext *nc;
1270 if (sq_prepare (plugin->dbh,
1271 "SELECT size,type,prio,anonLevel,expire,hash,value,_ROWID_ FROM gn080",
1272 &stmt) != SQLITE_OK)
1274 LOG_SQLITE (plugin, NULL,
1275 GNUNET_ERROR_TYPE_ERROR |
1276 GNUNET_ERROR_TYPE_BULK, "sqlite3_prepare");
1277 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1280 nc = GNUNET_malloc (sizeof(struct NextContext));
1281 nc->plugin = plugin;
1283 nc->iter_cls = iter_cls;
1285 nc->prep = &all_next_prepare;
1286 nc->prep_cls = NULL;
1287 sqlite_next_request (nc, GNUNET_NO);
1294 struct GetNextContext
1325 GNUNET_HashCode key;
1330 GNUNET_HashCode vhash;
1338 * @param cls our "struct GetNextContext*"
1340 * @return GNUNET_YES if there are more results,
1341 * GNUNET_NO if there are no more results,
1342 * GNUNET_SYSERR on internal error
1345 get_next_prepare (void *cls,
1346 struct NextContext *nc)
1348 struct GetNextContext *gnc = cls;
1355 sqlite3_finalize (gnc->stmt);
1356 return GNUNET_SYSERR;
1358 if (nc->count == gnc->total)
1360 if (nc->count + gnc->off == gnc->total)
1363 limit_off = gnc->off;
1367 sqlite3_reset (nc->stmt);
1368 ret = sqlite3_bind_blob (nc->stmt,
1371 sizeof (GNUNET_HashCode),
1373 if ((gnc->have_vhash) && (ret == SQLITE_OK))
1374 ret = sqlite3_bind_blob (nc->stmt,
1377 sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1378 if ((gnc->type != 0) && (ret == SQLITE_OK))
1379 ret = sqlite3_bind_int (nc->stmt, sqoff++, gnc->type);
1380 if (ret == SQLITE_OK)
1381 ret = sqlite3_bind_int64 (nc->stmt, sqoff++, nc->last_rowid + 1);
1382 if (ret == SQLITE_OK)
1383 ret = sqlite3_bind_int (nc->stmt, sqoff++, limit_off);
1384 if (ret != SQLITE_OK)
1385 return GNUNET_SYSERR;
1386 if (SQLITE_ROW != sqlite3_step (nc->stmt))
1393 * Iterate over the results for a particular key
1396 * @param cls closure
1397 * @param key maybe NULL (to match all entries)
1398 * @param vhash hash of the value, maybe NULL (to
1399 * match all values that have the right key).
1400 * Note that for DBlocks there is no difference
1401 * betwen key and vhash, but for other blocks
1403 * @param type entries of which type are relevant?
1404 * Use 0 for any type.
1405 * @param iter function to call on each matching value;
1406 * will be called once with a NULL value at the end
1407 * @param iter_cls closure for iter
1410 sqlite_plugin_get (void *cls,
1411 const GNUNET_HashCode * key,
1412 const GNUNET_HashCode * vhash,
1414 PluginIterator iter, void *iter_cls)
1416 struct Plugin *plugin = cls;
1417 struct GetNextContext *gpc;
1418 struct NextContext *nc;
1425 GNUNET_assert (iter != NULL);
1428 sqlite_plugin_iter_low_priority (cls, type, iter, iter_cls);
1431 GNUNET_snprintf (scratch, 256,
1432 "SELECT count(*) FROM gn080 WHERE hash=:1%s%s",
1433 vhash == NULL ? "" : " AND vhash=:2",
1434 type == 0 ? "" : (vhash ==
1435 NULL) ? " AND type=:2" : " AND type=:3");
1436 if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
1438 LOG_SQLITE (plugin, NULL,
1439 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite_prepare");
1440 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1444 ret = sqlite3_bind_blob (stmt,
1446 key, sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1447 if ((vhash != NULL) && (ret == SQLITE_OK))
1448 ret = sqlite3_bind_blob (stmt,
1451 sizeof (GNUNET_HashCode), SQLITE_TRANSIENT);
1452 if ((type != 0) && (ret == SQLITE_OK))
1453 ret = sqlite3_bind_int (stmt, sqoff++, type);
1454 if (SQLITE_OK != ret)
1456 LOG_SQLITE (plugin, NULL,
1457 GNUNET_ERROR_TYPE_ERROR, "sqlite_bind");
1458 sqlite3_reset (stmt);
1459 sqlite3_finalize (stmt);
1460 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1463 ret = sqlite3_step (stmt);
1464 if (ret != SQLITE_ROW)
1466 LOG_SQLITE (plugin, NULL,
1467 GNUNET_ERROR_TYPE_ERROR| GNUNET_ERROR_TYPE_BULK,
1469 sqlite3_reset (stmt);
1470 sqlite3_finalize (stmt);
1471 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1474 total = sqlite3_column_int (stmt, 0);
1475 sqlite3_reset (stmt);
1476 sqlite3_finalize (stmt);
1479 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1483 GNUNET_snprintf (scratch, 256,
1484 "SELECT size, type, prio, anonLevel, expire, hash, value, _ROWID_ "
1485 "FROM gn080 WHERE hash=:1%s%s AND _ROWID_ >= :%d "
1486 "ORDER BY _ROWID_ ASC LIMIT 1 OFFSET :d",
1487 vhash == NULL ? "" : " AND vhash=:2",
1488 type == 0 ? "" : (vhash ==
1489 NULL) ? " AND type=:2" : " AND type=:3",
1491 if (sq_prepare (plugin->dbh, scratch, &stmt) != SQLITE_OK)
1493 LOG_SQLITE (plugin, NULL,
1494 GNUNET_ERROR_TYPE_ERROR |
1495 GNUNET_ERROR_TYPE_BULK, "sqlite_prepare");
1496 iter (iter_cls, NULL, NULL, 0, NULL, 0, 0, 0, GNUNET_TIME_UNIT_ZERO_ABS, 0);
1499 nc = GNUNET_malloc (sizeof(struct NextContext) +
1500 sizeof(struct GetNextContext));
1501 nc->plugin = plugin;
1503 nc->iter_cls = iter_cls;
1505 gpc = (struct GetNextContext*) &nc[1];
1509 gpc->stmt = stmt; /* alias used for freeing at the end! */
1512 gpc->have_vhash = GNUNET_YES;
1513 gpc->vhash = *vhash;
1515 gpc->off = GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK, total);
1516 nc->prep = &get_next_prepare;
1518 sqlite_next_request (nc, GNUNET_NO);
1525 * @param cls our plugin context
1528 sqlite_plugin_drop (void *cls)
1530 struct Plugin *plugin = cls;
1531 plugin->drop_on_shutdown = GNUNET_YES;
1536 * Callback function to process statistic values.
1538 * @param cls closure
1539 * @param subsystem name of subsystem that created the statistic
1540 * @param name the name of the datum
1541 * @param value the current value
1542 * @param is_persistent GNUNET_YES if the value is persistent, GNUNET_NO if not
1543 * @return GNUNET_OK to continue, GNUNET_SYSERR to abort iteration
1546 process_stat_in (void *cls,
1547 const char *subsystem,
1552 struct Plugin *plugin = cls;
1553 plugin->payload += value;
1555 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
1557 "Notification from statistics about existing payload (%llu), new payload is %llu\n",
1559 (unsigned long long) plugin->payload);
1566 * Entry point for the plugin.
1568 * @param cls the "struct GNUNET_DATASTORE_PluginEnvironment*"
1569 * @return NULL on error, othrewise the plugin context
1572 libgnunet_plugin_datastore_sqlite_init (void *cls)
1574 static struct Plugin plugin;
1575 struct GNUNET_DATASTORE_PluginEnvironment *env = cls;
1576 struct GNUNET_DATASTORE_PluginFunctions *api;
1578 if (plugin.env != NULL)
1579 return NULL; /* can only initialize once! */
1580 memset (&plugin, 0, sizeof(struct Plugin));
1582 plugin.statistics = GNUNET_STATISTICS_create (env->sched,
1585 GNUNET_STATISTICS_get (plugin.statistics,
1588 GNUNET_TIME_UNIT_MINUTES,
1593 database_setup (env->cfg, &plugin))
1595 database_shutdown (&plugin);
1598 api = GNUNET_malloc (sizeof (struct GNUNET_DATASTORE_PluginFunctions));
1600 api->get_size = &sqlite_plugin_get_size;
1601 api->put = &sqlite_plugin_put;
1602 api->next_request = &sqlite_next_request;
1603 api->get = &sqlite_plugin_get;
1604 api->update = &sqlite_plugin_update;
1605 api->iter_low_priority = &sqlite_plugin_iter_low_priority;
1606 api->iter_zero_anonymity = &sqlite_plugin_iter_zero_anonymity;
1607 api->iter_ascending_expiration = &sqlite_plugin_iter_ascending_expiration;
1608 api->iter_migration_order = &sqlite_plugin_iter_migration_order;
1609 api->iter_all_now = &sqlite_plugin_iter_all_now;
1610 api->drop = &sqlite_plugin_drop;
1611 GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
1612 "sqlite", _("Sqlite database running\n"));
1618 * Exit point from the plugin.
1620 * @param cls the plugin context (as returned by "init")
1621 * @return always NULL
1624 libgnunet_plugin_datastore_sqlite_done (void *cls)
1627 struct GNUNET_DATASTORE_PluginFunctions *api = cls;
1628 struct Plugin *plugin = api->cls;
1631 if (plugin->drop_on_shutdown)
1632 fn = GNUNET_strdup (plugin->fn);
1633 database_shutdown (plugin);
1634 GNUNET_STATISTICS_destroy (plugin->statistics,
1637 plugin->payload = 0;
1641 if (0 != UNLINK(fn))
1642 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
1650 /* end of plugin_datastore_sqlite.c */