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