Filesystem abstraction

virtual and physical filesystem interface More...

Collaboration diagram for Filesystem abstraction:

Data Structures
struct	sync_result_t
	the result of a fs_sync call this is here because we cant use Compiler message notification in the fs api More...

Functions
CT_FS_API void	fs_delete (STA_RELEASE fs_t *fs)
	delete a filesystem handle More...
CT_NODISCARD CT_FS_API fs_t *	fs_physical (const char *root, arena_t *arena)
	create a filesystem interface to a physical location on disk More...
CT_NODISCARD CT_FS_API fs_t *	fs_virtual (const char *name, arena_t *arena)
	create a virtual filesystem interface More...
CT_FS_API os_error_t	fs_dir_create (fs_t *fs, const char *path)
	create a directory create a directory and all child directories inside a filesystem More...
CT_FS_API void	fs_file_create (fs_t *fs, const char *path)
	create a file More...
CT_NODISCARD CT_FS_API io_t *	fs_open (fs_t *fs, const char *path, os_access_t flags)
	open a file at a given location in the filesystem More...
CT_NODISCARD CT_FS_API bool	fs_dir_exists (fs_t *fs, const char *path)
	query if a directory exists More...
CT_NODISCARD CT_FS_API bool	fs_file_exists (fs_t *fs, const char *path)
	query if a file exists More...
CT_FS_API os_error_t	fs_dir_delete (fs_t *fs, const char *path)
	delete a directory delete a directory and all contained files and folders More...
CT_FS_API os_error_t	fs_file_delete (fs_t *fs, const char *path)
	delete a file More...
CT_FS_API sync_result_t	fs_sync (fs_t *dst, fs_t *src)
	synchronize 2 filesystems copies all folders and files from src to dst More...
CT_PUREFN CT_FS_API os_dirent_t	fs_inode_type (const fs_inode_t *inode)
	get the type of an inode More...
CT_PUREFN CT_FS_API bool	fs_inode_is (const fs_inode_t *inode, os_dirent_t type)
	check if a given inode is of a certain type More...
CT_PUREFN CT_FS_API const char *	fs_inode_name (const fs_inode_t *inode)
	get the name of an inode More...
CT_FS_API fs_inode_t *	fs_find_inode (fs_t *fs, const char *path)
	find an inode in a filesystem More...
CT_PUREFN CT_FS_API fs_inode_t *	fs_root_inode (fs_t *fs)
	get the root inode of a filesystem More...
CT_FS_API os_error_t	fs_iter_begin (fs_t *fs, const fs_inode_t *node, OUT_NOTNULL fs_iter_t **iter)
	begin iterating over a directory More...
CT_FS_API os_error_t	fs_iter_end (fs_iter_t *iter)
	end an iteration More...
CT_FS_API os_error_t	fs_iter_next (fs_iter_t *iter, OUT_NOTNULL fs_inode_t **inode)
	get the next inode in an iteration More...

Detailed Description

virtual and physical filesystem interface

Function Documentation

fs_delete()

CT_FS_API void fs_delete

(

STA_RELEASE fs_t *

fs

)

delete a filesystem handle

Parameters

fs	the filesystem to delete

fs_dir_create()

CT_FS_API os_error_t fs_dir_create	(	fs_t *	fs,
		const char *	path
	)

create a directory create a directory and all child directories inside a filesystem

Parameters

fs	the filesystem
path	the full path of the directory

Returns

0 on success, an error code otherwise

Definition at line 333 of file fs.c.

fs_dir_delete()

CT_FS_API os_error_t fs_dir_delete	(	fs_t *	fs,
		const char *	path
	)

delete a directory delete a directory and all contained files and folders

Parameters

fs	the filesystem
path	the path to the folder

Returns

0 on success, an error code otherwise

Definition at line 397 of file fs.c.

fs_dir_exists()

CT_NODISCARD CT_FS_API bool fs_dir_exists	(	fs_t *	fs,
		const char *	path
	)

query if a directory exists

Parameters

fs	the filesystem
path	the path of the directory

Returns

true if it exists, false otherwise

Definition at line 368 of file fs.c.

fs_file_create()

CT_FS_API void fs_file_create	(	fs_t *	fs,
		const char *	path
	)

create a file

Note

this function will not create intermediate directories

create a file inside a directory

Parameters

fs	the filesystem
path	the full path of the file

Definition at line 176 of file fs.c.

fs_file_delete()

CT_FS_API os_error_t fs_file_delete	(	fs_t *	fs,
		const char *	path
	)

