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