Skip to contentSkip to conversation

PCI: Fix deadlocks when enabling ASPM

PATCH Applied Johan Hovold 7 participants 23 messages Nov 28, 2023 – Dec 14, 2023

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

v2 cover PCI: Fix deadlocks when enabling ASPM

The pci_enable_link_state() helper is currently only called from pci_walk_bus(), something which can lead to a deadlock as both helpers take a pci_bus_sem read lock.

Add a new locked helper which can be called with the read lock held and fix up the two current users (the second is new in 6.7-rc1).

Note that there are no users left of the original unlocked variant after this series, but I decided to leave it in place for now (e.g. to mirror the corresponding helpers to disable link states).

Included are also a couple of related cleanups.

Johan

Changes in v2
- fix up the function name in a kernel doc comment as reported by the kernel test robot <[email protected]>

Johan Hovold (6):
PCI/ASPM: Add locked helper for enabling link state
PCI: vmd: Fix deadlock when enabling ASPM
PCI: qcom: Fix deadlock when enabling ASPM
PCI: qcom: Clean up ASPM comment
PCI/ASPM: Clean up disable link state parameter PCI/ASPM: Add lockdep assert to link state helper

 drivers/pci/controller/dwc/pcie-qcom.c |  7 ++-
 drivers/pci/controller/vmd.c           |  2 +-
 drivers/pci/pcie/aspm.c                | 65 +++++++++++++++++++-------
 include/linux/pci.h                    |  3 ++
 4 files changed, 56 insertions(+), 21 deletions(-)
Signature · 1 line
2.41.0
#1 lore raw

PATCH v2 1/6 PCI/ASPM: Add locked helper for enabling link state

Add a helper for enabling link states that can be used in contexts where a pci_bus_sem read lock is already held (e.g. from pci_walk_bus()).

This helper will be used to fix a couple of potential deadlocks where the current helper is called with the lock already held, hence the CC stable tag.

Fixes f492edb40b54 ("PCI: vmd: Add quirk to configure PCIe ASPM and LTR")
Cc Michael Bottini <[email protected]>
Cc David E. Box <[email protected]>
---
 drivers/pci/pcie/aspm.c | 53 +++++++++++++++++++++++++++++++----------
 include/linux/pci.h     |  3 +++
 2 files changed, 43 insertions(+), 13 deletions(-)
drivers/pci/pcie/aspm.c +40 -13
index 50b04ae5c394..5eb462772354 100644
@@ -1109,17 +1109,7 @@ int pci_disable_link_state(struct pci_dev *pdev, int state)
 }
 EXPORT_SYMBOL(pci_disable_link_state);
 
-/**
- * pci_enable_link_state - Clear and set the default device link state so that
- * the link may be allowed to enter the specified states. Note that if the
- * BIOS didn't grant ASPM control to the OS, this does nothing because we can't
- * touch the LNKCTL register. Also note that this does not enable states
- * disabled by pci_disable_link_state(). Return 0 or a negative errno.
- *
- * @pdev: PCI device
- * @state: Mask of ASPM link states to enable
- */
-int pci_enable_link_state(struct pci_dev *pdev, int state)
+static int __pci_enable_link_state(struct pci_dev *pdev, int state, bool locked)
 {
 	struct pcie_link_state *link = pcie_aspm_get_link(pdev);
 
@@ -1136,7 +1126,8 @@ int pci_enable_link_state(struct pci_dev *pdev, int state)
 		return -EPERM;
 	}
 
-	down_read(&pci_bus_sem);
+	if (!locked)
+		down_read(&pci_bus_sem);
 	mutex_lock(&aspm_lock);
 	link->aspm_default = 0;
 	if (state & PCIE_LINK_STATE_L0S)
@@ -1157,12 +1148,48 @@ int pci_enable_link_state(struct pci_dev *pdev, int state)
 	link->clkpm_default = (state & PCIE_LINK_STATE_CLKPM) ? 1 : 0;
 	pcie_set_clkpm(link, policy_to_clkpm_state(link));
 	mutex_unlock(&aspm_lock);
-	up_read(&pci_bus_sem);
+	if (!locked)
+		up_read(&pci_bus_sem);
 
 	return 0;
 }
+
+/**
+ * pci_enable_link_state - Clear and set the default device link state so that
+ * the link may be allowed to enter the specified states. Note that if the
+ * BIOS didn't grant ASPM control to the OS, this does nothing because we can't
+ * touch the LNKCTL register. Also note that this does not enable states
+ * disabled by pci_disable_link_state(). Return 0 or a negative errno.
+ *
+ * @pdev: PCI device
+ * @state: Mask of ASPM link states to enable
+ */
+int pci_enable_link_state(struct pci_dev *pdev, int state)
+{
+	return __pci_enable_link_state(pdev, state, false);
+}
 EXPORT_SYMBOL(pci_enable_link_state);
 
