Merge branch 'feature/logv2_2' into 'master'

feat(log): Log v2

Closes IDF-245, IDFGH-3855, IDF-2956, IDF-7883, and IDFGH-13066

See merge request espressif/esp-idf!31128

Author: Konstantin Kondrashov

components/bootloader/Kconfig.log

@@ -1,5 +1,26 @@
 menu "Log"
 
+    choice BOOTLOADER_LOG_VERSION
+        prompt "Log version"
+        help
+            Select the log version to be used by the ESP log component.
+            The app log version (CONFIG_LOG_VERSION) controls the version used in the bootloader,
+            preventing the selection of different versions.
+            For description of V1 and V2 see CONFIG_LOG_VERSION.
+
+        config BOOTLOADER_LOG_VERSION_1
+            bool "V1" if LOG_VERSION_1
+        config BOOTLOADER_LOG_VERSION_2
+            bool "V2" if LOG_VERSION_2
+    endchoice
+
+    config BOOTLOADER_LOG_VERSION
+        int
+        default 1 if BOOTLOADER_LOG_VERSION_1
+        default 2 if BOOTLOADER_LOG_VERSION_2
+        help
+            This configuration sets the log version number based on the chosen log version.
+
     choice BOOTLOADER_LOG_LEVEL
         bool "Bootloader log verbosity"
         default BOOTLOADER_LOG_LEVEL_INFO

components/bootloader/Kconfig.log.format

@@ -3,11 +3,23 @@ menu "Format"
     config BOOTLOADER_LOG_COLORS
         bool "Color"
         default n
+        select BOOTLOADER_LOG_COLORS_SUPPORT if BOOTLOADER_LOG_VERSION_2
         help
-            Use ANSI terminal colors in log output
-            Enable ANSI terminal color codes.
+            Enable ANSI terminal color codes. Logs (info, errors, warnings) will contain color codes.
             In order to view these, your terminal program must support ANSI color codes.
 
+    config BOOTLOADER_LOG_COLORS_SUPPORT
+        bool "Allow enabling color output at run time"
+        depends on BOOTLOADER_LOG_VERSION_2
+        default n
+        help
+            Enables support for color codes in the esp_log() function. If CONFIG_LOG_COLORS is enabled, this option
+            is always active. If CONFIG_LOG_COLORS is disabled, this option allows you to still handle color codes
+            in specific files by defining ESP_LOG_COLOR_DISABLED as 0 before including esp_log.h.
+
+            Note that enabling this option may slightly increase RAM/FLASH usage due to additional color handling
+            functionality. It provides flexibility to manage color output even when CONFIG_LOG_COLORS is turned off.
+
     choice BOOTLOADER_LOG_TIMESTAMP_SOURCE
         prompt "Timestamp"
         default BOOTLOADER_LOG_TIMESTAMP_SOURCE_CPU_TICKS
@@ -28,11 +40,25 @@ menu "Format"
 
         config BOOTLOADER_LOG_TIMESTAMP_SOURCE_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
             bool "Milliseconds Since Boot"
+            select BOOTLOADER_LOG_TIMESTAMP_SUPPORT if BOOTLOADER_LOG_VERSION_2
 
     endchoice # BOOTLOADER_LOG_TIMESTAMP_SOURCE
 
+    config BOOTLOADER_LOG_TIMESTAMP_SUPPORT
+        bool "Allow enabling timestamp output at run time"
+        depends on BOOTLOADER_LOG_VERSION_2
+        default y
+        help
+            Enables support for timestamp in the esp_log() function.
+            If CONFIG_LOG_TIMESTAMP_SOURCE_NONE, this option allows you to still handle timestamp
+            in specific files by defining ESP_LOG_TIMESTAMP_DISABLED as 0 before including esp_log.h.
+
+            Note that enabling this option may slightly increase RAM/FLASH usage due to additional timestamp handling
+            functionality. It provides flexibility to manage timestamp output even when
+            CONFIG_LOG_TIMESTAMP_SOURCE_NONE.
+
 endmenu

components/esp_system/startup_funcs.c

@@ -12,7 +12,9 @@
 #include "esp_err.h"
 #include "esp_check.h"
 #include "esp_system.h"
+#include "esp_private/log_util.h"
 #include "esp_log.h"
+#include "esp_private/cache_utils.h"
 #include "spi_flash_mmap.h"
 #include "esp_flash_internal.h"
 #if CONFIG_NEWLIB_ENABLED
@@ -107,6 +109,8 @@ ESP_SYSTEM_INIT_FN(init_flash, CORE, BIT(0), 130)
 #if CONFIG_SPI_FLASH_BROWNOUT_RESET
     spi_flash_needs_reset_check();
 #endif // CONFIG_SPI_FLASH_BROWNOUT_RESET
+    // The log library will call the registered callback function to check if the cache is disabled.
+    esp_log_util_set_cache_enabled_cb(spi_flash_cache_enabled);
     return ESP_OK;
 }
 #endif // !CONFIG_APP_BUILD_TYPE_PURE_RAM_APP

components/log/CMakeLists.txt

@@ -13,18 +13,20 @@ endif()
 
 set(srcs "src/${system_target}/log_timestamp.c"
          "src/log_timestamp_common.c"
-         "src/${system_target}/log_lock.c")
+         "src/${system_target}/log_lock.c"
+         "src/buffer/log_buffers.c"
+         "src/${system_target}/util.c"
+         "src/util.c"
+         "src/log_print.c"
+         "src/log.c")
+
 set(priv_requires "")
 
 if(NOT non_os_build)
     list(APPEND priv_requires soc hal esp_hw_support)
 
     list(APPEND srcs "src/os/log_write.c")
 
