Skip to contentSkip to conversation

PM: refactor pm_pr_dbg() to support dynamic debug

PATCH In review David Cohen 2 participants 4 messages Mar 24, 2022 – Apr 13, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

v3 cover PM: refactor pm_pr_dbg() to support dynamic debug

Hi,

I am currently debugging an issue with s2idle on my laptop where in a rare occasion instead of sleeping, it gets stuck in an infinite loop. The pm_pr_dbg() is placed on very useful functions and it helps me to debug it, but the current all or nothing enabling mechanism with pm_debug_messages_on flag is causing the suspending mechanism to be disturbed with so many debug messages to the point it becomes extremely difficult to reproduce the issue I'm debugging. More granularity when enabling pm_pr_dbg() in this case is very welcome.

These patches I'm sending introduce dynamic debug support to pm_pr_dbg() while still maintaining the pm_debug_messages_on flag behavior if dynamic debug is not used.

Regards, David

---
David Cohen (2):
PM: narrow down -DDEBUG on kernel/power/ files
PM: enable dynamic debug support within pm_pr_dbg()

 include/linux/suspend.h | 44 ++++++++++++++++++++++++++++++++++++-----
 kernel/power/Makefile   |  6 +++++-
 kernel/power/main.c     | 29 ---------------------------
 kernel/power/process.c  |  3 ---
 4 files changed, 44 insertions(+), 38 deletions(-)

--
2.35.1

#1 lore raw

PATCH v3 1/2 PM: narrow down -DDEBUG on kernel/power/ files

The macro -DDEBUG is broadly enabled on kernel/power/ directory if CONFIG_DYNAMIC_DEBUG is enabled. As side effect all debug messages using pr_debug() and dev_dbg() are enabled by default on dynamic debug. We're reworking pm_pr_dbg() to support dynamic debug, where pm_pr_dbg() will print message if either pm_debug_messages_on flag is set or if it's explicitly enabled on dynamic debug's control. That means if we let -DDEBUG broadly set, the pm_debug_messages_on flag will be bypassed by default on pm_pr_dbg() if dynamic debug is also enabled.

The files that directly use pr_debug() and dev_dbg() on kernel/power/ are:
- swap.c
- snapshot.c
- energy_model.c

And those files do not use pm_pr_dbg(). So if we limit -DDEBUG to them, we keep the same functional behavior while allowing the pm_pr_dbg() refactor.

---
 kernel/power/Makefile  | 6 +++++-
 kernel/power/process.c | 3 ---
 2 files changed, 5 insertions(+), 4 deletions(-)
kernel/power/Makefile +5 -1
index 5899260a8bef..874ad834dc8d 100644
@@ -1,6 +1,10 @@
 # SPDX-License-Identifier: GPL-2.0
 
-ccflags-$(CONFIG_PM_DEBUG)	:= -DDEBUG
+ifeq ($(CONFIG_DYNAMIC_DEBUG), y)
+CFLAGS_swap.o                   := -DDEBUG
+CFLAGS_snapshot.o               := -DDEBUG
+CFLAGS_energy_model.o           := -DDEBUG
+endif
 
 KASAN_SANITIZE_snapshot.o	:= n
 
kernel/power/process.c +0 -3
index 11b570fcf049..3068601e585a 100644
@@ -6,9 +6,6 @@
  * Originally from swsusp.
  */
 
-
-#undef DEBUG
-
 #include <linux/interrupt.h>
 #include <linux/oom.h>
 #include <linux/suspend.h>

--
2.35.1

#2 lore raw

PATCH v3 2/2 PM: enable dynamic debug support within pm_pr_dbg()

In reply to David Cohen

Currently pm_pr_dbg() is used to filter kernel pm debug messages based on pm_debug_messages_on flag. The problem is if we enable/disable this flag it will affect all pm_pr_dbg() calls at once, so we can't individually control them.

This patch changes pm_pr_dbg() implementation as such:
- If pm_debug_messages_on is enabled, print the message.
- If pm_debug_messages_on is disabled and CONFIG_DYNAMIC_DEBUG is enabled, only print the messages explicitly enabled on /sys/kernel/debug/dynamic_debug/control.
- If pm_debug_messages_on is disabled and CONFIG_DYNAMIC_DEBUG is disabled, don't print the message.

---
 include/linux/suspend.h | 44 ++++++++++++++++++++++++++++++++++++-----
 kernel/power/main.c     | 29 ---------------------------
 2 files changed, 39 insertions(+), 34 deletions(-)
include/linux/suspend.h +39 -5
index 300273ff40cc..70f2921e2e70 100644
@@ -542,22 +542,56 @@ static inline void unlock_system_sleep(void) {}
 #ifdef CONFIG_PM_SLEEP_DEBUG
 extern bool pm_print_times_enabled;
 extern bool pm_debug_messages_on;
