man2/statx.2

   1 '\" t
   2 .\" Copyright (c) 2017 David Howells <dhowells@redhat.com>
   3 .\"
   4 .\" Derived from the stat.2 manual page:
   5 .\"   Copyright (c) 1992 Drew Eckhardt (drew@cs.colorado.edu), March 28, 1992
   6 .\"   Parts Copyright (c) 1995 Nicolai Langfeldt (janl@ifi.uio.no), 1/1/95
   7 .\"   and Copyright (c) 2006, 2007, 2014 Michael Kerrisk <mtk.manpages@gmail.com>
   8 .\"
   9 .\" %%%LICENSE_START(VERBATIM)
  10 .\" Permission is granted to make and distribute verbatim copies of this
  11 .\" manual provided the copyright notice and this permission notice are
  12 .\" preserved on all copies.
  13 .\"
  14 .\" Permission is granted to copy and distribute modified versions of this
  15 .\" manual under the conditions for verbatim copying, provided that the
  16 .\" entire resulting derived work is distributed under the terms of a
  17 .\" permission notice identical to this one.
  18 .\"
  19 .\" Since the Linux kernel and libraries are constantly changing, this
  20 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  21 .\" responsibility for errors or omissions, or for damages resulting from
  22 .\" the use of the information contained herein.  The author(s) may not
  23 .\" have taken the same level of care in the production of this manual,
  24 .\" which is licensed free of charge, as they might when working
  25 .\" professionally.
  26 .\"
  27 .\" Formatted or processed versions of this manual, if unaccompanied by
  28 .\" the source, must acknowledge the copyright and authors of this work.
  29 .\" %%%LICENSE_END
  30 .\"
  31 .TH STATX 2 2020-04-11 "Linux" "Linux Programmer's Manual"
  32 .SH NAME
  33 statx \- get file status (extended)
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <sys/types.h>
  37 .B #include <sys/stat.h>
  38 .B #include <unistd.h>
  39 .BR "#include <fcntl.h>           " "/* Definition of AT_* constants */"
  40 .PP
  41 .BI "int statx(int " dirfd ", const char *" pathname ", int " flags ","
  42 .BI "          unsigned int " mask ", struct statx *" statxbuf );
  43 .fi
  44 .PP
  45 .SH DESCRIPTION
  46 .PP
  47 This function returns information about a file, storing it in the buffer
  48 pointed to by
  49 .IR statxbuf .
  50 The returned buffer is a structure of the following type:
  51 .PP
  52 .in +4n
  53 .EX
  54 struct statx {
  55     __u32 stx_mask;        /* Mask of bits indicating
  56                               filled fields */
  57     __u32 stx_blksize;     /* Block size for filesystem I/O */
  58     __u64 stx_attributes;  /* Extra file attribute indicators */
  59     __u32 stx_nlink;       /* Number of hard links */
  60     __u32 stx_uid;         /* User ID of owner */
  61     __u32 stx_gid;         /* Group ID of owner */
  62     __u16 stx_mode;        /* File type and mode */
  63     __u64 stx_ino;         /* Inode number */
  64     __u64 stx_size;        /* Total size in bytes */
  65     __u64 stx_blocks;      /* Number of 512B blocks allocated */
  66     __u64 stx_attributes_mask;
  67                            /* Mask to show what's supported
  68                               in stx_attributes */
  69
  70     /* The following fields are file timestamps */
  71     struct statx_timestamp stx_atime;  /* Last access */
  72     struct statx_timestamp stx_btime;  /* Creation */
  73     struct statx_timestamp stx_ctime;  /* Last status change */
  74     struct statx_timestamp stx_mtime;  /* Last modification */
  75
  76     /* If this file represents a device, then the next two
  77        fields contain the ID of the device */
  78     __u32 stx_rdev_major;  /* Major ID */
  79     __u32 stx_rdev_minor;  /* Minor ID */
  80
  81     /* The next two fields contain the ID of the device
  82        containing the filesystem where the file resides */
  83     __u32 stx_dev_major;   /* Major ID */
  84     __u32 stx_dev_minor;   /* Minor ID */
  85 };
  86 .EE
  87 .in
  88 .PP
  89 The file timestamps are structures of the following type:
  90 .PP
  91 .in +4n
  92 .EX
  93 struct statx_timestamp {
  94     __s64 tv_sec;    /* Seconds since the Epoch (UNIX time) */
  95     __u32 tv_nsec;   /* Nanoseconds since tv_sec */
  96 };
  97 .EE
  98 .in
  99 .PP
 100 (Note that reserved space and padding is omitted.)
 101 .SS
 102 Invoking \fBstatx\fR():
 103 .PP
 104 To access a file's status, no permissions are required on the file itself,
 105 but in the case of
 106 .BR statx ()
 107 with a pathname,
 108 execute (search) permission is required on all of the directories in
 109 .I pathname
 110 that lead to the file.
 111 .PP
 112 .BR statx ()
 113 uses
 114 .IR pathname ,
 115 .IR dirfd ,
 116 and
 117 .IR flags
 118 to identify the target file in one of the following ways:
 119 .TP
 120 An absolute pathname
 121 If
 122 .I pathname
 123 begins with a slash,
 124 then it is an absolute pathname that identifies the target file.
 125 In this case,
 126 .I dirfd
 127 is ignored.
 128 .TP
 129 A relative pathname
 130 If
 131 .I pathname
 132 is a string that begins with a character other than a slash and
 133 .IR dirfd
 134 is
 135 .BR AT_FDCWD ,
 136 then
 137 .I pathname
 138 is a relative pathname that is interpreted relative to the process's
 139 current working directory.
 140 .TP
 141 A directory-relative pathname
 142 If
 143 .I pathname
 144 is a string that begins with a character other than a slash and
 145 .I dirfd
 146 is a file descriptor that refers to a directory, then
 147 .I pathname
 148 is a relative pathname that is interpreted relative to the directory
 149 referred to by
 150 .IR dirfd .
 151 .TP
 152 By file descriptor
 153 If
 154 .IR pathname
 155 is an empty string and the
 156 .B AT_EMPTY_PATH
 157 flag is specified in
 158 .IR flags
 159 (see below),
 160 then the target file is the one referred to by the file descriptor
 161 .IR dirfd .
 162 .PP
 163 .I flags
 164 can be used to influence a pathname-based lookup.
 165 A value for
 166 .I flags
 167 is constructed by ORing together zero or more of the following constants:
 168 .TP
 169 .BR AT_EMPTY_PATH
 170 .\" commit 65cfc6722361570bfe255698d9cd4dccaf47570d
 171 If
 172 .I pathname
 173 is an empty string, operate on the file referred to by
 174 .IR dirfd
 175 (which may have been obtained using the
 176 .BR open (2)
 177 .B O_PATH
 178 flag).
 179 In this case,
 180 .I dirfd
 181 can refer to any type of file, not just a directory.
 182 .IP
 183 If
 184 .I dirfd
 185 is
 186 .BR AT_FDCWD ,
 187 the call operates on the current working directory.
 188 .IP
 189 This flag is Linux-specific; define
 190 .B _GNU_SOURCE
 191 .\" Before glibc 2.16, defining _ATFILE_SOURCE sufficed
 192 to obtain its definition.
 193 .TP
 194 .BR AT_NO_AUTOMOUNT
 195 Don't automount the terminal ("basename") component of
 196 .I pathname
 197 if it is a directory that is an automount point.
 198 This allows the caller to gather attributes of an automount point
 199 (rather than the location it would mount).
 200 This flag can be used in tools that scan directories
 201 to prevent mass-automounting of a directory of automount points.
 202 The
 203 .B AT_NO_AUTOMOUNT
 204 flag has no effect if the mount point has already been mounted over.
 205 This flag is Linux-specific; define
 206 .B _GNU_SOURCE
 207 .\" Before glibc 2.16, defining _ATFILE_SOURCE sufficed
 208 to obtain its definition.
 209 .TP
 210 .B AT_SYMLINK_NOFOLLOW
 211 If
 212 .I pathname
 213 is a symbolic link, do not dereference it:
 214 instead return information about the link itself, like
 215 .BR lstat (2).
 216 .PP
 217 .I flags
 218 can also be used to control what sort of synchronization the kernel will do
 219 when querying a file on a remote filesystem.
 220 This is done by ORing in one of the following values:
 221 .TP
 222 .B AT_STATX_SYNC_AS_STAT
 223 Do whatever
 224 .BR stat (2)
 225 does.
 226 This is the default and is very much filesystem-specific.
 227 .TP
 228 .B AT_STATX_FORCE_SYNC
 229 Force the attributes to be synchronized with the server.
 230 This may require that
 231 a network filesystem perform a data writeback to get the timestamps correct.
 232 .TP
 233 .B AT_STATX_DONT_SYNC
 234 Don't synchronize anything, but rather just take whatever
 235 the system has cached if possible.
 236 This may mean that the information returned is approximate, but,
 237 on a network filesystem, it may not involve a round trip to the server - even
 238 if no lease is held.
 239 .PP
 240 The
 241 .I mask
 242 argument to
 243 .BR statx ()
 244 is used to tell the kernel which fields the caller is interested in.
 245 .I mask
 246 is an ORed combination of the following constants:
 247 .PP
 248 .in +4n
 249 .TS
 250 lB l.
 251 STATX_TYPE      Want stx_mode & S_IFMT
 252 STATX_MODE      Want stx_mode & ~S_IFMT
 253 STATX_NLINK     Want stx_nlink
 254 STATX_UID       Want stx_uid
 255 STATX_GID       Want stx_gid
 256 STATX_ATIME     Want stx_atime
 257 STATX_MTIME     Want stx_mtime
 258 STATX_CTIME     Want stx_ctime
 259 STATX_INO       Want stx_ino
 260 STATX_SIZE      Want stx_size
 261 STATX_BLOCKS    Want stx_blocks
 262 STATX_BASIC_STATS       [All of the above]
 263 STATX_BTIME     Want stx_btime
 264 STATX_ALL       [All currently available fields]
 265 .TE
 266 .in
 267 .PP
 268 Note that, in general, the kernel does
 269 .I not
 270 reject values in
 271 .I mask
 272 other than the above.
 273 (For an exception, see
 274 .B EINVAL
 275 in errors.)
 276 Instead, it simply informs the caller which values are supported
 277 by this kernel and filesystem via the
 278 .I statx.stx_mask
 279 field.
 280 Therefore,
 281 .I "do not"
 282 simply set
 283 .I mask
 284 to
 285 .B UINT_MAX
 286 (all bits set),
 287 as one or more bits may, in the future, be used to specify an
 288 extension to the buffer.
 289 .SS
 290 The returned information
 291 .PP
 292 The status information for the target file is returned in the
 293 .I statx
 294 structure pointed to by
 295 .IR statxbuf .
 296 Included in this is
 297 .I stx_mask
 298 which indicates what other information has been returned.
 299 .I stx_mask
 300 has the same format as the
 301 .I mask
 302 argument and bits are set in it to indicate
 303 which fields have been filled in.
 304 .PP
 305 It should be noted that the kernel may return fields that weren't
 306 requested and may fail to return fields that were requested,
 307 depending on what the backing filesystem supports.
 308 (Fields that are given values despite being unrequested can just be ignored.)
 309 In either case,
 310 .I stx_mask
 311 will not be equal
 312 .IR mask .
 313 .PP
 314 If a filesystem does not support a field or if it has
 315 an unrepresentable value (for instance, a file with an exotic type),
 316 then the mask bit corresponding to that field will be cleared in
 317 .I stx_mask
 318 even if the user asked for it and a dummy value will be filled in for
 319 compatibility purposes if one is available (e.g., a dummy UID and GID may be
 320 specified to mount under some circumstances).
 321 .PP
 322 A filesystem may also fill in fields that the caller didn't ask for if it has
 323 values for them available and the information is available at no extra cost.
 324 If this happens, the corresponding bits will be set in
 325 .IR stx_mask .
 326 .PP
 327 .\" Background: inode attributes are modified with i_mutex held, but
 328 .\" read by stat() without taking the mutex.
 329 .IR Note :
 330 for performance and simplicity reasons, different fields in the
 331 .I statx
 332 structure may contain state information from different moments
 333 during the execution of the system call.
 334 For example, if
 335 .IR stx_mode
 336 or
 337 .IR stx_uid
 338 is changed by another process by calling
 339 .BR chmod (2)
 340 or
 341 .BR chown (2),
 342 .BR stat ()
 343 might return the old
 344 .I stx_mode
 345 together with the new
 346 .IR stx_uid ,
 347 or the old
 348 .I stx_uid
 349 together with the new
 350 .IR stx_mode .
 351 .PP
 352 Apart from
 353 .I stx_mask
 354 (which is described above), the fields in the
 355 .I statx
 356 structure are:
 357 .TP
 358 .I stx_blksize
 359 The "preferred" block size for efficient filesystem I/O.
 360 (Writing to a file in
 361 smaller chunks may cause an inefficient read-modify-rewrite.)
 362 .TP
 363 .I stx_attributes
 364 Further status information about the file (see below for more information).
 365 .TP
 366 .I stx_nlink
 367 The number of hard links on a file.
 368 .TP
 369 .I stx_uid
 370 This field contains the user ID of the owner of the file.
 371 .TP
 372 .I stx_gid
 373 This field contains the ID of the group owner of the file.
 374 .TP
 375 .I stx_mode
 376 The file type and mode.
 377 See
 378 .BR inode (7)
 379 for details.
 380 .TP
 381 .I stx_ino
 382 The inode number of the file.
 383 .TP
 384 .I stx_size
 385 The size of the file (if it is a regular file or a symbolic link) in bytes.
 386 The size of a symbolic link is the length of the pathname it contains,
 387 without a terminating null byte.
 388 .TP
 389 .I stx_blocks
 390 The number of blocks allocated to the file on the medium, in 512-byte units.
 391 (This may be smaller than
 392 .IR stx_size /512
 393 when the file has holes.)
 394 .TP
 395 .I stx_attributes_mask
 396 A mask indicating which bits in
 397 .IR stx_attributes
 398 are supported by the VFS and the filesystem.
 399 .TP
 400 .I stx_atime
 401 The file's last access timestamp.
 402 .TP
 403 .I stx_btime
 404 The file's creation timestamp.
 405 .TP
 406 .I stx_ctime
 407 The file's last status change timestamp.
 408 .TP
 409 .I stx_mtime
 410 The file's last modification timestamp.
 411 .TP
 412 .IR stx_dev_major " and "  stx_dev_minor
 413 The device on which this file (inode) resides.
 414 .TP
 415 .IR stx_rdev_major " and "  stx_rdev_minor
 416 The device that this file (inode) represents if the file is of block or
 417 character device type.
 418 .PP
 419 For further information on the above fields, see
 420 .BR inode (7).
 421 .\"
 422 .SS File attributes
 423 .PP
 424 The
 425 .I stx_attributes
 426 field contains a set of ORed flags that indicate additional attributes
 427 of the file.
 428 Note that any attribute that is not indicated as supported by
 429 .I stx_attributes_mask
 430 has no usable value here.
 431 The bits in
 432 .I stx_attributes_mask
 433 correspond bit-by-bit to
 434 .IR stx_attributes .
 435 .PP
 436 The flags are as follows:
 437 .TP
 438 .B STATX_ATTR_COMPRESSED
 439 The file is compressed by the filesystem and may take extra resources
 440 to access.
 441 .TP
 442 .B STATX_ATTR_IMMUTABLE
 443 The file cannot be modified: it cannot be deleted or renamed,
 444 no hard links can be created to this file and no data can be written to it.
 445 See
 446 .BR chattr (1).
 447 .TP
 448 .B STATX_ATTR_APPEND
 449 The file can only be opened in append mode for writing.
 450 Random access writing
 451 is not permitted.
 452 See
 453 .BR chattr (1).
 454 .TP
 455 .B STATX_ATTR_NODUMP
 456 File is not a candidate for backup when a backup program such as
 457 .BR dump (8)
 458 is run.
 459 See
 460 .BR chattr (1).
 461 .TP
 462 .B STATX_ATTR_ENCRYPTED
 463 A key is required for the file to be encrypted by the filesystem.
 464 .TP
 465 .BR STATX_ATTR_VERITY " (since Linux 5.5)"
 466 .\" commit 3ad2522c64cff1f5aebb987b00683268f0cc7c29
 467 The file has fs-verity enabled.
 468 It cannot be written to, and all reads from it will be verified
 469 against a cryptographic hash that covers the
 470 entire file (e.g., via a Merkle tree).
 471 .SH RETURN VALUE
 472 On success, zero is returned.
 473 On error, \-1 is returned, and
 474 .I errno
 475 is set appropriately.
 476 .SH ERRORS
 477 .TP
 478 .B EACCES
 479 Search permission is denied for one of the directories
 480 in the path prefix of
 481 .IR pathname .
 482 (See also
 483 .BR path_resolution (7).)
 484 .TP
 485 .B EBADF
 486 .I dirfd
 487 is not a valid open file descriptor.
 488 .TP
 489 .B EFAULT
 490 .I pathname
 491 or
 492 .I statxbuf
 493 is NULL or points to a location outside the process's
 494 accessible address space.
 495 .TP
 496 .B EINVAL
 497 Invalid flag specified in
 498 .IR flags .
 499 .TP
 500 .B EINVAL
 501 Reserved flag specified in
 502 .IR mask .
 503 (Currently, there is one such flag, designated by the constant
 504 .BR STATX__RESERVED ,
 505 with the value 0x80000000U.)
 506 .TP
 507 .B ELOOP
 508 Too many symbolic links encountered while traversing the pathname.
 509 .TP
 510 .B ENAMETOOLONG
 511 .I pathname
 512 is too long.
 513 .TP
 514 .B ENOENT
 515 A component of
 516 .I pathname
 517 does not exist, or
 518 .I pathname
 519 is an empty string and
 520 .B AT_EMPTY_PATH
 521 was not specified in
 522 .IR flags .
 523 .TP
 524 .B ENOMEM
 525 Out of memory (i.e., kernel memory).
 526 .TP
 527 .B ENOTDIR
 528 A component of the path prefix of
 529 .I pathname
 530 is not a directory or
 531 .I pathname
 532 is relative and
 533 .I dirfd
 534 is a file descriptor referring to a file other than a directory.
 535 .SH VERSIONS
 536 .BR statx ()
 537 was added to Linux in kernel 4.11; library support was added in glibc 2.28.
 538 .SH CONFORMING TO
 539 .BR statx ()
 540 is Linux-specific.
 541 .SH SEE ALSO
 542 .BR ls (1),
 543 .BR stat (1),
 544 .BR access (2),
 545 .BR chmod (2),
 546 .BR chown (2),
 547 .BR readlink (2),
 548 .BR stat (2),
 549 .BR utime (2),
 550 .BR capabilities (7),
 551 .BR inode (7),
 552 .BR symlink (7)