summaryrefslogtreecommitdiffstats
path: root/mutrace.in
blob: e88f07d6acac7099124182e2ec98dec05d369aa1 (plain)
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
205
206
207
208
209
210
211
212
213
#!/bin/bash

# This file is part of mutrace.
#
# Copyright 2009 Lennart Poettering
#
# mutrace is free software: you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# mutrace 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with mutrace. If not, see <http://www.gnu.org/licenses/>.

if ! TEMP=`getopt -o +ardh --long hash-size:,frames:,locked-min:,owner-changed-min:,contended-min:,max:,mutex-order:,cond-order:,trap,help,all,debug-info -n mutrace -- "$@"` ; then
    exit 1
fi

eval set -- "$TEMP"

debug_info=0

while : ; do
        case $1 in
                --hash-size)
                        export MUTRACE_HASH_SIZE="$2"
                        shift 2
                        ;;

                --frames)
                        export MUTRACE_FRAMES="$2"
                        shift 2
                        ;;

                --locked-min)
                        export MUTRACE_LOCKED_MIN="$2"
                        shift 2
                        ;;

                --owner-changed-min)
                        export MUTRACE_OWNER_CHANGED_MIN="$2"
                        shift 2
                        ;;

                --contended-min)
                        export MUTRACE_CONTENDED_MIN="$2"
                        shift 2
                        ;;

                --max)
                        export MUTRACE_MAX="$2"
                        shift 2
                        ;;

                --mutex-order)
                        export MUTRACE_SUMMARY_MUTEX_ORDER="$2"
                        shift 2
                        ;;

                --cond-order)
                        export MUTRACE_SUMMARY_COND_ORDER="$2"
                        shift 2
                        ;;

                --trap)
                        export MUTRACE_TRAP=1
                        shift 1
                        ;;

                -r|--track-rt)
                        export MUTRACE_TRACK_RT=1
                        shift 1
                        ;;

                -d|--debug-info)
                        debug_info=1
                        shift 1
                        ;;

                -a|--all)
                        export MUTRACE_LOCKED_MIN=0
                        export MUTRACE_OWNER_CHANGED_MIN=0
                        export MUTRACE_CONTENDED_MIN=0
                        export MUTRACE_MAX=0
                        shift 1
                        ;;

                -h|--help)
                        cat <<EOF
@PACKAGE_STRING@

Usage: mutrace [OPTIONS...] APPLICATION [ARGUMENTS...]

COMMANDS:
  -h, --help                      Show this help

OPTIONS:
      --hash-size=INTEGER         Set size of mutex hash table
      --frames=INTEGER            Set number of frames to show in stack traces
  -d, --debug-info                Make use of debug information in stack traces
      --max=INTEGER               Show this many mutexes at maximum
      --mutex-order=STRING        Order the summary table of mutexes by this
                                  column (see below for valid column names)
      --cond-order=STRING         Order the summary table of condition variables
                                  by this column (see below for valid column
                                  names)

      --wait-min=INTEGER          Only show condition variables that have been
                                  waited on at least this often
      --locked-min=INTEGER        Only show mutexes that have been locked at
                                  least this often
      --owner-changed-min=INTEGER Only show mutexes whose owning thread changed
                                  at least this often
      --contended-min=INTEGER     Only show mutexes which have been contended
                                  at least this often
      --all                       Show all mutexes, overrides the values of the
                                  three values above

  -r, --track-rt                  Track for each mutex if it was accessed from
                                  a realtime thread
      --trap                      Trigger a debugger trap each time a mutex
                                  inconsistency is detected (for use in
                                  conjunction with gdb)

MUTEX ORDER COLUMN NAMES:
  id                              Mutex number
  n-locked                        Total number of times mutex was locked for
                                  writing
  n-read-locked                   Total number of times mutex was locked for
                                  reading
  n-contended                     Total number of times mutex was contended for
                                  writing
  n-read-contended                Total number of times mutex was contended for
                                  reading
  n-owner-changed                 Total number of times mutex ownership changed
  nsec-locked-total               Total time mutex was locked for writing
  nsec-locked-max                 Maximum time mutex was continuously locked for
                                  writing
  nsec-locked-avg                 Average time mutex was continuously locked for
                                  writing
  nsec-read-locked-total          Total time mutex was locked for reading
  nsec-read-locked-max            Maximum time mutex was continuously locked for
                                  reading
  nsec-read-locked-avg            Average time mutex was continuously locked for
                                  reading
  nsec-contended-total            Total time mutex was contended for writing
  nsec-contended-avg              Average time mutex was continuously contended
                                  for writing
  nsec-read-contended-total       Total time mutex was contended for reading
  nsec-read-contended-avg         Average time mutex was continuously contended
                                  for reading

CONDITION VARIABLE ORDER COLUMN NAMES:
  id                              Condition variable number
  n-wait                          Total number of times condition variable was
                                  waited on (inc. timed waits)
  n-signal                        Total number of times condition variable was
                                  signalled
  n-broadcast                     Total number of times condition variable was
                                  broadcasted
  n-wait-contended                Total number of times condition variable was
                                  concurrently waited on by multiple threads
  n-signal-contended              Total number of times condition variable was
                                  signalled with no threads waiting
  nsec-wait-total                 Total time condition variable was waited on
  nsec-wait-max                   Maximum time condition variable was
                                  continuously waited on
  nsec-wait-avg                   Average time condition variable was
                                  continuously waited on
  nsec-wait-contended-total       Total time condition variable was waited on
                                  by multiple threads before being signalled
  nsec-wait-contended-max         Maximum time condition variable was waited on
                                  by multiple threads
  nsec-wait-contended-avg         Average time condition variable was waited on
                                  by multiple threads
EOF
                        exit 0
                        ;;
                --)
                        shift
                        break
                        ;;

                *)
                        echo "Parsing failed!" >&2
                        exit 1
                        ;;
        esac
done

shift $(($OPTIND-1))

if [ x"$1" = x ] ; then
        echo "Please specify an application to profile!" >&2
        exit 1
fi

if [ x"$LD_PRELOAD" = x ] ; then
        export LD_PRELOAD="libmutrace.so"
else
        export LD_PRELOAD="$LD_PRELOAD:libmutrace.so"
fi

if [ x"$debug_info" = x1 ] ; then
        export LD_PRELOAD="$LD_PRELOAD:libmutrace-backtrace-symbols.so"
fi

exec "$@"