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