1 /* File tree walker functions.
2 Copyright (C) 1996-2003, 2004, 2006 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4 Contributed by Ulrich Drepper <drepper@cygnus.com>, 1996.
6 The GNU C Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Lesser General Public
8 License as published by the Free Software Foundation; either
9 version 2.1 of the License, or (at your option) any later version.
11 The GNU C Library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with the GNU C Library; if not, write to the Free
18 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26 # define alloca __builtin_alloca
41 # define NAMLEN(dirent) _D_EXACT_NAMLEN (dirent)
45 # define NAMLEN(dirent) strlen ((dirent)->d_name)
47 # define dirent direct
48 # define NAMLEN(dirent) (dirent)->d_namlen
50 # include <sys/ndir.h>
69 #include <not-cancel.h>
70 #if HAVE_SYS_PARAM_H || defined _LIBC
71 # include <sys/param.h>
74 # include <include/sys/stat.h>
76 # include <sys/stat.h>
79 #if ! _LIBC && !HAVE_DECL_STPCPY && !defined stpcpy
83 #if ! _LIBC && ! defined HAVE_MEMPCPY && ! defined mempcpy
84 /* Be CAREFUL that there are no side effects in N. */
85 # define mempcpy(D, S, N) ((void *) ((char *) memcpy (D, S, N) + (N)))
88 /* #define NDEBUG 1 */
93 # define __chdir chdir
95 # define __closedir closedir
97 # define __fchdir fchdir
99 # define __getcwd(P, N) xgetcwd ()
100 extern char *xgetcwd (void);
102 # define __mempcpy mempcpy
104 # define __opendir opendir
106 # define __readdir64 readdir
108 # define __stpcpy stpcpy
110 # define __tdestroy tdestroy
112 # define __tfind tfind
114 # define __tsearch tsearch
115 # undef internal_function
116 # define internal_function /* empty */
118 # define dirent64 dirent
120 # define MAX(a, b) ((a) > (b) ? (a) : (b))
123 /* Arrange to make lstat calls go through the wrapper function
124 on systems with an lstat function that does not dereference symlinks
125 that are specified with a trailing slash. */
126 #if ! _LIBC && ! LSTAT_FOLLOWS_SLASHED_SYMLINK
127 int rpl_lstat (const char *, struct stat *);
129 # define lstat(Name, Stat_buf) rpl_lstat(Name, Stat_buf)
133 # define __set_errno(Val) errno = (Val)
136 /* Support for the LFS API version. */
138 # define FTW_NAME ftw
139 # define NFTW_NAME nftw
140 # define NFTW_OLD_NAME __old_nftw
141 # define NFTW_NEW_NAME __new_nftw
145 # define LXSTAT __lxstat
146 # define XSTAT __xstat
147 # define FXSTATAT __fxstatat
149 # define LXSTAT(V,f,sb) lstat (f,sb)
150 # define XSTAT(V,f,sb) stat (f,sb)
151 # define FXSTATAT(V,d,f,sb,m) fstatat (d, f, sb, m)
153 # define FTW_FUNC_T __ftw_func_t
154 # define NFTW_FUNC_T __nftw_func_t
157 /* We define PATH_MAX if the system does not provide a definition.
158 This does not artificially limit any operation. PATH_MAX is simply
159 used as a guesstimate for the expected maximal path length.
160 Buffers will be enlarged if necessary. */
162 # define PATH_MAX 1024
180 /* Array with pointers to open directory streams. */
181 struct dir_data **dirstreams;
185 /* Buffer containing name of currently processed object. */
189 /* Passed as fourth argument to `nftw' callback. The `base' member
190 tracks the content of the `dirbuf'. */
193 /* Flags passed to `nftw' function. 0 for `ftw'. */
196 /* Conversion array for flag values. It is the identity mapping for
197 `nftw' calls, otherwise it maps the values to those known by
201 /* Callback function. We always use the `nftw' form. */
204 /* Device of starting point. Needed for FTW_MOUNT. */
207 /* Data structure for keeping fingerprints of already processed
208 object. This is needed when not using FTW_PHYS. */
213 /* Internally we use the FTW_* constants used for `nftw'. When invoked
214 as `ftw', map each flag to the subset of values used by `ftw'. */
215 static const int nftw_arr[] =
217 FTW_F, FTW_D, FTW_DNR, FTW_NS, FTW_SL, FTW_DP, FTW_SLN
220 static const int ftw_arr[] =
222 FTW_F, FTW_D, FTW_DNR, FTW_NS, FTW_F, FTW_D, FTW_NS
226 /* Forward declarations of local functions. */
227 static int ftw_dir (struct ftw_data *data, struct STAT *st,
228 struct dir_data *old_dir) internal_function;
232 object_compare (const void *p1, const void *p2)
234 /* We don't need a sophisticated and useful comparison. We are only
235 interested in equality. However, we must be careful not to
236 accidentally compare `holes' in the structure. */
237 const struct known_object *kp1 = p1, *kp2 = p2;
239 cmp1 = (kp1->ino > kp2->ino) - (kp1->ino < kp2->ino);
242 return (kp1->dev > kp2->dev) - (kp1->dev < kp2->dev);
247 add_object (struct ftw_data *data, struct STAT *st)
249 struct known_object *newp = malloc (sizeof (struct known_object));
252 newp->dev = st->st_dev;
253 newp->ino = st->st_ino;
254 return __tsearch (newp, &data->known_objects, object_compare) ? 0 : -1;
259 find_object (struct ftw_data *data, struct STAT *st)
261 struct known_object obj;
262 obj.dev = st->st_dev;
263 obj.ino = st->st_ino;
264 return __tfind (&obj, &data->known_objects, object_compare) != NULL;
269 __attribute ((always_inline))
270 open_dir_stream (int *dfdp, struct ftw_data *data, struct dir_data *dirp)
274 if (data->dirstreams[data->actdir] != NULL)
276 /* Oh, oh. We must close this stream. Get all remaining
277 entries and store them as a list in the `content' member of
278 the `struct dir_data' variable. */
279 size_t bufsize = 1024;
280 char *buf = malloc (bufsize);
286 DIR *st = data->dirstreams[data->actdir]->stream;
290 while ((d = __readdir64 (st)) != NULL)
292 size_t this_len = NAMLEN (d);
293 if (actsize + this_len + 2 >= bufsize)
296 bufsize += MAX (1024, 2 * this_len);
297 newp = (char *) realloc (buf, bufsize);
300 /* No more memory. */
301 int save_err = errno;
303 __set_errno (save_err);
310 *((char *) __mempcpy (buf + actsize, d->d_name, this_len))
312 actsize += this_len + 1;
315 /* Terminate the list with an additional NUL byte. */
316 buf[actsize++] = '\0';
318 /* Shrink the buffer to what we actually need. */
319 data->dirstreams[data->actdir]->content = realloc (buf, actsize);
320 if (data->dirstreams[data->actdir]->content == NULL)
322 int save_err = errno;
324 __set_errno (save_err);
330 data->dirstreams[data->actdir]->stream = NULL;
331 data->dirstreams[data->actdir]->streamfd = -1;
332 data->dirstreams[data->actdir] = NULL;
337 /* Open the new stream. */
340 assert (data->dirstreams[data->actdir] == NULL);
342 if (dfdp != NULL && *dfdp != -1)
344 int fd = openat64_not_cancel_3 (*dfdp, data->dirbuf + data->ftw.base,
345 O_RDONLY | O_DIRECTORY | O_NDELAY);
347 if (fd != -1 && (dirp->stream = __fdopendir (fd)) == NULL)
348 close_not_cancel_no_status (fd);
352 const char *name = ((data->flags & FTW_CHDIR)
353 ? data->dirbuf + data->ftw.base: data->dirbuf);
354 dirp->stream = __opendir (name);
357 if (dirp->stream == NULL)
361 dirp->streamfd = dirfd (dirp->stream);
362 dirp->content = NULL;
363 data->dirstreams[data->actdir] = dirp;
365 if (++data->actdir == data->maxdir)
376 process_entry (struct ftw_data *data, struct dir_data *dir, const char *name,
377 size_t namlen, int d_type)
384 if (name[0] == '.' && (name[1] == '\0'
385 || (name[1] == '.' && name[2] == '\0')))
386 /* Don't process the "." and ".." entries. */
389 new_buflen = data->ftw.base + namlen + 2;
390 if (data->dirbufsize < new_buflen)
392 /* Enlarge the buffer. */
395 data->dirbufsize = 2 * new_buflen;
396 newp = (char *) realloc (data->dirbuf, data->dirbufsize);
402 *((char *) __mempcpy (data->dirbuf + data->ftw.base, name, namlen)) = '\0';
405 if (dir->streamfd != -1)
406 statres = FXSTATAT (_STAT_VER, dir->streamfd, name, &st,
407 (data->flags & FTW_PHYS) ? AT_SYMLINK_NOFOLLOW : 0);
410 if ((data->flags & FTW_CHDIR) == 0)
413 statres = ((data->flags & FTW_PHYS)
414 ? LXSTAT (_STAT_VER, name, &st)
415 : XSTAT (_STAT_VER, name, &st));
420 if (errno != EACCES && errno != ENOENT)
422 else if (data->flags & FTW_PHYS)
424 else if (d_type == DT_LNK)
428 if (dir->streamfd != -1)
429 statres = FXSTATAT (_STAT_VER, dir->streamfd, name, &st,
430 AT_SYMLINK_NOFOLLOW);
432 statres = LXSTAT (_STAT_VER, name, &st);
433 if (statres == 0 && S_ISLNK (st.st_mode))
441 if (S_ISDIR (st.st_mode))
443 else if (S_ISLNK (st.st_mode))
451 || !(data->flags & FTW_MOUNT) || st.st_dev == data->dev))
455 if ((data->flags & FTW_PHYS)
456 || (!find_object (data, &st)
457 /* Remember the object. */
458 && (result = add_object (data, &st)) == 0))
459 result = ftw_dir (data, &st, dir);
462 result = (*data->func) (data->dirbuf, &st, data->cvt_arr[flag],
466 if ((data->flags & FTW_ACTIONRETVAL) && result == FTW_SKIP_SUBTREE)
474 __attribute ((noinline))
476 ftw_dir (struct ftw_data *data, struct STAT *st, struct dir_data *old_dir)
480 int previous_base = data->ftw.base;
484 /* Open the stream for this directory. This might require that
485 another stream has to be closed. */
486 result = open_dir_stream (old_dir == NULL ? NULL : &old_dir->streamfd,
491 /* We cannot read the directory. Signal this with a special flag. */
492 result = (*data->func) (data->dirbuf, st, FTW_DNR, &data->ftw);
497 /* First, report the directory (if not depth-first). */
498 if (!(data->flags & FTW_DEPTH))
500 result = (*data->func) (data->dirbuf, st, FTW_D, &data->ftw);
506 __closedir (dir.stream);
508 __set_errno (save_err);
510 if (data->actdir-- == 0)
511 data->actdir = data->maxdir - 1;
512 data->dirstreams[data->actdir] = NULL;
517 /* If necessary, change to this directory. */
518 if (data->flags & FTW_CHDIR)
520 if (__fchdir (dirfd (dir.stream)) < 0)
527 /* Next, update the `struct FTW' information. */
529 startp = __rawmemchr (data->dirbuf, '\0');
530 /* There always must be a directory name. */
531 assert (startp != data->dirbuf);
532 if (startp[-1] != '/')
534 data->ftw.base = startp - data->dirbuf;
536 while (dir.stream != NULL && (d = __readdir64 (dir.stream)) != NULL)
538 result = process_entry (data, &dir, d->d_name, NAMLEN (d), d->d_type);
543 if (dir.stream != NULL)
545 /* The stream is still open. I.e., we did not need more
546 descriptors. Simply close the stream now. */
547 int save_err = errno;
549 assert (dir.content == NULL);
551 __closedir (dir.stream);
553 __set_errno (save_err);
555 if (data->actdir-- == 0)
556 data->actdir = data->maxdir - 1;
557 data->dirstreams[data->actdir] = NULL;
562 char *runp = dir.content;
564 while (result == 0 && *runp != '\0')
566 char *endp = strchr (runp, '\0');
568 // XXX Should store the d_type values as well?!
569 result = process_entry (data, &dir, runp, endp - runp, DT_UNKNOWN);
576 __set_errno (save_err);
579 if ((data->flags & FTW_ACTIONRETVAL) && result == FTW_SKIP_SIBLINGS)
582 /* Prepare the return, revert the `struct FTW' information. */
583 data->dirbuf[data->ftw.base - 1] = '\0';
585 data->ftw.base = previous_base;
587 /* Finally, if we process depth-first report the directory. */
588 if (result == 0 && (data->flags & FTW_DEPTH))
589 result = (*data->func) (data->dirbuf, st, FTW_DP, &data->ftw);
592 && (data->flags & FTW_CHDIR)
594 || ((data->flags & FTW_ACTIONRETVAL)
595 && (result != -1 && result != FTW_STOP))))
597 /* Change back to the parent directory. */
599 if (old_dir->stream != NULL)
600 if (__fchdir (dirfd (old_dir->stream)) == 0)
605 if (data->ftw.base == 1)
607 if (__chdir ("/") < 0)
611 if (__chdir ("..") < 0)
621 __attribute ((noinline))
623 ftw_startup (const char *dir, int is_nftw, void *func, int descriptors,
626 struct ftw_data data;
634 /* First make sure the parameters are reasonable. */
637 __set_errno (ENOENT);
641 data.maxdir = descriptors < 1 ? 1 : descriptors;
643 data.dirstreams = (struct dir_data **) alloca (data.maxdir
644 * sizeof (struct dir_data *));
645 memset (data.dirstreams, '\0', data.maxdir * sizeof (struct dir_data *));
647 /* PATH_MAX is always defined when we get here. */
648 data.dirbufsize = MAX (2 * strlen (dir), PATH_MAX);
649 data.dirbuf = (char *) malloc (data.dirbufsize);
650 if (data.dirbuf == NULL)
652 cp = __stpcpy (data.dirbuf, dir);
653 /* Strip trailing slashes. */
654 while (cp > data.dirbuf + 1 && cp[-1] == '/')
661 while (cp > data.dirbuf && cp[-1] != '/')
663 data.ftw.base = cp - data.dirbuf;
667 /* This assignment might seem to be strange but it is what we want.
668 The trick is that the first three arguments to the `ftw' and
669 `nftw' callback functions are equal. Therefore we can call in
670 every case the callback using the format of the `nftw' version
671 and get the correct result since the stack layout for a function
672 call in C allows this. */
673 data.func = (NFTW_FUNC_T) func;
675 /* Since we internally use the complete set of FTW_* values we need
676 to reduce the value range before calling a `ftw' callback. */
677 data.cvt_arr = is_nftw ? nftw_arr : ftw_arr;
679 /* No object known so far. */
680 data.known_objects = NULL;
682 /* Now go to the directory containing the initial file/directory. */
683 if (flags & FTW_CHDIR)
685 /* We have to be able to go back to the current working
686 directory. The best way to do this is to use a file
688 cwdfd = __open (".", O_RDONLY | O_DIRECTORY);
691 /* Try getting the directory name. This can be needed if
692 the current directory is executable but not readable. */
694 /* GNU extension ahead. */
695 cwd = __getcwd (NULL, 0);
700 else if (data.maxdir > 1)
701 /* Account for the file descriptor we use here. */
704 if (data.ftw.base > 0)
706 /* Change to the directory the file is in. In data.dirbuf
707 we have a writable copy of the file name. Just NUL
708 terminate it for now and change the directory. */
709 if (data.ftw.base == 1)
710 /* I.e., the file is in the root directory. */
711 result = __chdir ("/");
714 char ch = data.dirbuf[data.ftw.base - 1];
715 data.dirbuf[data.ftw.base - 1] = '\0';
716 result = __chdir (data.dirbuf);
717 data.dirbuf[data.ftw.base - 1] = ch;
722 /* Get stat info for start directory. */
725 const char *name = ((data.flags & FTW_CHDIR)
726 ? data.dirbuf + data.ftw.base
729 if (((flags & FTW_PHYS)
730 ? LXSTAT (_STAT_VER, name, &st)
731 : XSTAT (_STAT_VER, name, &st)) < 0)
733 if (!(flags & FTW_PHYS)
735 && LXSTAT (_STAT_VER, name, &st) == 0
736 && S_ISLNK (st.st_mode))
737 result = (*data.func) (data.dirbuf, &st, data.cvt_arr[FTW_SLN],
740 /* No need to call the callback since we cannot say anything
746 if (S_ISDIR (st.st_mode))
748 /* Remember the device of the initial directory in case
749 FTW_MOUNT is given. */
750 data.dev = st.st_dev;
752 /* We know this directory now. */
753 if (!(flags & FTW_PHYS))
754 result = add_object (&data, &st);
757 result = ftw_dir (&data, &st, NULL);
761 int flag = S_ISLNK (st.st_mode) ? FTW_SL : FTW_F;
763 result = (*data.func) (data.dirbuf, &st, data.cvt_arr[flag],
768 if ((flags & FTW_ACTIONRETVAL)
769 && (result == FTW_SKIP_SUBTREE || result == FTW_SKIP_SIBLINGS))
773 /* Return to the start directory (if necessary). */
776 int save_err = errno;
778 __set_errno (save_err);
780 else if (cwd != NULL)
782 int save_err = errno;
785 __set_errno (save_err);
788 /* Free all memory. */
791 __tdestroy (data.known_objects, free);
793 __set_errno (save_err);
803 FTW_NAME (path, func, descriptors)
808 return ftw_startup (path, 0, func, descriptors, 0);
813 NFTW_NAME (path, func, descriptors, flags)
819 return ftw_startup (path, 1, func, descriptors, flags);
823 # include <shlib-compat.h>
825 int NFTW_NEW_NAME (const char *, NFTW_FUNC_T, int, int);
828 NFTW_NEW_NAME (path, func, descriptors, flags)
835 & ~(FTW_PHYS | FTW_MOUNT | FTW_CHDIR | FTW_DEPTH | FTW_ACTIONRETVAL))
837 __set_errno (EINVAL);
840 return ftw_startup (path, 1, func, descriptors, flags);
843 versioned_symbol (libc, NFTW_NEW_NAME, NFTW_NAME, GLIBC_2_3_3);
845 # if SHLIB_COMPAT(libc, GLIBC_2_1, GLIBC_2_3_3)
847 /* Older nftw* version just ignored all unknown flags. */
849 int NFTW_OLD_NAME (const char *, NFTW_FUNC_T, int, int);
852 attribute_compat_text_section
853 NFTW_OLD_NAME (path, func, descriptors, flags)
859 flags &= (FTW_PHYS | FTW_MOUNT | FTW_CHDIR | FTW_DEPTH);
860 return ftw_startup (path, 1, func, descriptors, flags);
863 compat_symbol (libc, NFTW_OLD_NAME, NFTW_NAME, GLIBC_2_1);