跟着小白一起学鸿蒙—DFX工具HiDumper

跟着小白一起学鸿蒙—DFX工具HiDumper

作者：左翼风发 2023-04-04 09:24:11系统 OpenHarmony 本章我们讲了Hidumper，作为开发者的查询工具，通过此工具可以查询系统信息，服务信息，进程栈等信息。

​​想了解更多关于开源的内容，请访问：​​

​​51CTO开源基础软件社区​​

​​https://ost.51cto.com​​

HiDumper

简介

HiDumper是OpenHarmony中为开发、测试人员，IDE工具提供统一的系统信息获取工具，帮助使用者分析，定位问题。

HiDumper主要包括以下几个主要模块：

hidumper：可执行程序，工具入口，在板上可通过hidumper执行对应命令。hidumperclient：动态库，提供framework层接口。lib_dump_usage：动态库，提供framework层功能实现。hidumperservice：动态库，sa服务，提供service层功能实现。

结构分析

.├── BUILD.gn├── bundle.json├── client│ └── native│ ├── dump_client_main.cpp│ └── main.cpp//可执行文件入口├── figures├── frameworks//框架实现│ └── native│ ├── BUILD.gn│ ├── common.h│ ├── dump_controller.h│ ├── dump_utils.cpp│ ├── dump_utils.h│ ├── include│ └── src├── hidumper.gni├── interfaces│ ├── innerkits│ │ ├── BUILD.gn│ │ ├── dump_usage.cpp│ │ └── include│ └── native│ └── innerkits├── LICENSE├── OAT.xml├── README.md├── README_zh.md├── sa_profile├── services//服务实现│ ├── BUILD.gn│ ├── hidumper.map│ ├── native│ │ ├── etc│ │ ├── include│ │ └── src│ └── zidl│ ├── include│ └── src├── test└── utilsusage"usage:\n""-h|help text for the tool\n""-lc |a list of system information clusters\n""-ls |a list of system abilities\n""-c|all system information clusters\n""-c [base system]|system information clusters labeled \"base\" and \"system\"\n""-s|all system abilities\n""-s [SA0 SA1]|system abilities labeled \"SA0\" and \"SA1\"\n""-s [SA] -a ['-h'] |system ability labeled \"SA\" with arguments \"-h\" specified\n""-e|faultlogs of crash history\n""--net |dump network information\n""--storage |dump storage information\n""-p|processes information, include list and infromation of processes"" and threads\n""-p [pid]|dump threads under pid, includes smap, block channel,"" execute time, mountinfo\n""--cpuusage [pid]|dump cpu usage by processes and category; if PID is specified,"" dump category usage of specified pid\n""--cpufreq |dump real CPU frequency of each core\n""--mem [pid] |dump memory usage of total; dump memory usage of specified"" pid if pid was specified\n""--zip |compress output to /data/log/hidumper\n";

如上，我们可以看出hidumper能查看几乎OpenHarmony里内的所有信息，比如：

