1 /* $NetBSD: pax.h,v 1.13 2002/01/31 22:43:36 tv Exp $ */ 2 3 /*- 4 * Copyright (c) 1992 Keith Muller. 5 * Copyright (c) 1992, 1993 6 * The Regents of the University of California. All rights reserved. 7 * 8 * This code is derived from software contributed to Berkeley by 9 * Keith Muller of the University of California, San Diego. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the University of 22 * California, Berkeley and its contributors. 23 * 4. Neither the name of the University nor the names of its contributors 24 * may be used to endorse or promote products derived from this software 25 * without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 37 * SUCH DAMAGE. 38 * 39 * @(#)pax.h 8.2 (Berkeley) 4/18/94 40 */ 41 42 #if HAVE_CONFIG_H 43 #include "config.h" 44 #else 45 #define HAVE_LCHMOD 1 46 #define HAVE_LCHOWN 1 47 #define HAVE_LUTIMES 1 48 #define HAVE_STRUCT_STAT_ST_FLAGS 1 49 #endif 50 51 /* 52 * BSD PAX global data structures and constants. 53 */ 54 55 #define MAXBLK 32256 /* MAX blocksize supported (posix SPEC) */ 56 /* WARNING: increasing MAXBLK past 32256 */ 57 /* will violate posix spec. */ 58 #define BLKMULT 512 /* blocksize must be even mult of 512 bytes */ 59 /* Don't even think of changing this */ 60 #define DEVBLK 8192 /* default read blksize for devices */ 61 #define FILEBLK 10240 /* default read blksize for files */ 62 #define PAXPATHLEN 3072 /* maximum path length for pax. MUST be */ 63 /* longer than the system MAXPATHLEN */ 64 65 /* 66 * Pax modes of operation 67 */ 68 #define LIST 0 /* List the file in an archive */ 69 #define EXTRACT 1 /* extract the files in an archive */ 70 #define ARCHIVE 2 /* write a new archive */ 71 #define APPND 3 /* append to the end of an archive */ 72 #define COPY 4 /* copy files to destination dir */ 73 #define DEFOP LIST /* if no flags default is to LIST */ 74 75 /* 76 * Device type of the current archive volume 77 */ 78 #define ISREG 0 /* regular file */ 79 #define ISCHR 1 /* character device */ 80 #define ISBLK 2 /* block device */ 81 #define ISTAPE 3 /* tape drive */ 82 #define ISPIPE 4 /* pipe/socket */ 83 84 85 /* 86 * Pattern matching structure 87 * 88 * Used to store command line patterns 89 */ 90 typedef struct pattern { 91 char *pstr; /* pattern to match, user supplied */ 92 char *pend; /* end of a prefix match */ 93 int plen; /* length of pstr */ 94 int flgs; /* processing/state flags */ 95 #define MTCH 0x1 /* pattern has been matched */ 96 #define DIR_MTCH 0x2 /* pattern matched a directory */ 97 #define PTCHDIR 0x4 /* not pattern but chdir */ 98 struct pattern *fow; /* next pattern */ 99 } PATTERN; 100 101 /* 102 * General Archive Structure (used internal to pax) 103 * 104 * This structure is used to pass information about archive members between 105 * the format independent routines and the format specific routines. When 106 * new archive formats are added, they must accept requests and supply info 107 * encoded in a structure of this type. The name fields are declared statically 108 * here, as there is only ONE of these floating around, size is not a major 109 * consideration. Eventually converting the name fields to a dynamic length 110 * may be required if and when the supporting operating system removes all 111 * restrictions on the length of pathnames it will resolve. 112 */ 113 typedef struct { 114 int nlen; /* file name length */ 115 char name[PAXPATHLEN+1]; /* file name */ 116 int ln_nlen; /* link name length */ 117 char ln_name[PAXPATHLEN+1]; /* name to link to (if any) */ 118 char *org_name; /* orig name in file system */ 119 PATTERN *pat; /* ptr to pattern match (if any) */ 120 struct stat sb; /* stat buffer see stat(2) */ 121 off_t pad; /* bytes of padding after file xfer */ 122 off_t skip; /* bytes of real data after header */ 123 /* IMPORTANT. The st_size field does */ 124 /* not always indicate the amount of */ 125 /* data following the header. */ 126 u_long crc; /* file crc */ 127 int type; /* type of file node */ 128 #define PAX_DIR 1 /* directory */ 129 #define PAX_CHR 2 /* character device */ 130 #define PAX_BLK 3 /* block device */ 131 #define PAX_REG 4 /* regular file */ 132 #define PAX_SLK 5 /* symbolic link */ 133 #define PAX_SCK 6 /* socket */ 134 #define PAX_FIF 7 /* fifo */ 135 #define PAX_HLK 8 /* hard link */ 136 #define PAX_HRG 9 /* hard link to a regular file */ 137 #define PAX_CTG 10 /* high performance file */ 138 #define PAX_GLL 11 /* GNU long symlink */ 139 #define PAX_GLF 12 /* GNU long file */ 140 } ARCHD; 141 142 /* 143 * Format Specific Routine Table 144 * 145 * The format specific routine table allows new archive formats to be quickly 146 * added. Overall pax operation is independent of the actual format used to 147 * form the archive. Only those routines which deal directly with the archive 148 * are tailored to the oddities of the specific format. All other routines are 149 * independent of the archive format. Data flow in and out of the format 150 * dependent routines pass pointers to ARCHD structure (described below). 151 */ 152 typedef struct { 153 char *name; /* name of format, this is the name the user */ 154 /* gives to -x option to select it. */ 155 int bsz; /* default block size. used when the user */ 156 /* does not specify a blocksize for writing */ 157 /* Appends continue to with the blocksize */ 158 /* the archive is currently using.*/ 159 int hsz; /* Header size in bytes. this is the size of */ 160 /* the smallest header this format supports. */ 161 /* Headers are assumed to fit in a BLKMULT. */ 162 /* If they are bigger, get_head() and */ 163 /* get_arc() must be adjusted */ 164 int udev; /* does append require unique dev/ino? some */ 165 /* formats use the device and inode fields */ 166 /* to specify hard links. when members in */ 167 /* the archive have the same inode/dev they */ 168 /* are assumed to be hard links. During */ 169 /* append we may have to generate unique ids */ 170 /* to avoid creating incorrect hard links */ 171 int hlk; /* does archive store hard links info? if */ 172 /* not, we do not bother to look for them */ 173 /* during archive write operations */ 174 int blkalgn; /* writes must be aligned to blkalgn boundary */ 175 int inhead; /* is the trailer encoded in a valid header? */ 176 /* if not, trailers are assumed to be found */ 177 /* in invalid headers (i.e like tar) */ 178 int (*id)(char *, int); /* checks if a buffer is a valid header */ 179 /* returns 1 if it is, o.w. returns a 0 */ 180 int (*st_rd)(void); /* initialize routine for read. so format */ 181 /* can set up tables etc before it starts */ 182 /* reading an archive */ 183 int (*rd) /* read header routine. passed a pointer to */ 184 (ARCHD *, char *); /* ARCHD. It must extract the info */ 185 /* from the format and store it in the ARCHD */ 186 /* struct. This routine is expected to fill */ 187 /* all the fields in the ARCHD (including */ 188 /* stat buf). 0 is returned when a valid */ 189 /* header is found. -1 when not valid. This */ 190 /* routine set the skip and pad fields so the */ 191 /* format independent routines know the */ 192 /* amount of padding and the number of bytes */ 193 /* of data which follow the header. This info */ 194 /* is used to skip to the next file header */ 195 off_t (*end_rd)(void); /* read cleanup. Allows format to clean up */ 196 /* and MUST RETURN THE LENGTH OF THE TRAILER */ 197 /* RECORD (so append knows how many bytes */ 198 /* to move back to rewrite the trailer) */ 199 int (*st_wr)(void); /* initialize routine for write operations */ 200 int (*wr)(ARCHD *); /* write archive header. Passed an ARCHD */ 201 /* filled with the specs on the next file to */ 202 /* archived. Returns a 1 if no file data is */ 203 /* is to be stored; 0 if file data is to be */ 204 /* added. A -1 is returned if a write */ 205 /* operation to the archive failed. this */ 206 /* function sets the skip and pad fields so */ 207 /* the proper padding can be added after */ 208 /* file data. This routine must NEVER write */ 209 /* a flawed archive header. */ 210 int (*end_wr)(void); /* end write. write the trailer and do any */ 211 /* other format specific functions needed */ 212 /* at the ecnd of a archive write */ 213 int (*trail) /* returns 0 if a valid trailer, -1 if not */ 214 (char *, int, int *); /* For formats which encode the */ 215 /* trailer outside of a valid header, a */ 216 /* return value of 1 indicates that the block */ 217 /* passed to it can never contain a valid */ 218 /* header (skip this block, no point in */ 219 /* looking at it) */ 220 int (*subtrail) /* read/process file data from the archive */ 221 (ARCHD *); /* this function is called for trailers */ 222 /* inside headers. */ 223 int (*rd_data) /* read/process file data from the archive */ 224 (ARCHD *, int, off_t *); 225 int (*wr_data) /* write/process file data to the archive */ 226 (ARCHD *, int, off_t *); 227 int (*options)(void); /* process format specific options (-o) */ 228 } FSUB; 229 230 /* 231 * Format Specific Options List 232 * 233 * Used to pass format options to the format options handler 234 */ 235 typedef struct oplist { 236 char *name; /* option variable name e.g. name= */ 237 char *value; /* value for option variable */ 238 struct oplist *fow; /* next option */ 239 } OPLIST; 240 241 /* 242 * General Macros 243 */ 244 #ifndef MIN 245 #define MIN(a,b) (((a)<(b))?(a):(b)) 246 #endif 247 #define MAJOR(x) major(x) 248 #define MINOR(x) minor(x) 249 #define TODEV(x, y) makedev(x, y) 250 251 /* 252 * General Defines 253 */ 254 #define HEX 16 255 #define OCT 8 256 #define _PAX_ 1 257 258 /* 259 * Pathname base component of the temporary file template, to be created in 260 * ${TMPDIR} or, as a fall-back, _PATH_TMP. 261 */ 262 #define TMPFILE "paxXXXXXX" 263 264 /* 265 * Macros to manipulate off_t as a unsigned long or unsigned long long 266 */ 267 #ifdef NET2_STAT 268 #define OFFT_F "%lu" 269 #define OFFT_FP(x) "%" x "lu" 270 #define OFFT_T u_long 271 #define ASC_OFFT(x,y,z) asc_ul(x,y,z) 272 #define OFFT_ASC(w,x,y,z) ul_asc((u_long)w,x,y,z) 273 #define OFFT_OCT(w,x,y,z) ul_oct((u_long)w,x,y,z) 274 #define STRTOOFFT(x,y,z) strtol(x,y,z) 275 #define OFFT_MAX LONG_MAX 276 #else 277 #define OFFT_F "%llu" 278 #define OFFT_FP(x) "%" x "llu" 279 #define OFFT_T unsigned long long 280 #define ASC_OFFT(x,y,z) asc_ull(x,y,z) 281 #define OFFT_ASC(w,x,y,z) ull_asc((unsigned long long)w,x,y,z) 282 #define OFFT_OCT(w,x,y,z) ull_oct((unsigned long long)w,x,y,z) 283 #define STRTOOFFT(x,y,z) strtoll(x,y,z) 284 #define OFFT_MAX ULLONG_MAX 285 #endif 286