tar.h revision 1557 
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 */
39
40/*
41 * defines and data structures common to all tar formats
42 */
43#define CHK_LEN		8		/* length of checksum field */
44#define TNMSZ		100		/* size of name field */
45#ifdef _PAX_
46#define NULLCNT		2		/* number of null blocks in trailer */
47#define CHK_OFFSET	148		/* start of chksum field */
48#define BLNKSUM		256L		/* sum of checksum field using ' ' */
49#endif /* _PAX_ */
50
51/*
52 * Values used in typeflag field in all tar formats
53 * (only REGTYPE, LNKTYPE and SYMTYPE are used in old bsd tar headers)
54 */
55#define	REGTYPE		'0'		/* Regular File */
56#define	AREGTYPE	'\0'		/* Regular File */
57#define	LNKTYPE		'1'		/* Link */
58#define	SYMTYPE		'2'		/* Symlink */
59#define	CHRTYPE		'3'		/* Character Special File */
60#define	BLKTYPE		'4'		/* Block Special File */
61#define	DIRTYPE		'5'		/* Directory */
62#define	FIFOTYPE	'6'		/* FIFO */
63#define	CONTTYPE	'7'		/* high perf file */
64
65/*
66 * Mode field encoding of the different file types - values in octal
67 */
68#define TSUID		04000		/* Set UID on execution */
69#define TSGID		02000		/* Set GID on execution */
70#define TSVTX		01000		/* Reserved */
71#define TUREAD		00400		/* Read by owner */
72#define TUWRITE		00200		/* Write by owner */
73#define TUEXEC		00100		/* Execute/Search by owner */
74#define TGREAD		00040		/* Read by group */
75#define TGWRITE		00020		/* Write by group */
76#define TGEXEC		00010		/* Execute/Search by group */
77#define TOREAD		00004		/* Read by other */
78#define TOWRITE		00002		/* Write by other */
79#define TOEXEC		00001		/* Execute/Search by other */
80
81#ifdef _PAX_
82/*
83 * Pad with a bit mask, much faster than doing a mod but only works on powers
84 * of 2. Macro below is for block of 512 bytes.
85 */
86#define TAR_PAD(x)	((512 - ((x) & 511)) & 511)
87#endif /* _PAX_ */
88
89/*
90 * structure of an old tar header as it appeared in BSD releases
91 */
92typedef struct {
93	char name[TNMSZ];		/* name of entry */
94	char mode[8]; 			/* mode */
95	char uid[8]; 			/* uid */
96	char gid[8];			/* gid */
97	char size[12];			/* size */
98	char mtime[12];			/* modification time */
99	char chksum[CHK_LEN];		/* checksum */
100	char linkflag;			/* norm, hard, or sym. */
101	char linkname[TNMSZ];		/* linked to name */
102} HD_TAR;
103
104#ifdef _PAX_
105/*
106 * -o options for BSD tar to not write directories to the archive
107 */
108#define TAR_NODIR	"nodir"
109#define TAR_OPTION	"write_opt"
110
111/*
112 * default device names
113 */
114#define	DEV_0		"/dev/rmt0"
115#define	DEV_1		"/dev/rmt1"
116#define	DEV_4		"/dev/rmt4"
117#define	DEV_5		"/dev/rmt5"
118#define	DEV_7		"/dev/rmt7"
119#define	DEV_8		"/dev/rmt8"
120#endif /* _PAX_ */
121
122/*
123 * Data Interchange Format - Extended tar header format - POSIX 1003.1-1990
124 */
125#define TPFSZ		155
126#define	TMAGIC		"ustar"		/* ustar and a null */
127#define	TMAGLEN		6
128#define	TVERSION	"00"		/* 00 and no null */
129#define	TVERSLEN	2
130
131typedef struct {
132	char name[TNMSZ];		/* name of entry */
133	char mode[8]; 			/* mode */
134	char uid[8]; 			/* uid */
135	char gid[8];			/* gid */
136	char size[12];			/* size */
137	char mtime[12];			/* modification time */
138	char chksum[CHK_LEN];		/* checksum */
139	char typeflag;			/* type of file. */
140	char linkname[TNMSZ];		/* linked to name */
141	char magic[TMAGLEN];		/* magic cookie */
142	char version[TVERSLEN];		/* version */
143	char uname[32];			/* ascii owner name */
144	char gname[32];			/* ascii group name */
145	char devmajor[8];		/* major device number */
146	char devminor[8];		/* minor device number */
147	char prefix[TPFSZ];		/* linked to name */
148} HD_USTAR;
149