1 /* $OpenBSD: pax.h,v 1.17 2005/11/09 19:59:06 otto Exp $ */
2 /* $NetBSD: pax.h,v 1.3 1995/03/21 09:07:41 cgd Exp $ */
5 * Copyright (c) 1992 Keith Muller.
6 * Copyright (c) 1992, 1993
7 * The Regents of the University of California. All rights reserved.
9 * This code is derived from software contributed to Berkeley by
10 * Keith Muller of the University of California, San Diego.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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
36 * @(#)pax.h 8.2 (Berkeley) 4/18/94
40 * BSD PAX global data structures and constants.
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 MAXPATHLEN */
55 * Pax modes of operation
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 */
65 * Device type of the current archive volume
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 */
74 * Pattern matching structure
76 * Used to store command line patterns
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 int 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 */
90 * General Archive Structure (used internal to pax)
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.
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 */
131 * Format Specific Routine Table
133 * The format specific routine table allows new archive formats to be quickly
134 * added. Overall pax operation is independent of the actual format used to
135 * form the archive. Only those routines which deal directly with the archive
136 * are tailored to the oddities of the specific format. All other routines are
137 * independent of the archive format. Data flow in and out of the format
138 * dependent routines pass pointers to ARCHD structure (described below).
141 char *name; /* name of format, this is the name the user */
142 /* gives to -x option to select it. */
143 int bsz; /* default block size. used when the user */
144 /* does not specify a blocksize for writing */
145 /* Appends continue to with the blocksize */
146 /* the archive is currently using. */
147 int hsz; /* Header size in bytes. this is the size of */
148 /* the smallest header this format supports. */
149 /* Headers are assumed to fit in a BLKMULT. */
150 /* If they are bigger, get_head() and */
151 /* get_arc() must be adjusted */
152 int udev; /* does append require unique dev/ino? some */
153 /* formats use the device and inode fields */
154 /* to specify hard links. when members in */
155 /* the archive have the same inode/dev they */
156 /* are assumed to be hard links. During */
157 /* append we may have to generate unique ids */
158 /* to avoid creating incorrect hard links */
159 int hlk; /* does archive store hard links info? if */
160 /* not, we do not bother to look for them */
161 /* during archive write operations */
162 int blkalgn; /* writes must be aligned to blkalgn boundary */
163 int inhead; /* is the trailer encoded in a valid header? */
164 /* if not, trailers are assumed to be found */
165 /* in invalid headers (i.e like tar) */
166 int (*id)(char *, /* checks if a buffer is a valid header */
167 int); /* returns 1 if it is, o.w. returns a 0 */
168 int (*st_rd)(void); /* initialize routine for read. so format */
169 /* can set up tables etc before it starts */
170 /* reading an archive */
171 int (*rd)(ARCHD *, /* read header routine. passed a pointer to */
172 char *); /* ARCHD. It must extract the info from the */
173 /* format and store it in the ARCHD struct. */
174 /* This routine is expected to fill all the */
175 /* fields in the ARCHD (including stat buf) */
176 /* 0 is returned when a valid header is */
177 /* found. -1 when not valid. This routine */
178 /* set the skip and pad fields so the format */
179 /* independent routines know the amount of */
180 /* padding and the number of bytes of data */
181 /* which follow the header. This info is */
182 /* used skip to the next file header */
183 off_t (*end_rd)(void); /* read cleanup. Allows format to clean up */
184 /* and MUST RETURN THE LENGTH OF THE TRAILER */
185 /* RECORD (so append knows how many bytes */
186 /* to move back to rewrite the trailer) */
187 int (*st_wr)(void); /* initialize routine for write operations */
188 int (*wr)(ARCHD *); /* write archive header. Passed an ARCHD */
189 /* filled with the specs on the next file to */
190 /* archived. Returns a 1 if no file data is */
191 /* is to be stored; 0 if file data is to be */
192 /* added. A -1 is returned if a write */
193 /* operation to the archive failed. this */
194 /* function sets the skip and pad fields so */
195 /* the proper padding can be added after */
196 /* file data. This routine must NEVER write */
197 /* a flawed archive header. */
198 int (*end_wr)(void); /* end write. write the trailer and do any */
199 /* other format specific functions needed */
200 /* at the end of an archive write */
201 int (*trail)(ARCHD *, /* returns 0 if a valid trailer, -1 if not */
202 char *, int, /* For formats which encode the trailer */
203 int *); /* outside of a valid header, a return value */
204 /* of 1 indicates that the block passed to */
205 /* it can never contain a valid header (skip */
206 /* this block, no point in looking at it) */
207 /* CAUTION: parameters to this function are */
208 /* different for trailers inside or outside */
209 /* of headers. See get_head() for details */
210 int (*rd_data)(ARCHD *, /* read/process file data from the archive */
212 int (*wr_data)(ARCHD *, /* write/process file data to the archive */
214 int (*options)(void); /* process format specific options (-o) */
218 * Format Specific Options List
220 * Used to pass format options to the format options handler
222 typedef struct oplist {
223 char *name; /* option variable name e.g. name= */
224 char *value; /* value for option variable */
225 struct oplist *fow; /* next option */
232 #define MIN(a,b) (((a)<(b))?(a):(b))
234 #define MAJOR(x) major(x)
235 #define MINOR(x) minor(x)
236 #define TODEV(x, y) makedev((x), (y))
244 #define _TFILE_BASE "paxXXXXXXXXXX"
246 /* hack since we're pulling routines in from OpenBSD library to this dir */
247 size_t strlcpy(char *, const char *, size_t);
248 char * vis(char *, int, int, int);
projects / debian / pax / blob