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