Merge tag 'fscrypt_for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/tytso...
[sfrench/cifs-2.6.git] / include / uapi / linux / fs.h
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 /* Use of MS_* flags within the kernel is restricted to core mount(2) code. */
18 #if !defined(__KERNEL__)
19 #include <linux/mount.h>
20 #endif
21
22 /*
23  * It's silly to have NR_OPEN bigger than NR_FILE, but you can change
24  * the file limit at runtime and only root can increase the per-process
25  * nr_file rlimit, so it's safe to set up a ridiculously high absolute
26  * upper limit on files-per-process.
27  *
28  * Some programs (notably those using select()) may have to be 
29  * recompiled to take full advantage of the new limits..  
30  */
31
32 /* Fixed constants first: */
33 #undef NR_OPEN
34 #define INR_OPEN_CUR 1024       /* Initial setting for nfile rlimits */
35 #define INR_OPEN_MAX 4096       /* Hard limit for nfile rlimits */
36
37 #define BLOCK_SIZE_BITS 10
38 #define BLOCK_SIZE (1<<BLOCK_SIZE_BITS)
39
40 #define SEEK_SET        0       /* seek relative to beginning of file */
41 #define SEEK_CUR        1       /* seek relative to current file position */
42 #define SEEK_END        2       /* seek relative to end of file */
43 #define SEEK_DATA       3       /* seek to the next data */
44 #define SEEK_HOLE       4       /* seek to the next hole */
45 #define SEEK_MAX        SEEK_HOLE
46
47 #define RENAME_NOREPLACE        (1 << 0)        /* Don't overwrite target */
48 #define RENAME_EXCHANGE         (1 << 1)        /* Exchange source and dest */
49 #define RENAME_WHITEOUT         (1 << 2)        /* Whiteout source */
50
51 struct file_clone_range {
52         __s64 src_fd;
53         __u64 src_offset;
54         __u64 src_length;
55         __u64 dest_offset;
56 };
57
58 struct fstrim_range {
59         __u64 start;
60         __u64 len;
61         __u64 minlen;
62 };
63
64 /* extent-same (dedupe) ioctls; these MUST match the btrfs ioctl definitions */
65 #define FILE_DEDUPE_RANGE_SAME          0
66 #define FILE_DEDUPE_RANGE_DIFFERS       1
67
68 /* from struct btrfs_ioctl_file_extent_same_info */
69 struct file_dedupe_range_info {
70         __s64 dest_fd;          /* in - destination file */
71         __u64 dest_offset;      /* in - start of extent in destination */
72         __u64 bytes_deduped;    /* out - total # of bytes we were able
73                                  * to dedupe from this file. */
74         /* status of this dedupe operation:
75          * < 0 for error
76          * == FILE_DEDUPE_RANGE_SAME if dedupe succeeds
77          * == FILE_DEDUPE_RANGE_DIFFERS if data differs
78          */
79         __s32 status;           /* out - see above description */
80         __u32 reserved;         /* must be zero */
81 };
82
83 /* from struct btrfs_ioctl_file_extent_same_args */
84 struct file_dedupe_range {
85         __u64 src_offset;       /* in - start of extent in source */
86         __u64 src_length;       /* in - length of extent */
87         __u16 dest_count;       /* in - total elements in info array */
88         __u16 reserved1;        /* must be zero */
89         __u32 reserved2;        /* must be zero */
90         struct file_dedupe_range_info info[0];
91 };
92
93 /* And dynamically-tunable limits and defaults: */
94 struct files_stat_struct {
95         unsigned long nr_files;         /* read only */
96         unsigned long nr_free_files;    /* read only */
97         unsigned long max_files;                /* tunable */
98 };
99
100 struct inodes_stat_t {
101         long nr_inodes;
102         long nr_unused;
103         long dummy[5];          /* padding for sysctl ABI compatibility */
104 };
105
106
107 #define NR_FILE  8192   /* this can well be larger on a larger system */
108
109 /*
110  * Structure for FS_IOC_FSGETXATTR[A] and FS_IOC_FSSETXATTR.
111  */
112 struct fsxattr {
113         __u32           fsx_xflags;     /* xflags field value (get/set) */
114         __u32           fsx_extsize;    /* extsize field value (get/set)*/
115         __u32           fsx_nextents;   /* nextents field value (get)   */
116         __u32           fsx_projid;     /* project identifier (get/set) */
117         __u32           fsx_cowextsize; /* CoW extsize field value (get/set)*/
118         unsigned char   fsx_pad[8];
119 };
120
121 /*
122  * Flags for the fsx_xflags field
123  */
124 #define FS_XFLAG_REALTIME       0x00000001      /* data in realtime volume */
125 #define FS_XFLAG_PREALLOC       0x00000002      /* preallocated file extents */
126 #define FS_XFLAG_IMMUTABLE      0x00000008      /* file cannot be modified */
127 #define FS_XFLAG_APPEND         0x00000010      /* all writes append */
128 #define FS_XFLAG_SYNC           0x00000020      /* all writes synchronous */
129 #define FS_XFLAG_NOATIME        0x00000040      /* do not update access time */
130 #define FS_XFLAG_NODUMP         0x00000080      /* do not include in backups */
131 #define FS_XFLAG_RTINHERIT      0x00000100      /* create with rt bit set */
132 #define FS_XFLAG_PROJINHERIT    0x00000200      /* create with parents projid */
133 #define FS_XFLAG_NOSYMLINKS     0x00000400      /* disallow symlink creation */
134 #define FS_XFLAG_EXTSIZE        0x00000800      /* extent size allocator hint */
135 #define FS_XFLAG_EXTSZINHERIT   0x00001000      /* inherit inode extent size */
136 #define FS_XFLAG_NODEFRAG       0x00002000      /* do not defragment */
137 #define FS_XFLAG_FILESTREAM     0x00004000      /* use filestream allocator */
138 #define FS_XFLAG_DAX            0x00008000      /* use DAX for IO */
139 #define FS_XFLAG_COWEXTSIZE     0x00010000      /* CoW extent size allocator hint */
140 #define FS_XFLAG_HASATTR        0x80000000      /* no DIFLAG for this   */
141
142 /* the read-only stuff doesn't really belong here, but any other place is
143    probably as bad and I don't want to create yet another include file. */
144
145 #define BLKROSET   _IO(0x12,93) /* set device read-only (0 = read-write) */
146 #define BLKROGET   _IO(0x12,94) /* get read-only status (0 = read_write) */
147 #define BLKRRPART  _IO(0x12,95) /* re-read partition table */
148 #define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */
149 #define BLKFLSBUF  _IO(0x12,97) /* flush buffer cache */
150 #define BLKRASET   _IO(0x12,98) /* set read ahead for block device */
151 #define BLKRAGET   _IO(0x12,99) /* get current read ahead setting */
152 #define BLKFRASET  _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
153 #define BLKFRAGET  _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
154 #define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
155 #define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
156 #define BLKSSZGET  _IO(0x12,104)/* get block device sector size */
157 #if 0
158 #define BLKPG      _IO(0x12,105)/* See blkpg.h */
159
160 /* Some people are morons.  Do not use sizeof! */
161
162 #define BLKELVGET  _IOR(0x12,106,size_t)/* elevator get */
163 #define BLKELVSET  _IOW(0x12,107,size_t)/* elevator set */
164 /* This was here just to show that the number is taken -
165    probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
166 #endif
167 /* A jump here: 108-111 have been used for various private purposes. */
168 #define BLKBSZGET  _IOR(0x12,112,size_t)
169 #define BLKBSZSET  _IOW(0x12,113,size_t)
170 #define BLKGETSIZE64 _IOR(0x12,114,size_t)      /* return device size in bytes (u64 *arg) */
171 #define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
172 #define BLKTRACESTART _IO(0x12,116)
173 #define BLKTRACESTOP _IO(0x12,117)
174 #define BLKTRACETEARDOWN _IO(0x12,118)
175 #define BLKDISCARD _IO(0x12,119)
176 #define BLKIOMIN _IO(0x12,120)
177 #define BLKIOOPT _IO(0x12,121)
178 #define BLKALIGNOFF _IO(0x12,122)
179 #define BLKPBSZGET _IO(0x12,123)
180 #define BLKDISCARDZEROES _IO(0x12,124)
181 #define BLKSECDISCARD _IO(0x12,125)
182 #define BLKROTATIONAL _IO(0x12,126)
183 #define BLKZEROOUT _IO(0x12,127)
184 /*
185  * A jump here: 130-131 are reserved for zoned block devices
186  * (see uapi/linux/blkzoned.h)
187  */
188
189 #define BMAP_IOCTL 1            /* obsolete - kept for compatibility */
190 #define FIBMAP     _IO(0x00,1)  /* bmap access */
191 #define FIGETBSZ   _IO(0x00,2)  /* get the block size used for bmap */
192 #define FIFREEZE        _IOWR('X', 119, int)    /* Freeze */
193 #define FITHAW          _IOWR('X', 120, int)    /* Thaw */
194 #define FITRIM          _IOWR('X', 121, struct fstrim_range)    /* Trim */
195 #define FICLONE         _IOW(0x94, 9, int)
196 #define FICLONERANGE    _IOW(0x94, 13, struct file_clone_range)
197 #define FIDEDUPERANGE   _IOWR(0x94, 54, struct file_dedupe_range)
198
199 #define FSLABEL_MAX 256 /* Max chars for the interface; each fs may differ */
200
201 #define FS_IOC_GETFLAGS                 _IOR('f', 1, long)
202 #define FS_IOC_SETFLAGS                 _IOW('f', 2, long)
203 #define FS_IOC_GETVERSION               _IOR('v', 1, long)
204 #define FS_IOC_SETVERSION               _IOW('v', 2, long)
205 #define FS_IOC_FIEMAP                   _IOWR('f', 11, struct fiemap)
206 #define FS_IOC32_GETFLAGS               _IOR('f', 1, int)
207 #define FS_IOC32_SETFLAGS               _IOW('f', 2, int)
208 #define FS_IOC32_GETVERSION             _IOR('v', 1, int)
209 #define FS_IOC32_SETVERSION             _IOW('v', 2, int)
210 #define FS_IOC_FSGETXATTR               _IOR('X', 31, struct fsxattr)
211 #define FS_IOC_FSSETXATTR               _IOW('X', 32, struct fsxattr)
212 #define FS_IOC_GETFSLABEL               _IOR(0x94, 49, char[FSLABEL_MAX])
213 #define FS_IOC_SETFSLABEL               _IOW(0x94, 50, char[FSLABEL_MAX])
214
215 /*
216  * File system encryption support
217  */
218 /* Policy provided via an ioctl on the topmost directory */
219 #define FS_KEY_DESCRIPTOR_SIZE  8
220
221 #define FS_POLICY_FLAGS_PAD_4           0x00
222 #define FS_POLICY_FLAGS_PAD_8           0x01
223 #define FS_POLICY_FLAGS_PAD_16          0x02
224 #define FS_POLICY_FLAGS_PAD_32          0x03
225 #define FS_POLICY_FLAGS_PAD_MASK        0x03
226 #define FS_POLICY_FLAG_DIRECT_KEY       0x04    /* use master key directly */
227 #define FS_POLICY_FLAGS_VALID           0x07
228
229 /* Encryption algorithms */
230 #define FS_ENCRYPTION_MODE_INVALID              0
231 #define FS_ENCRYPTION_MODE_AES_256_XTS          1
232 #define FS_ENCRYPTION_MODE_AES_256_GCM          2
233 #define FS_ENCRYPTION_MODE_AES_256_CBC          3
234 #define FS_ENCRYPTION_MODE_AES_256_CTS          4
235 #define FS_ENCRYPTION_MODE_AES_128_CBC          5
236 #define FS_ENCRYPTION_MODE_AES_128_CTS          6
237 #define FS_ENCRYPTION_MODE_SPECK128_256_XTS     7 /* Removed, do not use. */
238 #define FS_ENCRYPTION_MODE_SPECK128_256_CTS     8 /* Removed, do not use. */
239 #define FS_ENCRYPTION_MODE_ADIANTUM             9
240
241 struct fscrypt_policy {
242         __u8 version;
243         __u8 contents_encryption_mode;
244         __u8 filenames_encryption_mode;
245         __u8 flags;
246         __u8 master_key_descriptor[FS_KEY_DESCRIPTOR_SIZE];
247 };
248
249 #define FS_IOC_SET_ENCRYPTION_POLICY    _IOR('f', 19, struct fscrypt_policy)
250 #define FS_IOC_GET_ENCRYPTION_PWSALT    _IOW('f', 20, __u8[16])
251 #define FS_IOC_GET_ENCRYPTION_POLICY    _IOW('f', 21, struct fscrypt_policy)
252
253 /* Parameters for passing an encryption key into the kernel keyring */
254 #define FS_KEY_DESC_PREFIX              "fscrypt:"
255 #define FS_KEY_DESC_PREFIX_SIZE         8
256
257 /* Structure that userspace passes to the kernel keyring */
258 #define FS_MAX_KEY_SIZE                 64
259
260 struct fscrypt_key {
261         __u32 mode;
262         __u8 raw[FS_MAX_KEY_SIZE];
263         __u32 size;
264 };
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 /*
325  * Flags for preadv2/pwritev2:
326  */
327
328 typedef int __bitwise __kernel_rwf_t;
329
330 /* high priority request, poll if possible */
331 #define RWF_HIPRI       ((__force __kernel_rwf_t)0x00000001)
332
333 /* per-IO O_DSYNC */
334 #define RWF_DSYNC       ((__force __kernel_rwf_t)0x00000002)
335
336 /* per-IO O_SYNC */
337 #define RWF_SYNC        ((__force __kernel_rwf_t)0x00000004)
338
339 /* per-IO, return -EAGAIN if operation would block */
340 #define RWF_NOWAIT      ((__force __kernel_rwf_t)0x00000008)
341
342 /* per-IO O_APPEND */
343 #define RWF_APPEND      ((__force __kernel_rwf_t)0x00000010)
344
345 /* mask of flags supported by the kernel */
346 #define RWF_SUPPORTED   (RWF_HIPRI | RWF_DSYNC | RWF_SYNC | RWF_NOWAIT |\
347                          RWF_APPEND)
348
349 #endif /* _UAPI_LINUX_FS_H */