Changes on printing to comply with new understanding of SPI bus availability

from an ISR vs forground with INTLEVEL 15.

Author: mhightower83

cores/esp8266/heap.cpp

@@ -121,22 +121,39 @@ void* _calloc_r(struct _reent* unused, size_t count, size_t size)
 #undef calloc
 #undef realloc
 
-static const char oom_fmt[]   PROGMEM STORE_ATTR = ":oom(%d)@?\n";
-static const char oom_fmt_1[] PROGMEM STORE_ATTR = ":oom(%d)@";
-static const char oom_fmt_2[] PROGMEM STORE_ATTR = ":%d\n";
+#define DEBUG_HEAP_PRINTF ets_uart_printf
 
 void ICACHE_RAM_ATTR print_loc(size_t size, const char* file, int line)
 {
     (void)size;
     (void)line;
     if (system_get_os_print()) {
-        DBGLOG_FUNCTION_P(oom_fmt_1, (int)size);
-        DBGLOG_FUNCTION_P(file);
-        DBGLOG_FUNCTION_P(oom_fmt_2, line);
+        DEBUG_HEAP_PRINTF(":oom(%d)@", (int)size);
+
+        bool inISR = ETS_INTR_WITHINISR();
+        if (inISR && (uint32_t)file >= 0x40200000) {
+            DEBUG_HEAP_PRINTF("%p", file);
+        } else if (!inISR && (uint32_t)file >= 0x40200000) {
+            char buf[ets_strlen(file)] __attribute__ ((aligned(4)));
+            ets_strcpy(buf, file);
+            DEBUG_HEAP_PRINTF(buf);
+        } else {
+            DEBUG_HEAP_PRINTF(file);
+        }
+        
+        DEBUG_HEAP_PRINTF(":%d\n", line);
     }
 }
 
-#define OOM_CHECK__PRINT_OOM(p, f, s) if (!p && system_get_os_print()) DBGLOG_FUNCTION_P(f, s)
+void ICACHE_RAM_ATTR print_oom_size(size_t size)
+{
+    (void)size;
+    if (system_get_os_print()) {
+        DEBUG_HEAP_PRINTF(":oom(%d)@?\n", (int)size);
+    }
+}
+
+#define OOM_CHECK__PRINT_OOM(p, s) if (!p) print_oom_size(s)
 #define OOM_CHECK__PRINT_LOC(p, s, f, l) if (!p) print_loc(s, f, l)
 
 #else  // ! DEBUG_ESP_OOM
@@ -148,7 +165,7 @@ void ICACHE_RAM_ATTR print_loc(size_t size, const char* file, int line)
 #define PTR_CHECK__LOG_LAST_FAIL(p, s, a)
 #endif
 
-#define OOM_CHECK__PRINT_OOM(p, f, s)
+#define OOM_CHECK__PRINT_OOM(p, s)
 #define OOM_CHECK__PRINT_LOC(p, s, f, l)
 #endif
 
@@ -160,7 +177,7 @@ void* ICACHE_RAM_ATTR malloc(size_t size)
     POISON_CHECK__ABORT();
     void* ret = __umm_malloc(size);
     PTR_CHECK__LOG_LAST_FAIL(ret, size, __builtin_return_address(0));
-    OOM_CHECK__PRINT_OOM(ret, oom_fmt, (int)size);
+    OOM_CHECK__PRINT_OOM(ret, size);
     return ret;
 }
 
@@ -170,7 +187,7 @@ void* ICACHE_RAM_ATTR calloc(size_t count, size_t size)
     POISON_CHECK__ABORT();
     void* ret = __umm_calloc(count, size);
     PTR_CHECK__LOG_LAST_FAIL(ret, count * size, __builtin_return_address(0));
-    OOM_CHECK__PRINT_OOM(ret, oom_fmt, (int)size);
+    OOM_CHECK__PRINT_OOM(ret, size);
     return ret;
 }
 
@@ -180,7 +197,7 @@ void* ICACHE_RAM_ATTR realloc(void* ptr, size_t size)
     void* ret = __umm_realloc_fl(ptr, size, NULL, 0);
     POISON_CHECK__ABORT();
     PTR_CHECK__LOG_LAST_FAIL(ret, size, __builtin_return_address(0));
