# usttrace by Pierre-Marc Fournier 2009
# Distributed under the GPLv2.
-USTD="./ustd/ustd"
-LIBINTERFORK_PATH="./libinterfork/.libs/libinterfork.so"
-LIBMALLOCWRAP_PATH="./libmallocwrap/.libs/libmallocwrap.so"
+function error() {
+ echo "$0: error: $1" 2>/dev/stderr
+}
+
+function sighandler() {
+ echo "Caught Ctrl-C"
+ if [ -z "$USTDPID" ]; then
+ USTDPID="$(<$pidfilepath)"
+ fi
+ # Tell the daemon to die
+ kill -SIGTERM "$USTDPID"
-STD_LDLIBRARY_UST="./libust/.libs:../liburcu"
+ echo "Waiting for ustd to shutdown..."
+ wait "$USTDPID"
-BASE_TRACE_DIR="$HOME/.usttraces"
+ rm "$pidfilepath"
+
+ exit 0;
+}
+
+USTTRACE_DIR="$(dirname $0)"
+if [ -x "${USTTRACE_DIR}/ustd/ustd" ] ; then
+ # Use the not installed libraries instead
+ USTD="${USTTRACE_DIR}/ustd/ustd"
+ LIBINTERFORK_PATH="${USTTRACE_DIR}/libustfork/.libs/libustfork.so"
+ LIBMALLOCWRAP_PATH="${USTTRACE_DIR}/libustinstr-malloc/.libs/libustinstr-malloc.so"
+ LIBUST_PATH="${USTTRACE_DIR}/libust/.libs/libust.so"
+else
+ # Use the libraries that the dynamic link finds
+ USTD="ustd"
+ if [ ! -x "$(which ustd 2>/dev/null)" ]; then
+ error "cannot find an executable ustd; make sure its location is in the PATH"
+ exit 1
+ fi
+ LIBINTERFORK_PATH="libustfork.so"
+ LIBMALLOCWRAP_PATH="libustinstr-malloc.so"
+ LIBUST_PATH="libust.so.0"
+fi
+
+BASE_TRACE_DIR="${HOME}/.usttraces"
function usage () {
echo "usage: $0 OPTIONS COMMAND" 2>/dev/stderr
echo " -m Instrument malloc calls." 2>/dev/stderr
echo " -f Also trace forked processes." 2>/dev/stderr
echo " -s Use system-wide daemon instead of creating one for this session." 2>/dev/stderr
+ echo " -S Specify the subbuffer size." 2>/dev/stderr
+ echo " -N Specify the number of subbuffers." 2>/dev/stderr
+ echo " -o Output directory of the trace." 2>/dev/stderr
}
-function error() {
- echo "$0: error: $1" 2>/dev/stderr
-}
-
-while getopts ":hlLmfs" options; do
+while getopts ":hlLmfsWS:N:o:" options; do
case $options in
l) arg_preload_libust=1;;
L) arg_ld_std_ust=1;;
m) arg_preload_malloc=1;;
f) arg_preload_fork=1;;
s) arg_syswide_daemon=1;;
+ W) where=1;;
+ S) export UST_SUBBUF_SIZE=$OPTARG;;
+ N) export UST_SUBBUF_NUM=$OPTARG;;
+ o) OUTPUT_DIR=$OPTARG;;
h) usage;
exit 0;;
- \?) echo $usage
+ \?) usage
exit 1;;
- *) echo $usage
+ *) usage
exit 1;;
esac
done
shift $(($OPTIND - 1))
+if [ -n "$where" ]; then
+ echo $BASE_TRACE_DIR/$(ls "$BASE_TRACE_DIR" | tail -n 1)
+ exit 0
+fi
+
# Prepare vars
-CMD=$1
+CMD=$*
# Validate input
if [ -z "$HOME" ];
fi
# Create directory for trace output
-DATESTRING="$(hostname)-$(date +%Y%m%d%H%M%S)"
-OUTDIR="$BASE_TRACE_DIR/$DATESTRING"
-mkdir -p "$OUTDIR"
-
-# Choose socket path
-SOCKPATH="/tmp/ust-sock-$$"
-
-if [ "$arg_syswide_daemon" != "1" ];
-then
- # Start daemon
- $USTD -s "$SOCKPATH" -o "$OUTDIR" 2>&1 >"$OUTDIR/ustd.log" &
- USTDPID="$!"
- export UST_DAEMON_SOCKET="$SOCKPATH"
-fi
-
-# Wait for the daemon to settle
-# If we don't, the process may try to connect to its socket before
-# it's ready.
-# FIXME: is there a way to make sure this works every time?
-sleep 0.5
-
-# Establish the environment for the command
-export UST_TRACE=1
-export UST_AUTOPROBE=1
-
-if [ "$arg_preload_libust" = "1" ];
-then
- export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:./libust/.libs"
- export LD_PRELOAD="$LD_PRELOAD:./libust/.libs/libust.so"
+if [ -n "$OUTPUT_DIR" ]; then
+ OUTDIR=$OUTPUT_DIR
+else
+ DATESTRING="$(hostname)-$(date +%Y%m%d%H%M%S%N)"
+ OUTDIR="$BASE_TRACE_DIR/$DATESTRING"
fi
-if [ "$arg_ld_std_ust" = "1" ];
-then
- export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$STD_LDLIBRARY_UST"
+# Check if directory exist
+if [ ! -d "$OUTDIR" ]; then
+ mkdir -p $OUTDIR
+ if [ $? -eq 1 ]; then
+ exit 1
+ fi
fi
-if [ "$arg_preload_malloc" = "1" ];
-then
- export LD_PRELOAD="$LD_PRELOAD:./libmallocwrap/.libs/libmallocwrap.so"
-fi
+# Choose ustd socket path
+USTDSOCKPATH="/tmp/ustd-sock-$$"
-if [ "$arg_preload_fork" = "1" ];
+if [ "$arg_syswide_daemon" != "1" ];
then
- export LD_PRELOAD="$LD_PRELOAD:$LIBINTERFORK_PATH"
+ pidfilepath="/tmp/usttrace-$USER-$(date +%Y%m%d%H%M%S%N)-ustd-pid"
+ trap "sighandler $pidfilepath" SIGINT
+ mkfifo -m 0600 "$pidfilepath"
+ # Start daemon
+ $USTD --pidfile "$pidfilepath" -s "$USTDSOCKPATH" -o "$OUTDIR" >"$OUTDIR/ustd.log" 2>&1 &
+ # ustd sets up its server socket
+ # ustd opens the pidfile, blocks because no one has opened it
+ # we open pidfile
+ # we block reading pidfile
+ # ustd writes to pidfile
+ # ustd closes pidfile
+ # we unblock reading pidfile
+ USTDPID="$(<$pidfilepath)"
+ export UST_DAEMON_SOCKET="$USTDSOCKPATH"
fi
-# Install a handler for SIGIO. This is the signal that will be sent by ustd to
-# the traced program to trigger the creation of its listener thread. However,
-# it is possible that the SIGIO will be sent after the shell fork, but before
-# the exec of the command. If this handler isn't there, bash might terminate
-# because of a unhandled signal.
+# Establish the environment for the command
+(
+ export UST_TRACE=1
+ export UST_AUTOPROBE=1
+
+ if [ "$arg_preload_libust" = "1" ];
+ then
+ if [ -n "${LIBUST_PATH%libust.so}" ];
+ then
+ if [ -n "$LD_LIBRARY_PATH" ];
+ then
+ export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${LIBUST_PATH%libust.so}"
+ else
+ export LD_LIBRARY_PATH="${LIBUST_PATH%libust.so}"
+ fi
+ fi
+ if [ -n "$LIBUST_PATH" ];
+ then
+ if [ -n "$LD_PRELOAD" ];
+ then
+ export LD_PRELOAD="$LD_PRELOAD:$LIBUST_PATH"
+ else
+ export LD_PRELOAD="$LIBUST_PATH"
+ fi
+ fi
+ fi
+
+ if [ "$arg_ld_std_ust" = "1" ] && [ -n "${LIBUST_PATH%libust.so}" ];
+ then
+ if [ -n "$LD_LIBRARY_PATH" ];
+ then
+ export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${LIBUST_PATH%libust.so}"
+ else
+ export LD_LIBRARY_PATH="${LIBUST_PATH%libust.so}"
+ fi
+ fi
+
+ if [ "$arg_preload_malloc" = "1" ] && [ -n "$LIBMALLOCWRAP_PATH" ];
+ then
+ if [ -n "$LD_PRELOAD" ];
+ then
+ export LD_PRELOAD="$LD_PRELOAD:$LIBMALLOCWRAP_PATH"
+ else
+ export LD_PRELOAD="$LIBMALLOCWRAP_PATH"
+ fi
+ fi
+
+ if [ "$arg_preload_fork" = "1" ] && [ -n "$LIBINTERFORK_PATH" ];
+ then
+ if [ -n "$LD_PRELOAD" ];
+ then
+ export LD_PRELOAD="$LD_PRELOAD:$LIBINTERFORK_PATH"
+ else
+ export LD_PRELOAD="$LIBINTERFORK_PATH"
+ fi
+ fi
# Execute the command
-bash -c "$CMD" 2>&1 | tee "$OUTDIR/app.log"
+ $CMD 2>&1
+) | tee "$OUTDIR/app.log"
## Because of the keepalive mechanism, we're sure that by the time
## we get here, the daemon is connected to all the buffers that still exist.
echo "Waiting for ustd to shutdown..."
wait "$USTDPID"
+
+ rm "$pidfilepath"
fi
echo "Trace was output in: " $OUTDIR