2 * This file is part of GNUnet
3 * (C) 2009-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 namestore/plugin_namestore_sqlite.c
23 * @brief sqlite-based namestore backend
24 * @author Christian Grothoff
28 #include "gnunet_namestore_plugin.h"
29 #include "gnunet_namestore_service.h"
30 #include "namestore.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
47 * Log an error message at log-level 'level' that indicates
48 * a failure of the command 'cmd' on file 'filename'
49 * with the message given by strerror(errno).
51 #define LOG_SQLITE(db, level, cmd) do { GNUNET_log_from (level, "namestore-sqlite", _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db->dbh)); } while(0)
53 #define LOG(kind,...) GNUNET_log_from (kind, "namestore-sqlite", __VA_ARGS__)
57 * Context for all functions in this plugin.
62 const struct GNUNET_CONFIGURATION_Handle *cfg;
70 * Native SQLite database handle.
75 * Precompiled SQL for caching a block
77 sqlite3_stmt *cache_block;
80 * Precompiled SQL for looking up a block
82 sqlite3_stmt *lookup_block;
85 * Precompiled SQL for removing expired blocks
87 sqlite3_stmt *expire_blocks;
90 * Precompiled SQL to store records.
92 sqlite3_stmt *store_records;
95 * Precompiled SQL to deltete existing records.
97 sqlite3_stmt *delete_records;
100 * Precompiled SQL for iterate records within a zone.
102 sqlite3_stmt *iterate_zone;
105 * Precompiled SQL for iterate all records within all zones.
107 sqlite3_stmt *iterate_all_zones;
110 * Precompiled SQL to for reverse lookup based on PKEY.
112 sqlite3_stmt *zone_to_name;
118 * @brief Prepare a SQL statement
120 * @param dbh handle to the database
121 * @param zSql SQL statement, UTF-8 encoded
122 * @param ppStmt set to the prepared statement
123 * @return 0 on success
126 sq_prepare (sqlite3 * dbh, const char *zSql, sqlite3_stmt ** ppStmt)
132 sqlite3_prepare_v2 (dbh, zSql, strlen (zSql), ppStmt,
133 (const char **) &dummy);
134 LOG (GNUNET_ERROR_TYPE_DEBUG,
135 "Prepared `%s' / %p: %d\n", zSql, *ppStmt, result);
141 * Create our database indices.
143 * @param dbh handle to the database
146 create_indices (sqlite3 * dbh)
150 sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS ir_query_hash ON ns096blocks (query,expiration_time)",
151 NULL, NULL, NULL)) ||
153 sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS ir_block_expiration ON ns096blocks (expiration_time)",
154 NULL, NULL, NULL)) ||
156 sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS ir_pkey_reverse ON ns096records (zone_private_key,pkey_hash)",
157 NULL, NULL, NULL)) ||
159 sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS ir_pkey_iter ON ns096records (zone_private_key,rvalue)",
160 NULL, NULL, NULL)) ||
162 sqlite3_exec (dbh, "CREATE INDEX IF NOT EXISTS it_iter ON ns096records (rvalue)",
164 LOG (GNUNET_ERROR_TYPE_ERROR,
165 "Failed to create indices: %s\n", sqlite3_errmsg (dbh));
170 #define CHECK(a) GNUNET_break(a)
174 #define ENULL_DEFINED 1
175 #define CHECK(a) if (! a) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "%s\n", e); sqlite3_free(e); }
180 * Initialize the database connections and associated
181 * data structures (create tables and indices
182 * as needed as well).
184 * @param plugin the plugin context (state for this module)
185 * @return #GNUNET_OK on success
188 database_setup (struct Plugin *plugin)
197 GNUNET_CONFIGURATION_get_value_filename (plugin->cfg, "namestore-sqlite",
198 "FILENAME", &afsdir))
200 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
201 "namestore-sqlite", "FILENAME");
202 return GNUNET_SYSERR;
204 if (GNUNET_OK != GNUNET_DISK_file_test (afsdir))
206 if (GNUNET_OK != GNUNET_DISK_directory_create_for_file (afsdir))
209 GNUNET_free (afsdir);
210 return GNUNET_SYSERR;
213 /* afsdir should be UTF-8-encoded. If it isn't, it's a bug */
216 /* Open database and precompile statements */
217 if (sqlite3_open (plugin->fn, &plugin->dbh) != SQLITE_OK)
219 LOG (GNUNET_ERROR_TYPE_ERROR,
220 _("Unable to initialize SQLite: %s.\n"),
221 sqlite3_errmsg (plugin->dbh));
222 return GNUNET_SYSERR;
225 sqlite3_exec (plugin->dbh, "PRAGMA temp_store=MEMORY", NULL, NULL,
228 sqlite3_exec (plugin->dbh, "PRAGMA synchronous=NORMAL", NULL, NULL,
231 sqlite3_exec (plugin->dbh, "PRAGMA legacy_file_format=OFF", NULL, NULL,
234 sqlite3_exec (plugin->dbh, "PRAGMA auto_vacuum=INCREMENTAL", NULL,
237 sqlite3_exec (plugin->dbh, "PRAGMA encoding=\"UTF-8\"", NULL,
240 sqlite3_exec (plugin->dbh, "PRAGMA locking_mode=EXCLUSIVE", NULL, NULL,
243 sqlite3_exec (plugin->dbh, "PRAGMA count_changes=OFF", NULL, NULL,
246 sqlite3_exec (plugin->dbh, "PRAGMA page_size=4092", NULL, NULL,
249 CHECK (SQLITE_OK == sqlite3_busy_timeout (plugin->dbh, BUSY_TIMEOUT_MS));
254 sq_prepare (plugin->dbh,
255 "SELECT 1 FROM sqlite_master WHERE tbl_name = 'ns096blocks'",
257 if ((sqlite3_step (stmt) == SQLITE_DONE) &&
260 "CREATE TABLE ns096blocks ("
261 " query BLOB NOT NULL DEFAULT '',"
262 " block BLOB NOT NULL DEFAULT '',"
263 " expiration_time INT8 NOT NULL DEFAULT 0"
265 NULL, NULL, NULL) != SQLITE_OK))
267 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite3_exec");
268 sqlite3_finalize (stmt);
269 return GNUNET_SYSERR;
271 sqlite3_finalize (stmt);
274 sq_prepare (plugin->dbh,
275 "SELECT 1 FROM sqlite_master WHERE tbl_name = 'ns096records'",
277 if ((sqlite3_step (stmt) == SQLITE_DONE) &&
280 "CREATE TABLE ns096records ("
281 " zone_private_key BLOB NOT NULL DEFAULT '',"
283 " rvalue INT8 NOT NULL DEFAULT '',"
284 " record_count INT NOT NULL DEFAULT 0,"
285 " record_data BLOB NOT NULL DEFAULT '',"
286 " label TEXT NOT NULL DEFAULT ''"
288 NULL, NULL, NULL) != SQLITE_OK))
290 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite3_exec");
291 sqlite3_finalize (stmt);
292 return GNUNET_SYSERR;
294 sqlite3_finalize (stmt);
296 create_indices (plugin->dbh);
300 "INSERT INTO ns096blocks (query,block,expiration_time) VALUES (?, ?, ?)",
301 &plugin->cache_block) != SQLITE_OK) ||
304 "DELETE FROM ns096blocks WHERE expiration_time<?",
305 &plugin->expire_blocks) != SQLITE_OK) ||
308 "SELECT block FROM ns096blocks WHERE query=? ORDER BY expiration_time DESC LIMIT 1",
309 &plugin->lookup_block) != SQLITE_OK) ||
312 "INSERT INTO ns096records (zone_private_key, pkey_hash, rvalue, record_count, record_data, label)"
313 " VALUES (?, ?, ?, ?, ?, ?)",
314 &plugin->store_records) != SQLITE_OK) ||
317 "DELETE FROM ns096records WHERE zone_private_key=? AND label=?",
318 &plugin->delete_records) != SQLITE_OK) ||
321 "SELECT record_count,record_data,label"
322 " FROM ns096records WHERE zone_private_key=? AND pkey_hash=?",
323 &plugin->zone_to_name) != SQLITE_OK) ||
326 "SELECT record_count,record_data,label"
327 " FROM ns096records WHERE zone_private_key=? ORDER BY rvalue LIMIT 1 OFFSET ?",
328 &plugin->iterate_zone) != SQLITE_OK) ||
331 "SELECT record_count,record_data,label,zone_private_key"
332 " FROM ns096records ORDER BY rvalue LIMIT 1 OFFSET ?",
333 &plugin->iterate_all_zones) != SQLITE_OK)
336 LOG_SQLITE (plugin,GNUNET_ERROR_TYPE_ERROR, "precompiling");
337 return GNUNET_SYSERR;
344 * Shutdown database connection and associate data
346 * @param plugin the plugin context (state for this module)
349 database_shutdown (struct Plugin *plugin)
354 if (NULL != plugin->cache_block)
355 sqlite3_finalize (plugin->cache_block);
356 if (NULL != plugin->lookup_block)
357 sqlite3_finalize (plugin->lookup_block);
358 if (NULL != plugin->expire_blocks)
359 sqlite3_finalize (plugin->expire_blocks);
360 if (NULL != plugin->store_records)
361 sqlite3_finalize (plugin->store_records);
362 if (NULL != plugin->delete_records)
363 sqlite3_finalize (plugin->delete_records);
364 if (NULL != plugin->iterate_zone)
365 sqlite3_finalize (plugin->iterate_zone);
366 if (NULL != plugin->iterate_all_zones)
367 sqlite3_finalize (plugin->iterate_all_zones);
368 if (NULL != plugin->zone_to_name)
369 sqlite3_finalize (plugin->zone_to_name);
370 result = sqlite3_close (plugin->dbh);
371 if (result == SQLITE_BUSY)
373 LOG (GNUNET_ERROR_TYPE_WARNING,
374 _("Tried to close sqlite without finalizing all prepared statements.\n"));
375 stmt = sqlite3_next_stmt (plugin->dbh, NULL);
378 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite",
379 "Closing statement %p\n", stmt);
380 result = sqlite3_finalize (stmt);
381 if (result != SQLITE_OK)
382 GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING, "sqlite",
383 "Failed to close statement %p: %d\n", stmt, result);
384 stmt = sqlite3_next_stmt (plugin->dbh, NULL);
386 result = sqlite3_close (plugin->dbh);
388 if (SQLITE_OK != result)
389 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite3_close");
391 GNUNET_free_non_null (plugin->fn);
396 * Removes any expired block.
398 * @param plugin the plugin
401 namestore_sqlite_expire_blocks (struct Plugin *plugin)
403 struct GNUNET_TIME_Absolute now;
406 now = GNUNET_TIME_absolute_get ();
407 if (SQLITE_OK != sqlite3_bind_int64 (plugin->expire_blocks,
408 1, now.abs_value_us))
410 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
411 "sqlite3_bind_XXXX");
412 if (SQLITE_OK != sqlite3_reset (plugin->expire_blocks))
414 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
418 n = sqlite3_step (plugin->expire_blocks);
419 if (SQLITE_OK != sqlite3_reset (plugin->expire_blocks))
420 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
425 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite", "Records expired\n");
428 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
432 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
440 * Cache a block in the datastore.
442 * @param cls closure (internal context for the plugin)
443 * @param block block to cache
444 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
447 namestore_sqlite_cache_block (void *cls,
448 const struct GNUNET_NAMESTORE_Block *block)
450 struct Plugin *plugin = cls;
451 struct GNUNET_HashCode query;
452 struct GNUNET_TIME_Absolute expiration;
457 namestore_sqlite_expire_blocks (plugin);
458 GNUNET_CRYPTO_hash (&block->derived_key,
459 sizeof (struct GNUNET_CRYPTO_EccPublicSignKey),
461 expiration = GNUNET_TIME_absolute_ntoh (block->expiration_time);
462 dval = (int64_t) expiration.abs_value_us;
465 block_size = ntohl (block->purpose.size) +
466 sizeof (struct GNUNET_CRYPTO_EccPublicSignKey) +
467 sizeof (struct GNUNET_CRYPTO_EccSignature);
468 if (block_size > 64 * 65536)
471 return GNUNET_SYSERR;
474 sqlite3_bind_blob (plugin->cache_block, 1,
475 &query, sizeof (struct GNUNET_HashCode),
478 sqlite3_bind_blob (plugin->cache_block, 2,
482 sqlite3_bind_int64 (plugin->cache_block, 3,
486 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
487 "sqlite3_bind_XXXX");
488 if (SQLITE_OK != sqlite3_reset (plugin->cache_block))
490 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
492 return GNUNET_SYSERR;
495 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
496 "Caching block under derived key `%s'\n",
497 GNUNET_h2s_full (&query));
498 n = sqlite3_step (plugin->cache_block);
499 if (SQLITE_OK != sqlite3_reset (plugin->cache_block))
500 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
505 LOG (GNUNET_ERROR_TYPE_DEBUG,
509 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
513 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
515 return GNUNET_SYSERR;
521 * Get the block for a particular zone and label in the
522 * datastore. Will return at most one result to the iterator.
524 * @param cls closure (internal context for the plugin)
525 * @param query hash of public key derived from the zone and the label
526 * @param iter function to call with the result
527 * @param iter_cls closure for @a iter
528 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
531 namestore_sqlite_lookup_block (void *cls,
532 const struct GNUNET_HashCode *query,
533 GNUNET_NAMESTORE_BlockCallback iter, void *iter_cls)
535 struct Plugin *plugin = cls;
539 const struct GNUNET_NAMESTORE_Block *block;
541 if (SQLITE_OK != sqlite3_bind_blob (plugin->lookup_block, 1,
542 query, sizeof (struct GNUNET_HashCode),
545 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
546 "sqlite3_bind_XXXX");
547 if (SQLITE_OK != sqlite3_reset (plugin->lookup_block))
549 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
551 return GNUNET_SYSERR;
554 if (SQLITE_ROW == (sret = sqlite3_step (plugin->lookup_block)))
556 block = sqlite3_column_blob (plugin->lookup_block, 0);
557 block_size = sqlite3_column_bytes (plugin->lookup_block, 0);
558 if ( (block_size < sizeof (struct GNUNET_NAMESTORE_Block)) ||
559 (ntohl (block->purpose.size) +
560 sizeof (struct GNUNET_CRYPTO_EccPublicSignKey) +
561 sizeof (struct GNUNET_CRYPTO_EccSignature) != block_size) )
568 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
569 "Found block under derived key `%s'\n",
570 GNUNET_h2s_full (query));
571 iter (iter_cls, block);
577 if (SQLITE_DONE != sret)
579 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite_step");
584 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
585 "No block found under derived key `%s'\n",
586 GNUNET_h2s_full (query));
589 if (SQLITE_OK != sqlite3_reset (plugin->lookup_block))
591 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
598 * Store a record in the datastore. Removes any existing record in the
599 * same zone with the same name.
601 * @param cls closure (internal context for the plugin)
602 * @param zone_key private key of the zone
603 * @param label name that is being mapped (at most 255 characters long)
604 * @param rd_count number of entries in @a rd array
605 * @param rd array of records with data to store
606 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
609 namestore_sqlite_store_records (void *cls,
610 const struct GNUNET_CRYPTO_EccPrivateKey *zone_key,
612 unsigned int rd_count,
613 const struct GNUNET_NAMESTORE_RecordData *rd)
615 struct Plugin *plugin = cls;
617 struct GNUNET_HashCode pkey_hash;
622 memset (&pkey_hash, 0, sizeof (pkey_hash));
623 for (i=0;i<rd_count;i++)
624 if (GNUNET_NAMESTORE_TYPE_PKEY == rd[i].record_type)
626 GNUNET_break (sizeof (struct GNUNET_CRYPTO_EccPublicSignKey) == rd[i].data_size);
627 GNUNET_CRYPTO_hash (rd[i].data,
632 rvalue = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK, UINT64_MAX);
633 data_size = GNUNET_NAMESTORE_records_get_size (rd_count, rd);
634 if (data_size > 64 * 65536)
637 return GNUNET_SYSERR;
640 char data[data_size];
642 if (data_size != GNUNET_NAMESTORE_records_serialize (rd_count, rd,
646 return GNUNET_SYSERR;
649 /* First delete 'old' records */
650 if ((SQLITE_OK != sqlite3_bind_blob (plugin->delete_records, 1,
651 zone_key, sizeof (struct GNUNET_CRYPTO_EccPrivateKey), SQLITE_STATIC)) ||
652 (SQLITE_OK != sqlite3_bind_text (plugin->delete_records, 2, label, -1, SQLITE_STATIC)))
655 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
656 "sqlite3_bind_XXXX");
657 if (SQLITE_OK != sqlite3_reset (plugin->delete_records))
659 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
661 return GNUNET_SYSERR;
664 n = sqlite3_step (plugin->delete_records);
665 if (SQLITE_OK != sqlite3_reset (plugin->delete_records))
666 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
671 if ((SQLITE_OK != sqlite3_bind_blob (plugin->store_records, 1,
672 zone_key, sizeof (struct GNUNET_CRYPTO_EccPrivateKey), SQLITE_STATIC)) ||
673 (SQLITE_OK != sqlite3_bind_blob (plugin->store_records, 2,
674 &pkey_hash, sizeof (struct GNUNET_HashCode), SQLITE_STATIC)) ||
675 (SQLITE_OK != sqlite3_bind_int64 (plugin->store_records, 3, rvalue)) ||
676 (SQLITE_OK != sqlite3_bind_int (plugin->store_records, 4, rd_count)) ||
677 (SQLITE_OK != sqlite3_bind_blob (plugin->store_records, 5, data, data_size, SQLITE_STATIC)) ||
678 (SQLITE_OK != sqlite3_bind_text (plugin->store_records, 6, label, -1, SQLITE_STATIC)))
681 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
682 "sqlite3_bind_XXXX");
683 if (SQLITE_OK != sqlite3_reset (plugin->store_records))
685 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
687 return GNUNET_SYSERR;
689 n = sqlite3_step (plugin->store_records);
690 if (SQLITE_OK != sqlite3_reset (plugin->store_records))
691 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
698 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "sqlite", "Record stored\n");
701 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
705 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
707 return GNUNET_SYSERR;
713 * The given 'sqlite' statement has been prepared to be run.
714 * It will return a record which should be given to the iterator.
715 * Runs the statement and parses the returned record.
717 * @param plugin plugin context
718 * @param stmt to run (and then clean up)
719 * @param zone_key private key of the zone
720 * @param iter iterator to call with the result
721 * @param iter_cls closure for @a iter
722 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
725 get_record_and_call_iterator (struct Plugin *plugin,
727 const struct GNUNET_CRYPTO_EccPrivateKey *zone_key,
728 GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
730 unsigned int record_count;
738 if (SQLITE_ROW == (sret = sqlite3_step (stmt)))
740 record_count = sqlite3_column_int (stmt, 0);
741 data_size = sqlite3_column_bytes (stmt, 1);
742 data = sqlite3_column_blob (stmt, 1);
743 label = (const char*) sqlite3_column_text (stmt, 2);
744 if (NULL == zone_key)
746 /* must be "iterate_all_zones", got one extra return value */
747 if (sizeof (struct GNUNET_CRYPTO_EccPrivateKey) !=
748 sqlite3_column_bytes (stmt, 3))
755 zone_key = sqlite3_column_blob (stmt, 3);
758 if (record_count > 64 * 1024)
760 /* sanity check, don't stack allocate far too much just
761 because database might contain a large value here */
767 struct GNUNET_NAMESTORE_RecordData rd[record_count];
770 GNUNET_NAMESTORE_records_deserialize (data_size, data,
776 else if (NULL != zone_key)
779 iter (iter_cls, zone_key, label, record_count, rd);
786 if (SQLITE_DONE != sret)
787 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite_step");
789 if (SQLITE_OK != sqlite3_reset (stmt))
791 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
798 * Iterate over the results for a particular key and zone in the
799 * datastore. Will return at most one result to the iterator.
801 * @param cls closure (internal context for the plugin)
802 * @param zone hash of public key of the zone, NULL to iterate over all zones
803 * @param offset offset in the list of all matching records
804 * @param iter function to call with the result
805 * @param iter_cls closure for @a iter
806 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
809 namestore_sqlite_iterate_records (void *cls,
810 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
812 GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
814 struct Plugin *plugin = cls;
820 stmt = plugin->iterate_all_zones;
821 err = (SQLITE_OK != sqlite3_bind_int64 (stmt, 1,
826 stmt = plugin->iterate_zone;
827 err = ( (SQLITE_OK != sqlite3_bind_blob (stmt, 1,
828 zone, sizeof (struct GNUNET_CRYPTO_EccPrivateKey),
830 (SQLITE_OK != sqlite3_bind_int64 (stmt, 2,
835 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
836 "sqlite3_bind_XXXX");
837 if (SQLITE_OK != sqlite3_reset (stmt))
839 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
841 return GNUNET_SYSERR;
843 return get_record_and_call_iterator (plugin, stmt, zone, iter, iter_cls);
848 * Look for an existing PKEY delegation record for a given public key.
849 * Returns at most one result to the iterator.
851 * @param cls closure (internal context for the plugin)
852 * @param zone private key of the zone to look up in, never NULL
853 * @param value_zone public key of the target zone (value), never NULL
854 * @param iter function to call with the result
855 * @param iter_cls closure for @a iter
856 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
859 namestore_sqlite_zone_to_name (void *cls,
860 const struct GNUNET_CRYPTO_EccPrivateKey *zone,
861 const struct GNUNET_CRYPTO_EccPublicSignKey *value_zone,
862 GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
864 struct Plugin *plugin = cls;
867 stmt = plugin->zone_to_name;
868 if ( (SQLITE_OK != sqlite3_bind_blob (stmt, 1,
869 zone, sizeof (struct GNUNET_CRYPTO_EccPrivateKey),
871 (SQLITE_OK != sqlite3_bind_blob (stmt, 2,
872 value_zone, sizeof (struct GNUNET_CRYPTO_EccPublicSignKey),
875 LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
876 "sqlite3_bind_XXXX");
877 if (SQLITE_OK != sqlite3_reset (stmt))
879 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
881 return GNUNET_SYSERR;
883 return get_record_and_call_iterator (plugin, stmt, zone, iter, iter_cls);
888 * Entry point for the plugin.
890 * @param cls the "struct GNUNET_NAMESTORE_PluginEnvironment*"
891 * @return NULL on error, otherwise the plugin context
894 libgnunet_plugin_namestore_sqlite_init (void *cls)
896 static struct Plugin plugin;
897 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
898 struct GNUNET_NAMESTORE_PluginFunctions *api;
900 if (NULL != plugin.cfg)
901 return NULL; /* can only initialize once! */
902 memset (&plugin, 0, sizeof (struct Plugin));
904 if (GNUNET_OK != database_setup (&plugin))
906 database_shutdown (&plugin);
909 api = GNUNET_new (struct GNUNET_NAMESTORE_PluginFunctions);
911 api->cache_block = &namestore_sqlite_cache_block;
912 api->lookup_block = &namestore_sqlite_lookup_block;
913 api->store_records = &namestore_sqlite_store_records;
914 api->iterate_records = &namestore_sqlite_iterate_records;
915 api->zone_to_name = &namestore_sqlite_zone_to_name;
916 LOG (GNUNET_ERROR_TYPE_INFO,
917 _("Sqlite database running\n"));
923 * Exit point from the plugin.
925 * @param cls the plugin context (as returned by "init")
926 * @return always NULL
929 libgnunet_plugin_namestore_sqlite_done (void *cls)
931 struct GNUNET_NAMESTORE_PluginFunctions *api = cls;
932 struct Plugin *plugin = api->cls;
934 database_shutdown (plugin);
937 LOG (GNUNET_ERROR_TYPE_DEBUG,
938 "sqlite plugin is finished\n");
942 /* end of plugin_namestore_sqlite.c */