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