# Perf调测 ## 基本概念 Perf为性能分析工具，依赖PMU（Performance Monitoring Unit）对采样事件进行计数和上下文采集，统计出热点分布（hot spot）和热路径（hot path）。 ## 运行机制基于事件采样原理，以性能事件为基础，当事件发生时，相应的事件计数器溢出发生中断，在中断处理函数中记录事件信息，包括当前的pc、当前运行的任务ID以及调用栈等信息。 Perf提供2种工作模式，计数模式和采样模式。计数模式仅统计事件发生的次数和耗时，采样模式会收集上下文数据到环形buffer中，需要IDE进行数据解析生成热点函数与热点路径。 ## 接口说明 ### 内核态 OpenHarmony LiteOS-A内核的Perf模块提供下面几种功能，接口详细信息可以查看[API](https://gitee.com/openharmony/kernel_liteos_a/blob/master/kernel/include/los_perf.h)参考。 **表1** Perf模块接口说明 | 功能分类 | 接口描述 | | -------- | -------- | | 开启/停止Perf采样 | LOS_PerfInit : 初始化Perf
LOS_PerfStart：开启采样
LOS_PerfStop：停止采样 | | 配置Perf采样事件 | LOS_PerfConfig：配置采样事件的类型、周期等 | | 读取采样数据 | LOS_PerfDataRead：读取采样数据到指定地址 | | 注册采样数据缓冲区的钩子函数 | LOS_PerfNotifyHookReg：注册缓冲区水线到达的处理钩子
LOS_PerfFlushHookReg：注册缓冲区刷cache的钩子 | 1. Perf采样事件的结构体为PerfConfigAttr，详细字段含义及取值详见 [kernel\include\los_perf.h](https://gitee.com/openharmony/kernel_liteos_a/blob/master/kernel/include/los_perf.h) 。 2. 采样数据缓冲区为环形buffer，buffer中读过的区域可以覆盖写，未被读过的区域不能被覆盖写。 3. 缓冲区有限，用户可通过注册水线到达的钩子进行buffer溢出提醒或buffer读操作。默认水线值为buffer总大小的1/2。示例如下： ```c VOID Example_PerfNotifyHook(VOID) { CHAR buf[LOSCFG_PERF_BUFFER_SIZE] = {0}; UINT32 len; PRINT_DEBUG("perf buffer reach the waterline!\n"); len = LOS_PerfDataRead(buf, LOSCFG_PERF_BUFFER_SIZE); OsPrintBuff(buf, len); /* print data */ } LOS_PerfNotifyHookReg(Example_PerfNotifyHook); ``` 4. 若perf采样的buffer涉及到CPU跨cache，则用户可通过注册刷cache的钩子，进行cache同步。示例如下： ```c VOID Example_PerfFlushHook(VOID *addr, UINT32 size) { OsCacheFlush(addr, size); /* platform interface */ } LOS_PerfNotifyHookReg(Example_PerfFlushHook); ``` 刷cache接口视具体的平台自行配置。 ### 用户态新增perf字符设备，位于"/dev/perf",通过对设备节点的read\write\ioctl，实现用户态perf的读写和控制： - read: 用户态读取perf记录数据 - write: 用户态采样事件配置 - ioctl: 用户态Perf控制操作，包括 ```c #define PERF_IOC_MAGIC 'T' #define PERF_START _IO(PERF_IOC_MAGIC, 1) #define PERF_STOP _IO(PERF_IOC_MAGIC, 2) ``` 分别对应Perf启动(LOS_PerfStart)、停止(LOS_PerfStop) 具体的使用方法参见[用户态编程实例](#用户态编程实例)。 ## 开发指导 ### 内核态开发流程开启Perf调测的典型流程如下： 1. 配置Perf模块相关宏。配置Perf控制宏LOSCFG_KERNEL_PERF，默认关，在kernel/liteos_a目录下执行 make update_config命令配置"Kernel->Enable Perf Feature"中打开： | 配置项 | menuconfig选项 | 含义 | 设置值 | | -------- | -------- | -------- | -------- | | LOSCFG_KERNEL_PERF | Enable Perf Feature | Perf模块的裁剪开关 | YES/NO | | LOSCFG_PERF_CALC_TIME_BY_TICK | Time-consuming Calc Methods->By Tick | Perf计时单位为tick | YES/NO | | LOSCFG_PERF_CALC_TIME_BY_CYCLE | Time-consuming Calc Methods->By Cpu Cycle | Perf计时单位为cycle | YES/NO | | LOSCFG_PERF_BUFFER_SIZE | Perf Sampling Buffer Size | Perf采样buffer的大小 | INT | | LOSCFG_PERF_HW_PMU | Enable Hardware Pmu Events for Sampling | 使能硬件PMU事件，需要目标平台支持硬件PMU | YES/NO | | LOSCFG_PERF_TIMED_PMU | Enable Hrtimer Period Events for Sampling | 使能高精度周期事件，需要目标平台支持高精度定时器 | YES/NO | | LOSCFG_PERF_SW_PMU | Enable Software Events for Sampling | 使能软件事件，需要开启LOSCFG_KERNEL_HOOK | YES/NO | 2. 调用LOS_PerfConfig配置需要采样的事件。 Perf提供2种模式的配置，及3大类型的事件配置： 2种模式：计数模式（仅统计事件发生次数）、采样模式（收集上下文如任务ID、pc、backtrace等）。 3种事件类型：CPU硬件事件（cycle、branch、icache、dcache等）、高精度周期事件（cpu clock)、OS软件事件（task switch、mux pend、irq等）。 3. 在需要采样的代码起始点调用LOS_PerfStart(UINT32 sectionId), 入参sectionId标记不同的采样回话id。 4. 在需要采样的代码结束点调用LOS_PerfStop。 5. 调用输出缓冲区数据的接口LOS_PerfDataRead读取采样数据，并使用IDE工具进行解析。 #### 内核态编程实例本实例实现如下功能： 1. 创建perf测试任务。 2. 配置采样事件。 3. 启动perf。 4. 执行需要统计的算法。 5. 停止perf。 6. 输出统计结果。 #### 内核态示例代码前提条件：在menuconfig菜单中完成perf模块的配置。该示例代码的测试函数可以加在 kernel /liteos_a/testsuites /kernel /src /osTest.c 中的 TestTaskEntry 中进行测试。实例代码如下： ```c #include "los_perf.h" STATIC VOID OsPrintBuff(const CHAR *buf, UINT32 num) { UINT32 i = 0; PRINTK("num: "); for (i = 0; i < num; i++) { PRINTK(" %02d", i); } PRINTK("\n"); PRINTK("hex: "); for (i = 0; i < num; i++) { PRINTK(" %02x", buf[i]); } PRINTK("\n"); } STATIC VOID perfTestHwEvent(VOID) { UINT32 ret; CHAR *buf = NULL; UINT32 len; PerfConfigAttr attr = { .eventsCfg = { .type = PERF_EVENT_TYPE_HW, .events = { [0] = {PERF_COUNT_HW_CPU_CYCLES, 0xFFFF}, [1] = {PERF_COUNT_HW_BRANCH_INSTRUCTIONS, 0xFFFFFF00}, }, .eventsNr = 2, .predivided = 1, /* cycle counter increase every 64 cycles */ }, .taskIds = {0}, .taskIdsNr = 0, .needSample = 0, .sampleType = PERF_RECORD_IP | PERF_RECORD_CALLCHAIN, }; ret = LOS_PerfConfig(&attr); if (ret != LOS_OK) { PRINT_ERR("perf config error %u\n", ret); return; } PRINTK("------count mode------\n"); LOS_PerfStart(0); test(); /* this is any test function*/ LOS_PerfStop(); PRINTK("--------sample mode------ \n"); attr.needSample = 1; LOS_PerfConfig(&attr); LOS_PerfStart(2); // 2: set the section id to 2. test(); /* this is any test function*/ LOS_PerfStop(); buf = LOS_MemAlloc(m_aucSysMem1, LOSCFG_PERF_BUFFER_SIZE); if (buf == NULL) { PRINT_ERR("buffer alloc failed\n"); return; } /* get sample data */ len = LOS_PerfDataRead(buf, LOSCFG_PERF_BUFFER_SIZE); OsPrintBuff(buf, len); /* print data */ (VOID)LOS_MemFree(m_aucSysMem1, buf); } UINT32 Example_Perf_test(VOID) { UINT32 ret; TSK_INIT_PARAM_S perfTestTask; /* 创建用于perf测试的任务 */ memset(&perfTestTask, 0, sizeof(TSK_INIT_PARAM_S)); perfTestTask.pfnTaskEntry = (TSK_ENTRY_FUNC)perfTestHwEvent; perfTestTask.pcName = "TestPerfTsk"; /* 测试任务名称 */ perfTestTask.uwStackSize = 0x800; // 0x8000: perf test task stack size perfTestTask.usTaskPrio = 5; // 5: perf test task priority perfTestTask.uwResved = LOS_TASK_STATUS_DETACHED; ret = LOS_TaskCreate(&g_perfTestTaskId, &perfTestTask); if (ret != LOS_OK) { PRINT_ERR("PerfTestTask create failed.\n"); return LOS_NOK; } return LOS_OK; } LOS_MODULE_INIT(perfTestHwEvent, LOS_INIT_LEVEL_KMOD_EXTENDED); ``` #### 内核态结果验证输出结果如下： ``` --------count mode---------- [EMG] [cycles] eventType: 0xff: 5466989440 [EMG] [branches] eventType: 0xc: 602166445 ------- sample mode---------- [EMG] dump section data, addr: 0x8000000 length: 0x800000 num: 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 ... hex: 00 ef ef ef 00 00 00 00 14 00 00 00 60 00 00 00 00 00 00 00 70 88 36 40 08 00 00 00 6b 65 72 6e 65 6c 00 00 01 00 00 00 cc 55 30 40 08 00 00 00 6b 65 72 6e 65 6c 00 00 ``` - 针对计数模式，系统在perf stop后会打印：事件名称（cycles)、事件类型（0xff)、事件发生的次数（5466989440）。当采样事件为硬件PMU事件时，打印的事件类型为实际的硬件事件id，非enum PmuHWId中定义的抽象类型。 - 针对采样模式，系统在perf stop后会打印采样数据的地址和长度： dump section data, addr: （0x8000000） length: （0x5000）用户可以通过JTAG口导出该片内存，再使用IDE线下工具解析。或者通过LOS_PerfDataRead将数据读到指定地址，进行查看或进一步处理。示例中OsPrintBuff为测试接口，其按字节打印Read到的采样数据，num表示第几个字节，hex表示该字节中的数值。 ### 用户态开发流程通过在menuconfig配置"Driver->Enable PERF DRIVER",开启Perf驱动。该配置仅在内核Enable Perf Feature后，才可在Driver的选项中可见。 1. 打开“/dev/perf”字符文件，进行读写和IOCTL操作； 2. 系统提供用户态的perf命令，该命令位于/bin目录下，cd bin 后可执行如下命令： - ./perf start [id] 启动perf采样, id 为可选项，默认值为0 - ./perf stop 停止perf采样 - ./perf read <nBytes> 从采样缓冲区中读取nBytes数据并打印内容 - ./perf list 罗列-e支持的具体事件 - ./perf stat/record [option] <command> 计数/采样模式命令 - option可选如下： - -e，配置采样事件。可使用./perf list 中罗列的同类型事件。 - -p，配置事件采样周期。 - -o，指定perf采样数据结果保存的文件路径。 - -t，任务Id过滤（白名单），只采取指定任务中的上下文。如果不指定改参数，则默认采集所有的任务。 - -s，配置采样的具体上下文类型，可查阅los_perf.h中定义的PerfSampleType。 - -P，进程Id过滤（白名单），只采取指定进程中的上下文。如果不指定改参数，则默认采集所有进程。 - -d，是否进行分频（事件每发生64次累计+1），该选项仅在硬件cycle事件上生效。 - command 为待统计的子程序。用户态命令行的典型使用方法如下: ./perf list 查看可使用的事件列表，输出如下： ``` cycles [Hardware event] instruction [Hardware event] dcache [Hardware event] dcache-miss [Hardware event] icache [Hardware event] icache-miss [Hardware event] branch [Hardware event] branch-miss [Hardware event] clock [Timed event] task-switch [Software event] irq-in [Software event] mem-alloc [Software event] mux-pend [Software event] ``` ./perf stat -e cycles os_dump，输出如下： ``` type: 0 events[0]: 255, 0xffff predivided: 0 sampleType: 0x0 needSample: 0 usage os_dump [--help | -l | SERVICE] --help: shows this help -l: only list services, do not dump them SERVICE: dumps only service SERVICE time used: 0.058000(s) [cycles] eventType: 0xff [core 0]: 21720647 [cycles] eventType: 0xff [core 1]: 13583830 ``` ./perf record -e cycles os_dump, 输出如下： ``` type: 0 events[0]: 255, 0xffff predivided: 0 sampleType: 0x60 needSample: 1 usage os_dump [--help | -l | SERVICE] --help: shows this help -l: only list services, do not dump them SERVICE: dumps only service SERVICE dump perf data, addr: 0x408643d8 length: 0x5000 time used: 0.059000(s) save perf data success at /storage/data/perf.data ``` > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 在进行./perf stat/record命令后，用户可多次执行./perf start 和 ./perf stop进行采样，采样的事件配置为最近一次执行./perfstat/record 中设置的参数。 #### 用户态编程实例本实例实现如下功能： 1. 打开perf字符设备。 2. 写perf配置事件。 3. 启动perf。 4. 停止perf。 5. 读取perf采样数据。 #### 用户态示例代码实例代码如下： ```c #include "fcntl.h" #include "user_copy.h" #include "sys/ioctl.h" #include "fs/driver.h" #include "los_dev_perf.h" #include "los_perf.h" #include "los_init.h" /* perf ioctl */ #define PERF_IOC_MAGIC 'T' #define PERF_START _IO(PERF_IOC_MAGIC, 1) #define PERF_STOP _IO(PERF_IOC_MAGIC, 2) int main(int argc, char **argv) { char *buf = NULL; ssize_t len; int fd = open("/dev/perf", O_RDWR); if (fd == -1) { printf("Perf open failed.\n"); exit(EXIT_FAILURE); } PerfConfigAttr attr = { .eventsCfg = { #ifdef LOSCFG_PERF_HW_PMU .type = PERF_EVENT_TYPE_HW, .events = { [0] = {PERF_COUNT_HW_CPU_CYCLES, 0xFFFF}, }, #elif defined LOSCFG_PERF_TIMED_PMU .type = PERF_EVENT_TYPE_TIMED, .events = { [0] = {PERF_COUNT_CPU_CLOCK, 100}, }, #elif defined LOSCFG_PERF_SW_PMU .type = PERF_EVENT_TYPE_SW, .events = { [0] = {PERF_COUNT_SW_TASK_SWITCH, 1}, }, #endif .eventsNr = 1, /* 1 event */ .predivided = 0, }, .taskIds = {0}, .taskIdsNr = 0, .processIds = {0}, .processIdsNr = 0, .needSample = 1, .sampleType = PERF_RECORD_IP | PERF_RECORD_CALLCHAIN, }; (void)write(fd, &attr, sizeof(PerfConfigAttr)); /* perf config */ ioctl(fd, PERF_START, NULL); /* perf start */ test(); ioctl(fd, PERF_STOP, NULL); /* perf stop */ buf = (char *)malloc(LOSCFG_PERF_BUFFER_SIZE); if (buf == NULL) { printf("no memory for read perf 0x%x\n", LOSCFG_PERF_BUFFER_SIZE); return -1; } len = read(fd, buf, LOSCFG_PERF_BUFFER_SIZE); OsPrintBuff(buf, len); /* print data */ free(buf); close(fd); return 0; } ``` #### 用户态结果验证输出结果如下 ``` [EMG] dump section data, addr: 0x8000000 length: 0x800000 num: 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 ... hex: 00 ef ef ef 00 00 00 00 14 00 00 00 60 00 00 00 00 00 00 00 70 88 36 40 08 00 00 00 6b 65 72 6e 65 6c 00 00 01 00 00 00 cc 55 30 40 08 00 00 00 6b 65 72 6e 65 6c 00 00 ```