4 * Sleepycat (Berkeley) DB driver for Citadel/UX
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 /*****************************************************************************/
32 #include <sys/types.h>
38 #elif defined(HAVE_DB4_DB_H)
41 #error Neither <db.h> nor <db4/db.h> was found by configure. Install db4-devel.
45 #if DB_VERSION_MAJOR < 4 || DB_VERSION_MINOR < 1
46 #error Citadel requires Berkeley DB v4.1 or newer. Please upgrade.
53 #include "serv_extensions.h"
54 #include "citserver.h"
57 #include "sysdep_decls.h"
59 static DB *dbp[MAXCDB]; /* One DB handle for each Citadel database */
60 static DB_ENV *dbenv; /* The DB environment (global) */
62 struct cdbtsd { /* Thread-specific DB stuff */
63 DB_TXN *tid; /* Transaction handle */
64 DBC *cursors[MAXCDB]; /* Cursors, for traversals... */
71 static pthread_key_t tsdkey;
73 #define MYCURSORS (((struct cdbtsd*)pthread_getspecific(tsdkey))->cursors)
74 #define MYTID (((struct cdbtsd*)pthread_getspecific(tsdkey))->tid)
76 /* just a little helper function */
77 static void txabort(DB_TXN *tid) {
80 ret = tid->abort(tid);
83 lprintf(1, "cdb_*: txn_abort: %s\n", db_strerror(ret));
88 /* this one is even more helpful than the last. */
89 static void txcommit(DB_TXN *tid) {
92 ret = tid->commit(tid, 0);
95 lprintf(1, "cdb_*: txn_commit: %s\n", db_strerror(ret));
100 /* are you sensing a pattern yet? */
101 static void txbegin(DB_TXN **tid) {
104 ret = dbenv->txn_begin(dbenv, NULL, tid, 0);
107 lprintf(1, "cdb_*: txn_begin: %s\n", db_strerror(ret));
112 static void cclose(DBC *cursor) {
115 if ((ret = cursor->c_close(cursor))) {
116 lprintf(1, "cdb_*: c_close: %s\n", db_strerror(ret));
121 static void bailIfCursor(DBC **cursors, const char *msg)
125 for (i = 0; i < MAXCDB; i++)
126 if (cursors[i] != NULL)
128 lprintf(1, "cdb_*: cursor still in progress on cdb %d: %s\n", i, msg);
133 static void check_handles(void *arg) {
135 struct cdbtsd *tsd = (struct cdbtsd *)arg;
137 bailIfCursor(tsd->cursors, "in check_handles");
139 if (tsd->tid != NULL) {
140 lprintf(1, "cdb_*: transaction still in progress!");
146 static void dest_tsd(void *arg) {
154 * Ensure that we have a key for thread-specific data. We don't
155 * put anything in here that Citadel cares about; this is just database
156 * related stuff like cursors and transactions.
158 * This should be called immediately after startup by any thread which wants
159 * to use database calls, except for whatever thread calls open_databases.
161 void cdb_allocate_tsd(void) {
164 if (pthread_getspecific(tsdkey) != NULL)
167 tsd = mallok(sizeof(struct cdbtsd));
171 memset(tsd->cursors, 0, sizeof tsd->cursors);
172 pthread_setspecific(tsdkey, tsd);
175 void cdb_free_tsd(void) {
176 dest_tsd(pthread_getspecific(tsdkey));
177 pthread_setspecific(tsdkey, NULL);
180 void cdb_check_handles(void) {
181 check_handles(pthread_getspecific(tsdkey));
186 * Reclaim unused space in the databases. We need to do each one of
187 * these discretely, rather than in a loop.
189 * This is a stub function in the Sleepycat DB backend, because there is no
190 * such API call available.
192 void defrag_databases(void)
199 * Cull the database logs
201 static void cdb_cull_logs(void) {
207 lprintf(5, "Database log file cull started.\n");
211 /* Get the list of names. */
212 if ((ret = dbenv->log_archive(dbenv, &list, flags)) != 0) {
213 lprintf(1, "cdb_cull_logs: %s\n", db_strerror(ret));
217 /* Print the list of names. */
219 for (file = list; *file != NULL; ++file) {
220 lprintf(9, "Deleting log: %s\n", *file);
223 snprintf(errmsg, sizeof(errmsg),
224 " ** ERROR **\n \n \n "
225 "Citadel was unable to delete the "
226 "database log file '%s' because of the "
227 "following error:\n \n %s\n \n"
228 " This log file is no longer in use "
229 "and may be safely deleted.\n",
232 aide_message(errmsg);
238 lprintf(5, "Database log file cull ended.\n");
243 * Request a checkpoint of the database.
245 static void cdb_checkpoint(void) {
247 static time_t last_cull = 0L;
249 ret = dbenv->txn_checkpoint(dbenv,
250 MAX_CHECKPOINT_KBYTES,
251 MAX_CHECKPOINT_MINUTES,
255 lprintf(1, "cdb_checkpoint: txn_checkpoint: %s\n",
260 /* Cull the logs if we haven't done so for 24 hours */
261 if ((time(NULL) - last_cull) > 86400L) {
262 last_cull = time(NULL);
269 * Open the various databases we'll be using. Any database which
270 * does not exist should be created. Note that we don't need an S_DATABASE
271 * critical section here, because there aren't any active threads manipulating
272 * the database yet -- and besides, it causes problems on BSDI.
274 void open_databases(void)
278 char dbfilename[SIZ];
280 char dbdirname[PATH_MAX];
282 getcwd(dbdirname, sizeof dbdirname);
283 strcat(dbdirname, "/data");
285 lprintf(9, "cdb_*: open_databases() starting\n");
286 lprintf(9, "Compiled db: %s\n", DB_VERSION_STRING);
287 lprintf(5, " Linked db: %s\n", db_version(NULL, NULL, NULL));
289 lprintf(5, "Linked zlib: %s\n", zlibVersion());
293 * Silently try to create the database subdirectory. If it's
294 * already there, no problem.
296 mkdir(dbdirname, 0700);
298 lprintf(9, "cdb_*: Setting up DB environment\n");
299 db_env_set_func_yield(sched_yield);
300 ret = db_env_create(&dbenv, 0);
302 lprintf(1, "cdb_*: db_env_create: %s\n", db_strerror(ret));
305 dbenv->set_errpfx(dbenv, "citserver");
308 * We want to specify the shared memory buffer pool cachesize,
309 * but everything else is the default.
311 ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
313 lprintf(1, "cdb_*: set_cachesize: %s\n", db_strerror(ret));
314 dbenv->close(dbenv, 0);
318 if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
319 lprintf(1, "cdb_*: set_lk_detect: %s\n", db_strerror(ret));
320 dbenv->close(dbenv, 0);
324 flags = DB_CREATE|DB_RECOVER|DB_INIT_MPOOL|DB_PRIVATE|DB_INIT_TXN|
325 DB_INIT_LOCK|DB_THREAD;
326 lprintf(9, "dbenv->open(dbenv, %s, %d, 0)\n", dbdirname, flags);
327 ret = dbenv->open(dbenv, dbdirname, flags, 0);
329 lprintf(1, "cdb_*: dbenv->open: %s\n", db_strerror(ret));
330 dbenv->close(dbenv, 0);
334 lprintf(7, "cdb_*: Starting up DB\n");
336 for (i = 0; i < MAXCDB; ++i) {
338 /* Create a database handle */
339 ret = db_create(&dbp[i], dbenv, 0);
341 lprintf(1, "cdb_*: db_create: %s\n", db_strerror(ret));
346 /* Arbitrary names for our tables -- we reference them by
347 * number, so we don't have string names for them.
349 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);
351 ret = dbp[i]->open(dbp[i],
361 lprintf(1, "cdb_*: db_open[%d]: %s\n", i, db_strerror(ret));
366 if ((ret = pthread_key_create(&tsdkey, dest_tsd))) {
367 lprintf(1, "cdb_*: pthread_key_create: %s\n", strerror(ret));
372 CtdlRegisterSessionHook(cdb_checkpoint, EVT_TIMER);
373 lprintf(9, "cdb_*: open_databases() finished\n");
378 * Close all of the db database files we've opened. This can be done
379 * in a loop, since it's just a bunch of closes.
381 void close_databases(void)
388 if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) {
389 lprintf(1, "cdb_*: txn_checkpoint: %s\n", db_strerror(ret));
393 for (a = 0; a < MAXCDB; ++a) {
394 lprintf(7, "cdb_*: Closing database %d\n", a);
395 ret = dbp[a]->close(dbp[a], 0);
397 lprintf(1, "cdb_*: db_close: %s\n", db_strerror(ret));
403 /* Close the handle. */
404 ret = dbenv->close(dbenv, 0);
406 lprintf(1, "cdb_*: DBENV->close: %s\n", db_strerror(ret));
413 * Compression functions only used if we have zlib
417 void cdb_decompress_if_necessary(struct cdbdata *cdb) {
418 static int magic = COMPRESS_MAGIC;
419 struct CtdlCompressHeader zheader;
420 char *uncompressed_data;
421 char *compressed_data;
422 uLongf destLen, sourceLen;
424 if (cdb == NULL) return;
425 if (cdb->ptr == NULL) return;
426 if (memcmp(cdb->ptr, &magic, sizeof(magic))) return;
428 /* At this point we know we're looking at a compressed item. */
429 memcpy(&zheader, cdb->ptr, sizeof(struct CtdlCompressHeader));
431 compressed_data = cdb->ptr;
432 compressed_data += sizeof(struct CtdlCompressHeader);
434 sourceLen = (uLongf) zheader.compressed_len;
435 destLen = (uLongf) zheader.uncompressed_len;
436 uncompressed_data = mallok(zheader.uncompressed_len);
438 if (uncompress( (Bytef *) uncompressed_data,
443 lprintf(1, "uncompress() error\n");
448 cdb->len = (size_t) destLen;
449 cdb->ptr = uncompressed_data;
452 #endif /* HAVE_ZLIB */
456 * Store a piece of data. Returns 0 if the operation was successful. If a
457 * key already exists it should be overwritten.
459 int cdb_store(int cdb,
460 void *ckey, int ckeylen,
461 void *cdata, int cdatalen)
469 struct CtdlCompressHeader zheader;
470 char *compressed_data = NULL;
476 memset(&dkey, 0, sizeof(DBT));
477 memset(&ddata, 0, sizeof(DBT));
480 ddata.size = cdatalen;
484 /* Only compress Visit records. Everything else is uncompressed. */
485 if (cdb == CDB_VISIT) {
487 zheader.magic = COMPRESS_MAGIC;
488 zheader.uncompressed_len = cdatalen;
489 buffer_len = ( (cdatalen * 101) / 100 ) + 100
490 + sizeof(struct CtdlCompressHeader) ;
491 destLen = (uLongf) buffer_len;
492 compressed_data = mallok(buffer_len);
494 (Bytef *) (compressed_data +
495 sizeof(struct CtdlCompressHeader)),
501 lprintf(1, "compress2() error\n");
504 zheader.compressed_len = (size_t) destLen;
505 memcpy(compressed_data, &zheader,
506 sizeof(struct CtdlCompressHeader));
507 ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) +
508 zheader.compressed_len);
509 ddata.data = compressed_data;
515 ret = dbp[cdb]->put(dbp[cdb], /* db */
516 MYTID, /* transaction ID */
522 lprintf(1, "cdb_store(%d): %s\n", cdb,
527 if (compressing) phree(compressed_data);
534 bailIfCursor(MYCURSORS, "attempt to write during r/o cursor");
539 if ((ret = dbp[cdb]->put(dbp[cdb], /* db */
540 tid, /* transaction ID */
545 if (ret == DB_LOCK_DEADLOCK)
552 lprintf(1, "cdb_store(%d): %s\n", cdb,
561 if (compressing) phree(compressed_data);
570 * Delete a piece of data. Returns 0 if the operation was successful.
572 int cdb_delete(int cdb, void *key, int keylen)
579 memset(&dkey, 0, sizeof dkey);
585 ret = dbp[cdb]->del(dbp[cdb], MYTID, &dkey, 0);
588 lprintf(1, "cdb_delete(%d): %s\n", cdb,
590 if (ret != DB_NOTFOUND)
596 bailIfCursor(MYCURSORS, "attempt to delete during r/o cursor");
601 if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0))
602 && ret != DB_NOTFOUND)
604 if (ret == DB_LOCK_DEADLOCK)
611 lprintf(1, "cdb_delete(%d): %s\n", cdb,
624 static DBC *localcursor(int cdb)
629 if (MYCURSORS[cdb] == NULL)
630 ret = dbp[cdb]->cursor(dbp[cdb], MYTID, &curs, 0);
632 ret = MYCURSORS[cdb]->c_dup(MYCURSORS[cdb], &curs, DB_POSITION);
636 lprintf(1, "localcursor: %s\n", db_strerror(ret));
645 * Fetch a piece of data. If not found, returns NULL. Otherwise, it returns
646 * a struct cdbdata which it is the caller's responsibility to free later on
647 * using the cdb_free() routine.
649 struct cdbdata *cdb_fetch(int cdb, void *key, int keylen)
652 struct cdbdata *tempcdb;
656 memset(&dkey, 0, sizeof(DBT));
662 memset(&dret, 0, sizeof(DBT));
663 dret.flags = DB_DBT_MALLOC;
664 ret = dbp[cdb]->get(dbp[cdb], MYTID, &dkey, &dret, 0);
672 memset(&dret, 0, sizeof(DBT));
673 dret.flags = DB_DBT_MALLOC;
675 curs = localcursor(cdb);
677 ret = curs->c_get(curs, &dkey, &dret, DB_SET);
680 while (ret == DB_LOCK_DEADLOCK);
684 if ((ret != 0) && (ret != DB_NOTFOUND))
686 lprintf(1, "cdb_fetch(%d): %s\n", cdb, db_strerror(ret));
690 if (ret != 0) return NULL;
691 tempcdb = (struct cdbdata *) mallok(sizeof(struct cdbdata));
695 lprintf(2, "cdb_fetch: Cannot allocate memory for tempcdb\n");
699 tempcdb->len = dret.size;
700 tempcdb->ptr = dret.data;
702 cdb_decompress_if_necessary(tempcdb);
709 * Free a cdbdata item (ok, this is really no big deal, but we might need to do
710 * more complex stuff with other database managers in the future).
712 void cdb_free(struct cdbdata *cdb)
718 void cdb_close_cursor(int cdb)
720 if (MYCURSORS[cdb] != NULL)
721 cclose(MYCURSORS[cdb]);
723 MYCURSORS[cdb] = NULL;
727 * Prepare for a sequential search of an entire database.
728 * (There is guaranteed to be no more than one traversal in
729 * progress per thread at any given time.)
731 void cdb_rewind(int cdb)
735 if (MYCURSORS[cdb] != NULL)
736 cclose(MYCURSORS[cdb]);
739 * Now initialize the cursor
741 ret = dbp[cdb]->cursor(dbp[cdb], MYTID, &MYCURSORS[cdb], 0);
743 lprintf(1, "cdb_rewind: db_cursor: %s\n", db_strerror(ret));
750 * Fetch the next item in a sequential search. Returns a pointer to a
751 * cdbdata structure, or NULL if we've hit the end.
753 struct cdbdata *cdb_next_item(int cdb)
756 struct cdbdata *cdbret;
759 /* Initialize the key/data pair so the flags aren't set. */
760 memset(&key, 0, sizeof(key));
761 memset(&data, 0, sizeof(data));
762 data.flags = DB_DBT_MALLOC;
764 ret = MYCURSORS[cdb]->c_get(MYCURSORS[cdb],
765 &key, &data, DB_NEXT);
768 if (ret != DB_NOTFOUND) {
769 lprintf(1, "cdb_next_item(%d): %s\n",
770 cdb, db_strerror(ret));
773 cclose(MYCURSORS[cdb]);
774 MYCURSORS[cdb] = NULL;
775 return NULL; /* presumably, end of file */
778 cdbret = (struct cdbdata *) mallok(sizeof(struct cdbdata));
779 cdbret->len = data.size;
780 cdbret->ptr = data.data;
782 cdb_decompress_if_necessary(cdbret);
791 * Transaction-based stuff. I'm writing this as I bake cookies...
794 void cdb_begin_transaction(void) {
796 bailIfCursor(MYCURSORS, "can't begin transaction during r/o cursor");
800 lprintf(1, "cdb_begin_transaction: ERROR: nested transaction\n");
807 void cdb_end_transaction(void) {
810 for (i = 0; i < MAXCDB; i++)
811 if (MYCURSORS[i] != NULL) {
812 lprintf(1, "cdb_end_transaction: WARNING: cursor %d still open at transaction end\n", i);
813 cclose(MYCURSORS[i]);
819 lprintf(1, "cdb_end_transaction: ERROR: txcommit(NULL) !!\n");
829 * Truncate (delete every record)
831 void cdb_trunc(int cdb)
839 lprintf(1, "cdb_trunc must not be called in a transaction.\n");
844 bailIfCursor(MYCURSORS, "attempt to write during r/o cursor");
849 if ((ret = dbp[cdb]->truncate(dbp[cdb], /* db */
850 tid, /* transaction ID */
851 &count, /* #rows deleted */
854 if (ret == DB_LOCK_DEADLOCK)
861 lprintf(1, "cdb_truncate(%d): %s\n", cdb,