~akopytov/percona-xtrabackup/bug1166888-2.0

« back to all changes in this revision

Viewing changes to src/libarchive/libarchive/cpio.5

  • Committer: Alexey Kopytov
  • Date: 2012-02-10 20:05:56 UTC
  • 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
.\" Copyright (c) 2007 Tim Kientzle
 
2
.\" All rights reserved.
 
3
.\"
 
4
.\" Redistribution and use in source and binary forms, with or without
 
5
.\" modification, are permitted provided that the following conditions
 
6
.\" are met:
 
7
.\" 1. Redistributions of source code must retain the above copyright
 
8
.\"    notice, this list of conditions and the following disclaimer.
 
9
.\" 2. Redistributions in binary form must reproduce the above copyright
 
10
.\"    notice, this list of conditions and the following disclaimer in the
 
11
.\"    documentation and/or other materials provided with the distribution.
 
12
.\"
 
13
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 
14
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 
15
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 
16
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 
17
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 
18
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 
19
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 
20
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 
21
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 
22
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 
23
.\" SUCH DAMAGE.
 
24
.\"
 
25
.\" $FreeBSD: src/lib/libarchive/cpio.5,v 1.2 2008/05/26 17:00:23 kientzle Exp $
 
26
.\"
 
27
.Dd October 5, 2007
 
28
.Dt CPIO 5
 
29
.Os
 
30
.Sh NAME
 
31
.Nm cpio
 
32
.Nd format of cpio archive files
 
33
.Sh DESCRIPTION
 
34
The
 
35
.Nm
 
36
archive format collects any number of files, directories, and other
 
37
file system objects (symbolic links, device nodes, etc.) into a single
 
38
stream of bytes.
 
39
.Ss General Format
 
40
Each file system object in a
 
41
.Nm
 
42
archive comprises a header record with basic numeric metadata
 
43
followed by the full pathname of the entry and the file data.
 
44
The header record stores a series of integer values that generally
 
45
follow the fields in
 
46
.Va struct stat .
 
47
(See
 
48
.Xr stat 2
 
49
for details.)
 
50
The variants differ primarily in how they store those integers
 
51
(binary, octal, or hexadecimal).
 
52
The header is followed by the pathname of the
 
53
entry (the length of the pathname is stored in the header)
 
54
and any file data.
 
55
The end of the archive is indicated by a special record with
 
56
the pathname
 
57
.Dq TRAILER!!! .
 
58
.Ss PWB format
 
59
XXX Any documentation of the original PWB/UNIX 1.0 format? XXX
 
60
.Ss Old Binary Format
 
61
The old binary
 
62
.Nm
 
63
format stores numbers as 2-byte and 4-byte binary values.
 
64
Each entry begins with a header in the following format:
 
65
.Bd -literal -offset indent
 
66
struct header_old_cpio {
 
67
        unsigned short   c_magic;
 
68
        unsigned short   c_dev;
 
69
        unsigned short   c_ino;
 
70
        unsigned short   c_mode;
 
71
        unsigned short   c_uid;
 
72
        unsigned short   c_gid;
 
73
        unsigned short   c_nlink;
 
74
        unsigned short   c_rdev;
 
75
        unsigned short   c_mtime[2];
 
76
        unsigned short   c_namesize;
 
77
        unsigned short   c_filesize[2];
 
78
};
 
79
.Ed
 
80
.Pp
 
81
The
 
82
.Va unsigned short
 
83
fields here are 16-bit integer values; the
 
84
.Va unsigned int
 
85
fields are 32-bit integer values.
 
86
The fields are as follows
 
87
.Bl -tag -width indent
 
88
.It Va magic
 
89
The integer value octal 070707.
 
90
This value can be used to determine whether this archive is
 
91
written with little-endian or big-endian integers.
 
92
.It Va dev , Va ino
 
93
The device and inode numbers from the disk.
 
94
These are used by programs that read
 
95
.Nm
 
96
archives to determine when two entries refer to the same file.
 
97
Programs that synthesize
 
98
.Nm
 
99
archives should be careful to set these to distinct values for each entry.
 
100
.It Va mode
 
101
The mode specifies both the regular permissions and the file type.
 
102
It consists of several bit fields as follows:
 
103
.Bl -tag -width "MMMMMMM" -compact
 
104
.It 0170000
 
105
This masks the file type bits.
 
106
.It 0140000
 
