Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge branch 'bugfix/log_tag_change_level' into 'master'

Browse source 
bugfix(log): fix the log tag to update existing rather than add new tag when calling ``esp_log_level_set``

See merge request !1153
This commit is contained in:
Ivan Grokhotkov 2017-08-31 10:45:55 +08:00
commit 0a5a705ca8
2 changed files with 55 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
components/log/include/esp_log.h
View file

@ -154,10 +154,15 @@ void esp_log_buffer_char(const char *tag, const void *buffer, uint16_t buff_len)
#endif #endif
#endif #endif
/// macro to output logs in startup code, before heap allocator and syscalls have been initialized. log at ``ESP_LOG_ERROR`` level. @see ``printf``,``ESP_LOGE``
#define ESP_EARLY_LOGE( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_ERROR) { ets_printf(LOG_FORMAT(E, format), esp_log_timestamp(), tag, ##__VA_ARGS__); } #define ESP_EARLY_LOGE( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_ERROR) { ets_printf(LOG_FORMAT(E, format), esp_log_timestamp(), tag, ##__VA_ARGS__); }
/// macro to output logs in startup code at ``ESP_LOG_WARN`` level. @see ``ESP_EARLY_LOGE``,``ESP_LOGE``, ``printf``
#define ESP_EARLY_LOGW( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_WARN) { ets_printf(LOG_FORMAT(W, format), esp_log_timestamp(), tag, ##__VA_ARGS__); } #define ESP_EARLY_LOGW( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_WARN) { ets_printf(LOG_FORMAT(W, format), esp_log_timestamp(), tag, ##__VA_ARGS__); }
/// macro to output logs in startup code at ``ESP_LOG_INFO`` level. @see ``ESP_EARLY_LOGE``,``ESP_LOGE``, ``printf``
#define ESP_EARLY_LOGI( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_INFO) { ets_printf(LOG_FORMAT(I, format), esp_log_timestamp(), tag, ##__VA_ARGS__); } #define ESP_EARLY_LOGI( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_INFO) { ets_printf(LOG_FORMAT(I, format), esp_log_timestamp(), tag, ##__VA_ARGS__); }
/// macro to output logs in startup code at ``ESP_LOG_DEBUG`` level. @see ``ESP_EARLY_LOGE``,``ESP_LOGE``, ``printf``
#define ESP_EARLY_LOGD( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_DEBUG) { ets_printf(LOG_FORMAT(D, format), esp_log_timestamp(), tag, ##__VA_ARGS__); } #define ESP_EARLY_LOGD( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_DEBUG) { ets_printf(LOG_FORMAT(D, format), esp_log_timestamp(), tag, ##__VA_ARGS__); }
/// macro to output logs in startup code at ``ESP_LOG_VERBOSE`` level. @see ``ESP_EARLY_LOGE``,``ESP_LOGE``, ``printf``
#define ESP_EARLY_LOGV( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_VERBOSE) { ets_printf(LOG_FORMAT(V, format), esp_log_timestamp(), tag, ##__VA_ARGS__); } #define ESP_EARLY_LOGV( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_VERBOSE) { ets_printf(LOG_FORMAT(V, format), esp_log_timestamp(), tag, ##__VA_ARGS__); }
#ifndef BOOTLOADER_BUILD #ifndef BOOTLOADER_BUILD
@ -167,10 +172,21 @@ void esp_log_buffer_char(const char *tag, const void *buffer, uint16_t buff_len)
#define ESP_LOGD( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_DEBUG) { esp_log_write(ESP_LOG_DEBUG, tag, LOG_FORMAT(D, format), esp_log_timestamp(), tag, ##__VA_ARGS__); } #define ESP_LOGD( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_DEBUG) { esp_log_write(ESP_LOG_DEBUG, tag, LOG_FORMAT(D, format), esp_log_timestamp(), tag, ##__VA_ARGS__); }
#define ESP_LOGV( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_VERBOSE) { esp_log_write(ESP_LOG_VERBOSE, tag, LOG_FORMAT(V, format), esp_log_timestamp(), tag, ##__VA_ARGS__); } #define ESP_LOGV( tag, format, ... ) if (LOG_LOCAL_LEVEL >= ESP_LOG_VERBOSE) { esp_log_write(ESP_LOG_VERBOSE, tag, LOG_FORMAT(V, format), esp_log_timestamp(), tag, ##__VA_ARGS__); }
#else #else
/**
* macro to output logs at ESP_LOG_ERROR level.
*
* @param tag tag of the log, which can be used to change the log level by ``esp_log_level_set`` at runtime.
*
* @see ``printf``
*/
#define ESP_LOGE( tag, format, ... ) ESP_EARLY_LOGE(tag, format, ##__VA_ARGS__) #define ESP_LOGE( tag, format, ... ) ESP_EARLY_LOGE(tag, format, ##__VA_ARGS__)
/// macro to output logs at ``ESP_LOG_WARN`` level. @see ``ESP_LOGE``
#define ESP_LOGW( tag, format, ... ) ESP_EARLY_LOGW(tag, format, ##__VA_ARGS__) #define ESP_LOGW( tag, format, ... ) ESP_EARLY_LOGW(tag, format, ##__VA_ARGS__)
/// macro to output logs at ``ESP_LOG_INFO`` level. @see ``ESP_LOGE``
#define ESP_LOGI( tag, format, ... ) ESP_EARLY_LOGI(tag, format, ##__VA_ARGS__) #define ESP_LOGI( tag, format, ... ) ESP_EARLY_LOGI(tag, format, ##__VA_ARGS__)
/// macro to output logs at ``ESP_LOG_DEBUG`` level. @see ``ESP_LOGE``
#define ESP_LOGD( tag, format, ... ) ESP_EARLY_LOGD(tag, format, ##__VA_ARGS__) #define ESP_LOGD( tag, format, ... ) ESP_EARLY_LOGD(tag, format, ##__VA_ARGS__)
/// macro to output logs at ``ESP_LOG_VERBOSE`` level. @see ``ESP_LOGE``
#define ESP_LOGV( tag, format, ... ) ESP_EARLY_LOGV(tag, format, ##__VA_ARGS__) #define ESP_LOGV( tag, format, ... ) ESP_EARLY_LOGV(tag, format, ##__VA_ARGS__)
#endif // BOOTLOADER_BUILD #endif // BOOTLOADER_BUILD

