1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2#ifndef _LINUX_FS_H
3#define _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
17/* Use of MS_* flags within the kernel is restricted to core mount(2) code. */
18#include <linux/mount.h>
19
20/*
21 * It's silly to have NR_OPEN bigger than NR_FILE, but you can change
22 * the file limit at runtime and only root can increase the per-process
23 * nr_file rlimit, so it's safe to set up a ridiculously high absolute
24 * upper limit on files-per-process.
25 *
26 * Some programs (notably those using select()) may have to be
27 * recompiled to take full advantage of the new limits..
28 */
29
30/* Fixed constants first: */
31#undef NR_OPEN
32#define INR_OPEN_CUR 1024 /* Initial setting for nfile rlimits */
33#define INR_OPEN_MAX 4096 /* Hard limit for nfile rlimits */
34
35#define BLOCK_SIZE_BITS 10
36#define BLOCK_SIZE (1<<BLOCK_SIZE_BITS)
37
38#define SEEK_SET 0 /* seek relative to beginning of file */
39#define SEEK_CUR 1 /* seek relative to current file position */
40#define SEEK_END 2 /* seek relative to end of file */
41#define SEEK_DATA 3 /* seek to the next data */
42#define SEEK_HOLE 4 /* seek to the next hole */
43#define SEEK_MAX SEEK_HOLE
44
45#define RENAME_NOREPLACE (1 << 0) /* Don't overwrite target */
46#define RENAME_EXCHANGE (1 << 1) /* Exchange source and dest */
47#define RENAME_WHITEOUT (1 << 2) /* Whiteout source */
48
49struct file_clone_range {
50 __s64 src_fd;
51 __u64 src_offset;
52 __u64 src_length;
53 __u64 dest_offset;
54};
55
56struct fstrim_range {
57 __u64 start;
58 __u64 len;
59 __u64 minlen;
60};
61
62/* extent-same (dedupe) ioctls; these MUST match the btrfs ioctl definitions */
63#define FILE_DEDUPE_RANGE_SAME 0
64#define FILE_DEDUPE_RANGE_DIFFERS 1
65
66/* from struct btrfs_ioctl_file_extent_same_info */
67struct file_dedupe_range_info {
68 __s64 dest_fd; /* in - destination file */
69 __u64 dest_offset; /* in - start of extent in destination */
70 __u64 bytes_deduped; /* out - total # of bytes we were able
71 * to dedupe from this file. */
72 /* status of this dedupe operation:
73 * < 0 for error
74 * == FILE_DEDUPE_RANGE_SAME if dedupe succeeds
75 * == FILE_DEDUPE_RANGE_DIFFERS if data differs
76 */
77 __s32 status; /* out - see above description */
78 __u32 reserved; /* must be zero */
79};
80
81/* from struct btrfs_ioctl_file_extent_same_args */
82struct file_dedupe_range {
83 __u64 src_offset; /* in - start of extent in source */
84 __u64 src_length; /* in - length of extent */
85 __u16 dest_count; /* in - total elements in info array */
86 __u16 reserved1; /* must be zero */
87 __u32 reserved2; /* must be zero */
88 struct file_dedupe_range_info info[0];
89};
90
91/* And dynamically-tunable limits and defaults: */
92struct files_stat_struct {
93 unsigned long nr_files; /* read only */
94 unsigned long nr_free_files; /* read only */
95 unsigned long max_files; /* tunable */
96};
97
98struct inodes_stat_t {
99 long nr_inodes;
100 long nr_unused;
101 long dummy[5]; /* padding for sysctl ABI compatibility */
102};
103
104
105#define NR_FILE 8192 /* this can well be larger on a larger system */
106
107/*
108 * Structure for FS_IOC_FSGETXATTR[A] and FS_IOC_FSSETXATTR.
109 */
110struct fsxattr {
111 __u32 fsx_xflags; /* xflags field value (get/set) */
112 __u32 fsx_extsize; /* extsize field value (get/set)*/
113 __u32 fsx_nextents; /* nextents field value (get) */
114 __u32 fsx_projid; /* project identifier (get/set) */
115 __u32 fsx_cowextsize; /* CoW extsize field value (get/set)*/
116 unsigned char fsx_pad[8];
117};
118
119/*
120 * Flags for the fsx_xflags field
121 */
122#define FS_XFLAG_REALTIME 0x00000001 /* data in realtime volume */
123#define FS_XFLAG_PREALLOC 0x00000002 /* preallocated file extents */
124#define FS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */
125#define FS_XFLAG_APPEND 0x00000010 /* all writes append */
126#define FS_XFLAG_SYNC 0x00000020 /* all writes synchronous */
127#define FS_XFLAG_NOATIME 0x00000040 /* do not update access time */
128#define FS_XFLAG_NODUMP 0x00000080 /* do not include in backups */
129#define FS_XFLAG_RTINHERIT 0x00000100 /* create with rt bit set */
130#define FS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */
131#define FS_XFLAG_NOSYMLINKS 0x00000400 /* disallow symlink creation */
132#define FS_XFLAG_EXTSIZE 0x00000800 /* extent size allocator hint */
133#define FS_XFLAG_EXTSZINHERIT 0x00001000 /* inherit inode extent size */
134#define FS_XFLAG_NODEFRAG 0x00002000 /* do not defragment */
135#define FS_XFLAG_FILESTREAM 0x00004000 /* use filestream allocator */
136#define FS_XFLAG_DAX 0x00008000 /* use DAX for IO */
137#define FS_XFLAG_COWEXTSIZE 0x00010000 /* CoW extent size allocator hint */
138#define FS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */
139
140/* the read-only stuff doesn't really belong here, but any other place is
141 probably as bad and I don't want to create yet another include file. */
142
143#define BLKROSET _IO(0x12,93) /* set device read-only (0 = read-write) */
144#define BLKROGET _IO(0x12,94) /* get read-only status (0 = read_write) */
145#define BLKRRPART _IO(0x12,95) /* re-read partition table */
146#define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */
147#define BLKFLSBUF _IO(0x12,97) /* flush buffer cache */
148#define BLKRASET _IO(0x12,98) /* set read ahead for block device */
149#define BLKRAGET _IO(0x12,99) /* get current read ahead setting */
150#define BLKFRASET _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
151#define BLKFRAGET _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
152#define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
153#define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
154#define BLKSSZGET _IO(0x12,104)/* get block device sector size */
155#if 0
156#define BLKPG _IO(0x12,105)/* See blkpg.h */
157
158/* Some people are morons. Do not use sizeof! */
159
160#define BLKELVGET _IOR(0x12,106,size_t)/* elevator get */
161#define BLKELVSET _IOW(0x12,107,size_t)/* elevator set */
162/* This was here just to show that the number is taken -
163 probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
164#endif
165/* A jump here: 108-111 have been used for various private purposes. */
166#define BLKBSZGET _IOR(0x12,112,size_t)
167#define BLKBSZSET _IOW(0x12,113,size_t)
168#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
169#define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
170#define BLKTRACESTART _IO(0x12,116)
171#define BLKTRACESTOP _IO(0x12,117)
172#define BLKTRACETEARDOWN _IO(0x12,118)
173#define BLKDISCARD _IO(0x12,119)
174#define BLKIOMIN _IO(0x12,120)
175#define BLKIOOPT _IO(0x12,121)
176#define BLKALIGNOFF _IO(0x12,122)
177#define BLKPBSZGET _IO(0x12,123)
178#define BLKDISCARDZEROES _IO(0x12,124)
179#define BLKSECDISCARD _IO(0x12,125)
180#define BLKROTATIONAL _IO(0x12,126)
181#define BLKZEROOUT _IO(0x12,127)
182/*
183 * A jump here: 130-131 are reserved for zoned block devices
184 * (see uapi/linux/blkzoned.h)
185 */
186
187#define BMAP_IOCTL 1 /* obsolete - kept for compatibility */
188#define FIBMAP _IO(0x00,1) /* bmap access */
189#define FIGETBSZ _IO(0x00,2) /* get the block size used for bmap */
190#define FIFREEZE _IOWR('X', 119, int) /* Freeze */
191#define FITHAW _IOWR('X', 120, int) /* Thaw */
192#define FITRIM _IOWR('X', 121, struct fstrim_range) /* Trim */
193#define FICLONE _IOW(0x94, 9, int)
194#define FICLONERANGE _IOW(0x94, 13, struct file_clone_range)
195#define FIDEDUPERANGE _IOWR(0x94, 54, struct file_dedupe_range)
196
197#define FSLABEL_MAX 256 /* Max chars for the interface; each fs may differ */
198
199#define FS_IOC_GETFLAGS _IOR('f', 1, long)
200#define FS_IOC_SETFLAGS _IOW('f', 2, long)
201#define FS_IOC_GETVERSION _IOR('v', 1, long)
202#define FS_IOC_SETVERSION _IOW('v', 2, long)
203#define FS_IOC_FIEMAP _IOWR('f', 11, struct fiemap)
204#define FS_IOC32_GETFLAGS _IOR('f', 1, int)
205#define FS_IOC32_SETFLAGS _IOW('f', 2, int)
206#define FS_IOC32_GETVERSION _IOR('v', 1, int)
207#define FS_IOC32_SETVERSION _IOW('v', 2, int)
208#define FS_IOC_FSGETXATTR _IOR('X', 31, struct fsxattr)
209#define FS_IOC_FSSETXATTR _IOW('X', 32, struct fsxattr)
210#define FS_IOC_GETFSLABEL _IOR(0x94, 49, char[FSLABEL_MAX])
211#define FS_IOC_SETFSLABEL _IOW(0x94, 50, char[FSLABEL_MAX])
212
213/*
214 * File system encryption support
215 */
216/* Policy provided via an ioctl on the topmost directory */
217#define FS_KEY_DESCRIPTOR_SIZE 8
218
219#define FS_POLICY_FLAGS_PAD_4 0x00
220#define FS_POLICY_FLAGS_PAD_8 0x01
221#define FS_POLICY_FLAGS_PAD_16 0x02
222#define FS_POLICY_FLAGS_PAD_32 0x03
223#define FS_POLICY_FLAGS_PAD_MASK 0x03
224#define FS_POLICY_FLAG_DIRECT_KEY 0x04 /* use master key directly */
225#define FS_POLICY_FLAGS_VALID 0x07
226
227/* Encryption algorithms */
228#define FS_ENCRYPTION_MODE_INVALID 0
229#define FS_ENCRYPTION_MODE_AES_256_XTS 1
230#define FS_ENCRYPTION_MODE_AES_256_GCM 2
231#define FS_ENCRYPTION_MODE_AES_256_CBC 3
232#define FS_ENCRYPTION_MODE_AES_256_CTS 4
233#define FS_ENCRYPTION_MODE_AES_128_CBC 5
234#define FS_ENCRYPTION_MODE_AES_128_CTS 6
235#define FS_ENCRYPTION_MODE_SPECK128_256_XTS 7 /* Removed, do not use. */
236#define FS_ENCRYPTION_MODE_SPECK128_256_CTS 8 /* Removed, do not use. */
237#define FS_ENCRYPTION_MODE_ADIANTUM 9
238
239struct fscrypt_policy {
240 __u8 version;
241 __u8 contents_encryption_mode;
242 __u8 filenames_encryption_mode;
243 __u8 flags;
244 __u8 master_key_descriptor[FS_KEY_DESCRIPTOR_SIZE];
245};
246
247#define FS_IOC_SET_ENCRYPTION_POLICY _IOR('f', 19, struct fscrypt_policy)
248#define FS_IOC_GET_ENCRYPTION_PWSALT _IOW('f', 20, __u8[16])
249#define FS_IOC_GET_ENCRYPTION_POLICY _IOW('f', 21, struct fscrypt_policy)
250
251/* Parameters for passing an encryption key into the kernel keyring */
252#define FS_KEY_DESC_PREFIX "fscrypt:"
253#define FS_KEY_DESC_PREFIX_SIZE 8
254
255/* Structure that userspace passes to the kernel keyring */
256#define FS_MAX_KEY_SIZE 64
257
258struct fscrypt_key {
259 __u32 mode;
260 __u8 raw[FS_MAX_KEY_SIZE];
261 __u32 size;
262};
263
264/*
265 * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)
266 *
267 * Note: for historical reasons, these flags were originally used and
268 * defined for use by ext2/ext3, and then other file systems started
269 * using these flags so they wouldn't need to write their own version
270 * of chattr/lsattr (which was shipped as part of e2fsprogs). You
271 * should think twice before trying to use these flags in new
272 * contexts, or trying to assign these flags, since they are used both
273 * as the UAPI and the on-disk encoding for ext2/3/4. Also, we are
274 * almost out of 32-bit flags. :-)
275 *
276 * We have recently hoisted FS_IOC_FSGETXATTR / FS_IOC_FSSETXATTR from
277 * XFS to the generic FS level interface. This uses a structure that
278 * has padding and hence has more room to grow, so it may be more
279 * appropriate for many new use cases.
280 *
281 * Please do not change these flags or interfaces before checking with
282 * linux-fsdevel@vger.kernel.org and linux-api@vger.kernel.org.
283 */
284#define FS_SECRM_FL 0x00000001 /* Secure deletion */
285#define FS_UNRM_FL 0x00000002 /* Undelete */
286#define FS_COMPR_FL 0x00000004 /* Compress file */
287#define FS_SYNC_FL 0x00000008 /* Synchronous updates */
288#define FS_IMMUTABLE_FL 0x00000010 /* Immutable file */
289#define FS_APPEND_FL 0x00000020 /* writes to file may only append */
290#define FS_NODUMP_FL 0x00000040 /* do not dump file */
291#define FS_NOATIME_FL 0x00000080 /* do not update atime */
292/* Reserved for compression usage... */
293#define FS_DIRTY_FL 0x00000100
294#define FS_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
295#define FS_NOCOMP_FL 0x00000400 /* Don't compress */
296/* End compression flags --- maybe not all used */
297#define FS_ENCRYPT_FL 0x00000800 /* Encrypted file */
298#define FS_BTREE_FL 0x00001000 /* btree format dir */
299#define FS_INDEX_FL 0x00001000 /* hash-indexed directory */
300#define FS_IMAGIC_FL 0x00002000 /* AFS directory */
301#define FS_JOURNAL_DATA_FL 0x00004000 /* Reserved for ext3 */
302#define FS_NOTAIL_FL 0x00008000 /* file tail should not be merged */
303#define FS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
304#define FS_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
305#define FS_HUGE_FILE_FL 0x00040000 /* Reserved for ext4 */
306#define FS_EXTENT_FL 0x00080000 /* Extents */
307#define FS_EA_INODE_FL 0x00200000 /* Inode used for large EA */
308#define FS_EOFBLOCKS_FL 0x00400000 /* Reserved for ext4 */
309#define FS_NOCOW_FL 0x00800000 /* Do not cow file */
310#define FS_INLINE_DATA_FL 0x10000000 /* Reserved for ext4 */
311#define FS_PROJINHERIT_FL 0x20000000 /* Create with parents projid */
312#define FS_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
313
314#define FS_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */
315#define FS_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
316
317
318#define SYNC_FILE_RANGE_WAIT_BEFORE 1
319#define SYNC_FILE_RANGE_WRITE 2
320#define SYNC_FILE_RANGE_WAIT_AFTER 4
321#define SYNC_FILE_RANGE_WRITE_AND_WAIT (SYNC_FILE_RANGE_WRITE | \
322 SYNC_FILE_RANGE_WAIT_BEFORE | \
323 SYNC_FILE_RANGE_WAIT_AFTER)
324
325/*
326 * Flags for preadv2/pwritev2:
327 */
328
329typedef int __bitwise __kernel_rwf_t;
330
331/* high priority request, poll if possible */
332#define RWF_HIPRI ((__kernel_rwf_t)0x00000001)
333
334/* per-IO O_DSYNC */
335#define RWF_DSYNC ((__kernel_rwf_t)0x00000002)
336
337/* per-IO O_SYNC */
338#define RWF_SYNC ((__kernel_rwf_t)0x00000004)
339
340/* per-IO, return -EAGAIN if operation would block */
341#define RWF_NOWAIT ((__kernel_rwf_t)0x00000008)
342
343/* per-IO O_APPEND */
344#define RWF_APPEND ((__kernel_rwf_t)0x00000010)
345
346/* mask of flags supported by the kernel */
347#define RWF_SUPPORTED (RWF_HIPRI | RWF_DSYNC | RWF_SYNC | RWF_NOWAIT |\
348 RWF_APPEND)
349
350#endif /* _LINUX_FS_H */
351