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>
31 #include <WINNT/afsevent.h>
33 #include <sys/param.h>
37 #endif /* ITIMER_REAL */
39 #if defined(AFS_AIX_ENV) || defined(AFS_SUN4_ENV)
40 #define WCOREDUMP(x) (x & 0200)
43 #include <afs/afsint.h>
44 #include <afs/assert.h>
45 #if !defined(AFS_SGI_ENV) && !defined(AFS_NT40_ENV)
46 #if defined(AFS_VFSINCL_ENV)
47 #include <sys/vnode.h>
49 #include <sys/fs/ufs_inode.h>
51 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
52 #include <ufs/ufs/dinode.h>
53 #include <ufs/ffs/fs.h>
55 #include <ufs/inode.h>
58 #else /* AFS_VFSINCL_ENV */
60 #include <ufs/inode.h>
61 #else /* AFS_OSF_ENV */
62 #if !defined(AFS_LINUX20_ENV) && !defined(AFS_XBSD_ENV)
63 #include <sys/inode.h>
66 #endif /* AFS_VFSINCL_ENV */
67 #endif /* AFS_SGI_ENV */
70 #include <sys/lockf.h>
74 #include <checklist.h>
76 #if defined(AFS_SGI_ENV)
81 #if defined(AFS_SUN_ENV) || defined(AFS_SUN5_ENV)
84 #include <sys/mnttab.h>
85 #include <sys/mntent.h>
90 #endif /* AFS_SGI_ENV */
91 #endif /* AFS_HPUX_ENV */
96 #include <afs/osi_inode.h>
99 #include <afs/afsutil.h>
100 #include <afs/fileutil.h>
101 #include <afs/procmgmt.h> /* signal(), kill(), wait(), etc. */
109 #include <afs/afssyscalls.h>
113 #include "partition.h"
114 #include "daemon_com.h"
116 #include "salvsync.h"
117 #include "viceinode.h"
119 #include "volinodes.h" /* header magic number, etc. stuff */
120 #include "vol-salvage.h"
126 #if !defined(AFS_DEMAND_ATTACH_FS)
127 #error "online salvager only supported for demand attach fileserver"
128 #endif /* AFS_DEMAND_ATTACH_FS */
130 #if defined(AFS_NT40_ENV)
131 #error "online salvager not supported on NT"
132 #endif /* AFS_NT40_ENV */
135 /* Forward declarations */
136 /*@printflike@*/ void Log(const char *format, ...);
137 /*@printflike@*/ void Abort(const char *format, ...);
140 /*@+fcnmacros +macrofcndecl@*/
142 #define afs_fopen fopen64
143 #else /* !O_LARGEFILE */
144 #define afs_fopen fopen
145 #endif /* !O_LARGEFILE */
146 /*@=fcnmacros =macrofcndecl@*/
150 static volatile int current_workers = 0;
151 static volatile struct rx_queue pending_q;
152 static pthread_mutex_t worker_lock;
153 static pthread_cond_t worker_cv;
155 static void * SalvageChildReaperThread(void *);
156 static int DoSalvageVolume(struct SalvageQueueNode * node, int slot);
158 static void SalvageServer(void);
159 static void SalvageClient(VolumeId vid, char * pname);
161 static int ChildFailed(int status);
163 static int Reap_Child(char * prog, int * pid, int * status);
165 static void * SalvageLogCleanupThread(void *);
166 static int SalvageLogCleanup(int pid);
168 struct log_cleanup_node {
174 struct rx_queue queue_head;
175 pthread_cond_t queue_change_cv;
179 #define DEFAULT_PARALLELISM 4 /* allow 4 parallel salvage workers by default */
182 handleit(struct cmd_syndesc *as, void *arock)
184 register struct cmd_item *ti;
185 char pname[100], *temp;
186 afs_int32 seenpart = 0, seenvol = 0, vid = 0, seenany = 0;
187 struct DiskPartition64 *partP;
190 #ifdef AFS_SGI_VNODE_GLUE
191 if (afs_init_kernel_config(-1) < 0) {
193 ("Can't determine NUMA configuration, not starting salvager.\n");
198 if (as->parms[2].items) /* -debug */
200 if (as->parms[3].items) /* -nowrite */
202 if (as->parms[4].items) /* -inodes */
204 if (as->parms[5].items) /* -oktozap */
206 if (as->parms[6].items) /* -rootinodes */
208 if (as->parms[8].items) /* -ForceReads */
210 if ((ti = as->parms[9].items)) { /* -Parallel # */
212 if (strncmp(temp, "all", 3) == 0) {
216 if (strlen(temp) != 0) {
217 Parallel = atoi(temp);
220 if (Parallel > MAXPARALLEL) {
221 printf("Setting parallel salvages to maximum of %d \n",
223 Parallel = MAXPARALLEL;
227 Parallel = MIN(DEFAULT_PARALLELISM, MAXPARALLEL);
229 if ((ti = as->parms[10].items)) { /* -tmpdir */
233 dirp = opendir(tmpdir);
236 ("Can't open temporary placeholder dir %s; using current partition \n",
242 if ((ti = as->parms[11].items)) /* -showlog */
244 if ((ti = as->parms[12].items)) { /* -orphans */
246 orphans = ORPH_IGNORE;
247 else if (strcmp(ti->data, "remove") == 0
248 || strcmp(ti->data, "r") == 0)
249 orphans = ORPH_REMOVE;
250 else if (strcmp(ti->data, "attach") == 0
251 || strcmp(ti->data, "a") == 0)
252 orphans = ORPH_ATTACH;
254 #ifndef AFS_NT40_ENV /* ignore options on NT */
255 if ((ti = as->parms[13].items)) { /* -syslog */
259 if ((ti = as->parms[14].items)) { /* -syslogfacility */
260 useSyslogFacility = atoi(ti->data);
263 if ((ti = as->parms[15].items)) { /* -datelogs */
264 TimeStampLogFile(AFSDIR_SERVER_SALSRVLOG_FILEPATH);
268 if ((ti = as->parms[16].items)) { /* -client */
269 if ((ti = as->parms[0].items)) { /* -partition */
271 strlcpy(pname, ti->data, sizeof(pname));
273 if ((ti = as->parms[1].items)) { /* -volumeid */
275 vid = atoi(ti->data);
278 if (!seenpart || !seenvol) {
279 printf("You must specify '-partition' and '-volumeid' with the '-client' option\n");
283 SalvageClient(vid, pname);
285 } else { /* salvageserver mode */
293 #include "AFS_component_version_number.c"
297 char *save_args[MAX_ARGS];
299 pthread_t main_thread;
302 static char commandLine[150];
305 main(int argc, char **argv)
307 struct cmd_syndesc *ts;
311 extern char cml_version_number[];
315 * The following signal action for AIX is necessary so that in case of a
316 * crash (i.e. core is generated) we can include the user's data section
317 * in the core dump. Unfortunately, by default, only a partial core is
318 * generated which, in many cases, isn't too useful.
320 struct sigaction nsa;
322 sigemptyset(&nsa.sa_mask);
323 nsa.sa_handler = SIG_DFL;
324 nsa.sa_flags = SA_FULLDUMP;
325 sigaction(SIGABRT, &nsa, NULL);
326 sigaction(SIGSEGV, &nsa, NULL);
329 /* Initialize directory paths */
330 if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
332 ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
334 fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
339 main_thread = pthread_self();
340 if (spawnDatap && spawnDataLen) {
341 /* This is a child per partition salvager. Don't setup log or
342 * try to lock the salvager lock.
344 if (nt_SetupPartitionSalvage(spawnDatap, spawnDataLen) < 0)
348 for (commandLine[0] = '\0', i = 0; i < argc; i++) {
350 strlcat(commandLine, " ", sizeof(commandLine));
351 strlcat(commandLine, argv[i], sizeof(commandLine));
355 if (geteuid() != 0) {
356 printf("Salvager must be run as root.\n");
362 /* bad for normal help flag processing, but can do nada */
368 ts = cmd_CreateSyntax("initcmd", handleit, NULL, "initialize the program");
369 cmd_AddParm(ts, "-partition", CMD_SINGLE, CMD_OPTIONAL,
370 "Name of partition to salvage");
371 cmd_AddParm(ts, "-volumeid", CMD_SINGLE, CMD_OPTIONAL,
372 "Volume Id to salvage");
373 cmd_AddParm(ts, "-debug", CMD_FLAG, CMD_OPTIONAL,
374 "Run in Debugging mode");
375 cmd_AddParm(ts, "-nowrite", CMD_FLAG, CMD_OPTIONAL,
376 "Run readonly/test mode");
377 cmd_AddParm(ts, "-inodes", CMD_FLAG, CMD_OPTIONAL,
378 "Just list affected afs inodes - debugging flag");
379 cmd_AddParm(ts, "-oktozap", CMD_FLAG, CMD_OPTIONAL,
380 "Give permission to destroy bogus inodes/volumes - debugging flag");
381 cmd_AddParm(ts, "-rootinodes", CMD_FLAG, CMD_OPTIONAL,
382 "Show inodes owned by root - debugging flag");
383 cmd_AddParm(ts, "-salvagedirs", CMD_FLAG, CMD_OPTIONAL,
384 "Force rebuild/salvage of all directories");
385 cmd_AddParm(ts, "-blockreads", CMD_FLAG, CMD_OPTIONAL,
386 "Read smaller blocks to handle IO/bad blocks");
387 cmd_AddParm(ts, "-parallel", CMD_SINGLE, CMD_OPTIONAL,
388 "# of max parallel partition salvaging");
389 cmd_AddParm(ts, "-tmpdir", CMD_SINGLE, CMD_OPTIONAL,
390 "Name of dir to place tmp files ");
391 cmd_AddParm(ts, "-showlog", CMD_FLAG, CMD_OPTIONAL,
392 "Show log file upon completion");
393 cmd_AddParm(ts, "-orphans", CMD_SINGLE, CMD_OPTIONAL,
394 "ignore | remove | attach");
396 /* note - syslog isn't avail on NT, but if we make it conditional, have
397 * to deal with screwy offsets for cmd params */
398 cmd_AddParm(ts, "-syslog", CMD_FLAG, CMD_OPTIONAL,
399 "Write salvage log to syslogs");
400 cmd_AddParm(ts, "-syslogfacility", CMD_SINGLE, CMD_OPTIONAL,
401 "Syslog facility number to use");
402 cmd_AddParm(ts, "-datelogs", CMD_FLAG, CMD_OPTIONAL,
403 "Include timestamp in logfile filename");
405 cmd_AddParm(ts, "-client", CMD_FLAG, CMD_OPTIONAL,
406 "Use SALVSYNC to ask salvageserver to salvage a volume");
408 err = cmd_Dispatch(argc, argv);
410 return 0; /* not reached */
414 SalvageClient(VolumeId vid, char * pname)
419 SALVSYNC_response_hdr sres;
421 VInitVolumePackage(volumeUtility, 5, 5, DONT_CONNECT_FS, 0);
422 SALVSYNC_clientInit();
424 code = SALVSYNC_SalvageVolume(vid, pname, SALVSYNC_SALVAGE, SALVSYNC_OPERATOR, 0, NULL);
425 if (code != SYNC_OK) {
429 res.payload.buf = (void *) &sres;
430 res.payload.len = sizeof(sres);
434 code = SALVSYNC_SalvageVolume(vid, pname, SALVSYNC_QUERY, SALVSYNC_WHATEVER, 0, &res);
435 if (code != SYNC_OK) {
438 switch (sres.state) {
439 case SALVSYNC_STATE_ERROR:
440 printf("salvageserver reports salvage ended in an error; check log files for more details\n");
441 case SALVSYNC_STATE_DONE:
442 case SALVSYNC_STATE_UNKNOWN:
446 SALVSYNC_clientFinis();
450 if (code == SYNC_DENIED) {
451 printf("salvageserver refused to salvage volume %u on partition %s\n",
453 } else if (code == SYNC_BAD_COMMAND) {
454 printf("SALVSYNC protocol mismatch; please make sure fileserver, volserver, salvageserver and salvager are same version\n");
455 } else if (code == SYNC_COM_ERROR) {
456 printf("SALVSYNC communications error\n");
458 SALVSYNC_clientFinis();
462 static int * child_slot;
468 struct SalvageQueueNode * node;
470 pthread_attr_t attrs;
473 /* All entries to the log will be appended. Useful if there are
474 * multiple salvagers appending to the log.
477 CheckLogFile(AFSDIR_SERVER_SALSRVLOG_FILEPATH);
479 #ifdef AFS_LINUX20_ENV
480 fcntl(fileno(logFile), F_SETFL, O_APPEND); /* Isn't this redundant? */
482 fcntl(fileno(logFile), F_SETFL, FAPPEND); /* Isn't this redundant? */
487 fprintf(logFile, "%s\n", cml_version_number);
488 Log("Starting OpenAFS Online Salvage Server %s (%s)\n", SalvageVersion, commandLine);
490 /* Get and hold a lock for the duration of the salvage to make sure
491 * that no other salvage runs at the same time. The routine
492 * VInitVolumePackage (called below) makes sure that a file server or
493 * other volume utilities don't interfere with the salvage.
496 /* even demand attach online salvager
497 * still needs this because we don't want
498 * a stand-alone salvager to conflict with
499 * the salvager daemon */
502 child_slot = (int *) malloc(Parallel * sizeof(int));
503 assert(child_slot != NULL);
504 memset(child_slot, 0, Parallel * sizeof(int));
506 /* initialize things */
507 VInitVolumePackage(salvageServer, 5, 5,
510 queue_Init(&pending_q);
511 queue_Init(&log_cleanup_queue);
512 assert(pthread_mutex_init(&worker_lock, NULL) == 0);
513 assert(pthread_cond_init(&worker_cv, NULL) == 0);
514 assert(pthread_cond_init(&log_cleanup_queue.queue_change_cv, NULL) == 0);
515 assert(pthread_attr_init(&attrs) == 0);
517 /* start up the reaper and log cleaner threads */
518 assert(pthread_attr_setdetachstate(&attrs, PTHREAD_CREATE_DETACHED) == 0);
519 assert(pthread_create(&tid,
521 &SalvageChildReaperThread,
523 assert(pthread_create(&tid,
525 &SalvageLogCleanupThread,
528 /* loop forever serving requests */
530 node = SALVSYNC_getWork();
531 assert(node != NULL);
533 Log("dispatching child to salvage volume %u...\n",
534 node->command.sop.parent);
538 for (slot = 0; slot < Parallel; slot++) {
539 if (!child_slot[slot])
542 assert (slot < Parallel);
548 ret = DoSalvageVolume(node, slot);
550 } else if (pid < 0) {
551 Log("failed to fork child worker process\n");
555 child_slot[slot] = pid;
559 assert(pthread_mutex_lock(&worker_lock) == 0);
562 /* let the reaper thread know another worker was spawned */
563 assert(pthread_cond_broadcast(&worker_cv) == 0);
565 /* if we're overquota, wait for the reaper */
566 while (current_workers >= Parallel) {
567 assert(pthread_cond_wait(&worker_cv, &worker_lock) == 0);
569 assert(pthread_mutex_unlock(&worker_lock) == 0);
575 DoSalvageVolume(struct SalvageQueueNode * node, int slot)
577 char childLog[AFSDIR_PATH_MAX];
579 struct DiskPartition64 * partP;
581 /* do not allow further forking inside salvager */
584 /* do not attempt to close parent's logFile handle as
585 * another thread may have held the lock on the FILE
586 * structure when fork was called! */
588 afs_snprintf(childLog, sizeof(childLog), "%s.%d",
589 AFSDIR_SERVER_SLVGLOG_FILEPATH, getpid());
591 logFile = afs_fopen(childLog, "a");
592 if (!logFile) { /* still nothing, use stdout */
597 if (node->command.sop.parent <= 0) {
598 Log("salvageServer: invalid volume id specified; salvage aborted\n");
602 partP = VGetPartition(node->command.sop.partName, 0);
604 Log("salvageServer: Unknown or unmounted partition %s; salvage aborted\n",
605 node->command.sop.partName);
609 /* Salvage individual volume; don't notify fs */
610 SalvageFileSys1(partP, node->command.sop.parent);
618 SalvageChildReaperThread(void * args)
620 int slot, pid, status, code, found;
621 struct SalvageQueueNode *qp, *nqp;
622 struct log_cleanup_node * cleanup;
623 SALVSYNC_command_info info;
625 assert(pthread_mutex_lock(&worker_lock) == 0);
627 /* loop reaping our children */
629 /* wait() won't block unless we have children, so
630 * block on the cond var if we're childless */
631 while (current_workers == 0) {
632 assert(pthread_cond_wait(&worker_cv, &worker_lock) == 0);
635 assert(pthread_mutex_unlock(&worker_lock) == 0);
637 cleanup = (struct log_cleanup_node *) malloc(sizeof(struct log_cleanup_node));
639 while (Reap_Child("salvageserver", &pid, &status) < 0) {
640 /* try to prevent livelock if something goes wrong */
645 for (slot = 0; slot < Parallel; slot++) {
646 if (child_slot[slot] == pid)
649 assert(slot < Parallel);
650 child_slot[slot] = 0;
653 SALVSYNC_doneWorkByPid(pid, status);
655 assert(pthread_mutex_lock(&worker_lock) == 0);
659 queue_Append(&log_cleanup_queue, cleanup);
660 assert(pthread_cond_signal(&log_cleanup_queue.queue_change_cv) == 0);
663 /* ok, we've reaped a child */
665 assert(pthread_cond_broadcast(&worker_cv) == 0);
672 Reap_Child(char *prog, int * pid, int * status)
679 if (WCOREDUMP(*status))
680 Log("\"%s\" core dumped!\n", prog);
681 if ((WIFSIGNALED(*status) != 0) ||
682 ((WEXITSTATUS(*status) != 0) &&
683 (WEXITSTATUS(*status) != SALSRV_EXIT_VOLGROUP_LINK)))
684 Log("\"%s\" (pid=%d) terminated abnormally!\n", prog, ret);
686 Log("wait returned -1\n");
692 * thread to combine salvager child logs
693 * back into the main salvageserver log
696 SalvageLogCleanupThread(void * arg)
698 struct log_cleanup_node * cleanup;
700 assert(pthread_mutex_lock(&worker_lock) == 0);
703 while (queue_IsEmpty(&log_cleanup_queue)) {
704 assert(pthread_cond_wait(&log_cleanup_queue.queue_change_cv, &worker_lock) == 0);
707 while (queue_IsNotEmpty(&log_cleanup_queue)) {
708 cleanup = queue_First(&log_cleanup_queue, log_cleanup_node);
709 queue_Remove(cleanup);
710 assert(pthread_mutex_unlock(&worker_lock) == 0);
711 SalvageLogCleanup(cleanup->pid);
713 assert(pthread_mutex_lock(&worker_lock) == 0);
717 assert(pthread_mutex_unlock(&worker_lock) == 0);
721 #define LOG_XFER_BUF_SIZE 65536
723 SalvageLogCleanup(int pid)
726 char fn[AFSDIR_PATH_MAX];
727 static char buf[LOG_XFER_BUF_SIZE];
729 afs_snprintf(fn, sizeof(fn), "%s.%d",
730 AFSDIR_SERVER_SLVGLOG_FILEPATH, pid);
733 pidlog = open(fn, O_RDONLY);
738 len = read(pidlog, buf, LOG_XFER_BUF_SIZE);
740 fwrite(buf, len, 1, logFile);
741 len = read(pidlog, buf, LOG_XFER_BUF_SIZE);