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