xref: /openbsd/bin/pax/buf_subs.c (revision e6c7c102)
1 /*	$OpenBSD: buf_subs.c,v 1.33 2024/04/23 13:34:50 jsg Exp $	*/
2 /*	$NetBSD: buf_subs.c,v 1.5 1995/03/21 09:07:08 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 
37 #include <sys/types.h>
38 #include <sys/stat.h>
39 #include <stdio.h>
40 #include <errno.h>
41 #include <unistd.h>
42 #include <stdlib.h>
43 #include <string.h>
44 #include "pax.h"
45 #include "extern.h"
46 
47 /*
48  * routines which implement archive and file buffering
49  */
50 
51 static int buf_fill(void);
52 static int buf_flush(int);
53 
54 #define MINFBSZ		512		/* default block size for hole detect */
55 #define MAXFLT		10		/* default media read error limit */
56 
57 /*
58  * Need to change bufmem to dynamic allocation when the upper
59  * limit on blocking size is removed (though that will violate pax spec)
60  * MAXBLK define and tests will also need to be updated.
61  */
62 static char bufmem[MAXBLK+BLKMULT];	/* i/o buffer + pushback id space */
63 static char *buf;			/* normal start of i/o buffer */
64 static char *bufend;			/* end or last char in i/o buffer */
65 static char *bufpt;			/* read/write point in i/o buffer */
66 int blksz = MAXBLK;			/* block input/output size in bytes */
67 int wrblksz;				/* user spec output size in bytes */
68 int maxflt = MAXFLT;			/* MAX consecutive media errors */
69 int rdblksz;				/* first read blksize (tapes only) */
70 off_t wrlimit;				/* # of bytes written per archive vol */
71 off_t wrcnt;				/* # of bytes written on current vol */
72 off_t rdcnt;				/* # of bytes read on current vol */
73 
74 /*
75  * wr_start()
76  *	set up the buffering system to operate in a write mode
77  * Return:
78  *	0 if ok, -1 if the user specified write block size violates pax spec
79  */
80 
81 int
wr_start(void)82 wr_start(void)
83 {
84 	buf = &(bufmem[BLKMULT]);
85 	/*
86 	 * Check to make sure the write block size meets pax specs. If the user
87 	 * does not specify a blocksize, we use the format default blocksize.
88 	 * We must be picky on writes, so we do not allow the user to create an
89 	 * archive that might be hard to read elsewhere. If all ok, we then
90 	 * open the first archive volume
91 	 */
92 	if (!wrblksz)
93 		wrblksz = frmt->bsz;
94 	if (wrblksz > MAXBLK) {
95 		paxwarn(1, "Write block size of %d too large, maximium is: %d",
96 			wrblksz, MAXBLK);
97 		return(-1);
98 	}
99 	if (wrblksz % BLKMULT) {
100 		paxwarn(1, "Write block size of %d is not a %d byte multiple",
101 		    wrblksz, BLKMULT);
102 		return(-1);
103 	}
104 	if (wrblksz > MAXBLK_POSIX) {
105 		paxwarn(0, "Write block size of %d larger than POSIX max %d, archive may not be portable",
106 			wrblksz, MAXBLK_POSIX);
107 		return(-1);
108 	}
109 
110 	/*
111 	 * we only allow wrblksz to be used with all archive operations
112 	 */
113 	blksz = rdblksz = wrblksz;
114 	if ((ar_open(arcname) < 0) && (ar_next() < 0))
115 		return(-1);
116 	wrcnt = 0;
117 	bufend = buf + wrblksz;
118 	bufpt = buf;
119 	return(0);
120 }
121 
122 /*
123  * rd_start()
124  *	set up buffering system to read an archive
125  * Return:
126  *	0 if ok, -1 otherwise
127  */
128 
129 int
rd_start(void)130 rd_start(void)
131 {
132 	/*
133 	 * leave space for the header pushback (see get_arc()). If we are
134 	 * going to append and user specified a write block size, check it
135 	 * right away
136 	 */
137 	buf = &(bufmem[BLKMULT]);
138 	if ((act == APPND) && wrblksz) {
139 		if (wrblksz > MAXBLK) {
140 			paxwarn(1,"Write block size %d too large, maximium is: %d",
141 				wrblksz, MAXBLK);
142 			return(-1);
143 		}
144 		if (wrblksz % BLKMULT) {
145 			paxwarn(1, "Write block size %d is not a %d byte multiple",
146 			wrblksz, BLKMULT);
147 			return(-1);
148 		}
149 	}
150 
151 	/*
152 	 * open the archive
153 	 */
154 	if ((ar_open(arcname) < 0) && (ar_next() < 0))
155 		return(-1);
156 	bufend = buf + rdblksz;
157 	bufpt = bufend;
158 	rdcnt = 0;
159 	return(0);
160 }
161 
162 /*
163  * cp_start()
164  *	set up buffer system for copying within the file system
165  */
166 
167 void
cp_start(void)168 cp_start(void)
169 {
170 	buf = &(bufmem[BLKMULT]);
171 	rdblksz = blksz = MAXBLK;
172 }
173 
174 /*
175  * appnd_start()
176  *	Set up the buffering system to append new members to an archive that
177  *	was just read. The last block(s) of an archive may contain a format
178  *	specific trailer. To append a new member, this trailer has to be
179  *	removed from the archive. The first byte of the trailer is replaced by
180  *	the start of the header of the first file added to the archive. The
181  *	format specific end read function tells us how many bytes to move
182  *	backwards in the archive to be positioned BEFORE the trailer. Two
183  *	different position have to be adjusted, the O.S. file offset (e.g. the
184  *	position of the tape head) and the write point within the data we have
185  *	stored in the read (soon to become write) buffer. We may have to move
186  *	back several records (the number depends on the size of the archive
187  *	record and the size of the format trailer) to read up the record where
188  *	the first byte of the trailer is recorded. Trailers may span (and
189  *	overlap) record boundaries.
190  *	We first calculate which record has the first byte of the trailer. We
191  *	move the OS file offset back to the start of this record and read it
192  *	up. We set the buffer write pointer to be at this byte (the byte where
193  *	the trailer starts). We then move the OS file pointer back to the
194  *	start of this record so a flush of this buffer will replace the record
195  *	in the archive.
196  *	A major problem is rewriting this last record. For archives stored
197  *	on disk files, this is trivial. However, many devices are really picky
198  *	about the conditions under which they will allow a write to occur.
199  *	Often devices restrict the conditions where writes can be made,
200  *	so it may not be feasible to append archives stored on all types of
201  *	devices.
202  * Return:
203  *	0 for success, -1 for failure
204  */
205 
206 int
appnd_start(off_t skcnt)207 appnd_start(off_t skcnt)
208 {
209 	int res;
210 	off_t cnt;
211 
212 	if (exit_val != 0) {
213 		paxwarn(0, "Cannot append to an archive that may have flaws.");
214 		return(-1);
215 	}
216 	/*
217 	 * if the user did not specify a write blocksize, inherit the size used
218 	 * in the last archive volume read. (If a is set we still use rdblksz
219 	 * until next volume, cannot shift sizes within a single volume).
220 	 */
221 	if (!wrblksz)
222 		wrblksz = blksz = rdblksz;
223 	else
224 		blksz = rdblksz;
225 
226 	/*
227 	 * make sure that this volume allows appends
228 	 */
229 	if (ar_app_ok() < 0)
230 		return(-1);
231 
232 	/*
233 	 * Calculate bytes to move back and move in front of record where we
234 	 * need to start writing from. Remember we have to add in any padding
235 	 * that might be in the buffer after the trailer in the last block. We
236 	 * travel skcnt + padding ROUNDED UP to blksize.
237 	 */
238 	skcnt += bufend - bufpt;
239 	if ((cnt = (skcnt/blksz) * blksz) < skcnt)
240 		cnt += blksz;
241 	if (ar_rev(cnt) < 0)
242 		goto out;
243 
244 	/*
245 	 * We may have gone too far if there is valid data in the block we are
246 	 * now in front of, read up the block and position the pointer after
247 	 * the valid data.
248 	 */
249 	if ((cnt -= skcnt) > 0) {
250 		/*
251 		 * watch out for stupid tape drives. ar_rev() will set rdblksz
252 		 * to be real physical blocksize so we must loop until we get
253 		 * the old rdblksz (now in blksz). If ar_rev() fouls up the
254 		 * determination of the physical block size, we will fail.
255 		 */
256 		bufpt = buf;
257 		bufend = buf + blksz;
258 		while (bufpt < bufend) {
259 			if ((res = ar_read(bufpt, rdblksz)) <= 0)
260 				goto out;
261 			bufpt += res;
262 		}
263 		if (ar_rev(bufpt - buf) < 0)
264 			goto out;
265 		bufpt = buf + cnt;
266 		bufend = buf + blksz;
267 	} else {
268 		/*
269 		 * buffer is empty
270 		 */
271 		bufend = buf + blksz;
272 		bufpt = buf;
273 	}
274 	rdblksz = blksz;
275 	rdcnt -= skcnt;
276 	wrcnt = 0;
277 
278 	/*
279 	 * At this point we are ready to write. If the device requires special
280 	 * handling to write at a point were previously recorded data resides,
281 	 * that is handled in ar_set_wr(). From now on we operate under normal
282 	 * ARCHIVE mode (write) conditions
283 	 */
284 	if (ar_set_wr() < 0)
285 		return(-1);
286 	act = ARCHIVE;
287 	return(0);
288 
289     out:
290 	paxwarn(1, "Unable to rewrite archive trailer, cannot append.");
291 	return(-1);
292 }
293 
294 /*
295  * rd_sync()
296  *	A read error occurred on this archive volume. Resync the buffer and
297  *	try to reset the device (if possible) so we can continue to read. Keep
298  *	trying to do this until we get a valid read, or we reach the limit on
299  *	consecutive read faults (at which point we give up). The user can
300  *	adjust the read error limit through a command line option.
301  * Returns:
302  *	0 on success, and -1 on failure
303  */
304 
305 int
rd_sync(void)306 rd_sync(void)
307 {
308 	int errcnt = 0;
309 	int res;
310 
311 	/*
312 	 * if the user says bail out on first fault, we are out of here...
313 	 */
314 	if (maxflt == 0)
315 		return(-1);
316 	if (act == APPND) {
317 		paxwarn(1, "Unable to append when there are archive read errors.");
318 		return(-1);
319 	}
320 
321 	/*
322 	 * poke at device and try to get past media error
323 	 */
324 	if (ar_rdsync() < 0) {
325 		if (ar_next() < 0)
326 			return(-1);
327 		else
328 			rdcnt = 0;
329 	}
330 
331 	for (;;) {
332 		if ((res = ar_read(buf, blksz)) > 0) {
333 			/*
334 			 * All right! got some data, fill that buffer
335 			 */
336 			bufpt = buf;
337 			bufend = buf + res;
338 			rdcnt += res;
339 			return(0);
340 		}
341 
342 		/*
343 		 * Oh well, yet another failed read...
344 		 * if error limit reached, ditch. o.w. poke device to move past
345 		 * bad media and try again. if media is badly damaged, we ask
346 		 * the poor (and upset user at this point) for the next archive
347 		 * volume. remember the goal on reads is to get the most we
348 		 * can extract out of the archive.
349 		 */
350 		if ((maxflt > 0) && (++errcnt > maxflt))
351 			paxwarn(0,"Archive read error limit (%d) reached",maxflt);
352 		else if (ar_rdsync() == 0)
353 			continue;
354 		if (ar_next() < 0)
355 			break;
356 		rdcnt = 0;
357 		errcnt = 0;
358 	}
359 	return(-1);
360 }
361 
362 /*
363  * pback()
364  *	push the data used during the archive id phase back into the I/O
365  *	buffer. This is required as we cannot be sure that the header does NOT
366  *	overlap a block boundary (as in the case we are trying to recover a
367  *	flawed archived). This was not designed to be used for any other
368  *	purpose. (What software engineering, HA!)
369  *	WARNING: do not even THINK of pback greater than BLKMULT, unless the
370  *	pback space is increased.
371  */
372 
373 void
pback(char * pt,int cnt)374 pback(char *pt, int cnt)
375 {
376 	bufpt -= cnt;
377 	memcpy(bufpt, pt, cnt);
378 }
379 
380 /*
381  * rd_skip()
382  *	skip forward in the archive during a archive read. Used to get quickly
383  *	past file data and padding for files the user did NOT select.
384  * Return:
385  *	0 if ok, -1 failure, and 1 when EOF on the archive volume was detected.
386  */
387 
388 int
rd_skip(off_t skcnt)389 rd_skip(off_t skcnt)
390 {
391 	off_t res;
392 	off_t cnt;
393 	off_t skipped = 0;
394 
395 	/*
396 	 * consume what data we have in the buffer. If we have to move forward
397 	 * whole records, we call the low level skip function to see if we can
398 	 * move within the archive without doing the expensive reads on data we
399 	 * do not want.
400 	 */
401 	if (skcnt == 0)
402 		return(0);
403 	res = MINIMUM((bufend - bufpt), skcnt);
404 	bufpt += res;
405 	skcnt -= res;
406 
407 	/*
408 	 * if skcnt is now 0, then no additional i/o is needed
409 	 */
410 	if (skcnt == 0)
411 		return(0);
412 
413 	/*
414 	 * We have to read more, calculate complete and partial record reads
415 	 * based on rdblksz. we skip over "cnt" complete records
416 	 */
417 	res = skcnt%rdblksz;
418 	cnt = (skcnt/rdblksz) * rdblksz;
419 
420 	/*
421 	 * if the skip fails, we will have to resync. ar_fow will tell us
422 	 * how much it can skip over. We will have to read the rest.
423 	 */
424 	if (ar_fow(cnt, &skipped) < 0)
425 		return(-1);
426 	res += cnt - skipped;
427 	rdcnt += skipped;
428 
429 	/*
430 	 * what is left we have to read (which may be the whole thing if
431 	 * ar_fow() told us the device can only read to skip records);
432 	 */
433 	while (res > 0) {
434 		cnt = bufend - bufpt;
435 		/*
436 		 * if the read fails, we will have to resync
437 		 */
438 		if ((cnt <= 0) && ((cnt = buf_fill()) < 0))
439 			return(-1);
440 		if (cnt == 0)
441 			return(1);
442 		cnt = MINIMUM(cnt, res);
443 		bufpt += cnt;
444 		res -= cnt;
445 	}
446 	return(0);
447 }
448 
449 /*
450  * wr_fin()
451  *	flush out any data (and pad if required) the last block. We always pad
452  *	with zero (even though we do not have to). Padding with 0 makes it a
453  *	lot easier to recover if the archive is damaged. zero padding SHOULD
454  *	BE a requirement....
455  */
456 
457 void
wr_fin(void)458 wr_fin(void)
459 {
460 	if (bufpt > buf) {
461 		memset(bufpt, 0, bufend - bufpt);
462 		bufpt = bufend;
463 		(void)buf_flush(blksz);
464 	}
465 }
466 
467 /*
468  * wr_rdbuf()
469  *	fill the write buffer from data passed to it in a buffer (usually used
470  *	by format specific write routines to pass a file header). On failure we
471  *	punt. We do not allow the user to continue to write flawed archives.
472  *	We assume these headers are not very large (the memory copy we use is
473  *	a bit expensive).
474  * Return:
475  *	0 if buffer was filled ok, -1 o.w. (buffer flush failure)
476  */
477 
478 int
wr_rdbuf(char * out,int outcnt)479 wr_rdbuf(char *out, int outcnt)
480 {
481 	int cnt;
482 
483 	/*
484 	 * while there is data to copy copy into the write buffer. when the
485 	 * write buffer fills, flush it to the archive and continue
486 	 */
487 	while (outcnt > 0) {
488 		cnt = bufend - bufpt;
489 		if ((cnt <= 0) && ((cnt = buf_flush(blksz)) < 0))
490 			return(-1);
491 		/*
492 		 * only move what we have space for
493 		 */
494 		cnt = MINIMUM(cnt, outcnt);
495 		memcpy(bufpt, out, cnt);
496 		bufpt += cnt;
497 		out += cnt;
498 		outcnt -= cnt;
499 	}
500 	return(0);
501 }
502 
503 /*
504  * rd_wrbuf()
505  *	copy from the read buffer into a supplied buffer a specified number of
506  *	bytes. If the read buffer is empty fill it and continue to copy.
507  *	usually used to obtain a file header for processing by a format
508  *	specific read routine.
509  * Return
510  *	number of bytes copied to the buffer, 0 indicates EOF on archive volume,
511  *	-1 is a read error
512  */
513 
514 int
rd_wrbuf(char * in,int cpcnt)515 rd_wrbuf(char *in, int cpcnt)
516 {
517 	int res;
518 	int cnt;
519 	int incnt = cpcnt;
520 
521 	/*
522 	 * loop until we fill the buffer with the requested number of bytes
523 	 */
524 	while (incnt > 0) {
525 		cnt = bufend - bufpt;
526 		if ((cnt <= 0) && ((cnt = buf_fill()) <= 0)) {
527 			/*
528 			 * read error, return what we got (or the error if
529 			 * no data was copied). The caller must know that an
530 			 * error occurred and has the best knowledge what to
531 			 * do with it
532 			 */
533 			if ((res = cpcnt - incnt) > 0)
534 				return(res);
535 			return(cnt);
536 		}
537 
538 		/*
539 		 * calculate how much data to copy based on whats left and
540 		 * state of buffer
541 		 */
542 		cnt = MINIMUM(cnt, incnt);
543 		memcpy(in, bufpt, cnt);
544 		bufpt += cnt;
545 		incnt -= cnt;
546 		in += cnt;
547 	}
548 	return(cpcnt);
549 }
550 
551 /*
552  * wr_skip()
553  *	skip forward during a write. In other words add padding to the file.
554  *	we add zero filled padding as it makes flawed archives much easier to
555  *	recover from. the caller tells us how many bytes of padding to add
556  *	This routine was not designed to add HUGE amount of padding, just small
557  *	amounts (a few 512 byte blocks at most)
558  * Return:
559  *	0 if ok, -1 if there was a buf_flush failure
560  */
561 
562 int
wr_skip(off_t skcnt)563 wr_skip(off_t skcnt)
564 {
565 	int cnt;
566 
567 	/*
568 	 * loop while there is more padding to add
569 	 */
570 	while (skcnt > 0) {
571 		cnt = bufend - bufpt;
572 		if ((cnt <= 0) && ((cnt = buf_flush(blksz)) < 0))
573 			return(-1);
574 		cnt = MINIMUM(cnt, skcnt);
575 		memset(bufpt, 0, cnt);
576 		bufpt += cnt;
577 		skcnt -= cnt;
578 	}
579 	return(0);
580 }
581 
582 /*
583  * wr_rdfile()
584  *	fill write buffer with the contents of a file. We are passed an	open
585  *	file descriptor to the file an the archive structure that describes the
586  *	file we are storing. The variable "left" is modified to contain the
587  *	number of bytes of the file we were NOT able to write to the archive.
588  *	it is important that we always write EXACTLY the number of bytes that
589  *	the format specific write routine told us to. The file can also get
590  *	bigger, so reading to the end of file would create an improper archive,
591  *	we just detect this case and warn the user. We never create a bad
592  *	archive if we can avoid it. Of course trying to archive files that are
593  *	active is asking for trouble. It we fail, we pass back how much we
594  *	could NOT copy and let the caller deal with it.
595  * Return:
596  *	0 ok, -1 if archive write failure. a short read of the file returns a
597  *	0, but "left" is set to be greater than zero.
598  */
599 
600 int
wr_rdfile(ARCHD * arcn,int ifd,off_t * left)601 wr_rdfile(ARCHD *arcn, int ifd, off_t *left)
602 {
603 	int cnt;
604 	int res = 0;
605 	off_t size = arcn->sb.st_size;
606 	struct stat sb;
607 
608 	/*
609 	 * while there are more bytes to write
610 	 */
611 	while (size > 0) {
612 		cnt = bufend - bufpt;
613 		if ((cnt <= 0) && ((cnt = buf_flush(blksz)) < 0)) {
614 			*left = size;
615 			return(-1);
616 		}
617 		cnt = MINIMUM(cnt, size);
618 		if ((res = read(ifd, bufpt, cnt)) <= 0)
619 			break;
620 		size -= res;
621 		bufpt += res;
622 	}
623 
624 	/*
625 	 * better check the file did not change during this operation
626 	 * or the file read failed.
627 	 */
628 	if (res < 0)
629 		syswarn(1, errno, "Read fault on %s", arcn->org_name);
630 	else if (size != 0)
631 		paxwarn(1, "File changed size during read %s", arcn->org_name);
632 	else if (fstat(ifd, &sb) == -1)
633 		syswarn(1, errno, "Failed stat on %s", arcn->org_name);
634 	else if (timespeccmp(&arcn->sb.st_mtim, &sb.st_mtim, !=))
635 		paxwarn(1, "File %s was modified during copy to archive",
636 			arcn->org_name);
637 	*left = size;
638 	return(0);
639 }
640 
641 /*
642  * rd_wrfile()
643  *	extract the contents of a file from the archive. If we are unable to
644  *	extract the entire file (due to failure to write the file) we return
645  *	the numbers of bytes we did NOT process. This way the caller knows how
646  *	many bytes to skip past to find the next archive header. If the failure
647  *	was due to an archive read, we will catch that when we try to skip. If
648  *	the format supplies a file data crc value, we calculate the actual crc
649  *	so that it can be compared to the value stored in the header
650  * NOTE:
651  *	We call a special function to write the file. This function attempts to
652  *	restore file holes (blocks of zeros) into the file. When files are
653  *	sparse this saves space, and is a LOT faster. For non sparse files
654  *	the performance hit is small. As of this writing, no archive supports
655  *	information on where the file holes are.
656  * Return:
657  *	0 ok, -1 if archive read failure. if we cannot write the entire file,
658  *	we return a 0 but "left" is set to be the amount unwritten
659  */
660 
661 int
rd_wrfile(ARCHD * arcn,int ofd,off_t * left)662 rd_wrfile(ARCHD *arcn, int ofd, off_t *left)
663 {
664 	int cnt = 0;
665 	off_t size = arcn->sb.st_size;
666 	int res = 0;
667 	char *fnm = arcn->name;
668 	int isem = 1;
669 	int rem;
670 	int sz = MINFBSZ;
671 	struct stat sb;
672 	u_int32_t crc = 0;
673 
674 	/*
675 	 * pass the blocksize of the file being written to the write routine,
676 	 * if the size is zero, use the default MINFBSZ
677 	 */
678 	if (ofd < 0)
679 		sz = PAXPATHLEN + 1;		/* GNU tar long link/file */
680 	else if (fstat(ofd, &sb) == 0) {
681 		if (sb.st_blksize > 0)
682 			sz = (int)sb.st_blksize;
683 	} else
684 		syswarn(0,errno,"Unable to obtain block size for file %s",fnm);
685 	rem = sz;
686 	*left = 0;
687 
688 	/*
689 	 * Copy the archive to the file the number of bytes specified. We have
690 	 * to assume that we want to recover file holes as none of the archive
691 	 * formats can record the location of file holes.
692 	 */
693 	while (size > 0) {
694 		cnt = bufend - bufpt;
695 		/*
696 		 * if we get a read error, we do not want to skip, as we may
697 		 * miss a header, so we do not set left, but if we get a write
698 		 * error, we do want to skip over the unprocessed data.
699 		 */
700 		if ((cnt <= 0) && ((cnt = buf_fill()) <= 0))
701 			break;
702 		cnt = MINIMUM(cnt, size);
703 		if ((res = file_write(ofd,bufpt,cnt,&rem,&isem,sz,fnm)) <= 0) {
704 			*left = size;
705 			break;
706 		}
707 
708 		if (docrc) {
709 			/*
710 			 * update the actual crc value
711 			 */
712 			cnt = res;
713 			while (--cnt >= 0)
714 				crc += *bufpt++ & 0xff;
715 		} else
716 			bufpt += res;
717 		size -= res;
718 	}
719 
720 	/*
721 	 * if the last block has a file hole (all zero), we must make sure this
722 	 * gets updated in the file. We force the last block of zeros to be
723 	 * written. just closing with the file offset moved forward may not put
724 	 * a hole at the end of the file.
725 	 */
726 	if (isem && (arcn->sb.st_size > 0))
727 		file_flush(ofd, fnm, isem);
728 
729 	/*
730 	 * if we failed from archive read, we do not want to skip
731 	 */
732 	if ((size > 0) && (*left == 0))
733 		return(-1);
734 
735 	/*
736 	 * some formats record a crc on file data. If so, then we compare the
737 	 * calculated crc to the crc stored in the archive
738 	 */
739 	if (docrc && (size == 0) && (arcn->crc != crc))
740 		paxwarn(1,"Actual crc does not match expected crc %s",arcn->name);
741 	return(0);
742 }
743 
744 /*
745  * cp_file()
746  *	copy the contents of one file to another. used during -rw phase of pax
747  *	just as in rd_wrfile() we use a special write function to write the
748  *	destination file so we can properly copy files with holes.
749  */
750 
751 void
cp_file(ARCHD * arcn,int fd1,int fd2)752 cp_file(ARCHD *arcn, int fd1, int fd2)
753 {
754 	int cnt;
755 	off_t cpcnt = 0;
756 	int res = 0;
757 	char *fnm = arcn->name;
758 	int no_hole = 0;
759 	int isem = 1;
760 	int rem;
761 	int sz = MINFBSZ;
762 	struct stat sb;
763 
764 	/*
765 	 * check for holes in the source file. If none, we will use regular
766 	 * write instead of file write.
767 	 */
768 	if (((off_t)(arcn->sb.st_blocks * BLKMULT)) >= arcn->sb.st_size)
769 		++no_hole;
770 
771 	/*
772 	 * pass the blocksize of the file being written to the write routine,
773 	 * if the size is zero, use the default MINFBSZ
774 	 */
775 	if (fstat(fd2, &sb) == 0) {
776 		if (sb.st_blksize > 0)
777 			sz = sb.st_blksize;
778 	} else
779 		syswarn(0,errno,"Unable to obtain block size for file %s",fnm);
780 	rem = sz;
781 
782 	/*
783 	 * read the source file and copy to destination file until EOF
784 	 */
785 	for (;;) {
786 		if ((cnt = read(fd1, buf, blksz)) <= 0)
787 			break;
788 		if (no_hole)
789 			res = write(fd2, buf, cnt);
790 		else
791 			res = file_write(fd2, buf, cnt, &rem, &isem, sz, fnm);
792 		if (res != cnt)
793 			break;
794 		cpcnt += cnt;
795 	}
796 
797 	/*
798 	 * check to make sure the copy is valid.
799 	 */
800 	if (res < 0)
801 		syswarn(1, errno, "Failed write during copy of %s to %s",
802 			arcn->org_name, arcn->name);
803 	else if (cpcnt != arcn->sb.st_size)
804 		paxwarn(1, "File %s changed size during copy to %s",
805 			arcn->org_name, arcn->name);
806 	else if (fstat(fd1, &sb) == -1)
807 		syswarn(1, errno, "Failed stat of %s", arcn->org_name);
808 	else if (timespeccmp(&arcn->sb.st_mtim, &sb.st_mtim, !=))
809 		paxwarn(1, "File %s was modified during copy to %s",
810 			arcn->org_name, arcn->name);
811 
812 	/*
813 	 * if the last block has a file hole (all zero), we must make sure this
814 	 * gets updated in the file. We force the last block of zeros to be
815 	 * written. just closing with the file offset moved forward may not put
816 	 * a hole at the end of the file.
817 	 */
818 	if (!no_hole && isem && (arcn->sb.st_size > 0))
819 		file_flush(fd2, fnm, isem);
820 }
821 
822 /*
823  * buf_fill()
824  *	fill the read buffer with the next record (or what we can get) from
825  *	the archive volume.
826  * Return:
827  *	Number of bytes of data in the read buffer, -1 for read error, and
828  *	0 when finished (user specified termination in ar_next()).
829  */
830 
831 static int
buf_fill(void)832 buf_fill(void)
833 {
834 	int cnt;
835 	static int fini = 0;
836 
837 	if (fini)
838 		return(0);
839 
840 	for (;;) {
841 		/*
842 		 * try to fill the buffer. on error the next archive volume is
843 		 * opened and we try again.
844 		 */
845 		if ((cnt = ar_read(buf, blksz)) > 0) {
846 			bufpt = buf;
847 			bufend = buf + cnt;
848 			rdcnt += cnt;
849 			return(cnt);
850 		}
851 
852 		/*
853 		 * errors require resync, EOF goes to next archive
854 		 * but in case we have not determined yet the format,
855 		 * this means that we have a very short file, so we
856 		 * are done again.
857 		 */
858 		if (cnt < 0)
859 			break;
860 		if (frmt == NULL || ar_next() < 0) {
861 			fini = 1;
862 			return(0);
863 		}
864 		rdcnt = 0;
865 	}
866 	exit_val = 1;
867 	return(-1);
868 }
869 
870 /*
871  * buf_flush()
872  *	force the write buffer to the archive. We are passed the number of
873  *	bytes in the buffer at the point of the flush. When we change archives
874  *	the record size might change. (either larger or smaller).
875  * Return:
876  *	0 if all is ok, -1 when a write error occurs.
877  */
878 
879 static int
buf_flush(int bufcnt)880 buf_flush(int bufcnt)
881 {
882 	int cnt;
883 	int push = 0;
884 	int totcnt = 0;
885 
886 	/*
887 	 * if we have reached the user specified byte count for each archive
888 	 * volume, prompt for the next volume. (The non-standard -R flag).
889 	 * NOTE: If the wrlimit is smaller than wrcnt, we will always write
890 	 * at least one record. We always round limit UP to next blocksize.
891 	 */
892 	if ((wrlimit > 0) && (wrcnt > wrlimit)) {
893 		paxwarn(0, "User specified archive volume byte limit reached.");
894 		if (ar_next() < 0) {
895 			wrcnt = 0;
896 			exit_val = 1;
897 			return(-1);
898 		}
899 		wrcnt = 0;
900 
901 		/*
902 		 * The new archive volume might have changed the size of the
903 		 * write blocksize. if so we figure out if we need to write
904 		 * (one or more times), or if there is now free space left in
905 		 * the buffer (it is no longer full). bufcnt has the number of
906 		 * bytes in the buffer, (the blocksize, at the point we were
907 		 * CALLED). Push has the amount of "extra" data in the buffer
908 		 * if the block size has shrunk from a volume change.
909 		 */
910 		bufend = buf + blksz;
911 		if (blksz > bufcnt)
912 			return(0);
913 		if (blksz < bufcnt)
914 			push = bufcnt - blksz;
915 	}
916 
917 	/*
918 	 * We have enough data to write at least one archive block
919 	 */
920 	for (;;) {
921 		/*
922 		 * write a block and check if it all went out ok
923 		 */
924 		cnt = ar_write(buf, blksz);
925 		if (cnt == blksz) {
926 			/*
927 			 * the write went ok
928 			 */
929 			wrcnt += cnt;
930 			totcnt += cnt;
931 			if (push > 0) {
932 				/* we have extra data to push to the front.
933 				 * check for more than 1 block of push, and if
934 				 * so we loop back to write again
935 				 */
936 				memcpy(buf, bufend, push);
937 				bufpt = buf + push;
938 				if (push >= blksz) {
939 					push -= blksz;
940 					continue;
941 				}
942 			} else
943 				bufpt = buf;
944 			return(totcnt);
945 		} else if (cnt > 0) {
946 			/*
947 			 * Oh drat we got a partial write!
948 			 * if format does not care about alignment let it go,
949 			 * we warned the user in ar_write().... but this means
950 			 * the last record on this volume violates pax spec....
951 			 */
952 			totcnt += cnt;
953 			wrcnt += cnt;
954 			bufpt = buf + cnt;
955 			cnt = bufcnt - cnt;
956 			memcpy(buf, bufpt, cnt);
957 			bufpt = buf + cnt;
958 			if (!frmt->blkalgn || ((cnt % frmt->blkalgn) == 0))
959 				return(totcnt);
960 			break;
961 		}
962 
963 		/*
964 		 * All done, go to next archive
965 		 */
966 		wrcnt = 0;
967 		if (ar_next() < 0)
968 			break;
969 
970 		/*
971 		 * The new archive volume might also have changed the block
972 		 * size. if so, figure out if we have too much or too little
973 		 * data for using the new block size
974 		 */
975 		bufend = buf + blksz;
976 		if (blksz > bufcnt)
977 			return(0);
978 		if (blksz < bufcnt)
979 			push = bufcnt - blksz;
980 	}
981 
982 	/*
983 	 * write failed, stop pax. we must not create a bad archive!
984 	 */
985 	exit_val = 1;
986 	return(-1);
987 }
988