1 /* File tree walker functions.
2 Copyright (C) 1996-2003, 2004 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 _XOPEN_SOURCE 500
30 #define HAVE_DIRENT_H 1
31 #define HAVE_SYS_PARAM_H 1
32 #define HAVE_DECL_STPCPY 1
33 #define HAVE_MEMPCPY 1
37 # define alloca __builtin_alloca
52 # define NAMLEN(dirent) _D_EXACT_NAMLEN (dirent)
56 # define NAMLEN(dirent) strlen ((dirent)->d_name)
58 # define dirent direct
59 # define NAMLEN(dirent) (dirent)->d_namlen
61 # include <sys/ndir.h>
79 #if HAVE_SYS_PARAM_H || defined _LIBC
80 # include <sys/param.h>
83 # include <include/sys/stat.h>
85 # include <sys/stat.h>
88 libc_hidden_proto(memset)
89 libc_hidden_proto(strchr)
90 libc_hidden_proto(strlen)
91 libc_hidden_proto(dirfd)
92 libc_hidden_proto(tsearch)
93 libc_hidden_proto(tfind)
94 libc_hidden_proto(tdestroy)
95 libc_hidden_proto(getcwd)
96 libc_hidden_proto(chdir)
97 libc_hidden_proto(fchdir)
98 libc_hidden_proto(mempcpy)
99 libc_hidden_proto(opendir)
100 #ifdef __UCLIBC_HAS_LFS__
101 libc_hidden_proto(readdir64)
102 libc_hidden_proto(lstat64)
103 libc_hidden_proto(stat64)
105 libc_hidden_proto(closedir)
106 libc_hidden_proto(stpcpy)
107 libc_hidden_proto(lstat)
108 libc_hidden_proto(stat)
110 #if ! _LIBC && !HAVE_DECL_STPCPY && !defined stpcpy
114 #if ! _LIBC && ! defined HAVE_MEMPCPY && ! defined mempcpy
115 /* Be CAREFUL that there are no side effects in N. */
116 # define mempcpy(D, S, N) ((void *) ((char *) memcpy (D, S, N) + (N)))
119 /* #define NDEBUG 1 */
124 # define __chdir chdir
126 # define __closedir closedir
128 # define __fchdir fchdir
131 # define __getcwd(P, N) xgetcwd ()
132 extern char *xgetcwd (void);
134 # define __getcwd getcwd
137 # define __mempcpy mempcpy
139 # define __opendir opendir
141 # ifndef __UCLIBC_HAS_LFS__
142 # define __readdir64 readdir
144 # define __readdir64 readdir64
147 # define __stpcpy stpcpy
149 # define __tdestroy tdestroy
151 # define __tfind tfind
153 # define __tsearch tsearch
154 # undef internal_function
155 # define internal_function /* empty */
156 # ifndef __UCLIBC_HAS_LFS__
158 # define dirent64 dirent
161 # define MAX(a, b) ((a) > (b) ? (a) : (b))
164 /* Arrange to make lstat calls go through the wrapper function
165 on systems with an lstat function that does not dereference symlinks
166 that are specified with a trailing slash. */
167 #if ! _LIBC && ! LSTAT_FOLLOWS_SLASHED_SYMLINK && !defined __UCLIBC__
168 int rpl_lstat (const char *, struct stat *);
170 # define lstat(Name, Stat_buf) rpl_lstat(Name, Stat_buf)
174 # define __set_errno(Val) errno = (Val)
177 /* Support for the LFS API version. */
179 # define FTW_NAME ftw
180 # define NFTW_NAME nftw
181 # define NFTW_OLD_NAME __old_nftw
182 # define NFTW_NEW_NAME __new_nftw
186 # define LXSTAT __lxstat
187 # define XSTAT __xstat
189 # define LXSTAT(V,f,sb) lstat (f,sb)
190 # define XSTAT(V,f,sb) stat (f,sb)
192 # define FTW_FUNC_T __ftw_func_t
193 # define NFTW_FUNC_T __nftw_func_t
196 /* We define PATH_MAX if the system does not provide a definition.
197 This does not artificially limit any operation. PATH_MAX is simply
198 used as a guesstimate for the expected maximal path length.
199 Buffers will be enlarged if necessary. */
201 # define PATH_MAX 1024
218 /* Array with pointers to open directory streams. */
219 struct dir_data **dirstreams;
223 /* Buffer containing name of currently processed object. */
227 /* Passed as fourth argument to `nftw' callback. The `base' member
228 tracks the content of the `dirbuf'. */
231 /* Flags passed to `nftw' function. 0 for `ftw'. */
234 /* Conversion array for flag values. It is the identity mapping for
235 `nftw' calls, otherwise it maps the values to those known by
239 /* Callback function. We always use the `nftw' form. */
242 /* Device of starting point. Needed for FTW_MOUNT. */
245 /* Data structure for keeping fingerprints of already processed
246 object. This is needed when not using FTW_PHYS. */
251 /* Internally we use the FTW_* constants used for `nftw'. When invoked
252 as `ftw', map each flag to the subset of values used by `ftw'. */
253 static const int nftw_arr[] =
255 FTW_F, FTW_D, FTW_DNR, FTW_NS, FTW_SL, FTW_DP, FTW_SLN
258 static const int ftw_arr[] =
260 FTW_F, FTW_D, FTW_DNR, FTW_NS, FTW_F, FTW_D, FTW_NS
264 /* Forward declarations of local functions. */
265 static int ftw_dir (struct ftw_data *data, struct STAT *st,
266 struct dir_data *old_dir) internal_function;
270 object_compare (const void *p1, const void *p2)
272 /* We don't need a sophisticated and useful comparison. We are only
273 interested in equality. However, we must be careful not to
274 accidentally compare `holes' in the structure. */
275 const struct known_object *kp1 = p1, *kp2 = p2;
277 cmp1 = (kp1->ino > kp2->ino) - (kp1->ino < kp2->ino);
280 return (kp1->dev > kp2->dev) - (kp1->dev < kp2->dev);
285 add_object (struct ftw_data *data, struct STAT *st)
287 struct known_object *newp = malloc (sizeof (struct known_object));
290 newp->dev = st->st_dev;
291 newp->ino = st->st_ino;
292 return __tsearch (newp, &data->known_objects, object_compare) ? 0 : -1;
297 find_object (struct ftw_data *data, struct STAT *st)
299 struct known_object obj;
300 obj.dev = st->st_dev;
301 obj.ino = st->st_ino;
302 return __tfind (&obj, &data->known_objects, object_compare) != NULL;
307 __attribute ((always_inline))
308 open_dir_stream (struct ftw_data *data, struct dir_data *dirp)
312 if (data->dirstreams[data->actdir] != NULL)
314 /* Oh, oh. We must close this stream. Get all remaining
315 entries and store them as a list in the `content' member of
316 the `struct dir_data' variable. */
317 size_t bufsize = 1024;
318 char *buf = malloc (bufsize);
324 DIR *st = data->dirstreams[data->actdir]->stream;
328 while ((d = __readdir64 (st)) != NULL)
330 size_t this_len = NAMLEN (d);
331 if (actsize + this_len + 2 >= bufsize)
334 bufsize += MAX (1024, 2 * this_len);
335 newp = (char *) realloc (buf, bufsize);
338 /* No more memory. */
339 int save_err = errno;
341 __set_errno (save_err);
348 *((char *) __mempcpy (buf + actsize, d->d_name, this_len))
350 actsize += this_len + 1;
353 /* Terminate the list with an additional NUL byte. */
354 buf[actsize++] = '\0';
356 /* Shrink the buffer to what we actually need. */
357 data->dirstreams[data->actdir]->content = realloc (buf, actsize);
358 if (data->dirstreams[data->actdir]->content == NULL)
360 int save_err = errno;
362 __set_errno (save_err);
368 data->dirstreams[data->actdir]->stream = NULL;
369 data->dirstreams[data->actdir] = NULL;
374 /* Open the new stream. */
377 const char *name = ((data->flags & FTW_CHDIR)
378 ? data->dirbuf + data->ftw.base: data->dirbuf);
379 assert (data->dirstreams[data->actdir] == NULL);
381 dirp->stream = __opendir (name);
382 if (dirp->stream == NULL)
386 dirp->content = NULL;
387 data->dirstreams[data->actdir] = dirp;
389 if (++data->actdir == data->maxdir)
400 process_entry (struct ftw_data *data, struct dir_data *dir, const char *name,
408 if (name[0] == '.' && (name[1] == '\0'
409 || (name[1] == '.' && name[2] == '\0')))
410 /* Don't process the "." and ".." entries. */
413 new_buflen = data->ftw.base + namlen + 2;
414 if (data->dirbufsize < new_buflen)
416 /* Enlarge the buffer. */
419 data->dirbufsize = 2 * new_buflen;
420 newp = (char *) realloc (data->dirbuf, data->dirbufsize);
426 *((char *) __mempcpy (data->dirbuf + data->ftw.base, name, namlen)) = '\0';
428 if ((data->flags & FTW_CHDIR) == 0)
431 if (((data->flags & FTW_PHYS)
432 ? LXSTAT (_STAT_VER, name, &st)
433 : XSTAT (_STAT_VER, name, &st)) < 0)
435 if (errno != EACCES && errno != ENOENT)
437 else if (!(data->flags & FTW_PHYS)
438 && LXSTAT (_STAT_VER, name, &st) == 0
439 && S_ISLNK (st.st_mode))
446 if (S_ISDIR (st.st_mode))
448 else if (S_ISLNK (st.st_mode))
456 || !(data->flags & FTW_MOUNT) || st.st_dev == data->dev))
460 if ((data->flags & FTW_PHYS)
461 || (!find_object (data, &st)
462 /* Remember the object. */
463 && (result = add_object (data, &st)) == 0))
464 result = ftw_dir (data, &st, dir);
467 result = (*data->func) (data->dirbuf, &st, data->cvt_arr[flag],
471 if ((data->flags & FTW_ACTIONRETVAL) && result == FTW_SKIP_SUBTREE)
479 __attribute ((noinline))
481 ftw_dir (struct ftw_data *data, struct STAT *st, struct dir_data *old_dir)
485 int previous_base = data->ftw.base;
489 /* Open the stream for this directory. This might require that
490 another stream has to be closed. */
491 result = open_dir_stream (data, &dir);
495 /* We cannot read the directory. Signal this with a special flag. */
496 result = (*data->func) (data->dirbuf, st, FTW_DNR, &data->ftw);
501 /* First, report the directory (if not depth-first). */
502 if (!(data->flags & FTW_DEPTH))
504 result = (*data->func) (data->dirbuf, st, FTW_D, &data->ftw);
510 __closedir (dir.stream);
511 __set_errno (save_err);
513 if (data->actdir-- == 0)
514 data->actdir = data->maxdir - 1;
515 data->dirstreams[data->actdir] = NULL;
520 /* If necessary, change to this directory. */
521 if (data->flags & FTW_CHDIR)
523 if (__fchdir (dirfd (dir.stream)) < 0)
530 /* Next, update the `struct FTW' information. */
532 startp = strchr (data->dirbuf, '\0');
533 /* There always must be a directory name. */
534 assert (startp != data->dirbuf);
535 if (startp[-1] != '/')
537 data->ftw.base = startp - data->dirbuf;
539 while (dir.stream != NULL && (d = __readdir64 (dir.stream)) != NULL)
541 result = process_entry (data, &dir, d->d_name, NAMLEN (d));
546 if (dir.stream != NULL)
548 /* The stream is still open. I.e., we did not need more
549 descriptors. Simply close the stream now. */
550 int save_err = errno;
552 assert (dir.content == NULL);
554 __closedir (dir.stream);
555 __set_errno (save_err);
557 if (data->actdir-- == 0)
558 data->actdir = data->maxdir - 1;
559 data->dirstreams[data->actdir] = NULL;
564 char *runp = dir.content;
566 while (result == 0 && *runp != '\0')
568 char *endp = strchr (runp, '\0');
570 result = process_entry (data, &dir, runp, endp - runp);
577 __set_errno (save_err);
580 if ((data->flags & FTW_ACTIONRETVAL) && result == FTW_SKIP_SIBLINGS)
583 /* Prepare the return, revert the `struct FTW' information. */
584 data->dirbuf[data->ftw.base - 1] = '\0';
586 data->ftw.base = previous_base;
588 /* Finally, if we process depth-first report the directory. */
589 if (result == 0 && (data->flags & FTW_DEPTH))
590 result = (*data->func) (data->dirbuf, st, FTW_DP, &data->ftw);
593 && (data->flags & FTW_CHDIR)
595 || ((data->flags & FTW_ACTIONRETVAL)
596 && (result != -1 && result != FTW_STOP))))
598 /* Change back to the parent directory. */
600 if (old_dir->stream != NULL)
601 if (__fchdir (dirfd (old_dir->stream)) == 0)
606 if (data->ftw.base == 1)
608 if (__chdir ("/") < 0)
612 if (__chdir ("..") < 0)
622 __attribute ((noinline))
624 ftw_startup (const char *dir, int is_nftw, void *func, int descriptors,
627 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 /* GNU extension ahead. */
686 cwd = __getcwd (NULL, 0);
689 else if (data.ftw.base > 0)
691 /* Change to the directory the file is in. In data.dirbuf
692 we have a writable copy of the file name. Just NUL
693 terminate it for now and change the directory. */
694 if (data.ftw.base == 1)
695 /* I.e., the file is in the root directory. */
696 result = __chdir ("/");
699 char ch = data.dirbuf[data.ftw.base - 1];
700 data.dirbuf[data.ftw.base - 1] = '\0';
701 result = __chdir (data.dirbuf);
702 data.dirbuf[data.ftw.base - 1] = ch;
707 /* Get stat info for start directory. */
710 const char *name = ((data.flags & FTW_CHDIR)
711 ? data.dirbuf + data.ftw.base
714 if (((flags & FTW_PHYS)
715 ? LXSTAT (_STAT_VER, name, &st)
716 : XSTAT (_STAT_VER, name, &st)) < 0)
718 if (!(flags & FTW_PHYS)
720 && LXSTAT (_STAT_VER, name, &st) == 0
721 && S_ISLNK (st.st_mode))
722 result = (*data.func) (data.dirbuf, &st, data.cvt_arr[FTW_SLN],
725 /* No need to call the callback since we cannot say anything
731 if (S_ISDIR (st.st_mode))
733 /* Remember the device of the initial directory in case
734 FTW_MOUNT is given. */
735 data.dev = st.st_dev;
737 /* We know this directory now. */
738 if (!(flags & FTW_PHYS))
739 result = add_object (&data, &st);
742 result = ftw_dir (&data, &st, NULL);
746 int flag = S_ISLNK (st.st_mode) ? FTW_SL : FTW_F;
748 result = (*data.func) (data.dirbuf, &st, data.cvt_arr[flag],
753 if ((flags & FTW_ACTIONRETVAL)
754 && (result == FTW_SKIP_SUBTREE || result == FTW_SKIP_SIBLINGS))
758 /* Return to the start directory (if necessary). */
761 int save_err = errno;
764 __set_errno (save_err);
767 /* Free all memory. */
769 __tdestroy (data.known_objects, free);
771 __set_errno (save_err);
781 FTW_NAME (path, func, descriptors)
786 return ftw_startup (path, 0, func, descriptors, 0);
791 NFTW_NAME (path, func, descriptors, flags)
797 return ftw_startup (path, 1, func, descriptors, flags);
801 #include <shlib-compat.h>
803 int NFTW_NEW_NAME (const char *, NFTW_FUNC_T, int, int);
806 NFTW_NEW_NAME (path, func, descriptors, flags)
813 & ~(FTW_PHYS | FTW_MOUNT | FTW_CHDIR | FTW_DEPTH | FTW_ACTIONRETVAL))
815 __set_errno (EINVAL);
818 return ftw_startup (path, 1, func, descriptors, flags);
821 versioned_symbol (libc, NFTW_NEW_NAME, NFTW_NAME, GLIBC_2_3_3);
823 #if SHLIB_COMPAT(libc, GLIBC_2_1, GLIBC_2_3_3)
825 /* Older nftw* version just ignored all unknown flags. */
827 int NFTW_OLD_NAME (const char *, NFTW_FUNC_T, int, int);
830 attribute_compat_text_section
831 NFTW_OLD_NAME (path, func, descriptors, flags)
837 flags &= (FTW_PHYS | FTW_MOUNT | FTW_CHDIR | FTW_DEPTH);
838 return ftw_startup (path, 1, func, descriptors, flags);
841 compat_symbol (libc, NFTW_OLD_NAME, NFTW_NAME, GLIBC_2_1);