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
  86 static DBD *dbd;
  87 static int verbose;             /* Logging flag */
  88 static int exclusive;           /* Exclusive volume access */
  89 static struct db_param db_param = {
  90     NULL,                       /* Volume dirpath */
  91     1,                          /* bdb logfile autoremove */
  92     64 * 1024,                  /* bdb cachesize (64 MB) */
  93     0,                          /* flush_interval */
  94     0,                          /* flush_frequency */
  95     0,                          /* usock_file */
  96     -1,                         /* fd_table_size */
  97     -1,                         /* idle_timeout */
  98     -1                          /* max_vols */
  99 };
 100 static char dbpath[PATH_MAX];   /* Path to the dbd database */
 101
 102 /*
 103    Provide some logging
 104  */
 105 void dbd_log(enum logtype lt, char *fmt, ...)
 106 {
 107     int len;
 108     static char logbuffer[1024];
 109     va_list args;
 110
 111     if ( (lt == LOGSTD) || (verbose == 1)) {
 112         va_start(args, fmt);
 113         len = vsnprintf(logbuffer, 1023, fmt, args);
 114         va_end(args);
 115         logbuffer[1023] = 0;
 116
 117         printf("%s\n", logbuffer);
 118     }
 119 }
 120
 121 /*
 122    SIGNAL handling:
 123    catch SIGINT and SIGTERM which cause clean exit. Ignore anything else.
 124  */
 125
 126 static void sig_handler(int signo)
 127 {
 128     alarmed = 1;
 129     return;
 130 }
 131
 132 static void set_signal(void)
 133 {
 134     struct sigaction sv;
 135
 136     sv.sa_handler = sig_handler;
 137     sv.sa_flags = SA_RESTART;
 138     sigemptyset(&sv.sa_mask);
 139     if (sigaction(SIGTERM, &sv, NULL) < 0) {
 140         dbd_log( LOGSTD, "error in sigaction(SIGTERM): %s", strerror(errno));
 141         exit(EXIT_FAILURE);
 142     }
 143     if (sigaction(SIGINT, &sv, NULL) < 0) {
 144         dbd_log( LOGSTD, "error in sigaction(SIGINT): %s", strerror(errno));
 145         exit(EXIT_FAILURE);
 146     }
 147
 148     memset(&sv, 0, sizeof(struct sigaction));
 149     sv.sa_handler = SIG_IGN;
 150     sigemptyset(&sv.sa_mask);
 151
 152     if (sigaction(SIGABRT, &sv, NULL) < 0) {
 153         dbd_log( LOGSTD, "error in sigaction(SIGABRT): %s", strerror(errno));
 154         exit(EXIT_FAILURE);
 155     }
 156     if (sigaction(SIGHUP, &sv, NULL) < 0) {
 157         dbd_log( LOGSTD, "error in sigaction(SIGHUP): %s", strerror(errno));
 158         exit(EXIT_FAILURE);
 159     }
 160     if (sigaction(SIGQUIT, &sv, NULL) < 0) {
 161         dbd_log( LOGSTD, "error in sigaction(SIGQUIT): %s", strerror(errno));
 162         exit(EXIT_FAILURE);
 163     }
 164 }
 165
 166 static int get_lock(const char *dbpath)
 167 {
 168     int lockfd;
 169     char lockpath[PATH_MAX];
 170     struct flock lock;
 171     struct stat st;
 172
 173     if ( (strlen(dbpath) + strlen(LOCKFILENAME+1)) > (PATH_MAX - 1) ) {
 174         dbd_log( LOGSTD, ".AppleDB pathname too long");
 175         exit(EXIT_FAILURE);
 176     }
 177     strncpy(lockpath, dbpath, PATH_MAX - 1);
 178     strcat(lockpath, "/");
 179     strcat(lockpath, LOCKFILENAME);
 180
 181     if ((lockfd = open(lockpath, O_RDWR | O_CREAT, 0644)) < 0) {
 182         dbd_log( LOGSTD, "Error opening lockfile: %s", strerror(errno));
 183         exit(EXIT_FAILURE);
 184     }
 185
 186     if ((stat(dbpath, &st)) != 0) {
 187         dbd_log( LOGSTD, "Error statting lockfile: %s", strerror(errno));
 188         exit(EXIT_FAILURE);
 189     }
 190
 191     if ((chown(lockpath, st.st_uid, st.st_gid)) != 0) {
 192         dbd_log( LOGSTD, "Error inheriting lockfile permissions: %s", strerror(errno));
 193         exit(EXIT_FAILURE);
 194     }
 195
 196     lock.l_start  = 0;
 197     lock.l_whence = SEEK_SET;
 198     lock.l_len    = 0;
 199     lock.l_type   = F_WRLCK;
 200
 201     if (fcntl(lockfd, F_SETLK, &lock) < 0) {
 202         if (errno == EACCES || errno == EAGAIN) {
 203             if (exclusive) {
 204                 dbd_log( LOGSTD, "Database is in use and exlusive was requested", strerror(errno));
 205                 exit(EXIT_FAILURE);
 206             };
 207         } else {
 208             dbd_log( LOGSTD, "Error getting fcntl F_WRLCK on lockfile: %s", strerror(errno));
 209             exit(EXIT_FAILURE);
 210        }
 211     }
 212
 213     return lockfd;
 214 }
 215
 216 static void free_lock(int lockfd)
 217 {
 218     struct flock lock;
 219
 220     lock.l_start  = 0;
 221     lock.l_whence = SEEK_SET;
 222     lock.l_len    = 0;
 223     lock.l_type = F_UNLCK;
 224     fcntl(lockfd, F_SETLK, &lock);
 225     close(lockfd);
 226 }
 227
 228 static void usage (void)
 229 {
 230     printf("Usage: dbd [-e|-t|-v|-x] -d [-i] | -s [-c|-n]| -r [-c|-f] | -u <path to netatalk volume>\n"
 231            "dbd can dump, scan, reindex and rebuild Netatalk dbd CNID databases.\n"
 232            "dbd must be run with appropiate permissions i.e. as root.\n\n"
 233            "Main commands are:\n"
 234            "   -d Dump CNID database\n"
 235            "      Option: -i dump indexes too\n\n"
 236            "   -s Scan volume:\n"
 237            "      1. Compare CNIDs in database with volume\n"
 238            "      2. Check if .AppleDouble dirs exist\n"
 239            "      3. Check if  AppleDouble file exist\n"
 240            "      4. Report orphaned AppleDouble files\n"
 241            "      5. Check for directories inside AppleDouble directories\n"
 242            "      6. Check name encoding by roundtripping, log on error\n"
 243            "      7. Check for orphaned CNIDs in database (requires -e)\n"
 244            "      8. Open and close adouble files\n"
 245            "      Options: -c Don't check .AppleDouble stuff, only ckeck orphaned.\n"
 246            "               -n Don't open CNID database, skip CNID checks\n\n"
 247            "   -r Rebuild volume:\n"
 248            "      1. Sync CNIDSs in database with volume\n"
 249            "      2. Make sure .AppleDouble dir exist, create if missing\n"
 250            "      3. Make sure AppleDouble file exists, create if missing\n"
 251            "      4. Delete orphaned AppleDouble files\n"
 252            "      5. Check for directories inside AppleDouble directories\n"
 253            "      6. Check name encoding by roundtripping, log on error\n"
 254            "      7. Check for orphaned CNIDs in database (requires -e)\n"
 255            "      8. Open and close adouble files\n"
 256            "      Options: -c Don't create .AppleDouble stuff, only cleanup orphaned.\n"
 257            "               -f wipe database and rebuild from IDs stored in AppleDouble files,\n"
 258            "                  only available for volumes without 'nocnidcache' option. Implies -e.\n\n"
 259            "   -u Prepare upgrade:\n"
 260            "      Before installing an upgraded version of Netatalk that is linked against\n"
 261            "      a newer BerkeleyDB lib, run `dbd -u ...` from the OLD Netatalk pior to\n"
 262            "      upgrading on all volumes. This removes the BerkleyDB environment.\n"
 263            "      On exit cnid_dbd does this automatically, so normally calling dbd -u should not be necessary.\n\n"
 264            "General options:\n"
 265            "   -e only work on inactive volumes and lock them (exclusive)\n"
 266            "   -x rebuild indexes (just for completeness, mostly useless!)\n"
 267            "   -t show statistics while running\n"
 268            "   -v verbose\n\n"
 269            "WARNING:\n"
 270            "For -r -f restore of the CNID database from the adouble files, the CNID must of course\n"
 271            "be synched to them files first with a plain -r rebuild !\n"
 272         );
 273 }
 274
 275 int main(int argc, char **argv)
 276 {
 277     int c, lockfd, ret = -1;
 278     int dump=0, scan=0, rebuild=0, prep_upgrade=0, rebuildindexes=0, dumpindexes=0, force=0;
 279     dbd_flags_t flags = 0;
 280     char *volpath;
 281     struct volinfo volinfo;
 282     int cdir;
 283
 284     if (geteuid() != 0) {
 285         usage();
 286         exit(EXIT_FAILURE);
 287     }
 288     /* Inhereting perms in ad_mkdir etc requires this */
 289     ad_setfuid(0);
 290
 291     while ((c = getopt(argc, argv, ":cdefinrstuvx")) != -1) {
 292         switch(c) {
 293         case 'c':
 294             flags |= DBD_FLAGS_CLEANUP;
 295             break;
 296         case 'd':
 297             dump = 1;
 298             break;
 299         case 'i':
 300             dumpindexes = 1;
 301             break;
 302         case 's':
 303             scan = 1;
 304             flags |= DBD_FLAGS_SCAN;
 305             break;
 306         case 'n':
 307             nocniddb = 1; /* FIXME: this could/should be a flag too for consistency */
 308             break;
 309         case 'r':
 310             rebuild = 1;
 311             break;
 312         case 't':
 313             flags |= DBD_FLAGS_STATS;
 314             break;
 315         case 'u':
 316             prep_upgrade = 1;
 317             break;
 318         case 'v':
 319             verbose = 1;
 320             break;
 321         case 'e':
 322             exclusive = 1;
 323             flags |= DBD_FLAGS_EXCL;
 324             break;
 325         case 'x':
 326             rebuildindexes = 1;
 327             break;
 328         case 'f':
 329             force = 1;
 330             exclusive = 1;
 331             flags |= DBD_FLAGS_FORCE | DBD_FLAGS_EXCL;
 332             break;
 333         case ':':
 334         case '?':
 335             usage();
 336             exit(EXIT_FAILURE);
 337             break;
 338         }
 339     }
 340
 341     if ((dump + scan + rebuild + prep_upgrade) != 1) {
 342         usage();
 343         exit(EXIT_FAILURE);
 344     }
 345
 346     if ( (optind + 1) != argc ) {
 347         usage();
 348         exit(EXIT_FAILURE);
 349     }
 350     volpath = argv[optind];
 351
 352     setvbuf(stdout, (char *) NULL, _IONBF, 0);
 353
 354     /* Remember cwd */
 355     if ((cdir = open(".", O_RDONLY)) < 0) {
 356         dbd_log( LOGSTD, "Can't open dir: %s", strerror(errno));
 357         exit(EXIT_FAILURE);
 358     }
 359
 360     /* Setup signal handling */
 361     set_signal();
 362
 363     /* Setup logging. Should be portable among *NIXes */
 364     if (!verbose)
 365         setuplog("default log_info /dev/tty");
 366     else
 367         setuplog("default log_debug /dev/tty");
 368
 369     /* Load .volinfo file */
 370     if (loadvolinfo(volpath, &volinfo) == -1) {
 371         dbd_log( LOGSTD, "Not a Netatalk volume at '%s', no .volinfo file at '%s/.AppleDesktop/.volinfo' or unknown volume options", volpath, volpath);
 372         exit(EXIT_FAILURE);
 373     }
 374     if (vol_load_charsets(&volinfo) == -1) {
 375         dbd_log( LOGSTD, "Error loading charsets!");
 376         exit(EXIT_FAILURE);
 377     }
 378
 379     /* Sanity checks to ensure we can touch this volume */
 380     if (volinfo.v_vfs_ea != AFPVOL_EA_AD && volinfo.v_vfs_ea != AFPVOL_EA_SYS) {
 381         dbd_log( LOGSTD, "Unknown Extended Attributes option: %u", volinfo.v_vfs_ea);
 382         exit(EXIT_FAILURE);
 383     }
 384
 385     /* Put "/.AppleDB" at end of volpath, get path from volinfo file */
 386     if ( (strlen(volinfo.v_dbpath) + strlen("/.AppleDB")) > (PATH_MAX - 1) ) {
 387         dbd_log( LOGSTD, "Volume pathname too long");
 388         exit(EXIT_FAILURE);
 389     }
 390     strncpy(dbpath, volinfo.v_dbpath, PATH_MAX - 9 - 1);
 391     strcat(dbpath, "/.AppleDB");
 392
 393     /* Check or create dbpath */
 394     int dbdirfd = open(dbpath, O_RDONLY);
 395     if (dbdirfd == -1 && errno == ENOENT) {
 396         if (errno == ENOENT) {
 397             if ((mkdir(dbpath, 0755)) != 0) {
 398                 dbd_log( LOGSTD, "Can't create .AppleDB for \"%s\": %s", dbpath, strerror(errno));
 399                 exit(EXIT_FAILURE);
 400             }
 401         } else {
 402             dbd_log( LOGSTD, "Somethings wrong with .AppleDB for \"%s\", giving up: %s", dbpath, strerror(errno));
 403             exit(EXIT_FAILURE);
 404         }
 405     } else {
 406         close(dbdirfd);
 407     }
 408
 409     /*
 410        Before we do anything else, check if there is an instance of cnid_dbd
 411        running already and silently exit if yes.
 412     */
 413     lockfd = get_lock(dbpath);
 414
 415     /* Prepare upgrade ? */
 416     if (prep_upgrade) {
 417         if (dbif_prep_upgrade(dbpath))
 418             goto exit_failure;
 419         goto exit_success;
 420     }
 421
 422     /* Check if -f is requested and wipe db if yes */
 423     if ((flags & DBD_FLAGS_FORCE) && rebuild && (volinfo.v_flags & AFPVOL_CACHE)) {
 424         char cmd[8 + MAXPATHLEN];
 425         close(lockfd);
 426         snprintf(cmd, 8 + MAXPATHLEN, "rm -f %s/*", dbpath);
 427         dbd_log( LOGDEBUG, "Removing old database of volume: '%s'", volpath);
 428         system(cmd);
 429         dbd_log( LOGDEBUG, "Removed old database.");
 430         lockfd = get_lock(dbpath);
 431     }
 432
 433     /*
 434        Lets start with the BerkeleyDB stuff
 435     */
 436     if ( ! nocniddb) {
 437         if ((dbd = dbif_init(dbpath, "cnid2.db")) == NULL)
 438             goto exit_failure;
 439
 440         if (dbif_env_open(dbd, &db_param, exclusive ? (DBOPTIONS | DB_RECOVER) : DBOPTIONS) < 0) {
 441             dbd_log( LOGSTD, "error opening database!");
 442             goto exit_failure;
 443         }
 444
 445         if (exclusive)
 446             dbd_log( LOGDEBUG, "Finished recovery.");
 447
 448         if (dbif_open(dbd, NULL, rebuildindexes) < 0) {
 449             dbif_close(dbd);
 450             goto exit_failure;
 451         }
 452
 453         if (dbd_stamp(dbd) < 0) {
 454             dbif_close(dbd);
 455             goto exit_failure;
 456         }
 457     }
 458
 459     /* Now execute given command scan|rebuild|dump */
 460     if (dump && ! nocniddb) {
 461         if (dbif_dump(dbd, dumpindexes) < 0) {
 462             dbd_log( LOGSTD, "Error dumping database");
 463         }
 464     } else if ((rebuild && ! nocniddb) || scan) {
 465         if (cmd_dbd_scanvol(dbd, &volinfo, flags) < 0) {
 466             dbd_log( LOGSTD, "Error repairing database.");
 467         }
 468     }
 469
 470     /* Cleanup */
 471     dbd_log(LOGDEBUG, "Closing db");
 472     if (! nocniddb) {
 473         if (dbif_close(dbd) < 0) {
 474             dbd_log( LOGSTD, "Error closing database");
 475             goto exit_failure;
 476         }
 477     }
 478
 479 exit_success:
 480     ret = 0;
 481
 482 exit_failure:
 483     free_lock(lockfd);
 484
 485     if ((fchdir(cdir)) < 0)
 486         dbd_log(LOGSTD, "fchdir: %s", strerror(errno));
 487
 488     if (ret == 0)
 489         exit(EXIT_SUCCESS);
 490     else
 491         exit(EXIT_FAILURE);
 492 }