Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <e092f27243feeeec282ef8fdab57d8f9ee88a32d.camel@perches.com>
Subject: Re: [PATCH 1/1] checkpatch: recognise NOKPROBE_SYMBOL for blank
 line detection after function/struct/union/enum
From:   Joe Perches <joe@perches.com>
To:     Christian Borntraeger <borntraeger@linux.ibm.com>,
        Andy Whitcroft <apw@canonical.com>
Cc:     Dwaipayan Ray <dwaipayanray1@gmail.com>,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>,
        linux-kernel@vger.kernel.org,
        kernel-janitors <kernel-janitors@vger.kernel.org>
Date:   Fri, 20 Jan 2023 08:10:52 -0800
In-Reply-To: <20230120114649.117018-1-borntraeger@linux.ibm.com>
References: <20230120114649.117018-1-borntraeger@linux.ibm.com>
Content-Type: text/plain; charset="ISO-8859-1"
Content-Transfer-Encoding: 8BIT
User-Agent: Evolution 3.44.4 (3.44.4-2.fc36) 
MIME-Version: 1.0
Precedence: bulk

On Fri, 2023-01-20 at 12:46 +0100, Christian Borntraeger wrote:
> NOKPROBE_SYMBOL should be treated like EXPORT_SYMBOL to avoid
> false positives.
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -3995,6 +3995,7 @@ sub process {
>  		    $line =~ /^\+/ &&
>  		    !($line =~ /^\+\s*$/ ||
>  		      $line =~ /^\+\s*(?:EXPORT_SYMBOL|early_param)/ ||
> +		      $line =~ /^\+\s*NOKPROBE_SYMBOL/ ||
>  		      $line =~ /^\+\s*MODULE_/i ||
>  		      $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
>  		      $line =~ /^\+[a-z_]*init/ ||

$ git grep -P -w -oh '\w*NOKPROBE_SYMBOL\w*' | sort | uniq -c
     60 _ASM_NOKPROBE_SYMBOL
      2 __NOKPROBE_SYMBOL
    304 NOKPROBE_SYMBOL

Any issue with these other variants? (it doesn't seem so)

btw: __NOKPROBE_SYMBOL has a ; at the end of its definition.

include/asm-generic/kprobes.h:# define __NOKPROBE_SYMBOL(fname)                         \
include/asm-generic/kprobes.h-static unsigned long __used                                       \
include/asm-generic/kprobes.h-  __section("_kprobe_blacklist")                          \
include/asm-generic/kprobes.h-  _kbl_addr_##fname = (unsigned long)fname;

And so there are extra ; uses after ever use of NOKPROBE_SYMBOL(foo);

$ git grep -w NOKPROBE_SYMBOL | grep ';' | wc -l
285

There are only 10 uses of NOKPROBE_SYMBOL(foo) without a semicolon

$ git grep -P '\bNOKPROBE_SYMBOL\s*\(\s*\w+\s*\)\s*(?:[^\;]|$)'
arch/arm/kernel/traps.c:NOKPROBE_SYMBOL(do_undefinstr)
arch/arm/probes/kprobes/opt-arm.c:NOKPROBE_SYMBOL(optimized_callback)
arch/arm64/kernel/kgdb.c:NOKPROBE_SYMBOL(kgdb_brk_fn)
arch/powerpc/mm/cacheflush.c:NOKPROBE_SYMBOL(flush_dcache_icache_phys)
arch/powerpc/platforms/82xx/pq2.c:NOKPROBE_SYMBOL(pq2_restart)
include/asm-generic/kprobes.h:# define NOKPROBE_SYMBOL(fname)   __NOKPROBE_SYMBOL(fname)
include/asm-generic/kprobes.h:# define NOKPROBE_SYMBOL(fname)
kernel/fail_function.c:NOKPROBE_SYMBOL(fei_kprobe_handler)
kernel/kprobes.c:NOKPROBE_SYMBOL(__kretprobe_trampoline_handler)
kernel/trace/trace_eprobe.c:NOKPROBE_SYMBOL(process_fetch_insn)
kernel/trace/trace_kprobe.c:NOKPROBE_SYMBOL(process_fetch_insn)
kernel/trace/trace_uprobe.c:NOKPROBE_SYMBOL(process_fetch_insn)

The actual uses with NOKPROBE_SYMBOL(foo) should likely have semicolons added
and the __NOKPROBE_SYMBOL definition should have the semicolon removed.