vnode_ops_t Struct Reference

vnode operations structure. More...

#include <vnode.h>

Collaboration diagram for vnode_ops_t:

Data Fields
uint64_t(*	lookup )(vnode_t *dir, dentry_t *target)
	Look up a dentry in a directory vnode.
uint64_t(*	create )(vnode_t *dir, dentry_t *target, mode_t mode)
	Handles both directories and files depending on mode.
void(*	truncate )(vnode_t *target)
	Set the vnode size to zero.
uint64_t(*	link )(vnode_t *dir, dentry_t *old, dentry_t *new)
	Make the same file vnode appear twice in the filesystem.
uint64_t(*	readlink )(vnode_t *vnode, char *buffer, uint64_t size)
	Retrieve the path of the symbolic link.
uint64_t(*	symlink )(vnode_t *dir, dentry_t *target, const char *dest)
	Create a symbolic link.
uint64_t(*	remove )(vnode_t *dir, dentry_t *target)
	Remove a file or directory.
void(*	cleanup )(vnode_t *vnode)
	Cleanup function called when the vnode is being freed.

Detailed Description

vnode operations structure.

Note that the vnodes mutex will be acquired by the vfs.

Definition at line 68 of file vnode.h.

Field Documentation

lookup

uint64_t(* vnode_ops_t::lookup) (vnode_t *dir, dentry_t *target)

Look up a dentry in a directory vnode.

Should set the target dentry to be positive (give it an vnode), if the entry does not exist the operation should still return success but leave the dentry negative.

Parameters

dir	The directory vnode to look in.
target	The dentry to look up.

Returns

On success, 0. On failure, returns ERR and errno is set.

Definition at line 80 of file vnode.h.

create

uint64_t(* vnode_ops_t::create) (vnode_t *dir, dentry_t *target, mode_t mode)

Handles both directories and files depending on mode.

Takes in a negative dentry and creates the corresponding vnode to make the dentry positive.

Parameters

dir	The directory vnode to create the entry in.
target	The negative dentry to create.
mode	The mode to create the entry with.

Returns

On success, 0. On failure, returns ERR and errno is set.

Definition at line 91 of file vnode.h.

truncate

void(* vnode_ops_t::truncate) (vnode_t *target)

Set the vnode size to zero.

Parameters

target

The vnode to truncate.

Definition at line 97 of file vnode.h.

link

uint64_t(* vnode_ops_t::link) (vnode_t *dir, dentry_t *old, dentry_t *new)

Make the same file vnode appear twice in the filesystem.

Parameters

dir	The directory vnode to create the link in.
old	The existing dentry containing the vnode to link to.
new	The negative dentry to store the same vnode as old.

Returns

On success, 0. On failure, returns ERR and errno is set.

Definition at line 106 of file vnode.h.

readlink

uint64_t(* vnode_ops_t::readlink) (vnode_t *vnode, char *buffer, uint64_t size)

Retrieve the path of the symbolic link.

Parameters

vnode	The symbolic link vnode.
buffer	The buffer to store the path in.
size	The size of the buffer.

Returns

On success, the number of bytes read. On failure, returns ERR and errno is set.

Definition at line 115 of file vnode.h.

symlink

uint64_t(* vnode_ops_t::symlink) (vnode_t *dir, dentry_t *target, const char *dest)

Create a symbolic link.

Parameters

dir	The directory vnode to create the symbolic link in.
target	The negative dentry to create.
dest	The path to which the symbolic link will point.

Returns

On success, 0. On failure, returns ERR and errno is set.

Definition at line 124 of file vnode.h.

remove

uint64_t(* vnode_ops_t::remove) (vnode_t *dir, dentry_t *target)

Remove a file or directory.

Parameters

dir	The directory vnode containing the target.
target	The dentry to remove.

Returns

On success, 0. On failure, returns ERR and errno is set.

Definition at line 132 of file vnode.h.

cleanup

void(* vnode_ops_t::cleanup) (vnode_t *vnode)

Cleanup function called when the vnode is being freed.

Parameters

vnode

The vnode being freed.

Definition at line 138 of file vnode.h.

---

The documentation for this struct was generated from the following file:

• include/kernel/fs/vnode.h