vfs.h File Reference

#include <sys/kmem.h>
#include <sys/stat.h>

Include dependency graph for vfs.h:

Go to the source code of this file.

Data Structures
struct	VFS
struct	VNode
struct	VFSOp

Typedefs
typedef struct VFSOp	VFSOp
typedef struct VNode	VNode
typedef struct VFS	VFS

Functions
	DECLARE_SLAB (VFS)
	DECLARE_SLAB (VNode)
int	VFS_MountRoot (Disk *root)
VNode *	VFS_Lookup (const char *path)
int	VFS_Stat (const char *path, struct stat *sb)
int	VFS_Open (VNode *fn)
int	VFS_Close (VNode *fn)
int	VFS_Read (VNode *fn, void *buf, uint64_t off, uint64_t len)
int	VFS_Write (VNode *fn, void *buf, uint64_t off, uint64_t len)
int	VFS_ReadDir (VNode *fn, void *buf, uint64_t len, uint64_t *off)

---

Data Structure Documentation

VFS

struct VFS

Definition at line 11 of file vfs.h.

Collaboration diagram for VFS:

Data Fields
void *	bitmap[16]
uint64_t	blksize
Disk *	disk
void *	fsptr
uint64_t	fsval
Spinlock	lock
VFSOp *	op
uint64_t	refCount
VNode *	root

VNode

struct VNode

Definition at line 24 of file vfs.h.

Collaboration diagram for VNode:

Data Fields
Disk *	disk
void *	fsptr
uint64_t	fsval
Spinlock	lock
VFSOp *	op
uint64_t	refCount
VFS *	vfs

Typedef Documentation

VFS

typedef struct VFS VFS

VFSOp

typedef struct VFSOp VFSOp

Definition at line 8 of file vfs.h.

VNode

typedef struct VNode VNode

Definition at line 9 of file vfs.h.

Function Documentation

DECLARE_SLAB() [1/2]

DECLARE_SLAB

(

VFS

)

DECLARE_SLAB() [2/2]

DECLARE_SLAB

(

VNode

)

VFS_Close()

int VFS_Close

(

VNode *

fn

)

VFS_Close –

Close a vnode.

Parameters

[in]

fn

VNode to close.

Returns

Return status

Definition at line 162 of file vfs.c.

{
    return fn->op->close(fn);
}

Here is the caller graph for this function:

VFS_Lookup()

VNode * VFS_Lookup

(

const char *

path

)

VFS_Lookup –

Lookup a VNode by a path. This function recursively searches the directory heirarchy until the given path is found otherwise returns NULL if not found.

Definition at line 63 of file vfs.c.

{
    int status;
    const char *start = path + 1; 
    const char *end = path + 1;
    uint64_t len;
    VNode *curNode;
    VNode *oldNode;
    char curName[256];
 
    if (path[0] != '/')
        return NULL;
 
    status = rootFS->op->getroot(rootFS, &curNode);
    if (status < 0)
        Panic("Failed to get root VNode\n");
 
    while (1) {
        while (*end != '\0' && *end != '/')
            end++;
 
        len = (size_t)(end - start);
        if (len == 0) {
            // Handle root and trailing slash
            return curNode;
        }
        if (len > 256) {
            // Release
            return NULL;
        }
 
        memcpy(curName, start, len);
        curName[len] = '\0';
 
        oldNode = curNode;
        curNode = NULL;
        status = oldNode->op->lookup(oldNode, &curNode, curName);
        if (status < 0) {
            // Release
            return NULL;
        }
 
        // Release oldNode
 
        if (*end == '\0') {
            Log(vfs, "%s %lx\n", path, curNode);
            return curNode;
        }
 
        start = end + 1;
        end = end + 1;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

VFS_MountRoot()

int VFS_MountRoot

(

Disk *

rootDisk

)

VFS_MountRoot –

Mount the root file system from a specific disk.

Definition at line 36 of file vfs.c.

{
    int status;
 
    Spinlock_Init(&vfsLock, "VFS Lock", SPINLOCK_TYPE_NORMAL);
 
    Slab_Init(&vfsSlab, "VFS Slab", sizeof(VFS), 16);
    Slab_Init(&vnodeSlab, "VNode Slab", sizeof(VNode), 16);
 
    rootFS = O2FS_Mount(rootDisk);
    if (!rootFS)
        return -1;
 
    status = rootFS->op->getroot(rootFS, &rootNode);
    if (status < 0)
        Panic("Failed to get root VNode\n");
 
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

VFS_Open()

int VFS_Open

(

VNode *

fn

)

VFS_Open –

Open a vnode for reading and writing.

Parameters

[in]

fn

VNode to open.

Returns

Return status

Definition at line 147 of file vfs.c.

{
    return fn->op->open(fn);
}

Here is the caller graph for this function:

VFS_Read()

int VFS_Read	(	VNode *	fn,
		void *	buf,
		uint64_t	off,
		uint64_t	len
	)

VFS_Read –

Read from a vnode.

Parameters

[in]	fn	VNode to read from.
[in]	buf	Buffer to write the data to.
[in]	off	File offset in bytes.
[in]	len	Length to read in bytes.

Returns

Return status

Definition at line 180 of file vfs.c.

{
    return fn->op->read(fn, buf, off, len);
}

Here is the caller graph for this function:

VFS_ReadDir()

int VFS_ReadDir	(	VNode *	fn,
		void *	buf,
		uint64_t	len,
		uint64_t *	off
	)

VFS_ReadDir –

Read a directory entry from a vnode.

Parameters

[in]	fn	VNode to read from.
[in]	buf	Buffer to write the data to.
[in]	off	Directory offset in bytes.
[in]	len	Length to read in bytes.

Returns

Return status

Definition at line 216 of file vfs.c.

{
    return fn->op->readdir(fn, buf, len, off);
}

Here is the caller graph for this function:

VFS_Stat()

int VFS_Stat	(	const char *	path,
		struct stat *	sb
	)

VFS_Stat –

Return the struct stat that contains the file and directory information for a given VNode.

Definition at line 124 of file vfs.c.

{
    VNode *vn = VFS_Lookup(path);
    if (vn == NULL)
        return -ENOENT;
 
    vn->op->stat(vn, sb);
 
    // Release
 
    return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

VFS_Write()

int VFS_Write	(	VNode *	fn,
		void *	buf,
		uint64_t	off,
		uint64_t	len
	)

VFS_Write –

Write from a vnode.

Parameters

[in]	fn	VNode to write to.
[in]	buf	Buffer to read the data from.
[in]	off	File offset in bytes.
[in]	len	Length to read in bytes.

Returns

Return status

Definition at line 198 of file vfs.c.

{
    return fn->op->write(fn, buf, off, len);
}

Here is the caller graph for this function: