Merge branch 'apptrace_changes' into 'master'

Apptrace improvements

Closes IDF-11982

See merge request espressif/esp-idf!40407

Author: erhankur

components/app_trace/Kconfig

@@ -191,15 +191,6 @@ menu "Application Level Tracing"
         help
             Size of the memory buffer for trace data in bytes.
 
-    config APPTRACE_PENDING_DATA_SIZE_MAX
-        int "Size of the pending data buffer"
-        depends on APPTRACE_MEMBUFS_APPTRACE_PROTO_ENABLE
-        default 0
-        help
-            Size of the buffer for events in bytes. It is useful for buffering events from
-            the time critical code (scheduler, ISRs etc). If this parameter is 0 then
-            events will be discarded when main HW buffer is full.
-
     menu "FreeRTOS SystemView Tracing"
         depends on APPTRACE_ENABLE
         config APPTRACE_SV_ENABLE

components/app_trace/app_trace_membufs_proto.c

@@ -52,7 +52,6 @@ const static char *TAG = "esp_apptrace";
 
 static uint32_t esp_apptrace_membufs_down_buffer_write_nolock(esp_apptrace_membufs_proto_data_t *proto, uint8_t *data, uint32_t size);
 
-
 esp_err_t esp_apptrace_membufs_init(esp_apptrace_membufs_proto_data_t *proto, const esp_apptrace_mem_block_t blocks_cfg[2])
 {
     // disabled by default
@@ -64,10 +63,6 @@ esp_err_t esp_apptrace_membufs_init(esp_apptrace_membufs_proto_data_t *proto, co
         proto->state.markers[i] = 0;
     }
     proto->state.in_block = 0;
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-    esp_apptrace_rb_init(&proto->rb_pend, proto->pending_data,
-                        sizeof(proto->pending_data));
-#endif
     return ESP_OK;
 }
 
