Skip to content

Adds support to change LoopTask Stack size #6025

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

Merged
merged 5 commits into from
Dec 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions cores/esp32/Arduino.h
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,9 @@ uint16_t makeWord(uint8_t h, uint8_t l);

#define word(...) makeWord(__VA_ARGS__)

size_t getArduinoLoopTaskStackSize(void);
#define SET_LOOP_TASK_STACK_SIZE(sz) size_t getArduinoLoopTaskStackSize() { return sz;}

unsigned long pulseIn(uint8_t pin, uint8_t state, unsigned long timeout = 1000000L);
unsigned long pulseInLong(uint8_t pin, uint8_t state, unsigned long timeout = 1000000L);

Expand Down
6 changes: 5 additions & 1 deletion cores/esp32/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ void yieldIfNecessary(void){

bool loopTaskWDTEnabled;

__attribute__((weak)) size_t getArduinoLoopTaskStackSize(void) {
return ARDUINO_LOOP_STACK_SIZE;
}

void loopTask(void *pvParameters)
{
setup();
Expand Down Expand Up @@ -64,7 +68,7 @@ extern "C" void app_main()
#endif
loopTaskWDTEnabled = false;
initArduino();
xTaskCreateUniversal(loopTask, "loopTask", ARDUINO_LOOP_STACK_SIZE, NULL, 1, &loopTaskHandle, ARDUINO_RUNNING_CORE);
xTaskCreateUniversal(loopTask, "loopTask", getArduinoLoopTaskStackSize(), NULL, 1, &loopTaskHandle, ARDUINO_RUNNING_CORE);
}

#endif
36 changes: 36 additions & 0 deletions libraries/ESP32/examples/ArduinoStackSize/ArduinoStackSize.ino
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
ESP32 Arduino creates a task to run setup() and then to execute loop() continuously
This task can be found at https://github.com/espressif/arduino-esp32/blob/master/cores/esp32/main.cpp

By default "loopTask" will be created with a stack size of 8KB.
This should be plenty for most general sketches.

There is a way to change the stack size of this task by using
SET_LOOP_TASK_STACK_SIZE(size);
It will bypass the default stack size of 8KB and allow the user to define a new size.

It is recommend this value to be higher than 8KB, for instance 16KB.
This increasing may be necessary for the sketches that use deep recursion for instance.

In this example, you can verify it by changing or just commenting out SET_LOOP_TASK_STACK_SIZE();
*/


// This sets Arduino Stack Size - comment this line to use default 8K stack size
SET_LOOP_TASK_STACK_SIZE(16*1024); // 16KB

void setup() {
Serial.begin(115200);

Serial.printf("Arduino Stack was set to %d bytes", getArduinoLoopTaskStackSize());

// Print unused stack for the task that is running setup()
Serial.printf("\nSetup() - Free Stack Space: %d", uxTaskGetStackHighWaterMark(NULL));
}

void loop() {
delay(1000);

// Print unused stack for the task that is running loop() - the same as for setup()
Serial.printf("\nLoop() - Free Stack Space: %d", uxTaskGetStackHighWaterMark(NULL));
}