fs.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  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 [email protected] and
  9. * [email protected].
  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. #define SEEK_SET 0 /* seek relative to beginning of file */
  37. #define SEEK_CUR 1 /* seek relative to current file position */
  38. #define SEEK_END 2 /* seek relative to end of file */
  39. #define SEEK_DATA 3 /* seek to the next data */
  40. #define SEEK_HOLE 4 /* seek to the next hole */
  41. #define SEEK_MAX SEEK_HOLE
  42. #define RENAME_NOREPLACE (1 << 0) /* Don't overwrite target */
  43. #define RENAME_EXCHANGE (1 << 1) /* Exchange source and dest */
  44. #define RENAME_WHITEOUT (1 << 2) /* Whiteout source */
  45. struct file_clone_range {
  46. __s64 src_fd;
  47. __u64 src_offset;
  48. __u64 src_length;
  49. __u64 dest_offset;
  50. };
  51. struct fstrim_range {
  52. __u64 start;
  53. __u64 len;
  54. __u64 minlen;
  55. };
  56. /* extent-same (dedupe) ioctls; these MUST match the btrfs ioctl definitions */
  57. #define FILE_DEDUPE_RANGE_SAME 0
  58. #define FILE_DEDUPE_RANGE_DIFFERS 1
  59. /* from struct btrfs_ioctl_file_extent_same_info */
  60. struct file_dedupe_range_info {
  61. __s64 dest_fd; /* in - destination file */
  62. __u64 dest_offset; /* in - start of extent in destination */
  63. __u64 bytes_deduped; /* out - total # of bytes we were able
  64. * to dedupe from this file. */
  65. /* status of this dedupe operation:
  66. * < 0 for error
  67. * == FILE_DEDUPE_RANGE_SAME if dedupe succeeds
  68. * == FILE_DEDUPE_RANGE_DIFFERS if data differs
  69. */
  70. __s32 status; /* out - see above description */
  71. __u32 reserved; /* must be zero */
  72. };
  73. /* from struct btrfs_ioctl_file_extent_same_args */
  74. struct file_dedupe_range {
  75. __u64 src_offset; /* in - start of extent in source */
  76. __u64 src_length; /* in - length of extent */
  77. __u16 dest_count; /* in - total elements in info array */
  78. __u16 reserved1; /* must be zero */
  79. __u32 reserved2; /* must be zero */
  80. struct file_dedupe_range_info info[];
  81. };
  82. /* And dynamically-tunable limits and defaults: */
  83. struct files_stat_struct {
  84. unsigned long nr_files; /* read only */
  85. unsigned long nr_free_files; /* read only */
  86. unsigned long max_files; /* tunable */
  87. };
  88. struct inodes_stat_t {
  89. long nr_inodes;
  90. long nr_unused;
  91. long dummy[5]; /* padding for sysctl ABI compatibility */
  92. };
  93. #define NR_FILE 8192 /* this can well be larger on a larger system */
  94. /*
  95. * Structure for FS_IOC_FSGETXATTR[A] and FS_IOC_FSSETXATTR.
  96. */
  97. struct fsxattr {
  98. __u32 fsx_xflags; /* xflags field value (get/set) */
  99. __u32 fsx_extsize; /* extsize field value (get/set)*/
  100. __u32 fsx_nextents; /* nextents field value (get) */
  101. __u32 fsx_projid; /* project identifier (get/set) */
  102. __u32 fsx_cowextsize; /* CoW extsize field value (get/set)*/
  103. unsigned char fsx_pad[8];
  104. };
  105. /*
  106. * Flags for the fsx_xflags field
  107. */
  108. #define FS_XFLAG_REALTIME 0x00000001 /* data in realtime volume */
  109. #define FS_XFLAG_PREALLOC 0x00000002 /* preallocated file extents */
  110. #define FS_XFLAG_IMMUTABLE 0x00000008 /* file cannot be modified */
  111. #define FS_XFLAG_APPEND 0x00000010 /* all writes append */
  112. #define FS_XFLAG_SYNC 0x00000020 /* all writes synchronous */
  113. #define FS_XFLAG_NOATIME 0x00000040 /* do not update access time */
  114. #define FS_XFLAG_NODUMP 0x00000080 /* do not include in backups */
  115. #define FS_XFLAG_RTINHERIT 0x00000100 /* create with rt bit set */
  116. #define FS_XFLAG_PROJINHERIT 0x00000200 /* create with parents projid */
  117. #define FS_XFLAG_NOSYMLINKS 0x00000400 /* disallow symlink creation */
  118. #define FS_XFLAG_EXTSIZE 0x00000800 /* extent size allocator hint */
  119. #define FS_XFLAG_EXTSZINHERIT 0x00001000 /* inherit inode extent size */
  120. #define FS_XFLAG_NODEFRAG 0x00002000 /* do not defragment */
  121. #define FS_XFLAG_FILESTREAM 0x00004000 /* use filestream allocator */
  122. #define FS_XFLAG_DAX 0x00008000 /* use DAX for IO */
  123. #define FS_XFLAG_COWEXTSIZE 0x00010000 /* CoW extent size allocator hint */
  124. #define FS_XFLAG_HASATTR 0x80000000 /* no DIFLAG for this */
  125. /* the read-only stuff doesn't really belong here, but any other place is
  126. probably as bad and I don't want to create yet another include file. */
  127. #define BLKROSET _IO(0x12,93) /* set device read-only (0 = read-write) */
  128. #define BLKROGET _IO(0x12,94) /* get read-only status (0 = read_write) */
  129. #define BLKRRPART _IO(0x12,95) /* re-read partition table */
  130. #define BLKGETSIZE _IO(0x12,96) /* return device size /512 (long *arg) */
  131. #define BLKFLSBUF _IO(0x12,97) /* flush buffer cache */
  132. #define BLKRASET _IO(0x12,98) /* set read ahead for block device */
  133. #define BLKRAGET _IO(0x12,99) /* get current read ahead setting */
  134. #define BLKFRASET _IO(0x12,100)/* set filesystem (mm/filemap.c) read-ahead */
  135. #define BLKFRAGET _IO(0x12,101)/* get filesystem (mm/filemap.c) read-ahead */
  136. #define BLKSECTSET _IO(0x12,102)/* set max sectors per request (ll_rw_blk.c) */
  137. #define BLKSECTGET _IO(0x12,103)/* get max sectors per request (ll_rw_blk.c) */
  138. #define BLKSSZGET _IO(0x12,104)/* get block device sector size */
  139. #if 0
  140. #define BLKPG _IO(0x12,105)/* See blkpg.h */
  141. /* Some people are morons. Do not use sizeof! */
  142. #define BLKELVGET _IOR(0x12,106,size_t)/* elevator get */
  143. #define BLKELVSET _IOW(0x12,107,size_t)/* elevator set */
  144. /* This was here just to show that the number is taken -
  145. probably all these _IO(0x12,*) ioctls should be moved to blkpg.h. */
  146. #endif
  147. /* A jump here: 108-111 have been used for various private purposes. */
  148. #define BLKBSZGET _IOR(0x12,112,size_t)
  149. #define BLKBSZSET _IOW(0x12,113,size_t)
  150. #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
  151. #define BLKTRACESETUP _IOWR(0x12,115,struct blk_user_trace_setup)
  152. #define BLKTRACESTART _IO(0x12,116)
  153. #define BLKTRACESTOP _IO(0x12,117)
  154. #define BLKTRACETEARDOWN _IO(0x12,118)
  155. #define BLKDISCARD _IO(0x12,119)
  156. #define BLKIOMIN _IO(0x12,120)
  157. #define BLKIOOPT _IO(0x12,121)
  158. #define BLKALIGNOFF _IO(0x12,122)
  159. #define BLKPBSZGET _IO(0x12,123)
  160. #define BLKDISCARDZEROES _IO(0x12,124)
  161. #define BLKSECDISCARD _IO(0x12,125)
  162. #define BLKROTATIONAL _IO(0x12,126)
  163. #define BLKZEROOUT _IO(0x12,127)
  164. #define BLKGETDISKSEQ _IOR(0x12,128,__u64)
  165. /*
  166. * A jump here: 130-136 are reserved for zoned block devices
  167. * (see uapi/linux/blkzoned.h)
  168. */
  169. #define BMAP_IOCTL 1 /* obsolete - kept for compatibility */
  170. #define FIBMAP _IO(0x00,1) /* bmap access */
  171. #define FIGETBSZ _IO(0x00,2) /* get the block size used for bmap */
  172. #define FIFREEZE _IOWR('X', 119, int) /* Freeze */
  173. #define FITHAW _IOWR('X', 120, int) /* Thaw */
  174. #define FITRIM _IOWR('X', 121, struct fstrim_range) /* Trim */
  175. #define FICLONE _IOW(0x94, 9, int)
  176. #define FICLONERANGE _IOW(0x94, 13, struct file_clone_range)
  177. #define FIDEDUPERANGE _IOWR(0x94, 54, struct file_dedupe_range)
  178. #define FSLABEL_MAX 256 /* Max chars for the interface; each fs may differ */
  179. #define FS_IOC_GETFLAGS _IOR('f', 1, long)
  180. #define FS_IOC_SETFLAGS _IOW('f', 2, long)
  181. #define FS_IOC_GETVERSION _IOR('v', 1, long)
  182. #define FS_IOC_SETVERSION _IOW('v', 2, long)
  183. #define FS_IOC_FIEMAP _IOWR('f', 11, struct fiemap)
  184. #define FS_IOC32_GETFLAGS _IOR('f', 1, int)
  185. #define FS_IOC32_SETFLAGS _IOW('f', 2, int)
  186. #define FS_IOC32_GETVERSION _IOR('v', 1, int)
  187. #define FS_IOC32_SETVERSION _IOW('v', 2, int)
  188. #define FS_IOC_FSGETXATTR _IOR('X', 31, struct fsxattr)
  189. #define FS_IOC_FSSETXATTR _IOW('X', 32, struct fsxattr)
  190. #define FS_IOC_GETFSLABEL _IOR(0x94, 49, char[FSLABEL_MAX])
  191. #define FS_IOC_SETFSLABEL _IOW(0x94, 50, char[FSLABEL_MAX])
  192. /*
  193. * Inode flags (FS_IOC_GETFLAGS / FS_IOC_SETFLAGS)
  194. *
  195. * Note: for historical reasons, these flags were originally used and
  196. * defined for use by ext2/ext3, and then other file systems started
  197. * using these flags so they wouldn't need to write their own version
  198. * of chattr/lsattr (which was shipped as part of e2fsprogs). You
  199. * should think twice before trying to use these flags in new
  200. * contexts, or trying to assign these flags, since they are used both
  201. * as the UAPI and the on-disk encoding for ext2/3/4. Also, we are
  202. * almost out of 32-bit flags. :-)
  203. *
  204. * We have recently hoisted FS_IOC_FSGETXATTR / FS_IOC_FSSETXATTR from
  205. * XFS to the generic FS level interface. This uses a structure that
  206. * has padding and hence has more room to grow, so it may be more
  207. * appropriate for many new use cases.
  208. *
  209. * Please do not change these flags or interfaces before checking with
  210. * [email protected] and [email protected].
  211. */
  212. #define FS_SECRM_FL 0x00000001 /* Secure deletion */
  213. #define FS_UNRM_FL 0x00000002 /* Undelete */
  214. #define FS_COMPR_FL 0x00000004 /* Compress file */
  215. #define FS_SYNC_FL 0x00000008 /* Synchronous updates */
  216. #define FS_IMMUTABLE_FL 0x00000010 /* Immutable file */
  217. #define FS_APPEND_FL 0x00000020 /* writes to file may only append */
  218. #define FS_NODUMP_FL 0x00000040 /* do not dump file */
  219. #define FS_NOATIME_FL 0x00000080 /* do not update atime */
  220. /* Reserved for compression usage... */
  221. #define FS_DIRTY_FL 0x00000100
  222. #define FS_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
  223. #define FS_NOCOMP_FL 0x00000400 /* Don't compress */
  224. /* End compression flags --- maybe not all used */
  225. #define FS_ENCRYPT_FL 0x00000800 /* Encrypted file */
  226. #define FS_BTREE_FL 0x00001000 /* btree format dir */
  227. #define FS_INDEX_FL 0x00001000 /* hash-indexed directory */
  228. #define FS_IMAGIC_FL 0x00002000 /* AFS directory */
  229. #define FS_JOURNAL_DATA_FL 0x00004000 /* Reserved for ext3 */
  230. #define FS_NOTAIL_FL 0x00008000 /* file tail should not be merged */
  231. #define FS_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
  232. #define FS_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
  233. #define FS_HUGE_FILE_FL 0x00040000 /* Reserved for ext4 */
  234. #define FS_EXTENT_FL 0x00080000 /* Extents */
  235. #define FS_VERITY_FL 0x00100000 /* Verity protected inode */
  236. #define FS_EA_INODE_FL 0x00200000 /* Inode used for large EA */
  237. #define FS_EOFBLOCKS_FL 0x00400000 /* Reserved for ext4 */
  238. #define FS_NOCOW_FL 0x00800000 /* Do not cow file */
  239. #define FS_DAX_FL 0x02000000 /* Inode is DAX */
  240. #define FS_INLINE_DATA_FL 0x10000000 /* Reserved for ext4 */
  241. #define FS_PROJINHERIT_FL 0x20000000 /* Create with parents projid */
  242. #define FS_CASEFOLD_FL 0x40000000 /* Folder is case insensitive */
  243. #define FS_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
  244. #define FS_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */
  245. #define FS_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
  246. #define SYNC_FILE_RANGE_WAIT_BEFORE 1
  247. #define SYNC_FILE_RANGE_WRITE 2
  248. #define SYNC_FILE_RANGE_WAIT_AFTER 4
  249. #define SYNC_FILE_RANGE_WRITE_AND_WAIT (SYNC_FILE_RANGE_WRITE | \
  250. SYNC_FILE_RANGE_WAIT_BEFORE | \
  251. SYNC_FILE_RANGE_WAIT_AFTER)
  252. /*
  253. * Flags for preadv2/pwritev2:
  254. */
  255. typedef int __bitwise __kernel_rwf_t;
  256. /* high priority request, poll if possible */
  257. #define RWF_HIPRI ((__force __kernel_rwf_t)0x00000001)
  258. /* per-IO O_DSYNC */
  259. #define RWF_DSYNC ((__force __kernel_rwf_t)0x00000002)
  260. /* per-IO O_SYNC */
  261. #define RWF_SYNC ((__force __kernel_rwf_t)0x00000004)
  262. /* per-IO, return -EAGAIN if operation would block */
  263. #define RWF_NOWAIT ((__force __kernel_rwf_t)0x00000008)
  264. /* per-IO O_APPEND */
  265. #define RWF_APPEND ((__force __kernel_rwf_t)0x00000010)
  266. /* mask of flags supported by the kernel */
  267. #define RWF_SUPPORTED (RWF_HIPRI | RWF_DSYNC | RWF_SYNC | RWF_NOWAIT |\
  268. RWF_APPEND)
  269. #endif /* _UAPI_LINUX_FS_H */