@@ -81,10 +76,10 @@ static esp_err_t esp_apptrace_membufs_swap(esp_apptrace_membufs_proto_data_t *pr
 {
     int prev_block_num = proto->state.in_block % 2;
     int new_block_num = prev_block_num ? (0) : (1);
-    esp_err_t res = ESP_OK;
 
-    res = proto->hw->swap_start(proto->state.in_block);
+    esp_err_t res = proto->hw->swap_start(proto->state.in_block);
     if (res != ESP_OK) {
+        ESP_APPTRACE_LOGE("Failed to swap to new block: %d", res);
         return res;
     }
 
@@ -101,40 +96,18 @@ static esp_err_t esp_apptrace_membufs_swap(esp_apptrace_membufs_proto_data_t *pr
         // TODO: add support for multiple blocks from host, currently there is no need for that
         uint8_t *p = proto->blocks[new_block_num].start + proto->blocks[new_block_num].sz;
         ESP_APPTRACE_LOGD("Recvd %" PRIu16 " bytes from host (@ %p) [%x %x %x %x %x %x %x %x .. %x %x %x %x %x %x %x %x]",
-            hdr->block_sz, proto->blocks[new_block_num].start,
-            *(proto->blocks[new_block_num].start+0), *(proto->blocks[new_block_num].start+1),
-            *(proto->blocks[new_block_num].start+2), *(proto->blocks[new_block_num].start+3),
-            *(proto->blocks[new_block_num].start+4), *(proto->blocks[new_block_num].start+5),
-            *(proto->blocks[new_block_num].start+6), *(proto->blocks[new_block_num].start+7),
-            *(p-8), *(p-7), *(p-6), *(p-5), *(p-4), *(p-3), *(p-2), *(p-1));
-        uint32_t sz = esp_apptrace_membufs_down_buffer_write_nolock(proto, (uint8_t *)(hdr+1), hdr->block_sz);
+                          hdr->block_sz, proto->blocks[new_block_num].start,
+                          *(proto->blocks[new_block_num].start + 0), *(proto->blocks[new_block_num].start + 1),
+                          *(proto->blocks[new_block_num].start + 2), *(proto->blocks[new_block_num].start + 3),
+                          *(proto->blocks[new_block_num].start + 4), *(proto->blocks[new_block_num].start + 5),
+                          *(proto->blocks[new_block_num].start + 6), *(proto->blocks[new_block_num].start + 7),
+                          *(p - 8), *(p - 7), *(p - 6), *(p - 5), *(p - 4), *(p - 3), *(p - 2), *(p - 1));
+        uint32_t sz = esp_apptrace_membufs_down_buffer_write_nolock(proto, (uint8_t *)(hdr + 1), hdr->block_sz);
         if (sz != hdr->block_sz) {
             ESP_APPTRACE_LOGE("Failed to write %" PRIu32 " bytes to down buffer (%" PRIu16 " %" PRIu32 ")!", hdr->block_sz - sz, hdr->block_sz, sz);
         }
         hdr->block_sz = 0;
     }
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-    // copy pending data to  block if any
-    while (proto->state.markers[new_block_num] < proto->blocks[new_block_num].sz) {
-        uint32_t read_sz = esp_apptrace_rb_read_size_get(&proto->rb_pend);
-        if (read_sz == 0) {
-            break; // no more data in pending buffer
-        }
-        if (read_sz > proto->blocks[new_block_num].sz - proto->state.markers[new_block_num]) {
-            read_sz = proto->blocks[new_block_num].sz - proto->state.markers[new_block_num];
-        }
-        uint8_t *ptr = esp_apptrace_rb_consume(&proto->rb_pend, read_sz);
-        if (!ptr) {
-            assert(false && "Failed to consume pended bytes!!");
-            break;
-        }
-        ESP_APPTRACE_LOGD("Pump %d pend bytes [%x %x %x %x : %x %x %x %x : %x %x %x %x : %x %x...%x %x]",
-            read_sz, *(ptr+0), *(ptr+1), *(ptr+2), *(ptr+3), *(ptr+4),
-            *(ptr+5), *(ptr+6), *(ptr+7), *(ptr+8), *(ptr+9), *(ptr+10), *(ptr+11), *(ptr+12), *(ptr+13), *(ptr+read_sz-2), *(ptr+read_sz-1));
-        memcpy(proto->blocks[new_block_num].start + proto->state.markers[new_block_num], ptr, read_sz);
-        proto->state.markers[new_block_num] += read_sz;
-    }
-#endif
     proto->hw->swap_end(proto->state.in_block, proto->state.markers[prev_block_num]);
     return res;
 }
