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 #if HAVE_SYS_PARAM_H || defined _LIBC
70 # include <sys/param.h>
73 # include <include/sys/stat.h>
75 # include <sys/stat.h>
78 #if ! _LIBC && !HAVE_DECL_STPCPY && !defined stpcpy
82 #if ! _LIBC && ! defined HAVE_MEMPCPY && ! defined mempcpy
83 /* Be CAREFUL that there are no side effects in N. */
84 # define mempcpy(D, S, N) ((void *) ((char *) memcpy (D, S, N) + (N)))
87 /* #define NDEBUG 1 */
92 # define __chdir chdir
94 # define __closedir closedir
96 # define __fchdir fchdir
98 # define __getcwd(P, N) xgetcwd ()
99 extern char *xgetcwd (void);
101 # define __mempcpy mempcpy
103 # define __opendir opendir
105 # define __readdir64 readdir
107 # define __stpcpy stpcpy
109 # define __tdestroy tdestroy
111 # define __tfind tfind
113 # define __tsearch tsearch
114 # undef internal_function
115 # define internal_function /* empty */
117 # define dirent64 dirent
119 # define MAX(a, b) ((a) > (b) ? (a) : (b))
122 /* Arrange to make lstat calls go through the wrapper function
123 on systems with an lstat function that does not dereference symlinks
124 that are specified with a trailing slash. */
125 #if ! _LIBC && ! LSTAT_FOLLOWS_SLASHED_SYMLINK
126 int rpl_lstat (const char *, struct stat
*);
128 # define lstat(Name, Stat_buf) rpl_lstat(Name, Stat_buf)
132 # define __set_errno(Val) errno = (Val)
135 /* Support for the LFS API version. */
137 # define FTW_NAME ftw
138 # define NFTW_NAME nftw
139 # define NFTW_OLD_NAME __old_nftw
140 # define NFTW_NEW_NAME __new_nftw
144 # define LXSTAT __lxstat
145 # define XSTAT __xstat
147 # define LXSTAT(V,f,sb) lstat (f,sb)
148 # define XSTAT(V,f,sb) stat (f,sb)
150 # define FTW_FUNC_T __ftw_func_t
151 # define NFTW_FUNC_T __nftw_func_t
154 /* We define PATH_MAX if the system does not provide a definition.
155 This does not artificially limit any operation. PATH_MAX is simply
156 used as a guesstimate for the expected maximal path length.
157 Buffers will be enlarged if necessary. */
159 # define PATH_MAX 1024
176 /* Array with pointers to open directory streams. */
177 struct dir_data
**dirstreams
;
181 /* Buffer containing name of currently processed object. */
185 /* Passed as fourth argument to `nftw' callback. The `base' member
186 tracks the content of the `dirbuf'. */
189 /* Flags passed to `nftw' function. 0 for `ftw'. */
192 /* Conversion array for flag values. It is the identity mapping for
193 `nftw' calls, otherwise it maps the values to those known by
197 /* Callback function. We always use the `nftw' form. */
200 /* Device of starting point. Needed for FTW_MOUNT. */
203 /* Data structure for keeping fingerprints of already processed
204 object. This is needed when not using FTW_PHYS. */
209 /* Internally we use the FTW_* constants used for `nftw'. When invoked
210 as `ftw', map each flag to the subset of values used by `ftw'. */
211 static const int nftw_arr
[] =
213 FTW_F
, FTW_D
, FTW_DNR
, FTW_NS
, FTW_SL
, FTW_DP
, FTW_SLN
216 static const int ftw_arr
[] =
218 FTW_F
, FTW_D
, FTW_DNR
, FTW_NS
, FTW_F
, FTW_D
, FTW_NS
222 /* Forward declarations of local functions. */
223 static int ftw_dir (struct ftw_data
*data
, struct STAT
*st
,
224 struct dir_data
*old_dir
) internal_function
;
228 object_compare (const void *p1
, const void *p2
)
230 /* We don't need a sophisticated and useful comparison. We are only
231 interested in equality. However, we must be careful not to
232 accidentally compare `holes' in the structure. */
233 const struct known_object
*kp1
= p1
, *kp2
= p2
;
235 cmp1
= (kp1
->ino
> kp2
->ino
) - (kp1
->ino
< kp2
->ino
);
238 return (kp1
->dev
> kp2
->dev
) - (kp1
->dev
< kp2
->dev
);
243 add_object (struct ftw_data
*data
, struct STAT
*st
)
245 struct known_object
*newp
= malloc (sizeof (struct known_object
));
248 newp
->dev
= st
->st_dev
;
249 newp
->ino
= st
->st_ino
;
250 return __tsearch (newp
, &data
->known_objects
, object_compare
) ? 0 : -1;
255 find_object (struct ftw_data
*data
, struct STAT
*st
)
257 struct known_object obj
;
258 obj
.dev
= st
->st_dev
;
259 obj
.ino
= st
->st_ino
;
260 return __tfind (&obj
, &data
->known_objects
, object_compare
) != NULL
;
265 __attribute ((always_inline
))
266 open_dir_stream (struct ftw_data
*data
, struct dir_data
*dirp
)
270 if (data
->dirstreams
[data
->actdir
] != NULL
)
272 /* Oh, oh. We must close this stream. Get all remaining
273 entries and store them as a list in the `content' member of
274 the `struct dir_data' variable. */
275 size_t bufsize
= 1024;
276 char *buf
= malloc (bufsize
);
282 DIR *st
= data
->dirstreams
[data
->actdir
]->stream
;
286 while ((d
= __readdir64 (st
)) != NULL
)
288 size_t this_len
= NAMLEN (d
);
289 if (actsize
+ this_len
+ 2 >= bufsize
)
292 bufsize
+= MAX (1024, 2 * this_len
);
293 newp
= (char *) realloc (buf
, bufsize
);
296 /* No more memory. */
297 int save_err
= errno
;
299 __set_errno (save_err
);
306 *((char *) __mempcpy (buf
+ actsize
, d
->d_name
, this_len
))
308 actsize
+= this_len
+ 1;
311 /* Terminate the list with an additional NUL byte. */
312 buf
[actsize
++] = '\0';
314 /* Shrink the buffer to what we actually need. */
315 data
->dirstreams
[data
->actdir
]->content
= realloc (buf
, actsize
);
316 if (data
->dirstreams
[data
->actdir
]->content
== NULL
)
318 int save_err
= errno
;
320 __set_errno (save_err
);
326 data
->dirstreams
[data
->actdir
]->stream
= NULL
;
327 data
->dirstreams
[data
->actdir
] = NULL
;
332 /* Open the new stream. */
335 const char *name
= ((data
->flags
& FTW_CHDIR
)
336 ? data
->dirbuf
+ data
->ftw
.base
: data
->dirbuf
);
337 assert (data
->dirstreams
[data
->actdir
] == NULL
);
339 dirp
->stream
= __opendir (name
);
340 if (dirp
->stream
== NULL
)
344 dirp
->content
= NULL
;
345 data
->dirstreams
[data
->actdir
] = dirp
;
347 if (++data
->actdir
== data
->maxdir
)
358 process_entry (struct ftw_data
*data
, struct dir_data
*dir
, const char *name
,
366 if (name
[0] == '.' && (name
[1] == '\0'
367 || (name
[1] == '.' && name
[2] == '\0')))
368 /* Don't process the "." and ".." entries. */
371 new_buflen
= data
->ftw
.base
+ namlen
+ 2;
372 if (data
->dirbufsize
< new_buflen
)
374 /* Enlarge the buffer. */
377 data
->dirbufsize
= 2 * new_buflen
;
378 newp
= (char *) realloc (data
->dirbuf
, data
->dirbufsize
);
384 *((char *) __mempcpy (data
->dirbuf
+ data
->ftw
.base
, name
, namlen
)) = '\0';
386 if ((data
->flags
& FTW_CHDIR
) == 0)
389 if (((data
->flags
& FTW_PHYS
)
390 ? LXSTAT (_STAT_VER
, name
, &st
)
391 : XSTAT (_STAT_VER
, name
, &st
)) < 0)
393 if (errno
!= EACCES
&& errno
!= ENOENT
)
395 else if (!(data
->flags
& FTW_PHYS
)
396 && LXSTAT (_STAT_VER
, name
, &st
) == 0
397 && S_ISLNK (st
.st_mode
))
404 if (S_ISDIR (st
.st_mode
))
406 else if (S_ISLNK (st
.st_mode
))
414 || !(data
->flags
& FTW_MOUNT
) || st
.st_dev
== data
->dev
))
418 if ((data
->flags
& FTW_PHYS
)
419 || (!find_object (data
, &st
)
420 /* Remember the object. */
421 && (result
= add_object (data
, &st
)) == 0))
422 result
= ftw_dir (data
, &st
, dir
);
425 result
= (*data
->func
) (data
->dirbuf
, &st
, data
->cvt_arr
[flag
],
429 if ((data
->flags
& FTW_ACTIONRETVAL
) && result
== FTW_SKIP_SUBTREE
)
437 __attribute ((noinline
))
439 ftw_dir (struct ftw_data
*data
, struct STAT
*st
, struct dir_data
*old_dir
)
443 int previous_base
= data
->ftw
.base
;
447 /* Open the stream for this directory. This might require that
448 another stream has to be closed. */
449 result
= open_dir_stream (data
, &dir
);
453 /* We cannot read the directory. Signal this with a special flag. */
454 result
= (*data
->func
) (data
->dirbuf
, st
, FTW_DNR
, &data
->ftw
);
459 /* First, report the directory (if not depth-first). */
460 if (!(data
->flags
& FTW_DEPTH
))
462 result
= (*data
->func
) (data
->dirbuf
, st
, FTW_D
, &data
->ftw
);
468 __closedir (dir
.stream
);
469 __set_errno (save_err
);
471 if (data
->actdir
-- == 0)
472 data
->actdir
= data
->maxdir
- 1;
473 data
->dirstreams
[data
->actdir
] = NULL
;
478 /* If necessary, change to this directory. */
479 if (data
->flags
& FTW_CHDIR
)
481 if (__fchdir (dirfd (dir
.stream
)) < 0)
488 /* Next, update the `struct FTW' information. */
490 startp
= strchr (data
->dirbuf
, '\0');
491 /* There always must be a directory name. */
492 assert (startp
!= data
->dirbuf
);
493 if (startp
[-1] != '/')
495 data
->ftw
.base
= startp
- data
->dirbuf
;
497 while (dir
.stream
!= NULL
&& (d
= __readdir64 (dir
.stream
)) != NULL
)
499 result
= process_entry (data
, &dir
, d
->d_name
, NAMLEN (d
));
504 if (dir
.stream
!= NULL
)
506 /* The stream is still open. I.e., we did not need more
507 descriptors. Simply close the stream now. */
508 int save_err
= errno
;
510 assert (dir
.content
== NULL
);
512 __closedir (dir
.stream
);
513 __set_errno (save_err
);
515 if (data
->actdir
-- == 0)
516 data
->actdir
= data
->maxdir
- 1;
517 data
->dirstreams
[data
->actdir
] = NULL
;
522 char *runp
= dir
.content
;
524 while (result
== 0 && *runp
!= '\0')
526 char *endp
= strchr (runp
, '\0');
528 result
= process_entry (data
, &dir
, runp
, endp
- runp
);
535 __set_errno (save_err
);
538 if ((data
->flags
& FTW_ACTIONRETVAL
) && result
== FTW_SKIP_SIBLINGS
)
541 /* Prepare the return, revert the `struct FTW' information. */
542 data
->dirbuf
[data
->ftw
.base
- 1] = '\0';
544 data
->ftw
.base
= previous_base
;
546 /* Finally, if we process depth-first report the directory. */
547 if (result
== 0 && (data
->flags
& FTW_DEPTH
))
548 result
= (*data
->func
) (data
->dirbuf
, st
, FTW_DP
, &data
->ftw
);
551 && (data
->flags
& FTW_CHDIR
)
553 || ((data
->flags
& FTW_ACTIONRETVAL
)
554 && (result
!= -1 && result
!= FTW_STOP
))))
556 /* Change back to the parent directory. */
558 if (old_dir
->stream
!= NULL
)
559 if (__fchdir (dirfd (old_dir
->stream
)) == 0)
564 if (data
->ftw
.base
== 1)
566 if (__chdir ("/") < 0)
570 if (__chdir ("..") < 0)
580 __attribute ((noinline
))
582 ftw_startup (const char *dir
, int is_nftw
, void *func
, int descriptors
,
585 struct ftw_data data
;
593 /* First make sure the parameters are reasonable. */
596 __set_errno (ENOENT
);
600 data
.maxdir
= descriptors
< 1 ? 1 : descriptors
;
602 data
.dirstreams
= (struct dir_data
**) alloca (data
.maxdir
603 * sizeof (struct dir_data
*));
604 memset (data
.dirstreams
, '\0', data
.maxdir
* sizeof (struct dir_data
*));
606 /* PATH_MAX is always defined when we get here. */
607 data
.dirbufsize
= MAX (2 * strlen (dir
), PATH_MAX
);
608 data
.dirbuf
= (char *) malloc (data
.dirbufsize
);
609 if (data
.dirbuf
== NULL
)
611 cp
= __stpcpy (data
.dirbuf
, dir
);
612 /* Strip trailing slashes. */
613 while (cp
> data
.dirbuf
+ 1 && cp
[-1] == '/')
620 while (cp
> data
.dirbuf
&& cp
[-1] != '/')
622 data
.ftw
.base
= cp
- data
.dirbuf
;
626 /* This assignment might seem to be strange but it is what we want.
627 The trick is that the first three arguments to the `ftw' and
628 `nftw' callback functions are equal. Therefore we can call in
629 every case the callback using the format of the `nftw' version
630 and get the correct result since the stack layout for a function
631 call in C allows this. */
632 data
.func
= (NFTW_FUNC_T
) func
;
634 /* Since we internally use the complete set of FTW_* values we need
635 to reduce the value range before calling a `ftw' callback. */
636 data
.cvt_arr
= is_nftw
? nftw_arr
: ftw_arr
;
638 /* No object known so far. */
639 data
.known_objects
= NULL
;
641 /* Now go to the directory containing the initial file/directory. */
642 if (flags
& FTW_CHDIR
)
644 /* We have to be able to go back to the current working
645 directory. The best way to do this is to use a file
647 cwdfd
= __open (".", O_RDONLY
| O_DIRECTORY
);
650 /* Try getting the directory name. This can be needed if
651 the current directory is executable but not readable. */
653 /* GNU extension ahead. */
654 cwd
= __getcwd (NULL
, 0);
659 else if (data
.maxdir
> 1)
660 /* Account for the file descriptor we use here. */
663 if (data
.ftw
.base
> 0)
665 /* Change to the directory the file is in. In data.dirbuf
666 we have a writable copy of the file name. Just NUL
667 terminate it for now and change the directory. */
668 if (data
.ftw
.base
== 1)
669 /* I.e., the file is in the root directory. */
670 result
= __chdir ("/");
673 char ch
= data
.dirbuf
[data
.ftw
.base
- 1];
674 data
.dirbuf
[data
.ftw
.base
- 1] = '\0';
675 result
= __chdir (data
.dirbuf
);
676 data
.dirbuf
[data
.ftw
.base
- 1] = ch
;
681 /* Get stat info for start directory. */
684 const char *name
= ((data
.flags
& FTW_CHDIR
)
685 ? data
.dirbuf
+ data
.ftw
.base
688 if (((flags
& FTW_PHYS
)
689 ? LXSTAT (_STAT_VER
, name
, &st
)
690 : XSTAT (_STAT_VER
, name
, &st
)) < 0)
692 if (!(flags
& FTW_PHYS
)
694 && LXSTAT (_STAT_VER
, name
, &st
) == 0
695 && S_ISLNK (st
.st_mode
))
696 result
= (*data
.func
) (data
.dirbuf
, &st
, data
.cvt_arr
[FTW_SLN
],
699 /* No need to call the callback since we cannot say anything
705 if (S_ISDIR (st
.st_mode
))
707 /* Remember the device of the initial directory in case
708 FTW_MOUNT is given. */
709 data
.dev
= st
.st_dev
;
711 /* We know this directory now. */
712 if (!(flags
& FTW_PHYS
))
713 result
= add_object (&data
, &st
);
716 result
= ftw_dir (&data
, &st
, NULL
);
720 int flag
= S_ISLNK (st
.st_mode
) ? FTW_SL
: FTW_F
;
722 result
= (*data
.func
) (data
.dirbuf
, &st
, data
.cvt_arr
[flag
],
727 if ((flags
& FTW_ACTIONRETVAL
)
728 && (result
== FTW_SKIP_SUBTREE
|| result
== FTW_SKIP_SIBLINGS
))
732 /* Return to the start directory (if necessary). */
735 int save_err
= errno
;
737 __set_errno (save_err
);
739 else if (cwd
!= NULL
)
741 int save_err
= errno
;
744 __set_errno (save_err
);
747 /* Free all memory. */
750 __tdestroy (data
.known_objects
, free
);
752 __set_errno (save_err
);
762 FTW_NAME (path
, func
, descriptors
)
767 return ftw_startup (path
, 0, func
, descriptors
, 0);
772 NFTW_NAME (path
, func
, descriptors
, flags
)
778 return ftw_startup (path
, 1, func
, descriptors
, flags
);
782 # include <shlib-compat.h>
784 int NFTW_NEW_NAME (const char *, NFTW_FUNC_T
, int, int);
787 NFTW_NEW_NAME (path
, func
, descriptors
, flags
)
794 & ~(FTW_PHYS
| FTW_MOUNT
| FTW_CHDIR
| FTW_DEPTH
| FTW_ACTIONRETVAL
))
796 __set_errno (EINVAL
);
799 return ftw_startup (path
, 1, func
, descriptors
, flags
);
802 versioned_symbol (libc
, NFTW_NEW_NAME
, NFTW_NAME
, GLIBC_2_3_3
);
804 # if SHLIB_COMPAT(libc, GLIBC_2_1, GLIBC_2_3_3)
806 /* Older nftw* version just ignored all unknown flags. */
808 int NFTW_OLD_NAME (const char *, NFTW_FUNC_T
, int, int);
811 attribute_compat_text_section
812 NFTW_OLD_NAME (path
, func
, descriptors
, flags
)
818 flags
&= (FTW_PHYS
| FTW_MOUNT
| FTW_CHDIR
| FTW_DEPTH
);
819 return ftw_startup (path
, 1, func
, descriptors
, flags
);
822 compat_symbol (libc
, NFTW_OLD_NAME
, NFTW_NAME
, GLIBC_2_1
);