@hmos-library-adapter/fast 0.0.17-beta.0 → 0.0.17-beta.2

package/node_modules/@ohos-agent/pc-adapter/skills/openharmony-device-porting/references-full/subsystems/subsys-boot-init-faqs.md

@@ -0,0 +1,191 @@
+# init常见问题指导
+
+## 服务进程相关问题
+
+### 系统服务进程退出后不自动重启
+
+    查看服务进程的cfg文件，是否将"once"项配置为1；该项若为1，则表示为一次性进程，进程退出后不会再被init拉起
+
+### 如何默认disable系统服务进程
+
+    当前服务的cfg文件中配置"disable" 项未启用，可以通过配置"start-mode" 项来控制启动方式
+
+### 如何关闭系统服务进程沙盒
+
+    在服务的cfg文件中配置 "sandbox" : 0 即服务不进入沙盒、1为进入沙盒，默认服务是进入沙盒
+
+### 服务不存在
+
+  **现象描述：**
+
+  kernel日志打印 "Failed get servName"。
+
+  **原因分析：**
+
+  在init中查找对应的代码位置，发现是服务不存在。
+
+  **解决方法：**
+
+  1. 确认服务是否在cfg中正确配置。
+  2. 服务的cfg文件是否正常加载。
+  3. cfg文件格式是否正确。
+## init开机启动相关问题
+
+### 卡在开机Logo界面
+
+ 1. 原因分析：init 二级启动没有完成。
+
+    解决方法：执行begetctl setloglevel 0并重启设备，通过串口查看内核日志。确认init的二级启动是否正常完成，关键log如下：
+    
+  ```
+  [32.173144][pid=1] [Init] [INFO] [init.c:206]Start init second stage.
+  [33.173144][pid=1] [Init] [DEBUG] [init.c:206]Parse init configs from /etc/init.cfg.
+  ```
+
+​   如果此时hdcd服务没有启动，或者分区没有挂载好，无法执行begetctl 命令。需要修改init 代码，设置log等级。确保init 的debug        log能正常输出。
+
+ 2. 原因分析：init.cfg 解析失败。
+
+    1. cfg json格式错误。
+    2. 无法正确解析：无权限或权限受限。
+
+    解决方法：
+
+      1. 排查cfg文件json格式， init cfg文件遵循json格式，按要求修改cfg文件。
+      2. 日志中有 permission denied，init 进程报权限问题。判断是否是selinux 导致的，关闭selinux 重新验证，如果正常，无权限报错。则是selinux 策略配置不正确导致的。 请配置正确的selinux 策略。selinux 策略配置，请参考base/security/selinux_adapter 仓中的说明。
+
+  3. 原因分析：required mount 分区没有正常挂载。
+
+     1. cmdline中没有配置或格式错误。
+     2. ramdisk中没有fstag.requried 文件。
+
+     解决方法：
+
+       1. 查看日志， 查看Kernel command line 中是否required mount 分区配置；如果配置，查看cmdline格式是否出错，按照格式修改或添加命令。
+          
+          ```
+          [0.000000] Kernel command line: currentslot=0 bootslots=0 rw rootwait earlycon=uart8250,mmio32,0xfe660000 console=ttyFIQ0 ohos.boot.eng_mode=on root=PARTUUID=614e0000-0000 hardware=rk3568 default_boot_device=fe310000.sdhci ohos.required_mount.system=/dev/block/platform/fe310000.sdhci/by-name/system@/usr@ext4@ro,barrier=1@wait,required ohos.required_mount.vendor=/dev/block/platform/fe310000.sdhci/by-name/vendor@/vendor@ext4@ro,barrier=1@wait,required ohos.required_mount.misc=/dev/block/platform/fe310000.sdhci/by-name/misc@none@none@none@wait,required ohos.required_mount.bootctrl=/dev/block/platform/fe310000.sdhci/by-name/bootctrl@none@none@none@wait,required
+          ```
+
+           或 在设备中通过cat /proc/cmdline 查看。
+
+       2. 查看 ramdisk.img 中是否存在fstab.required文件。
+
+  4. 原因分析：com.ohos.launcher 没有启动， 导致无开机动画。
+
+     1. ps -ef 查看com.ohos.launcher是否存在。
+
+     解决方案：根据日志具体分析。
+
+  5. 原因分析： bootanimation 启动失败。
+
+     1. 查看bootanimation服务是否被拉起。
+     2. 判断bootanimation是否被重复拉起。
+
+     解决方法：
+
+     1. 在日志中查看log： 
+
+        ```
+        [10.175192] [pid=1] [Init] [INFO] [init_service_manager.c:1088]Start service bootanimation
+        ```
+
+         表示服务启动。
+
+  6. 原因分析：data分区没有正常挂载
+
+     1. 设备分区表没有配置userdata分区。
+     2. device的fstab 中没有给出data分区的挂载配置。
+     3. device 给的fstab中配置的文件系统与userdata 镜像实际的文件系统不匹配。如fstab 中配置的是ext4, 而userdata 镜像实际的文件系统是f2fs。
+
+     解决方法：
+
+     对应的关键内核日志:
+
+     1. "wait for file:/dev/block/platform/soc/10100000.himci.eMMC/by-name/userdata failed after"。
+     2. 日志中看不到userdata 任何挂载相关的输出。
+     3. "Mount /dev/block/platform/soc/10100000.himci.eMMC/by-name/userdata to /data failed",  如果fstab 配置了nofail, log 有"Mount no fail     device /dev/block/platform/soc/10100000.himci.eMMC/by-name/userdata to /data failed"
+      nofail，表示该设备的挂载，不可以失败。
+
+### 卡在开机动画界面
+
+  **原因分析：**
+
+  1. 开机动画没有正常退出。
+  2. 系统应用孵化失败。
+  3. 服务上报bootevent不完整，所有注册了bootevent 的服务，没有全部上报。
+
+  **解决方法：**
+
+  1. 查看服务是否在反复重启， 重启服务是否配置critical。
+  2. ps -ef | grep ohos, 确定系统应用是否存在；日志中有 permission denied，init进程报权限问题。 确认系统应用权限，关闭selinux， 重新验证，如果正常， 则是selinux 策略配置不正确导致，重新配置或添加对应的selinux权限。 [selinux 策略配置](https://gitcode.com/openharmony/security_selinux_adapter#%E6%97%A5%E5%BF%97%E4%BF%A1%E6%81%AF) 请参考base/security/selinux_adapter 仓中的说明。
+  3. 通过bootevent事件分析， 通过排查没有上报的bootevent的服务， 可能会导致开机动画卡死，比如systemUI。
+
+### 自动重启
+
+  **原因分析：**
+
+  1. init服务中定义“importance”的属性。
+  2. critcial 使能， 关键进程符合critical 会重启。
+  3. init进程挂掉会导致panic。
+
+  **解决方法：**
+
+  1. 小型系统中服务配置importance属性为0，importance: 0重启， 1 不重启。
+  2. 关键进程服务配置critcial 会导致进程重启。
+  3. CloseStdio();之前执行execv("/bin/sh", NULL)。
+
+### reboot命令无法重启
+
+  **原因分析：**
+
+ 1. reboot 插件安装失败。
+ 2. reboot 命令错误。
+ 3. ohos.startup.powerctrl reboot 系统参数设置失败。
+ 4. reboot selinux 权限受限。
+
+  **解决方法：**
+
+ 1. 插件安装成功，在板子中查看/system/lib/init/reboot/librebootmodule.z.so是否安装成功。
+ 2. 执行begetctl setloglevel 0设置日志级别，日志打印：
+
+  ```
+  08-10 18:48:07.653  1421  1421 D C02c0b/BEGET: [init_reboot_innerkits.c:51]Reboot cmd reboot
+  ```
+
+​    查看 reboot 命令， reboot命令不超过96。
+
+ 3. hdc shell 执行param set ohos.startup.powerctrl reboot， 观察是否重启， 重启表示系统参数设置成功。
+ 4. 日志中有 permission denied，init 进程报权限问题。关闭selinux, 重新验证， 如果验证成功，则是selnux策略配置不正确导致， 重新配置或添加对应的selinux权限。 [selinux 策略配置](https://gitcode.com/openharmony/security_selinux_adapter#%E6%97%A5%E5%BF%97%E4%BF%A1%E6%81%AF) 请参考base/security/selinux_adapter 仓中的说明。
+
+### 系统启动过程中打印“Cfg error!”错误后停止启动
+
+  **现象描述：**
+
+  系统启动过程中，解析init.cfg文件错误，启动过程停止，打印日志如下：
+
+  ```
+  Cfg error, failed to parse json etc/init.cfg
+  ```
+
+  **可能原因：**
+
+  修改init.cfg文件时，漏掉或多加了逗号或括号等，导致init.cfg文件的json格式被破坏。
+
+  **解决办法**
+
+  仔细检查init.cfg文件，确保其格式符合json格式要求。
+
+### 请求其他服务代持fd，init有报错
+
+  **现象描述：**
+
+  kernel日志打印 "Service ' xxx '(pid = xxx) is not valid or request with unexpected process(pid = xxx)"。
+
+  **原因分析：**
+
+  kernel日志打印，都是由init 打印。在init中查找对应的代码位置。发现是其他服务代持fd。
+
+  **解决方法：**
+
+  只支持代持本服务的fd，不允许让其他服务代持fd。

package/node_modules/@ohos-agent/pc-adapter/skills/openharmony-device-porting/references-full/subsystems/subsys-boot-init-jobs.md

@@ -0,0 +1,161 @@
+# jobs管理
+## 概述
+### 功能简介
+jobs是init组件下cfg文件中的一组命令构成的集合, 最多添加4096个job。 jobs可以在 **[cfg](subsys-boot-init-cfg.md)** 文件中配置，通常在init启动过程中执行，服务于service的正常启动或特定基础功能的初始化。
+
+### 基本概念
+job可以在init.cfg中配置，也可以在模块的自定义cfg中配置。init解析程序会把相同名字job的命令合并到一个job中。同一名字的job只能保证init.cfg中的命令优先执行，其他cfg间的命令执行顺序不保证。
+- 基本jobs
+
+  init启动的固定阶段，如“pre-init“，“init”，“post-init”，这类job在init启动的固定阶段执行。
+  - pre-init：init前置阶段，其他服务所依赖的，类似于ueventd、watchdog、hilogd等的关键服务会在这一阶段启动，data分区的挂载也在这一阶段进行。
+  - init：init进程的主要阶段，这一阶段除了大量命令的执行，同时也是init分组并行启动boot组（第一组）服务的启动阶段，一些关乎系统功能的重要服务会在这一阶段被拉起。
+  - post-init：这一阶段主要是通过trigger命令触发其他阶段执行，可以把所有被触发的阶段看作一个个的小阶段，也可以把它们统一看作post-init阶段，这一阶段会执行大量命令，并且它还是init分组并行启动normal组（第二组）服务的启动阶段，cfg中配置的大部分服务都是在这一阶段被拉起的。
+
+- 自定义jobs(仅标准系统以上提供)
+
+  这类job按照一定的规则进行触发，用户根据需要定义的命令集合，通过trigger命令触发执行。
+
+- 条件jobs(仅标准系统以上提供)
+
+  用户通过在jobs中添加condition配置，在条件满足时触发命令执行。
+
+  条件是系统参数值的组合，支持&& 、||等操作, 并且支持*匹配任意值。
+
+  一般情况可按如下示例配置：
+
+  ```
+  "condition" : "sys.usb.config = none && sys.usb.configfs = 0",
+  ```
+
+  如果特殊情况需要在boot阶段对参数做检查可按下面示例配置：
+
+  ```
+  "condition" : "boot && const.debuggable=1",
+  ```
+
+  并且jobs在定义命令时，按照下面的规则"param:xxx"命名, 可以根据不同的属性自行组合。
+
+### 约束与限制
+在标准系统下有系统参数模块的支持，支持基本jobs、条件jobs、自定义jobs。在小型系统中只支持基本jobs。
+
+## 开发指导
+### 场景介绍
+job就是命令集合，jobs管理就是对要执行的一组命令集合进行管理， 一组命令集合最多添加4096个命令。在init启动过程中，jobs的执行为服务的正常运行提供支持。
+
+### 参数说明
+
+   **表1** 命令集说明
+   | 命令 | 命令格式和示例 | 说明 |
+   | -------- | -------- | -------- |
+   | mkdir | mkdir 目标文件夹 [mode] [owner] [group]<br/>如：mkdir /storage/myDirectory<br>mkdir /storage/myDirectory 0755 root root| 创建文件夹命令，mkdir和目标文件夹之间有且只能有一个空格。<br>系统类型：小型系统和标准系统 |
+   | chmod | chmod&nbsp;权限&nbsp;目标<br/>如：chmod&nbsp;0600&nbsp;/storage/myFile.txt<br/>chmod&nbsp;0750&nbsp;/storage/myDir | 修改权限命令，chmod权限目标之间间隔有且仅有一个空格，权限必须为0xxx格式。<br>系统类型：小型系统和标准系统|
+   | chown | chown&nbsp;uid&nbsp;gid&nbsp;目标<br/>如：chown&nbsp;900&nbsp;800&nbsp;/storage/myDir<br/>chown&nbsp;100&nbsp;100&nbsp;/storage/myFile.txt | 修改属组命令，chown&nbsp;uid&nbsp;gid目标之间间隔有且仅有一个空格。<br>系统类型：小型系统和标准系统 |
+   | mount | mount&nbsp;fileSystemType&nbsp;src&nbsp;dst&nbsp;flags&nbsp;[data]<br/>如：mount&nbsp;vfat&nbsp;/dev/mmcblk0&nbsp;/sdc&nbsp;rw,umask=000<br/>mount&nbsp;jffs2&nbsp;/dev/mtdblock3&nbsp;/storage&nbsp;nosuid | 挂载命令，各参数之间有且仅有一个空格。flags参考base/startup/init/services/init/init_common_cmds.c中mountFlagMap函数mountFlagMap[]，data为可选字段。<br>系统类型：小型系统和标准系统 |
+   | start | start&nbsp;serviceName<br/>如：start&nbsp;foundation| 启动服务命令，start后面跟着service名称，该service名称必须能够在services数组中找到。<br>系统类型：小型系统和标准系统 |
+   | export | export key value<br>如：export TEST /data/test | 设置环境变量命令。后面跟两个参数，第一个参数是环境变量名，第二个参数是环境变量值。<br>系统类型：小型系统和标准系统 |
+   | rm | rm filename<br>如：rm /data/testfile | 删除文件命令。后面跟一个参数，即文件的绝对路径。<br>系统类型：小型系统和标准系统 |
+   | rmdir | rmdir dirname<br>如：rmdir /data/testdir | 删除目录命令。后面跟一个参数，即目录的绝对路径。 <br>系统类型：小型系统和标准系统 |
+   | write | write filename value<br>如：write /data/testfile 0 | 写文件命令。后面跟两个参数，第一个参数是文件的绝对路径，第二个参数是要写入文件的字符串。 <br>系统类型：小型系统和标准系统 |
+   | stop | stop serviceName<br>如：stop console | 关闭服务命令。后面跟一个参数，即要关闭的服务名。<br>系统类型：小型系统和标准系统 |
+   | copy | copy oldfile newfile<br>如：copy /data/old /data/new | 拷贝文件命令。后面跟两个参数，第一个参数是原文件绝对路径，第二个参数是新文件绝对路径。<br>系统类型：小型系统和标准系统 |
+   | reset | reset serviceName<br>如：reset console | 重置服务命令。后面跟一个参数，即要重启的服务名。目前reset命令的策略是，如果一个服务没有启动，则该命令会将其拉起，如果一个服务处于运行状态，则该命令会将其关闭后重启。<br>系统类型：小型系统和标准系统 |
+   | reboot | reboot [subsystem]<br>如：reboot updater | 重启系统命令。后面可以跟一个参数，也可以没有参数，当没有参数时执行该命令，将会使设备重启到当前系统，当后面跟参数时，参数应当是子系统的名字，例如,reboot updater，将会重启进入updater子系统。<br>系统类型：小型系统和标准系统 |
+   | sleep | sleep time<br>如：sleep 5 | 睡眠命令。后面可以跟一个参数，该参数是睡眠时间， 限制睡眠时间在5秒内。<br>sleep命令谨慎使用。<br>系统类型：小型系统和标准系统 |
+   | domainname | domainname name<br>如：domainname localdomain | 设置域名。<br>系统类型：小型系统和标准系统 |
+   | hostname | hostname name<br>如：hostname localhost | 设置主机名命令。<br>系统类型：小型系统和标准系统 |
+   | wait | wait filepath [time]<br>如：wait /data/testfile 或 wait /data/testfile 5| 等待命令，等待时间不超过5秒。<br>系统类型：小型系统和标准系统 |
+   | setrlimit | setrlimit resource curValue maxValue<br>如：setrlimit RLIMIT_CPU 10 100| 设定资源使用限制命令。<br>系统类型：小型系统和标准系统 |
+   | write | write path content<br>如：write /proc/sys/kernel/sysrq 0 | 写文件命令。<br>系统类型：小型系统和标准系统 |
+   | exec | exec 可执行文件路径 可执行文件传的参数<br>如： exec /system/bin/mkdir /data/test.txt | 系统调用命令。<br>系统类型：小型系统和标准系统 |
+   | syncexec | syncexec 可执行文件路径 可执行文件传的参数<br>如:syncexec /system/bin/udevadm trigger| 同步执行，syncexec 会调用wait等待子进程结束。参数个数不超过10个。<br>系统类型：标准系统
+   | mknode |mknode name { b \| c } Major Minor<br>如mknode path b 0644 1 9| 建立一个目录项和一个特殊文件的对应索引节点。<br>系统类型：标准系统 |
+   | makedev | makedev major minor<br>如：makedev -v update | 创建静态的设备节点命令，通常位于/dev目录下。<br>系统类型：标准系统 |
+   | symlink | symlink target link_name<br>如：symlink /proc/self/fd/0 /dev/stdin | 符号链接命令。<br>系统类型：标准系统 |
+   | trigger | trigger jobName<br>如：trigger early-fs | 触发job执行的命令。<br>系统类型：标准系统 |
+   | insmod | insmod [-f] [options]<br>如：insmod xxx.ko| 内核模块文件载入命令。<br>系统类型：标准系统 |
+   | setparam | setparam paramName paramValue<br>如：setparam sys.usb.config hdc| 设置系统参数。<br>系统类型：标准系统 |
+   | load_persist_params | load persist params<br>如：load_persist_params&nbsp;| 加载persist参数。load_persist_params命令后有且仅有一个空格。<br>系统类型：标准系统 |
+   | load_param | load params<br>如：load_param /data/test.normal.para| 将文件里的param加载到内存。<br>系统类型：标准系统 |
+   | load_access_token_id | 如：load_access_token_id&nbsp;| 将access token信息写入data/service/el0/access_token/nativetoken.json文件，load_access_token_id后有且只有一个空格。<br>系统类型：标准系统 |
+   | ifup | ifup 激活网络接口<br>如：ifup eth0 | 激活指定的网络接口。<br>系统类型：标准系统 |
+   | mount_fstab | mount_fstab fstab.test<br>如：mount_fstab /vendor/etc/fstab.test| 按照fstab挂载分区的命令。<br>系统类型：标准系统 |
+   | umount_fstab | umount_fstab  fstab.test<br>如：umount_fstab  /vendor/etc/fstab.test | 按照fstab卸载分区的命令。<br>系统类型：标准系统 |
+   | restorecon | restorecon file or dir<br>如：restorecon /file | 重新加载selinux 的context。<br>系统类型：标准系统 |
+   | stopAllServices | stopAllServices [bool]<br>如：stopAllServices false 或 stopAllServices | 停止所有服务，最长响应时间默认10毫秒。<br>系统类型：标准系统 |
+   | umount |umount path<br>如：umount /vendor | 卸载已经挂载的硬件设备 。<br>系统类型：标准系统 |
+   | sync | 如：sync&nbsp; | 同步写入数据到磁盘。sync后有且仅有一个空格。<br>系统类型：标准系统 |
+   | timer_start | timer_start serviceName<br>如：timer_start console | 启动服务计时器。<br>系统类型：标准系统 |
+   | timer_stop | timer_stop serviceName<br>如：timer_stop console | 停止服务计时器。<br>系统类型：标准系统 |
+   | init_global_key | init_global_key path<br>如：init_global_key /data | data分区文件加密key初始化。<br>系统类型：标准系统 |
+   | init_main_user | 如：init_main_user| 主用户目录加密。<br>系统类型：标准系统 |
+   | mkswap | mkswap file<br>如：mkswap /swapfile1 | 在一个文件或者设备上建立交换分区。<br>系统类型：标准系统 |
+   | swapon | swapon file <br>如：swapon /swapfile1| 激活交换空间。<br>系统类型：标准系统 |
+   | mksandbox | mksandbox fileName<br>如：mksandbox system | 创建沙盒。<br>系统类型：标准系统 |
+   | loadcfg | loadcfg&nbsp;filePath<br/>如：loadcfg&nbsp;/patch/fstab.cfg | 加载其他cfg文件命令。后面跟着的目标文件大小不得超过50KB，且目前仅支持加载/patch/fstab.cfg，其他文件路径和文件名均不支持。/patch/fstab.cfg文件的每一行都是一条命令，命令类型和格式必须符合本表格描述，命令条数不得超过20条。<br>系统类型：小型系统 |
+
+### 接口说明
+jobs管理属于init启动过程中的一环，是一个流程化的功能，是完全服务于init启动过程的，并不对其他组件提供任何功能接口，其运行逻辑契合cfg中命令组的管理，无法对其他类型管理提供帮助。下述主要介绍其在init当中的调用逻辑。
+
+**表2** job解析接口说明
+| 函数名 | 函数解释 | 支持系统类型 |
+|:--------|:-----|:------|
+|void ParseAllJobs(const cJSON *fileRoot)|jobs解析总入口。| 小型系统和标准系统 |
+|static void ParseJob(const cJSON *jobItem, Job *resJob)|校验job是否已存在，解析cmds下命令的功能。| 小型系统 |
+|int GetCmdLinesFromJson(const cJSON *root, CmdLines **cmdLines)| 解析job中cmds命令。当前小型系统使用，标准系统由于涉及trigger<br/>功能和condition条件启动功能，并未使用该接口进行命令解析。| 小型系统和标准系统 |
+|int ParseTriggerConfig(const cJSON *fileRoot, <br>int (*checkJobValid)(const char *jobName))|解析job中Trigger命令。| 标准系统 |
+|static int ParseTrigger_(const TriggerWorkSpace *workSpace,<br>const cJSON *triggerItem, <br/>int (*checkJobValid)(const char *jobName))|获取job名称，condition属性以及cmds命令组的功能，解析到的<br/>job以hash表的形式存储，而命令的保存则使用了队列结构。| 标准系统 |
+
+**表3** job触发接口说明
+| 函数名 | 函数解释 | 支持系统类型 |
+|:--------|:-----|:------|
+|void PostTrigger(EventType type, const char *content, uint32_t contentLen)|校验名称的有效性并发送触发job事件的功能。| 标准系统 |
+|static void SendTriggerEvent(int type, const char *content, uint32_t contentLen)|通过系统参数进行整机控制以及服务的启动与停止等。| 标准系统 |
+|static void DoTriggerCmd(const struct CmdArgs *ctx)|trigger命令执行接口。| 标准系统 |
+|void DoTriggerExec(const char *triggerName)|仅标准系统可用。通过参数中的job名称找到对应命令组，<br>并将命令推入执行队列依次执行。| 标准系统 |
+|void DoJob(const char *jobName)|通过jobName匹配对应job，调用DoCmdByIndex<br>执行其中的命令。| 小型系统 |
+|void DoCmdByIndex(int index, const char *cmdContent)|拼接参数与命令。| 小型系统和标准系统 |
+
+### 开发实例
+下述为cfg文件中jobs配置模板，可验证jobs管理的功能。
+```
+{
+    "jobs" : [{     // 基本job
+            "name" : "stage1",
+            "cmds" : [
+                "start service1",
+                "mkdir dir1"
+            ]
+        }, {        // 条件job
+            "name" : "param:test.name1=0",
+            "condition" : "test.name1=0",
+            "cmds" : [
+                "chmod 0755 dir1",
+                "chown root root dir1"
+            ]
+        }, {        // 自定义job
+            "name" : "param:test.name2=*",
+            "condition" : "test.name2=*",
+            "cmds" : [
+                "chmod 0644 dir1",
+                "chown system system dir1"
+            ]
+        }
+    ]
+}
+```
+以上展示了三种job配置的方式，下面对其中的配置差别分别进行介绍：
+
+1. "name"和"cmds"是一个job中的必选项，并且"cmds"中应当包含系统支持的命令，否则就是浪费资源的无意义配置。
+
+2. "condition"是一个job中的可选属性，这一属性的配置代表着该job是一个条件触发的job，不通过代码或trigger命令在固定阶段触发执行，而是在condition中的条件满足后才被触发执行。
+
+3. job的命名需满足一定的规则，对于条件是系统参数的job，以"param:"为前缀。
+
+4. 一个新的job命名需要在其他可执行的job命令组中通过trigger命令触发才可执行，提供的默认trigger命令执行阶段是post-init阶段。
+
+5. 一个已经存在的job名称仍可以在不同文件中继续使用，相同名称的job将会被视为同一job，通过trigger触发时其中的命令合并执行。
+
+6. 条件执行job的condition配置通常是系统参数，可以指定某个系统参数被设定为某个值时该job触发执行，也可以使用"*"符号，代表只要该系统参数被设置，不论为何值，条件都满足，该job可以被触发执行。
+
+7. 在小型系统中，jobs中的post-init 部分不支持trigger命令。

package/node_modules/@ohos-agent/pc-adapter/skills/openharmony-device-porting/references-full/subsystems/subsys-boot-init-plugin.md

@@ -0,0 +1,215 @@
+# 插件
+
+## 概述
+### 基本概念
+ - begetctl介绍
+
+   具体参考[begetctl命令](#table14737791480)。
+ - bootchart 插件
+
+   bootchart是一个用于linux启动过程性能分析的开源工具软件，在系统中自动收集CPU占用率、磁盘吞吐率、进程等信息，并以图形方式显示分析结果，可用作指导优化系统启动过程。begetctl命令参考：[begetctl命令](#table14737791480)。
+ - bootevent 插件
+
+   bootevent是一个记录init进程及各个服务的启动关键事件的插件，记录内容包括事件名称，关联事件的服务的启动时间，事件发生时间。导出文件支持tracing解析，可用作指导优化系统启动过程。
+
+### 约束与限制
+
+bootchart和bootevent只支持标准系统， begetctl 支持小型系统和标准系统。
+
+## 开发指导
+### 参数说明
+ **表1**  begetctl 命令说明<a name="table14737791480"></a>
+| 命令 | 说明 | 格式和示例|
+| :----------  |  :----------  |:-------------- |
+| init group test [stage] | init moduletest 测试用 | stage参见[ServiceStatus](#section001) |
+| param ls [-r] [name] | 显示系统参数dac和selinux信息<br> -r： 展示所有参数信息 <br> name：展示指定参数信息 | begetctl param ls xxx.xxx 或 <br>param ls xxx.xxx<br>例如：<br>begetctl param ls persist.sys.usb |
+| param get [name] | 获取系参数统值 | begetctl param get xxxx.xxx 或 <br>param get xxxx.xxx<br>例如：<br>param get const.product.name|
+| param set name value| 设置系统参数值 |begetctl param set xxxx.xxx value 或<br> param set xxxx.xxx value <br>例如：<br>begetctl param set ohos.servicectrl.display 1 |
+| param wait name [value] [timeout] | 等待参数被设置成某值<br> timeout默认值：30秒| begetctl param wait xxx.xxx value 或<br> wait xxx.xxx value <br>例如：<br>param wait xx.sss 1 |
+| param dump [verbose] | dump 系统参数信息|begetctl param dump <br>或 param dump |
+| param shell [name] | 进入Parameter shell|begetctl param shell <br>或 param shell |
+| param save | 持久化workspace中的所有带持久化标记的参数|begetctl param save <br>或 param save |
+| dump api | dump 显示init 系统参数接口信息|begetctl dump api |
+| getloglevel | 获取当前init的log等级<br>读取persist.init.debug.loglevel<br>0:debug<br> 1:info<br> 2:warning<br> 3:err<br> 4:fatal|begetctl getloglevel |
+| setloglevel level | 设置log等级为info <br>log等级设置范围0~4<br> 0:debug<br>1:info<br> 2:warning<br> 3:err<br>4:fatal|begetctl setloglevel 1 |
+| timer_stop servicename | 停止服务计时器<br>servicename长度不超过96字符|begetctl timer_stop servicename | begetctl timer_stop appspawn |
+| timer_start servicename timeout | 启动服务计时器<br>servicename长度不超过96<br>timeout默认值：10毫秒 |begetctl timer_start servicename | begetctl timer_start appspawn|
+| start_service servicename | 启动服务| begetctl start_service servicename 或<br>start_service servicename|begetctl start_service appspawn |
+| stop_service servicename | 停止服务|begetctl stop_service servicename 或<br> stop_service servicename|begetctl stop_service appspawn |
+| service_control start servicename | 启动服务|begetctl service_control start servicename 或<br> service_control start servicename|begetctl service_control start appspawn |
+| service_control stop servicename | 停止服务|begetctl service_control stop servicename 或<br> service_control stop servicename|begetctl service_control stop appspawn |
+| sandbox -b pid | 进入native应用沙盒 | begetctl sandbox -b pid|
+| sandbox -p process_name | 进程进沙盒| begetctl sandbox -p /bin/sh |
+| sandbox -n sandbox_name | 进入配置的system或者chipset沙盒| begetctl sandbox -n system|
+| sandbox -s service_name | 服务进沙盒| begetctl sandbox -s service_name |
+| sandbox -h | 展示sandbox 命令帮助信息| begetctl sandbox -h |
+| modulectl uninstall moduleName | 卸载动态插件| begetctl modulectl uninstall moduleName <br>例如:<br>卸载bootchart：<br> begetctl modulectl uninstall bootchart |
+| modulectl install moduleName | 安装动态插件|begetctl modulectl install moduleName <br>例如:<br>安装bootchart：<br>begetctl modulectl install bootchart |
+| modulectl list | 查询动态插件列表|begetctl modulectl list |
+| misc_daemon --write_logo xxx.rgb | 写入开机logo<br>rgb文件最大不超过1024*2038，仅支持hi3516dv300|begetctl misc_daemon --write_logo logo.rgb 或<br> misc_daemon --write_logo logo.rgb|
+| reboot | 重启系统|begetctl reboot 或<br> reboot|
+| reboot shutdown[:options] | 关闭系统|begetctl reboot shutdown 或<br> reboot shutdown |
+| reboot suspend | 暂停系统|begetctl reboot suspend 或<br> reboot suspend |
+| reboot updater | 重新启动并进入updater|begetctl reboot updater 或<br> reboot updater |
+| reboot updater[:options] | 重新启动并进入updater|begetctl reboot updater 或<br> reboot updater |
+| reboot flashd | 重新启动并进入flashd|begetctl reboot flashd 或<br> reboot flashd |
+| reboot flashd[:options] | 重新启动并进入flashd|begetctl reboot flashd 或<br> reboot flashd |
+| reboot charge | 重新启动并进入charge|begetctl reboot charge 或<br> reboot charge |
+| reboot loader | 重新启动并进入烧写模式|begetctl reboot loader 或<br> reboot loader |
+| bootevent disable | 关闭bootevent插件功能|begetctl bootevent disable |
+| bootevent enable | 开启bootevent插件功能|begetctl bootevent enable |
+| dump_service parameter_service trigger | 命令行展示所有trigger信息|begetctl dump_service parameter_service trigger |
+| dump_service all | 命令行展示所有服务的信息|begetctl dump_service all |
+| dump_service serviceName | 命令行展示单个服务信息|begetctl dump_service param_watcher |
+| dump_service loop | dump loop 中fd信息 |begetctl dump_service loop|
+| bootchart stop | 停止图形分析，仅支持rk3568|begetctl bootchart stop |
+| bootchart start | 开始图形分析|begetctl bootchart start |
+| bootchart disable | 图形分析不使能|begetctl bootchart disable |
+| bootchart enable | 图形分析使能|begetctl bootchart enable |
+| dac uid username | 查询username 对应的uid|begetctl dac uid username <br>例如:<br>begetctl dac uid root|
+| dac gid groupname | groupname 对应的gid以及组成员|begetctl dac gid groupname <br>例如:<br> begetctl dac gid shell |
+| get log level | 获取当前init的log等级<br>读取persist.init.debug.loglevel<br>0:debug<br> 1:info<br> 2:warning<br> 3:err<br> 4:fatal|begetctl get log level |
+| set log level | 设置log等级为info <br>log等级设置范围0~4<br> 0:debug<br>1:info<br> 2:warning<br> 3:err<br>4:fatal|begetctl set log level 1 |
+| appspawn_time | 查询应用孵化的最大最小时间 | begetctl appspawn_time <br>例如：<br>begetctl appspawn_time|
+| dump_nwebspawn | dump nwebspawn 应用信息|begetctl dump_nwebspawn <br>例如：<br>打开备忘录<br>begetctl dump_nwebspawn |
+| dump_appspawn | dump appspawn 应用信息|begetctl dump_appspawn<br>例如：<br>begetctl dump_appspawn|
+
+- <a name = "section001"> **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为例：
+1. 安装so文件， 定义单独文件，实现下面函数。 
+      ```c
+      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);
+      }
+      ```     
+2. 编译成静态库libbootchart_static，并加入static_modules组。
+      ```
+      group("static_modules") {
+        if (!defined(ohos_lite)) {
+          deps = [ ":libbootchart_static" ]
+        }
+      }
+      ```
+      
+3. 初始化bootchart插件， 可以安装插件命令。
+      ```c
+      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();
+      }
+      ```
+4. 退出bootchart插件。
+      ```c
+      MODULE_DESTRUCTOR(void)
+      {
+          PLUGIN_LOGI("DoBootchartStop now ...");
+          DoBootchartStop();
+          BootchartExit();
+      }
+      ```
+5. 执行bootchart命令。
+    ```c
+    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文件夹：<br>
+        header<br>
+        proc_diskstats.log<br>
+        proc_ps.log<br>
+        proc_stat.log<br>
+  7. 使用tar -zcvf bootchart.tgz * 命令进行打包（只支持linux版本）并将该打包文件拷贝到linux：bootchart-master目录下。
+  8. 在bootchart-master目录下运行命令：
+      ```
+      python3 pybootchartgui.py -f pdf bootchart.tgz
+      ```
+
+  预期结果：
+        <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;在bootchart-master目录下生成bootchart.pdf。
+#### bootevent 使用示例
+1. 在服务的cfg文件中配置bootevent事件,支持配置一个或多个bootevent事件。
+
+    配置单个bootevent事件:
+    ```json
+    bootevents : "bootevent.xxxbootevent",
+    ```
+    配置多个bootevent事件:
+    ```json
+    bootevents : ["bootevent.xxxbootevent1", "bootevent.xxxbootevent2.xxx"],
+    ```
+> **注意：** 配置的bootevent事件必须以“bootevent.”开始。
+2. 服务代码中发送bootevent事件。
+
+    服务自身代码中调用init提供的SetParameter接口发送bootevent事件,例如发送上一步骤中设置的XXXbootevent1事件：
+    ```c
+    SetParameter("bootevent.XXXbootevent1", "true");
+    ```
+3. 命令行启用bootevent功能。
+
+    - 执行begetctl bootevent enable命令后再次启动系统，bootevent功能开启。
+    - 执行begetctl bootevent disable命令后再次启动系统，bootevent功能关闭。
+4. 导出文件支持trace分析。
+
+    - 导出的bootevent文件目录：/data/service/el0/startup/init/。
+    - 导出文件命名规则：“时间戳.bootevent”。
+    - 导出的bootevent信息文件可以通过trace分析工具进行可视化展示。