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