fs_operation.h 文件参考

浏览源代码.

函数
void	los_vfs_init (void)
	Initializes the vfs filesystem 更多...
void	CloseOnExec (struct files_struct *files)
void	SetCloexecFlag (int procFd)
bool	CheckCloexecFlag (int procFd)
void	ClearCloexecFlag (int procFd)
void	clear_fd (int fd)
char *	rindex (const char *s, int c)
	locate character in string. 更多...
void	set_label (const char *name)
int	format (const char *dev, int sectors, int option)
	formatting sd card 更多...
void	ls (const char *pathname)
	list directory contents. 更多...
int	los_set_systime_status (BOOL b_status)
	set current system time is valid or invalid for FAT file system. 更多...
int	chattr (const char *pathname, struct IATTR *attr)
int	VfsFcntl (int fd, int cmd,...)
INT32	LOS_BcacheSyncByName (const CHAR *name)
INT32	LOS_GetDirtyRatioByName (const CHAR *name)
VOID	LOS_SetDirtyRatioThreshold (UINT32 dirtyRatio)
VOID	LOS_SetSyncThreadInterval (UINT32 interval)
	设置同步间隔,5秒 更多...
INT32	LOS_SetSyncThreadPrio (UINT32 prio, const CHAR *name)
	设置同步任务优先级,10 更多...

函数说明

chattr()

int chattr	(	const char *	pathname,
		struct IATTR *	attr
	)

在文件 vfs_chattr.c 第 58 行定义.

{
    struct Vnode *vnode = NULL;
    int ret;
 
    if (pathname == NULL || attr == NULL) {
        set_errno(EINVAL);
        return VFS_ERROR;
    }
 
    VnodeHold();
    ret = VnodeLookup(pathname, &vnode, 0);
    if (ret != LOS_OK) {
        goto errout_with_lock;
    }
 
    if ((vnode->originMount) && (vnode->originMount->mountFlags & MS_RDONLY)) {
        ret = -EROFS;
        goto errout_with_lock;
    }
 
    /* The way we handle the stat depends on the type of vnode that we
     * are dealing with.
     */
 
    if (vnode->vop != NULL && vnode->vop->Chattr != NULL) {
        ret = vnode->vop->Chattr(vnode, attr);
    } else {
        ret = -ENOSYS;
    }
    VnodeDrop();
 
    if (ret < 0) {
        goto errout;
    }
 
    return OK;
 
    /* Failure conditions always set the errno appropriately */
 
errout_with_lock:
    VnodeDrop();
errout:
    set_errno(-ret);
    return VFS_ERROR;
}

函数调用图:

这是这个函数的调用关系图:

CheckCloexecFlag()

bool CheckCloexecFlag

(

int

procFd

)

在文件 vfs_cloexec.c 第 75 行定义.

{
    bool isCloexec = 0;
    struct fd_table_s *fdt = GetFdTable();
    if (fdt == NULL) {
        return false;
    }
 
    FileTableLock(fdt);
    isCloexec = FD_ISSET(procFd, fdt->cloexec_fds);
    FileTableUnLock(fdt);
    return isCloexec;
}

函数调用图:

这是这个函数的调用关系图:

clear_fd()

void clear_fd

(

int

fd

)

ClearCloexecFlag()

void ClearCloexecFlag

(

int

procFd

)

在文件 vfs_cloexec.c 第 89 行定义.

{
    struct fd_table_s *fdt = GetFdTable();
    if (fdt == NULL) {
        return;
    }
 
    FileTableLock(fdt);
    FD_CLR(procFd, fdt->cloexec_fds);
    FileTableUnLock(fdt);
    return;
}

函数调用图:

这是这个函数的调用关系图:

CloseOnExec()

void CloseOnExec

(

struct files_struct *

files

)

在文件 vfs_cloexec.c 第 42 行定义.

