FuriThread: Improve state callbacks (#3881)

State callbacks assumed they were invoked from the thread that changed
its state, but this wasn't true for FuriThreadStateStarting in the past,
and now it's not true for FuriThreadStateStopped either.

Now it is safe to release the thread memory form the state callback
once it switches to FuriThreadStateStopped. Therefore, pending deletion
calls can be removed.

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
This commit is contained in:
Silent
2024-10-08 21:50:31 +02:00
committed by GitHub
parent 369e19def3
commit 5b36c5465d
8 changed files with 60 additions and 68 deletions

View File

@@ -33,7 +33,7 @@ struct FuriThread {
StaticTask_t container;
StackType_t* stack_buffer;
FuriThreadState state;
volatile FuriThreadState state;
int32_t ret;
FuriThreadCallback callback;
@@ -59,7 +59,6 @@ struct FuriThread {
// this ensures that the size of this structure is minimal
bool is_service;
bool heap_trace_enabled;
volatile bool is_active;
};
// IMPORTANT: container MUST be the FIRST struct member
@@ -84,7 +83,7 @@ static void furi_thread_set_state(FuriThread* thread, FuriThreadState state) {
furi_assert(thread);
thread->state = state;
if(thread->state_callback) {
thread->state_callback(state, thread->state_context);
thread->state_callback(thread, state, thread->state_context);
}
}
@@ -124,7 +123,7 @@ static void furi_thread_body(void* context) {
// flush stdout
__furi_thread_stdout_flush(thread);
furi_thread_set_state(thread, FuriThreadStateStopped);
furi_thread_set_state(thread, FuriThreadStateStopping);
vTaskDelete(NULL);
furi_thread_catch();
@@ -207,7 +206,6 @@ void furi_thread_free(FuriThread* thread) {
furi_check(thread->is_service == false);
// Cannot free a non-joined thread
furi_check(thread->state == FuriThreadStateStopped);
furi_check(!thread->is_active);
furi_thread_set_name(thread, NULL);
furi_thread_set_appid(thread, NULL);
@@ -349,8 +347,6 @@ void furi_thread_start(FuriThread* thread) {
uint32_t stack_depth = thread->stack_size / sizeof(StackType_t);
thread->is_active = true;
furi_check(
xTaskCreateStatic(
furi_thread_body,
@@ -368,7 +364,7 @@ void furi_thread_cleanup_tcb_event(TaskHandle_t task) {
// clear thread local storage
vTaskSetThreadLocalStoragePointer(task, 0, NULL);
furi_check(thread == (FuriThread*)task);
thread->is_active = false;
furi_thread_set_state(thread, FuriThreadStateStopped);
}
}
@@ -383,8 +379,8 @@ bool furi_thread_join(FuriThread* thread) {
//
// If your thread exited, but your app stuck here: some other thread uses
// all cpu time, which delays kernel from releasing task handle
while(thread->is_active) {
furi_delay_ms(10);
while(thread->state != FuriThreadStateStopped) {
furi_delay_tick(2);
}
return true;

View File

@@ -21,7 +21,8 @@ extern "C" {
* Many of the FuriThread functions MUST ONLY be called when the thread is STOPPED.
*/
typedef enum {
FuriThreadStateStopped, /**< Thread is stopped */
FuriThreadStateStopped, /**< Thread is stopped and is safe to release */
FuriThreadStateStopping, /**< Thread is stopping */
FuriThreadStateStarting, /**< Thread is starting */
FuriThreadStateRunning, /**< Thread is running */
} FuriThreadState;
@@ -80,10 +81,11 @@ typedef void (*FuriThreadStdoutWriteCallback)(const char* data, size_t size);
*
* The function to be used as a state callback MUST follow this signature.
*
* @param[in] pointer to the FuriThread instance that changed the state
* @param[in] state identifier of the state the thread has transitioned to
* @param[in,out] context pointer to a user-specified object
*/
typedef void (*FuriThreadStateCallback)(FuriThreadState state, void* context);
typedef void (*FuriThreadStateCallback)(FuriThread* thread, FuriThreadState state, void* context);
/**
* @brief Signal handler callback function pointer type.