xref: /freebsd/sbin/dump/optr.c (revision dba6dd177bdee890cf445fbe21a5dccefd5de18e)
1 /*-
2  * Copyright (c) 1980, 1988, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #ifndef lint
31 #if 0
32 static char sccsid[] = "@(#)optr.c	8.2 (Berkeley) 1/6/94";
33 #endif
34 static const char rcsid[] =
35   "$FreeBSD$";
36 #endif /* not lint */
37 
38 #include <sys/param.h>
39 #include <sys/queue.h>
40 #include <sys/wait.h>
41 #include <sys/time.h>
42 
43 #include <ufs/ufs/dinode.h>
44 
45 #include <errno.h>
46 #include <fstab.h>
47 #include <grp.h>
48 #include <limits.h>
49 #include <stdio.h>
50 #include <stdlib.h>
51 #include <string.h>
52 #include <stdarg.h>
53 #include <signal.h>
54 #include <unistd.h>
55 
56 #include "dump.h"
57 #include "pathnames.h"
58 
59 void	alarmcatch(int);
60 int	datesort(const void *, const void *);
61 
62 /*
63  *	Query the operator; This previously-fascist piece of code
64  *	no longer requires an exact response.
65  *	It is intended to protect dump aborting by inquisitive
66  *	people banging on the console terminal to see what is
67  *	happening which might cause dump to croak, destroying
68  *	a large number of hours of work.
69  *
70  *	Every 2 minutes we reprint the message, alerting others
71  *	that dump needs attention.
72  */
73 static	int timeout;
74 static	const char *attnmessage;		/* attention message */
75 
76 int
77 query(const char *question)
78 {
79 	char	replybuffer[64];
80 	int	back, errcount;
81 	FILE	*mytty;
82 
83 	if ((mytty = fopen(_PATH_TTY, "r")) == NULL)
84 		quit("fopen on %s fails: %s\n", _PATH_TTY, strerror(errno));
85 	attnmessage = question;
86 	timeout = 0;
87 	alarmcatch(0);
88 	back = -1;
89 	errcount = 0;
90 	do {
91 		if (fgets(replybuffer, 63, mytty) == NULL) {
92 			clearerr(mytty);
93 			if (++errcount > 30)	/* XXX	ugly */
94 				quit("excessive operator query failures\n");
95 		} else if (replybuffer[0] == 'y' || replybuffer[0] == 'Y') {
96 			back = 1;
97 		} else if (replybuffer[0] == 'n' || replybuffer[0] == 'N') {
98 			back = 0;
99 		} else {
100 			(void) fprintf(stderr,
101 			    "  DUMP: \"Yes\" or \"No\"?\n");
102 			(void) fprintf(stderr,
103 			    "  DUMP: %s: (\"yes\" or \"no\") ", question);
104 		}
105 	} while (back < 0);
106 
107 	/*
108 	 *	Turn off the alarm, and reset the signal to trap out..
109 	 */
110 	(void) alarm(0);
111 	if (signal(SIGALRM, sig) == SIG_IGN)
112 		signal(SIGALRM, SIG_IGN);
113 	(void) fclose(mytty);
114 	return(back);
115 }
116 
117 char lastmsg[BUFSIZ];
118 
119 /*
120  *	Alert the console operator, and enable the alarm clock to
121  *	sleep for 2 minutes in case nobody comes to satisfy dump
122  */
123 void
124 alarmcatch(int sig __unused)
125 {
126 	if (notify == 0) {
127 		if (timeout == 0)
128 			(void) fprintf(stderr,
129 			    "  DUMP: %s: (\"yes\" or \"no\") ",
130 			    attnmessage);
131 		else
132 			msgtail("\a\a");
133 	} else {
134 		if (timeout) {
135 			msgtail("\n");
136 			broadcast("");		/* just print last msg */
137 		}
138 		(void) fprintf(stderr,"  DUMP: %s: (\"yes\" or \"no\") ",
139 		    attnmessage);
140 	}
141 	signal(SIGALRM, alarmcatch);
142 	(void) alarm(120);
143 	timeout = 1;
144 }
145 
146 /*
147  *	Here if an inquisitive operator interrupts the dump program
148  */
149 void
150 interrupt(int signo __unused)
151 {
152 	msg("Interrupt received.\n");
153 	if (query("Do you want to abort dump?"))
154 		dumpabort(0);
155 }
156 
157 /*
158  *	We now use wall(1) to do the actual broadcasting.
159  */
160 void
161 broadcast(const char *message)
162 {
163 	FILE *fp;
164 	char buf[sizeof(_PATH_WALL) + sizeof(OPGRENT) + 3];
165 
166 	if (!notify)
167 		return;
168 
169 	snprintf(buf, sizeof(buf), "%s -g %s", _PATH_WALL, OPGRENT);
170 	if ((fp = popen(buf, "w")) == NULL)
171 		return;
172 
173 	(void) fputs("\a\a\aMessage from the dump program to all operators\n\nDUMP: NEEDS ATTENTION: ", fp);
174 	if (lastmsg[0])
175 		(void) fputs(lastmsg, fp);
176 	if (message[0])
177 		(void) fputs(message, fp);
178 
179 	(void) pclose(fp);
180 }
181 
182 /*
183  *	Print out an estimate of the amount of time left to do the dump
184  */
185 
186 time_t	tschedule = 0;
187 
188 void
189 timeest(void)
190 {
191 	double percent;
192 	time_t	tnow, tdone;
193 	int deltat, hours, mins;
194 
195 	if (blockswritten > tapesize) {
196 		setproctitle("%s: 99.99%% done, finished soon", disk);
197 		msg("99.99%% done, finished soon\n");
198 	} else {
199 		(void) time(&tnow);
200 		deltat = (blockswritten == 0) ? 0 : tstart_writing - tnow +
201 		    (double)(tnow - tstart_writing) / blockswritten * tapesize;
202 		tdone = tnow + deltat;
203 		percent = (blockswritten * 100.0) / tapesize;
204 		hours = deltat / 3600;
205 		mins = (deltat % 3600) / 60;
206 
207 		setproctitle(
208 		    "%s: pass %d: %3.2f%% done, finished in %d:%02d at %s",
209 		    disk, passno, percent, hours, mins, ctime(&tdone));
210 		if (tnow >= tschedule) {
211 			tschedule = tnow + 300;
212 			if (blockswritten < 500)
213 				return;
214 			msg("%3.2f%% done, finished in %d:%02d at %s", percent,
215 			    hours, mins, ctime(&tdone));
216 		}
217 	}
218 }
219 
220 /*
221  * Schedule a printout of the estimate in the next call to timeest().
222  */
223 void
224 infosch(int signal __unused)
225 {
226 	tschedule = 0;
227 }
228 
229 void
230 msg(const char *fmt, ...)
231 {
232 	va_list ap;
233 	va_list ap2;
234 
235 	(void) fprintf(stderr,"  DUMP: ");
236 #ifdef TDEBUG
237 	(void) fprintf(stderr, "pid=%d ", getpid());
238 #endif
239 	va_start(ap, fmt);
240 	va_copy(ap2, ap);
241 	(void) vfprintf(stderr, fmt, ap);
242 	(void) fflush(stdout);
243 	(void) fflush(stderr);
244 	(void) vsnprintf(lastmsg, sizeof(lastmsg), fmt, ap2);
245 	va_end(ap);
246 	va_end(ap2);
247 }
248 
249 void
250 msgtail(const char *fmt, ...)
251 {
252 	va_list ap;
253 	va_start(ap, fmt);
254 	(void) vfprintf(stderr, fmt, ap);
255 	va_end(ap);
256 }
257 
258 void
259 quit(const char *fmt, ...)
260 {
261 	va_list ap;
262 
263 	(void) fprintf(stderr,"  DUMP: ");
264 #ifdef TDEBUG
265 	(void) fprintf(stderr, "pid=%d ", getpid());
266 #endif
267 	va_start(ap, fmt);
268 	(void) vfprintf(stderr, fmt, ap);
269 	va_end(ap);
270 	(void) fflush(stdout);
271 	(void) fflush(stderr);
272 	dumpabort(0);
273 }
274 
275 /*
276  *	Tell the operator what has to be done;
277  *	we don't actually do it
278  */
279 
280 struct fstab *
281 allocfsent(const struct fstab *fs)
282 {
283 	struct fstab *new;
284 
285 	new = (struct fstab *)malloc(sizeof (*fs));
286 	if (new == NULL ||
287 	    (new->fs_file = strdup(fs->fs_file)) == NULL ||
288 	    (new->fs_type = strdup(fs->fs_type)) == NULL ||
289 	    (new->fs_spec = strdup(fs->fs_spec)) == NULL)
290 		quit("%s\n", strerror(errno));
291 	new->fs_passno = fs->fs_passno;
292 	new->fs_freq = fs->fs_freq;
293 	return (new);
294 }
295 
296 struct	pfstab {
297 	SLIST_ENTRY(pfstab) pf_list;
298 	struct	fstab *pf_fstab;
299 };
300 
301 static	SLIST_HEAD(, pfstab) table;
302 
303 void
304 dump_getfstab(void)
305 {
306 	struct fstab *fs;
307 	struct pfstab *pf;
308 
309 	if (setfsent() == 0) {
310 		msg("Can't open %s for dump table information: %s\n",
311 		    _PATH_FSTAB, strerror(errno));
312 		return;
313 	}
314 	while ((fs = getfsent()) != NULL) {
315 		if (strcmp(fs->fs_type, FSTAB_RW) &&
316 		    strcmp(fs->fs_type, FSTAB_RO) &&
317 		    strcmp(fs->fs_type, FSTAB_RQ))
318 			continue;
319 		fs = allocfsent(fs);
320 		if ((pf = (struct pfstab *)malloc(sizeof (*pf))) == NULL)
321 			quit("%s\n", strerror(errno));
322 		pf->pf_fstab = fs;
323 		SLIST_INSERT_HEAD(&table, pf, pf_list);
324 	}
325 	(void) endfsent();
326 }
327 
328 /*
329  * Search in the fstab for a file name.
330  * This file name can be either the special or the path file name.
331  *
332  * The file name can omit the leading '/'.
333  */
334 struct fstab *
335 fstabsearch(const char *key)
336 {
337 	struct pfstab *pf;
338 	struct fstab *fs;
339 	char *rn;
340 
341 	SLIST_FOREACH(pf, &table, pf_list) {
342 		fs = pf->pf_fstab;
343 		if (strcmp(fs->fs_file, key) == 0 ||
344 		    strcmp(fs->fs_spec, key) == 0)
345 			return (fs);
346 		rn = rawname(fs->fs_spec);
347 		if (rn != NULL && strcmp(rn, key) == 0)
348 			return (fs);
349 		if (key[0] != '/') {
350 			if (*fs->fs_spec == '/' &&
351 			    strcmp(fs->fs_spec + 1, key) == 0)
352 				return (fs);
353 			if (*fs->fs_file == '/' &&
354 			    strcmp(fs->fs_file + 1, key) == 0)
355 				return (fs);
356 		}
357 	}
358 	return (NULL);
359 }
360 
361 /*
362  *	Tell the operator what to do
363  */
364 void
365 lastdump(int arg)	/* w ==> just what to do; W ==> most recent dumps */
366 {
367 	int i;
368 	struct fstab *dt;
369 	struct dumpdates *dtwalk;
370 	char *lastname, *date;
371 	int dumpme;
372 	time_t tnow;
373 	struct tm *tlast;
374 
375 	(void) time(&tnow);
376 	dump_getfstab();	/* /etc/fstab input */
377 	initdumptimes();	/* /etc/dumpdates input */
378 	qsort((char *) ddatev, nddates, sizeof(struct dumpdates *), datesort);
379 
380 	if (arg == 'w')
381 		(void) printf("Dump these file systems:\n");
382 	else
383 		(void) printf("Last dump(s) done (Dump '>' file systems):\n");
384 	lastname = "??";
385 	ITITERATE(i, dtwalk) {
386 		if (strncmp(lastname, dtwalk->dd_name,
387 		    sizeof(dtwalk->dd_name)) == 0)
388 			continue;
389 		date = (char *)ctime(&dtwalk->dd_ddate);
390 		date[16] = '\0';	/* blast away seconds and year */
391 		lastname = dtwalk->dd_name;
392 		dt = fstabsearch(dtwalk->dd_name);
393 		dumpme = (dt != NULL && dt->fs_freq != 0);
394 		if (dumpme) {
395 		    tlast = localtime(&dtwalk->dd_ddate);
396 		    dumpme = tnow > (dtwalk->dd_ddate - (tlast->tm_hour * 3600)
397 				     - (tlast->tm_min * 60) - tlast->tm_sec
398 				     + (dt->fs_freq * 86400));
399 		};
400 		if (arg != 'w' || dumpme)
401 			(void) printf(
402 			    "%c %8s\t(%6s) Last dump: Level %c, Date %s\n",
403 			    dumpme && (arg != 'w') ? '>' : ' ',
404 			    dtwalk->dd_name,
405 			    dt ? dt->fs_file : "",
406 			    dtwalk->dd_level,
407 			    date);
408 	}
409 }
410 
411 int
412 datesort(const void *a1, const void *a2)
413 {
414 	struct dumpdates *d1 = *(struct dumpdates **)a1;
415 	struct dumpdates *d2 = *(struct dumpdates **)a2;
416 	int diff;
417 
418 	diff = strncmp(d1->dd_name, d2->dd_name, sizeof(d1->dd_name));
419 	if (diff == 0)
420 		return (d2->dd_ddate - d1->dd_ddate);
421 	return (diff);
422 }
423