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 <dirent.h>
  18 #include <zlib.h>
  19 #include <db.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 *dbp[MAXCDB];         // One DB handle for each Citadel database
  31 static DB_ENV *dbenv;           // The DB environment (global)
  32
  33
  34 // Thread-Specific-Storage items for this backend
  35 struct bdb_tsd {
  36         DB_TXN *tid;            // Transaction handle
  37         DBC *cursors[MAXCDB];   // Cursors, for traversals...
  38 };
  39
  40
  41 pthread_key_t bdb_thread_key;
  42 #define TSD bdb_get_tsd()
  43
  44
  45 // Return a pointer to our thread-specific (not session-specific) data.
  46 struct bdb_tsd *bdb_get_tsd(void) {
  47
  48         struct bdb_tsd *c = (struct bdb_tsd *) pthread_getspecific(bdb_thread_key) ;
  49         if (c != NULL) {
  50                 return(c);              // Got it.
  51         }
  52
  53         // If there's no TSD for this thread, it must be a new thread.  Create our TSD region.
  54         c = (struct bdb_tsd *) malloc(sizeof(struct bdb_tsd));
  55         memset(c, 0, sizeof(struct bdb_tsd));
  56         pthread_setspecific(bdb_thread_key, (const void *) c);
  57         return(c);
  58 }
  59
  60
  61 // Called by other functions in this module to GTFO quickly if we need to.  Not part of the backend API.
  62 void bdb_abort(void) {
  63         syslog(LOG_DEBUG, "bdb: citserver is stopping in order to prevent data loss. uid=%d gid=%d euid=%d egid=%d",
  64                 getuid(), getgid(), geteuid(), getegid()
  65         );
  66         raise(SIGABRT);         // This will exit in a way that can produce a core dump if needed.
  67         exit(CTDLEXIT_DB);      // Exit if the signal failed to end the program.
  68 }
  69
  70
  71 // Verbose logging callback for Berkeley DB.  Not part of the backend API.
  72 void bdb_verbose_log(const DB_ENV *dbenv, const char *msg, const char *foo) {
  73         if (!IsEmptyStr(msg)) {
  74                 syslog(LOG_DEBUG, "bdb: %s %s", msg, foo);
  75         }
  76 }
  77
  78
  79 // Verbose error logging callback for Berkeley DB.  Not part of the backend API.
  80 void bdb_verbose_err(const DB_ENV *dbenv, const char *errpfx, const char *msg) {
  81         syslog(LOG_ERR, "bdb: %s", msg);
  82 }
  83
  84
  85 // Wrapper for txn_abort() that logs/aborts on error.  Not part of the backend API.
  86 static void bdb_txabort(DB_TXN *tid) {
  87         int ret;
  88
  89         ret = tid->abort(tid);
  90
  91         if (ret) {
  92                 syslog(LOG_ERR, "bdb: txn_abort: %s", db_strerror(ret));
  93                 bdb_abort();
  94         }
  95 }
  96
  97
  98 // Wrapper for txn_commit() that logs/aborts on error.  Not part of the backend API.
  99 static void bdb_txcommit(DB_TXN *tid) {
 100         int ret;
 101
 102         ret = tid->commit(tid, 0);
 103
 104         if (ret) {
 105                 syslog(LOG_ERR, "bdb: txn_commit: %s", db_strerror(ret));
 106                 bdb_abort();
 107         }
 108 }
 109
 110
 111 // Wrapper for txn_begin() that logs/aborts on error.  Not part of the backend API.
 112 static void bdb_txbegin(DB_TXN **tid) {
 113         int ret;
 114
 115         ret = dbenv->txn_begin(dbenv, NULL, tid, 0);
 116
 117         if (ret) {
 118                 syslog(LOG_ERR, "bdb: txn_begin: %s", db_strerror(ret));
 119                 bdb_abort();
 120         }
 121 }
 122
 123
 124 // Panic callback for Berkeley DB.  Not part of the backend API.
 125 static void bdb_dbpanic(DB_ENV *env, int errval) {
 126         syslog(LOG_ERR, "bdb: PANIC: %s", db_strerror(errval));
 127         bdb_abort();
 128 }
 129
 130
 131 // Close a cursor -- not part of the backend API.
 132 static void bdb_cclose(DBC *cursor) {
 133         int ret;
 134
 135         if ((ret = cursor->c_close(cursor))) {
 136                 syslog(LOG_ERR, "bdb: c_close: %s", db_strerror(ret));
 137                 bdb_abort();
 138         }
 139 }
 140
 141
 142 // Convenience function to abort if a cursor is still open when we didn't expect it to be.
 143 // This is not part of the backend API.
 144 static void bdb_bailIfCursor(DBC **cursors, const char *msg) {
 145         int i;
 146
 147         for (i = 0; i < MAXCDB; i++)
 148                 if (cursors[i] != NULL) {
 149                         syslog(LOG_ERR, "bdb: cursor still in progress on cdb %02x: %s", i, msg);
 150                         bdb_abort();
 151                 }
 152 }
 153
 154
 155 void bdb_check_handles(void) {
 156         bdb_bailIfCursor(TSD->cursors, "in check_handles");
 157
 158         if (TSD->tid != NULL) {
 159                 syslog(LOG_ERR, "bdb: transaction still in progress!");
 160                 bdb_abort();
 161         }
 162 }
 163
 164
 165 // Request a checkpoint of the database.  Called once per minute by the thread manager.
 166 void bdb_checkpoint(void) {
 167         int ret;
 168
 169         syslog(LOG_DEBUG, "bdb: -- checkpoint --");
 170         ret = dbenv->txn_checkpoint(dbenv, MAX_CHECKPOINT_KBYTES, MAX_CHECKPOINT_MINUTES, 0);
 171
 172         if (ret != 0) {
 173                 syslog(LOG_ERR, "bdb: bdb_checkpoint() txn_checkpoint: %s", db_strerror(ret));
 174                 bdb_abort();
 175         }
 176
 177         // After a successful checkpoint, we can cull the unused logs
 178         if (CtdlGetConfigInt("c_auto_cull")) {
 179                 ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 1);
 180         }
 181         else {
 182                 ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 0);
 183         }
 184 }
 185
 186
 187 // Open the various databases we'll be using.  Any database which
 188 // does not exist should be created.  Note that we don't need a
 189 // critical section here, because there aren't any active threads
 190 // manipulating the database yet.
 191 void bdb_open_databases(void) {
 192         int ret;
 193         int i;
 194         char dbfilename[32];
 195         u_int32_t flags = 0;
 196         int dbversion_major, dbversion_minor, dbversion_patch;
 197
 198         syslog(LOG_DEBUG, "bdb: bdb_open_databases() starting");
 199         syslog(LOG_DEBUG, "bdb:    Linked zlib: %s", zlibVersion());
 200         syslog(LOG_DEBUG, "bdb: Compiled libdb: %s", DB_VERSION_STRING);
 201         syslog(LOG_DEBUG, "bdb:   Linked libdb: %s", db_version(&dbversion_major, &dbversion_minor, &dbversion_patch));
 202
 203         // Create synthetic integer version numbers and compare them.
 204         // Never allow citserver to run with a libdb older then the one with which it was compiled.
 205         int compiled_db_version = ( (DB_VERSION_MAJOR * 1000000) + (DB_VERSION_MINOR * 1000) + (DB_VERSION_PATCH) );
 206         int linked_db_version = ( (dbversion_major * 1000000) + (dbversion_minor * 1000) + (dbversion_patch) );
 207         if (compiled_db_version > linked_db_version) {
 208                 syslog(LOG_ERR, "bdb: citserver is running with a version of libdb older than the one with which it was compiled.");
 209                 syslog(LOG_ERR, "bdb: This is an invalid configuration.  citserver will now exit to prevent data loss.");
 210                 exit(CTDLEXIT_DB);
 211         }
 212
 213         // Silently try to create the database subdirectory.  If it's already there, no problem.
 214         if ((mkdir(ctdl_db_dir, 0700) != 0) && (errno != EEXIST)) {
 215                 syslog(LOG_ERR, "bdb: database directory [%s] does not exist and could not be created: %m", ctdl_db_dir);
 216                 exit(CTDLEXIT_DB);
 217         }
 218         if (chmod(ctdl_db_dir, 0700) != 0) {
 219                 syslog(LOG_ERR, "bdb: unable to set database directory permissions [%s]: %m", ctdl_db_dir);
 220                 exit(CTDLEXIT_DB);
 221         }
 222         if (chown(ctdl_db_dir, CTDLUID, (-1)) != 0) {
 223                 syslog(LOG_ERR, "bdb: unable to set the owner for [%s]: %m", ctdl_db_dir);
 224                 exit(CTDLEXIT_DB);
 225         }
 226         syslog(LOG_DEBUG, "bdb: Setting up DB environment");
 227         ret = db_env_create(&dbenv, 0);
 228         if (ret) {
 229                 syslog(LOG_ERR, "bdb: db_env_create: %s", db_strerror(ret));
 230                 syslog(LOG_ERR, "bdb: exit code %d", ret);
 231                 exit(CTDLEXIT_DB);
 232         }
 233         dbenv->set_errpfx(dbenv, "citserver");
 234         dbenv->set_paniccall(dbenv, bdb_dbpanic);
 235         dbenv->set_errcall(dbenv, bdb_verbose_err);
 236         dbenv->set_msgcall(dbenv, bdb_verbose_log);
 237         dbenv->set_verbose(dbenv, DB_VERB_DEADLOCK, 1);
 238         dbenv->set_verbose(dbenv, DB_VERB_RECOVERY, 1);
 239
 240         // We want to specify the shared memory buffer pool cachesize, but everything else is the default.
 241         ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
 242         if (ret) {
 243                 syslog(LOG_ERR, "bdb: set_cachesize: %s", db_strerror(ret));
 244                 dbenv->close(dbenv, 0);
 245                 syslog(LOG_ERR, "bdb: exit code %d", ret);
 246                 exit(CTDLEXIT_DB);
 247         }
 248
 249         if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
 250                 syslog(LOG_ERR, "bdb: set_lk_detect: %s", db_strerror(ret));
 251                 dbenv->close(dbenv, 0);
 252                 syslog(LOG_ERR, "bdb: exit code %d", ret);
 253                 exit(CTDLEXIT_DB);
 254         }
 255
 256         flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_INIT_LOG;
 257         syslog(LOG_DEBUG, "bdb: dbenv->open(dbenv, %s, %d, 0)", ctdl_db_dir, flags);
 258         ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0);                                // try opening the database cleanly
 259         if (ret == DB_RUNRECOVERY) {
 260                 syslog(LOG_ERR, "bdb: dbenv->open: %s", db_strerror(ret));
 261                 syslog(LOG_ERR, "bdb: attempting recovery...");
 262                 flags |= DB_RECOVER;
 263                 ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0);                        // try recovery
 264         }
 265         if (ret == DB_RUNRECOVERY) {
 266                 syslog(LOG_ERR, "bdb: dbenv->open: %s", db_strerror(ret));
 267                 syslog(LOG_ERR, "bdb: attempting catastrophic recovery...");
 268                 flags &= ~DB_RECOVER;
 269                 flags |= DB_RECOVER_FATAL;
 270                 ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0);                        // try catastrophic recovery
 271         }
 272         if (ret) {
 273                 syslog(LOG_ERR, "bdb: dbenv->open: %s", db_strerror(ret));
 274                 dbenv->close(dbenv, 0);
 275                 syslog(LOG_ERR, "bdb: exit code %d", ret);
 276                 exit(CTDLEXIT_DB);
 277         }
 278
 279         syslog(LOG_INFO, "bdb: mounting databases");
 280         for (i = 0; i < MAXCDB; ++i) {
 281                 ret = db_create(&dbp[i], dbenv, 0);                                     // Create a database handle
 282                 if (ret) {
 283                         syslog(LOG_ERR, "bdb: db_create: %s", db_strerror(ret));
 284                         syslog(LOG_ERR, "bdb: exit code %d", ret);
 285                         exit(CTDLEXIT_DB);
 286                 }
 287
 288                 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);                 // table names by number
 289                 ret = dbp[i]->open(dbp[i], NULL, dbfilename, NULL, DB_BTREE, DB_CREATE | DB_AUTO_COMMIT | DB_THREAD, 0600);
 290                 if (ret) {
 291                         syslog(LOG_ERR, "bdb: db_open[%02x]: %s", i, db_strerror(ret));
 292                         if (ret == ENOMEM) {
 293                                 syslog(LOG_ERR, "bdb: You may need to tune your database; please check http://www.citadel.org for more information.");
 294                         }
 295                         syslog(LOG_ERR, "bdb: exit code %d", ret);
 296                         exit(CTDLEXIT_DB);
 297                 }
 298         }
 299 }
 300
 301
 302 // Make sure we own all the files, because in a few milliseconds we're going to drop root privs.
 303 void bdb_chmod_data(void) {
 304         DIR *dp;
 305         struct dirent *d;
 306         char filename[PATH_MAX];
 307
 308         dp = opendir(ctdl_db_dir);
 309         if (dp != NULL) {
 310                 while (d = readdir(dp), d != NULL) {
 311                         if (d->d_name[0] != '.') {
 312                                 snprintf(filename, sizeof filename, "%s/%s", ctdl_db_dir, d->d_name);
 313                                 syslog(LOG_DEBUG, "bdb: chmod(%s, 0600) returned %d", filename, chmod(filename, 0600));
 314                                 syslog(LOG_DEBUG, "bdb: chown(%s, CTDLUID, -1) returned %d", filename, chown(filename, CTDLUID, (-1)));
 315                         }
 316                 }
 317                 closedir(dp);
 318         }
 319 }
 320
 321
 322 // 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.
 323 void bdb_close_databases(void) {
 324         int i;
 325         int ret;
 326
 327         static int closing = 0;
 328         while (closing == 1) {
 329                 syslog(LOG_INFO, "bdb: already closing");
 330         }
 331         closing = 1;
 332
 333         syslog(LOG_INFO, "bdb: performing final checkpoint");
 334         if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) {
 335                 syslog(LOG_ERR, "bdb: txn_checkpoint: %s", db_strerror(ret));
 336         }
 337
 338         syslog(LOG_INFO, "bdb: flushing the database logs");
 339         if ((ret = dbenv->log_flush(dbenv, NULL))) {
 340                 syslog(LOG_ERR, "bdb: log_flush: %s", db_strerror(ret));
 341         }
 342
 343         // close the tables
 344         syslog(LOG_INFO, "bdb: closing databases");
 345         for (i = 0; i < MAXCDB; ++i) {
 346                 syslog(LOG_INFO, "bdb: closing database %02x", i);
 347                 ret = dbp[i]->close(dbp[i], 0);
 348                 if (ret) {
 349                         syslog(LOG_ERR, "bdb: db_close: %s", db_strerror(ret));
 350                 }
 351         }
 352
 353         // Close the handle.
 354         ret = dbenv->close(dbenv, DB_FORCESYNC);
 355         if (ret) {
 356                 syslog(LOG_ERR, "bdb: DBENV->close: %s", db_strerror(ret));
 357         }
 358 }
 359
 360
 361 // Decompress a database item if it was compressed on disk
 362 void bdb_decompress_if_necessary(struct cdbdata *cdb) {
 363         static int magic = COMPRESS_MAGIC;
 364
 365         if ((cdb == NULL) || (cdb->ptr == NULL) || (cdb->len < sizeof(magic)) || (memcmp(cdb->ptr, &magic, sizeof(magic)))) {
 366                 return;
 367         }
 368
 369         // At this point we know we're looking at a compressed item.
 370
 371         struct CtdlCompressHeader zheader;
 372         char *uncompressed_data;
 373         char *compressed_data;
 374         uLongf destLen, sourceLen;
 375         size_t cplen;
 376
 377         memset(&zheader, 0, sizeof(struct CtdlCompressHeader));
 378         cplen = sizeof(struct CtdlCompressHeader);
 379         if (sizeof(struct CtdlCompressHeader) > cdb->len) {
 380                 cplen = cdb->len;
 381         }
 382         memcpy(&zheader, cdb->ptr, cplen);
 383
 384         compressed_data = cdb->ptr;
 385         compressed_data += sizeof(struct CtdlCompressHeader);
 386
 387         sourceLen = (uLongf) zheader.compressed_len;
 388         destLen = (uLongf) zheader.uncompressed_len;
 389         uncompressed_data = malloc(zheader.uncompressed_len);
 390
 391         if (uncompress((Bytef *) uncompressed_data,
 392                        (uLongf *) &destLen, (const Bytef *) compressed_data, (uLong) sourceLen) != Z_OK) {
 393                 syslog(LOG_ERR, "bdb: uncompress() error");
 394                 bdb_abort();
 395         }
 396
 397         free(cdb->ptr);
 398         cdb->len = (size_t) destLen;
 399         cdb->ptr = uncompressed_data;
 400 }
 401
 402
 403 // Store a piece of data.  Returns 0 if the operation was successful.  If a
 404 // key already exists it should be overwritten.
 405 int bdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) {
 406
 407         DBT dkey, ddata;
 408         DB_TXN *tid = NULL;
 409         int ret = 0;
 410         struct CtdlCompressHeader zheader;
 411         char *compressed_data = NULL;
 412         int compressing = 0;
 413         size_t buffer_len = 0;
 414         uLongf destLen = 0;
 415
 416         memset(&dkey, 0, sizeof(DBT));
 417         memset(&ddata, 0, sizeof(DBT));
 418         dkey.size = ckeylen;
 419         dkey.data = (void *) ckey;
 420         ddata.size = cdatalen;
 421         ddata.data = cdata;
 422
 423         // "visit" records are numerous and have big, mostly-empty string buffers in them.
 424         // If we compress these we can get them down to 1% of their size most of the time.
 425         if (cdb == CDB_VISIT) {
 426                 compressing = 1;
 427                 zheader.magic = COMPRESS_MAGIC;
 428                 zheader.uncompressed_len = cdatalen;
 429                 buffer_len = ((cdatalen * 101) / 100) + 100 + sizeof(struct CtdlCompressHeader);
 430                 destLen = (uLongf) buffer_len;
 431                 compressed_data = malloc(buffer_len);
 432                 if (compress2((Bytef *) (compressed_data + sizeof(struct CtdlCompressHeader)), &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK) {
 433                         syslog(LOG_ERR, "bdb: compress2() error");
 434                         bdb_abort();
 435                 }
 436                 zheader.compressed_len = (size_t) destLen;
 437                 memcpy(compressed_data, &zheader, sizeof(struct CtdlCompressHeader));
 438                 ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) + zheader.compressed_len);
 439                 ddata.data = compressed_data;
 440         }
 441
 442         if (TSD->tid != NULL) {
 443                 ret = dbp[cdb]->put(dbp[cdb],   // db
 444                                     TSD->tid,   // transaction ID
 445                                     &dkey,      // key
 446                                     &ddata,     // data
 447                                     0           // flags
 448                 );
 449                 if (ret) {
 450                         syslog(LOG_ERR, "bdb: bdb_store(%d): %s", cdb, db_strerror(ret));
 451                         bdb_abort();
 452                 }
 453                 if (compressing) {
 454                         free(compressed_data);
 455                 }
 456                 return ret;
 457         }
 458         else {
 459                 bdb_bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 460
 461               retry:
 462                 bdb_txbegin(&tid);
 463
 464                 if ((ret = dbp[cdb]->put(dbp[cdb],      // db
 465                                          tid,           // transaction ID
 466                                          &dkey,         // key
 467                                          &ddata,        // data
 468                                          0))) {         // flags
 469                         if (ret == DB_LOCK_DEADLOCK) {
 470                                 bdb_txabort(tid);
 471                                 goto retry;
 472                         }
 473                         else {
 474                                 syslog(LOG_ERR, "bdb: bdb_store(%d): %s", cdb, db_strerror(ret));
 475                                 bdb_abort();
 476                         }
 477                 }
 478                 else {
 479                         bdb_txcommit(tid);
 480                         if (compressing) {
 481                                 free(compressed_data);
 482                         }
 483                         return ret;
 484                 }
 485         }
 486         return ret;
 487 }
 488
 489
 490 // Delete a piece of data.  Returns 0 if the operation was successful.
 491 int bdb_delete(int cdb, void *key, int keylen) {
 492         DBT dkey;
 493         DB_TXN *tid;
 494         int ret;
 495
 496         memset(&dkey, 0, sizeof dkey);
 497         dkey.size = keylen;
 498         dkey.data = key;
 499
 500         if (TSD->tid != NULL) {
 501                 ret = dbp[cdb]->del(dbp[cdb], TSD->tid, &dkey, 0);
 502                 if (ret) {
 503                         syslog(LOG_ERR, "bdb: bdb_delete(%d): %s", cdb, db_strerror(ret));
 504                         if (ret != DB_NOTFOUND) {
 505                                 bdb_abort();
 506                         }
 507                 }
 508         }
 509         else {
 510                 bdb_bailIfCursor(TSD->cursors, "attempt to delete during r/o cursor");
 511
 512               retry:
 513                 bdb_txbegin(&tid);
 514
 515                 if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0)) && ret != DB_NOTFOUND) {
 516                         if (ret == DB_LOCK_DEADLOCK) {
 517                                 bdb_txabort(tid);
 518                                 goto retry;
 519                         }
 520                         else {
 521                                 syslog(LOG_ERR, "bdb: bdb_delete(%d): %s", cdb, db_strerror(ret));
 522                                 bdb_abort();
 523                         }
 524                 }
 525                 else {
 526                         bdb_txcommit(tid);
 527                 }
 528         }
 529         return ret;
 530 }
 531
 532
 533 static DBC *bdb_localcursor(int cdb) {
 534         int ret;
 535         DBC *curs;
 536
 537         if (TSD->cursors[cdb] == NULL) {
 538                 ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &curs, 0);
 539         }
 540         else {
 541                 ret = TSD->cursors[cdb]->c_dup(TSD->cursors[cdb], &curs, DB_POSITION);
 542         }
 543
 544         if (ret) {
 545                 syslog(LOG_ERR, "bdb: bdb_localcursor: %s", db_strerror(ret));
 546                 bdb_abort();
 547         }
 548
 549         return curs;
 550 }
 551
 552
 553 // Fetch a piece of data.  If not found, returns NULL.  Otherwise, it returns
 554 // a struct cdbdata which it is the caller's responsibility to free later on
 555 // using the bdb_free() routine.
 556 struct cdbdata *bdb_fetch(int cdb, const void *key, int keylen) {
 557
 558         if (keylen == 0) {              // key length zero is impossible
 559                 return(NULL);
 560         }
 561
 562         struct cdbdata *tempcdb;
 563         DBT dkey, dret;
 564         int ret;
 565
 566         memset(&dkey, 0, sizeof(DBT));
 567         dkey.size = keylen;
 568         dkey.data = (void *) key;
 569
 570         if (TSD->tid != NULL) {
 571                 memset(&dret, 0, sizeof(DBT));
 572                 dret.flags = DB_DBT_MALLOC;
 573                 ret = dbp[cdb]->get(dbp[cdb], TSD->tid, &dkey, &dret, 0);
 574         }
 575         else {
 576                 DBC *curs;
 577
 578                 do {
 579                         memset(&dret, 0, sizeof(DBT));
 580                         dret.flags = DB_DBT_MALLOC;
 581                         curs = bdb_localcursor(cdb);
 582                         ret = curs->c_get(curs, &dkey, &dret, DB_SET);
 583                         bdb_cclose(curs);
 584                 } while (ret == DB_LOCK_DEADLOCK);
 585         }
 586
 587         if ((ret != 0) && (ret != DB_NOTFOUND)) {
 588                 syslog(LOG_ERR, "bdb: bdb_fetch(%d): %s", cdb, db_strerror(ret));
 589                 bdb_abort();
 590         }
 591
 592         if (ret != 0) {
 593                 return NULL;
 594         }
 595
 596         tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 597         if (tempcdb == NULL) {
 598                 syslog(LOG_ERR, "bdb: bdb_fetch() cannot allocate memory for tempcdb: %m");
 599                 bdb_abort();
 600         }
 601         else {
 602                 tempcdb->len = dret.size;
 603                 tempcdb->ptr = dret.data;
 604                 bdb_decompress_if_necessary(tempcdb);
 605                 return (tempcdb);
 606         }
 607 }
 608
 609
 610 // Free a cdbdata item.
 611 //
 612 // Note that we only free the 'ptr' portion if it is not NULL.  This allows
 613 // other code to assume ownership of that memory simply by storing the
 614 // pointer elsewhere and then setting 'ptr' to NULL.  bdb_free() will then
 615 // avoid freeing it.
 616 void bdb_free(struct cdbdata *cdb) {
 617         if (cdb->ptr) {
 618                 free(cdb->ptr);
 619         }
 620         free(cdb);
 621 }
 622
 623
 624 void bdb_close_cursor(int cdb) {
 625         if (TSD->cursors[cdb] != NULL) {
 626                 bdb_cclose(TSD->cursors[cdb]);
 627         }
 628
 629         TSD->cursors[cdb] = NULL;
 630 }
 631
 632
 633 // Prepare for a sequential search of an entire database.
 634 // (There is guaranteed to be no more than one traversal in progress per thread at any given time.)
 635 void bdb_rewind(int cdb) {
 636         int ret = 0;
 637
 638         if (TSD->cursors[cdb] != NULL) {
 639                 syslog(LOG_ERR, "bdb: bdb_rewind: must close cursor on database %d before reopening", cdb);
 640                 bdb_abort();
 641                 // bdb_cclose(TSD->cursors[cdb]);
 642         }
 643
 644         // Now initialize the cursor
 645         ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &TSD->cursors[cdb], 0);
 646         if (ret) {
 647                 syslog(LOG_ERR, "bdb: bdb_rewind: db_cursor: %s", db_strerror(ret));
 648                 bdb_abort();
 649         }
 650 }
 651
 652
 653 // Fetch the next item in a sequential search.  Returns a pointer to a
 654 // cdbdata structure, or NULL if we've hit the end.
 655 struct cdbdata *bdb_next_item(int cdb) {
 656         DBT key, data;
 657         struct cdbdata *cdbret;
 658         int ret = 0;
 659
 660         // Initialize the key/data pair so the flags aren't set.
 661         memset(&key, 0, sizeof(key));
 662         memset(&data, 0, sizeof(data));
 663         data.flags = DB_DBT_MALLOC;
 664
 665         ret = TSD->cursors[cdb]->c_get(TSD->cursors[cdb], &key, &data, DB_NEXT);
 666
 667         if (ret) {
 668                 if (ret != DB_NOTFOUND) {
 669                         syslog(LOG_ERR, "bdb: bdb_next_item(%d): %s", cdb, db_strerror(ret));
 670                         bdb_abort();
 671                 }
 672                 bdb_close_cursor(cdb);
 673                 return NULL;    // presumably, end of file
 674         }
 675
 676         cdbret = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 677         cdbret->len = data.size;
 678         cdbret->ptr = data.data;
 679         bdb_decompress_if_necessary(cdbret);
 680
 681         return (cdbret);
 682 }
 683
 684
 685 // Transaction-based stuff.  I'm writing this as I bake cookies...
 686 void bdb_begin_transaction(void) {
 687         bdb_bailIfCursor(TSD->cursors, "can't begin transaction during r/o cursor");
 688
 689         if (TSD->tid != NULL) {
 690                 syslog(LOG_ERR, "bdb: bdb_begin_transaction: ERROR: nested transaction");
 691                 bdb_abort();
 692         }
 693
 694         bdb_txbegin(&TSD->tid);
 695 }
 696
 697
 698 void bdb_end_transaction(void) {
 699         int i;
 700
 701         for (i = 0; i < MAXCDB; i++) {
 702                 if (TSD->cursors[i] != NULL) {
 703                         syslog(LOG_WARNING, "bdb: bdb_end_transaction: WARNING: cursor %d still open at transaction end", i);
 704                         bdb_cclose(TSD->cursors[i]);
 705                         TSD->cursors[i] = NULL;
 706                 }
 707         }
 708
 709         if (TSD->tid == NULL) {
 710                 syslog(LOG_ERR, "bdb: bdb_end_transaction: ERROR: bdb_txcommit(NULL) !!");
 711                 bdb_abort();
 712         }
 713         else {
 714                 bdb_txcommit(TSD->tid);
 715         }
 716
 717         TSD->tid = NULL;
 718 }
 719
 720
 721 // Truncate (delete every record)
 722 void bdb_trunc(int cdb) {
 723         int ret;
 724         u_int32_t count;
 725
 726         if (TSD->tid != NULL) {
 727                 syslog(LOG_ERR, "bdb: bdb_trunc must not be called in a transaction.");
 728                 bdb_abort();
 729         }
 730         else {
 731                 bdb_bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 732
 733               retry:
 734
 735                 if ((ret = dbp[cdb]->truncate(dbp[cdb], // db
 736                                               NULL,     // transaction ID
 737                                               &count,   // #rows deleted
 738                                               0))) {    // flags
 739                         if (ret == DB_LOCK_DEADLOCK) {
 740                                 goto retry;
 741                         }
 742                         else {
 743                                 syslog(LOG_ERR, "bdb: bdb_truncate(%d): %s", cdb, db_strerror(ret));
 744                                 if (ret == ENOMEM) {
 745                                         syslog(LOG_ERR, "bdb: You may need to tune your database; please read http://www.citadel.org for more information.");
 746                                 }
 747                                 exit(CTDLEXIT_DB);
 748                         }
 749                 }
 750         }
 751 }
 752
 753
 754 // compact (defragment) the database, possibly returning space back to the underlying filesystem
 755 void bdb_compact(void) {
 756         int ret;
 757         int i;
 758
 759         syslog(LOG_DEBUG, "bdb: bdb_compact() started");
 760         for (i = 0; i < MAXCDB; i++) {
 761                 syslog(LOG_DEBUG, "bdb: compacting database %d", i);
 762                 ret = dbp[i]->compact(dbp[i], NULL, NULL, NULL, NULL, DB_FREE_SPACE, NULL);
 763                 if (ret) {
 764                         syslog(LOG_ERR, "bdb: compact: %s", db_strerror(ret));
 765                 }
 766         }
 767         syslog(LOG_DEBUG, "bdb: bdb_compact() finished");
 768 }
 769
 770
 771 // Calling this function activates the Berkeley DB back end.
 772 void bdb_init_backend(void) {
 773         cdb_compact = bdb_compact;
 774         cdb_checkpoint = bdb_checkpoint;
 775         cdb_rewind = bdb_rewind;
 776         cdb_fetch = bdb_fetch;
 777         cdb_open_databases = bdb_open_databases;
 778         cdb_close_databases = bdb_close_databases;
 779         cdb_store = bdb_store;
 780         cdb_delete = bdb_delete;
 781         cdb_free = bdb_free;
 782         cdb_next_item = bdb_next_item;
 783         cdb_close_cursor = bdb_close_cursor;
 784         cdb_begin_transaction = bdb_begin_transaction;
 785         cdb_end_transaction = bdb_end_transaction;
 786         cdb_check_handles = bdb_check_handles;
 787         cdb_trunc = bdb_trunc;
 788         cdb_chmod_data = bdb_chmod_data;
 789
 790         if (pthread_key_create(&bdb_thread_key, NULL) != 0) {                   // TSD key for this module
 791                 syslog(LOG_ERR, "pthread_key_create() : %m");
 792                 exit(CTDLEXIT_THREAD);
 793         }
 794
 795         syslog(LOG_INFO, "db: initialized Berkeley DB backend");
 796 }