From patchwork Fri Jan 18 22:50:47 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jason Gunthorpe X-Patchwork-Id: 10771751 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id C416513B4 for ; Fri, 18 Jan 2019 22:50:52 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id AF98F308F1 for ; Fri, 18 Jan 2019 22:50:52 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id A2A5B308C5; Fri, 18 Jan 2019 22:50:52 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id BDBF1308E2 for ; Fri, 18 Jan 2019 22:50:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729872AbfARWuv (ORCPT ); Fri, 18 Jan 2019 17:50:51 -0500 Received: from mail-pl1-f195.google.com ([209.85.214.195]:42720 "EHLO mail-pl1-f195.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729849AbfARWuv (ORCPT ); Fri, 18 Jan 2019 17:50:51 -0500 Received: by mail-pl1-f195.google.com with SMTP id y1so6952636plp.9 for ; Fri, 18 Jan 2019 14:50:50 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ziepe.ca; s=google; h=date:from:to:cc:subject:message-id:mime-version:content-disposition :user-agent; bh=MNUKPjJqvWPEMXelfnXE6nuCjxdv1362biBH6cW7C38=; b=b83MAFLRfu9lfKeMa+xo8W6wK+AaLnI3BiblZipDEcIqwUEzaXzjplTd8xyWme5zrC 1AJRTEV8U3apfWhZpoY6uL4OpYxVrQhdTzsZpoCr/kl5c9+mTt5ZPwm5kBWnIrQxU4FU l9mZjjf00c3yBH6vJB/929aN1OySxruHF9v9SNbg/cnJ4N4zepEtDmBvZjs88+227IMx BCYYiiShYwvkEzsFLoCAL0h26Y2eilqFa+ZhWT0ovb/UHcXrxuz/2rIDPJmIn7C3iVxF ymWvPhIWtg1H4SEATMemj97j5kl7HTgEtHueNqrVCcPdwxqeKl3upH4RG7KI526Hcst1 oHNQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:mime-version :content-disposition:user-agent; bh=MNUKPjJqvWPEMXelfnXE6nuCjxdv1362biBH6cW7C38=; b=YuB9q47PSO81WvmULuAHMPaoKv33ZIXmCyT00LaTf2uxu44s76JwkUCNZzuVVQseE0 D9mnlGAhYt0JBJ+8LvAu4qvpAWvID9Vhbi8zwqsfIjwnEGw/RJ3dJFnG0O07+RxVthlC O7fkXEmhop4ggziHtxGdvbntsyuOsdEjIboKs+kDwQisZWsDdmVNdHxAOG+J29lJl7E9 ykN74IsbaAtZpxeJKA4oAAB/znmrCUm9GAkYye57AeS5QgKsTHFUtf7ymxvuyJCOBVmi EU5JDGdVol8rCPhThVTqgzwa3Ww2AaFi3zZ5/2J0/9GJIQulOG2RsAjBzCfWJAZEUjGJ sJLg== X-Gm-Message-State: AJcUukeXYK4NZonI9g7bzfNWDp/RLUGsMe7ttzzyhtzx3Bis6EOykkBY yHsUhXl+tDG9lJpEkotnpNuP4Q== X-Google-Smtp-Source: ALg8bN4qjfesCJZ/3g5Aw/eeYaW0+raxrdBY93e4Mt6TpqCNmp3yGY39XBVP1sgr0Rqw8bRBUUH1SA== X-Received: by 2002:a17:902:2ec1:: with SMTP id r59mr21141578plb.254.1547851849940; Fri, 18 Jan 2019 14:50:49 -0800 (PST) Received: from ziepe.ca (S010614cc2056d97f.ed.shawcable.net. [174.3.196.123]) by smtp.gmail.com with ESMTPSA id 184sm9368824pfe.106.2019.01.18.14.50.48 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 18 Jan 2019 14:50:48 -0800 (PST) Received: from jgg by mlx.ziepe.ca with local (Exim 4.90_1) (envelope-from ) id 1gkcyN-0007He-Ni; Fri, 18 Jan 2019 15:50:47 -0700 Date: Fri, 18 Jan 2019 15:50:47 -0700 From: Jason Gunthorpe To: Joe Perches Cc: Gal Pressman , Bart Van Assche , Stephen Warren , Tariq Toukan , xavier.huwei@huawei.com, netdev@vger.kernel.org, linux-rdma@vger.kernel.org, Doug Ledford , Stephen Warren , Christoph Hellwig , Andrew Morton , Linus Torvalds , linux-doc@vger.kernel.org, Jonathan Corbet , linux-kernel@vger.kernel.org Subject: [PATCH v5] coding-style: Clarify the expectations around bool Message-ID: <20190118225047.GH4759@ziepe.ca> MIME-Version: 1.0 Content-Disposition: inline User-Agent: Mutt/1.9.4 (2018-02-28) Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP There has been some confusion since checkpatch started warning about bool use in structures, and people have been avoiding using it. Many people feel there is still a legitimate place for bool in structures, so provide some guidance on bool usage derived from the entire thread that spawned the checkpatch warning. Link: https://lkml.kernel.org/r/CA+55aFwVZk1OfB9T2v014PTAKFhtVan_Zj2dOjnCy3x6E4UJfA@mail.gmail.com Signed-off-by: Joe Perches Acked-by: Joe Perches Reviewed-by: Bart Van Assche Acked-by: Jani Nikula Reviewed-by: Joey Pabalinas Signed-off-by: Jason Gunthorpe Acked-by: Federico Vaga --- Documentation/process/coding-style.rst | 38 +++++++++++++++++++++++--- scripts/checkpatch.pl | 13 --------- 2 files changed, 34 insertions(+), 17 deletions(-) v5: - Wording updates from JoeyP, MatthewW, FedericoV diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst index b78dd680c03809..de889deaf29c42 100644 --- a/Documentation/process/coding-style.rst +++ b/Documentation/process/coding-style.rst @@ -921,7 +921,37 @@ result. Typical examples would be functions that return pointers; they use NULL or the ERR_PTR mechanism to report failure. -17) Don't re-invent the kernel macros +17) Using bool +-------------- + +The Linux kernel bool type is an alias for the C99 _Bool type. bool values can +only evaluate to 0 or 1, and implicit or explicit conversion to bool +automatically converts the value to true or false. When using bool types the +!! construction is not needed, which eliminates a class of bugs. + +When working with bool values the true and false definitions should be used +instead of 1 and 0. + +bool function return types and stack variables are always fine to use whenever +appropriate. Use of bool is encouraged to improve readability and is often a +better option than 'int' for storing boolean values. + +Do not use bool if cache line layout or size of the value matters, as its size +and alignment varies based on the compiled architecture. Structures that are +optimized for alignment and size should not use bool. + +If a structure has many true/false values, consider consolidating them into a +bitfield with 1 bit members, or using an appropriate fixed width type, such as +u8. + +Similarly for function arguments, many true/false values can be consolidated +into a single bitwise 'flags' argument and 'flags' can often be a more +readable alternative if the call-sites have naked true/false constants. + +Otherwise limited use of bool in structures and arguments can improve +readability. + +18) Don't re-invent the kernel macros ------------------------------------- The header file include/linux/kernel.h contains a number of macros that @@ -944,7 +974,7 @@ need them. Feel free to peruse that header file to see what else is already defined that you shouldn't reproduce in your code. -18) Editor modelines and other cruft +19) Editor modelines and other cruft ------------------------------------ Some editors can interpret configuration information embedded in source files, @@ -978,7 +1008,7 @@ own custom mode, or may have some other magic method for making indentation work correctly. -19) Inline assembly +20) Inline assembly ------------------- In architecture-specific code, you may need to use inline assembly to interface @@ -1010,7 +1040,7 @@ the next instruction in the assembly output: : /* outputs */ : /* inputs */ : /* clobbers */); -20) Conditional Compilation +21) Conditional Compilation --------------------------- Wherever possible, don't use preprocessor conditionals (#if, #ifdef) in .c diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index b737ca9d720441..d62abd032885a1 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -6368,19 +6368,6 @@ sub process { } } -# check for bool bitfields - if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) { - WARN("BOOL_BITFIELD", - "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr); - } - -# check for bool use in .h files - if ($realfile =~ /\.h$/ && - $sline =~ /^.\s+bool\s*$Ident\s*(?::\s*d+\s*)?;/) { - CHK("BOOL_MEMBER", - "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr); - } - # check for semaphores initialized locked if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { WARN("CONSIDER_COMPLETION",