-    # Buffer APIs call ESP_LOG_LEVEL -> esp_log_write, which can not used in bootloader.
-    list(APPEND srcs "src/buffer/log_buffers.c"
-                     "src/util.c")
-
     list(APPEND srcs "src/log_level/log_level.c"
                      "src/log_level/tag_log_level/tag_log_level.c")
 

components/log/Kconfig

@@ -1,5 +1,51 @@
 menu "Log"
 
+    choice LOG_VERSION
+        prompt "Log version"
+        default LOG_VERSION_1
+        help
+            Select the log version to be used by the ESP log component.
+
+            - "V1": This version integrates log formatting into the format string provided by the user.
+                    Logs are processed and formatted during compile time, leading to a larger binary file.
+                    Example: ESP_LOGI("boot", "chip revision: v%d.%d", major, minor);
+                    Output: I (56) boot: chip revision: v3.0
+                    Note: Log strings are stored in Flash with added formatting characters.
+                    Format string on flash: "[0;32mI (%lu) %s: chip revision: v%d.%d [0m"
+
+            - "V2": This version centralizes log formatting within the esp_log() function.
+                    User-supplied format strings are stored without added formatting, reducing binary size.
+                    Example: ESP_LOGI("boot", "chip revision: v%d.%d", major, minor);
+                    Output: I (56) boot: chip revision: v3.0
+                    Note: This version supports runtime configuration of formatting and is more flexible,
+                    logging from constrained environments (ex.: ISR, Startup, Cache disabled).
+                    It may consumes a bit more stack and affect performance.
+                    Format string on flash: "chip revision: v%d.%d"
+
+            Use V1 for minimal stack usage and simpler implementation.
+            Use V2 for smaller binary sizes, more flexible log formatting, and advanced features like disabling
+            colors or timestamps.
+
+        config LOG_VERSION_1
+            bool "V1"
+            help
+                Select this option to use Log V1. Recommended for projects with strict stack constraints
+                or that prioritize performance over flexibility.
+
+        config LOG_VERSION_2
+            bool "V2"
+            help
+                Select this option to use Log V2. Recommended for projects that require smaller binaries,
+                runtime log formatting configuration, or advanced logging features.
+    endchoice
+
+    config LOG_VERSION
+        int
+        default 1 if LOG_VERSION_1
+        default 2 if LOG_VERSION_2
+        help
+            This configuration sets the log version number based on the chosen log version.
+
     orsource "./Kconfig.level"
 
     orsource "./Kconfig.format"

components/log/Kconfig.format

@@ -3,10 +3,23 @@ menu "Format"
     config LOG_COLORS
         bool "Color"
         default n
+        select LOG_COLORS_SUPPORT if LOG_VERSION_2
         help
-            Enable ANSI terminal color codes.
+            Enable ANSI terminal color codes. Logs (info, errors, warnings) will contain color codes.
             In order to view these, your terminal program must support ANSI color codes.
 
+    config LOG_COLORS_SUPPORT
+        bool "Allow enabling color output at run time"
+        depends on LOG_VERSION_2
+        default n
+        help
+            Enables support for color codes in the esp_log() function. If CONFIG_LOG_COLORS is enabled, this option
+            is always active. If CONFIG_LOG_COLORS is disabled, this option allows you to still handle color codes
+            in specific files by defining ESP_LOG_COLOR_DISABLED as 0 before including esp_log.h.
+
+            Note that enabling this option may slightly increase IRAM usage due to additional color handling
+            functionality. It provides flexibility to manage color output even when CONFIG_LOG_COLORS is turned off.
+
     choice LOG_TIMESTAMP_SOURCE
         prompt "Timestamp"
         default LOG_TIMESTAMP_SOURCE_RTOS
@@ -33,24 +46,49 @@ menu "Format"
             - "System time (YY-MM-DD HH:MM:SS.sss)" it is the same as the above,
               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
               (i.e WiFi & Bluetooth libraries), these will always print
               milliseconds since boot.
 
         config LOG_TIMESTAMP_SOURCE_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
             bool "Milliseconds Since Boot"
+            select LOG_TIMESTAMP_SUPPORT if LOG_VERSION_2
 
         config LOG_TIMESTAMP_SOURCE_SYSTEM
             bool "System Time (HH:MM:SS.sss)"
+            select LOG_TIMESTAMP_SUPPORT if LOG_VERSION_2
 
         config LOG_TIMESTAMP_SOURCE_SYSTEM_FULL
             bool "System Time (YY-MM-DD HH:MM:SS.sss)"
-            depends on NO_SYMBOL  # hide it now, turn it on final MR
+            select LOG_TIMESTAMP_SUPPORT if 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
 
+    config LOG_TIMESTAMP_SUPPORT
+        bool "Allow enabling timestamp output at run time"
+        depends on LOG_VERSION_2
+        default y
+        help
+            Enables support for timestamp in the esp_log() function.
+            If CONFIG_LOG_TIMESTAMP_SOURCE_NONE, this option allows you to still handle timestamp
+            in specific files by defining ESP_LOG_TIMESTAMP_DISABLED as 0 before including esp_log.h.
+
+            Note that enabling this option may slightly increase IRAM usage due to additional timestamp handling
+            functionality. It provides flexibility to manage timestamp output even when
+            CONFIG_LOG_TIMESTAMP_SOURCE_NONE.
+
 endmenu