vfs_file.h File Reference

#include <zrtos/error.h>
#include <zrtos/bitfield.h>
#include <zrtos/vfs_dentry.h>

Include dependency graph for vfs_file.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_zrtos_vfs_file_t

Macros
#define	ZRTOS_VFS_FILE__EACH_BEGIN(fd, file)
#define	ZRTOS_VFS_FILE__EACH_END

Typedefs
typedef struct _zrtos_vfs_file_t	zrtos_vfs_file_t

Functions
zrtos_error_t	zrtos_vfs_file__open (char *path, zrtos_vfs_file_t **file, void *file_ctx)
size_t	zrtos_vfs_file__get_dentry_count (zrtos_vfs_file_t *file)
zrtos_error_t	zrtos_vfs_file__close (zrtos_vfs_file_t *file)
zrtos_error_t	zrtos_vfs_file__read (zrtos_vfs_file_t *file, char *path, void *buffer, size_t len, size_t offset, size_t *ret)
zrtos_error_t	zrtos_vfs_file__write (zrtos_vfs_file_t *file, char *path, void *buffer, size_t len, size_t offset, size_t *ret)
zrtos_error_t	zrtos_vfs_file__can_read (zrtos_vfs_file_t *file)
zrtos_error_t	zrtos_vfs_file__can_write (zrtos_vfs_file_t *file)
zrtos_error_t	zrtos_vfs_file__ioctl_va (zrtos_vfs_file_t *file, char *path, int request, va_list args)
zrtos_error_t	zrtos_vfs_file__ioctl (zrtos_vfs_file_t *file, char *path, int request,...)
void	zrtos_vfs_file__set_inode_data (zrtos_vfs_file_t *thiz, void *ctx)
void *	zrtos_vfs_file__get_inode_data (zrtos_vfs_file_t *thiz)
void	zrtos_vfs_file__set_data (zrtos_vfs_file_t *thiz, void *ctx)
void *	zrtos_vfs_file__get_data (zrtos_vfs_file_t *thiz)
void	zrtos_vfs_file__set_offset (zrtos_vfs_file_t *thiz, zrtos_vfs_offset_t offset)
zrtos_vfs_offset_t	zrtos_vfs_file__get_offset (zrtos_vfs_file_t *thiz)

Variables
zrtos_vfs_file_t	zrtos_vfs_file__index [ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX]

Macro Definition Documentation

ZRTOS_VFS_FILE__EACH_BEGIN

#define ZRTOS_VFS_FILE__EACH_BEGIN	(		fd,
			file
	)

Value:

for(size_t fd = 0;fd < ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX;fd++){\
        zrtos_vfs_file_t *file = &zrtos_vfs_file__index[fd];\
        if(0 != file->dentry){

Definition at line 211 of file vfs_file.h.

ZRTOS_VFS_FILE__EACH_END

#define ZRTOS_VFS_FILE__EACH_END

Value:

}\
    }

Definition at line 216 of file vfs_file.h.

Typedef Documentation

zrtos_vfs_file_t

typedef struct _zrtos_vfs_file_t zrtos_vfs_file_t

Function Documentation

zrtos_vfs_file__can_read()

zrtos_error_t zrtos_vfs_file__can_read

(

zrtos_vfs_file_t *

file

)

Definition at line 126 of file vfs_file.h.

 {
    return file->dentry ? ZRTOS_VFS_PLUGIN__INVOKE(
         file->dentry->inode.plugin
        ,ZRTOS_VFS_PLUGIN_OPERATION__CAN_READ
        ,file
    ) : ZRTOS_ERROR__BADF;
}

Here is the caller graph for this function:

zrtos_vfs_file__can_write()

zrtos_error_t zrtos_vfs_file__can_write

(

zrtos_vfs_file_t *

file

)

Definition at line 136 of file vfs_file.h.

 {
    return file->dentry ? ZRTOS_VFS_PLUGIN__INVOKE(
         file->dentry->inode.plugin
        ,ZRTOS_VFS_PLUGIN_OPERATION__CAN_WRITE
        ,file
    ) : ZRTOS_ERROR__BADF;
}

Here is the caller graph for this function:

zrtos_vfs_file__close()

zrtos_error_t zrtos_vfs_file__close

(

zrtos_vfs_file_t *

file

)

Definition at line 71 of file vfs_file.h.

                                                           {
    zrtos_error_t ret;

    file->dentry->count--;
    ret = ZRTOS_VFS_PLUGIN__INVOKE(
         file->dentry->inode.plugin
        ,ZRTOS_VFS_PLUGIN_OPERATION__CLOSE
        ,file
    );
    file->dentry = 0;
    file->offset = 0;

    return ret;
}

Here is the caller graph for this function:

zrtos_vfs_file__get_data()

void* zrtos_vfs_file__get_data

(

zrtos_vfs_file_t *

thiz

)

Definition at line 199 of file vfs_file.h.

                                                      {
    return thiz->ctx;
}

Here is the caller graph for this function:

zrtos_vfs_file__get_dentry_count()

size_t zrtos_vfs_file__get_dentry_count

(

zrtos_vfs_file_t *

file

)

Definition at line 67 of file vfs_file.h.

                                                               {
    return file->dentry->count;
}

Here is the caller graph for this function:

zrtos_vfs_file__get_inode_data()

void* zrtos_vfs_file__get_inode_data

(

zrtos_vfs_file_t *

thiz

)

