移植案例与原理 - utils子系统之file文件操作部件

【本文正在参与优质创作者激励】

Utils子系统是OpenHarmony的公共基础库，存放OpenHarmony通用的基础组件。这些基础组件可被OpenHarmony各业务子系统及上层应用所使用。公共基础库在不同平台上提供的能力：

• LiteOS-M内核：KV(key value)存储、文件操作、定时器、Dump系统属性。
• LiteOS-A内核：KV(key value)存储、定时器、JS API(设备查询，数据存储)、Dump系统属性。

本文介绍下移植开发板时如何适配utils子系统之file文件操作部件，并介绍下相关的运行机制原理。系统属性部件syspara_lite包含系统参数特性syspara_lite和token。file文件操作部件定义在utils\native\lite\。源代码目录如下：

utils/native/lite/              # 公共基础库根目录
├── file                        # 文件接口实现
├── hals                        # HAL目录
│   └── file                    # 文件操作硬件抽象层头文件
├── include                     # 公共基础库对外接口文件
├── js                          # JS API目录                 
│   └── builtin
│       ├── common
│       ├── deviceinfokit       # 设备信息Kit
│       ├── filekit             # 文件Kit
│       └── kvstorekit          # KV存储Kit
├── kal                         # KAL目录
│   └── timer                   # Timer的KAL实现
├── kv_store	                # KV存储实现
│   ├── innerkits               # KV存储内部接口
│   └── src	                    # KV存储源文件
├── memory
│   └── include                 # 内存池管理接口
├── os_dump                     # Dump系统属性
└── timer_task                  # Timer实现

1、file文件操作部件适配示例

1.1 配置产品解决方案config.json

utils子系统之file文件操作部件的适配示例可以参考vendor\ohemu\qemu_csky_mini_system_demo\config.json，代码片段如下。⑴处用于配置子系统的file部件。⑵处指定在开发板目录中适配目录，这个适配目录下需要创建目录device\qemu\SmartL_E802\adapter\hals\utils\file\。为什么配置这个目录，后文会解析。

      {
        "subsystem": "utils",
        "components": [
⑴        { "component": "file", "features":[] },
          { "component": "kv_store", "features":[] }
        ]
      }
    ],
⑵   "vendor_adapter_dir": "//device/qemu/SmartL_E802/adapter",

1.2 适配hal_file.h文件中的接口

在文件utils\native\lite\hals\file\hal_file.h头文件中，定义了文件操作接口，适配开发板时，如果需要使用utils子系统之file文件操作部件，就要适配这些接口。需要适配的接口如下。HalFileOpen()函数返回值是文件描述符fd，可以被其他带int fd参数的函数使用。

int HalFileOpen(const char* path, int oflag, int mode);

int HalFileClose(int fd);

int HalFileRead(int fd, char* buf, unsigned int len);

int HalFileWrite(int fd, const char* buf, unsigned int len);

int HalFileDelete(const char* path);

int HalFileStat(const char* path, unsigned int* fileSize);

int HalFileSeek(int fd, int offset, unsigned int whence);

文件device\qemu\SmartL_E802\adapter\hals\utils\file\src\hal_file.c可以作为参考示例，演示如何适配上述接口。⑴处的HalFileOpen()函数中，先组装文件路径，"/littlefs"是SmartL_E802开发板设置的LFS文件默认挂载点，关于LFS的适配请参考device\qemu\SmartL_E802\liteos_m\board\fs\fs_init.c。HalFileXXX函数调用的open、close、read、write、unlink、stat、lseek等函数定义在kernel\liteos_m\kal\libc\musl\fs.c或kernel\liteos_m\kal\libc\newlib\porting\src\fs.c，这个取决于使用的是musl C库还是newlib C库。文件系统接口调用链如下所示：UtilsFileXXX(utils\native\lite\file\src\file_impl_hal\file.c)-> HalFileXXXX(device\qemu\SmartL_E802\adapter\hals\utils\file\src\hal_file.c) -> open/read/write/…(kernel\liteos_m\kal\libc\musl\fs.c或kernel\liteos_m\kal\libc\newlib\porting\src\fs.c) -> LOS_XXXX(kernel\liteos_m\components\fs\vfs\los_fs.c) -> Lfs_XXXX(kernel\liteos_m\components\fs\littlefs\lfs_api.c) -> lfs_file_XXX (third_party\littlefs\lfs.c) -> Littlefs*(device\qemu\SmartL_E802\liteos_m\board\fs\littlefs_hal.c)。

  int HalFileOpen(const char* path, int oflag, int mode)
  {
      char tmpPath[LITTLEFS_MAX_LFN_LEN] = {0};
⑴    (void)snprintf_s(tmpPath, LITTLEFS_MAX_LFN_LEN, LITTLEFS_MAX_LFN_LEN, "/littlefs/%s", path);
      return open(tmpPath, oflag, mode);
  }

  int HalFileClose(int fd)
  {
      return close(fd);
  }

  int HalFileRead(int fd, char *buf, unsigned int len)
  {
      return read(fd, buf, len);
  }

  int HalFileWrite(int fd, const char *buf, unsigned int len)
  {
      return write(fd, buf, len);
  }

  int HalFileDelete(const char *path)
  {
      char tmpPath[LITTLEFS_MAX_LFN_LEN] = {0};
      (void)snprintf_s(tmpPath, LITTLEFS_MAX_LFN_LEN, LITTLEFS_MAX_LFN_LEN, "/littlefs/%s", path);
      return unlink(path);
  }

  int HalFileStat(const char *path, unsigned int *fileSize)
  {
      char tmpPath[LITTLEFS_MAX_LFN_LEN] = {0};
      struct stat halStat ;
      int ret = 0;
      (void)snprintf_s(tmpPath, LITTLEFS_MAX_LFN_LEN, LITTLEFS_MAX_LFN_LEN, "/littlefs/%s", path);
      ret = stat(tmpPath, &halStat);
      *fileSize = halStat.st_size;
      return ret;
  }

  int HalFileSeek(int fd, int offset, unsigned int whence)
  {
      return lseek(fd, (off_t)offset, whence);
  }

