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