rename GNUNET_PQ_QueryStatus to GNUNET_DB_QueryStatus
[oweals/gnunet.git] / src / namestore / plugin_namestore_sqlite.c
1  /*
2   * This file is part of GNUnet
3   * Copyright (C) 2009-2017 GNUnet e.V.
4   *
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.
9   *
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.
14   *
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., 51 Franklin Street, Fifth Floor,
18   * Boston, MA 02110-1301, USA.
19   */
20
21 /**
22  * @file namestore/plugin_namestore_sqlite.c
23  * @brief sqlite-based namestore backend
24  * @author Christian Grothoff
25  */
26
27 #include "platform.h"
28 #include "gnunet_namestore_plugin.h"
29 #include "gnunet_namestore_service.h"
30 #include "gnunet_gnsrecord_lib.h"
31 #include "gnunet_sq_lib.h"
32 #include "namestore.h"
33 #include <sqlite3.h>
34
35 /**
36  * After how many ms "busy" should a DB operation fail for good?  A
37  * low value makes sure that we are more responsive to requests
38  * (especially PUTs).  A high value guarantees a higher success rate
39  * (SELECTs in iterate can take several seconds despite LIMIT=1).
40  *
41  * The default value of 1s should ensure that users do not experience
42  * huge latencies while at the same time allowing operations to
43  * succeed with reasonable probability.
44  */
45 #define BUSY_TIMEOUT_MS 1000
46
47
48 /**
49  * Log an error message at log-level 'level' that indicates
50  * a failure of the command 'cmd' on file 'filename'
51  * with the message given by strerror(errno).
52  */
53 #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)
54
55 #define LOG(kind,...) GNUNET_log_from (kind, "namestore-sqlite", __VA_ARGS__)
56
57
58 /**
59  * Context for all functions in this plugin.
60  */
61 struct Plugin
62 {
63
64   const struct GNUNET_CONFIGURATION_Handle *cfg;
65
66   /**
67    * Database filename.
68    */
69   char *fn;
70
71   /**
72    * Native SQLite database handle.
73    */
74   sqlite3 *dbh;
75
76   /**
77    * Precompiled SQL to store records.
78    */
79   sqlite3_stmt *store_records;
80
81   /**
82    * Precompiled SQL to deltete existing records.
83    */
84   sqlite3_stmt *delete_records;
85
86   /**
87    * Precompiled SQL for iterate records within a zone.
88    */
89   sqlite3_stmt *iterate_zone;
90
91   /**
92    * Precompiled SQL for iterate all records within all zones.
93    */
94   sqlite3_stmt *iterate_all_zones;
95
96   /**
97    * Precompiled SQL to for reverse lookup based on PKEY.
98    */
99   sqlite3_stmt *zone_to_name;
100
101   /**
102    * Precompiled SQL to lookup records based on label.
103    */
104   sqlite3_stmt *lookup_label;
105 };
106
107
108 /**
109  * @brief Prepare a SQL statement
110  *
111  * @param dbh handle to the database
112  * @param zSql SQL statement, UTF-8 encoded
113  * @param ppStmt set to the prepared statement
114  * @return 0 on success
115  */
116 static int
117 sq_prepare (sqlite3 *dbh,
118             const char *zSql,
119             sqlite3_stmt **ppStmt)
120 {
121   char *dummy;
122   int result;
123
124   result =
125       sqlite3_prepare_v2 (dbh,
126                           zSql,
127                           strlen (zSql),
128                           ppStmt,
129                           (const char **) &dummy);
130   LOG (GNUNET_ERROR_TYPE_DEBUG,
131        "Prepared `%s' / %p: %d\n",
132        zSql,
133        *ppStmt,
134        result);
135   return result;
136 }
137
138
139 /**
140  * Create our database indices.
141  *
142  * @param dbh handle to the database
143  */
144 static void
145 create_indices (sqlite3 * dbh)
146 {
147   /* create indices */
148   if ( (SQLITE_OK !=
149         sqlite3_exec (dbh,
150                       "CREATE INDEX IF NOT EXISTS ir_pkey_reverse ON ns097records (zone_private_key,pkey)",
151                       NULL, NULL, NULL)) ||
152        (SQLITE_OK !=
153         sqlite3_exec (dbh,
154                       "CREATE INDEX IF NOT EXISTS ir_pkey_iter ON ns097records (zone_private_key,rvalue)",
155                       NULL, NULL, NULL)) ||
156        (SQLITE_OK !=
157         sqlite3_exec (dbh,
158                       "CREATE INDEX IF NOT EXISTS it_iter ON ns097records (rvalue)",
159                       NULL, NULL, NULL)) )
160     LOG (GNUNET_ERROR_TYPE_ERROR,
161          "Failed to create indices: %s\n",
162          sqlite3_errmsg (dbh));
163 }
164
165
166 #if 0
167 #define CHECK(a) GNUNET_break(a)
168 #define ENULL NULL
169 #else
170 #define ENULL &e
171 #define ENULL_DEFINED 1
172 #define CHECK(a) if (! (a)) { GNUNET_log(GNUNET_ERROR_TYPE_ERROR, "%s\n", e); sqlite3_free(e); }
173 #endif
174
175
176 /**
177  * Initialize the database connections and associated
178  * data structures (create tables and indices
179  * as needed as well).
180  *
181  * @param plugin the plugin context (state for this module)
182  * @return #GNUNET_OK on success
183  */
184 static int
185 database_setup (struct Plugin *plugin)
186 {
187   sqlite3_stmt *stmt;
188   char *afsdir;
189 #if ENULL_DEFINED
190   char *e;
191 #endif
192
193   if (GNUNET_OK !=
194       GNUNET_CONFIGURATION_get_value_filename (plugin->cfg,
195                                                "namestore-sqlite",
196                                                "FILENAME",
197                                                &afsdir))
198   {
199     GNUNET_log_config_missing (GNUNET_ERROR_TYPE_ERROR,
200                                "namestore-sqlite",
201                                "FILENAME");
202     return GNUNET_SYSERR;
203   }
204   if (GNUNET_OK !=
205       GNUNET_DISK_file_test (afsdir))
206   {
207     if (GNUNET_OK !=
208         GNUNET_DISK_directory_create_for_file (afsdir))
209     {
210       GNUNET_break (0);
211       GNUNET_free (afsdir);
212       return GNUNET_SYSERR;
213     }
214   }
215   /* afsdir should be UTF-8-encoded. If it isn't, it's a bug */
216   plugin->fn = afsdir;
217
218   /* Open database and precompile statements */
219   if (sqlite3_open (plugin->fn, &plugin->dbh) != SQLITE_OK)
220   {
221     LOG (GNUNET_ERROR_TYPE_ERROR,
222          _("Unable to initialize SQLite: %s.\n"),
223          sqlite3_errmsg (plugin->dbh));
224     return GNUNET_SYSERR;
225   }
226   CHECK (SQLITE_OK ==
227          sqlite3_exec (plugin->dbh,
228                        "PRAGMA temp_store=MEMORY", NULL, NULL,
229                        ENULL));
230   CHECK (SQLITE_OK ==
231          sqlite3_exec (plugin->dbh,
232                        "PRAGMA synchronous=NORMAL", NULL, NULL,
233                        ENULL));
234   CHECK (SQLITE_OK ==
235          sqlite3_exec (plugin->dbh,
236                        "PRAGMA legacy_file_format=OFF", NULL, NULL,
237                        ENULL));
238   CHECK (SQLITE_OK ==
239          sqlite3_exec (plugin->dbh,
240                        "PRAGMA auto_vacuum=INCREMENTAL", NULL,
241                        NULL, ENULL));
242   CHECK (SQLITE_OK ==
243          sqlite3_exec (plugin->dbh,
244                        "PRAGMA encoding=\"UTF-8\"", NULL,
245                        NULL, ENULL));
246   CHECK (SQLITE_OK ==
247          sqlite3_exec (plugin->dbh,
248                        "PRAGMA locking_mode=EXCLUSIVE", NULL, NULL,
249                        ENULL));
250   CHECK (SQLITE_OK ==
251          sqlite3_exec (plugin->dbh,
252                        "PRAGMA page_size=4092", NULL, NULL,
253                        ENULL));
254
255   CHECK (SQLITE_OK ==
256          sqlite3_busy_timeout (plugin->dbh,
257                                BUSY_TIMEOUT_MS));
258
259
260   /* Create table */
261   CHECK (SQLITE_OK ==
262          sq_prepare (plugin->dbh,
263                      "SELECT 1 FROM sqlite_master WHERE tbl_name = 'ns097records'",
264                      &stmt));
265   if ((sqlite3_step (stmt) == SQLITE_DONE) &&
266       (sqlite3_exec
267        (plugin->dbh,
268         "CREATE TABLE ns097records ("
269         " zone_private_key BLOB NOT NULL DEFAULT '',"
270         " pkey BLOB,"
271         " rvalue INT8 NOT NULL DEFAULT '',"
272         " record_count INT NOT NULL DEFAULT 0,"
273         " record_data BLOB NOT NULL DEFAULT '',"
274         " label TEXT NOT NULL DEFAULT ''"
275         ")",
276         NULL, NULL, NULL) != SQLITE_OK))
277   {
278     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR,
279                 "sqlite3_exec");
280     sqlite3_finalize (stmt);
281     return GNUNET_SYSERR;
282   }
283   sqlite3_finalize (stmt);
284
285   create_indices (plugin->dbh);
286
287   if ( (SQLITE_OK !=
288         sq_prepare (plugin->dbh,
289                     "INSERT INTO ns097records (zone_private_key, pkey, rvalue, record_count, record_data, label)"
290                     " VALUES (?, ?, ?, ?, ?, ?)",
291                     &plugin->store_records)) ||
292        (SQLITE_OK !=
293         sq_prepare (plugin->dbh,
294                     "DELETE FROM ns097records WHERE zone_private_key=? AND label=?",
295                     &plugin->delete_records)) ||
296        (SQLITE_OK !=
297         sq_prepare (plugin->dbh,
298                     "SELECT record_count,record_data,label"
299                     " FROM ns097records WHERE zone_private_key=? AND pkey=?",
300                     &plugin->zone_to_name)) ||
301        (SQLITE_OK !=
302         sq_prepare (plugin->dbh,
303                     "SELECT record_count,record_data,label"
304                     " FROM ns097records WHERE zone_private_key=?"
305                     " ORDER BY rvalue LIMIT 1 OFFSET ?",
306                     &plugin->iterate_zone)) ||
307        (SQLITE_OK !=
308         sq_prepare (plugin->dbh,
309                     "SELECT record_count,record_data,label,zone_private_key"
310                     " FROM ns097records ORDER BY rvalue LIMIT 1 OFFSET ?",
311                     &plugin->iterate_all_zones))  ||
312        (SQLITE_OK !=
313         sq_prepare (plugin->dbh,
314                     "SELECT record_count,record_data,label,zone_private_key"
315                     " FROM ns097records WHERE zone_private_key=? AND label=?",
316                     &plugin->lookup_label))
317        )
318   {
319     LOG_SQLITE (plugin,
320                 GNUNET_ERROR_TYPE_ERROR,
321                 "precompiling");
322     return GNUNET_SYSERR;
323   }
324   return GNUNET_OK;
325 }
326
327
328 /**
329  * Shutdown database connection and associate data
330  * structures.
331  * @param plugin the plugin context (state for this module)
332  */
333 static void
334 database_shutdown (struct Plugin *plugin)
335 {
336   int result;
337   sqlite3_stmt *stmt;
338
339   if (NULL != plugin->store_records)
340     sqlite3_finalize (plugin->store_records);
341   if (NULL != plugin->delete_records)
342     sqlite3_finalize (plugin->delete_records);
343   if (NULL != plugin->iterate_zone)
344     sqlite3_finalize (plugin->iterate_zone);
345   if (NULL != plugin->iterate_all_zones)
346     sqlite3_finalize (plugin->iterate_all_zones);
347   if (NULL != plugin->zone_to_name)
348     sqlite3_finalize (plugin->zone_to_name);
349   if (NULL != plugin->lookup_label)
350     sqlite3_finalize (plugin->lookup_label);
351   result = sqlite3_close (plugin->dbh);
352   if (result == SQLITE_BUSY)
353   {
354     LOG (GNUNET_ERROR_TYPE_WARNING,
355          _("Tried to close sqlite without finalizing all prepared statements.\n"));
356     stmt = sqlite3_next_stmt (plugin->dbh,
357                               NULL);
358     while (NULL != stmt)
359     {
360       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
361                        "sqlite",
362                        "Closing statement %p\n",
363                        stmt);
364       result = sqlite3_finalize (stmt);
365       if (result != SQLITE_OK)
366         GNUNET_log_from (GNUNET_ERROR_TYPE_WARNING,
367                          "sqlite",
368                          "Failed to close statement %p: %d\n",
369                          stmt,
370                          result);
371       stmt = sqlite3_next_stmt (plugin->dbh,
372                                 NULL);
373     }
374     result = sqlite3_close (plugin->dbh);
375   }
376   if (SQLITE_OK != result)
377     LOG_SQLITE (plugin,
378                 GNUNET_ERROR_TYPE_ERROR,
379                 "sqlite3_close");
380
381   GNUNET_free_non_null (plugin->fn);
382 }
383
384
385 /**
386  * Store a record in the datastore.  Removes any existing record in the
387  * same zone with the same name.
388  *
389  * @param cls closure (internal context for the plugin)
390  * @param zone_key private key of the zone
391  * @param label name that is being mapped (at most 255 characters long)
392  * @param rd_count number of entries in @a rd array
393  * @param rd array of records with data to store
394  * @return #GNUNET_OK on success, else #GNUNET_SYSERR
395  */
396 static int
397 namestore_sqlite_store_records (void *cls,
398                                 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
399                                 const char *label,
400                                 unsigned int rd_count,
401                                 const struct GNUNET_GNSRECORD_Data *rd)
402 {
403   struct Plugin *plugin = cls;
404   int n;
405   struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
406   uint64_t rvalue;
407   size_t data_size;
408   unsigned int i;
409
410   memset (&pkey, 0, sizeof (pkey));
411   for (i=0;i<rd_count;i++)
412     if (GNUNET_GNSRECORD_TYPE_PKEY == rd[i].record_type)
413     {
414       GNUNET_break (sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) ==
415                     rd[i].data_size);
416       GNUNET_memcpy (&pkey,
417                      rd[i].data,
418                      rd[i].data_size);
419       break;
420     }
421   rvalue = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK,
422                                      UINT64_MAX);
423   data_size = GNUNET_GNSRECORD_records_get_size (rd_count,
424                                                  rd);
425   if (data_size > 64 * 65536)
426   {
427     GNUNET_break (0);
428     return GNUNET_SYSERR;
429   }
430   {
431     /* First delete 'old' records */
432     char data[data_size];
433     struct GNUNET_SQ_QueryParam dparams[] = {
434       GNUNET_SQ_query_param_auto_from_type (zone_key),
435       GNUNET_SQ_query_param_string (label),
436       GNUNET_SQ_query_param_end
437     };
438
439     if (data_size !=
440         GNUNET_GNSRECORD_records_serialize (rd_count,
441                                             rd,
442                                             data_size,
443                                             data))
444     {
445       GNUNET_break (0);
446       return GNUNET_SYSERR;
447     }
448     if (GNUNET_OK !=
449         GNUNET_SQ_bind (plugin->delete_records,
450                         dparams))
451     {
452       LOG_SQLITE (plugin,
453                   GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
454                   "sqlite3_bind_XXXX");
455       GNUNET_SQ_reset (plugin->dbh,
456                        plugin->delete_records);
457       return GNUNET_SYSERR;
458
459     }
460     n = sqlite3_step (plugin->delete_records);
461     GNUNET_SQ_reset (plugin->dbh,
462                      plugin->delete_records);
463
464     if (0 != rd_count)
465     {
466       uint32_t rd_count32 = (uint32_t) rd_count;
467       struct GNUNET_SQ_QueryParam sparams[] = {
468         GNUNET_SQ_query_param_auto_from_type (zone_key),
469         GNUNET_SQ_query_param_auto_from_type (&rvalue),
470         GNUNET_SQ_query_param_uint64 (&rvalue),
471         GNUNET_SQ_query_param_uint32 (&rd_count32),
472         GNUNET_SQ_query_param_fixed_size (data, data_size),
473         GNUNET_SQ_query_param_string (label),
474         GNUNET_SQ_query_param_end
475       };
476
477       if (GNUNET_OK !=
478           GNUNET_SQ_bind (plugin->store_records,
479                           sparams))
480       {
481         LOG_SQLITE (plugin,
482                     GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
483                     "sqlite3_bind_XXXX");
484         GNUNET_SQ_reset (plugin->dbh,
485                          plugin->store_records);
486         return GNUNET_SYSERR;
487       }
488       n = sqlite3_step (plugin->store_records);
489       GNUNET_SQ_reset (plugin->dbh,
490                        plugin->store_records);
491     }
492   }
493   switch (n)
494   {
495   case SQLITE_DONE:
496     if (0 != rd_count)
497       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
498                        "sqlite",
499                        "Record stored\n");
500     else
501       GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG,
502                        "sqlite",
503                        "Record deleted\n");
504     return GNUNET_OK;
505   case SQLITE_BUSY:
506     LOG_SQLITE (plugin,
507                 GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
508                 "sqlite3_step");
509     return GNUNET_NO;
510   default:
511     LOG_SQLITE (plugin,
512                 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
513                 "sqlite3_step");
514     return GNUNET_SYSERR;
515   }
516 }
517
518
519 /**
520  * The given 'sqlite' statement has been prepared to be run.
521  * It will return a record which should be given to the iterator.
522  * Runs the statement and parses the returned record.
523  *
524  * @param plugin plugin context
525  * @param stmt to run (and then clean up)
526  * @param zone_key private key of the zone
527  * @param iter iterator to call with the result
528  * @param iter_cls closure for @a iter
529  * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
530  */
531 static int
532 get_record_and_call_iterator (struct Plugin *plugin,
533                               sqlite3_stmt *stmt,
534                               const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
535                               GNUNET_NAMESTORE_RecordIterator iter,
536                               void *iter_cls)
537 {
538   uint32_t record_count;
539   size_t data_size;
540   void *data;
541   char *label;
542   struct GNUNET_CRYPTO_EcdsaPrivateKey zk;
543   int ret;
544   int sret;
545
546   ret = GNUNET_NO;
547   if (SQLITE_ROW == (sret = sqlite3_step (stmt)))
548   {
549     struct GNUNET_SQ_ResultSpec rs[] = {
550       GNUNET_SQ_result_spec_uint32 (&record_count),
551       GNUNET_SQ_result_spec_variable_size (&data, &data_size),
552       GNUNET_SQ_result_spec_string (&label),
553       GNUNET_SQ_result_spec_end
554     };
555     struct GNUNET_SQ_ResultSpec rsx[] = {
556       GNUNET_SQ_result_spec_uint32 (&record_count),
557       GNUNET_SQ_result_spec_variable_size (&data, &data_size),
558       GNUNET_SQ_result_spec_string (&label),
559       GNUNET_SQ_result_spec_auto_from_type (&zk),
560       GNUNET_SQ_result_spec_end
561     };
562
563     if (NULL == zone_key)
564     {
565       zone_key = &zk;
566       ret = GNUNET_SQ_extract_result (stmt,
567                                       rsx);
568     }
569     else
570     {
571       ret = GNUNET_SQ_extract_result (stmt,
572                                       rs);
573     }
574     if ( (GNUNET_OK != ret) ||
575          (record_count > 64 * 1024) )
576     {
577       /* sanity check, don't stack allocate far too much just
578          because database might contain a large value here */
579       GNUNET_break (0);
580       ret = GNUNET_SYSERR;
581     }
582     else
583     {
584       struct GNUNET_GNSRECORD_Data rd[record_count];
585
586       if (GNUNET_OK !=
587           GNUNET_GNSRECORD_records_deserialize (data_size,
588                                                 data,
589                                                 record_count,
590                                                 rd))
591       {
592         GNUNET_break (0);
593         ret = GNUNET_SYSERR;
594       }
595       else
596       {
597         if (NULL != iter)
598           iter (iter_cls,
599                 zone_key,
600                 label,
601                 record_count,
602                 rd);
603         ret = GNUNET_YES;
604       }
605     }
606     GNUNET_SQ_cleanup_result (rs);
607   }
608   else
609   {
610     if (SQLITE_DONE != sret)
611       LOG_SQLITE (plugin,
612                   GNUNET_ERROR_TYPE_ERROR,
613                   "sqlite_step");
614   }
615   GNUNET_SQ_reset (plugin->dbh,
616                    stmt);
617   return ret;
618 }
619
620
621 /**
622  * Lookup records in the datastore for which we are the authority.
623  *
624  * @param cls closure (internal context for the plugin)
625  * @param zone private key of the zone
626  * @param label name of the record in the zone
627  * @param iter function to call with the result
628  * @param iter_cls closure for @a iter
629  * @return #GNUNET_OK on success, else #GNUNET_SYSERR
630  */
631 static int
632 namestore_sqlite_lookup_records (void *cls,
633                                  const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
634                                  const char *label,
635                                  GNUNET_NAMESTORE_RecordIterator iter,
636                                  void *iter_cls)
637 {
638   struct Plugin *plugin = cls;
639   struct GNUNET_SQ_QueryParam params[] = {
640     GNUNET_SQ_query_param_auto_from_type (zone),
641     GNUNET_SQ_query_param_string (label),
642     GNUNET_SQ_query_param_end
643   };
644
645   if (NULL == zone)
646     return GNUNET_SYSERR;
647   if (GNUNET_OK !=
648       GNUNET_SQ_bind (plugin->lookup_label,
649                       params))
650   {
651     LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
652                 "sqlite3_bind_XXXX");
653     GNUNET_SQ_reset (plugin->dbh,
654                      plugin->lookup_label);
655     return GNUNET_SYSERR;
656   }
657   return get_record_and_call_iterator (plugin,
658                                        plugin->lookup_label,
659                                        zone,
660                                        iter,
661                                        iter_cls);
662 }
663
664
665 /**
666  * Iterate over the results for a particular key and zone in the
667  * datastore.  Will return at most one result to the iterator.
668  *
669  * @param cls closure (internal context for the plugin)
670  * @param zone hash of public key of the zone, NULL to iterate over all zones
671  * @param offset offset in the list of all matching records
672  * @param iter function to call with the result
673  * @param iter_cls closure for @a iter
674  * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
675  */
676 static int
677 namestore_sqlite_iterate_records (void *cls,
678                                   const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
679                                   uint64_t offset,
680                                   GNUNET_NAMESTORE_RecordIterator iter,
681                                   void *iter_cls)
682 {
683   struct Plugin *plugin = cls;
684   sqlite3_stmt *stmt;
685   int err;
686
687   if (NULL == zone)
688   {
689     struct GNUNET_SQ_QueryParam params[] = {
690       GNUNET_SQ_query_param_uint64 (&offset),
691       GNUNET_SQ_query_param_end
692     };
693
694     stmt = plugin->iterate_all_zones;
695     err = GNUNET_SQ_bind (stmt,
696                           params);
697   }
698   else
699   {
700     struct GNUNET_SQ_QueryParam params[] = {
701       GNUNET_SQ_query_param_auto_from_type (zone),
702       GNUNET_SQ_query_param_uint64 (&offset),
703       GNUNET_SQ_query_param_end
704     };
705
706     stmt = plugin->iterate_zone;
707     err = GNUNET_SQ_bind (stmt,
708                           params);
709   }
710   if (GNUNET_OK != err)
711   {
712     LOG_SQLITE (plugin,
713                 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
714                 "sqlite3_bind_XXXX");
715     GNUNET_SQ_reset (plugin->dbh,
716                      stmt);
717     return GNUNET_SYSERR;
718   }
719   return get_record_and_call_iterator (plugin,
720                                        stmt,
721                                        zone,
722                                        iter,
723                                        iter_cls);
724 }
725
726
727 /**
728  * Look for an existing PKEY delegation record for a given public key.
729  * Returns at most one result to the iterator.
730  *
731  * @param cls closure (internal context for the plugin)
732  * @param zone private key of the zone to look up in, never NULL
733  * @param value_zone public key of the target zone (value), never NULL
734  * @param iter function to call with the result
735  * @param iter_cls closure for @a iter
736  * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
737  */
738 static int
739 namestore_sqlite_zone_to_name (void *cls,
740                                const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
741                                const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
742                                GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
743 {
744   struct Plugin *plugin = cls;
745   struct GNUNET_SQ_QueryParam params[] = {
746     GNUNET_SQ_query_param_auto_from_type (zone),
747     GNUNET_SQ_query_param_auto_from_type (value_zone),
748     GNUNET_SQ_query_param_end
749   };
750
751   if (GNUNET_OK !=
752       GNUNET_SQ_bind (plugin->zone_to_name,
753                       params))
754   {
755     LOG_SQLITE (plugin,
756                 GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
757                 "sqlite3_bind_XXXX");
758     GNUNET_SQ_reset (plugin->dbh,
759                      plugin->zone_to_name);
760     return GNUNET_SYSERR;
761   }
762   LOG (GNUNET_ERROR_TYPE_DEBUG,
763        "Performing reverse lookup for `%s'\n",
764        GNUNET_GNSRECORD_z2s (value_zone));
765   return get_record_and_call_iterator (plugin,
766                                        plugin->zone_to_name,
767                                        zone,
768                                        iter,
769                                        iter_cls);
770 }
771
772
773 /**
774  * Entry point for the plugin.
775  *
776  * @param cls the "struct GNUNET_NAMESTORE_PluginEnvironment*"
777  * @return NULL on error, otherwise the plugin context
778  */
779 void *
780 libgnunet_plugin_namestore_sqlite_init (void *cls)
781 {
782   static struct Plugin plugin;
783   const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
784   struct GNUNET_NAMESTORE_PluginFunctions *api;
785
786   if (NULL != plugin.cfg)
787     return NULL;                /* can only initialize once! */
788   memset (&plugin, 0, sizeof (struct Plugin));
789   plugin.cfg = cfg;
790   if (GNUNET_OK != database_setup (&plugin))
791   {
792     database_shutdown (&plugin);
793     return NULL;
794   }
795   api = GNUNET_new (struct GNUNET_NAMESTORE_PluginFunctions);
796   api->cls = &plugin;
797   api->store_records = &namestore_sqlite_store_records;
798   api->iterate_records = &namestore_sqlite_iterate_records;
799   api->zone_to_name = &namestore_sqlite_zone_to_name;
800   api->lookup_records = &namestore_sqlite_lookup_records;
801   LOG (GNUNET_ERROR_TYPE_INFO,
802        _("Sqlite database running\n"));
803   return api;
804 }
805
806
807 /**
808  * Exit point from the plugin.
809  *
810  * @param cls the plugin context (as returned by "init")
811  * @return always NULL
812  */
813 void *
814 libgnunet_plugin_namestore_sqlite_done (void *cls)
815 {
816   struct GNUNET_NAMESTORE_PluginFunctions *api = cls;
817   struct Plugin *plugin = api->cls;
818
819   database_shutdown (plugin);
820   plugin->cfg = NULL;
821   GNUNET_free (api);
822   LOG (GNUNET_ERROR_TYPE_DEBUG,
823        "sqlite plugin is finished\n");
824   return NULL;
825 }
826
827 /* end of plugin_namestore_sqlite.c */