7e4717b1904f11da2e9b723865978c9942a66e99
[openafs.git] / src / vol / salvaged.c
1 /*
2  * Copyright 2006-2007, Sine Nomine Associates 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  * demand attach fs
12  * online salvager daemon
13  */
14
15 /* Main program file. Define globals. */
16 #define MAIN 1
17
18 #include <afsconfig.h>
19 #include <afs/param.h>
20
21 #include <roken.h>
22
23 #ifdef HAVE_SYS_FILE_H
24 #include <sys/file.h>
25 #endif
26
27 #ifdef AFS_NT40_ENV
28 #include <WINNT/afsevent.h>
29 #endif
30
31 #ifndef WCOREDUMP
32 #define WCOREDUMP(x)    ((x) & 0200)
33 #endif
34
35 #include <afs/opr.h>
36 #include <opr/lock.h>
37 #include <afs/afsint.h>
38 #include <rx/rx_queue.h>
39
40 #if !defined(AFS_SGI_ENV) && !defined(AFS_NT40_ENV)
41 #if defined(AFS_VFSINCL_ENV)
42 #include <sys/vnode.h>
43 #ifdef  AFS_SUN5_ENV
44 #include <sys/fs/ufs_inode.h>
45 #else
46 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
47 #include <ufs/ufs/dinode.h>
48 #include <ufs/ffs/fs.h>
49 #else
50 #include <ufs/inode.h>
51 #endif
52 #endif
53 #else /* AFS_VFSINCL_ENV */
54 #ifdef  AFS_OSF_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>
59 #endif
60 #endif
61 #endif /* AFS_VFSINCL_ENV */
62 #endif /* AFS_SGI_ENV */
63 #ifdef  AFS_AIX_ENV
64 #include <sys/vfs.h>
65 #include <sys/lockf.h>
66 #else
67 #ifdef  AFS_HPUX_ENV
68 #include <checklist.h>
69 #else
70 #if defined(AFS_SGI_ENV)
71 #include <mntent.h>
72 #else
73 #if     defined(AFS_SUN_ENV) || defined(AFS_SUN5_ENV)
74 #ifdef    AFS_SUN5_ENV
75 #include <sys/mnttab.h>
76 #include <sys/mntent.h>
77 #else
78 #include <mntent.h>
79 #endif
80 #else
81 #endif /* AFS_SGI_ENV */
82 #endif /* AFS_HPUX_ENV */
83 #endif
84 #endif
85 #ifndef AFS_NT40_ENV
86 #include <afs/osi_inode.h>
87 #endif
88 #include <afs/cmd.h>
89 #include <afs/afsutil.h>
90 #include <afs/fileutil.h>
91 #include <afs/procmgmt.h>       /* signal(), kill(), wait(), etc. */
92 #include <afs/dir.h>
93
94 #include "nfs.h"
95 #include "lwp.h"
96 #include "lock.h"
97 #include <afs/afssyscalls.h>
98 #include "ihandle.h"
99 #include "vnode.h"
100 #include "volume.h"
101 #include "partition.h"
102 #include "daemon_com.h"
103 #include "fssync.h"
104 #include "salvsync.h"
105 #include "viceinode.h"
106 #include "salvage.h"
107 #include "vol-salvage.h"
108 #include "common.h"
109 #ifdef AFS_NT40_ENV
110 #include <pthread.h>
111 #endif
112
113 char *logFileName = NULL;
114
115 #if !defined(AFS_DEMAND_ATTACH_FS)
116 #error "online salvager only supported for demand attach fileserver"
117 #endif /* AFS_DEMAND_ATTACH_FS */
118
119 #if defined(AFS_NT40_ENV)
120 #error "online salvager not supported on NT"
121 #endif /* AFS_NT40_ENV */
122
123 /*@+fcnmacros +macrofcndecl@*/
124 #ifdef O_LARGEFILE
125 #define afs_fopen       fopen64
126 #else /* !O_LARGEFILE */
127 #define afs_fopen       fopen
128 #endif /* !O_LARGEFILE */
129 /*@=fcnmacros =macrofcndecl@*/
130
131
132
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;
137
138 static void * SalvageChildReaperThread(void *);
139 static int DoSalvageVolume(struct SalvageQueueNode * node, int slot);
140
141 static void SalvageServer(int argc, char **argv);
142 static void SalvageClient(VolumeId vid, char * pname);
143
144 static int Reap_Child(char * prog, int * pid, int * status);
145
146 static void * SalvageLogCleanupThread(void *);
147 static int SalvageLogCleanup(int pid);
148
149 static void * SalvageLogScanningThread(void *);
150 static void ScanLogs(struct rx_queue *log_watch_queue);
151
152 struct cmdline_rock {
153     int argc;
154     char **argv;
155 };
156
157 struct log_cleanup_node {
158     struct rx_queue q;
159     int pid;
160 };
161
162 struct {
163     struct rx_queue queue_head;
164     pthread_cond_t queue_change_cv;
165 } log_cleanup_queue;
166
167
168 #define DEFAULT_PARALLELISM 4 /* allow 4 parallel salvage workers by default */
169
170 enum optionsList {
171     OPT_partition,
172     OPT_volumeid,
173     OPT_debug,
174     OPT_nowrite,
175     OPT_inodes,
176     OPT_oktozap,
177     OPT_rootinodes,
178     OPT_salvagedirs,
179     OPT_blockreads,
180     OPT_parallel,
181     OPT_tmpdir,
182     OPT_orphans,
183     OPT_syslog,
184     OPT_syslogfacility,
185     OPT_logfile,
186     OPT_client
187 };
188
189 static int
190 handleit(struct cmd_syndesc *opts, void *arock)
191 {
192     char pname[100];
193     afs_int32 seenpart = 0, seenvol = 0;
194     VolumeId vid = 0;
195     struct cmdline_rock *rock = (struct cmdline_rock *)arock;
196     char *optstring = NULL;
197
198 #ifdef AFS_SGI_VNODE_GLUE
199     if (afs_init_kernel_config(-1) < 0) {
200         printf
201             ("Can't determine NUMA configuration, not starting salvager.\n");
202         exit(1);
203     }
204 #endif
205
206     cmd_OptionAsFlag(opts, OPT_debug, &debug);
207     cmd_OptionAsFlag(opts, OPT_nowrite, &Testing);
208     cmd_OptionAsFlag(opts, OPT_inodes, &ListInodeOption);
209     cmd_OptionAsFlag(opts, OPT_oktozap, &OKToZap);
210     cmd_OptionAsFlag(opts, OPT_rootinodes, &ShowRootFiles);
211     cmd_OptionAsFlag(opts, OPT_blockreads, &forceR);
212     if (cmd_OptionAsString(opts, OPT_parallel, &optstring) == 0) {
213         if (strncmp(optstring, "all", 3) == 0) {
214             PartsPerDisk = 1;
215         }
216         if (strlen(optstring) != 0) {
217             Parallel = atoi(optstring);
218             if (Parallel < 1)
219                 Parallel = 1;
220             if (Parallel > MAXPARALLEL) {
221                 printf("Setting parallel salvages to maximum of %d \n",
222                        MAXPARALLEL);
223                 Parallel = MAXPARALLEL;
224             }
225         }
226         free(optstring);
227         optstring = NULL;
228     } else {
229         Parallel = min(DEFAULT_PARALLELISM, MAXPARALLEL);
230     }
231     if (cmd_OptionAsString(opts, OPT_tmpdir, &optstring) == 0) {
232         DIR *dirp;
233         dirp = opendir(optstring);
234         if (!dirp) {
235             printf
236                 ("Can't open temporary placeholder dir %s; using current partition \n",
237                  optstring);
238             tmpdir = NULL;
239         } else
240             closedir(dirp);
241         free(optstring);
242         optstring = NULL;
243     }
244     if (cmd_OptionAsString(opts, OPT_orphans, &optstring) == 0) {
245         if (Testing)
246             orphans = ORPH_IGNORE;
247         else if (strcmp(optstring, "remove") == 0
248                  || strcmp(optstring, "r") == 0)
249             orphans = ORPH_REMOVE;
250         else if (strcmp(optstring, "attach") == 0
251                  || strcmp(optstring, "a") == 0)
252             orphans = ORPH_ATTACH;
253         free(optstring);
254         optstring = NULL;
255     }
256 #ifndef AFS_NT40_ENV            /* ignore options on NT */
257     if (cmd_OptionPresent(opts, OPT_syslog)) {
258         useSyslog = 1;
259     }
260     cmd_OptionAsInt(opts, OPT_syslogfacility, &useSyslogFacility);
261 #endif
262
263     if (cmd_OptionPresent(opts, OPT_client)) {
264         if (cmd_OptionAsString(opts, OPT_partition, &optstring) == 0) {
265             seenpart = 1;
266             strlcpy(pname, optstring, sizeof(pname));
267             free(optstring);
268             optstring = NULL;
269         }
270         if (cmd_OptionAsString(opts, OPT_volumeid, &optstring) == 0) {
271             char *end;
272             unsigned long vid_l;
273             seenvol = 1;
274             vid_l = strtoul(optstring, &end, 10);
275             if (vid_l >= MAX_AFS_UINT32 || vid_l == ULONG_MAX || *end != '\0') {
276                 printf("Invalid volume id specified; salvage aborted\n");
277                 exit(-1);
278             }
279             vid = (VolumeId)vid_l;
280         }
281
282         if (!seenpart || !seenvol) {
283             printf("You must specify '-partition' and '-volumeid' with the '-client' option\n");
284             exit(-1);
285         }
286
287         SalvageClient(vid, pname);
288
289     } else {  /* salvageserver mode */
290         SalvageServer(rock->argc, rock->argv);
291     }
292     return (0);
293 }
294
295
296 #ifndef AFS_NT40_ENV
297 #include "AFS_component_version_number.c"
298 #endif
299 #define MAX_ARGS 128
300 #ifdef AFS_NT40_ENV
301 char *save_args[MAX_ARGS];
302 int n_save_args = 0;
303 pthread_t main_thread;
304 #endif
305
306 int
307 main(int argc, char **argv)
308 {
309     struct cmd_syndesc *ts;
310     int err = 0;
311     struct cmdline_rock arock;
312
313 #ifdef  AFS_AIX32_ENV
314     /*
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.
319      */
320     struct sigaction nsa;
321
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);
327 #endif
328
329     /* Initialize directory paths */
330     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
331 #ifdef AFS_NT40_ENV
332         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
333 #endif
334         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
335                 argv[0]);
336         exit(2);
337     }
338 #ifdef AFS_NT40_ENV
339     /* Default to binary mode for fopen() */
340     _set_fmode(_O_BINARY);
341
342     main_thread = pthread_self();
343     if (spawnDatap && spawnDataLen) {
344         /* This is a child per partition salvager. Don't setup log or
345          * try to lock the salvager lock.
346          */
347         if (nt_SetupPartitionSalvage(spawnDatap, spawnDataLen) < 0)
348             exit(3);
349     } else {
350 #endif
351
352 #ifndef AFS_NT40_ENV
353         if (geteuid() != 0) {
354             printf("Salvager must be run as root.\n");
355             fflush(stdout);
356             Exit(0);
357         }
358 #endif
359
360         /* bad for normal help flag processing, but can do nada */
361
362 #ifdef AFS_NT40_ENV
363     }
364 #endif
365
366     arock.argc = argc;
367     arock.argv = argv;
368
369     logFileName = strdup(AFSDIR_SERVER_SALSRVLOG_FILEPATH);
370
371     ts = cmd_CreateSyntax("initcmd", handleit, &arock, 0, "initialize the program");
372     cmd_AddParmAtOffset(ts, OPT_partition, "-partition", CMD_SINGLE,
373             CMD_OPTIONAL, "Name of partition to salvage");
374     cmd_AddParmAtOffset(ts, OPT_volumeid, "-volumeid", CMD_SINGLE, CMD_OPTIONAL,
375             "Volume Id to salvage");
376     cmd_AddParmAtOffset(ts, OPT_debug, "-debug", CMD_FLAG, CMD_OPTIONAL,
377             "Run in Debugging mode");
378     cmd_AddParmAtOffset(ts, OPT_nowrite, "-nowrite", CMD_FLAG, CMD_OPTIONAL,
379             "Run readonly/test mode");
380     cmd_AddParmAtOffset(ts, OPT_inodes, "-inodes", CMD_FLAG, CMD_OPTIONAL,
381             "Just list affected afs inodes - debugging flag");
382     cmd_AddParmAtOffset(ts, OPT_oktozap, "-oktozap", CMD_FLAG, CMD_OPTIONAL,
383             "Give permission to destroy bogus inodes/volumes - debugging flag");
384     cmd_AddParmAtOffset(ts, OPT_rootinodes, "-rootinodes", CMD_FLAG,
385             CMD_OPTIONAL, "Show inodes owned by root - debugging flag");
386     cmd_AddParmAtOffset(ts, OPT_salvagedirs, "-salvagedirs", CMD_FLAG,
387             CMD_OPTIONAL, "Force rebuild/salvage of all directories");
388     cmd_AddParmAtOffset(ts, OPT_blockreads, "-blockreads", CMD_FLAG,
389             CMD_OPTIONAL, "Read smaller blocks to handle IO/bad blocks");
390     cmd_AddParmAtOffset(ts, OPT_parallel, "-parallel", CMD_SINGLE, CMD_OPTIONAL,
391             "# of max parallel partition salvaging");
392     cmd_AddParmAtOffset(ts, OPT_tmpdir, "-tmpdir", CMD_SINGLE, CMD_OPTIONAL,
393             "Name of dir to place tmp files ");
394     cmd_AddParmAtOffset(ts, OPT_orphans, "-orphans", CMD_SINGLE, CMD_OPTIONAL,
395             "ignore | remove | attach");
396
397 #if !defined(AFS_NT40_ENV)
398     cmd_AddParmAtOffset(ts, OPT_syslog, "-syslog", CMD_FLAG, CMD_OPTIONAL,
399             "Write salvage log to syslogs");
400     cmd_AddParmAtOffset(ts, OPT_syslogfacility, "-syslogfacility", CMD_SINGLE,
401             CMD_OPTIONAL, "Syslog facility number to use");
402 #endif
403
404     cmd_AddParmAtOffset(ts, OPT_client, "-client", CMD_FLAG, CMD_OPTIONAL,
405                 "Use SALVSYNC to ask salvageserver to salvage a volume");
406
407     cmd_AddParmAtOffset(ts, OPT_logfile, "-logfile", CMD_SINGLE, CMD_OPTIONAL,
408             "Location of log file ");
409
410     err = cmd_Dispatch(argc, argv);
411     Exit(err);
412     return 0; /* not reached */
413 }
414
415 static void
416 SalvageClient(VolumeId vid, char * pname)
417 {
418     int done = 0;
419     afs_int32 code;
420     SYNC_response res;
421     SALVSYNC_response_hdr sres;
422     VolumePackageOptions opts;
423
424     /* Send Log() messages to stderr in client mode. */
425     logFile = stderr;
426
427     VOptDefaults(volumeUtility, &opts);
428     if (VInitVolumePackage2(volumeUtility, &opts)) {
429         /* VInitVolumePackage2 can fail on e.g. partition attachment errors,
430          * but we don't really care, since all we're doing is trying to use
431          * SALVSYNC */
432         fprintf(stderr, "errors encountered initializing volume package, but "
433                         "trying to continue anyway\n");
434     }
435     SALVSYNC_clientInit();
436
437     code = SALVSYNC_SalvageVolume(vid, pname, SALVSYNC_SALVAGE, SALVSYNC_OPERATOR, 0, NULL);
438     if (code != SYNC_OK) {
439         goto sync_error;
440     }
441
442     res.payload.buf = (void *) &sres;
443     res.payload.len = sizeof(sres);
444
445     while(!done) {
446         sleep(2);
447         code = SALVSYNC_SalvageVolume(vid, pname, SALVSYNC_QUERY, SALVSYNC_WHATEVER, 0, &res);
448         if (code != SYNC_OK) {
449             goto sync_error;
450         }
451         switch (sres.state) {
452         case SALVSYNC_STATE_ERROR:
453             printf("salvageserver reports salvage ended in an error; check log files for more details\n");
454         case SALVSYNC_STATE_DONE:
455         case SALVSYNC_STATE_UNKNOWN:
456             done = 1;
457         }
458     }
459     SALVSYNC_clientFinis();
460     return;
461
462  sync_error:
463     if (code == SYNC_DENIED) {
464         printf("salvageserver refused to salvage volume %u on partition %s\n",
465                vid, pname);
466     } else if (code == SYNC_BAD_COMMAND) {
467         printf("SALVSYNC protocol mismatch; please make sure fileserver, volserver, salvageserver and salvager are same version\n");
468     } else if (code == SYNC_COM_ERROR) {
469         printf("SALVSYNC communications error\n");
470     }
471     SALVSYNC_clientFinis();
472     exit(-1);
473 }
474
475 static int * child_slot;
476
477 static void
478 SalvageServer(int argc, char **argv)
479 {
480     int pid, ret;
481     struct SalvageQueueNode * node;
482     pthread_t tid;
483     pthread_attr_t attrs;
484     int slot;
485     VolumePackageOptions opts;
486
487     /* All entries to the log will be appended.  Useful if there are
488      * multiple salvagers appending to the log.
489      */
490
491     CheckLogFile(logFileName);
492 #ifndef AFS_NT40_ENV
493 #ifdef AFS_LINUX20_ENV
494     fcntl(fileno(logFile), F_SETFL, O_APPEND);  /* Isn't this redundant? */
495 #else
496     fcntl(fileno(logFile), F_SETFL, FAPPEND);   /* Isn't this redundant? */
497 #endif
498 #endif
499     setlinebuf(logFile);
500
501     fprintf(logFile, "%s\n", cml_version_number);
502     LogCommandLine(argc, argv, "Online Salvage Server",
503                    SalvageVersion, "Starting OpenAFS", Log);
504     /* Get and hold a lock for the duration of the salvage to make sure
505      * that no other salvage runs at the same time.  The routine
506      * VInitVolumePackage2 (called below) makes sure that a file server or
507      * other volume utilities don't interfere with the salvage.
508      */
509
510     /* even demand attach online salvager
511      * still needs this because we don't want
512      * a stand-alone salvager to conflict with
513      * the salvager daemon */
514     ObtainSharedSalvageLock();
515
516     child_slot = calloc(Parallel, sizeof(int));
517     opr_Assert(child_slot != NULL);
518
519     /* initialize things */
520     VOptDefaults(salvageServer, &opts);
521     if (VInitVolumePackage2(salvageServer, &opts)) {
522         Log("Shutting down: errors encountered initializing volume package\n");
523         Exit(1);
524     }
525     DInit(10);
526     queue_Init(&pending_q);
527     queue_Init(&log_cleanup_queue);
528     opr_mutex_init(&worker_lock);
529     opr_cv_init(&worker_cv);
530     opr_cv_init(&log_cleanup_queue.queue_change_cv);
531     opr_Verify(pthread_attr_init(&attrs) == 0);
532
533     /* start up the reaper and log cleaner threads */
534     opr_Verify(pthread_attr_setdetachstate(&attrs,
535                                            PTHREAD_CREATE_DETACHED) == 0);
536     opr_Verify(pthread_create(&tid, &attrs,
537                               &SalvageChildReaperThread, NULL) == 0);
538     opr_Verify(pthread_create(&tid, &attrs,
539                               &SalvageLogCleanupThread, NULL) == 0);
540     opr_Verify(pthread_create(&tid, &attrs,
541                               &SalvageLogScanningThread, NULL) == 0);
542
543     /* loop forever serving requests */
544     while (1) {
545         node = SALVSYNC_getWork();
546         opr_Assert(node != NULL);
547
548         Log("dispatching child to salvage volume %u...\n",
549             node->command.sop.parent);
550
551         VOL_LOCK;
552         /* find a slot */
553         for (slot = 0; slot < Parallel; slot++) {
554           if (!child_slot[slot])
555             break;
556         }
557         opr_Assert (slot < Parallel);
558
559     do_fork:
560         pid = Fork();
561         if (pid == 0) {
562             VOL_UNLOCK;
563             ret = DoSalvageVolume(node, slot);
564             Exit(ret);
565         } else if (pid < 0) {
566             Log("failed to fork child worker process\n");
567             sleep(1);
568             goto do_fork;
569         } else {
570             child_slot[slot] = pid;
571             node->pid = pid;
572             VOL_UNLOCK;
573
574             opr_mutex_enter(&worker_lock);
575             current_workers++;
576
577             /* let the reaper thread know another worker was spawned */
578             opr_cv_broadcast(&worker_cv);
579
580             /* if we're overquota, wait for the reaper */
581             while (current_workers >= Parallel) {
582                 opr_cv_wait(&worker_cv, &worker_lock);
583             }
584             opr_mutex_exit(&worker_lock);
585         }
586     }
587 }
588
589 static int
590 DoSalvageVolume(struct SalvageQueueNode * node, int slot)
591 {
592     char *childLog;
593     struct DiskPartition64 * partP;
594
595     /* do not allow further forking inside salvager */
596     canfork = 0;
597
598     /* do not attempt to close parent's logFile handle as
599      * another thread may have held the lock on the FILE
600      * structure when fork was called! */
601
602     if (asprintf(&childLog, "%s.%d",
603                  AFSDIR_SERVER_SLVGLOG_FILEPATH, getpid()) < 0) {
604         logFile = stdout;
605     } else {
606         logFile = afs_fopen(childLog, "a");
607         if (!logFile) {         /* still nothing, use stdout */
608             logFile = stdout;
609             ShowLog = 0;
610         }
611         free(childLog);
612     }
613
614     if (node->command.sop.parent <= 0) {
615         Log("salvageServer: invalid volume id specified; salvage aborted\n");
616         return 1;
617     }
618
619     partP = VGetPartition(node->command.sop.partName, 0);
620     if (!partP) {
621         Log("salvageServer: Unknown or unmounted partition %s; salvage aborted\n",
622             node->command.sop.partName);
623         return 1;
624     }
625
626     /* obtain a shared salvage lock in the child worker, so if the
627      * salvageserver restarts (and we continue), we will still hold a lock and
628      * prevent standalone salvagers from interfering */
629     ObtainSharedSalvageLock();
630
631     /* Salvage individual volume; don't notify fs */
632     SalvageFileSys1(partP, node->command.sop.parent);
633
634     fclose(logFile);
635     return 0;
636 }
637
638
639 static void *
640 SalvageChildReaperThread(void * args)
641 {
642     int slot, pid, status;
643     struct log_cleanup_node * cleanup;
644
645     opr_mutex_enter(&worker_lock);
646
647     /* loop reaping our children */
648     while (1) {
649         /* wait() won't block unless we have children, so
650          * block on the cond var if we're childless */
651         while (current_workers == 0) {
652             opr_cv_wait(&worker_cv, &worker_lock);
653         }
654
655         opr_mutex_exit(&worker_lock);
656
657         cleanup = malloc(sizeof(struct log_cleanup_node));
658
659         while (Reap_Child("salvageserver", &pid, &status) < 0) {
660             /* try to prevent livelock if something goes wrong */
661             sleep(1);
662         }
663
664         VOL_LOCK;
665         for (slot = 0; slot < Parallel; slot++) {
666             if (child_slot[slot] == pid)
667                 break;
668         }
669         opr_Assert(slot < Parallel);
670         child_slot[slot] = 0;
671         VOL_UNLOCK;
672
673         SALVSYNC_doneWorkByPid(pid, status);
674
675         opr_mutex_enter(&worker_lock);
676
677         if (cleanup) {
678             cleanup->pid = pid;
679             queue_Append(&log_cleanup_queue, cleanup);
680             opr_cv_signal(&log_cleanup_queue.queue_change_cv);
681         }
682
683         /* ok, we've reaped a child */
684         current_workers--;
685         opr_cv_broadcast(&worker_cv);
686     }
687
688     return NULL;
689 }
690
691 static int
692 Reap_Child(char *prog, int * pid, int * status)
693 {
694     int ret;
695     ret = wait(status);
696
697     if (ret >= 0) {
698         *pid = ret;
699         if (WCOREDUMP(*status))
700             Log("\"%s\" core dumped!\n", prog);
701         if ((WIFSIGNALED(*status) != 0) ||
702             ((WEXITSTATUS(*status) != 0) &&
703              (WEXITSTATUS(*status) != SALSRV_EXIT_VOLGROUP_LINK)))
704             Log("\"%s\" (pid=%d) terminated abnormally!\n", prog, ret);
705     } else {
706         Log("wait returned -1\n");
707     }
708     return ret;
709 }
710
711 /*
712  * thread to combine salvager child logs
713  * back into the main salvageserver log
714  */
715 static void *
716 SalvageLogCleanupThread(void * arg)
717 {
718     struct log_cleanup_node * cleanup;
719
720     opr_mutex_enter(&worker_lock);
721
722     while (1) {
723         while (queue_IsEmpty(&log_cleanup_queue)) {
724             opr_cv_wait(&log_cleanup_queue.queue_change_cv, &worker_lock);
725         }
726
727         while (queue_IsNotEmpty(&log_cleanup_queue)) {
728             cleanup = queue_First(&log_cleanup_queue, log_cleanup_node);
729             queue_Remove(cleanup);
730             opr_mutex_exit(&worker_lock);
731             SalvageLogCleanup(cleanup->pid);
732             free(cleanup);
733             opr_mutex_enter(&worker_lock);
734         }
735     }
736
737     opr_mutex_exit(&worker_lock);
738     return NULL;
739 }
740
741 #define LOG_XFER_BUF_SIZE 65536
742 static int
743 SalvageLogCleanup(int pid)
744 {
745     int pidlog, len;
746     char *fn;
747     static char buf[LOG_XFER_BUF_SIZE];
748
749     if (asprintf(&fn, "%s.%d", AFSDIR_SERVER_SLVGLOG_FILEPATH, pid) < 0)
750         return 1;
751
752     pidlog = open(fn, O_RDONLY);
753     unlink(fn);
754     free(fn);
755     if (pidlog < 0)
756         return 1;
757
758     len = read(pidlog, buf, LOG_XFER_BUF_SIZE);
759     while (len) {
760         fwrite(buf, len, 1, logFile);
761         len = read(pidlog, buf, LOG_XFER_BUF_SIZE);
762     }
763
764     close(pidlog);
765
766     return 0;
767 }
768
769 /* wake up every five minutes to see if a non-child salvage has finished */
770 #define SALVAGE_SCAN_POLL_INTERVAL 300
771
772 /**
773  * Thread to look for SalvageLog.$pid files that are not from our child
774  * worker salvagers, and notify SalvageLogCleanupThread to clean them
775  * up. This can happen if we restart during salvages, or the
776  * salvageserver crashes or something.
777  *
778  * @param arg  unused
779  *
780  * @return always NULL
781  */
782 static void *
783 SalvageLogScanningThread(void * arg)
784 {
785     struct rx_queue log_watch_queue;
786     char *prefix;
787     int prefix_len;
788
789     queue_Init(&log_watch_queue);
790
791     prefix_len = asprintf(&prefix, "%s.", AFSDIR_SLVGLOG_FILE);
792     if (prefix_len >= 0) {
793         DIR *dp;
794         struct dirent *dirp;
795
796         dp = opendir(AFSDIR_LOGS_DIR);
797         opr_Assert(dp);
798
799         while ((dirp = readdir(dp)) != NULL) {
800             pid_t pid;
801             struct log_cleanup_node *cleanup;
802             int i;
803
804             if (strncmp(dirp->d_name, prefix, prefix_len) != 0) {
805                 /* not a salvage logfile; skip */
806                 continue;
807             }
808
809             errno = 0;
810             pid = strtol(dirp->d_name + prefix_len, NULL, 10);
811
812             if (errno != 0) {
813                 /* file is SalvageLog.<something> but <something> isn't
814                  * a pid, so skip */
815                  continue;
816             }
817
818             VOL_LOCK;
819             for (i = 0; i < Parallel; ++i) {
820                 if (pid == child_slot[i]) {
821                     break;
822                 }
823             }
824             VOL_UNLOCK;
825             if (i < Parallel) {
826                 /* this pid is one of our children, so the reaper thread
827                  * will take care of it; skip */
828                 continue;
829             }
830
831             cleanup = malloc(sizeof(struct log_cleanup_node));
832             cleanup->pid = pid;
833
834             queue_Append(&log_watch_queue, cleanup);
835         }
836         free(prefix);
837         closedir(dp);
838     }
839
840     ScanLogs(&log_watch_queue);
841
842     while (queue_IsNotEmpty(&log_watch_queue)) {
843         sleep(SALVAGE_SCAN_POLL_INTERVAL);
844         ScanLogs(&log_watch_queue);
845     }
846
847     return NULL;
848 }
849
850 /**
851  * look through log_watch_queue, and if any processes are not still
852  * running, hand them off to the SalvageLogCleanupThread
853  *
854  * @param log_watch_queue  a queue of PIDs that we should clean up if
855  * that PID has died
856  */
857 static void
858 ScanLogs(struct rx_queue *log_watch_queue)
859 {
860     struct log_cleanup_node *cleanup, *next;
861
862     opr_mutex_enter(&worker_lock);
863
864     for (queue_Scan(log_watch_queue, cleanup, next, log_cleanup_node)) {
865         /* if a process is still running, assume it's the salvage process
866          * still going, and keep waiting for it */
867         if (kill(cleanup->pid, 0) < 0 && errno == ESRCH) {
868             queue_Remove(cleanup);
869             queue_Append(&log_cleanup_queue, cleanup);
870             opr_cv_signal(&log_cleanup_queue.queue_change_cv);
871         }
872     }
873
874     opr_mutex_exit(&worker_lock);
875 }