xref: /freebsd/share/man/man9/vfs_getvfs.9 (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
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.Dd November 21, 2001
28.Dt VFS_GETVFS 9
29.Os
30.Sh NAME
31.Nm vfs_getvfs
32.Nd "returns a mount point given its file system identifier"
33.Sh SYNOPSIS
34.In sys/param.h
35.In sys/mount.h
36.Ft "struct mount *"
37.Fn vfs_getvfs "fsid_t *fsid"
38.Sh DESCRIPTION
39The
40.Fn vfs_getvfs
41function returns the mount point structure for a file system given its file system
42identifier.
43The file system ID should have been allocated by calling
44.Xr vfs_getnewfsid 9 ;
45otherwise, it will not be found.
46.Pp
47A major user of
48.Fn vfs_getvfs
49is NFS, which uses the
50.Vt fsid
51as part of file handles in order to determine the
52file system a given RPC is for.
53If
54.Fn vfs_getvfs
55fails to find the mount point related to
56.Fa fsid ,
57the file system is considered stale.
58.Sh RETURN VALUES
59If
60.Fa fsid
61is found, the mount point for the ID is returned; otherwise,
62.Dv NULL
63is returned.
64.Sh PSEUDOCODE
65.Bd -literal
66if ((mp = vfs_getvfs(&fhp->fh_fsid)) == NULL) {
67	error = ESTALE;
68	goto out;
69}
70.Ed
71.Sh SEE ALSO
72.Xr vfs_getnewfsid 9
73.Sh AUTHORS
74This manual page was written by
75.An Chad David Aq Mt davidc@acns.ab.ca .
76