fs.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569
  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. * 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. #include <linux/limits.h>
  12. #include <linux/ioctl.h>
  13. #include <linux/types.h>
  14. #ifndef __KERNEL__
  15. #include <linux/fscrypt.h>
  16. #endif
  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. * It's silly to have NR_OPEN bigger than NR_FILE, but you can change
  23. * the file limit at runtime and only root can increase the per-process
  24. * nr_file rlimit, so it's safe to set up a ridiculously high absolute
  25. * upper limit on files-per-process.
  26. *
  27. * Some programs (notably those using select()) may have to be
  28. * recompiled to take full advantage of the new limits..
  29. */
  30. /* Fixed constants first: */
  31. #undef NR_OPEN
  32. #define INR_OPEN_CUR 1024 /* Initial setting for nfile rlimits */
  33. #define INR_OPEN_MAX 4096 /* Hard limit for nfile rlimits */
  34. #define BLOCK_SIZE_BITS 10
  35. #define BLOCK_SIZE (1<<BLOCK_SIZE_BITS)
  36. /* flags for integrity meta */
  37. #define IO_INTEGRITY_CHK_GUARD (1U << 0) /* enforce guard check */
  38. #define IO_INTEGRITY_CHK_REFTAG (1U << 1) /* enforce ref check */
  39. #define IO_INTEGRITY_CHK_APPTAG (1U << 2) /* enforce app check */
  40. #define IO_INTEGRITY_VALID_FLAGS (IO_INTEGRITY_CHK_GUARD | \
  41. IO_INTEGRITY_CHK_REFTAG | \
  42. IO_INTEGRITY_CHK_APPTAG)
  43. #define SEEK_SET 0 /* seek relative to beginning of file */
  44. #define SEEK_CUR 1 /* seek relative to current file position */
  45. #define SEEK_END 2 /* seek relative to end of file */
  46. #define SEEK_DATA 3 /* seek to the next data */
  47. #define SEEK_HOLE 4 /* seek to the next hole */
  48. #define SEEK_MAX SEEK_HOLE
  49. #define RENAME_NOREPLACE (1 << 0) /* Don't overwrite target */
  50. #define RENAME_EXCHANGE (1 << 1) /* Exchange source and dest */
  51. #define RENAME_WHITEOUT (1 << 2) /* Whiteout source */
  52. struct file_clone_range {
  53. __s64 src_fd;
  54. __u64 src_offset;
  55. __u64 src_length;
  56. __u64 dest_offset;
  57. };
  58. struct fstrim_range {
  59. __u64 start;
  60. __u64 len;
  61. __u64 minlen;
  62. };
  63. /*
  64. * We include a length field because some filesystems (vfat) have an identifier
  65. * that we do want to expose as a UUID, but doesn't have the standard length.
  66. *
  67. * We use a fixed size buffer beacuse this interface will, by fiat, never
  68. * support "UUIDs" longer than 16 bytes; we don't want to force all downstream
  69. * users to have to deal with that.
  70. */
  71. struct fsuuid2 {
  72. __u8 len;
  73. __u8 uuid[16];
  74. };
  75. struct fs_sysfs_path {
  76. __u8 len;
  77. __u8 name[128];
  78. };
  79. /* extent-same (dedupe) ioctls; these MUST match the btrfs ioctl definitions */
  80. #define FILE_DEDUPE_RANGE_SAME 0
  81. #define FILE_DEDUPE_RANGE_DIFFERS 1
  82. /* from struct btrfs_ioctl_file_extent_same_info */
  83. struct file_dedupe_range_info {
  84. __s64 dest_fd; /* in - destination file */
  85. __u64 dest_offset; /* in - start of extent in destination */
  86. __u64 bytes_deduped; /* out - total # of bytes we were able
  87. * to dedupe from this file. */
  88. /* status of this dedupe operation:
  89. * < 0 for error
  90. * == FILE_DEDUPE_RANGE_SAME if dedupe succeeds
  91. * == FILE_DEDUPE_RANGE_DIFFERS if data differs
  92. */
  93. __s32 status; /* out - see above description */
  94. __u32 reserved; /* must be zero */
  95. };
  96. /* from struct btrfs_ioctl_file_extent_same_args */
  97. struct file_dedupe_range {
  98. __u64 src_offset; /* in - start of extent in source */
  99. __u64 src_length; /* in - length of extent */
  100. __u16 dest_count; /* in - total elements in info array */
  101. __u16 reserved1; /* must be zero */
  102. __u32 reserved2; /* must be zero */
  103. struct file_dedupe_range_info info[];
  104. };
  105. /* And dynamically-tunable limits and defaults: */
  106. struct files_stat_struct {
  107. unsigned long nr_files; /* read only */
  108. unsigned long nr_free_files; /* read only */
  109. unsigned long max_files; /* tunable */
  110. };
  111. struct inodes_stat_t {
  112. long nr_inodes;
  113. long nr_unused;
  114. long dummy[5]; /* padding for sysctl ABI compatibility */
  115. };
  116. #define NR_FILE 8192 /* this can well be larger on a larger system */
  117. /*
  118. * Structure for FS_IOC_FSGETXATTR[A] and FS_IOC_FSSETXATTR.
  119. */
  120. struct fsxattr {
  121. __u32 fsx_xflags; /* xflags field value (get/set) */
  122. __u32 fsx_extsize; /* extsize field value (get/set)*/
  123. __u32 fsx_nextents; /* nextents field value (get) */
  124. __u32 fsx_projid; /* project identifier (get/set) */
  125. __u32 fsx_cowextsize; /* CoW extsize field value (get/set)*/
  126. unsigned char fsx_pad[8];
  127. };
  128. /*
  129. * Flags for the fsx_xflags field
  130. */
  131. #define FS_XFLAG_REALTIME 0x00000001 /* data in realtime volume */
  132. #define FS_XFLAG_PREALLOC 0x00000002 /* preallocated file extents */
  133. #define FS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */
  134. #define FS_XFLAG_APPEND 0x00000010 /* all writes append */
  135. #define FS_XFLAG_SYNC 0x00000020 /* all writes synchronous */
  136. #define FS_XFLAG_NOATIME 0x00000040 /* do not update access time */
  137. #define FS_XFLAG_NODUMP 0x00000080 /* do not include in backups */
  138. #define FS_XFLAG_RTINHERIT 0x00000100 /* create with rt bit set */
  139. #define FS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */
  140. #define FS_XFLAG_NOSYMLINKS 0x00000400 /* disallow symlink creation */
  141. #define FS_XFLAG_EXTSIZE 0x00000800 /* extent size allocator hint */
  142. #define FS_XFLAG_EXTSZINHERIT 0x00001000 /* inherit inode extent size */
  143. #define FS_XFLAG_NODEFRAG 0x00002000 /* do not defragment */
  144. #define FS_XFLAG_FILESTREAM 0x00004000 /* use filestream allocator */
  145. #define FS_XFLAG_DAX 0x00008000 /* use DAX for IO */
  146. #define FS_XFLAG_COWEXTSIZE 0x00010000 /* CoW extent size allocator hint */
  147. #define FS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */
  148. /* the read-only stuff doesn't really belong here, but any other place is
  149. probably as bad and I don't want to create yet another include file. */
  150. #define BLKROSET _IO(0x12,93) /* set device read-only (0 = read-write) */
  151. #define BLKROGET _IO(0x12,94) /* get read-only status (0 = read_write) */
  152. #define BLKRRPART _IO(0x12,95) /* re-read partition table */
  153. #define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */
  154. #define BLKFLSBUF _IO(0x12,97) /* flush buffer cache */
  155. #define BLKRASET _IO(0x12,98) /* set read ahead for block device */
  156. #define BLKRAGET _IO(0x12,99) /* get current read ahead setting */
  157. #define BLKFRASET _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
  158. #define BLKFRAGET _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
  159. #define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
  160. #define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
  161. #define BLKSSZGET _IO(0x12,104)/* get block device sector size */
  162. #if 0
  163. #define BLKPG _IO(0x12,105)/* See blkpg.h */
  164. /* Some people are morons. Do not use sizeof! */
  165. #define BLKELVGET _IOR(0x12,106,size_t)/* elevator get */
  166. #define BLKELVSET _IOW(0x12,107,size_t)/* elevator set */
  167. /* This was here just to show that the number is taken -
  168. probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
  169. #endif
  170. /* A jump here: 108-111 have been used for various private purposes. */
  171. #define BLKBSZGET _IOR(0x12,112,size_t)
  172. #define BLKBSZSET _IOW(0x12,113,size_t)
  173. #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
  174. #define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
  175. #define BLKTRACESTART _IO(0x12,116)
  176. #define BLKTRACESTOP _IO(0x12,117)
  177. #define BLKTRACETEARDOWN _IO(0x12,118)
  178. #define BLKDISCARD _IO(0x12,119)
  179. #define BLKIOMIN _IO(0x12,120)
  180. #define BLKIOOPT _IO(0x12,121)
  181. #define BLKALIGNOFF _IO(0x12,122)
  182. #define BLKPBSZGET _IO(0x12,123)
  183. #define BLKDISCARDZEROES _IO(0x12,124)
  184. #define BLKSECDISCARD _IO(0x12,125)
  185. #define BLKROTATIONAL _IO(0x12,126)
  186. #define BLKZEROOUT _IO(0x12,127)
  187. #define BLKGETDISKSEQ _IOR(0x12,128,__u64)
  188. /*
  189. * A jump here: 130-136 are reserved for zoned block devices
  190. * (see uapi/linux/blkzoned.h)
  191. */
  192. #define BMAP_IOCTL 1 /* obsolete - kept for compatibility */
  193. #define FIBMAP _IO(0x00,1) /* bmap access */
  194. #define FIGETBSZ _IO(0x00,2) /* get the block size used for bmap */
  195. #define FIFREEZE _IOWR('X', 119, int) /* Freeze */
  196. #define FITHAW _IOWR('X', 120, int) /* Thaw */
  197. #define FITRIM _IOWR('X', 121, struct fstrim_range) /* Trim */
  198. #define FICLONE _IOW(0x94, 9, int)
  199. #define FICLONERANGE _IOW(0x94, 13, struct file_clone_range)
  200. #define FIDEDUPERANGE _IOWR(0x94, 54, struct file_dedupe_range)
  201. #define FSLABEL_MAX 256 /* Max chars for the interface; each fs may differ */
  202. #define FS_IOC_GETFLAGS _IOR('f', 1, long)
  203. #define FS_IOC_SETFLAGS _IOW('f', 2, long)
  204. #define FS_IOC_GETVERSION _IOR('v', 1, long)
  205. #define FS_IOC_SETVERSION _IOW('v', 2, long)
  206. #define FS_IOC_FIEMAP _IOWR('f', 11, struct fiemap)
  207. #define FS_IOC32_GETFLAGS _IOR('f', 1, int)
  208. #define FS_IOC32_SETFLAGS _IOW('f', 2, int)
  209. #define FS_IOC32_GETVERSION _IOR('v', 1, int)
  210. #define FS_IOC32_SETVERSION _IOW('v', 2, int)
  211. #define FS_IOC_FSGETXATTR _IOR('X', 31, struct fsxattr)
  212. #define FS_IOC_FSSETXATTR _IOW('X', 32, struct fsxattr)
  213. #define FS_IOC_GETFSLABEL _IOR(0x94, 49, char[FSLABEL_MAX])
  214. #define FS_IOC_SETFSLABEL _IOW(0x94, 50, char[FSLABEL_MAX])
  215. /* Returns the external filesystem UUID, the same one blkid returns */
  216. #define FS_IOC_GETFSUUID _IOR(0x15, 0, struct fsuuid2)
  217. /*
  218. * Returns the path component under /sys/fs/ that refers to this filesystem;
  219. * also /sys/kernel/debug/ for filesystems with debugfs exports
  220. */
  221. #define FS_IOC_GETFSSYSFSPATH _IOR(0x15, 1, struct fs_sysfs_path)
  222. /*
  223. * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)
  224. *
  225. * Note: for historical reasons, these flags were originally used and
  226. * defined for use by ext2/ext3, and then other file systems started
  227. * using these flags so they wouldn't need to write their own version
  228. * of chattr/lsattr (which was shipped as part of e2fsprogs). You
  229. * should think twice before trying to use these flags in new
  230. * contexts, or trying to assign these flags, since they are used both
  231. * as the UAPI and the on-disk encoding for ext2/3/4. Also, we are
  232. * almost out of 32-bit flags. :-)
  233. *
  234. * We have recently hoisted FS_IOC_FSGETXATTR / FS_IOC_FSSETXATTR from
  235. * XFS to the generic FS level interface. This uses a structure that
  236. * has padding and hence has more room to grow, so it may be more
  237. * appropriate for many new use cases.
  238. *
  239. * Please do not change these flags or interfaces before checking with
  240. * linux-fsdevel@vger.kernel.org and linux-api@vger.kernel.org.
  241. */
  242. #define FS_SECRM_FL 0x00000001 /* Secure deletion */
  243. #define FS_UNRM_FL 0x00000002 /* Undelete */
  244. #define FS_COMPR_FL 0x00000004 /* Compress file */
  245. #define FS_SYNC_FL 0x00000008 /* Synchronous updates */
  246. #define FS_IMMUTABLE_FL 0x00000010 /* Immutable file */
  247. #define FS_APPEND_FL 0x00000020 /* writes to file may only append */
  248. #define FS_NODUMP_FL 0x00000040 /* do not dump file */
  249. #define FS_NOATIME_FL 0x00000080 /* do not update atime */
  250. /* Reserved for compression usage... */
  251. #define FS_DIRTY_FL 0x00000100
  252. #define FS_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
  253. #define FS_NOCOMP_FL 0x00000400 /* Don't compress */
  254. /* End compression flags --- maybe not all used */
  255. #define FS_ENCRYPT_FL 0x00000800 /* Encrypted file */
  256. #define FS_BTREE_FL 0x00001000 /* btree format dir */
  257. #define FS_INDEX_FL 0x00001000 /* hash-indexed directory */
  258. #define FS_IMAGIC_FL 0x00002000 /* AFS directory */
  259. #define FS_JOURNAL_DATA_FL 0x00004000 /* Reserved for ext3 */
  260. #define FS_NOTAIL_FL 0x00008000 /* file tail should not be merged */
  261. #define FS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
  262. #define FS_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
  263. #define FS_HUGE_FILE_FL 0x00040000 /* Reserved for ext4 */
  264. #define FS_EXTENT_FL 0x00080000 /* Extents */
  265. #define FS_VERITY_FL 0x00100000 /* Verity protected inode */
  266. #define FS_EA_INODE_FL 0x00200000 /* Inode used for large EA */
  267. #define FS_EOFBLOCKS_FL 0x00400000 /* Reserved for ext4 */
  268. #define FS_NOCOW_FL 0x00800000 /* Do not cow file */
  269. #define FS_DAX_FL 0x02000000 /* Inode is DAX */
  270. #define FS_INLINE_DATA_FL 0x10000000 /* Reserved for ext4 */
  271. #define FS_PROJINHERIT_FL 0x20000000 /* Create with parents projid */
  272. #define FS_CASEFOLD_FL 0x40000000 /* Folder is case insensitive */
  273. #define FS_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
  274. #define FS_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */
  275. #define FS_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
  276. #define SYNC_FILE_RANGE_WAIT_BEFORE 1
  277. #define SYNC_FILE_RANGE_WRITE 2
  278. #define SYNC_FILE_RANGE_WAIT_AFTER 4
  279. #define SYNC_FILE_RANGE_WRITE_AND_WAIT (SYNC_FILE_RANGE_WRITE | \
  280. SYNC_FILE_RANGE_WAIT_BEFORE | \
  281. SYNC_FILE_RANGE_WAIT_AFTER)
  282. /*
  283. * Flags for preadv2/pwritev2:
  284. */
  285. typedef int __bitwise __kernel_rwf_t;
  286. /* high priority request, poll if possible */
  287. #define RWF_HIPRI ((__force __kernel_rwf_t)0x00000001)
  288. /* per-IO O_DSYNC */
  289. #define RWF_DSYNC ((__force __kernel_rwf_t)0x00000002)
  290. /* per-IO O_SYNC */
  291. #define RWF_SYNC ((__force __kernel_rwf_t)0x00000004)
  292. /* per-IO, return -EAGAIN if operation would block */
  293. #define RWF_NOWAIT ((__force __kernel_rwf_t)0x00000008)
  294. /* per-IO O_APPEND */
  295. #define RWF_APPEND ((__force __kernel_rwf_t)0x00000010)
  296. /* per-IO negation of O_APPEND */
  297. #define RWF_NOAPPEND ((__force __kernel_rwf_t)0x00000020)
  298. /* Atomic Write */
  299. #define RWF_ATOMIC ((__force __kernel_rwf_t)0x00000040)
  300. /* buffered IO that drops the cache after reading or writing data */
  301. #define RWF_DONTCACHE ((__force __kernel_rwf_t)0x00000080)
  302. /* mask of flags supported by the kernel */
  303. #define RWF_SUPPORTED (RWF_HIPRI | RWF_DSYNC | RWF_SYNC | RWF_NOWAIT |\
  304. RWF_APPEND | RWF_NOAPPEND | RWF_ATOMIC |\
  305. RWF_DONTCACHE)
  306. #define PROCFS_IOCTL_MAGIC 'f'
  307. /* Pagemap ioctl */
  308. #define PAGEMAP_SCAN _IOWR(PROCFS_IOCTL_MAGIC, 16, struct pm_scan_arg)
  309. /* Bitmasks provided in pm_scan_args masks and reported in page_region.categories. */
  310. #define PAGE_IS_WPALLOWED (1 << 0)
  311. #define PAGE_IS_WRITTEN (1 << 1)
  312. #define PAGE_IS_FILE (1 << 2)
  313. #define PAGE_IS_PRESENT (1 << 3)
  314. #define PAGE_IS_SWAPPED (1 << 4)
  315. #define PAGE_IS_PFNZERO (1 << 5)
  316. #define PAGE_IS_HUGE (1 << 6)
  317. #define PAGE_IS_SOFT_DIRTY (1 << 7)
  318. #define PAGE_IS_GUARD (1 << 8)
  319. /*
  320. * struct page_region - Page region with flags
  321. * @start: Start of the region
  322. * @end: End of the region (exclusive)
  323. * @categories: PAGE_IS_* category bitmask for the region
  324. */
  325. struct page_region {
  326. __u64 start;
  327. __u64 end;
  328. __u64 categories;
  329. };
  330. /* Flags for PAGEMAP_SCAN ioctl */
  331. #define PM_SCAN_WP_MATCHING (1 << 0) /* Write protect the pages matched. */
  332. #define PM_SCAN_CHECK_WPASYNC (1 << 1) /* Abort the scan when a non-WP-enabled page is found. */
  333. /*
  334. * struct pm_scan_arg - Pagemap ioctl argument
  335. * @size: Size of the structure
  336. * @flags: Flags for the IOCTL
  337. * @start: Starting address of the region
  338. * @end: Ending address of the region
  339. * @walk_end Address where the scan stopped (written by kernel).
  340. * walk_end == end (address tags cleared) informs that the scan completed on entire range.
  341. * @vec: Address of page_region struct array for output
  342. * @vec_len: Length of the page_region struct array
  343. * @max_pages: Optional limit for number of returned pages (0 = disabled)
  344. * @category_inverted: PAGE_IS_* categories which values match if 0 instead of 1
  345. * @category_mask: Skip pages for which any category doesn't match
  346. * @category_anyof_mask: Skip pages for which no category matches
  347. * @return_mask: PAGE_IS_* categories that are to be reported in `page_region`s returned
  348. */
  349. struct pm_scan_arg {
  350. __u64 size;
  351. __u64 flags;
  352. __u64 start;
  353. __u64 end;
  354. __u64 walk_end;
  355. __u64 vec;
  356. __u64 vec_len;
  357. __u64 max_pages;
  358. __u64 category_inverted;
  359. __u64 category_mask;
  360. __u64 category_anyof_mask;
  361. __u64 return_mask;
  362. };
  363. /* /proc/<pid>/maps ioctl */
  364. #define PROCMAP_QUERY _IOWR(PROCFS_IOCTL_MAGIC, 17, struct procmap_query)
  365. enum procmap_query_flags {
  366. /*
  367. * VMA permission flags.
  368. *
  369. * Can be used as part of procmap_query.query_flags field to look up
  370. * only VMAs satisfying specified subset of permissions. E.g., specifying
  371. * PROCMAP_QUERY_VMA_READABLE only will return both readable and read/write VMAs,
  372. * while having PROCMAP_QUERY_VMA_READABLE | PROCMAP_QUERY_VMA_WRITABLE will only
  373. * return read/write VMAs, though both executable/non-executable and
  374. * private/shared will be ignored.
  375. *
  376. * PROCMAP_QUERY_VMA_* flags are also returned in procmap_query.vma_flags
  377. * field to specify actual VMA permissions.
  378. */
  379. PROCMAP_QUERY_VMA_READABLE = 0x01,
  380. PROCMAP_QUERY_VMA_WRITABLE = 0x02,
  381. PROCMAP_QUERY_VMA_EXECUTABLE = 0x04,
  382. PROCMAP_QUERY_VMA_SHARED = 0x08,
  383. /*
  384. * Query modifier flags.
  385. *
  386. * By default VMA that covers provided address is returned, or -ENOENT
  387. * is returned. With PROCMAP_QUERY_COVERING_OR_NEXT_VMA flag set, closest
  388. * VMA with vma_start > addr will be returned if no covering VMA is
  389. * found.
  390. *
  391. * PROCMAP_QUERY_FILE_BACKED_VMA instructs query to consider only VMAs that
  392. * have file backing. Can be combined with PROCMAP_QUERY_COVERING_OR_NEXT_VMA
  393. * to iterate all VMAs with file backing.
  394. */
  395. PROCMAP_QUERY_COVERING_OR_NEXT_VMA = 0x10,
  396. PROCMAP_QUERY_FILE_BACKED_VMA = 0x20,
  397. };
  398. /*
  399. * Input/output argument structured passed into ioctl() call. It can be used
  400. * to query a set of VMAs (Virtual Memory Areas) of a process.
  401. *
  402. * Each field can be one of three kinds, marked in a short comment to the
  403. * right of the field:
  404. * - "in", input argument, user has to provide this value, kernel doesn't modify it;
  405. * - "out", output argument, kernel sets this field with VMA data;
  406. * - "in/out", input and output argument; user provides initial value (used
  407. * to specify maximum allowable buffer size), and kernel sets it to actual
  408. * amount of data written (or zero, if there is no data).
  409. *
  410. * If matching VMA is found (according to criterias specified by
  411. * query_addr/query_flags, all the out fields are filled out, and ioctl()
  412. * returns 0. If there is no matching VMA, -ENOENT will be returned.
  413. * In case of any other error, negative error code other than -ENOENT is
  414. * returned.
  415. *
  416. * Most of the data is similar to the one returned as text in /proc/<pid>/maps
  417. * file, but procmap_query provides more querying flexibility. There are no
  418. * consistency guarantees between subsequent ioctl() calls, but data returned
  419. * for matched VMA is self-consistent.
  420. */
  421. struct procmap_query {
  422. /* Query struct size, for backwards/forward compatibility */
  423. __u64 size;
  424. /*
  425. * Query flags, a combination of enum procmap_query_flags values.
  426. * Defines query filtering and behavior, see enum procmap_query_flags.
  427. *
  428. * Input argument, provided by user. Kernel doesn't modify it.
  429. */
  430. __u64 query_flags; /* in */
  431. /*
  432. * Query address. By default, VMA that covers this address will
  433. * be looked up. PROCMAP_QUERY_* flags above modify this default
  434. * behavior further.
  435. *
  436. * Input argument, provided by user. Kernel doesn't modify it.
  437. */
  438. __u64 query_addr; /* in */
  439. /* VMA starting (inclusive) and ending (exclusive) address, if VMA is found. */
  440. __u64 vma_start; /* out */
  441. __u64 vma_end; /* out */
  442. /* VMA permissions flags. A combination of PROCMAP_QUERY_VMA_* flags. */
  443. __u64 vma_flags; /* out */
  444. /* VMA backing page size granularity. */
  445. __u64 vma_page_size; /* out */
  446. /*
  447. * VMA file offset. If VMA has file backing, this specifies offset
  448. * within the file that VMA's start address corresponds to.
  449. * Is set to zero if VMA has no backing file.
  450. */
  451. __u64 vma_offset; /* out */
  452. /* Backing file's inode number, or zero, if VMA has no backing file. */
  453. __u64 inode; /* out */
  454. /* Backing file's device major/minor number, or zero, if VMA has no backing file. */
  455. __u32 dev_major; /* out */
  456. __u32 dev_minor; /* out */
  457. /*
  458. * If set to non-zero value, signals the request to return VMA name
  459. * (i.e., VMA's backing file's absolute path, with " (deleted)" suffix
  460. * appended, if file was unlinked from FS) for matched VMA. VMA name
  461. * can also be some special name (e.g., "[heap]", "[stack]") or could
  462. * be even user-supplied with prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME).
  463. *
  464. * Kernel will set this field to zero, if VMA has no associated name.
  465. * Otherwise kernel will return actual amount of bytes filled in
  466. * user-supplied buffer (see vma_name_addr field below), including the
  467. * terminating zero.
  468. *
  469. * If VMA name is longer that user-supplied maximum buffer size,
  470. * -E2BIG error is returned.
  471. *
  472. * If this field is set to non-zero value, vma_name_addr should point
  473. * to valid user space memory buffer of at least vma_name_size bytes.
  474. * If set to zero, vma_name_addr should be set to zero as well
  475. */
  476. __u32 vma_name_size; /* in/out */
  477. /*
  478. * If set to non-zero value, signals the request to extract and return
  479. * VMA's backing file's build ID, if the backing file is an ELF file
  480. * and it contains embedded build ID.
  481. *
  482. * Kernel will set this field to zero, if VMA has no backing file,
  483. * backing file is not an ELF file, or ELF file has no build ID
  484. * embedded.
  485. *
  486. * Build ID is a binary value (not a string). Kernel will set
  487. * build_id_size field to exact number of bytes used for build ID.
  488. * If build ID is requested and present, but needs more bytes than
  489. * user-supplied maximum buffer size (see build_id_addr field below),
  490. * -E2BIG error will be returned.
  491. *
  492. * If this field is set to non-zero value, build_id_addr should point
  493. * to valid user space memory buffer of at least build_id_size bytes.
  494. * If set to zero, build_id_addr should be set to zero as well
  495. */
  496. __u32 build_id_size; /* in/out */
  497. /*
  498. * User-supplied address of a buffer of at least vma_name_size bytes
  499. * for kernel to fill with matched VMA's name (see vma_name_size field
  500. * description above for details).
  501. *
  502. * Should be set to zero if VMA name should not be returned.
  503. */
  504. __u64 vma_name_addr; /* in */
  505. /*
  506. * User-supplied address of a buffer of at least build_id_size bytes
  507. * for kernel to fill with matched VMA's ELF build ID, if available
  508. * (see build_id_size field description above for details).
  509. *
  510. * Should be set to zero if build ID should not be returned.
  511. */
  512. __u64 build_id_addr; /* in */
  513. };
  514. #endif /* _UAPI_LINUX_FS_H */