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 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>
68 #if HAVE_SYS_PARAM_H || defined _LIBC
69 # include <sys/param.h>
72 # include <include/sys/stat.h>
74 # include <sys/stat.h>
77 #if ! _LIBC && !HAVE_DECL_STPCPY && !defined stpcpy
81 #if ! _LIBC && ! defined HAVE_MEMPCPY && ! defined mempcpy
82 /* Be CAREFUL that there are no side effects in N. */
83 # define mempcpy(D, S, N) ((void *) ((char *) memcpy (D, S, N) + (N)))
86 /* #define NDEBUG 1 */
91 # define __chdir chdir
93 # define __closedir closedir
95 # define __fchdir fchdir
97 # define __getcwd(P, N) xgetcwd ()
98 extern char *xgetcwd (void);
100 # define __mempcpy mempcpy
102 # define __opendir opendir
104 # define __readdir64 readdir
106 # define __stpcpy stpcpy
108 # define __tdestroy tdestroy
110 # define __tfind tfind
112 # define __tsearch tsearch
113 # undef internal_function
114 # define internal_function /* empty */
116 # define dirent64 dirent
118 # define MAX(a, b) ((a) > (b) ? (a) : (b))
121 /* Arrange to make lstat calls go through the wrapper function
122 on systems with an lstat function that does not dereference symlinks
123 that are specified with a trailing slash. */
124 #if ! _LIBC && ! LSTAT_FOLLOWS_SLASHED_SYMLINK
125 int rpl_lstat (const char *, struct stat
*);
127 # define lstat(Name, Stat_buf) rpl_lstat(Name, Stat_buf)
131 # define __set_errno(Val) errno = (Val)
134 /* Support for the LFS API version. */
136 # define FTW_NAME ftw
137 # define NFTW_NAME nftw
138 # define NFTW_OLD_NAME __old_nftw
139 # define NFTW_NEW_NAME __new_nftw
143 # define LXSTAT __lxstat
144 # define XSTAT __xstat
146 # define LXSTAT(V,f,sb) lstat (f,sb)
147 # define XSTAT(V,f,sb) stat (f,sb)
149 # define FTW_FUNC_T __ftw_func_t
150 # define NFTW_FUNC_T __nftw_func_t
153 /* We define PATH_MAX if the system does not provide a definition.
154 This does not artificially limit any operation. PATH_MAX is simply
155 used as a guesstimate for the expected maximal path length.
156 Buffers will be enlarged if necessary. */
158 # define PATH_MAX 1024
175 /* Array with pointers to open directory streams. */
176 struct dir_data
**dirstreams
;
180 /* Buffer containing name of currently processed object. */
184 /* Passed as fourth argument to `nftw' callback. The `base' member
185 tracks the content of the `dirbuf'. */
188 /* Flags passed to `nftw' function. 0 for `ftw'. */
191 /* Conversion array for flag values. It is the identity mapping for
192 `nftw' calls, otherwise it maps the values to those known by
196 /* Callback function. We always use the `nftw' form. */
199 /* Device of starting point. Needed for FTW_MOUNT. */
202 /* Data structure for keeping fingerprints of already processed
203 object. This is needed when not using FTW_PHYS. */
208 /* Internally we use the FTW_* constants used for `nftw'. When invoked
209 as `ftw', map each flag to the subset of values used by `ftw'. */
210 static const int nftw_arr
[] =
212 FTW_F
, FTW_D
, FTW_DNR
, FTW_NS
, FTW_SL
, FTW_DP
, FTW_SLN
215 static const int ftw_arr
[] =
217 FTW_F
, FTW_D
, FTW_DNR
, FTW_NS
, FTW_F
, FTW_D
, FTW_NS
221 /* Forward declarations of local functions. */
222 static int ftw_dir (struct ftw_data
*data
, struct STAT
*st
,
223 struct dir_data
*old_dir
) internal_function
;
227 object_compare (const void *p1
, const void *p2
)
229 /* We don't need a sophisticated and useful comparison. We are only
230 interested in equality. However, we must be careful not to
231 accidentally compare `holes' in the structure. */
232 const struct known_object
*kp1
= p1
, *kp2
= p2
;
234 cmp1
= (kp1
->ino
> kp2
->ino
) - (kp1
->ino
< kp2
->ino
);
237 return (kp1
->dev
> kp2
->dev
) - (kp1
->dev
< kp2
->dev
);
242 add_object (struct ftw_data
*data
, struct STAT
*st
)
244 struct known_object
*newp
= malloc (sizeof (struct known_object
));
247 newp
->dev
= st
->st_dev
;
248 newp
->ino
= st
->st_ino
;
249 return __tsearch (newp
, &data
->known_objects
, object_compare
) ? 0 : -1;
254 find_object (struct ftw_data
*data
, struct STAT
*st
)
256 struct known_object obj
;
257 obj
.dev
= st
->st_dev
;
258 obj
.ino
= st
->st_ino
;
259 return __tfind (&obj
, &data
->known_objects
, object_compare
) != NULL
;
264 __attribute ((always_inline
))
265 open_dir_stream (struct ftw_data
*data
, struct dir_data
*dirp
)
269 if (data
->dirstreams
[data
->actdir
] != NULL
)
271 /* Oh, oh. We must close this stream. Get all remaining
272 entries and store them as a list in the `content' member of
273 the `struct dir_data' variable. */
274 size_t bufsize
= 1024;
275 char *buf
= malloc (bufsize
);
281 DIR *st
= data
->dirstreams
[data
->actdir
]->stream
;
285 while ((d
= __readdir64 (st
)) != NULL
)
287 size_t this_len
= NAMLEN (d
);
288 if (actsize
+ this_len
+ 2 >= bufsize
)
291 bufsize
+= MAX (1024, 2 * this_len
);
292 newp
= (char *) realloc (buf
, bufsize
);
295 /* No more memory. */
296 int save_err
= errno
;
298 __set_errno (save_err
);
305 *((char *) __mempcpy (buf
+ actsize
, d
->d_name
, this_len
))
307 actsize
+= this_len
+ 1;
310 /* Terminate the list with an additional NUL byte. */
311 buf
[actsize
++] = '\0';
313 /* Shrink the buffer to what we actually need. */
314 data
->dirstreams
[data
->actdir
]->content
= realloc (buf
, actsize
);
315 if (data
->dirstreams
[data
->actdir
]->content
== NULL
)
317 int save_err
= errno
;
319 __set_errno (save_err
);
325 data
->dirstreams
[data
->actdir
]->stream
= NULL
;
326 data
->dirstreams
[data
->actdir
] = NULL
;
331 /* Open the new stream. */
334 const char *name
= ((data
->flags
& FTW_CHDIR
)
335 ? data
->dirbuf
+ data
->ftw
.base
: data
->dirbuf
);
336 assert (data
->dirstreams
[data
->actdir
] == NULL
);
338 dirp
->stream
= __opendir (name
);
339 if (dirp
->stream
== NULL
)
343 dirp
->content
= NULL
;
344 data
->dirstreams
[data
->actdir
] = dirp
;
346 if (++data
->actdir
== data
->maxdir
)
357 process_entry (struct ftw_data
*data
, struct dir_data
*dir
, const char *name
,
365 if (name
[0] == '.' && (name
[1] == '\0'
366 || (name
[1] == '.' && name
[2] == '\0')))
367 /* Don't process the "." and ".." entries. */
370 new_buflen
= data
->ftw
.base
+ namlen
+ 2;
371 if (data
->dirbufsize
< new_buflen
)
373 /* Enlarge the buffer. */
376 data
->dirbufsize
= 2 * new_buflen
;
377 newp
= (char *) realloc (data
->dirbuf
, data
->dirbufsize
);
383 *((char *) __mempcpy (data
->dirbuf
+ data
->ftw
.base
, name
, namlen
)) = '\0';
385 if ((data
->flags
& FTW_CHDIR
) == 0)
388 if (((data
->flags
& FTW_PHYS
)
389 ? LXSTAT (_STAT_VER
, name
, &st
)
390 : XSTAT (_STAT_VER
, name
, &st
)) < 0)
392 if (errno
!= EACCES
&& errno
!= ENOENT
)
394 else if (!(data
->flags
& FTW_PHYS
)
395 && LXSTAT (_STAT_VER
, name
, &st
) == 0
396 && S_ISLNK (st
.st_mode
))
403 if (S_ISDIR (st
.st_mode
))
405 else if (S_ISLNK (st
.st_mode
))
413 || !(data
->flags
& FTW_MOUNT
) || st
.st_dev
== data
->dev
))
417 if ((data
->flags
& FTW_PHYS
)
418 || (!find_object (data
, &st
)
419 /* Remember the object. */
420 && (result
= add_object (data
, &st
)) == 0))
421 result
= ftw_dir (data
, &st
, dir
);
424 result
= (*data
->func
) (data
->dirbuf
, &st
, data
->cvt_arr
[flag
],
428 if ((data
->flags
& FTW_ACTIONRETVAL
) && result
== FTW_SKIP_SUBTREE
)
436 __attribute ((noinline
))
438 ftw_dir (struct ftw_data
*data
, struct STAT
*st
, struct dir_data
*old_dir
)
442 int previous_base
= data
->ftw
.base
;
446 /* Open the stream for this directory. This might require that
447 another stream has to be closed. */
448 result
= open_dir_stream (data
, &dir
);
452 /* We cannot read the directory. Signal this with a special flag. */
453 result
= (*data
->func
) (data
->dirbuf
, st
, FTW_DNR
, &data
->ftw
);
458 /* First, report the directory (if not depth-first). */
459 if (!(data
->flags
& FTW_DEPTH
))
461 result
= (*data
->func
) (data
->dirbuf
, st
, FTW_D
, &data
->ftw
);
467 __closedir (dir
.stream
);
468 __set_errno (save_err
);
470 if (data
->actdir
-- == 0)
471 data
->actdir
= data
->maxdir
- 1;
472 data
->dirstreams
[data
->actdir
] = NULL
;
477 /* If necessary, change to this directory. */
478 if (data
->flags
& FTW_CHDIR
)
480 if (__fchdir (dirfd (dir
.stream
)) < 0)
487 /* Next, update the `struct FTW' information. */
489 startp
= strchr (data
->dirbuf
, '\0');
490 /* There always must be a directory name. */
491 assert (startp
!= data
->dirbuf
);
492 if (startp
[-1] != '/')
494 data
->ftw
.base
= startp
- data
->dirbuf
;
496 while (dir
.stream
!= NULL
&& (d
= __readdir64 (dir
.stream
)) != NULL
)
498 result
= process_entry (data
, &dir
, d
->d_name
, NAMLEN (d
));
503 if (dir
.stream
!= NULL
)
505 /* The stream is still open. I.e., we did not need more
506 descriptors. Simply close the stream now. */
507 int save_err
= errno
;
509 assert (dir
.content
== NULL
);
511 __closedir (dir
.stream
);
512 __set_errno (save_err
);
514 if (data
->actdir
-- == 0)
515 data
->actdir
= data
->maxdir
- 1;
516 data
->dirstreams
[data
->actdir
] = NULL
;
521 char *runp
= dir
.content
;
523 while (result
== 0 && *runp
!= '\0')
525 char *endp
= strchr (runp
, '\0');
527 result
= process_entry (data
, &dir
, runp
, endp
- runp
);
534 __set_errno (save_err
);
537 if ((data
->flags
& FTW_ACTIONRETVAL
) && result
== FTW_SKIP_SIBLINGS
)
540 /* Prepare the return, revert the `struct FTW' information. */
541 data
->dirbuf
[data
->ftw
.base
- 1] = '\0';
543 data
->ftw
.base
= previous_base
;
545 /* Finally, if we process depth-first report the directory. */
546 if (result
== 0 && (data
->flags
& FTW_DEPTH
))
547 result
= (*data
->func
) (data
->dirbuf
, st
, FTW_DP
, &data
->ftw
);
550 && (data
->flags
& FTW_CHDIR
)
552 || ((data
->flags
& FTW_ACTIONRETVAL
)
553 && (result
!= -1 && result
!= FTW_STOP
))))
555 /* Change back to the parent directory. */
557 if (old_dir
->stream
!= NULL
)
558 if (__fchdir (dirfd (old_dir
->stream
)) == 0)
563 if (data
->ftw
.base
== 1)
565 if (__chdir ("/") < 0)
569 if (__chdir ("..") < 0)
579 __attribute ((noinline
))
581 ftw_startup (const char *dir
, int is_nftw
, void *func
, int descriptors
,
584 struct ftw_data data
;
591 /* First make sure the parameters are reasonable. */
594 __set_errno (ENOENT
);
598 data
.maxdir
= descriptors
< 1 ? 1 : descriptors
;
600 data
.dirstreams
= (struct dir_data
**) alloca (data
.maxdir
601 * sizeof (struct dir_data
*));
602 memset (data
.dirstreams
, '\0', data
.maxdir
* sizeof (struct dir_data
*));
604 /* PATH_MAX is always defined when we get here. */
605 data
.dirbufsize
= MAX (2 * strlen (dir
), PATH_MAX
);
606 data
.dirbuf
= (char *) malloc (data
.dirbufsize
);
607 if (data
.dirbuf
== NULL
)
609 cp
= __stpcpy (data
.dirbuf
, dir
);
610 /* Strip trailing slashes. */
611 while (cp
> data
.dirbuf
+ 1 && cp
[-1] == '/')
618 while (cp
> data
.dirbuf
&& cp
[-1] != '/')
620 data
.ftw
.base
= cp
- data
.dirbuf
;
624 /* This assignment might seem to be strange but it is what we want.
625 The trick is that the first three arguments to the `ftw' and
626 `nftw' callback functions are equal. Therefore we can call in
627 every case the callback using the format of the `nftw' version
628 and get the correct result since the stack layout for a function
629 call in C allows this. */
630 data
.func
= (NFTW_FUNC_T
) func
;
632 /* Since we internally use the complete set of FTW_* values we need
633 to reduce the value range before calling a `ftw' callback. */
634 data
.cvt_arr
= is_nftw
? nftw_arr
: ftw_arr
;
636 /* No object known so far. */
637 data
.known_objects
= NULL
;
639 /* Now go to the directory containing the initial file/directory. */
640 if (flags
& FTW_CHDIR
)
642 /* GNU extension ahead. */
643 cwd
= __getcwd (NULL
, 0);
646 else if (data
.ftw
.base
> 0)
648 /* Change to the directory the file is in. In data.dirbuf
649 we have a writable copy of the file name. Just NUL
650 terminate it for now and change the directory. */
651 if (data
.ftw
.base
== 1)
652 /* I.e., the file is in the root directory. */
653 result
= __chdir ("/");
656 char ch
= data
.dirbuf
[data
.ftw
.base
- 1];
657 data
.dirbuf
[data
.ftw
.base
- 1] = '\0';
658 result
= __chdir (data
.dirbuf
);
659 data
.dirbuf
[data
.ftw
.base
- 1] = ch
;
664 /* Get stat info for start directory. */
667 const char *name
= ((data
.flags
& FTW_CHDIR
)
668 ? data
.dirbuf
+ data
.ftw
.base
671 if (((flags
& FTW_PHYS
)
672 ? LXSTAT (_STAT_VER
, name
, &st
)
673 : XSTAT (_STAT_VER
, name
, &st
)) < 0)
675 if (!(flags
& FTW_PHYS
)
677 && LXSTAT (_STAT_VER
, name
, &st
) == 0
678 && S_ISLNK (st
.st_mode
))
679 result
= (*data
.func
) (data
.dirbuf
, &st
, data
.cvt_arr
[FTW_SLN
],
682 /* No need to call the callback since we cannot say anything
688 if (S_ISDIR (st
.st_mode
))
690 /* Remember the device of the initial directory in case
691 FTW_MOUNT is given. */
692 data
.dev
= st
.st_dev
;
694 /* We know this directory now. */
695 if (!(flags
& FTW_PHYS
))
696 result
= add_object (&data
, &st
);
699 result
= ftw_dir (&data
, &st
, NULL
);
703 int flag
= S_ISLNK (st
.st_mode
) ? FTW_SL
: FTW_F
;
705 result
= (*data
.func
) (data
.dirbuf
, &st
, data
.cvt_arr
[flag
],
710 if ((flags
& FTW_ACTIONRETVAL
)
711 && (result
== FTW_SKIP_SUBTREE
|| result
== FTW_SKIP_SIBLINGS
))
715 /* Return to the start directory (if necessary). */
718 int save_err
= errno
;
721 __set_errno (save_err
);
724 /* Free all memory. */
726 __tdestroy (data
.known_objects
, free
);
728 __set_errno (save_err
);
738 FTW_NAME (path
, func
, descriptors
)
743 return ftw_startup (path
, 0, func
, descriptors
, 0);
748 NFTW_NAME (path
, func
, descriptors
, flags
)
754 return ftw_startup (path
, 1, func
, descriptors
, flags
);
758 #include <shlib-compat.h>
760 int NFTW_NEW_NAME (const char *, NFTW_FUNC_T
, int, int);
763 NFTW_NEW_NAME (path
, func
, descriptors
, flags
)
770 & ~(FTW_PHYS
| FTW_MOUNT
| FTW_CHDIR
| FTW_DEPTH
| FTW_ACTIONRETVAL
))
772 __set_errno (EINVAL
);
775 return ftw_startup (path
, 1, func
, descriptors
, flags
);
778 versioned_symbol (libc
, NFTW_NEW_NAME
, NFTW_NAME
, GLIBC_2_3_3
);
780 #if SHLIB_COMPAT(libc, GLIBC_2_1, GLIBC_2_3_3)
782 /* Older nftw* version just ignored all unknown flags. */
784 int NFTW_OLD_NAME (const char *, NFTW_FUNC_T
, int, int);
787 attribute_compat_text_section
788 NFTW_OLD_NAME (path
, func
, descriptors
, flags
)
794 flags
&= (FTW_PHYS
| FTW_MOUNT
| FTW_CHDIR
| FTW_DEPTH
);
795 return ftw_startup (path
, 1, func
, descriptors
, flags
);
798 compat_symbol (libc
, NFTW_OLD_NAME
, NFTW_NAME
, GLIBC_2_1
);