{
    int sysFd;
    if ((files == NULL) || (files->fdt == NULL)) {
        return;
    }
 
    for (int i = 0; i < files->fdt->max_fds; i++) {
        if (FD_ISSET(i, files->fdt->proc_fds) &&
            FD_ISSET(i, files->fdt->cloexec_fds)) {
            sysFd = DisassociateProcessFd(i);
            if (sysFd >= 0) {
                close(sysFd);
            }
 
            FreeProcessFd(i);
        }
    }
}

函数调用图:

这是这个函数的调用关系图:

format()

int format	(	const char *	dev,
		int	sectors,
		int	option
	)

formatting sd card

Description:

formatting sd card.

注意

• The prefix of the parameter dev must be "/dev", and the length must be less than the value defined by PATH_MAX. There are four kind of format option: FMT_FAT16, FMT_FAT32, FMT_ANY, FMT_ERASE. If users input anything else, the default format option is FMT_ANY. Format option is decided by the number of clusters. Choosing the wrong option will cause error of format. The detailed information of (FAT16,FAT32) is ff.h.

参数

dev	[IN] Type #const char* path of the block device to format, which must be a really existing block device node.
sectors	[IN] Type int number of sectors per cluster.
option	[IN] Type int option of format.

返回值

#0	Format success.
#-1	Format failed.

Dependency:

• unistd.h: the header file that contains the API declaration.

参见

在文件 format.c 第 44 行定义.

{
    struct Vnode *device = NULL;
    INT err;
    if (dev == NULL) {
        set_errno(EINVAL);
        return -1;
    }
 
    if (strncmp(dev, "/dev", DEV_NAME_SIZE) != 0) {
        PRINTK("Usage  :\n");
        PRINTK("        format <dev_vnodename> <sectors> <option> <label>\n");
        PRINTK("        dev_vnodename : the name of dev\n");
        PRINTK("        sectors       : Size of allocation unit in unit of byte or sector, ");
        PRINTK("0 instead of default size\n");
        PRINTK("        options       : Index of filesystem. 1 for FAT filesystem, 2 for FAT32 filesystem, ");
        PRINTK("7 for any, 8 for erase\n");
        PRINTK("        label         : The volume of device. It will be emptyed when this parameter is null\n");
        PRINTK("Example:\n");
        PRINTK("        format /dev/mmcblk0 128 2\n");
 
        set_errno(EINVAL);
        return -1;
    }
    VnodeHold();
    err = VnodeLookup(dev, &device, 0);
    if (err == -ENOENT || err == -ENOSYS) {
        VnodeDrop();
        set_errno(ENODEV);
        return -1;
    } else if (err < 0) {
        VnodeDrop();
        set_errno(-err);
        return -1;
    }
    err = fatfs_mkfs(device, sectors, option);
    if (err < 0) {
        VnodeDrop();
        set_errno(-err);
        return -1;
    }
#ifdef LOSCFG_FS_FAT_VIRTUAL_PARTITION
    else if (err >= VIRERR_BASE) {
        set_errno(err);
    }
#endif
    VnodeDrop();
    return 0;
}

函数调用图:

这是这个函数的调用关系图:

LOS_BcacheSyncByName()

INT32 LOS_BcacheSyncByName

(

const CHAR *

name

)

Description:

The LOS_BcacheSyncByName() function shall sync all the data in the cache corresponding to the disk name to the disk.

参数

name	[IN] name of the disk

注意

• Now only fat filesystem support this function.

返回值

#0	On success.
INT32	On failure.

Dependency:

• fs.h

参见

None

在文件 bcache.c 第 983 行定义.

{
    INT32 diskID = los_get_diskid_byname(name);
    return OsSdSync(diskID);
}

函数调用图:

LOS_GetDirtyRatioByName()

INT32 LOS_GetDirtyRatioByName

(

const CHAR *

name

)

Description:

The LOS_GetDirtyRatioByName() function shall return the percentage of dirty blocks in the cache corresponding to the disk name.

