簡介

性能調(diào)優(yōu)組件包含系統(tǒng)和應用調(diào)優(yōu)框架，旨在為開發(fā)者提供一套性能調(diào)優(yōu)平臺，可以用來分析內(nèi)存、性能等問題。

該組件整體分為PC端和設備端兩部分，PC端最終作為deveco studio的插件進行發(fā)布，內(nèi)部主要包括分為UI繪制、設備管理、進程管理、插件管理、數(shù)據(jù)導入、數(shù)據(jù)存儲、 數(shù)據(jù)分析、Session管理、配置管理等模塊；設備端主要包括命令行工具、服務進程、插件集合、應用程序組件等模塊。設備端提供了插件擴展能力，對外提供了插件接口，基于該擴展能力可以按需定義自己的能力，并集成到框架中來，目前基于插件能力已經(jīng)完成了實時內(nèi)存插件,trace插件。下文會重點對設備端提供的插件能力進行介紹。

架構(gòu)圖

說明

下面針對設備端對外提供的插件擴展能力進行接口和使用說明。

接口說明

下面是設備端插件模塊對外提供的接口：

• PluginModuleCallbacks為插件模塊對外提供的回調(diào)接口，插件管理模塊通過該回調(diào)接口列表與每一個插件模塊進行交互，每一個新增插件都需要實現(xiàn)該接口列表中的函數(shù)。

表 1 PluginModuleCallbacks接口列表

[]()

[]()[]()插件會話開始接口，開始插件會話時會被調(diào)用，用來下發(fā)插件配置

• 輸入?yún)?shù)：
  []()[]()configData：配置信息內(nèi)存塊起始地址
  []()[]()configSize：配置信息內(nèi)存塊字節(jié)數(shù)
• 返回值：
  []()[]()0：成功
  []()[]()-1：失敗 |
  | []()[]()PluginModuleCallbacks::onPluginReportResult | []()[]()int (PluginReportResultCallback)(uint8_t bufferData, uint32_t bufferSize); | []()[]()- 功能：
  []()[]()插件結(jié)果上報接口類型，當任務下發(fā)后，框架采集任務會周期性調(diào)用此接口請求回填數(shù)據(jù)
• 輸入?yún)?shù):
  []()[]()bufferData: 存放結(jié)果的內(nèi)存緩沖區(qū)起始地址
  []()[]()bufferSize: 存放結(jié)果的內(nèi)存緩沖區(qū)的字節(jié)數(shù)
• 返回值：
  []()[]()大于0：已經(jīng)填充的內(nèi)存字節(jié)數(shù)
  []()[]()等于0：沒有填充任何內(nèi)容
  []()[]()小于0：失敗 |
  | []()[]()PluginModuleCallbacks::onPluginSessionStop | []()[]()int (*PluginSessionStopCallback)(); | []()[]()- 功能：
  []()[]()采集會話結(jié)束接口
• 返回值：
  []()[]()0：成功
  []()[]()-1：失敗 |
  | []()[]()PluginModuleCallbacks::onRegisterWriterStruct | []()[]()int (RegisterWriterStructCallback)(WriterStruct writer); | []()[]()- 功能：
  []()[]()采集框架注冊寫數(shù)據(jù)接口，當插件管理模塊向插件注冊此接口，插件可以主動調(diào)用write句柄，進行寫入數(shù)據(jù)
• 輸入?yún)?shù)：
  []()[]()writer 寫者指針
• 返回值：
  []()[]()0：成功
  []()[]()-1：失敗 |
• WriterStruct是上面onRegisterWriterStruct接口中的參數(shù)，主要實現(xiàn)寫數(shù)據(jù)接口，將插件中采集的數(shù)據(jù)通過該接口進行寫入。

表 2 WriterStruct接口列表

[]()

[]()[]()寫接口，將插件中采集的數(shù)據(jù)通過writer進行寫入

• 輸入?yún)?shù)：
  []()[]()writer：寫者指針
  []()[]()data：數(shù)據(jù)緩沖區(qū)首字節(jié)指針
  []()[]()size: 數(shù)據(jù)緩沖區(qū)的字節(jié)數(shù)
• 返回值：
  []()[]()0：成功
  []()[]()-1：失敗 |
  | []()[]()WriterStruct::flush | []()[]()bool (FlushFuncPtr)(WriterStruct writer); | []()[]()- 功能：
  []()[]()觸發(fā)數(shù)據(jù)上傳接口
• 輸入?yún)?shù):
  []()[]()writer：寫者指針
• 返回值：
  []()[]()true：成功
  []()[]()false：失敗 |
• 下面是插件模塊對外提供的總?cè)肟?，主要包括?中的插件模塊回調(diào)函數(shù)以及插件名稱、插件模塊需要申請的內(nèi)存大小。

