稀疏映象在OpenHarmony上的應用

一、稀疏映象升級背景

常用系統映象格式為原始映象，即RAW格式。映象體積比較大，在燒錄韌體或者升級韌體時比較耗時，而且在移動裝置升級過程時比較耗費流量。為此，將原始映象用稀疏描述，可以大大地縮減映象體積，省時省流量。

二、稀疏映象原理

1、稀疏映象的概念
原始映象：即raw image，完整的ext4分割槽映象，包含很多全零的無效填充區
稀疏映象：即sparse image，將raw ext4進行稀疏描述，因此尺寸比較小，製作目錄有多少檔案就計算多少，沒有全零填充

2、稀疏映象格式

稀疏映象資料格式：首先是sparse_header佔用28byte，然後是12byte的chunk_header，同樣這chunk_header的型別決定了後面跟著的資料，如果讀到資料是0xCAC1意味著後面是本身的raw_data，如果是0xCAC3，則後面num為0，接著再0xCAC2意味著後面填充4byte的內容。

三、實現稀疏映象升級方案

版本基線：
OpenAtom OpenHarmony（以下簡稱“OpenHarmony”） 3.1 Release
程式碼路徑：https://gitee.com/openharmony...

1、稀疏映象燒錄
（1）生成稀疏格式映象
有2種方法可以生成稀疏映象：
1）修改檔案build/ohos_var.gni中，sparse_image=true

2）編譯命令增加--sparse-image欄位，如./build.sh --product-name=xxx --sparse-image

（2）增加稀疏格式轉換工具
在目錄build/ohos/images/mkimage中增加檔案img2simg，該工具用於編譯完成後將raw映象轉換為sparse格式，並設定許可權為777。

（3）編譯後的映象對比

編譯出的映象格式為sparse格式，映象大小相比raw格式明顯變小。

（4）燒錄稀疏映象

燒錄稀疏映象方法和燒錄原始映象方法一致。

稀疏映象本身是不能直接掛載的，在燒錄過程中透過uboot將稀疏格式映象還原為原始映象，然後寫到磁碟中，系統啟動後可掛載對應的映象。

2、稀疏映象升級
升級包採用稀疏映象製作。
（1）修改升級包製作工具
官方升級包工具不支援生成稀疏映象的升級包，修改升級包工具，生成稀疏格式的升級包。.\base\update\packaging_tools\image_class.py

按照上圖所示註釋程式碼

（2）生成稀疏映象升級包
和全量映象升級包製作方法一致。
參考：https://gitee.com/openharmony...

（3）適配updater元件中稀疏映象功能

● 增加寫稀疏映象分支
.\base\update\updater\services\applypatch\data_writer.cpp

寫資料函式CreateDataWriter增加寫稀疏映象分支

case WRITE_SPARSE:
{
    std::unique_ptr<SparseWriter> writer(std::make_unique<SparseWriter>(partitionName));
    return std::move(writer);
}

● 增加稀疏映象類宣告
.\base\update\updater\services\applypatch\raw_writer.h
增加稀疏映象類宣告及相關變數定義

typedef struct sparse_header {
  uint32_t  magic;      /* 0xed26ff3a */
  uint16_t  major_version;  /* (0x1) - reject images with higher major versions */
  uint16_t  minor_version;  /* (0x0) - allow images with higer minor versions */
  uint16_t  file_hdr_sz;    /* 28 bytes for first revision of the file format */
  uint16_t  chunk_hdr_sz;   /* 12 bytes for first revision of the file format */
  uint32_t  blk_sz;     /* block size in bytes, must be a multiple of 4 (4096) */
  uint32_t  total_blks; /* total blocks in the non-sparse output image */
  uint32_t  total_chunks;   /* total chunks in the sparse input image */
  uint32_t  image_checksum; /* CRC32 checksum of the original data, counting "don't care" */
                /* as 0. Standard 802.3 polynomial, use a Public Domain */
                /* table implementation */
} sparse_header_t;
 
#define SPARSE_HEADER_MAGIC 0xed26ff3a
 
#define CHUNK_TYPE_RAW      0xCAC1
#define CHUNK_TYPE_FILL     0xCAC2
#define CHUNK_TYPE_DONT_CARE    0xCAC3
#define CHUNK_TYPE_CRC32    0xCAC4
 
