From patchwork Mon Dec 18 09:00:18 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Federico Serafini X-Patchwork-Id: 13496404 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 0679EC46CD2 for ; Mon, 18 Dec 2023 09:00:55 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.655711.1023438 (Exim 4.92) (envelope-from ) id 1rF9UL-0003Tr-LO; Mon, 18 Dec 2023 09:00:37 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 655711.1023438; Mon, 18 Dec 2023 09:00:37 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1rF9UL-0003Tk-HY; Mon, 18 Dec 2023 09:00:37 +0000 Received: by outflank-mailman (input) for mailman id 655711; Mon, 18 Dec 2023 09:00:36 +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 1rF9UK-0003Te-M5 for xen-devel@lists.xenproject.org; Mon, 18 Dec 2023 09:00:36 +0000 Received: from support.bugseng.com (mail.bugseng.com [162.55.131.47]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id e763abf3-9d83-11ee-9b0f-b553b5be7939; Mon, 18 Dec 2023 10:00:34 +0100 (CET) Received: from Dell.bugseng.com (unknown [78.210.165.135]) by support.bugseng.com (Postfix) with ESMTPSA id 803954EE0742; Mon, 18 Dec 2023 10:00:31 +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: e763abf3-9d83-11ee-9b0f-b553b5be7939 From: Federico Serafini To: xen-devel@lists.xenproject.org Cc: consulting@bugseng.com, Federico Serafini , Simone Ballarin , Doug Goldstein , Stefano Stabellini , Andrew Cooper , George Dunlap , Jan Beulich , Julien Grall , Wei Liu Subject: [XEN PATCH v3] automation/eclair: add deviations for MISRA C:2012 Rule 16.3 Date: Mon, 18 Dec 2023 10:00:18 +0100 Message-Id: <23f4bf337883f1d6b67f7bd8466a9c299713e9d4.1702889534.git.federico.serafini@bugseng.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 MISRA C:2012 Rule 16.3 states that an unconditional break statement shall terminate every switch-clause. Update ECLAIR configuration to take into account: - continue, goto, return statements; - functions with attribute noreturn; - pseudo-keyword fallthrough; - macro BUG(); - comments. Update docs/misra/deviations.rst accordingly. Signed-off-by: Federico Serafini Reviewed-by: Stefano Stabellini --- Changes in v3: - added bullet point for pseudo-keyword fallthrough; - mentioned noreturn attribute; - fixed typo. --- Changes in v2: - applied suggestions coming from https://lists.xenproject.org/archives/html/xen-devel/2023-12/msg00957.html --- .../eclair_analysis/ECLAIR/deviations.ecl | 28 ++++++++++++++++ docs/misra/deviations.rst | 32 +++++++++++++++++++ 2 files changed, 60 insertions(+) diff --git a/automation/eclair_analysis/ECLAIR/deviations.ecl b/automation/eclair_analysis/ECLAIR/deviations.ecl index 683f2bbfe8..0e8152f9c3 100644 --- a/automation/eclair_analysis/ECLAIR/deviations.ecl +++ b/automation/eclair_analysis/ECLAIR/deviations.ecl @@ -327,6 +327,34 @@ therefore have the same behavior of a boolean" -config=MC3R1.R14.4,etypes+={deliberate, "stmt(child(cond,child(expr,ref(^?::is_dying$))))","src_type(enum)"} -doc_end +# +# Series 16. +# + +-doc_begin="Switch clauses ending with continue, goto, return statements are +safe." +-config=MC3R1.R16.3,terminals+={safe, "node(continue_stmt||goto_stmt||return_stmt)"} +-doc_end + +-doc_begin="Switch clauses ending with a call to a function that does not give +the control back (i.e., a function with attribute noreturn) are safe." +-config=MC3R1.R16.3,terminals+={safe, "call(property(noreturn))"} +-doc_end + +-doc_begin="Switch clauses ending with pseudo-keyword \"fallthrough\" are +safe." +-config=MC3R1.R16.3,reports+={safe, "any_area(end_loc(any_exp(text(/fallthrough;/))))"} +-doc_end + +-doc_begin="Switch clauses ending with failure method \"BUG()\" are safe." +-config=MC3R1.R16.3,reports+={safe, "any_area(end_loc(any_exp(text(/BUG\\(\\);/))))"} +-doc_end + +-doc_begin="Switch clauses not ending with the break statement are safe if an +explicit comment indicating the fallthrough intention is present." +-config=MC3R1.R16.3,reports+={safe, "any_area(end_loc(any_exp(text(^(?s).*/\\* [fF]all ?through.? \\*/.*$,0..1))))"} +-doc_end + # # Series 20. # diff --git a/docs/misra/deviations.rst b/docs/misra/deviations.rst index eda3c8100c..0131d72959 100644 --- a/docs/misra/deviations.rst +++ b/docs/misra/deviations.rst @@ -276,6 +276,38 @@ Deviations related to MISRA C:2012 Rules: therefore have the same behavior of a boolean. - Project-wide deviation; tagged as `deliberate` for ECLAIR. + * - R16.3 + - Switch clauses ending with continue, goto, return statements are safe. + - Tagged as `safe` for ECLAIR. + + * - R16.3 + - Switch clauses ending with a call to a function that does not give + the control back (i.e., a function with attribute noreturn) are safe. + - Tagged as `safe` for ECLAIR. + + * - R16.3 + - Switch clauses ending with pseudo-keyword \"fallthrough\" are safe. + - Tagged as `safe` for ECLAIR. + + * - R16.3 + - Switch clauses ending with failure method \"BUG()\" are safe. + - Tagged as `safe` for ECLAIR. + + * - R16.3 + - Existing switch clauses not ending with the break statement are safe if + an explicit comment indicating the fallthrough intention is present. + However, the use of such comments in new code is deprecated: + the pseudo-keyword "fallthrough" shall be used. + - Tagged as `safe` for ECLAIR. The accepted comments are: + - /\* fall through \*/ + - /\* fall through. \*/ + - /\* fallthrough \*/ + - /\* fallthrough. \*/ + - /\* Fall through \*/ + - /\* Fall through. \*/ + - /\* Fallthrough \*/ + - /\* Fallthrough. \*/ + * - R20.7 - Code violating Rule 20.7 is safe when macro parameters are used: (1) as function arguments;