Fix ESP8266 crash in logging macros due to __FUNCTION__ in flash #371
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 tasks
mathieucarbou
approved these changes
Jan 22, 2026
willmmiles
reviewed
Jan 22, 2026
|
|
||
| /** | ||
| * ESP8266 specific configurations | ||
| * Note: __FUNCTION__ is stored in flash on ESP8266, so we use FPSTR() to handle it properly |
There was a problem hiding this comment.
This comment doesn't reflect the code below anymore as __FUNCTION__ was removed.
| // error | ||
| #if ASYNCWEBSERVER_LOG_LEVEL >= ASYNC_WS_LOG_ERROR | ||
| #define async_ws_log_e(format, ...) ets_printf(String(F("E async_ws %s() %d: " format)).c_str(), __FUNCTION__, __LINE__, ##__VA_ARGS__); | ||
| #define async_ws_log_e(format, ...) Serial.printf_P(PSTR("E async_ws %d: " format "\n"), __LINE__, ##__VA_ARGS__) |
There was a problem hiding this comment.
Is it useful to print the line number without the function name? We'll be searching on the error text either way.
Member
There was a problem hiding this comment.
I saw that but agree with if because it quickly helps determine if the prints are in sync or not with the code we are reading. That's usually the first thing I look when users are giving some logs or stack... I first make sure the code they run is really the code they thunk they run.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
On ESP8266, the
__FUNCTION__macro returns a pointer to flash memory. The logging macros pass this directly toets_printfwith%s, which expects a RAM pointer. This causes a LoadStoreError (Exception 3) crash whenever anyasync_ws_log_*macro is invoked.Replace
ets_printfwithSerial.printf_PusingPSTR()for the format string, and remove__FUNCTION__since it cannot be safely used with printf on ESP8266.This bug has existed since the logging refactoring in commit e323ae1 (2025-09-10). Any ESP8266 code path that triggers a log message (e.g., queue overflow, allocation failure) would crash.