Merge branch 'master' into dynamic_sd_cache

Author: devyte

.gitignore

@@ -19,3 +19,4 @@ boards.local.txt
 *.gcno
 *.gcda
 *.o
+*.a

boards.txt

@@ -34,8 +34,13 @@
 /* default implementation: may be overridden */
 size_t Print::write(const uint8_t *buffer, size_t size) {
     size_t n = 0;
-    while(size--) {
-        n += write(*buffer++);
+    while (size--) {
+        size_t ret = write(*buffer++);
+        if (ret == 0) {
+            // Write of last byte didn't complete, abort additional processing
+            break;
+        }
+        n += ret;
     }
     return n;
 }

cores/esp8266/Print.cpp

@@ -24,14 +24,28 @@
 
 using __cxxabiv1::__guard;
 
+// Debugging helper, last allocation which returned NULL
+extern void *umm_last_fail_alloc_addr;
+extern int umm_last_fail_alloc_size;
+
 void *operator new(size_t size)
 {
-    return malloc(size);
+    void *ret = malloc(size);
+    if (0 != size && 0 == ret) {
+        umm_last_fail_alloc_addr = __builtin_return_address(0);
+        umm_last_fail_alloc_size = size;
+    }
+    return ret;
 }
 
 void *operator new[](size_t size)
 {
-    return malloc(size);
+    void *ret = malloc(size);
+    if (0 != size && 0 == ret) {
+        umm_last_fail_alloc_addr = __builtin_return_address(0);
+        umm_last_fail_alloc_size = size;
+    }
+    return ret;
 }
 
 void operator delete(void * ptr)

cores/esp8266/abi.cpp

@@ -56,6 +56,7 @@ static uint32_t *i2s_slc_buf_pntr[SLC_BUF_CNT]; //Pointer to the I2S DMA buffer
 static struct slc_queue_item i2s_slc_items[SLC_BUF_CNT]; //I2S DMA buffer descriptors
 static uint32_t *i2s_curr_slc_buf=NULL;//current buffer for writing
 static int i2s_curr_slc_buf_pos=0; //position in the current buffer
+static void (*i2s_callback) (void)=0; //Callback function should be defined as 'void ICACHE_FLASH_ATTR function_name()', placing the function in IRAM for faster execution. Avoid long computational tasks in this function, use it to set flags and process later.
 
 bool ICACHE_FLASH_ATTR i2s_is_full(){
   return (i2s_curr_slc_buf_pos==SLC_BUF_LEN || i2s_curr_slc_buf==NULL) && (i2s_slc_queue_len == 0);
@@ -92,10 +93,15 @@ void ICACHE_FLASH_ATTR i2s_slc_isr(void) {
       i2s_slc_queue_next_item(); //free space for finished_item
     }
     i2s_slc_queue[i2s_slc_queue_len++] = finished_item->buf_ptr;
+    if (i2s_callback) i2s_callback();
     ETS_SLC_INTR_ENABLE();
   }
 }
 