@@ -209,7 +182,7 @@ static uint32_t esp_apptrace_membufs_down_buffer_write_nolock(esp_apptrace_membu
 
     while (total_sz < size) {
         ESP_APPTRACE_LOGD("esp_apptrace_trax_down_buffer_write_nolock WRS %" PRIu32 "-%" PRIu32 "-%" PRIu32 " %" PRIu32, proto->rb_down.wr, proto->rb_down.rd,
-            proto->rb_down.cur_size, size);
+                          proto->rb_down.cur_size, size);
         uint32_t wr_sz = esp_apptrace_rb_write_size_get(&proto->rb_down);
         if (wr_sz == 0) {
             break;
@@ -231,45 +204,6 @@ static uint32_t esp_apptrace_membufs_down_buffer_write_nolock(esp_apptrace_membu
     return total_sz;
 }
 
-static inline uint8_t *esp_apptrace_membufs_wait4buf(esp_apptrace_membufs_proto_data_t *proto, uint16_t size, esp_apptrace_tmo_t *tmo, int *pended)
-{
-    uint8_t *ptr = NULL;
-
-    int res = esp_apptrace_membufs_swap_waitus(proto, tmo);
-    if (res != ESP_OK) {
-        return NULL;
-    }
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-    // check if we still have pending data
-    if (esp_apptrace_rb_read_size_get(&proto->rb_pend) > 0) {
-        // if after block switch we still have pending data (not all pending data have been pumped to block)
-        // alloc new pending buffer
-        *pended = 1;
-        ptr = esp_apptrace_rb_produce(&proto->rb_pend, size);
-        if (!ptr) {
-            ESP_APPTRACE_LOGE("Failed to alloc pend buf 1: w-r-s %d-%d-%d!", proto->rb_pend.wr, proto->rb_pend.rd, proto->rb_pend.cur_size);
-        }
-    } else
-#endif
-    {
-        // update block pointers
-        if (ESP_APPTRACE_INBLOCK_MARKER(proto) + size > ESP_APPTRACE_INBLOCK(proto)->sz) {
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-            *pended = 1;
-            ptr = esp_apptrace_rb_produce(&proto->rb_pend, size);
-            if (ptr == NULL) {
-                ESP_APPTRACE_LOGE("Failed to alloc pend buf 2: w-r-s %d-%d-%d!", proto->rb_pend.wr, proto->rb_pend.rd, proto->rb_pend.cur_size);
-            }
-#endif
-        } else {
-            *pended = 0;
-            ptr = ESP_APPTRACE_INBLOCK(proto)->start + ESP_APPTRACE_INBLOCK_MARKER(proto);
-        }
-    }
-
-    return ptr;
-}
-
 static inline uint8_t *esp_apptrace_membufs_pkt_start(uint8_t *ptr, uint16_t size)
 {
     // it is safe to use esp_cpu_get_core_id() in macro call because arg is used only once inside it
@@ -287,63 +221,23 @@ static inline void esp_apptrace_membufs_pkt_end(uint8_t *ptr)
 
 uint8_t *esp_apptrace_membufs_up_buffer_get(esp_apptrace_membufs_proto_data_t *proto, uint32_t size, esp_apptrace_tmo_t *tmo)
 {
-    uint8_t *buf_ptr = NULL;
-
     if (size > ESP_APPTRACE_USR_DATA_LEN_MAX(proto)) {
         ESP_APPTRACE_LOGE("Too large user data size %" PRIu32 "!", size);
         return NULL;
     }
 
-    // check for data in the pending buffer
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-    if (esp_apptrace_rb_read_size_get(&proto->rb_pend) > 0) {
-        // if we have buffered data try to switch  block
-        esp_apptrace_membufs_swap(proto);
-        // if switch was successful, part or all pended data have been copied to  block
-    }
-    if (esp_apptrace_rb_read_size_get(&proto->rb_pend) > 0) {
-        // if we have buffered data alloc new pending buffer
-        ESP_APPTRACE_LOGD("Get %d bytes from PEND buffer", size);
-        buf_ptr = esp_apptrace_rb_produce(&proto->rb_pend, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
-        if (buf_ptr == NULL) {
-            int pended_buf;
-            buf_ptr = esp_apptrace_membufs_wait4buf(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size), tmo, &pended_buf);
-            if (buf_ptr && !pended_buf) {
-                ESP_APPTRACE_LOGD("Get %d bytes from block", size);
-                // update cur block marker
-                ESP_APPTRACE_INBLOCK_MARKER_UPD(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
-            }
-        }
-    } else {
-#else
-    if (1) {
-#endif
-        if (ESP_APPTRACE_INBLOCK_MARKER(proto) + ESP_APPTRACE_USR_BLOCK_RAW_SZ(size) > ESP_APPTRACE_INBLOCK(proto)->sz) {
-            #if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-            ESP_APPTRACE_LOGD("Block full. Get %" PRIu32 " bytes from PEND buffer", size);
-            buf_ptr = esp_apptrace_rb_produce(&proto->rb_pend, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
-            #endif
-            if (buf_ptr == NULL) {
-                int pended_buf;
-                ESP_APPTRACE_LOGD(" full. Get %" PRIu32 " bytes from pend buffer", size);
-                buf_ptr = esp_apptrace_membufs_wait4buf(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size), tmo, &pended_buf);
-                if (buf_ptr && !pended_buf) {
-                    ESP_APPTRACE_LOGD("Got %" PRIu32 " bytes from block", size);
-                    // update cur block marker
-                    ESP_APPTRACE_INBLOCK_MARKER_UPD(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
-                }
-            }
-        } else {
-            ESP_APPTRACE_LOGD("Get %" PRIu32 " bytes from  buffer", size);
-            // fit to curr  nlock
-            buf_ptr = ESP_APPTRACE_INBLOCK(proto)->start + ESP_APPTRACE_INBLOCK_MARKER(proto);
-            // update cur block marker
-            ESP_APPTRACE_INBLOCK_MARKER_UPD(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
+    if (ESP_APPTRACE_INBLOCK_MARKER(proto) + ESP_APPTRACE_USR_BLOCK_RAW_SZ(size) > ESP_APPTRACE_INBLOCK(proto)->sz) {
+        int res = esp_apptrace_membufs_swap_waitus(proto, tmo);
+        if (res != ESP_OK) {
+            return NULL;
         }
     }
-    if (buf_ptr) {
-        buf_ptr = esp_apptrace_membufs_pkt_start(buf_ptr, size);
-    }
+
+    uint8_t *buf_ptr = ESP_APPTRACE_INBLOCK(proto)->start + ESP_APPTRACE_INBLOCK_MARKER(proto);
+    // update cur block marker
+    ESP_APPTRACE_INBLOCK_MARKER_UPD(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
+    buf_ptr = esp_apptrace_membufs_pkt_start(buf_ptr, size);
+    ESP_APPTRACE_LOGD("Got %" PRIu32 " bytes from  block", size);
 
     return buf_ptr;
 }
@@ -367,15 +261,16 @@ esp_err_t esp_apptrace_membufs_flush_nolock(esp_apptrace_membufs_proto_data_t *p
         ESP_APPTRACE_LOGI("Ignore flush request for min %" PRIu32 " bytes. Bytes in  block: %" PRIu32, min_sz, ESP_APPTRACE_INBLOCK_MARKER(proto));
         return ESP_OK;
     }
-    // switch  block while size of data (including that in pending buffer) is more than min size
+    // switch  block while size of data is more than min size
     while (ESP_APPTRACE_INBLOCK_MARKER(proto) > min_sz) {
-        ESP_APPTRACE_LOGD("Try to flush %" PRIu32 " bytes. Wait until block switch for %" PRIi64 " us", ESP_APPTRACE_INBLOCK_MARKER(proto), tmo->tmo);
+        ESP_APPTRACE_LOGD("Try to flush %" PRIu32 " bytes", ESP_APPTRACE_INBLOCK_MARKER(proto));
         res = esp_apptrace_membufs_swap_waitus(proto, tmo);
         if (res != ESP_OK) {
-            if (tmo->tmo != ESP_APPTRACE_TMO_INFINITE)
-                ESP_APPTRACE_LOGW("Failed to switch to another block in %lld us!", tmo->tmo);
-            else
-                ESP_APPTRACE_LOGE("Failed to switch to another block in %lld us!", tmo->tmo);
+            if (res == ESP_ERR_TIMEOUT) {
+                ESP_APPTRACE_LOGW("Failed to switch to another block in %" PRIi32 " us!", (int32_t)tmo->elapsed);
+            } else {
+                ESP_APPTRACE_LOGE("Failed to switch to another block, res: %d", res);
+            }
             return res;
         }
     }

components/app_trace/app_trace_util.c

@@ -44,7 +44,7 @@ void esp_apptrace_log_unlock(void)
 
 esp_err_t esp_apptrace_tmo_check(esp_apptrace_tmo_t *tmo)
 {
-    if (tmo->tmo != (int64_t)-1) {
+    if (tmo->tmo != (int64_t) -1) {
         tmo->elapsed = esp_timer_get_time() - tmo->start;
         if (tmo->elapsed >= tmo->tmo) {
             return ESP_ERR_TIMEOUT;

components/app_trace/gcov/gcov_rtio.c

@@ -73,7 +73,7 @@ void gcov_create_task(void *arg)
 {
     ESP_EARLY_LOGV(TAG, "%s", __FUNCTION__);
     xTaskCreatePinnedToCore(&gcov_dump_task, "gcov_dump_task", CONFIG_APPTRACE_GCOV_DUMP_TASK_STACK_SIZE,
-		(void *)&s_gcov_task_running, configMAX_PRIORITIES - 1, NULL, 0);
+                            (void *)&s_gcov_task_running, configMAX_PRIORITIES - 1, NULL, 0);
 }
 
 static IRAM_ATTR
@@ -180,7 +180,7 @@ int gcov_rtio_feof(void *stream)
     return ret;
 }
 
-void gcov_rtio_setbuf(void *arg1 __attribute__ ((unused)), void *arg2 __attribute__ ((unused)))
+void gcov_rtio_setbuf(void *arg1 __attribute__((unused)), void *arg2 __attribute__((unused)))
 {
     return;
 }

components/app_trace/heap_trace_tohost.c

@@ -33,7 +33,7 @@ esp_err_t heap_trace_init_tohost(void)
 esp_err_t heap_trace_start(heap_trace_mode_t mode_param)
 {
 #if CONFIG_APPTRACE_SV_ENABLE
-    esp_err_t ret = esp_sysview_heap_trace_start((uint32_t)-1);
+    esp_err_t ret = esp_sysview_heap_trace_start((uint32_t) -1);
     if (ret != ESP_OK) {
         return ret;
     }

components/app_trace/host_file_io.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2017-2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2017-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -152,7 +152,7 @@ void *esp_apptrace_fopen(esp_apptrace_dest_t dest, const char *path, const char
     cmd_args.mode_len = strlen(mode) + 1;
 
     esp_err_t ret = esp_apptrace_file_cmd_send(dest, ESP_APPTRACE_FILE_CMD_FOPEN, esp_apptrace_fopen_args_prepare,
-                        &cmd_args, cmd_args.path_len+cmd_args.mode_len);
+                                               &cmd_args, cmd_args.path_len + cmd_args.mode_len);
     if (ret != ESP_OK) {
         ESP_EARLY_LOGE(TAG, "Failed to send file cmd (%d)!", ret);
         return NULL;
@@ -182,7 +182,7 @@ int esp_apptrace_fclose(esp_apptrace_dest_t dest, void *stream)
 
     cmd_args.file = stream;
     esp_err_t ret = esp_apptrace_file_cmd_send(dest, ESP_APPTRACE_FILE_CMD_FCLOSE, esp_apptrace_fclose_args_prepare,
-                        &cmd_args, sizeof(cmd_args));
+                                               &cmd_args, sizeof(cmd_args));
     if (ret != ESP_OK) {
         ESP_EARLY_LOGE(TAG, "Failed to send file cmd (%d)!", ret);
         return EOF;
@@ -211,7 +211,7 @@ size_t esp_apptrace_fwrite(esp_apptrace_dest_t dest, const void *ptr, size_t siz
 {
     esp_apptrace_fwrite_args_t cmd_args;
 
-    ESP_EARLY_LOGV(TAG, "esp_apptrace_fwrite f %p l %d", stream, size*nmemb);
+    ESP_EARLY_LOGV(TAG, "esp_apptrace_fwrite f %p l %d", stream, size * nmemb);
 
     if (ptr == NULL) {
         return 0;
@@ -221,7 +221,7 @@ size_t esp_apptrace_fwrite(esp_apptrace_dest_t dest, const void *ptr, size_t siz
     cmd_args.size = size * nmemb;
     cmd_args.file = stream;
     esp_err_t ret = esp_apptrace_file_cmd_send(dest, ESP_APPTRACE_FILE_CMD_FWRITE, esp_apptrace_fwrite_args_prepare,
-                        &cmd_args, sizeof(cmd_args.file)+cmd_args.size);
+                                               &cmd_args, sizeof(cmd_args.file) + cmd_args.size);
     if (ret != ESP_OK) {
         ESP_EARLY_LOGE(TAG, "Failed to send file cmd (%d)!", ret);
         return 0;
@@ -253,7 +253,7 @@ size_t esp_apptrace_fread(esp_apptrace_dest_t dest, void *ptr, size_t size, size
 {
     esp_apptrace_fread_args_t cmd_args;
 
-    ESP_EARLY_LOGV(TAG, "esp_apptrace_fread f %p l %d", stream, size*nmemb);
+    ESP_EARLY_LOGV(TAG, "esp_apptrace_fread f %p l %d", stream, size * nmemb);
 
     if (ptr == NULL) {
         return 0;
@@ -262,7 +262,7 @@ size_t esp_apptrace_fread(esp_apptrace_dest_t dest, void *ptr, size_t size, size
     cmd_args.size = size * nmemb;
     cmd_args.file = stream;
     esp_err_t ret = esp_apptrace_file_cmd_send(dest, ESP_APPTRACE_FILE_CMD_FREAD, esp_apptrace_fread_args_prepare,
-                        &cmd_args, sizeof(cmd_args));
+                                               &cmd_args, sizeof(cmd_args));
     if (ret != ESP_OK) {
         ESP_EARLY_LOGE(TAG, "Failed to send file cmd (%d)!", ret);
         return 0;
@@ -288,7 +288,7 @@ size_t esp_apptrace_fread(esp_apptrace_dest_t dest, void *ptr, size_t size, size
      *      fread(buf, 1 ,size, file);
      * So, total read bytes count returns
      */
-    return resp/size; // return the number of items read
+    return resp / size; // return the number of items read
 }
 
 static void esp_apptrace_fseek_args_prepare(uint8_t *buf, void *priv)
@@ -310,7 +310,7 @@ int esp_apptrace_fseek(esp_apptrace_dest_t dest, void *stream, long offset, int
     cmd_args.offset = offset;
     cmd_args.whence = whence;
     esp_err_t ret = esp_apptrace_file_cmd_send(dest, ESP_APPTRACE_FILE_CMD_FSEEK, esp_apptrace_fseek_args_prepare,
-                        &cmd_args, sizeof(cmd_args));
+                                               &cmd_args, sizeof(cmd_args));
     if (ret != ESP_OK) {
         ESP_EARLY_LOGE(TAG, "Failed to send file cmd (%d)!", ret);
         return -1;
@@ -340,7 +340,7 @@ int esp_apptrace_ftell(esp_apptrace_dest_t dest, void *stream)
 
     cmd_args.file = stream;
     esp_err_t ret = esp_apptrace_file_cmd_send(dest, ESP_APPTRACE_FILE_CMD_FTELL, esp_apptrace_ftell_args_prepare,
-                        &cmd_args, sizeof(cmd_args));
+                                               &cmd_args, sizeof(cmd_args));
     if (ret != ESP_OK) {
         ESP_EARLY_LOGE(TAG, "Failed to send file cmd (%d)!", ret);
         return -1;
@@ -380,7 +380,7 @@ int esp_apptrace_feof(esp_apptrace_dest_t dest, void *stream)
 
     cmd_args.file = stream;
     esp_err_t ret = esp_apptrace_file_cmd_send(dest, ESP_APPTRACE_FILE_CMD_FEOF, esp_apptrace_feof_args_prepare,
-                        &cmd_args, sizeof(cmd_args));
+                                               &cmd_args, sizeof(cmd_args));
     if (ret != ESP_OK) {
         ESP_EARLY_LOGE(TAG, "Failed to send file cmd (%d)!", ret);
         return EOF;