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