[Memory] Fix strange crashes due to not using correct heap

Author: TD-er

src/src/DataStructs/EventQueue.cpp

@@ -1,5 +1,7 @@
 #include "EventQueue.h"
 
+#include "../../ESPEasy_common.h"
+
 EventQueueStruct::EventQueueStruct() {}
 
 void EventQueueStruct::add(const String& event)
@@ -16,7 +18,8 @@ void EventQueueStruct::add(const __FlashStringHelper * event)
   #ifdef USE_SECOND_HEAP
   HeapSelectIram ephemeral;
   #endif
-  _eventQueue.push_back(event);
+  // Wrap in String() constructor to make sure it is using the 2nd heap allocator if present.
+  _eventQueue.push_back(String(event));
 }
 
 void EventQueueStruct::addMove(String&& event)
@@ -35,7 +38,12 @@ bool EventQueueStruct::getNext(String& event)
     return false;
   }
   #ifdef USE_SECOND_HEAP
-  event = _eventQueue.front();
+  {
+    // Fetch the event and make sure it is allocated on the DRAM heap, not the 2nd heap
+    // Otherwise checks like strnlen_P may crash on it.
+    HeapSelectDram ephemeral;
+    event = std::move(String(_eventQueue.front()));
+  }
   #else
   event = std::move(_eventQueue.front());
   #endif

src/src/DataStructs/EventQueue.h

@@ -3,7 +3,7 @@
 
 
 #include <list>
-#include "../../ESPEasy_common.h"
+
 
 #include "../Globals/Plugins.h"
 

src/src/DataStructs/LogStruct.cpp

@@ -34,6 +34,8 @@ void LogStruct::add(const byte loglevel, const char *line) {
     #ifdef USE_SECOND_HEAP
     {
       if (millis() > 5000) {
+        // FIXME TD-er: Must check if we're called from loop() and not from setup()
+        // For now we can probably expect not to be in the setup() anymore???
         HeapSelectIram ephemeral;
       }
       Message[write_idx] = EMPTY_STRING; // Have to clear it first or else it will re-allocate on the same heap
@@ -51,6 +53,11 @@ bool LogStruct::get(String& output, const String& lineEnd) {
   lastReadTimeStamp = millis();
 
   if (!isEmpty()) {
+    #ifdef USE_SECOND_HEAP
+    // Fetch the log line and make sure it is allocated on the DRAM heap, not the 2nd heap
+    // Otherwise checks like strnlen_P may crash on it.
+    HeapSelectDram ephemeral;
+    #endif
     read_idx = (read_idx + 1) % LOG_STRUCT_MESSAGE_LINES;
     output  += formatLine(read_idx, lineEnd);
   }

src/src/DataStructs/LogStruct.h

@@ -14,7 +14,7 @@
   #define LOG_BUFFER_EXPIRE         30000  // Time after which a buffered log item is considered expired.
 #else
   #ifdef USE_SECOND_HEAP
-    #define LOG_STRUCT_MESSAGE_LINES 15
+    #define LOG_STRUCT_MESSAGE_LINES 30
   #else
     #if defined(PLUGIN_BUILD_TESTING) || defined(PLUGIN_BUILD_DEV)
       #define LOG_STRUCT_MESSAGE_LINES 10

src/src/DataStructs/Web_StreamingBuffer.cpp

@@ -10,7 +10,7 @@
 
 #include "../Helpers/ESPEasy_time_calc.h"
 
-
+#include "../../ESPEasy_common.h"
 
 #define CHUNKED_BUFFER_SIZE          400
 
@@ -69,6 +69,10 @@ Web_StreamingBuffer Web_StreamingBuffer::operator+=(const __FlashStringHelper* s
 }
 
 Web_StreamingBuffer Web_StreamingBuffer::addFlashString(PGM_P str) {
+  #ifdef USE_SECOND_HEAP
+  HeapSelectDram ephemeral;
+  #endif
+
   ++flashStringCalls;
 
   if (!str) { return *this; // return if the pointer is void
@@ -163,6 +167,10 @@ void Web_StreamingBuffer::startJsonStream() {
 }
 
 void Web_StreamingBuffer::startStream(bool json, const String& origin) {
+  #ifdef USE_SECOND_HEAP
+  HeapSelectDram ephemeral;
+  #endif
+
   maxCoreUsage = maxServerUsage = 0;
   initialRam   = ESP.getFreeHeap();
   beforeTXRam  = initialRam;
@@ -183,6 +191,10 @@ void Web_StreamingBuffer::startStream(bool json, const String& origin) {
 }
 
 void Web_StreamingBuffer::trackTotalMem() {
+  #ifdef USE_SECOND_HEAP
+  HeapSelectDram ephemeral;
+  #endif
+
   beforeTXRam = ESP.getFreeHeap();
 
   if ((initialRam - beforeTXRam) > maxServerUsage) {
@@ -191,6 +203,10 @@ void Web_StreamingBuffer::trackTotalMem() {
 }
 
 void Web_StreamingBuffer::trackCoreMem() {
+  #ifdef USE_SECOND_HEAP
+  HeapSelectDram ephemeral;
+  #endif
+
   duringTXRam = ESP.getFreeHeap();
 
   if ((initialRam - duringTXRam) > maxCoreUsage) {
@@ -199,6 +215,10 @@ void Web_StreamingBuffer::trackCoreMem() {
 }
 
 void Web_StreamingBuffer::endStream() {
+  #ifdef USE_SECOND_HEAP
+  HeapSelectDram ephemeral;
+  #endif
+
   if (!lowMemorySkip) {
     if (buf.length() > 0) { sendContentBlocking(buf); }
     buf.clear();
@@ -230,6 +250,10 @@ void Web_StreamingBuffer::endStream() {
 
 
 void Web_StreamingBuffer::sendContentBlocking(String& data) {
+  #ifdef USE_SECOND_HEAP
+  HeapSelectDram ephemeral;
+  #endif
+
   const uint32_t length   = data.length();
 #ifndef BUILD_NO_DEBUG
   if (loglevelActiveFor(LOG_LEVEL_DEBUG_DEV)) {
@@ -283,6 +307,10 @@ void Web_StreamingBuffer::sendContentBlocking(String& data) {
 }
 
 void Web_StreamingBuffer::sendHeaderBlocking(bool json, const String& origin) {
+  #ifdef USE_SECOND_HEAP
+  HeapSelectDram ephemeral;
+  #endif
+
   #ifndef BUILD_NO_RAM_TRACKER
   checkRAM(F("sendHeaderBlocking"));
   #endif