2 .\" Copyright (c) 2017 David Howells <dhowells@redhat.com>
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>
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.
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.
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
27 .\" Formatted or processed versions of this manual, if unaccompanied by
28 .\" the source, must acknowledge the copyright and authors of this work.
31 .TH STATX 2 2019-03-06 "Linux" "Linux Programmer's Manual"
33 statx \- get file status (extended)
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 */"
41 .BI "int statx(int " dirfd ", const char *" pathname ", int " flags ","
42 .BI " unsigned int " mask ", struct statx *" statxbuf );
47 This function returns information about a file, storing it in the buffer
50 The returned buffer is a structure of the following type:
55 __u32 stx_mask; /* Mask of bits indicating
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
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 */
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 */
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 */
89 The file timestamps are structures of the following type:
93 struct statx_timestamp {
94 __s64 tv_sec; /* Seconds since the Epoch (UNIX time) */
95 __u32 tv_nsec; /* Nanoseconds since tv_sec */
100 (Note that reserved space and padding is omitted.)
102 Invoking \fBstatx\fR():
104 To access a file's status, no permissions are required on the file itself,
108 execute (search) permission is required on all of the directories in
110 that lead to the file.
118 to identify the target file in one of the following ways:
124 then it is an absolute pathname that identifies the target file.
132 is a string that begins with a character other than a slash and
138 is a relative pathname that is interpreted relative to the process's
139 current working directory.
141 A directory-relative pathname
144 is a string that begins with a character other than a slash and
146 is a file descriptor that refers to a directory, then
148 is a relative pathname that is interpreted relative to the directory
155 is an empty string and the
160 then the target file is the one referred to by the file descriptor
164 can be used to influence a pathname-based lookup.
167 is constructed by ORing together zero or more of the following constants:
170 .\" commit 65cfc6722361570bfe255698d9cd4dccaf47570d
173 is an empty string, operate on the file referred to by
175 (which may have been obtained using the
181 can refer to any type of file, not just a directory.
187 the call operates on the current working directory.
189 This flag is Linux-specific; define
191 .\" Before glibc 2.16, defining _ATFILE_SOURCE sufficed
192 to obtain its definition.
195 Don't automount the terminal ("basename") component of
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.
204 flag has no effect if the mount point has already been mounted over.
205 This flag is Linux-specific; define
207 .\" Before glibc 2.16, defining _ATFILE_SOURCE sufficed
208 to obtain its definition.
210 .B AT_SYMLINK_NOFOLLOW
213 is a symbolic link, do not dereference it:
214 instead return information about the link itself, like
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:
222 .B AT_STATX_SYNC_AS_STAT
226 This is the default and is very much filesystem-specific.
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.
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
244 is used to tell the kernel which fields the caller is interested in.
246 is an ORed combination of the following constants:
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]
268 Note that the kernel does
272 other than the above.
273 Instead, it simply informs the caller which values are supported
274 by this kernel and filesystem via the
284 as one or more bits may, in the future, be used to specify an
285 extension to the buffer.
287 The returned information
289 The status information for the target file is returned in the
291 structure pointed to by
295 which indicates what other information has been returned.
297 has the same format as the
299 argument and bits are set in it to indicate
300 which fields have been filled in.
302 It should be noted that the kernel may return fields that weren't
303 requested and may fail to return fields that were requested,
304 depending on what the backing filesystem supports.
305 (Fields that are given values despite being unrequested can just be ignored.)
311 If a filesystem does not support a field or if it has
312 an unrepresentable value (for instance, a file with an exotic type),
313 then the mask bit corresponding to that field will be cleared in
315 even if the user asked for it and a dummy value will be filled in for
316 compatibility purposes if one is available (e.g., a dummy UID and GID may be
317 specified to mount under some circumstances).
319 A filesystem may also fill in fields that the caller didn't ask for if it has
320 values for them available and the information is available at no extra cost.
321 If this happens, the corresponding bits will be set in
324 .\" Background: inode attributes are modified with i_mutex held, but
325 .\" read by stat() without taking the mutex.
327 for performance and simplicity reasons, different fields in the
329 structure may contain state information from different moments
330 during the execution of the system call.
335 is changed by another process by calling
342 together with the new
346 together with the new
351 (which is described above), the fields in the
356 The "preferred" block size for efficient filesystem I/O.
357 (Writing to a file in
358 smaller chunks may cause an inefficient read-modify-rewrite.)
361 Further status information about the file (see below for more information).
364 The number of hard links on a file.
367 This field contains the user ID of the owner of the file.
370 This field contains the ID of the group owner of the file.
373 The file type and mode.
379 The inode number of the file.
382 The size of the file (if it is a regular file or a symbolic link) in bytes.
383 The size of a symbolic link is the length of the pathname it contains,
384 without a terminating null byte.
387 The number of blocks allocated to the file on the medium, in 512-byte units.
388 (This may be smaller than
390 when the file has holes.)
392 .I stx_attributes_mask
393 A mask indicating which bits in
395 are supported by the VFS and the filesystem.
398 The file's last access timestamp.
401 The file's creation timestamp.
404 The file's last status change timestamp.
407 The file's last modification timestamp.
409 .IR stx_dev_major " and " stx_dev_minor
410 The device on which this file (inode) resides.
412 .IR stx_rdev_major " and " stx_rdev_minor
413 The device that this file (inode) represents if the file is of block or
414 character device type.
416 For further information on the above fields, see
423 field contains a set of ORed flags that indicate additional attributes
425 Note that any attribute that is not indicated as supported by
426 .I stx_attributes_mask
427 has no usable value here.
429 .I stx_attributes_mask
430 correspond bit-by-bit to
433 The flags are as follows:
435 .B STATX_ATTR_COMPRESSED
436 The file is compressed by the filesystem and may take extra resources
439 .B STATX_ATTR_IMMUTABLE
440 The file cannot be modified: it cannot be deleted or renamed,
441 no hard links can be created to this file and no data can be written to it.
446 The file can only be opened in append mode for writing.
447 Random access writing
453 File is not a candidate for backup when a backup program such as
459 .B STATX_ATTR_ENCRYPTED
460 A key is required for the file to be encrypted by the filesystem.
462 On success, zero is returned.
463 On error, \-1 is returned, and
465 is set appropriately.
469 Search permission is denied for one of the directories
470 in the path prefix of
473 .BR path_resolution (7).)
477 is not a valid open file descriptor.
483 is NULL or points to a location outside the process's
484 accessible address space.
487 Invalid flag specified in
491 Reserved flag specified in
495 Too many symbolic links encountered while traversing the pathname.
506 is an empty string and
512 Out of memory (i.e., kernel memory).
515 A component of the path prefix of
517 is not a directory or
521 is a file descriptor referring to a file other than a directory.
524 was added to Linux in kernel 4.11; library support was added in glibc 2.28.
537 .BR capabilities (7),