1 /* vi: set sw=4 ts=4: */
3 * Mini tar implementation for busybox
5 * Modified to use common extraction code used by ar, cpio, dpkg-deb, dpkg
8 * Note, that as of BusyBox-0.43, tar has been completely rewritten from the
9 * ground up. It still has remnants of the old code lying about, but it is
10 * very different now (i.e., cleaner, less global variables, etc.)
12 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
14 * Based in part in the tar implementation in sash
15 * Copyright (c) 1999 by David I. Bell
16 * Permission is granted to use, distribute, or modify this source,
17 * provided that this copyright notice remains intact.
18 * Permission to distribute sash derived code under GPL has been granted.
20 * Based in part on the tar implementation from busybox-0.28
21 * Copyright (C) 1995 Bruce Perens
23 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
27 //config: bool "tar (40 kb)"
30 //config: tar is an archiving program. It's commonly used with gzip to
31 //config: create compressed archives. It's probably the most widely used
32 //config: UNIX archive program.
34 //config:config FEATURE_TAR_LONG_OPTIONS
35 //config: bool "Enable long options"
37 //config: depends on TAR && LONG_OPTS
39 //config:config FEATURE_TAR_CREATE
40 //config: bool "Enable -c (archive creation)"
42 //config: depends on TAR
44 //config:config FEATURE_TAR_AUTODETECT
45 //config: bool "Autodetect compressed tarballs"
47 //config: depends on TAR && (FEATURE_SEAMLESS_Z || FEATURE_SEAMLESS_GZ || FEATURE_SEAMLESS_BZ2 || FEATURE_SEAMLESS_LZMA || FEATURE_SEAMLESS_XZ)
49 //config: With this option tar can automatically detect compressed
50 //config: tarballs. Currently it works only on files (not pipes etc).
52 //config:config FEATURE_TAR_FROM
53 //config: bool "Enable -X (exclude from) and -T (include from) options)"
55 //config: depends on TAR
57 //config: If you enable this option you'll be able to specify
58 //config: a list of files to include or exclude from an archive.
60 //config:config FEATURE_TAR_OLDGNU_COMPATIBILITY
61 //config: bool "Support old tar header format"
63 //config: depends on TAR || DPKG
65 //config: This option is required to unpack archives created in
66 //config: the old GNU format; help to kill this old format by
67 //config: repacking your ancient archives with the new format.
69 //config:config FEATURE_TAR_OLDSUN_COMPATIBILITY
70 //config: bool "Enable untarring of tarballs with checksums produced by buggy Sun tar"
72 //config: depends on TAR || DPKG
74 //config: This option is required to unpack archives created by some old
75 //config: version of Sun's tar (it was calculating checksum using signed
76 //config: arithmetic). It is said to be fixed in newer Sun tar, but "old"
77 //config: tarballs still exist.
79 //config:config FEATURE_TAR_GNU_EXTENSIONS
80 //config: bool "Support GNU tar extensions (long filenames)"
82 //config: depends on TAR || DPKG
84 //config:config FEATURE_TAR_TO_COMMAND
85 //config: bool "Support writing to an external program (--to-command)"
87 //config: depends on TAR && FEATURE_TAR_LONG_OPTIONS
89 //config: If you enable this option you'll be able to instruct tar to send
90 //config: the contents of each extracted file to the standard input of an
91 //config: external program.
93 //config:config FEATURE_TAR_UNAME_GNAME
94 //config: bool "Enable use of user and group names"
96 //config: depends on TAR
98 //config: Enable use of user and group names in tar. This affects contents
99 //config: listings (-t) and preserving permissions when unpacking (-p).
100 //config: +200 bytes.
102 //config:config FEATURE_TAR_NOPRESERVE_TIME
103 //config: bool "Enable -m (do not preserve time) GNU option"
105 //config: depends on TAR
107 //config:config FEATURE_TAR_SELINUX
108 //config: bool "Support extracting SELinux labels"
110 //config: depends on TAR && SELINUX
112 //config: With this option busybox supports restoring SELinux labels
113 //config: when extracting files from tar archives.
115 //applet:IF_TAR(APPLET(tar, BB_DIR_BIN, BB_SUID_DROP))
116 //kbuild:lib-$(CONFIG_TAR) += tar.o
120 #include "common_bufsiz.h"
121 #include "bb_archive.h"
122 /* FIXME: Stop using this non-standard feature */
123 #ifndef FNM_LEADING_DIR
124 # define FNM_LEADING_DIR 0
128 # define DBG(fmt, ...) bb_error_msg("%s: " fmt, __func__, ## __VA_ARGS__)
130 # define DBG(...) ((void)0)
132 #define DBG_OPTION_PARSING 0
135 #define block_buf bb_common_bufsiz1
136 #define INIT_G() do { setup_common_bufsiz(); } while (0)
139 #if ENABLE_FEATURE_TAR_CREATE
142 ** writeTarFile(), writeFileToTarball(), and writeTarHeader() are
143 ** the only functions that deal with the HardLinkInfo structure.
144 ** Even these functions use the xxxHardLinkInfo() functions.
146 typedef struct HardLinkInfo {
147 struct HardLinkInfo *next; /* Next entry in list */
148 dev_t dev; /* Device number */
149 ino_t ino; /* Inode number */
150 // short linkCount; /* (Hard) Link Count */
151 char name[1]; /* Start of filename (must be last) */
154 /* Some info to be carried along when creating a new tarball */
155 typedef struct TarBallInfo {
156 int tarFd; /* Open-for-write file descriptor
158 int verboseFlag; /* Whether to print extra stuff or not */
159 const llist_t *excludeList; /* List of files to not include */
160 HardLinkInfo *hlInfoHead; /* Hard Link Tracking Information */
161 HardLinkInfo *hlInfo; /* Hard Link Info for the current file */
162 //TODO: save only st_dev + st_ino
163 struct stat tarFileStatBuf; /* Stat info for the tarball, letting
164 * us know the inode and device that the
165 * tarball lives, so we can avoid trying
166 * to include the tarball into itself */
169 /* A nice enum with all the possible tar file content types */
171 REGTYPE = '0', /* regular file */
172 REGTYPE0 = '\0', /* regular file (ancient bug compat) */
173 LNKTYPE = '1', /* hard link */
174 SYMTYPE = '2', /* symbolic link */
175 CHRTYPE = '3', /* character special */
176 BLKTYPE = '4', /* block special */
177 DIRTYPE = '5', /* directory */
178 FIFOTYPE = '6', /* FIFO special */
179 CONTTYPE = '7', /* reserved */
180 GNULONGLINK = 'K', /* GNU long (>100 chars) link name */
181 GNULONGNAME = 'L', /* GNU long (>100 chars) file name */
184 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
185 static void addHardLinkInfo(HardLinkInfo **hlInfoHeadPtr,
186 struct stat *statbuf,
187 const char *fileName)
189 /* Note: hlInfoHeadPtr can never be NULL! */
190 HardLinkInfo *hlInfo;
192 hlInfo = xmalloc(sizeof(HardLinkInfo) + strlen(fileName));
193 hlInfo->next = *hlInfoHeadPtr;
194 *hlInfoHeadPtr = hlInfo;
195 hlInfo->dev = statbuf->st_dev;
196 hlInfo->ino = statbuf->st_ino;
197 // hlInfo->linkCount = statbuf->st_nlink;
198 strcpy(hlInfo->name, fileName);
201 static void freeHardLinkInfo(HardLinkInfo **hlInfoHeadPtr)
203 HardLinkInfo *hlInfo;
204 HardLinkInfo *hlInfoNext;
207 hlInfo = *hlInfoHeadPtr;
209 hlInfoNext = hlInfo->next;
213 *hlInfoHeadPtr = NULL;
217 /* Might be faster (and bigger) if the dev/ino were stored in numeric order ;) */
218 static HardLinkInfo *findHardLinkInfo(HardLinkInfo *hlInfo, struct stat *statbuf)
221 if (statbuf->st_ino == hlInfo->ino
222 && statbuf->st_dev == hlInfo->dev
224 DBG("found hardlink:'%s'", hlInfo->name);
227 hlInfo = hlInfo->next;
232 /* Put an octal string into the specified buffer.
233 * The number is zero padded and possibly null terminated.
234 * Stores low-order bits only if whole value does not fit. */
235 static void putOctal(char *cp, int len, off_t value)
237 char tempBuffer[sizeof(off_t)*3 + 1];
238 char *tempString = tempBuffer;
241 width = sprintf(tempBuffer, "%0*"OFF_FMT"o", len, value);
242 tempString += (width - len);
244 /* If string has leading zeroes, we can drop one */
245 /* and field will have trailing '\0' */
246 /* (increases chances of compat with other tars) */
247 if (tempString[0] == '0')
250 /* Copy the string to the field */
251 memcpy(cp, tempString, len);
253 #define PUT_OCTAL(a, b) putOctal((a), sizeof(a), (b))
255 static void chksum_and_xwrite(int fd, struct tar_header_t* hp)
257 /* POSIX says that checksum is done on unsigned bytes
258 * (Sun and HP-UX gets it wrong... more details in
260 const unsigned char *cp;
263 strcpy(hp->magic, "ustar ");
265 /* Calculate and store the checksum (i.e., the sum of all of the bytes of
266 * the header). The checksum field must be filled with blanks for the
267 * calculation. The checksum field is formatted differently from the
268 * other fields: it has 6 digits, a null, then a space -- rather than
269 * digits, followed by a null like the other fields... */
270 memset(hp->chksum, ' ', sizeof(hp->chksum));
271 cp = (const unsigned char *) hp;
274 do { chksum += *cp++; } while (--size);
275 putOctal(hp->chksum, sizeof(hp->chksum)-1, chksum);
277 /* Now write the header out to disk */
278 xwrite(fd, hp, sizeof(*hp));
281 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
282 static void writeLongname(int fd, int type, const char *name, int dir)
284 static const struct {
285 char mode[8]; /* 100-107 */
286 char uid[8]; /* 108-115 */
287 char gid[8]; /* 116-123 */
288 char size[12]; /* 124-135 */
289 char mtime[12]; /* 136-147 */
297 struct tar_header_t header;
300 dir = !!dir; /* normalize: 0/1 */
301 size = strlen(name) + 1 + dir; /* GNU tar uses strlen+1 */
302 /* + dir: account for possible '/' */
304 memset(&header, 0, sizeof(header));
305 strcpy(header.name, "././@LongLink");
306 memcpy(header.mode, prefilled.mode, sizeof(prefilled));
307 PUT_OCTAL(header.size, size);
308 header.typeflag = type;
309 chksum_and_xwrite(fd, &header);
311 /* Write filename[/] and pad the block. */
312 /* dir=0: writes 'name<NUL>', pads */
313 /* dir=1: writes 'name', writes '/<NUL>', pads */
315 xwrite(fd, name, size - dir);
316 xwrite(fd, "/", dir);
317 size = (-size) & (TAR_BLOCK_SIZE-1);
318 memset(&header, 0, size);
319 xwrite(fd, &header, size);
323 /* Write out a tar header for the specified file/directory/whatever */
324 static int writeTarHeader(struct TarBallInfo *tbInfo,
325 const char *header_name, const char *fileName, struct stat *statbuf)
327 struct tar_header_t header;
329 memset(&header, 0, sizeof(header));
331 strncpy(header.name, header_name, sizeof(header.name));
333 /* POSIX says to mask mode with 07777. */
334 PUT_OCTAL(header.mode, statbuf->st_mode & 07777);
335 PUT_OCTAL(header.uid, statbuf->st_uid);
336 PUT_OCTAL(header.gid, statbuf->st_gid);
337 memset(header.size, '0', sizeof(header.size)-1); /* Regular file size is handled later */
338 /* users report that files with negative st_mtime cause trouble, so: */
339 PUT_OCTAL(header.mtime, statbuf->st_mtime >= 0 ? statbuf->st_mtime : 0);
341 /* Enter the user and group names */
342 safe_strncpy(header.uname, get_cached_username(statbuf->st_uid), sizeof(header.uname));
343 safe_strncpy(header.gname, get_cached_groupname(statbuf->st_gid), sizeof(header.gname));
345 if (tbInfo->hlInfo) {
346 /* This is a hard link */
347 header.typeflag = LNKTYPE;
348 strncpy(header.linkname, tbInfo->hlInfo->name,
349 sizeof(header.linkname));
350 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
351 /* Write out long linkname if needed */
352 if (header.linkname[sizeof(header.linkname)-1])
353 writeLongname(tbInfo->tarFd, GNULONGLINK,
354 tbInfo->hlInfo->name, 0);
356 } else if (S_ISLNK(statbuf->st_mode)) {
357 char *lpath = xmalloc_readlink_or_warn(fileName);
360 header.typeflag = SYMTYPE;
361 strncpy(header.linkname, lpath, sizeof(header.linkname));
362 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
363 /* Write out long linkname if needed */
364 if (header.linkname[sizeof(header.linkname)-1])
365 writeLongname(tbInfo->tarFd, GNULONGLINK, lpath, 0);
367 /* If it is larger than 100 bytes, bail out */
368 if (header.linkname[sizeof(header.linkname)-1]) {
370 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
375 } else if (S_ISDIR(statbuf->st_mode)) {
376 header.typeflag = DIRTYPE;
377 /* Append '/' only if there is a space for it */
378 if (!header.name[sizeof(header.name)-1])
379 header.name[strlen(header.name)] = '/';
380 } else if (S_ISCHR(statbuf->st_mode)) {
381 header.typeflag = CHRTYPE;
382 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
383 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
384 } else if (S_ISBLK(statbuf->st_mode)) {
385 header.typeflag = BLKTYPE;
386 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
387 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
388 } else if (S_ISFIFO(statbuf->st_mode)) {
389 header.typeflag = FIFOTYPE;
390 } else if (S_ISREG(statbuf->st_mode)) {
391 /* header.size field is 12 bytes long */
392 /* Does octal-encoded size fit? */
393 uoff_t filesize = statbuf->st_size;
394 if (sizeof(filesize) <= 4
395 || filesize <= (uoff_t)0777777777777LL
397 PUT_OCTAL(header.size, filesize);
399 /* Does base256-encoded size fit?
400 * It always does unless off_t is wider than 64 bits.
402 else if (ENABLE_FEATURE_TAR_GNU_EXTENSIONS
403 #if ULLONG_MAX > 0xffffffffffffffffLL /* 2^64-1 */
404 && (filesize <= 0x3fffffffffffffffffffffffLL)
407 /* GNU tar uses "base-256 encoding" for very large numbers.
408 * Encoding is binary, with highest bit always set as a marker
409 * and sign in next-highest bit:
411 * bf ff .. ff - largest positive number
412 * ff ff .. ff - minus 1
413 * c0 00 .. 00 - smallest negative number
415 char *p8 = header.size + sizeof(header.size);
417 *--p8 = (uint8_t)filesize;
419 } while (p8 != header.size);
422 bb_error_msg_and_die("can't store file '%s' "
423 "of size %"OFF_FMT"u, aborting",
424 fileName, statbuf->st_size);
426 header.typeflag = REGTYPE;
428 bb_error_msg("%s: unknown file type", fileName);
432 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
433 /* Write out long name if needed */
434 /* (we, like GNU tar, output long linkname *before* long name) */
435 if (header.name[sizeof(header.name)-1])
436 writeLongname(tbInfo->tarFd, GNULONGNAME,
437 header_name, S_ISDIR(statbuf->st_mode));
440 /* Now write the header out to disk */
441 chksum_and_xwrite(tbInfo->tarFd, &header);
443 /* Now do the verbose thing (or not) */
444 if (tbInfo->verboseFlag) {
447 /* If archive goes to stdout, verbose goes to stderr */
448 if (tbInfo->tarFd == STDOUT_FILENO)
450 /* GNU "tar cvvf" prints "extended" listing a-la "ls -l" */
451 /* We don't have such excesses here: for us "v" == "vv" */
452 /* '/' is probably a GNUism */
453 fprintf(vbFd, "%s%s\n", header_name,
454 S_ISDIR(statbuf->st_mode) ? "/" : "");
460 #if ENABLE_FEATURE_TAR_FROM
461 static int exclude_file(const llist_t *excluded_files, const char *file)
463 while (excluded_files) {
464 if (excluded_files->data[0] == '/') {
465 if (fnmatch(excluded_files->data, file,
466 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
471 for (p = file; p[0] != '\0'; p++) {
472 if ((p == file || p[-1] == '/')
474 && fnmatch(excluded_files->data, p,
475 FNM_PATHNAME | FNM_LEADING_DIR) == 0
481 excluded_files = excluded_files->link;
487 # define exclude_file(excluded_files, file) 0
490 static int FAST_FUNC writeFileToTarball(const char *fileName, struct stat *statbuf,
491 void *userData, int depth UNUSED_PARAM)
493 struct TarBallInfo *tbInfo = (struct TarBallInfo *) userData;
494 const char *header_name;
495 int inputFileFd = -1;
497 DBG("writeFileToTarball('%s')", fileName);
499 /* Strip leading '/' and such (must be before memorizing hardlink's name) */
500 header_name = strip_unsafe_prefix(fileName);
502 if (header_name[0] == '\0')
505 /* It is against the rules to archive a socket */
506 if (S_ISSOCK(statbuf->st_mode)) {
507 bb_error_msg("%s: socket ignored", fileName);
512 * Check to see if we are dealing with a hard link.
514 * Treat the first occurrence of a given dev/inode as a file while
515 * treating any additional occurrences as hard links. This is done
516 * by adding the file information to the HardLinkInfo linked list.
518 tbInfo->hlInfo = NULL;
519 if (!S_ISDIR(statbuf->st_mode) && statbuf->st_nlink > 1) {
520 DBG("'%s': st_nlink > 1", header_name);
521 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf);
522 if (tbInfo->hlInfo == NULL) {
523 DBG("'%s': addHardLinkInfo", header_name);
524 addHardLinkInfo(&tbInfo->hlInfoHead, statbuf, header_name);
528 /* It is a bad idea to store the archive we are in the process of creating,
529 * so check the device and inode to be sure that this particular file isn't
531 if (tbInfo->tarFileStatBuf.st_dev == statbuf->st_dev
532 && tbInfo->tarFileStatBuf.st_ino == statbuf->st_ino
534 bb_error_msg("%s: file is the archive; skipping", fileName);
538 if (exclude_file(tbInfo->excludeList, header_name))
541 #if !ENABLE_FEATURE_TAR_GNU_EXTENSIONS
542 if (strlen(header_name) >= NAME_SIZE) {
543 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
548 /* Is this a regular file? */
549 if (tbInfo->hlInfo == NULL && S_ISREG(statbuf->st_mode)) {
550 /* open the file we want to archive, and make sure all is well */
551 inputFileFd = open_or_warn(fileName, O_RDONLY);
552 if (inputFileFd < 0) {
557 /* Add an entry to the tarball */
558 if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
562 /* If it was a regular file, write out the body */
563 if (inputFileFd >= 0) {
565 /* Write the file to the archive. */
566 /* We record size into header first, */
567 /* and then write out file. If file shrinks in between, */
568 /* tar will be corrupted. So we don't allow for that. */
569 /* NB: GNU tar 1.16 warns and pads with zeroes */
570 /* or even seeks back and updates header */
571 bb_copyfd_exact_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
573 ////readSize = bb_copyfd_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
574 ////if (readSize != statbuf->st_size && readSize >= 0) {
575 //// bb_error_msg_and_die("short read from %s, aborting", fileName);
578 /* Check that file did not grow in between? */
579 /* if (safe_read(inputFileFd, 1) == 1) warn but continue? */
583 /* Pad the file up to the tar block size */
584 /* (a few tricks here in the name of code size) */
585 readSize = (-(int)statbuf->st_size) & (TAR_BLOCK_SIZE-1);
586 memset(block_buf, 0, readSize);
587 xwrite(tbInfo->tarFd, block_buf, readSize);
593 #if SEAMLESS_COMPRESSION
594 /* Don't inline: vfork scares gcc and pessimizes code */
595 static void NOINLINE vfork_compressor(int tar_fd, const char *gzip)
599 // On Linux, vfork never unpauses parent early, although standard
600 // allows for that. Do we want to waste bytes checking for it?
601 # define WAIT_FOR_CHILD 0
602 volatile int vfork_exec_errno = 0;
603 struct fd_pair gzipDataPipe;
605 struct fd_pair gzipStatusPipe;
606 xpiped_pair(gzipStatusPipe);
608 xpiped_pair(gzipDataPipe);
610 signal(SIGPIPE, SIG_IGN); /* we only want EPIPE on errors */
616 /* NB: close _first_, then move fds! */
617 close(gzipDataPipe.wr);
619 close(gzipStatusPipe.rd);
620 /* gzipStatusPipe.wr will close only on exec -
621 * parent waits for this close to happen */
622 fcntl(gzipStatusPipe.wr, F_SETFD, FD_CLOEXEC);
624 xmove_fd(gzipDataPipe.rd, 0);
626 /* exec gzip/bzip2 program/applet */
627 BB_EXECLP(gzip, gzip, "-f", (char *)0);
628 vfork_exec_errno = errno;
633 xmove_fd(gzipDataPipe.wr, tar_fd);
634 close(gzipDataPipe.rd);
636 close(gzipStatusPipe.wr);
641 /* Wait until child execs (or fails to) */
642 n = full_read(gzipStatusPipe.rd, &buf, 1);
643 if (n < 0 /* && errno == EAGAIN */)
644 continue; /* try it again */
646 close(gzipStatusPipe.rd);
648 if (vfork_exec_errno) {
649 errno = vfork_exec_errno;
650 bb_perror_msg_and_die("can't execute '%s'", gzip);
653 #endif /* SEAMLESS_COMPRESSION */
656 #if !SEAMLESS_COMPRESSION
657 /* Do not pass gzip flag to writeTarFile() */
658 #define writeTarFile(tar_fd, verboseFlag, recurseFlags, include, exclude, gzip) \
659 writeTarFile(tar_fd, verboseFlag, recurseFlags, include, exclude)
661 /* gcc 4.2.1 inlines it, making code bigger */
662 static NOINLINE int writeTarFile(int tar_fd, int verboseFlag,
663 int recurseFlags, const llist_t *include,
664 const llist_t *exclude, const char *gzip)
666 int errorFlag = FALSE;
667 struct TarBallInfo tbInfo;
669 tbInfo.hlInfoHead = NULL;
670 tbInfo.tarFd = tar_fd;
671 tbInfo.verboseFlag = verboseFlag;
673 /* Store the stat info for the tarball's file, so
674 * can avoid including the tarball into itself.... */
675 xfstat(tbInfo.tarFd, &tbInfo.tarFileStatBuf, "can't stat tar file");
677 #if SEAMLESS_COMPRESSION
679 vfork_compressor(tbInfo.tarFd, gzip);
682 tbInfo.excludeList = exclude;
684 /* Read the directory/files and iterate over them one at a time */
686 if (!recursive_action(include->data, recurseFlags,
687 writeFileToTarball, writeFileToTarball, &tbInfo, 0)
691 include = include->link;
693 /* Write two empty blocks to the end of the archive */
694 memset(block_buf, 0, 2*TAR_BLOCK_SIZE);
695 xwrite(tbInfo.tarFd, block_buf, 2*TAR_BLOCK_SIZE);
697 /* To be pedantically correct, we would check if the tarball
698 * is smaller than 20 tar blocks, and pad it if it was smaller,
699 * but that isn't necessary for GNU tar interoperability, and
700 * so is considered a waste of space */
702 /* Close so the child process (if any) will exit */
705 /* Hang up the tools, close up shop, head home */
706 if (ENABLE_FEATURE_CLEAN_UP)
707 freeHardLinkInfo(&tbInfo.hlInfoHead);
710 bb_error_msg("error exit delayed from previous errors");
712 #if SEAMLESS_COMPRESSION
715 if (safe_waitpid(-1, &status, 0) == -1)
716 bb_perror_msg("waitpid");
717 else if (!WIFEXITED(status) || WEXITSTATUS(status))
718 /* gzip was killed or has exited with nonzero! */
724 #else /* !FEATURE_TAR_CREATE */
725 # define writeTarFile(...) 0
728 #if ENABLE_FEATURE_TAR_FROM
729 static llist_t *append_file_list_to_list(llist_t *list)
733 llist_t *newlist = NULL;
736 src_stream = xfopen_stdin(llist_pop(&list));
737 while ((line = xmalloc_fgetline(src_stream)) != NULL) {
738 /* kill trailing '/' unless the string is just "/" */
739 char *cp = last_char_is(line, '/');
742 llist_add_to_end(&newlist, line);
750 //usage:#define tar_trivial_usage
751 //usage: "-[" IF_FEATURE_TAR_CREATE("c") "xt"
752 //usage: IF_FEATURE_SEAMLESS_Z("Z")
753 //usage: IF_FEATURE_SEAMLESS_GZ("z")
754 //usage: IF_FEATURE_SEAMLESS_XZ("J")
755 //usage: IF_FEATURE_SEAMLESS_BZ2("j")
756 //usage: IF_FEATURE_SEAMLESS_LZMA("a")
757 //usage: IF_FEATURE_TAR_CREATE("h")
758 //usage: IF_FEATURE_TAR_NOPRESERVE_TIME("m")
760 //usage: IF_FEATURE_TAR_FROM("[-X FILE] [-T FILE] ")
761 //usage: "[-f TARFILE] [-C DIR] [FILE]..."
762 //usage:#define tar_full_usage "\n\n"
763 //usage: IF_FEATURE_TAR_CREATE("Create, extract, ")
764 //usage: IF_NOT_FEATURE_TAR_CREATE("Extract ")
765 //usage: "or list files from a tar file\n"
766 //usage: "\nOperation:"
767 //usage: IF_FEATURE_TAR_CREATE(
768 //usage: "\n c Create"
770 //usage: "\n x Extract"
772 //usage: "\n f Name of TARFILE ('-' for stdin/out)"
773 //usage: "\n C Change to DIR before operation"
774 //usage: "\n v Verbose"
775 //usage: IF_FEATURE_SEAMLESS_Z(
776 //usage: "\n Z (De)compress using compress"
778 //usage: IF_FEATURE_SEAMLESS_GZ(
779 //usage: "\n z (De)compress using gzip"
781 //usage: IF_FEATURE_SEAMLESS_XZ(
782 //usage: "\n J (De)compress using xz"
784 //usage: IF_FEATURE_SEAMLESS_BZ2(
785 //usage: "\n j (De)compress using bzip2"
787 //usage: IF_FEATURE_SEAMLESS_LZMA(
788 //usage: "\n a (De)compress using lzma"
790 //usage: "\n O Extract to stdout"
791 //usage: IF_FEATURE_TAR_CREATE(
792 //usage: "\n h Follow symlinks"
794 //usage: IF_FEATURE_TAR_NOPRESERVE_TIME(
795 //usage: "\n m Don't restore mtime"
797 //usage: IF_FEATURE_TAR_FROM(
798 //usage: IF_FEATURE_TAR_LONG_OPTIONS(
799 //usage: "\n exclude File to exclude"
801 //usage: "\n X File with names to exclude"
802 //usage: "\n T File with names to include"
805 //usage:#define tar_example_usage
806 //usage: "$ zcat /tmp/tarball.tar.gz | tar -xf -\n"
807 //usage: "$ tar -cf /tmp/tarball.tar /usr/local\n"
809 // Supported but aren't in --help:
811 // p same-permissions
815 // no-same-permissions
817 //IF_FEATURE_TAR_TO_COMMAND(
823 IF_FEATURE_TAR_CREATE( OPTBIT_CREATE ,)
824 IF_FEATURE_TAR_CREATE( OPTBIT_DEREFERENCE ,)
825 IF_FEATURE_SEAMLESS_BZ2( OPTBIT_BZIP2 ,)
826 IF_FEATURE_SEAMLESS_LZMA(OPTBIT_LZMA ,)
827 IF_FEATURE_TAR_FROM( OPTBIT_INCLUDE_FROM,)
828 IF_FEATURE_TAR_FROM( OPTBIT_EXCLUDE_FROM,)
829 IF_FEATURE_SEAMLESS_GZ( OPTBIT_GZIP ,)
830 IF_FEATURE_SEAMLESS_XZ( OPTBIT_XZ ,) // 16th bit
831 IF_FEATURE_SEAMLESS_Z( OPTBIT_COMPRESS ,)
832 IF_FEATURE_TAR_NOPRESERVE_TIME(OPTBIT_NOPRESERVE_TIME,)
833 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
834 OPTBIT_STRIP_COMPONENTS,
836 IF_FEATURE_TAR_TO_COMMAND(OPTBIT_2COMMAND ,)
837 OPTBIT_NUMERIC_OWNER,
838 OPTBIT_NOPRESERVE_PERM,
841 OPT_TEST = 1 << 0, // t
842 OPT_EXTRACT = 1 << 1, // x
843 OPT_BASEDIR = 1 << 2, // C
844 OPT_TARNAME = 1 << 3, // f
845 OPT_2STDOUT = 1 << 4, // O
846 OPT_NOPRESERVE_OWNER = 1 << 5, // o == no-same-owner
848 OPT_VERBOSE = 1 << 7, // v
849 OPT_KEEP_OLD = 1 << 8, // k
850 OPT_CREATE = IF_FEATURE_TAR_CREATE( (1 << OPTBIT_CREATE )) + 0, // c
851 OPT_DEREFERENCE = IF_FEATURE_TAR_CREATE( (1 << OPTBIT_DEREFERENCE )) + 0, // h
852 OPT_BZIP2 = IF_FEATURE_SEAMLESS_BZ2( (1 << OPTBIT_BZIP2 )) + 0, // j
853 OPT_LZMA = IF_FEATURE_SEAMLESS_LZMA((1 << OPTBIT_LZMA )) + 0, // a
854 OPT_INCLUDE_FROM = IF_FEATURE_TAR_FROM( (1 << OPTBIT_INCLUDE_FROM)) + 0, // T
855 OPT_EXCLUDE_FROM = IF_FEATURE_TAR_FROM( (1 << OPTBIT_EXCLUDE_FROM)) + 0, // X
856 OPT_GZIP = IF_FEATURE_SEAMLESS_GZ( (1 << OPTBIT_GZIP )) + 0, // z
857 OPT_XZ = IF_FEATURE_SEAMLESS_XZ( (1 << OPTBIT_XZ )) + 0, // J
858 OPT_COMPRESS = IF_FEATURE_SEAMLESS_Z( (1 << OPTBIT_COMPRESS )) + 0, // Z
859 OPT_NOPRESERVE_TIME = IF_FEATURE_TAR_NOPRESERVE_TIME((1 << OPTBIT_NOPRESERVE_TIME)) + 0, // m
860 OPT_STRIP_COMPONENTS = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_STRIP_COMPONENTS)) + 0, // strip-components
861 OPT_NORECURSION = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_NORECURSION )) + 0, // no-recursion
862 OPT_2COMMAND = IF_FEATURE_TAR_TO_COMMAND( (1 << OPTBIT_2COMMAND )) + 0, // to-command
863 OPT_NUMERIC_OWNER = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_NUMERIC_OWNER )) + 0, // numeric-owner
864 OPT_NOPRESERVE_PERM = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_NOPRESERVE_PERM)) + 0, // no-same-permissions
865 OPT_OVERWRITE = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_OVERWRITE )) + 0, // overwrite
867 OPT_ANY_COMPRESS = (OPT_BZIP2 | OPT_LZMA | OPT_GZIP | OPT_XZ | OPT_COMPRESS),
869 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
870 static const char tar_longopts[] ALIGN1 =
871 "list\0" No_argument "t"
872 "extract\0" No_argument "x"
873 "directory\0" Required_argument "C"
874 "file\0" Required_argument "f"
875 "to-stdout\0" No_argument "O"
876 /* do not restore owner */
877 /* Note: GNU tar handles 'o' as no-same-owner only on extract,
878 * on create, 'o' is --old-archive. We do not support --old-archive. */
879 "no-same-owner\0" No_argument "o"
880 "same-permissions\0" No_argument "p"
881 "verbose\0" No_argument "v"
882 "keep-old\0" No_argument "k"
883 # if ENABLE_FEATURE_TAR_CREATE
884 "create\0" No_argument "c"
885 "dereference\0" No_argument "h"
887 # if ENABLE_FEATURE_SEAMLESS_BZ2
888 "bzip2\0" No_argument "j"
890 # if ENABLE_FEATURE_SEAMLESS_LZMA
891 "lzma\0" No_argument "a"
893 # if ENABLE_FEATURE_TAR_FROM
894 "files-from\0" Required_argument "T"
895 "exclude-from\0" Required_argument "X"
897 # if ENABLE_FEATURE_SEAMLESS_GZ
898 "gzip\0" No_argument "z"
900 # if ENABLE_FEATURE_SEAMLESS_XZ
901 "xz\0" No_argument "J"
903 # if ENABLE_FEATURE_SEAMLESS_Z
904 "compress\0" No_argument "Z"
906 # if ENABLE_FEATURE_TAR_NOPRESERVE_TIME
907 "touch\0" No_argument "m"
909 "strip-components\0" Required_argument "\xf9"
910 "no-recursion\0" No_argument "\xfa"
911 # if ENABLE_FEATURE_TAR_TO_COMMAND
912 "to-command\0" Required_argument "\xfb"
914 /* use numeric uid/gid from tar header, not textual */
915 "numeric-owner\0" No_argument "\xfc"
916 /* do not restore mode */
917 "no-same-permissions\0" No_argument "\xfd"
918 /* on unpack, open with O_TRUNC and !O_EXCL */
919 "overwrite\0" No_argument "\xfe"
920 /* --exclude takes next bit position in option mask, */
921 /* therefore we have to put it _after_ --no-same-permissions */
922 # if ENABLE_FEATURE_TAR_FROM
923 "exclude\0" Required_argument "\xff"
926 # define GETOPT32 getopt32long
927 # define LONGOPTS ,tar_longopts
929 # define GETOPT32 getopt32
933 int tar_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
934 int tar_main(int argc UNUSED_PARAM, char **argv)
936 archive_handle_t *tar_handle;
937 char *base_dir = NULL;
938 const char *tar_filename = "-";
941 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
942 llist_t *excludes = NULL;
946 /* Initialise default values */
947 tar_handle = init_handle();
948 tar_handle->ah_flags = ARCHIVE_CREATE_LEADING_DIRS
949 | ARCHIVE_RESTORE_DATE
950 | ARCHIVE_UNLINK_OLD;
952 /* Apparently only root's tar preserves perms (see bug 3844) */
954 tar_handle->ah_flags |= ARCHIVE_DONT_RESTORE_PERM;
957 /* Lie to buildroot when it starts asking stupid questions. */
958 if (argv[1] && strcmp(argv[1], "--version") == 0) {
959 // Output of 'tar --version' examples:
960 // tar (GNU tar) 1.15.1
961 // tar (GNU tar) 1.25
962 // bsdtar 2.8.3 - libarchive 2.8.3
963 puts("tar (busybox) " BB_VER);
966 if (argv[1] && argv[1][0] != '-') {
968 * 1st argument without dash handles options with parameters
969 * differently from dashed one: it takes *next argv[i]*
970 * as paramenter even if there are more chars in 1st argument:
971 * "tar fx TARFILE" - "x" is not taken as f's param
972 * but is interpreted as -x option
973 * "tar -xf TARFILE" - dashed equivalent of the above
974 * "tar -fx ..." - "x" is taken as f's param
975 * getopt32 wouldn't handle 1st command correctly.
976 * Unfortunately, people do use such commands.
977 * We massage argv[1] to work around it by moving 'f'
978 * to the end of the string.
979 * More contrived "tar fCx TARFILE DIR" still fails,
980 * but such commands are much less likely to be used.
982 char *f = strchr(argv[1], 'f');
984 while (f[1] != '\0') {
992 /* Prepend '-' to the first argument if required */
993 if (argv[1] && argv[1][0] != '-' && argv[1][0] != '\0')
994 argv[1] = xasprintf("-%s", argv[1]);
995 opt = GETOPT32(argv, "^"
997 IF_FEATURE_TAR_CREATE( "ch" )
998 IF_FEATURE_SEAMLESS_BZ2( "j" )
999 IF_FEATURE_SEAMLESS_LZMA("a" )
1000 IF_FEATURE_TAR_FROM( "T:*X:*")
1001 IF_FEATURE_SEAMLESS_GZ( "z" )
1002 IF_FEATURE_SEAMLESS_XZ( "J" )
1003 IF_FEATURE_SEAMLESS_Z( "Z" )
1004 IF_FEATURE_TAR_NOPRESERVE_TIME("m")
1005 IF_FEATURE_TAR_LONG_OPTIONS("\xf9:") // --strip-components
1007 "tt:vv:" // count -t,-v
1008 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
1009 "\xff::" // --exclude=PATTERN is a list
1011 IF_FEATURE_TAR_CREATE("c:") "t:x:" // at least one of these is reqd
1012 IF_FEATURE_TAR_CREATE("c--tx:t--cx:x--ct") // mutually exclusive
1013 IF_NOT_FEATURE_TAR_CREATE("t--x:x--t") // mutually exclusive
1014 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
1015 ":\xf9+" // --strip-components=NUM
1018 , &base_dir // -C dir
1019 , &tar_filename // -f filename
1020 IF_FEATURE_TAR_FROM(, &(tar_handle->accept)) // T
1021 IF_FEATURE_TAR_FROM(, &(tar_handle->reject)) // X
1022 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
1023 , &tar_handle->tar__strip_components // --strip-components
1025 IF_FEATURE_TAR_TO_COMMAND(, &(tar_handle->tar__to_command)) // --to-command
1026 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
1027 , &excludes // --exclude
1029 , &verboseFlag // combined count for -t and -v
1030 , &verboseFlag // combined count for -t and -v
1032 #if DBG_OPTION_PARSING
1033 bb_error_msg("opt: 0x%08x", opt);
1034 # define showopt(o) bb_error_msg("opt & %s(%x): %x", #o, o, opt & o);
1036 showopt(OPT_EXTRACT );
1037 showopt(OPT_BASEDIR );
1038 showopt(OPT_TARNAME );
1039 showopt(OPT_2STDOUT );
1040 showopt(OPT_NOPRESERVE_OWNER);
1042 showopt(OPT_VERBOSE );
1043 showopt(OPT_KEEP_OLD );
1044 showopt(OPT_CREATE );
1045 showopt(OPT_DEREFERENCE );
1046 showopt(OPT_BZIP2 );
1048 showopt(OPT_INCLUDE_FROM );
1049 showopt(OPT_EXCLUDE_FROM );
1052 showopt(OPT_COMPRESS );
1053 showopt(OPT_NOPRESERVE_TIME );
1054 showopt(OPT_STRIP_COMPONENTS);
1055 showopt(OPT_NORECURSION );
1056 showopt(OPT_2COMMAND );
1057 showopt(OPT_NUMERIC_OWNER );
1058 showopt(OPT_NOPRESERVE_PERM );
1059 showopt(OPT_OVERWRITE );
1060 showopt(OPT_ANY_COMPRESS );
1061 bb_error_msg("base_dir:'%s'", base_dir);
1062 bb_error_msg("tar_filename:'%s'", tar_filename);
1063 bb_error_msg("verboseFlag:%d", verboseFlag);
1064 bb_error_msg("tar_handle->tar__to_command:'%s'", tar_handle->tar__to_command);
1065 bb_error_msg("tar_handle->tar__strip_components:%u", tar_handle->tar__strip_components);
1072 tar_handle->action_header = header_verbose_list;
1073 if (verboseFlag == 1)
1074 tar_handle->action_header = header_list;
1076 if (opt & OPT_EXTRACT)
1077 tar_handle->action_data = data_extract_all;
1079 if (opt & OPT_2STDOUT)
1080 tar_handle->action_data = data_extract_to_stdout;
1082 if (opt & OPT_2COMMAND) {
1083 putenv((char*)"TAR_FILETYPE=f");
1084 signal(SIGPIPE, SIG_IGN);
1085 tar_handle->action_data = data_extract_to_command;
1086 IF_FEATURE_TAR_TO_COMMAND(tar_handle->tar__to_command_shell = xstrdup(get_shell_name());)
1089 if (opt & OPT_KEEP_OLD)
1090 tar_handle->ah_flags &= ~ARCHIVE_UNLINK_OLD;
1092 if (opt & OPT_NUMERIC_OWNER)
1093 tar_handle->ah_flags |= ARCHIVE_NUMERIC_OWNER;
1095 if (opt & OPT_NOPRESERVE_OWNER)
1096 tar_handle->ah_flags |= ARCHIVE_DONT_RESTORE_OWNER;
1098 if (opt & OPT_NOPRESERVE_PERM)
1099 tar_handle->ah_flags |= ARCHIVE_DONT_RESTORE_PERM;
1101 if (opt & OPT_OVERWRITE) {
1102 tar_handle->ah_flags &= ~ARCHIVE_UNLINK_OLD;
1103 tar_handle->ah_flags |= ARCHIVE_O_TRUNC;
1106 if (opt & OPT_NOPRESERVE_TIME)
1107 tar_handle->ah_flags &= ~ARCHIVE_RESTORE_DATE;
1109 #if ENABLE_FEATURE_TAR_FROM
1110 tar_handle->reject = append_file_list_to_list(tar_handle->reject);
1111 # if ENABLE_FEATURE_TAR_LONG_OPTIONS
1112 /* Append excludes to reject */
1114 llist_t *next = excludes->link;
1115 excludes->link = tar_handle->reject;
1116 tar_handle->reject = excludes;
1120 tar_handle->accept = append_file_list_to_list(tar_handle->accept);
1123 /* Setup an array of filenames to work with */
1124 /* TODO: This is the same as in ar, make a separate function? */
1126 /* kill trailing '/' unless the string is just "/" */
1127 char *cp = last_char_is(*argv, '/');
1130 llist_add_to_end(&tar_handle->accept, *argv);
1134 if (tar_handle->accept || tar_handle->reject)
1135 tar_handle->filter = filter_accept_reject_list;
1137 /* Open the tar file */
1139 int tar_fd = STDIN_FILENO;
1140 int flags = O_RDONLY;
1142 if (opt & OPT_CREATE) {
1143 /* Make sure there is at least one file to tar up */
1144 if (tar_handle->accept == NULL)
1145 bb_error_msg_and_die("empty archive");
1147 tar_fd = STDOUT_FILENO;
1148 /* Mimicking GNU tar 1.15.1: */
1149 flags = O_WRONLY | O_CREAT | O_TRUNC;
1152 if (LONE_DASH(tar_filename)) {
1153 tar_handle->src_fd = tar_fd;
1154 tar_handle->seek = seek_by_read;
1156 if (ENABLE_FEATURE_TAR_AUTODETECT
1157 && flags == O_RDONLY
1158 && !(opt & OPT_ANY_COMPRESS)
1160 tar_handle->src_fd = open_zipped(tar_filename, /*fail_if_not_compressed:*/ 0);
1161 if (tar_handle->src_fd < 0)
1162 bb_perror_msg_and_die("can't open '%s'", tar_filename);
1164 tar_handle->src_fd = xopen(tar_filename, flags);
1172 //if (SEAMLESS_COMPRESSION)
1173 // /* We need to know whether child (gzip/bzip/etc) exits abnormally */
1174 // signal(SIGCHLD, check_errors_in_children);
1176 #if ENABLE_FEATURE_TAR_CREATE
1177 /* Create an archive */
1178 if (opt & OPT_CREATE) {
1179 # if SEAMLESS_COMPRESSION
1180 const char *zipMode = NULL;
1181 if (opt & OPT_COMPRESS)
1182 zipMode = "compress";
1185 if (opt & OPT_BZIP2)
1192 /* NB: writeTarFile() closes tar_handle->src_fd */
1193 return writeTarFile(tar_handle->src_fd, verboseFlag,
1194 (opt & OPT_DEREFERENCE ? ACTION_FOLLOWLINKS : 0)
1195 | (opt & OPT_NORECURSION ? 0 : ACTION_RECURSE),
1197 tar_handle->reject, zipMode);
1201 if (opt & OPT_ANY_COMPRESS) {
1202 USE_FOR_MMU(IF_DESKTOP(long long) int FAST_FUNC (*xformer)(transformer_state_t *xstate);)
1203 USE_FOR_NOMMU(const char *xformer_prog;)
1205 if (opt & OPT_COMPRESS) {
1206 USE_FOR_MMU(IF_FEATURE_SEAMLESS_Z(xformer = unpack_Z_stream;))
1207 USE_FOR_NOMMU(xformer_prog = "uncompress";)
1209 if (opt & OPT_GZIP) {
1210 USE_FOR_MMU(IF_FEATURE_SEAMLESS_GZ(xformer = unpack_gz_stream;))
1211 USE_FOR_NOMMU(xformer_prog = "gunzip";)
1213 if (opt & OPT_BZIP2) {
1214 USE_FOR_MMU(IF_FEATURE_SEAMLESS_BZ2(xformer = unpack_bz2_stream;))
1215 USE_FOR_NOMMU(xformer_prog = "bunzip2";)
1217 if (opt & OPT_LZMA) {
1218 USE_FOR_MMU(IF_FEATURE_SEAMLESS_LZMA(xformer = unpack_lzma_stream;))
1219 USE_FOR_NOMMU(xformer_prog = "unlzma";)
1222 USE_FOR_MMU(IF_FEATURE_SEAMLESS_XZ(xformer = unpack_xz_stream;))
1223 USE_FOR_NOMMU(xformer_prog = "unxz";)
1226 fork_transformer_with_sig(tar_handle->src_fd, xformer, xformer_prog);
1227 /* Can't lseek over pipes */
1228 tar_handle->seek = seek_by_read;
1229 /*tar_handle->offset = 0; - already is */
1232 /* Zero processed headers (== empty file) is not a valid tarball.
1233 * We (ab)use bb_got_signal as exitcode here,
1234 * because check_errors_in_children() uses _it_ as error indicator.
1236 bb_got_signal = EXIT_FAILURE;
1238 while (get_header_tar(tar_handle) == EXIT_SUCCESS)
1239 bb_got_signal = EXIT_SUCCESS; /* saw at least one header, good */
1241 /* Check that every file that should have been extracted was */
1242 while (tar_handle->accept) {
1243 if (!find_list_entry(tar_handle->reject, tar_handle->accept->data)
1244 && !find_list_entry(tar_handle->passed, tar_handle->accept->data)
1246 bb_error_msg_and_die("%s: not found in archive",
1247 tar_handle->accept->data);
1249 tar_handle->accept = tar_handle->accept->link;
1251 if (ENABLE_FEATURE_CLEAN_UP /* && tar_handle->src_fd != STDIN_FILENO */)
1252 close(tar_handle->src_fd);
1254 if (SEAMLESS_COMPRESSION || OPT_COMPRESS) {
1255 /* Set bb_got_signal to 1 if a child died with !0 exitcode */
1256 check_errors_in_children(0);
1259 return bb_got_signal;