-    OOM_CHECK__PRINT_OOM(ret, oom_fmt, (int)size);
+    OOM_CHECK__PRINT_OOM(ret, size);
     return ret;
 }
 
@@ -247,9 +264,6 @@ size_t ICACHE_RAM_ATTR xPortWantedSizeAlign(size_t size)
 
 void system_show_malloc(void)
 {
-#if !defined(UMM_INFO_PRINT)
-    ::printf(PSTR("\nTo use \"system_show_malloc()\", you need to build with the \"-DUMM_INFO_PRINT\" option.\n"));
-#endif
     umm_info(NULL, 1);
 }
 

cores/esp8266/umm_malloc/isr_safe_printf.cpp

@@ -13,10 +13,14 @@
 #include "umm_malloc_cfg.h"
 extern "C" {
 
-#if defined(DEBUG_ESP_ISR)
+#if 0 //defined(DEBUG_ESP_ISR)
 
 int _isr_safe_printf_P(const char *fmt, ...) __attribute__((format(printf, 1, 2)));
 int ICACHE_RAM_ATTR _isr_safe_printf_P(const char *fmt, ...) {
+    if (ETS_INTR_WITHINISR() && (uint32_t)fmt >= 0x40200000) {
+        ets_uart_printf("\nCannot print flash string, %p, from ISR\n", fmt);
+        return 0;
+    }
     /*
       To use ets_strlen() and ets_memcpy() safely with PROGMEM, flash storage,
       the PROGMEM address must be word (4 bytes) aligned. The destination

cores/esp8266/umm_malloc/isr_safe_printf.h

@@ -8,6 +8,7 @@
 extern "C" {
 #endif
 
+#if 0
 /*
   ISR Safe to call for debugging. Not really safe to use all the time. The
   problem is going over 10us with interrupts disabled. It takes 86.8us to send
@@ -18,6 +19,7 @@ int _isr_safe_printf_P(const char *fmt, ...) __attribute__((format(printf, 1, 2)
 // PROGMEM. Only the 1st parameter, fmt, is supported in PROGMEM.
 #define ISR_PRINTF(fmt, ...) _isr_safe_printf_P(PSTR(fmt), ##__VA_ARGS__)
 #define ISR_PRINTF_P(fmt, ...) _isr_safe_printf_P(fmt, ##__VA_ARGS__)
+#endif
 
 #ifdef __cplusplus
 }

cores/esp8266/umm_malloc/umm_local.c

@@ -194,6 +194,22 @@ void print_stats(int force) {
 #endif
 
 
+
+int ICACHE_FLASH_ATTR umm_info_safe_printf_P(const char *fmt, ...) {
+    /*
+      To use ets_strlen() and ets_strcpy() safely with PROGMEM, flash storage,
+      the PROGMEM address must be word (4 bytes) aligned. The destination
+      address for ets_memcpy must also be word-aligned.
+    */
+    char ram_buf[ets_strlen(fmt)] __attribute__ ((aligned(4)));
+    ets_strcpy(ram_buf, fmt);
+    va_list argPtr;
+    va_start(argPtr, fmt);
+    int result = ets_vprintf(ets_uart_putc1, ram_buf, argPtr);
+    va_end(argPtr);
+    return result;
+}
+
 #endif // BUILD_UMM_MALLOC_C
 
 

cores/esp8266/umm_malloc/umm_local.h

@@ -3,6 +3,7 @@
 /*
  * A home for local items exclusive to umm_malloc.c and not to be shared in
  * umm_malloc_cfg.h. And, not for upstream version.
+ * Also used to redefine defines made in upstream files we donet want to edit.
  *
  */
 
@@ -13,13 +14,17 @@
 #define memmove ets_memmove
 #define memset ets_memset
 
-#if !defined(UMM_INFO_PRINT)
-/* This will stop umm_info from printing.
- * At this time DBGLOG_FORCE is only used by umm_info.
+
+/* 
+ * This redefines DBGLOG_FORCE defined in dbglog/dbglog.h
+ * Just for printing from umm_info() which is assumed to always be called from
+ * non-ISR. Thus SPI bus is available to handle cache-miss and reading a flash
+ * string while INTLEVEL is non-zero.
  */
 #undef DBGLOG_FORCE
-#define DBGLOG_FORCE(force, format, ...) {(void)force; (void)format;}
-#endif
+#define DBGLOG_FORCE(force, format, ...) {if(force) {UMM_INFO_PRINTF(format, ## __VA_ARGS__);}}
+// #define DBGLOG_FORCE(force, format, ...) {if(force) {::printf(PSTR(format), ## __VA_ARGS__);}}
+
 
 #if defined(DEBUG_ESP_OOM) || defined(UMM_POISON_CHECK) || defined(UMM_POISON_CHECK_LITE) || defined(UMM_INTEGRITY_CHECK)
 #else
@@ -30,12 +35,20 @@
 #define umm_free(p)      free(p)
 #endif
 
+
 #if defined(UMM_POISON_CHECK_LITE)
 static int check_poison_neighbors( unsigned short cur );
 #endif
 
+
 #if defined(UMM_STATS) || defined(UMM_STATS_FULL)
 void ICACHE_FLASH_ATTR print_stats(int force);
 #endif
 
+
+
+int ICACHE_FLASH_ATTR umm_info_safe_printf_P(const char *fmt, ...) __attribute__((format(printf, 1, 2)));
+#define UMM_INFO_PRINTF(fmt, ...) umm_info_safe_printf_P(PSTR(fmt), ##__VA_ARGS__)
+
+
 #endif

cores/esp8266/umm_malloc/umm_malloc_cfg.h

@@ -10,7 +10,7 @@
 
 #include <debug.h>
 #include <pgmspace.h>
-#include "isr_safe_printf.h"
+#include <esp8266_undocumented.h>
 
 #ifdef __cplusplus
 extern "C" {
@@ -113,25 +113,6 @@ extern char _heap_start[];
 #else
 #endif
 
-/*
- * -D UMM_INFO_PRINT
- *
- * umm_info(NULL, true) is used to print a debug view of heap information to the
- * debug port. It has to walk the heap and print out information while in a
- * critical section. This requires that the print function be able to print w/o
- * doing malloc calls and from an IRQ disabled context. This requires extra IRAM
- * based code for printing. Without this define `umm_info(NULL, true)` will
- * not print.
- *
- * UMM_INFO_PRINT is enabled as part of selecting `Debug port: "Serial" or
- * "Serial1"`. To make available all the time use '-D UMM_INFO_PRINT`.
- *
- * Status: Local Enhancement - addresses platform specific issue.
- */
-#if defined(DEBUG_ESP_PORT) && !defined(UMM_INFO_PRINT) && defined(UMM_INFO)
-#define UMM_INFO_PRINT
-#endif
-
 /*
  * -D UMM_STATS :
  * -D UMM_STATS_FULL
@@ -587,20 +568,10 @@ static inline void _critical_exit(UMM_TIME_STAT *p, uint32_t *saved_ps) {
 
 #if defined(DEBUG_ESP_PORT) || defined(DEBUG_ESP_OOM) || \
     defined(UMM_POISON_CHECK) || defined(UMM_POISON_CHECK_LITE) || \
-    defined(UMM_INFO_PRINT) || defined(UMM_INTEGRITY_CHECK)
-
-#ifndef DEBUG_ESP_ISR
-#define DEBUG_ESP_ISR
-#endif
-
-// Note, ISR_PRINTF_P will not handle additional string arguments in
-// PROGMEM. Only the 1st parameter, fmt, is supported in PROGMEM.
-#define DBGLOG_FUNCTION(fmt, ...) ISR_PRINTF(fmt, ##__VA_ARGS__)
-#define DBGLOG_FUNCTION_P(fmt, ...) ISR_PRINTF_P(fmt, ##__VA_ARGS__)
-
+    defined(UMM_INTEGRITY_CHECK)
+#define DBGLOG_FUNCTION(fmt, ...) ets_uart_printf(fmt, ##__VA_ARGS__)
 #else
 #define DBGLOG_FUNCTION(fmt, ...)   do { (void)fmt; } while(false)
-#define DBGLOG_FUNCTION_P(fmt, ...) do { (void)fmt; } while(false)
 #endif
 
 /////////////////////////////////////////////////