1 /* vi: set sw=4 ts=4: */
3 * Mini cpio implementation for busybox
5 * Copyright (C) 2001 by Glenn McGrath
7 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
11 * Only supports new ASCII and CRC formats
14 //config: bool "cpio (14 kb)"
17 //config: cpio is an archival utility program used to create, modify, and
18 //config: extract contents from archives.
19 //config: cpio has 110 bytes of overheads for every stored file.
21 //config: This implementation of cpio can extract cpio archives created in the
22 //config: "newc" or "crc" format.
24 //config: Unless you have a specific application which requires cpio, you
25 //config: should probably say N here.
27 //config:config FEATURE_CPIO_O
28 //config: bool "Support archive creation"
30 //config: depends on CPIO
32 //config: This implementation of cpio can create cpio archives in the "newc"
33 //config: format only.
35 //config:config FEATURE_CPIO_P
36 //config: bool "Support passthrough mode"
38 //config: depends on FEATURE_CPIO_O
40 //config: Passthrough mode. Rarely used.
42 //applet:IF_CPIO(APPLET(cpio, BB_DIR_BIN, BB_SUID_DROP))
44 //kbuild:lib-$(CONFIG_CPIO) += cpio.o
46 //usage:#define cpio_trivial_usage
47 //usage: "[-dmvu] [-F FILE] [-R USER[:GRP]]" IF_FEATURE_CPIO_O(" [-H newc]")
48 //usage: " [-ti"IF_FEATURE_CPIO_O("o")"]" IF_FEATURE_CPIO_P(" [-p DIR]")
49 //usage: " [EXTR_FILE]..."
50 //usage:#define cpio_full_usage "\n\n"
51 //usage: "Extract (-i) or list (-t) files from a cpio archive"
52 //usage: IF_FEATURE_CPIO_O(", or"
53 //usage: "\ntake file list from stdin and create an archive (-o)"
54 //usage: IF_FEATURE_CPIO_P(" or copy files (-p)")
57 //usage: "\nMain operation mode:"
59 //usage: "\n -i Extract EXTR_FILEs (or all)"
60 //usage: IF_FEATURE_CPIO_O(
61 //usage: "\n -o Create (requires -H newc)"
63 //usage: IF_FEATURE_CPIO_P(
64 //usage: "\n -p DIR Copy files to DIR"
67 //usage: IF_FEATURE_CPIO_O(
68 //usage: "\n -H newc Archive format"
70 //usage: "\n -d Make leading directories"
71 //usage: "\n -m Preserve mtime"
72 //usage: "\n -v Verbose"
73 //usage: "\n -u Overwrite"
74 //usage: "\n -F FILE Input (-t,-i,-p) or output (-o) file"
75 //usage: "\n -R USER[:GRP] Set owner of created files"
76 //usage: "\n -L Dereference symlinks"
77 //usage: "\n -0 Input is separated by NULs"
79 /* GNU cpio 2.9 --help (abridged):
82 -t, --list List the archive
83 -i, --extract Extract files from an archive
84 -o, --create Create the archive
85 -p, --pass-through Copy-pass mode
87 Options valid in any mode:
88 --block-size=SIZE I/O block size = SIZE * 512 bytes
89 -B I/O block size = 5120 bytes
90 -c Use the old portable (ASCII) archive format
91 -C, --io-size=NUMBER I/O block size in bytes
92 -f, --nonmatching Only copy files that do not match given pattern
93 -F, --file=FILE Use FILE instead of standard input or output
94 -H, --format=FORMAT Use given archive FORMAT
95 -M, --message=STRING Print STRING when the end of a volume of the
96 backup media is reached
97 -n, --numeric-uid-gid If -v, show numeric UID and GID
98 --quiet Do not print the number of blocks copied
99 --rsh-command=COMMAND Use remote COMMAND instead of rsh
100 -v, --verbose Verbosely list the files processed
101 -V, --dot Print a "." for each file processed
102 -W, --warning=FLAG Control warning display: 'none','truncate','all';
103 multiple options accumulate
105 Options valid only in --extract mode:
106 -b, --swap Swap both halfwords of words and bytes of
107 halfwords in the data (equivalent to -sS)
108 -r, --rename Interactively rename files
109 -s, --swap-bytes Swap the bytes of each halfword in the files
110 -S, --swap-halfwords Swap the halfwords of each word (4 bytes)
111 --to-stdout Extract files to standard output
112 -E, --pattern-file=FILE Read additional patterns specifying filenames to
113 extract or list from FILE
114 --only-verify-crc Verify CRC's, don't actually extract the files
116 Options valid only in --create mode:
117 -A, --append Append to an existing archive
118 -O FILE File to use instead of standard output
120 Options valid only in --pass-through mode:
121 -l, --link Link files instead of copying them, when possible
123 Options valid in --extract and --create modes:
124 --absolute-filenames Do not strip file system prefix components from
126 --no-absolute-filenames Create all files relative to the current dir
128 Options valid in --create and --pass-through modes:
129 -0, --null A list of filenames is terminated by a NUL
130 -a, --reset-access-time Reset the access times of files after reading them
131 -I FILE File to use instead of standard input
132 -L, --dereference Dereference symbolic links (copy the files
133 that they point to instead of copying the links)
134 -R, --owner=[USER][:.][GRP] Set owner of created files
136 Options valid in --extract and --pass-through modes:
137 -d, --make-directories Create leading directories where needed
138 -m, --preserve-modification-time Retain mtime when creating files
139 --no-preserve-owner Do not change the ownership of the files
140 --sparse Write files with blocks of zeros as sparse files
141 -u, --unconditional Replace all files unconditionally
145 #include "common_bufsiz.h"
146 #include "bb_archive.h"
149 OPT_EXTRACT = (1 << 0),
151 OPT_NUL_TERMINATED = (1 << 2),
152 OPT_UNCONDITIONAL = (1 << 3),
153 OPT_VERBOSE = (1 << 4),
154 OPT_CREATE_LEADING_DIR = (1 << 5),
155 OPT_PRESERVE_MTIME = (1 << 6),
156 OPT_DEREF = (1 << 7),
158 OPT_OWNER = (1 << 9),
160 IF_FEATURE_CPIO_O(OPTBIT_CREATE ,)
161 IF_FEATURE_CPIO_O(OPTBIT_FORMAT ,)
162 IF_FEATURE_CPIO_P(OPTBIT_PASSTHROUGH,)
163 IF_LONG_OPTS( OPTBIT_QUIET ,)
164 IF_LONG_OPTS( OPTBIT_2STDOUT ,)
165 OPT_CREATE = IF_FEATURE_CPIO_O((1 << OPTBIT_CREATE )) + 0,
166 OPT_FORMAT = IF_FEATURE_CPIO_O((1 << OPTBIT_FORMAT )) + 0,
167 OPT_PASSTHROUGH = IF_FEATURE_CPIO_P((1 << OPTBIT_PASSTHROUGH)) + 0,
168 OPT_QUIET = IF_LONG_OPTS( (1 << OPTBIT_QUIET )) + 0,
169 OPT_2STDOUT = IF_LONG_OPTS( (1 << OPTBIT_2STDOUT )) + 0,
172 #define OPTION_STR "it0uvdmLF:R:"
175 struct bb_uidgid_t owner_ugid;
177 #define G (*(struct globals*)bb_common_bufsiz1)
178 void BUG_cpio_globals_too_big(void);
179 #define INIT_G() do { \
180 setup_common_bufsiz(); \
181 G.owner_ugid.uid = -1L; \
182 G.owner_ugid.gid = -1L; \
185 #if ENABLE_FEATURE_CPIO_O
186 static off_t cpio_pad4(off_t size)
197 /* Return value will become exit code.
198 * It's ok to exit instead of return. */
199 static NOINLINE int cpio_o(void)
206 struct inodes_s *next;
207 struct name_s *names;
211 struct inodes_s *links = NULL;
212 off_t bytes = 0; /* output bytes count */
219 line = (option_mask32 & OPT_NUL_TERMINATED)
220 ? bb_get_chunk_from_file(stdin, NULL)
221 : xmalloc_fgetline(stdin);
224 /* Strip leading "./[./]..." from the filename */
226 while (name[0] == '.' && name[1] == '/') {
227 while (*++name == '/')
230 if (!*name) { /* line is empty */
234 if ((option_mask32 & OPT_DEREF)
239 bb_simple_perror_msg_and_die(name);
242 if (G.owner_ugid.uid != (uid_t)-1L)
243 st.st_uid = G.owner_ugid.uid;
244 if (G.owner_ugid.gid != (gid_t)-1L)
245 st.st_gid = G.owner_ugid.gid;
247 if (!(S_ISLNK(st.st_mode) || S_ISREG(st.st_mode)))
248 st.st_size = 0; /* paranoia */
250 /* Store hardlinks for later processing, dont output them */
251 if (!S_ISDIR(st.st_mode) && st.st_nlink > 1) {
255 /* Do we have this hardlink remembered? */
259 /* Not found: add new item to "links" list */
260 l = xzalloc(sizeof(*l));
266 if (l->st.st_ino == st.st_ino) {
272 /* Add new name to "l->names" list */
273 n = xmalloc(sizeof(*n) + strlen(name));
274 strcpy(n->name, name);
281 } else { /* line == NULL: EOF */
284 /* Output hardlink's data */
286 name = links->names->name;
287 links->names = links->names->next;
288 /* GNU cpio is reported to emit file data
289 * only for the last instance. Mimic that. */
290 if (links->names == NULL)
294 /* NB: we leak links->names and/or links,
295 * this is intended (we exit soon anyway) */
297 /* If no (more) hardlinks to output,
298 * output "trailer" entry */
300 /* st.st_size == 0 is a must, but for uniformity
301 * in the output, we zero out everything */
302 memset(&st, 0, sizeof(st));
303 /* st.st_nlink = 1; - GNU cpio does this */
307 bytes += printf("070701"
308 "%08X%08X%08X%08X%08X%08X%08X"
309 "%08X%08X%08X%08X" /* GNU cpio uses uppercase hex */
310 /* strlen+1: */ "%08X"
311 /* chksum: */ "00000000" /* (only for "070702" files) */
312 /* name,NUL: */ "%s%c",
313 (unsigned)(uint32_t) st.st_ino,
314 (unsigned)(uint32_t) st.st_mode,
315 (unsigned)(uint32_t) st.st_uid,
316 (unsigned)(uint32_t) st.st_gid,
317 (unsigned)(uint32_t) st.st_nlink,
318 (unsigned)(uint32_t) st.st_mtime,
319 (unsigned)(uint32_t) st.st_size,
320 (unsigned)(uint32_t) major(st.st_dev),
321 (unsigned)(uint32_t) minor(st.st_dev),
322 (unsigned)(uint32_t) major(st.st_rdev),
323 (unsigned)(uint32_t) minor(st.st_rdev),
324 (unsigned)(strlen(name) + 1),
326 bytes = cpio_pad4(bytes);
329 if (S_ISLNK(st.st_mode)) {
330 char *lpath = xmalloc_readlink_or_warn(name);
333 bytes += printf("%s", lpath);
335 } else { /* S_ISREG */
336 int fd = xopen(name, O_RDONLY);
338 /* We must abort if file got shorter too! */
339 bb_copyfd_exact_size(fd, STDOUT_FILENO, st.st_size);
343 bytes = cpio_pad4(bytes);
347 if (name != cpio_TRAILER)
349 /* TODO: GNU cpio pads trailer to 512 bytes, do we want that? */
354 } /* end of "while (1)" */
358 int cpio_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
359 int cpio_main(int argc UNUSED_PARAM, char **argv)
361 archive_handle_t *archive_handle;
364 IF_FEATURE_CPIO_O(const char *cpio_fmt = "";)
367 const char *long_opts =
368 "extract\0" No_argument "i"
369 "list\0" No_argument "t"
370 #if ENABLE_FEATURE_CPIO_O
371 "create\0" No_argument "o"
372 "format\0" Required_argument "H"
373 #if ENABLE_FEATURE_CPIO_P
374 "pass-through\0" No_argument "p"
377 "owner\0" Required_argument "R"
378 "verbose\0" No_argument "v"
379 "null\0" No_argument "0"
380 "quiet\0" No_argument "\xff"
381 "to-stdout\0" No_argument "\xfe"
386 archive_handle = init_handle();
387 /* archive_handle->src_fd = STDIN_FILENO; - done by init_handle */
388 archive_handle->ah_flags = ARCHIVE_EXTRACT_NEWER;
390 /* As of now we do not enforce this: */
391 /* -i,-t,-o,-p are mutually exclusive */
392 /* -u,-d,-m make sense only with -i or -p */
393 /* -L makes sense only with -o or -p */
395 #if !ENABLE_FEATURE_CPIO_O
396 opt = getopt32long(argv, OPTION_STR, long_opts, &cpio_filename, &cpio_owner);
398 opt = getopt32long(argv, OPTION_STR "oH:" IF_FEATURE_CPIO_P("p"), long_opts,
399 &cpio_filename, &cpio_owner, &cpio_fmt);
402 if (opt & OPT_OWNER) { /* -R */
403 parse_chown_usergroup_or_die(&G.owner_ugid, cpio_owner);
404 archive_handle->cpio__owner = G.owner_ugid;
406 #if !ENABLE_FEATURE_CPIO_O
407 if (opt & OPT_FILE) { /* -F */
408 xmove_fd(xopen(cpio_filename, O_RDONLY), STDIN_FILENO);
411 if ((opt & (OPT_FILE|OPT_CREATE)) == OPT_FILE) { /* -F without -o */
412 xmove_fd(xopen(cpio_filename, O_RDONLY), STDIN_FILENO);
414 if (opt & OPT_PASSTHROUGH) {
420 if (opt & OPT_CREATE_LEADING_DIR)
421 mkdir(argv[0], 0777);
422 /* Crude existence check:
423 * close(xopen(argv[0], O_RDONLY | O_DIRECTORY));
424 * We can also xopen, fstat, IS_DIR, later fchdir.
425 * This would check for existence earlier and cleaner.
426 * As it stands now, if we fail xchdir later,
427 * child dies on EPIPE, unless it caught
428 * a diffrerent problem earlier.
429 * This is good enough for now.
442 pid = fork_or_rexec(argv - optind);
443 if (pid == 0) { /* child */
445 xmove_fd(pp.wr, STDOUT_FILENO);
449 USE_FOR_NOMMU(argv[-optind][0] &= 0x7f); /* undo fork_or_rexec() damage */
452 xmove_fd(pp.rd, STDIN_FILENO);
453 //opt &= ~OPT_PASSTHROUGH;
458 if (opt & OPT_CREATE) {
459 if (cpio_fmt[0] != 'n') /* we _require_ "-H newc" */
461 if (opt & OPT_FILE) {
462 xmove_fd(xopen(cpio_filename, O_WRONLY | O_CREAT | O_TRUNC), STDOUT_FILENO);
470 /* One of either extract or test options must be given */
471 if ((opt & (OPT_TEST | OPT_EXTRACT)) == 0) {
475 if (opt & OPT_TEST) {
476 /* if both extract and test options are given, ignore extract option */
478 archive_handle->action_header = header_list;
480 if (opt & OPT_EXTRACT) {
481 archive_handle->action_data = data_extract_all;
482 if (opt & OPT_2STDOUT)
483 archive_handle->action_data = data_extract_to_stdout;
485 if (opt & OPT_UNCONDITIONAL) {
486 archive_handle->ah_flags |= ARCHIVE_UNLINK_OLD;
487 archive_handle->ah_flags &= ~ARCHIVE_EXTRACT_NEWER;
489 if (opt & OPT_VERBOSE) {
490 if (archive_handle->action_header == header_list) {
491 archive_handle->action_header = header_verbose_list;
493 archive_handle->action_header = header_list;
496 if (opt & OPT_CREATE_LEADING_DIR) {
497 archive_handle->ah_flags |= ARCHIVE_CREATE_LEADING_DIRS;
499 if (opt & OPT_PRESERVE_MTIME) {
500 archive_handle->ah_flags |= ARCHIVE_RESTORE_DATE;
504 archive_handle->filter = filter_accept_list;
505 llist_add_to(&archive_handle->accept, *argv);
509 /* see get_header_cpio */
510 archive_handle->cpio__blocks = (off_t)-1;
511 while (get_header_cpio(archive_handle) == EXIT_SUCCESS)
514 create_links_from_list(archive_handle->link_placeholders);
516 if (archive_handle->cpio__blocks != (off_t)-1
517 && !(opt & OPT_QUIET)
519 fprintf(stderr, "%"OFF_FMT"u blocks\n", archive_handle->cpio__blocks);