# Updater<a name="EN-US_TOPIC_0000001148614629"></a>

-   [Introduction](#section184mcpsimp)
-   [Directory Structure](#section198mcpsimp)
-   [Usage](#section218mcpsimp)
    -   [Usage Guidelines](#section220mcpsimp)

-   [Repositories Involved](#section247mcpsimp)

## Introduction<a name="section184mcpsimp"></a>

The updater runs in the updater partition. It reads the misc partition information to obtain the update package status and verifies the update package to ensure that the update package is valid. Then, the updater parses the executable program from the update package, creates a subprocess, and starts the update program. After that, update operations will be automatically implemented by the update script.

## Directory Structure<a name="section198mcpsimp"></a>

```
base/update/updater/
├── resources           # UI image resources of the update subsystem
├── services            # Service code of the updater
│   ├── applypatch      # Update package data update code
│   ├── fs_manager      # File system and partition management code
│   ├── include         # Header files for the update subsystem
│   ├── log             # Log module of the update subsystem
│   ├── package         # Update packages
│   ├── script          # Update scripts
│   ├── diffpatch       # Differential package restore code
│   ├── sparse_image    # Sparse image parsing code
│   ├── ui              # UI code
│   └── updater_binary  # Executable programs
├── interfaces
│   └── kits            # External APIs
└── utils               # Common utilities of the update subsystem
    └── include         # Header files for general functions of the update subsystem
```

## Usage<a name="section218mcpsimp"></a>

### Usage Guidelines<a name="section220mcpsimp"></a>

The updater runs in the updater partition. To ensure proper functioning of the updater, perform the following operations:

1. Create a updater partition.

The updater partition is independent of other partitions. It is recommended that the size of the updater partition be greater than or equal to 20 MB. The updater partition image is an ext4 file system. Ensure that the  **config**  option of the ext4 file system in the system kernel is enabled.

2. Create the misc partition.

The misc partition stores metadata required by the update subsystem during the update process. Such data includes update commands and records of resumable data transfer upon power-off. This partition is a raw partition and its size is about 1 MB. You do not need to create a file system for the misc partition, because the update subsystem can directly access this partition.

3. Prepare the partition configuration table.

During the update process, the updater needs to operate the partitions through the partition configuration table. The default file name of the partition configuration table is  **fstab.updater**. You need to pack the  **fstab.updater**  file into the updater during compilation.

4. Start the updater.

The init process in the updater partition has an independent configuration file named  **init.cfg**. The startup configuration of the updater is stored in this file.

5. Compile the updater.

a. Add the updater configurations to the  **build/subsystem\_config.json**  file.

Example configuration:

```
"updater": {
"project": "hmf/updater",
"path": "base/update/updater",
"name": "updater",
"dir": "base/update"
},
```

b. Add the updater for the desired product.

For example, to add the updater for Hi3516D V300, add the following code to the  **productdefine/common/products/Hi3516DV300.json**  file.

```
     "updater:updater":{},
```

6. Compile the updater partition image.

Add the compilation configuration to the  **build\_updater\_image.sh**  script, which is stored in the  **build**  repository and called by the OpenHarmony compilation system.

## Repositories Involved<a name="section247mcpsimp"></a>

Update subsystem

[**update\_updater**](https://gitee.com/openharmony/update_updater)

[build](https://gitee.com/openharmony/build)

[productdefine\_common](https://gitee.com/openharmony/productdefine_common)

# 升级包安装组件<a name="ZH-CN_TOPIC_0000001148614629"></a>

-   [简介](#section184mcpsimp)
-   [目录](#section198mcpsimp)
-   [说明](#section218mcpsimp)
    -   [使用说明](#section220mcpsimp)

-   [相关仓](#section247mcpsimp)

## 简介<a name="section184mcpsimp"></a>

升级包安装组件运行在updater分区，其功能主要包括读取misc分区信息获取升级包状态，对升级包进行校验，确保升级包合法有效；然后从升级包中解析出升级的可执行程序，创建子进程并启动升级程序。具体升级的动作由升级脚本控制。

更多升级子系统相关概念，请参考：[升级子系统](https://gitee.com/openharmony/docs/blob/master/zh-cn/readme/%E5%8D%87%E7%BA%A7%E5%AD%90%E7%B3%BB%E7%BB%9F.md)

**图 1**  升级子系统架构图

![](figures/Openharmony-updater-升级子系统架构图.png)

## 目录<a name="section198mcpsimp"></a>

```
base/update/updater/
├── resources           # 升级子系统用户界面图片资源目录
├── services            # 组件服务层代码目录
│   ├── applypatch      # 升级包数据更新代码目录
│   ├── diffpatch       # 差分还原代码目录
│   ├── etc             # 启动相关配置文件目录
│   ├── flashd          # flashd模式镜像写入和升级功代码目录
│   ├── fs_manager      # 文件系统和分区管理代码目录
│   ├── hdi             # 硬件相关接口定义
│   ├── include         # 升级子系统头文件目录
│   ├── log             # 升级子系统日志模块目录
│   ├── package         # 升级包管理模块目录
│   ├── ptable_parse    # 分区表解析代码目录
│   ├── script          # 升级脚本管理目录
│   ├── ui              # 升级ui界面代码目录
│   └── updater_binary  # 升级可执行程序目录
├── interfaces
│   └── kits            # 对外模块接口定义
└── utils               # 升级子系统通用代码目录
    └── include         # 升级子系统通用函数头文件目录
```

## 说明<a name="section218mcpsimp"></a>

### 使用说明<a name="section220mcpsimp"></a>

升级包安装组件运行在updater分区里，需要如下的操作

1、创建updater分区

updater是一个独立的分区，分区大小建议不小于20MB。updater分区镜像是ext4 格式文件系统。确保系统内核ext4 文件系统的config 是打开状态。

2、创建misc分区

misc 分区中存储了升级子系统在升级过程中需要的元数据\(metadata\)，如升级命令，掉电续传记录等。 misc 分区的大小约1MB，是一个裸分区，无需制作文件系统， 升级子系统直接访问。

3、分区配置表

升级包安装组件在运行过程中，需要通过分区配置表操作分区。默认的分区配置表文件名是fstab.updater，在编译的时候，打包到升级包安装组件中。

4、升级包安装组件启动

updater分区的init 进程有单独的配置文件 init.cfg，升级包安装进程启动配置在该文件中。

5、升级包安装组件编译

a、在build/subsystem\_config.json文件添加配置。

如下：

```
"updater": {
"project": "hmf/updater",
"path": "base/update/updater",
"name": "updater",
"dir": "base/update"
},
```

b、 产品中添加需要编译的组件

以Hi3516DV300为例，在productdefine/common/products/Hi3516DV300.json 中添加updater：

```
     "updater:updater":{},
```

6、updater分区镜像编译

编译配置在build仓下，build\_updater\_image.sh 脚本中，该脚本由OHOS 编译系统调用。

## 相关仓<a name="section247mcpsimp"></a>

[升级子系统](https://gitee.com/openharmony/docs/blob/master/zh-cn/readme/%E5%8D%87%E7%BA%A7%E5%AD%90%E7%B3%BB%E7%BB%9F.md)

[**update\_updater**](https://gitee.com/openharmony/update_updater)

[build](https://gitee.com/openharmony/build)

[productdefine\_common](https://gitee.com/openharmony/productdefine_common)