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 the 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 tarball for details.
29 #include "unarchive.h"
31 #define block_buf bb_common_bufsiz1
33 #if ENABLE_FEATURE_TAR_CREATE
35 /* Tar file constants */
37 #define TAR_BLOCK_SIZE 512
39 /* POSIX tar Header Block, from POSIX 1003.1-1990 */
41 #define NAME_SIZE_STR "100"
42 typedef struct TarHeader TarHeader;
43 struct TarHeader { /* byte offset */
44 char name[NAME_SIZE]; /* 0-99 */
45 char mode[8]; /* 100-107 */
46 char uid[8]; /* 108-115 */
47 char gid[8]; /* 116-123 */
48 char size[12]; /* 124-135 */
49 char mtime[12]; /* 136-147 */
50 char chksum[8]; /* 148-155 */
51 char typeflag; /* 156-156 */
52 char linkname[NAME_SIZE]; /* 157-256 */
53 /* POSIX: "ustar" NUL "00" */
54 /* GNU tar: "ustar " NUL */
55 char magic[8]; /* 257-264 */
56 char uname[32]; /* 265-296 */
57 char gname[32]; /* 297-328 */
58 char devmajor[8]; /* 329-336 */
59 char devminor[8]; /* 337-344 */
60 char prefix[155]; /* 345-499 */
61 char padding[12]; /* 500-512 (pad to exactly the TAR_BLOCK_SIZE) */
65 ** writeTarFile(), writeFileToTarball(), and writeTarHeader() are
66 ** the only functions that deal with the HardLinkInfo structure.
67 ** Even these functions use the xxxHardLinkInfo() functions.
69 typedef struct HardLinkInfo HardLinkInfo;
71 HardLinkInfo *next; /* Next entry in list */
72 dev_t dev; /* Device number */
73 ino_t ino; /* Inode number */
74 short linkCount; /* (Hard) Link Count */
75 char name[1]; /* Start of filename (must be last) */
78 /* Some info to be carried along when creating a new tarball */
79 typedef struct TarBallInfo TarBallInfo;
81 int tarFd; /* Open-for-write file descriptor
83 struct stat statBuf; /* Stat info for the tarball, letting
84 us know the inode and device that the
85 tarball lives, so we can avoid trying
86 to include the tarball into itself */
87 int verboseFlag; /* Whether to print extra stuff or not */
88 const llist_t *excludeList; /* List of files to not include */
89 HardLinkInfo *hlInfoHead; /* Hard Link Tracking Information */
90 HardLinkInfo *hlInfo; /* Hard Link Info for the current file */
93 /* A nice enum with all the possible tar file content types */
95 REGTYPE = '0', /* regular file */
96 REGTYPE0 = '\0', /* regular file (ancient bug compat) */
97 LNKTYPE = '1', /* hard link */
98 SYMTYPE = '2', /* symbolic link */
99 CHRTYPE = '3', /* character special */
100 BLKTYPE = '4', /* block special */
101 DIRTYPE = '5', /* directory */
102 FIFOTYPE = '6', /* FIFO special */
103 CONTTYPE = '7', /* reserved */
104 GNULONGLINK = 'K', /* GNU long (>100 chars) link name */
105 GNULONGNAME = 'L', /* GNU long (>100 chars) file name */
107 typedef enum TarFileType TarFileType;
109 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
110 static void addHardLinkInfo(HardLinkInfo **hlInfoHeadPtr,
111 struct stat *statbuf,
112 const char *fileName)
114 /* Note: hlInfoHeadPtr can never be NULL! */
115 HardLinkInfo *hlInfo;
117 hlInfo = xmalloc(sizeof(HardLinkInfo) + strlen(fileName));
118 hlInfo->next = *hlInfoHeadPtr;
119 *hlInfoHeadPtr = hlInfo;
120 hlInfo->dev = statbuf->st_dev;
121 hlInfo->ino = statbuf->st_ino;
122 hlInfo->linkCount = statbuf->st_nlink;
123 strcpy(hlInfo->name, fileName);
126 static void freeHardLinkInfo(HardLinkInfo **hlInfoHeadPtr)
128 HardLinkInfo *hlInfo;
129 HardLinkInfo *hlInfoNext;
132 hlInfo = *hlInfoHeadPtr;
134 hlInfoNext = hlInfo->next;
138 *hlInfoHeadPtr = NULL;
142 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
143 static HardLinkInfo *findHardLinkInfo(HardLinkInfo *hlInfo, struct stat *statbuf)
146 if ((statbuf->st_ino == hlInfo->ino) && (statbuf->st_dev == hlInfo->dev))
148 hlInfo = hlInfo->next;
153 /* Put an octal string into the specified buffer.
154 * The number is zero padded and possibly null terminated.
155 * Stores low-order bits only if whole value does not fit. */
156 static void putOctal(char *cp, int len, off_t value)
158 char tempBuffer[sizeof(off_t)*3+1];
159 char *tempString = tempBuffer;
162 width = sprintf(tempBuffer, "%0*"OFF_FMT"o", len, value);
163 tempString += (width - len);
165 /* If string has leading zeroes, we can drop one */
166 /* and field will have trailing '\0' */
167 /* (increases chances of compat with other tars) */
168 if (tempString[0] == '0')
171 /* Copy the string to the field */
172 memcpy(cp, tempString, len);
174 #define PUT_OCTAL(a, b) putOctal((a), sizeof(a), (b))
176 static void chksum_and_xwrite(int fd, struct TarHeader* hp)
178 /* POSIX says that checksum is done on unsigned bytes
179 * (Sun and HP-UX gets it wrong... more details in
181 const unsigned char *cp;
184 strcpy(hp->magic, "ustar ");
186 /* Calculate and store the checksum (i.e., the sum of all of the bytes of
187 * the header). The checksum field must be filled with blanks for the
188 * calculation. The checksum field is formatted differently from the
189 * other fields: it has 6 digits, a null, then a space -- rather than
190 * digits, followed by a null like the other fields... */
191 memset(hp->chksum, ' ', sizeof(hp->chksum));
192 cp = (const unsigned char *) hp;
195 do { chksum += *cp++; } while (--size);
196 putOctal(hp->chksum, sizeof(hp->chksum)-1, chksum);
198 /* Now write the header out to disk */
199 xwrite(fd, hp, sizeof(*hp));
202 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
203 static void writeLongname(int fd, int type, const char *name, int dir)
205 static const struct {
206 char mode[8]; /* 100-107 */
207 char uid[8]; /* 108-115 */
208 char gid[8]; /* 116-123 */
209 char size[12]; /* 124-135 */
210 char mtime[12]; /* 136-147 */
218 struct TarHeader header;
221 dir = !!dir; /* normalize: 0/1 */
222 size = strlen(name) + 1 + dir; /* GNU tar uses strlen+1 */
223 /* + dir: account for possible '/' */
225 memset(&header, 0, sizeof(header));
226 strcpy(header.name, "././@LongLink");
227 memcpy(header.mode, prefilled.mode, sizeof(prefilled));
228 PUT_OCTAL(header.size, size);
229 header.typeflag = type;
230 chksum_and_xwrite(fd, &header);
232 /* Write filename[/] and pad the block. */
233 /* dir=0: writes 'name<NUL>', pads */
234 /* dir=1: writes 'name', writes '/<NUL>', pads */
236 xwrite(fd, name, size - dir);
237 xwrite(fd, "/", dir);
238 size = (-size) & (TAR_BLOCK_SIZE-1);
239 memset(&header, 0, size);
240 xwrite(fd, &header, size);
244 /* Write out a tar header for the specified file/directory/whatever */
245 void BUG_tar_header_size(void);
246 static int writeTarHeader(struct TarBallInfo *tbInfo,
247 const char *header_name, const char *fileName, struct stat *statbuf)
249 struct TarHeader header;
251 if (sizeof(header) != 512)
252 BUG_tar_header_size();
254 memset(&header, 0, sizeof(struct TarHeader));
256 strncpy(header.name, header_name, sizeof(header.name));
258 /* POSIX says to mask mode with 07777. */
259 PUT_OCTAL(header.mode, statbuf->st_mode & 07777);
260 PUT_OCTAL(header.uid, statbuf->st_uid);
261 PUT_OCTAL(header.gid, statbuf->st_gid);
262 memset(header.size, '0', sizeof(header.size)-1); /* Regular file size is handled later */
263 PUT_OCTAL(header.mtime, statbuf->st_mtime);
265 /* Enter the user and group names */
266 safe_strncpy(header.uname, get_cached_username(statbuf->st_uid), sizeof(header.uname));
267 safe_strncpy(header.gname, get_cached_groupname(statbuf->st_gid), sizeof(header.gname));
269 if (tbInfo->hlInfo) {
270 /* This is a hard link */
271 header.typeflag = LNKTYPE;
272 strncpy(header.linkname, tbInfo->hlInfo->name,
273 sizeof(header.linkname));
274 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
275 /* Write out long linkname if needed */
276 if (header.linkname[sizeof(header.linkname)-1])
277 writeLongname(tbInfo->tarFd, GNULONGLINK,
278 tbInfo->hlInfo->name, 0);
280 } else if (S_ISLNK(statbuf->st_mode)) {
281 char *lpath = xmalloc_readlink_or_warn(fileName);
284 header.typeflag = SYMTYPE;
285 strncpy(header.linkname, lpath, sizeof(header.linkname));
286 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
287 /* Write out long linkname if needed */
288 if (header.linkname[sizeof(header.linkname)-1])
289 writeLongname(tbInfo->tarFd, GNULONGLINK, lpath, 0);
291 /* If it is larger than 100 bytes, bail out */
292 if (header.linkname[sizeof(header.linkname)-1]) {
294 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
299 } else if (S_ISDIR(statbuf->st_mode)) {
300 header.typeflag = DIRTYPE;
301 /* Append '/' only if there is a space for it */
302 if (!header.name[sizeof(header.name)-1])
303 header.name[strlen(header.name)] = '/';
304 } else if (S_ISCHR(statbuf->st_mode)) {
305 header.typeflag = CHRTYPE;
306 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
307 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
308 } else if (S_ISBLK(statbuf->st_mode)) {
309 header.typeflag = BLKTYPE;
310 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
311 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
312 } else if (S_ISFIFO(statbuf->st_mode)) {
313 header.typeflag = FIFOTYPE;
314 } else if (S_ISREG(statbuf->st_mode)) {
315 if (sizeof(statbuf->st_size) > 4
316 && statbuf->st_size > (off_t)0777777777777LL
318 bb_error_msg_and_die("cannot store file '%s' "
319 "of size %"OFF_FMT"d, aborting",
320 fileName, statbuf->st_size);
322 header.typeflag = REGTYPE;
323 PUT_OCTAL(header.size, statbuf->st_size);
325 bb_error_msg("%s: unknown file type", fileName);
329 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
330 /* Write out long name if needed */
331 /* (we, like GNU tar, output long linkname *before* long name) */
332 if (header.name[sizeof(header.name)-1])
333 writeLongname(tbInfo->tarFd, GNULONGNAME,
334 header_name, S_ISDIR(statbuf->st_mode));
337 /* Now write the header out to disk */
338 chksum_and_xwrite(tbInfo->tarFd, &header);
340 /* Now do the verbose thing (or not) */
341 if (tbInfo->verboseFlag) {
344 if (tbInfo->tarFd == STDOUT_FILENO) /* If the archive goes to stdout, verbose to stderr */
346 /* GNU "tar cvvf" prints "extended" listing a-la "ls -l" */
347 /* We don't have such excesses here: for us "v" == "vv" */
348 /* '/' is probably a GNUism */
349 fprintf(vbFd, "%s%s\n", header_name,
350 S_ISDIR(statbuf->st_mode) ? "/" : "");
356 #if ENABLE_FEATURE_TAR_FROM
357 static int exclude_file(const llist_t *excluded_files, const char *file)
359 while (excluded_files) {
360 if (excluded_files->data[0] == '/') {
361 if (fnmatch(excluded_files->data, file,
362 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
367 for (p = file; p[0] != '\0'; p++) {
368 if ((p == file || p[-1] == '/') && p[0] != '/' &&
369 fnmatch(excluded_files->data, p,
370 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
374 excluded_files = excluded_files->link;
380 #define exclude_file(excluded_files, file) 0
383 static int writeFileToTarball(const char *fileName, struct stat *statbuf,
384 void *userData, int depth ATTRIBUTE_UNUSED)
386 struct TarBallInfo *tbInfo = (struct TarBallInfo *) userData;
387 const char *header_name;
388 int inputFileFd = -1;
390 /* Strip leading '/' (must be before memorizing hardlink's name) */
391 header_name = fileName;
392 while (header_name[0] == '/') {
393 static smallint warned;
396 bb_error_msg("removing leading '/' from member names");
402 if (header_name[0] == '\0')
405 /* It is against the rules to archive a socket */
406 if (S_ISSOCK(statbuf->st_mode)) {
407 bb_error_msg("%s: socket ignored", fileName);
412 * Check to see if we are dealing with a hard link.
414 * Treat the first occurance of a given dev/inode as a file while
415 * treating any additional occurances as hard links. This is done
416 * by adding the file information to the HardLinkInfo linked list.
418 tbInfo->hlInfo = NULL;
419 if (statbuf->st_nlink > 1) {
420 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf);
421 if (tbInfo->hlInfo == NULL)
422 addHardLinkInfo(&tbInfo->hlInfoHead, statbuf, header_name);
425 /* It is a bad idea to store the archive we are in the process of creating,
426 * so check the device and inode to be sure that this particular file isn't
428 if (tbInfo->statBuf.st_dev == statbuf->st_dev
429 && tbInfo->statBuf.st_ino == statbuf->st_ino
431 bb_error_msg("%s: file is the archive; skipping", fileName);
435 if (exclude_file(tbInfo->excludeList, header_name))
438 #if !ENABLE_FEATURE_TAR_GNU_EXTENSIONS
439 if (strlen(header_name) >= NAME_SIZE) {
440 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
445 /* Is this a regular file? */
446 if (tbInfo->hlInfo == NULL && S_ISREG(statbuf->st_mode)) {
447 /* open the file we want to archive, and make sure all is well */
448 inputFileFd = open_or_warn(fileName, O_RDONLY);
449 if (inputFileFd < 0) {
454 /* Add an entry to the tarball */
455 if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
459 /* If it was a regular file, write out the body */
460 if (inputFileFd >= 0) {
462 /* Write the file to the archive. */
463 /* We record size into header first, */
464 /* and then write out file. If file shrinks in between, */
465 /* tar will be corrupted. So we don't allow for that. */
466 /* NB: GNU tar 1.16 warns and pads with zeroes */
467 /* or even seeks back and updates header */
468 bb_copyfd_exact_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
470 ////readSize = bb_copyfd_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
471 ////if (readSize != statbuf->st_size && readSize >= 0) {
472 //// bb_error_msg_and_die("short read from %s, aborting", fileName);
475 /* Check that file did not grow in between? */
476 /* if (safe_read(inputFileFd, 1) == 1) warn but continue? */
480 /* Pad the file up to the tar block size */
481 /* (a few tricks here in the name of code size) */
482 readSize = (-(int)statbuf->st_size) & (TAR_BLOCK_SIZE-1);
483 memset(block_buf, 0, readSize);
484 xwrite(tbInfo->tarFd, block_buf, readSize);
490 static int writeTarFile(const int tar_fd, const int verboseFlag,
491 const unsigned long dereferenceFlag, const llist_t *include,
492 const llist_t *exclude, const int gzip)
495 int errorFlag = FALSE;
496 struct TarBallInfo tbInfo;
498 tbInfo.hlInfoHead = NULL;
500 fchmod(tar_fd, 0644);
501 tbInfo.tarFd = tar_fd;
502 tbInfo.verboseFlag = verboseFlag;
504 /* Store the stat info for the tarball's file, so
505 * can avoid including the tarball into itself.... */
506 if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
507 bb_perror_msg_and_die("cannot stat tar file");
509 if ((ENABLE_FEATURE_TAR_GZIP || ENABLE_FEATURE_TAR_BZIP2) && gzip) {
510 // On Linux, vfork never unpauses parent early, although standard
511 // allows for that. Do we want to waste bytes checking for it?
512 #define WAIT_FOR_CHILD 0
514 volatile int vfork_exec_errno = 0;
516 struct { int rd; int wr; } gzipStatusPipe;
518 struct { int rd; int wr; } gzipDataPipe;
519 const char *zip_exec = (gzip == 1) ? "gzip" : "bzip2";
521 xpipe(&gzipDataPipe.rd);
523 xpipe(&gzipStatusPipe.rd);
526 signal(SIGPIPE, SIG_IGN); /* we only want EPIPE on errors */
528 #if defined(__GNUC__) && __GNUC__
529 /* Avoid vfork clobbering */
537 bb_perror_msg_and_die("vfork gzip");
541 xmove_fd(tbInfo.tarFd, 1);
542 xmove_fd(gzipDataPipe.rd, 0);
543 close(gzipDataPipe.wr);
545 close(gzipStatusPipe.rd);
546 fcntl(gzipStatusPipe.wr, F_SETFD, FD_CLOEXEC);
548 /* exec gzip/bzip2 program/applet */
549 BB_EXECLP(zip_exec, zip_exec, "-f", NULL);
550 vfork_exec_errno = errno;
555 xmove_fd(gzipDataPipe.wr, tbInfo.tarFd);
556 close(gzipDataPipe.rd);
558 close(gzipStatusPipe.wr);
563 /* Wait until child execs (or fails to) */
564 n = full_read(gzipStatusPipe.rd, &buf, 1);
565 if ((n < 0) && (/*errno == EAGAIN ||*/ errno == EINTR))
566 continue; /* try it again */
569 close(gzipStatusPipe.rd);
571 if (vfork_exec_errno) {
572 errno = vfork_exec_errno;
573 bb_perror_msg_and_die("cannot exec %s", zip_exec);
577 tbInfo.excludeList = exclude;
579 /* Read the directory/files and iterate over them one at a time */
581 if (!recursive_action(include->data, ACTION_RECURSE |
582 (dereferenceFlag ? ACTION_FOLLOWLINKS : 0),
583 writeFileToTarball, writeFileToTarball, &tbInfo, 0))
587 include = include->link;
589 /* Write two empty blocks to the end of the archive */
590 memset(block_buf, 0, 2*TAR_BLOCK_SIZE);
591 xwrite(tbInfo.tarFd, block_buf, 2*TAR_BLOCK_SIZE);
593 /* To be pedantically correct, we would check if the tarball
594 * is smaller than 20 tar blocks, and pad it if it was smaller,
595 * but that isn't necessary for GNU tar interoperability, and
596 * so is considered a waste of space */
598 /* Close so the child process (if any) will exit */
601 /* Hang up the tools, close up shop, head home */
602 if (ENABLE_FEATURE_CLEAN_UP)
603 freeHardLinkInfo(&tbInfo.hlInfoHead);
606 bb_error_msg("error exit delayed from previous errors");
610 if (waitpid(gzipPid, &status, 0) == -1)
611 bb_perror_msg("waitpid");
612 else if (!WIFEXITED(status) || WEXITSTATUS(status))
613 /* gzip was killed or has exited with nonzero! */
619 int writeTarFile(const int tar_fd, const int verboseFlag,
620 const unsigned long dereferenceFlag, const llist_t *include,
621 const llist_t *exclude, const int gzip);
622 #endif /* FEATURE_TAR_CREATE */
624 #if ENABLE_FEATURE_TAR_FROM
625 static llist_t *append_file_list_to_list(llist_t *list)
631 llist_t *newlist = NULL;
634 src_stream = xfopen(cur->data, "r");
638 while ((line = xmalloc_getline(src_stream)) != NULL) {
639 /* kill trailing '/' unless the string is just "/" */
640 char *cp = last_char_is(line, '/');
643 llist_add_to(&newlist, line);
650 #define append_file_list_to_list(x) 0
653 #if ENABLE_FEATURE_TAR_COMPRESS
654 static char get_header_tar_Z(archive_handle_t *archive_handle)
656 /* Can't lseek over pipes */
657 archive_handle->seek = seek_by_read;
659 /* do the decompression, and cleanup */
660 if (xread_char(archive_handle->src_fd) != 0x1f
661 || xread_char(archive_handle->src_fd) != 0x9d
663 bb_error_msg_and_die("invalid magic");
666 archive_handle->src_fd = open_transformer(archive_handle->src_fd, uncompress, "uncompress");
667 archive_handle->offset = 0;
668 while (get_header_tar(archive_handle) == EXIT_SUCCESS)
671 /* Can only do one file at a time */
675 #define get_header_tar_Z NULL
678 #ifdef CHECK_FOR_CHILD_EXITCODE
679 /* Looks like it isn't needed - tar detects malformed (truncated)
680 * archive if e.g. bunzip2 fails */
681 static int child_error;
683 static void handle_SIGCHLD(int status)
685 /* Actually, 'status' is a signo. We reuse it for other needs */
687 /* Wait for any child without blocking */
688 if (waitpid(-1, &status, WNOHANG) < 0)
689 /* wait failed?! I'm confused... */
692 if (WIFEXITED(status) && WEXITSTATUS(status)==0)
693 /* child exited with 0 */
696 if (!WIFSIGNALED(status) && !WIFEXITED(status)) return; */
703 USE_FEATURE_TAR_CREATE( OPTBIT_CREATE ,)
704 USE_FEATURE_TAR_CREATE( OPTBIT_DEREFERENCE ,)
705 USE_FEATURE_TAR_BZIP2( OPTBIT_BZIP2 ,)
706 USE_FEATURE_TAR_LZMA( OPTBIT_LZMA ,)
707 USE_FEATURE_TAR_FROM( OPTBIT_INCLUDE_FROM,)
708 USE_FEATURE_TAR_FROM( OPTBIT_EXCLUDE_FROM,)
709 USE_FEATURE_TAR_GZIP( OPTBIT_GZIP ,)
710 USE_FEATURE_TAR_COMPRESS(OPTBIT_COMPRESS ,)
711 OPTBIT_NOPRESERVE_OWN,
712 OPTBIT_NOPRESERVE_PERM,
713 OPT_TEST = 1 << 0, // t
714 OPT_EXTRACT = 1 << 1, // x
715 OPT_BASEDIR = 1 << 2, // C
716 OPT_TARNAME = 1 << 3, // f
717 OPT_2STDOUT = 1 << 4, // O
719 OPT_VERBOSE = 1 << 6, // v
720 OPT_KEEP_OLD = 1 << 7, // k
721 OPT_CREATE = USE_FEATURE_TAR_CREATE( (1<<OPTBIT_CREATE )) + 0, // c
722 OPT_DEREFERENCE = USE_FEATURE_TAR_CREATE( (1<<OPTBIT_DEREFERENCE )) + 0, // h
723 OPT_BZIP2 = USE_FEATURE_TAR_BZIP2( (1<<OPTBIT_BZIP2 )) + 0, // j
724 OPT_LZMA = USE_FEATURE_TAR_LZMA( (1<<OPTBIT_LZMA )) + 0, // a
725 OPT_INCLUDE_FROM = USE_FEATURE_TAR_FROM( (1<<OPTBIT_INCLUDE_FROM)) + 0, // T
726 OPT_EXCLUDE_FROM = USE_FEATURE_TAR_FROM( (1<<OPTBIT_EXCLUDE_FROM)) + 0, // X
727 OPT_GZIP = USE_FEATURE_TAR_GZIP( (1<<OPTBIT_GZIP )) + 0, // z
728 OPT_COMPRESS = USE_FEATURE_TAR_COMPRESS((1<<OPTBIT_COMPRESS )) + 0, // Z
729 OPT_NOPRESERVE_OWN = 1 << OPTBIT_NOPRESERVE_OWN , // no-same-owner
730 OPT_NOPRESERVE_PERM = 1 << OPTBIT_NOPRESERVE_PERM, // no-same-permissions
732 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
733 static const char tar_longopts[] ALIGN1 =
734 "list\0" No_argument "t"
735 "extract\0" No_argument "x"
736 "directory\0" Required_argument "C"
737 "file\0" Required_argument "f"
738 "to-stdout\0" No_argument "O"
739 "same-permissions\0" No_argument "p"
740 "verbose\0" No_argument "v"
741 "keep-old\0" No_argument "k"
742 # if ENABLE_FEATURE_TAR_CREATE
743 "create\0" No_argument "c"
744 "dereference\0" No_argument "h"
746 # if ENABLE_FEATURE_TAR_BZIP2
747 "bzip2\0" No_argument "j"
749 # if ENABLE_FEATURE_TAR_LZMA
750 "lzma\0" No_argument "a"
752 # if ENABLE_FEATURE_TAR_FROM
753 "files-from\0" Required_argument "T"
754 "exclude-from\0" Required_argument "X"
756 # if ENABLE_FEATURE_TAR_GZIP
757 "gzip\0" No_argument "z"
759 # if ENABLE_FEATURE_TAR_COMPRESS
760 "compress\0" No_argument "Z"
762 "no-same-owner\0" No_argument "\xfd"
763 "no-same-permissions\0" No_argument "\xfe"
764 /* --exclude takes next bit position in option mask, */
765 /* therefore we have to either put it _after_ --no-same-perm */
766 /* or add OPT[BIT]_EXCLUDE before OPT[BIT]_NOPRESERVE_OWN */
767 # if ENABLE_FEATURE_TAR_FROM
768 "exclude\0" Required_argument "\xff"
773 int tar_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
774 int tar_main(int argc, char **argv)
776 char (*get_header_ptr)(archive_handle_t *) = get_header_tar;
777 archive_handle_t *tar_handle;
778 char *base_dir = NULL;
779 const char *tar_filename = "-";
782 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
783 llist_t *excludes = NULL;
786 /* Initialise default values */
787 tar_handle = init_handle();
788 tar_handle->flags = ARCHIVE_CREATE_LEADING_DIRS
789 | ARCHIVE_PRESERVE_DATE
790 | ARCHIVE_EXTRACT_UNCONDITIONAL;
792 /* Prepend '-' to the first argument if required */
793 opt_complementary = "--:" // first arg is options
794 "tt:vv:" // count -t,-v
795 "?:" // bail out with usage instead of error return
796 "X::T::" // cumulative lists
797 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
798 "\xff::" // cumulative lists for --exclude
800 USE_FEATURE_TAR_CREATE("c:") "t:x:" // at least one of these is reqd
801 USE_FEATURE_TAR_CREATE("c--tx:t--cx:x--ct") // mutually exclusive
802 SKIP_FEATURE_TAR_CREATE("t--x:x--t"); // mutually exclusive
803 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
804 applet_long_options = tar_longopts;
808 USE_FEATURE_TAR_CREATE( "ch" )
809 USE_FEATURE_TAR_BZIP2( "j" )
810 USE_FEATURE_TAR_LZMA( "a" )
811 USE_FEATURE_TAR_FROM( "T:X:")
812 USE_FEATURE_TAR_GZIP( "z" )
813 USE_FEATURE_TAR_COMPRESS("Z" )
814 , &base_dir // -C dir
815 , &tar_filename // -f filename
816 USE_FEATURE_TAR_FROM(, &(tar_handle->accept)) // T
817 USE_FEATURE_TAR_FROM(, &(tar_handle->reject)) // X
818 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
819 , &excludes // --exclude
821 , &verboseFlag // combined count for -t and -v
822 , &verboseFlag // combined count for -t and -v
825 if (verboseFlag) tar_handle->action_header = header_verbose_list;
826 if (verboseFlag == 1) tar_handle->action_header = header_list;
828 if (opt & OPT_EXTRACT)
829 tar_handle->action_data = data_extract_all;
831 if (opt & OPT_2STDOUT)
832 tar_handle->action_data = data_extract_to_stdout;
834 if (opt & OPT_KEEP_OLD)
835 tar_handle->flags &= ~ARCHIVE_EXTRACT_UNCONDITIONAL;
837 if (opt & OPT_NOPRESERVE_OWN)
838 tar_handle->flags |= ARCHIVE_NOPRESERVE_OWN;
840 if (opt & OPT_NOPRESERVE_PERM)
841 tar_handle->flags |= ARCHIVE_NOPRESERVE_PERM;
844 get_header_ptr = get_header_tar_gz;
847 get_header_ptr = get_header_tar_bz2;
850 get_header_ptr = get_header_tar_lzma;
852 if (opt & OPT_COMPRESS)
853 get_header_ptr = get_header_tar_Z;
855 #if ENABLE_FEATURE_TAR_FROM
856 tar_handle->reject = append_file_list_to_list(tar_handle->reject);
857 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
858 /* Append excludes to reject */
860 llist_t *next = excludes->link;
861 excludes->link = tar_handle->reject;
862 tar_handle->reject = excludes;
866 tar_handle->accept = append_file_list_to_list(tar_handle->accept);
869 /* Check if we are reading from stdin */
870 if (argv[optind] && *argv[optind] == '-') {
871 /* Default is to read from stdin, so just skip to next arg */
875 /* Setup an array of filenames to work with */
876 /* TODO: This is the same as in ar, separate function ? */
877 while (optind < argc) {
878 /* kill trailing '/' unless the string is just "/" */
879 char *cp = last_char_is(argv[optind], '/');
880 if (cp > argv[optind])
882 llist_add_to_end(&tar_handle->accept, argv[optind]);
886 if (tar_handle->accept || tar_handle->reject)
887 tar_handle->filter = filter_accept_reject_list;
889 /* Open the tar file */
894 if (opt & OPT_CREATE) {
895 /* Make sure there is at least one file to tar up. */
896 if (tar_handle->accept == NULL)
897 bb_error_msg_and_die("empty archive");
900 /* Mimicking GNU tar 1.15.1: */
901 flags = O_WRONLY|O_CREAT|O_TRUNC;
902 /* was doing unlink; open(O_WRONLY|O_CREAT|O_EXCL); why? */
908 if (LONE_DASH(tar_filename)) {
909 tar_handle->src_fd = fileno(tar_stream);
910 tar_handle->seek = seek_by_read;
912 tar_handle->src_fd = xopen(tar_filename, flags);
919 #ifdef CHECK_FOR_CHILD_EXITCODE
920 /* We need to know whether child (gzip/bzip/etc) exits abnormally */
921 signal(SIGCHLD, handle_SIGCHLD);
924 /* create an archive */
925 if (opt & OPT_CREATE) {
927 if (ENABLE_FEATURE_TAR_GZIP && get_header_ptr == get_header_tar_gz)
929 if (ENABLE_FEATURE_TAR_BZIP2 && get_header_ptr == get_header_tar_bz2)
931 /* NB: writeTarFile() closes tar_handle->src_fd */
932 return writeTarFile(tar_handle->src_fd, verboseFlag, opt & OPT_DEREFERENCE,
934 tar_handle->reject, zipMode);
937 while (get_header_ptr(tar_handle) == EXIT_SUCCESS)
940 /* Check that every file that should have been extracted was */
941 while (tar_handle->accept) {
942 if (!find_list_entry(tar_handle->reject, tar_handle->accept->data)
943 && !find_list_entry(tar_handle->passed, tar_handle->accept->data)
945 bb_error_msg_and_die("%s: not found in archive",
946 tar_handle->accept->data);
948 tar_handle->accept = tar_handle->accept->link;
950 if (ENABLE_FEATURE_CLEAN_UP /* && tar_handle->src_fd != STDIN_FILENO */)
951 close(tar_handle->src_fd);