PCI/AER: Use for_each_set_bit()
Subsystems (2)
PATCH 1/2 PCI/AER: Use for_each_set_bit()
This simplifies and standardizes slot manipulation code by using for_each_set_bit() library function.
--- drivers/pci/pcie/aer.c | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-)
drivers/pci/pcie/aer.c +8 -11
@@ -15,6 +15,7 @@#define pr_fmt (fmt) "AER: " fmt#define dev_fmt pr_fmt +#include <linux/bitops.h> #include <linux/cper.h> #include <linux/pci.h> #include <linux/pci-acpi.h>
@@ -657,7 +658,8 @@ const struct attribute_group aer_stats_attr_group = {static void pci_dev_aer_stats_incr (struct pci_dev *pdev,struct aer_err_info *info) { -int status, i, max =-1 ; +unsigned long status = info->status & ~info->mask; +int i, max =-1 ;u64 *counter =NULL ;struct aer_stats *aer_stats = pdev->aer_stats;
@@ -682,10 +684,8 @@ static void pci_dev_aer_stats_incr(struct pci_dev *pdev,break ; } - status = (info->status & ~info->mask); -for (i =0 ; i < max; i++) -if (status & (1 << i)) - counter[i]++; +for_each_set_bit (i, &status, max) + counter[i]++; } static void pci_rootport_aer_stats_incr(struct pci_dev *pdev,
@@ -717,14 +717,11 @@ static void __print_tlp_header(struct pci_dev *dev,static void __aer_print_error (struct pci_dev *dev,struct aer_err_info *info) { -int i, status; +unsigned long status = info->status & ~info->mask;const char *errmsg =NULL ; - status = (info->status & ~info->mask); - -for (i =0 ; i <32 ; i++) { -if (!(status & (1 << i))) -continue ; +int i; +for_each_set_bit (i, &status,32 ) {if (info->severity ==AER_CORRECTABLE ) errmsg = i <ARRAY_SIZE (aer_correctable_error_string) ? aer_correctable_error_string[i] :NULL ;
Signature · 1 line
2.23.0.rc1
PATCH 2/2 PCI/AER: Update parameter descriptions to satisfy kernel-doc validator
Kernel-doc validator complains:
aer.c:207: warning: Function parameter or member 'str' not described in 'pcie_ecrc_get_policy' aer.c:1209: warning: Function parameter or member 'irq' not described in 'aer_isr' aer.c:1209: warning: Function parameter or member 'context' not described in 'aer_isr' aer.c:1209: warning: Excess function parameter 'work' description in 'aer_isr'
Fix the above accordingly.
--- drivers/pci/pcie/aer.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
drivers/pci/pcie/aer.c +3 -1
@@ -202,6 +202,7 @@ void pcie_set_ecrc_checking(struct pci_dev *dev)/** * pcie_ecrc_get_policy - parse kernel command-line ecrc option +* @str: ECRC policy from kernel command line to use */ void pcie_ecrc_get_policy (char *str) {
@@ -1201,7 +1202,8 @@ static void aer_isr_one_error(struct aer_rpc *rpc,/** * aer_isr - consume errors detected by root port -* @work: definition of this work item +* @irq: IRQ assigned to Root Port +* @context: pointer to Root Port data structure * * Invoked, as DPC, when root port records new detected error */
Signature · 1 line
2.23.0.rc1
Re: [PATCH v1 2/2] PCI/AER: Update parameter descriptions to satisfy kernel-doc validator
Quoted 10 lines · Andy Shevchenko
Kernel-doc validator complains:
aer.c:207: warning: Function parameter or member 'str' not described in '
pcie_ecrc_get_policy' aer.c:1209: warning: Function parameter or member 'irq' not described in 'aer_isr' aer.c:1209: warning: Function parameter or member 'context' not described in 'aer_isr' aer.c:1209: warning: Excess function parameter 'work' description in 'aer_isr'Fix the above accordingly.
Signed-off-by Andy Shevchenko <[email protected]>
Quoted 26 lines
--- drivers/pci/pcie/aer.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)drivers/pci/pcie/aer.c +3
-1@@ -202,6 +202,7 @@ void pcie_set_ecrc_checking(struct pci_dev *dev)/** * pcie_ecrc_get_policy - parse kernel command-line ecrc option +* @str: ECRC policy from kernel command line to use */ void pcie_ecrc_get_policy (char *str) {@@ -1201,7 +1202,8 @@ static void aer_isr_one_error(struct aer_rpc *rpc,/** * aer_isr - consume errors detected by root port -* @work: definition of this work item +* @irq: IRQ assigned to Root Port +* @context: pointer to Root Port data structure * * Invoked, as DPC, when root port records new detected error */
Signature · 2 lines
Sathyanarayanan Kuppuswamy Linux kernel developer
Re: [PATCH v1 2/2] PCI/AER: Update parameter descriptions to satisfy kernel-doc validator
Quoted 9 lines · Kuppuswamy Sathyanarayanan
Quoted 7 lines · Andy Shevchenko
Kernel-doc validator complains:
aer.c:207: warning: Function parameter or member 'str' not described in '
pcie_ecrc_get_policy' aer.c:1209: warning: Function parameter or member 'irq' not described in 'aer_isr' aer.c:1209: warning: Function parameter or member 'context' not described in 'aer_isr' aer.c:1209: warning: Excess function parameter 'work' description in 'aer_isr'
Quoted 6 lines
Quoted 3 lines
Fix the above accordingly.
Signed-off-by Andy Shevchenko <[email protected]>Reviewed-by: Kuppuswamy Sathyanarayanan
<[email protected]>
Thanks!
JFYI: Keep your tag on one line. Some bots require this IIRC (patchwork).
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 4 lines · Andy Shevchenko
This simplifies and standardizes slot manipulation code by using
for_each_set_bit()library function.Signed-off-by Andy Shevchenko <[email protected]>
Quoted 57 lines
--- drivers/pci/pcie/aer.c | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-)drivers/pci/pcie/aer.c +8
-11@@ -15,6 +15,7 @@#define pr_fmt (fmt) "AER: " fmt#define dev_fmt pr_fmt +#include <linux/bitops.h> #include <linux/cper.h> #include <linux/pci.h> #include <linux/pci-acpi.h> @@ -657,7 +658,8 @@ const struct attribute_group aer_stats_attr_group = {static void pci_dev_aer_stats_incr (struct pci_dev *pdev,struct aer_err_info *info) { -int status, i, max =-1 ; +unsigned long status = info->status & ~info->mask; +int i, max =-1 ;u64 *counter =NULL ;struct aer_stats *aer_stats = pdev->aer_stats;@@ -682,10 +684,8 @@ static void pci_dev_aer_stats_incr(struct pci_dev *pdev,break ; } - status = (info->status & ~info->mask); -for (i =0 ; i < max; i++) -if (status & (1 << i)) - counter[i]++; +for_each_set_bit (i, &status, max) + counter[i]++; } static void pci_rootport_aer_stats_incr(struct pci_dev *pdev,@@ -717,14 +717,11 @@ static void __print_tlp_header(struct pci_dev *dev,static void __aer_print_error (struct pci_dev *dev,struct aer_err_info *info) { -int i, status; +unsigned long status = info->status & ~info->mask;const char *errmsg =NULL ; - status = (info->status & ~info->mask); - -for (i =0 ; i <32 ; i++) { -if (!(status & (1 << i))) -continue ; +int i; +for_each_set_bit (i, &status,32 ) {if (info->severity ==AER_CORRECTABLE ) errmsg = i <ARRAY_SIZE (aer_correctable_error_string) ? aer_correctable_error_string[i] :NULL ;
Signature · 2 lines
Sathyanarayanan Kuppuswamy Linux kernel developer
Bjorn Helgaas
AppliedQuoted 4 lines · Andy Shevchenko
This simplifies and standardizes slot manipulation code by using
for_each_set_bit()library function.Signed-off-by Andy Shevchenko <[email protected]>
Applied both with Kuppuswamy's reviewed-by to pci/aer for v5.5, thanks!
Quoted 60 lines
--- drivers/pci/pcie/aer.c | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-)drivers/pci/pcie/aer.c +8
-11@@ -15,6 +15,7 @@#define pr_fmt (fmt) "AER: " fmt#define dev_fmt pr_fmt +#include <linux/bitops.h> #include <linux/cper.h> #include <linux/pci.h> #include <linux/pci-acpi.h> @@ -657,7 +658,8 @@ const struct attribute_group aer_stats_attr_group = {static void pci_dev_aer_stats_incr (struct pci_dev *pdev,struct aer_err_info *info) { -int status, i, max =-1 ; +unsigned long status = info->status & ~info->mask; +int i, max =-1 ;u64 *counter =NULL ;struct aer_stats *aer_stats = pdev->aer_stats;@@ -682,10 +684,8 @@ static void pci_dev_aer_stats_incr(struct pci_dev *pdev,break ; } - status = (info->status & ~info->mask); -for (i =0 ; i < max; i++) -if (status & (1 << i)) - counter[i]++; +for_each_set_bit (i, &status, max) + counter[i]++; } static void pci_rootport_aer_stats_incr(struct pci_dev *pdev,@@ -717,14 +717,11 @@ static void __print_tlp_header(struct pci_dev *dev,static void __aer_print_error (struct pci_dev *dev,struct aer_err_info *info) { -int i, status; +unsigned long status = info->status & ~info->mask;const char *errmsg =NULL ; - status = (info->status & ~info->mask); - -for (i =0 ; i <32 ; i++) { -if (!(status & (1 << i))) -continue ; +int i; +for_each_set_bit (i, &status,32 ) {if (info->severity ==AER_CORRECTABLE ) errmsg = i <ARRAY_SIZE (aer_correctable_error_string) ? aer_correctable_error_string[i] :NULL ;Signature · 1 line
2.23.0.rc1
Quoted 31 lines · Andy Shevchenko
This simplifies and standardizes slot manipulation code by using
for_each_set_bit()library function.Signed-off-by Andy Shevchenko <[email protected]>--- drivers/pci/pcie/aer.c | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-)drivers/pci/pcie/aer.c +3
-1@@ -15,6 +15,7 @@#define pr_fmt (fmt) "AER: " fmt#define dev_fmt pr_fmt +#include <linux/bitops.h> #include <linux/cper.h> #include <linux/pci.h> #include <linux/pci-acpi.h> @@ -657,7 +658,8 @@ const struct attribute_group aer_stats_attr_group = {static void pci_dev_aer_stats_incr (struct pci_dev *pdev,struct aer_err_info *info) { -int status, i, max =-1 ; +unsigned long status = info->status & ~info->mask; +int i, max =-1 ;u64 *counter =NULL ;struct aer_stats *aer_stats = pdev->aer_stats;
drivers/pci/pcie/aer.c static void pci_dev_aer_stats_incr(struct pci_dev *pdev, · line 687
Quoted 8 lines
drivers/pci/pcie/aer.c +1
-4@@ -682,10 +684,8 @@ static void pci_dev_aer_stats_incr(struct pci_dev *pdev,break ; } - status = (info->status & ~info->mask); -for (i =0 ; i < max; i++) -if (status & (1 << i)) - counter[i]++; +for_each_set_bit (i, &status, max)
I applied this, but I confess to being a little ambivalent. It's arguably a little easier to read, but it's not nearly as efficient (not a great concern here) and more importantly much harder to verify that it's correct because you have to chase through for_each_set_bit(), find_first_bit(), _ffs(), etc, etc. No doubt it's great for bitmaps of arbitrary size, but for a simple 32-bit register I'm a little hesitant. But I applied it anyway.
Quoted 25 lines
drivers/pci/pcie/aer.c +4
-6+ counter[i]++; } static void pci_rootport_aer_stats_incr(struct pci_dev *pdev,@@ -717,14 +717,11 @@ static void __print_tlp_header(struct pci_dev *dev,static void __aer_print_error (struct pci_dev *dev,struct aer_err_info *info) { -int i, status; +unsigned long status = info->status & ~info->mask;const char *errmsg =NULL ; - status = (info->status & ~info->mask); - -for (i =0 ; i <32 ; i++) { -if (!(status & (1 << i))) -continue ; +int i; +for_each_set_bit (i, &status,32 ) {if (info->severity ==AER_CORRECTABLE ) errmsg = i <ARRAY_SIZE (aer_correctable_error_string) ? aer_correctable_error_string[i] :NULL ;Signature · 1 line
2.23.0.rc1
Quoted 7 lines · Bjorn Helgaas
Quoted 5 lines · Andy Shevchenko
This simplifies and standardizes slot manipulation code by using
for_each_set_bit()library function.drivers/pci/pcie/aer.c +2
-0+unsigned long status = info->status & ~info->mask; +int i, max =-1 ;
Quoted 6 lines
drivers/pci/pcie/aer.c static void pci_dev_aer_stats_incr(struct pci_dev *pdev, · line 687
Quoted 4 lines
drivers/pci/pcie/aer.c +1
-3-for (i =0 ; i < max; i++) -if (status & (1 << i)) - counter[i]++; +for_each_set_bit (i, &status, max)I applied this,
Thank you!
Quoted 2 lines
but I confess to being a little ambivalent. It's
arguably a little easier to read,
I have another opinion here. Instead of parsing body of for-loop, the name of the function tells you exactly what it's done. Besides the fact that reading and parsing two lines, with zero conditionals, is faster.
Quoted 2 lines
but it's not nearly as efficient
(not a great concern here)
David, do you know why for_each_set_bit() has no optimization for the cases when nbits <= BITS_PER_LONG? (Actually find_*bit() family of functions)
Quoted 3 lines
and more importantly much harder to verify that it's correct because you have to chase through
for_each_set_bit(),find_first_bit(),_ffs(), etc, etc.
If for_each_set_bit() or any other fundamental bit operation helper is broken, PCI subsystem is a little concern here.
Quoted 5 lines
No doubt it's
great for bitmaps of arbitrary size, but for a simple 32-bit register I'm a little hesitant. But I applied it anyway.Quoted 1 line
drivers/pci/pcie/aer.c +1
-0+ counter[i]++;
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 7 lines · Andy Shevchenko
Quoted 2 lines
but I confess to being a little ambivalent. It's
arguably a little easier to read,I have another opinion here. Instead of parsing body of for-loop, the name of the function tells you exactly what it's done. Besides the fact that reading and parsing two lines, with zero conditionals, is faster.
Quoted 5 lines
Quoted 2 lines
but it's not nearly as efficient
(not a great concern here)David, do you know why
for_each_set_bit()has no optimization for the cases when nbits <=BITS_PER_LONG? (Actually find_*bit() family of functions)
I've not had anything to do with for_each_set_bit() itself.
By 'nbits', I presume you mean the size parameter - max in the sample bit of code.
It would need per-arch optimisation. Some arches have an instruction to find the next bit and some don't.
Using for_each_set_bit() like this is definitely suboptimal, since find_first_bit() and find_next_bit() may well be out of line.
It should probably be using something like __ffs() if size <= BITS_PER_LONG.
David