citadel/database_sleepycat.c

   1 /*
   2  * $Id$
   3  *
   4  * Sleepycat (Berkeley) DB driver for Citadel
   5  *
   6  */
   7
   8 /*****************************************************************************
   9        Tunable configuration parameters for the Sleepycat DB back end
  10  *****************************************************************************/
  11
  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.
  15  */
  16 #define MAX_CHECKPOINT_KBYTES   256
  17 #define MAX_CHECKPOINT_MINUTES  15
  18
  19 /*****************************************************************************/
  20
  21 #include "sysdep.h"
  22 #include <stdlib.h>
  23 #include <unistd.h>
  24 #include <stdio.h>
  25 #include <ctype.h>
  26 #include <string.h>
  27 #include <errno.h>
  28 #include <sys/types.h>
  29 #include <sys/stat.h>
  30 #include <dirent.h>
  31
  32 #ifdef HAVE_DB_H
  33 #include <db.h>
  34 #elif defined(HAVE_DB4_DB_H)
  35 #include <db4/db.h>
  36 #else
  37 #error Neither <db.h> nor <db4/db.h> was found by configure. Install db4-devel.
  38 #endif
  39
  40
  41 #if DB_VERSION_MAJOR < 4 || DB_VERSION_MINOR < 1
  42 #error Citadel requires Berkeley DB v4.1 or newer.  Please upgrade.
  43 #endif
  44
  45
  46 #include "citadel.h"
  47 #include "server.h"
  48 #include "citserver.h"
  49 #include "database.h"
  50 #include "msgbase.h"
  51 #include "sysdep_decls.h"
  52 #include "threads.h"
  53 #include "config.h"
  54
  55 #include "ctdl_module.h"
  56
  57
  58 static DB *dbp[MAXCDB];         /* One DB handle for each Citadel database */
  59 static DB_ENV *dbenv;           /* The DB environment (global) */
  60
  61
  62 #ifdef HAVE_ZLIB
  63 #include <zlib.h>
  64 #endif
  65
  66
  67 /* Verbose logging callback */
  68 void cdb_verbose_log(const DB_ENV *dbenv, const char *msg)
  69 {
  70         CtdlLogPrintf(CTDL_DEBUG, "BDB: %s\n", msg);
  71 }
  72
  73
  74 /* Verbose logging callback */
  75 void cdb_verbose_err(const DB_ENV *dbenv, const char *errpfx, const char *msg)
  76 {
  77         CtdlLogPrintf(CTDL_ALERT, "BDB: %s\n", msg);
  78 }
  79
  80
  81 /* just a little helper function */
  82 static void txabort(DB_TXN * tid)
  83 {
  84         int ret;
  85
  86         ret = tid->abort(tid);
  87
  88         if (ret) {
  89                 CtdlLogPrintf(CTDL_EMERG, "cdb_*: txn_abort: %s\n",
  90                         db_strerror(ret));
  91                 abort();
  92         }
  93 }
  94
  95 /* this one is even more helpful than the last. */
  96 static void txcommit(DB_TXN * tid)
  97 {
  98         int ret;
  99
 100         ret = tid->commit(tid, 0);
 101
 102         if (ret) {
 103                 CtdlLogPrintf(CTDL_EMERG, "cdb_*: txn_commit: %s\n",
 104                         db_strerror(ret));
 105                 abort();
 106         }
 107 }
 108
 109 /* are you sensing a pattern yet? */
 110 static void txbegin(DB_TXN ** tid)
 111 {
 112         int ret;
 113
 114         ret = dbenv->txn_begin(dbenv, NULL, tid, 0);
 115
 116         if (ret) {
 117                 CtdlLogPrintf(CTDL_EMERG, "cdb_*: txn_begin: %s\n",
 118                         db_strerror(ret));
 119                 abort();
 120         }
 121 }
 122
 123 static void dbpanic(DB_ENV * env, int errval)
 124 {
 125         CtdlLogPrintf(CTDL_EMERG, "cdb_*: Berkeley DB panic: %d\n", errval);
 126 }
 127
 128 static void cclose(DBC * cursor)
 129 {
 130         int ret;
 131
 132         if ((ret = cursor->c_close(cursor))) {
 133                 CtdlLogPrintf(CTDL_EMERG, "cdb_*: c_close: %s\n",
 134                         db_strerror(ret));
 135                 abort();
 136         }
 137 }
 138
 139 static void bailIfCursor(DBC ** cursors, const char *msg)
 140 {
 141         int i;
 142
 143         for (i = 0; i < MAXCDB; i++)
 144                 if (cursors[i] != NULL) {
 145                         CtdlLogPrintf(CTDL_EMERG,
 146                                 "cdb_*: cursor still in progress on cdb %d: %s\n",
 147                                 i, msg);
 148                         abort();
 149                 }
 150 }
 151
 152 void check_handles(void *arg)
 153 {
 154         if (arg != NULL) {
 155                 ThreadTSD *tsd = (ThreadTSD *) arg;
 156
 157                 bailIfCursor(tsd->cursors, "in check_handles");
 158
 159                 if (tsd->tid != NULL) {
 160                         CtdlLogPrintf(CTDL_EMERG,
 161                                 "cdb_*: transaction still in progress!");
 162                         abort();
 163                 }
 164         }
 165 }
 166
 167 void cdb_check_handles(void)
 168 {
 169         check_handles(pthread_getspecific(ThreadKey));
 170 }
 171
 172
 173 /*
 174  * Cull the database logs
 175  */
 176 static void cdb_cull_logs(void)
 177 {
 178         u_int32_t flags;
 179         int ret;
 180         char **file, **list;
 181         char errmsg[SIZ];
 182
 183         flags = DB_ARCH_ABS;
 184
 185         /* Get the list of names. */
 186         if ((ret = dbenv->log_archive(dbenv, &list, flags)) != 0) {
 187                 CtdlLogPrintf(CTDL_ERR, "cdb_cull_logs: %s\n", db_strerror(ret));
 188                 return;
 189         }
 190
 191         /* Print the list of names. */
 192         if (list != NULL) {
 193                 for (file = list; *file != NULL; ++file) {
 194                         CtdlLogPrintf(CTDL_DEBUG, "Deleting log: %s\n", *file);
 195                         ret = unlink(*file);
 196                         if (ret != 0) {
 197                                 snprintf(errmsg, sizeof(errmsg),
 198                                          " ** ERROR **\n \n \n "
 199                                          "Citadel was unable to delete the "
 200                                          "database log file '%s' because of the "
 201                                          "following error:\n \n %s\n \n"
 202                                          " This log file is no longer in use "
 203                                          "and may be safely deleted.\n",
 204                                          *file, strerror(errno));
 205                                 aide_message(errmsg, "Database Warning Message");
 206                         }
 207                 }
 208                 free(list);
 209         }
 210 }
 211
 212 /*
 213  * Manually initiate log file cull.
 214  */
 215 void cmd_cull(char *argbuf) {
 216         if (CtdlAccessCheck(ac_internal)) return;
 217         cdb_cull_logs();
 218         cprintf("%d Database log file cull completed.\n", CIT_OK);
 219 }
 220
 221
 222 /*
 223  * Request a checkpoint of the database.
 224  */
 225 void cdb_checkpoint(void)
 226 {
 227         int ret;
 228 //      static time_t last_run = 0L;
 229
 230         /* Only do a checkpoint once per minute. */
 231 /*
 232  * Don't need this any more, since the thread that calls us sleeps for 60 seconds between calls
 233
 234         if ((time(NULL) - last_run) < 60L) {
 235                 return;
 236         }
 237         last_run = time(NULL);
 238 */
 239
 240         CtdlLogPrintf(CTDL_DEBUG, "-- db checkpoint --\n");
 241         ret = dbenv->txn_checkpoint(dbenv,
 242                                     MAX_CHECKPOINT_KBYTES,
 243                                     MAX_CHECKPOINT_MINUTES, 0);
 244
 245         if (ret != 0) {
 246                 CtdlLogPrintf(CTDL_EMERG, "cdb_checkpoint: txn_checkpoint: %s\n",
 247                         db_strerror(ret));
 248                 abort();
 249         }
 250
 251         /* After a successful checkpoint, we can cull the unused logs */
 252         if (config.c_auto_cull) {
 253                 cdb_cull_logs();
 254         }
 255 }
 256
 257
 258
 259 /*
 260  * Open the various databases we'll be using.  Any database which
 261  * does not exist should be created.  Note that we don't need a
 262  * critical section here, because there aren't any active threads
 263  * manipulating the database yet.
 264  */
 265 void open_databases(void)
 266 {
 267         int ret;
 268         int i;
 269         char dbfilename[SIZ];
 270         u_int32_t flags = 0;
 271
 272         CtdlLogPrintf(CTDL_DEBUG, "cdb_*: open_databases() starting\n");
 273         CtdlLogPrintf(CTDL_DEBUG, "Compiled db: %s\n", DB_VERSION_STRING);
 274         CtdlLogPrintf(CTDL_INFO, "  Linked db: %s\n",
 275                 db_version(NULL, NULL, NULL));
 276 #ifdef HAVE_ZLIB
 277         CtdlLogPrintf(CTDL_INFO, "Linked zlib: %s\n", zlibVersion());
 278 #endif
 279
 280         /*
 281          * Silently try to create the database subdirectory.  If it's
 282          * already there, no problem.
 283          */
 284         mkdir(ctdl_data_dir, 0700);
 285         chmod(ctdl_data_dir, 0700);
 286         chown(ctdl_data_dir, CTDLUID, (-1));
 287
 288         CtdlLogPrintf(CTDL_DEBUG, "cdb_*: Setting up DB environment\n");
 289         db_env_set_func_yield(sched_yield);
 290         ret = db_env_create(&dbenv, 0);
 291         if (ret) {
 292                 CtdlLogPrintf(CTDL_EMERG, "cdb_*: db_env_create: %s\n",
 293                         db_strerror(ret));
 294                 exit(CTDLEXIT_DB);
 295         }
 296         dbenv->set_errpfx(dbenv, "citserver");
 297         dbenv->set_paniccall(dbenv, dbpanic);
 298         dbenv->set_errcall(dbenv, cdb_verbose_err);
 299         dbenv->set_errpfx(dbenv, "ctdl");
 300 #if (DB_VERSION_MAJOR == 4) && (DB_VERSION_MINOR >= 3)
 301         dbenv->set_msgcall(dbenv, cdb_verbose_log);
 302 #endif
 303         dbenv->set_verbose(dbenv, DB_VERB_DEADLOCK, 1);
 304         dbenv->set_verbose(dbenv, DB_VERB_RECOVERY, 1);
 305
 306         /*
 307          * We want to specify the shared memory buffer pool cachesize,
 308          * but everything else is the default.
 309          */
 310         ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
 311         if (ret) {
 312                 CtdlLogPrintf(CTDL_EMERG, "cdb_*: set_cachesize: %s\n",
 313                         db_strerror(ret));
 314                 dbenv->close(dbenv, 0);
 315                 exit(CTDLEXIT_DB);
 316         }
 317
 318         if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
 319                 CtdlLogPrintf(CTDL_EMERG, "cdb_*: set_lk_detect: %s\n",
 320                         db_strerror(ret));
 321                 dbenv->close(dbenv, 0);
 322                 exit(CTDLEXIT_DB);
 323         }
 324
 325         flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_RECOVER;
 326         CtdlLogPrintf(CTDL_DEBUG, "dbenv->open(dbenv, %s, %d, 0)\n", ctdl_data_dir, flags);
 327         ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
 328         if (ret == DB_RUNRECOVERY) {
 329                 CtdlLogPrintf(CTDL_ALERT, "dbenv->open: %s\n", db_strerror(ret));
 330                 CtdlLogPrintf(CTDL_ALERT, "Attempting recovery...\n");
 331                 flags |= DB_RECOVER;
 332                 ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
 333         }
 334         if (ret == DB_RUNRECOVERY) {
 335                 CtdlLogPrintf(CTDL_ALERT, "dbenv->open: %s\n", db_strerror(ret));
 336                 CtdlLogPrintf(CTDL_ALERT, "Attempting catastrophic recovery...\n");
 337                 flags &= ~DB_RECOVER;
 338                 flags |= DB_RECOVER_FATAL;
 339                 ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
 340         }
 341         if (ret) {
 342                 CtdlLogPrintf(CTDL_DEBUG, "dbenv->open: %s\n", db_strerror(ret));
 343                 dbenv->close(dbenv, 0);
 344                 exit(CTDLEXIT_DB);
 345         }
 346
 347         CtdlLogPrintf(CTDL_INFO, "Starting up DB\n");
 348
 349         for (i = 0; i < MAXCDB; ++i) {
 350
 351                 /* Create a database handle */
 352                 ret = db_create(&dbp[i], dbenv, 0);
 353                 if (ret) {
 354                         CtdlLogPrintf(CTDL_DEBUG, "db_create: %s\n",
 355                                 db_strerror(ret));
 356                         exit(CTDLEXIT_DB);
 357                 }
 358
 359
 360                 /* Arbitrary names for our tables -- we reference them by
 361                  * number, so we don't have string names for them.
 362                  */
 363                 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);
 364
 365                 ret = dbp[i]->open(dbp[i],
 366                                    NULL,
 367                                    dbfilename,
 368                                    NULL,
 369                                    DB_BTREE,
 370                                    DB_CREATE | DB_AUTO_COMMIT | DB_THREAD,
 371                                    0600);
 372                 if (ret) {
 373                         CtdlLogPrintf(CTDL_EMERG, "db_open[%d]: %s\n", i,
 374                                 db_strerror(ret));
 375                         exit(CTDLEXIT_DB);
 376                 }
 377         }
 378
 379 }
 380
 381
 382 /* Make sure we own all the files, because in a few milliseconds
 383  * we're going to drop root privs.
 384  */
 385 void cdb_chmod_data(void) {
 386         DIR *dp;
 387         struct dirent *d;
 388         char filename[PATH_MAX];
 389
 390         dp = opendir(ctdl_data_dir);
 391         if (dp != NULL) {
 392                 while (d = readdir(dp), d != NULL) {
 393                         if (d->d_name[0] != '.') {
 394                                 snprintf(filename, sizeof filename,
 395                                          "%s/%s", ctdl_data_dir, d->d_name);
 396                                 CtdlLogPrintf(9, "chmod(%s, 0600) returned %d\n",
 397                                         filename, chmod(filename, 0600)
 398                                 );
 399                                 CtdlLogPrintf(9, "chown(%s, CTDLUID, -1) returned %d\n",
 400                                         filename, chown(filename, CTDLUID, (-1))
 401                                 );
 402                         }
 403                 }
 404                 closedir(dp);
 405         }
 406
 407         CtdlLogPrintf(CTDL_DEBUG, "open_databases() finished\n");
 408
 409         CtdlRegisterProtoHook(cmd_cull, "CULL", "Cull database logs");
 410 }
 411
 412
 413 /*
 414  * Close all of the db database files we've opened.  This can be done
 415  * in a loop, since it's just a bunch of closes.
 416  */
 417 void close_databases(void)
 418 {
 419         int a;
 420         int ret;
 421
 422         ctdl_thread_internal_free_tsd();
 423
 424         if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) {
 425                 CtdlLogPrintf(CTDL_EMERG,
 426                         "txn_checkpoint: %s\n", db_strerror(ret));
 427         }
 428
 429         /* print some statistics... */
 430 #ifdef DB_STAT_ALL
 431         dbenv->lock_stat_print(dbenv, DB_STAT_ALL);
 432 #endif
 433
 434         /* close the tables */
 435         for (a = 0; a < MAXCDB; ++a) {
 436                 CtdlLogPrintf(CTDL_INFO, "Closing database %d\n", a);
 437                 ret = dbp[a]->close(dbp[a], 0);
 438                 if (ret) {
 439                         CtdlLogPrintf(CTDL_EMERG,
 440                                 "db_close: %s\n", db_strerror(ret));
 441                 }
 442
 443         }
 444
 445         /* Close the handle. */
 446         ret = dbenv->close(dbenv, 0);
 447         if (ret) {
 448                 CtdlLogPrintf(CTDL_EMERG,
 449                         "DBENV->close: %s\n", db_strerror(ret));
 450         }
 451 }
 452
 453
 454 /*
 455  * Compression functions only used if we have zlib
 456  */
 457 #ifdef HAVE_ZLIB
 458
 459 void cdb_decompress_if_necessary(struct cdbdata *cdb)
 460 {
 461         static int magic = COMPRESS_MAGIC;
 462         struct CtdlCompressHeader zheader;
 463         char *uncompressed_data;
 464         char *compressed_data;
 465         uLongf destLen, sourceLen;
 466
 467         if (cdb == NULL)
 468                 return;
 469         if (cdb->ptr == NULL)
 470                 return;
 471         if (memcmp(cdb->ptr, &magic, sizeof(magic)))
 472                 return;
 473
 474         /* At this point we know we're looking at a compressed item. */
 475         memcpy(&zheader, cdb->ptr, sizeof(struct CtdlCompressHeader));
 476
 477         compressed_data = cdb->ptr;
 478         compressed_data += sizeof(struct CtdlCompressHeader);
 479
 480         sourceLen = (uLongf) zheader.compressed_len;
 481         destLen = (uLongf) zheader.uncompressed_len;
 482         uncompressed_data = malloc(zheader.uncompressed_len);
 483
 484         if (uncompress((Bytef *) uncompressed_data,
 485                        (uLongf *) & destLen,
 486                        (const Bytef *) compressed_data,
 487                        (uLong) sourceLen) != Z_OK) {
 488                 CtdlLogPrintf(CTDL_EMERG, "uncompress() error\n");
 489                 abort();
 490         }
 491
 492         free(cdb->ptr);
 493         cdb->len = (size_t) destLen;
 494         cdb->ptr = uncompressed_data;
 495 }
 496
 497 #endif                          /* HAVE_ZLIB */
 498
 499
 500 /*
 501  * Store a piece of data.  Returns 0 if the operation was successful.  If a
 502  * key already exists it should be overwritten.
 503  */
 504 int cdb_store(int cdb, void *ckey, int ckeylen, void *cdata, int cdatalen)
 505 {
 506
 507         DBT dkey, ddata;
 508         DB_TXN *tid;
 509         int ret = 0;
 510
 511 #ifdef HAVE_ZLIB
 512         struct CtdlCompressHeader zheader;
 513         char *compressed_data = NULL;
 514         int compressing = 0;
 515         size_t buffer_len = 0;
 516         uLongf destLen = 0;
 517 #endif
 518
 519         memset(&dkey, 0, sizeof(DBT));
 520         memset(&ddata, 0, sizeof(DBT));
 521         dkey.size = ckeylen;
 522         dkey.data = ckey;
 523         ddata.size = cdatalen;
 524         ddata.data = cdata;
 525
 526 #ifdef HAVE_ZLIB
 527         /* Only compress Visit records.  Everything else is uncompressed. */
 528         if (cdb == CDB_VISIT) {
 529                 compressing = 1;
 530                 zheader.magic = COMPRESS_MAGIC;
 531                 zheader.uncompressed_len = cdatalen;
 532                 buffer_len = ((cdatalen * 101) / 100) + 100
 533                     + sizeof(struct CtdlCompressHeader);
 534                 destLen = (uLongf) buffer_len;
 535                 compressed_data = malloc(buffer_len);
 536                 if (compress2((Bytef *) (compressed_data +
 537                                          sizeof(struct
 538                                                 CtdlCompressHeader)),
 539                               &destLen, (Bytef *) cdata, (uLongf) cdatalen,
 540                               1) != Z_OK) {
 541                         CtdlLogPrintf(CTDL_EMERG, "compress2() error\n");
 542                         abort();
 543                 }
 544                 zheader.compressed_len = (size_t) destLen;
 545                 memcpy(compressed_data, &zheader,
 546                        sizeof(struct CtdlCompressHeader));
 547                 ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) +
 548                                        zheader.compressed_len);
 549                 ddata.data = compressed_data;
 550         }
 551 #endif
 552
 553         if (MYTID != NULL) {
 554                 ret = dbp[cdb]->put(dbp[cdb],   /* db */
 555                                     MYTID,      /* transaction ID */
 556                                     &dkey,      /* key */
 557                                     &ddata,     /* data */
 558                                     0); /* flags */
 559                 if (ret) {
 560                         CtdlLogPrintf(CTDL_EMERG, "cdb_store(%d): %s\n", cdb,
 561                                 db_strerror(ret));
 562                         abort();
 563                 }
 564 #ifdef HAVE_ZLIB
 565                 if (compressing)
 566                         free(compressed_data);
 567 #endif
 568                 return ret;
 569
 570         } else {
 571                 bailIfCursor(MYCURSORS,
 572                              "attempt to write during r/o cursor");
 573
 574               retry:
 575                 txbegin(&tid);
 576
 577                 if ((ret = dbp[cdb]->put(dbp[cdb],      /* db */
 578                                          tid,   /* transaction ID */
 579                                          &dkey, /* key */
 580                                          &ddata,        /* data */
 581                                          0))) { /* flags */
 582                         if (ret == DB_LOCK_DEADLOCK) {
 583                                 txabort(tid);
 584                                 goto retry;
 585                         } else {
 586                                 CtdlLogPrintf(CTDL_EMERG, "cdb_store(%d): %s\n",
 587                                         cdb, db_strerror(ret));
 588                                 abort();
 589                         }
 590                 } else {
 591                         txcommit(tid);
 592 #ifdef HAVE_ZLIB
 593                         if (compressing)
 594                                 free(compressed_data);
 595 #endif
 596                         return ret;
 597                 }
 598         }
 599 }
 600
 601
 602 /*
 603  * Delete a piece of data.  Returns 0 if the operation was successful.
 604  */
 605 int cdb_delete(int cdb, void *key, int keylen)
 606 {
 607
 608         DBT dkey;
 609         DB_TXN *tid;
 610         int ret;
 611
 612         memset(&dkey, 0, sizeof dkey);
 613         dkey.size = keylen;
 614         dkey.data = key;
 615
 616         if (MYTID != NULL) {
 617                 ret = dbp[cdb]->del(dbp[cdb], MYTID, &dkey, 0);
 618                 if (ret) {
 619                         CtdlLogPrintf(CTDL_EMERG, "cdb_delete(%d): %s\n", cdb,
 620                                 db_strerror(ret));
 621                         if (ret != DB_NOTFOUND)
 622                                 abort();
 623                 }
 624         } else {
 625                 bailIfCursor(MYCURSORS,
 626                              "attempt to delete during r/o cursor");
 627
 628               retry:
 629                 txbegin(&tid);
 630
 631                 if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0))
 632                     && ret != DB_NOTFOUND) {
 633                         if (ret == DB_LOCK_DEADLOCK) {
 634                                 txabort(tid);
 635                                 goto retry;
 636                         } else {
 637                                 CtdlLogPrintf(CTDL_EMERG, "cdb_delete(%d): %s\n",
 638                                         cdb, db_strerror(ret));
 639                                 abort();
 640                         }
 641                 } else {
 642                         txcommit(tid);
 643                 }
 644         }
 645         return ret;
 646 }
 647
 648 static DBC *localcursor(int cdb)
 649 {
 650         int ret;
 651         DBC *curs;
 652
 653         if (MYCURSORS[cdb] == NULL)
 654                 ret = dbp[cdb]->cursor(dbp[cdb], MYTID, &curs, 0);
 655         else
 656                 ret =
 657                     MYCURSORS[cdb]->c_dup(MYCURSORS[cdb], &curs,
 658                                           DB_POSITION);
 659
 660         if (ret) {
 661                 CtdlLogPrintf(CTDL_EMERG, "localcursor: %s\n", db_strerror(ret));
 662                 abort();
 663         }
 664
 665         return curs;
 666 }
 667
 668
 669 /*
 670  * Fetch a piece of data.  If not found, returns NULL.  Otherwise, it returns
 671  * a struct cdbdata which it is the caller's responsibility to free later on
 672  * using the cdb_free() routine.
 673  */
 674 struct cdbdata *cdb_fetch(int cdb, void *key, int keylen)
 675 {
 676
 677         struct cdbdata *tempcdb;
 678         DBT dkey, dret;
 679         int ret;
 680
 681         memset(&dkey, 0, sizeof(DBT));
 682         dkey.size = keylen;
 683         dkey.data = key;
 684
 685         if (MYTID != NULL) {
 686                 memset(&dret, 0, sizeof(DBT));
 687                 dret.flags = DB_DBT_MALLOC;
 688                 ret = dbp[cdb]->get(dbp[cdb], MYTID, &dkey, &dret, 0);
 689         } else {
 690                 DBC *curs;
 691
 692                 do {
 693                         memset(&dret, 0, sizeof(DBT));
 694                         dret.flags = DB_DBT_MALLOC;
 695
 696                         curs = localcursor(cdb);
 697
 698                         ret = curs->c_get(curs, &dkey, &dret, DB_SET);
 699                         cclose(curs);
 700                 }
 701                 while (ret == DB_LOCK_DEADLOCK);
 702
 703         }
 704
 705         if ((ret != 0) && (ret != DB_NOTFOUND)) {
 706                 CtdlLogPrintf(CTDL_EMERG, "cdb_fetch(%d): %s\n", cdb,
 707                         db_strerror(ret));
 708                 abort();
 709         }
 710
 711         if (ret != 0)
 712                 return NULL;
 713         tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 714
 715         if (tempcdb == NULL) {
 716                 CtdlLogPrintf(CTDL_EMERG,
 717                         "cdb_fetch: Cannot allocate memory for tempcdb\n");
 718                 abort();
 719         }
 720
 721         tempcdb->len = dret.size;
 722         tempcdb->ptr = dret.data;
 723 #ifdef HAVE_ZLIB
 724         cdb_decompress_if_necessary(tempcdb);
 725 #endif
 726         return (tempcdb);
 727 }
 728
 729
 730 /*
 731  * Free a cdbdata item.
 732  *
 733  * Note that we only free the 'ptr' portion if it is not NULL.  This allows
 734  * other code to assume ownership of that memory simply by storing the
 735  * pointer elsewhere and then setting 'ptr' to NULL.  cdb_free() will then
 736  * avoid freeing it.
 737  */
 738 void cdb_free(struct cdbdata *cdb)
 739 {
 740         if (cdb->ptr) {
 741                 free(cdb->ptr);
 742         }
 743         free(cdb);
 744 }
 745
 746 void cdb_close_cursor(int cdb)
 747 {
 748         if (MYCURSORS[cdb] != NULL)
 749                 cclose(MYCURSORS[cdb]);
 750
 751         MYCURSORS[cdb] = NULL;
 752 }
 753
 754 /*
 755  * Prepare for a sequential search of an entire database.
 756  * (There is guaranteed to be no more than one traversal in
 757  * progress per thread at any given time.)
 758  */
 759 void cdb_rewind(int cdb)
 760 {
 761         int ret = 0;
 762
 763         if (MYCURSORS[cdb] != NULL) {
 764                 CtdlLogPrintf(CTDL_EMERG,
 765                         "cdb_rewind: must close cursor on database %d before reopening.\n",
 766                         cdb);
 767                 abort();
 768                 /* cclose(MYCURSORS[cdb]); */
 769         }
 770
 771         /*
 772          * Now initialize the cursor
 773          */
 774         ret = dbp[cdb]->cursor(dbp[cdb], MYTID, &MYCURSORS[cdb], 0);
 775         if (ret) {
 776                 CtdlLogPrintf(CTDL_EMERG, "cdb_rewind: db_cursor: %s\n",
 777                         db_strerror(ret));
 778                 abort();
 779         }
 780 }
 781
 782
 783 /*
 784  * Fetch the next item in a sequential search.  Returns a pointer to a
 785  * cdbdata structure, or NULL if we've hit the end.
 786  */
 787 struct cdbdata *cdb_next_item(int cdb)
 788 {
 789         DBT key, data;
 790         struct cdbdata *cdbret;
 791         int ret = 0;
 792
 793         /* Initialize the key/data pair so the flags aren't set. */
 794         memset(&key, 0, sizeof(key));
 795         memset(&data, 0, sizeof(data));
 796         data.flags = DB_DBT_MALLOC;
 797
 798         ret = MYCURSORS[cdb]->c_get(MYCURSORS[cdb], &key, &data, DB_NEXT);
 799
 800         if (ret) {
 801                 if (ret != DB_NOTFOUND) {
 802                         CtdlLogPrintf(CTDL_EMERG, "cdb_next_item(%d): %s\n",
 803                                 cdb, db_strerror(ret));
 804                         abort();
 805                 }
 806                 cclose(MYCURSORS[cdb]);
 807                 MYCURSORS[cdb] = NULL;
 808                 return NULL;    /* presumably, end of file */
 809         }
 810
 811         cdbret = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 812         cdbret->len = data.size;
 813         cdbret->ptr = data.data;
 814 #ifdef HAVE_ZLIB
 815         cdb_decompress_if_necessary(cdbret);
 816 #endif
 817
 818         return (cdbret);
 819 }
 820
 821
 822
 823 /*
 824  * Transaction-based stuff.  I'm writing this as I bake cookies...
 825  */
 826
 827 void cdb_begin_transaction(void)
 828 {
 829
 830         bailIfCursor(MYCURSORS,
 831                      "can't begin transaction during r/o cursor");
 832
 833         if (MYTID != NULL) {
 834                 CtdlLogPrintf(CTDL_EMERG,
 835                         "cdb_begin_transaction: ERROR: nested transaction\n");
 836                 abort();
 837         }
 838
 839         txbegin(&MYTID);
 840 }
 841
 842 void cdb_end_transaction(void)
 843 {
 844         int i;
 845
 846         for (i = 0; i < MAXCDB; i++)
 847                 if (MYCURSORS[i] != NULL) {
 848                         CtdlLogPrintf(CTDL_WARNING,
 849                                 "cdb_end_transaction: WARNING: cursor %d still open at transaction end\n",
 850                                 i);
 851                         cclose(MYCURSORS[i]);
 852                         MYCURSORS[i] = NULL;
 853                 }
 854
 855         if (MYTID == NULL) {
 856                 CtdlLogPrintf(CTDL_EMERG,
 857                         "cdb_end_transaction: ERROR: txcommit(NULL) !!\n");
 858                 abort();
 859         } else
 860                 txcommit(MYTID);
 861
 862         MYTID = NULL;
 863 }
 864
 865 /*
 866  * Truncate (delete every record)
 867  */
 868 void cdb_trunc(int cdb)
 869 {
 870         /* DB_TXN *tid; */
 871         int ret;
 872         u_int32_t count;
 873
 874         if (MYTID != NULL) {
 875                 CtdlLogPrintf(CTDL_EMERG,
 876                         "cdb_trunc must not be called in a transaction.\n");
 877                 abort();
 878         } else {
 879                 bailIfCursor(MYCURSORS,
 880                              "attempt to write during r/o cursor");
 881
 882               retry:
 883                 /* txbegin(&tid); */
 884
 885                 if ((ret = dbp[cdb]->truncate(dbp[cdb], /* db */
 886                                               NULL,     /* transaction ID */
 887                                               &count,   /* #rows deleted */
 888                                               0))) {    /* flags */
 889                         if (ret == DB_LOCK_DEADLOCK) {
 890                                 /* txabort(tid); */
 891                                 goto retry;
 892                         } else {
 893                                 CtdlLogPrintf(CTDL_EMERG,
 894                                         "cdb_truncate(%d): %s\n", cdb,
 895                                         db_strerror(ret));
 896                                 abort();
 897                         }
 898                 } else {
 899                         /* txcommit(tid); */
 900                 }
 901         }
 902 }