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