From patchwork Fri Jul 28 08:11:39 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luca Fancellu X-Patchwork-Id: 13331391 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 53CD9C0015E for ; Fri, 28 Jul 2023 08:12:16 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.571371.895035 (Exim 4.92) (envelope-from ) id 1qPIZu-0004Ag-Ct; Fri, 28 Jul 2023 08:12:02 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 571371.895035; Fri, 28 Jul 2023 08:12:02 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qPIZu-0004AZ-9y; Fri, 28 Jul 2023 08:12:02 +0000 Received: by outflank-mailman (input) for mailman id 571371; Fri, 28 Jul 2023 08:12:01 +0000 Received: from se1-gles-flk1-in.inumbo.com ([94.247.172.50] helo=se1-gles-flk1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qPIZt-0004AS-5k for xen-devel@lists.xenproject.org; Fri, 28 Jul 2023 08:12:01 +0000 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by se1-gles-flk1.inumbo.com (Halon) with ESMTP id 6bd0ea61-2d1e-11ee-8613-37d641c3527e; Fri, 28 Jul 2023 10:11:58 +0200 (CEST) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 779CD2F4; Fri, 28 Jul 2023 01:12:40 -0700 (PDT) Received: from e125770.cambridge.arm.com (e125770.arm.com [10.1.199.1]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id E3C0D3F67D; Fri, 28 Jul 2023 01:11:55 -0700 (PDT) X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: 6bd0ea61-2d1e-11ee-8613-37d641c3527e From: Luca Fancellu To: xen-devel@lists.xenproject.org Cc: bertrand.marquis@arm.com, wei.chen@arm.com, Andrew Cooper , George Dunlap , Jan Beulich , Julien Grall , Stefano Stabellini , Wei Liu , =?utf-8?q?Roger_Pau_Monn=C3=A9?= Subject: [RFC PATCH 0/5] clang-format for Xen Date: Fri, 28 Jul 2023 09:11:39 +0100 Message-Id: <20230728081144.4124309-1-luca.fancellu@arm.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 ## Introduction ################################################################ In this serie, I would like to get feedbacks on the output generated by the configuration of clang-format, unfortunately we can't use only clang-format, but we need to call it using a wrapper, because we need the information of what files need to be excluded from the tool. Another reason is that clang-format has some limitation when formatting asm() instruction and most of the time it format them in a very ugly way or it breaks the code for example removing spaces that were there for a reason (I don't think it's a tool to format asm), so in the wrapper script we protect all asm() invocation or macros where there are asm() invocation with in-code comments that stops clang-format to act on that section: /* clang-format off */section/* clang-format on */ I've read the past threads about the brave people who dared to try to introduce clang-format for the xen codebase, some of them from 5 years ago, two points were clear: 1) goto label needs to be indented and 2) do-while loops have the braket in the same line. While point 1) was quite a blocker, it seemd to me that point 2) was less controversial to be changed in the Xen codestyle, so the current wrapper script handles only the point 1 (which is easy), the point 2 can be more tricky to handle. ## The clang-format configuration ############################################## In my clang-format configuration I've taken inspiration from EPAM's work, then from the configuration in Linux and finally from the clang-format manual, to try to produce a comprehensive configuration. Every configuration parameter has on top a comment with the description and when it was supported, finally I've added also a [not specified] if that behavior is not clearly specified in the Xen coding style, I've done that so we could discuss about adding more specification in our CODING_STYLE. Every comment can be stripped out in the final release of the file, but I think that now they are useful for the discussion. The minimum clang-format version for the file is 15, my ubuntu 22.04 comes with it, we can reason if it's too high, or if we could also use the latest version maybe shipped inside a docker image. For every [not specified] behavior, I've tried to guess it from the codebase, I've seen that also in that case it's not easy as there is (sometimes) low consistency between modules, so we can discuss on every configurable. Worth to mention, the public header are all excluded from the format tool, because formatting them breaks the build on X86, because there are scripts for auto-generation that don't handle the formatted headers, I didn't investigate on it, maybe it can be added as technical debt. So I've tried building arm32, arm64 and x86_64 with the formatted output and they build, I've used Yocto for that. ## How to try it? ############################################################## So how to generate everything? Just invoke the codestyle.py script without parameter and it will format every .c and .h file in the hypervisor codebase. ./xen/scripts/codestyle.py Optionally you can also pass one or more relative path from the folder you are invoking the script and it will format only them. ## What I expect from this RFC ################################################# I expect feedback on the output, some agreement on what configuration to use, and I expect to find possible blocker before working seriously on this serie, because if there are outstanding blockers on the adoption of the tool and we can't reach an agreement, I won't spend further time on it. I understand that the release is coming soon and some people are on holiday in this period, so worst case I will ping again after the release. Luca Fancellu (5): [WIP]misra: add entries to the excluded list [WIP]cppcheck: rework exclusion_file_list.py code [WIP]xen/scripts: add codestyle.py script x86/HVM: protect mm_type_tbl format from clang-format xen: Add clang-format configuration docs/misra/exclude-list.json | 88 +++ xen/.clang-format | 693 ++++++++++++++++++ xen/arch/x86/hvm/mtrr.c | 2 + xen/scripts/codestyle.py | 261 +++++++ xen/scripts/xen_analysis/cppcheck_analysis.py | 6 +- .../xen_analysis/exclusion_file_list.py | 31 +- 6 files changed, 1063 insertions(+), 18 deletions(-) create mode 100644 xen/.clang-format create mode 100755 xen/scripts/codestyle.py