xref: /freebsd/bin/pax/tar.h (revision 3bdf775801b218aa5a89564839405b122f4b233e)
1 /*-
2  * Copyright (c) 1992 Keith Muller.
3  * Copyright (c) 1992, 1993
4  *	The Regents of the University of California.  All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * Keith Muller of the University of California, San Diego.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)tar.h	8.2 (Berkeley) 4/18/94
34  * $FreeBSD$
35  */
36 
37 /*
38  * defines and data structures common to all tar formats
39  */
40 #define CHK_LEN		8		/* length of checksum field */
41 #define TNMSZ		100		/* size of name field */
42 #ifdef _PAX_
43 #define NULLCNT		2		/* number of null blocks in trailer */
44 #define CHK_OFFSET	148		/* start of checksum field */
45 #define BLNKSUM		256L		/* sum of checksum field using ' ' */
46 #endif /* _PAX_ */
47 
48 /*
49  * Values used in typeflag field in all tar formats
50  * (only REGTYPE, LNKTYPE and SYMTYPE are used in old BSD tar headers)
51  */
52 #define	REGTYPE		'0'		/* Regular File */
53 #define	AREGTYPE	'\0'		/* Regular File */
54 #define	LNKTYPE		'1'		/* Link */
55 #define	SYMTYPE		'2'		/* Symlink */
56 #define	CHRTYPE		'3'		/* Character Special File */
57 #define	BLKTYPE		'4'		/* Block Special File */
58 #define	DIRTYPE		'5'		/* Directory */
59 #define	FIFOTYPE	'6'		/* FIFO */
60 #define	CONTTYPE	'7'		/* high perf file */
61 
62 /*
63  * Mode field encoding of the different file types - values in octal
64  */
65 #define TSUID		04000		/* Set UID on execution */
66 #define TSGID		02000		/* Set GID on execution */
67 #define TSVTX		01000		/* Reserved */
68 #define TUREAD		00400		/* Read by owner */
69 #define TUWRITE		00200		/* Write by owner */
70 #define TUEXEC		00100		/* Execute/Search by owner */
71 #define TGREAD		00040		/* Read by group */
72 #define TGWRITE		00020		/* Write by group */
73 #define TGEXEC		00010		/* Execute/Search by group */
74 #define TOREAD		00004		/* Read by other */
75 #define TOWRITE		00002		/* Write by other */
76 #define TOEXEC		00001		/* Execute/Search by other */
77 
78 #ifdef _PAX_
79 /*
80  * Pad with a bit mask, much faster than doing a mod but only works on powers
81  * of 2. Macro below is for block of 512 bytes.
82  */
83 #define TAR_PAD(x)	((512 - ((x) & 511)) & 511)
84 #endif /* _PAX_ */
85 
86 /*
87  * structure of an old tar header as it appeared in BSD releases
88  */
89 typedef struct {
90 	char name[TNMSZ];		/* name of entry */
91 	char mode[8]; 			/* mode */
92 	char uid[8]; 			/* uid */
93 	char gid[8];			/* gid */
94 	char size[12];			/* size */
95 	char mtime[12];			/* modification time */
96 	char chksum[CHK_LEN];		/* checksum */
97 	char linkflag;			/* norm, hard, or sym. */
98 	char linkname[TNMSZ];		/* linked to name */
99 } HD_TAR __aligned(1);
100 
101 #ifdef _PAX_
102 /*
103  * -o options for BSD tar to not write directories to the archive
104  */
105 #define TAR_NODIR	"nodir"
106 #define TAR_OPTION	"write_opt"
107 
108 /*
109  * default device names
110  */
111 #define	DEV_0		"/dev/rmt0"
112 #define	DEV_1		"/dev/rmt1"
113 #define	DEV_4		"/dev/rmt4"
114 #define	DEV_5		"/dev/rmt5"
115 #define	DEV_7		"/dev/rmt7"
116 #define	DEV_8		"/dev/rmt8"
117 #endif /* _PAX_ */
118 
119 /*
120  * Data Interchange Format - Extended tar header format - POSIX 1003.1-1990
121  */
122 #define TPFSZ		155
123 #define	TMAGIC		"ustar"		/* ustar and a null */
124 #define	TMAGLEN		6
125 #define	TVERSION	"00"		/* 00 and no null */
126 #define	TVERSLEN	2
127 
128 typedef struct {
129 	char name[TNMSZ];		/* name of entry */
130 	char mode[8]; 			/* mode */
131 	char uid[8]; 			/* uid */
132 	char gid[8];			/* gid */
133 	char size[12];			/* size */
134 	char mtime[12];			/* modification time */
135 	char chksum[CHK_LEN];		/* checksum */
136 	char typeflag;			/* type of file. */
137 	char linkname[TNMSZ];		/* linked to name */
138 	char magic[TMAGLEN];		/* magic cookie */
139 	char version[TVERSLEN];		/* version */
140 	char uname[32];			/* ascii owner name */
141 	char gname[32];			/* ascii group name */
142 	char devmajor[8];		/* major device number */
143 	char devminor[8];		/* minor device number */
144 	char prefix[TPFSZ];		/* linked to name */
145 } HD_USTAR __aligned(1);
146