share/man/man9/VOP_OPENCLOSE.9

   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 .\"
  31 .Dd July 24, 1996
  32 .Os
  33 .Dt VOP_OPEN 9
  34 .Sh NAME
  35 .Nm VOP_OPEN ,
  36 .Nm VOP_CLOSE
  37 .Nd open or close a file
  38 .Sh SYNOPSIS
  39 .In sys/param.h
  40 .In sys/vnode.h
  41 .Ft int
  42 .Fn VOP_OPEN "struct vnode *vp" "int mode" "struct ucred *cred" "struct proc *p"
  43 .Ft int
  44 .Fn VOP_CLOSE "struct vnode *vp" "int mode" "struct ucred *cred" "struct proc *p"
  45 .Sh DESCRIPTION
  46 The
  47 .Xr VOP_OPEN 9
  48 entry point is called before a file is accessed by a process and the
  49 .Xr VOP_CLOSE 9
  50 entry point is called after a file is finished with by the process.
  51 .Pp
  52 The arguments are:
  53 .Bl -tag -width mode
  54 .It Ar vp
  55 the vnode of the file
  56 .It Ar mode
  57 the access mode required by the calling process
  58 .It Ar p
  59 the process which is accessing the file
  60 .El
  61 .Pp
  62 The access mode is a set of flags, including
  63 .Dv FREAD ,
  64 .Dv FWRITE ,
  65 .Dv O_NONBLOCK ,
  66 .Dv O_APPEND .
  67 .Sh LOCKS
  68 .Xr VOP_OPEN 9
  69 expects
  70 .Fa vp
  71 to be locked on entry and will leave it locked on return.
  72 .Pp
  73 .Xr VOP_CLOSE 9
  74 expects at least a reference to be associated with the vnode and does not
  75 care whether the vnode is locked or not.  The lock and reference state is
  76 left unchanged on return.  Note that
  77 .Fa vn_close
  78 expects an unlocked, referenced vnode and will dereference the vnode prior
  79 to returning.
  80 .Sh RETURN VALUES
  81 Zero is returned on success, otherwise an error code is returned.
  82 .Sh PSEUDOCODE
  83 .Bd -literal
  84 int
  85 vop_open(struct vnode *vp, int mode, struct ucred *cred, struct proc *p)
  86 {
  87     /*
  88      * Most filesystems don't do much here.
  89      */
  90     return 0;
  91 }
  92 .Ed
  93 .Sh SEE ALSO
  94 .Xr vnode 9 ,
  95 .Xr VOP_LOOKUP 9
  96 .Sh AUTHORS
  97 This man page was written by
  98 .An Doug Rabson .