~akopytov/percona-xtrabackup/bug1166888-2.1

« back to all changes in this revision

Viewing changes to src/libarchive/libarchive/archive_write_private.h

  • Committer: Alexey Kopytov
  • Date: 2012-02-10 20:05:56 UTC
  • mto: (391.1.5 staging)
  • mto: This revision was merged to the branch mainline in revision 390.
  • Revision ID: akopytov@gmail.com-20120210200556-6kx41z8wwrqfucro
Rebase of the parallel compression patch on new trunk + post-review
fixes.

Implementation of parallel compression and streaming for XtraBackup.

This revision implements the following changes:

* InnoDB files are now streamed by the xtrabackup binary rather than
innobackupex. As a result, integrity is now verified by xtrabackup and
thus tar4ibd is no longer needed, so it was removed.

* xtrabackup binary now accepts the new '--stream' option which has
exactly the same semantics as the '--stream' option in
innobackupex: it tells xtrabackup to stream all files to the standard
output in the specified format rather than storing them locally.

* The xtrabackup binary can now do parallel compression using the
quicklz library. Two new options were added to xtrabackup to support
this feature:

- '--compress' tells xtrabackup to compress all output data, including
the transaction log file and meta data files, using the specified
compression algorithm. The only currently supported algorithm is
'quicklz'. The resulting files have the qpress archive format,
i.e. every *.qp file produced by xtrabackup is essentially a one-file
qpress archive and can be extracted and uncompressed by the qpress
file archiver (http://www.quicklz.com/).

- '--compress-threads' specifies the number of worker threads used by
xtrabackup for parallel data compression. This option defaults to 1.

Parallel compression ('--compress-threads') can be used together with
parallel file copying ('--parallel'). For example, '--parallel=4
--compress --compress-threads=2' will create 4 IO threads that will
read the data and pipe it to 2 compression threads.

* To support simultaneous compression and streaming, a new custom
streaming format called 'xbstream' was introduced to XtraBackup in
addition to the 'tar' format. That was required to overcome some
limitations of traditional archive formats such as 'tar', 'cpio' and
others that do not allow streaming dynamically generated files, for
example dynamically compressed files.  Other advantages of xbstream over
traditional streaming/archive formats include ability to stream multiple
files concurrently (so it is possible to use streaming in the xbstream
format together with the --parallel option) and more compact data
storage.

* To allow streaming and extracting files to/from the xbstream format
produced by xtrabackup, a new utility aptly called 'xbstream' was
added to the XtraBackup distribution. This utility has a tar-like
interface:

- with the '-x' option it extracts files from the stream read from its
standard input to the current directory unless specified otherwise
with the '-C' option.

- with the '-c' option it streams files specified on the command line
to its standard output.

The utility also tries to minimize its impact on the OS page cache by
using the appropriate posix_fadvise() calls when available.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*-
 
2
 * Copyright (c) 2003-2007 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
 * $FreeBSD: head/lib/libarchive/archive_write_private.h 201155 2009-12-29 05:20:12Z kientzle $
 
26
 */
 
27
 
 
28
#ifndef __LIBARCHIVE_BUILD
 
29
#error This header is only to be used internally to libarchive.
 
30
#endif
 
31
 
 
32
#ifndef ARCHIVE_WRITE_PRIVATE_H_INCLUDED
 
33
#define ARCHIVE_WRITE_PRIVATE_H_INCLUDED
 
34
 
 
35
#include "archive.h"
 
36
#include "archive_string.h"
 
37
#include "archive_private.h"
 
38
 
 
39
struct archive_write {
 
40
        struct archive  archive;
 
41
 
 
42
        /* Dev/ino of the archive being written. */
 
43
        dev_t             skip_file_dev;
 
44
        int64_t           skip_file_ino;
 
45
 
 
46
        /* Utility:  Pointer to a block of nulls. */
 
47
        const unsigned char     *nulls;
 
48
        size_t                   null_length;
 
49
 
 
50
        /* Callbacks to open/read/write/close archive stream. */
 
51
        archive_open_callback   *client_opener;
 
52
        archive_write_callback  *client_writer;
 
53
        archive_close_callback  *client_closer;
 
54
        void                    *client_data;
 
55
 
 
56
        /*
 
57
         * Blocking information.  Note that bytes_in_last_block is
 
58
         * misleadingly named; I should find a better name.  These
 
59
         * control the final output from all compressors, including
 
60
         * compression_none.
 
61
         */
 
62
        int               bytes_per_block;
 
63
        int               bytes_in_last_block;
 
64
 
 
65
        /*
 
66
         * These control whether data within a gzip/bzip2 compressed
 
67
         * stream gets padded or not.  If pad_uncompressed is set,
 
68
         * the data will be padded to a full block before being
 
69
         * compressed.  The pad_uncompressed_byte determines the value
 
70
         * that will be used for padding.  Note that these have no
 
71
         * effect on compression "none."
 
72
         */
 
73
        int               pad_uncompressed;
 
74
        int               pad_uncompressed_byte; /* TODO: Support this. */
 
75
 
 
76
        /*
 
77
         * On write, the client just invokes an archive_write_set function
 
78
         * which sets up the data here directly.
 
79
         */
 
80
        struct {
 
81
                void     *data;
 
82
                void     *config;
 
83
                int     (*init)(struct archive_write *);
 
84
                int     (*options)(struct archive_write *,
 
85
                            const char *key, const char *value);
 
86
                int     (*finish)(struct archive_write *);
 
87
                int     (*write)(struct archive_write *, const void *, size_t);
 
88
        } compressor;
 
89
 
 
90
        /*
 
91
         * Pointers to format-specific functions for writing.  They're
 
92
         * initialized by archive_write_set_format_XXX() calls.
 
93
         */
 
94
        void     *format_data;
 
95
        const char *format_name;
 
96
        int     (*format_init)(struct archive_write *);
 
97
        int     (*format_options)(struct archive_write *,
 
98
                    const char *key, const char *value);
 
99
        int     (*format_finish)(struct archive_write *);
 
100
        int     (*format_destroy)(struct archive_write *);
 
101
        int     (*format_finish_entry)(struct archive_write *);
 
102
        int     (*format_write_header)(struct archive_write *,
 
103
                    struct archive_entry *);
 
104
        ssize_t (*format_write_data)(struct archive_write *,
 
105
                    const void *buff, size_t);
 
106
};
 
107
 
 
108
/*
 
109
 * Utility function to format a USTAR header into a buffer.  If
 
110
 * "strict" is set, this tries to create the absolutely most portable
 
111
 * version of a ustar header.  If "strict" is set to 0, then it will
 
112
 * relax certain requirements.
 
113
 *
 
114
 * Generally, format-specific declarations don't belong in this
 
115
 * header; this is a rare example of a function that is shared by
 
116
 * two very similar formats (ustar and pax).
 
117
 */
 
118
int
 
119
__archive_write_format_header_ustar(struct archive_write *, char buff[512],
 
120
    struct archive_entry *, int tartype, int strict);
 
121
 
 
122
#endif