harmony 鸿蒙Trace调测

2022-08-09
浏览 (802)

Trace调测

基本概念

Trace调测旨在帮助开发者获取内核的运行流程，各个模块、任务的执行顺序，从而可以辅助开发者定位一些时序问题或者了解内核的代码运行过程。

运行机制

内核提供一套Hook框架，将Hook点预埋在各个模块的主要流程中, 在内核启动初期完成Trace功能的初始化，并注册Trace的处理函数到Hook中。

当系统触发到一个Hook点时，Trace模块会对输入信息进行封装，添加Trace帧头信息，包含事件类型、运行的cpuid、运行的任务id、运行的相对时间戳等信息；

Trace提供2种工作模式，离线模式和在线模式。

离线模式会将trace frame记录到预先申请好的循环buffer中。如果循环buffer记录的frame过多则可能出现翻转，会覆盖之前的记录，故保持记录的信息始终是最新的信息。Trace循环buffer的数据可以通过shell命令导出进行详细分析，导出信息已按照时间戳信息完成排序。

zh-cn_image_0000001214329013

在线模式需要配合IDE使用，实时将trace frame记录发送给IDE，IDE端进行解析并可视化展示。

接口说明

内核态

LiteOS-A内核的Trace模块提供下面几种功能，接口详细信息可以查看API参考。

表1 Trace模块接口说明

功能分类	接口描述
启停控制	LOS_TraceStart：启动Trace LOS_TraceStop：停止Trace
操作Trace记录的数据	LOS_TraceRecordDump：输出Trace缓冲区数据 LOS_TraceRecordGet：获取Trace缓冲区的首地址 LOS_TraceReset：清除Trace缓冲区中的事件
过滤Trace记录的数据	LOS_TraceEventMaskSet：设置事件掩码，仅记录某些模块的事件
屏蔽某些中断号事件	LOS_TraceHwiFilterHookReg：注册过滤特定中断号事件的钩子函数
插桩函数	LOS_TRACE_EASY：简易插桩 LOS_TRACE：标准插桩

当用户需要针对自定义事件进行追踪时，可按规则在目标源代码中进行插桩，系统提供如下2种插桩接口：

LOS_TRACE_EASY(TYPE, IDENTITY, params…) 简易插桩。

用户在目标源代码中插入该接口即可。
TYPE有效取值范围为[0, 0xF]，表示不同的事件类型，不同取值表示的含义由用户自定义。
IDENTITY类型UINTPTR，表示事件操作的主体对象。
Params类型UINTPTR，表示事件的参数。示例：

假设需要新增对文件（fd1、fd2）读写操作的简易插桩,
自定义读操作为type：1， 写操作为type：2，则
在读fd1文件的适当位置插入：
LOS_TRACE_EASY(1, fd1, flag, size);
在读fd2文件的适当位置插入：
LOS_TRACE_EASY(1, fd2, flag, size);
在写fd1文件的适当位置插入：
LOS_TRACE_EASY(2, fd1, flag, size);
在写fd2文件的适当位置插入：
LOS_TRACE_EASY(2, fd2，flag, size);

LOS_TRACE(TYPE, IDENTITY, params…) 标准插桩。

相比简易插桩，支持动态过滤事件和参数裁剪，但使用上需要用户按规则来扩展。
TYPE用于设置具体的事件类型，可以在头文件los_trace.h中的enum LOS_TRACE_TYPE中自定义事件类型。定义方法和规则可以参考其他事件类型。
IDENTITY和Params的类型及含义同简易插桩。示例：

1.在enum LOS_TRACE_MASK中定义事件掩码，即模块级别的事件类型。
  定义规范为TRACE_#MOD#_FLAG，#MOD#表示模块名。
  例如:
  TRACE_FS_FLAG = 0x4000
2.在enum LOS_TRACE_TYPE中定义具体事件类型。
  定义规范为#TYPE# = TRACE_#MOD#_FLAG|NUMBER，
  例如:
  FS_READ  = TRACE_FS_FLAG|0; // 读文件
  FS_WRITE = TRACE_FS_FLAG|1; // 写文件
3.定义事件参数。定义规范为#TYPE#_PARAMS(IDENTITY, parma1...) IDENTITY, ...
  其中的#TYPE#就是上面2中的#TYPE#，
  例如:
  #define FS_READ_PARAMS(fp, fd, flag, size)    fp, fd, flag, size
  宏定义的参数对应于Trace缓冲区中记录的事件参数，用户可对任意参数字段进行裁剪:
  当定义为空时，表示不追踪该类型事件:
  #define FS_READ_PARAMS(fp, fd, flag, size) // 不追踪文件读事件
