source: trunk/minix/commands/pax/pax.h@ 9

Last change on this file since 9 was 9, checked in by Mattia Monga, 13 years ago

Minix 3.1.2a

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