表 3 PluginModuleStruct接口列表

[]()

使用說明

下面介紹在設備端基于性能調(diào)優(yōu)框架提供的插件能力，新增一個插件涉及到的關鍵開發(fā)步驟：

1. 編寫proto數(shù)據(jù)定義文件_plugin_data.proto_，定義數(shù)據(jù)源格式，數(shù)據(jù)源格式?jīng)Q定了插件上報哪些數(shù)據(jù)：

   message PluginData {
       int32 pid = 1;
       string name = 2;
       uint64 count1 = 3;
       uint64 count2 = 4;
       uint64 count3 = 5;
       ......
   }
   

2. 編寫數(shù)據(jù)源配置文件_plugin_config.proto_，采集的行為可以根據(jù)配置進行變化，可以設置數(shù)據(jù)源上報間隔等信息：

   message PluginConfig {
       int32 pid = 1;
       bool report_interval = 2;
       int report_counter_id_1 = 3;
       int report_counter_id_2 = 4;
       ......
   }
   

3. 定義PluginModuleCallbacks實現(xiàn)插件回調(diào)接口；定義PluginModuleStruct類型的g_pluginModule全局變量，注冊插件信息。

   static PluginModuleCallbacks callbacks = {
       PluginSessionStart,
       PluginReportResult,
       PluginSessionStop,
   };
   PluginModuleStruct g_pluginModule = {&callbacks, "test-plugin", MAX_BUFFER_SIZE};
   

4. 通過PluginSessionStart（名字可以自己定義）實現(xiàn)插件回調(diào)接口列表的onPluginSessionStart接口，主要處理插件的開始流程。

   int PluginSessionStart(const uint8_t* configData, uint32_t configSize)
   {
       ......
       return 0;
   }
   

5. 通過PluginReportResult（名字可以自己定義）實現(xiàn)插件回調(diào)接口列表的onPluginReportResult接口，將插件內(nèi)部采集的信息通過該接口進行上報：

   int PluginReportResult(uint8_t* bufferData, uint32_t bufferSize)
   {
       ......
       return 0;
   }
   

6. 通過PluginSessionStop（名字可以自己定義）實現(xiàn)插件回調(diào)接口列表的onPluginSessionStop接口，主要進行插件停止后的操作流程。

   int PluginSessionStop()
   {
       ......
       return 0;
   }
   

7. 編寫proto gn構(gòu)建腳本, 生成protobuf源文件，protobuf源文件編譯生成目標文件:

   action("plugin_cpp_gen") {
     script = "${OHOS_PROFILER_DIR}/build/protoc.sh"  //依賴的編譯工具鏈
     sources = [   //定義的插件相關的proto文件，比如插件配置文件、插件數(shù)據(jù)對應的proto文件
       "plugin_data.proto",
       "plugin_config.proto",
     ]
     outputs = [    //通過protoc編譯生成的結(jié)果文件
       "plugin_data.pb.h",
       "plugin_data.pb.cc",
       "plugin_config.pb.h",
       "plugin_config.pb.cc",
     ]
     args = [
       "--cpp_out",
       "$proto_rel_out_dir",
       "--proto_path",
       rebase_path(".", root_build_dir),
     ]
     deps = [
       "${OHOS_PROFILER_3RDPARTY_PROTOBUF_DIR}:protoc(${host_toolchain})",
     ]
   }
   ohos_source_set("plug_cpp") {   //將定義的proto文件生成cpp文件
     deps = [
       ":plugin_cpp_gen",
     ]
     public_deps = [
       "${OHOS_PROFILER_3RDPARTY_PROTOBUF_DIR}:protobuf",
       "${OHOS_PROFILER_3RDPARTY_PROTOBUF_DIR}:protobuf_lite",
     ]
     include_dirs = [ "$proto_out_dir" ]
     sources = [   //目標plug_cpp中包括的源文件
       "plugin_data.pb.h",
       "plugin_data.pb.cc",
       "plugin_config.pb.h",
       "plugin_config.pb.cc",
     ]
   }
   

8. 編寫插件GN構(gòu)建腳本:

   ohos_shared_library("***plugin") {
     output_name = "***plugin"
     sources = [
       "src/***plugin.cpp",  //插件中的源文件
     ]
     include_dirs = [
       "../api/include",
       "${OHOS_PROFILER_DIR}/device/base/include",
     ]
     deps = [
       "${OHOS_PROFILER_3RDPARTY_PROTOBUF_DIR}:protobuf_lite",
       "${OHOS_PROFILER_3RDPARTY_PROTOBUF_DIR}:protoc_lib",
       "${OHOS_PROFILER_DIR}/protos/types/plugins/**:plug_cpp",  //上面ohos_source_set中生成的plug_cpp
     ]
     install_enable = true
     subsystem_name = "${OHOS_PROFILER_SUBSYS_NAME}"
   }
   

