2 * This file is part of GNUnet
3 * (C) 2013 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 3, or (at your
8 * option) any later version.
10 * GNUnet is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with GNUnet; see the file COPYING. If not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * @file peerstore/plugin_peerstore_sqlite.c
23 * @brief sqlite-based peerstore backend
24 * @author Omar Tarabai
28 #include "gnunet_peerstore_plugin.h"
29 #include "gnunet_peerstore_service.h"
30 #include "peerstore.h"
34 * After how many ms "busy" should a DB operation fail for good? A
35 * low value makes sure that we are more responsive to requests
36 * (especially PUTs). A high value guarantees a higher success rate
37 * (SELECTs in iterate can take several seconds despite LIMIT=1).
39 * The default value of 1s should ensure that users do not experience
40 * huge latencies while at the same time allowing operations to
41 * succeed with reasonable probability.
43 #define BUSY_TIMEOUT_MS 1000
46 * Log an error message at log-level 'level' that indicates
47 * a failure of the command 'cmd' on file 'filename'
48 * with the message given by strerror(errno).
50 #define LOG_SQLITE(db, level, cmd) do { GNUNET_log_from (level, "peerstore-sqlite", _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db->dbh)); } while(0)
52 #define LOG(kind,...) GNUNET_log_from (kind, "peerstore-sqlite", __VA_ARGS__)
55 * Context for all functions in this plugin.
61 * Configuration handle
63 const struct GNUNET_CONFIGURATION_Handle *cfg;
71 * Native SQLite database handle.
76 * Precompiled SQL for inserting into peerstoredata
78 sqlite3_stmt *insert_peerstoredata;
81 * Precompiled SQL for selecting from peerstoredata
83 sqlite3_stmt *select_peerstoredata;
86 * Precompiled SQL for selecting from peerstoredata
88 sqlite3_stmt *select_peerstoredata_by_pid;
91 * Precompiled SQL for selecting from peerstoredata
93 sqlite3_stmt *select_peerstoredata_by_key;
96 * Precompiled SQL for selecting from peerstoredata
98 sqlite3_stmt *select_peerstoredata_by_all;
101 * Precompiled SQL for deleting expired
102 * records from peerstoredata
104 sqlite3_stmt *expire_peerstoredata;
107 * Precompiled SQL for deleting records
110 sqlite3_stmt *delete_peerstoredata;
115 * Delete records with the given key
117 * @param cls closure (internal context for the plugin)
118 * @param sub_system name of sub system
119 * @param peer Peer identity (can be NULL)
120 * @param key entry key string (can be NULL)
121 * @return number of deleted records
124 peerstore_sqlite_delete_records (void *cls, const char *sub_system,
125 const struct GNUNET_PeerIdentity *peer,
128 struct Plugin *plugin = cls;
129 sqlite3_stmt *stmt = plugin->delete_peerstoredata;
132 sqlite3_bind_text (stmt, 1, sub_system, strlen (sub_system) + 1,
135 sqlite3_bind_blob (stmt, 2, peer, sizeof (struct GNUNET_PeerIdentity),
138 sqlite3_bind_text (stmt, 3, key, strlen (key) + 1, SQLITE_STATIC)))
140 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
143 else if (SQLITE_DONE != sqlite3_step (stmt))
145 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
148 if (SQLITE_OK != sqlite3_reset (stmt))
150 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
154 return sqlite3_changes (plugin->dbh);
159 * Delete expired records (expiry < now)
161 * @param cls closure (internal context for the plugin)
162 * @param now time to use as reference
163 * @return number of records deleted
166 peerstore_sqlite_expire_records (void *cls, struct GNUNET_TIME_Absolute now)
168 struct Plugin *plugin = cls;
169 sqlite3_stmt *stmt = plugin->expire_peerstoredata;
172 sqlite3_bind_int64 (stmt, 1, (sqlite3_uint64) now.abs_value_us))
174 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
177 else if (SQLITE_DONE != sqlite3_step (stmt))
179 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
182 if (SQLITE_OK != sqlite3_reset (stmt))
184 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
188 return sqlite3_changes (plugin->dbh);
193 * Iterate over the records given an optional peer id
196 * @param cls closure (internal context for the plugin)
197 * @param sub_system name of sub system
198 * @param peer Peer identity (can be NULL)
199 * @param key entry key string (can be NULL)
200 * @param iter function to call with the result
201 * @param iter_cls closure for @a iter
202 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
205 peerstore_sqlite_iterate_records (void *cls, const char *sub_system,
206 const struct GNUNET_PeerIdentity *peer,
208 GNUNET_PEERSTORE_Processor iter,
211 struct Plugin *plugin = cls;
215 struct GNUNET_PEERSTORE_Record *ret;
217 LOG (GNUNET_ERROR_TYPE_DEBUG, "Executing iterate request on sqlite db.\n");
218 if (NULL == peer && NULL == key)
220 stmt = plugin->select_peerstoredata;
223 sqlite3_bind_text (stmt, 1, sub_system, strlen (sub_system) + 1,
226 else if (NULL == key)
228 stmt = plugin->select_peerstoredata_by_pid;
231 sqlite3_bind_text (stmt, 1, sub_system, strlen (sub_system) + 1,
234 sqlite3_bind_blob (stmt, 2, peer, sizeof (struct GNUNET_PeerIdentity),
237 else if (NULL == peer)
239 stmt = plugin->select_peerstoredata_by_key;
242 sqlite3_bind_text (stmt, 1, sub_system, strlen (sub_system) + 1,
245 sqlite3_bind_text (stmt, 2, key, strlen (key) + 1, SQLITE_STATIC));
249 stmt = plugin->select_peerstoredata_by_all;
252 sqlite3_bind_text (stmt, 1, sub_system, strlen (sub_system) + 1,
255 sqlite3_bind_blob (stmt, 2, peer, sizeof (struct GNUNET_PeerIdentity),
258 sqlite3_bind_text (stmt, 3, key, strlen (key) + 1, SQLITE_STATIC));
263 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
264 "sqlite3_bind_XXXX");
265 if (SQLITE_OK != sqlite3_reset (stmt))
266 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
268 return GNUNET_SYSERR;
270 while (SQLITE_ROW == (sret = sqlite3_step (stmt)))
272 LOG (GNUNET_ERROR_TYPE_DEBUG, "Returning a matched record.\n");
273 ret = GNUNET_new (struct GNUNET_PEERSTORE_Record);
275 ret->sub_system = (char *) sqlite3_column_text (stmt, 0);
276 ret->peer = (struct GNUNET_PeerIdentity *) sqlite3_column_blob (stmt, 1);
277 ret->key = (char *) sqlite3_column_text (stmt, 2);
278 ret->value = (void *) sqlite3_column_blob (stmt, 3);
279 ret->value_size = sqlite3_column_bytes (stmt, 3);
280 ret->expiry = GNUNET_new (struct GNUNET_TIME_Absolute);
282 ret->expiry->abs_value_us = (uint64_t) sqlite3_column_int64 (stmt, 4);
284 iter (iter_cls, ret, NULL);
285 GNUNET_free (ret->expiry);
288 if (SQLITE_DONE != sret)
290 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite_step");
293 if (SQLITE_OK != sqlite3_reset (stmt))
295 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
300 return GNUNET_SYSERR;
306 * Store a record in the peerstore.
307 * Key is the combination of sub system and peer identity.
308 * One key can store multiple values.
310 * @param cls closure (internal context for the plugin)
311 * @param sub_system name of the GNUnet sub system responsible
312 * @param peer peer identity
313 * @param key record key string
314 * @param value value to be stored
315 * @param size size of value to be stored
316 * @param expiry absolute time after which the record is (possibly) deleted
317 * @param options options related to the store operation
318 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
321 peerstore_sqlite_store_record (void *cls, const char *sub_system,
322 const struct GNUNET_PeerIdentity *peer,
323 const char *key, const void *value, size_t size,
324 struct GNUNET_TIME_Absolute expiry,
325 enum GNUNET_PEERSTORE_StoreOption options)
327 struct Plugin *plugin = cls;
328 sqlite3_stmt *stmt = plugin->insert_peerstoredata;
330 if (GNUNET_PEERSTORE_STOREOPTION_REPLACE == options)
332 peerstore_sqlite_delete_records (cls, sub_system, peer, key);
335 sqlite3_bind_text (stmt, 1, sub_system, strlen (sub_system) + 1,
337 SQLITE_OK != sqlite3_bind_blob (stmt, 2, peer,
338 sizeof (struct GNUNET_PeerIdentity),
340 SQLITE_OK != sqlite3_bind_text (stmt, 3, key, strlen (key) + 1,
342 SQLITE_OK != sqlite3_bind_blob (stmt, 4, value, size, SQLITE_STATIC) ||
343 SQLITE_OK != sqlite3_bind_int64 (stmt, 5,
344 (sqlite3_uint64) expiry.abs_value_us))
345 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
347 else if (SQLITE_DONE != sqlite3_step (stmt))
349 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
352 if (SQLITE_OK != sqlite3_reset (stmt))
354 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
356 return GNUNET_SYSERR;
363 * @brief Prepare a SQL statement
365 * @param dbh handle to the database
366 * @param sql SQL statement, UTF-8 encoded
367 * @return 0 on success
370 sql_exec (sqlite3 * dbh, const char *sql)
374 result = sqlite3_exec (dbh, sql, NULL, NULL, NULL);
375 LOG (GNUNET_ERROR_TYPE_DEBUG, "Executed `%s' / %d\n", sql, result);
376 if (result != SQLITE_OK)
377 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error executing SQL query: %s\n %s\n"),
378 sqlite3_errmsg (dbh), sql);
384 * @brief Prepare a SQL statement
386 * @param dbh handle to the database
387 * @param sql SQL statement, UTF-8 encoded
388 * @param stmt set to the prepared statement
389 * @return 0 on success
392 sql_prepare (sqlite3 * dbh, const char *sql, sqlite3_stmt ** stmt)
398 sqlite3_prepare_v2 (dbh, sql, strlen (sql), stmt, (const char **) &tail);
399 LOG (GNUNET_ERROR_TYPE_DEBUG, "Prepared `%s' / %p: %d\n", sql, *stmt, result);
400 if (result != SQLITE_OK)
401 LOG (GNUNET_ERROR_TYPE_ERROR, _("Error preparing SQL query: %s\n %s\n"),
402 sqlite3_errmsg (dbh), sql);
408 * sqlite3 custom function for comparison of uint64_t values
409 * since it is not supported by default
412 sqlite3_lessthan (sqlite3_context * ctx, int dummy, sqlite3_value ** values)
417 v1 = (uint64_t) sqlite3_value_int64 (values[0]);
418 v2 = (uint64_t) sqlite3_value_int64 (values[1]);
419 sqlite3_result_int (ctx, v1 < v2);
424 * Initialize the database connections and associated
425 * data structures (create tables and indices
426 * as needed as well).
428 * @param plugin the plugin context (state for this module)
429 * @return GNUNET_OK on success
432 database_setup (struct Plugin *plugin)
437 GNUNET_CONFIGURATION_get_value_filename (plugin->cfg, "peerstore-sqlite",
438 "FILENAME", &filename))
440 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR, "peerstore-sqlite",
442 return GNUNET_SYSERR;
444 if (GNUNET_OK != GNUNET_DISK_file_test (filename))
446 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (filename))
449 GNUNET_free (filename);
450 return GNUNET_SYSERR;
453 /* filename should be UTF-8-encoded. If it isn't, it's a bug */
454 plugin->fn = filename;
455 /* Open database and precompile statements */
456 if (SQLITE_OK != sqlite3_open (plugin->fn, &plugin->dbh))
458 LOG (GNUNET_ERROR_TYPE_ERROR, _("Unable to initialize SQLite: %s.\n"),
459 sqlite3_errmsg (plugin->dbh));
460 return GNUNET_SYSERR;
462 sql_exec (plugin->dbh, "PRAGMA temp_store=MEMORY");
463 sql_exec (plugin->dbh, "PRAGMA synchronous=OFF");
464 sql_exec (plugin->dbh, "PRAGMA legacy_file_format=OFF");
465 sql_exec (plugin->dbh, "PRAGMA auto_vacuum=INCREMENTAL");
466 sql_exec (plugin->dbh, "PRAGMA encoding=\"UTF-8\"");
467 sql_exec (plugin->dbh, "PRAGMA page_size=4096");
468 sqlite3_busy_timeout (plugin->dbh, BUSY_TIMEOUT_MS);
470 sql_exec (plugin->dbh,
471 "CREATE TABLE IF NOT EXISTS peerstoredata (\n"
472 " sub_system TEXT NOT NULL,\n" " peer_id BLOB NOT NULL,\n"
473 " key TEXT NOT NULL,\n" " value BLOB NULL,\n"
474 " expiry sqlite3_uint64 NOT NULL" ");");
475 sqlite3_create_function (plugin->dbh, "UINT64_LT", 2, SQLITE_UTF8, NULL,
476 &sqlite3_lessthan, NULL, NULL);
479 sqlite3_exec (plugin->dbh,
480 "CREATE INDEX IF NOT EXISTS peerstoredata_key_index ON peerstoredata (sub_system, peer_id, key)",
483 LOG (GNUNET_ERROR_TYPE_ERROR, _("Unable to create indices: %s.\n"),
484 sqlite3_errmsg (plugin->dbh));
485 return GNUNET_SYSERR;
487 /* Prepare statements */
489 sql_prepare (plugin->dbh,
490 "INSERT INTO peerstoredata (sub_system, peer_id, key, value, expiry) VALUES (?,?,?,?,?);",
491 &plugin->insert_peerstoredata);
492 sql_prepare (plugin->dbh,
493 "SELECT * FROM peerstoredata" " WHERE sub_system = ?",
494 &plugin->select_peerstoredata);
495 sql_prepare (plugin->dbh,
496 "SELECT * FROM peerstoredata" " WHERE sub_system = ?"
497 " AND peer_id = ?", &plugin->select_peerstoredata_by_pid);
498 sql_prepare (plugin->dbh,
499 "SELECT * FROM peerstoredata" " WHERE sub_system = ?"
500 " AND key = ?", &plugin->select_peerstoredata_by_key);
501 sql_prepare (plugin->dbh,
502 "SELECT * FROM peerstoredata" " WHERE sub_system = ?"
503 " AND peer_id = ?" " AND key = ?",
504 &plugin->select_peerstoredata_by_all);
505 sql_prepare (plugin->dbh,
506 "DELETE FROM peerstoredata" " WHERE UINT64_LT(expiry, ?)",
507 &plugin->expire_peerstoredata);
508 sql_prepare (plugin->dbh,
509 "DELETE FROM peerstoredata" " WHERE sub_system = ?"
510 " AND peer_id = ?" " AND key = ?",
511 &plugin->delete_peerstoredata);
517 * Shutdown database connection and associate data
519 * @param plugin the plugin context (state for this module)
522 database_shutdown (struct Plugin *plugin)
527 while (NULL != (stmt = sqlite3_next_stmt (plugin->dbh, NULL)))
529 result = sqlite3_finalize (stmt);
530 if (SQLITE_OK != result)
531 LOG (GNUNET_ERROR_TYPE_WARNING, "Failed to close statement %p: %d\n",
534 if (SQLITE_OK != sqlite3_close (plugin->dbh))
535 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite3_close");
536 GNUNET_free_non_null (plugin->fn);
541 * Entry point for the plugin.
543 * @param cls The struct GNUNET_CONFIGURATION_Handle.
544 * @return NULL on error, otherwise the plugin context
547 libgnunet_plugin_peerstore_sqlite_init (void *cls)
549 static struct Plugin plugin;
550 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
551 struct GNUNET_PEERSTORE_PluginFunctions *api;
553 if (NULL != plugin.cfg)
554 return NULL; /* can only initialize once! */
555 memset (&plugin, 0, sizeof (struct Plugin));
557 if (GNUNET_OK != database_setup (&plugin))
559 database_shutdown (&plugin);
562 api = GNUNET_new (struct GNUNET_PEERSTORE_PluginFunctions);
564 api->store_record = &peerstore_sqlite_store_record;
565 api->iterate_records = &peerstore_sqlite_iterate_records;
566 api->expire_records = &peerstore_sqlite_expire_records;
567 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sqlite plugin is running\n");
573 * Exit point from the plugin.
575 * @param cls The plugin context (as returned by "init")
576 * @return Always NULL
579 libgnunet_plugin_peerstore_sqlite_done (void *cls)
581 struct GNUNET_PEERSTORE_PluginFunctions *api = cls;
582 struct Plugin *plugin = api->cls;
584 database_shutdown (plugin);
587 LOG (GNUNET_ERROR_TYPE_DEBUG, "Sqlite plugin is finished\n");
591 /* end of plugin_peerstore_sqlite.c */