订阅资源泄漏事件（C/C++）
===============

#### 接口说明

本文介绍如何使用HiAppEvent提供的C/C++接口订阅资源泄漏事件。API接口的具体使用说明（参数使用限制、具体取值范围等）请参考[hiappevent.h](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-hiappevent-h)。

**订阅接口功能介绍**：

| 接口名 | 描述 |
| :-- | :-- |
| int OH\_HiAppEvent\_AddWatcher(HiAppEvent\_Watcher \*watcher) | 添加应用事件观察者，以添加对应用事件的订阅。 |
| int OH\_HiAppEvent\_RemoveWatcher(HiAppEvent\_Watcher \*watcher) | 移除应用事件观察者，以移除对应用事件的订阅。 |

#### 开发步骤

#### \[h2\]步骤一：新建工程

1.  获取该示例工程依赖的jsoncpp文件，从[三方开源库jsoncpp代码仓](https://github.com/open-source-parsers/jsoncpp)下载源码的压缩包，并按照README的**Amalgamated source**中介绍的操作步骤得到jsoncpp.cpp、json.h和json-forwards.h三个文件。
    
    在DevEco Studio中新建工程，选择“Native C++”工程。目录结构如下：
    
    entry:
      src:
        main:
          cpp:
            - json:
                - json.h
                - json-forwards.h
            - types:
                libentry:
                  - index.d.ts
            - CMakeLists.txt
            - napi\_init.cpp
            - jsoncpp.cpp
          ets:
            - entryability:
                - EntryAbility.ets
            - pages:
                - Index.ets
    
2.  编辑“CMakeLists.txt”文件，添加源文件及动态库：
    
    \# 新增jsoncpp.cpp(解析订阅事件中的json字符串)源文件
    add\_library(entry SHARED napi\_init.cpp jsoncpp.cpp)
    # 新增动态库依赖libhiappevent\_ndk.z.so和libhilog\_ndk.z.so(日志输出)
    target\_link\_libraries(entry PUBLIC libace\_napi.z.so libhilog\_ndk.z.so libhiappevent\_ndk.z.so)
    
3.  编辑“napi\_init.cpp”文件，导入依赖文件，并定义LOG\_TAG：
    
    #include "napi/native\_api.h"
    #include "json/json.h"
    #include "hilog/log.h"
    #include "hiappevent/hiappevent.h"
    
    #undef LOG\_TAG
    #define LOG\_TAG "testTag"
    

#### \[h2\]步骤二：订阅系统事件

1.  订阅系统事件：
    
    *   onReceive类型观察者：
        
        编辑“napi\_init.cpp”文件，定义onReceive类型观察者相关方法：
        
        // 定义一个变量，用来缓存创建的观察者的指针。
        static HiAppEvent\_Watcher \*systemEventWatcher;
        
        static void OnReceive(const char \*domain, const struct HiAppEvent\_AppEventGroup \*appEventGroups, uint32\_t groupLen) {
            for (int i = 0; i < groupLen; ++i) {
                for (int j = 0; j < appEventGroups\[i\].infoLen; ++j) {
                    OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.domain=%{public}s", appEventGroups\[i\].appEventInfos\[j\].domain);
                    OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.name=%{public}s", appEventGroups\[i\].appEventInfos\[j\].name);
                    OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.eventType=%{public}d", appEventGroups\[i\].appEventInfos\[j\].type);
                    if (strcmp(appEventGroups\[i\].appEventInfos\[j\].domain, DOMAIN\_OS) == 0 &&
                        strcmp(appEventGroups\[i\].appEventInfos\[j\].name, EVENT\_RESOURCE\_OVERLIMIT) == 0) {
                        Json::Value params;
                        Json::Reader reader(Json::Features::strictMode());
                        Json::FastWriter writer;
                        if (reader.parse(appEventGroups\[i\].appEventInfos\[j\].params, params)) {
                            auto time = params\["time"\].asInt64();
                            auto pid = params\["pid"\].asInt();
                            auto uid = params\["uid"\].asInt();
                            auto resourceType = params\["resourceType"\].asString();
                            auto bundleName = params\["bundle\_name"\].asString();
                            auto appRunningUniqueId = params\["app\_running\_unique\_id"\].asString();
                            auto bundleVersion = params\["bundle\_version"\].asString();
                            auto memory = writer.write(params\["memory"\]);
                            auto externalLog = writer.write(params\["external\_log"\]);
                            std::string logOverLimit = params\["log\_over\_limit"\].asBool() ? "true":"false";
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time);
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid);
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid);
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.resource\_type=%{public}s", resourceType.c\_str());
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.bundle\_name=%{public}s", bundleName.c\_str());
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.app\_running\_unique\_id=%{public}s", appRunningUniqueId.c\_str());
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.bundle\_version=%{public}s", bundleVersion.c\_str());
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.memory=%{public}s", memory.c\_str());
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.external\_log=%{public}s", externalLog.c\_str());
                            OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.log\_over\_limit=%{public}s", logOverLimit.c\_str());
                        }
                    }
                }
            }
        }
        
        static napi\_value RegisterWatcher(napi\_env env, napi\_callback\_info info) {
            // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。
            systemEventWatcher = OH\_HiAppEvent\_CreateWatcher("onReceiverWatcher");
            // 设置订阅的事件为EVENT\_RESOURCE\_OVERLIMIT。
            const char \*names\[\] = {EVENT\_RESOURCE\_OVERLIMIT};
            // 开发者订阅感兴趣的事件，此处订阅了系统事件。
            OH\_HiAppEvent\_SetAppEventFilter(systemEventWatcher, DOMAIN\_OS, 0, names, 1);
            // 开发者设置已实现的回调函数，观察者接收到事件后回立即触发OnReceive回调。
            OH\_HiAppEvent\_SetWatcherOnReceive(systemEventWatcher, OnReceive);
            // 使观察者开始监听订阅的事件。
            OH\_HiAppEvent\_AddWatcher(systemEventWatcher);
            return {};
        }
        
    *   onTrigger类型观察者：
        
        编辑“napi\_init.cpp”文件，定义OnTrigger类型观察者相关方法：
        
        // 定义一个变量，用来缓存创建的观察者的指针。
        static HiAppEvent\_Watcher \*systemEventWatcher;
        
        // 开发者可以自行实现获取已监听到事件的回调函数，其中events指针指向内容仅在该函数内有效。
        static void OnTake(const char \*const \*events, uint32\_t eventLen) {
            Json::Reader reader(Json::Features::strictMode());
            Json::FastWriter writer;
            for (int i = 0; i < eventLen; ++i) {
                Json::Value eventInfo;
                if (reader.parse(events\[i\], eventInfo)) {
                    auto domain =  eventInfo\["domain\_"\].asString();
                    auto name = eventInfo\["name\_"\].asString();
                    auto type = eventInfo\["type\_"\].asInt();
                    OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.domain=%{public}s", domain.c\_str());
                    OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.name=%{public}s", name.c\_str());
                    OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.eventType=%{public}d", type);
                    if (domain ==  DOMAIN\_OS && name == EVENT\_RESOURCE\_OVERLIMIT) {
                        auto time = eventInfo\["time"\].asInt64();
                        auto pid = eventInfo\["pid"\].asInt();
                        auto uid = eventInfo\["uid"\].asInt();
                        auto resourceType = eventInfo\["resourceType"\].asString();
                        auto bundleName = eventInfo\["bundle\_name"\].asString();
                        auto appRunningUniqueId = eventInfo\["app\_running\_unique\_id"\].asString();
                        auto bundleVersion = eventInfo\["bundle\_version"\].asString();
                        auto memory = writer.write(eventInfo\["memory"\]);
                        auto externalLog = writer.write(eventInfo\["external\_log"\]);
                        std::string logOverLimit = eventInfo\["log\_over\_limit"\].asBool() ? "true":"false";
                        OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time);
                        OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid);
                        OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid);
                        OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.resource\_type=%{public}s", resourceType.c\_str());
                        OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.bundle\_name=%{public}s", bundleName.c\_str());
                        OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.app\_running\_unique\_id=%{public}s", appRunningUniqueId.c\_str());
                        OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.bundle\_version=%{public}s", bundleVersion.c\_str());
                        OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.memory=%{public}s", memory.c\_str());
                        OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.external\_log=%{public}s", externalLog.c\_str());
                        OH\_LOG\_INFO(LogType::LOG\_APP, "HiAppEvent eventInfo.params.log\_over\_limit=%{public}s", logOverLimit.c\_str());
                    }
                }
            }
        }
        
        // 开发者可以自行实现订阅回调函数，以便对获取到的事件打点数据进行自定义处理。
        static void OnTrigger(int row, int size) {
            // 接收回调后，获取指定数量的已接收事件。
            OH\_HiAppEvent\_TakeWatcherData(systemEventWatcher, row, OnTake);
        }
        
        static napi\_value RegisterWatcher(napi\_env env, napi\_callback\_info info) {
            // 开发者自定义观察者名称，系统根据不同的名称来识别不同的观察者。
            systemEventWatcher = OH\_HiAppEvent\_CreateWatcher("onTriggerWatcher");
            // 设置订阅的事件为EVENT\_RESOURCE\_OVERLIMIT。
            const char \*names\[\] = {EVENT\_RESOURCE\_OVERLIMIT};
            // 开发者订阅感兴趣的事件，此处订阅了系统事件。
            OH\_HiAppEvent\_SetAppEventFilter(systemEventWatcher, DOMAIN\_OS, 0, names, 1);
            // 开发者设置已实现的回调函数，需OH\_HiAppEvent\_SetTriggerCondition设置的条件满足方可触发。
            OH\_HiAppEvent\_SetWatcherOnTrigger(systemEventWatcher, OnTrigger);
            // 开发者可以设置订阅触发回调的条件，此处是设置新增事件打点数量为2个时，触发onTrigger回调。
            OH\_HiAppEvent\_SetTriggerCondition(systemEventWatcher, 1, 0, 0);
            // 使观察者开始监听订阅的事件。
            OH\_HiAppEvent\_AddWatcher(systemEventWatcher);
            return {};
        }
        
