[apple/file_cmds.git] / pax / tar.h

/*	$OpenBSD: tar.h,v 1.5 1997/04/16 03:50:25 millert Exp $	*/
/*	$NetBSD: tar.h,v 1.3 1995/03/21 09:07:51 cgd Exp $	*/

/*-
 * Copyright (c) 1992 Keith Muller.
 * Copyright (c) 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Keith Muller of the University of California, San Diego.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)tar.h	8.2 (Berkeley) 4/18/94
 */

/*
 * defines and data structures common to all tar formats
 */
#define CHK_LEN		8		/* length of checksum field */
#define TNMSZ		100		/* size of name field */
#ifdef _PAX_
#define NULLCNT		2		/* number of null blocks in trailer */
#define CHK_OFFSET	148		/* start of chksum field */
#define BLNKSUM		256L		/* sum of checksum field using ' ' */
#endif /* _PAX_ */

/*
 * Values used in typeflag field in all tar formats
 * (only REGTYPE, LNKTYPE and SYMTYPE are used in old bsd tar headers)
 */
#define	REGTYPE		'0'		/* Regular File */
#define	AREGTYPE	'\0'		/* Regular File */
#define	LNKTYPE		'1'		/* Link */
#define	SYMTYPE		'2'		/* Symlink */
#define	CHRTYPE		'3'		/* Character Special File */
#define	BLKTYPE		'4'		/* Block Special File */
#define	DIRTYPE		'5'		/* Directory */
#define	FIFOTYPE	'6'		/* FIFO */
#define	CONTTYPE	'7'		/* high perf file */

/*
 * Mode field encoding of the different file types - values in octal
 */
#define TSUID		04000		/* Set UID on execution */
#define TSGID		02000		/* Set GID on execution */
#define TSVTX		01000		/* Reserved */
#define TUREAD		00400		/* Read by owner */
#define TUWRITE		00200		/* Write by owner */
#define TUEXEC		00100		/* Execute/Search by owner */
#define TGREAD		00040		/* Read by group */
#define TGWRITE		00020		/* Write by group */
#define TGEXEC		00010		/* Execute/Search by group */
#define TOREAD		00004		/* Read by other */
#define TOWRITE		00002		/* Write by other */
#define TOEXEC		00001		/* Execute/Search by other */

#ifdef _PAX_
/*
 * Pad with a bit mask, much faster than doing a mod but only works on powers
 * of 2. Macro below is for block of 512 bytes.
 */
#define TAR_PAD(x)	((512 - ((x) & 511)) & 511)
#endif /* _PAX_ */

/*
 * structure of an old tar header as it appeared in BSD releases
 */
typedef struct {
	char name[TNMSZ];		/* name of entry */
	char mode[8]; 			/* mode */
	char uid[8]; 			/* uid */
	char gid[8];			/* gid */
	char size[12];			/* size */
	char mtime[12];			/* modification time */
	char chksum[CHK_LEN];		/* checksum */
	char linkflag;			/* norm, hard, or sym. */
	char linkname[TNMSZ];		/* linked to name */
} HD_TAR;

#ifdef _PAX_
/*
 * -o options for BSD tar to not write directories to the archive
 */
#define TAR_NODIR	"nodir"
#define TAR_OPTION	"write_opt"

/*
 * default device names
 */
#define	DEV_0		"/dev/rst0"
#define	DEV_1		"/dev/rst1"
#define	DEV_4		"/dev/rst4"
#define	DEV_5		"/dev/rst5"
#define	DEV_7		"/dev/rst7"
#define	DEV_8		"/dev/rst8"
#endif /* _PAX_ */

/*
 * Data Interchange Format - Extended tar header format - POSIX 1003.1-1990
 */
#define TPFSZ		155
#define	TMAGIC		"ustar"		/* ustar and a null */
#define	TMAGLEN		6
#define	TVERSION	"00"		/* 00 and no null */
#define	TVERSLEN	2

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