los_trace.c 文件参考

http://weharmonyos.com/openharmony/zh-cn/device-dev/kernel/kernel-small-debug-trace.html 更多...

浏览源代码.

函数
LITE_OS_SEC_BSS	SPIN_LOCK_INIT (g_traceSpin)
STATIC_INLINE BOOL	OsTraceHwiFilter (UINT32 hwiNum)
STATIC VOID	OsTraceSetFrame (TraceEventFrame *frame, UINT32 eventType, UINTPTR identity, const UINTPTR *params, UINT16 paramCount)
VOID	OsTraceSetObj (ObjData *obj, const LosTaskCB *tcb)
VOID	OsTraceHook (UINT32 eventType, UINTPTR identity, const UINTPTR *params, UINT16 paramCount)
	OsTraceHook 事件统一处理函数 更多...
BOOL	OsTraceIsEnable (VOID)
STATIC VOID	OsTraceHookInstall (VOID)
	初始化事件处理函数 更多...
STATIC BOOL	OsTraceCmdIsValid (const TraceClientCmd *msg)
STATIC VOID	OsTraceCmdHandle (const TraceClientCmd *msg)
	trace任务的入口函数,接收串口数据 更多...
VOID	TraceAgent (VOID)
STATIC UINT32	OsCreateTraceAgentTask (VOID)
	OsCreateTraceAgentTask 创建trace任务 更多...
STATIC UINT32	OsTraceInit (VOID)
	跟踪模块初始化 更多...
UINT32	LOS_TraceStart (VOID)
	启动Trace 更多...
VOID	LOS_TraceStop (VOID)
	停止Trace(跟踪) 更多...
VOID	LOS_TraceEventMaskSet (UINT32 mask)
	设置事件掩码，仅记录某些模块的事件 更多...
VOID	LOS_TraceRecordDump (BOOL toClient)
	输出Trace缓冲区数据 更多...
OfflineHead *	LOS_TraceRecordGet (VOID)
	获取Trace缓冲区的首地址 更多...
VOID	LOS_TraceReset (VOID)
	清除Trace缓冲区中的事件 更多...
VOID	LOS_TraceHwiFilterHookReg (TRACE_HWI_FILTER_HOOK hook)
	注册过滤特定中断号事件的钩子函数 更多...
LITE_OS_SEC_TEXT_MINOR UINT32	OsShellCmdTraceSetMask (INT32 argc, const CHAR **argv)
	通过shell命令 设置事件掩码，仅记录某些模块的事件 更多...
LITE_OS_SEC_TEXT_MINOR UINT32	OsShellCmdTraceDump (INT32 argc, const CHAR **argv)
	SHELLCMD_ENTRY (tracestart_shellcmd, CMD_TYPE_EX, "trace_start", 0,(CmdCallBackFunc) LOS_TraceStart)
	SHELLCMD_ENTRY (tracestop_shellcmd, CMD_TYPE_EX, "trace_stop", 0,(CmdCallBackFunc) LOS_TraceStop)
	SHELLCMD_ENTRY (tracesetmask_shellcmd, CMD_TYPE_EX, "trace_mask", 1,(CmdCallBackFunc) OsShellCmdTraceSetMask)
	SHELLCMD_ENTRY (tracereset_shellcmd, CMD_TYPE_EX, "trace_reset", 0,(CmdCallBackFunc) LOS_TraceReset)
	SHELLCMD_ENTRY (tracedump_shellcmd, CMD_TYPE_EX, "trace_dump", 1,(CmdCallBackFunc) OsShellCmdTraceDump)
	LOS_MODULE_INIT (OsTraceInit, LOS_INIT_LEVEL_KMOD_EXTENDED)

变量
LITE_OS_SEC_BSS STATIC UINT32	g_traceEventCount
LITE_OS_SEC_BSS STATIC enum TraceState	g_traceState = TRACE_UNINIT
LITE_OS_SEC_DATA_INIT STATIC volatile BOOL	g_enableTrace = FALSE
	trace开关 更多...
LITE_OS_SEC_BSS STATIC UINT32	g_traceMask = TRACE_DEFAULT_MASK
	全局变量设置事件掩码，仅记录某些模块的事件 更多...
TRACE_EVENT_HOOK	g_traceEventHook = NULL
	事件钩子函数 更多...
TRACE_DUMP_HOOK	g_traceDumpHook = NULL
	输出缓冲区数据 更多...
LITE_OS_SEC_BSS STATIC UINT32	g_traceTaskId
LITE_OS_SEC_BSS STATIC TRACE_HWI_FILTER_HOOK	g_traceHwiFilterHook = NULL
	用于跟踪硬中断过滤的钩子函数 更多...

