[Memory] Allow to disable collecting timing stats to save RAM

BitBerv · Jul 2, 2021 · 64e3c4a · 64e3c4a
1 parent 71fcf79
commit 64e3c4a
Show file tree

Hide file tree

Showing 11 changed files with 43 additions and 6 deletions.
diff --git a/src/src/CustomBuild/ESPEasyDefaults.h b/src/src/CustomBuild/ESPEasyDefaults.h
@@ -223,6 +223,9 @@
 #ifndef DEFAULT_JSON_BOOL_WITHOUT_QUOTES
 #define DEFAULT_JSON_BOOL_WITHOUT_QUOTES false
 #endif
+#ifndef DEFAULT_ENABLE_TIMING_STATS
+#define DEFAULT_ENABLE_TIMING_STATS false
+#endif
 
 
 

diff --git a/src/src/DataStructs/SettingsStruct.cpp b/src/src/DataStructs/SettingsStruct.cpp
@@ -180,6 +180,16 @@ void SettingsStruct_tmpl<N_TASKS>::JSONBoolWithoutQuotes(bool value) {
   bitWrite(VariousBits1, 16, value);
 }
 
+template<unsigned int N_TASKS>
+bool SettingsStruct_tmpl<N_TASKS>::EnableTimingStats() const {
+  return bitRead(VariousBits1, 17);
+}
+
+template<unsigned int N_TASKS>
+void SettingsStruct_tmpl<N_TASKS>::EnableTimingStats(bool value) {
+  bitWrite(VariousBits1, 17, value);
+}
+
 template<unsigned int N_TASKS>
 bool SettingsStruct_tmpl<N_TASKS>::CombineTaskValues_SingleEvent(taskIndex_t taskIndex) const {
   if (validTaskIndex(taskIndex)) {

diff --git a/src/src/DataStructs/SettingsStruct.h b/src/src/DataStructs/SettingsStruct.h
@@ -109,6 +109,10 @@ class SettingsStruct_tmpl
   // When outputting JSON bools use quoted values (on, backward compatible) or use official JSON true/false unquoted
   bool JSONBoolWithoutQuotes() const;
   void JSONBoolWithoutQuotes(bool value);
+
+  // Enable timing statistics (may consume a few kB of RAM)
+  bool EnableTimingStats() const;
+  void EnableTimingStats(bool value);
 
 
   // Flag indicating whether all task values should be sent in a single event or one event per task value (default behavior)

diff --git a/src/src/DataStructs/TimingStats.cpp b/src/src/DataStructs/TimingStats.cpp
@@ -100,6 +100,7 @@ const __FlashStringHelper * getPluginFunctionName(int function) {
 }
 
 bool mustLogFunction(int function) {
+  if (!Settings.EnableTimingStats()) return false;
   switch (function) {
     case PLUGIN_INIT_ALL:              return false;
     case PLUGIN_INIT:                  return false;
@@ -163,6 +164,7 @@ const __FlashStringHelper * getCPluginCFunctionName(CPlugin::Function function)
 }
 
 bool mustLogCFunction(CPlugin::Function function) {
+  if (!Settings.EnableTimingStats()) return false;
   switch (function) {
     case CPlugin::Function::CPLUGIN_PROTOCOL_ADD:              return false;
     case CPlugin::Function::CPLUGIN_PROTOCOL_TEMPLATE:         return false;

diff --git a/src/src/DataStructs/TimingStats.h b/src/src/DataStructs/TimingStats.h
@@ -126,10 +126,10 @@ extern unsigned long timingstats_last_reset;
   if (mustLogCFunction(F)) controllerStats[(T) * 256 + static_cast<int>(F)].add(usecPassedSince(statisticsTimerStart));
 
 // #define STOP_TIMER_LOADFILE miscStats[LOADFILE_STATS].add(usecPassedSince(statisticsTimerStart));
-# define STOP_TIMER(L) miscStats[L].add(usecPassedSince(statisticsTimerStart));
+# define STOP_TIMER(L) if (Settings.EnableTimingStats()) { miscStats[L].add(usecPassedSince(statisticsTimerStart)); }
 
 // Add a timer statistic value in usec.
-# define ADD_TIMER_STAT(L, T) miscStats[L].add(T);
+# define ADD_TIMER_STAT(L, T) if (Settings.EnableTimingStats()) { miscStats[L].add(T); }
 
 #else // ifdef USES_TIMING_STATS
 

diff --git a/src/src/Helpers/ESPEasyRTC.cpp b/src/src/Helpers/ESPEasyRTC.cpp
@@ -8,6 +8,7 @@
 #include "../ESPEasyCore/ESPEasy_Log.h"
 #include "../Globals/Plugins.h"
 #include "../Globals/RuntimeData.h"
+#include "../Globals/Settings.h"
 #include "../Helpers/CRC_functions.h"
 #include "../../ESPEasy_common.h"
 

diff --git a/src/src/Helpers/ESPEasy_FactoryDefault.cpp b/src/src/Helpers/ESPEasy_FactoryDefault.cpp
@@ -220,6 +220,7 @@ void ResetFactory()
   Settings.I2C_clockSpeed = DEFAULT_I2C_CLOCK_SPEED;
 
   Settings.JSONBoolWithoutQuotes(DEFAULT_JSON_BOOL_WITHOUT_QUOTES);
+  Settings.EnableTimingStats(DEFAULT_ENABLE_TIMING_STATS);
 
 #ifdef PLUGIN_DESCR
   strcpy_P(Settings.Name, PSTR(PLUGIN_DESCR));

diff --git a/src/src/Helpers/StringProvider.cpp b/src/src/Helpers/StringProvider.cpp
@@ -75,6 +75,10 @@ const __FlashStringHelper * getLabel(LabelType::Enum label) {
     #endif // ESP32_ENABLE_PSRAM
 #endif // ifdef ESP32
 
+    case LabelType::JSON_BOOL_QUOTES:       return F("JSON bool output without quotes");
+    case LabelType::ENABLE_TIMING_STATISTICS:  return F("Collect Timing Statistics");
+
+
     case LabelType::BOOT_TYPE:              return F("Last Boot Cause");
     case LabelType::BOOT_COUNT:             return F("Boot Count");
     case LabelType::DEEP_SLEEP_ALTERNATIVE_CALL: return F("Deep Sleep Alternative");
@@ -241,6 +245,9 @@ String getValue(LabelType::Enum label) {
 #endif // ifdef ESP32
 
 
+    case LabelType::JSON_BOOL_QUOTES:       return jsonBool(Settings.JSONBoolWithoutQuotes());
+    case LabelType::ENABLE_TIMING_STATISTICS:  return jsonBool(Settings.EnableTimingStats());
+
     case LabelType::BOOT_TYPE:              return getLastBootCauseString();
     case LabelType::BOOT_COUNT:             break;
     case LabelType::DEEP_SLEEP_ALTERNATIVE_CALL: return jsonBool(Settings.UseAlternativeDeepSleep());

diff --git a/src/src/Helpers/StringProvider.h b/src/src/Helpers/StringProvider.h
@@ -49,6 +49,9 @@ struct LabelType {
     #endif // ESP32_ENABLE_PSRAM
 #endif // ifdef ESP32
 
+    JSON_BOOL_QUOTES,
+    ENABLE_TIMING_STATISTICS,
+
     BOOT_TYPE,               // Cold boot
     BOOT_COUNT,              // 0
     RESET_REASON,            // Software/System restart

diff --git a/src/src/WebServer/AdvancedConfigPage.cpp b/src/src/WebServer/AdvancedConfigPage.cpp
@@ -98,7 +98,8 @@ void handle_advanced() {
     Settings.NumberExtraWiFiScans = getFormItemInt(LabelType::WIFI_NR_EXTRA_SCANS);
     Settings.PeriodicalScanWiFi(isFormItemChecked(LabelType::WIFI_PERIODICAL_SCAN));
     Settings.UseLastWiFiFromRTC(isFormItemChecked(LabelType::WIFI_USE_LAST_CONN_FROM_RTC));
-    Settings.JSONBoolWithoutQuotes(isFormItemChecked(F("json_bool_with_quotes")));
+    Settings.JSONBoolWithoutQuotes(isFormItemChecked(LabelType::JSON_BOOL_QUOTES));
+    Settings.EnableTimingStats(isFormItemChecked(LabelType::ENABLE_TIMING_STATISTICS));
     #ifdef ESP8266
     Settings.UseAlternativeDeepSleep(isFormItemChecked(LabelType::DEEP_SLEEP_ALTERNATIVE_CALL));
     #endif
@@ -202,7 +203,10 @@ void handle_advanced() {
   addFormCheckBox_disabled(F("Enable RTOS Multitasking"), F("usertosmultitasking"), Settings.UseRTOSMultitasking);
   #endif // if defined(ESP32)
 
-  addFormCheckBox(F("JSON bool output without quotes"), F("json_bool_with_quotes"), Settings.JSONBoolWithoutQuotes());
+  addFormCheckBox(LabelType::JSON_BOOL_QUOTES, Settings.JSONBoolWithoutQuotes());
+  #ifdef USES_TIMING_STATS
+  addFormCheckBox(LabelType::ENABLE_TIMING_STATISTICS, Settings.EnableTimingStats());
+  #endif
   #ifdef ESP8266
   addFormCheckBox(LabelType::DEEP_SLEEP_ALTERNATIVE_CALL, Settings.UseAlternativeDeepSleep());
   #endif

diff --git a/src/src/WebServer/WebServer.cpp b/src/src/WebServer/WebServer.cpp
@@ -763,7 +763,8 @@ void writeDefaultCSS(void)
 {
   return; // TODO
 
-#ifndef BUILD_NO_DEBUG
+/*
+#ifndef WEBSERVER_USE_CDN_JS_CSS
 
   if (!fileExists(F("esp.css")))
   {
@@ -785,7 +786,8 @@ void writeDefaultCSS(void)
       f.close();
     }
   }
-#endif // ifndef BUILD_NO_DEBUG
+#endif
+*/
 }
 
 // ********************************************************************************