original/man3/ftw.3

   1 .\" Copyright (c) 1993 Michael Haardt (michael@moria.de)
   2 .\" and copyright (c) 1999 Andries Brouwer (aeb@cwi.nl)
   3 .\" and copyright (c) 2006 Justin Pryzby <justinpryzby@users.sf.net>
   4 .\" and copyright (c) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
   5 .\"
   6 .\" This is free documentation; you can redistribute it and/or
   7 .\" modify it under the terms of the GNU General Public License as
   8 .\" published by the Free Software Foundation; either version 2 of
   9 .\" the License, or (at your option) any later version.
  10 .\"
  11 .\" The GNU General Public License's references to "object code"
  12 .\" and "executables" are to be interpreted as the output of any
  13 .\" document formatting or typesetting system, including
  14 .\" intermediate and printed output.
  15 .\"
  16 .\" This manual is distributed in the hope that it will be useful,
  17 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 .\" GNU General Public License for more details.
  20 .\"
  21 .\" You should have received a copy of the GNU General Public
  22 .\" License along with this manual; if not, write to the Free
  23 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  24 .\" USA.
  25 .\"
  26 .\" Modified Sun Jul 25 11:02:22 1993 by Rik Faith (faith@cs.unc.edu)
  27 .\" 2006-05-24, Justin Pryzby <justinpryzby@users.sf.net>
  28 .\"     document FTW_ACTIONRETVAL; include .SH "RETURN VALUE";
  29 .\" 2006-05-24, Justin Pryzby <justinpryzby@users.sf.net> and
  30 .\"     Michael Kerrisk <mtk.manpages@gmail.com>
  31 .\"     reorganized and rewrote much of the page
  32 .\" 2006-05-24, Michael Kerrisk <mtk.manpages@gmail.com>
  33 .\"     Added an example program.
  34 .TH FTW 3 2010-06-10 "Linux" "Linux Programmer's Manual"
  35 .SH NAME
  36 ftw, nftw \- file tree walk
  37 .SH SYNOPSIS
  38 .nf
  39 .B #include <ftw.h>
  40 .sp
  41 .BI "int ftw(const char *" dirpath ,
  42 .BI "        int (*" fn ") (const char *" fpath ", const struct stat *" sb ,
  43 .BI "                   int " typeflag ),
  44 .BI "        int " nopenfd );
  45 .sp
  46 .B #define _XOPEN_SOURCE 500
  47 .B #include <ftw.h>
  48 .sp
  49 .BI "int nftw(const char *" dirpath ,
  50 .BI "        int (*" fn ") (const char *" fpath ", const struct stat *" sb ,
  51 .BI "                   int " typeflag ", struct FTW *" ftwbuf ),
  52 .BI "        int " nopenfd ", int " flags );
  53 .fi
  54 .SH DESCRIPTION
  55 .BR ftw ()
  56 walks through the directory tree that is
  57 located under the directory \fIdirpath\fP,
  58 and calls \fIfn\fP() once for each entry in the tree.
  59 By default, directories are handled before the files and
  60 subdirectories they contain (preorder traversal).
  61
  62 To avoid using up all of the calling process's file descriptors,
  63 \fInopenfd\fP specifies the maximum number of directories that
  64 .BR ftw ()
  65 will hold open simultaneously.
  66 When
  67 the search depth exceeds this,
  68 .BR ftw ()
  69 will become slower because
  70 directories have to be closed and reopened.
  71 .BR ftw ()
  72 uses at most
  73 one file descriptor for each level in the directory tree.
  74
  75 For each entry found in the tree,
  76 .BR ftw ()
  77 calls
  78 \fIfn\fP() with three arguments:
  79 .IR fpath ,
  80 .IR sb ,
  81 and
  82 .IR typeflag .
  83 .I fpath
  84 is the pathname of the entry,
  85 and is expressed either as a pathname relative to the calling process's
  86 current working directory at the time of the call to
  87 .BR ftw (),
  88 if
  89 .IR dirpath
  90 was expressed as a relative pathname,
  91 or as an absolute pathname, if
  92 .I dirpath
  93 was expressed as an absolute pathname.
  94 .I sb
  95 is a pointer to the
  96 .I stat
  97 structure returned by a call to
  98 .BR stat (2)
  99 for
 100 .IR fpath .
 101 .I typeflag
 102 is an integer that has one of the following values:
 103 .TP
 104 .B FTW_F
 105 .I fpath
 106 is a regular file.
 107 .TP
 108 .B FTW_D
 109 .I fpath
 110 is a directory.
 111 .TP
 112 .B FTW_DNR
 113 .I fpath
 114 is a directory which can't be read.
 115 .TP
 116 .B FTW_NS
 117 The
 118 .BR stat (2)
 119 call failed on
 120 .IR fpath ,
 121 which is not a symbolic link.
 122 .sp
 123 If
 124 .I fpath
 125 is a symbolic link and
 126 .BR stat (2)
 127 failed, POSIX.1-2001 states
 128 that it is undefined whether \fBFTW_NS\fP or \fBFTW_SL\fP (see below)
 129 is passed in
 130 .IR typeflag .
 131 .PP
 132 To stop the tree walk, \fIfn\fP() returns a nonzero value; this
 133 value will become the return value of
 134 .BR ftw ().
 135 As long as \fIfn\fP() returns 0,
 136 .BR ftw ()
 137 will continue either until it has traversed the entire tree,
 138 in which case it will return zero,
 139 or until it encounters an error (such as a
 140 .BR malloc (3)
 141 failure), in which case it will return \-1.
 142 .PP
 143 Because
 144 .BR ftw ()
 145 uses dynamic data structures, the only safe way to
 146 exit out of a tree walk is to return a nonzero value from \fIfn\fP().
 147 To allow a signal to terminate the walk without causing a memory leak,
 148 have the handler set a global flag that is checked by \fIfn\fP().
 149 \fIDon't\fP use
 150 .BR longjmp (3)
 151 unless the program is going to terminate.
 152 .SS nftw()
 153 The function
 154 .BR nftw ()
 155 is the same as
 156 .BR ftw (),
 157 except that it has one additional argument, \fIflags\fP,
 158 and calls \fIfn\fP() with one more argument, \fIftwbuf\fP.
 159
 160 This \fIflags\fP argument is formed by ORing zero or more of the
 161 following flags:
 162 .TP
 163 .BR FTW_ACTIONRETVAL " (since glibc 2.3.3)"
 164 If this glibc-specific flag is set, then
 165 .BR nftw ()
 166 handles the return value from
 167 .IR fn ()
 168 differently.
 169 .IR fn ()
 170 should return one of the following values:
 171 .RS
 172 .TP
 173 .B FTW_CONTINUE
 174 Instructs
 175 .BR nftw ()
 176 to continue normally.
 177 .TP
 178 .B FTW_SKIP_SIBLINGS
 179 If \fIfn\fP() returns this value, then
 180 siblings of the current entry will be skipped,
 181 and processing continues in the parent.
 182 .\" If \fBFTW_DEPTH\fP
 183 .\" is set, the entry's parent directory is processed next (with
 184 .\" \fIflag\fP set to \fBFTW_DP\fP).
 185 .TP
 186 .B FTW_SKIP_SUBTREE
 187 If \fIfn\fP() is called with an entry that is a directory
 188 (\fItypeflag\fP is \fBFTW_D\fP), this return
 189 value will prevent objects within that directory from being passed as
 190 arguments to \fIfn\fP().
 191 .BR nftw ()
 192 continues processing with the next sibling of the directory.
 193 .TP
 194 .B FTW_STOP
 195 Causes
 196 .BR nftw ()
 197 to return immediately with the return value
 198 \fBFTW_STOP\fP.
 199 .PP
 200 Other return values could be associated with new actions in the future;
 201 \fIfn\fP() should not return values other than those listed above.
 202
 203 The feature test macro
 204 .B _GNU_SOURCE
 205 must be defined in order to
 206 obtain the definition of \fBFTW_ACTIONRETVAL\fP from \fI<ftw.h>\fP.
 207 .RE
 208 .TP
 209 .B FTW_CHDIR
 210 If set, do a
 211 .BR chdir (2)
 212 to each directory before handling its contents.
 213 This is useful if the program needs to perform some action
 214 in the directory in which \fIfpath\fP resides.
 215 .TP
 216 .B FTW_DEPTH
 217 If set, do a post-order traversal, that is, call \fIfn\fP() for
 218 the directory itself \fIafter\fP handling the contents of the directory
 219 and its subdirectories.
 220 (By default, each directory is handled \fIbefore\fP its contents.)
 221 .TP
 222 .B FTW_MOUNT
 223 If set, stay within the same file system
 224 (i.e., do not cross mount points).
 225 .TP
 226 .B FTW_PHYS
 227 If set, do not follow symbolic links.
 228 (This is what you want.)
 229 If not set, symbolic links are followed, but no file is reported twice.
 230 .sp
 231 If \fBFTW_PHYS\fP is not set, but \fBFTW_DEPTH\fP is set,
 232 then the function
 233 .IR fn ()
 234 is never called for a directory that would be a descendant of itself.
 235 .LP
 236 For each entry in the directory tree,
 237 .BR nftw ()
 238 calls
 239 .IR fn ()
 240 with four arguments.
 241 .I fpath
 242 and
 243 .I sb
 244 are as for
 245 .BR ftw ().
 246 .I typeflag
 247 may receive any of the same values as with
 248 .BR ftw (),
 249 or any of the following values:
 250 .TP
 251 .B FTW_DP
 252 .I fpath
 253 is a directory, and \fBFTW_DEPTH\fP was specified in \fIflags\fP.
 254 All of the files
 255 and subdirectories within \fIfpath\fP have been processed.
 256 .TP
 257 .B FTW_SL
 258 .I fpath
 259 is a symbolic link, and \fBFTW_PHYS\fP was set in \fIflags\fP.
 260 .\" To obtain the definition of this constant from
 261 .\" .IR <ftw.h> ,
 262 .\" either
 263 .\" .B _BSD_SOURCE
 264 .\" must be defined, or
 265 .\" .BR _XOPEN_SOURCE
 266 .\" must be defined with a value of 500 or more.
 267 .TP
 268 .B FTW_SLN
 269 .I fpath
 270 is a symbolic link pointing to a nonexistent file.
 271 (This occurs only if \fBFTW_PHYS\fP is not set.)
 272 .LP
 273 The fourth argument that
 274 .BR nftw ()
 275 supplies when calling
 276 \fIfn\fP()
 277 is a structure of type \fIFTW\fP:
 278 .in +4n
 279 .nf
 280
 281 struct FTW {
 282     int base;
 283     int level;
 284 };
 285
 286 .fi
 287 .in
 288 .I base
 289 is the offset of the filename (i.e., basename component)
 290 in the pathname given in
 291 .IR fpath .
 292 .I level
 293 is the depth of
 294 .I fpath
 295 in the directory tree, relative to the root of the tree
 296 .RI ( dirpath ,
 297 which has depth 0).
 298 .SH "RETURN VALUE"
 299 These functions return 0 on success, and \-1 if an error occurs.
 300
 301 If \fIfn\fP() returns nonzero,
 302 then the tree walk is terminated and the value returned by \fIfn\fP()
 303 is returned as the result of
 304 .BR ftw ()
 305 or
 306 .BR nftw ().
 307
 308 If
 309 .BR nftw ()
 310 is called with the \fBFTW_ACTIONRETVAL\fP flag,
 311 then the only nonzero value that should be used by \fIfn\fP()
 312 to terminate the tree walk is \fBFTW_STOP\fP,
 313 and that value is returned as the result of
 314 .BR nftw ().
 315 .SH "CONFORMING TO"
 316 POSIX.1-2001, SVr4, SUSv1.
 317 POSIX.1-2008 marks
 318 .BR ftw ()
 319 as obsolete.
 320 .SH NOTES
 321 POSIX.1-2001 note that the results are unspecified if
 322 .I fn
 323 does not preserve the current working directory.
 324 .PP
 325 The function
 326 .BR nftw ()
 327 and the use of \fBFTW_SL\fP with
 328 .BR ftw ()
 329 were introduced in SUSv1.
 330 .LP
 331 On some systems
 332 .BR ftw ()
 333 will never use \fBFTW_SL\fP, on other systems \fBFTW_SL\fP occurs only
 334 for symbolic links that do not point to an existing file,
 335 and again on other systems
 336 .BR ftw ()
 337 will use \fBFTW_SL\fP for each symbolic link.
 338 For predictable control, use
 339 .BR nftw ().
 340 .LP
 341 Under Linux, libc4 and libc5 and glibc 2.0.6 will
 342 use \fBFTW_F\fP for all objects (files, symbolic links, FIFOs, etc.)
 343 that can be stat'ed but are not a directory.
 344
 345 The function
 346 .BR nftw ()
 347 is available since glibc 2.1.
 348
 349 \fBFTW_ACTIONRETVAL\fP is glibc-specific.
 350 .SH EXAMPLE
 351 The following program traverses the directory tree under the path named
 352 in its first command-line argument, or under the current directory
 353 if no argument is supplied.
 354 It displays various information about each file.
 355 The second command-line argument can be used to specify characters that
 356 control the value assigned to the \fIflags\fP
 357 argument when calling
 358 .BR nftw ().
 359 .nf
 360
 361 #define _XOPEN_SOURCE 500
 362 #include <ftw.h>
 363 #include <stdio.h>
 364 #include <stdlib.h>
 365 #include <string.h>
 366 #include <stdint.h>
 367
 368 static int
 369 display_info(const char *fpath, const struct stat *sb,
 370              int tflag, struct FTW *ftwbuf)
 371 {
 372     printf("%\-3s %2d %7jd   %\-40s %d %s\\n",
 373         (tflag == FTW_D) ?   "d"   : (tflag == FTW_DNR) ? "dnr" :
 374         (tflag == FTW_DP) ?  "dp"  : (tflag == FTW_F) ?   "f" :
 375         (tflag == FTW_NS) ?  "ns"  : (tflag == FTW_SL) ?  "sl" :
 376         (tflag == FTW_SLN) ? "sln" : "???",
 377         ftwbuf\->level, (intmax_t) sb\->st_size,
 378         fpath, ftwbuf\->base, fpath + ftwbuf\->base);
 379     return 0;           /* To tell nftw() to continue */
 380 }
 381
 382 int
 383 main(int argc, char *argv[])
 384 {
 385     int flags = 0;
 386
 387     if (argc > 2 && strchr(argv[2], \(aqd\(aq) != NULL)
 388         flags |= FTW_DEPTH;
 389     if (argc > 2 && strchr(argv[2], \(aqp\(aq) != NULL)
 390         flags |= FTW_PHYS;
 391
 392     if (nftw((argc < 2) ? "." : argv[1], display_info, 20, flags)
 393             == \-1) {
 394         perror("nftw");
 395         exit(EXIT_FAILURE);
 396     }
 397     exit(EXIT_SUCCESS);
 398 }
 399 .fi
 400 .SH "SEE ALSO"
 401 .BR stat (2),
 402 .BR fts (3),
 403 .BR readdir (3),
 404 .BR feature_test_macros (7)