2 * $Id: dbif.c,v 1.10 2009-05-14 13:46:08 franklahm Exp $
4 * Copyright (C) Joerg Lenneis 2003
5 * Copyright (C) Frank Lahm 2009
6 * All Rights Reserved. See COPYING.
11 #endif /* HAVE_CONFIG_H */
16 #ifdef HAVE_SYS_TYPES_H
17 #include <sys/types.h>
18 #endif /* HAVE_SYS_TYPES_H */
20 #include <sys/types.h>
22 #include <sys/cdefs.h>
24 #include <atalk/logger.h>
30 #define DB_ERRLOGFILE "db_errlog"
32 static char *old_dbfiles[] = {"cnid.db", NULL};
35 static int upgrade_required()
41 for (i = 0; old_dbfiles[i] != NULL; i++) {
42 if ( !(stat(old_dbfiles[i], &st) < 0) ) {
46 if (errno != ENOENT) {
47 LOG(log_error, logtype_cnid, "cnid_open: Checking %s gave %s", old_dbfiles[i], strerror(errno));
55 int dbif_stamp(DBD *dbd, void *buffer, int size)
63 if ((rc = stat(dbd->db_table[DBIF_CNID].name, &st)) < 0) {
64 LOG(log_error, logtype_cnid, "error stating database %s: %s", dbd->db_table[DBIF_CNID].name, db_strerror(rc));
67 memset(buffer, 0, size);
68 memcpy(buffer, &st.st_ctime, sizeof(st.st_ctime));
74 DBD *dbif_init(const char *envhome, const char *filename)
78 if ( NULL == (dbd = calloc(sizeof(DBD), 1)) )
81 /* filename == NULL means in memory db */
86 dbd->db_envhome = strdup(envhome);
87 if (NULL == dbd->db_envhome) {
92 dbd->db_filename = strdup(filename);
93 if (NULL == dbd->db_filename) {
94 free(dbd->db_envhome);
100 dbd->db_table[DBIF_CNID].name = "cnid2.db";
101 dbd->db_table[DBIF_IDX_DEVINO].name = "devino.db";
102 dbd->db_table[DBIF_IDX_DIDNAME].name = "didname.db";
104 dbd->db_table[DBIF_CNID].type = DB_BTREE;
105 dbd->db_table[DBIF_IDX_DEVINO].type = DB_BTREE;
106 dbd->db_table[DBIF_IDX_DIDNAME].type = DB_BTREE;
108 dbd->db_table[DBIF_CNID].openflags = DB_CREATE;
109 dbd->db_table[DBIF_IDX_DEVINO].openflags = DB_CREATE;
110 dbd->db_table[DBIF_IDX_DIDNAME].openflags = DB_CREATE;
115 /* --------------- */
117 * We assume our current directory is already the BDB homedir. Otherwise
118 * opening the databases will not work as expected.
120 int dbif_env_open(DBD *dbd, struct db_param *dbp, uint32_t dbenv_oflags)
123 char **logfiles = NULL;
126 /* Refuse to do anything if this is an old version of the CNID database */
127 if (upgrade_required()) {
128 LOG(log_error, logtype_cnid, "Found version 1 of the CNID database. Please upgrade to version 2");
132 if ((dbd->db_errlog = fopen(DB_ERRLOGFILE, "a")) == NULL)
133 LOG(log_warning, logtype_cnid, "error creating/opening DB errlogfile: %s", strerror(errno));
135 if ((ret = db_env_create(&dbd->db_env, 0))) {
136 LOG(log_error, logtype_cnid, "error creating DB environment: %s",
142 if (dbd->db_errlog != NULL) {
143 dbd->db_env->set_errfile(dbd->db_env, dbd->db_errlog);
144 dbd->db_env->set_msgfile(dbd->db_env, dbd->db_errlog);
147 if (dbenv_oflags & DB_RECOVER) {
148 dbd->db_env->set_verbose(dbd->db_env, DB_VERB_RECOVERY, 1);
149 /* Open the database for recovery using DB_PRIVATE option which is faster */
150 if ((ret = dbd->db_env->open(dbd->db_env, dbd->db_envhome, dbenv_oflags | DB_PRIVATE, 0))) {
151 LOG(log_error, logtype_cnid, "error opening DB environment: %s",
153 dbd->db_env->close(dbd->db_env, 0);
157 dbenv_oflags = (dbenv_oflags & ~DB_RECOVER);
159 if (dbd->db_errlog != NULL)
160 fflush(dbd->db_errlog);
162 if ((ret = dbd->db_env->close(dbd->db_env, 0))) {
163 LOG(log_error, logtype_cnid, "error closing DB environment after recovery: %s",
169 if ((ret = db_env_create(&dbd->db_env, 0))) {
170 LOG(log_error, logtype_cnid, "error creating DB environment after recovery: %s",
177 if ((ret = dbd->db_env->set_cachesize(dbd->db_env, 0, 1024 * dbp->cachesize, 0))) {
178 LOG(log_error, logtype_cnid, "error setting DB environment cachesize to %i: %s",
179 dbp->cachesize, db_strerror(ret));
180 dbd->db_env->close(dbd->db_env, 0);
185 if (dbd->db_errlog != NULL) {
186 dbd->db_env->set_errfile(dbd->db_env, dbd->db_errlog);
187 dbd->db_env->set_msgfile(dbd->db_env, dbd->db_errlog);
189 if ((ret = dbd->db_env->open(dbd->db_env, dbd->db_envhome, dbenv_oflags, 0))) {
190 LOG(log_error, logtype_cnid, "error opening DB environment after recovery: %s",
192 dbd->db_env->close(dbd->db_env, 0);
197 if ((ret = dbd->db_env->set_flags(dbd->db_env, DB_AUTO_COMMIT, 1))) {
198 LOG(log_error, logtype_cnid, "error setting DB_AUTO_COMMIT flag: %s",
200 dbd->db_env->close(dbd->db_env, 0);
205 if (dbp->logfile_autoremove) {
206 if (dbd->db_env->log_archive(dbd->db_env, &logfiles, 0)) {
207 LOG(log_error, logtype_cnid, "error getting list of stale logfiles: %s",
209 dbd->db_env->close(dbd->db_env, 0);
213 if (logfiles != NULL) {
214 for (file = logfiles; *file != NULL; file++) {
215 if (unlink(*file) < 0)
216 LOG(log_warning, logtype_cnid, "Error removing stale logfile %s: %s", *file, strerror(errno));
221 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 7)
222 if ((ret = dbd->db_env->log_set_config(dbd->db_env, DB_LOG_AUTO_REMOVE, 1))) {
223 LOG(log_error, logtype_cnid, "error setting DB_LOG_AUTO_REMOVE flag: %s",
225 dbd->db_env->close(dbd->db_env, 0);
230 if ((ret = dbd->db_env->set_flags(dbd->db_env, DB_LOG_AUTOREMOVE, 1))) {
231 LOG(log_error, logtype_cnid, "error setting DB_LOG_AUTOREMOVE flag: %s",
233 dbd->db_env->close(dbd->db_env, 0);
243 /* --------------- */
244 int dbif_open(DBD *dbd, struct db_param *dbp _U_, int do_truncate)
250 for (i = 0; i != DBIF_DB_CNT; i++) {
251 if ((ret = db_create(&dbd->db_table[i].db, dbd->db_env, 0))) {
252 LOG(log_error, logtype_cnid, "error creating handle for database %s: %s",
253 dbd->db_table[i].name, db_strerror(ret));
257 if (dbd->db_table[i].flags) {
258 if ((ret = dbd->db_table[i].db->set_flags(dbd->db_table[i].db,
259 dbd->db_table[i].flags))) {
260 LOG(log_error, logtype_cnid, "error setting flags for database %s: %s",
261 dbd->db_table[i].name, db_strerror(ret));
266 if (dbd->db_table[i].db->open(dbd->db_table[i].db,
269 dbd->db_table[i].name,
270 dbd->db_table[i].type,
271 dbd->db_table[i].openflags,
273 LOG(log_error, logtype_cnid, "Cant open database");
276 if (dbd->db_errlog != NULL)
277 dbd->db_table[i].db->set_errfile(dbd->db_table[i].db, dbd->db_errlog);
279 if (do_truncate && i > 0) {
280 LOG(log_info, logtype_cnid, "Truncating CNID index.");
281 if ((ret = dbd->db_table[i].db->truncate(dbd->db_table[i].db, NULL, &count, 0))) {
282 LOG(log_error, logtype_cnid, "error truncating database %s: %s",
283 dbd->db_table[i].name, db_strerror(ret));
289 /* TODO: Implement CNID DB versioning info on new databases. */
291 /* Associate the secondary with the primary. */
293 LOG(log_info, logtype_cnid, "Reindexing did/name index...");
294 if ((ret = dbd->db_table[0].db->associate(dbd->db_table[DBIF_CNID].db,
296 dbd->db_table[DBIF_IDX_DIDNAME].db,
298 (do_truncate) ? DB_CREATE : 0))
300 LOG(log_error, logtype_cnid, "Failed to associate didname database: %s",db_strerror(ret));
304 LOG(log_info, logtype_cnid, "... done.");
307 LOG(log_info, logtype_cnid, "Reindexing dev/ino index...");
308 if ((ret = dbd->db_table[0].db->associate(dbd->db_table[0].db,
310 dbd->db_table[DBIF_IDX_DEVINO].db,
312 (do_truncate) ? DB_CREATE : 0))
314 LOG(log_error, logtype_cnid, "Failed to associate devino database: %s",db_strerror(ret));
318 LOG(log_info, logtype_cnid, "... done.");
323 /* ------------------------ */
324 int dbif_closedb(DBD *dbd)
330 for (i = DBIF_DB_CNT -1; i >= 0; i--) {
331 if (dbd->db_table[i].db != NULL && (ret = dbd->db_table[i].db->close(dbd->db_table[i].db, 0))) {
332 LOG(log_error, logtype_cnid, "error closing database %s: %s", dbd->db_table[i].name, db_strerror(ret));
341 /* ------------------------ */
342 int dbif_close(DBD *dbd)
347 if (dbif_closedb(dbd))
350 if (dbd->db_env != NULL && (ret = dbd->db_env->close(dbd->db_env, 0))) {
351 LOG(log_error, logtype_cnid, "error closing DB environment: %s", db_strerror(ret));
354 if (dbd->db_errlog != NULL && fclose(dbd->db_errlog) == EOF) {
355 LOG(log_error, logtype_cnid, "error closing DB logfile: %s", strerror(errno));
359 free(dbd->db_filename);
369 * The following three functions are wrappers for DB->get(), DB->put() and DB->del().
370 * All three return -1 on error. dbif_get()/dbif_del return 1 if the key was found and 0
371 * otherwise. dbif_put() returns 0 if key/val was successfully updated and 1 if
372 * the DB_NOOVERWRITE flag was specified and the key already exists.
374 * All return codes other than DB_NOTFOUND and DB_KEYEXIST from the DB->()
375 * functions are not expected and therefore error conditions.
378 int dbif_get(DBD *dbd, const int dbi, DBT *key, DBT *val, u_int32_t flags)
382 ret = dbd->db_table[dbi].db->get(dbd->db_table[dbi].db,
388 if (ret == DB_NOTFOUND)
391 LOG(log_error, logtype_cnid, "error retrieving value from %s: %s",
392 dbd->db_table[dbi].name, db_strerror(errno));
398 /* search by secondary return primary */
399 int dbif_pget(DBD *dbd, const int dbi, DBT *key, DBT *pkey, DBT *val, u_int32_t flags)
403 ret = dbd->db_table[dbi].db->pget(dbd->db_table[dbi].db,
410 if (ret == DB_NOTFOUND || ret == DB_SECONDARY_BAD) {
414 LOG(log_error, logtype_cnid, "error retrieving value from %s: %s",
415 dbd->db_table[dbi].name, db_strerror(errno));
421 /* -------------------------- */
422 int dbif_put(DBD *dbd, const int dbi, DBT *key, DBT *val, u_int32_t flags)
426 if (dbif_txn_begin(dbd) < 0) {
427 LOG(log_error, logtype_cnid, "error setting key/value in %s: %s",
428 dbd->db_table[dbi].name, db_strerror(errno));
432 ret = dbd->db_table[dbi].db->put(dbd->db_table[dbi].db,
439 if ((flags & DB_NOOVERWRITE) && ret == DB_KEYEXIST) {
442 LOG(log_error, logtype_cnid, "error setting key/value in %s: %s",
443 dbd->db_table[dbi].name, db_strerror(errno));
450 int dbif_del(DBD *dbd, const int dbi, DBT *key, u_int32_t flags)
454 if (dbif_txn_begin(dbd) < 0) {
455 LOG(log_error, logtype_cnid, "error deleting key/value from %s: %s",
456 dbd->db_table[dbi].name, db_strerror(errno));
460 ret = dbd->db_table[dbi].db->del(dbd->db_table[dbi].db,
465 if (ret == DB_NOTFOUND || ret == DB_SECONDARY_BAD)
468 LOG(log_error, logtype_cnid, "error deleting key/value from %s: %s",
469 dbd->db_table[dbi].name, db_strerror(errno));
475 int dbif_txn_begin(DBD *dbd)
479 /* If we already have an active txn, just return */
483 /* If our DBD has no env, just return (-> in memory db) */
484 if (dbd->db_env == NULL)
487 ret = dbd->db_env->txn_begin(dbd->db_env, NULL, &dbd->db_txn, 0);
490 LOG(log_error, logtype_cnid, "error starting transaction: %s", db_strerror(errno));
496 int dbif_txn_commit(DBD *dbd)
503 /* If our DBD has no env, just return (-> in memory db) */
504 if (dbd->db_env == NULL)
507 ret = dbd->db_txn->commit(dbd->db_txn, 0);
511 LOG(log_error, logtype_cnid, "error committing transaction: %s", db_strerror(errno));
517 int dbif_txn_abort(DBD *dbd)
524 /* If our DBD has no env, just return (-> in memory db) */
525 if (dbd->db_env == NULL)
528 ret = dbd->db_txn->abort(dbd->db_txn);
532 LOG(log_error, logtype_cnid, "error aborting transaction: %s", db_strerror(errno));
539 ret = 1 -> commit txn
540 ret = 0 -> abort txn -> exit!
541 anything else -> exit!
543 void dbif_txn_close(DBD *dbd, int ret)
546 if (dbif_txn_abort(dbd) < 0) {
547 LOG( log_error, logtype_cnid, "Fatal error aborting transaction. Exiting!");
550 } else if (ret == 1) {
551 ret = dbif_txn_commit(dbd);
553 LOG( log_error, logtype_cnid, "Fatal error committing transaction. Exiting!");
560 int dbif_txn_checkpoint(DBD *dbd, u_int32_t kbyte, u_int32_t min, u_int32_t flags)
563 ret = dbd->db_env->txn_checkpoint(dbd->db_env, kbyte, min, flags);
565 LOG(log_error, logtype_cnid, "error checkpointing transaction susystem: %s", db_strerror(errno));
571 int dbif_count(DBD *dbd, const int dbi, u_int32_t *count)
575 DB *db = dbd->db_table[dbi].db;
577 ret = db->stat(db, NULL, &sp, 0);
580 LOG(log_error, logtype_cnid, "error getting stat infotmation on database: %s", db_strerror(errno));
584 *count = sp->bt_ndata;
590 int dbif_copy_rootinfokey(DBD *srcdbd, DBD *destdbd)
595 memset(&key, 0, sizeof(key));
596 memset(&data, 0, sizeof(data));
598 key.data = ROOTINFO_KEY;
599 key.size = ROOTINFO_KEYLEN;
601 if ((rc = dbif_get(srcdbd, DBIF_CNID, &key, &data, 0)) <= 0) {
602 LOG(log_error, logtype_cnid, "dbif_copy_rootinfokey: Error getting rootinfo record");
606 memset(&key, 0, sizeof(key));
607 key.data = ROOTINFO_KEY;
608 key.size = ROOTINFO_KEYLEN;
610 if ((rc = dbif_put(destdbd, DBIF_CNID, &key, &data, 0))) {
611 LOG(log_error, logtype_cnid, "dbif_copy_rootinfokey: Error writing rootinfo key");
618 int dbif_dump(DBD *dbd, int dumpindexes)
621 uint32_t max = 0, count = 0, cnid, type, did, lastid;
625 DBT key = { 0 }, data = { 0 };
626 DB *db = dbd->db_table[DBIF_CNID].db;
627 char *typestring[2] = {"f", "d"};
630 printf("CNID database dump:\n");
632 rc = db->cursor(db, NULL, &cur, 0);
634 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
638 cur->c_get(cur, &key, &data, DB_FIRST);
640 /* Parse and print data */
641 memcpy(&cnid, key.data, 4);
646 /* Rootinfo node ? */
648 memcpy(&stamp, data.data + 4, sizeof(time_t));
649 memcpy(&lastid, data.data + 20, sizeof(cnid_t));
650 lastid = ntohl(lastid);
651 strftime(timebuf, sizeof(timebuf), "%b %d %Y %H:%M:%S", localtime(&stamp));
652 printf("dbd stamp: 0x%08x (%s), next free CNID: %u\n", (unsigned int)stamp, timebuf, lastid + 1);
655 memcpy(&dev, data.data + CNID_DEV_OFS, 8);
658 memcpy(&ino, data.data + CNID_INO_OFS, 8);
661 memcpy(&type, data.data + CNID_TYPE_OFS, 4);
664 memcpy(&did, data.data + CNID_DID_OFS, 4);
668 printf("id: %10u, did: %10u, type: %s, dev: 0x%llx, ino: 0x%016llx, name: %s\n",
669 cnid, did, typestring[type],
670 (long long unsigned int)dev, (long long unsigned int)ino,
671 (char *)data.data + CNID_NAME_OFS);
675 rc = cur->c_get(cur, &key, &data, DB_NEXT);
678 if (rc != DB_NOTFOUND) {
679 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
683 rc = cur->c_close(cur);
685 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
688 printf("%u CNIDs in database. Max CNID: %u.\n", count, max);
690 /* Dump indexes too ? */
692 /* DBIF_IDX_DEVINO */
693 printf("\ndev/inode index:\n");
695 db = dbd->db_table[DBIF_IDX_DEVINO].db;
696 rc = db->cursor(db, NULL, &cur, 0);
698 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
702 cur->c_get(cur, &key, &data, DB_FIRST);
704 /* Parse and print data */
707 memcpy(&cnid, data.data, CNID_LEN);
713 memcpy(&dev, key.data, CNID_DEV_LEN);
716 memcpy(&ino, key.data + CNID_DEV_LEN, CNID_INO_LEN);
719 printf("id: %10u <== dev: 0x%llx, ino: 0x%016llx\n",
720 cnid, (unsigned long long int)dev, (unsigned long long int)ino);
723 rc = cur->c_get(cur, &key, &data, DB_NEXT);
725 if (rc != DB_NOTFOUND) {
726 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
730 rc = cur->c_close(cur);
732 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
735 printf("%u items\n", count);
737 /* Now dump DBIF_IDX_DIDNAME */
738 printf("\ndid/name index:\n");
740 db = dbd->db_table[DBIF_IDX_DIDNAME].db;
741 rc = db->cursor(db, NULL, &cur, 0);
743 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
747 cur->c_get(cur, &key, &data, DB_FIRST);
749 /* Parse and print data */
752 memcpy(&cnid, data.data, CNID_LEN);
758 memcpy(&did, key.data, CNID_LEN);
761 printf("id: %10u <== did: %10u, name: %s\n", cnid, did, (char *)key.data + CNID_LEN);
764 rc = cur->c_get(cur, &key, &data, DB_NEXT);
766 if (rc != DB_NOTFOUND) {
767 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
771 rc = cur->c_close(cur);
773 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
776 printf("%u items\n", count);