{"id":8650,"date":"2024-01-31T09:18:16","date_gmt":"2024-01-31T17:18:16","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=8650"},"modified":"2024-01-31T09:18:16","modified_gmt":"2024-01-31T17:18:16","slug":"tracing-externally-built-projects-with-quick-debug","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/tutorials\/tracing\/embedded\/external\/","title":{"rendered":"Tracing Externally Built Projects with Quick Debug"},"content":{"rendered":"

This tutorial shows how to use Software Tracing<\/a> with the Quick Debug feature to record the execution of a project that was built outside VisualGDB on a different machine.<\/p>\n

We will first use a Linux machine to build a basic USB-controlled embedded application using the mbed framework<\/a>, and then will copy the ELF file along with the sources to the Windows machine and will use VisualGDB to create trace of all commands received by it via USB.<\/p>\n

Note that if are already using VisualGDB to build your project, you can trace it much easier via the regular debugging GUI (see this tutorial<\/a>). The steps shown in this tutorial are only needed if you want to trace an existing project without having to change its build process.<\/p>\n

Before you begin, install VisualGDB 6.0 or later.<\/p>\n

    \n
  1. Install the mbed tools on the Linux machine. For Debian-based distributions, the command below should suffice:\n
    sudo apt install gcc-arm-none-eabi python3-pip git mercurial<\/pre>\n<\/li>\n
  2. Create a separate virtual Python environment and install the mbed scripts into it:\n
    python3 -m venv ~\/mbed-python-env\r\nsource ~\/mbed-python-env\/bin\/activate\r\npip3 install mbed-cli<\/pre>\n
    \"\"<\/a><\/li>\n
  3. Once the mbed tools are ready, create a new mbed project by running mbed new <Project Name><\/strong>:\"\"<\/a><\/li>\n
  4. Once the project is created, add a file called main.cpp<\/strong> with the following contents to the project directory:\n
    #include \"mbed.h\"\r\n#include \"USBSerial.h\"\r\n\r\n#if !defined(DEVICE_USBDEVICE) || !DEVICE_USBDEVICE\r\n#error The current target does not support the USB interface\r\n#endif\r\n\r\nUSBSerial serial;\r\n\r\nint main()\r\n{\r\n    DigitalOut led(LED1);\r\n\r\n    while (true) {\r\n        char ch = serial._getc();\r\n        if (ch == '1')\r\n        \tled = true;\r\n        else if (ch == '0')\r\n        \tled = false;\r\n    }\r\n}<\/pre>\n<\/li>\n
  5. Select the target board (mbed target <Target name><\/strong>) and build the project using the ARM toolchain (mbed compile -t GCC_ARM<\/strong>):\"\"<\/a><\/li>\n
  6. Once the project finished building, take a note of the .bin<\/strong> file:\"\"<\/a>In order to debug and trace the application, you would need to point VisualGDB to the ELF file (containing both the code and debug symbols) that has the same name as the .bin<\/strong> file, and the .elf<\/strong> extension.<\/li>\n
  7. Copy the project sources and the ELF file to the Windows machine. Start Visual Studio and select Debug->Quick Debug with GDB<\/strong>:\"\"<\/a><\/li>\n
  8. Create a new embedded Quick Debug preset, point VisualGDB to the ELF file, and enable software tracing. If VisualGDB supports FLASH hotpatching<\/a> for your device, enable it so you won’t need to restart debugging after changing the tracepoints:\"\"<\/a><\/li>\n
  9. If you try debugging now, VisualGDB will report missing relocation records inside the ELF file:\"\"<\/a>This happens because in order to do software tracing, VisualGDB needs to reserve a part of the target memory for the tracing programs and data. VisualGDB can do it automatically by relocating the heap or stack (thus, requiring the relocation records in the ELF file) or you can do it manually by declaring an otherwise unused buffer variable and pointing VisualGDB to it. In this tutorial we will use the first approach and will enable relocation records on mbed side.<\/li>\n
  10. In order to produce relocation records, you need to add “-Wl,-q” to the linker command line (LDFLAGS). For mbed this can be done by copying the debug.json<\/strong> profile to the project directory and patching it. You can find the profile path by running “find . | grep debug.json<\/strong>“:\"\"<\/a><\/li>\n
  11. Patch the local copy of the profile so that ld<\/strong> flags for\u00a0GCC_ARM<\/strong> will contain “-Wl,-q<\/strong>“:\"\"<\/a>We also recommend replacing “-Og” with “-O0” for better debugging experience.<\/li>\n
  12. Build the project using the new profile:\n
    mbed compile -t GCC_ARM --profile=debug+reloc.json<\/pre>\n
    \"\"<\/a><\/li>\n
  13. Copy the new ELF file to the Windows machine and update the path in the Quick Debug window:\"\"<\/a>Now you can click Debug<\/strong> to start debugging and tracing the program.<\/li>\n
  14. The application shown in this tutorial uses the USBSerial<\/a> class to emulate a serial port via a second USB port (separate from the ST-Link USB port). Make sure that port is connected and open it in a terminal program:\"\"<\/a><\/li>\n
  15. The initial breakpoint in main()<\/strong> will trigger. However, because the program was built on a different machine, VisualGDB won’t know the location of the main.cpp<\/strong> file on the Windows machine and will ask for it. Locate it manually and create a rule to automatically map other source paths:\"\"<\/a><\/li>\n
  16. Try pressing F10 step over the DigitalOut<\/strong> initialization. If GDB ends up stepping into an interrupt handler, you can enable stepping over interrupts in the GDB Session<\/strong> window, step out of it (Shift-F12) and step over again (F10):\"\"<\/a><\/li>\n
  17. Try setting a tracepoint at the first line that checks the value of ch. <\/strong>Configure it to trace ch and the Cortex-M<\/strong> cycle counter:\"\"<\/a>Then, press F5 to continue debugging.<\/li>\n
  18. If you are debugging a device supported by the FLASH hotpatching framework, the tracepoint will get applied immediately. Otherwise, it will be stored in the Quick Debug profile and will take effect during the next debug session. Try sending some characters to the virtual COM port and observe how the LED immediately turns on or off, and the trace event count is incremented:\"\"<\/a>Tracing works directly on the target without stopping it in a debugger, so it can be used to capture events in real time, and review them later.<\/li>\n
  19. Click on the “N events<\/strong><\/span>” link or go to Debug->Windows->Tracepoints<\/strong> to review the captured events:\"\"<\/a><\/li>\n
  20. You can create table views and drag the variables from the Trace Data<\/strong> window to them to quickly see the value of a variable captured at different times. Try adding ‘ch’ and the cycle counter to separate columns to see the exact characters received via the USB port, along with precise timestamps:\"\"<\/a>Double-clicking on a row in the table will select that event, allowing you to review other captured data, or step forwards or backwards in time.<\/li>\n
  21. Try setting a breakpoint on the “led = true<\/strong>” line and stepping in it. Once inside the operator=()<\/strong> implementation, set another tracepoint capturing the value<\/strong>. The tracepoints window will now show how receiving ‘1’ or ‘0’ via USB immediately triggers the tracepoint in the operator:\"\"<\/a><\/li>\n
  22. Once the debug session is over, VisualGDB will save all recorded data into a trace file. You can open it later via File->Open<\/strong> to step through the recorded events or view the tables created via the Trace Data window:\"\"<\/a><\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
    This tutorial shows how to use Software Tracing with the Quick Debug feature to record the execution of a project<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[247],"tags":[248,204],"_links":{"self":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8650"}],"collection":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/comments?post=8650"}],"version-history":[{"count":2,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8650\/revisions"}],"predecessor-version":[{"id":8673,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8650\/revisions\/8673"}],"wp:attachment":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/media?parent=8650"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/categories?post=8650"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/tags?post=8650"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}