16f52b16cSGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2607ca46eSDavid Howells #ifndef _UAPI_LINUX_FS_H 3607ca46eSDavid Howells #define _UAPI_LINUX_FS_H 4607ca46eSDavid Howells 5607ca46eSDavid Howells /* 668ce7bfcSTheodore Ts'o * This file has definitions for some important file table structures 768ce7bfcSTheodore Ts'o * and constants and structures used by various generic file system 868ce7bfcSTheodore Ts'o * ioctl's. Please do not make any changes in this file before 968ce7bfcSTheodore Ts'o * sending patches for review to [email protected] and 1068ce7bfcSTheodore Ts'o * [email protected]. 11607ca46eSDavid Howells */ 12607ca46eSDavid Howells 13607ca46eSDavid Howells #include <linux/limits.h> 14607ca46eSDavid Howells #include <linux/ioctl.h> 15607ca46eSDavid Howells #include <linux/types.h> 167af0ab0dSEric Biggers #ifndef __KERNEL__ 177af0ab0dSEric Biggers #include <linux/fscrypt.h> 187af0ab0dSEric Biggers #endif 19607ca46eSDavid Howells 20e262e32dSDavid Howells /* Use of MS_* flags within the kernel is restricted to core mount(2) code. */ 21e262e32dSDavid Howells #if !defined(__KERNEL__) 22e262e32dSDavid Howells #include <linux/mount.h> 23e262e32dSDavid Howells #endif 24e262e32dSDavid Howells 25607ca46eSDavid Howells /* 26607ca46eSDavid Howells * It's silly to have NR_OPEN bigger than NR_FILE, but you can change 27607ca46eSDavid Howells * the file limit at runtime and only root can increase the per-process 28607ca46eSDavid Howells * nr_file rlimit, so it's safe to set up a ridiculously high absolute 29607ca46eSDavid Howells * upper limit on files-per-process. 30607ca46eSDavid Howells * 31607ca46eSDavid Howells * Some programs (notably those using select()) may have to be 32607ca46eSDavid Howells * recompiled to take full advantage of the new limits.. 33607ca46eSDavid Howells */ 34607ca46eSDavid Howells 35607ca46eSDavid Howells /* Fixed constants first: */ 36607ca46eSDavid Howells #undef NR_OPEN 37607ca46eSDavid Howells #define INR_OPEN_CUR 1024 /* Initial setting for nfile rlimits */ 38607ca46eSDavid Howells #define INR_OPEN_MAX 4096 /* Hard limit for nfile rlimits */ 39607ca46eSDavid Howells 40607ca46eSDavid Howells #define BLOCK_SIZE_BITS 10 41607ca46eSDavid Howells #define BLOCK_SIZE (1<<BLOCK_SIZE_BITS) 42607ca46eSDavid Howells 4310783d0bSAnuj Gupta /* flags for integrity meta */ 4410783d0bSAnuj Gupta #define IO_INTEGRITY_CHK_GUARD (1U << 0) /* enforce guard check */ 4510783d0bSAnuj Gupta #define IO_INTEGRITY_CHK_REFTAG (1U << 1) /* enforce ref check */ 4610783d0bSAnuj Gupta #define IO_INTEGRITY_CHK_APPTAG (1U << 2) /* enforce app check */ 4710783d0bSAnuj Gupta 4810783d0bSAnuj Gupta #define IO_INTEGRITY_VALID_FLAGS (IO_INTEGRITY_CHK_GUARD | \ 4910783d0bSAnuj Gupta IO_INTEGRITY_CHK_REFTAG | \ 5010783d0bSAnuj Gupta IO_INTEGRITY_CHK_APPTAG) 5110783d0bSAnuj Gupta 52607ca46eSDavid Howells #define SEEK_SET 0 /* seek relative to beginning of file */ 53607ca46eSDavid Howells #define SEEK_CUR 1 /* seek relative to current file position */ 54607ca46eSDavid Howells #define SEEK_END 2 /* seek relative to end of file */ 55607ca46eSDavid Howells #define SEEK_DATA 3 /* seek to the next data */ 56607ca46eSDavid Howells #define SEEK_HOLE 4 /* seek to the next hole */ 57607ca46eSDavid Howells #define SEEK_MAX SEEK_HOLE 58607ca46eSDavid Howells 590a7c3937SMiklos Szeredi #define RENAME_NOREPLACE (1 << 0) /* Don't overwrite target */ 60da1ce067SMiklos Szeredi #define RENAME_EXCHANGE (1 << 1) /* Exchange source and dest */ 610d7a8555SMiklos Szeredi #define RENAME_WHITEOUT (1 << 2) /* Whiteout source */ 620a7c3937SMiklos Szeredi 6304b38d60SChristoph Hellwig struct file_clone_range { 6404b38d60SChristoph Hellwig __s64 src_fd; 6504b38d60SChristoph Hellwig __u64 src_offset; 6604b38d60SChristoph Hellwig __u64 src_length; 6704b38d60SChristoph Hellwig __u64 dest_offset; 6804b38d60SChristoph Hellwig }; 6904b38d60SChristoph Hellwig 70607ca46eSDavid Howells struct fstrim_range { 71607ca46eSDavid Howells __u64 start; 72607ca46eSDavid Howells __u64 len; 73607ca46eSDavid Howells __u64 minlen; 74607ca46eSDavid Howells }; 75607ca46eSDavid Howells 7641bcbe59SKent Overstreet /* 7741bcbe59SKent Overstreet * We include a length field because some filesystems (vfat) have an identifier 7841bcbe59SKent Overstreet * that we do want to expose as a UUID, but doesn't have the standard length. 7941bcbe59SKent Overstreet * 8041bcbe59SKent Overstreet * We use a fixed size buffer beacuse this interface will, by fiat, never 8141bcbe59SKent Overstreet * support "UUIDs" longer than 16 bytes; we don't want to force all downstream 8241bcbe59SKent Overstreet * users to have to deal with that. 8341bcbe59SKent Overstreet */ 8441bcbe59SKent Overstreet struct fsuuid2 { 8541bcbe59SKent Overstreet __u8 len; 8641bcbe59SKent Overstreet __u8 uuid[16]; 8741bcbe59SKent Overstreet }; 8841bcbe59SKent Overstreet 89ae8c5117SKent Overstreet struct fs_sysfs_path { 90ae8c5117SKent Overstreet __u8 len; 91ae8c5117SKent Overstreet __u8 name[128]; 92ae8c5117SKent Overstreet }; 93ae8c5117SKent Overstreet 9454dbc151SDarrick J. Wong /* extent-same (dedupe) ioctls; these MUST match the btrfs ioctl definitions */ 9554dbc151SDarrick J. Wong #define FILE_DEDUPE_RANGE_SAME 0 9654dbc151SDarrick J. Wong #define FILE_DEDUPE_RANGE_DIFFERS 1 9754dbc151SDarrick J. Wong 9854dbc151SDarrick J. Wong /* from struct btrfs_ioctl_file_extent_same_info */ 9954dbc151SDarrick J. Wong struct file_dedupe_range_info { 10054dbc151SDarrick J. Wong __s64 dest_fd; /* in - destination file */ 10154dbc151SDarrick J. Wong __u64 dest_offset; /* in - start of extent in destination */ 10254dbc151SDarrick J. Wong __u64 bytes_deduped; /* out - total # of bytes we were able 10354dbc151SDarrick J. Wong * to dedupe from this file. */ 10454dbc151SDarrick J. Wong /* status of this dedupe operation: 10554dbc151SDarrick J. Wong * < 0 for error 10654dbc151SDarrick J. Wong * == FILE_DEDUPE_RANGE_SAME if dedupe succeeds 10754dbc151SDarrick J. Wong * == FILE_DEDUPE_RANGE_DIFFERS if data differs 10854dbc151SDarrick J. Wong */ 10954dbc151SDarrick J. Wong __s32 status; /* out - see above description */ 11054dbc151SDarrick J. Wong __u32 reserved; /* must be zero */ 11154dbc151SDarrick J. Wong }; 11254dbc151SDarrick J. Wong 11354dbc151SDarrick J. Wong /* from struct btrfs_ioctl_file_extent_same_args */ 11454dbc151SDarrick J. Wong struct file_dedupe_range { 11554dbc151SDarrick J. Wong __u64 src_offset; /* in - start of extent in source */ 11654dbc151SDarrick J. Wong __u64 src_length; /* in - length of extent */ 11754dbc151SDarrick J. Wong __u16 dest_count; /* in - total elements in info array */ 11854dbc151SDarrick J. Wong __u16 reserved1; /* must be zero */ 11954dbc151SDarrick J. Wong __u32 reserved2; /* must be zero */ 12094dfc73eSGustavo A. R. Silva struct file_dedupe_range_info info[]; 12154dbc151SDarrick J. Wong }; 12254dbc151SDarrick J. Wong 123607ca46eSDavid Howells /* And dynamically-tunable limits and defaults: */ 124607ca46eSDavid Howells struct files_stat_struct { 125607ca46eSDavid Howells unsigned long nr_files; /* read only */ 126607ca46eSDavid Howells unsigned long nr_free_files; /* read only */ 127607ca46eSDavid Howells unsigned long max_files; /* tunable */ 128607ca46eSDavid Howells }; 129607ca46eSDavid Howells 130607ca46eSDavid Howells struct inodes_stat_t { 1313942c07cSGlauber Costa long nr_inodes; 1323942c07cSGlauber Costa long nr_unused; 1333942c07cSGlauber Costa long dummy[5]; /* padding for sysctl ABI compatibility */ 134607ca46eSDavid Howells }; 135607ca46eSDavid Howells 136607ca46eSDavid Howells 137607ca46eSDavid Howells #define NR_FILE 8192 /* this can well be larger on a larger system */ 138607ca46eSDavid Howells 139334e580aSDave Chinner /* 140334e580aSDave Chinner * Structure for FS_IOC_FSGETXATTR[A] and FS_IOC_FSSETXATTR. 141334e580aSDave Chinner */ 142334e580aSDave Chinner struct fsxattr { 143334e580aSDave Chinner __u32 fsx_xflags; /* xflags field value (get/set) */ 144334e580aSDave Chinner __u32 fsx_extsize; /* extsize field value (get/set)*/ 145334e580aSDave Chinner __u32 fsx_nextents; /* nextents field value (get) */ 146334e580aSDave Chinner __u32 fsx_projid; /* project identifier (get/set) */ 1470a6eab8bSDarrick J. Wong __u32 fsx_cowextsize; /* CoW extsize field value (get/set)*/ 1480a6eab8bSDarrick J. Wong unsigned char fsx_pad[8]; 149334e580aSDave Chinner }; 150334e580aSDave Chinner 151334e580aSDave Chinner /* 152334e580aSDave Chinner * Flags for the fsx_xflags field 153334e580aSDave Chinner */ 154334e580aSDave Chinner #define FS_XFLAG_REALTIME 0x00000001 /* data in realtime volume */ 155334e580aSDave Chinner #define FS_XFLAG_PREALLOC 0x00000002 /* preallocated file extents */ 156334e580aSDave Chinner #define FS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */ 157334e580aSDave Chinner #define FS_XFLAG_APPEND 0x00000010 /* all writes append */ 158334e580aSDave Chinner #define FS_XFLAG_SYNC 0x00000020 /* all writes synchronous */ 159334e580aSDave Chinner #define FS_XFLAG_NOATIME 0x00000040 /* do not update access time */ 160334e580aSDave Chinner #define FS_XFLAG_NODUMP 0x00000080 /* do not include in backups */ 161334e580aSDave Chinner #define FS_XFLAG_RTINHERIT 0x00000100 /* create with rt bit set */ 162334e580aSDave Chinner #define FS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */ 163334e580aSDave Chinner #define FS_XFLAG_NOSYMLINKS 0x00000400 /* disallow symlink creation */ 164334e580aSDave Chinner #define FS_XFLAG_EXTSIZE 0x00000800 /* extent size allocator hint */ 165334e580aSDave Chinner #define FS_XFLAG_EXTSZINHERIT 0x00001000 /* inherit inode extent size */ 166334e580aSDave Chinner #define FS_XFLAG_NODEFRAG 0x00002000 /* do not defragment */ 167334e580aSDave Chinner #define FS_XFLAG_FILESTREAM 0x00004000 /* use filestream allocator */ 16858f88ca2SDave Chinner #define FS_XFLAG_DAX 0x00008000 /* use DAX for IO */ 1690a6eab8bSDarrick J. Wong #define FS_XFLAG_COWEXTSIZE 0x00010000 /* CoW extent size allocator hint */ 170334e580aSDave Chinner #define FS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */ 171334e580aSDave Chinner 172607ca46eSDavid Howells /* the read-only stuff doesn't really belong here, but any other place is 173607ca46eSDavid Howells probably as bad and I don't want to create yet another include file. */ 174607ca46eSDavid Howells 175607ca46eSDavid Howells #define BLKROSET _IO(0x12,93) /* set device read-only (0 = read-write) */ 176607ca46eSDavid Howells #define BLKROGET _IO(0x12,94) /* get read-only status (0 = read_write) */ 177607ca46eSDavid Howells #define BLKRRPART _IO(0x12,95) /* re-read partition table */ 178607ca46eSDavid Howells #define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */ 179607ca46eSDavid Howells #define BLKFLSBUF _IO(0x12,97) /* flush buffer cache */ 180607ca46eSDavid Howells #define BLKRASET _IO(0x12,98) /* set read ahead for block device */ 181607ca46eSDavid Howells #define BLKRAGET _IO(0x12,99) /* get current read ahead setting */ 182607ca46eSDavid Howells #define BLKFRASET _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */ 183607ca46eSDavid Howells #define BLKFRAGET _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */ 184607ca46eSDavid Howells #define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */ 185607ca46eSDavid Howells #define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */ 186607ca46eSDavid Howells #define BLKSSZGET _IO(0x12,104)/* get block device sector size */ 187607ca46eSDavid Howells #if 0 188607ca46eSDavid Howells #define BLKPG _IO(0x12,105)/* See blkpg.h */ 189607ca46eSDavid Howells 190607ca46eSDavid Howells /* Some people are morons. Do not use sizeof! */ 191607ca46eSDavid Howells 192607ca46eSDavid Howells #define BLKELVGET _IOR(0x12,106,size_t)/* elevator get */ 193607ca46eSDavid Howells #define BLKELVSET _IOW(0x12,107,size_t)/* elevator set */ 194607ca46eSDavid Howells /* This was here just to show that the number is taken - 195607ca46eSDavid Howells probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */ 196607ca46eSDavid Howells #endif 197607ca46eSDavid Howells /* A jump here: 108-111 have been used for various private purposes. */ 198607ca46eSDavid Howells #define BLKBSZGET _IOR(0x12,112,size_t) 199607ca46eSDavid Howells #define BLKBSZSET _IOW(0x12,113,size_t) 200607ca46eSDavid Howells #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */ 201607ca46eSDavid Howells #define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup) 202607ca46eSDavid Howells #define BLKTRACESTART _IO(0x12,116) 203607ca46eSDavid Howells #define BLKTRACESTOP _IO(0x12,117) 204607ca46eSDavid Howells #define BLKTRACETEARDOWN _IO(0x12,118) 205607ca46eSDavid Howells #define BLKDISCARD _IO(0x12,119) 206607ca46eSDavid Howells #define BLKIOMIN _IO(0x12,120) 207607ca46eSDavid Howells #define BLKIOOPT _IO(0x12,121) 208607ca46eSDavid Howells #define BLKALIGNOFF _IO(0x12,122) 209607ca46eSDavid Howells #define BLKPBSZGET _IO(0x12,123) 210607ca46eSDavid Howells #define BLKDISCARDZEROES _IO(0x12,124) 211607ca46eSDavid Howells #define BLKSECDISCARD _IO(0x12,125) 212607ca46eSDavid Howells #define BLKROTATIONAL _IO(0x12,126) 213607ca46eSDavid Howells #define BLKZEROOUT _IO(0x12,127) 2147957d93bSMatteo Croce #define BLKGETDISKSEQ _IOR(0x12,128,__u64) 215*1ebd4a3cSEric Biggers /* 130-136 are used by zoned block device ioctls (uapi/linux/blkzoned.h) */ 216*1ebd4a3cSEric Biggers /* 137-141 are used by blk-crypto ioctls (uapi/linux/blk-crypto.h) */ 217607ca46eSDavid Howells 218607ca46eSDavid Howells #define BMAP_IOCTL 1 /* obsolete - kept for compatibility */ 219607ca46eSDavid Howells #define FIBMAP _IO(0x00,1) /* bmap access */ 220607ca46eSDavid Howells #define FIGETBSZ _IO(0x00,2) /* get the block size used for bmap */ 221607ca46eSDavid Howells #define FIFREEZE _IOWR('X', 119, int) /* Freeze */ 222607ca46eSDavid Howells #define FITHAW _IOWR('X', 120, int) /* Thaw */ 223607ca46eSDavid Howells #define FITRIM _IOWR('X', 121, struct fstrim_range) /* Trim */ 22404b38d60SChristoph Hellwig #define FICLONE _IOW(0x94, 9, int) 22504b38d60SChristoph Hellwig #define FICLONERANGE _IOW(0x94, 13, struct file_clone_range) 22654dbc151SDarrick J. Wong #define FIDEDUPERANGE _IOWR(0x94, 54, struct file_dedupe_range) 227607ca46eSDavid Howells 22862750d04SEric Sandeen #define FSLABEL_MAX 256 /* Max chars for the interface; each fs may differ */ 22962750d04SEric Sandeen 230607ca46eSDavid Howells #define FS_IOC_GETFLAGS _IOR('f', 1, long) 231607ca46eSDavid Howells #define FS_IOC_SETFLAGS _IOW('f', 2, long) 232607ca46eSDavid Howells #define FS_IOC_GETVERSION _IOR('v', 1, long) 233607ca46eSDavid Howells #define FS_IOC_SETVERSION _IOW('v', 2, long) 234607ca46eSDavid Howells #define FS_IOC_FIEMAP _IOWR('f', 11, struct fiemap) 235607ca46eSDavid Howells #define FS_IOC32_GETFLAGS _IOR('f', 1, int) 236607ca46eSDavid Howells #define FS_IOC32_SETFLAGS _IOW('f', 2, int) 237607ca46eSDavid Howells #define FS_IOC32_GETVERSION _IOR('v', 1, int) 238607ca46eSDavid Howells #define FS_IOC32_SETVERSION _IOW('v', 2, int) 239334e580aSDave Chinner #define FS_IOC_FSGETXATTR _IOR('X', 31, struct fsxattr) 240334e580aSDave Chinner #define FS_IOC_FSSETXATTR _IOW('X', 32, struct fsxattr) 24162750d04SEric Sandeen #define FS_IOC_GETFSLABEL _IOR(0x94, 49, char[FSLABEL_MAX]) 24262750d04SEric Sandeen #define FS_IOC_SETFSLABEL _IOW(0x94, 50, char[FSLABEL_MAX]) 24341bcbe59SKent Overstreet /* Returns the external filesystem UUID, the same one blkid returns */ 24441bcbe59SKent Overstreet #define FS_IOC_GETFSUUID _IOR(0x15, 0, struct fsuuid2) 245ae8c5117SKent Overstreet /* 246ae8c5117SKent Overstreet * Returns the path component under /sys/fs/ that refers to this filesystem; 247ae8c5117SKent Overstreet * also /sys/kernel/debug/ for filesystems with debugfs exports 248ae8c5117SKent Overstreet */ 249ae8c5117SKent Overstreet #define FS_IOC_GETFSSYSFSPATH _IOR(0x15, 1, struct fs_sysfs_path) 250607ca46eSDavid Howells 251607ca46eSDavid Howells /* 252607ca46eSDavid Howells * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS) 25368ce7bfcSTheodore Ts'o * 25468ce7bfcSTheodore Ts'o * Note: for historical reasons, these flags were originally used and 25568ce7bfcSTheodore Ts'o * defined for use by ext2/ext3, and then other file systems started 25668ce7bfcSTheodore Ts'o * using these flags so they wouldn't need to write their own version 25768ce7bfcSTheodore Ts'o * of chattr/lsattr (which was shipped as part of e2fsprogs). You 25868ce7bfcSTheodore Ts'o * should think twice before trying to use these flags in new 25968ce7bfcSTheodore Ts'o * contexts, or trying to assign these flags, since they are used both 26068ce7bfcSTheodore Ts'o * as the UAPI and the on-disk encoding for ext2/3/4. Also, we are 26168ce7bfcSTheodore Ts'o * almost out of 32-bit flags. :-) 26268ce7bfcSTheodore Ts'o * 26368ce7bfcSTheodore Ts'o * We have recently hoisted FS_IOC_FSGETXATTR / FS_IOC_FSSETXATTR from 26468ce7bfcSTheodore Ts'o * XFS to the generic FS level interface. This uses a structure that 26568ce7bfcSTheodore Ts'o * has padding and hence has more room to grow, so it may be more 26668ce7bfcSTheodore Ts'o * appropriate for many new use cases. 26768ce7bfcSTheodore Ts'o * 26868ce7bfcSTheodore Ts'o * Please do not change these flags or interfaces before checking with 26968ce7bfcSTheodore Ts'o * [email protected] and [email protected]. 270607ca46eSDavid Howells */ 271607ca46eSDavid Howells #define FS_SECRM_FL 0x00000001 /* Secure deletion */ 272607ca46eSDavid Howells #define FS_UNRM_FL 0x00000002 /* Undelete */ 273607ca46eSDavid Howells #define FS_COMPR_FL 0x00000004 /* Compress file */ 274607ca46eSDavid Howells #define FS_SYNC_FL 0x00000008 /* Synchronous updates */ 275607ca46eSDavid Howells #define FS_IMMUTABLE_FL 0x00000010 /* Immutable file */ 276607ca46eSDavid Howells #define FS_APPEND_FL 0x00000020 /* writes to file may only append */ 277607ca46eSDavid Howells #define FS_NODUMP_FL 0x00000040 /* do not dump file */ 278607ca46eSDavid Howells #define FS_NOATIME_FL 0x00000080 /* do not update atime */ 279607ca46eSDavid Howells /* Reserved for compression usage... */ 280607ca46eSDavid Howells #define FS_DIRTY_FL 0x00000100 281607ca46eSDavid Howells #define FS_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */ 282607ca46eSDavid Howells #define FS_NOCOMP_FL 0x00000400 /* Don't compress */ 283607ca46eSDavid Howells /* End compression flags --- maybe not all used */ 28468ce7bfcSTheodore Ts'o #define FS_ENCRYPT_FL 0x00000800 /* Encrypted file */ 285607ca46eSDavid Howells #define FS_BTREE_FL 0x00001000 /* btree format dir */ 286607ca46eSDavid Howells #define FS_INDEX_FL 0x00001000 /* hash-indexed directory */ 287607ca46eSDavid Howells #define FS_IMAGIC_FL 0x00002000 /* AFS directory */ 288607ca46eSDavid Howells #define FS_JOURNAL_DATA_FL 0x00004000 /* Reserved for ext3 */ 289607ca46eSDavid Howells #define FS_NOTAIL_FL 0x00008000 /* file tail should not be merged */ 290607ca46eSDavid Howells #define FS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */ 291607ca46eSDavid Howells #define FS_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/ 29268ce7bfcSTheodore Ts'o #define FS_HUGE_FILE_FL 0x00040000 /* Reserved for ext4 */ 293607ca46eSDavid Howells #define FS_EXTENT_FL 0x00080000 /* Extents */ 294fe9918d3SEric Biggers #define FS_VERITY_FL 0x00100000 /* Verity protected inode */ 29568ce7bfcSTheodore Ts'o #define FS_EA_INODE_FL 0x00200000 /* Inode used for large EA */ 29668ce7bfcSTheodore Ts'o #define FS_EOFBLOCKS_FL 0x00400000 /* Reserved for ext4 */ 297607ca46eSDavid Howells #define FS_NOCOW_FL 0x00800000 /* Do not cow file */ 298b383a73fSIra Weiny #define FS_DAX_FL 0x02000000 /* Inode is DAX */ 29968ce7bfcSTheodore Ts'o #define FS_INLINE_DATA_FL 0x10000000 /* Reserved for ext4 */ 3008b4953e1STheodore Ts'o #define FS_PROJINHERIT_FL 0x20000000 /* Create with parents projid */ 30171e90b46SDaniel Rosenberg #define FS_CASEFOLD_FL 0x40000000 /* Folder is case insensitive */ 302607ca46eSDavid Howells #define FS_RESERVED_FL 0x80000000 /* reserved for ext2 lib */ 303607ca46eSDavid Howells 304607ca46eSDavid Howells #define FS_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */ 305607ca46eSDavid Howells #define FS_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */ 306607ca46eSDavid Howells 307607ca46eSDavid Howells 308607ca46eSDavid Howells #define SYNC_FILE_RANGE_WAIT_BEFORE 1 309607ca46eSDavid Howells #define SYNC_FILE_RANGE_WRITE 2 310607ca46eSDavid Howells #define SYNC_FILE_RANGE_WAIT_AFTER 4 311c553ea4fSAmir Goldstein #define SYNC_FILE_RANGE_WRITE_AND_WAIT (SYNC_FILE_RANGE_WRITE | \ 312c553ea4fSAmir Goldstein SYNC_FILE_RANGE_WAIT_BEFORE | \ 313c553ea4fSAmir Goldstein SYNC_FILE_RANGE_WAIT_AFTER) 314607ca46eSDavid Howells 315ddef7ed2SChristoph Hellwig /* 316ddef7ed2SChristoph Hellwig * Flags for preadv2/pwritev2: 317ddef7ed2SChristoph Hellwig */ 31897be7ebeSChristoph Hellwig 319ddef7ed2SChristoph Hellwig typedef int __bitwise __kernel_rwf_t; 320ddef7ed2SChristoph Hellwig 321ddef7ed2SChristoph Hellwig /* high priority request, poll if possible */ 322ddef7ed2SChristoph Hellwig #define RWF_HIPRI ((__force __kernel_rwf_t)0x00000001) 323ddef7ed2SChristoph Hellwig 324ddef7ed2SChristoph Hellwig /* per-IO O_DSYNC */ 325ddef7ed2SChristoph Hellwig #define RWF_DSYNC ((__force __kernel_rwf_t)0x00000002) 326ddef7ed2SChristoph Hellwig 327ddef7ed2SChristoph Hellwig /* per-IO O_SYNC */ 328ddef7ed2SChristoph Hellwig #define RWF_SYNC ((__force __kernel_rwf_t)0x00000004) 329ddef7ed2SChristoph Hellwig 330ddef7ed2SChristoph Hellwig /* per-IO, return -EAGAIN if operation would block */ 331ddef7ed2SChristoph Hellwig #define RWF_NOWAIT ((__force __kernel_rwf_t)0x00000008) 332ddef7ed2SChristoph Hellwig 333e1fc742eSJürg Billeter /* per-IO O_APPEND */ 334e1fc742eSJürg Billeter #define RWF_APPEND ((__force __kernel_rwf_t)0x00000010) 335e1fc742eSJürg Billeter 33673fa7547SRich Felker /* per-IO negation of O_APPEND */ 33773fa7547SRich Felker #define RWF_NOAPPEND ((__force __kernel_rwf_t)0x00000020) 33873fa7547SRich Felker 339c34fc6f2SPrasad Singamsetty /* Atomic Write */ 340c34fc6f2SPrasad Singamsetty #define RWF_ATOMIC ((__force __kernel_rwf_t)0x00000040) 341c34fc6f2SPrasad Singamsetty 342af6505e5SJens Axboe /* buffered IO that drops the cache after reading or writing data */ 343af6505e5SJens Axboe #define RWF_DONTCACHE ((__force __kernel_rwf_t)0x00000080) 344af6505e5SJens Axboe 345ddef7ed2SChristoph Hellwig /* mask of flags supported by the kernel */ 346e1fc742eSJürg Billeter #define RWF_SUPPORTED (RWF_HIPRI | RWF_DSYNC | RWF_SYNC | RWF_NOWAIT |\ 347af6505e5SJens Axboe RWF_APPEND | RWF_NOAPPEND | RWF_ATOMIC |\ 348af6505e5SJens Axboe RWF_DONTCACHE) 349fdd2f5b7SGoldwyn Rodrigues 350ed5d583aSAndrii Nakryiko #define PROCFS_IOCTL_MAGIC 'f' 351ed5d583aSAndrii Nakryiko 35252526ca7SMuhammad Usama Anjum /* Pagemap ioctl */ 353ed5d583aSAndrii Nakryiko #define PAGEMAP_SCAN _IOWR(PROCFS_IOCTL_MAGIC, 16, struct pm_scan_arg) 35452526ca7SMuhammad Usama Anjum 35552526ca7SMuhammad Usama Anjum /* Bitmasks provided in pm_scan_args masks and reported in page_region.categories. */ 35652526ca7SMuhammad Usama Anjum #define PAGE_IS_WPALLOWED (1 << 0) 35752526ca7SMuhammad Usama Anjum #define PAGE_IS_WRITTEN (1 << 1) 35852526ca7SMuhammad Usama Anjum #define PAGE_IS_FILE (1 << 2) 35952526ca7SMuhammad Usama Anjum #define PAGE_IS_PRESENT (1 << 3) 36052526ca7SMuhammad Usama Anjum #define PAGE_IS_SWAPPED (1 << 4) 36152526ca7SMuhammad Usama Anjum #define PAGE_IS_PFNZERO (1 << 5) 36252526ca7SMuhammad Usama Anjum #define PAGE_IS_HUGE (1 << 6) 363e6a9a2cbSAndrei Vagin #define PAGE_IS_SOFT_DIRTY (1 << 7) 36452526ca7SMuhammad Usama Anjum 36552526ca7SMuhammad Usama Anjum /* 36652526ca7SMuhammad Usama Anjum * struct page_region - Page region with flags 36752526ca7SMuhammad Usama Anjum * @start: Start of the region 36852526ca7SMuhammad Usama Anjum * @end: End of the region (exclusive) 36952526ca7SMuhammad Usama Anjum * @categories: PAGE_IS_* category bitmask for the region 37052526ca7SMuhammad Usama Anjum */ 37152526ca7SMuhammad Usama Anjum struct page_region { 37252526ca7SMuhammad Usama Anjum __u64 start; 37352526ca7SMuhammad Usama Anjum __u64 end; 37452526ca7SMuhammad Usama Anjum __u64 categories; 37552526ca7SMuhammad Usama Anjum }; 37652526ca7SMuhammad Usama Anjum 37752526ca7SMuhammad Usama Anjum /* Flags for PAGEMAP_SCAN ioctl */ 37852526ca7SMuhammad Usama Anjum #define PM_SCAN_WP_MATCHING (1 << 0) /* Write protect the pages matched. */ 37952526ca7SMuhammad Usama Anjum #define PM_SCAN_CHECK_WPASYNC (1 << 1) /* Abort the scan when a non-WP-enabled page is found. */ 38052526ca7SMuhammad Usama Anjum 38152526ca7SMuhammad Usama Anjum /* 38252526ca7SMuhammad Usama Anjum * struct pm_scan_arg - Pagemap ioctl argument 38352526ca7SMuhammad Usama Anjum * @size: Size of the structure 38452526ca7SMuhammad Usama Anjum * @flags: Flags for the IOCTL 38552526ca7SMuhammad Usama Anjum * @start: Starting address of the region 38652526ca7SMuhammad Usama Anjum * @end: Ending address of the region 38752526ca7SMuhammad Usama Anjum * @walk_end Address where the scan stopped (written by kernel). 38852526ca7SMuhammad Usama Anjum * walk_end == end (address tags cleared) informs that the scan completed on entire range. 38952526ca7SMuhammad Usama Anjum * @vec: Address of page_region struct array for output 39052526ca7SMuhammad Usama Anjum * @vec_len: Length of the page_region struct array 39152526ca7SMuhammad Usama Anjum * @max_pages: Optional limit for number of returned pages (0 = disabled) 39252526ca7SMuhammad Usama Anjum * @category_inverted: PAGE_IS_* categories which values match if 0 instead of 1 39352526ca7SMuhammad Usama Anjum * @category_mask: Skip pages for which any category doesn't match 39452526ca7SMuhammad Usama Anjum * @category_anyof_mask: Skip pages for which no category matches 39552526ca7SMuhammad Usama Anjum * @return_mask: PAGE_IS_* categories that are to be reported in `page_region`s returned 39652526ca7SMuhammad Usama Anjum */ 39752526ca7SMuhammad Usama Anjum struct pm_scan_arg { 39852526ca7SMuhammad Usama Anjum __u64 size; 39952526ca7SMuhammad Usama Anjum __u64 flags; 40052526ca7SMuhammad Usama Anjum __u64 start; 40152526ca7SMuhammad Usama Anjum __u64 end; 40252526ca7SMuhammad Usama Anjum __u64 walk_end; 40352526ca7SMuhammad Usama Anjum __u64 vec; 40452526ca7SMuhammad Usama Anjum __u64 vec_len; 40552526ca7SMuhammad Usama Anjum __u64 max_pages; 40652526ca7SMuhammad Usama Anjum __u64 category_inverted; 40752526ca7SMuhammad Usama Anjum __u64 category_mask; 40852526ca7SMuhammad Usama Anjum __u64 category_anyof_mask; 40952526ca7SMuhammad Usama Anjum __u64 return_mask; 41052526ca7SMuhammad Usama Anjum }; 41152526ca7SMuhammad Usama Anjum 412ed5d583aSAndrii Nakryiko /* /proc/<pid>/maps ioctl */ 413ed5d583aSAndrii Nakryiko #define PROCMAP_QUERY _IOWR(PROCFS_IOCTL_MAGIC, 17, struct procmap_query) 414ed5d583aSAndrii Nakryiko 415ed5d583aSAndrii Nakryiko enum procmap_query_flags { 416ed5d583aSAndrii Nakryiko /* 417ed5d583aSAndrii Nakryiko * VMA permission flags. 418ed5d583aSAndrii Nakryiko * 419ed5d583aSAndrii Nakryiko * Can be used as part of procmap_query.query_flags field to look up 420ed5d583aSAndrii Nakryiko * only VMAs satisfying specified subset of permissions. E.g., specifying 421ed5d583aSAndrii Nakryiko * PROCMAP_QUERY_VMA_READABLE only will return both readable and read/write VMAs, 422ed5d583aSAndrii Nakryiko * while having PROCMAP_QUERY_VMA_READABLE | PROCMAP_QUERY_VMA_WRITABLE will only 423ed5d583aSAndrii Nakryiko * return read/write VMAs, though both executable/non-executable and 424ed5d583aSAndrii Nakryiko * private/shared will be ignored. 425ed5d583aSAndrii Nakryiko * 426ed5d583aSAndrii Nakryiko * PROCMAP_QUERY_VMA_* flags are also returned in procmap_query.vma_flags 427ed5d583aSAndrii Nakryiko * field to specify actual VMA permissions. 428ed5d583aSAndrii Nakryiko */ 429ed5d583aSAndrii Nakryiko PROCMAP_QUERY_VMA_READABLE = 0x01, 430ed5d583aSAndrii Nakryiko PROCMAP_QUERY_VMA_WRITABLE = 0x02, 431ed5d583aSAndrii Nakryiko PROCMAP_QUERY_VMA_EXECUTABLE = 0x04, 432ed5d583aSAndrii Nakryiko PROCMAP_QUERY_VMA_SHARED = 0x08, 433ed5d583aSAndrii Nakryiko /* 434ed5d583aSAndrii Nakryiko * Query modifier flags. 435ed5d583aSAndrii Nakryiko * 436ed5d583aSAndrii Nakryiko * By default VMA that covers provided address is returned, or -ENOENT 437ed5d583aSAndrii Nakryiko * is returned. With PROCMAP_QUERY_COVERING_OR_NEXT_VMA flag set, closest 438ed5d583aSAndrii Nakryiko * VMA with vma_start > addr will be returned if no covering VMA is 439ed5d583aSAndrii Nakryiko * found. 440ed5d583aSAndrii Nakryiko * 441ed5d583aSAndrii Nakryiko * PROCMAP_QUERY_FILE_BACKED_VMA instructs query to consider only VMAs that 442ed5d583aSAndrii Nakryiko * have file backing. Can be combined with PROCMAP_QUERY_COVERING_OR_NEXT_VMA 443ed5d583aSAndrii Nakryiko * to iterate all VMAs with file backing. 444ed5d583aSAndrii Nakryiko */ 445ed5d583aSAndrii Nakryiko PROCMAP_QUERY_COVERING_OR_NEXT_VMA = 0x10, 446ed5d583aSAndrii Nakryiko PROCMAP_QUERY_FILE_BACKED_VMA = 0x20, 447ed5d583aSAndrii Nakryiko }; 448ed5d583aSAndrii Nakryiko 449ed5d583aSAndrii Nakryiko /* 450ed5d583aSAndrii Nakryiko * Input/output argument structured passed into ioctl() call. It can be used 451ed5d583aSAndrii Nakryiko * to query a set of VMAs (Virtual Memory Areas) of a process. 452ed5d583aSAndrii Nakryiko * 453ed5d583aSAndrii Nakryiko * Each field can be one of three kinds, marked in a short comment to the 454ed5d583aSAndrii Nakryiko * right of the field: 455ed5d583aSAndrii Nakryiko * - "in", input argument, user has to provide this value, kernel doesn't modify it; 456ed5d583aSAndrii Nakryiko * - "out", output argument, kernel sets this field with VMA data; 457ed5d583aSAndrii Nakryiko * - "in/out", input and output argument; user provides initial value (used 458ed5d583aSAndrii Nakryiko * to specify maximum allowable buffer size), and kernel sets it to actual 459ed5d583aSAndrii Nakryiko * amount of data written (or zero, if there is no data). 460ed5d583aSAndrii Nakryiko * 461ed5d583aSAndrii Nakryiko * If matching VMA is found (according to criterias specified by 462ed5d583aSAndrii Nakryiko * query_addr/query_flags, all the out fields are filled out, and ioctl() 463ed5d583aSAndrii Nakryiko * returns 0. If there is no matching VMA, -ENOENT will be returned. 464ed5d583aSAndrii Nakryiko * In case of any other error, negative error code other than -ENOENT is 465ed5d583aSAndrii Nakryiko * returned. 466ed5d583aSAndrii Nakryiko * 467ed5d583aSAndrii Nakryiko * Most of the data is similar to the one returned as text in /proc/<pid>/maps 468ed5d583aSAndrii Nakryiko * file, but procmap_query provides more querying flexibility. There are no 469ed5d583aSAndrii Nakryiko * consistency guarantees between subsequent ioctl() calls, but data returned 470ed5d583aSAndrii Nakryiko * for matched VMA is self-consistent. 471ed5d583aSAndrii Nakryiko */ 472ed5d583aSAndrii Nakryiko struct procmap_query { 473ed5d583aSAndrii Nakryiko /* Query struct size, for backwards/forward compatibility */ 474ed5d583aSAndrii Nakryiko __u64 size; 475ed5d583aSAndrii Nakryiko /* 476ed5d583aSAndrii Nakryiko * Query flags, a combination of enum procmap_query_flags values. 477ed5d583aSAndrii Nakryiko * Defines query filtering and behavior, see enum procmap_query_flags. 478ed5d583aSAndrii Nakryiko * 479ed5d583aSAndrii Nakryiko * Input argument, provided by user. Kernel doesn't modify it. 480ed5d583aSAndrii Nakryiko */ 481ed5d583aSAndrii Nakryiko __u64 query_flags; /* in */ 482ed5d583aSAndrii Nakryiko /* 483ed5d583aSAndrii Nakryiko * Query address. By default, VMA that covers this address will 484ed5d583aSAndrii Nakryiko * be looked up. PROCMAP_QUERY_* flags above modify this default 485ed5d583aSAndrii Nakryiko * behavior further. 486ed5d583aSAndrii Nakryiko * 487ed5d583aSAndrii Nakryiko * Input argument, provided by user. Kernel doesn't modify it. 488ed5d583aSAndrii Nakryiko */ 489ed5d583aSAndrii Nakryiko __u64 query_addr; /* in */ 490ed5d583aSAndrii Nakryiko /* VMA starting (inclusive) and ending (exclusive) address, if VMA is found. */ 491ed5d583aSAndrii Nakryiko __u64 vma_start; /* out */ 492ed5d583aSAndrii Nakryiko __u64 vma_end; /* out */ 493ed5d583aSAndrii Nakryiko /* VMA permissions flags. A combination of PROCMAP_QUERY_VMA_* flags. */ 494ed5d583aSAndrii Nakryiko __u64 vma_flags; /* out */ 495ed5d583aSAndrii Nakryiko /* VMA backing page size granularity. */ 496ed5d583aSAndrii Nakryiko __u64 vma_page_size; /* out */ 497ed5d583aSAndrii Nakryiko /* 498ed5d583aSAndrii Nakryiko * VMA file offset. If VMA has file backing, this specifies offset 499ed5d583aSAndrii Nakryiko * within the file that VMA's start address corresponds to. 500ed5d583aSAndrii Nakryiko * Is set to zero if VMA has no backing file. 501ed5d583aSAndrii Nakryiko */ 502ed5d583aSAndrii Nakryiko __u64 vma_offset; /* out */ 503ed5d583aSAndrii Nakryiko /* Backing file's inode number, or zero, if VMA has no backing file. */ 504ed5d583aSAndrii Nakryiko __u64 inode; /* out */ 505ed5d583aSAndrii Nakryiko /* Backing file's device major/minor number, or zero, if VMA has no backing file. */ 506ed5d583aSAndrii Nakryiko __u32 dev_major; /* out */ 507ed5d583aSAndrii Nakryiko __u32 dev_minor; /* out */ 508ed5d583aSAndrii Nakryiko /* 509ed5d583aSAndrii Nakryiko * If set to non-zero value, signals the request to return VMA name 510ed5d583aSAndrii Nakryiko * (i.e., VMA's backing file's absolute path, with " (deleted)" suffix 511ed5d583aSAndrii Nakryiko * appended, if file was unlinked from FS) for matched VMA. VMA name 512ed5d583aSAndrii Nakryiko * can also be some special name (e.g., "[heap]", "[stack]") or could 513ed5d583aSAndrii Nakryiko * be even user-supplied with prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME). 514ed5d583aSAndrii Nakryiko * 515ed5d583aSAndrii Nakryiko * Kernel will set this field to zero, if VMA has no associated name. 516ed5d583aSAndrii Nakryiko * Otherwise kernel will return actual amount of bytes filled in 517ed5d583aSAndrii Nakryiko * user-supplied buffer (see vma_name_addr field below), including the 518ed5d583aSAndrii Nakryiko * terminating zero. 519ed5d583aSAndrii Nakryiko * 520ed5d583aSAndrii Nakryiko * If VMA name is longer that user-supplied maximum buffer size, 521ed5d583aSAndrii Nakryiko * -E2BIG error is returned. 522ed5d583aSAndrii Nakryiko * 523ed5d583aSAndrii Nakryiko * If this field is set to non-zero value, vma_name_addr should point 524ed5d583aSAndrii Nakryiko * to valid user space memory buffer of at least vma_name_size bytes. 525ed5d583aSAndrii Nakryiko * If set to zero, vma_name_addr should be set to zero as well 526ed5d583aSAndrii Nakryiko */ 527ed5d583aSAndrii Nakryiko __u32 vma_name_size; /* in/out */ 528ed5d583aSAndrii Nakryiko /* 529bfc69fd0SAndrii Nakryiko * If set to non-zero value, signals the request to extract and return 530bfc69fd0SAndrii Nakryiko * VMA's backing file's build ID, if the backing file is an ELF file 531bfc69fd0SAndrii Nakryiko * and it contains embedded build ID. 532bfc69fd0SAndrii Nakryiko * 533bfc69fd0SAndrii Nakryiko * Kernel will set this field to zero, if VMA has no backing file, 534bfc69fd0SAndrii Nakryiko * backing file is not an ELF file, or ELF file has no build ID 535bfc69fd0SAndrii Nakryiko * embedded. 536bfc69fd0SAndrii Nakryiko * 537bfc69fd0SAndrii Nakryiko * Build ID is a binary value (not a string). Kernel will set 538bfc69fd0SAndrii Nakryiko * build_id_size field to exact number of bytes used for build ID. 539bfc69fd0SAndrii Nakryiko * If build ID is requested and present, but needs more bytes than 540bfc69fd0SAndrii Nakryiko * user-supplied maximum buffer size (see build_id_addr field below), 541bfc69fd0SAndrii Nakryiko * -E2BIG error will be returned. 542bfc69fd0SAndrii Nakryiko * 543bfc69fd0SAndrii Nakryiko * If this field is set to non-zero value, build_id_addr should point 544bfc69fd0SAndrii Nakryiko * to valid user space memory buffer of at least build_id_size bytes. 545bfc69fd0SAndrii Nakryiko * If set to zero, build_id_addr should be set to zero as well 546bfc69fd0SAndrii Nakryiko */ 547bfc69fd0SAndrii Nakryiko __u32 build_id_size; /* in/out */ 548bfc69fd0SAndrii Nakryiko /* 549ed5d583aSAndrii Nakryiko * User-supplied address of a buffer of at least vma_name_size bytes 550ed5d583aSAndrii Nakryiko * for kernel to fill with matched VMA's name (see vma_name_size field 551ed5d583aSAndrii Nakryiko * description above for details). 552ed5d583aSAndrii Nakryiko * 553ed5d583aSAndrii Nakryiko * Should be set to zero if VMA name should not be returned. 554ed5d583aSAndrii Nakryiko */ 555ed5d583aSAndrii Nakryiko __u64 vma_name_addr; /* in */ 556bfc69fd0SAndrii Nakryiko /* 557bfc69fd0SAndrii Nakryiko * User-supplied address of a buffer of at least build_id_size bytes 558bfc69fd0SAndrii Nakryiko * for kernel to fill with matched VMA's ELF build ID, if available 559bfc69fd0SAndrii Nakryiko * (see build_id_size field description above for details). 560bfc69fd0SAndrii Nakryiko * 561bfc69fd0SAndrii Nakryiko * Should be set to zero if build ID should not be returned. 562bfc69fd0SAndrii Nakryiko */ 563bfc69fd0SAndrii Nakryiko __u64 build_id_addr; /* in */ 564ed5d583aSAndrii Nakryiko }; 565ed5d583aSAndrii Nakryiko 566607ca46eSDavid Howells #endif /* _UAPI_LINUX_FS_H */ 567