All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Lassoff <jof@thejof.com>
To: linux-xfs@vger.kernel.org
Cc: "Darrick J . Wong" <djwong@kernel.org>,
	Jonathan Lassoff <jof@thejof.com>
Subject: [PATCH v1] Add XFS messages to printk index
Date: Mon, 21 Mar 2022 23:11:23 +0000	[thread overview]
Message-ID: <20220321231123.73487-1-jof@thejof.com> (raw)

In order for end users to quickly react to new issues that come up in
production, it is proving useful to leverage the printk indexing system.
This printk index enables kernel developers to use calls to printk()
with changable ad-hoc format strings, while still enabling end users to
detect changes and develop a semi-stable interface for detecting and
parsing these messages.

So that detailed XFS messages are captures by this printk index, this
patch wraps the xfs_<level> and xfs_alert_tag functions.

[PATCH v1] -- De-duplicate kernel logging levels and tidy whitespace.
---
 fs/xfs/xfs_message.c | 68 +++++++++++++++++++-----------------
 fs/xfs/xfs_message.h | 82 ++++++++++++++++++++++++++++++++------------
 2 files changed, 97 insertions(+), 53 deletions(-)

diff --git a/fs/xfs/xfs_message.c b/fs/xfs/xfs_message.c
index bc66d95c8d4c..8f29d8e86482 100644
--- a/fs/xfs/xfs_message.c
+++ b/fs/xfs/xfs_message.c
@@ -21,46 +21,50 @@ __xfs_printk(
 	struct va_format	*vaf)
 {
 	if (mp && mp->m_super) {
-		printk("%sXFS (%s): %pV\n", level, mp->m_super->s_id, vaf);
+		_printk("%sXFS (%s): %pV\n", level, mp->m_super->s_id, vaf);
 		return;
 	}
-	printk("%sXFS: %pV\n", level, vaf);
+	_printk("%sXFS: %pV\n", level, vaf);
 }
 
-#define define_xfs_printk_level(func, kern_level)		\
-void func(const struct xfs_mount *mp, const char *fmt, ...)	\
-{								\
-	struct va_format	vaf;				\
-	va_list			args;				\
-	int			level;				\
-								\
-	va_start(args, fmt);					\
-								\
-	vaf.fmt = fmt;						\
-	vaf.va = &args;						\
-								\
-	__xfs_printk(kern_level, mp, &vaf);			\
-	va_end(args);						\
-								\
-	if (!kstrtoint(kern_level, 0, &level) &&		\
-	    level <= LOGLEVEL_ERR &&				\
-	    xfs_error_level >= XFS_ERRLEVEL_HIGH)		\
-		xfs_stack_trace();				\
-}								\
-
-define_xfs_printk_level(xfs_emerg, KERN_EMERG);
-define_xfs_printk_level(xfs_alert, KERN_ALERT);
-define_xfs_printk_level(xfs_crit, KERN_CRIT);
-define_xfs_printk_level(xfs_err, KERN_ERR);
-define_xfs_printk_level(xfs_warn, KERN_WARNING);
-define_xfs_printk_level(xfs_notice, KERN_NOTICE);
-define_xfs_printk_level(xfs_info, KERN_INFO);
+#define define_xfs_printk_level(func)			\
+void func(						\
+	const char *kern_level,				\
+	const struct xfs_mount *mp,			\
+	const char *fmt,				\
+	...)						\
+{							\
+	struct va_format	vaf;			\
+	va_list			args;			\
+	int			level;			\
+							\
+	va_start(args, fmt);				\
+							\
+	vaf.fmt = fmt;					\
+	vaf.va = &args;					\
+							\
+	__xfs_printk(kern_level, mp, &vaf);		\
+	va_end(args);					\
+							\
+	if (!kstrtoint(kern_level, 0, &level) &&	\
+	    level <= LOGLEVEL_ERR &&			\
+	    xfs_error_level >= XFS_ERRLEVEL_HIGH)	\
+		xfs_stack_trace();			\
+}							\
+
+define_xfs_printk_level(_xfs_emerg);
+define_xfs_printk_level(_xfs_alert);
+define_xfs_printk_level(_xfs_crit);
+define_xfs_printk_level(_xfs_err);
+define_xfs_printk_level(_xfs_warn);
+define_xfs_printk_level(_xfs_notice);
+define_xfs_printk_level(_xfs_info);
 #ifdef DEBUG
-define_xfs_printk_level(xfs_debug, KERN_DEBUG);
+define_xfs_printk_level(_xfs_debug);
 #endif
 
 void
