xfs_health.h 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * Copyright (C) 2019 Oracle. All Rights Reserved.
  4. * Author: Darrick J. Wong <[email protected]>
  5. */
  6. #ifndef __XFS_HEALTH_H__
  7. #define __XFS_HEALTH_H__
  8. /*
  9. * In-Core Filesystem Health Assessments
  10. * =====================================
  11. *
  12. * We'd like to be able to summarize the current health status of the
  13. * filesystem so that the administrator knows when it's necessary to schedule
  14. * some downtime for repairs. Until then, we would also like to avoid abrupt
  15. * shutdowns due to corrupt metadata.
  16. *
  17. * The online scrub feature evaluates the health of all filesystem metadata.
  18. * When scrub detects corruption in a piece of metadata it will set the
  19. * corresponding sickness flag, and repair will clear it if successful. If
  20. * problems remain at unmount time, we can also request manual intervention by
  21. * logging a notice to run xfs_repair.
  22. *
  23. * Each health tracking group uses a pair of fields for reporting. The
  24. * "checked" field tell us if a given piece of metadata has ever been examined,
  25. * and the "sick" field tells us if that piece was found to need repairs.
  26. * Therefore we can conclude that for a given sick flag value:
  27. *
  28. * - checked && sick => metadata needs repair
  29. * - checked && !sick => metadata is ok
  30. * - !checked => has not been examined since mount
  31. */
  32. struct xfs_mount;
  33. struct xfs_perag;
  34. struct xfs_inode;
  35. struct xfs_fsop_geom;
  36. /* Observable health issues for metadata spanning the entire filesystem. */
  37. #define XFS_SICK_FS_COUNTERS (1 << 0) /* summary counters */
  38. #define XFS_SICK_FS_UQUOTA (1 << 1) /* user quota */
  39. #define XFS_SICK_FS_GQUOTA (1 << 2) /* group quota */
  40. #define XFS_SICK_FS_PQUOTA (1 << 3) /* project quota */
  41. /* Observable health issues for realtime volume metadata. */
  42. #define XFS_SICK_RT_BITMAP (1 << 0) /* realtime bitmap */
  43. #define XFS_SICK_RT_SUMMARY (1 << 1) /* realtime summary */
  44. /* Observable health issues for AG metadata. */
  45. #define XFS_SICK_AG_SB (1 << 0) /* superblock */
  46. #define XFS_SICK_AG_AGF (1 << 1) /* AGF header */
  47. #define XFS_SICK_AG_AGFL (1 << 2) /* AGFL header */
  48. #define XFS_SICK_AG_AGI (1 << 3) /* AGI header */
  49. #define XFS_SICK_AG_BNOBT (1 << 4) /* free space by block */
  50. #define XFS_SICK_AG_CNTBT (1 << 5) /* free space by length */
  51. #define XFS_SICK_AG_INOBT (1 << 6) /* inode index */
  52. #define XFS_SICK_AG_FINOBT (1 << 7) /* free inode index */
  53. #define XFS_SICK_AG_RMAPBT (1 << 8) /* reverse mappings */
  54. #define XFS_SICK_AG_REFCNTBT (1 << 9) /* reference counts */
  55. /* Observable health issues for inode metadata. */
  56. #define XFS_SICK_INO_CORE (1 << 0) /* inode core */
  57. #define XFS_SICK_INO_BMBTD (1 << 1) /* data fork */
  58. #define XFS_SICK_INO_BMBTA (1 << 2) /* attr fork */
  59. #define XFS_SICK_INO_BMBTC (1 << 3) /* cow fork */
  60. #define XFS_SICK_INO_DIR (1 << 4) /* directory */
  61. #define XFS_SICK_INO_XATTR (1 << 5) /* extended attributes */
  62. #define XFS_SICK_INO_SYMLINK (1 << 6) /* symbolic link remote target */
  63. #define XFS_SICK_INO_PARENT (1 << 7) /* parent pointers */
  64. /* Primary evidence of health problems in a given group. */
  65. #define XFS_SICK_FS_PRIMARY (XFS_SICK_FS_COUNTERS | \
  66. XFS_SICK_FS_UQUOTA | \
  67. XFS_SICK_FS_GQUOTA | \
  68. XFS_SICK_FS_PQUOTA)
  69. #define XFS_SICK_RT_PRIMARY (XFS_SICK_RT_BITMAP | \
  70. XFS_SICK_RT_SUMMARY)
  71. #define XFS_SICK_AG_PRIMARY (XFS_SICK_AG_SB | \
  72. XFS_SICK_AG_AGF | \
  73. XFS_SICK_AG_AGFL | \
  74. XFS_SICK_AG_AGI | \
  75. XFS_SICK_AG_BNOBT | \
  76. XFS_SICK_AG_CNTBT | \
  77. XFS_SICK_AG_INOBT | \
  78. XFS_SICK_AG_FINOBT | \
  79. XFS_SICK_AG_RMAPBT | \
  80. XFS_SICK_AG_REFCNTBT)
  81. #define XFS_SICK_INO_PRIMARY (XFS_SICK_INO_CORE | \
  82. XFS_SICK_INO_BMBTD | \
  83. XFS_SICK_INO_BMBTA | \
  84. XFS_SICK_INO_BMBTC | \
  85. XFS_SICK_INO_DIR | \
  86. XFS_SICK_INO_XATTR | \
  87. XFS_SICK_INO_SYMLINK | \
  88. XFS_SICK_INO_PARENT)
  89. /* These functions must be provided by the xfs implementation. */
  90. void xfs_fs_mark_sick(struct xfs_mount *mp, unsigned int mask);
  91. void xfs_fs_mark_healthy(struct xfs_mount *mp, unsigned int mask);
  92. void xfs_fs_measure_sickness(struct xfs_mount *mp, unsigned int *sick,
  93. unsigned int *checked);
  94. void xfs_rt_mark_sick(struct xfs_mount *mp, unsigned int mask);
  95. void xfs_rt_mark_healthy(struct xfs_mount *mp, unsigned int mask);
  96. void xfs_rt_measure_sickness(struct xfs_mount *mp, unsigned int *sick,
  97. unsigned int *checked);
  98. void xfs_ag_mark_sick(struct xfs_perag *pag, unsigned int mask);
  99. void xfs_ag_mark_healthy(struct xfs_perag *pag, unsigned int mask);
  100. void xfs_ag_measure_sickness(struct xfs_perag *pag, unsigned int *sick,
  101. unsigned int *checked);
  102. void xfs_inode_mark_sick(struct xfs_inode *ip, unsigned int mask);
  103. void xfs_inode_mark_healthy(struct xfs_inode *ip, unsigned int mask);
  104. void xfs_inode_measure_sickness(struct xfs_inode *ip, unsigned int *sick,
  105. unsigned int *checked);
  106. void xfs_health_unmount(struct xfs_mount *mp);
  107. /* Now some helpers. */
  108. static inline bool
  109. xfs_fs_has_sickness(struct xfs_mount *mp, unsigned int mask)
  110. {
  111. unsigned int sick, checked;
  112. xfs_fs_measure_sickness(mp, &sick, &checked);
  113. return sick & mask;
  114. }
  115. static inline bool
  116. xfs_rt_has_sickness(struct xfs_mount *mp, unsigned int mask)
  117. {
  118. unsigned int sick, checked;
  119. xfs_rt_measure_sickness(mp, &sick, &checked);
  120. return sick & mask;
  121. }
  122. static inline bool
  123. xfs_ag_has_sickness(struct xfs_perag *pag, unsigned int mask)
  124. {
  125. unsigned int sick, checked;
  126. xfs_ag_measure_sickness(pag, &sick, &checked);
  127. return sick & mask;
  128. }
  129. static inline bool
  130. xfs_inode_has_sickness(struct xfs_inode *ip, unsigned int mask)
  131. {
  132. unsigned int sick, checked;
  133. xfs_inode_measure_sickness(ip, &sick, &checked);
  134. return sick & mask;
  135. }
  136. static inline bool
  137. xfs_fs_is_healthy(struct xfs_mount *mp)
  138. {
  139. return !xfs_fs_has_sickness(mp, -1U);
  140. }
  141. static inline bool
  142. xfs_rt_is_healthy(struct xfs_mount *mp)
  143. {
  144. return !xfs_rt_has_sickness(mp, -1U);
  145. }
  146. static inline bool
  147. xfs_ag_is_healthy(struct xfs_perag *pag)
  148. {
  149. return !xfs_ag_has_sickness(pag, -1U);
  150. }
  151. static inline bool
  152. xfs_inode_is_healthy(struct xfs_inode *ip)
  153. {
  154. return !xfs_inode_has_sickness(ip, -1U);
  155. }
  156. void xfs_fsop_geom_health(struct xfs_mount *mp, struct xfs_fsop_geom *geo);
  157. void xfs_ag_geom_health(struct xfs_perag *pag, struct xfs_ag_geometry *ageo);
  158. void xfs_bulkstat_health(struct xfs_inode *ip, struct xfs_bulkstat *bs);
  159. #endif /* __XFS_HEALTH_H__ */