2 * Copyright (c) 1992 Keith Muller.
3 * Copyright (c) 1992, 1993
4 * The Regents of the University of California. All rights reserved.
6 * This code is derived from software contributed to Berkeley by
7 * Keith Muller of the University of California, San Diego.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * @(#)file_subs.c 8.1 (Berkeley) 5/31/93
34 * $FreeBSD: src/bin/pax/file_subs.c,v 1.12.2.1 2001/08/01 05:03:11 obrien Exp $
35 * $DragonFly: src/bin/pax/file_subs.c,v 1.8 2006/09/27 21:58:08 pavalos Exp $
38 #include <sys/types.h>
53 mk_link (char *,struct stat
*,char *, int);
56 * routines that deal with file operations such as: creating, removing;
57 * and setting access modes, uid/gid and times of files
60 #define FILEBITS (S_ISVTX | S_IRWXU | S_IRWXG | S_IRWXO)
61 #define SETBITS (S_ISUID | S_ISGID)
62 #define ABITS (FILEBITS | SETBITS)
66 * Create and open a file.
68 * file descriptor or -1 for failure
72 file_creat(ARCHD
*arcn
)
79 * Assume file doesn't exist, so just try to create it, most times this
80 * works. We have to take special handling when the file does exist. To
81 * detect this, we use O_EXCL. For example when trying to create a
82 * file and a character device or fifo exists with the same name, we
83 * can accidently open the device by mistake (or block waiting to open).
84 * If we find that the open has failed, then spend the effort to
85 * figure out why. This strategy was found to have better average
86 * performance in common use than checking the file (and the path)
89 file_mode
= arcn
->sb
.st_mode
& FILEBITS
;
90 if ((fd
= open(arcn
->name
, O_WRONLY
| O_CREAT
| O_TRUNC
| O_EXCL
,
95 * the file seems to exist. First we try to get rid of it (found to be
96 * the second most common failure when traced). If this fails, only
97 * then we go to the expense to check and create the path to the file
99 if (unlnk_exist(arcn
->name
, arcn
->type
) != 0)
104 * try to open it again, if this fails, check all the nodes in
105 * the path and give it a final try. if chk_path() finds that
106 * it cannot fix anything, we will skip the last attempt
108 if ((fd
= open(arcn
->name
, O_WRONLY
| O_CREAT
| O_TRUNC
,
112 if (nodirs
|| chk_path(arcn
->name
,arcn
->sb
.st_uid
,arcn
->sb
.st_gid
) < 0) {
113 syswarn(1, oerrno
, "Unable to create %s", arcn
->name
);
122 * Close file descriptor to a file just created by pax. Sets modes,
123 * ownership and times as required.
125 * 0 for success, -1 for failure
129 file_close(ARCHD
*arcn
, int fd
)
136 syswarn(0, errno
, "Unable to close file descriptor on %s",
140 * set owner/groups first as this may strip off mode bits we want
141 * then set file permission modes. Then set file access and
142 * modification times.
145 res
= set_ids(arcn
->name
, arcn
->sb
.st_uid
, arcn
->sb
.st_gid
);
148 * IMPORTANT SECURITY NOTE:
149 * if not preserving mode or we cannot set uid/gid, then PROHIBIT
153 arcn
->sb
.st_mode
&= ~(SETBITS
);
155 set_pmode(arcn
->name
, arcn
->sb
.st_mode
);
156 if (patime
|| pmtime
)
157 set_ftime(arcn
->name
, arcn
->sb
.st_mtime
, arcn
->sb
.st_atime
, 0);
162 * Create a hard link to arcn->ln_name from arcn->name. arcn->ln_name
165 * 0 if ok, -1 otherwise
169 lnk_creat(ARCHD
*arcn
)
174 * we may be running as root, so we have to be sure that link target
175 * is not a directory, so we lstat and check
177 if (lstat(arcn
->ln_name
, &sb
) < 0) {
178 syswarn(1,errno
,"Unable to link to %s from %s", arcn
->ln_name
,
183 if (S_ISDIR(sb
.st_mode
)) {
184 paxwarn(1, "A hard link to the directory %s is not allowed",
189 return(mk_link(arcn
->ln_name
, &sb
, arcn
->name
, 0));
194 * Create a hard link to arcn->org_name from arcn->name. Only used in copy
195 * with the -l flag. No warning or error if this does not succeed (we will
196 * then just create the file)
198 * 1 if copy() should try to create this file node
199 * 0 if cross_lnk() ok, -1 for fatal flaw (like linking to self).
203 cross_lnk(ARCHD
*arcn
)
206 * try to make a link to original file (-l flag in copy mode). make sure
207 * we do not try to link to directories in case we are running as root
208 * (and it might succeed).
210 if (arcn
->type
== PAX_DIR
)
212 return(mk_link(arcn
->org_name
, &(arcn
->sb
), arcn
->name
, 1));
217 * In copy mode if we are not trying to make hard links between the src
218 * and destinations, make sure we are not going to overwrite ourselves by
219 * accident. This slows things down a little, but we have to protect all
220 * those people who make typing errors.
222 * 1 the target does not exist, go ahead and copy
223 * 0 skip it file exists (-k) or may be the same as source file
227 chk_same(ARCHD
*arcn
)
232 * if file does not exist, return. if file exists and -k, skip it
235 if (lstat(arcn
->name
, &sb
) < 0)
241 * better make sure the user does not have src == dest by mistake
243 if ((arcn
->sb
.st_dev
== sb
.st_dev
) && (arcn
->sb
.st_ino
== sb
.st_ino
)) {
244 paxwarn(1, "Unable to copy %s, file would overwrite itself",
253 * try to make a hard link between two files. if ign set, we do not
256 * 0 if successful (or we are done with this file but no error, such as
257 * finding the from file exists and the user has set -k).
258 * 1 when ign was set to indicates we could not make the link but we
259 * should try to copy/extract the file as that might work (and is an
260 * allowed option). -1 an error occurred.
264 mk_link(char *to
, struct stat
*to_sb
, char *from
,
271 * if from file exists, it has to be unlinked to make the link. If the
272 * file exists and -k is set, skip it quietly
274 if (lstat(from
, &sb
) == 0) {
279 * make sure it is not the same file, protect the user
281 if ((to_sb
->st_dev
==sb
.st_dev
)&&(to_sb
->st_ino
== sb
.st_ino
)) {
282 paxwarn(1, "Unable to link file %s to itself", to
);
287 * try to get rid of the file, based on the type
289 if (S_ISDIR(sb
.st_mode
)) {
290 if (rmdir(from
) < 0) {
291 syswarn(1, errno
, "Unable to remove %s", from
);
294 } else if (unlink(from
) < 0) {
296 syswarn(1, errno
, "Unable to remove %s", from
);
304 * from file is gone (or did not exist), try to make the hard link.
305 * if it fails, check the path and try it again (if chk_path() says to
309 if (link(to
, from
) == 0)
312 if (!nodirs
&& chk_path(from
, to_sb
->st_uid
, to_sb
->st_gid
) == 0)
315 syswarn(1, oerrno
, "Could not link to %s from %s", to
,
323 * all right the link was made
330 * create an entry in the file system (other than a file or hard link).
331 * If successful, sets uid/gid modes and times as required.
333 * 0 if ok, -1 otherwise
337 node_creat(ARCHD
*arcn
)
347 * create node based on type, if that fails try to unlink the node and
348 * try again. finally check the path and try again. As noted in the
349 * file and link creation routines, this method seems to exhibit the
350 * best performance in general use workloads.
352 file_mode
= arcn
->sb
.st_mode
& FILEBITS
;
357 res
= mkdir(arcn
->name
, file_mode
);
362 file_mode
|= S_IFCHR
;
363 res
= mknod(arcn
->name
, file_mode
, arcn
->sb
.st_rdev
);
366 file_mode
|= S_IFBLK
;
367 res
= mknod(arcn
->name
, file_mode
, arcn
->sb
.st_rdev
);
370 res
= mkfifo(arcn
->name
, file_mode
);
374 * Skip sockets, operation has no meaning under BSD
377 "%s skipped. Sockets cannot be copied or extracted",
381 res
= symlink(arcn
->ln_name
, arcn
->name
);
389 * we should never get here
391 paxwarn(0, "%s has an unknown file type, skipping",
397 * if we were able to create the node break out of the loop,
398 * otherwise try to unlink the node and try again. if that
399 * fails check the full path and try a final time.
405 * we failed to make the node
408 if ((ign
= unlnk_exist(arcn
->name
, arcn
->type
)) < 0)
414 if (nodirs
|| chk_path(arcn
->name
,arcn
->sb
.st_uid
,arcn
->sb
.st_gid
) < 0) {
415 syswarn(1, oerrno
, "Could not create: %s", arcn
->name
);
421 * we were able to create the node. set uid/gid, modes and times
424 res
= ((arcn
->type
== PAX_SLK
) ?
425 set_lids(arcn
->name
, arcn
->sb
.st_uid
, arcn
->sb
.st_gid
) :
426 set_ids(arcn
->name
, arcn
->sb
.st_uid
, arcn
->sb
.st_gid
));
431 * symlinks are done now.
433 if (arcn
->type
== PAX_SLK
)
437 * IMPORTANT SECURITY NOTE:
438 * if not preserving mode or we cannot set uid/gid, then PROHIBIT any
442 arcn
->sb
.st_mode
&= ~(SETBITS
);
444 set_pmode(arcn
->name
, arcn
->sb
.st_mode
);
446 if (arcn
->type
== PAX_DIR
&& strcmp(NM_CPIO
, argv0
) != 0) {
448 * Dirs must be processed again at end of extract to set times
449 * and modes to agree with those stored in the archive. However
450 * to allow extract to continue, we may have to also set owner
451 * rights. This allows nodes in the archive that are children
452 * of this directory to be extracted without failure. Both time
453 * and modes will be fixed after the entire archive is read and
456 if (access(arcn
->name
, R_OK
| W_OK
| X_OK
) < 0) {
457 if (lstat(arcn
->name
, &sb
) < 0) {
458 syswarn(0, errno
,"Could not access %s (stat)",
460 set_pmode(arcn
->name
,file_mode
| S_IRWXU
);
463 * We have to add rights to the dir, so we make
464 * sure to restore the mode. The mode must be
465 * restored AS CREATED and not as stored if
468 set_pmode(arcn
->name
,
469 ((sb
.st_mode
& FILEBITS
) | S_IRWXU
));
471 arcn
->sb
.st_mode
= sb
.st_mode
;
475 * we have to force the mode to what was set here,
476 * since we changed it from the default as created.
478 add_dir(arcn
->name
, arcn
->nlen
, &(arcn
->sb
), 1);
479 } else if (pmode
|| patime
|| pmtime
)
480 add_dir(arcn
->name
, arcn
->nlen
, &(arcn
->sb
), 0);
483 if (patime
|| pmtime
)
484 set_ftime(arcn
->name
, arcn
->sb
.st_mtime
, arcn
->sb
.st_atime
, 0);
490 * Remove node from file system with the specified name. We pass the type
491 * of the node that is going to replace it. When we try to create a
492 * directory and find that it already exists, we allow processing to
493 * continue as proper modes etc will always be set for it later on.
495 * 0 is ok to proceed, no file with the specified name exists
496 * -1 we were unable to remove the node, or we should not remove it (-k)
497 * 1 we found a directory and we were going to create a directory.
501 unlnk_exist(char *name
, int type
)
506 * the file does not exist, or -k we are done
508 if (lstat(name
, &sb
) < 0)
513 if (S_ISDIR(sb
.st_mode
)) {
515 * try to remove a directory, if it fails and we were going to
516 * create a directory anyway, tell the caller (return a 1)
518 if (rmdir(name
) < 0) {
521 syswarn(1,errno
,"Unable to remove directory %s", name
);
528 * try to get rid of all non-directory type nodes
530 if (unlink(name
) < 0) {
531 syswarn(1, errno
, "Could not unlink %s", name
);
539 * We were trying to create some kind of node in the file system and it
540 * failed. chk_path() makes sure the path up to the node exists and is
541 * writeable. When we have to create a directory that is missing along the
542 * path somewhere, the directory we create will be set to the same
543 * uid/gid as the file has (when uid and gid are being preserved).
544 * NOTE: this routine is a real performance loss. It is only used as a
545 * last resort when trying to create entries in the file system.
547 * -1 when it could find nothing it is allowed to fix.
552 chk_path( char *name
, uid_t st_uid
, gid_t st_gid
)
559 * watch out for paths with nodes stored directly in / (e.g. /bozo)
566 * work forward from the first / and check each part of the path
568 spt
= strchr(spt
, '/');
574 * if it exists we assume it is a directory, it is not within
575 * the spec (at least it seems to read that way) to alter the
576 * file system for nodes NOT EXPLICITLY stored on the archive.
577 * If that assumption is changed, you would test the node here
578 * and figure out how to get rid of it (probably like some
579 * recursive unlink()) or fix up the directory permissions if
580 * required (do an access()).
582 if (lstat(name
, &sb
) == 0) {
588 * the path fails at this point, see if we can create the
589 * needed directory and continue on
591 if (mkdir(name
, S_IRWXU
| S_IRWXG
| S_IRWXO
) < 0) {
598 * we were able to create the directory. We will tell the
599 * caller that we found something to fix, and it is ok to try
600 * and create the node again.
604 set_ids(name
, st_uid
, st_gid
);
607 * make sure the user doesn't have some strange umask that
608 * causes this newly created directory to be unusable. We fix
609 * the modes and restore them back to the creation default at
612 if ((access(name
, R_OK
| W_OK
| X_OK
) < 0) &&
613 (lstat(name
, &sb
) == 0)) {
614 set_pmode(name
, ((sb
.st_mode
& FILEBITS
) | S_IRWXU
));
615 add_dir(name
, spt
- name
, &sb
, 1);
625 * Set the access time and modification time for a named file. If frc is
626 * non-zero we force these times to be set even if the user did not
627 * request access and/or modification time preservation (this is also
628 * used by -t to reset access times).
629 * When ign is zero, only those times the user has asked for are set, the
630 * other ones are left alone. We do not assume the un-documented feature
631 * of many utimes() implementations that consider a 0 time value as a do
636 set_ftime(char *fnm
, time_t mtime
, time_t atime
, int frc
)
638 static struct timeval tv
[2] = {{0L, 0L}, {0L, 0L}};
641 tv
[0].tv_sec
= (long)atime
;
642 tv
[1].tv_sec
= (long)mtime
;
643 if (!frc
&& (!patime
|| !pmtime
)) {
645 * if we are not forcing, only set those times the user wants
646 * set. We get the current values of the times if we need them.
648 if (lstat(fnm
, &sb
) == 0) {
650 tv
[0].tv_sec
= (long)sb
.st_atime
;
652 tv
[1].tv_sec
= (long)sb
.st_mtime
;
654 syswarn(0,errno
,"Unable to obtain file stats %s", fnm
);
660 if (utimes(fnm
, tv
) < 0)
661 syswarn(1, errno
, "Access/modification time set failed on: %s",
668 * set the uid and gid of a file system node
670 * 0 when set, -1 on failure
674 set_ids(char *fnm
, uid_t uid
, gid_t gid
)
676 if (chown(fnm
, uid
, gid
) < 0) {
678 * ignore EPERM unless in verbose mode or being run by root.
679 * if running as pax, POSIX requires a warning.
681 if (strcmp(NM_PAX
, argv0
) == 0 || errno
!= EPERM
|| vflag
||
683 syswarn(1, errno
, "Unable to set file uid/gid of %s",
692 * set the uid and gid of a file system node
694 * 0 when set, -1 on failure
698 set_lids(char *fnm
, uid_t uid
, gid_t gid
)
700 if (lchown(fnm
, uid
, gid
) < 0) {
702 * ignore EPERM unless in verbose mode or being run by root.
703 * if running as pax, POSIX requires a warning.
705 if (strcmp(NM_PAX
, argv0
) == 0 || errno
!= EPERM
|| vflag
||
707 syswarn(1, errno
, "Unable to set file uid/gid of %s",
716 * Set file access mode
720 set_pmode(char *fnm
, mode_t mode
)
723 if (chmod(fnm
, mode
) < 0)
724 syswarn(1, errno
, "Could not set permissions on %s", fnm
);
730 * Write/copy a file (during copy or archive extract). This routine knows
731 * how to copy files with lseek holes in it. (Which are read as file
732 * blocks containing all 0's but do not have any file blocks associated
733 * with the data). Typical examples of these are files created by dbm
734 * variants (.pag files). While the file size of these files are huge, the
735 * actual storage is quite small (the files are sparse). The problem is
736 * the holes read as all zeros so are probably stored on the archive that
737 * way (there is no way to determine if the file block is really a hole,
738 * we only know that a file block of all zero's can be a hole).
739 * At this writing, no major archive format knows how to archive files
740 * with holes. However, on extraction (or during copy, -rw) we have to
741 * deal with these files. Without detecting the holes, the files can
742 * consume a lot of file space if just written to disk. This replacement
743 * for write when passed the basic allocation size of a file system block,
744 * uses lseek whenever it detects the input data is all 0 within that
745 * file block. In more detail, the strategy is as follows:
746 * While the input is all zero keep doing an lseek. Keep track of when we
747 * pass over file block boundaries. Only write when we hit a non zero
748 * input. once we have written a file block, we continue to write it to
749 * the end (we stop looking at the input). When we reach the start of the
750 * next file block, start checking for zero blocks again. Working on file
751 * block boundaries significantly reduces the overhead when copying files
752 * that are NOT very sparse. This overhead (when compared to a write) is
753 * almost below the measurement resolution on many systems. Without it,
754 * files with holes cannot be safely copied. It does has a side effect as
755 * it can put holes into files that did not have them before, but that is
756 * not a problem since the file contents are unchanged (in fact it saves
757 * file space). (Except on paging files for diskless clients. But since we
758 * cannot determine one of those file from here, we ignore them). If this
759 * ever ends up on a system where CTG files are supported and the holes
760 * are not desired, just do a conditional test in those routines that
761 * call file_write() and have it call write() instead. BEFORE CLOSING THE
762 * FILE, make sure to call file_flush() when the last write finishes with
763 * an empty block. A lot of file systems will not create an lseek hole at
764 * the end. In this case we drop a single 0 at the end to force the
765 * trailing 0's in the file.
767 * rem: how many bytes left in this file system block
768 * isempt: have we written to the file block yet (is it empty)
769 * sz: basic file block allocation size
770 * cnt: number of bytes on this write
771 * str: buffer to write
773 * number of bytes written, -1 on write (or lseek) error.
777 file_write(int fd
, char *str
, int cnt
, int *rem
, int *isempt
, int sz
,
786 * while we have data to process
791 * We are now at the start of file system block again
792 * (or what we think one is...). start looking for
800 * only examine up to the end of the current file block or
801 * remaining characters to write, whatever is smaller
803 wcnt
= MIN(cnt
, *rem
);
808 * have not written to this block yet, so we keep
815 * look for a zero filled buffer
817 while ((pt
< end
) && (*pt
== '\0'))
822 * skip, buf is empty so far
824 if (lseek(fd
, (off_t
)wcnt
, SEEK_CUR
) < 0) {
825 syswarn(1,errno
,"File seek on %s",
833 * drat, the buf is not zero filled
839 * have non-zero data in this file system block, have to write
841 if (write(fd
, st
, wcnt
) != wcnt
) {
842 syswarn(1, errno
, "Failed write to file %s", name
);
852 * when the last file block in a file is zero, many file systems will not
853 * let us create a hole at the end. To get the last block with zeros, we
854 * write the last BYTE with a zero (back up one byte and write a zero).
858 file_flush(int fd
, char *fname
, int isempt
)
860 static char blnk
[] = "\0";
863 * silly test, but make sure we are only called when the last block is
864 * filled with all zeros.
870 * move back one byte and write a zero
872 if (lseek(fd
, (off_t
)-1, SEEK_CUR
) < 0) {
873 syswarn(1, errno
, "Failed seek on file %s", fname
);
877 if (write(fd
, blnk
, 1) < 0)
878 syswarn(1, errno
, "Failed write to file %s", fname
);
884 * close a file we have beed reading (to copy or archive). If we have to
885 * reset access time (tflag) do so (the times are stored in arcn).
889 rdfile_close(ARCHD
*arcn
, int *fd
)
892 * make sure the file is open
903 * user wants last access time reset
905 set_ftime(arcn
->org_name
, arcn
->sb
.st_mtime
, arcn
->sb
.st_atime
, 1);
911 * read a file to calculate its crc. This is a real drag. Archive formats
912 * that have this, end up reading the file twice (we have to write the
913 * header WITH the crc before writing the file contents. Oh well...
915 * 0 if was able to calculate the crc, -1 otherwise
919 set_crc(ARCHD
*arcn
, int fd
)
925 unsigned long crc
= 0L;
931 * hmm, no fd, should never happen. well no crc then.
937 if ((size
= (u_long
)arcn
->sb
.st_blksize
) > (u_long
)sizeof(tbuf
))
938 size
= (u_long
)sizeof(tbuf
);
941 * read all the bytes we think that there are in the file. If the user
942 * is trying to archive an active file, forget this file.
945 if ((res
= read(fd
, tbuf
, size
)) <= 0)
948 for (i
= 0; i
< res
; ++i
)
949 crc
+= (tbuf
[i
] & 0xff);
953 * safety check. we want to avoid archiving files that are active as
954 * they can create inconsistent archive copies.
956 if (cpcnt
!= arcn
->sb
.st_size
)
957 paxwarn(1, "File changed size %s", arcn
->org_name
);
958 else if (fstat(fd
, &sb
) < 0)
959 syswarn(1, errno
, "Failed stat on %s", arcn
->org_name
);
960 else if (arcn
->sb
.st_mtime
!= sb
.st_mtime
)
961 paxwarn(1, "File %s was modified during read", arcn
->org_name
);
962 else if (lseek(fd
, (off_t
)0L, SEEK_SET
) < 0)
963 syswarn(1, errno
, "File rewind failed on: %s", arcn
->org_name
);