FileOps#

FileOps 提供内核态文件操作抽象接口,支持文件的打开、关闭、读写、同步与定位操作,屏蔽 Linux、LiteOS、FreeRTOS 等多操作系统底层差异。

模块公共头文件

#include "fileops/osal_fileops.h"

接口清单#

接口名称

功能简述

osal_klib_fopen

打开文件并返回文件指针

osal_klib_fclose

关闭已打开的文件

osal_klib_fwrite

向文件写入数据

osal_klib_fread

从文件读取数据

osal_klib_fsync

将文件数据同步到磁盘

osal_klib_fseek

设置文件读写位置

Functions#

osal_klib_fopen #

void *osal_klib_fopen(const char *file, int flags, int mode)

声明头文件

#include "fileops/osal_fileops.h"

功能说明

  • 打开指定路径的文件,根据标志位和模式参数控制文件的打开方式。

  • 返回文件指针用于后续文件操作接口的入参。

前置条件

  • 文件系统已初始化且可访问。

入参

名称

参数类型

说明

约束取值范围

file

const char *

文件路径字符串

非 NULL

flags

int

文件操作标志,控制打开方式;访问模式(RDONLY / WRONLY / RDWR)互斥且必选其一,其余标志可组合

OSAL_O_RDONLY:00000000;
OSAL_O_WRONLY:00000001;
OSAL_O_RDWR:00000002;
OSAL_O_CREAT:00000100;
OSAL_O_EXCL:00000200;
OSAL_O_TRUNC:00001000;
OSAL_O_APPEND:00002000;
OSAL_O_CLOEXEC:02000000。

mode

int

文件创建权限位,当 flags 含 OSAL_O_CREAT 时生效

权限位组合(如 0666;
0644;
0600)。

返回值

返回类型:void *

返回值

文字含义

触发场景

非 NULL 指针

文件打开成功

文件路径合法且文件系统可用

NULL

文件打开失败

file 为 NULL、文件不存在且未指定 OSAL_O_CREAT、存储空间不足

osal_klib_fclose #

void osal_klib_fclose(void *filp)

声明头文件

#include "fileops/osal_fileops.h"

功能说明

  • 关闭由 osal_klib_fopen 打开的文件。

  • 释放文件指针占用的内核内存资源。

  • 关闭后 filp 指针不可再用于其他文件操作接口。

前置条件

  • filp 为 osal_klib_fopen 返回的有效文件指针。

入参

名称

参数类型

说明

约束取值范围

filp

void *

文件指针

osal_klib_fopen 返回的有效指针,非 NULL

osal_klib_fwrite #

int osal_klib_fwrite(const char *buf, unsigned long size, void *filp)

声明头文件

#include "fileops/osal_fileops.h"

功能说明

  • 将缓冲区数据写入文件。

  • 从当前文件读写位置开始写入,写入完成后读写位置自动后移。

  • 返回实际写入的字节数。

前置条件

  • filp 为 osal_klib_fopen 返回的有效文件指针。

  • 文件以写模式(OSAL_O_WRONLY 或 OSAL_O_RDWR)打开。

入参

名称

参数类型

说明

约束取值范围

buf

const char *

待写入数据缓冲区

非 NULL

size

unsigned long

待写入数据字节数

> 0

filp

void *

文件指针

osal_klib_fopen 返回的有效指针,非 NULL

返回值

返回类型:int

返回值

文字含义

触发场景

> 0

实际写入的字节数

写入成功

-1

写入失败

filp 或 buf 为 NULL

osal_klib_fread #

int osal_klib_fread(char *buf, unsigned long size, void *filp)

声明头文件

#include "fileops/osal_fileops.h"

功能说明

  • 从文件读取数据到缓冲区。

  • 从当前文件读写位置开始读取,读取完成后读写位置自动后移。

  • 返回实际读取的字节数。

前置条件

  • filp 为 osal_klib_fopen 返回的有效文件指针。

  • 文件以读模式(OSAL_O_RDONLY 或 OSAL_O_RDWR)打开。

入参

名称

参数类型

说明

约束取值范围

size

unsigned long

待读取数据字节数

> 0

filp

void *

文件指针

osal_klib_fopen 返回的有效指针,非 NULL

出参

名称

数据类型

输出说明

buf

char *

读取的文件数据,由调用方分配缓冲区且长度不小于 size,函数填充

返回值

返回类型:int

返回值

文字含义

触发场景

> 0

实际读取的字节数

读取成功

-1

读取失败

filp 或 buf 为 NULL

osal_klib_fsync #

void osal_klib_fsync(void *filp)

声明头文件

#include "fileops/osal_fileops.h"

功能说明

  • 将文件缓存数据同步到存储设备。

  • 确保数据持久化写入底层存储介质。

  • 仅支持 linux、liteos 系统。

前置条件

  • filp 为 osal_klib_fopen 返回的有效文件指针。

  • 文件已写入数据且需持久化。

入参

名称

参数类型

说明

约束取值范围

filp

void *

文件指针

osal_klib_fopen 返回的有效指针,非 NULL

osal_klib_fseek #

int osal_klib_fseek(long long offset, int whence, void *filp)

声明头文件

#include "fileops/osal_fileops.h"

功能说明

  • 设置文件读写位置偏移量。

  • 根据 whence 参数确定偏移基准位置。

  • offset 值超过 INT32_MAX 时返回 OSAL_EOVERFLOW。

前置条件

  • filp 为 osal_klib_fopen 返回的有效文件指针。

入参

名称

参数类型

说明

约束取值范围

offset

long long

偏移量

≤ INT32_MAX

whence

int

偏移基准位置

OSAL_SEEK_SET:0;
OSAL_SEEK_CUR:1;
OSAL_SEEK_END:2。

filp

void *

文件指针

osal_klib_fopen 返回的有效指针,非 NULL

返回值

返回类型:int

返回值

文字含义

触发场景

>= 0

新的文件读写位置

设置成功

-1

设置失败

filp 为 NULL 或 offset 超过 INT32_MAX

-75

偏移结果溢出

lseek 返回值超过 int 表达范围

Macros#

OSAL_O_RDONLY #

#define OSAL_O_RDONLY 00000000

OSAL_O_WRONLY #

#define OSAL_O_WRONLY 00000001

OSAL_O_RDWR #

#define OSAL_O_RDWR 00000002

OSAL_O_CREAT #

#define OSAL_O_CREAT 00000100

OSAL_O_EXCL #

#define OSAL_O_EXCL 00000200

OSAL_O_TRUNC #

#define OSAL_O_TRUNC 00001000

OSAL_O_APPEND #

#define OSAL_O_APPEND 00002000

OSAL_O_CLOEXEC #

#define OSAL_O_CLOEXEC 02000000

OSAL_SEEK_SET #

#define OSAL_SEEK_SET 0

OSAL_SEEK_CUR #

#define OSAL_SEEK_CUR 1

OSAL_SEEK_END #

#define OSAL_SEEK_END 2