2 * $Id: dbif.c,v 1.11 2009-05-18 09:54:14 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;
116 We must open the db_env with an absolute pathname, as `dbd` keeps chdir'ing, which
117 breaks e.g. bdb logfile-rotation with relative pathnames.
118 But still we use relative paths with upgrade_required() and the DB_ERRLOGFILE
119 in order to avoid creating absolute paths by copying. Both have no problem with
122 int dbif_env_open(DBD *dbd, struct db_param *dbp, uint32_t dbenv_oflags)
125 char **logfiles = NULL;
129 if ((cwd = open(".", O_RDONLY)) < 0) {
130 LOG(log_error, logtype_cnid, "error opening cwd: %s", strerror(errno));
134 /* chdir to db_envhome. makes it easier checking for old db files and creating db_errlog file */
135 if ((chdir(dbd->db_envhome)) != 0) {
136 LOG(log_error, logtype_cnid, "error chdiring to db_env '%s': %s", dbd->db_envhome, strerror(errno));
140 /* Refuse to do anything if this is an old version of the CNID database */
141 if (upgrade_required()) {
142 LOG(log_error, logtype_cnid, "Found version 1 of the CNID database. Please upgrade to version 2");
146 if ((dbd->db_errlog = fopen(DB_ERRLOGFILE, "a")) == NULL)
147 LOG(log_warning, logtype_cnid, "error creating/opening DB errlogfile: %s", strerror(errno));
149 if ((fchdir(cwd)) != 0) {
150 LOG(log_error, logtype_cnid, "error chdiring back: %s", strerror(errno));
154 if ((ret = db_env_create(&dbd->db_env, 0))) {
155 LOG(log_error, logtype_cnid, "error creating DB environment: %s",
161 if (dbd->db_errlog != NULL) {
162 dbd->db_env->set_errfile(dbd->db_env, dbd->db_errlog);
163 dbd->db_env->set_msgfile(dbd->db_env, dbd->db_errlog);
166 if (dbenv_oflags & DB_RECOVER) {
167 dbd->db_env->set_verbose(dbd->db_env, DB_VERB_RECOVERY, 1);
168 /* Open the database for recovery using DB_PRIVATE option which is faster */
169 if ((ret = dbd->db_env->open(dbd->db_env, dbd->db_envhome, dbenv_oflags | DB_PRIVATE, 0))) {
170 LOG(log_error, logtype_cnid, "error opening DB environment: %s",
172 dbd->db_env->close(dbd->db_env, 0);
176 dbenv_oflags = (dbenv_oflags & ~DB_RECOVER);
178 if (dbd->db_errlog != NULL)
179 fflush(dbd->db_errlog);
181 if ((ret = dbd->db_env->close(dbd->db_env, 0))) {
182 LOG(log_error, logtype_cnid, "error closing DB environment after recovery: %s",
188 if ((ret = db_env_create(&dbd->db_env, 0))) {
189 LOG(log_error, logtype_cnid, "error creating DB environment after recovery: %s",
196 if ((ret = dbd->db_env->set_cachesize(dbd->db_env, 0, 1024 * dbp->cachesize, 0))) {
197 LOG(log_error, logtype_cnid, "error setting DB environment cachesize to %i: %s",
198 dbp->cachesize, db_strerror(ret));
199 dbd->db_env->close(dbd->db_env, 0);
204 if (dbd->db_errlog != NULL) {
205 dbd->db_env->set_errfile(dbd->db_env, dbd->db_errlog);
206 dbd->db_env->set_msgfile(dbd->db_env, dbd->db_errlog);
208 if ((ret = dbd->db_env->open(dbd->db_env, dbd->db_envhome, dbenv_oflags, 0))) {
209 LOG(log_error, logtype_cnid, "error opening DB environment after recovery: %s",
211 dbd->db_env->close(dbd->db_env, 0);
216 if ((ret = dbd->db_env->set_flags(dbd->db_env, DB_AUTO_COMMIT, 1))) {
217 LOG(log_error, logtype_cnid, "error setting DB_AUTO_COMMIT flag: %s",
219 dbd->db_env->close(dbd->db_env, 0);
224 if (dbp->logfile_autoremove) {
225 if (dbd->db_env->log_archive(dbd->db_env, &logfiles, 0)) {
226 LOG(log_error, logtype_cnid, "error getting list of stale logfiles: %s",
228 dbd->db_env->close(dbd->db_env, 0);
232 if (logfiles != NULL) {
233 for (file = logfiles; *file != NULL; file++) {
234 if (unlink(*file) < 0)
235 LOG(log_warning, logtype_cnid, "Error removing stale logfile %s: %s", *file, strerror(errno));
240 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 7)
241 if ((ret = dbd->db_env->log_set_config(dbd->db_env, DB_LOG_AUTO_REMOVE, 1))) {
242 LOG(log_error, logtype_cnid, "error setting DB_LOG_AUTO_REMOVE flag: %s",
244 dbd->db_env->close(dbd->db_env, 0);
249 if ((ret = dbd->db_env->set_flags(dbd->db_env, DB_LOG_AUTOREMOVE, 1))) {
250 LOG(log_error, logtype_cnid, "error setting DB_LOG_AUTOREMOVE flag: %s",
252 dbd->db_env->close(dbd->db_env, 0);
262 /* --------------- */
263 int dbif_open(DBD *dbd, struct db_param *dbp _U_, int do_truncate)
269 for (i = 0; i != DBIF_DB_CNT; i++) {
270 if ((ret = db_create(&dbd->db_table[i].db, dbd->db_env, 0))) {
271 LOG(log_error, logtype_cnid, "error creating handle for database %s: %s",
272 dbd->db_table[i].name, db_strerror(ret));
276 if (dbd->db_table[i].flags) {
277 if ((ret = dbd->db_table[i].db->set_flags(dbd->db_table[i].db,
278 dbd->db_table[i].flags))) {
279 LOG(log_error, logtype_cnid, "error setting flags for database %s: %s",
280 dbd->db_table[i].name, db_strerror(ret));
285 if (dbd->db_table[i].db->open(dbd->db_table[i].db,
288 dbd->db_table[i].name,
289 dbd->db_table[i].type,
290 dbd->db_table[i].openflags,
292 LOG(log_error, logtype_cnid, "Cant open database");
295 if (dbd->db_errlog != NULL)
296 dbd->db_table[i].db->set_errfile(dbd->db_table[i].db, dbd->db_errlog);
298 if (do_truncate && i > 0) {
299 LOG(log_info, logtype_cnid, "Truncating CNID index.");
300 if ((ret = dbd->db_table[i].db->truncate(dbd->db_table[i].db, NULL, &count, 0))) {
301 LOG(log_error, logtype_cnid, "error truncating database %s: %s",
302 dbd->db_table[i].name, db_strerror(ret));
308 /* TODO: Implement CNID DB versioning info on new databases. */
310 /* Associate the secondary with the primary. */
312 LOG(log_info, logtype_cnid, "Reindexing did/name index...");
313 if ((ret = dbd->db_table[0].db->associate(dbd->db_table[DBIF_CNID].db,
315 dbd->db_table[DBIF_IDX_DIDNAME].db,
317 (do_truncate) ? DB_CREATE : 0))
319 LOG(log_error, logtype_cnid, "Failed to associate didname database: %s",db_strerror(ret));
323 LOG(log_info, logtype_cnid, "... done.");
326 LOG(log_info, logtype_cnid, "Reindexing dev/ino index...");
327 if ((ret = dbd->db_table[0].db->associate(dbd->db_table[0].db,
329 dbd->db_table[DBIF_IDX_DEVINO].db,
331 (do_truncate) ? DB_CREATE : 0))
333 LOG(log_error, logtype_cnid, "Failed to associate devino database: %s",db_strerror(ret));
337 LOG(log_info, logtype_cnid, "... done.");
342 /* ------------------------ */
343 int dbif_closedb(DBD *dbd)
349 for (i = DBIF_DB_CNT -1; i >= 0; i--) {
350 if (dbd->db_table[i].db != NULL && (ret = dbd->db_table[i].db->close(dbd->db_table[i].db, 0))) {
351 LOG(log_error, logtype_cnid, "error closing database %s: %s", dbd->db_table[i].name, db_strerror(ret));
360 /* ------------------------ */
361 int dbif_close(DBD *dbd)
366 if (dbif_closedb(dbd))
369 if (dbd->db_env != NULL && (ret = dbd->db_env->close(dbd->db_env, 0))) {
370 LOG(log_error, logtype_cnid, "error closing DB environment: %s", db_strerror(ret));
373 if (dbd->db_errlog != NULL && fclose(dbd->db_errlog) == EOF) {
374 LOG(log_error, logtype_cnid, "error closing DB logfile: %s", strerror(errno));
378 free(dbd->db_filename);
388 * The following three functions are wrappers for DB->get(), DB->put() and DB->del().
389 * All three return -1 on error. dbif_get()/dbif_del return 1 if the key was found and 0
390 * otherwise. dbif_put() returns 0 if key/val was successfully updated and 1 if
391 * the DB_NOOVERWRITE flag was specified and the key already exists.
393 * All return codes other than DB_NOTFOUND and DB_KEYEXIST from the DB->()
394 * functions are not expected and therefore error conditions.
397 int dbif_get(DBD *dbd, const int dbi, DBT *key, DBT *val, u_int32_t flags)
401 ret = dbd->db_table[dbi].db->get(dbd->db_table[dbi].db,
407 if (ret == DB_NOTFOUND)
410 LOG(log_error, logtype_cnid, "error retrieving value from %s: %s",
411 dbd->db_table[dbi].name, db_strerror(errno));
417 /* search by secondary return primary */
418 int dbif_pget(DBD *dbd, const int dbi, DBT *key, DBT *pkey, DBT *val, u_int32_t flags)
422 ret = dbd->db_table[dbi].db->pget(dbd->db_table[dbi].db,
429 if (ret == DB_NOTFOUND || ret == DB_SECONDARY_BAD) {
433 LOG(log_error, logtype_cnid, "error retrieving value from %s: %s",
434 dbd->db_table[dbi].name, db_strerror(errno));
440 /* -------------------------- */
441 int dbif_put(DBD *dbd, const int dbi, DBT *key, DBT *val, u_int32_t flags)
445 if (dbif_txn_begin(dbd) < 0) {
446 LOG(log_error, logtype_cnid, "error setting key/value in %s: %s",
447 dbd->db_table[dbi].name, db_strerror(errno));
451 ret = dbd->db_table[dbi].db->put(dbd->db_table[dbi].db,
458 if ((flags & DB_NOOVERWRITE) && ret == DB_KEYEXIST) {
461 LOG(log_error, logtype_cnid, "error setting key/value in %s: %s",
462 dbd->db_table[dbi].name, db_strerror(errno));
469 int dbif_del(DBD *dbd, const int dbi, DBT *key, u_int32_t flags)
473 if (dbif_txn_begin(dbd) < 0) {
474 LOG(log_error, logtype_cnid, "error deleting key/value from %s: %s",
475 dbd->db_table[dbi].name, db_strerror(errno));
479 ret = dbd->db_table[dbi].db->del(dbd->db_table[dbi].db,
484 if (ret == DB_NOTFOUND || ret == DB_SECONDARY_BAD)
487 LOG(log_error, logtype_cnid, "error deleting key/value from %s: %s",
488 dbd->db_table[dbi].name, db_strerror(errno));
494 int dbif_txn_begin(DBD *dbd)
498 /* If we already have an active txn, just return */
502 /* If our DBD has no env, just return (-> in memory db) */
503 if (dbd->db_env == NULL)
506 ret = dbd->db_env->txn_begin(dbd->db_env, NULL, &dbd->db_txn, 0);
509 LOG(log_error, logtype_cnid, "error starting transaction: %s", db_strerror(errno));
515 int dbif_txn_commit(DBD *dbd)
522 /* If our DBD has no env, just return (-> in memory db) */
523 if (dbd->db_env == NULL)
526 ret = dbd->db_txn->commit(dbd->db_txn, 0);
530 LOG(log_error, logtype_cnid, "error committing transaction: %s", db_strerror(errno));
536 int dbif_txn_abort(DBD *dbd)
543 /* If our DBD has no env, just return (-> in memory db) */
544 if (dbd->db_env == NULL)
547 ret = dbd->db_txn->abort(dbd->db_txn);
551 LOG(log_error, logtype_cnid, "error aborting transaction: %s", db_strerror(errno));
558 ret = 1 -> commit txn
559 ret = 0 -> abort txn -> exit!
560 anything else -> exit!
562 void dbif_txn_close(DBD *dbd, int ret)
565 if (dbif_txn_abort(dbd) < 0) {
566 LOG( log_error, logtype_cnid, "Fatal error aborting transaction. Exiting!");
569 } else if (ret == 1) {
570 ret = dbif_txn_commit(dbd);
572 LOG( log_error, logtype_cnid, "Fatal error committing transaction. Exiting!");
579 int dbif_txn_checkpoint(DBD *dbd, u_int32_t kbyte, u_int32_t min, u_int32_t flags)
582 ret = dbd->db_env->txn_checkpoint(dbd->db_env, kbyte, min, flags);
584 LOG(log_error, logtype_cnid, "error checkpointing transaction susystem: %s", db_strerror(errno));
590 int dbif_count(DBD *dbd, const int dbi, u_int32_t *count)
594 DB *db = dbd->db_table[dbi].db;
596 ret = db->stat(db, NULL, &sp, 0);
599 LOG(log_error, logtype_cnid, "error getting stat infotmation on database: %s", db_strerror(errno));
603 *count = sp->bt_ndata;
609 int dbif_copy_rootinfokey(DBD *srcdbd, DBD *destdbd)
614 memset(&key, 0, sizeof(key));
615 memset(&data, 0, sizeof(data));
617 key.data = ROOTINFO_KEY;
618 key.size = ROOTINFO_KEYLEN;
620 if ((rc = dbif_get(srcdbd, DBIF_CNID, &key, &data, 0)) <= 0) {
621 LOG(log_error, logtype_cnid, "dbif_copy_rootinfokey: Error getting rootinfo record");
625 memset(&key, 0, sizeof(key));
626 key.data = ROOTINFO_KEY;
627 key.size = ROOTINFO_KEYLEN;
629 if ((rc = dbif_put(destdbd, DBIF_CNID, &key, &data, 0))) {
630 LOG(log_error, logtype_cnid, "dbif_copy_rootinfokey: Error writing rootinfo key");
637 int dbif_dump(DBD *dbd, int dumpindexes)
640 uint32_t max = 0, count = 0, cnid, type, did, lastid;
644 DBT key = { 0 }, data = { 0 };
645 DB *db = dbd->db_table[DBIF_CNID].db;
646 char *typestring[2] = {"f", "d"};
649 printf("CNID database dump:\n");
651 rc = db->cursor(db, NULL, &cur, 0);
653 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
657 cur->c_get(cur, &key, &data, DB_FIRST);
659 /* Parse and print data */
660 memcpy(&cnid, key.data, 4);
665 /* Rootinfo node ? */
667 memcpy(&stamp, data.data + 4, sizeof(time_t));
668 memcpy(&lastid, data.data + 20, sizeof(cnid_t));
669 lastid = ntohl(lastid);
670 strftime(timebuf, sizeof(timebuf), "%b %d %Y %H:%M:%S", localtime(&stamp));
671 printf("dbd stamp: 0x%08x (%s), next free CNID: %u\n", (unsigned int)stamp, timebuf, lastid + 1);
674 memcpy(&dev, data.data + CNID_DEV_OFS, 8);
677 memcpy(&ino, data.data + CNID_INO_OFS, 8);
680 memcpy(&type, data.data + CNID_TYPE_OFS, 4);
683 memcpy(&did, data.data + CNID_DID_OFS, 4);
687 printf("id: %10u, did: %10u, type: %s, dev: 0x%llx, ino: 0x%016llx, name: %s\n",
688 cnid, did, typestring[type],
689 (long long unsigned int)dev, (long long unsigned int)ino,
690 (char *)data.data + CNID_NAME_OFS);
694 rc = cur->c_get(cur, &key, &data, DB_NEXT);
697 if (rc != DB_NOTFOUND) {
698 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
702 rc = cur->c_close(cur);
704 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
707 printf("%u CNIDs in database. Max CNID: %u.\n", count, max);
709 /* Dump indexes too ? */
711 /* DBIF_IDX_DEVINO */
712 printf("\ndev/inode index:\n");
714 db = dbd->db_table[DBIF_IDX_DEVINO].db;
715 rc = db->cursor(db, NULL, &cur, 0);
717 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
721 cur->c_get(cur, &key, &data, DB_FIRST);
723 /* Parse and print data */
726 memcpy(&cnid, data.data, CNID_LEN);
732 memcpy(&dev, key.data, CNID_DEV_LEN);
735 memcpy(&ino, key.data + CNID_DEV_LEN, CNID_INO_LEN);
738 printf("id: %10u <== dev: 0x%llx, ino: 0x%016llx\n",
739 cnid, (unsigned long long int)dev, (unsigned long long int)ino);
742 rc = cur->c_get(cur, &key, &data, DB_NEXT);
744 if (rc != DB_NOTFOUND) {
745 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
749 rc = cur->c_close(cur);
751 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
754 printf("%u items\n", count);
756 /* Now dump DBIF_IDX_DIDNAME */
757 printf("\ndid/name index:\n");
759 db = dbd->db_table[DBIF_IDX_DIDNAME].db;
760 rc = db->cursor(db, NULL, &cur, 0);
762 LOG(log_error, logtype_cnid, "Couldn't create cursor: %s", db_strerror(errno));
766 cur->c_get(cur, &key, &data, DB_FIRST);
768 /* Parse and print data */
771 memcpy(&cnid, data.data, CNID_LEN);
777 memcpy(&did, key.data, CNID_LEN);
780 printf("id: %10u <== did: %10u, name: %s\n", cnid, did, (char *)key.data + CNID_LEN);
783 rc = cur->c_get(cur, &key, &data, DB_NEXT);
785 if (rc != DB_NOTFOUND) {
786 LOG(log_error, logtype_cnid, "Error iterating over btree: %s", db_strerror(errno));
790 rc = cur->c_close(cur);
792 LOG(log_error, logtype_cnid, "Couldn't close cursor: %s", db_strerror(errno));
795 printf("%u items\n", count);