1 /* Miscellaneous functions, not really specific to GNU tar.
3 Copyright (C) 1988, 1992, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
4 2003, 2004, 2005, 2006, 2007, 2009 Free Software Foundation, Inc.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 3, or (at your option) any later
11 This program is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
14 Public License for more details.
16 You should have received a copy of the GNU General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
26 #include <unlinkdir.h>
33 # include <sys/filio.h>
36 #ifndef DOUBLE_SLASH_IS_DISTINCT_ROOT
37 # define DOUBLE_SLASH_IS_DISTINCT_ROOT 0
41 /* Handling strings. */
43 /* Assign STRING to a copy of VALUE if not zero, or to zero. If
44 STRING was nonzero, it is freed first. */
46 assign_string (char **string
, const char *value
)
50 *string
= value
? xstrdup (value
) : 0;
53 /* Allocate a copy of the string quoted as in C, and returns that. If
54 the string does not have to be quoted, it returns a null pointer.
55 The allocated copy should normally be freed with free() after the
56 caller is done with it.
58 This is used in one context only: generating the directory file in
59 incremental dumps. The quoted string is not intended for human
60 consumption; it is intended only for unquote_string. The quoting
61 is locale-independent, so that users needn't worry about locale
62 when reading directory files. This means that we can't use
63 quotearg, as quotearg is locale-dependent and is meant for human
66 quote_copy_string (const char *string
)
68 const char *source
= string
;
69 char *destination
= 0;
75 int character
= *source
++;
82 size_t length
= (source
- string
) - 1;
85 buffer
= xmalloc (length
+ 2 + 2 * strlen (source
) + 1);
86 memcpy (buffer
, string
, length
);
87 destination
= buffer
+ length
;
89 *destination
++ = '\\';
90 *destination
++ = character
== '\\' ? '\\' : 'n';
95 *destination
++ = character
;
107 /* Takes a quoted C string (like those produced by quote_copy_string)
108 and turns it back into the un-quoted original. This is done in
109 place. Returns 0 only if the string was not properly quoted, but
110 completes the unquoting anyway.
112 This is used for reading the saved directory file in incremental
113 dumps. It is used for decoding old `N' records (demangling names).
114 But also, it is used for decoding file arguments, would they come
115 from the shell or a -T file, and for decoding the --exclude
118 unquote_string (char *string
)
121 char *source
= string
;
122 char *destination
= string
;
124 /* Escape sequences other than \\ and \n are no longer generated by
125 quote_copy_string, but accept them for backwards compatibility,
126 and also because unquote_string is used for purposes other than
127 parsing the output of quote_copy_string. */
134 *destination
++ = '\\';
139 *destination
++ = '\a';
144 *destination
++ = '\b';
149 *destination
++ = '\f';
154 *destination
++ = '\n';
159 *destination
++ = '\r';
164 *destination
++ = '\t';
169 *destination
++ = '\v';
174 *destination
++ = 0177;
187 int value
= *source
++ - '0';
189 if (*source
< '0' || *source
> '7')
191 *destination
++ = value
;
194 value
= value
* 8 + *source
++ - '0';
195 if (*source
< '0' || *source
> '7')
197 *destination
++ = value
;
200 value
= value
* 8 + *source
++ - '0';
201 *destination
++ = value
;
207 *destination
++ = '\\';
209 *destination
++ = *source
++;
212 else if (source
!= destination
)
213 *destination
++ = *source
++;
215 source
++, destination
++;
217 if (source
!= destination
)
222 /* Zap trailing slashes. */
224 zap_slashes (char *name
)
228 if (!name
|| *name
== 0)
230 q
= name
+ strlen (name
) - 1;
231 while (q
> name
&& ISSLASH (*q
))
236 /* Normalize NAME by resolving any relative references and
237 removing trailing slashes. Destructive version: modifies its argument. */
239 normalize_filename_x (char *name
)
244 if (DOUBLE_SLASH_IS_DISTINCT_ROOT
&& ISSLASH (*p
))
247 /* Remove /./, resolve /../ and compress sequences of slashes */
266 if (q
[1] == '.' && ISSLASH (q
[2]))
272 if (*q
== '.' && ISSLASH (p
[-1]))
281 else if (q
[1] == '.' && ISSLASH (q
[2]))
287 while (p
> name
&& !ISSLASH (p
[-1]));
296 /* Remove trailing slashes */
297 while (p
- 1 > name
&& ISSLASH (p
[-1]))
304 /* Normalize NAME by resolving any relative references, removing trailing
305 slashes, and converting it to absolute file name. Return the normalized
306 name, or NULL in case of error. */
309 normalize_filename (const char *name
)
316 copy
= xrealloc (copy
, strlen (copy
) + strlen (name
) + 2);
322 copy
= xstrdup (name
);
323 if (normalize_filename_x (copy
))
328 return xrealloc (copy
, strlen (copy
) + 1);
333 replace_prefix (char **pname
, const char *samp
, size_t slen
,
334 const char *repl
, size_t rlen
)
337 size_t nlen
= strlen (name
);
338 if (nlen
> slen
&& memcmp (name
, samp
, slen
) == 0 && ISSLASH (name
[slen
]))
342 name
= xrealloc (name
, nlen
- slen
+ rlen
+ 1);
345 memmove (name
+ rlen
, name
+ slen
, nlen
- slen
+ 1);
346 memcpy (name
, repl
, rlen
);
351 /* Handling numbers. */
353 /* Output fraction and trailing digits appropriate for a nanoseconds
354 count equal to NS, but don't output unnecessary '.' or trailing
358 code_ns_fraction (int ns
, char *p
)
377 p
[--i
] = '0' + ns
% 10;
386 code_timespec (struct timespec t
, char sbuf
[TIMESPEC_STRSIZE_BOUND
])
391 bool negative
= s
< 0;
393 /* ignore invalid values of ns */
394 if (BILLION
<= ns
|| ns
< 0)
397 if (negative
&& ns
!= 0)
403 np
= umaxtostr (negative
? - (uintmax_t) s
: (uintmax_t) s
, sbuf
+ 1);
406 code_ns_fraction (ns
, sbuf
+ UINTMAX_STRSIZE_BOUND
);
412 /* Saved names in case backup needs to be undone. */
413 static char *before_backup_name
;
414 static char *after_backup_name
;
416 /* Return 1 if FILE_NAME is obviously "." or "/". */
418 must_be_dot_or_slash (char const *file_name
)
420 file_name
+= FILE_SYSTEM_PREFIX_LEN (file_name
);
422 if (ISSLASH (file_name
[0]))
425 if (ISSLASH (file_name
[1]))
427 else if (file_name
[1] == '.'
428 && ISSLASH (file_name
[2 + (file_name
[2] == '.')]))
429 file_name
+= 2 + (file_name
[2] == '.');
431 return ! file_name
[1];
435 while (file_name
[0] == '.' && ISSLASH (file_name
[1]))
438 while (ISSLASH (*file_name
))
442 return ! file_name
[0] || (file_name
[0] == '.' && ! file_name
[1]);
446 /* Some implementations of rmdir let you remove '.' or '/'.
447 Report an error with errno set to zero for obvious cases of this;
448 otherwise call rmdir. */
450 safer_rmdir (const char *file_name
)
452 if (must_be_dot_or_slash (file_name
))
458 return rmdir (file_name
);
461 /* Remove FILE_NAME, returning 1 on success. If FILE_NAME is a directory,
462 then if OPTION is RECURSIVE_REMOVE_OPTION is set remove FILE_NAME
463 recursively; otherwise, remove it only if it is empty. If FILE_NAME is
464 a directory that cannot be removed (e.g., because it is nonempty)
465 and if OPTION is WANT_DIRECTORY_REMOVE_OPTION, then return -1.
466 Return 0 on error, with errno set; if FILE_NAME is obviously the working
467 directory return zero with errno set to zero. */
469 remove_any_file (const char *file_name
, enum remove_option option
)
471 /* Try unlink first if we cannot unlink directories, as this saves
472 us a system call in the common case where we're removing a
474 bool try_unlink_first
= cannot_unlink_dir ();
476 if (try_unlink_first
)
478 if (unlink (file_name
) == 0)
481 /* POSIX 1003.1-2001 requires EPERM when attempting to unlink a
482 directory without appropriate privileges, but many Linux
483 kernels return the more-sensible EISDIR. */
484 if (errno
!= EPERM
&& errno
!= EISDIR
)
488 if (safer_rmdir (file_name
) == 0)
494 return !try_unlink_first
&& unlink (file_name
) == 0;
498 #if defined ENOTEMPTY && ENOTEMPTY != EEXIST
503 case ORDINARY_REMOVE_OPTION
:
506 case WANT_DIRECTORY_REMOVE_OPTION
:
509 case RECURSIVE_REMOVE_OPTION
:
511 char *directory
= savedir (file_name
);
518 for (entry
= directory
;
519 (entrylen
= strlen (entry
)) != 0;
520 entry
+= entrylen
+ 1)
522 char *file_name_buffer
= new_name (file_name
, entry
);
523 int r
= remove_any_file (file_name_buffer
,
524 RECURSIVE_REMOVE_OPTION
);
526 free (file_name_buffer
);
537 return safer_rmdir (file_name
) == 0;
546 /* Check if FILE_NAME already exists and make a backup of it right now.
547 Return success (nonzero) only if the backup is either unneeded, or
548 successful. For now, directories are considered to never need
549 backup. If THIS_IS_THE_ARCHIVE is nonzero, this is the archive and
550 so, we do not have to backup block or character devices, nor remote
553 maybe_backup_file (const char *file_name
, bool this_is_the_archive
)
555 struct stat file_stat
;
557 assign_string (&before_backup_name
, file_name
);
559 /* A run situation may exist between Emacs or other GNU programs trying to
560 make a backup for the same file simultaneously. If theoretically
561 possible, real problems are unlikely. Doing any better would require a
562 convention, GNU-wide, for all programs doing backups. */
564 assign_string (&after_backup_name
, 0);
566 /* Check if we really need to backup the file. */
568 if (this_is_the_archive
&& _remdev (file_name
))
571 if (stat (file_name
, &file_stat
))
576 stat_error (file_name
);
580 if (S_ISDIR (file_stat
.st_mode
))
583 if (this_is_the_archive
584 && (S_ISBLK (file_stat
.st_mode
) || S_ISCHR (file_stat
.st_mode
)))
587 after_backup_name
= find_backup_file_name (file_name
, backup_type
);
588 if (! after_backup_name
)
591 if (rename (before_backup_name
, after_backup_name
) == 0)
594 fprintf (stdlis
, _("Renaming %s to %s\n"),
595 quote_n (0, before_backup_name
),
596 quote_n (1, after_backup_name
));
601 /* The backup operation failed. */
603 ERROR ((0, e
, _("%s: Cannot rename to %s"),
604 quotearg_colon (before_backup_name
),
605 quote_n (1, after_backup_name
)));
606 assign_string (&after_backup_name
, 0);
611 /* Try to restore the recently backed up file to its original name.
612 This is usually only needed after a failed extraction. */
614 undo_last_backup (void)
616 if (after_backup_name
)
618 if (rename (after_backup_name
, before_backup_name
) != 0)
621 ERROR ((0, e
, _("%s: Cannot rename to %s"),
622 quotearg_colon (after_backup_name
),
623 quote_n (1, before_backup_name
)));
626 fprintf (stdlis
, _("Renaming %s back to %s\n"),
627 quote_n (0, after_backup_name
),
628 quote_n (1, before_backup_name
));
629 assign_string (&after_backup_name
, 0);
633 /* Depending on DEREF, apply either stat or lstat to (NAME, BUF). */
635 deref_stat (bool deref
, char const *name
, struct stat
*buf
)
637 return deref
? stat (name
, buf
) : lstat (name
, buf
);
640 /* Set FD's (i.e., FILE's) access time to TIMESPEC[0]. If that's not
641 possible to do by itself, set its access and data modification
642 times to TIMESPEC[0] and TIMESPEC[1], respectively. */
644 set_file_atime (int fd
, char const *file
, struct timespec
const timespec
[2])
649 struct timeval timeval
;
650 timeval
.tv_sec
= timespec
[0].tv_sec
;
651 timeval
.tv_usec
= timespec
[0].tv_nsec
/ 1000;
652 if (ioctl (fd
, _FIOSATIME
, &timeval
) == 0)
657 return gl_futimens (fd
, file
, timespec
);
660 /* A description of a working directory. */
665 struct saved_cwd saved_cwd
;
668 /* A vector of chdir targets. wd[0] is the initial working directory. */
669 static struct wd
*wd
;
671 /* The number of working directories in the vector. */
672 static size_t wd_count
;
674 /* The allocated size of the vector. */
675 static size_t wd_alloc
;
685 /* DIR is the operand of a -C option; add it to vector of chdir targets,
686 and return the index of its location. */
688 chdir_arg (char const *dir
)
690 if (wd_count
== wd_alloc
)
695 wd
= xmalloc (sizeof *wd
* wd_alloc
);
698 wd
= x2nrealloc (wd
, &wd_alloc
, sizeof *wd
);
702 wd
[wd_count
].name
= ".";
703 wd
[wd_count
].saved
= 0;
708 /* Optimize the common special case of the working directory,
709 or the working directory as a prefix. */
712 while (dir
[0] == '.' && ISSLASH (dir
[1]))
713 for (dir
+= 2; ISSLASH (*dir
); dir
++)
715 if (! dir
[dir
[0] == '.'])
719 wd
[wd_count
].name
= dir
;
720 wd
[wd_count
].saved
= 0;
724 /* Change to directory I. If I is 0, change to the initial working
725 directory; otherwise, I must be a value returned by chdir_arg. */
733 struct wd
*prev
= &wd
[previous
];
734 struct wd
*curr
= &wd
[i
];
740 if (save_cwd (&prev
->saved_cwd
) != 0)
742 else if (0 <= prev
->saved_cwd
.desc
)
744 /* Make sure we still have at least one descriptor available. */
745 int fd1
= prev
->saved_cwd
.desc
;
749 else if (errno
== EMFILE
)
751 /* Force restore_cwd to use chdir_long. */
753 prev
->saved_cwd
.desc
= -1;
754 prev
->saved_cwd
.name
= xgetcwd ();
761 FATAL_ERROR ((0, err
, _("Cannot save working directory")));
766 if (restore_cwd (&curr
->saved_cwd
))
767 FATAL_ERROR ((0, 0, _("Cannot change working directory")));
771 if (i
&& ! ISSLASH (curr
->name
[0]))
773 if (chdir (curr
->name
) != 0)
774 chdir_fatal (curr
->name
);
782 close_diag (char const *name
)
784 if (ignore_failed_read_option
)
791 open_diag (char const *name
)
793 if (ignore_failed_read_option
)
800 read_diag_details (char const *name
, off_t offset
, size_t size
)
802 if (ignore_failed_read_option
)
803 read_warn_details (name
, offset
, size
);
805 read_error_details (name
, offset
, size
);
809 readlink_diag (char const *name
)
811 if (ignore_failed_read_option
)
812 readlink_warn (name
);
814 readlink_error (name
);
818 savedir_diag (char const *name
)
820 if (ignore_failed_read_option
)
823 savedir_error (name
);
827 seek_diag_details (char const *name
, off_t offset
)
829 if (ignore_failed_read_option
)
830 seek_warn_details (name
, offset
);
832 seek_error_details (name
, offset
);
836 stat_diag (char const *name
)
838 if (ignore_failed_read_option
)
845 file_removed_diag (const char *name
, bool top_level
,
846 void (*diagfn
) (char const *name
))
848 if (!top_level
&& errno
== ENOENT
)
850 WARNOPT (WARN_FILE_REMOVED
,
851 (0, 0, _("%s: File removed before we read it"),
852 quotearg_colon (name
)));
853 set_exit_status (TAREXIT_DIFFERS
);
860 dir_removed_diag (const char *name
, bool top_level
,
861 void (*diagfn
) (char const *name
))
863 if (!top_level
&& errno
== ENOENT
)
865 WARNOPT (WARN_FILE_REMOVED
,
866 (0, 0, _("%s: Directory removed before we read it"),
867 quotearg_colon (name
)));
868 set_exit_status (TAREXIT_DIFFERS
);
875 write_fatal_details (char const *name
, ssize_t status
, size_t size
)
877 write_error_details (name
, status
, size
);
881 /* Fork, aborting if unsuccessful. */
887 call_arg_fatal ("fork", _("child process"));
891 /* Create a pipe, aborting if unsuccessful. */
896 call_arg_fatal ("pipe", _("interprocess channel"));
899 /* Return PTR, aligned upward to the next multiple of ALIGNMENT.
900 ALIGNMENT must be nonzero. The caller must arrange for ((char *)
901 PTR) through ((char *) PTR + ALIGNMENT - 1) to be addressable
905 ptr_align (void *ptr
, size_t alignment
)
908 char *p1
= p0
+ alignment
- 1;
909 return p1
- (size_t) p1
% alignment
;
912 /* Return the address of a page-aligned buffer of at least SIZE bytes.
913 The caller should free *PTR when done with the buffer. */
916 page_aligned_alloc (void **ptr
, size_t size
)
918 size_t alignment
= getpagesize ();
919 size_t size1
= size
+ alignment
;
922 *ptr
= xmalloc (size1
);
923 return ptr_align (*ptr
, alignment
);
930 char *buffer
; /* directory, `/', and directory member */
931 size_t buffer_size
; /* allocated size of name_buffer */
932 size_t dir_length
; /* length of directory part in buffer */
936 namebuf_create (const char *dir
)
938 namebuf_t buf
= xmalloc (sizeof (*buf
));
939 buf
->buffer_size
= strlen (dir
) + 2;
940 buf
->buffer
= xmalloc (buf
->buffer_size
);
941 strcpy (buf
->buffer
, dir
);
942 buf
->dir_length
= strlen (buf
->buffer
);
943 if (!ISSLASH (buf
->buffer
[buf
->dir_length
- 1]))
944 buf
->buffer
[buf
->dir_length
++] = DIRECTORY_SEPARATOR
;
949 namebuf_free (namebuf_t buf
)
956 namebuf_name (namebuf_t buf
, const char *name
)
958 size_t len
= strlen (name
);
959 while (buf
->dir_length
+ len
+ 1 >= buf
->buffer_size
)
960 buf
->buffer
= x2realloc (buf
->buffer
, &buf
->buffer_size
);
961 strcpy (buf
->buffer
+ buf
->dir_length
, name
);