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