libatalk/cnid/cdb/cnid_cdb_open.c

   1
   2 /*
   3  * $Id: cnid_cdb_open.c,v 1.1.4.10.2.1 2005-09-27 10:40:41 didg Exp $
   4  *
   5  * Copyright (c) 1999. Adrian Sun (asun@zoology.washington.edu)
   6  * All Rights Reserved. See COPYRIGHT.
   7  *
   8  * CNID database support.
   9  *
  10  * here's the deal:
  11  *  1) afpd already caches did's.
  12  *  2) the database stores cnid's as both did/name and dev/ino pairs.
  13  *  3) RootInfo holds the value of the NextID.
  14  *  4) the cnid database gets called in the following manner --
  15  *     start a database:
  16  *     cnid = cnid_open(root_dir);
  17  *
  18  *     allocate a new id:
  19  *     newid = cnid_add(cnid, dev, ino, parent did,
  20  *     name, id); id is a hint for a specific id. pass 0 if you don't
  21  *     care. if the id is already assigned, you won't get what you
  22  *     requested.
  23  *
  24  *     given an id, get a did/name and dev/ino pair.
  25  *     name = cnid_get(cnid, &id); given an id, return the corresponding
  26  *     info.
  27  *     return code = cnid_delete(cnid, id); delete an entry.
  28  *
  29  * with AFP, CNIDs 0-2 have special meanings. here they are:
  30  * 0 -- invalid cnid
  31  * 1 -- parent of root directory (handled by afpd)
  32  * 2 -- root directory (handled by afpd)
  33  *
  34  * CNIDs 4-16 are reserved according to page 31 of the AFP 3.0 spec so,
  35  * CNID_START begins at 17.
  36  */
  37
  38 #ifdef HAVE_CONFIG_H
  39 #include "config.h"
  40 #endif /* HAVE_CONFIG_H */
  41
  42 #ifdef CNID_BACKEND_CDB
  43 #include "cnid_cdb_private.h"
  44
  45 #ifndef MIN
  46 #define MIN(a, b)  ((a) < (b) ? (a) : (b))
  47 #endif /* ! MIN */
  48
  49 #define DBHOME        ".AppleDB"
  50 #define DBCNID        "cnid2.db"
  51 #define DBDEVINO      "devino.db"
  52 #define DBDIDNAME     "didname.db"      /* did/full name mapping */
  53 #define DBLOCKFILE    "cnid.lock"
  54
  55 #define DBHOMELEN    8
  56 #define DBLEN        10
  57
  58 /* we version the did/name database so that we can change the format
  59  * if necessary. the key is in the form of a did/name pair. in this case,
  60  * we use 0/0. */
  61 #define DBVERSION_KEY    "\0\0\0\0\0"
  62 #define DBVERSION_KEYLEN 5
  63 #define DBVERSION1       0x00000001U
  64 #define DBVERSION        DBVERSION1
  65
  66 #define DBOPTIONS    (DB_CREATE | DB_INIT_CDB | DB_INIT_MPOOL)
  67
  68 #define MAXITER     0xFFFF      /* maximum number of simultaneously open CNID
  69                                  * databases. */
  70
  71 static char *old_dbfiles[] = {"cnid.db", NULL};
  72
  73 /* -----------------------
  74  * bandaid for LanTest performance pb. for now not used, cf. ifdef 0 below
  75 */
  76 static int my_yield(void)
  77 {
  78     struct timeval t;
  79     int ret;
  80
  81     t.tv_sec = 0;
  82     t.tv_usec = 1000;
  83     ret = select(0, NULL, NULL, NULL, &t);
  84     return 0;
  85 }
  86
  87 /* --------------- */
  88 static int didname(dbp, pkey, pdata, skey)
  89 DB *dbp _U_;
  90 const DBT *pkey _U_, *pdata;
  91 DBT *skey;
  92 {
  93 int len;
  94
  95     memset(skey, 0, sizeof(DBT));
  96     skey->data = (char *)pdata->data + CNID_DID_OFS;
  97     len = strlen((char *)skey->data + CNID_DID_LEN);
  98     skey->size = CNID_DID_LEN + len + 1;
  99     return (0);
 100 }
 101
 102 /* --------------- */
 103 static int devino(dbp, pkey, pdata, skey)
 104 DB *dbp _U_;
 105 const DBT *pkey _U_, *pdata;
 106 DBT *skey;
 107 {
 108     memset(skey, 0, sizeof(DBT));
 109     skey->data = (char *)pdata->data + CNID_DEVINO_OFS;
 110     skey->size = CNID_DEVINO_LEN;
 111     return (0);
 112 }
 113
 114 /* --------------- */
 115 static int  my_associate (DB *p, DB *s,
 116                    int (*callback)(DB *, const DBT *,const DBT *, DBT *),
 117                    u_int32_t flags)
 118 {
 119 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 1)
 120     return p->associate(p, NULL, s, callback, flags);
 121 #else
 122 #if (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR == 0)
 123     return p->associate(p,       s, callback, flags);
 124 #else
 125     return 0; /* FIXME */
 126 #endif
 127 #endif
 128 }
 129
 130 /* --------------- */
 131 static int my_open(DB * p, const char *f, const char *d, DBTYPE t, u_int32_t flags, int mode)
 132 {
 133 #if DB_VERSION_MAJOR > 4 || (DB_VERSION_MAJOR == 4 && DB_VERSION_MINOR >= 1)
 134     return p->open(p, NULL, f, d, t, flags, mode);
 135 #else
 136     return p->open(p, f, d, t, flags, mode);
 137 #endif
 138 }
 139
 140 /* --------------- */
 141 static struct _cnid_db *cnid_cdb_new(const char *volpath)
 142 {
 143     struct _cnid_db *cdb;
 144     int major, minor, patch;
 145     char *version_str;
 146
 147     version_str = db_version(&major, &minor, &patch);
 148
 149     /* check library match, ignore if only patch level changed */
 150     if ( major != DB_VERSION_MAJOR || minor != DB_VERSION_MINOR)
 151     {
 152         LOG(log_error, logtype_cnid, "cnid_cdb_new: the Berkeley DB library version used does not match the version compiled with: (%u.%u)/(%u.%u)", DB_VERSION_MAJOR, DB_VERSION_MINOR, major, minor);
 153         return NULL;
 154     }
 155
 156     if ((cdb = (struct _cnid_db *) calloc(1, sizeof(struct _cnid_db))) == NULL)
 157         return NULL;
 158
 159     if ((cdb->volpath = strdup(volpath)) == NULL) {
 160         free(cdb);
 161         return NULL;
 162     }
 163
 164     cdb->flags = CNID_FLAG_PERSISTENT;
 165
 166     cdb->cnid_add = cnid_cdb_add;
 167     cdb->cnid_delete = cnid_cdb_delete;
 168     cdb->cnid_get = cnid_cdb_get;
 169     cdb->cnid_lookup = cnid_cdb_lookup;
 170     cdb->cnid_nextid = NULL;    /*cnid_cdb_nextid;*/
 171     cdb->cnid_resolve = cnid_cdb_resolve;
 172     cdb->cnid_update = cnid_cdb_update;
 173     cdb->cnid_close = cnid_cdb_close;
 174     cdb->cnid_getstamp = cnid_cdb_getstamp;
 175
 176     return cdb;
 177 }
 178
 179 /* --------------- */
 180 static int upgrade_required(char *dbdir)
 181 {
 182     char path[MAXPATHLEN + 1];
 183     int len, i;
 184     int found = 0;
 185     struct stat st;
 186
 187     strcpy(path, dbdir);
 188
 189     len = strlen(path);
 190     if (path[len - 1] != '/') {
 191         strcat(path, "/");
 192         len++;
 193     }
 194
 195     for (i = 0; old_dbfiles[i] != NULL; i++) {
 196         strcpy(path + len, old_dbfiles[i]);
 197         if ( !(stat(path, &st) < 0) ) {
 198             found++;
 199             continue;
 200         }
 201         if (errno != ENOENT) {
 202             LOG(log_error, logtype_default, "cnid_open: Checking %s gave %s", path, strerror(errno));
 203             found++;
 204         }
 205     }
 206     return found;
 207 }
 208
 209 /* --------------- */
 210 struct _cnid_db *cnid_cdb_open(const char *dir, mode_t mask)
 211 {
 212     struct stat st;
 213     char path[MAXPATHLEN + 1];
 214     CNID_private *db;
 215     struct _cnid_db *cdb;
 216     int open_flag, len;
 217     static int first = 0;
 218     int rc;
 219
 220     if (!dir || *dir == 0) {
 221         return NULL;
 222     }
 223
 224     /* this checks .AppleDB.
 225        We need space for dir + '/' + DBHOMELEN + '/' + DBLEN */
 226     if ((len = strlen(dir)) > (MAXPATHLEN - DBHOMELEN - DBLEN - 2)) {
 227         LOG(log_error, logtype_default, "cnid_open: Pathname too large: %s", dir);
 228         return NULL;
 229     }
 230
 231     if ((cdb = cnid_cdb_new(dir)) == NULL) {
 232         LOG(log_error, logtype_default, "cnid_open: Unable to allocate memory for database");
 233         return NULL;
 234     }
 235
 236     if ((db = (CNID_private *) calloc(1, sizeof(CNID_private))) == NULL) {
 237         LOG(log_error, logtype_default, "cnid_open: Unable to allocate memory for database");
 238         goto fail_cdb;
 239     }
 240
 241     cdb->_private = (void *) db;
 242     db->magic = CNID_DB_MAGIC;
 243
 244     strcpy(path, dir);
 245     if (path[len - 1] != '/') {
 246         strcat(path, "/");
 247         len++;
 248     }
 249
 250     strcpy(path + len, DBHOME);
 251     if ((stat(path, &st) < 0) && (ad_mkdir(path, 0777 & ~mask) < 0)) {
 252         LOG(log_error, logtype_default, "cnid_open: DBHOME mkdir failed for %s", path);
 253         goto fail_adouble;
 254     }
 255
 256     if (upgrade_required(path)) {
 257         LOG(log_error, logtype_default, "cnid_open: Found version 1 of the CNID database. Please upgrade to version 2");
 258         goto fail_adouble;
 259     }
 260
 261     /* Print out the version of BDB we're linked against. */
 262     if (!first) {
 263         first = 1;
 264         LOG(log_info, logtype_default, "CNID DB initialized using %s", db_version(NULL, NULL, NULL));
 265     }
 266
 267     open_flag = DB_CREATE;
 268
 269     /* We need to be able to open the database environment with full
 270      * transaction, logging, and locking support if we ever hope to
 271      * be a true multi-acess file server. */
 272     if ((rc = db_env_create(&db->dbenv, 0)) != 0) {
 273         LOG(log_error, logtype_default, "cnid_open: db_env_create: %s", db_strerror(rc));
 274         goto fail_lock;
 275     }
 276
 277     /* Open the database environment. */
 278     if ((rc = db->dbenv->open(db->dbenv, path, DBOPTIONS, 0666 & ~mask)) != 0) {
 279         LOG(log_error, logtype_default, "cnid_open: dbenv->open (rw) of %s failed: %s", path, db_strerror(rc));
 280         /* FIXME: This should probably go. Even if it worked, any use for a read-only DB? Didier? */
 281         if (rc == DB_RUNRECOVERY) {
 282             /* This is the mother of all errors.  We _must_ fail here. */
 283             LOG(log_error, logtype_default,
 284                 "cnid_open: CATASTROPHIC ERROR opening database environment %s.  Run db_recovery -c immediately", path);
 285             goto fail_lock;
 286         }
 287
 288         /* We can't get a full transactional environment, so multi-access
 289          * is out of the question.  Let's assume a read-only environment,
 290          * and try to at least get a shared memory pool. */
 291         if ((rc = db->dbenv->open(db->dbenv, path, DB_INIT_MPOOL, 0666 & ~mask)) != 0) {
 292             /* Nope, not a MPOOL, either.  Last-ditch effort: we'll try to
 293              * open the environment with no flags. */
 294             if ((rc = db->dbenv->open(db->dbenv, path, 0, 0666 & ~mask)) != 0) {
 295                 LOG(log_error, logtype_default, "cnid_open: dbenv->open of %s failed: %s", path, db_strerror(rc));
 296                 goto fail_lock;
 297             }
 298         }
 299         db->flags |= CNIDFLAG_DB_RO;
 300         open_flag = DB_RDONLY;
 301         LOG(log_info, logtype_default, "cnid_open: Obtained read-only database environment %s", path);
 302     }
 303
 304     /* ---------------------- */
 305     /* Main CNID database.  Use a hash for this one. */
 306
 307     if ((rc = db_create(&db->db_cnid, db->dbenv, 0)) != 0) {
 308         LOG(log_error, logtype_default, "cnid_open: Failed to create cnid database: %s",
 309             db_strerror(rc));
 310         goto fail_appinit;
 311     }
 312
 313     if ((rc = my_open(db->db_cnid, DBCNID, DBCNID, DB_BTREE, open_flag, 0666 & ~mask)) != 0) {
 314         LOG(log_error, logtype_default, "cnid_open: Failed to open dev/ino database: %s",
 315             db_strerror(rc));
 316         goto fail_appinit;
 317     }
 318
 319     /* ---------------------- */
 320     /* did/name reverse mapping.  We use a BTree for this one. */
 321
 322     if ((rc = db_create(&db->db_didname, db->dbenv, 0)) != 0) {
 323         LOG(log_error, logtype_default, "cnid_open: Failed to create did/name database: %s",
 324             db_strerror(rc));
 325         goto fail_appinit;
 326     }
 327
 328     if ((rc = my_open(db->db_didname, DBCNID, DBDIDNAME, DB_BTREE, open_flag, 0666 & ~mask))) {
 329         LOG(log_error, logtype_default, "cnid_open: Failed to open did/name database: %s",
 330             db_strerror(rc));
 331         goto fail_appinit;
 332     }
 333
 334     /* ---------------------- */
 335     /* dev/ino reverse mapping.  Use a hash for this one. */
 336
 337     if ((rc = db_create(&db->db_devino, db->dbenv, 0)) != 0) {
 338         LOG(log_error, logtype_default, "cnid_open: Failed to create dev/ino database: %s",
 339             db_strerror(rc));
 340         goto fail_appinit;
 341     }
 342
 343     if ((rc = my_open(db->db_devino, DBCNID, DBDEVINO, DB_BTREE, open_flag, 0666 & ~mask)) != 0) {
 344         LOG(log_error, logtype_default, "cnid_open: Failed to open devino database: %s",
 345             db_strerror(rc));
 346         goto fail_appinit;
 347     }
 348
 349     /* ---------------------- */
 350     /* Associate the secondary with the primary. */
 351     if ((rc = my_associate(db->db_cnid, db->db_didname, didname, 0)) != 0) {
 352         LOG(log_error, logtype_default, "cnid_open: Failed to associate didname database: %s",
 353             db_strerror(rc));
 354         goto fail_appinit;
 355     }
 356
 357     if ((rc = my_associate(db->db_cnid, db->db_devino, devino, 0)) != 0) {
 358         LOG(log_error, logtype_default, "cnid_open: Failed to associate devino database: %s",
 359             db_strerror(rc));
 360         goto fail_appinit;
 361     }
 362
 363 #if 0
 364     DBT key, pkey, data;
 365     /* ---------------------- */
 366     /* Check for version.  This way we can update the database if we need
 367      * to change the format in any way. */
 368     memset(&key, 0, sizeof(key));
 369     memset(&pkey, 0, sizeof(DBT));
 370     memset(&data, 0, sizeof(data));
 371     key.data = DBVERSION_KEY;
 372     key.size = DBVERSION_KEYLEN;
 373
 374     if ((rc = db->db_didname->pget(db->db_didname, NULL, &key, &pkey, &data, 0)) != 0) {
 375         int ret;
 376         {
 377             u_int32_t version = htonl(DBVERSION);
 378
 379             data.data = &version;
 380             data.size = sizeof(version);
 381         }
 382         if ((ret = db->db_didname->put(db->db_cnid, NULL, &key, &data,
 383                                        DB_NOOVERWRITE))) {
 384             LOG(log_error, logtype_default, "cnid_open: Error putting new version: %s",
 385                 db_strerror(ret));
 386             db->db_didname->close(db->db_didname, 0);
 387             goto fail_appinit;
 388         }
 389     }
 390 #endif
 391
 392     /* TODO In the future we might check for version number here. */
 393 #if 0
 394     memcpy(&version, data.data, sizeof(version));
 395     if (version != ntohl(DBVERSION)) {
 396         /* Do stuff here. */
 397     }
 398 #endif /* 0 */
 399
 400     db_env_set_func_yield(my_yield);
 401     return cdb;
 402
 403   fail_appinit:
 404     if (db->db_didname)
 405         db->db_didname->close(db->db_didname, 0);
 406     if (db->db_devino)
 407         db->db_devino->close(db->db_devino, 0);
 408     if (db->db_cnid)
 409         db->db_cnid->close(db->db_cnid, 0);
 410     LOG(log_error, logtype_default, "cnid_open: Failed to setup CNID DB environment");
 411     db->dbenv->close(db->dbenv, 0);
 412
 413   fail_lock:
 414
 415   fail_adouble:
 416
 417     free(db);
 418
 419   fail_cdb:
 420     if (cdb->volpath != NULL)
 421         free(cdb->volpath);
 422     free(cdb);
 423
 424     return NULL;
 425 }
 426
 427 struct _cnid_module cnid_cdb_module = {
 428     "cdb",
 429     {NULL, NULL},
 430     cnid_cdb_open,
 431     CNID_FLAG_SETUID | CNID_FLAG_BLOCK
 432 };
 433
 434
 435 #endif /* CNID_BACKEND_CDB */