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.
25 /* TODO: security with -C DESTDIR option can be enhanced.
26 * Consider tar file created via:
27 * $ tar cvf bug.tar anything.txt
28 * $ ln -s /tmp symlink
29 * $ tar --append -f bug.tar symlink
32 * $ tar --append -f bug.tar symlink/evil.py
34 * This will result in an archive which contains:
35 * $ tar --list -f bug.tar
40 * Untarring it puts evil.py in '/tmp' even if the -C DESTDIR is given.
41 * This doesn't feel right, and IIRC GNU tar doesn't do that.
48 //config: tar is an archiving program. It's commonly used with gzip to
49 //config: create compressed archives. It's probably the most widely used
50 //config: UNIX archive program.
52 //config:config FEATURE_TAR_CREATE
53 //config: bool "Enable archive creation"
55 //config: depends on TAR
57 //config: If you enable this option you'll be able to create
58 //config: tar archives using the `-c' option.
60 //config:config FEATURE_TAR_AUTODETECT
61 //config: bool "Autodetect compressed tarballs"
63 //config: depends on TAR && (FEATURE_SEAMLESS_Z || FEATURE_SEAMLESS_GZ || FEATURE_SEAMLESS_BZ2 || FEATURE_SEAMLESS_LZMA || FEATURE_SEAMLESS_XZ)
65 //config: With this option tar can automatically detect compressed
66 //config: tarballs. Currently it works only on files (not pipes etc).
68 //config:config FEATURE_TAR_FROM
69 //config: bool "Enable -X (exclude from) and -T (include from) options)"
71 //config: depends on TAR
73 //config: If you enable this option you'll be able to specify
74 //config: a list of files to include or exclude from an archive.
76 //config:config FEATURE_TAR_OLDGNU_COMPATIBILITY
77 //config: bool "Support for old tar header format"
79 //config: depends on TAR || DPKG
81 //config: This option is required to unpack archives created in
82 //config: the old GNU format; help to kill this old format by
83 //config: repacking your ancient archives with the new format.
85 //config:config FEATURE_TAR_OLDSUN_COMPATIBILITY
86 //config: bool "Enable untarring of tarballs with checksums produced by buggy Sun tar"
88 //config: depends on TAR || DPKG
90 //config: This option is required to unpack archives created by some old
91 //config: version of Sun's tar (it was calculating checksum using signed
92 //config: arithmetic). It is said to be fixed in newer Sun tar, but "old"
93 //config: tarballs still exist.
95 //config:config FEATURE_TAR_GNU_EXTENSIONS
96 //config: bool "Support for GNU tar extensions (long filenames)"
98 //config: depends on TAR || DPKG
100 //config: With this option busybox supports GNU long filenames and
103 //config:config FEATURE_TAR_LONG_OPTIONS
104 //config: bool "Enable long options"
106 //config: depends on TAR && LONG_OPTS
108 //config: Enable use of long options, increases size by about 400 Bytes
110 //config:config FEATURE_TAR_TO_COMMAND
111 //config: bool "Support for writing to an external program"
113 //config: depends on TAR && FEATURE_TAR_LONG_OPTIONS
115 //config: If you enable this option you'll be able to instruct tar to send
116 //config: the contents of each extracted file to the standard input of an
117 //config: external program.
119 //config:config FEATURE_TAR_UNAME_GNAME
120 //config: bool "Enable use of user and group names"
122 //config: depends on TAR
124 //config: Enables use of user and group names in tar. This affects contents
125 //config: listings (-t) and preserving permissions when unpacking (-p).
126 //config: +200 bytes.
128 //config:config FEATURE_TAR_NOPRESERVE_TIME
129 //config: bool "Enable -m (do not preserve time) option"
131 //config: depends on TAR
133 //config: With this option busybox supports GNU tar -m
134 //config: (do not preserve time) option.
136 //config:config FEATURE_TAR_SELINUX
137 //config: bool "Support for extracting SELinux labels"
139 //config: depends on TAR && SELINUX
141 //config: With this option busybox supports restoring SELinux labels
142 //config: when extracting files from tar archives.
144 //applet:IF_TAR(APPLET(tar, BB_DIR_BIN, BB_SUID_DROP))
145 //kbuild:lib-$(CONFIG_TAR) += tar.o
149 #include "common_bufsiz.h"
150 #include "bb_archive.h"
151 /* FIXME: Stop using this non-standard feature */
152 #ifndef FNM_LEADING_DIR
153 # define FNM_LEADING_DIR 0
157 # define DBG(fmt, ...) bb_error_msg("%s: " fmt, __func__, ## __VA_ARGS__)
159 # define DBG(...) ((void)0)
161 #define DBG_OPTION_PARSING 0
164 #define block_buf bb_common_bufsiz1
167 #if ENABLE_FEATURE_TAR_CREATE
170 ** writeTarFile(), writeFileToTarball(), and writeTarHeader() are
171 ** the only functions that deal with the HardLinkInfo structure.
172 ** Even these functions use the xxxHardLinkInfo() functions.
174 typedef struct HardLinkInfo {
175 struct HardLinkInfo *next; /* Next entry in list */
176 dev_t dev; /* Device number */
177 ino_t ino; /* Inode number */
178 // short linkCount; /* (Hard) Link Count */
179 char name[1]; /* Start of filename (must be last) */
182 /* Some info to be carried along when creating a new tarball */
183 typedef struct TarBallInfo {
184 int tarFd; /* Open-for-write file descriptor
186 int verboseFlag; /* Whether to print extra stuff or not */
187 const llist_t *excludeList; /* List of files to not include */
188 HardLinkInfo *hlInfoHead; /* Hard Link Tracking Information */
189 HardLinkInfo *hlInfo; /* Hard Link Info for the current file */
190 //TODO: save only st_dev + st_ino
191 struct stat tarFileStatBuf; /* Stat info for the tarball, letting
192 * us know the inode and device that the
193 * tarball lives, so we can avoid trying
194 * to include the tarball into itself */
197 /* A nice enum with all the possible tar file content types */
199 REGTYPE = '0', /* regular file */
200 REGTYPE0 = '\0', /* regular file (ancient bug compat) */
201 LNKTYPE = '1', /* hard link */
202 SYMTYPE = '2', /* symbolic link */
203 CHRTYPE = '3', /* character special */
204 BLKTYPE = '4', /* block special */
205 DIRTYPE = '5', /* directory */
206 FIFOTYPE = '6', /* FIFO special */
207 CONTTYPE = '7', /* reserved */
208 GNULONGLINK = 'K', /* GNU long (>100 chars) link name */
209 GNULONGNAME = 'L', /* GNU long (>100 chars) file name */
212 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
213 static void addHardLinkInfo(HardLinkInfo **hlInfoHeadPtr,
214 struct stat *statbuf,
215 const char *fileName)
217 /* Note: hlInfoHeadPtr can never be NULL! */
218 HardLinkInfo *hlInfo;
220 hlInfo = xmalloc(sizeof(HardLinkInfo) + strlen(fileName));
221 hlInfo->next = *hlInfoHeadPtr;
222 *hlInfoHeadPtr = hlInfo;
223 hlInfo->dev = statbuf->st_dev;
224 hlInfo->ino = statbuf->st_ino;
225 // hlInfo->linkCount = statbuf->st_nlink;
226 strcpy(hlInfo->name, fileName);
229 static void freeHardLinkInfo(HardLinkInfo **hlInfoHeadPtr)
231 HardLinkInfo *hlInfo;
232 HardLinkInfo *hlInfoNext;
235 hlInfo = *hlInfoHeadPtr;
237 hlInfoNext = hlInfo->next;
241 *hlInfoHeadPtr = NULL;
245 /* Might be faster (and bigger) if the dev/ino were stored in numeric order ;) */
246 static HardLinkInfo *findHardLinkInfo(HardLinkInfo *hlInfo, struct stat *statbuf)
249 if (statbuf->st_ino == hlInfo->ino
250 && statbuf->st_dev == hlInfo->dev
252 DBG("found hardlink:'%s'", hlInfo->name);
255 hlInfo = hlInfo->next;
260 /* Put an octal string into the specified buffer.
261 * The number is zero padded and possibly null terminated.
262 * Stores low-order bits only if whole value does not fit. */
263 static void putOctal(char *cp, int len, off_t value)
265 char tempBuffer[sizeof(off_t)*3 + 1];
266 char *tempString = tempBuffer;
269 width = sprintf(tempBuffer, "%0*"OFF_FMT"o", len, value);
270 tempString += (width - len);
272 /* If string has leading zeroes, we can drop one */
273 /* and field will have trailing '\0' */
274 /* (increases chances of compat with other tars) */
275 if (tempString[0] == '0')
278 /* Copy the string to the field */
279 memcpy(cp, tempString, len);
281 #define PUT_OCTAL(a, b) putOctal((a), sizeof(a), (b))
283 static void chksum_and_xwrite(int fd, struct tar_header_t* hp)
285 /* POSIX says that checksum is done on unsigned bytes
286 * (Sun and HP-UX gets it wrong... more details in
288 const unsigned char *cp;
291 strcpy(hp->magic, "ustar ");
293 /* Calculate and store the checksum (i.e., the sum of all of the bytes of
294 * the header). The checksum field must be filled with blanks for the
295 * calculation. The checksum field is formatted differently from the
296 * other fields: it has 6 digits, a null, then a space -- rather than
297 * digits, followed by a null like the other fields... */
298 memset(hp->chksum, ' ', sizeof(hp->chksum));
299 cp = (const unsigned char *) hp;
302 do { chksum += *cp++; } while (--size);
303 putOctal(hp->chksum, sizeof(hp->chksum)-1, chksum);
305 /* Now write the header out to disk */
306 xwrite(fd, hp, sizeof(*hp));
309 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
310 static void writeLongname(int fd, int type, const char *name, int dir)
312 static const struct {
313 char mode[8]; /* 100-107 */
314 char uid[8]; /* 108-115 */
315 char gid[8]; /* 116-123 */
316 char size[12]; /* 124-135 */
317 char mtime[12]; /* 136-147 */
325 struct tar_header_t header;
328 dir = !!dir; /* normalize: 0/1 */
329 size = strlen(name) + 1 + dir; /* GNU tar uses strlen+1 */
330 /* + dir: account for possible '/' */
332 memset(&header, 0, sizeof(header));
333 strcpy(header.name, "././@LongLink");
334 memcpy(header.mode, prefilled.mode, sizeof(prefilled));
335 PUT_OCTAL(header.size, size);
336 header.typeflag = type;
337 chksum_and_xwrite(fd, &header);
339 /* Write filename[/] and pad the block. */
340 /* dir=0: writes 'name<NUL>', pads */
341 /* dir=1: writes 'name', writes '/<NUL>', pads */
343 xwrite(fd, name, size - dir);
344 xwrite(fd, "/", dir);
345 size = (-size) & (TAR_BLOCK_SIZE-1);
346 memset(&header, 0, size);
347 xwrite(fd, &header, size);
351 /* Write out a tar header for the specified file/directory/whatever */
352 static int writeTarHeader(struct TarBallInfo *tbInfo,
353 const char *header_name, const char *fileName, struct stat *statbuf)
355 struct tar_header_t header;
357 memset(&header, 0, sizeof(header));
359 strncpy(header.name, header_name, sizeof(header.name));
361 /* POSIX says to mask mode with 07777. */
362 PUT_OCTAL(header.mode, statbuf->st_mode & 07777);
363 PUT_OCTAL(header.uid, statbuf->st_uid);
364 PUT_OCTAL(header.gid, statbuf->st_gid);
365 memset(header.size, '0', sizeof(header.size)-1); /* Regular file size is handled later */
366 /* users report that files with negative st_mtime cause trouble, so: */
367 PUT_OCTAL(header.mtime, statbuf->st_mtime >= 0 ? statbuf->st_mtime : 0);
369 /* Enter the user and group names */
370 safe_strncpy(header.uname, get_cached_username(statbuf->st_uid), sizeof(header.uname));
371 safe_strncpy(header.gname, get_cached_groupname(statbuf->st_gid), sizeof(header.gname));
373 if (tbInfo->hlInfo) {
374 /* This is a hard link */
375 header.typeflag = LNKTYPE;
376 strncpy(header.linkname, tbInfo->hlInfo->name,
377 sizeof(header.linkname));
378 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
379 /* Write out long linkname if needed */
380 if (header.linkname[sizeof(header.linkname)-1])
381 writeLongname(tbInfo->tarFd, GNULONGLINK,
382 tbInfo->hlInfo->name, 0);
384 } else if (S_ISLNK(statbuf->st_mode)) {
385 char *lpath = xmalloc_readlink_or_warn(fileName);
388 header.typeflag = SYMTYPE;
389 strncpy(header.linkname, lpath, sizeof(header.linkname));
390 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
391 /* Write out long linkname if needed */
392 if (header.linkname[sizeof(header.linkname)-1])
393 writeLongname(tbInfo->tarFd, GNULONGLINK, lpath, 0);
395 /* If it is larger than 100 bytes, bail out */
396 if (header.linkname[sizeof(header.linkname)-1]) {
398 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
403 } else if (S_ISDIR(statbuf->st_mode)) {
404 header.typeflag = DIRTYPE;
405 /* Append '/' only if there is a space for it */
406 if (!header.name[sizeof(header.name)-1])
407 header.name[strlen(header.name)] = '/';
408 } else if (S_ISCHR(statbuf->st_mode)) {
409 header.typeflag = CHRTYPE;
410 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
411 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
412 } else if (S_ISBLK(statbuf->st_mode)) {
413 header.typeflag = BLKTYPE;
414 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
415 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
416 } else if (S_ISFIFO(statbuf->st_mode)) {
417 header.typeflag = FIFOTYPE;
418 } else if (S_ISREG(statbuf->st_mode)) {
419 /* header.size field is 12 bytes long */
420 /* Does octal-encoded size fit? */
421 uoff_t filesize = statbuf->st_size;
422 if (sizeof(filesize) <= 4
423 || filesize <= (uoff_t)0777777777777LL
425 PUT_OCTAL(header.size, filesize);
427 /* Does base256-encoded size fit?
428 * It always does unless off_t is wider than 64 bits.
430 else if (ENABLE_FEATURE_TAR_GNU_EXTENSIONS
431 #if ULLONG_MAX > 0xffffffffffffffffLL /* 2^64-1 */
432 && (filesize <= 0x3fffffffffffffffffffffffLL)
435 /* GNU tar uses "base-256 encoding" for very large numbers.
436 * Encoding is binary, with highest bit always set as a marker
437 * and sign in next-highest bit:
439 * bf ff .. ff - largest positive number
440 * ff ff .. ff - minus 1
441 * c0 00 .. 00 - smallest negative number
443 char *p8 = header.size + sizeof(header.size);
445 *--p8 = (uint8_t)filesize;
447 } while (p8 != header.size);
450 bb_error_msg_and_die("can't store file '%s' "
451 "of size %"OFF_FMT"u, aborting",
452 fileName, statbuf->st_size);
454 header.typeflag = REGTYPE;
456 bb_error_msg("%s: unknown file type", fileName);
460 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
461 /* Write out long name if needed */
462 /* (we, like GNU tar, output long linkname *before* long name) */
463 if (header.name[sizeof(header.name)-1])
464 writeLongname(tbInfo->tarFd, GNULONGNAME,
465 header_name, S_ISDIR(statbuf->st_mode));
468 /* Now write the header out to disk */
469 chksum_and_xwrite(tbInfo->tarFd, &header);
471 /* Now do the verbose thing (or not) */
472 if (tbInfo->verboseFlag) {
475 /* If archive goes to stdout, verbose goes to stderr */
476 if (tbInfo->tarFd == STDOUT_FILENO)
478 /* GNU "tar cvvf" prints "extended" listing a-la "ls -l" */
479 /* We don't have such excesses here: for us "v" == "vv" */
480 /* '/' is probably a GNUism */
481 fprintf(vbFd, "%s%s\n", header_name,
482 S_ISDIR(statbuf->st_mode) ? "/" : "");
488 #if ENABLE_FEATURE_TAR_FROM
489 static int exclude_file(const llist_t *excluded_files, const char *file)
491 while (excluded_files) {
492 if (excluded_files->data[0] == '/') {
493 if (fnmatch(excluded_files->data, file,
494 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
499 for (p = file; p[0] != '\0'; p++) {
500 if ((p == file || p[-1] == '/')
502 && fnmatch(excluded_files->data, p,
503 FNM_PATHNAME | FNM_LEADING_DIR) == 0
509 excluded_files = excluded_files->link;
515 # define exclude_file(excluded_files, file) 0
518 static int FAST_FUNC writeFileToTarball(const char *fileName, struct stat *statbuf,
519 void *userData, int depth UNUSED_PARAM)
521 struct TarBallInfo *tbInfo = (struct TarBallInfo *) userData;
522 const char *header_name;
523 int inputFileFd = -1;
525 DBG("writeFileToTarball('%s')", fileName);
527 /* Strip leading '/' and such (must be before memorizing hardlink's name) */
528 header_name = strip_unsafe_prefix(fileName);
530 if (header_name[0] == '\0')
533 /* It is against the rules to archive a socket */
534 if (S_ISSOCK(statbuf->st_mode)) {
535 bb_error_msg("%s: socket ignored", fileName);
540 * Check to see if we are dealing with a hard link.
542 * Treat the first occurance of a given dev/inode as a file while
543 * treating any additional occurances as hard links. This is done
544 * by adding the file information to the HardLinkInfo linked list.
546 tbInfo->hlInfo = NULL;
547 if (!S_ISDIR(statbuf->st_mode) && statbuf->st_nlink > 1) {
548 DBG("'%s': st_nlink > 1", header_name);
549 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf);
550 if (tbInfo->hlInfo == NULL) {
551 DBG("'%s': addHardLinkInfo", header_name);
552 addHardLinkInfo(&tbInfo->hlInfoHead, statbuf, header_name);
556 /* It is a bad idea to store the archive we are in the process of creating,
557 * so check the device and inode to be sure that this particular file isn't
559 if (tbInfo->tarFileStatBuf.st_dev == statbuf->st_dev
560 && tbInfo->tarFileStatBuf.st_ino == statbuf->st_ino
562 bb_error_msg("%s: file is the archive; skipping", fileName);
566 if (exclude_file(tbInfo->excludeList, header_name))
569 #if !ENABLE_FEATURE_TAR_GNU_EXTENSIONS
570 if (strlen(header_name) >= NAME_SIZE) {
571 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
576 /* Is this a regular file? */
577 if (tbInfo->hlInfo == NULL && S_ISREG(statbuf->st_mode)) {
578 /* open the file we want to archive, and make sure all is well */
579 inputFileFd = open_or_warn(fileName, O_RDONLY);
580 if (inputFileFd < 0) {
585 /* Add an entry to the tarball */
586 if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
590 /* If it was a regular file, write out the body */
591 if (inputFileFd >= 0) {
593 /* Write the file to the archive. */
594 /* We record size into header first, */
595 /* and then write out file. If file shrinks in between, */
596 /* tar will be corrupted. So we don't allow for that. */
597 /* NB: GNU tar 1.16 warns and pads with zeroes */
598 /* or even seeks back and updates header */
599 bb_copyfd_exact_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
601 ////readSize = bb_copyfd_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
602 ////if (readSize != statbuf->st_size && readSize >= 0) {
603 //// bb_error_msg_and_die("short read from %s, aborting", fileName);
606 /* Check that file did not grow in between? */
607 /* if (safe_read(inputFileFd, 1) == 1) warn but continue? */
611 /* Pad the file up to the tar block size */
612 /* (a few tricks here in the name of code size) */
613 readSize = (-(int)statbuf->st_size) & (TAR_BLOCK_SIZE-1);
614 memset(block_buf, 0, readSize);
615 xwrite(tbInfo->tarFd, block_buf, readSize);
621 #if SEAMLESS_COMPRESSION
622 /* Don't inline: vfork scares gcc and pessimizes code */
623 static void NOINLINE vfork_compressor(int tar_fd, const char *gzip)
627 // On Linux, vfork never unpauses parent early, although standard
628 // allows for that. Do we want to waste bytes checking for it?
629 # define WAIT_FOR_CHILD 0
630 volatile int vfork_exec_errno = 0;
631 struct fd_pair gzipDataPipe;
633 struct fd_pair gzipStatusPipe;
634 xpiped_pair(gzipStatusPipe);
636 xpiped_pair(gzipDataPipe);
638 signal(SIGPIPE, SIG_IGN); /* we only want EPIPE on errors */
644 /* NB: close _first_, then move fds! */
645 close(gzipDataPipe.wr);
647 close(gzipStatusPipe.rd);
648 /* gzipStatusPipe.wr will close only on exec -
649 * parent waits for this close to happen */
650 fcntl(gzipStatusPipe.wr, F_SETFD, FD_CLOEXEC);
652 xmove_fd(gzipDataPipe.rd, 0);
654 /* exec gzip/bzip2 program/applet */
655 BB_EXECLP(gzip, gzip, "-f", (char *)0);
656 vfork_exec_errno = errno;
661 xmove_fd(gzipDataPipe.wr, tar_fd);
662 close(gzipDataPipe.rd);
664 close(gzipStatusPipe.wr);
669 /* Wait until child execs (or fails to) */
670 n = full_read(gzipStatusPipe.rd, &buf, 1);
671 if (n < 0 /* && errno == EAGAIN */)
672 continue; /* try it again */
674 close(gzipStatusPipe.rd);
676 if (vfork_exec_errno) {
677 errno = vfork_exec_errno;
678 bb_perror_msg_and_die("can't execute '%s'", gzip);
681 #endif /* SEAMLESS_COMPRESSION */
684 #if !SEAMLESS_COMPRESSION
685 /* Do not pass gzip flag to writeTarFile() */
686 #define writeTarFile(tar_fd, verboseFlag, recurseFlags, include, exclude, gzip) \
687 writeTarFile(tar_fd, verboseFlag, recurseFlags, include, exclude)
689 /* gcc 4.2.1 inlines it, making code bigger */
690 static NOINLINE int writeTarFile(int tar_fd, int verboseFlag,
691 int recurseFlags, const llist_t *include,
692 const llist_t *exclude, const char *gzip)
694 int errorFlag = FALSE;
695 struct TarBallInfo tbInfo;
697 tbInfo.hlInfoHead = NULL;
698 tbInfo.tarFd = tar_fd;
699 tbInfo.verboseFlag = verboseFlag;
701 /* Store the stat info for the tarball's file, so
702 * can avoid including the tarball into itself.... */
703 xfstat(tbInfo.tarFd, &tbInfo.tarFileStatBuf, "can't stat tar file");
705 #if SEAMLESS_COMPRESSION
707 vfork_compressor(tbInfo.tarFd, gzip);
710 tbInfo.excludeList = exclude;
712 /* Read the directory/files and iterate over them one at a time */
714 if (!recursive_action(include->data, recurseFlags,
715 writeFileToTarball, writeFileToTarball, &tbInfo, 0)
719 include = include->link;
721 /* Write two empty blocks to the end of the archive */
722 memset(block_buf, 0, 2*TAR_BLOCK_SIZE);
723 xwrite(tbInfo.tarFd, block_buf, 2*TAR_BLOCK_SIZE);
725 /* To be pedantically correct, we would check if the tarball
726 * is smaller than 20 tar blocks, and pad it if it was smaller,
727 * but that isn't necessary for GNU tar interoperability, and
728 * so is considered a waste of space */
730 /* Close so the child process (if any) will exit */
733 /* Hang up the tools, close up shop, head home */
734 if (ENABLE_FEATURE_CLEAN_UP)
735 freeHardLinkInfo(&tbInfo.hlInfoHead);
738 bb_error_msg("error exit delayed from previous errors");
740 #if SEAMLESS_COMPRESSION
743 if (safe_waitpid(-1, &status, 0) == -1)
744 bb_perror_msg("waitpid");
745 else if (!WIFEXITED(status) || WEXITSTATUS(status))
746 /* gzip was killed or has exited with nonzero! */
752 #else /* !FEATURE_TAR_CREATE */
753 # define writeTarFile(...) 0
756 #if ENABLE_FEATURE_TAR_FROM
757 static llist_t *append_file_list_to_list(llist_t *list)
761 llist_t *newlist = NULL;
764 src_stream = xfopen_stdin(llist_pop(&list));
765 while ((line = xmalloc_fgetline(src_stream)) != NULL) {
766 /* kill trailing '/' unless the string is just "/" */
767 char *cp = last_char_is(line, '/');
770 llist_add_to_end(&newlist, line);
778 //usage:#define tar_trivial_usage
779 //usage: "-[" IF_FEATURE_TAR_CREATE("c") "xt"
780 //usage: IF_FEATURE_SEAMLESS_Z("Z")
781 //usage: IF_FEATURE_SEAMLESS_GZ("z")
782 //usage: IF_FEATURE_SEAMLESS_XZ("J")
783 //usage: IF_FEATURE_SEAMLESS_BZ2("j")
784 //usage: IF_FEATURE_SEAMLESS_LZMA("a")
785 //usage: IF_FEATURE_TAR_CREATE("h")
786 //usage: IF_FEATURE_TAR_NOPRESERVE_TIME("m")
788 //usage: IF_FEATURE_TAR_FROM("[-X FILE] [-T FILE] ")
789 //usage: "[-f TARFILE] [-C DIR] [FILE]..."
790 //usage:#define tar_full_usage "\n\n"
791 //usage: IF_FEATURE_TAR_CREATE("Create, extract, ")
792 //usage: IF_NOT_FEATURE_TAR_CREATE("Extract ")
793 //usage: "or list files from a tar file\n"
794 //usage: "\nOperation:"
795 //usage: IF_FEATURE_TAR_CREATE(
796 //usage: "\n c Create"
798 //usage: "\n x Extract"
800 //usage: "\n f Name of TARFILE ('-' for stdin/out)"
801 //usage: "\n C Change to DIR before operation"
802 //usage: "\n v Verbose"
803 //usage: IF_FEATURE_SEAMLESS_Z(
804 //usage: "\n Z (De)compress using compress"
806 //usage: IF_FEATURE_SEAMLESS_GZ(
807 //usage: "\n z (De)compress using gzip"
809 //usage: IF_FEATURE_SEAMLESS_XZ(
810 //usage: "\n J (De)compress using xz"
812 //usage: IF_FEATURE_SEAMLESS_BZ2(
813 //usage: "\n j (De)compress using bzip2"
815 //usage: IF_FEATURE_SEAMLESS_LZMA(
816 //usage: "\n a (De)compress using lzma"
818 //usage: "\n O Extract to stdout"
819 //usage: IF_FEATURE_TAR_CREATE(
820 //usage: "\n h Follow symlinks"
822 //usage: IF_FEATURE_TAR_NOPRESERVE_TIME(
823 //usage: "\n m Don't restore mtime"
825 //usage: IF_FEATURE_TAR_FROM(
826 //usage: IF_FEATURE_TAR_LONG_OPTIONS(
827 //usage: "\n exclude File to exclude"
829 //usage: "\n X File with names to exclude"
830 //usage: "\n T File with names to include"
833 //usage:#define tar_example_usage
834 //usage: "$ zcat /tmp/tarball.tar.gz | tar -xf -\n"
835 //usage: "$ tar -cf /tmp/tarball.tar /usr/local\n"
837 // Supported but aren't in --help:
839 // p same-permissions
843 // no-same-permissions
845 //IF_FEATURE_TAR_TO_COMMAND(
851 IF_FEATURE_TAR_CREATE( OPTBIT_CREATE ,)
852 IF_FEATURE_TAR_CREATE( OPTBIT_DEREFERENCE ,)
853 IF_FEATURE_SEAMLESS_BZ2( OPTBIT_BZIP2 ,)
854 IF_FEATURE_SEAMLESS_LZMA(OPTBIT_LZMA ,)
855 IF_FEATURE_TAR_FROM( OPTBIT_INCLUDE_FROM,)
856 IF_FEATURE_TAR_FROM( OPTBIT_EXCLUDE_FROM,)
857 IF_FEATURE_SEAMLESS_GZ( OPTBIT_GZIP ,)
858 IF_FEATURE_SEAMLESS_XZ( OPTBIT_XZ ,) // 16th bit
859 IF_FEATURE_SEAMLESS_Z( OPTBIT_COMPRESS ,)
860 IF_FEATURE_TAR_NOPRESERVE_TIME(OPTBIT_NOPRESERVE_TIME,)
861 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
862 OPTBIT_STRIP_COMPONENTS,
864 IF_FEATURE_TAR_TO_COMMAND(OPTBIT_2COMMAND ,)
865 OPTBIT_NUMERIC_OWNER,
866 OPTBIT_NOPRESERVE_PERM,
869 OPT_TEST = 1 << 0, // t
870 OPT_EXTRACT = 1 << 1, // x
871 OPT_BASEDIR = 1 << 2, // C
872 OPT_TARNAME = 1 << 3, // f
873 OPT_2STDOUT = 1 << 4, // O
874 OPT_NOPRESERVE_OWNER = 1 << 5, // o == no-same-owner
876 OPT_VERBOSE = 1 << 7, // v
877 OPT_KEEP_OLD = 1 << 8, // k
878 OPT_CREATE = IF_FEATURE_TAR_CREATE( (1 << OPTBIT_CREATE )) + 0, // c
879 OPT_DEREFERENCE = IF_FEATURE_TAR_CREATE( (1 << OPTBIT_DEREFERENCE )) + 0, // h
880 OPT_BZIP2 = IF_FEATURE_SEAMLESS_BZ2( (1 << OPTBIT_BZIP2 )) + 0, // j
881 OPT_LZMA = IF_FEATURE_SEAMLESS_LZMA((1 << OPTBIT_LZMA )) + 0, // a
882 OPT_INCLUDE_FROM = IF_FEATURE_TAR_FROM( (1 << OPTBIT_INCLUDE_FROM)) + 0, // T
883 OPT_EXCLUDE_FROM = IF_FEATURE_TAR_FROM( (1 << OPTBIT_EXCLUDE_FROM)) + 0, // X
884 OPT_GZIP = IF_FEATURE_SEAMLESS_GZ( (1 << OPTBIT_GZIP )) + 0, // z
885 OPT_XZ = IF_FEATURE_SEAMLESS_XZ( (1 << OPTBIT_XZ )) + 0, // J
886 OPT_COMPRESS = IF_FEATURE_SEAMLESS_Z( (1 << OPTBIT_COMPRESS )) + 0, // Z
887 OPT_NOPRESERVE_TIME = IF_FEATURE_TAR_NOPRESERVE_TIME((1 << OPTBIT_NOPRESERVE_TIME)) + 0, // m
888 OPT_STRIP_COMPONENTS = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_STRIP_COMPONENTS)) + 0, // strip-components
889 OPT_NORECURSION = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_NORECURSION )) + 0, // no-recursion
890 OPT_2COMMAND = IF_FEATURE_TAR_TO_COMMAND( (1 << OPTBIT_2COMMAND )) + 0, // to-command
891 OPT_NUMERIC_OWNER = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_NUMERIC_OWNER )) + 0, // numeric-owner
892 OPT_NOPRESERVE_PERM = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_NOPRESERVE_PERM)) + 0, // no-same-permissions
893 OPT_OVERWRITE = IF_FEATURE_TAR_LONG_OPTIONS((1 << OPTBIT_OVERWRITE )) + 0, // overwrite
895 OPT_ANY_COMPRESS = (OPT_BZIP2 | OPT_LZMA | OPT_GZIP | OPT_XZ | OPT_COMPRESS),
897 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
898 static const char tar_longopts[] ALIGN1 =
899 "list\0" No_argument "t"
900 "extract\0" No_argument "x"
901 "directory\0" Required_argument "C"
902 "file\0" Required_argument "f"
903 "to-stdout\0" No_argument "O"
904 /* do not restore owner */
905 /* Note: GNU tar handles 'o' as no-same-owner only on extract,
906 * on create, 'o' is --old-archive. We do not support --old-archive. */
907 "no-same-owner\0" No_argument "o"
908 "same-permissions\0" No_argument "p"
909 "verbose\0" No_argument "v"
910 "keep-old\0" No_argument "k"
911 # if ENABLE_FEATURE_TAR_CREATE
912 "create\0" No_argument "c"
913 "dereference\0" No_argument "h"
915 # if ENABLE_FEATURE_SEAMLESS_BZ2
916 "bzip2\0" No_argument "j"
918 # if ENABLE_FEATURE_SEAMLESS_LZMA
919 "lzma\0" No_argument "a"
921 # if ENABLE_FEATURE_TAR_FROM
922 "files-from\0" Required_argument "T"
923 "exclude-from\0" Required_argument "X"
925 # if ENABLE_FEATURE_SEAMLESS_GZ
926 "gzip\0" No_argument "z"
928 # if ENABLE_FEATURE_SEAMLESS_XZ
929 "xz\0" No_argument "J"
931 # if ENABLE_FEATURE_SEAMLESS_Z
932 "compress\0" No_argument "Z"
934 # if ENABLE_FEATURE_TAR_NOPRESERVE_TIME
935 "touch\0" No_argument "m"
937 "strip-components\0" Required_argument "\xf9"
938 "no-recursion\0" No_argument "\xfa"
939 # if ENABLE_FEATURE_TAR_TO_COMMAND
940 "to-command\0" Required_argument "\xfb"
942 /* use numeric uid/gid from tar header, not textual */
943 "numeric-owner\0" No_argument "\xfc"
944 /* do not restore mode */
945 "no-same-permissions\0" No_argument "\xfd"
946 /* on unpack, open with O_TRUNC and !O_EXCL */
947 "overwrite\0" No_argument "\xfe"
948 /* --exclude takes next bit position in option mask, */
949 /* therefore we have to put it _after_ --no-same-permissions */
950 # if ENABLE_FEATURE_TAR_FROM
951 "exclude\0" Required_argument "\xff"
956 int tar_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
957 int tar_main(int argc UNUSED_PARAM, char **argv)
959 archive_handle_t *tar_handle;
960 char *base_dir = NULL;
961 const char *tar_filename = "-";
964 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
965 llist_t *excludes = NULL;
968 /* Initialise default values */
969 tar_handle = init_handle();
970 tar_handle->ah_flags = ARCHIVE_CREATE_LEADING_DIRS
971 | ARCHIVE_RESTORE_DATE
972 | ARCHIVE_UNLINK_OLD;
974 /* Apparently only root's tar preserves perms (see bug 3844) */
976 tar_handle->ah_flags |= ARCHIVE_DONT_RESTORE_PERM;
978 /* Prepend '-' to the first argument if required */
979 opt_complementary = "--:" // first arg is options
980 "tt:vv:" // count -t,-v
981 IF_FEATURE_TAR_FROM("X::T::") // cumulative lists
982 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
983 "\xff::" // --exclude=PATTERN is a list
985 IF_FEATURE_TAR_CREATE("c:") "t:x:" // at least one of these is reqd
986 IF_FEATURE_TAR_CREATE("c--tx:t--cx:x--ct") // mutually exclusive
987 IF_NOT_FEATURE_TAR_CREATE("t--x:x--t") // mutually exclusive
988 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
989 ":\xf9+" // --strip-components=NUM
992 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
993 applet_long_options = tar_longopts;
996 /* Lie to buildroot when it starts asking stupid questions. */
997 if (argv[1] && strcmp(argv[1], "--version") == 0) {
998 // Output of 'tar --version' examples:
999 // tar (GNU tar) 1.15.1
1000 // tar (GNU tar) 1.25
1001 // bsdtar 2.8.3 - libarchive 2.8.3
1002 puts("tar (busybox) " BB_VER);
1005 if (argv[1] && argv[1][0] != '-') {
1007 * 1st argument without dash handles options with parameters
1008 * differently from dashed one: it takes *next argv[i]*
1009 * as paramenter even if there are more chars in 1st argument:
1010 * "tar fx TARFILE" - "x" is not taken as f's param
1011 * but is interpreted as -x option
1012 * "tar -xf TARFILE" - dashed equivalent of the above
1013 * "tar -fx ..." - "x" is taken as f's param
1014 * getopt32 wouldn't handle 1st command correctly.
1015 * Unfortunately, people do use such commands.
1016 * We massage argv[1] to work around it by moving 'f'
1017 * to the end of the string.
1018 * More contrived "tar fCx TARFILE DIR" still fails,
1019 * but such commands are much less likely to be used.
1021 char *f = strchr(argv[1], 'f');
1023 while (f[1] != '\0') {
1031 opt = getopt32(argv,
1033 IF_FEATURE_TAR_CREATE( "ch" )
1034 IF_FEATURE_SEAMLESS_BZ2( "j" )
1035 IF_FEATURE_SEAMLESS_LZMA("a" )
1036 IF_FEATURE_TAR_FROM( "T:X:")
1037 IF_FEATURE_SEAMLESS_GZ( "z" )
1038 IF_FEATURE_SEAMLESS_XZ( "J" )
1039 IF_FEATURE_SEAMLESS_Z( "Z" )
1040 IF_FEATURE_TAR_NOPRESERVE_TIME("m")
1041 IF_FEATURE_TAR_LONG_OPTIONS("\xf9:") // --strip-components
1042 , &base_dir // -C dir
1043 , &tar_filename // -f filename
1044 IF_FEATURE_TAR_FROM(, &(tar_handle->accept)) // T
1045 IF_FEATURE_TAR_FROM(, &(tar_handle->reject)) // X
1046 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
1047 , &tar_handle->tar__strip_components // --strip-components
1049 IF_FEATURE_TAR_TO_COMMAND(, &(tar_handle->tar__to_command)) // --to-command
1050 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
1051 , &excludes // --exclude
1053 , &verboseFlag // combined count for -t and -v
1054 , &verboseFlag // combined count for -t and -v
1056 #if DBG_OPTION_PARSING
1057 bb_error_msg("opt: 0x%08x", opt);
1058 # define showopt(o) bb_error_msg("opt & %s(%x): %x", #o, o, opt & o);
1060 showopt(OPT_EXTRACT );
1061 showopt(OPT_BASEDIR );
1062 showopt(OPT_TARNAME );
1063 showopt(OPT_2STDOUT );
1064 showopt(OPT_NOPRESERVE_OWNER);
1066 showopt(OPT_VERBOSE );
1067 showopt(OPT_KEEP_OLD );
1068 showopt(OPT_CREATE );
1069 showopt(OPT_DEREFERENCE );
1070 showopt(OPT_BZIP2 );
1072 showopt(OPT_INCLUDE_FROM );
1073 showopt(OPT_EXCLUDE_FROM );
1076 showopt(OPT_COMPRESS );
1077 showopt(OPT_NOPRESERVE_TIME );
1078 showopt(OPT_STRIP_COMPONENTS);
1079 showopt(OPT_NORECURSION );
1080 showopt(OPT_2COMMAND );
1081 showopt(OPT_NUMERIC_OWNER );
1082 showopt(OPT_NOPRESERVE_PERM );
1083 showopt(OPT_OVERWRITE );
1084 showopt(OPT_ANY_COMPRESS );
1085 bb_error_msg("base_dir:'%s'", base_dir);
1086 bb_error_msg("tar_filename:'%s'", tar_filename);
1087 bb_error_msg("verboseFlag:%d", verboseFlag);
1088 bb_error_msg("tar_handle->tar__to_command:'%s'", tar_handle->tar__to_command);
1089 bb_error_msg("tar_handle->tar__strip_components:%u", tar_handle->tar__strip_components);
1096 tar_handle->action_header = header_verbose_list;
1097 if (verboseFlag == 1)
1098 tar_handle->action_header = header_list;
1100 if (opt & OPT_EXTRACT)
1101 tar_handle->action_data = data_extract_all;
1103 if (opt & OPT_2STDOUT)
1104 tar_handle->action_data = data_extract_to_stdout;
1106 if (opt & OPT_2COMMAND) {
1107 putenv((char*)"TAR_FILETYPE=f");
1108 signal(SIGPIPE, SIG_IGN);
1109 tar_handle->action_data = data_extract_to_command;
1110 IF_FEATURE_TAR_TO_COMMAND(tar_handle->tar__to_command_shell = xstrdup(get_shell_name());)
1113 if (opt & OPT_KEEP_OLD)
1114 tar_handle->ah_flags &= ~ARCHIVE_UNLINK_OLD;
1116 if (opt & OPT_NUMERIC_OWNER)
1117 tar_handle->ah_flags |= ARCHIVE_NUMERIC_OWNER;
1119 if (opt & OPT_NOPRESERVE_OWNER)
1120 tar_handle->ah_flags |= ARCHIVE_DONT_RESTORE_OWNER;
1122 if (opt & OPT_NOPRESERVE_PERM)
1123 tar_handle->ah_flags |= ARCHIVE_DONT_RESTORE_PERM;
1125 if (opt & OPT_OVERWRITE) {
1126 tar_handle->ah_flags &= ~ARCHIVE_UNLINK_OLD;
1127 tar_handle->ah_flags |= ARCHIVE_O_TRUNC;
1130 if (opt & OPT_NOPRESERVE_TIME)
1131 tar_handle->ah_flags &= ~ARCHIVE_RESTORE_DATE;
1133 #if ENABLE_FEATURE_TAR_FROM
1134 tar_handle->reject = append_file_list_to_list(tar_handle->reject);
1135 # if ENABLE_FEATURE_TAR_LONG_OPTIONS
1136 /* Append excludes to reject */
1138 llist_t *next = excludes->link;
1139 excludes->link = tar_handle->reject;
1140 tar_handle->reject = excludes;
1144 tar_handle->accept = append_file_list_to_list(tar_handle->accept);
1147 /* Setup an array of filenames to work with */
1148 /* TODO: This is the same as in ar, make a separate function? */
1150 /* kill trailing '/' unless the string is just "/" */
1151 char *cp = last_char_is(*argv, '/');
1154 llist_add_to_end(&tar_handle->accept, *argv);
1158 if (tar_handle->accept || tar_handle->reject)
1159 tar_handle->filter = filter_accept_reject_list;
1161 /* Open the tar file */
1163 int tar_fd = STDIN_FILENO;
1164 int flags = O_RDONLY;
1166 if (opt & OPT_CREATE) {
1167 /* Make sure there is at least one file to tar up */
1168 if (tar_handle->accept == NULL)
1169 bb_error_msg_and_die("empty archive");
1171 tar_fd = STDOUT_FILENO;
1172 /* Mimicking GNU tar 1.15.1: */
1173 flags = O_WRONLY | O_CREAT | O_TRUNC;
1176 if (LONE_DASH(tar_filename)) {
1177 tar_handle->src_fd = tar_fd;
1178 tar_handle->seek = seek_by_read;
1180 if (ENABLE_FEATURE_TAR_AUTODETECT
1181 && flags == O_RDONLY
1182 && !(opt & OPT_ANY_COMPRESS)
1184 tar_handle->src_fd = open_zipped(tar_filename, /*fail_if_not_compressed:*/ 0);
1185 if (tar_handle->src_fd < 0)
1186 bb_perror_msg_and_die("can't open '%s'", tar_filename);
1188 tar_handle->src_fd = xopen(tar_filename, flags);
1196 //if (SEAMLESS_COMPRESSION)
1197 // /* We need to know whether child (gzip/bzip/etc) exits abnormally */
1198 // signal(SIGCHLD, check_errors_in_children);
1200 /* Create an archive */
1201 if (opt & OPT_CREATE) {
1202 #if SEAMLESS_COMPRESSION
1203 const char *zipMode = NULL;
1204 if (opt & OPT_COMPRESS)
1205 zipMode = "compress";
1208 if (opt & OPT_BZIP2)
1215 /* NB: writeTarFile() closes tar_handle->src_fd */
1216 return writeTarFile(tar_handle->src_fd, verboseFlag,
1217 (opt & OPT_DEREFERENCE ? ACTION_FOLLOWLINKS : 0)
1218 | (opt & OPT_NORECURSION ? 0 : ACTION_RECURSE),
1220 tar_handle->reject, zipMode);
1223 if (opt & OPT_ANY_COMPRESS) {
1224 USE_FOR_MMU(IF_DESKTOP(long long) int FAST_FUNC (*xformer)(transformer_state_t *xstate);)
1225 USE_FOR_NOMMU(const char *xformer_prog;)
1227 if (opt & OPT_COMPRESS)
1228 USE_FOR_MMU(xformer = unpack_Z_stream;)
1229 USE_FOR_NOMMU(xformer_prog = "uncompress";)
1231 USE_FOR_MMU(xformer = unpack_gz_stream;)
1232 USE_FOR_NOMMU(xformer_prog = "gunzip";)
1233 if (opt & OPT_BZIP2)
1234 USE_FOR_MMU(xformer = unpack_bz2_stream;)
1235 USE_FOR_NOMMU(xformer_prog = "bunzip2";)
1237 USE_FOR_MMU(xformer = unpack_lzma_stream;)
1238 USE_FOR_NOMMU(xformer_prog = "unlzma";)
1240 USE_FOR_MMU(xformer = unpack_xz_stream;)
1241 USE_FOR_NOMMU(xformer_prog = "unxz";)
1243 fork_transformer_with_sig(tar_handle->src_fd, xformer, xformer_prog);
1244 /* Can't lseek over pipes */
1245 tar_handle->seek = seek_by_read;
1246 /*tar_handle->offset = 0; - already is */
1249 /* Zero processed headers (== empty file) is not a valid tarball.
1250 * We (ab)use bb_got_signal as exitcode here,
1251 * because check_errors_in_children() uses _it_ as error indicator.
1253 bb_got_signal = EXIT_FAILURE;
1255 while (get_header_tar(tar_handle) == EXIT_SUCCESS)
1256 bb_got_signal = EXIT_SUCCESS; /* saw at least one header, good */
1258 /* Check that every file that should have been extracted was */
1259 while (tar_handle->accept) {
1260 if (!find_list_entry(tar_handle->reject, tar_handle->accept->data)
1261 && !find_list_entry(tar_handle->passed, tar_handle->accept->data)
1263 bb_error_msg_and_die("%s: not found in archive",
1264 tar_handle->accept->data);
1266 tar_handle->accept = tar_handle->accept->link;
1268 if (ENABLE_FEATURE_CLEAN_UP /* && tar_handle->src_fd != STDIN_FILENO */)
1269 close(tar_handle->src_fd);
1271 if (SEAMLESS_COMPRESSION || OPT_COMPRESS) {
1272 /* Set bb_got_signal to 1 if a child died with !0 exitcode */
1273 check_errors_in_children(0);
1276 return bb_got_signal;