107
File type value for sockets.
 
108
.It 0120000
 
109
File type value for symbolic links.
 
110
For symbolic links, the link body is stored as file data.
 
111
.It 0100000
 
112
File type value for regular files.
 
113
.It 0060000
 
114
File type value for block special devices.
 
115
.It 0040000
 
116
File type value for directories.
 
117
.It 0020000
 
118
File type value for character special devices.
 
119
.It 0010000
 
120
File type value for named pipes or FIFOs.
 
121
.It 0004000
 
122
SUID bit.
 
123
.It 0002000
 
124
SGID bit.
 
125
.It 0001000
 
126
Sticky bit.
 
127
On some systems, this modifies the behavior of executables and/or directories.
 
128
.It 0000777
 
129
The lower 9 bits specify read/write/execute permissions
 
130
for world, group, and user following standard POSIX conventions.
 
131
.El
 
132
.It Va uid , Va gid
 
133
The numeric user id and group id of the owner.
 
134
.It Va nlink
 
135
The number of links to this file.
 
136
Directories always have a value of at least two here.
 
137
Note that hardlinked files include file data with every copy in the archive.
 
138
.It Va rdev
 
139
For block special and character special entries,
 
140
this field contains the associated device number.
 
141
For all other entry types, it should be set to zero by writers
 
142
and ignored by readers.
 
143
.It Va mtime
 
144
Modification time of the file, indicated as the number
 
145
of seconds since the start of the epoch,
 
146
00:00:00 UTC January 1, 1970.
 
147
The four-byte integer is stored with the most-significant 16 bits first
 
148
followed by the least-significant 16 bits.
 
149
Each of the two 16 bit values are stored in machine-native byte order.
 
150
.It Va namesize
 
151
The number of bytes in the pathname that follows the header.
 
152
This count includes the trailing NUL byte.
 
153
.It Va filesize
 
154
The size of the file.
 
155
Note that this archive format is limited to
 
156
four gigabyte file sizes.
 
157
See
 
158
.Va mtime
 
159
above for a description of the storage of four-byte integers.
 
160
.El
 
161
.Pp
 
162
The pathname immediately follows the fixed header.
 
163
If the
 
164
.Cm namesize
 
165
is odd, an additional NUL byte is added after the pathname.
 
166
The file data is then appended, padded with NUL
 
167
bytes to an even length.
 
168
.Pp
 
169
Hardlinked files are not given special treatment;
 
170
the full file contents are included with each copy of the
 
171
file.
 
172
.Ss Portable ASCII Format
 
173
.St -susv2
 
174
standardized an ASCII variant that is portable across all
 
175
platforms.
 
176
It is commonly known as the
 
177
.Dq old character
 
178
format or as the
 
179
.Dq odc
 
180
format.
 
181
It stores the same numeric fields as the old binary format, but
 
182
represents them as 6-character or 11-character octal values.
 
183
.Bd -literal -offset indent
 
184
struct cpio_odc_header {
 
185
        char    c_magic[6];
 
186
        char    c_dev[6];
 
187
        char    c_ino[6];
 
188
        char    c_mode[6];
 
189
        char    c_uid[6];
 
190
        char    c_gid[6];
 
191
        char    c_nlink[6];
 
192
        char    c_rdev[6];
 
193
        char    c_mtime[11];
 
194
        char    c_namesize[6];
 
195
        char    c_filesize[11];
 
196
};
 
197
.Ed
 
198
.Pp
 
199
The fields are identical to those in the old binary format.
 
200
The name and file body follow the fixed header.
 
201
Unlike the old binary format, there is no additional padding
 
202
after the pathname or file contents.
 
203
If the files being archived are themselves entirely ASCII, then
 
204
the resulting archive will be entirely ASCII, except for the
 
205
NUL byte that terminates the name field.
 
206
.Ss New ASCII Format
 
207
The "new" ASCII format uses 8-byte hexadecimal fields for
 
208
all numbers and separates device numbers into separate fields
 
209
for major and minor numbers.
 
210
.Bd -literal -offset indent
 
211
struct cpio_newc_header {
 
212
        char    c_magic[6];
 
213
        char    c_ino[8];
 
214
        char    c_mode[8];
 
215
        char    c_uid[8];
 
216
        char    c_gid[8];
 
217
        char    c_nlink[8];
 
218
        char    c_mtime[8];
 
219
        char    c_filesize[8];
 
220
        char    c_devmajor[8];
 
221
        char    c_devminor[8];
 
222
        char    c_rdevmajor[8];
 
223
        char    c_rdevminor[8];
 
224
        char    c_namesize[8];
 
225
        char    c_check[8];
 
226
};
 
