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