详细描述

http://weharmonyos.com/openharmony/zh-cn/device-dev/kernel/kernel-small-debug-trace.html

 基本概念
    Trace调测旨在帮助开发者获取内核的运行流程，各个模块、任务的执行顺序，从而可以辅助开发者定位一些时序问题
    或者了解内核的代码运行过程。
 相关宏
    LOSCFG_KERNEL_TRACE             Trace模块的裁剪开关                YES/NO
    LOSCFG_RECORDER_MODE_OFFLINE    Trace工作模式为离线模式              YES/NO
    LOSCFG_RECORDER_MODE_ONLINE     Trace工作模式为在线模式              YES/NO
    LOSCFG_TRACE_CLIENT_INTERACT    使能与Trace IDE （dev tools）的交互，包括数据可视化和流程控制    YES/NO
    LOSCFG_TRACE_FRAME_CORE_MSG     记录CPUID、中断状态、锁任务状态  YES/NO
    LOSCFG_TRACE_FRAME_EVENT_COUNT  记录事件的次序编号                   YES/NO
    LOSCFG_TRACE_FRAME_MAX_PARAMS   配置记录事件的最大参数个数               INT
    LOSCFG_TRACE_BUFFER_SIZE        配置Trace的缓冲区大小               INT
 运行机制
    内核提供一套Hook框架，将Hook点预埋在各个模块的主要流程中, 在内核启动初期完成Trace功能的初始化，
    并注册Trace的处理函数到Hook中。

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

    Trace提供2种工作模式，离线模式和在线模式。
        在线模式需要配合IDE使用，实时将trace frame记录发送给IDE，IDE端进行解析并可视化展示。
        离线模式会将trace frame记录到预先申请好的循环buffer中。如果循环buffer记录的frame过多则可能出现翻转，
        会覆盖之前的记录，故保持记录的信息始终是最新的信息。Trace循环buffer的数据可以通过shell命令导出进行详细分析，
        导出信息已按照时间戳信息完成排序。

版本

作者

weharmonyos.com | 鸿蒙研究站 | 每天死磕一点点

日期

2021-11-20

在文件 los_trace.c 中定义.

函数说明

LOS_MODULE_INIT()

LOS_MODULE_INIT	(	OsTraceInit	,
		LOS_INIT_LEVEL_KMOD_EXTENDED
	)

OsCreateTraceAgentTask()

STATIC UINT32 OsCreateTraceAgentTask

(

VOID

)

OsCreateTraceAgentTask 创建trace任务

返回

参见

在文件 los_trace.c 第 281 行定义.

{
    UINT32 ret;
    TSK_INIT_PARAM_S taskInitParam;
 
    (VOID)memset_s((VOID *)(&taskInitParam), sizeof(TSK_INIT_PARAM_S), 0, sizeof(TSK_INIT_PARAM_S));
    taskInitParam.pfnTaskEntry = (TSK_ENTRY_FUNC)TraceAgent;    //任务入口函数
    taskInitParam.usTaskPrio = LOSCFG_TRACE_TASK_PRIORITY;  //任务优先级 2
    taskInitParam.pcName = "TraceAgent";    //任务名称
    taskInitParam.uwStackSize = LOSCFG_BASE_CORE_TSK_DEFAULT_STACK_SIZE; //内核栈大小 16K
#ifdef LOSCFG_KERNEL_SMP
    taskInitParam.usCpuAffiMask = CPUID_TO_AFFI_MASK(ArchCurrCpuid());//指定为当前CPU执行
#endif
    ret = LOS_TaskCreate(&g_traceTaskId, &taskInitParam);//创建任务并产生调度
    return ret;
}

函数调用图:

这是这个函数的调用关系图:

OsShellCmdTraceDump()

LITE_OS_SEC_TEXT_MINOR UINT32 OsShellCmdTraceDump	(	INT32	argc,
		const CHAR **	argv
	)

在文件 los_trace.c 第 457 行定义.

{
    BOOL toClient;
    CHAR *endPtr = NULL;
 
    if (argc >= 2) { /* 2:Just as number of parameters */
        PRINTK("\nUsage: trace_dump or trace_dump [1/0]\n");
        return OS_ERROR;
    }
 
    if (argc == 0) {
        toClient = FALSE;
    } else {
        toClient = strtoul(argv[0], &endPtr, 0) != 0 ? TRUE : FALSE;
    }
    LOS_TraceRecordDump(toClient);
    return LOS_OK;
}

函数调用图:

OsShellCmdTraceSetMask()

