-
-/*
- * $Id: cnid_db3_open.c,v 1.5 2009-11-24 12:18:19 didg Exp $
- *
- * Copyright (c) 1999. Adrian Sun (asun@zoology.washington.edu)
- * All Rights Reserved. See COPYRIGHT.
- *
- * CNID database support.
- *
- * here's the deal:
- * 1) afpd already caches did's.
- * 2) the database stores cnid's as both did/name and dev/ino pairs.
- * 3) RootInfo holds the value of the NextID.
- * 4) the cnid database gets called in the following manner --
- * start a database:
- * cnid = cnid_open(root_dir);
- *
- * allocate a new id:
- * newid = cnid_add(cnid, dev, ino, parent did,
- * name, id); id is a hint for a specific id. pass 0 if you don't
- * care. if the id is already assigned, you won't get what you
- * requested.
- *
- * given an id, get a did/name and dev/ino pair.
- * name = cnid_get(cnid, &id); given an id, return the corresponding
- * info.
- * return code = cnid_delete(cnid, id); delete an entry.
- *
- * with AFP, CNIDs 0-2 have special meanings. here they are:
- * 0 -- invalid cnid
- * 1 -- parent of root directory (handled by afpd)
- * 2 -- root directory (handled by afpd)
- *
- * CNIDs 4-16 are reserved according to page 31 of the AFP 3.0 spec so,
- * CNID_START begins at 17.
- */
-
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif /* HAVE_CONFIG_H */
-
-#ifdef CNID_BACKEND_DB3
-
-#include <errno.h>
-#include <stdlib.h>
-#include <string.h>
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
-#endif /* HAVE_UNISTD_H */
-#ifdef HAVE_FCNTL_H
-#include <fcntl.h>
-#endif /* HAVE_FCNTL_H */
-#include <sys/param.h>
-#include <sys/stat.h>
-#include <atalk/logger.h>
-#ifdef HAVE_SYS_TIME_H
-#include <sys/time.h>
-#endif /* HAVE_SYS_TIME_H */
-
-#ifdef HAVE_DB4_DB_H
-#include <db4/db.h>
-#else
-#include <db.h>
-#endif
-
-#include <atalk/adouble.h>
-#include <atalk/cnid.h>
-#include "cnid_db3.h"
-#include <atalk/util.h>
-
-#include "cnid_db3_private.h"
-
-#ifndef MIN
-#define MIN(a, b) ((a) < (b) ? (a) : (b))
-#endif /* ! MIN */
-
-#define DBHOME ".AppleDB"
-#define DBCNID "cnid.db"
-#define DBDEVINO "devino.db"
-#define DBDIDNAME "didname.db" /* did/full name mapping */
-#define DBLOCKFILE "cnid.lock"
-#define DBRECOVERFILE "cnid.dbrecover"
-#define DBCLOSEFILE "cnid.close"
-
-#define DBHOMELEN 8
-#define DBLEN 10
-
-/* we version the did/name database so that we can change the format
- * if necessary. the key is in the form of a did/name pair. in this case,
- * we use 0/0. */
-#define DBVERSION_KEY "\0\0\0\0\0"
-#define DBVERSION_KEYLEN 5
-#define DBVERSION1 0x00000001U
-#define DBVERSION DBVERSION1
-
-#if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
-#define DBOPTIONS (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
-DB_INIT_LOG | DB_INIT_TXN)
-#else /* DB_VERSION_MINOR < 1 */
-
-/*#define DBOPTIONS (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
-DB_INIT_LOG | DB_INIT_TXN | DB_TXN_NOSYNC)*/
-#define DBOPTIONS (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
-DB_INIT_LOG | DB_INIT_TXN)
-#endif /* DB_VERSION_MINOR */
-
-/* Let's try and use the youngest lock detector if present.
- * If we can't do that, then let BDB use its default deadlock detector. */
-#if defined DB_LOCK_YOUNGEST
-#define DEAD_LOCK_DETECT DB_LOCK_YOUNGEST
-#else /* DB_LOCK_YOUNGEST */
-#define DEAD_LOCK_DETECT DB_LOCK_DEFAULT
-#endif /* DB_LOCK_YOUNGEST */
-
-#define MAXITER 0xFFFF /* maximum number of simultaneously open CNID
- * databases. */
-
-#if 0
-/* -----------------------
- * bandaid for LanTest performance pb. for now not used, cf. ifdef 0 below
-*/
-static int my_yield(void)
-{
- struct timeval t;
- int ret;
-
- t.tv_sec = 0;
- t.tv_usec = 1000;
- ret = select(0, NULL, NULL, NULL, &t);
- return 0;
-}
-#endif
-
-/* --------------- */
-static int my_open(DB * p, const char *f, const char *d, DBTYPE t, u_int32_t flags, int mode)
-{
-#if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 1)
- return p->open(p, NULL, f, d, t, flags | DB_AUTO_COMMIT, mode);
-#else
- return p->open(p, f, d, t, flags, mode);
-#endif
-}
-
-#if 0
-/* ---------------
- * XXX not used
-*/
-
-/* the first compare that's always done. */
-static int compare_did(const DBT * a, const DBT * b)
-{
- u_int32_t dida, didb;
-
- memcpy(&dida, a->data, sizeof(dida));
- memcpy(&didb, b->data, sizeof(didb));
- return dida - didb;
-}
-
-/* sort did's and then names. this is for unix paths.
- * i.e., did/unixname lookups. */
-#if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
-static int compare_unix(DB * db _U_, const DBT * a, const DBT * b)
-#else /* DB_VERSION_MINOR < 1 */
-static int compare_unix(const DBT * a, const DBT * b)
-#endif /* DB_VERSION_MINOR */
-{
- u_int8_t *sa, *sb;
- int len, ret;
-
- /* sort by did */
- if ((ret = compare_did(a, b)))
- return ret;
-
- sa = (u_int8_t *) a->data + 4; /* shift past did */
- sb = (u_int8_t *) b->data + 4;
- for (len = MIN(a->size, b->size); len-- > 4; sa++, sb++)
- if ((ret = (*sa - *sb)))
- return ret; /* sort by lexical ordering */
-
- return a->size - b->size; /* sort by length */
-}
-
-/* sort did's and then names. this is for macified paths (i.e.,
- * did/macname, and did/shortname. i think did/longname needs a
- * unicode table to work. also, we can't use strdiacasecmp as that
- * returns a match if a < b. */
-#if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
-static int compare_mac(DB * db _U_, const DBT * a, const DBT * b)
-#else /* DB_VERSION_MINOR < 1 */
-static int compare_mac(const DBT * a, const DBT * b)
-#endif /* DB_VERSION_MINOR */
-{
- u_int8_t *sa, *sb;
- int len, ret;
-
- /* sort by did */
- if ((ret = compare_did(a, b)))
- return ret;
-
- sa = (u_int8_t *) a->data + 4;
- sb = (u_int8_t *) b->data + 4;
- for (len = MIN(a->size, b->size); len-- > 4; sa++, sb++)
- if ((ret = (_diacasemap[*sa] - _diacasemap[*sb])))
- return ret; /* sort by lexical ordering */
-
- return a->size - b->size; /* sort by length */
-}
-
-/* for unicode names -- right now it's the same as compare_mac. */
-#if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
-static int compare_unicode(DB * db, const DBT * a, const DBT * b)
-#else /* DB_VERSION_MINOR < 1 */
-static int compare_unicode(const DBT * a, const DBT * b)
-#endif /* DB_VERSION_MINOR */
-{
-#if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
- return compare_mac(db, a, b);
-#else /* DB_VERSION_MINOR < 1 */
- return compare_mac(a, b);
-#endif /* DB_VERSION_MINOR */
-}
-#endif
-
-static struct _cnid_db *cnid_db3_new(const char *volpath)
-{
- struct _cnid_db *cdb;
-
- if ((cdb = (struct _cnid_db *) calloc(1, sizeof(struct _cnid_db))) == NULL)
- return NULL;
-
- if ((cdb->volpath = strdup(volpath)) == NULL) {
- free(cdb);
- return NULL;
- }
-
- cdb->flags = CNID_FLAG_PERSISTENT;
-
- cdb->cnid_add = cnid_db3_add;
- cdb->cnid_delete = cnid_db3_delete;
- cdb->cnid_get = cnid_db3_get;
- cdb->cnid_lookup = cnid_db3_lookup;
- cdb->cnid_nextid = NULL; /*cnid_db3_nextid;*/
- cdb->cnid_resolve = cnid_db3_resolve;
- cdb->cnid_update = cnid_db3_update;
- cdb->cnid_close = cnid_db3_close;
-
- return cdb;
-}
-
-struct _cnid_db *cnid_db3_open(const char *dir, mode_t mask, u_int32_t flags _U_)
-{
- struct stat st;
- struct flock lock;
- char path[MAXPATHLEN + 1];
- CNID_private *db;
- struct _cnid_db *cdb;
- DBT key, data;
- DB_TXN *tid = NULL;
- int open_flag, len;
- int rc;
-
- if (!dir) {
- return NULL;
- }
-
- /* this checks .AppleDB */
- if ((len = strlen(dir)) > (MAXPATHLEN - DBLEN - 1)) {
- LOG(log_error, logtype_default, "cnid_open: Pathname too large: %s", dir);
- return NULL;
- }
-
- if ((cdb = cnid_db3_new(dir)) == NULL) {
- LOG(log_error, logtype_default, "cnid_open: Unable to allocate memory for database");
- return NULL;
- }
-
- if ((db = (CNID_private *) calloc(1, sizeof(CNID_private))) == NULL) {
- LOG(log_error, logtype_default, "cnid_open: Unable to allocate memory for database");
- goto fail_cdb;
- }
-
- cdb->_private = (void *) db;
- db->magic = CNID_DB_MAGIC;
-
- strcpy(path, dir);
- if (path[len - 1] != '/') {
- strcat(path, "/");
- len++;
- }
-
- strcpy(path + len, DBHOME);
- if ((stat(path, &st) < 0) && (ad_mkdir(path, 0777 & ~mask) < 0)) {
- LOG(log_error, logtype_default, "cnid_open: DBHOME mkdir failed for %s", path);
- goto fail_adouble;
- }
-
- lock.l_type = F_WRLCK;
- lock.l_whence = SEEK_SET;
- /* Make sure cnid.lock goes in .AppleDB. */
- strcat(path, "/");
- len++;
-
- /* Search for a byte lock. This allows us to cleanup the log files
- * at cnid_close() in a clean fashion.
- *
- * NOTE: This won't work if multiple volumes for the same user refer
- * to the sahe directory. */
- strcat(path, DBLOCKFILE);
- strcpy(db->lock_file, path);
- if ((db->lockfd = open(path, O_RDWR | O_CREAT, 0666 & ~mask)) > -1) {
- lock.l_start = 0;
- lock.l_len = 1;
- while (fcntl(db->lockfd, F_SETLK, &lock) < 0) {
- if (++lock.l_start > MAXITER) {
- LOG(log_error, logtype_default,
- "cnid_open: Cannot establish logfile cleanup for database environment %s lock (lock failed)", path);
- close(db->lockfd);
- db->lockfd = -1;
- break;
- }
- }
- } else {
- LOG(log_error, logtype_default,
- "cnid_open: Cannot establish logfile cleanup lock for database environment %s (open() failed)", path);
- }
-
- path[len + DBHOMELEN] = '\0';
- open_flag = DB_CREATE;
-
- /* Print out the version of BDB we're linked against. */
- LOG(log_info, logtype_default, "CNID DB initializing using %s", db_version(NULL, NULL, NULL));
-
- /* We need to be able to open the database environment with full
- * transaction, logging, and locking support if we ever hope to
- * be a true multi-acess file server. */
- if ((rc = db_env_create(&db->dbenv, 0)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: db_env_create: %s", db_strerror(rc));
- goto fail_lock;
- }
-
- /* Setup internal deadlock detection. */
- if ((rc = db->dbenv->set_lk_detect(db->dbenv, DEAD_LOCK_DETECT)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: set_lk_detect: %s", db_strerror(rc));
- goto fail_lock;
- }
-
-#if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
-#if 0
- /* Take care of setting the DB_TXN_NOSYNC flag in db3 > 3.1.x. */
- if ((rc = db->dbenv->set_flags(db->dbenv, DB_TXN_NOSYNC, 1)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: set_flags: %s", db_strerror(rc));
- goto fail_lock;
- }
-#endif
-#endif /* DB_VERSION_MINOR > 1 */
-
- /* Open the database environment. */
- if ((rc = db->dbenv->open(db->dbenv, path, DBOPTIONS, 0666 & ~mask)) != 0) {
- if (rc == DB_RUNRECOVERY) {
- /* This is the mother of all errors. We _must_ fail here. */
- LOG(log_error, logtype_default,
- "cnid_open: CATASTROPHIC ERROR opening database environment %s. Run db_recovery -c immediately", path);
- goto fail_lock;
- }
-
- /* We can't get a full transactional environment, so multi-access
- * is out of the question. Let's assume a read-only environment,
- * and try to at least get a shared memory pool. */
- if ((rc = db->dbenv->open(db->dbenv, path, DB_INIT_MPOOL, 0666 & ~mask)) != 0) {
- /* Nope, not a MPOOL, either. Last-ditch effort: we'll try to
- * open the environment with no flags. */
- if ((rc = db->dbenv->open(db->dbenv, path, 0, 0666 & ~mask)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: dbenv->open of %s failed: %s", path, db_strerror(rc));
- goto fail_lock;
- }
- }
- db->flags |= CNIDFLAG_DB_RO;
- open_flag = DB_RDONLY;
- LOG(log_info, logtype_default, "cnid_open: Obtained read-only database environment %s", path);
- }
- /* did/name reverse mapping. We use a BTree for this one. */
- if ((rc = db_create(&db->db_didname, db->dbenv, 0)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: Failed to create did/name database: %s", db_strerror(rc));
- goto fail_appinit;
- }
-
- /*db->db_didname->set_bt_compare(db->db_didname, &compare_unix); */
- if ((rc = my_open(db->db_didname, DBDIDNAME, NULL, DB_BTREE, open_flag, 0666 & ~mask))) {
- LOG(log_error, logtype_default, "cnid_open: Failed to open did/name database: %s", db_strerror(rc));
- goto fail_appinit;
- }
-
- /* Check for version. This way we can update the database if we need
- * to change the format in any way. */
- memset(&key, 0, sizeof(key));
- memset(&data, 0, sizeof(data));
- key.data = DBVERSION_KEY;
- key.size = DBVERSION_KEYLEN;
-
- dbversion_retry:
- if ((rc = db3_txn_begin(db->dbenv, NULL, &tid, 0)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: txn_begin: failed to check db version: %s", db_strerror(rc));
- goto fail_appinit;
- }
-
- while ((rc = db->db_didname->get(db->db_didname, tid, &key, &data, DB_RMW))) {
- int ret;
-
- switch (rc) {
- case DB_LOCK_DEADLOCK:
- if ((ret = db3_txn_abort(tid)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: txn_abort: %s", db_strerror(ret));
- goto fail_appinit;
- }
- goto dbversion_retry;
- case DB_NOTFOUND:
- {
- u_int32_t version = htonl(DBVERSION);
-
- data.data = &version;
- data.size = sizeof(version);
- }
-
- if ((ret = db->db_didname->put(db->db_didname, tid, &key, &data, DB_NOOVERWRITE))) {
- if (ret == DB_LOCK_DEADLOCK) {
- if ((ret = db3_txn_abort(tid)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: txn_abort: %s", db_strerror(ret));
- goto fail_appinit;
- }
- goto dbversion_retry;
- } else if (ret == DB_RUNRECOVERY) {
- /* At this point, we don't care if the transaction aborts
- * successfully or not. */
- db3_txn_abort(tid);
- LOG(log_error, logtype_default, "cnid_open: Error putting new version: %s", db_strerror(ret));
- goto fail_appinit;
- }
- }
- break; /* while loop */
- default:
- db3_txn_abort(tid);
- LOG(log_error, logtype_default, "cnid_open: Failed to check db version: %s", db_strerror(rc));
- goto fail_appinit;
- }
- }
-
- if ((rc = db3_txn_commit(tid, 0)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: Failed to commit db version: %s", db_strerror(rc));
- goto fail_appinit;
- }
-
- /* TODO In the future we might check for version number here. */
-#if 0
- memcpy(&version, data.data, sizeof(version));
- if (version != ntohl(DBVERSION)) {
- /* Do stuff here. */
- }
-#endif /* 0 */
-
- /* dev/ino reverse mapping. Use a hash for this one. */
- if ((rc = db_create(&db->db_devino, db->dbenv, 0)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: Failed to create dev/ino database: %s", db_strerror(rc));
- goto fail_appinit;
- }
-
- if ((rc = my_open(db->db_devino, DBDEVINO, NULL, DB_BTREE, open_flag, 0666 & ~mask))) {
- LOG(log_error, logtype_default, "cnid_open: Failed to open devino database: %s", db_strerror(rc));
- goto fail_appinit;
- }
-
- /* Main CNID database. Use a hash for this one. */
- if ((rc = db_create(&db->db_cnid, db->dbenv, 0)) != 0) {
- LOG(log_error, logtype_default, "cnid_open: Failed to create cnid database: %s", db_strerror(rc));
- goto fail_appinit;
- }
-
- if ((rc = my_open(db->db_cnid, DBCNID, NULL, DB_BTREE, open_flag, 0666 & ~mask))) {
- LOG(log_error, logtype_default, "cnid_open: Failed to open dev/ino database: %s", db_strerror(rc));
- goto fail_appinit;
- }
-
-#if 0
- db_env_set_func_yield(my_yield);
-#endif
- return cdb;
-
- fail_appinit:
- if (db->db_didname)
- db->db_didname->close(db->db_didname, 0);
- if (db->db_devino)
- db->db_devino->close(db->db_devino, 0);
- if (db->db_cnid)
- db->db_cnid->close(db->db_cnid, 0);
- LOG(log_error, logtype_default, "cnid_open: Failed to setup CNID DB environment");
- db->dbenv->close(db->dbenv, 0);
-
- fail_lock:
- if (db->lockfd > -1) {
- close(db->lockfd);
- (void) remove(db->lock_file);
- }
-
- fail_adouble:
-
- free(db);
-
- fail_cdb:
- if (cdb->volpath != NULL)
- free(cdb->volpath);
- free(cdb);
-
- return NULL;
-}
-
-struct _cnid_module cnid_db3_module = {
- "db3",
- {NULL, NULL},
- cnid_db3_open,
- CNID_FLAG_BLOCK
-};
-
-#endif /* CNID_BACKEND_DB3 */