Perf

Perf 的协作图:

结构体
struct	PerfEventConfig
struct	PerfConfigAttr

类型定义
typedef VOID(*	PERF_BUF_NOTIFY_HOOK) (VOID)
typedef VOID(*	PERF_BUF_FLUSH_HOOK) (VOID *addr, UINT32 size)

枚举
enum	PerfStatus { PERF_UNINIT , PERF_STARTED , PERF_STOPPED }
enum	PerfEventType {   PERF_EVENT_TYPE_HW , PERF_EVENT_TYPE_TIMED , PERF_EVENT_TYPE_SW , PERF_EVENT_TYPE_RAW ,   PERF_EVENT_TYPE_MAX , PERF_EVENT_TYPE_HW , PERF_EVENT_TYPE_TIMED , PERF_EVENT_TYPE_SW ,   PERF_EVENT_TYPE_RAW , PERF_EVENT_TYPE_MAX }
enum	PmuHwId {   PERF_COUNT_HW_CPU_CYCLES = 0 , PERF_COUNT_HW_INSTRUCTIONS , PERF_COUNT_HW_DCACHE_REFERENCES , PERF_COUNT_HW_DCACHE_MISSES ,   PERF_COUNT_HW_ICACHE_REFERENCES , PERF_COUNT_HW_ICACHE_MISSES , PERF_COUNT_HW_BRANCH_INSTRUCTIONS , PERF_COUNT_HW_BRANCH_MISSES ,   PERF_COUNT_HW_MAX , PERF_COUNT_HW_CPU_CYCLES = 0 , PERF_COUNT_HW_INSTRUCTIONS , PERF_COUNT_HW_DCACHE_REFERENCES ,   PERF_COUNT_HW_DCACHE_MISSES , PERF_COUNT_HW_ICACHE_REFERENCES , PERF_COUNT_HW_ICACHE_MISSES , PERF_COUNT_HW_BRANCH_INSTRUCTIONS ,   PERF_COUNT_HW_BRANCH_MISSES , PERF_COUNT_HW_MAX }
enum	PmuTimedId { PERF_COUNT_CPU_CLOCK = 0 , PERF_COUNT_CPU_CLOCK = 0 }
enum	PmuSwId {   PERF_COUNT_SW_TASK_SWITCH = 1 , PERF_COUNT_SW_IRQ_RESPONSE , PERF_COUNT_SW_MEM_ALLOC , PERF_COUNT_SW_MUX_PEND ,   PERF_COUNT_SW_MAX , PERF_COUNT_SW_TASK_SWITCH = 1 , PERF_COUNT_SW_IRQ_RESPONSE , PERF_COUNT_SW_MEM_ALLOC ,   PERF_COUNT_SW_MUX_PEND , PERF_COUNT_SW_MAX }
enum	PerfSampleType {   PERF_RECORD_CPU = 1U << 0 , PERF_RECORD_TID = 1U << 1 , PERF_RECORD_TYPE = 1U << 2 , PERF_RECORD_PERIOD = 1U << 3 ,   PERF_RECORD_TIMESTAMP = 1U << 4 , PERF_RECORD_IP = 1U << 5 , PERF_RECORD_CALLCHAIN = 1U << 6 , PERF_RECORD_PID = 1U << 7 ,   PERF_RECORD_CPU = 1U << 0 , PERF_RECORD_TID = 1U << 1 , PERF_RECORD_TYPE = 1U << 2 , PERF_RECORD_PERIOD = 1U << 3 ,   PERF_RECORD_TIMESTAMP = 1U << 4 , PERF_RECORD_IP = 1U << 5 , PERF_RECORD_CALLCHAIN = 1U << 6 , PERF_RECORD_PID = 1U << 7 }

函数
UINT32	LOS_PerfInit (VOID *buf, UINT32 size)
	Init perf. 更多...
VOID	LOS_PerfStart (UINT32 sectionId)
	Start perf sampling. 更多...
VOID	LOS_PerfStop (VOID)
	Stop perf sampling. 更多...
UINT32	LOS_PerfConfig (PerfConfigAttr *attr)
	Config perf parameters. 更多...
UINT32	LOS_PerfDataRead (CHAR *dest, UINT32 size)
	Read data from perf sample data buffer. 更多...
VOID	LOS_PerfNotifyHookReg (const PERF_BUF_NOTIFY_HOOK func)
	Register perf sample data buffer water mark hook function. 更多...
VOID	LOS_PerfFlushHookReg (const PERF_BUF_FLUSH_HOOK func)
	Register perf sample data buffer flush hook function. 更多...

详细描述

类型定义说明

PERF_BUF_FLUSH_HOOK

typedef VOID(* PERF_BUF_FLUSH_HOOK) (VOID *addr, UINT32 size)

