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 * 4. 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$ 35 */ 36 37 /* 38 * BSD PAX global data structures and constants. 39 */ 40 41 #define MAXBLK 64512 /* MAX blocksize supported (posix SPEC) */ 42 /* WARNING: increasing MAXBLK past 32256 */ 43 /* will violate posix spec. */ 44 #define MAXBLK_POSIX 32256 /* MAX blocksize supported as per POSIX */ 45 #define BLKMULT 512 /* blocksize must be even mult of 512 bytes */ 46 /* Don't even think of changing this */ 47 #define DEVBLK 8192 /* default read blksize for devices */ 48 #define FILEBLK 10240 /* default read blksize for files */ 49 #define PAXPATHLEN 3072 /* maximum path length for pax. MUST be */ 50 /* longer than the system PATH_MAX */ 51 52 /* 53 * Pax modes of operation 54 */ 55 #define LIST 0 /* List the file in an archive */ 56 #define EXTRACT 1 /* extract the files in an archive */ 57 #define ARCHIVE 2 /* write a new archive */ 58 #define APPND 3 /* append to the end of an archive */ 59 #define COPY 4 /* copy files to destination dir */ 60 #define DEFOP LIST /* if no flags default is to LIST */ 61 62 /* 63 * Device type of the current archive volume 64 */ 65 #define ISREG 0 /* regular file */ 66 #define ISCHR 1 /* character device */ 67 #define ISBLK 2 /* block device */ 68 #define ISTAPE 3 /* tape drive */ 69 #define ISPIPE 4 /* pipe/socket */ 70 71 typedef struct archd ARCHD; 72 typedef struct fsub FSUB; 73 typedef struct oplist OPLIST; 74 typedef struct pattern PATTERN; 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 struct fsub { 87 const 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)(char *, int); /* checks if a buffer is a valid header */ 113 /* returns 1 if it is, o.w. returns a 0 */ 114 int (*st_rd)(void); /* initialize routine for read. so format */ 115 /* can set up tables etc before it starts */ 116 /* reading an archive */ 117 int (*rd)(ARCHD *, char *); 118 /* read header routine. passed a pointer to */ 119 /* ARCHD. It must extract the info from the */ 120 /* format and store it in the ARCHD struct. */ 121 /* This routine is expected to fill all the */ 122 /* fields in the ARCHD (including stat buf) */ 123 /* 0 is returned when a valid header is */ 124 /* found. -1 when not valid. This routine */ 125 /* set the skip and pad fields so the format */ 126 /* independent routines know the amount of */ 127 /* padding and the number of bytes of data */ 128 /* which follow the header. This info is */ 129 /* used skip to the next file header */ 130 off_t (*end_rd)(void); /* read cleanup. Allows format to clean up */ 131 /* and MUST RETURN THE LENGTH OF THE TRAILER */ 132 /* RECORD (so append knows how many bytes */ 133 /* to move back to rewrite the trailer) */ 134 int (*st_wr)(void); /* initialize routine for write operations */ 135 int (*wr)(ARCHD *); /* write archive header. Passed an ARCHD */ 136 /* filled with the specs on the next file to */ 137 /* archived. Returns a 1 if no file data is */ 138 /* is to be stored; 0 if file data is to be */ 139 /* added. A -1 is returned if a write */ 140 /* operation to the archive failed. this */ 141 /* function sets the skip and pad fields so */ 142 /* the proper padding can be added after */ 143 /* file data. This routine must NEVER write */ 144 /* a flawed archive header. */ 145 int (*end_wr)(void); /* end write. write the trailer and do any */ 146 /* other format specific functions needed */ 147 /* at the end of an archive write */ 148 int (*trail_cpio)(ARCHD *); 149 int (*trail_tar)(char *, int, int *); 150 /* returns 0 if a valid trailer, -1 if not */ 151 /* For formats which encode the trailer */ 152 /* outside of a valid header, a return value */ 153 /* of 1 indicates that the block passed to */ 154 /* it can never contain a valid header (skip */ 155 /* this block, no point in looking at it) */ 156 int (*rd_data)(ARCHD *, int, off_t *); 157 /* read/process file data from the archive */ 158 int (*wr_data)(ARCHD *, int, off_t *); 159 /* write/process file data to the archive */ 160 int (*options)(void); /* process format specific options (-o) */ 161 }; 162 163 /* 164 * Pattern matching structure 165 * 166 * Used to store command line patterns 167 */ 168 struct pattern { 169 char *pstr; /* pattern to match, user supplied */ 170 char *pend; /* end of a prefix match */ 171 char *chdname; /* the dir to change to if not NULL. */ 172 int plen; /* length of pstr */ 173 int flgs; /* processing/state flags */ 174 #define MTCH 0x1 /* pattern has been matched */ 175 #define DIR_MTCH 0x2 /* pattern matched a directory */ 176 struct pattern *fow; /* next pattern */ 177 }; 178 179 /* 180 * General Archive Structure (used internal to pax) 181 * 182 * This structure is used to pass information about archive members between 183 * the format independent routines and the format specific routines. When 184 * new archive formats are added, they must accept requests and supply info 185 * encoded in a structure of this type. The name fields are declared statically 186 * here, as there is only ONE of these floating around, size is not a major 187 * consideration. Eventually converting the name fields to a dynamic length 188 * may be required if and when the supporting operating system removes all 189 * restrictions on the length of pathnames it will resolve. 190 */ 191 struct archd { 192 int nlen; /* file name length */ 193 char name[PAXPATHLEN+1]; /* file name */ 194 int ln_nlen; /* link name length */ 195 char ln_name[PAXPATHLEN+1]; /* name to link to (if any) */ 196 char *org_name; /* orig name in file system */ 197 PATTERN *pat; /* ptr to pattern match (if any) */ 198 struct stat sb; /* stat buffer see stat(2) */ 199 off_t pad; /* bytes of padding after file xfer */ 200 off_t skip; /* bytes of real data after header */ 201 /* IMPORTANT. The st_size field does */ 202 /* not always indicate the amount of */ 203 /* data following the header. */ 204 u_long crc; /* file crc */ 205 int type; /* type of file node */ 206 #define PAX_DIR 1 /* directory */ 207 #define PAX_CHR 2 /* character device */ 208 #define PAX_BLK 3 /* block device */ 209 #define PAX_REG 4 /* regular file */ 210 #define PAX_SLK 5 /* symbolic link */ 211 #define PAX_SCK 6 /* socket */ 212 #define PAX_FIF 7 /* fifo */ 213 #define PAX_HLK 8 /* hard link */ 214 #define PAX_HRG 9 /* hard link to a regular file */ 215 #define PAX_CTG 10 /* high performance file */ 216 }; 217 218 /* 219 * Format Specific Options List 220 * 221 * Used to pass format options to the format options handler 222 */ 223 struct oplist { 224 char *name; /* option variable name e.g. name= */ 225 char *value; /* value for option variable */ 226 struct oplist *fow; /* next option */ 227 }; 228 229 /* 230 * General Macros 231 */ 232 #ifndef MIN 233 #define MIN(a,b) (((a)<(b))?(a):(b)) 234 #endif 235 #define MAJOR(x) major(x) 236 #define MINOR(x) minor(x) 237 #define TODEV(x, y) makedev((x), (y)) 238 239 /* 240 * General Defines 241 */ 242 #define HEX 16 243 #define OCT 8 244 #define _PAX_ 1 245 #define _TFILE_BASE "paxXXXXXXXXXX" 246