/*
- * This file contains a set of abstractions that allow Citadel to plug into any
- * record manager or database system for its data store.
+ * This is a data store backend for the Citadel server which uses Berkeley DB.
+ *
+ * Copyright (c) 1987-2012 by the citadel.org team
+ *
+ * This program is open source software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License version 3.
+ *
+ * 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.
+ *
*/
+/*****************************************************************************
+ Tunable configuration parameters for the Berkeley DB back end
+ *****************************************************************************/
+/* Citadel will checkpoint the db at the end of every session, but only if
+ * the specified number of kilobytes has been written, or if the specified
+ * number of minutes has passed, since the last checkpoint.
+ */
+#define MAX_CHECKPOINT_KBYTES 256
+#define MAX_CHECKPOINT_MINUTES 15
+
+/*****************************************************************************/
+
+#include "sysdep.h"
#include <stdlib.h>
#include <unistd.h>
#include <stdio.h>
-#include <time.h>
#include <ctype.h>
#include <string.h>
#include <errno.h>
-#include <pthread.h>
-#include <gdbm.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <dirent.h>
+#include <syslog.h>
+#include <zlib.h>
+
+#ifdef HAVE_DB_H
+#include <db.h>
+#elif defined(HAVE_DB4_DB_H)
+#include <db4/db.h>
+#else
+#error Neither <db.h> nor <db4/db.h> was found by configure. Install db4-devel.
+#endif
+
+
+#if DB_VERSION_MAJOR < 4 || DB_VERSION_MINOR < 1
+#error Citadel requires Berkeley DB v4.1 or newer. Please upgrade.
+#endif
+
+
+#include <libcitadel.h>
#include "citadel.h"
#include "server.h"
-#include "proto.h"
+#include "citserver.h"
+#include "database.h"
+#include "msgbase.h"
+#include "sysdep_decls.h"
+#include "threads.h"
+#include "config.h"
+#include "control.h"
+
+#include "ctdl_module.h"
+
+
+static DB *dbp[MAXCDB]; /* One DB handle for each Citadel database */
+static DB_ENV *dbenv; /* The DB environment (global) */
+
+
+void cdb_abort(void) {
+ syslog(LOG_DEBUG,
+ "citserver is stopping in order to prevent data loss. uid=%d gid=%d euid=%d egid=%d",
+ getuid(),
+ getgid(),
+ geteuid(),
+ getegid()
+ );
+ cit_backtrace();
+ exit(CTDLEXIT_DB);
+}
+
+
+/* Verbose logging callback */
+void cdb_verbose_log(const DB_ENV *dbenv, const char *msg)
+{
+ if (!IsEmptyStr(msg)) {
+ syslog(LOG_DEBUG, "DB: %s", msg);
+ cit_backtrace();
+ }
+}
+
+
+/* Verbose logging callback */
+void cdb_verbose_err(const DB_ENV *dbenv, const char *errpfx, const char *msg)
+{
+ syslog(LOG_ALERT, "DB: %s", msg);
+ cit_backtrace();
+}
+
+
+/* just a little helper function */
+static void txabort(DB_TXN * tid)
+{
+ int ret;
+
+ ret = tid->abort(tid);
+
+ if (ret) {
+ syslog(LOG_EMERG, "bdb(): txn_abort: %s", db_strerror(ret));
+ cdb_abort();
+ }
+}
+
+/* this one is even more helpful than the last. */
+static void txcommit(DB_TXN * tid)
+{
+ int ret;
+
+ ret = tid->commit(tid, 0);
+
+ if (ret) {
+ syslog(LOG_EMERG, "bdb(): txn_commit: %s", db_strerror(ret));
+ cdb_abort();
+ }
+}
+
+/* are you sensing a pattern yet? */
+static void txbegin(DB_TXN ** tid)
+{
+ int ret;
+
+ ret = dbenv->txn_begin(dbenv, NULL, tid, 0);
+
+ if (ret) {
+ syslog(LOG_EMERG, "bdb(): txn_begin: %s", db_strerror(ret));
+ cdb_abort();
+ }
+}
+
+static void dbpanic(DB_ENV * env, int errval)
+{
+ syslog(LOG_EMERG, "bdb(): PANIC: %s", db_strerror(errval));
+ cit_backtrace();
+}
+
+static void cclose(DBC * cursor)
+{
+ int ret;
+
+ if ((ret = cursor->c_close(cursor))) {
+ syslog(LOG_EMERG, "bdb(): c_close: %s", db_strerror(ret));
+ cdb_abort();
+ }
+}
+
+static void bailIfCursor(DBC ** cursors, const char *msg)
+{
+ int i;
+
+ for (i = 0; i < MAXCDB; i++)
+ if (cursors[i] != NULL) {
+ syslog(LOG_EMERG, "bdb(): cursor still in progress on cdb %02x: %s", i, msg);
+ cdb_abort();
+ }
+}
+
+
+void cdb_check_handles(void)
+{
+ bailIfCursor(TSD->cursors, "in check_handles");
+
+ if (TSD->tid != NULL) {
+ syslog(LOG_EMERG, "bdb(): transaction still in progress!");
+ cdb_abort();
+ }
+}
/*
- * This array holds one gdbm handle for each Citadel database.
+ * Cull the database logs
*/
-GDBM_FILE gdbms[MAXCDB];
+static void cdb_cull_logs(void)
+{
+ u_int32_t flags;
+ int ret;
+ char **file, **list;
+ char errmsg[SIZ];
+
+ flags = DB_ARCH_ABS;
+
+ /* Get the list of names. */
+ if ((ret = dbenv->log_archive(dbenv, &list, flags)) != 0) {
+ syslog(LOG_ERR, "cdb_cull_logs: %s", db_strerror(ret));
+ return;
+ }
+
+ /* Print the list of names. */
+ if (list != NULL) {
+ for (file = list; *file != NULL; ++file) {
+ syslog(LOG_DEBUG, "Deleting log: %s", *file);
+ ret = unlink(*file);
+ if (ret != 0) {
+ snprintf(errmsg, sizeof(errmsg),
+ " ** ERROR **\n \n \n "
+ "Citadel was unable to delete the "
+ "database log file '%s' because of the "
+ "following error:\n \n %s\n \n"
+ " This log file is no longer in use "
+ "and may be safely deleted.\n",
+ *file, strerror(errno));
+ CtdlAideMessage(errmsg, "Database Warning Message");
+ }
+ }
+ free(list);
+ }
+}
/*
- * We also keep these around, for sequential searches... (one per
- * session. Maybe there's a better way?)
+ * Manually initiate log file cull.
*/
-#define MAXKEYS 256
-datum dtkey[MAXKEYS];
+void cmd_cull(char *argbuf) {
+ if (CtdlAccessCheck(ac_internal)) return;
+ cdb_cull_logs();
+ cprintf("%d Database log file cull completed.\n", CIT_OK);
+}
/*
- * Reclaim unused space in the databases. We need to do each one of
- * these discretely, rather than in a loop.
+ * Request a checkpoint of the database. Called once per minute by the thread manager.
*/
-void defrag_databases() {
-
- /* defrag the message base */
- begin_critical_section(S_MSGMAIN);
- gdbm_reorganize(gdbms[CDB_MSGMAIN]);
- end_critical_section(S_MSGMAIN);
+void cdb_checkpoint(void)
+{
+ int ret;
- /* defrag the user file and mailboxes */
- begin_critical_section(S_USERSUPP);
- gdbm_reorganize(gdbms[CDB_USERSUPP]);
- gdbm_reorganize(gdbms[CDB_MAILBOXES]);
- end_critical_section(S_USERSUPP);
+ syslog(LOG_DEBUG, "-- db checkpoint --");
+ ret = dbenv->txn_checkpoint(dbenv, MAX_CHECKPOINT_KBYTES, MAX_CHECKPOINT_MINUTES, 0);
- /* defrag the room files and message lists */
- begin_critical_section(S_QUICKROOM);
- gdbm_reorganize(gdbms[CDB_QUICKROOM]);
- gdbm_reorganize(gdbms[CDB_MSGLISTS]);
- end_critical_section(S_QUICKROOM);
+ if (ret != 0) {
+ syslog(LOG_EMERG, "cdb_checkpoint: txn_checkpoint: %s", db_strerror(ret));
+ cdb_abort();
+ }
- /* defrag the floor table */
- begin_critical_section(S_FLOORTAB);
- gdbm_reorganize(gdbms[CDB_FLOORTAB]);
- end_critical_section(S_FLOORTAB);
+ /* After a successful checkpoint, we can cull the unused logs */
+ if (config.c_auto_cull) {
+ cdb_cull_logs();
}
+}
+
/*
- * Open the various gdbm databases we'll be using. Any database which
- * does not exist should be created.
+ * Open the various databases we'll be using. Any database which
+ * does not exist should be created. Note that we don't need a
+ * critical section here, because there aren't any active threads
+ * manipulating the database yet.
*/
-void open_databases() {
- int a;
+void open_databases(void)
+{
+ int ret;
+ int i;
+ char dbfilename[32];
+ u_int32_t flags = 0;
+ int dbversion_major, dbversion_minor, dbversion_patch;
+ int current_dbversion = 0;
+
+ syslog(LOG_DEBUG, "bdb(): open_databases() starting");
+ syslog(LOG_DEBUG, "Compiled db: %s", DB_VERSION_STRING);
+ syslog(LOG_INFO, " Linked db: %s",
+ db_version(&dbversion_major, &dbversion_minor, &dbversion_patch));
+
+ current_dbversion = (dbversion_major * 1000000) + (dbversion_minor * 1000) + dbversion_patch;
+
+ syslog(LOG_DEBUG, "Calculated dbversion: %d", current_dbversion);
+ syslog(LOG_DEBUG, " Previous dbversion: %d", CitControl.MMdbversion);
+
+ if ( (getenv("SUPPRESS_DBVERSION_CHECK") == NULL)
+ && (CitControl.MMdbversion > current_dbversion) ) {
+ syslog(LOG_EMERG, "You are attempting to run the Citadel server using a version");
+ syslog(LOG_EMERG, "of Berkeley DB that is older than that which last created or");
+ syslog(LOG_EMERG, "updated the database. Because this would probably cause data");
+ syslog(LOG_EMERG, "corruption or loss, the server is aborting execution now.");
+ exit(CTDLEXIT_DB);
+ }
- gdbms[CDB_MSGMAIN] = gdbm_open("msgmain.gdbm", 8192,
- GDBM_WRCREAT, 0600, NULL);
- if (gdbms[CDB_MSGMAIN] == NULL) {
- lprintf(2, "Cannot open msgmain: %s\n",
- gdbm_strerror(gdbm_errno));
- }
+ CitControl.MMdbversion = current_dbversion;
+ put_control();
- gdbms[CDB_USERSUPP] = gdbm_open("usersupp.gdbm", 0,
- GDBM_WRCREAT, 0600, NULL);
- if (gdbms[CDB_USERSUPP] == NULL) {
- lprintf(2, "Cannot open usersupp: %s\n",
- gdbm_strerror(gdbm_errno));
- }
+ syslog(LOG_INFO, "Linked zlib: %s\n", zlibVersion());
- gdbms[CDB_QUICKROOM] = gdbm_open("quickroom.gdbm", 0,
- GDBM_WRCREAT, 0600, NULL);
- if (gdbms[CDB_QUICKROOM] == NULL) {
- lprintf(2, "Cannot open quickroom: %s\n",
- gdbm_strerror(gdbm_errno));
- }
+ /*
+ * Silently try to create the database subdirectory. If it's
+ * already there, no problem.
+ */
+ if ((mkdir(ctdl_data_dir, 0700) != 0) && (errno != EEXIST)){
+ syslog(LOG_EMERG,
+ "unable to create database directory [%s]: %s",
+ ctdl_data_dir, strerror(errno));
+ }
+ if (chmod(ctdl_data_dir, 0700) != 0){
+ syslog(LOG_EMERG,
+ "unable to set database directory accessrights [%s]: %s",
+ ctdl_data_dir, strerror(errno));
+ }
+ if (chown(ctdl_data_dir, CTDLUID, (-1)) != 0){
+ syslog(LOG_EMERG,
+ "unable to set the owner for [%s]: %s",
+ ctdl_data_dir, strerror(errno));
+ }
+ syslog(LOG_DEBUG, "bdb(): Setting up DB environment\n");
+ /* db_env_set_func_yield((int (*)(u_long, u_long))sched_yield); */
+ ret = db_env_create(&dbenv, 0);
+ if (ret) {
+ syslog(LOG_EMERG, "bdb(): db_env_create: %s\n", db_strerror(ret));
+ syslog(LOG_EMERG, "exit code %d\n", ret);
+ exit(CTDLEXIT_DB);
+ }
+ dbenv->set_errpfx(dbenv, "citserver");
+ dbenv->set_paniccall(dbenv, dbpanic);
+ dbenv->set_errcall(dbenv, cdb_verbose_err);
+ dbenv->set_errpfx(dbenv, "ctdl");
+#if (DB_VERSION_MAJOR == 4) && (DB_VERSION_MINOR >= 3)
+ dbenv->set_msgcall(dbenv, cdb_verbose_log);
+#endif
+ dbenv->set_verbose(dbenv, DB_VERB_DEADLOCK, 1);
+ dbenv->set_verbose(dbenv, DB_VERB_RECOVERY, 1);
+
+ /*
+ * We want to specify the shared memory buffer pool cachesize,
+ * but everything else is the default.
+ */
+ ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
+ if (ret) {
+ syslog(LOG_EMERG, "bdb(): set_cachesize: %s\n", db_strerror(ret));
+ dbenv->close(dbenv, 0);
+ syslog(LOG_EMERG, "exit code %d\n", ret);
+ exit(CTDLEXIT_DB);
+ }
- gdbms[CDB_FLOORTAB] = gdbm_open("floortab.gdbm", 0,
- GDBM_WRCREAT, 0600, NULL);
- if (gdbms[CDB_FLOORTAB] == NULL) {
- lprintf(2, "Cannot open floortab: %s\n",
- gdbm_strerror(gdbm_errno));
- }
+ if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
+ syslog(LOG_EMERG, "bdb(): set_lk_detect: %s\n", db_strerror(ret));
+ dbenv->close(dbenv, 0);
+ syslog(LOG_EMERG, "exit code %d\n", ret);
+ exit(CTDLEXIT_DB);
+ }
- gdbms[CDB_MSGLISTS] = gdbm_open("msglists.gdbm", 0,
- GDBM_WRCREAT, 0600, NULL);
- if (gdbms[CDB_MSGLISTS] == NULL) {
- lprintf(2, "Cannot open msglists: %s\n",
- gdbm_strerror(gdbm_errno));
- }
+ flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_RECOVER;
+ syslog(LOG_DEBUG, "dbenv->open(dbenv, %s, %d, 0)\n", ctdl_data_dir, flags);
+ ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
+ if (ret == DB_RUNRECOVERY) {
+ syslog(LOG_ALERT, "dbenv->open: %s\n", db_strerror(ret));
+ syslog(LOG_ALERT, "Attempting recovery...\n");
+ flags |= DB_RECOVER;
+ ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
+ }
+ if (ret == DB_RUNRECOVERY) {
+ syslog(LOG_ALERT, "dbenv->open: %s\n", db_strerror(ret));
+ syslog(LOG_ALERT, "Attempting catastrophic recovery...\n");
+ flags &= ~DB_RECOVER;
+ flags |= DB_RECOVER_FATAL;
+ ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
+ }
+ if (ret) {
+ syslog(LOG_EMERG, "dbenv->open: %s\n", db_strerror(ret));
+ dbenv->close(dbenv, 0);
+ syslog(LOG_EMERG, "exit code %d\n", ret);
+ exit(CTDLEXIT_DB);
+ }
- gdbms[CDB_MAILBOXES] = gdbm_open("mailboxes.gdbm", 0,
- GDBM_WRCREAT, 0600, NULL);
- if (gdbms[CDB_MAILBOXES] == NULL) {
- lprintf(2, "Cannot open mailboxes: %s\n",
- gdbm_strerror(gdbm_errno));
+ syslog(LOG_INFO, "Starting up DB\n");
+
+ for (i = 0; i < MAXCDB; ++i) {
+
+ /* Create a database handle */
+ ret = db_create(&dbp[i], dbenv, 0);
+ if (ret) {
+ syslog(LOG_EMERG, "db_create: %s\n", db_strerror(ret));
+ syslog(LOG_EMERG, "exit code %d\n", ret);
+ exit(CTDLEXIT_DB);
}
- for (a=0; a<MAXKEYS; ++a) {
- dtkey[a].dsize = 0;
- dtkey[a].dptr = NULL;
+
+ /* Arbitrary names for our tables -- we reference them by
+ * number, so we don't have string names for them.
+ */
+ snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);
+
+ ret = dbp[i]->open(dbp[i],
+ NULL,
+ dbfilename,
+ NULL,
+ DB_BTREE,
+ DB_CREATE | DB_AUTO_COMMIT | DB_THREAD,
+ 0600
+ );
+ if (ret) {
+ syslog(LOG_EMERG, "db_open[%02x]: %s\n", i, db_strerror(ret));
+ if (ret == ENOMEM) {
+ syslog(LOG_EMERG, "You may need to tune your database; please read http://www.citadel.org/doku.php?id=faq:troubleshooting:out_of_lock_entries for more information.");
+ }
+ syslog(LOG_EMERG, "exit code %d\n", ret);
+ exit(CTDLEXIT_DB);
}
+ }
+}
+
+/* Make sure we own all the files, because in a few milliseconds
+ * we're going to drop root privs.
+ */
+void cdb_chmod_data(void) {
+ DIR *dp;
+ struct dirent *d;
+ char filename[PATH_MAX];
+
+ dp = opendir(ctdl_data_dir);
+ if (dp != NULL) {
+ while (d = readdir(dp), d != NULL) {
+ if (d->d_name[0] != '.') {
+ snprintf(filename, sizeof filename,
+ "%s/%s", ctdl_data_dir, d->d_name);
+ syslog(LOG_DEBUG, "chmod(%s, 0600) returned %d\n",
+ filename, chmod(filename, 0600)
+ );
+ syslog(LOG_DEBUG, "chown(%s, CTDLUID, -1) returned %d\n",
+ filename, chown(filename, CTDLUID, (-1))
+ );
+ }
+ }
+ closedir(dp);
}
+ syslog(LOG_DEBUG, "open_databases() finished\n");
+ CtdlRegisterProtoHook(cmd_cull, "CULL", "Cull database logs");
+}
+
/*
- * Close all of the gdbm database files we've opened. This can be done
+ * Close all of the db database files we've opened. This can be done
* in a loop, since it's just a bunch of closes.
*/
-void close_databases() {
+void close_databases(void)
+{
int a;
+ int ret;
- defrag_databases();
- for (a=0; a<MAXCDB; ++a) {
- lprintf(7, "Closing database %d\n", a);
- gdbm_close(gdbms[a]);
- }
+ if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) {
+ syslog(LOG_EMERG,
+ "txn_checkpoint: %s\n", db_strerror(ret));
+ }
- for (a=0; a<MAXKEYS; ++a) {
- if (dtkey[a].dptr != NULL) {
- free(dtkey[a].dptr);
- }
+ /* print some statistics... */
+#ifdef DB_STAT_ALL
+ dbenv->lock_stat_print(dbenv, DB_STAT_ALL);
+#endif
+
+ /* close the tables */
+ for (a = 0; a < MAXCDB; ++a) {
+ syslog(LOG_INFO, "Closing database %02x\n", a);
+ ret = dbp[a]->close(dbp[a], 0);
+ if (ret) {
+ syslog(LOG_EMERG, "db_close: %s\n", db_strerror(ret));
}
}
+ /* Close the handle. */
+ ret = dbenv->close(dbenv, 0);
+ if (ret) {
+ syslog(LOG_EMERG, "DBENV->close: %s\n", db_strerror(ret));
+ }
+}
+
/*
- * Store a piece of data. Returns 0 if the operation was successful. If a
- * datum already exists it should be overwritten.
+ * Decompress a database item if it was compressed on disk
*/
-int cdb_store(int cdb,
- char *key, int keylen,
- char *data, int datalen) {
+void cdb_decompress_if_necessary(struct cdbdata *cdb)
+{
+ static int magic = COMPRESS_MAGIC;
+
+ if ((cdb == NULL) ||
+ (cdb->ptr == NULL) ||
+ (cdb->len < sizeof(magic)) ||
+ (memcmp(cdb->ptr, &magic, sizeof(magic))))
+ return;
+
+ /* At this point we know we're looking at a compressed item. */
+
+ struct CtdlCompressHeader zheader;
+ char *uncompressed_data;
+ char *compressed_data;
+ uLongf destLen, sourceLen;
+ size_t cplen;
+
+ memset(&zheader, 0, sizeof(struct CtdlCompressHeader));
+ cplen = sizeof(struct CtdlCompressHeader);
+ if (sizeof(struct CtdlCompressHeader) > cdb->len)
+ cplen = cdb->len;
+ memcpy(&zheader, cdb->ptr, cplen);
+
+ compressed_data = cdb->ptr;
+ compressed_data += sizeof(struct CtdlCompressHeader);
+
+ sourceLen = (uLongf) zheader.compressed_len;
+ destLen = (uLongf) zheader.uncompressed_len;
+ uncompressed_data = malloc(zheader.uncompressed_len);
+
+ if (uncompress((Bytef *) uncompressed_data,
+ (uLongf *) & destLen,
+ (const Bytef *) compressed_data,
+ (uLong) sourceLen) != Z_OK) {
+ syslog(LOG_EMERG, "uncompress() error\n");
+ cdb_abort();
+ }
+
+ free(cdb->ptr);
+ cdb->len = (size_t) destLen;
+ cdb->ptr = uncompressed_data;
+}
- datum dkey, ddata;
- dkey.dsize = keylen;
- dkey.dptr = key;
- ddata.dsize = datalen;
- ddata.dptr = data;
- if ( gdbm_store(gdbms[cdb], dkey, ddata, GDBM_REPLACE) < 0 ) {
- lprintf(2, "gdbm error: %s\n", gdbm_strerror(gdbm_errno));
- return(-1);
+/*
+ * Store a piece of data. Returns 0 if the operation was successful. If a
+ * key already exists it should be overwritten.
+ */
+int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen)
+{
+
+ DBT dkey, ddata;
+ DB_TXN *tid;
+ int ret = 0;
+
+ struct CtdlCompressHeader zheader;
+ char *compressed_data = NULL;
+ int compressing = 0;
+ size_t buffer_len = 0;
+ uLongf destLen = 0;
+
+ memset(&dkey, 0, sizeof(DBT));
+ memset(&ddata, 0, sizeof(DBT));
+ dkey.size = ckeylen;
+ /* no, we don't care for this error. */
+ dkey.data = ckey;
+
+ ddata.size = cdatalen;
+ ddata.data = cdata;
+
+ /* Only compress Visit records. Everything else is uncompressed. */
+ if (cdb == CDB_VISIT) {
+ compressing = 1;
+ zheader.magic = COMPRESS_MAGIC;
+ zheader.uncompressed_len = cdatalen;
+ buffer_len = ((cdatalen * 101) / 100) + 100
+ + sizeof(struct CtdlCompressHeader);
+ destLen = (uLongf) buffer_len;
+ compressed_data = malloc(buffer_len);
+ if (compress2((Bytef *) (compressed_data + sizeof(struct CtdlCompressHeader)),
+ &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK)
+ {
+ syslog(LOG_EMERG, "compress2() error\n");
+ cdb_abort();
}
+ zheader.compressed_len = (size_t) destLen;
+ memcpy(compressed_data, &zheader, sizeof(struct CtdlCompressHeader));
+ ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) + zheader.compressed_len);
+ ddata.data = compressed_data;
+ }
- return(0);
+ if (TSD->tid != NULL) {
+ ret = dbp[cdb]->put(dbp[cdb], /* db */
+ TSD->tid, /* transaction ID */
+ &dkey, /* key */
+ &ddata, /* data */
+ 0); /* flags */
+ if (ret) {
+ syslog(LOG_EMERG, "cdb_store(%d): %s", cdb, db_strerror(ret));
+ cdb_abort();
+ }
+ if (compressing)
+ free(compressed_data);
+ return ret;
+
+ } else {
+ bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
+
+ retry:
+ txbegin(&tid);
+
+ if ((ret = dbp[cdb]->put(dbp[cdb], /* db */
+ tid, /* transaction ID */
+ &dkey, /* key */
+ &ddata, /* data */
+ 0))) { /* flags */
+ if (ret == DB_LOCK_DEADLOCK) {
+ txabort(tid);
+ goto retry;
+ } else {
+ syslog(LOG_EMERG, "cdb_store(%d): %s", cdb, db_strerror(ret));
+ cdb_abort();
+ }
+ } else {
+ txcommit(tid);
+ if (compressing) {
+ free(compressed_data);
+ }
+ return ret;
+ }
}
+ return ret;
+}
/*
* Delete a piece of data. Returns 0 if the operation was successful.
*/
-int cdb_delete(int cdb, char *key, int keylen) {
-
- datum dkey;
-
- dkey.dsize = keylen;
- dkey.dptr = key;
-
- return(gdbm_delete(gdbms[cdb], dkey));
-
+int cdb_delete(int cdb, void *key, int keylen)
+{
+
+ DBT dkey;
+ DB_TXN *tid;
+ int ret;
+
+ memset(&dkey, 0, sizeof dkey);
+ dkey.size = keylen;
+ dkey.data = key;
+
+ if (TSD->tid != NULL) {
+ ret = dbp[cdb]->del(dbp[cdb], TSD->tid, &dkey, 0);
+ if (ret) {
+ syslog(LOG_EMERG, "cdb_delete(%d): %s\n", cdb, db_strerror(ret));
+ if (ret != DB_NOTFOUND) {
+ cdb_abort();
+ }
+ }
+ } else {
+ bailIfCursor(TSD->cursors, "attempt to delete during r/o cursor");
+
+ retry:
+ txbegin(&tid);
+
+ if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0))
+ && ret != DB_NOTFOUND) {
+ if (ret == DB_LOCK_DEADLOCK) {
+ txabort(tid);
+ goto retry;
+ } else {
+ syslog(LOG_EMERG, "cdb_delete(%d): %s\n",
+ cdb, db_strerror(ret));
+ cdb_abort();
+ }
+ } else {
+ txcommit(tid);
+ }
+ }
+ return ret;
+}
+
+static DBC *localcursor(int cdb)
+{
+ int ret;
+ DBC *curs;
+
+ if (TSD->cursors[cdb] == NULL)
+ ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &curs, 0);
+ else
+ ret = TSD->cursors[cdb]->c_dup(TSD->cursors[cdb], &curs, DB_POSITION);
+
+ if (ret) {
+ syslog(LOG_EMERG, "localcursor: %s\n", db_strerror(ret));
+ cdb_abort();
}
-
+ return curs;
+}
/*
* a struct cdbdata which it is the caller's responsibility to free later on
* using the cdb_free() routine.
*/
-struct cdbdata *cdb_fetch(int cdb, char *key, int keylen) {
-
+struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen)
+{
struct cdbdata *tempcdb;
- datum dkey, dret;
-
- dkey.dsize = keylen;
- dkey.dptr = key;
+ DBT dkey, dret;
+ int ret;
- dret = gdbm_fetch(gdbms[cdb], dkey);
- if (dret.dptr == NULL) {
- return NULL;
+ memset(&dkey, 0, sizeof(DBT));
+ dkey.size = keylen;
+ /* no we don't care about this error. */
+ dkey.data = key;
+
+ if (TSD->tid != NULL) {
+ memset(&dret, 0, sizeof(DBT));
+ dret.flags = DB_DBT_MALLOC;
+ ret = dbp[cdb]->get(dbp[cdb], TSD->tid, &dkey, &dret, 0);
+ } else {
+ DBC *curs;
+
+ do {
+ memset(&dret, 0, sizeof(DBT));
+ dret.flags = DB_DBT_MALLOC;
+
+ curs = localcursor(cdb);
+
+ ret = curs->c_get(curs, &dkey, &dret, DB_SET);
+ cclose(curs);
}
+ while (ret == DB_LOCK_DEADLOCK);
+
+ }
+ if ((ret != 0) && (ret != DB_NOTFOUND)) {
+ syslog(LOG_EMERG, "cdb_fetch(%d): %s\n", cdb, db_strerror(ret));
+ cdb_abort();
+ }
+
+ if (ret != 0)
+ return NULL;
tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata));
- if (tempcdb == NULL) {
- lprintf(2, "Cannot allocate memory!\n");
- }
- tempcdb->len = dret.dsize;
- tempcdb->ptr = dret.dptr;
- return(tempcdb);
+ if (tempcdb == NULL) {
+ syslog(LOG_EMERG, "cdb_fetch: Cannot allocate memory for tempcdb\n");
+ cdb_abort();
+ return NULL; /* make it easier for static analysis... */
+ }
+ else
+ {
+ tempcdb->len = dret.size;
+ tempcdb->ptr = dret.data;
+ cdb_decompress_if_necessary(tempcdb);
+ return (tempcdb);
}
+}
/*
- * Free a cdbdata item (ok, this is really no big deal, but we might need to do
- * more complex stuff with other database managers in the future).
+ * Free a cdbdata item.
+ *
+ * Note that we only free the 'ptr' portion if it is not NULL. This allows
+ * other code to assume ownership of that memory simply by storing the
+ * pointer elsewhere and then setting 'ptr' to NULL. cdb_free() will then
+ * avoid freeing it.
*/
-void cdb_free(struct cdbdata *cdb) {
- free(cdb->ptr);
+void cdb_free(struct cdbdata *cdb)
+{
+ if (cdb->ptr) {
+ free(cdb->ptr);
+ }
free(cdb);
+}
+
+void cdb_close_cursor(int cdb)
+{
+ if (TSD->cursors[cdb] != NULL) {
+ cclose(TSD->cursors[cdb]);
}
+ TSD->cursors[cdb] = NULL;
+}
/*
- * Prepare for a sequential search of an entire database. (In the gdbm model,
- * we do this by keeping an array dtkey[] of "the next" key for each session
- * that is open. There is guaranteed to be no more than one traversal in
- * progress per session at any given time.)
+ * Prepare for a sequential search of an entire database.
+ * (There is guaranteed to be no more than one traversal in
+ * progress per thread at any given time.)
*/
-void cdb_rewind(int cdb) {
-
- if (dtkey[CC->cs_pid].dptr != NULL) {
- free(dtkey[CC->cs_pid].dptr);
- }
+void cdb_rewind(int cdb)
+{
+ int ret = 0;
+
+ if (TSD->cursors[cdb] != NULL) {
+ syslog(LOG_EMERG,
+ "cdb_rewind: must close cursor on database %d before reopening.\n", cdb);
+ cdb_abort();
+ /* cclose(TSD->cursors[cdb]); */
+ }
- dtkey[CC->cs_pid] = gdbm_firstkey(gdbms[cdb]);
+ /*
+ * Now initialize the cursor
+ */
+ ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &TSD->cursors[cdb], 0);
+ if (ret) {
+ syslog(LOG_EMERG, "cdb_rewind: db_cursor: %s\n", db_strerror(ret));
+ cdb_abort();
}
+}
/*
* Fetch the next item in a sequential search. Returns a pointer to a
* cdbdata structure, or NULL if we've hit the end.
*/
-struct cdbdata *cdb_next_item(int cdb) {
- datum dret;
+struct cdbdata *cdb_next_item(int cdb)
+{
+ DBT key, data;
struct cdbdata *cdbret;
+ int ret = 0;
-
- if (dtkey[CC->cs_pid].dptr == NULL) { /* end of file */
- return NULL;
- }
+ /* Initialize the key/data pair so the flags aren't set. */
+ memset(&key, 0, sizeof(key));
+ memset(&data, 0, sizeof(data));
+ data.flags = DB_DBT_MALLOC;
- dret = gdbm_fetch(gdbms[cdb], dtkey[CC->cs_pid]);
- if (dret.dptr == NULL) { /* bad read */
- free(dtkey[CC->cs_pid].dptr);
- return NULL;
+ ret = TSD->cursors[cdb]->c_get(TSD->cursors[cdb], &key, &data, DB_NEXT);
+
+ if (ret) {
+ if (ret != DB_NOTFOUND) {
+ syslog(LOG_EMERG, "cdb_next_item(%d): %s\n", cdb, db_strerror(ret));
+ cdb_abort();
}
+ cdb_close_cursor(cdb);
+ return NULL; /* presumably, end of file */
+ }
cdbret = (struct cdbdata *) malloc(sizeof(struct cdbdata));
- cdbret->len = dret.dsize;
- cdbret->ptr = dret.dptr;
+ cdbret->len = data.size;
+ cdbret->ptr = data.data;
+ cdb_decompress_if_necessary(cdbret);
+
+ return (cdbret);
+}
+
+
+
+/*
+ * Transaction-based stuff. I'm writing this as I bake cookies...
+ */
- dtkey[CC->cs_pid] = gdbm_nextkey(gdbms[cdb], dtkey[CC->cs_pid]);
- return(cdbret);
+void cdb_begin_transaction(void)
+{
+
+ bailIfCursor(TSD->cursors, "can't begin transaction during r/o cursor");
+
+ if (TSD->tid != NULL) {
+ syslog(LOG_EMERG, "cdb_begin_transaction: ERROR: nested transaction\n");
+ cdb_abort();
+ }
+
+ txbegin(&TSD->tid);
+}
+
+void cdb_end_transaction(void)
+{
+ int i;
+
+ for (i = 0; i < MAXCDB; i++)
+ if (TSD->cursors[i] != NULL) {
+ syslog(LOG_WARNING,
+ "cdb_end_transaction: WARNING: cursor %d still open at transaction end\n",
+ i);
+ cclose(TSD->cursors[i]);
+ TSD->cursors[i] = NULL;
+ }
+
+ if (TSD->tid == NULL) {
+ syslog(LOG_EMERG,
+ "cdb_end_transaction: ERROR: txcommit(NULL) !!\n");
+ cdb_abort();
+ } else {
+ txcommit(TSD->tid);
}
+
+ TSD->tid = NULL;
+}
+
+/*
+ * Truncate (delete every record)
+ */
+void cdb_trunc(int cdb)
+{
+ /* DB_TXN *tid; */
+ int ret;
+ u_int32_t count;
+
+ if (TSD->tid != NULL) {
+ syslog(LOG_EMERG, "cdb_trunc must not be called in a transaction.");
+ cdb_abort();
+ } else {
+ bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
+
+ retry:
+ /* txbegin(&tid); */
+
+ if ((ret = dbp[cdb]->truncate(dbp[cdb], /* db */
+ NULL, /* transaction ID */
+ &count, /* #rows deleted */
+ 0))) { /* flags */
+ if (ret == DB_LOCK_DEADLOCK) {
+ /* txabort(tid); */
+ goto retry;
+ } else {
+ syslog(LOG_EMERG, "cdb_truncate(%d): %s\n", cdb, db_strerror(ret));
+ if (ret == ENOMEM) {
+ syslog(LOG_EMERG, "You may need to tune your database; please read http://www.citadel.org/doku.php?id=faq:troubleshooting:out_of_lock_entries for more information.");
+ }
+ exit(CTDLEXIT_DB);
+ }
+ } else {
+ /* txcommit(tid); */
+ }
+ }
+}
+
+int SeentDebugEnabled = 0;
+
+#define DBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (SeentDebugEnabled != 0))
+#define SEENM_syslog(LEVEL, FORMAT) \
+ DBGLOG(LEVEL) syslog(LEVEL, \
+ "IO[%ld]CC[%ld] SEEN[%s][%d] " FORMAT, \
+ ioid, ccid, Facility, cType)
+
+time_t CheckIfAlreadySeen(const char *Facility,
+ StrBuf *guid,
+ time_t now,
+ time_t antiexpire,
+ eCheckType cType,
+ long ccid,
+ long ioid)
+{
+ struct UseTable ut;
+ struct cdbdata *cdbut;
+
+ if (cType != eWrite)
+ {
+ time_t InDBTimeStamp = 0;
+ SEENM_syslog(LOG_DEBUG, "Loading");
+ cdbut = cdb_fetch(CDB_USETABLE, SKEY(guid));
+ if (cdbut != NULL) {
+ memcpy(&ut, cdbut->ptr,
+ ((cdbut->len > sizeof(struct UseTable)) ?
+ sizeof(struct UseTable) : cdbut->len));
+
+ if (ut.ut_timestamp > antiexpire)
+ {
+ SEENM_syslog(LOG_DEBUG, "Found - Not expired.");
+ cdb_free(cdbut);
+ return ut.ut_timestamp;
+ }
+ else
+ {
+ SEENM_syslog(LOG_DEBUG, "Found - Expired.");
+ InDBTimeStamp = ut.ut_timestamp;
+ cdb_free(cdbut);
+ }
+ }
+ else
+ {
+ SEENM_syslog(LOG_DEBUG, "not Found");
+ }
+
+ if (cType == eCheckExist)
+ return InDBTimeStamp;
+ }
+
+ memcpy(ut.ut_msgid, SKEY(guid));
+ ut.ut_timestamp = now;
+
+ SEENM_syslog(LOG_DEBUG, "Saving");
+ /* rewrite the record anyway, to update the timestamp */
+ cdb_store(CDB_USETABLE,
+ SKEY(guid),
+ &ut, sizeof(struct UseTable) );
+
+ SEENM_syslog(LOG_DEBUG, "Done Saving");
+ return 0;
+}
+
+
+void LogDebugEnableSeenEnable(const int n)
+{
+ SeentDebugEnabled = n;
+}
+
+CTDL_MODULE_INIT(database)
+{
+ if (!threading)
+ {
+ CtdlRegisterDebugFlagHook(HKEY("SeenDebug"), LogDebugEnableSeenEnable, &SeentDebugEnabled);
+ }
+
+ /* return our module id for the log */
+ return "database";
+}
projects / citadel.git / blobdiff