citadel/server/backends/berkeley_db/berkeley_db.c

   1 // This is a data store backend for the Citadel server which uses Berkeley DB.
   2 //
   3 // Copyright (c) 1987-2023 by the citadel.org team
   4 //
   5 // This program is open source software.  Use, duplication, or disclosure
   6 // is subject to the terms of the GNU General Public License, version 3.
   7
   8 // Citadel will checkpoint the db at the end of every session, but only if
   9 // the specified number of kilobytes has been written, or if the specified
  10 // number of minutes has passed, since the last checkpoint.
  11 #define MAX_CHECKPOINT_KBYTES   256
  12 #define MAX_CHECKPOINT_MINUTES  15
  13
  14 #include "../../sysdep.h"
  15 #include <sys/stat.h>
  16 #include <stdio.h>
  17 #include <zlib.h>
  18 #include <db.h>
  19 #include <assert.h>
  20 #include <libcitadel.h>
  21 #include "../../citserver.h"
  22 #include "../../config.h"
  23 #include "berkeley_db.h"
  24
  25 #if DB_VERSION_MAJOR < 18
  26 #error Citadel requires Berkeley DB v18.0 or newer.  Please upgrade.
  27 #endif
  28
  29 // Globals (these are used across multiple functions in *this* module, but not elsewhere)
  30 static DB *bdb_table[MAXCDB];   // One DB handle for each Citadel database
  31 static DB_ENV *bdb_env;         // The DB environment (global)
  32
  33
  34 // These are items that we need to store "per thread" rather than "per session".
  35 struct bdb_tsd {
  36         DB_TXN *tid;            // Transaction handle
  37         DBC *cursors[MAXCDB];   // Cursors, for traversals...
  38         DBT dbkey[MAXCDB];
  39         DBT dbdata[MAXCDB];
  40 };
  41
  42
  43 pthread_key_t bdb_thread_key;
  44 #define TSD bdb_get_tsd()
  45
  46
  47 // Some functions in this backend need to store some per-thread data.
  48 // This returns the pointer to the current thread's per-thread data block, creating it if necessary.
  49 // (This will also work in a non-threaded program; it will return the same pointer every time.)
  50 struct bdb_tsd *bdb_get_tsd(void) {
  51
  52         struct bdb_tsd *c = (struct bdb_tsd *) pthread_getspecific(bdb_thread_key) ;
  53         if (c != NULL) {
  54                 return(c);              // Got it.
  55         }
  56
  57         // If there's no TSD for this thread, it must be a new thread.  Create our TSD region.
  58         c = (struct bdb_tsd *) malloc(sizeof(struct bdb_tsd));
  59         memset(c, 0, sizeof(struct bdb_tsd));
  60         pthread_setspecific(bdb_thread_key, (const void *) c);
  61         return(c);
  62 }
  63
  64
  65 // Called by other functions in this module to GTFO quickly if we need to.  Not part of the backend API.
  66 void bdb_abort(void) {
  67         syslog(LOG_DEBUG, "bdb: citserver is stopping in order to prevent data loss. uid=%d gid=%d euid=%d egid=%d",
  68                 getuid(), getgid(), geteuid(), getegid()
  69         );
  70         raise(SIGABRT);         // This will exit in a way that can produce a core dump if needed.
  71         exit(CTDLEXIT_DB);      // Exit if the signal failed to end the program.
  72 }
  73
  74
  75 // Verbose logging callback for Berkeley DB.  Not part of the backend API.
  76 void bdb_verbose_log(const DB_ENV *bdb_env, const char *msg, const char *foo) {
  77         if (!IsEmptyStr(msg)) {
  78                 syslog(LOG_DEBUG, "bdb: %s %s", msg, foo);
  79         }
  80 }
  81
  82
  83 // Verbose error logging callback for Berkeley DB.  Not part of the backend API.
  84 void bdb_verbose_err(const DB_ENV *bdb_env, const char *errpfx, const char *msg) {
  85         syslog(LOG_ERR, "bdb: %s", msg);
  86 }
  87
  88
  89 // Wrapper for txn_abort() that logs/aborts on error.  Not part of the backend API.
  90 static void bdb_txabort(DB_TXN *tid) {
  91         int ret;
  92
  93         ret = tid->abort(tid);
  94
  95         if (ret) {
  96                 syslog(LOG_ERR, "bdb: txn_abort: %s", db_strerror(ret));
  97                 bdb_abort();
  98         }
  99 }
 100
 101
 102 // Wrapper for txn_commit() that logs/aborts on error.  Not part of the backend API.
 103 static void bdb_txcommit(DB_TXN *tid) {
 104         int ret;
 105
 106         ret = tid->commit(tid, 0);
 107
 108         if (ret) {
 109                 syslog(LOG_ERR, "bdb: txn_commit: %s", db_strerror(ret));
 110                 bdb_abort();
 111         }
 112 }
 113
 114
 115 // Panic callback for Berkeley DB.  Not part of the backend API.
 116 static void bdb_dbpanic(DB_ENV *env, int errval) {
 117         syslog(LOG_ERR, "bdb: PANIC: %s", db_strerror(errval));
 118         bdb_abort();
 119 }
 120
 121
 122 // Close a cursor -- not part of the backend API.
 123 static void bdb_cclose(DBC *cursor) {
 124         int ret;
 125
 126         if ((ret = cursor->c_close(cursor))) {
 127                 syslog(LOG_ERR, "bdb: c_close: %s", db_strerror(ret));
 128                 bdb_abort();
 129         }
 130 }
 131
 132
 133 // Convenience function to abort if a cursor is still open when we didn't expect it to be.
 134 // This is not part of the backend API.
 135 static void bdb_bailIfCursor(DBC **cursors, const char *msg) {
 136         int i;
 137
 138         for (i = 0; i < MAXCDB; i++)
 139                 if (cursors[i] != NULL) {
 140                         syslog(LOG_ERR, "bdb: cursor still in progress on cdb %02x: %s", i, msg);
 141                         bdb_abort();
 142                 }
 143 }
 144
 145
 146 void bdb_check_handles(void) {
 147         bdb_bailIfCursor(TSD->cursors, "in check_handles");
 148
 149         if (TSD->tid != NULL) {
 150                 syslog(LOG_ERR, "bdb: transaction still in progress!");
 151                 bdb_abort();
 152         }
 153 }
 154
 155
 156 // Transaction-based stuff.  I'm writing this as I bake cookies...
 157 void bdb_begin_transaction(void) {
 158         int ret;
 159         bdb_bailIfCursor(TSD->cursors, "can't begin transaction during r/o cursor");
 160
 161         if (TSD->tid != NULL) {
 162                 syslog(LOG_ERR, "bdb: bdb_begin_transaction: ERROR: nested transaction");
 163                 bdb_abort();
 164         }
 165
 166         ret = bdb_env->txn_begin(bdb_env, NULL, &TSD->tid, 0);
 167         if (ret) {
 168                 syslog(LOG_ERR, "bdb: bdb_begin_transaction: %s", db_strerror(ret));
 169                 bdb_abort();
 170         }
 171 }
 172
 173
 174 // ...and the cookies are cursed.
 175 void bdb_end_transaction(void) {
 176         int i;
 177
 178         for (i = 0; i < MAXCDB; i++) {
 179                 if (TSD->cursors[i] != NULL) {
 180                         syslog(LOG_WARNING, "bdb: bdb_end_transaction: WARNING: cursor %d still open at transaction end", i);
 181                         bdb_cclose(TSD->cursors[i]);
 182                         TSD->cursors[i] = NULL;
 183                 }
 184         }
 185
 186         if (TSD->tid == NULL) {
 187                 syslog(LOG_ERR, "bdb: bdb_end_transaction: ERROR: bdb_txcommit(NULL) !!");
 188                 bdb_abort();
 189         }
 190         else {
 191                 bdb_txcommit(TSD->tid);
 192         }
 193
 194         TSD->tid = NULL;
 195 }
 196
 197
 198 // Request a checkpoint of the database.  Called once per minute by the thread manager.
 199 void bdb_checkpoint(void) {
 200         int ret;
 201
 202         syslog(LOG_DEBUG, "bdb: -- checkpoint --");
 203         ret = bdb_env->txn_checkpoint(bdb_env, MAX_CHECKPOINT_KBYTES, MAX_CHECKPOINT_MINUTES, 0);
 204
 205         if (ret != 0) {
 206                 syslog(LOG_ERR, "bdb: bdb_checkpoint() txn_checkpoint: %s", db_strerror(ret));
 207                 bdb_abort();
 208         }
 209
 210         // After a successful checkpoint, we can cull the unused logs
 211         ret = bdb_env->log_set_config(bdb_env, DB_LOG_AUTO_REMOVE, 1);
 212         if (ret != 0) {
 213                 syslog(LOG_ERR, "bdb: bdb_checkpoint() auto coll logs: %s", db_strerror(ret));
 214         }
 215 }
 216
 217
 218 // Open the various tables we'll be using.  Any table which does not exist should be created.  Note that we don't need a
 219 // critical section here, because there aren't any active threads manipulating the database yet.
 220 void bdb_open_databases(void) {
 221         int ret;
 222         int i;
 223         char dbfilename[32];
 224         u_int32_t flags = 0;
 225         int dbversion_major, dbversion_minor, dbversion_patch;
 226
 227         syslog(LOG_DEBUG, "bdb: bdb_open_databases() starting");
 228         syslog(LOG_DEBUG, "bdb:    Linked zlib: %s", zlibVersion());
 229         syslog(LOG_DEBUG, "bdb: Compiled libdb: %s", DB_VERSION_STRING);
 230         syslog(LOG_DEBUG, "bdb:   Linked libdb: %s", db_version(&dbversion_major, &dbversion_minor, &dbversion_patch));
 231
 232         // Create synthetic integer version numbers and compare them.
 233         // Never allow citserver to run with a libdb older then the one with which it was compiled.
 234         int compiled_db_version = ( (DB_VERSION_MAJOR * 1000000) + (DB_VERSION_MINOR * 1000) + (DB_VERSION_PATCH) );
 235         int linked_db_version = ( (dbversion_major * 1000000) + (dbversion_minor * 1000) + (dbversion_patch) );
 236         if (compiled_db_version > linked_db_version) {
 237                 syslog(LOG_ERR, "bdb: citserver is running with a version of libdb older than the one with which it was compiled.");
 238                 syslog(LOG_ERR, "bdb: This is an invalid configuration.  citserver will now exit to prevent data loss.");
 239                 exit(CTDLEXIT_DB);
 240         }
 241
 242         syslog(LOG_DEBUG, "bdb: Setting up DB environment");
 243         ret = db_env_create(&bdb_env, 0);
 244         if (ret) {
 245                 syslog(LOG_ERR, "bdb: db_env_create: %s", db_strerror(ret));
 246                 syslog(LOG_ERR, "bdb: exit code %d", ret);
 247                 exit(CTDLEXIT_DB);
 248         }
 249         bdb_env->set_errpfx(bdb_env, "citserver");
 250         bdb_env->set_paniccall(bdb_env, bdb_dbpanic);
 251         bdb_env->set_errcall(bdb_env, bdb_verbose_err);
 252         bdb_env->set_msgcall(bdb_env, bdb_verbose_log);
 253         bdb_env->set_verbose(bdb_env, DB_VERB_DEADLOCK, 1);
 254         bdb_env->set_verbose(bdb_env, DB_VERB_RECOVERY, 1);
 255
 256         flags = DB_CREATE | DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_MPOOL | DB_INIT_TXN | DB_RECOVER | DB_THREAD ;
 257         syslog(LOG_DEBUG, "bdb: bdb_env->open(bdb_env, %s, %d, 0)", ctdl_db_dir, flags);
 258         ret = bdb_env->open(bdb_env, ctdl_db_dir, flags, 0);                            // try opening the database cleanly
 259         if (ret) {
 260                 syslog(LOG_ERR, "bdb: bdb_env->open: %s: %s", ctdl_db_dir, db_strerror(ret));
 261                 bdb_env->close(bdb_env, 0);
 262                 syslog(LOG_ERR, "bdb: exit code %d", ret);
 263                 exit(CTDLEXIT_DB);
 264         }
 265
 266         for (i = 0; i < MAXCDB; ++i) {
 267                 ret = db_create(&bdb_table[i], bdb_env, 0);                             // Create a database handle
 268                 if (ret) {
 269                         syslog(LOG_ERR, "bdb: db_create: %s", db_strerror(ret));
 270                         syslog(LOG_ERR, "bdb: exit code %d", ret);
 271                         exit(CTDLEXIT_DB);
 272                 }
 273
 274                 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);                 // table names by number
 275                 ret = bdb_table[i]->open(bdb_table[i], NULL, dbfilename, NULL, DB_BTREE, DB_CREATE | DB_AUTO_COMMIT, 0600);
 276                 if (ret) {
 277                         syslog(LOG_ERR, "bdb: db_open[%02x]: %s", i, db_strerror(ret));
 278                         if (ret == ENOMEM) {
 279                                 syslog(LOG_ERR, "bdb: You may need to tune your database; please check http://www.citadel.org for more information.");
 280                         }
 281                         syslog(LOG_ERR, "bdb: exit code %d", ret);
 282                         exit(CTDLEXIT_DB);
 283                 }
 284         }
 285 }
 286
 287
 288 // 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.
 289 void bdb_close_databases(void) {
 290         int i;
 291         int ret;
 292
 293         static int closing = 0;
 294         while (closing == 1) {
 295                 syslog(LOG_INFO, "bdb: already closing");
 296         }
 297         closing = 1;
 298
 299         syslog(LOG_INFO, "bdb: performing final checkpoint");
 300         if ((ret = bdb_env->txn_checkpoint(bdb_env, 0, 0, 0))) {
 301                 syslog(LOG_ERR, "bdb: txn_checkpoint: %s", db_strerror(ret));
 302         }
 303
 304         syslog(LOG_INFO, "bdb: flushing the database logs");
 305         if ((ret = bdb_env->log_flush(bdb_env, NULL))) {
 306                 syslog(LOG_ERR, "bdb: log_flush: %s", db_strerror(ret));
 307         }
 308
 309         // close the tables
 310         syslog(LOG_INFO, "bdb: closing databases");
 311         for (i = 0; i < MAXCDB; ++i) {
 312                 ret = bdb_table[i]->close(bdb_table[i], 0);
 313                 if (ret) {
 314                         syslog(LOG_ERR, "bdb: db_close: %s", db_strerror(ret));
 315                 }
 316         }
 317
 318         // Close the handle.
 319         syslog(LOG_INFO, "bdb: closing environment");
 320         ret = bdb_env->close(bdb_env, DB_FORCESYNC);
 321         if (ret) {
 322                 syslog(LOG_ERR, "bdb: DBENV->close: %s", db_strerror(ret));
 323         }
 324
 325         syslog(LOG_INFO, "bdb: shutdown completed");
 326 }
 327
 328
 329 // Decompress a DBT data block if it was compressed on disk.
 330 void bdb_decompress_if_necessary(DBT *d) {
 331         static int magic = COMPRESS_MAGIC;
 332
 333         if ((d == NULL) || (d->data == NULL) || (d->size < sizeof(magic)) || (memcmp(d->data, &magic, sizeof(magic)))) {
 334                 return;
 335         }
 336
 337         // At this point we know we're looking at a compressed item.
 338
 339         struct CtdlCompressHeader zheader;
 340         char *uncompressed_data;
 341         char *compressed_data;
 342         uLongf destLen, sourceLen;
 343         size_t cplen;
 344
 345         memset(&zheader, 0, sizeof(struct CtdlCompressHeader));
 346         cplen = sizeof(struct CtdlCompressHeader);
 347         if (sizeof(struct CtdlCompressHeader) > d->size) {
 348                 cplen = d->size;
 349         }
 350         memcpy(&zheader, d->data, cplen);
 351
 352         compressed_data = d->data;
 353         compressed_data += sizeof(struct CtdlCompressHeader);
 354
 355         sourceLen = (uLongf) zheader.compressed_len;
 356         destLen = (uLongf) zheader.uncompressed_len;
 357         uncompressed_data = malloc(zheader.uncompressed_len);
 358
 359         if (uncompress((Bytef *) uncompressed_data, (uLongf *) &destLen, (const Bytef *) compressed_data, (uLong) sourceLen) != Z_OK) {
 360                 syslog(LOG_ERR, "bdb: uncompress() error");
 361                 bdb_abort();
 362         }
 363
 364         free(d->data);
 365         d->size = (size_t) destLen;
 366         d->data = uncompressed_data;
 367 }
 368
 369
 370 // Store a piece of data.  Returns 0 if the operation was successful.  If a
 371 // key already exists it should be overwritten.
 372 int bdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) {
 373
 374         DBT dkey, ddata;
 375         DB_TXN *tid = NULL;
 376         int ret = 0;
 377         struct CtdlCompressHeader zheader;
 378         char *compressed_data = NULL;
 379         int compressing = 0;
 380         size_t buffer_len = 0;
 381         uLongf destLen = 0;
 382         int existing_txn = 0;                   // set to nonzero if we are already inside a transaction
 383
 384         memset(&dkey, 0, sizeof(DBT));
 385         memset(&ddata, 0, sizeof(DBT));
 386         dkey.size = ckeylen;
 387         dkey.data = (void *) ckey;
 388         ddata.size = cdatalen;
 389         ddata.data = cdata;
 390
 391         // "visit" records are numerous and have big, mostly-empty string buffers in them.
 392         // If we compress these we can get them down to 1% of their size most of the time.
 393         if (cdb == CDB_VISIT) {
 394                 compressing = 1;
 395                 zheader.magic = COMPRESS_MAGIC;
 396                 zheader.uncompressed_len = cdatalen;
 397                 buffer_len = ((cdatalen * 101) / 100) + 100 + sizeof(struct CtdlCompressHeader);
 398                 destLen = (uLongf) buffer_len;
 399                 compressed_data = malloc(buffer_len);
 400                 if (compress2((Bytef *) (compressed_data + sizeof(struct CtdlCompressHeader)), &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK) {
 401                         syslog(LOG_ERR, "bdb: compress2() error");
 402                         bdb_abort();
 403                 }
 404                 zheader.compressed_len = (size_t) destLen;
 405                 memcpy(compressed_data, &zheader, sizeof(struct CtdlCompressHeader));
 406                 ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) + zheader.compressed_len);
 407                 ddata.data = compressed_data;
 408         }
 409
 410         if (TSD->tid != NULL) {
 411                 existing_txn = 1;
 412         }
 413
 414         if (!existing_txn) {                            // If we're not already inside a transaction,
 415                 bdb_begin_transaction();                // create our own for this operation.
 416         }
 417
 418         do {
 419                 ret = bdb_table[cdb]->put(bdb_table[cdb],       // db
 420                                 TSD->tid,                       // transaction ID
 421                                 &dkey,                  // key
 422                                 &ddata,                 // data
 423                                 0                               // flags
 424                 );
 425                 if ((ret != 0) && (ret != DB_LOCK_DEADLOCK)) {
 426                         syslog(LOG_ERR, "bdb: bdb_store(%02x): error %d: %s", cdb, ret, db_strerror(ret));
 427                         bdb_abort();
 428                 }
 429                 if (ret == DB_LOCK_DEADLOCK) {
 430                         syslog(LOG_DEBUG, "bdb: bdb_store(%02x): would deadlock, trying again", cdb);
 431                 }
 432         } while (ret == DB_LOCK_DEADLOCK);
 433
 434         if (!existing_txn) {
 435                 bdb_end_transaction();
 436         }
 437
 438         if (compressing) {
 439                 free(compressed_data);
 440         }
 441
 442         return ret;
 443 }
 444
 445
 446 // Delete a piece of data.  Returns 0 if the operation was successful.
 447 int bdb_delete(int cdb, void *key, int keylen) {
 448         DBT dkey;
 449         int ret;
 450         int existing_txn = 0;                           // set to nonzero if we are already inside a transaction
 451
 452         memset(&dkey, 0, sizeof dkey);
 453         dkey.size = keylen;
 454         dkey.data = key;
 455
 456         if (TSD->tid != NULL) {
 457                 existing_txn = 1;
 458         }
 459
 460         if (!existing_txn) {                            // If we're not already inside a transaction,
 461                 bdb_begin_transaction();                // create our own for this operation.
 462         }
 463
 464         ret = bdb_table[cdb]->del(bdb_table[cdb], TSD->tid, &dkey, 0);
 465         if (ret) {
 466                 if (ret != DB_NOTFOUND) {
 467                         syslog(LOG_ERR, "bdb: bdb_delete(%02x): %s", cdb, db_strerror(ret));
 468                         bdb_abort();
 469                 }
 470         }
 471
 472         if (!existing_txn) {
 473                 bdb_end_transaction();                  // Only end the transaction if we began it.
 474         }
 475
 476         return ret;
 477 }
 478
 479
 480 // Fetch a piece of data.  Returns a "struct cdbdata"
 481 // If the item is not found, the pointer will be NULL.
 482 struct cdbdata bdb_fetch(int cdb, const void *key, int keylen) {
 483
 484         struct cdbdata returned_data;
 485         memset(&returned_data, 0, sizeof(struct cdbdata));
 486
 487         if (keylen == 0) {              // key length zero is impossible
 488                 return(returned_data);
 489         }
 490
 491         DBT dkey;
 492         int ret;
 493
 494         memset(&dkey, 0, sizeof(DBT));
 495         dkey.size = keylen;
 496         dkey.data = (void *) key;
 497
 498         TSD->dbdata[cdb].flags = DB_DBT_REALLOC;
 499
 500         do {
 501                 ret = bdb_table[cdb]->get(bdb_table[cdb], TSD->tid, &dkey, &TSD->dbdata[cdb], 0);
 502                 if ((ret != 0) && (ret != DB_NOTFOUND) && (ret != DB_LOCK_DEADLOCK)) {
 503                         syslog(LOG_ERR, "bdb: bdb_fetch(%d): error %d: %s", cdb, ret, db_strerror(ret));
 504                         bdb_abort();
 505                 }
 506         } while (ret == DB_LOCK_DEADLOCK);
 507
 508         if (ret == 0) {
 509                 bdb_decompress_if_necessary(&TSD->dbdata[cdb]);
 510                 returned_data.len = TSD->dbdata[cdb].size;
 511                 returned_data.ptr = TSD->dbdata[cdb].data;
 512         }
 513
 514         return(returned_data);
 515 }
 516
 517
 518 void bdb_close_cursor(int cdb) {
 519         if (TSD->cursors[cdb] != NULL) {
 520                 bdb_cclose(TSD->cursors[cdb]);
 521         }
 522
 523         TSD->cursors[cdb] = NULL;
 524 }
 525
 526
 527 // Prepare for a sequential search of an entire database.
 528 // (There is guaranteed to be no more than one traversal in progress per thread at any given time.)
 529 void bdb_rewind(int cdb) {
 530         int ret = 0;
 531
 532         if (TSD->cursors[cdb] != NULL) {
 533                 syslog(LOG_ERR, "bdb: bdb_rewind: must close cursor on database %d before reopening", cdb);
 534                 bdb_abort();
 535                 // bdb_cclose(TSD->cursors[cdb]);
 536         }
 537
 538         // Now initialize the cursor
 539         ret = bdb_table[cdb]->cursor(bdb_table[cdb], TSD->tid, &TSD->cursors[cdb], 0);
 540         if (ret) {
 541                 syslog(LOG_ERR, "bdb: bdb_rewind: db_cursor: %s", db_strerror(ret));
 542                 bdb_abort();
 543         }
 544 }
 545
 546
 547 // Fetch the next item in a sequential search.  Returns a pointer to a
 548 // cdbdata structure, or NULL if we've hit the end.
 549 struct cdbkeyval bdb_next_item(int cdb) {
 550         struct cdbkeyval kv;
 551         int ret = 0;
 552
 553         memset(&kv, 0, sizeof(struct cdbkeyval));
 554
 555         // reuse memory from the previous call.
 556         TSD->dbkey[cdb].flags = DB_DBT_REALLOC;
 557         TSD->dbdata[cdb].flags = DB_DBT_REALLOC;
 558
 559         assert(TSD->cursors[cdb] != NULL);
 560         ret = TSD->cursors[cdb]->c_get(TSD->cursors[cdb], &TSD->dbkey[cdb], &TSD->dbdata[cdb], DB_NEXT);
 561
 562         if (ret) {
 563                 if (ret != DB_NOTFOUND) {
 564                         syslog(LOG_ERR, "bdb: bdb_next_item(%d): %s", cdb, db_strerror(ret));
 565                         bdb_abort();
 566                 }
 567                 bdb_close_cursor(cdb);
 568                 return(kv);             // presumably, we are at the end
 569         }
 570
 571         bdb_decompress_if_necessary(&TSD->dbdata[cdb]);
 572
 573         kv.key.len = TSD->dbkey[cdb].size;
 574         kv.key.ptr = TSD->dbkey[cdb].data;
 575         kv.val.len = TSD->dbdata[cdb].size;
 576         kv.val.ptr = TSD->dbdata[cdb].data;
 577         return (kv);
 578 }
 579
 580
 581 // Truncate (delete every record)
 582 void bdb_trunc(int cdb) {
 583         int ret;
 584         u_int32_t count;
 585
 586         if (TSD->tid != NULL) {
 587                 syslog(LOG_ERR, "bdb: bdb_trunc must not be called in a transaction.");
 588                 bdb_abort();
 589         }
 590
 591         bdb_begin_transaction();                                // create our own transaction for this operation.
 592         ret = bdb_table[cdb]->truncate(bdb_table[cdb],          // db
 593                                       NULL,                     // transaction ID
 594                                       &count,                   // #rows deleted
 595                                       0);                       // flags
 596                                                                 //
 597         if (ret) {
 598                 syslog(LOG_ERR, "bdb: bdb_truncate(%d): %s", cdb, db_strerror(ret));
 599                 if (ret == ENOMEM) {
 600                         syslog(LOG_ERR, "bdb: You may need to tune your database; please read http://www.citadel.org for more information.");
 601                 }
 602                 exit(CTDLEXIT_DB);
 603         }
 604         bdb_end_transaction();
 605 }
 606
 607
 608 // compact (defragment) the database, possibly returning space back to the underlying filesystem
 609 void bdb_compact(void) {
 610         int ret;
 611         int i;
 612
 613         syslog(LOG_DEBUG, "bdb: bdb_compact() started");
 614         for (i = 0; i < MAXCDB; i++) {
 615                 syslog(LOG_DEBUG, "bdb: compacting database %d", i);
 616                 ret = bdb_table[i]->compact(bdb_table[i], NULL, NULL, NULL, NULL, DB_FREE_SPACE, NULL);
 617                 if (ret) {
 618                         syslog(LOG_ERR, "bdb: compact: %s", db_strerror(ret));
 619                 }
 620         }
 621         syslog(LOG_DEBUG, "bdb: bdb_compact() finished");
 622 }
 623
 624
 625 // periodically called for maintenance
 626 void bdb_tick(void) {
 627         int ret;
 628         int rejected;
 629
 630         ret = bdb_env->lock_detect(bdb_env, 0, DB_LOCK_DEFAULT, &rejected);
 631         if (ret) {
 632                 syslog(LOG_ERR, "bdb: lock_detect: %s", db_strerror(ret));
 633         }
 634         else if (rejected) {
 635                 syslog(LOG_DEBUG, "bdb: rejected lock %d", rejected);
 636         }
 637 }
 638
 639
 640 // Calling this function activates the Berkeley DB back end.
 641 void bdb_init_backend(void) {
 642
 643         // Assign the backend API stubs to the functions in this module.
 644         cdb_compact = bdb_compact;
 645         cdb_checkpoint = bdb_checkpoint;
 646         cdb_rewind = bdb_rewind;
 647         cdb_fetch = bdb_fetch;
 648         cdb_open_databases = bdb_open_databases;
 649         cdb_close_databases = bdb_close_databases;
 650         cdb_store = bdb_store;
 651         cdb_delete = bdb_delete;
 652         cdb_next_item = bdb_next_item;
 653         cdb_close_cursor = bdb_close_cursor;
 654         cdb_begin_transaction = bdb_begin_transaction;
 655         cdb_end_transaction = bdb_end_transaction;
 656         cdb_check_handles = bdb_check_handles;
 657         cdb_trunc = bdb_trunc;
 658         cdb_tick = bdb_tick;
 659
 660         // Some functions in this backend need to store some per-thread data.
 661         // We create the key here, during module initialization.
 662         if (pthread_key_create(&bdb_thread_key, NULL) != 0) {
 663                 syslog(LOG_ERR, "pthread_key_create() : %m");
 664                 exit(CTDLEXIT_THREAD);
 665         }
 666
 667         syslog(LOG_INFO, "db: initialized Berkeley DB backend");
 668 }