-xfs_alert_tag(
+_xfs_alert_tag(
 	const struct xfs_mount	*mp,
 	int			panic_tag,
 	const char		*fmt, ...)
diff --git a/fs/xfs/xfs_message.h b/fs/xfs/xfs_message.h
index bb9860ec9a93..6f9d4a3553de 100644
--- a/fs/xfs/xfs_message.h
+++ b/fs/xfs/xfs_message.h
@@ -6,31 +6,71 @@
 
 struct xfs_mount;
 
-extern __printf(2, 3)
-void xfs_emerg(const struct xfs_mount *mp, const char *fmt, ...);
-extern __printf(2, 3)
-void xfs_alert(const struct xfs_mount *mp, const char *fmt, ...);
+#define xfs_printk_index_wrap(_p_func, kern_level, mp, fmt, ...)		\
+({										\
+	printk_index_subsys_emit("%sXFS%s: ", kern_level, fmt, ##__VA_ARGS__);	\
+	_p_func(kern_level, mp, fmt, ##__VA_ARGS__);				\
+})
+#define xfs_alert_tag(mp, tag, fmt, ...)					\
+({										\
+	printk_index_subsys_emit("%sXFS%s: ", KERN_ALERT, fmt, ##__VA_ARGS__);	\
+	_xfs_alert_tag(mp, tag, fmt, ##__VA_ARGS__);				\
+})
+#define xfs_emerg(mp, fmt, ...)\
+	xfs_printk_index_wrap(_xfs_emerg, KERN_EMERG, mp, fmt, ##__VA_ARGS__)
+#define xfs_alert(mp, fmt, ...)\
+	xfs_printk_index_wrap(_xfs_alert, KERN_ALERT, mp, fmt, ##__VA_ARGS__)
+#define xfs_crit(mp, fmt, ...)\
+	xfs_printk_index_wrap(_xfs_crit, KERN_CRIT, mp, fmt, ##__VA_ARGS__)
+#define xfs_err(mp, fmt, ...)\
+	xfs_printk_index_wrap(_xfs_err, KERN_ERR, mp, fmt, ##__VA_ARGS__)
+#define xfs_warn(mp, fmt, ...)\
+	xfs_printk_index_wrap(_xfs_warn, KERN_WARNING, mp, fmt, ##__VA_ARGS__)
+#define xfs_notice(mp, fmt, ...)\
+	xfs_printk_index_wrap(_xfs_notice, KERN_NOTICE, mp, fmt, ##__VA_ARGS__)
+#define xfs_info(mp, fmt, ...)\
+	xfs_printk_index_wrap(_xfs_info, KERN_INFO, mp, fmt, ##__VA_ARGS__)
+#ifdef DEBUG
+#define xfs_debug(mp, fmt, ...)\
+	xfs_printk_index_wrap(_xfs_debug, KERN_DEBUG, mp, fmt, ##__VA_ARGS__)
+#else
+#define xfs_debug(mp, fmt, ...) do {} while (0)
+#endif
+
+
+extern __printf(3, 4)
+void _xfs_emerg(
+	const char *kern_level, const struct xfs_mount *mp, const char *fmt, ...);
+extern __printf(3, 4)
+void _xfs_alert(
+	const char *kern_level, const struct xfs_mount *mp, const char *fmt, ...);
 extern __printf(3, 4)
-void xfs_alert_tag(const struct xfs_mount *mp, int tag, const char *fmt, ...);
-extern __printf(2, 3)
-void xfs_crit(const struct xfs_mount *mp, const char *fmt, ...);
-extern __printf(2, 3)
-void xfs_err(const struct xfs_mount *mp, const char *fmt, ...);
-extern __printf(2, 3)
-void xfs_warn(const struct xfs_mount *mp, const char *fmt, ...);
-extern __printf(2, 3)
-void xfs_notice(const struct xfs_mount *mp, const char *fmt, ...);
-extern __printf(2, 3)
-void xfs_info(const struct xfs_mount *mp, const char *fmt, ...);
+void _xfs_alert_tag(const struct xfs_mount *mp, int tag, const char *fmt, ...);
+extern __printf(3, 4)
+void _xfs_crit(
+	const char *kern_level, const struct xfs_mount *mp, const char *fmt, ...);
+extern __printf(3, 4)
+void _xfs_err(
+	const char *kern_level, const struct xfs_mount *mp, const char *fmt, ...);
+extern __printf(3, 4)
+void _xfs_warn(
+	const char *kern_level, const struct xfs_mount *mp, const char *fmt, ...);
+extern __printf(3, 4)
+void _xfs_notice(
+	const char *kern_level, const struct xfs_mount *mp, const char *fmt, ...);
+extern __printf(3, 4)
+void _xfs_info(
+	const char *kern_level, const struct xfs_mount *mp, const char *fmt, ...);
 
 #ifdef DEBUG
-extern __printf(2, 3)
-void xfs_debug(const struct xfs_mount *mp, const char *fmt, ...);
+extern __printf(3, 4)
+void _xfs_debug(
+	const char *kern_level, const struct xfs_mount *mp, const char *fmt, ...);
 #else
-static inline __printf(2, 3)
-void xfs_debug(const struct xfs_mount *mp, const char *fmt, ...)
-{
-}
+extern __printf(3, 4)
+void _xfs_debug(
+	const char *kern_level, const struct xfs_mount *mp, const char *fmt, ...)
+{}
 #endif
 
 #define xfs_printk_ratelimited(func, dev, fmt, ...)			\
-- 
2.30.2


             reply	other threads:[~2022-03-21 23:19 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-21 23:11 Jonathan Lassoff [this message]
2022-03-25  1:16 ` [PATCH v1] Add XFS messages to printk index Dave Chinner
2022-03-25  7:37   ` Jonathan Lassoff

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=20220321231123.73487-1-jof@thejof.com \
    --to=jof@thejof.com \
    --cc=djwong@kernel.org \
    --cc=linux-xfs@vger.kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.