source: rtems/cpukit/libmisc/shell/fts.c @ 2ad5753

4.104.115
Last change on this file since 2ad5753 was 2ad5753, checked in by Ralf Corsepius <ralf.corsepius@…>, on May 22, 2010 at 4:48:41 PM

2010-05-22 Ralf Corsépius <ralf.corsepius@…>

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