/*
* This is a data store backend for the Citadel server which uses Berkeley DB.
*
- * Copyright (c) 1987-2018 by the citadel.org team
+ * Copyright (c) 1987-2019 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.
#include <dirent.h>
#include <zlib.h>
-#ifdef HAVE_DB_H
#include <db.h>
-#elif defined(HAVE_DB4_DB_H)
-#include <db5/db.h>
-#else
-#error Neither <db.h> nor <db5/db.h> was found by configure. Install db5-devel.
-#endif
#if DB_VERSION_MAJOR < 5
#error Citadel requires Berkeley DB v5.0 or newer. Please upgrade.
}
-/* just a little helper function */
+/* wrapper for txn_abort() that logs/aborts on error */
static void txabort(DB_TXN * tid)
{
int ret;
}
-/* this one is even more helpful than the last. */
+/* wrapper for txn_commit() that logs/aborts on error */
static void txcommit(DB_TXN * tid)
{
int ret;
}
-/* are you sensing a pattern yet? */
+/* wrapper for txn_begin() that logs/aborts on error */
static void txbegin(DB_TXN ** tid)
{
int ret;
}
+/* panic callback */
static void dbpanic(DB_ENV * env, int errval)
{
syslog(LOG_ERR, "db: PANIC: %s", db_strerror(errval));
}
-/*
- * Cull the database logs by removing log files that are no longer needed.
- * Note: this code will be removed once we are confident that Berkeley DB can do this on its own.
- */
-void cdb_cull_logs(void)
-{
-#ifndef DB_LOG_AUTO_REMOVE
- 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, "db: 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, "db: 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);
- }
-#endif /* DB_LOG_AUTO_REMOVE */
-}
-
-
/*
* Request a checkpoint of the database. Called once per minute by the thread manager.
*/
/* After a successful checkpoint, we can cull the unused logs */
if (CtdlGetConfigInt("c_auto_cull")) {
-#ifdef DB_LOG_AUTO_REMOVE
- // This version of Berkeley DB can cull the logs on its own!
ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 1);
-#else
- cdb_cull_logs(); // Citadel knows how to do it too.
-#endif
}
-#ifdef DB_LOG_AUTO_REMOVE
else {
ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 0);
}
-#endif
}
syslog(LOG_DEBUG, "db: Linked zlib: %s", zlibVersion());
/*
- * Silently try to create the database subdirectory. If it's
- * already there, no problem.
+ * 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_ERR, "db: unable to create database directory [%s]: %m", ctdl_data_dir);
}
if (chmod(ctdl_data_dir, 0700) != 0) {
- syslog(LOG_ERR, "db: unable to set database directory accessrights [%s]: %m", ctdl_data_dir);
+ syslog(LOG_ERR, "db: unable to set database directory permissions [%s]: %m", ctdl_data_dir);
}
if (chown(ctdl_data_dir, CTDLUID, (-1)) != 0) {
syslog(LOG_ERR, "db: unable to set the owner for [%s]: %m", ctdl_data_dir);
}
- syslog(LOG_DEBUG, "db: Setting up DB environment\n");
- /* db_env_set_func_yield((int (*)(u_long, u_long))sched_yield); */
+ syslog(LOG_DEBUG, "db: Setting up DB environment");
+ // db_env_set_func_yield((int (*)(u_long, u_long))sched_yield);
ret = db_env_create(&dbenv, 0);
if (ret) {
syslog(LOG_ERR, "db: db_env_create: %s", db_strerror(ret));
flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_INIT_LOG;
syslog(LOG_DEBUG, "db: dbenv->open(dbenv, %s, %d, 0)", ctdl_data_dir, flags);
- ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
+ ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); // try opening the database cleanly
if (ret == DB_RUNRECOVERY) {
syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
syslog(LOG_ERR, "db: attempting recovery...");
flags |= DB_RECOVER;
- ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
+ ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); // try recovery
}
if (ret == DB_RUNRECOVERY) {
syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
syslog(LOG_ERR, "db: attempting catastrophic recovery...");
flags &= ~DB_RECOVER;
flags |= DB_RECOVER_FATAL;
- ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
+ ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); // try catastrophic recovery
}
if (ret) {
syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
}
syslog(LOG_INFO, "db: mounting databases");
-
for (i = 0; i < MAXCDB; ++i) {
-
- /* Create a database handle */
- ret = db_create(&dbp[i], dbenv, 0);
+ ret = db_create(&dbp[i], dbenv, 0); // Create a database handle
if (ret) {
syslog(LOG_ERR, "db: db_create: %s", db_strerror(ret));
syslog(LOG_ERR, "db: exit code %d", ret);
exit(CTDLEXIT_DB);
}
-
- /* 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);
-
+ snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i); // table names by number
ret = dbp[i]->open(dbp[i], NULL, dbfilename, NULL, DB_BTREE, DB_CREATE | DB_AUTO_COMMIT | DB_THREAD, 0600);
if (ret) {
syslog(LOG_ERR, "db: db_open[%02x]: %s", i, db_strerror(ret));
if (ret == ENOMEM) {
- syslog(LOG_ERR,
- "db: 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_ERR, "db: 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_ERR, "db: exit code %d", ret);
exit(CTDLEXIT_DB);
}
}
-
}
-/* Make sure we own all the files, because in a few milliseconds
- * we're going to drop root privs.
+/*
+ * Make sure we own all the files, because in a few milliseconds we're going to drop root privs.
*/
void cdb_chmod_data(void)
{
}
closedir(dp);
}
-
- syslog(LOG_DEBUG, "db: open_databases() finished");
}
*/
void close_databases(void)
{
- int a;
+ int i;
int ret;
syslog(LOG_INFO, "db: performing final checkpoint");
syslog(LOG_ERR, "db: log_flush: %s", db_strerror(ret));
}
- /* print some statistics... */
#ifdef DB_STAT_ALL
+ /* print some statistics... */
dbenv->lock_stat_print(dbenv, DB_STAT_ALL);
#endif
/* close the tables */
- for (a = 0; a < MAXCDB; ++a) {
- syslog(LOG_INFO, "db: closing database %02x", a);
- ret = dbp[a]->close(dbp[a], 0);
+ syslog(LOG_INFO, "db: closing databases");
+ for (i = 0; i < MAXCDB; ++i) {
+ syslog(LOG_INFO, "db: closing database %02x", i);
+ ret = dbp[i]->close(dbp[i], 0);
if (ret) {
syslog(LOG_ERR, "db: db_close: %s", db_strerror(ret));
}
memset(&zheader, 0, sizeof(struct CtdlCompressHeader));
cplen = sizeof(struct CtdlCompressHeader);
- if (sizeof(struct CtdlCompressHeader) > cdb->len)
+ if (sizeof(struct CtdlCompressHeader) > cdb->len) {
cplen = cdb->len;
+ }
memcpy(&zheader, cdb->ptr, cplen);
compressed_data = cdb->ptr;
}
if (TSD->tid != NULL) {
- ret = dbp[cdb]->put(dbp[cdb], /* db */
- TSD->tid, /* transaction ID */
- &dkey, /* key */
- &ddata, /* data */
- 0 /* flags */
+ ret = dbp[cdb]->put(dbp[cdb], // db
+ TSD->tid, // transaction ID
+ &dkey, // key
+ &ddata, // data
+ 0 // flags
);
if (ret) {
syslog(LOG_EMERG, "db: cdb_store(%d): %s", cdb, db_strerror(ret));
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);
+ ret = dbp[cdb]->get(dbp[cdb], TSD->tid, &dkey, &dret, 0); // crashing here
} 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)) {
projects / citadel.git / blobdiff