Skip to contentSkip to conversation

suspend/resume debugging: device filter

PATCH In review Ingo Molnar 6 participants 9 messages Jan 25, 2007 – May 8, 2007

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

PATCH 1/1 suspend/resume debugging: device filter

Subject: [patch] suspend/resume debugging: device filter
From: Ingo Molnar <[email protected]>

this patch implements the /sys/power/filter attribute, which takes a string. If a device's name matches the filter string (exactly), then that device is excluded from suspend/resume.

this can be helpful in a number of ways when debugging suspend and resume problems:

- if CONFIG_DISABLE_CONSOLE_SUSPEND is used then the serial console is still suspended after which point there's no log output. Doing "echo serial > /sys/power/filter" keeps the serial port active, so any messages (and crash info) after that point is displayed.

- if a device is suspected to be the reason of resume failure then it can be excluded via the filter. That device obviously wont work, but users can thus help us debug resume problems in combination with pm_trace, without having to hack the kernel.

(note that you can obvious break suspend/resume via the filter, by excluding a vital device - so it is only to be used when suspend or resume is broken to begin with.)

it might be better to do this centrally in sysfs, via a per-device attribute, to individually enable suspend and resume on a per device basis, but my sysfs-fu is not strong enough for that now ;-)

---
 drivers/base/power/resume.c  |    6 ++++
 drivers/base/power/suspend.c |    3 +-
 include/linux/resume-trace.h |    6 ++++
 kernel/power/main.c          |   58 +++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 72 insertions(+), 1 deletion(-)
