cpio.h revision 1.5
1/*	$NetBSD: cpio.h,v 1.5 2003/08/07 09:05:20 agc Exp $	*/
2
3/*-
4 * Copyright (c) 1992, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Keith Muller of the University of California, San Diego.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 *	@(#)cpio.h	8.1 (Berkeley) 5/31/93
35 */
36
37/*-
38 * Copyright (c) 1992 Keith Muller.
39 *
40 * This code is derived from software contributed to Berkeley by
41 * Keith Muller of the University of California, San Diego.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 *    notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 *    notice, this list of conditions and the following disclaimer in the
50 *    documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 *    must display the following acknowledgement:
53 *	This product includes software developed by the University of
54 *	California, Berkeley and its contributors.
55 * 4. Neither the name of the University nor the names of its contributors
56 *    may be used to endorse or promote products derived from this software
57 *    without specific prior written permission.
58 *
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * SUCH DAMAGE.
70 *
71 *	@(#)cpio.h	8.1 (Berkeley) 5/31/93
72 */
73
74/*
75 * Defines common to all versions of cpio
76 */
77#define TRAILER		"TRAILER!!!"	/* name in last archive record */
78
79/*
80 * Header encoding of the different file types
81 */
82#define	C_ISDIR		 040000		/* Directory */
83#define	C_ISFIFO	 010000		/* FIFO */
84#define	C_ISREG		0100000		/* Regular file */
85#define	C_ISBLK		 060000		/* Block special file */
86#define	C_ISCHR		 020000		/* Character special file */
87#define	C_ISCTG		0110000		/* Reserved for contiguous files */
88#define	C_ISLNK		0120000		/* Reserved for symbolic links */
89#define	C_ISOCK		0140000		/* Reserved for sockets */
90#define C_IFMT		0170000		/* type of file */
91
92/*
93 * Data Interchange Format - Extended cpio header format - POSIX 1003.1-1990
94 */
95typedef struct {
96	char	c_magic[6];		/* magic cookie */
97	char	c_dev[6];		/* device number */
98	char	c_ino[6];		/* inode number */
99	char	c_mode[6];		/* file type/access */
100	char	c_uid[6];		/* owners uid */
101	char	c_gid[6];		/* owners gid */
102	char	c_nlink[6];		/* # of links at archive creation */
103	char	c_rdev[6];		/* block/char major/minor # */
104	char	c_mtime[11];		/* modification time */
105	char	c_namesize[6];		/* length of pathname */
106	char	c_filesize[11];		/* length of file in bytes */
107} HD_CPIO;
108
109#define	MAGIC		070707		/* transportable archive id */
110
111#ifdef _PAX_
112#define	AMAGIC		"070707"	/* ascii equivalent string of MAGIC */
113#define CPIO_MASK	0x3ffff		/* bits valid in the dev/ino fields */
114					/* used for dev/inode remaps */
115#endif /* _PAX_ */
116
117/*
118 * Binary cpio header structure
119 *
120 * CAUTION! CAUTION! CAUTION!
121 * Each field really represents a 16 bit short (NOT ASCII). Described as
122 * an array of chars in an attempt to improve portability!!
123 */
124typedef struct {
125	u_char	h_magic[2];
126	u_char	h_dev[2];
127	u_char	h_ino[2];
128	u_char	h_mode[2];
129	u_char	h_uid[2];
130	u_char	h_gid[2];
131	u_char	h_nlink[2];
132	u_char	h_rdev[2];
133	u_char	h_mtime_1[2];
134	u_char	h_mtime_2[2];
135	u_char	h_namesize[2];
136	u_char	h_filesize_1[2];
137	u_char	h_filesize_2[2];
138} HD_BCPIO;
139
140#ifdef _PAX_
141/*
142 * extraction and creation macros for binary cpio
143 */
144#define SHRT_EXT(ch)	((((unsigned)(ch)[0])<<8) | (((unsigned)(ch)[1])&0xff))
145#define RSHRT_EXT(ch)	((((unsigned)(ch)[1])<<8) | (((unsigned)(ch)[0])&0xff))
146#define CHR_WR_0(val)	((char)(((val) >> 24) & 0xff))
147#define CHR_WR_1(val)	((char)(((val) >> 16) & 0xff))
148#define CHR_WR_2(val)	((char)(((val) >> 8) & 0xff))
149#define CHR_WR_3(val)	((char)((val) & 0xff))
150
151/*
152 * binary cpio masks and pads
153 */
154#define BCPIO_PAD(x)	((2 - ((x) & 1)) & 1)	/* pad to next 2 byte word */
155#define BCPIO_MASK	0xffff			/* mask for dev/ino fields */
156#endif /* _PAX_ */
157
158/*
159 * System VR4 cpio header structure (with/without file data crc)
160 */
161typedef struct {
162	char	c_magic[6];		/* magic cookie */
163	char	c_ino[8];		/* inode number */
164	char	c_mode[8];		/* file type/access */
165	char	c_uid[8];		/* owners uid */
166	char	c_gid[8];		/* owners gid */
167	char	c_nlink[8];		/* # of links at archive creation */
168	char	c_mtime[8];		/* modification time */
169	char	c_filesize[8];		/* length of file in bytes */
170	char	c_maj[8];		/* block/char major # */
171	char	c_min[8];		/* block/char minor # */
172	char	c_rmaj[8];		/* special file major # */
173	char	c_rmin[8];		/* special file minor # */
174	char	c_namesize[8];		/* length of pathname */
175	char	c_chksum[8];		/* 0 OR CRC of bytes of FILE data */
176} HD_VCPIO;
177
178#define	VMAGIC		070701		/* sVr4 new portable archive id */
179#define	VCMAGIC		070702		/* sVr4 new portable archive id CRC */
180#ifdef _PAX_
181#define	AVMAGIC		"070701"	/* ascii string of above */
182#define	AVCMAGIC	"070702"	/* ascii string of above */
183#define VCPIO_PAD(x)	((4 - ((x) & 3)) & 3)	/* pad to next 4 byte word */
184#define VCPIO_MASK	0xffffffff	/* mask for dev/ino fields */
185#endif /* _PAX_ */
186