etc/cnid_dbd/cmd_dbd.c

   1 /*
   2    Copyright (c) 2009 Frank Lahm <franklahm@gmail.com>
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13 */
  14
  15 /*
  16   dbd specs and implementation progress
  17   =====================================
  18
  19   St := Status
  20
  21   Force option
  22   ------------
  23
  24   St Spec
  25   -- ----
  26   OK If -f is requested, ensure -e is too.
  27      Check if volumes is using AFPVOL_CACHE, then wipe db from disk. Rebuild from ad-files.
  28
  29   1st pass: Scan volume
  30   --------------------
  31
  32   St Type Check
  33   -- ---- -----
  34   OK F/D  Make sure ad file exists
  35   OK D    Make sure .AppleDouble dir exist, create if missing. Error creating
  36           it is fatal as that shouldn't happen as root.
  37   OK F/D  Delete orphaned ad-files, log dirs in ad-dir
  38   OK F/D  Check name encoding by roundtripping, log on error
  39   OK F/D  try: read CNID from ad file (if cnid caching is on)
  40           try: fetch CNID from database
  41           -> on mismatch: use CNID from file, update database (deleting both found CNIDs first)
  42           -> if no CNID in ad file: write CNID from database to ad file
  43           -> if no CNID in database: add CNID from ad file to database
  44           -> on no CNID at all: create one and store in both places
  45   OK F/D  Add found CNID, DID, filename, dev/inode, stamp to rebuild database
  46   OK F/D  Check/update stamp (implicitly done while checking CNIDs)
  47
  48
  49   2nd pass: Delete unused CNIDs
  50   -----------------------------
  51
  52   St Spec
  53   -- ----
  54   OK Step through dbd (the one on disk) and rebuild-db from pass 1 and delete any CNID from
  55      dbd not in rebuild db. This in only done in exclusive mode.
  56 */
  57
  58 #ifdef HAVE_CONFIG_H
  59 #include "config.h"
  60 #endif /* HAVE_CONFIG_H */
  61
  62 #include <unistd.h>
  63 #include <sys/types.h>
  64 #include <stdlib.h>
  65 #include <stdio.h>
  66 #include <stdarg.h>
  67 #include <limits.h>
  68 #include <signal.h>
  69 #include <string.h>
  70 #include <errno.h>
  71
  72 #include <atalk/logger.h>
  73 #include <atalk/cnid_dbd_private.h>
  74 #include <atalk/volinfo.h>
  75 #include "cmd_dbd.h"
  76 #include "dbd.h"
  77 #include "dbif.h"
  78 #include "db_param.h"
  79
  80 #define LOCKFILENAME  "lock"
  81 #define DBOPTIONS (DB_CREATE | DB_INIT_LOCK | DB_INIT_LOG | DB_INIT_MPOOL | DB_INIT_TXN)
  82
  83 int nocniddb = 0;               /* Dont open CNID database, only scan filesystem */
  84 volatile sig_atomic_t alarmed;
  85 struct volinfo volinfo; /* needed by pack.c:idxname() */
  86
  87 static DBD *dbd;
  88 static int verbose;             /* Logging flag */
  89 static int exclusive;           /* Exclusive volume access */
  90 static struct db_param db_param = {
  91     NULL,                       /* Volume dirpath */
  92     1,                          /* bdb logfile autoremove */
  93     64 * 1024,                  /* bdb cachesize (64 MB) */
  94     DEFAULT_MAXLOCKS,           /* maxlocks */
  95     DEFAULT_MAXLOCKOBJS,        /* maxlockobjs */
  96     0,                          /* flush_interval */
  97     0,                          /* flush_frequency */
  98     1000,                       /* txn_frequency */
  99     0,                          /* usock_file */
 100     -1,                         /* fd_table_size */
 101     -1,                         /* idle_timeout */
 102     -1                          /* max_vols */
 103 };
 104 static char dbpath[MAXPATHLEN+1];   /* Path to the dbd database */
 105
 106 /*
 107    Provide some logging
 108  */
 109 void dbd_log(enum logtype lt, char *fmt, ...)
 110 {
 111     int len;
 112     static char logbuffer[1024];
 113     va_list args;
 114
 115     if ( (lt == LOGSTD) || (verbose == 1)) {
 116         va_start(args, fmt);
 117         len = vsnprintf(logbuffer, 1023, fmt, args);
 118         va_end(args);
 119         logbuffer[1023] = 0;
 120
 121         printf("%s\n", logbuffer);
 122     }
 123 }
 124
 125 /*
 126    SIGNAL handling:
 127    catch SIGINT and SIGTERM which cause clean exit. Ignore anything else.
 128  */
 129
 130 static void sig_handler(int signo)
 131 {
 132     alarmed = 1;
 133     return;
 134 }
 135
 136 static void set_signal(void)
 137 {
 138     struct sigaction sv;
 139
 140     sv.sa_handler = sig_handler;
 141     sv.sa_flags = SA_RESTART;
 142     sigemptyset(&sv.sa_mask);
 143     if (sigaction(SIGTERM, &sv, NULL) < 0) {
 144         dbd_log( LOGSTD, "error in sigaction(SIGTERM): %s", strerror(errno));
 145         exit(EXIT_FAILURE);
 146     }
 147     if (sigaction(SIGINT, &sv, NULL) < 0) {
 148         dbd_log( LOGSTD, "error in sigaction(SIGINT): %s", strerror(errno));
 149         exit(EXIT_FAILURE);
 150     }
 151
 152     memset(&sv, 0, sizeof(struct sigaction));
 153     sv.sa_handler = SIG_IGN;
 154     sigemptyset(&sv.sa_mask);
 155
 156     if (sigaction(SIGABRT, &sv, NULL) < 0) {
 157         dbd_log( LOGSTD, "error in sigaction(SIGABRT): %s", strerror(errno));
 158         exit(EXIT_FAILURE);
 159     }
 160     if (sigaction(SIGHUP, &sv, NULL) < 0) {
 161         dbd_log( LOGSTD, "error in sigaction(SIGHUP): %s", strerror(errno));
 162         exit(EXIT_FAILURE);
 163     }
 164     if (sigaction(SIGQUIT, &sv, NULL) < 0) {
 165         dbd_log( LOGSTD, "error in sigaction(SIGQUIT): %s", strerror(errno));
 166         exit(EXIT_FAILURE);
 167     }
 168 }
 169
 170 static int get_lock(const char *dbpath)
 171 {
 172     int lockfd;
 173     char lockpath[PATH_MAX];
 174     struct flock lock;
 175     struct stat st;
 176
 177     if ( (strlen(dbpath) + strlen(LOCKFILENAME+1)) > (PATH_MAX - 1) ) {
 178         dbd_log( LOGSTD, ".AppleDB pathname too long");
 179         exit(EXIT_FAILURE);
 180     }
 181     strncpy(lockpath, dbpath, PATH_MAX - 1);
 182     strcat(lockpath, "/");
 183     strcat(lockpath, LOCKFILENAME);
 184
 185     if ((lockfd = open(lockpath, O_RDWR | O_CREAT, 0644)) < 0) {
 186         dbd_log( LOGSTD, "Error opening lockfile: %s", strerror(errno));
 187         exit(EXIT_FAILURE);
 188     }
 189
 190     if ((stat(dbpath, &st)) != 0) {
 191         dbd_log( LOGSTD, "Error statting lockfile: %s", strerror(errno));
 192         exit(EXIT_FAILURE);
 193     }
 194
 195     if ((chown(lockpath, st.st_uid, st.st_gid)) != 0) {
 196         dbd_log( LOGSTD, "Error inheriting lockfile permissions: %s", strerror(errno));
 197         exit(EXIT_FAILURE);
 198     }
 199
 200     lock.l_start  = 0;
 201     lock.l_whence = SEEK_SET;
 202     lock.l_len    = 0;
 203     lock.l_type   = F_WRLCK;
 204
 205     if (fcntl(lockfd, F_SETLK, &lock) < 0) {
 206         if (errno == EACCES || errno == EAGAIN) {
 207             if (exclusive) {
 208                 dbd_log( LOGSTD, "Database is in use and exlusive was requested", strerror(errno));
 209                 exit(EXIT_FAILURE);
 210             };
 211         } else {
 212             dbd_log( LOGSTD, "Error getting fcntl F_WRLCK on lockfile: %s", strerror(errno));
 213             exit(EXIT_FAILURE);
 214        }
 215     }
 216
 217     return lockfd;
 218 }
 219
 220 static void free_lock(int lockfd)
 221 {
 222     struct flock lock;
 223
 224     lock.l_start  = 0;
 225     lock.l_whence = SEEK_SET;
 226     lock.l_len    = 0;
 227     lock.l_type = F_UNLCK;
 228     fcntl(lockfd, F_SETLK, &lock);
 229     close(lockfd);
 230 }
 231
 232 static void usage (void)
 233 {
 234     printf("Usage: dbd [-e|-t|-v|-x] -d [-i] | -s [-c|-n]| -r [-c|-f] | -u <path to netatalk volume>\n"
 235            "dbd can dump, scan, reindex and rebuild Netatalk dbd CNID databases.\n"
 236            "dbd must be run with appropiate permissions i.e. as root.\n\n"
 237            "Main commands are:\n"
 238            "   -d Dump CNID database\n"
 239            "      Option: -i dump indexes too\n\n"
 240            "   -s Scan volume:\n"
 241            "      1. Compare CNIDs in database with volume\n"
 242            "      2. Check if .AppleDouble dirs exist\n"
 243            "      3. Check if  AppleDouble file exist\n"
 244            "      4. Report orphaned AppleDouble files\n"
 245            "      5. Check for directories inside AppleDouble directories\n"
 246            "      6. Check name encoding by roundtripping, log on error\n"
 247            "      7. Check for orphaned CNIDs in database (requires -e)\n"
 248            "      8. Open and close adouble files\n"
 249            "      Options: -c Don't check .AppleDouble stuff, only ckeck orphaned.\n"
 250            "               -n Don't open CNID database, skip CNID checks\n\n"
 251            "   -r Rebuild volume:\n"
 252            "      1. Sync CNIDSs in database with volume\n"
 253            "      2. Make sure .AppleDouble dir exist, create if missing\n"
 254            "      3. Make sure AppleDouble file exists, create if missing\n"
 255            "      4. Delete orphaned AppleDouble files\n"
 256            "      5. Check for directories inside AppleDouble directories\n"
 257            "      6. Check name encoding by roundtripping, log on error\n"
 258            "      7. Check for orphaned CNIDs in database (requires -e)\n"
 259            "      8. Open and close adouble files\n"
 260            "      Options: -c Don't create .AppleDouble stuff, only cleanup orphaned.\n"
 261            "               -f wipe database and rebuild from IDs stored in AppleDouble files,\n"
 262            "                  only available for volumes without 'nocnidcache' option. Implies -e.\n\n"
 263            "   -u Prepare upgrade:\n"
 264            "      Before installing an upgraded version of Netatalk that is linked against\n"
 265            "      a newer BerkeleyDB lib, run `dbd -u ...` from the OLD Netatalk pior to\n"
 266            "      upgrading on all volumes. This removes the BerkleyDB environment.\n"
 267            "      On exit cnid_dbd does this automatically, so normally calling dbd -u should not be necessary.\n\n"
 268            "General options:\n"
 269            "   -e only work on inactive volumes and lock them (exclusive)\n"
 270            "   -x rebuild indexes (just for completeness, mostly useless!)\n"
 271            "   -t show statistics while running\n"
 272            "   -v verbose\n\n"
 273            "WARNING:\n"
 274            "For -r -f restore of the CNID database from the adouble files, the CNID must of course\n"
 275            "be synched to them files first with a plain -r rebuild !\n"
 276         );
 277 }
 278
 279 int main(int argc, char **argv)
 280 {
 281     int c, lockfd, ret = -1;
 282     int dump=0, scan=0, rebuild=0, prep_upgrade=0, rebuildindexes=0, dumpindexes=0, force=0;
 283     dbd_flags_t flags = 0;
 284     char *volpath;
 285     int cdir;
 286
 287     if (geteuid() != 0) {
 288         usage();
 289         exit(EXIT_FAILURE);
 290     }
 291     /* Inhereting perms in ad_mkdir etc requires this */
 292     ad_setfuid(0);
 293
 294     while ((c = getopt(argc, argv, ":cdefinrstuvx")) != -1) {
 295         switch(c) {
 296         case 'c':
 297             flags |= DBD_FLAGS_CLEANUP;
 298             break;
 299         case 'd':
 300             dump = 1;
 301             break;
 302         case 'i':
 303             dumpindexes = 1;
 304             break;
 305         case 's':
 306             scan = 1;
 307             flags |= DBD_FLAGS_SCAN;
 308             break;
 309         case 'n':
 310             nocniddb = 1; /* FIXME: this could/should be a flag too for consistency */
 311             break;
 312         case 'r':
 313             rebuild = 1;
 314             break;
 315         case 't':
 316             flags |= DBD_FLAGS_STATS;
 317             break;
 318         case 'u':
 319             prep_upgrade = 1;
 320             break;
 321         case 'v':
 322             verbose = 1;
 323             break;
 324         case 'e':
 325             exclusive = 1;
 326             flags |= DBD_FLAGS_EXCL;
 327             break;
 328         case 'x':
 329             rebuildindexes = 1;
 330             break;
 331         case 'f':
 332             force = 1;
 333             exclusive = 1;
 334             flags |= DBD_FLAGS_FORCE | DBD_FLAGS_EXCL;
 335             break;
 336         case ':':
 337         case '?':
 338             usage();
 339             exit(EXIT_FAILURE);
 340             break;
 341         }
 342     }
 343
 344     if ((dump + scan + rebuild + prep_upgrade) != 1) {
 345         usage();
 346         exit(EXIT_FAILURE);
 347     }
 348
 349     if ( (optind + 1) != argc ) {
 350         usage();
 351         exit(EXIT_FAILURE);
 352     }
 353     volpath = argv[optind];
 354
 355     setvbuf(stdout, (char *) NULL, _IONBF, 0);
 356
 357     /* Remember cwd */
 358     if ((cdir = open(".", O_RDONLY)) < 0) {
 359         dbd_log( LOGSTD, "Can't open dir: %s", strerror(errno));
 360         exit(EXIT_FAILURE);
 361     }
 362
 363     /* Setup signal handling */
 364     set_signal();
 365
 366     /* Setup logging. Should be portable among *NIXes */
 367     if (!verbose)
 368         setuplog("default log_info /dev/tty");
 369     else
 370         setuplog("default log_debug /dev/tty");
 371
 372     /* Load .volinfo file */
 373     if (loadvolinfo(volpath, &volinfo) == -1) {
 374         dbd_log( LOGSTD, "Not a Netatalk volume at '%s', no .volinfo file at '%s/.AppleDesktop/.volinfo' or unknown volume options", volpath, volpath);
 375         exit(EXIT_FAILURE);
 376     }
 377     if (vol_load_charsets(&volinfo) == -1) {
 378         dbd_log( LOGSTD, "Error loading charsets!");
 379         exit(EXIT_FAILURE);
 380     }
 381
 382     /* Sanity checks to ensure we can touch this volume */
 383     if (volinfo.v_vfs_ea != AFPVOL_EA_AD && volinfo.v_vfs_ea != AFPVOL_EA_SYS) {
 384         dbd_log( LOGSTD, "Unknown Extended Attributes option: %u", volinfo.v_vfs_ea);
 385         exit(EXIT_FAILURE);
 386     }
 387
 388     /* Enuser dbpath is there, create if necessary */
 389     struct stat st;
 390     if (stat(volinfo.v_dbpath, &st) != 0) {
 391         if (errno != ENOENT) {
 392             dbd_log( LOGSTD, "Can't stat dbpath \"%s\": %s", volinfo.v_dbpath, strerror(errno));
 393             exit(EXIT_FAILURE);
 394         }
 395         if ((mkdir(volinfo.v_dbpath, 0755)) != 0) {
 396             dbd_log( LOGSTD, "Can't create dbpath \"%s\": %s", dbpath, strerror(errno));
 397             exit(EXIT_FAILURE);
 398         }
 399     }
 400
 401     /* Put "/.AppleDB" at end of volpath, get path from volinfo file */
 402     if ( (strlen(volinfo.v_dbpath) + strlen("/.AppleDB")) > MAXPATHLEN ) {
 403         dbd_log( LOGSTD, "Volume pathname too long");
 404         exit(EXIT_FAILURE);
 405     }
 406     strncpy(dbpath, volinfo.v_dbpath, MAXPATHLEN - strlen("/.AppleDB"));
 407     strcat(dbpath, "/.AppleDB");
 408
 409     /* Check or create dbpath */
 410     int dbdirfd = open(dbpath, O_RDONLY);
 411     if (dbdirfd == -1 && errno == ENOENT) {
 412         if (errno == ENOENT) {
 413             if ((mkdir(dbpath, 0755)) != 0) {
 414                 dbd_log( LOGSTD, "Can't create .AppleDB for \"%s\": %s", dbpath, strerror(errno));
 415                 exit(EXIT_FAILURE);
 416             }
 417         } else {
 418             dbd_log( LOGSTD, "Somethings wrong with .AppleDB for \"%s\", giving up: %s", dbpath, strerror(errno));
 419             exit(EXIT_FAILURE);
 420         }
 421     } else {
 422         close(dbdirfd);
 423     }
 424
 425     /*
 426        Before we do anything else, check if there is an instance of cnid_dbd
 427        running already and silently exit if yes.
 428     */
 429     lockfd = get_lock(dbpath);
 430
 431     /* Prepare upgrade ? */
 432     if (prep_upgrade) {
 433         if (dbif_env_remove(dbpath))
 434             goto exit_failure;
 435         goto exit_success;
 436     }
 437
 438     /* Check if -f is requested and wipe db if yes */
 439     if ((flags & DBD_FLAGS_FORCE) && rebuild && (volinfo.v_flags & AFPVOL_CACHE)) {
 440         char cmd[8 + MAXPATHLEN];
 441         close(lockfd);
 442         snprintf(cmd, 8 + MAXPATHLEN, "rm -rf \"%s\"", dbpath);
 443         dbd_log( LOGDEBUG, "Removing old database of volume: '%s'", volpath);
 444         system(cmd);
 445         if ((mkdir(dbpath, 0755)) != 0) {
 446             dbd_log( LOGSTD, "Can't create dbpath \"%s\": %s", dbpath, strerror(errno));
 447             exit(EXIT_FAILURE);
 448         }
 449         dbd_log( LOGDEBUG, "Removed old database.");
 450         lockfd = get_lock(dbpath);
 451     }
 452
 453     /*
 454        Lets start with the BerkeleyDB stuff
 455     */
 456     if ( ! nocniddb) {
 457         if ((dbd = dbif_init(dbpath, "cnid2.db")) == NULL)
 458             goto exit_failure;
 459
 460         if (dbif_env_open(dbd, &db_param, exclusive ? (DBOPTIONS | DB_RECOVER) : DBOPTIONS) < 0) {
 461             dbd_log( LOGSTD, "error opening database!");
 462             goto exit_failure;
 463         }
 464
 465         if (exclusive)
 466             dbd_log( LOGDEBUG, "Finished recovery.");
 467
 468         if (dbif_open(dbd, NULL, rebuildindexes) < 0) {
 469             dbif_close(dbd);
 470             goto exit_failure;
 471         }
 472     }
 473
 474     /* Now execute given command scan|rebuild|dump */
 475     if (dump && ! nocniddb) {
 476         if (dbif_dump(dbd, dumpindexes) < 0) {
 477             dbd_log( LOGSTD, "Error dumping database");
 478         }
 479     } else if ((rebuild && ! nocniddb) || scan) {
 480         if (cmd_dbd_scanvol(dbd, &volinfo, flags) < 0) {
 481             dbd_log( LOGSTD, "Error repairing database.");
 482         }
 483     }
 484
 485     /* Cleanup */
 486     dbd_log(LOGDEBUG, "Closing db");
 487     if (! nocniddb) {
 488         if (dbif_close(dbd) < 0) {
 489             dbd_log( LOGSTD, "Error closing database");
 490             goto exit_failure;
 491         }
 492     }
 493
 494 exit_success:
 495     ret = 0;
 496
 497 exit_failure:
 498     free_lock(lockfd);
 499
 500     if ((fchdir(cdir)) < 0)
 501         dbd_log(LOGSTD, "fchdir: %s", strerror(errno));
 502
 503     if (ret == 0)
 504         exit(EXIT_SUCCESS);
 505     else
 506         exit(EXIT_FAILURE);
 507 }