typedef struct chunk_header {
  uint16_t  chunk_type; /* 0xCAC1 -> raw; 0xCAC2 -> fill; 0xCAC3 -> don't care */
  uint16_t  reserved1;
  uint32_t  chunk_sz;   /* in blocks in output image */
  uint32_t  total_sz;   /* in bytes of chunk input file including chunk header and data */
} chunk_header_t;
 
class SparseWriter : public DataWriter {
public:
    virtual bool Write(const uint8_t *addr, size_t len, WriteMode mode, const std::string &partitionName);
 
    explicit SparseWriter(const std::string partitionName) : offset_(0), fd_(-1), partitionName_(partitionName) {}
 
    virtual ~SparseWriter()
    {
        offset_ = 0;
        if (fd_ > 0) {
            fsync(fd_);
            close(fd_);
        }
        fd_ = -1;
    }
private:
    int WriteInternal(int fd, const uint8_t *data, size_t len, const std::string &partitionName);
 
    SparseWriter(const SparseWriter&) = delete;
 
    const SparseWriter& operator=(const SparseWriter&) = delete;
    off64_t offset_;
    int fd_;
    std::string partitionName_;
};

● 增加稀疏映象類實現
.\base\update\updater\services\applypatch\raw_writer.cpp
增加稀疏映象類實現及相關變數定義，原有程式碼不變

typedef struct sparse_header {
  uint32_t  magic;      /* 0xed26ff3a */
  uint16_t  major_version;  /* (0x1) - reject images with higher major versions */
  uint16_t  minor_version;  /* (0x0) - allow images with higer minor versions */
  uint16_t  file_hdr_sz;    /* 28 bytes for first revision of the file format */
  uint16_t  chunk_hdr_sz;   /* 12 bytes for first revision of the file format */
  uint32_t  blk_sz;     /* block size in bytes, must be a multiple of 4 (4096) */
  uint32_t  total_blks; /* total blocks in the non-sparse output image */
  uint32_t  total_chunks;   /* total chunks in the sparse input image */
  uint32_t  image_checksum; /* CRC32 checksum of the original data, counting "don't care" */
                /* as 0. Standard 802.3 polynomial, use a Public Domain */
                /* table implementation */
} sparse_header_t;
 
#define SPARSE_HEADER_MAGIC 0xed26ff3a
 
#define CHUNK_TYPE_RAW      0xCAC1
#define CHUNK_TYPE_FILL     0xCAC2
#define CHUNK_TYPE_DONT_CARE    0xCAC3
#define CHUNK_TYPE_CRC32    0xCAC4
 
typedef struct chunk_header {
  uint16_t  chunk_type; /* 0xCAC1 -> raw; 0xCAC2 -> fill; 0xCAC3 -> don't care */
  uint16_t  reserved1;
  uint32_t  chunk_sz;   /* in blocks in output image */
  uint32_t  total_sz;   /* in bytes of chunk input file including chunk header and data */
} chunk_header_t;
 
class SparseWriter : public DataWriter {
public:
    virtual bool Write(const uint8_t *addr, size_t len, WriteMode mode, const std::string &partitionName);
 
    explicit SparseWriter(const std::string partitionName) : offset_(0), fd_(-1), partitionName_(partitionName) {}
 
    virtual ~SparseWriter()
    {
        offset_ = 0;
        if (fd_ > 0) {
            fsync(fd_);
            close(fd_);
        }
        fd_ = -1;
    }
private:
    int WriteInternal(int fd, const uint8_t *data, size_t len, const std::string &partitionName);
 
    SparseWriter(const SparseWriter&) = delete;
 
    const SparseWriter& operator=(const SparseWriter&) = delete;
    off64_t offset_;
    int fd_;
    std::string partitionName_;
};

3、驗證稀疏映象升級
（1）複製升級包
將製作的稀疏映象升級包透過HDC工具推進系統data目錄，並修改檔名為updater.zip，路徑如下：/data/updater/updater.zip

（2）啟動升級
系統啟動後，在命令列工具輸入如下命令啟動升級
reboot updater:--update_package=/data/updater/updater.zip
輸入命令後，系統重啟，進入升級頁面，等待升級完成。

本文介紹了OpenHarmony系統中實現稀疏映象升級的方法，理解稀疏映象原理及稀疏映象還原方法可以快速在自己的系統中應用稀疏映象升級，提高系統升級速度。