From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 36118A0558; Sat, 15 Oct 2022 14:59:09 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 288B842C08; Sat, 15 Oct 2022 14:59:09 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id C7E0040E25 for ; Sat, 15 Oct 2022 14:59:07 +0200 (CEST) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.17.1.5/8.17.1.5) with ESMTP id 29FCRW6k012559; Sat, 15 Oct 2022 05:59:07 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-transfer-encoding : content-type; s=pfpt0220; bh=cdBeGmBf8/EOon8S3ZMc6N8zfPNqUweOQItAK/tL8FU=; b=FdDV3f1pP7HVqCMvaCd1FwujBsGl5ycnxE1rLsXM8pZOatqHNQ5ZiGjVDWkdoWQGaTQD EM0l7Wh6YFkh/l6qBQ2d5Z2EI2d/aMDydCD4cD7fgJXzUoZmTSXEoXsRaq+usgdHvhrD h6RXBD3JaA84ooVFNmIKTsm0/uFc2UweUUdKCpyqnARtoaDqCnrCxBZdlpP1IJPl4Yla WG3145unamcH6yY3l9cPbGfX4Y9QFTE4dBIsd82vNxgqPjiZVw5ZJQ7atx/abiFCYdKp TcIThJdFP9/wNO2I3aQs9B4V/lXwMmt5qQPzsdskfpeDZZ/i7M3GF7sdbUVZF0zxyLai 3g== Received: from dc5-exch01.marvell.com ([199.233.59.181]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3k7t7q8dgr-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Sat, 15 Oct 2022 05:59:06 -0700 Received: from DC5-EXCH01.marvell.com (10.69.176.38) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Sat, 15 Oct 2022 05:59:05 -0700 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server id 15.0.1497.2 via Frontend Transport; Sat, 15 Oct 2022 05:59:05 -0700 Received: from hyd1349.t110.caveonetworks.com.com (unknown [10.29.45.13]) by maili.marvell.com (Postfix) with ESMTP id 047313F7071; Sat, 15 Oct 2022 05:59:02 -0700 (PDT) From: Ankur Dwivedi To: CC: , , , , , , Ankur Dwivedi Subject: [PATCH v3 2/2] devtools: add tracepoint check in checkpatch Date: Sat, 15 Oct 2022 18:28:26 +0530 Message-ID: <20221015125826.27760-3-adwivedi@marvell.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20221015125826.27760-1-adwivedi@marvell.com> References: <20221012114525.12220-1-adwivedi@marvell.com> <20221015125826.27760-1-adwivedi@marvell.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Proofpoint-ORIG-GUID: SC3PZzOAbZnYk2gDXXYqTLQhsczEdkCw X-Proofpoint-GUID: SC3PZzOAbZnYk2gDXXYqTLQhsczEdkCw X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.205,Aquarius:18.0.895,Hydra:6.0.545,FMLib:17.11.122.1 definitions=2022-10-15_08,2022-10-14_01,2022-06-22_01 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org This patch adds a validation in checkpatch tool, to check if a tracepoint is present in any new function added in cryptodev library. It uses the existing build_map_changes function to create a map of functions. In the map, the newly added functions are identified and their definition are checked for the presence of tracepoint. The checkpatch return error if the tracepoint is not present. For functions for which trace is not needed, they can be added to devtools/trace-skiplist.txt file. The above tracepoint check will be skipped for them. Signed-off-by: Ankur Dwivedi --- devtools/check-tracepoint.sh | 129 +++++++++++++++++++++++++++++++++++ devtools/checkpatches.sh | 9 +++ devtools/trace-skiplist.txt | 0 3 files changed, 138 insertions(+) create mode 100755 devtools/check-tracepoint.sh create mode 100644 devtools/trace-skiplist.txt diff --git a/devtools/check-tracepoint.sh b/devtools/check-tracepoint.sh new file mode 100755 index 0000000000..2e8a33758c --- /dev/null +++ b/devtools/check-tracepoint.sh @@ -0,0 +1,129 @@ +#!/bin/sh +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (C) 2022 Marvell. + +selfdir=$(dirname $(readlink -f $0)) +. $selfdir/build-symbol-map.sh + +# Library for trace check +libdir="cryptodev" + +# Functions for which the trace check can be skipped +skiplist="$selfdir/trace-skiplist.txt" + +find_trace_fn() +{ + local fname="$1" + + cat "$fname" | awk -v symname="$2 *\\\(" ' + # Initialize the variables. + # The variable symname provides a pattern to match + # "function_name(", zero or more spaces can be present + # between function_name and (. + BEGIN {found=0; fndef=""} + + # Matches the function name, set found=1. + $0 ~ symname {found=1} + + # If closing parentheses with semicolon ");" is found, then it + # is not the function definition. + /) *;/ { + if (found == 1) { + found=0 + } + } + + # If closing parentheses is found, this is the start of function + # definition. Check for tracepoint in the function definition. + # The tracepoint has _trace_ in its name. + /)/ { + if (found == 1) { + while (index($0, "}") == 0) { + if (index($0, "_trace_") != 0) { + exit 0 + } + if (getline <= 0) { + break + } + } + exit 1 + } + } + ' +} + +check_for_tracepoint() +{ + local patch="$1" + local mapdb="$2" + local skip_sym + local libname + local secname + local mname + local ret=0 + local pdir + local libp + local libn + local sym + local ar + + while read -r mname symname secname ar; do + pdir=$(echo $mname | awk 'BEGIN {FS="/"};{print $2}') + libname=$(echo $mname | awk 'BEGIN {FS="/"};{print $3}') + skip_sym=0 + libp=0 + + if [ "$pdir" != "lib" ]; then + continue + fi + + for libn in $libdir; do + if [ $libn = $libname ]; then + libp=1 + break + fi + done + + if [ $libp -eq 0 ]; then + continue + fi + + for sym in $(cat $skiplist); do + if [ $sym = $symname ]; then + skip_sym=1 + break + fi + done + + if [ $skip_sym -eq 1 ]; then + continue + fi + + if [ "$ar" = "add" ] && [ "$secname" = "EXPERIMENTAL" ]; then + # Check if new API is added with tracepoint + find_trace_fn $patch $symname + if [ $? -eq 1 ]; then + ret=1 + echo -n "ERROR: New function $symname is added " + echo -n "without a tracepoint. Please add a tracepoint " + echo -n "or add the function $symname in " + echo "devtools/trace-skiplist.txt to skip this error." + fi + fi + done < "$mapdb" + + return $ret +} + +clean_and_exit_on_sig() +{ + rm -rf "$mapfile" +} + +trap clean_and_exit_on_sig EXIT + +mapfile=$(mktemp -t dpdk.mapdb.XXXXXX) +patch=$1 + +build_map_changes "$patch" "$mapfile" +check_for_tracepoint "$patch" "$mapfile" diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index 1f1175c4f1..7392560460 100755 --- a/devtools/checkpatches.sh +++ b/devtools/checkpatches.sh @@ -10,6 +10,7 @@ . $(dirname $(readlink -f $0))/load-devel-config VALIDATE_NEW_API=$(dirname $(readlink -f $0))/check-symbol-change.sh +VALIDATE_TRACEPOINT=$(dirname $(readlink -f $0))/check-tracepoint.sh # Enable codespell by default. This can be overwritten from a config file. # Codespell can also be enabled by setting DPDK_CHECKPATCH_CODESPELL to a valid path @@ -352,6 +353,14 @@ check () { # ret=1 fi + ! $verbose || printf '\nChecking API additions with tracepoint :\n' + report=$($VALIDATE_TRACEPOINT "$tmpinput") + if [ $? -ne 0 ] ; then + $headline_printed || print_headline "$3" + printf '%s\n' "$report" + ret=1 + fi + if [ "$tmpinput" != "$1" ]; then rm -f "$tmpinput" trap - INT diff --git a/devtools/trace-skiplist.txt b/devtools/trace-skiplist.txt new file mode 100644 index 0000000000..e69de29bb2 -- 2.28.0