dump/optr.c

   1 /*
   2  *      Ported to Linux's Second Extended File System as part of the
   3  *      dump and restore backup suit
   4  *      Remy Card <card@Linux.EU.Org>, 1994-1997
   5  *      Stelian Pop <pop@cybercable.fr>, 1999-2000
   6  */
   7
   8 /*-
   9  * Copyright (c) 1980, 1988, 1993
  10  *      The Regents of the University of California.  All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. All advertising materials mentioning features or use of this software
  21  *    must display the following acknowledgement:
  22  *      This product includes software developed by the University of
  23  *      California, Berkeley and its contributors.
  24  * 4. Neither the name of the University nor the names of its contributors
  25  *    may be used to endorse or promote products derived from this software
  26  *    without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38  * SUCH DAMAGE.
  39  */
  40
  41 #ifndef lint
  42 static const char rcsid[] =
  43         "$Id: optr.c,v 1.9 2000/01/26 11:38:08 stelian Exp $";
  44 #endif /* not lint */
  45
  46 #include <sys/param.h>
  47 #include <sys/wait.h>
  48 #include <sys/time.h>
  49
  50 #include <errno.h>
  51 #include <fstab.h>
  52 #include <grp.h>
  53 #include <stdio.h>
  54 #include <stdlib.h>
  55 #include <string.h>
  56 #include <stdarg.h>
  57 #include <unistd.h>
  58 #include <utmp.h>
  59 #include <sys/stat.h>
  60
  61 #ifdef __linux__
  62 #include <linux/ext2_fs.h>
  63 #include <ext2fs/ext2fs.h>
  64 #include <bsdcompat.h>
  65 #include <signal.h>
  66 #endif
  67
  68 #include "dump.h"
  69 #include "pathnames.h"
  70
  71 static  void alarmcatch __P((int));
  72 int     datesort __P((const void *, const void *));
  73 static  void sendmes __P((const char *, const char *));
  74
  75 /*
  76  *      Query the operator; This previously-fascist piece of code
  77  *      no longer requires an exact response.
  78  *      It is intended to protect dump aborting by inquisitive
  79  *      people banging on the console terminal to see what is
  80  *      happening which might cause dump to croak, destroying
  81  *      a large number of hours of work.
  82  *
  83  *      Every 2 minutes we reprint the message, alerting others
  84  *      that dump needs attention.
  85  */
  86 static  int timeout;
  87 static  const char *attnmessage;                /* attention message */
  88
  89 int
  90 query(const char *question)
  91 {
  92         char    replybuffer[64];
  93         int     back, errcount;
  94         FILE    *mytty;
  95         time_t  firstprompt, when_answered;
  96
  97 #ifdef __linux__
  98         (void)time4(&(firstprompt));
  99 #else
 100         (void)time((time_t *)&(firstprompt));
 101 #endif
 102
 103         if ((mytty = fopen(_PATH_TTY, "r")) == NULL)
 104                 quit("fopen on %s fails: %s\n", _PATH_TTY, strerror(errno));
 105         attnmessage = question;
 106         timeout = 0;
 107         alarmcatch(0);
 108         back = -1;
 109         errcount = 0;
 110         do {
 111                 if (fgets(replybuffer, 63, mytty) == NULL) {
 112                         clearerr(mytty);
 113                         if (++errcount > 30)    /* XXX  ugly */
 114                                 quit("excessive operator query failures\n");
 115                 } else if (replybuffer[0] == 'y' || replybuffer[0] == 'Y') {
 116                         back = 1;
 117                 } else if (replybuffer[0] == 'n' || replybuffer[0] == 'N') {
 118                         back = 0;
 119                 } else {
 120                         (void) fprintf(stderr,
 121                             "  DUMP: \"Yes\" or \"No\"?\n");
 122                         (void) fprintf(stderr,
 123                             "  DUMP: %s: (\"yes\" or \"no\") ", question);
 124                 }
 125         } while (back < 0);
 126
 127         /*
 128          *      Turn off the alarm, and reset the signal to trap out..
 129          */
 130         (void) alarm(0);
 131         if (signal(SIGALRM, sig) == SIG_IGN)
 132                 signal(SIGALRM, SIG_IGN);
 133         (void) fclose(mytty);
 134 #ifdef __linux__
 135         (void)time4(&(when_answered));
 136 #else
 137         (void)time((time_t *)&(when_answered));
 138 #endif
 139         /*
 140          * Adjust the base for time estimates to ignore time we spent waiting
 141          * for operator input.
 142          */
 143         if ((tstart_writing != 0) && (when_answered != (time_t)-1) && (firstprompt != (time_t)-1))
 144                 tstart_writing += (when_answered - firstprompt);
 145         return(back);
 146 }
 147
 148 char lastmsg[BUFSIZ];
 149
 150 /*
 151  *      Alert the console operator, and enable the alarm clock to
 152  *      sleep for 2 minutes in case nobody comes to satisfy dump
 153  */
 154 static void
 155 alarmcatch(int signo)
 156 {
 157         int save_errno = errno;
 158         if (notify == 0) {
 159                 if (timeout == 0)
 160                         (void) fprintf(stderr,
 161                             "  DUMP: %s: (\"yes\" or \"no\") ",
 162                             attnmessage);
 163                 else
 164                         msgtail("\7\7");
 165         } else {
 166                 if (timeout) {
 167                         msgtail("\n");
 168                         broadcast("");          /* just print last msg */
 169                 }
 170                 (void) fprintf(stderr,"  DUMP: %s: (\"yes\" or \"no\") ",
 171                     attnmessage);
 172         }
 173         signal(SIGALRM, alarmcatch);
 174         (void) alarm(120);
 175         timeout = 1;
 176         errno = save_errno;
 177 }
 178
 179 /*
 180  *      Here if an inquisitive operator interrupts the dump program
 181  */
 182 void
 183 interrupt(int signo)
 184 {
 185         msg("Interrupt received.\n");
 186         if (query("Do you want to abort dump?"))
 187                 dumpabort(0);
 188 }
 189
 190 /*
 191  *      The following variables and routines manage alerting
 192  *      operators to the status of dump.
 193  *      This works much like wall(1) does.
 194  */
 195 struct  group *gp;
 196
 197 /*
 198  *      Get the names from the group entry "operator" to notify.
 199  */
 200 void
 201 set_operators(void)
 202 {
 203         if (!notify)            /*not going to notify*/
 204                 return;
 205         gp = getgrnam(OPGRENT);
 206         (void) endgrent();
 207         if (gp == NULL) {
 208                 msg("No group entry for %s.\n", OPGRENT);
 209                 notify = 0;
 210                 return;
 211         }
 212 }
 213
 214 struct tm *localclock;
 215
 216 /*
 217  *      We fork a child to do the actual broadcasting, so
 218  *      that the process control groups are not messed up
 219  */
 220 void
 221 broadcast(const char *message)
 222 {
 223         time_t          clock;
 224         FILE    *f_utmp;
 225         struct  utmp    utmp;
 226         char    **np;
 227         int     pid, s;
 228
 229         if (!notify || gp == NULL)
 230                 return;
 231
 232         switch (pid = fork()) {
 233         case -1:
 234                 return;
 235         case 0:
 236                 break;
 237         default:
 238                 while (wait(&s) != pid)
 239                         continue;
 240                 return;
 241         }
 242
 243         clock = time((time_t *)0);
 244         localclock = localtime(&clock);
 245
 246         if ((f_utmp = fopen(_PATH_UTMP, "r")) == NULL) {
 247                 msg("Cannot open %s: %s\n", _PATH_UTMP, strerror(errno));
 248                 return;
 249         }
 250
 251         while (!feof(f_utmp)) {
 252                 if (fread((char *) &utmp, sizeof (struct utmp), 1, f_utmp) != 1)
 253                         break;
 254                 if (utmp.ut_name[0] == 0)
 255                         continue;
 256                 for (np = gp->gr_mem; *np; np++) {
 257                         if (strncmp(*np, utmp.ut_name, sizeof(utmp.ut_name)) != 0)
 258                                 continue;
 259                         /*
 260                          *      Do not send messages to operators on dialups
 261                          */
 262                         if (strncmp(utmp.ut_line, DIALUP, strlen(DIALUP)) == 0)
 263                                 continue;
 264 #ifdef DEBUG
 265                         msg("Message to %s at %s\n", *np, utmp.ut_line);
 266 #endif
 267                         sendmes(utmp.ut_line, message);
 268                 }
 269         }
 270         (void) fclose(f_utmp);
 271         Exit(0);        /* the wait in this same routine will catch this */
 272         /* NOTREACHED */
 273 }
 274
 275 static void
 276 sendmes(const char *tty, const char *message)
 277 {
 278         char t[MAXPATHLEN], buf[BUFSIZ];
 279         register const char *cp;
 280         int lmsg = 1;
 281         FILE *f_tty;
 282
 283         (void) strcpy(t, _PATH_DEV);
 284         (void) strncat(t, tty, sizeof t - strlen(_PATH_DEV) - 1);
 285
 286         if ((f_tty = fopen(t, "w")) != NULL) {
 287                 setbuf(f_tty, buf);
 288                 (void) fprintf(f_tty,
 289                     "\n\
 290 \7\7\7Message from the dump program to all operators at %d:%02d ...\r\n\n\
 291 DUMP: NEEDS ATTENTION: ",
 292                     localclock->tm_hour, localclock->tm_min);
 293                 for (cp = lastmsg; ; cp++) {
 294                         if (*cp == '\0') {
 295                                 if (lmsg) {
 296                                         cp = message;
 297                                         if (!(cp && *cp != '\0'))
 298                                                 break;
 299                                         lmsg = 0;
 300                                 } else
 301                                         break;
 302                         }
 303                         if (*cp == '\n')
 304                                 (void) putc('\r', f_tty);
 305                         (void) putc(*cp, f_tty);
 306                 }
 307                 (void) fclose(f_tty);
 308         }
 309 }
 310
 311 /*
 312  *      print out an estimate of the amount of time left to do the dump
 313  */
 314
 315 time_t  tschedule = 0;
 316
 317 void
 318 timeest(void)
 319 {
 320         time_t  tnow, deltat;
 321
 322 #ifdef __linux__
 323         (void) time4(&tnow);
 324 #else
 325         (void) time((time_t *) &tnow);
 326 #endif
 327         if (tnow >= tschedule) {
 328                 tschedule = tnow + 300;
 329                 if (blockswritten < 500)
 330                         return;
 331                 deltat = tstart_writing - tnow +
 332                         (1.0 * (tnow - tstart_writing))
 333                         / blockswritten * tapesize;
 334                 msg("%3.2f%% done, finished in %d:%02d\n",
 335                         (blockswritten * 100.0) / tapesize,
 336                         deltat / 3600, (deltat % 3600) / 60);
 337         }
 338 }
 339
 340 void
 341 #ifdef __STDC__
 342 msg(const char *fmt, ...)
 343 #else
 344 msg(fmt, va_alist)
 345         char *fmt;
 346         va_dcl
 347 #endif
 348 {
 349         va_list ap;
 350
 351         (void) fprintf(stderr,"  DUMP: ");
 352 #ifdef TDEBUG
 353         (void) fprintf(stderr, "pid=%d ", getpid());
 354 #endif
 355 #ifdef __STDC__
 356         va_start(ap, fmt);
 357 #else
 358         va_start(ap);
 359 #endif
 360         (void) vfprintf(stderr, fmt, ap);
 361         va_end(ap);
 362         (void) fflush(stdout);
 363         (void) fflush(stderr);
 364 #ifdef __STDC__
 365         va_start(ap, fmt);
 366 #else
 367         va_start(ap);
 368 #endif
 369         (void) vsnprintf(lastmsg, sizeof(lastmsg), fmt, ap);
 370         va_end(ap);
 371 }
 372
 373 void
 374 #ifdef __STDC__
 375 msgtail(const char *fmt, ...)
 376 #else
 377 msgtail(fmt, va_alist)
 378         char *fmt;
 379         va_dcl
 380 #endif
 381 {
 382         va_list ap;
 383 #ifdef __STDC__
 384         va_start(ap, fmt);
 385 #else
 386         va_start(ap);
 387 #endif
 388         (void) vfprintf(stderr, fmt, ap);
 389         va_end(ap);
 390 }
 391
 392 void
 393 #ifdef __STDC__
 394 quit(const char *fmt, ...)
 395 #else
 396 quit(fmt, va_alist)
 397         char *fmt;
 398         va_dcl
 399 #endif
 400 {
 401         va_list ap;
 402
 403         (void) fprintf(stderr,"  DUMP: ");
 404 #ifdef TDEBUG
 405         (void) fprintf(stderr, "pid=%d ", getpid());
 406 #endif
 407 #ifdef __STDC__
 408         va_start(ap, fmt);
 409 #else
 410         va_start(ap);
 411 #endif
 412         (void) vfprintf(stderr, fmt, ap);
 413         va_end(ap);
 414         (void) fflush(stdout);
 415         (void) fflush(stderr);
 416         dumpabort(0);
 417 }
 418
 419 /*
 420  *      Tell the operator what has to be done;
 421  *      we don't actually do it
 422  */
 423
 424 static struct fstab *
 425 allocfsent(struct fstab *fs)
 426 {
 427         register struct fstab *new;
 428
 429         new = (struct fstab *)malloc(sizeof (*fs));
 430         if (new == NULL)
 431                 quit("%s\n", strerror(errno));
 432         if (strlen(fs->fs_file) > 1 && fs->fs_file[strlen(fs->fs_file) - 1] == '/')
 433                 fs->fs_file[strlen(fs->fs_file) - 1] = '\0';
 434         if ((new->fs_file = strdup(fs->fs_file)) == NULL ||
 435             (new->fs_type = strdup(fs->fs_type)) == NULL ||
 436             (new->fs_spec = strdup(fs->fs_spec)) == NULL)
 437                 quit("%s\n", strerror(errno));
 438         new->fs_passno = fs->fs_passno;
 439         new->fs_freq = fs->fs_freq;
 440         return (new);
 441 }
 442
 443 struct  pfstab {
 444         struct  pfstab *pf_next;
 445         struct  fstab *pf_fstab;
 446 };
 447
 448 static  struct pfstab *table;
 449
 450 void
 451 getfstab(void)
 452 {
 453         register struct fstab *fs;
 454         register struct pfstab *pf;
 455
 456         if (setfsent() == 0) {
 457                 msg("Can't open %s for dump table information: %s\n",
 458                     _PATH_FSTAB, strerror(errno));
 459                 return;
 460         }
 461         while ((fs = getfsent()) != NULL) {
 462                 if (strcmp(fs->fs_type, FSTAB_RW) &&
 463                     strcmp(fs->fs_type, FSTAB_RO) &&
 464                     strcmp(fs->fs_type, FSTAB_RQ))
 465                         continue;
 466                 fs = allocfsent(fs);
 467                 if ((pf = (struct pfstab *)malloc(sizeof (*pf))) == NULL)
 468                         quit("%s\n", strerror(errno));
 469                 pf->pf_fstab = fs;
 470                 pf->pf_next = table;
 471                 table = pf;
 472         }
 473         (void) endfsent();
 474 }
 475
 476 /*
 477  * Search in the fstab for a file name.
 478  * This file name can be either the special or the path file name.
 479  *
 480  * The entries in the fstab are the BLOCK special names, not the
 481  * character special names.
 482  * The caller of fstabsearch assures that the character device
 483  * is dumped (that is much faster)
 484  *
 485  * The file name can omit the leading '/'.
 486  */
 487 struct fstab *
 488 fstabsearch(const char *key)
 489 {
 490         register struct pfstab *pf;
 491         register struct fstab *fs;
 492         char *rn;
 493
 494         for (pf = table; pf != NULL; pf = pf->pf_next) {
 495                 fs = pf->pf_fstab;
 496                 if (strcmp(fs->fs_file, key) == 0 ||
 497                     strcmp(fs->fs_spec, key) == 0)
 498                         return (fs);
 499                 rn = rawname(fs->fs_spec);
 500                 if (rn != NULL && strcmp(rn, key) == 0)
 501                         return (fs);
 502                 if (key[0] != '/') {
 503                         if (*fs->fs_spec == '/' &&
 504                             strcmp(fs->fs_spec + 1, key) == 0)
 505                                 return (fs);
 506                         if (*fs->fs_file == '/' &&
 507                             strcmp(fs->fs_file + 1, key) == 0)
 508                                 return (fs);
 509                 }
 510         }
 511         return (NULL);
 512 }
 513
 514 #ifdef  __linux__
 515 struct fstab *
 516 fstabsearchdir(const char *key, char *directory)
 517 {
 518         register struct pfstab *pf;
 519         register struct fstab *fs;
 520         register struct fstab *found_fs = NULL;
 521         unsigned int size = 0;
 522         struct stat buf;
 523
 524         if (stat(key, &buf) == 0 && S_ISBLK(buf.st_mode))
 525                 return NULL;
 526
 527         for (pf = table; pf != NULL; pf = pf->pf_next) {
 528                 fs = pf->pf_fstab;
 529                 if (strlen(fs->fs_file) > size &&
 530                     strlen(key) > strlen(fs->fs_file) + 2 &&
 531                     strncmp(fs->fs_file, key, strlen(fs->fs_file)) == 0 &&
 532                     (key[strlen(fs->fs_file)] == '/' ||
 533                      fs->fs_file[strlen(fs->fs_file) - 1] == '/')) {
 534                         found_fs = fs;
 535                         size = strlen(fs->fs_file);
 536                 }
 537         }
 538         if (found_fs != NULL) {
 539                 /*
 540                  * Ok, we have found a fstab entry which matches the argument
 541                  * We have to split the argument name into:
 542                  * - a device name (from the fstab entry)
 543                  * - a directory name on this device
 544                  */
 545                 strcpy(directory, key + size);
 546         }
 547         return(found_fs);
 548 }
 549 #endif
 550
 551 /*
 552  *      Tell the operator what to do
 553  */
 554 void
 555 lastdump(char arg) /* w ==> just what to do; W ==> most recent dumps */
 556 {
 557         register int i;
 558         register struct fstab *dt;
 559         register struct dumpdates *dtwalk=NULL;
 560         char *lastname, *date;
 561         int dumpme;
 562         time_t tnow;
 563
 564         (void) time(&tnow);
 565         getfstab();             /* /etc/fstab input */
 566         initdumptimes(0);       /* dumpdates input */
 567         if (ddatev != NULL) {
 568                 qsort((char *) ddatev, nddates, sizeof(struct dumpdates *), datesort);
 569
 570                 if (arg == 'w')
 571                         (void) printf("Dump these file systems:\n");
 572                 else
 573                         (void) printf("Last dump(s) done (Dump '>' file systems):\n");
 574                 lastname = "??";
 575                 ITITERATE(i, dtwalk) {
 576                         if (strncmp(lastname, dtwalk->dd_name,
 577                                 sizeof(dtwalk->dd_name)) == 0)
 578                                 continue;
 579                         date = (char *)ctime(&dtwalk->dd_ddate);
 580                         date[16] = '\0';        /* blast away seconds and year */
 581                         lastname = dtwalk->dd_name;
 582                         dt = fstabsearch(dtwalk->dd_name);
 583                         dumpme = (dt != NULL &&
 584                                 dt->fs_freq != 0 &&
 585                                 dtwalk->dd_ddate < tnow - (dt->fs_freq * 86400));
 586                         if (arg != 'w' || dumpme)
 587                                 (void) printf(
 588                                         "%c %8s\t(%6s) Last dump: Level %c, Date %s\n",
 589                                         dumpme && (arg != 'w') ? '>' : ' ',
 590                                         dtwalk->dd_name,
 591                                         dt ? dt->fs_file : "",
 592                                         dtwalk->dd_level,
 593                                         date);
 594                 }
 595         }
 596 }
 597
 598 int
 599 datesort(const void *a1, const void *a2)
 600 {
 601         struct dumpdates *d1 = *(struct dumpdates **)a1;
 602         struct dumpdates *d2 = *(struct dumpdates **)a2;
 603         int diff;
 604
 605         diff = strncmp(d1->dd_name, d2->dd_name, sizeof(d1->dd_name));
 606         if (diff == 0)
 607                 return (d2->dd_ddate - d1->dd_ddate);
 608         return (diff);
 609 }