+/**
+ * pci_enable_link_state_locked - Clear and set the default device link state
+ * so that the link may be allowed to enter the specified states. Note that if
+ * the BIOS didn't grant ASPM control to the OS, this does nothing because we
+ * can't touch the LNKCTL register. Also note that this does not enable states
+ * disabled by pci_disable_link_state(). Return 0 or a negative errno.
+ *
+ * @pdev: PCI device
+ * @state: Mask of ASPM link states to enable
+ *
+ * Context: Caller holds pci_bus_sem read lock.
+ */
+int pci_enable_link_state_locked(struct pci_dev *pdev, int state)
+{
+	lockdep_assert_held_read(&pci_bus_sem);
+
+	return __pci_enable_link_state(pdev, state, true);
+}
+EXPORT_SYMBOL(pci_enable_link_state_locked);
+
 static int pcie_aspm_set_policy(const char *val,
 				const struct kernel_param *kp)
 {
include/linux/pci.h +3 -0
index 60ca768bc867..dea043bc1e38 100644
@@ -1829,6 +1829,7 @@ extern bool pcie_ports_native;
 int pci_disable_link_state(struct pci_dev *pdev, int state);
 int pci_disable_link_state_locked(struct pci_dev *pdev, int state);
 int pci_enable_link_state(struct pci_dev *pdev, int state);
+int pci_enable_link_state_locked(struct pci_dev *pdev, int state);
 void pcie_no_aspm(void);
 bool pcie_aspm_support_enabled(void);
 bool pcie_aspm_enabled(struct pci_dev *pdev);
@@ -1839,6 +1840,8 @@ static inline int pci_disable_link_state_locked(struct pci_dev *pdev, int state)
 { return 0; }
 static inline int pci_enable_link_state(struct pci_dev *pdev, int state)
 { return 0; }
+static inline int pci_enable_link_state_locked(struct pci_dev *pdev, int state)
+{ return 0; }
 static inline void pcie_no_aspm(void) { }
 static inline bool pcie_aspm_support_enabled(void) { return false; }
 static inline bool pcie_aspm_enabled(struct pci_dev *pdev) { return false; }
Signature · 1 line
2.41.0
#2 lore raw

Re: [PATCH v2 1/6] PCI/ASPM: Add locked helper for enabling link state

[+cc Kai-Heng]

Quoted 67 lines · Johan Hovold

Add a helper for enabling link states that can be used in contexts where a pci_bus_sem read lock is already held (e.g. from pci_walk_bus()).

This helper will be used to fix a couple of potential deadlocks where the current helper is called with the lock already held, hence the CC stable tag.

Fixes f492edb40b54 ("PCI: vmd: Add quirk to configure PCIe ASPM and LTR")
Cc Michael Bottini <[email protected]>
Cc David E. Box <[email protected]>
---
 drivers/pci/pcie/aspm.c | 53 +++++++++++++++++++++++++++++++----------
 include/linux/pci.h     |  3 +++
 2 files changed, 43 insertions(+), 13 deletions(-)
drivers/pci/pcie/aspm.c +11 -13
index 50b04ae5c394..5eb462772354 100644
@@ -1109,17 +1109,7 @@ int pci_disable_link_state(struct pci_dev *pdev, int state)
 }
 EXPORT_SYMBOL(pci_disable_link_state);
 
-/**
- * pci_enable_link_state - Clear and set the default device link state so that
- * the link may be allowed to enter the specified states. Note that if the
- * BIOS didn't grant ASPM control to the OS, this does nothing because we can't
- * touch the LNKCTL register. Also note that this does not enable states
- * disabled by pci_disable_link_state(). Return 0 or a negative errno.
- *
- * @pdev: PCI device
- * @state: Mask of ASPM link states to enable
- */
-int pci_enable_link_state(struct pci_dev *pdev, int state)
+static int __pci_enable_link_state(struct pci_dev *pdev, int state, bool locked)
 {
 	struct pcie_link_state *link = pcie_aspm_get_link(pdev);
 
@@ -1136,7 +1126,8 @@ int pci_enable_link_state(struct pci_dev *pdev, int state)
 		return -EPERM;
 	}
 
-	down_read(&pci_bus_sem);
+	if (!locked)
+		down_read(&pci_bus_sem);
 	mutex_lock(&aspm_lock);
 	link->aspm_default = 0;
 	if (state & PCIE_LINK_STATE_L0S)
@@ -1157,12 +1148,48 @@ int pci_enable_link_state(struct pci_dev *pdev, int state)
 	link->clkpm_default = (state & PCIE_LINK_STATE_CLKPM) ? 1 : 0;
 	pcie_set_clkpm(link, policy_to_clkpm_state(link));
 	mutex_unlock(&aspm_lock);
-	up_read(&pci_bus_sem);
+	if (!locked)
+		up_read(&pci_bus_sem);
 
 	return 0;
 }
+
+/**
+ * pci_enable_link_state - Clear and set the default device link state so that
+ * the link may be allowed to enter the specified states. Note that if the
+ * BIOS didn't grant ASPM control to the OS, this does nothing because we can't
+ * touch the LNKCTL register. Also note that this does not enable states

drivers/pci/pcie/aspm.c int pci_enable_link_state(struct pci_dev *pdev, int state) · line 1171

Quoted 10 lines
drivers/pci/pcie/aspm.c +9 -0
+ * disabled by pci_disable_link_state(). Return 0 or a negative errno.
+ *
+ * @pdev: PCI device
+ * @state: Mask of ASPM link states to enable
+ */
+int pci_enable_link_state(struct pci_dev *pdev, int state)
+{
+	return __pci_enable_link_state(pdev, state, false);
+}
 EXPORT_SYMBOL(pci_enable_link_state);

As far as I can see, we end up with pci_enable_link_state() defined but never called and pci_enable_link_state_locked() being called only by pcie-qcom.c and vmd.c.

Can we just rename pci_enable_link_state() to pci_enable_link_state_locked() and assert that pci_bus_sem is held, so we don't end up with a function that's never used?

I hope we can obsolete this whole idea someday. Using pci_walk_bus() in qcom and vmd to enable ASPM is an ugly hack to work around this weird idea that "the OS isn't allowed to enable more ASPM states than the BIOS did because the BIOS might have left ASPM disabled because it knows about hardware issues." More history at
https://lore.kernel.org/linux-pci/[email protected]/T/#u

I think we need to get to a point where Linux enables all supported ASPM features by default. If we really think x86 BIOS assumes an implicit contract that the OS will never enable ASPM more aggressively, we might need some kind of arch quirk for that.

If we can get there, the qcom use of pci_enable_link_state() could go away, and the vmd use could be replaced by some kind of "if device is below VMD, get rid of the legacy x86 ASPM assumption" quirk.

Bjorn

#3 lore raw

Re: [PATCH v2 1/6] PCI/ASPM: Add locked helper for enabling link state

Quoted 6 lines · Bjorn Helgaas

[+cc Kai-Heng]

Quoted 3 lines · Johan Hovold

