bin/pax/cpio.h

   1 /*      $OpenBSD: cpio.h,v 1.4 2003/06/02 23:32:08 millert Exp $        */
   2 /*      $NetBSD: cpio.h,v 1.3 1995/03/21 09:07:15 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  *      @(#)cpio.h      8.1 (Berkeley) 5/31/93
  37  */
  38
  39 /*
  40  * Defines common to all versions of cpio
  41  */
  42 #define TRAILER         "TRAILER!!!"    /* name in last archive record */
  43
  44 /*
  45  * Header encoding of the different file types
  46  */
  47 #define C_ISDIR          040000         /* Directory */
  48 #define C_ISFIFO         010000         /* FIFO */
  49 #define C_ISREG         0100000         /* Regular file */
  50 #define C_ISBLK          060000         /* Block special file */
  51 #define C_ISCHR          020000         /* Character special file */
  52 #define C_ISCTG         0110000         /* Reserved for contiguous files */
  53 #define C_ISLNK         0120000         /* Reserved for symbolic links */
  54 #define C_ISOCK         0140000         /* Reserved for sockets */
  55 #define C_IFMT          0170000         /* type of file */
  56
  57 /*
  58  * Data Interchange Format - Extended cpio header format - POSIX 1003.1-1990
  59  */
  60 typedef struct {
  61         char    c_magic[6];             /* magic cookie */
  62         char    c_dev[6];               /* device number */
  63         char    c_ino[6];               /* inode number */
  64         char    c_mode[6];              /* file type/access */
  65         char    c_uid[6];               /* owners uid */
  66         char    c_gid[6];               /* owners gid */
  67         char    c_nlink[6];             /* # of links at archive creation */
  68         char    c_rdev[6];              /* block/char major/minor # */
  69         char    c_mtime[11];            /* modification time */
  70         char    c_namesize[6];          /* length of pathname */
  71         char    c_filesize[11];         /* length of file in bytes */
  72 } HD_CPIO;
  73
  74 #define MAGIC           070707          /* transportable archive id */
  75
  76 #ifdef _PAX_
  77 #define AMAGIC          "070707"        /* ascii equivalent string of MAGIC */
  78 #define CPIO_MASK       0x3ffff         /* bits valid in the dev/ino fields */
  79                                         /* used for dev/inode remaps */
  80 #endif /* _PAX_ */
  81
  82 /*
  83  * Binary cpio header structure
  84  *
  85  * CAUTION! CAUTION! CAUTION!
  86  * Each field really represents a 16 bit short (NOT ASCII). Described as
  87  * an array of chars in an attempt to improve portability!!
  88  */
  89 typedef struct {
  90         u_char  h_magic[2];
  91         u_char  h_dev[2];
  92         u_char  h_ino[2];
  93         u_char  h_mode[2];
  94         u_char  h_uid[2];
  95         u_char  h_gid[2];
  96         u_char  h_nlink[2];
  97         u_char  h_rdev[2];
  98         u_char  h_mtime_1[2];
  99         u_char  h_mtime_2[2];
 100         u_char  h_namesize[2];
 101         u_char  h_filesize_1[2];
 102         u_char  h_filesize_2[2];
 103 } HD_BCPIO;
 104
 105 #ifdef _PAX_
 106 /*
 107  * extraction and creation macros for binary cpio
 108  */
 109 #define SHRT_EXT(ch)    ((((unsigned)(ch)[0])<<8) | (((unsigned)(ch)[1])&0xff))
 110 #define RSHRT_EXT(ch)   ((((unsigned)(ch)[1])<<8) | (((unsigned)(ch)[0])&0xff))
 111 #define CHR_WR_0(val)   ((char)(((val) >> 24) & 0xff))
 112 #define CHR_WR_1(val)   ((char)(((val) >> 16) & 0xff))
 113 #define CHR_WR_2(val)   ((char)(((val) >> 8) & 0xff))
 114 #define CHR_WR_3(val)   ((char)((val) & 0xff))
 115
 116 /*
 117  * binary cpio masks and pads
 118  */
 119 #define BCPIO_PAD(x)    ((2 - ((x) & 1)) & 1)   /* pad to next 2 byte word */
 120 #define BCPIO_MASK      0xffff                  /* mask for dev/ino fields */
 121 #endif /* _PAX_ */
 122
 123 /*
 124  * System VR4 cpio header structure (with/without file data crc)
 125  */
 126 typedef struct {
 127         char    c_magic[6];             /* magic cookie */
 128         char    c_ino[8];               /* inode number */
 129         char    c_mode[8];              /* file type/access */
 130         char    c_uid[8];               /* owners uid */
 131         char    c_gid[8];               /* owners gid */
 132         char    c_nlink[8];             /* # of links at archive creation */
 133         char    c_mtime[8];             /* modification time */
 134         char    c_filesize[8];          /* length of file in bytes */
 135         char    c_maj[8];               /* block/char major # */
 136         char    c_min[8];               /* block/char minor # */
 137         char    c_rmaj[8];              /* special file major # */
 138         char    c_rmin[8];              /* special file minor # */
 139         char    c_namesize[8];          /* length of pathname */
 140         char    c_chksum[8];            /* 0 OR CRC of bytes of FILE data */
 141 } HD_VCPIO;
 142
 143 #define VMAGIC          070701          /* sVr4 new portable archive id */
 144 #define VCMAGIC         070702          /* sVr4 new portable archive id CRC */
 145 #ifdef _PAX_
 146 #define AVMAGIC         "070701"        /* ascii string of above */
 147 #define AVCMAGIC        "070702"        /* ascii string of above */
 148 #define VCPIO_PAD(x)    ((4 - ((x) & 3)) & 3)   /* pad to next 4 byte word */
 149 #define VCPIO_MASK      0xffffffff      /* mask for dev/ino fields */
 150 #endif /* _PAX_ */