2、file文件操作部件代码分析

2.1 部件的头文件

上文已经知道，file文件操作部件代码的头文件为utils\native\lite\include\utils_file.h，用户程序可以使用该头文件中定义的接口。

int UtilsFileOpen(const char* path, int oflag, int mode);

int UtilsFileClose(int fd);

int UtilsFileRead(int fd, char* buf, unsigned int len);

int UtilsFileWrite(int fd, const char* buf, unsigned int len);

int UtilsFileDelete(const char* path);

int UtilsFileStat(const char* path, unsigned int* fileSize);

int UtilsFileSeek(int fd, int offset, unsigned int whence);

int UtilsFileCopy(const char* src, const char* dest);

int UtilsFileMove(const char* src, const char* dest);

头文件utils\native\lite\hals\file\hal_file.h中定义的接口，需要移植适配时提供实现，具体接口见上文。

2.2 部件的源代码文件

文件utils\native\lite\file\src\file_impl_hal\file.c中实现了UtilsFileXXX接口，代码比较简单，调用需要开发板移植适配的HalFileXXX接口。

int UtilsFileOpen(const char* path, int oflag, int mode)
{
    return HalFileOpen(path, oflag, mode);
}

int UtilsFileClose(int fd)
{
    return HalFileClose(fd);
}

int UtilsFileRead(int fd, char* buf, unsigned int len)
{
    return HalFileRead(fd, buf, len);
}

int UtilsFileWrite(int fd, const char* buf, unsigned int len)
{
    return HalFileWrite(fd, buf, len);
}

int UtilsFileDelete(const char* path)
{
    return HalFileDelete(path);
}

int UtilsFileStat(const char* path, unsigned int* fileSize)
{
    return HalFileStat(path, fileSize);
}

int UtilsFileSeek(int fd, int offset, unsigned int whence)
{
    return HalFileSeek(fd, offset, whence);
}

int UtilsFileCopy(const char* src, const char* dest)
{
    if ((src == NULL) || (dest == NULL)) {
        return EC_FAILURE;
    }
    int fpSrc = UtilsFileOpen(src, O_RDONLY_FS, 0);
    if (fpSrc < 0) {
        return fpSrc;
    }
    int fpDest = UtilsFileOpen(dest, O_RDWR_FS | O_CREAT_FS | O_TRUNC_FS, 0);
    if (fpDest < 0) {
        UtilsFileClose(fpSrc);
        return fpDest;
    }
    bool copyFailed = true;
    char* dataBuf = (char *)malloc(BUFFER_SIZE);
    if (dataBuf == NULL) {
        goto MALLOC_ERROR;
    }
    int nLen = UtilsFileRead(fpSrc, dataBuf, BUFFER_SIZE);
    while (nLen > 0) {
        if (UtilsFileWrite(fpDest, dataBuf, nLen) != nLen) {
            goto EXIT;
        }
        nLen = UtilsFileRead(fpSrc, dataBuf, BUFFER_SIZE);
    }
    copyFailed = (nLen < 0);

EXIT:
    free(dataBuf);
MALLOC_ERROR:
    UtilsFileClose(fpSrc);
    UtilsFileClose(fpDest);
    if (copyFailed) {
        UtilsFileDelete(dest);
        return EC_FAILURE;
    }
    return EC_SUCCESS;
}

int UtilsFileMove(const char* src, const char* dest)
{
    int ret = UtilsFileCopy(src, dest);
    if (ret == EC_SUCCESS) {
        ret = UtilsFileDelete(src);
    }
    return ret;
}

2.3 部件的编译构建

编译构建配置文件utils\native\lite\file\BUILD.gn代码如下,⑴处的配置项ohos_board_adapter_dir为产品解决方案配置文件config.json中定义的开发板适配目录。可以看出来：

• 开发板适配目录必须包含目录hals/utils/file
• 目录hals/utils/file同级的BUILD.gn文件中，构建目标必须为hal_file_static。不能随意命名。

  import("//build/lite/config/component/lite_component.gni")

  static_library("native_file") {
    sources = [ "src/file_impl_hal/file.c" ]
    include_dirs = [
      "//utils/native/lite/include",
      "//utils/native/lite/hals/file",
    ]
⑴  deps = [ "$ohos_board_adapter_dir/hals/utils/file:hal_file_static" ]
  }

  lite_component("file") {
    features = [ ":native_file" ]
  }

参考站点

参考了下述站点，或者推荐读者阅读下述站点了解更多信息。

• OpenHarmony / utils_native_lite
• 轻量带屏解决方案之恒玄芯片移植案例
• Device Qemu的一个合入PR
• 鸿蒙轻内核M核源码分析系列十九 Musl LibC
• 鸿蒙轻内核M核源码分析系列二十 Newlib C
• 鸿蒙轻内核M核源码分析系列二一 02 文件系统LittleFS
• 鸿蒙轻内核M核源码分析系列二一 03 文件系统LittleFS

小结

本文介绍了utils子系统之file文件操作部件的移植适配案例，分析了部件源代码。因为时间关系，仓促写作，或能力限制，若有失误之处，请各位读者多多指正。感谢阅读，有什么问题，请留言。
【本文正在参与优质创作者激励】