1 /* $OpenBSD: pax.h,v 1.9 1997/07/23 19:15:58 kstailey 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. All advertising materials mentioning features or use of this software 21 * must display the following acknowledgement: 22 * This product includes software developed by the University of 23 * California, Berkeley and its contributors. 24 * 4. Neither the name of the University nor the names of its contributors 25 * may be used to endorse or promote products derived from this software 26 * without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 38 * SUCH DAMAGE. 39 * 40 * @(#)pax.h 8.2 (Berkeley) 4/18/94 41 */ 42 43 /* 44 * BSD PAX global data structures and constants. 45 */ 46 47 #define MAXBLK 64512 /* MAX blocksize supported (posix SPEC) */ 48 /* WARNING: increasing MAXBLK past 32256 */ 49 /* will violate posix spec. */ 50 #define MAXBLK_POSIX 32256 /* MAX blocksize supported as per POSIX */ 51 #define BLKMULT 512 /* blocksize must be even mult of 512 bytes */ 52 /* Don't even think of changing this */ 53 #define DEVBLK 8192 /* default read blksize for devices */ 54 #define FILEBLK 10240 /* default read blksize for files */ 55 #define PAXPATHLEN 3072 /* maximium path length for pax. MUST be */ 56 /* longer than the system MAXPATHLEN */ 57 58 /* 59 * Pax modes of operation 60 */ 61 #define LIST 0 /* List the file in an archive */ 62 #define EXTRACT 1 /* extract the files in an archive */ 63 #define ARCHIVE 2 /* write a new archive */ 64 #define APPND 3 /* append to the end of an archive */ 65 #define COPY 4 /* copy files to destination dir */ 66 #define DEFOP LIST /* if no flags default is to LIST */ 67 68 /* 69 * Device type of the current archive volume 70 */ 71 #define ISREG 0 /* regular file */ 72 #define ISCHR 1 /* character device */ 73 #define ISBLK 2 /* block device */ 74 #define ISTAPE 3 /* tape drive */ 75 #define ISPIPE 4 /* pipe/socket */ 76 77 /* 78 * Format Specific Routine Table 79 * 80 * The format specific routine table allows new archive formats to be quickly 81 * added. Overall pax operation is independent of the actual format used to 82 * form the archive. Only those routines which deal directly with the archive 83 * are tailored to the oddities of the specifc format. All other routines are 84 * independent of the archive format. Data flow in and out of the format 85 * dependent routines pass pointers to ARCHD structure (described below). 86 */ 87 typedef struct { 88 char *name; /* name of format, this is the name the user */ 89 /* gives to -x option to select it. */ 90 int bsz; /* default block size. used when the user */ 91 /* does not specify a blocksize for writing */ 92 /* Appends continue to with the blocksize */ 93 /* the archive is currently using. */ 94 int hsz; /* Header size in bytes. this is the size of */ 95 /* the smallest header this format supports. */ 96 /* Headers are assumed to fit in a BLKMULT. */ 97 /* If they are bigger, get_head() and */ 98 /* get_arc() must be adjusted */ 99 int udev; /* does append require unique dev/ino? some */ 100 /* formats use the device and inode fields */ 101 /* to specify hard links. when members in */ 102 /* the archive have the same inode/dev they */ 103 /* are assumed to be hard links. During */ 104 /* append we may have to generate unique ids */ 105 /* to avoid creating incorrect hard links */ 106 int hlk; /* does archive store hard links info? if */ 107 /* not, we do not bother to look for them */ 108 /* during archive write operations */ 109 int blkalgn; /* writes must be aligned to blkalgn boundry */ 110 int inhead; /* is the trailer encoded in a valid header? */ 111 /* if not, trailers are assumed to be found */ 112 /* in invalid headers (i.e like tar) */ 113 int (*id)(); /* checks if a buffer is a valid header */ 114 /* returns 1 if it is, o.w. returns a 0 */ 115 int (*st_rd)(); /* initialize routine for read. so format */ 116 /* can set up tables etc before it starts */ 117 /* reading an archive */ 118 int (*rd)(); /* 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)(); /* 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)(); /* initialize routine for write operations */ 135 int (*wr)(); /* 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)(); /* end write. write the trailer and do any */ 146 /* other format specific functions needed */ 147 /* at the ecnd of a archive write */ 148 int (*trail)(); /* returns 0 if a valid trailer, -1 if not */ 149 /* For formats which encode the trailer */ 150 /* outside of a valid header, a return value */ 151 /* of 1 indicates that the block passed to */ 152 /* it can never contain a valid header (skip */ 153 /* this block, no point in looking at it) */ 154 /* CAUTION: parameters to this function are */ 155 /* different for trailers inside or outside */ 156 /* of headers. See get_head() for details */ 157 int (*rd_data)(); /* read/process file data from the archive */ 158 int (*wr_data)(); /* write/process file data to the archive */ 159 int (*options)(); /* process format specific options (-o) */ 160 } FSUB; 161 162 /* 163 * Pattern matching structure 164 * 165 * Used to store command line patterns 166 */ 167 typedef struct pattern { 168 char *pstr; /* pattern to match, user supplied */ 169 char *pend; /* end of a prefix match */ 170 char *chdname; /* the dir to change to if not NULL. */ 171 int plen; /* length of pstr */ 172 int flgs; /* processing/state flags */ 173 #define MTCH 0x1 /* pattern has been matched */ 174 #define DIR_MTCH 0x2 /* pattern matched a directory */ 175 struct pattern *fow; /* next pattern */ 176 } PATTERN; 177 178 /* 179 * General Archive Structure (used internal to pax) 180 * 181 * This structure is used to pass information about archive members between 182 * the format independent routines and the format specific routines. When 183 * new archive formats are added, they must accept requests and supply info 184 * encoded in a structure of this type. The name fields are declared statically 185 * here, as there is only ONE of these floating around, size is not a major 186 * consideration. Eventually converting the name fields to a dynamic length 187 * may be required if and when the supporting operating system removes all 188 * restrictions on the length of pathnames it will resolve. 189 */ 190 typedef struct { 191 int nlen; /* file name length */ 192 char name[PAXPATHLEN+1]; /* file name */ 193 int ln_nlen; /* link name length */ 194 char ln_name[PAXPATHLEN+1]; /* name to link to (if any) */ 195 char *org_name; /* orig name in file system */ 196 PATTERN *pat; /* ptr to pattern match (if any) */ 197 struct stat sb; /* stat buffer see stat(2) */ 198 off_t pad; /* bytes of padding after file xfer */ 199 off_t skip; /* bytes of real data after header */ 200 /* IMPORTANT. The st_size field does */ 201 /* not always indicate the amount of */ 202 /* data following the header. */ 203 u_long crc; /* file crc */ 204 int type; /* type of file node */ 205 #define PAX_DIR 1 /* directory */ 206 #define PAX_CHR 2 /* character device */ 207 #define PAX_BLK 3 /* block device */ 208 #define PAX_REG 4 /* regular file */ 209 #define PAX_SLK 5 /* symbolic link */ 210 #define PAX_SCK 6 /* socket */ 211 #define PAX_FIF 7 /* fifo */ 212 #define PAX_HLK 8 /* hard link */ 213 #define PAX_HRG 9 /* hard link to a regular file */ 214 #define PAX_CTG 10 /* high performance file */ 215 } ARCHD; 216 217 /* 218 * Format Specific Options List 219 * 220 * Used to pass format options to the format options handler 221 */ 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 */ 226 } OPLIST; 227 228 /* 229 * General Macros 230 */ 231 #ifndef MIN 232 #define MIN(a,b) (((a)<(b))?(a):(b)) 233 #endif 234 #define MAJOR(x) major(x) 235 #define MINOR(x) minor(x) 236 #define TODEV(x, y) makedev((x), (y)) 237 238 /* 239 * General Defines 240 */ 241 #define HEX 16 242 #define OCT 8 243 #define _PAX_ 1 244