-extern __printf(2, 3) void __pm_pr_dbg(bool defer, const char *fmt, ...);
+static inline int pm_dyn_debug_messages_on(void)
+{
+#ifdef CONFIG_DYNAMIC_DEBUG
+	return 1;
+#else
+	return 0;
+#endif
+}
+#ifndef pr_fmt
+#define pr_fmt(fmt) "PM: " fmt
+#endif
+#define __pm_pr_dbg(fmt, ...)					\
+	do {							\
+		if (pm_debug_messages_on)			\
+			printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__);	\
+		else if (pm_dyn_debug_messages_on())		\
+			pr_debug(fmt, ##__VA_ARGS__);	\
+	} while (0)
+#define __pm_deferred_pr_dbg(fmt, ...)				\
+	do {							\
+		if (pm_debug_messages_on)			\
+			printk_deferred(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__);	\
+	} while (0)
 #else
 #define pm_print_times_enabled	(false)
 #define pm_debug_messages_on	(false)
 
 #include <linux/printk.h>
 
-#define __pm_pr_dbg(defer, fmt, ...) \
-	no_printk(KERN_DEBUG fmt, ##__VA_ARGS__)
+#define __pm_pr_dbg(fmt, ...) \
+	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
+#define __pm_deferred_pr_dbg(fmt, ...) \
+	no_printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
 #endif
 
+/**
+ * pm_pr_dbg - print pm sleep debug messages
+ *
+ * If pm_debug_messages_on is enabled, print message.
+ * If pm_debug_messages_on is disabled and CONFIG_DYNAMIC_DEBUG is enabled,
+ *	print message only from instances explicitly enabled on dynamic debug's
+ *	control.
+ * If pm_debug_messages_on is disabled and CONFIG_DYNAMIC_DEBUG is disabled,
+ *	don't print message.
+ */
 #define pm_pr_dbg(fmt, ...) \
-	__pm_pr_dbg(false, fmt, ##__VA_ARGS__)
+	__pm_pr_dbg(fmt, ##__VA_ARGS__)
 
 #define pm_deferred_pr_dbg(fmt, ...) \
-	__pm_pr_dbg(true, fmt, ##__VA_ARGS__)
+	__pm_deferred_pr_dbg(fmt, ##__VA_ARGS__)
 
 #ifdef CONFIG_PM_AUTOSLEEP
 
kernel/power/main.c +0 -29
index 7e646079fbeb..5242bf2ee469 100644
@@ -545,35 +545,6 @@ static int __init pm_debug_messages_setup(char *str)
 }
 __setup("pm_debug_messages", pm_debug_messages_setup);
 
-/**
- * __pm_pr_dbg - Print a suspend debug message to the kernel log.
- * @defer: Whether or not to use printk_deferred() to print the message.
- * @fmt: Message format.
- *
- * The message will be emitted if enabled through the pm_debug_messages
- * sysfs attribute.
- */
-void __pm_pr_dbg(bool defer, const char *fmt, ...)
-{
-	struct va_format vaf;
-	va_list args;
-
-	if (!pm_debug_messages_on)
-		return;
-
-	va_start(args, fmt);
-
-	vaf.fmt = fmt;
-	vaf.va = &args;
-
-	if (defer)
-		printk_deferred(KERN_DEBUG "PM: %pV", &vaf);
-	else
-		printk(KERN_DEBUG "PM: %pV", &vaf);
-
-	va_end(args);
-}
-
 #else /* !CONFIG_PM_SLEEP_DEBUG */
 static inline void pm_print_times_init(void) {}
 #endif /* CONFIG_PM_SLEEP_DEBUG */

--
2.35.1

#3 lore raw
In reply to David Cohen
Quoted 16 lines · David Cohen

Hi,

I am currently debugging an issue with s2idle on my laptop where in a rare occasion instead of sleeping, it gets stuck in an infinite loop. The pm_pr_dbg() is placed on very useful functions and it helps me to debug it, but the current all or nothing enabling mechanism with pm_debug_messages_on flag is causing the suspending mechanism to be disturbed with so many debug messages to the point it becomes extremely difficult to reproduce the issue I'm debugging. More granularity when enabling pm_pr_dbg() in this case is very welcome.

These patches I'm sending introduce dynamic debug support to pm_pr_dbg() while still maintaining the pm_debug_messages_on flag behavior if dynamic debug is not used.

Quoted 6 lines

Regards, David

---
David Cohen (2):
PM: narrow down -DDEBUG on kernel/power/ files
PM: enable dynamic debug support within pm_pr_dbg()

Both patches applied as 5.19 material, thanks!