xref: /dragonfly/bin/pax/pax.h (revision 030b3383)
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. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)pax.h	8.2 (Berkeley) 4/18/94
34  * $FreeBSD: src/bin/pax/pax.h,v 1.8.2.1 2001/08/01 05:03:11 obrien Exp $
35  * $DragonFly: src/bin/pax/pax.h,v 1.3 2006/09/27 21:58:08 pavalos Exp $
36  */
37 
38 /*
39  * BSD PAX global data structures and constants.
40  */
41 
42 #define	MAXBLK		64512	/* MAX blocksize supported (posix SPEC) */
43 				/* WARNING: increasing MAXBLK past 32256 */
44 				/* will violate posix spec. */
45 #define	MAXBLK_POSIX	32256	/* MAX blocksize supported as per POSIX */
46 #define BLKMULT		512	/* blocksize must be even mult of 512 bytes */
47 				/* Don't even think of changing this */
48 #define DEVBLK		8192	/* default read blksize for devices */
49 #define FILEBLK		10240	/* default read blksize for files */
50 #define PAXPATHLEN	3072	/* maximum path length for pax. MUST be */
51 				/* longer than the system PATH_MAX */
52 
53 /*
54  * Pax modes of operation
55  */
56 #define	LIST		0	/* List the file in an archive */
57 #define	EXTRACT		1	/* extract the files in an archive */
58 #define ARCHIVE		2	/* write a new archive */
59 #define APPND		3	/* append to the end of an archive */
60 #define	COPY		4	/* copy files to destination dir */
61 #define DEFOP		LIST	/* if no flags default is to LIST */
62 
63 /*
64  * Device type of the current archive volume
65  */
66 #define ISREG		0	/* regular file */
67 #define ISCHR		1	/* character device */
68 #define ISBLK		2	/* block device */
69 #define ISTAPE		3	/* tape drive */
70 #define ISPIPE		4	/* pipe/socket */
71 
72 /*
73  * Format Specific Routine Table
74  *
75  * The format specific routine table allows new archive formats to be quickly
76  * added. Overall pax operation is independent of the actual format used to
77  * form the archive. Only those routines which deal directly with the archive
78  * are tailored to the oddities of the specific format. All other routines are
79  * independent of the archive format. Data flow in and out of the format
80  * dependent routines pass pointers to ARCHD structure (described below).
81  */
82 typedef struct {
83 	char *name;		/* name of format, this is the name the user */
84 				/* gives to -x option to select it. */
85 	int bsz;		/* default block size. used when the user */
86 				/* does not specify a blocksize for writing */
87 				/* Appends continue to with the blocksize */
88 				/* the archive is currently using. */
89 	int hsz;		/* Header size in bytes. this is the size of */
90 				/* the smallest header this format supports. */
91 				/* Headers are assumed to fit in a BLKMULT. */
92 				/* If they are bigger, get_head() and */
93 				/* get_arc() must be adjusted */
94 	int udev;		/* does append require unique dev/ino? some */
95 				/* formats use the device and inode fields */
96 				/* to specify hard links. when members in */
97 				/* the archive have the same inode/dev they */
98 				/* are assumed to be hard links. During */
99 				/* append we may have to generate unique ids */
100 				/* to avoid creating incorrect hard links */
101 	int hlk;		/* does archive store hard links info? if */
102 				/* not, we do not bother to look for them */
103 				/* during archive write operations */
104 	int blkalgn;		/* writes must be aligned to blkalgn boundary */
105 	int inhead;		/* is the trailer encoded in a valid header? */
106 				/* if not, trailers are assumed to be found */
107 				/* in invalid headers (i.e like tar) */
108 	int (*id)();		/* checks if a buffer is a valid header */
109 				/* returns 1 if it is, o.w. returns a 0 */
110 	int (*st_rd)();		/* initialize routine for read. so format */
111 				/* can set up tables etc before it starts */
112 				/* reading an archive */
113 	int (*rd)();		/* read header routine. passed a pointer to */
114 				/* ARCHD. It must extract the info from the */
115 				/* format and store it in the ARCHD struct. */
116 				/* This routine is expected to fill all the */
117 				/* fields in the ARCHD (including stat buf) */
118 				/* 0 is returned when a valid header is */
119 				/* found. -1 when not valid. This routine */
120 				/* set the skip and pad fields so the format */
121 				/* independent routines know the amount of */
122 				/* padding and the number of bytes of data */
123 				/* which follow the header. This info is */
124 				/* used skip to the next file header */
125 	off_t (*end_rd)();	/* read cleanup. Allows format to clean up */
126 				/* and MUST RETURN THE LENGTH OF THE TRAILER */
127 				/* RECORD (so append knows how many bytes */
128 				/* to move back to rewrite the trailer) */
129 	int (*st_wr)();		/* initialize routine for write operations */
130 	int (*wr)();		/* write archive header. Passed an ARCHD */
131 				/* filled with the specs on the next file to */
132 				/* archived. Returns a 1 if no file data is */
133 				/* is to be stored; 0 if file data is to be */
134 				/* added. A -1 is returned if a write */
135 				/* operation to the archive failed. this */
136 				/* function sets the skip and pad fields so */
137 				/* the proper padding can be added after */
138 				/* file data. This routine must NEVER write */
139 				/* a flawed archive header. */
140 	int (*end_wr)();	/* end write. write the trailer and do any */
141 				/* other format specific functions needed */
142 				/* at the end of an archive write */
143 	int (*trail)();		/* returns 0 if a valid trailer, -1 if not */
144 				/* For formats which encode the trailer */
145 				/* outside of a valid header, a return value */
146 				/* of 1 indicates that the block passed to */
147 				/* it can never contain a valid header (skip */
148 				/* this block, no point in looking at it)  */
149 				/* CAUTION: parameters to this function are */
150 				/* different for trailers inside or outside */
151 				/* of headers. See get_head() for details */
152 	int (*rd_data)();	/* read/process file data from the archive */
153 	int (*wr_data)();	/* write/process file data to the archive */
154 	int (*options)();	/* process format specific options (-o) */
155 } FSUB;
156 
157 /*
158  * Pattern matching structure
159  *
160  * Used to store command line patterns
161  */
162 typedef struct pattern {
163 	char		*pstr;		/* pattern to match, user supplied */
164 	char		*pend;		/* end of a prefix match */
165 	char		*chdname;	/* the dir to change to if not NULL.  */
166 	int		plen;		/* length of pstr */
167 	int		flgs;		/* processing/state flags */
168 #define MTCH		0x1		/* pattern has been matched */
169 #define DIR_MTCH	0x2		/* pattern matched a directory */
170 	struct pattern	*fow;		/* next pattern */
171 } PATTERN;
172 
173 /*
174  * General Archive Structure (used internal to pax)
175  *
176  * This structure is used to pass information about archive members between
177  * the format independent routines and the format specific routines. When
178  * new archive formats are added, they must accept requests and supply info
179  * encoded in a structure of this type. The name fields are declared statically
180  * here, as there is only ONE of these floating around, size is not a major
181  * consideration. Eventually converting the name fields to a dynamic length
182  * may be required if and when the supporting operating system removes all
183  * restrictions on the length of pathnames it will resolve.
184  */
185 typedef struct {
186 	int nlen;			/* file name length */
187 	char name[PAXPATHLEN+1];	/* file name */
188 	int ln_nlen;			/* link name length */
189 	char ln_name[PAXPATHLEN+1];	/* name to link to (if any) */
190 	char *org_name;			/* orig name in file system */
191 	PATTERN *pat;			/* ptr to pattern match (if any) */
192 	struct stat sb;			/* stat buffer see stat(2) */
193 	off_t pad;			/* bytes of padding after file xfer */
194 	off_t skip;			/* bytes of real data after header */
195 					/* IMPORTANT. The st_size field does */
196 					/* not always indicate the amount of */
197 					/* data following the header. */
198 	u_long crc;			/* file crc */
199 	int type;			/* type of file node */
200 #define PAX_DIR		1		/* directory */
201 #define PAX_CHR		2		/* character device */
202 #define PAX_BLK		3		/* block device */
203 #define PAX_REG		4		/* regular file */
204 #define PAX_SLK		5		/* symbolic link */
205 #define PAX_SCK		6		/* socket */
206 #define PAX_FIF		7		/* fifo */
207 #define PAX_HLK		8		/* hard link */
208 #define PAX_HRG		9		/* hard link to a regular file */
209 #define PAX_CTG		10		/* high performance file */
210 } ARCHD;
211 
212 /*
213  * Format Specific Options List
214  *
215  * Used to pass format options to the format options handler
216  */
217 typedef struct oplist {
218 	char		*name;		/* option variable name e.g. name= */
219 	char		*value;		/* value for option variable */
220 	struct oplist	*fow;		/* next option */
221 } OPLIST;
222 
223 /*
224  * General Macros
225  */
226 #ifndef MIN
227 #define	       MIN(a,b) (((a)<(b))?(a):(b))
228 #endif
229 #define MAJOR(x)	major(x)
230 #define MINOR(x)	minor(x)
231 #define TODEV(x, y)	makedev((x), (y))
232 
233 /*
234  * General Defines
235  */
236 #define HEX		16
237 #define OCT		8
238 #define _PAX_		1
239 #define _TFILE_BASE	"paxXXXXXXXXXX"
240