2 * $Id: cnid_open.c,v 1.49 2003-01-04 21:41:49 jmarcus Exp $
4 * Copyright (c) 1999. Adrian Sun (asun@zoology.washington.edu)
5 * All Rights Reserved. See COPYRIGHT.
7 * CNID database support.
10 * 1) afpd already caches did's.
11 * 2) the database stores cnid's as both did/name and dev/ino pairs.
12 * 3) RootInfo holds the value of the NextID.
13 * 4) the cnid database gets called in the following manner --
15 * cnid = cnid_open(root_dir);
18 * newid = cnid_add(cnid, dev, ino, parent did,
19 * name, id); id is a hint for a specific id. pass 0 if you don't
20 * care. if the id is already assigned, you won't get what you
23 * given an id, get a did/name and dev/ino pair.
24 * name = cnid_get(cnid, &id); given an id, return the corresponding
26 * return code = cnid_delete(cnid, id); delete an entry.
28 * with AFP, CNIDs 0-2 have special meanings. here they are:
30 * 1 -- parent of root directory (handled by afpd)
31 * 2 -- root directory (handled by afpd)
33 * CNIDs 4-16 are reserved according to page 31 of the AFP 3.0 spec so,
34 * CNID_START begins at 17.
39 #endif /* HAVE_CONFIG_H */
47 #endif /* HAVE_UNISTD_H */
50 #endif /* HAVE_FCNTL_H */
51 #include <sys/param.h>
53 #include <atalk/logger.h>
54 #ifdef HAVE_SYS_TIME_H
56 #endif /* HAVE_SYS_TIME_H */
60 #include <atalk/adouble.h>
61 #include <atalk/cnid.h>
62 #include <atalk/util.h>
64 #include "cnid_private.h"
67 #define MIN(a, b) ((a) < (b) ? (a) : (b))
70 #define DBHOME ".AppleDB"
71 #define DBCNID "cnid.db"
72 #define DBDEVINO "devino.db"
73 #define DBDIDNAME "didname.db" /* did/full name mapping */
74 #define DBSHORTNAME "shortname.db" /* did/8+3 mapping */
75 #define DBMACNAME "macname.db" /* did/31 mapping */
76 #define DBMANGLE "mangle.db" /* filename mangling */
77 #define DBLONGNAME "longname.db" /* did/unicode mapping */
78 #define DBLOCKFILE "cnid.lock"
79 #define DBRECOVERFILE "cnid.dbrecover"
80 #define DBCLOSEFILE "cnid.close"
85 /* we version the did/name database so that we can change the format
86 * if necessary. the key is in the form of a did/name pair. in this case,
88 #define DBVERSION_KEY "\0\0\0\0\0"
89 #define DBVERSION_KEYLEN 5
90 #define DBVERSION1 0x00000001U
91 #define DBVERSION DBVERSION1
94 #define DBOPTIONS (DB_CREATE | DB_INIT_CDB | DB_INIT_MPOOL)
95 #else /* !CNID_DB_CDB */
96 #if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
97 #define DBOPTIONS (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
98 DB_INIT_LOG | DB_INIT_TXN)
99 #else /* DB_VERSION_MINOR < 1 */
100 /*#define DBOPTIONS (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
101 DB_INIT_LOG | DB_INIT_TXN | DB_TXN_NOSYNC)*/
102 #define DBOPTIONS (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
103 DB_INIT_LOG | DB_INIT_TXN)
104 #endif /* DB_VERSION_MINOR */
105 #endif /* CNID_DB_CDB */
108 /* Let's try and use the youngest lock detector if present.
109 * If we can't do that, then let BDB use its default deadlock detector. */
110 #if defined DB_LOCK_YOUNGEST
111 #define DEAD_LOCK_DETECT DB_LOCK_YOUNGEST
112 #else /* DB_LOCK_YOUNGEST */
113 #define DEAD_LOCK_DETECT DB_LOCK_DEFAULT
114 #endif /* DB_LOCK_YOUNGEST */
115 #endif /* CNID_DB_CDB */
117 #define MAXITER 0xFFFF /* maximum number of simultaneously open CNID
120 /* the first compare that's always done. */
121 static __inline__ int compare_did(const DBT *a, const DBT *b)
123 u_int32_t dida, didb;
125 memcpy(&dida, a->data, sizeof(dida));
126 memcpy(&didb, b->data, sizeof(didb));
130 /* sort did's and then names. this is for unix paths.
131 * i.e., did/unixname lookups. */
132 #if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
133 static int compare_unix(DB *db, const DBT *a, const DBT *b)
134 #else /* DB_VERSION_MINOR < 1 */
135 static int compare_unix(const DBT *a, const DBT *b)
136 #endif /* DB_VERSION_MINOR */
142 if ((ret = compare_did(a, b)))
145 sa = (u_int8_t *) a->data + 4; /* shift past did */
146 sb = (u_int8_t *) b->data + 4;
147 for (len = MIN(a->size, b->size); len-- > 4; sa++, sb++)
148 if ((ret = (*sa - *sb)))
149 return ret; /* sort by lexical ordering */
151 return a->size - b->size; /* sort by length */
154 /* sort did's and then names. this is for macified paths (i.e.,
155 * did/macname, and did/shortname. i think did/longname needs a
156 * unicode table to work. also, we can't use strdiacasecmp as that
157 * returns a match if a < b. */
158 #if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
159 static int compare_mac(DB *db, const DBT *a, const DBT *b)
160 #else /* DB_VERSION_MINOR < 1 */
161 static int compare_mac(const DBT *a, const DBT *b)
162 #endif /* DB_VERSION_MINOR */
168 if ((ret = compare_did(a, b)))
171 sa = (u_int8_t *) a->data + 4;
172 sb = (u_int8_t *) b->data + 4;
173 for (len = MIN(a->size, b->size); len-- > 4; sa++, sb++)
174 if ((ret = (_diacasemap[*sa] - _diacasemap[*sb])))
175 return ret; /* sort by lexical ordering */
177 return a->size - b->size; /* sort by length */
181 /* for unicode names -- right now it's the same as compare_mac. */
182 #if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
183 static int compare_unicode(DB *db, const DBT *a, const DBT *b)
184 #else /* DB_VERSION_MINOR < 1 */
185 static int compare_unicode(const DBT *a, const DBT *b)
186 #endif /* DB_VERSION_MINOR */
188 #if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
189 return compare_mac(db,a,b);
190 #else /* DB_VERSION_MINOR < 1 */
191 return compare_mac(a,b);
192 #endif /* DB_VERSION_MINOR */
195 void *cnid_open(const char *dir, mode_t mask) {
199 #endif /* CNID_DB_CDB */
200 char path[MAXPATHLEN + 1];
211 /* this checks .AppleDB */
212 if ((len = strlen(dir)) > (MAXPATHLEN - DBLEN - 1)) {
213 LOG(log_error, logtype_default, "cnid_open: Pathname too large: %s", dir);
217 if ((db = (CNID_private *)calloc(1, sizeof(CNID_private))) == NULL) {
218 LOG(log_error, logtype_default, "cnid_open: Unable to allocate memory for database");
222 db->magic = CNID_DB_MAGIC;
225 if (path[len - 1] != '/') {
230 strcpy(path + len, DBHOME);
231 if ((stat(path, &st) < 0) && (ad_mkdir(path, 0777 & ~mask) < 0)) {
232 LOG(log_error, logtype_default, "cnid_open: DBHOME mkdir failed for %s", path);
237 lock.l_type = F_WRLCK;
238 lock.l_whence = SEEK_SET;
239 /* Make sure cnid.lock goes in .AppleDB. */
243 /* Search for a byte lock. This allows us to cleanup the log files
244 * at cnid_close() in a clean fashion.
246 * NOTE: This won't work if multiple volumes for the same user refer
247 * to the sahe directory. */
248 strcat(path, DBLOCKFILE);
249 strcpy(db->lock_file, path);
250 if ((db->lockfd = open(path, O_RDWR | O_CREAT, 0666 & ~mask)) > -1) {
253 while (fcntl(db->lockfd, F_SETLK, &lock) < 0) {
254 if (++lock.l_start > MAXITER) {
255 LOG(log_error, logtype_default, "cnid_open: Cannot establish logfile cleanup for database environment %s lock (lock failed)", path);
263 LOG(log_error, logtype_default, "cnid_open: Cannot establish logfile cleanup lock for database environment %s (open() failed)", path);
265 #endif /* CNID_DB_CDB */
267 path[len + DBHOMELEN] = '\0';
268 open_flag = DB_CREATE;
270 /* We need to be able to open the database environment with full
271 * transaction, logging, and locking support if we ever hope to
272 * be a true multi-acess file server. */
273 if ((rc = db_env_create(&db->dbenv, 0)) != 0) {
274 LOG(log_error, logtype_default, "cnid_open: db_env_create: %s", db_strerror(rc));
279 /* Setup internal deadlock detection. */
280 if ((rc = db->dbenv->set_lk_detect(db->dbenv, DEAD_LOCK_DETECT)) != 0) {
281 LOG(log_error, logtype_default, "cnid_open: set_lk_detect: %s", db_strerror(rc));
284 #endif /* CNID_DB_CDB */
287 #if DB_VERSION_MAJOR >= 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR > 1)
289 /* Take care of setting the DB_TXN_NOSYNC flag in db3 > 3.1.x. */
290 if ((rc = db->dbenv->set_flags(db->dbenv, DB_TXN_NOSYNC, 1)) != 0) {
291 LOG(log_error, logtype_default, "cnid_open: set_flags: %s", db_strerror(rc));
295 #endif /* DB_VERSION_MINOR > 1 */
296 #endif /* CNID_DB_CDB */
298 /* Open the database environment. */
299 if ((rc = db->dbenv->open(db->dbenv, path, DBOPTIONS, 0666 & ~mask)) != 0) {
300 if (rc == DB_RUNRECOVERY) {
301 /* This is the mother of all errors. We _must_ fail here. */
302 LOG(log_error, logtype_default, "cnid_open: CATASTROPHIC ERROR opening database environment %s. Run db_recovery -c immediately", path);
306 /* We can't get a full transactional environment, so multi-access
307 * is out of the question. Let's assume a read-only environment,
308 * and try to at least get a shared memory pool. */
309 if ((rc = db->dbenv->open(db->dbenv, path, DB_INIT_MPOOL, 0666 & ~mask)) != 0) {
310 /* Nope, not a MPOOL, either. Last-ditch effort: we'll try to
311 * open the environment with no flags. */
312 if ((rc = db->dbenv->open(db->dbenv, path, 0, 0666 & ~mask)) != 0) {
313 LOG(log_error, logtype_default, "cnid_open: dbenv->open of %s failed: %s",
314 path, db_strerror(rc));
318 db->flags |= CNIDFLAG_DB_RO;
319 open_flag = DB_RDONLY;
320 LOG(log_info, logtype_default, "cnid_open: Obtained read-only database environment %s", path);
323 /* did/name reverse mapping. We use a BTree for this one. */
324 if ((rc = db_create(&db->db_didname, db->dbenv, 0)) != 0) {
325 LOG(log_error, logtype_default, "cnid_open: Failed to create did/name database: %s",
330 /*db->db_didname->set_bt_compare(db->db_didname, &compare_unix);*/
331 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 1)
332 if ((rc = db->db_didname->open(db->db_didname, NULL, DBDIDNAME, NULL,
333 DB_HASH, open_flag | DB_AUTO_COMMIT, 0666 & ~mask))) {
335 if ((rc = db->db_didname->open(db->db_didname, DBDIDNAME, NULL,
336 DB_HASH, open_flag, 0666 & ~mask))) {
337 #endif /* DB_VERSION_MAJOR >= 4 */
338 LOG(log_error, logtype_default, "cnid_open: Failed to open did/name database: %s",
343 /* Check for version. This way we can update the database if we need
344 * to change the format in any way. */
345 memset(&key, 0, sizeof(key));
346 memset(&data, 0, sizeof(data));
347 key.data = DBVERSION_KEY;
348 key.size = DBVERSION_KEYLEN;
351 if ((rc = db->db_didname->get(db->db_didname, NULL, &key, &data, 0)) != 0) {
354 u_int32_t version = htonl(DBVERSION);
356 data.data = &version;
357 data.size = sizeof(version);
359 if ((ret = db->db_didname->put(db->db_didname, NULL, &key, &data,
361 LOG(log_error, logtype_default, "cnid_open: Error putting new version: %s",
363 db->db_didname->close(db->db_didname, 0);
367 #else /* CNID_DB_CDB */
369 if ((rc = txn_begin(db->dbenv, NULL, &tid, 0)) != 0) {
370 LOG(log_error, logtype_default, "cnid_open: txn_begin: failed to check db version: %s",
372 db->db_didname->close(db->db_didname, 0);
376 while ((rc = db->db_didname->get(db->db_didname, tid, &key, &data, DB_RMW))) {
379 case DB_LOCK_DEADLOCK:
380 if ((ret = txn_abort(tid)) != 0) {
381 LOG(log_error, logtype_default, "cnid_open: txn_abort: %s", db_strerror(ret));
382 db->db_didname->close(db->db_didname, 0);
385 goto dbversion_retry;
388 u_int32_t version = htonl(DBVERSION);
390 data.data = &version;
391 data.size = sizeof(version);
394 if ((ret = db->db_didname->put(db->db_didname, tid, &key, &data,
396 if (ret == DB_LOCK_DEADLOCK) {
397 if ((ret = txn_abort(tid)) != 0) {
398 LOG(log_error, logtype_default, "cnid_open: txn_abort: %s",
400 db->db_didname->close(db->db_didname, 0);
403 goto dbversion_retry;
405 else if (ret == DB_RUNRECOVERY) {
406 /* At this point, we don't care if the transaction aborts
407 * successfully or not. */
409 LOG(log_error, logtype_default, "cnid_open: Error putting new version: %s",
411 db->db_didname->close(db->db_didname, 0);
415 break; /* while loop */
418 LOG(log_error, logtype_default, "cnid_open: Failed to check db version: %s",
420 db->db_didname->close(db->db_didname, 0);
425 if ((rc = txn_commit(tid, 0)) != 0) {
426 LOG(log_error, logtype_default, "cnid_open: Failed to commit db version: %s",
428 db->db_didname->close(db->db_didname, 0);
431 #endif /* CNID_DB_CDB */
433 /* TODO In the future we might check for version number here. */
435 memcpy(&version, data.data, sizeof(version));
436 if (version != ntohl(DBVERSION)) {
442 /* did/macname (31 character) mapping. Use a BTree for this one. */
443 if ((rc = db_create(&db->db_macname, db->dbenv, 0)) != 0) {
444 LOG(log_error, logtype_default, "cnid_open: Failed to create did/macname database: %s",
446 db->db_didname->close(db->db_didname, 0);
450 db->db_macname->set_bt_compare(db->db_macname, &compare_mac);
451 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 1)
452 if ((rc = db->db_macname->open(db->db_macname, NULL, DBMACNAME, NULL, DB_BTREE, open_flag | DB_AUTO_COMMIT, 0666 & ~mask)) != 0) {
454 if ((rc = db->db_macname->open(db->db_macname, DBMACNAME, NULL, DB_BTREE, open_flag, 0666 & ~mask)) != 0) {
455 #endif /* DB_VERSION_MAJOR >= 4 */
456 LOG(log_error, logtype_default, "cnid_open: Failed to open did/macname database: %s",
458 db->db_didname->close(db->db_didname, 0);
462 /* did/shortname (DOS 8.3) mapping. Use a BTree for this one. */
463 if ((rc = db_create(&db->db_shortname, db->dbenv, 0)) != 0) {
464 LOG(log_error, logtype_default, "cnid_open: Failed to create did/shortname database: %s",
466 db->db_didname->close(db->db_didname, 0);
467 db->db_macname->close(db->db_macname, 0);
471 db->db_shortname->set_bt_compare(db->db_shortname, &compare_mac);
472 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 1)
473 if ((rc = db->db_shortname->open(db->db_shortname, NULL, DBSHORTNAME, NULL, DB_BTREE, open_flag | DB_AUTO_COMMIT, 0666 & ~mask)) != 0) {
475 if ((rc = db->db_shortname->open(db->db_shortname, DBSHORTNAME, NULL, DB_BTREE, open_flag, 0666 & ~mask)) != 0) {
476 #endif /* DB_VERSION_MAJOR >= 4 */
477 LOG(log_error, logtype_default, "cnid_open: Failed to open did/shortname database: %s",
479 db->db_didname->close(db->db_didname, 0);
480 db->db_macname->close(db->db_macname, 0);
484 /* did/longname (Unicode) mapping. Use a BTree for this one. */
485 if ((rc = db_create(&db->db_longname, db->dbenv, 0)) != 0) {
486 LOG(log_error, logtype_default, "cnid_open: Failed to create did/longname database: %s",
488 db->db_didname->close(db->db_didname, 0);
489 db->db_macname->close(db->db_macname, 0);
490 db->db_shortname->close(db->db_shortname, 0);
494 db->db_longname->set_bt_compare(db->db_longname, &compare_unicode);
495 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 1)
496 if ((rc = db->db_longname->open(db->db_longname, NULL, DBLONGNAME, NULL, DB_BTREE, open_flag | DB_AUTO_COMMIT, 0666 & ~mask)) != 0) {
498 if ((rc = db->db_longname->open(db->db_longname, DBLONGNAME, NULL, DB_BTREE, open_flag, 0666 & ~mask)) != 0) {
499 #endif /* DB_VERSION_MAJOR >= 4 */
500 LOG(log_error, logtype_default, "cnid_open: Failed to open did/longname database: %s",
502 db->db_didname->close(db->db_didname, 0);
503 db->db_macname->close(db->db_macname, 0);
504 db->db_shortname->close(db->db_shortname, 0);
507 #endif /* EXTENDED_DB */
509 /* dev/ino reverse mapping. Use a hash for this one. */
510 if ((rc = db_create(&db->db_devino, db->dbenv, 0)) != 0) {
511 LOG(log_error, logtype_default, "cnid_open: Failed to create dev/ino database: %s",
513 db->db_didname->close(db->db_didname, 0);
515 db->db_macname->close(db->db_macname, 0);
516 db->db_shortname->close(db->db_shortname, 0);
517 db->db_longname->close(db->db_longname, 0);
518 #endif /* EXTENDED_DB */
522 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 1)
523 if ((rc = db->db_devino->open(db->db_devino, NULL, DBDEVINO, NULL, DB_HASH, open_flag | DB_AUTO_COMMIT, 0666 & ~mask)) != 0) {
525 if ((rc = db->db_devino->open(db->db_devino, DBDEVINO, NULL, DB_HASH, open_flag, 0666 & ~mask)) != 0) {
526 #endif /* DB_VERSION_MAJOR >= 4 */
527 LOG(log_error, logtype_default, "cnid_open: Failed to open devino database: %s",
529 db->db_didname->close(db->db_didname, 0);
531 db->db_macname->close(db->db_macname, 0);
532 db->db_shortname->close(db->db_shortname, 0);
533 db->db_longname->close(db->db_longname, 0);
534 #endif /* EXTENDED_DB */
538 /* Main CNID database. Use a hash for this one. */
539 if ((rc = db_create(&db->db_cnid, db->dbenv, 0)) != 0) {
540 LOG(log_error, logtype_default, "cnid_open: Failed to create cnid database: %s",
542 db->db_didname->close(db->db_didname, 0);
544 db->db_macname->close(db->db_macname, 0);
545 db->db_shortname->close(db->db_shortname, 0);
546 db->db_longname->close(db->db_longname, 0);
547 #endif /* EXTENDED_DB */
548 db->db_devino->close(db->db_devino, 0);
553 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 1)
554 if ((rc = db->db_cnid->open(db->db_cnid, NULL, DBCNID, NULL, DB_HASH, open_flag | DB_AUTO_COMMIT, 0666 & ~mask)) != 0) {
556 if ((rc = db->db_cnid->open(db->db_cnid, DBCNID, NULL, DB_HASH, open_flag, 0666 & ~mask)) != 0) {
557 #endif /* DB_VERSION_MAJOR >= 4 */
558 LOG(log_error, logtype_default, "cnid_open: Failed to open dev/ino database: %s",
560 db->db_didname->close(db->db_didname, 0);
562 db->db_macname->close(db->db_macname, 0);
563 db->db_shortname->close(db->db_shortname, 0);
564 db->db_longname->close(db->db_longname, 0);
565 #endif /* EXTENDED_DB */
566 db->db_devino->close(db->db_devino, 0);
571 /* filename mangling database. Use a hash for this one. */
572 if ((rc = db_create(&db->db_mangle, db->dbenv, 0)) != 0) {
573 LOG(log_error, logtype_default, "cnid_open: Failed to create mangle database: %s", db_strerror(rc));
574 db->db_didname->close(db->db_didname, 0);
575 db->db_devino->close(db->db_devino, 0);
576 db->db_cnid->close(db->db_cnid, 0);
578 db->db_macname->close(db->db_macname, 0);
579 db->db_shortname->close(db->db_shortname, 0);
580 db->db_longname->close(db->db_longname, 0);
581 #endif /* EXTENDED_DB */
585 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 1)
586 if ((rc = db->db_mangle->open(db->db_mangle, NULL, DBMANGLE, NULL, DB_HASH, open_flag | DB_AUTO_COMMIT, 0666 & ~mask)) != 0) {
588 if ((rc = db->db_mangle->open(db->db_mangle, DBMANGLE, NULL, DB_HASH, open_flag, 0666 & ~mask)) != 0) {
589 #endif /* DB_VERSION_MAJOR >= 4 */
590 LOG(log_error, logtype_default, "cnid_open: Failed to open mangle database: %s", db_strerror(rc));
591 db->db_didname->close(db->db_didname, 0);
592 db->db_devino->close(db->db_devino, 0);
593 db->db_cnid->close(db->db_cnid, 0);
595 db->db_macname->close(db->db_macname, 0);
596 db->db_shortname->close(db->db_shortname, 0);
597 db->db_longname->close(db->db_longname, 0);
598 #endif /* EXTENDED_DB */
601 #endif /* FILE_MANGLING */
603 /* Print out the version of BDB we're linked against. */
604 LOG(log_info, logtype_default, "CNID DB initialized using %s",
605 db_version(NULL, NULL, NULL));
610 LOG(log_error, logtype_default, "cnid_open: Failed to setup CNID DB environment");
611 db->dbenv->close(db->dbenv, 0);
615 if (db->lockfd > -1) {
617 (void)remove(db->lock_file);
619 #endif /* CNID_DB_CDB */