65
components/log/log.c
View file

@ -13,7 +13,7 @@
// limitations under the License. // limitations under the License.
/* /*
* Log library — implementation notes. * Log library implementation notes.
* *
* Log library stores all tags provided to esp_log_level_set as a linked * Log library stores all tags provided to esp_log_level_set as a linked
* list. See uncached_tag_entry_t structure. * list. See uncached_tag_entry_t structure.
@ -53,6 +53,7 @@
#include <stdio.h> #include <stdio.h>
#include <assert.h> #include <assert.h>
#include "esp_log.h" #include "esp_log.h"
#include "rom/queue.h"
//print number of bytes per line for esp_log_buffer_char and esp_log_buffer_hex //print number of bytes per line for esp_log_buffer_char and esp_log_buffer_hex
#define BYTES_PER_LINE 16 #define BYTES_PER_LINE 16
@ -76,14 +77,13 @@ typedef struct {
} cached_tag_entry_t; } cached_tag_entry_t;
typedef struct uncached_tag_entry_{ typedef struct uncached_tag_entry_{
struct uncached_tag_entry_* next; SLIST_ENTRY(uncached_tag_entry_) entries;
uint8_t level; // esp_log_level_t as uint8_t uint8_t level; // esp_log_level_t as uint8_t
char tag[0]; // beginning of a zero-terminated string char tag[0]; // beginning of a zero-terminated string
} uncached_tag_entry_t; } uncached_tag_entry_t;
static esp_log_level_t s_log_default_level = ESP_LOG_VERBOSE; static esp_log_level_t s_log_default_level = ESP_LOG_VERBOSE;
static uncached_tag_entry_t* s_log_tags_head = NULL; static SLIST_HEAD(log_tags_head , uncached_tag_entry_) s_log_tags = SLIST_HEAD_INITIALIZER(s_log_tags);
static uncached_tag_entry_t* s_log_tags_tail = NULL;
static cached_tag_entry_t s_log_cache[TAG_CACHE_SIZE]; static cached_tag_entry_t s_log_cache[TAG_CACHE_SIZE];
static uint32_t s_log_cache_max_generation = 0; static uint32_t s_log_cache_max_generation = 0;
static uint32_t s_log_cache_entry_count = 0; static uint32_t s_log_cache_entry_count = 0;
@ -122,41 +122,53 @@ void esp_log_level_set(const char* tag, esp_log_level_t level)
return; return;
} }
// allocate new linked list entry and append it to the endo of the list //searching exist tag
size_t entry_size = offsetof(uncached_tag_entry_t, tag) + strlen(tag) + 1; uncached_tag_entry_t *it = NULL;
uncached_tag_entry_t* new_entry = (uncached_tag_entry_t*) malloc(entry_size); SLIST_FOREACH( it, &s_log_tags, entries ) {
if (!new_entry) { if ( strcmp(it->tag, tag)==0 ) {
xSemaphoreGive(s_log_mutex); //one tag in the linked list match, update the level
return; it->level = level;
//quit with it != NULL
break;
}
} }
new_entry->next = NULL; //no exist tag, append new one
new_entry->level = (uint8_t) level; if ( it == NULL ) {
strcpy(new_entry->tag, tag); // allocate new linked list entry and append it to the head of the list
if (s_log_tags_tail) { size_t entry_size = offsetof(uncached_tag_entry_t, tag) + strlen(tag) + 1;
s_log_tags_tail->next = new_entry; uncached_tag_entry_t* new_entry = (uncached_tag_entry_t*) malloc(entry_size);
if (!new_entry) {
xSemaphoreGive(s_log_mutex);
return;
}
new_entry->level = (uint8_t) level;
strcpy(new_entry->tag, tag);
SLIST_INSERT_HEAD( &s_log_tags, new_entry, entries );
} }
s_log_tags_tail = new_entry;
if (!s_log_tags_head) { //search in the cache and update it if exist
s_log_tags_head = new_entry; for (int i = 0; i < s_log_cache_entry_count; ++i) {
#ifdef LOG_BUILTIN_CHECKS
assert(i == 0 || s_log_cache[(i - 1) / 2].generation < s_log_cache[i].generation);
#endif
if (s_log_cache[i].tag == tag) {
s_log_cache[i].level = level;
break;
}
} }
xSemaphoreGive(s_log_mutex); xSemaphoreGive(s_log_mutex);
} }
void clear_log_level_list() void clear_log_level_list()
{ {
for (uncached_tag_entry_t* it = s_log_tags_head; it != NULL; ) { while( !SLIST_EMPTY(&s_log_tags)) {
uncached_tag_entry_t* next = it->next; SLIST_REMOVE_HEAD(&s_log_tags, entries );
free(it);
it = next;
} }
s_log_tags_tail = NULL;
s_log_tags_head = NULL;
s_log_cache_entry_count = 0; s_log_cache_entry_count = 0;
s_log_cache_max_generation = 0; s_log_cache_max_generation = 0;
#ifdef LOG_BUILTIN_CHECKS #ifdef LOG_BUILTIN_CHECKS
s_log_cache_misses = 0; s_log_cache_misses = 0;
#endif #endif
} }
void IRAM_ATTR esp_log_write(esp_log_level_t level, void IRAM_ATTR esp_log_write(esp_log_level_t level,
@ -253,7 +265,8 @@ static inline bool get_uncached_log_level(const char* tag, esp_log_level_t* leve
{ {
// Walk the linked list of all tags and see if given tag is present in the list. // Walk the linked list of all tags and see if given tag is present in the list.
// This is slow because tags are compared as strings. // This is slow because tags are compared as strings.
for (uncached_tag_entry_t* it = s_log_tags_head; it != NULL; it = it->next) { uncached_tag_entry_t *it;
SLIST_FOREACH( it, &s_log_tags, entries ) {
if (strcmp(tag, it->tag) == 0) { if (strcmp(tag, it->tag) == 0) {
*level = it->level; *level = it->level;
return true; return true;