{"id":8464,"date":"2023-10-04T14:04:32","date_gmt":"2023-10-04T21:04:32","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=8464"},"modified":"2023-10-11T10:36:59","modified_gmt":"2023-10-11T17:36:59","slug":"using-live-tracing-to-trace-freertos-events","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/tutorials\/tracing\/embedded\/freertos\/","title":{"rendered":"Using Live Tracing to Trace FreeRTOS Events"},"content":{"rendered":"

This tutorial shows how to use the VisualGDB’s Live Tracing<\/a> feature to record the flow of a simple 2-thread program that reads bytes via UART and replies back to them with the “You typed <…><\/strong>” messages. The program will consist of 2 threads (ProcessingThread()<\/strong> and SendingThread()<\/strong>), 2 queues (s_RXQueue<\/strong> and s_TXQueue<\/strong>) and one semaphore (s_TXReadySemaphore<\/strong>) used to determine when a UART transmission has been completed and a new character is ready to be sent:\"\"<\/a>We will use Live Tracing to create a detailed recording of the program flow (exact functions called, queue sizes, sent\/received data) without having to instrument it or change any code. The tracepoints will be injected into the program dynamically, will run directly on the device with minimal overhead, and VisualGDB will use them to generate a detailed report showing what exactly happened on the device.<\/p>\n

    \n
  1. Start Visual Studio and locate the VisualGDB Embedded Project Wizard:\"\"<\/a><\/li>\n
  2. Enter the name and location for the new project: \"\"<\/a><\/li>\n
  3. Select “Create an embedded application -> Advanced CMake”. Live Tracing will also work with other project types (including unit test projects):\"\"<\/a><\/li>\n
  4. Select the latest ARM toolchain and pick your device:\"\"<\/a><\/li>\n
  5. Select the “LEDBlink (FreeRTOS)” sample: \"\"<\/a><\/li>\n
  6. On the last page of the wizard select the debug settings that work in your configuration and make sure tracing and FLASH patching are enabled:\"\"<\/a><\/li>\n
  7. Now we will add the UART functionality to the basic FreeRTOS project. The easiest way to do it would be to clone a UART sample for your board into a separate project (or use STM32CubeMX to generate it):\"\"<\/a><\/li>\n
  8. Create a separate file\u00a0 called UARTFunctions.c<\/strong> and copy the the following logic from the UART sample:
    \n\n\n\n\n\n\n
    Logic<\/td>\nDescription<\/td>\nDestination function<\/td>\n<\/tr>\n
    SystemClock_Config()<\/strong><\/td>\nConfigures system clock so that UART can run with correct frequency<\/td>\nSystemClock_Config()<\/td>\n<\/tr>\n
    Calls to HAL_GPIO_Init(USARTx_TX_GPIO_PORT, …)<\/strong><\/td>\nConfigures I\/O pins used by UART<\/td>\nUART_Init()<\/td>\n<\/tr>\n
    Call to HAL_UART_Init()<\/strong><\/td>\nConfigures UART frequency, bit count, parity, etc<\/td>\nUART_Init()<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    You can find sample UARTFunctions.c<\/a> and UARTFunctions.h<\/a> files for the Nucleo-STM32F446RE board in our GitHub repository<\/a>.<\/li>\n

  9. Call SystemClock_Config()<\/strong> and UART_Init()<\/strong> from the main() function. Then modify it to enable the UART interrupt:\n
    void USART2_IRQHandler()\r\n{\r\n    HAL_UART_IRQHandler(&UartHandle);\r\n}\r\n\r\nint main()\r\n{\r\n    \/* ... *\/\r\n    NVIC_SetPriority(USART2_IRQn, configLIBRARY_LOWEST_INTERRUPT_PRIORITY);\r\n    NVIC_EnableIRQ(USART2_IRQn);\r\n}<\/pre>\n<\/li>\n
  10. Define and create the RX\/TX queues and a semaphore described at the beginning of the tutorial:\n
    static QueueHandle_t s_RXQueue, s_TXQueue;\r\nstatic SemaphoreHandle_t s_TXReadySemaphore;\r\nstatic uint8_t s_RxCharacter, s_TxCharacter;\r\nint main()\r\n{\r\n    \/* ... *\/\r\n    s_RXQueue = xQueueCreate(128, 1);\r\n    s_TXQueue = xQueueCreate(128, 1);\r\n    s_TXReadySemaphore = xSemaphoreCreateBinary();\r\n}<\/pre>\n<\/li>\n
  11. Define the ProcessingThread()<\/strong> function that will initiate a UART receive operation, wait for the data to come from the s_RXQueue<\/strong>, format the reply and send it into s_TXQueue. Also add a HAL_UART_RxCpltCallback()<\/strong> handler that will push the received characters into s_RXQueue<\/strong>:\n
    static void ProcessingThread(void const *argument)\r\n{\r\n    HAL_UART_Receive_IT(&UartHandle, &s_RxCharacter, 1);\r\n    \r\n    for (int i = 0;;i++)\r\n    {\r\n    \tuint8_t ch;\r\n    \tstatic char reply[64];\r\n    \txQueueReceive(s_RXQueue, &ch, portMAX_DELAY);\r\n    \tsprintf(reply, \"You typed '%c'\\r\\n\", ch);\r\n    \t\r\n    \tfor (char *p = reply; *p; p++)\r\n    \t{\r\n       \t    xQueueSend(s_TXQueue, p, portMAX_DELAY);\r\n    \t}\r\n    }\r\n}\r\n\r\nvoid HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart)\r\n{\r\n    BaseType_t xHigherPriorityTaskWoken = pdFALSE;\r\n    xQueueSendFromISR(s_RXQueue, &s_RxCharacter, &xHigherPriorityTaskWoken);\r\n    HAL_UART_Receive_IT(&UartHandle, &s_RxCharacter, 1);\r\n    portYIELD_FROM_ISR(xHigherPriorityTaskWoken);\r\n}<\/pre>\n<\/li>\n
  12. Similarly, add a SendingThread()<\/strong> function that will send the contents of s_TXQueue<\/strong> to UART, along with the HAL_UART_TxCpltCallback()<\/strong> handler that will signal the semaphore:\n
    static void SendingThread(void const *argument)\r\n{\r\n    for (;;)\r\n    {\r\n        uint8_t ch;\r\n        xQueueReceive(s_TXQueue, &ch, portMAX_DELAY);\r\n        \r\n        HAL_UART_Transmit_IT(&UartHandle, &ch, 1);\r\n        xSemaphoreTake(s_TXReadySemaphore, portMAX_DELAY);\r\n    }\r\n}\r\n\r\nvoid HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart)\r\n{\r\n    BaseType_t xHigherPriorityTaskWoken;\r\n    xSemaphoreGiveFromISR(s_TXReadySemaphore, &xHigherPriorityTaskWoken);\r\n    portYIELD_FROM_ISR(xHigherPriorityTaskWoken);\r\n}<\/pre>\n<\/li>\n
  13. Finally, create and start both threads from main()<\/strong>:\n
    \u00a0   osThreadDef(Process, ProcessingThread, osPriorityNormal, 0, configMINIMAL_STACK_SIZE);\r\n    osThreadDef(Sender, SendingThread, osPriorityAboveNormal, 0, configMINIMAL_STACK_SIZE);\r\n    osThreadCreate(osThread(Process), NULL);\r\n    osThreadCreate(osThread(Sender), NULL);<\/pre>\n<\/li>\n
  14. The final version of the code should look like this<\/a>. Build it, and run it under the debugger:
    \n    \"\"<\/a><\/li>\n
  15. Connect to the virtual COM port provided by ST-Link using SmarTTY<\/a> or any other terminal client, and try typing some characters there. You will see the program reply back with the “You typed” messages:\"\"<\/a><\/li>\n
  16. Now we will use the Live Tracing GUI to record what exactly happens inside the program without interrupting it. Open the Debug->Windows->Live Tracing<\/strong> window, click “Create a function tracepoint”, enter “UART in the filter”, and press Ctrl-A, <space> to select all of them for tracing: \"\"<\/a><\/li>\n
  17. If you have not created any tracepoints before, VisualGDB will suggest restarting the debug session so that it could reserve memory for the tracepoints. Once this is done, you can add and remove tracepoints during debugging without any further restarts:\"\"<\/a><\/li>\n
  18. Type something in the terminal window and watch how the Events<\/strong> view in the Tracepoints window now shows which exact UART-related functions were called. You can navigate between the events in the Tracepoints view to have their locations highlighted in the editor: \"\"<\/a><\/li>\n
  19. Locate the HAL_UART_IRQHandler()<\/strong> tracepoint and switch the Trace Data<\/strong> view to Properties<\/strong>. Select to trace the USART2->SR<\/strong> register: \"\"<\/a><\/li>\n
  20. Go to the HAL_UART_Transmit_IT()<\/strong> tracepoint and start tracing pData<\/strong> as a dynamic array. Drag Size<\/strong> into the “number of elements<\/strong>” field:\"\"<\/a><\/li>\n
  21. Click “Apply” to modify the tracepoints. Now VisualGDB will record the UART flags each time an interrupt happens: \"\"<\/a><\/li>\n
  22. Similarly, it will record the exact sent data on each call to HAL_UART_Transmit_IT()<\/strong>: \"\"<\/a><\/li>\n
  23. Select all tracepoints in the Tracepoitns view, right-click and select “Export Selected Tracepoints to File<\/strong>“. Save the tracepoint set somewhere near the project directory: \"\"<\/a>At the end of the tutorial we will show how to record traces from saved tracepoint sets using command line, so you can easily compare what different versions of the firmware are doing, or how they react to different environments.<\/li>\n
  24. Now we will create additional tracepoints to record the queue read\/write operations. First of all, add a tracepoint in main()<\/strong> just after the queues got created. Select to trace s_TXQueue<\/strong>, s_RXQueue<\/strong> and s_TXReadySemaphore<\/strong>. If you hold Shift<\/strong> while checking the variables, VisualGDB will trace them in the shallow mode (i.e. will record the pointer value, but not the values of all fields). The (1\/13)<\/strong> hint next to the variable names will indicate that only 1 out of 13 sub-variables is being recorded:\"\"<\/a><\/li>\n
  25. Go to the xQueueReceive()<\/strong> function in FreeRTOS and set a tracepoint to the line that decrements uxMessagesWaiting<\/strong>. Configure it to trace the pointer value of xQueue<\/strong> and the uxMessagesWaiting<\/strong> field: \"\"<\/a>You can rename the newly created tracepoint via the Tracepoints window to see a meaningful name instead of just file:line.<\/li>\n
  26. Create a tracepoint in xQueueGenericSend()<\/strong> and similarly trace uxMessagesWaiting<\/strong> and the pointer value of xQueue<\/strong>:\"\"<\/a><\/li>\n
  27. VisualGDB will now record the creation of the queues, and each time a queue is being used. To quickly separate events belonging to different queues (s_RXQueue, s_TXQueue <\/strong>and even s_TXReadySemaphore<\/strong> that is implemented as a queue), go to the Trace Data window and click “Edit quick search indexes<\/strong>“: \"\"<\/a><\/li>\n
  28. Drag the s_RXQueue<\/strong> and s_TXQueue<\/strong> fields from the initial tracepoint and the xQueue<\/strong>\/pxQueue<\/strong> from other tracepoints into the same index. This will mark them as interchangeable, so VisualGDB will know they are related: \"\"<\/a><\/li>\n
  29. Go to the initial event and click the event symbol near s_TXQueue<\/strong>: \"\"<\/a><\/li>\n
  30. VisualGDB will quickly find all events having the same value of xQueue<\/strong>\/pxQueue<\/strong>: \"\"<\/a><\/li>\n
  31. In order to minimize overhead, live Tracing does not record the call stack, so you cannot quickly see who called the xQueueGenericSend()<\/strong> function to push the charater into the queue. However, you can dynamically add tracepoints in common locations of your code (e.g. ProcessingThread()<\/strong>) and trace arbitrary global variables (e.g. current thread pointer): \"\"<\/a><\/li>\n
  32. Then use the navigation buttons in the Trace Data<\/strong> window to quickly go to the previous\/next event: \"\"<\/a><\/li>\n
  33. This way you can see that last traced line before the first call to xQueueGenericSend()<\/strong> was the sprintf() call in ProcessingThread()<\/strong>:\"\"<\/a><\/li>\n
  34. At the end of each tracing session VisualGDB will produce a tracing report containing all recorded data. You can replay old reports at any time via the Profiling\/Tracing Reports window:\"\"<\/a><\/li>\n
  35. You can also create tracing reports via command line. Modify the ProcessingThread()<\/strong> function to trigger a breakpoint after 3 iterations:\"\"<\/a><\/li>\n
  36. Then build the project and run the following command line from the project directory:\n
    \"%VISUALGDB_DIR%\\VisualGDB.exe\" \/trace FreeRTOSTracingDemo.vgdbcmake \/traceconfig:TracepointSets\\UARTFunctions.xml \/tracereport:UARTFunctions.vgdbtrace \/xmltracereport:UARTFunctions.xml \/targetpath:build\\VisualGDB\\Debug\\FreeRTOSTracingDemo<\/pre>\n
    VisualGDB will create 2 reports: a UARTFunctions.vgdbtrace<\/strong> report that can be opened in Visual Studio<\/strong> and replayed, and UARTFunctions.xml<\/strong><\/a> report that can be analyzed programmatically.<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
    This tutorial shows how to use the VisualGDB’s Live Tracing feature to record the flow of a simple 2-thread program<\/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":[53,248,204,61],"_links":{"self":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8464"}],"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=8464"}],"version-history":[{"count":4,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8464\/revisions"}],"predecessor-version":[{"id":8503,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8464\/revisions\/8503"}],"wp:attachment":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/media?parent=8464"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/categories?post=8464"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/tags?post=8464"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}