2.  将RegisterWatcher注册为ArkTS接口：
    
    编辑“napi\_init.cpp”文件，将RegisterWatcher注册为ArkTS接口：
    
    static napi\_value Init(napi\_env env, napi\_value exports)
    {
        napi\_property\_descriptor desc\[\] = {
            { "registerWatcher", nullptr, RegisterWatcher, nullptr, nullptr, nullptr, napi\_default, nullptr }
        };
        napi\_define\_properties(env, exports, sizeof(desc) / sizeof(desc\[0\]), desc);
        return exports;
    }
    
    编辑“index.d.ts”文件，定义ArkTS接口：
    
    export const registerWatcher: () => void;
    
3.  编辑“EntryAbility.ets”文件，在onCreate()函数中添加接口调用：
    
    import testNapi from 'libentry.so'
    import hidebug from '@kit.PerformanceAnalysisKit'
    export default class EntryAbility extends UIAbility {
      onCreate(want, launchParam) {
        // 启动时，注册系统事件观察者
        testNapi.registerWatcher();
      }
    }
    

#### \[h2\]步骤三：测试资源泄漏事件

1.  编辑工程中的“entry > src > main > ets > pages > Index.ets”文件，添加按钮并在其 onClick 函数中构造资源泄漏场景，以触发资源泄漏事件。
    
    此处需要使用[hidebug.setAppResourceLimit](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/js-apis-hidebug#hidebugsetappresourcelimit12)设置内存限制，造成内存泄漏，同步在“开发者选项”中打开“系统资源泄漏日志”(开关状态变更后需重启设备)。接口示例代码如下：
    
    Button('pss leak')
        .type(ButtonType.Capsule)
        .margin({
          top: 20
        })
        .backgroundColor('#0D9FFB')
        .width('80%')
        .height('5%')
        .onClick(() => {
          // 设置一个简单的资源泄漏场景
          hilog.info(0x0000, 'testTag', 'click pss leak button');
          testNapi.leakMB(3072);
        })
    
2.  添加 pss leak 相关内容：
    
    编辑“napi\_init.cpp”文件：
    
    *   头文件加入：
    
    #include <iostream>
    #include <fstream>
    #include <sstream>
    #include <thread>
    
    *   定义 pss leak 相关方法：
    
    // 读 /proc/self/smaps\_rollup 中的 PSS 字段，统计当前进程的 PSS (单位 KB)
    static int GetCurrentProcessPss()
    {
        std::ifstream smapsFile("/proc/self/smaps\_rollup");
        if (!smapsFile.is\_open()) {
            std::cerr << "Failed to open /proc/self/smaps\_rollup" << std::endl;
            return 0;
        }
        std::string line;
        int totalPss = 0;
        while (std::getline(smapsFile, line)) {
            if (line.find("Pss:") == 0) {
                std::istringstream iss(line);
                std::string label;
                int pss;
                iss >> label >>pss;
                totalPss += pss;
            }
        }
        smapsFile.close();
        std::cout << "Current pss: " << totalPss << " KB\\r";
        std::cout.flush();
        return totalPss;
    }
    
    // 读取当前进程的 FD 数量
    static int GetCurrentFd()
    {
        std::ifstream fdFile("/proc/self/fd\_num");
        if (!fdFile.is\_open()) {
            std::cerr << "Failed to open /proc/self/fd\_num" << std::endl;
            return 0;
        }
        std::string line;
        int totalPss = 0;
        std::getline(fdFile, line);
        fdFile.close();
        std::cout << "Current fd: " << line << std::endl;
        std::cout.flush();
        return std::stoi(line);
    }
    
    // 申请 size 字节内存并写入数据（用 'a' 填充），制造 native 内存增长
    static bool InjectNativeLeakMallocWithSize(int size, char \*p)
    {
        const size\_t maxSafe = 1073741824;
        if (size < 0 || size > maxSafe) {
            printf("InjectNativeLeakMallocWithSize invalid size\\n");
            return false;
        }
        p = (char \*) malloc(size + 1);
        if (!p) {
            printf("InjectNativeLeakMallocWithSize malloc failed\\n");
            return false;
        }
        void\* err = memset(p, 'a', size);
        if (err == nullptr) {
            printf("InjectNativeLeakMallocWithSize memset failed\\n");
            return false;
        }
        return true;
    }
    
    // 循环申请/释放内存，使进程 PSS 持续接近 target
    static void InjectNativeLeakMallocUntil(int target)
    {
        constexpr int leakSizePerTime = 5000000;
        std::vector<char \*> mems;
        int curPss = GetCurrentProcessPss();
        while (curPss != 0) {
            char \*p = nullptr;
            if (curPss < target) {
                if (!InjectNativeLeakMallocWithSize(leakSizePerTime, p)) {
                    printf("InjectNativeLeakMallocUntil target = %d failed\\n", target);
                }
                mems.push\_back(p);
                std::cout << "Inject size: " << leakSizePerTime << ", currentSize: " << mems.size() << std::endl;
            } else {
                if (mems.size() > 0) {
                    char \*dst = mems\[0\];
                    mems.erase(mems.begin());
                    free(dst);
                }
                std::cout << "Free size: " << leakSizePerTime << ", currentSize: " << mems.size() << std::endl;
            }
            curPss = GetCurrentProcessPss();
        }
        std::cout << std::endl;
        printf("InjectNativeLeakMallocUntil target = %d success\\n", target);
    }
    
    // 启动后台执行的 InjectNativeLeakMallocUntil 线程，使 native 内存占用接近 leakSize
    static void StartNativeLeak(int leakSize)
    {
        std::cout << "Start inject malloc until" << leakSize << "KB" << std::endl;
        std::thread t1(InjectNativeLeakMallocUntil, leakSize);
        t1.detach();
        std::cout << "Inject finished." << std::endl;
    }
    
    // N-API 导出方法
    static napi\_value LeakMB(napi\_env env, napi\_callback\_info info)
    {
        size\_t argc = 1;
        napi\_value args\[1\];
        napi\_get\_cb\_info(env, info, &argc, args, nullptr, nullptr);
        if (argc < 1) {
            napi\_throw\_type\_error(env, nullptr, "Expected 1 argument");
            return nullptr;
        }
        double x = 0;
        if (napi\_get\_value\_double(env, args\[0\], &x) != napi\_ok) {
            napi\_throw\_type\_error(env, nullptr, "Argument must be a number");
            return nullptr;
        }
        const size\_t kilobyte = 1024;
        StartNativeLeak(static\_cast<size\_t>(x \* kilobyte));
        napi\_value rtn;
        napi\_get\_undefined(env, &rtn);
        return rtn;
    }
    
    *   初始化：
    
    static napi\_value Init(napi\_env env, napi\_value exports)
    {
        napi\_property\_descriptor desc\[\] = {
            // ...
            { "leakMB", nullptr, LeakMB, nullptr, nullptr, nullptr, napi\_default, nullptr}
        };
        napi\_define\_properties(env, exports, sizeof(desc) / sizeof(desc\[0\]), desc);
        return exports;
    }
    
    编辑"Index.d.ts"文件：
    
    *   添加类型声明：
    
    export const leakMB: (size: number) => void;
    
3.  单击DevEco Studio界面中的运行按钮，运行应用工程，单击 pss leak 按钮后，等待15到30分钟，系统将上报应用内存泄漏事件。
    
    同一个应用，24小时内至多上报一次资源泄漏事件，如果短时间内要二次上报，需要重启设备。
    
4.  内存泄漏事件上报后，可以在Log窗口看到对系统事件数据的处理日志：
    
    08-07 03:53:35.314 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.domain=OS
    08-07 03:53:35.314 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.name=RESOURCE\_OVERLIMIT
    08-07 03:53:35.314 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.eventType=1
    08-07 03:53:35.349 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.params.time=1502049167732
    08-07 03:53:35.349 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.params.pid=1587
    08-07 03:53:35.349 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.params.uid=20010043
    08-07 03:53:35.349 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.params.resource\_type=pss\_memory
    08-07 03:53:35.349 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.params.bundle\_name=com.example.myapplication
    08-07 03:53:35.349 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.params.app\_running\_unique\_id=12369547851223645271
    08-07 03:53:35.349 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.params.bundle\_version=1.0.0
    08-07 03:53:35.350 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.params.memory={"pss":2100257,"rss":1352644,"sys\_avail\_mem":250272,"sys\_free\_mem":60004,"sys\_total\_mem":1992340,"vss":2462936}
    08-07 03:53:35.350 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.params.external\_log=\["/data/storage/el2/log/resourcelimit/RESOURCE\_OVERLIMIT\_1725614572401\_6808.log","/data/storage/el2/log/resourcelimit/RESOURCE\_OVERLIMIT\_1725614572412\_6808.log"\]
    08-07 03:53:35.350 1719-1738/? I A00000/testTag: HiAppEvent eventInfo.params.log\_over\_limit=false
    

#### \[h2\]步骤四：移除观察者

1.  移除事件观察者：
    
    static napi\_value RemoveWatcher(napi\_env env, napi\_callback\_info info) {
        // 移除观察者以停止监听事件
        OH\_HiAppEvent\_RemoveWatcher(systemEventWatcher);
        return {};
    }
    
2.  销毁事件观察者：
    
    static napi\_value DestroyWatcher(napi\_env env, napi\_callback\_info info) {
        // 销毁创建的观察者，并置systemEventWatcher为nullptr。
        OH\_HiAppEvent\_DestroyWatcher(systemEventWatcher);
        systemEventWatcher = nullptr;
        return {};
    }