1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2023 Oracle. All Rights Reserved.
4 * Author: Darrick J. Wong <djwong@kernel.org>
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",
82 /* Format the scrub stats into a text buffer, similar to pcp style. */
85 struct xchk_stats *cs,
89 struct xchk_scrub_stats *css = &cs->cs_stats[0];
94 for (i = 0; i < XFS_SCRUB_TYPE_NR; i++, css++) {
98 ret = scnprintf(buf, remaining,
99 "%s %u %u %u %u %u %u %u %u %u %llu %u %u %llu\n",
101 (unsigned int)css->invocations,
102 (unsigned int)css->clean,
103 (unsigned int)css->corrupt,
104 (unsigned int)css->preen,
105 (unsigned int)css->xfail,
106 (unsigned int)css->xcorrupt,
107 (unsigned int)css->incomplete,
108 (unsigned int)css->warning,
109 (unsigned int)css->retries,
110 (unsigned long long)css->checktime_us,
111 (unsigned int)css->repair_invocations,
112 (unsigned int)css->repair_success,
113 (unsigned long long)css->repairtime_us);
122 return copied > 0 ? copied : ret;
125 /* Estimate the worst case buffer size required to hold the whole report. */
127 xchk_stats_estimate_bufsize(
128 struct xchk_stats *cs)
130 struct xchk_scrub_stats *css = &cs->cs_stats[0];
135 /* 4294967296 plus one space for each u32 field */
136 field_width = 11 * (offsetof(struct xchk_scrub_stats, checktime_us) /
139 /* 18446744073709551615 plus one space for each u64 field */
140 field_width += 21 * ((offsetof(struct xchk_scrub_stats, css_lock) -
141 offsetof(struct xchk_scrub_stats, checktime_us)) /
144 for (i = 0; i < XFS_SCRUB_TYPE_NR; i++, css++) {
148 /* name plus one space */
149 ret += 1 + strlen(name_map[i]);
151 /* all fields, plus newline */
152 ret += field_width + 1;
158 /* Clear all counters. */
161 struct xchk_stats *cs)
163 struct xchk_scrub_stats *css = &cs->cs_stats[0];
166 for (i = 0; i < XFS_SCRUB_TYPE_NR; i++, css++) {
167 spin_lock(&css->css_lock);
168 memset(css, 0, offsetof(struct xchk_scrub_stats, css_lock));
169 spin_unlock(&css->css_lock);
173 #define XFS_SCRUB_OFLAG_UNCLEAN (XFS_SCRUB_OFLAG_CORRUPT | \
174 XFS_SCRUB_OFLAG_PREEN | \
175 XFS_SCRUB_OFLAG_XFAIL | \
176 XFS_SCRUB_OFLAG_XCORRUPT | \
177 XFS_SCRUB_OFLAG_INCOMPLETE | \
178 XFS_SCRUB_OFLAG_WARNING)
181 xchk_stats_merge_one(
182 struct xchk_stats *cs,
183 const struct xfs_scrub_metadata *sm,
184 const struct xchk_stats_run *run)
186 struct xchk_scrub_stats *css;
188 if (sm->sm_type >= XFS_SCRUB_TYPE_NR) {
189 ASSERT(sm->sm_type < XFS_SCRUB_TYPE_NR);
193 css = &cs->cs_stats[sm->sm_type];
194 spin_lock(&css->css_lock);
196 if (!(sm->sm_flags & XFS_SCRUB_OFLAG_UNCLEAN))
198 if (sm->sm_flags & XFS_SCRUB_OFLAG_CORRUPT)
200 if (sm->sm_flags & XFS_SCRUB_OFLAG_PREEN)
202 if (sm->sm_flags & XFS_SCRUB_OFLAG_XFAIL)
204 if (sm->sm_flags & XFS_SCRUB_OFLAG_XCORRUPT)
206 if (sm->sm_flags & XFS_SCRUB_OFLAG_INCOMPLETE)
208 if (sm->sm_flags & XFS_SCRUB_OFLAG_WARNING)
210 css->retries += run->retries;
211 css->checktime_us += howmany_64(run->scrub_ns, NSEC_PER_USEC);
213 if (run->repair_attempted)
214 css->repair_invocations++;
215 if (run->repair_succeeded)
216 css->repair_success++;
217 css->repairtime_us += howmany_64(run->repair_ns, NSEC_PER_USEC);
218 spin_unlock(&css->css_lock);
221 /* Merge these scrub-run stats into the global and mount stat data. */
224 struct xfs_mount *mp,
225 const struct xfs_scrub_metadata *sm,
226 const struct xchk_stats_run *run)
228 xchk_stats_merge_one(&global_stats, sm, run);
229 xchk_stats_merge_one(mp->m_scrub_stats, sm, run);
232 /* debugfs boilerplate */
235 xchk_scrub_stats_read(
241 struct xchk_stats *cs = file->private_data;
247 * This generates stringly snapshot of all the scrub counters, so we
248 * do not want userspace to receive garbled text from multiple calls.
249 * If the file position is greater than 0, return a short read.
254 bufsize = xchk_stats_estimate_bufsize(cs);
256 buf = kvmalloc(bufsize, XCHK_GFP_FLAGS);
260 avail = xchk_stats_format(cs, buf, bufsize);
266 ret = simple_read_from_buffer(ubuf, count, ppos, buf, avail);
272 static const struct file_operations scrub_stats_fops = {
274 .read = xchk_scrub_stats_read,
278 xchk_clear_scrub_stats_write(
280 const char __user *ubuf,
284 struct xchk_stats *cs = file->private_data;
288 ret = kstrtouint_from_user(ubuf, count, 0, &val);
295 xchk_stats_clearall(cs);
299 static const struct file_operations clear_scrub_stats_fops = {
301 .write = xchk_clear_scrub_stats_write,
304 /* Initialize the stats object. */
307 struct xchk_stats *cs,
308 struct xfs_mount *mp)
310 struct xchk_scrub_stats *css = &cs->cs_stats[0];
313 for (i = 0; i < XFS_SCRUB_TYPE_NR; i++, css++)
314 spin_lock_init(&css->css_lock);
319 /* Connect the stats object to debugfs. */
322 struct xchk_stats *cs,
323 struct dentry *parent)
328 cs->cs_debugfs = xfs_debugfs_mkdir("scrub", parent);
332 debugfs_create_file("stats", 0644, cs->cs_debugfs, cs,
334 debugfs_create_file("clear_stats", 0400, cs->cs_debugfs, cs,
335 &clear_scrub_stats_fops);
338 /* Free all resources related to the stats object. */
341 struct xchk_stats *cs)
346 /* Disconnect the stats object from debugfs. */
348 xchk_stats_unregister(
349 struct xchk_stats *cs)
351 debugfs_remove(cs->cs_debugfs);
354 /* Initialize global stats and register them */
356 xchk_global_stats_setup(
357 struct dentry *parent)
361 error = xchk_stats_init(&global_stats, NULL);
365 xchk_stats_register(&global_stats, parent);
369 /* Unregister global stats and tear them down */
371 xchk_global_stats_teardown(void)
373 xchk_stats_unregister(&global_stats);
374 xchk_stats_teardown(&global_stats);
377 /* Allocate per-mount stats */
379 xchk_mount_stats_alloc(
380 struct xfs_mount *mp)
382 struct xchk_stats *cs;
385 cs = kvzalloc(sizeof(struct xchk_stats), GFP_KERNEL);
389 error = xchk_stats_init(cs, mp);
393 mp->m_scrub_stats = cs;
400 /* Free per-mount stats */
402 xchk_mount_stats_free(
403 struct xfs_mount *mp)
405 xchk_stats_teardown(mp->m_scrub_stats);
406 kvfree(mp->m_scrub_stats);
407 mp->m_scrub_stats = NULL;