libatalk/cnid/cnid_open.c

   1 /*
   2  * $Id: cnid_open.c,v 1.16 2001-10-21 08:38:30 jmarcus Exp $
   3  *
   4  * Copyright (c) 1999. Adrian Sun (asun@zoology.washington.edu)
   5  * All Rights Reserved. See COPYRIGHT.
   6  *
   7  * CNID database support.
   8  *
   9  * here's the deal:
  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 --
  14  *     start a database:
  15  *     cnid = cnid_open(root_dir);
  16  *
  17  *     allocate a new id:
  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
  21  *     requested.
  22  *
  23  *     given an id, get a did/name and dev/ino pair.
  24  *     name = cnid_get(cnid, &id); given an id, return the corresponding
  25  *     info.
  26  *     return code = cnid_delete(cnid, id); delete an entry.
  27  *
  28  * with AFP, CNIDs 0-2 have special meanings. here they are:
  29  * 0 -- invalid cnid
  30  * 1 -- parent of root directory (handled by afpd)
  31  * 2 -- root directory (handled by afpd)
  32  *
  33  * so, CNID_START begins at 3.
  34  */
  35
  36 #ifdef HAVE_CONFIG_H
  37 #include "config.h"
  38 #endif /* HAVE_CONFIG_H */
  39
  40 #ifdef CNID_DB
  41 #include <errno.h>
  42 #include <stdlib.h>
  43 #include <string.h>
  44 #ifdef HAVE_UNISTD_H
  45 #include <unistd.h>
  46 #endif /* HAVE_UNISTD_H */
  47 #ifdef HAVE_FCNTL_H
  48 #include <fcntl.h>
  49 #endif /* HAVE_FCNTL_H */
  50 #include <sys/param.h>
  51 #include <sys/stat.h>
  52 #include <syslog.h>
  53
  54 #include <db.h>
  55
  56 #include <atalk/adouble.h>
  57 #include <atalk/cnid.h>
  58 #include <atalk/util.h>
  59
  60 #include "cnid_private.h"
  61
  62 #ifndef MIN
  63 #define MIN(a, b)  ((a) < (b) ? (a) : (b))
  64 #endif /* ! MIN */
  65
  66 #define DBHOME       ".AppleDB"
  67 #define DBCNID       "cnid.db"
  68 #define DBDEVINO     "devino.db"
  69 #define DBDIDNAME    "didname.db"   /* did/full name mapping */
  70 #define DBSHORTNAME  "shortname.db" /* did/8+3 mapping */
  71 #define DBMACNAME    "macname.db"   /* did/31 mapping */
  72 #define DBLONGNAME   "longname.db"  /* did/unicode mapping */
  73 #define DBLOCKFILE   "cnid.lock"
  74
  75 #define DBHOMELEN    8
  76 #define DBLEN        10
  77
  78 /* we version the did/name database so that we can change the format
  79  * if necessary. the key is in the form of a did/name pair. in this case,
  80  * we use 0/0. */
  81 #define DBVERSION_KEY    "\0\0\0\0\0"
  82 #define DBVERSION_KEYLEN 5
  83 #define DBVERSION1       0x00000001U
  84 #define DBVERSION        DBVERSION1
  85
  86 #if DB_VERSION_MINOR > 1
  87 #define DBOPTIONS    (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
  88 DB_INIT_LOG | DB_INIT_TXN)
  89 #else /* DB_VERSION_MINOR < 1 */
  90 #define DBOPTIONS    (DB_CREATE | DB_INIT_MPOOL | DB_INIT_LOCK | \
  91 DB_INIT_LOG | DB_INIT_TXN | DB_TXN_NOSYNC)
  92 #endif /* DB_VERSION_MINOR */
  93
  94 #define MAXITER     0xFFFF /* maximum number of simultaneously open CNID
  95                             * databases. */
  96
  97 /* the first compare that's always done. */
  98 static __inline__ int compare_did(const DBT *a, const DBT *b)
  99 {
 100   u_int32_t dida, didb;
 101
 102   memcpy(&dida, a->data, sizeof(dida));
 103   memcpy(&didb, b->data, sizeof(didb));
 104   return dida - didb;
 105 }
 106
 107 /* sort did's and then names. this is for unix paths.
 108  * i.e., did/unixname lookups. */
 109 #if DB_VERSION_MINOR > 1
 110 static int compare_unix(DB *db, const DBT *a, const DBT *b)
 111 #else /* DB_VERSION_MINOR < 1 */
 112 static int compare_unix(const DBT *a, const DBT *b)
 113 #endif /* DB_VERSION_MINOR */
 114 {
 115   u_int8_t *sa, *sb;
 116   int len, ret;
 117
 118   /* sort by did */
 119   if ((ret = compare_did(a, b)))
 120     return ret;
 121
 122   sa = (u_int8_t *) a->data + 4; /* shift past did */
 123   sb = (u_int8_t *) b->data + 4;
 124   for (len = MIN(a->size, b->size); len-- > 4; sa++, sb++)
 125     if ((ret = (*sa - *sb)))
 126       return ret; /* sort by lexical ordering */
 127
 128   return a->size - b->size; /* sort by length */
 129 }
 130
 131 /* sort did's and then names. this is for macified paths (i.e.,
 132  * did/macname, and did/shortname. i think did/longname needs a
 133  * unicode table to work. also, we can't use strdiacasecmp as that
 134  * returns a match if a < b. */
 135 #if DB_VERSION_MINOR > 1
 136 static int compare_mac(DB *db, const DBT *a, const DBT *b)
 137 #else /* DB_VERSION_MINOR < 1 */
 138 static int compare_mac(const DBT *a, const DBT *b)
 139 #endif /* DB_VERSION_MINOR */
 140 {
 141   u_int8_t *sa, *sb;
 142   int len, ret;
 143
 144   /* sort by did */
 145   if ((ret = compare_did(a, b)))
 146     return ret;
 147
 148   sa = (u_int8_t *) a->data + 4;
 149   sb = (u_int8_t *) b->data + 4;
 150   for (len = MIN(a->size, b->size); len-- > 4; sa++, sb++)
 151     if ((ret = (_diacasemap[*sa] - _diacasemap[*sb])))
 152       return ret; /* sort by lexical ordering */
 153
 154   return a->size - b->size; /* sort by length */
 155 }
 156
 157
 158 /* for unicode names -- right now it's the same as compare_mac. */
 159 #if DB_VERSION_MINOR > 1
 160 static int compare_unicode(DB *db, const DBT *a, const DBT *b)
 161 #else /* DB_VERSION_MINOR < 1 */
 162 static int compare_unicode(const DBT *a, const DBT *b)
 163 #endif /* DB_VERSION_MINOR */
 164 {
 165 #if DB_VERSION_MINOR > 1
 166     return compare_mac(db,a,b);
 167 #else /* DB_VERSION_MINOR < 1 */
 168     return compare_mac(a,b);
 169 #endif /* DB_VERSION_MINOR */
 170 }
 171
 172 void *cnid_open(const char *dir) {
 173         struct stat st;
 174         struct flock lock;
 175         char path[MAXPATHLEN + 1];
 176         CNID_private *db;
 177         DBT key, data;
 178         DB_TXN *tid;
 179         int open_flag, len;
 180         int rc;
 181
 182         if (!dir) {
 183                 return NULL;
 184         }
 185
 186         /* this checks .AppleDB */
 187         if ((len = strlen(dir)) > (MAXPATHLEN - DBLEN - 1)) {
 188                 syslog(LOG_ERR, "cnid_open: Pathname too large: %s", dir);
 189                 return NULL;
 190         }
 191
 192         if ((db = (CNID_private *)calloc(1, sizeof(CNID_private))) == NULL) {
 193                 syslog(LOG_ERR, "cnid_open: Unable to allocate memory for database");
 194                 return NULL;
 195         }
 196
 197         db->magic = CNID_DB_MAGIC;
 198
 199         strcpy(path, dir);
 200         if (path[len - 1] != '/') {
 201                 strcat(path, "/");
 202                 len++;
 203         }
 204
 205         lock.l_type = F_WRLCK;
 206         lock.l_whence = SEEK_SET;
 207
 208         strcpy(path + len, DBHOME);
 209         if ((stat(path, &st) < 0) && (ad_mkdir(path, 0777) < 0)) {
 210                 syslog(LOG_ERR, "cnid_open: DBHOME mkdir failed");
 211                 goto fail_adouble;
 212         }
 213
 214         /* Search for a byte lock.  This allows us to cleanup the log files
 215          * at cnid_close() in a clean fashion.
 216          *
 217          * NOTE: This won't work if multiple volumes for the same user refer
 218          * to the sahe directory. */
 219         strcat(path, DBLOCKFILE);
 220         if ((db->lockfd = open(path, O_RDWR | O_CREAT, 0666)) > -1) {
 221                 lock.l_start = 0;
 222                 lock.l_len = 1;
 223                 while (fcntl(db->lockfd, F_SETLK, &lock) < 0) {
 224                         if (++lock.l_start > MAXITER) {
 225                                 syslog(LOG_INFO, "cnid_open: Cannot establish logfile cleanup lock.");
 226                                 close(db->lockfd);
 227                                 db->lockfd = -1;
 228                                 break;
 229                         }
 230                 }
 231         }
 232
 233         path[len + DBHOMELEN] = '\0';
 234         open_flag = DB_CREATE;
 235
 236         /* We need to be able to open the database environment with full
 237          * transaction, logging, and locking support if we ever hope to
 238          * be a true multi-acess file server. */
 239         if ((rc = db_env_create(&db->dbenv, 0)) != 0) {
 240                 syslog(LOG_ERR, "cnid_open: db_env_create: %s", db_strerror(rc));
 241                 goto fail_lock;
 242         }
 243
 244         /* Setup internal deadlock detection. */
 245         if ((rc = db->dbenv->set_lk_detect(db->dbenv, DB_LOCK_DEFAULT)) != 0) {
 246                 syslog(LOG_ERR, "cnid_open: set_lk_detect: %s", db_strerror(rc));
 247                 goto fail_lock;
 248         }
 249
 250 #if DB_VERSION_MINOR > 1
 251         /* Take care of setting the DB_TXN_NOSYNC flag in db3 > 3.1.x. */
 252         if ((rc = db->dbenv->set_flags(db->dbenv, DB_TXN_NOSYNC, 1)) != 0) {
 253                 syslog(LOG_ERR, "cnid_open: set_flags: %s", db_strerror(rc));
 254                 goto fail_lock;
 255         }
 256 #endif /* DB_VERSION_MINOR > 1 */
 257
 258         /* Open the database environment. */
 259         if ((rc = db->dbenv->open(db->dbenv, path, DBOPTIONS, 0666)) != 0) {
 260                 if (rc == DB_RUNRECOVERY) {
 261                         /* This is the mother of all errors.  We _must_ fail here. */
 262                         syslog(LOG_ERR, "cnid_open: CATASTROPHIC ERROR opening database environment.  Run db_recovery immediately");
 263                         goto fail_lock;
 264                 }
 265
 266                 /* We can't get a full transactional environment, so multi-access
 267                  * is out of the question.  Let's assume a read-only environment,
 268                  * and trry to at least get a shared memory pool. */
 269                 if ((rc = db->dbenv->open(db->dbenv, path, DB_INIT_MPOOL, 0666)) != 0) {
 270                         /* Nope, not a MPOOL, either.  Last-ditch effort: we'll try to
 271                          * open the environment with no flags. */
 272                         if ((rc = db->dbenv->open(db->dbenv, path, 0, 0666)) != 0) {
 273                                 syslog(LOG_ERR, "cnid_open: dbenv->open of %s failed: %s",
 274                                        path, db_strerror(rc));
 275                                 goto fail_lock;
 276                         }
 277                 }
 278                 db->flags |= CNIDFLAG_DB_RO;
 279                 open_flag = DB_RDONLY;
 280                 syslog(LOG_INFO, "cnid_open: Obtained read-only database environment");
 281         }
 282
 283         /* did/name reverse mapping.  We use a BTree for this one. */
 284         if ((rc = db_create(&db->db_didname, db->dbenv, 0)) != 0) {
 285                 syslog(LOG_ERR, "cnid_open: Failed to create did/name database: %s",
 286                        db_strerror(rc));
 287                 goto fail_appinit;
 288         }
 289
 290         db->db_didname->set_bt_compare(db->db_didname, &compare_unix);
 291         if ((rc = db->db_didname->open(db->db_didname, DBDIDNAME, NULL,
 292                  DB_BTREE, open_flag, 0666))) {
 293                 syslog(LOG_ERR, "cnid_open: Failed to open did/name database: %s",
 294                        db_strerror(rc));
 295                 goto fail_appinit;
 296         }
 297
 298         /* Check for version.  This way we can update the database if we need
 299          * to change the format in any way. */
 300         memset(&key, 0, sizeof(key));
 301         memset(&data, 0, sizeof(data));
 302         key.data = DBVERSION_KEY;
 303         key.size = DBVERSION_KEYLEN;
 304
 305 dbversion_retry:
 306         if ((rc = txn_begin(db->dbenv, NULL, &tid, 0)) != 0) {
 307                 syslog(LOG_ERR, "cnid_open: txn_begin: failed to check db version: %s",
 308                        db_strerror(rc));
 309                 db->db_didname->close(db->db_didname, 0);
 310                 goto fail_appinit;
 311         }
 312
 313         while ((rc = db->db_didname->get(db->db_didname, tid, &key, &data, DB_RMW))) {
 314                 int ret;
 315                 switch (rc) {
 316                         case DB_LOCK_DEADLOCK:
 317                                 if ((ret = txn_abort(tid)) != 0) {
 318                                         syslog(LOG_ERR, "cnid_open: txn_abort: %s", db_strerror(ret));
 319                                         db->db_didname->close(db->db_didname, 0);
 320                                         goto fail_appinit;
 321                                 }
 322                                 goto dbversion_retry;
 323                         case DB_NOTFOUND:
 324                         {
 325                                 u_int32_t version = htonl(DBVERSION);
 326
 327                                 data.data = &version;
 328                                 data.size = sizeof(version);
 329                         }
 330
 331                         if ((ret = db->db_didname->put(db->db_didname, tid, &key, &data,
 332                                       DB_NOOVERWRITE))) {
 333                                 if (ret == DB_LOCK_DEADLOCK) {
 334                                         if ((ret = txn_abort(tid)) != 0) {
 335                                                 syslog(LOG_ERR, "cnid_open: txn_abort: %s",
 336                                                        db_strerror(ret));
 337                                                 db->db_didname->close(db->db_didname, 0);
 338                                                 goto fail_appinit;
 339                                         }
 340                                         goto dbversion_retry;
 341                                 }
 342                                 else if (ret == DB_RUNRECOVERY) {
 343                                         /* At this point, we don't care if the transaction aborts
 344                                          * successfully or not. */
 345                                         txn_abort(tid);
 346                                         syslog(LOG_ERR, "cnid_open: Error putting new version: %s",
 347                                                db_strerror(ret));
 348                                         db->db_didname->close(db->db_didname, 0);
 349                                         goto fail_appinit;
 350                                 }
 351                         }
 352                                 break; /* while loop */
 353                         default:
 354                                 txn_abort(tid);
 355                                 syslog(LOG_ERR, "cnid_open: Failed to check db version: %s",
 356                                        db_strerror(rc));
 357                                 db->db_didname->close(db->db_didname, 0);
 358                                 goto fail_appinit;
 359                 }
 360         }
 361
 362         if ((rc = txn_commit(tid, 0)) != 0) {
 363                 syslog(LOG_ERR, "cnid_open: Failed to commit db version: %s",
 364                        db_strerror(rc));
 365                 db->db_didname->close(db->db_didname, 0);
 366                 goto fail_appinit;
 367         }
 368
 369         /* TODO In the future we might check for version number here. */
 370 #if 0
 371         memcpy(&version, data.data, sizeof(version));
 372         if (version != ntohl(DBVERSION)) {
 373                 /* Do stuff here. */
 374         }
 375 #endif /* 0 */
 376
 377 #ifdef EXTENDED_DB
 378         /* did/macname (31 character) mapping.  Use a BTree for this one. */
 379         if ((rc = db_create(&db->db_macname, db->dbenv, 0)) != 0) {
 380                 syslog(LOG_ERR, "cnid_open: Failed to create did/macname database: %s",
 381                        db_strerror(rc));
 382                 db->db_didname->close(db->db_didname, 0);
 383                 goto fail_appinit;
 384         }
 385
 386         db->db_macname->set_bt_compare(db->db_macname, &compare_mac);
 387         if ((rc = db->db_macname->open(db->db_macname, DBMACNAME, NULL, DB_BTREE, open_flag, 0666)) != 0) {
 388                 syslog(LOG_ERR, "cnid_open: Failed to open did/macname database: %s",
 389                        db_strerror(rc));
 390                 db->db_didname->close(db->db_didname, 0);
 391                 goto fail_appinit;
 392         }
 393
 394         /* did/shortname (DOS 8.3) mapping.  Use a BTree for this one. */
 395         if ((rc = db_create(&db->db_shortname, db->dbenv, 0)) != 0) {
 396                 syslog(LOG_ERR, "cnid_open: Failed to create did/shortname database: %s",
 397                        db_strerror(rc));
 398                 db->db_didname->close(db->db_didname, 0);
 399                 db->db_macname->close(db->db_macname, 0);
 400                 goto fail_appinit;
 401         }
 402
 403         db->db_shortname->set_bt_compare(db->db_shortname, &compare_mac);
 404         if ((rc = db->db_shortname->open(db->db_shortname, DBSHORTNAME, NULL, DB_BTREE, open_flag, 0666)) != 0) {
 405                 syslog(LOG_ERR, "cnid_open: Failed to open did/shortname database: %s",
 406                        db_strerror(rc));
 407                 db->db_didname->close(db->db_didname, 0);
 408                 db->db_macname->close(db->db_macname, 0);
 409                 goto fail_appinit;
 410         }
 411
 412         /* did/longname (Unicode) mapping.  Use a BTree for this one. */
 413         if ((rc = db_create(&db->db_longname, db->dbenv, 0)) != 0) {
 414                 syslog(LOG_ERR, "cnid_open: Failed to create did/longname database: %s",
 415                        db_strerror(rc));
 416                 db->db_didname->close(db->db_didname, 0);
 417                 db->db_macname->close(db->db_macname, 0);
 418                 db->db_shortname->close(db->db_shortname, 0);
 419                 goto fail_appinit;
 420         }
 421
 422         db->db_longname->set_bt_compare(db->db_longname, &compare_unicode);
 423         if ((rc = db->db_longname->open(db->db_longname, DBLONGNAME, NULL, DB_BTREE, open_flag, 0666)) != 0) {
 424                 syslog(LOG_ERR, "cnid_open: Failed to open did/longname database: %s",
 425                        db_strerror(rc));
 426                 db->db_didname->close(db->db_didname, 0);
 427                 db->db_macname->close(db->db_macname, 0);
 428                 db->db_shortname->close(db->db_shortname, 0);
 429                 goto fail_appinit;
 430         }
 431 #endif /* EXTENDED_DB */
 432
 433         /* dev/ino reverse mapping.  Use a hash for this one. */
 434         if ((rc = db_create(&db->db_devino, db->dbenv, 0)) != 0) {
 435                 syslog(LOG_ERR, "cnid_open: Failed to create dev/ino database: %s",
 436                        db_strerror(rc));
 437                 db->db_didname->close(db->db_didname, 0);
 438 #ifdef EXTENDED_DB
 439                 db->db_macname->close(db->db_macname, 0);
 440                 db->db_shortname->close(db->db_shortname, 0);
 441                 db->db_longname->close(db->db_longname, 0);
 442 #endif /* EXTENDED_DB */
 443                 goto fail_appinit;
 444         }
 445
 446         if ((rc = db->db_devino->open(db->db_devino, DBDEVINO, NULL, DB_HASH, open_flag, 0666)) != 0) {
 447                 syslog(LOG_ERR, "cnid_open: Failed to open devino database: %s",
 448                        db_strerror(rc));
 449                 db->db_didname->close(db->db_didname, 0);
 450 #ifdef EXTENDED_DB
 451                 db->db_macname->close(db->db_macname, 0);
 452                 db->db_shortname->close(db->db_shortname, 0);
 453                 db->db_longname->close(db->db_longname, 0);
 454 #endif /* EXTENDED_DB */
 455                 goto fail_appinit;
 456         }
 457
 458         /* Main CNID database.  Use a hash for this one. */
 459         if ((rc = db_create(&db->db_cnid, db->dbenv, 0)) != 0) {
 460                 syslog(LOG_ERR, "cnid_open: Failed to create cnid database: %s",
 461                        db_strerror(rc));
 462                 db->db_didname->close(db->db_didname, 0);
 463 #ifdef EXTENDED_DB
 464                 db->db_macname->close(db->db_macname, 0);
 465                 db->db_shortname->close(db->db_shortname, 0);
 466                 db->db_longname->close(db->db_longname, 0);
 467 #endif /* EXTENDED_DB */
 468                 db->db_devino->close(db->db_devino, 0);
 469                 goto fail_appinit;
 470         }
 471
 472
 473         if ((rc = db->db_cnid->open(db->db_cnid, DBCNID, NULL, DB_HASH, open_flag, 0666)) != 0) {
 474                 syslog(LOG_ERR, "cnid_open: Failed to open dev/ino database: %s",
 475                        db_strerror(rc));
 476                 db->db_didname->close(db->db_didname, 0);
 477 #ifdef EXTENDED_DB
 478                 db->db_macname->close(db->db_macname, 0);
 479                 db->db_shortname->close(db->db_shortname, 0);
 480                 db->db_longname->close(db->db_longname, 0);
 481 #endif /* EXTENDED_DB */
 482                 goto fail_appinit;
 483         }
 484
 485         return db;
 486
 487 fail_appinit:
 488         syslog(LOG_ERR, "cnid_open: Failed to setup CNID DB environment");
 489         db->dbenv->close(db->dbenv, 0);
 490
 491 fail_lock:
 492         if (db->lockfd > -1) {
 493                 close(db->lockfd);
 494         }
 495
 496 fail_adouble:
 497
 498 fail_db:
 499         free(db);
 500         return NULL;
 501 }
 502 #endif /* CNID_DB */
 503
 504