- moved timeout handling responsibility from for nat tests from caller to the library
[oweals/gnunet.git] / src / peerstore / plugin_peerstore_sqlite.c
index ff6ae9f67f108b878ce96573ba3d709794917193..fdf25c79c52603f025340b6832c61a2a1914a54a 100644 (file)
@@ -77,8 +77,259 @@ struct Plugin
    */
   sqlite3_stmt *insert_peerstoredata;
 
+  /**
+   * Precompiled SQL for selecting from peerstoredata
+   */
+  sqlite3_stmt *select_peerstoredata;
+
+  /**
+   * Precompiled SQL for selecting from peerstoredata
+   */
+  sqlite3_stmt *select_peerstoredata_by_pid;
+
+  /**
+   * Precompiled SQL for selecting from peerstoredata
+   */
+  sqlite3_stmt *select_peerstoredata_by_key;
+
+  /**
+   * Precompiled SQL for selecting from peerstoredata
+   */
+  sqlite3_stmt *select_peerstoredata_by_all;
+
+  /**
+   * Precompiled SQL for deleting expired
+   * records from peerstoredata
+   */
+  sqlite3_stmt *expire_peerstoredata;
+
+  /**
+   * Precompiled SQL for deleting records
+   * with given key
+   */
+  sqlite3_stmt *delete_peerstoredata;
+
 };
 
