From 2dc3ac61269058747d4d34a2311630ad96822343 Mon Sep 17 00:00:00 2001 From: xuyong Date: Mon, 27 Mar 2023 14:45:31 +0800 Subject: [PATCH] Optimize the documents of developing guide for Hicollie Signed-off-by: xuyong --- .../subsystems/subsys-dfx-hicollie.md | 53 +++++++------------ 1 file changed, 18 insertions(+), 35 deletions(-) diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hicollie.md b/zh-cn/device-dev/subsystems/subsys-dfx-hicollie.md index fa0a13a42b..b3c51302ce 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hicollie.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hicollie.md @@ -8,45 +8,28 @@ HiCollie提供了软件看门狗功能。针对系统服务死锁、应用主线 ## 接口说明 - **表1** C++接口功能描述表 + **表1** XCollieChecker接口 -| 所属类 | 接口定义 | 描述 | -| -------- | -------- | -------- | -| XCollieChecker类接口 | virtual void CheckBlock() | 接口功能：卡死检测回调函数。
输入参数：无。
输出参数：无。
返回值：无。 | -| XCollieChecker类接口 | virtual void CheckThreadBlock() | 接口功能：线程卡死检测回调函数。
输入参数：无。
输出参数：无。
返回值：无。 | -| XCollie类接口 | void RegisterXCollieChecker(const sptr<XCollieChecker> &checker, unsigned int type) | 接口功能：线程卡死检测回调函数注册。
输入参数：
- checker：XCollieChecker实例指针。
- type：卡死检测类型，取值设置为XCOLLIE_THREAD。
输出参数：无。
返回值：无。 | -| XCollie类接口 | int SetTimer(const std::string &name, unsigned int timeout, std::function<void (void _)> func, void _arg, unsigned int flag) | 接口功能：添加定时器。
输入参数：
- name：定时器名称。
- timeout：超时时间，单位为秒。
- func：超时回调函数。
- arg：超时回调函数参数指针。
- flag：定时器操作类型。
  XCOLLIE_FLAG_DEFAULT  // 其他三个选项功能之和
  XCOLLIE_FLAG_NOOP // 仅调用超时回调函数
  XCOLLIE_FLAG_LOG //  生成超时故障日志
  XCOLLIE_FLAG_RECOVERY //  进程退出
输出参数：无。
返回值：成功返回定时器标识，失败返回-1。 | -| XCollie类接口 | bool UpdateTimer(int id, unsigned int timeout) | 接口功能：更新定时器。
输入参数：
- id：定时器标识。
- timeout：超时时间，单位为秒。
输出参数：无。
返回值：成功返回true，失败返回false。 | -| XCollie类接口 | void CancelTimer(int id) | 接口功能：取消定时器。
输入参数：定时器标识。
输出参数：无。
返回值：无。 | +| 接口名称 | 描述 | +| -------- | -------- | +| virtual void CheckBlock() | 接口功能：卡死检测回调函数。
输入参数：无。
输出参数：无。
返回值：无。 | +| virtual void CheckThreadBlock() | 接口功能：线程卡死检测回调函数。
输入参数：无。
输出参数：无。
返回值：无。 | -## 效果 + **表2** XCollie接口 -日志打印： - - -``` -timeout: TimeoutTimer start at 1611040305 to check 1s ago - -----------StacktraceCatcher CurrentTime:2021-01-19 15:11:45 Unexecuted(-1)(LogType:Stacktrace Pid:27689 Process:XCollieTimeoutModuleTest)---------- - - ------ pid 27689 at 2021-01-19 15:11:45 ----- -Cmd line: ./XCollieTimeoutModuleTest -ABI: 'arm64' - -"XCollieTimeoutM" sysTid=27689 - #01 pc 00000000000174cc /data/test/XCollieTimeoutModuleTest -``` +| 接口名称 | 描述 | +| -------- | -------- | +| void RegisterXCollieChecker(const sptr<XCollieChecker> &checker, unsigned int type) | 接口功能：线程卡死检测回调函数注册。
输入参数：
- **checker**：XCollieChecker实例指针。
- **type**：卡死检测类型，取值设置为**XCOLLIE_THREAD**。
输出参数：无。
返回值：无。 | +| int SetTimer(const std::string &name, unsigned int timeout, std::function<void(void*)> func, void *arg, unsigned int flag) | 接口功能：添加定时器。
输入参数：
- **name**：定时器名称。
- **timeout**：超时时间，单位为秒。
- **func**：超时回调函数。
- **arg**：超时回调函数参数指针。
- **flag**：定时器操作类型。
XCOLLIE_FLAG_DEFAULT：其他三个选项功能之和
XCOLLIE_FLAG_NOOP：仅调用超时回调函数
XCOLLIE_FLAG_LOG：生成超时故障日志
XCOLLIE_FLAG_RECOVERY：进程退出
输出参数：无。
返回值：成功返回定时器标识，失败返回 **-1**。 | +| bool UpdateTimer(int id, unsigned int timeout) | 接口功能：更新定时器。
输入参数：
- **id**：定时器标识。
- **timeout**：超时时间，单位为秒。
输出参数：无。
返回值：成功返回**true**，失败返回**false**。 | +| void CancelTimer(int id) | 接口功能：取消定时器。
输入参数：
- **id**：定时器标识。
输出参数：无。
返回值：无。 | ## 开发实例 -### C++接口开发实例 - - -### 线程卡死监控 +### 线程卡死监控开发实例 线程卡死监控功能需要开发者实现两个卡死检测回调函数，XCollieChecker类的CheckBlock和CheckThreadBlock接口函数。实现了该回调函数之后，开发者还需要通过XCollie类的RegisterXCollieChecker函数，将该回调函数的类实例成功注册。卡死监控线程会定时执行全部已成功注册的回调函数，检查线程逻辑完成标志位，判定已经成功注册的线程逻辑是否被卡死。 @@ -59,7 +42,7 @@ ABI: 'arm64' 在业务代码中使用： - + ``` void MyXCollieChecker::CheckLock() { @@ -78,13 +61,13 @@ ABI: 'arm64' ``` 2. 编译设置，在BUILD.gn里增加子系统SDK依赖： - + ``` external_deps = [ "hiviewdfx:libxcollie" ] ``` -### 超时监控 +### 超时监控开发实例 单个进程通过SetTimer接口函数添加定时器最多可以设置128个，超过上限则添加定时器操作会失败。 @@ -96,7 +79,7 @@ ABI: 'arm64' ``` 在业务代码中使用（添加/更新/取消）： - + ``` std::function callback = [](void *args) { @@ -112,7 +95,7 @@ ABI: 'arm64' ``` 2. 编译设置，在BUILD.gn里增加子系统SDK依赖： - + ``` external_deps = [ "hiviewdfx:libxcollie" ] ``` -- GitLab