From patchwork Wed Jan 31 11:02:39 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luca Fancellu X-Patchwork-Id: 13539210 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 DDC4DC47DDF for ; Wed, 31 Jan 2024 11:03:21 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.673919.1048509 (Exim 4.92) (envelope-from ) id 1rV8N4-0001qU-Rh; Wed, 31 Jan 2024 11:03:10 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 673919.1048509; Wed, 31 Jan 2024 11:03:10 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1rV8N4-0001qN-O5; Wed, 31 Jan 2024 11:03:10 +0000 Received: by outflank-mailman (input) for mailman id 673919; Wed, 31 Jan 2024 11:03:08 +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 1rV8N2-0001NU-KK for xen-devel@lists.xenproject.org; Wed, 31 Jan 2024 11:03:08 +0000 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by se1-gles-flk1.inumbo.com (Halon) with ESMTP id 4f869515-c028-11ee-98f5-efadbce2ee36; Wed, 31 Jan 2024 12:03:06 +0100 (CET) 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 3894311FB; Wed, 31 Jan 2024 03:03:49 -0800 (PST) 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 4A2883F762; Wed, 31 Jan 2024 03:03:05 -0800 (PST) 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: 4f869515-c028-11ee-98f5-efadbce2ee36 From: Luca Fancellu To: xen-devel@lists.xenproject.org Cc: Stefano Stabellini Subject: [PATCH 1/3] xen-analysis.py: Use named group for tag regex Date: Wed, 31 Jan 2024 11:02:39 +0000 Message-Id: <20240131110241.3951995-2-luca.fancellu@arm.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240131110241.3951995-1-luca.fancellu@arm.com> References: <20240131110241.3951995-1-luca.fancellu@arm.com> MIME-Version: 1.0 Use named group for the regex matching a tag identifier, this is done to ease retrieving the matching group instead of using an index. Signed-off-by: Luca Fancellu --- xen/scripts/xen_analysis/cppcheck_analysis.py | 4 ++-- xen/scripts/xen_analysis/tag_database.py | 24 +++++++++---------- xen/scripts/xen_analysis/utils.py | 2 +- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/xen/scripts/xen_analysis/cppcheck_analysis.py b/xen/scripts/xen_analysis/cppcheck_analysis.py index e54848aa5339..919eb153ce9c 100644 --- a/xen/scripts/xen_analysis/cppcheck_analysis.py +++ b/xen/scripts/xen_analysis/cppcheck_analysis.py @@ -41,7 +41,7 @@ def __generate_suppression_list(out_file): # The following lambda function will return a file if it contains lines with # a comment containing "cppcheck-suppress[*]" on a single line. grep_action = lambda x: utils.grep(x, - r'^[ \t]*/\* cppcheck-suppress\[(.*)\] \*/$') + r'^[ \t]*/\* cppcheck-suppress\[(?P.*)\] \*/$') # Look for a list of .h files that matches the condition above headers = utils.recursive_find_file(settings.xen_dir, r'.*\.h$', grep_action) @@ -97,7 +97,7 @@ def __generate_suppression_list(out_file): if (not comment_section) and comment_line_starts: comment_section = True if (len(line.strip()) != 0) and (not comment_section): - cppcheck_violation_id = entry["matches"][line_num][0] + cppcheck_violation_id = entry["matches"][line_num]['id'] break if comment_section and comment_line_stops: comment_section = False diff --git a/xen/scripts/xen_analysis/tag_database.py b/xen/scripts/xen_analysis/tag_database.py index ca374bbb62dd..abba163aec71 100644 --- a/xen/scripts/xen_analysis/tag_database.py +++ b/xen/scripts/xen_analysis/tag_database.py @@ -18,11 +18,12 @@ tool_syntax = { def get_xen_tag_index_type_regex(tool): - return r'^SAF-(\d+)-(safe|false-positive-' + tool + ')$' + return rf'^SAF-(?P\d+)-(?Psafe|false-positive-{tool})$' def get_xen_tag_comment_regex(tool): - return r'^[ \t]*/\* +(SAF-\d+-(?:safe|false-positive-' + tool + ')).*\*/$' + tag=rf'(?PSAF-\d+-(?:safe|false-positive-{tool}))' + return rf'^[ \t]*/\* +{tag}.*\*/$' # Returns a data structure containing dictionaries for safe and false-positive-* @@ -60,12 +61,11 @@ def load_tag_database(tool, input_files, data_struct = None, schema = "safe"): if proprietary_id != "": comment=tool_syntax[tool].replace("VID",proprietary_id) # Regex to capture the index of the Xen tag and the schema - xen_tag = re.compile(get_xen_tag_index_type_regex(tool))\ - .match(entry["id"]) - if xen_tag and xen_tag.group(1) and xen_tag.group(2): + xen_tag = re.match(get_xen_tag_index_type_regex(tool), entry["id"]) + if xen_tag and xen_tag.group('id') and xen_tag.group('type'): # Save in safe or false-positive-* the key {#id: "comment"} - id_number = int(xen_tag.group(1)) - key = xen_tag.group(2) + id_number = int(xen_tag.group('id')) + key = xen_tag.group('type') ret[key][id_number] = "/* {} */\n".format(comment) else: raise TagDatabaseError( @@ -95,11 +95,11 @@ def substitute_tags(tool, input_file, grep_struct, subs_rules): # information access the subs_rules dictionary to see if there is # a match for line_number in grep_struct["matches"]: - xen_tag = grep_struct["matches"][line_number][0] - xen_tag_regex_obj = re.compile( - get_xen_tag_index_type_regex(tool)).match(xen_tag) - id_number = int(xen_tag_regex_obj.group(1)) - key = xen_tag_regex_obj.group(2) + xen_tag = grep_struct["matches"][line_number]['tag'] + xen_tag_regex_obj = re.match(get_xen_tag_index_type_regex(tool), + xen_tag) + id_number = int(xen_tag_regex_obj.group('id')) + key = xen_tag_regex_obj.group('type') if id_number in subs_rules[key]: parsed_content[line_number-1] = subs_rules[key][id_number] diff --git a/xen/scripts/xen_analysis/utils.py b/xen/scripts/xen_analysis/utils.py index 1193e3f4631e..eef48eeb7e87 100644 --- a/xen/scripts/xen_analysis/utils.py +++ b/xen/scripts/xen_analysis/utils.py @@ -12,7 +12,7 @@ def grep(filepath, regex): for line in f: match = regObj.match(line) if match: - res["matches"][line_number] = match.groups() + res["matches"][line_number] = match line_number = line_number + 1 except Exception as e: print("WARNING: Can't open {}: {}".format(filepath, e)) From patchwork Wed Jan 31 11:02:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luca Fancellu X-Patchwork-Id: 13539211 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 9FBFCC4828D for ; Wed, 31 Jan 2024 11:03:22 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.673918.1048494 (Exim 4.92) (envelope-from ) id 1rV8N3-0001R3-Ia; Wed, 31 Jan 2024 11:03:09 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 673918.1048494; Wed, 31 Jan 2024 11:03:09 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1rV8N3-0001QO-Di; Wed, 31 Jan 2024 11:03:09 +0000 Received: by outflank-mailman (input) for mailman id 673918; Wed, 31 Jan 2024 11:03:08 +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 1rV8N2-0001NO-BK for xen-devel@lists.xenproject.org; Wed, 31 Jan 2024 11:03:08 +0000 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by se1-gles-sth1.inumbo.com (Halon) with ESMTP id 4ff0d39e-c028-11ee-8a43-1f161083a0e0; Wed, 31 Jan 2024 12:03:07 +0100 (CET) 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 D5AE71477; Wed, 31 Jan 2024 03:03:49 -0800 (PST) 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 E71183F762; Wed, 31 Jan 2024 03:03:05 -0800 (PST) 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: 4ff0d39e-c028-11ee-8a43-1f161083a0e0 From: Luca Fancellu To: xen-devel@lists.xenproject.org Cc: Stefano Stabellini Subject: [PATCH 2/3] xen-analysis.py: Substitute only the comment instead of the line Date: Wed, 31 Jan 2024 11:02:40 +0000 Message-Id: <20240131110241.3951995-3-luca.fancellu@arm.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240131110241.3951995-1-luca.fancellu@arm.com> References: <20240131110241.3951995-1-luca.fancellu@arm.com> MIME-Version: 1.0 Change the code in tag_database.py to substitute only the SAF-* comment instead of replacing the line. Signed-off-by: Luca Fancellu --- xen/scripts/xen_analysis/tag_database.py | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/xen/scripts/xen_analysis/tag_database.py b/xen/scripts/xen_analysis/tag_database.py index abba163aec71..dc0558a46ed6 100644 --- a/xen/scripts/xen_analysis/tag_database.py +++ b/xen/scripts/xen_analysis/tag_database.py @@ -16,14 +16,18 @@ tool_syntax = { "eclair":"-E> hide VID 1 \"\"" } +def get_xen_tag_regex(tool): + return rf'(?PSAF-(?P\d+)-(?Psafe|false-positive-{tool}))' + def get_xen_tag_index_type_regex(tool): - return rf'^SAF-(?P\d+)-(?Psafe|false-positive-{tool})$' + return rf'^{get_xen_tag_regex(tool)}$' def get_xen_tag_comment_regex(tool): - tag=rf'(?PSAF-\d+-(?:safe|false-positive-{tool}))' - return rf'^[ \t]*/\* +{tag}.*\*/$' + before_comment = r'(?P[ \t]*)' + comment = rf'(?P/\* +{get_xen_tag_regex(tool)}.*\*/)' + return rf'^(?P{before_comment}{comment})$' # Returns a data structure containing dictionaries for safe and false-positive-* @@ -66,7 +70,7 @@ def load_tag_database(tool, input_files, data_struct = None, schema = "safe"): # Save in safe or false-positive-* the key {#id: "comment"} id_number = int(xen_tag.group('id')) key = xen_tag.group('type') - ret[key][id_number] = "/* {} */\n".format(comment) + ret[key][id_number] = "/* {} */".format(comment) else: raise TagDatabaseError( "Error in database file, entry {} has unexpected " @@ -101,7 +105,11 @@ def substitute_tags(tool, input_file, grep_struct, subs_rules): id_number = int(xen_tag_regex_obj.group('id')) key = xen_tag_regex_obj.group('type') if id_number in subs_rules[key]: - parsed_content[line_number-1] = subs_rules[key][id_number] + comment_in = grep_struct["matches"][line_number]['comment'] + comment_out = subs_rules[key][id_number] + parsed_content[line_number-1] = re.sub( + re.escape(comment_in), comment_out, + parsed_content[line_number-1]) outfile.writelines(parsed_content) except Exception as e: From patchwork Wed Jan 31 11:02:41 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luca Fancellu X-Patchwork-Id: 13539209 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 8525FC47258 for ; Wed, 31 Jan 2024 11:03:20 +0000 (UTC) Received: from list by lists.xenproject.org with outflank-mailman.673920.1048515 (Exim 4.92) (envelope-from ) id 1rV8N5-0001tp-4d; Wed, 31 Jan 2024 11:03:11 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 673920.1048515; Wed, 31 Jan 2024 11:03:11 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1rV8N4-0001t9-Vc; Wed, 31 Jan 2024 11:03:10 +0000 Received: by outflank-mailman (input) for mailman id 673920; Wed, 31 Jan 2024 11:03:10 +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 1rV8N4-0001NU-5G for xen-devel@lists.xenproject.org; Wed, 31 Jan 2024 11:03:10 +0000 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by se1-gles-flk1.inumbo.com (Halon) with ESMTP id 50b4dbc4-c028-11ee-98f5-efadbce2ee36; Wed, 31 Jan 2024 12:03:08 +0100 (CET) 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 0D7F61480; Wed, 31 Jan 2024 03:03:51 -0800 (PST) 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 91AFD3F762; Wed, 31 Jan 2024 03:03:06 -0800 (PST) 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: 50b4dbc4-c028-11ee-98f5-efadbce2ee36 From: Luca Fancellu To: xen-devel@lists.xenproject.org Cc: Andrew Cooper , George Dunlap , Jan Beulich , Julien Grall , Stefano Stabellini , Wei Liu Subject: [PATCH 3/3] xen-analysis.py: Accept deviation comment at the end of the line Date: Wed, 31 Jan 2024 11:02:41 +0000 Message-Id: <20240131110241.3951995-4-luca.fancellu@arm.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240131110241.3951995-1-luca.fancellu@arm.com> References: <20240131110241.3951995-1-luca.fancellu@arm.com> MIME-Version: 1.0 Implement the in-code suppression comment at the end of the line. Now it is possible to add a Xen deviaiton comment with the syntax described in the docs at the end of the line affected by the violation, to deviate it. Eclair natively supports it, so the translation for the tool will be straighforward, but the other tool needs to translate an occurrence of the tag into a suppressino comment at the end of the previous line, this will have a corner case where the line number 1 of the file can't be deviated in this way for such tools. Updated documentation. Signed-off-by: Luca Fancellu --- docs/misra/documenting-violations.rst | 10 ++++++++ xen/scripts/xen_analysis/cppcheck_analysis.py | 2 +- xen/scripts/xen_analysis/generic_analysis.py | 14 +++++++---- xen/scripts/xen_analysis/tag_database.py | 25 ++++++++++++++++++- 4 files changed, 44 insertions(+), 7 deletions(-) diff --git a/docs/misra/documenting-violations.rst b/docs/misra/documenting-violations.rst index 0d02a8e6f905..8f1cbd83b859 100644 --- a/docs/misra/documenting-violations.rst +++ b/docs/misra/documenting-violations.rst @@ -210,3 +210,13 @@ will be an entry like the following and the violation id will be in the column Given the violation id "misra-c2012-20.7", the procedure above can be followed to justify this finding. + +Another way to justify the above violation is to put the in-code comment tag +at the end of the affected line:: + +| extern char _start[], _end[], start[]; /* SAF-1-safe [...] */ + +This way of deviating violations needs however to be used only when placing the +tag above the line can't be done. This option suffers from some limitation on +cppcheck and coverity tool that don't support natively the suppression comment +at the end of the line. diff --git a/xen/scripts/xen_analysis/cppcheck_analysis.py b/xen/scripts/xen_analysis/cppcheck_analysis.py index 919eb153ce9c..850335c998a3 100644 --- a/xen/scripts/xen_analysis/cppcheck_analysis.py +++ b/xen/scripts/xen_analysis/cppcheck_analysis.py @@ -41,7 +41,7 @@ def __generate_suppression_list(out_file): # The following lambda function will return a file if it contains lines with # a comment containing "cppcheck-suppress[*]" on a single line. grep_action = lambda x: utils.grep(x, - r'^[ \t]*/\* cppcheck-suppress\[(?P.*)\] \*/$') + r'^.*/\* cppcheck-suppress\[(?P.*)\] \*/$') # Look for a list of .h files that matches the condition above headers = utils.recursive_find_file(settings.xen_dir, r'.*\.h$', grep_action) diff --git a/xen/scripts/xen_analysis/generic_analysis.py b/xen/scripts/xen_analysis/generic_analysis.py index 94122aebace0..9e0cfc1bbc08 100644 --- a/xen/scripts/xen_analysis/generic_analysis.py +++ b/xen/scripts/xen_analysis/generic_analysis.py @@ -52,11 +52,15 @@ def parse_xen_tags(): os.rename(file, bkp_file) time_bkp_file = os.stat(bkp_file) # Create from .safparse but with the Xen tag parsed - tag_database.substitute_tags(settings.analysis_tool, bkp_file, entry, - subs_list) - # Set timestamp for file equal to bkp_file, so that if the file is - # modified during the process by the user, we can catch it - os.utime(file, (time_bkp_file.st_atime, time_bkp_file.st_mtime)) + try: + tag_database.substitute_tags(settings.analysis_tool, bkp_file, entry, + subs_list) + except Exception as e: + raise ParseTagPhaseError("{}".format(e)) + finally: + # Set timestamp for file equal to bkp_file, so that if the file is + # modified during the process by the user, we can catch it + os.utime(file, (time_bkp_file.st_atime, time_bkp_file.st_mtime)) def build_xen(): diff --git a/xen/scripts/xen_analysis/tag_database.py b/xen/scripts/xen_analysis/tag_database.py index dc0558a46ed6..57746ca0ddb6 100644 --- a/xen/scripts/xen_analysis/tag_database.py +++ b/xen/scripts/xen_analysis/tag_database.py @@ -25,7 +25,7 @@ def get_xen_tag_index_type_regex(tool): def get_xen_tag_comment_regex(tool): - before_comment = r'(?P[ \t]*)' + before_comment = r'(?P.*)' comment = rf'(?P/\* +{get_xen_tag_regex(tool)}.*\*/)' return rf'^(?P{before_comment}{comment})$' @@ -106,7 +106,30 @@ def substitute_tags(tool, input_file, grep_struct, subs_rules): key = xen_tag_regex_obj.group('type') if id_number in subs_rules[key]: comment_in = grep_struct["matches"][line_number]['comment'] + before = grep_struct["matches"][line_number]['before'] comment_out = subs_rules[key][id_number] + if before != '' and not re.match(r'^[ \t]+$', before): + # The comment is at the end of some line with some code + if tool == "eclair": + # Eclair supports comment at the end of the line, so + # the only thing to do is use the right syntax in + # the comment, the default version of it is + # deviating the current line and the next one + comment_out = re.sub(r'\d+ ""', '0 ""', comment_out) + else: + # Other tool does not support deviating the same + # line of the comment, so we use a trick and we use + # the comment at the end of the previous line + if line_number-2 < 0: + raise TagDatabaseError( + "The comment {} using the tool '{}' can't " + "stay at the end of the line 1." + .format(comment_in, tool) + ) + parsed_content[line_number-2] = \ + parsed_content[line_number-2].replace("\n", + comment_out + '\n') + comment_out = '' parsed_content[line_number-1] = re.sub( re.escape(comment_in), comment_out, parsed_content[line_number-1])