bin/pax/pax.h

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