LITE_OS_SEC_TEXT_MINOR UINT32 OsShellCmdTraceSetMask	(	INT32	argc,
		const CHAR **	argv
	)

通过shell命令 设置事件掩码，仅记录某些模块的事件

在文件 los_trace.c 第 438 行定义.

{
    size_t mask;
    CHAR *endPtr = NULL;
 
    if (argc >= 2) { /* 2:Just as number of parameters */
        PRINTK("\nUsage: trace_mask or trace_mask ID\n");
        return OS_ERROR;
    }
 
    if (argc == 0) {
        mask = TRACE_DEFAULT_MASK;
    } else {
        mask = strtoul(argv[0], &endPtr, 0);
    }
    LOS_TraceEventMaskSet((UINT32)mask);
    return LOS_OK;
}

函数调用图:

OsTraceCmdHandle()

STATIC VOID OsTraceCmdHandle

(

const TraceClientCmd *

msg

)

trace任务的入口函数,接收串口数据

在文件 los_trace.c 第 234 行定义.

函数调用图:

这是这个函数的调用关系图:

OsTraceCmdIsValid()

STATIC BOOL OsTraceCmdIsValid

(

const TraceClientCmd *

msg

)

在文件 los_trace.c 第 229 行定义.

{
    return ((msg->end == TRACE_CMD_END_CHAR) && (msg->cmd < TRACE_CMD_MAX_CODE));
}

这是这个函数的调用关系图:

OsTraceHook()

VOID OsTraceHook	(	UINT32	eventType,
		UINTPTR	identity,
		const UINTPTR *	params,
		UINT16	paramCount
	)

OsTraceHook
事件统一处理函数

参数

eventType
identity
paramCount
params

返回

参见

在文件 los_trace.c 第 188 行定义.

{
    TraceEventFrame frame;//离线和在线模式下, trace数据的保存和传送以帧为单位
    if ((eventType == TASK_CREATE) || (eventType == TASK_PRIOSET)) {//创建任务和设置任务优先级
        OsTraceObjAdd(eventType, identity); /* handle important obj info, these can not be filtered */
    }
 
    if ((g_enableTrace == TRUE) && (eventType & g_traceMask)) {//使能跟踪模块且事件未屏蔽
        UINTPTR id = identity;
        if (TRACE_GET_MODE_FLAG(eventType) == TRACE_HWI_FLAG) {//关于硬中断的事件
            if (OsTraceHwiFilter(identity)) {//检查中断号是否过滤掉了,注意:中断控制器本身是可以屏蔽中断号的
                return;
            }
        } else if (TRACE_GET_MODE_FLAG(eventType) == TRACE_TASK_FLAG) {//关于任务的事件
            id = OsTraceGetMaskTid(identity);//获取任务ID
        } else if (eventType == MEM_INFO_REQ) {//内存信息事件
            LOS_MEM_POOL_STATUS status;
            LOS_MemInfoGet((VOID *)identity, &status);//获取内存各项信息
            LOS_TRACE(MEM_INFO, identity, status.totalUsedSize, status.totalFreeSize);//打印信息
            return;
        }
 
        OsTraceSetFrame(&frame, eventType, id, params, paramCount);//创建帧数据
        OsTraceWriteOrSendEvent(&frame);//保存(离线模式下)或者发送(在线模式下)帧数据
    }
}

函数调用图:

这是这个函数的调用关系图:

OsTraceHookInstall()

STATIC VOID OsTraceHookInstall

(

VOID

)

初始化事件处理函数

在文件 los_trace.c 第 220 行定义.

{
    g_traceEventHook = OsTraceHook;
#ifdef LOSCFG_RECORDER_MODE_OFFLINE
    g_traceDumpHook = OsTraceRecordDump;
#endif
}

函数调用图:

这是这个函数的调用关系图:

OsTraceHwiFilter()

STATIC_INLINE BOOL OsTraceHwiFilter

(

UINT32

hwiNum

)

在文件 los_trace.c 第 107 行定义.

{
    BOOL ret = ((hwiNum == NUM_HAL_INTERRUPT_UART) || (hwiNum == OS_TICK_INT_NUM));
#ifdef LOSCFG_KERNEL_SMP
    ret |= (hwiNum == LOS_MP_IPI_SCHEDULE);
#endif
    if (g_traceHwiFilterHook != NULL) {
        ret |= g_traceHwiFilterHook(hwiNum);
    }
    return ret;
}

这是这个函数的调用关系图:

OsTraceInit()

STATIC UINT32 OsTraceInit

(

VOID

)

跟踪模块初始化

