Mercurial > hg > octave-lojdl > gnulib-hg
annotate lib/fts_.h @ 9309:bbbbbf4cd1c5
Change copyright notice from GPLv2+ to GPLv3+.
| author | Bruno Haible <bruno@clisp.org> |
|---|---|
| date | Sun, 07 Oct 2007 19:14:58 +0200 |
| parents | 10432bdf90d3 |
| children | cf86778a4e1a |
| rev | line source |
|---|---|
| 5858 | 1 /* Traverse a file hierarchy. |
| 2 | |
|
7797
10432bdf90d3
2007-01-08 Bruno Haible <bruno@clisp.org>
Bruno Haible <bruno@clisp.org>
parents:
7639
diff
changeset
|
3 Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
| 5858 | 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 | 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 | 9 |
| 10 This program is distributed in the hope that it will be useful, | |
| 11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 13 GNU General Public License for more details. | |
| 14 | |
| 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 | 17 |
| 18 /* | |
| 19 * Copyright (c) 1989, 1993 | |
| 20 * The Regents of the University of California. All rights reserved. | |
| 21 * | |
| 22 * Redistribution and use in source and binary forms, with or without | |
| 23 * modification, are permitted provided that the following conditions | |
| 24 * are met: | |
| 25 * 1. Redistributions of source code must retain the above copyright | |
| 26 * notice, this list of conditions and the following disclaimer. | |
| 27 * 2. Redistributions in binary form must reproduce the above copyright | |
| 28 * notice, this list of conditions and the following disclaimer in the | |
| 29 * documentation and/or other materials provided with the distribution. | |
| 30 * 4. Neither the name of the University nor the names of its contributors | |
| 31 * may be used to endorse or promote products derived from this software | |
| 32 * without specific prior written permission. | |
| 33 * | |
| 34 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
| 35 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 36 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 37 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
| 38 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
| 39 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
| 40 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
| 41 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
| 42 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
| 43 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
| 44 * SUCH DAMAGE. | |
| 45 * | |
| 46 * @(#)fts.h 8.3 (Berkeley) 8/14/94 | |
| 47 */ | |
| 48 | |
| 49 #ifndef _FTS_H | |
| 50 # define _FTS_H 1 | |
| 51 | |
| 52 # ifdef _LIBC | |
| 53 # include <features.h> | |
| 54 # else | |
| 55 # undef __THROW | |
| 56 # define __THROW | |
| 57 # undef __BEGIN_DECLS | |
| 58 # define __BEGIN_DECLS | |
| 59 # undef __END_DECLS | |
| 60 # define __END_DECLS | |
| 61 # endif | |
| 62 | |
| 63 # include <stddef.h> | |
| 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 | 67 |
| 68 typedef struct { | |
| 69 struct _ftsent *fts_cur; /* current node */ | |
| 70 struct _ftsent *fts_child; /* linked list of children */ | |
| 71 struct _ftsent **fts_array; /* sort array */ | |
| 72 dev_t fts_dev; /* starting device # */ | |
| 5907 | 73 char *fts_path; /* file name for this descent */ |
| 5858 | 74 int fts_rfd; /* fd for root */ |
| 7151 | 75 int fts_cwd_fd; /* the file descriptor on which the |
| 76 virtual cwd is open, or AT_FDCWD */ | |
| 5858 | 77 size_t fts_pathlen; /* sizeof(path) */ |
| 7151 | 78 size_t fts_nitems; /* elements in the sort array */ |
| 5858 | 79 int (*fts_compar) (struct _ftsent const **, struct _ftsent const **); |
| 80 /* compare fn */ | |
| 81 | |
| 82 # define FTS_COMFOLLOW 0x0001 /* follow command line symlinks */ | |
| 83 # define FTS_LOGICAL 0x0002 /* logical walk */ | |
| 84 # define FTS_NOCHDIR 0x0004 /* don't change directories */ | |
| 85 # define FTS_NOSTAT 0x0008 /* don't get stat info */ | |
| 86 # define FTS_PHYSICAL 0x0010 /* physical walk */ | |
| 87 # define FTS_SEEDOT 0x0020 /* return dot and dot-dot */ | |
| 88 # define FTS_XDEV 0x0040 /* don't cross devices */ | |
| 89 # define FTS_WHITEOUT 0x0080 /* return whiteout information */ | |
| 90 | |
| 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 | 94 part of the cycle several times before detecting the cycle. |
| 95 The `tight' way, whereby fts uses more memory (proportional | |
| 96 to number of `active' directories, aka distance from root | |
| 97 of current tree to current directory -- see active_dir_ht) | |
| 98 to detect any cycle right away. For example, du must use | |
| 99 this option to avoid counting disk space in a cycle multiple | |
| 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 | 114 # define FTS_TIGHT_CYCLE_CHECK 0x0100 |
| 115 | |
| 7151 | 116 /* Use this flag to enable semantics with which the parent |
| 117 application may be made both more efficient and more robust. | |
| 118 Whereas the default is to visit each directory in a recursive | |
| 119 traversal (via chdir), using this flag makes it so the initial | |
| 120 working directory is never changed. Instead, these functions | |
| 121 perform the traversal via a virtual working directory, maintained | |
| 122 through the file descriptor member, fts_cwd_fd. */ | |
| 123 # define FTS_CWDFD 0x0200 | |
| 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 |
|
26914593f079
Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents:
7151
diff
changeset
|
132 of each entry until it actually processed. However, note that if you use |
|
26914593f079
Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents:
7151
diff
changeset
|
133 this option and also specify a comparison function, that function may not |
|
26914593f079
Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents:
7151
diff
changeset
|
134 examine any data via fts_statp. */ |
|
26914593f079
Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents:
7151
diff
changeset
|
135 # 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
|
136 |
|
26914593f079
Big performance improvement for fts-based tools that use FTS_NOSTAT.
Jim Meyering <jim@meyering.net>
parents:
7151
diff
changeset
|
137 # define FTS_OPTIONMASK 0x07ff /* valid user option mask */ |
| 5858 | 138 |
| 139 # define FTS_NAMEONLY 0x1000 /* (private) child names only */ | |
| 140 # define FTS_STOP 0x2000 /* (private) unrecoverable error */ | |
| 141 int fts_options; /* fts_open options, global flags */ | |
| 142 | |
|
7797
10432bdf90d3
2007-01-08 Bruno Haible <bruno@clisp.org>
Bruno Haible <bruno@clisp.org>
parents:
7639
diff
changeset
|
143 # if GNULIB_FTS |
| 5872 | 144 union { |
| 145 /* This data structure is used if FTS_TIGHT_CYCLE_CHECK is | |
| 146 specified. It records the directories between a starting | |
| 147 point and the current directory. I.e., a directory is | |
| 148 recorded here IFF we have visited it once, but we have not | |
| 149 yet completed processing of all its entries. Every time we | |
| 150 visit a new directory, we add that directory to this set. | |
| 151 When we finish with a directory (usually by visiting it a | |
| 152 second time), we remove it from this set. Each entry in | |
| 153 this data structure is a device/inode pair. This data | |
| 154 structure is used to detect directory cycles efficiently and | |
| 155 promptly even when the depth of a hierarchy is in the tens | |
| 156 of thousands. */ | |
| 157 struct hash_table *ht; | |
| 158 | |
| 7151 | 159 /* FIXME: rename these two members to have the fts_ prefix */ |
| 160 /* This data structure uses a lazy cycle-detection algorithm, | |
| 161 as done by rm via cycle-check.c. It's the default, | |
| 162 but it's not appropriate for programs like du. */ | |
| 5872 | 163 struct cycle_check_state *state; |
| 164 } 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
|
165 |
| 5872 | 166 # 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
|
167 /* 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
|
168 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
|
169 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
|
170 I_ring fts_fd_ring; |
| 5858 | 171 } FTS; |
| 172 | |
| 173 typedef struct _ftsent { | |
| 174 struct _ftsent *fts_cycle; /* cycle node */ | |
| 175 struct _ftsent *fts_parent; /* parent directory */ | |
| 176 struct _ftsent *fts_link; /* next file in directory */ | |
| 177 long fts_number; /* local numeric value */ | |
| 178 void *fts_pointer; /* local address value */ | |
| 5907 | 179 char *fts_accpath; /* access file name */ |
| 180 char *fts_path; /* root name; == fts_fts->fts_path */ | |
| 5858 | 181 int fts_errno; /* errno for this node */ |
| 182 int fts_symfd; /* fd for symlink */ | |
| 183 size_t fts_pathlen; /* strlen(fts_path) */ | |
| 184 | |
| 185 FTS *fts_fts; /* the file hierarchy itself */ | |
| 186 | |
| 187 # define FTS_ROOTPARENTLEVEL (-1) | |
| 188 # define FTS_ROOTLEVEL 0 | |
| 189 ptrdiff_t fts_level; /* depth (-1 to N) */ | |
| 190 | |
| 191 size_t fts_namelen; /* strlen(fts_name) */ | |
| 192 | |
| 193 # define FTS_D 1 /* preorder directory */ | |
| 194 # define FTS_DC 2 /* directory that causes cycles */ | |
| 195 # define FTS_DEFAULT 3 /* none of the above */ | |
| 196 # define FTS_DNR 4 /* unreadable directory */ | |
| 197 # define FTS_DOT 5 /* dot or dot-dot */ | |
| 198 # define FTS_DP 6 /* postorder directory */ | |
| 199 # define FTS_ERR 7 /* error; errno is set */ | |
| 200 # define FTS_F 8 /* regular file */ | |
| 201 # define FTS_INIT 9 /* initialized only */ | |
| 202 # define FTS_NS 10 /* stat(2) failed */ | |
| 203 # define FTS_NSOK 11 /* no stat(2) requested */ | |
| 204 # define FTS_SL 12 /* symbolic link */ | |
| 205 # define FTS_SLNONE 13 /* symbolic link without target */ | |
| 206 # define FTS_W 14 /* whiteout object */ | |
| 207 unsigned short int fts_info; /* user flags for FTSENT structure */ | |
| 208 | |
| 209 # define FTS_DONTCHDIR 0x01 /* don't chdir .. to the parent */ | |
| 210 # define FTS_SYMFOLLOW 0x02 /* followed a symlink to get here */ | |
| 211 unsigned short int fts_flags; /* private flags for FTSENT structure */ | |
| 212 | |
| 213 # define FTS_AGAIN 1 /* read node again */ | |
| 214 # define FTS_FOLLOW 2 /* follow symbolic link */ | |
| 215 # define FTS_NOINSTR 3 /* no instructions */ | |
| 216 # define FTS_SKIP 4 /* discard node */ | |
| 217 unsigned short int fts_instr; /* fts_set() instructions */ | |
| 218 | |
| 219 struct stat fts_statp[1]; /* stat(2) information */ | |
| 220 char fts_name[1]; /* file name */ | |
| 221 } FTSENT; | |
| 222 | |
| 223 __BEGIN_DECLS | |
| 224 FTSENT *fts_children (FTS *, int) __THROW; | |
| 225 int fts_close (FTS *) __THROW; | |
| 226 FTS *fts_open (char * const *, int, | |
| 227 int (*)(const FTSENT **, const FTSENT **)) __THROW; | |
| 228 FTSENT *fts_read (FTS *) __THROW; | |
| 229 int fts_set (FTS *, FTSENT *, int) __THROW; | |
| 230 __END_DECLS | |
| 231 | |
| 232 #endif /* fts.h */ |