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