File: usttrace

package info (click to toggle)
ust 0.5-1%2Bsqueeze1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 2,616 kB
  • ctags: 1,506
  • sloc: ansic: 10,786; sh: 10,329; makefile: 195
file content (204 lines) | stat: -rwxr-xr-x 5,034 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
#!/bin/bash

# usttrace  by Pierre-Marc Fournier 2009
# Distributed under the GPLv2.

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"

	echo "Waiting for ustd to shutdown..."
	wait "$USTDPID"

	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 "" 2>/dev/stderr
	echo "Options:" 2>/dev/stderr
	echo "    -l    Runtime link with UST library." 2>/dev/stderr
	echo "          (Needed only if program was not linked at compile time with libust.)" 2>/dev/stderr
	echo "    -L    Add path to ust libraries to LD_LIBRARY_PATH." 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
}

while getopts ":hlLmfsWS:N:" 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;;
		h) usage;
		   exit 0;;
		\?) usage
			exit 1;;
		*) 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=$*

# Validate input
if [ -z "$HOME" ];
then
	error "no home specified"
fi

if [ -z "$CMD" ];
then
	error "no command specified"
	usage;
	exit 1
fi

# Create directory for trace output
DATESTRING="$(hostname)-$(date +%Y%m%d%H%M%S%N)"
OUTDIR="$BASE_TRACE_DIR/$DATESTRING"
mkdir -p "$OUTDIR"

# Choose ustd socket path
USTDSOCKPATH="/tmp/ustd-sock-$$"

if [ "$arg_syswide_daemon" != "1" ];
then
	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

# 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
    $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.
## Therefore we can politely ask it to die when it's done.

if [ "$arg_syswide_daemon" != "1" ];
then
	# Tell the daemon to die
	kill -SIGTERM "$USTDPID"

	echo "Waiting for ustd to shutdown..."
	wait "$USTDPID"

	rm "$pidfilepath"
fi

echo "Trace was output in: " $OUTDIR