harmony 鸿蒙插件

2022-08-09
浏览 (1783)

插件

概述

基本概念

begetctl介绍

具体参考begetctl命令。 - bootchart 插件

bootchart是一个用于linux启动过程性能分析的开源工具软件，在系统中自动收集CPU占用率、磁盘吞吐率、进程等信息，并以图形方式显示分析结果，可用作指导优化系统启动过程。begetctl命令参考：begetctl命令。 - bootevent 插件

bootevent是一个记录init进程及各个服务的启动关键事件的插件，记录内容包括事件名称，关联事件的服务的启动时间，事件发生时间。导出文件支持tracing解析，可用作指导优化系统启动过程。

约束与限制

bootchart和bootevent只支持标准系统， begetctl 支持小型系统和标准系统。

开发指导

参数说明

ServiceStatus

typedef enum {
SERVICE_IDLE = 0, // service add
SERVICE_STARTING, // service start
SERVICE_STARTED, // 2 service ok running
SERVICE_READY, // 3 service ok running
SERVICE_STOPPING,
SERVICE_STOPPED, // 5
SERVICE_ERROR,
SERVICE_SUSPENDED,
SERVICE_FREEZED,
SERVICE_DISABLED,
SERVICE_CRITICAL
} ServiceStatus;

开发步骤

新增一个插件，以bootchart为例：

安装so文件，定义单独文件，实现下面函数。

  static int bootchartEarlyHook(int stage, int prio, void *cookie)
  {
      char enable[4] = {}; // 4 enable size
      uint32_t size = sizeof(enable);
      SystemReadParam("persist.init.bootchart.enabled", enable, &size);
      if (strcmp(enable, "1") != 0) {
          PLUGIN_LOGI("bootchart disabled.");
          return 0;
      }
      InitModuleMgrInstall("libbootchart");
      PLUGIN_LOGI("bootchart enabled.");
      return 0;
  }


  MODULE_CONSTRUCTOR(void)
  {
      // Depends on parameter service
      InitAddPostPersistParamLoadHook(0, bootchartEarlyHook);
  }

编译成静态库libbootchart_static，并加入static_modules组。

  group("static_modules") {
    if (!defined(ohos_lite)) {
      deps = [ ":libbootchart_static" ]
    }
  }

初始化bootchart插件，可以安装插件命令。

  static int BootchartInit(void)
  {
      if (g_executorId == -1) {
          g_executorId = AddCmdExecutor("bootchart", DoBootchartCmd);
          PLUGIN_LOGI("BootchartInit executorId %d", g_executorId);
      }
      return 0;
  }


  MODULE_CONSTRUCTOR(void)
  {
      PLUGIN_LOGI("DoBootchartStart now ...");
      BootchartInit();
  }

退出bootchart插件。

  MODULE_DESTRUCTOR(void)
  {
      PLUGIN_LOGI("DoBootchartStop now ...");
      DoBootchartStop();
      BootchartExit();
  }

执行bootchart命令。

static int DoBootchartCmd(int id, const char *name, int argc, const char **argv)
{
    PLUGIN_LOGI("DoBootchartCmd argc %d %s", argc, name);
    ...
    return 0;
}

开发实例

bootchart 使用示例

预制条件： 1. 准备bootchart测试环境：linux操作系统下安装python及pycairo pip install pycairo。 2. 在linux解压bootchart-master.tar。

 tar -zxvf  bootchart-master.tar

执行步骤： 1. 启动系统。 2. 执行命令行：begetctl bootchart enable。 3. 重启系统。 4. 执行命令行：begetctl bootchart stop。 5. 执行命令行：begetctl bootchart disable。 6. 在/data/service/el0/startup/init/目录下导出如下文件并存放在bootchart文件夹：
header
proc_diskstats.log
proc_ps.log
proc_stat.log
7. 使用tar -zcvf bootchart.tgz * 命令进行打包（只支持linux版本）并将该打包文件拷贝到linux：bootchart-master目录下。 8. 在bootchart-master目录下运行命令： python3 pybootchartgui.py -f pdf bootchart.tgz

预期结果：
        在bootchart-master目录下生成bootchart.pdf。

bootevent 使用示例

在服务的cfg文件中配置bootevent事件,支持配置一个或多个bootevent事件。

配置单个bootevent事件:
```
bootevents : "bootevent.xxxbootevent",
```
配置多个bootevent事件:
```
bootevents : ["bootevent.xxxbootevent1", "bootevent.xxxbootevent2.xxx"],
```
注意： 配置的bootevent事件必须以“bootevent.”开始。
服务代码中发送bootevent事件。

服务自身代码中调用init提供的SetParameter接口发送bootevent事件,例如发送上一步骤中设置的XXXbootevent1事件：
```
SetParameter("bootevent.XXXbootevent1", "true");
```
命令行启用bootevent功能。
- 执行begetctl bootevent enable命令后再次启动系统，bootevent功能开启。
- 执行begetctl bootevent disable命令后再次启动系统，bootevent功能关闭。
导出文件支持trace分析。
- 导出的bootevent文件目录：/data/service/el0/startup/init/。
- 导出文件命名规则：“时间戳.bootevent”。
- 导出的bootevent信息文件可以通过trace分析工具进行可视化展示。