{"id":8793,"date":"2024-06-24T13:09:01","date_gmt":"2024-06-24T20:09:01","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=8793"},"modified":"2024-06-24T13:11:58","modified_gmt":"2024-06-24T20:11:58","slug":"using-software-tracing-to-record-network-packets-on-stm32","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/tutorials\/tracing\/embedded\/http\/","title":{"rendered":"Using Software Tracing to Record Network Packets on STM32"},"content":{"rendered":"

This tutorial shows how to use VisualGDB’s Software Tracing feature to analyze the real-time behavior of a simple HTTP server running on the STMF7-Discovery board. We will first trace the DHCP logic, quickly showing which functions are being called, then will modify the tracepoints to record the incoming and outgoing DHCP packets, and will finally show how to use tracing to record the URLs of all pages requested by the HTTP client.<\/p>\n

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

    \n
  1. Start Visual Studio and open the VisualGDB Embedded Project Wizard:\"\"<\/a><\/li>\n
  2. Enter the name and location of your project:\"\"<\/a><\/li>\n
  3. Select the default options (new embedded application -> Advanced CMake):\"\"<\/a><\/li>\n
  4. Select the latest ARM toolchain and pick your device:\"\"<\/a><\/li>\n
  5. On the next page pick STM32CubeMX Samples->LwIP->LwIP_HTTP_Server_Netconn_RTOS<\/strong>:
    \n    \"\"<\/a><\/li>\n
  6. Finally, configure the debugging settings and click “Finish” to create the project:\"\"<\/a><\/li>\n
  7. Press F5 to build the project and start debugging it. Once it obtains an IP address from the DHCP server, try opening it in the browser. If everything goes well, you should see the following page:\"\"<\/a><\/li>\n
  8. Now we will show how to use Software Tracing to see what functions are running on the target, and record the details of their execution. Open the Debug->Windows->Tracepoints<\/strong> window, type “dhcp” in the filter, select all functions (Ctrl+A) and press space to trace all of them:\"\"<\/a><\/li>\n
  9. In order to avoid any memory overhead, VisualGDB didn’t reserve any memory for the trace data before we set the first tracepoint, so you would need to restart the debug session to begin tracing:\"\"<\/a>You can configure this behavior (i.e. always reserve tracing memory) via VisualGDB Project Properties -> Software Tracing<\/strong>.<\/li>\n
  10. Once the debug session is started again, VisualGDB will show that dhcp_fine_tmr()<\/strong> is running all the time, while functions like dhcp_recv()<\/strong> executed a couple of times and stopped:
    \n    \"\"<\/a><\/li>\n
  11. Select the tracepoint for dhcp_recv()<\/strong> and configure it to record addr->addr<\/strong> as IP Address<\/strong> and port <\/strong>as UInt16<\/strong>:\"\" <\/a><\/li>\n
  12. Also enable recording of p->payload<\/strong> as a dynamic array of [p->len]<\/strong> elements: \"\"<\/a><\/li>\n
  13. Click Apply<\/strong> and VisualGDB will automatically patch the trace program in the FLASH memory:\"\"<\/a><\/li>\n
  14. We can also record the specific DHCP options contained in the packets. It will be redundant since we are already recording entire packets, but will allow seeing what is going on quicker. Set a tracepoint in the option byte check in dhcp_parse_reply()<\/strong> and set it to record op<\/strong>:\"\"<\/a><\/li>\n
  15. Similarly,record dhcp_option()<\/strong> to keep a track of the options in the outgoing packet:\"\"<\/a><\/li>\n
  16. Place another tracepoint in dhcp_bind()<\/strong> after it has computed the address of struct dhcp<\/strong> and record all fields of it:\"\"<\/a><\/li>\n
  17. Reconnect the network cable to force another DHCP communication and check the traced events. Select all of them and click “Export selected events”:\"\"<\/a>VisualGDB will produce a text file with records showing the incoming and outgoing DHCP communication:\n
    === udp_sendto_if_src ===\r\n    p = {...}\r\n        len = 308\r\n    payload = 0x2004808c [01 01 06 00 ... 00]\r\n    dst_ip = 0x08022910\r\n        addr = 255.255.255.255\r\n    dst_port = 67\r\n=== dhcp_recv ===\r\n    p = {...}\r\n        len = 576\r\n        payload = 0x20003862 [02 01 06 00 ... 00]\r\n    addr = {...}\r\n        addr = 192.168.0.2\r\n    port = 67\r\n=== Parse option ===\r\n    op = 53\r\n=== Parse option ===\r\n    op = 51\r\n=== Parse option ===\r\n    op = 54\r\n=== Parse option ===\r\n    op = 1\r\n=== Parse option ===\r\n    op = 3<\/pre>\n
    In this example, you see how the server (192.168.0.2) sent a packet containing the Msg Type (53)<\/strong>, Address Time (51)<\/strong>, DHCP Server ID (54)<\/strong>, Subnet Mask (1)<\/strong> and Router (3)<\/strong> options. We did not record the value of each option in this example, but it can be easily done by adding another tracepoint.<\/li>\n
  18. You can also let VisualGDB create tables with the data from relevant tracepoints. Create a new table view as shown below:\"\"<\/a><\/li>\n
  19. Drag the option values from the tracepoints recording them into one column, then add another column for the incoming\/outgoing packet length, and yet another one for DHCP state. VisualGDB will show the same information in a more compact form:\"\"<\/a><\/li>\n
  20. Click the “export tracepoint set” button on the toolbar and enter a name for the set. VisualGDB will save the tracepoints (with their configuration) and remove them from the list:\"\"<\/a>Next time you want to trace DHCP logic, you can simply import the tracepoint set via the context menu.<\/li>\n
  21. Now we will show how to record the URLs of all pages requested by the HTTP clients. Go to http_server_serve()<\/strong>, set a tracepoint on the first URL comparison and record buf<\/strong> as a null-terminated string:
    \n    \"\"<\/a><\/li>\n
  22. Refresh the page and observe how VisualGDB recorded new events. Then, create another table view:\"\"<\/a><\/li>\n
  23. Drag the [string] value from one of the events into the bottom part of the view and VisualGDB will display a table containing all requests recorded by the tracing logic:\"\"<\/a>You can record any other information together with the request as well (e.g. remote IP address, exact timestamp, etc.) to get a detailed view of what the firmware is doing without ever having to stop it.<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
    This tutorial shows how to use VisualGDB’s Software Tracing feature to analyze the real-time behavior of a simple HTTP server<\/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":[101,204,249],"_links":{"self":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8793"}],"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=8793"}],"version-history":[{"count":4,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8793\/revisions"}],"predecessor-version":[{"id":8887,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/8793\/revisions\/8887"}],"wp:attachment":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/media?parent=8793"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/categories?post=8793"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/tags?post=8793"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}