]>
git.cameronkatri.com Git - mandoc.git/blob - compat_fts.c
9 /* $Id: compat_fts.c,v 1.12 2016/10/18 23:58:12 schwarze Exp $ */
10 /* $OpenBSD: fts.c,v 1.56 2016/09/21 04:38:56 guenther Exp $ */
13 * Copyright (c) 1990, 1993, 1994
14 * The Regents of the University of California. All rights reserved.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
24 * 3. Neither the name of the University nor the names of its contributors
25 * may be used to endorse or promote products derived from this software
26 * without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42 #include <sys/types.h>
51 #include "compat_fts.h"
53 #define MAXIMUM(a, b) (((a) > (b)) ? (a) : (b))
55 static FTSENT
*fts_alloc(FTS
*, const char *, size_t);
56 static FTSENT
*fts_build(FTS
*);
57 static void fts_lfree(FTSENT
*);
58 static void fts_load(FTS
*, FTSENT
*);
59 static size_t fts_maxarglen(char * const *);
60 static void fts_padjust(FTS
*, FTSENT
*);
61 static int fts_palloc(FTS
*, size_t);
62 static FTSENT
*fts_sort(FTS
*, FTSENT
*, int);
63 static unsigned short fts_stat(FTS
*, FTSENT
*);
65 #define ISDOT(a) (a[0] == '.' && (!a[1] || (a[1] == '.' && !a[2])))
76 #define CLR(opt) (sp->fts_options &= ~(opt))
77 #define ISSET(opt) (sp->fts_options & (opt))
78 #define SET(opt) (sp->fts_options |= (opt))
81 fts_open(char * const *argv
, int options
,
82 int (*compar
)(const FTSENT
**, const FTSENT
**))
90 if (options
& ~FTS_OPTIONMASK
) {
95 /* At least one path must be specified. */
101 /* Allocate/initialize the stream */
102 if ((sp
= calloc(1, sizeof(FTS
))) == NULL
)
104 sp
->fts_compar
= compar
;
105 sp
->fts_options
= options
;
108 * Start out with 1K of path space, and enough, in any case,
109 * to hold the user's paths.
111 if (fts_palloc(sp
, MAXIMUM(fts_maxarglen(argv
), PATH_MAX
)))
114 /* Allocate/initialize root's parent. */
115 if ((parent
= fts_alloc(sp
, "", 0)) == NULL
)
117 parent
->fts_level
= FTS_ROOTPARENTLEVEL
;
119 /* Allocate/initialize root(s). */
120 for (root
= NULL
, nitems
= 0; *argv
; ++argv
, ++nitems
) {
121 if ((p
= fts_alloc(sp
, *argv
, strlen(*argv
))) == NULL
)
123 p
->fts_level
= FTS_ROOTLEVEL
;
124 p
->fts_parent
= parent
;
125 p
->fts_accpath
= p
->fts_name
;
126 p
->fts_info
= fts_stat(sp
, p
);
128 /* Command-line "." and ".." are real directories. */
129 if (p
->fts_info
== FTS_DOT
)
133 * If comparison routine supplied, traverse in sorted
134 * order; otherwise traverse in the order specified.
149 if (compar
&& nitems
> 1)
150 root
= fts_sort(sp
, root
, nitems
);
153 * Allocate a dummy pointer and make fts_read think that we've just
154 * finished the node before the root(s); set p->fts_info to FTS_INIT
155 * so that everything about the "current" node is ignored.
157 if ((sp
->fts_cur
= fts_alloc(sp
, "", 0)) == NULL
)
159 sp
->fts_cur
->fts_link
= root
;
160 sp
->fts_cur
->fts_info
= FTS_INIT
;
167 mem3
: fts_lfree(root
);
169 mem2
: free(sp
->fts_path
);
175 fts_load(FTS
*sp
, FTSENT
*p
)
181 * Load the stream structure for the next traversal. Since we don't
182 * actually enter the directory until after the preorder visit, set
183 * the fts_accpath field specially so the chdir gets done to the right
184 * place and the user can access the first node. From fts_open it's
185 * known that the path will fit.
187 len
= p
->fts_pathlen
= p
->fts_namelen
;
188 memmove(sp
->fts_path
, p
->fts_name
, len
+ 1);
189 if ((cp
= strrchr(p
->fts_name
, '/')) && (cp
!= p
->fts_name
|| cp
[1])) {
191 memmove(p
->fts_name
, cp
, len
+ 1);
192 p
->fts_namelen
= len
;
194 p
->fts_accpath
= p
->fts_path
= sp
->fts_path
;
195 sp
->fts_dev
= p
->fts_dev
;
204 * This still works if we haven't read anything -- the dummy structure
205 * points to the root list, so we step through to the end of the root
206 * list which has a valid parent pointer.
209 for (p
= sp
->fts_cur
; p
->fts_level
>= FTS_ROOTLEVEL
;) {
211 p
= p
->fts_link
? p
->fts_link
: p
->fts_parent
;
217 /* Free up child linked list, sort array, path buffer, stream ptr.*/
219 fts_lfree(sp
->fts_child
);
228 * Special case of "/" at the end of the path so that slashes aren't
229 * appended which would cause paths to be written as "....//foo".
232 (p->fts_path[p->fts_pathlen - 1] == '/' \
233 ? p->fts_pathlen - 1 : p->fts_pathlen)
242 /* If finished or unrecoverable error, return NULL. */
243 if (sp
->fts_cur
== NULL
|| ISSET(FTS_STOP
))
246 /* Set current node pointer. */
249 /* Save and zero out user instructions. */
250 instr
= p
->fts_instr
;
251 p
->fts_instr
= FTS_NOINSTR
;
253 /* Directory in pre-order. */
254 if (p
->fts_info
== FTS_D
) {
255 /* If skipped or crossed mount point, do post-order visit. */
256 if (instr
== FTS_SKIP
||
257 (ISSET(FTS_XDEV
) && p
->fts_dev
!= sp
->fts_dev
)) {
259 fts_lfree(sp
->fts_child
);
260 sp
->fts_child
= NULL
;
262 p
->fts_info
= FTS_DP
;
267 * If haven't read do so. If the read fails, fts_build sets
268 * FTS_STOP or the fts_info field of the node.
272 } else if ((sp
->fts_child
= fts_build(sp
)) == NULL
) {
278 sp
->fts_child
= NULL
;
282 /* Move to the next node on this level. */
284 if ((p
= p
->fts_link
)) {
288 * If reached the top, return to the original directory (or
289 * the root of the tree), and load the paths for the next root.
291 if (p
->fts_level
== FTS_ROOTLEVEL
) {
293 return (sp
->fts_cur
= p
);
297 * User may have called fts_set on the node. If skipped,
298 * ignore. If followed, get a file descriptor so we can
299 * get back if necessary.
301 if (p
->fts_instr
== FTS_SKIP
)
304 name
: t
= sp
->fts_path
+ NAPPEND(p
->fts_parent
);
306 memmove(t
, p
->fts_name
, p
->fts_namelen
+ 1);
307 return (sp
->fts_cur
= p
);
310 /* Move up to the parent node. */
314 if (p
->fts_level
== FTS_ROOTPARENTLEVEL
) {
316 * Done; free everything up and set errno to 0 so the user
317 * can distinguish between error and EOF.
321 return (sp
->fts_cur
= NULL
);
324 /* NUL terminate the pathname. */
325 sp
->fts_path
[p
->fts_pathlen
] = '\0';
327 p
->fts_info
= p
->fts_errno
? FTS_ERR
: FTS_DP
;
328 return (sp
->fts_cur
= p
);
332 * Fts_set takes the stream as an argument although it's not used in this
333 * implementation; it would be necessary if anyone wanted to add global
334 * semantics to fts using fts_set. An error return is allowed for similar
338 fts_set(FTS
*sp
, FTSENT
*p
, int instr
)
340 if (instr
&& instr
!= FTS_NOINSTR
&& instr
!= FTS_SKIP
) {
344 p
->fts_instr
= instr
;
349 * This is the tricky part -- do not casually change *anything* in here. The
350 * idea is to build the linked list of entries that are used by fts_children
351 * and fts_read. There are lots of special cases.
353 * The real slowdown in walking the tree is the stat calls. If FTS_NOSTAT is
354 * set and it's a physical walk (so that symbolic links can't be directories),
355 * we can do things quickly. First, if it's a 4.4BSD file system, the type
356 * of the file is in the directory entry. Otherwise, we assume that the number
357 * of subdirectories in a node is equal to the number of links to the parent.
358 * The former skips all stat calls. The latter skips stat calls in any leaf
359 * directories and for any files after the subdirectories in the directory have
360 * been found, cutting the stat calls by about 2/3.
370 size_t dlen
, len
, maxlen
;
371 int nitems
, level
, doadjust
;
375 /* Set current node pointer. */
379 * Open the directory for reading. If this fails, we're done.
380 * If being called from fts_read, set the fts_info field.
382 if ((dirp
= opendir(cur
->fts_accpath
)) == NULL
) {
383 cur
->fts_info
= FTS_DNR
;
384 cur
->fts_errno
= errno
;
389 * Figure out the max file name length that can be stored in the
390 * current path -- the inner loop allocates more path as necessary.
391 * We really wouldn't have to do the maxlen calculations here, we
392 * could do them in fts_read before returning the path, but it's a
393 * lot easier here since the length is part of the dirent structure.
395 * If not changing directories set a pointer so that can just append
396 * each new name into the path.
399 cp
= sp
->fts_path
+ len
;
402 maxlen
= sp
->fts_pathlen
- len
;
405 * fts_level is signed so we must prevent it from wrapping
406 * around to FTS_ROOTLEVEL and FTS_ROOTPARENTLEVEL.
408 level
= cur
->fts_level
;
409 if (level
< FTS_MAXLEVEL
)
412 /* Read the directory, attaching each entry to the `link' pointer. */
414 for (head
= tail
= NULL
, nitems
= 0; dirp
&& (dp
= readdir(dirp
));) {
415 if (ISDOT(dp
->d_name
))
418 #if HAVE_DIRENT_NAMLEN
421 dlen
= strlen(dp
->d_name
);
424 if (!(p
= fts_alloc(sp
, dp
->d_name
, dlen
)))
426 if (dlen
>= maxlen
) { /* include space for NUL */
427 oldaddr
= sp
->fts_path
;
428 if (fts_palloc(sp
, dlen
+ len
+ 1)) {
430 * No more memory for path or structures. Save
431 * errno, free up the current structure and the
432 * structures already allocated.
434 mem1
: saved_errno
= errno
;
437 (void)closedir(dirp
);
438 cur
->fts_info
= FTS_ERR
;
443 /* Did realloc() change the pointer? */
444 if (oldaddr
!= sp
->fts_path
) {
446 cp
= sp
->fts_path
+ len
;
448 maxlen
= sp
->fts_pathlen
- len
;
451 p
->fts_level
= level
;
452 p
->fts_parent
= sp
->fts_cur
;
453 p
->fts_pathlen
= len
+ dlen
;
454 if (p
->fts_pathlen
< len
) {
456 * If we wrap, free up the current structure and
457 * the structures already allocated, then error
458 * out with ENAMETOOLONG.
462 (void)closedir(dirp
);
463 cur
->fts_info
= FTS_ERR
;
465 errno
= ENAMETOOLONG
;
469 /* Build a file name for fts_stat to stat. */
470 p
->fts_accpath
= p
->fts_path
;
471 memmove(cp
, p
->fts_name
, p
->fts_namelen
+ 1);
473 p
->fts_info
= fts_stat(sp
, p
);
475 /* We walk in directory order so "ls -f" doesn't get upset. */
486 (void)closedir(dirp
);
489 * If realloc() changed the address of the path, adjust the
490 * addresses for the rest of the tree and the dir list.
493 fts_padjust(sp
, head
);
496 * If not changing directories, reset the path back to original
499 if (len
== sp
->fts_pathlen
|| nitems
== 0)
503 /* If didn't find anything, return NULL. */
505 cur
->fts_info
= FTS_DP
;
509 /* Sort the entries. */
510 if (sp
->fts_compar
&& nitems
> 1)
511 head
= fts_sort(sp
, head
, nitems
);
515 static unsigned short
516 fts_stat(FTS
*sp
, FTSENT
*p
)
523 /* If user needs stat info, stat buffer already allocated. */
526 if (lstat(p
->fts_accpath
, sbp
)) {
527 p
->fts_errno
= errno
;
528 memset(sbp
, 0, sizeof(struct stat
));
532 if (S_ISDIR(sbp
->st_mode
)) {
534 * Set the device/inode. Used to find cycles and check for
535 * crossing mount points. Also remember the link count, used
536 * in fts_build to limit the number of stat calls. It is
537 * understood that these fields are only referenced if fts_info
540 dev
= p
->fts_dev
= sbp
->st_dev
;
541 ino
= p
->fts_ino
= sbp
->st_ino
;
542 p
->fts_nlink
= sbp
->st_nlink
;
544 if (ISDOT(p
->fts_name
))
548 * Cycle detection is done by brute force when the directory
549 * is first encountered. If the tree gets deep enough or the
550 * number of symbolic links to directories is high enough,
551 * something faster might be worthwhile.
553 for (t
= p
->fts_parent
;
554 t
->fts_level
>= FTS_ROOTLEVEL
; t
= t
->fts_parent
)
555 if (ino
== t
->fts_ino
&& dev
== t
->fts_dev
) {
561 if (S_ISLNK(sbp
->st_mode
))
563 if (S_ISREG(sbp
->st_mode
))
565 return (FTS_DEFAULT
);
569 fts_sort(FTS
*sp
, FTSENT
*head
, int nitems
)
574 * Construct an array of pointers to the structures and call qsort(3).
575 * Reassemble the array in the order returned by qsort. If unable to
576 * sort for memory reasons, return the directory entries in their
577 * current order. Allocate enough space for the current needs plus
578 * 40 so don't realloc one entry at a time.
580 if (nitems
> sp
->fts_nitems
) {
583 sp
->fts_nitems
= nitems
+ 40;
584 if ((a
= reallocarray(sp
->fts_array
,
585 sp
->fts_nitems
, sizeof(FTSENT
*))) == NULL
) {
587 sp
->fts_array
= NULL
;
593 for (ap
= sp
->fts_array
, p
= head
; p
; p
= p
->fts_link
)
595 qsort(sp
->fts_array
, nitems
, sizeof(FTSENT
*), sp
->fts_compar
);
596 for (head
= *(ap
= sp
->fts_array
); --nitems
; ++ap
)
597 ap
[0]->fts_link
= ap
[1];
598 ap
[0]->fts_link
= NULL
;
603 fts_alloc(FTS
*sp
, const char *name
, size_t namelen
)
608 len
= sizeof(FTSENT
) + namelen
;
609 if ((p
= calloc(1, len
)) == NULL
)
612 p
->fts_path
= sp
->fts_path
;
613 p
->fts_namelen
= namelen
;
614 p
->fts_instr
= FTS_NOINSTR
;
615 p
->fts_statp
= malloc(sizeof(struct stat
));
616 if (p
->fts_statp
== NULL
) {
620 memcpy(p
->fts_name
, name
, namelen
);
626 fts_lfree(FTSENT
*head
)
630 /* Free a linked list of structures. */
632 head
= head
->fts_link
;
638 * Allow essentially unlimited paths; find, rm, ls should all work on any tree.
639 * Most systems will allow creation of paths much longer than PATH_MAX, even
640 * though the kernel won't resolve them. Add the size (not just what's needed)
641 * plus 256 bytes so don't realloc the path 2 bytes at a time.
644 fts_palloc(FTS
*sp
, size_t more
)
649 * Check for possible wraparound.
652 if (sp
->fts_pathlen
+ more
< sp
->fts_pathlen
) {
655 errno
= ENAMETOOLONG
;
658 sp
->fts_pathlen
+= more
;
659 p
= realloc(sp
->fts_path
, sp
->fts_pathlen
);
670 * When the path is realloc'd, have to fix all of the pointers in structures
674 fts_padjust(FTS
*sp
, FTSENT
*head
)
677 char *addr
= sp
->fts_path
;
679 #define ADJUST(p) { \
680 if ((p)->fts_accpath != (p)->fts_name) { \
682 (char *)addr + ((p)->fts_accpath - (p)->fts_path); \
684 (p)->fts_path = addr; \
686 /* Adjust the current set of children. */
687 for (p
= sp
->fts_child
; p
; p
= p
->fts_link
)
690 /* Adjust the rest of the tree, including the current level. */
691 for (p
= head
; p
->fts_level
>= FTS_ROOTLEVEL
;) {
693 p
= p
->fts_link
? p
->fts_link
: p
->fts_parent
;
698 fts_maxarglen(char * const *argv
)
702 for (max
= 0; *argv
; ++argv
)
703 if ((len
= strlen(*argv
)) > max
)