2 * $Id: dbif.c,v 1.12 2009-05-22 20:48:44 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)
64 if ((cwd = open(".", O_RDONLY)) < 0) {
65 LOG(log_error, logtype_cnid, "error opening cwd: %s", strerror(errno));
69 /* chdir to db_envhome */
70 if ((chdir(dbd->db_envhome)) != 0) {
71 LOG(log_error, logtype_cnid, "error chdiring to db_env '%s': %s", dbd->db_envhome, strerror(errno));
75 if ((rc = stat(dbd->db_table[DBIF_CNID].name, &st)) < 0) {
76 LOG(log_error, logtype_cnid, "error stating database %s: %s", dbd->db_table[DBIF_CNID].name, db_strerror(rc));
79 memset(buffer, 0, size);
80 memcpy(buffer, &st.st_ctime, sizeof(st.st_ctime));
82 if ((fchdir(cwd)) != 0) {
83 LOG(log_error, logtype_cnid, "error chdiring back: %s", strerror(errno));
91 DBD *dbif_init(const char *envhome, const char *filename)
95 if ( NULL == (dbd = calloc(sizeof(DBD), 1)) )
98 /* filename == NULL means in memory db */
103 dbd->db_envhome = strdup(envhome);
104 if (NULL == dbd->db_envhome) {
109 dbd->db_filename = strdup(filename);
110 if (NULL == dbd->db_filename) {
111 free(dbd->db_envhome);
117 dbd->db_table[DBIF_CNID].name = "cnid2.db";
118 dbd->db_table[DBIF_IDX_DEVINO].name = "devino.db";
119 dbd->db_table[DBIF_IDX_DIDNAME].name = "didname.db";
121 dbd->db_table[DBIF_CNID].type = DB_BTREE;
122 dbd->db_table[DBIF_IDX_DEVINO].type = DB_BTREE;
123 dbd->db_table[DBIF_IDX_DIDNAME].type = DB_BTREE;
125 dbd->db_table[DBIF_CNID].openflags = DB_CREATE;
126 dbd->db_table[DBIF_IDX_DEVINO].openflags = DB_CREATE;
127 dbd->db_table[DBIF_IDX_DIDNAME].openflags = DB_CREATE;
133 We must open the db_env with an absolute pathname, as `dbd` keeps chdir'ing, which
134 breaks e.g. bdb logfile-rotation with relative pathnames.
135 But still we use relative paths with upgrade_required() and the DB_ERRLOGFILE
136 in order to avoid creating absolute paths by copying. Both have no problem with
139 int dbif_env_open(DBD *dbd, struct db_param *dbp, uint32_t dbenv_oflags)
142 char **logfiles = NULL;
146 if ((cwd = open(".", O_RDONLY)) < 0) {
147 LOG(log_error, logtype_cnid, "error opening cwd: %s", strerror(errno));
151 /* chdir to db_envhome. makes it easier checking for old db files and creating db_errlog file */
152 if ((chdir(dbd->db_envhome)) != 0) {
153 LOG(log_error, logtype_cnid, "error chdiring to db_env '%s': %s", dbd->db_envhome, strerror(errno));
157 /* Refuse to do anything if this is an old version of the CNID database */
158 if (upgrade_required()) {
159 LOG(log_error, logtype_cnid, "Found version 1 of the CNID database. Please upgrade to version 2");
163 if ((dbd->db_errlog = fopen(DB_ERRLOGFILE, "a")) == NULL)
164 LOG(log_warning, logtype_cnid, "error creating/opening DB errlogfile: %s", strerror(errno));
166 if ((fchdir(cwd)) != 0) {
167 LOG(log_error, logtype_cnid, "error chdiring back: %s", strerror(errno));
171 if ((ret = db_env_create(&dbd->db_env, 0))) {
172 LOG(log_error, logtype_cnid, "error creating DB environment: %s",
178 if (dbd->db_errlog != NULL) {
179 dbd->db_env->set_errfile(dbd->db_env, dbd->db_errlog);
180 dbd->db_env->set_msgfile(dbd->db_env, dbd->db_errlog);
183 if (dbenv_oflags & DB_RECOVER) {
184 dbd->db_env->set_verbose(dbd->db_env, DB_VERB_RECOVERY, 1);
185 /* Open the database for recovery using DB_PRIVATE option which is faster */
186 if ((ret = dbd->db_env->open(dbd->db_env, dbd->db_envhome, dbenv_oflags | DB_PRIVATE, 0))) {
187 LOG(log_error, logtype_cnid, "error opening DB environment: %s",
189 dbd->db_env->close(dbd->db_env, 0);
193 dbenv_oflags = (dbenv_oflags & ~DB_RECOVER);
195 if (dbd->db_errlog != NULL)
196 fflush(dbd->db_errlog);
198 if ((ret = dbd->db_env->close(dbd->db_env, 0))) {
199 LOG(log_error, logtype_cnid, "error closing DB environment after recovery: %s",
205 if ((ret = db_env_create(&dbd->db_env, 0))) {
206 LOG(log_error, logtype_cnid, "error creating DB environment after recovery: %s",
213 if ((ret = dbd->db_env->set_cachesize(dbd->db_env, 0, 1024 * dbp->cachesize, 0))) {
214 LOG(log_error, logtype_cnid, "error setting DB environment cachesize to %i: %s",
215 dbp->cachesize, db_strerror(ret));
216 dbd->db_env->close(dbd->db_env, 0);
221 if (dbd->db_errlog != NULL) {
222 dbd->db_env->set_errfile(dbd->db_env, dbd->db_errlog);
223 dbd->db_env->set_msgfile(dbd->db_env, dbd->db_errlog);
225 if ((ret = dbd->db_env->open(dbd->db_env, dbd->db_envhome, dbenv_oflags, 0))) {
226 LOG(log_error, logtype_cnid, "error opening DB environment after recovery: %s",
228 dbd->db_env->close(dbd->db_env, 0);
233 if ((ret = dbd->db_env->set_flags(dbd->db_env, DB_AUTO_COMMIT, 1))) {
234 LOG(log_error, logtype_cnid, "error setting DB_AUTO_COMMIT flag: %s",
236 dbd->db_env->close(dbd->db_env, 0);
241 if (dbp->logfile_autoremove) {
242 if (dbd->db_env->log_archive(dbd->db_env, &logfiles, 0)) {
243 LOG(log_error, logtype_cnid, "error getting list of stale logfiles: %s",
245 dbd->db_env->close(dbd->db_env, 0);
249 if (logfiles != NULL) {
250 for (file = logfiles; *file != NULL; file++) {
251 if (unlink(*file) < 0)
252 LOG(log_warning, logtype_cnid, "Error removing stale logfile %s: %s", *file, strerror(errno));
257 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 7)
258 if ((ret = dbd->db_env->log_set_config(dbd->db_env, DB_LOG_AUTO_REMOVE, 1))) {
259 LOG(log_error, logtype_cnid, "error setting DB_LOG_AUTO_REMOVE flag: %s",
261 dbd->db_env->close(dbd->db_env, 0);
266 if ((ret = dbd->db_env->set_flags(dbd->db_env, DB_LOG_AUTOREMOVE, 1))) {
267 LOG(log_error, logtype_cnid, "error setting DB_LOG_AUTOREMOVE flag: %s",
269 dbd->db_env->close(dbd->db_env, 0);
279 /* --------------- */
280 int dbif_open(DBD *dbd, struct db_param *dbp _U_, int reindex)
286 for (i = 0; i != DBIF_DB_CNT; i++) {
287 if ((ret = db_create(&dbd->db_table[i].db, dbd->db_env, 0))) {
288 LOG(log_error, logtype_cnid, "error creating handle for database %s: %s",
289 dbd->db_table[i].name, db_strerror(ret));
293 if (dbd->db_table[i].flags) {
294 if ((ret = dbd->db_table[i].db->set_flags(dbd->db_table[i].db,
295 dbd->db_table[i].flags))) {
296 LOG(log_error, logtype_cnid, "error setting flags for database %s: %s",
297 dbd->db_table[i].name, db_strerror(ret));
302 if (dbd->db_table[i].db->open(dbd->db_table[i].db,
305 dbd->db_table[i].name,
306 dbd->db_table[i].type,
307 dbd->db_table[i].openflags,
309 LOG(log_error, logtype_cnid, "Cant open database");
312 if (dbd->db_errlog != NULL)
313 dbd->db_table[i].db->set_errfile(dbd->db_table[i].db, dbd->db_errlog);
315 if (reindex && i > 0) {
316 LOG(log_info, logtype_cnid, "Truncating CNID index.");
317 if ((ret = dbd->db_table[i].db->truncate(dbd->db_table[i].db, NULL, &count, 0))) {
318 LOG(log_error, logtype_cnid, "error truncating database %s: %s",
319 dbd->db_table[i].name, db_strerror(ret));
325 /* TODO: Implement CNID DB versioning info on new databases. */
327 /* Associate the secondary with the primary. */
329 LOG(log_info, logtype_cnid, "Reindexing did/name index...");
330 if ((ret = dbd->db_table[0].db->associate(dbd->db_table[DBIF_CNID].db,
332 dbd->db_table[DBIF_IDX_DIDNAME].db,
334 (reindex) ? DB_CREATE : 0))
336 LOG(log_error, logtype_cnid, "Failed to associate didname database: %s",db_strerror(ret));
340 LOG(log_info, logtype_cnid, "... done.");
343 LOG(log_info, logtype_cnid, "Reindexing dev/ino index...");
344 if ((ret = dbd->db_table[0].db->associate(dbd->db_table[0].db,
346 dbd->db_table[DBIF_IDX_DEVINO].db,
348 (reindex) ? DB_CREATE : 0))
350 LOG(log_error, logtype_cnid, "Failed to associate devino database: %s",db_strerror(ret));
354 LOG(log_info, logtype_cnid, "... done.");
359 /* ------------------------ */
360 int dbif_closedb(DBD *dbd)
366 for (i = DBIF_DB_CNT -1; i >= 0; i--) {
367 if (dbd->db_table[i].db != NULL && (ret = dbd->db_table[i].db->close(dbd->db_table[i].db, 0))) {
368 LOG(log_error, logtype_cnid, "error closing database %s: %s", dbd->db_table[i].name, db_strerror(ret));
377 /* ------------------------ */
378 int dbif_close(DBD *dbd)
383 if (dbif_closedb(dbd))
386 if (dbd->db_env != NULL && (ret = dbd->db_env->close(dbd->db_env, 0))) {
387 LOG(log_error, logtype_cnid, "error closing DB environment: %s", db_strerror(ret));
390 if (dbd->db_errlog != NULL && fclose(dbd->db_errlog) == EOF) {
391 LOG(log_error, logtype_cnid, "error closing DB logfile: %s", strerror(errno));
395 free(dbd->db_filename);
405 * The following three functions are wrappers for DB->get(), DB->put() and DB->del().
406 * All three return -1 on error. dbif_get()/dbif_del return 1 if the key was found and 0
407 * otherwise. dbif_put() returns 0 if key/val was successfully updated and 1 if
408 * the DB_NOOVERWRITE flag was specified and the key already exists.
410 * All return codes other than DB_NOTFOUND and DB_KEYEXIST from the DB->()
411 * functions are not expected and therefore error conditions.
414 int dbif_get(DBD *dbd, const int dbi, DBT *key, DBT *val, u_int32_t flags)
418 ret = dbd->db_table[dbi].db->get(dbd->db_table[dbi].db,
424 if (ret == DB_NOTFOUND)
427 LOG(log_error, logtype_cnid, "error retrieving value from %s: %s",
428 dbd->db_table[dbi].name, db_strerror(errno));
434 /* search by secondary return primary */
435 int dbif_pget(DBD *dbd, const int dbi, DBT *key, DBT *pkey, DBT *val, u_int32_t flags)
439 ret = dbd->db_table[dbi].db->pget(dbd->db_table[dbi].db,
446 if (ret == DB_NOTFOUND || ret == DB_SECONDARY_BAD) {
450 LOG(log_error, logtype_cnid, "error retrieving value from %s: %s",
451 dbd->db_table[dbi].name, db_strerror(errno));
457 /* -------------------------- */
458 int dbif_put(DBD *dbd, const int dbi, DBT *key, DBT *val, u_int32_t flags)
462 if (dbif_txn_begin(dbd) < 0) {
463 LOG(log_error, logtype_cnid, "error setting key/value in %s: %s",
464 dbd->db_table[dbi].name, db_strerror(errno));
468 ret = dbd->db_table[dbi].db->put(dbd->db_table[dbi].db,
475 if ((flags & DB_NOOVERWRITE) && ret == DB_KEYEXIST) {
478 LOG(log_error, logtype_cnid, "error setting key/value in %s: %s",
479 dbd->db_table[dbi].name, db_strerror(errno));
486 int dbif_del(DBD *dbd, const int dbi, DBT *key, u_int32_t flags)
490 /* For cooperation with the dbd utility and its usage of a cursor */
492 dbd->db_cur->close(dbd->db_cur);
496 if (dbif_txn_begin(dbd) < 0) {
497 LOG(log_error, logtype_cnid, "error deleting key/value from %s: %s",
498 dbd->db_table[dbi].name, db_strerror(errno));
502 ret = dbd->db_table[dbi].db->del(dbd->db_table[dbi].db,
507 if (ret == DB_NOTFOUND || ret == DB_SECONDARY_BAD)
510 LOG(log_error, logtype_cnid, "error deleting key/value from %s: %s",
511 dbd->db_table[dbi].name, db_strerror(errno));
517 int dbif_txn_begin(DBD *dbd)
521 /* If we already have an active txn, just return */
525 /* If our DBD has no env, just return (-> in memory db) */
526 if (dbd->db_env == NULL)
529 ret = dbd->db_env->txn_begin(dbd->db_env, NULL, &dbd->db_txn, 0);
532 LOG(log_error, logtype_cnid, "error starting transaction: %s", db_strerror(errno));
538 int dbif_txn_commit(DBD *dbd)
545 /* If our DBD has no env, just return (-> in memory db) */
546 if (dbd->db_env == NULL)
549 ret = dbd->db_txn->commit(dbd->db_txn, 0);
553 LOG(log_error, logtype_cnid, "error committing transaction: %s", db_strerror(errno));
559 int dbif_txn_abort(DBD *dbd)
566 /* If our DBD has no env, just return (-> in memory db) */
567 if (dbd->db_env == NULL)
570 ret = dbd->db_txn->abort(dbd->db_txn);
574 LOG(log_error, logtype_cnid, "error aborting transaction: %s", db_strerror(errno));
581 ret = 1 -> commit txn
582 ret = 0 -> abort txn -> exit!
583 anything else -> exit!
585 void dbif_txn_close(DBD *dbd, int ret)
588 if (dbif_txn_abort(dbd) < 0) {
589 LOG( log_error, logtype_cnid, "Fatal error aborting transaction. Exiting!");
592 } else if (ret == 1) {
593 ret = dbif_txn_commit(dbd);
595 LOG( log_error, logtype_cnid, "Fatal error committing transaction. Exiting!");
602 int dbif_txn_checkpoint(DBD *dbd, u_int32_t kbyte, u_int32_t min, u_int32_t flags)
605 ret = dbd->db_env->txn_checkpoint(dbd->db_env, kbyte, min, flags);
607 LOG(log_error, logtype_cnid, "error checkpointing transaction susystem: %s", db_strerror(errno));
613 int dbif_count(DBD *dbd, const int dbi, u_int32_t *count)
617 DB *db = dbd->db_table[dbi].db;
619 ret = db->stat(db, NULL, &sp, 0);
622 LOG(log_error, logtype_cnid, "error getting stat infotmation on database: %s", db_strerror(errno));
626 *count = sp->bt_ndata;
632 int dbif_copy_rootinfokey(DBD *srcdbd, DBD *destdbd)
637 memset(&key, 0, sizeof(key));
638 memset(&data, 0, sizeof(data));
640 key.data = ROOTINFO_KEY;
641 key.size = ROOTINFO_KEYLEN;
643 if ((rc = dbif_get(srcdbd, DBIF_CNID, &key, &data, 0)) <= 0) {
644 LOG(log_error, logtype_cnid, "dbif_copy_rootinfokey: Error getting rootinfo record");
648 memset(&key, 0, sizeof(key));
649 key.data = ROOTINFO_KEY;
650 key.size = ROOTINFO_KEYLEN;
652 if ((rc = dbif_put(destdbd, DBIF_CNID, &key, &data, 0))) {
653 LOG(log_error, logtype_cnid, "dbif_copy_rootinfokey: Error writing rootinfo key");
660 int dbif_dump(DBD *dbd, int dumpindexes)
663 uint32_t max = 0, count = 0, cnid, type, did, lastid;
667 DBT key = { 0 }, data = { 0 };
668 DB *db = dbd->db_table[DBIF_CNID].db;
669 char *typestring[2] = {"f", "d"};
672 printf("CNID database dump:\n");
674 rc = db->cursor(db, NULL, &cur, 0);
676 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
680 cur->c_get(cur, &key, &data, DB_FIRST);
682 /* Parse and print data */
683 memcpy(&cnid, key.data, 4);
688 /* Rootinfo node ? */
690 memcpy(&stamp, data.data + 4, sizeof(time_t));
691 memcpy(&lastid, data.data + 20, sizeof(cnid_t));
692 lastid = ntohl(lastid);
693 strftime(timebuf, sizeof(timebuf), "%b %d %Y %H:%M:%S", localtime(&stamp));
694 printf("dbd stamp: 0x%08x (%s), next free CNID: %u\n", (unsigned int)stamp, timebuf, lastid + 1);
697 memcpy(&dev, data.data + CNID_DEV_OFS, 8);
700 memcpy(&ino, data.data + CNID_INO_OFS, 8);
703 memcpy(&type, data.data + CNID_TYPE_OFS, 4);
706 memcpy(&did, data.data + CNID_DID_OFS, 4);
710 printf("id: %10u, did: %10u, type: %s, dev: 0x%llx, ino: 0x%016llx, name: %s\n",
711 cnid, did, typestring[type],
712 (long long unsigned int)dev, (long long unsigned int)ino,
713 (char *)data.data + CNID_NAME_OFS);
717 rc = cur->c_get(cur, &key, &data, DB_NEXT);
720 if (rc != DB_NOTFOUND) {
721 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
725 rc = cur->c_close(cur);
727 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
730 printf("%u CNIDs in database. Max CNID: %u.\n", count, max);
732 /* Dump indexes too ? */
734 /* DBIF_IDX_DEVINO */
735 printf("\ndev/inode index:\n");
737 db = dbd->db_table[DBIF_IDX_DEVINO].db;
738 rc = db->cursor(db, NULL, &cur, 0);
740 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
744 cur->c_get(cur, &key, &data, DB_FIRST);
746 /* Parse and print data */
749 memcpy(&cnid, data.data, CNID_LEN);
755 memcpy(&dev, key.data, CNID_DEV_LEN);
758 memcpy(&ino, key.data + CNID_DEV_LEN, CNID_INO_LEN);
761 printf("id: %10u <== dev: 0x%llx, ino: 0x%016llx\n",
762 cnid, (unsigned long long int)dev, (unsigned long long int)ino);
765 rc = cur->c_get(cur, &key, &data, DB_NEXT);
767 if (rc != DB_NOTFOUND) {
768 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
772 rc = cur->c_close(cur);
774 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
777 printf("%u items\n", count);
779 /* Now dump DBIF_IDX_DIDNAME */
780 printf("\ndid/name index:\n");
782 db = dbd->db_table[DBIF_IDX_DIDNAME].db;
783 rc = db->cursor(db, NULL, &cur, 0);
785 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
789 cur->c_get(cur, &key, &data, DB_FIRST);
791 /* Parse and print data */
794 memcpy(&cnid, data.data, CNID_LEN);
800 memcpy(&did, key.data, CNID_LEN);
803 printf("id: %10u <== did: %10u, name: %s\n", cnid, did, (char *)key.data + CNID_LEN);
806 rc = cur->c_get(cur, &key, &data, DB_NEXT);
808 if (rc != DB_NOTFOUND) {
809 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
813 rc = cur->c_close(cur);
815 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
818 printf("%u items\n", count);
825 Iterates over dbd, returning cnids.
826 Uses in-value of cnid to seek to that cnid, then gets next and return that in cnid.
827 If close=1, close cursor.
828 Return -1 on error, 0 on EOD (end-of-database), 1 if returning cnid.
830 int dbif_idwalk(DBD *dbd, cnid_t *cnid, int close)
836 static DBT key = { 0 }, data = { 0 };
837 DB *db = dbd->db_table[DBIF_CNID].db;
839 if (close && dbd->db_cur) {
840 dbd->db_cur->close(dbd->db_cur);
845 /* An dbif_del will have closed our cursor too */
846 if ( ! dbd->db_cur ) {
847 if (db->cursor(db, NULL, &dbd->db_cur, 0) != 0) {
848 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
851 flag = DB_SET_RANGE; /* This will seek to next cnid after the one just deleted */
854 key.size = sizeof(cnid_t);
858 if ((rc = dbd->db_cur->get(dbd->db_cur, &key, &data, flag)) == 0) {
859 memcpy(cnid, key.data, sizeof(cnid_t));
860 *cnid = ntohl(*cnid);
864 if (rc != DB_NOTFOUND) {
865 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
866 dbd->db_cur->close(dbd->db_cur);
872 dbd->db_cur->close(dbd->db_cur);