Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
0002 #ifndef _UAPI_LINUX_FS_H
0003 #define _UAPI_LINUX_FS_H
0004 
0005 /*
0006  * This file has definitions for some important file table structures
0007  * and constants and structures used by various generic file system
0008  * ioctl's.  Please do not make any changes in this file before
0009  * sending patches for review to linux-fsdevel@vger.kernel.org and
0010  * linux-api@vger.kernel.org.
0011  */
0012 
0013 #include <linux/limits.h>
0014 #include <linux/ioctl.h>
0015 #include <linux/types.h>
0016 #ifndef __KERNEL__
0017 #include <linux/fscrypt.h>
0018 #endif
0019 
0020 /* Use of MS_* flags within the kernel is restricted to core mount(2) code. */
0021 #if !defined(__KERNEL__)
0022 #include <linux/mount.h>
0023 #endif
0024 
0025 /*
0026  * It's silly to have NR_OPEN bigger than NR_FILE, but you can change
0027  * the file limit at runtime and only root can increase the per-process
0028  * nr_file rlimit, so it's safe to set up a ridiculously high absolute
0029  * upper limit on files-per-process.
0030  *
0031  * Some programs (notably those using select()) may have to be 
0032  * recompiled to take full advantage of the new limits..  
0033  */
0034 
0035 /* Fixed constants first: */
0036 #undef NR_OPEN
0037 #define INR_OPEN_CUR 1024   /* Initial setting for nfile rlimits */
0038 #define INR_OPEN_MAX 4096   /* Hard limit for nfile rlimits */
0039 
0040 #define BLOCK_SIZE_BITS 10
0041 #define BLOCK_SIZE (1<<BLOCK_SIZE_BITS)
0042 
0043 #define SEEK_SET    0   /* seek relative to beginning of file */
0044 #define SEEK_CUR    1   /* seek relative to current file position */
0045 #define SEEK_END    2   /* seek relative to end of file */
0046 #define SEEK_DATA   3   /* seek to the next data */
0047 #define SEEK_HOLE   4   /* seek to the next hole */
0048 #define SEEK_MAX    SEEK_HOLE
0049 
0050 #define RENAME_NOREPLACE    (1 << 0)    /* Don't overwrite target */
0051 #define RENAME_EXCHANGE     (1 << 1)    /* Exchange source and dest */
0052 #define RENAME_WHITEOUT     (1 << 2)    /* Whiteout source */
0053 
0054 struct file_clone_range {
0055     __s64 src_fd;
0056     __u64 src_offset;
0057     __u64 src_length;
0058     __u64 dest_offset;
0059 };
0060 
0061 struct fstrim_range {
0062     __u64 start;
0063     __u64 len;
0064     __u64 minlen;
0065 };
0066 
0067 /* extent-same (dedupe) ioctls; these MUST match the btrfs ioctl definitions */
0068 #define FILE_DEDUPE_RANGE_SAME      0
0069 #define FILE_DEDUPE_RANGE_DIFFERS   1
0070 
0071 /* from struct btrfs_ioctl_file_extent_same_info */
0072 struct file_dedupe_range_info {
0073     __s64 dest_fd;      /* in - destination file */
0074     __u64 dest_offset;  /* in - start of extent in destination */
0075     __u64 bytes_deduped;    /* out - total # of bytes we were able
0076                  * to dedupe from this file. */
0077     /* status of this dedupe operation:
0078      * < 0 for error
0079      * == FILE_DEDUPE_RANGE_SAME if dedupe succeeds
0080      * == FILE_DEDUPE_RANGE_DIFFERS if data differs
0081      */
0082     __s32 status;       /* out - see above description */
0083     __u32 reserved;     /* must be zero */
0084 };
0085 
0086 /* from struct btrfs_ioctl_file_extent_same_args */
0087 struct file_dedupe_range {
0088     __u64 src_offset;   /* in - start of extent in source */
0089     __u64 src_length;   /* in - length of extent */
0090     __u16 dest_count;   /* in - total elements in info array */
0091     __u16 reserved1;    /* must be zero */
0092     __u32 reserved2;    /* must be zero */
0093     struct file_dedupe_range_info info[];
0094 };
0095 
0096 /* And dynamically-tunable limits and defaults: */
0097 struct files_stat_struct {
0098     unsigned long nr_files;     /* read only */
0099     unsigned long nr_free_files;    /* read only */
0100     unsigned long max_files;        /* tunable */
0101 };
0102 
0103 struct inodes_stat_t {
0104     long nr_inodes;
0105     long nr_unused;
0106     long dummy[5];      /* padding for sysctl ABI compatibility */
0107 };
0108 
0109 
0110 #define NR_FILE  8192   /* this can well be larger on a larger system */
0111 
0112 /*
0113  * Structure for FS_IOC_FSGETXATTR[A] and FS_IOC_FSSETXATTR.
0114  */
0115 struct fsxattr {
0116     __u32       fsx_xflags; /* xflags field value (get/set) */
0117     __u32       fsx_extsize;    /* extsize field value (get/set)*/
0118     __u32       fsx_nextents;   /* nextents field value (get)   */
0119     __u32       fsx_projid; /* project identifier (get/set) */
0120     __u32       fsx_cowextsize; /* CoW extsize field value (get/set)*/
0121     unsigned char   fsx_pad[8];
0122 };
0123 
0124 /*
0125  * Flags for the fsx_xflags field
0126  */
0127 #define FS_XFLAG_REALTIME   0x00000001  /* data in realtime volume */
0128 #define FS_XFLAG_PREALLOC   0x00000002  /* preallocated file extents */
0129 #define FS_XFLAG_IMMUTABLE  0x00000008  /* file cannot be modified */
0130 #define FS_XFLAG_APPEND     0x00000010  /* all writes append */
0131 #define FS_XFLAG_SYNC       0x00000020  /* all writes synchronous */
0132 #define FS_XFLAG_NOATIME    0x00000040  /* do not update access time */
0133 #define FS_XFLAG_NODUMP     0x00000080  /* do not include in backups */
0134 #define FS_XFLAG_RTINHERIT  0x00000100  /* create with rt bit set */
0135 #define FS_XFLAG_PROJINHERIT    0x00000200  /* create with parents projid */
0136 #define FS_XFLAG_NOSYMLINKS 0x00000400  /* disallow symlink creation */
0137 #define FS_XFLAG_EXTSIZE    0x00000800  /* extent size allocator hint */
0138 #define FS_XFLAG_EXTSZINHERIT   0x00001000  /* inherit inode extent size */
0139 #define FS_XFLAG_NODEFRAG   0x00002000  /* do not defragment */
0140 #define FS_XFLAG_FILESTREAM 0x00004000  /* use filestream allocator */
0141 #define FS_XFLAG_DAX        0x00008000  /* use DAX for IO */
0142 #define FS_XFLAG_COWEXTSIZE 0x00010000  /* CoW extent size allocator hint */
0143 #define FS_XFLAG_HASATTR    0x80000000  /* no DIFLAG for this   */
0144 
0145 /* the read-only stuff doesn't really belong here, but any other place is
0146    probably as bad and I don't want to create yet another include file. */
0147 
0148 #define BLKROSET   _IO(0x12,93) /* set device read-only (0 = read-write) */
0149 #define BLKROGET   _IO(0x12,94) /* get read-only status (0 = read_write) */
0150 #define BLKRRPART  _IO(0x12,95) /* re-read partition table */
0151 #define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */
0152 #define BLKFLSBUF  _IO(0x12,97) /* flush buffer cache */
0153 #define BLKRASET   _IO(0x12,98) /* set read ahead for block device */
0154 #define BLKRAGET   _IO(0x12,99) /* get current read ahead setting */
0155 #define BLKFRASET  _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
0156 #define BLKFRAGET  _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
0157 #define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
0158 #define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
0159 #define BLKSSZGET  _IO(0x12,104)/* get block device sector size */
0160 #if 0
0161 #define BLKPG      _IO(0x12,105)/* See blkpg.h */
0162 
0163 /* Some people are morons.  Do not use sizeof! */
0164 
0165 #define BLKELVGET  _IOR(0x12,106,size_t)/* elevator get */
0166 #define BLKELVSET  _IOW(0x12,107,size_t)/* elevator set */
0167 /* This was here just to show that the number is taken -
0168    probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
0169 #endif
0170 /* A jump here: 108-111 have been used for various private purposes. */
0171 #define BLKBSZGET  _IOR(0x12,112,size_t)
0172 #define BLKBSZSET  _IOW(0x12,113,size_t)
0173 #define BLKGETSIZE64 _IOR(0x12,114,size_t)  /* return device size in bytes (u64 *arg) */
0174 #define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
0175 #define BLKTRACESTART _IO(0x12,116)
0176 #define BLKTRACESTOP _IO(0x12,117)
0177 #define BLKTRACETEARDOWN _IO(0x12,118)
0178 #define BLKDISCARD _IO(0x12,119)
0179 #define BLKIOMIN _IO(0x12,120)
0180 #define BLKIOOPT _IO(0x12,121)
0181 #define BLKALIGNOFF _IO(0x12,122)
0182 #define BLKPBSZGET _IO(0x12,123)
0183 #define BLKDISCARDZEROES _IO(0x12,124)
0184 #define BLKSECDISCARD _IO(0x12,125)
0185 #define BLKROTATIONAL _IO(0x12,126)
0186 #define BLKZEROOUT _IO(0x12,127)
0187 #define BLKGETDISKSEQ _IOR(0x12,128,__u64)
0188 /*
0189  * A jump here: 130-136 are reserved for zoned block devices
0190  * (see uapi/linux/blkzoned.h)
0191  */
0192 
0193 #define BMAP_IOCTL 1        /* obsolete - kept for compatibility */
0194 #define FIBMAP     _IO(0x00,1)  /* bmap access */
0195 #define FIGETBSZ   _IO(0x00,2)  /* get the block size used for bmap */
0196 #define FIFREEZE    _IOWR('X', 119, int)    /* Freeze */
0197 #define FITHAW      _IOWR('X', 120, int)    /* Thaw */
0198 #define FITRIM      _IOWR('X', 121, struct fstrim_range)    /* Trim */
0199 #define FICLONE     _IOW(0x94, 9, int)
0200 #define FICLONERANGE    _IOW(0x94, 13, struct file_clone_range)
0201 #define FIDEDUPERANGE   _IOWR(0x94, 54, struct file_dedupe_range)
0202 
0203 #define FSLABEL_MAX 256 /* Max chars for the interface; each fs may differ */
0204 
0205 #define FS_IOC_GETFLAGS         _IOR('f', 1, long)
0206 #define FS_IOC_SETFLAGS         _IOW('f', 2, long)
0207 #define FS_IOC_GETVERSION       _IOR('v', 1, long)
0208 #define FS_IOC_SETVERSION       _IOW('v', 2, long)
0209 #define FS_IOC_FIEMAP           _IOWR('f', 11, struct fiemap)
0210 #define FS_IOC32_GETFLAGS       _IOR('f', 1, int)
0211 #define FS_IOC32_SETFLAGS       _IOW('f', 2, int)
0212 #define FS_IOC32_GETVERSION     _IOR('v', 1, int)
0213 #define FS_IOC32_SETVERSION     _IOW('v', 2, int)
0214 #define FS_IOC_FSGETXATTR       _IOR('X', 31, struct fsxattr)
0215 #define FS_IOC_FSSETXATTR       _IOW('X', 32, struct fsxattr)
0216 #define FS_IOC_GETFSLABEL       _IOR(0x94, 49, char[FSLABEL_MAX])
0217 #define FS_IOC_SETFSLABEL       _IOW(0x94, 50, char[FSLABEL_MAX])
0218 
0219 /*
0220  * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)
0221  *
0222  * Note: for historical reasons, these flags were originally used and
0223  * defined for use by ext2/ext3, and then other file systems started
0224  * using these flags so they wouldn't need to write their own version
0225  * of chattr/lsattr (which was shipped as part of e2fsprogs).  You
0226  * should think twice before trying to use these flags in new
0227  * contexts, or trying to assign these flags, since they are used both
0228  * as the UAPI and the on-disk encoding for ext2/3/4.  Also, we are
0229  * almost out of 32-bit flags.  :-)
0230  *
0231  * We have recently hoisted FS_IOC_FSGETXATTR / FS_IOC_FSSETXATTR from
0232  * XFS to the generic FS level interface.  This uses a structure that
0233  * has padding and hence has more room to grow, so it may be more
0234  * appropriate for many new use cases.
0235  *
0236  * Please do not change these flags or interfaces before checking with
0237  * linux-fsdevel@vger.kernel.org and linux-api@vger.kernel.org.
0238  */
0239 #define FS_SECRM_FL         0x00000001 /* Secure deletion */
0240 #define FS_UNRM_FL          0x00000002 /* Undelete */
0241 #define FS_COMPR_FL         0x00000004 /* Compress file */
0242 #define FS_SYNC_FL          0x00000008 /* Synchronous updates */
0243 #define FS_IMMUTABLE_FL         0x00000010 /* Immutable file */
0244 #define FS_APPEND_FL            0x00000020 /* writes to file may only append */
0245 #define FS_NODUMP_FL            0x00000040 /* do not dump file */
0246 #define FS_NOATIME_FL           0x00000080 /* do not update atime */
0247 /* Reserved for compression usage... */
0248 #define FS_DIRTY_FL         0x00000100
0249 #define FS_COMPRBLK_FL          0x00000200 /* One or more compressed clusters */
0250 #define FS_NOCOMP_FL            0x00000400 /* Don't compress */
0251 /* End compression flags --- maybe not all used */
0252 #define FS_ENCRYPT_FL           0x00000800 /* Encrypted file */
0253 #define FS_BTREE_FL         0x00001000 /* btree format dir */
0254 #define FS_INDEX_FL         0x00001000 /* hash-indexed directory */
0255 #define FS_IMAGIC_FL            0x00002000 /* AFS directory */
0256 #define FS_JOURNAL_DATA_FL      0x00004000 /* Reserved for ext3 */
0257 #define FS_NOTAIL_FL            0x00008000 /* file tail should not be merged */
0258 #define FS_DIRSYNC_FL           0x00010000 /* dirsync behaviour (directories only) */
0259 #define FS_TOPDIR_FL            0x00020000 /* Top of directory hierarchies*/
0260 #define FS_HUGE_FILE_FL         0x00040000 /* Reserved for ext4 */
0261 #define FS_EXTENT_FL            0x00080000 /* Extents */
0262 #define FS_VERITY_FL            0x00100000 /* Verity protected inode */
0263 #define FS_EA_INODE_FL          0x00200000 /* Inode used for large EA */
0264 #define FS_EOFBLOCKS_FL         0x00400000 /* Reserved for ext4 */
0265 #define FS_NOCOW_FL         0x00800000 /* Do not cow file */
0266 #define FS_DAX_FL           0x02000000 /* Inode is DAX */
0267 #define FS_INLINE_DATA_FL       0x10000000 /* Reserved for ext4 */
0268 #define FS_PROJINHERIT_FL       0x20000000 /* Create with parents projid */
0269 #define FS_CASEFOLD_FL          0x40000000 /* Folder is case insensitive */
0270 #define FS_RESERVED_FL          0x80000000 /* reserved for ext2 lib */
0271 
0272 #define FS_FL_USER_VISIBLE      0x0003DFFF /* User visible flags */
0273 #define FS_FL_USER_MODIFIABLE       0x000380FF /* User modifiable flags */
0274 
0275 
0276 #define SYNC_FILE_RANGE_WAIT_BEFORE 1
0277 #define SYNC_FILE_RANGE_WRITE       2
0278 #define SYNC_FILE_RANGE_WAIT_AFTER  4
0279 #define SYNC_FILE_RANGE_WRITE_AND_WAIT  (SYNC_FILE_RANGE_WRITE | \
0280                      SYNC_FILE_RANGE_WAIT_BEFORE | \
0281                      SYNC_FILE_RANGE_WAIT_AFTER)
0282 
0283 /*
0284  * Flags for preadv2/pwritev2:
0285  */
0286 
0287 typedef int __bitwise __kernel_rwf_t;
0288 
0289 /* high priority request, poll if possible */
0290 #define RWF_HIPRI   ((__force __kernel_rwf_t)0x00000001)
0291 
0292 /* per-IO O_DSYNC */
0293 #define RWF_DSYNC   ((__force __kernel_rwf_t)0x00000002)
0294 
0295 /* per-IO O_SYNC */
0296 #define RWF_SYNC    ((__force __kernel_rwf_t)0x00000004)
0297 
0298 /* per-IO, return -EAGAIN if operation would block */
0299 #define RWF_NOWAIT  ((__force __kernel_rwf_t)0x00000008)
0300 
0301 /* per-IO O_APPEND */
0302 #define RWF_APPEND  ((__force __kernel_rwf_t)0x00000010)
0303 
0304 /* mask of flags supported by the kernel */
0305 #define RWF_SUPPORTED   (RWF_HIPRI | RWF_DSYNC | RWF_SYNC | RWF_NOWAIT |\
0306              RWF_APPEND)
0307 
0308 #endif /* _UAPI_LINUX_FS_H */