Changes between Version 20 and Version 21 of EngineProfiling

Timestamp:

Jul 31, 2022, 6:32:34 AM (21 months ago)

Author:

Andy Alt

Comment:

Add instructions for profiling with google-perf (gperftools)... Instructions pinched (and modified) from the Geany wiki ​https://wiki.geany.org/howtos/profiling/gperftools

EngineProfiling

@@ -47 +47 @@
 
 Additional information on Profiler2 such as screenshots and explanations of the HTML interface can be found at [wiki:Profiler2 Profiler2]
+
+== Profiling with google-perf or pprof
+
+On debian-based systems the tools are packaged under the google-perftools package. For graphical output you also need graphviz installed:
+
+```sudo apt-get install google-perftools graphviz```
+
+On arch-based systems, the package is called gperftools.
+
+To start profiling, run
+
+```LD_PRELOAD=/usr/lib/libprofiler.so CPUPROFILE=/tmp/0ad.prof 0ad```
+
+LD_PRELOAD is used to preload the profiler's library, CPUPROFILE determines the location of the profiler's output, and in the above example, 0ad is the name of the binary to be executed. The path to the libprofiler library may differ distribution by distribution - I have also seen it under /usr/lib/libprofiler.so.0.
+
+Do whatever you want to profile in 0ad. When finished, close 0ad.
+
+At this point, /tmp/0ad.prof contains the CPU profile information. To view it graphically, run
+
+```google-pprof --web /usr/bin/0ad /tmp/0ad.prof```
+
+(Note the absolute path to 0ad must be used here.) T
+
+On arch-based systems, use `pprof` instead of `google-pprof`.
+
+After several minutes, your default web browser will open and display the graphical profile in the svg format.
 
 == Low-overhead timer ==