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