xref: /freebsd/bin/pax/pax.c (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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 
38 #ifndef lint
39 static char const copyright[] =
40 "@(#) Copyright (c) 1992, 1993\n\
41 	The Regents of the University of California.  All rights reserved.\n";
42 #endif /* not lint */
43 
44 #ifndef lint
45 #if 0
46 static char sccsid[] = "@(#)pax.c	8.2 (Berkeley) 4/18/94";
47 #endif
48 static const char rcsid[] =
49   "$FreeBSD$";
50 #endif /* not lint */
51 
52 #include <sys/types.h>
53 #include <sys/stat.h>
54 #include <sys/time.h>
55 #include <sys/resource.h>
56 #include <errno.h>
57 #include <locale.h>
58 #include <signal.h>
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <unistd.h>
62 #include "pax.h"
63 #include "extern.h"
64 static int gen_init __P((void));
65 
66 /*
67  * PAX main routines, general globals and some simple start up routines
68  */
69 
70 /*
71  * Variables that can be accessed by any routine within pax
72  */
73 int	act = DEFOP;		/* read/write/append/copy */
74 FSUB	*frmt = NULL;		/* archive format type */
75 int	cflag;			/* match all EXCEPT pattern/file */
76 int	dflag;			/* directory member match only  */
77 int	iflag;			/* interactive file/archive rename */
78 int	kflag;			/* do not overwrite existing files */
79 int	lflag;			/* use hard links when possible */
80 int	nflag;			/* select first archive member match */
81 int	tflag;			/* restore access time after read */
82 int	uflag;			/* ignore older modification time files */
83 int	vflag;			/* produce verbose output */
84 int	Dflag;			/* same as uflag except inode change time */
85 int	Hflag;			/* follow command line symlinks (write only) */
86 int	Lflag;			/* follow symlinks when writing */
87 int	Xflag;			/* archive files with same device id only */
88 int	Yflag;			/* same as Dflg except after name mode */
89 int	Zflag;			/* same as uflg except after name mode */
90 int	vfpart;			/* is partial verbose output in progress */
91 int	patime = 1;		/* preserve file access time */
92 int	pmtime = 1;		/* preserve file modification times */
93 int	pmode;			/* preserve file mode bits */
94 int	pids;			/* preserve file uid/gid */
95 int	exit_val;		/* exit value */
96 int	docrc;			/* check/create file crc */
97 char	*dirptr;		/* destination dir in a copy */
98 char	*ltmfrmt;		/* -v locale time format (if any) */
99 char	*argv0;			/* root of argv[0] */
100 sigset_t s_mask;		/* signal mask for cleanup critical sect */
101 
102 /*
103  *	PAX - Portable Archive Interchange
104  *
105  * 	A utility to read, write, and write lists of the members of archive
106  *	files and copy directory hierarchies. A variety of archive formats
107  *	are supported (some are described in POSIX 1003.1 10.1):
108  *
109  *		ustar - 10.1.1 extended tar interchange format
110  *		cpio  - 10.1.2 extended cpio interchange format
111  *		tar - old BSD 4.3 tar format
112  *		binary cpio - old cpio with binary header format
113  *		sysVR4 cpio -  with and without CRC
114  *
115  * This version is a superset of IEEE Std 1003.2b-d3
116  *
117  * Summary of Extensions to the IEEE Standard:
118  *
119  * 1	READ ENHANCEMENTS
120  * 1.1	Operations which read archives will continue to operate even when
121  *	processing archives which may be damaged, truncated, or fail to meet
122  *	format specs in several different ways. Damaged sections of archives
123  *	are detected and avoided if possible. Attempts will be made to resync
124  *	archive read operations even with badly damaged media.
125  * 1.2	Blocksize requirements are not strictly enforced on archive read.
126  *	Tapes which have variable sized records can be read without errors.
127  * 1.3	The user can specify via the non-standard option flag -E if error
128  *	resync operation should stop on a media error, try a specified number
129  *	of times to correct, or try to correct forever.
130  * 1.4	Sparse files (lseek holes) stored on the archive (but stored with blocks
131  *	of all zeros will be restored with holes appropriate for the target
132  *	filesystem
133  * 1.5	The user is notified whenever something is found during archive
134  *	read operations which violates spec (but the read will continue).
135  * 1.6	Multiple archive volumes can be read and may span over different
136  *	archive devices
137  * 1.7	Rigidly restores all file attributes exactly as they are stored on the
138  *	archive.
139  * 1.8	Modification change time ranges can be specified via multiple -T
140  *	options. These allow a user to select files whose modification time
141  *	lies within a specific time range.
142  * 1.9	Files can be selected based on owner (user name or uid) via one or more
143  *	-U options.
144  * 1.10	Files can be selected based on group (group name or gid) via one o
145  *	more -G options.
146  * 1.11	File modification time can be checked against existing file after
147  *	name modification (-Z)
148  *
149  * 2	WRITE ENHANCEMENTS
150  * 2.1	Write operation will stop instead of allowing a user to create a flawed
151  *	flawed archive (due to any problem).
152  * 2.2	Archives written by pax are forced to strictly conform to both the
153  *	archive and pax the specific format specifications.
154  * 2.3	Blocking size and format is rigidly enforced on writes.
155  * 2.4	Formats which may exhibit header overflow problems (they have fields
156  *	too small for large file systems, such as inode number storage), use
157  *	routines designed to repair this problem. These techniques still
158  *	conform to both pax and format specifications, but no longer truncate
159  *	these fields. This removes any restrictions on using these archive
160  *	formats on large file systems.
161  * 2.5	Multiple archive volumes can be written and may span over different
162  *	archive devices
163  * 2.6	A archive volume record limit allows the user to specify the number
164  *	of bytes stored on an archive volume. When reached the user is
165  *	prompted for the next archive volume. This is specified with the
166  *	non-standard -B flag. The limit is rounded up to the next blocksize.
167  * 2.7	All archive padding during write use zero filled sections. This makes
168  *	it much easier to pull data out of flawed archive during read
169  *	operations.
170  * 2.8	Access time reset with the -t applies to all file nodes (including
171  *	directories).
172  * 2.9	Symbolic links can be followed with -L (optional in the spec).
173  * 2.10	Modification or inode change time ranges can be specified via
174  *	multiple -T options. These allow a user to select files whose
175  *	modification or inode change time lies within a specific time range.
176  * 2.11	Files can be selected based on owner (user name or uid) via one or more
177  *	-U options.
178  * 2.12	Files can be selected based on group (group name or gid) via one o
179  *	more -G options.
180  * 2.13	Symlinks which appear on the command line can be followed (without
181  *	following other symlinks; -H flag)
182  *
183  * 3	COPY ENHANCEMENTS
184  * 3.1	Sparse files (lseek holes) can be copied without expanding the holes
185  *	into zero filled blocks. The file copy is created with holes which are
186  *	appropriate for the target filesystem
187  * 3.2	Access time as well as modification time on copied file trees can be
188  *	preserved with the appropriate -p options.
189  * 3.3	Access time reset with the -t applies to all file nodes (including
190  *	directories).
191  * 3.4	Symbolic links can be followed with -L (optional in the spec).
192  * 3.5	Modification or inode change time ranges can be specified via
193  *	multiple -T options. These allow a user to select files whose
194  *	modification or inode change time lies within a specific time range.
195  * 3.6	Files can be selected based on owner (user name or uid) via one or more
196  *	-U options.
197  * 3.7	Files can be selected based on group (group name or gid) via one o
198  *	more -G options.
199  * 3.8	Symlinks which appear on the command line can be followed (without
200  *	following other symlinks; -H flag)
201  * 3.9  File inode change time can be checked against existing file before
202  *	name modification (-D)
203  * 3.10 File inode change time can be checked against existing file after
204  *	name modification (-Y)
205  * 3.11	File modification time can be checked against existing file after
206  *	name modification (-Z)
207  *
208  * 4	GENERAL ENHANCEMENTS
209  * 4.1	Internal structure is designed to isolate format dependent and
210  *	independent functions. Formats are selected via a format driver table.
211  *	This encourages the addition of new archive formats by only having to
212  *	write those routines which id, read and write the archive header.
213  */
214 
215 /*
216  * main()
217  *	parse options, set up and operate as specified by the user.
218  *	any operational flaw will set exit_val to non-zero
219  * Return: 0 if ok, 1 otherwise
220  */
221 
222 #if __STDC__
223 int
224 main(int argc, char **argv)
225 #else
226 int
227 main(argc, argv)
228 	int argc;
229 	char **argv;
230 #endif
231 {
232 	(void) setlocale(LC_ALL, "");
233 	/*
234 	 * parse options, determine operational mode, general init
235 	 */
236 	options(argc, argv);
237         if ((gen_init() < 0) || (tty_init() < 0))
238 		return(exit_val);
239 
240 	/*
241 	 * select a primary operation mode
242 	 */
243 	switch(act) {
244 	case EXTRACT:
245 		extract();
246 		break;
247 	case ARCHIVE:
248 		archive();
249 		break;
250 	case APPND:
251 		append();
252 		break;
253 	case COPY:
254 		copy();
255 		break;
256 	default:
257 	case LIST:
258 		list();
259 		break;
260 	}
261 	return(exit_val);
262 }
263 
264 /*
265  * sig_cleanup()
266  *	when interrupted we try to do whatever delayed processing we can.
267  *	This is not critical, but we really ought to limit our damage when we
268  *	are aborted by the user.
269  * Return:
270  *	never....
271  */
272 
273 #if __STDC__
274 void
275 sig_cleanup(int which_sig)
276 #else
277 void
278 sig_cleanup(which_sig)
279 	int which_sig;
280 #endif
281 {
282 	/*
283 	 * restore modes and times for any dirs we may have created
284 	 * or any dirs we may have read. Set vflag and vfpart so the user
285 	 * will clearly see the message on a line by itself.
286 	 */
287 	vflag = vfpart = 1;
288 	if (which_sig == SIGXCPU)
289 		pax_warn(0, "Cpu time limit reached, cleaning up.");
290 	else
291 		pax_warn(0, "Signal caught, cleaning up.");
292 
293 	ar_close();
294 	proc_dir();
295 	if (tflag)
296 		atdir_end();
297 	exit(1);
298 }
299 
300 /*
301  * gen_init()
302  *	general setup routines. Not all are required, but they really help
303  *	when dealing with a medium to large sized archives.
304  */
305 
306 #if __STDC__
307 static int
308 gen_init(void)
309 #else
310 static int
311 gen_init()
312 #endif
313 {
314 	struct rlimit reslimit;
315 	struct sigaction n_hand;
316 	struct sigaction o_hand;
317 
318 	/*
319 	 * Really needed to handle large archives. We can run out of memory for
320 	 * internal tables really fast when we have a whole lot of files...
321 	 */
322 	if (getrlimit(RLIMIT_DATA , &reslimit) == 0){
323 		reslimit.rlim_cur = reslimit.rlim_max;
324 		(void)setrlimit(RLIMIT_DATA , &reslimit);
325 	}
326 
327 	/*
328 	 * should file size limits be waived? if the os limits us, this is
329 	 * needed if we want to write a large archive
330 	 */
331 	if (getrlimit(RLIMIT_FSIZE , &reslimit) == 0){
332 		reslimit.rlim_cur = reslimit.rlim_max;
333 		(void)setrlimit(RLIMIT_FSIZE , &reslimit);
334 	}
335 
336 	/*
337 	 * increase the size the stack can grow to
338 	 */
339 	if (getrlimit(RLIMIT_STACK , &reslimit) == 0){
340 		reslimit.rlim_cur = reslimit.rlim_max;
341 		(void)setrlimit(RLIMIT_STACK , &reslimit);
342 	}
343 
344 	/*
345 	 * not really needed, but doesn't hurt
346 	 */
347 	if (getrlimit(RLIMIT_RSS , &reslimit) == 0){
348 		reslimit.rlim_cur = reslimit.rlim_max;
349 		(void)setrlimit(RLIMIT_RSS , &reslimit);
350 	}
351 
352 	/*
353 	 * Handle posix locale
354 	 *
355 	 * set user defines time printing format for -v option
356 	 */
357 	ltmfrmt = getenv("LC_TIME");
358 
359 	/*
360 	 * signal handling to reset stored directory times and modes. Since
361 	 * we deal with broken pipes via failed writes we ignore it. We also
362 	 * deal with any file size limit thorugh failed writes. Cpu time
363 	 * limits are caught and a cleanup is forced.
364 	 */
365 	if ((sigemptyset(&s_mask) < 0) || (sigaddset(&s_mask, SIGTERM) < 0) ||
366 	    (sigaddset(&s_mask,SIGINT) < 0)||(sigaddset(&s_mask,SIGHUP) < 0) ||
367 	    (sigaddset(&s_mask,SIGPIPE) < 0)||(sigaddset(&s_mask,SIGQUIT)<0) ||
368 	    (sigaddset(&s_mask,SIGXCPU) < 0)||(sigaddset(&s_mask,SIGXFSZ)<0)) {
369 		pax_warn(1, "Unable to set up signal mask");
370 		return(-1);
371 	}
372 	n_hand.sa_mask = s_mask;
373 	n_hand.sa_flags = 0;
374 	n_hand.sa_handler = sig_cleanup;
375 
376 	if ((sigaction(SIGHUP, &n_hand, &o_hand) < 0) &&
377 	    (o_hand.sa_handler == SIG_IGN) &&
378 	    (sigaction(SIGHUP, &o_hand, &o_hand) < 0))
379 		goto out;
380 
381 	if ((sigaction(SIGTERM, &n_hand, &o_hand) < 0) &&
382 	    (o_hand.sa_handler == SIG_IGN) &&
383 	    (sigaction(SIGTERM, &o_hand, &o_hand) < 0))
384 		goto out;
385 
386 	if ((sigaction(SIGINT, &n_hand, &o_hand) < 0) &&
387 	    (o_hand.sa_handler == SIG_IGN) &&
388 	    (sigaction(SIGINT, &o_hand, &o_hand) < 0))
389 		goto out;
390 
391 	if ((sigaction(SIGQUIT, &n_hand, &o_hand) < 0) &&
392 	    (o_hand.sa_handler == SIG_IGN) &&
393 	    (sigaction(SIGQUIT, &o_hand, &o_hand) < 0))
394 		goto out;
395 
396 	if ((sigaction(SIGXCPU, &n_hand, &o_hand) < 0) &&
397 	    (o_hand.sa_handler == SIG_IGN) &&
398 	    (sigaction(SIGXCPU, &o_hand, &o_hand) < 0))
399 		goto out;
400 
401 	n_hand.sa_handler = SIG_IGN;
402 	if ((sigaction(SIGPIPE, &n_hand, &o_hand) < 0) ||
403 	    (sigaction(SIGXFSZ, &n_hand, &o_hand) < 0))
404 		goto out;
405 	return(0);
406 
407     out:
408 	sys_warn(1, errno, "Unable to set up signal handler");
409 	return(-1);
410 }
411