xref: /freebsd/sbin/dump/optr.c (revision 8fa113e5fc65fe6abc757f0089f477a87ee4d185)
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 <unistd.h>
55 #include <utmp.h>
56 
57 #include "dump.h"
58 #include "pathnames.h"
59 
60 void	alarmcatch __P((/* int, int */));
61 int	datesort __P((const void *, const void *));
62 
63 /*
64  *	Query the operator; This previously-fascist piece of code
65  *	no longer requires an exact response.
66  *	It is intended to protect dump aborting by inquisitive
67  *	people banging on the console terminal to see what is
68  *	happening which might cause dump to croak, destroying
69  *	a large number of hours of work.
70  *
71  *	Every 2 minutes we reprint the message, alerting others
72  *	that dump needs attention.
73  */
74 static	int timeout;
75 static	char *attnmessage;		/* attention message */
76 
77 int
78 query(question)
79 	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();
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()
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(signo)
153 	int signo;
154 {
155 	msg("Interrupt received.\n");
156 	if (query("Do you want to abort dump?"))
157 		dumpabort(0);
158 }
159 
160 /*
161  *	We now use wall(1) to do the actual broadcasting.
162  */
163 void
164 broadcast(message)
165 	char	*message;
166 {
167 	FILE *fp;
168 	char buf[sizeof(_PATH_WALL) + sizeof(OPGRENT) + 3];
169 
170 	if (!notify)
171 		return;
172 
173 	snprintf(buf, sizeof(buf), "%s -g %s", _PATH_WALL, OPGRENT);
174 	if ((fp = popen(buf, "w")) == NULL)
175 		return;
176 
177 	(void) fputs("\a\a\aMessage from the dump program to all operators\n\nDUMP: NEEDS ATTENTION: ", fp);
178 	if (lastmsg[0])
179 		(void) fputs(lastmsg, fp);
180 	if (message[0])
181 		(void) fputs(message, fp);
182 
183 	(void) pclose(fp);
184 }
185 
186 /*
187  *	Print out an estimate of the amount of time left to do the dump
188  */
189 
190 time_t	tschedule = 0;
191 
192 void
193 timeest()
194 {
195 	time_t	tnow;
196 	int deltat;
197 
198 	(void) time((time_t *) &tnow);
199 	if (tnow >= tschedule) {
200 		tschedule = tnow + 300;
201 		if (blockswritten < 500)
202 			return;
203 		deltat = tstart_writing - tnow +
204 			(1.0 * (tnow - tstart_writing))
205 			/ blockswritten * tapesize;
206 		msg("%3.2f%% done, finished in %d:%02d\n",
207 			(blockswritten * 100.0) / tapesize,
208 			deltat / 3600, (deltat % 3600) / 60);
209 	}
210 }
211 
212 void
213 #if __STDC__
214 msg(const char *fmt, ...)
215 #else
216 msg(fmt, va_alist)
217 	char *fmt;
218 	va_dcl
219 #endif
220 {
221 	va_list ap;
222 
223 	(void) fprintf(stderr,"  DUMP: ");
224 #ifdef TDEBUG
225 	(void) fprintf(stderr, "pid=%d ", getpid());
226 #endif
227 #if __STDC__
228 	va_start(ap, fmt);
229 #else
230 	va_start(ap);
231 #endif
232 	(void) vfprintf(stderr, fmt, ap);
233 	(void) fflush(stdout);
234 	(void) fflush(stderr);
235 	(void) vsnprintf(lastmsg, sizeof(lastmsg), fmt, ap);
236 	va_end(ap);
237 }
238 
239 void
240 #if __STDC__
241 msgtail(const char *fmt, ...)
242 #else
243 msgtail(fmt, va_alist)
244 	char *fmt;
245 	va_dcl
246 #endif
247 {
248 	va_list ap;
249 #if __STDC__
250 	va_start(ap, fmt);
251 #else
252 	va_start(ap);
253 #endif
254 	(void) vfprintf(stderr, fmt, ap);
255 	va_end(ap);
256 }
257 
258 void
259 #if __STDC__
260 quit(const char *fmt, ...)
261 #else
262 quit(fmt, va_alist)
263 	char *fmt;
264 	va_dcl
265 #endif
266 {
267 	va_list ap;
268 
269 	(void) fprintf(stderr,"  DUMP: ");
270 #ifdef TDEBUG
271 	(void) fprintf(stderr, "pid=%d ", getpid());
272 #endif
273 #if __STDC__
274 	va_start(ap, fmt);
275 #else
276 	va_start(ap);
277 #endif
278 	(void) vfprintf(stderr, fmt, ap);
279 	va_end(ap);
280 	(void) fflush(stdout);
281 	(void) fflush(stderr);
282 	dumpabort(0);
283 }
284 
285 /*
286  *	Tell the operator what has to be done;
287  *	we don't actually do it
288  */
289 
290 struct fstab *
291 allocfsent(fs)
292 	struct fstab *fs;
293 {
294 	struct fstab *new;
295 
296 	new = (struct fstab *)malloc(sizeof (*fs));
297 	if (new == NULL ||
298 	    (new->fs_file = strdup(fs->fs_file)) == NULL ||
299 	    (new->fs_type = strdup(fs->fs_type)) == NULL ||
300 	    (new->fs_spec = strdup(fs->fs_spec)) == NULL)
301 		quit("%s\n", strerror(errno));
302 	new->fs_passno = fs->fs_passno;
303 	new->fs_freq = fs->fs_freq;
304 	return (new);
305 }
306 
307 struct	pfstab {
308 	SLIST_ENTRY(pfstab) pf_list;
309 	struct	fstab *pf_fstab;
310 };
311 
312 static	SLIST_HEAD(, pfstab) table;
313 
314 void
315 getfstab()
316 {
317 	struct fstab *fs;
318 	struct pfstab *pf;
319 
320 	if (setfsent() == 0) {
321 		msg("Can't open %s for dump table information: %s\n",
322 		    _PATH_FSTAB, strerror(errno));
323 		return;
324 	}
325 	while ((fs = getfsent()) != NULL) {
326 		if (strcmp(fs->fs_type, FSTAB_RW) &&
327 		    strcmp(fs->fs_type, FSTAB_RO) &&
328 		    strcmp(fs->fs_type, FSTAB_RQ))
329 			continue;
330 		fs = allocfsent(fs);
331 		if ((pf = (struct pfstab *)malloc(sizeof (*pf))) == NULL)
332 			quit("%s\n", strerror(errno));
333 		pf->pf_fstab = fs;
334 		SLIST_INSERT_HEAD(&table, pf, pf_list);
335 	}
336 	(void) endfsent();
337 }
338 
339 /*
340  * Search in the fstab for a file name.
341  * This file name can be either the special or the path file name.
342  *
343  * The file name can omit the leading '/'.
344  */
345 struct fstab *
346 fstabsearch(key)
347 	char *key;
348 {
349 	struct pfstab *pf;
350 	struct fstab *fs;
351 	char *rn;
352 
353 	SLIST_FOREACH(pf, &table, pf_list) {
354 		fs = pf->pf_fstab;
355 		if (strcmp(fs->fs_file, key) == 0 ||
356 		    strcmp(fs->fs_spec, key) == 0)
357 			return (fs);
358 		rn = rawname(fs->fs_spec);
359 		if (rn != NULL && strcmp(rn, key) == 0)
360 			return (fs);
361 		if (key[0] != '/') {
362 			if (*fs->fs_spec == '/' &&
363 			    strcmp(fs->fs_spec + 1, key) == 0)
364 				return (fs);
365 			if (*fs->fs_file == '/' &&
366 			    strcmp(fs->fs_file + 1, key) == 0)
367 				return (fs);
368 		}
369 	}
370 	return (NULL);
371 }
372 
373 /*
374  *	Tell the operator what to do
375  */
376 void
377 lastdump(arg)
378 	char	arg;	/* w ==> just what to do; W ==> most recent dumps */
379 {
380 	int i;
381 	struct fstab *dt;
382 	struct dumpdates *dtwalk;
383 	char *lastname, *date;
384 	int dumpme;
385 	time_t tnow;
386 	struct tm *tlast;
387 
388 	(void) time(&tnow);
389 	getfstab();		/* /etc/fstab input */
390 	initdumptimes();	/* /etc/dumpdates input */
391 	qsort((char *) ddatev, nddates, sizeof(struct dumpdates *), datesort);
392 
393 	if (arg == 'w')
394 		(void) printf("Dump these file systems:\n");
395 	else
396 		(void) printf("Last dump(s) done (Dump '>' file systems):\n");
397 	lastname = "??";
398 	ITITERATE(i, dtwalk) {
399 		if (strncmp(lastname, dtwalk->dd_name,
400 		    sizeof(dtwalk->dd_name)) == 0)
401 			continue;
402 		date = (char *)ctime(&dtwalk->dd_ddate);
403 		date[16] = '\0';	/* blast away seconds and year */
404 		lastname = dtwalk->dd_name;
405 		dt = fstabsearch(dtwalk->dd_name);
406 		dumpme = (dt != NULL && dt->fs_freq != 0);
407 		if (dumpme) {
408 		    tlast = localtime(&dtwalk->dd_ddate);
409 		    dumpme = tnow > (dtwalk->dd_ddate - (tlast->tm_hour * 3600)
410 				     - (tlast->tm_min * 60) - tlast->tm_sec
411 				     + (dt->fs_freq * 86400));
412 		};
413 		if (arg != 'w' || dumpme)
414 			(void) printf(
415 			    "%c %8s\t(%6s) Last dump: Level %c, Date %s\n",
416 			    dumpme && (arg != 'w') ? '>' : ' ',
417 			    dtwalk->dd_name,
418 			    dt ? dt->fs_file : "",
419 			    dtwalk->dd_level,
420 			    date);
421 	}
422 }
423 
424 int
425 datesort(a1, a2)
426 	const void *a1, *a2;
427 {
428 	struct dumpdates *d1 = *(struct dumpdates **)a1;
429 	struct dumpdates *d2 = *(struct dumpdates **)a2;
430 	int diff;
431 
432 	diff = strncmp(d1->dd_name, d2->dd_name, sizeof(d1->dd_name));
433 	if (diff == 0)
434 		return (d2->dd_ddate - d1->dd_ddate);
435 	return (diff);
436 }
437