xref: /freebsd/share/man/man9/VFS_SET.9 (revision bc96366c864c07ef352edb92017357917c75b36c)
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 February 21, 2013
30.Dt VFS_SET 9
31.Os
32.Sh NAME
33.Nm VFS_SET
34.Nd set up loadable file system
35.Vt vfsconf
36.Sh SYNOPSIS
37.In sys/param.h
38.In sys/kernel.h
39.In sys/module.h
40.In sys/mount.h
41.Ft void
42.Fn VFS_SET "struct vfsops *vfsops" "fsname" "int flags"
43.Sh DESCRIPTION
44.Fn VFS_SET
45creates a
46.Vt vfsconf
47structure for the loadable module with the given
48.Fa vfsops , fsname
49and
50.Fa flags ,
51and declares it by calling
52.Xr DECLARE_MODULE 9
53using
54.Fn vfs_modevent
55as the event handler.
56.Pp
57Possible values for the
58.Fa flags
59argument are:
60.Bl -hang -width ".Dv VFCF_DELEGADMIN"
61.It Dv VFCF_STATIC
62File system should be statically available in the kernel.
63.It Dv VFCF_NETWORK
64Network exportable file system.
65.It Dv VFCF_READONLY
66Does not support write operations.
67.It Dv VFCF_SYNTHETIC
68Pseudo file system, data does not represent on-disk files.
69.It Dv VFCF_LOOPBACK
70Loopback file system layer.
71.It Dv VFCF_UNICODE
72File names are stored as Unicode.
73.It Dv VFCF_JAIL
74Can be mounted from within a jail if
75.Va security.jail.mount_allowed
76sysctl is set to
77.Dv 1 .
78.It Dv VFCF_DELEGADMIN
79Supports delegated administration if
80.Va vfs.usermount
81sysctl is set to
82.Dv 1 .
83.It Dv VFCF_SBDRY
84When in VFS method, the thread suspension is deferred to the user
85boundary upon arrival of stop action.
86.El
87.Sh PSEUDOCODE
88.Bd -literal
89/*
90 * Fill in the fields for which we have special methods.
91 * The others are initially null.  This tells vfs to change them to
92 * pointers to vfs_std* functions during file system registration.
93 */
94static struct vfsops myfs_vfsops = {
95        .vfs_mount =    myfs_mount,
96        .vfs_root =     myfs_root,
97        .vfs_statfs =   myfs_statfs,
98        .vfs_unmount =  myfs_unmount,
99};
100
101VFS_SET(myfs_vfsops, myfs, 0);
102.Ed
103.Sh SEE ALSO
104.Xr jail 2 ,
105.Xr jail 8 ,
106.Xr DECLARE_MODULE 9 ,
107.Xr vfs_modevent 9 ,
108.Xr vfsconf 9
109.Sh AUTHORS
110This manual page was written by
111.An Chad David Aq Mt davidc@acns.ab.ca .
112