| blob | e9073cb3bb6399d4f7a2f44f8872e519199cfe2d |
1 '\" te
2 .\" Copyright (c) 1980 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution. Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
3 .TH UFSDUMP 4 "Apr 9, 2003"
4 .SH NAME
5 ufsdump, dumpdates \- incremental dump format
6 .SH SYNOPSIS
7 .LP
8 .nf
9 \fB#include <sys/types.h>\fR
10 .fi
12 .LP
13 .nf
14 \fB#include <sys/inode.h>\fR
15 .fi
17 .LP
18 .nf
19 \fB#include <protocols/dumprestore.h>\fR
20 .fi
22 .LP
23 .nf
24 \fB/etc/dumpdates\fR
25 .fi
27 .SH DESCRIPTION
28 .sp
29 .LP
30 Tapes used by \fBufsdump\fR(1M) and \fBufsrestore\fR(1M) contain:
31 .RS +4
32 .TP
33 .ie t \(bu
34 .el o
35 a header record
36 .RE
37 .RS +4
38 .TP
39 .ie t \(bu
40 .el o
41 two groups of bit map records
42 .RE
43 .RS +4
44 .TP
45 .ie t \(bu
46 .el o
47 a group of records describing directories
48 .RE
49 .RS +4
50 .TP
51 .ie t \(bu
52 .el o
53 a group of records describing files
54 .RE
55 .sp
56 .LP
57 The format of the header record and the format of the first record of each
58 description in the \fB<protocols/dumprestore.h>\fR include file are:
59 .sp
60 .in +2
61 .nf
62 #define TP_BSIZE_MAX 65536
63 #define TP_BSIZE_MIN 1024
64 #define ESIZE_SHIFT_MAX 6
66 #ifdef SUPPORTS_MTB_TAPE_FORMAT
67 #define TP_BUFSIZE TP_BSIZE_MAX
68 #else
69 #define TP_BSIZE 1024
70 #define TP_BUFSIZE TP_BSIZE
71 #endif /* SUPPORTS_MTB_TAPE_FORMAT */
73 #define NTREC 10
74 #define HIGHDENSITYTREC 32
75 #define CARTRIDGETREC 63
76 #define TP_NINDIR (TP_BSIZE_MIN/2)
77 #define TP_NINOS (TP_NINDIR / sizeof (long))
78 #define LBLSIZE 16
79 #define NAMELEN 64
81 #define OFS_MAGIC (int)60011
82 #define NFS_MAGIC (int)60012
83 #define MTB_MAGIC (int)60013
84 #define CHECKSUM (int)84446
85 .fi
86 .in -2
88 .sp
89 .in +2
90 .nf
91 union u_data {
92 char s_addrs[TP_NINDIR];
93 int32_t s_inos[TP_NINOS];
94 };
96 union u_shadow {
97 struct s_nonsh {
98 int32_t c_level;
99 char c_filesys[NAMELEN];
100 char c_dev[NAMELEN];
101 char c_host[NAMELEN];
102 } c_nonsh;
103 char c_shadow[1];
104 };
106 union u_spcl {
107 char dummy[TP_BUFSIZE];
108 struct s_spcl {
109 int32_t c_type;
110 time32_t c_date;
111 time32_t c_ddate;
112 int32_t c_volume;
113 daddr32_t c_tapea;
114 ino32_t c_inumber;
115 int32_t c_magic;
116 int32_t c_checksum;
117 struct dinode c_dinode;
118 int32_t c_count;
119 union u_data c_data;
120 char c_label[LBLSIZE];
121 union u_shadow c_shadow;
122 int32_t c_flags;
123 int32_t c_firstrec;
124 #ifdef SUPPORTS_MTB_TAPE_FORMAT
125 int32_t c_tpbsize;
126 int32_t c_spare[31];
127 #else
128 int32_t c_spare[32];
129 #endif /* SUPPORTS_MTB_TAPE_FORMAT */
130 } s_spcl;
131 } u_spcl;
132 .fi
133 .in -2
135 .sp
136 .in +2
137 .nf
138 int32_t c_type;
139 time32_t c_date;
140 time32_t c_ddate;
141 int32_t c_volume;
142 daddr32_t c_tapea;
143 ino32_t c_inumber;
144 int32_t c_magic;
145 int32_t c_checksum;
146 struct dinode c_dinode;
147 int32_t c_count;
148 union u_data c_data;
149 char c_label[LBLSIZE];
150 union u_shadow c_shadow;
151 int32_t c_flags;
152 int32_t c_firstrec;
153 #ifdef SUPPORTS_MTB_TAPE_FORMAT
154 int32_t c_tpbsize;
155 int32_t c_spare[31];
156 #else
157 int32_t c_spare[32];
158 #endif /*
159 SUPPORTS_MTB_TAPE_FORMAT */
160 .fi
161 .in -2
163 .sp
164 .in +2
165 .nf
166 } s_spcl;
167 } u_spcl;
168 #define spcl u_spcl.s_spcl
169 #define c_addr c_data.s_addrs
170 #define c_inos c_data.s_inos
171 #define c_level c_shadow.c_nonsh.c_level
172 #define c_filesys c_shadow.c_nonsh.c_filesys
173 #define c_dev c_shadow.c_nonsh.c_dev
174 #define c_host c_shadow.c_nonsh.c_host
175 .fi
176 .in -2
178 .sp
179 .in +2
180 .nf
181 #define TS_TAPE 1
182 #define TS_INODE 2
183 #define TS_ADDR 4
184 #define TS_BITS 3
185 #define TS_CLRI 6
186 #define TS_END 5
187 #define TS_EOM 7
189 #define DR_NEWHEADER 1
190 #define DR_INODEINFO 2
191 #define DR_REDUMP 4
192 #define DR_TRUEINC 8
193 #define DR_HASMETA 16
194 .fi
195 .in -2
197 .sp
198 .LP
199 This header describes three formats for the \fBufsdump\fR/\fBufsrestore\fR
200 interface:
201 .RS +4
202 .TP
203 .ie t \(bu
204 .el o
205 An old format, non-MTB, that supports dump sizes of less than 2 terabytes. This
206 format is represented by \fBNFS_MAGIC\fR.
207 .RE
208 .RS +4
209 .TP
210 .ie t \(bu
211 .el o
212 A new format, MTB, that supports dump sizes of greater than 2 terabytes using a
213 variable block size and 2 new constants: \fBTP_BSIZE_MIN\fR and
214 \fBTP_BSIZE_MAX\fR. This format is represented by \fBMTB_MAGIC\fR.
215 .RE
216 .RS +4
217 .TP
218 .ie t \(bu
219 .el o
220 A much older format that might be found on existing backup tapes. The
221 \fBufsrestore\fR command can restore tapes of this format, but no longer
222 generates tapes of this format. Backups in this format have the \fBOFS_MAGIC\fR
223 magic number in their tape headers.
224 .RE
225 .sp
226 .LP
227 The constants are described as follows:
228 .sp
229 .ne 2
230 .na
231 \fB\fBTP_BSIZE\fR\fR
232 .ad
233 .RS 20n
234 Size of file blocks on the dump tapes for the old format. Note that
235 \fBTP_BSIZE\fR must be a multiple of \fBDEV_BSIZE\fR This is applicable for
236 dumps of type \fBNFS_MAGIC\fR or \fBOFS_MAGIC\fR, but is not applicable for
237 dumps of type \fBMTB_MAGIC\fR.
238 .RE
240 .sp
241 .ne 2
242 .na
243 \fB\fBTP_BSIZE_MIN\fR\fR
244 .ad
245 .RS 20n
246 Minimum size of file blocks on the dump tapes for the new MTB format
247 (\fBMTB_MAGIC\fR) only.
248 .RE
250 .sp
251 .ne 2
252 .na
253 \fB\fBTP_BSIZE_MAX\fR\fR
254 .ad
255 .RS 20n
256 Maximum size of file blocks on the dump tapes for the new MTB format
257 (\fBMTB_MAGIC\fR) only.
258 .RE
260 .sp
261 .ne 2
262 .na
263 \fB\fBNTREC\fR\fR
264 .ad
265 .RS 20n
266 Number of \fBTP_BSIZE\fR blocks that are written in each tape record.
267 .RE
269 .sp
270 .ne 2
271 .na
272 \fB\fBHIGHDENSITYNTREC\fR\fR
273 .ad
274 .RS 20n
275 Number of \fBTP_BSIZE\fR blocks that are written in each tape record on 6250
276 BPI or higher density tapes.
277 .RE
279 .sp
280 .ne 2
281 .na
282 \fB\fBCARTRIDGETREC\fR\fR
283 .ad
284 .RS 20n
285 Number of \fBTP_BSIZE\fR blocks that are written in each tape record on
286 cartridge tapes.
287 .RE
289 .sp
290 .ne 2
291 .na
292 \fB\fBTP_NINDIR\fR\fR
293 .ad
294 .RS 20n
295 Number of indirect pointers in a \fBTS_INODE\fR or \fBTS_ADDR\fR record. It
296 must be a power of 2.
297 .RE
299 .sp
300 .ne 2
301 .na
302 \fB\fBTP_NINOS\fR\fR
303 .ad
304 .RS 20n
305 The maximum number of volumes on a tape.
306 .RE
308 .sp
309 .ne 2
310 .na
311 \fB\fBLBLSIZE\fR\fR
312 .ad
313 .RS 20n
314 The maximum size of a volume label.
315 .RE
317 .sp
318 .ne 2
319 .na
320 \fB\fBNAMELEN\fR\fR
321 .ad
322 .RS 20n
323 The maximum size of a host's name.
324 .RE
326 .sp
327 .ne 2
328 .na
329 \fB\fBOFS_MAGIC\fR\fR
330 .ad
331 .RS 20n
332 Magic number that is used for the very old format.
333 .RE
335 .sp
336 .ne 2
337 .na
338 \fB\fBNFS_MAGIC\fR\fR
339 .ad
340 .RS 20n
341 Magic number that is used for the non-MTB format.
342 .RE
344 .sp
345 .ne 2
346 .na
347 \fB\fBMTB_MAGIC\fR\fR
348 .ad
349 .RS 20n
350 Magic number that is used for the MTB format.
351 .RE
353 .sp
354 .ne 2
355 .na
356 \fB\fBCHECKSUM\fR\fR
357 .ad
358 .RS 20n
359 Header records checksum to this value.
360 .RE
362 .sp
363 .LP
364 The \fBTS_\fR entries are used in the \fBc_type\fR field to indicate what sort
365 of header this is. The types and their meanings are as follows:
366 .sp
367 .ne 2
368 .na
369 \fB\fBTS_TAPE\fR\fR
370 .ad
371 .RS 12n
372 Tape volume label.
373 .RE
375 .sp
376 .ne 2
377 .na
378 \fB\fBTS_INODE\fR\fR
379 .ad
380 .RS 12n
381 A file or directory follows. The \fBc_dinode\fR field is a copy of the disk
382 inode and contains bits telling what sort of file this is.
383 .RE
385 .sp
386 .ne 2
387 .na
388 \fB\fBTS_ADDR\fR\fR
389 .ad
390 .RS 12n
391 A subrecord of a file description. See \fBs_addrs\fR below.
392 .RE
394 .sp
395 .ne 2
396 .na
397 \fB\fBTS_BITS\fR\fR
398 .ad
399 .RS 12n
400 A bit map follows. This bit map has a one bit for each inode that was dumped.
401 .RE
403 .sp
404 .ne 2
405 .na
406 \fB\fBTS_CLRI\fR\fR
407 .ad
408 .RS 12n
409 A bit map follows. This bit map contains a zero bit for all inodes that were
410 empty on the file system when dumped.
411 .RE
413 .sp
414 .ne 2
415 .na
416 \fB\fBTS_END\fR\fR
417 .ad
418 .RS 12n
419 End of tape record.
420 .RE
422 .sp
423 .ne 2
424 .na
425 \fB\fBTS_EOM\fR\fR
426 .ad
427 .RS 12n
428 diskette \fBEOM\fRindicates that the restore is compatible with old dump
429 .RE
431 .sp
432 .LP
433 The flags are described as follows:
434 .sp
435 .ne 2
436 .na
437 \fB\fBDR_NEWHEADER\fR\fR
438 .ad
439 .RS 17n
440 New format tape header.
441 .RE
443 .sp
444 .ne 2
445 .na
446 \fB\fBDR_INFODEINFO\fR\fR
447 .ad
448 .RS 17n
449 Header contains starting inode info.
450 .RE
452 .sp
453 .ne 2
454 .na
455 \fB\fBDR_REDUMP\fR\fR
456 .ad
457 .RS 17n
458 Dump contains recopies of active files.
459 .RE
461 .sp
462 .ne 2
463 .na
464 \fB\fBDR_TRUEINC\fR\fR
465 .ad
466 .RS 17n
467 Dump is a "true incremental".
468 .RE
470 .sp
471 .ne 2
472 .na
473 \fB\fBDR_HASMETA\fR\fR
474 .ad
475 .RS 17n
476 The metadata in this header.
477 .RE
479 .sp
480 .ne 2
481 .na
482 \fB\fBDUMPOUTFMT\fR\fR
483 .ad
484 .RS 17n
485 Name, incon, and ctime (date) for printf.
486 .RE
488 .sp
489 .ne 2
490 .na
491 \fB\fBDUMPINFMT\fR\fR
492 .ad
493 .RS 17n
494 Inverse for scanf.
495 .RE
497 .sp
498 .LP
499 The fields of the header structure are as follows:
500 .sp
501 .ne 2
502 .na
503 \fB\fBs_addrs\fR\fR
504 .ad
505 .RS 17n
506 An array of bytes describing the blocks of the dumped file. A byte is zero if
507 the block associated with that byte was not present on the file system;
508 otherwise, the byte is non-zero. If the block was not present on the file
509 lsystem, no block was dumped; the block will be stored as a hole in the file.
510 If there is not sufficient space in this record to describe all the blocks in
511 a file, \fBTS_ADDR\fR records will be scattered through the file, each one
512 picking up where the last left off
513 .RE
515 .sp
516 .ne 2
517 .na
518 \fB\fBs_inos\fR\fR
519 .ad
520 .RS 17n
521 The starting inodes on tape.
522 .RE
524 .sp
525 .ne 2
526 .na
527 \fB\fBc_type\fR\fR
528 .ad
529 .RS 17n
530 The type of the record.
531 .RE
533 .sp
534 .ne 2
535 .na
536 \fB\fBc_date\fR\fR
537 .ad
538 .RS 17n
539 The date of the previous dump.
540 .RE
542 .sp
543 .ne 2
544 .na
545 \fB\fBc_ddate\fR\fR
546 .ad
547 .RS 17n
548 The date of this dump.
549 .RE
551 .sp
552 .ne 2
553 .na
554 \fB\fBc_volume\fR\fR
555 .ad
556 .RS 17n
557 The current volume number of the dump.
558 .RE
560 .sp
561 .ne 2
562 .na
563 \fB\fBc_tapea\fR\fR
564 .ad
565 .RS 17n
566 The logical block of this record.
567 .RE
569 .sp
570 .ne 2
571 .na
572 \fB\fBc_inumber\fR\fR
573 .ad
574 .RS 17n
575 The number of the inode being dumped if this is of type \fBTS_INODE\fR.
576 .RE
578 .sp
579 .ne 2
580 .na
581 \fB\fBc_magic\fR\fR
582 .ad
583 .RS 17n
584 This contains the value \fBMAGIC\fR above, truncated as needed.
585 .RE
587 .sp
588 .ne 2
589 .na
590 \fB\fBc_checksum\fR\fR
591 .ad
592 .RS 17n
593 This contains whatever value is needed to make the record sum to
594 \fBCHECKSUM\fR.
595 .RE
597 .sp
598 .ne 2
599 .na
600 \fB\fBc_dinode\fR\fR
601 .ad
602 .RS 17n
603 This is a copy of the inode as it appears on the file system.
604 .RE
606 .sp
607 .ne 2
608 .na
609 \fB\fBc_count\fR\fR
610 .ad
611 .RS 17n
612 The count of bytes in \fBs_addrs\fR.
613 .RE
615 .sp
616 .ne 2
617 .na
618 \fB\fBu_data c_data\fR\fR
619 .ad
620 .RS 17n
621 The union of either \fBu_data c_data\fR The union of either \fBs_addrs\fR or
622 \fBs_inos\fR.
623 .RE
625 .sp
626 .ne 2
627 .na
628 \fB\fBc_label\fR\fR
629 .ad
630 .RS 17n
631 Label for this dump.
632 .RE
634 .sp
635 .ne 2
636 .na
637 \fB\fBc_level\fR\fR
638 .ad
639 .RS 17n
640 Level of this dump.
641 .RE
643 .sp
644 .ne 2
645 .na
646 \fB\fBc_filesys\fR\fR
647 .ad
648 .RS 17n
649 Name of dumped file system.
650 .RE
652 .sp
653 .ne 2
654 .na
655 \fB\fBc_dev\fR\fR
656 .ad
657 .RS 17n
658 Name of dumped service.
659 .RE
661 .sp
662 .ne 2
663 .na
664 \fB\fBc_host\fR\fR
665 .ad
666 .RS 17n
667 Name of dumped host.
668 .RE
670 .sp
671 .ne 2
672 .na
673 \fB\fBc_flags\fR\fR
674 .ad
675 .RS 17n
676 Additional information.
677 .RE
679 .sp
680 .ne 2
681 .na
682 \fB\fBc_firstrec\fR\fR
683 .ad
684 .RS 17n
685 First record on volume.
686 .RE
688 .sp
689 .ne 2
690 .na
691 \fB\fBc_spare\fR\fR
692 .ad
693 .RS 17n
694 Reserved for future uses.
695 .RE
697 .sp
698 .ne 2
699 .na
700 \fB\fBc_tpbsize\fR\fR
701 .ad
702 .RS 17n
703 Tape block size for MTB format only.
704 .RE
706 .sp
707 .LP
708 Each volume except the last ends with a tapemark (read as an end of file). The
709 last volume ends with a \fBTS_END\fR record and then the tapemark.
710 .sp
711 .LP
712 The dump history is kept in the file \fB/etc/dumpdates\fR. It is an \fBASCII\fR
713 file with three fields separated by white space:
714 .RS +4
715 .TP
716 .ie t \(bu
717 .el o
718 The name of the device on which the dumped file system resides.
719 .RE
720 .RS +4
721 .TP
722 .ie t \(bu
723 .el o
724 The level number of the dump tape; see \fBufsdump\fR(1M).
725 .RE
726 .RS +4
727 .TP
728 .ie t \(bu
729 .el o
730 The date of the incremental dump in the format generated by \fBctime\fR(3C).
731 .RE
732 .sp
733 .LP
734 \fBDUMPOUTFMT\fR is the format to use when using \fBprintf\fR(3C) to write an
735 entry to \fB/etc/dumpdates\fR; \fBDUMPINFMT\fR is the format to use when using
736 \fBscanf\fR(3C) to read an entry from \fB/etc/dumpdates\fR.
737 .SH ATTRIBUTES
738 .sp
739 .LP
740 See \fBattributes\fR(5) for a description of the following attributes:
741 .sp
743 .sp
744 .TS
745 box;
746 c | c
747 l | l .
748 ATTRIBUTE TYPE ATTRIBUTE VALUE
749 _
750 Stability Level Unstable
751 .TE
753 .SH SEE ALSO
754 .sp
755 .LP
756 \fBufsdump\fR(1M), \fBufsrestore\fR(1M), \fBctime\fR(3C), \fBprintf\fR(3C),
757 \fBscanf\fR(3C), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5),