debug/xtrace.sh

   1 #!/bin/bash
   2 # Copyright (C) 1999-2024 Free Software Foundation, Inc.
   3 # This file is part of the GNU C Library.
   4
   5 # The GNU C Library is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU Lesser General Public
   7 # License as published by the Free Software Foundation; either
   8 # version 2.1 of the License, or (at your option) any later version.
   9
  10 # The GNU C Library is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # Lesser General Public License for more details.
  14
  15 # You should have received a copy of the GNU Lesser General Public
  16 # License along with the GNU C Library; if not, see
  17 # <https://www.gnu.org/licenses/>.
  18
  19 pcprofileso='@SLIBDIR@/libpcprofile.so'
  20 pcprofiledump='@BINDIR@/pcprofiledump'
  21 TEXTDOMAIN=libc
  22
  23 # Print usage message.
  24 do_usage() {
  25   printf $"Usage: xtrace [OPTION]... PROGRAM [PROGRAMOPTION]...\n"
  26   exit 0
  27 }
  28
  29 # Refer to --help option.
  30 help_info() {
  31   printf >&2 $"Try \`%s --help' or \`%s --usage' for more information.\n" xtrace xtrace
  32   exit 1
  33 }
  34
  35 # Message for missing argument.
  36 do_missing_arg() {
  37   printf >&2 $"%s: option '%s' requires an argument.\n" xtrace "$1"
  38   help_info
  39 }
  40
  41 # Print help message
  42 do_help() {
  43   printf $"Usage: xtrace [OPTION]... PROGRAM [PROGRAMOPTION]...\n"
  44   printf $"Trace execution of program by printing currently executed function.
  45
  46      --data=FILE          Don't run the program, just print the data from FILE.
  47
  48    -?,--help              Print this help and exit
  49       --usage             Give a short usage message
  50    -V,--version           Print version information and exit
  51
  52 Mandatory arguments to long options are also mandatory for any corresponding
  53 short options.
  54
  55 "
  56   printf $"For bug reporting instructions, please see:\\n%s.\\n" \
  57     "@REPORT_BUGS_TO@"
  58   exit 0
  59 }
  60
  61 do_version() {
  62   echo 'xtrace @PKGVERSION@@VERSION@'
  63   printf $"Copyright (C) %s Free Software Foundation, Inc.
  64 This is free software; see the source for copying conditions.  There is NO
  65 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  66 " "2024"
  67   printf $"Written by %s.
  68 " "Ulrich Drepper"
  69   exit 0
  70 }
  71
  72 # Print out function name, file, and line number in a nicely formatted way.
  73 format_line() {
  74   fct=$1
  75   file=${2%%:*}
  76   line=${2##*:}
  77   width=$(expr $COLUMNS - 30)
  78   filelen=$(expr length $file)
  79   if test "$filelen" -gt "$width"; then
  80     rwidth=$(expr $width - 3)
  81     file="...$(expr substr $file $(expr 1 + $filelen - $rwidth) $rwidth)"
  82   fi
  83   printf '%-20s  %-*s  %6s\n' $fct $width $file $line
  84 }
  85
  86
  87 # If the variable COLUMNS is not set do this now.
  88 COLUMNS=${COLUMNS:-80}
  89
  90 # If `TERMINAL_PROG' is not set, set it to `xterm'.
  91 TERMINAL_PROG=${TERMINAL_PROG:-xterm}
  92
  93 # The data file to process, if any.
  94 data=
  95
  96 # Process arguments.  But stop as soon as the program name is found.
  97 while test $# -gt 0; do
  98   case "$1" in
  99   --d | --da | --dat | --data)
 100     if test $# -eq 1; then
 101       do_missing_arg $1
 102     fi
 103     shift
 104     data="$1"
 105     ;;
 106   --d=* | --da=* | --dat=* | --data=*)
 107     data=${1##*=}
 108     ;;
 109   -\? | --h | --he | --hel | --help)
 110     do_help
 111     ;;
 112   -V | --v | --ve | --ver | --vers | --versi | --versio | --version)
 113     do_version
 114     ;;
 115   --u | --us | --usa | --usag | --usage)
 116     do_usage
 117     ;;
 118   --)
 119     # Stop processing arguments.
 120     shift
 121     break
 122     ;;
 123   --*)
 124     printf >&2 $"xtrace: unrecognized option \`$1'\n"
 125     help_info
 126     ;;
 127   *)
 128     # Unknown option.  This means the rest is the program name and parameters.
 129     break
 130     ;;
 131   esac
 132   shift
 133 done
 134
 135 # See whether any arguments are left.
 136 if test $# -eq 0; then
 137   printf >&2 $"No program name given\n"
 138   help_info
 139 fi
 140
 141 # Determine the program name and check whether it exists.
 142 program=$1
 143 shift
 144 if test ! -f "$program"; then
 145   printf >&2 $"executable \`$program' not found\n"
 146   help_info
 147 fi
 148 if test ! -x "$program"; then
 149   printf >&2 $"\`$program' is no executable\n"
 150   help_info
 151 fi
 152
 153 # We have two modes.  If a data file is given simply print the included data.
 154 printf "%-20s  %-*s  %6s\n" Function $(expr $COLUMNS - 30) File Line
 155 for i in $(seq 1 $COLUMNS); do printf -; done; printf '\n'
 156 if test -n "$data"; then
 157   $pcprofiledump "$data" |
 158   sed 's/this = \([^,]*\).*/\1/' |
 159   addr2line -fC -e "$program" |
 160   while read fct; do
 161     read file
 162     if test "$fct" != '??' -a "$file" != '??:0'; then
 163       format_line "$fct" "$file"
 164     fi
 165   done
 166 else
 167   fifo=$(mktemp -ut xtrace.XXXXXX) || exit
 168   trap 'rm -f "$fifo"; exit 1' HUP INT QUIT TERM PIPE
 169   mkfifo -m 0600 $fifo || exit 1
 170
 171   # Now start the program and let it write to the FIFO.
 172   $TERMINAL_PROG -T "xtrace - $program $*" -e /bin/sh -c "LD_PRELOAD=$pcprofileso PCPROFILE_OUTPUT=$fifo $program $*; read < $fifo" &
 173   termpid=$!
 174   $pcprofiledump -u "$fifo" |
 175   while read line; do
 176      echo "$line" |
 177      sed 's/this = \([^,]*\).*/\1/' |
 178      addr2line -fC -e "$program"
 179   done |
 180   while read fct; do
 181     read file
 182     if test "$fct" != '??' -a "$file" != '??:0'; then
 183       format_line "$fct" "$file"
 184     fi
 185   done
 186   read -p "Press return here to close $TERMINAL_PROG($program)."
 187   echo > "$fifo"
 188   rm "$fifo"
 189 fi
 190
 191 exit 0
 192 # Local Variables:
 193 #  mode:ksh
 194 # End: