2 * Copyright (c) 2003-2010 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
26 #include "archive_platform.h"
27 __FBSDID("$FreeBSD$");
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.
37 #ifdef HAVE_SYS_WAIT_H
59 #include "archive_entry.h"
60 #include "archive_private.h"
61 #include "archive_write_private.h"
63 static struct archive_vtable *archive_write_vtable(void);
65 static int _archive_filter_code(struct archive *, int);
66 static const char *_archive_filter_name(struct archive *, int);
67 static int64_t _archive_filter_bytes(struct archive *, int);
68 static int _archive_write_filter_count(struct archive *);
69 static int _archive_write_close(struct archive *);
70 static int _archive_write_free(struct archive *);
71 static int _archive_write_header(struct archive *, struct archive_entry *);
72 static int _archive_write_finish_entry(struct archive *);
73 static ssize_t _archive_write_data(struct archive *, const void *, size_t);
82 static struct archive_vtable *
83 archive_write_vtable(void)
85 static struct archive_vtable av;
86 static int inited = 0;
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;
104 * Allocate, initialize and return an archive object.
107 archive_write_new(void)
109 struct archive_write *a;
110 unsigned char *nulls;
112 a = (struct archive_write *)calloc(1, sizeof(*a));
115 a->archive.magic = ARCHIVE_WRITE_MAGIC;
116 a->archive.state = ARCHIVE_STATE_NEW;
117 a->archive.vtable = archive_write_vtable();
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.
123 a->bytes_per_block = 10240;
124 a->bytes_in_last_block = -1; /* Default */
126 /* Initialize a block of nulls for padding purposes. */
127 a->null_length = 1024;
128 nulls = (unsigned char *)calloc(1, a->null_length);
134 return (&a->archive);
138 * Set the block size. Returns 0 if successful.
141 archive_write_set_bytes_per_block(struct archive *_a, int bytes_per_block)
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;
151 * Get the current block size. -1 if it has never been set.
154 archive_write_get_bytes_per_block(struct archive *_a)
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);
163 * Set the size for the last block.
164 * Returns 0 if successful.
167 archive_write_set_bytes_in_last_block(struct archive *_a, int bytes)
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;
177 * Return the value set above. -1 indicates it has not been set.
180 archive_write_get_bytes_in_last_block(struct archive *_a)
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);
189 * dev/ino of a file to be rejected. Used to prevent adding
190 * an archive to itself recursively.
193 archive_write_set_skip_file(struct archive *_a, la_int64_t d, la_int64_t i)
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;
205 * Allocate and return the next filter structure.
207 struct archive_write_filter *
208 __archive_write_allocate_filter(struct archive *_a)
210 struct archive_write *a = (struct archive_write *)_a;
211 struct archive_write_filter *f;
213 f = calloc(1, sizeof(*f));
215 if (a->filter_first == NULL)
218 a->filter_last->next_filter = f;
224 * Write data to a particular filter.
227 __archive_write_filter(struct archive_write_filter *f,
228 const void *buff, size_t length)
233 if (f->write == NULL)
234 /* If unset, a fatal error has already occurred, so this filter
235 * didn't open. We cannot write anything. */
236 return(ARCHIVE_FATAL);
237 r = (f->write)(f, buff, length);
238 f->bytes_written += length;
246 __archive_write_open_filter(struct archive_write_filter *f)
257 __archive_write_close_filter(struct archive_write_filter *f)
259 if (f->close != NULL)
260 return (f->close)(f);
261 if (f->next_filter != NULL)
262 return (__archive_write_close_filter(f->next_filter));
267 __archive_write_output(struct archive_write *a, const void *buff, size_t length)
269 return (__archive_write_filter(a->filter_first, buff, length));
273 __archive_write_nulls(struct archive_write *a, size_t length)
279 size_t to_write = length < a->null_length ? length : a->null_length;
280 int r = __archive_write_output(a, a->nulls, to_write);
289 archive_write_client_open(struct archive_write_filter *f)
291 struct archive_write *a = (struct archive_write *)f->archive;
292 struct archive_none *state;
296 f->bytes_per_block = archive_write_get_bytes_per_block(f->archive);
297 f->bytes_in_last_block =
298 archive_write_get_bytes_in_last_block(f->archive);
299 buffer_size = f->bytes_per_block;
301 state = (struct archive_none *)calloc(1, sizeof(*state));
302 buffer = (char *)malloc(buffer_size);
303 if (state == NULL || buffer == NULL) {
306 archive_set_error(f->archive, ENOMEM,
307 "Can't allocate data for output buffering");
308 return (ARCHIVE_FATAL);
311 state->buffer_size = buffer_size;
312 state->buffer = buffer;
313 state->next = state->buffer;
314 state->avail = state->buffer_size;
317 if (a->client_opener == NULL)
319 return (a->client_opener(f->archive, a->client_data));
323 archive_write_client_write(struct archive_write_filter *f,
324 const void *_buff, size_t length)
326 struct archive_write *a = (struct archive_write *)f->archive;
327 struct archive_none *state = (struct archive_none *)f->data;
328 const char *buff = (const char *)_buff;
329 ssize_t remaining, to_copy;
330 ssize_t bytes_written;
335 * If there is no buffer for blocking, just pass the data
336 * straight through to the client write callback. In
337 * particular, this supports "no write delay" operation for
338 * special applications. Just set the block size to zero.
340 if (state->buffer_size == 0) {
341 while (remaining > 0) {
342 bytes_written = (a->client_writer)(&a->archive,
343 a->client_data, buff, remaining);
344 if (bytes_written <= 0)
345 return (ARCHIVE_FATAL);
346 remaining -= bytes_written;
347 buff += bytes_written;
352 /* If the copy buffer isn't empty, try to fill it. */
353 if (state->avail < state->buffer_size) {
354 /* If buffer is not empty... */
355 /* ... copy data into buffer ... */
356 to_copy = ((size_t)remaining > state->avail) ?
357 state->avail : (size_t)remaining;
358 memcpy(state->next, buff, to_copy);
359 state->next += to_copy;
360 state->avail -= to_copy;
362 remaining -= to_copy;
363 /* ... if it's full, write it out. */
364 if (state->avail == 0) {
365 char *p = state->buffer;
366 size_t to_write = state->buffer_size;
367 while (to_write > 0) {
368 bytes_written = (a->client_writer)(&a->archive,
369 a->client_data, p, to_write);
370 if (bytes_written <= 0)
371 return (ARCHIVE_FATAL);
372 if ((size_t)bytes_written > to_write) {
373 archive_set_error(&(a->archive),
374 -1, "write overrun");
375 return (ARCHIVE_FATAL);
378 to_write -= bytes_written;
380 state->next = state->buffer;
381 state->avail = state->buffer_size;
385 while ((size_t)remaining >= state->buffer_size) {
386 /* Write out full blocks directly to client. */
387 bytes_written = (a->client_writer)(&a->archive,
388 a->client_data, buff, state->buffer_size);
389 if (bytes_written <= 0)
390 return (ARCHIVE_FATAL);
391 buff += bytes_written;
392 remaining -= bytes_written;
396 /* Copy last bit into copy buffer. */
397 memcpy(state->next, buff, remaining);
398 state->next += remaining;
399 state->avail -= remaining;
405 archive_write_client_close(struct archive_write_filter *f)
407 struct archive_write *a = (struct archive_write *)f->archive;
408 struct archive_none *state = (struct archive_none *)f->data;
409 ssize_t block_length;
410 ssize_t target_block_length;
411 ssize_t bytes_written;
412 int ret = ARCHIVE_OK;
414 /* If there's pending data, pad and write the last block */
415 if (state->next != state->buffer) {
416 block_length = state->buffer_size - state->avail;
418 /* Tricky calculation to determine size of last block */
419 if (a->bytes_in_last_block <= 0)
420 /* Default or Zero: pad to full block */
421 target_block_length = a->bytes_per_block;
423 /* Round to next multiple of bytes_in_last_block. */
424 target_block_length = a->bytes_in_last_block *
425 ( (block_length + a->bytes_in_last_block - 1) /
426 a->bytes_in_last_block);
427 if (target_block_length > a->bytes_per_block)
428 target_block_length = a->bytes_per_block;
429 if (block_length < target_block_length) {
430 memset(state->next, 0,
431 target_block_length - block_length);
432 block_length = target_block_length;
434 bytes_written = (a->client_writer)(&a->archive,
435 a->client_data, state->buffer, block_length);
436 ret = bytes_written <= 0 ? ARCHIVE_FATAL : ARCHIVE_OK;
438 if (a->client_closer)
439 (*a->client_closer)(&a->archive, a->client_data);
442 /* Clear the close handler myself not to be called again. */
444 a->client_data = NULL;
445 /* Clear passphrase. */
446 if (a->passphrase != NULL) {
447 memset(a->passphrase, 0, strlen(a->passphrase));
449 a->passphrase = NULL;
455 * Open the archive using the current settings.
458 archive_write_open(struct archive *_a, void *client_data,
459 archive_open_callback *opener, archive_write_callback *writer,
460 archive_close_callback *closer)
462 struct archive_write *a = (struct archive_write *)_a;
463 struct archive_write_filter *client_filter;
466 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
467 ARCHIVE_STATE_NEW, "archive_write_open");
468 archive_clear_error(&a->archive);
470 a->client_writer = writer;
471 a->client_opener = opener;
472 a->client_closer = closer;
473 a->client_data = client_data;
475 client_filter = __archive_write_allocate_filter(_a);
476 client_filter->open = archive_write_client_open;
477 client_filter->write = archive_write_client_write;
478 client_filter->close = archive_write_client_close;
480 ret = __archive_write_open_filter(a->filter_first);
481 if (ret < ARCHIVE_WARN) {
482 r1 = __archive_write_close_filter(a->filter_first);
483 return (r1 < ret ? r1 : ret);
486 a->archive.state = ARCHIVE_STATE_HEADER;
488 ret = (a->format_init)(a);
493 * Close out the archive.
496 _archive_write_close(struct archive *_a)
498 struct archive_write *a = (struct archive_write *)_a;
499 int r = ARCHIVE_OK, r1 = ARCHIVE_OK;
501 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
502 ARCHIVE_STATE_ANY | ARCHIVE_STATE_FATAL,
503 "archive_write_close");
504 if (a->archive.state == ARCHIVE_STATE_NEW
505 || a->archive.state == ARCHIVE_STATE_CLOSED)
506 return (ARCHIVE_OK); /* Okay to close() when not open. */
508 archive_clear_error(&a->archive);
510 /* Finish the last entry if a finish callback is specified */
511 if (a->archive.state == ARCHIVE_STATE_DATA
512 && a->format_finish_entry != NULL)
513 r = ((a->format_finish_entry)(a));
515 /* Finish off the archive. */
516 /* TODO: have format closers invoke compression close. */
517 if (a->format_close != NULL) {
518 r1 = (a->format_close)(a);
523 /* Finish the compression and close the stream. */
524 r1 = __archive_write_close_filter(a->filter_first);
528 if (a->archive.state != ARCHIVE_STATE_FATAL)
529 a->archive.state = ARCHIVE_STATE_CLOSED;
534 _archive_write_filter_count(struct archive *_a)
536 struct archive_write *a = (struct archive_write *)_a;
537 struct archive_write_filter *p = a->filter_first;
547 __archive_write_filters_free(struct archive *_a)
549 struct archive_write *a = (struct archive_write *)_a;
550 int r = ARCHIVE_OK, r1;
552 while (a->filter_first != NULL) {
553 struct archive_write_filter *next
554 = a->filter_first->next_filter;
555 if (a->filter_first->free != NULL) {
556 r1 = (*a->filter_first->free)(a->filter_first);
560 free(a->filter_first);
561 a->filter_first = next;
563 a->filter_last = NULL;
567 * Destroy the archive structure.
569 * Be careful: user might just call write_new and then write_free.
570 * Don't assume we actually wrote anything or performed any non-trivial
574 _archive_write_free(struct archive *_a)
576 struct archive_write *a = (struct archive_write *)_a;
577 int r = ARCHIVE_OK, r1;
581 /* It is okay to call free() in state FATAL. */
582 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
583 ARCHIVE_STATE_ANY | ARCHIVE_STATE_FATAL, "archive_write_free");
584 if (a->archive.state != ARCHIVE_STATE_FATAL)
585 r = archive_write_close(&a->archive);
587 /* Release format resources. */
588 if (a->format_free != NULL) {
589 r1 = (a->format_free)(a);
594 __archive_write_filters_free(_a);
596 /* Release various dynamic buffers. */
597 free((void *)(uintptr_t)(const void *)a->nulls);
598 archive_string_free(&a->archive.error_string);
599 if (a->passphrase != NULL) {
600 /* A passphrase should be cleaned. */
601 memset(a->passphrase, 0, strlen(a->passphrase));
604 a->archive.magic = 0;
605 __archive_clean(&a->archive);
611 * Write the appropriate header.
614 _archive_write_header(struct archive *_a, struct archive_entry *entry)
616 struct archive_write *a = (struct archive_write *)_a;
619 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
620 ARCHIVE_STATE_DATA | ARCHIVE_STATE_HEADER, "archive_write_header");
621 archive_clear_error(&a->archive);
623 if (a->format_write_header == NULL) {
624 archive_set_error(&(a->archive), -1,
625 "Format must be set before you can write to an archive.");
626 a->archive.state = ARCHIVE_STATE_FATAL;
627 return (ARCHIVE_FATAL);
630 /* In particular, "retry" and "fatal" get returned immediately. */
631 ret = archive_write_finish_entry(&a->archive);
632 if (ret == ARCHIVE_FATAL) {
633 a->archive.state = ARCHIVE_STATE_FATAL;
634 return (ARCHIVE_FATAL);
636 if (ret < ARCHIVE_OK && ret != ARCHIVE_WARN)
639 if (a->skip_file_set &&
640 archive_entry_dev_is_set(entry) &&
641 archive_entry_ino_is_set(entry) &&
642 archive_entry_dev(entry) == (dev_t)a->skip_file_dev &&
643 archive_entry_ino64(entry) == a->skip_file_ino) {
644 archive_set_error(&a->archive, 0,
645 "Can't add archive to itself");
646 return (ARCHIVE_FAILED);
649 /* Format and write header. */
650 r2 = ((a->format_write_header)(a, entry));
651 if (r2 == ARCHIVE_FAILED) {
652 return (ARCHIVE_FAILED);
654 if (r2 == ARCHIVE_FATAL) {
655 a->archive.state = ARCHIVE_STATE_FATAL;
656 return (ARCHIVE_FATAL);
661 a->archive.state = ARCHIVE_STATE_DATA;
666 _archive_write_finish_entry(struct archive *_a)
668 struct archive_write *a = (struct archive_write *)_a;
669 int ret = ARCHIVE_OK;
671 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
672 ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
673 "archive_write_finish_entry");
674 if (a->archive.state & ARCHIVE_STATE_DATA
675 && a->format_finish_entry != NULL)
676 ret = (a->format_finish_entry)(a);
677 a->archive.state = ARCHIVE_STATE_HEADER;
682 * Note that the compressor is responsible for blocking.
685 _archive_write_data(struct archive *_a, const void *buff, size_t s)
687 struct archive_write *a = (struct archive_write *)_a;
688 const size_t max_write = INT_MAX;
690 archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
691 ARCHIVE_STATE_DATA, "archive_write_data");
692 /* In particular, this catches attempts to pass negative values. */
695 archive_clear_error(&a->archive);
696 return ((a->format_write_data)(a, buff, s));
699 static struct archive_write_filter *
700 filter_lookup(struct archive *_a, int n)
702 struct archive_write *a = (struct archive_write *)_a;
703 struct archive_write_filter *f = a->filter_first;
705 return a->filter_last;
708 while (n > 0 && f != NULL) {
716 _archive_filter_code(struct archive *_a, int n)
718 struct archive_write_filter *f = filter_lookup(_a, n);
719 return f == NULL ? -1 : f->code;
723 _archive_filter_name(struct archive *_a, int n)
725 struct archive_write_filter *f = filter_lookup(_a, n);
726 return f != NULL ? f->name : NULL;
730 _archive_filter_bytes(struct archive *_a, int n)
732 struct archive_write_filter *f = filter_lookup(_a, n);
733 return f == NULL ? -1 : f->bytes_written;