vfs_root Entry Point

Purpose

Returns the root v-node of a virtual file system (VFS).

Syntax

int vfs_root ( vfsp,  vpp,  crp)
struct vfs *vfsp;
struct vnode **vpp;
struct ucred *crp;

Parameters

Item Description
vfsp Points to the vfs structure.
vpp Points to the place to return the v-node pointer.
crp Points to the cred structure. This structure contains data that the file system can use to validate access permission.

Description

The vfs_root entry point is invoked by the logical file system to get a pointer to the root v-node of the file system. When successful, the vpp parameter points to the root virtual node (v-node) and the v-node hold count is incremented.

Execution Environment

The vfs_root entry point can be called from the process environment only.

Return Values

Item Description
0 Indicates success.

Nonzero return values are returned from the /usr/include/sys/errno.h file to indicate failure.