4.在适当位置插入代码桩。
  定义规范为LOS_TRACE(#TYPE#, #TYPE#_PARAMS(IDENTITY, parma1...))
  LOS_TRACE(FS_READ, fp, fd, flag, size); // 读文件的代码桩,
  #TYPE#之后的入参就是上面3中的FS_READ_PARAMS函数的入参

说明： 预置的Trace事件及参数均可以通过上述方式进行裁剪，参数详见 kernel\include\los_trace.h。

Trace Mask事件过滤接口LOS_TraceEventMaskSet(UINT32 mask)，其入参mask仅高28位生效（对应LOS_TRACE_MASK中某模块的使能位），仅用于模块的过滤，暂不支持针对某个特定事件的细粒度过滤。例如：LOS_TraceEventMaskSet(0x202)，则实际设置生效的mask为0x200（TRACE_QUE_FLAG），QUE模块的所有事件均会被采集。一般建议使用的方法为： LOS_TraceEventMaskSet(TRACE_EVENT_FLAG|TRACE_MUX_FLAG|TRACE_SEM_FLAG|TRACE_QUE_FLAG);
如果仅需要使能简易插桩事件，通过设置Trace Mask为TRACE_MAX_FLAG即可。
Trace缓冲区有限，事件写满之后会覆盖写，用户可通过LOS_TraceRecordDump中打印的CurEvtIndex识别最新记录。
Trace的典型操作流程为：LOS_TraceStart、 LOS_TraceStop、 LOS_TraceRecordDump.
针对中断事件的Trace, 提供中断号过滤，用于解决某些场景下特定中断号频繁触发导致其他事件被覆盖的情况，用户可自定义中断过滤的规则，示例如下：

  BOOL Example_HwiNumFilter(UINT32 hwiNum)
  {
      if ((hwiNum == TIMER_INT)||(hwiNum == DMA_INT)) {
          return TRUE;
      }
      return FALSE;
  }
  LOS_TraceHwiFilterHookReg(Example_HwiNumFilter);

则当中断号为TIMER_INT 或者DMA_INT时，不记录中断事件。

用户态

新增trace字符设备，位于”/dev/trace”，通过对设备节点的read、write、ioctl，实现用户态trace的读写和控制：

read: 用户态读取Trace记录数据
write: 用户态事件写入
ioctl: 用户态Trace控制操作，包括

#define TRACE_IOC_MAGIC   'T'
#define TRACE_START      _IO(TRACE_IOC_MAGIC, 1)
#define TRACE_STOP       _IO(TRACE_IOC_MAGIC, 2)
#define TRACE_RESET      _IO(TRACE_IOC_MAGIC, 3)
#define TRACE_DUMP		 _IO(TRACE_IOC_MAGIC, 4)
#define TRACE_SET_MASK	 _IO(TRACE_IOC_MAGIC, 5)

分别对应Trace启动(LOS_TraceStart)、停止(LOS_TraceStop)、清除记录(LOS_TraceReset)、dump记录(LOS_TraceRecordDump)、设置事件过滤掩码(LOS_TraceEventMaskSet)

具体的使用方法参见用户态编程实例。

开发指导

内核态开发流程

开启Trace调测的典型流程如下：

配置Trace模块相关宏。配置Trace控制宏LOSCFG_KERNEL_TRACE，默认关，在 kernel/liteos_a 目录下执行 make update_config 命令配置 “Kernel->Enable Hook Feature->Enable Trace Feature” 中打开：

(可选)预置事件参数和事件桩（或使用系统默认的事件参数配置和事件桩）。
(可选)调用LOS_TraceStop停止Trace后，清除缓冲区LOS_TraceReset（系统默认已启动trace）。
(可选)调用LOS_TraceEventMaskSet设置需要追踪的事件掩码（系统默认的事件掩码仅使能中断与任务事件），事件掩码参见 los_trace.h 中的LOS_TRACE_MASK定义。
在需要记录事件的代码起始点调用LOS_TraceStart。
在需要记录事件的代码结束点调用LOS_TraceStop。
调用LOS_TraceRecordDump输出缓冲区数据（函数的入参为布尔型，FALSE表示格式化输出，TRUE表示输出到Trace IDE）。

上述第3-7步中的接口，均封装有对应的shell命令，开启shell后可执行相应的命令，对应关系如下:

LOS_TraceReset —— trace_reset
LOS_TraceEventMaskSet —— trace_mask
LOS_TraceStart —— trace_start
LOS_TraceStop —— trace_stop
LOS_TraceRecordDump —— trace_dump

内核态编程实例

本实例实现如下功能：

创建一个用于Trace测试的任务。
设置事件掩码。
启动trace。
停止trace。
格式化输出trace数据。

内核态示例代码

该示例代码的测试函数可以加在 kernel /liteos_a/testsuites /kernel /src /osTest.c 中的 TestTaskEntry 中进行测试。实例代码如下：

#include "los_trace.h"
UINT32 g_traceTestTaskId;
VOID Example_Trace(VOID)
{
    UINT32 ret;
    LOS_TaskDelay(10);
    /* 开启trace */
    ret = LOS_TraceStart();
    if (ret != LOS_OK) {
        dprintf("trace start error\n");
        return;
    }
    /* 触发任务切换的事件 */
    LOS_TaskDelay(1);
    LOS_TaskDelay(1);
    LOS_TaskDelay(1);
    /* 停止trace */
    LOS_TraceStop();
    LOS_TraceRecordDump(FALSE);
}
UINT32 Example_Trace_test(VOID)
{
    UINT32 ret;
    TSK_INIT_PARAM_S traceTestTask;
    /* 创建用于trace测试的任务 */
    memset(&traceTestTask, 0, sizeof(TSK_INIT_PARAM_S));
    traceTestTask.pfnTaskEntry = (TSK_ENTRY_FUNC)Example_Trace;
    traceTestTask.pcName       = "TestTraceTsk";    /* 测试任务名称 */
    traceTestTask.uwStackSize  = 0x800; // 0x800: trace test task stacksize
    traceTestTask.usTaskPrio   = 5; // 5: trace test task priority
    traceTestTask.uwResved   = LOS_TASK_STATUS_DETACHED;
    ret = LOS_TaskCreate(&g_traceTestTaskId, &traceTestTask);
    if (ret != LOS_OK) {
        dprintf("TraceTestTask create failed .\n");
        return LOS_NOK;
    }
    /* 系统默认情况下已启动trace, 因此可先关闭trace后清除缓存区后，再重启trace */
    LOS_TraceStop();
    LOS_TraceReset();
    /* 开启任务模块事件记录 */
    LOS_TraceEventMaskSet(TRACE_TASK_FLAG);
    return LOS_OK;
}
LOS_MODULE_INIT(Example_Trace_test, LOS_INIT_LEVEL_KMOD_EXTENDED);

结果验证

输出结果如下：

***TraceInfo begin***
clockFreq = 50000000
CurEvtIndex = 7
Index   Time(cycles)      EventType      CurTask   Identity      params
0       0x366d5e88        0x45           0x1       0x0           0x1f         0x4       0x0
1       0x366d74ae        0x45           0x0       0x1           0x0          0x8       0x1f
2       0x36940da6        0x45           0x1       0xc           0x1f         0x4       0x9
3       0x3694337c        0x45           0xc       0x1           0x9          0x8       0x1f
4       0x36eea56e        0x45           0x1       0xc           0x1f         0x4       0x9
5       0x36eec810        0x45           0xc       0x1           0x9          0x8       0x1f
6       0x3706f804        0x45           0x1       0x0           0x1f         0x4       0x0
7       0x37070e59        0x45           0x0       0x1           0x0          0x8       0x1f
***TraceInfo end***

输出的事件信息包括：发生时间、事件类型、事件发生在哪个任务中、事件操作的主体对象、事件的其他参数。

EventType：表示的具体事件可查阅头文件 los_trace.h 中的enum LOS_TRACE_TYPE。
CurrentTask：表示当前运行在哪个任务中，值为taskid。
Identity：表示事件操作的主体对象，可查阅头文件 los_trace.h 中的#TYPE#_PARAMS。
params：表示的事件参数可查阅头文件 los_trace.h 中的#TYPE#_PARAMS。

下面以序号为0的输出项为例，进行说明。

Index   Time(cycles)      EventType      CurTask   Identity      params
0       0x366d5e88        0x45           0x1       0x0           0x1f         0x4

Time cycles可换算成时间，换算公式为cycles/clockFreq，单位为s。
0x45为TASK_SWITCH即任务切换事件，当前运行的任务taskid为0x1。
Identity和params的含义需要查看TASK_SWITCH_PARAMS宏定义：

#define TASK_SWITCH_PARAMS(taskId, oldPriority, oldTaskStatus, newPriority, newTaskStatus) \
taskId, oldPriority, oldTaskStatus, newPriority, newTaskStatus

因为#TYPE#_PARAMS(IDENTITY, parma1…) IDENTITY, …，所以Identity为taskId（0x0），第一个参数为oldPriority（0x1f）