Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-22 06:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added some information regarding Valgrind to INSTALL.md.

Browse source
This commit is contained in:
Leon Styhre 2021-03-01 19:38:56 +01:00
parent 5bc19fc723
commit d73d32754d
1 changed files with 17 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
INSTALL.md
View file

@ -126,20 +126,29 @@ cmake -DCMAKE_BUILD_TYPE=Profiling .
make make
``` ```
You can then profile the code with Valgrind: As for more advanced debugging, Valgrind is a very powerful and useful tool which can analyze many aspects of the application. Be aware that some of the Valgrind tools should be run with an optimized build, and some with optimizations turned off. Refer to the Valgrind documentation for more information.
```
valgrind --tool=callgrind --log-file=../valgrind_run_01 ./emulationstation
```
The output file can be loaded into a tool such as KCachegrind for data analysis. The most common tool is Memcheck to check for memory leaks, which you run like this:
To check for memory leaks, the following command is useful:
``` ```
valgrind --tool=memcheck --leak-check=full --log-file=../valgrind_run_01 ./emulationstation valgrind --tool=memcheck --leak-check=full --log-file=../valgrind_run_01 ./emulationstation
``` ```
Note that you can also profile either a normal build or a debug build, but it's normally recommended to use the profiling build as it's compiled with optimizations while retaining the debug symbols. But if you need to alternate between Valgrind and the normal debugger the optimizations can be very annoying and therefore a normal debug build could be recommended in that instance. Another helpful tool is the Callgrind call-graph analyzer:
```
valgrind --tool=callgrind --log-file=../valgrind_run_01 ./emulationstation
```
The output file can be loaded into an application such as KCachegrind for data analysis.
Yet another very useful Valgrind tool is the Massif heap profiler, which can be run like this:
```
valgrind --tool=massif --massif-out-file=../massif.out.01 ./emulationstation
```
The output file can be loaded into an application such as Massif-Visualizer for analysis.
Another useful tool is `scan-build`, assuming you use Clang/LLVM. This is a static analyzer that runs during compilation to provide a very helpful HTML report of potential bugs (well it should be actual bugs but some false positives could be included). You need to run it for both the cmake and make steps, here's an example: Another useful tool is `scan-build`, assuming you use Clang/LLVM. This is a static analyzer that runs during compilation to provide a very helpful HTML report of potential bugs (well it should be actual bugs but some false positives could be included). You need to run it for both the cmake and make steps, here's an example: