annotate lib/fts_.h @ 11925:4934b28baa2b

fts: help ensure that return values are not ignored * lib/fts_.h (__GNUC_PREREQ): Define. (__attribute_warn_unused_result__): Define. (fts_children, fts_close, fts_open, fts_read): Declare with __attribute_warn_unused_result__.
author Jim Meyering <meyering@redhat.com>
date Tue, 01 Sep 2009 11:20:41 +0200
parents 90715da41753
children e8d2c6fc33ad
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
1 /* Traverse a file hierarchy.
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
2
11164
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
3 Copyright (C) 2004-2009 Free Software Foundation, Inc.
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
4
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7797
diff changeset
5 This program is free software: you can redistribute it and/or modify
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7797
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7797
diff changeset
8 (at your option) any later version.
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
9
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
13 GNU General Public License for more details.
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
14
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 7797
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
17
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
18 /*
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
19 * Copyright (c) 1989, 1993
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
20 * The Regents of the University of California. All rights reserved.
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
21 *
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
22 * Redistribution and use in source and binary forms, with or without
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
23 * modification, are permitted provided that the following conditions
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
24 * are met:
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
25 * 1. Redistributions of source code must retain the above copyright
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
26 * notice, this list of conditions and the following disclaimer.
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
27 * 2. Redistributions in binary form must reproduce the above copyright
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
28 * notice, this list of conditions and the following disclaimer in the
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
29 * documentation and/or other materials provided with the distribution.
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
30 * 4. Neither the name of the University nor the names of its contributors
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
31 * may be used to endorse or promote products derived from this software
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
32 * without specific prior written permission.
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
33 *
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
34 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
35 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
36 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
37 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
38 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
39 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
40 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
41 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
42 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
43 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
44 * SUCH DAMAGE.
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
45 *
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
46 * @(#)fts.h 8.3 (Berkeley) 8/14/94
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
47 */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
48
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
49 #ifndef _FTS_H
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
50 # define _FTS_H 1
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
51
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
52 # ifdef _LIBC
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
53 # include <features.h>
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
54 # else
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
55 # undef __THROW
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
56 # define __THROW
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
57 # undef __BEGIN_DECLS
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
58 # define __BEGIN_DECLS
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
59 # undef __END_DECLS
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
60 # define __END_DECLS
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
61 # endif
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
62
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
63 # include <stddef.h>
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
64 # include <sys/types.h>
5867
67b499052f7f * fts.c: Include fts_.h first, to check interface.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5858
diff changeset
65 # include <sys/stat.h>
7639
1670d42131d7 Make fts (in FTS_CWDFD mode) more efficient by caching a few open
Jim Meyering <jim@meyering.net>
parents: 7482
diff changeset
66 # include "i-ring.h"
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
67
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
68 typedef struct {
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
69 struct _ftsent *fts_cur; /* current node */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
70 struct _ftsent *fts_child; /* linked list of children */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
71 struct _ftsent **fts_array; /* sort array */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
72 dev_t fts_dev; /* starting device # */
5907
c47674a83a78 Sync from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5872
diff changeset
73 char *fts_path; /* file name for this descent */
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
74 int fts_rfd; /* fd for root */
7151
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
75 int fts_cwd_fd; /* the file descriptor on which the
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
76 virtual cwd is open, or AT_FDCWD */
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
77 size_t fts_pathlen; /* sizeof(path) */
7151
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
78 size_t fts_nitems; /* elements in the sort array */
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
79 int (*fts_compar) (struct _ftsent const **, struct _ftsent const **);
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
80 /* compare fn */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
81
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
82 # define FTS_COMFOLLOW 0x0001 /* follow command line symlinks */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
83 # define FTS_LOGICAL 0x0002 /* logical walk */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
84 # define FTS_NOCHDIR 0x0004 /* don't change directories */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
85 # define FTS_NOSTAT 0x0008 /* don't get stat info */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
86 # define FTS_PHYSICAL 0x0010 /* physical walk */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
87 # define FTS_SEEDOT 0x0020 /* return dot and dot-dot */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
88 # define FTS_XDEV 0x0040 /* don't cross devices */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
89 # define FTS_WHITEOUT 0x0080 /* return whiteout information */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
90
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
91 /* There are two ways to detect cycles.
6035
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
92 The lazy way (which works only with FTS_PHYSICAL),
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
93 with which one may process a directory that is a
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
94 part of the cycle several times before detecting the cycle.
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
95 The `tight' way, whereby fts uses more memory (proportional
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
96 to number of `active' directories, aka distance from root
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
97 of current tree to current directory -- see active_dir_ht)
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
98 to detect any cycle right away. For example, du must use
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
99 this option to avoid counting disk space in a cycle multiple
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
100 times, but chown -R need not.
6035
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
101 The default is to use the constant-memory lazy way, when possible
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
102 (see below).
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
103
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
104 However, with FTS_LOGICAL (when following symlinks, e.g., chown -L)
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
105 using lazy cycle detection is inadequate. For example, traversing
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
106 a directory containing a symbolic link to a peer directory, it is
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
107 possible to encounter the same directory twice even though there
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
108 is no cycle:
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
109 dir
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
110 ...
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
111 slink -> dir
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
112 So, when FTS_LOGICAL is selected, we have to use a different
a166800910b5 Mention that with FTS_LOGICAL, we use FTS_TIGHT_CYCLE_CHECK.
Jim Meyering <jim@meyering.net>
parents: 5907
diff changeset
113 mode of cycle detection: FTS_TIGHT_CYCLE_CHECK. */
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
114 # define FTS_TIGHT_CYCLE_CHECK 0x0100
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
115
7151
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
116 /* Use this flag to enable semantics with which the parent
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
117 application may be made both more efficient and more robust.
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
118 Whereas the default is to visit each directory in a recursive
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
119 traversal (via chdir), using this flag makes it so the initial
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
120 working directory is never changed. Instead, these functions
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
121 perform the traversal via a virtual working directory, maintained
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
122 through the file descriptor member, fts_cwd_fd. */
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
123 # define FTS_CWDFD 0x0200
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
124
7482
26914593f079 Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents: 7151
diff changeset
125 /* Historically, for each directory that fts initially encounters, it would
26914593f079 Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents: 7151
diff changeset
126 open it, read all entries, and stat each entry, storing the results, and
26914593f079 Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents: 7151
diff changeset
127 then it would process the first entry. But that behavior is bad for
26914593f079 Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents: 7151
diff changeset
128 locality of reference, and also causes trouble with inode-simulating
26914593f079 Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents: 7151
diff changeset
129 file systems like FAT, CIFS, FUSE-based ones, etc., when entries from
26914593f079 Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents: 7151
diff changeset
130 their name/inode cache are flushed too early.
26914593f079 Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents: 7151
diff changeset
131 Use this flag to make fts_open and fts_read defer the stat/lstat/fststat
10317
cf86778a4e1a * lib/fts_.h: Fix grammar (insert a missing "is") in a comment.
Jim Meyering <meyering@redhat.com>
parents: 9309
diff changeset
132 of each entry until it is actually processed. However, note that if you
cf86778a4e1a * lib/fts_.h: Fix grammar (insert a missing "is") in a comment.
Jim Meyering <meyering@redhat.com>
parents: 9309
diff changeset
133 use this option and also specify a comparison function, that function may
10843
36479bd141ee fts: provide dirent.d_type via FTSENT.fts_statp, when possible
Jim Meyering <meyering@redhat.com>
parents: 10317
diff changeset
134 not examine any data via fts_statp. However, when fts_statp->st_mode is
36479bd141ee fts: provide dirent.d_type via FTSENT.fts_statp, when possible
Jim Meyering <meyering@redhat.com>
parents: 10317
diff changeset
135 nonzero, the S_IFMT type bits are valid, with mapped dirent.d_type data.
36479bd141ee fts: provide dirent.d_type via FTSENT.fts_statp, when possible
Jim Meyering <meyering@redhat.com>
parents: 10317
diff changeset
136 Of course, that happens only on file systems that provide useful
36479bd141ee fts: provide dirent.d_type via FTSENT.fts_statp, when possible
Jim Meyering <meyering@redhat.com>
parents: 10317
diff changeset
137 dirent.d_type data. */
7482
26914593f079 Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents: 7151
diff changeset
138 # define FTS_DEFER_STAT 0x0400
26914593f079 Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents: 7151
diff changeset
139
26914593f079 Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents: 7151
diff changeset
140 # define FTS_OPTIONMASK 0x07ff /* valid user option mask */
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
141
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
142 # define FTS_NAMEONLY 0x1000 /* (private) child names only */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
143 # define FTS_STOP 0x2000 /* (private) unrecoverable error */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
144 int fts_options; /* fts_open options, global flags */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
145
7797
10432bdf90d3 2007-01-08 Bruno Haible <bruno@clisp.org>
Bruno Haible <bruno@clisp.org>
parents: 7639
diff changeset
146 # if GNULIB_FTS
11164
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
147 /* Map a directory's device number to a boolean. The boolean is
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
148 true if for that file system (type determined by a single fstatfs
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
149 call per FS) st_nlink can be used to calculate the number of
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
150 sub-directory entries in a directory.
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
151 Using this table is an optimization that permits us to look up
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
152 file system type on a per-inode basis at the minimal cost of
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
153 calling fstatfs only once per traversed device. */
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
154 struct hash_table *fts_leaf_optimization_works_ht;
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
155
5872
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
156 union {
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
157 /* This data structure is used if FTS_TIGHT_CYCLE_CHECK is
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
158 specified. It records the directories between a starting
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
159 point and the current directory. I.e., a directory is
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
160 recorded here IFF we have visited it once, but we have not
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
161 yet completed processing of all its entries. Every time we
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
162 visit a new directory, we add that directory to this set.
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
163 When we finish with a directory (usually by visiting it a
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
164 second time), we remove it from this set. Each entry in
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
165 this data structure is a device/inode pair. This data
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
166 structure is used to detect directory cycles efficiently and
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
167 promptly even when the depth of a hierarchy is in the tens
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
168 of thousands. */
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
169 struct hash_table *ht;
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
170
7151
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
171 /* FIXME: rename these two members to have the fts_ prefix */
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
172 /* This data structure uses a lazy cycle-detection algorithm,
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
173 as done by rm via cycle-check.c. It's the default,
43e3888c56c4 Update from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 6035
diff changeset
174 but it's not appropriate for programs like du. */
5872
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
175 struct cycle_check_state *state;
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
176 } fts_cycle;
7639
1670d42131d7 Make fts (in FTS_CWDFD mode) more efficient by caching a few open
Jim Meyering <jim@meyering.net>
parents: 7482
diff changeset
177
5872
fab6701e5cb2 New fts module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5867
diff changeset
178 # endif
7639
1670d42131d7 Make fts (in FTS_CWDFD mode) more efficient by caching a few open
Jim Meyering <jim@meyering.net>
parents: 7482
diff changeset
179 /* A stack of the file descriptors corresponding to the
1670d42131d7 Make fts (in FTS_CWDFD mode) more efficient by caching a few open
Jim Meyering <jim@meyering.net>
parents: 7482
diff changeset
180 most-recently traversed parent directories.
1670d42131d7 Make fts (in FTS_CWDFD mode) more efficient by caching a few open
Jim Meyering <jim@meyering.net>
parents: 7482
diff changeset
181 Currently used only in FTS_CWDFD mode. */
1670d42131d7 Make fts (in FTS_CWDFD mode) more efficient by caching a few open
Jim Meyering <jim@meyering.net>
parents: 7482
diff changeset
182 I_ring fts_fd_ring;
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
183 } FTS;
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
184
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
185 typedef struct _ftsent {
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
186 struct _ftsent *fts_cycle; /* cycle node */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
187 struct _ftsent *fts_parent; /* parent directory */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
188 struct _ftsent *fts_link; /* next file in directory */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
189 long fts_number; /* local numeric value */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
190 void *fts_pointer; /* local address value */
5907
c47674a83a78 Sync from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5872
diff changeset
191 char *fts_accpath; /* access file name */
c47674a83a78 Sync from coreutils.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5872
diff changeset
192 char *fts_path; /* root name; == fts_fts->fts_path */
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
193 int fts_errno; /* errno for this node */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
194 int fts_symfd; /* fd for symlink */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
195 size_t fts_pathlen; /* strlen(fts_path) */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
196
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
197 FTS *fts_fts; /* the file hierarchy itself */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
198
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
199 # define FTS_ROOTPARENTLEVEL (-1)
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
200 # define FTS_ROOTLEVEL 0
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
201 ptrdiff_t fts_level; /* depth (-1 to N) */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
202
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
203 size_t fts_namelen; /* strlen(fts_name) */
11164
90715da41753 fts: arrange not to stat non-directories in more cases
Jim Meyering <meyering@redhat.com>
parents: 10843
diff changeset
204 nlink_t fts_n_dirs_remaining; /* count down from st_nlink */
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
205
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
206 # define FTS_D 1 /* preorder directory */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
207 # define FTS_DC 2 /* directory that causes cycles */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
208 # define FTS_DEFAULT 3 /* none of the above */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
209 # define FTS_DNR 4 /* unreadable directory */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
210 # define FTS_DOT 5 /* dot or dot-dot */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
211 # define FTS_DP 6 /* postorder directory */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
212 # define FTS_ERR 7 /* error; errno is set */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
213 # define FTS_F 8 /* regular file */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
214 # define FTS_INIT 9 /* initialized only */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
215 # define FTS_NS 10 /* stat(2) failed */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
216 # define FTS_NSOK 11 /* no stat(2) requested */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
217 # define FTS_SL 12 /* symbolic link */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
218 # define FTS_SLNONE 13 /* symbolic link without target */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
219 # define FTS_W 14 /* whiteout object */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
220 unsigned short int fts_info; /* user flags for FTSENT structure */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
221
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
222 # define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
223 # define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
224 unsigned short int fts_flags; /* private flags for FTSENT structure */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
225
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
226 # define FTS_AGAIN 1 /* read node again */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
227 # define FTS_FOLLOW 2 /* follow symbolic link */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
228 # define FTS_NOINSTR 3 /* no instructions */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
229 # define FTS_SKIP 4 /* discard node */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
230 unsigned short int fts_instr; /* fts_set() instructions */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
231
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
232 struct stat fts_statp[1]; /* stat(2) information */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
233 char fts_name[1]; /* file name */
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
234 } FTSENT;
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
235
11925
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
236 #ifndef __GNUC_PREREQ
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
237 # if defined __GNUC__ && defined __GNUC_MINOR__
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
238 # define __GNUC_PREREQ(maj, min) \
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
239 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
240 # else
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
241 # define __GNUC_PREREQ(maj, min) 0
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
242 # endif
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
243 #endif
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
244
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
245 #if __GNUC_PREREQ (3,4)
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
246 # undef __attribute_warn_unused_result__
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
247 # define __attribute_warn_unused_result__ \
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
248 __attribute__ ((__warn_unused_result__))
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
249 #else
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
250 # define __attribute_warn_unused_result__ /* empty */
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
251 #endif
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
252
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
253 __BEGIN_DECLS
11925
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
254 FTSENT *fts_children (FTS *, int) __THROW __attribute_warn_unused_result__;
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
255 int fts_close (FTS *) __THROW __attribute_warn_unused_result__;
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
256 FTS *fts_open (char * const *, int,
11925
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
257 int (*)(const FTSENT **, const FTSENT **))
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
258 __THROW __attribute_warn_unused_result__;
4934b28baa2b fts: help ensure that return values are not ignored
Jim Meyering <meyering@redhat.com>
parents: 11164
diff changeset
259 FTSENT *fts_read (FTS *) __THROW __attribute_warn_unused_result__;
5858
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
260 int fts_set (FTS *, FTSENT *, int) __THROW;
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
261 __END_DECLS
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
262
942c4d17dd7d New files, from coreutils.
Jim Meyering <jim@meyering.net>
parents:
diff changeset
263 #endif /* fts.h */