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_postgres.c
23 * @brief postgres-based namestore backend
24 * @author Christian Grothoff
27 #include "gnunet_namestore_plugin.h"
28 #include "gnunet_namestore_service.h"
29 #include "gnunet_gnsrecord_lib.h"
30 #include "gnunet_postgres_lib.h"
31 #include "namestore.h"
35 * After how many ms "busy" should a DB operation fail for good?
36 * A low value makes sure that we are more responsive to requests
37 * (especially PUTs). A high value guarantees a higher success
38 * rate (SELECTs in iterate can take several seconds despite LIMIT=1).
40 * The default value of 1s should ensure that users do not experience
41 * huge latencies while at the same time allowing operations to succeed
42 * with reasonable probability.
44 #define BUSY_TIMEOUT_MS 1000
48 * Log an error message at log-level 'level' that indicates
49 * a failure of the command 'cmd' on file 'filename'
50 * with the message given by strerror(errno).
52 #define LOG_POSTGRES(db, level, cmd) do { GNUNET_log_from (level, "namestore-postgres", _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, sqlite3_errmsg(db->dbh)); } while(0)
54 #define LOG(kind,...) GNUNET_log_from (kind, "namestore-postgres", __VA_ARGS__)
58 * Context for all functions in this plugin.
63 const struct GNUNET_CONFIGURATION_Handle *cfg;
66 * Native Postgres database handle.
74 * Create our database indices.
76 * @param dbh handle to the database
79 create_indices (PGconn * dbh)
83 GNUNET_POSTGRES_exec (dbh,
84 "CREATE INDEX ir_pkey_reverse ON ns097records (zone_private_key,pkey)")) ||
86 GNUNET_POSTGRES_exec (dbh,
87 "CREATE INDEX ir_pkey_iter ON ns097records (zone_private_key,rvalue)")) ||
89 GNUNET_POSTGRES_exec (dbh,
90 "CREATE INDEX it_iter ON ns097records (rvalue)")) )
91 LOG (GNUNET_ERROR_TYPE_ERROR,
92 _("Failed to create indices\n"));
97 * Initialize the database connections and associated
98 * data structures (create tables and indices
101 * @param plugin the plugin context (state for this module)
102 * @return GNUNET_OK on success
105 database_setup (struct Plugin *plugin)
109 plugin->dbh = GNUNET_POSTGRES_connect (plugin->cfg,
110 "namestore-postgres");
111 if (NULL == plugin->dbh)
112 return GNUNET_SYSERR;
114 GNUNET_CONFIGURATION_get_value_yesno (plugin->cfg,
115 "namestore-postgres",
120 "CREATE TEMPORARY TABLE ns097records ("
121 " zone_private_key BYTEA NOT NULL DEFAULT '',"
122 " pkey BYTEA DEFAULT '',"
123 " rvalue BYTEA NOT NULL DEFAULT '',"
124 " record_count INTEGER NOT NULL DEFAULT 0,"
125 " record_data BYTEA NOT NULL DEFAULT '',"
126 " label TEXT NOT NULL DEFAULT ''"
133 "CREATE TABLE ns097records ("
134 " zone_private_key BYTEA NOT NULL DEFAULT '',"
135 " pkey BYTEA DEFAULT '',"
136 " rvalue BYTEA NOT NULL DEFAULT '',"
137 " record_count INTEGER NOT NULL DEFAULT 0,"
138 " record_data BYTEA NOT NULL DEFAULT '',"
139 " label TEXT NOT NULL DEFAULT ''"
142 if ( (NULL == res) ||
143 ((PQresultStatus (res) != PGRES_COMMAND_OK) &&
144 (0 != strcmp ("42P07", /* duplicate table */
147 PG_DIAG_SQLSTATE)))))
149 (void) GNUNET_POSTGRES_check_result (plugin->dbh, res,
150 PGRES_COMMAND_OK, "CREATE TABLE",
152 PQfinish (plugin->dbh);
154 return GNUNET_SYSERR;
156 create_indices (plugin->dbh);
159 GNUNET_POSTGRES_prepare (plugin->dbh,
161 "INSERT INTO ns097records (zone_private_key, pkey, rvalue, record_count, record_data, label) VALUES "
162 "($1, $2, $3, $4, $5, $6)", 6)) ||
164 GNUNET_POSTGRES_prepare (plugin->dbh,
166 "DELETE FROM ns097records WHERE zone_private_key=$1 AND label=$2", 2)) ||
168 GNUNET_POSTGRES_prepare (plugin->dbh,
170 "SELECT record_count,record_data,label FROM ns097records"
171 " WHERE zone_private_key=$1 AND pkey=$2", 2)) ||
173 GNUNET_POSTGRES_prepare (plugin->dbh,
175 "SELECT record_count, record_data, label FROM ns097records"
176 " WHERE zone_private_key=$1 ORDER BY rvalue LIMIT 1 OFFSET $2", 2)) ||
178 GNUNET_POSTGRES_prepare (plugin->dbh,
180 "SELECT record_count,record_data,label,zone_private_key"
181 " FROM ns097records ORDER BY rvalue LIMIT 1 OFFSET $1", 1)))
183 PQfinish (plugin->dbh);
185 return GNUNET_SYSERR;
192 * Store a record in the datastore. Removes any existing record in the
193 * same zone with the same name.
195 * @param cls closure (internal context for the plugin)
196 * @param zone_key private key of the zone
197 * @param label name that is being mapped (at most 255 characters long)
198 * @param rd_count number of entries in @a rd array
199 * @param rd array of records with data to store
200 * @return #GNUNET_OK on success, else #GNUNET_SYSERR
203 namestore_postgres_store_records (void *cls,
204 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
206 unsigned int rd_count,
207 const struct GNUNET_GNSRECORD_Data *rd)
209 struct Plugin *plugin = cls;
210 struct GNUNET_CRYPTO_EcdsaPublicKey pkey;
212 uint32_t rd_count_nbo = htonl ((uint32_t) rd_count);
216 memset (&pkey, 0, sizeof (pkey));
217 for (i=0;i<rd_count;i++)
218 if (GNUNET_GNSRECORD_TYPE_PKEY == rd[i].record_type)
220 GNUNET_break (sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey) == rd[i].data_size);
226 rvalue = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK, UINT64_MAX);
227 data_size = GNUNET_GNSRECORD_records_get_size (rd_count, rd);
228 if (data_size > 64 * 65536)
231 return GNUNET_SYSERR;
234 char data[data_size];
235 const char *paramValues[] = {
236 (const char *) zone_key,
237 (const char *) &pkey,
238 (const char *) &rvalue,
239 (const char *) &rd_count_nbo,
243 int paramLengths[] = {
247 sizeof (rd_count_nbo),
251 const int paramFormats[] = { 1, 1, 1, 1, 1, 1 };
254 if (data_size != GNUNET_GNSRECORD_records_serialize (rd_count, rd,
258 return GNUNET_SYSERR;
262 PQexecPrepared (plugin->dbh, "store_records", 6,
263 paramValues, paramLengths, paramFormats, 1);
265 GNUNET_POSTGRES_check_result (plugin->dbh,
270 return GNUNET_SYSERR;
278 * A statement has been run. We should evaluate the result, and if possible
279 * call the given @a iter with the result.
281 * @param plugin plugin context
282 * @param res result from the statement that was run (to be cleaned up)
283 * @param zone_key private key of the zone, could be NULL, in which case we should
284 * get the zone from @a res
285 * @param iter iterator to call with the result
286 * @param iter_cls closure for @a iter
287 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
290 get_record_and_call_iterator (struct Plugin *plugin,
292 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone_key,
293 GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
297 uint32_t record_count;
303 GNUNET_POSTGRES_check_result (plugin->dbh, res, PGRES_TUPLES_OK,
307 LOG (GNUNET_ERROR_TYPE_DEBUG,
308 "Failing lookup (postgres error)\n");
309 return GNUNET_SYSERR;
311 if (0 == (cnt = PQntuples (res)))
314 LOG (GNUNET_ERROR_TYPE_DEBUG,
315 "Ending iteration (no more results)\n");
319 GNUNET_assert (1 == cnt);
320 GNUNET_assert (3 + ((NULL == zone_key) ? 1 : 0) == PQnfields (res));
321 if (NULL == zone_key)
323 if (sizeof (struct GNUNET_CRYPTO_EcdsaPrivateKey) != PQgetlength (res, 0, 3))
327 return GNUNET_SYSERR;
329 zone_key = (const struct GNUNET_CRYPTO_EcdsaPrivateKey *) PQgetvalue (res, 0, 3);
331 if (sizeof (uint32_t) != PQfsize (res, 0))
335 return GNUNET_SYSERR;
338 record_count = ntohl (*(uint32_t *) PQgetvalue (res, 0, 0));
339 data = PQgetvalue (res, 0, 1);
340 data_size = PQgetlength (res, 0, 1);
341 label = PQgetvalue (res, 0, 2);
342 label_len = PQgetlength (res, 0, 1);
343 if (record_count > 64 * 1024)
345 /* sanity check, don't stack allocate far too much just
346 because database might contain a large value here */
349 return GNUNET_SYSERR;
352 struct GNUNET_GNSRECORD_Data rd[record_count];
353 char buf[label_len + 1];
355 memcpy (buf, label, label_len);
356 buf[label_len] = '\0';
358 GNUNET_GNSRECORD_records_deserialize (data_size, data,
363 return GNUNET_SYSERR;
365 iter (iter_cls, zone_key, buf, record_count, rd);
373 * Iterate over the results for a particular key and zone in the
374 * datastore. Will return at most one result to the iterator.
376 * @param cls closure (internal context for the plugin)
377 * @param zone hash of public key of the zone, NULL to iterate over all zones
378 * @param offset offset in the list of all matching records
379 * @param iter function to call with the result
380 * @param iter_cls closure for @a iter
381 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
384 namestore_postgres_iterate_records (void *cls,
385 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
387 GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
389 struct Plugin *plugin = cls;
390 uint64_t offset_be = GNUNET_htonll (offset);
394 const char *paramValues[] = {
395 (const char *) &offset_be
397 int paramLengths[] = {
400 const int paramFormats[] = { 1 };
403 res = PQexecPrepared (plugin->dbh,
404 "iterate_all_zones", 1,
405 paramValues, paramLengths, paramFormats,
407 return get_record_and_call_iterator (plugin,
414 const char *paramValues[] = {
416 (const char *) &offset_be
418 int paramLengths[] = {
422 const int paramFormats[] = { 1, 1 };
425 res = PQexecPrepared (plugin->dbh,
427 paramValues, paramLengths, paramFormats,
429 return get_record_and_call_iterator (plugin,
438 * Look for an existing PKEY delegation record for a given public key.
439 * Returns at most one result to the iterator.
441 * @param cls closure (internal context for the plugin)
442 * @param zone private key of the zone to look up in, never NULL
443 * @param value_zone public key of the target zone (value), never NULL
444 * @param iter function to call with the result
445 * @param iter_cls closure for @a iter
446 * @return #GNUNET_OK on success, #GNUNET_NO if there were no results, #GNUNET_SYSERR on error
449 namestore_postgres_zone_to_name (void *cls,
450 const struct GNUNET_CRYPTO_EcdsaPrivateKey *zone,
451 const struct GNUNET_CRYPTO_EcdsaPublicKey *value_zone,
452 GNUNET_NAMESTORE_RecordIterator iter, void *iter_cls)
454 struct Plugin *plugin = cls;
455 const char *paramValues[] = {
457 (const char *) value_zone
459 int paramLengths[] = {
463 const int paramFormats[] = { 1, 1 };
466 res = PQexecPrepared (plugin->dbh,
468 paramValues, paramLengths, paramFormats,
470 return get_record_and_call_iterator (plugin,
478 * Shutdown database connection and associate data
481 * @param plugin the plugin context (state for this module)
484 database_shutdown (struct Plugin *plugin)
486 PQfinish (plugin->dbh);
492 * Entry point for the plugin.
494 * @param cls the "struct GNUNET_NAMESTORE_PluginEnvironment*"
495 * @return NULL on error, othrewise the plugin context
498 libgnunet_plugin_namestore_postgres_init (void *cls)
500 static struct Plugin plugin;
501 const struct GNUNET_CONFIGURATION_Handle *cfg = cls;
502 struct GNUNET_NAMESTORE_PluginFunctions *api;
504 if (NULL != plugin.cfg)
505 return NULL; /* can only initialize once! */
506 memset (&plugin, 0, sizeof (struct Plugin));
508 if (GNUNET_OK != database_setup (&plugin))
510 database_shutdown (&plugin);
513 api = GNUNET_new (struct GNUNET_NAMESTORE_PluginFunctions);
515 api->store_records = &namestore_postgres_store_records;
516 api->iterate_records = &namestore_postgres_iterate_records;
517 api->zone_to_name = &namestore_postgres_zone_to_name;
518 LOG (GNUNET_ERROR_TYPE_INFO,
519 _("Postgres database running\n"));
525 * Exit point from the plugin.
527 * @param cls the plugin context (as returned by "init")
528 * @return always NULL
531 libgnunet_plugin_namestore_postgres_done (void *cls)
533 struct GNUNET_NAMESTORE_PluginFunctions *api = cls;
534 struct Plugin *plugin = api->cls;
536 database_shutdown (plugin);
539 LOG (GNUNET_ERROR_TYPE_DEBUG,
540 "postgres plugin is finished\n");
544 /* end of plugin_namestore_postgres.c */