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