• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 订阅地址越界事件（ArkTS）
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接口的具体使用说明（参数使用限制、具体取值范围等）请参考[@ohos.hiviewdfx.hiAppEvent (应用事件打点)ArkTS API文档](../reference/apis-performance-analysis-kit/js-apis-hiviewdfx-hiappevent.md)。
12
13| 接口名 | 描述 |
14| -------- | -------- |
15| addWatcher(watcher: Watcher): AppEventPackageHolder | 添加应用事件观察者，以添加对应用事件的订阅。 |
16| removeWatcher(watcher: Watcher): void | 移除应用事件观察者，以移除对应用事件的订阅。 |
17
18## 开发步骤
19
20以实现对写数组越界场景生成的地址越界事件订阅为例，说明开发步骤。
21
22### 步骤一：新建工程
23
241. 新建Native C++工程，目录结构如下：
25
26   ```yml
27   entry:
28     src:
29       main:
30         cpp:
31           - types:
32               libentry:
33                 - index.d.ts
34           - CMakeLists.txt
35           - napi_init.cpp
36         ets:
37           - entryability:
38               - EntryAbility.ets
39           - pages:
40               - Index.ets
41   ```
42
432. 编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，导入依赖模块：
44
45   ```ts
46   import { hiAppEvent, hilog } from '@kit.PerformanceAnalysisKit';
47   ```
48
49### 步骤二：订阅地址越界事件
50
511. 编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，在onCreate函数中添加系统事件的订阅，示例代码如下
52
53   ```ts
54   hiAppEvent.addWatcher({
55     // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
56     name: "watcher",
57     // 开发者可以订阅感兴趣的系统事件，此处是订阅了地址越界事件
58     appEventFilters: [
59       {
60         domain: hiAppEvent.domain.OS,
61         names: [hiAppEvent.event.ADDRESS_SANITIZER]
62       }
63     ],
64     // 开发者可以自行实现订阅系统事件回调函数，以便对订阅获取到的事件数据进行自定义处理
65     onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
66       hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`);
67       for (const eventGroup of appEventGroups) {
68         // 开发者可以根据事件集合中的事件名称区分不同的系统事件
69         hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`);
70         for (const eventInfo of eventGroup.appEventInfos) {
71           // 开发者可以对事件集合中的事件数据进行自定义处理，此处是将事件数据打印在日志中
72           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.domain=${eventInfo.domain}`);
73           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.name=${eventInfo.name}`);
74           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.eventType=${eventInfo.eventType}`);
75           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.time=${eventInfo.params['time']}`);
76           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.bundle_version=${eventInfo.params['bundle_version']}`);
77           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.bundle_name=${eventInfo.params['bundle_name']}`);
78           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.pid=${eventInfo.params['pid']}`);
79           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.uid=${eventInfo.params['uid']}`);
80           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.type=${eventInfo.params['type']}`);
81           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.external_log=${JSON.stringify(eventInfo.params['external_log'])}`);
82           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.log_over_limit=${eventInfo.params['log_over_limit']}`);
83         }
84       }
85     }
86   });
87   ```
88
89### 步骤三：构造地址越界错误
90
911. 编辑“entry > src > main > cpp > napi_init.cpp”文件，该文件实现地址越界场景，并提供NAPI接口给应用层代码调用，完整示例代码如下：
92
93   ```c++
94   #include "napi/native_api.h"
95
96   static napi_value Test(napi_env env, napi_callback_info info)
97   {
98       int a[10];
99       // 构造数组越界写入
100       a[10] = 1;
101       return {};
102   }
103
104   EXTERN_C_START
105   static napi_value Init(napi_env env, napi_value exports)
106   {
107       napi_property_descriptor desc[] = {
108           { "test", nullptr, Test, nullptr, nullptr, nullptr, napi_default, nullptr }
109       };
110       napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
111       return exports;
112   }
113   EXTERN_C_END
114
115   static napi_module demoModule = {
116       .nm_version = 1,
117       .nm_flags = 0,
118       .nm_filename = nullptr,
119       .nm_register_func = Init,
120       .nm_modname = "entry",
121       .nm_priv = ((void*)0),
122       .reserved = { 0 }
123   };
124
125   extern "C" __attribute__((constructor)) void RegisterEntryModule(void)
126   {
127       napi_module_register(&demoModule);
128   }
129   ```
130
1312. 编辑“entry > src > main > cpp > types > libentry > index.d.ts”文件，完整示例代码如下：
132
133   ```ts
134   export const test: () => void;
135   ```
136
1373. 编辑工程中的“entry > src > main > ets  > pages > Index.ets”文件，新增按钮触发地址越界事件：
138
139   ```ts
140   import testNapi from 'libentry.so';
141
142   @Entry
143   @Component
144   struct Index {
145     build() {
146       Row() {
147         Column() {
148           Button("address-sanitizer").onClick(() => {
149             testNapi.test();
150           })
151         }
152         .width('100%')
153       }
154       .height('100%')
155     }
156   }
157   ```
158
1594. 点击DevEco Studio界面中的“entry”，点击“Edit Configurations”，点击“Diagnostics”，勾选“Address Sanitizer”，保存设置。点击DevEco Studio界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“address-sanitizer”，触发一次地址越界事件。应用崩溃后重新进入应用，可以在Log窗口看到对系统事件数据的处理日志：
160
161   ```text
162   HiAppEvent onReceive: domain=OS
163   HiAppEvent eventName=ADDRESS_SANITIZER
164   HiAppEvent eventInfo.domain=OS
165   HiAppEvent eventInfo.name=ADDRESS_SANITIZER
166   HiAppEvent eventInfo.eventType=1
167   HiAppEvent eventInfo.time=1713161197957
168   HiAppEvent eventInfo.bundle_version=1.0.0
169   HiAppEvent eventInfo.bundle_name=com.example.myapplication
170   HiAppEvent eventInfo.pid=12889
171   HiAppEvent eventInfo.uid=20020140
172   HiAppEvent eventInfo.type=stack-buffer-overflow
173   HiAppEvent eventInfo.external_log=["/data/storage/el2/log/hiappevent/ADDRESS_SANITIZER_1713161197960_12889.log"]
174   HiAppEvent eventInfo.log_over_limit=false
175   ```
176