在文件 los_trace.c 第 299 行定义.

{
    UINT32 ret;
 
    if (g_traceState != TRACE_UNINIT) {
        TRACE_ERROR("trace has been initialized already, the current state is :%d\n", g_traceState);
        ret = LOS_ERRNO_TRACE_ERROR_STATUS;
        goto LOS_ERREND;
    }
 
#ifdef LOSCFG_TRACE_CLIENT_INTERACT //使能与Trace IDE （dev tools）的交互，包括数据可视化和流程控制
    ret = OsTracePipelineInit();//在线模式(管道模式)的初始化
    if (ret != LOS_OK) {
        goto LOS_ERREND;
    }
#endif
 
#ifdef LOSCFG_TRACE_CONTROL_AGENT //trace任务代理开关,所谓代理是创建专门的任务来处理 trace
    ret = OsCreateTraceAgentTask();
    if (ret != LOS_OK) {
        TRACE_ERROR("trace init create agentTask error :0x%x\n", ret);
        goto LOS_ERREND;
    }
#endif
 
#ifdef LOSCFG_RECORDER_MODE_OFFLINE //trace离线模式开关
//离线模式会将trace frame记录到预先申请好的循环buffer中。如果循环buffer记录的frame过多则可能出现翻转，
//会覆盖之前的记录，故保持记录的信息始终是最新的信息。
    ret = OsTraceBufInit(LOSCFG_TRACE_BUFFER_SIZE); //离线模式下buf 大小,这个大小决定了装多少 ObjData 和 TraceEventFrame
    if (ret != LOS_OK) {
#ifdef LOSCFG_TRACE_CONTROL_AGENT
        (VOID)LOS_TaskDelete(g_traceTaskId);
#endif
        goto LOS_ERREND;
    }
#endif
 
    OsTraceHookInstall();//安装HOOK框架
    OsTraceCnvInit();//将事件处理函数注册到HOOK框架
 
    g_traceEventCount = 0;
 
#ifdef LOSCFG_RECORDER_MODE_ONLINE  /* Wait trace client to start trace */
    g_enableTrace = FALSE;
    g_traceState = TRACE_INITED;
#else
    g_enableTrace = TRUE;
    g_traceState = TRACE_STARTED;
#endif
    return LOS_OK;
LOS_ERREND:
    return ret;
}

函数调用图:

OsTraceIsEnable()

BOOL OsTraceIsEnable

(

VOID

)

在文件 los_trace.c 第 215 行定义.

{
    return g_enableTrace;
}

这是这个函数的调用关系图:

OsTraceSetFrame()

STATIC VOID OsTraceSetFrame	(	TraceEventFrame *	frame,
		UINT32	eventType,
		UINTPTR	identity,
		const UINTPTR *	params,
		UINT16	paramCount
	)

在文件 los_trace.c 第 119 行定义.

{
    INT32 i;
    UINT32 intSave;
 
    (VOID)memset_s(frame, sizeof(TraceEventFrame), 0, sizeof(TraceEventFrame));
 
    if (paramCount > LOSCFG_TRACE_FRAME_MAX_PARAMS) {
        paramCount = LOSCFG_TRACE_FRAME_MAX_PARAMS;
    }
 
    TRACE_LOCK(intSave);
    frame->curTask   = OsTraceGetMaskTid(LOS_CurTaskIDGet());
    frame->curPid    = LOS_GetCurrProcessID();
    frame->identity  = identity;
    frame->curTime   = HalClockGetCycles();
    frame->eventType = eventType;
 
#ifdef LOSCFG_TRACE_FRAME_CORE_MSG
    frame->core.cpuid      = ArchCurrCpuid();
    frame->core.hwiActive  = OS_INT_ACTIVE ? TRUE : FALSE;
    frame->core.taskLockCnt = MIN(OsSchedLockCountGet(), 0xF); /* taskLockCnt is 4 bits, max value = 0xF */
    frame->core.paramCount = paramCount;
#endif
 
#ifdef LOS_TRACE_FRAME_LR
    /* Get the linkreg from stack fp and storage to frame */
    LOS_RecordLR(frame->linkReg, LOS_TRACE_LR_RECORD, LOS_TRACE_LR_RECORD, LOS_TRACE_LR_IGNORE);
#endif
 
#ifdef LOSCFG_TRACE_FRAME_EVENT_COUNT
    frame->eventCount = g_traceEventCount;
    g_traceEventCount++;
#endif
    TRACE_UNLOCK(intSave);
 
    for (i = 0; i < paramCount; i++) {
        frame->params[i] = params[i];
    }
}

函数调用图:

