ASoC: cs35l56: Fix race between kexec and snd_soc_register_component()
Subsystems (3)
Richard Fitzgerald
maintainerPATCH 1/1 ASoC: cs35l56: Fix race between kexec and snd_soc_register_component()
Use a reboot notifier and a mutex to prevent snd_soc_register_component() from racing with a kexec reboot. This prevents snd_soc_register_component() from manipulating device lists while device_shutdown() is walking them.
Commit 1d80a4792f1de ("ASoC: cs35l56: Fix probe deadlock waiting for SoundWire enumeration") moved snd_soc_register_component() out of probe() into a workqueue item. See the description in that commit for a detailed explanation.
That change introduces a race between snd_soc_register_component() and kexec. The reboot notifier and mutex prevent the shutdown race.
There is one remaining race with KEXEC_JUMP because it does not invoke reboot notifiers or freeze freezable workqueues. But KEXEC_JUMP is rarely used and is supported on only two architectures (x86 and SuperH). It does not appear to be enabled by default in any distro. It is also unlikely there will be a KEXEC_JUMP before snd_soc_register_component() has had the opportunity to execute. Fixing this can be deferred to a future patch.
--- sound/soc/codecs/cs35l56.c | 45 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+)
sound/soc/codecs/cs35l56.c +45 -0
@@ -18,9 +18,11 @@#include <linux/interrupt.h> #include <linux/math.h> #include <linux/module.h> +#include <linux/mutex.h> #include <linux/pm.h> #include <linux/pm_runtime.h> #include <linux/property.h> +#include <linux/reboot.h> #include <linux/regmap.h> #include <linux/regulator/consumer.h> #include <linux/slab.h>
@@ -37,6 +39,13 @@#include "wm_adsp.h" #include "cs35l56.h" +/* +* snd_soc_register_component() can call component_probe() on all instances +* in a card, so deferred registration must be protected across all instances. +*/ +static DEFINE_MUTEX (cs35l56_component_register_lock); +static bool cs35l56_shutting_down; +void cs35l56_mask_soundwire_interrupts (struct cs35l56_private *cs35l56) {/*
@@ -1957,6 +1966,11 @@ static void cs35l56_component_register_work(struct work_struct *work) component_register_work);int ret; +guard (mutex)(&cs35l56_component_register_lock); + +if (cs35l56_shutting_down) +return ; +PM_RUNTIME_ACQUIRE_AUTOSUSPEND (cs35l56->base.dev, pm_err); ret =PM_RUNTIME_ACQUIRE_ERR (&pm_err);if (ret) {
@@ -2217,6 +2231,37 @@ EXPORT_NS_GPL_DEV_PM_OPS(cs35l56_pm_ops_i2c_spi, SND_SOC_CS35L56_CORE) = { };#endif +static int cs35l56_reboot_notify (struct notifier_block *nb, +unsigned long action,void *data) +{ +guard (mutex)(&cs35l56_component_register_lock); + cs35l56_shutting_down = true; + +return NOTIFY_DONE ; +} + +static struct notifier_block cs35l56_reboot_notifier = { + .notifier_call = cs35l56_reboot_notify, +}; + +static int __init cs35l56_modinit (void ) +{ +/* +* Use reboot notifier to prevent race between shutdown and +* snd_soc_register_component(). Driver shutdown() callback would +* run too late, after device_shutdown() is already walking the +* device list that component registration can modify. +*/ +return register_reboot_notifier (&cs35l56_reboot_notifier); +} +module_init (cs35l56_modinit); + +static void __exit cs35l56_modexit(void) +{ +unregister_reboot_notifier (&cs35l56_reboot_notifier); +} +module_exit (cs35l56_modexit); +MODULE_DESCRIPTION ("ASoC CS35L56 driver" );MODULE_IMPORT_NS ("SND_SOC_CS35L56_SHARED" );MODULE_IMPORT_NS ("SND_SOC_CS_AMP_LIB" );
Signature · 1 line
2.47.3
Mark Brown
maintainerQuoted 1 line · Richard Fitzgerald
ASoC: cs35l56: Fix race between kexec and
snd_soc_register_component()
Applied to
https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-7.3
Thanks!
[1/1] ASoC: cs35l56: Fix race between kexec and snd_soc_register_component()
https://git.kernel.org/broonie/sound/c/883e78c9e600
All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.
You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.
If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.
Please add any relevant lists and maintainers to the CCs when replying to this mail.
Thanks,
Mark