Add a helper for enabling link states that can be used in contexts where a pci_bus_sem read lock is already held (e.g. from pci_walk_bus()).

Quoted 7 lines
Quoted 3 lines

This helper will be used to fix a couple of potential deadlocks where the current helper is called with the lock already held, hence the CC stable tag.

As far as I can see, we end up with pci_enable_link_state() defined but never called and pci_enable_link_state_locked() being called only by pcie-qcom.c and vmd.c.

Correct, I mentioned this in the cover letter.

Quoted 3 lines

Can we just rename pci_enable_link_state() to pci_enable_link_state_locked() and assert that pci_bus_sem is held, so we don't end up with a function that's never used?

That would work too. I went with adding a new helper to facilitate stable backports and to mirror pci_disable_link_state(). The variants are simple wrappers around the implementation so there's no real cost to having the unused one.

But it seems like you think there will never be a need to call this helper outside of pci_walk_bus() and if so we can drop the unlocked variant right away.

Would you prefer basically squashing the first three patches and mark the result for stable even though that patch will fail to apply to older kernels as the Qualcomm bits went into -rc1?

Or should I send a follow-on patch removing the unused helper after merging this series?

The end-result will be identical.

Johan

#4 lore raw

Re: [PATCH v2 1/6] PCI/ASPM: Add locked helper for enabling link state

Quoted 9 lines · Johan Hovold
Quoted 7 lines · Bjorn Helgaas
Quoted 6 lines · Johan Hovold

Add a helper for enabling link states that can be used in contexts where a pci_bus_sem read lock is already held (e.g. from pci_walk_bus()).

This helper will be used to fix a couple of potential deadlocks where the current helper is called with the lock already held, hence the CC stable tag.

Quoted 5 lines
Quoted 3 lines

As far as I can see, we end up with pci_enable_link_state() defined but never called and pci_enable_link_state_locked() being called only by pcie-qcom.c and vmd.c.

Correct, I mentioned this in the cover letter.

Ah, right. I really don't like these exported locked/unlocked interfaces because pci_bus_sem is internal to the PCI core, and the caller shouldn't need to know or be able to specify whether it is held or not. They exist for now, but I think we should try to get rid of them.

Quoted 8 lines
Quoted 3 lines

Can we just rename pci_enable_link_state() to pci_enable_link_state_locked() and assert that pci_bus_sem is held, so we don't end up with a function that's never used?

That would work too. I went with adding a new helper to facilitate stable backports and to mirror pci_disable_link_state(). The variants are simple wrappers around the implementation so there's no real cost to having the unused one.

Makes good sense. There's no real machine cost to the unused one; I'm more concerned about the human cost here.

Quoted 10 lines

But it seems like you think there will never be a need to call this helper outside of pci_walk_bus() and if so we can drop the unlocked variant right away.

Would you prefer basically squashing the first three patches and mark the result for stable even though that patch will fail to apply to older kernels as the Qualcomm bits went into -rc1?

Or should I send a follow-on patch removing the unused helper after merging this series?

I think you did the right thing.

Bjorn

#5 lore raw

Re: [PATCH v2 1/6] PCI/ASPM: Add locked helper for enabling link state

Quoted 26 lines · Bjorn Helgaas
Quoted 9 lines · Johan Hovold
Quoted 7 lines · Bjorn Helgaas
Quoted 6 lines · Johan Hovold

Add a helper for enabling link states that can be used in contexts where a pci_bus_sem read lock is already held (e.g. from pci_walk_bus()).

This helper will be used to fix a couple of potential deadlocks where the current helper is called with the lock already held, hence the CC stable tag.

Quoted 5 lines
Quoted 3 lines

As far as I can see, we end up with pci_enable_link_state() defined but never called and pci_enable_link_state_locked() being called only by pcie-qcom.c and vmd.c.

Correct, I mentioned this in the cover letter.

Ah, right. I really don't like these exported locked/unlocked interfaces because pci_bus_sem is internal to the PCI core, and the caller shouldn't need to know or be able to specify whether it is held or not. They exist for now, but I think we should try to get rid of them.

Quoted 4 lines
Quoted 3 lines

Can we just rename pci_enable_link_state() to pci_enable_link_state_locked() and assert that pci_bus_sem is held, so we don't end up with a function that's never used?

Quoted 7 lines
Quoted 4 lines

That would work too. I went with adding a new helper to facilitate stable backports and to mirror pci_disable_link_state(). The variants are simple wrappers around the implementation so there's no real cost to having the unused one.

Makes good sense. There's no real machine cost to the unused one; I'm more concerned about the human cost here.

I know these were already applied but I want to correct one small misconcept that seems to be floating around thanks the misleading name...

pci_enable_link_state() is not really a pair/mirror of pci_disable_link_state() despite its name. It would be better called pci_set_default_link_state() to better match what it does.

Signature · 1 line
 i.
#6 lore raw

Re: [PATCH v2 1/6] PCI/ASPM: Add locked helper for enabling link state

In reply to Bjorn Helgaas
Quoted 97 lines · Bjorn Helgaas

[+cc Kai-Heng]

Quoted 67 lines · Johan Hovold

Add a helper for enabling link states that can be used in contexts where a pci_bus_sem read lock is already held (e.g. from pci_walk_bus()).

This helper will be used to fix a couple of potential deadlocks where the current helper is called with the lock already held, hence the CC stable tag.

Fixes f492edb40b54 ("PCI: vmd: Add quirk to configure PCIe ASPM and LTR")
Cc Michael Bottini <[email protected]>
Cc David E. Box <[email protected]>
---
 drivers/pci/pcie/aspm.c | 53 +++++++++++++++++++++++++++++++----------
 include/linux/pci.h     |  3 +++
 2 files changed, 43 insertions(+), 13 deletions(-)
drivers/pci/pcie/aspm.c +11 -13
index 50b04ae5c394..5eb462772354 100644
@@ -1109,17 +1109,7 @@ int pci_disable_link_state(struct pci_dev *pdev, int state)
 }
 EXPORT_SYMBOL(pci_disable_link_state);
 