查看系统ability信息，其中也包括HiDumperService# hidumper -lsSystem ability list:RenderServiceAbilityManagerServiceDataObserverMgrUriPermissionMgr AccountMgr BundleMgrFormMgrApplicationManagerServiceInstalldAccessibilityManagerServiceUserIdmService UserAuthServiceAuthExecutorMgrService PinAuthService FaceAuthServiceWifiDevice WifiHotspotWifiP2pWifiScan BluetoothHostNetConnManagerNetPolicyManager NetStatsManagerNetTetheringManagerEthernetManagerNetsysNative HiviewServiceHiviewFaultLoggerHiviewSysEventServiceHiDumperServiceDistributedKvDataDistributedSched EnterpriseDeviceManagerServiceResourceSchedBackgroundTaskManagerWorkScheduleSocPerfService DeviceUsageStatisticsMemoryManagerServiceLocationGeoConvert LocationLocatorLocationGnssLocationNetworkLocatingLocationNopowerLocatingDeviceStatusServiceAudioDistributed PlayerDistributedService CameraServiceAudioPolicyService AVSessionService MultimodalInputDistributedNotificationService CommonEventService PowerManagerServiceBatteryService ThermalService BatteryStatisticsServiceDisplayPowerManagerService AccessTokenManagerServicePrivacyManagerServiceKeystoreServiceCertManagerService SensorServiceMiscDeviceServicePasteboardServiceTimeServiceInputMethodService ScreenlockServiceWallpaperManagerServiceParamWatcher SysParamDevice TelephonyCellularCallTelephonyCellularDataTelephonySmsMmsTelephonyStateRegistryTelephonyCoreService UsbService WindowManagerServiceDisplayManagerServiceDSoftbus DeviceAuthServiceDeviceManagerService StorageDaemonStorageManagerHdfDeviceServiceManagerDistributedFileDaemondevattest_serviceDistributedDeviceProfile UiService查看系统ability信息，其中也包括HiDumperService-------------------------------[ability]-----------------------------------------------------------------RenderService---------------------------------------Graphic2D--RenderSerice ------Usage: h |help text for the toolscreen |dump all screen infomation in the systemsurface|dump all surface informationcomposer fps |dump the fps info of composer[surface name] fps |dump the fps info of surfacecomposer fpsClear |clear the fps info of composer[surface name] fpsClear |clear the fps info of surfacenodeNotOnTree|dump nodeNotOnTree infoallSurfacesMem |dump surface mem infoRSTree |dump RSTree infoEventParamList |dump EventParamList infoallInfo|dump all info...后面有好多查看系统网络信息#hidumper --net-------------------------------[net]-------------------------------cmd is: netstat -nWActive Internet connections (w/o servers)Proto Recv-Q Send-Q Local Address Foreign Address Stateudp00 127.0.0.1:44451 127.0.0.1:9877ESTABLISHEDudp00 127.0.0.1:37649 127.0.0.1:9877ESTABLISHEDActive UNIX domain sockets (w/o servers)Proto RefCnt Flags TypeStateI-Node Pathunix2[ ] DGRAM1675 /dev/unix/socket/fd_holderunix74 [ ] DGRAM 344 /dev/unix/socket/hilogInputunix2[ ] DGRAM1719 /dev/unix/socket/hisyseventunix2[ ] SEQPACKET 24844 /dev/unix/socket/hdcd...后面还有好多查看系统进程信息#hidumper -p-------------------------------[processes]-------------------------------cmd is: ps -efTUIDPID TIDPPID TCNT STIME TTYTIME CMDroot 1 1 01 15:55:05 ? 00:00:03 init --second-stageroot 2 2 01 15:55:05 ? 00:00:00 [kthreadd]root 3 3 21 15:55:05 ? 00:00:00 [rcu_gp]root 4 4 21 15:55:05 ? 00:00:00 [rcu_par_gp]root 8 8 21 15:55:05 ? 00:00:00 [mm_percpu_wq]root 9 9 21 15:55:05 ? 00:00:00 [rcu_tasks_rude_]...后面还有好多查看系统内存信息#hidumper --mem-------------------------------[memory]-------------------------------Total Memory Usage by PID:PIDNameTotal Pss(xxx in SwapPss) Total Vss Total Rss Total UssGL Graph4init 1217(0 in SwapPss) kB 4612 kB 3600 kB828 kB0 kB0 kB241watchdog_servic260(0 in SwapPss) kB 3160 kB 2320 kB232 kB0 kB0 kB253hilogd 2414(0 in SwapPss) kB 5968 kB 4576 kB 2252 kB0 kB0 kB254hdf_devmgr 600(0 in SwapPss) kB 6440 kB 3320 kB496 kB0 kB0 kB255hiview 4780(0 in SwapPss) kB79168 kB14752 kB 3148 kB0 kB0 kB256storage_daemon 1539(0 in SwapPss) kB11404 kB 7024 kB932 kB0 kB0 kB...后面有好多查看系统错误#hidumper -e-------------------------------[faultlog]-------------------------------/data/log/faultlog/faultlogger/jscrash-ohos.samples.videoplayer-20010040-20230328160126Generated by HiviewDFX@OpenHarmony================================================================Device info:OpenHarmony 3.2Build info:OpenHarmony 3.2.11.2Module name:ohos.samples.videoplayerVersion:1.0.0Pid:1763Uid:20010040Lifetime: 0.000000sJs-Engine: arkpage: pages/Player.jsError message: assertion (false) failed: type mismatchStacktrace:at clearVideoPlayer (/ets/pages/Player.ets:213:7)at onPageHide (/ets/pages/Player.ets:200:5)...后面还有好多

