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 2EC9841DC9; Fri, 3 Mar 2023 16:58:37 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2068D42B8E; Fri, 3 Mar 2023 16:58:37 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by mails.dpdk.org (Postfix) with ESMTP id 7066D42B71 for ; Fri, 3 Mar 2023 16:58:35 +0100 (CET) Received: from pps.filterd (m0045851.ppops.net [127.0.0.1]) by mx0b-0016f401.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 323EEbcQ031698; Fri, 3 Mar 2023 07:58:34 -0800 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=abWI6eLiMQ4/I/v2mzBdPdXmKmOront8FrxWkeHgp3s=; b=Ff5rusFklXhdGnRILtTh3n/OBHrLUh0qNBiR2NNOjjSJOIT1fXO5one1PRMkFxbvBfAU vIEGJNC0lb54i+Dvds93phNHcf4Mk+GKH1Ei12lTZ7CEcDx+Qfe4oyR/8rax94VFQLzI AZJCNUKj1v9Xz6c2L9klmPr0KmyD15L+/lU8ONllSkoBoUtAQZewfYztnOWjxImG5QO6 AE2Y61R5dnXPgGayhbPbTvh+sQ2ws22VVwWDU2Xv+9rIVlFu2wX8BRD+df74MoDqAcpp c0GJMICeUHuR4S8vzc/nrfJXXbK9mulRu+2L0NE+umtohJA7ntpox1QyYlamXvU5YiB9 7g== Received: from dc5-exch02.marvell.com ([199.233.59.182]) by mx0b-0016f401.pphosted.com (PPS) with ESMTPS id 3p3jbqremr-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Fri, 03 Mar 2023 07:58:34 -0800 Received: from DC5-EXCH01.marvell.com (10.69.176.38) by DC5-EXCH02.marvell.com (10.69.176.39) with Microsoft SMTP Server (TLS) id 15.0.1497.42; Fri, 3 Mar 2023 07:58:32 -0800 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.42 via Frontend Transport; Fri, 3 Mar 2023 07:58:32 -0800 Received: from localhost.localdomain (unknown [10.28.36.185]) by maili.marvell.com (Postfix) with ESMTP id BE0743F7074; Fri, 3 Mar 2023 07:58:30 -0800 (PST) From: Ankur Dwivedi To: CC: , , Ankur Dwivedi Subject: [PATCH v4 2/2] devtools: add tracepoint check in checkpatch Date: Fri, 3 Mar 2023 21:28:11 +0530 Message-ID: <20230303155811.2751210-3-adwivedi@marvell.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230303155811.2751210-1-adwivedi@marvell.com> References: <20221015125826.27760-1-adwivedi@marvell.com> <20230303155811.2751210-1-adwivedi@marvell.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Proofpoint-ORIG-GUID: 76C2GKyGZd1k2BipNlhudEimpO_92iMC X-Proofpoint-GUID: 76C2GKyGZd1k2BipNlhudEimpO_92iMC X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.219,Aquarius:18.0.942,Hydra:6.0.573,FMLib:17.11.170.22 definitions=2023-03-03_03,2023-03-03_01,2023-02-09_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 ethdev library. It uses the existing build_map_changes function to create a map of functions. In the map, the newly added functions, added in the experimental section 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 | 146 +++++++++++++++++++++++++++++++++++ devtools/checkpatches.sh | 9 +++ devtools/trace-skiplist.txt | 0 3 files changed, 155 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..591d5cd397 --- /dev/null +++ b/devtools/check-tracepoint.sh @@ -0,0 +1,146 @@ +#!/bin/sh +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (C) 2023 Marvell. + +selfdir=$(dirname $(readlink -f $0)) +. $selfdir/build-symbol-map.sh + +# Library for trace check +libdir="ethdev" + +# 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} + + # 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 (found == 1) { + ln_pth = NR + } + } + + # If closing parentheses and then opening braces is found in + # adjacent line, then this is the start of function + # definition. Check for tracepoint in the function definition. + # The tracepoint has _trace_ in its name. + /{/ { + if (found == 1) { + if (ln_pth != NR - 1) { + found = 0 + next + } + while (index($0, "}") != 2) { + 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 +} + +trap clean_and_exit_on_sig EXIT + +mapfile=`mktemp -t dpdk.mapdb.XXXXXX` +patch=$1 +exit_code=1 + +clean_and_exit_on_sig() +{ + rm -f "$mapfile" + exit $exit_code +} + +build_map_changes "$patch" "$mapfile" +check_for_tracepoint "$patch" "$mapfile" +exit_code=$? +rm -f "$mapfile" + +exit $exit_code diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index 1dee094c7a..471db1d21b 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 @@ -386,6 +387,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 "$subject" + 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.25.1