hiperf

hiperf为开发人员提供用于调试的命令行工具，用于抓取特定程序或者系统的性能数据，类似内核的perf工具，该工具支持在 Windows/Linux/Mac 等操作系统上运行。

环境要求

• 根据hdc命令行工具指导，完成环境准备。

• 确保设备已正常连接，并执行hdc shell。

hiperf命令行说明

帮助命令

可用 –help 查看帮助。

hiperf --help

使用样例：

$ hiperf --help
Usage: hiperf [options] command [args for command]
options:
        --debug                 show debug log, usage format: --debug [command] [args]
        --help                  show help
        --hilog                 use hilog not file to record log
        --logpath               log file name full path, usage format: --logpath [filepath] [command] [args]
        --logtag                enable log level for HILOG_TAG, usage format: --logtag <tag>[:level][,<tag>[:level]] [command] [args]
                                tag: Dump, Report, Record, Stat... level: D, V, M...
                                example: hiperf --verbose --logtag Record:D [command] [args]
        --mixlog                mix the log in output, usage format: --much [command] [args]
        --much                  show extremely much debug log, usage format: --much [command] [args]
        --nodebug               disable debug log, usage format: --nodebug [command] [args]
        --verbose               show debug log, usage format: --verbose [command] [args]
        -h                      show help
command:
        dump:   Dump content of a perf data file, like perf.data
        help:   Show more help information for hiperf
        list:   List the supported event types.
        record: Collect performance sample information
        report: report sampling information from perf.data format file
        stat:   Collect performance counter information

See 'hiperf help [command]' for more information on a specific command.

使用如下命令查看子功能的帮助信息。

Usage: hiperf [command] --help

list命令

可列出设备上支持的所有事件名称，事件名称用于 stat 和 record 的 -e 和 -g 参数。

list命令参数说明

Usage: hiperf list [event type name]

使用help命令查询支持的事件类型。

hiperf list --help

使用样例：

$ hiperf list --help
Usage: hiperf list [event type name]
       List all supported event types on this devices.
   To list the events of a specific type, specify the type name
       hw          hardware events
       sw          software events
       tp          tracepoint events
       cache       hardware cache events
       raw         raw pmu events

下面列出了设备支持的HW事件，并且会提示哪些事件此设备不支持。

hiperf list hw

使用样例：

$ hiperf list hw
event not support hw-ref-cpu-cycles

Supported events for hardware:
        hw-cpu-cycles
        hw-instructions
        hw-cache-references
        hw-cache-misses
        hw-branch-instructions
        hw-branch-misses
        hw-bus-cycles
        hw-stalled-cycles-frontend
        hw-stalled-cycles-backend

record命令

采样指定目标程序，并且将采样数据保存到指定的文件中(默认为/data/local/tmp/perf.data)。

record命令参数说明

Usage: hiperf record [options] [command [command-args]]

对指定的PID为1273的进程采样10秒，并且使用dwarf回栈。

hiperf record -p 1273 -d 10 -s dwarf

使用样例：

$ hiperf record -p 1273 -d 10 -s dwarf
Profiling duration is 10.000 seconds.
Start Profiling...
Timeout exit (total 10000 ms)
Process and Saving data...
/proc/sys/kernel/kptr_restrict is NOT 0, will try set it to 0.
[ hiperf record: Captured 0.297 MB perf data. ]
[ Sample records: 97, Non sample records: 2426 ]
[ Sample lost: 0, Non sample lost: 0 ]

stat命令

监听指定目标程序，周期性打印性能计数器的值。

stat命令参数说明

Usage: hiperf stat [options] [command [command-args]]

下面展示了一个 stats 监听1273进程在CPU0上3秒的性能计数器命令。

hiperf stat -p 1273 -d 3 -c 0

使用样例：

