feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

feat(log): Updates timestamp APIs

Browse Source
This commit is contained in:
Konstantin Kondrashov
2024-09-06 16:47:12 +03:00
committed by BOT
parent bc46512ad5
commit b994f33f51
15 changed files with 110 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
components/bootloader/Kconfig.log.format
View File

@@ -40,11 +40,11 @@ menu "Format"
config BOOTLOADER_LOG_TIMESTAMP_SOURCE_NONE config BOOTLOADER_LOG_TIMESTAMP_SOURCE_NONE
bool "None" bool "None"
depends on NO_SYMBOL # hide it now, turn it on final MR depends on BOOTLOADER_LOG_VERSION_2
config BOOTLOADER_LOG_TIMESTAMP_SOURCE_CPU_TICKS config BOOTLOADER_LOG_TIMESTAMP_SOURCE_CPU_TICKS
bool "Milliseconds Since Boot" bool "Milliseconds Since Boot"
select BOOTLOADER_LOG_TIMESTAMP_SUPPORT select BOOTLOADER_LOG_TIMESTAMP_SUPPORT if BOOTLOADER_LOG_VERSION_2
endchoice # BOOTLOADER_LOG_TIMESTAMP_SOURCE endchoice # BOOTLOADER_LOG_TIMESTAMP_SOURCE

11
components/log/Kconfig.format
View File

@@ -46,13 +46,17 @@ menu "Format"
- "System time (YY-MM-DD HH:MM:SS.sss)" it is the same as the above, - "System time (YY-MM-DD HH:MM:SS.sss)" it is the same as the above,
but also prints the date as well. but also prints the date as well.
- "Unix time in milliseconds" is the same as the two above,
but in Unix time format and in milliseconds.
e.g. (1718795571035).
- NOTE: Currently this will not get used in logging from binary blobs - NOTE: Currently this will not get used in logging from binary blobs
(i.e WiFi & Bluetooth libraries), these will always print (i.e WiFi & Bluetooth libraries), these will always print
milliseconds since boot. milliseconds since boot.
config LOG_TIMESTAMP_SOURCE_NONE config LOG_TIMESTAMP_SOURCE_NONE
bool "None" bool "None"
depends on NO_SYMBOL # hide it now, turn it on final MR depends on LOG_VERSION_2
config LOG_TIMESTAMP_SOURCE_RTOS config LOG_TIMESTAMP_SOURCE_RTOS
bool "Milliseconds Since Boot" bool "Milliseconds Since Boot"
@@ -67,6 +71,11 @@ menu "Format"
select LOG_TIMESTAMP_SUPPORT if LOG_VERSION_2 select LOG_TIMESTAMP_SUPPORT if LOG_VERSION_2
depends on LOG_VERSION_2 depends on LOG_VERSION_2
config LOG_TIMESTAMP_SOURCE_UNIX
bool "Unix time in milliseconds"
select LOG_TIMESTAMP_SUPPORT if LOG_VERSION_2
depends on LOG_VERSION_2
endchoice # LOG_TIMESTAMP_SOURCE endchoice # LOG_TIMESTAMP_SOURCE
config LOG_TIMESTAMP_SUPPORT config LOG_TIMESTAMP_SUPPORT

75
components/log/host_test/log_test/main/log_test.cpp
View File

