xref: /freebsd/bin/pax/cpio.h (revision 952d112864d8008aa87278a30a539d888a8493cd)
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  *	@(#)cpio.h	8.1 (Berkeley) 5/31/93
38  *	$Id$
39  */
40 
41 /*
42  * Defines common to all versions of cpio
43  */
44 #define TRAILER		"TRAILER!!!"	/* name in last archive record */
45 
46 /*
47  * Header encoding of the different file types
48  */
49 #define	C_ISDIR		 040000		/* Directory */
50 #define	C_ISFIFO	 010000		/* FIFO */
51 #define	C_ISREG		0100000		/* Regular file */
52 #define	C_ISBLK		 060000		/* Block special file */
53 #define	C_ISCHR		 020000		/* Character special file */
54 #define	C_ISCTG		0110000		/* Reserved for contiguous files */
55 #define	C_ISLNK		0120000		/* Reserved for symbolic links */
56 #define	C_ISOCK		0140000		/* Reserved for sockets */
57 #define C_IFMT		0170000		/* type of file */
58 
59 /*
60  * Data Interchange Format - Extended cpio header format - POSIX 1003.1-1990
61  */
62 typedef struct {
63 	char	c_magic[6];		/* magic cookie */
64 	char	c_dev[6];		/* device number */
65 	char	c_ino[6];		/* inode number */
66 	char	c_mode[6];		/* file type/access */
67 	char	c_uid[6];		/* owners uid */
68 	char	c_gid[6];		/* owners gid */
69 	char	c_nlink[6];		/* # of links at archive creation */
70 	char	c_rdev[6];		/* block/char major/minor # */
71 	char	c_mtime[11];		/* modification time */
72 	char	c_namesize[6];		/* length of pathname */
73 	char	c_filesize[11];		/* length of file in bytes */
74 } HD_CPIO;
75 
76 #define	MAGIC		070707		/* transportable archive id */
77 
78 #ifdef _PAX_
79 #define	AMAGIC		"070707"	/* ascii equivalent string of MAGIC */
80 #define CPIO_MASK	0x3ffff		/* bits valid in the dev/ino fields */
81 					/* used for dev/inode remaps */
82 #endif /* _PAX_ */
83 
84 /*
85  * Binary cpio header structure
86  *
87  * CAUTION! CAUTION! CAUTION!
88  * Each field really represents a 16 bit short (NOT ASCII). Described as
89  * an array of chars in an attempt to improve portability!!
90  */
91 typedef struct {
92 	u_char	h_magic[2];
93 	u_char	h_dev[2];
94 	u_char	h_ino[2];
95 	u_char	h_mode[2];
96 	u_char	h_uid[2];
97 	u_char	h_gid[2];
98 	u_char	h_nlink[2];
99 	u_char	h_rdev[2];
100 	u_char	h_mtime_1[2];
101 	u_char	h_mtime_2[2];
102 	u_char	h_namesize[2];
103 	u_char	h_filesize_1[2];
104 	u_char	h_filesize_2[2];
105 } HD_BCPIO;
106 
107 #ifdef _PAX_
108 /*
109  * extraction and creation macros for binary cpio
110  */
111 #define SHRT_EXT(ch)	((((unsigned)(ch)[0])<<8) | (((unsigned)(ch)[1])&0xff))
112 #define RSHRT_EXT(ch)	((((unsigned)(ch)[1])<<8) | (((unsigned)(ch)[0])&0xff))
113 #define CHR_WR_0(val)	((char)(((val) >> 24) & 0xff))
114 #define CHR_WR_1(val)	((char)(((val) >> 16) & 0xff))
115 #define CHR_WR_2(val)	((char)(((val) >> 8) & 0xff))
116 #define CHR_WR_3(val)	((char)((val) & 0xff))
117 
118 /*
119  * binary cpio masks and pads
120  */
121 #define BCPIO_PAD(x)	((2 - ((x) & 1)) & 1)	/* pad to next 2 byte word */
122 #define BCPIO_MASK	0xffff			/* mask for dev/ino fields */
123 #endif /* _PAX_ */
124 
125 /*
126  * System VR4 cpio header structure (with/without file data crc)
127  */
128 typedef struct {
129 	char	c_magic[6];		/* magic cookie */
130 	char	c_ino[8];		/* inode number */
131 	char	c_mode[8];		/* file type/access */
132 	char	c_uid[8];		/* owners uid */
133 	char	c_gid[8];		/* owners gid */
134 	char	c_nlink[8];		/* # of links at archive creation */
135 	char	c_mtime[8];		/* modification time */
136 	char	c_filesize[8];		/* length of file in bytes */
137 	char	c_maj[8];		/* block/char major # */
138 	char	c_min[8];		/* block/char minor # */
139 	char	c_rmaj[8];		/* special file major # */
140 	char	c_rmin[8];		/* special file minor # */
141 	char	c_namesize[8];		/* length of pathname */
142 	char	c_chksum[8];		/* 0 OR CRC of bytes of FILE data */
143 } HD_VCPIO;
144 
145 #define	VMAGIC		070701		/* sVr4 new portable archive id */
146 #define	VCMAGIC		070702		/* sVr4 new portable archive id CRC */
147 #ifdef _PAX_
148 #define	AVMAGIC		"070701"	/* ascii string of above */
149 #define	AVCMAGIC	"070702"	/* ascii string of above */
150 #define VCPIO_PAD(x)	((4 - ((x) & 3)) & 3)	/* pad to next 4 byte word */
151 #define VCPIO_MASK	0xffffffff	/* mask for dev/ino fields */
152 #endif /* _PAX_ */
153