2 * $Id: dbif.c,v 1.9 2009-05-10 08:08:28 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 *filename)
78 if ( NULL == (dbd = calloc(sizeof(DBD), 1)) )
81 /* filename == NULL means in memory db */
83 dbd->db_filename = strdup(filename);
84 if (NULL == dbd->db_filename) {
90 dbd->db_table[DBIF_CNID].name = "cnid2.db";
91 dbd->db_table[DBIF_IDX_DEVINO].name = "devino.db";
92 dbd->db_table[DBIF_IDX_DIDNAME].name = "didname.db";
94 dbd->db_table[DBIF_CNID].type = DB_BTREE;
95 dbd->db_table[DBIF_IDX_DEVINO].type = DB_BTREE;
96 dbd->db_table[DBIF_IDX_DIDNAME].type = DB_BTREE;
98 dbd->db_table[DBIF_CNID].openflags = DB_CREATE;
99 dbd->db_table[DBIF_IDX_DEVINO].openflags = DB_CREATE;
100 dbd->db_table[DBIF_IDX_DIDNAME].openflags = DB_CREATE;
105 /* --------------- */
107 * We assume our current directory is already the BDB homedir. Otherwise
108 * opening the databases will not work as expected.
110 int dbif_env_open(DBD *dbd, struct db_param *dbp, uint32_t dbenv_oflags)
113 char **logfiles = NULL;
116 /* Refuse to do anything if this is an old version of the CNID database */
117 if (upgrade_required()) {
118 LOG(log_error, logtype_cnid, "Found version 1 of the CNID database. Please upgrade to version 2");
122 if ((dbd->db_errlog = fopen(DB_ERRLOGFILE, "a")) == NULL)
123 LOG(log_warning, logtype_cnid, "error creating/opening DB errlogfile: %s", strerror(errno));
125 if ((ret = db_env_create(&dbd->db_env, 0))) {
126 LOG(log_error, logtype_cnid, "error creating DB environment: %s",
132 if (dbd->db_errlog != NULL) {
133 dbd->db_env->set_errfile(dbd->db_env, dbd->db_errlog);
134 dbd->db_env->set_msgfile(dbd->db_env, dbd->db_errlog);
137 dbd->db_env->set_verbose(dbd->db_env, DB_VERB_RECOVERY, 1);
139 if (dbenv_oflags & DB_RECOVER) {
140 /* Open the database for recovery using DB_PRIVATE option which is faster */
141 if ((ret = dbd->db_env->open(dbd->db_env, ".", dbenv_oflags | DB_PRIVATE, 0))) {
142 LOG(log_error, logtype_cnid, "error opening DB environment: %s",
144 dbd->db_env->close(dbd->db_env, 0);
148 dbenv_oflags = (dbenv_oflags & ~DB_RECOVER);
150 if (dbd->db_errlog != NULL)
151 fflush(dbd->db_errlog);
153 if ((ret = dbd->db_env->close(dbd->db_env, 0))) {
154 LOG(log_error, logtype_cnid, "error closing DB environment after recovery: %s",
160 if ((ret = db_env_create(&dbd->db_env, 0))) {
161 LOG(log_error, logtype_cnid, "error creating DB environment after recovery: %s",
168 if ((ret = dbd->db_env->set_cachesize(dbd->db_env, 0, 1024 * dbp->cachesize, 0))) {
169 LOG(log_error, logtype_cnid, "error setting DB environment cachesize to %i: %s",
170 dbp->cachesize, db_strerror(ret));
171 dbd->db_env->close(dbd->db_env, 0);
176 if (dbd->db_errlog != NULL) {
177 dbd->db_env->set_errfile(dbd->db_env, dbd->db_errlog);
178 dbd->db_env->set_msgfile(dbd->db_env, dbd->db_errlog);
180 if ((ret = dbd->db_env->open(dbd->db_env, ".", dbenv_oflags, 0))) {
181 LOG(log_error, logtype_cnid, "error opening DB environment after recovery: %s",
183 dbd->db_env->close(dbd->db_env, 0);
188 if ((ret = dbd->db_env->set_flags(dbd->db_env, DB_AUTO_COMMIT, 1))) {
189 LOG(log_error, logtype_cnid, "error setting DB_AUTO_COMMIT flag: %s",
191 dbd->db_env->close(dbd->db_env, 0);
196 if (dbp->logfile_autoremove) {
197 if (dbd->db_env->log_archive(dbd->db_env, &logfiles, 0)) {
198 LOG(log_error, logtype_cnid, "error getting list of stale logfiles: %s",
200 dbd->db_env->close(dbd->db_env, 0);
204 if (logfiles != NULL) {
205 for (file = logfiles; *file != NULL; file++) {
206 if (unlink(*file) < 0)
207 LOG(log_warning, logtype_cnid, "Error removing stale logfile %s: %s", *file, strerror(errno));
212 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 7)
213 if ((ret = dbd->db_env->log_set_config(dbd->db_env, DB_LOG_AUTO_REMOVE, 1))) {
214 LOG(log_error, logtype_cnid, "error setting DB_LOG_AUTO_REMOVE flag: %s",
216 dbd->db_env->close(dbd->db_env, 0);
221 if ((ret = dbd->db_env->set_flags(dbd->db_env, DB_LOG_AUTOREMOVE, 1))) {
222 LOG(log_error, logtype_cnid, "error setting DB_LOG_AUTOREMOVE flag: %s",
224 dbd->db_env->close(dbd->db_env, 0);
234 /* --------------- */
235 int dbif_open(DBD *dbd, struct db_param *dbp _U_, int do_truncate)
241 for (i = 0; i != DBIF_DB_CNT; i++) {
242 if ((ret = db_create(&dbd->db_table[i].db, dbd->db_env, 0))) {
243 LOG(log_error, logtype_cnid, "error creating handle for database %s: %s",
244 dbd->db_table[i].name, db_strerror(ret));
248 if (dbd->db_table[i].flags) {
249 if ((ret = dbd->db_table[i].db->set_flags(dbd->db_table[i].db,
250 dbd->db_table[i].flags))) {
251 LOG(log_error, logtype_cnid, "error setting flags for database %s: %s",
252 dbd->db_table[i].name, db_strerror(ret));
257 if (dbd->db_table[i].db->open(dbd->db_table[i].db,
260 dbd->db_table[i].name,
261 dbd->db_table[i].type,
262 dbd->db_table[i].openflags,
264 LOG(log_error, logtype_cnid, "Cant open database");
267 if (dbd->db_errlog != NULL)
268 dbd->db_table[i].db->set_errfile(dbd->db_table[i].db, dbd->db_errlog);
270 if (do_truncate && i > 0) {
271 LOG(log_info, logtype_cnid, "Truncating CNID index.");
272 if ((ret = dbd->db_table[i].db->truncate(dbd->db_table[i].db, NULL, &count, 0))) {
273 LOG(log_error, logtype_cnid, "error truncating database %s: %s",
274 dbd->db_table[i].name, db_strerror(ret));
280 /* TODO: Implement CNID DB versioning info on new databases. */
282 /* Associate the secondary with the primary. */
284 LOG(log_info, logtype_cnid, "Reindexing did/name index...");
285 if ((ret = dbd->db_table[0].db->associate(dbd->db_table[DBIF_CNID].db,
287 dbd->db_table[DBIF_IDX_DIDNAME].db,
289 (do_truncate) ? DB_CREATE : 0))
291 LOG(log_error, logtype_cnid, "Failed to associate didname database: %s",db_strerror(ret));
295 LOG(log_info, logtype_cnid, "... done.");
298 LOG(log_info, logtype_cnid, "Reindexing dev/ino index...");
299 if ((ret = dbd->db_table[0].db->associate(dbd->db_table[0].db,
301 dbd->db_table[DBIF_IDX_DEVINO].db,
303 (do_truncate) ? DB_CREATE : 0))
305 LOG(log_error, logtype_cnid, "Failed to associate devino database: %s",db_strerror(ret));
309 LOG(log_info, logtype_cnid, "... done.");
314 /* ------------------------ */
315 int dbif_closedb(DBD *dbd)
321 for (i = DBIF_DB_CNT -1; i >= 0; i--) {
322 if (dbd->db_table[i].db != NULL && (ret = dbd->db_table[i].db->close(dbd->db_table[i].db, 0))) {
323 LOG(log_error, logtype_cnid, "error closing database %s: %s", dbd->db_table[i].name, db_strerror(ret));
332 /* ------------------------ */
333 int dbif_close(DBD *dbd)
338 if (dbif_closedb(dbd))
341 if (dbd->db_env != NULL && (ret = dbd->db_env->close(dbd->db_env, 0))) {
342 LOG(log_error, logtype_cnid, "error closing DB environment: %s", db_strerror(ret));
345 if (dbd->db_errlog != NULL && fclose(dbd->db_errlog) == EOF) {
346 LOG(log_error, logtype_cnid, "error closing DB logfile: %s", strerror(errno));
350 free(dbd->db_filename);
360 * The following three functions are wrappers for DB->get(), DB->put() and DB->del().
361 * All three return -1 on error. dbif_get()/dbif_del return 1 if the key was found and 0
362 * otherwise. dbif_put() returns 0 if key/val was successfully updated and 1 if
363 * the DB_NOOVERWRITE flag was specified and the key already exists.
365 * All return codes other than DB_NOTFOUND and DB_KEYEXIST from the DB->()
366 * functions are not expected and therefore error conditions.
369 int dbif_get(DBD *dbd, const int dbi, DBT *key, DBT *val, u_int32_t flags)
373 ret = dbd->db_table[dbi].db->get(dbd->db_table[dbi].db,
379 if (ret == DB_NOTFOUND)
382 LOG(log_error, logtype_cnid, "error retrieving value from %s: %s",
383 dbd->db_table[dbi].name, db_strerror(errno));
389 /* search by secondary return primary */
390 int dbif_pget(DBD *dbd, const int dbi, DBT *key, DBT *pkey, DBT *val, u_int32_t flags)
394 ret = dbd->db_table[dbi].db->pget(dbd->db_table[dbi].db,
401 if (ret == DB_NOTFOUND || ret == DB_SECONDARY_BAD) {
405 LOG(log_error, logtype_cnid, "error retrieving value from %s: %s",
406 dbd->db_table[dbi].name, db_strerror(errno));
412 /* -------------------------- */
413 int dbif_put(DBD *dbd, const int dbi, DBT *key, DBT *val, u_int32_t flags)
417 if (dbif_txn_begin(dbd) < 0) {
418 LOG(log_error, logtype_cnid, "error setting key/value in %s: %s",
419 dbd->db_table[dbi].name, db_strerror(errno));
423 ret = dbd->db_table[dbi].db->put(dbd->db_table[dbi].db,
430 if ((flags & DB_NOOVERWRITE) && ret == DB_KEYEXIST) {
433 LOG(log_error, logtype_cnid, "error setting key/value in %s: %s",
434 dbd->db_table[dbi].name, db_strerror(errno));
441 int dbif_del(DBD *dbd, const int dbi, DBT *key, u_int32_t flags)
445 if (dbif_txn_begin(dbd) < 0) {
446 LOG(log_error, logtype_cnid, "error deleting key/value from %s: %s",
447 dbd->db_table[dbi].name, db_strerror(errno));
451 ret = dbd->db_table[dbi].db->del(dbd->db_table[dbi].db,
456 if (ret == DB_NOTFOUND || ret == DB_SECONDARY_BAD)
459 LOG(log_error, logtype_cnid, "error deleting key/value from %s: %s",
460 dbd->db_table[dbi].name, db_strerror(errno));
466 int dbif_txn_begin(DBD *dbd)
470 /* If we already have an active txn, just return */
474 /* If our DBD has no env, just return (-> in memory db) */
475 if (dbd->db_env == NULL)
478 ret = dbd->db_env->txn_begin(dbd->db_env, NULL, &dbd->db_txn, 0);
481 LOG(log_error, logtype_cnid, "error starting transaction: %s", db_strerror(errno));
487 int dbif_txn_commit(DBD *dbd)
494 /* If our DBD has no env, just return (-> in memory db) */
495 if (dbd->db_env == NULL)
498 ret = dbd->db_txn->commit(dbd->db_txn, 0);
502 LOG(log_error, logtype_cnid, "error committing transaction: %s", db_strerror(errno));
508 int dbif_txn_abort(DBD *dbd)
515 /* If our DBD has no env, just return (-> in memory db) */
516 if (dbd->db_env == NULL)
519 ret = dbd->db_txn->abort(dbd->db_txn);
523 LOG(log_error, logtype_cnid, "error aborting transaction: %s", db_strerror(errno));
529 int dbif_txn_checkpoint(DBD *dbd, u_int32_t kbyte, u_int32_t min, u_int32_t flags)
532 ret = dbd->db_env->txn_checkpoint(dbd->db_env, kbyte, min, flags);
534 LOG(log_error, logtype_cnid, "error checkpointing transaction susystem: %s", db_strerror(errno));
540 int dbif_count(DBD *dbd, const int dbi, u_int32_t *count)
544 DB *db = dbd->db_table[dbi].db;
546 ret = db->stat(db, NULL, &sp, 0);
549 LOG(log_error, logtype_cnid, "error getting stat infotmation on database: %s", db_strerror(errno));
553 *count = sp->bt_ndata;
559 int dbif_copy_rootinfokey(DBD *srcdbd, DBD *destdbd)
564 memset(&key, 0, sizeof(key));
565 memset(&data, 0, sizeof(data));
567 key.data = ROOTINFO_KEY;
568 key.size = ROOTINFO_KEYLEN;
570 if ((rc = dbif_get(srcdbd, DBIF_CNID, &key, &data, 0)) <= 0) {
571 LOG(log_error, logtype_cnid, "dbif_copy_rootinfokey: Error getting rootinfo record");
575 memset(&key, 0, sizeof(key));
576 key.data = ROOTINFO_KEY;
577 key.size = ROOTINFO_KEYLEN;
579 if ((rc = dbif_put(destdbd, DBIF_CNID, &key, &data, 0))) {
580 LOG(log_error, logtype_cnid, "dbif_copy_rootinfokey: Error writing rootinfo key");
587 int dbif_dump(DBD *dbd, int dumpindexes)
590 uint32_t max = 0, count = 0, cnid, type, did, lastid;
594 DBT key = { 0 }, data = { 0 };
595 DB *db = dbd->db_table[DBIF_CNID].db;
596 char *typestring[2] = {"f", "d"};
599 printf("CNID database dump:\n");
601 rc = db->cursor(db, NULL, &cur, 0);
603 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
607 cur->c_get(cur, &key, &data, DB_FIRST);
609 /* Parse and print data */
610 memcpy(&cnid, key.data, 4);
615 /* Rootinfo node ? */
617 memcpy(&stamp, data.data + 4, sizeof(time_t));
618 memcpy(&lastid, data.data + 20, sizeof(cnid_t));
619 lastid = ntohl(lastid);
620 strftime(timebuf, sizeof(timebuf), "%b %d %Y %H:%M:%S", localtime(&stamp));
621 printf("dbd stamp: 0x%08x (%s), next free CNID: %u\n", (unsigned int)stamp, timebuf, lastid + 1);
624 memcpy(&dev, data.data + CNID_DEV_OFS, 8);
627 memcpy(&ino, data.data + CNID_INO_OFS, 8);
630 memcpy(&type, data.data + CNID_TYPE_OFS, 4);
633 memcpy(&did, data.data + CNID_DID_OFS, 4);
637 printf("id: %10u, did: %10u, type: %s, dev: 0x%llx, ino: 0x%016llx, name: %s\n",
638 cnid, did, typestring[type],
639 (long long unsigned int)dev, (long long unsigned int)ino,
640 (char *)data.data + CNID_NAME_OFS);
644 rc = cur->c_get(cur, &key, &data, DB_NEXT);
647 if (rc != DB_NOTFOUND) {
648 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
652 rc = cur->c_close(cur);
654 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
657 printf("%u CNIDs in database. Max CNID: %u.\n", count, max);
659 /* Dump indexes too ? */
661 /* DBIF_IDX_DEVINO */
662 printf("\ndev/inode index:\n");
664 db = dbd->db_table[DBIF_IDX_DEVINO].db;
665 rc = db->cursor(db, NULL, &cur, 0);
667 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
671 cur->c_get(cur, &key, &data, DB_FIRST);
673 /* Parse and print data */
676 memcpy(&cnid, data.data, CNID_LEN);
682 memcpy(&dev, key.data, CNID_DEV_LEN);
685 memcpy(&ino, key.data + CNID_DEV_LEN, CNID_INO_LEN);
688 printf("id: %10u <== dev: 0x%llx, ino: 0x%016llx\n",
689 cnid, (unsigned long long int)dev, (unsigned long long int)ino);
692 rc = cur->c_get(cur, &key, &data, DB_NEXT);
694 if (rc != DB_NOTFOUND) {
695 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
699 rc = cur->c_close(cur);
701 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
704 printf("%u items\n", count);
706 /* Now dump DBIF_IDX_DIDNAME */
707 printf("\ndid/name index:\n");
709 db = dbd->db_table[DBIF_IDX_DIDNAME].db;
710 rc = db->cursor(db, NULL, &cur, 0);
712 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
716 cur->c_get(cur, &key, &data, DB_FIRST);
718 /* Parse and print data */
721 memcpy(&cnid, data.data, CNID_LEN);
727 memcpy(&did, key.data, CNID_LEN);
730 printf("id: %10u <== did: %10u, name: %s\n", cnid, did, (char *)key.data + CNID_LEN);
733 rc = cur->c_get(cur, &key, &data, DB_NEXT);
735 if (rc != DB_NOTFOUND) {
736 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
740 rc = cur->c_close(cur);
742 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
745 printf("%u items\n", count);