diff options
author | Robin Gareus <robin@gareus.org> | 2014-07-08 00:22:40 +0200 |
---|---|---|
committer | Robin Gareus <robin@gareus.org> | 2014-07-08 01:11:05 +0200 |
commit | bf1de52de5e1196f566d6b5d5fc3578e56dc4420 (patch) | |
tree | 5634ab8695df06ed0ad00148783d84c4f782408f /doc | |
parent | eaa17c39512c09161dca253926ef9e35580a02c5 (diff) |
update callgrind script and add some doc.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/using_callgrind.txt | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/using_callgrind.txt b/doc/using_callgrind.txt new file mode 100644 index 0000000000..b6196b00e0 --- /dev/null +++ b/doc/using_callgrind.txt @@ -0,0 +1,49 @@ +Profiling Ardour with Callgrind +=============================== + +Prerequisites +------------- + +* valgrind version 3.7.0 or later (current 3.9.0) +* kcachegrind 0.6 or later (current: 0.7.4) + + +Basic Profiling +--------------- + +1. Compile ardour with debug symbols [1]. +2. `cd gtk2_ardour` +3. start ardour using `./arcall` + +Load a session, ideally use the 'Dummy' (non realtime) backend. + +The `arcall` script does not start profiling immediately, +to start profiling, in a second terminal run + +4. `callgrind_control -i on` + +[do operations in Ardour that should be profiled] + +5. `callgrind_control -i off` + +6. quit ardour + +7. run `kcachegrind calgringd.out.<PID>` + +NB. There will be multiple files calgringd.out.<PID>-<Thread-ID> for every run, +only load the main file without the dash into + +8. clean-up: `rm calgringd.out.*` + + +Advanced Usage +-------------- + +Edit gtk2_ardour/arcall, add/remove options as needed. +see http://valgrind.org/docs/manual/cl-manual.html for further information. + +--- + +[1] ideally an optimized built with debug-symbols (-g) is used for profiling, +however the ardour wscript does not yet offer that configuration option. +However, a default (non optimized build) does contain debug-symbols. |