master
1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2#ifndef _LINUX_STAT_H
3#define _LINUX_STAT_H
4
5#include <linux/types.h>
6
7#if defined(__KERNEL__) || !defined(__GLIBC__) || (__GLIBC__ < 2)
8
9#define S_IFMT 00170000
10#define S_IFSOCK 0140000
11#define S_IFLNK 0120000
12#define S_IFREG 0100000
13#define S_IFBLK 0060000
14#define S_IFDIR 0040000
15#define S_IFCHR 0020000
16#define S_IFIFO 0010000
17#define S_ISUID 0004000
18#define S_ISGID 0002000
19#define S_ISVTX 0001000
20
21#define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
22#define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
23#define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
24#define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
25#define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
26#define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
27#define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
28
29#define S_IRWXU 00700
30#define S_IRUSR 00400
31#define S_IWUSR 00200
32#define S_IXUSR 00100
33
34#define S_IRWXG 00070
35#define S_IRGRP 00040
36#define S_IWGRP 00020
37#define S_IXGRP 00010
38
39#define S_IRWXO 00007
40#define S_IROTH 00004
41#define S_IWOTH 00002
42#define S_IXOTH 00001
43
44#endif
45
46/*
47 * Timestamp structure for the timestamps in struct statx.
48 *
49 * tv_sec holds the number of seconds before (negative) or after (positive)
50 * 00:00:00 1st January 1970 UTC.
51 *
52 * tv_nsec holds a number of nanoseconds (0..999,999,999) after the tv_sec time.
53 *
54 * __reserved is held in case we need a yet finer resolution.
55 */
56struct statx_timestamp {
57 __s64 tv_sec;
58 __u32 tv_nsec;
59 __s32 __reserved;
60};
61
62/*
63 * Structures for the extended file attribute retrieval system call
64 * (statx()).
65 *
66 * The caller passes a mask of what they're specifically interested in as a
67 * parameter to statx(). What statx() actually got will be indicated in
68 * st_mask upon return.
69 *
70 * For each bit in the mask argument:
71 *
72 * - if the datum is not supported:
73 *
74 * - the bit will be cleared, and
75 *
76 * - the datum will be set to an appropriate fabricated value if one is
77 * available (eg. CIFS can take a default uid and gid), otherwise
78 *
79 * - the field will be cleared;
80 *
81 * - otherwise, if explicitly requested:
82 *
83 * - the datum will be synchronised to the server if AT_STATX_FORCE_SYNC is
84 * set or if the datum is considered out of date, and
85 *
86 * - the field will be filled in and the bit will be set;
87 *
88 * - otherwise, if not requested, but available in approximate form without any
89 * effort, it will be filled in anyway, and the bit will be set upon return
90 * (it might not be up to date, however, and no attempt will be made to
91 * synchronise the internal state first);
92 *
93 * - otherwise the field and the bit will be cleared before returning.
94 *
95 * Items in STATX_BASIC_STATS may be marked unavailable on return, but they
96 * will have values installed for compatibility purposes so that stat() and
97 * co. can be emulated in userspace.
98 */
99struct statx {
100 /* 0x00 */
101 /* What results were written [uncond] */
102 __u32 stx_mask;
103
104 /* Preferred general I/O size [uncond] */
105 __u32 stx_blksize;
106
107 /* Flags conveying information about the file [uncond] */
108 __u64 stx_attributes;
109
110 /* 0x10 */
111 /* Number of hard links */
112 __u32 stx_nlink;
113
114 /* User ID of owner */
115 __u32 stx_uid;
116
117 /* Group ID of owner */
118 __u32 stx_gid;
119
120 /* File mode */
121 __u16 stx_mode;
122 __u16 __spare0[1];
123
124 /* 0x20 */
125 /* Inode number */
126 __u64 stx_ino;
127
128 /* File size */
129 __u64 stx_size;
130
131 /* Number of 512-byte blocks allocated */
132 __u64 stx_blocks;
133
134 /* Mask to show what's supported in stx_attributes */
135 __u64 stx_attributes_mask;
136
137 /* 0x40 */
138 /* Last access time */
139 struct statx_timestamp stx_atime;
140
141 /* File creation time */
142 struct statx_timestamp stx_btime;
143
144 /* Last attribute change time */
145 struct statx_timestamp stx_ctime;
146
147 /* Last data modification time */
148 struct statx_timestamp stx_mtime;
149
150 /* 0x80 */
151 /* Device ID of special file [if bdev/cdev] */
152 __u32 stx_rdev_major;
153 __u32 stx_rdev_minor;
154
155 /* ID of device containing file [uncond] */
156 __u32 stx_dev_major;
157 __u32 stx_dev_minor;
158
159 /* 0x90 */
160 __u64 stx_mnt_id;
161
162 /* Memory buffer alignment for direct I/O */
163 __u32 stx_dio_mem_align;
164
165 /* File offset alignment for direct I/O */
166 __u32 stx_dio_offset_align;
167
168 /* 0xa0 */
169 /* Subvolume identifier */
170 __u64 stx_subvol;
171
172 /* Min atomic write unit in bytes */
173 __u32 stx_atomic_write_unit_min;
174
175 /* Max atomic write unit in bytes */
176 __u32 stx_atomic_write_unit_max;
177
178 /* 0xb0 */
179 /* Max atomic write segment count */
180 __u32 stx_atomic_write_segments_max;
181
182 /* File offset alignment for direct I/O reads */
183 __u32 stx_dio_read_offset_align;
184
185 /* Optimised max atomic write unit in bytes */
186 __u32 stx_atomic_write_unit_max_opt;
187 __u32 __spare2[1];
188
189 /* 0xc0 */
190 __u64 __spare3[8]; /* Spare space for future expansion */
191
192 /* 0x100 */
193};
194
195/*
196 * Flags to be stx_mask
197 *
198 * Query request/result mask for statx() and struct statx::stx_mask.
199 *
200 * These bits should be set in the mask argument of statx() to request
201 * particular items when calling statx().
202 */
203#define STATX_TYPE 0x00000001U /* Want/got stx_mode & S_IFMT */
204#define STATX_MODE 0x00000002U /* Want/got stx_mode & ~S_IFMT */
205#define STATX_NLINK 0x00000004U /* Want/got stx_nlink */
206#define STATX_UID 0x00000008U /* Want/got stx_uid */
207#define STATX_GID 0x00000010U /* Want/got stx_gid */
208#define STATX_ATIME 0x00000020U /* Want/got stx_atime */
209#define STATX_MTIME 0x00000040U /* Want/got stx_mtime */
210#define STATX_CTIME 0x00000080U /* Want/got stx_ctime */
211#define STATX_INO 0x00000100U /* Want/got stx_ino */
212#define STATX_SIZE 0x00000200U /* Want/got stx_size */
213#define STATX_BLOCKS 0x00000400U /* Want/got stx_blocks */
214#define STATX_BASIC_STATS 0x000007ffU /* The stuff in the normal stat struct */
215#define STATX_BTIME 0x00000800U /* Want/got stx_btime */
216#define STATX_MNT_ID 0x00001000U /* Got stx_mnt_id */
217#define STATX_DIOALIGN 0x00002000U /* Want/got direct I/O alignment info */
218#define STATX_MNT_ID_UNIQUE 0x00004000U /* Want/got extended stx_mount_id */
219#define STATX_SUBVOL 0x00008000U /* Want/got stx_subvol */
220#define STATX_WRITE_ATOMIC 0x00010000U /* Want/got atomic_write_* fields */
221#define STATX_DIO_READ_ALIGN 0x00020000U /* Want/got dio read alignment info */
222
223#define STATX__RESERVED 0x80000000U /* Reserved for future struct statx expansion */
224
225/*
226 * This is deprecated, and shall remain the same value in the future. To avoid
227 * confusion please use the equivalent (STATX_BASIC_STATS | STATX_BTIME)
228 * instead.
229 */
230#define STATX_ALL 0x00000fffU
231
232/*
233 * Attributes to be found in stx_attributes and masked in stx_attributes_mask.
234 *
235 * These give information about the features or the state of a file that might
236 * be of use to ordinary userspace programs such as GUIs or ls rather than
237 * specialised tools.
238 *
239 * Note that the flags marked [I] correspond to the FS_IOC_SETFLAGS flags
240 * semantically. Where possible, the numerical value is picked to correspond
241 * also. Note that the DAX attribute indicates that the file is in the CPU
242 * direct access state. It does not correspond to the per-inode flag that
243 * some filesystems support.
244 *
245 */
246#define STATX_ATTR_COMPRESSED 0x00000004 /* [I] File is compressed by the fs */
247#define STATX_ATTR_IMMUTABLE 0x00000010 /* [I] File is marked immutable */
248#define STATX_ATTR_APPEND 0x00000020 /* [I] File is append-only */
249#define STATX_ATTR_NODUMP 0x00000040 /* [I] File is not to be dumped */
250#define STATX_ATTR_ENCRYPTED 0x00000800 /* [I] File requires key to decrypt in fs */
251#define STATX_ATTR_AUTOMOUNT 0x00001000 /* Dir: Automount trigger */
252#define STATX_ATTR_MOUNT_ROOT 0x00002000 /* Root of a mount */
253#define STATX_ATTR_VERITY 0x00100000 /* [I] Verity protected file */
254#define STATX_ATTR_DAX 0x00200000 /* File is currently in DAX state */
255#define STATX_ATTR_WRITE_ATOMIC 0x00400000 /* File supports atomic write operations */
256
257
258#endif /* _LINUX_STAT_H */