Revert "sq h2"

[metze/wireshark/wip.git] / tools / valgrind-wireshark.sh

diff --git a/tools/valgrind-wireshark.sh b/tools/valgrind-wireshark.sh
index 7fbacc4a7aee8f309652409d94fa33f928729f80..c5592e0b02d6c86597d2f46f5cc6e7477fe321a6 100755 (executable)
--- a/tools/valgrind-wireshark.sh
+++ b/tools/valgrind-wireshark.sh
@@ -5,28 +5,16 @@
 #
 # Copyright 2012 Jeff Morriss <jeff.morriss.ws [AT] gmail.com>
 #
-# $Id$
-#
 # Wireshark - Network traffic analyzer
 # By Gerald Combs <gerald@wireshark.org>
 # Copyright 1998 Gerald Combs
 #
-# This program is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License
-# as published by the Free Software Foundation; either version 2
-# of the License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# SPDX-License-Identifier: GPL-2.0-or-later
 
-# Directory containing tshark or wireshark.  Default current directory.
-BIN_DIR=.
+# Directory containing tshark or wireshark.  Default: cmake run directory.
+if [ -z "$WIRESHARK_BIN_DIR" ]; then
+    WIRESHARK_BIN_DIR=run
+fi
 
 # Use tshark by default
 COMMAND=tshark
@@ -34,21 +22,26 @@ COMMAND_ARGS="-nr"
 COMMAND_ARGS2=
 VALID=0
 PCAP=""
-TOOL=""
+TOOL="memcheck"
 
-while getopts ":2b:C:lmnprtTwcevW" OPTCHAR ; do
+while getopts ":2a:b:C:lmnpP:rstTYwcevWdG" OPTCHAR ; do
     case $OPTCHAR in
         2) COMMAND_ARGS="-2 $COMMAND_ARGS" ;;
-        b) BIN_DIR=$OPTARG ;;
+        a) ADDITIONAL_SUPPRESSION_FILE="$ADDITIONAL_SUPPRESSION_FILE --suppressions=$OPTARG" ;;
+        b) WIRESHARK_BIN_DIR=$OPTARG ;;
         C) COMMAND_ARGS="-C $OPTARG $COMMAND_ARGS" ;;
         l) LEAK_CHECK="--leak-check=full" ;;
-        m) TOOL="--tool=massif" ;;
+        m) TOOL="massif" ;;
         n) COMMAND_ARGS="-v"
            VALID=1 ;;
-        p) TOOL="--tool=callgrind" ;;
+        p) TOOL="callgrind" ;;
+        P) TOOL="callgrind"
+           CALLGRIND_OUT_FILE="--callgrind-out-file=$OPTARG" ;;
         r) REACHABLE="--show-reachable=yes" ;;
+        s) GEN_SUPPRESSIONS="--gen-suppressions=yes" ;;
         t) TRACK_ORIGINS="--track-origins=yes" ;;
         T) COMMAND_ARGS="-Vx $COMMAND_ARGS" ;; # "build the Tree"
+        Y) COMMAND_ARGS="-Y frame $COMMAND_ARGS" ;; # Run with a read filter (but no tree)
         w) COMMAND=wireshark
            COMMAND_ARGS="-nr" ;;
         c) COMMAND=capinfos
@@ -57,15 +50,25 @@ while getopts ":2b:C:lmnprtTwcevW" OPTCHAR ; do
            COMMAND_ARGS="-E 0.02"
            # We don't care about the output of editcap
            COMMAND_ARGS2="/dev/null" ;;
-        v) VERBOSE="--num-callers=256" ;;
+        v) VERBOSE="--num-callers=256 -v" ;;
         W) COMMAND=wireshark
            COMMAND_ARGS=""
            VALID=1 ;;
-        *) printf "Unknown option -$OPTARG!\n"
+        d) COMMAND=dumpcap
+           COMMAND_ARGS="-i eth1 -c 3000"
+           VALID=1 ;;
+        *) printf "Unknown option: %s\\n" "$OPTARG"
            exit ;;
     esac
 done
