From patchwork Fri Nov 17 08:53:25 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nicola Vetrini X-Patchwork-Id: 13458528 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 9F966C072A2 for ; Fri, 17 Nov 2023 08:54:09 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.634903.990503 (Exim 4.92) (envelope-from ) id 1r3ubd-0001ey-Un; Fri, 17 Nov 2023 08:53:41 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 634903.990503; Fri, 17 Nov 2023 08:53:41 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r3ubd-0001er-R7; Fri, 17 Nov 2023 08:53:41 +0000 Received: by outflank-mailman (input) for mailman id 634903; Fri, 17 Nov 2023 08:53:40 +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 1r3ubc-0001Px-5M for xen-devel@lists.xenproject.org; Fri, 17 Nov 2023 08:53:40 +0000 Received: from support.bugseng.com (mail.bugseng.com [162.55.131.47]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id cc0c82c6-8526-11ee-9b0e-b553b5be7939; Fri, 17 Nov 2023 09:53:37 +0100 (CET) Received: from nico.bugseng.com (unknown [147.123.100.131]) by support.bugseng.com (Postfix) with ESMTPSA id 5F35F4EE0C81; Fri, 17 Nov 2023 09:53:36 +0100 (CET) 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: cc0c82c6-8526-11ee-9b0e-b553b5be7939 From: Nicola Vetrini To: nicola.vetrini@bugseng.com, xen-devel@lists.xenproject.org Cc: sstabellini@kernel.org, michal.orzel@amd.com, xenia.ragiadakou@amd.com, ayan.kumar.halder@amd.com, consulting@bugseng.com, jbeulich@suse.com, andrew.cooper3@citrix.com, roger.pau@citrix.com, bertrand.marquis@arm.com, julien@xen.org, Simone Ballarin , Doug Goldstein Subject: [XEN PATCH v5 1/2] automation/eclair: make the docs for MISRA C:2012 Dir 4.1 visible to ECLAIR Date: Fri, 17 Nov 2023 09:53:25 +0100 Message-Id: X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 To be able to check for the existence of the necessary subsections in the documentation for MISRA C:2012 Dir 4.1, ECLAIR needs to have a source file that is built. This file is generated from 'C-runtime-failures.rst' in docs/misra and the configuration is updated accordingly. Signed-off-by: Nicola Vetrini Reviewed-by: Stefano Stabellini --- Changes from RFC: - Dropped unused/useless code - Revised the sed command - Revised the clean target Changes in v2: - Added explanative comment to the makefile - printf instead of echo Changes in v3: - Terminate the generated file with a newline - Build it with -std=c99, so that the documentation for D1.1 applies. Changes in v4: - Transform and build the file directly in the eclair-specific directory Changes in v5: - Small improvements --- automation/eclair_analysis/build.sh | 31 +++++++++++++++++++++++---- automation/eclair_analysis/prepare.sh | 7 +++--- 2 files changed, 31 insertions(+), 7 deletions(-) diff --git a/automation/eclair_analysis/build.sh b/automation/eclair_analysis/build.sh index ec087dd822fa..122b93b80581 100755 --- a/automation/eclair_analysis/build.sh +++ b/automation/eclair_analysis/build.sh @@ -33,12 +33,35 @@ else PROCESSORS=6 fi +# Variables driving the build +CC=${CROSS_COMPILE}gcc-12 +CXX=${CROSS_COMPILE}g++-12 + +runtime_failures_docs() { + doc="C-runtime-failures.rst" + builddir="automation/eclair_analysis" + + cd "${builddir}" + printf "/*\n\n" >"${doc}.c" + sed -e 's|\*/|*//*|g' "../../docs/misra/${doc}" >>"${doc}.c" + + # At least a dummy decl is needed to comply with the C standard. + printf "\n\n*/\ntypedef int dummy_typedef;\n" >>"${doc}.c" + + # The C language standard applicable to Xen is C99 (with extensions), + # therefore even this dummy file needs to be compiled with -std=c99. + # Cannot redirect to /dev/null because it would be excluded from the analysis + "${CC}" -std=c99 -c "${doc}.c" -o "${doc}.o" + cd - +} + ( - cd xen + runtime_failures_docs make "-j${PROCESSORS}" "-l${PROCESSORS}.0" \ "CROSS_COMPILE=${CROSS_COMPILE}" \ - "CC=${CROSS_COMPILE}gcc-12" \ - "CXX=${CROSS_COMPILE}g++-12" \ - "XEN_TARGET_ARCH=${XEN_TARGET_ARCH}" + "CC=${CC}" \ + "CXX=${CXX}" \ + "XEN_TARGET_ARCH=${XEN_TARGET_ARCH}" \ + -C xen ) diff --git a/automation/eclair_analysis/prepare.sh b/automation/eclair_analysis/prepare.sh index 0cac5eba00ae..fe9d16e48ecc 100755 --- a/automation/eclair_analysis/prepare.sh +++ b/automation/eclair_analysis/prepare.sh @@ -35,11 +35,12 @@ else fi ( - cd xen - cp "${CONFIG_FILE}" .config + ./configure + cp "${CONFIG_FILE}" xen/.config make clean find . -type f -name "*.safparse" -print -delete - make -f ${script_dir}/Makefile.prepare prepare + cd xen + make -f "${script_dir}/Makefile.prepare" prepare # Translate the /* SAF-n-safe */ comments into ECLAIR CBTs scripts/xen-analysis.py --run-eclair --no-build --no-clean ) From patchwork Fri Nov 17 08:53:26 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nicola Vetrini X-Patchwork-Id: 13458526 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 2B5E6C072A2 for ; Fri, 17 Nov 2023 08:54:02 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.634904.990510 (Exim 4.92) (envelope-from ) id 1r3ube-0001iL-9X; Fri, 17 Nov 2023 08:53:42 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 634904.990510; Fri, 17 Nov 2023 08:53:42 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r3ube-0001hk-20; Fri, 17 Nov 2023 08:53:42 +0000 Received: by outflank-mailman (input) for mailman id 634904; Fri, 17 Nov 2023 08:53:40 +0000 Received: from se1-gles-sth1-in.inumbo.com ([159.253.27.254] helo=se1-gles-sth1.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1r3ubc-0001Q3-FT for xen-devel@lists.xenproject.org; Fri, 17 Nov 2023 08:53:40 +0000 Received: from support.bugseng.com (mail.bugseng.com [162.55.131.47]) by se1-gles-sth1.inumbo.com (Halon) with ESMTPS id cd5772c2-8526-11ee-98dc-6d05b1d4d9a1; Fri, 17 Nov 2023 09:53:39 +0100 (CET) Received: from nico.bugseng.com (unknown [147.123.100.131]) by support.bugseng.com (Postfix) with ESMTPSA id 230574EE0C87; Fri, 17 Nov 2023 09:53:38 +0100 (CET) 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: cd5772c2-8526-11ee-98dc-6d05b1d4d9a1 From: Nicola Vetrini To: nicola.vetrini@bugseng.com, xen-devel@lists.xenproject.org Cc: sstabellini@kernel.org, michal.orzel@amd.com, xenia.ragiadakou@amd.com, ayan.kumar.halder@amd.com, consulting@bugseng.com, jbeulich@suse.com, andrew.cooper3@citrix.com, roger.pau@citrix.com, bertrand.marquis@arm.com, julien@xen.org, George Dunlap , Wei Liu , Julien Grall Subject: [XEN PATCH v5 2/2] docs/misra: add guidance on the format of Dir 4.1 docs for ECLAIR Date: Fri, 17 Nov 2023 09:53:26 +0100 Message-Id: X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 Additional guidance on the formatting of the document for ECLAIR is supplied. Signed-off-by: Nicola Vetrini Reviewed-by: Stefano Stabellini Acked-by: Julien Grall --- docs/misra/C-runtime-failures.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/misra/C-runtime-failures.rst b/docs/misra/C-runtime-failures.rst index 1052b2afca13..cac51d6b2596 100644 --- a/docs/misra/C-runtime-failures.rst +++ b/docs/misra/C-runtime-failures.rst @@ -12,6 +12,14 @@ built-in checks that are present in the language. The presence of such documentation is requested by MISRA C:2012 Directive 4.1, whose headline states: "Run-time failures shall be minimized". +The ECLAIR checker for MISRA C:2012 Directive 4.1 requires the documentation +to be supplied using the following format: + +``Documentation for MISRA C:2012 Dir 4.1: `` + +The matched categories are the ones listed below (e.g., ``overflow`` and +``unexpected wrapping``). The content of the description is not checked and can +span multiple lines. Documentation for MISRA C:2012 Dir 4.1: overflow ________________________________________________