1 /* remove.c -- core functions for removing files and directories
2 Copyright (C) 88, 90, 91, 1994-2007 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2, or (at your option)
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software Foundation,
16 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
18 /* Extracted from rm.c and librarified, then rewritten by Jim Meyering. */
22 #include <sys/types.h>
27 #include "cycle-check.h"
30 #include "euidaccess.h"
31 #include "euidaccess-stat.h"
32 #include "file-type.h"
40 #include "root-dev-ino.h"
41 #include "unlinkdir.h"
44 /* Avoid shadowing warnings because these are functions declared
45 in dirname.h as well as locals used below. */
46 #define dir_name rm_dir_name
47 #define dir_len rm_dir_len
49 #define obstack_chunk_alloc malloc
50 #define obstack_chunk_free free
52 /* This is the maximum number of consecutive readdir/unlink calls that
53 can be made (with no intervening rewinddir or closedir/opendir) before
54 triggering a bug that makes readdir return NULL even though some
55 directory entries have not been processed. The bug afflicts SunOS's
56 readdir when applied to ufs file systems and Darwin 6.5's (and OSX
57 v.10.3.8's) HFS+. This maximum is conservative in that demonstrating
58 the problem requires a directory containing at least 16 deletable
59 entries (which doesn't count . and ..).
60 This problem also affects Darwin 7.9.0 (aka MacOS X 10.3.9) on HFS+
61 and NFS-mounted file systems, but not vfat ones. */
64 CONSECUTIVE_READDIR_UNLINK_THRESHOLD = 10
67 /* FIXME: in 2009, or whenever Darwin 7.9.0 (aka MacOS X 10.3.9) is no
68 longer relevant, remove this work-around code. Then, there will be
69 no need to perform the extra rewinddir call, ever. */
70 #define NEED_REWIND(readdir_unlink_count) \
71 (CONSECUTIVE_READDIR_UNLINK_THRESHOLD <= (readdir_unlink_count))
79 typedef enum Ternary Ternary;
81 /* The prompt function may be called twice for a given directory.
82 The first time, we ask whether to descend into it, and the
83 second time, we ask whether to remove it. */
86 PA_DESCEND_INTO_DIR = 2,
90 /* Initial capacity of per-directory hash table of entries that have
91 been processed but not been deleted. */
92 enum { HT_UNREMOVABLE_INITIAL_CAPACITY = 13 };
94 /* An entry in the active directory stack.
95 Each entry corresponds to an `active' directory. */
98 /* For a given active directory, this is the set of names of
99 entries in that directory that could/should not be removed.
100 For example, `.' and `..', as well as files/dirs for which
101 unlink/rmdir failed e.g., due to access restrictions. */
102 Hash_table *unremovable;
104 /* Record the status for a given active directory; we need to know
105 whether an entry was not removed, either because of an error or
106 because the user declined. */
107 enum RM_status status;
109 /* The directory's dev/ino. Used to ensure that a malicious user does
110 not replace a directory we're about to process with a symlink to
111 some other directory. */
112 struct dev_ino dev_ino;
115 extern char *program_name;
117 struct dirstack_state
119 /* The name of the directory (starting with and relative to a command
120 line argument) being processed. When a subdirectory is entered, a new
121 component is appended (pushed). Remove (pop) the top component
122 upon chdir'ing out of a directory. This is used to form the full
123 name of the current directory or a file therein, when necessary. */
124 struct obstack dir_stack;
126 /* Stack of lengths of directory names (including trailing slash)
127 appended to dir_stack. We have to have a separate stack of lengths
128 (rather than just popping back to previous slash) because the first
129 element pushed onto the dir stack may contain slashes. */
130 struct obstack len_stack;
132 /* Stack of active directory entries.
133 The first `active' directory is the initial working directory.
134 Additional active dirs are pushed onto the stack as we `chdir'
135 into each directory to be processed. When finished with the
136 hierarchy under a directory, pop the active dir stack. */
137 struct obstack Active_dir;
139 /* Used to detect cycles. */
140 struct cycle_check_state cycle_check_state;
142 /* Target of a longjmp in case rm has to stop processing the current
143 command-line argument. This happens 1) when rm detects a directory
144 cycle or 2) when it has processed one or more directories, but then
145 is unable to return to the initial working directory to process
146 additional `.'-relative command-line arguments. */
147 jmp_buf current_arg_jumpbuf;
149 typedef struct dirstack_state Dirstack_state;
151 /* Like fstatat, but cache the result. If ST->st_size is -1, the
152 status has not been gotten yet. If less than -1, fstatat failed
153 with errno == -1 - ST->st_size. Otherwise, the status has already
154 been gotten, so return 0. */
156 cache_fstatat (int fd, char const *file, struct stat *st, int flag)
158 if (st->st_size == -1 && fstatat (fd, file, st, flag) != 0)
159 st->st_size = -1 - errno;
160 if (0 <= st->st_size)
162 errno = -1 - st->st_size;
166 /* Initialize a fstatat cache *ST. Return ST for convenience. */
167 static inline struct stat *
168 cache_stat_init (struct stat *st)
174 /* Return true if *ST has been statted. */
176 cache_statted (struct stat *st)
178 return (st->st_size != -1);
181 /* Return true if *ST has been statted successfully. */
183 cache_stat_ok (struct stat *st)
185 return (0 <= st->st_size);
196 hash_compare_strings (void const *x, void const *y)
198 return STREQ (x, y) ? true : false;
202 push_dir (Dirstack_state *ds, const char *dir_name)
204 size_t len = strlen (dir_name);
206 /* Append the string onto the stack. */
207 obstack_grow (&ds->dir_stack, dir_name, len);
209 /* Append a trailing slash. */
210 obstack_1grow (&ds->dir_stack, '/');
212 /* Add one for the slash. */
215 /* Push the length (including slash) onto its stack. */
216 obstack_grow (&ds->len_stack, &len, sizeof (len));
219 /* Return the entry name of the directory on the top of the stack
220 in malloc'd storage. */
222 top_dir (Dirstack_state const *ds)
224 size_t n_lengths = obstack_object_size (&ds->len_stack) / sizeof (size_t);
225 size_t *length = obstack_base (&ds->len_stack);
226 size_t top_len = length[n_lengths - 1];
227 char const *p = obstack_next_free (&ds->dir_stack) - top_len;
228 char *q = xmalloc (top_len);
229 memcpy (q, p, top_len - 1);
235 pop_dir (Dirstack_state *ds)
237 size_t n_lengths = obstack_object_size (&ds->len_stack) / sizeof (size_t);
238 size_t *length = obstack_base (&ds->len_stack);
240 assert (n_lengths > 0);
241 size_t top_len = length[n_lengths - 1];
242 assert (top_len >= 2);
244 /* Pop the specified length of file name. */
245 assert (obstack_object_size (&ds->dir_stack) >= top_len);
246 obstack_blank (&ds->dir_stack, -top_len);
248 /* Pop the length stack, too. */
249 assert (obstack_object_size (&ds->len_stack) >= sizeof (size_t));
250 obstack_blank (&ds->len_stack, -(int) sizeof (size_t));
253 /* Copy the SRC_LEN bytes of data beginning at SRC into the DST_LEN-byte
254 buffer, DST, so that the last source byte is at the end of the destination
255 buffer. If SRC_LEN is longer than DST_LEN, then set *TRUNCATED.
256 Set *RESULT to point to the beginning of (the portion of) the source data
257 in DST. Return the number of bytes remaining in the destination buffer. */
260 right_justify (char *dst, size_t dst_len, const char *src, size_t src_len,
261 char **result, bool *truncated)
266 if (src_len <= dst_len)
269 dp = dst + (dst_len - src_len);
274 sp = src + (src_len - dst_len);
280 *result = memcpy (dp, sp, src_len);
281 return dst_len - src_len;
284 /* Using the global directory name obstack, create the full name FILENAME.
285 Return it in sometimes-realloc'd space that should not be freed by the
286 caller. Realloc as necessary. If realloc fails, use a static buffer
287 and put as long a suffix in that buffer as possible. */
289 #define full_filename(Filename) full_filename_ (ds, Filename)
291 full_filename_ (Dirstack_state const *ds, const char *filename)
293 static char *buf = NULL;
294 static size_t n_allocated = 0;
296 size_t dir_len = obstack_object_size (&ds->dir_stack);
297 char *dir_name = obstack_base (&ds->dir_stack);
298 size_t n_bytes_needed;
301 filename_len = strlen (filename);
302 n_bytes_needed = dir_len + filename_len + 1;
304 if (n_allocated < n_bytes_needed)
306 /* This code requires that realloc accept NULL as the first arg.
307 This function must not use xrealloc. Otherwise, an out-of-memory
308 error involving a file name to be expanded here wouldn't ever
309 be issued. Use realloc and fall back on using a static buffer
310 if memory allocation fails. */
311 char *new_buf = realloc (buf, n_bytes_needed);
312 n_allocated = n_bytes_needed;
316 #define SBUF_SIZE 512
317 #define ELLIPSES_PREFIX "[...]"
318 static char static_buf[SBUF_SIZE];
324 len = right_justify (static_buf, SBUF_SIZE, filename,
325 filename_len + 1, &p, &truncated);
326 right_justify (static_buf, len, dir_name, dir_len, &p, &truncated);
329 memcpy (static_buf, ELLIPSES_PREFIX,
330 sizeof (ELLIPSES_PREFIX) - 1);
338 if (filename_len == 1 && *filename == '.' && dir_len)
340 /* FILENAME is just `.' and dir_len is nonzero.
341 Copy the directory part, omitting the trailing slash,
342 and append a trailing zero byte. */
343 char *p = mempcpy (buf, dir_name, dir_len - 1);
348 /* Copy the directory part, including trailing slash, and then
349 append the filename part, including a trailing zero byte. */
350 memcpy (mempcpy (buf, dir_name, dir_len), filename, filename_len + 1);
351 assert (strlen (buf) + 1 == n_bytes_needed);
358 AD_stack_height (Dirstack_state const *ds)
360 return obstack_object_size (&ds->Active_dir) / sizeof (struct AD_ent);
363 static inline struct AD_ent *
364 AD_stack_top (Dirstack_state const *ds)
366 return (struct AD_ent *)
367 ((char *) obstack_next_free (&ds->Active_dir) - sizeof (struct AD_ent));
371 AD_stack_pop (Dirstack_state *ds)
373 assert (0 < AD_stack_height (ds));
375 /* operate on Active_dir. pop and free top entry */
376 struct AD_ent *top = AD_stack_top (ds);
377 if (top->unremovable)
378 hash_free (top->unremovable);
379 obstack_blank (&ds->Active_dir, -(int) sizeof (struct AD_ent));
383 AD_stack_clear (Dirstack_state *ds)
385 while (0 < AD_stack_height (ds))
391 static Dirstack_state *
394 Dirstack_state *ds = xmalloc (sizeof *ds);
395 obstack_init (&ds->dir_stack);
396 obstack_init (&ds->len_stack);
397 obstack_init (&ds->Active_dir);
402 ds_clear (Dirstack_state *ds)
404 obstack_free (&ds->dir_stack, obstack_finish (&ds->dir_stack));
405 obstack_free (&ds->len_stack, obstack_finish (&ds->len_stack));
406 while (0 < AD_stack_height (ds))
408 obstack_free (&ds->Active_dir, obstack_finish (&ds->Active_dir));
412 ds_free (Dirstack_state *ds)
414 obstack_free (&ds->dir_stack, NULL);
415 obstack_free (&ds->len_stack, NULL);
416 obstack_free (&ds->Active_dir, NULL);
420 /* Pop the active directory (AD) stack and prepare to move `up' one level,
421 safely. Moving `up' usually means opening `..', but when we've just
422 finished recursively processing a command-line directory argument,
423 there's nothing left on the stack, so set *FDP to AT_FDCWD in that case.
424 The idea is to return with *FDP opened on the parent directory,
425 assuming there are entries in that directory that we need to remove.
427 Note that we must not call opendir (or fdopendir) just yet, since
428 the caller must first remove the directory we're coming from.
429 That is because some file system implementations cache readdir
430 results at opendir time; so calling opendir, rmdir, readdir would
431 return an entry for the just-removed directory.
433 Whenever using chdir '..' (virtually, now, via openat), verify
434 that the post-chdir dev/ino numbers for `.' match the saved ones.
435 If any system call fails or if dev/ino don't match, then give a
436 diagnostic and longjump out.
437 Return the name (in malloc'd storage) of the
438 directory (usually now empty) from which we're coming, and which
439 corresponds to the input value of DIRP.
441 Finally, note that while this function's name is no longer as
442 accurate as it once was (it no longer calls chdir), it does open
443 the destination directory. */
445 AD_pop_and_chdir (DIR *dirp, int *fdp, Dirstack_state *ds)
447 struct AD_ent *leaf_dir_ent = AD_stack_top(ds);
448 struct dev_ino leaf_dev_ino = leaf_dir_ent->dev_ino;
449 enum RM_status old_status = leaf_dir_ent->status;
452 /* Get the name of the current (but soon to be `previous') directory
453 from the top of the stack. */
454 char *prev_dir = top_dir (ds);
458 top = AD_stack_top (ds);
460 /* If the directory we're about to leave (and try to rmdir)
461 is the one whose dev_ino is being used to detect a cycle,
462 reset cycle_check_state.dev_ino to that of the parent.
463 Otherwise, once that directory is removed, its dev_ino
464 could be reused in the creation (by some other process)
465 of a directory that this rm process would encounter,
466 which would result in a false-positive cycle indication. */
467 CYCLE_CHECK_REFLECT_CHDIR_UP (&ds->cycle_check_state,
468 top->dev_ino, leaf_dev_ino);
470 /* Propagate any failure to parent. */
471 UPDATE_STATUS (top->status, old_status);
473 assert (AD_stack_height (ds));
475 if (1 < AD_stack_height (ds))
478 int fd = openat (dirfd (dirp), "..", O_RDONLY);
479 if (closedir (dirp) != 0)
481 error (0, errno, _("FATAL: failed to close directory %s"),
482 quote (full_filename (prev_dir)));
483 goto next_cmdline_arg;
486 /* The above fails with EACCES when DIRP is readable but not
487 searchable, when using Solaris' openat. Without this openat
488 call, tests/rm2 would fail to remove directories a/2 and a/3. */
490 fd = openat (AT_FDCWD, full_filename ("."), O_RDONLY);
494 error (0, errno, _("FATAL: cannot open .. from %s"),
495 quote (full_filename (prev_dir)));
496 goto next_cmdline_arg;
502 _("FATAL: cannot ensure %s (returned to via ..) is safe"),
503 quote (full_filename (".")));
507 /* Ensure that post-chdir dev/ino match the stored ones. */
508 if ( ! SAME_INODE (sb, top->dev_ino))
510 error (0, 0, _("FATAL: directory %s changed dev/ino"),
511 quote (full_filename (".")));
517 longjmp (ds->current_arg_jumpbuf, 1);
523 if (closedir (dirp) != 0)
525 error (0, errno, _("FATAL: failed to close directory %s"),
526 quote (full_filename (prev_dir)));
527 goto next_cmdline_arg;
535 /* Initialize *HT if it is NULL. Return *HT. */
537 AD_ensure_initialized (Hash_table **ht)
541 *ht = hash_initialize (HT_UNREMOVABLE_INITIAL_CAPACITY, NULL, hash_pjw,
542 hash_compare_strings, hash_freer);
550 /* Initialize *HT if it is NULL.
551 Insert FILENAME into HT. */
553 AD_mark_helper (Hash_table **ht, char *filename)
555 void *ent = hash_insert (AD_ensure_initialized (ht), filename);
565 /* Mark FILENAME (in current directory) as unremovable. */
567 AD_mark_as_unremovable (Dirstack_state *ds, char const *filename)
569 AD_mark_helper (&AD_stack_top(ds)->unremovable, xstrdup (filename));
572 /* Mark the current directory as unremovable. I.e., mark the entry
573 in the parent directory corresponding to `.'.
574 This happens e.g., when an opendir fails and the only name
575 the caller has conveniently at hand is `.'. */
577 AD_mark_current_as_unremovable (Dirstack_state *ds)
579 struct AD_ent *top = AD_stack_top (ds);
580 char *curr = top_dir (ds);
582 assert (1 < AD_stack_height (ds));
585 AD_mark_helper (&top->unremovable, curr);
588 /* Push an initial dummy entry onto the stack.
589 This will always be the bottommost entry on the stack. */
591 AD_push_initial (Dirstack_state *ds)
595 /* Extend the stack. */
596 obstack_blank (&ds->Active_dir, sizeof (struct AD_ent));
598 /* Fill in the new values. */
599 top = AD_stack_top (ds);
600 top->unremovable = NULL;
602 /* These should never be used.
603 Give them values that might look suspicious
604 in a debugger or in a diagnostic. */
605 top->dev_ino.st_dev = TYPE_MAXIMUM (dev_t);
606 top->dev_ino.st_ino = TYPE_MAXIMUM (ino_t);
609 /* Push info about the current working directory (".") onto the
610 active directory stack. DIR is the ./-relative name through
611 which we've just `chdir'd to this directory. DIR_SB_FROM_PARENT
612 is the result of calling lstat on DIR from the parent of DIR.
613 Longjump out (skipping the entire command line argument we're
614 dealing with) if `fstat (FD_CWD, ...' fails or if someone has
615 replaced DIR with e.g., a symlink to some other directory. */
617 AD_push (int fd_cwd, Dirstack_state *ds, char const *dir,
618 struct stat const *dir_sb_from_parent)
624 /* If our uses of openat are guaranteed not to
625 follow a symlink, then we can skip this check. */
626 if (! HAVE_WORKING_O_NOFOLLOW)
629 if (fstat (fd_cwd, &sb) != 0)
631 error (0, errno, _("FATAL: cannot enter directory %s"),
632 quote (full_filename (".")));
633 longjmp (ds->current_arg_jumpbuf, 1);
636 if ( ! SAME_INODE (sb, *dir_sb_from_parent))
639 _("FATAL: just-changed-to directory %s changed dev/ino"),
640 quote (full_filename (".")));
641 longjmp (ds->current_arg_jumpbuf, 1);
645 if (cycle_check (&ds->cycle_check_state, dir_sb_from_parent))
648 WARNING: Circular directory structure.\n\
649 This almost certainly means that you have a corrupted file system.\n\
650 NOTIFY YOUR SYSTEM MANAGER.\n\
651 The following directory is part of the cycle:\n %s\n"),
652 quote (full_filename (".")));
653 longjmp (ds->current_arg_jumpbuf, 1);
656 /* Extend the stack. */
657 obstack_blank (&ds->Active_dir, sizeof (struct AD_ent));
659 /* The active directory stack must be one larger than the length stack. */
660 assert (AD_stack_height (ds) ==
661 1 + obstack_object_size (&ds->len_stack) / sizeof (size_t));
663 /* Fill in the new values. */
664 top = AD_stack_top (ds);
665 top->dev_ino.st_dev = dir_sb_from_parent->st_dev;
666 top->dev_ino.st_ino = dir_sb_from_parent->st_ino;
667 top->unremovable = NULL;
671 AD_is_removable (Dirstack_state const *ds, char const *file)
673 struct AD_ent *top = AD_stack_top (ds);
674 return ! (top->unremovable && hash_lookup (top->unremovable, file));
677 /* Return true if DIR is determined to be an empty directory. */
679 is_empty_dir (int fd_cwd, char const *dir)
682 struct dirent const *dp;
684 int fd = openat (fd_cwd, dir,
685 (O_RDONLY | O_DIRECTORY
686 | O_NOCTTY | O_NOFOLLOW | O_NONBLOCK));
691 dirp = fdopendir (fd);
699 dp = readdir_ignoring_dot_and_dotdot (dirp);
704 return saved_errno == 0 ? true : false;
707 /* Return true if FILE is determined to be an unwritable non-symlink.
708 Otherwise, return false (including when lstat'ing it fails).
709 Set *BUF to the file status.
710 This is to avoid calling euidaccess when FILE is a symlink. */
712 write_protected_non_symlink (int fd_cwd,
714 Dirstack_state const *ds,
717 if (cache_fstatat (fd_cwd, file, buf, AT_SYMLINK_NOFOLLOW) != 0)
719 if (S_ISLNK (buf->st_mode))
721 /* Here, we know FILE is not a symbolic link. */
723 /* In order to be reentrant -- i.e., to avoid changing the working
724 directory, and at the same time to be able to deal with alternate
725 access control mechanisms (ACLs, xattr-style attributes) and
726 arbitrarily deep trees -- we need a function like eaccessat, i.e.,
727 like Solaris' eaccess, but fd-relative, in the spirit of openat. */
729 /* In the absence of a native eaccessat function, here are some of
730 the implementation choices [#4 and #5 were suggested by Paul Eggert]:
731 1) call openat with O_WRONLY|O_NOCTTY
732 Disadvantage: may create the file and doesn't work for directory,
733 may mistakenly report `unwritable' for EROFS or ACLs even though
734 perm bits say the file is writable.
736 2) fake eaccessat (save_cwd, fchdir, call euidaccess, restore_cwd)
737 Disadvantage: changes working directory (not reentrant) and can't
738 work if save_cwd fails.
740 3) if (euidaccess (full_filename (file), W_OK) == 0)
741 Disadvantage: doesn't work if full_filename is too long.
742 Inefficient for very deep trees (O(Depth^2)).
744 4) If the full pathname is sufficiently short (say, less than
745 PATH_MAX or 8192 bytes, whichever is shorter):
746 use method (3) (i.e., euidaccess (full_filename (file), W_OK));
747 Otherwise: vfork, fchdir in the child, run euidaccess in the
748 child, then the child exits with a status that tells the parent
749 whether euidaccess succeeded.
751 This avoids the O(N**2) algorithm of method (3), and it also avoids
752 the failure-due-to-too-long-file-names of method (3), but it's fast
753 in the normal shallow case. It also avoids the lack-of-reentrancy
754 and the save_cwd problems.
755 Disadvantage; it uses a process slot for very-long file names,
756 and would be very slow for hierarchies with many such files.
758 5) If the full file name is sufficiently short (say, less than
759 PATH_MAX or 8192 bytes, whichever is shorter):
760 use method (3) (i.e., euidaccess (full_filename (file), W_OK));
761 Otherwise: look just at the file bits. Perhaps issue a warning
762 the first time this occurs.
764 This is like (4), except for the "Otherwise" case where it isn't as
765 "perfect" as (4) but is considerably faster. It conforms to current
766 POSIX, and is uniformly better than what Solaris and FreeBSD do (they
767 mess up with long file names). */
770 /* This implements #5: */
772 = obstack_object_size (&ds->dir_stack) + strlen (file);
774 return (file_name_len < MIN (PATH_MAX, 8192)
775 ? euidaccess (full_filename (file), W_OK) != 0 && errno == EACCES
776 : euidaccess_stat (buf, W_OK) != 0);
780 /* Prompt whether to remove FILENAME, if required via a combination of
781 the options specified by X and/or file attributes. If the file may
782 be removed, return RM_OK. If the user declines to remove the file,
783 return RM_USER_DECLINED. If not ignoring missing files and we
784 cannot lstat FILENAME, then return RM_ERROR.
786 Depending on MODE, ask whether to `descend into' or to `remove' the
787 directory FILENAME. MODE is ignored when FILENAME is not a directory.
788 Set *IS_EMPTY to T_YES if FILENAME is an empty directory, and it is
789 appropriate to try to remove it with rmdir (e.g. recursive mode).
790 Don't even try to set *IS_EMPTY when MODE == PA_REMOVE_DIR. */
791 static enum RM_status
792 prompt (int fd_cwd, Dirstack_state const *ds, char const *filename,
794 struct rm_options const *x, enum Prompt_action mode,
797 bool write_protected = false;
799 *is_empty = T_UNKNOWN;
801 if (((!x->ignore_missing_files & (x->interactive | x->stdin_tty))
802 && (write_protected = write_protected_non_symlink (fd_cwd, filename,
806 if (cache_fstatat (fd_cwd, filename, sbuf, AT_SYMLINK_NOFOLLOW) != 0)
808 /* This happens, e.g., with `rm '''. */
809 error (0, errno, _("cannot remove %s"),
810 quote (full_filename (filename)));
814 if (S_ISDIR (sbuf->st_mode) && !x->recursive)
816 error (0, EISDIR, _("cannot remove %s"),
817 quote (full_filename (filename)));
821 /* Using permissions doesn't make sense for symlinks. */
822 if (S_ISLNK (sbuf->st_mode))
824 if ( ! x->interactive)
826 write_protected = false;
829 /* Issue the prompt. */
831 char const *quoted_name = quote (full_filename (filename));
833 /* FIXME: use a variant of error (instead of fprintf) that doesn't
834 append a newline. Then we won't have to declare program_name in
836 if (S_ISDIR (sbuf->st_mode)
838 && mode == PA_DESCEND_INTO_DIR
839 && ((*is_empty = (is_empty_dir (fd_cwd, filename) ? T_YES : T_NO))
843 ? _("%s: descend into write-protected directory %s? ")
844 : _("%s: descend into directory %s? ")),
845 program_name, quoted_name);
848 /* TRANSLATORS: You may find it more convenient to translate
849 the equivalent of _("%s: remove %s (write-protected) %s? ").
850 It should avoid grammatical problems with the output
854 ? _("%s: remove write-protected %s %s? ")
855 : _("%s: remove %s %s? ")),
856 program_name, file_type (sbuf), quoted_name);
860 return RM_USER_DECLINED;
866 /* Return true if FILENAME is a directory (and not a symlink to a directory).
867 Otherwise, including the case in which lstat fails, return false.
868 *ST is FILENAME's tstatus.
869 Do not modify errno. */
871 is_dir_lstat (char const *filename, struct stat *st)
873 int saved_errno = errno;
875 (cache_fstatat (AT_FDCWD, filename, st, AT_SYMLINK_NOFOLLOW) == 0
876 && S_ISDIR (st->st_mode));
881 #if HAVE_STRUCT_DIRENT_D_TYPE
883 /* True if the type of the directory entry D is known. */
884 # define DT_IS_KNOWN(d) ((d)->d_type != DT_UNKNOWN)
886 /* True if the type of the directory entry D must be T. */
887 # define DT_MUST_BE(d, t) ((d)->d_type == (t))
890 # define DT_IS_KNOWN(d) false
891 # define DT_MUST_BE(d, t) false
894 #define DO_UNLINK(Fd_cwd, Filename, X) \
897 if (unlinkat (Fd_cwd, Filename, 0) == 0) \
900 printf (_("removed %s\n"), quote (full_filename (Filename))); \
904 if (ignorable_missing (X, errno)) \
909 #define DO_RMDIR(Fd_cwd, Filename, X) \
912 if (unlinkat (Fd_cwd, Filename, AT_REMOVEDIR) == 0) /* rmdir */ \
915 printf (_("removed directory: %s\n"), \
916 quote (full_filename (Filename))); \
920 if (ignorable_missing (X, errno)) \
923 if (errno == ENOTEMPTY || errno == EEXIST) \
924 return RM_NONEMPTY_DIR; \
928 /* When a function like unlink, rmdir, or fstatat fails with an errno
929 value of ERRNUM, return true if the specified file system object
930 is guaranteed not to exist; otherwise, return false. */
932 nonexistent_file_errno (int errnum)
934 /* Do not include ELOOP here, since the specified file may indeed
935 exist, but be (in)accessible only via too long a symlink chain.
936 Likewise for ENAMETOOLONG, since rm -f ./././.../foo may fail
937 if the "..." part expands to a long enough sequence of "./"s,
938 even though ./foo does indeed exist. */
950 /* Encapsulate the test for whether the errno value, ERRNUM, is ignorable. */
952 ignorable_missing (struct rm_options const *x, int errnum)
954 return x->ignore_missing_files && nonexistent_file_errno (errnum);
957 /* Remove the file or directory specified by FILENAME.
958 Return RM_OK if it is removed, and RM_ERROR or RM_USER_DECLINED if not.
959 But if FILENAME specifies a non-empty directory, return RM_NONEMPTY_DIR. */
961 static enum RM_status
962 remove_entry (int fd_cwd, Dirstack_state const *ds, char const *filename,
964 struct rm_options const *x, struct dirent const *dp)
966 Ternary is_empty_directory;
967 enum RM_status s = prompt (fd_cwd, ds, filename, st, x, PA_DESCEND_INTO_DIR,
968 &is_empty_directory);
969 bool known_to_be_dir = (cache_stat_ok (st) && S_ISDIR (st->st_mode));
974 /* Why bother with the following if/else block? Because on systems with
975 an unlink function that *can* unlink directories, we must determine the
976 type of each entry before removing it. Otherwise, we'd risk unlinking
977 an entire directory tree simply by unlinking a single directory; then
978 all the storage associated with that hierarchy would not be freed until
979 the next fsck. Not nice. To avoid that, on such slightly losing
980 systems, we need to call lstat to determine the type of each entry,
981 and that represents extra overhead that -- it turns out -- we can
982 avoid on non-losing systems, since there, unlink will never remove
983 a directory. Also, on systems where unlink may unlink directories,
984 we're forced to allow a race condition: we lstat a non-directory, then
985 go to unlink it, but in the mean time, a malicious someone could have
986 replaced it with a directory. */
988 if (cannot_unlink_dir ())
990 if (known_to_be_dir && ! x->recursive)
992 error (0, EISDIR, _("cannot remove %s"),
993 quote (full_filename (filename)));
997 /* is_empty_directory is set iff it's ok to use rmdir.
998 Note that it's set only in interactive mode -- in which case it's
999 an optimization that arranges so that the user is asked just
1000 once whether to remove the directory. */
1001 if (is_empty_directory == T_YES)
1002 DO_RMDIR (fd_cwd, filename, x);
1004 /* If we happen to know that FILENAME is a directory, return now
1005 and let the caller remove it -- this saves the overhead of a failed
1006 unlink call. If FILENAME is a command-line argument, then dp is NULL,
1007 so we'll first try to unlink it. Using unlink here is ok, because it
1008 cannot remove a directory. */
1009 if ((dp && DT_MUST_BE (dp, DT_DIR)) || known_to_be_dir)
1010 return RM_NONEMPTY_DIR;
1012 DO_UNLINK (fd_cwd, filename, x);
1014 /* Upon a failed attempt to unlink a directory, most non-Linux systems
1015 set errno to the POSIX-required value EPERM. In that case, change
1016 errno to EISDIR so that we emit a better diagnostic. */
1017 if (! x->recursive && errno == EPERM && is_dir_lstat (filename, st))
1021 || (cache_stat_ok (st) && !S_ISDIR (st->st_mode)))
1023 if (ignorable_missing (x, errno))
1026 /* Either --recursive is not in effect, or the file cannot be a
1027 directory. Report the unlink problem and fail. */
1028 error (0, errno, _("cannot remove %s"),
1029 quote (full_filename (filename)));
1032 assert (!cache_stat_ok (st) || S_ISDIR (st->st_mode));
1036 /* If we don't already know whether FILENAME is a directory,
1037 find out now. Then, if it's a non-directory, we can use
1041 if (cache_statted (st))
1042 is_dir = known_to_be_dir;
1045 if (dp && DT_IS_KNOWN (dp))
1046 is_dir = DT_MUST_BE (dp, DT_DIR);
1049 if (fstatat (fd_cwd, filename, st, AT_SYMLINK_NOFOLLOW))
1051 if (ignorable_missing (x, errno))
1054 error (0, errno, _("cannot remove %s"),
1055 quote (full_filename (filename)));
1059 is_dir = !! S_ISDIR (st->st_mode);
1065 /* At this point, barring race conditions, FILENAME is known
1066 to be a non-directory, so it's ok to try to unlink it. */
1067 DO_UNLINK (fd_cwd, filename, x);
1069 /* unlink failed with some other error code. report it. */
1070 error (0, errno, _("cannot remove %s"),
1071 quote (full_filename (filename)));
1077 error (0, EISDIR, _("cannot remove %s"),
1078 quote (full_filename (filename)));
1082 if (is_empty_directory == T_YES)
1084 DO_RMDIR (fd_cwd, filename, x);
1085 /* Don't diagnose any failure here.
1086 It'll be detected when the caller tries another way. */
1090 return RM_NONEMPTY_DIR;
1093 /* Given FD_CWD, the file descriptor for an open directory,
1094 open its subdirectory F (F is already `known' to be a directory,
1095 so if it is no longer one, someone is playing games), return a DIR*
1096 pointer for F, and put F's `stat' data in *SUBDIR_SB.
1097 Upon failure give a diagnostic and return NULL.
1098 If PREV_ERRNO is nonzero, it is the errno value from a preceding failed
1099 unlink- or rmdir-like system call -- use that value instead of ENOTDIR
1100 if an opened file turns out not to be a directory. This is important
1101 when the preceding non-dir-unlink failed due to e.g., EPERM or EACCES.
1102 The caller must use a nonnnull CWD_ERRNO the first
1103 time this function is called for each command-line-specified directory.
1104 If CWD_ERRNO is not null, set *CWD_ERRNO to the appropriate error number
1105 if this function fails to restore the initial working directory.
1106 If it is null, report an error and exit if the working directory
1109 fd_to_subdirp (int fd_cwd, char const *f,
1110 struct rm_options const *x, int prev_errno,
1111 struct stat *subdir_sb,
1112 int *cwd_errno ATTRIBUTE_UNUSED)
1114 int open_flags = O_RDONLY | O_NOCTTY | O_NOFOLLOW | O_NONBLOCK;
1115 int fd_sub = openat_permissive (fd_cwd, f, open_flags, 0, cwd_errno);
1118 /* Record dev/ino of F. We may compare them against saved values
1119 to thwart any attempt to subvert the traversal. They are also used
1120 to detect directory cycles. */
1123 else if (fstat (fd_sub, subdir_sb) != 0)
1124 saved_errno = errno;
1125 else if (S_ISDIR (subdir_sb->st_mode))
1127 DIR *subdir_dirp = fdopendir (fd_sub);
1130 saved_errno = errno;
1133 saved_errno = (prev_errno ? prev_errno : ENOTDIR);
1136 errno = saved_errno;
1140 /* Remove entries in the directory open on DIRP
1141 Upon finding a directory that is both non-empty and that can be chdir'd
1142 into, return RM_OK and set *SUBDIR and fill in SUBDIR_SB, where
1143 SUBDIR is the malloc'd name of the subdirectory if the chdir succeeded,
1144 NULL otherwise (e.g., if opendir failed or if there was no subdirectory).
1145 Likewise, SUBDIR_SB is the result of calling lstat on SUBDIR.
1146 Return RM_OK if all entries are removed. Return RM_ERROR if any
1147 entry cannot be removed. Otherwise, return RM_USER_DECLINED if
1148 the user declines to remove at least one entry. Remove as much as
1149 possible, continuing even if we fail to remove some entries. */
1150 static enum RM_status
1151 remove_cwd_entries (DIR **dirp,
1152 Dirstack_state *ds, char **subdir, struct stat *subdir_sb,
1153 struct rm_options const *x)
1155 struct AD_ent *top = AD_stack_top (ds);
1156 enum RM_status status = top->status;
1157 size_t n_unlinked_since_opendir_or_last_rewind = 0;
1159 assert (VALID_STATUS (status));
1164 struct dirent const *dp;
1165 enum RM_status tmp_status;
1168 /* Set errno to zero so we can distinguish between a readdir failure
1169 and when readdir simply finds that there are no more entries. */
1171 dp = readdir_ignoring_dot_and_dotdot (*dirp);
1178 else if (NEED_REWIND (n_unlinked_since_opendir_or_last_rewind))
1180 /* Call rewinddir if we've called unlink or rmdir so many times
1181 (since the opendir or the previous rewinddir) that this
1182 NULL-return may be the symptom of a buggy readdir. */
1184 n_unlinked_since_opendir_or_last_rewind = 0;
1192 /* Skip files we've already tried/failed to remove. */
1193 if ( ! AD_is_removable (ds, f))
1196 /* Pass dp->d_type info to remove_entry so the non-glibc
1197 case can decide whether to use unlink or chdir.
1198 Systems without the d_type member will have to endure
1199 the performance hit of first calling lstat F. */
1200 cache_stat_init (subdir_sb);
1201 tmp_status = remove_entry (dirfd (*dirp), ds, f, subdir_sb, x, dp);
1205 /* Count how many files we've unlinked since the initial
1206 opendir or the last rewinddir. On buggy systems, if you
1207 remove too many, readdir returns NULL even though there
1208 remain unprocessed directory entries. */
1209 ++n_unlinked_since_opendir_or_last_rewind;
1213 case RM_USER_DECLINED:
1214 AD_mark_as_unremovable (ds, f);
1215 UPDATE_STATUS (status, tmp_status);
1218 case RM_NONEMPTY_DIR:
1220 DIR *subdir_dirp = fd_to_subdirp (dirfd (*dirp), f,
1221 x, errno, subdir_sb, NULL);
1222 if (subdir_dirp == NULL)
1226 /* CAUTION: this test and diagnostic are identical to
1227 those following the other use of fd_to_subdirp. */
1228 if (ignorable_missing (x, errno))
1230 /* With -f, don't report "file not found". */
1234 /* Upon fd_to_subdirp failure, try to remove F directly,
1235 in case it's just an empty directory. */
1236 int saved_errno = errno;
1237 if (unlinkat (dirfd (*dirp), f, AT_REMOVEDIR) == 0)
1240 error (0, saved_errno,
1241 _("cannot remove %s"), quote (full_filename (f)));
1244 if (status == RM_ERROR)
1245 AD_mark_as_unremovable (ds, f);
1249 *subdir = xstrdup (f);
1250 if (closedir (*dirp) != 0)
1252 error (0, 0, _("failed to close directory %s"),
1253 quote (full_filename (".")));
1256 *dirp = subdir_dirp;
1262 /* Record status for this directory. */
1263 UPDATE_STATUS (top->status, status);
1269 /* Ensure that *dirp is not NULL and that its file descriptor is valid. */
1270 assert (*dirp != NULL);
1271 assert (0 <= fcntl (dirfd (*dirp), F_GETFD));
1276 /* Do this after each call to AD_push or AD_push_initial.
1277 Because the status = RM_OK bit is too remove-specific to
1278 go into the general-purpose AD_* package. */
1279 #define AD_INIT_OTHER_MEMBERS() \
1282 AD_stack_top(ds)->status = RM_OK; \
1286 /* Remove the hierarchy rooted at DIR.
1287 Do that by changing into DIR, then removing its contents, then
1288 returning to the original working directory and removing DIR itself.
1289 Don't use recursion. Be careful when using chdir ".." that we
1290 return to the same directory from which we came, if necessary.
1291 Return an RM_status value to indicate success or failure. */
1293 static enum RM_status
1294 remove_dir (int fd_cwd, Dirstack_state *ds, char const *dir,
1295 struct stat *dir_st,
1296 struct rm_options const *x, int *cwd_errno)
1298 enum RM_status status;
1299 dev_t current_dev = dir_st->st_dev;
1301 /* There is a race condition in that an attacker could replace the nonempty
1302 directory, DIR, with a symlink between the preceding call to rmdir
1303 (unlinkat, in our caller) and fd_to_subdirp's openat call. But on most
1304 systems, even those without openat, this isn't a problem, since we ensure
1305 that opening a symlink will fail, when that is possible. Otherwise,
1306 fd_to_subdirp's fstat, along with the `fstat' and the dev/ino
1307 comparison in AD_push ensure that we detect it and fail. */
1309 DIR *dirp = fd_to_subdirp (fd_cwd, dir, x, 0, dir_st, cwd_errno);
1313 /* CAUTION: this test and diagnostic are identical to
1314 those following the other use of fd_to_subdirp. */
1315 if (ignorable_missing (x, errno))
1317 /* With -f, don't report "file not found". */
1321 /* Upon fd_to_subdirp failure, try to remove DIR directly,
1322 in case it's just an empty directory. */
1323 int saved_errno = errno;
1324 if (unlinkat (fd_cwd, dir, AT_REMOVEDIR) == 0)
1327 error (0, saved_errno,
1328 _("cannot remove %s"), quote (full_filename (dir)));
1334 if (ROOT_DEV_INO_CHECK (x->root_dev_ino, dir_st))
1336 ROOT_DEV_INO_WARN (full_filename (dir));
1338 goto closedir_and_return;
1341 AD_push (dirfd (dirp), ds, dir, dir_st);
1342 AD_INIT_OTHER_MEMBERS ();
1348 char *subdir = NULL;
1349 struct stat subdir_sb;
1350 enum RM_status tmp_status;
1352 tmp_status = remove_cwd_entries (&dirp, ds, &subdir, &subdir_sb, x);
1354 if (tmp_status != RM_OK)
1356 UPDATE_STATUS (status, tmp_status);
1357 AD_mark_current_as_unremovable (ds);
1361 if ( ! x->one_file_system
1362 || subdir_sb.st_dev == current_dev)
1364 AD_push (dirfd (dirp), ds, subdir, &subdir_sb);
1365 AD_INIT_OTHER_MEMBERS ();
1370 /* Here, --one-file-system is in effect, and with remove_cwd_entries'
1371 traversal into the current directory, (known as SUBDIR, from ..),
1372 DIRP's device number is different from CURRENT_DEV. Arrange not
1373 to do anything more with this hierarchy. */
1374 error (0, 0, _("skipping %s, since it's on a different device"),
1375 quote (full_filename (subdir)));
1377 AD_mark_current_as_unremovable (ds);
1378 tmp_status = RM_ERROR;
1379 UPDATE_STATUS (status, tmp_status);
1382 /* Execution reaches this point when we've removed the last
1383 removable entry from the current directory -- or, with
1384 --one-file-system, when the current directory is on a
1385 different file system. */
1388 /* The name of the directory that we have just processed,
1389 nominally removing all of its contents. */
1390 char *empty_dir = AD_pop_and_chdir (dirp, &fd, ds);
1392 assert (fd != AT_FDCWD || AD_stack_height (ds) == 1);
1394 /* Try to remove EMPTY_DIR only if remove_cwd_entries succeeded. */
1395 if (tmp_status == RM_OK)
1397 /* This does a little more work than necessary when it actually
1398 prompts the user. E.g., we already know that D is a directory
1399 and that it's almost certainly empty, yet we lstat it.
1400 But that's no big deal since we're interactive. */
1401 struct stat empty_st;
1403 enum RM_status s = prompt (fd, ds, empty_dir,
1404 cache_stat_init (&empty_st), x,
1405 PA_REMOVE_DIR, &is_empty);
1413 goto closedir_and_return;
1416 if (unlinkat (fd, empty_dir, AT_REMOVEDIR) == 0)
1419 printf (_("removed directory: %s\n"),
1420 quote (full_filename (empty_dir)));
1424 error (0, errno, _("cannot remove directory %s"),
1425 quote (full_filename (empty_dir)));
1426 AD_mark_as_unremovable (ds, empty_dir);
1428 UPDATE_STATUS (AD_stack_top(ds)->status, status);
1437 dirp = fdopendir (fd);
1440 error (0, errno, _("FATAL: cannot return to .. from %s"),
1441 quote (full_filename (".")));
1443 longjmp (ds->current_arg_jumpbuf, 1);
1448 /* If the first/final hash table of unremovable entries was used,
1452 closedir_and_return:;
1453 if (dirp != NULL && closedir (dirp) != 0)
1455 error (0, 0, _("failed to close directory %s"),
1456 quote (full_filename (".")));
1463 /* Remove the file or directory specified by FILENAME.
1464 Return RM_OK if it is removed, and RM_ERROR or RM_USER_DECLINED if not. */
1466 static enum RM_status
1467 rm_1 (Dirstack_state *ds, char const *filename,
1468 struct rm_options const *x, int *cwd_errno)
1470 char const *base = last_component (filename);
1471 if (dot_or_dotdot (base))
1473 error (0, 0, _(base == filename
1474 ? "cannot remove directory %s"
1475 : "cannot remove %s directory %s"),
1476 quote_n (0, base), quote_n (1, filename));
1481 cache_stat_init (&st);
1482 cycle_check_init (&ds->cycle_check_state);
1483 if (x->root_dev_ino)
1485 if (cache_fstatat (AT_FDCWD, filename, &st, AT_SYMLINK_NOFOLLOW) != 0)
1487 if (ignorable_missing (x, errno))
1489 error (0, errno, _("cannot remove %s"), quote (filename));
1492 if (SAME_INODE (st, *(x->root_dev_ino)))
1494 error (0, 0, _("cannot remove root directory %s"), quote (filename));
1499 AD_push_initial (ds);
1500 AD_INIT_OTHER_MEMBERS ();
1502 enum RM_status status = remove_entry (AT_FDCWD, ds, filename, &st, x, NULL);
1503 if (status == RM_NONEMPTY_DIR)
1505 /* In the event that remove_dir->remove_cwd_entries detects
1506 a directory cycle, arrange to fail, give up on this FILE, but
1507 continue on with any other arguments. */
1508 if (setjmp (ds->current_arg_jumpbuf))
1511 status = remove_dir (AT_FDCWD, ds, filename, &st, x, cwd_errno);
1513 AD_stack_clear (ds);
1520 /* Remove all files and/or directories specified by N_FILES and FILE.
1521 Apply the options in X. */
1522 extern enum RM_status
1523 rm (size_t n_files, char const *const *file, struct rm_options const *x)
1525 enum RM_status status = RM_OK;
1526 Dirstack_state *ds = ds_init ();
1530 for (i = 0; i < n_files; i++)
1532 if (cwd_errno && IS_RELATIVE_FILE_NAME (file[i]))
1534 error (0, 0, _("cannot remove relative-named %s"), quote (file[i]));
1539 enum RM_status s = rm_1 (ds, file[i], x, &cwd_errno);
1540 assert (VALID_STATUS (s));
1541 UPDATE_STATUS (status, s);
1545 if (x->require_restore_cwd && cwd_errno)
1547 error (0, cwd_errno,
1548 _("cannot restore current working directory"));