From c9f80a25a5fc63886dc1c8ddb94b302f1099941e Mon Sep 17 00:00:00 2001 From: shripad621git Date: Fri, 14 Jul 2023 13:21:46 +0530 Subject: [PATCH] Added custom_tracing_functionality for esp32 platform and integrated the tracing with esp_insights. Added a esp32_trace directory to provide esp32 specific basic implementation of the scoped tracing macros. Integrated esp-insights on a config option in the all-clusters-app. This is an initial implemenation of the matter_insights framework . --- config/esp32/components/chip/CMakeLists.txt | 9 ++++ config/esp32/components/chip/Kconfig | 7 +++ .../esp32/components/chip/idf_component.yml | 3 ++ examples/all-clusters-app/esp32/README.md | 21 ++++++++ .../esp32/main/CMakeLists.txt | 18 ++++++- examples/all-clusters-app/esp32/main/main.cpp | 23 +++++++++ src/tracing/esp32_trace/BUILD.gn | 27 ++++++++++ .../include/matter/tracing/macros_impl.cpp | 44 ++++++++++++++++ .../include/matter/tracing/macros_impl.h | 50 +++++++++++++++++++ src/tracing/macros.h | 1 + src/tracing/tracing_args.gni | 16 +++++- 11 files changed, 216 insertions(+), 3 deletions(-) create mode 100644 src/tracing/esp32_trace/BUILD.gn create mode 100644 src/tracing/esp32_trace/include/matter/tracing/macros_impl.cpp create mode 100644 src/tracing/esp32_trace/include/matter/tracing/macros_impl.h diff --git a/config/esp32/components/chip/CMakeLists.txt b/config/esp32/components/chip/CMakeLists.txt index d35791cf1ed3c0..55b2165ede6087 100644 --- a/config/esp32/components/chip/CMakeLists.txt +++ b/config/esp32/components/chip/CMakeLists.txt @@ -252,6 +252,10 @@ if (CONFIG_SEC_CERT_DAC_PROVIDER) chip_gn_arg_append("chip_use_secure_cert_dac_provider" "true") endif() +if (CONFIG_ENABLE_INSIGHTS_CUSTOM_TRACE) + chip_gn_arg_append("chip_enable_insights_custom_trace" "true") +endif() + if (CONFIG_USE_ESP32_ECDSA_PERIPHERAL) chip_gn_arg_append("chip_use_esp32_ecdsa_peripheral" "true") endif() @@ -414,6 +418,11 @@ if (CONFIG_SEC_CERT_DAC_PROVIDER) list(APPEND chip_libraries $) endif() +if (CONFIG_ENABLE_INSIGHTS_CUSTOM_TRACE) +idf_component_get_property(esp_insights_lib espressif__esp_insights COMPONENT_LIB) +list(APPEND chip_libraries $) +endif() + idf_component_get_property(lwip_lib lwip COMPONENT_LIB) list(APPEND chip_libraries $) diff --git a/config/esp32/components/chip/Kconfig b/config/esp32/components/chip/Kconfig index 99de12afa97e6e..107d643bd17b52 100644 --- a/config/esp32/components/chip/Kconfig +++ b/config/esp32/components/chip/Kconfig @@ -800,6 +800,13 @@ menu "CHIP Device Layer" then this option gets enabled. Also, please disable ESP_SECURE_CERT_DS_PERIPHERAL from the menuconfig when this option is disabled + config ENABLE_INSIGHTS_CUSTOM_TRACE + bool "Enable ESP32 Custom Tracing Functionality" + depends on ESP_INSIGHTS_ENABLED + default n + help + Enables ESP32 Custom Tracing functionality with esp-insights. + endmenu diff --git a/config/esp32/components/chip/idf_component.yml b/config/esp32/components/chip/idf_component.yml index 82c7fe3fc81338..337ee410954d78 100644 --- a/config/esp32/components/chip/idf_component.yml +++ b/config/esp32/components/chip/idf_component.yml @@ -15,3 +15,6 @@ dependencies: version: "2.0.3" rules: - if: "idf_version >=4.4" + + espressif/esp_insights: + version: "1.0.0" diff --git a/examples/all-clusters-app/esp32/README.md b/examples/all-clusters-app/esp32/README.md index d7817027369adf..4714665fe150cb 100644 --- a/examples/all-clusters-app/esp32/README.md +++ b/examples/all-clusters-app/esp32/README.md @@ -9,6 +9,27 @@ and refer [building and commissioning](../../../docs/guides/esp32/build_app_and_commission.md) guides to get started. +#Note: Enabling ESP-Insights in the example: + +1.Before building the app, enable the options: ESP_INSIGHTS_ENABLED and +CONFIG_ENABLE_INSIGHTS_CUSTOM_TRACE through menuconfig. + +2.Create a file named insights_auth_key.txt in the main directory of the +example. + +3.Follow the steps +present[here](https://github.com/espressif/esp-insights/blob/main/examples/README.md#set-up-esp-insights-account) +to set up an insights_account and the auth key created while setting it up +willbe used in the example. + +4.Download the auth key and copy Auth Key to the example + +``` +cp /path/to/auth/key.txt path/to/connectedhomeip/examples/all-clusters-app/esp32/main/insights_auth_key.txt +``` + +5.Now build the example. + --- - [Cluster control](#cluster-control) diff --git a/examples/all-clusters-app/esp32/main/CMakeLists.txt b/examples/all-clusters-app/esp32/main/CMakeLists.txt index 14015338230788..4f47f43d2d42ea 100644 --- a/examples/all-clusters-app/esp32/main/CMakeLists.txt +++ b/examples/all-clusters-app/esp32/main/CMakeLists.txt @@ -102,6 +102,17 @@ set(SRC_DIRS_LIST set(EXCLUDE_SRCS "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/examples/all-clusters-app/all-clusters-common/src/static-supported-modes-manager.cpp") +if (CONFIG_ENABLE_INSIGHTS_CUSTOM_TRACE) +#Append directories for build +set(PRIV_INCLUDE_DIRS_LIST "${PRIV_INCLUDE_DIRS_LIST}" + "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/tracing/esp32_trace/include") +endif() + +if (NOT CONFIG_ENABLE_INSIGHTS_CUSTOM_TRACE) +set(PRIV_INCLUDE_DIRS_LIST "${PRIV_INCLUDE_DIRS_LIST}" + "${CMAKE_SOURCE_DIR}/third_party/connectedhomeip/src/tracing/none/include") +endif () + if (CONFIG_ENABLE_PW_RPC) # Append additional directories for RPC build set(PRIV_INCLUDE_DIRS_LIST "${PRIV_INCLUDE_DIRS_LIST}" @@ -119,7 +130,7 @@ set(SRC_DIRS_LIST "${SRC_DIRS_LIST}" ) endif (CONFIG_ENABLE_PW_RPC) -set(PRIV_REQUIRES_LIST chip QRCode bt driver app_update nvs_flash spi_flash openthread) +set(PRIV_REQUIRES_LIST chip QRCode bt driver app_update nvs_flash spi_flash openthread espressif__esp_insights) if(CONFIG_HAVE_DISPLAY) list(APPEND PRIV_REQUIRES_LIST tft spidrier screen-framework) endif() @@ -146,6 +157,11 @@ target_compile_options(${COMPONENT_LIB} PUBLIC "-DCHIP_ADDRESS_RESOLVE_IMPL_INCLUDE_HEADER=" ) + +if (CONFIG_ENABLE_INSIGHTS_CUSTOM_TRACE) +target_add_binary_data(${COMPONENT_TARGET} "insights_auth_key.txt" TEXT) +endif() + if (CONFIG_ENABLE_PW_RPC) diff --git a/examples/all-clusters-app/esp32/main/main.cpp b/examples/all-clusters-app/esp32/main/main.cpp index ecca799c81d07b..8bf18d91ff614e 100644 --- a/examples/all-clusters-app/esp32/main/main.cpp +++ b/examples/all-clusters-app/esp32/main/main.cpp @@ -44,6 +44,10 @@ #include #include +#if CONFIG_ENABLE_INSIGHTS_CUSTOM_TRACE +#include +#endif + #if CONFIG_HAVE_DISPLAY #include "DeviceWithDisplay.h" #endif @@ -78,6 +82,11 @@ using namespace ::chip::Credentials; const char * TAG = "all-clusters-app"; +#if CONFIG_ENABLE_INSIGHTS_CUSTOM_TRACE +extern const char insights_auth_key_start[] asm("_binary_insights_auth_key_txt_start"); +extern const char insights_auth_key_end[] asm("_binary_insights_auth_key_txt_end"); +#endif + static AppDeviceCallbacks EchoCallbacks; static AppDeviceCallbacksDelegate sAppDeviceCallbacksDelegate; namespace { @@ -161,6 +170,20 @@ extern "C" void app_main() chip::rpc::Init(); #endif +#if CONFIG_ENABLE_INSIGHTS_CUSTOM_TRACE + esp_insights_config_t config = { + .log_type = ESP_DIAG_LOG_TYPE_ERROR | ESP_DIAG_LOG_TYPE_WARNING | ESP_DIAG_LOG_TYPE_EVENT, + .auth_key = insights_auth_key_start, + }; + + esp_err_t ret = esp_insights_init(&config); + + if (ret != ESP_OK) + { + ESP_LOGE(TAG, "Failed to initialize ESP Insights, err:0x%x", ret); + } +#endif + ESP_LOGI(TAG, "=================================================="); ESP_LOGI(TAG, "chip-esp32-all-cluster-demo starting"); ESP_LOGI(TAG, "=================================================="); diff --git a/src/tracing/esp32_trace/BUILD.gn b/src/tracing/esp32_trace/BUILD.gn new file mode 100644 index 00000000000000..d7580a3e68ac2a --- /dev/null +++ b/src/tracing/esp32_trace/BUILD.gn @@ -0,0 +1,27 @@ +# +#Copyright (c) 2023 Project CHIP Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import("//build_overrides/build.gni") +import("//build_overrides/chip.gni") + +config("tracing") { + include_dirs = [ "include" ] +} + +source_set("esp32_trace") { + public = [ "include/matter/tracing/macros_impl.h" ] + sources = [ "include/matter/tracing/macros_impl.cpp" ] + public_configs = [ ":tracing" ] +} diff --git a/src/tracing/esp32_trace/include/matter/tracing/macros_impl.cpp b/src/tracing/esp32_trace/include/matter/tracing/macros_impl.cpp new file mode 100644 index 00000000000000..eb21dd68bddcea --- /dev/null +++ b/src/tracing/esp32_trace/include/matter/tracing/macros_impl.cpp @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2023 Project CHIP Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include "macros_impl.h" +#include +#include +namespace Insights { + +ESP32Backend::ESP32Backend(const char * str, ...) +{ + va_list args; + va_start(args, str); + var1 = str; + var2 = va_arg(args, const char *); + + int start_min_heap = heap_caps_get_minimum_free_size(MALLOC_CAP_8BIT); + int largest_free_block = heap_caps_get_largest_free_block(MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT); + int start_free_heap = heap_caps_get_free_size(MALLOC_CAP_8BIT); + ESP_DIAG_EVENT("MTR_TRC", "Entry - %s - %s - Start Min Free heap - %5d - Largest Free Block - %5d Start free heap -%5d", var1, + var2, start_min_heap, largest_free_block, start_free_heap); +} + +ESP32Backend::~ESP32Backend() +{ + int end_minimum_free_heap = heap_caps_get_minimum_free_size(MALLOC_CAP_8BIT); + int end_largest_free_block = heap_caps_get_largest_free_block(MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT); + int end_free_heap = heap_caps_get_free_size(MALLOC_CAP_8BIT); + ESP_DIAG_EVENT("MTR_TRC", "Exit - %s - %s - End Min Free heap - %5d - End Largest Free Block %5d - End free Heap - %5d", var1, + var2, end_minimum_free_heap, end_largest_free_block, end_free_heap); +} +} // namespace Insights diff --git a/src/tracing/esp32_trace/include/matter/tracing/macros_impl.h b/src/tracing/esp32_trace/include/matter/tracing/macros_impl.h new file mode 100644 index 00000000000000..3135b9b43b985d --- /dev/null +++ b/src/tracing/esp32_trace/include/matter/tracing/macros_impl.h @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2023 Project CHIP Authors + * All rights reserved. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#pragma once + +/* Ensure we do not have double tracing macros defined */ +#if defined(MATTER_TRACE_BEGIN) +#error "Tracing macros seem to be double defined" +#endif + +namespace Insights { +class ESP32Backend +{ +public: + ESP32Backend(const char * str, ...); + ~ESP32Backend(); + +private: + const char * var1; + const char * var2; +}; +} // namespace Insights + +#define MATTER_TRACE_SCOPE(...) \ + do \ + { \ + Insights::ESP32Backend backend(__VA_ARGS__); \ + } while (0) + +#define _MATTER_TRACE_DISABLE(...) \ + do \ + { \ + } while (false) + +#define MATTER_TRACE_BEGIN(...) _MATTER_TRACE_DISABLE(__VA_ARGS__) +#define MATTER_TRACE_END(...) _MATTER_TRACE_DISABLE(__VA_ARGS__) +#define MATTER_TRACE_INSTANT(...) _MATTER_TRACE_DISABLE(__VA_ARGS__) diff --git a/src/tracing/macros.h b/src/tracing/macros.h index 5f836e44d373bc..e68e2fa113d9ad 100644 --- a/src/tracing/macros.h +++ b/src/tracing/macros.h @@ -26,6 +26,7 @@ // MATTER_TRACE_END(label, group) // MATTER_TRACE_INSTANT(label, group) // MATTER_TRACE_SCOPE(label, group) + #include #include #include diff --git a/src/tracing/tracing_args.gni b/src/tracing/tracing_args.gni index 7c27f9ecaba39a..5c190b0eaaa71d 100644 --- a/src/tracing/tracing_args.gni +++ b/src/tracing/tracing_args.gni @@ -14,6 +14,7 @@ import("//build_overrides/build.gni") import("//build_overrides/chip.gni") import("${build_root}/config/compiler/compiler.gni") +import("${chip_root}/src/platform/device.gni") declare_args() { # Tracing can have a non-zero size impact to binaries. We try to make @@ -22,7 +23,9 @@ declare_args() { # # Additionally, if tracing is enabled, the main() function has to add # backends explicitly - matter_enable_tracing_support = current_os == "android" + matter_enable_tracing_support = + current_os == "android" || chip_device_platform == "esp32" + chip_enable_insights_custom_trace = false # Defines the trace backend. Current matter tracing splits the logic # into two parts: @@ -43,7 +46,16 @@ declare_args() { # since tracing is very noisy, we generally expect it to be explicitly # set up. # - if (current_os == "linux" || current_os == "android") { +} + +declare_args() { + if (chip_device_platform == "esp32" && chip_enable_insights_custom_trace) { + matter_trace_config = "${chip_root}/src/tracing/esp32_trace" + } else + # TODO: cpp_standard check is not ideal, it should be >= 17, + # however for now this is what we use in compilations + if ((current_os == "linux" || current_os == "android") && + cpp_standard == "gnu++17") { matter_trace_config = "${chip_root}/src/tracing/perfetto:perfetto_tracing" } else { matter_trace_config = "${chip_root}/src/tracing/none"