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
37#ifndef _PROTOCOLS_DUMPRESTORE_H_
38#define _PROTOCOLS_DUMPRESTORE_H_
39
40/*
41 * TP_BSIZE is the size of file blocks on the dump tapes.
42 * Note that TP_BSIZE must be a multiple of DEV_BSIZE.
43 *
44 * NTREC is the number of TP_BSIZE blocks that are written
45 * in each tape record. HIGHDENSITYTREC is the number of
46 * TP_BSIZE blocks that are written in each tape record on
47 * 6250 BPI or higher density tapes.
48 *
49 * TP_NINDIR is the number of indirect pointers in a TS_INODE
50 * or TS_ADDR record. Note that it must be a power of two.
51 */
52#define TP_BSIZE	1024
53#define NTREC   	10
54#define HIGHDENSITYTREC	32
55#define TP_NINDIR	(TP_BSIZE/2)
56#define LBLSIZE		16
57#define NAMELEN		64
58
59#define OFS_MAGIC   	(int)60011
60#define NFS_MAGIC   	(int)60012
61#ifndef FS_UFS2_MAGIC
62#define FS_UFS2_MAGIC  	(int)0x19540119
63#endif
64#define CHECKSUM	(int)84446
65
66/*
67 * Since ino_t size is changing to 64-bits, yet we desire this structure to
68 * remain compatible with exiting dump formats, we do NOT use ino_t here,
69 * but rather define a 32-bit type in its place.  At some point, it may be
70 * necessary to use some of the c_spare[] in order to fully support 64-bit
71 * inode numbers.
72 */
73typedef uint32_t dump_ino_t;
74
75extern union u_spcl {
76	char dummy[TP_BSIZE];
77	struct	s_spcl {
78		int32_t	c_type;		    /* record type (see below) */
79		int32_t	c_old_date;	    /* date of this dump */
80		int32_t	c_old_ddate;	    /* date of previous dump */
81		int32_t	c_volume;	    /* dump volume number */
82		int32_t	c_old_tapea;	    /* logical block of this record */
83		dump_ino_t c_inumber;	    /* number of inode */
84		int32_t	c_magic;	    /* magic number (see above) */
85		int32_t	c_checksum;	    /* record checksum */
86		/*
87		 * Start old dinode structure, expanded for binary
88		 * compatibility with UFS1.
89		 */
90		u_int16_t c_mode;	    /* file mode */
91		int16_t	c_spare1[3];	    /* old nlink, ids */
92		u_int64_t c_size;	    /* file byte count */
93		int32_t	c_old_atime;	    /* old last access time, seconds */
94		int32_t	c_atimensec;	    /* last access time, nanoseconds */
95		int32_t	c_old_mtime;	    /* old last modified time, secs */
96		int32_t	c_mtimensec;	    /* last modified time, nanosecs */
97		int32_t	c_spare2[2];	    /* old ctime */
98		int32_t	c_rdev;		    /* for devices, device number */
99		int32_t	c_birthtimensec;    /* creation time, nanosecs */
100		int64_t	c_birthtime;	    /* creation time, seconds */
101		int64_t	c_atime;	    /* last access time, seconds */
102		int64_t	c_mtime;	    /* last modified time, seconds */
103		int32_t	c_extsize;	    /* external attribute size */
104		int32_t	c_spare4[6];	    /* old block pointers */
105		u_int32_t c_file_flags;	    /* status flags (chflags) */
106		int32_t	c_spare5[2];	    /* old blocks, generation number */
107		u_int32_t c_uid;	    /* file owner */
108		u_int32_t c_gid;	    /* file group */
109		int32_t	c_spare6[2];	    /* previously unused spares */
110		/*
111		 * End old dinode structure.
112		 */
113		int32_t	c_count;	    /* number of valid c_addr entries */
114		char	c_addr[TP_NINDIR];  /* 1 => data; 0 => hole in inode */
115		char	c_label[LBLSIZE];   /* dump label */
116		int32_t	c_level;	    /* level of this dump */
117		char	c_filesys[NAMELEN]; /* name of dumped file system */
118		char	c_dev[NAMELEN];	    /* name of dumped device */
119		char	c_host[NAMELEN];    /* name of dumped host */
120		int32_t	c_flags;	    /* additional information */
121		int32_t	c_old_firstrec;	    /* first record on volume */
122		int64_t	c_date;		    /* date of this dump */
123		int64_t	c_ddate;	    /* date of previous dump */
124		int64_t	c_tapea;	    /* logical block of this record */
125		int64_t	c_firstrec;	    /* first record on volume */
126		int32_t	c_spare[24];	    /* reserved for future uses */
127	} s_spcl;
128} u_spcl;
129#define spcl u_spcl.s_spcl
130/*
131 * special record types
132 */
133#define TS_TAPE 	1	/* dump tape header */
134#define TS_INODE	2	/* beginning of file record */
135#define TS_ADDR 	4	/* continuation of file record */
136#define TS_BITS 	3	/* map of inodes on tape */
137#define TS_CLRI 	6	/* map of inodes deleted since last dump */
138#define TS_END  	5	/* end of volume marker */
139
140#endif /* !_DUMPRESTORE_H_ */
141