-
Notifications
You must be signed in to change notification settings - Fork 13.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Automatic stack location selection (SYS or HEAP), enable per library AR-chive in arduino build system #5018
Changes from 2 commits
1f88f28
60d3b4e
05b2aee
6ed54ee
6f7286e
12f412d
3259bbc
446220b
33db9a2
c64f994
cdba9b4
d38afda
67405c1
7c9d897
8ec3504
77b1b2d
28c9c22
eb18c5b
d08728a
8487455
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
/* | ||
* This is the original app_entry() not providing extra 4K heap, but allowing | ||
* the use of WPS. | ||
* | ||
* see comments in core_esp8266_main.cpp's app_entry() | ||
* | ||
*/ | ||
|
||
#include <c_types.h> | ||
#include "cont.h" | ||
#include "coredecls.h" | ||
|
||
// calls to this function must *always* be inlined | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. must never be inlined? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was meaning: |
||
void disable_extra4k_at_link_time (void) | ||
{ | ||
/* | ||
* does nothing | ||
* allows overriding the core_esp8266_main.cpp's app_entry() | ||
* by this one below, at link time | ||
* | ||
*/ | ||
} | ||
|
||
/* the following code is linked only if a call to the above function is made somewhere */ | ||
|
||
extern "C" void call_user_start(); | ||
|
||
/* this is the default NONOS-SDK user's heap location */ | ||
static cont_t g_cont __attribute__ ((aligned (16))); | ||
|
||
extern "C" void ICACHE_RAM_ATTR app_entry_redefinable(void) | ||
{ | ||
/* this is the default NONOS-SDK user's heap location */ | ||
g_pcont = &g_cont; | ||
|
||
/* Call the entry point of the SDK code. */ | ||
call_user_start(); | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -175,10 +175,15 @@ void init_done() { | |
|
||
WPS beeing flawed by its poor security, or not beeing used by lots of | ||
users, it has been decided that we are still going to use that memory for | ||
user's stack and disable the use of WPS, with an option to revert that | ||
back at the user's discretion. This selection can be done with the | ||
global define NO_EXTRA_4K_HEAP. An option has been added to the board | ||
generator script. | ||
user's stack and disable the use of WPS. | ||
|
||
app_entry() jumps to app_entry_custom() defined as "weakref" calling | ||
itself a weak customizable function, allowing to use another one when | ||
this is required (see core_esp8266_app_entry_noextra4k.cpp, used by WPS). | ||
|
||
(note: setting app_entry() itself as "weak" is not sufficient and always | ||
ends up with the other "noextra4k" one linked, maybe because it has a | ||
default value in linker scripts). | ||
|
||
References: | ||
https://github.com/esp8266/Arduino/pull/4553 | ||
|
@@ -188,31 +193,25 @@ void init_done() { | |
|
||
*/ | ||
|
||
#ifdef NO_EXTRA_4K_HEAP | ||
/* this is the default NONOS-SDK user's heap location */ | ||
cont_t g_cont __attribute__ ((aligned (16))); | ||
#endif | ||
|
||
extern "C" void ICACHE_RAM_ATTR app_entry(void) | ||
extern "C" void ICACHE_RAM_ATTR app_entry_redefinable(void) __attribute__((weak)); | ||
extern "C" void ICACHE_RAM_ATTR app_entry_redefinable(void) | ||
{ | ||
#ifdef NO_EXTRA_4K_HEAP | ||
|
||
/* this is the default NONOS-SDK user's heap location */ | ||
g_pcont = &g_cont; | ||
|
||
#else | ||
|
||
/* Allocate continuation context on this SYS stack, | ||
and save pointer to it. */ | ||
cont_t s_cont __attribute__((aligned(16))); | ||
g_pcont = &s_cont; | ||
|
||
#endif | ||
|
||
/* Call the entry point of the SDK code. */ | ||
call_user_start(); | ||
} | ||
|
||
static void ICACHE_RAM_ATTR app_entry_custom (void) __attribute__((weakref("app_entry_redefinable"))); | ||
|
||
extern "C" void ICACHE_RAM_ATTR app_entry (void) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we drop this extra call level? In this file, you define: extern "C" void ICACHE_RAM_ATTR app_entry_sysstack(void)
{
cont_t s_cont __attribute__((aligned(16)));
g_pcont = &s_cont;
call_user_start();
}
extern "C" void app_entry(void) __attribute__((weak, alias("app_entry_sysstack"))); In the other file, you define app_entry as a strong symbol: extern "C" void ICACHE_RAM_ATTR app_entry(void)
{
g_pcont = &g_cont;
call_user_start();
} I think it should work... There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I tried that, and just re-tried your way (weak+alias instead of weakref) and it still does not work, the strong one is always used. I don't know why for sure. I had put that comment just above about that.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, you are right. That's a side effect of specifying something as ENTRY, it also makes the symbol undefined, and the linker picks it up from core_esp8266_app_entry_noextra4k.cpp before it sees core_esp8266_main.cpp (probably due to alphabetical ordering when creating the archive file)... There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I tried again (after dot_a_linkage, just to be sure), still the same. The indirection is still needed. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No problem, that only cost us 16 bytes of the stack, which we can later remove by re-writing |
||
{ | ||
return app_entry_custom(); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can't we call app_entry_redefinable() directly here? or is that what is meant about the extra level of indirection in the comments above? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See comment above: tried that 3 times with different context with no luck. It is because (maybe)
|
||
} | ||
|
||
extern "C" void user_init(void) { | ||
struct rst_info *rtc_info_ptr = system_get_rst_info(); | ||
memcpy((void *) &resetInfo, (void *) rtc_info_ptr, sizeof(resetInfo)); | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -46,22 +46,26 @@ How can I get some extra KBs in flash ? | |
* Using ``*printf()`` with floats is enabled by default. Some KBs of flash can | ||
be saved by using the option ``--nofloat`` with the boards generator: | ||
|
||
``./tools/boards.txt.py --nofloat --allgen`` | ||
``./tools/boards.txt.py --nofloat --boardsgen`` | ||
|
||
* Use the debug level option ``NoAssert-NDEBUG`` (in the Tools menu) | ||
|
||
`Read more <a05-board-generator.rst>`__. | ||
|
||
Why can't I use WPS ? | ||
~~~~~~~~~~~~~~~~~~~~~ | ||
About WPS | ||
~~~~~~~~~ | ||
|
||
WPS is disabled by default, this offers an extra 4KB in ram/heap. To enable | ||
WPS (and lose 4KB of useable ram), use this boards generator option: | ||
In release 2.4.2 only, WPS is disabled by default. To enable WPS, use this | ||
boards generator option: | ||
|
||
``./tools/boards.txt.py --allowWPS --allgen`` | ||
``./tools/boards.txt.py --allowWPS --boardsgen`` | ||
|
||
`Read more <a05-board-generator.rst>`__. | ||
|
||
From release 2.4.2 and ahead, using WPS will reduce available heap space to | ||
user by around 4.5KB. In other words, from release 2.4.2 without using WPS, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Suggest rewording this to make it clear that this is not yet available in 2.4.2. E.g. "starting from 2.5.0, ...". |
||
an extra ~4.5KB is available in user's heap space. | ||
|
||
This Arduino library doesn't work on ESP. How do I make it work? | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. LGPL license missing |
||
#include "ESP8266WiFi.h" | ||
#include "ESP8266WiFiGeneric.h" | ||
#include "ESP8266WiFiSTA.h" | ||
|
||
void wifi_wps_status_cb(wps_cb_status status); | ||
|
||
/** | ||
* WPS config | ||
* so far only WPS_TYPE_PBC is supported (SDK 1.2.0) | ||
* @return ok | ||
*/ | ||
bool beginWPSConfig(void) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can keep this a member function of |
||
|
||
if(!WiFi.enableSTA(true)) { | ||
// enable STA failed | ||
return false; | ||
} | ||
|
||
WiFi.disconnect(); | ||
|
||
DEBUGV("wps begin\n"); | ||
|
||
if(!wifi_wps_disable()) { | ||
DEBUGV("wps disable failed\n"); | ||
return false; | ||
} | ||
|
||
// so far only WPS_TYPE_PBC is supported (SDK 1.2.0) | ||
if(!wifi_wps_enable(WPS_TYPE_PBC)) { | ||
DEBUGV("wps enable failed\n"); | ||
return false; | ||
} | ||
|
||
if(!wifi_set_wps_cb((wps_st_cb_t) &wifi_wps_status_cb)) { | ||
DEBUGV("wps cb failed\n"); | ||
return false; | ||
} | ||
|
||
if(!wifi_wps_start()) { | ||
DEBUGV("wps start failed\n"); | ||
return false; | ||
} | ||
|
||
esp_yield(); | ||
// will return here when wifi_wps_status_cb fires | ||
|
||
return true; | ||
} | ||
|
||
/** | ||
* WPS callback | ||
* @param status wps_cb_status | ||
*/ | ||
void wifi_wps_status_cb(wps_cb_status status) { | ||
DEBUGV("wps cb status: %d\r\n", status); | ||
switch(status) { | ||
case WPS_CB_ST_SUCCESS: | ||
if(!wifi_wps_disable()) { | ||
DEBUGV("wps disable failed\n"); | ||
} | ||
wifi_station_connect(); | ||
break; | ||
case WPS_CB_ST_FAILED: | ||
DEBUGV("wps FAILED\n"); | ||
break; | ||
case WPS_CB_ST_TIMEOUT: | ||
DEBUGV("wps TIMEOUT\n"); | ||
break; | ||
case WPS_CB_ST_WEP: | ||
DEBUGV("wps WEP\n"); | ||
break; | ||
case WPS_CB_ST_UNK: | ||
DEBUGV("wps UNKNOWN\n"); | ||
if(!wifi_wps_disable()) { | ||
DEBUGV("wps disable failed\n"); | ||
} | ||
break; | ||
} | ||
// TODO user function to get status | ||
|
||
esp_schedule(); // resume the beginWPSConfig function | ||
} | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,7 +27,9 @@ | |
#include "ESP8266WiFiType.h" | ||
#include "ESP8266WiFiGeneric.h" | ||
#include "user_interface.h" | ||
#include "coredecls.h" // disable_extra4k_at_link_time() | ||
|
||
extern bool beginWPSConfig(void); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why does this need to be a freestanding function? |
||
|
||
class ESP8266WiFiSTAClass { | ||
// ---------------------------------------------------------------------------------------------- | ||
|
@@ -93,13 +95,11 @@ class ESP8266WiFiSTAClass { | |
|
||
public: | ||
|
||
#ifdef NO_EXTRA_4K_HEAP | ||
bool beginWPSConfig(void); | ||
#else | ||
inline bool beginWPSConfig(void) __attribute__((always_inline)) { | ||
return WPS_is_unavailable_in_this_configuration__Please_check_FAQ_or_board_generator_tool(); | ||
inline bool beginWPSConfig(void) __attribute__((always_inline)) | ||
{ | ||
disable_extra4k_at_link_time(); // this call must always be inlined | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. as far as i can tell this can never be inlined, unless we enable LTO? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have updated the code/comment (yet to push) as follow:
When it is not inlined, or not optimized by gcc, or if There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Okay, i finally understood why you were mentioning inlining in other comments and why you needed to make it inline. This is because Arduino IDE does not combine object files from libraries into static archives, it links them directly. This is in contrast with the core object files, which are first placed into an archive. However, recent Arduino versions support putting library object files into .a archive before linking, which should remove the need for inlining. Please check https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5:-Library-specification and add There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It works with Things are now more clear, thanks for this tip. I was not understanding in the first place why I had to use the inline trick and was wrongly thinking that objects files were stored in a library. I admit I don't often try to read the long-like-hell IDE commands. But I had to cheat and create an empty archive edit: now trying to find the arduino environment variable for the AR object |
||
return ::beginWPSConfig(); | ||
} | ||
#endif | ||
|
||
bool beginSmartConfig(); | ||
bool stopSmartConfig(); | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1260,13 +1260,13 @@ bool WiFiClientSecure::loadPrivateKey(Stream& stream, size_t size) { | |
|
||
extern "C" { | ||
#include <cont.h> | ||
extern cont_t g_cont; | ||
extern cont_t *g_pcont; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. let's put this into coredecls.h as well |
||
extern size_t br_esp8266_stack_proxy_usage(); | ||
|
||
void _BearSSLCheckStack(const char *fcn, const char *file, int line) { | ||
static int cnt = 0; | ||
register uint32_t *sp asm("a1"); | ||
int freestack = 4 * (sp - g_cont.stack); | ||
int freestack = 4 * (sp - g_pcont->stack); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for keeping this updated. |
||
int freeheap = ESP.getFreeHeap(); | ||
static int laststack, lastheap, laststack2; | ||
if ((laststack != freestack) || (lastheap != freeheap) || (laststack2 != (int)br_esp8266_stack_proxy_usage())) { | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
__attribute__
seems to be needed only on definition, not on declaration. Details about placement into noinit section can live there as well.