从上面列举的一些命令可以看出hidumper是个集成入口，有些用了Linux下的常规命令，如ps，netstat，有些用OH内特制的内容，如systemability，faultlog。

基本原理

hidumper同OHOS里的其他服务一样都提供framework和service架构，通过IPC方式通过hidumperservice服务执行具体命令。功能定义：在下面的问题提供三部分内容：base/hiviewdfx/hidumper/frameworks/native/src/util/config_data.cpp1. 功能定义const std::string ConfigData::CONFIG_NAME_SPLIT = "_";const std::string ConfigData::CONFIG_GROUP = "group";...const std::string ConfigData::CONFIG_DUMPER_LIST_SYSTEM_ABILITY = ConfigData::CONFIG_DUMPER_LIST_ + "system_ability";...const std::string ConfigData::STR_ABILITY = "ability";const std::string ConfigData::STR_BASE = "base";const std::string ConfigData::STR_SERVICE = "service";const std::string ConfigData::STR_SYSTEM = "system";2. dumper方法const ConfigData::ItemCfg ConfigData::baseInfoDumper_[] = {{.name_ = "dumper_base_info",.desc_ = "Base Information",.target_ = "",.section_ = "",.class_ = DumperConstant::API_DUMPER,.level_ = DumperConstant::NONE,.loop_ = DumperConstant::NONE,.filterCfg_ = "",},{.name_ = "",.desc_ = "",.target_ = "",.section_ = "",.class_ = DumperConstant::FD_OUTPUT,.level_ = DumperConstant::NONE,.loop_ = DumperConstant::NONE,.filterCfg_ = "",},};3. 功能组定义...const std::string ConfigData::testGroup_[] = {"dumper_test",};const ConfigData::GroupCfg ConfigData::groups_[] = {{.name_ = ConfigData::CONFIG_GROUP_CPU_FREQ,.desc_ = "group of cpu freq dumper",.list_ = cpuFreqGroup_,.size_ = ARRAY_SIZE(cpuFreqGroup_),.type_ = DumperConstant::GROUPTYPE_CPUID,.expand_ = true,},...简单调用流程：graph LRmain --> DumpManagerClient --> DumpManagerService --> DumpImplement功能实现流程：graph LRCmdParse --> GetDumperConfigs --> GetExecutorConfigList --> setExecutorList --> SetProgressEnabled --> DumpDatasCmdParse: 解析命令。GetDumperConfigs: 获取配置。GetExecutorConfigList: 根据配置获取执行命令。setExecutorList: 生成执行命令列表，通过ptrExecutorFactoryMap_获得对应executor。SetProgressEnabled: 设置执行开关。DumpDatas: 执行命令，获取输出信息。executor实现：//命令调用popen 对应 dumper里.class_ = DumperConstant::CMD_DUMPER,//文件读取fdopen 对应 dumper里 .class_ = DumperConstant::FILE_DUMPER,//api接口读取提供对应的API调用，如GetDisplayVersion， 对应 dumper里 .class_ = DumperConstant::API_DUMPER,

小结

本章我们讲了hidumper，作为开发者的查询工具，通过此工具可以查询系统信息，服务信息，进程栈等信息。通过此工具可以协助开发者发现一些系统运行信息，比如进程，线程，内存，CPU等信息；当然也可自己根据具体内容实现实现自己的对应查看工具。

​​想了解更多关于开源的内容，请访问：​​

​​51CTO开源基础软件社区​​

​​https://ost.51cto.com​​

责任编辑：jianghua 来源：51CTO 开源基础软件社区 鸿蒙HiDumper