1 // SPDX-License-Identifier: BSD-2-Clause
2 /*
3 * Copyright (c) 2020 iXsystems, Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, 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 AUTHORS AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER 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
25 * SUCH DAMAGE.
26 *
27 */
28
29 #include <sys/param.h>
30 #include <sys/buf.h>
31 #include <sys/cmn_err.h>
32 #include <sys/conf.h>
33 #include <sys/dmu.h>
34 #include <sys/dmu_impl.h>
35 #include <sys/dmu_objset.h>
36 #include <sys/dmu_send.h>
37 #include <sys/dmu_tx.h>
38 #include <sys/dsl_bookmark.h>
39 #include <sys/dsl_crypt.h>
40 #include <sys/dsl_dataset.h>
41 #include <sys/dsl_deleg.h>
42 #include <sys/dsl_destroy.h>
43 #include <sys/dsl_dir.h>
44 #include <sys/dsl_prop.h>
45 #include <sys/dsl_scan.h>
46 #include <sys/dsl_userhold.h>
47 #include <sys/errno.h>
48 #include <sys/eventhandler.h>
49 #include <sys/file.h>
50 #include <sys/fm/util.h>
51 #include <sys/fs/zfs.h>
52 #include <sys/kernel.h>
53 #include <sys/kmem.h>
54 #include <sys/lock.h>
55 #include <sys/malloc.h>
56 #include <sys/mount.h>
57 #include <sys/mutex.h>
58 #include <sys/nvpair.h>
59 #include <sys/policy.h>
60 #include <sys/proc.h>
61 #include <sys/sdt.h>
62 #include <sys/spa.h>
63 #include <sys/spa_impl.h>
64 #include <sys/stat.h>
65 #include <sys/sunddi.h>
66 #include <sys/sysctl.h>
67 #include <sys/systm.h>
68 #include <sys/taskqueue.h>
69 #include <sys/uio.h>
70 #include <sys/vdev.h>
71 #include <sys/vdev_removal.h>
72 #include <sys/zap.h>
73 #include <sys/zcp.h>
74 #include <sys/zfeature.h>
75 #include <sys/zfs_context.h>
76 #include <sys/zfs_ctldir.h>
77 #include <sys/zfs_dir.h>
78 #include <sys/zfs_ioctl.h>
79 #include <sys/zfs_ioctl_compat.h>
80 #include <sys/zfs_ioctl_impl.h>
81 #include <sys/zfs_onexit.h>
82 #include <sys/zfs_vfsops.h>
83 #include <sys/zfs_znode.h>
84 #include <sys/zio_checksum.h>
85 #include <sys/zone.h>
86 #include <sys/zvol.h>
87
88 #include "zfs_comutil.h"
89 #include "zfs_deleg.h"
90 #include "zfs_namecheck.h"
91 #include "zfs_prop.h"
92
93 SYSCTL_DECL(_vfs_zfs);
94 SYSCTL_DECL(_vfs_zfs_vdev);
95
96 extern uint_t rrw_tsd_key;
97 static int zfs_version_ioctl = ZFS_IOCVER_OZFS;
98 SYSCTL_DECL(_vfs_zfs_version);
99 SYSCTL_INT(_vfs_zfs_version, OID_AUTO, ioctl, CTLFLAG_RD, &zfs_version_ioctl,
100 0, "ZFS_IOCTL_VERSION");
101
102 static struct cdev *zfsdev;
103
104 static struct root_hold_token *zfs_root_token;
105
106 extern uint_t rrw_tsd_key;
107 extern uint_t zfs_allow_log_key;
108 extern uint_t zfs_geom_probe_vdev_key;
109
110 static int zfs__init(void);
111 static int zfs__fini(void);
112 static void zfs_shutdown(void *, int);
113
114 static eventhandler_tag zfs_shutdown_event_tag;
115 static eventhandler_tag zfs_mountroot_event_tag;
116
117 #define ZFS_MIN_KSTACK_PAGES 4
118
119 static int
zfsdev_ioctl(struct cdev * dev,ulong_t zcmd,caddr_t arg,int flag,struct thread * td)120 zfsdev_ioctl(struct cdev *dev, ulong_t zcmd, caddr_t arg, int flag,
121 struct thread *td)
122 {
123 uint_t len;
124 int vecnum;
125 zfs_iocparm_t *zp;
126 zfs_cmd_t *zc;
127 #ifdef ZFS_LEGACY_SUPPORT
128 zfs_cmd_legacy_t *zcl;
129 #endif
130 int rc, error;
131 void *uaddr;
132
133 len = IOCPARM_LEN(zcmd);
134 vecnum = zcmd & 0xff;
135 zp = (void *)arg;
136 error = 0;
137 #ifdef ZFS_LEGACY_SUPPORT
138 zcl = NULL;
139 #endif
140
141 if (len != sizeof (zfs_iocparm_t))
142 return (EINVAL);
143
144 uaddr = (void *)(uintptr_t)zp->zfs_cmd;
145 zc = vmem_zalloc(sizeof (zfs_cmd_t), KM_SLEEP);
146 #ifdef ZFS_LEGACY_SUPPORT
147 /*
148 * Remap ioctl code for legacy user binaries
149 */
150 if (zp->zfs_ioctl_version == ZFS_IOCVER_LEGACY) {
151 vecnum = zfs_ioctl_legacy_to_ozfs(vecnum);
152 if (vecnum < 0) {
153 vmem_free(zc, sizeof (zfs_cmd_t));
154 return (ENOTSUP);
155 }
156 zcl = vmem_zalloc(sizeof (zfs_cmd_legacy_t), KM_SLEEP);
157 if (copyin(uaddr, zcl, sizeof (zfs_cmd_legacy_t))) {
158 error = SET_ERROR(EFAULT);
159 goto out;
160 }
161 zfs_cmd_legacy_to_ozfs(zcl, zc);
162 } else
163 #endif
164 if (copyin(uaddr, zc, sizeof (zfs_cmd_t))) {
165 error = SET_ERROR(EFAULT);
166 goto out;
167 }
168 error = zfsdev_ioctl_common(vecnum, zc, 0);
169 #ifdef ZFS_LEGACY_SUPPORT
170 if (zcl) {
171 zfs_cmd_ozfs_to_legacy(zc, zcl);
172 rc = copyout(zcl, uaddr, sizeof (*zcl));
173 } else
174 #endif
175 {
176 rc = copyout(zc, uaddr, sizeof (*zc));
177 }
178 if (error == 0 && rc != 0)
179 error = SET_ERROR(EFAULT);
180 out:
181 #ifdef ZFS_LEGACY_SUPPORT
182 if (zcl)
183 vmem_free(zcl, sizeof (zfs_cmd_legacy_t));
184 #endif
185 vmem_free(zc, sizeof (zfs_cmd_t));
186 MPASS(tsd_get(rrw_tsd_key) == NULL);
187 return (error);
188 }
189
190 static void
zfsdev_close(void * data)191 zfsdev_close(void *data)
192 {
193 zfsdev_state_destroy(data);
194 }
195
196 void
zfsdev_private_set_state(void * priv __unused,zfsdev_state_t * zs)197 zfsdev_private_set_state(void *priv __unused, zfsdev_state_t *zs)
198 {
199 devfs_set_cdevpriv(zs, zfsdev_close);
200 }
201
202 zfsdev_state_t *
zfsdev_private_get_state(void * priv)203 zfsdev_private_get_state(void *priv)
204 {
205 return (priv);
206 }
207
208 static int
zfsdev_open(struct cdev * devp __unused,int flag __unused,int mode __unused,struct thread * td __unused)209 zfsdev_open(struct cdev *devp __unused, int flag __unused, int mode __unused,
210 struct thread *td __unused)
211 {
212 int error;
213
214 mutex_enter(&zfsdev_state_lock);
215 error = zfsdev_state_init(NULL);
216 mutex_exit(&zfsdev_state_lock);
217
218 return (error);
219 }
220
221 static struct cdevsw zfs_cdevsw = {
222 .d_version = D_VERSION,
223 .d_open = zfsdev_open,
224 .d_ioctl = zfsdev_ioctl,
225 .d_name = ZFS_DRIVER
226 };
227
228 int
zfsdev_attach(void)229 zfsdev_attach(void)
230 {
231 struct make_dev_args args;
232
233 make_dev_args_init(&args);
234 args.mda_flags = MAKEDEV_CHECKNAME | MAKEDEV_WAITOK;
235 args.mda_devsw = &zfs_cdevsw;
236 args.mda_cr = NULL;
237 args.mda_uid = UID_ROOT;
238 args.mda_gid = GID_OPERATOR;
239 args.mda_mode = 0666;
240 return (make_dev_s(&args, &zfsdev, ZFS_DRIVER));
241 }
242
243 void
zfsdev_detach(void)244 zfsdev_detach(void)
245 {
246 if (zfsdev != NULL)
247 destroy_dev(zfsdev);
248 }
249
250 int
zfs__init(void)251 zfs__init(void)
252 {
253 int error;
254
255 #if KSTACK_PAGES < ZFS_MIN_KSTACK_PAGES
256 printf("ZFS NOTICE: KSTACK_PAGES is %d which could result in stack "
257 "overflow panic!\nPlease consider adding "
258 "'options KSTACK_PAGES=%d' to your kernel config\n", KSTACK_PAGES,
259 ZFS_MIN_KSTACK_PAGES);
260 #endif
261 zfs_root_token = root_mount_hold("ZFS");
262 if ((error = zfs_kmod_init()) != 0) {
263 printf("ZFS: Failed to Load ZFS Filesystem"
264 ", rc = %d\n", error);
265 root_mount_rel(zfs_root_token);
266 return (error);
267 }
268
269
270 tsd_create(&zfs_geom_probe_vdev_key, NULL);
271
272 printf("ZFS storage pool version: features support ("
273 SPA_VERSION_STRING ")\n");
274 root_mount_rel(zfs_root_token);
275 ddi_sysevent_init();
276 return (0);
277 }
278
279 int
zfs__fini(void)280 zfs__fini(void)
281 {
282 if (zfs_busy() || zvol_busy() ||
283 zio_injection_enabled) {
284 return (EBUSY);
285 }
286 zfs_kmod_fini();
287 tsd_destroy(&zfs_geom_probe_vdev_key);
288 return (0);
289 }
290
291 static void
zfs_shutdown(void * arg __unused,int howto __unused)292 zfs_shutdown(void *arg __unused, int howto __unused)
293 {
294
295 /*
296 * ZFS fini routines can not properly work in a panic-ed system.
297 */
298 if (panicstr == NULL)
299 zfs__fini();
300 }
301
302 static int
zfs_modevent(module_t mod,int type,void * unused __unused)303 zfs_modevent(module_t mod, int type, void *unused __unused)
304 {
305 int err;
306
307 switch (type) {
308 case MOD_LOAD:
309 err = zfs__init();
310 if (err == 0) {
311 zfs_shutdown_event_tag = EVENTHANDLER_REGISTER(
312 shutdown_post_sync, zfs_shutdown, NULL,
313 SHUTDOWN_PRI_FIRST);
314 zfs_mountroot_event_tag = EVENTHANDLER_REGISTER(
315 mountroot, spa_boot_init, NULL,
316 SI_ORDER_ANY);
317 }
318 return (err);
319 case MOD_UNLOAD:
320 err = zfs__fini();
321 if (err == 0) {
322 if (zfs_shutdown_event_tag != NULL)
323 EVENTHANDLER_DEREGISTER(shutdown_post_sync,
324 zfs_shutdown_event_tag);
325 if (zfs_mountroot_event_tag != NULL)
326 EVENTHANDLER_DEREGISTER(mountroot,
327 zfs_mountroot_event_tag);
328 }
329 return (err);
330 case MOD_SHUTDOWN:
331 return (0);
332 default:
333 break;
334 }
335 return (EOPNOTSUPP);
336 }
337
338 static moduledata_t zfs_mod = {
339 "zfsctrl",
340 zfs_modevent,
341 0
342 };
343
344
345 FEATURE(zfs, "OpenZFS support");
346
347 DECLARE_MODULE(zfsctrl, zfs_mod, SI_SUB_CLOCKS, SI_ORDER_ANY);
348 MODULE_VERSION(zfsctrl, 1);
349 MODULE_DEPEND(zfsctrl, xdr, 1, 1, 1);
350 MODULE_DEPEND(zfsctrl, acl_nfs4, 1, 1, 1);
351 MODULE_DEPEND(zfsctrl, crypto, 1, 1, 1);
352 MODULE_DEPEND(zfsctrl, zlib, 1, 1, 1);
353