xref: /linux-6.15/include/uapi/linux/fs.h (revision 1f330c32)
1 #ifndef _UAPI_LINUX_FS_H
2 #define _UAPI_LINUX_FS_H
3 
4 /*
5  * This file has definitions for some important file table
6  * structures etc.
7  */
8 
9 #include <linux/limits.h>
10 #include <linux/ioctl.h>
11 #include <linux/types.h>
12 
13 /*
14  * It's silly to have NR_OPEN bigger than NR_FILE, but you can change
15  * the file limit at runtime and only root can increase the per-process
16  * nr_file rlimit, so it's safe to set up a ridiculously high absolute
17  * upper limit on files-per-process.
18  *
19  * Some programs (notably those using select()) may have to be
20  * recompiled to take full advantage of the new limits..
21  */
22 
23 /* Fixed constants first: */
24 #undef NR_OPEN
25 #define INR_OPEN_CUR 1024	/* Initial setting for nfile rlimits */
26 #define INR_OPEN_MAX 4096	/* Hard limit for nfile rlimits */
27 
28 #define BLOCK_SIZE_BITS 10
29 #define BLOCK_SIZE (1<<BLOCK_SIZE_BITS)
30 
31 #define SEEK_SET	0	/* seek relative to beginning of file */
32 #define SEEK_CUR	1	/* seek relative to current file position */
33 #define SEEK_END	2	/* seek relative to end of file */
34 #define SEEK_DATA	3	/* seek to the next data */
35 #define SEEK_HOLE	4	/* seek to the next hole */
36 #define SEEK_MAX	SEEK_HOLE
37 
38 #define RENAME_NOREPLACE	(1 << 0)	/* Don't overwrite target */
39 #define RENAME_EXCHANGE		(1 << 1)	/* Exchange source and dest */
40 #define RENAME_WHITEOUT		(1 << 2)	/* Whiteout source */
41 
42 struct file_clone_range {
43 	__s64 src_fd;
44 	__u64 src_offset;
45 	__u64 src_length;
46 	__u64 dest_offset;
47 };
48 
49 struct fstrim_range {
50 	__u64 start;
51 	__u64 len;
52 	__u64 minlen;
53 };
54 
55 /* extent-same (dedupe) ioctls; these MUST match the btrfs ioctl definitions */
56 #define FILE_DEDUPE_RANGE_SAME		0
57 #define FILE_DEDUPE_RANGE_DIFFERS	1
58 
59 /* from struct btrfs_ioctl_file_extent_same_info */
60 struct file_dedupe_range_info {
61 	__s64 dest_fd;		/* in - destination file */
62 	__u64 dest_offset;	/* in - start of extent in destination */
63 	__u64 bytes_deduped;	/* out - total # of bytes we were able
64 				 * to dedupe from this file. */
65 	/* status of this dedupe operation:
66 	 * < 0 for error
67 	 * == FILE_DEDUPE_RANGE_SAME if dedupe succeeds
68 	 * == FILE_DEDUPE_RANGE_DIFFERS if data differs
69 	 */
70 	__s32 status;		/* out - see above description */
71 	__u32 reserved;		/* must be zero */
72 };
73 
74 /* from struct btrfs_ioctl_file_extent_same_args */
75 struct file_dedupe_range {
76 	__u64 src_offset;	/* in - start of extent in source */
77 	__u64 src_length;	/* in - length of extent */
78 	__u16 dest_count;	/* in - total elements in info array */
79 	__u16 reserved1;	/* must be zero */
80 	__u32 reserved2;	/* must be zero */
81 	struct file_dedupe_range_info info[0];
82 };
83 
84 /* And dynamically-tunable limits and defaults: */
85 struct files_stat_struct {
86 	unsigned long nr_files;		/* read only */
87 	unsigned long nr_free_files;	/* read only */
88 	unsigned long max_files;		/* tunable */
89 };
90 
91 struct inodes_stat_t {
92 	long nr_inodes;
93 	long nr_unused;
94 	long dummy[5];		/* padding for sysctl ABI compatibility */
95 };
96 
97 
98 #define NR_FILE  8192	/* this can well be larger on a larger system */
99 
100 
101 /*
102  * These are the fs-independent mount-flags: up to 32 flags are supported
103  */
104 #define MS_RDONLY	 1	/* Mount read-only */
105 #define MS_NOSUID	 2	/* Ignore suid and sgid bits */
106 #define MS_NODEV	 4	/* Disallow access to device special files */
107 #define MS_NOEXEC	 8	/* Disallow program execution */
108 #define MS_SYNCHRONOUS	16	/* Writes are synced at once */
109 #define MS_REMOUNT	32	/* Alter flags of a mounted FS */
110 #define MS_MANDLOCK	64	/* Allow mandatory locks on an FS */
111 #define MS_DIRSYNC	128	/* Directory modifications are synchronous */
112 #define MS_NOATIME	1024	/* Do not update access times. */
113 #define MS_NODIRATIME	2048	/* Do not update directory access times */
114 #define MS_BIND		4096
115 #define MS_MOVE		8192
116 #define MS_REC		16384
117 #define MS_VERBOSE	32768	/* War is peace. Verbosity is silence.
118 				   MS_VERBOSE is deprecated. */
119 #define MS_SILENT	32768
120 #define MS_POSIXACL	(1<<16)	/* VFS does not apply the umask */
121 #define MS_UNBINDABLE	(1<<17)	/* change to unbindable */
122 #define MS_PRIVATE	(1<<18)	/* change to private */
123 #define MS_SLAVE	(1<<19)	/* change to slave */
124 #define MS_SHARED	(1<<20)	/* change to shared */
125 #define MS_RELATIME	(1<<21)	/* Update atime relative to mtime/ctime. */
126 #define MS_KERNMOUNT	(1<<22) /* this is a kern_mount call */
127 #define MS_I_VERSION	(1<<23) /* Update inode I_version field */
128 #define MS_STRICTATIME	(1<<24) /* Always perform atime updates */
129 #define MS_LAZYTIME	(1<<25) /* Update the on-disk [acm]times lazily */
130 
131 /* These sb flags are internal to the kernel */
132 #define MS_NOSEC	(1<<28)
133 #define MS_BORN		(1<<29)
134 #define MS_ACTIVE	(1<<30)
135 #define MS_NOUSER	(1<<31)
136 
137 /*
138  * Superblock flags that can be altered by MS_REMOUNT
139  */
140 #define MS_RMT_MASK	(MS_RDONLY|MS_SYNCHRONOUS|MS_MANDLOCK|MS_I_VERSION|\
141 			 MS_LAZYTIME)
142 
143 /*
144  * Old magic mount flag and mask
145  */
146 #define MS_MGC_VAL 0xC0ED0000
147 #define MS_MGC_MSK 0xffff0000
148 
149 /* the read-only stuff doesn't really belong here, but any other place is
150    probably as bad and I don't want to create yet another include file. */
151 
152 #define BLKROSET   _IO(0x12,93)	/* set device read-only (0 = read-write) */
153 #define BLKROGET   _IO(0x12,94)	/* get read-only status (0 = read_write) */
154 #define BLKRRPART  _IO(0x12,95)	/* re-read partition table */
155 #define BLKGETSIZE _IO(0x12,96)	/* return device size /512 (long *arg) */
156 #define BLKFLSBUF  _IO(0x12,97)	/* flush buffer cache */
157 #define BLKRASET   _IO(0x12,98)	/* set read ahead for block device */
158 #define BLKRAGET   _IO(0x12,99)	/* get current read ahead setting */
159 #define BLKFRASET  _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
160 #define BLKFRAGET  _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
161 #define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
162 #define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
163 #define BLKSSZGET  _IO(0x12,104)/* get block device sector size */
164 #if 0
165 #define BLKPG      _IO(0x12,105)/* See blkpg.h */
166 
167 /* Some people are morons.  Do not use sizeof! */
168 
169 #define BLKELVGET  _IOR(0x12,106,size_t)/* elevator get */
170 #define BLKELVSET  _IOW(0x12,107,size_t)/* elevator set */
171 /* This was here just to show that the number is taken -
172    probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
173 #endif
174 /* A jump here: 108-111 have been used for various private purposes. */
175 #define BLKBSZGET  _IOR(0x12,112,size_t)
176 #define BLKBSZSET  _IOW(0x12,113,size_t)
177 #define BLKGETSIZE64 _IOR(0x12,114,size_t)	/* return device size in bytes (u64 *arg) */
178 #define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
179 #define BLKTRACESTART _IO(0x12,116)
180 #define BLKTRACESTOP _IO(0x12,117)
181 #define BLKTRACETEARDOWN _IO(0x12,118)
182 #define BLKDISCARD _IO(0x12,119)
183 #define BLKIOMIN _IO(0x12,120)
184 #define BLKIOOPT _IO(0x12,121)
185 #define BLKALIGNOFF _IO(0x12,122)
186 #define BLKPBSZGET _IO(0x12,123)
187 #define BLKDISCARDZEROES _IO(0x12,124)
188 #define BLKSECDISCARD _IO(0x12,125)
189 #define BLKROTATIONAL _IO(0x12,126)
190 #define BLKZEROOUT _IO(0x12,127)
191 #define BLKDAXSET _IO(0x12,128)
192 #define BLKDAXGET _IO(0x12,129)
193 
194 #define BMAP_IOCTL 1		/* obsolete - kept for compatibility */
195 #define FIBMAP	   _IO(0x00,1)	/* bmap access */
196 #define FIGETBSZ   _IO(0x00,2)	/* get the block size used for bmap */
197 #define FIFREEZE	_IOWR('X', 119, int)	/* Freeze */
198 #define FITHAW		_IOWR('X', 120, int)	/* Thaw */
199 #define FITRIM		_IOWR('X', 121, struct fstrim_range)	/* Trim */
200 #define FICLONE		_IOW(0x94, 9, int)
201 #define FICLONERANGE	_IOW(0x94, 13, struct file_clone_range)
202 #define FIDEDUPERANGE	_IOWR(0x94, 54, struct file_dedupe_range)
203 
204 #define	FS_IOC_GETFLAGS			_IOR('f', 1, long)
205 #define	FS_IOC_SETFLAGS			_IOW('f', 2, long)
206 #define	FS_IOC_GETVERSION		_IOR('v', 1, long)
207 #define	FS_IOC_SETVERSION		_IOW('v', 2, long)
208 #define FS_IOC_FIEMAP			_IOWR('f', 11, struct fiemap)
209 #define FS_IOC32_GETFLAGS		_IOR('f', 1, int)
210 #define FS_IOC32_SETFLAGS		_IOW('f', 2, int)
211 #define FS_IOC32_GETVERSION		_IOR('v', 1, int)
212 #define FS_IOC32_SETVERSION		_IOW('v', 2, int)
213 
214 /*
215  * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)
216  */
217 #define	FS_SECRM_FL			0x00000001 /* Secure deletion */
218 #define	FS_UNRM_FL			0x00000002 /* Undelete */
219 #define	FS_COMPR_FL			0x00000004 /* Compress file */
220 #define FS_SYNC_FL			0x00000008 /* Synchronous updates */
221 #define FS_IMMUTABLE_FL			0x00000010 /* Immutable file */
222 #define FS_APPEND_FL			0x00000020 /* writes to file may only append */
223 #define FS_NODUMP_FL			0x00000040 /* do not dump file */
224 #define FS_NOATIME_FL			0x00000080 /* do not update atime */
225 /* Reserved for compression usage... */
226 #define FS_DIRTY_FL			0x00000100
227 #define FS_COMPRBLK_FL			0x00000200 /* One or more compressed clusters */
228 #define FS_NOCOMP_FL			0x00000400 /* Don't compress */
229 #define FS_ECOMPR_FL			0x00000800 /* Compression error */
230 /* End compression flags --- maybe not all used */
231 #define FS_BTREE_FL			0x00001000 /* btree format dir */
232 #define FS_INDEX_FL			0x00001000 /* hash-indexed directory */
233 #define FS_IMAGIC_FL			0x00002000 /* AFS directory */
234 #define FS_JOURNAL_DATA_FL		0x00004000 /* Reserved for ext3 */
235 #define FS_NOTAIL_FL			0x00008000 /* file tail should not be merged */
236 #define FS_DIRSYNC_FL			0x00010000 /* dirsync behaviour (directories only) */
237 #define FS_TOPDIR_FL			0x00020000 /* Top of directory hierarchies*/
238 #define FS_EXTENT_FL			0x00080000 /* Extents */
239 #define FS_DIRECTIO_FL			0x00100000 /* Use direct i/o */
240 #define FS_NOCOW_FL			0x00800000 /* Do not cow file */
241 #define FS_PROJINHERIT_FL		0x20000000 /* Create with parents projid */
242 #define FS_RESERVED_FL			0x80000000 /* reserved for ext2 lib */
243 
244 #define FS_FL_USER_VISIBLE		0x0003DFFF /* User visible flags */
245 #define FS_FL_USER_MODIFIABLE		0x000380FF /* User modifiable flags */
246 
247 
248 #define SYNC_FILE_RANGE_WAIT_BEFORE	1
249 #define SYNC_FILE_RANGE_WRITE		2
250 #define SYNC_FILE_RANGE_WAIT_AFTER	4
251 
252 #endif /* _UAPI_LINUX_FS_H */
253