-shift $(($OPTIND - 1))
+shift $(( OPTIND - 1 ))
+
+# Sanitize parameters
+if [ "$COMMAND" != "tshark" ] && [[ $COMMAND_ARGS =~ Vx ]]
+then
+    printf "\\nYou can't use -T if you're not using tshark\\n\\n" >&2
+    exit 1
+fi
 
 if [ $# -ge 1 ]
 then
@@ -75,17 +78,46 @@ fi
 
 if [ $VALID -eq 0 ]
 then
-    printf "Usage: $0 [-2] [-b bin_dir] [-c] [-e] [-C config_profile] [-l] [-n] [-r] [-t] [-T] [-w] [-v] /path/to/file.pcap\n"
+    printf "\\nUsage: %s [-2] [-a file] [-b bin_dir] [-c] [-e] [-C config_profile] " "$(basename "$0")"
+    printf "[-l] [-m] [-n] [-p] [-r] [-s] [-t] [-T] [-w] [-v] /path/to/file.pcap\\n"
+    printf "\\n"
+    printf "[-2]: run tshark with 2-pass analysis\\n"
+    printf "[-a]: additional valgrind suppression file\\n"
+    printf "[-b]: tshark binary dir\\n"
+    printf "[-e]: use 'editcap -E 0.02' instead of tshark\\n"
+    printf "[-c]: use capinfos instead of tshark\\n"
+    printf "[-C]: binary profile file\\n"
+    printf "[-l]: add valgrind option --leak-check=full\\n"
+    printf "[-m]: use valgrind massif tool\\n"
+    printf "[-n]: print binary version\\n"
+    printf "[-p]: use callgrind massif tool\\n"
+    printf "[-r]: add valgrind option --show-reachable=yes\\n"
+    printf "[-s]: add valgrind option --gen-suppressions=yes\\n"
+    printf "[-t]: add valgrind option --track-origins=yes\\n"
+    printf "[-T]: build the tshark tree (-Vx)\\n"
+    printf "[-w]: use wireshark instead of tshark\\n"
+    printf "[-v]: run in verbose mode (--num-callers=256)\\n"
     exit 1
 fi
 
-if [ "$BIN_DIR" = "." ]; then
+if [ "$WIRESHARK_BIN_DIR" = "." ]; then
     export WIRESHARK_RUN_FROM_BUILD_DIRECTORY=
 fi
 
-export WIRESHARK_DEBUG_EP_NO_CHUNKS=
-export WIRESHARK_DEBUG_SE_NO_CHUNKS=
-export WIRESHARK_DEBUG_WMEM_OVERRIDE=simple
-export G_SLICE=always-malloc # or debug-blocks
+if [ "$TOOL" != "callgrind" ]; then
+    export WIRESHARK_DEBUG_WMEM_OVERRIDE=simple
+    export G_SLICE=always-malloc # or debug-blocks
+fi
+
+COMMAND="$WIRESHARK_BIN_DIR/$COMMAND"
+
+cmdline="valgrind --suppressions=$( dirname "$0" )/vg-suppressions $ADDITIONAL_SUPPRESSION_FILE \
+--tool=$TOOL $CALLGRIND_OUT_FILE $VERBOSE $LEAK_CHECK $REACHABLE $GEN_SUPPRESSIONS $TRACK_ORIGINS \
+$COMMAND $COMMAND_ARGS $PCAP $COMMAND_ARGS2"
+
+if [ "$VERBOSE" != "" ];then
+  echo -e "\\n$cmdline\\n"
+fi
 
-./libtool --mode=execute valgrind $TOOL $VERBOSE $LEAK_CHECK $REACHABLE $TRACK_ORIGINS $BIN_DIR/$COMMAND $COMMAND_ARGS $PCAP $COMMAND_ARGS2 > /dev/null
+# shellcheck disable=SC2086
+exec $cmdline > /dev/null