~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/uapi/linux/fs.h

Version: ~ [ linux-6.11-rc3 ] ~ [ linux-6.10.4 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.45 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.104 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.164 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.223 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.281 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.319 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.9 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php