njn | e43d3ae | 2003-05-05 13:04:49 +0000 | [diff] [blame] | 1 | |
njn | e43d3ae | 2003-05-05 13:04:49 +0000 | [diff] [blame] | 2 | Building and not installing it |
| 3 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
njn | 090dc84 | 2005-03-12 16:47:07 +0000 | [diff] [blame] | 4 | To run Valgrind without having to install it, run coregrind/valgrind |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 5 | with the VALGRIND_LIB environment variable set, where <dir> is the root |
njn | 090dc84 | 2005-03-12 16:47:07 +0000 | [diff] [blame] | 6 | of the source tree (and must be an absolute path). Eg: |
| 7 | |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 8 | VALGRIND_LIB=~/grind/head4/.in_place ~/grind/head4/coregrind/valgrind |
njn | e43d3ae | 2003-05-05 13:04:49 +0000 | [diff] [blame] | 9 | |
| 10 | This allows you to compile and run with "make" instead of "make install", |
| 11 | saving you time. |
| 12 | |
njn | 7bbc8d6 | 2007-02-19 04:09:24 +0000 | [diff] [blame] | 13 | Or, you can use the 'vg-in-place' script which does that for you. |
| 14 | |
njn | e43d3ae | 2003-05-05 13:04:49 +0000 | [diff] [blame] | 15 | I recommend compiling with "make --quiet" to further reduce the amount of |
| 16 | output spewed out during compilation, letting you actually see any errors, |
| 17 | warnings, etc. |
| 18 | |
| 19 | |
florian | cb8ea55 | 2011-10-19 21:56:25 +0000 | [diff] [blame] | 20 | Building a distribution tarball |
| 21 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 22 | To build a distribution tarball from the valgrind sources: |
| 23 | |
| 24 | make dist |
| 25 | |
| 26 | In addition to compiling, linking and packaging everything up, the command |
florian | 83e6948 | 2015-03-16 12:22:35 +0000 | [diff] [blame] | 27 | will also attempt to build the documentation. |
florian | cb8ea55 | 2011-10-19 21:56:25 +0000 | [diff] [blame] | 28 | |
| 29 | If you only want to test whether the generated tarball is complete and runs |
| 30 | regression tests successfully, building documentation is not needed. |
florian | ee470b8 | 2015-03-16 22:42:13 +0000 | [diff] [blame] | 31 | |
| 32 | make dist BUILD_ALL_DOCS=no |
florian | cb8ea55 | 2011-10-19 21:56:25 +0000 | [diff] [blame] | 33 | |
florian | 83e6948 | 2015-03-16 12:22:35 +0000 | [diff] [blame] | 34 | If you insist on building documentation some embarrassing instructions |
florian | ee470b8 | 2015-03-16 22:42:13 +0000 | [diff] [blame] | 35 | can be found in docs/README. |
florian | 83e6948 | 2015-03-16 12:22:35 +0000 | [diff] [blame] | 36 | |
florian | cb8ea55 | 2011-10-19 21:56:25 +0000 | [diff] [blame] | 37 | |
njn | e43d3ae | 2003-05-05 13:04:49 +0000 | [diff] [blame] | 38 | Running the regression tests |
| 39 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 40 | To build and run all the regression tests, run "make [--quiet] regtest". |
| 41 | |
| 42 | To run a subset of the regression tests, execute: |
| 43 | |
| 44 | perl tests/vg_regtest <name> |
| 45 | |
| 46 | where <name> is a directory (all tests within will be run) or a single |
| 47 | .vgtest test file, or the name of a program which has a like-named .vgtest |
| 48 | file. Eg: |
| 49 | |
| 50 | perl tests/vg_regtest memcheck |
| 51 | perl tests/vg_regtest memcheck/tests/badfree.vgtest |
| 52 | perl tests/vg_regtest memcheck/tests/badfree |
| 53 | |
nethercote | 16b59ee | 2004-10-09 15:59:05 +0000 | [diff] [blame] | 54 | |
njn | 6f58249 | 2006-06-02 23:59:40 +0000 | [diff] [blame] | 55 | Running the performance tests |
njn | 5359b6f | 2006-06-02 23:57:22 +0000 | [diff] [blame] | 56 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
njn | 6f58249 | 2006-06-02 23:59:40 +0000 | [diff] [blame] | 57 | To build and run all the performance tests, run "make [--quiet] perf". |
njn | 5359b6f | 2006-06-02 23:57:22 +0000 | [diff] [blame] | 58 | |
njn | 6f58249 | 2006-06-02 23:59:40 +0000 | [diff] [blame] | 59 | To run a subset of the performance suite, execute: |
njn | 5359b6f | 2006-06-02 23:57:22 +0000 | [diff] [blame] | 60 | |
| 61 | perl perf/vg_perf <name> |
| 62 | |
| 63 | where <name> is a directory (all tests within will be run) or a single |
| 64 | .vgperf test file, or the name of a program which has a like-named .vgperf |
| 65 | file. Eg: |
| 66 | |
| 67 | perl perf/vg_perf perf/ |
| 68 | perl perf/vg_perf perf/bz2.vgperf |
| 69 | perl perf/vg_perf perf/bz2 |
| 70 | |
njn | 6f58249 | 2006-06-02 23:59:40 +0000 | [diff] [blame] | 71 | To compare multiple versions of Valgrind, use the --vg= option multiple |
njn | 5359b6f | 2006-06-02 23:57:22 +0000 | [diff] [blame] | 72 | times. For example, if you have two Valgrinds next to each other, one in |
njn | 6f58249 | 2006-06-02 23:59:40 +0000 | [diff] [blame] | 73 | trunk1/ and one in trunk2/, from within either trunk1/ or trunk2/ do this to |
| 74 | compare them on all the performance tests: |
njn | 5359b6f | 2006-06-02 23:57:22 +0000 | [diff] [blame] | 75 | |
| 76 | perl perf/vg_perf --vg=../trunk1 --vg=../trunk2 perf/ |
| 77 | |
| 78 | |
nethercote | 16b59ee | 2004-10-09 15:59:05 +0000 | [diff] [blame] | 79 | Debugging Valgrind with GDB |
| 80 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
tom | 4a5223b | 2005-11-17 12:31:12 +0000 | [diff] [blame] | 81 | To debug the valgrind launcher program (<prefix>/bin/valgrind) just |
| 82 | run it under gdb in the normal way. |
nethercote | 4fffabd | 2004-11-02 09:13:12 +0000 | [diff] [blame] | 83 | |
tom | 4a5223b | 2005-11-17 12:31:12 +0000 | [diff] [blame] | 84 | Debugging the main body of the valgrind code (and/or the code for |
| 85 | a particular tool) requires a bit more trickery but can be achieved |
| 86 | without too much problem by following these steps: |
nethercote | 16b59ee | 2004-10-09 15:59:05 +0000 | [diff] [blame] | 87 | |
njn | 90c8192 | 2007-09-17 22:35:57 +0000 | [diff] [blame] | 88 | (1) Set VALGRIND_LAUNCHER to point to the valgrind executable. Eg: |
nethercote | 16b59ee | 2004-10-09 15:59:05 +0000 | [diff] [blame] | 89 | |
njn | 90c8192 | 2007-09-17 22:35:57 +0000 | [diff] [blame] | 90 | export VALGRIND_LAUNCHER=/usr/local/bin/valgrind |
nethercote | 16b59ee | 2004-10-09 15:59:05 +0000 | [diff] [blame] | 91 | |
njn | 90c8192 | 2007-09-17 22:35:57 +0000 | [diff] [blame] | 92 | or for an uninstalled version in a source directory $DIR: |
nethercote | 16b59ee | 2004-10-09 15:59:05 +0000 | [diff] [blame] | 93 | |
njn | 90c8192 | 2007-09-17 22:35:57 +0000 | [diff] [blame] | 94 | export VALGRIND_LAUNCHER=$DIR/coregrind/valgrind |
| 95 | |
| 96 | (2) Run gdb on the tool executable. Eg: |
| 97 | |
| 98 | gdb /usr/local/lib/valgrind/ppc32-linux/lackey |
| 99 | |
| 100 | or |
| 101 | |
| 102 | gdb $DIR/.in_place/x86-linux/memcheck |
nethercote | 16b59ee | 2004-10-09 15:59:05 +0000 | [diff] [blame] | 103 | |
tom | 4a5223b | 2005-11-17 12:31:12 +0000 | [diff] [blame] | 104 | (3) Do "handle SIGSEGV SIGILL nostop noprint" in GDB to prevent GDB from |
| 105 | stopping on a SIGSEGV or SIGILL: |
| 106 | |
| 107 | (gdb) handle SIGILL SIGSEGV nostop noprint |
| 108 | |
| 109 | (4) Set any breakpoints you want and proceed as normal for gdb. The |
| 110 | macro VG_(FUNC) is expanded to vgPlain_FUNC, so If you want to set |
| 111 | a breakpoint VG_(do_exec), you could do like this in GDB: |
| 112 | |
| 113 | (gdb) b vgPlain_do_exec |
| 114 | |
weidendo | 4089f32 | 2012-08-06 12:27:51 +0000 | [diff] [blame] | 115 | (5) Run the tool with required options (the --tool option is required |
| 116 | for correct setup), e.g. |
tom | 4a5223b | 2005-11-17 12:31:12 +0000 | [diff] [blame] | 117 | |
weidendo | 4089f32 | 2012-08-06 12:27:51 +0000 | [diff] [blame] | 118 | (gdb) run --tool=lackey pwd |
nethercote | 16b59ee | 2004-10-09 15:59:05 +0000 | [diff] [blame] | 119 | |
njn | 90c8192 | 2007-09-17 22:35:57 +0000 | [diff] [blame] | 120 | Steps (1)--(3) can be put in a .gdbinit file, but any directory names must |
| 121 | be fully expanded (ie. not an environment variable). |
njn | 585b8b3 | 2005-10-10 11:36:55 +0000 | [diff] [blame] | 122 | |
sewardj | e089f01 | 2010-10-13 21:47:29 +0000 | [diff] [blame] | 123 | A different and possibly easier way is as follows: |
| 124 | |
| 125 | (1) Run Valgrind as normal, but add the flag --wait-for-gdb=yes. This |
| 126 | puts the tool executable into a wait loop soon after it gains |
| 127 | control. This delays startup for a few seconds. |
| 128 | |
| 129 | (2) In a different shell, do "gdb /proc/<pid>/exe <pid>", where |
| 130 | <pid> you read from the output printed by (1). This attaches |
| 131 | GDB to the tool executable, which should be in the abovementioned |
| 132 | wait loop. |
| 133 | |
| 134 | (3) Do "cont" to continue. After the loop finishes spinning, startup |
| 135 | will continue as normal. Note that comment (3) above re passing |
| 136 | signals applies here too. |
| 137 | |
njn | 4be4e2a | 2009-06-12 23:40:04 +0000 | [diff] [blame] | 138 | |
njn | 585b8b3 | 2005-10-10 11:36:55 +0000 | [diff] [blame] | 139 | Self-hosting |
| 140 | ~~~~~~~~~~~~ |
philippe | 14ab1a3 | 2012-04-08 19:52:38 +0000 | [diff] [blame] | 141 | This section explains : |
| 142 | (A) How to configure Valgrind to run under Valgrind. |
| 143 | Such a setup is called self hosting, or outer/inner setup. |
| 144 | (B) How to run Valgrind regression tests in a 'self-hosting' mode, |
| 145 | e.g. to verify Valgrind has no bugs such as memory leaks. |
| 146 | (C) How to run Valgrind performance tests in a 'self-hosting' mode, |
| 147 | to analyse and optimise the performance of Valgrind and its tools. |
| 148 | |
| 149 | (A) How to configure Valgrind to run under Valgrind: |
njn | 585b8b3 | 2005-10-10 11:36:55 +0000 | [diff] [blame] | 150 | |
njn | 801288e | 2009-08-04 07:02:54 +0000 | [diff] [blame] | 151 | (1) Check out 2 trees, "Inner" and "Outer". Inner runs the app |
| 152 | directly. Outer runs Inner. |
njn | 585b8b3 | 2005-10-10 11:36:55 +0000 | [diff] [blame] | 153 | |
philippe | 72faf10 | 2012-03-11 22:24:03 +0000 | [diff] [blame] | 154 | (2) Configure inner with --enable-inner and build/install as usual. |
njn | 585b8b3 | 2005-10-10 11:36:55 +0000 | [diff] [blame] | 155 | |
njn | 801288e | 2009-08-04 07:02:54 +0000 | [diff] [blame] | 156 | (3) Configure Outer normally and build/install as usual. |
njn | 585b8b3 | 2005-10-10 11:36:55 +0000 | [diff] [blame] | 157 | |
| 158 | (4) Choose a very simple program (date) and try |
| 159 | |
njn | 86d6807 | 2005-11-12 19:07:45 +0000 | [diff] [blame] | 160 | outer/.../bin/valgrind --sim-hints=enable-outer --trace-children=yes \ |
philippe | 14ab1a3 | 2012-04-08 19:52:38 +0000 | [diff] [blame] | 161 | --smc-check=all-non-file \ |
philippe | 277eaff | 2012-03-03 12:01:48 +0000 | [diff] [blame] | 162 | --run-libc-freeres=no --tool=cachegrind -v \ |
| 163 | inner/.../bin/valgrind --vgdb-prefix=./inner --tool=none -v prog |
njn | 585b8b3 | 2005-10-10 11:36:55 +0000 | [diff] [blame] | 164 | |
philippe | 9b705b9 | 2013-09-12 21:12:24 +0000 | [diff] [blame] | 165 | Note: You must use a "make install"-ed valgrind. |
| 166 | Do *not* use vg-in-place for the outer valgrind. |
| 167 | |
njn | 801288e | 2009-08-04 07:02:54 +0000 | [diff] [blame] | 168 | If you omit the --trace-children=yes, you'll only monitor Inner's launcher |
philippe | 277eaff | 2012-03-03 12:01:48 +0000 | [diff] [blame] | 169 | program, not its stage2. Outer needs --run-libc-freeres=no, as otherwise |
| 170 | it will try to find and run __libc_freeres in the inner, while libc is not |
| 171 | used by the inner. Inner needs --vgdb-prefix=./inner to avoid inner |
| 172 | gdbserver colliding with outer gdbserver. |
philippe | 14ab1a3 | 2012-04-08 19:52:38 +0000 | [diff] [blame] | 173 | Currently, inner does *not* use the client request |
| 174 | VALGRIND_DISCARD_TRANSLATIONS for the JITted code or the code patched for |
| 175 | translation chaining. So the outer needs --smc-check=all-non-file to |
| 176 | detect the modified code. |
philippe | 277eaff | 2012-03-03 12:01:48 +0000 | [diff] [blame] | 177 | |
| 178 | Debugging the whole thing might imply to use up to 3 GDB: |
| 179 | * a GDB attached to the Outer valgrind, allowing |
| 180 | to examine the state of Outer. |
| 181 | * a GDB using Outer gdbserver, allowing to |
| 182 | examine the state of Inner. |
| 183 | * a GDB using Inner gdbserver, allowing to |
| 184 | examine the state of prog. |
njn | 7cce5b8 | 2005-11-16 20:12:22 +0000 | [diff] [blame] | 185 | |
| 186 | The whole thing is fragile, confusing and slow, but it does work well enough |
njn | 801288e | 2009-08-04 07:02:54 +0000 | [diff] [blame] | 187 | for you to get some useful performance data. Inner has most of |
njn | 7cce5b8 | 2005-11-16 20:12:22 +0000 | [diff] [blame] | 188 | its output (ie. those lines beginning with "==<pid>==") prefixed with a '>', |
philippe | 72faf10 | 2012-03-11 22:24:03 +0000 | [diff] [blame] | 189 | which helps a lot. However, when running regression tests in an Outer/Inner |
| 190 | setup, this prefix causes the reg test diff to fail. Give |
| 191 | --sim-hints=no-inner-prefix to the Inner to disable the production |
| 192 | of the prefix in the stdout/stderr output of Inner. |
njn | 15a6563 | 2005-10-10 11:43:14 +0000 | [diff] [blame] | 193 | |
philippe | 72faf10 | 2012-03-11 22:24:03 +0000 | [diff] [blame] | 194 | The allocator (coregrind/m_mallocfree.c) is annotated with client requests |
| 195 | so Memcheck can be used to find leaks and use after free in an Inner |
| 196 | Valgrind. |
| 197 | |
| 198 | The Valgrind "big lock" is annotated with helgrind client requests |
| 199 | so helgrind and drd can be used to find race conditions in an Inner |
| 200 | Valgrind. |
| 201 | |
| 202 | All this has not been tested much, so don't be surprised if you hit problems. |
njn | 0dc09e8 | 2005-11-03 16:24:53 +0000 | [diff] [blame] | 203 | |
njn | 801288e | 2009-08-04 07:02:54 +0000 | [diff] [blame] | 204 | When using self-hosting with an outer Callgrind tool, use '--pop-on-jump' |
| 205 | (on the outer). Otherwise, Callgrind has much higher memory requirements. |
weidendo | 10e80e3 | 2006-05-01 01:49:28 +0000 | [diff] [blame] | 206 | |
philippe | 14ab1a3 | 2012-04-08 19:52:38 +0000 | [diff] [blame] | 207 | (B) Regression tests in an outer/inner setup: |
| 208 | |
philippe | 72faf10 | 2012-03-11 22:24:03 +0000 | [diff] [blame] | 209 | To run all the regression tests with an outer memcheck, do : |
philippe | 8730e0f | 2012-05-06 21:29:59 +0000 | [diff] [blame] | 210 | perl tests/vg_regtest --outer-valgrind=../outer/.../bin/valgrind \ |
| 211 | --all |
philippe | 72faf10 | 2012-03-11 22:24:03 +0000 | [diff] [blame] | 212 | |
| 213 | To run a specific regression tests with an outer memcheck, do: |
philippe | 8730e0f | 2012-05-06 21:29:59 +0000 | [diff] [blame] | 214 | perl tests/vg_regtest --outer-valgrind=../outer/.../bin/valgrind \ |
| 215 | none/tests/args.vgtest |
philippe | 72faf10 | 2012-03-11 22:24:03 +0000 | [diff] [blame] | 216 | |
| 217 | To run regression tests with another outer tool: |
| 218 | perl tests/vg_regtest --outer-valgrind=../outer/.../bin/valgrind \ |
philippe | 14ab1a3 | 2012-04-08 19:52:38 +0000 | [diff] [blame] | 219 | --outer-tool=helgrind --all |
philippe | 72faf10 | 2012-03-11 22:24:03 +0000 | [diff] [blame] | 220 | |
| 221 | --outer-args allows to give specific arguments to the outer tool, |
| 222 | replacing the default one provided by vg_regtest. |
| 223 | |
philippe | 9b705b9 | 2013-09-12 21:12:24 +0000 | [diff] [blame] | 224 | Note: --outer-valgrind must be a "make install"-ed valgrind. |
| 225 | Do *not* use vg-in-place. |
| 226 | |
philippe | 72faf10 | 2012-03-11 22:24:03 +0000 | [diff] [blame] | 227 | When an outer valgrind runs an inner valgrind, a regression test |
| 228 | produces one additional file <testname>.outer.log which contains the |
| 229 | errors detected by the outer valgrind. E.g. for an outer memcheck, it |
| 230 | contains the leaks found in the inner, for an outer helgrind or drd, |
| 231 | it contains the detected race conditions. |
| 232 | |
| 233 | The file tests/outer_inner.supp contains suppressions for |
| 234 | the irrelevant or benign errors found in the inner. |
njn | 0b5efe7 | 2005-11-10 03:40:36 +0000 | [diff] [blame] | 235 | |
philippe | 14ab1a3 | 2012-04-08 19:52:38 +0000 | [diff] [blame] | 236 | (C) Performance tests in an outer/inner setup: |
| 237 | |
| 238 | To run all the performance tests with an outer cachegrind, do : |
| 239 | perl perf/vg_perf --outer-valgrind=../outer/.../bin/valgrind perf |
| 240 | |
| 241 | To run a specific perf test (e.g. bz2) in this setup, do : |
| 242 | perl perf/vg_perf --outer-valgrind=../outer/.../bin/valgrind perf/bz2 |
| 243 | |
| 244 | To run all the performance tests with an outer callgrind, do : |
| 245 | perl perf/vg_perf --outer-valgrind=../outer/.../bin/valgrind \ |
| 246 | --outer-tool=callgrind perf |
| 247 | |
philippe | 9b705b9 | 2013-09-12 21:12:24 +0000 | [diff] [blame] | 248 | Note: --outer-valgrind must be a "make install"-ed valgrind. |
| 249 | Do *not* use vg-in-place. |
| 250 | |
philippe | 14ab1a3 | 2012-04-08 19:52:38 +0000 | [diff] [blame] | 251 | To compare the performance of multiple Valgrind versions, do : |
| 252 | perl perf/vg_perf --outer-valgrind=../outer/.../bin/valgrind \ |
philippe | 9087927 | 2015-05-10 18:17:38 +0000 | [diff] [blame] | 253 | --outer-tool=callgrind \ |
philippe | 14ab1a3 | 2012-04-08 19:52:38 +0000 | [diff] [blame] | 254 | --vg=../inner_xxxx --vg=../inner_yyyy perf |
philippe | 9b705b9 | 2013-09-12 21:12:24 +0000 | [diff] [blame] | 255 | (where inner_xxxx and inner_yyyy are the toplevel directories of |
| 256 | the versions to compare). |
philippe | 14ab1a3 | 2012-04-08 19:52:38 +0000 | [diff] [blame] | 257 | Cachegrind and cg_diff are particularly handy to obtain a delta |
| 258 | between the two versions. |
| 259 | |
| 260 | When the outer tool is callgrind or cachegrind, the following |
| 261 | output files will be created for each test: |
| 262 | <outertoolname>.out.<inner_valgrind_dir>.<tt>.<perftestname>.<pid> |
| 263 | <outertoolname>.outer.log.<inner_valgrind_dir>.<tt>.<perftestname>.<pid> |
| 264 | (where tt is the two letters abbreviation for the inner tool(s) run). |
| 265 | |
| 266 | For example, the command |
| 267 | perl perf/vg_perf \ |
| 268 | --outer-valgrind=../outer_trunk/install/bin/valgrind \ |
| 269 | --outer-tool=callgrind \ |
| 270 | --vg=../inner_tchain --vg=../inner_trunk perf/many-loss-records |
| 271 | |
| 272 | produces the files |
| 273 | callgrind.out.inner_tchain.no.many-loss-records.18465 |
| 274 | callgrind.outer.log.inner_tchain.no.many-loss-records.18465 |
| 275 | callgrind.out.inner_tchain.me.many-loss-records.21899 |
| 276 | callgrind.outer.log.inner_tchain.me.many-loss-records.21899 |
| 277 | callgrind.out.inner_trunk.no.many-loss-records.21224 |
| 278 | callgrind.outer.log.inner_trunk.no.many-loss-records.21224 |
| 279 | callgrind.out.inner_trunk.me.many-loss-records.22916 |
| 280 | callgrind.outer.log.inner_trunk.me.many-loss-records.22916 |
| 281 | |
| 282 | |
njn | 0dc09e8 | 2005-11-03 16:24:53 +0000 | [diff] [blame] | 283 | Printing out problematic blocks |
| 284 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 285 | If you want to print out a disassembly of a particular block that |
| 286 | causes a crash, do the following. |
| 287 | |
| 288 | Try running with "--vex-guest-chase-thresh=0 --trace-flags=10000000 |
| 289 | --trace-notbelow=999999". This should print one line for each block |
| 290 | translated, and that includes the address. |
| 291 | |
| 292 | Then re-run with 999999 changed to the highest bb number shown. |
| 293 | This will print the one line per block, and also will print a |
| 294 | disassembly of the block in which the fault occurred. |