/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ #ifndef _UAPI_LINUX_FS_H #define _UAPI_LINUX_FS_H /* * This file has definitions for some important file table structures * and constants and structures used by various generic file system * ioctl's. Please do not make any changes in this file before * sending patches for review to linux-fsdevel@vger.kernel.org and * linux-api@vger.kernel.org. */ #include #include #include #ifndef __KERNEL__ #include #endif /* Use of MS_* flags within the kernel is restricted to core mount(2) code. */ #if !defined(__KERNEL__) #include #endif /* * It's silly to have NR_OPEN bigger than NR_FILE, but you can change * the file limit at runtime and only root can increase the per-process * nr_file rlimit, so it's safe to set up a ridiculously high absolute * upper limit on files-per-process. * * Some programs (notably those using select()) may have to be * recompiled to take full advantage of the new limits.. */ /* Fixed constants first: */ #undef NR_OPEN #define INR_OPEN_CUR 1024 /* Initial setting for nfile rlimits */ #define INR_OPEN_MAX 4096 /* Hard limit for nfile rlimits */ #define BLOCK_SIZE_BITS 10 #define BLOCK_SIZE (1</maps ioctl */ #define PROCMAP_QUERY _IOWR(PROCFS_IOCTL_MAGIC, 17, struct procmap_query) enum procmap_query_flags { /* * VMA permission flags. * * Can be used as part of procmap_query.query_flags field to look up * only VMAs satisfying specified subset of permissions. E.g., specifying * PROCMAP_QUERY_VMA_READABLE only will return both readable and read/write VMAs, * while having PROCMAP_QUERY_VMA_READABLE | PROCMAP_QUERY_VMA_WRITABLE will only * return read/write VMAs, though both executable/non-executable and * private/shared will be ignored. * * PROCMAP_QUERY_VMA_* flags are also returned in procmap_query.vma_flags * field to specify actual VMA permissions. */ PROCMAP_QUERY_VMA_READABLE = 0x01, PROCMAP_QUERY_VMA_WRITABLE = 0x02, PROCMAP_QUERY_VMA_EXECUTABLE = 0x04, PROCMAP_QUERY_VMA_SHARED = 0x08, /* * Query modifier flags. * * By default VMA that covers provided address is returned, or -ENOENT * is returned. With PROCMAP_QUERY_COVERING_OR_NEXT_VMA flag set, closest * VMA with vma_start > addr will be returned if no covering VMA is * found. * * PROCMAP_QUERY_FILE_BACKED_VMA instructs query to consider only VMAs that * have file backing. Can be combined with PROCMAP_QUERY_COVERING_OR_NEXT_VMA * to iterate all VMAs with file backing. */ PROCMAP_QUERY_COVERING_OR_NEXT_VMA = 0x10, PROCMAP_QUERY_FILE_BACKED_VMA = 0x20, }; /* * Input/output argument structured passed into ioctl() call. It can be used * to query a set of VMAs (Virtual Memory Areas) of a process. * * Each field can be one of three kinds, marked in a short comment to the * right of the field: * - "in", input argument, user has to provide this value, kernel doesn't modify it; * - "out", output argument, kernel sets this field with VMA data; * - "in/out", input and output argument; user provides initial value (used * to specify maximum allowable buffer size), and kernel sets it to actual * amount of data written (or zero, if there is no data). * * If matching VMA is found (according to criterias specified by * query_addr/query_flags, all the out fields are filled out, and ioctl() * returns 0. If there is no matching VMA, -ENOENT will be returned. * In case of any other error, negative error code other than -ENOENT is * returned. * * Most of the data is similar to the one returned as text in /proc//maps * file, but procmap_query provides more querying flexibility. There are no * consistency guarantees between subsequent ioctl() calls, but data returned * for matched VMA is self-consistent. */ struct procmap_query { /* Query struct size, for backwards/forward compatibility */ __u64 size; /* * Query flags, a combination of enum procmap_query_flags values. * Defines query filtering and behavior, see enum procmap_query_flags. * * Input argument, provided by user. Kernel doesn't modify it. */ __u64 query_flags; /* in */ /* * Query address. By default, VMA that covers this address will * be looked up. PROCMAP_QUERY_* flags above modify this default * behavior further. * * Input argument, provided by user. Kernel doesn't modify it. */ __u64 query_addr; /* in */ /* VMA starting (inclusive) and ending (exclusive) address, if VMA is found. */ __u64 vma_start; /* out */ __u64 vma_end; /* out */ /* VMA permissions flags. A combination of PROCMAP_QUERY_VMA_* flags. */ __u64 vma_flags; /* out */ /* VMA backing page size granularity. */ __u64 vma_page_size; /* out */ /* * VMA file offset. If VMA has file backing, this specifies offset * within the file that VMA's start address corresponds to. * Is set to zero if VMA has no backing file. */ __u64 vma_offset; /* out */ /* Backing file's inode number, or zero, if VMA has no backing file. */ __u64 inode; /* out */ /* Backing file's device major/minor number, or zero, if VMA has no backing file. */ __u32 dev_major; /* out */ __u32 dev_minor; /* out */ /* * If set to non-zero value, signals the request to return VMA name * (i.e., VMA's backing file's absolute path, with " (deleted)" suffix * appended, if file was unlinked from FS) for matched VMA. VMA name * can also be some special name (e.g., "[heap]", "[stack]") or could * be even user-supplied with prctl(PR_SET_VMA, PR_SET_VMA_ANON_NAME). * * Kernel will set this field to zero, if VMA has no associated name. * Otherwise kernel will return actual amount of bytes filled in * user-supplied buffer (see vma_name_addr field below), including the * terminating zero. * * If VMA name is longer that user-supplied maximum buffer size, * -E2BIG error is returned. * * If this field is set to non-zero value, vma_name_addr should point * to valid user space memory buffer of at least vma_name_size bytes. * If set to zero, vma_name_addr should be set to zero as well */ __u32 vma_name_size; /* in/out */ /* * If set to non-zero value, signals the request to extract and return * VMA's backing file's build ID, if the backing file is an ELF file * and it contains embedded build ID. * * Kernel will set this field to zero, if VMA has no backing file, * backing file is not an ELF file, or ELF file has no build ID * embedded. * * Build ID is a binary value (not a string). Kernel will set * build_id_size field to exact number of bytes used for build ID. * If build ID is requested and present, but needs more bytes than * user-supplied maximum buffer size (see build_id_addr field below), * -E2BIG error will be returned. * * If this field is set to non-zero value, build_id_addr should point * to valid user space memory buffer of at least build_id_size bytes. * If set to zero, build_id_addr should be set to zero as well */ __u32 build_id_size; /* in/out */ /* * User-supplied address of a buffer of at least vma_name_size bytes * for kernel to fill with matched VMA's name (see vma_name_size field * description above for details). * * Should be set to zero if VMA name should not be returned. */ __u64 vma_name_addr; /* in */ /* * User-supplied address of a buffer of at least build_id_size bytes * for kernel to fill with matched VMA's ELF build ID, if available * (see build_id_size field description above for details). * * Should be set to zero if build ID should not be returned. */ __u64 build_id_addr; /* in */ }; #endif /* _UAPI_LINUX_FS_H */