FreeRTOS Trace原理
Tracealyzer 本身只提供了图形化界面的显示以及从 TraceRecorder 接收事件的形式, TraceRecorder 提供的是目标平台以固定形式记录事件的能力,但是具体要记录什么事件,以及何时进行记录,是由目标平台来定义的。在 FreeRTOS 中,在很多关键代码中插入了形如 traceXXX 的宏函数,这些宏函数被作为一个插槽可以被第三方库来使用,例如下图
在 FreeRTOS 的 systick 中,通过 traceINCREASE_TICK_COUNT 来跟踪系统节拍事件。这些宏函数只是定义了一个事件触发机制以及事件携带什么参数,在 FreeRTOS 的 FreeRTOS.h 头文件中,都定义为了空函数,即如果外部未定义,则所有的跟踪宏函数不执行任何操作
以下列举了一些常用的跟踪宏函数
宏定义 | 含义 |
traceTASK_SWITCHED_IN | 一个任务被选中进入运行态之前 |
traceINCREASE_TICK_COUNT | systick 计数 |
traceLOW_POWER_IDLE_BEGIN | 在进入 tickless idle 之前 |
traceLOW_POWER_IDLE_END | 在 tickless idle 之后 |
traceTASK_SWITCHED_OUT | 一个任务从运行态转换到 Not Running |
traceTASK_PRIORITY_INHERIT | 当任务试图获取已由低优先级任务持有的互斥锁时调用 |
traceTASK_PRIORITY_DISINHERIT | 当任务释放互斥锁时调用,保持互斥锁会导致任务继承更高优先级任务的优先级 |
traceBLOCKING_ON_QUEUE_RECEIVE | 任务因为无法从队列/互斥体/信号量中读取而阻塞 |
traceBLOCKING_ON_QUEUE_PEEK | 任务因为无法从队列/互斥体/信号量中读取而阻塞 |
traceBLOCKING_ON_QUEUE_SEND | 任务因为无法从队列/互斥体/信号量中写入而阻塞 |
traceMOVED_TASK_TO_READY_STATE | 任务转为 Ready 状态时 |
用户层面或者第三方库可以利用这些宏函数插槽插入具体的处理函数覆盖 FreeRTOS.h 中原本的空定义,以对具体事件进行捕获处理,启用 FreeRTOS 的 Trace 功能,需要在 FreeRTOSConfig.h 中配置 configUSE_TRACE_FACILITY 为 1
TraceRecorder库
在 Tracealyzer 安装路径 Tracealyzer 4/FreeRTOS/TraceRecorder 文件夹下,是针对 FreeRTOS 的 TraceRecorder 库源文件,在 FreeRTOS 中使用TraceRecroder,需要将其中部分文件添加到目标平台的工程中,对其进行一些配置,然后与 FreeRTOS 共同编译。另外, FreeRTOS 官方发布的源码中,在 FreeRTOS+Plus中的 FreeRTOSPlusTrace 也是 TraceRecroder 源码,使用这个源码也可以
TraceRecorder文件结构
TraceRecorder 文件结构如图所示
以下对关键文件进行介绍
config/trcConfig.h
该文件是对 TraceRecorder 库主要和整体层面的一个配置文件,包含了记录模式选择 (流/快照)、 FreeRTOS 哪些事件被记录等。该文件必须包含在目标工程中
config/trcSnapshotConfig.h
该文件是快照模式下的一些配置选项,包括可记录事件数量等。当使用快照模式时,该文件需要包含在目标平台工程中
config/trcStreamingConfig.h
该文件是流模式下的一些配置选项,包括定义流模式、读写模式等。当使用流模式时,该文件需要包含在目标平台工程中
include/trcHardwarePort.h
该文件是与目标平台相关定义,必须被包含在目标平台工程中,且在适配目标平台时需要对其进行修改
include/trcKernelPort.h
该文件中定义了 TraceRecorder 的核心功能函数,对 FreeRTOS 跟踪函数的重定义也在其中,必须被包含在目标平台工程中