-/**
- * pci_enable_link_state - Clear and set the default device link state so that
- * the link may be allowed to enter the specified states. Note that if the
- * BIOS didn't grant ASPM control to the OS, this does nothing because we can't
- * touch the LNKCTL register. Also note that this does not enable states
- * disabled by pci_disable_link_state(). Return 0 or a negative errno.
- *
- * @pdev: PCI device
- * @state: Mask of ASPM link states to enable
- */
-int pci_enable_link_state(struct pci_dev *pdev, int state)
+static int __pci_enable_link_state(struct pci_dev *pdev, int state, bool locked)
 {
      struct pcie_link_state *link = pcie_aspm_get_link(pdev);
 
@@ -1136,7 +1126,8 @@ int pci_enable_link_state(struct pci_dev *pdev, int state)
              return -EPERM;
      }
 
-     down_read(&pci_bus_sem);
+     if (!locked)
+             down_read(&pci_bus_sem);
      mutex_lock(&aspm_lock);
      link->aspm_default = 0;
      if (state & PCIE_LINK_STATE_L0S)
@@ -1157,12 +1148,48 @@ int pci_enable_link_state(struct pci_dev *pdev, int state)
      link->clkpm_default = (state & PCIE_LINK_STATE_CLKPM) ? 1 : 0;
      pcie_set_clkpm(link, policy_to_clkpm_state(link));
      mutex_unlock(&aspm_lock);
-     up_read(&pci_bus_sem);
+     if (!locked)
+             up_read(&pci_bus_sem);
 
      return 0;
 }
+
+/**
+ * pci_enable_link_state - Clear and set the default device link state so that
+ * the link may be allowed to enter the specified states. Note that if the
+ * BIOS didn't grant ASPM control to the OS, this does nothing because we can't
+ * touch the LNKCTL register. Also note that this does not enable states

drivers/pci/pcie/aspm.c int pci_enable_link_state(struct pci_dev *pdev, int state) · line 1171

Quoted 10 lines
drivers/pci/pcie/aspm.c +9 -0
+ * disabled by pci_disable_link_state(). Return 0 or a negative errno.
+ *
+ * @pdev: PCI device
+ * @state: Mask of ASPM link states to enable
+ */
+int pci_enable_link_state(struct pci_dev *pdev, int state)
+{
+     return __pci_enable_link_state(pdev, state, false);
+}
 EXPORT_SYMBOL(pci_enable_link_state);

As far as I can see, we end up with pci_enable_link_state() defined but never called and pci_enable_link_state_locked() being called only by pcie-qcom.c and vmd.c.

Can we just rename pci_enable_link_state() to pci_enable_link_state_locked() and assert that pci_bus_sem is held, so we don't end up with a function that's never used?

I hope we can obsolete this whole idea someday. Using pci_walk_bus() in qcom and vmd to enable ASPM is an ugly hack to work around this weird idea that "the OS isn't allowed to enable more ASPM states than the BIOS did because the BIOS might have left ASPM disabled because it knows about hardware issues." More history at
https://lore.kernel.org/linux-pci/[email protected]/T/#u

Quoted 4 lines

I think we need to get to a point where Linux enables all supported ASPM features by default. If we really think x86 BIOS assumes an implicit contract that the OS will never enable ASPM more aggressively, we might need some kind of arch quirk for that.

The reality is that PC ODM toggles ASPM to workaround hardware defects, assuming that OS will honor what's set by the BIOS. If ASPM gets enabled for all devices, many devices will break.

Kai-Heng

Quoted 6 lines

If we can get there, the qcom use of pci_enable_link_state() could go away, and the vmd use could be replaced by some kind of "if device is below VMD, get rid of the legacy x86 ASPM assumption" quirk.

Bjorn

#7 lore raw

Re: [PATCH v2 1/6] PCI/ASPM: Add locked helper for enabling link state

Quoted 10 lines · Kai-Heng Feng

On Fri, Dec 8, 2023 at 4:47 AM Bjorn Helgaas <[email protected]> wrote:
...

Quoted 7 lines

I hope we can obsolete this whole idea someday. Using pci_walk_bus() in qcom and vmd to enable ASPM is an ugly hack to work around this weird idea that "the OS isn't allowed to enable more ASPM states than the BIOS did because the BIOS might have left ASPM disabled because it knows about hardware issues." More history at
https://lore.kernel.org/linux-pci/[email protected]/T/#u

Quoted 8 lines
Quoted 4 lines

I think we need to get to a point where Linux enables all supported ASPM features by default. If we really think x86 BIOS assumes an implicit contract that the OS will never enable ASPM more aggressively, we might need some kind of arch quirk for that.

The reality is that PC ODM toggles ASPM to workaround hardware defects, assuming that OS will honor what's set by the BIOS. If ASPM gets enabled for all devices, many devices will break.

That's why I mentioned some kind of arch quirk. Maybe we're forced to do that for x86, for instance. But even that is a stop-gap.

The idea that the BIOS ASPM config is some kind of handoff protocol is really unsupportable.

Do we have concrete examples of where enabling ASPM for a device that advertises ASPM support will break something?

Bjorn

#8 lore raw

Re: [PATCH v2 1/6] PCI/ASPM: Add locked helper for enabling link state

Quoted 20 lines · Bjorn Helgaas
Quoted 10 lines · Kai-Heng Feng

On Fri, Dec 8, 2023 at 4:47 AM Bjorn Helgaas <[email protected]> wrote:
...

Quoted 7 lines

I hope we can obsolete this whole idea someday.  Using pci_walk_bus() in qcom and vmd to enable ASPM is an ugly hack to work around this weird idea that "the OS isn't allowed to enable more ASPM states than the BIOS did because the BIOS might have left ASPM disabled because it knows about hardware issues."  More history at
https://lore.kernel.org/linux-pci/[email protected]/T/#u

