DPDK patches and discussions
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: ferruh.yigit@amd.com
Cc: dev@dpdk.org, Ferruh Yigit <ferruh.yigit@intel.com>,
	Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH] devtools: add cppcheck wrapper
Date: Mon, 12 Jun 2023 16:55:16 -0700	[thread overview]
Message-ID: <20230612235516.63546-1-stephen@networkplumber.org> (raw)
In-Reply-To: <20210211172758.2977369-1-ferruh.yigit@intel.com>

From: Ferruh Yigit <ferruh.yigit@intel.com>

Adding wrapper script for cppcheck code analysis tool.

usage: cppcheck.sh [-h] [cppcheck options] [path]

Example:
 $ ./devtools/cppcheck.sh -q lib/ethdev/

The tool is useful but gets confused by macros in parts of DPDK.
It identified some bogus code in netvsc driver, and some possible
issues in pcapng.

Would also like to do another round of dead code squashing

Revised and simplified from original version by Ferruh Yigit.
Let the user redirect output as they want, and allow passing
options such as -q (quiet) and -v (verbose).

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 devtools/cppcheck.sh | 59 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100755 devtools/cppcheck.sh

diff --git a/devtools/cppcheck.sh b/devtools/cppcheck.sh
new file mode 100755
index 000000000000..df885df61423
--- /dev/null
+++ b/devtools/cppcheck.sh
@@ -0,0 +1,59 @@
+#! /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
+RTE_CONFIG=./build/rte_build_config.h
+
+which $CPPCHECK_BIN > /dev/null 2> /dev/null
+if [ $? -ne 0 ]; then
+	echo "$CPPCHECK_BIN is missing!" >&2
+	exit 1
+fi
+
+if [ ! -r $RTE_CONFIG ]; then
+	echo "Build not configured missing $RTE_CONFIG" >&2
+	exit 1
+fi
+
+print_usage () {
+	cat <<- END_OF_HELP
+	usage: $(basename $0) [-h] [cppcheck options] [file or path]
+
+	Run Linux cppcheck tool with DPDK options.
+
+	END_OF_HELP
+}
+
+if [ "$1" = "-h" ]; then
+	print_usage
+	exit 1;
+fi
+
+suppress_args="
+	--suppress=invalidPrintfArgType_sint \
+	--suppress=invalidPrintfArgType_uint \
+	--suppress=duplicateAssignExpression \
+	--suppress=nullPointerRedundantCheck \
+	--suppress=identicalConditionAfterEarlyExit \
+	--suppress=objectIndex \
+	--suppress=unknownMacro \
+	"
+
+includes="
+	--include=$RTE_CONFIG \
+	--includes-file=lib/eal/include \
+	--includes-file=lib/eal/linux/include \
+	"
+
+# all, warning, performance, portability,
+# information, unusedFunction, missingInclude
+additional_checks=warning
+
+${CPPCHECK_BIN}	--language=c ${includes} \
+		--enable=${additional_checks} \
+		--force ${suppress_args} $@
-- 
2.39.2


      parent reply	other threads:[~2023-06-12 23:55 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-11 17:27 [dpdk-dev] " Ferruh Yigit
2021-05-20  7:48 ` Thomas Monjalon
2023-06-12 23:55 ` Stephen Hemminger [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230612235516.63546-1-stephen@networkplumber.org \
    --to=stephen@networkplumber.org \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@amd.com \
    --cc=ferruh.yigit@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).