xref: /freebsd/sys/fs/fuse/fuse_main.c (revision 51369649b03ece2aed3eb61b0c8214b9aa5b2fa2)
1*51369649SPedro F. Giffuni /*-
2*51369649SPedro F. Giffuni  * SPDX-License-Identifier: BSD-3-Clause
3*51369649SPedro F. Giffuni  *
45fe58019SAttilio Rao  * Copyright (c) 2007-2009 Google Inc.
55fe58019SAttilio Rao  * All rights reserved.
65fe58019SAttilio Rao  *
75fe58019SAttilio Rao  * Redistribution and use in source and binary forms, with or without
85fe58019SAttilio Rao  * modification, are permitted provided that the following conditions are
95fe58019SAttilio Rao  * met:
105fe58019SAttilio Rao  *
115fe58019SAttilio Rao  * * Redistributions of source code must retain the above copyright
125fe58019SAttilio Rao  *   notice, this list of conditions and the following disclaimer.
135fe58019SAttilio Rao  * * Redistributions in binary form must reproduce the above
145fe58019SAttilio Rao  *   copyright notice, this list of conditions and the following disclaimer
155fe58019SAttilio Rao  *   in the documentation and/or other materials provided with the
165fe58019SAttilio Rao  *   distribution.
175fe58019SAttilio Rao  * * Neither the name of Google Inc. nor the names of its
185fe58019SAttilio Rao  *   contributors may be used to endorse or promote products derived from
195fe58019SAttilio Rao  *   this software without specific prior written permission.
205fe58019SAttilio Rao  *
215fe58019SAttilio Rao  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
225fe58019SAttilio Rao  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
235fe58019SAttilio Rao  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
245fe58019SAttilio Rao  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
255fe58019SAttilio Rao  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
265fe58019SAttilio Rao  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
275fe58019SAttilio Rao  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
285fe58019SAttilio Rao  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
295fe58019SAttilio Rao  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
305fe58019SAttilio Rao  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
315fe58019SAttilio Rao  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
325fe58019SAttilio Rao  *
335fe58019SAttilio Rao  * Copyright (C) 2005 Csaba Henk.
345fe58019SAttilio Rao  * All rights reserved.
355fe58019SAttilio Rao  *
365fe58019SAttilio Rao  * Redistribution and use in source and binary forms, with or without
375fe58019SAttilio Rao  * modification, are permitted provided that the following conditions
385fe58019SAttilio Rao  * are met:
395fe58019SAttilio Rao  * 1. Redistributions of source code must retain the above copyright
405fe58019SAttilio Rao  *    notice, this list of conditions and the following disclaimer.
415fe58019SAttilio Rao  * 2. Redistributions in binary form must reproduce the above copyright
425fe58019SAttilio Rao  *    notice, this list of conditions and the following disclaimer in the
435fe58019SAttilio Rao  *    documentation and/or other materials provided with the distribution.
445fe58019SAttilio Rao  *
455fe58019SAttilio Rao  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
465fe58019SAttilio Rao  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
475fe58019SAttilio Rao  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
485fe58019SAttilio Rao  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
495fe58019SAttilio Rao  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
505fe58019SAttilio Rao  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
515fe58019SAttilio Rao  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
525fe58019SAttilio Rao  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
535fe58019SAttilio Rao  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
545fe58019SAttilio Rao  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
555fe58019SAttilio Rao  * SUCH DAMAGE.
565fe58019SAttilio Rao  */
575fe58019SAttilio Rao 
585fe58019SAttilio Rao #include <sys/cdefs.h>
595fe58019SAttilio Rao __FBSDID("$FreeBSD$");
605fe58019SAttilio Rao 
615fe58019SAttilio Rao #include <sys/types.h>
625fe58019SAttilio Rao #include <sys/module.h>
635fe58019SAttilio Rao #include <sys/systm.h>
645fe58019SAttilio Rao #include <sys/errno.h>
655fe58019SAttilio Rao #include <sys/param.h>
665fe58019SAttilio Rao #include <sys/kernel.h>
675fe58019SAttilio Rao #include <sys/conf.h>
685fe58019SAttilio Rao #include <sys/mutex.h>
695fe58019SAttilio Rao #include <sys/proc.h>
705fe58019SAttilio Rao #include <sys/mount.h>
715fe58019SAttilio Rao #include <sys/vnode.h>
725fe58019SAttilio Rao #include <sys/stat.h>
735fe58019SAttilio Rao #include <sys/file.h>
745fe58019SAttilio Rao #include <sys/buf.h>
755fe58019SAttilio Rao #include <sys/sysctl.h>
765fe58019SAttilio Rao 
775fe58019SAttilio Rao #include "fuse.h"
785fe58019SAttilio Rao 
795fe58019SAttilio Rao static void fuse_bringdown(eventhandler_tag eh_tag);
805fe58019SAttilio Rao static int fuse_loader(struct module *m, int what, void *arg);
815fe58019SAttilio Rao 
825fe58019SAttilio Rao struct mtx fuse_mtx;
835fe58019SAttilio Rao 
845fe58019SAttilio Rao extern struct vfsops fuse_vfsops;
855fe58019SAttilio Rao extern struct cdevsw fuse_cdevsw;
865fe58019SAttilio Rao extern struct vop_vector fuse_vnops;
875fe58019SAttilio Rao extern int fuse_pbuf_freecnt;
885fe58019SAttilio Rao 
895fe58019SAttilio Rao static struct vfsconf fuse_vfsconf = {
905fe58019SAttilio Rao 	.vfc_version = VFS_VERSION,
915fe58019SAttilio Rao 	.vfc_name = "fusefs",
925fe58019SAttilio Rao 	.vfc_vfsops = &fuse_vfsops,
935fe58019SAttilio Rao 	.vfc_typenum = -1,
945fe58019SAttilio Rao 	.vfc_flags = VFCF_SYNTHETIC
955fe58019SAttilio Rao };
965fe58019SAttilio Rao 
975fe58019SAttilio Rao SYSCTL_INT(_vfs_fuse, OID_AUTO, kernelabi_major, CTLFLAG_RD,
98f0188618SHans Petter Selasky     SYSCTL_NULL_INT_PTR, FUSE_KERNEL_VERSION, "FUSE kernel abi major version");
995fe58019SAttilio Rao SYSCTL_INT(_vfs_fuse, OID_AUTO, kernelabi_minor, CTLFLAG_RD,
100f0188618SHans Petter Selasky     SYSCTL_NULL_INT_PTR, FUSE_KERNEL_MINOR_VERSION, "FUSE kernel abi minor version");
1015fe58019SAttilio Rao 
1025fe58019SAttilio Rao /******************************
1035fe58019SAttilio Rao  *
1045fe58019SAttilio Rao  * >>> Module management stuff
1055fe58019SAttilio Rao  *
1065fe58019SAttilio Rao  ******************************/
1075fe58019SAttilio Rao 
1085fe58019SAttilio Rao static void
1095fe58019SAttilio Rao fuse_bringdown(eventhandler_tag eh_tag)
1105fe58019SAttilio Rao {
1115fe58019SAttilio Rao 
1125fe58019SAttilio Rao 	fuse_ipc_destroy();
1135fe58019SAttilio Rao 	fuse_device_destroy();
1145fe58019SAttilio Rao 	mtx_destroy(&fuse_mtx);
1155fe58019SAttilio Rao }
1165fe58019SAttilio Rao 
1175fe58019SAttilio Rao static int
1185fe58019SAttilio Rao fuse_loader(struct module *m, int what, void *arg)
1195fe58019SAttilio Rao {
1205fe58019SAttilio Rao 	static eventhandler_tag eh_tag = NULL;
1215fe58019SAttilio Rao 	int err = 0;
1225fe58019SAttilio Rao 
1235fe58019SAttilio Rao 	switch (what) {
1245fe58019SAttilio Rao 	case MOD_LOAD:			/* kldload */
1255fe58019SAttilio Rao 		fuse_pbuf_freecnt = nswbuf / 2 + 1;
1265fe58019SAttilio Rao 		mtx_init(&fuse_mtx, "fuse_mtx", NULL, MTX_DEF);
1275fe58019SAttilio Rao 		err = fuse_device_init();
1285fe58019SAttilio Rao 		if (err) {
1295fe58019SAttilio Rao 			mtx_destroy(&fuse_mtx);
1305fe58019SAttilio Rao 			return (err);
1315fe58019SAttilio Rao 		}
1325fe58019SAttilio Rao 		fuse_ipc_init();
1335fe58019SAttilio Rao 
1345fe58019SAttilio Rao 		/* vfs_modevent ignores its first arg */
1355fe58019SAttilio Rao 		if ((err = vfs_modevent(NULL, what, &fuse_vfsconf)))
1365fe58019SAttilio Rao 			fuse_bringdown(eh_tag);
1375fe58019SAttilio Rao 		else
1385fe58019SAttilio Rao 			printf("fuse-freebsd: version %s, FUSE ABI %d.%d\n",
1395fe58019SAttilio Rao 			    FUSE_FREEBSD_VERSION,
1405fe58019SAttilio Rao 			    FUSE_KERNEL_VERSION, FUSE_KERNEL_MINOR_VERSION);
1415fe58019SAttilio Rao 
1425fe58019SAttilio Rao 		break;
1435fe58019SAttilio Rao 	case MOD_UNLOAD:
1445fe58019SAttilio Rao 		if ((err = vfs_modevent(NULL, what, &fuse_vfsconf)))
1455fe58019SAttilio Rao 			return (err);
1465fe58019SAttilio Rao 		fuse_bringdown(eh_tag);
1475fe58019SAttilio Rao 		break;
1485fe58019SAttilio Rao 	default:
1495fe58019SAttilio Rao 		return (EINVAL);
1505fe58019SAttilio Rao 	}
1515fe58019SAttilio Rao 
1525fe58019SAttilio Rao 	return (err);
1535fe58019SAttilio Rao }
1545fe58019SAttilio Rao 
1555fe58019SAttilio Rao /* Registering the module */
1565fe58019SAttilio Rao 
1575fe58019SAttilio Rao static moduledata_t fuse_moddata = {
1585fe58019SAttilio Rao 	"fuse",
1595fe58019SAttilio Rao 	fuse_loader,
1605fe58019SAttilio Rao 	&fuse_vfsconf
1615fe58019SAttilio Rao };
1625fe58019SAttilio Rao 
1635fe58019SAttilio Rao DECLARE_MODULE(fuse, fuse_moddata, SI_SUB_VFS, SI_ORDER_MIDDLE);
1645fe58019SAttilio Rao MODULE_VERSION(fuse, 1);
165