$ hiperf stat -p 1273 -d 3 -c 0
Profiling duration is 3.000 seconds.
Start Profiling...
Timeout exit (total 3000 ms)
                    count  name                         |comment                        |coverage
                      521  hw-branch-instructions       |                               |(9%)
                      217  hw-branch-misses             |                               |(9%)
                   32,491  hw-cpu-cycles                |                               |(9%)
                    4,472  hw-instructions              |                               |(9%)
                        1  sw-context-switches          |                               |(9%)
                        0  sw-page-faults               |                               |(9%)
                   39,083  sw-task-clock                |0.000143 cpus used             |(9%)

dump命令

此命令主要以不加以处理的方式直接读取perf.data的数据，开发和测试人员可核对其中原始采样数据的正确性。

dump命令参数说明

Usage: hiperf dump [option] \<filename\>

使用dump命令将/data/local/tmp/perf.data文件读取出来，输出到/data/local/tmp/perf.dump文件中。

hiperf dump -i /data/local/tmp/perf.data -o /data/local/tmp/perf.dump

使用样例：

$ hiperf dump -i /data/local/tmp/perf.data -o /data/local/tmp/perf.dump
dump result will save at '/data/local/tmp/perf.dump'

report命令

此命令主要用于展示相关采样数据（从perf.data中读取）并且转换为用户需要的格式（比如Json或者ProtoBuf）。

report命令参数说明

Usage: hiperf report [option] \<filename\>

范例输出普通报告的命令，限制为占比不超过1%。

hiperf report --limit-percent 1

脚本

一般用户用脚本执行采样操作，可生成可视化的火焰图。工具可在developtools_hiperf仓库中获取。

1. 采样。

由 command_script.py 完成，它是 report 命令的包装脚本。

   usage: command_script.py [-h]
                            (-app PACKAGE_NAME|-lp LOCAL_PROGRAM|-cmd CMD|-p [PID [PID ...]]|-t [TID [TID ...]]|-sw)
                            [-a ABILITY] [-r RECORD_OPTIONS] [-lib LOCAL_LIB_DIR]
                            [-o OUTPUT_PERF_DATA] [--not_hdc_root]

对指定包名采样，包名是 com.ohos.launch。

   python command_script.py -app com.ohos.launch

对特定进程采样，进程名称是 hdcd。

   python command_script.py -lp hdcd

1. 收集符号表。

由 recv_binary_cache.py 完成，它主要根据 perf.data 里面记录的相关文件和库以及它们的 buildid， 在用户指定的路径中去寻找对应的 ELF 作为符号表文件用于回栈或者打印函数名等。

   usage: recv_binary_cache.py [-h] [-i PERF_DATA] [-l LOCAL_LIB_DIR [LOCAL_LIB_DIR ...]]

指定了2个符号表路径的位置。

   python recv_binary_cache.py -l Z:\OHOS_MASTER\out\ohos-arm-release\lib.unstripped  Z:\OHOS_MASTER\out\ohos-arm-release\exe.unstripped

对应的符号表文件会复制到 binary_cache 文件夹，优先检查用户给出的符号表位置，如果没有则复制设备中的文件。

1. 生成火焰图。

由 make_report.py 完成，将采样后的数据导出为HTML展示页面。

   usage: make_report.py [-h] [-i PERF_DATA] [-r REPORT_HTML]

产生HTML文件，默认的文件名是 hiperf_report.html。

   python make_report.py -i perf.data

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Performance Analysis Kit（性能分析服务）

harmony 鸿蒙分析AppFreeze（应用无响应）

harmony 鸿蒙应用恢复开发指导

harmony 鸿蒙分析CppCrash（进程崩溃）

harmony 鸿蒙错误管理开发指导

harmony 鸿蒙hdc

harmony 鸿蒙事件上报

harmony 鸿蒙HiAppEvent介绍

harmony 鸿蒙订阅踩内存事件（ArkTS）

harmony 鸿蒙订阅踩内存事件（C/C++）