2 * This is a data store backend for the Citadel server which uses Berkeley DB.
4 * Copyright (c) 1987-2018 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
15 /*****************************************************************************
16 Tunable configuration parameters for the Berkeley DB back end
17 *****************************************************************************/
19 /* Citadel will checkpoint the db at the end of every session, but only if
20 * the specified number of kilobytes has been written, or if the specified
21 * number of minutes has passed, since the last checkpoint.
23 #define MAX_CHECKPOINT_KBYTES 256
24 #define MAX_CHECKPOINT_MINUTES 15
26 /*****************************************************************************/
38 #elif defined(HAVE_DB4_DB_H)
41 #error Neither <db.h> nor <db5/db.h> was found by configure. Install db5-devel.
44 #if DB_VERSION_MAJOR < 5
45 #error Citadel requires Berkeley DB v5.0 or newer. Please upgrade.
48 #include <libcitadel.h>
50 #include "ctdl_module.h"
52 #include "citserver.h"
55 static DB *dbp[MAXCDB]; /* One DB handle for each Citadel database */
56 static DB_ENV *dbenv; /* The DB environment (global) */
61 syslog(LOG_DEBUG, "db: citserver is stopping in order to prevent data loss. uid=%d gid=%d euid=%d egid=%d",
62 getuid(), getgid(), geteuid(), getegid()
68 /* Verbose logging callback */
69 void cdb_verbose_log(const DB_ENV * dbenv, const char *msg)
71 if (!IsEmptyStr(msg)) {
72 syslog(LOG_DEBUG, "db: %s", msg);
77 /* Verbose logging callback */
78 void cdb_verbose_err(const DB_ENV * dbenv, const char *errpfx, const char *msg)
80 syslog(LOG_ERR, "db: %s", msg);
84 /* just a little helper function */
85 static void txabort(DB_TXN * tid)
89 ret = tid->abort(tid);
92 syslog(LOG_ERR, "db: txn_abort: %s", db_strerror(ret));
98 /* this one is even more helpful than the last. */
99 static void txcommit(DB_TXN * tid)
103 ret = tid->commit(tid, 0);
106 syslog(LOG_ERR, "db: txn_commit: %s", db_strerror(ret));
112 /* are you sensing a pattern yet? */
113 static void txbegin(DB_TXN ** tid)
117 ret = dbenv->txn_begin(dbenv, NULL, tid, 0);
120 syslog(LOG_ERR, "db: txn_begin: %s", db_strerror(ret));
126 static void dbpanic(DB_ENV * env, int errval)
128 syslog(LOG_ERR, "db: PANIC: %s", db_strerror(errval));
132 static void cclose(DBC * cursor)
136 if ((ret = cursor->c_close(cursor))) {
137 syslog(LOG_ERR, "db: c_close: %s", db_strerror(ret));
143 static void bailIfCursor(DBC ** cursors, const char *msg)
147 for (i = 0; i < MAXCDB; i++)
148 if (cursors[i] != NULL) {
149 syslog(LOG_ERR, "db: cursor still in progress on cdb %02x: %s", i, msg);
155 void cdb_check_handles(void)
157 bailIfCursor(TSD->cursors, "in check_handles");
159 if (TSD->tid != NULL) {
160 syslog(LOG_ERR, "db: transaction still in progress!");
167 * Request a checkpoint of the database. Called once per minute by the thread manager.
169 void cdb_checkpoint(void)
173 syslog(LOG_DEBUG, "db: -- checkpoint --");
174 ret = dbenv->txn_checkpoint(dbenv, MAX_CHECKPOINT_KBYTES, MAX_CHECKPOINT_MINUTES, 0);
177 syslog(LOG_ERR, "db: cdb_checkpoint() txn_checkpoint: %s", db_strerror(ret));
181 /* After a successful checkpoint, we can cull the unused logs */
182 if (CtdlGetConfigInt("c_auto_cull")) {
183 ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 1);
186 ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 0);
192 * Open the various databases we'll be using. Any database which
193 * does not exist should be created. Note that we don't need a
194 * critical section here, because there aren't any active threads
195 * manipulating the database yet.
197 void open_databases(void)
203 int dbversion_major, dbversion_minor, dbversion_patch;
205 syslog(LOG_DEBUG, "db: open_databases() starting");
206 syslog(LOG_DEBUG, "db: Compiled libdb: %s", DB_VERSION_STRING);
207 syslog(LOG_DEBUG, "db: Linked libdb: %s", db_version(&dbversion_major, &dbversion_minor, &dbversion_patch));
208 syslog(LOG_DEBUG, "db: Linked zlib: %s", zlibVersion());
211 * Silently try to create the database subdirectory. If it's
212 * already there, no problem.
214 if ((mkdir(ctdl_data_dir, 0700) != 0) && (errno != EEXIST)) {
215 syslog(LOG_ERR, "db: unable to create database directory [%s]: %m", ctdl_data_dir);
217 if (chmod(ctdl_data_dir, 0700) != 0) {
218 syslog(LOG_ERR, "db: unable to set database directory accessrights [%s]: %m", ctdl_data_dir);
220 if (chown(ctdl_data_dir, CTDLUID, (-1)) != 0) {
221 syslog(LOG_ERR, "db: unable to set the owner for [%s]: %m", ctdl_data_dir);
223 syslog(LOG_DEBUG, "db: Setting up DB environment\n");
224 /* db_env_set_func_yield((int (*)(u_long, u_long))sched_yield); */
225 ret = db_env_create(&dbenv, 0);
227 syslog(LOG_ERR, "db: db_env_create: %s", db_strerror(ret));
228 syslog(LOG_ERR, "db: exit code %d", ret);
231 dbenv->set_errpfx(dbenv, "citserver");
232 dbenv->set_paniccall(dbenv, dbpanic);
233 dbenv->set_errcall(dbenv, cdb_verbose_err);
234 dbenv->set_errpfx(dbenv, "ctdl");
235 dbenv->set_msgcall(dbenv, cdb_verbose_log);
236 dbenv->set_verbose(dbenv, DB_VERB_DEADLOCK, 1);
237 dbenv->set_verbose(dbenv, DB_VERB_RECOVERY, 1);
240 * We want to specify the shared memory buffer pool cachesize,
241 * but everything else is the default.
243 ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
245 syslog(LOG_ERR, "db: set_cachesize: %s", db_strerror(ret));
246 dbenv->close(dbenv, 0);
247 syslog(LOG_ERR, "db: exit code %d", ret);
251 if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
252 syslog(LOG_ERR, "db: set_lk_detect: %s", db_strerror(ret));
253 dbenv->close(dbenv, 0);
254 syslog(LOG_ERR, "db: exit code %d", ret);
258 flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_INIT_LOG;
259 syslog(LOG_DEBUG, "db: dbenv->open(dbenv, %s, %d, 0)", ctdl_data_dir, flags);
260 ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
261 if (ret == DB_RUNRECOVERY) {
262 syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
263 syslog(LOG_ERR, "db: attempting recovery...");
265 ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
267 if (ret == DB_RUNRECOVERY) {
268 syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
269 syslog(LOG_ERR, "db: attempting catastrophic recovery...");
270 flags &= ~DB_RECOVER;
271 flags |= DB_RECOVER_FATAL;
272 ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
275 syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
276 dbenv->close(dbenv, 0);
277 syslog(LOG_ERR, "db: exit code %d", ret);
281 syslog(LOG_INFO, "db: mounting databases");
283 for (i = 0; i < MAXCDB; ++i) {
285 /* Create a database handle */
286 ret = db_create(&dbp[i], dbenv, 0);
288 syslog(LOG_ERR, "db: db_create: %s", db_strerror(ret));
289 syslog(LOG_ERR, "db: exit code %d", ret);
294 /* Arbitrary names for our tables -- we reference them by
295 * number, so we don't have string names for them.
297 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);
299 ret = dbp[i]->open(dbp[i], NULL, dbfilename, NULL, DB_BTREE, DB_CREATE | DB_AUTO_COMMIT | DB_THREAD, 0600);
301 syslog(LOG_ERR, "db: db_open[%02x]: %s", i, db_strerror(ret));
304 "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.");
306 syslog(LOG_ERR, "db: exit code %d", ret);
314 /* Make sure we own all the files, because in a few milliseconds
315 * we're going to drop root privs.
317 void cdb_chmod_data(void)
321 char filename[PATH_MAX];
323 dp = opendir(ctdl_data_dir);
325 while (d = readdir(dp), d != NULL) {
326 if (d->d_name[0] != '.') {
327 snprintf(filename, sizeof filename, "%s/%s", ctdl_data_dir, d->d_name);
328 syslog(LOG_DEBUG, "db: chmod(%s, 0600) returned %d", filename, chmod(filename, 0600));
329 syslog(LOG_DEBUG, "db: chown(%s, CTDLUID, -1) returned %d",
330 filename, chown(filename, CTDLUID, (-1))
337 syslog(LOG_DEBUG, "db: open_databases() finished");
342 * Close all of the db database files we've opened. This can be done
343 * in a loop, since it's just a bunch of closes.
345 void close_databases(void)
350 syslog(LOG_INFO, "db: performing final checkpoint");
351 if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) {
352 syslog(LOG_ERR, "txn_checkpoint: %s", db_strerror(ret));
355 syslog(LOG_INFO, "db: flushing the database logs");
356 if ((ret = dbenv->log_flush(dbenv, NULL))) {
357 syslog(LOG_ERR, "db: log_flush: %s", db_strerror(ret));
360 /* print some statistics... */
362 dbenv->lock_stat_print(dbenv, DB_STAT_ALL);
365 /* close the tables */
366 for (a = 0; a < MAXCDB; ++a) {
367 syslog(LOG_INFO, "db: closing database %02x", a);
368 ret = dbp[a]->close(dbp[a], 0);
370 syslog(LOG_ERR, "db: db_close: %s", db_strerror(ret));
375 /* Close the handle. */
376 ret = dbenv->close(dbenv, 0);
378 syslog(LOG_EMERG, "db: DBENV->close: %s", db_strerror(ret));
384 * Decompress a database item if it was compressed on disk
386 void cdb_decompress_if_necessary(struct cdbdata *cdb)
388 static int magic = COMPRESS_MAGIC;
390 if ((cdb == NULL) || (cdb->ptr == NULL) || (cdb->len < sizeof(magic)) || (memcmp(cdb->ptr, &magic, sizeof(magic)))) {
394 /* At this point we know we're looking at a compressed item. */
396 struct CtdlCompressHeader zheader;
397 char *uncompressed_data;
398 char *compressed_data;
399 uLongf destLen, sourceLen;
402 memset(&zheader, 0, sizeof(struct CtdlCompressHeader));
403 cplen = sizeof(struct CtdlCompressHeader);
404 if (sizeof(struct CtdlCompressHeader) > cdb->len)
406 memcpy(&zheader, cdb->ptr, cplen);
408 compressed_data = cdb->ptr;
409 compressed_data += sizeof(struct CtdlCompressHeader);
411 sourceLen = (uLongf) zheader.compressed_len;
412 destLen = (uLongf) zheader.uncompressed_len;
413 uncompressed_data = malloc(zheader.uncompressed_len);
415 if (uncompress((Bytef *) uncompressed_data,
416 (uLongf *) & destLen, (const Bytef *) compressed_data, (uLong) sourceLen) != Z_OK) {
417 syslog(LOG_EMERG, "db: uncompress() error");
422 cdb->len = (size_t) destLen;
423 cdb->ptr = uncompressed_data;
428 * Store a piece of data. Returns 0 if the operation was successful. If a
429 * key already exists it should be overwritten.
431 int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen)
438 struct CtdlCompressHeader zheader;
439 char *compressed_data = NULL;
441 size_t buffer_len = 0;
444 memset(&dkey, 0, sizeof(DBT));
445 memset(&ddata, 0, sizeof(DBT));
447 dkey.data = (void *) ckey;
448 ddata.size = cdatalen;
451 /* Only compress Visit and UseTable records. Everything else is uncompressed. */
452 if ((cdb == CDB_VISIT) || (cdb == CDB_USETABLE)) {
454 zheader.magic = COMPRESS_MAGIC;
455 zheader.uncompressed_len = cdatalen;
456 buffer_len = ((cdatalen * 101) / 100) + 100 + sizeof(struct CtdlCompressHeader);
457 destLen = (uLongf) buffer_len;
458 compressed_data = malloc(buffer_len);
459 if (compress2((Bytef *) (compressed_data + sizeof(struct CtdlCompressHeader)),
460 &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK) {
461 syslog(LOG_EMERG, "db: compress2() error");
464 zheader.compressed_len = (size_t) destLen;
465 memcpy(compressed_data, &zheader, sizeof(struct CtdlCompressHeader));
466 ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) + zheader.compressed_len);
467 ddata.data = compressed_data;
470 if (TSD->tid != NULL) {
471 ret = dbp[cdb]->put(dbp[cdb], /* db */
472 TSD->tid, /* transaction ID */
478 syslog(LOG_EMERG, "db: cdb_store(%d): %s", cdb, db_strerror(ret));
482 free(compressed_data);
486 bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
491 if ((ret = dbp[cdb]->put(dbp[cdb], /* db */
492 tid, /* transaction ID */
496 if (ret == DB_LOCK_DEADLOCK) {
500 syslog(LOG_EMERG, "db: cdb_store(%d): %s", cdb, db_strerror(ret));
506 free(compressed_data);
516 * Delete a piece of data. Returns 0 if the operation was successful.
518 int cdb_delete(int cdb, void *key, int keylen)
525 memset(&dkey, 0, sizeof dkey);
529 if (TSD->tid != NULL) {
530 ret = dbp[cdb]->del(dbp[cdb], TSD->tid, &dkey, 0);
532 syslog(LOG_EMERG, "db: cdb_delete(%d): %s", cdb, db_strerror(ret));
533 if (ret != DB_NOTFOUND) {
538 bailIfCursor(TSD->cursors, "attempt to delete during r/o cursor");
543 if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0)) && ret != DB_NOTFOUND) {
544 if (ret == DB_LOCK_DEADLOCK) {
548 syslog(LOG_EMERG, "db: cdb_delete(%d): %s", cdb, db_strerror(ret));
559 static DBC *localcursor(int cdb)
564 if (TSD->cursors[cdb] == NULL) {
565 ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &curs, 0);
568 ret = TSD->cursors[cdb]->c_dup(TSD->cursors[cdb], &curs, DB_POSITION);
572 syslog(LOG_EMERG, "db: localcursor: %s", db_strerror(ret));
581 * Fetch a piece of data. If not found, returns NULL. Otherwise, it returns
582 * a struct cdbdata which it is the caller's responsibility to free later on
583 * using the cdb_free() routine.
585 struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen)
587 struct cdbdata *tempcdb;
591 memset(&dkey, 0, sizeof(DBT));
593 dkey.data = (void *) key;
595 if (TSD->tid != NULL) {
596 memset(&dret, 0, sizeof(DBT));
597 dret.flags = DB_DBT_MALLOC;
598 ret = dbp[cdb]->get(dbp[cdb], TSD->tid, &dkey, &dret, 0);
603 memset(&dret, 0, sizeof(DBT));
604 dret.flags = DB_DBT_MALLOC;
606 curs = localcursor(cdb);
608 ret = curs->c_get(curs, &dkey, &dret, DB_SET);
611 while (ret == DB_LOCK_DEADLOCK);
615 if ((ret != 0) && (ret != DB_NOTFOUND)) {
616 syslog(LOG_EMERG, "db: cdb_fetch(%d): %s", cdb, db_strerror(ret));
624 tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata));
626 if (tempcdb == NULL) {
627 syslog(LOG_EMERG, "db: cdb_fetch: Cannot allocate memory for tempcdb");
629 return NULL; /* make it easier for static analysis... */
631 tempcdb->len = dret.size;
632 tempcdb->ptr = dret.data;
633 cdb_decompress_if_necessary(tempcdb);
640 * Free a cdbdata item.
642 * Note that we only free the 'ptr' portion if it is not NULL. This allows
643 * other code to assume ownership of that memory simply by storing the
644 * pointer elsewhere and then setting 'ptr' to NULL. cdb_free() will then
647 void cdb_free(struct cdbdata *cdb)
656 void cdb_close_cursor(int cdb)
658 if (TSD->cursors[cdb] != NULL) {
659 cclose(TSD->cursors[cdb]);
662 TSD->cursors[cdb] = NULL;
667 * Prepare for a sequential search of an entire database.
668 * (There is guaranteed to be no more than one traversal in
669 * progress per thread at any given time.)
671 void cdb_rewind(int cdb)
675 if (TSD->cursors[cdb] != NULL) {
676 syslog(LOG_EMERG, "db: cdb_rewind: must close cursor on database %d before reopening", cdb);
678 /* cclose(TSD->cursors[cdb]); */
682 * Now initialize the cursor
684 ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &TSD->cursors[cdb], 0);
686 syslog(LOG_EMERG, "db: cdb_rewind: db_cursor: %s", db_strerror(ret));
693 * Fetch the next item in a sequential search. Returns a pointer to a
694 * cdbdata structure, or NULL if we've hit the end.
696 struct cdbdata *cdb_next_item(int cdb)
699 struct cdbdata *cdbret;
702 /* Initialize the key/data pair so the flags aren't set. */
703 memset(&key, 0, sizeof(key));
704 memset(&data, 0, sizeof(data));
705 data.flags = DB_DBT_MALLOC;
707 ret = TSD->cursors[cdb]->c_get(TSD->cursors[cdb], &key, &data, DB_NEXT);
710 if (ret != DB_NOTFOUND) {
711 syslog(LOG_EMERG, "db: cdb_next_item(%d): %s", cdb, db_strerror(ret));
714 cdb_close_cursor(cdb);
715 return NULL; /* presumably, end of file */
718 cdbret = (struct cdbdata *) malloc(sizeof(struct cdbdata));
719 cdbret->len = data.size;
720 cdbret->ptr = data.data;
721 cdb_decompress_if_necessary(cdbret);
728 * Transaction-based stuff. I'm writing this as I bake cookies...
730 void cdb_begin_transaction(void)
733 bailIfCursor(TSD->cursors, "can't begin transaction during r/o cursor");
735 if (TSD->tid != NULL) {
736 syslog(LOG_EMERG, "db: cdb_begin_transaction: ERROR: nested transaction");
744 void cdb_end_transaction(void)
748 for (i = 0; i < MAXCDB; i++)
749 if (TSD->cursors[i] != NULL) {
750 syslog(LOG_WARNING, "db: cdb_end_transaction: WARNING: cursor %d still open at transaction end", i);
751 cclose(TSD->cursors[i]);
752 TSD->cursors[i] = NULL;
755 if (TSD->tid == NULL) {
756 syslog(LOG_ERR, "db: cdb_end_transaction: ERROR: txcommit(NULL) !!");
767 * Truncate (delete every record)
769 void cdb_trunc(int cdb)
775 if (TSD->tid != NULL) {
776 syslog(LOG_EMERG, "db: cdb_trunc must not be called in a transaction.");
779 bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
784 if ((ret = dbp[cdb]->truncate(dbp[cdb], /* db */
785 NULL, /* transaction ID */
786 &count, /* #rows deleted */
788 if (ret == DB_LOCK_DEADLOCK) {
792 syslog(LOG_EMERG, "db: cdb_truncate(%d): %s", cdb, db_strerror(ret));
795 "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.");
807 * compact (defragment) the database , possibly returning space back to the underlying filesystem
809 void cdb_compact(void)
814 syslog(LOG_DEBUG, "db: cdb_compact() started");
815 for (i = 0; i < MAXCDB; i++) {
816 syslog(LOG_DEBUG, "db: compacting database %d", i);
817 ret = dbp[i]->compact(dbp[i], NULL, NULL, NULL, NULL, DB_FREE_SPACE, NULL);
819 syslog(LOG_ERR, "db: compact: %s", db_strerror(ret));
822 syslog(LOG_DEBUG, "db: cdb_compact() finished");
826 // Has an item already been seen (is it in the CDB_USETABLE) ?
827 // Returns 0 if it hasn't, 1 if it has
828 // In either case, writes the item to the database for next time.
829 int CheckIfAlreadySeen(StrBuf *guid)
833 struct cdbdata *cdbut;
835 syslog(LOG_DEBUG, "db: CheckIfAlreadySeen(%s)", ChrPtr(guid));
836 cdbut = cdb_fetch(CDB_USETABLE, SKEY(guid));
842 /* (Re)write the record, to update the timestamp. Zeroing it out makes it compress better. */
843 memset(&ut, 0, sizeof(struct UseTable));
844 memcpy(ut.ut_msgid, SKEY(guid));
845 ut.ut_timestamp = time(NULL);
846 cdb_store(CDB_USETABLE, SKEY(guid), &ut, sizeof(struct UseTable));
851 void cmd_rsen(char *argbuf)
858 struct cdbdata *cdbut;
860 if (CtdlAccessCheck(ac_aide)) {
864 TLen = extract_token(Token, argbuf, 1, '|', sizeof Token);
865 if (strncmp(argbuf, "GET", 3) == 0) {
866 cdbut = cdb_fetch(CDB_USETABLE, Token, TLen);
868 memcpy(&ut, cdbut->ptr, ((cdbut->len > sizeof(struct UseTable)) ? sizeof(struct UseTable) : cdbut->len));
870 cprintf("%d %ld\n", CIT_OK, ut.ut_timestamp);
872 cprintf("%d not found\n", ERROR + NOT_HERE);
875 } else if (strncmp(argbuf, "SET", 3) == 0) {
876 memcpy(ut.ut_msgid, Token, TLen);
877 extract_token(Time, argbuf, 2, '|', sizeof Time);
878 ut.ut_timestamp = atol(Time);
879 cdb_store(CDB_USETABLE, Token, TLen, &ut, sizeof(struct UseTable));
880 cprintf("%d token updated\n", CIT_OK);
881 } else if (strncmp(argbuf, "DEL", 3) == 0) {
882 if (cdb_delete(CDB_USETABLE, Token, TLen))
883 cprintf("%d not found\n", ERROR + NOT_HERE);
885 cprintf("%d deleted.\n", CIT_OK);
888 cprintf("%d Usage: [GET|SET|DEL]|Token|timestamp\n", ERROR);
894 CTDL_MODULE_INIT(database)
897 CtdlRegisterProtoHook(cmd_rsen, "RSEN", "manipulate Aggregators seen database");
900 /* return our module id for the log */