Mirrorlandia_minetest/minetest
1
0
Fork 1
mirror of https://github.com/minetest/minetest.git synced 2024-11-30 03:23:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Amend profiling documentation

Browse Source
This commit is contained in:
sfan5 2024-04-24 14:50:05 +02:00
parent be540043ee
commit 12ccbe6f12
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/developing/misc.md
View File

@ -4,7 +4,7 @@
We will be using a tool called "perf", which you can get by installing `perf` or `linux-perf` or `linux-tools-common`. We will be using a tool called "perf", which you can get by installing `perf` or `linux-perf` or `linux-tools-common`.
For best results build Minetest and Irrlicht with debug symbols To get usable results you need to build Minetest with debug symbols
(`-DCMAKE_BUILD_TYPE=RelWithDebInfo` or `-DCMAKE_BUILD_TYPE=Debug`). (`-DCMAKE_BUILD_TYPE=RelWithDebInfo` or `-DCMAKE_BUILD_TYPE=Debug`).
Run the client (or server) like this and do whatever you wanted to test: Run the client (or server) like this and do whatever you wanted to test:
@ -17,3 +17,22 @@ This will leave a file called "perf.data".
You can open this file with perf built-in tools but much more interesting You can open this file with perf built-in tools but much more interesting
is the visualization using a GUI tool: **[Hotspot](https://github.com/KDAB/hotspot)**. is the visualization using a GUI tool: **[Hotspot](https://github.com/KDAB/hotspot)**.
It will give you flamegraphs, per-thread, per-function views and much more. It will give you flamegraphs, per-thread, per-function views and much more.
### Remote Profiling
Attach perf to your running server, press *^C* to stop:
```bash
perf record -z --call-graph dwarf -F 400 -p "$(pidof minetestserver)"
```
Collect a copy of the required libraries/executables:
```bash
perf buildid-list | grep -Eo '/[^ ]+(minetestserver|\.so)[^ ]*$' | \
tar -cvahf debug.tgz --files-from=- --ignore-failed-read
```
Give both files to the developer and also provide:
* Linux distribution and version
* commit the source was built from and/or modified source code (if applicable)
Hotspot will resolve symbols correctly when pointing the sysroot option at the collected libs.