Merge branch 'pr-eraseconfig-reset' of github.com:mhightower83/Arduino into pr-eraseconfig-reset

Author: mhightower83

cores/esp8266/WString.cpp

@@ -197,6 +197,15 @@ bool String::reserve(unsigned int size) {
     return false;
 }
 
+#ifdef DEBUG_ESP_PORT
+static void identifyString (const String& badOne)
+{
+    DEBUG_ESP_PORT.printf("[String] '%." STR(OOM_STRING_BORDER_DISPLAY) "s ... %." STR(OOM_STRING_BORDER_DISPLAY) "s': ",
+        badOne.c_str(),
+        badOne.length() > OOM_STRING_BORDER_DISPLAY? badOne.c_str() + std::max((int)badOne.length() - OOM_STRING_BORDER_DISPLAY, OOM_STRING_BORDER_DISPLAY): "");
+}
+#endif
+
 bool String::changeBuffer(unsigned int maxStrLen) {
     // Can we use SSO here to avoid allocation?
     if (maxStrLen < sizeof(sso.buff) - 1) {
@@ -218,16 +227,19 @@ bool String::changeBuffer(unsigned int maxStrLen) {
     }
     // Fallthrough to normal allocator
     size_t newSize = (maxStrLen + 16) & (~0xf);
-#ifdef DEBUG_ESP_OOM
+#ifdef DEBUG_ESP_PORT
     if (!isSSO() && capacity() >= OOM_STRING_THRESHOLD_REALLOC_WARN && maxStrLen > capacity()) {
         // warn when badly re-allocating
-        DEBUGV("[String] Reallocating large String(%d -> %d bytes) '%." STR(OOM_STRING_BORDER_DISPLAY) "s ... %." STR(OOM_STRING_BORDER_DISPLAY) "s'\n",
-            len(), maxStrLen, c_str(),
-            len() > OOM_STRING_BORDER_DISPLAY? c_str() + std::max((int)len() - OOM_STRING_BORDER_DISPLAY, OOM_STRING_BORDER_DISPLAY): "");
+        identifyString(*this);
+        DEBUG_ESP_PORT.printf("Reallocating large String(%d -> %d bytes)\n", len(), maxStrLen);
     }
 #endif
     // Make sure we can fit newsize in the buffer
     if (newSize > CAPACITY_MAX) {
+#ifdef DEBUG_ESP_PORT
+        identifyString(*this);
+        DEBUG_ESP_PORT.printf("Maximum capacity reached (" STR(CAPACITY_MAX) ")\n");
+#endif
         return false;
     }
     uint16_t oldLen = len();
@@ -247,6 +259,10 @@ bool String::changeBuffer(unsigned int maxStrLen) {
         setBuffer(newbuffer);
         return true;
     }
+#ifdef DEBUG_ESP_PORT
+    identifyString(*this);
+    DEBUG_ESP_PORT.printf("OOM: %d -> %zu bytes\n", isSSO() ? 0: capacity(), newSize);
+#endif
     return false;
 }
 
@@ -804,7 +820,7 @@ void String::replace(const String &find, const String &replace) {
         if (size == len())
             return;
         if (size > capacity() && !changeBuffer(size))
-            return; // XXX: tell user!
+            return;
         int index = len() - 1;
         while (index >= 0 && (index = lastIndexOf(find, index)) >= 0) {
             readFrom = wbuffer() + index + find.len();

cores/esp8266/core_esp8266_postmortem.cpp

@@ -110,10 +110,26 @@ static void cut_here() {
     ets_putc('\n');
 }
 
-void __wrap_system_restart_local() {
-    register uint32_t sp asm("a1");
-    uint32_t sp_dump = sp;
-
+/*
+  Add some assembly to grab the stack pointer and pass it as an argument before
+  it grows for the target function. Should stabilize the stack offsets, used to
+  find the relevant stack content for dumping.
+*/
+extern "C" void __wrap_system_restart_local(void);
+asm(
+    ".section     .text.__wrap_system_restart_local,\"ax\",@progbits\n\t"
+    ".literal_position\n\t"
+    ".align       4\n\t"
+    ".global      __wrap_system_restart_local\n\t"
+    ".type        __wrap_system_restart_local, @function\n\t"
+    "\n"
+"__wrap_system_restart_local:\n\t"
+    "mov          a2,     a1\n\t"
+    "j            postmortem_report\n\t"
+    ".size __wrap_system_restart_local, .-__wrap_system_restart_local\n\t"
+);
+
+static void postmortem_report(uint32_t sp_dump) {
     struct rst_info rst_info;
     memset(&rst_info, 0, sizeof(rst_info));
     if (s_user_reset_reason == REASON_DEFAULT_RST)
@@ -152,9 +168,17 @@ void __wrap_system_restart_local() {
     else if (rst_info.reason == REASON_EXCEPTION_RST) {
         // The GCC divide routine in ROM jumps to the address below and executes ILL (00 00 00) on div-by-zero
         // In that case, print the exception as (6) which is IntegerDivZero
-        bool div_zero = (rst_info.exccause == 0) && (rst_info.epc1 == 0x4000dce5);
+        uint32_t epc1 = rst_info.epc1;
+        uint32_t exccause = rst_info.exccause;
+        bool div_zero = (exccause == 0) && (epc1 == 0x4000dce5u);
+        if (div_zero) {
+            exccause = 6;
+            // In place of the detached 'ILL' instruction., redirect attention
+            // back to the code that called the ROM divide function.
+            __asm__ __volatile__("rsr.excsave1 %0\n\t" : "=r"(epc1) :: "memory");
+        }
         ets_printf_P(PSTR("\nException (%d):\nepc1=0x%08x epc2=0x%08x epc3=0x%08x excvaddr=0x%08x depc=0x%08x\n"),
-            div_zero ? 6 : rst_info.exccause, rst_info.epc1, rst_info.epc2, rst_info.epc3, rst_info.excvaddr, rst_info.depc);
+            exccause, epc1, rst_info.epc2, rst_info.epc3, rst_info.excvaddr, rst_info.depc);
     }
     else if (rst_info.reason == REASON_SOFT_WDT_RST) {
         ets_printf_P(PSTR("\nSoft WDT reset\n"));
@@ -174,16 +198,31 @@ void __wrap_system_restart_local() {
 
     // amount of stack taken by interrupt or exception handler
     // and everything up to __wrap_system_restart_local
-    // (determined empirically, might break)
+    // ~(determined empirically, might break)~
     uint32_t offset = 0;
     if (rst_info.reason == REASON_SOFT_WDT_RST) {
-        offset = 0x1a0;
+        // Stack Tally
+        // 256 User Exception vector handler reserves stack space
+        //     directed to _xtos_l1int_handler function in Boot ROM
+        //  48 wDev_ProcessFiq - its address appears in a vector table at 0x3FFFC27C
+        //  16 ?unnamed? - index into a table, pull out pointer, and call if non-zero
+        //     appears near near wDev_ProcessFiq
+        //  32 pp_soft_wdt_feed_local - gather the specifics and call __wrap_system_restart_local
+        offset =  32 + 16 + 48 + 256;
     }
     else if (rst_info.reason == REASON_EXCEPTION_RST) {
-        offset = 0x190;
+        // Stack Tally
+        // 256 Exception vector reserves stack space
+        //     filled in by "C" wrapper handler
+        //  16 Handler level 1 - enable icache
+        //  64 Handler level 2 - exception report
+        offset = 64 + 16 + 256;
     }
     else if (rst_info.reason == REASON_WDT_RST) {
-        offset = 0x10;
+        offset = 16;
+    }
+    else if (rst_info.reason == REASON_USER_SWEXCEPTION_RST) {
+        offset = 16;
     }
 
     ets_printf_P(PSTR("\n>>>stack>>>\n"));
@@ -280,8 +319,9 @@ static void raise_exception() {
 
     s_user_reset_reason = REASON_USER_SWEXCEPTION_RST;
     ets_printf_P(PSTR("\nUser exception (panic/abort/assert)"));
-    __wrap_system_restart_local();
-
+    uint32_t sp;
+    __asm__ __volatile__ ("mov %0, a1\n\t" : "=r"(sp) :: "memory");
+    postmortem_report(sp);
     while (1); // never reached, needed to satisfy "noreturn" attribute
 }
 
@@ -321,7 +361,9 @@ void __stack_chk_fail(void) {
     if (gdb_present())
         __asm__ __volatile__ ("syscall"); // triggers GDB when enabled
 
-    __wrap_system_restart_local();
+    uint32_t sp;
+    __asm__ __volatile__ ("mov %0, a1\n\t" : "=r"(sp) :: "memory");
+    postmortem_report(sp);
 
     __builtin_unreachable(); // never reached, needed to satisfy "noreturn" attribute
 }

libraries/ESP8266SdFat

@@ -296,12 +296,35 @@ void ESP8266WebServerTemplate<ServerType>::handleClient() {
   bool keepCurrentClient = false;
   bool callYield = false;
 
-  DBGWS("http-server loop: conn=%d avail=%d status=%s\n",
-    _currentClient.connected(), _currentClient.available(),
-    _currentStatus==HC_NONE?"none":
-    _currentStatus==HC_WAIT_READ?"wait-read":
-    _currentStatus==HC_WAIT_CLOSE?"wait-close":
-    "??");
+#ifdef DEBUG_ESP_HTTP_SERVER
+
+  struct compare_s
+  {
+    uint8_t connected;
+    int available;
+    HTTPClientStatus status;
+    bool operator != (const compare_s& o)
+    {
+      return    o.connected != connected
+             || o.available != available
+             || o.status != status;
+    }
+  };
+  static compare_s last { false, 0, HC_NONE };
+  compare_s now { _currentClient.connected(), _currentClient.available(), _currentStatus };
+
+  if (last != now)
+  {
+    DBGWS("http-server loop: conn=%d avail=%d status=%s\n",
+      _currentClient.connected(), _currentClient.available(),
+      _currentStatus==HC_NONE?"none":
+      _currentStatus==HC_WAIT_READ?"wait-read":
+      _currentStatus==HC_WAIT_CLOSE?"wait-close":
+      "??");
+    last = now;
+  }
+
+#endif // DEBUG_ESP_HTTP_SERVER
 
   if (_currentClient.connected() || _currentClient.available()) {
     if (_currentClient.available() && _keepAlive) {

libraries/ESP8266WebServer/src/ESP8266WebServer-impl.h

@@ -1,5 +1,14 @@
 #include "SD.h"
 
+static_assert(__builtin_strcmp(SDClassFileMode(FILE_READ), "r") == 0, "");
+static_assert(__builtin_strcmp(SDClassFileMode(FILE_WRITE), "a+") == 0, "");
+
+static_assert(__builtin_strcmp(SDClassFileMode(O_RDONLY), "r") == 0, "");
+static_assert(__builtin_strcmp(SDClassFileMode(O_WRONLY), "w+") == 0, "");
+static_assert(__builtin_strcmp(SDClassFileMode(O_RDWR), "w+") == 0, "");
+static_assert(__builtin_strcmp(SDClassFileMode(O_WRONLY | O_APPEND), "a") == 0, "");
+static_assert(__builtin_strcmp(SDClassFileMode(O_RDWR | O_APPEND), "a+") == 0, "");
+
 #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SD)
 SDClass SD;
 #endif

libraries/SD/src/SD.cpp

@@ -24,11 +24,44 @@
 #include <FS.h>
 #include <SDFS.h>
 
+// Avoid type ambiguity, force u8 instead of untyped literal
+// ref. #6106 as to why we add APPEND to WRITE
+
+inline constexpr uint8_t SDClassFileRead { FILE_READ };
 #undef FILE_READ
-#define FILE_READ ((uint8_t)O_READ)
-#undef FILE_WRITE
-#define FILE_WRITE ((uint8_t)(O_READ | O_WRITE | O_CREAT | O_APPEND))
+#define FILE_READ SDClassFileRead
 
+inline constexpr uint8_t SDClassFileWrite { FILE_WRITE | O_APPEND };
+#undef FILE_WRITE
+#define FILE_WRITE SDClassFileWrite
+
+static inline constexpr const char* SDClassFileMode(uint8_t mode) {
+    bool read = false;
+    bool write = false;
+
+    switch (mode & O_ACCMODE) {
+    case O_RDONLY:
+        read = true;
+        break;
+    case O_WRONLY:
+        write = true;
+        break;
+    case O_RDWR:
+        read = true;
+        write = true;
+        break;
+    }
+
+    const bool append = (mode & O_APPEND) > 0;
+
+    if      (  read && !write )            { return "r";  }
+    else if ( !read &&  write && !append ) { return "w+"; }
+    else if ( !read &&  write &&  append ) { return "a";  }
+    else if (  read &&  write && !append ) { return "w+"; } // may be a bug in FS::mode interpretation, "r+" seems proper
+    else if (  read &&  write &&  append ) { return "a+"; }
+
+    return "r";
+}
 
 class SDClass {
 public:
@@ -45,7 +78,7 @@ class SDClass {
     }
 
     fs::File open(const char *filename, uint8_t mode = FILE_READ) {
-        return SDFS.open(filename, getMode(mode));
+        return SDFS.open(filename, SDClassFileMode(mode));
     }
 
     fs::File open(const char *filename, const char *mode) {
@@ -158,18 +191,6 @@ class SDClass {
     }
 
 private:
-    const char *getMode(uint8_t mode) {
-        bool read = (mode & O_READ) ? true : false;
-        bool write = (mode & O_WRITE) ? true : false;
-        bool append = (mode & O_APPEND) ? true : false;
-        if      (  read & !write )           { return "r";  }
-        else if ( !read &  write & !append ) { return "w+"; }
-        else if ( !read &  write &  append ) { return "a";  }
-        else if (  read &  write & !append ) { return "w+"; } // may be a bug in FS::mode interpretation, "r+" seems proper
-        else if (  read &  write &  append ) { return "a+"; }
-        else                                 { return "r";  }
-    }
-
     static time_t wrapperTimeCB(void) {
         extern void (*__SD__userDateTimeCB)(uint16_t*, uint16_t*);
         if (__SD__userDateTimeCB) {

libraries/SD/src/SD.h

@@ -115,14 +115,28 @@ void Ticker::_static_callback()
         }
     }
 
+    // it is technically allowed to call either schedule or detach
+    // *during* callback execution. allow both to happen
+    decltype(_callback) tmp;
+    std::swap(tmp, _callback);
+
     std::visit([](auto&& callback) {
         using T = std::decay_t<decltype(callback)>;
         if constexpr (std::is_same_v<T, callback_ptr_t>) {
             callback.func(callback.arg);
         } else if constexpr (std::is_same_v<T, callback_function_t>) {
             callback();
         }
-    }, _callback);
+    }, tmp);
+
+    // ...and move ourselves back only when object is in a valid state
+    // * ticker was not detached, zeroing timer pointer
+    // * nothing else replaced callback variant
+    if ((_timer == nullptr) || !std::holds_alternative<std::monostate>(_callback)) {
+        return;
+    }
+
+    std::swap(tmp, _callback);
 
     if (_repeat) {
         if (_tick) {

libraries/SoftwareSerial

@@ -128,7 +128,7 @@ void setup() {
 
   // Read previous resets (Deep Sleeps) from RTC memory, if any
   uint32_t crcOfData = crc32((uint8_t*)&nv->rtcData.rstCount, sizeof(nv->rtcData.rstCount));
-  if ((crcOfData = nv->rtcData.crc32) && (resetCause == "Deep-Sleep Wake")) {
+  if ((crcOfData == nv->rtcData.crc32) && (resetCause == "Deep-Sleep Wake")) {
     resetCount = nv->rtcData.rstCount;  // read the previous reset count
     resetCount++;
   }

libraries/Ticker/src/Ticker.cpp

@@ -76,18 +76,18 @@ compiler.cpreprocessor.flags=-D__ets__ -DICACHE_FLASH -U__STRICT_ANSI__ -D_GNU_S
 compiler.libraries.ldflags=
 
 compiler.c.cmd=xtensa-lx106-elf-gcc
-compiler.c.flags=-c "{compiler.warning_flags}-gcc" -std=gnu17 {build.stacksmash_flags} -Os -g -free -fipa-pta -Werror=return-type -Wpointer-arith -Wno-implicit-function-declaration -Wl,-EL -fno-inline-functions -nostdlib -mlongcalls -mtext-section-literals -falign-functions=4 -MMD -ffunction-sections -fdata-sections {build.exception_flags} {build.sslflags} {build.mmuflags} {build.non32xferflags}
+compiler.c.flags=-c "{compiler.warning_flags}-cflags" -std=gnu17 {build.stacksmash_flags} -Os -g -free -fipa-pta -Werror=return-type -Wpointer-arith -Wno-implicit-function-declaration -Wl,-EL -fno-inline-functions -nostdlib -mlongcalls -mtext-section-literals -falign-functions=4 -MMD -ffunction-sections -fdata-sections {build.exception_flags} {build.sslflags} {build.mmuflags} {build.non32xferflags}
 
 compiler.S.cmd=xtensa-lx106-elf-gcc
 compiler.S.flags=-c -g -x assembler-with-cpp -MMD -mlongcalls "-I{runtime.tools.xtensa-lx106-elf-gcc.path}/include/"
 
-compiler.c.elf.flags=-g "{compiler.warning_flags}-gcc" -Os -nostdlib -Wl,--no-check-sections -u app_entry {build.float} -Wl,-static "-L{compiler.sdk.path}/lib" "-L{compiler.sdk.path}/lib/{build.sdk}" "-L{build.path}" "-L{compiler.libc.path}/lib" "-Tlocal.eagle.flash.ld" -Wl,--gc-sections -Wl,-wrap,system_restart_local -Wl,-wrap,spi_flash_read
+compiler.c.elf.flags=-g "{compiler.warning_flags}-cflags" -Os -nostdlib -Wl,--no-check-sections -u app_entry {build.float} -Wl,-static "-L{compiler.sdk.path}/lib" "-L{compiler.sdk.path}/lib/{build.sdk}" "-L{build.path}" "-L{compiler.libc.path}/lib" "-Tlocal.eagle.flash.ld" -Wl,--gc-sections -Wl,-wrap,system_restart_local -Wl,-wrap,spi_flash_read
 
 compiler.c.elf.cmd=xtensa-lx106-elf-gcc
 compiler.c.elf.libs=-lhal -lphy -lpp -lnet80211 {build.lwip_lib} -lwpa -lcrypto -lmain -lwps -lbearssl -lespnow -lsmartconfig -lairkiss -lwpa2 {build.stdcpp_lib} -lm -lc -lgcc
 
 compiler.cpp.cmd=xtensa-lx106-elf-g++
-compiler.cpp.flags=-c "{compiler.warning_flags}-g++" {build.stacksmash_flags} -Os -g -free -fipa-pta -Werror=return-type -mlongcalls -mtext-section-literals -fno-rtti -falign-functions=4 {build.stdcpp_level} -MMD -ffunction-sections -fdata-sections {build.exception_flags} {build.sslflags} {build.mmuflags} {build.non32xferflags}
+compiler.cpp.flags=-c "{compiler.warning_flags}-cppflags" {build.stacksmash_flags} -Os -g -free -fipa-pta -Werror=return-type -mlongcalls -mtext-section-literals -fno-rtti -falign-functions=4 {build.stdcpp_level} -MMD -ffunction-sections -fdata-sections {build.exception_flags} {build.sslflags} {build.mmuflags} {build.non32xferflags}
 
 compiler.as.cmd=xtensa-lx106-elf-as