1# HiCollie开发指导 2 3 4## 概述 5 6HiCollie提供了软件看门狗功能。针对系统服务死锁、应用主线程阻塞，用户业务流程超时等故障，HiCollie提供了一套统一的用于故障检测和故障日志生成的框架，提供软件超时故障日志，辅助定位软件超时问题。 7 8 9## 接口说明 10 11 **表1** XCollieChecker接口 12 13| 接口名称 | 描述 | 14| -------- | -------- | 15| virtual void CheckBlock() | 接口功能：卡死检测回调函数。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：无。 | 16| virtual void CheckThreadBlock() | 接口功能：线程卡死检测回调函数。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：无。 | 17 18 19 **表2** XCollie接口 20 21| 接口名称 | 描述 | 22| -------- | -------- | 23| void RegisterXCollieChecker(const sptr<XCollieChecker> &checker, unsigned int type) | 接口功能：线程卡死检测回调函数注册。<br/>输入参数：<br/>- **checker**：XCollieChecker实例指针。<br/>- **type**：卡死检测类型，取值设置为**XCOLLIE_THREAD**。<br/>输出参数：无。<br/>返回值：无。 | 24| int SetTimer(const std::string &name, unsigned int timeout, std::function<void(void*)> func, void *arg, unsigned int flag) | 接口功能：添加定时器。<br/>输入参数：<br/>- **name**：定时器名称。<br/>- **timeout**：超时时间，单位为秒。<br/>- **func**：超时回调函数。<br/>- **arg**：超时回调函数参数指针。<br/>- **flag**：定时器操作类型。<br/> XCOLLIE_FLAG_DEFAULT：其他三个选项功能之和<br/> XCOLLIE_FLAG_NOOP：仅调用超时回调函数<br/> XCOLLIE_FLAG_LOG：生成超时故障日志<br/> XCOLLIE_FLAG_RECOVERY：进程退出<br/>输出参数：无。<br/>返回值：成功返回定时器标识，失败返回 **-1**。 | 25| bool UpdateTimer(int id, unsigned int timeout) | 接口功能：更新定时器。<br/>输入参数：<br/>- **id**：定时器标识。<br/>- **timeout**：超时时间，单位为秒。<br/>输出参数：无。<br/>返回值：成功返回**true**，失败返回**false**。 | 26| void CancelTimer(int id) | 接口功能：取消定时器。<br/>输入参数：<br/>- **id**：定时器标识。<br/>输出参数：无。<br/>返回值：无。 | 27 28 29## 开发实例 30 31 32### 线程卡死监控开发实例 33 34线程卡死监控功能需要开发者实现两个卡死检测回调函数，XCollieChecker类的CheckBlock和CheckThreadBlock接口函数。实现了该回调函数之后，开发者还需要通过XCollie类的RegisterXCollieChecker函数，将该回调函数的类实例成功注册。卡死监控线程会定时执行全部已成功注册的回调函数，检查线程逻辑完成标志位，判定已经成功注册的线程逻辑是否被卡死。 35 361. 源代码开发 37 包含头文件： 38 39 ``` 40 #include "xcollie.h" 41 ``` 42 43 在业务代码中使用： 44 45 46 ``` 47 void MyXCollieChecker::CheckLock() 48 { 49 /* time consuming job */ 50 } 51 52 void MyXCollieChecker::CheckThreadBlock() 53 { 54 /* time consuming job */ 55 } 56 57 sptr<XCollieChecker> checker = new MyXCollieChecker("MyXCollieChecker"); 58 XCollie::GetInstance().RegisterXCollieChecker(checker, 59 (XCOLLIE_LOCK | XCOLLIE_THREAD)); 60 ...... 61 ``` 62 632. 编译设置，在BUILD.gn里增加子系统SDK依赖： 64 65 ``` 66 external_deps = [ "hiviewdfx:libxcollie" ] 67 ``` 68 69 70### 超时监控开发实例 71 72单个进程通过SetTimer接口函数添加定时器最多可以设置128个，超过上限则添加定时器操作会失败。 73 741. 源代码开发 75 包含头文件： 76 77 ``` 78 #include "xcollie.h" 79 ``` 80 81 在业务代码中使用（添加/更新/取消）： 82 83 ``` 84 std::function<void(void *)> callback = [](void *args) 85 { 86 /* dump helpful information */ 87 }; 88 89 int id = XCollie::GetInstance().SetTimer("MyXCollieTimer", 10, callback ,nullptr, XCOLLIE_FLAG_LOG); 90 /* time consuming job */ 91 XCollie::GetInstance().UpdateTimer(id, 5); 92 /* time consuming job */ 93 XCollie::GetInstance().CancelTimer(id); 94 ...... 95 ``` 96 972. 编译设置，在BUILD.gn里增加子系统SDK依赖： 98 99 ``` 100 external_deps = [ "hiviewdfx:libxcollie" ] 101 ``` 102