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.
26 //config: bool "tar (40 kb)"
29 //config: tar is an archiving program. It's commonly used with gzip to
30 //config: create compressed archives. It's probably the most widely used
31 //config: UNIX archive program.
33 //config:config FEATURE_TAR_LONG_OPTIONS
34 //config: bool "Enable long options"
36 //config: depends on TAR && LONG_OPTS
38 //config:config FEATURE_TAR_CREATE
39 //config: bool "Enable -c (archive creation)"
41 //config: depends on TAR
43 //config:config FEATURE_TAR_AUTODETECT
44 //config: bool "Autodetect compressed tarballs"
46 //config: depends on TAR && (FEATURE_SEAMLESS_Z || FEATURE_SEAMLESS_GZ || FEATURE_SEAMLESS_BZ2 || FEATURE_SEAMLESS_LZMA || FEATURE_SEAMLESS_XZ)
48 //config: With this option tar can automatically detect compressed
49 //config: tarballs. Currently it works only on files (not pipes etc).
51 //config:config FEATURE_TAR_FROM
52 //config: bool "Enable -X (exclude from) and -T (include from) options"
54 //config: depends on TAR
56 //config: If you enable this option you'll be able to specify
57 //config: a list of files to include or exclude from an archive.
59 //config:config FEATURE_TAR_OLDGNU_COMPATIBILITY
60 //config: bool "Support old tar header format"
62 //config: depends on TAR || DPKG
64 //config: This option is required to unpack archives created in
65 //config: the old GNU format; help to kill this old format by
66 //config: repacking your ancient archives with the new format.
68 //config:config FEATURE_TAR_OLDSUN_COMPATIBILITY
69 //config: bool "Enable untarring of tarballs with checksums produced by buggy Sun tar"
71 //config: depends on TAR || DPKG
73 //config: This option is required to unpack archives created by some old
74 //config: version of Sun's tar (it was calculating checksum using signed
75 //config: arithmetic). It is said to be fixed in newer Sun tar, but "old"
76 //config: tarballs still exist.
78 //config:config FEATURE_TAR_GNU_EXTENSIONS
79 //config: bool "Support GNU tar extensions (long filenames)"
81 //config: depends on TAR || DPKG
83 //config:config FEATURE_TAR_TO_COMMAND
84 //config: bool "Support writing to an external program (--to-command)"
86 //config: depends on TAR && FEATURE_TAR_LONG_OPTIONS
88 //config: If you enable this option you'll be able to instruct tar to send
89 //config: the contents of each extracted file to the standard input of an
90 //config: external program.
92 //config:config FEATURE_TAR_UNAME_GNAME
93 //config: bool "Enable use of user and group names"
95 //config: depends on TAR
97 //config: Enable use of user and group names in tar. This affects contents
98 //config: listings (-t) and preserving permissions when unpacking (-p).
101 //config:config FEATURE_TAR_NOPRESERVE_TIME
102 //config: bool "Enable -m (do not preserve time) GNU option"
104 //config: depends on TAR
106 //config:config FEATURE_TAR_SELINUX
107 //config: bool "Support extracting SELinux labels"
109 //config: depends on TAR && SELINUX
111 //config: With this option busybox supports restoring SELinux labels
112 //config: when extracting files from tar archives.
114 //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 # if ENABLE_FEATURE_TAR_FROM
160 const llist_t *excludeList; /* List of files to not include */
162 HardLinkInfo *hlInfoHead; /* Hard Link Tracking Information */
163 HardLinkInfo *hlInfo; /* Hard Link Info for the current file */
164 //TODO: save only st_dev + st_ino
165 struct stat tarFileStatBuf; /* Stat info for the tarball, letting
166 * us know the inode and device that the
167 * tarball lives, so we can avoid trying
168 * to include the tarball into itself */
171 /* A nice enum with all the possible tar file content types */
173 REGTYPE = '0', /* regular file */
174 REGTYPE0 = '\0', /* regular file (ancient bug compat) */
175 LNKTYPE = '1', /* hard link */
176 SYMTYPE = '2', /* symbolic link */
177 CHRTYPE = '3', /* character special */
178 BLKTYPE = '4', /* block special */
179 DIRTYPE = '5', /* directory */
180 FIFOTYPE = '6', /* FIFO special */
181 CONTTYPE = '7', /* reserved */
182 GNULONGLINK = 'K', /* GNU long (>100 chars) link name */
183 GNULONGNAME = 'L', /* GNU long (>100 chars) file name */
186 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
187 static void addHardLinkInfo(HardLinkInfo **hlInfoHeadPtr,
188 struct stat *statbuf,
189 const char *fileName)
191 /* Note: hlInfoHeadPtr can never be NULL! */
192 HardLinkInfo *hlInfo;
194 hlInfo = xmalloc(sizeof(HardLinkInfo) + strlen(fileName));
195 hlInfo->next = *hlInfoHeadPtr;
196 *hlInfoHeadPtr = hlInfo;
197 hlInfo->dev = statbuf->st_dev;
198 hlInfo->ino = statbuf->st_ino;
199 // hlInfo->linkCount = statbuf->st_nlink;
200 strcpy(hlInfo->name, fileName);
203 static void freeHardLinkInfo(HardLinkInfo **hlInfoHeadPtr)
205 HardLinkInfo *hlInfo;
206 HardLinkInfo *hlInfoNext;
209 hlInfo = *hlInfoHeadPtr;
211 hlInfoNext = hlInfo->next;
215 *hlInfoHeadPtr = NULL;
219 /* Might be faster (and bigger) if the dev/ino were stored in numeric order ;) */
220 static HardLinkInfo *findHardLinkInfo(HardLinkInfo *hlInfo, struct stat *statbuf)
223 if (statbuf->st_ino == hlInfo->ino
224 && statbuf->st_dev == hlInfo->dev
226 DBG("found hardlink:'%s'", hlInfo->name);
229 hlInfo = hlInfo->next;
234 /* Put an octal string into the specified buffer.
235 * The number is zero padded and possibly null terminated.
236 * Stores low-order bits only if whole value does not fit. */
237 static void putOctal(char *cp, int len, off_t value)
239 char tempBuffer[sizeof(off_t)*3 + 1];
240 char *tempString = tempBuffer;
243 width = sprintf(tempBuffer, "%0*"OFF_FMT"o", len, value);
244 tempString += (width - len);
246 /* If string has leading zeroes, we can drop one */
247 /* and field will have trailing '\0' */
248 /* (increases chances of compat with other tars) */
249 if (tempString[0] == '0')
252 /* Copy the string to the field */
253 memcpy(cp, tempString, len);
255 #define PUT_OCTAL(a, b) putOctal((a), sizeof(a), (b))
257 static void chksum_and_xwrite(int fd, struct tar_header_t* hp)
259 /* POSIX says that checksum is done on unsigned bytes
260 * (Sun and HP-UX gets it wrong... more details in
262 const unsigned char *cp;
265 strcpy(hp->magic, "ustar ");
267 /* Calculate and store the checksum (i.e., the sum of all of the bytes of
268 * the header). The checksum field must be filled with blanks for the
269 * calculation. The checksum field is formatted differently from the
270 * other fields: it has 6 digits, a null, then a space -- rather than
271 * digits, followed by a null like the other fields... */
272 memset(hp->chksum, ' ', sizeof(hp->chksum));
273 cp = (const unsigned char *) hp;
276 do { chksum += *cp++; } while (--size);
277 putOctal(hp->chksum, sizeof(hp->chksum)-1, chksum);
279 /* Now write the header out to disk */
280 xwrite(fd, hp, sizeof(*hp));
283 # if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
284 static void writeLongname(int fd, int type, const char *name, int dir)
286 static const struct {
287 char mode[8]; /* 100-107 */
288 char uid[8]; /* 108-115 */
289 char gid[8]; /* 116-123 */
290 char size[12]; /* 124-135 */
291 char mtime[12]; /* 136-147 */
299 struct tar_header_t header;
302 dir = !!dir; /* normalize: 0/1 */
303 size = strlen(name) + 1 + dir; /* GNU tar uses strlen+1 */
304 /* + dir: account for possible '/' */
306 memset(&header, 0, sizeof(header));
307 strcpy(header.name, "././@LongLink");
308 memcpy(header.mode, prefilled.mode, sizeof(prefilled));
309 PUT_OCTAL(header.size, size);
310 header.typeflag = type;
311 chksum_and_xwrite(fd, &header);
313 /* Write filename[/] and pad the block. */
314 /* dir=0: writes 'name<NUL>', pads */
315 /* dir=1: writes 'name', writes '/<NUL>', pads */
317 xwrite(fd, name, size - dir);
318 xwrite(fd, "/", dir);
319 size = (-size) & (TAR_BLOCK_SIZE-1);
320 memset(&header, 0, size);
321 xwrite(fd, &header, size);
325 /* Write out a tar header for the specified file/directory/whatever */
326 static int writeTarHeader(struct TarBallInfo *tbInfo,
327 const char *header_name, const char *fileName, struct stat *statbuf)
329 struct tar_header_t header;
331 memset(&header, 0, sizeof(header));
333 strncpy(header.name, header_name, sizeof(header.name));
335 /* POSIX says to mask mode with 07777. */
336 PUT_OCTAL(header.mode, statbuf->st_mode & 07777);
337 PUT_OCTAL(header.uid, statbuf->st_uid);
338 PUT_OCTAL(header.gid, statbuf->st_gid);
339 memset(header.size, '0', sizeof(header.size)-1); /* Regular file size is handled later */
340 /* users report that files with negative st_mtime cause trouble, so: */
341 PUT_OCTAL(header.mtime, statbuf->st_mtime >= 0 ? statbuf->st_mtime : 0);
343 /* Enter the user and group names */
344 safe_strncpy(header.uname, get_cached_username(statbuf->st_uid), sizeof(header.uname));
345 safe_strncpy(header.gname, get_cached_groupname(statbuf->st_gid), sizeof(header.gname));
347 if (tbInfo->hlInfo) {
348 /* This is a hard link */
349 header.typeflag = LNKTYPE;
350 strncpy(header.linkname, tbInfo->hlInfo->name,
351 sizeof(header.linkname));
352 # if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
353 /* Write out long linkname if needed */
354 if (header.linkname[sizeof(header.linkname)-1])
355 writeLongname(tbInfo->tarFd, GNULONGLINK,
356 tbInfo->hlInfo->name, 0);
358 } else if (S_ISLNK(statbuf->st_mode)) {
359 char *lpath = xmalloc_readlink_or_warn(fileName);
362 header.typeflag = SYMTYPE;
363 strncpy(header.linkname, lpath, sizeof(header.linkname));
364 # if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
365 /* Write out long linkname if needed */
366 if (header.linkname[sizeof(header.linkname)-1])
367 writeLongname(tbInfo->tarFd, GNULONGLINK, lpath, 0);
369 /* If it is larger than 100 bytes, bail out */
370 if (header.linkname[sizeof(header.linkname)-1]) {
372 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
377 } else if (S_ISDIR(statbuf->st_mode)) {
378 header.typeflag = DIRTYPE;
379 /* Append '/' only if there is a space for it */
380 if (!header.name[sizeof(header.name)-1])
381 header.name[strlen(header.name)] = '/';
382 } else if (S_ISCHR(statbuf->st_mode)) {
383 header.typeflag = CHRTYPE;
384 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
385 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
386 } else if (S_ISBLK(statbuf->st_mode)) {
387 header.typeflag = BLKTYPE;
388 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
389 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
390 } else if (S_ISFIFO(statbuf->st_mode)) {
391 header.typeflag = FIFOTYPE;
392 } else if (S_ISREG(statbuf->st_mode)) {
393 /* header.size field is 12 bytes long */
394 /* Does octal-encoded size fit? */
395 uoff_t filesize = statbuf->st_size;
396 if (sizeof(filesize) <= 4
397 || filesize <= (uoff_t)0777777777777LL
399 PUT_OCTAL(header.size, filesize);
401 /* Does base256-encoded size fit?
402 * It always does unless off_t is wider than 64 bits.
404 else if (ENABLE_FEATURE_TAR_GNU_EXTENSIONS
405 # if ULLONG_MAX > 0xffffffffffffffffLL /* 2^64-1 */
406 && (filesize <= 0x3fffffffffffffffffffffffLL)
409 /* GNU tar uses "base-256 encoding" for very large numbers.
410 * Encoding is binary, with highest bit always set as a marker
411 * and sign in next-highest bit:
413 * bf ff .. ff - largest positive number
414 * ff ff .. ff - minus 1
415 * c0 00 .. 00 - smallest negative number
417 char *p8 = header.size + sizeof(header.size);
419 *--p8 = (uint8_t)filesize;
421 } while (p8 != header.size);
424 bb_error_msg_and_die("can't store file '%s' "
425 "of size %"OFF_FMT"u, aborting",
426 fileName, statbuf->st_size);
428 header.typeflag = REGTYPE;
430 bb_error_msg("%s: unknown file type", fileName);
434 # if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
435 /* Write out long name if needed */
436 /* (we, like GNU tar, output long linkname *before* long name) */
437 if (header.name[sizeof(header.name)-1])
438 writeLongname(tbInfo->tarFd, GNULONGNAME,
439 header_name, S_ISDIR(statbuf->st_mode));
442 /* Now write the header out to disk */
443 chksum_and_xwrite(tbInfo->tarFd, &header);
445 /* Now do the verbose thing (or not) */
446 if (tbInfo->verboseFlag) {
449 /* If archive goes to stdout, verbose goes to stderr */
450 if (tbInfo->tarFd == STDOUT_FILENO)
452 /* GNU "tar cvvf" prints "extended" listing a-la "ls -l" */
453 /* We don't have such excesses here: for us "v" == "vv" */
454 /* '/' is probably a GNUism */
455 fprintf(vbFd, "%s%s\n", header_name,
456 S_ISDIR(statbuf->st_mode) ? "/" : "");
462 # if ENABLE_FEATURE_TAR_FROM
463 static int exclude_file(const llist_t *excluded_files, const char *file)
465 while (excluded_files) {
466 if (excluded_files->data[0] == '/') {
467 if (fnmatch(excluded_files->data, file,
468 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
473 for (p = file; p[0] != '\0'; p++) {
474 if ((p == file || p[-1] == '/')
476 && fnmatch(excluded_files->data, p,
477 FNM_PATHNAME | FNM_LEADING_DIR) == 0
483 excluded_files = excluded_files->link;
489 # define exclude_file(excluded_files, file) 0
492 static int FAST_FUNC writeFileToTarball(const char *fileName, struct stat *statbuf,
493 void *userData, int depth UNUSED_PARAM)
495 struct TarBallInfo *tbInfo = (struct TarBallInfo *) userData;
496 const char *header_name;
497 int inputFileFd = -1;
499 DBG("writeFileToTarball('%s')", fileName);
501 /* Strip leading '/' and such (must be before memorizing hardlink's name) */
502 header_name = strip_unsafe_prefix(fileName);
504 if (header_name[0] == '\0')
507 /* It is against the rules to archive a socket */
508 if (S_ISSOCK(statbuf->st_mode)) {
509 bb_error_msg("%s: socket ignored", fileName);
514 * Check to see if we are dealing with a hard link.
516 * Treat the first occurrence of a given dev/inode as a file while
517 * treating any additional occurrences as hard links. This is done
518 * by adding the file information to the HardLinkInfo linked list.
520 tbInfo->hlInfo = NULL;
521 if (!S_ISDIR(statbuf->st_mode) && statbuf->st_nlink > 1) {
522 DBG("'%s': st_nlink > 1", header_name);
523 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf);
524 if (tbInfo->hlInfo == NULL) {
525 DBG("'%s': addHardLinkInfo", header_name);
526 addHardLinkInfo(&tbInfo->hlInfoHead, statbuf, header_name);
530 /* It is a bad idea to store the archive we are in the process of creating,
531 * so check the device and inode to be sure that this particular file isn't
533 if (tbInfo->tarFileStatBuf.st_dev == statbuf->st_dev
534 && tbInfo->tarFileStatBuf.st_ino == statbuf->st_ino
536 bb_error_msg("%s: file is the archive; skipping", fileName);
540 if (exclude_file(tbInfo->excludeList, header_name))
543 # if !ENABLE_FEATURE_TAR_GNU_EXTENSIONS
544 if (strlen(header_name) >= NAME_SIZE) {
545 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
550 /* Is this a regular file? */
551 if (tbInfo->hlInfo == NULL && S_ISREG(statbuf->st_mode)) {
552 /* open the file we want to archive, and make sure all is well */
553 inputFileFd = open_or_warn(fileName, O_RDONLY);
554 if (inputFileFd < 0) {
559 /* Add an entry to the tarball */
560 if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
564 /* If it was a regular file, write out the body */
565 if (inputFileFd >= 0) {
567 /* Write the file to the archive. */
568 /* We record size into header first, */
569 /* and then write out file. If file shrinks in between, */
570 /* tar will be corrupted. So we don't allow for that. */
571 /* NB: GNU tar 1.16 warns and pads with zeroes */
572 /* or even seeks back and updates header */
573 bb_copyfd_exact_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
575 ////readSize = bb_copyfd_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
576 ////if (readSize != statbuf->st_size && readSize >= 0) {
577 //// bb_error_msg_and_die("short read from %s, aborting", fileName);
580 /* Check that file did not grow in between? */
581 /* if (safe_read(inputFileFd, 1) == 1) warn but continue? */
585 /* Pad the file up to the tar block size */
586 /* (a few tricks here in the name of code size) */
587 readSize = (-(int)statbuf->st_size) & (TAR_BLOCK_SIZE-1);
588 memset(block_buf, 0, readSize);
589 xwrite(tbInfo->tarFd, block_buf, readSize);
595 # if SEAMLESS_COMPRESSION
596 /* Don't inline: vfork scares gcc and pessimizes code */
597 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;
605 struct fd_pair status;
610 signal(SIGPIPE, SIG_IGN); /* we only want EPIPE on errors */
615 /* NB: close _first_, then move fds! */
619 /* status.wr will close only on exec -
620 * parent waits for this close to happen */
621 fcntl(status.wr, F_SETFD, FD_CLOEXEC);
623 /* copy it: parent's tar_fd variable must not change */
626 /* Output tar fd may be zero.
627 * xmove_fd(data.rd, 0) would destroy it.
631 * tar czf Z.tar.gz FILE
632 * Swapping move_fd's order wouldn't work:
633 * data.rd is 1 and _it_ would be destroyed.
637 xmove_fd(data.rd, 0);
639 /* exec gzip/bzip2 program/applet */
640 BB_EXECLP(gzip, gzip, "-f", (char *)0);
641 vfork_exec_errno = errno;
646 xmove_fd(data.wr, tar_fd);
651 /* Wait until child execs (or fails to) */
653 int n = full_read(status.rd, &buf, 1);
654 if (n < 0 /* && errno == EAGAIN */)
655 continue; /* try it again */
659 if (vfork_exec_errno) {
660 errno = vfork_exec_errno;
661 bb_perror_msg_and_die("can't execute '%s'", gzip);
664 # endif /* SEAMLESS_COMPRESSION */
667 # if !SEAMLESS_COMPRESSION
668 /* Do not pass gzip flag to writeTarFile() */
669 #define writeTarFile(tbInfo, recurseFlags, filelist, gzip) \
670 writeTarFile(tbInfo, recurseFlags, filelist)
672 /* gcc 4.2.1 inlines it, making code bigger */
673 static NOINLINE int writeTarFile(
674 struct TarBallInfo *tbInfo,
676 const llist_t *filelist,
679 int errorFlag = FALSE;
681 /*tbInfo->hlInfoHead = NULL; - already is */
683 /* Store the stat info for the tarball's file, so
684 * can avoid including the tarball into itself.... */
685 xfstat(tbInfo->tarFd, &tbInfo->tarFileStatBuf, "can't stat tar file");
687 # if SEAMLESS_COMPRESSION
689 vfork_compressor(tbInfo->tarFd, gzip);
692 /* Read the directory/files and iterate over them one at a time */
694 if (!recursive_action(filelist->data, recurseFlags,
695 writeFileToTarball, writeFileToTarball, tbInfo, 0)
699 filelist = filelist->link;
701 /* Write two empty blocks to the end of the archive */
702 memset(block_buf, 0, 2*TAR_BLOCK_SIZE);
703 xwrite(tbInfo->tarFd, block_buf, 2*TAR_BLOCK_SIZE);
705 /* To be pedantically correct, we would check if the tarball
706 * is smaller than 20 tar blocks, and pad it if it was smaller,
707 * but that isn't necessary for GNU tar interoperability, and
708 * so is considered a waste of space */
710 /* Close so the child process (if any) will exit */
711 close(tbInfo->tarFd);
713 /* Hang up the tools, close up shop, head home */
714 if (ENABLE_FEATURE_CLEAN_UP)
715 freeHardLinkInfo(&tbInfo->hlInfoHead);
718 bb_error_msg("error exit delayed from previous errors");
720 # if SEAMLESS_COMPRESSION
723 if (safe_waitpid(-1, &status, 0) == -1)
724 bb_perror_msg("waitpid");
725 else if (!WIFEXITED(status) || WEXITSTATUS(status))
726 /* gzip was killed or has exited with nonzero! */
733 #endif /* FEATURE_TAR_CREATE */
735 #if ENABLE_FEATURE_TAR_FROM
736 static llist_t *append_file_list_to_list(llist_t *list)
738 llist_t *newlist = NULL;
744 src_stream = xfopen_stdin(llist_pop(&list));
745 while ((line = xmalloc_fgetline(src_stream)) != NULL) {
746 /* kill trailing '/' unless the string is just "/" */
747 char *cp = last_char_is(line, '/');
750 llist_add_to_end(&newlist, line);
758 //usage:#define tar_trivial_usage
759 //usage: IF_FEATURE_TAR_CREATE("c|") "x|t [-"
760 //usage: IF_FEATURE_SEAMLESS_Z("Z")
761 //usage: IF_FEATURE_SEAMLESS_GZ("z")
762 //usage: IF_FEATURE_SEAMLESS_XZ("J")
763 //usage: IF_FEATURE_SEAMLESS_BZ2("j")
764 //usage: IF_FEATURE_SEAMLESS_LZMA("a")
765 //usage: IF_FEATURE_TAR_CREATE("h")
766 //usage: IF_FEATURE_TAR_NOPRESERVE_TIME("m")
768 //usage: "[-f TARFILE] [-C DIR] "
769 //usage: IF_FEATURE_TAR_FROM("[-T FILE] [-X FILE] "IF_FEATURE_TAR_LONG_OPTIONS("[--exclude PATTERN]... "))
771 //usage:#define tar_full_usage "\n\n"
772 //usage: IF_FEATURE_TAR_CREATE("Create, extract, ")
773 //usage: IF_NOT_FEATURE_TAR_CREATE("Extract ")
774 //usage: "or list files from a tar file"
776 //usage: IF_FEATURE_TAR_CREATE(
777 //usage: "\n c Create"
779 //usage: "\n x Extract"
781 //usage: "\n -f FILE Name of TARFILE ('-' for stdin/out)"
782 //usage: "\n -C DIR Change to DIR before operation"
783 //usage: "\n -v Verbose"
784 //usage: "\n -O Extract to stdout"
785 //usage: IF_FEATURE_TAR_NOPRESERVE_TIME(
786 //usage: "\n -m Don't restore mtime"
788 //usage: "\n -o Don't restore user:group"
789 ///////:-p - accepted but ignored, restores mode (aliases in GNU tar: --preserve-permissions, --same-permissions)
790 //usage: "\n -k Don't replace existing files"
791 //usage: IF_FEATURE_SEAMLESS_Z(
792 //usage: "\n -Z (De)compress using compress"
794 //usage: IF_FEATURE_SEAMLESS_GZ(
795 //usage: "\n -z (De)compress using gzip"
797 //usage: IF_FEATURE_SEAMLESS_XZ(
798 //usage: "\n -J (De)compress using xz"
800 //usage: IF_FEATURE_SEAMLESS_BZ2(
801 //usage: "\n -j (De)compress using bzip2"
803 //usage: IF_FEATURE_SEAMLESS_LZMA(
804 //usage: "\n -a (De)compress using lzma"
806 //usage: IF_FEATURE_TAR_CREATE(
807 //usage: "\n -h Follow symlinks"
809 //usage: IF_FEATURE_TAR_FROM(
810 //usage: "\n -T FILE File with names to include"
811 //usage: "\n -X FILE File with glob patterns to exclude"
812 //usage: IF_FEATURE_TAR_LONG_OPTIONS(
813 //usage: "\n --exclude PATTERN Glob pattern to exclude"
817 //usage:#define tar_example_usage
818 //usage: "$ zcat /tmp/tarball.tar.gz | tar -xf -\n"
819 //usage: "$ tar -cf /tmp/tarball.tar /usr/local\n"
821 // Supported but aren't in --help:
824 // no-same-permissions
826 //IF_FEATURE_TAR_TO_COMMAND(
832 IF_FEATURE_TAR_CREATE( OPTBIT_CREATE ,)
833 IF_FEATURE_TAR_CREATE( OPTBIT_DEREFERENCE ,)
834 IF_FEATURE_SEAMLESS_BZ2( OPTBIT_BZIP2 ,)
835 IF_FEATURE_SEAMLESS_LZMA(OPTBIT_LZMA ,)
836 IF_FEATURE_TAR_FROM( OPTBIT_INCLUDE_FROM,)
837 IF_FEATURE_TAR_FROM( OPTBIT_EXCLUDE_FROM,)
838 IF_FEATURE_SEAMLESS_GZ( OPTBIT_GZIP ,)
839 IF_FEATURE_SEAMLESS_XZ( OPTBIT_XZ ,) // 16th bit
840 IF_FEATURE_SEAMLESS_Z( OPTBIT_COMPRESS ,)
841 IF_FEATURE_TAR_NOPRESERVE_TIME(OPTBIT_NOPRESERVE_TIME,)
842 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
843 OPTBIT_STRIP_COMPONENTS,
845 IF_FEATURE_TAR_TO_COMMAND(OPTBIT_2COMMAND ,)
846 OPTBIT_NUMERIC_OWNER,
847 OPTBIT_NOPRESERVE_PERM,
850 OPT_TEST = 1 << 0, // t
851 OPT_EXTRACT = 1 << 1, // x
852 OPT_BASEDIR = 1 << 2, // C
853 OPT_TARNAME = 1 << 3, // f
854 OPT_2STDOUT = 1 << 4, // O
855 OPT_NOPRESERVE_OWNER = 1 << 5, // o == no-same-owner
857 OPT_VERBOSE = 1 << 7, // v
858 OPT_KEEP_OLD = 1 << 8, // k
859 OPT_CREATE = IF_FEATURE_TAR_CREATE( (1 << OPTBIT_CREATE )) + 0, // c
860 OPT_DEREFERENCE = IF_FEATURE_TAR_CREATE( (1 << OPTBIT_DEREFERENCE )) + 0, // h
861 OPT_BZIP2 = IF_FEATURE_SEAMLESS_BZ2( (1 << OPTBIT_BZIP2 )) + 0, // j
862 OPT_LZMA = IF_FEATURE_SEAMLESS_LZMA((1 << OPTBIT_LZMA )) + 0, // a
863 OPT_INCLUDE_FROM = IF_FEATURE_TAR_FROM( (1 << OPTBIT_INCLUDE_FROM)) + 0, // T
864 OPT_EXCLUDE_FROM = IF_FEATURE_TAR_FROM( (1 << OPTBIT_EXCLUDE_FROM)) + 0, // X
865 OPT_GZIP = IF_FEATURE_SEAMLESS_GZ( (1 << OPTBIT_GZIP )) + 0, // z
866 OPT_XZ = IF_FEATURE_SEAMLESS_XZ( (1 << OPTBIT_XZ )) + 0, // J
867 OPT_COMPRESS = IF_FEATURE_SEAMLESS_Z( (1 << OPTBIT_COMPRESS )) + 0, // Z
868 OPT_NOPRESERVE_TIME = IF_FEATURE_TAR_NOPRESERVE_TIME((1 << OPTBIT_NOPRESERVE_TIME)) + 0, // m
869 OPT_STRIP_COMPONENTS = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_STRIP_COMPONENTS)) + 0, // strip-components
870 OPT_NORECURSION = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_NORECURSION )) + 0, // no-recursion
871 OPT_2COMMAND = IF_FEATURE_TAR_TO_COMMAND( (1 << OPTBIT_2COMMAND )) + 0, // to-command
872 OPT_NUMERIC_OWNER = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_NUMERIC_OWNER )) + 0, // numeric-owner
873 OPT_NOPRESERVE_PERM = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_NOPRESERVE_PERM)) + 0, // no-same-permissions
874 OPT_OVERWRITE = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_OVERWRITE )) + 0, // overwrite
876 OPT_ANY_COMPRESS = (OPT_BZIP2 | OPT_LZMA | OPT_GZIP | OPT_XZ | OPT_COMPRESS),
878 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
879 static const char tar_longopts[] ALIGN1 =
880 "list\0" No_argument "t"
881 "extract\0" No_argument "x"
882 "directory\0" Required_argument "C"
883 "file\0" Required_argument "f"
884 "to-stdout\0" No_argument "O"
885 /* do not restore owner */
886 /* Note: GNU tar handles 'o' as no-same-owner only on extract,
887 * on create, 'o' is --old-archive. We do not support --old-archive. */
888 "no-same-owner\0" No_argument "o"
889 "same-permissions\0" No_argument "p"
890 "verbose\0" No_argument "v"
891 "keep-old\0" No_argument "k"
892 # if ENABLE_FEATURE_TAR_CREATE
893 "create\0" No_argument "c"
894 "dereference\0" No_argument "h"
896 # if ENABLE_FEATURE_SEAMLESS_BZ2
897 "bzip2\0" No_argument "j"
899 # if ENABLE_FEATURE_SEAMLESS_LZMA
900 "lzma\0" No_argument "a"
902 # if ENABLE_FEATURE_TAR_FROM
903 "files-from\0" Required_argument "T"
904 "exclude-from\0" Required_argument "X"
906 # if ENABLE_FEATURE_SEAMLESS_GZ
907 "gzip\0" No_argument "z"
909 # if ENABLE_FEATURE_SEAMLESS_XZ
910 "xz\0" No_argument "J"
912 # if ENABLE_FEATURE_SEAMLESS_Z
913 "compress\0" No_argument "Z"
915 # if ENABLE_FEATURE_TAR_NOPRESERVE_TIME
916 "touch\0" No_argument "m"
918 "strip-components\0" Required_argument "\xf9"
919 "no-recursion\0" No_argument "\xfa"
920 # if ENABLE_FEATURE_TAR_TO_COMMAND
921 "to-command\0" Required_argument "\xfb"
923 /* use numeric uid/gid from tar header, not textual */
924 "numeric-owner\0" No_argument "\xfc"
925 /* do not restore mode */
926 "no-same-permissions\0" No_argument "\xfd"
927 /* on unpack, open with O_TRUNC and !O_EXCL */
928 "overwrite\0" No_argument "\xfe"
929 /* --exclude takes next bit position in option mask, */
930 /* therefore we have to put it _after_ --no-same-permissions */
931 # if ENABLE_FEATURE_TAR_FROM
932 "exclude\0" Required_argument "\xff"
935 # define GETOPT32 getopt32long
936 # define LONGOPTS ,tar_longopts
938 # define GETOPT32 getopt32
942 int tar_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
943 int tar_main(int argc UNUSED_PARAM, char **argv)
945 archive_handle_t *tar_handle;
946 char *base_dir = NULL;
947 const char *tar_filename = "-";
950 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
951 llist_t *excludes = NULL;
955 /* Initialise default values */
956 tar_handle = init_handle();
957 tar_handle->ah_flags = ARCHIVE_CREATE_LEADING_DIRS
958 | ARCHIVE_RESTORE_DATE
959 | ARCHIVE_UNLINK_OLD;
961 /* Apparently only root's tar preserves perms (see bug 3844) */
963 tar_handle->ah_flags |= ARCHIVE_DONT_RESTORE_PERM;
966 /* Lie to buildroot when it starts asking stupid questions. */
967 if (argv[1] && strcmp(argv[1], "--version") == 0) {
968 // Output of 'tar --version' examples:
969 // tar (GNU tar) 1.15.1
970 // tar (GNU tar) 1.25
971 // bsdtar 2.8.3 - libarchive 2.8.3
972 puts("tar (busybox) " BB_VER);
976 if (argv[1] && argv[1][0] != '-' && argv[1][0] != '\0') {
978 * 1st argument without dash handles options with parameters
979 * differently from dashed one: it takes *next argv[i]*
980 * as parameter even if there are more chars in 1st argument:
981 * "tar fx TARFILE" - "x" is not taken as f's param
982 * but is interpreted as -x option
983 * "tar -xf TARFILE" - dashed equivalent of the above
984 * "tar -fx ..." - "x" is taken as f's param
985 * getopt32 wouldn't handle 1st command correctly.
986 * Unfortunately, people do use such commands.
987 * We massage argv[1] to work around it by moving 'f'
988 * to the end of the string.
989 * More contrived "tar fCx TARFILE DIR" still fails,
990 * but such commands are much less likely to be used.
992 char *f = strchr(argv[1], 'f');
994 while (f[1] != '\0') {
1000 /* Prepend '-' to the first argument */
1001 argv[1] = xasprintf("-%s", argv[1]);
1003 opt = GETOPT32(argv, "^"
1005 IF_FEATURE_TAR_CREATE( "ch" )
1006 IF_FEATURE_SEAMLESS_BZ2( "j" )
1007 IF_FEATURE_SEAMLESS_LZMA("a" )
1008 IF_FEATURE_TAR_FROM( "T:*X:*")
1009 IF_FEATURE_SEAMLESS_GZ( "z" )
1010 IF_FEATURE_SEAMLESS_XZ( "J" )
1011 IF_FEATURE_SEAMLESS_Z( "Z" )
1012 IF_FEATURE_TAR_NOPRESERVE_TIME("m")
1013 IF_FEATURE_TAR_LONG_OPTIONS("\xf9:") // --strip-components
1015 "tt:vv:" // count -t,-v
1016 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
1017 "\xff::" // --exclude=PATTERN is a list
1019 IF_FEATURE_TAR_CREATE("c:") "t:x:" // at least one of these is reqd
1020 IF_FEATURE_TAR_CREATE("c--tx:t--cx:x--ct") // mutually exclusive
1021 IF_NOT_FEATURE_TAR_CREATE("t--x:x--t") // mutually exclusive
1022 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
1023 ":\xf9+" // --strip-components=NUM
1026 , &base_dir // -C dir
1027 , &tar_filename // -f filename
1028 IF_FEATURE_TAR_FROM(, &(tar_handle->accept)) // T
1029 IF_FEATURE_TAR_FROM(, &(tar_handle->reject)) // X
1030 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
1031 , &tar_handle->tar__strip_components // --strip-components
1033 IF_FEATURE_TAR_TO_COMMAND(, &(tar_handle->tar__to_command)) // --to-command
1034 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
1035 , &excludes // --exclude
1037 , &verboseFlag // combined count for -t and -v
1038 , &verboseFlag // combined count for -t and -v
1040 #if DBG_OPTION_PARSING
1041 bb_error_msg("opt: 0x%08x", opt);
1042 # define showopt(o) bb_error_msg("opt & %s(%x): %x", #o, o, opt & o);
1044 showopt(OPT_EXTRACT );
1045 showopt(OPT_BASEDIR );
1046 showopt(OPT_TARNAME );
1047 showopt(OPT_2STDOUT );
1048 showopt(OPT_NOPRESERVE_OWNER);
1050 showopt(OPT_VERBOSE );
1051 showopt(OPT_KEEP_OLD );
1052 showopt(OPT_CREATE );
1053 showopt(OPT_DEREFERENCE );
1054 showopt(OPT_BZIP2 );
1056 showopt(OPT_INCLUDE_FROM );
1057 showopt(OPT_EXCLUDE_FROM );
1060 showopt(OPT_COMPRESS );
1061 showopt(OPT_NOPRESERVE_TIME );
1062 showopt(OPT_STRIP_COMPONENTS);
1063 showopt(OPT_NORECURSION );
1064 showopt(OPT_2COMMAND );
1065 showopt(OPT_NUMERIC_OWNER );
1066 showopt(OPT_NOPRESERVE_PERM );
1067 showopt(OPT_OVERWRITE );
1068 showopt(OPT_ANY_COMPRESS );
1069 bb_error_msg("base_dir:'%s'", base_dir);
1070 bb_error_msg("tar_filename:'%s'", tar_filename);
1071 bb_error_msg("verboseFlag:%d", verboseFlag);
1072 bb_error_msg("tar_handle->tar__to_command:'%s'", tar_handle->tar__to_command);
1073 bb_error_msg("tar_handle->tar__strip_components:%u", tar_handle->tar__strip_components);
1080 tar_handle->action_header = header_verbose_list;
1081 if (verboseFlag == 1)
1082 tar_handle->action_header = header_list;
1084 if (opt & OPT_EXTRACT)
1085 tar_handle->action_data = data_extract_all;
1087 if (opt & OPT_2STDOUT)
1088 tar_handle->action_data = data_extract_to_stdout;
1090 if (opt & OPT_2COMMAND) {
1091 putenv((char*)"TAR_FILETYPE=f");
1092 signal(SIGPIPE, SIG_IGN);
1093 tar_handle->action_data = data_extract_to_command;
1094 IF_FEATURE_TAR_TO_COMMAND(tar_handle->tar__to_command_shell = xstrdup(get_shell_name());)
1097 if (opt & OPT_KEEP_OLD)
1098 tar_handle->ah_flags &= ~ARCHIVE_UNLINK_OLD;
1100 if (opt & OPT_NUMERIC_OWNER)
1101 tar_handle->ah_flags |= ARCHIVE_NUMERIC_OWNER;
1103 if (opt & OPT_NOPRESERVE_OWNER)
1104 tar_handle->ah_flags |= ARCHIVE_DONT_RESTORE_OWNER;
1106 if (opt & OPT_NOPRESERVE_PERM)
1107 tar_handle->ah_flags |= ARCHIVE_DONT_RESTORE_PERM;
1109 if (opt & OPT_OVERWRITE) {
1110 tar_handle->ah_flags &= ~ARCHIVE_UNLINK_OLD;
1111 tar_handle->ah_flags |= ARCHIVE_O_TRUNC;
1114 if (opt & OPT_NOPRESERVE_TIME)
1115 tar_handle->ah_flags &= ~ARCHIVE_RESTORE_DATE;
1117 #if ENABLE_FEATURE_TAR_FROM
1118 tar_handle->reject = append_file_list_to_list(tar_handle->reject);
1119 # if ENABLE_FEATURE_TAR_LONG_OPTIONS
1120 /* Append excludes to reject */
1122 llist_t *next = excludes->link;
1123 excludes->link = tar_handle->reject;
1124 tar_handle->reject = excludes;
1128 tar_handle->accept = append_file_list_to_list(tar_handle->accept);
1131 /* Setup an array of filenames to work with */
1132 /* TODO: This is the same as in ar, make a separate function? */
1134 /* kill trailing '/' unless the string is just "/" */
1135 char *cp = last_char_is(*argv, '/');
1138 llist_add_to_end(&tar_handle->accept, *argv);
1142 if (tar_handle->accept || tar_handle->reject)
1143 tar_handle->filter = filter_accept_reject_list;
1145 /* Open the tar file */
1147 int tar_fd = STDIN_FILENO;
1148 int flags = O_RDONLY;
1150 if (opt & OPT_CREATE) {
1151 /* Make sure there is at least one file to tar up */
1152 if (tar_handle->accept == NULL)
1153 bb_error_msg_and_die("empty archive");
1155 tar_fd = STDOUT_FILENO;
1156 /* Mimicking GNU tar 1.15.1: */
1157 flags = O_WRONLY | O_CREAT | O_TRUNC;
1160 if (LONE_DASH(tar_filename)) {
1161 tar_handle->src_fd = tar_fd;
1162 tar_handle->seek = seek_by_read;
1164 if (ENABLE_FEATURE_TAR_AUTODETECT
1165 && flags == O_RDONLY
1166 && !(opt & OPT_ANY_COMPRESS)
1168 tar_handle->src_fd = open_zipped(tar_filename, /*fail_if_not_compressed:*/ 0);
1169 if (tar_handle->src_fd < 0)
1170 bb_perror_msg_and_die("can't open '%s'", tar_filename);
1172 tar_handle->src_fd = xopen(tar_filename, flags);
1179 #if ENABLE_FEATURE_TAR_CREATE
1180 /* Create an archive */
1181 if (opt & OPT_CREATE) {
1182 struct TarBallInfo *tbInfo;
1183 # if SEAMLESS_COMPRESSION
1184 const char *zipMode = NULL;
1185 if (opt & OPT_COMPRESS)
1186 zipMode = "compress";
1189 if (opt & OPT_BZIP2)
1196 tbInfo = xzalloc(sizeof(*tbInfo));
1197 tbInfo->tarFd = tar_handle->src_fd;
1198 tbInfo->verboseFlag = verboseFlag;
1199 # if ENABLE_FEATURE_TAR_FROM
1200 tbInfo->excludeList = tar_handle->reject;
1202 /* NB: writeTarFile() closes tar_handle->src_fd */
1203 return writeTarFile(tbInfo,
1204 (opt & OPT_DEREFERENCE ? ACTION_FOLLOWLINKS : 0)
1205 | (opt & OPT_NORECURSION ? 0 : ACTION_RECURSE),
1211 if (opt & OPT_ANY_COMPRESS) {
1212 USE_FOR_MMU(IF_DESKTOP(long long) int FAST_FUNC (*xformer)(transformer_state_t *xstate);)
1213 USE_FOR_NOMMU(const char *xformer_prog;)
1215 if (opt & OPT_COMPRESS) {
1216 USE_FOR_MMU(IF_FEATURE_SEAMLESS_Z(xformer = unpack_Z_stream;))
1217 USE_FOR_NOMMU(xformer_prog = "uncompress";)
1219 if (opt & OPT_GZIP) {
1220 USE_FOR_MMU(IF_FEATURE_SEAMLESS_GZ(xformer = unpack_gz_stream;))
1221 USE_FOR_NOMMU(xformer_prog = "gunzip";)
1223 if (opt & OPT_BZIP2) {
1224 USE_FOR_MMU(IF_FEATURE_SEAMLESS_BZ2(xformer = unpack_bz2_stream;))
1225 USE_FOR_NOMMU(xformer_prog = "bunzip2";)
1227 if (opt & OPT_LZMA) {
1228 USE_FOR_MMU(IF_FEATURE_SEAMLESS_LZMA(xformer = unpack_lzma_stream;))
1229 USE_FOR_NOMMU(xformer_prog = "unlzma";)
1232 USE_FOR_MMU(IF_FEATURE_SEAMLESS_XZ(xformer = unpack_xz_stream;))
1233 USE_FOR_NOMMU(xformer_prog = "unxz";)
1236 fork_transformer_with_sig(tar_handle->src_fd, xformer, xformer_prog);
1237 /* Can't lseek over pipes */
1238 tar_handle->seek = seek_by_read;
1239 /*tar_handle->offset = 0; - already is */
1242 /* Zero processed headers (== empty file) is not a valid tarball.
1243 * We (ab)use bb_got_signal as exitcode here,
1244 * because check_errors_in_children() uses _it_ as error indicator.
1246 bb_got_signal = EXIT_FAILURE;
1248 while (get_header_tar(tar_handle) == EXIT_SUCCESS)
1249 bb_got_signal = EXIT_SUCCESS; /* saw at least one header, good */
1251 create_links_from_list(tar_handle->link_placeholders);
1253 /* Check that every file that should have been extracted was */
1254 while (tar_handle->accept) {
1255 if (!find_list_entry(tar_handle->reject, tar_handle->accept->data)
1256 && !find_list_entry(tar_handle->passed, tar_handle->accept->data)
1258 bb_error_msg_and_die("%s: not found in archive",
1259 tar_handle->accept->data);
1261 tar_handle->accept = tar_handle->accept->link;
1263 if (ENABLE_FEATURE_CLEAN_UP /* && tar_handle->src_fd != STDIN_FILENO */)
1264 close(tar_handle->src_fd);
1266 if (SEAMLESS_COMPRESSION || OPT_COMPRESS) {
1267 /* Set bb_got_signal to 1 if a child died with !0 exitcode */
1268 check_errors_in_children(0);
1271 return bb_got_signal;