Select one of the symbols to view example projects that use it.
 
Outline
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "esp_app_trace_util.h"
#include "sdkconfig.h"
#define ESP_APPTRACE_PRINT_LOCK
esp_apptrace_log_lock()
esp_apptrace_log_unlock()
esp_apptrace_tmo_check(esp_apptrace_tmo_t *)
esp_apptrace_lock_take(esp_apptrace_lock_t *, esp_apptrace_tmo_t *)
esp_apptrace_lock_give(esp_apptrace_lock_t *)
esp_apptrace_rb_produce(esp_apptrace_rb_t *, uint32_t)
esp_apptrace_rb_consume(esp_apptrace_rb_t *, uint32_t)
esp_apptrace_rb_read_size_get(esp_apptrace_rb_t *)
esp_apptrace_rb_write_size_get(esp_apptrace_rb_t *)
Files
ESP-IDF
components
app_trace
gcov
include
port
private_include
sys_view
app_update
bootloader_support
bt
cmock
console
cxx
driver
efuse
esp_adc
esp_app_format
esp_bootloader_format
esp_coex
esp_common
esp_driver_ana_cmpr
esp_driver_cam
esp_driver_dac
esp_driver_gpio
esp_driver_gptimer
esp_driver_i2c
esp_driver_i2s
esp_driver_jpeg
esp_driver_ledc
esp_driver_mcpwm
esp_driver_parlio
esp_driver_pcnt
esp_driver_rmt
esp_driver_sdio
esp_driver_sdm
esp_driver_sdmmc
esp_driver_sdspi
esp_driver_spi
esp_driver_tsens
esp_driver_uart
esp_driver_usb_serial_jtag
esp_eth
esp_event
esp_gdbstub
esp_hid
esp_http_client
esp_http_server
esp_https_ota
esp_https_server
esp_hw_support
esp_lcd
esp_local_ctrl
esp_mm
esp_netif
esp_partition
esp_phy
esp_pm
esp_psram
esp_ringbuf
esp_rom
esp_security
esp_system
esp_timer
esp_vfs_console
esp_wifi
esp-tls
espcoredump
hal
heap
http_parser
ieee802154
log
mqtt
newlib
nvs_flash
nvs_sec_provider
openthread
perfmon
protobuf-c
protocomm
pthread
rt
sdmmc
soc
spi_flash
spiffs
tcp_transport
ulp
unity
vfs
wear_levelling
wifi_provisioning
wpa_supplicant
xtensa
examples
lwIP
FreeRTOS
cJSON
mbedTLS
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/app_trace/app_trace_util.c
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 OR MIT *//* ... */ // #include "freertos/FreeRTOS.h" #include "freertos/task.h" #include "esp_app_trace_util.h" #include "sdkconfig.h" #define ESP_APPTRACE_PRINT_LOCK 0 /////////////////////////////////////////////////////////////////////////////// ///////////////////////////////// Locks ///////////////////////////////////// /////////////////////////////////////////////////////////////////////////////// #if ESP_APPTRACE_PRINT_LOCK static esp_apptrace_lock_t s_log_lock = { .mux = portMUX_INITIALIZER_UNLOCKED }; #endif int esp_apptrace_log_lock(void) { #if ESP_APPTRACE_PRINT_LOCK esp_apptrace_tmo_t tmo; esp_apptrace_tmo_init(&tmo, ESP_APPTRACE_TMO_INFINITE); int ret = esp_apptrace_lock_take(&s_log_lock, &tmo); return ret;/* ... */ #else return 0; #endif }{ ... } void esp_apptrace_log_unlock(void) { #if ESP_APPTRACE_PRINT_LOCK esp_apptrace_lock_give(&s_log_lock); #endif }{ ... } /////////////////////////////////////////////////////////////////////////////// ///////////////////////////////// TIMEOUT ///////////////////////////////////// /////////////////////////////////////////////////////////////////////////////// esp_err_t esp_apptrace_tmo_check(esp_apptrace_tmo_t *tmo) { if (tmo->tmo != (int64_t)-1) { tmo->elapsed = esp_timer_get_time() - tmo->start; if (tmo->elapsed >= tmo->tmo) { return ESP_ERR_TIMEOUT; }{...} }{...} return ESP_OK; }{ ... } /////////////////////////////////////////////////////////////////////////////// ///////////////////////////////// LOCK //////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////// esp_err_t esp_apptrace_lock_take(esp_apptrace_lock_t *lock, esp_apptrace_tmo_t *tmo) { esp_err_t ret; while (1) { // Try enter a critical section (i.e., take the spinlock) with 0 timeout if (portTRY_ENTER_CRITICAL(&(lock->mux), 0) == pdTRUE) { return ESP_OK; }{...} // Failed to enter the critical section, so interrupts are still enabled. Check if we have timed out. ret = esp_apptrace_tmo_check(tmo); if (ret != ESP_OK) { break; // Timed out, exit now }{...} // Haven't timed out, try again }{...} return ret; }{ ... } esp_err_t esp_apptrace_lock_give(esp_apptrace_lock_t *lock) { portEXIT_CRITICAL(&(lock->mux)); return ESP_OK; }{ ... } /////////////////////////////////////////////////////////////////////////////// ////////////////////////////// RING BUFFER //////////////////////////////////// /////////////////////////////////////////////////////////////////////////////// uint8_t *esp_apptrace_rb_produce(esp_apptrace_rb_t *rb, uint32_t size) { uint8_t *ptr = rb->data + rb->wr; // check for available space if (rb->rd <= rb->wr) { // |?R......W??| if (rb->wr + size >= rb->size) { if (rb->rd == 0) { return NULL; // cannot wrap wr }{...} if (rb->wr + size == rb->size) { rb->wr = 0; }{...} else { // check if we can wrap wr earlier to get space for requested size if (size > rb->rd - 1) { return NULL; // cannot wrap wr }{...} // shrink buffer a bit, full size will be restored at rd wrapping rb->cur_size = rb->wr; rb->wr = 0; ptr = rb->data; if (rb->rd == rb->cur_size) { rb->rd = 0; if (rb->cur_size < rb->size) { rb->cur_size = rb->size; }{...} }{...} rb->wr += size; }{...} }{...} else { rb->wr += size; }{...} }{...} else { // |?W......R??| if (size > rb->rd - rb->wr - 1) { return NULL; }{...} rb->wr += size; }{...} return ptr; }{ ... } uint8_t *esp_apptrace_rb_consume(esp_apptrace_rb_t *rb, uint32_t size) { uint8_t *ptr = rb->data + rb->rd; if (rb->rd <= rb->wr) { // |?R......W??| if (rb->rd + size > rb->wr) { return NULL; }{...} rb->rd += size; }{...} else { // |?W......R??| if (rb->rd + size > rb->cur_size) { return NULL; }{...} else if (rb->rd + size == rb->cur_size) { // restore full size usage if (rb->cur_size < rb->size) { rb->cur_size = rb->size; }{...} rb->rd = 0; }{...} else { rb->rd += size; }{...} }{...} return ptr; }{ ... } uint32_t esp_apptrace_rb_read_size_get(esp_apptrace_rb_t *rb) { uint32_t size = 0; if (rb->rd <= rb->wr) { // |?R......W??| size = rb->wr - rb->rd; }{...} else { // |?W......R??| size = rb->cur_size - rb->rd; }{...} return size; }{ ... } uint32_t esp_apptrace_rb_write_size_get(esp_apptrace_rb_t *rb) { uint32_t size = 0; if (rb->rd <= rb->wr) { // |?R......W??| size = rb->size - rb->wr; if (size && rb->rd == 0) { size--; }{...} }{...} else { // |?W......R??| size = rb->rd - rb->wr - 1; }{...} return size; }{ ... }
Details