参数

name	[IN] name of the disk

注意

• Now only fat filesystem support this function.

返回值

INT32	the percentage of dirty blocks.
#-1	On failure.

Dependency:

• fs.h

参见

None

在文件 bcache.c 第 1017 行定义.

{
    INT32 diskID = los_get_diskid_byname(name);
    return BcacheGetDirtyRatio(diskID);
}

函数调用图:

los_set_systime_status()

int los_set_systime_status

(

BOOL

b_status

)

set current system time is valid or invalid for FAT file system.

Description:

The function is used for setting current system time is valid or invalid for FAT file system. The value can be set as FAT_SYSTEM_TIME_ENABLE/FAT_SYSTEM_TIME_DISABLE.

注意

• When the system time is valid, it should set FAT_SYSTEM_TIME_ENABLE.
• When the system time is invalid, it should set FAT_SYSTEM_TIME_DISABLE.

参数

b_status

[IN] Type BOOL system time status.

返回值

#0	set status success
#-22	Invalid argument

Dependency:

• fs.h: the header file that contains the API declaration.

参见

LOS_SetDirtyRatioThreshold()

VOID LOS_SetDirtyRatioThreshold

(

UINT32

dirtyRatio

)

Description:

The LOS_SetDirtyRatioThreshold() function shall set the dirty ratio threshold of bcache. When the percentage of dirty blocks in the cache is greater than the threshold, write back data to disk.

参数

dirtyRatio

[IN] Threshold of the percentage of dirty blocks, expressed in %.

注意

• The dirtyRatio must be less than or equal to 100, or the setting is invalid.

返回值

#VOID

None.

Dependency:

• fs.h

参见

LOS_SetSyncThreadInterval | LOS_SetSyncThreadPrio

在文件 bcache.c 第 85 行定义.

{
    if ((dirtyRatio != g_dirtyRatio) && (dirtyRatio <= 100)) { /* The ratio cannot exceed 100% */
        g_dirtyRatio = dirtyRatio;
    }
}

LOS_SetSyncThreadInterval()

VOID LOS_SetSyncThreadInterval

(

UINT32

interval

)

设置同步间隔,5秒

Description:

The LOS_SetSyncThreadInterval() function shall set the interval for the sync thread to wake up.

参数

interval

[IN] the interval time for the sync thread to wake up, in milliseconds, accuracy is 10ms.

注意

• None

返回值

#VOID

None.

Dependency:

• fs.h

参见

LOS_SetDirtyRatioThreshold | LOS_SetSyncThreadPrio

在文件 bcache.c 第 92 行定义.

{
    g_syncInterval = interval;
}

LOS_SetSyncThreadPrio()

INT32 LOS_SetSyncThreadPrio	(	UINT32	prio,
		const CHAR *	name
	)

设置同步任务优先级,10

Description:

The LOS_SetSyncThreadPrio() function shall set the priority of the sync thread.

参数

prio	[IN] priority of sync thread to be set
name	[IN] name of the disk

注意

• The prio must be less than 31 and be greater than 0, or the setting is invalid.
• If the parameter name is NULL, it only set the value of a global variable, and take effect the next time the thread is created. If name is not NULL and can't find the disk corresponding to name, it shall return an error.

返回值

INT32	On failure.
0	On success.

Dependency:

• fs.h

参见

LOS_SetDirtyRatioThreshold | LOS_SetSyncThreadInterval | LOS_TaskPriSet

在文件 bcache.c 第 97 行定义.

