1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2023 Oracle. All Rights Reserved.
8 #include "xfs_shared.h"
9 #include "xfs_format.h"
10 #include "xfs_trans_resv.h"
11 #include "xfs_mount.h"
12 #include "xfs_sysfs.h"
13 #include "xfs_btree.h"
14 #include "xfs_super.h"
15 #include "scrub/scrub.h"
16 #include "scrub/stats.h"
17 #include "scrub/trace.h"
19 struct xchk_scrub_stats {
20 /* all 32-bit counters here */
34 uint32_t repair_invocations;
35 uint32_t repair_success;
37 /* all 64-bit items here */
40 uint64_t checktime_us;
41 uint64_t repairtime_us;
43 /* non-counter state must go at the end for clearall */
48 struct dentry *cs_debugfs;
49 struct xchk_scrub_stats cs_stats[XFS_SCRUB_TYPE_NR];
53 static struct xchk_stats global_stats;
55 static const char *name_map[XFS_SCRUB_TYPE_NR] = {
56 [XFS_SCRUB_TYPE_SB] = "sb",
57 [XFS_SCRUB_TYPE_AGF] = "agf",
58 [XFS_SCRUB_TYPE_AGFL] = "agfl",
59 [XFS_SCRUB_TYPE_AGI] = "agi",
60 [XFS_SCRUB_TYPE_BNOBT] = "bnobt",
61 [XFS_SCRUB_TYPE_CNTBT] = "cntbt",
62 [XFS_SCRUB_TYPE_INOBT] = "inobt",
63 [XFS_SCRUB_TYPE_FINOBT] = "finobt",
64 [XFS_SCRUB_TYPE_RMAPBT] = "rmapbt",
65 [XFS_SCRUB_TYPE_REFCNTBT] = "refcountbt",
66 [XFS_SCRUB_TYPE_INODE] = "inode",
67 [XFS_SCRUB_TYPE_BMBTD] = "bmapbtd",
68 [XFS_SCRUB_TYPE_BMBTA] = "bmapbta",
69 [XFS_SCRUB_TYPE_BMBTC] = "bmapbtc",
70 [XFS_SCRUB_TYPE_DIR] = "directory",
71 [XFS_SCRUB_TYPE_XATTR] = "xattr",
72 [XFS_SCRUB_TYPE_SYMLINK] = "symlink",
73 [XFS_SCRUB_TYPE_PARENT] = "parent",
74 [XFS_SCRUB_TYPE_RTBITMAP] = "rtbitmap",
75 [XFS_SCRUB_TYPE_RTSUM] = "rtsummary",
76 [XFS_SCRUB_TYPE_UQUOTA] = "usrquota",
77 [XFS_SCRUB_TYPE_GQUOTA] = "grpquota",
78 [XFS_SCRUB_TYPE_PQUOTA] = "prjquota",
79 [XFS_SCRUB_TYPE_FSCOUNTERS] = "fscounters",
80 [XFS_SCRUB_TYPE_QUOTACHECK] = "quotacheck",
81 [XFS_SCRUB_TYPE_NLINKS] = "nlinks",
84 /* Format the scrub stats into a text buffer, similar to pcp style. */
87 struct xchk_stats *cs,
91 struct xchk_scrub_stats *css = &cs->cs_stats[0];
96 for (i = 0; i < XFS_SCRUB_TYPE_NR; i++, css++) {
100 ret = scnprintf(buf, remaining,
101 "%s %u %u %u %u %u %u %u %u %u %llu %u %u %llu\n",
103 (unsigned int)css->invocations,
104 (unsigned int)css->clean,
105 (unsigned int)css->corrupt,
106 (unsigned int)css->preen,
107 (unsigned int)css->xfail,
108 (unsigned int)css->xcorrupt,
109 (unsigned int)css->incomplete,
110 (unsigned int)css->warning,
111 (unsigned int)css->retries,
112 (unsigned long long)css->checktime_us,
113 (unsigned int)css->repair_invocations,
114 (unsigned int)css->repair_success,
115 (unsigned long long)css->repairtime_us);
124 return copied > 0 ? copied : ret;
127 /* Estimate the worst case buffer size required to hold the whole report. */
129 xchk_stats_estimate_bufsize(
130 struct xchk_stats *cs)
132 struct xchk_scrub_stats *css = &cs->cs_stats[0];
137 /* 4294967296 plus one space for each u32 field */
138 field_width = 11 * (offsetof(struct xchk_scrub_stats, checktime_us) /
141 /* 18446744073709551615 plus one space for each u64 field */
142 field_width += 21 * ((offsetof(struct xchk_scrub_stats, css_lock) -
143 offsetof(struct xchk_scrub_stats, checktime_us)) /
146 for (i = 0; i < XFS_SCRUB_TYPE_NR; i++, css++) {
150 /* name plus one space */
151 ret += 1 + strlen(name_map[i]);
153 /* all fields, plus newline */
154 ret += field_width + 1;
160 /* Clear all counters. */
163 struct xchk_stats *cs)
165 struct xchk_scrub_stats *css = &cs->cs_stats[0];
168 for (i = 0; i < XFS_SCRUB_TYPE_NR; i++, css++) {
169 spin_lock(&css->css_lock);
170 memset(css, 0, offsetof(struct xchk_scrub_stats, css_lock));
171 spin_unlock(&css->css_lock);
175 #define XFS_SCRUB_OFLAG_UNCLEAN (XFS_SCRUB_OFLAG_CORRUPT | \
176 XFS_SCRUB_OFLAG_PREEN | \
177 XFS_SCRUB_OFLAG_XFAIL | \
178 XFS_SCRUB_OFLAG_XCORRUPT | \
179 XFS_SCRUB_OFLAG_INCOMPLETE | \
180 XFS_SCRUB_OFLAG_WARNING)
183 xchk_stats_merge_one(
184 struct xchk_stats *cs,
185 const struct xfs_scrub_metadata *sm,
186 const struct xchk_stats_run *run)
188 struct xchk_scrub_stats *css;
190 if (sm->sm_type >= XFS_SCRUB_TYPE_NR) {
191 ASSERT(sm->sm_type < XFS_SCRUB_TYPE_NR);
195 css = &cs->cs_stats[sm->sm_type];
196 spin_lock(&css->css_lock);
198 if (!(sm->sm_flags & XFS_SCRUB_OFLAG_UNCLEAN))
200 if (sm->sm_flags & XFS_SCRUB_OFLAG_CORRUPT)
202 if (sm->sm_flags & XFS_SCRUB_OFLAG_PREEN)
204 if (sm->sm_flags & XFS_SCRUB_OFLAG_XFAIL)
206 if (sm->sm_flags & XFS_SCRUB_OFLAG_XCORRUPT)
208 if (sm->sm_flags & XFS_SCRUB_OFLAG_INCOMPLETE)
210 if (sm->sm_flags & XFS_SCRUB_OFLAG_WARNING)
212 css->retries += run->retries;
213 css->checktime_us += howmany_64(run->scrub_ns, NSEC_PER_USEC);
215 if (run->repair_attempted)
216 css->repair_invocations++;
217 if (run->repair_succeeded)
218 css->repair_success++;
219 css->repairtime_us += howmany_64(run->repair_ns, NSEC_PER_USEC);
220 spin_unlock(&css->css_lock);
223 /* Merge these scrub-run stats into the global and mount stat data. */
226 struct xfs_mount *mp,
227 const struct xfs_scrub_metadata *sm,
228 const struct xchk_stats_run *run)
230 xchk_stats_merge_one(&global_stats, sm, run);
231 xchk_stats_merge_one(mp->m_scrub_stats, sm, run);
234 /* debugfs boilerplate */
237 xchk_scrub_stats_read(
243 struct xchk_stats *cs = file->private_data;
249 * This generates stringly snapshot of all the scrub counters, so we
250 * do not want userspace to receive garbled text from multiple calls.
251 * If the file position is greater than 0, return a short read.
256 bufsize = xchk_stats_estimate_bufsize(cs);
258 buf = kvmalloc(bufsize, XCHK_GFP_FLAGS);
262 avail = xchk_stats_format(cs, buf, bufsize);
268 ret = simple_read_from_buffer(ubuf, count, ppos, buf, avail);
274 static const struct file_operations scrub_stats_fops = {
276 .read = xchk_scrub_stats_read,
280 xchk_clear_scrub_stats_write(
282 const char __user *ubuf,
286 struct xchk_stats *cs = file->private_data;
290 ret = kstrtouint_from_user(ubuf, count, 0, &val);
297 xchk_stats_clearall(cs);
301 static const struct file_operations clear_scrub_stats_fops = {
303 .write = xchk_clear_scrub_stats_write,
306 /* Initialize the stats object. */
309 struct xchk_stats *cs,
310 struct xfs_mount *mp)
312 struct xchk_scrub_stats *css = &cs->cs_stats[0];
315 for (i = 0; i < XFS_SCRUB_TYPE_NR; i++, css++)
316 spin_lock_init(&css->css_lock);
321 /* Connect the stats object to debugfs. */
324 struct xchk_stats *cs,
325 struct dentry *parent)
330 cs->cs_debugfs = xfs_debugfs_mkdir("scrub", parent);
334 debugfs_create_file("stats", 0444, cs->cs_debugfs, cs,
336 debugfs_create_file("clear_stats", 0200, cs->cs_debugfs, cs,
337 &clear_scrub_stats_fops);
340 /* Free all resources related to the stats object. */
343 struct xchk_stats *cs)
348 /* Disconnect the stats object from debugfs. */
350 xchk_stats_unregister(
351 struct xchk_stats *cs)
353 debugfs_remove(cs->cs_debugfs);
356 /* Initialize global stats and register them */
358 xchk_global_stats_setup(
359 struct dentry *parent)
363 error = xchk_stats_init(&global_stats, NULL);
367 xchk_stats_register(&global_stats, parent);
371 /* Unregister global stats and tear them down */
373 xchk_global_stats_teardown(void)
375 xchk_stats_unregister(&global_stats);
376 xchk_stats_teardown(&global_stats);
379 /* Allocate per-mount stats */
381 xchk_mount_stats_alloc(
382 struct xfs_mount *mp)
384 struct xchk_stats *cs;
387 cs = kvzalloc(sizeof(struct xchk_stats), GFP_KERNEL);
391 error = xchk_stats_init(cs, mp);
395 mp->m_scrub_stats = cs;
402 /* Free per-mount stats */
404 xchk_mount_stats_free(
405 struct xfs_mount *mp)
407 xchk_stats_teardown(mp->m_scrub_stats);
408 kvfree(mp->m_scrub_stats);
409 mp->m_scrub_stats = NULL;