HarmonyOS 鸿蒙Next实战开发：【FaultLoggerd组件】讲解

HarmonyOS 鸿蒙Next实战开发：【FaultLoggerd组件】讲解 简介
Faultloggerd部件是OpenHarmony中C/C++运行时崩溃临时日志的生成及管理模块。面向基于 Rust 开发的部件，Faultloggerd 提供了Rust Panic故障日志生成能力。系统开发者可以在预设的路径下找到故障日志，定位相关问题。

架构

• Native InnerKits 接口

  • SignalHandler：信号处理器，接收系统异常信号，触发抓取进程异常时的现场信息。
  • BackTrace：本地回栈库，提供进程内本地回栈能力。
  • DumpCatcher：堆栈信息抓取工具库，提供了抓取指定进程和线程的堆栈栈信息的能力。
  • FaultloggerdClient：崩溃临时日志管理客户端，接收申请文件描述符、堆栈导出等请求。

• Rust 接口

  • PanicHandler：Rust PANIC故障处理器，封装faultloggerd回栈能力支持rust模块PANIC故障回栈。
  • Rustc Demangle：Rust 符号demangle库，支持Rust模块mangled符号解析。

• Faultlogger Daemon 服务

  • FaultloggerdServer：核心服务处理模块，接收并处理客户端的请求。
  • FaultloggerdSecure：权限校验模块，对运行时崩溃日志生成和抓取提供权限管理和校验能力。
  • FaultloggerdConfig：崩溃临时日志管理模块。
  • FaultloggerdPipe：数据管道传输管理模块，提供数据传输管道申请和管理能力。

• 工具

  • DumpCatcher Command Tool：提供命令行形式的主动抓栈工具，仅在Debug版本提供。
  • ProcessDump：进程信息抓取二进制工具，通过命令行方式提供抓取指定进程、线程堆栈信息的能力。
  • crasher：崩溃构造器，提供了崩溃构造和模拟能力。
  • Rust Panic Maker：Rust PANIC 故障构造器，提供了构造Rust模块的故障构造能力。

目前主要支持对以下C/C++运行时崩溃异常信号的处理：

使用说明
进程崩溃日志生成
目前已默认开启，进程因上述异常信号崩溃将会在设备 /data/log/faultlog/temp 目录下生成完整的崩溃日志，可基于该崩溃日志进行问题定位可分析。

DumpCatcher 接口
DumpCatcher是提供给第三方模块使用的抓取调用栈基础库，其中包含了打印指定进程（或线程）的栈信息的接口函数。目前支持CPP调用栈和CPP-JS混合栈。

接口类名：DfxDumpCatcher

接口定义：

• 默认：bool DumpCatch(int pid, int tid, std::string& msg);
• 支持混合栈：bool DumpCatchMix(int pid, int tid, std::string& msg);
• 支持输出到指定文件：bool DumpCatchFd(int pid, int tid, std::string& msg, int fd);
• 支持批量抓栈：bool DumpCatchMultiPid(const std::vector<int> pidV, std::string& msg);

接口参数说明：

• 接口返回值：
  • true：回栈成功，回栈信息存储在msg字符串对象中；
  • false：回栈失败。
• 输入参数：
  • pid：希望回栈的进程号，如果需要回栈进程中的所有线程，则tid设定为0；
  • tid：希望回栈的线程号；
  • fd：指定写入回栈信息的文件句柄；
• 输出参数：
  • msg：如果回栈成功，则通过msg输出回栈后的信息。

注意：此接口需要调用者是管理员（system，root）用户，或者只抓取自己用户拥有的进程信息。

样例代码：

• dump_catcher_demo.h
• dump_catcher_demo.cpp
• BUILD.gn

执行结果：

# ./dumpcatcherdemo
#00 pc 0000000000000981(/data/test/dumpcatcherdemo)
#01 pc 0000000000000a6d(/data/test/dumpcatcherdemo)
#02 pc 0000000000000a63(/data/test/dumpcatcherdemo)
#03 pc 0000000000000a59(/data/test/dumpcatcherdemo)
#04 pc 0000000000000a4f(/data/test/dumpcatcherdemo)
#05 pc 0000000000000a45(/data/test/dumpcatcherdemo)
#06 pc 0000000000000a3b(/data/test/dumpcatcherdemo)
#07 pc 0000000000000a31(/data/test/dumpcatcherdemo)
#08 pc 0000000000000a27(/data/test/dumpcatcherdemo)
#09 pc 0000000000000a1d(/data/test/dumpcatcherdemo)
#10 pc 0000000000000a13(/data/test/dumpcatcherdemo)
#11 pc 0000000000000a77(/data/test/dumpcatcherdemo)
#12 pc 00000000000c2b08(/system/lib/ld-musl-arm.so1)(__libc_start_main+116)
#13 pc 0000000000000938(/data/test/dumpcatcherdemo)
#14 pc 00000000000008c4(/data/test/dumpcatcherdemo)

DumpCatcher 命令行工具
DumpCatcher 是指提供给用户的一个抓取调用栈命令行工具，由 DumpCatcher innerkits 接口封装实现，该工具通过 -p、-t 参数指定进程和线程，以及 [-c -m -k] 可选参数指定抓栈的类型，命令执行后在命令行窗口打印指定的进程的线程栈信息。

工具名称：dumpcatcher

位置：/system/bin

参数说明：

• -p [pid]：打印指定进程下面的所有线程栈信息；
• -p [pid] -t [tid]：打印指定进程下面的指定线程信息。
• [-c -m -k]：可选参数, 指定打印 -c(pp) C++调用栈、-m(ix) C++ JS混合调用栈、-k(ernel) 调用栈类型。

返回打印说明：如果栈信息解析成功，则将信息显示到标准输出。

注意：使用此接口需要调用者是管理员（system，root）用户。

处理流程
进程崩溃抓栈处理流程

1. 进程运行时异常崩溃后会收到来自 Kernel 发送的崩溃信号，由进程在启动加载的 SignalHandler 模块进行信号处理；
2. 进程接收到崩溃信号后，保存当前进程上下文，fork 出子进程执行 ProcessDump 二进制进行抓栈；
3. ProcessDump 向 Faultloggerd 申请文件句柄用于存储收集到的崩溃日志数据；
4. ProcessDump 将完整崩溃日志数据写入到 /data/log/faultlog/temp 目录下进行临时存储；
5. ProcessDump 收集完崩溃日志后，上报给 Hiview 进行后续处理；
6. Hiview 接收到新增进程崩溃故障数据后，提取简易的崩溃日志存储到 /data/log/faultlog/faultlogger 目录下，并生成 HiSysevent 故障事件。

DumpCatcher 接口/命令行工具 主动抓栈处理流程

1. 进程A调用 DumpCatcher 库提供的系列接口（1B），或通过 DumpCatcher 命令行工具(1A)，申请dump指定进程和线程的堆栈信息；
2. 如果目前进程是当前进程，则直接调用 BackTrace Local 提供的能力进行本地回栈输出（2B）；如果不是，则向 Faultloggerd 服务发送抓栈请求（2A）；
3. Faultloggerd 接收到抓栈请求，鉴通过权和管道申请等操作后，向目标进程发送 SIGDUMP(35) 信号触发主动抓栈（3）；
4. 目前进程接收到 SIGDUMP(35) 抓栈信号后，保存当前进程上下文，fork出子进程执行 ProcessDump 二进制进行抓栈，通过 Faultloggerd 申请到的管道返回调用栈数据（4）。