Debugging tools
There are several ways to debug Jami from a developer perspective, depending on what is required to be debugged.
Latowniarze
The first way is to use runtime loggers.
Starting jami
with -d
will enable logging by the daemon (or the Troubleshoot section in the General settings).
All logs are not enabled by default, as Jami uses several libraries.
However, passing environment variables enables logs:
SIPLOGLEVEL=5
enables logs from PJSIP.DHTLOGLEVEL=5
enables logs from OpenDHT.AVLOGLEVEL=50
enables logs from ffmpeg.
Odbudowy błędów
Generally, the IDE has an embedded debugger.
Otherwise, gdb
can be used, for example, to be able to add breakpoints, backtraces from crashes, print internal structures, etc.
To get debug symbols, it is required to compile the project in DEBUG mode.
Niektóre przydatne polecenia:
b file.cpp:line
- add a breakpoint (file.cpp:line can be replaced by a symbol)t a a bt
- (trzema stosować wszystkie backtrace) aby uzyskać wszystkie backtracesCtrl + X / A
- przejść w widoku graficznymp
- wydrukuj wartość wewnętrzną.
Informacja
Visual Studio Code is fully supported by Jami and can be used to debug the project.
Profilisty
Debuggers are useful, but they do not show real-time memory consumption/network activity/CPU usage. For this, an embedded profiler in the (Android Studio, Qt Creator/Visual Studio, etc.) IDE can be used.
AddressSanitizer
AddressSanitizer can be useful to detect leaks, crashes, and potential deadlocks at runtime.
To enable this, compile the daemon with CXXFLAGS+="-fsanitize=address"
.
Other flags like tsan
may be useful.
Władze włoskie
Valgrind is a tool to watch allocations, CPU usage, and more and can be used via:
valgrind --tool=callgrind ./jami -d
.
This will make the application very slow but can provide useful reports about memory allocation/performance usage (KCacheGrind can be used to read reports).
Badania
Daemon has many tests and coverage enabled.
If the daemon is built in static (else private symbols will not be available), adding new tests can help to reproduce bugs, solve bugs, and avoid any regression.
(cf. daemon/tests/unitTests
)
Agent
Testy wykorzystują tylko jednego demona do symulacji obu rówieśników. Może być więc trudne testowanie w różnych środowiskach.
LTTng
Finally, tracepoints can be created and analyzed.
daemon/tools/trace
provide the documentation and some examples.
The advantage of LTTng is that it is quicker than logs, can be triggered by system events and can be used with tracepoints already present in the kernel (so that it can be used with tracepoints from network interfaces).
Badania
Zarówno klient jak i demon posiadają testy. Testy demona są napisane w C++ i używają frameworka cppunit
. Znajdują się one w katalogu daemon/tests
.