Definition at line 191 of file vfs_file.h.

                                                            {
    return thiz->dentry->inode.ctx;
}

Here is the caller graph for this function:

zrtos_vfs_file__get_offset()

zrtos_vfs_offset_t zrtos_vfs_file__get_offset

(

zrtos_vfs_file_t *

thiz

)

Definition at line 207 of file vfs_file.h.

                                                                     {
    return thiz->offset;
}

Here is the caller graph for this function:

zrtos_vfs_file__ioctl()

zrtos_error_t zrtos_vfs_file__ioctl	(	zrtos_vfs_file_t *	file,
		char *	path,
		int	request,
			...
	)

Definition at line 166 of file vfs_file.h.

 {
    zrtos_error_t ret;
    va_list       args;

    va_start(args,request);
    ret = zrtos_vfs_file__ioctl_va(
         file
        ,path
        ,request
        ,args
    );
    va_end(args);

    return ret;
}

Here is the call graph for this function:

zrtos_vfs_file__ioctl_va()

zrtos_error_t zrtos_vfs_file__ioctl_va	(	zrtos_vfs_file_t *	file,
		char *	path,
		int	request,
		va_list	args
	)

Definition at line 146 of file vfs_file.h.

 {
    zrtos_error_t ret;

    ret = file->dentry ? ZRTOS_VFS_PLUGIN__INVOKE(
         file->dentry->inode.plugin
        ,ZRTOS_VFS_PLUGIN_OPERATION__IOCTL
        ,file
        ,path
        ,request
        ,args
    ) : ZRTOS_ERROR__BADF;

    return ret;
}

Here is the caller graph for this function:

zrtos_vfs_file__open()

zrtos_error_t zrtos_vfs_file__open	(	char *	path,
		zrtos_vfs_file_t **	file,
		void *	file_ctx
	)

Definition at line 30 of file vfs_file.h.

                                                                                     {
    zrtos_error_t ret;
    zrtos_vfs_dentry_t *dentry = zrtos_vfs_dentry__lookup(
         0
        ,path
    );
    if(dentry){ 
        for(size_t fd=0;fd<ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX;fd++){
            if(0 == zrtos_vfs_file__index[fd].dentry){
                zrtos_vfs_file_t *tmp = *file = &zrtos_vfs_file__index[fd];

                dentry->count++;
                tmp->dentry = dentry;
                tmp->ctx = file_ctx;

                zrtos_vfs_plugin_t *plugin = dentry->inode.plugin;
                ret = ZRTOS_VFS_PLUGIN__INVOKE(
                     plugin
                    ,ZRTOS_VFS_PLUGIN_OPERATION__OPEN
                    ,tmp
                );
                if(!zrtos_error__is_success(ret)){
                    dentry->count--;
                    tmp->dentry = 0;
                }
                goto L_OUT;
            }
        }
        ret = ZRTOS_ERROR__MFILE;
    }else{
        ret = ZRTOS_ERROR__NOENT;
    }

L_OUT:
    return ret;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_vfs_file__read()

zrtos_error_t zrtos_vfs_file__read	(	zrtos_vfs_file_t *	file,
		char *	path,
		void *	buffer,
		size_t	len,
		size_t	offset,
		size_t *	ret
	)

Definition at line 86 of file vfs_file.h.

 {
    return file->dentry ? ZRTOS_VFS_PLUGIN__INVOKE(
         file->dentry->inode.plugin
        ,ZRTOS_VFS_PLUGIN_OPERATION__READ
        ,file
        ,path
        ,buffer
        ,len
        ,offset
        ,ret
    ) : ZRTOS_ERROR__BADF;
}

Here is the caller graph for this function:

zrtos_vfs_file__set_data()

void zrtos_vfs_file__set_data	(	zrtos_vfs_file_t *	thiz,
		void *	ctx
	)

Definition at line 195 of file vfs_file.h.

                                                               {
    thiz->ctx = ctx;
}

zrtos_vfs_file__set_inode_data()

void zrtos_vfs_file__set_inode_data	(	zrtos_vfs_file_t *	thiz,
		void *	ctx
	)

Definition at line 187 of file vfs_file.h.

                                                                     {
    thiz->dentry->inode.ctx = ctx;
}

zrtos_vfs_file__set_offset()

void zrtos_vfs_file__set_offset	(	zrtos_vfs_file_t *	thiz,
		zrtos_vfs_offset_t	offset
	)

Definition at line 203 of file vfs_file.h.

                                                                                 {
    thiz->offset = offset;
}

Here is the caller graph for this function:

zrtos_vfs_file__write()

zrtos_error_t zrtos_vfs_file__write	(	zrtos_vfs_file_t *	file,
		char *	path,
		void *	buffer,
		size_t	len,
		size_t	offset,
		size_t *	ret
	)

Definition at line 106 of file vfs_file.h.

 {
    return file->dentry ? ZRTOS_VFS_PLUGIN__INVOKE(
         file->dentry->inode.plugin
        ,ZRTOS_VFS_PLUGIN_OPERATION__WRITE
        ,file
        ,path
        ,buffer
        ,len
        ,offset
        ,ret
    ) : ZRTOS_ERROR__BADF;
}

Here is the caller graph for this function:

Variable Documentation

zrtos_vfs_file__index

zrtos_vfs_file_t zrtos_vfs_file__index[ZRTOS_VFS_FILE_DESCRIPTOR__CFG_MAX]

Definition at line 28 of file vfs_file.h.