drivers/base/power/resume.c +6 -0
Index: linux/drivers/base/power/resume.c
===================================================================
@@ -24,6 +24,9 @@ int resume_device(struct device * dev)
 {
 	int error = 0;
 
+	if (power_filter(dev))
+		return 0;
+
 	TRACE_DEVICE(dev);
 	TRACE_RESUME(0);
 	down(&dev->sem);
@@ -52,6 +55,9 @@ static int resume_device_early(struct de
 {
 	int error = 0;
 
+	if (power_filter(dev))
+		return 0;
+
 	TRACE_DEVICE(dev);
 	TRACE_RESUME(0);
 	if (dev->bus && dev->bus->resume_early) {
drivers/base/power/suspend.c +2 -1
Index: linux/drivers/base/power/suspend.c
===================================================================
@@ -10,6 +10,7 @@
 
 #include <linux/device.h>
 #include <linux/kallsyms.h>
+#include <linux/resume-trace.h>
 #include <linux/pm.h>
 #include "../base.h"
 #include "power.h"
@@ -78,7 +79,7 @@ int suspend_device(struct device * dev, 
 		suspend_report_result(dev->class->suspend, error);
 	}
 
-	if (!error && dev->bus && dev->bus->suspend && !dev->power.power_state.event) {
+	if (!error && dev->bus && dev->bus->suspend && !dev->power.power_state.event && !power_filter(dev)) {
 		dev_dbg(dev, "%s%s\n",
 			suspend_verb(state.event),
 			((state.event == PM_EVENT_SUSPEND)
include/linux/resume-trace.h +6 -0
Index: linux/include/linux/resume-trace.h
===================================================================
@@ -9,6 +9,8 @@ struct device;
 extern void set_trace_device(struct device *);
 extern void generate_resume_trace(void *tracedata, unsigned int user);
 
+extern int power_filter(struct device *dev);
+
 #define TRACE_DEVICE(dev) set_trace_device(dev)
 #define TRACE_RESUME(user) do {					\
 	if (pm_trace_enabled) {					\
@@ -28,6 +30,10 @@ extern void generate_resume_trace(void *
 
 #define TRACE_DEVICE(dev) do { } while (0)
 #define TRACE_RESUME(dev) do { } while (0)
+static inline int power_filter(struct device *dev)
+{
+	return 0;
+}
 
 #endif
 
kernel/power/main.c +58 -0

73 lines not on this page · raw message

#1 lore raw

Hi.

Quoted 3 lines · Ingo Molnar

it might be better to do this centrally in sysfs, via a per-device attribute, to individually enable suspend and resume on a per device basis, but my sysfs-fu is not strong enough for that now ;-)

Yeah. I was thinking recently of doing a per-device attribute, but like so many things at the moment, getting around to it is a little bit of a problem.

Quoted 6 lines
---
 drivers/base/power/resume.c  |    6 ++++
 drivers/base/power/suspend.c |    3 +-
 include/linux/resume-trace.h |    6 ++++
 kernel/power/main.c          |   58 +++++++++++++++++++++++++++++++++++++++++++

Should the sysfs stuff (not just this) be in kernel/power/main.c? I wonder if it would be better put in drivers/base?

Regards,

Nigel

#2 lore raw
In reply to Ingo Molnar

Hi!

Quoted 16 lines

Subject: [patch] suspend/resume debugging: device filter
From: Ingo Molnar <[email protected]>

this patch implements the /sys/power/filter attribute, which takes a string. If a device's name matches the filter string (exactly), then that device is excluded from suspend/resume.

this can be helpful in a number of ways when debugging suspend and resume problems:

- if CONFIG_DISABLE_CONSOLE_SUSPEND is used then the serial console is still suspended after which point there's no log output. Doing "echo serial > /sys/power/filter" keeps the serial port active, so any messages (and crash info) after that point is displayed.

Quoted 8 lines

- if a device is suspected to be the reason of resume failure then it can be excluded via the filter. That device obviously wont work, but users can thus help us debug resume problems in combination with pm_trace, without having to hack the kernel.

(note that you can obvious break suspend/resume via the filter, by excluding a vital device - so it is only to be used when suspend or resume is broken to begin with.)

Should this go to Documentation/power?

Quoted 3 lines

it might be better to do this centrally in sysfs, via a per-device attribute, to individually enable suspend and resume on a per device basis, but my sysfs-fu is not strong enough for that now ;-)

Yep, I think it should go to per-device attribute. Also it would be nice to name it somehow like debug_suspend_filter or something, so that people have less tendency to play with it.
Pavel

Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#3 lore raw
In reply to Ingo Molnar
Quoted 21 lines · Ingo Molnar

Subject: [patch] suspend/resume debugging: device filter
From: Ingo Molnar <[email protected]>

this patch implements the /sys/power/filter attribute, which takes a string. If a device's name matches the filter string (exactly), then that device is excluded from suspend/resume.

this can be helpful in a number of ways when debugging suspend and resume problems:

- if CONFIG_DISABLE_CONSOLE_SUSPEND is used then the serial console is still suspended after which point there's no log output. Doing "echo serial > /sys/power/filter" keeps the serial port active, so any messages (and crash info) after that point is displayed.

- if a device is suspected to be the reason of resume failure then it can be excluded via the filter. That device obviously wont work, but users can thus help us debug resume problems in combination with pm_trace, without having to hack the kernel.

Quoted 7 lines

(note that you can obvious break suspend/resume via the filter, by excluding a vital device - so it is only to be used when suspend or resume is broken to begin with.)

it might be better to do this centrally in sysfs, via a per-device attribute, to individually enable suspend and resume on a per device basis, but my sysfs-fu is not strong enough for that now ;-)

Here's a (compile tested only) patch that does this on a per-device basis, which is smaller, and should work just as well as your patch.

It creates a new file in the power/ directory for every device called "can_suspend". Write a '0' to it to prevent that device from being suspended.

Does this work for you?

Yeah, the wording of the filename and variable isn't the best, I'm open to better choices if anyone has them.

thanks,

greg k-h

---
 drivers/base/power/suspend.c |    2 +-
 drivers/base/power/sysfs.c   |   30 ++++++++++++++++++++++++++++++
 include/linux/device.h       |    1 +
 3 files changed, 32 insertions(+), 1 deletion(-)
drivers/base/power/suspend.c +1 -1
@@ -78,7 +78,7 @@ int suspend_device(struct device * dev, 
 		suspend_report_result(dev->class->suspend, error);
 	}
 
-	if (!error && dev->bus && dev->bus->suspend && !dev->power.power_state.event) {
+	if (!error && !dev->no_suspend && dev->bus && dev->bus->suspend && !dev->power.power_state.event) {
 		dev_dbg(dev, "%s%s\n",
 			suspend_verb(state.event),
 			((state.event == PM_EVENT_SUSPEND)
drivers/base/power/sysfs.c +30 -0
@@ -141,12 +141,42 @@ wake_store(struct device * dev, struct d
 
 static DEVICE_ATTR(wakeup, 0644, wake_show, wake_store);
 
+static ssize_t can_suspend_show(struct device *dev,
+				struct device_attribute *attr, char *buf)
+{
+	return sprintf(buf, "%s\n", dev->no_suspend ? "no" : "yes");
+}
+
+static ssize_t can_suspend_store(struct device *dev,
+				 struct device_attribute *attr,
+				 const char *buf, size_t n)
+{
+	if (!n)
+		return -EINVAL;
+
+	switch (buf[0]) {
+	case 'y':
+	case 'Y':
+	case '1':
+		dev->no_suspend = 0;
+		break;
+	case 'n':
+	case 'N':
+	case '0':
+		dev->no_suspend = 1;
+		break;
+	}
+
+	return n;
+}
+static DEVICE_ATTR(can_suspend, 0644, can_suspend_show, can_suspend_store);
 
 static struct attribute * power_attrs[] = {
 #ifdef	CONFIG_PM_SYSFS_DEPRECATED
 	&dev_attr_state.attr,
 #endif
 	&dev_attr_wakeup.attr,
+	&dev_attr_can_suspend.attr,
 	NULL,
 };
 static struct attribute_group pm_attr_group = {
include/linux/device.h +1 -0
@@ -365,6 +365,7 @@ struct device {
 	char	bus_id[BUS_ID_SIZE];	/* position on parent bus */
 	struct device_type	*type;
 	unsigned		is_registered:1;
+	unsigned		no_suspend:1;
 	struct device_attribute uevent_attr;
 	struct device_attribute *devt_attr;
 
#4 lore raw

Hi!

Quoted 10 lines
Quoted 3 lines

it might be better to do this centrally in sysfs, via a per-device attribute, to individually enable suspend and resume on a per device basis, but my sysfs-fu is not strong enough for that now ;-)

Here's a (compile tested only) patch that does this on a per-device basis, which is smaller, and should work just as well as your patch.

It creates a new file in the power/ directory for every device called "can_suspend". Write a '0' to it to prevent that device from being suspended.

Maybe we could just introduce debug_flags?

Quoted 8 lines
drivers/base/power/sysfs.c +8 -0
+static ssize_t can_suspend_store(struct device *dev,
+				 struct device_attribute *attr,
+				 const char *buf, size_t n)
+{
+	if (!n)
+		return -EINVAL;
+
+	switch (buf[0]) {

drivers/base/power/sysfs.c wake_store(struct device * dev, struct d · line 167

Quoted 10 lines
drivers/base/power/sysfs.c +10 -0
+	case 'y':
+	case 'Y':
+	case '1':
+		dev->no_suspend = 0;
+		break;
+	case 'n':
+	case 'N':
+	case '0':
+		dev->no_suspend = 1;
+		break;

default: return -EINVAL ?

Pavel

Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#5 lore raw
In reply to Greg KH
Quoted 8 lines · Greg KH

Here's a (compile tested only) patch that does this on a per-device basis, which is smaller, and should work just as well as your patch.

It creates a new file in the power/ directory for every device called "can_suspend". Write a '0' to it to prevent that device from being suspended.

Does this work for you?

yeah, i was able to use this too to debug suspend/resume problems. But i've added the check to the resume path too - for example sw-suspend does a resume of devices during its suspend cycle, cutting off much of the netconsole output.

which makes the can_suspend flag mis-named - perhaps rename it to exclude_pm ?

updated patch below, against v2.6.21. Could we get this into v2.6.22 please? It's a real time-saver.

Ingo

---
 drivers/base/power/resume.c  |    6 ++++++
 drivers/base/power/suspend.c |    2 +-
 drivers/base/power/sysfs.c   |   30 ++++++++++++++++++++++++++++++
 include/linux/device.h       |    1 +
 4 files changed, 38 insertions(+), 1 deletion(-)
drivers/base/power/resume.c +6 -0
Index: linux/drivers/base/power/resume.c
===================================================================
@@ -24,6 +24,9 @@ int resume_device(struct device * dev)
 {
 	int error = 0;
 
+	if (dev->no_suspend)
+		return 0;
+
 	TRACE_DEVICE(dev);
 	TRACE_RESUME(0);
 	down(&dev->sem);
@@ -52,6 +55,9 @@ static int resume_device_early(struct de
 {
 	int error = 0;
 
+	if (dev->no_suspend)
+		return 0;
+
 	TRACE_DEVICE(dev);
 	TRACE_RESUME(0);
 	if (dev->bus && dev->bus->resume_early) {
drivers/base/power/suspend.c +1 -1
Index: linux/drivers/base/power/suspend.c
===================================================================
@@ -78,7 +78,7 @@ int suspend_device(struct device * dev, 
 		suspend_report_result(dev->class->suspend, error);
 	}
 
-	if (!error && dev->bus && dev->bus->suspend && !dev->power.power_state.event) {
+	if (!error && !dev->no_suspend && dev->bus && dev->bus->suspend && !dev->power.power_state.event) {
 		dev_dbg(dev, "%s%s\n",
 			suspend_verb(state.event),
 			((state.event == PM_EVENT_SUSPEND)
drivers/base/power/sysfs.c +30 -0
Index: linux/drivers/base/power/sysfs.c
===================================================================
@@ -141,12 +141,42 @@ wake_store(struct device * dev, struct d
 
 static DEVICE_ATTR(wakeup, 0644, wake_show, wake_store);
 
+static ssize_t can_suspend_show(struct device *dev,
+				struct device_attribute *attr, char *buf)
+{
+	return sprintf(buf, "%s\n", dev->no_suspend ? "no" : "yes");
+}
+
+static ssize_t can_suspend_store(struct device *dev,
+				 struct device_attribute *attr,
+				 const char *buf, size_t n)
+{
+	if (!n)
+		return -EINVAL;
+
+	switch (buf[0]) {
+	case 'y':
+	case 'Y':
+	case '1':
+		dev->no_suspend = 0;
+		break;
+	case 'n':
+	case 'N':
+	case '0':
+		dev->no_suspend = 1;
+		break;
+	}
+
+	return n;
+}
+static DEVICE_ATTR(can_suspend, 0644, can_suspend_show, can_suspend_store);
 
 static struct attribute * power_attrs[] = {
 #ifdef	CONFIG_PM_SYSFS_DEPRECATED
 	&dev_attr_state.attr,
 #endif
 	&dev_attr_wakeup.attr,
+	&dev_attr_can_suspend.attr,
 	NULL,
 };
 static struct attribute_group pm_attr_group = {
include/linux/device.h +1 -0
Index: linux/include/linux/device.h
===================================================================
@@ -402,6 +402,7 @@ struct device {
 	char	bus_id[BUS_ID_SIZE];	/* position on parent bus */
 	struct device_type	*type;
 	unsigned		is_registered:1;
+	unsigned		no_suspend:1;
 	struct device_attribute uevent_attr;
 	struct device_attribute *devt_attr;
 
#6 lore raw
Quoted 17 lines · Ingo Molnar
Quoted 8 lines · Greg KH

Here's a (compile tested only) patch that does this on a per-device basis, which is smaller, and should work just as well as your patch.

It creates a new file in the power/ directory for every device called "can_suspend". Write a '0' to it to prevent that device from being suspended.

Does this work for you?

yeah, i was able to use this too to debug suspend/resume problems. But i've added the check to the resume path too - for example sw-suspend does a resume of devices during its suspend cycle, cutting off much of the netconsole output.

Quoted 5 lines

which makes the can_suspend flag mis-named - perhaps rename it to exclude_pm ?

updated patch below, against v2.6.21. Could we get this into v2.6.22 please? It's a real time-saver.

ACK

Greetings,
Rafael

#7 lore raw
In reply to Ingo Molnar

Hi!

Quoted 9 lines
Quoted 8 lines

Here's a (compile tested only) patch that does this on a per-device basis, which is smaller, and should work just as well as your patch.

It creates a new file in the power/ directory for every device called "can_suspend". Write a '0' to it to prevent that device from being suspended.

Does this work for you?

Quoted 7 lines

yeah, i was able to use this too to debug suspend/resume problems. But i've added the check to the resume path too - for example sw-suspend does a resume of devices during its suspend cycle, cutting off much of the netconsole output.

which makes the can_suspend flag mis-named - perhaps rename it to exclude_pm ?

debug_exclude_pm? I do not want people playing with it, then complaining that they broke the suspend.
Pavel

Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#8 lore raw
Quoted 16 lines · Pavel Machek

Hi!

Quoted 14 lines
Quoted 8 lines

Here's a (compile tested only) patch that does this on a per-device basis, which is smaller, and should work just as well as your patch.

It creates a new file in the power/ directory for every device called "can_suspend". Write a '0' to it to prevent that device from being suspended.

Does this work for you?

yeah, i was able to use this too to debug suspend/resume problems. But i've added the check to the resume path too - for example sw-suspend does a resume of devices during its suspend cycle, cutting off much of the netconsole output.

Quoted 5 lines
Quoted 2 lines

which makes the can_suspend flag mis-named - perhaps rename it to exclude_pm ?

debug_exclude_pm? I do not want people playing with it, then complaining that they broke the suspend.

I can make the attribute only show up if CONFIG_DEBUG_DRIVER is enabled. Would that be better? We can also write to the syslog when the attribute is changed that they just might have broken something.

thanks,

greg k-h