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