igc: Reinstate IGC_REMOVED logic and implement it properly
Subsystems (3)
PATCH 1/1 igc: Reinstate IGC_REMOVED logic and implement it properly
The initially merged version of the igc driver code (via commit 146740f9abc4, "igc: Add support for PF") contained the following IGC_REMOVED checks in the igc_rd32/wr32() MMIO accessors:
u32 igc_rd32(struct igc_hw *hw, u32 reg)
{
u8 __iomem *hw_addr = READ_ONCE(hw->hw_addr);
u32 value = 0;
if (IGC_REMOVED(hw_addr))
return ~value;
value = readl(&hw_addr[reg]);
/* reads should not return all F's */
if (!(~value) && (!reg || !(~readl(hw_addr))))
hw->hw_addr = NULL;
return value;
}And:
#define wr32(reg, val) \
do { \
u8 __iomem *hw_addr = READ_ONCE((hw)->hw_addr); \
if (!IGC_REMOVED(hw_addr)) \
writel((val), &hw_addr[(reg)]); \
} while (0)E.g. igb has similar checks in its MMIO accessors, and has a similar macro E1000_REMOVED, which is implemented as follows:
#define E1000_REMOVED(h) unlikely(!(h))
These checks serve to detect and take note of an 0xffffffff MMIO read return from the device, which can be caused by a PCIe link flap or some other kind of PCI bus error, and to avoid performing MMIO reads and writes from that point onwards.
However, the IGC_REMOVED macro was not originally implemented:
#ifndef IGC_REMOVED #define IGC_REMOVED(a) (0) #endif /* IGC_REMOVED */
This led to the IGC_REMOVED logic to be removed entirely in a subsequent commit (commit 3c215fb18e70, "igc: remove IGC_REMOVED function"), with the rationale that such checks matter only for virtualization and that igc does not support virtualization -- but a PCIe device can become detached even without virtualization being in use, and without proper checks, a PCIe bus error affecting an igc adapter will lead to various NULL pointer dereferences, as the first access after the error will set hw->hw_addr to NULL, and subsequent accesses will blindly dereference this now-NULL pointer.
This patch reinstates the IGC_REMOVED checks in igc_rd32/wr32(), and implements IGC_REMOVED the way it is done for igb, by checking for the unlikely() case of hw_addr being NULL. This change prevents the oopses seen when a PCIe link flap occurs on an igc adapter.
---
As initially reported on intel-wired-lan@ in February:
https://lists.osuosl.org/pipermail/intel-wired-lan/Week-of-Mon-20220214/027787.html
We're seeing these NULL pointer dereferences hit fairly reproducibly when rebooting, presumably due to the particularities of reset sequencing on the boards we see this hit on.
A link flap can be caused by toggling the Secondary Bus Reset bit in the upstream PCIe bridge's Bridge Control register and can reliably reproduce this problem.
drivers/net/ethernet/intel/igc/igc_main.c | 3 +++ drivers/net/ethernet/intel/igc/igc_regs.h | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-)
drivers/net/ethernet/intel/igc/igc_main.c +3 -0
@@ -6171,6 +6171,9 @@ u32 igc_rd32(struct igc_hw *hw, u32 reg)u8 __iomem *hw_addr =READ_ONCE (hw->hw_addr);u32 value =0 ; +if (IGC_REMOVED (hw_addr)) +return ~value; + value =readl (&hw_addr[reg]);/* reads should not return all F's */
drivers/net/ethernet/intel/igc/igc_regs.h +4 -1
@@ -306,7 +306,8 @@ u32 igc_rd32(struct igc_hw *hw, u32 reg);#define wr32 (reg, val) \ do { \ u8 __iomem *hw_addr = READ_ONCE((hw)->hw_addr); \ - writel((val), &hw_addr[(reg)]); \ + if (!IGC_REMOVED(hw_addr)) \ + writel((val), &hw_addr[(reg)]); \ } while (0)#define rd32 (reg) (igc_rd32(hw, reg))
@@ -318,4 +319,6 @@ do { \#define array_rd32 (reg, offset) (igc_rd32(hw, (reg) + ((offset) << 2))) +#define IGC_REMOVED (h) unlikely(!(h)) +#endif
Signature · 5 lines
2.36.1 _______________________________________________ Intel-wired-lan mailing list [email protected] https://lists.osuosl.org/mailman/listinfo/intel-wired-lan
Quoted 72 lines · Lennert Buytenhek
The initially merged version of the igc driver code (via commit
146740f9abc4, "igc: Add support for PF") contained the followingIGC_REMOVEDchecks in the igc_rd32/wr32() MMIO accessors:u32 igc_rd32(struct igc_hw *hw, u32 reg) { u8 __iomem *hw_addr = READ_ONCE(hw->hw_addr); u32 value = 0; if (IGC_REMOVED(hw_addr)) return ~value; value = readl(&hw_addr[reg]); /* reads should not return all F's */ if (!(~value) && (!reg || !(~readl(hw_addr)))) hw->hw_addr = NULL; return value; }And:
#define wr32(reg, val) \ do { \ u8 __iomem *hw_addr = READ_ONCE((hw)->hw_addr); \ if (!IGC_REMOVED(hw_addr)) \ writel((val), &hw_addr[(reg)]); \ } while (0)E.g. igb has similar checks in its MMIO accessors, and has a similar macro
E1000_REMOVED, which is implemented as follows:#define E1000_REMOVED(h) unlikely(!(h))These checks serve to detect and take note of an
0xffffffffMMIO read return from the device, which can be caused by a PCIe link flap or some other kind of PCI bus error, and to avoid performing MMIO reads and writes from that point onwards.However, the
IGC_REMOVEDmacro was not originally implemented:#ifndef IGC_REMOVED #define IGC_REMOVED(a) (0) #endif /* IGC_REMOVED */This led to the
IGC_REMOVEDlogic to be removed entirely in a subsequent commit (commit3c215fb18e70, "igc: removeIGC_REMOVEDfunction"), with the rationale that such checks matter only for virtualization and that igc does not support virtualization -- but a PCIe device can become detached even without virtualization being in use, and without proper checks, a PCIe bus error affecting an igc adapter will lead to various NULL pointer dereferences, as the first access after the error will sethw->hw_addrto NULL, and subsequent accesses will blindly dereference this now-NULL pointer.This patch reinstates the
IGC_REMOVEDchecks in igc_rd32/wr32(), and implementsIGC_REMOVEDthe way it is done for igb, by checking for theunlikely()case ofhw_addrbeing NULL. This change prevents the oopses seen when a PCIe link flap occurs on an igc adapter.Fixes 146740f9abc4 ("igc: Add support for PF")Signed-off-by Lennert Buytenhek <[email protected]>---
As initially reported on intel-wired-lan@ in February:https://lists.osuosl.org/pipermail/intel-wired-lan/Week-of-Mon-20220214/027787.htmlWe're seeing these NULL pointer dereferences hit fairly reproducibly when rebooting, presumably due to the particularities of reset sequencing on the boards we see this hit on.
Quoted 7 lines
A link flap can be caused by toggling the Secondary Bus Reset bit in the upstream PCIe bridge's Bridge Control register and can reliably reproduce this problem.
drivers/net/ethernet/intel/igc/igc_main.c | 3 +++ drivers/net/ethernet/intel/igc/igc_regs.h | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-)
Quoted 109 lines · Lennert Buytenhek
The initially merged version of the igc driver code (via commit
146740f9abc4, "igc: Add support for PF") contained the followingIGC_REMOVEDchecks in the igc_rd32/wr32() MMIO accessors:u32 igc_rd32(struct igc_hw *hw, u32 reg) { u8 __iomem *hw_addr = READ_ONCE(hw->hw_addr); u32 value = 0; if (IGC_REMOVED(hw_addr)) return ~value; value = readl(&hw_addr[reg]); /* reads should not return all F's */ if (!(~value) && (!reg || !(~readl(hw_addr)))) hw->hw_addr = NULL; return value; }And:
#define wr32(reg, val) \ do { \ u8 __iomem *hw_addr = READ_ONCE((hw)->hw_addr); \ if (!IGC_REMOVED(hw_addr)) \ writel((val), &hw_addr[(reg)]); \ } while (0)E.g. igb has similar checks in its MMIO accessors, and has a similar macro
E1000_REMOVED, which is implemented as follows:#define E1000_REMOVED(h) unlikely(!(h))These checks serve to detect and take note of an
0xffffffffMMIO read return from the device, which can be caused by a PCIe link flap or some other kind of PCI bus error, and to avoid performing MMIO reads and writes from that point onwards.However, the
IGC_REMOVEDmacro was not originally implemented:#ifndef IGC_REMOVED #define IGC_REMOVED(a) (0) #endif /* IGC_REMOVED */This led to the
IGC_REMOVEDlogic to be removed entirely in a subsequent commit (commit3c215fb18e70, "igc: removeIGC_REMOVEDfunction"), with the rationale that such checks matter only for virtualization and that igc does not support virtualization -- but a PCIe device can become detached even without virtualization being in use, and without proper checks, a PCIe bus error affecting an igc adapter will lead to various NULL pointer dereferences, as the first access after the error will sethw->hw_addrto NULL, and subsequent accesses will blindly dereference this now-NULL pointer.This patch reinstates the
IGC_REMOVEDchecks in igc_rd32/wr32(), and implementsIGC_REMOVEDthe way it is done for igb, by checking for theunlikely()case ofhw_addrbeing NULL. This change prevents the oopses seen when a PCIe link flap occurs on an igc adapter.Fixes 146740f9abc4 ("igc: Add support for PF")Signed-off-by Lennert Buytenhek <[email protected]>---
As initially reported on intel-wired-lan@ in February:https://lists.osuosl.org/pipermail/intel-wired-lan/Week-of-Mon-20220214/027787.htmlWe're seeing these NULL pointer dereferences hit fairly reproducibly when rebooting, presumably due to the particularities of reset sequencing on the boards we see this hit on.
A link flap can be caused by toggling the Secondary Bus Reset bit in the upstream PCIe bridge's Bridge Control register and can reliably reproduce this problem.
drivers/net/ethernet/intel/igc/igc_main.c | 3 +++ drivers/net/ethernet/intel/igc/igc_regs.h | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-)drivers/net/ethernet/intel/igc/igc_main.c +3
-0@@ -6171,6 +6171,9 @@ u32 igc_rd32(struct igc_hw *hw, u32 reg)u8 __iomem *hw_addr =READ_ONCE (hw->hw_addr);u32 value =0 ; +if (IGC_REMOVED (hw_addr)) +return ~value; + value =readl (&hw_addr[reg]);/* reads should not return all F's */ drivers/net/ethernet/intel/igc/igc_regs.h +2
-1@@ -306,7 +306,8 @@ u32 igc_rd32(struct igc_hw *hw, u32 reg);#define wr32 (reg, val) \ do { \ u8 __iomem *hw_addr = READ_ONCE((hw)->hw_addr); \ - writel((val), &hw_addr[(reg)]); \ + if (!IGC_REMOVED(hw_addr)) \ + writel((val), &hw_addr[(reg)]); \ } while (0)#define rd32 (reg) (igc_rd32(hw, reg))
drivers/net/ethernet/intel/igc/igc_regs.h do { \ · line 324
Quoted 6 lines
drivers/net/ethernet/intel/igc/igc_regs.h +2
-0@@ -318,4 +319,6 @@ do { \#define array_rd32 (reg, offset) (igc_rd32(hw, (reg) + ((offset) << 2))) +#define IGC_REMOVED (h) unlikely(!(h)) +#endif