mirror of
https://github.com/espressif/esp-idf
synced 2025-03-10 17:49:10 -04:00
5b817038a0
`vTaskGetSnapshot` is being used in coredump module to collect diagnostic information. It is possible that input arguments are invalid and `assert` in this situation is not correct. This commit modifies API signature to return pdTRUE in case of success, and pdFALSE otherwise. Caller can verify return value and then take appropriate decision.
81 lines
3.2 KiB
C
81 lines
3.2 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "sdkconfig.h"
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/task.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#if CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT || defined __DOXYGEN__
|
|
/**
|
|
* @brief Task Snapshot structure
|
|
*
|
|
* - Used with the uxTaskGetSnapshotAll() function to save memory snapshot of each task in the system.
|
|
* - We need this structure because TCB_t is defined (hidden) in tasks.c.
|
|
*/
|
|
typedef struct xTASK_SNAPSHOT
|
|
{
|
|
void *pxTCB; /*!< Address of the task control block. */
|
|
StackType_t *pxTopOfStack; /*!< Points to the location of the last item placed on the tasks stack. */
|
|
StackType_t *pxEndOfStack; /*!< Points to the end of the stack. pxTopOfStack < pxEndOfStack, stack grows hi2lo
|
|
pxTopOfStack > pxEndOfStack, stack grows lo2hi*/
|
|
} TaskSnapshot_t;
|
|
|
|
/**
|
|
* @brief Iterate over all tasks in the system
|
|
*
|
|
* - This function can be used to iterate over every task in the system
|
|
* - The first call to this function must set pxTask to NULL
|
|
* - When all functions have been iterated, this function will return NULL.
|
|
* - This function is only available when CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT is set to 1.
|
|
*
|
|
* @note This function should only be called when FreeRTOS is no longer running (e.g., during a panic) as this function
|
|
* does not acquire any locks.
|
|
* @param pxTask Handle of the previous task (or NULL on the first call of this function)
|
|
* @return TaskHandle_t Handle of the next task (or NULL when all tasks have been iterated over)
|
|
*/
|
|
TaskHandle_t pxTaskGetNext( TaskHandle_t pxTask );
|
|
|
|
/**
|
|
* @brief Fill a TaskSnapshot_t structure for specified task.
|
|
*
|
|
* - This function is used by the panic handler to get the snapshot of a particular task.
|
|
* - This function is only available when CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT is set to 1.
|
|
*
|
|
* @note This function should only be called when FreeRTOS is no longer running (e.g., during a panic) as this function
|
|
* does not acquire any locks.
|
|
* @param[in] pxTask Task's handle
|
|
* @param[out] pxTaskSnapshot Snapshot of the task
|
|
* @return pdTRUE if operation was successful else pdFALSE
|
|
*/
|
|
BaseType_t vTaskGetSnapshot( TaskHandle_t pxTask, TaskSnapshot_t *pxTaskSnapshot );
|
|
|
|
/**
|
|
* @brief Fill an array of TaskSnapshot_t structures for every task in the system
|
|
*
|
|
* - This function is used by the panic handler to get a snapshot of all tasks in the system
|
|
* - This function is only available when CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT is set to 1.
|
|
*
|
|
* @note This function should only be called when FreeRTOS is no longer running (e.g., during a panic) as this function
|
|
* does not acquire any locks.
|
|
* @param[out] pxTaskSnapshotArray Array of TaskSnapshot_t structures filled by this function
|
|
* @param[in] uxArrayLength Length of the provided array
|
|
* @param[out] pxTCBSize Size of the a task's TCB structure
|
|
* @return UBaseType_t
|
|
*/
|
|
UBaseType_t uxTaskGetSnapshotAll( TaskSnapshot_t * const pxTaskSnapshotArray, const UBaseType_t uxArrayLength, UBaseType_t * const pxTCBSize );
|
|
|
|
#endif // CONFIG_FREERTOS_ENABLE_TASK_SNAPSHOT || defined __DOXYGEN__
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|