pax.h revision 76017
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: head/bin/pax/pax.h 76017 2001-04-26 08:37:00Z kris $ 39 */ 40 41/* 42 * BSD PAX global data structures and constants. 43 */ 44 45#define MAXBLK 32256 /* MAX blocksize supported (posix SPEC) */ 46 /* WARNING: increasing MAXBLK past 32256 */ 47 /* will violate posix spec. */ 48#define BLKMULT 512 /* blocksize must be even mult of 512 bytes */ 49 /* Don't even think of changing this */ 50#define DEVBLK 8192 /* default read blksize for devices */ 51#define FILEBLK 10240 /* default read blksize for files */ 52#define PAXPATHLEN 3072 /* maximum path length for pax. MUST be */ 53 /* longer than the system MAXPATHLEN */ 54 55/* 56 * Pax modes of operation 57 */ 58#define LIST 0 /* List the file in an archive */ 59#define EXTRACT 1 /* extract the files in an archive */ 60#define ARCHIVE 2 /* write a new archive */ 61#define APPND 3 /* append to the end of an archive */ 62#define COPY 4 /* copy files to destination dir */ 63#define DEFOP LIST /* if no flags default is to LIST */ 64 65/* 66 * Device type of the current archive volume 67 */ 68#define ISREG 0 /* regular file */ 69#define ISCHR 1 /* character device */ 70#define ISBLK 2 /* block device */ 71#define ISTAPE 3 /* tape drive */ 72#define ISPIPE 4 /* pipe/socket */ 73 74/* 75 * Format Specific Routine Table 76 * 77 * The format specific routine table allows new archive formats to be quickly 78 * added. Overall pax operation is independent of the actual format used to 79 * form the archive. Only those routines which deal directly with the archive 80 * are tailored to the oddities of the specific format. All other routines are 81 * independent of the archive format. Data flow in and out of the format 82 * dependent routines pass pointers to ARCHD structure (described below). 83 */ 84typedef struct { 85 char *name; /* name of format, this is the name the user */ 86 /* gives to -x option to select it. */ 87 int bsz; /* default block size. used when the user */ 88 /* does not specify a blocksize for writing */ 89 /* Appends continue to with the blocksize */ 90 /* the archive is currently using. */ 91 int hsz; /* Header size in bytes. this is the size of */ 92 /* the smallest header this format supports. */ 93 /* Headers are assumed to fit in a BLKMULT. */ 94 /* If they are bigger, get_head() and */ 95 /* get_arc() must be adjusted */ 96 int udev; /* does append require unique dev/ino? some */ 97 /* formats use the device and inode fields */ 98 /* to specify hard links. when members in */ 99 /* the archive have the same inode/dev they */ 100 /* are assumed to be hard links. During */ 101 /* append we may have to generate unique ids */ 102 /* to avoid creating incorrect hard links */ 103 int hlk; /* does archive store hard links info? if */ 104 /* not, we do not bother to look for them */ 105 /* during archive write operations */ 106 int blkalgn; /* writes must be aligned to blkalgn boundary */ 107 int inhead; /* is the trailer encoded in a valid header? */ 108 /* if not, trailers are assumed to be found */ 109 /* in invalid headers (i.e like tar) */ 110 int (*id)(); /* checks if a buffer is a valid header */ 111 /* returns 1 if it is, o.w. returns a 0 */ 112 int (*st_rd)(); /* initialize routine for read. so format */ 113 /* can set up tables etc before it starts */ 114 /* reading an archive */ 115 int (*rd)(); /* read header routine. passed a pointer to */ 116 /* ARCHD. It must extract the info from the */ 117 /* format and store it in the ARCHD struct. */ 118 /* This routine is expected to fill all the */ 119 /* fields in the ARCHD (including stat buf) */ 120 /* 0 is returned when a valid header is */ 121 /* found. -1 when not valid. This routine */ 122 /* set the skip and pad fields so the format */ 123 /* independent routines know the amount of */ 124 /* padding and the number of bytes of data */ 125 /* which follow the header. This info is */ 126 /* used skip to the next file header */ 127 off_t (*end_rd)(); /* read cleanup. Allows format to clean up */ 128 /* and MUST RETURN THE LENGTH OF THE TRAILER */ 129 /* RECORD (so append knows how many bytes */ 130 /* to move back to rewrite the trailer) */ 131 int (*st_wr)(); /* initialize routine for write operations */ 132 int (*wr)(); /* write archive header. Passed an ARCHD */ 133 /* filled with the specs on the next file to */ 134 /* archived. Returns a 1 if no file data is */ 135 /* is to be stored; 0 if file data is to be */ 136 /* added. A -1 is returned if a write */ 137 /* operation to the archive failed. this */ 138 /* function sets the skip and pad fields so */ 139 /* the proper padding can be added after */ 140 /* file data. This routine must NEVER write */ 141 /* a flawed archive header. */ 142 int (*end_wr)(); /* end write. write the trailer and do any */ 143 /* other format specific functions needed */ 144 /* at the end of a archive write */ 145 int (*trail)(); /* returns 0 if a valid trailer, -1 if not */ 146 /* For formats which encode the trailer */ 147 /* outside of a valid header, a return value */ 148 /* of 1 indicates that the block passed to */ 149 /* it can never contain a valid header (skip */ 150 /* this block, no point in looking at it) */ 151 /* CAUTION: parameters to this function are */ 152 /* different for trailers inside or outside */ 153 /* of headers. See get_head() for details */ 154 int (*rd_data)(); /* read/process file data from the archive */ 155 int (*wr_data)(); /* write/process file data to the archive */ 156 int (*options)(); /* process format specific options (-o) */ 157} FSUB; 158 159/* 160 * Pattern matching structure 161 * 162 * Used to store command line patterns 163 */ 164typedef struct pattern { 165 char *pstr; /* pattern to match, user supplied */ 166 char *pend; /* end of a prefix match */ 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 */ 186typedef 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} ARCHD; 212 213/* 214 * Format Specific Options List 215 * 216 * Used to pass format options to the format options handler 217 */ 218typedef struct oplist { 219 char *name; /* option variable name e.g. name= */ 220 char *value; /* value for option variable */ 221 struct oplist *fow; /* next option */ 222} OPLIST; 223 224/* 225 * General Macros 226 */ 227#ifndef MIN 228#define MIN(a,b) (((a)<(b))?(a):(b)) 229#endif 230#define MAJOR(x) major(x) 231#define MINOR(x) minor(x) 232#define TODEV(x, y) makedev((x), (y)) 233 234/* 235 * General Defines 236 */ 237#define HEX 16 238#define OCT 8 239#define _PAX_ 1 240#define _TFILE_BASE "paxXXXXXXXXXX" 241