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$
  30 .\"
  31 .Dd December 2, 2009
  32 .Dt VOP_OPEN 9
  33 .Os
  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 thread *td" "struct file *fp"
  43 .Ft int
  44 .Fn VOP_CLOSE "struct vnode *vp" "int mode" "struct ucred *cred" "struct thread *td"
  45 .Sh DESCRIPTION
  46 The
  47 .Fn VOP_OPEN
  48 entry point is called before a file is accessed by a process and the
  49 .Fn VOP_CLOSE
  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 Fa vp
  55 The vnode of the file.
  56 .It Fa mode
  57 The access mode required by the calling process.
  58 .It Fa cred
  59 The caller's credentials.
  60 .It Fa td
  61 The thread which is accessing the file.
  62 .It Fa fp
  63 The file being opened.
  64 .El
  65 .Pp
  66 Pointer to the file
  67 .Fa fp
  68 is useful for file systems which require such information, e.g.,
  69 .Xr fdescfs 5 .
  70 Use
  71 .Ql NULL
  72 as
  73 .Fa fp
  74 argument to
  75 .Fn VOP_OPEN
  76 for in-kernel opens.
  77 .Pp
  78 The access mode is a set of flags, including
  79 .Dv FREAD ,
  80 .Dv FWRITE ,
  81 .Dv O_NONBLOCK ,
  82 .Dv O_APPEND .
  83 .Sh LOCKS
  84 .Fn VOP_OPEN
  85 expects
  86 .Fa vp
  87 to be locked on entry and will leave it locked on return.
  88 .Pp
  89 .Fn VOP_CLOSE
  90 expects at least a reference to be associated with the vnode and does not
  91 care whether the vnode is locked or not.
  92 The lock and reference state is left unchanged on return.
  93 Note that
  94 .Fa vn_close
  95 expects an unlocked, referenced vnode and will dereference the vnode prior
  96 to returning.
  97 .Sh RETURN VALUES
  98 Zero is returned on success, otherwise an error code is returned.
  99 .Sh SEE ALSO
 100 .Xr vnode 9 ,
 101 .Xr VOP_LOOKUP 9
 102 .Sh AUTHORS
 103 This manual page was written by
 104 .An Doug Rabson .