4 * Sleepycat (Berkeley) DB driver for Citadel
8 /*****************************************************************************
9 Tunable configuration parameters for the Sleepycat DB back end
10 *****************************************************************************/
12 /* Citadel will checkpoint the db at the end of every session, but only if
13 * the specified number of kilobytes has been written, or if the specified
14 * number of minutes has passed, since the last checkpoint.
16 #define MAX_CHECKPOINT_KBYTES 256
17 #define MAX_CHECKPOINT_MINUTES 15
19 /*****************************************************************************/
28 #include <sys/types.h>
34 #elif defined(HAVE_DB4_DB_H)
37 #error Neither <db.h> nor <db4/db.h> was found by configure. Install db4-devel.
41 #if DB_VERSION_MAJOR < 4 || DB_VERSION_MINOR < 1
42 #error Citadel requires Berkeley DB v4.1 or newer. Please upgrade.
49 #include "citserver.h"
52 #include "sysdep_decls.h"
55 #include "ctdl_module.h"
58 static DB *dbp[MAXCDB]; /* One DB handle for each Citadel database */
59 static DB_ENV *dbenv; /* The DB environment (global) */
61 struct cdbtsd { /* Thread-specific DB stuff */
62 DB_TXN *tid; /* Transaction handle */
63 DBC *cursors[MAXCDB]; /* Cursors, for traversals... */
70 static pthread_key_t tsdkey;
72 #define MYCURSORS (((struct cdbtsd*)pthread_getspecific(tsdkey))->cursors)
73 #define MYTID (((struct cdbtsd*)pthread_getspecific(tsdkey))->tid)
75 /* Verbose logging callback */
76 void cdb_verbose_log(const DB_ENV *dbenv, const char *msg)
78 lprintf(CTDL_DEBUG, "BDB: %s\n", msg);
82 /* Verbose logging callback */
83 void cdb_verbose_err(const DB_ENV *dbenv, const char *errpfx, const char *msg)
85 lprintf(CTDL_ALERT, "BDB: %s\n", msg);
89 /* just a little helper function */
90 static void txabort(DB_TXN * tid)
94 ret = tid->abort(tid);
97 lprintf(CTDL_EMERG, "cdb_*: txn_abort: %s\n",
103 /* this one is even more helpful than the last. */
104 static void txcommit(DB_TXN * tid)
108 ret = tid->commit(tid, 0);
111 lprintf(CTDL_EMERG, "cdb_*: txn_commit: %s\n",
117 /* are you sensing a pattern yet? */
118 static void txbegin(DB_TXN ** tid)
122 ret = dbenv->txn_begin(dbenv, NULL, tid, 0);
125 lprintf(CTDL_EMERG, "cdb_*: txn_begin: %s\n",
131 static void dbpanic(DB_ENV * env, int errval)
133 lprintf(CTDL_EMERG, "cdb_*: Berkeley DB panic: %d\n", errval);
136 static void cclose(DBC * cursor)
140 if ((ret = cursor->c_close(cursor))) {
141 lprintf(CTDL_EMERG, "cdb_*: c_close: %s\n",
147 static void bailIfCursor(DBC ** cursors, const char *msg)
151 for (i = 0; i < MAXCDB; i++)
152 if (cursors[i] != NULL) {
154 "cdb_*: cursor still in progress on cdb %d: %s\n",
160 static void check_handles(void *arg)
163 struct cdbtsd *tsd = (struct cdbtsd *) arg;
165 bailIfCursor(tsd->cursors, "in check_handles");
167 if (tsd->tid != NULL) {
169 "cdb_*: transaction still in progress!");
175 static void dest_tsd(void *arg)
184 * Ensure that we have a key for thread-specific data. We don't
185 * put anything in here that Citadel cares about; this is just database
186 * related stuff like cursors and transactions.
188 * This should be called immediately after startup by any thread which wants
189 * to use database calls, except for whatever thread calls open_databases.
191 void cdb_allocate_tsd(void)
195 if (pthread_getspecific(tsdkey) != NULL)
198 tsd = malloc(sizeof(struct cdbtsd));
202 memset(tsd->cursors, 0, sizeof tsd->cursors);
203 pthread_setspecific(tsdkey, tsd);
206 void cdb_free_tsd(void)
208 dest_tsd(pthread_getspecific(tsdkey));
209 pthread_setspecific(tsdkey, NULL);
212 void cdb_check_handles(void)
214 check_handles(pthread_getspecific(tsdkey));
219 * Reclaim unused space in the databases. We need to do each one of
220 * these discretely, rather than in a loop.
222 * This is a stub function in the Sleepycat DB backend, because there is no
223 * such API call available.
225 void defrag_databases(void)
232 * Cull the database logs
234 static void cdb_cull_logs(void)
243 /* Get the list of names. */
244 if ((ret = dbenv->log_archive(dbenv, &list, flags)) != 0) {
245 lprintf(CTDL_ERR, "cdb_cull_logs: %s\n", db_strerror(ret));
249 /* Print the list of names. */
251 for (file = list; *file != NULL; ++file) {
252 lprintf(CTDL_DEBUG, "Deleting log: %s\n", *file);
255 snprintf(errmsg, sizeof(errmsg),
256 " ** ERROR **\n \n \n "
257 "Citadel was unable to delete the "
258 "database log file '%s' because of the "
259 "following error:\n \n %s\n \n"
260 " This log file is no longer in use "
261 "and may be safely deleted.\n",
262 *file, strerror(errno));
263 aide_message(errmsg, "Database Warning Message");
271 * Manually initiate log file cull.
273 void cmd_cull(char *argbuf) {
274 if (CtdlAccessCheck(ac_internal)) return;
276 cprintf("%d Database log file cull completed.\n", CIT_OK);
281 * Request a checkpoint of the database.
283 static void cdb_checkpoint(void)
286 static time_t last_run = 0L;
288 /* Only do a checkpoint once per minute. */
289 if ((time(NULL) - last_run) < 60L) {
292 last_run = time(NULL);
294 lprintf(CTDL_DEBUG, "-- db checkpoint --\n");
295 ret = dbenv->txn_checkpoint(dbenv,
296 MAX_CHECKPOINT_KBYTES,
297 MAX_CHECKPOINT_MINUTES, 0);
300 lprintf(CTDL_EMERG, "cdb_checkpoint: txn_checkpoint: %s\n",
305 /* After a successful checkpoint, we can cull the unused logs */
306 if (config.c_auto_cull) {
313 * Main loop for the checkpoint thread.
315 void *checkpoint_thread(void *arg) {
316 struct CitContext checkpointCC;
318 lprintf(CTDL_DEBUG, "checkpoint_thread() initializing\n");
320 memset(&checkpointCC, 0, sizeof(struct CitContext));
321 checkpointCC.internal_pgm = 1;
322 checkpointCC.cs_pid = 0;
323 pthread_setspecific(MyConKey, (void *)&checkpointCC );
327 while (!time_to_die) {
332 lprintf(CTDL_DEBUG, "checkpoint_thread() exiting\n");
337 * Open the various databases we'll be using. Any database which
338 * does not exist should be created. Note that we don't need a
339 * critical section here, because there aren't any active threads
340 * manipulating the database yet.
342 void open_databases(void)
346 char dbfilename[SIZ];
349 lprintf(CTDL_DEBUG, "cdb_*: open_databases() starting\n");
350 lprintf(CTDL_DEBUG, "Compiled db: %s\n", DB_VERSION_STRING);
351 lprintf(CTDL_INFO, " Linked db: %s\n",
352 db_version(NULL, NULL, NULL));
354 lprintf(CTDL_INFO, "Linked zlib: %s\n", zlibVersion());
358 * Silently try to create the database subdirectory. If it's
359 * already there, no problem.
361 mkdir(ctdl_data_dir, 0700);
362 chmod(ctdl_data_dir, 0700);
363 chown(ctdl_data_dir, CTDLUID, (-1));
365 lprintf(CTDL_DEBUG, "cdb_*: Setting up DB environment\n");
366 db_env_set_func_yield(sched_yield);
367 ret = db_env_create(&dbenv, 0);
369 lprintf(CTDL_EMERG, "cdb_*: db_env_create: %s\n",
373 dbenv->set_errpfx(dbenv, "citserver");
374 dbenv->set_paniccall(dbenv, dbpanic);
375 dbenv->set_errcall(dbenv, cdb_verbose_err);
376 dbenv->set_errpfx(dbenv, "ctdl");
377 #if (DB_VERSION_MAJOR == 4) && (DB_VERSION_MINOR >= 3)
378 dbenv->set_msgcall(dbenv, cdb_verbose_log);
380 dbenv->set_verbose(dbenv, DB_VERB_DEADLOCK, 1);
381 dbenv->set_verbose(dbenv, DB_VERB_RECOVERY, 1);
384 * We want to specify the shared memory buffer pool cachesize,
385 * but everything else is the default.
387 ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
389 lprintf(CTDL_EMERG, "cdb_*: set_cachesize: %s\n",
391 dbenv->close(dbenv, 0);
395 if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
396 lprintf(CTDL_EMERG, "cdb_*: set_lk_detect: %s\n",
398 dbenv->close(dbenv, 0);
402 flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_RECOVER;
403 lprintf(CTDL_DEBUG, "dbenv->open(dbenv, %s, %d, 0)\n", ctdl_data_dir, flags);
404 ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
405 if (ret == DB_RUNRECOVERY) {
406 lprintf(CTDL_ALERT, "dbenv->open: %s\n", db_strerror(ret));
407 lprintf(CTDL_ALERT, "Attempting recovery...\n");
409 ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
411 if (ret == DB_RUNRECOVERY) {
412 lprintf(CTDL_ALERT, "dbenv->open: %s\n", db_strerror(ret));
413 lprintf(CTDL_ALERT, "Attempting catastrophic recovery...\n");
414 flags &= ~DB_RECOVER;
415 flags |= DB_RECOVER_FATAL;
416 ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
419 lprintf(CTDL_DEBUG, "dbenv->open: %s\n", db_strerror(ret));
420 dbenv->close(dbenv, 0);
424 lprintf(CTDL_INFO, "Starting up DB\n");
426 for (i = 0; i < MAXCDB; ++i) {
428 /* Create a database handle */
429 ret = db_create(&dbp[i], dbenv, 0);
431 lprintf(CTDL_DEBUG, "db_create: %s\n",
437 /* Arbitrary names for our tables -- we reference them by
438 * number, so we don't have string names for them.
440 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);
442 ret = dbp[i]->open(dbp[i],
447 DB_CREATE | DB_AUTO_COMMIT | DB_THREAD,
450 lprintf(CTDL_EMERG, "db_open[%d]: %s\n", i,
456 if ((ret = pthread_key_create(&tsdkey, dest_tsd))) {
457 lprintf(CTDL_EMERG, "pthread_key_create: %s\n",
464 CtdlRegisterMaintenanceThread ("checkpoint", checkpoint_thread);
468 /* Make sure we own all the files, because in a few milliseconds
469 * we're going to drop root privs.
471 void cdb_chmod_data(void) {
474 char filename[PATH_MAX];
476 dp = opendir(ctdl_data_dir);
478 while (d = readdir(dp), d != NULL) {
479 if (d->d_name[0] != '.') {
480 snprintf(filename, sizeof filename,
481 "%s/%s", ctdl_data_dir, d->d_name);
482 lprintf(9, "chmod(%s, 0600) returned %d\n",
483 filename, chmod(filename, 0600)
485 lprintf(9, "chown(%s, CTDLUID, -1) returned %d\n",
486 filename, chown(filename, CTDLUID, (-1))
493 lprintf(CTDL_DEBUG, "open_databases() finished\n");
495 CtdlRegisterProtoHook(cmd_cull, "CULL", "Cull database logs");
500 * Close all of the db database files we've opened. This can be done
501 * in a loop, since it's just a bunch of closes.
503 void close_databases(void)
510 if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) {
512 "txn_checkpoint: %s\n", db_strerror(ret));
515 /* print some statistics... */
517 dbenv->lock_stat_print(dbenv, DB_STAT_ALL);
520 /* close the tables */
521 for (a = 0; a < MAXCDB; ++a) {
522 lprintf(CTDL_INFO, "Closing database %d\n", a);
523 ret = dbp[a]->close(dbp[a], 0);
526 "db_close: %s\n", db_strerror(ret));
531 /* Close the handle. */
532 ret = dbenv->close(dbenv, 0);
535 "DBENV->close: %s\n", db_strerror(ret));
541 * Compression functions only used if we have zlib
545 void cdb_decompress_if_necessary(struct cdbdata *cdb)
547 static int magic = COMPRESS_MAGIC;
548 struct CtdlCompressHeader zheader;
549 char *uncompressed_data;
550 char *compressed_data;
551 uLongf destLen, sourceLen;
555 if (cdb->ptr == NULL)
557 if (memcmp(cdb->ptr, &magic, sizeof(magic)))
560 /* At this point we know we're looking at a compressed item. */
561 memcpy(&zheader, cdb->ptr, sizeof(struct CtdlCompressHeader));
563 compressed_data = cdb->ptr;
564 compressed_data += sizeof(struct CtdlCompressHeader);
566 sourceLen = (uLongf) zheader.compressed_len;
567 destLen = (uLongf) zheader.uncompressed_len;
568 uncompressed_data = malloc(zheader.uncompressed_len);
570 if (uncompress((Bytef *) uncompressed_data,
571 (uLongf *) & destLen,
572 (const Bytef *) compressed_data,
573 (uLong) sourceLen) != Z_OK) {
574 lprintf(CTDL_EMERG, "uncompress() error\n");
579 cdb->len = (size_t) destLen;
580 cdb->ptr = uncompressed_data;
583 #endif /* HAVE_ZLIB */
587 * Store a piece of data. Returns 0 if the operation was successful. If a
588 * key already exists it should be overwritten.
590 int cdb_store(int cdb, void *ckey, int ckeylen, void *cdata, int cdatalen)
598 struct CtdlCompressHeader zheader;
599 char *compressed_data = NULL;
601 size_t buffer_len = 0;
605 memset(&dkey, 0, sizeof(DBT));
606 memset(&ddata, 0, sizeof(DBT));
609 ddata.size = cdatalen;
613 /* Only compress Visit records. Everything else is uncompressed. */
614 if (cdb == CDB_VISIT) {
616 zheader.magic = COMPRESS_MAGIC;
617 zheader.uncompressed_len = cdatalen;
618 buffer_len = ((cdatalen * 101) / 100) + 100
619 + sizeof(struct CtdlCompressHeader);
620 destLen = (uLongf) buffer_len;
621 compressed_data = malloc(buffer_len);
622 if (compress2((Bytef *) (compressed_data +
624 CtdlCompressHeader)),
625 &destLen, (Bytef *) cdata, (uLongf) cdatalen,
627 lprintf(CTDL_EMERG, "compress2() error\n");
630 zheader.compressed_len = (size_t) destLen;
631 memcpy(compressed_data, &zheader,
632 sizeof(struct CtdlCompressHeader));
633 ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) +
634 zheader.compressed_len);
635 ddata.data = compressed_data;
640 ret = dbp[cdb]->put(dbp[cdb], /* db */
641 MYTID, /* transaction ID */
646 lprintf(CTDL_EMERG, "cdb_store(%d): %s\n", cdb,
652 free(compressed_data);
657 bailIfCursor(MYCURSORS,
658 "attempt to write during r/o cursor");
663 if ((ret = dbp[cdb]->put(dbp[cdb], /* db */
664 tid, /* transaction ID */
668 if (ret == DB_LOCK_DEADLOCK) {
672 lprintf(CTDL_EMERG, "cdb_store(%d): %s\n",
673 cdb, db_strerror(ret));
680 free(compressed_data);
689 * Delete a piece of data. Returns 0 if the operation was successful.
691 int cdb_delete(int cdb, void *key, int keylen)
698 memset(&dkey, 0, sizeof dkey);
703 ret = dbp[cdb]->del(dbp[cdb], MYTID, &dkey, 0);
705 lprintf(CTDL_EMERG, "cdb_delete(%d): %s\n", cdb,
707 if (ret != DB_NOTFOUND)
711 bailIfCursor(MYCURSORS,
712 "attempt to delete during r/o cursor");
717 if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0))
718 && ret != DB_NOTFOUND) {
719 if (ret == DB_LOCK_DEADLOCK) {
723 lprintf(CTDL_EMERG, "cdb_delete(%d): %s\n",
724 cdb, db_strerror(ret));
734 static DBC *localcursor(int cdb)
739 if (MYCURSORS[cdb] == NULL)
740 ret = dbp[cdb]->cursor(dbp[cdb], MYTID, &curs, 0);
743 MYCURSORS[cdb]->c_dup(MYCURSORS[cdb], &curs,
747 lprintf(CTDL_EMERG, "localcursor: %s\n", db_strerror(ret));
756 * Fetch a piece of data. If not found, returns NULL. Otherwise, it returns
757 * a struct cdbdata which it is the caller's responsibility to free later on
758 * using the cdb_free() routine.
760 struct cdbdata *cdb_fetch(int cdb, void *key, int keylen)
763 struct cdbdata *tempcdb;
767 memset(&dkey, 0, sizeof(DBT));
772 memset(&dret, 0, sizeof(DBT));
773 dret.flags = DB_DBT_MALLOC;
774 ret = dbp[cdb]->get(dbp[cdb], MYTID, &dkey, &dret, 0);
779 memset(&dret, 0, sizeof(DBT));
780 dret.flags = DB_DBT_MALLOC;
782 curs = localcursor(cdb);
784 ret = curs->c_get(curs, &dkey, &dret, DB_SET);
787 while (ret == DB_LOCK_DEADLOCK);
791 if ((ret != 0) && (ret != DB_NOTFOUND)) {
792 lprintf(CTDL_EMERG, "cdb_fetch(%d): %s\n", cdb,
799 tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata));
801 if (tempcdb == NULL) {
803 "cdb_fetch: Cannot allocate memory for tempcdb\n");
807 tempcdb->len = dret.size;
808 tempcdb->ptr = dret.data;
810 cdb_decompress_if_necessary(tempcdb);
817 * Free a cdbdata item.
819 * Note that we only free the 'ptr' portion if it is not NULL. This allows
820 * other code to assume ownership of that memory simply by storing the
821 * pointer elsewhere and then setting 'ptr' to NULL. cdb_free() will then
824 void cdb_free(struct cdbdata *cdb)
832 void cdb_close_cursor(int cdb)
834 if (MYCURSORS[cdb] != NULL)
835 cclose(MYCURSORS[cdb]);
837 MYCURSORS[cdb] = NULL;
841 * Prepare for a sequential search of an entire database.
842 * (There is guaranteed to be no more than one traversal in
843 * progress per thread at any given time.)
845 void cdb_rewind(int cdb)
849 if (MYCURSORS[cdb] != NULL) {
851 "cdb_rewind: must close cursor on database %d before reopening.\n",
854 /* cclose(MYCURSORS[cdb]); */
858 * Now initialize the cursor
860 ret = dbp[cdb]->cursor(dbp[cdb], MYTID, &MYCURSORS[cdb], 0);
862 lprintf(CTDL_EMERG, "cdb_rewind: db_cursor: %s\n",
870 * Fetch the next item in a sequential search. Returns a pointer to a
871 * cdbdata structure, or NULL if we've hit the end.
873 struct cdbdata *cdb_next_item(int cdb)
876 struct cdbdata *cdbret;
879 /* Initialize the key/data pair so the flags aren't set. */
880 memset(&key, 0, sizeof(key));
881 memset(&data, 0, sizeof(data));
882 data.flags = DB_DBT_MALLOC;
884 ret = MYCURSORS[cdb]->c_get(MYCURSORS[cdb], &key, &data, DB_NEXT);
887 if (ret != DB_NOTFOUND) {
888 lprintf(CTDL_EMERG, "cdb_next_item(%d): %s\n",
889 cdb, db_strerror(ret));
892 cclose(MYCURSORS[cdb]);
893 MYCURSORS[cdb] = NULL;
894 return NULL; /* presumably, end of file */
897 cdbret = (struct cdbdata *) malloc(sizeof(struct cdbdata));
898 cdbret->len = data.size;
899 cdbret->ptr = data.data;
901 cdb_decompress_if_necessary(cdbret);
910 * Transaction-based stuff. I'm writing this as I bake cookies...
913 void cdb_begin_transaction(void)
916 bailIfCursor(MYCURSORS,
917 "can't begin transaction during r/o cursor");
921 "cdb_begin_transaction: ERROR: nested transaction\n");
928 void cdb_end_transaction(void)
932 for (i = 0; i < MAXCDB; i++)
933 if (MYCURSORS[i] != NULL) {
934 lprintf(CTDL_WARNING,
935 "cdb_end_transaction: WARNING: cursor %d still open at transaction end\n",
937 cclose(MYCURSORS[i]);
943 "cdb_end_transaction: ERROR: txcommit(NULL) !!\n");
952 * Truncate (delete every record)
954 void cdb_trunc(int cdb)
962 "cdb_trunc must not be called in a transaction.\n");
965 bailIfCursor(MYCURSORS,
966 "attempt to write during r/o cursor");
971 if ((ret = dbp[cdb]->truncate(dbp[cdb], /* db */
972 NULL, /* transaction ID */
973 &count, /* #rows deleted */
975 if (ret == DB_LOCK_DEADLOCK) {
980 "cdb_truncate(%d): %s\n", cdb,