usttrace

   1 #!/bin/bash
   2
   3 # usttrace  by Pierre-Marc Fournier 2009
   4 # Distributed under the GPLv2.
   5
   6 function error() {
   7         echo "$0: error: $1" 2>/dev/stderr
   8 }
   9
  10 function sighandler() {
  11         echo "Caught Ctrl-C"
  12         if [ -z "$USTDPID" ]; then
  13                 USTDPID="$(<$pidfilepath)"
  14         fi
  15         # Tell the daemon to die
  16         kill -SIGTERM "$USTDPID"
  17
  18         echo "Waiting for ustd to shutdown..."
  19         wait "$USTDPID"
  20
  21         rm "$pidfilepath"
  22
  23         exit 0;
  24 }
  25
  26 USTTRACE_DIR="$(dirname $0)"
  27 if [ -x "${USTTRACE_DIR}/ustd/ustd" ] ; then
  28     # Use the not installed libraries instead
  29     USTD="${USTTRACE_DIR}/ustd/ustd"
  30     LIBINTERFORK_PATH="${USTTRACE_DIR}/libustfork/.libs/libustfork.so"
  31     LIBMALLOCWRAP_PATH="${USTTRACE_DIR}/libustinstr-malloc/.libs/libustinstr-malloc.so"
  32     LIBUST_PATH="${USTTRACE_DIR}/libust/.libs/libust.so"
  33 else
  34     # Use the libraries that the dynamic link finds
  35     USTD="ustd"
  36     if [ ! -x "$(which ustd 2>/dev/null)" ]; then
  37         error "cannot find an executable ustd; make sure its location is in the PATH"
  38         exit 1
  39     fi
  40     LIBINTERFORK_PATH="libustfork.so"
  41     LIBMALLOCWRAP_PATH="libustinstr-malloc.so"
  42     LIBUST_PATH="libust.so.0"
  43 fi
  44
  45 BASE_TRACE_DIR="${HOME}/.usttraces"
  46
  47 function usage () {
  48         echo "usage:  $0 OPTIONS COMMAND" 2>/dev/stderr
  49         echo "" 2>/dev/stderr
  50         echo "Options:" 2>/dev/stderr
  51         echo "    -l    Runtime link with UST library." 2>/dev/stderr
  52         echo "          (Needed only if program was not linked at compile time with libust.)" 2>/dev/stderr
  53         echo "    -L    Add path to ust libraries to LD_LIBRARY_PATH." 2>/dev/stderr
  54         echo "    -m    Instrument malloc calls." 2>/dev/stderr
  55         echo "    -f    Also trace forked processes." 2>/dev/stderr
  56         echo "    -s    Use system-wide daemon instead of creating one for this session." 2>/dev/stderr
  57         echo "    -S    Specify the subbuffer size." 2>/dev/stderr
  58         echo "    -N    Specify the number of subbuffers." 2>/dev/stderr
  59 }
  60
  61 while getopts ":hlLmfsWS:N:" options; do
  62         case $options in
  63                 l) arg_preload_libust=1;;
  64                 L) arg_ld_std_ust=1;;
  65                 m) arg_preload_malloc=1;;
  66                 f) arg_preload_fork=1;;
  67                 s) arg_syswide_daemon=1;;
  68                 W) where=1;;
  69                 S) export UST_SUBBUF_SIZE=$OPTARG;;
  70                 N) export UST_SUBBUF_NUM=$OPTARG;;
  71                 h) usage;
  72                    exit 0;;
  73                 \?) usage
  74                         exit 1;;
  75                 *) usage
  76                         exit 1;;
  77         esac
  78 done
  79 shift $(($OPTIND - 1))
  80
  81 if [ -n "$where" ]; then
  82         echo $BASE_TRACE_DIR/$(ls "$BASE_TRACE_DIR" | tail -n 1)
  83         exit 0
  84 fi
  85
  86 # Prepare vars
  87 CMD=$*
  88
  89 # Validate input
  90 if [ -z "$HOME" ];
  91 then
  92         error "no home specified"
  93 fi
  94
  95 if [ -z "$CMD" ];
  96 then
  97         error "no command specified"
  98         usage;
  99         exit 1
 100 fi
 101
 102 # Create directory for trace output
 103 DATESTRING="$(hostname)-$(date +%Y%m%d%H%M%S%N)"
 104 OUTDIR="$BASE_TRACE_DIR/$DATESTRING"
 105 mkdir -p "$OUTDIR"
 106
 107 # Choose ustd socket path
 108 USTDSOCKPATH="/tmp/ustd-sock-$$"
 109
 110 if [ "$arg_syswide_daemon" != "1" ];
 111 then
 112         pidfilepath="/tmp/usttrace-$USER-$(date +%Y%m%d%H%M%S%N)-ustd-pid"
 113         trap "sighandler $pidfilepath" SIGINT
 114         mkfifo -m 0600 "$pidfilepath"
 115         # Start daemon
 116         $USTD --pidfile "$pidfilepath" -s "$USTDSOCKPATH" -o "$OUTDIR" >"$OUTDIR/ustd.log" 2>&1 &
 117         # ustd sets up its server socket
 118         # ustd opens the pidfile, blocks because no one has opened it
 119         # we open pidfile
 120         # we block reading pidfile
 121         # ustd writes to pidfile
 122         # ustd closes pidfile
 123         # we unblock reading pidfile
 124         USTDPID="$(<$pidfilepath)"
 125         export UST_DAEMON_SOCKET="$USTDSOCKPATH"
 126 fi
 127
 128 # Establish the environment for the command
 129 (
 130     export UST_TRACE=1
 131     export UST_AUTOPROBE=1
 132
 133     if [ "$arg_preload_libust" = "1" ];
 134     then
 135         if [ -n "${LIBUST_PATH%libust.so}" ];
 136         then
 137                 if [ -n "$LD_LIBRARY_PATH" ];
 138                 then
 139                         export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${LIBUST_PATH%libust.so}"
 140                 else
 141                         export LD_LIBRARY_PATH="${LIBUST_PATH%libust.so}"
 142                 fi
 143         fi
 144         if [ -n "$LIBUST_PATH" ];
 145         then
 146                 if [ -n "$LD_PRELOAD" ];
 147                 then
 148                         export LD_PRELOAD="$LD_PRELOAD:$LIBUST_PATH"
 149                 else
 150                         export LD_PRELOAD="$LIBUST_PATH"
 151                 fi
 152         fi
 153     fi
 154
 155     if [ "$arg_ld_std_ust" = "1" ] && [ -n "${LIBUST_PATH%libust.so}" ];
 156     then
 157         if [ -n "$LD_LIBRARY_PATH" ];
 158         then
 159                 export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${LIBUST_PATH%libust.so}"
 160         else
 161                 export LD_LIBRARY_PATH="${LIBUST_PATH%libust.so}"
 162         fi
 163     fi
 164
 165     if [ "$arg_preload_malloc" = "1" ] && [ -n "$LIBMALLOCWRAP_PATH" ];
 166     then
 167         if [ -n "$LD_PRELOAD" ];
 168         then
 169                 export LD_PRELOAD="$LD_PRELOAD:$LIBMALLOCWRAP_PATH"
 170         else
 171                 export LD_PRELOAD="$LIBMALLOCWRAP_PATH"
 172         fi
 173     fi
 174
 175     if [ "$arg_preload_fork" = "1" ] && [ -n "$LIBINTERFORK_PATH" ];
 176     then
 177         if [ -n "$LD_PRELOAD" ];
 178         then
 179                 export LD_PRELOAD="$LD_PRELOAD:$LIBINTERFORK_PATH"
 180         else
 181                 export LD_PRELOAD="$LIBINTERFORK_PATH"
 182         fi
 183     fi
 184
 185 # Execute the command
 186     $CMD 2>&1
 187 ) | tee "$OUTDIR/app.log"
 188
 189 ## Because of the keepalive mechanism, we're sure that by the time
 190 ## we get here, the daemon is connected to all the buffers that still exist.
 191 ## Therefore we can politely ask it to die when it's done.
 192
 193 if [ "$arg_syswide_daemon" != "1" ];
 194 then
 195         # Tell the daemon to die
 196         kill -SIGTERM "$USTDPID"
 197
 198         echo "Waiting for ustd to shutdown..."
 199         wait "$USTDPID"
 200
 201         rm "$pidfilepath"
 202 fi
 203
 204 echo "Trace was output in: " $OUTDIR