PM: Fix symbol export for _SIMPLE_ variants of _PM_OPS()

PATCH Applied Raag Jadav 3 participants 3 messages Sep 22, 2023 – Sep 26, 2023

Subsystems (3)

Suspend to RAM Hibernation Power management core

lore

Share & tools

lore

Raag Jadav

author

2023-09-22 05:47 UTC #0 lore raw

PATCH v4 1/1 PM: Fix symbol export for _SIMPLE_ variants of _PM_OPS()

Currently EXPORT_*_SIMPLE_DEV_PM_OPS() use EXPORT_*_DEV_PM_OPS() set of macros to export dev_pm_ops symbol, which export the symbol in case CONFIG_PM=y but don't take CONFIG_PM_SLEEP into consideration.

Since _SIMPLE_ variants of _PM_OPS() do not include runtime PM handles and are only used in case CONFIG_PM_SLEEP=y, we should not be exporting dev_pm_ops symbol for them in case CONFIG_PM_SLEEP=n.

This can be fixed by having two distinct set of export macros for both _RUNTIME_ and _SIMPLE_ variants of _PM_OPS(), such that the export of dev_pm_ops symbol used in each variant depends on CONFIG_PM and CONFIG_PM_SLEEP respectively.

Introduce _DEV_SLEEP_PM_OPS() set of export macros for _SIMPLE_ variants of _PM_OPS(), which export dev_pm_ops symbol only in case CONFIG_PM_SLEEP=y and discard it otherwise.

Fixes 34e1ed189fab ("PM: Improve EXPORT_*_DEV_PM_OPS macros")

Signed-off-by Raag Jadav <[email protected]>

---
PS: This is a standalone fix and works without updating existing drivers.

Changes since v3:
- Rename _PM_OPS macro to _DISCARD_PM_OPS

Changes since v2:
- Drop redundant patches

Changes since v1:
- Update drivers to new set of macros

 include/linux/pm.h | 43 +++++++++++++++++++++++++++++--------------
 1 file changed, 29 insertions(+), 14 deletions(-)

include/linux/pm.h +29 ~~-14~~

index 1400c37b29c7..629c1633bbd0 100644
@@ -374,24 +374,39 @@ const struct dev_pm_ops name = { \
 	RUNTIME_PM_OPS(runtime_suspend_fn, runtime_resume_fn, idle_fn) \
 }
 
-#ifdef CONFIG_PM
-#define _EXPORT_DEV_PM_OPS(name, license, ns)				\
+#define _EXPORT_PM_OPS(name, license, ns)				\
 	const struct dev_pm_ops name;					\
 	__EXPORT_SYMBOL(name, license, ns);				\
 	const struct dev_pm_ops name
-#define EXPORT_PM_FN_GPL(name)		EXPORT_SYMBOL_GPL(name)
-#define EXPORT_PM_FN_NS_GPL(name, ns)	EXPORT_SYMBOL_NS_GPL(name, ns)
-#else
-#define _EXPORT_DEV_PM_OPS(name, license, ns)				\
+
+#define _DISCARD_PM_OPS(name, license, ns)				\
 	static __maybe_unused const struct dev_pm_ops __static_##name
+
+#ifdef CONFIG_PM
+#define _EXPORT_DEV_PM_OPS(name, license, ns)		_EXPORT_PM_OPS(name, license, ns)
+#define EXPORT_PM_FN_GPL(name)				EXPORT_SYMBOL_GPL(name)
+#define EXPORT_PM_FN_NS_GPL(name, ns)			EXPORT_SYMBOL_NS_GPL(name, ns)
+#else
+#define _EXPORT_DEV_PM_OPS(name, license, ns)		_DISCARD_PM_OPS(name, license, ns)
 #define EXPORT_PM_FN_GPL(name)
 #define EXPORT_PM_FN_NS_GPL(name, ns)
 #endif
 
