bin/pax/cpio.h

   1 /*-
   2  * Copyright (c) 1992 Keith Muller.
   3  * Copyright (c) 1992, 1993
   4  *      The Regents of the University of California.  All rights reserved.
   5  *
   6  * This code is derived from software contributed to Berkeley by
   7  * Keith Muller of the University of California, San Diego.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)cpio.h      8.1 (Berkeley) 5/31/93
  34  * $FreeBSD$
  35  */
  36
  37 /*
  38  * Defines common to all versions of cpio
  39  */
  40 #define TRAILER         "TRAILER!!!"    /* name in last archive record */
  41
  42 /*
  43  * Header encoding of the different file types
  44  */
  45 #define C_ISDIR          040000         /* Directory */
  46 #define C_ISFIFO         010000         /* FIFO */
  47 #define C_ISREG         0100000         /* Regular file */
  48 #define C_ISBLK          060000         /* Block special file */
  49 #define C_ISCHR          020000         /* Character special file */
  50 #define C_ISCTG         0110000         /* Reserved for contiguous files */
  51 #define C_ISLNK         0120000         /* Reserved for symbolic links */
  52 #define C_ISOCK         0140000         /* Reserved for sockets */
  53 #define C_IFMT          0170000         /* type of file */
  54
  55 /*
  56  * Data Interchange Format - Extended cpio header format - POSIX 1003.1-1990
  57  */
  58 typedef struct {
  59         char    c_magic[6];             /* magic cookie */
  60         char    c_dev[6];               /* device number */
  61         char    c_ino[6];               /* inode number */
  62         char    c_mode[6];              /* file type/access */
  63         char    c_uid[6];               /* owners uid */
  64         char    c_gid[6];               /* owners gid */
  65         char    c_nlink[6];             /* # of links at archive creation */
  66         char    c_rdev[6];              /* block/char major/minor # */
  67         char    c_mtime[11];            /* modification time */
  68         char    c_namesize[6];          /* length of pathname */
  69         char    c_filesize[11];         /* length of file in bytes */
  70 } HD_CPIO __aligned(1);
  71
  72 #define MAGIC           070707          /* transportable archive id */
  73
  74 #ifdef _PAX_
  75 #define AMAGIC          "070707"        /* ascii equivalent string of MAGIC */
  76 #define CPIO_MASK       0x3ffff         /* bits valid in the dev/ino fields */
  77                                         /* used for dev/inode remaps */
  78 #endif /* _PAX_ */
  79
  80 /*
  81  * Binary cpio header structure
  82  *
  83  * CAUTION! CAUTION! CAUTION!
  84  * Each field really represents a 16 bit short (NOT ASCII). Described as
  85  * an array of chars in an attempt to improve portability!!
  86  */
  87 typedef struct {
  88         u_char  h_magic[2];
  89         u_char  h_dev[2];
  90         u_char  h_ino[2];
  91         u_char  h_mode[2];
  92         u_char  h_uid[2];
  93         u_char  h_gid[2];
  94         u_char  h_nlink[2];
  95         u_char  h_rdev[2];
  96         u_char  h_mtime_1[2];
  97         u_char  h_mtime_2[2];
  98         u_char  h_namesize[2];
  99         u_char  h_filesize_1[2];
 100         u_char  h_filesize_2[2];
 101 } HD_BCPIO __aligned(1);
 102
 103 #ifdef _PAX_
 104 /*
 105  * extraction and creation macros for binary cpio
 106  */
 107 #define SHRT_EXT(ch)    ((((unsigned)(ch)[0])<<8) | (((unsigned)(ch)[1])&0xff))
 108 #define RSHRT_EXT(ch)   ((((unsigned)(ch)[1])<<8) | (((unsigned)(ch)[0])&0xff))
 109 #define CHR_WR_0(val)   ((char)(((val) >> 24) & 0xff))
 110 #define CHR_WR_1(val)   ((char)(((val) >> 16) & 0xff))
 111 #define CHR_WR_2(val)   ((char)(((val) >> 8) & 0xff))
 112 #define CHR_WR_3(val)   ((char)((val) & 0xff))
 113
 114 /*
 115  * binary cpio masks and pads
 116  */
 117 #define BCPIO_PAD(x)    ((2 - ((x) & 1)) & 1)   /* pad to next 2 byte word */
 118 #define BCPIO_MASK      0xffff                  /* mask for dev/ino fields */
 119 #endif /* _PAX_ */
 120
 121 /*
 122  * System VR4 cpio header structure (with/without file data crc)
 123  */
 124 typedef struct {
 125         char    c_magic[6];             /* magic cookie */
 126         char    c_ino[8];               /* inode number */
 127         char    c_mode[8];              /* file type/access */
 128         char    c_uid[8];               /* owners uid */
 129         char    c_gid[8];               /* owners gid */
 130         char    c_nlink[8];             /* # of links at archive creation */
 131         char    c_mtime[8];             /* modification time */
 132         char    c_filesize[8];          /* length of file in bytes */
 133         char    c_maj[8];               /* block/char major # */
 134         char    c_min[8];               /* block/char minor # */
 135         char    c_rmaj[8];              /* special file major # */
 136         char    c_rmin[8];              /* special file minor # */
 137         char    c_namesize[8];          /* length of pathname */
 138         char    c_chksum[8];            /* 0 OR CRC of bytes of FILE data */
 139 } HD_VCPIO __aligned(1);
 140
 141 #define VMAGIC          070701          /* sVr4 new portable archive id */
 142 #define VCMAGIC         070702          /* sVr4 new portable archive id CRC */
 143 #ifdef _PAX_
 144 #define AVMAGIC         "070701"        /* ascii string of above */
 145 #define AVCMAGIC        "070702"        /* ascii string of above */
 146 #define VCPIO_PAD(x)    ((4 - ((x) & 3)) & 3)   /* pad to next 4 byte word */
 147 #define VCPIO_MASK      0xffffffff      /* mask for dev/ino fields */
 148 #endif /* _PAX_ */