+/**
+ * Delete records with the given key
+ *
+ * @param cls closure (internal context for the plugin)
+ * @param sub_system name of sub system
+ * @param peer Peer identity (can be NULL)
+ * @param key entry key string (can be NULL)
+ * @return number of deleted records
+ */
+static int
+peerstore_sqlite_delete_records(void *cls,
+    const char *sub_system,
+    const struct GNUNET_PeerIdentity *peer,
+    const char *key)
+{
+  struct Plugin *plugin = cls;
+  sqlite3_stmt *stmt = plugin->delete_peerstoredata;
+
+  if((SQLITE_OK != sqlite3_bind_text(stmt, 1, sub_system, strlen(sub_system) + 1, SQLITE_STATIC))
+      || (SQLITE_OK != sqlite3_bind_blob(stmt, 2, peer, sizeof(struct GNUNET_PeerIdentity), SQLITE_STATIC))
+      || (SQLITE_OK != sqlite3_bind_text(stmt, 3, key, strlen(key) + 1, SQLITE_STATIC)))
+  {
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_bind");
+  }
+  else if (SQLITE_DONE != sqlite3_step (stmt))
+  {
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
+                "sqlite3_step");
+  }
+  if (SQLITE_OK != sqlite3_reset (stmt))
+  {
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
+                "sqlite3_reset");
+    return 0;
+  }
+  return sqlite3_changes(plugin->dbh);
+}
+
+/**
+ * Delete expired records (expiry < now)
+ *
+ * @param cls closure (internal context for the plugin)
+ * @param now time to use as reference
+ * @return number of records deleted
+ */
+static int
+peerstore_sqlite_expire_records(void *cls,
+    struct GNUNET_TIME_Absolute now)
+{
+  struct Plugin *plugin = cls;
+  sqlite3_stmt *stmt = plugin->expire_peerstoredata;
+
+  if(SQLITE_OK != sqlite3_bind_int64(stmt, 1, (sqlite3_uint64)now.abs_value_us))
+  {
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK, "sqlite3_bind");
+  }
+  else if (SQLITE_DONE != sqlite3_step (stmt))
+  {
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
+                "sqlite3_step");
+  }
+  if (SQLITE_OK != sqlite3_reset (stmt))
+  {
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
+                "sqlite3_reset");
+    return 0;
+  }
+  return sqlite3_changes(plugin->dbh);
+
+}
+
+/**
+ * Iterate over the records given an optional peer id
+ * and/or key.
+ *
+ * @param cls closure (internal context for the plugin)
+ * @param sub_system name of sub system
+ * @param peer Peer identity (can be NULL)
+ * @param key entry key string (can be NULL)
+ * @param iter function to call with the result
+ * @param iter_cls closure for @a iter
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
+ */
+static int
+peerstore_sqlite_iterate_records (void *cls,
+    const char *sub_system,
+    const struct GNUNET_PeerIdentity *peer,
+    const char *key,
+    GNUNET_PEERSTORE_Processor iter, void *iter_cls)
+{
+  struct Plugin *plugin = cls;
+  sqlite3_stmt *stmt;
+  int err = 0;
+  int sret;
+  struct GNUNET_PEERSTORE_Record *ret;
+
+  LOG(GNUNET_ERROR_TYPE_DEBUG, "Executing iterate request on sqlite db.\n");
+  if(NULL == peer && NULL == key)
+  {
+    stmt = plugin->select_peerstoredata;
+    err = (SQLITE_OK != sqlite3_bind_text(stmt, 1, sub_system, strlen(sub_system) + 1, SQLITE_STATIC));
+  }
+  else if(NULL == key)
+  {
+    stmt = plugin->select_peerstoredata_by_pid;
+    err = (SQLITE_OK != sqlite3_bind_text(stmt, 1, sub_system, strlen(sub_system) + 1, SQLITE_STATIC))
+        || (SQLITE_OK != sqlite3_bind_blob(stmt, 2, peer, sizeof(struct GNUNET_PeerIdentity), SQLITE_STATIC));
+  }
+  else if(NULL == peer)
+  {
+    stmt = plugin->select_peerstoredata_by_key;
+    err = (SQLITE_OK != sqlite3_bind_text(stmt, 1, sub_system, strlen(sub_system) + 1, SQLITE_STATIC))
+        || (SQLITE_OK != sqlite3_bind_text(stmt, 3, key, strlen(key) + 1, SQLITE_STATIC));
+  }
+  else
+  {
+    stmt = plugin->select_peerstoredata_by_all;
+    err = (SQLITE_OK != sqlite3_bind_text(stmt, 1, sub_system, strlen(sub_system) + 1, SQLITE_STATIC))
+            || (SQLITE_OK != sqlite3_bind_blob(stmt, 2, peer, sizeof(struct GNUNET_PeerIdentity), SQLITE_STATIC))
+            || (SQLITE_OK != sqlite3_bind_text(stmt, 3, key, strlen(key) + 1, SQLITE_STATIC));
+  }
+
+  if (err)
+  {
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
+    "sqlite3_bind_XXXX");
+    if (SQLITE_OK != sqlite3_reset (stmt))
+      LOG_SQLITE (plugin,
+      GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
+      "sqlite3_reset");
+    return GNUNET_SYSERR;
+  }
+  while (SQLITE_ROW == (sret = sqlite3_step (stmt)))
+  {
+    LOG(GNUNET_ERROR_TYPE_DEBUG, "Returning a matched record.\n");
+    ret = GNUNET_new(struct GNUNET_PEERSTORE_Record);
+    ret->sub_system = (char *)sqlite3_column_text(stmt, 0);
+    ret->peer = (struct GNUNET_PeerIdentity *)sqlite3_column_blob(stmt, 1);
+    ret->key = (char *)sqlite3_column_text(stmt, 2);
+    ret->value = (void *)sqlite3_column_blob(stmt, 3);
+    ret->value_size = sqlite3_column_bytes(stmt, 3);
+    ret->expiry = GNUNET_new(struct GNUNET_TIME_Absolute);
+    ret->expiry->abs_value_us = (uint64_t)sqlite3_column_int64(stmt, 4);
+    if (NULL != iter)
+      iter (iter_cls,
+          ret,
+          NULL);
+    GNUNET_free(ret->expiry);
+    GNUNET_free(ret);
+  }
+  if (SQLITE_DONE != sret)
+  {
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR, "sqlite_step");
+    err = 1;
+  }
+  if (SQLITE_OK != sqlite3_reset (stmt))
+  {
+    LOG_SQLITE (plugin,
+    GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
+    "sqlite3_reset");
+    err = 1;
+  }
+  if(err)
+    return GNUNET_SYSERR;
+  return GNUNET_OK;
+}
+
+/**
+ * Store a record in the peerstore.
+ * Key is the combination of sub system and peer identity.
+ * One key can store multiple values.
+ *
+ * @param cls closure (internal context for the plugin)
+ * @param peer peer identity
+ * @param sub_system name of the GNUnet sub system responsible
+ * @param value value to be stored
+ * @param size size of value to be stored
+ * @return #GNUNET_OK on success, else #GNUNET_SYSERR
+ */
+static int
+peerstore_sqlite_store_record(void *cls,
+    const char *sub_system,
+    const struct GNUNET_PeerIdentity *peer,
+    const char *key,
+    const void *value,
+    size_t size,
+    struct GNUNET_TIME_Absolute expiry,
+    enum GNUNET_PEERSTORE_StoreOption options)
+{
+  struct Plugin *plugin = cls;
+  sqlite3_stmt *stmt = plugin->insert_peerstoredata;
+
+  if(GNUNET_PEERSTORE_STOREOPTION_REPLACE == options)
+  {
+    peerstore_sqlite_delete_records(cls, sub_system, peer, key);
+  }
+  if(SQLITE_OK != sqlite3_bind_text(stmt, 1, sub_system, strlen(sub_system) + 1, SQLITE_STATIC)
+      || SQLITE_OK != sqlite3_bind_blob(stmt, 2, peer, sizeof(struct GNUNET_PeerIdentity), SQLITE_STATIC)
+      || SQLITE_OK != sqlite3_bind_text(stmt, 3, key, strlen(key) + 1, SQLITE_STATIC)
+      || SQLITE_OK != sqlite3_bind_blob(stmt, 4, value, size, SQLITE_STATIC)
+      || SQLITE_OK != sqlite3_bind_int64(stmt, 5, (sqlite3_uint64)expiry.abs_value_us))
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
+                    "sqlite3_bind");
+  else if (SQLITE_DONE != sqlite3_step (stmt))
+  {
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
+                "sqlite3_step");
+  }
+  if (SQLITE_OK != sqlite3_reset (stmt))
+  {
+    LOG_SQLITE (plugin, GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
+                "sqlite3_reset");
+    return GNUNET_SYSERR;
+  }
+
+  return GNUNET_OK;
+}
+
+
 /**
  * @brief Prepare a SQL statement
  *
@@ -126,6 +377,21 @@ sql_prepare (sqlite3 *dbh, const char *sql, sqlite3_stmt **stmt)
   return result;
 }
 
+/**
+ * sqlite3 custom function for comparison of uint64_t values
+ * since it is not supported by default
+ */
+void sqlite3_lessthan(sqlite3_context* ctx, int dummy,
+    sqlite3_value** values)
+{
+  uint64_t v1;
+  uint64_t v2;
+
+  v1 = (uint64_t)sqlite3_value_int64(values[0]);
+  v2 = (uint64_t)sqlite3_value_int64(values[1]);
+  sqlite3_result_int(ctx, v1 < v2);
+}
+
 /**
  * Initialize the database connections and associated
  * data structures (create tables and indices
@@ -169,7 +435,7 @@ database_setup (struct Plugin *plugin)
   }
 
   sql_exec (plugin->dbh, "PRAGMA temp_store=MEMORY");
-  sql_exec (plugin->dbh, "PRAGMA synchronous=NORMAL");
+  sql_exec (plugin->dbh, "PRAGMA synchronous=OFF");
   sql_exec (plugin->dbh, "PRAGMA legacy_file_format=OFF");
   sql_exec (plugin->dbh, "PRAGMA auto_vacuum=INCREMENTAL");
   sql_exec (plugin->dbh, "PRAGMA encoding=\"UTF-8\"");
@@ -181,17 +447,63 @@ database_setup (struct Plugin *plugin)
   /* Create tables */
 
   sql_exec (plugin->dbh,
-            "CREATE TABLE IF NOT EXISTS peerstoredata (\n"
-            "  sub_system TEXT NOT NULL,\n"
-            "  peer_id BLOB NOT NULL,\n"
-            "  value BLOB NULL"
-            ");");
+      "CREATE TABLE IF NOT EXISTS peerstoredata (\n"
+      "  sub_system TEXT NOT NULL,\n"
+      "  peer_id BLOB NOT NULL,\n"
+      "  key TEXT NOT NULL,\n"
+      "  value BLOB NULL,\n"
+      "  expiry sqlite3_uint64 NOT NULL"
+      ");");
+
+  sqlite3_create_function(plugin->dbh, "UINT64_LT", 2, SQLITE_UTF8, NULL, &sqlite3_lessthan, NULL, NULL);
+
+  /* Create Indices */
+  if (SQLITE_OK !=
+      sqlite3_exec(plugin->dbh,
+        "CREATE INDEX IF NOT EXISTS peerstoredata_key_index ON peerstoredata (sub_system, peer_id, key)",
+        NULL, NULL, NULL))
+  {
+    LOG (GNUNET_ERROR_TYPE_ERROR,
+     _("Unable to create indices: %s.\n"),
+     sqlite3_errmsg (plugin->dbh));
+      return GNUNET_SYSERR;
+  }
 
   /* Prepare statements */
 
   sql_prepare (plugin->dbh,
-               "INSERT INTO peerstoredata (sub_system, peer_id, value) VALUES (?,?,?);",
-               &plugin->insert_peerstoredata);
+      "INSERT INTO peerstoredata (sub_system, peer_id, key, value, expiry) VALUES (?,?,?,?,?);",
+      &plugin->insert_peerstoredata);
+  sql_prepare(plugin->dbh,
+      "SELECT * FROM peerstoredata"
+      " WHERE sub_system = ?",
+      &plugin->select_peerstoredata);
+  sql_prepare(plugin->dbh,
+      "SELECT * FROM peerstoredata"
+      " WHERE sub_system = ?"
+      " AND peer_id = ?",
+      &plugin->select_peerstoredata_by_pid);
+  sql_prepare(plugin->dbh,
+      "SELECT * FROM peerstoredata"
+      " WHERE sub_system = ?"
+      " AND key = ?",
+      &plugin->select_peerstoredata_by_key);
+  sql_prepare(plugin->dbh,
+      "SELECT * FROM peerstoredata"
+      " WHERE sub_system = ?"
+      " AND peer_id = ?"
+      " AND key = ?",
+      &plugin->select_peerstoredata_by_all);
+  sql_prepare(plugin->dbh,
+      "DELETE FROM peerstoredata"
+      " WHERE UINT64_LT(expiry, ?)",
+      &plugin->expire_peerstoredata);
+  sql_prepare(plugin->dbh,
+      "DELETE FROM peerstoredata"
+      " WHERE sub_system = ?"
+      " AND peer_id = ?"
+      " AND key = ?",
+      &plugin->delete_peerstoredata);
 
   return GNUNET_OK;
 }
@@ -243,7 +555,10 @@ libgnunet_plugin_peerstore_sqlite_init (void *cls)
   }
   api = GNUNET_new (struct GNUNET_PEERSTORE_PluginFunctions);
   api->cls = &plugin;
-  LOG(GNUNET_ERROR_TYPE_INFO, "Sqlite plugin is running\n");
+  api->store_record = &peerstore_sqlite_store_record;
+  api->iterate_records = &peerstore_sqlite_iterate_records;
+  api->expire_records = &peerstore_sqlite_expire_records;
+  LOG(GNUNET_ERROR_TYPE_DEBUG, "Sqlite plugin is running\n");
   return api;
 }
 
@@ -262,7 +577,7 @@ libgnunet_plugin_peerstore_sqlite_done (void *cls)
   database_shutdown (plugin);
   plugin->cfg = NULL;
   GNUNET_free (api);
-  LOG (GNUNET_ERROR_TYPE_INFO, "Sqlite plugin is finished\n");
+  LOG (GNUNET_ERROR_TYPE_DEBUG, "Sqlite plugin is finished\n");
   return NULL;
 
 }