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