1.\" -*- nroff -*- 2.\" 3.\" Copyright (c) 1996 Doug Rabson 4.\" 5.\" All rights reserved. 6.\" 7.\" This program is free software. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR 19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT, 22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28.\" 29.\" $FreeBSD: src/share/man/man9/VOP_OPENCLOSE.9,v 1.6.2.2 2001/12/17 11:30:18 ru Exp $ 30.\" $DragonFly: src/share/man/man9/VOP_OPENCLOSE.9,v 1.2 2003/06/17 04:37:01 dillon Exp $ 31.\" 32.Dd July 24, 1996 33.Os 34.Dt VOP_OPEN 9 35.Sh NAME 36.Nm VOP_OPEN , 37.Nm VOP_CLOSE 38.Nd open or close a file 39.Sh SYNOPSIS 40.In sys/param.h 41.In sys/vnode.h 42.Ft int 43.Fn VOP_OPEN "struct vnode *vp" "int mode" "struct ucred *cred" "struct proc *p" 44.Ft int 45.Fn VOP_CLOSE "struct vnode *vp" "int mode" "struct ucred *cred" "struct proc *p" 46.Sh DESCRIPTION 47The 48.Xr VOP_OPEN 9 49entry point is called before a file is accessed by a process and the 50.Xr VOP_CLOSE 9 51entry point is called after a file is finished with by the process. 52.Pp 53The arguments are: 54.Bl -tag -width mode 55.It Ar vp 56the vnode of the file 57.It Ar mode 58the access mode required by the calling process 59.It Ar p 60the process which is accessing the file 61.El 62.Pp 63The access mode is a set of flags, including 64.Dv FREAD , 65.Dv FWRITE , 66.Dv O_NONBLOCK , 67.Dv O_APPEND . 68.Sh LOCKS 69.Xr VOP_OPEN 9 70expects 71.Fa vp 72to be locked on entry and will leave it locked on return. 73.Pp 74.Xr VOP_CLOSE 9 75expects at least a reference to be associated with the vnode and does not 76care whether the vnode is locked or not. The lock and reference state is 77left unchanged on return. Note that 78.Fa vn_close 79expects an unlocked, referenced vnode and will dereference the vnode prior 80to returning. 81.Sh RETURN VALUES 82Zero is returned on success, otherwise an error code is returned. 83.Sh PSEUDOCODE 84.Bd -literal 85int 86vop_open(struct vnode *vp, int mode, struct ucred *cred, struct proc *p) 87{ 88 /* 89 * Most filesystems don't do much here. 90 */ 91 return 0; 92} 93.Ed 94.Sh SEE ALSO 95.Xr vnode 9 , 96.Xr VOP_LOOKUP 9 97.Sh AUTHORS 98This man page was written by 99.An Doug Rabson . 100