Debugging¶

When debugging, some additional compiler flags are needed to produce debugging information. These flags can be enabled using CMake's CMAKE_BUILD_TYPE option. This option can be set similarly as the Libtropic's CMake options — see How to Configure section.

After this, you can use debugging tools of your choice, e.g. GNU Debugger or Valgrind. Refer to each tool's documentation for installation instructions.

Debugging the Tests¶

In our functional and functional mock tests we support running with both AddressSanitizer and Valgrind on Linux (USB, SPI and model HALs):

• To use AddressSanitizer: add CMake switches -DCMAKE_BUILD_TYPE=Debug and -DLT_ASAN=1.
• To use Valgrind: add CMake switches -DCMAKE_BUILD_TYPE=Debug and -DLT_VALGRIND=1.

You can also use GNU Debugger to debug the tests:

• Add CMake switch -DCMAKE_BUILD_TYPE=Debug and run the binary using gdb.
  • If you want to use the debugger with the model, you can't use the model runner. Run the model server manually instead and then run the test binary using gdb. See the model tutorial.

char *p = malloc(10);
if (!p) return 1;
p[10] = 'X'; // one-past-end heap buffer write -> ASan/Valgrind should report
free(p);

char *p = malloc(16);
if (!p) return 1;
free(p);
p[0] = 'X'; // use-after-free -> ASan/Valgrind should report