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