+void i2s_set_callback(void (*callback) (void)){
+    i2s_callback = callback;
+}
+
 void ICACHE_FLASH_ATTR i2s_slc_begin(){
   i2s_slc_queue_len = 0;
   int x, y;
@@ -248,7 +254,6 @@ float ICACHE_FLASH_ATTR i2s_get_real_rate(){
   return (float)I2SBASEFREQ/32/((I2SC>>I2SBD) & I2SBDM)/((I2SC >> I2SCD) & I2SCDM);
 }
 
-
 void ICACHE_FLASH_ATTR i2s_begin(){
   _i2s_sample_rate = 0;
   i2s_slc_begin();

cores/esp8266/core_esp8266_i2s.c

@@ -33,6 +33,7 @@ extern "C" {
 #include "cont.h"
 }
 #include <core_version.h>
+#include "gdb_hooks.h"
 
 #define LOOP_TASK_PRIORITY 1
 #define LOOP_QUEUE_SIZE    1
@@ -137,12 +138,6 @@ static void do_global_ctors(void) {
         (*--p)();
 }
 
-extern "C" void __gdb_init() {}
-extern "C" void gdb_init(void) __attribute__ ((weak, alias("__gdb_init")));
-
-extern "C" void __gdb_do_break(){}
-extern "C" void gdb_do_break(void) __attribute__ ((weak, alias("__gdb_do_break")));
-
 void init_done() {
     system_set_os_print(1);
     gdb_init();

cores/esp8266/core_esp8266_main.cpp

@@ -28,26 +28,31 @@
 #include "esp8266_peri.h"
 #include "cont.h"
 #include "pgmspace.h"
+#include "gdb_hooks.h"
 
 extern void __real_system_restart_local();
-extern void gdb_do_break();
 
 extern cont_t g_cont;
 
 // These will be pointers to PROGMEM const strings
 static const char* s_panic_file = 0;
 static int s_panic_line = 0;
 static const char* s_panic_func = 0;
+static const char* s_panic_what = 0;
 
 static bool s_abort_called = false;
 
-void uart_write_char_d(char c);
+void abort() __attribute__((noreturn));
+static void uart_write_char_d(char c);
 static void uart0_write_char_d(char c);
 static void uart1_write_char_d(char c);
 static void print_stack(uint32_t start, uint32_t end);
-//static void print_pcs(uint32_t start, uint32_t end);
 
-bool __attribute((weak)) crash_for_gdb = 0;
+// From UMM, the last caller of a malloc/realloc/calloc which failed:
+extern void *umm_last_fail_alloc_addr;
+extern int umm_last_fail_alloc_size;
+
+static void raise_exception() __attribute__((noreturn));
 
 extern void __custom_crash_callback( struct rst_info * rst_info, uint32_t stack, uint32_t stack_end ) {
     (void) rst_info;
@@ -57,18 +62,42 @@ extern void __custom_crash_callback( struct rst_info * rst_info, uint32_t stack,
 
 extern void custom_crash_callback( struct rst_info * rst_info, uint32_t stack, uint32_t stack_end ) __attribute__ ((weak, alias("__custom_crash_callback")));
 
-static void ets_puts_P(const char *romString) {
-    char c = pgm_read_byte(romString++);
-    while (c) {
-        ets_putc(c);
-        c = pgm_read_byte(romString++);
-    }
+// Single, non-inlined copy of pgm_read_byte to save IRAM space (as this is not timing critical)
+static char ICACHE_RAM_ATTR iram_read_byte (const char *addr) {
+    return pgm_read_byte(addr);
+}
+
+// Required to output the s_panic_file, it's stored in PMEM
+#define ets_puts_P(pstr) \
+{ \
+    char c; \
+    do { \
+        c = iram_read_byte(pstr++); \
+        if (c) ets_putc(c); \
+    } while (c); \
+}
+
+// Place these strings in .text because the SPI interface may be in bad shape during an exception.
+#define ets_printf_P(str, ...) \
+{ \
+    static const char istr[] ICACHE_RAM_ATTR = (str); \
+    char mstr[sizeof(str)]; \
+    for (size_t i=0; i < sizeof(str); i++) mstr[i] = iram_read_byte(&istr[i]); \
+    ets_printf(mstr, ##__VA_ARGS__); \
 }
 
 void __wrap_system_restart_local() {
-    if (crash_for_gdb) *((int*)0) = 0;
     register uint32_t sp asm("a1");
 
+    if (gdb_present()) {
+        /* When GDBStub is present, exceptions are handled by GDBStub,
+           but Soft WDT will still call this function.
+           Trigger an exception to break into GDB.
+           TODO: check why gdb_do_break() or asm("break.n 0") do not
+           break into GDB here. */
+        raise_exception();
+    }
+
     struct rst_info rst_info = {0};
     system_rtc_mem_read(0, &rst_info, sizeof(rst_info));
     if (rst_info.reason != REASON_SOFT_WDT_RST &&
@@ -81,21 +110,25 @@ void __wrap_system_restart_local() {
     ets_install_putc1(&uart_write_char_d);
 
     if (s_panic_line) {
-        ets_puts_P(PSTR("\nPanic "));
-        ets_puts_P(s_panic_file);
-        ets_printf(":%d ", s_panic_line);
-        ets_puts_P(s_panic_func);
-        ets_puts_P(PSTR("\n"));
+        ets_printf_P("\nPanic ");
+        ets_puts_P(s_panic_file); // This is in PROGMEM, need special output because ets_printf can't handle ROM parameters
+        ets_printf_P(":%d %s", s_panic_line, s_panic_func);
+        if (s_panic_what) {
+            ets_printf_P(": Assertion '");
+            ets_puts_P(s_panic_what); // This is also in PMEM
+            ets_printf_P("' failed.");
+        }
+        ets_putc('\n');
     }
     else if (s_abort_called) {
-        ets_puts_P(PSTR("Abort called\n"));
+        ets_printf_P("\nAbort called\n");
     }
     else if (rst_info.reason == REASON_EXCEPTION_RST) {
-        ets_printf("\nException (%d):\nepc1=0x%08x epc2=0x%08x epc3=0x%08x excvaddr=0x%08x depc=0x%08x\n",
+        ets_printf_P("\nException (%d):\nepc1=0x%08x epc2=0x%08x epc3=0x%08x excvaddr=0x%08x depc=0x%08x\n",
             rst_info.exccause, rst_info.epc1, rst_info.epc2, rst_info.epc3, rst_info.excvaddr, rst_info.depc);
     }
     else if (rst_info.reason == REASON_SOFT_WDT_RST) {
-        ets_puts_P(PSTR("\nSoft WDT reset\n"));
+        ets_printf_P("\nSoft WDT reset\n");
     }
 
     uint32_t cont_stack_start = (uint32_t) &(g_cont.stack);
@@ -117,60 +150,47 @@ void __wrap_system_restart_local() {
     }
 
     if (sp > cont_stack_start && sp < cont_stack_end) {
-        ets_puts_P(PSTR("\nctx: cont \n"));
+        ets_printf_P("\nctx: cont \n");
         stack_end = cont_stack_end;
     }
     else {
-        ets_puts_P(("\nctx: sys \n"));
+        ets_printf_P("\nctx: sys \n");
         stack_end = 0x3fffffb0;
         // it's actually 0x3ffffff0, but the stuff below ets_run
         // is likely not really relevant to the crash
     }
 
-    ets_printf("sp: %08x end: %08x offset: %04x\n", sp, stack_end, offset);
+    ets_printf_P("sp: %08x end: %08x offset: %04x\n", sp, stack_end, offset);
 
-    // print_pcs(sp + offset, stack_end);
     print_stack(sp + offset, stack_end);
 
+    // Use cap-X formatting to ensure the standard EspExceptionDecoder doesn't match the address
+    if (umm_last_fail_alloc_addr) {
+      ets_printf("\nlast failed alloc call: %08X(%d)\n", (uint32_t)umm_last_fail_alloc_addr, umm_last_fail_alloc_size);
+    }
+
     custom_crash_callback( &rst_info, sp + offset, stack_end );
 
     delayMicroseconds(10000);
     __real_system_restart_local();
 }
 
 
-static void print_stack(uint32_t start, uint32_t end) {
-    ets_puts_P(PSTR("\n>>>stack>>>\n"));
+static void ICACHE_RAM_ATTR print_stack(uint32_t start, uint32_t end) {
+    ets_printf_P("\n>>>stack>>>\n");
     for (uint32_t pos = start; pos < end; pos += 0x10) {
         uint32_t* values = (uint32_t*)(pos);
 
         // rough indicator: stack frames usually have SP saved as the second word
         bool looksLikeStackFrame = (values[2] == pos + 0x10);
 
-        ets_printf("%08x:  %08x %08x %08x %08x %c\n",
+        ets_printf_P("%08x:  %08x %08x %08x %08x %c\n",
             pos, values[0], values[1], values[2], values[3], (looksLikeStackFrame)?'<':' ');
     }
-    ets_puts_P(PSTR("<<<stack<<<\n"));
+    ets_printf_P("<<<stack<<<\n");
 }
 
-/*
-static void print_pcs(uint32_t start, uint32_t end) {
-    uint32_t n = 0;
-    ets_printf("\n>>>pc>>>\n");
-    for (uint32_t pos = start; pos < end; pos += 16, ++n) {
-        uint32_t* sf = (uint32_t*) pos;
-
-        uint32_t pc_ret = sf[3];
-        uint32_t sp_ret = sf[2];
-        if (pc_ret < 0x40000000 || pc_ret > 0x40f00000 || sp_ret != pos + 16)
-            continue;
-        ets_printf("%08x\n", pc_ret);
-    }
-    ets_printf("<<<pc<<<\n");
-}
-*/
-
-void uart_write_char_d(char c) {
+static void uart_write_char_d(char c) {
     uart0_write_char_d(c);
     uart1_write_char_d(c);
 }
@@ -192,29 +212,32 @@ static void uart1_write_char_d(char c) {
     }
     USF(1) = c;
 }
-void abort() __attribute__((noreturn));
 
-void abort(){
-    // cause exception
+static void raise_exception() {
+    __asm__ __volatile__ ("syscall");
+    while (1); // never reached, needed to satisfy "noreturn" attribute
+}
+
+void abort() {
     s_abort_called = true;
-    do {
-        *((int*)0) = 0;
-    } while(true);
+    raise_exception();
 }
 
 void __assert_func(const char *file, int line, const char *func, const char *what) {
-    (void) what;
     s_panic_file = file;
     s_panic_line = line;
     s_panic_func = func;
-    gdb_do_break();
+    s_panic_what = what;
+    gdb_do_break();     /* if GDB is not present, this is a no-op */
+    raise_exception();
 }
 
 void __panic_func(const char* file, int line, const char* func) {
     s_panic_file = file;
     s_panic_line = line;
     s_panic_func = func;
-    gdb_do_break();
-    abort();
+    s_panic_what = 0;
+    gdb_do_break();     /* if GDB is not present, this is a no-op */
+    raise_exception();
 }