Define the type of the perf sample data buffer flush hook function.

在文件 los_perf.h 第 94 行定义.

PERF_BUF_NOTIFY_HOOK

typedef VOID(* PERF_BUF_NOTIFY_HOOK) (VOID)

Define the type of the perf sample data buffer water mark hook function.

在文件 los_perf.h 第 87 行定义.

枚举类型说明

PerfEventType

enum PerfEventType

Perf types

枚举值
PERF_EVENT_TYPE_HW
PERF_EVENT_TYPE_TIMED
PERF_EVENT_TYPE_SW
PERF_EVENT_TYPE_RAW
PERF_EVENT_TYPE_MAX
PERF_EVENT_TYPE_HW
PERF_EVENT_TYPE_TIMED
PERF_EVENT_TYPE_SW
PERF_EVENT_TYPE_RAW
PERF_EVENT_TYPE_MAX

在文件 los_perf.h 第 180 行定义.

                   {
    PERF_EVENT_TYPE_HW,      /* boards common hw events */
    PERF_EVENT_TYPE_TIMED,   /* hrtimer timed events */
    PERF_EVENT_TYPE_SW,      /* software trace events */
    PERF_EVENT_TYPE_RAW,     /* boards special hw events, see enum PmuEventType in corresponding arch headfile */
 
    PERF_EVENT_TYPE_MAX
};

PerfSampleType

enum PerfSampleType

perf sample data types Config it through PerfConfigAttr->sampleType.

枚举值
PERF_RECORD_CPU
PERF_RECORD_TID
PERF_RECORD_TYPE
PERF_RECORD_PERIOD
PERF_RECORD_TIMESTAMP
PERF_RECORD_IP
PERF_RECORD_CALLCHAIN
PERF_RECORD_PID
PERF_RECORD_CPU
PERF_RECORD_TID
PERF_RECORD_TYPE
PERF_RECORD_PERIOD
PERF_RECORD_TIMESTAMP
PERF_RECORD_IP
PERF_RECORD_CALLCHAIN
PERF_RECORD_PID

在文件 los_perf.h 第 232 行定义.

                    {
    PERF_RECORD_CPU       = 1U << 0, /* record current cpuid */
    PERF_RECORD_TID       = 1U << 1, /* record current task id */
    PERF_RECORD_TYPE      = 1U << 2, /* record event type */
    PERF_RECORD_PERIOD    = 1U << 3, /* record event period */
    PERF_RECORD_TIMESTAMP = 1U << 4, /* record timestamp */
    PERF_RECORD_IP        = 1U << 5, /* record instruction pointer */
    PERF_RECORD_CALLCHAIN = 1U << 6, /* record backtrace */
    PERF_RECORD_PID       = 1U << 7, /* record current process id */
};

PerfStatus

enum PerfStatus

Perf status.

枚举值
PERF_UNINIT
PERF_STARTED
PERF_STOPPED

在文件 los_perf.h 第 76 行定义.

                {
    PERF_UNINIT,   /* perf isn't inited */
    PERF_STARTED,  /* perf is started */
    PERF_STOPPED,  /* perf is stopped */
};

PmuHwId

enum PmuHwId

Common hardware pmu events

枚举值
PERF_COUNT_HW_CPU_CYCLES
PERF_COUNT_HW_INSTRUCTIONS
PERF_COUNT_HW_DCACHE_REFERENCES
PERF_COUNT_HW_DCACHE_MISSES
PERF_COUNT_HW_ICACHE_REFERENCES
PERF_COUNT_HW_ICACHE_MISSES
PERF_COUNT_HW_BRANCH_INSTRUCTIONS
PERF_COUNT_HW_BRANCH_MISSES
PERF_COUNT_HW_MAX
PERF_COUNT_HW_CPU_CYCLES
PERF_COUNT_HW_INSTRUCTIONS
PERF_COUNT_HW_DCACHE_REFERENCES
PERF_COUNT_HW_DCACHE_MISSES
PERF_COUNT_HW_ICACHE_REFERENCES
PERF_COUNT_HW_ICACHE_MISSES
PERF_COUNT_HW_BRANCH_INSTRUCTIONS
PERF_COUNT_HW_BRANCH_MISSES
PERF_COUNT_HW_MAX

在文件 los_perf.h 第 193 行定义.

             {
    PERF_COUNT_HW_CPU_CYCLES = 0,      /* cpu cycle event */
    PERF_COUNT_HW_INSTRUCTIONS,        /* instruction event */
    PERF_COUNT_HW_DCACHE_REFERENCES,   /* dcache access event */
    PERF_COUNT_HW_DCACHE_MISSES,       /* dcache miss event */
    PERF_COUNT_HW_ICACHE_REFERENCES,   /* icache access event */
    PERF_COUNT_HW_ICACHE_MISSES,       /* icache miss event */
    PERF_COUNT_HW_BRANCH_INSTRUCTIONS, /* software change of pc event */
    PERF_COUNT_HW_BRANCH_MISSES,       /* branch miss event */
 
    PERF_COUNT_HW_MAX,
};

