include/protocols/dumprestore.h

/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 1980, 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.
 *
 *      @(#)dumprestore.h       8.2 (Berkeley) 1/21/94
 *
 * $FreeBSD$
 */

#ifndef _PROTOCOLS_DUMPRESTORE_H_
#define _PROTOCOLS_DUMPRESTORE_H_

/*
 * TP_BSIZE is the size of file blocks on the dump tapes.
 * Note that TP_BSIZE must be a multiple of DEV_BSIZE.
 *
 * NTREC is the number of TP_BSIZE blocks that are written
 * in each tape record. HIGHDENSITYTREC is the number of
 * TP_BSIZE blocks that are written in each tape record on
 * 6250 BPI or higher density tapes.
 *
 * TP_NINDIR is the number of indirect pointers in a TS_INODE
 * or TS_ADDR record. Note that it must be a power of two.
 */
#define TP_BSIZE        1024
#define NTREC           10
#define HIGHDENSITYTREC 32
#define TP_NINDIR       (TP_BSIZE/2)
#define LBLSIZE         16
#define NAMELEN         64

#define OFS_MAGIC       (int)60011
#define NFS_MAGIC       (int)60012
#ifndef FS_UFS2_MAGIC
#define FS_UFS2_MAGIC   (int)0x19540119
#endif
#define CHECKSUM        (int)84446

/*
 * Since ino_t size is changing to 64-bits, yet we desire this structure to
 * remain compatible with exiting dump formats, we do NOT use ino_t here,
 * but rather define a 32-bit type in its place.  At some point, it may be
 * necessary to use some of the c_spare[] in order to fully support 64-bit
 * inode numbers.
 */
typedef uint32_t dump_ino_t;

union u_spcl {
        char dummy[TP_BSIZE];
        struct  s_spcl {
                int32_t c_type;             /* record type (see below) */
                int32_t c_old_date;         /* date of this dump */
                int32_t c_old_ddate;        /* date of previous dump */
                int32_t c_volume;           /* dump volume number */
                int32_t c_old_tapea;        /* logical block of this record */
                dump_ino_t c_inumber;       /* number of inode */
                int32_t c_magic;            /* magic number (see above) */
                int32_t c_checksum;         /* record checksum */
                /*
                 * Start old dinode structure, expanded for binary
                 * compatibility with UFS1.
                 */
                u_int16_t c_mode;           /* file mode */
                int16_t c_spare1[3];        /* old nlink, ids */
                u_int64_t c_size;           /* file byte count */
                int32_t c_old_atime;        /* old last access time, seconds */
                int32_t c_atimensec;        /* last access time, nanoseconds */
                int32_t c_old_mtime;        /* old last modified time, secs */
                int32_t c_mtimensec;        /* last modified time, nanosecs */
                int32_t c_spare2[2];        /* old ctime */
                int32_t c_rdev;             /* for devices, device number */
                int32_t c_birthtimensec;    /* creation time, nanosecs */
                int64_t c_birthtime;        /* creation time, seconds */
                int64_t c_atime;            /* last access time, seconds */
                int64_t c_mtime;            /* last modified time, seconds */
                int32_t c_extsize;          /* external attribute size */
                int32_t c_spare4[6];        /* old block pointers */
                u_int32_t c_file_flags;     /* status flags (chflags) */
                int32_t c_spare5[2];        /* old blocks, generation number */
                u_int32_t c_uid;            /* file owner */
                u_int32_t c_gid;            /* file group */
                int32_t c_spare6[2];        /* previously unused spares */
                /*
                 * End old dinode structure.
                 */
                int32_t c_count;            /* number of valid c_addr entries */
                char    c_addr[TP_NINDIR];  /* 1 => data; 0 => hole in inode */
                char    c_label[LBLSIZE];   /* dump label */
                int32_t c_level;            /* level of this dump */
                char    c_filesys[NAMELEN]; /* name of dumpped file system */
                char    c_dev[NAMELEN];     /* name of dumpped device */
                char    c_host[NAMELEN];    /* name of dumpped host */
                int32_t c_flags;            /* additional information */
                int32_t c_old_firstrec;     /* first record on volume */
                int64_t c_date;             /* date of this dump */
                int64_t c_ddate;            /* date of previous dump */
                int64_t c_tapea;            /* logical block of this record */
                int64_t c_firstrec;         /* first record on volume */
                int32_t c_spare[24];        /* reserved for future uses */
        } s_spcl;
} u_spcl;
#define spcl u_spcl.s_spcl
/*
 * special record types
 */
#define TS_TAPE         1       /* dump tape header */
#define TS_INODE        2       /* beginning of file record */
#define TS_ADDR         4       /* continuation of file record */
#define TS_BITS         3       /* map of inodes on tape */
#define TS_CLRI         6       /* map of inodes deleted since last dump */
#define TS_END          5       /* end of volume marker */

#endif /* !_DUMPRESTORE_H_ */
1	/*-
2	* SPDX-License-Identifier: BSD-3-Clause
3	*
4	* Copyright (c) 1980, 1993
5	* The Regents of the University of California. All rights reserved.
6	* (c) UNIX System Laboratories, Inc.
7	* All or some portions of this file are derived from material licensed
8	* to the University of California by American Telephone and Telegraph
9	* Co. or Unix System Laboratories, Inc. and are reproduced herein with
10	* the permission of UNIX System Laboratories, Inc.
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. Neither the name of the University nor the names of its contributors
21	* may be used to endorse or promote products derived from this software
22	* without specific prior written permission.
23	*
24	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34	* SUCH DAMAGE.
35	*
36	* @(#)dumprestore.h 8.2 (Berkeley) 1/21/94
37	*
38	* $FreeBSD$
39	*/
40
41	#ifndef _PROTOCOLS_DUMPRESTORE_H_
42	#define _PROTOCOLS_DUMPRESTORE_H_
43
44	/*
45	* TP_BSIZE is the size of file blocks on the dump tapes.
46	* Note that TP_BSIZE must be a multiple of DEV_BSIZE.
47	*
48	* NTREC is the number of TP_BSIZE blocks that are written
49	* in each tape record. HIGHDENSITYTREC is the number of
50	* TP_BSIZE blocks that are written in each tape record on
51	* 6250 BPI or higher density tapes.
52	*
53	* TP_NINDIR is the number of indirect pointers in a TS_INODE
54	* or TS_ADDR record. Note that it must be a power of two.
55	*/
56	#define TP_BSIZE 1024
57	#define NTREC 10
58	#define HIGHDENSITYTREC 32
59	#define TP_NINDIR (TP_BSIZE/2)
60	#define LBLSIZE 16
61	#define NAMELEN 64
62
63	#define OFS_MAGIC (int)60011
64	#define NFS_MAGIC (int)60012
65	#ifndef FS_UFS2_MAGIC
66	#define FS_UFS2_MAGIC (int)0x19540119
67	#endif
68	#define CHECKSUM (int)84446
69
70	/*
71	* Since ino_t size is changing to 64-bits, yet we desire this structure to
72	* remain compatible with exiting dump formats, we do NOT use ino_t here,
73	* but rather define a 32-bit type in its place. At some point, it may be
74	* necessary to use some of the c_spare[] in order to fully support 64-bit
75	* inode numbers.
76	*/
77	typedef uint32_t dump_ino_t;
78
79	union u_spcl {
80	char dummy[TP_BSIZE];
81	struct s_spcl {
82	int32_t c_type; /* record type (see below) */
83	int32_t c_old_date; /* date of this dump */
84	int32_t c_old_ddate; /* date of previous dump */
85	int32_t c_volume; /* dump volume number */
86	int32_t c_old_tapea; /* logical block of this record */
87	dump_ino_t c_inumber; /* number of inode */
88	int32_t c_magic; /* magic number (see above) */
89	int32_t c_checksum; /* record checksum */
90	/*
91	* Start old dinode structure, expanded for binary
92	* compatibility with UFS1.
93	*/
94	u_int16_t c_mode; /* file mode */
95	int16_t c_spare1[3]; /* old nlink, ids */
96	u_int64_t c_size; /* file byte count */
97	int32_t c_old_atime; /* old last access time, seconds */
98	int32_t c_atimensec; /* last access time, nanoseconds */
99	int32_t c_old_mtime; /* old last modified time, secs */
100	int32_t c_mtimensec; /* last modified time, nanosecs */
101	int32_t c_spare2[2]; /* old ctime */
102	int32_t c_rdev; /* for devices, device number */
103	int32_t c_birthtimensec; /* creation time, nanosecs */
104	int64_t c_birthtime; /* creation time, seconds */
105	int64_t c_atime; /* last access time, seconds */
106	int64_t c_mtime; /* last modified time, seconds */
107	int32_t c_extsize; /* external attribute size */
108	int32_t c_spare4[6]; /* old block pointers */
109	u_int32_t c_file_flags; /* status flags (chflags) */
110	int32_t c_spare5[2]; /* old blocks, generation number */
111	u_int32_t c_uid; /* file owner */
112	u_int32_t c_gid; /* file group */
113	int32_t c_spare6[2]; /* previously unused spares */
114	/*
115	* End old dinode structure.
116	*/
117	int32_t c_count; /* number of valid c_addr entries */
118	char c_addr[TP_NINDIR]; /* 1 => data; 0 => hole in inode */
119	char c_label[LBLSIZE]; /* dump label */
120	int32_t c_level; /* level of this dump */
121	char c_filesys[NAMELEN]; /* name of dumpped file system */
122	char c_dev[NAMELEN]; /* name of dumpped device */
123	char c_host[NAMELEN]; /* name of dumpped host */
124	int32_t c_flags; /* additional information */
125	int32_t c_old_firstrec; /* first record on volume */
126	int64_t c_date; /* date of this dump */
127	int64_t c_ddate; /* date of previous dump */
128	int64_t c_tapea; /* logical block of this record */
129	int64_t c_firstrec; /* first record on volume */
130	int32_t c_spare[24]; /* reserved for future uses */
131	} s_spcl;
132	} u_spcl;
133	#define spcl u_spcl.s_spcl
134	/*
135	* special record types
136	*/
137	#define TS_TAPE 1 /* dump tape header */
138	#define TS_INODE 2 /* beginning of file record */
139	#define TS_ADDR 4 /* continuation of file record */
140	#define TS_BITS 3 /* map of inodes on tape */
141	#define TS_CLRI 6 /* map of inodes deleted since last dump */
142	#define TS_END 5 /* end of volume marker */
143
144	#endif /* !_DUMPRESTORE_H_ */