Quoted 8 lines
Quoted 4 lines

I think we need to get to a point where Linux enables all supported ASPM features by default.  If we really think x86 BIOS assumes an implicit contract that the OS will never enable ASPM more aggressively, we might need some kind of arch quirk for that.

The reality is that PC ODM toggles ASPM to workaround hardware defects, assuming that OS will honor what's set by the BIOS. If ASPM gets enabled for all devices, many devices will break.

Quoted 5 lines

That's why I mentioned some kind of arch quirk.  Maybe we're forced to do that for x86, for instance.  But even that is a stop-gap.

The idea that the BIOS ASPM config is some kind of handoff protocol is really unsupportable.

To be clear, you are not talking about a situation where ACPI_FADT_NO_ASPM or _OSC PCIe disallow OS ASPM control, right? Everyone agrees that this should be honored? The question is what to do by default when the OS is not restricted by these mechanisms?

Reading the mentioned thread, I too think that using the BIOS config as the default would be the safest option, but only to avoid breaking systems, not because of an implied contract between the BIOS and OS. However, enabling all capable ASPM features is the ideal option. If the OS isn't limited by ACPI_FADT_NO_ASPM or _OSC PCIe, then ASPM enabling is fully under its control. If this doesn't work for some devices then they are broken and need a quirk.

David

#9 lore raw

Re: [PATCH v2 1/6] PCI/ASPM: Add locked helper for enabling link state

Quoted 24 lines · David E. Box
Quoted 23 lines · Bjorn Helgaas
Quoted 10 lines · Kai-Heng Feng

On Fri, Dec 8, 2023 at 4:47 AM Bjorn Helgaas <[email protected]> wrote:
...

Quoted 7 lines

I hope we can obsolete this whole idea someday.  Using pci_walk_bus() in qcom and vmd to enable ASPM is an ugly hack to work around this weird idea that "the OS isn't allowed to enable more ASPM states than the BIOS did because the BIOS might have left ASPM disabled because it knows about hardware issues."  More history at
https://lore.kernel.org/linux-pci/[email protected]/T/#u

Quoted 8 lines
Quoted 4 lines

I think we need to get to a point where Linux enables all supported ASPM features by default.  If we really think x86 BIOS assumes an implicit contract that the OS will never enable ASPM more aggressively, we might need some kind of arch quirk for that.

The reality is that PC ODM toggles ASPM to workaround hardware defects, assuming that OS will honor what's set by the BIOS. If ASPM gets enabled for all devices, many devices will break.

That's why I mentioned some kind of arch quirk.  Maybe we're forced to do that for x86, for instance.  But even that is a stop-gap.

Quoted 7 lines
Quoted 2 lines

The idea that the BIOS ASPM config is some kind of handoff protocol is really unsupportable.

To be clear, you are not talking about a situation where ACPI_FADT_NO_ASPM or _OSC PCIe disallow OS ASPM control, right? Everyone agrees that this should be honored? The question is what to do by default when the OS is not restricted by these mechanisms?

Exactly. The OS should respect ACPI_FADT_NO_ASPM and _OSC.

I think there are a couple exceptions where we want to disable ASPM even if the platform said the OS shouldn't touch ASPM at all, but that's a special case.

Quoted 7 lines

Reading the mentioned thread, I too think that using the BIOS config as the default would be the safest option, but only to avoid breaking systems, not because of an implied contract between the BIOS and OS. However, enabling all capable ASPM features is the ideal option. If the OS isn't limited by ACPI_FADT_NO_ASPM or _OSC PCIe, then ASPM enabling is fully under its control. If this doesn't work for some devices then they are broken and need a quirk.

Agreed. It may not be practical to identify such devices, so we may need a broader arch-based and/or date-based quirk.

I'd be shocked if Windows treated the BIOS config as a "do not exceed this" situation, so my secret hope is that some of these "broken" devices are really caused by defects in the Linux ASPM support or the driver, and that we can fix them if we find out about them.

But I have no details about any of these alleged broken devices, so it's hard to make progress on them. Maybe we should log a debug note if the device advertises ASPM support that BIOS didn't enable.

Bjorn

#10 lore raw

Re: [PATCH v2 1/6] PCI/ASPM: Add locked helper for enabling link state

Quoted 50 lines · Bjorn Helgaas
Quoted 24 lines · David E. Box
Quoted 23 lines · Bjorn Helgaas
Quoted 10 lines · Kai-Heng Feng

On Fri, Dec 8, 2023 at 4:47 AM Bjorn Helgaas <[email protected]> wrote:
...

Quoted 7 lines

I hope we can obsolete this whole idea someday.  Using pci_walk_bus() in qcom and vmd to enable ASPM is an ugly hack to work around this weird idea that "the OS isn't allowed to enable more ASPM states than the BIOS did because the BIOS might have left ASPM disabled because it knows about hardware issues."  More history at
https://lore.kernel.org/linux-pci/[email protected]/T/#u

Quoted 8 lines
Quoted 4 lines

I think we need to get to a point where Linux enables all supported ASPM features by default.  If we really think x86 BIOS assumes an implicit contract that the OS will never enable ASPM more aggressively, we might need some kind of arch quirk for that.

The reality is that PC ODM toggles ASPM to workaround hardware defects, assuming that OS will honor what's set by the BIOS. If ASPM gets enabled for all devices, many devices will break.

That's why I mentioned some kind of arch quirk.  Maybe we're forced to do that for x86, for instance.  But even that is a stop-gap.

Quoted 7 lines
Quoted 2 lines

The idea that the BIOS ASPM config is some kind of handoff protocol is really unsupportable.

To be clear, you are not talking about a situation where ACPI_FADT_NO_ASPM or _OSC PCIe disallow OS ASPM control, right? Everyone agrees that this should be honored? The question is what to do by default when the OS is not restricted by these mechanisms?

Exactly.  The OS should respect ACPI_FADT_NO_ASPM and _OSC.

