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