tar.h revision 330897 
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 * 4. 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 * $FreeBSD: stable/11/bin/pax/tar.h 330897 2018-03-14 03:19:51Z eadler $
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 checksum 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 * Mode field encoding of the different file types - values in octal
66 */
67#define TSUID		04000		/* Set UID on execution */
68#define TSGID		02000		/* Set GID on execution */
69#define TSVTX		01000		/* Reserved */
70#define TUREAD		00400		/* Read by owner */
71#define TUWRITE		00200		/* Write by owner */
72#define TUEXEC		00100		/* Execute/Search by owner */
73#define TGREAD		00040		/* Read by group */
74#define TGWRITE		00020		/* Write by group */
75#define TGEXEC		00010		/* Execute/Search by group */
76#define TOREAD		00004		/* Read by other */
77#define TOWRITE		00002		/* Write by other */
78#define TOEXEC		00001		/* Execute/Search by other */
79
80#ifdef _PAX_
81/*
82 * Pad with a bit mask, much faster than doing a mod but only works on powers
83 * of 2. Macro below is for block of 512 bytes.
84 */
85#define TAR_PAD(x)	((512 - ((x) & 511)) & 511)
86#endif /* _PAX_ */
87
88/*
89 * structure of an old tar header as it appeared in BSD releases
90 */
91typedef struct {
92	char name[TNMSZ];		/* name of entry */
93	char mode[8]; 			/* mode */
94	char uid[8]; 			/* uid */
95	char gid[8];			/* gid */
96	char size[12];			/* size */
97	char mtime[12];			/* modification time */
98	char chksum[CHK_LEN];		/* checksum */
99	char linkflag;			/* norm, hard, or sym. */
100	char linkname[TNMSZ];		/* linked to name */
101} HD_TAR __aligned(1);
102
103#ifdef _PAX_
104/*
105 * -o options for BSD tar to not write directories to the archive
106 */
107#define TAR_NODIR	"nodir"
108#define TAR_OPTION	"write_opt"
109
110/*
111 * default device names
112 */
113#define	DEV_0		"/dev/rmt0"
114#define	DEV_1		"/dev/rmt1"
115#define	DEV_4		"/dev/rmt4"
116#define	DEV_5		"/dev/rmt5"
117#define	DEV_7		"/dev/rmt7"
118#define	DEV_8		"/dev/rmt8"
119#endif /* _PAX_ */
120
121/*
122 * Data Interchange Format - Extended tar header format - POSIX 1003.1-1990
123 */
124#define TPFSZ		155
125#define	TMAGIC		"ustar"		/* ustar and a null */
126#define	TMAGLEN		6
127#define	TVERSION	"00"		/* 00 and no null */
128#define	TVERSLEN	2
129
130typedef struct {
131	char name[TNMSZ];		/* name of entry */
132	char mode[8]; 			/* mode */
133	char uid[8]; 			/* uid */
134	char gid[8];			/* gid */
135	char size[12];			/* size */
136	char mtime[12];			/* modification time */
137	char chksum[CHK_LEN];		/* checksum */
138	char typeflag;			/* type of file. */
139	char linkname[TNMSZ];		/* linked to name */
140	char magic[TMAGLEN];		/* magic cookie */
141	char version[TVERSLEN];		/* version */
142	char uname[32];			/* ascii owner name */
143	char gname[32];			/* ascii group name */
144	char devmajor[8];		/* major device number */
145	char devminor[8];		/* minor device number */
146	char prefix[TPFSZ];		/* linked to name */
147} HD_USTAR __aligned(1);
148