Add the ability to uninitialize
[zfs.git] / module / zfs / zfs_ioctl.c
blobefaf6f9b390a21947c258482b48e2bf8a39781d7
1 /*
2 * CDDL HEADER START
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or https://opensource.org/licenses/CDDL-1.0.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
19 * CDDL HEADER END
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Portions Copyright 2011 Martin Matuska
25 * Copyright 2015, OmniTI Computer Consulting, Inc. All rights reserved.
26 * Copyright (c) 2012 Pawel Jakub Dawidek
27 * Copyright (c) 2014, 2016 Joyent, Inc. All rights reserved.
28 * Copyright 2016 Nexenta Systems, Inc. All rights reserved.
29 * Copyright (c) 2014, Joyent, Inc. All rights reserved.
30 * Copyright (c) 2011, 2020 by Delphix. All rights reserved.
31 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
32 * Copyright (c) 2013 Steven Hartland. All rights reserved.
33 * Copyright (c) 2014 Integros [integros.com]
34 * Copyright 2016 Toomas Soome <tsoome@me.com>
35 * Copyright (c) 2016 Actifio, Inc. All rights reserved.
36 * Copyright (c) 2018, loli10K <ezomori.nozomu@gmail.com>. All rights reserved.
37 * Copyright 2017 RackTop Systems.
38 * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
39 * Copyright (c) 2019 Datto Inc.
40 * Copyright (c) 2019, 2020 by Christian Schwarz. All rights reserved.
41 * Copyright (c) 2019, 2021, Klara Inc.
42 * Copyright (c) 2019, Allan Jude
46 * ZFS ioctls.
48 * This file handles the ioctls to /dev/zfs, used for configuring ZFS storage
49 * pools and filesystems, e.g. with /sbin/zfs and /sbin/zpool.
51 * There are two ways that we handle ioctls: the legacy way where almost
52 * all of the logic is in the ioctl callback, and the new way where most
53 * of the marshalling is handled in the common entry point, zfsdev_ioctl().
55 * Non-legacy ioctls should be registered by calling
56 * zfs_ioctl_register() from zfs_ioctl_init(). The ioctl is invoked
57 * from userland by lzc_ioctl().
59 * The registration arguments are as follows:
61 * const char *name
62 * The name of the ioctl. This is used for history logging. If the
63 * ioctl returns successfully (the callback returns 0), and allow_log
64 * is true, then a history log entry will be recorded with the input &
65 * output nvlists. The log entry can be printed with "zpool history -i".
67 * zfs_ioc_t ioc
68 * The ioctl request number, which userland will pass to ioctl(2).
69 * We want newer versions of libzfs and libzfs_core to run against
70 * existing zfs kernel modules (i.e. a deferred reboot after an update).
71 * Therefore the ioctl numbers cannot change from release to release.
73 * zfs_secpolicy_func_t *secpolicy
74 * This function will be called before the zfs_ioc_func_t, to
75 * determine if this operation is permitted. It should return EPERM
76 * on failure, and 0 on success. Checks include determining if the
77 * dataset is visible in this zone, and if the user has either all
78 * zfs privileges in the zone (SYS_MOUNT), or has been granted permission
79 * to do this operation on this dataset with "zfs allow".
81 * zfs_ioc_namecheck_t namecheck
82 * This specifies what to expect in the zfs_cmd_t:zc_name -- a pool
83 * name, a dataset name, or nothing. If the name is not well-formed,
84 * the ioctl will fail and the callback will not be called.
85 * Therefore, the callback can assume that the name is well-formed
86 * (e.g. is null-terminated, doesn't have more than one '@' character,
87 * doesn't have invalid characters).
89 * zfs_ioc_poolcheck_t pool_check
90 * This specifies requirements on the pool state. If the pool does
91 * not meet them (is suspended or is readonly), the ioctl will fail
92 * and the callback will not be called. If any checks are specified
93 * (i.e. it is not POOL_CHECK_NONE), namecheck must not be NO_NAME.
94 * Multiple checks can be or-ed together (e.g. POOL_CHECK_SUSPENDED |
95 * POOL_CHECK_READONLY).
97 * zfs_ioc_key_t *nvl_keys
98 * The list of expected/allowable innvl input keys. This list is used
99 * to validate the nvlist input to the ioctl.
101 * boolean_t smush_outnvlist
102 * If smush_outnvlist is true, then the output is presumed to be a
103 * list of errors, and it will be "smushed" down to fit into the
104 * caller's buffer, by removing some entries and replacing them with a
105 * single "N_MORE_ERRORS" entry indicating how many were removed. See
106 * nvlist_smush() for details. If smush_outnvlist is false, and the
107 * outnvlist does not fit into the userland-provided buffer, then the
108 * ioctl will fail with ENOMEM.
110 * zfs_ioc_func_t *func
111 * The callback function that will perform the operation.
113 * The callback should return 0 on success, or an error number on
114 * failure. If the function fails, the userland ioctl will return -1,
115 * and errno will be set to the callback's return value. The callback
116 * will be called with the following arguments:
118 * const char *name
119 * The name of the pool or dataset to operate on, from
120 * zfs_cmd_t:zc_name. The 'namecheck' argument specifies the
121 * expected type (pool, dataset, or none).
123 * nvlist_t *innvl
124 * The input nvlist, deserialized from zfs_cmd_t:zc_nvlist_src. Or
125 * NULL if no input nvlist was provided. Changes to this nvlist are
126 * ignored. If the input nvlist could not be deserialized, the
127 * ioctl will fail and the callback will not be called.
129 * nvlist_t *outnvl
130 * The output nvlist, initially empty. The callback can fill it in,
131 * and it will be returned to userland by serializing it into
132 * zfs_cmd_t:zc_nvlist_dst. If it is non-empty, and serialization
133 * fails (e.g. because the caller didn't supply a large enough
134 * buffer), then the overall ioctl will fail. See the
135 * 'smush_nvlist' argument above for additional behaviors.
137 * There are two typical uses of the output nvlist:
138 * - To return state, e.g. property values. In this case,
139 * smush_outnvlist should be false. If the buffer was not large
140 * enough, the caller will reallocate a larger buffer and try
141 * the ioctl again.
143 * - To return multiple errors from an ioctl which makes on-disk
144 * changes. In this case, smush_outnvlist should be true.
145 * Ioctls which make on-disk modifications should generally not
146 * use the outnvl if they succeed, because the caller can not
147 * distinguish between the operation failing, and
148 * deserialization failing.
150 * IOCTL Interface Errors
152 * The following ioctl input errors can be returned:
153 * ZFS_ERR_IOC_CMD_UNAVAIL the ioctl number is not supported by kernel
154 * ZFS_ERR_IOC_ARG_UNAVAIL an input argument is not supported by kernel
155 * ZFS_ERR_IOC_ARG_REQUIRED a required input argument is missing
156 * ZFS_ERR_IOC_ARG_BADTYPE an input argument has an invalid type
159 #include <sys/types.h>
160 #include <sys/param.h>
161 #include <sys/errno.h>
162 #include <sys/uio_impl.h>
163 #include <sys/file.h>
164 #include <sys/kmem.h>
165 #include <sys/cmn_err.h>
166 #include <sys/stat.h>
167 #include <sys/zfs_ioctl.h>
168 #include <sys/zfs_quota.h>
169 #include <sys/zfs_vfsops.h>
170 #include <sys/zfs_znode.h>
171 #include <sys/zap.h>
172 #include <sys/spa.h>
173 #include <sys/spa_impl.h>
174 #include <sys/vdev.h>
175 #include <sys/vdev_impl.h>
176 #include <sys/dmu.h>
177 #include <sys/dsl_dir.h>
178 #include <sys/dsl_dataset.h>
179 #include <sys/dsl_prop.h>
180 #include <sys/dsl_deleg.h>
181 #include <sys/dmu_objset.h>
182 #include <sys/dmu_impl.h>
183 #include <sys/dmu_redact.h>
184 #include <sys/dmu_tx.h>
185 #include <sys/sunddi.h>
186 #include <sys/policy.h>
187 #include <sys/zone.h>
188 #include <sys/nvpair.h>
189 #include <sys/pathname.h>
190 #include <sys/fs/zfs.h>
191 #include <sys/zfs_ctldir.h>
192 #include <sys/zfs_dir.h>
193 #include <sys/zfs_onexit.h>
194 #include <sys/zvol.h>
195 #include <sys/dsl_scan.h>
196 #include <sys/fm/util.h>
197 #include <sys/dsl_crypt.h>
198 #include <sys/rrwlock.h>
199 #include <sys/zfs_file.h>
201 #include <sys/dmu_recv.h>
202 #include <sys/dmu_send.h>
203 #include <sys/dmu_recv.h>
204 #include <sys/dsl_destroy.h>
205 #include <sys/dsl_bookmark.h>
206 #include <sys/dsl_userhold.h>
207 #include <sys/zfeature.h>
208 #include <sys/zcp.h>
209 #include <sys/zio_checksum.h>
210 #include <sys/vdev_removal.h>
211 #include <sys/vdev_impl.h>
212 #include <sys/vdev_initialize.h>
213 #include <sys/vdev_trim.h>
215 #include "zfs_namecheck.h"
216 #include "zfs_prop.h"
217 #include "zfs_deleg.h"
218 #include "zfs_comutil.h"
220 #include <sys/lua/lua.h>
221 #include <sys/lua/lauxlib.h>
222 #include <sys/zfs_ioctl_impl.h>
224 kmutex_t zfsdev_state_lock;
225 static zfsdev_state_t zfsdev_state_listhead;
228 * Limit maximum nvlist size. We don't want users passing in insane values
229 * for zc->zc_nvlist_src_size, since we will need to allocate that much memory.
230 * Defaults to 0=auto which is handled by platform code.
232 uint64_t zfs_max_nvlist_src_size = 0;
235 * When logging the output nvlist of an ioctl in the on-disk history, limit
236 * the logged size to this many bytes. This must be less than DMU_MAX_ACCESS.
237 * This applies primarily to zfs_ioc_channel_program().
239 static uint64_t zfs_history_output_max = 1024 * 1024;
241 uint_t zfs_fsyncer_key;
242 uint_t zfs_allow_log_key;
244 /* DATA_TYPE_ANY is used when zkey_type can vary. */
245 #define DATA_TYPE_ANY DATA_TYPE_UNKNOWN
247 typedef struct zfs_ioc_vec {
248 zfs_ioc_legacy_func_t *zvec_legacy_func;
249 zfs_ioc_func_t *zvec_func;
250 zfs_secpolicy_func_t *zvec_secpolicy;
251 zfs_ioc_namecheck_t zvec_namecheck;
252 boolean_t zvec_allow_log;
253 zfs_ioc_poolcheck_t zvec_pool_check;
254 boolean_t zvec_smush_outnvlist;
255 const char *zvec_name;
256 const zfs_ioc_key_t *zvec_nvl_keys;
257 size_t zvec_nvl_key_count;
258 } zfs_ioc_vec_t;
260 /* This array is indexed by zfs_userquota_prop_t */
261 static const char *userquota_perms[] = {
262 ZFS_DELEG_PERM_USERUSED,
263 ZFS_DELEG_PERM_USERQUOTA,
264 ZFS_DELEG_PERM_GROUPUSED,
265 ZFS_DELEG_PERM_GROUPQUOTA,
266 ZFS_DELEG_PERM_USEROBJUSED,
267 ZFS_DELEG_PERM_USEROBJQUOTA,
268 ZFS_DELEG_PERM_GROUPOBJUSED,
269 ZFS_DELEG_PERM_GROUPOBJQUOTA,
270 ZFS_DELEG_PERM_PROJECTUSED,
271 ZFS_DELEG_PERM_PROJECTQUOTA,
272 ZFS_DELEG_PERM_PROJECTOBJUSED,
273 ZFS_DELEG_PERM_PROJECTOBJQUOTA,
276 static int zfs_ioc_userspace_upgrade(zfs_cmd_t *zc);
277 static int zfs_ioc_id_quota_upgrade(zfs_cmd_t *zc);
278 static int zfs_check_settable(const char *name, nvpair_t *property,
279 cred_t *cr);
280 static int zfs_check_clearable(const char *dataset, nvlist_t *props,
281 nvlist_t **errors);
282 static int zfs_fill_zplprops_root(uint64_t, nvlist_t *, nvlist_t *,
283 boolean_t *);
284 int zfs_set_prop_nvlist(const char *, zprop_source_t, nvlist_t *, nvlist_t *);
285 static int get_nvlist(uint64_t nvl, uint64_t size, int iflag, nvlist_t **nvp);
287 static void
288 history_str_free(char *buf)
290 kmem_free(buf, HIS_MAX_RECORD_LEN);
293 static char *
294 history_str_get(zfs_cmd_t *zc)
296 char *buf;
298 if (zc->zc_history == 0)
299 return (NULL);
301 buf = kmem_alloc(HIS_MAX_RECORD_LEN, KM_SLEEP);
302 if (copyinstr((void *)(uintptr_t)zc->zc_history,
303 buf, HIS_MAX_RECORD_LEN, NULL) != 0) {
304 history_str_free(buf);
305 return (NULL);
308 buf[HIS_MAX_RECORD_LEN -1] = '\0';
310 return (buf);
314 * Return non-zero if the spa version is less than requested version.
316 static int
317 zfs_earlier_version(const char *name, int version)
319 spa_t *spa;
321 if (spa_open(name, &spa, FTAG) == 0) {
322 if (spa_version(spa) < version) {
323 spa_close(spa, FTAG);
324 return (1);
326 spa_close(spa, FTAG);
328 return (0);
332 * Return TRUE if the ZPL version is less than requested version.
334 static boolean_t
335 zpl_earlier_version(const char *name, int version)
337 objset_t *os;
338 boolean_t rc = B_TRUE;
340 if (dmu_objset_hold(name, FTAG, &os) == 0) {
341 uint64_t zplversion;
343 if (dmu_objset_type(os) != DMU_OST_ZFS) {
344 dmu_objset_rele(os, FTAG);
345 return (B_TRUE);
347 /* XXX reading from non-owned objset */
348 if (zfs_get_zplprop(os, ZFS_PROP_VERSION, &zplversion) == 0)
349 rc = zplversion < version;
350 dmu_objset_rele(os, FTAG);
352 return (rc);
355 static void
356 zfs_log_history(zfs_cmd_t *zc)
358 spa_t *spa;
359 char *buf;
361 if ((buf = history_str_get(zc)) == NULL)
362 return;
364 if (spa_open(zc->zc_name, &spa, FTAG) == 0) {
365 if (spa_version(spa) >= SPA_VERSION_ZPOOL_HISTORY)
366 (void) spa_history_log(spa, buf);
367 spa_close(spa, FTAG);
369 history_str_free(buf);
373 * Policy for top-level read operations (list pools). Requires no privileges,
374 * and can be used in the local zone, as there is no associated dataset.
376 static int
377 zfs_secpolicy_none(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
379 (void) zc, (void) innvl, (void) cr;
380 return (0);
384 * Policy for dataset read operations (list children, get statistics). Requires
385 * no privileges, but must be visible in the local zone.
387 static int
388 zfs_secpolicy_read(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
390 (void) innvl, (void) cr;
391 if (INGLOBALZONE(curproc) ||
392 zone_dataset_visible(zc->zc_name, NULL))
393 return (0);
395 return (SET_ERROR(ENOENT));
398 static int
399 zfs_dozonecheck_impl(const char *dataset, uint64_t zoned, cred_t *cr)
401 int writable = 1;
404 * The dataset must be visible by this zone -- check this first
405 * so they don't see EPERM on something they shouldn't know about.
407 if (!INGLOBALZONE(curproc) &&
408 !zone_dataset_visible(dataset, &writable))
409 return (SET_ERROR(ENOENT));
411 if (INGLOBALZONE(curproc)) {
413 * If the fs is zoned, only root can access it from the
414 * global zone.
416 if (secpolicy_zfs(cr) && zoned)
417 return (SET_ERROR(EPERM));
418 } else {
420 * If we are in a local zone, the 'zoned' property must be set.
422 if (!zoned)
423 return (SET_ERROR(EPERM));
425 /* must be writable by this zone */
426 if (!writable)
427 return (SET_ERROR(EPERM));
429 return (0);
432 static int
433 zfs_dozonecheck(const char *dataset, cred_t *cr)
435 uint64_t zoned;
437 if (dsl_prop_get_integer(dataset, zfs_prop_to_name(ZFS_PROP_ZONED),
438 &zoned, NULL))
439 return (SET_ERROR(ENOENT));
441 return (zfs_dozonecheck_impl(dataset, zoned, cr));
444 static int
445 zfs_dozonecheck_ds(const char *dataset, dsl_dataset_t *ds, cred_t *cr)
447 uint64_t zoned;
449 if (dsl_prop_get_int_ds(ds, zfs_prop_to_name(ZFS_PROP_ZONED), &zoned))
450 return (SET_ERROR(ENOENT));
452 return (zfs_dozonecheck_impl(dataset, zoned, cr));
455 static int
456 zfs_secpolicy_write_perms_ds(const char *name, dsl_dataset_t *ds,
457 const char *perm, cred_t *cr)
459 int error;
461 error = zfs_dozonecheck_ds(name, ds, cr);
462 if (error == 0) {
463 error = secpolicy_zfs(cr);
464 if (error != 0)
465 error = dsl_deleg_access_impl(ds, perm, cr);
467 return (error);
470 static int
471 zfs_secpolicy_write_perms(const char *name, const char *perm, cred_t *cr)
473 int error;
474 dsl_dataset_t *ds;
475 dsl_pool_t *dp;
478 * First do a quick check for root in the global zone, which
479 * is allowed to do all write_perms. This ensures that zfs_ioc_*
480 * will get to handle nonexistent datasets.
482 if (INGLOBALZONE(curproc) && secpolicy_zfs(cr) == 0)
483 return (0);
485 error = dsl_pool_hold(name, FTAG, &dp);
486 if (error != 0)
487 return (error);
489 error = dsl_dataset_hold(dp, name, FTAG, &ds);
490 if (error != 0) {
491 dsl_pool_rele(dp, FTAG);
492 return (error);
495 error = zfs_secpolicy_write_perms_ds(name, ds, perm, cr);
497 dsl_dataset_rele(ds, FTAG);
498 dsl_pool_rele(dp, FTAG);
499 return (error);
503 * Policy for setting the security label property.
505 * Returns 0 for success, non-zero for access and other errors.
507 static int
508 zfs_set_slabel_policy(const char *name, const char *strval, cred_t *cr)
510 #ifdef HAVE_MLSLABEL
511 char ds_hexsl[MAXNAMELEN];
512 bslabel_t ds_sl, new_sl;
513 boolean_t new_default = FALSE;
514 uint64_t zoned;
515 int needed_priv = -1;
516 int error;
518 /* First get the existing dataset label. */
519 error = dsl_prop_get(name, zfs_prop_to_name(ZFS_PROP_MLSLABEL),
520 1, sizeof (ds_hexsl), &ds_hexsl, NULL);
521 if (error != 0)
522 return (SET_ERROR(EPERM));
524 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
525 new_default = TRUE;
527 /* The label must be translatable */
528 if (!new_default && (hexstr_to_label(strval, &new_sl) != 0))
529 return (SET_ERROR(EINVAL));
532 * In a non-global zone, disallow attempts to set a label that
533 * doesn't match that of the zone; otherwise no other checks
534 * are needed.
536 if (!INGLOBALZONE(curproc)) {
537 if (new_default || !blequal(&new_sl, CR_SL(CRED())))
538 return (SET_ERROR(EPERM));
539 return (0);
543 * For global-zone datasets (i.e., those whose zoned property is
544 * "off", verify that the specified new label is valid for the
545 * global zone.
547 if (dsl_prop_get_integer(name,
548 zfs_prop_to_name(ZFS_PROP_ZONED), &zoned, NULL))
549 return (SET_ERROR(EPERM));
550 if (!zoned) {
551 if (zfs_check_global_label(name, strval) != 0)
552 return (SET_ERROR(EPERM));
556 * If the existing dataset label is nondefault, check if the
557 * dataset is mounted (label cannot be changed while mounted).
558 * Get the zfsvfs_t; if there isn't one, then the dataset isn't
559 * mounted (or isn't a dataset, doesn't exist, ...).
561 if (strcasecmp(ds_hexsl, ZFS_MLSLABEL_DEFAULT) != 0) {
562 objset_t *os;
563 static const char *setsl_tag = "setsl_tag";
566 * Try to own the dataset; abort if there is any error,
567 * (e.g., already mounted, in use, or other error).
569 error = dmu_objset_own(name, DMU_OST_ZFS, B_TRUE, B_TRUE,
570 setsl_tag, &os);
571 if (error != 0)
572 return (SET_ERROR(EPERM));
574 dmu_objset_disown(os, B_TRUE, setsl_tag);
576 if (new_default) {
577 needed_priv = PRIV_FILE_DOWNGRADE_SL;
578 goto out_check;
581 if (hexstr_to_label(strval, &new_sl) != 0)
582 return (SET_ERROR(EPERM));
584 if (blstrictdom(&ds_sl, &new_sl))
585 needed_priv = PRIV_FILE_DOWNGRADE_SL;
586 else if (blstrictdom(&new_sl, &ds_sl))
587 needed_priv = PRIV_FILE_UPGRADE_SL;
588 } else {
589 /* dataset currently has a default label */
590 if (!new_default)
591 needed_priv = PRIV_FILE_UPGRADE_SL;
594 out_check:
595 if (needed_priv != -1)
596 return (PRIV_POLICY(cr, needed_priv, B_FALSE, EPERM, NULL));
597 return (0);
598 #else
599 return (SET_ERROR(ENOTSUP));
600 #endif /* HAVE_MLSLABEL */
603 static int
604 zfs_secpolicy_setprop(const char *dsname, zfs_prop_t prop, nvpair_t *propval,
605 cred_t *cr)
607 const char *strval;
610 * Check permissions for special properties.
612 switch (prop) {
613 default:
614 break;
615 case ZFS_PROP_ZONED:
617 * Disallow setting of 'zoned' from within a local zone.
619 if (!INGLOBALZONE(curproc))
620 return (SET_ERROR(EPERM));
621 break;
623 case ZFS_PROP_QUOTA:
624 case ZFS_PROP_FILESYSTEM_LIMIT:
625 case ZFS_PROP_SNAPSHOT_LIMIT:
626 if (!INGLOBALZONE(curproc)) {
627 uint64_t zoned;
628 char setpoint[ZFS_MAX_DATASET_NAME_LEN];
630 * Unprivileged users are allowed to modify the
631 * limit on things *under* (ie. contained by)
632 * the thing they own.
634 if (dsl_prop_get_integer(dsname,
635 zfs_prop_to_name(ZFS_PROP_ZONED), &zoned, setpoint))
636 return (SET_ERROR(EPERM));
637 if (!zoned || strlen(dsname) <= strlen(setpoint))
638 return (SET_ERROR(EPERM));
640 break;
642 case ZFS_PROP_MLSLABEL:
643 if (!is_system_labeled())
644 return (SET_ERROR(EPERM));
646 if (nvpair_value_string(propval, &strval) == 0) {
647 int err;
649 err = zfs_set_slabel_policy(dsname, strval, CRED());
650 if (err != 0)
651 return (err);
653 break;
656 return (zfs_secpolicy_write_perms(dsname, zfs_prop_to_name(prop), cr));
659 static int
660 zfs_secpolicy_set_fsacl(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
663 * permission to set permissions will be evaluated later in
664 * dsl_deleg_can_allow()
666 (void) innvl;
667 return (zfs_dozonecheck(zc->zc_name, cr));
670 static int
671 zfs_secpolicy_rollback(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
673 (void) innvl;
674 return (zfs_secpolicy_write_perms(zc->zc_name,
675 ZFS_DELEG_PERM_ROLLBACK, cr));
678 static int
679 zfs_secpolicy_send(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
681 (void) innvl;
682 dsl_pool_t *dp;
683 dsl_dataset_t *ds;
684 const char *cp;
685 int error;
688 * Generate the current snapshot name from the given objsetid, then
689 * use that name for the secpolicy/zone checks.
691 cp = strchr(zc->zc_name, '@');
692 if (cp == NULL)
693 return (SET_ERROR(EINVAL));
694 error = dsl_pool_hold(zc->zc_name, FTAG, &dp);
695 if (error != 0)
696 return (error);
698 error = dsl_dataset_hold_obj(dp, zc->zc_sendobj, FTAG, &ds);
699 if (error != 0) {
700 dsl_pool_rele(dp, FTAG);
701 return (error);
704 dsl_dataset_name(ds, zc->zc_name);
706 error = zfs_secpolicy_write_perms_ds(zc->zc_name, ds,
707 ZFS_DELEG_PERM_SEND, cr);
708 dsl_dataset_rele(ds, FTAG);
709 dsl_pool_rele(dp, FTAG);
711 return (error);
714 static int
715 zfs_secpolicy_send_new(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
717 (void) innvl;
718 return (zfs_secpolicy_write_perms(zc->zc_name,
719 ZFS_DELEG_PERM_SEND, cr));
722 static int
723 zfs_secpolicy_share(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
725 (void) zc, (void) innvl, (void) cr;
726 return (SET_ERROR(ENOTSUP));
729 static int
730 zfs_secpolicy_smb_acl(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
732 (void) zc, (void) innvl, (void) cr;
733 return (SET_ERROR(ENOTSUP));
736 static int
737 zfs_get_parent(const char *datasetname, char *parent, int parentsize)
739 char *cp;
742 * Remove the @bla or /bla from the end of the name to get the parent.
744 (void) strlcpy(parent, datasetname, parentsize);
745 cp = strrchr(parent, '@');
746 if (cp != NULL) {
747 cp[0] = '\0';
748 } else {
749 cp = strrchr(parent, '/');
750 if (cp == NULL)
751 return (SET_ERROR(ENOENT));
752 cp[0] = '\0';
755 return (0);
759 zfs_secpolicy_destroy_perms(const char *name, cred_t *cr)
761 int error;
763 if ((error = zfs_secpolicy_write_perms(name,
764 ZFS_DELEG_PERM_MOUNT, cr)) != 0)
765 return (error);
767 return (zfs_secpolicy_write_perms(name, ZFS_DELEG_PERM_DESTROY, cr));
770 static int
771 zfs_secpolicy_destroy(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
773 (void) innvl;
774 return (zfs_secpolicy_destroy_perms(zc->zc_name, cr));
778 * Destroying snapshots with delegated permissions requires
779 * descendant mount and destroy permissions.
781 static int
782 zfs_secpolicy_destroy_snaps(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
784 (void) zc;
785 nvlist_t *snaps;
786 nvpair_t *pair, *nextpair;
787 int error = 0;
789 snaps = fnvlist_lookup_nvlist(innvl, "snaps");
791 for (pair = nvlist_next_nvpair(snaps, NULL); pair != NULL;
792 pair = nextpair) {
793 nextpair = nvlist_next_nvpair(snaps, pair);
794 error = zfs_secpolicy_destroy_perms(nvpair_name(pair), cr);
795 if (error == ENOENT) {
797 * Ignore any snapshots that don't exist (we consider
798 * them "already destroyed"). Remove the name from the
799 * nvl here in case the snapshot is created between
800 * now and when we try to destroy it (in which case
801 * we don't want to destroy it since we haven't
802 * checked for permission).
804 fnvlist_remove_nvpair(snaps, pair);
805 error = 0;
807 if (error != 0)
808 break;
811 return (error);
815 zfs_secpolicy_rename_perms(const char *from, const char *to, cred_t *cr)
817 char parentname[ZFS_MAX_DATASET_NAME_LEN];
818 int error;
820 if ((error = zfs_secpolicy_write_perms(from,
821 ZFS_DELEG_PERM_RENAME, cr)) != 0)
822 return (error);
824 if ((error = zfs_secpolicy_write_perms(from,
825 ZFS_DELEG_PERM_MOUNT, cr)) != 0)
826 return (error);
828 if ((error = zfs_get_parent(to, parentname,
829 sizeof (parentname))) != 0)
830 return (error);
832 if ((error = zfs_secpolicy_write_perms(parentname,
833 ZFS_DELEG_PERM_CREATE, cr)) != 0)
834 return (error);
836 if ((error = zfs_secpolicy_write_perms(parentname,
837 ZFS_DELEG_PERM_MOUNT, cr)) != 0)
838 return (error);
840 return (error);
843 static int
844 zfs_secpolicy_rename(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
846 (void) innvl;
847 return (zfs_secpolicy_rename_perms(zc->zc_name, zc->zc_value, cr));
850 static int
851 zfs_secpolicy_promote(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
853 (void) innvl;
854 dsl_pool_t *dp;
855 dsl_dataset_t *clone;
856 int error;
858 error = zfs_secpolicy_write_perms(zc->zc_name,
859 ZFS_DELEG_PERM_PROMOTE, cr);
860 if (error != 0)
861 return (error);
863 error = dsl_pool_hold(zc->zc_name, FTAG, &dp);
864 if (error != 0)
865 return (error);
867 error = dsl_dataset_hold(dp, zc->zc_name, FTAG, &clone);
869 if (error == 0) {
870 char parentname[ZFS_MAX_DATASET_NAME_LEN];
871 dsl_dataset_t *origin = NULL;
872 dsl_dir_t *dd;
873 dd = clone->ds_dir;
875 error = dsl_dataset_hold_obj(dd->dd_pool,
876 dsl_dir_phys(dd)->dd_origin_obj, FTAG, &origin);
877 if (error != 0) {
878 dsl_dataset_rele(clone, FTAG);
879 dsl_pool_rele(dp, FTAG);
880 return (error);
883 error = zfs_secpolicy_write_perms_ds(zc->zc_name, clone,
884 ZFS_DELEG_PERM_MOUNT, cr);
886 dsl_dataset_name(origin, parentname);
887 if (error == 0) {
888 error = zfs_secpolicy_write_perms_ds(parentname, origin,
889 ZFS_DELEG_PERM_PROMOTE, cr);
891 dsl_dataset_rele(clone, FTAG);
892 dsl_dataset_rele(origin, FTAG);
894 dsl_pool_rele(dp, FTAG);
895 return (error);
898 static int
899 zfs_secpolicy_recv(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
901 (void) innvl;
902 int error;
904 if ((error = zfs_secpolicy_write_perms(zc->zc_name,
905 ZFS_DELEG_PERM_RECEIVE, cr)) != 0)
906 return (error);
908 if ((error = zfs_secpolicy_write_perms(zc->zc_name,
909 ZFS_DELEG_PERM_MOUNT, cr)) != 0)
910 return (error);
912 return (zfs_secpolicy_write_perms(zc->zc_name,
913 ZFS_DELEG_PERM_CREATE, cr));
917 zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr)
919 return (zfs_secpolicy_write_perms(name,
920 ZFS_DELEG_PERM_SNAPSHOT, cr));
924 * Check for permission to create each snapshot in the nvlist.
926 static int
927 zfs_secpolicy_snapshot(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
929 (void) zc;
930 nvlist_t *snaps;
931 int error = 0;
932 nvpair_t *pair;
934 snaps = fnvlist_lookup_nvlist(innvl, "snaps");
936 for (pair = nvlist_next_nvpair(snaps, NULL); pair != NULL;
937 pair = nvlist_next_nvpair(snaps, pair)) {
938 char *name = (char *)nvpair_name(pair);
939 char *atp = strchr(name, '@');
941 if (atp == NULL) {
942 error = SET_ERROR(EINVAL);
943 break;
945 *atp = '\0';
946 error = zfs_secpolicy_snapshot_perms(name, cr);
947 *atp = '@';
948 if (error != 0)
949 break;
951 return (error);
955 * Check for permission to create each bookmark in the nvlist.
957 static int
958 zfs_secpolicy_bookmark(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
960 (void) zc;
961 int error = 0;
963 for (nvpair_t *pair = nvlist_next_nvpair(innvl, NULL);
964 pair != NULL; pair = nvlist_next_nvpair(innvl, pair)) {
965 char *name = (char *)nvpair_name(pair);
966 char *hashp = strchr(name, '#');
968 if (hashp == NULL) {
969 error = SET_ERROR(EINVAL);
970 break;
972 *hashp = '\0';
973 error = zfs_secpolicy_write_perms(name,
974 ZFS_DELEG_PERM_BOOKMARK, cr);
975 *hashp = '#';
976 if (error != 0)
977 break;
979 return (error);
982 static int
983 zfs_secpolicy_destroy_bookmarks(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
985 (void) zc;
986 nvpair_t *pair, *nextpair;
987 int error = 0;
989 for (pair = nvlist_next_nvpair(innvl, NULL); pair != NULL;
990 pair = nextpair) {
991 char *name = (char *)nvpair_name(pair);
992 char *hashp = strchr(name, '#');
993 nextpair = nvlist_next_nvpair(innvl, pair);
995 if (hashp == NULL) {
996 error = SET_ERROR(EINVAL);
997 break;
1000 *hashp = '\0';
1001 error = zfs_secpolicy_write_perms(name,
1002 ZFS_DELEG_PERM_DESTROY, cr);
1003 *hashp = '#';
1004 if (error == ENOENT) {
1006 * Ignore any filesystems that don't exist (we consider
1007 * their bookmarks "already destroyed"). Remove
1008 * the name from the nvl here in case the filesystem
1009 * is created between now and when we try to destroy
1010 * the bookmark (in which case we don't want to
1011 * destroy it since we haven't checked for permission).
1013 fnvlist_remove_nvpair(innvl, pair);
1014 error = 0;
1016 if (error != 0)
1017 break;
1020 return (error);
1023 static int
1024 zfs_secpolicy_log_history(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1026 (void) zc, (void) innvl, (void) cr;
1028 * Even root must have a proper TSD so that we know what pool
1029 * to log to.
1031 if (tsd_get(zfs_allow_log_key) == NULL)
1032 return (SET_ERROR(EPERM));
1033 return (0);
1036 static int
1037 zfs_secpolicy_create_clone(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1039 char parentname[ZFS_MAX_DATASET_NAME_LEN];
1040 int error;
1041 const char *origin;
1043 if ((error = zfs_get_parent(zc->zc_name, parentname,
1044 sizeof (parentname))) != 0)
1045 return (error);
1047 if (nvlist_lookup_string(innvl, "origin", &origin) == 0 &&
1048 (error = zfs_secpolicy_write_perms(origin,
1049 ZFS_DELEG_PERM_CLONE, cr)) != 0)
1050 return (error);
1052 if ((error = zfs_secpolicy_write_perms(parentname,
1053 ZFS_DELEG_PERM_CREATE, cr)) != 0)
1054 return (error);
1056 return (zfs_secpolicy_write_perms(parentname,
1057 ZFS_DELEG_PERM_MOUNT, cr));
1061 * Policy for pool operations - create/destroy pools, add vdevs, etc. Requires
1062 * SYS_CONFIG privilege, which is not available in a local zone.
1065 zfs_secpolicy_config(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1067 (void) zc, (void) innvl;
1069 if (secpolicy_sys_config(cr, B_FALSE) != 0)
1070 return (SET_ERROR(EPERM));
1072 return (0);
1076 * Policy for object to name lookups.
1078 static int
1079 zfs_secpolicy_diff(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1081 (void) innvl;
1082 int error;
1084 if (secpolicy_sys_config(cr, B_FALSE) == 0)
1085 return (0);
1087 error = zfs_secpolicy_write_perms(zc->zc_name, ZFS_DELEG_PERM_DIFF, cr);
1088 return (error);
1092 * Policy for fault injection. Requires all privileges.
1094 static int
1095 zfs_secpolicy_inject(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1097 (void) zc, (void) innvl;
1098 return (secpolicy_zinject(cr));
1101 static int
1102 zfs_secpolicy_inherit_prop(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1104 (void) innvl;
1105 zfs_prop_t prop = zfs_name_to_prop(zc->zc_value);
1107 if (prop == ZPROP_USERPROP) {
1108 if (!zfs_prop_user(zc->zc_value))
1109 return (SET_ERROR(EINVAL));
1110 return (zfs_secpolicy_write_perms(zc->zc_name,
1111 ZFS_DELEG_PERM_USERPROP, cr));
1112 } else {
1113 return (zfs_secpolicy_setprop(zc->zc_name, prop,
1114 NULL, cr));
1118 static int
1119 zfs_secpolicy_userspace_one(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1121 int err = zfs_secpolicy_read(zc, innvl, cr);
1122 if (err)
1123 return (err);
1125 if (zc->zc_objset_type >= ZFS_NUM_USERQUOTA_PROPS)
1126 return (SET_ERROR(EINVAL));
1128 if (zc->zc_value[0] == 0) {
1130 * They are asking about a posix uid/gid. If it's
1131 * themself, allow it.
1133 if (zc->zc_objset_type == ZFS_PROP_USERUSED ||
1134 zc->zc_objset_type == ZFS_PROP_USERQUOTA ||
1135 zc->zc_objset_type == ZFS_PROP_USEROBJUSED ||
1136 zc->zc_objset_type == ZFS_PROP_USEROBJQUOTA) {
1137 if (zc->zc_guid == crgetuid(cr))
1138 return (0);
1139 } else if (zc->zc_objset_type == ZFS_PROP_GROUPUSED ||
1140 zc->zc_objset_type == ZFS_PROP_GROUPQUOTA ||
1141 zc->zc_objset_type == ZFS_PROP_GROUPOBJUSED ||
1142 zc->zc_objset_type == ZFS_PROP_GROUPOBJQUOTA) {
1143 if (groupmember(zc->zc_guid, cr))
1144 return (0);
1146 /* else is for project quota/used */
1149 return (zfs_secpolicy_write_perms(zc->zc_name,
1150 userquota_perms[zc->zc_objset_type], cr));
1153 static int
1154 zfs_secpolicy_userspace_many(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1156 int err = zfs_secpolicy_read(zc, innvl, cr);
1157 if (err)
1158 return (err);
1160 if (zc->zc_objset_type >= ZFS_NUM_USERQUOTA_PROPS)
1161 return (SET_ERROR(EINVAL));
1163 return (zfs_secpolicy_write_perms(zc->zc_name,
1164 userquota_perms[zc->zc_objset_type], cr));
1167 static int
1168 zfs_secpolicy_userspace_upgrade(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1170 (void) innvl;
1171 return (zfs_secpolicy_setprop(zc->zc_name, ZFS_PROP_VERSION,
1172 NULL, cr));
1175 static int
1176 zfs_secpolicy_hold(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1178 (void) zc;
1179 nvpair_t *pair;
1180 nvlist_t *holds;
1181 int error;
1183 holds = fnvlist_lookup_nvlist(innvl, "holds");
1185 for (pair = nvlist_next_nvpair(holds, NULL); pair != NULL;
1186 pair = nvlist_next_nvpair(holds, pair)) {
1187 char fsname[ZFS_MAX_DATASET_NAME_LEN];
1188 error = dmu_fsname(nvpair_name(pair), fsname);
1189 if (error != 0)
1190 return (error);
1191 error = zfs_secpolicy_write_perms(fsname,
1192 ZFS_DELEG_PERM_HOLD, cr);
1193 if (error != 0)
1194 return (error);
1196 return (0);
1199 static int
1200 zfs_secpolicy_release(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1202 (void) zc;
1203 nvpair_t *pair;
1204 int error;
1206 for (pair = nvlist_next_nvpair(innvl, NULL); pair != NULL;
1207 pair = nvlist_next_nvpair(innvl, pair)) {
1208 char fsname[ZFS_MAX_DATASET_NAME_LEN];
1209 error = dmu_fsname(nvpair_name(pair), fsname);
1210 if (error != 0)
1211 return (error);
1212 error = zfs_secpolicy_write_perms(fsname,
1213 ZFS_DELEG_PERM_RELEASE, cr);
1214 if (error != 0)
1215 return (error);
1217 return (0);
1221 * Policy for allowing temporary snapshots to be taken or released
1223 static int
1224 zfs_secpolicy_tmp_snapshot(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1227 * A temporary snapshot is the same as a snapshot,
1228 * hold, destroy and release all rolled into one.
1229 * Delegated diff alone is sufficient that we allow this.
1231 int error;
1233 if (zfs_secpolicy_write_perms(zc->zc_name,
1234 ZFS_DELEG_PERM_DIFF, cr) == 0)
1235 return (0);
1237 error = zfs_secpolicy_snapshot_perms(zc->zc_name, cr);
1239 if (innvl != NULL) {
1240 if (error == 0)
1241 error = zfs_secpolicy_hold(zc, innvl, cr);
1242 if (error == 0)
1243 error = zfs_secpolicy_release(zc, innvl, cr);
1244 if (error == 0)
1245 error = zfs_secpolicy_destroy(zc, innvl, cr);
1247 return (error);
1250 static int
1251 zfs_secpolicy_load_key(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1253 return (zfs_secpolicy_write_perms(zc->zc_name,
1254 ZFS_DELEG_PERM_LOAD_KEY, cr));
1257 static int
1258 zfs_secpolicy_change_key(zfs_cmd_t *zc, nvlist_t *innvl, cred_t *cr)
1260 return (zfs_secpolicy_write_perms(zc->zc_name,
1261 ZFS_DELEG_PERM_CHANGE_KEY, cr));
1265 * Returns the nvlist as specified by the user in the zfs_cmd_t.
1267 static int
1268 get_nvlist(uint64_t nvl, uint64_t size, int iflag, nvlist_t **nvp)
1270 char *packed;
1271 int error;
1272 nvlist_t *list = NULL;
1275 * Read in and unpack the user-supplied nvlist.
1277 if (size == 0)
1278 return (SET_ERROR(EINVAL));
1280 packed = vmem_alloc(size, KM_SLEEP);
1282 if (ddi_copyin((void *)(uintptr_t)nvl, packed, size, iflag) != 0) {
1283 vmem_free(packed, size);
1284 return (SET_ERROR(EFAULT));
1287 if ((error = nvlist_unpack(packed, size, &list, 0)) != 0) {
1288 vmem_free(packed, size);
1289 return (error);
1292 vmem_free(packed, size);
1294 *nvp = list;
1295 return (0);
1299 * Reduce the size of this nvlist until it can be serialized in 'max' bytes.
1300 * Entries will be removed from the end of the nvlist, and one int32 entry
1301 * named "N_MORE_ERRORS" will be added indicating how many entries were
1302 * removed.
1304 static int
1305 nvlist_smush(nvlist_t *errors, size_t max)
1307 size_t size;
1309 size = fnvlist_size(errors);
1311 if (size > max) {
1312 nvpair_t *more_errors;
1313 int n = 0;
1315 if (max < 1024)
1316 return (SET_ERROR(ENOMEM));
1318 fnvlist_add_int32(errors, ZPROP_N_MORE_ERRORS, 0);
1319 more_errors = nvlist_prev_nvpair(errors, NULL);
1321 do {
1322 nvpair_t *pair = nvlist_prev_nvpair(errors,
1323 more_errors);
1324 fnvlist_remove_nvpair(errors, pair);
1325 n++;
1326 size = fnvlist_size(errors);
1327 } while (size > max);
1329 fnvlist_remove_nvpair(errors, more_errors);
1330 fnvlist_add_int32(errors, ZPROP_N_MORE_ERRORS, n);
1331 ASSERT3U(fnvlist_size(errors), <=, max);
1334 return (0);
1337 static int
1338 put_nvlist(zfs_cmd_t *zc, nvlist_t *nvl)
1340 char *packed = NULL;
1341 int error = 0;
1342 size_t size;
1344 size = fnvlist_size(nvl);
1346 if (size > zc->zc_nvlist_dst_size) {
1347 error = SET_ERROR(ENOMEM);
1348 } else {
1349 packed = fnvlist_pack(nvl, &size);
1350 if (ddi_copyout(packed, (void *)(uintptr_t)zc->zc_nvlist_dst,
1351 size, zc->zc_iflags) != 0)
1352 error = SET_ERROR(EFAULT);
1353 fnvlist_pack_free(packed, size);
1356 zc->zc_nvlist_dst_size = size;
1357 zc->zc_nvlist_dst_filled = B_TRUE;
1358 return (error);
1362 getzfsvfs_impl(objset_t *os, zfsvfs_t **zfvp)
1364 int error = 0;
1365 if (dmu_objset_type(os) != DMU_OST_ZFS) {
1366 return (SET_ERROR(EINVAL));
1369 mutex_enter(&os->os_user_ptr_lock);
1370 *zfvp = dmu_objset_get_user(os);
1371 /* bump s_active only when non-zero to prevent umount race */
1372 error = zfs_vfs_ref(zfvp);
1373 mutex_exit(&os->os_user_ptr_lock);
1374 return (error);
1378 getzfsvfs(const char *dsname, zfsvfs_t **zfvp)
1380 objset_t *os;
1381 int error;
1383 error = dmu_objset_hold(dsname, FTAG, &os);
1384 if (error != 0)
1385 return (error);
1387 error = getzfsvfs_impl(os, zfvp);
1388 dmu_objset_rele(os, FTAG);
1389 return (error);
1393 * Find a zfsvfs_t for a mounted filesystem, or create our own, in which
1394 * case its z_sb will be NULL, and it will be opened as the owner.
1395 * If 'writer' is set, the z_teardown_lock will be held for RW_WRITER,
1396 * which prevents all inode ops from running.
1398 static int
1399 zfsvfs_hold(const char *name, const void *tag, zfsvfs_t **zfvp,
1400 boolean_t writer)
1402 int error = 0;
1404 if (getzfsvfs(name, zfvp) != 0)
1405 error = zfsvfs_create(name, B_FALSE, zfvp);
1406 if (error == 0) {
1407 if (writer)
1408 ZFS_TEARDOWN_ENTER_WRITE(*zfvp, tag);
1409 else
1410 ZFS_TEARDOWN_ENTER_READ(*zfvp, tag);
1411 if ((*zfvp)->z_unmounted) {
1413 * XXX we could probably try again, since the unmounting
1414 * thread should be just about to disassociate the
1415 * objset from the zfsvfs.
1417 ZFS_TEARDOWN_EXIT(*zfvp, tag);
1418 return (SET_ERROR(EBUSY));
1421 return (error);
1424 static void
1425 zfsvfs_rele(zfsvfs_t *zfsvfs, const void *tag)
1427 ZFS_TEARDOWN_EXIT(zfsvfs, tag);
1429 if (zfs_vfs_held(zfsvfs)) {
1430 zfs_vfs_rele(zfsvfs);
1431 } else {
1432 dmu_objset_disown(zfsvfs->z_os, B_TRUE, zfsvfs);
1433 zfsvfs_free(zfsvfs);
1437 static int
1438 zfs_ioc_pool_create(zfs_cmd_t *zc)
1440 int error;
1441 nvlist_t *config, *props = NULL;
1442 nvlist_t *rootprops = NULL;
1443 nvlist_t *zplprops = NULL;
1444 dsl_crypto_params_t *dcp = NULL;
1445 const char *spa_name = zc->zc_name;
1446 boolean_t unload_wkey = B_TRUE;
1448 if ((error = get_nvlist(zc->zc_nvlist_conf, zc->zc_nvlist_conf_size,
1449 zc->zc_iflags, &config)))
1450 return (error);
1452 if (zc->zc_nvlist_src_size != 0 && (error =
1453 get_nvlist(zc->zc_nvlist_src, zc->zc_nvlist_src_size,
1454 zc->zc_iflags, &props))) {
1455 nvlist_free(config);
1456 return (error);
1459 if (props) {
1460 nvlist_t *nvl = NULL;
1461 nvlist_t *hidden_args = NULL;
1462 uint64_t version = SPA_VERSION;
1463 const char *tname;
1465 (void) nvlist_lookup_uint64(props,
1466 zpool_prop_to_name(ZPOOL_PROP_VERSION), &version);
1467 if (!SPA_VERSION_IS_SUPPORTED(version)) {
1468 error = SET_ERROR(EINVAL);
1469 goto pool_props_bad;
1471 (void) nvlist_lookup_nvlist(props, ZPOOL_ROOTFS_PROPS, &nvl);
1472 if (nvl) {
1473 error = nvlist_dup(nvl, &rootprops, KM_SLEEP);
1474 if (error != 0)
1475 goto pool_props_bad;
1476 (void) nvlist_remove_all(props, ZPOOL_ROOTFS_PROPS);
1479 (void) nvlist_lookup_nvlist(props, ZPOOL_HIDDEN_ARGS,
1480 &hidden_args);
1481 error = dsl_crypto_params_create_nvlist(DCP_CMD_NONE,
1482 rootprops, hidden_args, &dcp);
1483 if (error != 0)
1484 goto pool_props_bad;
1485 (void) nvlist_remove_all(props, ZPOOL_HIDDEN_ARGS);
1487 VERIFY(nvlist_alloc(&zplprops, NV_UNIQUE_NAME, KM_SLEEP) == 0);
1488 error = zfs_fill_zplprops_root(version, rootprops,
1489 zplprops, NULL);
1490 if (error != 0)
1491 goto pool_props_bad;
1493 if (nvlist_lookup_string(props,
1494 zpool_prop_to_name(ZPOOL_PROP_TNAME), &tname) == 0)
1495 spa_name = tname;
1498 error = spa_create(zc->zc_name, config, props, zplprops, dcp);
1501 * Set the remaining root properties
1503 if (!error && (error = zfs_set_prop_nvlist(spa_name,
1504 ZPROP_SRC_LOCAL, rootprops, NULL)) != 0) {
1505 (void) spa_destroy(spa_name);
1506 unload_wkey = B_FALSE; /* spa_destroy() unloads wrapping keys */
1509 pool_props_bad:
1510 nvlist_free(rootprops);
1511 nvlist_free(zplprops);
1512 nvlist_free(config);
1513 nvlist_free(props);
1514 dsl_crypto_params_free(dcp, unload_wkey && !!error);
1516 return (error);
1519 static int
1520 zfs_ioc_pool_destroy(zfs_cmd_t *zc)
1522 int error;
1523 zfs_log_history(zc);
1524 error = spa_destroy(zc->zc_name);
1526 return (error);
1529 static int
1530 zfs_ioc_pool_import(zfs_cmd_t *zc)
1532 nvlist_t *config, *props = NULL;
1533 uint64_t guid;
1534 int error;
1536 if ((error = get_nvlist(zc->zc_nvlist_conf, zc->zc_nvlist_conf_size,
1537 zc->zc_iflags, &config)) != 0)
1538 return (error);
1540 if (zc->zc_nvlist_src_size != 0 && (error =
1541 get_nvlist(zc->zc_nvlist_src, zc->zc_nvlist_src_size,
1542 zc->zc_iflags, &props))) {
1543 nvlist_free(config);
1544 return (error);
1547 if (nvlist_lookup_uint64(config, ZPOOL_CONFIG_POOL_GUID, &guid) != 0 ||
1548 guid != zc->zc_guid)
1549 error = SET_ERROR(EINVAL);
1550 else
1551 error = spa_import(zc->zc_name, config, props, zc->zc_cookie);
1553 if (zc->zc_nvlist_dst != 0) {
1554 int err;
1556 if ((err = put_nvlist(zc, config)) != 0)
1557 error = err;
1560 nvlist_free(config);
1561 nvlist_free(props);
1563 return (error);
1566 static int
1567 zfs_ioc_pool_export(zfs_cmd_t *zc)
1569 int error;
1570 boolean_t force = (boolean_t)zc->zc_cookie;
1571 boolean_t hardforce = (boolean_t)zc->zc_guid;
1573 zfs_log_history(zc);
1574 error = spa_export(zc->zc_name, NULL, force, hardforce);
1576 return (error);
1579 static int
1580 zfs_ioc_pool_configs(zfs_cmd_t *zc)
1582 nvlist_t *configs;
1583 int error;
1585 if ((configs = spa_all_configs(&zc->zc_cookie)) == NULL)
1586 return (SET_ERROR(EEXIST));
1588 error = put_nvlist(zc, configs);
1590 nvlist_free(configs);
1592 return (error);
1596 * inputs:
1597 * zc_name name of the pool
1599 * outputs:
1600 * zc_cookie real errno
1601 * zc_nvlist_dst config nvlist
1602 * zc_nvlist_dst_size size of config nvlist
1604 static int
1605 zfs_ioc_pool_stats(zfs_cmd_t *zc)
1607 nvlist_t *config;
1608 int error;
1609 int ret = 0;
1611 error = spa_get_stats(zc->zc_name, &config, zc->zc_value,
1612 sizeof (zc->zc_value));
1614 if (config != NULL) {
1615 ret = put_nvlist(zc, config);
1616 nvlist_free(config);
1619 * The config may be present even if 'error' is non-zero.
1620 * In this case we return success, and preserve the real errno
1621 * in 'zc_cookie'.
1623 zc->zc_cookie = error;
1624 } else {
1625 ret = error;
1628 return (ret);
1632 * Try to import the given pool, returning pool stats as appropriate so that
1633 * user land knows which devices are available and overall pool health.
1635 static int
1636 zfs_ioc_pool_tryimport(zfs_cmd_t *zc)
1638 nvlist_t *tryconfig, *config = NULL;
1639 int error;
1641 if ((error = get_nvlist(zc->zc_nvlist_conf, zc->zc_nvlist_conf_size,
1642 zc->zc_iflags, &tryconfig)) != 0)
1643 return (error);
1645 config = spa_tryimport(tryconfig);
1647 nvlist_free(tryconfig);
1649 if (config == NULL)
1650 return (SET_ERROR(EINVAL));
1652 error = put_nvlist(zc, config);
1653 nvlist_free(config);
1655 return (error);
1659 * inputs:
1660 * zc_name name of the pool
1661 * zc_cookie scan func (pool_scan_func_t)
1662 * zc_flags scrub pause/resume flag (pool_scrub_cmd_t)
1664 static int
1665 zfs_ioc_pool_scan(zfs_cmd_t *zc)
1667 spa_t *spa;
1668 int error;
1670 if (zc->zc_flags >= POOL_SCRUB_FLAGS_END)
1671 return (SET_ERROR(EINVAL));
1673 if ((error = spa_open(zc->zc_name, &spa, FTAG)) != 0)
1674 return (error);
1676 if (zc->zc_flags == POOL_SCRUB_PAUSE)
1677 error = spa_scrub_pause_resume(spa, POOL_SCRUB_PAUSE);
1678 else if (zc->zc_cookie == POOL_SCAN_NONE)
1679 error = spa_scan_stop(spa);
1680 else
1681 error = spa_scan(spa, zc->zc_cookie);
1683 spa_close(spa, FTAG);
1685 return (error);
1688 static int
1689 zfs_ioc_pool_freeze(zfs_cmd_t *zc)
1691 spa_t *spa;
1692 int error;
1694 error = spa_open(zc->zc_name, &spa, FTAG);
1695 if (error == 0) {
1696 spa_freeze(spa);
1697 spa_close(spa, FTAG);
1699 return (error);
1702 static int
1703 zfs_ioc_pool_upgrade(zfs_cmd_t *zc)
1705 spa_t *spa;
1706 int error;
1708 if ((error = spa_open(zc->zc_name, &spa, FTAG)) != 0)
1709 return (error);
1711 if (zc->zc_cookie < spa_version(spa) ||
1712 !SPA_VERSION_IS_SUPPORTED(zc->zc_cookie)) {
1713 spa_close(spa, FTAG);
1714 return (SET_ERROR(EINVAL));
1717 spa_upgrade(spa, zc->zc_cookie);
1718 spa_close(spa, FTAG);
1720 return (error);
1723 static int
1724 zfs_ioc_pool_get_history(zfs_cmd_t *zc)
1726 spa_t *spa;
1727 char *hist_buf;
1728 uint64_t size;
1729 int error;
1731 if ((size = zc->zc_history_len) == 0)
1732 return (SET_ERROR(EINVAL));
1734 if ((error = spa_open(zc->zc_name, &spa, FTAG)) != 0)
1735 return (error);
1737 if (spa_version(spa) < SPA_VERSION_ZPOOL_HISTORY) {
1738 spa_close(spa, FTAG);
1739 return (SET_ERROR(ENOTSUP));
1742 hist_buf = vmem_alloc(size, KM_SLEEP);
1743 if ((error = spa_history_get(spa, &zc->zc_history_offset,
1744 &zc->zc_history_len, hist_buf)) == 0) {
1745 error = ddi_copyout(hist_buf,
1746 (void *)(uintptr_t)zc->zc_history,
1747 zc->zc_history_len, zc->zc_iflags);
1750 spa_close(spa, FTAG);
1751 vmem_free(hist_buf, size);
1752 return (error);
1755 static int
1756 zfs_ioc_pool_reguid(zfs_cmd_t *zc)
1758 spa_t *spa;
1759 int error;
1761 error = spa_open(zc->zc_name, &spa, FTAG);
1762 if (error == 0) {
1763 error = spa_change_guid(spa);
1764 spa_close(spa, FTAG);
1766 return (error);
1769 static int
1770 zfs_ioc_dsobj_to_dsname(zfs_cmd_t *zc)
1772 return (dsl_dsobj_to_dsname(zc->zc_name, zc->zc_obj, zc->zc_value));
1776 * inputs:
1777 * zc_name name of filesystem
1778 * zc_obj object to find
1780 * outputs:
1781 * zc_value name of object
1783 static int
1784 zfs_ioc_obj_to_path(zfs_cmd_t *zc)
1786 objset_t *os;
1787 int error;
1789 /* XXX reading from objset not owned */
1790 if ((error = dmu_objset_hold_flags(zc->zc_name, B_TRUE,
1791 FTAG, &os)) != 0)
1792 return (error);
1793 if (dmu_objset_type(os) != DMU_OST_ZFS) {
1794 dmu_objset_rele_flags(os, B_TRUE, FTAG);
1795 return (SET_ERROR(EINVAL));
1797 error = zfs_obj_to_path(os, zc->zc_obj, zc->zc_value,
1798 sizeof (zc->zc_value));
1799 dmu_objset_rele_flags(os, B_TRUE, FTAG);
1801 return (error);
1805 * inputs:
1806 * zc_name name of filesystem
1807 * zc_obj object to find
1809 * outputs:
1810 * zc_stat stats on object
1811 * zc_value path to object
1813 static int
1814 zfs_ioc_obj_to_stats(zfs_cmd_t *zc)
1816 objset_t *os;
1817 int error;
1819 /* XXX reading from objset not owned */
1820 if ((error = dmu_objset_hold_flags(zc->zc_name, B_TRUE,
1821 FTAG, &os)) != 0)
1822 return (error);
1823 if (dmu_objset_type(os) != DMU_OST_ZFS) {
1824 dmu_objset_rele_flags(os, B_TRUE, FTAG);
1825 return (SET_ERROR(EINVAL));
1827 error = zfs_obj_to_stats(os, zc->zc_obj, &zc->zc_stat, zc->zc_value,
1828 sizeof (zc->zc_value));
1829 dmu_objset_rele_flags(os, B_TRUE, FTAG);
1831 return (error);
1834 static int
1835 zfs_ioc_vdev_add(zfs_cmd_t *zc)
1837 spa_t *spa;
1838 int error;
1839 nvlist_t *config;
1841 error = spa_open(zc->zc_name, &spa, FTAG);
1842 if (error != 0)
1843 return (error);
1845 error = get_nvlist(zc->zc_nvlist_conf, zc->zc_nvlist_conf_size,
1846 zc->zc_iflags, &config);
1847 if (error == 0) {
1848 error = spa_vdev_add(spa, config);
1849 nvlist_free(config);
1851 spa_close(spa, FTAG);
1852 return (error);
1856 * inputs:
1857 * zc_name name of the pool
1858 * zc_guid guid of vdev to remove
1859 * zc_cookie cancel removal
1861 static int
1862 zfs_ioc_vdev_remove(zfs_cmd_t *zc)
1864 spa_t *spa;
1865 int error;
1867 error = spa_open(zc->zc_name, &spa, FTAG);
1868 if (error != 0)
1869 return (error);
1870 if (zc->zc_cookie != 0) {
1871 error = spa_vdev_remove_cancel(spa);
1872 } else {
1873 error = spa_vdev_remove(spa, zc->zc_guid, B_FALSE);
1875 spa_close(spa, FTAG);
1876 return (error);
1879 static int
1880 zfs_ioc_vdev_set_state(zfs_cmd_t *zc)
1882 spa_t *spa;
1883 int error;
1884 vdev_state_t newstate = VDEV_STATE_UNKNOWN;
1886 if ((error = spa_open(zc->zc_name, &spa, FTAG)) != 0)
1887 return (error);
1888 switch (zc->zc_cookie) {
1889 case VDEV_STATE_ONLINE:
1890 error = vdev_online(spa, zc->zc_guid, zc->zc_obj, &newstate);
1891 break;
1893 case VDEV_STATE_OFFLINE:
1894 error = vdev_offline(spa, zc->zc_guid, zc->zc_obj);
1895 break;
1897 case VDEV_STATE_FAULTED:
1898 if (zc->zc_obj != VDEV_AUX_ERR_EXCEEDED &&
1899 zc->zc_obj != VDEV_AUX_EXTERNAL &&
1900 zc->zc_obj != VDEV_AUX_EXTERNAL_PERSIST)
1901 zc->zc_obj = VDEV_AUX_ERR_EXCEEDED;
1903 error = vdev_fault(spa, zc->zc_guid, zc->zc_obj);
1904 break;
1906 case VDEV_STATE_DEGRADED:
1907 if (zc->zc_obj != VDEV_AUX_ERR_EXCEEDED &&
1908 zc->zc_obj != VDEV_AUX_EXTERNAL)
1909 zc->zc_obj = VDEV_AUX_ERR_EXCEEDED;
1911 error = vdev_degrade(spa, zc->zc_guid, zc->zc_obj);
1912 break;
1914 case VDEV_STATE_REMOVED:
1915 error = vdev_remove_wanted(spa, zc->zc_guid);
1916 break;
1918 default:
1919 error = SET_ERROR(EINVAL);
1921 zc->zc_cookie = newstate;
1922 spa_close(spa, FTAG);
1923 return (error);
1926 static int
1927 zfs_ioc_vdev_attach(zfs_cmd_t *zc)
1929 spa_t *spa;
1930 nvlist_t *config;
1931 int replacing = zc->zc_cookie;
1932 int rebuild = zc->zc_simple;
1933 int error;
1935 if ((error = spa_open(zc->zc_name, &spa, FTAG)) != 0)
1936 return (error);
1938 if ((error = get_nvlist(zc->zc_nvlist_conf, zc->zc_nvlist_conf_size,
1939 zc->zc_iflags, &config)) == 0) {
1940 error = spa_vdev_attach(spa, zc->zc_guid, config, replacing,
1941 rebuild);
1942 nvlist_free(config);
1945 spa_close(spa, FTAG);
1946 return (error);
1949 static int
1950 zfs_ioc_vdev_detach(zfs_cmd_t *zc)
1952 spa_t *spa;
1953 int error;
1955 if ((error = spa_open(zc->zc_name, &spa, FTAG)) != 0)
1956 return (error);
1958 error = spa_vdev_detach(spa, zc->zc_guid, 0, B_FALSE);
1960 spa_close(spa, FTAG);
1961 return (error);
1964 static int
1965 zfs_ioc_vdev_split(zfs_cmd_t *zc)
1967 spa_t *spa;
1968 nvlist_t *config, *props = NULL;
1969 int error;
1970 boolean_t exp = !!(zc->zc_cookie & ZPOOL_EXPORT_AFTER_SPLIT);
1972 if ((error = spa_open(zc->zc_name, &spa, FTAG)) != 0)
1973 return (error);
1975 if ((error = get_nvlist(zc->zc_nvlist_conf, zc->zc_nvlist_conf_size,
1976 zc->zc_iflags, &config))) {
1977 spa_close(spa, FTAG);
1978 return (error);
1981 if (zc->zc_nvlist_src_size != 0 && (error =
1982 get_nvlist(zc->zc_nvlist_src, zc->zc_nvlist_src_size,
1983 zc->zc_iflags, &props))) {
1984 spa_close(spa, FTAG);
1985 nvlist_free(config);
1986 return (error);
1989 error = spa_vdev_split_mirror(spa, zc->zc_string, config, props, exp);
1991 spa_close(spa, FTAG);
1993 nvlist_free(config);
1994 nvlist_free(props);
1996 return (error);
1999 static int
2000 zfs_ioc_vdev_setpath(zfs_cmd_t *zc)
2002 spa_t *spa;
2003 const char *path = zc->zc_value;
2004 uint64_t guid = zc->zc_guid;
2005 int error;
2007 error = spa_open(zc->zc_name, &spa, FTAG);
2008 if (error != 0)
2009 return (error);
2011 error = spa_vdev_setpath(spa, guid, path);
2012 spa_close(spa, FTAG);
2013 return (error);
2016 static int
2017 zfs_ioc_vdev_setfru(zfs_cmd_t *zc)
2019 spa_t *spa;
2020 const char *fru = zc->zc_value;
2021 uint64_t guid = zc->zc_guid;
2022 int error;
2024 error = spa_open(zc->zc_name, &spa, FTAG);
2025 if (error != 0)
2026 return (error);
2028 error = spa_vdev_setfru(spa, guid, fru);
2029 spa_close(spa, FTAG);
2030 return (error);
2033 static int
2034 zfs_ioc_objset_stats_impl(zfs_cmd_t *zc, objset_t *os)
2036 int error = 0;
2037 nvlist_t *nv;
2039 dmu_objset_fast_stat(os, &zc->zc_objset_stats);
2041 if (!zc->zc_simple && zc->zc_nvlist_dst != 0 &&
2042 (error = dsl_prop_get_all(os, &nv)) == 0) {
2043 dmu_objset_stats(os, nv);
2045 * NB: zvol_get_stats() will read the objset contents,
2046 * which we aren't supposed to do with a
2047 * DS_MODE_USER hold, because it could be
2048 * inconsistent. So this is a bit of a workaround...
2049 * XXX reading without owning
2051 if (!zc->zc_objset_stats.dds_inconsistent &&
2052 dmu_objset_type(os) == DMU_OST_ZVOL) {
2053 error = zvol_get_stats(os, nv);
2054 if (error == EIO) {
2055 nvlist_free(nv);
2056 return (error);
2058 VERIFY0(error);
2060 if (error == 0)
2061 error = put_nvlist(zc, nv);
2062 nvlist_free(nv);
2065 return (error);
2069 * inputs:
2070 * zc_name name of filesystem
2071 * zc_nvlist_dst_size size of buffer for property nvlist
2073 * outputs:
2074 * zc_objset_stats stats
2075 * zc_nvlist_dst property nvlist
2076 * zc_nvlist_dst_size size of property nvlist
2078 static int
2079 zfs_ioc_objset_stats(zfs_cmd_t *zc)
2081 objset_t *os;
2082 int error;
2084 error = dmu_objset_hold(zc->zc_name, FTAG, &os);
2085 if (error == 0) {
2086 error = zfs_ioc_objset_stats_impl(zc, os);
2087 dmu_objset_rele(os, FTAG);
2090 return (error);
2094 * inputs:
2095 * zc_name name of filesystem
2096 * zc_nvlist_dst_size size of buffer for property nvlist
2098 * outputs:
2099 * zc_nvlist_dst received property nvlist
2100 * zc_nvlist_dst_size size of received property nvlist
2102 * Gets received properties (distinct from local properties on or after
2103 * SPA_VERSION_RECVD_PROPS) for callers who want to differentiate received from
2104 * local property values.
2106 static int
2107 zfs_ioc_objset_recvd_props(zfs_cmd_t *zc)
2109 int error = 0;
2110 nvlist_t *nv;
2113 * Without this check, we would return local property values if the
2114 * caller has not already received properties on or after
2115 * SPA_VERSION_RECVD_PROPS.
2117 if (!dsl_prop_get_hasrecvd(zc->zc_name))
2118 return (SET_ERROR(ENOTSUP));
2120 if (zc->zc_nvlist_dst != 0 &&
2121 (error = dsl_prop_get_received(zc->zc_name, &nv)) == 0) {
2122 error = put_nvlist(zc, nv);
2123 nvlist_free(nv);
2126 return (error);
2129 static int
2130 nvl_add_zplprop(objset_t *os, nvlist_t *props, zfs_prop_t prop)
2132 uint64_t value;
2133 int error;
2136 * zfs_get_zplprop() will either find a value or give us
2137 * the default value (if there is one).
2139 if ((error = zfs_get_zplprop(os, prop, &value)) != 0)
2140 return (error);
2141 VERIFY(nvlist_add_uint64(props, zfs_prop_to_name(prop), value) == 0);
2142 return (0);
2146 * inputs:
2147 * zc_name name of filesystem
2148 * zc_nvlist_dst_size size of buffer for zpl property nvlist
2150 * outputs:
2151 * zc_nvlist_dst zpl property nvlist
2152 * zc_nvlist_dst_size size of zpl property nvlist
2154 static int
2155 zfs_ioc_objset_zplprops(zfs_cmd_t *zc)
2157 objset_t *os;
2158 int err;
2160 /* XXX reading without owning */
2161 if ((err = dmu_objset_hold(zc->zc_name, FTAG, &os)))
2162 return (err);
2164 dmu_objset_fast_stat(os, &zc->zc_objset_stats);
2167 * NB: nvl_add_zplprop() will read the objset contents,
2168 * which we aren't supposed to do with a DS_MODE_USER
2169 * hold, because it could be inconsistent.
2171 if (zc->zc_nvlist_dst != 0 &&
2172 !zc->zc_objset_stats.dds_inconsistent &&
2173 dmu_objset_type(os) == DMU_OST_ZFS) {
2174 nvlist_t *nv;
2176 VERIFY(nvlist_alloc(&nv, NV_UNIQUE_NAME, KM_SLEEP) == 0);
2177 if ((err = nvl_add_zplprop(os, nv, ZFS_PROP_VERSION)) == 0 &&
2178 (err = nvl_add_zplprop(os, nv, ZFS_PROP_NORMALIZE)) == 0 &&
2179 (err = nvl_add_zplprop(os, nv, ZFS_PROP_UTF8ONLY)) == 0 &&
2180 (err = nvl_add_zplprop(os, nv, ZFS_PROP_CASE)) == 0)
2181 err = put_nvlist(zc, nv);
2182 nvlist_free(nv);
2183 } else {
2184 err = SET_ERROR(ENOENT);
2186 dmu_objset_rele(os, FTAG);
2187 return (err);
2191 * inputs:
2192 * zc_name name of filesystem
2193 * zc_cookie zap cursor
2194 * zc_nvlist_dst_size size of buffer for property nvlist
2196 * outputs:
2197 * zc_name name of next filesystem
2198 * zc_cookie zap cursor
2199 * zc_objset_stats stats
2200 * zc_nvlist_dst property nvlist
2201 * zc_nvlist_dst_size size of property nvlist
2203 static int
2204 zfs_ioc_dataset_list_next(zfs_cmd_t *zc)
2206 objset_t *os;
2207 int error;
2208 char *p;
2209 size_t orig_len = strlen(zc->zc_name);
2211 top:
2212 if ((error = dmu_objset_hold(zc->zc_name, FTAG, &os))) {
2213 if (error == ENOENT)
2214 error = SET_ERROR(ESRCH);
2215 return (error);
2218 p = strrchr(zc->zc_name, '/');
2219 if (p == NULL || p[1] != '\0')
2220 (void) strlcat(zc->zc_name, "/", sizeof (zc->zc_name));
2221 p = zc->zc_name + strlen(zc->zc_name);
2223 do {
2224 error = dmu_dir_list_next(os,
2225 sizeof (zc->zc_name) - (p - zc->zc_name), p,
2226 NULL, &zc->zc_cookie);
2227 if (error == ENOENT)
2228 error = SET_ERROR(ESRCH);
2229 } while (error == 0 && zfs_dataset_name_hidden(zc->zc_name));
2230 dmu_objset_rele(os, FTAG);
2233 * If it's an internal dataset (ie. with a '$' in its name),
2234 * don't try to get stats for it, otherwise we'll return ENOENT.
2236 if (error == 0 && strchr(zc->zc_name, '$') == NULL) {
2237 error = zfs_ioc_objset_stats(zc); /* fill in the stats */
2238 if (error == ENOENT) {
2239 /* We lost a race with destroy, get the next one. */
2240 zc->zc_name[orig_len] = '\0';
2241 goto top;
2244 return (error);
2248 * inputs:
2249 * zc_name name of filesystem
2250 * zc_cookie zap cursor
2251 * zc_nvlist_src iteration range nvlist
2252 * zc_nvlist_src_size size of iteration range nvlist
2254 * outputs:
2255 * zc_name name of next snapshot
2256 * zc_objset_stats stats
2257 * zc_nvlist_dst property nvlist
2258 * zc_nvlist_dst_size size of property nvlist
2260 static int
2261 zfs_ioc_snapshot_list_next(zfs_cmd_t *zc)
2263 int error;
2264 objset_t *os, *ossnap;
2265 dsl_dataset_t *ds;
2266 uint64_t min_txg = 0, max_txg = 0;
2268 if (zc->zc_nvlist_src_size != 0) {
2269 nvlist_t *props = NULL;
2270 error = get_nvlist(zc->zc_nvlist_src, zc->zc_nvlist_src_size,
2271 zc->zc_iflags, &props);
2272 if (error != 0)
2273 return (error);
2274 (void) nvlist_lookup_uint64(props, SNAP_ITER_MIN_TXG,
2275 &min_txg);
2276 (void) nvlist_lookup_uint64(props, SNAP_ITER_MAX_TXG,
2277 &max_txg);
2278 nvlist_free(props);
2281 error = dmu_objset_hold(zc->zc_name, FTAG, &os);
2282 if (error != 0) {
2283 return (error == ENOENT ? SET_ERROR(ESRCH) : error);
2287 * A dataset name of maximum length cannot have any snapshots,
2288 * so exit immediately.
2290 if (strlcat(zc->zc_name, "@", sizeof (zc->zc_name)) >=
2291 ZFS_MAX_DATASET_NAME_LEN) {
2292 dmu_objset_rele(os, FTAG);
2293 return (SET_ERROR(ESRCH));
2296 while (error == 0) {
2297 if (issig(JUSTLOOKING) && issig(FORREAL)) {
2298 error = SET_ERROR(EINTR);
2299 break;
2302 error = dmu_snapshot_list_next(os,
2303 sizeof (zc->zc_name) - strlen(zc->zc_name),
2304 zc->zc_name + strlen(zc->zc_name), &zc->zc_obj,
2305 &zc->zc_cookie, NULL);
2306 if (error == ENOENT) {
2307 error = SET_ERROR(ESRCH);
2308 break;
2309 } else if (error != 0) {
2310 break;
2313 error = dsl_dataset_hold_obj(dmu_objset_pool(os), zc->zc_obj,
2314 FTAG, &ds);
2315 if (error != 0)
2316 break;
2318 if ((min_txg != 0 && dsl_get_creationtxg(ds) < min_txg) ||
2319 (max_txg != 0 && dsl_get_creationtxg(ds) > max_txg)) {
2320 dsl_dataset_rele(ds, FTAG);
2321 /* undo snapshot name append */
2322 *(strchr(zc->zc_name, '@') + 1) = '\0';
2323 /* skip snapshot */
2324 continue;
2327 if (zc->zc_simple) {
2328 dsl_dataset_fast_stat(ds, &zc->zc_objset_stats);
2329 dsl_dataset_rele(ds, FTAG);
2330 break;
2333 if ((error = dmu_objset_from_ds(ds, &ossnap)) != 0) {
2334 dsl_dataset_rele(ds, FTAG);
2335 break;
2337 if ((error = zfs_ioc_objset_stats_impl(zc, ossnap)) != 0) {
2338 dsl_dataset_rele(ds, FTAG);
2339 break;
2341 dsl_dataset_rele(ds, FTAG);
2342 break;
2345 dmu_objset_rele(os, FTAG);
2346 /* if we failed, undo the @ that we tacked on to zc_name */
2347 if (error != 0)
2348 *strchr(zc->zc_name, '@') = '\0';
2349 return (error);
2352 static int
2353 zfs_prop_set_userquota(const char *dsname, nvpair_t *pair)
2355 const char *propname = nvpair_name(pair);
2356 uint64_t *valary;
2357 unsigned int vallen;
2358 const char *dash, *domain;
2359 zfs_userquota_prop_t type;
2360 uint64_t rid;
2361 uint64_t quota;
2362 zfsvfs_t *zfsvfs;
2363 int err;
2365 if (nvpair_type(pair) == DATA_TYPE_NVLIST) {
2366 nvlist_t *attrs;
2367 VERIFY(nvpair_value_nvlist(pair, &attrs) == 0);
2368 if (nvlist_lookup_nvpair(attrs, ZPROP_VALUE,
2369 &pair) != 0)
2370 return (SET_ERROR(EINVAL));
2374 * A correctly constructed propname is encoded as
2375 * userquota@<rid>-<domain>.
2377 if ((dash = strchr(propname, '-')) == NULL ||
2378 nvpair_value_uint64_array(pair, &valary, &vallen) != 0 ||
2379 vallen != 3)
2380 return (SET_ERROR(EINVAL));
2382 domain = dash + 1;
2383 type = valary[0];
2384 rid = valary[1];
2385 quota = valary[2];
2387 err = zfsvfs_hold(dsname, FTAG, &zfsvfs, B_FALSE);
2388 if (err == 0) {
2389 err = zfs_set_userquota(zfsvfs, type, domain, rid, quota);
2390 zfsvfs_rele(zfsvfs, FTAG);
2393 return (err);
2397 * If the named property is one that has a special function to set its value,
2398 * return 0 on success and a positive error code on failure; otherwise if it is
2399 * not one of the special properties handled by this function, return -1.
2401 * XXX: It would be better for callers of the property interface if we handled
2402 * these special cases in dsl_prop.c (in the dsl layer).
2404 static int
2405 zfs_prop_set_special(const char *dsname, zprop_source_t source,
2406 nvpair_t *pair)
2408 const char *propname = nvpair_name(pair);
2409 zfs_prop_t prop = zfs_name_to_prop(propname);
2410 uint64_t intval = 0;
2411 const char *strval = NULL;
2412 int err = -1;
2414 if (prop == ZPROP_USERPROP) {
2415 if (zfs_prop_userquota(propname))
2416 return (zfs_prop_set_userquota(dsname, pair));
2417 return (-1);
2420 if (nvpair_type(pair) == DATA_TYPE_NVLIST) {
2421 nvlist_t *attrs;
2422 VERIFY(nvpair_value_nvlist(pair, &attrs) == 0);
2423 VERIFY(nvlist_lookup_nvpair(attrs, ZPROP_VALUE,
2424 &pair) == 0);
2427 /* all special properties are numeric except for keylocation */
2428 if (zfs_prop_get_type(prop) == PROP_TYPE_STRING) {
2429 strval = fnvpair_value_string(pair);
2430 } else {
2431 intval = fnvpair_value_uint64(pair);
2434 switch (prop) {
2435 case ZFS_PROP_QUOTA:
2436 err = dsl_dir_set_quota(dsname, source, intval);
2437 break;
2438 case ZFS_PROP_REFQUOTA:
2439 err = dsl_dataset_set_refquota(dsname, source, intval);
2440 break;
2441 case ZFS_PROP_FILESYSTEM_LIMIT:
2442 case ZFS_PROP_SNAPSHOT_LIMIT:
2443 if (intval == UINT64_MAX) {
2444 /* clearing the limit, just do it */
2445 err = 0;
2446 } else {
2447 err = dsl_dir_activate_fs_ss_limit(dsname);
2450 * Set err to -1 to force the zfs_set_prop_nvlist code down the
2451 * default path to set the value in the nvlist.
2453 if (err == 0)
2454 err = -1;
2455 break;
2456 case ZFS_PROP_KEYLOCATION:
2457 err = dsl_crypto_can_set_keylocation(dsname, strval);
2460 * Set err to -1 to force the zfs_set_prop_nvlist code down the
2461 * default path to set the value in the nvlist.
2463 if (err == 0)
2464 err = -1;
2465 break;
2466 case ZFS_PROP_RESERVATION:
2467 err = dsl_dir_set_reservation(dsname, source, intval);
2468 break;
2469 case ZFS_PROP_REFRESERVATION:
2470 err = dsl_dataset_set_refreservation(dsname, source, intval);
2471 break;
2472 case ZFS_PROP_COMPRESSION:
2473 err = dsl_dataset_set_compression(dsname, source, intval);
2475 * Set err to -1 to force the zfs_set_prop_nvlist code down the
2476 * default path to set the value in the nvlist.
2478 if (err == 0)
2479 err = -1;
2480 break;
2481 case ZFS_PROP_VOLSIZE:
2482 err = zvol_set_volsize(dsname, intval);
2483 break;
2484 case ZFS_PROP_SNAPDEV:
2485 err = zvol_set_snapdev(dsname, source, intval);
2486 break;
2487 case ZFS_PROP_VOLMODE:
2488 err = zvol_set_volmode(dsname, source, intval);
2489 break;
2490 case ZFS_PROP_VERSION:
2492 zfsvfs_t *zfsvfs;
2494 if ((err = zfsvfs_hold(dsname, FTAG, &zfsvfs, B_TRUE)) != 0)
2495 break;
2497 err = zfs_set_version(zfsvfs, intval);
2498 zfsvfs_rele(zfsvfs, FTAG);
2500 if (err == 0 && intval >= ZPL_VERSION_USERSPACE) {
2501 zfs_cmd_t *zc;
2503 zc = kmem_zalloc(sizeof (zfs_cmd_t), KM_SLEEP);
2504 (void) strlcpy(zc->zc_name, dsname,
2505 sizeof (zc->zc_name));
2506 (void) zfs_ioc_userspace_upgrade(zc);
2507 (void) zfs_ioc_id_quota_upgrade(zc);
2508 kmem_free(zc, sizeof (zfs_cmd_t));
2510 break;
2512 default:
2513 err = -1;
2516 return (err);
2519 static boolean_t
2520 zfs_is_namespace_prop(zfs_prop_t prop)
2522 switch (prop) {
2524 case ZFS_PROP_ATIME:
2525 case ZFS_PROP_RELATIME:
2526 case ZFS_PROP_DEVICES:
2527 case ZFS_PROP_EXEC:
2528 case ZFS_PROP_SETUID:
2529 case ZFS_PROP_READONLY:
2530 case ZFS_PROP_XATTR:
2531 case ZFS_PROP_NBMAND:
2532 return (B_TRUE);
2534 default:
2535 return (B_FALSE);
2540 * This function is best effort. If it fails to set any of the given properties,
2541 * it continues to set as many as it can and returns the last error
2542 * encountered. If the caller provides a non-NULL errlist, it will be filled in
2543 * with the list of names of all the properties that failed along with the
2544 * corresponding error numbers.
2546 * If every property is set successfully, zero is returned and errlist is not
2547 * modified.
2550 zfs_set_prop_nvlist(const char *dsname, zprop_source_t source, nvlist_t *nvl,
2551 nvlist_t *errlist)
2553 nvpair_t *pair;
2554 nvpair_t *propval;
2555 int rv = 0;
2556 int err;
2557 uint64_t intval;
2558 const char *strval;
2559 boolean_t should_update_mount_cache = B_FALSE;
2561 nvlist_t *genericnvl = fnvlist_alloc();
2562 nvlist_t *retrynvl = fnvlist_alloc();
2563 retry:
2564 pair = NULL;
2565 while ((pair = nvlist_next_nvpair(nvl, pair)) != NULL) {
2566 const char *propname = nvpair_name(pair);
2567 zfs_prop_t prop = zfs_name_to_prop(propname);
2568 err = 0;
2570 /* decode the property value */
2571 propval = pair;
2572 if (nvpair_type(pair) == DATA_TYPE_NVLIST) {
2573 nvlist_t *attrs;
2574 attrs = fnvpair_value_nvlist(pair);
2575 if (nvlist_lookup_nvpair(attrs, ZPROP_VALUE,
2576 &propval) != 0)
2577 err = SET_ERROR(EINVAL);
2580 /* Validate value type */
2581 if (err == 0 && source == ZPROP_SRC_INHERITED) {
2582 /* inherited properties are expected to be booleans */
2583 if (nvpair_type(propval) != DATA_TYPE_BOOLEAN)
2584 err = SET_ERROR(EINVAL);
2585 } else if (err == 0 && prop == ZPROP_USERPROP) {
2586 if (zfs_prop_user(propname)) {
2587 if (nvpair_type(propval) != DATA_TYPE_STRING)
2588 err = SET_ERROR(EINVAL);
2589 } else if (zfs_prop_userquota(propname)) {
2590 if (nvpair_type(propval) !=
2591 DATA_TYPE_UINT64_ARRAY)
2592 err = SET_ERROR(EINVAL);
2593 } else {
2594 err = SET_ERROR(EINVAL);
2596 } else if (err == 0) {
2597 if (nvpair_type(propval) == DATA_TYPE_STRING) {
2598 if (zfs_prop_get_type(prop) != PROP_TYPE_STRING)
2599 err = SET_ERROR(EINVAL);
2600 } else if (nvpair_type(propval) == DATA_TYPE_UINT64) {
2601 const char *unused;
2603 intval = fnvpair_value_uint64(propval);
2605 switch (zfs_prop_get_type(prop)) {
2606 case PROP_TYPE_NUMBER:
2607 break;
2608 case PROP_TYPE_STRING:
2609 err = SET_ERROR(EINVAL);
2610 break;
2611 case PROP_TYPE_INDEX:
2612 if (zfs_prop_index_to_string(prop,
2613 intval, &unused) != 0)
2614 err =
2615 SET_ERROR(ZFS_ERR_BADPROP);
2616 break;
2617 default:
2618 cmn_err(CE_PANIC,
2619 "unknown property type");
2621 } else {
2622 err = SET_ERROR(EINVAL);
2626 /* Validate permissions */
2627 if (err == 0)
2628 err = zfs_check_settable(dsname, pair, CRED());
2630 if (err == 0) {
2631 if (source == ZPROP_SRC_INHERITED)
2632 err = -1; /* does not need special handling */
2633 else
2634 err = zfs_prop_set_special(dsname, source,
2635 pair);
2636 if (err == -1) {
2638 * For better performance we build up a list of
2639 * properties to set in a single transaction.
2641 err = nvlist_add_nvpair(genericnvl, pair);
2642 } else if (err != 0 && nvl != retrynvl) {
2644 * This may be a spurious error caused by
2645 * receiving quota and reservation out of order.
2646 * Try again in a second pass.
2648 err = nvlist_add_nvpair(retrynvl, pair);
2652 if (err != 0) {
2653 if (errlist != NULL)
2654 fnvlist_add_int32(errlist, propname, err);
2655 rv = err;
2658 if (zfs_is_namespace_prop(prop))
2659 should_update_mount_cache = B_TRUE;
2662 if (nvl != retrynvl && !nvlist_empty(retrynvl)) {
2663 nvl = retrynvl;
2664 goto retry;
2667 if (nvlist_empty(genericnvl))
2668 goto out;
2671 * Try to set them all in one batch.
2673 err = dsl_props_set(dsname, source, genericnvl);
2674 if (err == 0)
2675 goto out;
2678 * If batching fails, we still want to set as many properties as we
2679 * can, so try setting them individually.
2681 pair = NULL;
2682 while ((pair = nvlist_next_nvpair(genericnvl, pair)) != NULL) {
2683 const char *propname = nvpair_name(pair);
2685 propval = pair;
2686 if (nvpair_type(pair) == DATA_TYPE_NVLIST) {
2687 nvlist_t *attrs;
2688 attrs = fnvpair_value_nvlist(pair);
2689 propval = fnvlist_lookup_nvpair(attrs, ZPROP_VALUE);
2692 if (nvpair_type(propval) == DATA_TYPE_STRING) {
2693 strval = fnvpair_value_string(propval);
2694 err = dsl_prop_set_string(dsname, propname,
2695 source, strval);
2696 } else if (nvpair_type(propval) == DATA_TYPE_BOOLEAN) {
2697 err = dsl_prop_inherit(dsname, propname, source);
2698 } else {
2699 intval = fnvpair_value_uint64(propval);
2700 err = dsl_prop_set_int(dsname, propname, source,
2701 intval);
2704 if (err != 0) {
2705 if (errlist != NULL) {
2706 fnvlist_add_int32(errlist, propname, err);
2708 rv = err;
2712 out:
2713 if (should_update_mount_cache)
2714 zfs_ioctl_update_mount_cache(dsname);
2716 nvlist_free(genericnvl);
2717 nvlist_free(retrynvl);
2719 return (rv);
2723 * Check that all the properties are valid user properties.
2725 static int
2726 zfs_check_userprops(nvlist_t *nvl)
2728 nvpair_t *pair = NULL;
2730 while ((pair = nvlist_next_nvpair(nvl, pair)) != NULL) {
2731 const char *propname = nvpair_name(pair);
2733 if (!zfs_prop_user(propname) ||
2734 nvpair_type(pair) != DATA_TYPE_STRING)
2735 return (SET_ERROR(EINVAL));
2737 if (strlen(propname) >= ZAP_MAXNAMELEN)
2738 return (SET_ERROR(ENAMETOOLONG));
2740 if (strlen(fnvpair_value_string(pair)) >= ZAP_MAXVALUELEN)
2741 return (SET_ERROR(E2BIG));
2743 return (0);
2746 static void
2747 props_skip(nvlist_t *props, nvlist_t *skipped, nvlist_t **newprops)
2749 nvpair_t *pair;
2751 VERIFY(nvlist_alloc(newprops, NV_UNIQUE_NAME, KM_SLEEP) == 0);
2753 pair = NULL;
2754 while ((pair = nvlist_next_nvpair(props, pair)) != NULL) {
2755 if (nvlist_exists(skipped, nvpair_name(pair)))
2756 continue;
2758 VERIFY(nvlist_add_nvpair(*newprops, pair) == 0);
2762 static int
2763 clear_received_props(const char *dsname, nvlist_t *props,
2764 nvlist_t *skipped)
2766 int err = 0;
2767 nvlist_t *cleared_props = NULL;
2768 props_skip(props, skipped, &cleared_props);
2769 if (!nvlist_empty(cleared_props)) {
2771 * Acts on local properties until the dataset has received
2772 * properties at least once on or after SPA_VERSION_RECVD_PROPS.
2774 zprop_source_t flags = (ZPROP_SRC_NONE |
2775 (dsl_prop_get_hasrecvd(dsname) ? ZPROP_SRC_RECEIVED : 0));
2776 err = zfs_set_prop_nvlist(dsname, flags, cleared_props, NULL);
2778 nvlist_free(cleared_props);
2779 return (err);
2783 * inputs:
2784 * zc_name name of filesystem
2785 * zc_value name of property to set
2786 * zc_nvlist_src{_size} nvlist of properties to apply
2787 * zc_cookie received properties flag
2789 * outputs:
2790 * zc_nvlist_dst{_size} error for each unapplied received property
2792 static int
2793 zfs_ioc_set_prop(zfs_cmd_t *zc)
2795 nvlist_t *nvl;
2796 boolean_t received = zc->zc_cookie;
2797 zprop_source_t source = (received ? ZPROP_SRC_RECEIVED :
2798 ZPROP_SRC_LOCAL);
2799 nvlist_t *errors;
2800 int error;
2802 if ((error = get_nvlist(zc->zc_nvlist_src, zc->zc_nvlist_src_size,
2803 zc->zc_iflags, &nvl)) != 0)
2804 return (error);
2806 if (received) {
2807 nvlist_t *origprops;
2809 if (dsl_prop_get_received(zc->zc_name, &origprops) == 0) {
2810 (void) clear_received_props(zc->zc_name,
2811 origprops, nvl);
2812 nvlist_free(origprops);
2815 error = dsl_prop_set_hasrecvd(zc->zc_name);
2818 errors = fnvlist_alloc();
2819 if (error == 0)
2820 error = zfs_set_prop_nvlist(zc->zc_name, source, nvl, errors);
2822 if (zc->zc_nvlist_dst != 0 && errors != NULL) {
2823 (void) put_nvlist(zc, errors);
2826 nvlist_free(errors);
2827 nvlist_free(nvl);
2828 return (error);
2832 * inputs:
2833 * zc_name name of filesystem
2834 * zc_value name of property to inherit
2835 * zc_cookie revert to received value if TRUE
2837 * outputs: none
2839 static int
2840 zfs_ioc_inherit_prop(zfs_cmd_t *zc)
2842 const char *propname = zc->zc_value;
2843 zfs_prop_t prop = zfs_name_to_prop(propname);
2844 boolean_t received = zc->zc_cookie;
2845 zprop_source_t source = (received
2846 ? ZPROP_SRC_NONE /* revert to received value, if any */
2847 : ZPROP_SRC_INHERITED); /* explicitly inherit */
2848 nvlist_t *dummy;
2849 nvpair_t *pair;
2850 zprop_type_t type;
2851 int err;
2853 if (!received) {
2855 * Only check this in the non-received case. We want to allow
2856 * 'inherit -S' to revert non-inheritable properties like quota
2857 * and reservation to the received or default values even though
2858 * they are not considered inheritable.
2860 if (prop != ZPROP_USERPROP && !zfs_prop_inheritable(prop))
2861 return (SET_ERROR(EINVAL));
2864 if (prop == ZPROP_USERPROP) {
2865 if (!zfs_prop_user(propname))
2866 return (SET_ERROR(EINVAL));
2868 type = PROP_TYPE_STRING;
2869 } else if (prop == ZFS_PROP_VOLSIZE || prop == ZFS_PROP_VERSION) {
2870 return (SET_ERROR(EINVAL));
2871 } else {
2872 type = zfs_prop_get_type(prop);
2876 * zfs_prop_set_special() expects properties in the form of an
2877 * nvpair with type info.
2879 dummy = fnvlist_alloc();
2881 switch (type) {
2882 case PROP_TYPE_STRING:
2883 VERIFY(0 == nvlist_add_string(dummy, propname, ""));
2884 break;
2885 case PROP_TYPE_NUMBER:
2886 case PROP_TYPE_INDEX:
2887 VERIFY(0 == nvlist_add_uint64(dummy, propname, 0));
2888 break;
2889 default:
2890 err = SET_ERROR(EINVAL);
2891 goto errout;
2894 pair = nvlist_next_nvpair(dummy, NULL);
2895 if (pair == NULL) {
2896 err = SET_ERROR(EINVAL);
2897 } else {
2898 err = zfs_prop_set_special(zc->zc_name, source, pair);
2899 if (err == -1) /* property is not "special", needs handling */
2900 err = dsl_prop_inherit(zc->zc_name, zc->zc_value,
2901 source);
2904 errout:
2905 nvlist_free(dummy);
2906 return (err);
2909 static int
2910 zfs_ioc_pool_set_props(zfs_cmd_t *zc)
2912 nvlist_t *props;
2913 spa_t *spa;
2914 int error;
2915 nvpair_t *pair;
2917 if ((error = get_nvlist(zc->zc_nvlist_src, zc->zc_nvlist_src_size,
2918 zc->zc_iflags, &props)))
2919 return (error);
2922 * If the only property is the configfile, then just do a spa_lookup()
2923 * to handle the faulted case.
2925 pair = nvlist_next_nvpair(props, NULL);
2926 if (pair != NULL && strcmp(nvpair_name(pair),
2927 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE)) == 0 &&
2928 nvlist_next_nvpair(props, pair) == NULL) {
2929 mutex_enter(&spa_namespace_lock);
2930 if ((spa = spa_lookup(zc->zc_name)) != NULL) {
2931 spa_configfile_set(spa, props, B_FALSE);
2932 spa_write_cachefile(spa, B_FALSE, B_TRUE, B_FALSE);
2934 mutex_exit(&spa_namespace_lock);
2935 if (spa != NULL) {
2936 nvlist_free(props);
2937 return (0);
2941 if ((error = spa_open(zc->zc_name, &spa, FTAG)) != 0) {
2942 nvlist_free(props);
2943 return (error);
2946 error = spa_prop_set(spa, props);
2948 nvlist_free(props);
2949 spa_close(spa, FTAG);
2951 return (error);
2954 static int
2955 zfs_ioc_pool_get_props(zfs_cmd_t *zc)
2957 spa_t *spa;
2958 int error;
2959 nvlist_t *nvp = NULL;
2961 if ((error = spa_open(zc->zc_name, &spa, FTAG)) != 0) {
2963 * If the pool is faulted, there may be properties we can still
2964 * get (such as altroot and cachefile), so attempt to get them
2965 * anyway.
2967 mutex_enter(&spa_namespace_lock);
2968 if ((spa = spa_lookup(zc->zc_name)) != NULL)
2969 error = spa_prop_get(spa, &nvp);
2970 mutex_exit(&spa_namespace_lock);
2971 } else {
2972 error = spa_prop_get(spa, &nvp);
2973 spa_close(spa, FTAG);
2976 if (error == 0 && zc->zc_nvlist_dst != 0)
2977 error = put_nvlist(zc, nvp);
2978 else
2979 error = SET_ERROR(EFAULT);
2981 nvlist_free(nvp);
2982 return (error);
2986 * innvl: {
2987 * "vdevprops_set_vdev" -> guid
2988 * "vdevprops_set_props" -> { prop -> value }
2991 * outnvl: propname -> error code (int32)
2993 static const zfs_ioc_key_t zfs_keys_vdev_set_props[] = {
2994 {ZPOOL_VDEV_PROPS_SET_VDEV, DATA_TYPE_UINT64, 0},
2995 {ZPOOL_VDEV_PROPS_SET_PROPS, DATA_TYPE_NVLIST, 0}
2998 static int
2999 zfs_ioc_vdev_set_props(const char *poolname, nvlist_t *innvl, nvlist_t *outnvl)
3001 spa_t *spa;
3002 int error;
3003 vdev_t *vd;
3004 uint64_t vdev_guid;
3006 /* Early validation */
3007 if (nvlist_lookup_uint64(innvl, ZPOOL_VDEV_PROPS_SET_VDEV,
3008 &vdev_guid) != 0)
3009 return (SET_ERROR(EINVAL));
3011 if (outnvl == NULL)
3012 return (SET_ERROR(EINVAL));
3014 if ((error = spa_open(poolname, &spa, FTAG)) != 0)
3015 return (error);
3017 ASSERT(spa_writeable(spa));
3019 if ((vd = spa_lookup_by_guid(spa, vdev_guid, B_TRUE)) == NULL) {
3020 spa_close(spa, FTAG);
3021 return (SET_ERROR(ENOENT));
3024 error = vdev_prop_set(vd, innvl, outnvl);
3026 spa_close(spa, FTAG);
3028 return (error);
3032 * innvl: {
3033 * "vdevprops_get_vdev" -> guid
3034 * (optional) "vdevprops_get_props" -> { propname -> propid }
3037 * outnvl: propname -> value
3039 static const zfs_ioc_key_t zfs_keys_vdev_get_props[] = {
3040 {ZPOOL_VDEV_PROPS_GET_VDEV, DATA_TYPE_UINT64, 0},
3041 {ZPOOL_VDEV_PROPS_GET_PROPS, DATA_TYPE_NVLIST, ZK_OPTIONAL}
3044 static int
3045 zfs_ioc_vdev_get_props(const char *poolname, nvlist_t *innvl, nvlist_t *outnvl)
3047 spa_t *spa;
3048 int error;
3049 vdev_t *vd;
3050 uint64_t vdev_guid;
3052 /* Early validation */
3053 if (nvlist_lookup_uint64(innvl, ZPOOL_VDEV_PROPS_GET_VDEV,
3054 &vdev_guid) != 0)
3055 return (SET_ERROR(EINVAL));
3057 if (outnvl == NULL)
3058 return (SET_ERROR(EINVAL));
3060 if ((error = spa_open(poolname, &spa, FTAG)) != 0)
3061 return (error);
3063 if ((vd = spa_lookup_by_guid(spa, vdev_guid, B_TRUE)) == NULL) {
3064 spa_close(spa, FTAG);
3065 return (SET_ERROR(ENOENT));
3068 error = vdev_prop_get(vd, innvl, outnvl);
3070 spa_close(spa, FTAG);
3072 return (error);
3076 * inputs:
3077 * zc_name name of filesystem
3078 * zc_nvlist_src{_size} nvlist of delegated permissions
3079 * zc_perm_action allow/unallow flag
3081 * outputs: none
3083 static int
3084 zfs_ioc_set_fsacl(zfs_cmd_t *zc)
3086 int error;
3087 nvlist_t *fsaclnv = NULL;
3089 if ((error = get_nvlist(zc->zc_nvlist_src, zc->zc_nvlist_src_size,
3090 zc->zc_iflags, &fsaclnv)) != 0)
3091 return (error);
3094 * Verify nvlist is constructed correctly
3096 if (zfs_deleg_verify_nvlist(fsaclnv) != 0) {
3097 nvlist_free(fsaclnv);
3098 return (SET_ERROR(EINVAL));
3102 * If we don't have PRIV_SYS_MOUNT, then validate
3103 * that user is allowed to hand out each permission in
3104 * the nvlist(s)
3107 error = secpolicy_zfs(CRED());
3108 if (error != 0) {
3109 if (zc->zc_perm_action == B_FALSE) {
3110 error = dsl_deleg_can_allow(zc->zc_name,
3111 fsaclnv, CRED());
3112 } else {
3113 error = dsl_deleg_can_unallow(zc->zc_name,
3114 fsaclnv, CRED());
3118 if (error == 0)
3119 error = dsl_deleg_set(zc->zc_name, fsaclnv, zc->zc_perm_action);
3121 nvlist_free(fsaclnv);
3122 return (error);
3126 * inputs:
3127 * zc_name name of filesystem
3129 * outputs:
3130 * zc_nvlist_src{_size} nvlist of delegated permissions
3132 static int
3133 zfs_ioc_get_fsacl(zfs_cmd_t *zc)
3135 nvlist_t *nvp;
3136 int error;
3138 if ((error = dsl_deleg_get(zc->zc_name, &nvp)) == 0) {
3139 error = put_nvlist(zc, nvp);
3140 nvlist_free(nvp);
3143 return (error);
3146 static void
3147 zfs_create_cb(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx)
3149 zfs_creat_t *zct = arg;
3151 zfs_create_fs(os, cr, zct->zct_zplprops, tx);
3154 #define ZFS_PROP_UNDEFINED ((uint64_t)-1)
3157 * inputs:
3158 * os parent objset pointer (NULL if root fs)
3159 * fuids_ok fuids allowed in this version of the spa?
3160 * sa_ok SAs allowed in this version of the spa?
3161 * createprops list of properties requested by creator
3163 * outputs:
3164 * zplprops values for the zplprops we attach to the master node object
3165 * is_ci true if requested file system will be purely case-insensitive
3167 * Determine the settings for utf8only, normalization and
3168 * casesensitivity. Specific values may have been requested by the
3169 * creator and/or we can inherit values from the parent dataset. If
3170 * the file system is of too early a vintage, a creator can not
3171 * request settings for these properties, even if the requested
3172 * setting is the default value. We don't actually want to create dsl
3173 * properties for these, so remove them from the source nvlist after
3174 * processing.
3176 static int
3177 zfs_fill_zplprops_impl(objset_t *os, uint64_t zplver,
3178 boolean_t fuids_ok, boolean_t sa_ok, nvlist_t *createprops,
3179 nvlist_t *zplprops, boolean_t *is_ci)
3181 uint64_t sense = ZFS_PROP_UNDEFINED;
3182 uint64_t norm = ZFS_PROP_UNDEFINED;
3183 uint64_t u8 = ZFS_PROP_UNDEFINED;
3184 int error;
3186 ASSERT(zplprops != NULL);
3188 /* parent dataset must be a filesystem */
3189 if (os != NULL && os->os_phys->os_type != DMU_OST_ZFS)
3190 return (SET_ERROR(ZFS_ERR_WRONG_PARENT));
3193 * Pull out creator prop choices, if any.
3195 if (createprops) {
3196 (void) nvlist_lookup_uint64(createprops,
3197 zfs_prop_to_name(ZFS_PROP_VERSION), &zplver);
3198 (void) nvlist_lookup_uint64(createprops,
3199 zfs_prop_to_name(ZFS_PROP_NORMALIZE), &norm);
3200 (void) nvlist_remove_all(createprops,
3201 zfs_prop_to_name(ZFS_PROP_NORMALIZE));
3202 (void) nvlist_lookup_uint64(createprops,
3203 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), &u8);
3204 (void) nvlist_remove_all(createprops,
3205 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
3206 (void) nvlist_lookup_uint64(createprops,
3207 zfs_prop_to_name(ZFS_PROP_CASE), &sense);
3208 (void) nvlist_remove_all(createprops,
3209 zfs_prop_to_name(ZFS_PROP_CASE));
3213 * If the zpl version requested is whacky or the file system
3214 * or pool is version is too "young" to support normalization
3215 * and the creator tried to set a value for one of the props,
3216 * error out.
3218 if ((zplver < ZPL_VERSION_INITIAL || zplver > ZPL_VERSION) ||
3219 (zplver >= ZPL_VERSION_FUID && !fuids_ok) ||
3220 (zplver >= ZPL_VERSION_SA && !sa_ok) ||
3221 (zplver < ZPL_VERSION_NORMALIZATION &&
3222 (norm != ZFS_PROP_UNDEFINED || u8 != ZFS_PROP_UNDEFINED ||
3223 sense != ZFS_PROP_UNDEFINED)))
3224 return (SET_ERROR(ENOTSUP));
3227 * Put the version in the zplprops
3229 VERIFY(nvlist_add_uint64(zplprops,
3230 zfs_prop_to_name(ZFS_PROP_VERSION), zplver) == 0);
3232 if (norm == ZFS_PROP_UNDEFINED &&
3233 (error = zfs_get_zplprop(os, ZFS_PROP_NORMALIZE, &norm)) != 0)
3234 return (error);
3235 VERIFY(nvlist_add_uint64(zplprops,
3236 zfs_prop_to_name(ZFS_PROP_NORMALIZE), norm) == 0);
3239 * If we're normalizing, names must always be valid UTF-8 strings.
3241 if (norm)
3242 u8 = 1;
3243 if (u8 == ZFS_PROP_UNDEFINED &&
3244 (error = zfs_get_zplprop(os, ZFS_PROP_UTF8ONLY, &u8)) != 0)
3245 return (error);
3246 VERIFY(nvlist_add_uint64(zplprops,
3247 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), u8) == 0);
3249 if (sense == ZFS_PROP_UNDEFINED &&
3250 (error = zfs_get_zplprop(os, ZFS_PROP_CASE, &sense)) != 0)
3251 return (error);
3252 VERIFY(nvlist_add_uint64(zplprops,
3253 zfs_prop_to_name(ZFS_PROP_CASE), sense) == 0);
3255 if (is_ci)
3256 *is_ci = (sense == ZFS_CASE_INSENSITIVE);
3258 return (0);
3261 static int
3262 zfs_fill_zplprops(const char *dataset, nvlist_t *createprops,
3263 nvlist_t *zplprops, boolean_t *is_ci)
3265 boolean_t fuids_ok, sa_ok;
3266 uint64_t zplver = ZPL_VERSION;
3267 objset_t *os = NULL;
3268 char parentname[ZFS_MAX_DATASET_NAME_LEN];
3269 spa_t *spa;
3270 uint64_t spa_vers;
3271 int error;
3273 zfs_get_parent(dataset, parentname, sizeof (parentname));
3275 if ((error = spa_open(dataset, &spa, FTAG)) != 0)
3276 return (error);
3278 spa_vers = spa_version(spa);
3279 spa_close(spa, FTAG);
3281 zplver = zfs_zpl_version_map(spa_vers);
3282 fuids_ok = (zplver >= ZPL_VERSION_FUID);
3283 sa_ok = (zplver >= ZPL_VERSION_SA);
3286 * Open parent object set so we can inherit zplprop values.
3288 if ((error = dmu_objset_hold(parentname, FTAG, &os)) != 0)
3289 return (error);
3291 error = zfs_fill_zplprops_impl(os, zplver, fuids_ok, sa_ok, createprops,
3292 zplprops, is_ci);
3293 dmu_objset_rele(os, FTAG);
3294 return (error);
3297 static int
3298 zfs_fill_zplprops_root(uint64_t spa_vers, nvlist_t *createprops,
3299 nvlist_t *zplprops, boolean_t *is_ci)
3301 boolean_t fuids_ok;
3302 boolean_t sa_ok;
3303 uint64_t zplver = ZPL_VERSION;
3304 int error;
3306 zplver = zfs_zpl_version_map(spa_vers);
3307 fuids_ok = (zplver >= ZPL_VERSION_FUID);
3308 sa_ok = (zplver >= ZPL_VERSION_SA);
3310 error = zfs_fill_zplprops_impl(NULL, zplver, fuids_ok, sa_ok,
3311 createprops, zplprops, is_ci);
3312 return (error);
3316 * innvl: {
3317 * "type" -> dmu_objset_type_t (int32)
3318 * (optional) "props" -> { prop -> value }
3319 * (optional) "hidden_args" -> { "wkeydata" -> value }
3320 * raw uint8_t array of encryption wrapping key data (32 bytes)
3323 * outnvl: propname -> error code (int32)
3326 static const zfs_ioc_key_t zfs_keys_create[] = {
3327 {"type", DATA_TYPE_INT32, 0},
3328 {"props", DATA_TYPE_NVLIST, ZK_OPTIONAL},
3329 {"hidden_args", DATA_TYPE_NVLIST, ZK_OPTIONAL},
3332 static int
3333 zfs_ioc_create(const char *fsname, nvlist_t *innvl, nvlist_t *outnvl)
3335 int error = 0;
3336 zfs_creat_t zct = { 0 };
3337 nvlist_t *nvprops = NULL;
3338 nvlist_t *hidden_args = NULL;
3339 void (*cbfunc)(objset_t *os, void *arg, cred_t *cr, dmu_tx_t *tx);
3340 dmu_objset_type_t type;
3341 boolean_t is_insensitive = B_FALSE;
3342 dsl_crypto_params_t *dcp = NULL;
3344 type = (dmu_objset_type_t)fnvlist_lookup_int32(innvl, "type");
3345 (void) nvlist_lookup_nvlist(innvl, "props", &nvprops);
3346 (void) nvlist_lookup_nvlist(innvl, ZPOOL_HIDDEN_ARGS, &hidden_args);
3348 switch (type) {
3349 case DMU_OST_ZFS:
3350 cbfunc = zfs_create_cb;
3351 break;
3353 case DMU_OST_ZVOL:
3354 cbfunc = zvol_create_cb;
3355 break;
3357 default:
3358 cbfunc = NULL;
3359 break;
3361 if (strchr(fsname, '@') ||
3362 strchr(fsname, '%'))
3363 return (SET_ERROR(EINVAL));
3365 zct.zct_props = nvprops;
3367 if (cbfunc == NULL)
3368 return (SET_ERROR(EINVAL));
3370 if (type == DMU_OST_ZVOL) {
3371 uint64_t volsize, volblocksize;
3373 if (nvprops == NULL)
3374 return (SET_ERROR(EINVAL));
3375 if (nvlist_lookup_uint64(nvprops,
3376 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &volsize) != 0)
3377 return (SET_ERROR(EINVAL));
3379 if ((error = nvlist_lookup_uint64(nvprops,
3380 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3381 &volblocksize)) != 0 && error != ENOENT)
3382 return (SET_ERROR(EINVAL));
3384 if (error != 0)
3385 volblocksize = zfs_prop_default_numeric(
3386 ZFS_PROP_VOLBLOCKSIZE);
3388 if ((error = zvol_check_volblocksize(fsname,
3389 volblocksize)) != 0 ||
3390 (error = zvol_check_volsize(volsize,
3391 volblocksize)) != 0)
3392 return (error);
3393 } else if (type == DMU_OST_ZFS) {
3394 int error;
3397 * We have to have normalization and
3398 * case-folding flags correct when we do the
3399 * file system creation, so go figure them out
3400 * now.
3402 VERIFY(nvlist_alloc(&zct.zct_zplprops,
3403 NV_UNIQUE_NAME, KM_SLEEP) == 0);
3404 error = zfs_fill_zplprops(fsname, nvprops,
3405 zct.zct_zplprops, &is_insensitive);
3406 if (error != 0) {
3407 nvlist_free(zct.zct_zplprops);
3408 return (error);
3412 error = dsl_crypto_params_create_nvlist(DCP_CMD_NONE, nvprops,
3413 hidden_args, &dcp);
3414 if (error != 0) {
3415 nvlist_free(zct.zct_zplprops);
3416 return (error);
3419 error = dmu_objset_create(fsname, type,
3420 is_insensitive ? DS_FLAG_CI_DATASET : 0, dcp, cbfunc, &zct);
3422 nvlist_free(zct.zct_zplprops);
3423 dsl_crypto_params_free(dcp, !!error);
3426 * It would be nice to do this atomically.
3428 if (error == 0) {
3429 error = zfs_set_prop_nvlist(fsname, ZPROP_SRC_LOCAL,
3430 nvprops, outnvl);
3431 if (error != 0) {
3432 spa_t *spa;
3433 int error2;
3436 * Volumes will return EBUSY and cannot be destroyed
3437 * until all asynchronous minor handling (e.g. from
3438 * setting the volmode property) has completed. Wait for
3439 * the spa_zvol_taskq to drain then retry.
3441 error2 = dsl_destroy_head(fsname);
3442 while ((error2 == EBUSY) && (type == DMU_OST_ZVOL)) {
3443 error2 = spa_open(fsname, &spa, FTAG);
3444 if (error2 == 0) {
3445 taskq_wait(spa->spa_zvol_taskq);
3446 spa_close(spa, FTAG);
3448 error2 = dsl_destroy_head(fsname);
3452 return (error);
3456 * innvl: {
3457 * "origin" -> name of origin snapshot
3458 * (optional) "props" -> { prop -> value }
3459 * (optional) "hidden_args" -> { "wkeydata" -> value }
3460 * raw uint8_t array of encryption wrapping key data (32 bytes)
3463 * outputs:
3464 * outnvl: propname -> error code (int32)
3466 static const zfs_ioc_key_t zfs_keys_clone[] = {
3467 {"origin", DATA_TYPE_STRING, 0},
3468 {"props", DATA_TYPE_NVLIST, ZK_OPTIONAL},
3469 {"hidden_args", DATA_TYPE_NVLIST, ZK_OPTIONAL},
3472 static int
3473 zfs_ioc_clone(const char *fsname, nvlist_t *innvl, nvlist_t *outnvl)
3475 int error = 0;
3476 nvlist_t *nvprops = NULL;
3477 const char *origin_name;
3479 origin_name = fnvlist_lookup_string(innvl, "origin");
3480 (void) nvlist_lookup_nvlist(innvl, "props", &nvprops);
3482 if (strchr(fsname, '@') ||
3483 strchr(fsname, '%'))
3484 return (SET_ERROR(EINVAL));
3486 if (dataset_namecheck(origin_name, NULL, NULL) != 0)
3487 return (SET_ERROR(EINVAL));
3489 error = dmu_objset_clone(fsname, origin_name);
3492 * It would be nice to do this atomically.
3494 if (error == 0) {
3495 error = zfs_set_prop_nvlist(fsname, ZPROP_SRC_LOCAL,
3496 nvprops, outnvl);
3497 if (error != 0)
3498 (void) dsl_destroy_head(fsname);
3500 return (error);
3503 static const zfs_ioc_key_t zfs_keys_remap[] = {
3504 /* no nvl keys */
3507 static int
3508 zfs_ioc_remap(const char *fsname, nvlist_t *innvl, nvlist_t *outnvl)
3510 /* This IOCTL is no longer supported. */
3511 (void) fsname, (void) innvl, (void) outnvl;
3512 return (0);
3516 * innvl: {
3517 * "snaps" -> { snapshot1, snapshot2 }
3518 * (optional) "props" -> { prop -> value (string) }
3521 * outnvl: snapshot -> error code (int32)
3523 static const zfs_ioc_key_t zfs_keys_snapshot[] = {
3524 {"snaps", DATA_TYPE_NVLIST, 0},
3525 {"props", DATA_TYPE_NVLIST, ZK_OPTIONAL},
3528 static int
3529 zfs_ioc_snapshot(const char *poolname, nvlist_t *innvl, nvlist_t *outnvl)
3531 nvlist_t *snaps;
3532 nvlist_t *props = NULL;
3533 int error, poollen;
3534 nvpair_t *pair;
3536 (void) nvlist_lookup_nvlist(innvl, "props", &props);
3537 if (!nvlist_empty(props) &&
3538 zfs_earlier_version(poolname, SPA_VERSION_SNAP_PROPS))
3539 return (SET_ERROR(ENOTSUP));
3540 if ((error = zfs_check_userprops(props)) != 0)
3541 return (error);
3543 snaps = fnvlist_lookup_nvlist(innvl, "snaps");
3544 poollen = strlen(poolname);
3545 for (pair = nvlist_next_nvpair(snaps, NULL); pair != NULL;
3546 pair = nvlist_next_nvpair(snaps, pair)) {
3547 const char *name = nvpair_name(pair);
3548 char *cp = strchr(name, '@');
3551 * The snap name must contain an @, and the part after it must
3552 * contain only valid characters.
3554 if (cp == NULL ||
3555 zfs_component_namecheck(cp + 1, NULL, NULL) != 0)
3556 return (SET_ERROR(EINVAL));
3559 * The snap must be in the specified pool.
3561 if (strncmp(name, poolname, poollen) != 0 ||
3562 (name[poollen] != '/' && name[poollen] != '@'))
3563 return (SET_ERROR(EXDEV));
3566 * Check for permission to set the properties on the fs.
3568 if (!nvlist_empty(props)) {
3569 *cp = '\0';
3570 error = zfs_secpolicy_write_perms(name,
3571 ZFS_DELEG_PERM_USERPROP, CRED());
3572 *cp = '@';
3573 if (error != 0)
3574 return (error);
3577 /* This must be the only snap of this fs. */
3578 for (nvpair_t *pair2 = nvlist_next_nvpair(snaps, pair);
3579 pair2 != NULL; pair2 = nvlist_next_nvpair(snaps, pair2)) {
3580 if (strncmp(name, nvpair_name(pair2), cp - name + 1)
3581 == 0) {
3582 return (SET_ERROR(EXDEV));
3587 error = dsl_dataset_snapshot(snaps, props, outnvl);
3589 return (error);
3593 * innvl: "message" -> string
3595 static const zfs_ioc_key_t zfs_keys_log_history[] = {
3596 {"message", DATA_TYPE_STRING, 0},
3599 static int
3600 zfs_ioc_log_history(const char *unused, nvlist_t *innvl, nvlist_t *outnvl)
3602 (void) unused, (void) outnvl;
3603 const char *message;
3604 char *poolname;
3605 spa_t *spa;
3606 int error;
3609 * The poolname in the ioctl is not set, we get it from the TSD,
3610 * which was set at the end of the last successful ioctl that allows
3611 * logging. The secpolicy func already checked that it is set.
3612 * Only one log ioctl is allowed after each successful ioctl, so
3613 * we clear the TSD here.
3615 poolname = tsd_get(zfs_allow_log_key);
3616 if (poolname == NULL)
3617 return (SET_ERROR(EINVAL));
3618 (void) tsd_set(zfs_allow_log_key, NULL);
3619 error = spa_open(poolname, &spa, FTAG);
3620 kmem_strfree(poolname);
3621 if (error != 0)
3622 return (error);
3624 message = fnvlist_lookup_string(innvl, "message");
3626 if (spa_version(spa) < SPA_VERSION_ZPOOL_HISTORY) {
3627 spa_close(spa, FTAG);
3628 return (SET_ERROR(ENOTSUP));
3631 error = spa_history_log(spa, message);
3632 spa_close(spa, FTAG);
3633 return (error);
3637 * This ioctl is used to set the bootenv configuration on the current
3638 * pool. This configuration is stored in the second padding area of the label,
3639 * and it is used by the bootloader(s) to store the bootloader and/or system
3640 * specific data.
3641 * The data is stored as nvlist data stream, and is protected by
3642 * an embedded checksum.
3643 * The version can have two possible values:
3644 * VB_RAW: nvlist should have key GRUB_ENVMAP, value DATA_TYPE_STRING.
3645 * VB_NVLIST: nvlist with arbitrary <key, value> pairs.
3647 static const zfs_ioc_key_t zfs_keys_set_bootenv[] = {
3648 {"version", DATA_TYPE_UINT64, 0},
3649 {"<keys>", DATA_TYPE_ANY, ZK_OPTIONAL | ZK_WILDCARDLIST},
3652 static int
3653 zfs_ioc_set_bootenv(const char *name, nvlist_t *innvl, nvlist_t *outnvl)
3655 int error;
3656 spa_t *spa;
3658 if ((error = spa_open(name, &spa, FTAG)) != 0)
3659 return (error);
3660 spa_vdev_state_enter(spa, SCL_ALL);
3661 error = vdev_label_write_bootenv(spa->spa_root_vdev, innvl);
3662 (void) spa_vdev_state_exit(spa, NULL, 0);
3663 spa_close(spa, FTAG);
3664 return (error);
3667 static const zfs_ioc_key_t zfs_keys_get_bootenv[] = {
3668 /* no nvl keys */
3671 static int
3672 zfs_ioc_get_bootenv(const char *name, nvlist_t *innvl, nvlist_t *outnvl)
3674 spa_t *spa;
3675 int error;
3677 if ((error = spa_open(name, &spa, FTAG)) != 0)
3678 return (error);
3679 spa_vdev_state_enter(spa, SCL_ALL);
3680 error = vdev_label_read_bootenv(spa->spa_root_vdev, outnvl);
3681 (void) spa_vdev_state_exit(spa, NULL, 0);
3682 spa_close(spa, FTAG);
3683 return (error);
3687 * The dp_config_rwlock must not be held when calling this, because the
3688 * unmount may need to write out data.
3690 * This function is best-effort. Callers must deal gracefully if it
3691 * remains mounted (or is remounted after this call).
3693 * Returns 0 if the argument is not a snapshot, or it is not currently a
3694 * filesystem, or we were able to unmount it. Returns error code otherwise.
3696 void
3697 zfs_unmount_snap(const char *snapname)
3699 if (strchr(snapname, '@') == NULL)
3700 return;
3702 (void) zfsctl_snapshot_unmount(snapname, MNT_FORCE);
3705 static int
3706 zfs_unmount_snap_cb(const char *snapname, void *arg)
3708 (void) arg;
3709 zfs_unmount_snap(snapname);
3710 return (0);
3714 * When a clone is destroyed, its origin may also need to be destroyed,
3715 * in which case it must be unmounted. This routine will do that unmount
3716 * if necessary.
3718 void
3719 zfs_destroy_unmount_origin(const char *fsname)
3721 int error;
3722 objset_t *os;
3723 dsl_dataset_t *ds;
3725 error = dmu_objset_hold(fsname, FTAG, &os);
3726 if (error != 0)
3727 return;
3728 ds = dmu_objset_ds(os);
3729 if (dsl_dir_is_clone(ds->ds_dir) && DS_IS_DEFER_DESTROY(ds->ds_prev)) {
3730 char originname[ZFS_MAX_DATASET_NAME_LEN];
3731 dsl_dataset_name(ds->ds_prev, originname);
3732 dmu_objset_rele(os, FTAG);
3733 zfs_unmount_snap(originname);
3734 } else {
3735 dmu_objset_rele(os, FTAG);
3740 * innvl: {
3741 * "snaps" -> { snapshot1, snapshot2 }
3742 * (optional boolean) "defer"
3745 * outnvl: snapshot -> error code (int32)
3747 static const zfs_ioc_key_t zfs_keys_destroy_snaps[] = {
3748 {"snaps", DATA_TYPE_NVLIST, 0},
3749 {"defer", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
3752 static int
3753 zfs_ioc_destroy_snaps(const char *poolname, nvlist_t *innvl, nvlist_t *outnvl)
3755 int poollen;
3756 nvlist_t *snaps;
3757 nvpair_t *pair;
3758 boolean_t defer;
3759 spa_t *spa;
3761 snaps = fnvlist_lookup_nvlist(innvl, "snaps");
3762 defer = nvlist_exists(innvl, "defer");
3764 poollen = strlen(poolname);
3765 for (pair = nvlist_next_nvpair(snaps, NULL); pair != NULL;
3766 pair = nvlist_next_nvpair(snaps, pair)) {
3767 const char *name = nvpair_name(pair);
3770 * The snap must be in the specified pool to prevent the
3771 * invalid removal of zvol minors below.
3773 if (strncmp(name, poolname, poollen) != 0 ||
3774 (name[poollen] != '/' && name[poollen] != '@'))
3775 return (SET_ERROR(EXDEV));
3777 zfs_unmount_snap(nvpair_name(pair));
3778 if (spa_open(name, &spa, FTAG) == 0) {
3779 zvol_remove_minors(spa, name, B_TRUE);
3780 spa_close(spa, FTAG);
3784 return (dsl_destroy_snapshots_nvl(snaps, defer, outnvl));
3788 * Create bookmarks. The bookmark names are of the form <fs>#<bmark>.
3789 * All bookmarks and snapshots must be in the same pool.
3790 * dsl_bookmark_create_nvl_validate describes the nvlist schema in more detail.
3792 * innvl: {
3793 * new_bookmark1 -> existing_snapshot,
3794 * new_bookmark2 -> existing_bookmark,
3797 * outnvl: bookmark -> error code (int32)
3800 static const zfs_ioc_key_t zfs_keys_bookmark[] = {
3801 {"<bookmark>...", DATA_TYPE_STRING, ZK_WILDCARDLIST},
3804 static int
3805 zfs_ioc_bookmark(const char *poolname, nvlist_t *innvl, nvlist_t *outnvl)
3807 (void) poolname;
3808 return (dsl_bookmark_create(innvl, outnvl));
3812 * innvl: {
3813 * property 1, property 2, ...
3816 * outnvl: {
3817 * bookmark name 1 -> { property 1, property 2, ... },
3818 * bookmark name 2 -> { property 1, property 2, ... }
3822 static const zfs_ioc_key_t zfs_keys_get_bookmarks[] = {
3823 {"<property>...", DATA_TYPE_BOOLEAN, ZK_WILDCARDLIST | ZK_OPTIONAL},
3826 static int
3827 zfs_ioc_get_bookmarks(const char *fsname, nvlist_t *innvl, nvlist_t *outnvl)
3829 return (dsl_get_bookmarks(fsname, innvl, outnvl));
3833 * innvl is not used.
3835 * outnvl: {
3836 * property 1, property 2, ...
3840 static const zfs_ioc_key_t zfs_keys_get_bookmark_props[] = {
3841 /* no nvl keys */
3844 static int
3845 zfs_ioc_get_bookmark_props(const char *bookmark, nvlist_t *innvl,
3846 nvlist_t *outnvl)
3848 (void) innvl;
3849 char fsname[ZFS_MAX_DATASET_NAME_LEN];
3850 char *bmname;
3852 bmname = strchr(bookmark, '#');
3853 if (bmname == NULL)
3854 return (SET_ERROR(EINVAL));
3855 bmname++;
3857 (void) strlcpy(fsname, bookmark, sizeof (fsname));
3858 *(strchr(fsname, '#')) = '\0';
3860 return (dsl_get_bookmark_props(fsname, bmname, outnvl));
3864 * innvl: {
3865 * bookmark name 1, bookmark name 2
3868 * outnvl: bookmark -> error code (int32)
3871 static const zfs_ioc_key_t zfs_keys_destroy_bookmarks[] = {
3872 {"<bookmark>...", DATA_TYPE_BOOLEAN, ZK_WILDCARDLIST},
3875 static int
3876 zfs_ioc_destroy_bookmarks(const char *poolname, nvlist_t *innvl,
3877 nvlist_t *outnvl)
3879 int error, poollen;
3881 poollen = strlen(poolname);
3882 for (nvpair_t *pair = nvlist_next_nvpair(innvl, NULL);
3883 pair != NULL; pair = nvlist_next_nvpair(innvl, pair)) {
3884 const char *name = nvpair_name(pair);
3885 const char *cp = strchr(name, '#');
3888 * The bookmark name must contain an #, and the part after it
3889 * must contain only valid characters.
3891 if (cp == NULL ||
3892 zfs_component_namecheck(cp + 1, NULL, NULL) != 0)
3893 return (SET_ERROR(EINVAL));
3896 * The bookmark must be in the specified pool.
3898 if (strncmp(name, poolname, poollen) != 0 ||
3899 (name[poollen] != '/' && name[poollen] != '#'))
3900 return (SET_ERROR(EXDEV));
3903 error = dsl_bookmark_destroy(innvl, outnvl);
3904 return (error);
3907 static const zfs_ioc_key_t zfs_keys_channel_program[] = {
3908 {"program", DATA_TYPE_STRING, 0},
3909 {"arg", DATA_TYPE_ANY, 0},
3910 {"sync", DATA_TYPE_BOOLEAN_VALUE, ZK_OPTIONAL},
3911 {"instrlimit", DATA_TYPE_UINT64, ZK_OPTIONAL},
3912 {"memlimit", DATA_TYPE_UINT64, ZK_OPTIONAL},
3915 static int
3916 zfs_ioc_channel_program(const char *poolname, nvlist_t *innvl,
3917 nvlist_t *outnvl)
3919 const char *program;
3920 uint64_t instrlimit, memlimit;
3921 boolean_t sync_flag;
3922 nvpair_t *nvarg = NULL;
3924 program = fnvlist_lookup_string(innvl, ZCP_ARG_PROGRAM);
3925 if (0 != nvlist_lookup_boolean_value(innvl, ZCP_ARG_SYNC, &sync_flag)) {
3926 sync_flag = B_TRUE;
3928 if (0 != nvlist_lookup_uint64(innvl, ZCP_ARG_INSTRLIMIT, &instrlimit)) {
3929 instrlimit = ZCP_DEFAULT_INSTRLIMIT;
3931 if (0 != nvlist_lookup_uint64(innvl, ZCP_ARG_MEMLIMIT, &memlimit)) {
3932 memlimit = ZCP_DEFAULT_MEMLIMIT;
3934 nvarg = fnvlist_lookup_nvpair(innvl, ZCP_ARG_ARGLIST);
3936 if (instrlimit == 0 || instrlimit > zfs_lua_max_instrlimit)
3937 return (SET_ERROR(EINVAL));
3938 if (memlimit == 0 || memlimit > zfs_lua_max_memlimit)
3939 return (SET_ERROR(EINVAL));
3941 return (zcp_eval(poolname, program, sync_flag, instrlimit, memlimit,
3942 nvarg, outnvl));
3946 * innvl: unused
3947 * outnvl: empty
3949 static const zfs_ioc_key_t zfs_keys_pool_checkpoint[] = {
3950 /* no nvl keys */
3953 static int
3954 zfs_ioc_pool_checkpoint(const char *poolname, nvlist_t *innvl, nvlist_t *outnvl)
3956 (void) innvl, (void) outnvl;
3957 return (spa_checkpoint(poolname));
3961 * innvl: unused
3962 * outnvl: empty
3964 static const zfs_ioc_key_t zfs_keys_pool_discard_checkpoint[] = {
3965 /* no nvl keys */
3968 static int
3969 zfs_ioc_pool_discard_checkpoint(const char *poolname, nvlist_t *innvl,
3970 nvlist_t *outnvl)
3972 (void) innvl, (void) outnvl;
3973 return (spa_checkpoint_discard(poolname));
3977 * inputs:
3978 * zc_name name of dataset to destroy
3979 * zc_defer_destroy mark for deferred destroy
3981 * outputs: none
3983 static int
3984 zfs_ioc_destroy(zfs_cmd_t *zc)
3986 objset_t *os;
3987 dmu_objset_type_t ost;
3988 int err;
3990 err = dmu_objset_hold(zc->zc_name, FTAG, &os);
3991 if (err != 0)
3992 return (err);
3993 ost = dmu_objset_type(os);
3994 dmu_objset_rele(os, FTAG);
3996 if (ost == DMU_OST_ZFS)
3997 zfs_unmount_snap(zc->zc_name);
3999 if (strchr(zc->zc_name, '@')) {
4000 err = dsl_destroy_snapshot(zc->zc_name, zc->zc_defer_destroy);
4001 } else {
4002 err = dsl_destroy_head(zc->zc_name);
4003 if (err == EEXIST) {
4005 * It is possible that the given DS may have
4006 * hidden child (%recv) datasets - "leftovers"
4007 * resulting from the previously interrupted
4008 * 'zfs receive'.
4010 * 6 extra bytes for /%recv
4012 char namebuf[ZFS_MAX_DATASET_NAME_LEN + 6];
4014 if (snprintf(namebuf, sizeof (namebuf), "%s/%s",
4015 zc->zc_name, recv_clone_name) >=
4016 sizeof (namebuf))
4017 return (SET_ERROR(EINVAL));
4020 * Try to remove the hidden child (%recv) and after
4021 * that try to remove the target dataset.
4022 * If the hidden child (%recv) does not exist
4023 * the original error (EEXIST) will be returned
4025 err = dsl_destroy_head(namebuf);
4026 if (err == 0)
4027 err = dsl_destroy_head(zc->zc_name);
4028 else if (err == ENOENT)
4029 err = SET_ERROR(EEXIST);
4033 return (err);
4037 * innvl: {
4038 * "initialize_command" -> POOL_INITIALIZE_{CANCEL|START|SUSPEND} (uint64)
4039 * "initialize_vdevs": { -> guids to initialize (nvlist)
4040 * "vdev_path_1": vdev_guid_1, (uint64),
4041 * "vdev_path_2": vdev_guid_2, (uint64),
4042 * ...
4043 * },
4046 * outnvl: {
4047 * "initialize_vdevs": { -> initialization errors (nvlist)
4048 * "vdev_path_1": errno, see function body for possible errnos (uint64)
4049 * "vdev_path_2": errno, ... (uint64)
4050 * ...
4054 * EINVAL is returned for an unknown commands or if any of the provided vdev
4055 * guids have be specified with a type other than uint64.
4057 static const zfs_ioc_key_t zfs_keys_pool_initialize[] = {
4058 {ZPOOL_INITIALIZE_COMMAND, DATA_TYPE_UINT64, 0},
4059 {ZPOOL_INITIALIZE_VDEVS, DATA_TYPE_NVLIST, 0}
4062 static int
4063 zfs_ioc_pool_initialize(const char *poolname, nvlist_t *innvl, nvlist_t *outnvl)
4065 uint64_t cmd_type;
4066 if (nvlist_lookup_uint64(innvl, ZPOOL_INITIALIZE_COMMAND,
4067 &cmd_type) != 0) {
4068 return (SET_ERROR(EINVAL));
4071 if (!(cmd_type == POOL_INITIALIZE_CANCEL ||
4072 cmd_type == POOL_INITIALIZE_START ||
4073 cmd_type == POOL_INITIALIZE_SUSPEND ||
4074 cmd_type == POOL_INITIALIZE_UNINIT)) {
4075 return (SET_ERROR(EINVAL));
4078 nvlist_t *vdev_guids;
4079 if (nvlist_lookup_nvlist(innvl, ZPOOL_INITIALIZE_VDEVS,
4080 &vdev_guids) != 0) {
4081 return (SET_ERROR(EINVAL));
4084 for (nvpair_t *pair = nvlist_next_nvpair(vdev_guids, NULL);
4085 pair != NULL; pair = nvlist_next_nvpair(vdev_guids, pair)) {
4086 uint64_t vdev_guid;
4087 if (nvpair_value_uint64(pair, &vdev_guid) != 0) {
4088 return (SET_ERROR(EINVAL));
4092 spa_t *spa;
4093 int error = spa_open(poolname, &spa, FTAG);
4094 if (error != 0)
4095 return (error);
4097 nvlist_t *vdev_errlist = fnvlist_alloc();
4098 int total_errors = spa_vdev_initialize(spa, vdev_guids, cmd_type,
4099 vdev_errlist);
4101 if (fnvlist_size(vdev_errlist) > 0) {
4102 fnvlist_add_nvlist(outnvl, ZPOOL_INITIALIZE_VDEVS,
4103 vdev_errlist);
4105 fnvlist_free(vdev_errlist);
4107 spa_close(spa, FTAG);
4108 return (total_errors > 0 ? SET_ERROR(EINVAL) : 0);
4112 * innvl: {
4113 * "trim_command" -> POOL_TRIM_{CANCEL|START|SUSPEND} (uint64)
4114 * "trim_vdevs": { -> guids to TRIM (nvlist)
4115 * "vdev_path_1": vdev_guid_1, (uint64),
4116 * "vdev_path_2": vdev_guid_2, (uint64),
4117 * ...
4118 * },
4119 * "trim_rate" -> Target TRIM rate in bytes/sec.
4120 * "trim_secure" -> Set to request a secure TRIM.
4123 * outnvl: {
4124 * "trim_vdevs": { -> TRIM errors (nvlist)
4125 * "vdev_path_1": errno, see function body for possible errnos (uint64)
4126 * "vdev_path_2": errno, ... (uint64)
4127 * ...
4131 * EINVAL is returned for an unknown commands or if any of the provided vdev
4132 * guids have be specified with a type other than uint64.
4134 static const zfs_ioc_key_t zfs_keys_pool_trim[] = {
4135 {ZPOOL_TRIM_COMMAND, DATA_TYPE_UINT64, 0},
4136 {ZPOOL_TRIM_VDEVS, DATA_TYPE_NVLIST, 0},
4137 {ZPOOL_TRIM_RATE, DATA_TYPE_UINT64, ZK_OPTIONAL},
4138 {ZPOOL_TRIM_SECURE, DATA_TYPE_BOOLEAN_VALUE, ZK_OPTIONAL},
4141 static int
4142 zfs_ioc_pool_trim(const char *poolname, nvlist_t *innvl, nvlist_t *outnvl)
4144 uint64_t cmd_type;
4145 if (nvlist_lookup_uint64(innvl, ZPOOL_TRIM_COMMAND, &cmd_type) != 0)
4146 return (SET_ERROR(EINVAL));
4148 if (!(cmd_type == POOL_TRIM_CANCEL ||
4149 cmd_type == POOL_TRIM_START ||
4150 cmd_type == POOL_TRIM_SUSPEND)) {
4151 return (SET_ERROR(EINVAL));
4154 nvlist_t *vdev_guids;
4155 if (nvlist_lookup_nvlist(innvl, ZPOOL_TRIM_VDEVS, &vdev_guids) != 0)
4156 return (SET_ERROR(EINVAL));
4158 for (nvpair_t *pair = nvlist_next_nvpair(vdev_guids, NULL);
4159 pair != NULL; pair = nvlist_next_nvpair(vdev_guids, pair)) {
4160 uint64_t vdev_guid;
4161 if (nvpair_value_uint64(pair, &vdev_guid) != 0) {
4162 return (SET_ERROR(EINVAL));
4166 /* Optional, defaults to maximum rate when not provided */
4167 uint64_t rate;
4168 if (nvlist_lookup_uint64(innvl, ZPOOL_TRIM_RATE, &rate) != 0)
4169 rate = 0;
4171 /* Optional, defaults to standard TRIM when not provided */
4172 boolean_t secure;
4173 if (nvlist_lookup_boolean_value(innvl, ZPOOL_TRIM_SECURE,
4174 &secure) != 0) {
4175 secure = B_FALSE;
4178 spa_t *spa;
4179 int error = spa_open(poolname, &spa, FTAG);
4180 if (error != 0)
4181 return (error);
4183 nvlist_t *vdev_errlist = fnvlist_alloc();
4184 int total_errors = spa_vdev_trim(spa, vdev_guids, cmd_type,
4185 rate, !!zfs_trim_metaslab_skip, secure, vdev_errlist);
4187 if (fnvlist_size(vdev_errlist) > 0)
4188 fnvlist_add_nvlist(outnvl, ZPOOL_TRIM_VDEVS, vdev_errlist);
4190 fnvlist_free(vdev_errlist);
4192 spa_close(spa, FTAG);
4193 return (total_errors > 0 ? SET_ERROR(EINVAL) : 0);
4197 * This ioctl waits for activity of a particular type to complete. If there is
4198 * no activity of that type in progress, it returns immediately, and the
4199 * returned value "waited" is false. If there is activity in progress, and no
4200 * tag is passed in, the ioctl blocks until all activity of that type is
4201 * complete, and then returns with "waited" set to true.
4203 * If a tag is provided, it identifies a particular instance of an activity to
4204 * wait for. Currently, this is only valid for use with 'initialize', because
4205 * that is the only activity for which there can be multiple instances running
4206 * concurrently. In the case of 'initialize', the tag corresponds to the guid of
4207 * the vdev on which to wait.
4209 * If a thread waiting in the ioctl receives a signal, the call will return
4210 * immediately, and the return value will be EINTR.
4212 * innvl: {
4213 * "wait_activity" -> int32_t
4214 * (optional) "wait_tag" -> uint64_t
4217 * outnvl: "waited" -> boolean_t
4219 static const zfs_ioc_key_t zfs_keys_pool_wait[] = {
4220 {ZPOOL_WAIT_ACTIVITY, DATA_TYPE_INT32, 0},
4221 {ZPOOL_WAIT_TAG, DATA_TYPE_UINT64, ZK_OPTIONAL},
4224 static int
4225 zfs_ioc_wait(const char *name, nvlist_t *innvl, nvlist_t *outnvl)
4227 int32_t activity;
4228 uint64_t tag;
4229 boolean_t waited;
4230 int error;
4232 if (nvlist_lookup_int32(innvl, ZPOOL_WAIT_ACTIVITY, &activity) != 0)
4233 return (EINVAL);
4235 if (nvlist_lookup_uint64(innvl, ZPOOL_WAIT_TAG, &tag) == 0)
4236 error = spa_wait_tag(name, activity, tag, &waited);
4237 else
4238 error = spa_wait(name, activity, &waited);
4240 if (error == 0)
4241 fnvlist_add_boolean_value(outnvl, ZPOOL_WAIT_WAITED, waited);
4243 return (error);
4247 * This ioctl waits for activity of a particular type to complete. If there is
4248 * no activity of that type in progress, it returns immediately, and the
4249 * returned value "waited" is false. If there is activity in progress, and no
4250 * tag is passed in, the ioctl blocks until all activity of that type is
4251 * complete, and then returns with "waited" set to true.
4253 * If a thread waiting in the ioctl receives a signal, the call will return
4254 * immediately, and the return value will be EINTR.
4256 * innvl: {
4257 * "wait_activity" -> int32_t
4260 * outnvl: "waited" -> boolean_t
4262 static const zfs_ioc_key_t zfs_keys_fs_wait[] = {
4263 {ZFS_WAIT_ACTIVITY, DATA_TYPE_INT32, 0},
4266 static int
4267 zfs_ioc_wait_fs(const char *name, nvlist_t *innvl, nvlist_t *outnvl)
4269 int32_t activity;
4270 boolean_t waited = B_FALSE;
4271 int error;
4272 dsl_pool_t *dp;
4273 dsl_dir_t *dd;
4274 dsl_dataset_t *ds;
4276 if (nvlist_lookup_int32(innvl, ZFS_WAIT_ACTIVITY, &activity) != 0)
4277 return (SET_ERROR(EINVAL));
4279 if (activity >= ZFS_WAIT_NUM_ACTIVITIES || activity < 0)
4280 return (SET_ERROR(EINVAL));
4282 if ((error = dsl_pool_hold(name, FTAG, &dp)) != 0)
4283 return (error);
4285 if ((error = dsl_dataset_hold(dp, name, FTAG, &ds)) != 0) {
4286 dsl_pool_rele(dp, FTAG);
4287 return (error);
4290 dd = ds->ds_dir;
4291 mutex_enter(&dd->dd_activity_lock);
4292 dd->dd_activity_waiters++;
4295 * We get a long-hold here so that the dsl_dataset_t and dsl_dir_t
4296 * aren't evicted while we're waiting. Normally this is prevented by
4297 * holding the pool, but we can't do that while we're waiting since
4298 * that would prevent TXGs from syncing out. Some of the functionality
4299 * of long-holds (e.g. preventing deletion) is unnecessary for this
4300 * case, since we would cancel the waiters before proceeding with a
4301 * deletion. An alternative mechanism for keeping the dataset around
4302 * could be developed but this is simpler.
4304 dsl_dataset_long_hold(ds, FTAG);
4305 dsl_pool_rele(dp, FTAG);
4307 error = dsl_dir_wait(dd, ds, activity, &waited);
4309 dsl_dataset_long_rele(ds, FTAG);
4310 dd->dd_activity_waiters--;
4311 if (dd->dd_activity_waiters == 0)
4312 cv_signal(&dd->dd_activity_cv);
4313 mutex_exit(&dd->dd_activity_lock);
4315 dsl_dataset_rele(ds, FTAG);
4317 if (error == 0)
4318 fnvlist_add_boolean_value(outnvl, ZFS_WAIT_WAITED, waited);
4320 return (error);
4324 * fsname is name of dataset to rollback (to most recent snapshot)
4326 * innvl may contain name of expected target snapshot
4328 * outnvl: "target" -> name of most recent snapshot
4331 static const zfs_ioc_key_t zfs_keys_rollback[] = {
4332 {"target", DATA_TYPE_STRING, ZK_OPTIONAL},
4335 static int
4336 zfs_ioc_rollback(const char *fsname, nvlist_t *innvl, nvlist_t *outnvl)
4338 zfsvfs_t *zfsvfs;
4339 zvol_state_handle_t *zv;
4340 const char *target = NULL;
4341 int error;
4343 (void) nvlist_lookup_string(innvl, "target", &target);
4344 if (target != NULL) {
4345 const char *cp = strchr(target, '@');
4348 * The snap name must contain an @, and the part after it must
4349 * contain only valid characters.
4351 if (cp == NULL ||
4352 zfs_component_namecheck(cp + 1, NULL, NULL) != 0)
4353 return (SET_ERROR(EINVAL));
4356 if (getzfsvfs(fsname, &zfsvfs) == 0) {
4357 dsl_dataset_t *ds;
4359 ds = dmu_objset_ds(zfsvfs->z_os);
4360 error = zfs_suspend_fs(zfsvfs);
4361 if (error == 0) {
4362 int resume_err;
4364 error = dsl_dataset_rollback(fsname, target, zfsvfs,
4365 outnvl);
4366 resume_err = zfs_resume_fs(zfsvfs, ds);
4367 error = error ? error : resume_err;
4369 zfs_vfs_rele(zfsvfs);
4370 } else if ((zv = zvol_suspend(fsname)) != NULL) {
4371 error = dsl_dataset_rollback(fsname, target, zvol_tag(zv),
4372 outnvl);
4373 zvol_resume(zv);
4374 } else {
4375 error = dsl_dataset_rollback(fsname, target, NULL, outnvl);
4377 return (error);
4380 static int
4381 recursive_unmount(const char *fsname, void *arg)
4383 const char *snapname = arg;
4384 char *fullname;
4386 fullname = kmem_asprintf("%s@%s", fsname, snapname);
4387 zfs_unmount_snap(fullname);
4388 kmem_strfree(fullname);
4390 return (0);
4395 * snapname is the snapshot to redact.
4396 * innvl: {
4397 * "bookname" -> (string)
4398 * shortname of the redaction bookmark to generate
4399 * "snapnv" -> (nvlist, values ignored)
4400 * snapshots to redact snapname with respect to
4403 * outnvl is unused
4406 static const zfs_ioc_key_t zfs_keys_redact[] = {
4407 {"bookname", DATA_TYPE_STRING, 0},
4408 {"snapnv", DATA_TYPE_NVLIST, 0},
4411 static int
4412 zfs_ioc_redact(const char *snapname, nvlist_t *innvl, nvlist_t *outnvl)
4414 (void) outnvl;
4415 nvlist_t *redactnvl = NULL;
4416 const char *redactbook = NULL;
4418 if (nvlist_lookup_nvlist(innvl, "snapnv", &redactnvl) != 0)
4419 return (SET_ERROR(EINVAL));
4420 if (fnvlist_num_pairs(redactnvl) == 0)
4421 return (SET_ERROR(ENXIO));
4422 if (nvlist_lookup_string(innvl, "bookname", &redactbook) != 0)
4423 return (SET_ERROR(EINVAL));
4425 return (dmu_redact_snap(snapname, redactnvl, redactbook));
4429 * inputs:
4430 * zc_name old name of dataset
4431 * zc_value new name of dataset
4432 * zc_cookie recursive flag (only valid for snapshots)
4434 * outputs: none
4436 static int
4437 zfs_ioc_rename(zfs_cmd_t *zc)
4439 objset_t *os;
4440 dmu_objset_type_t ost;
4441 boolean_t recursive = zc->zc_cookie & 1;
4442 boolean_t nounmount = !!(zc->zc_cookie & 2);
4443 char *at;
4444 int err;
4446 /* "zfs rename" from and to ...%recv datasets should both fail */
4447 zc->zc_name[sizeof (zc->zc_name) - 1] = '\0';
4448 zc->zc_value[sizeof (zc->zc_value) - 1] = '\0';
4449 if (dataset_namecheck(zc->zc_name, NULL, NULL) != 0 ||
4450 dataset_namecheck(zc->zc_value, NULL, NULL) != 0 ||
4451 strchr(zc->zc_name, '%') || strchr(zc->zc_value, '%'))
4452 return (SET_ERROR(EINVAL));
4454 err = dmu_objset_hold(zc->zc_name, FTAG, &os);
4455 if (err != 0)
4456 return (err);
4457 ost = dmu_objset_type(os);
4458 dmu_objset_rele(os, FTAG);
4460 at = strchr(zc->zc_name, '@');
4461 if (at != NULL) {
4462 /* snaps must be in same fs */
4463 int error;
4465 if (strncmp(zc->zc_name, zc->zc_value, at - zc->zc_name + 1))
4466 return (SET_ERROR(EXDEV));
4467 *at = '\0';
4468 if (ost == DMU_OST_ZFS && !nounmount) {
4469 error = dmu_objset_find(zc->zc_name,
4470 recursive_unmount, at + 1,
4471 recursive ? DS_FIND_CHILDREN : 0);
4472 if (error != 0) {
4473 *at = '@';
4474 return (error);
4477 error = dsl_dataset_rename_snapshot(zc->zc_name,
4478 at + 1, strchr(zc->zc_value, '@') + 1, recursive);
4479 *at = '@';
4481 return (error);
4482 } else {
4483 return (dsl_dir_rename(zc->zc_name, zc->zc_value));
4487 static int
4488 zfs_check_settable(const char *dsname, nvpair_t *pair, cred_t *cr)
4490 const char *propname = nvpair_name(pair);
4491 boolean_t issnap = (strchr(dsname, '@') != NULL);
4492 zfs_prop_t prop = zfs_name_to_prop(propname);
4493 uint64_t intval, compval;
4494 int err;
4496 if (prop == ZPROP_USERPROP) {
4497 if (zfs_prop_user(propname)) {
4498 if ((err = zfs_secpolicy_write_perms(dsname,
4499 ZFS_DELEG_PERM_USERPROP, cr)))
4500 return (err);
4501 return (0);
4504 if (!issnap && zfs_prop_userquota(propname)) {
4505 const char *perm = NULL;
4506 const char *uq_prefix =
4507 zfs_userquota_prop_prefixes[ZFS_PROP_USERQUOTA];
4508 const char *gq_prefix =
4509 zfs_userquota_prop_prefixes[ZFS_PROP_GROUPQUOTA];
4510 const char *uiq_prefix =
4511 zfs_userquota_prop_prefixes[ZFS_PROP_USEROBJQUOTA];
4512 const char *giq_prefix =
4513 zfs_userquota_prop_prefixes[ZFS_PROP_GROUPOBJQUOTA];
4514 const char *pq_prefix =
4515 zfs_userquota_prop_prefixes[ZFS_PROP_PROJECTQUOTA];
4516 const char *piq_prefix = zfs_userquota_prop_prefixes[\
4517 ZFS_PROP_PROJECTOBJQUOTA];
4519 if (strncmp(propname, uq_prefix,
4520 strlen(uq_prefix)) == 0) {
4521 perm = ZFS_DELEG_PERM_USERQUOTA;
4522 } else if (strncmp(propname, uiq_prefix,
4523 strlen(uiq_prefix)) == 0) {
4524 perm = ZFS_DELEG_PERM_USEROBJQUOTA;
4525 } else if (strncmp(propname, gq_prefix,
4526 strlen(gq_prefix)) == 0) {
4527 perm = ZFS_DELEG_PERM_GROUPQUOTA;
4528 } else if (strncmp(propname, giq_prefix,
4529 strlen(giq_prefix)) == 0) {
4530 perm = ZFS_DELEG_PERM_GROUPOBJQUOTA;
4531 } else if (strncmp(propname, pq_prefix,
4532 strlen(pq_prefix)) == 0) {
4533 perm = ZFS_DELEG_PERM_PROJECTQUOTA;
4534 } else if (strncmp(propname, piq_prefix,
4535 strlen(piq_prefix)) == 0) {
4536 perm = ZFS_DELEG_PERM_PROJECTOBJQUOTA;
4537 } else {
4538 /* {USER|GROUP|PROJECT}USED are read-only */
4539 return (SET_ERROR(EINVAL));
4542 if ((err = zfs_secpolicy_write_perms(dsname, perm, cr)))
4543 return (err);
4544 return (0);
4547 return (SET_ERROR(EINVAL));
4550 if (issnap)
4551 return (SET_ERROR(EINVAL));
4553 if (nvpair_type(pair) == DATA_TYPE_NVLIST) {
4555 * dsl_prop_get_all_impl() returns properties in this
4556 * format.
4558 nvlist_t *attrs;
4559 VERIFY(nvpair_value_nvlist(pair, &attrs) == 0);
4560 VERIFY(nvlist_lookup_nvpair(attrs, ZPROP_VALUE,
4561 &pair) == 0);
4565 * Check that this value is valid for this pool version
4567 switch (prop) {
4568 case ZFS_PROP_COMPRESSION:
4570 * If the user specified gzip compression, make sure
4571 * the SPA supports it. We ignore any errors here since
4572 * we'll catch them later.
4574 if (nvpair_value_uint64(pair, &intval) == 0) {
4575 compval = ZIO_COMPRESS_ALGO(intval);
4576 if (compval >= ZIO_COMPRESS_GZIP_1 &&
4577 compval <= ZIO_COMPRESS_GZIP_9 &&
4578 zfs_earlier_version(dsname,
4579 SPA_VERSION_GZIP_COMPRESSION)) {
4580 return (SET_ERROR(ENOTSUP));
4583 if (compval == ZIO_COMPRESS_ZLE &&
4584 zfs_earlier_version(dsname,
4585 SPA_VERSION_ZLE_COMPRESSION))
4586 return (SET_ERROR(ENOTSUP));
4588 if (compval == ZIO_COMPRESS_LZ4) {
4589 spa_t *spa;
4591 if ((err = spa_open(dsname, &spa, FTAG)) != 0)
4592 return (err);
4594 if (!spa_feature_is_enabled(spa,
4595 SPA_FEATURE_LZ4_COMPRESS)) {
4596 spa_close(spa, FTAG);
4597 return (SET_ERROR(ENOTSUP));
4599 spa_close(spa, FTAG);
4602 if (compval == ZIO_COMPRESS_ZSTD) {
4603 spa_t *spa;
4605 if ((err = spa_open(dsname, &spa, FTAG)) != 0)
4606 return (err);
4608 if (!spa_feature_is_enabled(spa,
4609 SPA_FEATURE_ZSTD_COMPRESS)) {
4610 spa_close(spa, FTAG);
4611 return (SET_ERROR(ENOTSUP));
4613 spa_close(spa, FTAG);
4616 break;
4618 case ZFS_PROP_COPIES:
4619 if (zfs_earlier_version(dsname, SPA_VERSION_DITTO_BLOCKS))
4620 return (SET_ERROR(ENOTSUP));
4621 break;
4623 case ZFS_PROP_VOLBLOCKSIZE:
4624 case ZFS_PROP_RECORDSIZE:
4625 /* Record sizes above 128k need the feature to be enabled */
4626 if (nvpair_value_uint64(pair, &intval) == 0 &&
4627 intval > SPA_OLD_MAXBLOCKSIZE) {
4628 spa_t *spa;
4631 * We don't allow setting the property above 1MB,
4632 * unless the tunable has been changed.
4634 if (intval > zfs_max_recordsize ||
4635 intval > SPA_MAXBLOCKSIZE)
4636 return (SET_ERROR(ERANGE));
4638 if ((err = spa_open(dsname, &spa, FTAG)) != 0)
4639 return (err);
4641 if (!spa_feature_is_enabled(spa,
4642 SPA_FEATURE_LARGE_BLOCKS)) {
4643 spa_close(spa, FTAG);
4644 return (SET_ERROR(ENOTSUP));
4646 spa_close(spa, FTAG);
4648 break;
4650 case ZFS_PROP_DNODESIZE:
4651 /* Dnode sizes above 512 need the feature to be enabled */
4652 if (nvpair_value_uint64(pair, &intval) == 0 &&
4653 intval != ZFS_DNSIZE_LEGACY) {
4654 spa_t *spa;
4656 if ((err = spa_open(dsname, &spa, FTAG)) != 0)
4657 return (err);
4659 if (!spa_feature_is_enabled(spa,
4660 SPA_FEATURE_LARGE_DNODE)) {
4661 spa_close(spa, FTAG);
4662 return (SET_ERROR(ENOTSUP));
4664 spa_close(spa, FTAG);
4666 break;
4668 case ZFS_PROP_SPECIAL_SMALL_BLOCKS:
4670 * This property could require the allocation classes
4671 * feature to be active for setting, however we allow
4672 * it so that tests of settable properties succeed.
4673 * The CLI will issue a warning in this case.
4675 break;
4677 case ZFS_PROP_SHARESMB:
4678 if (zpl_earlier_version(dsname, ZPL_VERSION_FUID))
4679 return (SET_ERROR(ENOTSUP));
4680 break;
4682 case ZFS_PROP_ACLINHERIT:
4683 if (nvpair_type(pair) == DATA_TYPE_UINT64 &&
4684 nvpair_value_uint64(pair, &intval) == 0) {
4685 if (intval == ZFS_ACL_PASSTHROUGH_X &&
4686 zfs_earlier_version(dsname,
4687 SPA_VERSION_PASSTHROUGH_X))
4688 return (SET_ERROR(ENOTSUP));
4690 break;
4691 case ZFS_PROP_CHECKSUM:
4692 case ZFS_PROP_DEDUP:
4694 spa_feature_t feature;
4695 spa_t *spa;
4696 int err;
4698 /* dedup feature version checks */
4699 if (prop == ZFS_PROP_DEDUP &&
4700 zfs_earlier_version(dsname, SPA_VERSION_DEDUP))
4701 return (SET_ERROR(ENOTSUP));
4703 if (nvpair_type(pair) == DATA_TYPE_UINT64 &&
4704 nvpair_value_uint64(pair, &intval) == 0) {
4705 /* check prop value is enabled in features */
4706 feature = zio_checksum_to_feature(
4707 intval & ZIO_CHECKSUM_MASK);
4708 if (feature == SPA_FEATURE_NONE)
4709 break;
4711 if ((err = spa_open(dsname, &spa, FTAG)) != 0)
4712 return (err);
4714 if (!spa_feature_is_enabled(spa, feature)) {
4715 spa_close(spa, FTAG);
4716 return (SET_ERROR(ENOTSUP));
4718 spa_close(spa, FTAG);
4720 break;
4723 default:
4724 break;
4727 return (zfs_secpolicy_setprop(dsname, prop, pair, CRED()));
4731 * Removes properties from the given props list that fail permission checks
4732 * needed to clear them and to restore them in case of a receive error. For each
4733 * property, make sure we have both set and inherit permissions.
4735 * Returns the first error encountered if any permission checks fail. If the
4736 * caller provides a non-NULL errlist, it also gives the complete list of names
4737 * of all the properties that failed a permission check along with the
4738 * corresponding error numbers. The caller is responsible for freeing the
4739 * returned errlist.
4741 * If every property checks out successfully, zero is returned and the list
4742 * pointed at by errlist is NULL.
4744 static int
4745 zfs_check_clearable(const char *dataset, nvlist_t *props, nvlist_t **errlist)
4747 zfs_cmd_t *zc;
4748 nvpair_t *pair, *next_pair;
4749 nvlist_t *errors;
4750 int err, rv = 0;
4752 if (props == NULL)
4753 return (0);
4755 VERIFY(nvlist_alloc(&errors, NV_UNIQUE_NAME, KM_SLEEP) == 0);
4757 zc = kmem_alloc(sizeof (zfs_cmd_t), KM_SLEEP);
4758 (void) strlcpy(zc->zc_name, dataset, sizeof (zc->zc_name));
4759 pair = nvlist_next_nvpair(props, NULL);
4760 while (pair != NULL) {
4761 next_pair = nvlist_next_nvpair(props, pair);
4763 (void) strlcpy(zc->zc_value, nvpair_name(pair),
4764 sizeof (zc->zc_value));
4765 if ((err = zfs_check_settable(dataset, pair, CRED())) != 0 ||
4766 (err = zfs_secpolicy_inherit_prop(zc, NULL, CRED())) != 0) {
4767 VERIFY(nvlist_remove_nvpair(props, pair) == 0);
4768 VERIFY(nvlist_add_int32(errors,
4769 zc->zc_value, err) == 0);
4771 pair = next_pair;
4773 kmem_free(zc, sizeof (zfs_cmd_t));
4775 if ((pair = nvlist_next_nvpair(errors, NULL)) == NULL) {
4776 nvlist_free(errors);
4777 errors = NULL;
4778 } else {
4779 VERIFY(nvpair_value_int32(pair, &rv) == 0);
4782 if (errlist == NULL)
4783 nvlist_free(errors);
4784 else
4785 *errlist = errors;
4787 return (rv);
4790 static boolean_t
4791 propval_equals(nvpair_t *p1, nvpair_t *p2)
4793 if (nvpair_type(p1) == DATA_TYPE_NVLIST) {
4794 /* dsl_prop_get_all_impl() format */
4795 nvlist_t *attrs;
4796 VERIFY(nvpair_value_nvlist(p1, &attrs) == 0);
4797 VERIFY(nvlist_lookup_nvpair(attrs, ZPROP_VALUE,
4798 &p1) == 0);
4801 if (nvpair_type(p2) == DATA_TYPE_NVLIST) {
4802 nvlist_t *attrs;
4803 VERIFY(nvpair_value_nvlist(p2, &attrs) == 0);
4804 VERIFY(nvlist_lookup_nvpair(attrs, ZPROP_VALUE,
4805 &p2) == 0);
4808 if (nvpair_type(p1) != nvpair_type(p2))
4809 return (B_FALSE);
4811 if (nvpair_type(p1) == DATA_TYPE_STRING) {
4812 const char *valstr1, *valstr2;
4814 VERIFY(nvpair_value_string(p1, &valstr1) == 0);
4815 VERIFY(nvpair_value_string(p2, &valstr2) == 0);
4816 return (strcmp(valstr1, valstr2) == 0);
4817 } else {
4818 uint64_t intval1, intval2;
4820 VERIFY(nvpair_value_uint64(p1, &intval1) == 0);
4821 VERIFY(nvpair_value_uint64(p2, &intval2) == 0);
4822 return (intval1 == intval2);
4827 * Remove properties from props if they are not going to change (as determined
4828 * by comparison with origprops). Remove them from origprops as well, since we
4829 * do not need to clear or restore properties that won't change.
4831 static void
4832 props_reduce(nvlist_t *props, nvlist_t *origprops)
4834 nvpair_t *pair, *next_pair;
4836 if (origprops == NULL)
4837 return; /* all props need to be received */
4839 pair = nvlist_next_nvpair(props, NULL);
4840 while (pair != NULL) {
4841 const char *propname = nvpair_name(pair);
4842 nvpair_t *match;
4844 next_pair = nvlist_next_nvpair(props, pair);
4846 if ((nvlist_lookup_nvpair(origprops, propname,
4847 &match) != 0) || !propval_equals(pair, match))
4848 goto next; /* need to set received value */
4850 /* don't clear the existing received value */
4851 (void) nvlist_remove_nvpair(origprops, match);
4852 /* don't bother receiving the property */
4853 (void) nvlist_remove_nvpair(props, pair);
4854 next:
4855 pair = next_pair;
4860 * Extract properties that cannot be set PRIOR to the receipt of a dataset.
4861 * For example, refquota cannot be set until after the receipt of a dataset,
4862 * because in replication streams, an older/earlier snapshot may exceed the
4863 * refquota. We want to receive the older/earlier snapshot, but setting
4864 * refquota pre-receipt will set the dsl's ACTUAL quota, which will prevent
4865 * the older/earlier snapshot from being received (with EDQUOT).
4867 * The ZFS test "zfs_receive_011_pos" demonstrates such a scenario.
4869 * libzfs will need to be judicious handling errors encountered by props
4870 * extracted by this function.
4872 static nvlist_t *
4873 extract_delay_props(nvlist_t *props)
4875 nvlist_t *delayprops;
4876 nvpair_t *nvp, *tmp;
4877 static const zfs_prop_t delayable[] = {
4878 ZFS_PROP_REFQUOTA,
4879 ZFS_PROP_KEYLOCATION,
4881 * Setting ZFS_PROP_SHARESMB requires the objset type to be
4882 * known, which is not possible prior to receipt of raw sends.
4884 ZFS_PROP_SHARESMB,
4887 int i;
4889 VERIFY(nvlist_alloc(&delayprops, NV_UNIQUE_NAME, KM_SLEEP) == 0);
4891 for (nvp = nvlist_next_nvpair(props, NULL); nvp != NULL;
4892 nvp = nvlist_next_nvpair(props, nvp)) {
4894 * strcmp() is safe because zfs_prop_to_name() always returns
4895 * a bounded string.
4897 for (i = 0; delayable[i] != 0; i++) {
4898 if (strcmp(zfs_prop_to_name(delayable[i]),
4899 nvpair_name(nvp)) == 0) {
4900 break;
4903 if (delayable[i] != 0) {
4904 tmp = nvlist_prev_nvpair(props, nvp);
4905 VERIFY(nvlist_add_nvpair(delayprops, nvp) == 0);
4906 VERIFY(nvlist_remove_nvpair(props, nvp) == 0);
4907 nvp = tmp;
4911 if (nvlist_empty(delayprops)) {
4912 nvlist_free(delayprops);
4913 delayprops = NULL;
4915 return (delayprops);
4918 static void
4919 zfs_allow_log_destroy(void *arg)
4921 char *poolname = arg;
4923 if (poolname != NULL)
4924 kmem_strfree(poolname);
4927 #ifdef ZFS_DEBUG
4928 static boolean_t zfs_ioc_recv_inject_err;
4929 #endif
4932 * nvlist 'errors' is always allocated. It will contain descriptions of
4933 * encountered errors, if any. It's the callers responsibility to free.
4935 static int
4936 zfs_ioc_recv_impl(char *tofs, char *tosnap, const char *origin,
4937 nvlist_t *recvprops, nvlist_t *localprops, nvlist_t *hidden_args,
4938 boolean_t force, boolean_t heal, boolean_t resumable, int input_fd,
4939 dmu_replay_record_t *begin_record, uint64_t *read_bytes,
4940 uint64_t *errflags, nvlist_t **errors)
4942 dmu_recv_cookie_t drc;
4943 int error = 0;
4944 int props_error = 0;
4945 offset_t off, noff;
4946 nvlist_t *local_delayprops = NULL;
4947 nvlist_t *recv_delayprops = NULL;
4948 nvlist_t *inherited_delayprops = NULL;
4949 nvlist_t *origprops = NULL; /* existing properties */
4950 nvlist_t *origrecvd = NULL; /* existing received properties */
4951 boolean_t first_recvd_props = B_FALSE;
4952 boolean_t tofs_was_redacted;
4953 zfs_file_t *input_fp;
4955 *read_bytes = 0;
4956 *errflags = 0;
4957 *errors = fnvlist_alloc();
4958 off = 0;
4960 if ((input_fp = zfs_file_get(input_fd)) == NULL)
4961 return (SET_ERROR(EBADF));
4963 noff = off = zfs_file_off(input_fp);
4964 error = dmu_recv_begin(tofs, tosnap, begin_record, force, heal,
4965 resumable, localprops, hidden_args, origin, &drc, input_fp,
4966 &off);
4967 if (error != 0)
4968 goto out;
4969 tofs_was_redacted = dsl_get_redacted(drc.drc_ds);
4972 * Set properties before we receive the stream so that they are applied
4973 * to the new data. Note that we must call dmu_recv_stream() if
4974 * dmu_recv_begin() succeeds.
4976 if (recvprops != NULL && !drc.drc_newfs) {
4977 if (spa_version(dsl_dataset_get_spa(drc.drc_ds)) >=
4978 SPA_VERSION_RECVD_PROPS &&
4979 !dsl_prop_get_hasrecvd(tofs))
4980 first_recvd_props = B_TRUE;
4983 * If new received properties are supplied, they are to
4984 * completely replace the existing received properties,
4985 * so stash away the existing ones.
4987 if (dsl_prop_get_received(tofs, &origrecvd) == 0) {
4988 nvlist_t *errlist = NULL;
4990 * Don't bother writing a property if its value won't
4991 * change (and avoid the unnecessary security checks).
4993 * The first receive after SPA_VERSION_RECVD_PROPS is a
4994 * special case where we blow away all local properties
4995 * regardless.
4997 if (!first_recvd_props)
4998 props_reduce(recvprops, origrecvd);
4999 if (zfs_check_clearable(tofs, origrecvd, &errlist) != 0)
5000 (void) nvlist_merge(*errors, errlist, 0);
5001 nvlist_free(errlist);
5003 if (clear_received_props(tofs, origrecvd,
5004 first_recvd_props ? NULL : recvprops) != 0)
5005 *errflags |= ZPROP_ERR_NOCLEAR;
5006 } else {
5007 *errflags |= ZPROP_ERR_NOCLEAR;
5012 * Stash away existing properties so we can restore them on error unless
5013 * we're doing the first receive after SPA_VERSION_RECVD_PROPS, in which
5014 * case "origrecvd" will take care of that.
5016 if (localprops != NULL && !drc.drc_newfs && !first_recvd_props) {
5017 objset_t *os;
5018 if (dmu_objset_hold(tofs, FTAG, &os) == 0) {
5019 if (dsl_prop_get_all(os, &origprops) != 0) {
5020 *errflags |= ZPROP_ERR_NOCLEAR;
5022 dmu_objset_rele(os, FTAG);
5023 } else {
5024 *errflags |= ZPROP_ERR_NOCLEAR;
5028 if (recvprops != NULL) {
5029 props_error = dsl_prop_set_hasrecvd(tofs);
5031 if (props_error == 0) {
5032 recv_delayprops = extract_delay_props(recvprops);
5033 (void) zfs_set_prop_nvlist(tofs, ZPROP_SRC_RECEIVED,
5034 recvprops, *errors);
5038 if (localprops != NULL) {
5039 nvlist_t *oprops = fnvlist_alloc();
5040 nvlist_t *xprops = fnvlist_alloc();
5041 nvpair_t *nvp = NULL;
5043 while ((nvp = nvlist_next_nvpair(localprops, nvp)) != NULL) {
5044 if (nvpair_type(nvp) == DATA_TYPE_BOOLEAN) {
5045 /* -x property */
5046 const char *name = nvpair_name(nvp);
5047 zfs_prop_t prop = zfs_name_to_prop(name);
5048 if (prop != ZPROP_USERPROP) {
5049 if (!zfs_prop_inheritable(prop))
5050 continue;
5051 } else if (!zfs_prop_user(name))
5052 continue;
5053 fnvlist_add_boolean(xprops, name);
5054 } else {
5055 /* -o property=value */
5056 fnvlist_add_nvpair(oprops, nvp);
5060 local_delayprops = extract_delay_props(oprops);
5061 (void) zfs_set_prop_nvlist(tofs, ZPROP_SRC_LOCAL,
5062 oprops, *errors);
5063 inherited_delayprops = extract_delay_props(xprops);
5064 (void) zfs_set_prop_nvlist(tofs, ZPROP_SRC_INHERITED,
5065 xprops, *errors);
5067 nvlist_free(oprops);
5068 nvlist_free(xprops);
5071 error = dmu_recv_stream(&drc, &off);
5073 if (error == 0) {
5074 zfsvfs_t *zfsvfs = NULL;
5075 zvol_state_handle_t *zv = NULL;
5077 if (getzfsvfs(tofs, &zfsvfs) == 0) {
5078 /* online recv */
5079 dsl_dataset_t *ds;
5080 int end_err;
5081 boolean_t stream_is_redacted = DMU_GET_FEATUREFLAGS(
5082 begin_record->drr_u.drr_begin.
5083 drr_versioninfo) & DMU_BACKUP_FEATURE_REDACTED;
5085 ds = dmu_objset_ds(zfsvfs->z_os);
5086 error = zfs_suspend_fs(zfsvfs);
5088 * If the suspend fails, then the recv_end will
5089 * likely also fail, and clean up after itself.
5091 end_err = dmu_recv_end(&drc, zfsvfs);
5093 * If the dataset was not redacted, but we received a
5094 * redacted stream onto it, we need to unmount the
5095 * dataset. Otherwise, resume the filesystem.
5097 if (error == 0 && !drc.drc_newfs &&
5098 stream_is_redacted && !tofs_was_redacted) {
5099 error = zfs_end_fs(zfsvfs, ds);
5100 } else if (error == 0) {
5101 error = zfs_resume_fs(zfsvfs, ds);
5103 error = error ? error : end_err;
5104 zfs_vfs_rele(zfsvfs);
5105 } else if ((zv = zvol_suspend(tofs)) != NULL) {
5106 error = dmu_recv_end(&drc, zvol_tag(zv));
5107 zvol_resume(zv);
5108 } else {
5109 error = dmu_recv_end(&drc, NULL);
5112 /* Set delayed properties now, after we're done receiving. */
5113 if (recv_delayprops != NULL && error == 0) {
5114 (void) zfs_set_prop_nvlist(tofs, ZPROP_SRC_RECEIVED,
5115 recv_delayprops, *errors);
5117 if (local_delayprops != NULL && error == 0) {
5118 (void) zfs_set_prop_nvlist(tofs, ZPROP_SRC_LOCAL,
5119 local_delayprops, *errors);
5121 if (inherited_delayprops != NULL && error == 0) {
5122 (void) zfs_set_prop_nvlist(tofs, ZPROP_SRC_INHERITED,
5123 inherited_delayprops, *errors);
5128 * Merge delayed props back in with initial props, in case
5129 * we're DEBUG and zfs_ioc_recv_inject_err is set (which means
5130 * we have to make sure clear_received_props() includes
5131 * the delayed properties).
5133 * Since zfs_ioc_recv_inject_err is only in DEBUG kernels,
5134 * using ASSERT() will be just like a VERIFY.
5136 if (recv_delayprops != NULL) {
5137 ASSERT(nvlist_merge(recvprops, recv_delayprops, 0) == 0);
5138 nvlist_free(recv_delayprops);
5140 if (local_delayprops != NULL) {
5141 ASSERT(nvlist_merge(localprops, local_delayprops, 0) == 0);
5142 nvlist_free(local_delayprops);
5144 if (inherited_delayprops != NULL) {
5145 ASSERT(nvlist_merge(localprops, inherited_delayprops, 0) == 0);
5146 nvlist_free(inherited_delayprops);
5148 *read_bytes = off - noff;
5150 #ifdef ZFS_DEBUG
5151 if (zfs_ioc_recv_inject_err) {
5152 zfs_ioc_recv_inject_err = B_FALSE;
5153 error = 1;
5155 #endif
5158 * On error, restore the original props.
5160 if (error != 0 && recvprops != NULL && !drc.drc_newfs) {
5161 if (clear_received_props(tofs, recvprops, NULL) != 0) {
5163 * We failed to clear the received properties.
5164 * Since we may have left a $recvd value on the
5165 * system, we can't clear the $hasrecvd flag.
5167 *errflags |= ZPROP_ERR_NORESTORE;
5168 } else if (first_recvd_props) {
5169 dsl_prop_unset_hasrecvd(tofs);
5172 if (origrecvd == NULL && !drc.drc_newfs) {
5173 /* We failed to stash the original properties. */
5174 *errflags |= ZPROP_ERR_NORESTORE;
5178 * dsl_props_set() will not convert RECEIVED to LOCAL on or
5179 * after SPA_VERSION_RECVD_PROPS, so we need to specify LOCAL
5180 * explicitly if we're restoring local properties cleared in the
5181 * first new-style receive.
5183 if (origrecvd != NULL &&
5184 zfs_set_prop_nvlist(tofs, (first_recvd_props ?
5185 ZPROP_SRC_LOCAL : ZPROP_SRC_RECEIVED),
5186 origrecvd, NULL) != 0) {
5188 * We stashed the original properties but failed to
5189 * restore them.
5191 *errflags |= ZPROP_ERR_NORESTORE;
5194 if (error != 0 && localprops != NULL && !drc.drc_newfs &&
5195 !first_recvd_props) {
5196 nvlist_t *setprops;
5197 nvlist_t *inheritprops;
5198 nvpair_t *nvp;
5200 if (origprops == NULL) {
5201 /* We failed to stash the original properties. */
5202 *errflags |= ZPROP_ERR_NORESTORE;
5203 goto out;
5206 /* Restore original props */
5207 setprops = fnvlist_alloc();
5208 inheritprops = fnvlist_alloc();
5209 nvp = NULL;
5210 while ((nvp = nvlist_next_nvpair(localprops, nvp)) != NULL) {
5211 const char *name = nvpair_name(nvp);
5212 const char *source;
5213 nvlist_t *attrs;
5215 if (!nvlist_exists(origprops, name)) {
5217 * Property was not present or was explicitly
5218 * inherited before the receive, restore this.
5220 fnvlist_add_boolean(inheritprops, name);
5221 continue;
5223 attrs = fnvlist_lookup_nvlist(origprops, name);
5224 source = fnvlist_lookup_string(attrs, ZPROP_SOURCE);
5226 /* Skip received properties */
5227 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0)
5228 continue;
5230 if (strcmp(source, tofs) == 0) {
5231 /* Property was locally set */
5232 fnvlist_add_nvlist(setprops, name, attrs);
5233 } else {
5234 /* Property was implicitly inherited */
5235 fnvlist_add_boolean(inheritprops, name);
5239 if (zfs_set_prop_nvlist(tofs, ZPROP_SRC_LOCAL, setprops,
5240 NULL) != 0)
5241 *errflags |= ZPROP_ERR_NORESTORE;
5242 if (zfs_set_prop_nvlist(tofs, ZPROP_SRC_INHERITED, inheritprops,
5243 NULL) != 0)
5244 *errflags |= ZPROP_ERR_NORESTORE;
5246 nvlist_free(setprops);
5247 nvlist_free(inheritprops);
5249 out:
5250 zfs_file_put(input_fp);
5251 nvlist_free(origrecvd);
5252 nvlist_free(origprops);
5254 if (error == 0)
5255 error = props_error;
5257 return (error);
5261 * inputs:
5262 * zc_name name of containing filesystem (unused)
5263 * zc_nvlist_src{_size} nvlist of properties to apply
5264 * zc_nvlist_conf{_size} nvlist of properties to exclude
5265 * (DATA_TYPE_BOOLEAN) and override (everything else)
5266 * zc_value name of snapshot to create
5267 * zc_string name of clone origin (if DRR_FLAG_CLONE)
5268 * zc_cookie file descriptor to recv from
5269 * zc_begin_record the BEGIN record of the stream (not byteswapped)
5270 * zc_guid force flag
5272 * outputs:
5273 * zc_cookie number of bytes read
5274 * zc_obj zprop_errflags_t
5275 * zc_nvlist_dst{_size} error for each unapplied received property
5277 static int
5278 zfs_ioc_recv(zfs_cmd_t *zc)
5280 dmu_replay_record_t begin_record;
5281 nvlist_t *errors = NULL;
5282 nvlist_t *recvdprops = NULL;
5283 nvlist_t *localprops = NULL;
5284 const char *origin = NULL;
5285 char *tosnap;
5286 char tofs[ZFS_MAX_DATASET_NAME_LEN];
5287 int error = 0;
5289 if (dataset_namecheck(zc->zc_value, NULL, NULL) != 0 ||
5290 strchr(zc->zc_value, '@') == NULL ||
5291 strchr(zc->zc_value, '%'))
5292 return (SET_ERROR(EINVAL));
5294 (void) strlcpy(tofs, zc->zc_value, sizeof (tofs));
5295 tosnap = strchr(tofs, '@');
5296 *tosnap++ = '\0';
5298 if (zc->zc_nvlist_src != 0 &&
5299 (error = get_nvlist(zc->zc_nvlist_src, zc->zc_nvlist_src_size,
5300 zc->zc_iflags, &recvdprops)) != 0)
5301 return (error);
5303 if (zc->zc_nvlist_conf != 0 &&
5304 (error = get_nvlist(zc->zc_nvlist_conf, zc->zc_nvlist_conf_size,
5305 zc->zc_iflags, &localprops)) != 0)
5306 return (error);
5308 if (zc->zc_string[0])
5309 origin = zc->zc_string;
5311 begin_record.drr_type = DRR_BEGIN;
5312 begin_record.drr_payloadlen = 0;
5313 begin_record.drr_u.drr_begin = zc->zc_begin_record;
5315 error = zfs_ioc_recv_impl(tofs, tosnap, origin, recvdprops, localprops,
5316 NULL, zc->zc_guid, B_FALSE, B_FALSE, zc->zc_cookie, &begin_record,
5317 &zc->zc_cookie, &zc->zc_obj, &errors);
5318 nvlist_free(recvdprops);
5319 nvlist_free(localprops);
5322 * Now that all props, initial and delayed, are set, report the prop
5323 * errors to the caller.
5325 if (zc->zc_nvlist_dst_size != 0 && errors != NULL &&
5326 (nvlist_smush(errors, zc->zc_nvlist_dst_size) != 0 ||
5327 put_nvlist(zc, errors) != 0)) {
5329 * Caller made zc->zc_nvlist_dst less than the minimum expected
5330 * size or supplied an invalid address.
5332 error = SET_ERROR(EINVAL);
5335 nvlist_free(errors);
5337 return (error);
5341 * innvl: {
5342 * "snapname" -> full name of the snapshot to create
5343 * (optional) "props" -> received properties to set (nvlist)
5344 * (optional) "localprops" -> override and exclude properties (nvlist)
5345 * (optional) "origin" -> name of clone origin (DRR_FLAG_CLONE)
5346 * "begin_record" -> non-byteswapped dmu_replay_record_t
5347 * "input_fd" -> file descriptor to read stream from (int32)
5348 * (optional) "force" -> force flag (value ignored)
5349 * (optional) "heal" -> use send stream to heal data corruption
5350 * (optional) "resumable" -> resumable flag (value ignored)
5351 * (optional) "cleanup_fd" -> unused
5352 * (optional) "action_handle" -> unused
5353 * (optional) "hidden_args" -> { "wkeydata" -> value }
5356 * outnvl: {
5357 * "read_bytes" -> number of bytes read
5358 * "error_flags" -> zprop_errflags_t
5359 * "errors" -> error for each unapplied received property (nvlist)
5362 static const zfs_ioc_key_t zfs_keys_recv_new[] = {
5363 {"snapname", DATA_TYPE_STRING, 0},
5364 {"props", DATA_TYPE_NVLIST, ZK_OPTIONAL},
5365 {"localprops", DATA_TYPE_NVLIST, ZK_OPTIONAL},
5366 {"origin", DATA_TYPE_STRING, ZK_OPTIONAL},
5367 {"begin_record", DATA_TYPE_BYTE_ARRAY, 0},
5368 {"input_fd", DATA_TYPE_INT32, 0},
5369 {"force", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
5370 {"heal", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
5371 {"resumable", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
5372 {"cleanup_fd", DATA_TYPE_INT32, ZK_OPTIONAL},
5373 {"action_handle", DATA_TYPE_UINT64, ZK_OPTIONAL},
5374 {"hidden_args", DATA_TYPE_NVLIST, ZK_OPTIONAL},
5377 static int
5378 zfs_ioc_recv_new(const char *fsname, nvlist_t *innvl, nvlist_t *outnvl)
5380 dmu_replay_record_t *begin_record;
5381 uint_t begin_record_size;
5382 nvlist_t *errors = NULL;
5383 nvlist_t *recvprops = NULL;
5384 nvlist_t *localprops = NULL;
5385 nvlist_t *hidden_args = NULL;
5386 const char *snapname;
5387 const char *origin = NULL;
5388 char *tosnap;
5389 char tofs[ZFS_MAX_DATASET_NAME_LEN];
5390 boolean_t force;
5391 boolean_t heal;
5392 boolean_t resumable;
5393 uint64_t read_bytes = 0;
5394 uint64_t errflags = 0;
5395 int input_fd = -1;
5396 int error;
5398 snapname = fnvlist_lookup_string(innvl, "snapname");
5400 if (dataset_namecheck(snapname, NULL, NULL) != 0 ||
5401 strchr(snapname, '@') == NULL ||
5402 strchr(snapname, '%'))
5403 return (SET_ERROR(EINVAL));
5405 (void) strlcpy(tofs, snapname, sizeof (tofs));
5406 tosnap = strchr(tofs, '@');
5407 *tosnap++ = '\0';
5409 error = nvlist_lookup_string(innvl, "origin", &origin);
5410 if (error && error != ENOENT)
5411 return (error);
5413 error = nvlist_lookup_byte_array(innvl, "begin_record",
5414 (uchar_t **)&begin_record, &begin_record_size);
5415 if (error != 0 || begin_record_size != sizeof (*begin_record))
5416 return (SET_ERROR(EINVAL));
5418 input_fd = fnvlist_lookup_int32(innvl, "input_fd");
5420 force = nvlist_exists(innvl, "force");
5421 heal = nvlist_exists(innvl, "heal");
5422 resumable = nvlist_exists(innvl, "resumable");
5424 /* we still use "props" here for backwards compatibility */
5425 error = nvlist_lookup_nvlist(innvl, "props", &recvprops);
5426 if (error && error != ENOENT)
5427 return (error);
5429 error = nvlist_lookup_nvlist(innvl, "localprops", &localprops);
5430 if (error && error != ENOENT)
5431 return (error);
5433 error = nvlist_lookup_nvlist(innvl, ZPOOL_HIDDEN_ARGS, &hidden_args);
5434 if (error && error != ENOENT)
5435 return (error);
5437 error = zfs_ioc_recv_impl(tofs, tosnap, origin, recvprops, localprops,
5438 hidden_args, force, heal, resumable, input_fd, begin_record,
5439 &read_bytes, &errflags, &errors);
5441 fnvlist_add_uint64(outnvl, "read_bytes", read_bytes);
5442 fnvlist_add_uint64(outnvl, "error_flags", errflags);
5443 fnvlist_add_nvlist(outnvl, "errors", errors);
5445 nvlist_free(errors);
5446 nvlist_free(recvprops);
5447 nvlist_free(localprops);
5449 return (error);
5452 typedef struct dump_bytes_io {
5453 zfs_file_t *dbi_fp;
5454 caddr_t dbi_buf;
5455 int dbi_len;
5456 int dbi_err;
5457 } dump_bytes_io_t;
5459 static void
5460 dump_bytes_cb(void *arg)
5462 dump_bytes_io_t *dbi = (dump_bytes_io_t *)arg;
5463 zfs_file_t *fp;
5464 caddr_t buf;
5466 fp = dbi->dbi_fp;
5467 buf = dbi->dbi_buf;
5469 dbi->dbi_err = zfs_file_write(fp, buf, dbi->dbi_len, NULL);
5472 static int
5473 dump_bytes(objset_t *os, void *buf, int len, void *arg)
5475 dump_bytes_io_t dbi;
5477 dbi.dbi_fp = arg;
5478 dbi.dbi_buf = buf;
5479 dbi.dbi_len = len;
5481 #if defined(HAVE_LARGE_STACKS)
5482 dump_bytes_cb(&dbi);
5483 #else
5485 * The vn_rdwr() call is performed in a taskq to ensure that there is
5486 * always enough stack space to write safely to the target filesystem.
5487 * The ZIO_TYPE_FREE threads are used because there can be a lot of
5488 * them and they are used in vdev_file.c for a similar purpose.
5490 spa_taskq_dispatch_sync(dmu_objset_spa(os), ZIO_TYPE_FREE,
5491 ZIO_TASKQ_ISSUE, dump_bytes_cb, &dbi, TQ_SLEEP);
5492 #endif /* HAVE_LARGE_STACKS */
5494 return (dbi.dbi_err);
5498 * inputs:
5499 * zc_name name of snapshot to send
5500 * zc_cookie file descriptor to send stream to
5501 * zc_obj fromorigin flag (mutually exclusive with zc_fromobj)
5502 * zc_sendobj objsetid of snapshot to send
5503 * zc_fromobj objsetid of incremental fromsnap (may be zero)
5504 * zc_guid if set, estimate size of stream only. zc_cookie is ignored.
5505 * output size in zc_objset_type.
5506 * zc_flags lzc_send_flags
5508 * outputs:
5509 * zc_objset_type estimated size, if zc_guid is set
5511 * NOTE: This is no longer the preferred interface, any new functionality
5512 * should be added to zfs_ioc_send_new() instead.
5514 static int
5515 zfs_ioc_send(zfs_cmd_t *zc)
5517 int error;
5518 offset_t off;
5519 boolean_t estimate = (zc->zc_guid != 0);
5520 boolean_t embedok = (zc->zc_flags & 0x1);
5521 boolean_t large_block_ok = (zc->zc_flags & 0x2);
5522 boolean_t compressok = (zc->zc_flags & 0x4);
5523 boolean_t rawok = (zc->zc_flags & 0x8);
5524 boolean_t savedok = (zc->zc_flags & 0x10);
5526 if (zc->zc_obj != 0) {
5527 dsl_pool_t *dp;
5528 dsl_dataset_t *tosnap;
5530 error = dsl_pool_hold(zc->zc_name, FTAG, &dp);
5531 if (error != 0)
5532 return (error);
5534 error = dsl_dataset_hold_obj(dp, zc->zc_sendobj, FTAG, &tosnap);
5535 if (error != 0) {
5536 dsl_pool_rele(dp, FTAG);
5537 return (error);
5540 if (dsl_dir_is_clone(tosnap->ds_dir))
5541 zc->zc_fromobj =
5542 dsl_dir_phys(tosnap->ds_dir)->dd_origin_obj;
5543 dsl_dataset_rele(tosnap, FTAG);
5544 dsl_pool_rele(dp, FTAG);
5547 if (estimate) {
5548 dsl_pool_t *dp;
5549 dsl_dataset_t *tosnap;
5550 dsl_dataset_t *fromsnap = NULL;
5552 error = dsl_pool_hold(zc->zc_name, FTAG, &dp);
5553 if (error != 0)
5554 return (error);
5556 error = dsl_dataset_hold_obj(dp, zc->zc_sendobj,
5557 FTAG, &tosnap);
5558 if (error != 0) {
5559 dsl_pool_rele(dp, FTAG);
5560 return (error);
5563 if (zc->zc_fromobj != 0) {
5564 error = dsl_dataset_hold_obj(dp, zc->zc_fromobj,
5565 FTAG, &fromsnap);
5566 if (error != 0) {
5567 dsl_dataset_rele(tosnap, FTAG);
5568 dsl_pool_rele(dp, FTAG);
5569 return (error);
5573 error = dmu_send_estimate_fast(tosnap, fromsnap, NULL,
5574 compressok || rawok, savedok, &zc->zc_objset_type);
5576 if (fromsnap != NULL)
5577 dsl_dataset_rele(fromsnap, FTAG);
5578 dsl_dataset_rele(tosnap, FTAG);
5579 dsl_pool_rele(dp, FTAG);
5580 } else {
5581 zfs_file_t *fp;
5582 dmu_send_outparams_t out = {0};
5584 if ((fp = zfs_file_get(zc->zc_cookie)) == NULL)
5585 return (SET_ERROR(EBADF));
5587 off = zfs_file_off(fp);
5588 out.dso_outfunc = dump_bytes;
5589 out.dso_arg = fp;
5590 out.dso_dryrun = B_FALSE;
5591 error = dmu_send_obj(zc->zc_name, zc->zc_sendobj,
5592 zc->zc_fromobj, embedok, large_block_ok, compressok,
5593 rawok, savedok, zc->zc_cookie, &off, &out);
5595 zfs_file_put(fp);
5597 return (error);
5601 * inputs:
5602 * zc_name name of snapshot on which to report progress
5603 * zc_cookie file descriptor of send stream
5605 * outputs:
5606 * zc_cookie number of bytes written in send stream thus far
5607 * zc_objset_type logical size of data traversed by send thus far
5609 static int
5610 zfs_ioc_send_progress(zfs_cmd_t *zc)
5612 dsl_pool_t *dp;
5613 dsl_dataset_t *ds;
5614 dmu_sendstatus_t *dsp = NULL;
5615 int error;
5617 error = dsl_pool_hold(zc->zc_name, FTAG, &dp);
5618 if (error != 0)
5619 return (error);
5621 error = dsl_dataset_hold(dp, zc->zc_name, FTAG, &ds);
5622 if (error != 0) {
5623 dsl_pool_rele(dp, FTAG);
5624 return (error);
5627 mutex_enter(&ds->ds_sendstream_lock);
5630 * Iterate over all the send streams currently active on this dataset.
5631 * If there's one which matches the specified file descriptor _and_ the
5632 * stream was started by the current process, return the progress of
5633 * that stream.
5636 for (dsp = list_head(&ds->ds_sendstreams); dsp != NULL;
5637 dsp = list_next(&ds->ds_sendstreams, dsp)) {
5638 if (dsp->dss_outfd == zc->zc_cookie &&
5639 zfs_proc_is_caller(dsp->dss_proc))
5640 break;
5643 if (dsp != NULL) {
5644 zc->zc_cookie = atomic_cas_64((volatile uint64_t *)dsp->dss_off,
5645 0, 0);
5646 /* This is the closest thing we have to atomic_read_64. */
5647 zc->zc_objset_type = atomic_cas_64(&dsp->dss_blocks, 0, 0);
5648 } else {
5649 error = SET_ERROR(ENOENT);
5652 mutex_exit(&ds->ds_sendstream_lock);
5653 dsl_dataset_rele(ds, FTAG);
5654 dsl_pool_rele(dp, FTAG);
5655 return (error);
5658 static int
5659 zfs_ioc_inject_fault(zfs_cmd_t *zc)
5661 int id, error;
5663 error = zio_inject_fault(zc->zc_name, (int)zc->zc_guid, &id,
5664 &zc->zc_inject_record);
5666 if (error == 0)
5667 zc->zc_guid = (uint64_t)id;
5669 return (error);
5672 static int
5673 zfs_ioc_clear_fault(zfs_cmd_t *zc)
5675 return (zio_clear_fault((int)zc->zc_guid));
5678 static int
5679 zfs_ioc_inject_list_next(zfs_cmd_t *zc)
5681 int id = (int)zc->zc_guid;
5682 int error;
5684 error = zio_inject_list_next(&id, zc->zc_name, sizeof (zc->zc_name),
5685 &zc->zc_inject_record);
5687 zc->zc_guid = id;
5689 return (error);
5692 static int
5693 zfs_ioc_error_log(zfs_cmd_t *zc)
5695 spa_t *spa;
5696 int error;
5698 if ((error = spa_open(zc->zc_name, &spa, FTAG)) != 0)
5699 return (error);
5701 error = spa_get_errlog(spa, (void *)(uintptr_t)zc->zc_nvlist_dst,
5702 &zc->zc_nvlist_dst_size);
5704 spa_close(spa, FTAG);
5706 return (error);
5709 static int
5710 zfs_ioc_clear(zfs_cmd_t *zc)
5712 spa_t *spa;
5713 vdev_t *vd;
5714 int error;
5717 * On zpool clear we also fix up missing slogs
5719 mutex_enter(&spa_namespace_lock);
5720 spa = spa_lookup(zc->zc_name);
5721 if (spa == NULL) {
5722 mutex_exit(&spa_namespace_lock);
5723 return (SET_ERROR(EIO));
5725 if (spa_get_log_state(spa) == SPA_LOG_MISSING) {
5726 /* we need to let spa_open/spa_load clear the chains */
5727 spa_set_log_state(spa, SPA_LOG_CLEAR);
5729 spa->spa_last_open_failed = 0;
5730 mutex_exit(&spa_namespace_lock);
5732 if (zc->zc_cookie & ZPOOL_NO_REWIND) {
5733 error = spa_open(zc->zc_name, &spa, FTAG);
5734 } else {
5735 nvlist_t *policy;
5736 nvlist_t *config = NULL;
5738 if (zc->zc_nvlist_src == 0)
5739 return (SET_ERROR(EINVAL));
5741 if ((error = get_nvlist(zc->zc_nvlist_src,
5742 zc->zc_nvlist_src_size, zc->zc_iflags, &policy)) == 0) {
5743 error = spa_open_rewind(zc->zc_name, &spa, FTAG,
5744 policy, &config);
5745 if (config != NULL) {
5746 int err;
5748 if ((err = put_nvlist(zc, config)) != 0)
5749 error = err;
5750 nvlist_free(config);
5752 nvlist_free(policy);
5756 if (error != 0)
5757 return (error);
5760 * If multihost is enabled, resuming I/O is unsafe as another
5761 * host may have imported the pool.
5763 if (spa_multihost(spa) && spa_suspended(spa))
5764 return (SET_ERROR(EINVAL));
5766 spa_vdev_state_enter(spa, SCL_NONE);
5768 if (zc->zc_guid == 0) {
5769 vd = NULL;
5770 } else {
5771 vd = spa_lookup_by_guid(spa, zc->zc_guid, B_TRUE);
5772 if (vd == NULL) {
5773 error = SET_ERROR(ENODEV);
5774 (void) spa_vdev_state_exit(spa, NULL, error);
5775 spa_close(spa, FTAG);
5776 return (error);
5780 vdev_clear(spa, vd);
5782 (void) spa_vdev_state_exit(spa, spa_suspended(spa) ?
5783 NULL : spa->spa_root_vdev, 0);
5786 * Resume any suspended I/Os.
5788 if (zio_resume(spa) != 0)
5789 error = SET_ERROR(EIO);
5791 spa_close(spa, FTAG);
5793 return (error);
5797 * Reopen all the vdevs associated with the pool.
5799 * innvl: {
5800 * "scrub_restart" -> when true and scrub is running, allow to restart
5801 * scrub as the side effect of the reopen (boolean).
5804 * outnvl is unused
5806 static const zfs_ioc_key_t zfs_keys_pool_reopen[] = {
5807 {"scrub_restart", DATA_TYPE_BOOLEAN_VALUE, ZK_OPTIONAL},
5810 static int
5811 zfs_ioc_pool_reopen(const char *pool, nvlist_t *innvl, nvlist_t *outnvl)
5813 (void) outnvl;
5814 spa_t *spa;
5815 int error;
5816 boolean_t rc, scrub_restart = B_TRUE;
5818 if (innvl) {
5819 error = nvlist_lookup_boolean_value(innvl,
5820 "scrub_restart", &rc);
5821 if (error == 0)
5822 scrub_restart = rc;
5825 error = spa_open(pool, &spa, FTAG);
5826 if (error != 0)
5827 return (error);
5829 spa_vdev_state_enter(spa, SCL_NONE);
5832 * If the scrub_restart flag is B_FALSE and a scrub is already
5833 * in progress then set spa_scrub_reopen flag to B_TRUE so that
5834 * we don't restart the scrub as a side effect of the reopen.
5835 * Otherwise, let vdev_open() decided if a resilver is required.
5838 spa->spa_scrub_reopen = (!scrub_restart &&
5839 dsl_scan_scrubbing(spa->spa_dsl_pool));
5840 vdev_reopen(spa->spa_root_vdev);
5841 spa->spa_scrub_reopen = B_FALSE;
5843 (void) spa_vdev_state_exit(spa, NULL, 0);
5844 spa_close(spa, FTAG);
5845 return (0);
5849 * inputs:
5850 * zc_name name of filesystem
5852 * outputs:
5853 * zc_string name of conflicting snapshot, if there is one
5855 static int
5856 zfs_ioc_promote(zfs_cmd_t *zc)
5858 dsl_pool_t *dp;
5859 dsl_dataset_t *ds, *ods;
5860 char origin[ZFS_MAX_DATASET_NAME_LEN];
5861 char *cp;
5862 int error;
5864 zc->zc_name[sizeof (zc->zc_name) - 1] = '\0';
5865 if (dataset_namecheck(zc->zc_name, NULL, NULL) != 0 ||
5866 strchr(zc->zc_name, '%'))
5867 return (SET_ERROR(EINVAL));
5869 error = dsl_pool_hold(zc->zc_name, FTAG, &dp);
5870 if (error != 0)
5871 return (error);
5873 error = dsl_dataset_hold(dp, zc->zc_name, FTAG, &ds);
5874 if (error != 0) {
5875 dsl_pool_rele(dp, FTAG);
5876 return (error);
5879 if (!dsl_dir_is_clone(ds->ds_dir)) {
5880 dsl_dataset_rele(ds, FTAG);
5881 dsl_pool_rele(dp, FTAG);
5882 return (SET_ERROR(EINVAL));
5885 error = dsl_dataset_hold_obj(dp,
5886 dsl_dir_phys(ds->ds_dir)->dd_origin_obj, FTAG, &ods);
5887 if (error != 0) {
5888 dsl_dataset_rele(ds, FTAG);
5889 dsl_pool_rele(dp, FTAG);
5890 return (error);
5893 dsl_dataset_name(ods, origin);
5894 dsl_dataset_rele(ods, FTAG);
5895 dsl_dataset_rele(ds, FTAG);
5896 dsl_pool_rele(dp, FTAG);
5899 * We don't need to unmount *all* the origin fs's snapshots, but
5900 * it's easier.
5902 cp = strchr(origin, '@');
5903 if (cp)
5904 *cp = '\0';
5905 (void) dmu_objset_find(origin,
5906 zfs_unmount_snap_cb, NULL, DS_FIND_SNAPSHOTS);
5907 return (dsl_dataset_promote(zc->zc_name, zc->zc_string));
5911 * Retrieve a single {user|group|project}{used|quota}@... property.
5913 * inputs:
5914 * zc_name name of filesystem
5915 * zc_objset_type zfs_userquota_prop_t
5916 * zc_value domain name (eg. "S-1-234-567-89")
5917 * zc_guid RID/UID/GID
5919 * outputs:
5920 * zc_cookie property value
5922 static int
5923 zfs_ioc_userspace_one(zfs_cmd_t *zc)
5925 zfsvfs_t *zfsvfs;
5926 int error;
5928 if (zc->zc_objset_type >= ZFS_NUM_USERQUOTA_PROPS)
5929 return (SET_ERROR(EINVAL));
5931 error = zfsvfs_hold(zc->zc_name, FTAG, &zfsvfs, B_FALSE);
5932 if (error != 0)
5933 return (error);
5935 error = zfs_userspace_one(zfsvfs,
5936 zc->zc_objset_type, zc->zc_value, zc->zc_guid, &zc->zc_cookie);
5937 zfsvfs_rele(zfsvfs, FTAG);
5939 return (error);
5943 * inputs:
5944 * zc_name name of filesystem
5945 * zc_cookie zap cursor
5946 * zc_objset_type zfs_userquota_prop_t
5947 * zc_nvlist_dst[_size] buffer to fill (not really an nvlist)
5949 * outputs:
5950 * zc_nvlist_dst[_size] data buffer (array of zfs_useracct_t)
5951 * zc_cookie zap cursor
5953 static int
5954 zfs_ioc_userspace_many(zfs_cmd_t *zc)
5956 zfsvfs_t *zfsvfs;
5957 int bufsize = zc->zc_nvlist_dst_size;
5959 if (bufsize <= 0)
5960 return (SET_ERROR(ENOMEM));
5962 int error = zfsvfs_hold(zc->zc_name, FTAG, &zfsvfs, B_FALSE);
5963 if (error != 0)
5964 return (error);
5966 void *buf = vmem_alloc(bufsize, KM_SLEEP);
5968 error = zfs_userspace_many(zfsvfs, zc->zc_objset_type, &zc->zc_cookie,
5969 buf, &zc->zc_nvlist_dst_size);
5971 if (error == 0) {
5972 error = xcopyout(buf,
5973 (void *)(uintptr_t)zc->zc_nvlist_dst,
5974 zc->zc_nvlist_dst_size);
5976 vmem_free(buf, bufsize);
5977 zfsvfs_rele(zfsvfs, FTAG);
5979 return (error);
5983 * inputs:
5984 * zc_name name of filesystem
5986 * outputs:
5987 * none
5989 static int
5990 zfs_ioc_userspace_upgrade(zfs_cmd_t *zc)
5992 int error = 0;
5993 zfsvfs_t *zfsvfs;
5995 if (getzfsvfs(zc->zc_name, &zfsvfs) == 0) {
5996 if (!dmu_objset_userused_enabled(zfsvfs->z_os)) {
5998 * If userused is not enabled, it may be because the
5999 * objset needs to be closed & reopened (to grow the
6000 * objset_phys_t). Suspend/resume the fs will do that.
6002 dsl_dataset_t *ds, *newds;
6004 ds = dmu_objset_ds(zfsvfs->z_os);
6005 error = zfs_suspend_fs(zfsvfs);
6006 if (error == 0) {
6007 dmu_objset_refresh_ownership(ds, &newds,
6008 B_TRUE, zfsvfs);
6009 error = zfs_resume_fs(zfsvfs, newds);
6012 if (error == 0) {
6013 mutex_enter(&zfsvfs->z_os->os_upgrade_lock);
6014 if (zfsvfs->z_os->os_upgrade_id == 0) {
6015 /* clear potential error code and retry */
6016 zfsvfs->z_os->os_upgrade_status = 0;
6017 mutex_exit(&zfsvfs->z_os->os_upgrade_lock);
6019 dsl_pool_config_enter(
6020 dmu_objset_pool(zfsvfs->z_os), FTAG);
6021 dmu_objset_userspace_upgrade(zfsvfs->z_os);
6022 dsl_pool_config_exit(
6023 dmu_objset_pool(zfsvfs->z_os), FTAG);
6024 } else {
6025 mutex_exit(&zfsvfs->z_os->os_upgrade_lock);
6028 taskq_wait_id(zfsvfs->z_os->os_spa->spa_upgrade_taskq,
6029 zfsvfs->z_os->os_upgrade_id);
6030 error = zfsvfs->z_os->os_upgrade_status;
6032 zfs_vfs_rele(zfsvfs);
6033 } else {
6034 objset_t *os;
6036 /* XXX kind of reading contents without owning */
6037 error = dmu_objset_hold_flags(zc->zc_name, B_TRUE, FTAG, &os);
6038 if (error != 0)
6039 return (error);
6041 mutex_enter(&os->os_upgrade_lock);
6042 if (os->os_upgrade_id == 0) {
6043 /* clear potential error code and retry */
6044 os->os_upgrade_status = 0;
6045 mutex_exit(&os->os_upgrade_lock);
6047 dmu_objset_userspace_upgrade(os);
6048 } else {
6049 mutex_exit(&os->os_upgrade_lock);
6052 dsl_pool_rele(dmu_objset_pool(os), FTAG);
6054 taskq_wait_id(os->os_spa->spa_upgrade_taskq, os->os_upgrade_id);
6055 error = os->os_upgrade_status;
6057 dsl_dataset_rele_flags(dmu_objset_ds(os), DS_HOLD_FLAG_DECRYPT,
6058 FTAG);
6060 return (error);
6064 * inputs:
6065 * zc_name name of filesystem
6067 * outputs:
6068 * none
6070 static int
6071 zfs_ioc_id_quota_upgrade(zfs_cmd_t *zc)
6073 objset_t *os;
6074 int error;
6076 error = dmu_objset_hold_flags(zc->zc_name, B_TRUE, FTAG, &os);
6077 if (error != 0)
6078 return (error);
6080 if (dmu_objset_userobjspace_upgradable(os) ||
6081 dmu_objset_projectquota_upgradable(os)) {
6082 mutex_enter(&os->os_upgrade_lock);
6083 if (os->os_upgrade_id == 0) {
6084 /* clear potential error code and retry */
6085 os->os_upgrade_status = 0;
6086 mutex_exit(&os->os_upgrade_lock);
6088 dmu_objset_id_quota_upgrade(os);
6089 } else {
6090 mutex_exit(&os->os_upgrade_lock);
6093 dsl_pool_rele(dmu_objset_pool(os), FTAG);
6095 taskq_wait_id(os->os_spa->spa_upgrade_taskq, os->os_upgrade_id);
6096 error = os->os_upgrade_status;
6097 } else {
6098 dsl_pool_rele(dmu_objset_pool(os), FTAG);
6101 dsl_dataset_rele_flags(dmu_objset_ds(os), DS_HOLD_FLAG_DECRYPT, FTAG);
6103 return (error);
6106 static int
6107 zfs_ioc_share(zfs_cmd_t *zc)
6109 return (SET_ERROR(ENOSYS));
6113 * inputs:
6114 * zc_name name of containing filesystem
6115 * zc_obj object # beyond which we want next in-use object #
6117 * outputs:
6118 * zc_obj next in-use object #
6120 static int
6121 zfs_ioc_next_obj(zfs_cmd_t *zc)
6123 objset_t *os = NULL;
6124 int error;
6126 error = dmu_objset_hold(zc->zc_name, FTAG, &os);
6127 if (error != 0)
6128 return (error);
6130 error = dmu_object_next(os, &zc->zc_obj, B_FALSE, 0);
6132 dmu_objset_rele(os, FTAG);
6133 return (error);
6137 * inputs:
6138 * zc_name name of filesystem
6139 * zc_value prefix name for snapshot
6140 * zc_cleanup_fd cleanup-on-exit file descriptor for calling process
6142 * outputs:
6143 * zc_value short name of new snapshot
6145 static int
6146 zfs_ioc_tmp_snapshot(zfs_cmd_t *zc)
6148 char *snap_name;
6149 char *hold_name;
6150 minor_t minor;
6152 zfs_file_t *fp = zfs_onexit_fd_hold(zc->zc_cleanup_fd, &minor);
6153 if (fp == NULL)
6154 return (SET_ERROR(EBADF));
6156 snap_name = kmem_asprintf("%s-%016llx", zc->zc_value,
6157 (u_longlong_t)ddi_get_lbolt64());
6158 hold_name = kmem_asprintf("%%%s", zc->zc_value);
6160 int error = dsl_dataset_snapshot_tmp(zc->zc_name, snap_name, minor,
6161 hold_name);
6162 if (error == 0)
6163 (void) strlcpy(zc->zc_value, snap_name,
6164 sizeof (zc->zc_value));
6165 kmem_strfree(snap_name);
6166 kmem_strfree(hold_name);
6167 zfs_onexit_fd_rele(fp);
6168 return (error);
6172 * inputs:
6173 * zc_name name of "to" snapshot
6174 * zc_value name of "from" snapshot
6175 * zc_cookie file descriptor to write diff data on
6177 * outputs:
6178 * dmu_diff_record_t's to the file descriptor
6180 static int
6181 zfs_ioc_diff(zfs_cmd_t *zc)
6183 zfs_file_t *fp;
6184 offset_t off;
6185 int error;
6187 if ((fp = zfs_file_get(zc->zc_cookie)) == NULL)
6188 return (SET_ERROR(EBADF));
6190 off = zfs_file_off(fp);
6191 error = dmu_diff(zc->zc_name, zc->zc_value, fp, &off);
6193 zfs_file_put(fp);
6195 return (error);
6198 static int
6199 zfs_ioc_smb_acl(zfs_cmd_t *zc)
6201 return (SET_ERROR(ENOTSUP));
6205 * innvl: {
6206 * "holds" -> { snapname -> holdname (string), ... }
6207 * (optional) "cleanup_fd" -> fd (int32)
6210 * outnvl: {
6211 * snapname -> error value (int32)
6212 * ...
6215 static const zfs_ioc_key_t zfs_keys_hold[] = {
6216 {"holds", DATA_TYPE_NVLIST, 0},
6217 {"cleanup_fd", DATA_TYPE_INT32, ZK_OPTIONAL},
6220 static int
6221 zfs_ioc_hold(const char *pool, nvlist_t *args, nvlist_t *errlist)
6223 (void) pool;
6224 nvpair_t *pair;
6225 nvlist_t *holds;
6226 int cleanup_fd = -1;
6227 int error;
6228 minor_t minor = 0;
6229 zfs_file_t *fp = NULL;
6231 holds = fnvlist_lookup_nvlist(args, "holds");
6233 /* make sure the user didn't pass us any invalid (empty) tags */
6234 for (pair = nvlist_next_nvpair(holds, NULL); pair != NULL;
6235 pair = nvlist_next_nvpair(holds, pair)) {
6236 const char *htag;
6238 error = nvpair_value_string(pair, &htag);
6239 if (error != 0)
6240 return (SET_ERROR(error));
6242 if (strlen(htag) == 0)
6243 return (SET_ERROR(EINVAL));
6246 if (nvlist_lookup_int32(args, "cleanup_fd", &cleanup_fd) == 0) {
6247 fp = zfs_onexit_fd_hold(cleanup_fd, &minor);
6248 if (fp == NULL)
6249 return (SET_ERROR(EBADF));
6252 error = dsl_dataset_user_hold(holds, minor, errlist);
6253 if (fp != NULL) {
6254 ASSERT3U(minor, !=, 0);
6255 zfs_onexit_fd_rele(fp);
6257 return (SET_ERROR(error));
6261 * innvl is not used.
6263 * outnvl: {
6264 * holdname -> time added (uint64 seconds since epoch)
6265 * ...
6268 static const zfs_ioc_key_t zfs_keys_get_holds[] = {
6269 /* no nvl keys */
6272 static int
6273 zfs_ioc_get_holds(const char *snapname, nvlist_t *args, nvlist_t *outnvl)
6275 (void) args;
6276 return (dsl_dataset_get_holds(snapname, outnvl));
6280 * innvl: {
6281 * snapname -> { holdname, ... }
6282 * ...
6285 * outnvl: {
6286 * snapname -> error value (int32)
6287 * ...
6290 static const zfs_ioc_key_t zfs_keys_release[] = {
6291 {"<snapname>...", DATA_TYPE_NVLIST, ZK_WILDCARDLIST},
6294 static int
6295 zfs_ioc_release(const char *pool, nvlist_t *holds, nvlist_t *errlist)
6297 (void) pool;
6298 return (dsl_dataset_user_release(holds, errlist));
6302 * inputs:
6303 * zc_guid flags (ZEVENT_NONBLOCK)
6304 * zc_cleanup_fd zevent file descriptor
6306 * outputs:
6307 * zc_nvlist_dst next nvlist event
6308 * zc_cookie dropped events since last get
6310 static int
6311 zfs_ioc_events_next(zfs_cmd_t *zc)
6313 zfs_zevent_t *ze;
6314 nvlist_t *event = NULL;
6315 minor_t minor;
6316 uint64_t dropped = 0;
6317 int error;
6319 zfs_file_t *fp = zfs_zevent_fd_hold(zc->zc_cleanup_fd, &minor, &ze);
6320 if (fp == NULL)
6321 return (SET_ERROR(EBADF));
6323 do {
6324 error = zfs_zevent_next(ze, &event,
6325 &zc->zc_nvlist_dst_size, &dropped);
6326 if (event != NULL) {
6327 zc->zc_cookie = dropped;
6328 error = put_nvlist(zc, event);
6329 nvlist_free(event);
6332 if (zc->zc_guid & ZEVENT_NONBLOCK)
6333 break;
6335 if ((error == 0) || (error != ENOENT))
6336 break;
6338 error = zfs_zevent_wait(ze);
6339 if (error != 0)
6340 break;
6341 } while (1);
6343 zfs_zevent_fd_rele(fp);
6345 return (error);
6349 * outputs:
6350 * zc_cookie cleared events count
6352 static int
6353 zfs_ioc_events_clear(zfs_cmd_t *zc)
6355 uint_t count;
6357 zfs_zevent_drain_all(&count);
6358 zc->zc_cookie = count;
6360 return (0);
6364 * inputs:
6365 * zc_guid eid | ZEVENT_SEEK_START | ZEVENT_SEEK_END
6366 * zc_cleanup zevent file descriptor
6368 static int
6369 zfs_ioc_events_seek(zfs_cmd_t *zc)
6371 zfs_zevent_t *ze;
6372 minor_t minor;
6373 int error;
6375 zfs_file_t *fp = zfs_zevent_fd_hold(zc->zc_cleanup_fd, &minor, &ze);
6376 if (fp == NULL)
6377 return (SET_ERROR(EBADF));
6379 error = zfs_zevent_seek(ze, zc->zc_guid);
6380 zfs_zevent_fd_rele(fp);
6382 return (error);
6386 * inputs:
6387 * zc_name name of later filesystem or snapshot
6388 * zc_value full name of old snapshot or bookmark
6390 * outputs:
6391 * zc_cookie space in bytes
6392 * zc_objset_type compressed space in bytes
6393 * zc_perm_action uncompressed space in bytes
6395 static int
6396 zfs_ioc_space_written(zfs_cmd_t *zc)
6398 int error;
6399 dsl_pool_t *dp;
6400 dsl_dataset_t *new;
6402 error = dsl_pool_hold(zc->zc_name, FTAG, &dp);
6403 if (error != 0)
6404 return (error);
6405 error = dsl_dataset_hold(dp, zc->zc_name, FTAG, &new);
6406 if (error != 0) {
6407 dsl_pool_rele(dp, FTAG);
6408 return (error);
6410 if (strchr(zc->zc_value, '#') != NULL) {
6411 zfs_bookmark_phys_t bmp;
6412 error = dsl_bookmark_lookup(dp, zc->zc_value,
6413 new, &bmp);
6414 if (error == 0) {
6415 error = dsl_dataset_space_written_bookmark(&bmp, new,
6416 &zc->zc_cookie,
6417 &zc->zc_objset_type, &zc->zc_perm_action);
6419 } else {
6420 dsl_dataset_t *old;
6421 error = dsl_dataset_hold(dp, zc->zc_value, FTAG, &old);
6423 if (error == 0) {
6424 error = dsl_dataset_space_written(old, new,
6425 &zc->zc_cookie,
6426 &zc->zc_objset_type, &zc->zc_perm_action);
6427 dsl_dataset_rele(old, FTAG);
6430 dsl_dataset_rele(new, FTAG);
6431 dsl_pool_rele(dp, FTAG);
6432 return (error);
6436 * innvl: {
6437 * "firstsnap" -> snapshot name
6440 * outnvl: {
6441 * "used" -> space in bytes
6442 * "compressed" -> compressed space in bytes
6443 * "uncompressed" -> uncompressed space in bytes
6446 static const zfs_ioc_key_t zfs_keys_space_snaps[] = {
6447 {"firstsnap", DATA_TYPE_STRING, 0},
6450 static int
6451 zfs_ioc_space_snaps(const char *lastsnap, nvlist_t *innvl, nvlist_t *outnvl)
6453 int error;
6454 dsl_pool_t *dp;
6455 dsl_dataset_t *new, *old;
6456 const char *firstsnap;
6457 uint64_t used, comp, uncomp;
6459 firstsnap = fnvlist_lookup_string(innvl, "firstsnap");
6461 error = dsl_pool_hold(lastsnap, FTAG, &dp);
6462 if (error != 0)
6463 return (error);
6465 error = dsl_dataset_hold(dp, lastsnap, FTAG, &new);
6466 if (error == 0 && !new->ds_is_snapshot) {
6467 dsl_dataset_rele(new, FTAG);
6468 error = SET_ERROR(EINVAL);
6470 if (error != 0) {
6471 dsl_pool_rele(dp, FTAG);
6472 return (error);
6474 error = dsl_dataset_hold(dp, firstsnap, FTAG, &old);
6475 if (error == 0 && !old->ds_is_snapshot) {
6476 dsl_dataset_rele(old, FTAG);
6477 error = SET_ERROR(EINVAL);
6479 if (error != 0) {
6480 dsl_dataset_rele(new, FTAG);
6481 dsl_pool_rele(dp, FTAG);
6482 return (error);
6485 error = dsl_dataset_space_wouldfree(old, new, &used, &comp, &uncomp);
6486 dsl_dataset_rele(old, FTAG);
6487 dsl_dataset_rele(new, FTAG);
6488 dsl_pool_rele(dp, FTAG);
6489 fnvlist_add_uint64(outnvl, "used", used);
6490 fnvlist_add_uint64(outnvl, "compressed", comp);
6491 fnvlist_add_uint64(outnvl, "uncompressed", uncomp);
6492 return (error);
6496 * innvl: {
6497 * "fd" -> file descriptor to write stream to (int32)
6498 * (optional) "fromsnap" -> full snap name to send an incremental from
6499 * (optional) "largeblockok" -> (value ignored)
6500 * indicates that blocks > 128KB are permitted
6501 * (optional) "embedok" -> (value ignored)
6502 * presence indicates DRR_WRITE_EMBEDDED records are permitted
6503 * (optional) "compressok" -> (value ignored)
6504 * presence indicates compressed DRR_WRITE records are permitted
6505 * (optional) "rawok" -> (value ignored)
6506 * presence indicates raw encrypted records should be used.
6507 * (optional) "savedok" -> (value ignored)
6508 * presence indicates we should send a partially received snapshot
6509 * (optional) "resume_object" and "resume_offset" -> (uint64)
6510 * if present, resume send stream from specified object and offset.
6511 * (optional) "redactbook" -> (string)
6512 * if present, use this bookmark's redaction list to generate a redacted
6513 * send stream
6516 * outnvl is unused
6518 static const zfs_ioc_key_t zfs_keys_send_new[] = {
6519 {"fd", DATA_TYPE_INT32, 0},
6520 {"fromsnap", DATA_TYPE_STRING, ZK_OPTIONAL},
6521 {"largeblockok", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
6522 {"embedok", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
6523 {"compressok", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
6524 {"rawok", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
6525 {"savedok", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
6526 {"resume_object", DATA_TYPE_UINT64, ZK_OPTIONAL},
6527 {"resume_offset", DATA_TYPE_UINT64, ZK_OPTIONAL},
6528 {"redactbook", DATA_TYPE_STRING, ZK_OPTIONAL},
6531 static int
6532 zfs_ioc_send_new(const char *snapname, nvlist_t *innvl, nvlist_t *outnvl)
6534 (void) outnvl;
6535 int error;
6536 offset_t off;
6537 const char *fromname = NULL;
6538 int fd;
6539 zfs_file_t *fp;
6540 boolean_t largeblockok;
6541 boolean_t embedok;
6542 boolean_t compressok;
6543 boolean_t rawok;
6544 boolean_t savedok;
6545 uint64_t resumeobj = 0;
6546 uint64_t resumeoff = 0;
6547 const char *redactbook = NULL;
6549 fd = fnvlist_lookup_int32(innvl, "fd");
6551 (void) nvlist_lookup_string(innvl, "fromsnap", &fromname);
6553 largeblockok = nvlist_exists(innvl, "largeblockok");
6554 embedok = nvlist_exists(innvl, "embedok");
6555 compressok = nvlist_exists(innvl, "compressok");
6556 rawok = nvlist_exists(innvl, "rawok");
6557 savedok = nvlist_exists(innvl, "savedok");
6559 (void) nvlist_lookup_uint64(innvl, "resume_object", &resumeobj);
6560 (void) nvlist_lookup_uint64(innvl, "resume_offset", &resumeoff);
6562 (void) nvlist_lookup_string(innvl, "redactbook", &redactbook);
6564 if ((fp = zfs_file_get(fd)) == NULL)
6565 return (SET_ERROR(EBADF));
6567 off = zfs_file_off(fp);
6569 dmu_send_outparams_t out = {0};
6570 out.dso_outfunc = dump_bytes;
6571 out.dso_arg = fp;
6572 out.dso_dryrun = B_FALSE;
6573 error = dmu_send(snapname, fromname, embedok, largeblockok,
6574 compressok, rawok, savedok, resumeobj, resumeoff,
6575 redactbook, fd, &off, &out);
6577 zfs_file_put(fp);
6578 return (error);
6581 static int
6582 send_space_sum(objset_t *os, void *buf, int len, void *arg)
6584 (void) os, (void) buf;
6585 uint64_t *size = arg;
6587 *size += len;
6588 return (0);
6592 * Determine approximately how large a zfs send stream will be -- the number
6593 * of bytes that will be written to the fd supplied to zfs_ioc_send_new().
6595 * innvl: {
6596 * (optional) "from" -> full snap or bookmark name to send an incremental
6597 * from
6598 * (optional) "largeblockok" -> (value ignored)
6599 * indicates that blocks > 128KB are permitted
6600 * (optional) "embedok" -> (value ignored)
6601 * presence indicates DRR_WRITE_EMBEDDED records are permitted
6602 * (optional) "compressok" -> (value ignored)
6603 * presence indicates compressed DRR_WRITE records are permitted
6604 * (optional) "rawok" -> (value ignored)
6605 * presence indicates raw encrypted records should be used.
6606 * (optional) "resume_object" and "resume_offset" -> (uint64)
6607 * if present, resume send stream from specified object and offset.
6608 * (optional) "fd" -> file descriptor to use as a cookie for progress
6609 * tracking (int32)
6612 * outnvl: {
6613 * "space" -> bytes of space (uint64)
6616 static const zfs_ioc_key_t zfs_keys_send_space[] = {
6617 {"from", DATA_TYPE_STRING, ZK_OPTIONAL},
6618 {"fromsnap", DATA_TYPE_STRING, ZK_OPTIONAL},
6619 {"largeblockok", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
6620 {"embedok", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
6621 {"compressok", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
6622 {"rawok", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
6623 {"fd", DATA_TYPE_INT32, ZK_OPTIONAL},
6624 {"redactbook", DATA_TYPE_STRING, ZK_OPTIONAL},
6625 {"resume_object", DATA_TYPE_UINT64, ZK_OPTIONAL},
6626 {"resume_offset", DATA_TYPE_UINT64, ZK_OPTIONAL},
6627 {"bytes", DATA_TYPE_UINT64, ZK_OPTIONAL},
6630 static int
6631 zfs_ioc_send_space(const char *snapname, nvlist_t *innvl, nvlist_t *outnvl)
6633 dsl_pool_t *dp;
6634 dsl_dataset_t *tosnap;
6635 dsl_dataset_t *fromsnap = NULL;
6636 int error;
6637 const char *fromname = NULL;
6638 const char *redactlist_book = NULL;
6639 boolean_t largeblockok;
6640 boolean_t embedok;
6641 boolean_t compressok;
6642 boolean_t rawok;
6643 boolean_t savedok;
6644 uint64_t space = 0;
6645 boolean_t full_estimate = B_FALSE;
6646 uint64_t resumeobj = 0;
6647 uint64_t resumeoff = 0;
6648 uint64_t resume_bytes = 0;
6649 int32_t fd = -1;
6650 zfs_bookmark_phys_t zbm = {0};
6652 error = dsl_pool_hold(snapname, FTAG, &dp);
6653 if (error != 0)
6654 return (error);
6656 error = dsl_dataset_hold(dp, snapname, FTAG, &tosnap);
6657 if (error != 0) {
6658 dsl_pool_rele(dp, FTAG);
6659 return (error);
6661 (void) nvlist_lookup_int32(innvl, "fd", &fd);
6663 largeblockok = nvlist_exists(innvl, "largeblockok");
6664 embedok = nvlist_exists(innvl, "embedok");
6665 compressok = nvlist_exists(innvl, "compressok");
6666 rawok = nvlist_exists(innvl, "rawok");
6667 savedok = nvlist_exists(innvl, "savedok");
6668 boolean_t from = (nvlist_lookup_string(innvl, "from", &fromname) == 0);
6669 boolean_t altbook = (nvlist_lookup_string(innvl, "redactbook",
6670 &redactlist_book) == 0);
6672 (void) nvlist_lookup_uint64(innvl, "resume_object", &resumeobj);
6673 (void) nvlist_lookup_uint64(innvl, "resume_offset", &resumeoff);
6674 (void) nvlist_lookup_uint64(innvl, "bytes", &resume_bytes);
6676 if (altbook) {
6677 full_estimate = B_TRUE;
6678 } else if (from) {
6679 if (strchr(fromname, '#')) {
6680 error = dsl_bookmark_lookup(dp, fromname, tosnap, &zbm);
6683 * dsl_bookmark_lookup() will fail with EXDEV if
6684 * the from-bookmark and tosnap are at the same txg.
6685 * However, it's valid to do a send (and therefore,
6686 * a send estimate) from and to the same time point,
6687 * if the bookmark is redacted (the incremental send
6688 * can change what's redacted on the target). In
6689 * this case, dsl_bookmark_lookup() fills in zbm
6690 * but returns EXDEV. Ignore this error.
6692 if (error == EXDEV && zbm.zbm_redaction_obj != 0 &&
6693 zbm.zbm_guid ==
6694 dsl_dataset_phys(tosnap)->ds_guid)
6695 error = 0;
6697 if (error != 0) {
6698 dsl_dataset_rele(tosnap, FTAG);
6699 dsl_pool_rele(dp, FTAG);
6700 return (error);
6702 if (zbm.zbm_redaction_obj != 0 || !(zbm.zbm_flags &
6703 ZBM_FLAG_HAS_FBN)) {
6704 full_estimate = B_TRUE;
6706 } else if (strchr(fromname, '@')) {
6707 error = dsl_dataset_hold(dp, fromname, FTAG, &fromsnap);
6708 if (error != 0) {
6709 dsl_dataset_rele(tosnap, FTAG);
6710 dsl_pool_rele(dp, FTAG);
6711 return (error);
6714 if (!dsl_dataset_is_before(tosnap, fromsnap, 0)) {
6715 full_estimate = B_TRUE;
6716 dsl_dataset_rele(fromsnap, FTAG);
6718 } else {
6720 * from is not properly formatted as a snapshot or
6721 * bookmark
6723 dsl_dataset_rele(tosnap, FTAG);
6724 dsl_pool_rele(dp, FTAG);
6725 return (SET_ERROR(EINVAL));
6729 if (full_estimate) {
6730 dmu_send_outparams_t out = {0};
6731 offset_t off = 0;
6732 out.dso_outfunc = send_space_sum;
6733 out.dso_arg = &space;
6734 out.dso_dryrun = B_TRUE;
6736 * We have to release these holds so dmu_send can take them. It
6737 * will do all the error checking we need.
6739 dsl_dataset_rele(tosnap, FTAG);
6740 dsl_pool_rele(dp, FTAG);
6741 error = dmu_send(snapname, fromname, embedok, largeblockok,
6742 compressok, rawok, savedok, resumeobj, resumeoff,
6743 redactlist_book, fd, &off, &out);
6744 } else {
6745 error = dmu_send_estimate_fast(tosnap, fromsnap,
6746 (from && strchr(fromname, '#') != NULL ? &zbm : NULL),
6747 compressok || rawok, savedok, &space);
6748 space -= resume_bytes;
6749 if (fromsnap != NULL)
6750 dsl_dataset_rele(fromsnap, FTAG);
6751 dsl_dataset_rele(tosnap, FTAG);
6752 dsl_pool_rele(dp, FTAG);
6755 fnvlist_add_uint64(outnvl, "space", space);
6757 return (error);
6761 * Sync the currently open TXG to disk for the specified pool.
6762 * This is somewhat similar to 'zfs_sync()'.
6763 * For cases that do not result in error this ioctl will wait for
6764 * the currently open TXG to commit before returning back to the caller.
6766 * innvl: {
6767 * "force" -> when true, force uberblock update even if there is no dirty data.
6768 * In addition this will cause the vdev configuration to be written
6769 * out including updating the zpool cache file. (boolean_t)
6772 * onvl is unused
6774 static const zfs_ioc_key_t zfs_keys_pool_sync[] = {
6775 {"force", DATA_TYPE_BOOLEAN_VALUE, 0},
6778 static int
6779 zfs_ioc_pool_sync(const char *pool, nvlist_t *innvl, nvlist_t *onvl)
6781 (void) onvl;
6782 int err;
6783 boolean_t rc, force = B_FALSE;
6784 spa_t *spa;
6786 if ((err = spa_open(pool, &spa, FTAG)) != 0)
6787 return (err);
6789 if (innvl) {
6790 err = nvlist_lookup_boolean_value(innvl, "force", &rc);
6791 if (err == 0)
6792 force = rc;
6795 if (force) {
6796 spa_config_enter(spa, SCL_CONFIG, FTAG, RW_WRITER);
6797 vdev_config_dirty(spa->spa_root_vdev);
6798 spa_config_exit(spa, SCL_CONFIG, FTAG);
6800 txg_wait_synced(spa_get_dsl(spa), 0);
6802 spa_close(spa, FTAG);
6804 return (0);
6808 * Load a user's wrapping key into the kernel.
6809 * innvl: {
6810 * "hidden_args" -> { "wkeydata" -> value }
6811 * raw uint8_t array of encryption wrapping key data (32 bytes)
6812 * (optional) "noop" -> (value ignored)
6813 * presence indicated key should only be verified, not loaded
6816 static const zfs_ioc_key_t zfs_keys_load_key[] = {
6817 {"hidden_args", DATA_TYPE_NVLIST, 0},
6818 {"noop", DATA_TYPE_BOOLEAN, ZK_OPTIONAL},
6821 static int
6822 zfs_ioc_load_key(const char *dsname, nvlist_t *innvl, nvlist_t *outnvl)
6824 (void) outnvl;
6825 int ret;
6826 dsl_crypto_params_t *dcp = NULL;
6827 nvlist_t *hidden_args;
6828 boolean_t noop = nvlist_exists(innvl, "noop");
6830 if (strchr(dsname, '@') != NULL || strchr(dsname, '%') != NULL) {
6831 ret = SET_ERROR(EINVAL);
6832 goto error;
6835 hidden_args = fnvlist_lookup_nvlist(innvl, ZPOOL_HIDDEN_ARGS);
6837 ret = dsl_crypto_params_create_nvlist(DCP_CMD_NONE, NULL,
6838 hidden_args, &dcp);
6839 if (ret != 0)
6840 goto error;
6842 ret = spa_keystore_load_wkey(dsname, dcp, noop);
6843 if (ret != 0)
6844 goto error;
6846 dsl_crypto_params_free(dcp, noop);
6848 return (0);
6850 error:
6851 dsl_crypto_params_free(dcp, B_TRUE);
6852 return (ret);
6856 * Unload a user's wrapping key from the kernel.
6857 * Both innvl and outnvl are unused.
6859 static const zfs_ioc_key_t zfs_keys_unload_key[] = {
6860 /* no nvl keys */
6863 static int
6864 zfs_ioc_unload_key(const char *dsname, nvlist_t *innvl, nvlist_t *outnvl)
6866 (void) innvl, (void) outnvl;
6867 int ret = 0;
6869 if (strchr(dsname, '@') != NULL || strchr(dsname, '%') != NULL) {
6870 ret = (SET_ERROR(EINVAL));
6871 goto out;
6874 ret = spa_keystore_unload_wkey(dsname);
6875 if (ret != 0)
6876 goto out;
6878 out:
6879 return (ret);
6883 * Changes a user's wrapping key used to decrypt a dataset. The keyformat,
6884 * keylocation, pbkdf2salt, and pbkdf2iters properties can also be specified
6885 * here to change how the key is derived in userspace.
6887 * innvl: {
6888 * "hidden_args" (optional) -> { "wkeydata" -> value }
6889 * raw uint8_t array of new encryption wrapping key data (32 bytes)
6890 * "props" (optional) -> { prop -> value }
6893 * outnvl is unused
6895 static const zfs_ioc_key_t zfs_keys_change_key[] = {
6896 {"crypt_cmd", DATA_TYPE_UINT64, ZK_OPTIONAL},
6897 {"hidden_args", DATA_TYPE_NVLIST, ZK_OPTIONAL},
6898 {"props", DATA_TYPE_NVLIST, ZK_OPTIONAL},
6901 static int
6902 zfs_ioc_change_key(const char *dsname, nvlist_t *innvl, nvlist_t *outnvl)
6904 (void) outnvl;
6905 int ret;
6906 uint64_t cmd = DCP_CMD_NONE;
6907 dsl_crypto_params_t *dcp = NULL;
6908 nvlist_t *args = NULL, *hidden_args = NULL;
6910 if (strchr(dsname, '@') != NULL || strchr(dsname, '%') != NULL) {
6911 ret = (SET_ERROR(EINVAL));
6912 goto error;
6915 (void) nvlist_lookup_uint64(innvl, "crypt_cmd", &cmd);
6916 (void) nvlist_lookup_nvlist(innvl, "props", &args);
6917 (void) nvlist_lookup_nvlist(innvl, ZPOOL_HIDDEN_ARGS, &hidden_args);
6919 ret = dsl_crypto_params_create_nvlist(cmd, args, hidden_args, &dcp);
6920 if (ret != 0)
6921 goto error;
6923 ret = spa_keystore_change_key(dsname, dcp);
6924 if (ret != 0)
6925 goto error;
6927 dsl_crypto_params_free(dcp, B_FALSE);
6929 return (0);
6931 error:
6932 dsl_crypto_params_free(dcp, B_TRUE);
6933 return (ret);
6936 static zfs_ioc_vec_t zfs_ioc_vec[ZFS_IOC_LAST - ZFS_IOC_FIRST];
6938 static void
6939 zfs_ioctl_register_legacy(zfs_ioc_t ioc, zfs_ioc_legacy_func_t *func,
6940 zfs_secpolicy_func_t *secpolicy, zfs_ioc_namecheck_t namecheck,
6941 boolean_t log_history, zfs_ioc_poolcheck_t pool_check)
6943 zfs_ioc_vec_t *vec = &zfs_ioc_vec[ioc - ZFS_IOC_FIRST];
6945 ASSERT3U(ioc, >=, ZFS_IOC_FIRST);
6946 ASSERT3U(ioc, <, ZFS_IOC_LAST);
6947 ASSERT3P(vec->zvec_legacy_func, ==, NULL);
6948 ASSERT3P(vec->zvec_func, ==, NULL);
6950 vec->zvec_legacy_func = func;
6951 vec->zvec_secpolicy = secpolicy;
6952 vec->zvec_namecheck = namecheck;
6953 vec->zvec_allow_log = log_history;
6954 vec->zvec_pool_check = pool_check;
6958 * See the block comment at the beginning of this file for details on
6959 * each argument to this function.
6961 void
6962 zfs_ioctl_register(const char *name, zfs_ioc_t ioc, zfs_ioc_func_t *func,
6963 zfs_secpolicy_func_t *secpolicy, zfs_ioc_namecheck_t namecheck,
6964 zfs_ioc_poolcheck_t pool_check, boolean_t smush_outnvlist,
6965 boolean_t allow_log, const zfs_ioc_key_t *nvl_keys, size_t num_keys)
6967 zfs_ioc_vec_t *vec = &zfs_ioc_vec[ioc - ZFS_IOC_FIRST];
6969 ASSERT3U(ioc, >=, ZFS_IOC_FIRST);
6970 ASSERT3U(ioc, <, ZFS_IOC_LAST);
6971 ASSERT3P(vec->zvec_legacy_func, ==, NULL);
6972 ASSERT3P(vec->zvec_func, ==, NULL);
6974 /* if we are logging, the name must be valid */
6975 ASSERT(!allow_log || namecheck != NO_NAME);
6977 vec->zvec_name = name;
6978 vec->zvec_func = func;
6979 vec->zvec_secpolicy = secpolicy;
6980 vec->zvec_namecheck = namecheck;
6981 vec->zvec_pool_check = pool_check;
6982 vec->zvec_smush_outnvlist = smush_outnvlist;
6983 vec->zvec_allow_log = allow_log;
6984 vec->zvec_nvl_keys = nvl_keys;
6985 vec->zvec_nvl_key_count = num_keys;
6988 static void
6989 zfs_ioctl_register_pool(zfs_ioc_t ioc, zfs_ioc_legacy_func_t *func,
6990 zfs_secpolicy_func_t *secpolicy, boolean_t log_history,
6991 zfs_ioc_poolcheck_t pool_check)
6993 zfs_ioctl_register_legacy(ioc, func, secpolicy,
6994 POOL_NAME, log_history, pool_check);
6997 void
6998 zfs_ioctl_register_dataset_nolog(zfs_ioc_t ioc, zfs_ioc_legacy_func_t *func,
6999 zfs_secpolicy_func_t *secpolicy, zfs_ioc_poolcheck_t pool_check)
7001 zfs_ioctl_register_legacy(ioc, func, secpolicy,
7002 DATASET_NAME, B_FALSE, pool_check);
7005 static void
7006 zfs_ioctl_register_pool_modify(zfs_ioc_t ioc, zfs_ioc_legacy_func_t *func)
7008 zfs_ioctl_register_legacy(ioc, func, zfs_secpolicy_config,
7009 POOL_NAME, B_TRUE, POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY);
7012 static void
7013 zfs_ioctl_register_pool_meta(zfs_ioc_t ioc, zfs_ioc_legacy_func_t *func,
7014 zfs_secpolicy_func_t *secpolicy)
7016 zfs_ioctl_register_legacy(ioc, func, secpolicy,
7017 NO_NAME, B_FALSE, POOL_CHECK_NONE);
7020 static void
7021 zfs_ioctl_register_dataset_read_secpolicy(zfs_ioc_t ioc,
7022 zfs_ioc_legacy_func_t *func, zfs_secpolicy_func_t *secpolicy)
7024 zfs_ioctl_register_legacy(ioc, func, secpolicy,
7025 DATASET_NAME, B_FALSE, POOL_CHECK_SUSPENDED);
7028 static void
7029 zfs_ioctl_register_dataset_read(zfs_ioc_t ioc, zfs_ioc_legacy_func_t *func)
7031 zfs_ioctl_register_dataset_read_secpolicy(ioc, func,
7032 zfs_secpolicy_read);
7035 static void
7036 zfs_ioctl_register_dataset_modify(zfs_ioc_t ioc, zfs_ioc_legacy_func_t *func,
7037 zfs_secpolicy_func_t *secpolicy)
7039 zfs_ioctl_register_legacy(ioc, func, secpolicy,
7040 DATASET_NAME, B_TRUE, POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY);
7043 static void
7044 zfs_ioctl_init(void)
7046 zfs_ioctl_register("snapshot", ZFS_IOC_SNAPSHOT,
7047 zfs_ioc_snapshot, zfs_secpolicy_snapshot, POOL_NAME,
7048 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7049 zfs_keys_snapshot, ARRAY_SIZE(zfs_keys_snapshot));
7051 zfs_ioctl_register("log_history", ZFS_IOC_LOG_HISTORY,
7052 zfs_ioc_log_history, zfs_secpolicy_log_history, NO_NAME,
7053 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_FALSE, B_FALSE,
7054 zfs_keys_log_history, ARRAY_SIZE(zfs_keys_log_history));
7056 zfs_ioctl_register("space_snaps", ZFS_IOC_SPACE_SNAPS,
7057 zfs_ioc_space_snaps, zfs_secpolicy_read, DATASET_NAME,
7058 POOL_CHECK_SUSPENDED, B_FALSE, B_FALSE,
7059 zfs_keys_space_snaps, ARRAY_SIZE(zfs_keys_space_snaps));
7061 zfs_ioctl_register("send", ZFS_IOC_SEND_NEW,
7062 zfs_ioc_send_new, zfs_secpolicy_send_new, DATASET_NAME,
7063 POOL_CHECK_SUSPENDED, B_FALSE, B_FALSE,
7064 zfs_keys_send_new, ARRAY_SIZE(zfs_keys_send_new));
7066 zfs_ioctl_register("send_space", ZFS_IOC_SEND_SPACE,
7067 zfs_ioc_send_space, zfs_secpolicy_read, DATASET_NAME,
7068 POOL_CHECK_SUSPENDED, B_FALSE, B_FALSE,
7069 zfs_keys_send_space, ARRAY_SIZE(zfs_keys_send_space));
7071 zfs_ioctl_register("create", ZFS_IOC_CREATE,
7072 zfs_ioc_create, zfs_secpolicy_create_clone, DATASET_NAME,
7073 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7074 zfs_keys_create, ARRAY_SIZE(zfs_keys_create));
7076 zfs_ioctl_register("clone", ZFS_IOC_CLONE,
7077 zfs_ioc_clone, zfs_secpolicy_create_clone, DATASET_NAME,
7078 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7079 zfs_keys_clone, ARRAY_SIZE(zfs_keys_clone));
7081 zfs_ioctl_register("remap", ZFS_IOC_REMAP,
7082 zfs_ioc_remap, zfs_secpolicy_none, DATASET_NAME,
7083 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_FALSE, B_TRUE,
7084 zfs_keys_remap, ARRAY_SIZE(zfs_keys_remap));
7086 zfs_ioctl_register("destroy_snaps", ZFS_IOC_DESTROY_SNAPS,
7087 zfs_ioc_destroy_snaps, zfs_secpolicy_destroy_snaps, POOL_NAME,
7088 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7089 zfs_keys_destroy_snaps, ARRAY_SIZE(zfs_keys_destroy_snaps));
7091 zfs_ioctl_register("hold", ZFS_IOC_HOLD,
7092 zfs_ioc_hold, zfs_secpolicy_hold, POOL_NAME,
7093 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7094 zfs_keys_hold, ARRAY_SIZE(zfs_keys_hold));
7095 zfs_ioctl_register("release", ZFS_IOC_RELEASE,
7096 zfs_ioc_release, zfs_secpolicy_release, POOL_NAME,
7097 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7098 zfs_keys_release, ARRAY_SIZE(zfs_keys_release));
7100 zfs_ioctl_register("get_holds", ZFS_IOC_GET_HOLDS,
7101 zfs_ioc_get_holds, zfs_secpolicy_read, DATASET_NAME,
7102 POOL_CHECK_SUSPENDED, B_FALSE, B_FALSE,
7103 zfs_keys_get_holds, ARRAY_SIZE(zfs_keys_get_holds));
7105 zfs_ioctl_register("rollback", ZFS_IOC_ROLLBACK,
7106 zfs_ioc_rollback, zfs_secpolicy_rollback, DATASET_NAME,
7107 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_FALSE, B_TRUE,
7108 zfs_keys_rollback, ARRAY_SIZE(zfs_keys_rollback));
7110 zfs_ioctl_register("bookmark", ZFS_IOC_BOOKMARK,
7111 zfs_ioc_bookmark, zfs_secpolicy_bookmark, POOL_NAME,
7112 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7113 zfs_keys_bookmark, ARRAY_SIZE(zfs_keys_bookmark));
7115 zfs_ioctl_register("get_bookmarks", ZFS_IOC_GET_BOOKMARKS,
7116 zfs_ioc_get_bookmarks, zfs_secpolicy_read, DATASET_NAME,
7117 POOL_CHECK_SUSPENDED, B_FALSE, B_FALSE,
7118 zfs_keys_get_bookmarks, ARRAY_SIZE(zfs_keys_get_bookmarks));
7120 zfs_ioctl_register("get_bookmark_props", ZFS_IOC_GET_BOOKMARK_PROPS,
7121 zfs_ioc_get_bookmark_props, zfs_secpolicy_read, ENTITY_NAME,
7122 POOL_CHECK_SUSPENDED, B_FALSE, B_FALSE, zfs_keys_get_bookmark_props,
7123 ARRAY_SIZE(zfs_keys_get_bookmark_props));
7125 zfs_ioctl_register("destroy_bookmarks", ZFS_IOC_DESTROY_BOOKMARKS,
7126 zfs_ioc_destroy_bookmarks, zfs_secpolicy_destroy_bookmarks,
7127 POOL_NAME,
7128 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7129 zfs_keys_destroy_bookmarks,
7130 ARRAY_SIZE(zfs_keys_destroy_bookmarks));
7132 zfs_ioctl_register("receive", ZFS_IOC_RECV_NEW,
7133 zfs_ioc_recv_new, zfs_secpolicy_recv, DATASET_NAME,
7134 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7135 zfs_keys_recv_new, ARRAY_SIZE(zfs_keys_recv_new));
7136 zfs_ioctl_register("load-key", ZFS_IOC_LOAD_KEY,
7137 zfs_ioc_load_key, zfs_secpolicy_load_key,
7138 DATASET_NAME, POOL_CHECK_SUSPENDED, B_TRUE, B_TRUE,
7139 zfs_keys_load_key, ARRAY_SIZE(zfs_keys_load_key));
7140 zfs_ioctl_register("unload-key", ZFS_IOC_UNLOAD_KEY,
7141 zfs_ioc_unload_key, zfs_secpolicy_load_key,
7142 DATASET_NAME, POOL_CHECK_SUSPENDED, B_TRUE, B_TRUE,
7143 zfs_keys_unload_key, ARRAY_SIZE(zfs_keys_unload_key));
7144 zfs_ioctl_register("change-key", ZFS_IOC_CHANGE_KEY,
7145 zfs_ioc_change_key, zfs_secpolicy_change_key,
7146 DATASET_NAME, POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY,
7147 B_TRUE, B_TRUE, zfs_keys_change_key,
7148 ARRAY_SIZE(zfs_keys_change_key));
7150 zfs_ioctl_register("sync", ZFS_IOC_POOL_SYNC,
7151 zfs_ioc_pool_sync, zfs_secpolicy_none, POOL_NAME,
7152 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_FALSE, B_FALSE,
7153 zfs_keys_pool_sync, ARRAY_SIZE(zfs_keys_pool_sync));
7154 zfs_ioctl_register("reopen", ZFS_IOC_POOL_REOPEN, zfs_ioc_pool_reopen,
7155 zfs_secpolicy_config, POOL_NAME, POOL_CHECK_SUSPENDED, B_TRUE,
7156 B_TRUE, zfs_keys_pool_reopen, ARRAY_SIZE(zfs_keys_pool_reopen));
7158 zfs_ioctl_register("channel_program", ZFS_IOC_CHANNEL_PROGRAM,
7159 zfs_ioc_channel_program, zfs_secpolicy_config,
7160 POOL_NAME, POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE,
7161 B_TRUE, zfs_keys_channel_program,
7162 ARRAY_SIZE(zfs_keys_channel_program));
7164 zfs_ioctl_register("redact", ZFS_IOC_REDACT,
7165 zfs_ioc_redact, zfs_secpolicy_config, DATASET_NAME,
7166 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7167 zfs_keys_redact, ARRAY_SIZE(zfs_keys_redact));
7169 zfs_ioctl_register("zpool_checkpoint", ZFS_IOC_POOL_CHECKPOINT,
7170 zfs_ioc_pool_checkpoint, zfs_secpolicy_config, POOL_NAME,
7171 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7172 zfs_keys_pool_checkpoint, ARRAY_SIZE(zfs_keys_pool_checkpoint));
7174 zfs_ioctl_register("zpool_discard_checkpoint",
7175 ZFS_IOC_POOL_DISCARD_CHECKPOINT, zfs_ioc_pool_discard_checkpoint,
7176 zfs_secpolicy_config, POOL_NAME,
7177 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7178 zfs_keys_pool_discard_checkpoint,
7179 ARRAY_SIZE(zfs_keys_pool_discard_checkpoint));
7181 zfs_ioctl_register("initialize", ZFS_IOC_POOL_INITIALIZE,
7182 zfs_ioc_pool_initialize, zfs_secpolicy_config, POOL_NAME,
7183 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7184 zfs_keys_pool_initialize, ARRAY_SIZE(zfs_keys_pool_initialize));
7186 zfs_ioctl_register("trim", ZFS_IOC_POOL_TRIM,
7187 zfs_ioc_pool_trim, zfs_secpolicy_config, POOL_NAME,
7188 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_TRUE, B_TRUE,
7189 zfs_keys_pool_trim, ARRAY_SIZE(zfs_keys_pool_trim));
7191 zfs_ioctl_register("wait", ZFS_IOC_WAIT,
7192 zfs_ioc_wait, zfs_secpolicy_none, POOL_NAME,
7193 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_FALSE, B_FALSE,
7194 zfs_keys_pool_wait, ARRAY_SIZE(zfs_keys_pool_wait));
7196 zfs_ioctl_register("wait_fs", ZFS_IOC_WAIT_FS,
7197 zfs_ioc_wait_fs, zfs_secpolicy_none, DATASET_NAME,
7198 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_FALSE, B_FALSE,
7199 zfs_keys_fs_wait, ARRAY_SIZE(zfs_keys_fs_wait));
7201 zfs_ioctl_register("set_bootenv", ZFS_IOC_SET_BOOTENV,
7202 zfs_ioc_set_bootenv, zfs_secpolicy_config, POOL_NAME,
7203 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_FALSE, B_TRUE,
7204 zfs_keys_set_bootenv, ARRAY_SIZE(zfs_keys_set_bootenv));
7206 zfs_ioctl_register("get_bootenv", ZFS_IOC_GET_BOOTENV,
7207 zfs_ioc_get_bootenv, zfs_secpolicy_none, POOL_NAME,
7208 POOL_CHECK_SUSPENDED, B_FALSE, B_TRUE,
7209 zfs_keys_get_bootenv, ARRAY_SIZE(zfs_keys_get_bootenv));
7211 zfs_ioctl_register("zpool_vdev_get_props", ZFS_IOC_VDEV_GET_PROPS,
7212 zfs_ioc_vdev_get_props, zfs_secpolicy_read, POOL_NAME,
7213 POOL_CHECK_NONE, B_FALSE, B_FALSE, zfs_keys_vdev_get_props,
7214 ARRAY_SIZE(zfs_keys_vdev_get_props));
7216 zfs_ioctl_register("zpool_vdev_set_props", ZFS_IOC_VDEV_SET_PROPS,
7217 zfs_ioc_vdev_set_props, zfs_secpolicy_config, POOL_NAME,
7218 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY, B_FALSE, B_FALSE,
7219 zfs_keys_vdev_set_props, ARRAY_SIZE(zfs_keys_vdev_set_props));
7221 /* IOCTLS that use the legacy function signature */
7223 zfs_ioctl_register_legacy(ZFS_IOC_POOL_FREEZE, zfs_ioc_pool_freeze,
7224 zfs_secpolicy_config, NO_NAME, B_FALSE, POOL_CHECK_READONLY);
7226 zfs_ioctl_register_pool(ZFS_IOC_POOL_CREATE, zfs_ioc_pool_create,
7227 zfs_secpolicy_config, B_TRUE, POOL_CHECK_NONE);
7228 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_SCAN,
7229 zfs_ioc_pool_scan);
7230 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_UPGRADE,
7231 zfs_ioc_pool_upgrade);
7232 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_ADD,
7233 zfs_ioc_vdev_add);
7234 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_REMOVE,
7235 zfs_ioc_vdev_remove);
7236 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SET_STATE,
7237 zfs_ioc_vdev_set_state);
7238 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_ATTACH,
7239 zfs_ioc_vdev_attach);
7240 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_DETACH,
7241 zfs_ioc_vdev_detach);
7242 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SETPATH,
7243 zfs_ioc_vdev_setpath);
7244 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SETFRU,
7245 zfs_ioc_vdev_setfru);
7246 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_SET_PROPS,
7247 zfs_ioc_pool_set_props);
7248 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SPLIT,
7249 zfs_ioc_vdev_split);
7250 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_REGUID,
7251 zfs_ioc_pool_reguid);
7253 zfs_ioctl_register_pool_meta(ZFS_IOC_POOL_CONFIGS,
7254 zfs_ioc_pool_configs, zfs_secpolicy_none);
7255 zfs_ioctl_register_pool_meta(ZFS_IOC_POOL_TRYIMPORT,
7256 zfs_ioc_pool_tryimport, zfs_secpolicy_config);
7257 zfs_ioctl_register_pool_meta(ZFS_IOC_INJECT_FAULT,
7258 zfs_ioc_inject_fault, zfs_secpolicy_inject);
7259 zfs_ioctl_register_pool_meta(ZFS_IOC_CLEAR_FAULT,
7260 zfs_ioc_clear_fault, zfs_secpolicy_inject);
7261 zfs_ioctl_register_pool_meta(ZFS_IOC_INJECT_LIST_NEXT,
7262 zfs_ioc_inject_list_next, zfs_secpolicy_inject);
7265 * pool destroy, and export don't log the history as part of
7266 * zfsdev_ioctl, but rather zfs_ioc_pool_export
7267 * does the logging of those commands.
7269 zfs_ioctl_register_pool(ZFS_IOC_POOL_DESTROY, zfs_ioc_pool_destroy,
7270 zfs_secpolicy_config, B_FALSE, POOL_CHECK_SUSPENDED);
7271 zfs_ioctl_register_pool(ZFS_IOC_POOL_EXPORT, zfs_ioc_pool_export,
7272 zfs_secpolicy_config, B_FALSE, POOL_CHECK_SUSPENDED);
7274 zfs_ioctl_register_pool(ZFS_IOC_POOL_STATS, zfs_ioc_pool_stats,
7275 zfs_secpolicy_read, B_FALSE, POOL_CHECK_NONE);
7276 zfs_ioctl_register_pool(ZFS_IOC_POOL_GET_PROPS, zfs_ioc_pool_get_props,
7277 zfs_secpolicy_read, B_FALSE, POOL_CHECK_NONE);
7279 zfs_ioctl_register_pool(ZFS_IOC_ERROR_LOG, zfs_ioc_error_log,
7280 zfs_secpolicy_inject, B_FALSE, POOL_CHECK_SUSPENDED);
7281 zfs_ioctl_register_pool(ZFS_IOC_DSOBJ_TO_DSNAME,
7282 zfs_ioc_dsobj_to_dsname,
7283 zfs_secpolicy_diff, B_FALSE, POOL_CHECK_SUSPENDED);
7284 zfs_ioctl_register_pool(ZFS_IOC_POOL_GET_HISTORY,
7285 zfs_ioc_pool_get_history,
7286 zfs_secpolicy_config, B_FALSE, POOL_CHECK_SUSPENDED);
7288 zfs_ioctl_register_pool(ZFS_IOC_POOL_IMPORT, zfs_ioc_pool_import,
7289 zfs_secpolicy_config, B_TRUE, POOL_CHECK_NONE);
7291 zfs_ioctl_register_pool(ZFS_IOC_CLEAR, zfs_ioc_clear,
7292 zfs_secpolicy_config, B_TRUE, POOL_CHECK_READONLY);
7294 zfs_ioctl_register_dataset_read(ZFS_IOC_SPACE_WRITTEN,
7295 zfs_ioc_space_written);
7296 zfs_ioctl_register_dataset_read(ZFS_IOC_OBJSET_RECVD_PROPS,
7297 zfs_ioc_objset_recvd_props);
7298 zfs_ioctl_register_dataset_read(ZFS_IOC_NEXT_OBJ,
7299 zfs_ioc_next_obj);
7300 zfs_ioctl_register_dataset_read(ZFS_IOC_GET_FSACL,
7301 zfs_ioc_get_fsacl);
7302 zfs_ioctl_register_dataset_read(ZFS_IOC_OBJSET_STATS,
7303 zfs_ioc_objset_stats);
7304 zfs_ioctl_register_dataset_read(ZFS_IOC_OBJSET_ZPLPROPS,
7305 zfs_ioc_objset_zplprops);
7306 zfs_ioctl_register_dataset_read(ZFS_IOC_DATASET_LIST_NEXT,
7307 zfs_ioc_dataset_list_next);
7308 zfs_ioctl_register_dataset_read(ZFS_IOC_SNAPSHOT_LIST_NEXT,
7309 zfs_ioc_snapshot_list_next);
7310 zfs_ioctl_register_dataset_read(ZFS_IOC_SEND_PROGRESS,
7311 zfs_ioc_send_progress);
7313 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_DIFF,
7314 zfs_ioc_diff, zfs_secpolicy_diff);
7315 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_OBJ_TO_STATS,
7316 zfs_ioc_obj_to_stats, zfs_secpolicy_diff);
7317 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_OBJ_TO_PATH,
7318 zfs_ioc_obj_to_path, zfs_secpolicy_diff);
7319 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_USERSPACE_ONE,
7320 zfs_ioc_userspace_one, zfs_secpolicy_userspace_one);
7321 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_USERSPACE_MANY,
7322 zfs_ioc_userspace_many, zfs_secpolicy_userspace_many);
7323 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_SEND,
7324 zfs_ioc_send, zfs_secpolicy_send);
7326 zfs_ioctl_register_dataset_modify(ZFS_IOC_SET_PROP, zfs_ioc_set_prop,
7327 zfs_secpolicy_none);
7328 zfs_ioctl_register_dataset_modify(ZFS_IOC_DESTROY, zfs_ioc_destroy,
7329 zfs_secpolicy_destroy);
7330 zfs_ioctl_register_dataset_modify(ZFS_IOC_RENAME, zfs_ioc_rename,
7331 zfs_secpolicy_rename);
7332 zfs_ioctl_register_dataset_modify(ZFS_IOC_RECV, zfs_ioc_recv,
7333 zfs_secpolicy_recv);
7334 zfs_ioctl_register_dataset_modify(ZFS_IOC_PROMOTE, zfs_ioc_promote,
7335 zfs_secpolicy_promote);
7336 zfs_ioctl_register_dataset_modify(ZFS_IOC_INHERIT_PROP,
7337 zfs_ioc_inherit_prop, zfs_secpolicy_inherit_prop);
7338 zfs_ioctl_register_dataset_modify(ZFS_IOC_SET_FSACL, zfs_ioc_set_fsacl,
7339 zfs_secpolicy_set_fsacl);
7341 zfs_ioctl_register_dataset_nolog(ZFS_IOC_SHARE, zfs_ioc_share,
7342 zfs_secpolicy_share, POOL_CHECK_NONE);
7343 zfs_ioctl_register_dataset_nolog(ZFS_IOC_SMB_ACL, zfs_ioc_smb_acl,
7344 zfs_secpolicy_smb_acl, POOL_CHECK_NONE);
7345 zfs_ioctl_register_dataset_nolog(ZFS_IOC_USERSPACE_UPGRADE,
7346 zfs_ioc_userspace_upgrade, zfs_secpolicy_userspace_upgrade,
7347 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY);
7348 zfs_ioctl_register_dataset_nolog(ZFS_IOC_TMP_SNAPSHOT,
7349 zfs_ioc_tmp_snapshot, zfs_secpolicy_tmp_snapshot,
7350 POOL_CHECK_SUSPENDED | POOL_CHECK_READONLY);
7352 zfs_ioctl_register_legacy(ZFS_IOC_EVENTS_NEXT, zfs_ioc_events_next,
7353 zfs_secpolicy_config, NO_NAME, B_FALSE, POOL_CHECK_NONE);
7354 zfs_ioctl_register_legacy(ZFS_IOC_EVENTS_CLEAR, zfs_ioc_events_clear,
7355 zfs_secpolicy_config, NO_NAME, B_FALSE, POOL_CHECK_NONE);
7356 zfs_ioctl_register_legacy(ZFS_IOC_EVENTS_SEEK, zfs_ioc_events_seek,
7357 zfs_secpolicy_config, NO_NAME, B_FALSE, POOL_CHECK_NONE);
7359 zfs_ioctl_init_os();
7363 * Verify that for non-legacy ioctls the input nvlist
7364 * pairs match against the expected input.
7366 * Possible errors are:
7367 * ZFS_ERR_IOC_ARG_UNAVAIL An unrecognized nvpair was encountered
7368 * ZFS_ERR_IOC_ARG_REQUIRED A required nvpair is missing
7369 * ZFS_ERR_IOC_ARG_BADTYPE Invalid type for nvpair
7371 static int
7372 zfs_check_input_nvpairs(nvlist_t *innvl, const zfs_ioc_vec_t *vec)
7374 const zfs_ioc_key_t *nvl_keys = vec->zvec_nvl_keys;
7375 boolean_t required_keys_found = B_FALSE;
7378 * examine each input pair
7380 for (nvpair_t *pair = nvlist_next_nvpair(innvl, NULL);
7381 pair != NULL; pair = nvlist_next_nvpair(innvl, pair)) {
7382 const char *name = nvpair_name(pair);
7383 data_type_t type = nvpair_type(pair);
7384 boolean_t identified = B_FALSE;
7387 * check pair against the documented names and type
7389 for (int k = 0; k < vec->zvec_nvl_key_count; k++) {
7390 /* if not a wild card name, check for an exact match */
7391 if ((nvl_keys[k].zkey_flags & ZK_WILDCARDLIST) == 0 &&
7392 strcmp(nvl_keys[k].zkey_name, name) != 0)
7393 continue;
7395 identified = B_TRUE;
7397 if (nvl_keys[k].zkey_type != DATA_TYPE_ANY &&
7398 nvl_keys[k].zkey_type != type) {
7399 return (SET_ERROR(ZFS_ERR_IOC_ARG_BADTYPE));
7402 if (nvl_keys[k].zkey_flags & ZK_OPTIONAL)
7403 continue;
7405 required_keys_found = B_TRUE;
7406 break;
7409 /* allow an 'optional' key, everything else is invalid */
7410 if (!identified &&
7411 (strcmp(name, "optional") != 0 ||
7412 type != DATA_TYPE_NVLIST)) {
7413 return (SET_ERROR(ZFS_ERR_IOC_ARG_UNAVAIL));
7417 /* verify that all required keys were found */
7418 for (int k = 0; k < vec->zvec_nvl_key_count; k++) {
7419 if (nvl_keys[k].zkey_flags & ZK_OPTIONAL)
7420 continue;
7422 if (nvl_keys[k].zkey_flags & ZK_WILDCARDLIST) {
7423 /* at least one non-optional key is expected here */
7424 if (!required_keys_found)
7425 return (SET_ERROR(ZFS_ERR_IOC_ARG_REQUIRED));
7426 continue;
7429 if (!nvlist_exists(innvl, nvl_keys[k].zkey_name))
7430 return (SET_ERROR(ZFS_ERR_IOC_ARG_REQUIRED));
7433 return (0);
7436 static int
7437 pool_status_check(const char *name, zfs_ioc_namecheck_t type,
7438 zfs_ioc_poolcheck_t check)
7440 spa_t *spa;
7441 int error;
7443 ASSERT(type == POOL_NAME || type == DATASET_NAME ||
7444 type == ENTITY_NAME);
7446 if (check & POOL_CHECK_NONE)
7447 return (0);
7449 error = spa_open(name, &spa, FTAG);
7450 if (error == 0) {
7451 if ((check & POOL_CHECK_SUSPENDED) && spa_suspended(spa))
7452 error = SET_ERROR(EAGAIN);
7453 else if ((check & POOL_CHECK_READONLY) && !spa_writeable(spa))
7454 error = SET_ERROR(EROFS);
7455 spa_close(spa, FTAG);
7457 return (error);
7461 zfsdev_getminor(zfs_file_t *fp, minor_t *minorp)
7463 zfsdev_state_t *zs, *fpd;
7465 ASSERT(!MUTEX_HELD(&zfsdev_state_lock));
7467 fpd = zfs_file_private(fp);
7468 if (fpd == NULL)
7469 return (SET_ERROR(EBADF));
7471 mutex_enter(&zfsdev_state_lock);
7473 for (zs = &zfsdev_state_listhead; zs != NULL; zs = zs->zs_next) {
7475 if (zs->zs_minor == -1)
7476 continue;
7478 if (fpd == zs) {
7479 *minorp = fpd->zs_minor;
7480 mutex_exit(&zfsdev_state_lock);
7481 return (0);
7485 mutex_exit(&zfsdev_state_lock);
7487 return (SET_ERROR(EBADF));
7490 void *
7491 zfsdev_get_state(minor_t minor, enum zfsdev_state_type which)
7493 zfsdev_state_t *zs;
7495 for (zs = &zfsdev_state_listhead; zs != NULL; zs = zs->zs_next) {
7496 if (zs->zs_minor == minor) {
7497 membar_consumer();
7498 switch (which) {
7499 case ZST_ONEXIT:
7500 return (zs->zs_onexit);
7501 case ZST_ZEVENT:
7502 return (zs->zs_zevent);
7503 case ZST_ALL:
7504 return (zs);
7509 return (NULL);
7513 * Find a free minor number. The zfsdev_state_list is expected to
7514 * be short since it is only a list of currently open file handles.
7516 static minor_t
7517 zfsdev_minor_alloc(void)
7519 static minor_t last_minor = 0;
7520 minor_t m;
7522 ASSERT(MUTEX_HELD(&zfsdev_state_lock));
7524 for (m = last_minor + 1; m != last_minor; m++) {
7525 if (m > ZFSDEV_MAX_MINOR)
7526 m = 1;
7527 if (zfsdev_get_state(m, ZST_ALL) == NULL) {
7528 last_minor = m;
7529 return (m);
7533 return (0);
7537 zfsdev_state_init(void *priv)
7539 zfsdev_state_t *zs, *zsprev = NULL;
7540 minor_t minor;
7541 boolean_t newzs = B_FALSE;
7543 ASSERT(MUTEX_HELD(&zfsdev_state_lock));
7545 minor = zfsdev_minor_alloc();
7546 if (minor == 0)
7547 return (SET_ERROR(ENXIO));
7549 for (zs = &zfsdev_state_listhead; zs != NULL; zs = zs->zs_next) {
7550 if (zs->zs_minor == -1)
7551 break;
7552 zsprev = zs;
7555 if (!zs) {
7556 zs = kmem_zalloc(sizeof (zfsdev_state_t), KM_SLEEP);
7557 newzs = B_TRUE;
7560 zfsdev_private_set_state(priv, zs);
7562 zfs_onexit_init((zfs_onexit_t **)&zs->zs_onexit);
7563 zfs_zevent_init((zfs_zevent_t **)&zs->zs_zevent);
7566 * In order to provide for lock-free concurrent read access
7567 * to the minor list in zfsdev_get_state(), new entries
7568 * must be completely written before linking them into the
7569 * list whereas existing entries are already linked; the last
7570 * operation must be updating zs_minor (from -1 to the new
7571 * value).
7573 if (newzs) {
7574 zs->zs_minor = minor;
7575 membar_producer();
7576 zsprev->zs_next = zs;
7577 } else {
7578 membar_producer();
7579 zs->zs_minor = minor;
7582 return (0);
7585 void
7586 zfsdev_state_destroy(void *priv)
7588 zfsdev_state_t *zs = zfsdev_private_get_state(priv);
7590 ASSERT(zs != NULL);
7591 ASSERT3S(zs->zs_minor, >, 0);
7594 * The last reference to this zfsdev file descriptor is being dropped.
7595 * We don't have to worry about lookup grabbing this state object, and
7596 * zfsdev_state_init() will not try to reuse this object until it is
7597 * invalidated by setting zs_minor to -1. Invalidation must be done
7598 * last, with a memory barrier to ensure ordering. This lets us avoid
7599 * taking the global zfsdev state lock around destruction.
7601 zfs_onexit_destroy(zs->zs_onexit);
7602 zfs_zevent_destroy(zs->zs_zevent);
7603 zs->zs_onexit = NULL;
7604 zs->zs_zevent = NULL;
7605 membar_producer();
7606 zs->zs_minor = -1;
7609 long
7610 zfsdev_ioctl_common(uint_t vecnum, zfs_cmd_t *zc, int flag)
7612 int error, cmd;
7613 const zfs_ioc_vec_t *vec;
7614 char *saved_poolname = NULL;
7615 uint64_t max_nvlist_src_size;
7616 size_t saved_poolname_len = 0;
7617 nvlist_t *innvl = NULL;
7618 fstrans_cookie_t cookie;
7619 hrtime_t start_time = gethrtime();
7621 cmd = vecnum;
7622 error = 0;
7623 if (vecnum >= sizeof (zfs_ioc_vec) / sizeof (zfs_ioc_vec[0]))
7624 return (SET_ERROR(ZFS_ERR_IOC_CMD_UNAVAIL));
7626 vec = &zfs_ioc_vec[vecnum];
7629 * The registered ioctl list may be sparse, verify that either
7630 * a normal or legacy handler are registered.
7632 if (vec->zvec_func == NULL && vec->zvec_legacy_func == NULL)
7633 return (SET_ERROR(ZFS_ERR_IOC_CMD_UNAVAIL));
7635 zc->zc_iflags = flag & FKIOCTL;
7636 max_nvlist_src_size = zfs_max_nvlist_src_size_os();
7637 if (zc->zc_nvlist_src_size > max_nvlist_src_size) {
7639 * Make sure the user doesn't pass in an insane value for
7640 * zc_nvlist_src_size. We have to check, since we will end
7641 * up allocating that much memory inside of get_nvlist(). This
7642 * prevents a nefarious user from allocating tons of kernel
7643 * memory.
7645 * Also, we return EINVAL instead of ENOMEM here. The reason
7646 * being that returning ENOMEM from an ioctl() has a special
7647 * connotation; that the user's size value is too small and
7648 * needs to be expanded to hold the nvlist. See
7649 * zcmd_expand_dst_nvlist() for details.
7651 error = SET_ERROR(EINVAL); /* User's size too big */
7653 } else if (zc->zc_nvlist_src_size != 0) {
7654 error = get_nvlist(zc->zc_nvlist_src, zc->zc_nvlist_src_size,
7655 zc->zc_iflags, &innvl);
7656 if (error != 0)
7657 goto out;
7661 * Ensure that all pool/dataset names are valid before we pass down to
7662 * the lower layers.
7664 zc->zc_name[sizeof (zc->zc_name) - 1] = '\0';
7665 switch (vec->zvec_namecheck) {
7666 case POOL_NAME:
7667 if (pool_namecheck(zc->zc_name, NULL, NULL) != 0)
7668 error = SET_ERROR(EINVAL);
7669 else
7670 error = pool_status_check(zc->zc_name,
7671 vec->zvec_namecheck, vec->zvec_pool_check);
7672 break;
7674 case DATASET_NAME:
7675 if (dataset_namecheck(zc->zc_name, NULL, NULL) != 0)
7676 error = SET_ERROR(EINVAL);
7677 else
7678 error = pool_status_check(zc->zc_name,
7679 vec->zvec_namecheck, vec->zvec_pool_check);
7680 break;
7682 case ENTITY_NAME:
7683 if (entity_namecheck(zc->zc_name, NULL, NULL) != 0) {
7684 error = SET_ERROR(EINVAL);
7685 } else {
7686 error = pool_status_check(zc->zc_name,
7687 vec->zvec_namecheck, vec->zvec_pool_check);
7689 break;
7691 case NO_NAME:
7692 break;
7695 * Ensure that all input pairs are valid before we pass them down
7696 * to the lower layers.
7698 * The vectored functions can use fnvlist_lookup_{type} for any
7699 * required pairs since zfs_check_input_nvpairs() confirmed that
7700 * they exist and are of the correct type.
7702 if (error == 0 && vec->zvec_func != NULL) {
7703 error = zfs_check_input_nvpairs(innvl, vec);
7704 if (error != 0)
7705 goto out;
7708 if (error == 0) {
7709 cookie = spl_fstrans_mark();
7710 error = vec->zvec_secpolicy(zc, innvl, CRED());
7711 spl_fstrans_unmark(cookie);
7714 if (error != 0)
7715 goto out;
7717 /* legacy ioctls can modify zc_name */
7719 * Can't use kmem_strdup() as we might truncate the string and
7720 * kmem_strfree() would then free with incorrect size.
7722 saved_poolname_len = strlen(zc->zc_name) + 1;
7723 saved_poolname = kmem_alloc(saved_poolname_len, KM_SLEEP);
7725 strlcpy(saved_poolname, zc->zc_name, saved_poolname_len);
7726 saved_poolname[strcspn(saved_poolname, "/@#")] = '\0';
7728 if (vec->zvec_func != NULL) {
7729 nvlist_t *outnvl;
7730 int puterror = 0;
7731 spa_t *spa;
7732 nvlist_t *lognv = NULL;
7734 ASSERT(vec->zvec_legacy_func == NULL);
7737 * Add the innvl to the lognv before calling the func,
7738 * in case the func changes the innvl.
7740 if (vec->zvec_allow_log) {
7741 lognv = fnvlist_alloc();
7742 fnvlist_add_string(lognv, ZPOOL_HIST_IOCTL,
7743 vec->zvec_name);
7744 if (!nvlist_empty(innvl)) {
7745 fnvlist_add_nvlist(lognv, ZPOOL_HIST_INPUT_NVL,
7746 innvl);
7750 outnvl = fnvlist_alloc();
7751 cookie = spl_fstrans_mark();
7752 error = vec->zvec_func(zc->zc_name, innvl, outnvl);
7753 spl_fstrans_unmark(cookie);
7756 * Some commands can partially execute, modify state, and still
7757 * return an error. In these cases, attempt to record what
7758 * was modified.
7760 if ((error == 0 ||
7761 (cmd == ZFS_IOC_CHANNEL_PROGRAM && error != EINVAL)) &&
7762 vec->zvec_allow_log &&
7763 spa_open(zc->zc_name, &spa, FTAG) == 0) {
7764 if (!nvlist_empty(outnvl)) {
7765 size_t out_size = fnvlist_size(outnvl);
7766 if (out_size > zfs_history_output_max) {
7767 fnvlist_add_int64(lognv,
7768 ZPOOL_HIST_OUTPUT_SIZE, out_size);
7769 } else {
7770 fnvlist_add_nvlist(lognv,
7771 ZPOOL_HIST_OUTPUT_NVL, outnvl);
7774 if (error != 0) {
7775 fnvlist_add_int64(lognv, ZPOOL_HIST_ERRNO,
7776 error);
7778 fnvlist_add_int64(lognv, ZPOOL_HIST_ELAPSED_NS,
7779 gethrtime() - start_time);
7780 (void) spa_history_log_nvl(spa, lognv);
7781 spa_close(spa, FTAG);
7783 fnvlist_free(lognv);
7785 if (!nvlist_empty(outnvl) || zc->zc_nvlist_dst_size != 0) {
7786 int smusherror = 0;
7787 if (vec->zvec_smush_outnvlist) {
7788 smusherror = nvlist_smush(outnvl,
7789 zc->zc_nvlist_dst_size);
7791 if (smusherror == 0)
7792 puterror = put_nvlist(zc, outnvl);
7795 if (puterror != 0)
7796 error = puterror;
7798 nvlist_free(outnvl);
7799 } else {
7800 cookie = spl_fstrans_mark();
7801 error = vec->zvec_legacy_func(zc);
7802 spl_fstrans_unmark(cookie);
7805 out:
7806 nvlist_free(innvl);
7807 if (error == 0 && vec->zvec_allow_log) {
7808 char *s = tsd_get(zfs_allow_log_key);
7809 if (s != NULL)
7810 kmem_strfree(s);
7811 (void) tsd_set(zfs_allow_log_key, kmem_strdup(saved_poolname));
7813 if (saved_poolname != NULL)
7814 kmem_free(saved_poolname, saved_poolname_len);
7816 return (error);
7820 zfs_kmod_init(void)
7822 int error;
7824 if ((error = zvol_init()) != 0)
7825 return (error);
7827 spa_init(SPA_MODE_READ | SPA_MODE_WRITE);
7828 zfs_init();
7830 zfs_ioctl_init();
7832 mutex_init(&zfsdev_state_lock, NULL, MUTEX_DEFAULT, NULL);
7833 zfsdev_state_listhead.zs_minor = -1;
7835 if ((error = zfsdev_attach()) != 0)
7836 goto out;
7838 tsd_create(&zfs_fsyncer_key, NULL);
7839 tsd_create(&rrw_tsd_key, rrw_tsd_destroy);
7840 tsd_create(&zfs_allow_log_key, zfs_allow_log_destroy);
7842 return (0);
7843 out:
7844 zfs_fini();
7845 spa_fini();
7846 zvol_fini();
7848 return (error);
7851 void
7852 zfs_kmod_fini(void)
7854 zfsdev_state_t *zs, *zsnext = NULL;
7856 zfsdev_detach();
7858 mutex_destroy(&zfsdev_state_lock);
7860 for (zs = &zfsdev_state_listhead; zs != NULL; zs = zsnext) {
7861 zsnext = zs->zs_next;
7862 if (zs->zs_onexit)
7863 zfs_onexit_destroy(zs->zs_onexit);
7864 if (zs->zs_zevent)
7865 zfs_zevent_destroy(zs->zs_zevent);
7866 if (zs != &zfsdev_state_listhead)
7867 kmem_free(zs, sizeof (zfsdev_state_t));
7870 zfs_ereport_taskq_fini(); /* run before zfs_fini() on Linux */
7871 zfs_fini();
7872 spa_fini();
7873 zvol_fini();
7875 tsd_destroy(&zfs_fsyncer_key);
7876 tsd_destroy(&rrw_tsd_key);
7877 tsd_destroy(&zfs_allow_log_key);
7880 ZFS_MODULE_PARAM(zfs, zfs_, max_nvlist_src_size, U64, ZMOD_RW,
7881 "Maximum size in bytes allowed for src nvlist passed with ZFS ioctls");
7883 ZFS_MODULE_PARAM(zfs, zfs_, history_output_max, U64, ZMOD_RW,
7884 "Maximum size in bytes of ZFS ioctl output that will be logged");