-#define EXPORT_DEV_PM_OPS(name) _EXPORT_DEV_PM_OPS(name, "", "")
-#define EXPORT_GPL_DEV_PM_OPS(name) _EXPORT_DEV_PM_OPS(name, "GPL", "")
-#define EXPORT_NS_DEV_PM_OPS(name, ns) _EXPORT_DEV_PM_OPS(name, "", #ns)
-#define EXPORT_NS_GPL_DEV_PM_OPS(name, ns) _EXPORT_DEV_PM_OPS(name, "GPL", #ns)
+#ifdef CONFIG_PM_SLEEP
+#define _EXPORT_DEV_SLEEP_PM_OPS(name, license, ns)	_EXPORT_PM_OPS(name, license, ns)
+#else
+#define _EXPORT_DEV_SLEEP_PM_OPS(name, license, ns)	_DISCARD_PM_OPS(name, license, ns)
+#endif
+
+#define EXPORT_DEV_PM_OPS(name)				_EXPORT_DEV_PM_OPS(name, "", "")
+#define EXPORT_GPL_DEV_PM_OPS(name)			_EXPORT_DEV_PM_OPS(name, "GPL", "")
+#define EXPORT_NS_DEV_PM_OPS(name, ns)			_EXPORT_DEV_PM_OPS(name, "", #ns)
+#define EXPORT_NS_GPL_DEV_PM_OPS(name, ns)		_EXPORT_DEV_PM_OPS(name, "GPL", #ns)
+
+#define EXPORT_DEV_SLEEP_PM_OPS(name)			_EXPORT_DEV_SLEEP_PM_OPS(name, "", "")
+#define EXPORT_GPL_DEV_SLEEP_PM_OPS(name)		_EXPORT_DEV_SLEEP_PM_OPS(name, "GPL", "")
+#define EXPORT_NS_DEV_SLEEP_PM_OPS(name, ns)		_EXPORT_DEV_SLEEP_PM_OPS(name, "", #ns)
+#define EXPORT_NS_GPL_DEV_SLEEP_PM_OPS(name, ns)	_EXPORT_DEV_SLEEP_PM_OPS(name, "GPL", #ns)
 
 /*
  * Use this if you want to use the same suspend and resume callbacks for suspend

@@ -404,19 +419,19 @@ const struct dev_pm_ops name = { \
 	_DEFINE_DEV_PM_OPS(name, suspend_fn, resume_fn, NULL, NULL, NULL)
 
 #define EXPORT_SIMPLE_DEV_PM_OPS(name, suspend_fn, resume_fn) \
-	EXPORT_DEV_PM_OPS(name) = { \
+	EXPORT_DEV_SLEEP_PM_OPS(name) = { \
 		SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \
 	}
 #define EXPORT_GPL_SIMPLE_DEV_PM_OPS(name, suspend_fn, resume_fn) \
-	EXPORT_GPL_DEV_PM_OPS(name) = { \
+	EXPORT_GPL_DEV_SLEEP_PM_OPS(name) = { \
 		SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \
 	}
 #define EXPORT_NS_SIMPLE_DEV_PM_OPS(name, suspend_fn, resume_fn, ns)	\
-	EXPORT_NS_DEV_PM_OPS(name, ns) = { \
+	EXPORT_NS_DEV_SLEEP_PM_OPS(name, ns) = { \
 		SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \
 	}
 #define EXPORT_NS_GPL_SIMPLE_DEV_PM_OPS(name, suspend_fn, resume_fn, ns)	\
-	EXPORT_NS_GPL_DEV_PM_OPS(name, ns) = { \
+	EXPORT_NS_GPL_DEV_SLEEP_PM_OPS(name, ns) = { \
 		SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \
 	}

Signature · 1 line

2.17.1

Paul Cercueil

Reviewed-by on v4 1/1

2023-09-25 09:01 UTC #1 lore raw

Hi,

Le vendredi 22 septembre 2023 à 11:15 +0530, Raag Jadav a écrit :

Quoted 17 lines

Currently EXPORT_*_SIMPLE_DEV_PM_OPS() use EXPORT_*_DEV_PM_OPS() set of macros to export dev_pm_ops symbol, which export the symbol in case
CONFIG_PM=y but don't take CONFIG_PM_SLEEP into consideration.
Since _SIMPLE_ variants of _PM_OPS() do not include runtime PM handles
and are only used in case CONFIG_PM_SLEEP=y, we should not be exporting
dev_pm_ops symbol for them in case CONFIG_PM_SLEEP=n.
This can be fixed by having two distinct set of export macros for both
_RUNTIME_ and _SIMPLE_ variants of _PM_OPS(), such that the export of dev_pm_ops symbol used in each variant depends on CONFIG_PM and CONFIG_PM_SLEEP respectively.

Quoted 8 lines

Introduce _DEV_SLEEP_PM_OPS() set of export macros for _SIMPLE_ variants
of _PM_OPS(), which export dev_pm_ops symbol only in case CONFIG_PM_SLEEP=y
and discard it otherwise.
Fixes 34e1ed189fab ("PM: Improve EXPORT_*_DEV_PM_OPS macros")
Signed-off-by Raag Jadav <[email protected]>

Reviewed-by Paul Cercueil <[email protected]>

Cheers,
-Paul

Quoted 128 lines

---
PS: This is a standalone fix and works without updating existing drivers.
Changes since v3:
- Rename _PM_OPS macro to _DISCARD_PM_OPS
Changes since v2:
- Drop redundant patches
Changes since v1:
- Update drivers to new set of macros
include/linux/pm.h | 43 +++++++++++++++++++++++++++++--------------
 1 file changed, 29 insertions(+), 14 deletions(-)
include/linux/pm.h +0 -0
index 1400c37b29c7..629c1633bbd0 100644
@@ -374,24 +374,39 @@ const struct dev_pm_ops name = { \
         RUNTIME_PM_OPS(runtime_suspend_fn, runtime_resume_fn,
 idle_fn) \
  }
include/linux/pm.h +0 -2
-#ifdef CONFIG_PM
-#define _EXPORT_DEV_PM_OPS(name, license,
ns)                          \
+#define _EXPORT_PM_OPS(name, license,
ns)                              \
        const struct dev_pm_ops
name;                                   \
        __EXPORT_SYMBOL(name, license,
ns);                             \
        const struct dev_pm_ops name
include/linux/pm.h +0 -2
-#define EXPORT_PM_FN_GPL(name)         EXPORT_SYMBOL_GPL(name)
-#define EXPORT_PM_FN_NS_GPL(name, ns)  EXPORT_SYMBOL_NS_GPL(name,
ns)
include/linux/pm.h +0 -2
-#else
-#define _EXPORT_DEV_PM_OPS(name, license,
ns) \
include/linux/pm.h +2 -0
+
+#define _DISCARD_PM_OPS(name, license,
ns) \
static __maybe_unused const struct dev_pm_ops __static_##name
include/linux/pm.h +3 -0
+
+#ifdef CONFIG_PM
+#define _EXPORT_DEV_PM_OPS(name, license,
ns)          _EXPORT_PM_OPS(name, license, ns)
+#define
EXPORT_PM_FN_GPL(name)                         EXPORT_SYMBOL_GPL(name )
+#define EXPORT_PM_FN_NS_GPL(name,
ns)                  EXPORT_SYMBOL_NS_GPL(name, ns)
include/linux/pm.h +2 -0
+#else
+#define _EXPORT_DEV_PM_OPS(name, license,
ns) _DISCARD_PM_OPS(name, license, ns)
#define EXPORT_PM_FN_GPL(name)
#define EXPORT_PM_FN_NS_GPL(name, ns)
#endif
include/linux/pm.h +0 -2
-#define EXPORT_DEV_PM_OPS(name) _EXPORT_DEV_PM_OPS(name, "", "")
-#define EXPORT_GPL_DEV_PM_OPS(name) _EXPORT_DEV_PM_OPS(name, "GPL",
"")
-#define EXPORT_NS_DEV_PM_OPS(name, ns) _EXPORT_DEV_PM_OPS(name, "", #ns)
-#define EXPORT_NS_GPL_DEV_PM_OPS(name, ns) _EXPORT_DEV_PM_OPS(name, "GPL", #ns)
include/linux/pm.h +2 -0
+#ifdef CONFIG_PM_SLEEP
+#define _EXPORT_DEV_SLEEP_PM_OPS(name, license,
ns) _EXPORT_PM_OPS(name, license, ns)
include/linux/pm.h +2 -0
+#else
+#define _EXPORT_DEV_SLEEP_PM_OPS(name, license,
ns) _DISCARD_PM_OPS(name, license, ns)
include/linux/pm.h +3 -0
+#endif
+
+#define
EXPORT_DEV_PM_OPS(name)                                _EXPORT_DEV_PM _OPS(name, "", "")
+#define
EXPORT_GPL_DEV_PM_OPS(name)                    _EXPORT_DEV_PM_OPS(nam e, "GPL", "")
+#define EXPORT_NS_DEV_PM_OPS(name,
ns)                 _EXPORT_DEV_PM_OPS(name, "", #ns) +#define EXPORT_NS_GPL_DEV_PM_OPS(name,
ns)             _EXPORT_DEV_PM_OPS(name, "GPL", #ns)
include/linux/pm.h +2 -0
+
+#define
EXPORT_DEV_SLEEP_PM_OPS(name)                  _EXPORT_DEV_SLEEP_PM_O PS(name, "", "")
+#define
EXPORT_GPL_DEV_SLEEP_PM_OPS(name)              _EXPORT_DEV_SLEEP_PM_O PS(name, "GPL", "")
+#define EXPORT_NS_DEV_SLEEP_PM_OPS(name,
ns)           _EXPORT_DEV_SLEEP_PM_OPS(name, "", #ns) +#define EXPORT_NS_GPL_DEV_SLEEP_PM_OPS(name,
ns)       _EXPORT_DEV_SLEEP_PM_OPS(name, "GPL", #ns)

/*
* Use this if you want to use the same suspend and resume callbacks for suspend
include/linux/pm.h +0 -0
@@ -404,19 +419,19 @@ const struct dev_pm_ops name = { \
         _DEFINE_DEV_PM_OPS(name, suspend_fn, resume_fn, NULL, NULL,
 NULL)
#define EXPORT_SIMPLE_DEV_PM_OPS(name, suspend_fn, resume_fn) \
-       EXPORT_DEV_PM_OPS(name) = { \
+       EXPORT_DEV_SLEEP_PM_OPS(name) = { \
                SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \
        }
#define EXPORT_GPL_SIMPLE_DEV_PM_OPS(name, suspend_fn, resume_fn) \
-       EXPORT_GPL_DEV_PM_OPS(name) = { \
+       EXPORT_GPL_DEV_SLEEP_PM_OPS(name) = { \
                SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \
        }
#define EXPORT_NS_SIMPLE_DEV_PM_OPS(name, suspend_fn, resume_fn, ns)   \
-       EXPORT_NS_DEV_PM_OPS(name, ns) = { \
+       EXPORT_NS_DEV_SLEEP_PM_OPS(name, ns) = { \
                SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \
        }
#define EXPORT_NS_GPL_SIMPLE_DEV_PM_OPS(name, suspend_fn, resume_fn, ns)       \
-       EXPORT_NS_GPL_DEV_PM_OPS(name, ns) = { \
+       EXPORT_NS_GPL_DEV_SLEEP_PM_OPS(name, ns) = { \
                SYSTEM_SLEEP_PM_OPS(suspend_fn, resume_fn) \
        }

Rafael J. Wysocki

maintainer Applied

2023-09-26 16:42 UTC #2 lore raw

Quoted 27 lines · Paul Cercueil

Hi,
Quoted 23 lines · Raag Jadav
Currently EXPORT_*_SIMPLE_DEV_PM_OPS() use EXPORT_*_DEV_PM_OPS() set of macros to export dev_pm_ops symbol, which export the symbol in case
CONFIG_PM=y but don't take CONFIG_PM_SLEEP into consideration.
Since _SIMPLE_ variants of _PM_OPS() do not include runtime PM handles
and are only used in case CONFIG_PM_SLEEP=y, we should not be exporting
dev_pm_ops symbol for them in case CONFIG_PM_SLEEP=n.
This can be fixed by having two distinct set of export macros for both
_RUNTIME_ and _SIMPLE_ variants of _PM_OPS(), such that the export of dev_pm_ops symbol used in each variant depends on CONFIG_PM and CONFIG_PM_SLEEP respectively.
Introduce _DEV_SLEEP_PM_OPS() set of export macros for _SIMPLE_ variants
of _PM_OPS(), which export dev_pm_ops symbol only in case CONFIG_PM_SLEEP=y
and discard it otherwise.

Quoted 4 lines

Quoted 2 lines
Fixes 34e1ed189fab ("PM: Improve EXPORT_*_DEV_PM_OPS macros")
Signed-off-by Raag Jadav <[email protected]>
Reviewed-by Paul Cercueil <[email protected]>

Applied as 6.7 material, thanks!