src/vol/salvager.c

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  */
   9
  10 /*
  11  *      System:         VICE-TWO
  12  *      Module:         salvager.c
  13  *      Institution:    The Information Technology Center, Carnegie-Mellon University
  14  */
  15
  16
  17 /* Main program file. Define globals. */
  18 #define MAIN 1
  19
  20 #include <afsconfig.h>
  21 #include <afs/param.h>
  22
  23
  24 #include <stdlib.h>
  25 #include <stdio.h>
  26 #include <string.h>
  27 #include <dirent.h>
  28 #include <sys/stat.h>
  29 #include <time.h>
  30 #include <errno.h>
  31 #ifdef AFS_NT40_ENV
  32 #include <io.h>
  33 #include <WINNT/afsevent.h>
  34 #else
  35 #include <sys/param.h>
  36 #include <sys/file.h>
  37 #ifndef ITIMER_REAL
  38 #include <sys/time.h>
  39 #endif /* ITIMER_REAL */
  40 #endif
  41 #ifndef WCOREDUMP
  42 #define WCOREDUMP(x)    ((x) & 0200)
  43 #endif
  44 #include <rx/xdr.h>
  45 #include <afs/afsint.h>
  46 #include <afs/assert.h>
  47 #if !defined(AFS_SGI_ENV) && !defined(AFS_NT40_ENV)
  48 #if defined(AFS_VFSINCL_ENV)
  49 #include <sys/vnode.h>
  50 #ifdef  AFS_SUN5_ENV
  51 #include <sys/fs/ufs_inode.h>
  52 #else
  53 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
  54 #include <ufs/ufs/dinode.h>
  55 #include <ufs/ffs/fs.h>
  56 #else
  57 #include <ufs/inode.h>
  58 #endif
  59 #endif
  60 #else /* AFS_VFSINCL_ENV */
  61 #ifdef  AFS_OSF_ENV
  62 #include <ufs/inode.h>
  63 #else /* AFS_OSF_ENV */
  64 #if !defined(AFS_LINUX20_ENV) && !defined(AFS_XBSD_ENV)
  65 #include <sys/inode.h>
  66 #endif
  67 #endif
  68 #endif /* AFS_VFSINCL_ENV */
  69 #endif /* AFS_SGI_ENV */
  70 #ifdef  AFS_AIX_ENV
  71 #include <sys/vfs.h>
  72 #include <sys/lockf.h>
  73 #else
  74 #ifdef  AFS_HPUX_ENV
  75 #include <unistd.h>
  76 #include <checklist.h>
  77 #else
  78 #if defined(AFS_SGI_ENV)
  79 #include <unistd.h>
  80 #include <fcntl.h>
  81 #include <mntent.h>
  82 #else
  83 #if     defined(AFS_SUN_ENV) || defined(AFS_SUN5_ENV)
  84 #ifdef    AFS_SUN5_ENV
  85 #include <unistd.h>
  86 #include <sys/mnttab.h>
  87 #include <sys/mntent.h>
  88 #else
  89 #include <mntent.h>
  90 #endif
  91 #else
  92 #endif /* AFS_SGI_ENV */
  93 #endif /* AFS_HPUX_ENV */
  94 #endif
  95 #endif
  96 #include <fcntl.h>
  97 #ifndef AFS_NT40_ENV
  98 #include <afs/osi_inode.h>
  99 #endif
 100 #include <afs/cmd.h>
 101 #include <afs/dir.h>
 102 #include <afs/afsutil.h>
 103 #include <afs/fileutil.h>
 104 #include <afs/procmgmt.h>       /* signal(), kill(), wait(), etc. */
 105 #ifndef AFS_NT40_ENV
 106 #include <syslog.h>
 107 #endif
 108
 109 #include "nfs.h"
 110 #include "lwp.h"
 111 #include "lock.h"
 112 #include <afs/afssyscalls.h>
 113 #include "ihandle.h"
 114 #include "vnode.h"
 115 #include "volume.h"
 116 #include "partition.h"
 117 #include "daemon_com.h"
 118 #include "fssync.h"
 119 #include "salvsync.h"
 120 #include "viceinode.h"
 121 #include "salvage.h"
 122 #include "vol-salvage.h"
 123 #ifdef AFS_NT40_ENV
 124 #include <pthread.h>
 125 pthread_t main_thread;
 126 #endif
 127
 128
 129 static int get_salvage_lock = 0;
 130
 131
 132 /* Forward declarations */
 133 /*@printflike@*/ void Log(const char *format, ...);
 134 /*@printflike@*/ void Abort(const char *format, ...);
 135
 136
 137 static int
 138 handleit(struct cmd_syndesc *as, void *arock)
 139 {
 140     register struct cmd_item *ti;
 141     char pname[100], *temp;
 142     afs_int32 seenpart = 0, seenvol = 0, vid = 0;
 143     ProgramType pt;
 144
 145 #ifdef FAST_RESTART
 146     afs_int32  seenany = 0;
 147 #endif
 148
 149     VolumePackageOptions opts;
 150     struct DiskPartition64 *partP;
 151
 152 #ifdef AFS_SGI_VNODE_GLUE
 153     if (afs_init_kernel_config(-1) < 0) {
 154         printf
 155             ("Can't determine NUMA configuration, not starting salvager.\n");
 156         exit(1);
 157     }
 158 #endif
 159
 160 #ifdef FAST_RESTART
 161     {
 162         afs_int32 i;
 163         for (i = 0; i < CMD_MAXPARMS; i++) {
 164             if (as->parms[i].items) {
 165                 seenany = 1;
 166                 break;
 167             }
 168         }
 169     }
 170     if (!seenany) {
 171         char *msg =
 172             "Exiting immediately without salvage. Look into the FileLog to find volumes which really need to be salvaged!";
 173
 174         if (useSyslog)
 175             Log(msg);
 176         else
 177             printf("%s\n", msg);
 178
 179         Exit(0);
 180     }
 181 #endif /* FAST_RESTART */
 182     if ((ti = as->parms[0].items)) {    /* -partition */
 183         seenpart = 1;
 184         strncpy(pname, ti->data, 100);
 185     }
 186     if ((ti = as->parms[1].items)) {    /* -volumeid */
 187         if (!seenpart) {
 188             printf
 189                 ("You must also specify '-partition' option with the '-volumeid' option\n");
 190             exit(-1);
 191         }
 192         seenvol = 1;
 193         vid = atoi(ti->data);
 194     }
 195     if (as->parms[2].items)     /* -debug */
 196         debug = 1;
 197     if (as->parms[3].items)     /* -nowrite */
 198         Testing = 1;
 199     if (as->parms[4].items)     /* -inodes */
 200         ListInodeOption = 1;
 201     if (as->parms[5].items)     /* -force */
 202         ForceSalvage = 1;
 203     if (as->parms[6].items)     /* -oktozap */
 204         OKToZap = 1;
 205     if (as->parms[7].items)     /* -rootinodes */
 206         ShowRootFiles = 1;
 207     if (as->parms[8].items)     /* -RebuildDirs */
 208         RebuildDirs = 1;
 209     if (as->parms[9].items)     /* -ForceReads */
 210         forceR = 1;
 211     if ((ti = as->parms[10].items)) {   /* -Parallel # */
 212         temp = ti->data;
 213         if (strncmp(temp, "all", 3) == 0) {
 214             PartsPerDisk = 1;
 215             temp += 3;
 216         }
 217         if (strlen(temp) != 0) {
 218             Parallel = atoi(temp);
 219             if (Parallel < 1)
 220                 Parallel = 1;
 221             if (Parallel > MAXPARALLEL) {
 222                 printf("Setting parallel salvages to maximum of %d \n",
 223                        MAXPARALLEL);
 224                 Parallel = MAXPARALLEL;
 225             }
 226         }
 227     }
 228     if ((ti = as->parms[11].items)) {   /* -tmpdir */
 229         DIR *dirp;
 230
 231         tmpdir = ti->data;
 232         dirp = opendir(tmpdir);
 233         if (!dirp) {
 234             printf
 235                 ("Can't open temporary placeholder dir %s; using current partition \n",
 236                  tmpdir);
 237             tmpdir = NULL;
 238         } else
 239             closedir(dirp);
 240     }
 241     if ((ti = as->parms[12].items))     /* -showlog */
 242         ShowLog = 1;
 243     if ((ti = as->parms[13].items)) {   /* -log */
 244         Testing = 1;
 245         ShowSuid = 1;
 246         Showmode = 1;
 247     }
 248     if ((ti = as->parms[14].items)) {   /* -showmounts */
 249         Testing = 1;
 250         Showmode = 1;
 251         ShowMounts = 1;
 252     }
 253     if ((ti = as->parms[15].items)) {   /* -orphans */
 254         if (Testing)
 255             orphans = ORPH_IGNORE;
 256         else if (strcmp(ti->data, "remove") == 0
 257                  || strcmp(ti->data, "r") == 0)
 258             orphans = ORPH_REMOVE;
 259         else if (strcmp(ti->data, "attach") == 0
 260                  || strcmp(ti->data, "a") == 0)
 261             orphans = ORPH_ATTACH;
 262     }
 263 #ifndef AFS_NT40_ENV            /* ignore options on NT */
 264     if ((ti = as->parms[16].items)) {   /* -syslog */
 265         useSyslog = 1;
 266         ShowLog = 0;
 267     }
 268     if ((ti = as->parms[17].items)) {   /* -syslogfacility */
 269         useSyslogFacility = atoi(ti->data);
 270     }
 271
 272     if ((ti = as->parms[18].items)) {   /* -datelogs */
 273       TimeStampLogFile((char *)AFSDIR_SERVER_SLVGLOG_FILEPATH);
 274     }
 275 #endif
 276
 277 #ifdef FAST_RESTART
 278     if (ti = as->parms[19].items) {     /* -DontSalvage */
 279         char *msg =
 280             "Exiting immediately without salvage. Look into the FileLog to find volumes which really need to be salvaged!";
 281
 282         if (useSyslog)
 283             Log(msg);
 284         else
 285             printf("%s\n", msg);
 286         Exit(0);
 287     }
 288 #elif defined(DEMAND_ATTACH_ENABLE)
 289     if (seenvol && !as->parms[19].items) {
 290         char * msg =
 291             "The standalone salvager cannot be run concurrently with a Demand Attach Fileserver.  Please use 'salvageserver -client <partition> <volume id>' to manually schedule volume salvages with the salvageserver (new versions of 'bos salvage' automatically do this for you).  Or, if you insist on using the standalone salvager, add the -forceDAFS flag to your salvager command line.";
 292
 293         if (useSyslog)
 294             Log(msg);
 295         else
 296             printf("%s\n", msg);
 297         Exit(1);
 298     }
 299 #endif
 300
 301     if (get_salvage_lock) {
 302         ObtainSalvageLock();
 303     }
 304
 305     /* Note:  if seenvol we initialize this as a standard volume utility:  this has the
 306      * implication that the file server may be running; negotations have to be made with
 307      * the file server in this case to take the read write volume and associated read-only
 308      * volumes off line before salvaging */
 309 #ifdef AFS_NT40_ENV
 310     if (seenvol) {
 311         if (afs_winsockInit() < 0) {
 312             ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0,
 313                                 AFSDIR_SALVAGER_FILE, 0);
 314             Log("Failed to initailize winsock, exiting.\n");
 315             Exit(1);
 316         }
 317     }
 318 #endif
 319
 320     if (seenvol) {
 321         pt = volumeSalvager;
 322     } else {
 323         pt = salvager;
 324     }
 325
 326     VOptDefaults(pt, &opts);
 327     VInitVolumePackage2(pt, &opts);
 328     DInit(10);
 329 #ifdef AFS_NT40_ENV
 330     if (myjob.cj_number != NOT_CHILD) {
 331         if (!seenpart) {
 332             seenpart = 1;
 333             (void)strcpy(pname, myjob.cj_part);
 334         }
 335     }
 336 #endif
 337     if (seenpart == 0) {
 338         for (partP = DiskPartitionList; partP; partP = partP->next) {
 339             SalvageFileSysParallel(partP);
 340         }
 341         SalvageFileSysParallel(0);
 342     } else {
 343         partP = VGetPartition(pname, 0);
 344         if (!partP) {
 345             Log("salvage: Unknown or unmounted partition %s; salvage aborted\n", pname);
 346             Exit(1);
 347         }
 348         if (!seenvol)
 349             SalvageFileSys(partP, 0);
 350         else {
 351             /* Salvage individual volume */
 352             if (vid <= 0) {
 353                 Log("salvage: invalid volume id specified; salvage aborted\n");
 354                 Exit(1);
 355             }
 356             SalvageFileSys(partP, vid);
 357         }
 358     }
 359     return (0);
 360 }
 361
 362
 363 #ifndef AFS_NT40_ENV
 364 #include "AFS_component_version_number.c"
 365 #endif
 366
 367 int
 368 main(int argc, char **argv)
 369 {
 370     struct cmd_syndesc *ts;
 371     int err = 0;
 372     char commandLine[150];
 373
 374     int i;
 375     extern char cml_version_number[];
 376
 377 #ifdef  AFS_AIX32_ENV
 378     /*
 379      * The following signal action for AIX is necessary so that in case of a
 380      * crash (i.e. core is generated) we can include the user's data section
 381      * in the core dump. Unfortunately, by default, only a partial core is
 382      * generated which, in many cases, isn't too useful.
 383      */
 384     struct sigaction nsa;
 385
 386     sigemptyset(&nsa.sa_mask);
 387     nsa.sa_handler = SIG_DFL;
 388     nsa.sa_flags = SA_FULLDUMP;
 389     sigaction(SIGABRT, &nsa, NULL);
 390     sigaction(SIGSEGV, &nsa, NULL);
 391 #endif
 392
 393     /* Initialize directory paths */
 394     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
 395 #ifdef AFS_NT40_ENV
 396         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
 397 #endif
 398         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
 399                 argv[0]);
 400         exit(2);
 401     }
 402 #ifdef AFS_NT40_ENV
 403     main_thread = pthread_self();
 404     if (spawnDatap && spawnDataLen) {
 405         /* This is a child per partition salvager. Don't setup log or
 406          * try to lock the salvager lock.
 407          */
 408         if (nt_SetupPartitionSalvage(spawnDatap, spawnDataLen) < 0)
 409             exit(3);
 410     } else {
 411 #endif
 412         for (commandLine[0] = '\0', i = 0; i < argc; i++) {
 413             if (i > 0)
 414                 strcat(commandLine, " ");
 415             strcat(commandLine, argv[i]);
 416         }
 417
 418         /* All entries to the log will be appended.  Useful if there are
 419          * multiple salvagers appending to the log.
 420          */
 421
 422         CheckLogFile((char *)AFSDIR_SERVER_SLVGLOG_FILEPATH);
 423 #ifndef AFS_NT40_ENV
 424 #ifdef AFS_LINUX20_ENV
 425         fcntl(fileno(logFile), F_SETFL, O_APPEND);      /* Isn't this redundant? */
 426 #else
 427         fcntl(fileno(logFile), F_SETFL, FAPPEND);       /* Isn't this redundant? */
 428 #endif
 429 #endif
 430         setlinebuf(logFile);
 431
 432 #ifndef AFS_NT40_ENV
 433         if (geteuid() != 0) {
 434             printf("Salvager must be run as root.\n");
 435             fflush(stdout);
 436             Exit(0);
 437         }
 438 #endif
 439
 440         /* bad for normal help flag processing, but can do nada */
 441
 442         fprintf(logFile, "%s\n", cml_version_number);
 443         Log("STARTING AFS SALVAGER %s (%s)\n", SalvageVersion, commandLine);
 444
 445         /* Get and hold a lock for the duration of the salvage to make sure
 446          * that no other salvage runs at the same time.  The routine
 447          * VInitVolumePackage2 (called below) makes sure that a file server or
 448          * other volume utilities don't interfere with the salvage.
 449          */
 450         get_salvage_lock = 1;
 451 #ifdef AFS_NT40_ENV
 452     }
 453 #endif
 454
 455     ts = cmd_CreateSyntax("initcmd", handleit, NULL, "initialize the program");
 456     cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_OPTIONAL,
 457                 "Name of partition to salvage");
 458     cmd_AddParm(ts, "-volumeid", CMD_SINGLE, CMD_OPTIONAL,
 459                 "Volume Id to salvage");
 460     cmd_AddParm(ts, "-debug", CMD_FLAG, CMD_OPTIONAL,
 461                 "Run in Debugging mode");
 462     cmd_AddParm(ts, "-nowrite", CMD_FLAG, CMD_OPTIONAL,
 463                 "Run readonly/test mode");
 464     cmd_AddParm(ts, "-inodes", CMD_FLAG, CMD_OPTIONAL,
 465                 "Just list affected afs inodes - debugging flag");
 466     cmd_AddParm(ts, "-force", CMD_FLAG, CMD_OPTIONAL, "Force full salvaging");
 467     cmd_AddParm(ts, "-oktozap", CMD_FLAG, CMD_OPTIONAL,
 468                 "Give permission to destroy bogus inodes/volumes - debugging flag");
 469     cmd_AddParm(ts, "-rootinodes", CMD_FLAG, CMD_OPTIONAL,
 470                 "Show inodes owned by root - debugging flag");
 471     cmd_AddParm(ts, "-salvagedirs", CMD_FLAG, CMD_OPTIONAL,
 472                 "Force rebuild/salvage of all directories");
 473     cmd_AddParm(ts, "-blockreads", CMD_FLAG, CMD_OPTIONAL,
 474                 "Read smaller blocks to handle IO/bad blocks");
 475     cmd_AddParm(ts, "-parallel", CMD_SINGLE, CMD_OPTIONAL,
 476                 "# of max parallel partition salvaging");
 477     cmd_AddParm(ts, "-tmpdir", CMD_SINGLE, CMD_OPTIONAL,
 478                 "Name of dir to place tmp files ");
 479     cmd_AddParm(ts, "-showlog", CMD_FLAG, CMD_OPTIONAL,
 480                 "Show log file upon completion");
 481     cmd_AddParm(ts, "-showsuid", CMD_FLAG, CMD_OPTIONAL,
 482                 "Report on suid/sgid files");
 483     cmd_AddParm(ts, "-showmounts", CMD_FLAG, CMD_OPTIONAL,
 484                 "Report on mountpoints");
 485     cmd_AddParm(ts, "-orphans", CMD_SINGLE, CMD_OPTIONAL,
 486                 "ignore | remove | attach");
 487
 488     /* note - syslog isn't avail on NT, but if we make it conditional, have
 489      * to deal with screwy offsets for cmd params */
 490     cmd_AddParm(ts, "-syslog", CMD_FLAG, CMD_OPTIONAL,
 491                 "Write salvage log to syslogs");
 492     cmd_AddParm(ts, "-syslogfacility", CMD_SINGLE, CMD_OPTIONAL,
 493                 "Syslog facility number to use");
 494     cmd_AddParm(ts, "-datelogs", CMD_FLAG, CMD_OPTIONAL,
 495                 "Include timestamp in logfile filename");
 496 #ifdef FAST_RESTART
 497     cmd_AddParm(ts, "-DontSalvage", CMD_FLAG, CMD_OPTIONAL,
 498                 "Don't salvage. This my be set in BosConfig to let the fileserver restart immediately after a crash. Bad volumes will be taken offline");
 499 #elif defined(DEMAND_ATTACH_ENABLE)
 500     cmd_AddParm(ts, "-forceDAFS", CMD_FLAG, CMD_OPTIONAL,
 501                 "For Demand Attach Fileserver, permit a manual volume salvage outside of the salvageserver");
 502 #endif /* FAST_RESTART */
 503     err = cmd_Dispatch(argc, argv);
 504     Exit(err);
 505     return 0; /* not reached */
 506 }
 507