xref: /freebsd/sys/fs/fuse/fuse_main.c (revision cd0d51baaa4509a1db83251a601d34404d20c990)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2007-2009 Google Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are
9  * met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  *   copyright notice, this list of conditions and the following disclaimer
15  *   in the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of Google Inc. nor the names of its
18  *   contributors may be used to endorse or promote products derived from
19  *   this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Copyright (C) 2005 Csaba Henk.
34  * All rights reserved.
35  *
36  * Copyright (c) 2019 The FreeBSD Foundation
37  *
38  * Portions of this software were developed by BFF Storage Systems, LLC under
39  * sponsorship from the FreeBSD Foundation.
40  *
41  * Redistribution and use in source and binary forms, with or without
42  * modification, are permitted provided that the following conditions
43  * are met:
44  * 1. Redistributions of source code must retain the above copyright
45  *    notice, this list of conditions and the following disclaimer.
46  * 2. Redistributions in binary form must reproduce the above copyright
47  *    notice, this list of conditions and the following disclaimer in the
48  *    documentation and/or other materials provided with the distribution.
49  *
50  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
60  * SUCH DAMAGE.
61  */
62 
63 #include <sys/cdefs.h>
64 __FBSDID("$FreeBSD$");
65 
66 #include <sys/types.h>
67 #include <sys/module.h>
68 #include <sys/systm.h>
69 #include <sys/errno.h>
70 #include <sys/param.h>
71 #include <sys/kernel.h>
72 #include <sys/conf.h>
73 #include <sys/mutex.h>
74 #include <sys/proc.h>
75 #include <sys/queue.h>
76 #include <sys/mount.h>
77 #include <sys/vnode.h>
78 #include <sys/stat.h>
79 #include <sys/file.h>
80 #include <sys/buf.h>
81 #include <sys/sdt.h>
82 #include <sys/sysctl.h>
83 
84 #include "fuse.h"
85 #include "fuse_file.h"
86 #include "fuse_ipc.h"
87 #include "fuse_internal.h"
88 #include "fuse_node.h"
89 
90 static void fuse_bringdown(eventhandler_tag eh_tag);
91 static int fuse_loader(struct module *m, int what, void *arg);
92 
93 struct mtx fuse_mtx;
94 
95 extern struct vfsops fuse_vfsops;
96 extern struct cdevsw fuse_cdevsw;
97 extern struct vop_vector fuse_fifonops;
98 extern uma_zone_t fuse_pbuf_zone;
99 
100 static struct vfsconf fuse_vfsconf = {
101 	.vfc_version = VFS_VERSION,
102 	.vfc_name = "fusefs",
103 	.vfc_vfsops = &fuse_vfsops,
104 	.vfc_typenum = -1,
105 	.vfc_flags = VFCF_JAIL | VFCF_SYNTHETIC
106 };
107 
108 SYSCTL_NODE(_vfs, OID_AUTO, fusefs, CTLFLAG_RW, 0, "FUSE tunables");
109 SYSCTL_NODE(_vfs_fusefs, OID_AUTO, stats, CTLFLAG_RW, 0, "FUSE statistics");
110 SYSCTL_INT(_vfs_fusefs, OID_AUTO, kernelabi_major, CTLFLAG_RD,
111     SYSCTL_NULL_INT_PTR, FUSE_KERNEL_VERSION, "FUSE kernel abi major version");
112 SYSCTL_INT(_vfs_fusefs, OID_AUTO, kernelabi_minor, CTLFLAG_RD,
113     SYSCTL_NULL_INT_PTR, FUSE_KERNEL_MINOR_VERSION, "FUSE kernel abi minor version");
114 SDT_PROVIDER_DEFINE(fusefs);
115 
116 /******************************
117  *
118  * >>> Module management stuff
119  *
120  ******************************/
121 
122 static void
123 fuse_bringdown(eventhandler_tag eh_tag)
124 {
125 	fuse_node_destroy();
126 	fuse_internal_destroy();
127 	fuse_file_destroy();
128 	fuse_ipc_destroy();
129 	fuse_device_destroy();
130 	mtx_destroy(&fuse_mtx);
131 }
132 
133 static int
134 fuse_loader(struct module *m, int what, void *arg)
135 {
136 	static eventhandler_tag eh_tag = NULL;
137 	int err = 0;
138 
139 	switch (what) {
140 	case MOD_LOAD:			/* kldload */
141 		mtx_init(&fuse_mtx, "fuse_mtx", NULL, MTX_DEF);
142 		err = fuse_device_init();
143 		if (err) {
144 			mtx_destroy(&fuse_mtx);
145 			return (err);
146 		}
147 		fuse_ipc_init();
148 		fuse_file_init();
149 		fuse_internal_init();
150 		fuse_node_init();
151 		fuse_pbuf_zone = pbuf_zsecond_create("fusepbuf", nswbuf / 2);
152 
153 		/* vfs_modevent ignores its first arg */
154 		if ((err = vfs_modevent(NULL, what, &fuse_vfsconf)))
155 			fuse_bringdown(eh_tag);
156 		break;
157 	case MOD_UNLOAD:
158 		if ((err = vfs_modevent(NULL, what, &fuse_vfsconf)))
159 			return (err);
160 		fuse_bringdown(eh_tag);
161 		uma_zdestroy(fuse_pbuf_zone);
162 		break;
163 	default:
164 		return (EINVAL);
165 	}
166 
167 	return (err);
168 }
169 
170 /* Registering the module */
171 
172 static moduledata_t fuse_moddata = {
173 	"fusefs",
174 	fuse_loader,
175 	&fuse_vfsconf
176 };
177 
178 DECLARE_MODULE(fusefs, fuse_moddata, SI_SUB_VFS, SI_ORDER_MIDDLE);
179 MODULE_VERSION(fusefs, 1);
180