{
    INT32 ret = VFS_ERROR;
    INT32 diskID;
    los_disk *disk = NULL;
    if ((prio == 0) || (prio >= OS_TASK_PRIORITY_LOWEST)) { /* The priority can not be zero */
        return ret;
    }
 
    g_syncThreadPrio = prio;
 
    /*
     * If the name is NULL, it only sets the value of a global variable,
     * and takes effect the next time the thread is created.
     */
    if (name == NULL) {
        return ENOERR;
    }
 
    /* If the name is not NULL, it shall return an error if can't find the disk corresponding to name. */
    diskID = los_get_diskid_byname(name);//获取磁盘ID
    disk = get_disk(diskID);//获取磁盘信息
    if (disk == NULL) {
        return ret;
    }
 
    if (pthread_mutex_lock(&disk->disk_mutex) != ENOERR) {
        PRINT_ERR("%s %d, mutex lock fail!\n", __FUNCTION__, __LINE__);
        return ret;
    }
    if ((disk->disk_status == STAT_INUSED) && (disk->bcache != NULL)) {
        ret = LOS_TaskPriSet(disk->bcache->syncTaskId, prio);//设置任务优先级
    }
    if (pthread_mutex_unlock(&disk->disk_mutex) != ENOERR) {
        PRINT_ERR("%s %d, mutex unlock fail!\n", __FUNCTION__, __LINE__);
        return VFS_ERROR;
    }
    return ret;
}

函数调用图:

los_vfs_init()

void los_vfs_init

(

void

)

Initializes the vfs filesystem

Description:

This API is used to initializes the vfs filesystem

注意

• Called only once, multiple calls will cause file system error.

参数

none

返回值

none

Dependency:

• fs.h: the header file that contains the API declaration.

参见

NULL

在文件 vfs_init.c 第 70 行定义.

{
    uint retval;
    static bool g_vfs_init = false;
    if (g_vfs_init) {
        return;
    }
 
#ifdef LOSCFG_FS_FAT_DISK //两个自旋锁
    spin_lock_init(&g_diskSpinlock);
    spin_lock_init(&g_diskFatBlockSpinlock);
#endif
    files_initialize();
    files_initlist(&tg_filelist);
 
    retval = VnodesInit();//索引节点初始化
    if (retval != LOS_OK) {
        PRINT_ERR("los_vfs_init VnodeInit failed error %d\n", retval);
        return;
    }
 
    retval = PathCacheInit();//路径缓存初始化
    if (retval != LOS_OK) {
        PRINT_ERR("los_vfs_init PathCacheInit failed error %d\n", retval);
        return;
    }
    retval = VnodeHashInit();//哈希列表初始化
    if (retval != LOS_OK) {
        PRINT_ERR("los_vfs_init VnodeHashInit failed error %d\n", retval);
        return;
    }
 
    retval = VnodeDevInit();
    if (retval != LOS_OK) {
        PRINT_ERR("los_vfs_init VnodeDevInit failed error %d\n", retval);
        return;
    }
 
    g_vfs_init = true;
}

函数调用图:

这是这个函数的调用关系图:

ls()

void ls

(

const char *

pathname

)

list directory contents.

Description:

List information about the FILEs (the current directory by default).

注意

• The total length of parameter pathname must be less than the value defined by PATH_MAX.

参数

pathname

[IN] Type #const char* The file pathname.

返回值

<ul>None.</ul>

Dependency:

• fs.h: the header file that contains the API declaration.

参见

ls

在文件 vfs_other.c 第 600 行定义.

{
    struct stat statInfo = { 0 };
    char *path = NULL;
    int ret;
 
    if (pathname == NULL) {
#ifdef VFS_USING_WORKDIR
        UINTPTR lock_flags;
        LosProcessCB *curr = OsCurrProcessGet();
 
        /* open current working directory */
 
        spin_lock_irqsave(&curr->files->workdir_lock, lock_flags);
        path = strdup(curr->files->workdir);
        spin_unlock_irqrestore(&curr->files->workdir_lock, lock_flags);
#else
        path = strdup("/");
#endif
        if (path == NULL) {
            return;
        }
    } else {
        ret = vfs_normalize_path(NULL, pathname, &path);
        if (ret < 0) {
            set_errno(-ret);
            return;
        }
    }
 
    ret = stat(path, &statInfo);
    if (ret < 0) {
        perror("ls error");
        free(path);
        return;
    }
 
    if (statInfo.st_mode & S_IFDIR) { /* list all directory and file */
        ret = LsDir((pathname == NULL) ? path : pathname);
    } else { /* show the file infomation */
        ret = LsFile(path);
    }
    if (ret < 0) {
        perror("ls error");
    }
 
    free(path);
    return;
}