delete a file

Parameters

fs	the filesystem
path	the path to the file

Returns

0 on success, an error code otherwise

Definition at line 219 of file fs.c.

fs_file_exists()

CT_NODISCARD CT_FS_API bool fs_file_exists	(	fs_t *	fs,
		const char *	path
	)

query if a file exists

Parameters

fs	the filesystem
path	the path of the file

Returns

true if it exists, false otherwise

Definition at line 197 of file fs.c.

fs_find_inode()

CT_FS_API fs_inode_t* fs_find_inode	(	fs_t *	fs,
		const char *	path
	)

find an inode in a filesystem

Parameters

fs	the filesystem to search
path	the path to the inode

Returns

the inode if it exists, NULL otherwise

Definition at line 544 of file fs.c.

fs_inode_is()

CT_PUREFN CT_FS_API bool fs_inode_is	(	const fs_inode_t *	inode,
		os_dirent_t	type
	)

check if a given inode is of a certain type

Parameters

inode	the inode to check
type	the type to check against

Returns

true if the inode is of the given type, false otherwise

Definition at line 528 of file fs.c.

fs_inode_name()

CT_PUREFN CT_FS_API const char* fs_inode_name

(

const fs_inode_t *

inode

)

get the name of an inode

Note

the name is only valid for the lifetime of the inode

Parameters

inode

the inode to get the name of

Returns

the name of the inode

Definition at line 536 of file fs.c.

fs_inode_type()

CT_PUREFN CT_FS_API os_dirent_t fs_inode_type

(

const fs_inode_t *

inode

)

get the type of an inode

Parameters

inode

the inode to get the type of

Returns

the type of the inode

Definition at line 520 of file fs.c.

fs_iter_begin()

CT_FS_API os_error_t fs_iter_begin	(	fs_t *	fs,
		const fs_inode_t *	node,
		OUT_NOTNULL fs_iter_t **	iter
	)

begin iterating over a directory

Parameters

fs	the filesystem to iterate
node	the path to the directory
iter	the iterator to create

Returns

eOsSuccess on success, an error code otherwise

fs_iter_end()

CT_FS_API os_error_t fs_iter_end

(

fs_iter_t *

iter

)

end an iteration

Parameters

iter	the iterator to end

Returns

eOsSuccess on success, an error code otherwise

Definition at line 590 of file fs.c.

fs_iter_next()

CT_FS_API os_error_t fs_iter_next	(	fs_iter_t *	iter,
		OUT_NOTNULL fs_inode_t **	inode
	)

get the next inode in an iteration

Parameters

iter	the iterator to get the next inode from
inode	the inode to write to

Returns

eOsSuccess on success, an error code otherwise

Return values

eOsNotFound

if there are no more inodes

fs_open()

CT_NODISCARD CT_FS_API io_t* fs_open	(	fs_t *	fs,
		const char *	path,
		os_access_t	flags
	)

open a file at a given location in the filesystem

Warning

the returned io object is not thread safe

Parameters

fs	the filesystem
path	the path of the file
flags	the access modifiers to use when opening the file

Returns

an io object representing the file on disk

Definition at line 254 of file fs.c.

fs_physical()

CT_NODISCARD CT_FS_API fs_t* fs_physical	(	const char *	root,
		arena_t *	arena
	)

create a filesystem interface to a physical location on disk

Parameters

root	the root directory to mount this filesystem on
arena	the arena to allocate from

Returns

a filesystem interface, or NULL if the filesystem failed to mount

Definition at line 215 of file physical.c.

fs_root_inode()

CT_PUREFN CT_FS_API fs_inode_t* fs_root_inode

(

fs_t *

fs

)

get the root inode of a filesystem

Parameters

fs	the filesystem to get the root inode of

Returns

the root inode of the filesystem

Definition at line 553 of file fs.c.

fs_sync()

CT_FS_API sync_result_t fs_sync	(	fs_t *	dst,
		fs_t *	src
	)

synchronize 2 filesystems copies all folders and files from src to dst

Parameters

dst	the destination filesystem
src	the source filesystem

Definition at line 511 of file fs.c.

fs_virtual()

CT_NODISCARD CT_FS_API fs_t* fs_virtual	(	const char *	name,
		arena_t *	arena
	)

create a virtual filesystem interface

Parameters

name	the name of the vfs
arena	the arena to allocate from

Returns

a filesystem interface to an in-memory fs

Definition at line 273 of file virtual.c.