Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Date:   Tue, 14 Sep 2021 18:05:12 +0200
From:   Niklas =?iso-8859-1?Q?S=F6derlund?= 
        <niklas.soderlund@corigine.com>
To:     Joe Perches <joe@perches.com>
Cc:     Andy Whitcroft <apw@canonical.com>, linux-kernel@vger.kernel.org
Subject: False positive for 'Possible unnecessary KERN_ERR' warning in
 checkpatch
Message-ID: <YUDIOLTCe0/kzVSW@bismarck.dyn.berto.se>
Content-Type: text/plain; charset=iso-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?iso-8859-1?Q?1DINHYzL0XuwR/oAluowOxFMkIwhtHhw8+SKXRyYzJvtu8WkjE2DwTAuqd?=
 =?iso-8859-1?Q?kqFjfzOlxEXGZ+7wQbTX/38phux3dgHNzR4AwQYD1KDyZvZHBYFfJIRNqX?=
 =?iso-8859-1?Q?g1YD6m8QQyB1sPIrTFf+a5hmdUORHcWgl7XEaPydtj3OOBOtMfOSGDF8Or?=
 =?iso-8859-1?Q?+f5gsX5vj//cPxaBmAbX1+6v93R3oZK0ylmgORUuF6y7DtYD3t658rsfaJ?=
 =?iso-8859-1?Q?sD/Xn91oQqYQ2pVBG8mJqu3NLsaFwaTBsxK30kqoE4H4R9TqDHKZDnlxPY?=
 =?iso-8859-1?Q?Kb8Yc1ibKF0D0SDWUfwTqkXonI+2PLFIoIj70t0xU2kPO0iDOcgNWavJWA?=
 =?iso-8859-1?Q?RLnd7puZPp/nV2Z2lw0WaQ/k5F4QnbX00X1A7tW0HPIJ14bk7tS3mcSN8Q?=
 =?iso-8859-1?Q?yUnOfz2rJUDAqKvfFl184rsT9fWdVDfb70n8ZYCLAdwT/7wPmfpLV5b8VD?=
 =?iso-8859-1?Q?/GzQ0tDA08fiAZ50juKtjyh/zRZ+NUx/hO7N2zxz3F9Qj6LctmnbaJZ+3Z?=
 =?iso-8859-1?Q?ggzxyg3Y2LWBNO9OHpdSQBbFX8dBdX/frJo6IYEAYA305db4hQWbL1PIR2?=
 =?iso-8859-1?Q?l9CIsGTc2+wwTweLdP9YkAUUUaQITxQwy0nv5MBSslFqA35xZ28gmXN+4T?=
 =?iso-8859-1?Q?OXZVJElpFYlKS84PAMO7g4pDcMJnyYIk5O3lwxjVDbmhcsiKsPeBjED8b9?=
 =?iso-8859-1?Q?MLkGyo/RSraaQxAnFsY4RvC2B3Se5oWXuCKZSdL+hizISE4sR+r6XBQmpy?=
 =?iso-8859-1?Q?Cv/tQpsmKWKnjQlgq17H7qy55ssYg7vGrJsIFC5LpET2L4teQm+fzQo+iW?=
 =?iso-8859-1?Q?mkNfCsIQ8GvB5MUs3dQiqxtWAhz56qT3COfZQO6GJ6UF3lwkkKIkyh70Dr?=
 =?iso-8859-1?Q?bVxnSKP5tSSkkBOW7AtmUtlIfNE0eWnZXF/AJPyXD7oG2VsD4fs8oybVCO?=
 =?iso-8859-1?Q?fqjl4UHKxf4IlqpBA++O1xZX9Zmso4HykF4en75I1d6N1kQosyqPWLdfcV?=
 =?iso-8859-1?Q?P/6yP7IzF9y78bHrAApL6WE0Q+Zc+ffghlFIX6GmUiNCCNBgPnHPW3R2w9?=
 =?iso-8859-1?Q?EeMHxk1VrvqtyxAyLGYj1tncp3vQ/MNe3W1jq4XSlkI6quRrLNXfY+XTwz?=
 =?iso-8859-1?Q?EjX+r1BGRDoQ0ZdJ8FQpsx6TKDZxSMuMUxydWZSl8TI7V00aHwzGQnC8ld?=
 =?iso-8859-1?Q?P+31vXfGLSrF7X1DbwTOgzTLayLyt39Bd4sJCWXFVmMLkV3wY2BrNQLVnl?=
 =?iso-8859-1?Q?DH2xYEDUx/khkXmOgF8B84ptuBTrX9sa9arHjdRoo16uFztYSVUASRS+xd?=
 =?iso-8859-1?Q?GkMLF1ivyWmtTcrqYQ1iCzMmA1Z3vl7ULwkOxNEBKsRJ9pU1rvSPnNSBzU?=
 =?iso-8859-1?Q?KelnsCxZkA?=
X-OriginatorOrg: corigine.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 25357c23-6135-43e4-9d36-08d9779972d1
X-MS-Exchange-CrossTenant-AuthSource: DM6PR13MB4431.namprd13.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Sep 2021 16:05:19.1041
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: fe128f2c-073b-4c20-818e-7246a585940c
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: irz1quEGf+Mt6n23+0OzvlIs2IFh+LJRMijYuUab9R7j4zZlCm+J4BODgFtVAJGuLVlJ8NcIr7dhmI4y0uNrPhznKZGrNdWC6fYNhqDBZSs=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM8PR13MB5095
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Hi Joe,

Maybe you are already aware of this, but in case you are not.

The issue is the checkpatch check for unnecessary KERN_<LEVEL> for log 
functions. If a single line contains a statement that match a log 
function name from $logFunctions, such as foo_err() and the same line 
contains a KERN_<LEVEL> statement the 'WARNING: Possible unnecessary 
KERN_ERR' is triggered. This is true even if the KERN_<LEVEL> statement 
is not part of the arguments to the foo_err() definition that triggers 
the first part of the check.

This can be demonstrated by,

    ./scripts/checkpatch.pl --mailback --git c821e617896e99b8

Where we get (among others) the warning,

    WARNING: Possible unnecessary KERN_ERR
    #38: FILE: drivers/net/ethernet/netronome/nfp/nfp_net.h:63:
    +#define nn_err(nn, fmt, args...)	nn_pr(nn, KERN_ERR, fmt, ## args)

Looking at the code in checkpatch.pl we have,

our $logFunctions = qr{(?x:
        printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
        (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
        TP_printk|
        WARN(?:_RATELIMIT|_ONCE|)|
        panic|
        MODULE_[A-Z_]+|
        seq_vprintf|seq_printf|seq_puts
)};

...

# check for logging functions with KERN_<LEVEL>
                if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
                    $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
                        my $level = $1;
                        if (WARN("UNNECESSARY_KERN_LEVEL",
                                 "Possible unnecessary $level\n" . $herecurr) &&
                            $fix) {
                                $fixed[$fixlinenr] =~ s/\s*$level\s*//;
                        }
                }

Looking at the line from above that triggers the warning,

	#define nn_err(nn, fmt, args...)   nn_pr(nn, KERN_ERR, fmt, ## args)

We see that the warning is triggers by the regexp but that it matches 
the first part on nn_err( and then the second part of on the second 
argument to nn_pr, KERN_ERR. I believe this to be a false positive.

Unfortunately my Perl skills are not good enough to fix the check to only 
look for KERN_[A-Z]+ inside the argument list to the log function name 
that matches the first part of the regexp.

-- 
Regards,
Niklas S?derlund