調(diào)測驗證：

插件動態(tài)庫生成后，可以自己編寫測試代碼，通過dlopen加載動態(tài)庫，并調(diào)用上面代碼中實現(xiàn)的插件模塊回調(diào)函數(shù)進行驗證。

int main(int argc, char** argv)
{
    void* handle;
    PluginModuleStruct* memplugin;
    handle = dlopen("./libplugin.z.so", RTLD_LAZY);   //動態(tài)打開上面生成的插件動態(tài)庫
    if (handle == nullptr) {
        HILOGD("dlopen err:%s.", dlerror());
        return 0;
    }
     memplugin = (PluginModuleStruct*)dlsym(handle, "g_pluginModule");  //獲取開發(fā)步驟3中定義的g_pluginModule全局變量
     //check memplugin- >callbacks   // 通過該指針調(diào)用上面開發(fā)步驟3中定義的回調(diào)函數(shù)
     return 0;

hiprofiler_cmd 使用說明

參數(shù)說明

執(zhí)行hiprofiler_cmd 為調(diào)優(yōu)業(yè)務的離線命令行抓取工具，具體使用方法及命令行參數(shù)介紹如下。

可以使用-h或者--help參數(shù)查看命令的使用描述信息：

hiprofiler_cmd -h
help :
  --getport        -q     : get grpc address
  --time           -t     : trace time
  --out            -o     : output file name
  --help           -h     : make some help
  --list           -l     : plugin list
  --start          -s     : start dependent process
  --kill           -k     : kill dependent process
  --config         -c     : start trace by config file

其余參數(shù)使用說明如下：

• -q或者--getport選項，用于查詢服務的端口信息；
• -t或者--time選項，用于指定抓取時間，單位是秒；
• -o或者--out選項，用于指定輸出的離線數(shù)據(jù)文件名；
• -h或者--help選項，用于輸出幫助信息；
• -l或者--list選項，用于查詢插件列表；
• -s或者--start選項，用于啟動依賴的進程；
• -k或者--kill選項，用于關閉依賴的進程；
• -c或者--config選項，用于指定配置文件；

命令展示

基礎配置參數(shù)

hiprofiler_cmd 
  -c - 
  -o /data/local/tmp/hiprofiler_data.htrace 
  -t 50 
  -s 
  -k 
<

命令參數(shù)說明：

• request_id:本次請求的id
• pages:存儲trace數(shù)據(jù)的buffer大?。? * pages kb）
• result_file:結(jié)果輸出的文件路徑，與-o參數(shù)對應
• sample_duration:抓取時長（ms），與-t參數(shù)對應

ftrace抓取場景示例

hiprofiler_cmd 
  -c - 
  -o /data/local/tmp/hiprofiler_data.htrace 
  -t 50 
  -s 
  -k 
<

命令參數(shù)說明：

• sample_interval:輪循模式下,插件上報數(shù)據(jù)的間隔時間（ms）
• trace_period_ms:ftrace插件讀取內(nèi)核緩沖區(qū)數(shù)據(jù)的間隔時間（ms）
• hitrace_time:hitrace命令行抓取時間，與hiprofiler_cmd下發(fā)的-t配置聯(lián)動

內(nèi)存信息抓取場景示例

內(nèi)核內(nèi)存信息

使用如下命令：

hiprofiler_cmd 
  -c - 
  -o /data/local/tmp/hiprofiler_data.htrace 
  -t 50 
  -s 
  -k 
<

虛擬內(nèi)存統(tǒng)計

使用如下命令：

hiprofiler_cmd 
  -c - 
  -o /data/local/tmp/hiprofiler_data.htrace 
  -t 50 
  -s 
  -k 
<

進程內(nèi)存使用跟蹤

如配置抓取的進程名是com.ohos.mms

hiprofiler_cmd 
  -c - 
  -o /data/local/tmp/hiprofiler_data.htrace 
  -t 50 
  -s 
  -k 
<

配置參數(shù)說明：

• pid/process_name:設置抓取的進程ID或者進程名
• max_stack_depth:抓取的棧的深度
• smb_pages:native_daemon和native_hook進程之間存儲數(shù)據(jù)的共享內(nèi)存大?。?KB的倍數(shù)）
• filter_size:只抓取大于該size的malloc數(shù)據(jù)（free不受影響）

bytrace/hitrace場景示例

運行如下命令：

hiprofiler_cmd 
  -c - 
  -o /data/local/tmp/hiprofiler_data.htrace 
  -t 30 
  -s 
<

hiperf場景示例

運行如下命令：

hiprofiler_cmd 
  -c - 
  -o /data/local/tmp/hiprofiler_data.htrace 
  -t 50 
  -s 
  -k 
<

審核編輯 黃宇