share/man/man9/VFS_CHECKEXP.9

   1 .\"
   2 .\" Copyright (c) 1999 Alfred Perlstein
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" This program is free software.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following condition
  10 .\" is met:
  11 .\"    Redistributions of source code must retain the above copyright
  12 .\"    notice, this condition and the following disclaimer.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man9/VFS_CHECKEXP.9,v 1.2.2.4 2001/12/17 11:30:18 ru Exp $
  26 .\"
  27 .Dd September 10, 1999
  28 .Dt VFS_CHECKEXP 9
  29 .Os
  30 .Sh NAME
  31 .Nm VFS_CHECKEXP
  32 .Nd check if vnode is exported to a client
  33 .Sh SYNOPSIS
  34 .In sys/param.h
  35 .In sys/mount.h
  36 .Ft int
  37 .Fn VFS_CHECKEXP "struct mount *mp" "struct mbuf *nam" "int *exflagsp" "struct ucred **credanonp"
  38 .Sh DESCRIPTION
  39 This is used by the NFS server to check if a mount point is exported
  40 to a client.
  41 .Pp
  42 Its arguments are:
  43 .Bl -tag -width credanonp
  44 .It Fa mp
  45 The mount point to be checked.
  46 .It Fa nam
  47 An mbuf containing the network address of the client.
  48 .It Fa exflagsp
  49 Return parameter for the export flags for this client.
  50 .It Fa credanonp
  51 Return parameter for the anonymous credentials for this client.
  52 .El
  53 .Pp
  54 This should be called on a file system's mount structure to determine if it
  55 is exported to a client whose address is contained in
  56 .Fa nam .
  57 .Pp
  58 It is generally called before
  59 .Xr VFS_FHTOVP 9
  60 to validate that a client has access to the filesystem.
  61 .Pp
  62 The filesystem should call
  63 .Fn vfs_export_lookup
  64 with the address of an appropriate
  65 .Vt netexport
  66 structure and the address of the client,
  67 .Fa nam ,
  68 to verify that the client can access this filesystem.
  69 .Sh RETURN VALUES
  70 The export flags and anonymous credentials specific to the client (returned
  71 by
  72 .Fn vfs_export_lookup )
  73 will be returned in
  74 .Fa *exflagsp
  75 and
  76 .Fa *credanonp .
  77 .Sh SEE ALSO
  78 .Xr VFS 9 ,
  79 .Xr VFS_FHTOVP 9 ,
  80 .Xr VFS_VPTOFH 9 ,
  81 .Xr vnode 9
  82 .Sh AUTHORS
  83 This man page was written by
  84 .An Alfred Perlstein .