227
.Ed
 
228
.Pp
 
229
Except as specified below, the fields here match those specified
 
230
for the old binary format above.
 
231
.Bl -tag -width indent
 
232
.It Va magic
 
233
The string
 
234
.Dq 070701 .
 
235
.It Va check
 
236
This field is always set to zero by writers and ignored by readers.
 
237
See the next section for more details.
 
238
.El
 
239
.Pp
 
240
The pathname is followed by NUL bytes so that the total size
 
241
of the fixed header plus pathname is a multiple of four.
 
242
Likewise, the file data is padded to a multiple of four bytes.
 
243
Note that this format supports only 4 gigabyte files (unlike the
 
244
older ASCII format, which supports 8 gigabyte files).
 
245
.Pp
 
246
In this format, hardlinked files are handled by setting the
 
247
filesize to zero for each entry except the last one that
 
248
appears in the archive.
 
249
.Ss New CRC Format
 
250
The CRC format is identical to the new ASCII format described
 
251
in the previous section except that the magic field is set
 
252
to
 
253
.Dq 070702
 
254
and the
 
255
.Va check
 
256
field is set to the sum of all bytes in the file data.
 
257
This sum is computed treating all bytes as unsigned values
 
258
and using unsigned arithmetic.
 
259
Only the least-significant 32 bits of the sum are stored.
 
260
.Ss HP variants
 
261
The
 
262
.Nm cpio
 
263
implementation distributed with HPUX used XXXX but stored
 
264
device numbers differently XXX.
 
265
.Ss Other Extensions and Variants
 
266
Sun Solaris uses additional file types to store extended file
 
267
data, including ACLs and extended attributes, as special
 
268
entries in cpio archives.
 
269
.Pp
 
270
XXX Others? XXX
 
271
.Sh BUGS
 
272
The
 
273
.Dq CRC
 
274
format is mis-named, as it uses a simple checksum and
 
275
not a cyclic redundancy check.
 
276
.Pp
 
277
The old binary format is limited to 16 bits for user id,
 
278
group id, device, and inode numbers.
 
279
It is limited to 4 gigabyte file sizes.
 
280
.Pp
 
281
The old ASCII format is limited to 18 bits for
 
282
the user id, group id, device, and inode numbers.
 
283
It is limited to 8 gigabyte file sizes.
 
284
.Pp
 
285
The new ASCII format is limited to 4 gigabyte file sizes.
 
286
.Pp
 
287
None of the cpio formats store user or group names,
 
288
which are essential when moving files between systems with
 
289
dissimilar user or group numbering.
 
290
.Pp
 
291
Especially when writing older cpio variants, it may be necessary
 
292
to map actual device/inode values to synthesized values that
 
293
fit the available fields.
 
294
With very large filesystems, this may be necessary even for
 
295
the newer formats.
 
296
.Sh SEE ALSO
 
297
.Xr cpio 1 ,
 
298
.Xr tar 5
 
299
.Sh STANDARDS
 
300
The
 
301
.Nm cpio
 
302
utility is no longer a part of POSIX or the Single Unix Standard.
 
303
It last appeared in
 
304
.St -susv2 .
 
305
It has been supplanted in subsequent standards by
 
306
.Xr pax 1 .
 
307
The portable ASCII format is currently part of the specification for the
 
308
.Xr pax 1
 
309
utility.
 
310
.Sh HISTORY
 
311
The original cpio utility was written by Dick Haight
 
312
while working in AT&T's Unix Support Group.
 
313
It appeared in 1977 as part of PWB/UNIX 1.0, the
 
314
.Dq Programmer's Work Bench
 
315
derived from
 
316
.At v6
 
317
that was used internally at AT&T.
 
318
Both the old binary and old character formats were in use
 
319
by 1980, according to the System III source released
 
320
by SCO under their
 
321
.Dq Ancient Unix
 
322
license.
 
323
The character format was adopted as part of
 
324
.St -p1003.1-88 .
 
325
XXX when did "newc" appear?  Who invented it?  When did HP come out with their variant?  When did Sun introduce ACLs and extended attributes? XXX