2001-12-03 00:25:04 +00:00
|
|
|
.\"
|
|
|
|
.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice(s), this list of conditions and the following disclaimer as
|
|
|
|
.\" the first lines of this file unmodified other than the possible
|
|
|
|
.\" addition of one or more copyright notices.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice(s), this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
|
|
|
|
.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
|
|
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
|
|
.\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
|
|
|
|
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
|
|
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
|
|
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
|
|
.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
|
|
|
|
.\" DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" $FreeBSD$
|
|
|
|
.\"
|
|
|
|
.Dd November 21, 2001
|
|
|
|
.Dt VFS_GETNEWFSID 9
|
|
|
|
.Os
|
|
|
|
.Sh NAME
|
|
|
|
.Nm vfs_getnewfsid
|
2002-12-12 17:26:04 +00:00
|
|
|
.Nd "allocate a new file system identifier"
|
2001-12-03 00:25:04 +00:00
|
|
|
.Sh SYNOPSIS
|
|
|
|
.In sys/param.h
|
|
|
|
.In sys/mount.h
|
|
|
|
.Ft void
|
|
|
|
.Fn vfs_getnewfsid "struct mount *mp"
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
The
|
|
|
|
.Fn vfs_getnewfsid
|
2002-12-12 17:26:04 +00:00
|
|
|
function allocates a new file system identifier for the mount point given.
|
|
|
|
File systems typically call
|
2001-12-03 00:25:04 +00:00
|
|
|
.Fn vfs_getnewfsid
|
2001-12-14 09:11:13 +00:00
|
|
|
in their mount routine in order to acquire a unique ID within the system
|
2002-12-12 17:26:04 +00:00
|
|
|
which can later be used to uniquely identify the file system via calls such as
|
2001-12-14 09:11:13 +00:00
|
|
|
.Xr vfs_getvfs 9 .
|
2001-12-03 00:25:04 +00:00
|
|
|
.Pp
|
2001-12-14 09:11:13 +00:00
|
|
|
The actual
|
|
|
|
.Vt fsid
|
|
|
|
is made up of two 32 bit integers, that are stored in the
|
|
|
|
.Vt statfs
|
2001-12-03 00:25:04 +00:00
|
|
|
structure of
|
|
|
|
.Fa mp .
|
2002-12-12 17:26:04 +00:00
|
|
|
The first integer is unique in the set of mounted file systems,
|
|
|
|
while the second holds the file system type.
|
2001-12-03 00:25:04 +00:00
|
|
|
.Bd -literal
|
2001-12-14 09:11:13 +00:00
|
|
|
typedef struct fsid {
|
|
|
|
int32_t val[2];
|
|
|
|
} fsid_t;
|
2001-12-03 00:25:04 +00:00
|
|
|
.Ed
|
|
|
|
.Sh PSEUDOCODE
|
|
|
|
.Bd -literal
|
2001-12-14 09:11:13 +00:00
|
|
|
xxx_mount(struct mount *mp, char *path, caddr_t data,
|
|
|
|
struct nameidata *ndp, struct thread *td)
|
|
|
|
{
|
|
|
|
...
|
|
|
|
vfs_getnewfsid(mp);
|
|
|
|
...
|
|
|
|
}
|
2001-12-03 00:25:04 +00:00
|
|
|
.Ed
|
|
|
|
.Sh SEE ALSO
|
|
|
|
.Xr vfs_getvfs 9
|
|
|
|
.Sh AUTHORS
|
|
|
|
This man page was written by
|
|
|
|
.An Chad David Aq davidc@acns.ab.ca .
|