I think there are a couple exceptions where we want to disable ASPM even if the platform said the OS shouldn't touch ASPM at all, but that's a special case.

Quoted 7 lines

Reading the mentioned thread, I too think that using the BIOS config as the default would be the safest option, but only to avoid breaking systems, not because of an implied contract between the BIOS and OS. However, enabling all capable ASPM features is the ideal option. If the OS isn't limited by ACPI_FADT_NO_ASPM or _OSC PCIe, then ASPM enabling is fully under its control.  If this doesn't work for some devices then they are broken and need a quirk.

Agreed.  It may not be practical to identify such devices, so we may need a broader arch-based and/or date-based quirk.

Quoted 7 lines

I'd be shocked if Windows treated the BIOS config as a "do not exceed this" situation, so my secret hope is that some of these "broken" devices are really caused by defects in the Linux ASPM support or the driver, and that we can fix them if we find out about them.

But I have no details about any of these alleged broken devices, so it's hard to make progress on them.

I don't have a sense of the scope either. But I could see BIOS not enabling features that would provide no added power savings benefit. We use ASPM to manage package power. There are Intel devices that certainly don't require L1SS for the SoC to achieve the deepest power savings. L1 alone is fine for them. I don't know what the test coveragae is for unenabled features. I've sent these questions to our BIOS folks.

Quoted 2 lines

Maybe we should log a debug note
if the device advertises ASPM support that BIOS didn't enable.

Good idea.

David

Quoted 2 lines

Bjorn

#11 lore raw

Re: [PATCH v2 1/6] PCI/ASPM: Add locked helper for enabling link state

Quoted 11 lines · David E. Box

On Wed, 2023-12-13 at 14:45 -0600, Bjorn Helgaas wrote:
...

Quoted 7 lines

I'd be shocked if Windows treated the BIOS config as a "do not exceed this" situation, so my secret hope is that some of these "broken" devices are really caused by defects in the Linux ASPM support or the driver, and that we can fix them if we find out about them.

But I have no details about any of these alleged broken devices, so it's hard to make progress on them.

Quoted 7 lines

I don't have a sense of the scope either. But I could see BIOS not enabling features that would provide no added power savings benefit. We use ASPM to manage package power. There are Intel devices that certainly don't require L1SS for the SoC to achieve the deepest power savings. L1 alone is fine for them. I don't know what the test coverage is for unenabled features. I've sent these questions to our BIOS folks.

Once upon a time there was a push to make it so firmware only had to enumerate boot and console devices and it could skip enumeration and configuration of other devices. But I don't think we've made much progress on that, at least for x86, possibly because Linux depends so much on BIOS resource assignment. IMO that's a Linux deficiency.

Bjorn

#12 lore raw

PATCH v2 2/6 PCI: vmd: Fix deadlock when enabling ASPM

In reply to Johan Hovold

The vmd_pm_enable_quirk() helper is called from pci_walk_bus() during probe to enable ASPM for controllers with VMD_FEAT_BIOS_PM_QUIRK set.

Since pci_walk_bus() already holds a pci_bus_sem read lock, use the new locked helper to enable link states in order to avoid a potential deadlock (e.g. in case someone takes a write lock before reacquiring the read lock).

Fixes f492edb40b54 ("PCI: vmd: Add quirk to configure PCIe ASPM and LTR")
Cc Michael Bottini <[email protected]>
Cc David E. Box <[email protected]>
---
 drivers/pci/controller/vmd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/pci/controller/vmd.c +1 -1
index 94ba61fe1c44..0452cbc362ee 100644
@@ -751,7 +751,7 @@ static int vmd_pm_enable_quirk(struct pci_dev *pdev, void *userdata)
 	if (!(features & VMD_FEAT_BIOS_PM_QUIRK))
 		return 0;
 
-	pci_enable_link_state(pdev, PCIE_LINK_STATE_ALL);
+	pci_enable_link_state_locked(pdev, PCIE_LINK_STATE_ALL);
 
 	pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_LTR);
 	if (!pos)
Signature · 1 line
2.41.0
#13 lore raw

PATCH v2 3/6 PCI: qcom: Fix deadlock when enabling ASPM

In reply to Johan Hovold

The qcom_pcie_enable_aspm() helper is called from pci_walk_bus() during host init to enable ASPM.

Since pci_walk_bus() already holds a pci_bus_sem read lock, use the new locked helper to enable link states in order to avoid a potential deadlock (e.g. in case someone takes a write lock before reacquiring the read lock).

This issue was reported by lockdep:

============================================
WARNING: possible recursive locking detected
6.7.0-rc1 #4 Not tainted
--------------------------------------------
kworker/u16:6/147 is trying to acquire lock:
ffffbf3ff9d2cfa0 (pci_bus_sem){++++}-{3:3}, at: pci_enable_link_state+0x74/0x1e8

but task is already holding lock:
ffffbf3ff9d2cfa0 (pci_bus_sem){++++}-{3:3}, at: pci_walk_bus+0x34/0xbc

other info that might help us debug this:

    Possible unsafe locking scenario:
          CPU0
          ----
     lock(pci_bus_sem);
     lock(pci_bus_sem);

    *** DEADLOCK ***
Fixes 9f4f3dfad8cf ("PCI: qcom: Enable ASPM for platforms supporting 1.9.0 ops")
---
 drivers/pci/controller/dwc/pcie-qcom.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/pci/controller/dwc/pcie-qcom.c +1 -1
index ce3ece28fed2..21523115f6a4 100644
@@ -971,7 +971,7 @@ static int qcom_pcie_enable_aspm(struct pci_dev *pdev, void *userdata)
 {
 	/* Downstream devices need to be in D0 state before enabling PCI PM substates */
 	pci_set_power_state(pdev, PCI_D0);
-	pci_enable_link_state(pdev, PCIE_LINK_STATE_ALL);
+	pci_enable_link_state_locked(pdev, PCIE_LINK_STATE_ALL);
 
 	return 0;
 }
