1.\" Copyright (c) 1996 Doug Rabson 2.\" 3.\" All rights reserved. 4.\" 5.\" This program is free software. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR 17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, 20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26.\" 27.\" $FreeBSD: src/share/man/man9/vnode.9,v 1.10.2.5 2001/12/17 11:30:19 ru Exp $ 28.\" 29.Dd May 5, 2007 30.Dt VNODE 9 31.Os 32.Sh NAME 33.Nm vnode 34.Nd internal representation of a file, directory, or other VFS entity 35.Sh SYNOPSIS 36.In sys/param.h 37.In sys/vnode.h 38.Sh DESCRIPTION 39The vnode is the focus of all file activity in 40.Ux . 41The 42.Nm 43is described by 44.Vt "struct vnode" . 45There is a 46unique vnode allocated for each active file, each current directory, 47each mounted-on file, text file, and the root. 48.Pp 49Each vnode has numerous reference counts, 50.Fa v_sysref , 51.Fa v_auxrefs , 52.Fa v_opencount , 53and 54.Fa v_writecount . 55.Pp 56.Fa v_sysref 57represents the number of primary references to the vnode. 58It is actually 59a structure which utilizes the SYSREF API and also manages allocation and 60deallocation of the vnode. 61Primary references keep a vnode ready for I/O and prevent it from being 62deactivated. 63Primary references are managed by 64.Xr vref 9 65and 66.Xr vrele 9 . 67.Pp 68.Fa v_auxrefs 69represents the number of auxiliary references to a vnode. 70Auxiliary references prevent a vnode from being reclaimed (if not already being 71reclaimed), reused for other purposes, or otherwise destroyed, but 72do not activate or deactivate the vnode. 73Auxiliary references are managed by 74.Xr vhold 9 75and 76.Xr vdrop 9 . 77.Pp 78.Fa v_opencount 79represents the number of discrete 80.Fn open 81calls made on the vnode (reading or writing). 82.Fa v_writecount 83represents the number of discrete 84.Fn open 85calls made on the vnode for the purpose of writing. 86This field will be a subset of 87.Fa v_opencount . 88These fields are managed primarily by calls to 89.Xr vn_open 9 90and 91.Xr vn_close 9 . 92.Pp 93A deactivated vnode or a vnode in an unknown state accessed from an 94Auxiliary data structure can be reactivated, referenced, and locked using 95.Xr vget 9 96and 97.Xr vput 9 . 98.Pp 99An actively referenced and possibly locked vnode must be passed 100to most kernel procedures taking a vnode as an argument. 101Most kernel procedures returning a vnode will return one that is actively 102referenced. 103.Pp 104Other commonly used members of the vnode structure are 105.Fa v_mount 106which points at the filesystem which owns the vnode, 107.Fa v_type 108which contains the type of object the vnode represents and 109.Fa v_data 110which is used by filesystems to store filesystem specific data with 111the vnode. 112The 113.Fa v_ops 114field is used by the 115.Dv VOP_* 116macros to call functions in the filesystem which implement the vnode's 117functionality. 118.Sh VNODE TYPES 119.Bl -tag -width ".Dv VSOCK" 120.It Dv VNON 121No type. 122.It Dv VREG 123A regular file; may be with or without VM object backing. 124If you want to make sure this get a backing object, call 125.Xr vfs_object_create 9 . 126.It Dv VDIR 127A directory. 128.It Dv VBLK 129A block device; may be with or without VM object backing. 130If you want to make sure this get a backing object, call 131.Xr vfs_object_create 9 . 132.It Dv VCHR 133A character device. 134.It Dv VLNK 135A symbolic link. 136.It Dv VSOCK 137A socket. 138Advisory locking won't work on this. 139.It Dv VFIFO 140A FIFO (named pipe). 141Advisory locking won't work on this. 142.It Dv VBAD 143An old style bad sector map. 144.El 145.Sh IMPLEMENTATION NOTES 146.Dv VFIFO 147uses the 148.Vt struct fileops 149from 150.Pa /sys/kern/sys_pipe.c . 151.Dv VSOCK 152uses the 153.Vt struct fileops 154from 155.Pa /sys/kern/sys_socket.c . 156Everything else uses the one from 157.Pa /sys/kern/vfs_vnops.c . 158.Pp 159The VFIFO/VSOCK code, which is why 160.Vt struct fileops 161is used at all, is an artifact of an incomplete integration of 162the VFS code into the kernel. 163.Sh SEE ALSO 164.Xr VFS 9 165.Sh AUTHORS 166This manual page was written by 167.An Doug Rabson . 168