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