PmuSwId

enum PmuSwId

Common software pmu events

枚举值
PERF_COUNT_SW_TASK_SWITCH
PERF_COUNT_SW_IRQ_RESPONSE
PERF_COUNT_SW_MEM_ALLOC
PERF_COUNT_SW_MUX_PEND
PERF_COUNT_SW_MAX
PERF_COUNT_SW_TASK_SWITCH
PERF_COUNT_SW_IRQ_RESPONSE
PERF_COUNT_SW_MEM_ALLOC
PERF_COUNT_SW_MUX_PEND
PERF_COUNT_SW_MAX

在文件 los_perf.h 第 218 行定义.

             {
    PERF_COUNT_SW_TASK_SWITCH = 1, /* task switch event */
    PERF_COUNT_SW_IRQ_RESPONSE,    /* irq response event */
    PERF_COUNT_SW_MEM_ALLOC,       /* memory alloc event */
    PERF_COUNT_SW_MUX_PEND,        /* mutex pend event */
 
    PERF_COUNT_SW_MAX,
};

PmuTimedId

enum PmuTimedId

Common hrtimer timed events

枚举值
PERF_COUNT_CPU_CLOCK
PERF_COUNT_CPU_CLOCK

在文件 los_perf.h 第 210 行定义.

                {
    PERF_COUNT_CPU_CLOCK = 0,      /* hrtimer timed event */
};

函数说明

LOS_PerfConfig()

UINT32 LOS_PerfConfig

(

PerfConfigAttr *

attr

)

Config perf parameters.

Description

Config perf parameters before sample, for example, sample event, sample task, etc. This interface need to be called before LOS_PerfStart.

注意

None.

参数

attr	[IN] Address of a perf event attr struct.

返回值

#LOS_ERRNO_PERF_STATUS_INVALID	Perf in a wrong status.
#LOS_ERRNO_PERF_CONFIG_NULL	Attr is NULL.
#LOS_ERRNO_PERF_INVALID_PMU	Config perf pmu with error type.
#LOS_ERRNO_PERF_PMU_CONFIG_ERROR	Config perf events fail with invalid event id or event period.
#LOS_OK	Config success.

Dependency:

• los_perf.h: the header file that contains the API declaration.

在文件 los_perf.c 第 424 行定义.

{
    UINT32 ret;
    UINT32 intSave;
 
    if (attr == NULL) {
        return LOS_ERRNO_PERF_CONFIG_NULL;
    }
 
    PERF_LOCK(intSave);
    if (g_perfCb.status != PERF_STOPPED) {
        ret = LOS_ERRNO_PERF_STATUS_INVALID;
        PRINT_ERR("perf config status error : 0x%x\n", g_perfCb.status);
        goto PERF_CONFIG_ERROR;
    }
 
    g_pmu = NULL;
 
    g_perfCb.needSample = attr->needSample;
    g_perfCb.sampleType = attr->sampleType;
 
    OsPerfSetFilterIds(g_perfCb.taskIds, &g_perfCb.taskIdsNr, attr->taskIds, attr->taskIdsNr);
    OsPerfSetFilterIds(g_perfCb.processIds, &g_perfCb.processIdsNr, attr->processIds, attr->processIdsNr);
 
    ret = OsPerfConfig(&attr->eventsCfg);
    PerfInfoDump();
PERF_CONFIG_ERROR:
    PERF_UNLOCK(intSave);
    return ret;
}

函数调用图:

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

LOS_PerfDataRead()

UINT32 LOS_PerfDataRead	(	CHAR *	dest,
		UINT32	size
	)

Read data from perf sample data buffer.

Description

Because perf sample data buffer is a ringbuffer, the data may be covered after user read ringbuffer.

注意

None.

参数

dest	[IN] The destination address.
size	[IN] Read size.

返回值

UINT32

The really read bytes.

Dependency:

• los_perf.h: the header file that contains the API declaration.

在文件 los_perf.c 第 514 行定义.

{
    return OsPerfOutputRead(dest, size);
}

函数调用图:

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

LOS_PerfFlushHookReg()

VOID LOS_PerfFlushHookReg

(

const PERF_BUF_FLUSH_HOOK

func

)

Register perf sample data buffer flush hook function.

Description

• Register perf sample data buffer flush hook function.
• The flush hook will be called when the buffer be read or written.

注意

None.

参数

