X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fdatabase.c;h=dfeb4f013946cb1c4f9c1cda84f2a8143c7b192a;hb=068d33e5d8569b2c4a2c8582178427892b0a8dee;hp=8b5820edb1a5eb9d0e229bf52b33d3f78154fa62;hpb=0566e798cbfc711e22b2e7328ed1d07a14265313;p=citadel.git diff --git a/citadel/database.c b/citadel/database.c index 8b5820edb..dfeb4f013 100644 --- a/citadel/database.c +++ b/citadel/database.c @@ -1,7 +1,7 @@ /* * This is a data store backend for the Citadel server which uses Berkeley DB. * - * Copyright (c) 1987-2019 by the citadel.org team + * Copyright (c) 1987-2021 by the citadel.org team * * This program is open source software; you can redistribute it and/or * modify it under the terms of the GNU General Public License version 3. @@ -50,8 +50,7 @@ static DB *dbp[MAXCDB]; /* One DB handle for each Citadel database */ static DB_ENV *dbenv; /* The DB environment (global) */ -void cdb_abort(void) -{ +void cdb_abort(void) { syslog(LOG_DEBUG, "db: citserver is stopping in order to prevent data loss. uid=%d gid=%d euid=%d egid=%d", getuid(), getgid(), geteuid(), getegid() ); @@ -60,8 +59,7 @@ void cdb_abort(void) /* Verbose logging callback */ -void cdb_verbose_log(const DB_ENV * dbenv, const char *msg) -{ +void cdb_verbose_log(const DB_ENV * dbenv, const char *msg) { if (!IsEmptyStr(msg)) { syslog(LOG_DEBUG, "db: %s", msg); } @@ -69,15 +67,13 @@ void cdb_verbose_log(const DB_ENV * dbenv, const char *msg) /* Verbose logging callback */ -void cdb_verbose_err(const DB_ENV * dbenv, const char *errpfx, const char *msg) -{ +void cdb_verbose_err(const DB_ENV * dbenv, const char *errpfx, const char *msg) { syslog(LOG_ERR, "db: %s", msg); } /* wrapper for txn_abort() that logs/aborts on error */ -static void txabort(DB_TXN * tid) -{ +static void txabort(DB_TXN *tid) { int ret; ret = tid->abort(tid); @@ -90,8 +86,7 @@ static void txabort(DB_TXN * tid) /* wrapper for txn_commit() that logs/aborts on error */ -static void txcommit(DB_TXN * tid) -{ +static void txcommit(DB_TXN *tid) { int ret; ret = tid->commit(tid, 0); @@ -104,8 +99,7 @@ static void txcommit(DB_TXN * tid) /* wrapper for txn_begin() that logs/aborts on error */ -static void txbegin(DB_TXN ** tid) -{ +static void txbegin(DB_TXN **tid) { int ret; ret = dbenv->txn_begin(dbenv, NULL, tid, 0); @@ -118,14 +112,12 @@ static void txbegin(DB_TXN ** tid) /* panic callback */ -static void dbpanic(DB_ENV * env, int errval) -{ +static void dbpanic(DB_ENV * env, int errval) { syslog(LOG_ERR, "db: PANIC: %s", db_strerror(errval)); } -static void cclose(DBC * cursor) -{ +static void cclose(DBC * cursor) { int ret; if ((ret = cursor->c_close(cursor))) { @@ -135,8 +127,7 @@ static void cclose(DBC * cursor) } -static void bailIfCursor(DBC ** cursors, const char *msg) -{ +static void bailIfCursor(DBC ** cursors, const char *msg) { int i; for (i = 0; i < MAXCDB; i++) @@ -147,8 +138,7 @@ static void bailIfCursor(DBC ** cursors, const char *msg) } -void cdb_check_handles(void) -{ +void cdb_check_handles(void) { bailIfCursor(TSD->cursors, "in check_handles"); if (TSD->tid != NULL) { @@ -161,8 +151,7 @@ void cdb_check_handles(void) /* * Request a checkpoint of the database. Called once per minute by the thread manager. */ -void cdb_checkpoint(void) -{ +void cdb_checkpoint(void) { int ret; syslog(LOG_DEBUG, "db: -- checkpoint --"); @@ -189,8 +178,7 @@ void cdb_checkpoint(void) * critical section here, because there aren't any active threads * manipulating the database yet. */ -void open_databases(void) -{ +void open_databases(void) { int ret; int i; char dbfilename[32]; @@ -205,14 +193,14 @@ void open_databases(void) /* * Silently try to create the database subdirectory. If it's already there, no problem. */ - if ((mkdir(ctdl_data_dir, 0700) != 0) && (errno != EEXIST)) { - syslog(LOG_ERR, "db: unable to create database directory [%s]: %m", ctdl_data_dir); + if ((mkdir(ctdl_db_dir, 0700) != 0) && (errno != EEXIST)) { + syslog(LOG_ERR, "db: unable to create database directory [%s]: %m", ctdl_db_dir); } - if (chmod(ctdl_data_dir, 0700) != 0) { - syslog(LOG_ERR, "db: unable to set database directory permissions [%s]: %m", ctdl_data_dir); + if (chmod(ctdl_db_dir, 0700) != 0) { + syslog(LOG_ERR, "db: unable to set database directory permissions [%s]: %m", ctdl_db_dir); } - if (chown(ctdl_data_dir, CTDLUID, (-1)) != 0) { - syslog(LOG_ERR, "db: unable to set the owner for [%s]: %m", ctdl_data_dir); + if (chown(ctdl_db_dir, CTDLUID, (-1)) != 0) { + syslog(LOG_ERR, "db: unable to set the owner for [%s]: %m", ctdl_db_dir); } syslog(LOG_DEBUG, "db: Setting up DB environment"); // db_env_set_func_yield((int (*)(u_long, u_long))sched_yield); @@ -250,20 +238,20 @@ void open_databases(void) } flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_INIT_LOG; - syslog(LOG_DEBUG, "db: dbenv->open(dbenv, %s, %d, 0)", ctdl_data_dir, flags); - ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); // try opening the database cleanly + syslog(LOG_DEBUG, "db: dbenv->open(dbenv, %s, %d, 0)", ctdl_db_dir, flags); + ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0); // try opening the database cleanly if (ret == DB_RUNRECOVERY) { syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret)); syslog(LOG_ERR, "db: attempting recovery..."); flags |= DB_RECOVER; - ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); // try recovery + ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0); // try recovery } if (ret == DB_RUNRECOVERY) { syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret)); syslog(LOG_ERR, "db: attempting catastrophic recovery..."); flags &= ~DB_RECOVER; flags |= DB_RECOVER_FATAL; - ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); // try catastrophic recovery + ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0); // try catastrophic recovery } if (ret) { syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret)); @@ -298,17 +286,16 @@ void open_databases(void) /* * Make sure we own all the files, because in a few milliseconds we're going to drop root privs. */ -void cdb_chmod_data(void) -{ +void cdb_chmod_data(void) { DIR *dp; struct dirent *d; char filename[PATH_MAX]; - dp = opendir(ctdl_data_dir); + dp = opendir(ctdl_db_dir); if (dp != NULL) { while (d = readdir(dp), d != NULL) { if (d->d_name[0] != '.') { - snprintf(filename, sizeof filename, "%s/%s", ctdl_data_dir, d->d_name); + snprintf(filename, sizeof filename, "%s/%s", ctdl_db_dir, d->d_name); syslog(LOG_DEBUG, "db: chmod(%s, 0600) returned %d", filename, chmod(filename, 0600)); syslog(LOG_DEBUG, "db: chown(%s, CTDLUID, -1) returned %d", filename, chown(filename, CTDLUID, (-1)) @@ -324,14 +311,13 @@ void cdb_chmod_data(void) * 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. */ -void close_databases(void) -{ +void close_databases(void) { int i; int ret; syslog(LOG_INFO, "db: performing final checkpoint"); if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) { - syslog(LOG_ERR, "txn_checkpoint: %s", db_strerror(ret)); + syslog(LOG_ERR, "db: txn_checkpoint: %s", db_strerror(ret)); } syslog(LOG_INFO, "db: flushing the database logs"); @@ -339,11 +325,6 @@ void close_databases(void) syslog(LOG_ERR, "db: log_flush: %s", db_strerror(ret)); } -#ifdef DB_STAT_ALL - /* print some statistics... */ - dbenv->lock_stat_print(dbenv, DB_STAT_ALL); -#endif - /* close the tables */ syslog(LOG_INFO, "db: closing databases"); for (i = 0; i < MAXCDB; ++i) { @@ -355,10 +336,16 @@ void close_databases(void) } + // This seemed nifty at the time but did anyone really look at it? + // #ifdef DB_STAT_ALL + // /* print some statistics... */ + // dbenv->lock_stat_print(dbenv, DB_STAT_ALL); + // #endif + /* Close the handle. */ ret = dbenv->close(dbenv, 0); if (ret) { - syslog(LOG_EMERG, "db: DBENV->close: %s", db_strerror(ret)); + syslog(LOG_ERR, "db: DBENV->close: %s", db_strerror(ret)); } } @@ -366,8 +353,7 @@ void close_databases(void) /* * Decompress a database item if it was compressed on disk */ -void cdb_decompress_if_necessary(struct cdbdata *cdb) -{ +void cdb_decompress_if_necessary(struct cdbdata *cdb) { static int magic = COMPRESS_MAGIC; if ((cdb == NULL) || (cdb->ptr == NULL) || (cdb->len < sizeof(magic)) || (memcmp(cdb->ptr, &magic, sizeof(magic)))) { @@ -398,7 +384,7 @@ void cdb_decompress_if_necessary(struct cdbdata *cdb) if (uncompress((Bytef *) uncompressed_data, (uLongf *) & destLen, (const Bytef *) compressed_data, (uLong) sourceLen) != Z_OK) { - syslog(LOG_EMERG, "db: uncompress() error"); + syslog(LOG_ERR, "db: uncompress() error"); cdb_abort(); } @@ -412,13 +398,11 @@ void cdb_decompress_if_necessary(struct cdbdata *cdb) * Store a piece of data. Returns 0 if the operation was successful. If a * key already exists it should be overwritten. */ -int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) -{ +int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) { DBT dkey, ddata; - DB_TXN *tid; + DB_TXN *tid = NULL; int ret = 0; - struct CtdlCompressHeader zheader; char *compressed_data = NULL; int compressing = 0; @@ -442,7 +426,7 @@ int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) compressed_data = malloc(buffer_len); if (compress2((Bytef *) (compressed_data + sizeof(struct CtdlCompressHeader)), &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK) { - syslog(LOG_EMERG, "db: compress2() error"); + syslog(LOG_ERR, "db: compress2() error"); cdb_abort(); } zheader.compressed_len = (size_t) destLen; @@ -459,7 +443,7 @@ int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) 0 // flags ); if (ret) { - syslog(LOG_EMERG, "db: cdb_store(%d): %s", cdb, db_strerror(ret)); + syslog(LOG_ERR, "db: cdb_store(%d): %s", cdb, db_strerror(ret)); cdb_abort(); } if (compressing) { @@ -472,16 +456,16 @@ int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) retry: txbegin(&tid); - if ((ret = dbp[cdb]->put(dbp[cdb], /* db */ - tid, /* transaction ID */ - &dkey, /* key */ - &ddata, /* data */ - 0))) { /* flags */ + if ((ret = dbp[cdb]->put(dbp[cdb], // db + tid, // transaction ID + &dkey, // key + &ddata, // data + 0))) { // flags if (ret == DB_LOCK_DEADLOCK) { txabort(tid); goto retry; } else { - syslog(LOG_EMERG, "db: cdb_store(%d): %s", cdb, db_strerror(ret)); + syslog(LOG_ERR, "db: cdb_store(%d): %s", cdb, db_strerror(ret)); cdb_abort(); } } else { @@ -499,9 +483,7 @@ int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) /* * Delete a piece of data. Returns 0 if the operation was successful. */ -int cdb_delete(int cdb, void *key, int keylen) -{ - +int cdb_delete(int cdb, void *key, int keylen) { DBT dkey; DB_TXN *tid; int ret; @@ -513,7 +495,7 @@ int cdb_delete(int cdb, void *key, int keylen) if (TSD->tid != NULL) { ret = dbp[cdb]->del(dbp[cdb], TSD->tid, &dkey, 0); if (ret) { - syslog(LOG_EMERG, "db: cdb_delete(%d): %s", cdb, db_strerror(ret)); + syslog(LOG_ERR, "db: cdb_delete(%d): %s", cdb, db_strerror(ret)); if (ret != DB_NOTFOUND) { cdb_abort(); } @@ -529,7 +511,7 @@ int cdb_delete(int cdb, void *key, int keylen) txabort(tid); goto retry; } else { - syslog(LOG_EMERG, "db: cdb_delete(%d): %s", cdb, db_strerror(ret)); + syslog(LOG_ERR, "db: cdb_delete(%d): %s", cdb, db_strerror(ret)); cdb_abort(); } } else { @@ -540,8 +522,7 @@ int cdb_delete(int cdb, void *key, int keylen) } -static DBC *localcursor(int cdb) -{ +static DBC *localcursor(int cdb) { int ret; DBC *curs; @@ -553,7 +534,7 @@ static DBC *localcursor(int cdb) } if (ret) { - syslog(LOG_EMERG, "db: localcursor: %s", db_strerror(ret)); + syslog(LOG_ERR, "db: localcursor: %s", db_strerror(ret)); cdb_abort(); } @@ -566,8 +547,7 @@ static DBC *localcursor(int cdb) * a struct cdbdata which it is the caller's responsibility to free later on * using the cdb_free() routine. */ -struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen) -{ +struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen) { struct cdbdata *tempcdb; DBT dkey, dret; int ret; @@ -594,7 +574,7 @@ struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen) } if ((ret != 0) && (ret != DB_NOTFOUND)) { - syslog(LOG_EMERG, "db: cdb_fetch(%d): %s", cdb, db_strerror(ret)); + syslog(LOG_ERR, "db: cdb_fetch(%d): %s", cdb, db_strerror(ret)); cdb_abort(); } @@ -605,7 +585,7 @@ struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen) tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata)); if (tempcdb == NULL) { - syslog(LOG_EMERG, "db: cdb_fetch: Cannot allocate memory for tempcdb"); + syslog(LOG_ERR, "db: cdb_fetch: Cannot allocate memory for tempcdb"); cdb_abort(); return NULL; /* make it easier for static analysis... */ } else { @@ -625,8 +605,7 @@ struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen) * pointer elsewhere and then setting 'ptr' to NULL. cdb_free() will then * avoid freeing it. */ -void cdb_free(struct cdbdata *cdb) -{ +void cdb_free(struct cdbdata *cdb) { if (cdb->ptr) { free(cdb->ptr); } @@ -634,8 +613,7 @@ void cdb_free(struct cdbdata *cdb) } -void cdb_close_cursor(int cdb) -{ +void cdb_close_cursor(int cdb) { if (TSD->cursors[cdb] != NULL) { cclose(TSD->cursors[cdb]); } @@ -649,12 +627,11 @@ void cdb_close_cursor(int cdb) * (There is guaranteed to be no more than one traversal in * progress per thread at any given time.) */ -void cdb_rewind(int cdb) -{ +void cdb_rewind(int cdb) { int ret = 0; if (TSD->cursors[cdb] != NULL) { - syslog(LOG_EMERG, "db: cdb_rewind: must close cursor on database %d before reopening", cdb); + syslog(LOG_ERR, "db: cdb_rewind: must close cursor on database %d before reopening", cdb); cdb_abort(); /* cclose(TSD->cursors[cdb]); */ } @@ -664,7 +641,7 @@ void cdb_rewind(int cdb) */ ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &TSD->cursors[cdb], 0); if (ret) { - syslog(LOG_EMERG, "db: cdb_rewind: db_cursor: %s", db_strerror(ret)); + syslog(LOG_ERR, "db: cdb_rewind: db_cursor: %s", db_strerror(ret)); cdb_abort(); } } @@ -674,8 +651,7 @@ void cdb_rewind(int cdb) * Fetch the next item in a sequential search. Returns a pointer to a * cdbdata structure, or NULL if we've hit the end. */ -struct cdbdata *cdb_next_item(int cdb) -{ +struct cdbdata *cdb_next_item(int cdb) { DBT key, data; struct cdbdata *cdbret; int ret = 0; @@ -689,7 +665,7 @@ struct cdbdata *cdb_next_item(int cdb) if (ret) { if (ret != DB_NOTFOUND) { - syslog(LOG_EMERG, "db: cdb_next_item(%d): %s", cdb, db_strerror(ret)); + syslog(LOG_ERR, "db: cdb_next_item(%d): %s", cdb, db_strerror(ret)); cdb_abort(); } cdb_close_cursor(cdb); @@ -708,13 +684,11 @@ struct cdbdata *cdb_next_item(int cdb) /* * Transaction-based stuff. I'm writing this as I bake cookies... */ -void cdb_begin_transaction(void) -{ - +void cdb_begin_transaction(void) { bailIfCursor(TSD->cursors, "can't begin transaction during r/o cursor"); if (TSD->tid != NULL) { - syslog(LOG_EMERG, "db: cdb_begin_transaction: ERROR: nested transaction"); + syslog(LOG_ERR, "db: cdb_begin_transaction: ERROR: nested transaction"); cdb_abort(); } @@ -722,8 +696,7 @@ void cdb_begin_transaction(void) } -void cdb_end_transaction(void) -{ +void cdb_end_transaction(void) { int i; for (i = 0; i < MAXCDB; i++) @@ -747,16 +720,16 @@ void cdb_end_transaction(void) /* * Truncate (delete every record) */ -void cdb_trunc(int cdb) -{ +void cdb_trunc(int cdb) { /* DB_TXN *tid; */ int ret; u_int32_t count; if (TSD->tid != NULL) { - syslog(LOG_EMERG, "db: cdb_trunc must not be called in a transaction."); + syslog(LOG_ERR, "db: cdb_trunc must not be called in a transaction."); cdb_abort(); - } else { + } + else { bailIfCursor(TSD->cursors, "attempt to write during r/o cursor"); retry: @@ -770,10 +743,9 @@ void cdb_trunc(int cdb) /* txabort(tid); */ goto retry; } else { - syslog(LOG_EMERG, "db: cdb_truncate(%d): %s", cdb, db_strerror(ret)); + syslog(LOG_ERR, "db: cdb_truncate(%d): %s", cdb, db_strerror(ret)); if (ret == ENOMEM) { - syslog(LOG_EMERG, - "db: You may need to tune your database; please read http://www.citadel.org/doku.php?id=faq:troubleshooting:out_of_lock_entries for more information."); + syslog(LOG_ERR, "db: You may need to tune your database; please read http://www.citadel.org/doku.php?id=faq:troubleshooting:out_of_lock_entries for more information."); } exit(CTDLEXIT_DB); } @@ -787,8 +759,7 @@ void cdb_trunc(int cdb) /* * compact (defragment) the database , possibly returning space back to the underlying filesystem */ -void cdb_compact(void) -{ +void cdb_compact(void) { int ret; int i; @@ -807,8 +778,7 @@ void cdb_compact(void) // Has an item already been seen (is it in the CDB_USETABLE) ? // Returns 0 if it hasn't, 1 if it has // In either case, writes the item to the database for next time. -int CheckIfAlreadySeen(StrBuf *guid) -{ +int CheckIfAlreadySeen(StrBuf *guid) { int found = 0; struct UseTable ut; struct cdbdata *cdbut; @@ -829,53 +799,10 @@ int CheckIfAlreadySeen(StrBuf *guid) } -void cmd_rsen(char *argbuf) -{ - char Token[SIZ]; - long TLen; - char Time[SIZ]; - - struct UseTable ut; - struct cdbdata *cdbut; - - if (CtdlAccessCheck(ac_aide)) { - return; - } - - TLen = extract_token(Token, argbuf, 1, '|', sizeof Token); - if (strncmp(argbuf, "GET", 3) == 0) { - cdbut = cdb_fetch(CDB_USETABLE, Token, TLen); - if (cdbut != NULL) { - memcpy(&ut, cdbut->ptr, ((cdbut->len > sizeof(struct UseTable)) ? sizeof(struct UseTable) : cdbut->len)); - - cprintf("%d %ld\n", CIT_OK, ut.ut_timestamp); - } else { - cprintf("%d not found\n", ERROR + NOT_HERE); - } - - } else if (strncmp(argbuf, "SET", 3) == 0) { - memcpy(ut.ut_msgid, Token, TLen); - extract_token(Time, argbuf, 2, '|', sizeof Time); - ut.ut_timestamp = atol(Time); - cdb_store(CDB_USETABLE, Token, TLen, &ut, sizeof(struct UseTable)); - cprintf("%d token updated\n", CIT_OK); - } else if (strncmp(argbuf, "DEL", 3) == 0) { - if (cdb_delete(CDB_USETABLE, Token, TLen)) - cprintf("%d not found\n", ERROR + NOT_HERE); - else - cprintf("%d deleted.\n", CIT_OK); - - } else { - cprintf("%d Usage: [GET|SET|DEL]|Token|timestamp\n", ERROR); - } - -} - - CTDL_MODULE_INIT(database) { if (!threading) { - CtdlRegisterProtoHook(cmd_rsen, "RSEN", "manipulate Aggregators seen database"); + // nothing to do here } /* return our module id for the log */