1 /*- 2 * Copyright (c) 1992 Keith Muller. 3 * Copyright (c) 1992 The Regents of the University of California. 4 * 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 * %sccs.include.redist.c% 10 * 11 * @(#)pax.h 1.1 (Berkeley) 12/13/92 12 */ 13 14 /* 15 * BSD PAX global data structures and constants. 16 */ 17 18 #define MAXBLK 32256 /* MAX blocksize supported (posix SPEC) */ 19 /* WARNING: increasing MAXBLK past 32256 */ 20 /* will violate posix spec. */ 21 #define BLKMULT 512 /* blocksize must be even mult of 512 bytes */ 22 /* Don't even think of changing this */ 23 #define DEVBLK 8192 /* default read blksize for devices */ 24 #define FILEBLK 10240 /* default read blksize for files */ 25 #define PAXPATHLEN 3072 /* maximium path length for pax. MUST be */ 26 /* longer than the system max */ 27 28 /* 29 * Pax modes of operation 30 */ 31 #define LIST 0 /* List the file in an archive */ 32 #define EXTRACT 1 /* extract the files in an archive */ 33 #define ARCHIVE 2 /* write a new archive */ 34 #define APPND 3 /* append to the end of an archive */ 35 #define COPY 4 /* copy files to destination dir */ 36 #define DEFOP LIST /* if no flags default is to LIST */ 37 38 /* 39 * Device type of the current archive volume 40 */ 41 #define ISREG 0 /* regular file */ 42 #define ISCHR 1 /* character device */ 43 #define ISBLK 2 /* block device */ 44 #define ISTAPE 3 /* tape drive */ 45 #define ISPIPE 4 /* pipe/socket */ 46 47 /* 48 * Format Specific Routine Table 49 * 50 * The format specific routine table allows new archive formats to be quickly 51 * added. Overall pax operation is independent of the actual format used to 52 * form the archive. Only those routines which deal directly with the archive 53 * are tailored to the oddities of the specifc format. All other routines are 54 * independent of the archive format. Data flow in and out of the format 55 * dependnent routines pass pointers to ARCHD structure (described below). 56 */ 57 typedef struct { 58 char *name; /* name of format, this is the name the user */ 59 /* gives to -x to select it. */ 60 int bsz; /* default block size. used when the user */ 61 /* does not specify a blocksize for writing */ 62 /* Appends continue to with the blocksize */ 63 /* the archive is currently using.*/ 64 int hsz; /* Header size in bytes. this is the size of */ 65 /* the smallest header this format supports. */ 66 /* Headers are assumed to fit in a BLKMULT. */ 67 /* If they are bigger, get_head() and */ 68 /* get_arc() must be adjusted */ 69 int udev; /* does append require unique dev/ino. some */ 70 /* formats use the device and inode fields */ 71 /* to specify hard links. when members in */ 72 /* the archive have the same inode/dev they */ 73 /* are assumed to be hard links. During */ 74 /* append we may have to generate unique ids */ 75 /* to avoid creating incorrect links */ 76 int hlk; /* does archive store hard links info? if */ 77 /* not we do not bother to look for them */ 78 /* during write operations */ 79 int blkalgn; /* writes must be aligned to blkalgn boundry */ 80 int inhead; /* is the trailer encoded in a valid header? */ 81 /* if not, trailers are assumed to be */ 82 /* invalid headers */ 83 int (*id)(); /* checks if a buffer is a valid header */ 84 /* returns 1 if it is, o.w. returns a 0 */ 85 int (*st_rd)(); /* initialize routine for read. so format */ 86 /* can set up tables etc before it starts */ 87 /* reading */ 88 int (*rd)(); /* read header routine. passed a pointer to */ 89 /* ARCHD. It must extract the info from the */ 90 /* format and store it in the ARCHD struct. */ 91 /* 0 is returned when a valid header is */ 92 /* found. -1 when not valid. This routine */ 93 /* set the skip and pad fields so the format */ 94 /* independent routines know the amount of */ 95 /* padding and the number of bytes to get to */ 96 /* the next file header */ 97 off_t (*end_rd)(); /* read is over. Allows format to clean up */ 98 /* and MUST return the length of the trailer */ 99 /* record (so append knows how many bytes */ 100 /* to move back to rewrite the trailer */ 101 int (*st_wr)(); /* initialize routine for write operations */ 102 int (*wr)(); /* write archive header. Passed an ARCHD */ 103 /* filled with the specs on the next file to */ 104 /* archived. Returns a 1 if no file data is */ 105 /* is to be stored; 0 if file data is to be */ 106 /* added. A -1 is returned if a write */ 107 /* operation to the archive failed. this */ 108 /* function sets the skip and pad fields so */ 109 /* the proper padding can be added after */ 110 /* file data. This routine must NEVER write */ 111 /* a flawed archive header. */ 112 int (*end_wr)(); /* end write. write the trailer and do any */ 113 /* other format specific functions needed */ 114 /* at the ecnd of a archive write */ 115 int (*trail)(); /* returns 0 if a valid trailer, -1 if not */ 116 /* For formats which encode the trailer */ 117 /* outside of a valid header, a return value */ 118 /* of 1 indicates that the block passed to */ 119 /* it can never contain a valid header (skip */ 120 /* this block, no point in looking at it) */ 121 /* CAUTION: parameters to this function are */ 122 /* different for trailers inside or outside */ 123 /* of headers. Se get_head() for details */ 124 int (*rd_data)(); /* read/process file data on the archive */ 125 int (*wr_data)(); /* read/process file data on the archive */ 126 int (*options)(); /* process format options (-x) flags */ 127 } FSUB; 128 129 /* 130 * Pattern matching structure 131 * 132 * Used to store command line patterns 133 */ 134 typedef struct pattern { 135 char *pstr; /* pattern to match, user supplied */ 136 int plen; /* length of pstr */ 137 int flgs; /* processing/state flags */ 138 #define MTCH 0x1 /* this pattern has been matched */ 139 #define DIR_MTCH 0x2 /* this pattern matched a directory */ 140 struct pattern *fow; /* next pattern */ 141 } PATTERN; 142 143 /* 144 * General Archive Structure (used internal to pax) 145 * 146 * This structure is used to pass information about archive members between 147 * the format independent routines and the format specific routines. When 148 * new archive formats are added, they must accept requests and supply info 149 * encoded in a structure of this type. The name fields are declared statically 150 * here. The cost of malloc() and free on every archive member was found to be 151 * excessive. Since there is only ONE of these flowting around, size is not a 152 * big consideration. 153 */ 154 typedef struct { 155 int nlen; /* file name length */ 156 char name[PAXPATHLEN+1]; /* file name */ 157 int ln_nlen; /* link name length */ 158 char ln_name[PAXPATHLEN+1]; /* name to link to (if any) */ 159 char *org_name; /* orig name in file system */ 160 PATTERN *pat; /* ptr to pattern match (if any) */ 161 struct stat sb; /* stat buffer see stat(2) */ 162 off_t pad; /* bytes of padding after file xfer */ 163 off_t skip; /* bytes of real data after header */ 164 /* the st_size field may not apply */ 165 u_long crc; /* file crc */ 166 int type; /* type of file node */ 167 #define PAX_DIR 1 /* directory */ 168 #define PAX_CHR 2 /* character device */ 169 #define PAX_BLK 3 /* block device */ 170 #define PAX_REG 4 /* regular file */ 171 #define PAX_SLK 5 /* symbolic link */ 172 #define PAX_SCK 6 /* socket */ 173 #define PAX_FIF 7 /* fifo */ 174 #define PAX_HLK 8 /* hard link */ 175 #define PAX_HRG 9 /* hard link (to a file if known) */ 176 #define PAX_CTG 10 /* high performance file */ 177 } ARCHD; 178 179 /* 180 * Format Specific Options List 181 * 182 * Used to pass format options to the format options handler 183 */ 184 typedef struct oplist { 185 char *name; /* option variable name e.g. name= */ 186 char *value; /* value for option variable */ 187 struct oplist *fow; /* next option */ 188 } OPLIST; 189 190 /* 191 * General Macros 192 */ 193 #ifndef MIN 194 #define MIN(a,b) (((a)<(b))?(a):(b)) 195 #endif 196 #define MAJOR(x) (((unsigned)(x) >> 8) & 0xff) 197 #define MINOR(x) ((x) & 0xff) 198 #define TODEV(x, y) (((unsigned)(x) << 8) | ((unsigned)(y))) 199 200 /* 201 * General Defines 202 */ 203 #define HEX 16 204 #define OCT 8 205