Warning: This file is not a C or C++ file. It does not have highlighting.
1 | /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ |
---|---|
2 | #ifndef _UAPI_LINUX_FS_H |
3 | #define _UAPI_LINUX_FS_H |
4 | |
5 | /* |
6 | * This file has definitions for some important file table structures |
7 | * and constants and structures used by various generic file system |
8 | * ioctl's. Please do not make any changes in this file before |
9 | * sending patches for review to linux-fsdevel@vger.kernel.org and |
10 | * linux-api@vger.kernel.org. |
11 | */ |
12 | |
13 | #include <linux/limits.h> |
14 | #include <linux/ioctl.h> |
15 | #include <linux/types.h> |
16 | #ifndef __KERNEL__ |
17 | #include <linux/fscrypt.h> |
18 | #endif |
19 | |
20 | /* Use of MS_* flags within the kernel is restricted to core mount(2) code. */ |
21 | #if !defined(__KERNEL__) |
22 | #include <linux/mount.h> |
23 | #endif |
24 | |
25 | /* |
26 | * It's silly to have NR_OPEN bigger than NR_FILE, but you can change |
27 | * the file limit at runtime and only root can increase the per-process |
28 | * nr_file rlimit, so it's safe to set up a ridiculously high absolute |
29 | * upper limit on files-per-process. |
30 | * |
31 | * Some programs (notably those using select()) may have to be |
32 | * recompiled to take full advantage of the new limits.. |
33 | */ |
34 | |
35 | /* Fixed constants first: */ |
36 | #undef NR_OPEN |
37 | #define INR_OPEN_CUR 1024 /* Initial setting for nfile rlimits */ |
38 | #define INR_OPEN_MAX 4096 /* Hard limit for nfile rlimits */ |
39 | |
40 | #define BLOCK_SIZE_BITS 10 |
41 | #define BLOCK_SIZE (1<<BLOCK_SIZE_BITS) |
42 | |
43 | #define SEEK_SET 0 /* seek relative to beginning of file */ |
44 | #define SEEK_CUR 1 /* seek relative to current file position */ |
45 | #define SEEK_END 2 /* seek relative to end of file */ |
46 | #define SEEK_DATA 3 /* seek to the next data */ |
47 | #define SEEK_HOLE 4 /* seek to the next hole */ |
48 | #define SEEK_MAX SEEK_HOLE |
49 | |
50 | #define RENAME_NOREPLACE (1 << 0) /* Don't overwrite target */ |
51 | #define RENAME_EXCHANGE (1 << 1) /* Exchange source and dest */ |
52 | #define RENAME_WHITEOUT (1 << 2) /* Whiteout source */ |
53 | |
54 | struct file_clone_range { |
55 | __s64 src_fd; |
56 | __u64 src_offset; |
57 | __u64 src_length; |
58 | __u64 dest_offset; |
59 | }; |
60 | |
61 | struct fstrim_range { |
62 | __u64 start; |
63 | __u64 len; |
64 | __u64 minlen; |
65 | }; |
66 | |
67 | /* |
68 | * We include a length field because some filesystems (vfat) have an identifier |
69 | * that we do want to expose as a UUID, but doesn't have the standard length. |
70 | * |
71 | * We use a fixed size buffer beacuse this interface will, by fiat, never |
72 | * support "UUIDs" longer than 16 bytes; we don't want to force all downstream |
73 | * users to have to deal with that. |
74 | */ |
75 | struct fsuuid2 { |
76 | __u8 len; |
77 | __u8 uuid[16]; |
78 | }; |
79 | |
80 | struct fs_sysfs_path { |
81 | __u8 len; |
82 | __u8 name[128]; |
83 | }; |
84 | |
85 | /* extent-same (dedupe) ioctls; these MUST match the btrfs ioctl definitions */ |
86 | #define FILE_DEDUPE_RANGE_SAME 0 |
87 | #define FILE_DEDUPE_RANGE_DIFFERS 1 |
88 | |
89 | /* from struct btrfs_ioctl_file_extent_same_info */ |
90 | struct file_dedupe_range_info { |
91 | __s64 dest_fd; /* in - destination file */ |
92 | __u64 dest_offset; /* in - start of extent in destination */ |
93 | __u64 bytes_deduped; /* out - total # of bytes we were able |
94 | * to dedupe from this file. */ |
95 | /* status of this dedupe operation: |
96 | * < 0 for error |
97 | * == FILE_DEDUPE_RANGE_SAME if dedupe succeeds |
98 | * == FILE_DEDUPE_RANGE_DIFFERS if data differs |
99 | */ |
100 | __s32 status; /* out - see above description */ |
101 | __u32 reserved; /* must be zero */ |
102 | }; |
103 | |
104 | /* from struct btrfs_ioctl_file_extent_same_args */ |
105 | struct file_dedupe_range { |
106 | __u64 src_offset; /* in - start of extent in source */ |
107 | __u64 src_length; /* in - length of extent */ |
108 | __u16 dest_count; /* in - total elements in info array */ |
109 | __u16 reserved1; /* must be zero */ |
110 | __u32 reserved2; /* must be zero */ |
111 | struct file_dedupe_range_info info[]; |
112 | }; |
113 | |
114 | /* And dynamically-tunable limits and defaults: */ |
115 | struct files_stat_struct { |
116 | unsigned long nr_files; /* read only */ |
117 | unsigned long nr_free_files; /* read only */ |
118 | unsigned long max_files; /* tunable */ |
119 | }; |
120 | |
121 | struct inodes_stat_t { |
122 | long nr_inodes; |
123 | long nr_unused; |
124 | long dummy[5]; /* padding for sysctl ABI compatibility */ |
125 | }; |
126 | |
127 | |
128 | #define NR_FILE 8192 /* this can well be larger on a larger system */ |
129 | |
130 | /* |
131 | * Structure for FS_IOC_FSGETXATTR[A] and FS_IOC_FSSETXATTR. |
132 | */ |
133 | struct fsxattr { |
134 | __u32 fsx_xflags; /* xflags field value (get/set) */ |
135 | __u32 fsx_extsize; /* extsize field value (get/set)*/ |
136 | __u32 fsx_nextents; /* nextents field value (get) */ |
137 | __u32 fsx_projid; /* project identifier (get/set) */ |
138 | __u32 fsx_cowextsize; /* CoW extsize field value (get/set)*/ |
139 | unsigned char fsx_pad[8]; |
140 | }; |
141 | |
142 | /* |
143 | * Flags for the fsx_xflags field |
144 | */ |
145 | #define FS_XFLAG_REALTIME 0x00000001 /* data in realtime volume */ |
146 | #define FS_XFLAG_PREALLOC 0x00000002 /* preallocated file extents */ |
147 | #define FS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */ |
148 | #define FS_XFLAG_APPEND 0x00000010 /* all writes append */ |
149 | #define FS_XFLAG_SYNC 0x00000020 /* all writes synchronous */ |
150 | #define FS_XFLAG_NOATIME 0x00000040 /* do not update access time */ |
151 | #define FS_XFLAG_NODUMP 0x00000080 /* do not include in backups */ |
152 | #define FS_XFLAG_RTINHERIT 0x00000100 /* create with rt bit set */ |
153 | #define FS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */ |
154 | #define FS_XFLAG_NOSYMLINKS 0x00000400 /* disallow symlink creation */ |
155 | #define FS_XFLAG_EXTSIZE 0x00000800 /* extent size allocator hint */ |
156 | #define FS_XFLAG_EXTSZINHERIT 0x00001000 /* inherit inode extent size */ |
157 | #define FS_XFLAG_NODEFRAG 0x00002000 /* do not defragment */ |
158 | #define FS_XFLAG_FILESTREAM 0x00004000 /* use filestream allocator */ |
159 | #define FS_XFLAG_DAX 0x00008000 /* use DAX for IO */ |
160 | #define FS_XFLAG_COWEXTSIZE 0x00010000 /* CoW extent size allocator hint */ |
161 | #define FS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */ |
162 | |
163 | /* the read-only stuff doesn't really belong here, but any other place is |
164 | probably as bad and I don't want to create yet another include file. */ |
165 | |
166 | #define BLKROSET _IO(0x12,93) /* set device read-only (0 = read-write) */ |
167 | #define BLKROGET _IO(0x12,94) /* get read-only status (0 = read_write) */ |
168 | #define BLKRRPART _IO(0x12,95) /* re-read partition table */ |
169 | #define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */ |
170 | #define BLKFLSBUF _IO(0x12,97) /* flush buffer cache */ |
171 | #define BLKRASET _IO(0x12,98) /* set read ahead for block device */ |
172 | #define BLKRAGET _IO(0x12,99) /* get current read ahead setting */ |
173 | #define BLKFRASET _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */ |
174 | #define BLKFRAGET _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */ |
175 | #define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */ |
176 | #define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */ |
177 | #define BLKSSZGET _IO(0x12,104)/* get block device sector size */ |
178 | #if 0 |
179 | #define BLKPG _IO(0x12,105)/* See blkpg.h */ |
180 | |
181 | /* Some people are morons. Do not use sizeof! */ |
182 | |
183 | #define BLKELVGET _IOR(0x12,106,size_t)/* elevator get */ |
184 | #define BLKELVSET _IOW(0x12,107,size_t)/* elevator set */ |
185 | /* This was here just to show that the number is taken - |
186 | probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */ |
187 | #endif |
188 | /* A jump here: 108-111 have been used for various private purposes. */ |
189 | #define BLKBSZGET _IOR(0x12,112,size_t) |
190 | #define BLKBSZSET _IOW(0x12,113,size_t) |
191 | #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */ |
192 | #define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup) |
193 | #define BLKTRACESTART _IO(0x12,116) |
194 | #define BLKTRACESTOP _IO(0x12,117) |
195 | #define BLKTRACETEARDOWN _IO(0x12,118) |
196 | #define BLKDISCARD _IO(0x12,119) |
197 | #define BLKIOMIN _IO(0x12,120) |
198 | #define BLKIOOPT _IO(0x12,121) |
199 | #define BLKALIGNOFF _IO(0x12,122) |
200 | #define BLKPBSZGET _IO(0x12,123) |
201 | #define BLKDISCARDZEROES _IO(0x12,124) |
202 | #define BLKSECDISCARD _IO(0x12,125) |
203 | #define BLKROTATIONAL _IO(0x12,126) |
204 | #define BLKZEROOUT _IO(0x12,127) |
205 | #define BLKGETDISKSEQ _IOR(0x12,128,__u64) |
206 | /* |
207 | * A jump here: 130-136 are reserved for zoned block devices |
208 | * (see uapi/linux/blkzoned.h) |
209 | */ |
210 | |
211 | #define BMAP_IOCTL 1 /* obsolete - kept for compatibility */ |
212 | #define FIBMAP _IO(0x00,1) /* bmap access */ |
213 | #define FIGETBSZ _IO(0x00,2) /* get the block size used for bmap */ |
214 | #define FIFREEZE _IOWR('X', 119, int) /* Freeze */ |
215 | #define FITHAW _IOWR('X', 120, int) /* Thaw */ |
216 | #define FITRIM _IOWR('X', 121, struct fstrim_range) /* Trim */ |
217 | #define FICLONE _IOW(0x94, 9, int) |
218 | #define FICLONERANGE _IOW(0x94, 13, struct file_clone_range) |
219 | #define FIDEDUPERANGE _IOWR(0x94, 54, struct file_dedupe_range) |
220 | |
221 | #define FSLABEL_MAX 256 /* Max chars for the interface; each fs may differ */ |
222 | |
223 | #define FS_IOC_GETFLAGS _IOR('f', 1, long) |
224 | #define FS_IOC_SETFLAGS _IOW('f', 2, long) |
225 | #define FS_IOC_GETVERSION _IOR('v', 1, long) |
226 | #define FS_IOC_SETVERSION _IOW('v', 2, long) |
227 | #define FS_IOC_FIEMAP _IOWR('f', 11, struct fiemap) |
228 | #define FS_IOC32_GETFLAGS _IOR('f', 1, int) |
229 | #define FS_IOC32_SETFLAGS _IOW('f', 2, int) |
230 | #define FS_IOC32_GETVERSION _IOR('v', 1, int) |
231 | #define FS_IOC32_SETVERSION _IOW('v', 2, int) |
232 | #define FS_IOC_FSGETXATTR _IOR('X', 31, struct fsxattr) |
233 | #define FS_IOC_FSSETXATTR _IOW('X', 32, struct fsxattr) |
234 | #define FS_IOC_GETFSLABEL _IOR(0x94, 49, char[FSLABEL_MAX]) |
235 | #define FS_IOC_SETFSLABEL _IOW(0x94, 50, char[FSLABEL_MAX]) |
236 | /* Returns the external filesystem UUID, the same one blkid returns */ |
237 | #define FS_IOC_GETFSUUID _IOR(0x15, 0, struct fsuuid2) |
238 | /* |
239 | * Returns the path component under /sys/fs/ that refers to this filesystem; |
240 | * also /sys/kernel/debug/ for filesystems with debugfs exports |
241 | */ |
242 | #define FS_IOC_GETFSSYSFSPATH _IOR(0x15, 1, struct fs_sysfs_path) |
243 | |
244 | /* |
245 | * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS) |
246 | * |
247 | * Note: for historical reasons, these flags were originally used and |
248 | * defined for use by ext2/ext3, and then other file systems started |
249 | * using these flags so they wouldn't need to write their own version |
250 | * of chattr/lsattr (which was shipped as part of e2fsprogs). You |
251 | * should think twice before trying to use these flags in new |
252 | * contexts, or trying to assign these flags, since they are used both |
253 | * as the UAPI and the on-disk encoding for ext2/3/4. Also, we are |
254 | * almost out of 32-bit flags. :-) |
255 | * |
256 | * We have recently hoisted FS_IOC_FSGETXATTR / FS_IOC_FSSETXATTR from |
257 | * XFS to the generic FS level interface. This uses a structure that |
258 | * has padding and hence has more room to grow, so it may be more |
259 | * appropriate for many new use cases. |
260 | * |
261 | * Please do not change these flags or interfaces before checking with |
262 | * linux-fsdevel@vger.kernel.org and linux-api@vger.kernel.org. |
263 | */ |
264 | #define FS_SECRM_FL 0x00000001 /* Secure deletion */ |
265 | #define FS_UNRM_FL 0x00000002 /* Undelete */ |
266 | #define FS_COMPR_FL 0x00000004 /* Compress file */ |
267 | #define FS_SYNC_FL 0x00000008 /* Synchronous updates */ |
268 | #define FS_IMMUTABLE_FL 0x00000010 /* Immutable file */ |
269 | #define FS_APPEND_FL 0x00000020 /* writes to file may only append */ |
270 | #define FS_NODUMP_FL 0x00000040 /* do not dump file */ |
271 | #define FS_NOATIME_FL 0x00000080 /* do not update atime */ |
272 | /* Reserved for compression usage... */ |
273 | #define FS_DIRTY_FL 0x00000100 |
274 | #define FS_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */ |
275 | #define FS_NOCOMP_FL 0x00000400 /* Don't compress */ |
276 | /* End compression flags --- maybe not all used */ |
277 | #define FS_ENCRYPT_FL 0x00000800 /* Encrypted file */ |
278 | #define FS_BTREE_FL 0x00001000 /* btree format dir */ |
279 | #define FS_INDEX_FL 0x00001000 /* hash-indexed directory */ |
280 | #define FS_IMAGIC_FL 0x00002000 /* AFS directory */ |
281 | #define FS_JOURNAL_DATA_FL 0x00004000 /* Reserved for ext3 */ |
282 | #define FS_NOTAIL_FL 0x00008000 /* file tail should not be merged */ |
283 | #define FS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */ |
284 | #define FS_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/ |
285 | #define FS_HUGE_FILE_FL 0x00040000 /* Reserved for ext4 */ |
286 | #define FS_EXTENT_FL 0x00080000 /* Extents */ |
287 | #define FS_VERITY_FL 0x00100000 /* Verity protected inode */ |
288 | #define FS_EA_INODE_FL 0x00200000 /* Inode used for large EA */ |
289 | #define FS_EOFBLOCKS_FL 0x00400000 /* Reserved for ext4 */ |
290 | #define FS_NOCOW_FL 0x00800000 /* Do not cow file */ |
291 | #define FS_DAX_FL 0x02000000 /* Inode is DAX */ |
292 | #define FS_INLINE_DATA_FL 0x10000000 /* Reserved for ext4 */ |
293 | #define FS_PROJINHERIT_FL 0x20000000 /* Create with parents projid */ |
294 | #define FS_CASEFOLD_FL 0x40000000 /* Folder is case insensitive */ |
295 | #define FS_RESERVED_FL 0x80000000 /* reserved for ext2 lib */ |
296 | |
297 | #define FS_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */ |
298 | #define FS_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */ |
299 | |
300 | |
301 | #define SYNC_FILE_RANGE_WAIT_BEFORE 1 |
302 | #define SYNC_FILE_RANGE_WRITE 2 |
303 | #define SYNC_FILE_RANGE_WAIT_AFTER 4 |
304 | #define SYNC_FILE_RANGE_WRITE_AND_WAIT (SYNC_FILE_RANGE_WRITE | \ |
305 | SYNC_FILE_RANGE_WAIT_BEFORE | \ |
306 | SYNC_FILE_RANGE_WAIT_AFTER) |
307 | |
308 | /* |
309 | * Flags for preadv2/pwritev2: |
310 | */ |
311 | |
312 | typedef int __bitwise __kernel_rwf_t; |
313 | |
314 | /* high priority request, poll if possible */ |
315 | #define RWF_HIPRI ((__force __kernel_rwf_t)0x00000001) |
316 | |
317 | /* per-IO O_DSYNC */ |
318 | #define RWF_DSYNC ((__force __kernel_rwf_t)0x00000002) |
319 | |
320 | /* per-IO O_SYNC */ |
321 | #define RWF_SYNC ((__force __kernel_rwf_t)0x00000004) |
322 | |
323 | /* per-IO, return -EAGAIN if operation would block */ |
324 | #define RWF_NOWAIT ((__force __kernel_rwf_t)0x00000008) |
325 | |
326 | /* per-IO O_APPEND */ |
327 | #define RWF_APPEND ((__force __kernel_rwf_t)0x00000010) |
328 | |
329 | /* per-IO negation of O_APPEND */ |
330 | #define RWF_NOAPPEND ((__force __kernel_rwf_t)0x00000020) |
331 | |
332 | /* mask of flags supported by the kernel */ |
333 | #define RWF_SUPPORTED (RWF_HIPRI | RWF_DSYNC | RWF_SYNC | RWF_NOWAIT |\ |
334 | RWF_APPEND | RWF_NOAPPEND) |
335 | |
336 | /* Pagemap ioctl */ |
337 | #define PAGEMAP_SCAN _IOWR('f', 16, struct pm_scan_arg) |
338 | |
339 | /* Bitmasks provided in pm_scan_args masks and reported in page_region.categories. */ |
340 | #define PAGE_IS_WPALLOWED (1 << 0) |
341 | #define PAGE_IS_WRITTEN (1 << 1) |
342 | #define PAGE_IS_FILE (1 << 2) |
343 | #define PAGE_IS_PRESENT (1 << 3) |
344 | #define PAGE_IS_SWAPPED (1 << 4) |
345 | #define PAGE_IS_PFNZERO (1 << 5) |
346 | #define PAGE_IS_HUGE (1 << 6) |
347 | #define PAGE_IS_SOFT_DIRTY (1 << 7) |
348 | |
349 | /* |
350 | * struct page_region - Page region with flags |
351 | * @start: Start of the region |
352 | * @end: End of the region (exclusive) |
353 | * @categories: PAGE_IS_* category bitmask for the region |
354 | */ |
355 | struct page_region { |
356 | __u64 start; |
357 | __u64 end; |
358 | __u64 categories; |
359 | }; |
360 | |
361 | /* Flags for PAGEMAP_SCAN ioctl */ |
362 | #define PM_SCAN_WP_MATCHING (1 << 0) /* Write protect the pages matched. */ |
363 | #define PM_SCAN_CHECK_WPASYNC (1 << 1) /* Abort the scan when a non-WP-enabled page is found. */ |
364 | |
365 | /* |
366 | * struct pm_scan_arg - Pagemap ioctl argument |
367 | * @size: Size of the structure |
368 | * @flags: Flags for the IOCTL |
369 | * @start: Starting address of the region |
370 | * @end: Ending address of the region |
371 | * @walk_end Address where the scan stopped (written by kernel). |
372 | * walk_end == end (address tags cleared) informs that the scan completed on entire range. |
373 | * @vec: Address of page_region struct array for output |
374 | * @vec_len: Length of the page_region struct array |
375 | * @max_pages: Optional limit for number of returned pages (0 = disabled) |
376 | * @category_inverted: PAGE_IS_* categories which values match if 0 instead of 1 |
377 | * @category_mask: Skip pages for which any category doesn't match |
378 | * @category_anyof_mask: Skip pages for which no category matches |
379 | * @return_mask: PAGE_IS_* categories that are to be reported in `page_region`s returned |
380 | */ |
381 | struct pm_scan_arg { |
382 | __u64 size; |
383 | __u64 flags; |
384 | __u64 start; |
385 | __u64 end; |
386 | __u64 walk_end; |
387 | __u64 vec; |
388 | __u64 vec_len; |
389 | __u64 max_pages; |
390 | __u64 category_inverted; |
391 | __u64 category_mask; |
392 | __u64 category_anyof_mask; |
393 | __u64 return_mask; |
394 | }; |
395 | |
396 | #endif /* _UAPI_LINUX_FS_H */ |
397 |
Warning: This file is not a C or C++ file. It does not have highlighting.