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 // Wrapper for txn_begin() that logs/aborts on error.  Not part of the backend API.
 116 static void bdb_txbegin(DB_TXN **tid) {
 117         int ret;
 118
 119         ret = bdb_env->txn_begin(bdb_env, NULL, tid, 0);
 120
 121         if (ret) {
 122                 syslog(LOG_ERR, "bdb: txn_begin: %s", db_strerror(ret));
 123                 bdb_abort();
 124         }
 125 }
 126
 127
 128 // Panic callback for Berkeley DB.  Not part of the backend API.
 129 static void bdb_dbpanic(DB_ENV *env, int errval) {
 130         syslog(LOG_ERR, "bdb: PANIC: %s", db_strerror(errval));
 131         bdb_abort();
 132 }
 133
 134
 135 // Close a cursor -- not part of the backend API.
 136 static void bdb_cclose(DBC *cursor) {
 137         int ret;
 138
 139         if ((ret = cursor->c_close(cursor))) {
 140                 syslog(LOG_ERR, "bdb: c_close: %s", db_strerror(ret));
 141                 bdb_abort();
 142         }
 143 }
 144
 145
 146 // Convenience function to abort if a cursor is still open when we didn't expect it to be.
 147 // This is not part of the backend API.
 148 static void bdb_bailIfCursor(DBC **cursors, const char *msg) {
 149         int i;
 150
 151         for (i = 0; i < MAXCDB; i++)
 152                 if (cursors[i] != NULL) {
 153                         syslog(LOG_ERR, "bdb: cursor still in progress on cdb %02x: %s", i, msg);
 154                         bdb_abort();
 155                 }
 156 }
 157
 158
 159 void bdb_check_handles(void) {
 160         bdb_bailIfCursor(TSD->cursors, "in check_handles");
 161
 162         if (TSD->tid != NULL) {
 163                 syslog(LOG_ERR, "bdb: transaction still in progress!");
 164                 bdb_abort();
 165         }
 166 }
 167
 168
 169 // Request a checkpoint of the database.  Called once per minute by the thread manager.
 170 void bdb_checkpoint(void) {
 171         int ret;
 172
 173         syslog(LOG_DEBUG, "bdb: -- checkpoint --");
 174         ret = bdb_env->txn_checkpoint(bdb_env, MAX_CHECKPOINT_KBYTES, MAX_CHECKPOINT_MINUTES, 0);
 175
 176         if (ret != 0) {
 177                 syslog(LOG_ERR, "bdb: bdb_checkpoint() txn_checkpoint: %s", db_strerror(ret));
 178                 bdb_abort();
 179         }
 180
 181         // After a successful checkpoint, we can cull the unused logs
 182         ret = bdb_env->log_set_config(bdb_env, DB_LOG_AUTO_REMOVE, 1);
 183         if (ret != 0) {
 184                 syslog(LOG_ERR, "bdb: bdb_checkpoint() auto coll logs: %s", db_strerror(ret));
 185         }
 186 }
 187
 188
 189 // Open the various tables we'll be using.  Any table which
 190 // does not exist should be created.  Note that we don't need a
 191 // critical section here, because there aren't any active threads
 192 // manipulating the database yet.
 193 void bdb_open_databases(void) {
 194         int ret;
 195         int i;
 196         char dbfilename[32];
 197         u_int32_t flags = 0;
 198         int dbversion_major, dbversion_minor, dbversion_patch;
 199
 200         syslog(LOG_DEBUG, "bdb: bdb_open_databases() starting");
 201         syslog(LOG_DEBUG, "bdb:    Linked zlib: %s", zlibVersion());
 202         syslog(LOG_DEBUG, "bdb: Compiled libdb: %s", DB_VERSION_STRING);
 203         syslog(LOG_DEBUG, "bdb:   Linked libdb: %s", db_version(&dbversion_major, &dbversion_minor, &dbversion_patch));
 204
 205         // Create synthetic integer version numbers and compare them.
 206         // Never allow citserver to run with a libdb older then the one with which it was compiled.
 207         int compiled_db_version = ( (DB_VERSION_MAJOR * 1000000) + (DB_VERSION_MINOR * 1000) + (DB_VERSION_PATCH) );
 208         int linked_db_version = ( (dbversion_major * 1000000) + (dbversion_minor * 1000) + (dbversion_patch) );
 209         if (compiled_db_version > linked_db_version) {
 210                 syslog(LOG_ERR, "bdb: citserver is running with a version of libdb older than the one with which it was compiled.");
 211                 syslog(LOG_ERR, "bdb: This is an invalid configuration.  citserver will now exit to prevent data loss.");
 212                 exit(CTDLEXIT_DB);
 213         }
 214
 215         syslog(LOG_DEBUG, "bdb: Setting up DB environment");
 216         ret = db_env_create(&bdb_env, 0);
 217         if (ret) {
 218                 syslog(LOG_ERR, "bdb: db_env_create: %s", db_strerror(ret));
 219                 syslog(LOG_ERR, "bdb: exit code %d", ret);
 220                 exit(CTDLEXIT_DB);
 221         }
 222         bdb_env->set_errpfx(bdb_env, "citserver");
 223         bdb_env->set_paniccall(bdb_env, bdb_dbpanic);
 224         bdb_env->set_errcall(bdb_env, bdb_verbose_err);
 225         bdb_env->set_msgcall(bdb_env, bdb_verbose_log);
 226         bdb_env->set_verbose(bdb_env, DB_VERB_DEADLOCK, 1);
 227         bdb_env->set_verbose(bdb_env, DB_VERB_RECOVERY, 1);
 228
 229         // We want to specify the shared memory buffer pool cachesize, but everything else is the default.
 230         // 2023aug21 ajc: the third argument is zero, so this never did anything
 231         // ret = bdb_env->set_cachesize(bdb_env, 0, 64 * 1024, 0);
 232         // if (ret) {
 233                 // syslog(LOG_ERR, "bdb: set_cachesize: %s", db_strerror(ret));
 234                 // bdb_env->close(bdb_env, 0);
 235                 // syslog(LOG_ERR, "bdb: exit code %d", ret);
 236                 // exit(CTDLEXIT_DB);
 237         // }
 238
 239         // This appears to do nothing over and above the default
 240         //if ((ret = bdb_env->set_lk_detect(bdb_env, DB_LOCK_DEFAULT))) {
 241                 //syslog(LOG_ERR, "bdb: set_lk_detect: %s", db_strerror(ret));
 242                 //bdb_env->close(bdb_env, 0);
 243                 //syslog(LOG_ERR, "bdb: exit code %d", ret);
 244                 //exit(CTDLEXIT_DB);
 245         //}
 246
 247         flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_INIT_LOG;
 248         syslog(LOG_DEBUG, "bdb: bdb_env->open(bdb_env, %s, %d, 0)", ctdl_db_dir, flags);
 249         ret = bdb_env->open(bdb_env, ctdl_db_dir, flags, 0);                            // try opening the database cleanly
 250         if (ret == DB_RUNRECOVERY) {
 251                 syslog(LOG_ERR, "bdb: bdb_env->open: %s", db_strerror(ret));
 252                 syslog(LOG_ERR, "bdb: attempting recovery...");
 253                 flags |= DB_RECOVER;
 254                 ret = bdb_env->open(bdb_env, ctdl_db_dir, flags, 0);                    // try recovery
 255         }
 256         if (ret == DB_RUNRECOVERY) {
 257                 syslog(LOG_ERR, "bdb: bdb_env->open: %s", db_strerror(ret));
 258                 syslog(LOG_ERR, "bdb: attempting catastrophic recovery...");
 259                 flags &= ~DB_RECOVER;
 260                 flags |= DB_RECOVER_FATAL;
 261                 ret = bdb_env->open(bdb_env, ctdl_db_dir, flags, 0);                    // try catastrophic recovery
 262         }
 263         if (ret) {
 264                 syslog(LOG_ERR, "bdb: bdb_env->open: %s", db_strerror(ret));
 265                 bdb_env->close(bdb_env, 0);
 266                 syslog(LOG_ERR, "bdb: exit code %d", ret);
 267                 exit(CTDLEXIT_DB);
 268         }
 269
 270         for (i = 0; i < MAXCDB; ++i) {
 271                 syslog(LOG_INFO, "bdb: mounting database %02x", i);
 272                 ret = db_create(&bdb_table[i], bdb_env, 0);                             // Create a database handle
 273                 if (ret) {
 274                         syslog(LOG_ERR, "bdb: db_create: %s", db_strerror(ret));
 275                         syslog(LOG_ERR, "bdb: exit code %d", ret);
 276                         exit(CTDLEXIT_DB);
 277                 }
 278
 279                 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);                 // table names by number
 280                 ret = bdb_table[i]->open(bdb_table[i], NULL, dbfilename, NULL, DB_BTREE, DB_CREATE | DB_AUTO_COMMIT, 0600);
 281                 if (ret) {
 282                         syslog(LOG_ERR, "bdb: db_open[%02x]: %s", i, db_strerror(ret));
 283                         if (ret == ENOMEM) {
 284                                 syslog(LOG_ERR, "bdb: You may need to tune your database; please check http://www.citadel.org for more information.");
 285                         }
 286                         syslog(LOG_ERR, "bdb: exit code %d", ret);
 287                         exit(CTDLEXIT_DB);
 288                 }
 289         }
 290 }
 291
 292
 293 // 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.
 294 void bdb_close_databases(void) {
 295         int i;
 296         int ret;
 297
 298         static int closing = 0;
 299         while (closing == 1) {
 300                 syslog(LOG_INFO, "bdb: already closing");
 301         }
 302         closing = 1;
 303
 304         syslog(LOG_INFO, "bdb: performing final checkpoint");
 305         if ((ret = bdb_env->txn_checkpoint(bdb_env, 0, 0, 0))) {
 306                 syslog(LOG_ERR, "bdb: txn_checkpoint: %s", db_strerror(ret));
 307         }
 308
 309         syslog(LOG_INFO, "bdb: flushing the database logs");
 310         if ((ret = bdb_env->log_flush(bdb_env, NULL))) {
 311                 syslog(LOG_ERR, "bdb: log_flush: %s", db_strerror(ret));
 312         }
 313
 314         // close the tables
 315         syslog(LOG_INFO, "bdb: closing databases");
 316         for (i = 0; i < MAXCDB; ++i) {
 317                 syslog(LOG_INFO, "bdb: closing database %02x", i);
 318                 ret = bdb_table[i]->close(bdb_table[i], 0);
 319                 if (ret) {
 320                         syslog(LOG_ERR, "bdb: db_close: %s", db_strerror(ret));
 321                 }
 322         }
 323
 324         // Close the handle.
 325         ret = bdb_env->close(bdb_env, DB_FORCESYNC);
 326         if (ret) {
 327                 syslog(LOG_ERR, "bdb: DBENV->close: %s", db_strerror(ret));
 328         }
 329 }
 330
 331
 332 // Decompress a DBT data block if it was compressed on disk.
 333 void bdb_decompress_if_necessary(DBT *d) {
 334         static int magic = COMPRESS_MAGIC;
 335
 336         if ((d == NULL) || (d->data == NULL) || (d->size < sizeof(magic)) || (memcmp(d->data, &magic, sizeof(magic)))) {
 337                 return;
 338         }
 339
 340         // At this point we know we're looking at a compressed item.
 341
 342         struct CtdlCompressHeader zheader;
 343         char *uncompressed_data;
 344         char *compressed_data;
 345         uLongf destLen, sourceLen;
 346         size_t cplen;
 347
 348         memset(&zheader, 0, sizeof(struct CtdlCompressHeader));
 349         cplen = sizeof(struct CtdlCompressHeader);
 350         if (sizeof(struct CtdlCompressHeader) > d->size) {
 351                 cplen = d->size;
 352         }
 353         memcpy(&zheader, d->data, cplen);
 354
 355         compressed_data = d->data;
 356         compressed_data += sizeof(struct CtdlCompressHeader);
 357
 358         sourceLen = (uLongf) zheader.compressed_len;
 359         destLen = (uLongf) zheader.uncompressed_len;
 360         uncompressed_data = malloc(zheader.uncompressed_len);
 361
 362         if (uncompress((Bytef *) uncompressed_data,
 363                        (uLongf *) &destLen, (const Bytef *) compressed_data, (uLong) sourceLen) != Z_OK) {
 364                 syslog(LOG_ERR, "bdb: uncompress() error");
 365                 bdb_abort();
 366         }
 367
 368         free(d->data);
 369         d->size = (size_t) destLen;
 370         d->data = uncompressed_data;
 371 }
 372
 373
 374 // Store a piece of data.  Returns 0 if the operation was successful.  If a
 375 // key already exists it should be overwritten.
 376 int bdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) {
 377
 378         DBT dkey, ddata;
 379         DB_TXN *tid = NULL;
 380         int ret = 0;
 381         struct CtdlCompressHeader zheader;
 382         char *compressed_data = NULL;
 383         int compressing = 0;
 384         size_t buffer_len = 0;
 385         uLongf destLen = 0;
 386
 387         memset(&dkey, 0, sizeof(DBT));
 388         memset(&ddata, 0, sizeof(DBT));
 389         dkey.size = ckeylen;
 390         dkey.data = (void *) ckey;
 391         ddata.size = cdatalen;
 392         ddata.data = cdata;
 393
 394         // "visit" records are numerous and have big, mostly-empty string buffers in them.
 395         // If we compress these we can get them down to 1% of their size most of the time.
 396         if (cdb == CDB_VISIT) {
 397                 compressing = 1;
 398                 zheader.magic = COMPRESS_MAGIC;
 399                 zheader.uncompressed_len = cdatalen;
 400                 buffer_len = ((cdatalen * 101) / 100) + 100 + sizeof(struct CtdlCompressHeader);
 401                 destLen = (uLongf) buffer_len;
 402                 compressed_data = malloc(buffer_len);
 403                 if (compress2((Bytef *) (compressed_data + sizeof(struct CtdlCompressHeader)), &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK) {
 404                         syslog(LOG_ERR, "bdb: compress2() error");
 405                         bdb_abort();
 406                 }
 407                 zheader.compressed_len = (size_t) destLen;
 408                 memcpy(compressed_data, &zheader, sizeof(struct CtdlCompressHeader));
 409                 ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) + zheader.compressed_len);
 410                 ddata.data = compressed_data;
 411         }
 412
 413         if (TSD->tid != NULL) {
 414                 ret = bdb_table[cdb]->put(bdb_table[cdb],       // db
 415                                     TSD->tid,                   // transaction ID
 416                                     &dkey,                      // key
 417                                     &ddata,                     // data
 418                                     0                           // flags
 419                 );
 420                 if (ret) {
 421                         syslog(LOG_ERR, "bdb: bdb_store(%d): %s", cdb, db_strerror(ret));
 422                         bdb_abort();
 423                 }
 424                 if (compressing) {
 425                         free(compressed_data);
 426                 }
 427                 return ret;
 428         }
 429         else {
 430                 bdb_bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 431
 432               retry:
 433                 bdb_txbegin(&tid);
 434
 435                 if ((ret = bdb_table[cdb]->put(bdb_table[cdb],  // db
 436                                          tid,                   // transaction ID
 437                                          &dkey,                 // key
 438                                          &ddata,                // data
 439                                          0))) {                 // flags
 440                         if (ret == DB_LOCK_DEADLOCK) {
 441                                 bdb_txabort(tid);
 442                                 goto retry;
 443                         }
 444                         else {
 445                                 syslog(LOG_ERR, "bdb: bdb_store(%d): %s", cdb, db_strerror(ret));
 446                                 bdb_abort();
 447                         }
 448                 }
 449                 else {
 450                         bdb_txcommit(tid);
 451                         if (compressing) {
 452                                 free(compressed_data);
 453                         }
 454                         return ret;
 455                 }
 456         }
 457         return ret;
 458 }
 459
 460
 461 // Delete a piece of data.  Returns 0 if the operation was successful.
 462 int bdb_delete(int cdb, void *key, int keylen) {
 463         DBT dkey;
 464         DB_TXN *tid;
 465         int ret;
 466
 467         memset(&dkey, 0, sizeof dkey);
 468         dkey.size = keylen;
 469         dkey.data = key;
 470
 471         if (TSD->tid != NULL) {
 472                 ret = bdb_table[cdb]->del(bdb_table[cdb], TSD->tid, &dkey, 0);
 473                 if (ret) {
 474                         syslog(LOG_ERR, "bdb: bdb_delete(%d): %s", cdb, db_strerror(ret));
 475                         if (ret != DB_NOTFOUND) {
 476                                 bdb_abort();
 477                         }
 478                 }
 479         }
 480         else {
 481                 bdb_bailIfCursor(TSD->cursors, "attempt to delete during r/o cursor");
 482
 483               retry:
 484                 bdb_txbegin(&tid);
 485
 486                 if ((ret = bdb_table[cdb]->del(bdb_table[cdb], tid, &dkey, 0)) && ret != DB_NOTFOUND) {
 487                         if (ret == DB_LOCK_DEADLOCK) {
 488                                 bdb_txabort(tid);
 489                                 goto retry;
 490                         }
 491                         else {
 492                                 syslog(LOG_ERR, "bdb: bdb_delete(%d): %s", cdb, db_strerror(ret));
 493                                 bdb_abort();
 494                         }
 495                 }
 496                 else {
 497                         bdb_txcommit(tid);
 498                 }
 499         }
 500         return ret;
 501 }
 502
 503
 504 static DBC *bdb_localcursor(int cdb) {
 505         int ret;
 506         DBC *curs;
 507
 508         if (TSD->cursors[cdb] == NULL) {
 509                 ret = bdb_table[cdb]->cursor(bdb_table[cdb], TSD->tid, &curs, 0);
 510         }
 511         else {
 512                 ret = TSD->cursors[cdb]->c_dup(TSD->cursors[cdb], &curs, DB_POSITION);
 513         }
 514
 515         if (ret) {
 516                 syslog(LOG_ERR, "bdb: bdb_localcursor: %s", db_strerror(ret));
 517                 bdb_abort();
 518         }
 519
 520         return curs;
 521 }
 522
 523
 524 // Fetch a piece of data.  Returns a "struct cdbdata"
 525 // cdbdata.len will be 0 if the item is not found.
 526 struct cdbdata bdb_fetch(int cdb, const void *key, int keylen) {
 527
 528         struct cdbdata returned_data;
 529         memset(&returned_data, 0, sizeof(struct cdbdata));
 530
 531         if (keylen == 0) {              // key length zero is impossible
 532                 return(returned_data);
 533         }
 534
 535         DBT dkey;
 536         int ret;
 537
 538         memset(&dkey, 0, sizeof(DBT));
 539         dkey.size = keylen;
 540         dkey.data = (void *) key;
 541
 542         if (TSD->tid != NULL) {
 543                 TSD->dbdata[cdb].flags = DB_DBT_REALLOC;
 544                 ret = bdb_table[cdb]->get(bdb_table[cdb], TSD->tid, &dkey, &TSD->dbdata[cdb], 0);
 545         }
 546         else {
 547                 DBC *curs;
 548
 549                 do {
 550                         TSD->dbdata[cdb].flags = DB_DBT_REALLOC;
 551                         curs = bdb_localcursor(cdb);
 552                         ret = curs->c_get(curs, &dkey, &TSD->dbdata[cdb], DB_SET);
 553                         bdb_cclose(curs);
 554                 } while (ret == DB_LOCK_DEADLOCK);
 555         }
 556
 557         if ((ret != 0) && (ret != DB_NOTFOUND)) {
 558                 syslog(LOG_ERR, "bdb: bdb_fetch(%d): %s", cdb, db_strerror(ret));
 559                 bdb_abort();
 560         }
 561
 562         if (ret == 0) {
 563                 bdb_decompress_if_necessary(&TSD->dbdata[cdb]);
 564                 returned_data.len = TSD->dbdata[cdb].size;
 565                 returned_data.ptr = TSD->dbdata[cdb].data;
 566         }
 567
 568         return(returned_data);
 569 }
 570
 571
 572 void bdb_close_cursor(int cdb) {
 573         if (TSD->cursors[cdb] != NULL) {
 574                 bdb_cclose(TSD->cursors[cdb]);
 575         }
 576
 577         TSD->cursors[cdb] = NULL;
 578 }
 579
 580
 581 // Prepare for a sequential search of an entire database.
 582 // (There is guaranteed to be no more than one traversal in progress per thread at any given time.)
 583 void bdb_rewind(int cdb) {
 584         int ret = 0;
 585
 586         if (TSD->cursors[cdb] != NULL) {
 587                 syslog(LOG_ERR, "bdb: bdb_rewind: must close cursor on database %d before reopening", cdb);
 588                 bdb_abort();
 589                 // bdb_cclose(TSD->cursors[cdb]);
 590         }
 591
 592         // Now initialize the cursor
 593         ret = bdb_table[cdb]->cursor(bdb_table[cdb], TSD->tid, &TSD->cursors[cdb], 0);
 594         if (ret) {
 595                 syslog(LOG_ERR, "bdb: bdb_rewind: db_cursor: %s", db_strerror(ret));
 596                 bdb_abort();
 597         }
 598 }
 599
 600
 601 // Fetch the next item in a sequential search.  Returns a pointer to a
 602 // cdbdata structure, or NULL if we've hit the end.
 603 struct cdbkeyval bdb_next_item(int cdb) {
 604         struct cdbkeyval kv;
 605         int ret = 0;
 606
 607         memset(&kv, 0, sizeof(struct cdbkeyval));
 608
 609         // reuse memory from the previous call.
 610         TSD->dbkey[cdb].flags = DB_DBT_MALLOC;
 611         TSD->dbdata[cdb].flags = DB_DBT_MALLOC;
 612
 613         assert(TSD->cursors[cdb] != NULL);
 614         ret = TSD->cursors[cdb]->c_get(TSD->cursors[cdb], &TSD->dbkey[cdb], &TSD->dbdata[cdb], DB_NEXT);
 615
 616         if (ret) {
 617                 if (ret != DB_NOTFOUND) {
 618                         syslog(LOG_ERR, "bdb: bdb_next_item(%d): %s", cdb, db_strerror(ret));
 619                         bdb_abort();
 620                 }
 621                 bdb_close_cursor(cdb);
 622                 return(kv);             // presumably, we are at the end
 623         }
 624
 625         bdb_decompress_if_necessary(&TSD->dbdata[cdb]);
 626
 627         kv.key.len = TSD->dbkey[cdb].size;
 628         kv.key.ptr = TSD->dbkey[cdb].data;
 629         kv.val.len = TSD->dbdata[cdb].size;
 630         kv.val.ptr = TSD->dbdata[cdb].data;
 631         return (kv);
 632 }
 633
 634
 635 // Transaction-based stuff.  I'm writing this as I bake cookies...
 636 void bdb_begin_transaction(void) {
 637         bdb_bailIfCursor(TSD->cursors, "can't begin transaction during r/o cursor");
 638
 639         if (TSD->tid != NULL) {
 640                 syslog(LOG_ERR, "bdb: bdb_begin_transaction: ERROR: nested transaction");
 641                 bdb_abort();
 642         }
 643
 644         bdb_txbegin(&TSD->tid);
 645 }
 646
 647
 648 void bdb_end_transaction(void) {
 649         int i;
 650
 651         for (i = 0; i < MAXCDB; i++) {
 652                 if (TSD->cursors[i] != NULL) {
 653                         syslog(LOG_WARNING, "bdb: bdb_end_transaction: WARNING: cursor %d still open at transaction end", i);
 654                         bdb_cclose(TSD->cursors[i]);
 655                         TSD->cursors[i] = NULL;
 656                 }
 657         }
 658
 659         if (TSD->tid == NULL) {
 660                 syslog(LOG_ERR, "bdb: bdb_end_transaction: ERROR: bdb_txcommit(NULL) !!");
 661                 bdb_abort();
 662         }
 663         else {
 664                 bdb_txcommit(TSD->tid);
 665         }
 666
 667         TSD->tid = NULL;
 668 }
 669
 670
 671 // Truncate (delete every record)
 672 void bdb_trunc(int cdb) {
 673         int ret;
 674         u_int32_t count;
 675
 676         if (TSD->tid != NULL) {
 677                 syslog(LOG_ERR, "bdb: bdb_trunc must not be called in a transaction.");
 678                 bdb_abort();
 679         }
 680         else {
 681                 bdb_bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 682
 683               retry:
 684
 685                 if ((ret = bdb_table[cdb]->truncate(bdb_table[cdb],     // db
 686                                               NULL,                     // transaction ID
 687                                               &count,                   // #rows deleted
 688                                               0))) {                    // flags
 689                         if (ret == DB_LOCK_DEADLOCK) {
 690                                 goto retry;
 691                         }
 692                         else {
 693                                 syslog(LOG_ERR, "bdb: bdb_truncate(%d): %s", cdb, db_strerror(ret));
 694                                 if (ret == ENOMEM) {
 695                                         syslog(LOG_ERR, "bdb: You may need to tune your database; please read http://www.citadel.org for more information.");
 696                                 }
 697                                 exit(CTDLEXIT_DB);
 698                         }
 699                 }
 700         }
 701 }
 702
 703
 704 // compact (defragment) the database, possibly returning space back to the underlying filesystem
 705 void bdb_compact(void) {
 706         int ret;
 707         int i;
 708
 709         syslog(LOG_DEBUG, "bdb: bdb_compact() started");
 710         for (i = 0; i < MAXCDB; i++) {
 711                 syslog(LOG_DEBUG, "bdb: compacting database %d", i);
 712                 ret = bdb_table[i]->compact(bdb_table[i], NULL, NULL, NULL, NULL, DB_FREE_SPACE, NULL);
 713                 if (ret) {
 714                         syslog(LOG_ERR, "bdb: compact: %s", db_strerror(ret));
 715                 }
 716         }
 717         syslog(LOG_DEBUG, "bdb: bdb_compact() finished");
 718 }
 719
 720
 721 // Calling this function activates the Berkeley DB back end.
 722 void bdb_init_backend(void) {
 723
 724         // Assign the backend API stubs to the functions in this module.
 725         cdb_compact = bdb_compact;
 726         cdb_checkpoint = bdb_checkpoint;
 727         cdb_rewind = bdb_rewind;
 728         cdb_fetch = bdb_fetch;
 729         cdb_open_databases = bdb_open_databases;
 730         cdb_close_databases = bdb_close_databases;
 731         cdb_store = bdb_store;
 732         cdb_delete = bdb_delete;
 733         cdb_next_item = bdb_next_item;
 734         cdb_close_cursor = bdb_close_cursor;
 735         cdb_begin_transaction = bdb_begin_transaction;
 736         cdb_end_transaction = bdb_end_transaction;
 737         cdb_check_handles = bdb_check_handles;
 738         cdb_trunc = bdb_trunc;
 739
 740         // Some functions in this backend need to store some per-thread data.
 741         // We crerate the key here, during module initialization.
 742         if (pthread_key_create(&bdb_thread_key, NULL) != 0) {
 743                 syslog(LOG_ERR, "pthread_key_create() : %m");
 744                 exit(CTDLEXIT_THREAD);
 745         }
 746
 747         syslog(LOG_INFO, "db: initialized Berkeley DB backend");
 748 }