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