/* Buffer management for tar.
Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,
- 2003, 2004, 2005 Free Software Foundation, Inc.
+ 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
Written by John Gilmore, on 1985-08-25.
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
- Free Software Foundation; either version 2, or (at your option) any later
+ Free Software Foundation; either version 3, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
#include <system.h>
+#include <system-ioctl.h>
#include <signal.h>
+#include <closeout.h>
#include <fnmatch.h>
#include <human.h>
#include <quotearg.h>
static tarlong prev_written; /* bytes written on previous volumes */
static tarlong bytes_written; /* bytes written on this volume */
static void *record_buffer[2]; /* allocated memory */
+union block *record_buffer_aligned[2];
static int record_index;
/* FIXME: The following variables should ideally be static to this
enum access_mode access_mode; /* how do we handle the archive */
off_t records_read; /* number of records read from this archive */
off_t records_written; /* likewise, for records written */
+extern off_t records_skipped; /* number of records skipped at the start
+ of the archive, defined in delete.c */
static off_t record_start_block; /* block ordinal at record_start */
static bool hit_eof;
/* Checkpointing counter */
-static int checkpoint;
+static unsigned checkpoint;
static bool read_full_records = false;
static off_t save_sizeleft; /* where we are in the file we are writing,
only valid if save_name is nonzero */
+\f
+static struct tar_stat_info dummy;
+
+void
+buffer_write_global_xheader ()
+{
+ xheader_write_global (&dummy.xhdr);
+}
+
void
mv_begin (struct tar_stat_info *st)
{
set_start_time ()
{
gettime (&start_time);
+ volume_start_time = start_time;
+ last_stat_time = start_time;
+}
+
+void
+set_volume_start_time ()
+{
+ gettime (&volume_start_time);
+ last_stat_time = volume_start_time;
}
void
{
struct timespec now;
gettime (&now);
- duration += ((now.tv_sec - start_time.tv_sec)
- + (now.tv_nsec - start_time.tv_nsec) / 1e9);
- set_start_time ();
+ duration += ((now.tv_sec - last_stat_time.tv_sec)
+ + (now.tv_nsec - last_stat_time.tv_nsec) / 1e9);
+ gettime (&last_stat_time);
}
\f
ct_none,
ct_compress,
ct_gzip,
- ct_bzip2
+ ct_bzip2,
+ ct_lzma
};
struct zip_magic
{ ct_compress, 2, "\037\235", "compress", "-Z" },
{ ct_gzip, 2, "\037\213", "gzip", "-z" },
{ ct_bzip2, 3, "BZh", "bzip2", "-j" },
+ { ct_lzma, 6, "\xFFLZMA", "lzma", "-a" }, /* FIXME: ???? */
};
#define NMAGIC (sizeof(magic)/sizeof(magic[0]))
{
struct zip_magic const *p;
bool sfr;
-
+ bool short_file = false;
+
/* Prepare global data needed for find_next_block: */
record_end = record_start; /* set up for 1st record = # 0 */
sfr = read_full_records;
read_full_records = true; /* Suppress fatal error on reading a partial
record */
- find_next_block ();
-
+ if (find_next_block () == 0)
+ short_file = true;
+
/* Restore global values */
read_full_records = sfr;
if (memcmp (record_start->buffer, p->magic, p->length) == 0)
return p->type;
+ if (short_file)
+ ERROR ((0, 0, _("This does not look like a tar archive")));
+
return ct_none;
}
}
\f
-void
-print_total_written (void)
+static void
+print_stats (FILE *fp, const char *text, tarlong numbytes)
{
- tarlong written = prev_written + bytes_written;
char bytes[sizeof (tarlong) * CHAR_BIT];
char abbr[LONGEST_HUMAN_READABLE + 1];
char rate[LONGEST_HUMAN_READABLE + 1];
int human_opts = human_autoscale | human_base_1024 | human_SI | human_B;
- sprintf (bytes, TARLONG_FORMAT, written);
+ sprintf (bytes, TARLONG_FORMAT, numbytes);
- /* Amanda 2.4.1p1 looks for "Total bytes written: [0-9][0-9]*". */
- fprintf (stderr, _("Total bytes written: %s (%s, %s/s)\n"), bytes,
- human_readable (written, abbr, human_opts, 1, 1),
- (0 < duration && written / duration < (uintmax_t) -1
- ? human_readable (written / duration, rate, human_opts, 1, 1)
+ fprintf (fp, "%s: %s (%s, %s/s)\n",
+ text, bytes,
+ human_readable (numbytes, abbr, human_opts, 1, 1),
+ (0 < duration && numbytes / duration < (uintmax_t) -1
+ ? human_readable (numbytes / duration, rate, human_opts, 1, 1)
: "?"));
}
+void
+print_total_stats ()
+{
+ switch (subcommand_option)
+ {
+ case CREATE_SUBCOMMAND:
+ case CAT_SUBCOMMAND:
+ case UPDATE_SUBCOMMAND:
+ case APPEND_SUBCOMMAND:
+ /* Amanda 2.4.1p1 looks for "Total bytes written: [0-9][0-9]*". */
+ print_stats (stderr, _("Total bytes written"),
+ prev_written + bytes_written);
+ break;
+
+ case DELETE_SUBCOMMAND:
+ {
+ char buf[UINTMAX_STRSIZE_BOUND];
+ print_stats (stderr, _("Total bytes read"),
+ records_read * record_size);
+ print_stats (stderr, _("Total bytes written"),
+ prev_written + bytes_written);
+ fprintf (stderr, _("Total bytes deleted: %s\n"),
+ STRINGIFY_BIGINT ((records_read - records_skipped)
+ * record_size
+ - (prev_written + bytes_written), buf));
+ }
+ break;
+
+ case EXTRACT_SUBCOMMAND:
+ case LIST_SUBCOMMAND:
+ case DIFF_SUBCOMMAND:
+ print_stats (stderr, _("Total bytes read"),
+ records_read * record_size);
+ break;
+
+ default:
+ abort ();
+ }
+}
+
/* Compute and return the block ordinal at current_block. */
off_t
current_block_ordinal (void)
static void
init_buffer ()
{
- if (!record_buffer[record_index])
- page_aligned_alloc (&record_buffer[record_index], record_size);
-
- record_start = record_buffer[record_index];
+ if (! record_buffer_aligned[record_index])
+ record_buffer_aligned[record_index] =
+ page_aligned_alloc (&record_buffer[record_index], record_size);
+
+ record_start = record_buffer_aligned[record_index];
current_block = record_start;
record_end = record_start + blocking_factor;
}
{
int backed_up_flag = 0;
- if (index_file_name)
- {
- stdlis = fopen (index_file_name, "w");
- if (! stdlis)
- open_error (index_file_name);
- }
- else
- stdlis = to_stdout_option ? stderr : stdout;
-
if (record_size == 0)
FATAL_ERROR ((0, 0, _("Invalid value for record_size")));
record_index = 0;
init_buffer ();
-
+
/* When updating the archive, we start with reading. */
access_mode = wanted_access == ACCESS_UPDATE ? ACCESS_READ : wanted_access;
break;
}
- if (wanted_access == ACCESS_WRITE
+ if (!index_file_name
+ && wanted_access == ACCESS_WRITE
&& strcmp (archive_name_array[0], "-") == 0)
stdlis = stderr;
}
archive = STDIN_FILENO;
- type = check_compressed_archive (archive);
+ type = check_compressed_archive ();
if (type != ct_none)
FATAL_ERROR ((0, 0,
_("Archive is compressed. Use %s option"),
case ACCESS_WRITE:
archive = STDOUT_FILENO;
- stdlis = stderr;
+ if (!index_file_name)
+ stdlis = stderr;
break;
case ACCESS_UPDATE:
archive = STDIN_FILENO;
- stdlis = stderr;
write_archive_to_stdout = true;
+ record_end = record_start; /* set up for 1st record = # 0 */
+ if (!index_file_name)
+ stdlis = stderr;
break;
}
}
break;
case ACCESS_UPDATE:
- archive = rmtopen (archive_name_array[0], O_RDWR | O_CREAT | O_BINARY,
+ archive = rmtopen (archive_name_array[0],
+ O_RDWR | O_CREAT | O_BINARY,
MODE_RW, rsh_command_option);
+
+ if (check_compressed_archive () != ct_none)
+ FATAL_ERROR ((0, 0,
+ _("Cannot update compressed archives")));
break;
}
switch (wanted_access)
{
- case ACCESS_UPDATE:
- records_written = 0;
- record_end = record_start; /* set up for 1st record = # 0 */
-
case ACCESS_READ:
find_next_block (); /* read it in, check for EOF */
break;
+ case ACCESS_UPDATE:
case ACCESS_WRITE:
records_written = 0;
break;
}
}
+static void
+do_checkpoint (bool do_write)
+{
+ if (checkpoint_option && !(++checkpoint % checkpoint_option))
+ {
+ switch (checkpoint_style)
+ {
+ case checkpoint_dot:
+ fputc ('.', stdlis);
+ fflush (stdlis);
+ break;
+
+ case checkpoint_text:
+ if (do_write)
+ /* TRANSLATORS: This is a ``checkpoint of write operation'',
+ *not* ``Writing a checkpoint''.
+ E.g. in Spanish ``Punto de comprobaci@'on de escritura'',
+ *not* ``Escribiendo un punto de comprobaci@'on'' */
+ WARN ((0, 0, _("Write checkpoint %u"), checkpoint));
+ else
+ /* TRANSLATORS: This is a ``checkpoint of read operation'',
+ *not* ``Reading a checkpoint''.
+ E.g. in Spanish ``Punto de comprobaci@'on de lectura'',
+ *not* ``Leyendo un punto de comprobaci@'on'' */
+ WARN ((0, 0, _("Read checkpoint %u"), checkpoint));
+ break;
+ }
+ }
+}
+
/* Perform a write to flush the buffer. */
ssize_t
_flush_write (void)
{
ssize_t status;
- if (checkpoint_option && !(++checkpoint % 10))
- /* TRANSLATORS: This is a ``checkpoint of write operation'',
- *not* ``Writing a checkpoint''.
- E.g. in Spanish ``Punto de comprobaci@'on de escritura'',
- *not* ``Escribiendo un punto de comprobaci@'on'' */
- WARN ((0, 0, _("Write checkpoint %d"), checkpoint));
-
+ do_checkpoint (true);
if (tape_length_option && tape_length_option <= bytes_written)
{
errno = ENOSPC;
if (totals_option)
{
int e = errno;
- print_total_written ();
+ print_total_stats ();
errno = e;
}
records_read++;
}
-/* Perform a read to flush the buffer. */
-size_t
-_flush_read (void)
-{
- size_t status; /* result from system call */
-
- if (checkpoint_option && !(++checkpoint % 10))
- /* TRANSLATORS: This is a ``checkpoint of read operation'',
- *not* ``Reading a checkpoint''.
- E.g. in Spanish ``Punto de comprobaci@'on de lectura'',
- *not* ``Leyendo un punto de comprobaci@'on'' */
- WARN ((0, 0, _("Read checkpoint %d"), checkpoint));
-
- /* Clear the count of errors. This only applies to a single call to
- flush_read. */
-
- read_error_count = 0; /* clear error count */
-
- if (write_archive_to_stdout && record_start_block != 0)
- {
- archive = STDOUT_FILENO;
- status = sys_write_archive_buffer ();
- archive = STDIN_FILENO;
- if (status != record_size)
- archive_write_error (status);
- }
-
- status = rmtread (archive, record_start->buffer, record_size);
- if (status == record_size)
- records_read++;
- return status;
-}
-
/* Flush the current buffer to/from the archive. */
void
flush_archive (void)
{
char *input_buffer = NULL;
size_t size = 0;
-
- while (1)
+ bool stop = false;
+
+ while (!stop)
{
fputc ('\007', stderr);
fprintf (stderr,
_("Prepare volume #%d for %s and hit return: "),
global_volno + 1, quote (*archive_name_cursor));
fflush (stderr);
-
+
if (getline (&input_buffer, &size, read_file) <= 0)
{
WARN ((0, 0, _("EOF where user reply was expected")));
-
+
if (subcommand_option != EXTRACT_SUBCOMMAND
&& subcommand_option != LIST_SUBCOMMAND
&& subcommand_option != DIFF_SUBCOMMAND)
WARN ((0, 0, _("WARNING: Archive is incomplete")));
-
+
fatal_exit ();
}
-
+
if (input_buffer[0] == '\n'
|| input_buffer[0] == 'y'
|| input_buffer[0] == 'Y')
case '?':
{
fprintf (stderr, _("\
- n [name] Give a new file name for the next (and subsequent) volume(s)\n\
+ n name Give a new file name for the next (and subsequent) volume(s)\n\
q Abort tar\n\
y or newline Continue operation\n"));
if (!restrict_option)
case 'q':
/* Quit. */
-
+
WARN ((0, 0, _("No new volume; exiting.\n")));
-
+
if (subcommand_option != EXTRACT_SUBCOMMAND
&& subcommand_option != LIST_SUBCOMMAND
&& subcommand_option != DIFF_SUBCOMMAND)
WARN ((0, 0, _("WARNING: Archive is incomplete")));
-
+
fatal_exit ();
-
+
case 'n':
/* Get new file name. */
-
+
{
char *name;
char *cursor;
-
+
for (name = input_buffer + 1;
*name == ' ' || *name == '\t';
name++)
;
-
+
for (cursor = name; *cursor && *cursor != '\n'; cursor++)
;
*cursor = '\0';
-
- /* FIXME: the following allocation is never reclaimed. */
- *archive_name_cursor = xstrdup (name);
+
+ if (name[0])
+ {
+ /* FIXME: the following allocation is never reclaimed. */
+ *archive_name_cursor = xstrdup (name);
+ stop = true;
+ }
+ else
+ fprintf (stderr, "%s",
+ _("File name not specified. Try again.\n"));
}
break;
-
+
case '!':
if (!restrict_option)
{
{
static FILE *read_file;
static int looped;
+ int prompt;
if (!read_file && !info_script_option)
/* FIXME: if fopen is used, it will never be closed. */
assign_string (&volume_label, NULL);
assign_string (&continued_file_name, NULL);
continued_file_size = continued_file_offset = 0;
+ current_block = record_start;
if (rmtclose (archive) != 0)
close_warn (*archive_name_cursor);
archive_name_cursor = archive_name_array;
looped = 1;
}
+ prompt = looped;
tryagain:
- if (looped)
+ if (prompt)
{
/* We have to prompt from now on. */
open_warn (*archive_name_cursor);
if (!verify_option && mode == ACCESS_WRITE && backup_option)
undo_last_backup ();
+ prompt = 1;
goto tryagain;
}
}
static bool
-read_header0 ()
+read_header0 (struct tar_stat_info *info)
{
- enum read_header rc = read_header (false);
+ enum read_header rc;
+ tar_stat_init (info);
+ rc = read_header_primitive (false, info);
if (rc == HEADER_SUCCESS)
{
set_next_block_after (current_header);
{
size_t status;
union block *header;
-
+ enum access_mode acc;
+
switch (subcommand_option)
{
case APPEND_SUBCOMMAND:
case CAT_SUBCOMMAND:
case UPDATE_SUBCOMMAND:
- if (!new_volume (ACCESS_UPDATE))
- return true;
+ acc = ACCESS_UPDATE;
break;
default:
- if (!new_volume (ACCESS_READ))
- return true;
+ acc = ACCESS_READ;
break;
}
+ if (!new_volume (acc))
+ return true;
+
while ((status = rmtread (archive, record_start->buffer, record_size))
== SAFE_READ_ERROR)
archive_read_error ();
header = find_next_block ();
if (!header)
return false;
+
switch (header->header.typeflag)
{
case XGLTYPE:
{
- struct tar_stat_info dummy;
- if (!read_header0 ())
+ if (!read_header0 (&dummy))
return false;
- tar_stat_init (&dummy);
xheader_decode (&dummy); /* decodes values from the global header */
tar_stat_destroy (&dummy);
if (!real_s_name)
}
break;
}
-
+
case GNUTYPE_VOLHDR:
- if (!read_header0 ())
+ if (!read_header0 (&dummy))
return false;
+ tar_stat_destroy (&dummy);
assign_string (&volume_label, current_header->header.name);
set_next_block_after (header);
header = find_next_block ();
if (header->header.typeflag != GNUTYPE_MULTIVOL)
break;
/* FALL THROUGH */
-
+
case GNUTYPE_MULTIVOL:
- if (!read_header0 ())
+ if (!read_header0 (&dummy))
return false;
+ tar_stat_destroy (&dummy);
assign_string (&continued_file_name, current_header->header.name);
continued_file_size =
UINTMAX_FROM_HEADER (current_header->header.size);
continued_file_offset =
UINTMAX_FROM_HEADER (current_header->oldgnu_header.offset);
break;
-
+
default:
break;
}
if (real_s_name)
{
uintmax_t s;
- if (!continued_file_name
+ if (!continued_file_name
|| strcmp (continued_file_name, real_s_name))
{
- WARN ((0, 0, _("%s is not continued on this volume"),
- quote (real_s_name)));
- return false;
+ if ((archive_format == GNU_FORMAT || archive_format == OLDGNU_FORMAT)
+ && strlen (real_s_name) >= NAME_FIELD_SIZE
+ && strncmp (continued_file_name, real_s_name,
+ NAME_FIELD_SIZE) == 0)
+ WARN ((0, 0,
+ _("%s is possibly continued on this volume: header contains truncated name"),
+ quote (real_s_name)));
+ else
+ {
+ WARN ((0, 0, _("%s is not continued on this volume"),
+ quote (real_s_name)));
+ return false;
+ }
}
s = continued_file_size + continued_file_offset;
STRINGIFY_BIGINT (continued_file_offset, s2buf)));
return false;
}
-
+
if (real_s_totsize - real_s_sizeleft != continued_file_offset)
{
WARN ((0, 0, _("This volume is out of sequence")));
_write_volume_label (const char *str)
{
if (archive_format == POSIX_FORMAT)
- xheader_store ("GNU.volume.label", NULL, str);
+ xheader_store ("GNU.volume.label", &dummy, str);
else
{
union block *label = find_next_block ();
-
+
memset (label, 0, BLOCKSIZE);
strcpy (label->header.name, volume_label_option);
real_s_part_no);
st.file_name = st.orig_file_name;
st.archive_file_size = st.stat.st_size = real_s_sizeleft;
-
+
block_ordinal = current_block_ordinal ();
blk = start_header (&st);
- free (st.orig_file_name);
if (!blk)
abort (); /* FIXME */
finish_header (&st, blk, block_ordinal);
+ free (st.orig_file_name);
}
}
{
int tmp;
union block *block = find_next_block ();
-
+
if (strlen (real_s_name) > NAME_FIELD_SIZE)
WARN ((0, 0,
_("%s: file name too long to be stored in a GNU multivolume header, truncated"),
quotearg_colon (real_s_name)));
-
+
memset (block, 0, BLOCKSIZE);
-
+
/* FIXME: Michael P Urban writes: [a long name file] is being written
when a new volume rolls around [...] Looks like the wrong value is
being preserved in real_s_name, though. */
-
+
strncpy (block->header.name, real_s_name, NAME_FIELD_SIZE);
block->header.typeflag = GNUTYPE_MULTIVOL;
-
+
OFF_TO_CHARS (real_s_sizeleft, block->header.size);
OFF_TO_CHARS (real_s_totsize - real_s_sizeleft,
block->oldgnu_header.offset);
-
+
tmp = verbose_option;
verbose_option = 0;
finish_header (¤t_stat_info, block, -1);
if (archive_format == POSIX_FORMAT)
{
off_t d = real_s_totsize - real_s_sizeleft;
- xheader_store ("GNU.volume.filename", NULL, real_s_name);
- xheader_store ("GNU.volume.size", NULL, &real_s_sizeleft);
- xheader_store ("GNU.volume.offset", NULL, &d);
+ xheader_store ("GNU.volume.filename", &dummy, real_s_name);
+ xheader_store ("GNU.volume.size", &dummy, &real_s_sizeleft);
+ xheader_store ("GNU.volume.offset", &dummy, &d);
}
else
gnu_add_multi_volume_header ();
{
size_t status; /* result from system call */
- if (checkpoint_option && !(++checkpoint % 10))
- /* TRANSLATORS: This is a ``checkpoint of read operation'',
- *not* ``Reading a checkpoint''.
- E.g. in Spanish ``Punto de comprobaci@'on de lectura'',
- *not* ``Leyendo un punto de comprobaci@'on'' */
- WARN ((0, 0, _("Read checkpoint %d"), checkpoint));
-
+ do_checkpoint (false);
+
/* Clear the count of errors. This only applies to a single call to
flush_read. */
if (status != record_size)
archive_write_error (status);
}
-
+
for (;;)
{
status = rmtread (archive, record_start->buffer, record_size);
{
size_t status; /* result from system call */
- if (checkpoint_option && !(++checkpoint % 10))
- /* TRANSLATORS: This is a ``checkpoint of read operation'',
- *not* ``Reading a checkpoint''.
- E.g. in Spanish ``Punto de comprobaci@'on de lectura'',
- *not* ``Leyendo un punto de comprobaci@'on'' */
- WARN ((0, 0, _("Read checkpoint %d"), checkpoint));
-
+ do_checkpoint (false);
+
/* Clear the count of errors. This only applies to a single call to
flush_read. */
else if (status == SAFE_READ_ERROR)
{
archive_read_error ();
- continue;
+ continue;
}
break;
}
{
flush_read_ptr = simple_flush_read; /* Avoid recursion */
_gnu_flush_read ();
- flush_read_ptr = gnu_flush_read;
+ flush_read_ptr = gnu_flush_read;
}
static void
char *copy_ptr;
size_t copy_size;
size_t bufsize;
-
+
status = _flush_write ();
if (status != record_size && !multi_volume_option)
archive_write_error (status);
if (!new_volume (ACCESS_WRITE))
return;
- xheader_destroy (&extended_header);
+ tar_stat_destroy (&dummy);
increase_volume_number ();
- if (totals_option)
- prev_written += bytes_written;
+ prev_written += bytes_written;
bytes_written = 0;
copy_ptr = record_start->buffer + status;
/* Switch to the next buffer */
record_index = !record_index;
init_buffer ();
-
+
if (volume_label_option)
add_volume_label ();
if (real_s_name)
add_multi_volume_header ();
- write_extended (true, NULL, find_next_block ());
+ write_extended (true, &dummy, find_next_block ());
+ tar_stat_destroy (&dummy);
+
if (real_s_name)
add_chunk_header ();
header = find_next_block ();
{
flush_write_ptr = simple_flush_write; /* Avoid recursion */
_gnu_flush_write (buffer_level);
- flush_write_ptr = gnu_flush_write;
+ flush_write_ptr = gnu_flush_write;
}
void
flush_write ()
{
flush_write_ptr (record_size);
-}
+}
void
open_archive (enum access_mode wanted_access)
if (volume_label_option)
write_volume_label ();
break;
+
+ default:
+ break;
}
+ set_volume_start_time ();
}
-