Signature · 1 line
2.41.0
#14 lore raw

PATCH v2 4/6 PCI: qcom: Clean up ASPM comment

In reply to Johan Hovold

Break up the newly added ASPM comment so that it fits within the soft 80 character limit and becomes more readable.

---
 drivers/pci/controller/dwc/pcie-qcom.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/pci/controller/dwc/pcie-qcom.c +4 -1
index 21523115f6a4..a6f08acff3d4 100644
@@ -969,7 +969,10 @@ static int qcom_pcie_post_init_2_7_0(struct qcom_pcie *pcie)
 
 static int qcom_pcie_enable_aspm(struct pci_dev *pdev, void *userdata)
 {
-	/* Downstream devices need to be in D0 state before enabling PCI PM substates */
+	/*
+	 * Downstream devices need to be in D0 state before enabling PCI PM
+	 * substates.
+	 */
 	pci_set_power_state(pdev, PCI_D0);
 	pci_enable_link_state_locked(pdev, PCIE_LINK_STATE_ALL);
 
Signature · 1 line
2.41.0
#15 lore raw

PATCH v2 5/6 PCI/ASPM: Clean up disable link state parameter

In reply to Johan Hovold

Replace the current 'sem' parameter to the __pci_disable_link_state() helper with a more descriptive 'locked' parameter, which indicates whether a pci_bus_sem read lock is already held.

---
 drivers/pci/pcie/aspm.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
drivers/pci/pcie/aspm.c +5 -5
index 5eb462772354..d7a3ca555cc1 100644
@@ -1041,7 +1041,7 @@ static struct pcie_link_state *pcie_aspm_get_link(struct pci_dev *pdev)
 	return bridge->link_state;
 }
 
-static int __pci_disable_link_state(struct pci_dev *pdev, int state, bool sem)
+static int __pci_disable_link_state(struct pci_dev *pdev, int state, bool locked)
 {
 	struct pcie_link_state *link = pcie_aspm_get_link(pdev);
 
@@ -1060,7 +1060,7 @@ static int __pci_disable_link_state(struct pci_dev *pdev, int state, bool sem)
 		return -EPERM;
 	}
 
-	if (sem)
+	if (!locked)
 		down_read(&pci_bus_sem);
 	mutex_lock(&aspm_lock);
 	if (state & PCIE_LINK_STATE_L0S)
@@ -1082,7 +1082,7 @@ static int __pci_disable_link_state(struct pci_dev *pdev, int state, bool sem)
 		link->clkpm_disable = 1;
 	pcie_set_clkpm(link, policy_to_clkpm_state(link));
 	mutex_unlock(&aspm_lock);
-	if (sem)
+	if (!locked)
 		up_read(&pci_bus_sem);
 
 	return 0;
@@ -1090,7 +1090,7 @@ static int __pci_disable_link_state(struct pci_dev *pdev, int state, bool sem)
 
 int pci_disable_link_state_locked(struct pci_dev *pdev, int state)
 {
-	return __pci_disable_link_state(pdev, state, false);
+	return __pci_disable_link_state(pdev, state, true);
 }
 EXPORT_SYMBOL(pci_disable_link_state_locked);
 
@@ -1105,7 +1105,7 @@ EXPORT_SYMBOL(pci_disable_link_state_locked);
  */
 int pci_disable_link_state(struct pci_dev *pdev, int state)
 {
-	return __pci_disable_link_state(pdev, state, true);
+	return __pci_disable_link_state(pdev, state, false);
 }
 EXPORT_SYMBOL(pci_disable_link_state);
 
Signature · 1 line
2.41.0
#16 lore raw

PATCH v2 6/6 PCI/ASPM: Add lockdep assert to link state helper

In reply to Johan Hovold

Add a lockdep assert to the locked disable link state helper which should only be called with a pci_bus_sem read lock held.

---
 drivers/pci/pcie/aspm.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/pci/pcie/aspm.c +2 -0
