alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'feature/add_ot_ts_lock_check' into 'master'

Browse Source 
feat(openthread): add task switching lock holder check

See merge request espressif/esp-idf!31002
This commit is contained in:
Shu Chen 2024-07-22 16:44:23 +08:00
commit e42b95d3d4
2 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
components/openthread/include/esp_openthread_lock.h
View File

@ -1,5 +1,5 @@
/* /*
* SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD * SPDX-FileCopyrightText: 2021-2024 Espressif Systems (Shanghai) CO LTD
* *
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */
@ -35,10 +35,10 @@ void esp_openthread_lock_deinit(void);
/** /**
* @brief This function acquires the OpenThread API lock. * @brief This function acquires the OpenThread API lock.
* *
* @note Every OT APIs that takes an otInstance argument MUST be protected with this API lock * @note Every Openthread APIs that takes an otInstance argument MUST be protected with this API lock
* except that the call site is in OT callbacks. * except that the call site is in Openthread callbacks.
* *
* @param[in] block_ticks The maxinum number of RTOS ticks to wait for the lock. * @param[in] block_ticks The maximum number of RTOS ticks to wait for the lock.
* *
* @return * @return
* - True on lock acquired * - True on lock acquired
@ -63,7 +63,7 @@ void esp_openthread_lock_release(void);
* *
* @note Please use esp_openthread_lock_acquire() for normal cases. * @note Please use esp_openthread_lock_acquire() for normal cases.
* *
* @param[in] block_ticks The maxinum number of RTOS ticks to wait for the lock. * @param[in] block_ticks The maximum number of RTOS ticks to wait for the lock.
* *
* @return * @return
* - True on lock acquired * - True on lock acquired
@ -75,6 +75,9 @@ bool esp_openthread_task_switching_lock_acquire(TickType_t block_ticks);
/** /**
* @brief This function releases the OpenThread API task switching lock. * @brief This function releases the OpenThread API task switching lock.
* *
* @note This API must be called after `esp_openthread_task_switching_lock_acquire` or
* `esp_openthread_lock_acquire` and will cause a crash if the current task is not the task switching lock holder.
* This error could be caused by calling OpenThread APIs without locking OpenThread stack.
*/ */
void esp_openthread_task_switching_lock_release(void); void esp_openthread_task_switching_lock_release(void);

7
components/openthread/src/esp_openthread_lock.c
View File

@ -1,5 +1,5 @@
/* /*
* SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD * SPDX-FileCopyrightText: 2021-2024 Espressif Systems (Shanghai) CO LTD
* *
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */
@ -45,6 +45,11 @@ void esp_openthread_task_switching_lock_release(void)
{ {
ESP_RETURN_ON_FALSE(s_openthread_task_mutex, , OT_PLAT_LOG_TAG, ESP_RETURN_ON_FALSE(s_openthread_task_mutex, , OT_PLAT_LOG_TAG,
"Failed to release the lock because the mutex is not ready"); "Failed to release the lock because the mutex is not ready");
if (xSemaphoreGetMutexHolder(s_openthread_task_mutex) != xTaskGetCurrentTaskHandle()) {
ESP_LOGE(OT_PLAT_LOG_TAG, "Task %s is attempting to release the OpenThread task switching lock but never acquired it.",
pcTaskGetName(xTaskGetCurrentTaskHandle()));
assert(false);
}
xSemaphoreGiveRecursive(s_openthread_task_mutex); xSemaphoreGiveRecursive(s_openthread_task_mutex);
} }