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 /* FIXME: Stop using this non-standard feature */
32 #ifndef FNM_LEADING_DIR
33 #define FNM_LEADING_DIR 0
37 #define block_buf bb_common_bufsiz1
40 #if !ENABLE_FEATURE_TAR_GZIP && !ENABLE_FEATURE_TAR_BZIP2
41 /* Do not pass gzip flag to writeTarFile() */
42 #define writeTarFile(tar_fd, verboseFlag, dereferenceFlag, include, exclude, gzip) \
43 writeTarFile(tar_fd, verboseFlag, dereferenceFlag, include, exclude)
47 #if ENABLE_FEATURE_TAR_CREATE
49 /* Tar file constants */
51 #define TAR_BLOCK_SIZE 512
53 /* POSIX tar Header Block, from POSIX 1003.1-1990 */
55 #define NAME_SIZE_STR "100"
56 typedef struct TarHeader TarHeader;
57 struct TarHeader { /* byte offset */
58 char name[NAME_SIZE]; /* 0-99 */
59 char mode[8]; /* 100-107 */
60 char uid[8]; /* 108-115 */
61 char gid[8]; /* 116-123 */
62 char size[12]; /* 124-135 */
63 char mtime[12]; /* 136-147 */
64 char chksum[8]; /* 148-155 */
65 char typeflag; /* 156-156 */
66 char linkname[NAME_SIZE]; /* 157-256 */
67 /* POSIX: "ustar" NUL "00" */
68 /* GNU tar: "ustar " NUL */
69 /* Normally it's defined as magic[6] followed by
70 * version[2], but we put them together to save code.
72 char magic[8]; /* 257-264 */
73 char uname[32]; /* 265-296 */
74 char gname[32]; /* 297-328 */
75 char devmajor[8]; /* 329-336 */
76 char devminor[8]; /* 337-344 */
77 char prefix[155]; /* 345-499 */
78 char padding[12]; /* 500-512 (pad to exactly TAR_BLOCK_SIZE) */
82 ** writeTarFile(), writeFileToTarball(), and writeTarHeader() are
83 ** the only functions that deal with the HardLinkInfo structure.
84 ** Even these functions use the xxxHardLinkInfo() functions.
86 typedef struct HardLinkInfo HardLinkInfo;
88 HardLinkInfo *next; /* Next entry in list */
89 dev_t dev; /* Device number */
90 ino_t ino; /* Inode number */
91 short linkCount; /* (Hard) Link Count */
92 char name[1]; /* Start of filename (must be last) */
95 /* Some info to be carried along when creating a new tarball */
96 typedef struct TarBallInfo TarBallInfo;
98 int tarFd; /* Open-for-write file descriptor
100 struct stat statBuf; /* Stat info for the tarball, letting
101 us know the inode and device that the
102 tarball lives, so we can avoid trying
103 to include the tarball into itself */
104 int verboseFlag; /* Whether to print extra stuff or not */
105 const llist_t *excludeList; /* List of files to not include */
106 HardLinkInfo *hlInfoHead; /* Hard Link Tracking Information */
107 HardLinkInfo *hlInfo; /* Hard Link Info for the current file */
110 /* A nice enum with all the possible tar file content types */
112 REGTYPE = '0', /* regular file */
113 REGTYPE0 = '\0', /* regular file (ancient bug compat) */
114 LNKTYPE = '1', /* hard link */
115 SYMTYPE = '2', /* symbolic link */
116 CHRTYPE = '3', /* character special */
117 BLKTYPE = '4', /* block special */
118 DIRTYPE = '5', /* directory */
119 FIFOTYPE = '6', /* FIFO special */
120 CONTTYPE = '7', /* reserved */
121 GNULONGLINK = 'K', /* GNU long (>100 chars) link name */
122 GNULONGNAME = 'L', /* GNU long (>100 chars) file name */
124 typedef enum TarFileType TarFileType;
126 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
127 static void addHardLinkInfo(HardLinkInfo **hlInfoHeadPtr,
128 struct stat *statbuf,
129 const char *fileName)
131 /* Note: hlInfoHeadPtr can never be NULL! */
132 HardLinkInfo *hlInfo;
134 hlInfo = xmalloc(sizeof(HardLinkInfo) + strlen(fileName));
135 hlInfo->next = *hlInfoHeadPtr;
136 *hlInfoHeadPtr = hlInfo;
137 hlInfo->dev = statbuf->st_dev;
138 hlInfo->ino = statbuf->st_ino;
139 hlInfo->linkCount = statbuf->st_nlink;
140 strcpy(hlInfo->name, fileName);
143 static void freeHardLinkInfo(HardLinkInfo **hlInfoHeadPtr)
145 HardLinkInfo *hlInfo;
146 HardLinkInfo *hlInfoNext;
149 hlInfo = *hlInfoHeadPtr;
151 hlInfoNext = hlInfo->next;
155 *hlInfoHeadPtr = NULL;
159 /* Might be faster (and bigger) if the dev/ino were stored in numeric order;) */
160 static HardLinkInfo *findHardLinkInfo(HardLinkInfo *hlInfo, struct stat *statbuf)
163 if ((statbuf->st_ino == hlInfo->ino) && (statbuf->st_dev == hlInfo->dev))
165 hlInfo = hlInfo->next;
170 /* Put an octal string into the specified buffer.
171 * The number is zero padded and possibly null terminated.
172 * Stores low-order bits only if whole value does not fit. */
173 static void putOctal(char *cp, int len, off_t value)
175 char tempBuffer[sizeof(off_t)*3+1];
176 char *tempString = tempBuffer;
179 width = sprintf(tempBuffer, "%0*"OFF_FMT"o", len, value);
180 tempString += (width - len);
182 /* If string has leading zeroes, we can drop one */
183 /* and field will have trailing '\0' */
184 /* (increases chances of compat with other tars) */
185 if (tempString[0] == '0')
188 /* Copy the string to the field */
189 memcpy(cp, tempString, len);
191 #define PUT_OCTAL(a, b) putOctal((a), sizeof(a), (b))
193 static void chksum_and_xwrite(int fd, struct TarHeader* hp)
195 /* POSIX says that checksum is done on unsigned bytes
196 * (Sun and HP-UX gets it wrong... more details in
198 const unsigned char *cp;
201 strcpy(hp->magic, "ustar ");
203 /* Calculate and store the checksum (i.e., the sum of all of the bytes of
204 * the header). The checksum field must be filled with blanks for the
205 * calculation. The checksum field is formatted differently from the
206 * other fields: it has 6 digits, a null, then a space -- rather than
207 * digits, followed by a null like the other fields... */
208 memset(hp->chksum, ' ', sizeof(hp->chksum));
209 cp = (const unsigned char *) hp;
212 do { chksum += *cp++; } while (--size);
213 putOctal(hp->chksum, sizeof(hp->chksum)-1, chksum);
215 /* Now write the header out to disk */
216 xwrite(fd, hp, sizeof(*hp));
219 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
220 static void writeLongname(int fd, int type, const char *name, int dir)
222 static const struct {
223 char mode[8]; /* 100-107 */
224 char uid[8]; /* 108-115 */
225 char gid[8]; /* 116-123 */
226 char size[12]; /* 124-135 */
227 char mtime[12]; /* 136-147 */
235 struct TarHeader header;
238 dir = !!dir; /* normalize: 0/1 */
239 size = strlen(name) + 1 + dir; /* GNU tar uses strlen+1 */
240 /* + dir: account for possible '/' */
242 memset(&header, 0, sizeof(header));
243 strcpy(header.name, "././@LongLink");
244 memcpy(header.mode, prefilled.mode, sizeof(prefilled));
245 PUT_OCTAL(header.size, size);
246 header.typeflag = type;
247 chksum_and_xwrite(fd, &header);
249 /* Write filename[/] and pad the block. */
250 /* dir=0: writes 'name<NUL>', pads */
251 /* dir=1: writes 'name', writes '/<NUL>', pads */
253 xwrite(fd, name, size - dir);
254 xwrite(fd, "/", dir);
255 size = (-size) & (TAR_BLOCK_SIZE-1);
256 memset(&header, 0, size);
257 xwrite(fd, &header, size);
261 /* Write out a tar header for the specified file/directory/whatever */
262 void BUG_tar_header_size(void);
263 static int writeTarHeader(struct TarBallInfo *tbInfo,
264 const char *header_name, const char *fileName, struct stat *statbuf)
266 struct TarHeader header;
268 if (sizeof(header) != 512)
269 BUG_tar_header_size();
271 memset(&header, 0, sizeof(struct TarHeader));
273 strncpy(header.name, header_name, sizeof(header.name));
275 /* POSIX says to mask mode with 07777. */
276 PUT_OCTAL(header.mode, statbuf->st_mode & 07777);
277 PUT_OCTAL(header.uid, statbuf->st_uid);
278 PUT_OCTAL(header.gid, statbuf->st_gid);
279 memset(header.size, '0', sizeof(header.size)-1); /* Regular file size is handled later */
280 PUT_OCTAL(header.mtime, statbuf->st_mtime);
282 /* Enter the user and group names */
283 safe_strncpy(header.uname, get_cached_username(statbuf->st_uid), sizeof(header.uname));
284 safe_strncpy(header.gname, get_cached_groupname(statbuf->st_gid), sizeof(header.gname));
286 if (tbInfo->hlInfo) {
287 /* This is a hard link */
288 header.typeflag = LNKTYPE;
289 strncpy(header.linkname, tbInfo->hlInfo->name,
290 sizeof(header.linkname));
291 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
292 /* Write out long linkname if needed */
293 if (header.linkname[sizeof(header.linkname)-1])
294 writeLongname(tbInfo->tarFd, GNULONGLINK,
295 tbInfo->hlInfo->name, 0);
297 } else if (S_ISLNK(statbuf->st_mode)) {
298 char *lpath = xmalloc_readlink_or_warn(fileName);
301 header.typeflag = SYMTYPE;
302 strncpy(header.linkname, lpath, sizeof(header.linkname));
303 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
304 /* Write out long linkname if needed */
305 if (header.linkname[sizeof(header.linkname)-1])
306 writeLongname(tbInfo->tarFd, GNULONGLINK, lpath, 0);
308 /* If it is larger than 100 bytes, bail out */
309 if (header.linkname[sizeof(header.linkname)-1]) {
311 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
316 } else if (S_ISDIR(statbuf->st_mode)) {
317 header.typeflag = DIRTYPE;
318 /* Append '/' only if there is a space for it */
319 if (!header.name[sizeof(header.name)-1])
320 header.name[strlen(header.name)] = '/';
321 } else if (S_ISCHR(statbuf->st_mode)) {
322 header.typeflag = CHRTYPE;
323 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
324 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
325 } else if (S_ISBLK(statbuf->st_mode)) {
326 header.typeflag = BLKTYPE;
327 PUT_OCTAL(header.devmajor, major(statbuf->st_rdev));
328 PUT_OCTAL(header.devminor, minor(statbuf->st_rdev));
329 } else if (S_ISFIFO(statbuf->st_mode)) {
330 header.typeflag = FIFOTYPE;
331 } else if (S_ISREG(statbuf->st_mode)) {
332 if (sizeof(statbuf->st_size) > 4
333 && statbuf->st_size > (off_t)0777777777777LL
335 bb_error_msg_and_die("cannot store file '%s' "
336 "of size %"OFF_FMT"d, aborting",
337 fileName, statbuf->st_size);
339 header.typeflag = REGTYPE;
340 PUT_OCTAL(header.size, statbuf->st_size);
342 bb_error_msg("%s: unknown file type", fileName);
346 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
347 /* Write out long name if needed */
348 /* (we, like GNU tar, output long linkname *before* long name) */
349 if (header.name[sizeof(header.name)-1])
350 writeLongname(tbInfo->tarFd, GNULONGNAME,
351 header_name, S_ISDIR(statbuf->st_mode));
354 /* Now write the header out to disk */
355 chksum_and_xwrite(tbInfo->tarFd, &header);
357 /* Now do the verbose thing (or not) */
358 if (tbInfo->verboseFlag) {
361 if (tbInfo->tarFd == STDOUT_FILENO) /* If the archive goes to stdout, verbose to stderr */
363 /* GNU "tar cvvf" prints "extended" listing a-la "ls -l" */
364 /* We don't have such excesses here: for us "v" == "vv" */
365 /* '/' is probably a GNUism */
366 fprintf(vbFd, "%s%s\n", header_name,
367 S_ISDIR(statbuf->st_mode) ? "/" : "");
373 #if ENABLE_FEATURE_TAR_FROM
374 static int exclude_file(const llist_t *excluded_files, const char *file)
376 while (excluded_files) {
377 if (excluded_files->data[0] == '/') {
378 if (fnmatch(excluded_files->data, file,
379 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
384 for (p = file; p[0] != '\0'; p++) {
385 if ((p == file || p[-1] == '/') && p[0] != '/' &&
386 fnmatch(excluded_files->data, p,
387 FNM_PATHNAME | FNM_LEADING_DIR) == 0)
391 excluded_files = excluded_files->link;
397 #define exclude_file(excluded_files, file) 0
400 static int writeFileToTarball(const char *fileName, struct stat *statbuf,
401 void *userData, int depth ATTRIBUTE_UNUSED)
403 struct TarBallInfo *tbInfo = (struct TarBallInfo *) userData;
404 const char *header_name;
405 int inputFileFd = -1;
407 /* Strip leading '/' (must be before memorizing hardlink's name) */
408 header_name = fileName;
409 while (header_name[0] == '/') {
410 static smallint warned;
413 bb_error_msg("removing leading '/' from member names");
419 if (header_name[0] == '\0')
422 /* It is against the rules to archive a socket */
423 if (S_ISSOCK(statbuf->st_mode)) {
424 bb_error_msg("%s: socket ignored", fileName);
429 * Check to see if we are dealing with a hard link.
431 * Treat the first occurance of a given dev/inode as a file while
432 * treating any additional occurances as hard links. This is done
433 * by adding the file information to the HardLinkInfo linked list.
435 tbInfo->hlInfo = NULL;
436 if (statbuf->st_nlink > 1) {
437 tbInfo->hlInfo = findHardLinkInfo(tbInfo->hlInfoHead, statbuf);
438 if (tbInfo->hlInfo == NULL)
439 addHardLinkInfo(&tbInfo->hlInfoHead, statbuf, header_name);
442 /* It is a bad idea to store the archive we are in the process of creating,
443 * so check the device and inode to be sure that this particular file isn't
445 if (tbInfo->statBuf.st_dev == statbuf->st_dev
446 && tbInfo->statBuf.st_ino == statbuf->st_ino
448 bb_error_msg("%s: file is the archive; skipping", fileName);
452 if (exclude_file(tbInfo->excludeList, header_name))
455 #if !ENABLE_FEATURE_TAR_GNU_EXTENSIONS
456 if (strlen(header_name) >= NAME_SIZE) {
457 bb_error_msg("names longer than "NAME_SIZE_STR" chars not supported");
462 /* Is this a regular file? */
463 if (tbInfo->hlInfo == NULL && S_ISREG(statbuf->st_mode)) {
464 /* open the file we want to archive, and make sure all is well */
465 inputFileFd = open_or_warn(fileName, O_RDONLY);
466 if (inputFileFd < 0) {
471 /* Add an entry to the tarball */
472 if (writeTarHeader(tbInfo, header_name, fileName, statbuf) == FALSE) {
476 /* If it was a regular file, write out the body */
477 if (inputFileFd >= 0) {
479 /* Write the file to the archive. */
480 /* We record size into header first, */
481 /* and then write out file. If file shrinks in between, */
482 /* tar will be corrupted. So we don't allow for that. */
483 /* NB: GNU tar 1.16 warns and pads with zeroes */
484 /* or even seeks back and updates header */
485 bb_copyfd_exact_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
487 ////readSize = bb_copyfd_size(inputFileFd, tbInfo->tarFd, statbuf->st_size);
488 ////if (readSize != statbuf->st_size && readSize >= 0) {
489 //// bb_error_msg_and_die("short read from %s, aborting", fileName);
492 /* Check that file did not grow in between? */
493 /* if (safe_read(inputFileFd, 1) == 1) warn but continue? */
497 /* Pad the file up to the tar block size */
498 /* (a few tricks here in the name of code size) */
499 readSize = (-(int)statbuf->st_size) & (TAR_BLOCK_SIZE-1);
500 memset(block_buf, 0, readSize);
501 xwrite(tbInfo->tarFd, block_buf, readSize);
507 static int writeTarFile(const int tar_fd, const int verboseFlag,
508 const unsigned long dereferenceFlag, const llist_t *include,
509 const llist_t *exclude, const int gzip)
512 int errorFlag = FALSE;
513 struct TarBallInfo tbInfo;
515 tbInfo.hlInfoHead = NULL;
517 fchmod(tar_fd, 0644);
518 tbInfo.tarFd = tar_fd;
519 tbInfo.verboseFlag = verboseFlag;
521 /* Store the stat info for the tarball's file, so
522 * can avoid including the tarball into itself.... */
523 if (fstat(tbInfo.tarFd, &tbInfo.statBuf) < 0)
524 bb_perror_msg_and_die("cannot stat tar file");
526 #if ENABLE_FEATURE_TAR_GZIP || ENABLE_FEATURE_TAR_BZIP2
528 #if ENABLE_FEATURE_TAR_GZIP && ENABLE_FEATURE_TAR_BZIP2
529 const char *zip_exec = (gzip == 1) ? "gzip" : "bzip2";
530 #elif ENABLE_FEATURE_TAR_GZIP
531 const char *zip_exec = "gzip";
532 #else /* only ENABLE_FEATURE_TAR_BZIP2 */
533 const char *zip_exec = "bzip2";
535 // On Linux, vfork never unpauses parent early, although standard
536 // allows for that. Do we want to waste bytes checking for it?
537 #define WAIT_FOR_CHILD 0
538 volatile int vfork_exec_errno = 0;
540 struct fd_pair gzipStatusPipe;
542 struct fd_pair gzipDataPipe;
543 xpiped_pair(gzipDataPipe);
545 xpiped_pair(gzipStatusPipe);
548 signal(SIGPIPE, SIG_IGN); /* we only want EPIPE on errors */
550 #if defined(__GNUC__) && __GNUC__
551 /* Avoid vfork clobbering */
559 bb_perror_msg_and_die("vfork gzip");
563 /* NB: close _first_, then move fds! */
564 close(gzipDataPipe.wr);
566 close(gzipStatusPipe.rd);
567 /* gzipStatusPipe.wr will close only on exec -
568 * parent waits for this close to happen */
569 fcntl(gzipStatusPipe.wr, F_SETFD, FD_CLOEXEC);
571 xmove_fd(gzipDataPipe.rd, 0);
572 xmove_fd(tbInfo.tarFd, 1);
573 /* exec gzip/bzip2 program/applet */
574 BB_EXECLP(zip_exec, zip_exec, "-f", NULL);
575 vfork_exec_errno = errno;
580 xmove_fd(gzipDataPipe.wr, tbInfo.tarFd);
581 close(gzipDataPipe.rd);
583 close(gzipStatusPipe.wr);
588 /* Wait until child execs (or fails to) */
589 n = full_read(gzipStatusPipe.rd, &buf, 1);
590 if (n < 0 /* && errno == EAGAIN */)
591 continue; /* try it again */
594 close(gzipStatusPipe.rd);
596 if (vfork_exec_errno) {
597 errno = vfork_exec_errno;
598 bb_perror_msg_and_die("cannot exec %s", zip_exec);
603 tbInfo.excludeList = exclude;
605 /* Read the directory/files and iterate over them one at a time */
607 if (!recursive_action(include->data, ACTION_RECURSE |
608 (dereferenceFlag ? ACTION_FOLLOWLINKS : 0),
609 writeFileToTarball, writeFileToTarball, &tbInfo, 0))
613 include = include->link;
615 /* Write two empty blocks to the end of the archive */
616 memset(block_buf, 0, 2*TAR_BLOCK_SIZE);
617 xwrite(tbInfo.tarFd, block_buf, 2*TAR_BLOCK_SIZE);
619 /* To be pedantically correct, we would check if the tarball
620 * is smaller than 20 tar blocks, and pad it if it was smaller,
621 * but that isn't necessary for GNU tar interoperability, and
622 * so is considered a waste of space */
624 /* Close so the child process (if any) will exit */
627 /* Hang up the tools, close up shop, head home */
628 if (ENABLE_FEATURE_CLEAN_UP)
629 freeHardLinkInfo(&tbInfo.hlInfoHead);
632 bb_error_msg("error exit delayed from previous errors");
636 if (safe_waitpid(gzipPid, &status, 0) == -1)
637 bb_perror_msg("waitpid");
638 else if (!WIFEXITED(status) || WEXITSTATUS(status))
639 /* gzip was killed or has exited with nonzero! */
645 int writeTarFile(const int tar_fd, const int verboseFlag,
646 const unsigned long dereferenceFlag, const llist_t *include,
647 const llist_t *exclude, const int gzip);
648 #endif /* FEATURE_TAR_CREATE */
650 #if ENABLE_FEATURE_TAR_FROM
651 static llist_t *append_file_list_to_list(llist_t *list)
657 llist_t *newlist = NULL;
660 src_stream = xfopen(cur->data, "r");
664 while ((line = xmalloc_getline(src_stream)) != NULL) {
665 /* kill trailing '/' unless the string is just "/" */
666 char *cp = last_char_is(line, '/');
669 llist_add_to(&newlist, line);
676 #define append_file_list_to_list(x) 0
679 #if ENABLE_FEATURE_TAR_COMPRESS
680 static char get_header_tar_Z(archive_handle_t *archive_handle)
682 /* Can't lseek over pipes */
683 archive_handle->seek = seek_by_read;
685 /* do the decompression, and cleanup */
686 if (xread_char(archive_handle->src_fd) != 0x1f
687 || xread_char(archive_handle->src_fd) != 0x9d
689 bb_error_msg_and_die("invalid magic");
692 archive_handle->src_fd = open_transformer(archive_handle->src_fd, uncompress, "uncompress");
693 archive_handle->offset = 0;
694 while (get_header_tar(archive_handle) == EXIT_SUCCESS)
697 /* Can only do one file at a time */
701 #define get_header_tar_Z NULL
704 #ifdef CHECK_FOR_CHILD_EXITCODE
705 /* Looks like it isn't needed - tar detects malformed (truncated)
706 * archive if e.g. bunzip2 fails */
707 static int child_error;
709 static void handle_SIGCHLD(int status)
711 /* Actually, 'status' is a signo. We reuse it for other needs */
713 /* Wait for any child without blocking */
714 if (wait_any_nohang(&status) < 0)
715 /* wait failed?! I'm confused... */
718 if (WIFEXITED(status) && WEXITSTATUS(status)==0)
719 /* child exited with 0 */
722 if (!WIFSIGNALED(status) && !WIFEXITED(status)) return; */
729 USE_FEATURE_TAR_CREATE( OPTBIT_CREATE ,)
730 USE_FEATURE_TAR_CREATE( OPTBIT_DEREFERENCE ,)
731 USE_FEATURE_TAR_BZIP2( OPTBIT_BZIP2 ,)
732 USE_FEATURE_TAR_LZMA( OPTBIT_LZMA ,)
733 USE_FEATURE_TAR_FROM( OPTBIT_INCLUDE_FROM,)
734 USE_FEATURE_TAR_FROM( OPTBIT_EXCLUDE_FROM,)
735 USE_FEATURE_TAR_GZIP( OPTBIT_GZIP ,)
736 USE_FEATURE_TAR_COMPRESS(OPTBIT_COMPRESS ,)
737 OPTBIT_NOPRESERVE_OWN,
738 OPTBIT_NOPRESERVE_PERM,
739 OPT_TEST = 1 << 0, // t
740 OPT_EXTRACT = 1 << 1, // x
741 OPT_BASEDIR = 1 << 2, // C
742 OPT_TARNAME = 1 << 3, // f
743 OPT_2STDOUT = 1 << 4, // O
745 OPT_VERBOSE = 1 << 6, // v
746 OPT_KEEP_OLD = 1 << 7, // k
747 OPT_CREATE = USE_FEATURE_TAR_CREATE( (1<<OPTBIT_CREATE )) + 0, // c
748 OPT_DEREFERENCE = USE_FEATURE_TAR_CREATE( (1<<OPTBIT_DEREFERENCE )) + 0, // h
749 OPT_BZIP2 = USE_FEATURE_TAR_BZIP2( (1<<OPTBIT_BZIP2 )) + 0, // j
750 OPT_LZMA = USE_FEATURE_TAR_LZMA( (1<<OPTBIT_LZMA )) + 0, // a
751 OPT_INCLUDE_FROM = USE_FEATURE_TAR_FROM( (1<<OPTBIT_INCLUDE_FROM)) + 0, // T
752 OPT_EXCLUDE_FROM = USE_FEATURE_TAR_FROM( (1<<OPTBIT_EXCLUDE_FROM)) + 0, // X
753 OPT_GZIP = USE_FEATURE_TAR_GZIP( (1<<OPTBIT_GZIP )) + 0, // z
754 OPT_COMPRESS = USE_FEATURE_TAR_COMPRESS((1<<OPTBIT_COMPRESS )) + 0, // Z
755 OPT_NOPRESERVE_OWN = 1 << OPTBIT_NOPRESERVE_OWN , // no-same-owner
756 OPT_NOPRESERVE_PERM = 1 << OPTBIT_NOPRESERVE_PERM, // no-same-permissions
758 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
759 static const char tar_longopts[] ALIGN1 =
760 "list\0" No_argument "t"
761 "extract\0" No_argument "x"
762 "directory\0" Required_argument "C"
763 "file\0" Required_argument "f"
764 "to-stdout\0" No_argument "O"
765 "same-permissions\0" No_argument "p"
766 "verbose\0" No_argument "v"
767 "keep-old\0" No_argument "k"
768 # if ENABLE_FEATURE_TAR_CREATE
769 "create\0" No_argument "c"
770 "dereference\0" No_argument "h"
772 # if ENABLE_FEATURE_TAR_BZIP2
773 "bzip2\0" No_argument "j"
775 # if ENABLE_FEATURE_TAR_LZMA
776 "lzma\0" No_argument "a"
778 # if ENABLE_FEATURE_TAR_FROM
779 "files-from\0" Required_argument "T"
780 "exclude-from\0" Required_argument "X"
782 # if ENABLE_FEATURE_TAR_GZIP
783 "gzip\0" No_argument "z"
785 # if ENABLE_FEATURE_TAR_COMPRESS
786 "compress\0" No_argument "Z"
788 "no-same-owner\0" No_argument "\xfd"
789 "no-same-permissions\0" No_argument "\xfe"
790 /* --exclude takes next bit position in option mask, */
791 /* therefore we have to either put it _after_ --no-same-perm */
792 /* or add OPT[BIT]_EXCLUDE before OPT[BIT]_NOPRESERVE_OWN */
793 # if ENABLE_FEATURE_TAR_FROM
794 "exclude\0" Required_argument "\xff"
799 int tar_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
800 int tar_main(int argc, char **argv)
802 char (*get_header_ptr)(archive_handle_t *) = get_header_tar;
803 archive_handle_t *tar_handle;
804 char *base_dir = NULL;
805 const char *tar_filename = "-";
808 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
809 llist_t *excludes = NULL;
812 /* Initialise default values */
813 tar_handle = init_handle();
814 tar_handle->flags = ARCHIVE_CREATE_LEADING_DIRS
815 | ARCHIVE_PRESERVE_DATE
816 | ARCHIVE_EXTRACT_UNCONDITIONAL;
818 /* Prepend '-' to the first argument if required */
819 opt_complementary = "--:" // first arg is options
820 "tt:vv:" // count -t,-v
821 "?:" // bail out with usage instead of error return
822 "X::T::" // cumulative lists
823 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
824 "\xff::" // cumulative lists for --exclude
826 USE_FEATURE_TAR_CREATE("c:") "t:x:" // at least one of these is reqd
827 USE_FEATURE_TAR_CREATE("c--tx:t--cx:x--ct") // mutually exclusive
828 SKIP_FEATURE_TAR_CREATE("t--x:x--t"); // mutually exclusive
829 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
830 applet_long_options = tar_longopts;
834 USE_FEATURE_TAR_CREATE( "ch" )
835 USE_FEATURE_TAR_BZIP2( "j" )
836 USE_FEATURE_TAR_LZMA( "a" )
837 USE_FEATURE_TAR_FROM( "T:X:")
838 USE_FEATURE_TAR_GZIP( "z" )
839 USE_FEATURE_TAR_COMPRESS("Z" )
840 , &base_dir // -C dir
841 , &tar_filename // -f filename
842 USE_FEATURE_TAR_FROM(, &(tar_handle->accept)) // T
843 USE_FEATURE_TAR_FROM(, &(tar_handle->reject)) // X
844 #if ENABLE_FEATURE_TAR_LONG_OPTIONS && ENABLE_FEATURE_TAR_FROM
845 , &excludes // --exclude
847 , &verboseFlag // combined count for -t and -v
848 , &verboseFlag // combined count for -t and -v
851 if (verboseFlag) tar_handle->action_header = header_verbose_list;
852 if (verboseFlag == 1) tar_handle->action_header = header_list;
854 if (opt & OPT_EXTRACT)
855 tar_handle->action_data = data_extract_all;
857 if (opt & OPT_2STDOUT)
858 tar_handle->action_data = data_extract_to_stdout;
860 if (opt & OPT_KEEP_OLD)
861 tar_handle->flags &= ~ARCHIVE_EXTRACT_UNCONDITIONAL;
863 if (opt & OPT_NOPRESERVE_OWN)
864 tar_handle->flags |= ARCHIVE_NOPRESERVE_OWN;
866 if (opt & OPT_NOPRESERVE_PERM)
867 tar_handle->flags |= ARCHIVE_NOPRESERVE_PERM;
870 get_header_ptr = get_header_tar_gz;
873 get_header_ptr = get_header_tar_bz2;
876 get_header_ptr = get_header_tar_lzma;
878 if (opt & OPT_COMPRESS)
879 get_header_ptr = get_header_tar_Z;
881 #if ENABLE_FEATURE_TAR_FROM
882 tar_handle->reject = append_file_list_to_list(tar_handle->reject);
883 #if ENABLE_FEATURE_TAR_LONG_OPTIONS
884 /* Append excludes to reject */
886 llist_t *next = excludes->link;
887 excludes->link = tar_handle->reject;
888 tar_handle->reject = excludes;
892 tar_handle->accept = append_file_list_to_list(tar_handle->accept);
895 /* Check if we are reading from stdin */
896 if (argv[optind] && *argv[optind] == '-') {
897 /* Default is to read from stdin, so just skip to next arg */
901 /* Setup an array of filenames to work with */
902 /* TODO: This is the same as in ar, separate function ? */
903 while (optind < argc) {
904 /* kill trailing '/' unless the string is just "/" */
905 char *cp = last_char_is(argv[optind], '/');
906 if (cp > argv[optind])
908 llist_add_to_end(&tar_handle->accept, argv[optind]);
912 if (tar_handle->accept || tar_handle->reject)
913 tar_handle->filter = filter_accept_reject_list;
915 /* Open the tar file */
920 if (opt & OPT_CREATE) {
921 /* Make sure there is at least one file to tar up. */
922 if (tar_handle->accept == NULL)
923 bb_error_msg_and_die("empty archive");
926 /* Mimicking GNU tar 1.15.1: */
927 flags = O_WRONLY|O_CREAT|O_TRUNC;
928 /* was doing unlink; open(O_WRONLY|O_CREAT|O_EXCL); why? */
934 if (LONE_DASH(tar_filename)) {
935 tar_handle->src_fd = fileno(tar_stream);
936 tar_handle->seek = seek_by_read;
938 tar_handle->src_fd = xopen(tar_filename, flags);
945 #ifdef CHECK_FOR_CHILD_EXITCODE
946 /* We need to know whether child (gzip/bzip/etc) exits abnormally */
947 signal(SIGCHLD, handle_SIGCHLD);
950 /* create an archive */
951 if (opt & OPT_CREATE) {
952 #if ENABLE_FEATURE_TAR_GZIP || ENABLE_FEATURE_TAR_BZIP2
954 if (ENABLE_FEATURE_TAR_GZIP && (opt & OPT_GZIP))
956 if (ENABLE_FEATURE_TAR_BZIP2 && (opt & OPT_BZIP2))
959 /* NB: writeTarFile() closes tar_handle->src_fd */
960 return writeTarFile(tar_handle->src_fd, verboseFlag, opt & OPT_DEREFERENCE,
962 tar_handle->reject, zipMode);
965 while (get_header_ptr(tar_handle) == EXIT_SUCCESS)
968 /* Check that every file that should have been extracted was */
969 while (tar_handle->accept) {
970 if (!find_list_entry(tar_handle->reject, tar_handle->accept->data)
971 && !find_list_entry(tar_handle->passed, tar_handle->accept->data)
973 bb_error_msg_and_die("%s: not found in archive",
974 tar_handle->accept->data);
976 tar_handle->accept = tar_handle->accept->link;
978 if (ENABLE_FEATURE_CLEAN_UP /* && tar_handle->src_fd != STDIN_FILENO */)
979 close(tar_handle->src_fd);