@@ -19,16 +19,25 @@
using namespace std; using namespace std;
#define EARLY_TIMESTAMP "[0-9]*"
#if CONFIG_LOG_TIMESTAMP_SOURCE_RTOS #if CONFIG_LOG_TIMESTAMP_SOURCE_RTOS
#define TIMESTAMP "[0-9]*" #define TIMESTAMP "[0-9]*"
#define TIMESTAMP_FORMAT "\\([0-9]*\\) "
#elif CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM #elif CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM
#define TIMESTAMP "[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}" #define TIMESTAMP "[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}"
#define TIMESTAMP_FORMAT "\\([0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}\\) "
#elif CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM_FULL #elif CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM_FULL
#define TIMESTAMP "[0-9]{2}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}" #define TIMESTAMP "[0-9]{2}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}"
#define TIMESTAMP_FORMAT "\\([0-9]{2}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}\\) "
#else #else
#define TIMESTAMP "" #define TIMESTAMP ""
#define TIMESTAMP_FORMAT ""
#define EARLY_TIMESTAMP ""
#define EARLY_TIMESTAMP_FORMAT ""
#endif
#ifndef EARLY_TIMESTAMP
#define EARLY_TIMESTAMP "[0-9]*"
#define EARLY_TIMESTAMP_FORMAT "\\([0-9]*\\) "
#endif #endif
static const char *TEST_TAG = "test"; static const char *TEST_TAG = "test";
@@ -150,7 +159,7 @@ PutcFixture *PutcFixture::instance = nullptr;
TEST_CASE("verbose log level") TEST_CASE("verbose log level")
{ {
PrintFixture fix(ESP_LOG_VERBOSE); PrintFixture fix(ESP_LOG_VERBOSE);
const std::regex test_print("V \\(" TIMESTAMP "\\) test: verbose", std::regex::ECMAScript); const std::regex test_print("V " TIMESTAMP_FORMAT "test: verbose", std::regex::ECMAScript);
ESP_LOGV(TEST_TAG, "verbose"); ESP_LOGV(TEST_TAG, "verbose");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -159,7 +168,7 @@ TEST_CASE("verbose log level")
TEST_CASE("debug log level") TEST_CASE("debug log level")
{ {
PrintFixture fix(ESP_LOG_DEBUG); PrintFixture fix(ESP_LOG_DEBUG);
const std::regex test_print("D \\(" TIMESTAMP "\\) test: debug", std::regex::ECMAScript); const std::regex test_print("D " TIMESTAMP_FORMAT "test: debug", std::regex::ECMAScript);
ESP_LOGD(TEST_TAG, "debug"); ESP_LOGD(TEST_TAG, "debug");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -168,7 +177,7 @@ TEST_CASE("debug log level")
TEST_CASE("info log level") TEST_CASE("info log level")
{ {
PrintFixture fix(ESP_LOG_INFO); PrintFixture fix(ESP_LOG_INFO);
const std::regex test_print("I \\(" TIMESTAMP "\\) test: info", std::regex::ECMAScript); const std::regex test_print("I " TIMESTAMP_FORMAT "test: info", std::regex::ECMAScript);
ESP_LOGI(TEST_TAG, "info"); ESP_LOGI(TEST_TAG, "info");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -177,7 +186,7 @@ TEST_CASE("info log level")
TEST_CASE("warn log level") TEST_CASE("warn log level")
{ {
PrintFixture fix(ESP_LOG_WARN); PrintFixture fix(ESP_LOG_WARN);
const std::regex test_print("W \\(" TIMESTAMP "\\) test: warn", std::regex::ECMAScript); const std::regex test_print("W " TIMESTAMP_FORMAT "test: warn", std::regex::ECMAScript);
ESP_LOGW(TEST_TAG, "warn"); ESP_LOGW(TEST_TAG, "warn");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -186,7 +195,7 @@ TEST_CASE("warn log level")
TEST_CASE("error log level") TEST_CASE("error log level")
{ {
PrintFixture fix(ESP_LOG_ERROR); PrintFixture fix(ESP_LOG_ERROR);
const std::regex test_print("E \\(" TIMESTAMP "\\) test: error", std::regex::ECMAScript); const std::regex test_print("E " TIMESTAMP_FORMAT "test: error", std::regex::ECMAScript);
ESP_LOGE(TEST_TAG, "error"); ESP_LOGE(TEST_TAG, "error");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -196,7 +205,7 @@ TEST_CASE("error log level")
TEST_CASE("changing log level") TEST_CASE("changing log level")
{ {
PrintFixture fix(ESP_LOG_INFO); PrintFixture fix(ESP_LOG_INFO);
const std::regex test_print("I \\(" TIMESTAMP "\\) test: must indeed be printed", std::regex::ECMAScript); const std::regex test_print("I " TIMESTAMP_FORMAT "test: must indeed be printed", std::regex::ECMAScript);
ESP_LOGI(TEST_TAG, "must indeed be printed"); ESP_LOGI(TEST_TAG, "must indeed be printed");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -223,7 +232,7 @@ TEST_CASE("log buffer")
0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18,
}; };
ESP_LOG_BUFFER_HEX(TEST_TAG, buffer, sizeof(buffer)); ESP_LOG_BUFFER_HEX(TEST_TAG, buffer, sizeof(buffer));
const std::regex buffer_regex("I \\(" TIMESTAMP "\\) test: 01 02 03 04 05 06 07 08 11 12 13 14 15 16 17 18", std::regex::ECMAScript); const std::regex buffer_regex("I " TIMESTAMP_FORMAT "test: 01 02 03 04 05 06 07 08 11 12 13 14 15 16 17 18", std::regex::ECMAScript);
CHECK(regex_search(fix.get_print_buffer_string(), buffer_regex)); CHECK(regex_search(fix.get_print_buffer_string(), buffer_regex));
} }
@@ -234,7 +243,7 @@ TEST_CASE("log bytes > 127")
0xff, 0x80, 0xff, 0x80,
}; };
ESP_LOG_BUFFER_HEX(TEST_TAG, buffer, sizeof(buffer)); ESP_LOG_BUFFER_HEX(TEST_TAG, buffer, sizeof(buffer));
const std::regex buffer_regex("I \\(" TIMESTAMP "\\) test: ff 80", std::regex::ECMAScript); const std::regex buffer_regex("I " TIMESTAMP_FORMAT "test: ff 80", std::regex::ECMAScript);
CHECK(regex_search(fix.get_print_buffer_string(), buffer_regex)); CHECK(regex_search(fix.get_print_buffer_string(), buffer_regex));
} }
@@ -242,11 +251,11 @@ TEST_CASE("log buffer char")
{ {
PrintFixture fix(ESP_LOG_INFO); PrintFixture fix(ESP_LOG_INFO);
const char g[] = "The way to get started is to quit talking and begin doing. - Walt Disney"; const char g[] = "The way to get started is to quit talking and begin doing. - Walt Disney";
const std::regex buffer_regex("I \\(" TIMESTAMP "\\) test: The way to get s.*\n\ const std::regex buffer_regex("I " TIMESTAMP_FORMAT "test: The way to get s.*\n\
.*I \\(" TIMESTAMP "\\) test: tarted is to qui.*\n\ .*I " TIMESTAMP_FORMAT "test: tarted is to qui.*\n\
.*I \\(" TIMESTAMP "\\) test: t talking and be.*\n\ .*I " TIMESTAMP_FORMAT "test: t talking and be.*\n\
.*I \\(" TIMESTAMP "\\) test: gin doing. - Wal.*\n\ .*I " TIMESTAMP_FORMAT "test: gin doing. - Wal.*\n\
.*I \\(" TIMESTAMP "\\) test: t Disney", std::regex::ECMAScript); .*I " TIMESTAMP_FORMAT "test: t Disney", std::regex::ECMAScript);
ESP_LOG_BUFFER_CHAR(TEST_TAG, g, sizeof(g)); ESP_LOG_BUFFER_CHAR(TEST_TAG, g, sizeof(g));
CHECK(regex_search(fix.get_print_buffer_string(), buffer_regex) == true); CHECK(regex_search(fix.get_print_buffer_string(), buffer_regex) == true);
} }
@@ -259,7 +268,7 @@ TEST_CASE("log buffer dump")
0xff, 0xfe, 0xfd, 0xfc, 0xfb, 0xfa, 0xf9, 0xf8 0xff, 0xfe, 0xfd, 0xfc, 0xfb, 0xfa, 0xf9, 0xf8
}; };
ESP_LOG_BUFFER_HEXDUMP(TEST_TAG, buffer, sizeof(buffer), ESP_LOG_INFO); ESP_LOG_BUFFER_HEXDUMP(TEST_TAG, buffer, sizeof(buffer), ESP_LOG_INFO);
const std::regex buffer_regex("I \\(" TIMESTAMP "\\) test: 0x[0-9a-f]+\\s+" const std::regex buffer_regex("I " TIMESTAMP_FORMAT "test: 0x[0-9a-f]+\\s+"
"00 00 00 00 05 06 07 08 ff fe fd fc fb fa f9 f8 " "00 00 00 00 05 06 07 08 ff fe fd fc fb fa f9 f8 "
"\\s+|[\\.]{16}|", std::regex::ECMAScript); "\\s+|[\\.]{16}|", std::regex::ECMAScript);
CHECK(regex_search(fix.get_print_buffer_string(), buffer_regex)); CHECK(regex_search(fix.get_print_buffer_string(), buffer_regex));
@@ -277,7 +286,7 @@ TEST_CASE("rom printf")
TEST_CASE("early verbose log level") TEST_CASE("early verbose log level")
{ {
PutcFixture fix; PutcFixture fix;
const std::regex test_print("V \\(" EARLY_TIMESTAMP "\\) test: verbose", std::regex::ECMAScript); const std::regex test_print("V " EARLY_TIMESTAMP_FORMAT "test: verbose", std::regex::ECMAScript);
ESP_EARLY_LOGV(TEST_TAG, "verbose"); ESP_EARLY_LOGV(TEST_TAG, "verbose");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -286,7 +295,7 @@ TEST_CASE("early verbose log level")
TEST_CASE("early debug log level") TEST_CASE("early debug log level")
{ {
PutcFixture fix; PutcFixture fix;
const std::regex test_print("D \\(" EARLY_TIMESTAMP "\\) test: debug", std::regex::ECMAScript); const std::regex test_print("D " EARLY_TIMESTAMP_FORMAT "test: debug", std::regex::ECMAScript);
ESP_EARLY_LOGD(TEST_TAG, "debug"); ESP_EARLY_LOGD(TEST_TAG, "debug");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -295,7 +304,7 @@ TEST_CASE("early debug log level")
TEST_CASE("early info log level") TEST_CASE("early info log level")
{ {
PutcFixture fix; PutcFixture fix;
const std::regex test_print("I \\(" EARLY_TIMESTAMP "\\) test: info", std::regex::ECMAScript); const std::regex test_print("I " EARLY_TIMESTAMP_FORMAT "test: info", std::regex::ECMAScript);
ESP_EARLY_LOGI(TEST_TAG, "info"); ESP_EARLY_LOGI(TEST_TAG, "info");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -304,7 +313,7 @@ TEST_CASE("early info log level")
TEST_CASE("early warn log level") TEST_CASE("early warn log level")
{ {
PutcFixture fix; PutcFixture fix;
const std::regex test_print("W \\(" EARLY_TIMESTAMP "\\) test: warn", std::regex::ECMAScript); const std::regex test_print("W " EARLY_TIMESTAMP_FORMAT "test: warn", std::regex::ECMAScript);
ESP_EARLY_LOGW(TEST_TAG, "warn"); ESP_EARLY_LOGW(TEST_TAG, "warn");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -313,7 +322,7 @@ TEST_CASE("early warn log level")
TEST_CASE("early error log level") TEST_CASE("early error log level")
{ {
PutcFixture fix; PutcFixture fix;
const std::regex test_print("E \\(" EARLY_TIMESTAMP "\\) test: error", std::regex::ECMAScript); const std::regex test_print("E " EARLY_TIMESTAMP_FORMAT "test: error", std::regex::ECMAScript);
ESP_EARLY_LOGE(TEST_TAG, "error"); ESP_EARLY_LOGE(TEST_TAG, "error");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -323,7 +332,7 @@ TEST_CASE("early error log level")
TEST_CASE("changing early log level") TEST_CASE("changing early log level")
{ {
PutcFixture fix(ESP_LOG_INFO); PutcFixture fix(ESP_LOG_INFO);
const std::regex test_print("I \\(" EARLY_TIMESTAMP "\\) test: must indeed be printed", std::regex::ECMAScript); const std::regex test_print("I " EARLY_TIMESTAMP_FORMAT "test: must indeed be printed", std::regex::ECMAScript);
ESP_EARLY_LOGI(TEST_TAG, "must indeed be printed"); ESP_EARLY_LOGI(TEST_TAG, "must indeed be printed");
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
@@ -406,6 +415,7 @@ TEST_CASE("esp_log_timestamp_str")
CHECK(regex_search(string(buffer), test_print2) == true); CHECK(regex_search(string(buffer), test_print2) == true);
} }
#if ESP_LOG_VERSION == 2
TEST_CASE("esp_log with formatting") TEST_CASE("esp_log with formatting")
{ {
PrintFixture fix(ESP_LOG_INFO); PrintFixture fix(ESP_LOG_INFO);
@@ -415,8 +425,8 @@ TEST_CASE("esp_log with formatting")
.log_level = ESP_LOG_NONE, .log_level = ESP_LOG_NONE,
.constrained_env = false, .constrained_env = false,
.require_formatting = true, .require_formatting = true,
.dis_color = false, .dis_color = ESP_LOG_COLOR_DISABLED,
.dis_timestamp = false, .dis_timestamp = ESP_LOG_TIMESTAMP_DISABLED,
.reserved = 0, .reserved = 0,
} }
}; };
@@ -433,13 +443,13 @@ TEST_CASE("esp_log with formatting")
esp_log(config, TEST_TAG, "Temp = %dC", i); esp_log(config, TEST_TAG, "Temp = %dC", i);
if (5 <= i && i < 7) { if (5 <= i && i < 7) {
const std::regex test_print("I \\(" TIMESTAMP "\\) test: Temp = [0-9]+C", std::regex::ECMAScript); const std::regex test_print("I " TIMESTAMP_FORMAT "test: Temp = [0-9]+C", std::regex::ECMAScript);
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
} else if (7 <= i && i < 9) { } else if (7 <= i && i < 9) {
const std::regex test_print("W \\(" TIMESTAMP "\\) test: Temp = [0-9]+C", std::regex::ECMAScript); const std::regex test_print("W " TIMESTAMP_FORMAT "test: Temp = [0-9]+C", std::regex::ECMAScript);
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
} else if (9 <= i) { } else if (9 <= i) {
const std::regex test_print("E \\(" TIMESTAMP "\\) test: Temp = [0-9]+C", std::regex::ECMAScript); const std::regex test_print("E " TIMESTAMP_FORMAT "test: Temp = [0-9]+C", std::regex::ECMAScript);
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
} else { } else {
const std::regex test_print("", std::regex::ECMAScript); const std::regex test_print("", std::regex::ECMAScript);
@@ -458,8 +468,8 @@ TEST_CASE("esp_log without formatting")
.log_level = ESP_LOG_NONE, .log_level = ESP_LOG_NONE,
.constrained_env = false, .constrained_env = false,
.require_formatting = false, // print just text .require_formatting = false, // print just text
.dis_color = false, .dis_color = ESP_LOG_COLOR_DISABLED,
.dis_timestamp = false, .dis_timestamp = ESP_LOG_TIMESTAMP_DISABLED,
.reserved = 0, .reserved = 0,
} }
}; };
@@ -495,15 +505,16 @@ TEST_CASE("esp_log TAG can be NULL")
.log_level = ESP_LOG_ERROR, .log_level = ESP_LOG_ERROR,
.constrained_env = false, .constrained_env = false,
.require_formatting = true, .require_formatting = true,
.dis_color = false, .dis_color = ESP_LOG_COLOR_DISABLED,
.dis_timestamp = false, .dis_timestamp = ESP_LOG_TIMESTAMP_DISABLED,
.reserved = 0, .reserved = 0,
} }
}; };
esp_log(config, NULL, "Temp = %dC", 120); esp_log(config, NULL, "Temp = %dC", 120);
const std::regex test_print("E \\(" TIMESTAMP "\\) Temp = 120C", std::regex::ECMAScript); const std::regex test_print("E " TIMESTAMP_FORMAT "Temp = 120C", std::regex::ECMAScript);
CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true); CHECK(regex_search(fix.get_print_buffer_string(), test_print) == true);
fix.reset_buffer(); fix.reset_buffer();
} }
#endif // ESP_LOG_VERSION == 2

9
components/log/host_test/log_test/pytest_log_linux.py
View File

@@ -8,7 +8,14 @@ from pytest_embedded import Dut
@pytest.mark.host_test @pytest.mark.host_test
@pytest.mark.parametrize('config', [ @pytest.mark.parametrize('config', [
'default', 'default',
'system_timestamp' 'v1_color',
'v2_color',
'v2_no_color_no_support',
'v2_no_timestamp',
'v2_no_timestamp_no_support',
'v2_rtos_timestamp',
'v2_system_full_timestamp',
'v2_system_timestamp',
'tag_level_linked_list', 'tag_level_linked_list',
'tag_level_linked_list_and_array_cache', 'tag_level_linked_list_and_array_cache',
'tag_level_none', 'tag_level_none',

2
components/log/host_test/log_test/sdkconfig.ci.v1_color Normal file
View File

@@ -0,0 +1,2 @@
CONFIG_LOG_VERSION_1=y
CONFIG_LOG_COLORS=y

2
components/log/host_test/log_test/sdkconfig.ci.v2_color Normal file
View File

@@ -0,0 +1,2 @@
CONFIG_LOG_VERSION_2=y
CONFIG_LOG_COLORS=y

3
components/log/host_test/log_test/sdkconfig.ci.v2_no_color_no_support Normal file
View File

@@ -0,0 +1,3 @@
CONFIG_LOG_VERSION_2=y
CONFIG_LOG_COLORS=n
CONFIG_LOG_COLORS_SUPPORT=n

2
components/log/host_test/log_test/sdkconfig.ci.v2_no_timestamp Normal file
View File

@@ -0,0 +1,2 @@
CONFIG_LOG_VERSION_2=y
CONFIG_LOG_TIMESTAMP_SOURCE_NONE=y

3
components/log/host_test/log_test/sdkconfig.ci.v2_no_timestamp_no_support Normal file
View File

@@ -0,0 +1,3 @@
CONFIG_LOG_VERSION_2=y
CONFIG_LOG_TIMESTAMP_SOURCE_NONE=n
CONFIG_LOG_TIMESTAMP_SUPPORT=n

2
components/log/host_test/log_test/sdkconfig.ci.v2_rtos_timestamp Normal file
View File

@@ -0,0 +1,2 @@
CONFIG_LOG_VERSION_2=y
CONFIG_LOG_TIMESTAMP_SOURCE_RTOS=y

2
components/log/host_test/log_test/sdkconfig.ci.v2_system_full_timestamp Normal file
View File

@@ -0,0 +1,2 @@
CONFIG_LOG_VERSION_2=y
CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM_FULL=y

1
components/log/host_test/log_test/sdkconfig.ci.system_timestamp → components/log/host_test/log_test/sdkconfig.ci.v2_system_timestamp
View File

@@ -1 +1,2 @@
CONFIG_LOG_VERSION_2=y
CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM=y CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM=y

11
components/log/include/esp_log_timestamp.h
View File

@@ -7,11 +7,22 @@
#pragma once #pragma once
#include <stdint.h> #include <stdint.h>
#include "esp_log_config.h"
#include "sdkconfig.h"
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
/** @cond */
// Determines whether esp_log() includes code to handle timestamp.
#if (!BOOTLOADER_BUILD && CONFIG_LOG_TIMESTAMP_SUPPORT) || (BOOTLOADER_BUILD && CONFIG_BOOTLOADER_LOG_TIMESTAMP_SUPPORT)
#define ESP_LOG_SUPPORT_TIMESTAMP (1)
#else
#define ESP_LOG_SUPPORT_TIMESTAMP (0)
#endif
/** @endcond */
/** /**
* @brief Function which returns timestamp to be used in log output * @brief Function which returns timestamp to be used in log output
* *

12
components/log/include/esp_private/log_timestamp.h
View File

@@ -18,18 +18,18 @@ extern "C" {
* *
* This function retrieves the timestamp in milliseconds for logging purposes. * This function retrieves the timestamp in milliseconds for logging purposes.
* *
* @param[in] critical Flag indicating whether the timestamp is needed for a critical log. * @param[in] constrained_env Flag indicating whether the timestamp is needed for a log from a constrained environment.
* If this flag is true, it means the function is called in one of the following states: * If this flag is true, it means the function is called in one of the following states:
* - early stage, when the Freertos scheduler is not running, * - early stage, when the Freertos scheduler is not running,
* - ISR, * - ISR,
* - CACHE is disabled. * - CACHE is disabled.
* *
* If the critical flag is set then uint32 timestamp is returned due to cpu ticks being used for this case. * If the constrained_env flag is set then uint32 timestamp is returned due to cpu ticks being used for this case.
* For some applications this uint32 timestamp may overflow after 4294967295/1000/86400 = 49 days of operation. * For some applications this uint32 timestamp may overflow after 4294967295/1000/86400 = 49 days of operation.
* *
* @return The uint64 timestamp in milliseconds. * @return The uint64 timestamp in milliseconds.
*/ */
uint64_t esp_log_timestamp64(bool critical); uint64_t esp_log_timestamp64(bool constrained_env);
/** /**
* @brief Convert the uint64 timestamp to a string representation. * @brief Convert the uint64 timestamp to a string representation.
@@ -40,8 +40,8 @@ uint64_t esp_log_timestamp64(bool critical);
* - Date and time, * - Date and time,
* - Time. * - Time.
* *
* @param[in] critical Flag indicating whether the timestamp is critical. If this flag is true, * @param[in] constrained_env Flag indicating whether the timestamp is needed for a log from a constrained environment.
* it means the function is called in one of the following states: * If this flag is true, it means the function is called in one of the following states:
* - early stage, when the Freertos scheduler is not running, * - early stage, when the Freertos scheduler is not running,
* - ISR, * - ISR,
* - CACHE is disabled. * - CACHE is disabled.
@@ -50,7 +50,7 @@ uint64_t esp_log_timestamp64(bool critical);
* *
* @return Pointer to the buffer containing the string representation of the timestamp. * @return Pointer to the buffer containing the string representation of the timestamp.
*/ */
char* esp_log_timestamp_str(bool critical, uint64_t timestamp_ms, char* buffer); char* esp_log_timestamp_str(bool constrained_env, uint64_t timestamp_ms, char* buffer);
#ifdef __cplusplus #ifdef __cplusplus
} }

25
components/log/src/log_timestamp_common.c
View File

@@ -7,6 +7,7 @@
#include <assert.h> #include <assert.h>
#include <time.h> #include <time.h>
#include <sys/time.h> #include <sys/time.h>
#include "esp_log_config.h"
#include "esp_log_timestamp.h" #include "esp_log_timestamp.h"
#include "esp_private/log_util.h" #include "esp_private/log_util.h"
#include "esp_private/log_timestamp.h" #include "esp_private/log_timestamp.h"
@@ -62,14 +63,14 @@ char *esp_log_system_timestamp(void)
} }
#endif // !NON_OS_BUILD #endif // !NON_OS_BUILD
uint64_t esp_log_timestamp64(bool critical) uint64_t esp_log_timestamp64(bool constrained_env)
{ {
uint64_t timestamp_ms; uint64_t timestamp_ms;
#if CONFIG_BOOTLOADER_LOG_TIMESTAMP_SOURCE_NONE || CONFIG_LOG_TIMESTAMP_SOURCE_NONE #if ESP_LOG_TIMESTAMP_DISABLED
(void) critical; (void) constrained_env;
timestamp_ms = 0; timestamp_ms = 0;
#elif CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM || CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM_FULL #elif !BOOTLOADER_BUILD && (CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM || CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM_FULL || CONFIG_LOG_TIMESTAMP_SOURCE_UNIX)
if (critical) { if (constrained_env) {
timestamp_ms = esp_log_early_timestamp(); timestamp_ms = esp_log_early_timestamp();
} else { } else {
#if CONFIG_IDF_TARGET_LINUX #if CONFIG_IDF_TARGET_LINUX
@@ -84,20 +85,20 @@ uint64_t esp_log_timestamp64(bool critical)
#endif #endif
} }
#else #else
(void) critical; (void) constrained_env;
timestamp_ms = esp_log_timestamp(); timestamp_ms = esp_log_timestamp();
#endif #endif
return timestamp_ms; return timestamp_ms;
} }
char* esp_log_timestamp_str(bool critical, uint64_t timestamp_ms, char* buffer) char* esp_log_timestamp_str(bool constrained_env, uint64_t timestamp_ms, char* buffer)
{ {
char* out_buffer = buffer; char* out_buffer = buffer;
#if CONFIG_BOOTLOADER_LOG_TIMESTAMP_SOURCE_NONE || CONFIG_LOG_TIMESTAMP_SOURCE_NONE #if ESP_LOG_TIMESTAMP_DISABLED
(void)critical; (void)constrained_env;
*buffer = '\0'; *buffer = '\0';
#elif CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM || CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM_FULL #elif !BOOTLOADER_BUILD && (CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM || CONFIG_LOG_TIMESTAMP_SOURCE_SYSTEM_FULL)
if (critical) { if (constrained_env) {
esp_log_util_cvt_dec(timestamp_ms, 0, buffer); esp_log_util_cvt_dec(timestamp_ms, 0, buffer);
} else { } else {
struct tm timeinfo; struct tm timeinfo;
@@ -122,7 +123,7 @@ char* esp_log_timestamp_str(bool critical, uint64_t timestamp_ms, char* buffer)
esp_log_util_cvt_dec(msec, 3, buffer); // (ms) esp_log_util_cvt_dec(msec, 3, buffer); // (ms)
} }
#else #else
(void)critical; (void)constrained_env;
esp_log_util_cvt_dec(timestamp_ms, 0, buffer); esp_log_util_cvt_dec(timestamp_ms, 0, buffer);
#endif #endif
return out_buffer; return out_buffer;