[PATCH] devtools: suppress checkpatch warning on some kernel macro

[PATCH] devtools: suppress checkpatch warning on some kernel macro

[David Marchand]

Kernel checkpatch.pl is confused about RTE_BUILD_BUG_ON() and warns as if
our code was calling the kernel macro BUG_ON().

This does not make sense in the DPDK userspace code and the Linux kernel
module hosted in our repository (kernel/linux/kni) won't make it upstream.

Disable this warning.

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 devtools/checkpatches.sh | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index a07bbc83cb..4eac45036a 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -33,7 +33,7 @@ VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,STRLCPY,\
 PREFER_KERNEL_TYPES,PREFER_FALLTHROUGH,BIT_MACRO,CONST_STRUCT,\
 SPLIT_STRING,LONG_LINE_STRING,C99_COMMENT_TOLERANCE,\
 LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
-NEW_TYPEDEFS,COMPARISON_TO_NULL"
+NEW_TYPEDEFS,COMPARISON_TO_NULL,AVOID_BUG"
 options="$options $DPDK_CHECKPATCH_OPTIONS"
 
 print_usage () {
-- 
2.39.2

Re: [PATCH] devtools: suppress checkpatch warning on some kernel macro

[Ferruh Yigit]

On 4/4/2023 1:36 PM, David Marchand wrote:
> Kernel checkpatch.pl is confused about RTE_BUILD_BUG_ON() and warns as if
> our code was calling the kernel macro BUG_ON().
> 
> This does not make sense in the DPDK userspace code and the Linux kernel
> module hosted in our repository (kernel/linux/kni) won't make it upstream.
> 
> Disable this warning.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>

Sounds reasonable,
Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>


Is there any occurrence in the public CI, as reference?

Re: [PATCH] devtools: suppress checkpatch warning on some kernel macro

[David Marchand]

On Tue, Apr 4, 2023 at 3:01 PM Ferruh Yigit <ferruh.yigit@amd.com> wrote:
>
> On 4/4/2023 1:36 PM, David Marchand wrote:
> > Kernel checkpatch.pl is confused about RTE_BUILD_BUG_ON() and warns as if
> > our code was calling the kernel macro BUG_ON().
> >
> > This does not make sense in the DPDK userspace code and the Linux kernel
> > module hosted in our repository (kernel/linux/kni) won't make it upstream.
> >
> > Disable this warning.
> >
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
>
> Sounds reasonable,
> Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
>
>
> Is there any occurrence in the public CI, as reference?

I caught it when preparing submission of:
https://patchwork.dpdk.org/project/dpdk/patch/20230404124840.1898-2-david.marchand@redhat.com/
dpdk.org checkpath did not catch it, so it is probably lagging a bit.


For reference, in my environment, this looks like:
### [PATCH] malloc: rework heap destroy

WARNING:AVOID_BUG: Do not crash the kernel unless it is absolutely
unavoidable--use WARN_ON_ONCE() plus recovery code (if feasible)
instead of BUG() or variants
#23: FILE: lib/eal/common/malloc_heap.c:1389:
+    RTE_BUILD_BUG_ON(offsetof(struct malloc_heap, lock) != 0);

total: 0 errors, 1 warnings, 23 lines checked

0/1 valid patch


-- 
David Marchand

Re: [PATCH] devtools: suppress checkpatch warning on some kernel macro

[Thomas Monjalon]

04/04/2023 15:00, Ferruh Yigit:
> On 4/4/2023 1:36 PM, David Marchand wrote:
> > Kernel checkpatch.pl is confused about RTE_BUILD_BUG_ON() and warns as if
> > our code was calling the kernel macro BUG_ON().
> > 
> > This does not make sense in the DPDK userspace code and the Linux kernel
> > module hosted in our repository (kernel/linux/kni) won't make it upstream.
> > 
> > Disable this warning.
> > 
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
> 
> Sounds reasonable,
> Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>

Applied, thanks.