devtools: add cppcheck wrapper
Checks
Commit Message
Adding wrapper script for cppcheck code analysis tool.
usage: cppcheck.sh [-h] [path]
Without any argument current folder scanned with all sub folders, if
'path' argument provided, that 'path' is scanned with all its
subfolders, like:
"./devtools/cppcheck.sh lib/librte_ethdev/"
The output log is saved to 'cppcheck_error.txt' in current folder.
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
devtools/cppcheck.sh | 67 ++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 67 insertions(+)
create mode 100755 devtools/cppcheck.sh
Comments
11/02/2021 18:27, Ferruh Yigit:
> +CPPCHECK_BIN=cppcheck
> +out=cppcheck_error.txt
In general we generate files in $(mktemp -t dpdk.cppcheck.XXXXXX)
The path is printed at the end anyway.
> +
> +which ${CPPCHECK_BIN} > /dev/null 2> /dev/null
> +if [ $? -ne 0 ]; then
> + echo "${CPPCHECK_BIN} is missing!"
Curly braces are not needed.
> + exit 1
> +fi
> +
> +print_usage () {
> + cat <<- END_OF_HELP
> + usage: $(basename $0) [-h] [path]
> +
> + Wrapper on checkpatch tool. Output goes to ${out} file.
s/checkpatch/cppcheck/
> +
> + Without parameter current folder with all subfolders scanned. It is possible
> + to provide a sub-folder to recude the scan to that folder.
A bit hard to read :)
> + END_OF_HELP
> +}
> +
> +if [ "$1" = "-h" ]; then
> + print_usage
> + exit 1;
> +fi
> +
> +dir=${1:-$(dirname $(readlink -f $0))/..}
> +if [ ! -e ${dir} ]; then
> + echo "\"${dir}\" is not valid folder/file to check"
> + exit 1
> +fi
> +
> +
> +suppress_args="
> + --suppress=invalidPrintfArgType_sint \
> + --suppress=invalidPrintfArgType_uint \
> + --suppress=duplicateAssignExpression \
> + --suppress=nullPointerRedundantCheck \
> + --suppress=identicalConditionAfterEarlyExit \
> + --suppress=objectIndex
> + "
> +
> +# all, warning, performance, portability,
> +# information, unusedFunction, missingInclude
> +additional_checks=warning
> +
> +${CPPCHECK_BIN} \
> + -j64 \
> + --language=c \
> + --enable=${additional_checks} \
> + --force \
> + ${suppress_args} \
> + ${dir} \
> + 2> ${out}
Is it possible to have only errors by default in the output,
and add all lines about what is being checked in a verbose mode?
> +
> +if [ $? -eq 0 ]; then
> + echo -e "\nOutput saved to ${out}"
Please prefer printf.
> +else
> + exit $?
> +fi
The report has 2000 lines of defects,
and it seems to have lots of false positive.
Is it possible to reduce them?
new file mode 100755
@@ -0,0 +1,67 @@
+#! /bin/sh
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2021 Intel Corporation
+
+# wrapper script for cppcheck code analysis tool
+# Args:
+# $1: path to scan (optional)
+
+CPPCHECK_BIN=cppcheck
+out=cppcheck_error.txt
+
+which ${CPPCHECK_BIN} > /dev/null 2> /dev/null
+if [ $? -ne 0 ]; then
+ echo "${CPPCHECK_BIN} is missing!"
+ exit 1
+fi
+
+print_usage () {
+ cat <<- END_OF_HELP
+ usage: $(basename $0) [-h] [path]
+
+ Wrapper on checkpatch tool. Output goes to ${out} file.
+
+ Without parameter current folder with all subfolders scanned. It is possible
+ to provide a sub-folder to recude the scan to that folder.
+ END_OF_HELP
+}
+
+if [ "$1" = "-h" ]; then
+ print_usage
+ exit 1;
+fi
+
+dir=${1:-$(dirname $(readlink -f $0))/..}
+if [ ! -e ${dir} ]; then
+ echo "\"${dir}\" is not valid folder/file to check"
+ exit 1
+fi
+
+
+suppress_args="
+ --suppress=invalidPrintfArgType_sint \
+ --suppress=invalidPrintfArgType_uint \
+ --suppress=duplicateAssignExpression \
+ --suppress=nullPointerRedundantCheck \
+ --suppress=identicalConditionAfterEarlyExit \
+ --suppress=objectIndex
+ "
+
+# all, warning, performance, portability,
+# information, unusedFunction, missingInclude
+additional_checks=warning
+
+${CPPCHECK_BIN} \
+ -j64 \
+ --language=c \
+ --enable=${additional_checks} \
+ --force \
+ ${suppress_args} \
+ ${dir} \
+ 2> ${out}
+
+if [ $? -eq 0 ]; then
+ echo -e "\nOutput saved to ${out}"
+else
+ exit $?
+fi