pci: fix a -Wtype-limits compilation warning
PATCH 1/1 pci: fix a -Wtype-limits compilation warning
The commit a7d06153eea2 ("PCI: Fix pci_add_dma_alias() bitmask size") introduced a compilation warning and a potential infinite loop because it is no longer possible to be self-terminated as u8 is always less than 256,
In file included from ./include/linux/kernel.h:12,
from ./include/asm-generic/bug.h:19,
from ./arch/x86/include/asm/bug.h:83,
from ./include/linux/bug.h:5,
from ./include/linux/jump_label.h:250,
from ./arch/x86/include/asm/string_64.h:6,
from ./arch/x86/include/asm/string.h:5,
from ./include/linux/string.h:20,
from ./include/linux/uuid.h:12,
from ./include/linux/mod_devicetable.h:13,
from ./include/linux/pci.h:27,
from drivers/pci/search.c:11:
drivers/pci/search.c: In function 'pci_for_each_dma_alias':
./include/linux/bitops.h:30:13: warning: comparison is always true due
to limited range of data type [-Wtype-limits]
(bit) < (size); \
^drivers/pci/search.c:46:3: note: in expansion of macro 'for_each_set_bit'
for_each_set_bit(devfn, pdev->dma_alias_mask, MAX_NR_DEVFNS) {
Fixed it by using u16 for "devfn" in this occasion.
--- drivers/pci/search.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/pci/search.c +1 -1
@@ -41,7 +41,7 @@ int pci_for_each_dma_alias(struct pci_dev *pdev,* DMA, iterate over that too. */ if (unlikely (pdev->dma_alias_mask)) { -u8 devfn; +u16 devfn;for_each_set_bit (devfn, pdev->dma_alias_mask,MAX_NR_DEVFNS ) { ret = fn(pdev, PCI_DEVID(pdev->bus->number, devfn),
Signature · 1 line
2.21.0 (Apple Git-122.2)
Quoted 22 lines · Qian Cai
The commit
a7d06153eea2("PCI: Fixpci_add_dma_alias()bitmask size") introduced a compilation warning and a potential infinite loop because it is no longer possible to be self-terminated as u8 is always less than 256,In file included from
./include/linux/kernel.h:12,from ./include/asm-generic/bug.h:19, from ./arch/x86/include/asm/bug.h:83, from ./include/linux/bug.h:5, from ./include/linux/jump_label.h:250, from ./arch/x86/include/asm/string_64.h:6, from ./arch/x86/include/asm/string.h:5, from ./include/linux/string.h:20, from ./include/linux/uuid.h:12, from ./include/linux/mod_devicetable.h:13, from ./include/linux/pci.h:27, from drivers/pci/search.c:11: drivers/pci/search.c: In function 'pci_for_each_dma_alias': ./include/linux/bitops.h:30:13: warning: comparison is always true due to limited range of data type [-Wtype-limits] (bit) < (size); \ ^
Quoted 7 lines
drivers/pci/search.c:46:3: note: in expansion of macro 'for_each_set_bit'
for_each_set_bit(devfn, pdev->dma_alias_mask, MAX_NR_DEVFNS){Fixed it by using u16 for "devfn" in this occasion.
Fixes a7d06153eea2 ("PCI: Fix pci_add_dma_alias() bitmask size")Signed-off-by Qian Cai <[email protected]>
Makes sense to me,
Quoted 18 lines
--- drivers/pci/search.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/pci/search.c +1
-1@@ -41,7 +41,7 @@ int pci_for_each_dma_alias(struct pci_dev *pdev,* DMA, iterate over that too. */ if (unlikely (pdev->dma_alias_mask)) { -u8 devfn; +u16 devfn;for_each_set_bit (devfn, pdev->dma_alias_mask,MAX_NR_DEVFNS ) { ret = fn(pdev, PCI_DEVID(pdev->bus->number, devfn),
Quoted 22 lines · Qian Cai
The commit
a7d06153eea2("PCI: Fixpci_add_dma_alias()bitmask size") introduced a compilation warning and a potential infinite loop because it is no longer possible to be self-terminated as u8 is always less than 256,In file included from
./include/linux/kernel.h:12,from ./include/asm-generic/bug.h:19, from ./arch/x86/include/asm/bug.h:83, from ./include/linux/bug.h:5, from ./include/linux/jump_label.h:250, from ./arch/x86/include/asm/string_64.h:6, from ./arch/x86/include/asm/string.h:5, from ./include/linux/string.h:20, from ./include/linux/uuid.h:12, from ./include/linux/mod_devicetable.h:13, from ./include/linux/pci.h:27, from drivers/pci/search.c:11: drivers/pci/search.c: In function 'pci_for_each_dma_alias': ./include/linux/bitops.h:30:13: warning: comparison is always true due to limited range of data type [-Wtype-limits] (bit) < (size); \ ^
Quoted 4 lines
drivers/pci/search.c:46:3: note: in expansion of macro 'for_each_set_bit'
for_each_set_bit(devfn, pdev->dma_alias_mask, MAX_NR_DEVFNS){Fixed it by using u16 for "devfn" in this occasion.
Ugh, that is pretty subtle! Would you mind if we used "unsigned int" instead of "u16"? "u16" makes it look like just a mistake -- somebody is likely to come along and say devfn only needs "u8" and try to change it back. The same might happen with "unsigned int", but at least it doesn't look like it was chosen specifically to fit a devfn.
Provisional patch below.
Quoted 21 lines
Fixes a7d06153eea2 ("PCI: Fix pci_add_dma_alias() bitmask size")Signed-off-by Qian Cai <[email protected]>--- drivers/pci/search.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/pci/search.c +1
-1@@ -41,7 +41,7 @@ int pci_for_each_dma_alias(struct pci_dev *pdev,* DMA, iterate over that too. */ if (unlikely (pdev->dma_alias_mask)) { -u8 devfn; +u16 devfn;for_each_set_bit (devfn, pdev->dma_alias_mask,MAX_NR_DEVFNS ) { ret = fn(pdev, PCI_DEVID(pdev->bus->number, devfn),Signature · 1 line
2.21.0 (Apple Git-122.2)
commit f8bf2aeb651b ("PCI: Fix pci_add_dma_alias() bitmask size")
Author: James Sewart <[email protected]> Date: Tue Dec 10 15:51:33 2019 -0600
PCI: Fix pci_add_dma_alias() bitmask size
The number of possible devfns is 256, but pci_add_dma_alias() allocated a bitmap of size 255. Fix this off-by-one error.
This fixes commits 338c3149a221 ("PCI: Add support for multiple DMA aliases") and c6635792737b ("PCI: Allocate dma_alias_mask with bitmap_zalloc()"), but I doubt it was possible to see a problem because it takes 4 64-bit longs (or 8 32-bit longs) to hold 255 bits, and bitmap_zalloc() doesn't save the 255-bit size anywhere.
[bhelgaas: commit log, move #define to drivers/pci/pci.h, include loop limit fix from Qian Cai:
https://lore.kernel.org/r/[email protected]]
drivers/pci/pci.c +1 -1
@@ -6017,7 +6017,7 @@ EXPORT_SYMBOL_GPL(pci_pr3_present);void pci_add_dma_alias (struct pci_dev *dev,u8 devfn) {if (!dev->dma_alias_mask) - dev->dma_alias_mask =bitmap_zalloc (U8_MAX ,GFP_KERNEL ); + dev->dma_alias_mask =bitmap_zalloc (MAX_NR_DEVFNS ,GFP_KERNEL );if (!dev->dma_alias_mask) {pci_warn (dev,"Unable to allocate DMA alias mask\n" );return ;
drivers/pci/pci.h +3 -0
@@ -4,6 +4,9 @@#include <linux/pci.h> +/* Number of possible devfns: 0.0 to 1f.7 inclusive */ +#define MAX_NR_DEVFNS 256 +#define PCI_FIND_CAP_TTL 48#define PCI_VSEC_ID_INTEL_TBT 0x1234/* Thunderbolt */
drivers/pci/search.c +2 -2
@@ -41,9 +41,9 @@ int pci_for_each_dma_alias(struct pci_dev *pdev,* DMA, iterate over that too. */ if (unlikely (pdev->dma_alias_mask)) { -u8 devfn; +unsigned int devfn; -for_each_set_bit (devfn, pdev->dma_alias_mask,U8_MAX ) { +for_each_set_bit (devfn, pdev->dma_alias_mask,MAX_NR_DEVFNS ) { ret =fn (pdev,PCI_DEVID (pdev->bus->number, devfn), data);if (ret)
Quoted 26 lines · Bjorn Helgaas
Quoted 25 lines · Qian Cai
The commit
a7d06153eea2("PCI: Fixpci_add_dma_alias()bitmask size") introduced a compilation warning and a potential infinite loop because it is no longer possible to be self-terminated as u8 is always less than 256,In file included from
./include/linux/kernel.h:12,from ./include/asm-generic/bug.h:19, from ./arch/x86/include/asm/bug.h:83, from ./include/linux/bug.h:5, from ./include/linux/jump_label.h:250, from ./arch/x86/include/asm/string_64.h:6, from ./arch/x86/include/asm/string.h:5, from ./include/linux/string.h:20, from ./include/linux/uuid.h:12, from ./include/linux/mod_devicetable.h:13, from ./include/linux/pci.h:27, from drivers/pci/search.c:11: drivers/pci/search.c: In function 'pci_for_each_dma_alias': ./include/linux/bitops.h:30:13: warning: comparison is always true due to limited range of data type [-Wtype-limits] (bit) < (size); \ ^
drivers/pci/search.c:46:3: note: in expansion of macro 'for_each_set_bit'
for_each_set_bit(devfn, pdev->dma_alias_mask, MAX_NR_DEVFNS){
Quoted 7 lines
Quoted 1 line
Fixed it by using u16 for "devfn" in this occasion.
Ugh, that is pretty subtle! Would you mind if we used "unsigned int" instead of "u16"? "u16" makes it look like just a mistake -- somebody is likely to come along and say devfn only needs "u8" and try to change it back. The same might happen with "unsigned int", but at least it doesn't look like it was chosen specifically to fit a devfn.
I agree: you're right that we really don't need an int that's specifically sized here. There's really shouldn't be any gain in using a smaller integer, in theory "int" should be the most "efficient" anyway, just using a full register in hardware.
Logan
Quoted 90 lines
Provisional patch below.
Quoted 21 lines
Fixes a7d06153eea2 ("PCI: Fix pci_add_dma_alias() bitmask size")Signed-off-by Qian Cai <[email protected]>--- drivers/pci/search.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/pci/search.c +1
-1@@ -41,7 +41,7 @@ int pci_for_each_dma_alias(struct pci_dev *pdev,* DMA, iterate over that too. */ if (unlikely (pdev->dma_alias_mask)) { -u8 devfn; +u16 devfn;for_each_set_bit (devfn, pdev->dma_alias_mask,MAX_NR_DEVFNS ) { ret = fn(pdev, PCI_DEVID(pdev->bus->number, devfn),Signature · 1 line
2.21.0 (Apple Git-122.2)commit
f8bf2aeb651b("PCI: Fixpci_add_dma_alias()bitmask size")Author: James Sewart <[email protected]> Date: Tue Dec 10 15:51:33 2019 -0600PCI: Fix
pci_add_dma_alias()bitmask sizeThe number of possible devfns is 256, but
pci_add_dma_alias()allocated a bitmap of size 255. Fix this off-by-one error.This fixes commits
338c3149a221("PCI: Add support for multiple DMA aliases") andc6635792737b("PCI: Allocatedma_alias_maskwithbitmap_zalloc()"), but I doubt it was possible to see a problem because it takes 4 64-bit longs (or 8 32-bit longs) to hold 255 bits, andbitmap_zalloc()doesn't save the 255-bit size anywhere.[bhelgaas: commit log, move #define to
drivers/pci/pci.h, include loop limit fix from Qian Cai:
https://lore.kernel.org/r/[email protected]]Signed-off-by James Sewart <[email protected]>Signed-off-by Bjorn Helgaas <[email protected]>Reviewed-by Logan Gunthorpe <[email protected]>drivers/pci/pci.c +1
-1@@ -6017,7 +6017,7 @@ EXPORT_SYMBOL_GPL(pci_pr3_present);void pci_add_dma_alias (struct pci_dev *dev,u8 devfn) {if (!dev->dma_alias_mask) - dev->dma_alias_mask =bitmap_zalloc (U8_MAX ,GFP_KERNEL ); + dev->dma_alias_mask =bitmap_zalloc (MAX_NR_DEVFNS ,GFP_KERNEL );if (!dev->dma_alias_mask) {pci_warn (dev,"Unable to allocate DMA alias mask\n" );return ;drivers/pci/pci.h +3
-0@@ -4,6 +4,9 @@#include <linux/pci.h> +/* Number of possible devfns: 0.0 to 1f.7 inclusive */ +#define MAX_NR_DEVFNS 256 +#define PCI_FIND_CAP_TTL 48#define PCI_VSEC_ID_INTEL_TBT 0x1234/* Thunderbolt */ drivers/pci/search.c +2
-2@@ -41,9 +41,9 @@ int pci_for_each_dma_alias(struct pci_dev *pdev,* DMA, iterate over that too. */ if (unlikely (pdev->dma_alias_mask)) { -u8 devfn; +unsigned int devfn; -for_each_set_bit (devfn, pdev->dma_alias_mask,U8_MAX ) { +for_each_set_bit (devfn, pdev->dma_alias_mask,MAX_NR_DEVFNS ) { ret =fn (pdev,PCI_DEVID (pdev->bus->number, devfn), data);if (ret)
Quoted 11 lines · Bjorn Helgaas
Ugh, that is pretty subtle! Would you mind if we used "unsigned int" instead of "u16"? "u16" makes it look like just a mistake -- somebody is likely to come along and say devfn only needs "u8" and try to change it back. The same might happen with "unsigned int", but at least it doesn't look like it was chosen specifically to fit a devfn.
Provisional patch below.
Looks good to me.