这是这个函数的调用关系图:

OsTraceSetObj()

VOID OsTraceSetObj	(	ObjData *	obj,
		const LosTaskCB *	tcb
	)

在文件 los_trace.c 第 161 行定义.

{
    errno_t ret;
    SchedParam param = { 0 };
    (VOID)memset_s(obj, sizeof(ObjData), 0, sizeof(ObjData));
 
    obj->id   = OsTraceGetMaskTid(tcb->taskID);
    tcb->ops->schedParamGet(tcb, &param);
    obj->prio = param.priority;
 
    ret = strncpy_s(obj->name, LOSCFG_TRACE_OBJ_MAX_NAME_SIZE, tcb->taskName, LOSCFG_TRACE_OBJ_MAX_NAME_SIZE - 1);
    if (ret != EOK) {
        TRACE_ERROR("Task name copy failed!\n");
    }
}

函数调用图:

这是这个函数的调用关系图:

SHELLCMD_ENTRY() [1/5]

SHELLCMD_ENTRY	(	tracedump_shellcmd	,
		CMD_TYPE_EX	,
		"trace_dump"	,
		1	,
		(CmdCallBackFunc)	OsShellCmdTraceDump
	)

SHELLCMD_ENTRY() [2/5]

SHELLCMD_ENTRY	(	tracereset_shellcmd	,
		CMD_TYPE_EX	,
		"trace_reset"	,
		0	,
		(CmdCallBackFunc)	LOS_TraceReset
	)

SHELLCMD_ENTRY() [3/5]

SHELLCMD_ENTRY	(	tracesetmask_shellcmd	,
		CMD_TYPE_EX	,
		"trace_mask"	,
		1	,
		(CmdCallBackFunc)	OsShellCmdTraceSetMask
	)

SHELLCMD_ENTRY() [4/5]

SHELLCMD_ENTRY	(	tracestart_shellcmd	,
		CMD_TYPE_EX	,
		"trace_start"	,
		0	,
		(CmdCallBackFunc)	LOS_TraceStart
	)

SHELLCMD_ENTRY() [5/5]

SHELLCMD_ENTRY	(	tracestop_shellcmd	,
		CMD_TYPE_EX	,
		"trace_stop"	,
		0	,
		(CmdCallBackFunc)	LOS_TraceStop
	)

SPIN_LOCK_INIT()

LITE_OS_SEC_BSS SPIN_LOCK_INIT

(

g_traceSpin

)

TraceAgent()

VOID TraceAgent

(

VOID

)

在文件 los_trace.c 第 259 行定义.

{
    UINT32 ret;
    TraceClientCmd msg;
 
    while (1) {
        (VOID)memset_s(&msg, sizeof(TraceClientCmd), 0, sizeof(TraceClientCmd));
        ret = OsTraceDataWait();//等待数据到来
        if (ret == LOS_OK) {
            OsTraceDataRecv((UINT8 *)&msg, sizeof(TraceClientCmd), 0);
            OsTraceCmdHandle(&msg);//处理数据
        }
    }
}

函数调用图:

这是这个函数的调用关系图:

变量说明

g_enableTrace

LITE_OS_SEC_DATA_INIT STATIC volatile BOOL g_enableTrace = FALSE

trace开关

在文件 los_trace.c 第 88 行定义.

g_traceDumpHook

TRACE_DUMP_HOOK g_traceDumpHook = NULL

输出缓冲区数据

在文件 los_trace.c 第 92 行定义.

g_traceEventCount

LITE_OS_SEC_BSS STATIC UINT32 g_traceEventCount

在文件 los_trace.c 第 86 行定义.

g_traceEventHook

TRACE_EVENT_HOOK g_traceEventHook = NULL

事件钩子函数

在文件 los_trace.c 第 91 行定义.

g_traceHwiFilterHook

LITE_OS_SEC_BSS STATIC TRACE_HWI_FILTER_HOOK g_traceHwiFilterHook = NULL

用于跟踪硬中断过滤的钩子函数

在文件 los_trace.c 第 101 行定义.

g_traceMask

LITE_OS_SEC_BSS STATIC UINT32 g_traceMask = TRACE_DEFAULT_MASK

全局变量设置事件掩码，仅记录某些模块的事件

在文件 los_trace.c 第 89 行定义.

g_traceState

LITE_OS_SEC_BSS STATIC enum TraceState g_traceState = TRACE_UNINIT

在文件 los_trace.c 第 87 行定义.

g_traceTaskId

LITE_OS_SEC_BSS STATIC UINT32 g_traceTaskId

在文件 los_trace.c 第 95 行定义.