share/man/man9/VOP_LEASE.9

   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/VOP_LEASE.9,v 1.2.2.5 2001/12/17 11:30:18 ru Exp $
  28 .\" $DragonFly: src/share/man/man9/VOP_LEASE.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
  29 .\"
  30 .Dd September 24, 1999
  31 .Os
  32 .Dt VOP_LEASE 9
  33 .Sh NAME
  34 .Nm VOP_LEASE
  35 .Nd "validate a vnode for a particular set of credentials and operation type"
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/mount.h
  39 .Ft int
  40 .Fn VOP_LEASE "struct vnode *vp" "struct proc *p" "struct ucred *cred" "int type"
  41 .Sh DESCRIPTION
  42 This entry point is currently not implemented.  I believe the idea is to
  43 validate a vnode for a particular set of user credentials and operation type.
  44 The two operation types supported are LEASE_READ and LEASE_WRITE.  The
  45 function currently always returns 0.
  46 .Sh LOCKS
  47 The vnode must be exclusively locked on entry, and should remain exclusively
  48 locked on return.
  49 .Sh RETURN VALUES
  50 If successful, zero is returned.  Otherwise, well... zero is returned too.
  51 .Sh ERRORS
  52 .Sh SEE ALSO
  53 .Xr VOP_READ 9 ,
  54 .Xr VOP_WRITE 9
  55 .Sh AUTHORS
  56 This man page was written by
  57 .An Matt Dillon .