share/man/man9/vfs_getvfs.9

   1 .\"
   2 .\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  16 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18 .\" DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
  19 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  25 .\" DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd November 21, 2001
  30 .Dt VFS_GETVFS 9
  31 .Os
  32 .Sh NAME
  33 .Nm vfs_getvfs
  34 .Nd "returns a mount point given its file system identifier"
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/mount.h
  38 .Ft "struct mount *"
  39 .Fn vfs_getvfs "fsid_t *fsid"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn vfs_getvfs
  43 function returns the mount point structure for a file system given its file system
  44 identifier.
  45 The file system ID should have been allocated by calling
  46 .Xr vfs_getnewfsid 9 ;
  47 otherwise, it will not be found.
  48 .Pp
  49 A major user of
  50 .Fn vfs_getvfs
  51 is NFS, which uses the
  52 .Vt fsid
  53 as part of file handles in order to determine the
  54 file system a given RPC is for.
  55 If
  56 .Fn vfs_getvfs
  57 fails to find the mount point related to
  58 .Fa fsid ,
  59 the file system is considered stale.
  60 .Sh RETURN VALUES
  61 If
  62 .Fa fsid
  63 is found, the mount point for the ID is returned; otherwise,
  64 .Dv NULL
  65 is returned.
  66 .Sh PSEUDOCODE
  67 .Bd -literal
  68 if ((mp = vfs_getvfs(&fhp->fh_fsid)) == NULL) {
  69         error = ESTALE;
  70         goto out;
  71 }
  72 .Ed
  73 .Sh SEE ALSO
  74 .Xr vfs_getnewfsid 9
  75 .Sh AUTHORS
  76 This manual page was written by
  77 .An Chad David Aq davidc@acns.ab.ca .