index d7a3ca555cc1..5dab531c8654 100644
@@ -1090,6 +1090,8 @@ static int __pci_disable_link_state(struct pci_dev *pdev, int state, bool locked
 
 int pci_disable_link_state_locked(struct pci_dev *pdev, int state)
 {
+	lockdep_assert_held_read(&pci_bus_sem);
+
 	return __pci_disable_link_state(pdev, state, true);
 }
 EXPORT_SYMBOL(pci_disable_link_state_locked);
Signature · 1 line
2.41.0
#17 lore raw
In reply to Johan Hovold

Hi PCI maintainers,

Quoted 13 lines · Johan Hovold

The pci_enable_link_state() helper is currently only called from pci_walk_bus(), something which can lead to a deadlock as both helpers take a pci_bus_sem read lock.

Add a new locked helper which can be called with the read lock held and fix up the two current users (the second is new in 6.7-rc1).

Note that there are no users left of the original unlocked variant after this series, but I decided to leave it in place for now (e.g. to mirror the corresponding helpers to disable link states).

Included are also a couple of related cleanups.

Quoted 7 lines

Johan Hovold (6):
PCI/ASPM: Add locked helper for enabling link state
PCI: vmd: Fix deadlock when enabling ASPM
PCI: qcom: Fix deadlock when enabling ASPM
PCI: qcom: Clean up ASPM comment
PCI/ASPM: Clean up disable link state parameter PCI/ASPM: Add lockdep assert to link state helper

Could we get this merged for 6.7-rc5? Even if the risk of a deadlock is not that great, this bug prevents using lockdep on Qualcomm platforms so that more locking issues can potentially make their way into the kernel.

And for Qualcomm platforms, this is a regression in 6.7-rc1.

Johan

#regzbot introduced: 9f4f3dfad8cf

#18 lore raw

[TLDR: This mail in primarily relevant for Linux kernel regression tracking. See link in footer if these mails annoy you.]

Quoted 22 lines · Johan Hovold
Quoted 13 lines · Johan Hovold

The pci_enable_link_state() helper is currently only called from pci_walk_bus(), something which can lead to a deadlock as both helpers take a pci_bus_sem read lock.

Add a new locked helper which can be called with the read lock held and fix up the two current users (the second is new in 6.7-rc1).

Note that there are no users left of the original unlocked variant after this series, but I decided to leave it in place for now (e.g. to mirror the corresponding helpers to disable link states).

Included are also a couple of related cleanups.

Quoted 7 lines

Johan Hovold (6):
PCI/ASPM: Add locked helper for enabling link state
PCI: vmd: Fix deadlock when enabling ASPM
PCI: qcom: Fix deadlock when enabling ASPM
PCI: qcom: Clean up ASPM comment
PCI/ASPM: Clean up disable link state parameter PCI/ASPM: Add lockdep assert to link state helper

Quoted 7 lines

Could we get this merged for 6.7-rc5? Even if the risk of a deadlock is not that great, this bug prevents using lockdep on Qualcomm platforms so that more locking issues can potentially make their way into the kernel.

And for Qualcomm platforms, this is a regression in 6.7-rc1.

#regzbot introduced: 9f4f3dfad8cf

Fixes are now here:
https://git.kernel.org/pub/scm/linux/kernel/git/pci/pci.git/log/?h=for-linus

#regzbot fix: 075268be58232b0a2ae
#regzbot ignore-activity

Ciao, Thorsten (wearing his 'the Linux kernel's regression tracker' hat) --
Everything you wanna know about Linux kernel regression tracking:
https://linux-regtracking.leemhuis.info/about/#tldr
That page also explains what to do if mails like this annoy you.

#19 lore raw
In reply to Johan Hovold
Quoted 29 lines · Johan Hovold

The pci_enable_link_state() helper is currently only called from pci_walk_bus(), something which can lead to a deadlock as both helpers take a pci_bus_sem read lock.

Add a new locked helper which can be called with the read lock held and fix up the two current users (the second is new in 6.7-rc1).

Note that there are no users left of the original unlocked variant after this series, but I decided to leave it in place for now (e.g. to mirror the corresponding helpers to disable link states).

Included are also a couple of related cleanups.

Johan

Changes in v2
- fix up the function name in a kernel doc comment as reported by the kernel test robot <[email protected]>

Johan Hovold (6):
PCI/ASPM: Add locked helper for enabling link state
PCI: vmd: Fix deadlock when enabling ASPM
PCI: qcom: Fix deadlock when enabling ASPM
PCI: qcom: Clean up ASPM comment
PCI/ASPM: Clean up disable link state parameter PCI/ASPM: Add lockdep assert to link state helper

Quoted 5 lines
 drivers/pci/controller/dwc/pcie-qcom.c |  7 ++-
 drivers/pci/controller/vmd.c           |  2 +-
 drivers/pci/pcie/aspm.c                | 65 +++++++++++++++++++-------
 include/linux/pci.h                    |  3 ++
 4 files changed, 56 insertions(+), 21 deletions(-)

Applied to for-linus for v6.7, thanks, Johan!

#20 lore raw

Hi Bjorn,

Quoted 11 lines · Bjorn Helgaas
Quoted 7 lines · Johan Hovold

Johan Hovold (6):
PCI/ASPM: Add locked helper for enabling link state
PCI: vmd: Fix deadlock when enabling ASPM
PCI: qcom: Fix deadlock when enabling ASPM
PCI: qcom: Clean up ASPM comment
PCI/ASPM: Clean up disable link state parameter PCI/ASPM: Add lockdep assert to link state helper

Applied to for-linus for v6.7, thanks, Johan!

I've noticed that you're pretty keen on amending commit messages.

For this series, for example, I noticed that you added an American comma after "e.g." even though this is not expected in British English that I (try to) use. This risks introducing inconsistencies and frankly I see no reason for this kind of editing. British English is not an error. :)

You also added a plus sign after the stable kernel versions in the comments after the CC-stable tags even though this is not the right notation for this (see the stable kernel rules).

I'm more OK with you preferring to use function names over free text in commit messages even if that is not my preferred style.

But generally I find it a bit odd that you insist on rewriting commit messages like this and would prefer if you did not (especially since there's no record of you having done this in the commits themselves).

Fixing typos and grammar issues, or rewriting bad commit messages, is another thing of course.

Johan

#21 lore raw
Quoted 17 lines · Johan Hovold

Hi Bjorn,

Quoted 11 lines · Bjorn Helgaas
Quoted 7 lines · Johan Hovold

Johan Hovold (6):
PCI/ASPM: Add locked helper for enabling link state
PCI: vmd: Fix deadlock when enabling ASPM
PCI: qcom: Fix deadlock when enabling ASPM
PCI: qcom: Clean up ASPM comment
PCI/ASPM: Clean up disable link state parameter PCI/ASPM: Add lockdep assert to link state helper

Applied to for-linus for v6.7, thanks, Johan!

I've noticed that you're pretty keen on amending commit messages.

Quoted 8 lines

For this series, for example, I noticed that you added an American comma after "e.g." even though this is not expected in British English that I (try to) use. This risks introducing inconsistencies and frankly I see no reason for this kind of editing. British English is not an error. :)

You also added a plus sign after the stable kernel versions in the comments after the CC-stable tags even though this is not the right notation for this (see the stable kernel rules).

Fixed, sorry.

#22 lore raw
Quoted 9 lines · Bjorn Helgaas
Quoted 7 lines · Johan Hovold

I've noticed that you're pretty keen on amending commit messages.

For this series, for example, I noticed that you added an American comma after "e.g." even though this is not expected in British English that I (try to) use. This risks introducing inconsistencies and frankly I see no reason for this kind of editing. British English is not an error. :)

Quoted 5 lines
Quoted 3 lines

You also added a plus sign after the stable kernel versions in the comments after the CC-stable tags even though this is not the right notation for this (see the stable kernel rules).

Fixed, sorry.

Thanks!

Johan