函数调用图:

rindex()

char * rindex	(	const char *	s,
		int	c
	)

locate character in string.

Description:

The API function returns a pointer to the last occurrence of the character c in the string s.

注意

• The parameter s must point a valid string, which end with the terminating null byte.

参数

s	[IN] Type #const char* A pointer to string.
c	[IN] Type int The character.

返回值

#char*

a pointer to the matched character or NULL if the character is not found.

Dependency:

• fs.h: the header file that contains the API declaration.

参见

rindex

在文件 vfs_other.c 第 432 行定义.

{
    if (s == NULL) {
        return NULL;
    }
 
    /* Don't bother tracing - strrchr can do that */
    return (char *)strrchr(s, c);
}

set_label()

void set_label

(

const char *

name

)

Description:

The set_label() function shall set the value of a global varible, the value will be used to set the label of SD card in format().

参数

name	[IN] label to set, the length must be less than 12

注意

• The function must be called before format().

返回值

void

None.

Dependency:

• fs.h

参见

format

在文件 format.c 第 94 行定义.

{
    INT len;
    INT err;
 
    (void)memset_s(FatLabel, LABEL_LEN, 0, LABEL_LEN);
 
    if (name == NULL || *name == '\0') {
        return;
    }
 
    len = strlen(name);
    if (len >= LABEL_LEN) {
        len = LABEL_LEN - 1;
    }
 
    err = strncpy_s(FatLabel, LABEL_LEN, name, len);
    if (err != EOK) {
        PRINT_ERR("Fat set_label error");
    }
}

这是这个函数的调用关系图:

SetCloexecFlag()

void SetCloexecFlag

(

int

procFd

)

在文件 vfs_cloexec.c 第 62 行定义.

{
    struct fd_table_s *fdt = GetFdTable();
    if (fdt == NULL) {
        return;
    }
 
    FileTableLock(fdt);
    FD_SET(procFd, fdt->cloexec_fds);
    FileTableUnLock(fdt);
    return;
}

函数调用图:

这是这个函数的调用关系图:

VfsFcntl()

int VfsFcntl	(	int	fd,
		int	cmd,
			...
	)

Description:

The VfsFcntl function shall manipulate file descriptor.

返回值

#0	On success.
#-1	On failure with errno set.
CONTINE_NUTTX_FCNTL	doesn't support some cmds in VfsFcntl, needs to continue going through Nuttx vfs operation.

Dependency:

• fs.h

参见

None

在文件 vfs_fcntl.c 第 68 行定义.

{
    va_list ap;
    int ret = 0;
 
    va_start(ap, cmd);
    switch (cmd) {
        case F_DUPFD:
            {
                int arg = va_arg(ap, int);
                ret = FcntlDupFd(procfd, arg);
            }
            break;
        case F_GETFD:
            {
                bool isCloexec = CheckCloexecFlag(procfd);
                ret = isCloexec ? FD_CLOEXEC : 0;
            }
            break;
        case F_SETFD:
            {
                int oflags = va_arg(ap, int);
                if (oflags & FD_CLOEXEC) {
                    SetCloexecFlag(procfd);
                } else {
                    ClearCloexecFlag(procfd);
                }
            }
            break;
        default:
            ret = CONTINE_NUTTX_FCNTL;
            break;
    }
 
    va_end(ap);
    return ret;
}

函数调用图:

这是这个函数的调用关系图: