ExternalVendorCode/serval-dna
1
0
Fork 0
mirror of https://github.com/servalproject/serval-dna.git synced 2024-12-30 09:58:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
7993332fe9
serval-dna/rhizome_database.c
Andrew Bettison f91033820b Use explicit serverMode enum values everywhere
2018-06-01 17:40:09 +09:30

2185 lines
79 KiB
C
Raw Blame History

/*
Serval DNA - Rhizome database operations
Copyright (C) 2012-2014 Serval Project Inc.
Copyright (C) 2016-2018 Flinders University
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#define __RHIZOME_INLINE
#include <stdlib.h>
#include <time.h>
#include <ctype.h>
#include <assert.h>
#include "lang.h" // for FALLTHROUGH
#include "serval.h"
#include "conf.h"
#include "rhizome.h"
#include "strbuf.h"
#include "strbuf_helpers.h"
#include "str.h"
#include "keyring.h"
#include "server.h"
#include "commandline.h"
#include "mdp_client.h"
#include "debug.h"
static int rhizome_delete_manifest_retry(sqlite_retry_state *retry, const rhizome_bid_t *bidp);
__thread struct rhizome_database rhizome_database = {
.dir_path = "",
.db = NULL,
.uuid = SERVAL_UUID_INVALID
};
static time_ms_t rhizomeRetryLimit = -1;
int is_debug_rhizome()
{
return IF_DEBUG(rhizome);
}
int is_debug_rhizome_ads()
{
return IF_DEBUG(rhizome_ads);
}
static int (*sqlite_trace_func)() = is_debug_rhizome;
const struct __sourceloc *sqlite_trace_whence = NULL;
static int sqlite_trace_done;
static uint64_t max_rowid=0;
/* This callback conditionally logs all rendered SQL statements. This function is registered with
* SQLite as the 'trace callback'. SQLite invokes it with mask == SQLITE_TRACE_STMT when about to
* execute a statement using sqlite3_step(), and with mask == SQLITE_TRACE_PROFILE when the
* statement finishes executing.
*
* SQLite neglects to call its trace callback with mask==SQLITE_TRACE_STMT on some kinds of
* statements, eg, PRAGMA. However, it does appear to call its trace callback with
* mask==SQLITE_TRACE_PROFILE after every kind of statement. Hence this function uses both
* callbacks, and uses the 'sqlite_trace_done' flag, which gets reset to zero whenever Rhizome
* prepares a new SQLite statement, to avoid duplicate logging.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
static int sqlite_trace_callback(unsigned UNUSED(mask), void *UNUSED(context), void * p, void * x)
{
if (sqlite_trace_func()) {
const char * expanded_sql = NULL;
const char * rendered_sql = NULL;
switch (mask) {
case SQLITE_TRACE_STMT:
if (!sqlite_trace_done) {
sqlite3_stmt * stmt = p;
const char * unexpanded_sql = x;
rendered_sql = (unexpanded_sql[0] == '-' && unexpanded_sql[1] == '-') ?
&unexpanded_sql[2] : (expanded_sql = sqlite3_expanded_sql(stmt));
}
break;
case SQLITE_TRACE_PROFILE:
if (!sqlite_trace_done) {
sqlite3_stmt * stmt = p;
rendered_sql = (expanded_sql = sqlite3_expanded_sql(stmt));
}
break;
}
if (rendered_sql) {
serval_logf(LOG_LEVEL_DEBUG, sqlite_trace_whence ? *sqlite_trace_whence : __HERE__, "%s", rendered_sql);
++sqlite_trace_done;
}
if (expanded_sql)
sqlite3_free((void*)expanded_sql);
}
return 0; // ignored by SQLite
}
/* This function allows code like:
*
* debugflags_t oldmask = sqlite_set_debugmask(DEBUG_SOMETHING_ELSE);
* ...
* sqlite3_stmt *statement = sqlite_prepare(&retry, "select blah blah blah");
* while (sqlite_step_retry(&retry, statement) == SQLITE_ROW) {
* // do blah blah blah
* }
* ...
* sqlite_set_debugmask(oldmask);
* return result;
*
* so that code can choose which DEBUG_ flags control the logging of rendered SQL queries.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int (*sqlite_set_tracefunc(int (*newfunc)()))()
{
int (*oldfunc)() = sqlite_trace_func;
sqlite_trace_func = newfunc;
return oldfunc;
}
void sqlite_log(void *UNUSED(ignored), int result, const char *msg)
{
WARNF("Sqlite: %d %s", result, msg);
}
void verify_bundles()
{
// assume that only the manifest itself can be trusted
// fetch all manifests, parse and update or delete them.
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
sqlite3_stmt *statement = sqlite_prepare(&retry, "SELECT ROWID, MANIFEST FROM MANIFESTS ORDER BY ROWID DESC;");
while (sqlite_step_retry(&retry, statement) == SQLITE_ROW) {
sqlite3_int64 rowid = sqlite3_column_int64(statement, 0);
const void *blob = sqlite3_column_blob(statement, 1);
size_t blob_length = sqlite3_column_bytes(statement, 1);
rhizome_manifest *m = rhizome_new_manifest();
if (m) {
memcpy(m->manifestdata, blob, blob_length);
m->manifest_all_bytes = blob_length;
int ret = -1;
if ( rhizome_manifest_parse(m) != -1
&& rhizome_manifest_validate(m)
&& rhizome_manifest_verify(m)
) {
assert(m->finalised);
if (m->filesize == 0 || rhizome_exists(&m->filehash) == RHIZOME_PAYLOAD_STATUS_STORED){
// Attempt to update the manifest
rhizome_bar_t bar;
rhizome_manifest_to_bar(m, &bar);
rhizome_authenticate_author(m);
if (sqlite_exec_void("UPDATE MANIFESTS SET "
"id = ?, "
"version = ?, "
"bar = ?, "
"filesize = ?, "
"filehash = ?, "
"author = ?, "
"service = ?, "
"name = ?, "
"sender = ?, "
"recipient = ?, "
"tail = ?, "
"manifest_hash = ? "
"WHERE ROWID = ?;",
RHIZOME_BID_T, &m->keypair.public_key,
INT64, m->version,
RHIZOME_BAR_T, &bar,
INT64, m->filesize,
RHIZOME_FILEHASH_T|NUL, m->filesize > 0 ? &m->filehash : NULL,
SID_T|NUL, m->authorship == AUTHOR_AUTHENTIC ? &m->author : NULL,
STATIC_TEXT, m->service,
STATIC_TEXT|NUL, m->name,
SID_T|NUL, m->has_sender ? &m->sender : NULL,
SID_T|NUL, m->has_recipient ? &m->recipient : NULL,
INT64, m->tail,
RHIZOME_FILEHASH_T, &m->manifesthash,
INT64, rowid,
END
)!=-1)
ret = 0;
}
}
if (ret) {
DEBUGF(rhizome, "Removing invalid manifest entry @%lld", rowid);
sqlite_exec_void_retry(&retry, "DELETE FROM MANIFESTS WHERE ROWID = ?;", INT64, rowid, END);
}
rhizome_manifest_free(m);
}
}
sqlite3_finalize(statement);
}
/*
* The MANIFESTS table 'author' column records the cryptographically verified SID of the author that
* has write permission on the bundle, ie, possesses the Rhizome secret key that generated the BID,
* and hence can derive the Bundle Secret from the bundle's BK field:
*
* - The MANIFESTS table 'author' column is set to the author SID when a bundle is created locally
* by a non-secret identity, so no verification need be performed for one's own bundles while they
* remain in the local Rhizome store.
*
* - When a bundle is imported, the 'author' column is set to NULL to indicate that no verification
* has passed yet. This includes one's own bundles that have been purged from the local Rhizome
* store then recovered from a remote Rhizome node.
*
* - When a manifest with NULL 'author' is examined closely, ie extracted, not merely listed, the
* keyring is searched for an identity that is the author. If the identity is found and its
* Rhizome Secret unlocks the Bundle Key (ie, reveals a Bundle Secret that yields the Bundle's ID
* as its public key), the MANIFESTS table 'author' column is updated. This allows one to regain
* the ability to overwrite one's own bundles that have been lost but
* recovered from an exterior Rhizome node.
*
* - The above check automates the "own bundle recovery" mechanism at the expense of a CPU-heavy
* cryptographic check every time a foreign bundle is examined, but at least listing is fast.
* This will not scale as many identities are added to the keyring. It will eventually have to be
* replaced with a means to cache positive and negative verifications in the Rhizome db for local,
* non-secret identities.
*
* -- Andrew Bettison <andrew@servalproject.com>, October 2012
*/
int rhizome_opendb()
{
if (rhizome_database.db) {
assert(serval_uuid_is_valid(&rhizome_database.uuid));
return 0;
}
IN();
if (sodium_init() == -1)
RETURN(WHY("Failed to initialise libsodium"));
// Work out the absolute path of the directory that contains all the database
// files/subdirectories.
if (!FORMF_RHIZOME_STORE_PATH(rhizome_database.dir_path, "%s", ""))
RETURN(-1);
DEBUGF(rhizome, "Rhizome store directory path = %s", alloca_str_toprint(rhizome_database.dir_path));
// Work out the absolute paths of the database file and subdirectories.
char dbpath[sizeof rhizome_database.dir_path];
char blobpath[sizeof rhizome_database.dir_path];
char hashpath[sizeof rhizome_database.dir_path];
char temppath[sizeof rhizome_database.dir_path];
int db_exists = 0;
{
struct file_meta dbmeta;
if ( !FORMF_RHIZOME_STORE_PATH(dbpath, "rhizome.db")
|| !FORMF_RHIZOME_STORE_PATH(blobpath, RHIZOME_BLOB_SUBDIR)
|| !FORMF_RHIZOME_STORE_PATH(hashpath, RHIZOME_HASH_SUBDIR)
|| !FORMF_RHIZOME_STORE_PATH(temppath, "sqlite3tmp")
|| get_file_meta(dbpath, &dbmeta) == -1)
RETURN(-1);
db_exists = is_file_meta_exists(&dbmeta);
}
// Create missing store directory.
if (emkdirs_info(rhizome_database.dir_path, 0700) == -1)
RETURN(-1);
// If the database file does not exist, then SQLite will create it. However, in 2014 a bug was
// introduced that always created the database file in the instance directory, regardless of the
// setting of the 'rhizome.datastore_path' config option. This bug has now been fixed, so in
// order to preserve the Rhizome data store when upgrading from an earlier (buggy) version, if
// there is a database file at this "legacy" location, then move it into the correct, configured
// location, instead of creating a fresh (empty) database file.
if (!db_exists) {
char legacy_dbpath[sizeof rhizome_database.dir_path];
if (FORMF_RHIZOME_STORE_LEGACY_PATH(legacy_dbpath, "rhizome.db")
&& strcmp(legacy_dbpath, dbpath) != 0
&& file_exists(legacy_dbpath)
) {
INFOF("Recover legacy Rhizome SQLite database");
// Move the legacy database file to its correct location.
if (erename_info(legacy_dbpath, dbpath) == -1)
RETURN(-1);
// Move any legacy "blob" and "hash" subdirectories too, if they are present.
char legacy_dirpath[sizeof rhizome_database.dir_path];
if ( !file_exists(blobpath)
&& FORMF_RHIZOME_STORE_LEGACY_PATH(legacy_dirpath, RHIZOME_BLOB_SUBDIR)
&& file_exists(legacy_dirpath))
erename_info(legacy_dirpath, blobpath);
if ( !file_exists(hashpath)
&& FORMF_RHIZOME_STORE_LEGACY_PATH(legacy_dirpath, RHIZOME_HASH_SUBDIR)
&& file_exists(legacy_dirpath))
erename_info(legacy_dirpath, hashpath);
}
else
INFOF("Creating Rhizome SQLite database: %s", dbpath);
}
// Create missing sub-directories.
if ( emkdirs_info(blobpath, 0700) == -1
|| emkdirs_info(hashpath, 0700) == -1
|| emkdirs_info(temppath, 0700) == -1)
RETURN(-1);
// Inform SQLite of its temporary directory.
assert(!sqlite3_temp_directory);
sqlite3_temp_directory = sqlite3_mprintf("%s", temppath);
// Set up SQLite logging.
sqlite3_config(SQLITE_CONFIG_LOG, sqlite_log, NULL);
// Open the SQLite database file, creating it if necessary.
if (sqlite3_open(dbpath, &rhizome_database.db)){
RETURN(WHYF("SQLite could not open database %s: %s", dbpath, sqlite3_errmsg(rhizome_database.db)));
}
sqlite3_trace_v2(rhizome_database.db, SQLITE_TRACE_STMT, sqlite_trace_callback, NULL);
int loglevel = IF_DEBUG(rhizome) ? LOG_LEVEL_DEBUG : LOG_LEVEL_SILENT;
const char *env = getenv("SERVALD_rhizome_database.db_RETRY_LIMIT_MS");
rhizomeRetryLimit = env ? atoi(env) : -1;
/* Read Rhizome configuration */
DEBUGF(rhizome, "Rhizome will use %"PRIu64"B of storage for its database.", (uint64_t) config.rhizome.database_size);
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
uint64_t version;
if (sqlite_exec_uint64_retry(&retry, &version, "PRAGMA user_version;", END) != SQLITE_ROW)
RETURN(-1);
if (version<1){
/* Create tables as required */
// Note that this will create the current schema
// further additional columns should be skipped.
sqlite_exec_void_loglevel(loglevel, "PRAGMA auto_vacuum=2;", END);
if ( sqlite_exec_void_retry(&retry,
"CREATE TABLE IF NOT EXISTS MANIFESTS("
"id text not null primary key, "
"version integer, "
"inserttime integer, "
"filesize integer, "
"filehash text, "
"author text, "
"bar blob, "
"manifest blob, "
"service text, "
"name text, "
"sender text collate nocase, "
"recipient text collate nocase, "
"tail integer, "
"manifest_hash text collate nocase"
");", END) == -1
|| sqlite_exec_void_retry(&retry,
"CREATE TABLE IF NOT EXISTS FILES("
"id text not null primary key, "
"length integer, "
"datavalid integer, "
"inserttime integer, "
"last_verified integer"
");", END) == -1
|| sqlite_exec_void_retry(&retry,
"CREATE TABLE IF NOT EXISTS FILEBLOBS("
"id text not null primary key, "
"data blob"
");", END) == -1
|| sqlite_exec_void_retry(&retry,
"CREATE TABLE IF NOT EXISTS IDENTITY("
"uuid text not null"
"); ", END) == -1
) {
RETURN(WHY("Failed to create schema"));
}
/* Create indexes if they don't already exist */
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "CREATE INDEX IF NOT EXISTS bundlesizeindex ON manifests (filesize);", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "CREATE INDEX IF NOT EXISTS IDX_MANIFESTS_HASH ON MANIFESTS(filehash);", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "PRAGMA user_version=1;", END);
}
if (version<2 && db_exists){
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "ALTER TABLE MANIFESTS ADD COLUMN service text;", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "ALTER TABLE MANIFESTS ADD COLUMN name text;", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "ALTER TABLE MANIFESTS ADD COLUMN sender text collate nocase;", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "ALTER TABLE MANIFESTS ADD COLUMN recipient text collate nocase;", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "PRAGMA user_version=2;", END);
}
if (version<3){
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "CREATE INDEX IF NOT EXISTS IDX_MANIFESTS_ID_VERSION ON MANIFESTS(id, version);", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "PRAGMA user_version=3;", END);
}
if (version<4 && db_exists){
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "ALTER TABLE MANIFESTS ADD COLUMN tail integer;", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "PRAGMA user_version=4;", END);
}
if (version<5 && db_exists){
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "CREATE TABLE IF NOT EXISTS IDENTITY(uuid text not null); ", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "PRAGMA user_version=5;", END);
}
if (version<6 && db_exists){
// we've always been at war with eurasia
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "DROP TABLE IF EXISTS GROUPLIST; ", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "DROP TABLE IF EXISTS GROUPMEMBERSHIPS; ", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "DROP TABLE IF EXISTS VERIFICATIONS; ", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "DROP TABLE IF EXISTS FILEMANIFESTS;", END);
}
if (version<7 && db_exists){
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "ALTER TABLE FILES ADD COLUMN last_verified integer;", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "PRAGMA user_version=7;", END);
}
if (version<8){
if (db_exists)
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "ALTER TABLE MANIFESTS ADD COLUMN manifest_hash text collate nocase;", END);
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "CREATE INDEX IF NOT EXISTS IDX_MANIFEST_HASH ON MANIFESTS(manifest_hash);", END);
// we need to populate fields on upgrade from older versions, we can simply re-insert all old manifests
// if more bundle verification is required in later upgrades, move this to the end, don't run it more than once.
verify_bundles();
sqlite_exec_void_loglevel(LOG_LEVEL_WARN, "PRAGMA user_version=8;", END);
}
// TODO recreate tables with collate nocase on all hex columns
/* Future schema updates should be performed here.
The above schema can be assumed to exist, no matter which version we upgraded from.
All changes should attempt to preserve all existing interesting data */
char buf[SERVAL_UUID_STRLEN + 1];
int r = sqlite_exec_strbuf_retry(&retry, strbuf_local_buf(buf), "SELECT uuid from IDENTITY LIMIT 1;", END);
if (r == -1)
RETURN(-1);
if (r) {
if (!str_to_serval_uuid(buf, &rhizome_database.uuid, NULL)) {
WHYF("IDENTITY table contains malformed UUID %s -- overwriting", alloca_str_toprint(buf));
if (serval_uuid_generate_random(&rhizome_database.uuid) == -1)
RETURN(WHY("Cannot generate new UUID for Rhizome database"));
if (sqlite_exec_void_retry(&retry, "UPDATE IDENTITY SET uuid = ? LIMIT 1;", SERVAL_UUID_T, &rhizome_database.uuid, END) == -1)
RETURN(WHY("Failed to update new UUID in Rhizome database"));
DEBUGF(rhizome, "Updated Rhizome database UUID to %s", alloca_uuid_str(rhizome_database.uuid));
}
} else if (r == 0) {
if (serval_uuid_generate_random(&rhizome_database.uuid) == -1)
RETURN(WHY("Cannot generate UUID for Rhizome database"));
if (sqlite_exec_void_retry(&retry, "INSERT INTO IDENTITY (uuid) VALUES (?);", SERVAL_UUID_T, &rhizome_database.uuid, END) == -1)
RETURN(WHY("Failed to insert UUID into Rhizome database"));
DEBUGF(rhizome, "Set Rhizome database UUID to %s", alloca_uuid_str(rhizome_database.uuid));
}
// We can't delete a file that is being transferred in another process at this very moment...
if (config.rhizome.clean_on_open)
rhizome_cleanup(NULL);
if (serverMode != SERVER_NOT_RUNNING) {
sqlite_exec_uint64_retry(&retry, &max_rowid,
"SELECT max(rowid) "
"FROM manifests", END);
}
INFOF("Opened Rhizome database %s, UUID=%s", dbpath, alloca_uuid_str(rhizome_database.uuid));
RETURN(0);
OUT();
}
int rhizome_close_db()
{
IN();
if (rhizome_database.db) {
rhizome_cache_close();
if (!sqlite3_get_autocommit(rhizome_database.db)){
WHY("Uncommitted transaction!");
sqlite_exec_void("ROLLBACK;", END);
}
sqlite3_stmt *stmt = NULL;
while ((stmt = sqlite3_next_stmt(rhizome_database.db, stmt))) {
const char *sql = sqlite3_sql(stmt);
WARNF("closing Rhizome db with unfinalised statement: %s", sql ? sql : "BLOB");
}
int r = sqlite3_close(rhizome_database.db);
if (r != SQLITE_OK)
RETURN(WHYF("Failed to close sqlite database, %s",sqlite3_errmsg(rhizome_database.db)));
rhizome_database.db = NULL;
assert(sqlite3_temp_directory);
sqlite3_free(sqlite3_temp_directory);
sqlite3_temp_directory = NULL;
}
RETURN(0);
OUT();
}
/* Close the Rhizome database after every CLI command.
*/
static void rhizome_on_cmd_cleanup();
DEFINE_TRIGGER(cmd_cleanup, rhizome_on_cmd_cleanup);
static void rhizome_on_cmd_cleanup()
{
rhizome_close_db();
}
/* SQL query retry logic.
The common retry-on-busy logic is factored into this function. This logic encapsulates the
maximum time (timeout) that the caller may wait for a lock to be released and the sleep interval
while waiting. The way to use it is this:
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
do ret = some_sqlite_operation(...);
while (is_busy(ret) && sqlite_retry(&retry, "some_sqlite_operation"));
if (is_error(ret) || is_busy(ret))
return -1; // an error has already been logged
sqlite_retry_done(&retry, "some_sqlite_operation");
...
If the database is currently locked for updates, then some_sqlite_operation() will return a code
indicating busy (which is distinguishable from the codes for success or any other error).
sqlite_retry() will then log a DEBUG or INFO message, sleep for a short period and return true if
the timeout has not been reached. It keeps this information in the 'retry' variable, which must
be initialised as shown. As long as the timeout has not been reached, sqlite_retry() will keep
sleeping and returning true. If the timeout is reached, then sqlite_retry() will log an error
and return false. If the operation is successful, sqlite_retry_done() must be called to log the
success as a DEBUG or INFO message to provide closure to the prior messages already logged by
sqlite_retry() and to reset the 'retry' variable for re-use.
The timeout and sleep interval depend on whether the caller is the servald server process or not.
See the definition of the SQLITE_RETRY_STATE_DEFAULT macro for the default settings.
A single 'retry' variable may be initialised once then used for a succession of database
operations. If invoked by the server process, then the timeout timer will not be reset by
sqlite_retry() or sqlite_retry_done(), so that the timeout limit will apply to the cumulative
latency, not just to each individual query, which could potentially add up to much greater
latency than desired. However, in non-server processes, each query may be allowed its own
timeout, giving a greater chance of success at the expense of potentially greater latency.
*/
/* In the servald server process, by default we retry every 10 ms for up to 50 ms, so as to not
introduce too much latency into server responsiveness. In other processes (eg, Batphone MeshMS
thread), by default we allow busy retries to go for over a second, waiting 100 ms between each
retry.
*/
sqlite_retry_state sqlite_retry_state_init(int serverLimit, int serverSleep, int otherLimit, int otherSleep)
{
return (sqlite_retry_state){
.limit = rhizomeRetryLimit >= 0 ? rhizomeRetryLimit :
serverMode != SERVER_NOT_RUNNING ? (serverLimit < 0 ? 50 : serverLimit)
: (otherLimit < 0 ? 5000 : otherLimit),
.sleep = serverMode != SERVER_NOT_RUNNING ? (serverSleep < 0 ? 10 : serverSleep)
: (otherSleep < 0 ? 100 : otherSleep),
.elapsed = 0,
.start = -1,
.busytries = 0
};
}
int _sqlite_retry(struct __sourceloc __whence, sqlite_retry_state *retry, const char *action)
{
time_ms_t now = gettime_ms();
++retry->busytries;
if (retry->start == -1)
retry->start = now;
retry->elapsed = now - retry->start;
INFOF("%s on try %u after %.3f seconds (limit %.3f): %s",
sqlite3_errmsg(rhizome_database.db),
retry->busytries,
(retry->elapsed) / 1e3,
(retry->limit) / 1e3,
action
);
if (retry->elapsed >= retry->limit) {
// reset ready for next query
retry->busytries = 0;
if (serverMode == SERVER_NOT_RUNNING)
retry->start = -1;
return 0; // tell caller to stop trying
}
if (retry->sleep)
sleep_ms(retry->sleep);
return 1; // tell caller to try again
}
void _sqlite_retry_done(struct __sourceloc __whence, sqlite_retry_state *retry, const char *action)
{
if (retry->busytries) {
time_ms_t now = gettime_ms();
INFOF("succeeded on try %u after %.3f seconds (limit %.3f): %s",
retry->busytries + 1,
(now - retry->start) / 1e3,
(retry->limit) / 1e3,
action
);
}
// reset ready for next query
retry->busytries = 0;
if (serverMode == SERVER_NOT_RUNNING)
retry->start = -1;
}
/* Prepare an SQL command from a simple string. Returns NULL if an error occurs (logged as an
* error), otherwise returns a pointer to the prepared SQLite statement.
*
* IMPORTANT! Do not form statement strings using sprintf(3) or strbuf_sprintf() or similar
* methods, because those are susceptible to SQL injection attacks. Instead, use bound parameters
* and bind them using the _sqlite_bind() function below.
*
* IMPORTANT! Do not add sprintf(3)-like functionality to this method. It used to take
* sprintf(3)-style varargs and these were deliberately removed. It is vital to discourage bad
* practice, and adding sprintf(3)-style args to this function would be a step in the wrong
* direction.
*
* See GitHub issue #69.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
sqlite3_stmt *_sqlite_prepare(struct __sourceloc __whence, int log_level, sqlite_retry_state *retry, const char *sqltext)
{
IN();
sqlite3_stmt *statement = NULL;
assert(rhizome_database.db);
while (1) {
switch (sqlite3_prepare_v2(rhizome_database.db, sqltext, -1, &statement, NULL)) {
case SQLITE_OK:
sqlite_trace_done = 0;
RETURN(statement);
case SQLITE_BUSY:
case SQLITE_LOCKED:
if (retry && _sqlite_retry(__whence, retry, sqltext)) {
break; // back to sqlite3_prepare_v2()
}
// fall through...
default:
LOGF(log_level, "query invalid, %s: %s", sqlite3_errmsg(rhizome_database.db), sqltext);
sqlite3_finalize(statement);
RETURN(NULL);
}
}
}
/* Bind some parameters to a prepared SQL statement. Returns -1 if an error occurs (logged as an
* error), otherwise zero with the prepared statement in *statement.
*
* Developed as part of GitHub issue #69.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int _sqlite_vbind(struct __sourceloc __whence, int log_level, sqlite_retry_state *retry, sqlite3_stmt *statement, va_list ap)
{
const int index_limit = sqlite3_limit(rhizome_database.db, SQLITE_LIMIT_VARIABLE_NUMBER, -1);
unsigned argnum = 0;
int index_counter = 0;
enum sqlbind_type typ;
while ((typ = va_arg(ap, int)) != END) {
++argnum;
int index;
const char *name = NULL;
strbuf ext = NULL;
if (typ & INDEX) {
typ &= ~INDEX;
index = va_arg(ap, int);
++argnum;
if (index < 1 || index > index_limit) {
LOGF(log_level, "at bind arg %u, illegal index=%d: %s", argnum, index, sqlite3_sql(statement));
return -1;
}
if (IF_DEBUG(rhizome))
strbuf_sprintf((ext = strbuf_alloca(35)), "|INDEX(%d)", index);
} else if (typ & NAMED) {
typ &= ~NAMED;
name = va_arg(ap, const char *);
++argnum;
index = sqlite3_bind_parameter_index(statement, name);
if (index == 0) {
LOGF(log_level, "at bind arg %u, no parameter named %s in query: %s", argnum, alloca_str_toprint(name), sqlite3_sql(statement));
return -1;
}
if (IF_DEBUG(rhizome)) {
ext = strbuf_alloca(30 + toprint_str_len(name, "\"\""));
strbuf_puts(ext, "|NAMED(");
strbuf_toprint_quoted(ext, "\"\"", name);
strbuf_puts(ext, ")");
}
} else {
index = ++index_counter;
if (IF_DEBUG(rhizome))
ext = strbuf_alloca(10);
}
#define BIND_DEBUG(TYP,FUNC,ARGFMT,...) \
DEBUGF(rhizome_sql_bind, "%s%s %s(%d," ARGFMT ") %s", #TYP, strbuf_str(ext), #FUNC, index, ##__VA_ARGS__, sqlite3_sql(statement))
#define BIND_RETRY(FUNC, ...) \
do { \
switch (FUNC(statement, index, ##__VA_ARGS__)) { \
case SQLITE_OK: \
break; \
case SQLITE_BUSY: \
case SQLITE_LOCKED: \
if (retry && _sqlite_retry(__whence, retry, #FUNC "()")) \
continue; \
FALLTHROUGH; \
default: \
LOGF(log_level, #FUNC "(%d) failed, %s: %s", index, sqlite3_errmsg(rhizome_database.db), sqlite3_sql(statement)); \
sqlite3_finalize(statement); \
return -1; \
} \
break; \
} while (1)
#define BIND_NULL(TYP) \
if (typ & NUL) { \
BIND_DEBUG(TYP, sqlite3_bind_null, ""); \
BIND_RETRY(sqlite3_bind_null); \
} else { \
LOGF(log_level, "at bind arg %u, %s%s parameter is NULL: %s", argnum, #TYP, strbuf_str(ext), sqlite3_sql(statement)); \
sqlite3_finalize(statement); \
return -1; \
}
switch (typ) {
case NUL:
BIND_DEBUG(NUL, sqlite3_bind_null, "");
BIND_RETRY(sqlite3_bind_null);
break;
default:
if ((typ & NUL) && IF_DEBUG(rhizome))
strbuf_puts(ext, "|NUL");
switch (typ & ~NUL) {
case INT: {
int value = va_arg(ap, int);
++argnum;
BIND_DEBUG(INT, sqlite3_bind_int, "%d", value);
BIND_RETRY(sqlite3_bind_int, value);
}
break;
case INT_TOSTR: {
int value = va_arg(ap, int);
++argnum;
char str[25];
sprintf(str, "%d", value);
BIND_DEBUG(INT_TOSTR, sqlite3_bind_text, "%s,-1,SQLITE_TRANSIENT", alloca_str_toprint(str));
BIND_RETRY(sqlite3_bind_text, str, -1, SQLITE_TRANSIENT);
}
break;
case UINT_TOSTR: {
unsigned value = va_arg(ap, unsigned);
++argnum;
char str[25];
sprintf(str, "%u", value);
BIND_DEBUG(UINT_TOSTR, sqlite3_bind_text, "%s,-1,SQLITE_TRANSIENT", alloca_str_toprint(str));
BIND_RETRY(sqlite3_bind_text, str, -1, SQLITE_TRANSIENT);
}
break;
case INT64: {
sqlite3_int64 value = va_arg(ap, int64_t);
BIND_DEBUG(INT64, sqlite3_bind_int64, "%"PRId64, (int64_t)value);
BIND_RETRY(sqlite3_bind_int64, value);
}
break;
case INT64_TOSTR: {
int64_t value = va_arg(ap, int64_t);
++argnum;
char str[35];
sprintf(str, "%"PRId64, value);
BIND_DEBUG(INT64_TOSTR, sqlite3_bind_text, "%s,-1,SQLITE_TRANSIENT", alloca_str_toprint(str));
BIND_RETRY(sqlite3_bind_text, str, -1, SQLITE_TRANSIENT);
}
break;
case UINT64_TOSTR: {
uint64_t value = va_arg(ap, uint64_t);
++argnum;
char str[35];
sprintf(str, "%"PRIu64, value);
BIND_DEBUG(UINT64_TOSTR, sqlite3_bind_text, "%s,-1,SQLITE_TRANSIENT", alloca_str_toprint(str));
BIND_RETRY(sqlite3_bind_text, str, -1, SQLITE_TRANSIENT);
}
break;
case TEXT: {
const char *text = va_arg(ap, const char *);
++argnum;
if (text == NULL) {
BIND_NULL(TEXT);
} else {
BIND_DEBUG(TEXT, sqlite3_bind_text, "%s,-1,SQLITE_TRANSIENT", alloca_str_toprint(text));
BIND_RETRY(sqlite3_bind_text, text, -1, SQLITE_TRANSIENT);
}
}
break;
case TEXT_LEN: {
const char *text = va_arg(ap, const char *);
int bytes = va_arg(ap, int);
argnum += 2;
if (text == NULL) {
BIND_NULL(TEXT_LEN);
} else {
BIND_DEBUG(TEXT_LEN, sqlite3_bind_text, "%s,%d,SQLITE_TRANSIENT", alloca_str_toprint(text), bytes);
BIND_RETRY(sqlite3_bind_text, text, bytes, SQLITE_TRANSIENT);
}
}
break;
case STATIC_TEXT: {
const char *text = va_arg(ap, const char *);
++argnum;
if (text == NULL) {
BIND_NULL(STATIC_TEXT);
} else {
BIND_DEBUG(STATIC_TEXT, sqlite3_bind_text, "%s,-1,SQLITE_STATIC", alloca_str_toprint(text));
BIND_RETRY(sqlite3_bind_text, text, -1, SQLITE_STATIC);
}
}
break;
case STATIC_TEXT_LEN: {
const char *text = va_arg(ap, const char *);
int bytes = va_arg(ap, int);
argnum += 2;
if (text == NULL) {
BIND_NULL(STATIC_TEXT_LEN);
} else {
BIND_DEBUG(STATIC_TEXT_LEN, sqlite3_bind_text, "%s,%d,SQLITE_STATIC", alloca_str_toprint(text), bytes);
BIND_RETRY(sqlite3_bind_text, text, bytes, SQLITE_STATIC);
}
}
break;
case STATIC_BLOB: {
const void *blob = va_arg(ap, const void *);
int bytes = va_arg(ap, int);
argnum += 2;
if (blob == NULL) {
BIND_NULL(STATIC_BLOB);
} else {
BIND_DEBUG(STATIC_BLOB, sqlite3_bind_blob, "%s,%d,SQLITE_STATIC", alloca_toprint(20, blob, bytes), bytes);
BIND_RETRY(sqlite3_bind_blob, blob, bytes, SQLITE_STATIC);
}
};
break;
case ZEROBLOB: {
int bytes = va_arg(ap, int);
++argnum;
BIND_DEBUG(ZEROBLOB, sqlite3_bind_zeroblob, "%d,SQLITE_STATIC", bytes);
BIND_RETRY(sqlite3_bind_zeroblob, bytes);
};
break;
case SID_T: {
const sid_t *sidp = va_arg(ap, const sid_t *);
++argnum;
if (sidp == NULL) {
BIND_NULL(SID_T);
} else {
const char *sid_hex = alloca_tohex_sid_t(*sidp);
BIND_DEBUG(SID_T, sqlite3_bind_text, "%s,%u,SQLITE_TRANSIENT", sid_hex, SID_STRLEN);
BIND_RETRY(sqlite3_bind_text, sid_hex, SID_STRLEN, SQLITE_TRANSIENT);
}
}
break;
case RHIZOME_BID_T: {
const rhizome_bid_t *bidp = va_arg(ap, const rhizome_bid_t *);
++argnum;
if (bidp == NULL) {
BIND_NULL(RHIZOME_BID_T);
} else {
const char *bid_hex = alloca_tohex_rhizome_bid_t(*bidp);
BIND_DEBUG(RHIZOME_BID_T, sqlite3_bind_text, "%s,%u,SQLITE_TRANSIENT", bid_hex, RHIZOME_MANIFEST_ID_STRLEN);
BIND_RETRY(sqlite3_bind_text, bid_hex, RHIZOME_MANIFEST_ID_STRLEN, SQLITE_TRANSIENT);
}
}
break;
case RHIZOME_BAR_T: {
const rhizome_bar_t *barp = va_arg(ap, const rhizome_bar_t *);
++argnum;
if (barp == NULL) {
BIND_NULL(RHIZOME_BAR_T);
} else {
BIND_DEBUG(STATIC_BLOB, sqlite3_bind_blob, "%s,%d,SQLITE_STATIC", alloca_toprint(20, barp->binary, RHIZOME_BAR_BYTES), RHIZOME_BAR_BYTES);
BIND_RETRY(sqlite3_bind_blob, barp->binary, RHIZOME_BAR_BYTES, SQLITE_STATIC);
}
}
break;
case RHIZOME_FILEHASH_T: {
const rhizome_filehash_t *hashp = va_arg(ap, const rhizome_filehash_t *);
++argnum;
if (hashp == NULL) {
BIND_NULL(RHIZOME_FILEHASH_T);
} else {
char hash_hex[RHIZOME_FILEHASH_STRLEN + 1];
tohex(hash_hex, RHIZOME_FILEHASH_STRLEN, hashp->binary);
BIND_DEBUG(RHIZOME_FILEHASH_T, sqlite3_bind_text, "%s,%u,SQLITE_TRANSIENT", hash_hex, RHIZOME_FILEHASH_STRLEN);
BIND_RETRY(sqlite3_bind_text, hash_hex, RHIZOME_FILEHASH_STRLEN, SQLITE_TRANSIENT);
}
}
break;
case TOHEX: {
const unsigned char *binary = va_arg(ap, const unsigned char *);
unsigned bytes = va_arg(ap, unsigned);
argnum += 2;
if (binary == NULL) {
BIND_NULL(TOHEX);
} else {
const char *hex = alloca_tohex(binary, bytes);
BIND_DEBUG(TOHEX, sqlite3_bind_text, "%s,%u,SQLITE_TRANSIENT", hex, bytes * 2);
BIND_RETRY(sqlite3_bind_text, hex, bytes * 2, SQLITE_TRANSIENT);
}
}
break;
case TEXT_TOUPPER: {
const char *text = va_arg(ap, const char *);
++argnum;
if (text == NULL) {
BIND_NULL(TEXT_TOUPPER);
} else {
unsigned bytes = strlen(text);
char upper[bytes + 1];
str_toupper_inplace(strcpy(upper, text));
BIND_DEBUG(TEXT_TOUPPER, sqlite3_bind_text, "%s,%u,SQLITE_TRANSIENT", alloca_toprint(-1, upper, bytes), bytes);
BIND_RETRY(sqlite3_bind_text, upper, bytes, SQLITE_TRANSIENT);
}
}
break;
case TEXT_LEN_TOUPPER: {
const char *text = va_arg(ap, const char *);
unsigned bytes = va_arg(ap, unsigned);
argnum += 2;
if (text == NULL) {
BIND_NULL(TEXT);
} else {
char upper[bytes];
unsigned i;
for (i = 0; i != bytes; ++i)
upper[i] = toupper(text[i]);
BIND_DEBUG(TEXT_LEN_TOUPPER, sqlite3_bind_text, "%s,%u,SQLITE_TRANSIENT", alloca_toprint(-1, upper, bytes), bytes);
BIND_RETRY(sqlite3_bind_text, upper, bytes, SQLITE_TRANSIENT);
}
}
break;
case SERVAL_UUID_T: {
const serval_uuid_t *uuidp = va_arg(ap, const serval_uuid_t *);
++argnum;
if (uuidp == NULL) {
BIND_NULL(SERVAL_UUID_T);
} else {
char uuid_str[SERVAL_UUID_STRLEN + 1];
serval_uuid_to_str(uuidp, uuid_str);
BIND_DEBUG(SERVAL_UUID_T, sqlite3_bind_text, "%s,%u,SQLITE_TRANSIENT", uuid_str, SERVAL_UUID_STRLEN);
BIND_RETRY(sqlite3_bind_text, uuid_str, SERVAL_UUID_STRLEN, SQLITE_TRANSIENT);
}
}
break;
#undef BIND_RETRY
default:
FATALF("at bind arg %u, unsupported bind code typ=0x%08x: %s", argnum, typ, sqlite3_sql(statement));
}
break;
}
}
return 0;
}
int _sqlite_bind(struct __sourceloc __whence, int log_level, sqlite_retry_state *retry, sqlite3_stmt *statement, ...)
{
va_list ap;
va_start(ap, statement);
int ret = _sqlite_vbind(__whence, log_level, retry, statement, ap);
va_end(ap);
return ret;
}
/* Prepare an SQL statement and bind some parameters. Returns a pointer to the SQLite statement if
* successful or NULL if an error occurs (which is logged at the given log level).
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
sqlite3_stmt *_sqlite_prepare_bind(struct __sourceloc __whence, int log_level, sqlite_retry_state *retry, const char *sqltext, ...)
{
sqlite3_stmt *statement = _sqlite_prepare(__whence, log_level, retry, sqltext);
if (statement != NULL) {
va_list ap;
va_start(ap, sqltext);
int ret = _sqlite_vbind(__whence, log_level, retry, statement, ap);
va_end(ap);
if (ret == -1) {
sqlite3_finalize(statement);
statement = NULL;
}
}
return statement;
}
int _sqlite_step(struct __sourceloc __whence, int log_level, sqlite_retry_state *retry, sqlite3_stmt *statement)
{
IN();
int ret = -1;
sqlite_trace_whence = &__whence;
while (statement) {
ret = sqlite3_step(statement);
switch (ret) {
case SQLITE_OK:
case SQLITE_DONE:
case SQLITE_ROW:
if (retry)
_sqlite_retry_done(__whence, retry, sqlite3_sql(statement));
statement = NULL;
break;
case SQLITE_BUSY:
case SQLITE_LOCKED:
if (retry && _sqlite_retry(__whence, retry, sqlite3_sql(statement))) {
sqlite3_reset(statement);
break; // back to sqlite3_step()
}
// fall through...
default:
LOGF(log_level, "query failed (%d), %s: %s", ret, sqlite3_errmsg(rhizome_database.db), sqlite3_sql(statement));
statement = NULL;
break;
}
}
sqlite_trace_whence = NULL;
OUT();
return ret;
}
int _sqlite_exec_code(struct __sourceloc __whence, int log_level, sqlite_retry_state *retry, sqlite3_stmt *statement, int *rowcount)
{
*rowcount = 0;
if (!statement)
return SQLITE_ERROR;
int stepcode;
while ((stepcode = _sqlite_step(__whence, log_level, retry, statement)) == SQLITE_ROW)
++(*rowcount);
sqlite3_finalize(statement);
if (sqlite_trace_func())
_DEBUGF("rowcount=%d changes=%d", *rowcount, sqlite3_changes(rhizome_database.db));
return stepcode;
}
/*
* Convenience wrapper for executing a prepared SQL statement where the row outputs are not wanted.
* Always finalises the statement before returning.
*
* If an error occurs then logs it at the given level and returns -1.
*
* If 'retry' is non-NULL and the BUSY error occurs (indicating the database is locked, ie,
* currently in use by another process), then resets the statement and retries while sqlite_retry()
* returns true. If sqlite_retry() returns false then returns -1.
*
* Otherwise returns the number of rows (SQLITE_ROW) results, which will be zero if the first result
* was SQLITE_OK or SQLITE_DONE.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int _sqlite_exec(struct __sourceloc __whence, int log_level, sqlite_retry_state *retry, sqlite3_stmt *statement)
{
int rowcount;
int stepcode = _sqlite_exec_code(__whence, log_level, retry, statement, &rowcount);
return sqlite_code_ok(stepcode) ? rowcount : -1;
}
static int _sqlite_vexec_void_code(struct __sourceloc __whence, int log_level, sqlite_retry_state *retry, int *rowcount, int *changes, const char *sqltext, va_list ap)
{
*changes=0;
*rowcount=0;
sqlite3_stmt *statement = _sqlite_prepare(__whence, log_level, retry, sqltext);
if (!statement)
return SQLITE_ERROR;
if (_sqlite_vbind(__whence, log_level, retry, statement, ap) == -1)
return SQLITE_ERROR;
int stepcode = _sqlite_exec_code(__whence, log_level, retry, statement, rowcount);
if (sqlite_code_ok(stepcode)){
*changes = sqlite3_changes(rhizome_database.db);
}
return stepcode;
}
/* Convenience wrapper for executing an SQL command that returns no value. If an error occurs then
* logs it at ERROR level and returns -1. Otherwise returns the number of rows changed by the
* command.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int _sqlite_exec_void(struct __sourceloc __whence, int log_level, const char *sqltext, ...)
{
int rowcount, changes;
va_list ap;
va_start(ap, sqltext);
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
int stepcode = _sqlite_vexec_void_code(__whence, log_level, &retry, &rowcount, &changes, sqltext, ap);
va_end(ap);
if (!sqlite_code_ok(stepcode))
return -1;
if (rowcount)
WARNF("void query unexpectedly returned %d row%s", rowcount, rowcount == 1 ? "" : "s");
return changes;
}
/* Same as sqlite_exec_void() but if the statement cannot be executed because the database is
* currently locked for updates, then will call sqlite_retry() on the supplied retry state variable
* instead of its own, internal one. If 'retry' is passed as NULL, then will not sleep and retry at
* all in the event of a busy condition, but will log it as an error and return immediately.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int _sqlite_exec_void_retry(struct __sourceloc __whence, int log_level, sqlite_retry_state *retry, const char *sqltext, ...)
{
int rowcount, changes;
va_list ap;
va_start(ap, sqltext);
int stepcode = _sqlite_vexec_void_code(__whence, log_level, retry, &rowcount, &changes, sqltext, ap);
va_end(ap);
if (!sqlite_code_ok(stepcode))
return -1;
if (rowcount)
WARNF("void query unexpectedly returned %d row%s", rowcount, rowcount == 1 ? "" : "s");
return changes;
}
int _sqlite_exec_changes_retry(struct __sourceloc __whence, int log_level, sqlite_retry_state *retry, int *rowcount, int *changes, const char *sqltext, ...)
{
va_list ap;
va_start(ap, sqltext);
int stepcode = _sqlite_vexec_void_code(__whence, log_level, retry, rowcount, changes, sqltext, ap);
va_end(ap);
return stepcode;
}
static int _sqlite_vexec_uint64(struct __sourceloc __whence, sqlite_retry_state *retry, uint64_t *result, const char *sqltext, va_list ap)
{
sqlite3_stmt *statement = _sqlite_prepare(__whence, LOG_LEVEL_ERROR, retry, sqltext);
if (!statement)
return -1;
if (_sqlite_vbind(__whence, LOG_LEVEL_ERROR, retry, statement, ap) == -1)
return -1;
int rows = 0;
int stepcode;
while ((stepcode = _sqlite_step(__whence, LOG_LEVEL_ERROR, retry, statement)) == SQLITE_ROW) {
int columncount = sqlite3_column_count(statement);
if (columncount != 1)
FATALF("incorrect column count %d (should be 1): %s", columncount, sqlite3_sql(statement));
else if (++rows == 1)
*result = sqlite3_column_int64(statement, 0);
}
if (rows > 1)
FATALF("query unexpectedly returned %d rows", rows);
sqlite3_finalize(statement);
if (sqlite_trace_func())
_DEBUGF("rowcount=%d changes=%d result=%"PRIu64, rows, sqlite3_changes(rhizome_database.db), *result);
if (sqlite_code_ok(stepcode) && rows>0)
return SQLITE_ROW;
return stepcode;
}
/*
* Convenience wrapper for executing an SQL command that returns a single int64 value.
* Logs an error and returns -1 if an error occurs.
* If no row is found, then returns SQLITE_OK / SQLITE_DONE and does not alter *result.
* If exactly one row is found, the assigns its value to *result and returns SQLITE_ROW.
* Otherwise an SQLITE_ stepcode will be returned
* If more than one row is found, or the query returns more that one column then this function asserts
*
* if the statement cannot be executed because the database is
* currently locked for updates, then will call sqlite_retry() on the supplied retry state variable
* instead of its own, internal one. If 'retry' is passed as NULL, then will not sleep and retry at
* all in the event of a busy condition, but will log it as an error and return immediately.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int _sqlite_exec_uint64_retry(struct __sourceloc __whence, sqlite_retry_state *retry, uint64_t *result, const char *sqlformat,...)
{
va_list ap;
va_start(ap, sqlformat);
int ret = _sqlite_vexec_uint64(__whence, retry, result, sqlformat, ap);
va_end(ap);
return ret;
}
/* Convenience wrapper for executing an SQL command that returns a single text value.
* Logs an error and returns -1 if an error occurs, otherwise the number of rows that were found:
* 0 means no rows, nothing is appended to the strbuf
* 1 means exactly one row, appends its column to the strbuf
* 2 more than one row, logs a warning and appends the first row's column to the strbuf
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int _sqlite_exec_strbuf(struct __sourceloc __whence, strbuf sb, const char *sqlformat,...)
{
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
va_list ap;
va_start(ap, sqlformat);
int ret = _sqlite_vexec_strbuf_retry(__whence, &retry, sb, sqlformat, ap);
va_end(ap);
return ret;
}
int _sqlite_exec_strbuf_retry(struct __sourceloc __whence, sqlite_retry_state *retry, strbuf sb, const char *sqlformat, ...)
{
va_list ap;
va_start(ap, sqlformat);
int ret = _sqlite_vexec_strbuf_retry(__whence, retry, sb, sqlformat, ap);
va_end(ap);
return ret;
}
int _sqlite_vexec_strbuf_retry(struct __sourceloc __whence, sqlite_retry_state *retry, strbuf sb, const char *sqltext, va_list ap)
{
sqlite3_stmt *statement = _sqlite_prepare(__whence, LOG_LEVEL_ERROR, retry, sqltext);
if (!statement)
return -1;
if (_sqlite_vbind(__whence, LOG_LEVEL_ERROR, retry, statement, ap) == -1)
return -1;
int ret = 0;
int rowcount = 0;
int stepcode;
while ((stepcode = _sqlite_step(__whence, LOG_LEVEL_ERROR, retry, statement)) == SQLITE_ROW) {
int columncount = sqlite3_column_count(statement);
if (columncount != 1)
ret = WHYF("incorrect column count %d (should be 1): %s", columncount, sqlite3_sql(statement));
else if (++rowcount == 1)
strbuf_puts(sb, (const char *)sqlite3_column_text(statement, 0));
}
if (rowcount > 1)
WARNF("query unexpectedly returned %d rows, ignored all but first", rowcount);
sqlite3_finalize(statement);
return sqlite_code_ok(stepcode) && ret != -1 ? rowcount : -1;
}
int _sqlite_blob_open_retry(
struct __sourceloc __whence,
int log_level,
sqlite_retry_state *retry,
const char *dbname,
const char *tablename,
const char *colname,
sqlite3_int64 rowid,
int flags,
sqlite3_blob **blobp
)
{
IN();
while (1) {
int code = sqlite3_blob_open(rhizome_database.db, dbname, tablename, colname, rowid, flags, blobp);
switch (code) {
case SQLITE_OK:
if (retry)
_sqlite_retry_done(__whence, retry, "sqlite3_blob_open()");
RETURN(code);
case SQLITE_DONE:
case SQLITE_ROW:
LOGF(log_level, "sqlite3_blob_open() returned unexpected code (%d)", code);
RETURN(-1);
case SQLITE_BUSY:
case SQLITE_LOCKED:
if (retry && _sqlite_retry(__whence, retry, "sqlite3_blob_open()"))
break; // back to sqlite3_blob_open()
// fall through...
default:
LOGF(log_level, "sqlite3_blob_open() failed (%d), %s", code, sqlite3_errmsg(rhizome_database.db));
RETURN(-1);
}
}
FATAL("not reached");
OUT();
}
int _sqlite_blob_write_retry(
struct __sourceloc __whence,
int log_level,
sqlite_retry_state *retry,
sqlite3_blob *blob,
const void *buf,
int len,
int offset
)
{
IN();
while (1) {
int code = sqlite3_blob_write(blob, buf, len, offset);
switch (code) {
case SQLITE_OK:
if (retry)
_sqlite_retry_done(__whence, retry, "sqlite3_blob_write()");
RETURN(code);
case SQLITE_DONE:
case SQLITE_ROW:
LOGF(log_level, "sqlite3_blob_write() returned unexpected code (%d)", code);
RETURN(-1);
case SQLITE_BUSY:
case SQLITE_LOCKED:
if (retry && _sqlite_retry(__whence, retry, "sqlite3_blob_write()"))
break; // back to sqlite3_blob_open()
// fall through...
default:
LOGF(log_level, "sqlite3_blob_write() failed (%d), %s", code, sqlite3_errmsg(rhizome_database.db));
RETURN(-1);
}
}
FATAL("not reached");
OUT();
}
int _sqlite_blob_close(struct __sourceloc __whence, int log_level, sqlite3_blob *blob)
{
int code = sqlite3_blob_close(blob);
if (code != SQLITE_OK)
LOGF(log_level, "sqlite3_blob_close() failed: %s", sqlite3_errmsg(rhizome_database.db));
return 0;
}
int rhizome_database_filehash_from_id(const rhizome_bid_t *bidp, uint64_t version, rhizome_filehash_t *hashp)
{
IN();
strbuf hash_sb = strbuf_alloca(RHIZOME_FILEHASH_STRLEN + 1);
int r = sqlite_exec_strbuf(hash_sb, "SELECT filehash FROM MANIFESTS WHERE version = ? AND id = ?;",
INT64, version, RHIZOME_BID_T, bidp, END);
if (r == -1)
RETURN(-1);
// this bundle / version was not found
if (r != 1)
RETURN(1);
if (strbuf_overrun(hash_sb) || str_to_rhizome_filehash_t(hashp, strbuf_str(hash_sb)) == -1)
RETURN(WHYF("malformed file hash (%s) for bid=%s version=%"PRIu64,
strbuf_str(hash_sb), alloca_tohex_rhizome_bid_t(*bidp), version));
RETURN(0);
OUT();
}
void rhizome_vacuum_db(sqlite_retry_state *retry){
sqlite3_stmt *statement = sqlite_prepare_bind(retry, "PRAGMA incremental_vacuum;", END);
if (!statement)
return;
sqlite_exec_retry(retry, statement);
}
int rhizome_cleanup(struct rhizome_cleanup_report *report)
{
IN();
if (IF_DEBUG(rhizome) && report == NULL)
report = alloca(sizeof *report);
if (report)
bzero(report, sizeof *report);
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
// make sure we are under our database size limit
rhizome_store_cleanup(report);
/* For testing, it helps to speed up the cleanup process. */
const char *orphan_payload_persist_ms = getenv("SERVALD_ORPHAN_PAYLOAD_PERSIST_MS");
time_ms_t now = gettime_ms();
time_ms_t insert_horizon_no_manifest = now - (orphan_payload_persist_ms ? atoi(orphan_payload_persist_ms) : 1000); // 1 second ago
// Remove external payload files for stale, incomplete payloads.
sqlite3_stmt *statement = sqlite_prepare_bind(&retry,
"SELECT id FROM FILES WHERE datavalid = 0;", END);
while (sqlite_step_retry(&retry, statement) == SQLITE_ROW) {
const char *id = (const char *) sqlite3_column_text(statement, 0);
rhizome_filehash_t filehash;
if (str_to_rhizome_filehash_t(&filehash, id) != -1
&& rhizome_delete_file(&filehash)==0 && report)
++report->deleted_stale_incoming_files;
}
sqlite3_finalize(statement);
// Remove external payload files for old, unreferenced payloads.
statement = sqlite_prepare_bind(&retry,
"SELECT id FROM FILES WHERE inserttime < ? AND NOT EXISTS( SELECT 1 FROM MANIFESTS WHERE MANIFESTS.filehash = FILES.id);",
INT64, insert_horizon_no_manifest, END);
while (sqlite_step_retry(&retry, statement) == SQLITE_ROW) {
const char *id = (const char *) sqlite3_column_text(statement, 0);
rhizome_filehash_t filehash;
if (str_to_rhizome_filehash_t(&filehash, id) != -1
&& rhizome_delete_file(&filehash)==0 && report)
++report->deleted_orphan_files;
}
sqlite3_finalize(statement);
// TODO Iterate through all files in RHIZOME_BLOB_SUBDIR and delete any which are no longer
// referenced or are stale. This could take a long time, so for scalability should be done
// in an incremental background task. See GitHub issue #50.
// Remove payload blobs that are no longer referenced.
int ret = sqlite_exec_void_retry(&retry,
"DELETE FROM FILEBLOBS WHERE NOT EXISTS( SELECT 1 FROM FILES WHERE FILES.id = FILEBLOBS.id );",
END);
if (ret > 0 && report)
report->deleted_orphan_fileblobs += ret;
// delete manifests that no longer have payload files
ret = sqlite_exec_void_retry(&retry,
"DELETE FROM MANIFESTS WHERE filesize > 0 AND NOT EXISTS( SELECT 1 FROM FILES WHERE MANIFESTS.filehash = FILES.id);", END);
if (report && ret > 0)
report->deleted_orphan_manifests += ret;
rhizome_vacuum_db(&retry);
if (report)
DEBUGF(rhizome, "report deleted_stale_incoming_files=%u deleted_orphan_files=%u deleted_orphan_fileblobs=%u deleted_orphan_manifests=%u",
report->deleted_stale_incoming_files,
report->deleted_orphan_files,
report->deleted_orphan_fileblobs,
report->deleted_orphan_manifests
);
RETURN(0);
OUT();
}
static void sync_rhizome(){
if (server_pid()<=0)
return;
/* Bind to MDP socket and await confirmation */
struct mdp_header mdp_header = {
.remote.port = MDP_SYNC_RHIZOME,
};
int mdpsock = mdp_socket();
if (mdpsock == -1)
WARN("cannot create MDP socket");
set_nonblock(mdpsock);
int r = mdp_send(mdpsock, &mdp_header, NULL, 0);
if (r == -1)
goto end;
time_ms_t deadline = gettime_ms() + 10000; // TODO add --timeout option?
struct mdp_header rev_header;
do {
ssize_t len = mdp_poll_recv(mdpsock, deadline, &rev_header, NULL, 0);
if (len == -1){
r = -1;
goto end;
}
if (len == -2) {
WHYF("timeout while synchronising daemon bundle list");
r = -1;
goto end;
}
} while (!(rev_header.flags & MDP_FLAG_CLOSE));
r = 0;
end:
mdp_close(mdpsock);
}
/* Insert the manifest 'm' into the Rhizome store. This function encapsulates all the invariants
* that a manifest must satisfy before it is allowed into the store, so it is used by both the sync
* protocol and the application layer.
*
* - If the manifest is not valid then returns RHIZOME_BUNDLE_STATUS_INVALID. A valid manifest is
* one with all the core (transport) fields present and consistent ('id', 'version', 'filesize',
* 'filehash', 'tail'), all mandatory application fields present and consistent ('service',
* 'date') and any other service-dependent mandatory fields present (eg, 'sender', 'recipient').
*
* - If the manifest's signature does not verify, then returns RHIZOME_BUNDLE_STATUS_FAKE.
*
* - If the manifest has a payload (filesize != 0) but the payload is not present in the store
* (filehash), then returns an internal error RHIZOME_BUNDLE_STATUS_ERROR (-1).
*
* - If the store will not accept the manifest because there is already the same or a newer
* manifest in the store, then returns RHIZOME_BUNDLE_STATUS_SAME or RHIZOME_BUNDLE_STATUS_OLD.
*
* This function then attempts to store the manifest. If this fails due to an internal error,
* then returns RHIZOME_BUNDLE_STATUS_ERROR (-1), otherwise returns RHIZOME_BUNDLE_STATUS_NEW to
* indicate that the manifest was successfully stored.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
enum rhizome_bundle_status rhizome_add_manifest_to_store(rhizome_manifest *m, rhizome_manifest **mout)
{
if (mout == NULL)
DEBUGF(rhizome, "%s(m=manifest %p, mout=NULL)", __func__, m);
else
DEBUGF(rhizome, "%s(m=manifest %p, *mout=manifest %p)", __func__, m, *mout);
if (!m->finalised && !rhizome_manifest_validate(m))
return RHIZOME_BUNDLE_STATUS_INVALID;
assert(m->finalised);
if (!m->selfSigned && !rhizome_manifest_verify(m))
return RHIZOME_BUNDLE_STATUS_FAKE;
assert(m->filesize != RHIZOME_SIZE_UNSET);
if (m->filesize > 0){
switch (rhizome_exists(&m->filehash)){
case RHIZOME_PAYLOAD_STATUS_BUSY:
return RHIZOME_BUNDLE_STATUS_BUSY;
case RHIZOME_PAYLOAD_STATUS_STORED:
break;
default:
return WHY("Payload has not been stored");
}
}
enum rhizome_bundle_status status = rhizome_manifest_check_stored(m, mout);
if (status != RHIZOME_BUNDLE_STATUS_NEW)
return status;
if (mout && *mout){
if (m != *mout)
rhizome_manifest_free(*mout);
*mout = NULL;
}
// manifest is complete, and not already stored
/* Bind BAR to data field */
rhizome_bar_t bar;
rhizome_manifest_to_bar(m, &bar);
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
if (sqlite_exec_void_retry(&retry, "BEGIN TRANSACTION;", END) == -1)
return WHY("Failed to begin transaction");
time_ms_t now = gettime_ms();
// The INSERT OR REPLACE statement will delete a row with the same ID (primary key) if it exists,
// so a new autoincremented ROWID will be allocated whether or not the manifest with this ID is
// already in the table. Other code depends on this property: that ROWID is monotonically
// increasing with time and unique.
sqlite3_stmt *stmt;
if ((stmt = sqlite_prepare_bind(&retry,
"INSERT OR REPLACE INTO MANIFESTS("
"id,"
"manifest,"
"version,"
"inserttime,"
"bar,"
"filesize,"
"filehash,"
"author,"
"service,"
"name,"
"sender,"
"recipient,"
"tail,"
"manifest_hash"
") VALUES("
"?,?,?,?,?,?,?,?,?,?,?,?,?,?"
");",
RHIZOME_BID_T, &m->keypair.public_key,
STATIC_BLOB, m->manifestdata, m->manifest_all_bytes,
INT64, m->version,
INT64, (int64_t) now,
RHIZOME_BAR_T, &bar,
INT64, m->filesize,
RHIZOME_FILEHASH_T|NUL, m->filesize > 0 ? &m->filehash : NULL,
// Only store the author if it is known to be authentic.
SID_T|NUL, m->authorship == AUTHOR_AUTHENTIC ? &m->author : NULL,
STATIC_TEXT, m->service,
STATIC_TEXT|NUL, m->name,
SID_T|NUL, m->has_sender ? &m->sender : NULL,
SID_T|NUL, m->has_recipient ? &m->recipient : NULL,
INT64, m->tail,
RHIZOME_FILEHASH_T, &m->manifesthash,
END
)
) == NULL)
goto rollback;
if (!sqlite_code_ok(sqlite_step_retry(&retry, stmt)))
goto rollback;
sqlite3_finalize(stmt);
stmt = NULL;
rhizome_manifest_set_rowid(m, sqlite3_last_insert_rowid(rhizome_database.db));
rhizome_manifest_set_inserttime(m, now);
if (sqlite_exec_void_retry(&retry, "COMMIT;", END) != -1){
// This message used in tests; do not modify or remove.
INFOF("RHIZOME ADD MANIFEST service=%s bid=%s version=%"PRIu64,
m->service ? m->service : "NULL",
alloca_tohex_rhizome_bid_t(m->keypair.public_key),
m->version
);
if (serverMode != SERVER_NOT_RUNNING) {
assert(max_rowid < m->rowid);
// detect any bundles added by the CLI
// due to potential race conditions, we have to do this here
// even though the CLI will try to send us a MDP_SYNC_RHIZOME message
if (m->rowid > max_rowid+1)
rhizome_process_added_bundles(m->rowid);
max_rowid = m->rowid;
CALL_TRIGGER(bundle_add, m);
}else{
sync_rhizome();
}
if (mout)
*mout = m;
return RHIZOME_BUNDLE_STATUS_NEW;
}
rollback:
if (stmt)
sqlite3_finalize(stmt);
WHYF("Failed to store bundle bid=%s", alloca_tohex_rhizome_bid_t(m->keypair.public_key));
sqlite_exec_void_retry(&retry, "ROLLBACK;", END);
return RHIZOME_BUNDLE_STATUS_ERROR;
}
static void trigger_rhizome_bundle_added_debug(rhizome_manifest *m)
{
DEBUGF(rhizome, "TRIGGER rhizome_bundle_added service=%s bid=%s version=%"PRIu64,
m->service ? m->service : "NULL",
alloca_tohex_rhizome_bid_t(m->keypair.public_key),
m->version
);
}
DEFINE_TRIGGER(bundle_add, trigger_rhizome_bundle_added_debug);
/* The cursor struct must be zerofilled and the query parameters optionally filled in prior to
* calling this function.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int rhizome_list_open(struct rhizome_list_cursor *c)
{
DEBUGF(rhizome, "c=%p c->service=%s c->name=%s c->sender=%s c->recipient=%s c->rowid_since=%"PRIu64" c->oldest_first=%d c->_rowid_last=%"PRIu64,
c,
alloca_str_toprint(c->service),
alloca_str_toprint(c->name),
c->is_sender_set ? alloca_tohex_sid_t(c->sender) : "UNSET",
c->is_recipient_set ? alloca_tohex_sid_t(c->recipient) : "UNSET",
c->rowid_since,
c->oldest_first,
c->_rowid_last
);
IN();
strbuf b = strbuf_alloca(1024);
strbuf_sprintf(b, "SELECT id, manifest, version, inserttime, author, rowid FROM manifests WHERE 1=1");
if (c->service)
strbuf_puts(b, " AND service = @service");
if (c->name)
strbuf_puts(b, " AND name like @name");
if (c->is_sender_set)
strbuf_puts(b, " AND sender = @sender");
if (c->is_recipient_set)
strbuf_puts(b, " AND recipient = @recipient");
if (c->rowid_since)
strbuf_puts(b, " AND rowid > @since");
if (c->oldest_first){
if (c->_rowid_last)
strbuf_puts(b, " AND rowid > @last");
strbuf_puts(b, " ORDER BY rowid ASC");
}else{
if (c->_rowid_last)
strbuf_puts(b, " AND rowid < @last");
strbuf_puts(b, " ORDER BY rowid DESC");
}
if (strbuf_overrun(b))
RETURN(WHYF("SQL command too long: %s", strbuf_str(b)));
c->_retry = SQLITE_RETRY_STATE_DEFAULT;
c->_statement = sqlite_prepare(&c->_retry, strbuf_str(b));
if (c->_statement == NULL)
RETURN(-1);
if (c->service && sqlite_bind(&c->_retry, c->_statement, NAMED|STATIC_TEXT, "@service", c->service, END) == -1)
goto failure;
if (c->name && sqlite_bind(&c->_retry, c->_statement, NAMED|STATIC_TEXT, "@name", c->name, END) == -1)
goto failure;
if (c->is_sender_set && sqlite_bind(&c->_retry, c->_statement, NAMED|SID_T, "@sender", &c->sender, END) == -1)
goto failure;
if (c->is_recipient_set && sqlite_bind(&c->_retry, c->_statement, NAMED|SID_T, "@recipient", &c->recipient, END) == -1)
goto failure;
if (c->rowid_since && sqlite_bind(&c->_retry, c->_statement, NAMED|INT64, "@since", c->rowid_since, END) == -1)
goto failure;
if (c->_rowid_last && sqlite_bind(&c->_retry, c->_statement, NAMED|INT64, "@last", c->_rowid_last, END) == -1)
goto failure;
c->manifest = NULL;
c->_rowid_current = 0;
RETURN(0);
OUT();
failure:
sqlite3_finalize(c->_statement);
c->_statement = NULL;
RETURN(-1);
OUT();
}
/* Guaranteed to return manifests with monotonically descending rowid. The first manifest will have
* the greatest rowid.
*
* Returns 1 if a new manifest has been fetched from the list, in which case the cursor 'manifest'
* field points to the fetched manifest. Returns 0 if there are no more manifests in the list.
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int rhizome_list_next(struct rhizome_list_cursor *c)
{
DEBUGF(rhizome, "c=%p c->service=%s c->name=%s c->sender=%s c->recipient=%s c->rowid_since=%"PRIu64" c->_rowid_last=%"PRIu64,
c,
alloca_str_toprint(c->service),
alloca_str_toprint(c->name),
c->is_sender_set ? alloca_tohex_sid_t(c->sender) : "UNSET",
c->is_recipient_set ? alloca_tohex_sid_t(c->recipient) : "UNSET",
c->rowid_since,
c->_rowid_last
);
IN();
if (c->_statement == NULL && rhizome_list_open(c) == -1)
RETURN(-1);
int r=0;
while (1) {
if (c->manifest) {
rhizome_manifest_free(c->manifest);
c->_rowid_current = 0;
c->manifest = NULL;
}
if ((r=sqlite_step_retry(&c->_retry, c->_statement)) != SQLITE_ROW)
break;
assert(sqlite3_column_count(c->_statement) == 6);
assert(sqlite3_column_type(c->_statement, 0) == SQLITE_TEXT);
assert(sqlite3_column_type(c->_statement, 1) == SQLITE_BLOB);
assert(sqlite3_column_type(c->_statement, 2) == SQLITE_INTEGER);
assert(sqlite3_column_type(c->_statement, 3) == SQLITE_INTEGER);
assert(sqlite3_column_type(c->_statement, 4) == SQLITE_TEXT || sqlite3_column_type(c->_statement, 4) == SQLITE_NULL);
assert(sqlite3_column_type(c->_statement, 5) == SQLITE_INTEGER);
uint64_t q_rowid = c->_rowid_current = sqlite3_column_int64(c->_statement, 5);
const char *q_manifestid = (const char *) sqlite3_column_text(c->_statement, 0);
const char *manifestblob = (char *) sqlite3_column_blob(c->_statement, 1);
size_t manifestblobsize = sqlite3_column_bytes(c->_statement, 1); // must call after sqlite3_column_blob()
uint64_t q_version = sqlite3_column_int64(c->_statement, 2);
int64_t q_inserttime = sqlite3_column_int64(c->_statement, 3);
const char *q_author = (const char *) sqlite3_column_text(c->_statement, 4);
sid_t author;
if (q_author) {
if (str_to_sid_t(&author, q_author) == -1) {
WHYF("MANIFESTS row id=%s has invalid author column %s -- skipped", q_manifestid, alloca_str_toprint(q_author));
continue;
}
}
rhizome_manifest *m = c->manifest = rhizome_new_manifest();
if (m == NULL)
RETURN(-1);
memcpy(m->manifestdata, manifestblob, manifestblobsize);
m->manifest_all_bytes = manifestblobsize;
if ( rhizome_manifest_parse(m) == -1
|| !rhizome_manifest_validate(m)
) {
WHYF("MANIFESTS row id=%s has invalid manifest blob -- skipped", q_manifestid);
continue;
}
if (m->version != q_version) {
WHYF("MANIFESTS row id=%s version=%"PRIu64" does not match manifest blob version=%"PRIu64" -- skipped",
q_manifestid, q_version, m->version);
continue;
}
if (q_author)
rhizome_manifest_set_author(m, &author);
rhizome_manifest_set_rowid(m, q_rowid);
rhizome_manifest_set_inserttime(m, q_inserttime);
assert(c->_rowid_current != 0);
// Don't do rhizome_verify_author(m); too CPU expensive for a listing. Save that for when
// the bundle is extracted or exported.
RETURN(1);
}
assert(c->_rowid_current == 0);
RETURN(sqlite_code_ok(r)?0:-1);
OUT();
}
void rhizome_list_commit(struct rhizome_list_cursor *c)
{
DEBUGF(rhizome, "c=%p c->oldest_first=%d c->_rowid_current=%"PRIu64" c->_rowid_last=%"PRIu64,
c, c->oldest_first, c->_rowid_current, c->_rowid_last);
assert(c->_rowid_current != 0);
if (c->_rowid_last == 0 || (c->oldest_first ? c->_rowid_current > c->_rowid_last : c->_rowid_current < c->_rowid_last))
c->_rowid_last = c->_rowid_current;
}
void rhizome_list_release(struct rhizome_list_cursor *c)
{
DEBUGF(rhizome, "c=%p", c);
if (c->manifest) {
rhizome_manifest_free(c->manifest);
c->_rowid_current = 0;
c->manifest = NULL;
}
if (c->_statement) {
sqlite3_finalize(c->_statement);
c->_statement = NULL;
}
}
void rhizome_bytes_to_hex_upper(unsigned const char *in, char *out, int byteCount)
{
(void) tohex(out, byteCount * 2, in);
}
/* Search the database for a manifest having the same name and payload content, and if the version
* is known, having the same version. Returns RHIZOME_BUNDLE_STATUS_DUPLICATE if a duplicate is found
* (setting *found to point to the duplicate's manifest), returns RHIZOME_BUNDLE_STATUS_NEW if no
* duplicate is found (leaving *found unchanged). Returns -1 on error (leaving *found undefined).
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
enum rhizome_bundle_status rhizome_find_duplicate(const rhizome_manifest *m, rhizome_manifest **found)
{
if (m->service == NULL)
return WHY("Manifest has no service");
char sqlcmd[1024];
strbuf b = strbuf_local_buf(sqlcmd);
strbuf_puts(b, "SELECT id, manifest, author FROM manifests WHERE filesize = ? AND service = ?");
assert(m->filesize != RHIZOME_SIZE_UNSET);
if (m->filesize > 0)
strbuf_puts(b, " AND filehash = ?");
if (m->name)
strbuf_puts(b, " AND name = ?");
if (m->has_sender)
strbuf_puts(b, " AND sender = ?");
if (m->has_recipient)
strbuf_puts(b, " AND recipient = ?");
if (strbuf_overrun(b))
return WHYF("SQL command too long: %s", strbuf_str(b));
int ret = RHIZOME_BUNDLE_STATUS_NEW;
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
sqlite3_stmt *statement = sqlite_prepare_bind(&retry, strbuf_str(b), INT64, m->filesize, STATIC_TEXT, m->service, END);
if (!statement)
return -1;
int field = 2;
if (m->filesize > 0)
sqlite_bind(&retry, statement, INDEX|RHIZOME_FILEHASH_T, ++field, &m->filehash, END);
if (m->name)
sqlite_bind(&retry, statement, INDEX|STATIC_TEXT, ++field, m->name, END);
if (m->has_sender)
sqlite_bind(&retry, statement, INDEX|SID_T, ++field, &m->sender, END);
if (m->has_recipient)
sqlite_bind(&retry, statement, INDEX|SID_T, ++field, &m->recipient, END);
int rows = 0;
int r=0;
while ((r=sqlite_step_retry(&retry, statement)) == SQLITE_ROW) {
++rows;
DEBUGF(rhizome, "Row %d", rows);
rhizome_manifest *blob_m = rhizome_new_manifest();
if (blob_m == NULL) {
ret = WHY("Out of manifests");
break;
}
const unsigned char *q_manifestid = sqlite3_column_text(statement, 0);
const char *manifestblob = (char *) sqlite3_column_blob(statement, 1);
size_t manifestblobsize = sqlite3_column_bytes(statement, 1); // must call after sqlite3_column_blob()
memcpy(blob_m->manifestdata, manifestblob, manifestblobsize);
blob_m->manifest_all_bytes = manifestblobsize;
if ( rhizome_manifest_parse(blob_m) == -1
|| !rhizome_manifest_validate(blob_m)
) {
WARNF("MANIFESTS row id=%s has invalid manifest blob -- skipped", q_manifestid);
goto next;
}
if (!rhizome_manifest_verify(blob_m)) {
WARNF("MANIFESTS row id=%s fails verification -- skipped", q_manifestid);
goto next;
}
const char *q_author = (const char *) sqlite3_column_text(statement, 2);
if (q_author) {
sid_t author;
if (str_to_sid_t(&author, q_author) == -1)
WARNF("MANIFESTS row id=%s has invalid author=%s -- ignored", q_manifestid, alloca_str_toprint(q_author));
else
rhizome_manifest_set_author(blob_m, &author);
}
// check that we can re-author this manifest
rhizome_authenticate_author(blob_m);
if (m->authorship != AUTHOR_AUTHENTIC)
goto next;
*found = blob_m;
DEBUGF(rhizome, "Found duplicate payload, %s", q_manifestid);
ret = RHIZOME_BUNDLE_STATUS_DUPLICATE;
break;
next:
if (blob_m)
rhizome_manifest_free(blob_m);
}
sqlite3_finalize(statement);
if (!sqlite_code_ok(r))
ret=-1;
return ret;
}
/* Unpacks a database MANIFESTS table row into a manifest structure.
*
* Returns RHIZOME_BUNDLE_STATUS_SAME if unpack succeeds
* Returns RHIZOME_BUNDLE_STATUS_NEW if manifest is not found
* Returns RHIZOME_BUNDLE_STATUS_ERROR on error
* Returns RHIZOME_BUNDLE_STATUS_BUSY if the database is locked
* Caller is responsible for allocating and freeing rhizome_manifest
*/
static int unpack_manifest_row(rhizome_manifest *m, sqlite3_stmt *statement){
const char *q_id = (const char *) sqlite3_column_text(statement, 0);
const char *q_blob = (char *) sqlite3_column_blob(statement, 1);
uint64_t q_version = sqlite3_column_int64(statement, 2);
int64_t q_inserttime = sqlite3_column_int64(statement, 3);
const char *q_author = (const char *) sqlite3_column_text(statement, 4);
size_t q_blobsize = sqlite3_column_bytes(statement, 1); // must call after sqlite3_column_blob()
uint64_t q_rowid = sqlite3_column_int64(statement, 5);
memcpy(m->manifestdata, q_blob, q_blobsize);
m->manifest_all_bytes = q_blobsize;
if (rhizome_manifest_parse(m) == -1 || !rhizome_manifest_validate(m))
return WHYF("Manifest bid=%s in database but invalid", q_id);
if (q_author) {
sid_t author;
if (str_to_sid_t(&author, q_author) == -1)
WARNF("MANIFESTS row id=%s has invalid author=%s -- ignored", q_id, alloca_str_toprint(q_author));
else
rhizome_manifest_set_author(m, &author);
}
if (m->version != q_version)
WARNF("Version mismatch, manifest is %"PRIu64", database is %"PRIu64, m->version, q_version);
rhizome_manifest_set_rowid(m, q_rowid);
rhizome_manifest_set_inserttime(m, q_inserttime);
return 0;
}
static enum rhizome_bundle_status step_unpack_manifest_row(sqlite_retry_state *retry, rhizome_manifest *m, sqlite3_stmt *statement)
{
int r=sqlite_step_retry(retry, statement);
if (sqlite_code_busy(r))
return RHIZOME_BUNDLE_STATUS_BUSY;
if (!sqlite_code_ok(r))
return RHIZOME_BUNDLE_STATUS_ERROR;
if (r!=SQLITE_ROW)
return RHIZOME_BUNDLE_STATUS_NEW;
if (unpack_manifest_row(m, statement)==-1)
return RHIZOME_BUNDLE_STATUS_ERROR;
return RHIZOME_BUNDLE_STATUS_SAME;
}
/* Retrieve a manifest from the database, given its Bundle ID.
*
* Returns RHIZOME_BUNDLE_STATUS_SAME if manifest is found
* Returns RHIZOME_BUNDLE_STATUS_NEW if manifest is not found
* Returns RHIZOME_BUNDLE_STATUS_ERROR on error
* Returns RHIZOME_BUNDLE_STATUS_BUSY if the database is locked
* Caller is responsible for allocating and freeing rhizome_manifest
*/
enum rhizome_bundle_status rhizome_retrieve_manifest(const rhizome_bid_t *bidp, rhizome_manifest *m)
{
DEBUGF(rhizome, "retrieve manifest bid=%s", bidp ? alloca_tohex_rhizome_bid_t(*bidp) : "<NULL>");
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
sqlite3_stmt *statement = sqlite_prepare_bind(&retry,
"SELECT id, manifest, version, inserttime, author, rowid FROM manifests WHERE id = ?",
RHIZOME_BID_T, bidp,
END);
if (!statement)
return RHIZOME_BUNDLE_STATUS_ERROR;
enum rhizome_bundle_status ret = step_unpack_manifest_row(&retry, m, statement);
sqlite3_finalize(statement);
return ret;
}
/* Retrieve any manifest from the database whose Bundle ID starts with the given prefix.
*
* Returns RHIZOME_BUNDLE_STATUS_SAME if manifest is found
* Returns RHIZOME_BUNDLE_STATUS_NEW if manifest is not found
* Returns RHIZOME_BUNDLE_STATUS_ERROR on error
* Returns RHIZOME_BUNDLE_STATUS_BUSY if the database is locked
* Caller is responsible for allocating and freeing rhizome_manifest
*/
enum rhizome_bundle_status rhizome_retrieve_manifest_by_prefix(const unsigned char *prefix, unsigned prefix_len, rhizome_manifest *m)
{
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
const unsigned prefix_strlen = prefix_len * 2;
char like[prefix_strlen + 2];
tohex(like, prefix_strlen, prefix);
like[prefix_strlen] = '%';
like[prefix_strlen + 1] = '\0';
sqlite3_stmt *statement = sqlite_prepare_bind(&retry,
"SELECT id, manifest, version, inserttime, author, rowid FROM manifests WHERE id like ?",
TEXT, like,
END);
if (!statement)
return RHIZOME_BUNDLE_STATUS_ERROR;
enum rhizome_bundle_status ret = step_unpack_manifest_row(&retry, m, statement);
sqlite3_finalize(statement);
return ret;
}
enum rhizome_bundle_status rhizome_retrieve_manifest_by_hash_prefix(const uint8_t *prefix, unsigned prefix_len, rhizome_manifest *m)
{
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
const unsigned prefix_strlen = prefix_len * 2;
char like[prefix_strlen + 2];
tohex(like, prefix_strlen, prefix);
like[prefix_strlen] = '%';
like[prefix_strlen + 1] = '\0';
sqlite3_stmt *statement = sqlite_prepare_bind(&retry,
"SELECT id, manifest, version, inserttime, author, rowid FROM manifests WHERE manifest_hash like ?",
TEXT, like,
END);
if (!statement)
return RHIZOME_BUNDLE_STATUS_ERROR;
enum rhizome_bundle_status ret = step_unpack_manifest_row(&retry, m, statement);
sqlite3_finalize(statement);
return ret;
}
enum rhizome_bundle_status rhizome_retrieve_bar_by_hash_prefix(const uint8_t *prefix, unsigned prefix_len, rhizome_bar_t *bar)
{
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
const unsigned prefix_strlen = prefix_len * 2;
char like[prefix_strlen + 2];
tohex(like, prefix_strlen, prefix);
like[prefix_strlen] = '%';
like[prefix_strlen + 1] = '\0';
sqlite3_stmt *statement = sqlite_prepare_bind(&retry,
"SELECT bar FROM manifests WHERE manifest_hash like ?",
TEXT, like,
END);
if (!statement)
return RHIZOME_BUNDLE_STATUS_ERROR;
enum rhizome_bundle_status ret;
int r=sqlite_step_retry(&retry, statement);
if (sqlite_code_busy(r)){
ret = RHIZOME_BUNDLE_STATUS_BUSY;
goto end;
}
if (!sqlite_code_ok(r)){
ret = RHIZOME_BUNDLE_STATUS_ERROR;
goto end;
}
if (r!=SQLITE_ROW){
ret = RHIZOME_BUNDLE_STATUS_NEW;
goto end;
}
const uint8_t *db_bar = sqlite3_column_blob(statement, 0);
size_t bar_size = sqlite3_column_bytes(statement, 0);
if (bar_size != RHIZOME_BAR_BYTES){
ret = RHIZOME_BUNDLE_STATUS_ERROR;
goto end;
}
bcopy(db_bar, bar, RHIZOME_BAR_BYTES);
ret = RHIZOME_BUNDLE_STATUS_SAME;
end:
sqlite3_finalize(statement);
return ret;
}
// Detect bundles added from the cmdline, and call trigger functions.
void rhizome_process_added_bundles(uint64_t up_to_rowid) {
assert(serverMode != SERVER_NOT_RUNNING);
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
sqlite3_stmt *statement = sqlite_prepare_bind(&retry,
"SELECT id, manifest, version, inserttime, author, rowid FROM manifests WHERE rowid > ? AND rowid < ?"
"ORDER BY rowid",
INT64, max_rowid, INT64, up_to_rowid, END);
while (sqlite_step_retry(&retry, statement) == SQLITE_ROW) {
rhizome_manifest *m = rhizome_new_manifest();
if (!m)
break;
if (unpack_manifest_row(m, statement)!=-1){
if (rhizome_manifest_verify(m)){
if (max_rowid < m->rowid)
max_rowid = m->rowid;
CALL_TRIGGER(bundle_add, m);
// Note that a trigger might cause a new bundle to be added, and max_rowid to jump
}
}
rhizome_manifest_free(m);
}
sqlite3_finalize(statement);
}
static int rhizome_delete_manifest_retry(sqlite_retry_state *retry, const rhizome_bid_t *bidp)
{
sqlite3_stmt *statement = sqlite_prepare_bind(retry,
"DELETE FROM manifests WHERE id = ?",
RHIZOME_BID_T, bidp,
END);
if (!statement)
return -1;
if (_sqlite_exec(__WHENCE__, LOG_LEVEL_ERROR, retry, statement) == -1)
return -1;
return sqlite3_changes(rhizome_database.db) ? 0 : 1;
}
/* Remove a manifest and its bundle from the database, given its manifest ID.
*
* Returns 0 if manifest is found and removed and bundle was either absent or removed
* Returns 1 if manifest is not found
* Returns -1 on error
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int rhizome_delete_bundle(const rhizome_bid_t *bidp)
{
if (rhizome_delete_payload(bidp) == -1)
return -1;
if (rhizome_delete_manifest(bidp) == -1)
return -1;
return 0;
}
/* Remove a manifest from the database, given its manifest ID, leaving its bundle (fileblob)
* untouched if present.
*
* Returns 0 if manifest is found and removed
* Returns 1 if manifest is not found
* Returns -1 on error
*
* @author Andrew Bettison <andrew@servalproject.com>
*/
int rhizome_delete_manifest(const rhizome_bid_t *bidp)
{
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
return rhizome_delete_manifest_retry(&retry, bidp);
}
static enum rhizome_bundle_status is_interesting(const char *id_hex, uint64_t version, uint64_t *filesizep)
{
IN();
// do we have this bundle [or later]?
sqlite_retry_state retry = SQLITE_RETRY_STATE_DEFAULT;
sqlite3_stmt *statement = sqlite_prepare_bind(&retry,
"SELECT version, filesize, filehash FROM MANIFESTS WHERE id LIKE ? AND version >= ?",
TEXT_TOUPPER, id_hex,
INT64, version,
END);
if (!statement)
RETURN(RHIZOME_BUNDLE_STATUS_ERROR);
enum rhizome_bundle_status status = RHIZOME_BUNDLE_STATUS_ERROR;
int stepcode;
if ((stepcode = sqlite_step_retry(&retry, statement)) == SQLITE_ROW){
uint64_t q_version = sqlite3_column_int64(statement, 0);
uint64_t q_filesize = sqlite3_column_int64(statement, 1);
const char *q_filehash = (const char *) sqlite3_column_text(statement, 2);
if (filesizep)
*filesizep = q_filesize;
if (q_version > version){
status = RHIZOME_BUNDLE_STATUS_OLD;
}else{
status = RHIZOME_BUNDLE_STATUS_SAME;
if (q_filesize) {
if (q_filehash && *q_filehash) {
rhizome_filehash_t hash;
if (str_to_rhizome_filehash_t(&hash, q_filehash) == -1) {
WHYF("Malformed filehash %s", q_filehash);
status = RHIZOME_BUNDLE_STATUS_ERROR;
}else{
// unless we are missing the payload...
enum rhizome_payload_status pstatus;
switch((pstatus = rhizome_exists(&hash))){
case RHIZOME_PAYLOAD_STATUS_NEW:
status = RHIZOME_BUNDLE_STATUS_NEW;
break;
case RHIZOME_PAYLOAD_STATUS_STORED:
break;
case RHIZOME_PAYLOAD_STATUS_BUSY:
status = RHIZOME_BUNDLE_STATUS_BUSY;
break;
default:
status = RHIZOME_BUNDLE_STATUS_ERROR;
break;
}
}
} else {
WHYF("Missing filehash");
status = RHIZOME_BUNDLE_STATUS_ERROR;
}
}
}
}else if (sqlite_code_busy(stepcode)){
status = RHIZOME_BUNDLE_STATUS_BUSY;
}else if (!sqlite_code_ok(stepcode)){
status = RHIZOME_BUNDLE_STATUS_ERROR;
}else{
status = RHIZOME_BUNDLE_STATUS_NEW;
}
sqlite3_finalize(statement);
RETURN(status);
OUT();
}
enum rhizome_bundle_status rhizome_is_bar_interesting(const rhizome_bar_t *bar)
{
char id_hex[RHIZOME_BAR_PREFIX_BYTES *2 + 2];
tohex(id_hex, RHIZOME_BAR_PREFIX_BYTES * 2, rhizome_bar_prefix(bar));
strcat(id_hex, "%");
return is_interesting(id_hex, rhizome_bar_version(bar), NULL);
}
enum rhizome_bundle_status rhizome_is_interesting(const rhizome_bid_t *bid, uint64_t version, uint64_t *filesizep)
{
return is_interesting(alloca_tohex_rhizome_bid_t(*bid), version, filesizep);
}
Reference in New Issue View Git Blame Copy Permalink