update from main archive 961217
[kopensolaris-gnu/glibc.git] / io / fts.c
1 /*-
2  * Copyright (c) 1990, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33
34 #if defined(LIBC_SCCS) && !defined(lint)
35 static char sccsid[] = "@(#)fts.c       8.2 (Berkeley) 1/2/94";
36 #endif /* LIBC_SCCS and not lint */
37
38 #include <sys/param.h>
39 #include <sys/stat.h>
40 #include <fcntl.h>
41 #include <dirent.h>
42 #include <errno.h>
43 #include <fts.h>
44 #include <stdlib.h>
45 #include <string.h>
46 #include <unistd.h>
47
48
49 /* Largest alignment size needed, minus one.
50    Usually long double is the worst case.  */
51 #ifndef ALIGNBYTES
52 #define ALIGNBYTES      (__alignof__ (long double) - 1)
53 #endif
54 /* Align P to that size.  */
55 #ifndef ALIGN
56 #define ALIGN(p)        (((unsigned long int) (p) + ALIGNBYTES) & ~ALIGNBYTES)
57 #endif
58
59
60 static FTSENT   *fts_alloc __P((FTS *, char *, int));
61 static FTSENT   *fts_build __P((FTS *, int));
62 static void      fts_lfree __P((FTSENT *));
63 static void      fts_load __P((FTS *, FTSENT *));
64 static size_t    fts_maxarglen __P((char * const *));
65 static void      fts_padjust __P((FTS *, void *));
66 static int       fts_palloc __P((FTS *, size_t));
67 static FTSENT   *fts_sort __P((FTS *, FTSENT *, int));
68 static u_short   fts_stat __P((FTS *, FTSENT *, int));
69
70 #ifndef MAX
71 #define MAX(a, b)       ({ __typeof__ (a) _a = (a); \
72                            __typeof__ (b) _b = (b); \
73                            _a > _b ? _a : _b; })
74 #endif
75
76 #define ISDOT(a)        (a[0] == '.' && (!a[1] || a[1] == '.' && !a[2]))
77
78 #define ISSET(opt)      (sp->fts_options & opt)
79 #define SET(opt)        (sp->fts_options |= opt)
80
81 #define CHDIR(sp, path) (!ISSET(FTS_NOCHDIR) && chdir(path))
82 #define FCHDIR(sp, fd)  (!ISSET(FTS_NOCHDIR) && fchdir(fd))
83
84 /* fts_build flags */
85 #define BCHILD          1               /* fts_children */
86 #define BNAMES          2               /* fts_children, names only */
87 #define BREAD           3               /* fts_read */
88
89 FTS *
90 fts_open(argv, options, compar)
91         char * const *argv;
92         register int options;
93         int (*compar) __P((const FTSENT **, const FTSENT **));
94 {
95         register FTS *sp;
96         register FTSENT *p, *root;
97         register int nitems;
98         FTSENT *parent, *tmp;
99         int len;
100
101         /* Options check. */
102         if (options & ~FTS_OPTIONMASK) {
103                 __set_errno (EINVAL);
104                 return (NULL);
105         }
106
107         /* Allocate/initialize the stream */
108         if ((sp = malloc((u_int)sizeof(FTS))) == NULL)
109                 return (NULL);
110         bzero(sp, sizeof(FTS));
111         sp->fts_compar = (int (*) __P((const void *, const void *))) compar;
112         sp->fts_options = options;
113
114         /* Logical walks turn on NOCHDIR; symbolic links are too hard. */
115         if (ISSET(FTS_LOGICAL))
116                 SET(FTS_NOCHDIR);
117
118         /*
119          * Start out with 1K of path space, and enough, in any case,
120          * to hold the user's paths.
121          */
122 #ifndef MAXPATHLEN
123 #define MAXPATHLEN 1024
124 #endif
125         if (fts_palloc(sp, MAX(fts_maxarglen(argv), MAXPATHLEN)))
126                 goto mem1;
127
128         /* Allocate/initialize root's parent. */
129         if ((parent = fts_alloc(sp, "", 0)) == NULL)
130                 goto mem2;
131         parent->fts_level = FTS_ROOTPARENTLEVEL;
132
133         /* Allocate/initialize root(s). */
134         for (root = NULL, nitems = 0; *argv; ++argv, ++nitems) {
135                 /* Don't allow zero-length paths. */
136                 if ((len = strlen(*argv)) == 0) {
137                         __set_errno (ENOENT);
138                         goto mem3;
139                 }
140
141                 p = fts_alloc(sp, *argv, len);
142                 p->fts_level = FTS_ROOTLEVEL;
143                 p->fts_parent = parent;
144                 p->fts_accpath = p->fts_name;
145                 p->fts_info = fts_stat(sp, p, ISSET(FTS_COMFOLLOW));
146
147                 /* Command-line "." and ".." are real directories. */
148                 if (p->fts_info == FTS_DOT)
149                         p->fts_info = FTS_D;
150
151                 /*
152                  * If comparison routine supplied, traverse in sorted
153                  * order; otherwise traverse in the order specified.
154                  */
155                 if (compar) {
156                         p->fts_link = root;
157                         root = p;
158                 } else {
159                         p->fts_link = NULL;
160                         if (root == NULL)
161                                 tmp = root = p;
162                         else {
163                                 tmp->fts_link = p;
164                                 tmp = p;
165                         }
166                 }
167         }
168         if (compar && nitems > 1)
169                 root = fts_sort(sp, root, nitems);
170
171         /*
172          * Allocate a dummy pointer and make fts_read think that we've just
173          * finished the node before the root(s); set p->fts_info to FTS_INIT
174          * so that everything about the "current" node is ignored.
175          */
176         if ((sp->fts_cur = fts_alloc(sp, "", 0)) == NULL)
177                 goto mem3;
178         sp->fts_cur->fts_link = root;
179         sp->fts_cur->fts_info = FTS_INIT;
180
181         /*
182          * If using chdir(2), grab a file descriptor pointing to dot to insure
183          * that we can get back here; this could be avoided for some paths,
184          * but almost certainly not worth the effort.  Slashes, symbolic links,
185          * and ".." are all fairly nasty problems.  Note, if we can't get the
186          * descriptor we run anyway, just more slowly.
187          */
188         if (!ISSET(FTS_NOCHDIR) && (sp->fts_rfd = open(".", O_RDONLY, 0)) < 0)
189                 SET(FTS_NOCHDIR);
190
191         return (sp);
192
193 mem3:   fts_lfree(root);
194         free(parent);
195 mem2:   free(sp->fts_path);
196 mem1:   free(sp);
197         return (NULL);
198 }
199
200 static void
201 fts_load(sp, p)
202         FTS *sp;
203         register FTSENT *p;
204 {
205         register int len;
206         register char *cp;
207
208         /*
209          * Load the stream structure for the next traversal.  Since we don't
210          * actually enter the directory until after the preorder visit, set
211          * the fts_accpath field specially so the chdir gets done to the right
212          * place and the user can access the first node.  From fts_open it's
213          * known that the path will fit.
214          */
215         len = p->fts_pathlen = p->fts_namelen;
216         bcopy(p->fts_name, sp->fts_path, len + 1);
217         if ((cp = rindex(p->fts_name, '/')) && (cp != p->fts_name || cp[1])) {
218                 len = strlen(++cp);
219                 bcopy(cp, p->fts_name, len + 1);
220                 p->fts_namelen = len;
221         }
222         p->fts_accpath = p->fts_path = sp->fts_path;
223         sp->fts_dev = p->fts_dev;
224 }
225
226 int
227 fts_close(sp)
228         FTS *sp;
229 {
230         register FTSENT *freep, *p;
231         int saved_errno;
232
233         /*
234          * This still works if we haven't read anything -- the dummy structure
235          * points to the root list, so we step through to the end of the root
236          * list which has a valid parent pointer.
237          */
238         if (sp->fts_cur) {
239                 for (p = sp->fts_cur; p->fts_level >= FTS_ROOTLEVEL;) {
240                         freep = p;
241                         p = p->fts_link ? p->fts_link : p->fts_parent;
242                         free(freep);
243                 }
244                 free(p);
245         }
246
247         /* Free up child linked list, sort array, path buffer. */
248         if (sp->fts_child)
249                 fts_lfree(sp->fts_child);
250         if (sp->fts_array)
251                 free(sp->fts_array);
252         free(sp->fts_path);
253
254         /* Return to original directory, save errno if necessary. */
255         if (!ISSET(FTS_NOCHDIR)) {
256                 saved_errno = fchdir(sp->fts_rfd) ? errno : 0;
257                 (void)close(sp->fts_rfd);
258         }
259
260         /* Free up the stream pointer. */
261         free(sp);
262
263         /* Set errno and return. */
264         if (!ISSET(FTS_NOCHDIR) && saved_errno) {
265                 __set_errno (saved_errno);
266                 return (-1);
267         }
268         return (0);
269 }
270
271 /*
272  * Special case a root of "/" so that slashes aren't appended which would
273  * cause paths to be written as "//foo".
274  */
275 #define NAPPEND(p)                                                      \
276         (p->fts_level == FTS_ROOTLEVEL && p->fts_pathlen == 1 &&        \
277             p->fts_path[0] == '/' ? 0 : p->fts_pathlen)
278
279 FTSENT *
280 fts_read(sp)
281         register FTS *sp;
282 {
283         register FTSENT *p, *tmp;
284         register int instr;
285         register char *t;
286         int saved_errno;
287
288         /* If finished or unrecoverable error, return NULL. */
289         if (sp->fts_cur == NULL || ISSET(FTS_STOP))
290                 return (NULL);
291
292         /* Set current node pointer. */
293         p = sp->fts_cur;
294
295         /* Save and zero out user instructions. */
296         instr = p->fts_instr;
297         p->fts_instr = FTS_NOINSTR;
298
299         /* Any type of file may be re-visited; re-stat and re-turn. */
300         if (instr == FTS_AGAIN) {
301                 p->fts_info = fts_stat(sp, p, 0);
302                 return (p);
303         }
304
305         /*
306          * Following a symlink -- SLNONE test allows application to see
307          * SLNONE and recover.  If indirecting through a symlink, have
308          * keep a pointer to current location.  If unable to get that
309          * pointer, follow fails.
310          */
311         if (instr == FTS_FOLLOW &&
312             (p->fts_info == FTS_SL || p->fts_info == FTS_SLNONE)) {
313                 p->fts_info = fts_stat(sp, p, 1);
314                 if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR))
315                         if ((p->fts_symfd = open(".", O_RDONLY, 0)) < 0) {
316                                 p->fts_errno = errno;
317                                 p->fts_info = FTS_ERR;
318                         } else
319                                 p->fts_flags |= FTS_SYMFOLLOW;
320                 return (p);
321         }
322
323         /* Directory in pre-order. */
324         if (p->fts_info == FTS_D) {
325                 /* If skipped or crossed mount point, do post-order visit. */
326                 if (instr == FTS_SKIP ||
327                     ISSET(FTS_XDEV) && p->fts_dev != sp->fts_dev) {
328                         if (p->fts_flags & FTS_SYMFOLLOW)
329                                 (void)close(p->fts_symfd);
330                         if (sp->fts_child) {
331                                 fts_lfree(sp->fts_child);
332                                 sp->fts_child = NULL;
333                         }
334                         p->fts_info = FTS_DP;
335                         return (p);
336                 }
337
338                 /* Rebuild if only read the names and now traversing. */
339                 if (sp->fts_child && sp->fts_options & FTS_NAMEONLY) {
340                         sp->fts_options &= ~FTS_NAMEONLY;
341                         fts_lfree(sp->fts_child);
342                         sp->fts_child = NULL;
343                 }
344
345                 /*
346                  * Cd to the subdirectory.
347                  *
348                  * If have already read and now fail to chdir, whack the list
349                  * to make the names come out right, and set the parent errno
350                  * so the application will eventually get an error condition.
351                  * Set the FTS_DONTCHDIR flag so that when we logically change
352                  * directories back to the parent we don't do a chdir.
353                  *
354                  * If haven't read do so.  If the read fails, fts_build sets
355                  * FTS_STOP or the fts_info field of the node.
356                  */
357                 if (sp->fts_child) {
358                         if (CHDIR(sp, p->fts_accpath)) {
359                                 p->fts_errno = errno;
360                                 p->fts_flags |= FTS_DONTCHDIR;
361                                 for (p = sp->fts_child; p; p = p->fts_link)
362                                         p->fts_accpath =
363                                             p->fts_parent->fts_accpath;
364                         }
365                 } else if ((sp->fts_child = fts_build(sp, BREAD)) == NULL) {
366                         if (ISSET(FTS_STOP))
367                                 return (NULL);
368                         return (p);
369                 }
370                 p = sp->fts_child;
371                 sp->fts_child = NULL;
372                 goto name;
373         }
374
375         /* Move to the next node on this level. */
376 next:   tmp = p;
377         if (p = p->fts_link) {
378                 free(tmp);
379
380                 /*
381                  * If reached the top, return to the original directory, and
382                  * load the paths for the next root.
383                  */
384                 if (p->fts_level == FTS_ROOTLEVEL) {
385                         if (!ISSET(FTS_NOCHDIR) && FCHDIR(sp, sp->fts_rfd)) {
386                                 SET(FTS_STOP);
387                                 return (NULL);
388                         }
389                         fts_load(sp, p);
390                         return (sp->fts_cur = p);
391                 }
392
393                 /*
394                  * User may have called fts_set on the node.  If skipped,
395                  * ignore.  If followed, get a file descriptor so we can
396                  * get back if necessary.
397                  */
398                 if (p->fts_instr == FTS_SKIP)
399                         goto next;
400                 if (p->fts_instr == FTS_FOLLOW) {
401                         p->fts_info = fts_stat(sp, p, 1);
402                         if (p->fts_info == FTS_D && !ISSET(FTS_NOCHDIR))
403                                 if ((p->fts_symfd =
404                                     open(".", O_RDONLY, 0)) < 0) {
405                                         p->fts_errno = errno;
406                                         p->fts_info = FTS_ERR;
407                                 } else
408                                         p->fts_flags |= FTS_SYMFOLLOW;
409                         p->fts_instr = FTS_NOINSTR;
410                 }
411
412 name:           t = sp->fts_path + NAPPEND(p->fts_parent);
413                 *t++ = '/';
414                 bcopy(p->fts_name, t, p->fts_namelen + 1);
415                 return (sp->fts_cur = p);
416         }
417
418         /* Move up to the parent node. */
419         p = tmp->fts_parent;
420         free(tmp);
421
422         if (p->fts_level == FTS_ROOTPARENTLEVEL) {
423                 /*
424                  * Done; free everything up and set errno to 0 so the user
425                  * can distinguish between error and EOF.
426                  */
427                 free(p);
428                 __set_errno (0);
429                 return (sp->fts_cur = NULL);
430         }
431
432         /* Nul terminate the pathname. */
433         sp->fts_path[p->fts_pathlen] = '\0';
434
435         /*
436          * Return to the parent directory.  If at a root node or came through
437          * a symlink, go back through the file descriptor.  Otherwise, cd up
438          * one directory.
439          */
440         if (p->fts_level == FTS_ROOTLEVEL) {
441                 if (!ISSET(FTS_NOCHDIR) && FCHDIR(sp, sp->fts_rfd)) {
442                         SET(FTS_STOP);
443                         return (NULL);
444                 }
445         } else if (p->fts_flags & FTS_SYMFOLLOW) {
446                 if (FCHDIR(sp, p->fts_symfd)) {
447                         saved_errno = errno;
448                         (void)close(p->fts_symfd);
449                         __set_errno (saved_errno);
450                         SET(FTS_STOP);
451                         return (NULL);
452                 }
453                 (void)close(p->fts_symfd);
454         } else if (!(p->fts_flags & FTS_DONTCHDIR)) {
455                 if (CHDIR(sp, "..")) {
456                         SET(FTS_STOP);
457                         return (NULL);
458                 }
459         }
460         p->fts_info = p->fts_errno ? FTS_ERR : FTS_DP;
461         return (sp->fts_cur = p);
462 }
463
464 /*
465  * Fts_set takes the stream as an argument although it's not used in this
466  * implementation; it would be necessary if anyone wanted to add global
467  * semantics to fts using fts_set.  An error return is allowed for similar
468  * reasons.
469  */
470 /* ARGSUSED */
471 int
472 fts_set(sp, p, instr)
473         FTS *sp;
474         FTSENT *p;
475         int instr;
476 {
477         if (instr && instr != FTS_AGAIN && instr != FTS_FOLLOW &&
478             instr != FTS_NOINSTR && instr != FTS_SKIP) {
479                 __set_errno (EINVAL);
480                 return (1);
481         }
482         p->fts_instr = instr;
483         return (0);
484 }
485
486 FTSENT *
487 fts_children(sp, instr)
488         register FTS *sp;
489         int instr;
490 {
491         register FTSENT *p;
492         int fd;
493
494         if (instr && instr != FTS_NAMEONLY) {
495                 __set_errno (EINVAL);
496                 return (NULL);
497         }
498
499         /* Set current node pointer. */
500         p = sp->fts_cur;
501
502         /*
503          * Errno set to 0 so user can distinguish empty directory from
504          * an error.
505          */
506         __set_errno (0);
507
508         /* Fatal errors stop here. */
509         if (ISSET(FTS_STOP))
510                 return (NULL);
511
512         /* Return logical hierarchy of user's arguments. */
513         if (p->fts_info == FTS_INIT)
514                 return (p->fts_link);
515
516         /*
517          * If not a directory being visited in pre-order, stop here.  Could
518          * allow FTS_DNR, assuming the user has fixed the problem, but the
519          * same effect is available with FTS_AGAIN.
520          */
521         if (p->fts_info != FTS_D /* && p->fts_info != FTS_DNR */)
522                 return (NULL);
523
524         /* Free up any previous child list. */
525         if (sp->fts_child)
526                 fts_lfree(sp->fts_child);
527
528         if (instr == FTS_NAMEONLY) {
529                 sp->fts_options |= FTS_NAMEONLY;
530                 instr = BNAMES;
531         } else
532                 instr = BCHILD;
533
534         /*
535          * If using chdir on a relative path and called BEFORE fts_read does
536          * its chdir to the root of a traversal, we can lose -- we need to
537          * chdir into the subdirectory, and we don't know where the current
538          * directory is, so we can't get back so that the upcoming chdir by
539          * fts_read will work.
540          */
541         if (p->fts_level != FTS_ROOTLEVEL || p->fts_accpath[0] == '/' ||
542             ISSET(FTS_NOCHDIR))
543                 return (sp->fts_child = fts_build(sp, instr));
544
545         if ((fd = open(".", O_RDONLY, 0)) < 0)
546                 return (NULL);
547         sp->fts_child = fts_build(sp, instr);
548         if (fchdir(fd))
549                 return (NULL);
550         (void)close(fd);
551         return (sp->fts_child);
552 }
553
554 /*
555  * This is the tricky part -- do not casually change *anything* in here.  The
556  * idea is to build the linked list of entries that are used by fts_children
557  * and fts_read.  There are lots of special cases.
558  *
559  * The real slowdown in walking the tree is the stat calls.  If FTS_NOSTAT is
560  * set and it's a physical walk (so that symbolic links can't be directories),
561  * we can do things quickly.  First, if it's a 4.4BSD file system, the type
562  * of the file is in the directory entry.  Otherwise, we assume that the number
563  * of subdirectories in a node is equal to the number of links to the parent.
564  * The former skips all stat calls.  The latter skips stat calls in any leaf
565  * directories and for any files after the subdirectories in the directory have
566  * been found, cutting the stat calls by about 2/3.
567  */
568 static FTSENT *
569 fts_build(sp, type)
570         register FTS *sp;
571         int type;
572 {
573         struct dirent *dp;
574         register FTSENT *p, *head;
575         register int nitems;
576         FTSENT *cur, *tail;
577         DIR *dirp;
578         void *adjaddr;
579         int cderrno, descend, len, level, maxlen, nlinks, saved_errno;
580         char *cp;
581
582         /* Set current node pointer. */
583         cur = sp->fts_cur;
584
585         /*
586          * Open the directory for reading.  If this fails, we're done.
587          * If being called from fts_read, set the fts_info field.
588          */
589         if ((dirp = opendir(cur->fts_accpath)) == NULL) {
590                 if (type == BREAD) {
591                         cur->fts_info = FTS_DNR;
592                         cur->fts_errno = errno;
593                 }
594                 return (NULL);
595         }
596
597         /*
598          * Nlinks is the number of possible entries of type directory in the
599          * directory if we're cheating on stat calls, 0 if we're not doing
600          * any stat calls at all, -1 if we're doing stats on everything.
601          */
602         if (type == BNAMES)
603                 nlinks = 0;
604         else if (ISSET(FTS_NOSTAT) && ISSET(FTS_PHYSICAL))
605                 nlinks = cur->fts_nlink - (ISSET(FTS_SEEDOT) ? 0 : 2);
606         else
607                 nlinks = -1;
608
609 #ifdef notdef
610         (void)printf("nlinks == %d (cur: %d)\n", nlinks, cur->fts_nlink);
611         (void)printf("NOSTAT %d PHYSICAL %d SEEDOT %d\n",
612             ISSET(FTS_NOSTAT), ISSET(FTS_PHYSICAL), ISSET(FTS_SEEDOT));
613 #endif
614         /*
615          * If we're going to need to stat anything or we want to descend
616          * and stay in the directory, chdir.  If this fails we keep going,
617          * but set a flag so we don't chdir after the post-order visit.
618          * We won't be able to stat anything, but we can still return the
619          * names themselves.  Note, that since fts_read won't be able to
620          * chdir into the directory, it will have to return different path
621          * names than before, i.e. "a/b" instead of "b".  Since the node
622          * has already been visited in pre-order, have to wait until the
623          * post-order visit to return the error.  There is a special case
624          * here, if there was nothing to stat then it's not an error to
625          * not be able to stat.  This is all fairly nasty.  If a program
626          * needed sorted entries or stat information, they had better be
627          * checking FTS_NS on the returned nodes.
628          */
629         cderrno = 0;
630         if (nlinks || type == BREAD)
631                 if (FCHDIR(sp, dirfd(dirp))) {
632                         if (nlinks && type == BREAD)
633                                 cur->fts_errno = errno;
634                         cur->fts_flags |= FTS_DONTCHDIR;
635                         descend = 0;
636                         cderrno = errno;
637                 } else
638                         descend = 1;
639         else
640                 descend = 0;
641
642         /*
643          * Figure out the max file name length that can be stored in the
644          * current path -- the inner loop allocates more path as necessary.
645          * We really wouldn't have to do the maxlen calculations here, we
646          * could do them in fts_read before returning the path, but it's a
647          * lot easier here since the length is part of the dirent structure.
648          *
649          * If not changing directories set a pointer so that can just append
650          * each new name into the path.
651          */
652         maxlen = sp->fts_pathlen - cur->fts_pathlen - 1;
653         len = NAPPEND(cur);
654         if (ISSET(FTS_NOCHDIR)) {
655                 cp = sp->fts_path + len;
656                 *cp++ = '/';
657         }
658
659         level = cur->fts_level + 1;
660
661         /* Read the directory, attaching each entry to the `link' pointer. */
662         adjaddr = NULL;
663         for (head = tail = NULL, nitems = 0; dp = readdir(dirp);) {
664                 int namlen;
665
666                 if (!ISSET(FTS_SEEDOT) && ISDOT(dp->d_name))
667                         continue;
668
669                 namlen = _D_EXACT_NAMLEN (dp);
670                 if ((p = fts_alloc(sp, dp->d_name, namlen)) == NULL)
671                         goto mem1;
672                 if (namlen > maxlen) {
673                         if (fts_palloc(sp, (size_t)namlen)) {
674                                 /*
675                                  * No more memory for path or structures.  Save
676                                  * errno, free up the current structure and the
677                                  * structures already allocated.
678                                  */
679 mem1:                           saved_errno = errno;
680                                 if (p)
681                                         free(p);
682                                 fts_lfree(head);
683                                 (void)closedir(dirp);
684                                 __set_errno (saved_errno);
685                                 cur->fts_info = FTS_ERR;
686                                 SET(FTS_STOP);
687                                 return (NULL);
688                         }
689                         adjaddr = sp->fts_path;
690                         maxlen = sp->fts_pathlen - sp->fts_cur->fts_pathlen - 1;
691                 }
692
693                 p->fts_pathlen = len + namlen + 1;
694                 p->fts_parent = sp->fts_cur;
695                 p->fts_level = level;
696
697                 if (cderrno) {
698                         if (nlinks) {
699                                 p->fts_info = FTS_NS;
700                                 p->fts_errno = cderrno;
701                         } else
702                                 p->fts_info = FTS_NSOK;
703                         p->fts_accpath = cur->fts_accpath;
704                 } else if (nlinks == 0
705 #ifdef DT_DIR
706                     || nlinks > 0 &&
707                     dp->d_type != DT_DIR && dp->d_type != DT_UNKNOWN
708 #endif
709                     ) {
710                         p->fts_accpath =
711                             ISSET(FTS_NOCHDIR) ? p->fts_path : p->fts_name;
712                         p->fts_info = FTS_NSOK;
713                 } else {
714                         /* Build a file name for fts_stat to stat. */
715                         if (ISSET(FTS_NOCHDIR)) {
716                                 p->fts_accpath = p->fts_path;
717                                 bcopy(p->fts_name, cp, p->fts_namelen + 1);
718                         } else
719                                 p->fts_accpath = p->fts_name;
720                         /* Stat it. */
721                         p->fts_info = fts_stat(sp, p, 0);
722
723                         /* Decrement link count if applicable. */
724                         if (nlinks > 0 && (p->fts_info == FTS_D ||
725                             p->fts_info == FTS_DC || p->fts_info == FTS_DOT))
726                                 --nlinks;
727                 }
728
729                 /* We walk in directory order so "ls -f" doesn't get upset. */
730                 p->fts_link = NULL;
731                 if (head == NULL)
732                         head = tail = p;
733                 else {
734                         tail->fts_link = p;
735                         tail = p;
736                 }
737                 ++nitems;
738         }
739         (void)closedir(dirp);
740
741         /*
742          * If had to realloc the path, adjust the addresses for the rest
743          * of the tree.
744          */
745         if (adjaddr)
746                 fts_padjust(sp, adjaddr);
747
748         /*
749          * If not changing directories, reset the path back to original
750          * state.
751          */
752         if (ISSET(FTS_NOCHDIR)) {
753                 if (cp - 1 > sp->fts_path)
754                         --cp;
755                 *cp = '\0';
756         }
757
758         /*
759          * If descended after called from fts_children or called from
760          * fts_read and didn't find anything, get back.  If can't get
761          * back, done.
762          */
763         if (descend && (!nitems || type == BCHILD) && CHDIR(sp, "..")) {
764                 cur->fts_info = FTS_ERR;
765                 SET(FTS_STOP);
766                 return (NULL);
767         }
768
769         /* If didn't find anything, return NULL. */
770         if (!nitems) {
771                 if (type == BREAD)
772                         cur->fts_info = FTS_DP;
773                 return (NULL);
774         }
775
776         /* Sort the entries. */
777         if (sp->fts_compar && nitems > 1)
778                 head = fts_sort(sp, head, nitems);
779         return (head);
780 }
781
782 static u_short
783 fts_stat(sp, p, follow)
784         FTS *sp;
785         register FTSENT *p;
786         int follow;
787 {
788         register FTSENT *t;
789         register dev_t dev;
790         register ino_t ino;
791         struct stat *sbp, sb;
792         int saved_errno;
793
794         /* If user needs stat info, stat buffer already allocated. */
795         sbp = ISSET(FTS_NOSTAT) ? &sb : p->fts_statp;
796
797         /*
798          * If doing a logical walk, or application requested FTS_FOLLOW, do
799          * a stat(2).  If that fails, check for a non-existent symlink.  If
800          * fail, set the errno from the stat call.
801          */
802         if (ISSET(FTS_LOGICAL) || follow) {
803                 if (stat(p->fts_accpath, sbp)) {
804                         saved_errno = errno;
805                         if (!lstat(p->fts_accpath, sbp)) {
806                                 __set_errno (0);
807                                 return (FTS_SLNONE);
808                         }
809                         p->fts_errno = saved_errno;
810                         goto err;
811                 }
812         } else if (lstat(p->fts_accpath, sbp)) {
813                 p->fts_errno = errno;
814 err:            bzero(sbp, sizeof(struct stat));
815                 return (FTS_NS);
816         }
817
818         if (S_ISDIR(sbp->st_mode)) {
819                 /*
820                  * Set the device/inode.  Used to find cycles and check for
821                  * crossing mount points.  Also remember the link count, used
822                  * in fts_build to limit the number of stat calls.  It is
823                  * understood that these fields are only referenced if fts_info
824                  * is set to FTS_D.
825                  */
826                 dev = p->fts_dev = sbp->st_dev;
827                 ino = p->fts_ino = sbp->st_ino;
828                 p->fts_nlink = sbp->st_nlink;
829
830                 if (ISDOT(p->fts_name))
831                         return (FTS_DOT);
832
833                 /*
834                  * Cycle detection is done by brute force when the directory
835                  * is first encountered.  If the tree gets deep enough or the
836                  * number of symbolic links to directories is high enough,
837                  * something faster might be worthwhile.
838                  */
839                 for (t = p->fts_parent;
840                     t->fts_level >= FTS_ROOTLEVEL; t = t->fts_parent)
841                         if (ino == t->fts_ino && dev == t->fts_dev) {
842                                 p->fts_cycle = t;
843                                 return (FTS_DC);
844                         }
845                 return (FTS_D);
846         }
847         if (S_ISLNK(sbp->st_mode))
848                 return (FTS_SL);
849         if (S_ISREG(sbp->st_mode))
850                 return (FTS_F);
851         return (FTS_DEFAULT);
852 }
853
854 static FTSENT *
855 fts_sort(sp, head, nitems)
856         FTS *sp;
857         FTSENT *head;
858         register int nitems;
859 {
860         register FTSENT **ap, *p;
861
862         /*
863          * Construct an array of pointers to the structures and call qsort(3).
864          * Reassemble the array in the order returned by qsort.  If unable to
865          * sort for memory reasons, return the directory entries in their
866          * current order.  Allocate enough space for the current needs plus
867          * 40 so don't realloc one entry at a time.
868          */
869         if (nitems > sp->fts_nitems) {
870                 sp->fts_nitems = nitems + 40;
871                 if ((sp->fts_array = realloc(sp->fts_array,
872                     (size_t)(sp->fts_nitems * sizeof(FTSENT *)))) == NULL) {
873                         sp->fts_nitems = 0;
874                         return (head);
875                 }
876         }
877         for (ap = sp->fts_array, p = head; p; p = p->fts_link)
878                 *ap++ = p;
879         qsort((void *)sp->fts_array, nitems, sizeof(FTSENT *), sp->fts_compar);
880         for (head = *(ap = sp->fts_array); --nitems; ++ap)
881                 ap[0]->fts_link = ap[1];
882         ap[0]->fts_link = NULL;
883         return (head);
884 }
885
886 static FTSENT *
887 fts_alloc(sp, name, namelen)
888         FTS *sp;
889         char *name;
890         register int namelen;
891 {
892         register FTSENT *p;
893         size_t len;
894
895         /*
896          * The file name is a variable length array and no stat structure is
897          * necessary if the user has set the nostat bit.  Allocate the FTSENT
898          * structure, the file name and the stat structure in one chunk, but
899          * be careful that the stat structure is reasonably aligned.  Since the
900          * fts_name field is declared to be of size 1, the fts_name pointer is
901          * namelen + 2 before the first possible address of the stat structure.
902          */
903         len = sizeof(FTSENT) + namelen;
904         if (!ISSET(FTS_NOSTAT))
905                 len += sizeof(struct stat) + ALIGNBYTES;
906         if ((p = malloc(len)) == NULL)
907                 return (NULL);
908
909         /* Copy the name plus the trailing NULL. */
910         bcopy(name, p->fts_name, namelen + 1);
911
912         if (!ISSET(FTS_NOSTAT))
913                 p->fts_statp = (struct stat *)ALIGN(p->fts_name + namelen + 2);
914         p->fts_namelen = namelen;
915         p->fts_path = sp->fts_path;
916         p->fts_errno = 0;
917         p->fts_flags = 0;
918         p->fts_instr = FTS_NOINSTR;
919         p->fts_number = 0;
920         p->fts_pointer = NULL;
921         return (p);
922 }
923
924 static void
925 fts_lfree(head)
926         register FTSENT *head;
927 {
928         register FTSENT *p;
929
930         /* Free a linked list of structures. */
931         while (p = head) {
932                 head = head->fts_link;
933                 free(p);
934         }
935 }
936
937 /*
938  * Allow essentially unlimited paths; find, rm, ls should all work on any tree.
939  * Most systems will allow creation of paths much longer than MAXPATHLEN, even
940  * though the kernel won't resolve them.  Add the size (not just what's needed)
941  * plus 256 bytes so don't realloc the path 2 bytes at a time.
942  */
943 static int
944 fts_palloc(sp, more)
945         FTS *sp;
946         size_t more;
947 {
948         sp->fts_pathlen += more + 256;
949         sp->fts_path = realloc(sp->fts_path, (size_t)sp->fts_pathlen);
950         return (sp->fts_path == NULL);
951 }
952
953 /*
954  * When the path is realloc'd, have to fix all of the pointers in structures
955  * already returned.
956  */
957 static void
958 fts_padjust(sp, addr)
959         FTS *sp;
960         void *addr;
961 {
962         FTSENT *p;
963
964 #define ADJUST(p) {                                                     \
965         (p)->fts_accpath =                                              \
966             (char *)addr + ((p)->fts_accpath - (p)->fts_path);          \
967         (p)->fts_path = addr;                                           \
968 }
969         /* Adjust the current set of children. */
970         for (p = sp->fts_child; p; p = p->fts_link)
971                 ADJUST(p);
972
973         /* Adjust the rest of the tree. */
974         for (p = sp->fts_cur; p->fts_level >= FTS_ROOTLEVEL;) {
975                 ADJUST(p);
976                 p = p->fts_link ? p->fts_link : p->fts_parent;
977         }
978 }
979
980 static size_t
981 fts_maxarglen(argv)
982         char * const *argv;
983 {
984         size_t len, max;
985
986         for (max = 0; *argv; ++argv)
987                 if ((len = strlen(*argv)) > max)
988                         max = len;
989         return (max);
990 }