root/sbin/restore/restore.h
/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 1983, 1993
 *      The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/*
 * Flags
 */
extern int      bflag;          /* set input block size */
extern int      dflag;          /* print out debugging info */
extern int      Dflag;          /* degraded mode - try hard to get stuff back */
extern int      hflag;          /* restore hierarchies */
extern int      mflag;          /* restore by name instead of inode number */
extern int      Nflag;          /* do not write the disk */
extern int      uflag;          /* unlink symlink targets */
extern int      vflag;          /* print out actions taken */
extern int      yflag;          /* always try to recover from tape errors */
/*
 * Global variables
 */
extern char     *dumpmap;       /* map of inodes on this dump tape */
extern char     *usedinomap;    /* map of inodes that are in use on this fs */
extern ino_t    maxino;         /* highest numbered inode in this file system */
extern long     dumpnum;        /* location of the dump on this tape */
extern long     volno;          /* current volume being read */
extern long     ntrec;          /* number of TP_BSIZE records per tape block */
extern time_t   dumptime;       /* time that this dump begins */
extern time_t   dumpdate;       /* time that this dump was made */
extern char     command;        /* operation being performed */
extern FILE     *terminal;      /* file descriptor for the terminal input */
extern int      Bcvt;           /* need byte swapping on inodes and dirs */
extern int      oldinofmt;      /* reading tape with FreeBSD 1 format inodes */

/*
 * Each file in the file system is described by one of these entries
 */
struct entry {
        char    *e_name;                /* the current name of this entry */
        u_char  e_namlen;               /* length of this name */
        char    e_type;                 /* type of this entry, see below */
        short   e_flags;                /* status flags, see below */
        ino_t   e_ino;                  /* inode number in previous file sys */
        long    e_index;                /* unique index (for dumped table) */
        struct  entry *e_parent;        /* pointer to parent directory (..) */
        struct  entry *e_sibling;       /* next element in this directory (.) */
        struct  entry *e_links;         /* hard links to this inode */
        struct  entry *e_entries;       /* for directories, their entries */
        struct  entry *e_next;          /* hash chain list */
};
/* types */
#define LEAF 1                  /* non-directory entry */
#define NODE 2                  /* directory entry */
#define LINK 4                  /* synthesized type, stripped by addentry */
/* flags */
#define EXTRACT         0x0001  /* entry is to be replaced from the tape */
#define NEW             0x0002  /* a new entry to be extracted */
#define KEEP            0x0004  /* entry is not to change */
#define REMOVED         0x0010  /* entry has been removed */
#define TMPNAME         0x0020  /* entry has been given a temporary name */
#define EXISTED         0x0040  /* directory already existed during extract */

/*
 * Constants associated with entry structs
 */
#define HARDLINK        1
#define SYMLINK         2
#define TMPHDR          "RSTTMP"

/*
 * The entry describes the next file available on the tape
 */
extern struct context {
        short   action;         /* action being taken on this file */
        mode_t  mode;           /* mode of file */
        ino_t   ino;            /* inumber of file */
        uid_t   uid;            /* file owner */
        gid_t   gid;            /* file group */
        int     file_flags;     /* status flags (chflags) */
        int     rdev;           /* device number of file */
        time_t  atime_sec;      /* access time seconds */
        time_t  mtime_sec;      /* modified time seconds */
        time_t  birthtime_sec;  /* creation time seconds */
        int     atime_nsec;     /* access time nanoseconds */
        int     mtime_nsec;     /* modified time nanoseconds */
        int     birthtime_nsec; /* creation time nanoseconds */
        int     extsize;        /* size of extended attribute data */
        off_t   size;           /* size of file */
        char    *name;          /* name of file */
} curfile;
/* actions */
#define USING   1       /* extracting from the tape */
#define SKIP    2       /* skipping */
#define UNKNOWN 3       /* disposition or starting point is unknown */

/*
 * Definitions for library routines operating on directories.
 */
typedef struct rstdirdesc RST_DIR;

/*
 * Flags to setdirmodes.
 */
#define FORCE   0x0001

/*
 * Useful macros
 */
#define TSTINO(ino, map) \
        (map[(u_int)((ino) - 1) / CHAR_BIT] & \
            (1 << ((u_int)((ino) - 1) % CHAR_BIT)))
#define SETINO(ino, map) \
        map[(u_int)((ino) - 1) / CHAR_BIT] |= \
            1 << ((u_int)((ino) - 1) % CHAR_BIT)

#define dprintf         if (dflag) fprintf
#define vprintf         if (vflag) fprintf

#define GOOD 1
#define FAIL 0

#define NFS_DR_NEWINODEFMT      0x2     /* Tape uses 4.4 BSD inode format */