• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 订阅地址越界事件（C/C++）
2<!--Kit: Performance Analysis Kit-->
3<!--Subsystem: HiviewDFX-->
4<!--Owner: @mlkgeek-->
5<!--Designer: @StevenLai1994-->
6<!--Tester: @gcw_KuLfPSbe-->
7<!--Adviser: @foryourself-->
8
9## 接口说明
10
11API接口的具体使用说明（参数使用限制、具体取值范围等）请参考[HiAppEvent C API文档](../reference/apis-performance-analysis-kit/capi-hiappevent-h.md)。
12
13**订阅接口功能介绍**：
14
15| 接口名 | 描述 |
16| -------- | -------- |
17| int OH_HiAppEvent_AddWatcher(HiAppEvent_Watcher \*watcher) | 添加应用事件观察者，以添加对应用事件的订阅。 |
18| int OH_HiAppEvent_RemoveWatcher(HiAppEvent_Watcher \*watcher) | 移除应用事件观察者，以移除对应用事件的订阅。 |
19
20## 开发步骤
21
22以实现对写数组越界场景生成的地址越界事件订阅为例，说明开发步骤。
23
24### 步骤一：新建工程
25
261. 参考[三方开源库jsoncpp代码仓](https://github.com/open-source-parsers/jsoncpp)README中**Using JsonCpp in your project**介绍的使用方法获取到jsoncpp.cpp、json.h和json-forwards.h三个文件。
27
282. 新建Native C++工程，并将上述文件导入到新建工程内，目录结构如下：
29
30   ```yml
31   entry:
32     src:
33       main:
34         cpp:
35           - json:
36               - json.h
37               - json-forwards.h
38           - types:
39               libentry:
40                 - index.d.ts
41           - CMakeLists.txt
42           - napi_init.cpp
43           - jsoncpp.cpp
44         ets:
45           - entryability:
46               - EntryAbility.ets
47           - pages:
48               - Index.ets
49   ```
50
513. 编辑"CMakeLists.txt"文件，添加源文件及动态库：
52
53   ```cmake
54   # 新增jsoncpp.cpp(解析订阅事件中的json字符串)源文件
55   add_library(entry SHARED napi_init.cpp jsoncpp.cpp)
56   # 新增动态库依赖libhiappevent_ndk.z.so和libhilog_ndk.z.so(日志输出)
57   target_link_libraries(entry PUBLIC libace_napi.z.so libhilog_ndk.z.so libhiappevent_ndk.z.so)
58   ```
59
604. 编辑"napi_init.cpp"文件，导入依赖的文件，并定义LOG_TAG：
61
62   ```c++
63   #include "napi/native_api.h"
64   #include "json/json.h"
65   #include "hilog/log.h"
66   #include "hiappevent/hiappevent.h"
67
68   #undef LOG_TAG
69   #define LOG_TAG "testTag"
70   ```
71
72### 步骤二：订阅地址越界事件
73
741. 订阅系统事件：
75
76   - onReceive类型观察者：
77
78      编辑"napi_init.cpp"文件，定义onReceive类型观察者相关方法：
79
80      ```c++
81      //定义一变量，用来缓存创建的观察者的指针。
82      static HiAppEvent_Watcher *systemEventWatcher;
83
84      static void OnReceive(const char *domain, const struct HiAppEvent_AppEventGroup *appEventGroups, uint32_t groupLen) {
85          for (int i = 0; i < groupLen; ++i) {
86              for (int j = 0; j < appEventGroups[i].infoLen; ++j) {
87                  OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", appEventGroups[i].appEventInfos[j].domain);
88                  OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", appEventGroups[i].appEventInfos[j].name);
89                  OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", appEventGroups[i].appEventInfos[j].type);
90                  if (strcmp(appEventGroups[i].appEventInfos[j].domain, DOMAIN_OS) == 0 &&
91                      strcmp(appEventGroups[i].appEventInfos[j].name, EVENT_ADDRESS_SANITIZER) == 0) {
92                      Json::Value params;
93                      Json::Reader reader(Json::Features::strictMode());
94                      Json::FastWriter writer;
95                      if (reader.parse(appEventGroups[i].appEventInfos[j].params, params)) {
96                          auto time = params["time"].asInt64();
97                          auto bundleVersion = params["bundle_version"].asString();
98                          auto bundleName = params["bundle_name"].asString();
99                          auto pid = params["pid"].asInt();
100                          auto uid = params["uid"].asInt();
101                          auto type = params["type"].asString();
102                          std::string logOverLimit = params["log_over_limit"].asBool() ? "true" : "false";
103                          auto externalLog = writer.write(params["external_log"]);
104                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time);
105                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", bundleVersion.c_str());
106                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s", bundleName.c_str());
107                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid);
108                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid);
109                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.type=%{public}s", type.c_str());
110                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", externalLog.c_str());
111                          OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}s", logOverLimit.c_str());
112                      }
113                  }
114              }
115          }
116      }
117
118      static napi_value RegisterWatcher(napi_env env, napi_callback_info info) {
119          // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。
120          systemEventWatcher = OH_HiAppEvent_CreateWatcher("onReceiverWatcher");
121          // 设置订阅的事件为EVENT_ADDRESS_SANITIZER。
122          const char *names[] = {EVENT_ADDRESS_SANITIZER};
123          // 开发者订阅感兴趣的事件，此处订阅了系统事件。
124          OH_HiAppEvent_SetAppEventFilter(systemEventWatcher, DOMAIN_OS, 0, names, 1);
125          // 开发者设置已实现的回调函数，观察者接收到事件后回立即触发OnReceive回调。
126          OH_HiAppEvent_SetWatcherOnReceive(systemEventWatcher, OnReceive);
127          // 使观察者开始监听订阅的事件。
128          OH_HiAppEvent_AddWatcher(systemEventWatcher);
129          return {};
130      }
131      ```
132
133   - onTrigger类型观察者：
134
135      编辑"napi_init.cpp"文件，定义OnTrigger类型观察者相关方法：
136
137      ```c++
138      //定义一变量，用来缓存创建的观察者的指针。
139      static HiAppEvent_Watcher *systemEventWatcher;
140
141      // 开发者可以自行实现获取已监听到事件的回调函数，其中events指针指向内容仅在该函数内有效。
142      static void OnTake(const char *const *events, uint32_t eventLen) {
143          Json::Reader reader(Json::Features::strictMode());
144          Json::FastWriter writer;
145          for (int i = 0; i < eventLen; ++i) {
146              Json::Value eventInfo;
147              if (reader.parse(events[i], eventInfo)) {
148                  auto domain =  eventInfo["domain_"].asString();
149                  auto name = eventInfo["name_"].asString();
150                  auto type = eventInfo["type_"].asInt();
151                  OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", domain.c_str());
152                  OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", name.c_str());
153                  OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", type);
154                  if (domain ==  DOMAIN_OS && name == EVENT_ADDRESS_SANITIZER) {
155                      auto time = eventInfo["time"].asInt64();
156                      auto bundleVersion = eventInfo["bundle_version"].asString();
157                      auto bundleName = eventInfo["bundle_name"].asString();
158                      auto pid = eventInfo["pid"].asInt();
159                      auto uid = eventInfo["uid"].asInt();
160                      auto asanType = eventInfo["type"].asString();
161                      auto externalLog = writer.write(eventInfo["external_log"]);
162                      std::string logOverLimit = eventInfo["log_over_limit"].asBool() ? "true" : "false";
163                      OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time);
164                      OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", bundleVersion.c_str());
165                      OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s", bundleName.c_str());
166                      OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid);
167                      OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid);
168                      OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.crash_type=%{public}s", asanType.c_str());
169                      OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", externalLog.c_str());
170                      OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}s", logOverLimit.c_str());
171                  }
172              }
173          }
174      }
175
176      // 开发者可以自行实现订阅回调函数，以便对获取到的事件打点数据进行自定义处理。
177      static void OnTrigger(int row, int size) {
178          // 接收回调后，获取指定数量的已接收事件。
179          OH_HiAppEvent_TakeWatcherData(systemEventWatcher, row, OnTake);
180      }
181
182      static napi_value RegisterWatcher(napi_env env, napi_callback_info info) {
183          // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。
184          systemEventWatcher = OH_HiAppEvent_CreateWatcher("onTriggerWatcher");
185          // 设置订阅的事件为EVENT_ADDRESS_SANITIZER。
186          const char *names[] = {EVENT_ADDRESS_SANITIZER};
187          // 开发者订阅感兴趣的事件，此处订阅了系统事件。
188          OH_HiAppEvent_SetAppEventFilter(systemEventWatcher, DOMAIN_OS, 0, names, 1);
189          // 开发者设置已实现的回调函数，需OH_HiAppEvent_SetTriggerCondition设置的条件满足方可触发。
190          OH_HiAppEvent_SetWatcherOnTrigger(systemEventWatcher, OnTrigger);
191          // 开发者可以设置订阅触发回调的条件，此处是设置新增事件打点数量为1个时，触发onTrigger回调。
192          OH_HiAppEvent_SetTriggerCondition(systemEventWatcher, 1, 0, 0);
193          // 使观察者开始监听订阅的事件。
194          OH_HiAppEvent_AddWatcher(systemEventWatcher);
195          return {};
196      }
197      ```
198
199### 步骤三：构造地址越界错误
200
2011. 编辑"napi_init.cpp"文件，定义Test方法, 方法中对一个整数数组进行越界访问：
202
203   ```c++
204   static napi_value Test(napi_env env, napi_callback_info info)
205   {
206       int a[10];
207       a[10] = 1;
208       return {};
209   }
210   ```
211
2122. 将RegisterWatcher和Test注册为ArkTS接口，编辑"napi_init.cpp"文件，将RegisterWatcher和Test注册为ArkTS接口：
213
214   ```c++
215   static napi_value Init(napi_env env, napi_value exports)
216   {
217       napi_property_descriptor desc[] = {
218           { "registerWatcher", nullptr, RegisterWatcher, nullptr, nullptr, nullptr, napi_default, nullptr },
219           { "test", nullptr, Test, nullptr, nullptr, nullptr, napi_default, nullptr}
220       };
221       napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
222       return exports;
223   }
224   ```
225
226   编辑"index.d.ts"文件，定义ArkTS接口：
227
228   ```typescript
229   export const registerWatcher: () => void;
230   export const test: () => void;
231   ```
232
2333. 编辑"EntryAbility.ets"文件，在onCreate()函数中新增接口调用：
234
235   ```typescript
236   // 导入依赖模块
237   import testNapi from 'libentry.so';
238
239   // 在onCreate()函数中新增接口调用
240   // 启动时，注册系统事件观察者
241   testNapi.registerWatcher();
242   ```
243
2444. 编辑“entry > src > main > ets  > pages > Index.ets”文件，新增按钮触发地址越界事件：
245
246   ```ts
247   import testNapi from 'libentry.so';
248
249   @Entry
250   @Component
251   struct Index {
252     build() {
253       Row() {
254         Column() {
255           Button("address-sanitizer").onClick(() => {
256             testNapi.test();
257           })
258         }
259         .width('100%')
260       }
261       .height('100%')
262     }
263   }
264   ```
265
2665. 点击DevEco Studio界面中的“entry”，点击“Edit Configurations”，点击“Diagnostics”，勾选“Address Sanitizer”，保存设置。点击DevEco Studio界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“address-sanitizer”，触发一次地址越界事件。应用崩溃后重新进入应用，可以在Log窗口看到对系统事件数据的处理日志：
267
268   ```text
269   HiAppEvent eventInfo.domain=OS
270   HiAppEvent eventInfo.name=ADDRESS_SANITIZER
271   HiAppEvent eventInfo.eventType=1
272   HiAppEvent eventInfo.params.time=1713148093326
273   HiAppEvent eventInfo.params.bundle_version=1.0.0
274   HiAppEvent eventInfo.params.bundle_name=com.example.myapplication
275   HiAppEvent eventInfo.params.pid=3378
276   HiAppEvent eventInfo.params.uid=20020140
277   HiAppEvent eventInfo.params.type="stack-buffer-overflow"
278   HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/hiappevent/ADDRESS_SANITIZER_1713148093326_3378.log"]
279   HiAppEvent eventInfo.params.log_over_limit=false
280   ```
281
282### 步骤四：销毁事件观察者
283
2841. 移除事件观察者：
285
286   ```c++
287   static napi_value RemoveWatcher(napi_env env, napi_callback_info info) {
288       // 使观察者停止监听事件
289       OH_HiAppEvent_RemoveWatcher(systemEventWatcher);
290       return {};
291   }
292   ```
293
2942. 销毁事件观察者：
295
296   ```c++
297   static napi_value DestroyWatcher(napi_env env, napi_callback_info info) {
298       // 销毁创建的观察者，并置systemEventWatcher为nullptr。
299       OH_HiAppEvent_DestroyWatcher(systemEventWatcher);
300       systemEventWatcher = nullptr;
301       return {};
302   }
303   ```
304