1 /* `rm' file deletion utility for GNU.
2 Copyright (C) 88, 90, 91, 94, 95, 96, 1997 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
18 /* Written by Paul Rubin, David MacKenzie, and Richard Stallman.
19 Reworked to use chdir and hash tables by Jim Meyering. */
21 /* Implementation overview:
23 In the `usual' case RM saves no state for directories it is processing.
24 When a removal fails (either due to an error or to an interactive `no'
25 reply), the failure is noted (see descriptin of `ht' remove_cwd_entries)
26 so that when/if the containing directory is reopened, RM doesn't try to
27 remove the entry again.
29 RM may delete arbitrarily deep hierarchies -- even ones in which file
30 names (from root to leaf) are longer than the system-imposed maximum.
31 It does this by using chdir to change to each directory in turn before
32 removing the entries in that directory.
34 RM detects directory cycles by maintaining a table of the currently
35 active directories. See the description of active_dir_map below.
37 RM is careful to avoid forming full file names whenever possible.
38 A full file name is formed only when it is about to be used -- e.g.
39 in a diagnostic or in an interactive-mode prompt.
41 RM minimizes the number of lstat system calls it makes. On systems
42 that have valid d_type data in directory entries, RM makes only one
43 lstat call per command line argument -- regardless of the depth of
49 #include <sys/types.h>
59 # if defined (__GNUC__) || __STDC__
60 # define PARAMS(args) args
62 # define PARAMS(args) ()
66 #define obstack_chunk_alloc malloc
67 #define obstack_chunk_free free
69 #ifdef D_INO_IN_DIRENT
70 # define D_INO(dp) ((dp)->d_ino)
72 /* Some systems don't have inodes, so fake them to avoid lots of ifdefs. */
76 #if !defined (S_ISLNK)
77 # define S_ISLNK(Mode) 0
80 #define DOT_OR_DOTDOT(Basename) \
81 (Basename[0] == '.' && (Basename[1] == '\0' \
82 || (Basename[1] == '.' && Basename[2] == '\0')))
85 # define ASSIGN_STRDUPA(DEST, S) \
86 do { DEST = strdupa(S); } while (0)
88 # define ASSIGN_STRDUPA(DEST, S) \
91 size_t len_ = strlen (S) + 1; \
92 char *tmp_dest_ = alloca (len_); \
93 memcpy (tmp_dest_, (S), len_); \
101 /* These must be listed in order of increasing seriousness. */
107 #define VALID_STATUS(S) \
108 ((S) == RM_OK || (S) == RM_USER_DECLINED || (S) == RM_ERROR)
110 /* Initial capacity of per-directory hash table of entries that have
111 been processed but not been deleted. */
112 #define HT_INITIAL_CAPACITY 13
114 /* Initial capacity of the active directory hash table. This table will
115 be resized only for hierarchies more than about 45 levels deep. */
116 #define ACTIVE_DIR_INITIAL_CAPACITY 53
121 unsigned int have_filetype_mode:1;
122 unsigned int have_full_mode:1;
129 void strip_trailing_slashes ();
132 /* Forward dcl for recursively called function. */
133 static enum RM_status rm PARAMS ((struct File_spec *fs,
134 int user_specified_name));
136 /* Name this program was run with. */
139 /* If nonzero, display the name of each file removed. */
142 /* If nonzero, ignore nonexistant files. */
143 static int ignore_missing_files;
145 /* If nonzero, recursively remove directories. */
146 static int recursive;
148 /* If nonzero, query the user about whether to remove each file. */
149 static int interactive;
151 /* If nonzero, remove directories with unlink instead of rmdir, and don't
152 require a directory to be empty before trying to unlink it.
153 Only works for the super-user. */
154 static int unlink_dirs;
156 /* If nonzero, stdin is a tty. */
157 static int stdin_tty;
159 /* If nonzero, display usage information and exit. */
160 static int show_help;
162 /* If nonzero, print the version on standard output and exit. */
163 static int show_version;
165 /* The name of the directory (starting with and relative to a command
166 line argument) being processed. When a subdirectory is entered, a new
167 component is appended (pushed). When RM chdir's out of a directory,
168 the top component is removed (popped). This is used to form a full
169 file name when necessary. */
170 static struct obstack dir_stack;
172 /* Stack of lengths of directory names (including trailing slash)
173 appended to dir_stack. We have to have a separate stack of lengths
174 (rather than just popping back to previous slash) because the first
175 element pushed onto the dir stack may contain slashes. */
176 static struct obstack len_stack;
178 /* Set of `active' directories from the current command-line argument
179 to the level in the hierarchy at which files are being removed.
180 A directory is added to the active set when RM begins removing it
181 (or its entries), and it is removed from the set just after RM has
182 finished processing it.
184 This is actually a map (not a set), implemented with a hash table.
185 For each active directory, it maps the directory's inode number to the
186 depth of that directory relative to the root of the tree being deleted.
187 A directory specified on the command line has depth zero.
188 This construct is used to detect directory cycles so that RM can warn
189 about them rather than iterating endlessly. */
190 static struct HT *active_dir_map;
192 /* An entry in the active_dir_map. */
193 struct active_dir_ent
199 static struct option const long_opts[] =
201 {"directory", no_argument, &unlink_dirs, 1},
202 {"force", no_argument, NULL, 'f'},
203 {"interactive", no_argument, NULL, 'i'},
204 {"recursive", no_argument, &recursive, 1},
205 {"verbose", no_argument, &verbose, 1},
206 {"help", no_argument, &show_help, 1},
207 {"version", no_argument, &show_version, 1},
211 static inline unsigned int
214 return obstack_object_size (&len_stack) / sizeof (size_t);
218 print_nth_dir (FILE *stream, unsigned int depth)
220 size_t *length = (size_t *) obstack_base (&len_stack);
221 char *dir_name = (char *) obstack_base (&dir_stack);
222 unsigned int sum = 0;
225 assert (0 <= depth && depth < current_depth ());
227 for (i = 0; i <= depth; i++)
232 fwrite (dir_name, 1, sum, stream);
235 static inline struct active_dir_ent *
236 make_active_dir_ent (ino_t inum, unsigned int depth)
238 struct active_dir_ent *ent;
239 ent = (struct active_dir_ent *) xmalloc (sizeof *ent);
246 hash_active_dir_ent (void const *x, unsigned int table_size)
248 struct active_dir_ent const *ade = x;
249 return ade->inum % table_size;
253 hash_compare_active_dir_ents (void const *x, void const *y)
255 struct active_dir_ent const *a = x;
256 struct active_dir_ent const *b = y;
257 return (a->inum == b->inum ? 0 : 1);
260 /* A hash function for null-terminated char* strings using
261 the method described in Aho, Sethi, & Ullman, p 436. */
264 hash_pjw (const void *x, unsigned int tablesize)
273 if ((g = h & 0xf0000000U) != 0)
274 h = (h ^ (g >> 24)) ^ g;
277 return (h % tablesize);
281 hash_compare_strings (void const *x, void const *y)
283 return strcmp (x, y);
290 fprintf (stderr, _("Try `%s --help' for more information.\n"),
294 printf (_("Usage: %s [OPTION]... FILE...\n"), program_name);
296 Remove (unlink) the FILE(s).\n\
298 -d, --directory unlink directory, even if non-empty (super-user only)\n\
299 -f, --force ignore nonexistent files, never prompt\n\
300 -i, --interactive prompt before any removal\n\
301 -r, -R, --recursive remove the contents of directories recursively\n\
302 -v, --verbose explain what is being done\n\
303 --help display this help and exit\n\
304 --version output version information and exit\n\
306 puts (_("\nReport bugs to <fileutils-bugs@gnu.org>."));
312 push_dir (const char *dir_name)
316 len = strlen (dir_name);
318 /* Append the string onto the stack. */
319 obstack_grow (&dir_stack, dir_name, len);
321 /* Append a trailing slash. */
322 obstack_1grow (&dir_stack, '/');
324 /* Add one for the slash. */
327 /* Push the length (including slash) onto its stack. */
328 obstack_grow (&len_stack, &len, sizeof (len));
334 int n_lengths = obstack_object_size (&len_stack) / sizeof (size_t);
335 size_t *length = (size_t *) obstack_base (&len_stack);
338 assert (n_lengths > 0);
339 top_len = length[n_lengths - 1];
340 assert (top_len >= 2);
342 /* Pop off the specified length of pathname. */
343 assert (obstack_object_size (&dir_stack) >= top_len);
344 obstack_blank (&dir_stack, -top_len);
346 /* Pop the length stack, too. */
347 assert (obstack_object_size (&len_stack) >= sizeof (size_t));
348 obstack_blank (&len_stack, -(sizeof (size_t)));
351 /* Copy the SRC_LEN bytes of data beginning at SRC into the DST_LEN-byte
352 buffer, DST, so that the last source byte is at the end of the destination
353 buffer. If SRC_LEN is longer than DST_LEN, then set *TRUNCATED to non-zero.
354 Set *RESULT to point to the beginning of (the portion of) the source data
355 in DST. Return the number of bytes remaining in the destination buffer. */
358 right_justify (char *dst, size_t dst_len, const char *src, size_t src_len,
359 char **result, int *truncated)
364 if (src_len <= dst_len)
367 dp = dst + (dst_len - src_len);
372 sp = src + (src_len - dst_len);
378 memcpy (dp, sp, src_len);
381 return dst_len - src_len;
384 /* Using the global directory name obstack, create the full path to FILENAME.
385 Return it in sometimes-realloc'd space that should not be freed by the
386 caller. Realloc as necessary. If realloc fails, use a static buffer
387 and put as long a suffix in that buffer as possible. */
390 full_filename (const char *filename)
392 static char *buf = NULL;
393 static size_t n_allocated = 0;
395 int dir_len = obstack_object_size (&dir_stack);
396 char *dir_name = (char *) obstack_base (&dir_stack);
397 size_t n_bytes_needed;
400 filename_len = strlen (filename);
401 n_bytes_needed = dir_len + filename_len + 1;
403 if (n_bytes_needed > n_allocated)
405 /* This code requires that realloc accept NULL as the first arg.
406 This function must not use xrealloc. Otherwise, an out-of-memory
407 error involving a file name to be expanded here wouldn't ever
408 be issued. Use realloc and fall back on using a static buffer
409 if memory allocation fails. */
410 buf = realloc (buf, n_bytes_needed);
411 n_allocated = n_bytes_needed;
415 #define SBUF_SIZE 512
416 #define ELLIPSES_PREFIX "[...]"
417 static char static_buf[SBUF_SIZE];
422 len = right_justify (static_buf, SBUF_SIZE, filename,
423 filename_len + 1, &p, &truncated);
424 right_justify (static_buf, len, dir_name, dir_len, &p, &truncated);
427 memcpy (static_buf, ELLIPSES_PREFIX,
428 sizeof (ELLIPSES_PREFIX) - 1);
434 /* Copy directory part, including trailing slash. */
435 memcpy (buf, dir_name, dir_len);
437 /* Append filename part, including trailing zero byte. */
438 memcpy (buf + dir_len, filename, filename_len + 1);
440 assert (strlen (buf) + 1 == n_bytes_needed);
446 fspec_init_file (struct File_spec *fs, const char *filename)
448 fs->filename = (char *) filename;
449 fs->have_full_mode = 0;
450 fs->have_filetype_mode = 0;
454 fspec_init_dp (struct File_spec *fs, struct dirent *dp)
456 fs->filename = dp->d_name;
457 fs->have_full_mode = 0;
458 fs->have_filetype_mode = 0;
459 fs->inum = D_INO (dp);
461 #if D_TYPE_IN_DIRENT && defined (DT_UNKNOWN) && defined (DTTOIF)
462 if (dp->d_type != DT_UNKNOWN)
464 fs->have_filetype_mode = 1;
465 fs->mode = DTTOIF (dp->d_type);
471 fspec_get_full_mode (struct File_spec *fs, mode_t *full_mode)
473 struct stat stat_buf;
475 if (fs->have_full_mode)
477 *full_mode = fs->mode;
481 if (lstat (fs->filename, &stat_buf))
484 fs->have_full_mode = 1;
485 fs->have_filetype_mode = 1;
486 fs->mode = stat_buf.st_mode;
487 fs->inum = stat_buf.st_ino;
489 *full_mode = stat_buf.st_mode;
494 fspec_get_filetype_mode (struct File_spec *fs, mode_t *filetype_mode)
498 if (fs->have_filetype_mode)
500 *filetype_mode = fs->mode;
505 fail = fspec_get_full_mode (fs, filetype_mode);
512 fspec_filetype_mode (const struct File_spec *fs)
514 assert (fs->have_filetype_mode);
518 /* Recursively remove all of the entries in the current directory.
519 Return an indication of the success of the operation. */
522 remove_cwd_entries (void)
524 /* NOTE: this is static. */
525 static DIR *dirp = NULL;
527 /* NULL or a malloc'd and initialized hash table of entries in the
528 current directory that have been processed but not removed --
529 due either to an error or to an interactive `no' response. */
530 struct HT *ht = NULL;
532 enum RM_status status = RM_OK;
538 /* FIXME-someday: but this is actually the previously opened dir. */
539 error (0, errno, "%s", full_filename ("."));
547 /* FIXME: why do this? */
550 dirp = opendir (".");
553 if (errno != ENOENT || !ignore_missing_files)
555 error (0, errno, "%s", full_filename ("."));
565 enum RM_status tmp_status;
568 /* FILE should be skipped if it is `.' or `..', or if it is in
569 the table, HT, of entries we've already processed. */
570 #define SKIPPABLE(Ht, File) (DOT_OR_DOTDOT(File) \
571 || (Ht && hash_query_in_table (Ht, File)))
576 /* Since we have probably modified the directory since it
577 was opened, readdir returning NULL does not necessarily
578 mean we have read the last entry. Rewind it and check
579 again. This happens on SunOS4.1.4 with 254 or more files
582 while ((dp = readdir (dirp)) && SKIPPABLE (ht, dp->d_name))
591 if (SKIPPABLE (ht, dp->d_name))
594 fspec_init_dp (&fs, dp);
596 /* Save a copy of the name of this entry, in case we have
597 to add it to the set of unremoved entries below. */
598 ASSIGN_STRDUPA (entry_name, dp->d_name);
600 /* CAUTION: after this call to rm, DP may not be valid --
601 it may have been freed due to a close in a recursive call
602 (through rm and remove_dir) to this function. */
603 tmp_status = rm (&fs, 0);
606 if (tmp_status > status)
608 assert (VALID_STATUS (status));
610 /* If this entry was not removed (due either to an error or to
611 an interactive `no' response), record it in the hash table so
612 we don't consider it again if we reopen this directory later. */
619 ht = hash_initialize (HT_INITIAL_CAPACITY, NULL,
620 hash_pjw, hash_compare_strings);
622 error (1, 0, _("Memory exhausted"));
624 HASH_INSERT_NEW_ITEM (ht, entry_name, &fail);
626 error (1, 0, _("Memory exhausted"));
633 while (dirp == NULL);
637 error (0, errno, "%s", full_filename ("."));
650 /* Query the user if appropriate, and if ok try to remove the
651 file or directory specified by FS. Return RM_OK if it is removed,
652 and RM_ERROR or RM_USER_DECLINED if not. */
654 static enum RM_status
655 remove_file (struct File_spec *fs)
658 char *pathname = fs->filename;
660 if (!ignore_missing_files && (interactive || stdin_tty)
661 && euidaccess (pathname, W_OK) )
663 if (!S_ISLNK (fspec_filetype_mode (fs)))
666 (S_ISDIR (fspec_filetype_mode (fs))
667 ? _("%s: remove write-protected directory `%s'? ")
668 : _("%s: remove write-protected file `%s'? ")),
669 program_name, full_filename (pathname));
671 return RM_USER_DECLINED;
677 if (!asked && interactive)
680 (S_ISDIR (fspec_filetype_mode (fs))
681 ? _("%s: remove directory `%s'? ")
682 : _("%s: remove `%s'? ")),
683 program_name, full_filename (pathname));
685 return RM_USER_DECLINED;
689 printf ("%s\n", full_filename (pathname));
691 if (unlink (pathname) && (errno != ENOENT || !ignore_missing_files))
693 error (0, errno, _("cannot unlink `%s'"), full_filename (pathname));
699 /* If not in recursive mode, print an error message and return RM_ERROR.
700 Otherwise, query the user if appropriate, then try to recursively
701 remove the directory specified by FS. Return RM_OK if it is removed,
702 and RM_ERROR or RM_USER_DECLINED if not.
703 FIXME: describe need_save_cwd parameter. */
705 static enum RM_status
706 remove_dir (struct File_spec *fs, int need_save_cwd)
708 enum RM_status status;
709 struct saved_cwd cwd;
710 char *dir_name = fs->filename;
711 const char *fmt = NULL;
715 error (0, 0, _("%s: is a directory"), full_filename (dir_name));
719 if (!ignore_missing_files && (interactive || stdin_tty)
720 && euidaccess (dir_name, W_OK))
722 fmt = _("%s: directory `%s' is write protected; descend into it anyway? ");
724 else if (interactive)
726 fmt = _("%s: descend into directory `%s'? ");
731 fprintf (stderr, fmt, program_name, full_filename (dir_name));
733 return RM_USER_DECLINED;
737 printf ("%s\n", full_filename (dir_name));
739 /* Save cwd if needed. */
740 if (need_save_cwd && save_cwd (&cwd))
743 /* Make target directory the current one. */
744 if (chdir (dir_name) < 0)
746 error (0, errno, _("cannot change to directory %s"),
747 full_filename (dir_name));
755 /* Save a copy of dir_name. Otherwise, remove_cwd_entries may clobber
756 dir_name because dir_name is just a pointer to the dir entry's d_name
757 field, and remove_cwd_entries may close the directory. */
758 ASSIGN_STRDUPA (dir_name, dir_name);
760 status = remove_cwd_entries ();
767 if (restore_cwd (&cwd, NULL, NULL))
774 else if (chdir ("..") < 0)
776 error (0, errno, _("cannot change back to directory %s via `..'"),
777 full_filename (dir_name));
783 error (0, 0, _("remove directory `%s'%s? "), full_filename (dir_name),
784 (status != RM_OK ? _(" (might be nonempty)") : ""));
787 return RM_USER_DECLINED;
791 if (rmdir (dir_name) && (errno != ENOENT || !ignore_missing_files))
793 error (0, errno, _("cannot remove directory `%s'"),
794 full_filename (dir_name));
801 /* Remove the file or directory specified by FS after checking appropriate
802 things. Return RM_OK if it is removed, and RM_ERROR or RM_USER_DECLINED
803 if not. If USER_SPECIFIED_NAME is non-zero, then the name part of FS may
804 be `.', `..', or may contain slashes. Otherwise, it must be a simple file
805 name (and hence must specify a file in the current directory). */
807 static enum RM_status
808 rm (struct File_spec *fs, int user_specified_name)
810 mode_t filetype_mode;
812 if (user_specified_name)
814 char *base = base_name (fs->filename);
816 if (DOT_OR_DOTDOT (base))
818 error (0, 0, _("cannot remove `.' or `..'"));
823 if (fspec_get_filetype_mode (fs, &filetype_mode))
825 if (ignore_missing_files && errno == ENOENT)
828 error (0, errno, _("cannot remove `%s'"), full_filename (fs->filename));
832 if (S_ISDIR (filetype_mode))
835 struct active_dir_ent *old_ent;
837 /* Insert this directory in the active_dir_map.
838 If there is already a directory in the map with the same inum,
839 then there's *probably* a directory cycle. This test can get
840 a false positive if two directories have the same inode number
841 but different device numbers and one directory contains the
842 other. But since people don't often try to delete hierarchies
843 containing mount points, and when they do, duplicate inode
844 numbers are not that likely, this isn't worth detecting. */
845 old_ent = hash_insert_if_absent (active_dir_map,
846 make_active_dir_ent (fs->inum,
850 error (1, 0, _("Memory exhausted"));
855 WARNING: Circular directory structure.\n\
856 This almost certainly means that you have a corrupted file system.\n\
857 NOTIFY YOUR SYSTEM MANAGER.\n\
858 The following two directories have the same inode number:\n"));
859 /* FIXME: test this!! */
860 print_nth_dir (stderr, current_depth ());
861 fputc ('\n', stderr);
862 print_nth_dir (stderr, old_ent->depth);
863 fputc ('\n', stderr);
870 error (0, 0, _("continue? "));
878 if (!S_ISDIR (filetype_mode) || unlink_dirs)
880 return remove_file (fs);
884 int need_save_cwd = user_specified_name;
885 enum RM_status status;
886 struct active_dir_ent tmp;
887 struct active_dir_ent *old_ent;
890 need_save_cwd = (strchr (fs->filename, '/') != NULL);
892 status = remove_dir (fs, need_save_cwd);
894 /* Remove this directory from the active_dir_map. */
896 old_ent = hash_delete_if_present (active_dir_map, &tmp);
897 assert (old_ent != NULL);
905 main (int argc, char **argv)
910 program_name = argv[0];
911 setlocale (LC_ALL, "");
912 bindtextdomain (PACKAGE, LOCALEDIR);
913 textdomain (PACKAGE);
915 verbose = ignore_missing_files = recursive = interactive
918 while ((c = getopt_long (argc, argv, "dfirvR", long_opts, NULL)) != -1)
922 case 0: /* Long option. */
929 ignore_missing_files = 1;
933 ignore_missing_files = 0;
949 printf ("rm (%s) %s\n", GNU_PACKAGE, VERSION);
958 if (ignore_missing_files)
962 error (0, 0, _("too few arguments"));
967 stdin_tty = isatty (STDIN_FILENO);
969 /* Initialize dir-stack obstacks. */
970 obstack_init (&dir_stack);
971 obstack_init (&len_stack);
973 active_dir_map = hash_initialize (ACTIVE_DIR_INITIAL_CAPACITY, free,
975 hash_compare_active_dir_ents);
977 for (; optind < argc; optind++)
980 enum RM_status status;
982 /* Stripping slashes is harmless for rmdir;
983 if the arg is not a directory, it will fail with ENOTDIR. */
984 strip_trailing_slashes (argv[optind]);
985 fspec_init_file (&fs, argv[optind]);
986 status = rm (&fs, 1);
987 assert (VALID_STATUS (status));
988 if (status == RM_ERROR)
992 hash_free (active_dir_map);