1#ifndef _LINUX_FS_H
2#define _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
45struct file_clone_range {
46 __s64 src_fd;
47 __u64 src_offset;
48 __u64 src_length;
49 __u64 dest_offset;
50};
51
52struct 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 */
63struct 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 */
78struct 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: */
88struct 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
94struct 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_SUBMOUNT (1<<26)
136#define MS_NOREMOTELOCK (1<<27)
137#define MS_NOSEC (1<<28)
138#define MS_BORN (1<<29)
139#define MS_ACTIVE (1<<30)
140#define MS_NOUSER (1<<31)
141
142/*
143 * Superblock flags that can be altered by MS_REMOUNT
144 */
145#define MS_RMT_MASK (MS_RDONLY|MS_SYNCHRONOUS|MS_MANDLOCK|MS_I_VERSION|\
146 MS_LAZYTIME)
147
148/*
149 * Old magic mount flag and mask
150 */
151#define MS_MGC_VAL 0xC0ED0000
152#define MS_MGC_MSK 0xffff0000
153
154/*
155 * Structure for FS_IOC_FSGETXATTR[A] and FS_IOC_FSSETXATTR.
156 */
157struct fsxattr {
158 __u32 fsx_xflags; /* xflags field value (get/set) */
159 __u32 fsx_extsize; /* extsize field value (get/set)*/
160 __u32 fsx_nextents; /* nextents field value (get) */
161 __u32 fsx_projid; /* project identifier (get/set) */
162 __u32 fsx_cowextsize; /* CoW extsize field value (get/set)*/
163 unsigned char fsx_pad[8];
164};
165
166/*
167 * Flags for the fsx_xflags field
168 */
169#define FS_XFLAG_REALTIME 0x00000001 /* data in realtime volume */
170#define FS_XFLAG_PREALLOC 0x00000002 /* preallocated file extents */
171#define FS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */
172#define FS_XFLAG_APPEND 0x00000010 /* all writes append */
173#define FS_XFLAG_SYNC 0x00000020 /* all writes synchronous */
174#define FS_XFLAG_NOATIME 0x00000040 /* do not update access time */
175#define FS_XFLAG_NODUMP 0x00000080 /* do not include in backups */
176#define FS_XFLAG_RTINHERIT 0x00000100 /* create with rt bit set */
177#define FS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */
178#define FS_XFLAG_NOSYMLINKS 0x00000400 /* disallow symlink creation */
179#define FS_XFLAG_EXTSIZE 0x00000800 /* extent size allocator hint */
180#define FS_XFLAG_EXTSZINHERIT 0x00001000 /* inherit inode extent size */
181#define FS_XFLAG_NODEFRAG 0x00002000 /* do not defragment */
182#define FS_XFLAG_FILESTREAM 0x00004000 /* use filestream allocator */
183#define FS_XFLAG_DAX 0x00008000 /* use DAX for IO */
184#define FS_XFLAG_COWEXTSIZE 0x00010000 /* CoW extent size allocator hint */
185#define FS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */
186
187/* the read-only stuff doesn't really belong here, but any other place is
188 probably as bad and I don't want to create yet another include file. */
189
190#define BLKROSET _IO(0x12,93) /* set device read-only (0 = read-write) */
191#define BLKROGET _IO(0x12,94) /* get read-only status (0 = read_write) */
192#define BLKRRPART _IO(0x12,95) /* re-read partition table */
193#define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */
194#define BLKFLSBUF _IO(0x12,97) /* flush buffer cache */
195#define BLKRASET _IO(0x12,98) /* set read ahead for block device */
196#define BLKRAGET _IO(0x12,99) /* get current read ahead setting */
197#define BLKFRASET _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
198#define BLKFRAGET _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
199#define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
200#define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
201#define BLKSSZGET _IO(0x12,104)/* get block device sector size */
202#if 0
203#define BLKPG _IO(0x12,105)/* See blkpg.h */
204
205/* Some people are morons. Do not use sizeof! */
206
207#define BLKELVGET _IOR(0x12,106,size_t)/* elevator get */
208#define BLKELVSET _IOW(0x12,107,size_t)/* elevator set */
209/* This was here just to show that the number is taken -
210 probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
211#endif
212/* A jump here: 108-111 have been used for various private purposes. */
213#define BLKBSZGET _IOR(0x12,112,size_t)
214#define BLKBSZSET _IOW(0x12,113,size_t)
215#define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
216#define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
217#define BLKTRACESTART _IO(0x12,116)
218#define BLKTRACESTOP _IO(0x12,117)
219#define BLKTRACETEARDOWN _IO(0x12,118)
220#define BLKDISCARD _IO(0x12,119)
221#define BLKIOMIN _IO(0x12,120)
222#define BLKIOOPT _IO(0x12,121)
223#define BLKALIGNOFF _IO(0x12,122)
224#define BLKPBSZGET _IO(0x12,123)
225#define BLKDISCARDZEROES _IO(0x12,124)
226#define BLKSECDISCARD _IO(0x12,125)
227#define BLKROTATIONAL _IO(0x12,126)
228#define BLKZEROOUT _IO(0x12,127)
229/*
230 * A jump here: 130-131 are reserved for zoned block devices
231 * (see uapi/linux/blkzoned.h)
232 */
233
234#define BMAP_IOCTL 1 /* obsolete - kept for compatibility */
235#define FIBMAP _IO(0x00,1) /* bmap access */
236#define FIGETBSZ _IO(0x00,2) /* get the block size used for bmap */
237#define FIFREEZE _IOWR('X', 119, int) /* Freeze */
238#define FITHAW _IOWR('X', 120, int) /* Thaw */
239#define FITRIM _IOWR('X', 121, struct fstrim_range) /* Trim */
240#define FICLONE _IOW(0x94, 9, int)
241#define FICLONERANGE _IOW(0x94, 13, struct file_clone_range)
242#define FIDEDUPERANGE _IOWR(0x94, 54, struct file_dedupe_range)
243
244#define FS_IOC_GETFLAGS _IOR('f', 1, long)
245#define FS_IOC_SETFLAGS _IOW('f', 2, long)
246#define FS_IOC_GETVERSION _IOR('v', 1, long)
247#define FS_IOC_SETVERSION _IOW('v', 2, long)
248#define FS_IOC_FIEMAP _IOWR('f', 11, struct fiemap)
249#define FS_IOC32_GETFLAGS _IOR('f', 1, int)
250#define FS_IOC32_SETFLAGS _IOW('f', 2, int)
251#define FS_IOC32_GETVERSION _IOR('v', 1, int)
252#define FS_IOC32_SETVERSION _IOW('v', 2, int)
253#define FS_IOC_FSGETXATTR _IOR ('X', 31, struct fsxattr)
254#define FS_IOC_FSSETXATTR _IOW ('X', 32, struct fsxattr)
255
256/*
257 * File system encryption support
258 */
259/* Policy provided via an ioctl on the topmost directory */
260#define FS_KEY_DESCRIPTOR_SIZE 8
261
262#define FS_POLICY_FLAGS_PAD_4 0x00
263#define FS_POLICY_FLAGS_PAD_8 0x01
264#define FS_POLICY_FLAGS_PAD_16 0x02
265#define FS_POLICY_FLAGS_PAD_32 0x03
266#define FS_POLICY_FLAGS_PAD_MASK 0x03
267#define FS_POLICY_FLAGS_VALID 0x03
268
269/* Encryption algorithms */
270#define FS_ENCRYPTION_MODE_INVALID 0
271#define FS_ENCRYPTION_MODE_AES_256_XTS 1
272#define FS_ENCRYPTION_MODE_AES_256_GCM 2
273#define FS_ENCRYPTION_MODE_AES_256_CBC 3
274#define FS_ENCRYPTION_MODE_AES_256_CTS 4
275
276struct fscrypt_policy {
277 __u8 version;
278 __u8 contents_encryption_mode;
279 __u8 filenames_encryption_mode;
280 __u8 flags;
281 __u8 master_key_descriptor[FS_KEY_DESCRIPTOR_SIZE];
282};
283
284#define FS_IOC_SET_ENCRYPTION_POLICY _IOR('f', 19, struct fscrypt_policy)
285#define FS_IOC_GET_ENCRYPTION_PWSALT _IOW('f', 20, __u8[16])
286#define FS_IOC_GET_ENCRYPTION_POLICY _IOW('f', 21, struct fscrypt_policy)
287
288/* Parameters for passing an encryption key into the kernel keyring */
289#define FS_KEY_DESC_PREFIX "fscrypt:"
290#define FS_KEY_DESC_PREFIX_SIZE 8
291
292/* Structure that userspace passes to the kernel keyring */
293#define FS_MAX_KEY_SIZE 64
294
295struct fscrypt_key {
296 __u32 mode;
297 __u8 raw[FS_MAX_KEY_SIZE];
298 __u32 size;
299};
300
301/*
302 * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)
303 *
304 * Note: for historical reasons, these flags were originally used and
305 * defined for use by ext2/ext3, and then other file systems started
306 * using these flags so they wouldn't need to write their own version
307 * of chattr/lsattr (which was shipped as part of e2fsprogs). You
308 * should think twice before trying to use these flags in new
309 * contexts, or trying to assign these flags, since they are used both
310 * as the UAPI and the on-disk encoding for ext2/3/4. Also, we are
311 * almost out of 32-bit flags. :-)
312 *
313 * We have recently hoisted FS_IOC_FSGETXATTR / FS_IOC_FSSETXATTR from
314 * XFS to the generic FS level interface. This uses a structure that
315 * has padding and hence has more room to grow, so it may be more
316 * appropriate for many new use cases.
317 *
318 * Please do not change these flags or interfaces before checking with
319 * linux-fsdevel@vger.kernel.org and linux-api@vger.kernel.org.
320 */
321#define FS_SECRM_FL 0x00000001 /* Secure deletion */
322#define FS_UNRM_FL 0x00000002 /* Undelete */
323#define FS_COMPR_FL 0x00000004 /* Compress file */
324#define FS_SYNC_FL 0x00000008 /* Synchronous updates */
325#define FS_IMMUTABLE_FL 0x00000010 /* Immutable file */
326#define FS_APPEND_FL 0x00000020 /* writes to file may only append */
327#define FS_NODUMP_FL 0x00000040 /* do not dump file */
328#define FS_NOATIME_FL 0x00000080 /* do not update atime */
329/* Reserved for compression usage... */
330#define FS_DIRTY_FL 0x00000100
331#define FS_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
332#define FS_NOCOMP_FL 0x00000400 /* Don't compress */
333/* End compression flags --- maybe not all used */
334#define FS_ENCRYPT_FL 0x00000800 /* Encrypted file */
335#define FS_BTREE_FL 0x00001000 /* btree format dir */
336#define FS_INDEX_FL 0x00001000 /* hash-indexed directory */
337#define FS_IMAGIC_FL 0x00002000 /* AFS directory */
338#define FS_JOURNAL_DATA_FL 0x00004000 /* Reserved for ext3 */
339#define FS_NOTAIL_FL 0x00008000 /* file tail should not be merged */
340#define FS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
341#define FS_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
342#define FS_HUGE_FILE_FL 0x00040000 /* Reserved for ext4 */
343#define FS_EXTENT_FL 0x00080000 /* Extents */
344#define FS_EA_INODE_FL 0x00200000 /* Inode used for large EA */
345#define FS_EOFBLOCKS_FL 0x00400000 /* Reserved for ext4 */
346#define FS_NOCOW_FL 0x00800000 /* Do not cow file */
347#define FS_INLINE_DATA_FL 0x10000000 /* Reserved for ext4 */
348#define FS_PROJINHERIT_FL 0x20000000 /* Create with parents projid */
349#define FS_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
350
351#define FS_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */
352#define FS_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
353
354
355#define SYNC_FILE_RANGE_WAIT_BEFORE 1
356#define SYNC_FILE_RANGE_WRITE 2
357#define SYNC_FILE_RANGE_WAIT_AFTER 4
358
359/* flags for preadv2/pwritev2: */
360#define RWF_HIPRI 0x00000001 /* high priority request, poll if possible */
361#define RWF_DSYNC 0x00000002 /* per-IO O_DSYNC */
362#define RWF_SYNC 0x00000004 /* per-IO O_SYNC */
363
364#endif /* _LINUX_FS_H */
365