xref: /freebsd/sbin/dump/optr.c (revision 55141f2c8991b2a6adbf30bb0fe3e6cbc303f06d)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1980, 1988, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef lint
33 #if 0
34 static char sccsid[] = "@(#)optr.c	8.2 (Berkeley) 1/6/94";
35 #endif
36 #endif /* not lint */
37 
38 #include <sys/param.h>
39 #include <sys/queue.h>
40 #include <sys/wait.h>
41 
42 #include <ufs/ufs/dinode.h>
43 
44 #include <errno.h>
45 #include <fstab.h>
46 #include <grp.h>
47 #include <limits.h>
48 #include <stdio.h>
49 #include <stdlib.h>
50 #include <string.h>
51 #include <stdarg.h>
52 #include <signal.h>
53 #include <time.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 	char *tdone_str;
194 	int deltat, hours, mins;
195 
196 	(void)time(&tnow);
197 	if (blockswritten > tapesize) {
198 		setproctitle("%s: 99.99%% done, finished soon", disk);
199 		if (tnow >= tschedule) {
200 			tschedule = tnow + 300;
201 			msg("99.99%% done, finished soon\n");
202 		}
203 	} else {
204 		deltat = (blockswritten == 0) ? 0 : tstart_writing - tnow +
205 		    (double)(tnow - tstart_writing) / blockswritten * tapesize;
206 		tdone = tnow + deltat;
207 		percent = (blockswritten * 100.0) / tapesize;
208 		hours = deltat / 3600;
209 		mins = (deltat % 3600) / 60;
210 
211 		tdone_str = ctime(&tdone);
212 		tdone_str[strlen(tdone_str) - 1] = '\0';
213 		setproctitle(
214 		    "%s: pass %d: %3.2f%% done, finished in %d:%02d at %s",
215 		    disk, passno, percent, hours, mins, tdone_str);
216 		if (tnow >= tschedule) {
217 			tschedule = tnow + 300;
218 			if (blockswritten < 500)
219 				return;
220 			msg("%3.2f%% done, finished in %d:%02d at %s\n", percent,
221 			    hours, mins, tdone_str);
222 		}
223 	}
224 }
225 
226 /*
227  * Schedule a printout of the estimate in the next call to timeest().
228  */
229 void
230 infosch(int signal __unused)
231 {
232 	tschedule = 0;
233 }
234 
235 void
236 msg(const char *fmt, ...)
237 {
238 	va_list ap;
239 
240 	(void) fprintf(stderr,"  DUMP: ");
241 #ifdef TDEBUG
242 	(void) fprintf(stderr, "pid=%d ", getpid());
243 #endif
244 	va_start(ap, fmt);
245 	(void) vfprintf(stderr, fmt, ap);
246 	va_end(ap);
247 	(void) fflush(stdout);
248 	(void) fflush(stderr);
249 	va_start(ap, fmt);
250 	(void) vsnprintf(lastmsg, sizeof(lastmsg), fmt, ap);
251 	va_end(ap);
252 }
253 
254 void
255 msgtail(const char *fmt, ...)
256 {
257 	va_list ap;
258 
259 	va_start(ap, fmt);
260 	(void) vfprintf(stderr, fmt, ap);
261 	va_end(ap);
262 }
263 
264 void
265 quit(const char *fmt, ...)
266 {
267 	va_list ap;
268 
269 	(void) fprintf(stderr,"  DUMP: ");
270 #ifdef TDEBUG
271 	(void) fprintf(stderr, "pid=%d ", getpid());
272 #endif
273 	va_start(ap, fmt);
274 	(void) vfprintf(stderr, fmt, ap);
275 	va_end(ap);
276 	(void) fflush(stdout);
277 	(void) fflush(stderr);
278 	dumpabort(0);
279 }
280 
281 /*
282  *	Tell the operator what has to be done;
283  *	we don't actually do it
284  */
285 
286 struct fstab *
287 allocfsent(const struct fstab *fs)
288 {
289 	struct fstab *new;
290 
291 	new = (struct fstab *)malloc(sizeof (*fs));
292 	if (new == NULL ||
293 	    (new->fs_file = strdup(fs->fs_file)) == NULL ||
294 	    (new->fs_type = strdup(fs->fs_type)) == NULL ||
295 	    (new->fs_spec = strdup(fs->fs_spec)) == NULL)
296 		quit("%s\n", strerror(errno));
297 	new->fs_passno = fs->fs_passno;
298 	new->fs_freq = fs->fs_freq;
299 	return (new);
300 }
301 
302 struct	pfstab {
303 	SLIST_ENTRY(pfstab) pf_list;
304 	struct	fstab *pf_fstab;
305 };
306 
307 static	SLIST_HEAD(, pfstab) table;
308 
309 void
310 dump_getfstab(void)
311 {
312 	struct fstab *fs;
313 	struct pfstab *pf;
314 
315 	if (setfsent() == 0) {
316 		msg("Can't open %s for dump table information: %s\n",
317 		    _PATH_FSTAB, strerror(errno));
318 		return;
319 	}
320 	while ((fs = getfsent()) != NULL) {
321 		if ((strcmp(fs->fs_type, FSTAB_RW) &&
322 		    strcmp(fs->fs_type, FSTAB_RO) &&
323 		    strcmp(fs->fs_type, FSTAB_RQ)) ||
324 		    strcmp(fs->fs_vfstype, "ufs"))
325 			continue;
326 		fs = allocfsent(fs);
327 		if ((pf = (struct pfstab *)malloc(sizeof (*pf))) == NULL)
328 			quit("%s\n", strerror(errno));
329 		pf->pf_fstab = fs;
330 		SLIST_INSERT_HEAD(&table, pf, pf_list);
331 	}
332 	(void) endfsent();
333 }
334 
335 /*
336  * Search in the fstab for a file name.
337  * This file name can be either the special or the path file name.
338  *
339  * The file name can omit the leading '/'.
340  */
341 struct fstab *
342 fstabsearch(const char *key)
343 {
344 	struct pfstab *pf;
345 	struct fstab *fs;
346 	char *rn;
347 
348 	SLIST_FOREACH(pf, &table, pf_list) {
349 		fs = pf->pf_fstab;
350 		if (strcmp(fs->fs_file, key) == 0 ||
351 		    strcmp(fs->fs_spec, key) == 0)
352 			return (fs);
353 		rn = rawname(fs->fs_spec);
354 		if (rn != NULL && strcmp(rn, key) == 0)
355 			return (fs);
356 		if (key[0] != '/') {
357 			if (*fs->fs_spec == '/' &&
358 			    strcmp(fs->fs_spec + 1, key) == 0)
359 				return (fs);
360 			if (*fs->fs_file == '/' &&
361 			    strcmp(fs->fs_file + 1, key) == 0)
362 				return (fs);
363 		}
364 	}
365 	return (NULL);
366 }
367 
368 /*
369  *	Tell the operator what to do
370  */
371 void
372 lastdump(int arg)	/* w ==> just what to do; W ==> most recent dumps */
373 {
374 	int i;
375 	struct fstab *dt;
376 	struct dumpdates *dtwalk;
377 	char *lastname, *date;
378 	int dumpme;
379 	time_t tnow;
380 	struct tm *tlast;
381 
382 	(void) time(&tnow);
383 	dump_getfstab();	/* /etc/fstab input */
384 	initdumptimes();	/* /etc/dumpdates input */
385 	qsort((char *) ddatev, nddates, sizeof(struct dumpdates *), datesort);
386 
387 	if (arg == 'w')
388 		(void) printf("Dump these file systems:\n");
389 	else
390 		(void) printf("Last dump(s) done (Dump '>' file systems):\n");
391 	lastname = "??";
392 	ITITERATE(i, dtwalk) {
393 		if (strncmp(lastname, dtwalk->dd_name,
394 		    sizeof(dtwalk->dd_name)) == 0)
395 			continue;
396 		date = (char *)ctime(&dtwalk->dd_ddate);
397 		date[16] = '\0';	/* blast away seconds and year */
398 		lastname = dtwalk->dd_name;
399 		dt = fstabsearch(dtwalk->dd_name);
400 		dumpme = (dt != NULL && dt->fs_freq != 0);
401 		if (dumpme) {
402 		    tlast = localtime(&dtwalk->dd_ddate);
403 		    dumpme = tnow > (dtwalk->dd_ddate - (tlast->tm_hour * 3600)
404 				     - (tlast->tm_min * 60) - tlast->tm_sec
405 				     + (dt->fs_freq * 86400));
406 		}
407 		if (arg != 'w' || dumpme)
408 			(void) printf(
409 			    "%c %8s\t(%6s) Last dump: Level %d, Date %s\n",
410 			    dumpme && (arg != 'w') ? '>' : ' ',
411 			    dtwalk->dd_name,
412 			    dt ? dt->fs_file : "",
413 			    dtwalk->dd_level,
414 			    date);
415 	}
416 }
417 
418 int
419 datesort(const void *a1, const void *a2)
420 {
421 	struct dumpdates *d1 = *(struct dumpdates **)a1;
422 	struct dumpdates *d2 = *(struct dumpdates **)a2;
423 	int diff;
424 
425 	diff = strncmp(d1->dd_name, d2->dd_name, sizeof(d1->dd_name));
426 	if (diff == 0)
427 		return (d2->dd_ddate - d1->dd_ddate);
428 	return (diff);
429 }
430