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