From: "Darrick J. Wong" <djwong@kernel.org>
To: david@fromorbit.com, sandeen@sandeen.net, cmaiolino@redhat.com
Cc: linux-xfs@vger.kernel.org
Subject: [PATCH v3 16/15] xfs: start documenting common units and tags used in tracepoints
Date: Thu, 19 Aug 2021 10:10:00 -0700 [thread overview]
Message-ID: <20210819171000.GU12640@magnolia> (raw)
In-Reply-To: <20210819034647.GR12640@magnolia>
From: Darrick J. Wong <djwong@kernel.org>
Because there are a lot of tracepoints that express numeric data with
an associated unit and tag, document what they are to help everyone else
keep these thigns straight.
Signed-off-by: Darrick J. Wong <djwong@kernel.org>
Reviewed-by: Dave Chinner <dchinner@redhat.com>
Reviewed-by: Carlos Maiolino <cmaiolino@redhat.com>
---
v2: update unit names, say that we want hex, and put related tag names
together
v3: more corrections of unit names
---
fs/xfs/scrub/trace.h | 4 ++++
fs/xfs/xfs_trace.h | 35 +++++++++++++++++++++++++++++++++++
2 files changed, 39 insertions(+)
diff --git a/fs/xfs/scrub/trace.h b/fs/xfs/scrub/trace.h
index dfb10966af24..a7bbb84f91a7 100644
--- a/fs/xfs/scrub/trace.h
+++ b/fs/xfs/scrub/trace.h
@@ -2,6 +2,10 @@
/*
* Copyright (C) 2017 Oracle. All Rights Reserved.
* Author: Darrick J. Wong <darrick.wong@oracle.com>
+ *
+ * NOTE: none of these tracepoints shall be considered a stable kernel ABI
+ * as they can change at any time. See xfs_trace.h for documentation of
+ * specific units found in tracepoint output.
*/
#undef TRACE_SYSTEM
#define TRACE_SYSTEM xfs_scrub
diff --git a/fs/xfs/xfs_trace.h b/fs/xfs/xfs_trace.h
index 676b66173bb1..6d025a231d3e 100644
--- a/fs/xfs/xfs_trace.h
+++ b/fs/xfs/xfs_trace.h
@@ -2,6 +2,41 @@
/*
* Copyright (c) 2009, Christoph Hellwig
* All Rights Reserved.
+ *
+ * NOTE: none of these tracepoints shall be considered a stable kernel ABI
+ * as they can change at any time.
+ *
+ * Current conventions for printing numbers measuring specific units:
+ *
+ * agno: allocation group number
+ *
+ * agino: per-AG inode number
+ * ino: filesystem inode number
+ *
+ * agbno: per-AG block number in fs blocks
+ * startblock: physical block number for file mappings. This is either a
+ * segmented fsblock for data device mappings, or a rfsblock
+ * for realtime device mappings
+ * fsbcount: number of blocks in an extent, in fs blocks
+ *
+ * daddr: physical block number in 512b blocks
+ * bbcount: number of blocks in a physical extent, in 512b blocks
+ *
+ * owner: reverse-mapping owner, usually inodes
+ *
+ * fileoff: file offset, in fs blocks
+ * pos: file offset, in bytes
+ * bytecount: number of bytes
+ *
+ * disize: ondisk file size, in bytes
+ * isize: incore file size, in bytes
+ *
+ * forkoff: inode fork offset, in bytes
+ *
+ * ireccount: number of inode records
+ *
+ * Numbers describing space allocations (blocks, extents, inodes) should be
+ * formatted in hexadecimal.
*/
#undef TRACE_SYSTEM
#define TRACE_SYSTEM xfs
prev parent reply other threads:[~2021-08-19 17:10 UTC|newest]
Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-17 23:42 [PATCHSET 00/15] xfs: clean up ftrace field tags and formats Darrick J. Wong
2021-08-17 23:42 ` [PATCH 01/15] xfs: fix incorrect unit conversion in scrub tracepoint Darrick J. Wong
2021-08-19 2:29 ` Dave Chinner
2021-08-19 7:57 ` Carlos Maiolino
2021-08-17 23:42 ` [PATCH 02/15] xfs: standardize inode number formatting in ftrace output Darrick J. Wong
2021-08-19 2:34 ` Dave Chinner
2021-08-19 8:27 ` Carlos Maiolino
2021-08-17 23:42 ` [PATCH 03/15] xfs: standardize AG " Darrick J. Wong
2021-08-19 2:35 ` Dave Chinner
2021-08-19 8:45 ` Carlos Maiolino
2021-08-17 23:42 ` [PATCH 04/15] xfs: standardize AG block " Darrick J. Wong
2021-08-19 2:37 ` Dave Chinner
2021-08-19 9:06 ` Carlos Maiolino
2021-08-17 23:42 ` [PATCH 05/15] xfs: standardize rmap owner " Darrick J. Wong
2021-08-19 2:38 ` Dave Chinner
2021-08-19 9:57 ` Carlos Maiolino
2021-08-17 23:42 ` [PATCH 06/15] xfs: standardize daddr " Darrick J. Wong
2021-08-19 2:42 ` Dave Chinner
2021-08-19 11:02 ` Carlos Maiolino
2021-08-17 23:42 ` [PATCH 07/15] xfs: disambiguate units for ftrace fields tagged "blkno", "block", or "bno" Darrick J. Wong
2021-08-19 2:47 ` Dave Chinner
2021-08-19 11:12 ` Carlos Maiolino
2021-08-17 23:42 ` [PATCH 08/15] xfs: disambiguate units for ftrace fields tagged "offset" Darrick J. Wong
2021-08-19 2:51 ` Dave Chinner
2021-08-19 11:45 ` Carlos Maiolino
2021-08-19 11:42 ` Carlos Maiolino
2021-08-17 23:43 ` [PATCH 09/15] xfs: disambiguate units for ftrace fields tagged "len" Darrick J. Wong
2021-08-19 3:01 ` Dave Chinner
2021-08-19 3:06 ` Darrick J. Wong
2021-08-19 3:44 ` [PATCH v2 " Darrick J. Wong
2021-08-19 12:08 ` Carlos Maiolino
2021-08-17 23:43 ` [PATCH 10/15] xfs: disambiguate units for ftrace fields tagged "count" Darrick J. Wong
2021-08-19 3:11 ` Dave Chinner
2021-08-19 3:19 ` Darrick J. Wong
2021-08-19 3:45 ` [PATCH v2 " Darrick J. Wong
2021-08-19 5:38 ` Dave Chinner
2021-08-19 12:26 ` Carlos Maiolino
2021-08-17 23:43 ` [PATCH 11/15] xfs: rename i_disk_size fields in ftrace output Darrick J. Wong
2021-08-19 3:14 ` Dave Chinner
2021-08-19 12:32 ` Carlos Maiolino
2021-08-17 23:43 ` [PATCH 12/15] xfs: resolve fork names in trace output Darrick J. Wong
2021-08-19 3:16 ` Dave Chinner
2021-08-19 12:43 ` Carlos Maiolino
2021-08-17 23:43 ` [PATCH 13/15] xfs: standardize remaining xfs_buf length tracepoints Darrick J. Wong
2021-08-19 3:19 ` Dave Chinner
2021-08-19 12:48 ` Carlos Maiolino
2021-08-17 23:43 ` [PATCH 14/15] xfs: standardize inode generation formatting in ftrace output Darrick J. Wong
2021-08-19 3:19 ` Dave Chinner
2021-08-19 12:57 ` Carlos Maiolino
2021-08-17 23:43 ` [PATCH 15/15] xfs: decode scrub flags " Darrick J. Wong
2021-08-19 3:20 ` Dave Chinner
2021-08-19 13:04 ` Carlos Maiolino
2021-08-19 3:07 ` [PATCH 16/15] xfs: start documenting common units and tags used in tracepoints Darrick J. Wong
2021-08-19 3:24 ` Dave Chinner
2021-08-19 3:46 ` [PATCH v2 " Darrick J. Wong
2021-08-19 5:39 ` Dave Chinner
2021-08-19 13:27 ` Carlos Maiolino
2021-08-19 17:06 ` Darrick J. Wong
2021-08-19 17:10 ` Darrick J. Wong [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210819171000.GU12640@magnolia \
--to=djwong@kernel.org \
--cc=cmaiolino@redhat.com \
--cc=david@fromorbit.com \
--cc=linux-xfs@vger.kernel.org \
--cc=sandeen@sandeen.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).