pax/pax.h

   1 /*      $OpenBSD: pax.h,v 1.17 2005/11/09 19:59:06 otto Exp $   */
   2 /*      $NetBSD: pax.h,v 1.3 1995/03/21 09:07:41 cgd Exp $      */
   3
   4 /*-
   5  * Copyright (c) 1992 Keith Muller.
   6  * Copyright (c) 1992, 1993
   7  *      The Regents of the University of California.  All rights reserved.
   8  *
   9  * This code is derived from software contributed to Berkeley by
  10  * Keith Muller of the University of California, San Diego.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)pax.h       8.2 (Berkeley) 4/18/94
  37  */
  38
  39 #ifndef _PAX_H_
  40 #define _PAX_H_
  41
  42 /*
  43  * BSD PAX global data structures and constants.
  44  */
  45
  46 #define MAXBLK          64512   /* MAX blocksize supported (posix SPEC) */
  47                                 /* WARNING: increasing MAXBLK past 32256 */
  48                                 /* will violate posix spec. */
  49 #define MAXBLK_POSIX    32256   /* MAX blocksize supported as per POSIX */
  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 LIST            0       /* List the file in an archive */
  61 #define EXTRACT         1       /* extract the files in an archive */
  62 #define ARCHIVE         2       /* write a new archive */
  63 #define APPND           3       /* append to the end of an archive */
  64 #define COPY            4       /* copy files to destination dir */
  65 #define DEFOP           LIST    /* if no flags default is to LIST */
  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
  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         char            *chdname;       /* the dir to change to if not NULL.  */
  85         int             plen;           /* length of pstr */
  86         int             flgs;           /* processing/state flags */
  87 #define MTCH            0x1             /* pattern has been matched */
  88 #define DIR_MTCH        0x2             /* pattern matched a directory */
  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_int32_t 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 specific 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 boundary */
 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)(char *,       /* checks if a buffer is a valid header */
 170             int);               /* returns 1 if it is, o.w. returns a 0 */
 171         int (*st_rd)(void);     /* initialize routine for read. so format */
 172                                 /* can set up tables etc before it starts */
 173                                 /* reading an archive */
 174         int (*rd)(ARCHD *,      /* read header routine. passed a pointer to */
 175             char *);            /* ARCHD. It must extract the info from the */
 176                                 /* format and store it in the ARCHD struct. */
 177                                 /* This routine is expected to fill all the */
 178                                 /* fields in the ARCHD (including stat buf) */
 179                                 /* 0 is returned when a valid header is */
 180                                 /* found. -1 when not valid. This routine */
 181                                 /* set the skip and pad fields so the format */
 182                                 /* independent routines know the amount of */
 183                                 /* padding and the number of bytes of data */
 184                                 /* which follow the header. This info is */
 185                                 /* used skip to the next file header */
 186         off_t (*end_rd)(void);  /* read cleanup. Allows format to clean up */
 187                                 /* 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)(void);     /* initialize routine for write operations */
 191         int (*wr)(ARCHD *);     /* write archive header. Passed an ARCHD */
 192                                 /* filled with the specs on the next file to */
 193                                 /* archived. Returns a 1 if no file data is */
 194                                 /* is to be stored; 0 if file data is to be */
 195                                 /* added. A -1 is returned if a write */
 196                                 /* operation to the archive failed. this */
 197                                 /* function sets the skip and pad fields so */
 198                                 /* the proper padding can be added after */
 199                                 /* file data. This routine must NEVER write */
 200                                 /* a flawed archive header. */
 201         int (*end_wr)(void);    /* end write. write the trailer and do any */
 202                                 /* other format specific functions needed */
 203                                 /* at the end of an archive write */
 204         int (*trail)(ARCHD *,   /* returns 0 if a valid trailer, -1 if not */
 205             char *, int,        /* For formats which encode the trailer */
 206             int *);             /* outside of a valid header, a return value */
 207                                 /* of 1 indicates that the block passed to */
 208                                 /* it can never contain a valid header (skip */
 209                                 /* this block, no point in looking at it)  */
 210                                 /* CAUTION: parameters to this function are */
 211                                 /* different for trailers inside or outside */
 212                                 /* of headers. See get_head() for details */
 213         int (*rd_data)(ARCHD *, /* read/process file data from the archive */
 214             int, off_t *);
 215         int (*wr_data)(ARCHD *, /* write/process file data to the archive */
 216             int, off_t *);
 217         int (*options)(void);   /* process format specific options (-o) */
 218 } FSUB;
 219
 220 /*
 221  * Format Specific Options List
 222  *
 223  * Used to pass format options to the format options handler
 224  */
 225 typedef 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         int             separator;      /* 2 means := separator; 1 means = separator
 230                                            0 means no separator */
 231 } OPLIST;
 232 #define SEP_COLONEQ     2
 233 #define SEP_EQ          1
 234 #define SEP_NONE        0
 235
 236 /*
 237  * General Macros
 238  */
 239 #ifndef MIN
 240 #define MIN(a,b) (((a)<(b))?(a):(b))
 241 #endif
 242 #define MAJOR(x)        major(x)
 243 #define MINOR(x)        minor(x)
 244 #define TODEV(x, y)     makedev((x), (y))
 245
 246 /*
 247  * General Defines
 248  */
 249 #define HEX             16
 250 #define OCT             8
 251 #define _PAX_           1
 252 #define _HAVE_REGCOMP_  1
 253 #define _TFILE_BASE     "paxXXXXXXXXXX"
 254
 255 #endif /* _PAX_H_ */