stat.h 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
  2. #ifndef _UAPI_LINUX_STAT_H
  3. #define _UAPI_LINUX_STAT_H
  4. #include <linux/types.h>
  5. #if defined(__KERNEL__) || !defined(__GLIBC__) || (__GLIBC__ < 2)
  6. #define S_IFMT 00170000
  7. #define S_IFSOCK 0140000
  8. #define S_IFLNK 0120000
  9. #define S_IFREG 0100000
  10. #define S_IFBLK 0060000
  11. #define S_IFDIR 0040000
  12. #define S_IFCHR 0020000
  13. #define S_IFIFO 0010000
  14. #define S_ISUID 0004000
  15. #define S_ISGID 0002000
  16. #define S_ISVTX 0001000
  17. #define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
  18. #define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
  19. #define S_ISDIR(m) (((m) & S_IFMT) == S_IFDIR)
  20. #define S_ISCHR(m) (((m) & S_IFMT) == S_IFCHR)
  21. #define S_ISBLK(m) (((m) & S_IFMT) == S_IFBLK)
  22. #define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
  23. #define S_ISSOCK(m) (((m) & S_IFMT) == S_IFSOCK)
  24. #define S_IRWXU 00700
  25. #define S_IRUSR 00400
  26. #define S_IWUSR 00200
  27. #define S_IXUSR 00100
  28. #define S_IRWXG 00070
  29. #define S_IRGRP 00040
  30. #define S_IWGRP 00020
  31. #define S_IXGRP 00010
  32. #define S_IRWXO 00007
  33. #define S_IROTH 00004
  34. #define S_IWOTH 00002
  35. #define S_IXOTH 00001
  36. #endif
  37. /*
  38. * Timestamp structure for the timestamps in struct statx.
  39. *
  40. * tv_sec holds the number of seconds before (negative) or after (positive)
  41. * 00:00:00 1st January 1970 UTC.
  42. *
  43. * tv_nsec holds a number of nanoseconds (0..999,999,999) after the tv_sec time.
  44. *
  45. * __reserved is held in case we need a yet finer resolution.
  46. */
  47. struct statx_timestamp {
  48. __s64 tv_sec;
  49. __u32 tv_nsec;
  50. __s32 __reserved;
  51. };
  52. /*
  53. * Structures for the extended file attribute retrieval system call
  54. * (statx()).
  55. *
  56. * The caller passes a mask of what they're specifically interested in as a
  57. * parameter to statx(). What statx() actually got will be indicated in
  58. * st_mask upon return.
  59. *
  60. * For each bit in the mask argument:
  61. *
  62. * - if the datum is not supported:
  63. *
  64. * - the bit will be cleared, and
  65. *
  66. * - the datum will be set to an appropriate fabricated value if one is
  67. * available (eg. CIFS can take a default uid and gid), otherwise
  68. *
  69. * - the field will be cleared;
  70. *
  71. * - otherwise, if explicitly requested:
  72. *
  73. * - the datum will be synchronised to the server if AT_STATX_FORCE_SYNC is
  74. * set or if the datum is considered out of date, and
  75. *
  76. * - the field will be filled in and the bit will be set;
  77. *
  78. * - otherwise, if not requested, but available in approximate form without any
  79. * effort, it will be filled in anyway, and the bit will be set upon return
  80. * (it might not be up to date, however, and no attempt will be made to
  81. * synchronise the internal state first);
  82. *
  83. * - otherwise the field and the bit will be cleared before returning.
  84. *
  85. * Items in STATX_BASIC_STATS may be marked unavailable on return, but they
  86. * will have values installed for compatibility purposes so that stat() and
  87. * co. can be emulated in userspace.
  88. */
  89. struct statx {
  90. /* 0x00 */
  91. __u32 stx_mask; /* What results were written [uncond] */
  92. __u32 stx_blksize; /* Preferred general I/O size [uncond] */
  93. __u64 stx_attributes; /* Flags conveying information about the file [uncond] */
  94. /* 0x10 */
  95. __u32 stx_nlink; /* Number of hard links */
  96. __u32 stx_uid; /* User ID of owner */
  97. __u32 stx_gid; /* Group ID of owner */
  98. __u16 stx_mode; /* File mode */
  99. __u16 __spare0[1];
  100. /* 0x20 */
  101. __u64 stx_ino; /* Inode number */
  102. __u64 stx_size; /* File size */
  103. __u64 stx_blocks; /* Number of 512-byte blocks allocated */
  104. __u64 stx_attributes_mask; /* Mask to show what's supported in stx_attributes */
  105. /* 0x40 */
  106. struct statx_timestamp stx_atime; /* Last access time */
  107. struct statx_timestamp stx_btime; /* File creation time */
  108. struct statx_timestamp stx_ctime; /* Last attribute change time */
  109. struct statx_timestamp stx_mtime; /* Last data modification time */
  110. /* 0x80 */
  111. __u32 stx_rdev_major; /* Device ID of special file [if bdev/cdev] */
  112. __u32 stx_rdev_minor;
  113. __u32 stx_dev_major; /* ID of device containing file [uncond] */
  114. __u32 stx_dev_minor;
  115. /* 0x90 */
  116. __u64 stx_mnt_id;
  117. __u32 stx_dio_mem_align; /* Memory buffer alignment for direct I/O */
  118. __u32 stx_dio_offset_align; /* File offset alignment for direct I/O */
  119. /* 0xa0 */
  120. __u64 __spare3[12]; /* Spare space for future expansion */
  121. /* 0x100 */
  122. };
  123. /*
  124. * Flags to be stx_mask
  125. *
  126. * Query request/result mask for statx() and struct statx::stx_mask.
  127. *
  128. * These bits should be set in the mask argument of statx() to request
  129. * particular items when calling statx().
  130. */
  131. #define STATX_TYPE 0x00000001U /* Want/got stx_mode & S_IFMT */
  132. #define STATX_MODE 0x00000002U /* Want/got stx_mode & ~S_IFMT */
  133. #define STATX_NLINK 0x00000004U /* Want/got stx_nlink */
  134. #define STATX_UID 0x00000008U /* Want/got stx_uid */
  135. #define STATX_GID 0x00000010U /* Want/got stx_gid */
  136. #define STATX_ATIME 0x00000020U /* Want/got stx_atime */
  137. #define STATX_MTIME 0x00000040U /* Want/got stx_mtime */
  138. #define STATX_CTIME 0x00000080U /* Want/got stx_ctime */
  139. #define STATX_INO 0x00000100U /* Want/got stx_ino */
  140. #define STATX_SIZE 0x00000200U /* Want/got stx_size */
  141. #define STATX_BLOCKS 0x00000400U /* Want/got stx_blocks */
  142. #define STATX_BASIC_STATS 0x000007ffU /* The stuff in the normal stat struct */
  143. #define STATX_BTIME 0x00000800U /* Want/got stx_btime */
  144. #define STATX_MNT_ID 0x00001000U /* Got stx_mnt_id */
  145. #define STATX_DIOALIGN 0x00002000U /* Want/got direct I/O alignment info */
  146. #define STATX__RESERVED 0x80000000U /* Reserved for future struct statx expansion */
  147. #ifndef __KERNEL__
  148. /*
  149. * This is deprecated, and shall remain the same value in the future. To avoid
  150. * confusion please use the equivalent (STATX_BASIC_STATS | STATX_BTIME)
  151. * instead.
  152. */
  153. #define STATX_ALL 0x00000fffU
  154. #endif
  155. /*
  156. * Attributes to be found in stx_attributes and masked in stx_attributes_mask.
  157. *
  158. * These give information about the features or the state of a file that might
  159. * be of use to ordinary userspace programs such as GUIs or ls rather than
  160. * specialised tools.
  161. *
  162. * Note that the flags marked [I] correspond to the FS_IOC_SETFLAGS flags
  163. * semantically. Where possible, the numerical value is picked to correspond
  164. * also. Note that the DAX attribute indicates that the file is in the CPU
  165. * direct access state. It does not correspond to the per-inode flag that
  166. * some filesystems support.
  167. *
  168. */
  169. #define STATX_ATTR_COMPRESSED 0x00000004 /* [I] File is compressed by the fs */
  170. #define STATX_ATTR_IMMUTABLE 0x00000010 /* [I] File is marked immutable */
  171. #define STATX_ATTR_APPEND 0x00000020 /* [I] File is append-only */
  172. #define STATX_ATTR_NODUMP 0x00000040 /* [I] File is not to be dumped */
  173. #define STATX_ATTR_ENCRYPTED 0x00000800 /* [I] File requires key to decrypt in fs */
  174. #define STATX_ATTR_AUTOMOUNT 0x00001000 /* Dir: Automount trigger */
  175. #define STATX_ATTR_MOUNT_ROOT 0x00002000 /* Root of a mount */
  176. #define STATX_ATTR_VERITY 0x00100000 /* [I] Verity protected file */
  177. #define STATX_ATTR_DAX 0x00200000 /* File is currently in DAX state */
  178. #endif /* _UAPI_LINUX_STAT_H */