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