2 * $Id: cnid_open.c,v 1.35 2002-01-23 02:31:32 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 DBLONGNAME "longname.db" /* did/unicode mapping */
77 #define DBLOCKFILE "cnid.lock"
78 #define DBRECOVERFILE "cnid.dbrecover"
79 #define DBCLOSEFILE "cnid.close"
84 /* we version the did/name database so that we can change the format
85 * if necessary. the key is in the form of a did/name pair. in this case,
87 #define DBVERSION_KEY "\0\0\0\0\0"
88 #define DBVERSION_KEYLEN 5
89 #define DBVERSION1 0x00000001U
90 #define DBVERSION DBVERSION1
92 #if DB_VERSION_MINOR > 1
93 #define DBOPTIONS (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
94 DB_INIT_LOG | DB_INIT_TXN)
95 #else /* DB_VERSION_MINOR < 1 */
96 /*#define DBOPTIONS (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
97 DB_INIT_LOG | DB_INIT_TXN | DB_TXN_NOSYNC)*/
98 #define DBOPTIONS (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
99 DB_INIT_LOG | DB_INIT_TXN)
100 #endif /* DB_VERSION_MINOR */
102 /* Let's try and use the youngest lock detector if present.
103 * If we can't do that, then let DB3 use its default deadlock detector. */
104 #if defined DB_LOCK_YOUNGEST
105 #define DEAD_LOCK_DETECT DB_LOCK_YOUNGEST
106 #else /* DB_LOCK_YOUNGEST */
107 #define DEAD_LOCK_DETECT DB_LOCK_DEFAULT
108 #endif /* DB_LOCK_YOUNGEST */
110 #define MAXITER 0xFFFF /* maximum number of simultaneously open CNID
113 /* the first compare that's always done. */
114 static __inline__ int compare_did(const DBT *a, const DBT *b)
116 u_int32_t dida, didb;
118 memcpy(&dida, a->data, sizeof(dida));
119 memcpy(&didb, b->data, sizeof(didb));
123 /* sort did's and then names. this is for unix paths.
124 * i.e., did/unixname lookups. */
125 #if DB_VERSION_MINOR > 1
126 static int compare_unix(DB *db, const DBT *a, const DBT *b)
127 #else /* DB_VERSION_MINOR < 1 */
128 static int compare_unix(const DBT *a, const DBT *b)
129 #endif /* DB_VERSION_MINOR */
135 if ((ret = compare_did(a, b)))
138 sa = (u_int8_t *) a->data + 4; /* shift past did */
139 sb = (u_int8_t *) b->data + 4;
140 for (len = MIN(a->size, b->size); len-- > 4; sa++, sb++)
141 if ((ret = (*sa - *sb)))
142 return ret; /* sort by lexical ordering */
144 return a->size - b->size; /* sort by length */
147 /* sort did's and then names. this is for macified paths (i.e.,
148 * did/macname, and did/shortname. i think did/longname needs a
149 * unicode table to work. also, we can't use strdiacasecmp as that
150 * returns a match if a < b. */
151 #if DB_VERSION_MINOR > 1
152 static int compare_mac(DB *db, const DBT *a, const DBT *b)
153 #else /* DB_VERSION_MINOR < 1 */
154 static int compare_mac(const DBT *a, const DBT *b)
155 #endif /* DB_VERSION_MINOR */
161 if ((ret = compare_did(a, b)))
164 sa = (u_int8_t *) a->data + 4;
165 sb = (u_int8_t *) b->data + 4;
166 for (len = MIN(a->size, b->size); len-- > 4; sa++, sb++)
167 if ((ret = (_diacasemap[*sa] - _diacasemap[*sb])))
168 return ret; /* sort by lexical ordering */
170 return a->size - b->size; /* sort by length */
174 /* for unicode names -- right now it's the same as compare_mac. */
175 #if DB_VERSION_MINOR > 1
176 static int compare_unicode(DB *db, const DBT *a, const DBT *b)
177 #else /* DB_VERSION_MINOR < 1 */
178 static int compare_unicode(const DBT *a, const DBT *b)
179 #endif /* DB_VERSION_MINOR */
181 #if DB_VERSION_MINOR > 1
182 return compare_mac(db,a,b);
183 #else /* DB_VERSION_MINOR < 1 */
184 return compare_mac(a,b);
185 #endif /* DB_VERSION_MINOR */
188 static int have_lock = 0;
190 void *cnid_open(const char *dir) {
191 struct stat st, rsb, csb;
193 char path[MAXPATHLEN + 1];
194 char recover_file[MAXPATHLEN + 1];
198 u_int32_t DBEXTRAS = 0;
206 /* this checks .AppleDB */
207 if ((len = strlen(dir)) > (MAXPATHLEN - DBLEN - 1)) {
208 LOG(log_error, logtype_default, "cnid_open: Pathname too large: %s", dir);
212 if ((db = (CNID_private *)calloc(1, sizeof(CNID_private))) == NULL) {
213 LOG(log_error, logtype_default, "cnid_open: Unable to allocate memory for database");
217 db->magic = CNID_DB_MAGIC;
220 if (path[len - 1] != '/') {
225 lock.l_type = F_WRLCK;
226 lock.l_whence = SEEK_SET;
228 strcpy(path + len, DBHOME);
229 if ((stat(path, &st) < 0) && (ad_mkdir(path, 0777) < 0)) {
230 LOG(log_error, logtype_default, "cnid_open: DBHOME mkdir failed for %s", path);
234 /* Make sure cnid.lock goes in .AppleDB. */
238 strcpy(db->close_file, path);
239 strcat(db->close_file, DBCLOSEFILE);
241 /* Check to make sure that a client isn't in the process of closing
242 * the database environment. To do this, select on the close file. */
243 while(stat(db->close_file, &csb) == 0) {
247 (void)select(0, NULL, NULL, NULL, &ct);
250 strcpy(recover_file, path);
251 strcat(recover_file, DBRECOVERFILE);
253 /* Search for a byte lock. This allows us to cleanup the log files
254 * at cnid_close() in a clean fashion.
256 * NOTE: This won't work if multiple volumes for the same user refer
257 * to the sahe directory. */
258 strcat(path, DBLOCKFILE);
259 if ((db->lockfd = open(path, O_RDWR | O_CREAT, 0666)) > -1) {
262 while (fcntl(db->lockfd, F_SETLK, &lock) < 0) {
263 if (++lock.l_start > MAXITER) {
264 LOG(log_error, logtype_default, "cnid_open: Cannot establish logfile cleanup for database environment %s lock (lock failed)", path);
272 LOG(log_error, logtype_default, "cnid_open: Cannot establish logfile cleanup lock for database environment %s (open() failed)", path);
275 /* Create a file to represent database recovery. While this file
276 * exists, the database is being recovered, and all other clients will
277 * select until recovery is complete, and this file goes away. */
278 if (!have_lock && db->lockfd > -1 && lock.l_start == 0) {
279 if (stat(recover_file, &rsb) == 0) {
280 (void)remove(recover_file);
282 if ((rfd = open(recover_file, O_RDWR | O_CREAT, 0666)) > -1) {
283 DBEXTRAS |= DB_RECOVER;
287 else if (!have_lock) {
288 while (stat(recover_file, &rsb) == 0) {
292 (void)select(0, NULL, NULL, NULL, &rt);
296 path[len + DBHOMELEN] = '\0';
297 open_flag = DB_CREATE;
299 /* We need to be able to open the database environment with full
300 * transaction, logging, and locking support if we ever hope to
301 * be a true multi-acess file server. */
302 if ((rc = db_env_create(&db->dbenv, 0)) != 0) {
303 LOG(log_error, logtype_default, "cnid_open: db_env_create: %s", db_strerror(rc));
307 /* Setup internal deadlock detection. */
308 if ((rc = db->dbenv->set_lk_detect(db->dbenv, DEAD_LOCK_DETECT)) != 0) {
309 LOG(log_error, logtype_default, "cnid_open: set_lk_detect: %s", db_strerror(rc));
313 #if DB_VERSION_MINOR > 1
315 /* Take care of setting the DB_TXN_NOSYNC flag in db3 > 3.1.x. */
316 if ((rc = db->dbenv->set_flags(db->dbenv, DB_TXN_NOSYNC, 1)) != 0) {
317 LOG(log_error, logtype_default, "cnid_open: set_flags: %s", db_strerror(rc));
321 #endif /* DB_VERSION_MINOR > 1 */
323 /* Open the database environment. */
324 if ((rc = db->dbenv->open(db->dbenv, path, DBOPTIONS | DBEXTRAS, 0666)) != 0) {
325 if (rc == DB_RUNRECOVERY) {
326 /* This is the mother of all errors. We _must_ fail here. */
327 LOG(log_error, logtype_default, "cnid_open: CATASTROPHIC ERROR opening database environment %s. Run db_recovery -c immediately", path);
331 /* We can't get a full transactional environment, so multi-access
332 * is out of the question. Let's assume a read-only environment,
333 * and try to at least get a shared memory pool. */
334 if ((rc = db->dbenv->open(db->dbenv, path, DB_INIT_MPOOL, 0666)) != 0) {
335 /* Nope, not a MPOOL, either. Last-ditch effort: we'll try to
336 * open the environment with no flags. */
337 if ((rc = db->dbenv->open(db->dbenv, path, 0, 0666)) != 0) {
338 LOG(log_error, logtype_default, "cnid_open: dbenv->open of %s failed: %s",
339 path, db_strerror(rc));
343 db->flags |= CNIDFLAG_DB_RO;
344 open_flag = DB_RDONLY;
345 LOG(log_info, logtype_default, "cnid_open: Obtained read-only database environment %s", path);
348 /* If we have the recovery lock, close the file, remove it, so other
349 * clients can proceed opening the DB environment. */
351 (void)remove(recover_file);
357 LOG(log_error, logtype_default, "cnid_open: Unable to remove %s: %s",
358 recover_file, strerror(errno));
364 /* did/name reverse mapping. We use a BTree for this one. */
365 if ((rc = db_create(&db->db_didname, db->dbenv, 0)) != 0) {
366 LOG(log_error, logtype_default, "cnid_open: Failed to create did/name database: %s",
371 /*db->db_didname->set_bt_compare(db->db_didname, &compare_unix);*/
372 if ((rc = db->db_didname->open(db->db_didname, DBDIDNAME, NULL,
373 DB_HASH, open_flag, 0666))) {
374 LOG(log_error, logtype_default, "cnid_open: Failed to open did/name database: %s",
379 /* Check for version. This way we can update the database if we need
380 * to change the format in any way. */
381 memset(&key, 0, sizeof(key));
382 memset(&data, 0, sizeof(data));
383 key.data = DBVERSION_KEY;
384 key.size = DBVERSION_KEYLEN;
387 if ((rc = txn_begin(db->dbenv, NULL, &tid, 0)) != 0) {
388 LOG(log_error, logtype_default, "cnid_open: txn_begin: failed to check db version: %s",
390 db->db_didname->close(db->db_didname, 0);
394 while ((rc = db->db_didname->get(db->db_didname, tid, &key, &data, DB_RMW))) {
397 case DB_LOCK_DEADLOCK:
398 if ((ret = txn_abort(tid)) != 0) {
399 LOG(log_error, logtype_default, "cnid_open: txn_abort: %s", db_strerror(ret));
400 db->db_didname->close(db->db_didname, 0);
403 goto dbversion_retry;
406 u_int32_t version = htonl(DBVERSION);
408 data.data = &version;
409 data.size = sizeof(version);
412 if ((ret = db->db_didname->put(db->db_didname, tid, &key, &data,
414 if (ret == DB_LOCK_DEADLOCK) {
415 if ((ret = txn_abort(tid)) != 0) {
416 LOG(log_error, logtype_default, "cnid_open: txn_abort: %s",
418 db->db_didname->close(db->db_didname, 0);
421 goto dbversion_retry;
423 else if (ret == DB_RUNRECOVERY) {
424 /* At this point, we don't care if the transaction aborts
425 * successfully or not. */
427 LOG(log_error, logtype_default, "cnid_open: Error putting new version: %s",
429 db->db_didname->close(db->db_didname, 0);
433 break; /* while loop */
436 LOG(log_error, logtype_default, "cnid_open: Failed to check db version: %s",
438 db->db_didname->close(db->db_didname, 0);
443 if ((rc = txn_commit(tid, 0)) != 0) {
444 LOG(log_error, logtype_default, "cnid_open: Failed to commit db version: %s",
446 db->db_didname->close(db->db_didname, 0);
450 /* TODO In the future we might check for version number here. */
452 memcpy(&version, data.data, sizeof(version));
453 if (version != ntohl(DBVERSION)) {
459 /* did/macname (31 character) mapping. Use a BTree for this one. */
460 if ((rc = db_create(&db->db_macname, db->dbenv, 0)) != 0) {
461 LOG(log_error, logtype_default, "cnid_open: Failed to create did/macname database: %s",
463 db->db_didname->close(db->db_didname, 0);
467 db->db_macname->set_bt_compare(db->db_macname, &compare_mac);
468 if ((rc = db->db_macname->open(db->db_macname, DBMACNAME, NULL, DB_BTREE, open_flag, 0666)) != 0) {
469 LOG(log_error, logtype_default, "cnid_open: Failed to open did/macname database: %s",
471 db->db_didname->close(db->db_didname, 0);
475 /* did/shortname (DOS 8.3) mapping. Use a BTree for this one. */
476 if ((rc = db_create(&db->db_shortname, db->dbenv, 0)) != 0) {
477 LOG(log_error, logtype_default, "cnid_open: Failed to create did/shortname database: %s",
479 db->db_didname->close(db->db_didname, 0);
480 db->db_macname->close(db->db_macname, 0);
484 db->db_shortname->set_bt_compare(db->db_shortname, &compare_mac);
485 if ((rc = db->db_shortname->open(db->db_shortname, DBSHORTNAME, NULL, DB_BTREE, open_flag, 0666)) != 0) {
486 LOG(log_error, logtype_default, "cnid_open: Failed to open did/shortname database: %s",
488 db->db_didname->close(db->db_didname, 0);
489 db->db_macname->close(db->db_macname, 0);
493 /* did/longname (Unicode) mapping. Use a BTree for this one. */
494 if ((rc = db_create(&db->db_longname, db->dbenv, 0)) != 0) {
495 LOG(log_error, logtype_default, "cnid_open: Failed to create did/longname database: %s",
497 db->db_didname->close(db->db_didname, 0);
498 db->db_macname->close(db->db_macname, 0);
499 db->db_shortname->close(db->db_shortname, 0);
503 db->db_longname->set_bt_compare(db->db_longname, &compare_unicode);
504 if ((rc = db->db_longname->open(db->db_longname, DBLONGNAME, NULL, DB_BTREE, open_flag, 0666)) != 0) {
505 LOG(log_error, logtype_default, "cnid_open: Failed to open did/longname database: %s",
507 db->db_didname->close(db->db_didname, 0);
508 db->db_macname->close(db->db_macname, 0);
509 db->db_shortname->close(db->db_shortname, 0);
512 #endif /* EXTENDED_DB */
514 /* dev/ino reverse mapping. Use a hash for this one. */
515 if ((rc = db_create(&db->db_devino, db->dbenv, 0)) != 0) {
516 LOG(log_error, logtype_default, "cnid_open: Failed to create dev/ino database: %s",
518 db->db_didname->close(db->db_didname, 0);
520 db->db_macname->close(db->db_macname, 0);
521 db->db_shortname->close(db->db_shortname, 0);
522 db->db_longname->close(db->db_longname, 0);
523 #endif /* EXTENDED_DB */
527 if ((rc = db->db_devino->open(db->db_devino, DBDEVINO, NULL, DB_HASH, open_flag, 0666)) != 0) {
528 LOG(log_error, logtype_default, "cnid_open: Failed to open devino database: %s",
530 db->db_didname->close(db->db_didname, 0);
532 db->db_macname->close(db->db_macname, 0);
533 db->db_shortname->close(db->db_shortname, 0);
534 db->db_longname->close(db->db_longname, 0);
535 #endif /* EXTENDED_DB */
539 /* Main CNID database. Use a hash for this one. */
540 if ((rc = db_create(&db->db_cnid, db->dbenv, 0)) != 0) {
541 LOG(log_error, logtype_default, "cnid_open: Failed to create cnid database: %s",
543 db->db_didname->close(db->db_didname, 0);
545 db->db_macname->close(db->db_macname, 0);
546 db->db_shortname->close(db->db_shortname, 0);
547 db->db_longname->close(db->db_longname, 0);
548 #endif /* EXTENDED_DB */
549 db->db_devino->close(db->db_devino, 0);
554 if ((rc = db->db_cnid->open(db->db_cnid, DBCNID, NULL, DB_HASH, open_flag, 0666)) != 0) {
555 LOG(log_error, logtype_default, "cnid_open: Failed to open dev/ino database: %s",
557 db->db_didname->close(db->db_didname, 0);
559 db->db_macname->close(db->db_macname, 0);
560 db->db_shortname->close(db->db_shortname, 0);
561 db->db_longname->close(db->db_longname, 0);
562 #endif /* EXTENDED_DB */
566 /* Print out the version of DB3 we're linked against. */
567 LOG(log_info, logtype_default, "CNID DB initialized using %s",
568 db_version(NULL, NULL, NULL));
573 LOG(log_error, logtype_default, "cnid_open: Failed to setup CNID DB environment");
574 db->dbenv->close(db->dbenv, 0);
577 if (db->lockfd > -1) {
581 (void)remove(recover_file);