Consolidate license copies
[its.git] / sysdoc / dump.format
1 -*- Text -*-                    This is the file AI:SYSDOC;DUMP FORMAT
2 Copyright (c) 1999 Massachusetts Institute of Technology
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 3 of the License, or (at
7 your option) any later version.
8
9 This program is distributed in the hope that it will be useful, but
10 WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 ------------------------------
18
19
20 This file attempts to document the format of DUMP tapes.
21 It probably contains inaccuracies.
22
23 Each tape record contains 1,024 36-bit words in "core dump" format;
24 thus on 7-track tape each 36-bit word takes 6 tape frames.  Data
25 formats are standard pdp-10 data formats such as sixbit (6 characters
26 per word), 7-bit ascii (5 characters per word, left-justified),
27 halfwords, and so forth.
28
29 Each file dumped to tape consists of a header, then the 36-bit data of
30 the file, and ends with an end-of-file mark.  The last record in a file
31 will generally be shorter than 1,024 words, depending on the length
32 of the file.  There is no padding, other than the usual control-C's
33 padding a text file out to a word boundary.  The tape ends with a
34 double end-of-file mark.
35
36 The first file on the tape is preceded by a tape header in front
37 of the file header, with no end-of-file mark in between.
38
39 Each type of header starts with a 36-bit word whose left half is minus
40 the number of words in the header, including this word.  The right
41 half of this word is zero.
42
43 Tape header:
44         -LTHBLK,,0
45         tape number,,reel number
46         tape creation date in sixbit
47         type of tape (0 random, >0 full dump, <0 incremental dump)
48
49 File header:
50         -LHBLK,,0
51         directory name in sixbit
52         first file name in sixbit
53         second file name in sixbit
54         disk pack number where file was
55         creation date of file (same format as in ITS directory)
56
57 If the file is really a link, then the left half of the
58 pack number is non-zero and the data of the file consists of
59 three words, containing the sixbit file name the link points to.
60
61 In addition to files, directories also appear on some dump tapes.  The
62 master file directory has name M.F.D. (FILE) and a user file directory
63 has name .FILE. (DIR).  The data for the master directory is an exact
64 binary copy of the directory as stored on disk.  The data for a user
65 directory is almost an exact binary copy except that unused space
66 between the descriptor area and the name area is squished out.