From nobody Sat May 18 13:16:36 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) client-ip=192.237.175.120; envelope-from=xen-devel-bounces@lists.xenproject.org; helo=lists.xenproject.org; Authentication-Results: mx.zohomail.com; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Return-Path: Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) by mx.zohomail.com with SMTPS id 1696587849636890.628801862535; Fri, 6 Oct 2023 03:24:09 -0700 (PDT) Received: from list by lists.xenproject.org with outflank-mailman.613500.954049 (Exim 4.92) (envelope-from ) id 1qohzp-0003Di-7B; Fri, 06 Oct 2023 10:23:49 +0000 Received: by outflank-mailman (output) from mailman id 613500.954049; Fri, 06 Oct 2023 10:23:49 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1qohzp-0003Db-4M; Fri, 06 Oct 2023 10:23:49 +0000 Received: by outflank-mailman (input) for mailman id 613500; Fri, 06 Oct 2023 10:23:47 +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 1qohzn-0003DT-Jt for xen-devel@lists.xenproject.org; Fri, 06 Oct 2023 10:23:47 +0000 Received: from support.bugseng.com (mail.bugseng.com [162.55.131.47]) by se1-gles-flk1.inumbo.com (Halon) with ESMTPS id 6dd97fee-6432-11ee-9b0d-b553b5be7939; Fri, 06 Oct 2023 12:23:45 +0200 (CEST) Received: from beta.station (net-188-218-250-245.cust.vodafonedsl.it [188.218.250.245]) by support.bugseng.com (Postfix) with ESMTPSA id 89D304EE0738; Fri, 6 Oct 2023 12:23:44 +0200 (CEST) X-Outflank-Mailman: Message body and most headers restored to incoming version 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: 6dd97fee-6432-11ee-9b0d-b553b5be7939 From: Simone Ballarin To: xen-devel@lists.xenproject.org Cc: consulting@bugseng.com, Simone Ballarin , Doug Goldstein , Stefano Stabellini Subject: [XEN PATCH] automation/eclair: update deviations and accepted guidelines Date: Fri, 6 Oct 2023 12:23:16 +0200 Message-Id: X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-ZM-MESSAGEID: 1696587851437100001 Content-Type: text/plain; charset="utf-8" Remove deviations for ERROR_EXIT, ERROR_EXIT_DOM and PIN_FAIL: the aforementioned macros have been removed. Add deviation for Rule 2.1 for pure declarations. Remove legacy text-based deviations: these are now implemented with SAF comments. Add deviations for Dir 4.3 and Rules 8.4, 10.1, 13.5, 14.2, 14.3. Remove deviations for guidelines not yet accepted or rejected. Add MC3R1.R11.7, MC3R1.R11.8, MC3R1.R11.9, MC3R1.R15.3 and MC3R1.R14.2 to the accepted guidelines selector. Update clean guidelines selector. Signed-off-by: Simone Ballarin --- .../eclair_analysis/ECLAIR/deviations.ecl | 138 +++++++++--------- automation/eclair_analysis/ECLAIR/tagging.ecl | 4 +- 2 files changed, 69 insertions(+), 73 deletions(-) diff --git a/automation/eclair_analysis/ECLAIR/deviations.ecl b/automation/= eclair_analysis/ECLAIR/deviations.ecl index d8170106b4..c00b9d5f38 100644 --- a/automation/eclair_analysis/ECLAIR/deviations.ecl +++ b/automation/eclair_analysis/ECLAIR/deviations.ecl @@ -15,14 +15,19 @@ Constant expressions and unreachable branches of if and= switch statements are ex -doc_end =20 -doc_begin=3D"Unreachability caused by calls to the following functions or= macros is deliberate and there is no risk of code being unexpectedly left = out." --config=3DMC3R1.R2.1,statements+=3D{deliberate,"macro(name(BUG||assert_fai= led||ERROR_EXIT||ERROR_EXIT_DOM||PIN_FAIL))"} +-config=3DMC3R1.R2.1,statements+=3D{deliberate,"macro(name(BUG||assert_fai= led))"} -config=3DMC3R1.R2.1,statements+=3D{deliberate, "call(decl(name(__builtin_= unreachable||panic||do_unexpected_trap||machine_halt||machine_restart||mayb= e_reboot)))"} -doc_end =20 --doc_begin=3D"Unreachability of an ASSERT_UNREACHABLE() and analogous macr= o calls is deliberate and safe." +-doc_begin=3D"Unreachability inside an ASSERT_UNREACHABLE() and analogous = macro calls is deliberate and safe." -config=3DMC3R1.R2.1,reports+=3D{deliberate, "any_area(any_loc(any_exp(mac= ro(name(ASSERT_UNREACHABLE||PARSE_ERR_RET||PARSE_ERR||FAIL_MSR||FAIL_CPUID)= ))))"} -doc_end =20 +-doc_begin=3D"Pure declarations (i.e., declarations without initialization= ) are +not executable, and therefore it is safe for them to be unreachable." +-config=3DMC3R1.R2.1,ignored_stmts+=3D{"any()", "pure_decl()"} +-doc_end + -doc_begin=3D"Proving compliance with respect to Rule 2.2 is generally imp= ossible: see https://arxiv.org/abs/2212.13933 for details. Moreover, peer review gi= ves us confidence that no evidence of errors in the program's logic has been miss= ed due @@ -49,33 +54,12 @@ they are not instances of commented-out code." -config=3DMC3R1.D4.3,reports+=3D{disapplied,"!(any_area(any_loc(file(^xen/= arch/arm/arm64/.*$))))"} -doc_end =20 --doc_begin=3D"Depending on the compiler, rewriting the following function-= like -macros as inline functions is not guaranteed to have the same effect." --config=3DMC3R1.D4.9,macros+=3D{deliberate,"name(likely)"} --config=3DMC3R1.D4.9,macros+=3D{deliberate,"name(unlikely)"} --config=3DMC3R1.D4.9,macros+=3D{deliberate,"name(unreachable)"} --doc_end - --doc_begin=3D"These macros can be used on both pointers and unsigned long = type values." --config=3DMC3R1.D4.9,macros+=3D{safe,"name(virt_to_maddr)"} --config=3DMC3R1.D4.9,macros+=3D{safe,"name(virt_to_mfn)"} --doc_end - --doc_begin=3D"Rewriting variadic macros as variadic functions might have a= negative impact on safety." --config=3DMC3R1.D4.9,macros+=3D{deliberate,"variadic()"} --doc_end - --doc_begin=3D"Rewriting macros with arguments that are, in turn, arguments= of -__builtin_constant_p() can change the behavior depending on the optimizati= on -level." --config=3DMC3R1.D4.9,macro_argument_context+=3D"skip_to(class(type||expr||= decl,any), - call(name(__builtin_constant_p= )))" --doc_end - --doc_begin=3D"Function-like macros defined in public headers are meant to = be -usable in C89 mode without any extensions. Hence they cannot be replaced by -inline functions." --config=3DMC3R1.D4.9,macros+=3D{deliberate, "loc(file(api:public))"} +-doc_begin=3D"The inline asm in 'arm64/lib/bitops.c' is tightly coupled wi= th the +surronding C code that acts as a wrapper, so it has been decided not to ad= d an +additional encapsulation layer." +-file_tag+=3D{arm64_bitops, "^xen/arch/arm/arm64/lib/bitops\\.c$"} +-config=3DMC3R1.D4.3,reports+=3D{deliberate, "all_area(any_loc(file(arm64_= bitops)&&any_exp(macro(^(bit|test)op$))))"} +-config=3DMC3R1.D4.3,reports+=3D{deliberate, "any_area(any_loc(file(arm64_= bitops))&&context(name(int_clear_mask16)))"} -doc_end =20 -doc_begin=3D"This header file is autogenerated or empty, therefore it pos= es no @@ -105,29 +89,6 @@ conform to the directive." -config=3DMC3R1.R5.3,reports+=3D{safe, "any_area(any_loc(any_exp(macro(^re= ad_debugreg$))&&any_exp(macro(^write_debugreg$))))"} -doc_end =20 --doc_begin=3D"Function-like macros cannot be confused with identifiers tha= t are -neither functions nor pointers to functions." --config=3DMC3R1.R5.5,reports=3D{safe,"all_area(decl(node(enum_decl||record= _decl||field_decl||param_decl||var_decl)&&!type(canonical(address((node(fun= ction||function_no_proto))))))||macro(function_like()))"} --doc_end - --doc_begin=3D"The use of these identifiers for both macro names and other = entities -is deliberate and does not generate developer confusion." --config=3DMC3R1.R5.5,reports+=3D{safe, "any_area(text(^\\s*/\\*\\s+SAF-[0-= 9]+-safe\\s+MC3R1\\.R5\\.5.*$, begin-1))"} --doc_end - --doc_begin=3D"The definition of macros and functions ending in '_bit' that= use the -same identifier in 'bitops.h' is deliberate and safe." --file_tag+=3D{bitops_h, "^xen/arch/x86/include/asm/bitops\\.h$"} --config=3DMC3R1.R5.5,reports+=3D{safe, "all_area((decl(^.*_bit\\(.*$)||mac= ro(^.*_bit$))&&all_loc(file(bitops_h)))"} --doc_end - --doc_begin=3D"The definition of macros and functions beginning in 'str' or= 'mem' -that use the same identifier in 'xen/include/xen/string.h' is deliberate a= nd -safe." --file_tag+=3D{string_h, "^xen/include/xen/string\\.h$"} --config=3DMC3R1.R5.5,reports+=3D{safe, "any_area((decl(^(mem|str).*$)||mac= ro(^(mem|str).*$))&&all_loc(file(string_h)))"} --doc_end - # # Series 7. # @@ -156,11 +117,6 @@ particular use of it done in xen_mk_ulong." -config=3DMC3R1.R7.2,reports+=3D{deliberate,"any_area(any_loc(macro(name(B= UILD_BUG_ON))))"} -doc_end =20 --doc_begin=3D"The following string literals are assigned to pointers to non -const-qualified char." --config=3DMC3R1.R7.4,reports+=3D{safe, "any_area(text(^\\s*/\\*\\s+SAF-[0-= 9]+-safe\\s+MC3R1\\.R7\\.4.*$, begin-1))"} --doc_end - -doc_begin=3D"Allow pointers of non-character type as long as the pointee = is const-qualified." -config=3DMC3R1.R7.4,same_pointee=3Dfalse @@ -204,6 +160,16 @@ const-qualified." -config=3DMC3R1.R8.3,reports+=3D{deliberate,"any_area(any_loc(file(adopted= _mpparse_r8_3)))&&any_area(any_loc(file(^xen/arch/x86/include/asm/mpspec\\.= h$)))"} -doc_end =20 +-doc_begin=3D"The definitions present in this file are meant to generate d= efinitions for asm modules, and are not called by C code. Therefore the abs= ence of prior declarations is safe." +-config=3DMC3R1.R8.4,reports+=3D{safe, "first_area(any_loc(file(asm_offset= s)))"} +-doc_end + +-doc_begin=3D"The functions defined in this file are meant to be called fr= om gcc-generated code in a non-release build configuration. +Therefore the absence of prior declarations is safe." +-file_tag+=3D{gcov, "^xen/common/coverage/gcov_base\\.c$"} +-config=3DMC3R1.R8.4,reports+=3D{safe, "first_area(any_loc(file(gcov)))"} +-doc_end + -doc_begin=3D"The following variables are compiled in multiple translation= units belonging to different executables and therefore are safe." -config=3DMC3R1.R8.6,declarations+=3D{safe, "name(current_stack_pointer||b= search||sort)"} @@ -222,12 +188,6 @@ definition is compiled-out or optimized-out by the com= piler)" # Series 9. # =20 --doc_begin=3D"The following variables are written before being set, theref= ore no -access to uninitialized memory locations happens, as explained in the devi= ation -comment." --config=3DMC3R1.R9.1,reports+=3D{safe, "any_area(text(^\\s*/\\*\\s+SAF-[0-= 9]+-safe\\s+MC3R1\\.R9\\.1.*$, begin-1))"} --doc_end - -doc_begin=3D"Violations in files that maintainers have asked to not modif= y in the context of R9.1." -file_tag+=3D{adopted_r9_1,"^xen/arch/arm/arm64/lib/find_next_bit\\.c$"} @@ -274,22 +234,47 @@ still non-negative." -config=3DMC3R1.R10.1,etypes+=3D{safe, "stmt(operator(logical)||node(condi= tional_operator||binary_conditional_operator))", "dst_type(ebool||boolean)"} -doc_end =20 -### Set 3 ### +-doc_begin=3D"XEN only supports architectures where signed integers are +representend using two's complement and all the XEN developers are aware of +this." +-config=3DMC3R1.R10.1,etypes+=3D{safe, + "stmt(operator(and||or||xor||not||and_assign||or_assign||xor_assign))", + "any()"} +-doc_end + +-doc_begin=3D"See Section \"4.5 Integers\" of \"GCC_MANUAL\", where it say= s that +\"Signed `>>' acts on negative numbers by sign extension. As an extension = to the +C language, GCC does not use the latitude given in C99 and C11 only to tre= at +certain aspects of signed `<<' as undefined. However, -fsanitize=3Dshift (= and +-fsanitize=3Dundefined) will diagnose such cases. They are also diagnosed = where +constant expressions are required.\"" +-config=3DMC3R1.R10.1,etypes+=3D{safe, + "stmt(operator(shl||shr||shl_assign||shr_assign))", + "any()"} +-doc_end =20 # -# Series 18. +# Series 13 # =20 --doc_begin=3D"FIXME: explain why pointer differences involving this macro = are safe." --config=3DMC3R1.R18.2,reports+=3D{safe,"all_area(all_loc(any_exp(macro(^AC= PI_PTR_DIFF$))))"} +-doc_begin=3D"All developers and reviewers can be safely assumed to be wel= l aware +of the short-circuit evaluation strategy of such logical operators." +-config=3DMC3R1.R13.5,reports+=3D{disapplied,"any()"} -doc_end =20 --doc_begin=3D"FIXME: explain why pointer differences involving this macro = are safe." --config=3DMC3R1.R18.2,reports+=3D{safe,"all_area(all_loc(any_exp(macro(^pa= ge_to_mfn$))))"} +# +# Series 14 +# + +-doc_begin=3D"The severe restrictions imposed by this rule on the use of f= or +statements are not balanced by the presumed facilitation of the peer review +activity." +-config=3DMC3R1.R14.2,reports+=3D{disapplied,"any()"} -doc_end =20 --doc_begin=3D"FIXME: explain why pointer differences involving this macro = are safe." --config=3DMC3R1.R18.2,reports+=3D{safe,"all_area(all_loc(any_exp(macro(^pa= ge_to_pdx$))))"} +-doc_begin=3D"The XEN team relies on the fact that invariant conditions of= 'if' +statements are deliberate" +-config=3DMC3R1.R14.3,statements=3D{deliberate , "wrapped(any(),node(if_st= mt))" } -doc_end =20 # @@ -306,6 +291,17 @@ in assignments." {safe, "left_right(^[(,\\[]$,^[),\\]]$)"} -doc_end =20 +# +# General +# + +-doc_begin=3D"do-while-0 is a well recognized loop idiom by the xen commun= ity." +-loop_idioms=3D{do_stmt, "literal(0)"} +-doc_end +-doc_begin=3D"while-[01] is a well recognized loop idiom by the xen commun= ity." +-loop_idioms+=3D{while_stmt, "literal(0)||literal(1)"} +-doc_end + # # Developer confusion # diff --git a/automation/eclair_analysis/ECLAIR/tagging.ecl b/automation/ecl= air_analysis/ECLAIR/tagging.ecl index 78a0bc948b..e82277fea3 100644 --- a/automation/eclair_analysis/ECLAIR/tagging.ecl +++ b/automation/eclair_analysis/ECLAIR/tagging.ecl @@ -19,7 +19,7 @@ =20 -doc=3D"Accepted guidelines as reported in XEN/docs/misra/rules.rst" -service_selector=3D{accepted_guidelines, - "MC3R1.D1.1||MC3R1.D2.1||MC3R1.D4.1||MC3R1.D4.3||MC3R1.D4.7||MC3R1.D4.= 10||MC3R1.D4.11||MC3R1.D4.14||MC3R1.R1.1||MC3R1.R1.3||MC3R1.R1.4||MC3R1.R2.= 1||MC3R1.R2.2||MC3R1.R2.6||MC3R1.R2.2||MC3R1.R3.1||MC3R1.R3.2||MC3R1.R4.1||= MC3R1.R4.2||MC3R1.R5.1||MC3R1.R5.2||MC3R1.R5.3||MC3R1.R5.4||MC3R1.R5.6||MC3= R1.R6.1||MC3R1.R6.2||MC3R1.R7.1||MC3R1.R7.2||MC3R1.R7.3||MC3R1.R7.4||MC3R1.= R8.1||MC3R1.R8.2||MC3R1.R8.3||MC3R1.R8.4||MC3R1.R8.5||MC3R1.R8.6||MC3R1.R8.= 8||MC3R1.R8.10||MC3R1.R8.12||MC3R1.R8.14||MC3R1.R9.1||MC3R1.R9.2||MC3R1.R9.= 3||MC3R1.R9.4||MC3R1.R9.5||MC3R1.R10.1||MC3R1.R10.2||MC3R1.R10.3||MC3R1.R10= .4||MC3R1.R12.5||MC3R1.R13.6||MC3R1.R13.1||MC3R1.R14.1||MC3R1.R14.3||MC3R1.= R16.7||MC3R1.R17.3||MC3R1.R17.4||MC3R1.R17.6||MC3R1.R18.3||MC3R1.R19.1||MC3= R1.R20.7||MC3R1.R20.13||MC3R1.R20.14||MC3R1.R21.13||MC3R1.R21.17||MC3R1.R21= .18||MC3R1.R21.19||MC3R1.R21.20||MC3R1.R21.21||MC3R1.R22.2||MC3R1.R22.4||MC= 3R1.R22.5||MC3R1.R22.6" + "MC3R1.D1.1||MC3R1.D2.1||MC3R1.D4.1||MC3R1.D4.3||MC3R1.D4.7||MC3R1.D4.= 10||MC3R1.D4.11||MC3R1.D4.14||MC3R1.R1.1||MC3R1.R1.3||MC3R1.R1.4||MC3R1.R2.= 1||MC3R1.R2.2||MC3R1.R2.6||MC3R1.R3.1||MC3R1.R3.2||MC3R1.R4.1||MC3R1.R4.2||= MC3R1.R5.1||MC3R1.R5.2||MC3R1.R5.3||MC3R1.R5.4||MC3R1.R5.6||MC3R1.R6.1||MC3= R1.R6.2||MC3R1.R7.1||MC3R1.R7.2||MC3R1.R7.3||MC3R1.R7.4||MC3R1.R8.1||MC3R1.= R8.2||MC3R1.R8.3||MC3R1.R8.4||MC3R1.R8.5||MC3R1.R8.6||MC3R1.R8.8||MC3R1.R8.= 10||MC3R1.R8.12||MC3R1.R8.14||MC3R1.R9.1||MC3R1.R9.2||MC3R1.R9.3||MC3R1.R9.= 4||MC3R1.R9.5||MC3R1.R10.1||MC3R1.R10.2||MC3R1.R10.3||MC3R1.R10.4||MC3R1.R1= 1.7||MC3R1.R11.8||MC3R1.R11.9||MC3R1.R12.5||MC3R1.R13.1||MC3R1.R13.5||MC3R1= .R13.6||MC3R1.R14.1||MC3R1.R14.2||MC3R1.R14.3||MC3R1.R16.7||MC3R1.R17.3||MC= 3R1.R17.4||MC3R1.R17.6||MC3R1.R18.3||MC3R1.R19.1||MC3R1.R20.7||MC3R1.R20.13= ||MC3R1.R20.14||MC3R1.R21.13||MC3R1.R21.17||MC3R1.R21.18||MC3R1.R21.19||MC3= R1.R21.20||MC3R1.R21.21||MC3R1.R22.2||MC3R1.R22.4||MC3R1.R22.5||MC3R1.R22.6" } -doc=3D"All reports of accepted guidelines are tagged as accepted." -reports+=3D{status:accepted,"service(accepted_guidelines)"} @@ -30,7 +30,7 @@ =20 -doc_begin=3D"Clean guidelines: new violations for these guidelines are no= t accepted." =20 --service_selector=3D{clean_guidelines_common,"MC3R1.D1.1||MC3R1.D2.1||MC3R= 1.D4.11||MC3R1.D4.14||MC3R1.R1.1||MC3R1.R1.3||MC3R1.R1.4||MC3R1.R2.2||MC3R1= .R3.1||MC3R1.R3.2||MC3R1.R4.1||MC3R1.R5.1||MC3R1.R5.2||MC3R1.R5.4||MC3R1.R6= .1||MC3R1.R6.2||MC3R1.R7.1||MC3R1.R8.1||MC3R1.R8.5||MC3R1.R8.8||MC3R1.R8.10= ||MC3R1.R8.12||MC3R1.R8.14||MC3R1.R9.2||MC3R1.R9.4||MC3R1.R9.5||MC3R1.R12.5= ||MC3R1.R17.3||MC3R1.R17.4||MC3R1.R17.6||MC3R1.R21.13||MC3R1.R21.19||MC3R1.= R21.21||MC3R1.R22.2||MC3R1.R22.4||MC3R1.R22.5||MC3R1.R22.6" +-service_selector=3D{clean_guidelines_common,"MC3R1.D1.1||MC3R1.D2.1||MC3R= 1.D4.11||MC3R1.D4.14||MC3R1.R1.1||MC3R1.R1.3||MC3R1.R1.4||MC3R1.R2.2||MC3R1= .R3.1||MC3R1.R3.2||MC3R1.R4.1||MC3R1.R4.2||MC3R1.R5.1||MC3R1.R5.2||MC3R1.R5= .4||MC3R1.R6.1||MC3R1.R6.2||MC3R1.R7.1||MC3R1.R8.1||MC3R1.R8.5||MC3R1.R8.8|= |MC3R1.R8.10||MC3R1.R8.12||MC3R1.R8.14||MC3R1.R9.2||MC3R1.R9.4||MC3R1.R9.5|= |MC3R1.R12.5||MC3R1.R17.3||MC3R1.R17.4||MC3R1.R17.6||MC3R1.R20.13||MC3R1.R2= 0.14||MC3R1.R21.13||MC3R1.R21.19||MC3R1.R21.21||MC3R1.R22.2||MC3R1.R22.4||M= C3R1.R22.5||MC3R1.R22.6" } =20 -setq=3Dtarget,getenv("XEN_TARGET_ARCH") --=20 2.34.1