Xen project Mailing List

[xen master] automation/eclair_analysis: file exclusion automation

Date: Sat, 16 Dec 2023 10:22:01 +0000

Delivery-date: Sat, 16 Dec 2023 10:22:13 +0000

List-id: "Change log for Mercurial $receive only$" <xen-changelog.lists.xenproject.org>

commit 896c1917868889c3561ef4fec7d12e4a2e309705 Author: Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx> AuthorDate: Mon Dec 11 09:55:16 2023 +0100 Commit: Stefano Stabellini <stefano.stabellini@xxxxxxx> CommitDate: Fri Dec 15 13:07:11 2023 -0800 automation/eclair_analysis: file exclusion automation The file exclude-list.json contains files that are classified as adopted code for MISRA compliance. Therefore, this file is used to automatically generate a suitable .ecl configuration for ECLAIR. As such, many entries in out_of_scope.ecl can be removed, as they would be duplicates. Signed-off-by: Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx> Reviewed-by: Stefano Stabellini <sstabellini@xxxxxxxxxx> --- automation/eclair_analysis/ECLAIR/adopted.sh | 30 ++++++++++ automation/eclair_analysis/ECLAIR/analysis.ecl | 3 + automation/eclair_analysis/ECLAIR/analyze.sh | 3 + automation/eclair_analysis/ECLAIR/generate_ecl.sh | 15 +++++ automation/eclair_analysis/ECLAIR/out_of_scope.ecl | 64 ---------------------- .../eclair_analysis/ECLAIR/print_analyzed_files.sh | 4 +- docs/misra/exclude-list.json | 4 ++ 7 files changed, 58 insertions(+), 65 deletions(-) diff --git a/automation/eclair_analysis/ECLAIR/adopted.sh b/automation/eclair_analysis/ECLAIR/adopted.sh new file mode 100755 index 0000000000..9adbc4e582 --- /dev/null +++ b/automation/eclair_analysis/ECLAIR/adopted.sh @@ -0,0 +1,30 @@ +#!/bin/bash + +# Generates the adopted.ecl file + +set -eu + +script_name="$(basename "$0")" +script_dir="$( + cd "$(dirname "$0")" + echo "${PWD}" +)" + +fatal() { + echo "${script_name}: $*" >&2 + exit 1 +} + +usage() { + fatal "Usage: ${script_name}" +} + +exclude_list=$1 +outfile=${script_dir}/adopted.ecl + +( + echo "-doc_begin=\"Adopted files.\"" >"${outfile}" + sed -n -E -e 's|^\s+"rel_path":\s+"([^"]*).*$|-file_tag+={adopted,"^xen/\1$"}|p' "${exclude_list}" | + sed -E -e 's|\.([ch])|\\\\.\1|g' -e 's|\*|.*|g' >>"${outfile}" + printf "%s\n" "-doc_end" >>"${outfile}" +) diff --git a/automation/eclair_analysis/ECLAIR/analysis.ecl b/automation/eclair_analysis/ECLAIR/analysis.ecl index f8d4cc8c99..a604582da3 100644 --- a/automation/eclair_analysis/ECLAIR/analysis.ecl +++ b/automation/eclair_analysis/ECLAIR/analysis.ecl @@ -21,6 +21,9 @@ map_strings("scheduled-analysis",analysis_kind) -eval_file=toolchain.ecl -eval_file=public_APIs.ecl +if(not(scheduled_analysis), + eval_file("adopted.ecl") +) if(not(scheduled_analysis), eval_file("out_of_scope.ecl") ) diff --git a/automation/eclair_analysis/ECLAIR/analyze.sh b/automation/eclair_analysis/ECLAIR/analyze.sh index 47cdbb03ce..a127e7aaed 100755 --- a/automation/eclair_analysis/ECLAIR/analyze.sh +++ b/automation/eclair_analysis/ECLAIR/analyze.sh @@ -82,6 +82,9 @@ export ECLAIR_PROJECT_ROOT="${PWD}" rm -rf "${ECLAIR_OUTPUT_DIR:?}/*" mkdir -p "${ECLAIR_DATA_DIR}" +# Generate additional configuration files +"${SCRIPT_DIR}/generate_ecl.sh" + # Perform the build (from scratch) in an ECLAIR environment. "${ECLAIR_BIN_DIR}eclair_env" \ "-config_file='${SCRIPT_DIR}/analysis.ecl'" \ diff --git a/automation/eclair_analysis/ECLAIR/generate_ecl.sh b/automation/eclair_analysis/ECLAIR/generate_ecl.sh new file mode 100755 index 0000000000..de20728eb1 --- /dev/null +++ b/automation/eclair_analysis/ECLAIR/generate_ecl.sh @@ -0,0 +1,15 @@ +#!/bin/bash + +# Generates the .ecl files + +set -eu + +script_dir="$( + cd "$(dirname "$0")" + echo "${PWD}" +)" + +exclude_list="${ECLAIR_PROJECT_ROOT}/docs/misra/exclude-list.json" + +# Generate the exclude list file +"${script_dir}/adopted.sh" "${exclude_list}" diff --git a/automation/eclair_analysis/ECLAIR/out_of_scope.ecl b/automation/eclair_analysis/ECLAIR/out_of_scope.ecl index e1ec4a607c..fd870716cf 100644 --- a/automation/eclair_analysis/ECLAIR/out_of_scope.ecl +++ b/automation/eclair_analysis/ECLAIR/out_of_scope.ecl @@ -1,55 +1,3 @@ --doc_begin="Imported from Linux: ignore for now." --file_tag+={adopted,"^xen/common/libfdt/.*$"} --file_tag+={adopted,"^xen/include/xen/libfdt/.*$"} --file_tag+={adopted,"^xen/common/xz/.*$"} --file_tag+={adopted,"^xen/common/zstd/.*$"} --file_tag+={adopted,"^xen/drivers/acpi/apei/.*$"} --file_tag+={adopted,"^xen/drivers/acpi/tables/.*$"} --file_tag+={adopted,"^xen/drivers/acpi/utilities/.*$"} --file_tag+={adopted,"^xen/drivers/video/font_.*$"} --file_tag+={adopted,"^xen/arch/arm/arm64/cpufeature\\.c$"} --file_tag+={adopted,"^xen/arch/arm/arm64/insn\\.c$"} --file_tag+={adopted,"^xen/arch/arm/arm64/lib/find_next_bit\\.c$"} --file_tag+={adopted,"^xen/common/bitmap\\.c$"} --file_tag+={adopted,"^xen/common/bunzip2\\.c$"} --file_tag+={adopted,"^xen/common/earlycpio\\.c$"} --file_tag+={adopted,"^xen/common/inflate\\.c$"} --file_tag+={adopted,"^xen/common/lzo\\.c$"} --file_tag+={adopted,"^xen/common/lz4/decompress\\.c$"} --file_tag+={adopted,"^xen/common/radix-tree\\.c$"} --file_tag+={adopted,"^xen/common/ubsan/ubsan\\.c$"} --file_tag+={adopted,"^xen/drivers/acpi/hwregs\\.c$"} --file_tag+={adopted,"^xen/drivers/acpi/numa\\.c$"} --file_tag+={adopted,"^xen/drivers/acpi/osl\\.c$"} --file_tag+={adopted,"^xen/drivers/acpi/tables\\.c$"} --file_tag+={adopted,"^xen/include/xen/acpi\\.h$"} --file_tag+={adopted,"^xen/include/acpi/acpiosxf\\.h$"} --file_tag+={adopted,"^xen/include/acpi/acpixf\\.h$"} --file_tag+={adopted,"^xen/lib/list-sort\\.c$"} --file_tag+={adopted,"^xen/lib/rbtree\\.c$"} --file_tag+={adopted,"^xen/lib/xxhash.*\\.c$"} --file_tag+={adopted,"^xen/arch/x86/acpi/boot\\.c$"} --file_tag+={adopted,"^xen/arch/x86/acpi/cpu_idle\\.c$"} --file_tag+={adopted,"^xen/arch/x86/acpi/cpufreq/cpufreq\\.c$"} --file_tag+={adopted,"^xen/arch/x86/acpi/cpuidle_menu\\.c$"} --file_tag+={adopted,"^xen/arch/x86/acpi/lib\\.c$"} --file_tag+={adopted,"^xen/arch/x86/cpu/amd\\.c$"} --file_tag+={adopted,"^xen/arch/x86/cpu/centaur\\.c$"} --file_tag+={adopted,"^xen/arch/x86/cpu/common\\.c$"} --file_tag+={adopted,"^xen/arch/x86/cpu/hygon\\.c$"} --file_tag+={adopted,"^xen/arch/x86/cpu/intel\\.c$"} --file_tag+={adopted,"^xen/arch/x86/cpu/intel_cacheinfo\\.c$"} --file_tag+={adopted,"^xen/arch/x86/cpu/mcheck/non-fatal\\.c$"} --file_tag+={adopted,"^xen/arch/x86/cpu/mtrr/.*$"} --file_tag+={adopted,"^xen/arch/x86/cpu/mwait-idle\\.c$"} --file_tag+={adopted,"^xen/arch/x86/delay\\.c$"} --file_tag+={adopted,"^xen/arch/x86/dmi_scan\\.c$"} --file_tag+={adopted,"^xen/arch/x86/mpparse\\.c$"} --file_tag+={adopted,"^xen/arch/x86/srat\\.c$"} --file_tag+={adopted,"^xen/arch/x86/time\\.c$"} --file_tag+={adopted,"^xen/arch/x86/x86_64/mmconf-fam10h\\.c$"} --doc_end - -doc_begin="Intel specific source files are out of scope." -file_tag+={out_of_scope,"^xen/arch/x86/cpu/intel\\.c$"} -file_tag+={out_of_scope,"^xen/arch/x86/cpu/intel_cacheinfo\\.c$"} @@ -69,18 +17,6 @@ -file_tag+={out_of_scope,"^xen/arch/x86/include/asm/intel-family\\.h$"} -doc_end --doc_begin="Not in scope initially as it generates many violations and it is not enabled in safety configurations." --file_tag+={adopted,"^xen/xsm/flask/.*$"} --doc_end - --doc_begin="unlz4.c implementation by Yann Collet, the others un* are from Linux, ignore for now." --file_tag+={adopted,"^xen/common/un.*\\.c$"} --doc_end - --doc_begin="Origin is external and documented in xen/crypto/README.source ." --file_tag+={adopted,"^xen/crypto/.*$"} --doc_end - -doc_begin="Files imported from the gnu-efi package" -file_tag+={adopted,"^xen/include/efi/.*$"} -file_tag+={adopted,"^xen/arch/x86/include/asm/x86_64/efibind\\.h$"} diff --git a/automation/eclair_analysis/ECLAIR/print_analyzed_files.sh b/automation/eclair_analysis/ECLAIR/print_analyzed_files.sh index c19a8ecbd0..7d23127161 100755 --- a/automation/eclair_analysis/ECLAIR/print_analyzed_files.sh +++ b/automation/eclair_analysis/ECLAIR/print_analyzed_files.sh @@ -46,7 +46,9 @@ fi "${ECLAIR_BIN_DIR}eclair_report" -db="${DB}" -files_txt="${files_txt}" { - # Extracting out of scope code + # Extracting out of scope and adopted code + adopted_ecl="${script_dir}/adopted.ecl" + extrapolate_regex adopted, "${adopted_ecl}" out_of_scope_ecl="${script_dir}/out_of_scope.ecl" extrapolate_regex adopted, "${out_of_scope_ecl}" extrapolate_regex out_of_scope_tools, "${out_of_scope_ecl}" diff --git a/docs/misra/exclude-list.json b/docs/misra/exclude-list.json index 24e4de3ca5..48f671c548 100644 --- a/docs/misra/exclude-list.json +++ b/docs/misra/exclude-list.json @@ -117,6 +117,10 @@ "rel_path": "common/libfdt/*", "comment": "External library" }, + { + "rel_path": "include/xen/libfdt/*", + "comment": "External library" + }, { "rel_path": "common/livepatch_elf.c", "comment": "Not in scope initially as it generates many violations and it is not enabled in safety configurations" -- generated by git-patchbot for /home/xen/git/xen.git#master

©2013 Xen Project, A Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation.
Xen Project is a trademark of The Linux Foundation.