lustre/doc/lfs-find.1

   1 .TH lfs-find 1 "2018-01-24" Lustre "user utilities"
   2 .SH NAME
   3 lfs-find \- Lustre client utility to list files with specific attributes
   4 .SH SYNOPSIS
   5 .B lfs find \fR<\fIdirectory\fR|\fIfilename \fR...>
   6       [[\fB!\fR] \fB--atime\fR|\fB-A\fR [\fB-+\fR]\fIn[smhdwy]\fR]
   7 [[\fB!\fR] \fB--blocks\fR|\fB-b\fR [\fB+-\fR]\fIn\fR]
   8       [[\fB!\fR] \fB--btime\fR|\fB--Btime\fR|\fB-B\fR [\fB+-\fR]\fIn[smhdwy]\fR]
   9       [[\fB!\fR] \fB--ctime\fR|\fB-C\fR [\fB+-\fR]\fIn[smhdwy]\fR]
  10       [[\fB!\fR] \fB--component-count|\fB--comp-count\fR [\fB+-\fR]\fIn\fR]
  11       [[\fB!\fR] \fB--component-end|\fB--comp-end\fR|\fB-E\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]]
  12       [[\fB!\fR] \fB--component-flags|\fB--comp-flags\fR <[^]\fIflag\fB,\fR...>]
  13       [[\fB!\fR] \fB--component-start|\fB--comp-start\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]]
  14       [[\fB!\fR] \fB--extension-size|\fB-z\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]]
  15       [[\fB!\fR] \fB--foreign\fR [<\fItype\fR>]]
  16 [[\fB!\fR] \fB--gid\fR|\fB-g\fR|\fB--group\fR|\fB-G\fR <\fIgname\fR>|<\fIgid\fR>]
  17       [[\fB!\fR] \fB--layout\fR|\fB-L mdt\fR,\fBraid0\fR,\fBreleased\fR]
  18 [\fB--lazy\fR]
  19       [\fB--maxdepth\fR|\fB-D\fI n\fR]
  20 [[\fB!\fR] \fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR <\fIuuid\fR|\fIindex\fR,...>]
  21       [[\fB!\fR] \fB--mdt-count\fR|\fB-T\fR [\fB+-\fR]\fIn\fR]
  22 [[\fB!\fR] \fB--mdt-hash\fR|\fB-H \fR<[^]\fIhashflag\fR,[^]\fIhashtype\fR,...>]
  23       [[\fB!\fR] \fB--mirror-count|\fB-N\fR [\fB+-\fR]\fIn\fR]
  24 [[\fB!\fR] \fB--mirror-state\fR <[^]\fIstate\fR>]
  25       [[\fB!\fR] \fB--mtime\fR|\fB-M\fR [\fB-+\fR]\fIn[smhdwy]\fR]
  26 [[\fB!\fR] \fB--name\fR|\fB-n <\fIpattern\fR>]
  27       [[\fB!\fR] \fB--newer\fR[\fBXY\fR] <\fIreference\fR>]
  28       [[\fB!\fR] \fB--ost\fR|\fB-O\fR <\fIindex\fR,...>]
  29       [[\fB!\fR] \fB--perm\fR [\fB/-\fR]<\fImode\fR> ]
  30 [[\fB!\fR] \fB--pool\fR <\fIpool\fR>]
  31 [\fB--print\fR|\fB-P\fR]
  32       [\fB--print0\fR|\fB-0\fR]
  33 [[\fB!\fR] \fB--projid\fR |<\fIprojid\fR>]
  34       [[\fB!\fR] \fB--size|\fB-s\fR [\fB-+\fR]\fIn\fR[\fBKMGTPE\fR]]
  35 [[\fB!\fR] \fB--stripe-count|\fB-c\fR [\fB+-\fR]\fIn\fR]
  36       [[\fB!\fR] \fB--stripe-index|\fB-i\fR \fIn\fR,...]
  37 [[\fB!\fR] \fB--stripe-size|\fB-S\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]]
  38       [[\fB!\fR] \fB--type\fR|\fB-t\fR {\fBbcdflps\fR}]
  39 [[\fB!\fR] \fB--uid\fR|\fB-u\fR|\fB--user\fR|\fB-U
  40 <\fIuname\fR>|<\fIuid>\fR]
  41 .SH DESCRIPTION
  42 .B lfs find
  43 is similar to the standard
  44 .BR find (1)
  45 utility and is used to list files and directories with specific attributes,
  46 both regular POSIX attributes such as ownership, timestamps, and size using
  47 the same options as
  48 .BR find (1),
  49 as well as Lustre-specific attributes such as stripe count and size,
  50 OST and MDT location, and composite layout attributes.
  51 .SH OPTIONS
  52 .TP
  53 .BR --atime | -A
  54 File was last accessed \fIn\fR*24 hours ago (if no units are given),
  55 or \fIn\fR*\fBs\fReconds, \fBm\fRinutes, \fBh\fRours, \fBd\fRays,
  56 \fBw\fReeks, or \fBy\fRears ago within a margin of error of 24h
  57 if no unit is specified.  Multiple units can be specified,
  58 for example \fB8h20m\fR is equivalent to \fB500m\fR.  If multiple units
  59 are specified, the margin of error is based on the smallest unit used, so
  60 .B -atime 3d
  61 has a margin of error of one day, while
  62 .B -atime 72h
  63 has a margin of error of one hour.
  64 .TP
  65 .BR --blocks | -b
  66 Blocks allocated by the file is \fIn\fR Kibibytes (if no units are given),
  67 \fIn\fR 512-byte \fBb\fRlocks, or \fBK\fRibi-, \fBM\fRebi-, \fBG\fRibi-,
  68 \fBT\fRebi-, \fBP\fRebi-, or \fBE\fRbi-bytes if that suffix is given.
  69 .TP
  70 .BR --btime | --Btime | -B
  71 File was created \fIn\fR*24 hours ago, see
  72 --atime
  73 for full details and options.
  74 .TP
  75 .BR --ctime | -C
  76 File's status was last changed \fIn\fR*24 hours ago, see
  77 --atime
  78 for full details and options.
  79 .TP
  80 .BR --component-count | --comp-count
  81 The file has \fIn\fR components in its layout.
  82 .TP
  83 .BR --component-end | --comp-end
  84 The file has component end offset \fIn\fR (in bytes) for any component.
  85 .TP
  86 .BR --component-flags | --comp-flags
  87 The file has components with the specified
  88 .I flag
  89 set.  If
  90 .BI ^ flag
  91 is used, print only components not matching
  92 .IR flag .
  93 Multiple flags can be specified, separated by commas.  Valid flag names are:
  94 .RS 1.2i
  95 .TP
  96 .B init
  97 Component has been initialized (has allocated OST objects).
  98 .TP
  99 .B stale
 100 Replicated (mirrored) components that do not have up-to-date data.  Stale
 101 components will not be used for read or write operations, and need to be
 102 resynched using
 103 .B lfs mirror resync
 104 before they can be accessed again.
 105 .TP
 106 .B prefer
 107 Replicated (mirrored) components that are preferred for read or write.
 108 For example, because they are located on SSD-based OSTs, or are more
 109 local on the network to clients.
 110 .RE
 111 .TP
 112 .BR --component-start | --comp-start
 113 The file has component start offset \fIn\fR (in bytes) for any component.
 114 .TP
 115 .BR --foreign
 116 File has a foreign (non-Lustre/free format) layout and is of the given
 117 .IR type ,
 118 if specified.  Presently only
 119 .B none
 120 or
 121 .B symlink
 122 are defined types, though 32-bit numeric types can also be used.
 123 .TP
 124 .BR --gid | -g
 125 File has specified numeric group ID.
 126 .TP
 127 .BR --group | -G
 128 File belongs to specified group, numeric group ID allowed.
 129 .TP
 130 .BR --layout | -L
 131 File has a layout of the given type, one of:
 132 .RS 1.2i
 133 .TP
 134 .B raid0
 135 Traditional Lustre RAID-0 striping format.
 136 .TP
 137 .B released
 138 HSM-archived files that are not resident in the filesystem.
 139 .TP
 140 .B mdt
 141 Files that have the first data component on an MDT.
 142 .RE
 143 .TP
 144 .BR --lazy
 145 Use file size and blocks from MDT, if available, to avoid extra RPCs.
 146 .TP
 147 .BR --maxdepth
 148 Limits find to decend at most \fIn\fR levels of directory tree.
 149 .TP
 150 .BR --mdt | --mdt-index | -m
 151 File or directory inode is located on the specified MDT(s).
 152 .TP
 153 .BR --mdt-hash | -H
 154 DNE striped directory uses the given filename hashing function, one of:
 155 .RS 1.2i
 156 .TP
 157 .B crush
 158 The CRUSH consistent hash function, added in Lustre 2.14, minimizes
 159 entry migration if the directory stripe count changes during migration.
 160 .TP
 161 .B fnv_1a_64
 162 The Fowler\-Noll\-Vo hash function, which is a simple and efficient hash.
 163 .TP
 164 .B all_char
 165 Simple hash function that sums all of the characters in the filename.
 166 This is mostly for testing, or if it is known that filenames will use
 167 sequential filenames.
 168 .RE
 169 This implicitly selects only directories to be matched, like
 170 .B -type d
 171 and not other file types.
 172 .TP
 173 .BR --mdt-count | -T
 174 The DNE striped directory has the given number of MDT shards.  This
 175 implicitly selects only directories to be matched, like
 176 .B -type d
 177 and not other file types.
 178 .TP
 179 .BR --mirror-count | -N
 180 The file has \fIn\fR mirrors in its layout.
 181 .TP
 182 .BR --mirror-state
 183 The file has a state of
 184 .I state.
 185 If
 186 .BI ^ state
 187 is used, print only files not matching
 188 .IR state.
 189 Only one state can be specified. Valid state name is:
 190 .RS 1.2i
 191 .TP
 192 .B ro
 193 The mirrored file is in read-only state. All of the mirrors contain
 194 the up-to-date data.
 195 .TP
 196 .B wp
 197 The mirrored file is in a state of being written.
 198 .TP
 199 .B sp
 200 The mirrored file is in a state of being resynchronized.
 201 .RE
 202 .TP
 203 .BR --mtime | -M
 204 File's data was last modified \fIn\fR*24 hours ago, see
 205 --atime
 206 for full details and options.
 207 .TP
 208 .BR --name | -n
 209 Filename matches the given filename, or regular expression using
 210 standard
 211 .BR glob (7)
 212 file name regular expressions and wildcards.
 213 .TP
 214 .BR --newer [ XY "] " \fIreference
 215 Succeeds if timestamp \fIX\fR of the file being considered is newer
 216 than timestamp \fIY\fR of the file
 217 .IR reference .
 218 The letters \fIX\fR and \fIY\fR can be any of the following letters:
 219
 220 .TS
 221 ll
 222 ll
 223 ll
 224 ll
 225 llw(2i).
 226 a       The access time of the file \fIreference\fR
 227 b|B     The birth time of the file \fIreference\fR
 228 c       The inode status change time of \fIreference\fR
 229 m       The modification time of the file \fIreference\fR
 230 t       \fIreference\fR is interpreted directly as a time
 231 .TE
 232
 233 Some combinations are invalid; for example, it is invalid for
 234 .I X
 235 to be
 236 .IR t .
 237 Specifying
 238 .B -newer
 239 is equivalent to
 240 .BR -newermm .
 241 When
 242 .IR reference
 243 is interpreted directly as a time, currently it must be in one of the
 244 following formats: "%Y-%m-%d %H:%M:%S", "%Y-%m-%d %H:%M", "%Y-%m-%d",
 245 "%H:%M:%S", "%H:%M", to represent year, month, day, hour, minute, seconds,
 246 with unspecified times at the start of that minute or day, unspecified dates
 247 being "today", and "@%s" or "%s" the seconds since the Unix epoch (see
 248 .BR strftime (3)
 249 for details of the time formats).  Otherwise, it will report an error.
 250 If you try to use the birth time of a reference file, and the birth
 251 time cannot be determined, a fatal error message results.  If you
 252 specify a test which refers to the birth time of files being examined,
 253 this test will fail for any files where the birth time is unknown.
 254 .TP
 255 .BR --ost | -O
 256 File has an object on the specified OST(s).  The OST names can be specified
 257 using the whole OST target name, or just the OST index number. If multiple
 258 OSTs are given in a comma-separated list, the file may have an object on
 259 any of the given OSTs.  Specifying multiple OSTs allows scanning the
 260 filesystem only once when migrating objects off multiple OSTs for evacuation
 261 and replacement using
 262 .BR lfs-migrate (1).
 263 .TP
 264 .BR "--perm \fImode\fR"
 265 File's permission are exactly \fImode\fR (octal or symbolic).
 266 .TP
 267 .BR "--perm /\fImode\fR"
 268 All of the permission bits \fImode\fR are set for the file.
 269 .TP
 270 .BR "--perm -\fImode\fR"
 271 Any of the permission bits \fImode\fR are set for the file. If no permission
 272 bits in \fImode\fR are set, this test matches any file.
 273 .TP
 274 .BR --pool
 275 Layout was created with the specified
 276 .I pool
 277 name.  For composite files, this may match the pool of any component.
 278 .BR --print | -P
 279 Prints the file or directory name to standard output if it matches
 280 all specified parameters, one file per line with a trailing linefeed.
 281 This is the default behaviour for any matching files.
 282 .TP
 283 .BR --print0 | -0
 284 Print full file name to standard output if it matches the specified
 285 parameters, followed by a NUL character.  This is for use together with
 286 .BR xargs (1)
 287 with the
 288 .B -0
 289 option to handle filenames with embedded spaces or other special characters.
 290 .TP
 291 .BR --projid
 292 File has specified numeric project ID.
 293 .TP
 294 .BR --size | -s
 295 File size is \fIn\fR bytes, or \fBK\fRibi-, \fBM\fRebi-,
 296 \fBG\fRibi-, \fBT\fRebi-, \fBP\fRebi-, or \fBE\fRbi-bytes if a
 297 suffix is given.
 298 .TP
 299 .BR --stripe-count | -c
 300 File has \fIn\fR stripes allocated.  For composite files, this
 301 matches the stripe count of the last initialized component.
 302 .TP
 303 .BR --stripe-index | -i
 304 File has stripe on OST index \fIn\fR.  Multiple OST indices can be
 305 specified in a comma-separated list, which indicates that the file
 306 has a stripe on \fIany\fR of the specified OSTs.  This allows a
 307 single namespace scan for files on multiple different OSTs, if there
 308 are multiple OSTs that are being replaced.
 309 .TP
 310 .BR --stripe-size | -S
 311 Stripe size is \fIn\fR bytes, or \fBK\fRibi-, \fBM\fRebi-,
 312 \fBG\fRibi-, \fBT\fRebi-, \fBP\fRebi-, or \fBE\fRbi-abytes if a
 313 suffix is given.  For composite files, this matches the stripe
 314 size of the last initialized non-extension component.
 315 .TP
 316 .BR --extension-size | --ext-size | -z
 317 Extension size is \fIn\fR bytes, or \fBK\fRibi-, \fBM\fRebi-,
 318 \fBG\fRibi-, \fBT\fRebi-, \fBP\fRebi-, or \fBE\fRbi-abytes if a
 319 suffix is given.  For composite files, this matches the extension
 320 size of any extension component.
 321 .TP
 322 .BR --type | -t
 323 File has type: \fBb\fRlock, \fBc\fRharacter, \fBd\fRirectory,
 324 \fBf\fRile, \fBp\fRipe, sym\fBl\fRink, or \fBs\fRocket.
 325 .TP
 326 .BR --uid | -u
 327 File has specified numeric user ID.
 328 .TP
 329 .BR --user | -U
 330 File owned by specified user, numeric user ID also allowed.
 331 .SH NOTES
 332 Specifying \fB!\fR before an option negates its meaning (\fIfiles
 333 NOT matching the parameter\fR). Using \fB+\fR before a numeric
 334 value means 'more than \fIn\fR', while \fB-\fR before a numeric value
 335 means 'less than \fIn\fR'.  If neither is used, it means 'equal to
 336 \fIn\fR', within the bounds of the unit specified (if any).
 337 .PP
 338 Numeric suffixes are in binary SI (power-of-two) units.
 339 .PP
 340 For compatibility with
 341 .BR find (1)
 342 it is possible to specify long options with either a single or double
 343 leading dash.
 344 .PP
 345 The order of parameters does not affect how the files are matched.
 346 .B lfs find
 347 will first scan the directory for any specified filename, and then fetch
 348 MDT inode attributes for each matching filename.  If it can make a
 349 positive or negative decision for a file based only on the MDT attributes
 350 (e.g.  newer than specified time, user/group/project ID) it will not fetch
 351 the OST object attributes for that file.
 352 .SH EXAMPLES
 353 .TP
 354 .B $ lfs find /mnt/lustre
 355 Efficiently lists all files in a given directory and its subdirectories,
 356 without fetching any file attributes.
 357 .TP
 358 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
 359 Recursively list all regular files in given directory more than 30 days old.
 360 .TP
 361 .B $ lfs find /mnt/lustre/test -o OST0002,OST0003 -print0 | lfs_migrate -y
 362 Recursively find all files in
 363 .B test
 364 that have objects on OST0002 or OST0003 and migrate them to other OSTs.  See
 365 .BR lfs_migrate (1)
 366 for more details.
 367 .TP
 368 .B $ lfs find -name "*.mpg" --component-count +3 /mnt/lustre
 369 Recursively list all files ending with
 370 .B .mpg
 371 that have more than 3 components.
 372 .TP
 373 .B $ lfs find --component-flags=init,prefer,^stale /mnt/lustre
 374 Recursively list all files that have at least one component with both 'init'
 375 and 'prefer' flags set, and doesn't have flag 'stale' set.
 376 .TP
 377 .B $ lfs find --mirror-count +2 /mnt/lustre
 378 Recursively list all mirrored files that have more than 2 mirrors.
 379 .TP
 380 .B $ lfs find ! --mirror-state=ro /mnt/lustre
 381 Recursively list all out-of-sync mirrored files.
 382 .TP
 383 .B $ lfs find ! --foreign=symlink /mnt/lustre
 384 Recursively list all but foreign files/dirs of
 385 .B symlink
 386 type.
 387 .SH BUGS
 388 The
 389 .B lfs find
 390 command isn't as comprehensive as
 391 .BR find (1).
 392 In particular, it doesn't support complex boolean expressions with
 393 .B -o
 394 (logical OR), only logical AND of all expressions.  The order that parameters
 395 are specified does not affect how the files are matched.
 396 .SH AUTHOR
 397 The
 398 .B lfs
 399 command is part of the Lustre filesystem.
 400 .SH SEE ALSO
 401 .BR lfs (1),
 402 .BR lfs-getstripe (1),
 403 .BR lfs-getdirstripe (1),
 404 .BR lfs-migrate (1),
 405 .BR lfs_migrate (1),
 406 .BR lustre (7),
 407 .BR xargs (1)