func	[IN] Buffer flush hook function.

返回值

None.

Dependency:

• los_perf.h: the header file that contains the API declaration.

在文件 los_perf.c 第 528 行定义.

{
    UINT32 intSave;
 
    PERF_LOCK(intSave);
    OsPerfFlushHookReg(func);
    PERF_UNLOCK(intSave);
}

函数调用图:

LOS_PerfInit()

UINT32 LOS_PerfInit	(	VOID *	buf,
		UINT32	size
	)

Init perf.

Description:

• Used to initialize the perf module, including initializing the PMU, allocating memory, etc.,which is called during the phase of system initialization.

注意

• If buf is not NULL, user must ensure size is not bigger than buf's length.

参数

buf	[IN] Pointer of sample data buffer;Use the dynamically allocated memory if the pointer is NULL.
size	[IN] Length of sample data buffer.

返回值

#LOS_ERRNO_PERF_STATUS_INVALID	Perf in a wrong status.
#LOS_ERRNO_PERF_HW_INIT_ERROR	Perf hardware pmu init fail.
#LOS_ERRNO_PERF_TIMED_INIT_ERROR	Perf timed pmu init fail.
#LOS_ERRNO_PERF_SW_INIT_ERROR	Perf software pmu init fail.
#LOS_ERRNO_PERF_BUF_ERROR	Perf buffer init fail.
#LOS_OK	Perf init success.

Dependency:

• los_perf.h: the header file that contains the API declaration.

LOS_PerfNotifyHookReg()

VOID LOS_PerfNotifyHookReg

(

const PERF_BUF_NOTIFY_HOOK

func

)

Register perf sample data buffer water mark hook function.

Description

• Register perf sample data buffer water mark hook function.
• The registered hook will be called when buffer reaches the water mark./li>

注意

None.

参数

func	[IN] Buffer water mark hook function.

返回值

None.

Dependency:

• los_perf.h: the header file that contains the API declaration.

在文件 los_perf.c 第 519 行定义.

{
    UINT32 intSave;
 
    PERF_LOCK(intSave);
    OsPerfNotifyHookReg(func);
    PERF_UNLOCK(intSave);
}

函数调用图:

LOS_PerfStart()

VOID LOS_PerfStart

(

UINT32

sectionId

)

Start perf sampling.

Description

Start perf sampling.

注意

None.

参数

sectionId

[IN] Set the section id for marking this piece of data in the perf sample data buffer.

返回值

None.

Dependency:

• los_perf.h: the header file that contains the API declaration.

在文件 los_perf.c 第 455 行定义.

{
    UINT32 intSave;
    UINT32 ret;
 
    PERF_LOCK(intSave);
    if (g_perfCb.status != PERF_STOPPED) {
        PRINT_ERR("perf start status error : 0x%x\n", g_perfCb.status);
        goto PERF_START_ERROR;
    }
 
    if (!OsPerfParamValid()) {
        PRINT_ERR("forgot call `LOS_PerfConfig(...)` before perf start?\n");
        goto PERF_START_ERROR;
    }
 
    if (g_perfCb.needSample) {
        ret = OsPerfHdrInit(sectionId); /* section header init */
        if (ret != LOS_OK) {
            PRINT_ERR("perf hdr init error 0x%x\n", ret);
            goto PERF_START_ERROR;
        }
    }
 
    SMP_CALL_PERF_FUNC(OsPerfStart); /* send to all cpu to start pmu */
    g_perfCb.status = PERF_STARTED;
    g_perfCb.startTime = OsPerfGetCurrTime();
PERF_START_ERROR:
    PERF_UNLOCK(intSave);
    return;
}

函数调用图:

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

LOS_PerfStop()

VOID LOS_PerfStop

(

VOID

)

Stop perf sampling.

Description

Stop perf sampling.

注意

None.

参数

None.

返回值

None.

Dependency:

• los_perf.h: the header file that contains the API declaration.

在文件 los_perf.c 第 487 行定义.

{
    UINT32 intSave;
 
    PERF_LOCK(intSave);
    if (g_perfCb.status != PERF_STARTED) {
        PRINT_ERR("perf stop status error : 0x%x\n", g_perfCb.status);
        goto PERF_STOP_ERROR;
    }
 
    SMP_CALL_PERF_FUNC(OsPerfStop); /* send to all cpu to stop pmu */
 
    OsPerfOutputFlush();
 
    if (g_perfCb.needSample) {
        OsPerfOutputInfo();
    }
 
    g_perfCb.status = PERF_STOPPED;
    g_perfCb.endTime = OsPerfGetCurrTime();
 
    OsPerfPrintTs();
PERF_STOP_ERROR:
    PERF_UNLOCK(intSave);
    return;
}

函数调用图:

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