1# Faultlogger开发指导 2 3 4## 概述 5 6 7### 功能简介 8 9Faultlogger是OpenHarmony为开发者提供的一个维测日志框架，能够为应用、元能力、系统服务进程崩溃故障提供统一检测、日志采集、日志存储、日志上报功能，为应用崩溃故障提供详细的维测日志用以辅助故障定位。 10 11FaultLogger承载OpenHarmony系统上的故障记录功能，按照服务对象不同分别运行在两个部件中： 12 13- Hiview部件中的服务：服务于应用层和native层的功能模块，功能是分类管理系统中发生的各类故障信息，并为模块提供查询故障的API。 14 15- Faultloggerd部件中的服务：服务于崩溃进程，功能是收集C/C++运行时异常的守护进程和获取进程调用栈。 16 17基于Faultlogger服务，进程崩溃的处理流程如下图所示： 18 19 **图1** 进程崩溃处理流程图 20 21 22 231. 进程安装信号处理器后，通过DFX_SignalHandler函数检测并响应进程崩溃异常信号； 24 252. SignalHandler检测到异常信号后Fork出子进程，并运行ProcessDump程序开始dump崩溃进程和线程的堆栈信息； 26 273. ProcessDump程序在读取异常堆栈信息后将日志写入到Faultloggerd中的临时存储目录，进而生成完整的崩溃日志； 28 294. Faultloggerd根据需要将故障通过Hiview提供的AddFaultLog()接口进行上报，hiview将处理生成简化的崩溃日志，并上报Hisysevent事件。 30 31基于这样的设计，在资源有限的小型系统上可只部署Faultloggerd，也依然可以获取用于定位崩溃问题的日志。 32 33 34### 使用场景 35 36Faultloggerd意在为开发者在开发测试过程中遇到的崩溃或卡死问题提供一种简单轻量的定位手段。 37 38主要包含以下应用场景： 39 40 **表1** Faultloggerd模块应用场景 41 42| 场景描述 | 使用工具 | 使用方式 | 43| -------- | -------- | -------- | 44| 了解函数的调用顺序 | DumpCatcher API | 参见：[使用DumpCatcher获取调用栈](#使用dumpcatcher获取调用栈) | 45| 应用卡死/CPU占用高 | ProcessDump | 参见：[使用ProcessDump获取调用栈](#使用processdump获取调用栈) | 46| 进程未处理信号崩溃 | 崩溃日志和addr2line工具 | 参见：[基于崩溃日志对问题进行定位](#基于崩溃日志对问题进行定位) | 47 48 49## 使用DumpCatcher获取调用栈 50 51 52### 接口说明 53 54DumpCatcher可以抓取OpenHarmony指定进程（线程）的调用栈。 55 56 **表2** DumpCatcher接口说明 57 58| 类 | 方法 | 描述 | 59| -------- | -------- | -------- | 60| DfxDumpCatcher | bool DumpCatch(const int pid, const int tid, std::string& msg) | 接口返回值：<br/>- true：回栈成功，回栈信息存储在msg字符串对象中；<br/>- false：回栈失败。<br/> 输入参数：<br/>- pid：目标进程号；<br/>- tid：目标线程号，如果需要回栈进程中的所有线程，则tid设定为0；<br/> 输出参数：<br/>- msg：如果回栈成功，则通过msg返回调用栈信息。 | 61 62>  **说明：** 63> 当调用此接口的进程id与目标pid不一致时需要调用者是管理员（system，root）用户。当抓取非本用户组进程调用栈时还需具备读取对方/proc/pid/maps及ptrace到对方进程的权限。 64 65 66### 开发实例 67 68 69系统应用开发者可以用DumpCatcher在自己的应用中获取指定进程（线程）的调用栈。下文以dumpcatcherdemo模块使用DumpCatcher接口获取调用栈作为实例进行讲解。 70 71 721. 编译构建文件添加dumpcatcher依赖：以/base/hiviewdfx/faultloggerd/example/BUILD.gn为例，在include_dirs中添加DfxDumpCatcher头文件路径，并在deps中添加“//base/hiviewdfx/faultloggerd/interfaces/innerkits/dump_catcher:lib_dfx_dump_catcher”模块依赖。 73 74 ``` 75 import("//base/hiviewdfx/faultloggerd/faultloggerd.gni") 76 import("//build/ohos.gni") 77 78 config("dumpcatcherdemo_config") { 79 visibility = [ ":*" ] 80 81 include_dirs = [ 82 ".", 83 "//utils/native/base/include", 84 "//base/hiviewdfx/faultloggerd/interfaces/innerkits/dump_catcher/include/", # 添加dumpcatcher头文件路径 85 ] 86 } 87 88 ohos_executable("dumpcatcherdemo") { sources = [ "dump_catcher_demo.cpp" ] configs = [ ":dumpcatcherdemo_config" ] deps = [ "//base/hiviewdfx/faultloggerd/interfaces/innerkits/dump_catcher:lib_dfx_dump_catcher", # 添加dumpcathcer模块依赖 "//utils/native/base:utils", ] external_deps = [ "hilog_native:libhilog" ] install_enable = true part_name = "faultloggerd" subsystem_name = "hiviewdfx" 89 } 90 ``` 91 922. 头文件定义用到的函数：以/base/hiviewdfx/faultloggerd/example/dump_catcher_demo.h为例，本样例代码中，通过调用栈深度测试的测试函数来构造一个指定深度的调用栈。 93 94 ``` 95 #ifndef DUMP_CATCHER_DEMO_H 96 #define DUMP_CATCHER_DEMO_H 97 98 #include <inttypes.h> 99 100 #define NOINLINE __attribute__((noinline)) 101 102 // 定义该宏函数用于自动生成函数调用链 103 #define GEN_TEST_FUNCTION(FuncNumA, FuncNumB) \ 104 __attribute__((noinline)) int TestFunc##FuncNumA() \ 105 { \ 106 return TestFunc##FuncNumB(); \ 107 } 108 109 // 调用栈深度测试的测试函数 110 int TestFunc0(void); 111 int TestFunc1(void); 112 int TestFunc2(void); 113 int TestFunc3(void); 114 int TestFunc4(void); 115 int TestFunc5(void); 116 int TestFunc6(void); 117 int TestFunc7(void); 118 int TestFunc8(void); 119 int TestFunc9(void); 120 int TestFunc10(void); 121 122 #endif // DUMP_CATCHER_DEMO_H 123 ``` 124 1253. 在源文件中调用DumpCatch接口：以/base/hiviewdfx/faultloggerd/example/dump_catcher_demo.cpp为例，引用dfx_dump_catcher.h头文件，声明DfxDumpCatcher对象，通过宏函数构造函数调用链，并最后调用DumpCatch接口方法，传入需要抓取调用栈的进程号、线程号。 126 127 ``` 128 #include "dump_catcher_demo.h" 129 130 #include <iostream> 131 #include <string> 132 #include <unistd.h> 133 // dfx_dump_catcher.h头文件引入 134 #include "dfx_dump_catcher.h" 135 using namespace std; 136 137 NOINLINE int TestFunc10(void) 138 { 139 OHOS::HiviewDFX::DfxDumpCatcher dumplog; 140 string msg = ""; 141 bool ret = dumplog.DumpCatch(getpid(), gettid(), msg); // 调用DumpCatch接口获取调用栈 142 if (ret) { 143 cout << msg << endl; 144 } 145 return 0; 146 } 147 148 // 通过宏函数自动生成函数调用链 149 GEN_TEST_FUNCTION(0, 1) 150 GEN_TEST_FUNCTION(1, 2) 151 GEN_TEST_FUNCTION(2, 3) 152 GEN_TEST_FUNCTION(3, 4) 153 GEN_TEST_FUNCTION(4, 5) 154 GEN_TEST_FUNCTION(5, 6) 155 GEN_TEST_FUNCTION(6, 7) 156 GEN_TEST_FUNCTION(7, 8) 157 GEN_TEST_FUNCTION(8, 9) 158 GEN_TEST_FUNCTION(9, 10) 159 160 int main(int argc, char *argv[]) 161 { 162 TestFunc0(); 163 return 0; 164 } 165 ``` 166 167 168## 使用ProcessDump获取调用栈 169 170 171### 工具说明 172 173ProcessDump是一个抓取调用栈的命令行工具，在OpenHarmony系统中可直接使用，该工具通过-p、-t参数指定进程和线程，命令执行后在命令行窗口打印指定进程的线程栈信息。 174 175 **表3** ProcessDump命令行工具使用说明 176 177| 工具名称 | 命令行工具路径 | 执行命令 | 描述 | 178| -------- | -------- | -------- | -------- | 179| processdump | /system/bin | - processdump -p [pid]<br/>- processdump -p [pid] -t [tid] | **参数说明：**<br/>- -p [pid]：打印指定进程下面的所有线程栈信息。<br/>- -p [pid] -t [tid]：打印指定进程下面的指定线程信息。<br/>**返回值说明：**<br/>如果栈信息解析成功，则将信息显示到标准输出；失败则打印错误信息。 | 180 181 182>  **说明：** 183> 此工具需要在root下使用，或调用者有权限ptrace到目标进程，并读取目标进程的smaps。 184 185 186### 使用实例 187 188通过processdump命令行工具打印hiview进程的调用栈。 189 190 191``` 192# ps -A | grep hiview 193 114 ? 00:00:00 hiview 194# processdump -p 114 -t 114 195Tid:114, Name:hiview 196#00 pc 0000000000089824(00000000b6f44824) /system/lib/ld-musl-arm.so.1(ioctl+68) 197#01 pc 000000000002a709(00000000b6c56709) /system/lib/libipc_core.z.so(_ZN4OHOS15BinderConnector11WriteBinderEmPv+16) 198#02 pc 000000000002ba75(00000000b6c57a75) /system/lib/libipc_core.z.so(_ZN4OHOS13BinderInvoker18TransactWithDriverEb+224) 199#03 pc 000000000002bb37(00000000b6c57b37) /system/lib/libipc_core.z.so(_ZN4OHOS13BinderInvoker13StartWorkLoopEv+22) 200#04 pc 000000000002c211(00000000b6c58211) /system/lib/libipc_core.z.so(_ZN4OHOS13BinderInvoker10JoinThreadEb+36) 201#05 pc 0000000000038d07(00000000004bcd07) /system/bin/hiview(_ZNSt3__h6vectorINS_9sub_matchINS_11__wrap_iterIPKcEEEENS_9allocatorIS6_EEE8__appendEj+596) 202#06 pc 0000000000028655(00000000004ac655) /system/bin/hiview 203#07 pc 00000000000c2b08(00000000b6f7db08) /system/lib/ld-musl-arm.so.1(__libc_start_main+116) 204#08 pc 00000000000285f4(00000000004ac5f4) /system/bin/hiview 205#09 pc 0000000000028580(00000000004ac580) /system/bin/hiview 206``` 207 208 209## 基于崩溃日志对问题进行定位 210 211开发者可以通过faultloggerd生成的崩溃堆栈日志进行问题定位。本章节将主要介绍如何利用addr2line工具进行崩溃问题定位。 212 2131. 程序自崩溃或构造崩溃。 214 例如将如下代码植入自己的代码中，调用触发一个无效内存访问故障（SIGSEGV）。 215 216 217 ``` 218 NOINLINE int TriggerSegmentFaultException() 219 { 220 printf("test TriggerSegmentFaultException \n"); 221 // 为构造崩溃，强制进行类型转换 222 int *a = (int *)(&RaiseAbort); 223 *a = SIGSEGV; 224 return 0; 225 } 226 ``` 227 2282. 获取崩溃函数调用栈日志。 229 因为存在未处理的异常，进程会在 /data/log/faultlog/temp路径下生成临时的日志文件，其命名规则为： 230 231 232 ``` 233 cppcrash-pid-time 234 ``` 235 236 获取其生成的调用栈如下： 237 238 239 ``` 240 Pid:816 241 Uid:0 242 Process name:./crasher 243 Reason:Signal:SIGSEGV(SEGV_ACCERR)@0x0042d33d 244 Fault thread Info: 245 Tid:816, Name:crasher 246 r0:0042d33d r1:0000000b r2:1725d4c4 r3:b6f9fa84 247 r4:bec97e69 r5:b6fc0268 r6:0042d661 r7:bec97d60 248 r8:00000000 r9:00000000 r10:00000000 249 fp:bec97d20 ip:00000020 sp:bec97cd0 lr:b6f9fae4 pc:0042d32c 250 251 #00 pc 000000000000332c(000000000042d32c) /data/crasher(TriggerSegmentFaultException+15) 252 #01 pc 00000000000035c7(000000000042d5c7) /data/crasher(ParseAndDoCrash+277) 253 #02 pc 0000000000003689(000000000042d689) /data/crasher(main+39) 254 #03 pc 00000000000c3b08(00000000b6fbbb08) /system/lib/ld-musl-arm.so.1(__libc_start_main+116) 255 #04 pc 00000000000032f8(000000000042d2f8) /data/crasher(_start_c+112) 256 #05 pc 0000000000003284(000000000042d284) /data/crasher(_start+32) 257 ``` 258 2593. 利用addr2line工具进行调用栈分析。 260 使用addr2line工具根据偏移地址解析行号: 261 262 263 ``` 264 root:~/OpenHarmony/out/hi3516dv300/exe.unstripped/hiviewdfx/faultloggerd$ addr2line -e crasher 000332c 265 base/hiviewdfx/faultloggerd/tools/crasher/dfx_crasher.c:57 266 ``` 267 268 这个崩溃是由赋值给一块不可写的区域导致的，代码行为dfx_crasher.c文件的57行，修改后可以避免发生此崩溃。 269
