1/*-
2 * Copyright (c) 2003-2010 Tim Kientzle
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#include "archive_platform.h"
27__FBSDID("$FreeBSD: stable/11/contrib/libarchive/libarchive/archive_write.c 370535 2021-09-10 08:34:36Z git2svn $");
28
29/*
30 * This file contains the "essential" portions of the write API, that
31 * is, stuff that will essentially always be used by any client that
32 * actually needs to write an archive.  Optional pieces have been, as
33 * far as possible, separated out into separate files to reduce
34 * needlessly bloating statically-linked clients.
35 */
36
37#ifdef HAVE_SYS_WAIT_H
38#include <sys/wait.h>
39#endif
40#ifdef HAVE_ERRNO_H
41#include <errno.h>
42#endif
43#ifdef HAVE_LIMITS_H
44#include <limits.h>
45#endif
46#include <stdio.h>
47#ifdef HAVE_STDLIB_H
48#include <stdlib.h>
49#endif
50#ifdef HAVE_STRING_H
51#include <string.h>
52#endif
53#include <time.h>
54#ifdef HAVE_UNISTD_H
55#include <unistd.h>
56#endif
57
58#include "archive.h"
59#include "archive_entry.h"
60#include "archive_private.h"
61#include "archive_write_private.h"
62
63static struct archive_vtable *archive_write_vtable(void);
64
65static int	_archive_filter_code(struct archive *, int);
66static const char *_archive_filter_name(struct archive *, int);
67static int64_t	_archive_filter_bytes(struct archive *, int);
68static int  _archive_write_filter_count(struct archive *);
69static int	_archive_write_close(struct archive *);
70static int	_archive_write_free(struct archive *);
71static int	_archive_write_header(struct archive *, struct archive_entry *);
72static int	_archive_write_finish_entry(struct archive *);
73static ssize_t	_archive_write_data(struct archive *, const void *, size_t);
74
75struct archive_none {
76	size_t buffer_size;
77	size_t avail;
78	char *buffer;
79	char *next;
80};
81
82static struct archive_vtable *
83archive_write_vtable(void)
84{
85	static struct archive_vtable av;
86	static int inited = 0;
87
88	if (!inited) {
89		av.archive_close = _archive_write_close;
90		av.archive_filter_bytes = _archive_filter_bytes;
91		av.archive_filter_code = _archive_filter_code;
92		av.archive_filter_name = _archive_filter_name;
93		av.archive_filter_count = _archive_write_filter_count;
94		av.archive_free = _archive_write_free;
95		av.archive_write_header = _archive_write_header;
96		av.archive_write_finish_entry = _archive_write_finish_entry;
97		av.archive_write_data = _archive_write_data;
98		inited = 1;
99	}
100	return (&av);
101}
102
103/*
104 * Allocate, initialize and return an archive object.
105 */
106struct archive *
107archive_write_new(void)
108{
109	struct archive_write *a;
110	unsigned char *nulls;
111
112	a = (struct archive_write *)calloc(1, sizeof(*a));
113	if (a == NULL)
114		return (NULL);
115	a->archive.magic = ARCHIVE_WRITE_MAGIC;
116	a->archive.state = ARCHIVE_STATE_NEW;
117	a->archive.vtable = archive_write_vtable();
118	/*
119	 * The value 10240 here matches the traditional tar default,
120	 * but is otherwise arbitrary.
121	 * TODO: Set the default block size from the format selected.
122	 */
123	a->bytes_per_block = 10240;
124	a->bytes_in_last_block = -1;	/* Default */
125
126	/* Initialize a block of nulls for padding purposes. */
127	a->null_length = 1024;
128	nulls = (unsigned char *)calloc(1, a->null_length);
129	if (nulls == NULL) {
130		free(a);
131		return (NULL);
132	}
133	a->nulls = nulls;
134	return (&a->archive);
135}
136
137/*
138 * Set the block size.  Returns 0 if successful.
139 */
140int
141archive_write_set_bytes_per_block(struct archive *_a, int bytes_per_block)
142{
143	struct archive_write *a = (struct archive_write *)_a;
144	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
145	    ARCHIVE_STATE_NEW, "archive_write_set_bytes_per_block");
146	a->bytes_per_block = bytes_per_block;
147	return (ARCHIVE_OK);
148}
149
150/*
151 * Get the current block size.  -1 if it has never been set.
152 */
153int
154archive_write_get_bytes_per_block(struct archive *_a)
155{
156	struct archive_write *a = (struct archive_write *)_a;
157	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
158	    ARCHIVE_STATE_ANY, "archive_write_get_bytes_per_block");
159	return (a->bytes_per_block);
160}
161
162/*
163 * Set the size for the last block.
164 * Returns 0 if successful.
165 */
166int
167archive_write_set_bytes_in_last_block(struct archive *_a, int bytes)
168{
169	struct archive_write *a = (struct archive_write *)_a;
170	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
171	    ARCHIVE_STATE_ANY, "archive_write_set_bytes_in_last_block");
172	a->bytes_in_last_block = bytes;
173	return (ARCHIVE_OK);
174}
175
176/*
177 * Return the value set above.  -1 indicates it has not been set.
178 */
179int
180archive_write_get_bytes_in_last_block(struct archive *_a)
181{
182	struct archive_write *a = (struct archive_write *)_a;
183	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
184	    ARCHIVE_STATE_ANY, "archive_write_get_bytes_in_last_block");
185	return (a->bytes_in_last_block);
186}
187
188/*
189 * dev/ino of a file to be rejected.  Used to prevent adding
190 * an archive to itself recursively.
191 */
192int
193archive_write_set_skip_file(struct archive *_a, la_int64_t d, la_int64_t i)
194{
195	struct archive_write *a = (struct archive_write *)_a;
196	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
197	    ARCHIVE_STATE_ANY, "archive_write_set_skip_file");
198	a->skip_file_set = 1;
199	a->skip_file_dev = d;
200	a->skip_file_ino = i;
201	return (ARCHIVE_OK);
202}
203
204/*
205 * Allocate and return the next filter structure.
206 */
207struct archive_write_filter *
208__archive_write_allocate_filter(struct archive *_a)
209{
210	struct archive_write *a = (struct archive_write *)_a;
211	struct archive_write_filter *f;
212
213	f = calloc(1, sizeof(*f));
214	f->archive = _a;
215	f->state = ARCHIVE_WRITE_FILTER_STATE_NEW;
216	if (a->filter_first == NULL)
217		a->filter_first = f;
218	else
219		a->filter_last->next_filter = f;
220	a->filter_last = f;
221	return f;
222}
223
224/*
225 * Write data to a particular filter.
226 */
227int
228__archive_write_filter(struct archive_write_filter *f,
229    const void *buff, size_t length)
230{
231	int r;
232	/* Never write to non-open filters */
233	if (f->state != ARCHIVE_WRITE_FILTER_STATE_OPEN)
234		return(ARCHIVE_FATAL);
235	if (length == 0)
236		return(ARCHIVE_OK);
237	if (f->write == NULL)
238		/* If unset, a fatal error has already occurred, so this filter
239		 * didn't open. We cannot write anything. */
240		return(ARCHIVE_FATAL);
241	r = (f->write)(f, buff, length);
242	f->bytes_written += length;
243	return (r);
244}
245
246/*
247 * Recursive function for opening the filter chain
248 * Last filter is opened first
249 */
250static int
251__archive_write_open_filter(struct archive_write_filter *f)
252{
253	int ret;
254
255	ret = ARCHIVE_OK;
256	if (f->next_filter != NULL)
257		ret = __archive_write_open_filter(f->next_filter);
258	if (ret != ARCHIVE_OK)
259		return (ret);
260	if (f->state != ARCHIVE_WRITE_FILTER_STATE_NEW)
261		return (ARCHIVE_FATAL);
262	if (f->open == NULL) {
263		f->state = ARCHIVE_WRITE_FILTER_STATE_OPEN;
264		return (ARCHIVE_OK);
265	}
266	ret = (f->open)(f);
267	if (ret == ARCHIVE_OK)
268		f->state = ARCHIVE_WRITE_FILTER_STATE_OPEN;
269	else
270		f->state = ARCHIVE_WRITE_FILTER_STATE_FATAL;
271	return (ret);
272}
273
274/*
275 * Open all filters
276 */
277static int
278__archive_write_filters_open(struct archive_write *a)
279{
280	return (__archive_write_open_filter(a->filter_first));
281}
282
283/*
284 * Close all filtes
285 */
286static int
287__archive_write_filters_close(struct archive_write *a)
288{
289	struct archive_write_filter *f;
290	int ret, ret1;
291	ret = ARCHIVE_OK;
292	for (f = a->filter_first; f != NULL; f = f->next_filter) {
293		/* Do not close filters that are not open */
294		if (f->state == ARCHIVE_WRITE_FILTER_STATE_OPEN) {
295			if (f->close != NULL) {
296				ret1 = (f->close)(f);
297				if (ret1 < ret)
298					ret = ret1;
299				if (ret1 == ARCHIVE_OK) {
300					f->state =
301					    ARCHIVE_WRITE_FILTER_STATE_CLOSED;
302				} else {
303					f->state =
304					    ARCHIVE_WRITE_FILTER_STATE_FATAL;
305				}
306			} else
307				f->state = ARCHIVE_WRITE_FILTER_STATE_CLOSED;
308		}
309	}
310	return (ret);
311}
312
313int
314__archive_write_output(struct archive_write *a, const void *buff, size_t length)
315{
316	return (__archive_write_filter(a->filter_first, buff, length));
317}
318
319int
320__archive_write_nulls(struct archive_write *a, size_t length)
321{
322	if (length == 0)
323		return (ARCHIVE_OK);
324
325	while (length > 0) {
326		size_t to_write = length < a->null_length ? length : a->null_length;
327		int r = __archive_write_output(a, a->nulls, to_write);
328		if (r < ARCHIVE_OK)
329			return (r);
330		length -= to_write;
331	}
332	return (ARCHIVE_OK);
333}
334
335static int
336archive_write_client_open(struct archive_write_filter *f)
337{
338	struct archive_write *a = (struct archive_write *)f->archive;
339	struct archive_none *state;
340	void *buffer;
341	size_t buffer_size;
342	int ret;
343
344	f->bytes_per_block = archive_write_get_bytes_per_block(f->archive);
345	f->bytes_in_last_block =
346	    archive_write_get_bytes_in_last_block(f->archive);
347	buffer_size = f->bytes_per_block;
348
349	state = (struct archive_none *)calloc(1, sizeof(*state));
350	buffer = (char *)malloc(buffer_size);
351	if (state == NULL || buffer == NULL) {
352		free(state);
353		free(buffer);
354		archive_set_error(f->archive, ENOMEM,
355		    "Can't allocate data for output buffering");
356		return (ARCHIVE_FATAL);
357	}
358
359	state->buffer_size = buffer_size;
360	state->buffer = buffer;
361	state->next = state->buffer;
362	state->avail = state->buffer_size;
363	f->data = state;
364
365	if (a->client_opener == NULL)
366		return (ARCHIVE_OK);
367	ret = a->client_opener(f->archive, a->client_data);
368	if (ret != ARCHIVE_OK) {
369		free(state->buffer);
370		free(state);
371		f->data = NULL;
372	}
373	return (ret);
374}
375
376static int
377archive_write_client_write(struct archive_write_filter *f,
378    const void *_buff, size_t length)
379{
380	struct archive_write *a = (struct archive_write *)f->archive;
381        struct archive_none *state = (struct archive_none *)f->data;
382	const char *buff = (const char *)_buff;
383	ssize_t remaining, to_copy;
384	ssize_t bytes_written;
385
386	remaining = length;
387
388	/*
389	 * If there is no buffer for blocking, just pass the data
390	 * straight through to the client write callback.  In
391	 * particular, this supports "no write delay" operation for
392	 * special applications.  Just set the block size to zero.
393	 */
394	if (state->buffer_size == 0) {
395		while (remaining > 0) {
396			bytes_written = (a->client_writer)(&a->archive,
397			    a->client_data, buff, remaining);
398			if (bytes_written <= 0)
399				return (ARCHIVE_FATAL);
400			remaining -= bytes_written;
401			buff += bytes_written;
402		}
403		return (ARCHIVE_OK);
404	}
405
406	/* If the copy buffer isn't empty, try to fill it. */
407	if (state->avail < state->buffer_size) {
408		/* If buffer is not empty... */
409		/* ... copy data into buffer ... */
410		to_copy = ((size_t)remaining > state->avail) ?
411			state->avail : (size_t)remaining;
412		memcpy(state->next, buff, to_copy);
413		state->next += to_copy;
414		state->avail -= to_copy;
415		buff += to_copy;
416		remaining -= to_copy;
417		/* ... if it's full, write it out. */
418		if (state->avail == 0) {
419			char *p = state->buffer;
420			size_t to_write = state->buffer_size;
421			while (to_write > 0) {
422				bytes_written = (a->client_writer)(&a->archive,
423				    a->client_data, p, to_write);
424				if (bytes_written <= 0)
425					return (ARCHIVE_FATAL);
426				if ((size_t)bytes_written > to_write) {
427					archive_set_error(&(a->archive),
428					    -1, "write overrun");
429					return (ARCHIVE_FATAL);
430				}
431				p += bytes_written;
432				to_write -= bytes_written;
433			}
434			state->next = state->buffer;
435			state->avail = state->buffer_size;
436		}
437	}
438
439	while ((size_t)remaining >= state->buffer_size) {
440		/* Write out full blocks directly to client. */
441		bytes_written = (a->client_writer)(&a->archive,
442		    a->client_data, buff, state->buffer_size);
443		if (bytes_written <= 0)
444			return (ARCHIVE_FATAL);
445		buff += bytes_written;
446		remaining -= bytes_written;
447	}
448
449	if (remaining > 0) {
450		/* Copy last bit into copy buffer. */
451		memcpy(state->next, buff, remaining);
452		state->next += remaining;
453		state->avail -= remaining;
454	}
455	return (ARCHIVE_OK);
456}
457
458static int
459archive_write_client_free(struct archive_write_filter *f)
460{
461	struct archive_write *a = (struct archive_write *)f->archive;
462
463	if (a->client_freer)
464		(*a->client_freer)(&a->archive, a->client_data);
465	a->client_data = NULL;
466
467	/* Clear passphrase. */
468	if (a->passphrase != NULL) {
469		memset(a->passphrase, 0, strlen(a->passphrase));
470		free(a->passphrase);
471		a->passphrase = NULL;
472	}
473
474	return (ARCHIVE_OK);
475}
476
477static int
478archive_write_client_close(struct archive_write_filter *f)
479{
480	struct archive_write *a = (struct archive_write *)f->archive;
481	struct archive_none *state = (struct archive_none *)f->data;
482	ssize_t block_length;
483	ssize_t target_block_length;
484	ssize_t bytes_written;
485	size_t to_write;
486	char *p;
487	int ret = ARCHIVE_OK;
488
489	/* If there's pending data, pad and write the last block */
490	if (state->next != state->buffer) {
491		block_length = state->buffer_size - state->avail;
492
493		/* Tricky calculation to determine size of last block */
494		if (a->bytes_in_last_block <= 0)
495			/* Default or Zero: pad to full block */
496			target_block_length = a->bytes_per_block;
497		else
498			/* Round to next multiple of bytes_in_last_block. */
499			target_block_length = a->bytes_in_last_block *
500			    ( (block_length + a->bytes_in_last_block - 1) /
501			        a->bytes_in_last_block);
502		if (target_block_length > a->bytes_per_block)
503			target_block_length = a->bytes_per_block;
504		if (block_length < target_block_length) {
505			memset(state->next, 0,
506			    target_block_length - block_length);
507			block_length = target_block_length;
508		}
509		p = state->buffer;
510		to_write = block_length;
511		while (to_write > 0) {
512			bytes_written = (a->client_writer)(&a->archive,
513			    a->client_data, p, to_write);
514			if (bytes_written <= 0) {
515				ret = ARCHIVE_FATAL;
516				break;
517			}
518			if ((size_t)bytes_written > to_write) {
519				archive_set_error(&(a->archive),
520						  -1, "write overrun");
521				ret = ARCHIVE_FATAL;
522				break;
523			}
524			p += bytes_written;
525			to_write -= bytes_written;
526		}
527	}
528	if (a->client_closer)
529		(*a->client_closer)(&a->archive, a->client_data);
530	free(state->buffer);
531	free(state);
532
533	/* Clear the close handler myself not to be called again. */
534	f->state = ARCHIVE_WRITE_FILTER_STATE_CLOSED;
535	return (ret);
536}
537
538/*
539 * Open the archive using the current settings.
540 */
541int
542archive_write_open2(struct archive *_a, void *client_data,
543    archive_open_callback *opener, archive_write_callback *writer,
544    archive_close_callback *closer, archive_free_callback *freer)
545{
546	struct archive_write *a = (struct archive_write *)_a;
547	struct archive_write_filter *client_filter;
548	int ret, r1;
549
550	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
551	    ARCHIVE_STATE_NEW, "archive_write_open");
552	archive_clear_error(&a->archive);
553
554	a->client_writer = writer;
555	a->client_opener = opener;
556	a->client_closer = closer;
557	a->client_freer = freer;
558	a->client_data = client_data;
559
560	client_filter = __archive_write_allocate_filter(_a);
561	client_filter->open = archive_write_client_open;
562	client_filter->write = archive_write_client_write;
563	client_filter->close = archive_write_client_close;
564	client_filter->free = archive_write_client_free;
565
566	ret = __archive_write_filters_open(a);
567	if (ret < ARCHIVE_WARN) {
568		r1 = __archive_write_filters_close(a);
569		__archive_write_filters_free(_a);
570		return (r1 < ret ? r1 : ret);
571	}
572
573	a->archive.state = ARCHIVE_STATE_HEADER;
574	if (a->format_init)
575		ret = (a->format_init)(a);
576	return (ret);
577}
578
579int
580archive_write_open(struct archive *_a, void *client_data,
581    archive_open_callback *opener, archive_write_callback *writer,
582    archive_close_callback *closer)
583{
584	return archive_write_open2(_a, client_data, opener, writer,
585	    closer, NULL);
586}
587
588/*
589 * Close out the archive.
590 */
591static int
592_archive_write_close(struct archive *_a)
593{
594	struct archive_write *a = (struct archive_write *)_a;
595	int r = ARCHIVE_OK, r1 = ARCHIVE_OK;
596
597	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
598	    ARCHIVE_STATE_ANY | ARCHIVE_STATE_FATAL,
599	    "archive_write_close");
600	if (a->archive.state == ARCHIVE_STATE_NEW
601	    || a->archive.state == ARCHIVE_STATE_CLOSED)
602		return (ARCHIVE_OK); /* Okay to close() when not open. */
603
604	archive_clear_error(&a->archive);
605
606	/* Finish the last entry if a finish callback is specified */
607	if (a->archive.state == ARCHIVE_STATE_DATA
608	    && a->format_finish_entry != NULL)
609		r = ((a->format_finish_entry)(a));
610
611	/* Finish off the archive. */
612	/* TODO: have format closers invoke compression close. */
613	if (a->format_close != NULL) {
614		r1 = (a->format_close)(a);
615		if (r1 < r)
616			r = r1;
617	}
618
619	/* Finish the compression and close the stream. */
620	r1 = __archive_write_filters_close(a);
621	if (r1 < r)
622		r = r1;
623
624	if (a->archive.state != ARCHIVE_STATE_FATAL)
625		a->archive.state = ARCHIVE_STATE_CLOSED;
626	return (r);
627}
628
629static int
630_archive_write_filter_count(struct archive *_a)
631{
632	struct archive_write *a = (struct archive_write *)_a;
633	struct archive_write_filter *p = a->filter_first;
634	int count = 0;
635	while(p) {
636		count++;
637		p = p->next_filter;
638	}
639	return count;
640}
641
642void
643__archive_write_filters_free(struct archive *_a)
644{
645	struct archive_write *a = (struct archive_write *)_a;
646	int r = ARCHIVE_OK, r1;
647
648	while (a->filter_first != NULL) {
649		struct archive_write_filter *next
650		    = a->filter_first->next_filter;
651		if (a->filter_first->free != NULL) {
652			r1 = (*a->filter_first->free)(a->filter_first);
653			if (r > r1)
654				r = r1;
655		}
656		free(a->filter_first);
657		a->filter_first = next;
658	}
659	a->filter_last = NULL;
660}
661
662/*
663 * Destroy the archive structure.
664 *
665 * Be careful: user might just call write_new and then write_free.
666 * Don't assume we actually wrote anything or performed any non-trivial
667 * initialization.
668 */
669static int
670_archive_write_free(struct archive *_a)
671{
672	struct archive_write *a = (struct archive_write *)_a;
673	int r = ARCHIVE_OK, r1;
674
675	if (_a == NULL)
676		return (ARCHIVE_OK);
677	/* It is okay to call free() in state FATAL. */
678	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
679	    ARCHIVE_STATE_ANY | ARCHIVE_STATE_FATAL, "archive_write_free");
680	if (a->archive.state != ARCHIVE_STATE_FATAL)
681		r = archive_write_close(&a->archive);
682
683	/* Release format resources. */
684	if (a->format_free != NULL) {
685		r1 = (a->format_free)(a);
686		if (r1 < r)
687			r = r1;
688	}
689
690	__archive_write_filters_free(_a);
691
692	/* Release various dynamic buffers. */
693	free((void *)(uintptr_t)(const void *)a->nulls);
694	archive_string_free(&a->archive.error_string);
695	if (a->passphrase != NULL) {
696		/* A passphrase should be cleaned. */
697		memset(a->passphrase, 0, strlen(a->passphrase));
698		free(a->passphrase);
699	}
700	a->archive.magic = 0;
701	__archive_clean(&a->archive);
702	free(a);
703	return (r);
704}
705
706/*
707 * Write the appropriate header.
708 */
709static int
710_archive_write_header(struct archive *_a, struct archive_entry *entry)
711{
712	struct archive_write *a = (struct archive_write *)_a;
713	int ret, r2;
714
715	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
716	    ARCHIVE_STATE_DATA | ARCHIVE_STATE_HEADER, "archive_write_header");
717	archive_clear_error(&a->archive);
718
719	if (a->format_write_header == NULL) {
720		archive_set_error(&(a->archive), -1,
721		    "Format must be set before you can write to an archive.");
722		a->archive.state = ARCHIVE_STATE_FATAL;
723		return (ARCHIVE_FATAL);
724	}
725
726	/* In particular, "retry" and "fatal" get returned immediately. */
727	ret = archive_write_finish_entry(&a->archive);
728	if (ret == ARCHIVE_FATAL) {
729		a->archive.state = ARCHIVE_STATE_FATAL;
730		return (ARCHIVE_FATAL);
731	}
732	if (ret < ARCHIVE_OK && ret != ARCHIVE_WARN)
733		return (ret);
734
735	if (a->skip_file_set &&
736	    archive_entry_dev_is_set(entry) &&
737	    archive_entry_ino_is_set(entry) &&
738	    archive_entry_dev(entry) == (dev_t)a->skip_file_dev &&
739	    archive_entry_ino64(entry) == a->skip_file_ino) {
740		archive_set_error(&a->archive, 0,
741		    "Can't add archive to itself");
742		return (ARCHIVE_FAILED);
743	}
744
745	/* Format and write header. */
746	r2 = ((a->format_write_header)(a, entry));
747	if (r2 == ARCHIVE_FAILED) {
748		return (ARCHIVE_FAILED);
749	}
750	if (r2 == ARCHIVE_FATAL) {
751		a->archive.state = ARCHIVE_STATE_FATAL;
752		return (ARCHIVE_FATAL);
753	}
754	if (r2 < ret)
755		ret = r2;
756
757	a->archive.state = ARCHIVE_STATE_DATA;
758	return (ret);
759}
760
761static int
762_archive_write_finish_entry(struct archive *_a)
763{
764	struct archive_write *a = (struct archive_write *)_a;
765	int ret = ARCHIVE_OK;
766
767	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
768	    ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
769	    "archive_write_finish_entry");
770	if (a->archive.state & ARCHIVE_STATE_DATA
771	    && a->format_finish_entry != NULL)
772		ret = (a->format_finish_entry)(a);
773	a->archive.state = ARCHIVE_STATE_HEADER;
774	return (ret);
775}
776
777/*
778 * Note that the compressor is responsible for blocking.
779 */
780static ssize_t
781_archive_write_data(struct archive *_a, const void *buff, size_t s)
782{
783	struct archive_write *a = (struct archive_write *)_a;
784	const size_t max_write = INT_MAX;
785
786	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
787	    ARCHIVE_STATE_DATA, "archive_write_data");
788	/* In particular, this catches attempts to pass negative values. */
789	if (s > max_write)
790		s = max_write;
791	archive_clear_error(&a->archive);
792	return ((a->format_write_data)(a, buff, s));
793}
794
795static struct archive_write_filter *
796filter_lookup(struct archive *_a, int n)
797{
798	struct archive_write *a = (struct archive_write *)_a;
799	struct archive_write_filter *f = a->filter_first;
800	if (n == -1)
801		return a->filter_last;
802	if (n < 0)
803		return NULL;
804	while (n > 0 && f != NULL) {
805		f = f->next_filter;
806		--n;
807	}
808	return f;
809}
810
811static int
812_archive_filter_code(struct archive *_a, int n)
813{
814	struct archive_write_filter *f = filter_lookup(_a, n);
815	return f == NULL ? -1 : f->code;
816}
817
818static const char *
819_archive_filter_name(struct archive *_a, int n)
820{
821	struct archive_write_filter *f = filter_lookup(_a, n);
822	return f != NULL ? f->name : NULL;
823}
824
825static int64_t
826_archive_filter_bytes(struct archive *_a, int n)
827{
828	struct archive_write_filter *f = filter_lookup(_a, n);
829	return f == NULL ? -1 : f->bytes_written;
830}
831