2 * Copyright 2006-2007, Sine Nomine Associates and others.
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
12 * online salvager daemon
15 /* Main program file. Define globals. */
18 #include <afsconfig.h>
19 #include <afs/param.h>
23 #ifdef HAVE_SYS_FILE_H
28 #include <WINNT/afsevent.h>
32 #define WCOREDUMP(x) ((x) & 0200)
37 #include <afs/afsint.h>
38 #include <rx/rx_queue.h>
40 #if !defined(AFS_SGI_ENV) && !defined(AFS_NT40_ENV)
41 #if defined(AFS_VFSINCL_ENV)
42 #include <sys/vnode.h>
44 #include <sys/fs/ufs_inode.h>
46 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
47 #include <ufs/ufs/dinode.h>
48 #include <ufs/ffs/fs.h>
50 #include <ufs/inode.h>
53 #else /* AFS_VFSINCL_ENV */
55 #include <ufs/inode.h>
56 #else /* AFS_OSF_ENV */
57 #if !defined(AFS_LINUX20_ENV) && !defined(AFS_XBSD_ENV) && !defined(AFS_DARWIN_ENV)
58 #include <sys/inode.h>
61 #endif /* AFS_VFSINCL_ENV */
62 #endif /* AFS_SGI_ENV */
65 #include <sys/lockf.h>
68 #include <checklist.h>
70 #if defined(AFS_SGI_ENV)
73 #if defined(AFS_SUN_ENV) || defined(AFS_SUN5_ENV)
75 #include <sys/mnttab.h>
76 #include <sys/mntent.h>
81 #endif /* AFS_SGI_ENV */
82 #endif /* AFS_HPUX_ENV */
86 #include <afs/osi_inode.h>
89 #include <afs/afsutil.h>
90 #include <afs/fileutil.h>
91 #include <afs/procmgmt.h> /* signal(), kill(), wait(), etc. */
97 #include <afs/afssyscalls.h>
101 #include "partition.h"
102 #include "daemon_com.h"
104 #include "salvsync.h"
105 #include "viceinode.h"
107 #include "vol-salvage.h"
113 char *logFileName = NULL;
115 #if !defined(AFS_DEMAND_ATTACH_FS)
116 #error "online salvager only supported for demand attach fileserver"
117 #endif /* AFS_DEMAND_ATTACH_FS */
119 #if defined(AFS_NT40_ENV)
120 #error "online salvager not supported on NT"
121 #endif /* AFS_NT40_ENV */
123 /*@+fcnmacros +macrofcndecl@*/
125 #define afs_fopen fopen64
126 #else /* !O_LARGEFILE */
127 #define afs_fopen fopen
128 #endif /* !O_LARGEFILE */
129 /*@=fcnmacros =macrofcndecl@*/
133 static volatile int current_workers = 0;
134 static volatile struct rx_queue pending_q;
135 static pthread_mutex_t worker_lock;
136 static pthread_cond_t worker_cv;
138 static void * SalvageChildReaperThread(void *);
139 static int DoSalvageVolume(struct SalvageQueueNode * node, int slot);
141 static void SalvageServer(int argc, char **argv);
142 static void SalvageClient(VolumeId vid, char * pname);
144 static int Reap_Child(char * prog, int * pid, int * status);
146 static void * SalvageLogCleanupThread(void *);
147 static int SalvageLogCleanup(int pid);
149 static void * SalvageLogScanningThread(void *);
150 static void ScanLogs(struct rx_queue *log_watch_queue);
152 struct cmdline_rock {
157 struct log_cleanup_node {
163 struct rx_queue queue_head;
164 pthread_cond_t queue_change_cv;
168 #define DEFAULT_PARALLELISM 4 /* allow 4 parallel salvage workers by default */
191 handleit(struct cmd_syndesc *opts, void *arock)
194 afs_int32 seenpart = 0, seenvol = 0;
196 struct cmdline_rock *rock = (struct cmdline_rock *)arock;
197 char *optstring = NULL;
199 #ifdef AFS_SGI_VNODE_GLUE
200 if (afs_init_kernel_config(-1) < 0) {
202 ("Can't determine NUMA configuration, not starting salvager.\n");
207 cmd_OptionAsFlag(opts, OPT_debug, &debug);
208 cmd_OptionAsFlag(opts, OPT_nowrite, &Testing);
209 cmd_OptionAsFlag(opts, OPT_inodes, &ListInodeOption);
210 cmd_OptionAsFlag(opts, OPT_oktozap, &OKToZap);
211 cmd_OptionAsFlag(opts, OPT_rootinodes, &ShowRootFiles);
212 cmd_OptionAsFlag(opts, OPT_blockreads, &forceR);
213 if (cmd_OptionAsString(opts, OPT_parallel, &optstring) == 0) {
214 if (strncmp(optstring, "all", 3) == 0) {
217 if (strlen(optstring) != 0) {
218 Parallel = atoi(optstring);
221 if (Parallel > MAXPARALLEL) {
222 printf("Setting parallel salvages to maximum of %d \n",
224 Parallel = MAXPARALLEL;
230 Parallel = min(DEFAULT_PARALLELISM, MAXPARALLEL);
232 if (cmd_OptionAsString(opts, OPT_tmpdir, &optstring) == 0) {
234 dirp = opendir(optstring);
237 ("Can't open temporary placeholder dir %s; using current partition \n",
245 cmd_OptionAsFlag(opts, OPT_showlog, &ShowLog);
246 if (cmd_OptionAsString(opts, OPT_orphans, &optstring) == 0) {
248 orphans = ORPH_IGNORE;
249 else if (strcmp(optstring, "remove") == 0
250 || strcmp(optstring, "r") == 0)
251 orphans = ORPH_REMOVE;
252 else if (strcmp(optstring, "attach") == 0
253 || strcmp(optstring, "a") == 0)
254 orphans = ORPH_ATTACH;
258 #ifndef AFS_NT40_ENV /* ignore options on NT */
259 if (cmd_OptionPresent(opts, OPT_syslog)) {
263 cmd_OptionAsInt(opts, OPT_syslogfacility, &useSyslogFacility);
266 if (cmd_OptionPresent(opts, OPT_client)) {
267 if (cmd_OptionAsString(opts, OPT_partition, &optstring) == 0) {
269 strlcpy(pname, optstring, sizeof(pname));
273 if (cmd_OptionAsString(opts, OPT_volumeid, &optstring) == 0) {
277 vid_l = strtoul(optstring, &end, 10);
278 if (vid_l >= MAX_AFS_UINT32 || vid_l == ULONG_MAX || *end != '\0') {
279 printf("Invalid volume id specified; salvage aborted\n");
282 vid = (VolumeId)vid_l;
286 printf("-showlog does not work with -client\n");
290 if (!seenpart || !seenvol) {
291 printf("You must specify '-partition' and '-volumeid' with the '-client' option\n");
295 SalvageClient(vid, pname);
297 } else { /* salvageserver mode */
298 SalvageServer(rock->argc, rock->argv);
305 #include "AFS_component_version_number.c"
309 char *save_args[MAX_ARGS];
311 pthread_t main_thread;
315 main(int argc, char **argv)
317 struct cmd_syndesc *ts;
319 struct cmdline_rock arock;
323 * The following signal action for AIX is necessary so that in case of a
324 * crash (i.e. core is generated) we can include the user's data section
325 * in the core dump. Unfortunately, by default, only a partial core is
326 * generated which, in many cases, isn't too useful.
328 struct sigaction nsa;
330 sigemptyset(&nsa.sa_mask);
331 nsa.sa_handler = SIG_DFL;
332 nsa.sa_flags = SA_FULLDUMP;
333 sigaction(SIGABRT, &nsa, NULL);
334 sigaction(SIGSEGV, &nsa, NULL);
337 /* Initialize directory paths */
338 if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
340 ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
342 fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
347 /* Default to binary mode for fopen() */
348 _set_fmode(_O_BINARY);
350 main_thread = pthread_self();
351 if (spawnDatap && spawnDataLen) {
352 /* This is a child per partition salvager. Don't setup log or
353 * try to lock the salvager lock.
355 if (nt_SetupPartitionSalvage(spawnDatap, spawnDataLen) < 0)
361 if (geteuid() != 0) {
362 printf("Salvager must be run as root.\n");
368 /* bad for normal help flag processing, but can do nada */
377 logFileName = strdup(AFSDIR_SERVER_SALSRVLOG_FILEPATH);
379 ts = cmd_CreateSyntax("initcmd", handleit, &arock, 0, "initialize the program");
380 cmd_AddParmAtOffset(ts, OPT_partition, "-partition", CMD_SINGLE,
381 CMD_OPTIONAL, "Name of partition to salvage");
382 cmd_AddParmAtOffset(ts, OPT_volumeid, "-volumeid", CMD_SINGLE, CMD_OPTIONAL,
383 "Volume Id to salvage");
384 cmd_AddParmAtOffset(ts, OPT_debug, "-debug", CMD_FLAG, CMD_OPTIONAL,
385 "Run in Debugging mode");
386 cmd_AddParmAtOffset(ts, OPT_nowrite, "-nowrite", CMD_FLAG, CMD_OPTIONAL,
387 "Run readonly/test mode");
388 cmd_AddParmAtOffset(ts, OPT_inodes, "-inodes", CMD_FLAG, CMD_OPTIONAL,
389 "Just list affected afs inodes - debugging flag");
390 cmd_AddParmAtOffset(ts, OPT_oktozap, "-oktozap", CMD_FLAG, CMD_OPTIONAL,
391 "Give permission to destroy bogus inodes/volumes - debugging flag");
392 cmd_AddParmAtOffset(ts, OPT_rootinodes, "-rootinodes", CMD_FLAG,
393 CMD_OPTIONAL, "Show inodes owned by root - debugging flag");
394 cmd_AddParmAtOffset(ts, OPT_salvagedirs, "-salvagedirs", CMD_FLAG,
395 CMD_OPTIONAL, "Force rebuild/salvage of all directories");
396 cmd_AddParmAtOffset(ts, OPT_blockreads, "-blockreads", CMD_FLAG,
397 CMD_OPTIONAL, "Read smaller blocks to handle IO/bad blocks");
398 cmd_AddParmAtOffset(ts, OPT_parallel, "-parallel", CMD_SINGLE, CMD_OPTIONAL,
399 "# of max parallel partition salvaging");
400 cmd_AddParmAtOffset(ts, OPT_tmpdir, "-tmpdir", CMD_SINGLE, CMD_OPTIONAL,
401 "Name of dir to place tmp files ");
402 cmd_AddParmAtOffset(ts, OPT_showlog, "-showlog", CMD_FLAG, CMD_OPTIONAL,
403 "Show log file upon completion");
404 cmd_AddParmAtOffset(ts, OPT_orphans, "-orphans", CMD_SINGLE, CMD_OPTIONAL,
405 "ignore | remove | attach");
407 #if !defined(AFS_NT40_ENV)
408 cmd_AddParmAtOffset(ts, OPT_syslog, "-syslog", CMD_FLAG, CMD_OPTIONAL,
409 "Write salvage log to syslogs");
410 cmd_AddParmAtOffset(ts, OPT_syslogfacility, "-syslogfacility", CMD_SINGLE,
411 CMD_OPTIONAL, "Syslog facility number to use");
414 cmd_AddParmAtOffset(ts, OPT_client, "-client", CMD_FLAG, CMD_OPTIONAL,
415 "Use SALVSYNC to ask salvageserver to salvage a volume");
417 cmd_AddParmAtOffset(ts, OPT_logfile, "-logfile", CMD_SINGLE, CMD_OPTIONAL,
418 "Location of log file ");
420 err = cmd_Dispatch(argc, argv);
422 return 0; /* not reached */
426 SalvageClient(VolumeId vid, char * pname)
431 SALVSYNC_response_hdr sres;
432 VolumePackageOptions opts;
434 VOptDefaults(volumeUtility, &opts);
435 if (VInitVolumePackage2(volumeUtility, &opts)) {
436 /* VInitVolumePackage2 can fail on e.g. partition attachment errors,
437 * but we don't really care, since all we're doing is trying to use
439 fprintf(stderr, "errors encountered initializing volume package, but "
440 "trying to continue anyway\n");
442 SALVSYNC_clientInit();
444 code = SALVSYNC_SalvageVolume(vid, pname, SALVSYNC_SALVAGE, SALVSYNC_OPERATOR, 0, NULL);
445 if (code != SYNC_OK) {
449 res.payload.buf = (void *) &sres;
450 res.payload.len = sizeof(sres);
454 code = SALVSYNC_SalvageVolume(vid, pname, SALVSYNC_QUERY, SALVSYNC_WHATEVER, 0, &res);
455 if (code != SYNC_OK) {
458 switch (sres.state) {
459 case SALVSYNC_STATE_ERROR:
460 printf("salvageserver reports salvage ended in an error; check log files for more details\n");
461 case SALVSYNC_STATE_DONE:
462 case SALVSYNC_STATE_UNKNOWN:
466 SALVSYNC_clientFinis();
470 if (code == SYNC_DENIED) {
471 printf("salvageserver refused to salvage volume %u on partition %s\n",
473 } else if (code == SYNC_BAD_COMMAND) {
474 printf("SALVSYNC protocol mismatch; please make sure fileserver, volserver, salvageserver and salvager are same version\n");
475 } else if (code == SYNC_COM_ERROR) {
476 printf("SALVSYNC communications error\n");
478 SALVSYNC_clientFinis();
482 static int * child_slot;
485 SalvageServer(int argc, char **argv)
488 struct SalvageQueueNode * node;
490 pthread_attr_t attrs;
492 VolumePackageOptions opts;
494 /* All entries to the log will be appended. Useful if there are
495 * multiple salvagers appending to the log.
498 CheckLogFile(logFileName);
500 #ifdef AFS_LINUX20_ENV
501 fcntl(fileno(logFile), F_SETFL, O_APPEND); /* Isn't this redundant? */
503 fcntl(fileno(logFile), F_SETFL, FAPPEND); /* Isn't this redundant? */
508 fprintf(logFile, "%s\n", cml_version_number);
509 LogCommandLine(argc, argv, "Online Salvage Server",
510 SalvageVersion, "Starting OpenAFS", Log);
511 /* Get and hold a lock for the duration of the salvage to make sure
512 * that no other salvage runs at the same time. The routine
513 * VInitVolumePackage2 (called below) makes sure that a file server or
514 * other volume utilities don't interfere with the salvage.
517 /* even demand attach online salvager
518 * still needs this because we don't want
519 * a stand-alone salvager to conflict with
520 * the salvager daemon */
521 ObtainSharedSalvageLock();
523 child_slot = calloc(Parallel, sizeof(int));
524 opr_Assert(child_slot != NULL);
526 /* initialize things */
527 VOptDefaults(salvageServer, &opts);
528 if (VInitVolumePackage2(salvageServer, &opts)) {
529 Log("Shutting down: errors encountered initializing volume package\n");
533 queue_Init(&pending_q);
534 queue_Init(&log_cleanup_queue);
535 opr_mutex_init(&worker_lock);
536 opr_cv_init(&worker_cv);
537 opr_cv_init(&log_cleanup_queue.queue_change_cv);
538 opr_Verify(pthread_attr_init(&attrs) == 0);
540 /* start up the reaper and log cleaner threads */
541 opr_Verify(pthread_attr_setdetachstate(&attrs,
542 PTHREAD_CREATE_DETACHED) == 0);
543 opr_Verify(pthread_create(&tid, &attrs,
544 &SalvageChildReaperThread, NULL) == 0);
545 opr_Verify(pthread_create(&tid, &attrs,
546 &SalvageLogCleanupThread, NULL) == 0);
547 opr_Verify(pthread_create(&tid, &attrs,
548 &SalvageLogScanningThread, NULL) == 0);
550 /* loop forever serving requests */
552 node = SALVSYNC_getWork();
553 opr_Assert(node != NULL);
555 Log("dispatching child to salvage volume %u...\n",
556 node->command.sop.parent);
560 for (slot = 0; slot < Parallel; slot++) {
561 if (!child_slot[slot])
564 opr_Assert (slot < Parallel);
570 ret = DoSalvageVolume(node, slot);
572 } else if (pid < 0) {
573 Log("failed to fork child worker process\n");
577 child_slot[slot] = pid;
581 opr_mutex_enter(&worker_lock);
584 /* let the reaper thread know another worker was spawned */
585 opr_cv_broadcast(&worker_cv);
587 /* if we're overquota, wait for the reaper */
588 while (current_workers >= Parallel) {
589 opr_cv_wait(&worker_cv, &worker_lock);
591 opr_mutex_exit(&worker_lock);
597 DoSalvageVolume(struct SalvageQueueNode * node, int slot)
600 struct DiskPartition64 * partP;
602 /* do not allow further forking inside salvager */
605 /* do not attempt to close parent's logFile handle as
606 * another thread may have held the lock on the FILE
607 * structure when fork was called! */
609 if (asprintf(&childLog, "%s.%d",
610 AFSDIR_SERVER_SLVGLOG_FILEPATH, getpid()) < 0) {
614 logFile = afs_fopen(childLog, "a");
615 if (!logFile) { /* still nothing, use stdout */
622 if (node->command.sop.parent <= 0) {
623 Log("salvageServer: invalid volume id specified; salvage aborted\n");
627 partP = VGetPartition(node->command.sop.partName, 0);
629 Log("salvageServer: Unknown or unmounted partition %s; salvage aborted\n",
630 node->command.sop.partName);
634 /* obtain a shared salvage lock in the child worker, so if the
635 * salvageserver restarts (and we continue), we will still hold a lock and
636 * prevent standalone salvagers from interfering */
637 ObtainSharedSalvageLock();
639 /* Salvage individual volume; don't notify fs */
640 SalvageFileSys1(partP, node->command.sop.parent);
648 SalvageChildReaperThread(void * args)
650 int slot, pid, status;
651 struct log_cleanup_node * cleanup;
653 opr_mutex_enter(&worker_lock);
655 /* loop reaping our children */
657 /* wait() won't block unless we have children, so
658 * block on the cond var if we're childless */
659 while (current_workers == 0) {
660 opr_cv_wait(&worker_cv, &worker_lock);
663 opr_mutex_exit(&worker_lock);
665 cleanup = malloc(sizeof(struct log_cleanup_node));
667 while (Reap_Child("salvageserver", &pid, &status) < 0) {
668 /* try to prevent livelock if something goes wrong */
673 for (slot = 0; slot < Parallel; slot++) {
674 if (child_slot[slot] == pid)
677 opr_Assert(slot < Parallel);
678 child_slot[slot] = 0;
681 SALVSYNC_doneWorkByPid(pid, status);
683 opr_mutex_enter(&worker_lock);
687 queue_Append(&log_cleanup_queue, cleanup);
688 opr_cv_signal(&log_cleanup_queue.queue_change_cv);
691 /* ok, we've reaped a child */
693 opr_cv_broadcast(&worker_cv);
700 Reap_Child(char *prog, int * pid, int * status)
707 if (WCOREDUMP(*status))
708 Log("\"%s\" core dumped!\n", prog);
709 if ((WIFSIGNALED(*status) != 0) ||
710 ((WEXITSTATUS(*status) != 0) &&
711 (WEXITSTATUS(*status) != SALSRV_EXIT_VOLGROUP_LINK)))
712 Log("\"%s\" (pid=%d) terminated abnormally!\n", prog, ret);
714 Log("wait returned -1\n");
720 * thread to combine salvager child logs
721 * back into the main salvageserver log
724 SalvageLogCleanupThread(void * arg)
726 struct log_cleanup_node * cleanup;
728 opr_mutex_enter(&worker_lock);
731 while (queue_IsEmpty(&log_cleanup_queue)) {
732 opr_cv_wait(&log_cleanup_queue.queue_change_cv, &worker_lock);
735 while (queue_IsNotEmpty(&log_cleanup_queue)) {
736 cleanup = queue_First(&log_cleanup_queue, log_cleanup_node);
737 queue_Remove(cleanup);
738 opr_mutex_exit(&worker_lock);
739 SalvageLogCleanup(cleanup->pid);
741 opr_mutex_enter(&worker_lock);
745 opr_mutex_exit(&worker_lock);
749 #define LOG_XFER_BUF_SIZE 65536
751 SalvageLogCleanup(int pid)
755 static char buf[LOG_XFER_BUF_SIZE];
757 if (asprintf(&fn, "%s.%d", AFSDIR_SERVER_SLVGLOG_FILEPATH, pid) < 0)
760 pidlog = open(fn, O_RDONLY);
766 len = read(pidlog, buf, LOG_XFER_BUF_SIZE);
768 fwrite(buf, len, 1, logFile);
769 len = read(pidlog, buf, LOG_XFER_BUF_SIZE);
777 /* wake up every five minutes to see if a non-child salvage has finished */
778 #define SALVAGE_SCAN_POLL_INTERVAL 300
781 * Thread to look for SalvageLog.$pid files that are not from our child
782 * worker salvagers, and notify SalvageLogCleanupThread to clean them
783 * up. This can happen if we restart during salvages, or the
784 * salvageserver crashes or something.
788 * @return always NULL
791 SalvageLogScanningThread(void * arg)
793 struct rx_queue log_watch_queue;
797 queue_Init(&log_watch_queue);
799 prefix_len = asprintf(&prefix, "%s.", AFSDIR_SLVGLOG_FILE);
800 if (prefix_len >= 0) {
804 dp = opendir(AFSDIR_LOGS_DIR);
807 while ((dirp = readdir(dp)) != NULL) {
809 struct log_cleanup_node *cleanup;
812 if (strncmp(dirp->d_name, prefix, prefix_len) != 0) {
813 /* not a salvage logfile; skip */
818 pid = strtol(dirp->d_name + prefix_len, NULL, 10);
821 /* file is SalvageLog.<something> but <something> isn't
827 for (i = 0; i < Parallel; ++i) {
828 if (pid == child_slot[i]) {
834 /* this pid is one of our children, so the reaper thread
835 * will take care of it; skip */
839 cleanup = malloc(sizeof(struct log_cleanup_node));
842 queue_Append(&log_watch_queue, cleanup);
848 ScanLogs(&log_watch_queue);
850 while (queue_IsNotEmpty(&log_watch_queue)) {
851 sleep(SALVAGE_SCAN_POLL_INTERVAL);
852 ScanLogs(&log_watch_queue);
859 * look through log_watch_queue, and if any processes are not still
860 * running, hand them off to the SalvageLogCleanupThread
862 * @param log_watch_queue a queue of PIDs that we should clean up if
866 ScanLogs(struct rx_queue *log_watch_queue)
868 struct log_cleanup_node *cleanup, *next;
870 opr_mutex_enter(&worker_lock);
872 for (queue_Scan(log_watch_queue, cleanup, next, log_cleanup_node)) {
873 /* if a process is still running, assume it's the salvage process
874 * still going, and keep waiting for it */
875 if (kill(cleanup->pid, 0) < 0 && errno == ESRCH) {
876 queue_Remove(cleanup);
877 queue_Append(&log_cleanup_queue, cleanup);
878 opr_cv_signal(&log_cleanup_queue.queue_change_cv);
882 opr_mutex_exit(&worker_lock);