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]
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
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:
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".
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:
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).
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.
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
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>
173 #include <sys/spa_impl.h>
174 #include <sys/vdev.h>
175 #include <sys/vdev_impl.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>
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
;
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
,
280 static int zfs_check_clearable(const char *dataset
, nvlist_t
*props
,
282 static int zfs_fill_zplprops_root(uint64_t, nvlist_t
*, nvlist_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
);
288 history_str_free(char *buf
)
290 kmem_free(buf
, HIS_MAX_RECORD_LEN
);
294 history_str_get(zfs_cmd_t
*zc
)
298 if (zc
->zc_history
== 0)
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
);
308 buf
[HIS_MAX_RECORD_LEN
-1] = '\0';
314 * Return non-zero if the spa version is less than requested version.
317 zfs_earlier_version(const char *name
, int version
)
321 if (spa_open(name
, &spa
, FTAG
) == 0) {
322 if (spa_version(spa
) < version
) {
323 spa_close(spa
, FTAG
);
326 spa_close(spa
, FTAG
);
332 * Return TRUE if the ZPL version is less than requested version.
335 zpl_earlier_version(const char *name
, int version
)
338 boolean_t rc
= B_TRUE
;
340 if (dmu_objset_hold(name
, FTAG
, &os
) == 0) {
343 if (dmu_objset_type(os
) != DMU_OST_ZFS
) {
344 dmu_objset_rele(os
, FTAG
);
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
);
356 zfs_log_history(zfs_cmd_t
*zc
)
361 if ((buf
= history_str_get(zc
)) == NULL
)
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.
377 zfs_secpolicy_none(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
379 (void) zc
, (void) innvl
, (void) cr
;
384 * Policy for dataset read operations (list children, get statistics). Requires
385 * no privileges, but must be visible in the local zone.
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
))
395 return (SET_ERROR(ENOENT
));
399 zfs_dozonecheck_impl(const char *dataset
, uint64_t zoned
, cred_t
*cr
)
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
416 if (secpolicy_zfs(cr
) && zoned
)
417 return (SET_ERROR(EPERM
));
420 * If we are in a local zone, the 'zoned' property must be set.
423 return (SET_ERROR(EPERM
));
425 /* must be writable by this zone */
427 return (SET_ERROR(EPERM
));
433 zfs_dozonecheck(const char *dataset
, cred_t
*cr
)
437 if (dsl_prop_get_integer(dataset
, zfs_prop_to_name(ZFS_PROP_ZONED
),
439 return (SET_ERROR(ENOENT
));
441 return (zfs_dozonecheck_impl(dataset
, zoned
, cr
));
445 zfs_dozonecheck_ds(const char *dataset
, dsl_dataset_t
*ds
, cred_t
*cr
)
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
));
456 zfs_secpolicy_write_perms_ds(const char *name
, dsl_dataset_t
*ds
,
457 const char *perm
, cred_t
*cr
)
461 error
= zfs_dozonecheck_ds(name
, ds
, cr
);
463 error
= secpolicy_zfs(cr
);
465 error
= dsl_deleg_access_impl(ds
, perm
, cr
);
471 zfs_secpolicy_write_perms(const char *name
, const char *perm
, cred_t
*cr
)
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)
485 error
= dsl_pool_hold(name
, FTAG
, &dp
);
489 error
= dsl_dataset_hold(dp
, name
, FTAG
, &ds
);
491 dsl_pool_rele(dp
, FTAG
);
495 error
= zfs_secpolicy_write_perms_ds(name
, ds
, perm
, cr
);
497 dsl_dataset_rele(ds
, FTAG
);
498 dsl_pool_rele(dp
, FTAG
);
503 * Policy for setting the security label property.
505 * Returns 0 for success, non-zero for access and other errors.
508 zfs_set_slabel_policy(const char *name
, const char *strval
, cred_t
*cr
)
511 char ds_hexsl
[MAXNAMELEN
];
512 bslabel_t ds_sl
, new_sl
;
513 boolean_t new_default
= FALSE
;
515 int needed_priv
= -1;
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
);
522 return (SET_ERROR(EPERM
));
524 if (strcasecmp(strval
, ZFS_MLSLABEL_DEFAULT
) == 0)
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
536 if (!INGLOBALZONE(curproc
)) {
537 if (new_default
|| !blequal(&new_sl
, CR_SL(CRED())))
538 return (SET_ERROR(EPERM
));
543 * For global-zone datasets (i.e., those whose zoned property is
544 * "off", verify that the specified new label is valid for the
547 if (dsl_prop_get_integer(name
,
548 zfs_prop_to_name(ZFS_PROP_ZONED
), &zoned
, NULL
))
549 return (SET_ERROR(EPERM
));
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) {
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
,
572 return (SET_ERROR(EPERM
));
574 dmu_objset_disown(os
, B_TRUE
, setsl_tag
);
577 needed_priv
= PRIV_FILE_DOWNGRADE_SL
;
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
;
589 /* dataset currently has a default label */
591 needed_priv
= PRIV_FILE_UPGRADE_SL
;
595 if (needed_priv
!= -1)
596 return (PRIV_POLICY(cr
, needed_priv
, B_FALSE
, EPERM
, NULL
));
599 return (SET_ERROR(ENOTSUP
));
600 #endif /* HAVE_MLSLABEL */
604 zfs_secpolicy_setprop(const char *dsname
, zfs_prop_t prop
, nvpair_t
*propval
,
610 * Check permissions for special properties.
617 * Disallow setting of 'zoned' from within a local zone.
619 if (!INGLOBALZONE(curproc
))
620 return (SET_ERROR(EPERM
));
624 case ZFS_PROP_FILESYSTEM_LIMIT
:
625 case ZFS_PROP_SNAPSHOT_LIMIT
:
626 if (!INGLOBALZONE(curproc
)) {
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
));
642 case ZFS_PROP_MLSLABEL
:
643 if (!is_system_labeled())
644 return (SET_ERROR(EPERM
));
646 if (nvpair_value_string(propval
, &strval
) == 0) {
649 err
= zfs_set_slabel_policy(dsname
, strval
, CRED());
656 return (zfs_secpolicy_write_perms(dsname
, zfs_prop_to_name(prop
), cr
));
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()
667 return (zfs_dozonecheck(zc
->zc_name
, cr
));
671 zfs_secpolicy_rollback(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
674 return (zfs_secpolicy_write_perms(zc
->zc_name
,
675 ZFS_DELEG_PERM_ROLLBACK
, cr
));
679 zfs_secpolicy_send(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
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
, '@');
693 return (SET_ERROR(EINVAL
));
694 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
698 error
= dsl_dataset_hold_obj(dp
, zc
->zc_sendobj
, FTAG
, &ds
);
700 dsl_pool_rele(dp
, FTAG
);
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
);
715 zfs_secpolicy_send_new(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
718 return (zfs_secpolicy_write_perms(zc
->zc_name
,
719 ZFS_DELEG_PERM_SEND
, cr
));
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
));
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
));
737 zfs_get_parent(const char *datasetname
, char *parent
, int parentsize
)
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
, '@');
749 cp
= strrchr(parent
, '/');
751 return (SET_ERROR(ENOENT
));
759 zfs_secpolicy_destroy_perms(const char *name
, cred_t
*cr
)
763 if ((error
= zfs_secpolicy_write_perms(name
,
764 ZFS_DELEG_PERM_MOUNT
, cr
)) != 0)
767 return (zfs_secpolicy_write_perms(name
, ZFS_DELEG_PERM_DESTROY
, cr
));
771 zfs_secpolicy_destroy(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
774 return (zfs_secpolicy_destroy_perms(zc
->zc_name
, cr
));
778 * Destroying snapshots with delegated permissions requires
779 * descendant mount and destroy permissions.
782 zfs_secpolicy_destroy_snaps(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
786 nvpair_t
*pair
, *nextpair
;
789 snaps
= fnvlist_lookup_nvlist(innvl
, "snaps");
791 for (pair
= nvlist_next_nvpair(snaps
, NULL
); pair
!= NULL
;
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
);
815 zfs_secpolicy_rename_perms(const char *from
, const char *to
, cred_t
*cr
)
817 char parentname
[ZFS_MAX_DATASET_NAME_LEN
];
820 if ((error
= zfs_secpolicy_write_perms(from
,
821 ZFS_DELEG_PERM_RENAME
, cr
)) != 0)
824 if ((error
= zfs_secpolicy_write_perms(from
,
825 ZFS_DELEG_PERM_MOUNT
, cr
)) != 0)
828 if ((error
= zfs_get_parent(to
, parentname
,
829 sizeof (parentname
))) != 0)
832 if ((error
= zfs_secpolicy_write_perms(parentname
,
833 ZFS_DELEG_PERM_CREATE
, cr
)) != 0)
836 if ((error
= zfs_secpolicy_write_perms(parentname
,
837 ZFS_DELEG_PERM_MOUNT
, cr
)) != 0)
844 zfs_secpolicy_rename(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
847 return (zfs_secpolicy_rename_perms(zc
->zc_name
, zc
->zc_value
, cr
));
851 zfs_secpolicy_promote(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
855 dsl_dataset_t
*clone
;
858 error
= zfs_secpolicy_write_perms(zc
->zc_name
,
859 ZFS_DELEG_PERM_PROMOTE
, cr
);
863 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
867 error
= dsl_dataset_hold(dp
, zc
->zc_name
, FTAG
, &clone
);
870 char parentname
[ZFS_MAX_DATASET_NAME_LEN
];
871 dsl_dataset_t
*origin
= NULL
;
875 error
= dsl_dataset_hold_obj(dd
->dd_pool
,
876 dsl_dir_phys(dd
)->dd_origin_obj
, FTAG
, &origin
);
878 dsl_dataset_rele(clone
, FTAG
);
879 dsl_pool_rele(dp
, FTAG
);
883 error
= zfs_secpolicy_write_perms_ds(zc
->zc_name
, clone
,
884 ZFS_DELEG_PERM_MOUNT
, cr
);
886 dsl_dataset_name(origin
, parentname
);
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
);
899 zfs_secpolicy_recv(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
904 if ((error
= zfs_secpolicy_write_perms(zc
->zc_name
,
905 ZFS_DELEG_PERM_RECEIVE
, cr
)) != 0)
908 if ((error
= zfs_secpolicy_write_perms(zc
->zc_name
,
909 ZFS_DELEG_PERM_MOUNT
, cr
)) != 0)
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.
927 zfs_secpolicy_snapshot(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
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
, '@');
942 error
= SET_ERROR(EINVAL
);
946 error
= zfs_secpolicy_snapshot_perms(name
, cr
);
955 * Check for permission to create each bookmark in the nvlist.
958 zfs_secpolicy_bookmark(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
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
, '#');
969 error
= SET_ERROR(EINVAL
);
973 error
= zfs_secpolicy_write_perms(name
,
974 ZFS_DELEG_PERM_BOOKMARK
, cr
);
983 zfs_secpolicy_destroy_bookmarks(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
986 nvpair_t
*pair
, *nextpair
;
989 for (pair
= nvlist_next_nvpair(innvl
, NULL
); pair
!= NULL
;
991 char *name
= (char *)nvpair_name(pair
);
992 char *hashp
= strchr(name
, '#');
993 nextpair
= nvlist_next_nvpair(innvl
, pair
);
996 error
= SET_ERROR(EINVAL
);
1001 error
= zfs_secpolicy_write_perms(name
,
1002 ZFS_DELEG_PERM_DESTROY
, cr
);
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
);
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
1031 if (tsd_get(zfs_allow_log_key
) == NULL
)
1032 return (SET_ERROR(EPERM
));
1037 zfs_secpolicy_create_clone(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1039 char parentname
[ZFS_MAX_DATASET_NAME_LEN
];
1043 if ((error
= zfs_get_parent(zc
->zc_name
, parentname
,
1044 sizeof (parentname
))) != 0)
1047 if (nvlist_lookup_string(innvl
, "origin", &origin
) == 0 &&
1048 (error
= zfs_secpolicy_write_perms(origin
,
1049 ZFS_DELEG_PERM_CLONE
, cr
)) != 0)
1052 if ((error
= zfs_secpolicy_write_perms(parentname
,
1053 ZFS_DELEG_PERM_CREATE
, cr
)) != 0)
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
));
1076 * Policy for object to name lookups.
1079 zfs_secpolicy_diff(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1084 if (secpolicy_sys_config(cr
, B_FALSE
) == 0)
1087 error
= zfs_secpolicy_write_perms(zc
->zc_name
, ZFS_DELEG_PERM_DIFF
, cr
);
1092 * Policy for fault injection. Requires all privileges.
1095 zfs_secpolicy_inject(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1097 (void) zc
, (void) innvl
;
1098 return (secpolicy_zinject(cr
));
1102 zfs_secpolicy_inherit_prop(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
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
));
1113 return (zfs_secpolicy_setprop(zc
->zc_name
, prop
,
1119 zfs_secpolicy_userspace_one(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1121 int err
= zfs_secpolicy_read(zc
, innvl
, cr
);
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
))
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
))
1146 /* else is for project quota/used */
1149 return (zfs_secpolicy_write_perms(zc
->zc_name
,
1150 userquota_perms
[zc
->zc_objset_type
], cr
));
1154 zfs_secpolicy_userspace_many(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1156 int err
= zfs_secpolicy_read(zc
, innvl
, cr
);
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
));
1168 zfs_secpolicy_userspace_upgrade(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1171 return (zfs_secpolicy_setprop(zc
->zc_name
, ZFS_PROP_VERSION
,
1176 zfs_secpolicy_hold(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
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
);
1191 error
= zfs_secpolicy_write_perms(fsname
,
1192 ZFS_DELEG_PERM_HOLD
, cr
);
1200 zfs_secpolicy_release(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
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
);
1212 error
= zfs_secpolicy_write_perms(fsname
,
1213 ZFS_DELEG_PERM_RELEASE
, cr
);
1221 * Policy for allowing temporary snapshots to be taken or released
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.
1233 if (zfs_secpolicy_write_perms(zc
->zc_name
,
1234 ZFS_DELEG_PERM_DIFF
, cr
) == 0)
1237 error
= zfs_secpolicy_snapshot_perms(zc
->zc_name
, cr
);
1239 if (innvl
!= NULL
) {
1241 error
= zfs_secpolicy_hold(zc
, innvl
, cr
);
1243 error
= zfs_secpolicy_release(zc
, innvl
, cr
);
1245 error
= zfs_secpolicy_destroy(zc
, innvl
, cr
);
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
));
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.
1268 get_nvlist(uint64_t nvl
, uint64_t size
, int iflag
, nvlist_t
**nvp
)
1272 nvlist_t
*list
= NULL
;
1275 * Read in and unpack the user-supplied nvlist.
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
);
1292 vmem_free(packed
, size
);
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
1305 nvlist_smush(nvlist_t
*errors
, size_t max
)
1309 size
= fnvlist_size(errors
);
1312 nvpair_t
*more_errors
;
1316 return (SET_ERROR(ENOMEM
));
1318 fnvlist_add_int32(errors
, ZPROP_N_MORE_ERRORS
, 0);
1319 more_errors
= nvlist_prev_nvpair(errors
, NULL
);
1322 nvpair_t
*pair
= nvlist_prev_nvpair(errors
,
1324 fnvlist_remove_nvpair(errors
, pair
);
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
);
1338 put_nvlist(zfs_cmd_t
*zc
, nvlist_t
*nvl
)
1340 char *packed
= NULL
;
1344 size
= fnvlist_size(nvl
);
1346 if (size
> zc
->zc_nvlist_dst_size
) {
1347 error
= SET_ERROR(ENOMEM
);
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
;
1362 getzfsvfs_impl(objset_t
*os
, zfsvfs_t
**zfvp
)
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
);
1378 getzfsvfs(const char *dsname
, zfsvfs_t
**zfvp
)
1383 error
= dmu_objset_hold(dsname
, FTAG
, &os
);
1387 error
= getzfsvfs_impl(os
, zfvp
);
1388 dmu_objset_rele(os
, FTAG
);
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.
1399 zfsvfs_hold(const char *name
, const void *tag
, zfsvfs_t
**zfvp
,
1404 if (getzfsvfs(name
, zfvp
) != 0)
1405 error
= zfsvfs_create(name
, B_FALSE
, zfvp
);
1408 ZFS_TEARDOWN_ENTER_WRITE(*zfvp
, tag
);
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
));
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
);
1432 dmu_objset_disown(zfsvfs
->z_os
, B_TRUE
, zfsvfs
);
1433 zfsvfs_free(zfsvfs
);
1438 zfs_ioc_pool_create(zfs_cmd_t
*zc
)
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
)))
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
);
1460 nvlist_t
*nvl
= NULL
;
1461 nvlist_t
*hidden_args
= NULL
;
1462 uint64_t version
= SPA_VERSION
;
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
);
1473 error
= nvlist_dup(nvl
, &rootprops
, KM_SLEEP
);
1475 goto pool_props_bad
;
1476 (void) nvlist_remove_all(props
, ZPOOL_ROOTFS_PROPS
);
1479 (void) nvlist_lookup_nvlist(props
, ZPOOL_HIDDEN_ARGS
,
1481 error
= dsl_crypto_params_create_nvlist(DCP_CMD_NONE
,
1482 rootprops
, hidden_args
, &dcp
);
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
,
1491 goto pool_props_bad
;
1493 if (nvlist_lookup_string(props
,
1494 zpool_prop_to_name(ZPOOL_PROP_TNAME
), &tname
) == 0)
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 */
1510 nvlist_free(rootprops
);
1511 nvlist_free(zplprops
);
1512 nvlist_free(config
);
1514 dsl_crypto_params_free(dcp
, unload_wkey
&& !!error
);
1520 zfs_ioc_pool_destroy(zfs_cmd_t
*zc
)
1523 zfs_log_history(zc
);
1524 error
= spa_destroy(zc
->zc_name
);
1530 zfs_ioc_pool_import(zfs_cmd_t
*zc
)
1532 nvlist_t
*config
, *props
= NULL
;
1536 if ((error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
1537 zc
->zc_iflags
, &config
)) != 0)
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
);
1547 if (nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
, &guid
) != 0 ||
1548 guid
!= zc
->zc_guid
)
1549 error
= SET_ERROR(EINVAL
);
1551 error
= spa_import(zc
->zc_name
, config
, props
, zc
->zc_cookie
);
1553 if (zc
->zc_nvlist_dst
!= 0) {
1556 if ((err
= put_nvlist(zc
, config
)) != 0)
1560 nvlist_free(config
);
1567 zfs_ioc_pool_export(zfs_cmd_t
*zc
)
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
);
1580 zfs_ioc_pool_configs(zfs_cmd_t
*zc
)
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
);
1597 * zc_name name of the pool
1600 * zc_cookie real errno
1601 * zc_nvlist_dst config nvlist
1602 * zc_nvlist_dst_size size of config nvlist
1605 zfs_ioc_pool_stats(zfs_cmd_t
*zc
)
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
1623 zc
->zc_cookie
= error
;
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.
1636 zfs_ioc_pool_tryimport(zfs_cmd_t
*zc
)
1638 nvlist_t
*tryconfig
, *config
= NULL
;
1641 if ((error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
1642 zc
->zc_iflags
, &tryconfig
)) != 0)
1645 config
= spa_tryimport(tryconfig
);
1647 nvlist_free(tryconfig
);
1650 return (SET_ERROR(EINVAL
));
1652 error
= put_nvlist(zc
, config
);
1653 nvlist_free(config
);
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)
1665 zfs_ioc_pool_scan(zfs_cmd_t
*zc
)
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)
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
);
1681 error
= spa_scan(spa
, zc
->zc_cookie
);
1683 spa_close(spa
, FTAG
);
1689 zfs_ioc_pool_freeze(zfs_cmd_t
*zc
)
1694 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
1697 spa_close(spa
, FTAG
);
1703 zfs_ioc_pool_upgrade(zfs_cmd_t
*zc
)
1708 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
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
);
1724 zfs_ioc_pool_get_history(zfs_cmd_t
*zc
)
1731 if ((size
= zc
->zc_history_len
) == 0)
1732 return (SET_ERROR(EINVAL
));
1734 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
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
);
1756 zfs_ioc_pool_reguid(zfs_cmd_t
*zc
)
1761 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
1763 error
= spa_change_guid(spa
);
1764 spa_close(spa
, FTAG
);
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
));
1777 * zc_name name of filesystem
1778 * zc_obj object to find
1781 * zc_value name of object
1784 zfs_ioc_obj_to_path(zfs_cmd_t
*zc
)
1789 /* XXX reading from objset not owned */
1790 if ((error
= dmu_objset_hold_flags(zc
->zc_name
, B_TRUE
,
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
);
1806 * zc_name name of filesystem
1807 * zc_obj object to find
1810 * zc_stat stats on object
1811 * zc_value path to object
1814 zfs_ioc_obj_to_stats(zfs_cmd_t
*zc
)
1819 /* XXX reading from objset not owned */
1820 if ((error
= dmu_objset_hold_flags(zc
->zc_name
, B_TRUE
,
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
);
1835 zfs_ioc_vdev_add(zfs_cmd_t
*zc
)
1841 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
1845 error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
1846 zc
->zc_iflags
, &config
);
1848 error
= spa_vdev_add(spa
, config
);
1849 nvlist_free(config
);
1851 spa_close(spa
, FTAG
);
1857 * zc_name name of the pool
1858 * zc_guid guid of vdev to remove
1859 * zc_cookie cancel removal
1862 zfs_ioc_vdev_remove(zfs_cmd_t
*zc
)
1867 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
1870 if (zc
->zc_cookie
!= 0) {
1871 error
= spa_vdev_remove_cancel(spa
);
1873 error
= spa_vdev_remove(spa
, zc
->zc_guid
, B_FALSE
);
1875 spa_close(spa
, FTAG
);
1880 zfs_ioc_vdev_set_state(zfs_cmd_t
*zc
)
1884 vdev_state_t newstate
= VDEV_STATE_UNKNOWN
;
1886 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
1888 switch (zc
->zc_cookie
) {
1889 case VDEV_STATE_ONLINE
:
1890 error
= vdev_online(spa
, zc
->zc_guid
, zc
->zc_obj
, &newstate
);
1893 case VDEV_STATE_OFFLINE
:
1894 error
= vdev_offline(spa
, zc
->zc_guid
, zc
->zc_obj
);
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
);
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
);
1914 case VDEV_STATE_REMOVED
:
1915 error
= vdev_remove_wanted(spa
, zc
->zc_guid
);
1919 error
= SET_ERROR(EINVAL
);
1921 zc
->zc_cookie
= newstate
;
1922 spa_close(spa
, FTAG
);
1927 zfs_ioc_vdev_attach(zfs_cmd_t
*zc
)
1931 int replacing
= zc
->zc_cookie
;
1932 int rebuild
= zc
->zc_simple
;
1935 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
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
,
1942 nvlist_free(config
);
1945 spa_close(spa
, FTAG
);
1950 zfs_ioc_vdev_detach(zfs_cmd_t
*zc
)
1955 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
1958 error
= spa_vdev_detach(spa
, zc
->zc_guid
, 0, B_FALSE
);
1960 spa_close(spa
, FTAG
);
1965 zfs_ioc_vdev_split(zfs_cmd_t
*zc
)
1968 nvlist_t
*config
, *props
= NULL
;
1970 boolean_t exp
= !!(zc
->zc_cookie
& ZPOOL_EXPORT_AFTER_SPLIT
);
1972 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
1975 if ((error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
1976 zc
->zc_iflags
, &config
))) {
1977 spa_close(spa
, FTAG
);
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
);
1989 error
= spa_vdev_split_mirror(spa
, zc
->zc_string
, config
, props
, exp
);
1991 spa_close(spa
, FTAG
);
1993 nvlist_free(config
);
2000 zfs_ioc_vdev_setpath(zfs_cmd_t
*zc
)
2003 const char *path
= zc
->zc_value
;
2004 uint64_t guid
= zc
->zc_guid
;
2007 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
2011 error
= spa_vdev_setpath(spa
, guid
, path
);
2012 spa_close(spa
, FTAG
);
2017 zfs_ioc_vdev_setfru(zfs_cmd_t
*zc
)
2020 const char *fru
= zc
->zc_value
;
2021 uint64_t guid
= zc
->zc_guid
;
2024 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
2028 error
= spa_vdev_setfru(spa
, guid
, fru
);
2029 spa_close(spa
, FTAG
);
2034 zfs_ioc_objset_stats_impl(zfs_cmd_t
*zc
, objset_t
*os
)
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
);
2061 error
= put_nvlist(zc
, nv
);
2070 * zc_name name of filesystem
2071 * zc_nvlist_dst_size size of buffer for property nvlist
2074 * zc_objset_stats stats
2075 * zc_nvlist_dst property nvlist
2076 * zc_nvlist_dst_size size of property nvlist
2079 zfs_ioc_objset_stats(zfs_cmd_t
*zc
)
2084 error
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
);
2086 error
= zfs_ioc_objset_stats_impl(zc
, os
);
2087 dmu_objset_rele(os
, FTAG
);
2095 * zc_name name of filesystem
2096 * zc_nvlist_dst_size size of buffer for property nvlist
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.
2107 zfs_ioc_objset_recvd_props(zfs_cmd_t
*zc
)
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
);
2130 nvl_add_zplprop(objset_t
*os
, nvlist_t
*props
, zfs_prop_t prop
)
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)
2141 VERIFY(nvlist_add_uint64(props
, zfs_prop_to_name(prop
), value
) == 0);
2147 * zc_name name of filesystem
2148 * zc_nvlist_dst_size size of buffer for zpl property nvlist
2151 * zc_nvlist_dst zpl property nvlist
2152 * zc_nvlist_dst_size size of zpl property nvlist
2155 zfs_ioc_objset_zplprops(zfs_cmd_t
*zc
)
2160 /* XXX reading without owning */
2161 if ((err
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
)))
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
) {
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
);
2184 err
= SET_ERROR(ENOENT
);
2186 dmu_objset_rele(os
, FTAG
);
2192 * zc_name name of filesystem
2193 * zc_cookie zap cursor
2194 * zc_nvlist_dst_size size of buffer for property nvlist
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
2204 zfs_ioc_dataset_list_next(zfs_cmd_t
*zc
)
2209 size_t orig_len
= strlen(zc
->zc_name
);
2212 if ((error
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
))) {
2213 if (error
== ENOENT
)
2214 error
= SET_ERROR(ESRCH
);
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
);
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';
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
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
2261 zfs_ioc_snapshot_list_next(zfs_cmd_t
*zc
)
2264 objset_t
*os
, *ossnap
;
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
);
2274 (void) nvlist_lookup_uint64(props
, SNAP_ITER_MIN_TXG
,
2276 (void) nvlist_lookup_uint64(props
, SNAP_ITER_MAX_TXG
,
2281 error
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
);
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
);
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
);
2309 } else if (error
!= 0) {
2313 error
= dsl_dataset_hold_obj(dmu_objset_pool(os
), zc
->zc_obj
,
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';
2327 if (zc
->zc_simple
) {
2328 dsl_dataset_fast_stat(ds
, &zc
->zc_objset_stats
);
2329 dsl_dataset_rele(ds
, FTAG
);
2333 if ((error
= dmu_objset_from_ds(ds
, &ossnap
)) != 0) {
2334 dsl_dataset_rele(ds
, FTAG
);
2337 if ((error
= zfs_ioc_objset_stats_impl(zc
, ossnap
)) != 0) {
2338 dsl_dataset_rele(ds
, FTAG
);
2341 dsl_dataset_rele(ds
, FTAG
);
2345 dmu_objset_rele(os
, FTAG
);
2346 /* if we failed, undo the @ that we tacked on to zc_name */
2348 *strchr(zc
->zc_name
, '@') = '\0';
2353 zfs_prop_set_userquota(const char *dsname
, nvpair_t
*pair
)
2355 const char *propname
= nvpair_name(pair
);
2357 unsigned int vallen
;
2358 const char *dash
, *domain
;
2359 zfs_userquota_prop_t type
;
2365 if (nvpair_type(pair
) == DATA_TYPE_NVLIST
) {
2367 VERIFY(nvpair_value_nvlist(pair
, &attrs
) == 0);
2368 if (nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
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 ||
2380 return (SET_ERROR(EINVAL
));
2387 err
= zfsvfs_hold(dsname
, FTAG
, &zfsvfs
, B_FALSE
);
2389 err
= zfs_set_userquota(zfsvfs
, type
, domain
, rid
, quota
);
2390 zfsvfs_rele(zfsvfs
, FTAG
);
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).
2405 zfs_prop_set_special(const char *dsname
, zprop_source_t source
,
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
;
2414 if (prop
== ZPROP_USERPROP
) {
2415 if (zfs_prop_userquota(propname
))
2416 return (zfs_prop_set_userquota(dsname
, pair
));
2420 if (nvpair_type(pair
) == DATA_TYPE_NVLIST
) {
2422 VERIFY(nvpair_value_nvlist(pair
, &attrs
) == 0);
2423 VERIFY(nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
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
);
2431 intval
= fnvpair_value_uint64(pair
);
2435 case ZFS_PROP_QUOTA
:
2436 err
= dsl_dir_set_quota(dsname
, source
, intval
);
2438 case ZFS_PROP_REFQUOTA
:
2439 err
= dsl_dataset_set_refquota(dsname
, source
, intval
);
2441 case ZFS_PROP_FILESYSTEM_LIMIT
:
2442 case ZFS_PROP_SNAPSHOT_LIMIT
:
2443 if (intval
== UINT64_MAX
) {
2444 /* clearing the limit, just do it */
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.
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.
2466 case ZFS_PROP_RESERVATION
:
2467 err
= dsl_dir_set_reservation(dsname
, source
, intval
);
2469 case ZFS_PROP_REFRESERVATION
:
2470 err
= dsl_dataset_set_refreservation(dsname
, source
, intval
);
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.
2481 case ZFS_PROP_VOLSIZE
:
2482 err
= zvol_set_volsize(dsname
, intval
);
2484 case ZFS_PROP_SNAPDEV
:
2485 err
= zvol_set_snapdev(dsname
, source
, intval
);
2487 case ZFS_PROP_VOLMODE
:
2488 err
= zvol_set_volmode(dsname
, source
, intval
);
2490 case ZFS_PROP_VERSION
:
2494 if ((err
= zfsvfs_hold(dsname
, FTAG
, &zfsvfs
, B_TRUE
)) != 0)
2497 err
= zfs_set_version(zfsvfs
, intval
);
2498 zfsvfs_rele(zfsvfs
, FTAG
);
2500 if (err
== 0 && intval
>= ZPL_VERSION_USERSPACE
) {
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
));
2520 zfs_is_namespace_prop(zfs_prop_t prop
)
2524 case ZFS_PROP_ATIME
:
2525 case ZFS_PROP_RELATIME
:
2526 case ZFS_PROP_DEVICES
:
2528 case ZFS_PROP_SETUID
:
2529 case ZFS_PROP_READONLY
:
2530 case ZFS_PROP_XATTR
:
2531 case ZFS_PROP_NBMAND
:
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
2550 zfs_set_prop_nvlist(const char *dsname
, zprop_source_t source
, nvlist_t
*nvl
,
2559 boolean_t should_update_mount_cache
= B_FALSE
;
2561 nvlist_t
*genericnvl
= fnvlist_alloc();
2562 nvlist_t
*retrynvl
= fnvlist_alloc();
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
);
2570 /* decode the property value */
2572 if (nvpair_type(pair
) == DATA_TYPE_NVLIST
) {
2574 attrs
= fnvpair_value_nvlist(pair
);
2575 if (nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
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
);
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
) {
2603 intval
= fnvpair_value_uint64(propval
);
2605 switch (zfs_prop_get_type(prop
)) {
2606 case PROP_TYPE_NUMBER
:
2608 case PROP_TYPE_STRING
:
2609 err
= SET_ERROR(EINVAL
);
2611 case PROP_TYPE_INDEX
:
2612 if (zfs_prop_index_to_string(prop
,
2613 intval
, &unused
) != 0)
2615 SET_ERROR(ZFS_ERR_BADPROP
);
2619 "unknown property type");
2622 err
= SET_ERROR(EINVAL
);
2626 /* Validate permissions */
2628 err
= zfs_check_settable(dsname
, pair
, CRED());
2631 if (source
== ZPROP_SRC_INHERITED
)
2632 err
= -1; /* does not need special handling */
2634 err
= zfs_prop_set_special(dsname
, source
,
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
);
2653 if (errlist
!= NULL
)
2654 fnvlist_add_int32(errlist
, propname
, err
);
2658 if (zfs_is_namespace_prop(prop
))
2659 should_update_mount_cache
= B_TRUE
;
2662 if (nvl
!= retrynvl
&& !nvlist_empty(retrynvl
)) {
2667 if (nvlist_empty(genericnvl
))
2671 * Try to set them all in one batch.
2673 err
= dsl_props_set(dsname
, source
, genericnvl
);
2678 * If batching fails, we still want to set as many properties as we
2679 * can, so try setting them individually.
2682 while ((pair
= nvlist_next_nvpair(genericnvl
, pair
)) != NULL
) {
2683 const char *propname
= nvpair_name(pair
);
2686 if (nvpair_type(pair
) == DATA_TYPE_NVLIST
) {
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
,
2696 } else if (nvpair_type(propval
) == DATA_TYPE_BOOLEAN
) {
2697 err
= dsl_prop_inherit(dsname
, propname
, source
);
2699 intval
= fnvpair_value_uint64(propval
);
2700 err
= dsl_prop_set_int(dsname
, propname
, source
,
2705 if (errlist
!= NULL
) {
2706 fnvlist_add_int32(errlist
, propname
, err
);
2713 if (should_update_mount_cache
)
2714 zfs_ioctl_update_mount_cache(dsname
);
2716 nvlist_free(genericnvl
);
2717 nvlist_free(retrynvl
);
2723 * Check that all the properties are valid user properties.
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
));
2747 props_skip(nvlist_t
*props
, nvlist_t
*skipped
, nvlist_t
**newprops
)
2751 VERIFY(nvlist_alloc(newprops
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
2754 while ((pair
= nvlist_next_nvpair(props
, pair
)) != NULL
) {
2755 if (nvlist_exists(skipped
, nvpair_name(pair
)))
2758 VERIFY(nvlist_add_nvpair(*newprops
, pair
) == 0);
2763 clear_received_props(const char *dsname
, nvlist_t
*props
,
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
);
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
2790 * zc_nvlist_dst{_size} error for each unapplied received property
2793 zfs_ioc_set_prop(zfs_cmd_t
*zc
)
2796 boolean_t received
= zc
->zc_cookie
;
2797 zprop_source_t source
= (received
? ZPROP_SRC_RECEIVED
:
2802 if ((error
= get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
2803 zc
->zc_iflags
, &nvl
)) != 0)
2807 nvlist_t
*origprops
;
2809 if (dsl_prop_get_received(zc
->zc_name
, &origprops
) == 0) {
2810 (void) clear_received_props(zc
->zc_name
,
2812 nvlist_free(origprops
);
2815 error
= dsl_prop_set_hasrecvd(zc
->zc_name
);
2818 errors
= fnvlist_alloc();
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
);
2833 * zc_name name of filesystem
2834 * zc_value name of property to inherit
2835 * zc_cookie revert to received value if TRUE
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 */
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
));
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();
2882 case PROP_TYPE_STRING
:
2883 VERIFY(0 == nvlist_add_string(dummy
, propname
, ""));
2885 case PROP_TYPE_NUMBER
:
2886 case PROP_TYPE_INDEX
:
2887 VERIFY(0 == nvlist_add_uint64(dummy
, propname
, 0));
2890 err
= SET_ERROR(EINVAL
);
2894 pair
= nvlist_next_nvpair(dummy
, NULL
);
2896 err
= SET_ERROR(EINVAL
);
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
,
2910 zfs_ioc_pool_set_props(zfs_cmd_t
*zc
)
2917 if ((error
= get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
2918 zc
->zc_iflags
, &props
)))
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
);
2941 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0) {
2946 error
= spa_prop_set(spa
, props
);
2949 spa_close(spa
, FTAG
);
2955 zfs_ioc_pool_get_props(zfs_cmd_t
*zc
)
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
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
);
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
);
2979 error
= SET_ERROR(EFAULT
);
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}
2999 zfs_ioc_vdev_set_props(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3006 /* Early validation */
3007 if (nvlist_lookup_uint64(innvl
, ZPOOL_VDEV_PROPS_SET_VDEV
,
3009 return (SET_ERROR(EINVAL
));
3012 return (SET_ERROR(EINVAL
));
3014 if ((error
= spa_open(poolname
, &spa
, FTAG
)) != 0)
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
);
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
}
3045 zfs_ioc_vdev_get_props(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3052 /* Early validation */
3053 if (nvlist_lookup_uint64(innvl
, ZPOOL_VDEV_PROPS_GET_VDEV
,
3055 return (SET_ERROR(EINVAL
));
3058 return (SET_ERROR(EINVAL
));
3060 if ((error
= spa_open(poolname
, &spa
, FTAG
)) != 0)
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
);
3077 * zc_name name of filesystem
3078 * zc_nvlist_src{_size} nvlist of delegated permissions
3079 * zc_perm_action allow/unallow flag
3084 zfs_ioc_set_fsacl(zfs_cmd_t
*zc
)
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)
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
3107 error
= secpolicy_zfs(CRED());
3109 if (zc
->zc_perm_action
== B_FALSE
) {
3110 error
= dsl_deleg_can_allow(zc
->zc_name
,
3113 error
= dsl_deleg_can_unallow(zc
->zc_name
,
3119 error
= dsl_deleg_set(zc
->zc_name
, fsaclnv
, zc
->zc_perm_action
);
3121 nvlist_free(fsaclnv
);
3127 * zc_name name of filesystem
3130 * zc_nvlist_src{_size} nvlist of delegated permissions
3133 zfs_ioc_get_fsacl(zfs_cmd_t
*zc
)
3138 if ((error
= dsl_deleg_get(zc
->zc_name
, &nvp
)) == 0) {
3139 error
= put_nvlist(zc
, nvp
);
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)
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
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
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
;
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.
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,
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)
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.
3243 if (u8
== ZFS_PROP_UNDEFINED
&&
3244 (error
= zfs_get_zplprop(os
, ZFS_PROP_UTF8ONLY
, &u8
)) != 0)
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)
3252 VERIFY(nvlist_add_uint64(zplprops
,
3253 zfs_prop_to_name(ZFS_PROP_CASE
), sense
) == 0);
3256 *is_ci
= (sense
== ZFS_CASE_INSENSITIVE
);
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
];
3273 zfs_get_parent(dataset
, parentname
, sizeof (parentname
));
3275 if ((error
= spa_open(dataset
, &spa
, FTAG
)) != 0)
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)
3291 error
= zfs_fill_zplprops_impl(os
, zplver
, fuids_ok
, sa_ok
, createprops
,
3293 dmu_objset_rele(os
, FTAG
);
3298 zfs_fill_zplprops_root(uint64_t spa_vers
, nvlist_t
*createprops
,
3299 nvlist_t
*zplprops
, boolean_t
*is_ci
)
3303 uint64_t zplver
= ZPL_VERSION
;
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
);
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
},
3333 zfs_ioc_create(const char *fsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
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
);
3350 cbfunc
= zfs_create_cb
;
3354 cbfunc
= zvol_create_cb
;
3361 if (strchr(fsname
, '@') ||
3362 strchr(fsname
, '%'))
3363 return (SET_ERROR(EINVAL
));
3365 zct
.zct_props
= nvprops
;
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
));
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)
3393 } else if (type
== DMU_OST_ZFS
) {
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
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
);
3407 nvlist_free(zct
.zct_zplprops
);
3412 error
= dsl_crypto_params_create_nvlist(DCP_CMD_NONE
, nvprops
,
3415 nvlist_free(zct
.zct_zplprops
);
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.
3429 error
= zfs_set_prop_nvlist(fsname
, ZPROP_SRC_LOCAL
,
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
);
3445 taskq_wait(spa
->spa_zvol_taskq
);
3446 spa_close(spa
, FTAG
);
3448 error2
= dsl_destroy_head(fsname
);
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)
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
},
3473 zfs_ioc_clone(const char *fsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
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.
3495 error
= zfs_set_prop_nvlist(fsname
, ZPROP_SRC_LOCAL
,
3498 (void) dsl_destroy_head(fsname
);
3503 static const zfs_ioc_key_t zfs_keys_remap
[] = {
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
;
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
},
3529 zfs_ioc_snapshot(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3532 nvlist_t
*props
= NULL
;
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)
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.
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
)) {
3570 error
= zfs_secpolicy_write_perms(name
,
3571 ZFS_DELEG_PERM_USERPROP
, CRED());
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)
3582 return (SET_ERROR(EXDEV
));
3587 error
= dsl_dataset_snapshot(snaps
, props
, outnvl
);
3593 * innvl: "message" -> string
3595 static const zfs_ioc_key_t zfs_keys_log_history
[] = {
3596 {"message", DATA_TYPE_STRING
, 0},
3600 zfs_ioc_log_history(const char *unused
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3602 (void) unused
, (void) outnvl
;
3603 const char *message
;
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
);
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
);
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
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
},
3653 zfs_ioc_set_bootenv(const char *name
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3658 if ((error
= spa_open(name
, &spa
, FTAG
)) != 0)
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
);
3667 static const zfs_ioc_key_t zfs_keys_get_bootenv
[] = {
3672 zfs_ioc_get_bootenv(const char *name
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3677 if ((error
= spa_open(name
, &spa
, FTAG
)) != 0)
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
);
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.
3697 zfs_unmount_snap(const char *snapname
)
3699 if (strchr(snapname
, '@') == NULL
)
3702 (void) zfsctl_snapshot_unmount(snapname
, MNT_FORCE
);
3706 zfs_unmount_snap_cb(const char *snapname
, void *arg
)
3709 zfs_unmount_snap(snapname
);
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
3719 zfs_destroy_unmount_origin(const char *fsname
)
3725 error
= dmu_objset_hold(fsname
, FTAG
, &os
);
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
);
3735 dmu_objset_rele(os
, FTAG
);
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
},
3753 zfs_ioc_destroy_snaps(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
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.
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
},
3805 zfs_ioc_bookmark(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3808 return (dsl_bookmark_create(innvl
, outnvl
));
3813 * property 1, property 2, ...
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
},
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.
3836 * property 1, property 2, ...
3840 static const zfs_ioc_key_t zfs_keys_get_bookmark_props
[] = {
3845 zfs_ioc_get_bookmark_props(const char *bookmark
, nvlist_t
*innvl
,
3849 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
3852 bmname
= strchr(bookmark
, '#');
3854 return (SET_ERROR(EINVAL
));
3857 (void) strlcpy(fsname
, bookmark
, sizeof (fsname
));
3858 *(strchr(fsname
, '#')) = '\0';
3860 return (dsl_get_bookmark_props(fsname
, bmname
, outnvl
));
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
},
3876 zfs_ioc_destroy_bookmarks(const char *poolname
, nvlist_t
*innvl
,
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.
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
);
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
},
3916 zfs_ioc_channel_program(const char *poolname
, nvlist_t
*innvl
,
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
)) {
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
,
3949 static const zfs_ioc_key_t zfs_keys_pool_checkpoint
[] = {
3954 zfs_ioc_pool_checkpoint(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3956 (void) innvl
, (void) outnvl
;
3957 return (spa_checkpoint(poolname
));
3964 static const zfs_ioc_key_t zfs_keys_pool_discard_checkpoint
[] = {
3969 zfs_ioc_pool_discard_checkpoint(const char *poolname
, nvlist_t
*innvl
,
3972 (void) innvl
, (void) outnvl
;
3973 return (spa_checkpoint_discard(poolname
));
3978 * zc_name name of dataset to destroy
3979 * zc_defer_destroy mark for deferred destroy
3984 zfs_ioc_destroy(zfs_cmd_t
*zc
)
3987 dmu_objset_type_t ost
;
3990 err
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
);
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
);
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
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
) >=
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
);
4027 err
= dsl_destroy_head(zc
->zc_name
);
4028 else if (err
== ENOENT
)
4029 err
= SET_ERROR(EEXIST
);
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),
4047 * "initialize_vdevs": { -> initialization errors (nvlist)
4048 * "vdev_path_1": errno, see function body for possible errnos (uint64)
4049 * "vdev_path_2": errno, ... (uint64)
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}
4063 zfs_ioc_pool_initialize(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
4066 if (nvlist_lookup_uint64(innvl
, ZPOOL_INITIALIZE_COMMAND
,
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 return (SET_ERROR(EINVAL
));
4077 nvlist_t
*vdev_guids
;
4078 if (nvlist_lookup_nvlist(innvl
, ZPOOL_INITIALIZE_VDEVS
,
4079 &vdev_guids
) != 0) {
4080 return (SET_ERROR(EINVAL
));
4083 for (nvpair_t
*pair
= nvlist_next_nvpair(vdev_guids
, NULL
);
4084 pair
!= NULL
; pair
= nvlist_next_nvpair(vdev_guids
, pair
)) {
4086 if (nvpair_value_uint64(pair
, &vdev_guid
) != 0) {
4087 return (SET_ERROR(EINVAL
));
4092 int error
= spa_open(poolname
, &spa
, FTAG
);
4096 nvlist_t
*vdev_errlist
= fnvlist_alloc();
4097 int total_errors
= spa_vdev_initialize(spa
, vdev_guids
, cmd_type
,
4100 if (fnvlist_size(vdev_errlist
) > 0) {
4101 fnvlist_add_nvlist(outnvl
, ZPOOL_INITIALIZE_VDEVS
,
4104 fnvlist_free(vdev_errlist
);
4106 spa_close(spa
, FTAG
);
4107 return (total_errors
> 0 ? SET_ERROR(EINVAL
) : 0);
4112 * "trim_command" -> POOL_TRIM_{CANCEL|START|SUSPEND} (uint64)
4113 * "trim_vdevs": { -> guids to TRIM (nvlist)
4114 * "vdev_path_1": vdev_guid_1, (uint64),
4115 * "vdev_path_2": vdev_guid_2, (uint64),
4118 * "trim_rate" -> Target TRIM rate in bytes/sec.
4119 * "trim_secure" -> Set to request a secure TRIM.
4123 * "trim_vdevs": { -> TRIM errors (nvlist)
4124 * "vdev_path_1": errno, see function body for possible errnos (uint64)
4125 * "vdev_path_2": errno, ... (uint64)
4130 * EINVAL is returned for an unknown commands or if any of the provided vdev
4131 * guids have be specified with a type other than uint64.
4133 static const zfs_ioc_key_t zfs_keys_pool_trim
[] = {
4134 {ZPOOL_TRIM_COMMAND
, DATA_TYPE_UINT64
, 0},
4135 {ZPOOL_TRIM_VDEVS
, DATA_TYPE_NVLIST
, 0},
4136 {ZPOOL_TRIM_RATE
, DATA_TYPE_UINT64
, ZK_OPTIONAL
},
4137 {ZPOOL_TRIM_SECURE
, DATA_TYPE_BOOLEAN_VALUE
, ZK_OPTIONAL
},
4141 zfs_ioc_pool_trim(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
4144 if (nvlist_lookup_uint64(innvl
, ZPOOL_TRIM_COMMAND
, &cmd_type
) != 0)
4145 return (SET_ERROR(EINVAL
));
4147 if (!(cmd_type
== POOL_TRIM_CANCEL
||
4148 cmd_type
== POOL_TRIM_START
||
4149 cmd_type
== POOL_TRIM_SUSPEND
)) {
4150 return (SET_ERROR(EINVAL
));
4153 nvlist_t
*vdev_guids
;
4154 if (nvlist_lookup_nvlist(innvl
, ZPOOL_TRIM_VDEVS
, &vdev_guids
) != 0)
4155 return (SET_ERROR(EINVAL
));
4157 for (nvpair_t
*pair
= nvlist_next_nvpair(vdev_guids
, NULL
);
4158 pair
!= NULL
; pair
= nvlist_next_nvpair(vdev_guids
, pair
)) {
4160 if (nvpair_value_uint64(pair
, &vdev_guid
) != 0) {
4161 return (SET_ERROR(EINVAL
));
4165 /* Optional, defaults to maximum rate when not provided */
4167 if (nvlist_lookup_uint64(innvl
, ZPOOL_TRIM_RATE
, &rate
) != 0)
4170 /* Optional, defaults to standard TRIM when not provided */
4172 if (nvlist_lookup_boolean_value(innvl
, ZPOOL_TRIM_SECURE
,
4178 int error
= spa_open(poolname
, &spa
, FTAG
);
4182 nvlist_t
*vdev_errlist
= fnvlist_alloc();
4183 int total_errors
= spa_vdev_trim(spa
, vdev_guids
, cmd_type
,
4184 rate
, !!zfs_trim_metaslab_skip
, secure
, vdev_errlist
);
4186 if (fnvlist_size(vdev_errlist
) > 0)
4187 fnvlist_add_nvlist(outnvl
, ZPOOL_TRIM_VDEVS
, vdev_errlist
);
4189 fnvlist_free(vdev_errlist
);
4191 spa_close(spa
, FTAG
);
4192 return (total_errors
> 0 ? SET_ERROR(EINVAL
) : 0);
4196 * This ioctl waits for activity of a particular type to complete. If there is
4197 * no activity of that type in progress, it returns immediately, and the
4198 * returned value "waited" is false. If there is activity in progress, and no
4199 * tag is passed in, the ioctl blocks until all activity of that type is
4200 * complete, and then returns with "waited" set to true.
4202 * If a tag is provided, it identifies a particular instance of an activity to
4203 * wait for. Currently, this is only valid for use with 'initialize', because
4204 * that is the only activity for which there can be multiple instances running
4205 * concurrently. In the case of 'initialize', the tag corresponds to the guid of
4206 * the vdev on which to wait.
4208 * If a thread waiting in the ioctl receives a signal, the call will return
4209 * immediately, and the return value will be EINTR.
4212 * "wait_activity" -> int32_t
4213 * (optional) "wait_tag" -> uint64_t
4216 * outnvl: "waited" -> boolean_t
4218 static const zfs_ioc_key_t zfs_keys_pool_wait
[] = {
4219 {ZPOOL_WAIT_ACTIVITY
, DATA_TYPE_INT32
, 0},
4220 {ZPOOL_WAIT_TAG
, DATA_TYPE_UINT64
, ZK_OPTIONAL
},
4224 zfs_ioc_wait(const char *name
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
4231 if (nvlist_lookup_int32(innvl
, ZPOOL_WAIT_ACTIVITY
, &activity
) != 0)
4234 if (nvlist_lookup_uint64(innvl
, ZPOOL_WAIT_TAG
, &tag
) == 0)
4235 error
= spa_wait_tag(name
, activity
, tag
, &waited
);
4237 error
= spa_wait(name
, activity
, &waited
);
4240 fnvlist_add_boolean_value(outnvl
, ZPOOL_WAIT_WAITED
, waited
);
4246 * This ioctl waits for activity of a particular type to complete. If there is
4247 * no activity of that type in progress, it returns immediately, and the
4248 * returned value "waited" is false. If there is activity in progress, and no
4249 * tag is passed in, the ioctl blocks until all activity of that type is
4250 * complete, and then returns with "waited" set to true.
4252 * If a thread waiting in the ioctl receives a signal, the call will return
4253 * immediately, and the return value will be EINTR.
4256 * "wait_activity" -> int32_t
4259 * outnvl: "waited" -> boolean_t
4261 static const zfs_ioc_key_t zfs_keys_fs_wait
[] = {
4262 {ZFS_WAIT_ACTIVITY
, DATA_TYPE_INT32
, 0},
4266 zfs_ioc_wait_fs(const char *name
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
4269 boolean_t waited
= B_FALSE
;
4275 if (nvlist_lookup_int32(innvl
, ZFS_WAIT_ACTIVITY
, &activity
) != 0)
4276 return (SET_ERROR(EINVAL
));
4278 if (activity
>= ZFS_WAIT_NUM_ACTIVITIES
|| activity
< 0)
4279 return (SET_ERROR(EINVAL
));
4281 if ((error
= dsl_pool_hold(name
, FTAG
, &dp
)) != 0)
4284 if ((error
= dsl_dataset_hold(dp
, name
, FTAG
, &ds
)) != 0) {
4285 dsl_pool_rele(dp
, FTAG
);
4290 mutex_enter(&dd
->dd_activity_lock
);
4291 dd
->dd_activity_waiters
++;
4294 * We get a long-hold here so that the dsl_dataset_t and dsl_dir_t
4295 * aren't evicted while we're waiting. Normally this is prevented by
4296 * holding the pool, but we can't do that while we're waiting since
4297 * that would prevent TXGs from syncing out. Some of the functionality
4298 * of long-holds (e.g. preventing deletion) is unnecessary for this
4299 * case, since we would cancel the waiters before proceeding with a
4300 * deletion. An alternative mechanism for keeping the dataset around
4301 * could be developed but this is simpler.
4303 dsl_dataset_long_hold(ds
, FTAG
);
4304 dsl_pool_rele(dp
, FTAG
);
4306 error
= dsl_dir_wait(dd
, ds
, activity
, &waited
);
4308 dsl_dataset_long_rele(ds
, FTAG
);
4309 dd
->dd_activity_waiters
--;
4310 if (dd
->dd_activity_waiters
== 0)
4311 cv_signal(&dd
->dd_activity_cv
);
4312 mutex_exit(&dd
->dd_activity_lock
);
4314 dsl_dataset_rele(ds
, FTAG
);
4317 fnvlist_add_boolean_value(outnvl
, ZFS_WAIT_WAITED
, waited
);
4323 * fsname is name of dataset to rollback (to most recent snapshot)
4325 * innvl may contain name of expected target snapshot
4327 * outnvl: "target" -> name of most recent snapshot
4330 static const zfs_ioc_key_t zfs_keys_rollback
[] = {
4331 {"target", DATA_TYPE_STRING
, ZK_OPTIONAL
},
4335 zfs_ioc_rollback(const char *fsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
4338 zvol_state_handle_t
*zv
;
4339 const char *target
= NULL
;
4342 (void) nvlist_lookup_string(innvl
, "target", &target
);
4343 if (target
!= NULL
) {
4344 const char *cp
= strchr(target
, '@');
4347 * The snap name must contain an @, and the part after it must
4348 * contain only valid characters.
4351 zfs_component_namecheck(cp
+ 1, NULL
, NULL
) != 0)
4352 return (SET_ERROR(EINVAL
));
4355 if (getzfsvfs(fsname
, &zfsvfs
) == 0) {
4358 ds
= dmu_objset_ds(zfsvfs
->z_os
);
4359 error
= zfs_suspend_fs(zfsvfs
);
4363 error
= dsl_dataset_rollback(fsname
, target
, zfsvfs
,
4365 resume_err
= zfs_resume_fs(zfsvfs
, ds
);
4366 error
= error
? error
: resume_err
;
4368 zfs_vfs_rele(zfsvfs
);
4369 } else if ((zv
= zvol_suspend(fsname
)) != NULL
) {
4370 error
= dsl_dataset_rollback(fsname
, target
, zvol_tag(zv
),
4374 error
= dsl_dataset_rollback(fsname
, target
, NULL
, outnvl
);
4380 recursive_unmount(const char *fsname
, void *arg
)
4382 const char *snapname
= arg
;
4385 fullname
= kmem_asprintf("%s@%s", fsname
, snapname
);
4386 zfs_unmount_snap(fullname
);
4387 kmem_strfree(fullname
);
4394 * snapname is the snapshot to redact.
4396 * "bookname" -> (string)
4397 * shortname of the redaction bookmark to generate
4398 * "snapnv" -> (nvlist, values ignored)
4399 * snapshots to redact snapname with respect to
4405 static const zfs_ioc_key_t zfs_keys_redact
[] = {
4406 {"bookname", DATA_TYPE_STRING
, 0},
4407 {"snapnv", DATA_TYPE_NVLIST
, 0},
4411 zfs_ioc_redact(const char *snapname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
4414 nvlist_t
*redactnvl
= NULL
;
4415 const char *redactbook
= NULL
;
4417 if (nvlist_lookup_nvlist(innvl
, "snapnv", &redactnvl
) != 0)
4418 return (SET_ERROR(EINVAL
));
4419 if (fnvlist_num_pairs(redactnvl
) == 0)
4420 return (SET_ERROR(ENXIO
));
4421 if (nvlist_lookup_string(innvl
, "bookname", &redactbook
) != 0)
4422 return (SET_ERROR(EINVAL
));
4424 return (dmu_redact_snap(snapname
, redactnvl
, redactbook
));
4429 * zc_name old name of dataset
4430 * zc_value new name of dataset
4431 * zc_cookie recursive flag (only valid for snapshots)
4436 zfs_ioc_rename(zfs_cmd_t
*zc
)
4439 dmu_objset_type_t ost
;
4440 boolean_t recursive
= zc
->zc_cookie
& 1;
4441 boolean_t nounmount
= !!(zc
->zc_cookie
& 2);
4445 /* "zfs rename" from and to ...%recv datasets should both fail */
4446 zc
->zc_name
[sizeof (zc
->zc_name
) - 1] = '\0';
4447 zc
->zc_value
[sizeof (zc
->zc_value
) - 1] = '\0';
4448 if (dataset_namecheck(zc
->zc_name
, NULL
, NULL
) != 0 ||
4449 dataset_namecheck(zc
->zc_value
, NULL
, NULL
) != 0 ||
4450 strchr(zc
->zc_name
, '%') || strchr(zc
->zc_value
, '%'))
4451 return (SET_ERROR(EINVAL
));
4453 err
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
);
4456 ost
= dmu_objset_type(os
);
4457 dmu_objset_rele(os
, FTAG
);
4459 at
= strchr(zc
->zc_name
, '@');
4461 /* snaps must be in same fs */
4464 if (strncmp(zc
->zc_name
, zc
->zc_value
, at
- zc
->zc_name
+ 1))
4465 return (SET_ERROR(EXDEV
));
4467 if (ost
== DMU_OST_ZFS
&& !nounmount
) {
4468 error
= dmu_objset_find(zc
->zc_name
,
4469 recursive_unmount
, at
+ 1,
4470 recursive
? DS_FIND_CHILDREN
: 0);
4476 error
= dsl_dataset_rename_snapshot(zc
->zc_name
,
4477 at
+ 1, strchr(zc
->zc_value
, '@') + 1, recursive
);
4482 return (dsl_dir_rename(zc
->zc_name
, zc
->zc_value
));
4487 zfs_check_settable(const char *dsname
, nvpair_t
*pair
, cred_t
*cr
)
4489 const char *propname
= nvpair_name(pair
);
4490 boolean_t issnap
= (strchr(dsname
, '@') != NULL
);
4491 zfs_prop_t prop
= zfs_name_to_prop(propname
);
4492 uint64_t intval
, compval
;
4495 if (prop
== ZPROP_USERPROP
) {
4496 if (zfs_prop_user(propname
)) {
4497 if ((err
= zfs_secpolicy_write_perms(dsname
,
4498 ZFS_DELEG_PERM_USERPROP
, cr
)))
4503 if (!issnap
&& zfs_prop_userquota(propname
)) {
4504 const char *perm
= NULL
;
4505 const char *uq_prefix
=
4506 zfs_userquota_prop_prefixes
[ZFS_PROP_USERQUOTA
];
4507 const char *gq_prefix
=
4508 zfs_userquota_prop_prefixes
[ZFS_PROP_GROUPQUOTA
];
4509 const char *uiq_prefix
=
4510 zfs_userquota_prop_prefixes
[ZFS_PROP_USEROBJQUOTA
];
4511 const char *giq_prefix
=
4512 zfs_userquota_prop_prefixes
[ZFS_PROP_GROUPOBJQUOTA
];
4513 const char *pq_prefix
=
4514 zfs_userquota_prop_prefixes
[ZFS_PROP_PROJECTQUOTA
];
4515 const char *piq_prefix
= zfs_userquota_prop_prefixes
[\
4516 ZFS_PROP_PROJECTOBJQUOTA
];
4518 if (strncmp(propname
, uq_prefix
,
4519 strlen(uq_prefix
)) == 0) {
4520 perm
= ZFS_DELEG_PERM_USERQUOTA
;
4521 } else if (strncmp(propname
, uiq_prefix
,
4522 strlen(uiq_prefix
)) == 0) {
4523 perm
= ZFS_DELEG_PERM_USEROBJQUOTA
;
4524 } else if (strncmp(propname
, gq_prefix
,
4525 strlen(gq_prefix
)) == 0) {
4526 perm
= ZFS_DELEG_PERM_GROUPQUOTA
;
4527 } else if (strncmp(propname
, giq_prefix
,
4528 strlen(giq_prefix
)) == 0) {
4529 perm
= ZFS_DELEG_PERM_GROUPOBJQUOTA
;
4530 } else if (strncmp(propname
, pq_prefix
,
4531 strlen(pq_prefix
)) == 0) {
4532 perm
= ZFS_DELEG_PERM_PROJECTQUOTA
;
4533 } else if (strncmp(propname
, piq_prefix
,
4534 strlen(piq_prefix
)) == 0) {
4535 perm
= ZFS_DELEG_PERM_PROJECTOBJQUOTA
;
4537 /* {USER|GROUP|PROJECT}USED are read-only */
4538 return (SET_ERROR(EINVAL
));
4541 if ((err
= zfs_secpolicy_write_perms(dsname
, perm
, cr
)))
4546 return (SET_ERROR(EINVAL
));
4550 return (SET_ERROR(EINVAL
));
4552 if (nvpair_type(pair
) == DATA_TYPE_NVLIST
) {
4554 * dsl_prop_get_all_impl() returns properties in this
4558 VERIFY(nvpair_value_nvlist(pair
, &attrs
) == 0);
4559 VERIFY(nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
4564 * Check that this value is valid for this pool version
4567 case ZFS_PROP_COMPRESSION
:
4569 * If the user specified gzip compression, make sure
4570 * the SPA supports it. We ignore any errors here since
4571 * we'll catch them later.
4573 if (nvpair_value_uint64(pair
, &intval
) == 0) {
4574 compval
= ZIO_COMPRESS_ALGO(intval
);
4575 if (compval
>= ZIO_COMPRESS_GZIP_1
&&
4576 compval
<= ZIO_COMPRESS_GZIP_9
&&
4577 zfs_earlier_version(dsname
,
4578 SPA_VERSION_GZIP_COMPRESSION
)) {
4579 return (SET_ERROR(ENOTSUP
));
4582 if (compval
== ZIO_COMPRESS_ZLE
&&
4583 zfs_earlier_version(dsname
,
4584 SPA_VERSION_ZLE_COMPRESSION
))
4585 return (SET_ERROR(ENOTSUP
));
4587 if (compval
== ZIO_COMPRESS_LZ4
) {
4590 if ((err
= spa_open(dsname
, &spa
, FTAG
)) != 0)
4593 if (!spa_feature_is_enabled(spa
,
4594 SPA_FEATURE_LZ4_COMPRESS
)) {
4595 spa_close(spa
, FTAG
);
4596 return (SET_ERROR(ENOTSUP
));
4598 spa_close(spa
, FTAG
);
4601 if (compval
== ZIO_COMPRESS_ZSTD
) {
4604 if ((err
= spa_open(dsname
, &spa
, FTAG
)) != 0)
4607 if (!spa_feature_is_enabled(spa
,
4608 SPA_FEATURE_ZSTD_COMPRESS
)) {
4609 spa_close(spa
, FTAG
);
4610 return (SET_ERROR(ENOTSUP
));
4612 spa_close(spa
, FTAG
);
4617 case ZFS_PROP_COPIES
:
4618 if (zfs_earlier_version(dsname
, SPA_VERSION_DITTO_BLOCKS
))
4619 return (SET_ERROR(ENOTSUP
));
4622 case ZFS_PROP_VOLBLOCKSIZE
:
4623 case ZFS_PROP_RECORDSIZE
:
4624 /* Record sizes above 128k need the feature to be enabled */
4625 if (nvpair_value_uint64(pair
, &intval
) == 0 &&
4626 intval
> SPA_OLD_MAXBLOCKSIZE
) {
4630 * We don't allow setting the property above 1MB,
4631 * unless the tunable has been changed.
4633 if (intval
> zfs_max_recordsize
||
4634 intval
> SPA_MAXBLOCKSIZE
)
4635 return (SET_ERROR(ERANGE
));
4637 if ((err
= spa_open(dsname
, &spa
, FTAG
)) != 0)
4640 if (!spa_feature_is_enabled(spa
,
4641 SPA_FEATURE_LARGE_BLOCKS
)) {
4642 spa_close(spa
, FTAG
);
4643 return (SET_ERROR(ENOTSUP
));
4645 spa_close(spa
, FTAG
);
4649 case ZFS_PROP_DNODESIZE
:
4650 /* Dnode sizes above 512 need the feature to be enabled */
4651 if (nvpair_value_uint64(pair
, &intval
) == 0 &&
4652 intval
!= ZFS_DNSIZE_LEGACY
) {
4655 if ((err
= spa_open(dsname
, &spa
, FTAG
)) != 0)
4658 if (!spa_feature_is_enabled(spa
,
4659 SPA_FEATURE_LARGE_DNODE
)) {
4660 spa_close(spa
, FTAG
);
4661 return (SET_ERROR(ENOTSUP
));
4663 spa_close(spa
, FTAG
);
4667 case ZFS_PROP_SPECIAL_SMALL_BLOCKS
:
4669 * This property could require the allocation classes
4670 * feature to be active for setting, however we allow
4671 * it so that tests of settable properties succeed.
4672 * The CLI will issue a warning in this case.
4676 case ZFS_PROP_SHARESMB
:
4677 if (zpl_earlier_version(dsname
, ZPL_VERSION_FUID
))
4678 return (SET_ERROR(ENOTSUP
));
4681 case ZFS_PROP_ACLINHERIT
:
4682 if (nvpair_type(pair
) == DATA_TYPE_UINT64
&&
4683 nvpair_value_uint64(pair
, &intval
) == 0) {
4684 if (intval
== ZFS_ACL_PASSTHROUGH_X
&&
4685 zfs_earlier_version(dsname
,
4686 SPA_VERSION_PASSTHROUGH_X
))
4687 return (SET_ERROR(ENOTSUP
));
4690 case ZFS_PROP_CHECKSUM
:
4691 case ZFS_PROP_DEDUP
:
4693 spa_feature_t feature
;
4697 /* dedup feature version checks */
4698 if (prop
== ZFS_PROP_DEDUP
&&
4699 zfs_earlier_version(dsname
, SPA_VERSION_DEDUP
))
4700 return (SET_ERROR(ENOTSUP
));
4702 if (nvpair_type(pair
) == DATA_TYPE_UINT64
&&
4703 nvpair_value_uint64(pair
, &intval
) == 0) {
4704 /* check prop value is enabled in features */
4705 feature
= zio_checksum_to_feature(
4706 intval
& ZIO_CHECKSUM_MASK
);
4707 if (feature
== SPA_FEATURE_NONE
)
4710 if ((err
= spa_open(dsname
, &spa
, FTAG
)) != 0)
4713 if (!spa_feature_is_enabled(spa
, feature
)) {
4714 spa_close(spa
, FTAG
);
4715 return (SET_ERROR(ENOTSUP
));
4717 spa_close(spa
, FTAG
);
4726 return (zfs_secpolicy_setprop(dsname
, prop
, pair
, CRED()));
4730 * Removes properties from the given props list that fail permission checks
4731 * needed to clear them and to restore them in case of a receive error. For each
4732 * property, make sure we have both set and inherit permissions.
4734 * Returns the first error encountered if any permission checks fail. If the
4735 * caller provides a non-NULL errlist, it also gives the complete list of names
4736 * of all the properties that failed a permission check along with the
4737 * corresponding error numbers. The caller is responsible for freeing the
4740 * If every property checks out successfully, zero is returned and the list
4741 * pointed at by errlist is NULL.
4744 zfs_check_clearable(const char *dataset
, nvlist_t
*props
, nvlist_t
**errlist
)
4747 nvpair_t
*pair
, *next_pair
;
4754 VERIFY(nvlist_alloc(&errors
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
4756 zc
= kmem_alloc(sizeof (zfs_cmd_t
), KM_SLEEP
);
4757 (void) strlcpy(zc
->zc_name
, dataset
, sizeof (zc
->zc_name
));
4758 pair
= nvlist_next_nvpair(props
, NULL
);
4759 while (pair
!= NULL
) {
4760 next_pair
= nvlist_next_nvpair(props
, pair
);
4762 (void) strlcpy(zc
->zc_value
, nvpair_name(pair
),
4763 sizeof (zc
->zc_value
));
4764 if ((err
= zfs_check_settable(dataset
, pair
, CRED())) != 0 ||
4765 (err
= zfs_secpolicy_inherit_prop(zc
, NULL
, CRED())) != 0) {
4766 VERIFY(nvlist_remove_nvpair(props
, pair
) == 0);
4767 VERIFY(nvlist_add_int32(errors
,
4768 zc
->zc_value
, err
) == 0);
4772 kmem_free(zc
, sizeof (zfs_cmd_t
));
4774 if ((pair
= nvlist_next_nvpair(errors
, NULL
)) == NULL
) {
4775 nvlist_free(errors
);
4778 VERIFY(nvpair_value_int32(pair
, &rv
) == 0);
4781 if (errlist
== NULL
)
4782 nvlist_free(errors
);
4790 propval_equals(nvpair_t
*p1
, nvpair_t
*p2
)
4792 if (nvpair_type(p1
) == DATA_TYPE_NVLIST
) {
4793 /* dsl_prop_get_all_impl() format */
4795 VERIFY(nvpair_value_nvlist(p1
, &attrs
) == 0);
4796 VERIFY(nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
4800 if (nvpair_type(p2
) == DATA_TYPE_NVLIST
) {
4802 VERIFY(nvpair_value_nvlist(p2
, &attrs
) == 0);
4803 VERIFY(nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
4807 if (nvpair_type(p1
) != nvpair_type(p2
))
4810 if (nvpair_type(p1
) == DATA_TYPE_STRING
) {
4811 const char *valstr1
, *valstr2
;
4813 VERIFY(nvpair_value_string(p1
, &valstr1
) == 0);
4814 VERIFY(nvpair_value_string(p2
, &valstr2
) == 0);
4815 return (strcmp(valstr1
, valstr2
) == 0);
4817 uint64_t intval1
, intval2
;
4819 VERIFY(nvpair_value_uint64(p1
, &intval1
) == 0);
4820 VERIFY(nvpair_value_uint64(p2
, &intval2
) == 0);
4821 return (intval1
== intval2
);
4826 * Remove properties from props if they are not going to change (as determined
4827 * by comparison with origprops). Remove them from origprops as well, since we
4828 * do not need to clear or restore properties that won't change.
4831 props_reduce(nvlist_t
*props
, nvlist_t
*origprops
)
4833 nvpair_t
*pair
, *next_pair
;
4835 if (origprops
== NULL
)
4836 return; /* all props need to be received */
4838 pair
= nvlist_next_nvpair(props
, NULL
);
4839 while (pair
!= NULL
) {
4840 const char *propname
= nvpair_name(pair
);
4843 next_pair
= nvlist_next_nvpair(props
, pair
);
4845 if ((nvlist_lookup_nvpair(origprops
, propname
,
4846 &match
) != 0) || !propval_equals(pair
, match
))
4847 goto next
; /* need to set received value */
4849 /* don't clear the existing received value */
4850 (void) nvlist_remove_nvpair(origprops
, match
);
4851 /* don't bother receiving the property */
4852 (void) nvlist_remove_nvpair(props
, pair
);
4859 * Extract properties that cannot be set PRIOR to the receipt of a dataset.
4860 * For example, refquota cannot be set until after the receipt of a dataset,
4861 * because in replication streams, an older/earlier snapshot may exceed the
4862 * refquota. We want to receive the older/earlier snapshot, but setting
4863 * refquota pre-receipt will set the dsl's ACTUAL quota, which will prevent
4864 * the older/earlier snapshot from being received (with EDQUOT).
4866 * The ZFS test "zfs_receive_011_pos" demonstrates such a scenario.
4868 * libzfs will need to be judicious handling errors encountered by props
4869 * extracted by this function.
4872 extract_delay_props(nvlist_t
*props
)
4874 nvlist_t
*delayprops
;
4875 nvpair_t
*nvp
, *tmp
;
4876 static const zfs_prop_t delayable
[] = {
4878 ZFS_PROP_KEYLOCATION
,
4880 * Setting ZFS_PROP_SHARESMB requires the objset type to be
4881 * known, which is not possible prior to receipt of raw sends.
4888 VERIFY(nvlist_alloc(&delayprops
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
4890 for (nvp
= nvlist_next_nvpair(props
, NULL
); nvp
!= NULL
;
4891 nvp
= nvlist_next_nvpair(props
, nvp
)) {
4893 * strcmp() is safe because zfs_prop_to_name() always returns
4896 for (i
= 0; delayable
[i
] != 0; i
++) {
4897 if (strcmp(zfs_prop_to_name(delayable
[i
]),
4898 nvpair_name(nvp
)) == 0) {
4902 if (delayable
[i
] != 0) {
4903 tmp
= nvlist_prev_nvpair(props
, nvp
);
4904 VERIFY(nvlist_add_nvpair(delayprops
, nvp
) == 0);
4905 VERIFY(nvlist_remove_nvpair(props
, nvp
) == 0);
4910 if (nvlist_empty(delayprops
)) {
4911 nvlist_free(delayprops
);
4914 return (delayprops
);
4918 zfs_allow_log_destroy(void *arg
)
4920 char *poolname
= arg
;
4922 if (poolname
!= NULL
)
4923 kmem_strfree(poolname
);
4927 static boolean_t zfs_ioc_recv_inject_err
;
4931 * nvlist 'errors' is always allocated. It will contain descriptions of
4932 * encountered errors, if any. It's the callers responsibility to free.
4935 zfs_ioc_recv_impl(char *tofs
, char *tosnap
, const char *origin
,
4936 nvlist_t
*recvprops
, nvlist_t
*localprops
, nvlist_t
*hidden_args
,
4937 boolean_t force
, boolean_t heal
, boolean_t resumable
, int input_fd
,
4938 dmu_replay_record_t
*begin_record
, uint64_t *read_bytes
,
4939 uint64_t *errflags
, nvlist_t
**errors
)
4941 dmu_recv_cookie_t drc
;
4943 int props_error
= 0;
4945 nvlist_t
*local_delayprops
= NULL
;
4946 nvlist_t
*recv_delayprops
= NULL
;
4947 nvlist_t
*inherited_delayprops
= NULL
;
4948 nvlist_t
*origprops
= NULL
; /* existing properties */
4949 nvlist_t
*origrecvd
= NULL
; /* existing received properties */
4950 boolean_t first_recvd_props
= B_FALSE
;
4951 boolean_t tofs_was_redacted
;
4952 zfs_file_t
*input_fp
;
4956 *errors
= fnvlist_alloc();
4959 if ((input_fp
= zfs_file_get(input_fd
)) == NULL
)
4960 return (SET_ERROR(EBADF
));
4962 noff
= off
= zfs_file_off(input_fp
);
4963 error
= dmu_recv_begin(tofs
, tosnap
, begin_record
, force
, heal
,
4964 resumable
, localprops
, hidden_args
, origin
, &drc
, input_fp
,
4968 tofs_was_redacted
= dsl_get_redacted(drc
.drc_ds
);
4971 * Set properties before we receive the stream so that they are applied
4972 * to the new data. Note that we must call dmu_recv_stream() if
4973 * dmu_recv_begin() succeeds.
4975 if (recvprops
!= NULL
&& !drc
.drc_newfs
) {
4976 if (spa_version(dsl_dataset_get_spa(drc
.drc_ds
)) >=
4977 SPA_VERSION_RECVD_PROPS
&&
4978 !dsl_prop_get_hasrecvd(tofs
))
4979 first_recvd_props
= B_TRUE
;
4982 * If new received properties are supplied, they are to
4983 * completely replace the existing received properties,
4984 * so stash away the existing ones.
4986 if (dsl_prop_get_received(tofs
, &origrecvd
) == 0) {
4987 nvlist_t
*errlist
= NULL
;
4989 * Don't bother writing a property if its value won't
4990 * change (and avoid the unnecessary security checks).
4992 * The first receive after SPA_VERSION_RECVD_PROPS is a
4993 * special case where we blow away all local properties
4996 if (!first_recvd_props
)
4997 props_reduce(recvprops
, origrecvd
);
4998 if (zfs_check_clearable(tofs
, origrecvd
, &errlist
) != 0)
4999 (void) nvlist_merge(*errors
, errlist
, 0);
5000 nvlist_free(errlist
);
5002 if (clear_received_props(tofs
, origrecvd
,
5003 first_recvd_props
? NULL
: recvprops
) != 0)
5004 *errflags
|= ZPROP_ERR_NOCLEAR
;
5006 *errflags
|= ZPROP_ERR_NOCLEAR
;
5011 * Stash away existing properties so we can restore them on error unless
5012 * we're doing the first receive after SPA_VERSION_RECVD_PROPS, in which
5013 * case "origrecvd" will take care of that.
5015 if (localprops
!= NULL
&& !drc
.drc_newfs
&& !first_recvd_props
) {
5017 if (dmu_objset_hold(tofs
, FTAG
, &os
) == 0) {
5018 if (dsl_prop_get_all(os
, &origprops
) != 0) {
5019 *errflags
|= ZPROP_ERR_NOCLEAR
;
5021 dmu_objset_rele(os
, FTAG
);
5023 *errflags
|= ZPROP_ERR_NOCLEAR
;
5027 if (recvprops
!= NULL
) {
5028 props_error
= dsl_prop_set_hasrecvd(tofs
);
5030 if (props_error
== 0) {
5031 recv_delayprops
= extract_delay_props(recvprops
);
5032 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_RECEIVED
,
5033 recvprops
, *errors
);
5037 if (localprops
!= NULL
) {
5038 nvlist_t
*oprops
= fnvlist_alloc();
5039 nvlist_t
*xprops
= fnvlist_alloc();
5040 nvpair_t
*nvp
= NULL
;
5042 while ((nvp
= nvlist_next_nvpair(localprops
, nvp
)) != NULL
) {
5043 if (nvpair_type(nvp
) == DATA_TYPE_BOOLEAN
) {
5045 const char *name
= nvpair_name(nvp
);
5046 zfs_prop_t prop
= zfs_name_to_prop(name
);
5047 if (prop
!= ZPROP_USERPROP
) {
5048 if (!zfs_prop_inheritable(prop
))
5050 } else if (!zfs_prop_user(name
))
5052 fnvlist_add_boolean(xprops
, name
);
5054 /* -o property=value */
5055 fnvlist_add_nvpair(oprops
, nvp
);
5059 local_delayprops
= extract_delay_props(oprops
);
5060 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_LOCAL
,
5062 inherited_delayprops
= extract_delay_props(xprops
);
5063 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_INHERITED
,
5066 nvlist_free(oprops
);
5067 nvlist_free(xprops
);
5070 error
= dmu_recv_stream(&drc
, &off
);
5073 zfsvfs_t
*zfsvfs
= NULL
;
5074 zvol_state_handle_t
*zv
= NULL
;
5076 if (getzfsvfs(tofs
, &zfsvfs
) == 0) {
5080 boolean_t stream_is_redacted
= DMU_GET_FEATUREFLAGS(
5081 begin_record
->drr_u
.drr_begin
.
5082 drr_versioninfo
) & DMU_BACKUP_FEATURE_REDACTED
;
5084 ds
= dmu_objset_ds(zfsvfs
->z_os
);
5085 error
= zfs_suspend_fs(zfsvfs
);
5087 * If the suspend fails, then the recv_end will
5088 * likely also fail, and clean up after itself.
5090 end_err
= dmu_recv_end(&drc
, zfsvfs
);
5092 * If the dataset was not redacted, but we received a
5093 * redacted stream onto it, we need to unmount the
5094 * dataset. Otherwise, resume the filesystem.
5096 if (error
== 0 && !drc
.drc_newfs
&&
5097 stream_is_redacted
&& !tofs_was_redacted
) {
5098 error
= zfs_end_fs(zfsvfs
, ds
);
5099 } else if (error
== 0) {
5100 error
= zfs_resume_fs(zfsvfs
, ds
);
5102 error
= error
? error
: end_err
;
5103 zfs_vfs_rele(zfsvfs
);
5104 } else if ((zv
= zvol_suspend(tofs
)) != NULL
) {
5105 error
= dmu_recv_end(&drc
, zvol_tag(zv
));
5108 error
= dmu_recv_end(&drc
, NULL
);
5111 /* Set delayed properties now, after we're done receiving. */
5112 if (recv_delayprops
!= NULL
&& error
== 0) {
5113 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_RECEIVED
,
5114 recv_delayprops
, *errors
);
5116 if (local_delayprops
!= NULL
&& error
== 0) {
5117 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_LOCAL
,
5118 local_delayprops
, *errors
);
5120 if (inherited_delayprops
!= NULL
&& error
== 0) {
5121 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_INHERITED
,
5122 inherited_delayprops
, *errors
);
5127 * Merge delayed props back in with initial props, in case
5128 * we're DEBUG and zfs_ioc_recv_inject_err is set (which means
5129 * we have to make sure clear_received_props() includes
5130 * the delayed properties).
5132 * Since zfs_ioc_recv_inject_err is only in DEBUG kernels,
5133 * using ASSERT() will be just like a VERIFY.
5135 if (recv_delayprops
!= NULL
) {
5136 ASSERT(nvlist_merge(recvprops
, recv_delayprops
, 0) == 0);
5137 nvlist_free(recv_delayprops
);
5139 if (local_delayprops
!= NULL
) {
5140 ASSERT(nvlist_merge(localprops
, local_delayprops
, 0) == 0);
5141 nvlist_free(local_delayprops
);
5143 if (inherited_delayprops
!= NULL
) {
5144 ASSERT(nvlist_merge(localprops
, inherited_delayprops
, 0) == 0);
5145 nvlist_free(inherited_delayprops
);
5147 *read_bytes
= off
- noff
;
5150 if (zfs_ioc_recv_inject_err
) {
5151 zfs_ioc_recv_inject_err
= B_FALSE
;
5157 * On error, restore the original props.
5159 if (error
!= 0 && recvprops
!= NULL
&& !drc
.drc_newfs
) {
5160 if (clear_received_props(tofs
, recvprops
, NULL
) != 0) {
5162 * We failed to clear the received properties.
5163 * Since we may have left a $recvd value on the
5164 * system, we can't clear the $hasrecvd flag.
5166 *errflags
|= ZPROP_ERR_NORESTORE
;
5167 } else if (first_recvd_props
) {
5168 dsl_prop_unset_hasrecvd(tofs
);
5171 if (origrecvd
== NULL
&& !drc
.drc_newfs
) {
5172 /* We failed to stash the original properties. */
5173 *errflags
|= ZPROP_ERR_NORESTORE
;
5177 * dsl_props_set() will not convert RECEIVED to LOCAL on or
5178 * after SPA_VERSION_RECVD_PROPS, so we need to specify LOCAL
5179 * explicitly if we're restoring local properties cleared in the
5180 * first new-style receive.
5182 if (origrecvd
!= NULL
&&
5183 zfs_set_prop_nvlist(tofs
, (first_recvd_props
?
5184 ZPROP_SRC_LOCAL
: ZPROP_SRC_RECEIVED
),
5185 origrecvd
, NULL
) != 0) {
5187 * We stashed the original properties but failed to
5190 *errflags
|= ZPROP_ERR_NORESTORE
;
5193 if (error
!= 0 && localprops
!= NULL
&& !drc
.drc_newfs
&&
5194 !first_recvd_props
) {
5196 nvlist_t
*inheritprops
;
5199 if (origprops
== NULL
) {
5200 /* We failed to stash the original properties. */
5201 *errflags
|= ZPROP_ERR_NORESTORE
;
5205 /* Restore original props */
5206 setprops
= fnvlist_alloc();
5207 inheritprops
= fnvlist_alloc();
5209 while ((nvp
= nvlist_next_nvpair(localprops
, nvp
)) != NULL
) {
5210 const char *name
= nvpair_name(nvp
);
5214 if (!nvlist_exists(origprops
, name
)) {
5216 * Property was not present or was explicitly
5217 * inherited before the receive, restore this.
5219 fnvlist_add_boolean(inheritprops
, name
);
5222 attrs
= fnvlist_lookup_nvlist(origprops
, name
);
5223 source
= fnvlist_lookup_string(attrs
, ZPROP_SOURCE
);
5225 /* Skip received properties */
5226 if (strcmp(source
, ZPROP_SOURCE_VAL_RECVD
) == 0)
5229 if (strcmp(source
, tofs
) == 0) {
5230 /* Property was locally set */
5231 fnvlist_add_nvlist(setprops
, name
, attrs
);
5233 /* Property was implicitly inherited */
5234 fnvlist_add_boolean(inheritprops
, name
);
5238 if (zfs_set_prop_nvlist(tofs
, ZPROP_SRC_LOCAL
, setprops
,
5240 *errflags
|= ZPROP_ERR_NORESTORE
;
5241 if (zfs_set_prop_nvlist(tofs
, ZPROP_SRC_INHERITED
, inheritprops
,
5243 *errflags
|= ZPROP_ERR_NORESTORE
;
5245 nvlist_free(setprops
);
5246 nvlist_free(inheritprops
);
5249 zfs_file_put(input_fp
);
5250 nvlist_free(origrecvd
);
5251 nvlist_free(origprops
);
5254 error
= props_error
;
5261 * zc_name name of containing filesystem (unused)
5262 * zc_nvlist_src{_size} nvlist of properties to apply
5263 * zc_nvlist_conf{_size} nvlist of properties to exclude
5264 * (DATA_TYPE_BOOLEAN) and override (everything else)
5265 * zc_value name of snapshot to create
5266 * zc_string name of clone origin (if DRR_FLAG_CLONE)
5267 * zc_cookie file descriptor to recv from
5268 * zc_begin_record the BEGIN record of the stream (not byteswapped)
5269 * zc_guid force flag
5272 * zc_cookie number of bytes read
5273 * zc_obj zprop_errflags_t
5274 * zc_nvlist_dst{_size} error for each unapplied received property
5277 zfs_ioc_recv(zfs_cmd_t
*zc
)
5279 dmu_replay_record_t begin_record
;
5280 nvlist_t
*errors
= NULL
;
5281 nvlist_t
*recvdprops
= NULL
;
5282 nvlist_t
*localprops
= NULL
;
5283 const char *origin
= NULL
;
5285 char tofs
[ZFS_MAX_DATASET_NAME_LEN
];
5288 if (dataset_namecheck(zc
->zc_value
, NULL
, NULL
) != 0 ||
5289 strchr(zc
->zc_value
, '@') == NULL
||
5290 strchr(zc
->zc_value
, '%'))
5291 return (SET_ERROR(EINVAL
));
5293 (void) strlcpy(tofs
, zc
->zc_value
, sizeof (tofs
));
5294 tosnap
= strchr(tofs
, '@');
5297 if (zc
->zc_nvlist_src
!= 0 &&
5298 (error
= get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
5299 zc
->zc_iflags
, &recvdprops
)) != 0)
5302 if (zc
->zc_nvlist_conf
!= 0 &&
5303 (error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
5304 zc
->zc_iflags
, &localprops
)) != 0)
5307 if (zc
->zc_string
[0])
5308 origin
= zc
->zc_string
;
5310 begin_record
.drr_type
= DRR_BEGIN
;
5311 begin_record
.drr_payloadlen
= 0;
5312 begin_record
.drr_u
.drr_begin
= zc
->zc_begin_record
;
5314 error
= zfs_ioc_recv_impl(tofs
, tosnap
, origin
, recvdprops
, localprops
,
5315 NULL
, zc
->zc_guid
, B_FALSE
, B_FALSE
, zc
->zc_cookie
, &begin_record
,
5316 &zc
->zc_cookie
, &zc
->zc_obj
, &errors
);
5317 nvlist_free(recvdprops
);
5318 nvlist_free(localprops
);
5321 * Now that all props, initial and delayed, are set, report the prop
5322 * errors to the caller.
5324 if (zc
->zc_nvlist_dst_size
!= 0 && errors
!= NULL
&&
5325 (nvlist_smush(errors
, zc
->zc_nvlist_dst_size
) != 0 ||
5326 put_nvlist(zc
, errors
) != 0)) {
5328 * Caller made zc->zc_nvlist_dst less than the minimum expected
5329 * size or supplied an invalid address.
5331 error
= SET_ERROR(EINVAL
);
5334 nvlist_free(errors
);
5341 * "snapname" -> full name of the snapshot to create
5342 * (optional) "props" -> received properties to set (nvlist)
5343 * (optional) "localprops" -> override and exclude properties (nvlist)
5344 * (optional) "origin" -> name of clone origin (DRR_FLAG_CLONE)
5345 * "begin_record" -> non-byteswapped dmu_replay_record_t
5346 * "input_fd" -> file descriptor to read stream from (int32)
5347 * (optional) "force" -> force flag (value ignored)
5348 * (optional) "heal" -> use send stream to heal data corruption
5349 * (optional) "resumable" -> resumable flag (value ignored)
5350 * (optional) "cleanup_fd" -> unused
5351 * (optional) "action_handle" -> unused
5352 * (optional) "hidden_args" -> { "wkeydata" -> value }
5356 * "read_bytes" -> number of bytes read
5357 * "error_flags" -> zprop_errflags_t
5358 * "errors" -> error for each unapplied received property (nvlist)
5361 static const zfs_ioc_key_t zfs_keys_recv_new
[] = {
5362 {"snapname", DATA_TYPE_STRING
, 0},
5363 {"props", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
5364 {"localprops", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
5365 {"origin", DATA_TYPE_STRING
, ZK_OPTIONAL
},
5366 {"begin_record", DATA_TYPE_BYTE_ARRAY
, 0},
5367 {"input_fd", DATA_TYPE_INT32
, 0},
5368 {"force", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
5369 {"heal", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
5370 {"resumable", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
5371 {"cleanup_fd", DATA_TYPE_INT32
, ZK_OPTIONAL
},
5372 {"action_handle", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
5373 {"hidden_args", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
5377 zfs_ioc_recv_new(const char *fsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
5379 dmu_replay_record_t
*begin_record
;
5380 uint_t begin_record_size
;
5381 nvlist_t
*errors
= NULL
;
5382 nvlist_t
*recvprops
= NULL
;
5383 nvlist_t
*localprops
= NULL
;
5384 nvlist_t
*hidden_args
= NULL
;
5385 const char *snapname
;
5386 const char *origin
= NULL
;
5388 char tofs
[ZFS_MAX_DATASET_NAME_LEN
];
5391 boolean_t resumable
;
5392 uint64_t read_bytes
= 0;
5393 uint64_t errflags
= 0;
5397 snapname
= fnvlist_lookup_string(innvl
, "snapname");
5399 if (dataset_namecheck(snapname
, NULL
, NULL
) != 0 ||
5400 strchr(snapname
, '@') == NULL
||
5401 strchr(snapname
, '%'))
5402 return (SET_ERROR(EINVAL
));
5404 (void) strlcpy(tofs
, snapname
, sizeof (tofs
));
5405 tosnap
= strchr(tofs
, '@');
5408 error
= nvlist_lookup_string(innvl
, "origin", &origin
);
5409 if (error
&& error
!= ENOENT
)
5412 error
= nvlist_lookup_byte_array(innvl
, "begin_record",
5413 (uchar_t
**)&begin_record
, &begin_record_size
);
5414 if (error
!= 0 || begin_record_size
!= sizeof (*begin_record
))
5415 return (SET_ERROR(EINVAL
));
5417 input_fd
= fnvlist_lookup_int32(innvl
, "input_fd");
5419 force
= nvlist_exists(innvl
, "force");
5420 heal
= nvlist_exists(innvl
, "heal");
5421 resumable
= nvlist_exists(innvl
, "resumable");
5423 /* we still use "props" here for backwards compatibility */
5424 error
= nvlist_lookup_nvlist(innvl
, "props", &recvprops
);
5425 if (error
&& error
!= ENOENT
)
5428 error
= nvlist_lookup_nvlist(innvl
, "localprops", &localprops
);
5429 if (error
&& error
!= ENOENT
)
5432 error
= nvlist_lookup_nvlist(innvl
, ZPOOL_HIDDEN_ARGS
, &hidden_args
);
5433 if (error
&& error
!= ENOENT
)
5436 error
= zfs_ioc_recv_impl(tofs
, tosnap
, origin
, recvprops
, localprops
,
5437 hidden_args
, force
, heal
, resumable
, input_fd
, begin_record
,
5438 &read_bytes
, &errflags
, &errors
);
5440 fnvlist_add_uint64(outnvl
, "read_bytes", read_bytes
);
5441 fnvlist_add_uint64(outnvl
, "error_flags", errflags
);
5442 fnvlist_add_nvlist(outnvl
, "errors", errors
);
5444 nvlist_free(errors
);
5445 nvlist_free(recvprops
);
5446 nvlist_free(localprops
);
5451 typedef struct dump_bytes_io
{
5459 dump_bytes_cb(void *arg
)
5461 dump_bytes_io_t
*dbi
= (dump_bytes_io_t
*)arg
;
5468 dbi
->dbi_err
= zfs_file_write(fp
, buf
, dbi
->dbi_len
, NULL
);
5472 dump_bytes(objset_t
*os
, void *buf
, int len
, void *arg
)
5474 dump_bytes_io_t dbi
;
5480 #if defined(HAVE_LARGE_STACKS)
5481 dump_bytes_cb(&dbi
);
5484 * The vn_rdwr() call is performed in a taskq to ensure that there is
5485 * always enough stack space to write safely to the target filesystem.
5486 * The ZIO_TYPE_FREE threads are used because there can be a lot of
5487 * them and they are used in vdev_file.c for a similar purpose.
5489 spa_taskq_dispatch_sync(dmu_objset_spa(os
), ZIO_TYPE_FREE
,
5490 ZIO_TASKQ_ISSUE
, dump_bytes_cb
, &dbi
, TQ_SLEEP
);
5491 #endif /* HAVE_LARGE_STACKS */
5493 return (dbi
.dbi_err
);
5498 * zc_name name of snapshot to send
5499 * zc_cookie file descriptor to send stream to
5500 * zc_obj fromorigin flag (mutually exclusive with zc_fromobj)
5501 * zc_sendobj objsetid of snapshot to send
5502 * zc_fromobj objsetid of incremental fromsnap (may be zero)
5503 * zc_guid if set, estimate size of stream only. zc_cookie is ignored.
5504 * output size in zc_objset_type.
5505 * zc_flags lzc_send_flags
5508 * zc_objset_type estimated size, if zc_guid is set
5510 * NOTE: This is no longer the preferred interface, any new functionality
5511 * should be added to zfs_ioc_send_new() instead.
5514 zfs_ioc_send(zfs_cmd_t
*zc
)
5518 boolean_t estimate
= (zc
->zc_guid
!= 0);
5519 boolean_t embedok
= (zc
->zc_flags
& 0x1);
5520 boolean_t large_block_ok
= (zc
->zc_flags
& 0x2);
5521 boolean_t compressok
= (zc
->zc_flags
& 0x4);
5522 boolean_t rawok
= (zc
->zc_flags
& 0x8);
5523 boolean_t savedok
= (zc
->zc_flags
& 0x10);
5525 if (zc
->zc_obj
!= 0) {
5527 dsl_dataset_t
*tosnap
;
5529 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
5533 error
= dsl_dataset_hold_obj(dp
, zc
->zc_sendobj
, FTAG
, &tosnap
);
5535 dsl_pool_rele(dp
, FTAG
);
5539 if (dsl_dir_is_clone(tosnap
->ds_dir
))
5541 dsl_dir_phys(tosnap
->ds_dir
)->dd_origin_obj
;
5542 dsl_dataset_rele(tosnap
, FTAG
);
5543 dsl_pool_rele(dp
, FTAG
);
5548 dsl_dataset_t
*tosnap
;
5549 dsl_dataset_t
*fromsnap
= NULL
;
5551 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
5555 error
= dsl_dataset_hold_obj(dp
, zc
->zc_sendobj
,
5558 dsl_pool_rele(dp
, FTAG
);
5562 if (zc
->zc_fromobj
!= 0) {
5563 error
= dsl_dataset_hold_obj(dp
, zc
->zc_fromobj
,
5566 dsl_dataset_rele(tosnap
, FTAG
);
5567 dsl_pool_rele(dp
, FTAG
);
5572 error
= dmu_send_estimate_fast(tosnap
, fromsnap
, NULL
,
5573 compressok
|| rawok
, savedok
, &zc
->zc_objset_type
);
5575 if (fromsnap
!= NULL
)
5576 dsl_dataset_rele(fromsnap
, FTAG
);
5577 dsl_dataset_rele(tosnap
, FTAG
);
5578 dsl_pool_rele(dp
, FTAG
);
5581 dmu_send_outparams_t out
= {0};
5583 if ((fp
= zfs_file_get(zc
->zc_cookie
)) == NULL
)
5584 return (SET_ERROR(EBADF
));
5586 off
= zfs_file_off(fp
);
5587 out
.dso_outfunc
= dump_bytes
;
5589 out
.dso_dryrun
= B_FALSE
;
5590 error
= dmu_send_obj(zc
->zc_name
, zc
->zc_sendobj
,
5591 zc
->zc_fromobj
, embedok
, large_block_ok
, compressok
,
5592 rawok
, savedok
, zc
->zc_cookie
, &off
, &out
);
5601 * zc_name name of snapshot on which to report progress
5602 * zc_cookie file descriptor of send stream
5605 * zc_cookie number of bytes written in send stream thus far
5606 * zc_objset_type logical size of data traversed by send thus far
5609 zfs_ioc_send_progress(zfs_cmd_t
*zc
)
5613 dmu_sendstatus_t
*dsp
= NULL
;
5616 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
5620 error
= dsl_dataset_hold(dp
, zc
->zc_name
, FTAG
, &ds
);
5622 dsl_pool_rele(dp
, FTAG
);
5626 mutex_enter(&ds
->ds_sendstream_lock
);
5629 * Iterate over all the send streams currently active on this dataset.
5630 * If there's one which matches the specified file descriptor _and_ the
5631 * stream was started by the current process, return the progress of
5635 for (dsp
= list_head(&ds
->ds_sendstreams
); dsp
!= NULL
;
5636 dsp
= list_next(&ds
->ds_sendstreams
, dsp
)) {
5637 if (dsp
->dss_outfd
== zc
->zc_cookie
&&
5638 zfs_proc_is_caller(dsp
->dss_proc
))
5643 zc
->zc_cookie
= atomic_cas_64((volatile uint64_t *)dsp
->dss_off
,
5645 /* This is the closest thing we have to atomic_read_64. */
5646 zc
->zc_objset_type
= atomic_cas_64(&dsp
->dss_blocks
, 0, 0);
5648 error
= SET_ERROR(ENOENT
);
5651 mutex_exit(&ds
->ds_sendstream_lock
);
5652 dsl_dataset_rele(ds
, FTAG
);
5653 dsl_pool_rele(dp
, FTAG
);
5658 zfs_ioc_inject_fault(zfs_cmd_t
*zc
)
5662 error
= zio_inject_fault(zc
->zc_name
, (int)zc
->zc_guid
, &id
,
5663 &zc
->zc_inject_record
);
5666 zc
->zc_guid
= (uint64_t)id
;
5672 zfs_ioc_clear_fault(zfs_cmd_t
*zc
)
5674 return (zio_clear_fault((int)zc
->zc_guid
));
5678 zfs_ioc_inject_list_next(zfs_cmd_t
*zc
)
5680 int id
= (int)zc
->zc_guid
;
5683 error
= zio_inject_list_next(&id
, zc
->zc_name
, sizeof (zc
->zc_name
),
5684 &zc
->zc_inject_record
);
5692 zfs_ioc_error_log(zfs_cmd_t
*zc
)
5697 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
5700 error
= spa_get_errlog(spa
, (void *)(uintptr_t)zc
->zc_nvlist_dst
,
5701 &zc
->zc_nvlist_dst_size
);
5703 spa_close(spa
, FTAG
);
5709 zfs_ioc_clear(zfs_cmd_t
*zc
)
5716 * On zpool clear we also fix up missing slogs
5718 mutex_enter(&spa_namespace_lock
);
5719 spa
= spa_lookup(zc
->zc_name
);
5721 mutex_exit(&spa_namespace_lock
);
5722 return (SET_ERROR(EIO
));
5724 if (spa_get_log_state(spa
) == SPA_LOG_MISSING
) {
5725 /* we need to let spa_open/spa_load clear the chains */
5726 spa_set_log_state(spa
, SPA_LOG_CLEAR
);
5728 spa
->spa_last_open_failed
= 0;
5729 mutex_exit(&spa_namespace_lock
);
5731 if (zc
->zc_cookie
& ZPOOL_NO_REWIND
) {
5732 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
5735 nvlist_t
*config
= NULL
;
5737 if (zc
->zc_nvlist_src
== 0)
5738 return (SET_ERROR(EINVAL
));
5740 if ((error
= get_nvlist(zc
->zc_nvlist_src
,
5741 zc
->zc_nvlist_src_size
, zc
->zc_iflags
, &policy
)) == 0) {
5742 error
= spa_open_rewind(zc
->zc_name
, &spa
, FTAG
,
5744 if (config
!= NULL
) {
5747 if ((err
= put_nvlist(zc
, config
)) != 0)
5749 nvlist_free(config
);
5751 nvlist_free(policy
);
5759 * If multihost is enabled, resuming I/O is unsafe as another
5760 * host may have imported the pool.
5762 if (spa_multihost(spa
) && spa_suspended(spa
))
5763 return (SET_ERROR(EINVAL
));
5765 spa_vdev_state_enter(spa
, SCL_NONE
);
5767 if (zc
->zc_guid
== 0) {
5770 vd
= spa_lookup_by_guid(spa
, zc
->zc_guid
, B_TRUE
);
5772 error
= SET_ERROR(ENODEV
);
5773 (void) spa_vdev_state_exit(spa
, NULL
, error
);
5774 spa_close(spa
, FTAG
);
5779 vdev_clear(spa
, vd
);
5781 (void) spa_vdev_state_exit(spa
, spa_suspended(spa
) ?
5782 NULL
: spa
->spa_root_vdev
, 0);
5785 * Resume any suspended I/Os.
5787 if (zio_resume(spa
) != 0)
5788 error
= SET_ERROR(EIO
);
5790 spa_close(spa
, FTAG
);
5796 * Reopen all the vdevs associated with the pool.
5799 * "scrub_restart" -> when true and scrub is running, allow to restart
5800 * scrub as the side effect of the reopen (boolean).
5805 static const zfs_ioc_key_t zfs_keys_pool_reopen
[] = {
5806 {"scrub_restart", DATA_TYPE_BOOLEAN_VALUE
, ZK_OPTIONAL
},
5810 zfs_ioc_pool_reopen(const char *pool
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
5815 boolean_t rc
, scrub_restart
= B_TRUE
;
5818 error
= nvlist_lookup_boolean_value(innvl
,
5819 "scrub_restart", &rc
);
5824 error
= spa_open(pool
, &spa
, FTAG
);
5828 spa_vdev_state_enter(spa
, SCL_NONE
);
5831 * If the scrub_restart flag is B_FALSE and a scrub is already
5832 * in progress then set spa_scrub_reopen flag to B_TRUE so that
5833 * we don't restart the scrub as a side effect of the reopen.
5834 * Otherwise, let vdev_open() decided if a resilver is required.
5837 spa
->spa_scrub_reopen
= (!scrub_restart
&&
5838 dsl_scan_scrubbing(spa
->spa_dsl_pool
));
5839 vdev_reopen(spa
->spa_root_vdev
);
5840 spa
->spa_scrub_reopen
= B_FALSE
;
5842 (void) spa_vdev_state_exit(spa
, NULL
, 0);
5843 spa_close(spa
, FTAG
);
5849 * zc_name name of filesystem
5852 * zc_string name of conflicting snapshot, if there is one
5855 zfs_ioc_promote(zfs_cmd_t
*zc
)
5858 dsl_dataset_t
*ds
, *ods
;
5859 char origin
[ZFS_MAX_DATASET_NAME_LEN
];
5863 zc
->zc_name
[sizeof (zc
->zc_name
) - 1] = '\0';
5864 if (dataset_namecheck(zc
->zc_name
, NULL
, NULL
) != 0 ||
5865 strchr(zc
->zc_name
, '%'))
5866 return (SET_ERROR(EINVAL
));
5868 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
5872 error
= dsl_dataset_hold(dp
, zc
->zc_name
, FTAG
, &ds
);
5874 dsl_pool_rele(dp
, FTAG
);
5878 if (!dsl_dir_is_clone(ds
->ds_dir
)) {
5879 dsl_dataset_rele(ds
, FTAG
);
5880 dsl_pool_rele(dp
, FTAG
);
5881 return (SET_ERROR(EINVAL
));
5884 error
= dsl_dataset_hold_obj(dp
,
5885 dsl_dir_phys(ds
->ds_dir
)->dd_origin_obj
, FTAG
, &ods
);
5887 dsl_dataset_rele(ds
, FTAG
);
5888 dsl_pool_rele(dp
, FTAG
);
5892 dsl_dataset_name(ods
, origin
);
5893 dsl_dataset_rele(ods
, FTAG
);
5894 dsl_dataset_rele(ds
, FTAG
);
5895 dsl_pool_rele(dp
, FTAG
);
5898 * We don't need to unmount *all* the origin fs's snapshots, but
5901 cp
= strchr(origin
, '@');
5904 (void) dmu_objset_find(origin
,
5905 zfs_unmount_snap_cb
, NULL
, DS_FIND_SNAPSHOTS
);
5906 return (dsl_dataset_promote(zc
->zc_name
, zc
->zc_string
));
5910 * Retrieve a single {user|group|project}{used|quota}@... property.
5913 * zc_name name of filesystem
5914 * zc_objset_type zfs_userquota_prop_t
5915 * zc_value domain name (eg. "S-1-234-567-89")
5916 * zc_guid RID/UID/GID
5919 * zc_cookie property value
5922 zfs_ioc_userspace_one(zfs_cmd_t
*zc
)
5927 if (zc
->zc_objset_type
>= ZFS_NUM_USERQUOTA_PROPS
)
5928 return (SET_ERROR(EINVAL
));
5930 error
= zfsvfs_hold(zc
->zc_name
, FTAG
, &zfsvfs
, B_FALSE
);
5934 error
= zfs_userspace_one(zfsvfs
,
5935 zc
->zc_objset_type
, zc
->zc_value
, zc
->zc_guid
, &zc
->zc_cookie
);
5936 zfsvfs_rele(zfsvfs
, FTAG
);
5943 * zc_name name of filesystem
5944 * zc_cookie zap cursor
5945 * zc_objset_type zfs_userquota_prop_t
5946 * zc_nvlist_dst[_size] buffer to fill (not really an nvlist)
5949 * zc_nvlist_dst[_size] data buffer (array of zfs_useracct_t)
5950 * zc_cookie zap cursor
5953 zfs_ioc_userspace_many(zfs_cmd_t
*zc
)
5956 int bufsize
= zc
->zc_nvlist_dst_size
;
5959 return (SET_ERROR(ENOMEM
));
5961 int error
= zfsvfs_hold(zc
->zc_name
, FTAG
, &zfsvfs
, B_FALSE
);
5965 void *buf
= vmem_alloc(bufsize
, KM_SLEEP
);
5967 error
= zfs_userspace_many(zfsvfs
, zc
->zc_objset_type
, &zc
->zc_cookie
,
5968 buf
, &zc
->zc_nvlist_dst_size
);
5971 error
= xcopyout(buf
,
5972 (void *)(uintptr_t)zc
->zc_nvlist_dst
,
5973 zc
->zc_nvlist_dst_size
);
5975 vmem_free(buf
, bufsize
);
5976 zfsvfs_rele(zfsvfs
, FTAG
);
5983 * zc_name name of filesystem
5989 zfs_ioc_userspace_upgrade(zfs_cmd_t
*zc
)
5994 if (getzfsvfs(zc
->zc_name
, &zfsvfs
) == 0) {
5995 if (!dmu_objset_userused_enabled(zfsvfs
->z_os
)) {
5997 * If userused is not enabled, it may be because the
5998 * objset needs to be closed & reopened (to grow the
5999 * objset_phys_t). Suspend/resume the fs will do that.
6001 dsl_dataset_t
*ds
, *newds
;
6003 ds
= dmu_objset_ds(zfsvfs
->z_os
);
6004 error
= zfs_suspend_fs(zfsvfs
);
6006 dmu_objset_refresh_ownership(ds
, &newds
,
6008 error
= zfs_resume_fs(zfsvfs
, newds
);
6012 mutex_enter(&zfsvfs
->z_os
->os_upgrade_lock
);
6013 if (zfsvfs
->z_os
->os_upgrade_id
== 0) {
6014 /* clear potential error code and retry */
6015 zfsvfs
->z_os
->os_upgrade_status
= 0;
6016 mutex_exit(&zfsvfs
->z_os
->os_upgrade_lock
);
6018 dsl_pool_config_enter(
6019 dmu_objset_pool(zfsvfs
->z_os
), FTAG
);
6020 dmu_objset_userspace_upgrade(zfsvfs
->z_os
);
6021 dsl_pool_config_exit(
6022 dmu_objset_pool(zfsvfs
->z_os
), FTAG
);
6024 mutex_exit(&zfsvfs
->z_os
->os_upgrade_lock
);
6027 taskq_wait_id(zfsvfs
->z_os
->os_spa
->spa_upgrade_taskq
,
6028 zfsvfs
->z_os
->os_upgrade_id
);
6029 error
= zfsvfs
->z_os
->os_upgrade_status
;
6031 zfs_vfs_rele(zfsvfs
);
6035 /* XXX kind of reading contents without owning */
6036 error
= dmu_objset_hold_flags(zc
->zc_name
, B_TRUE
, FTAG
, &os
);
6040 mutex_enter(&os
->os_upgrade_lock
);
6041 if (os
->os_upgrade_id
== 0) {
6042 /* clear potential error code and retry */
6043 os
->os_upgrade_status
= 0;
6044 mutex_exit(&os
->os_upgrade_lock
);
6046 dmu_objset_userspace_upgrade(os
);
6048 mutex_exit(&os
->os_upgrade_lock
);
6051 dsl_pool_rele(dmu_objset_pool(os
), FTAG
);
6053 taskq_wait_id(os
->os_spa
->spa_upgrade_taskq
, os
->os_upgrade_id
);
6054 error
= os
->os_upgrade_status
;
6056 dsl_dataset_rele_flags(dmu_objset_ds(os
), DS_HOLD_FLAG_DECRYPT
,
6064 * zc_name name of filesystem
6070 zfs_ioc_id_quota_upgrade(zfs_cmd_t
*zc
)
6075 error
= dmu_objset_hold_flags(zc
->zc_name
, B_TRUE
, FTAG
, &os
);
6079 if (dmu_objset_userobjspace_upgradable(os
) ||
6080 dmu_objset_projectquota_upgradable(os
)) {
6081 mutex_enter(&os
->os_upgrade_lock
);
6082 if (os
->os_upgrade_id
== 0) {
6083 /* clear potential error code and retry */
6084 os
->os_upgrade_status
= 0;
6085 mutex_exit(&os
->os_upgrade_lock
);
6087 dmu_objset_id_quota_upgrade(os
);
6089 mutex_exit(&os
->os_upgrade_lock
);
6092 dsl_pool_rele(dmu_objset_pool(os
), FTAG
);
6094 taskq_wait_id(os
->os_spa
->spa_upgrade_taskq
, os
->os_upgrade_id
);
6095 error
= os
->os_upgrade_status
;
6097 dsl_pool_rele(dmu_objset_pool(os
), FTAG
);
6100 dsl_dataset_rele_flags(dmu_objset_ds(os
), DS_HOLD_FLAG_DECRYPT
, FTAG
);
6106 zfs_ioc_share(zfs_cmd_t
*zc
)
6108 return (SET_ERROR(ENOSYS
));
6113 * zc_name name of containing filesystem
6114 * zc_obj object # beyond which we want next in-use object #
6117 * zc_obj next in-use object #
6120 zfs_ioc_next_obj(zfs_cmd_t
*zc
)
6122 objset_t
*os
= NULL
;
6125 error
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
);
6129 error
= dmu_object_next(os
, &zc
->zc_obj
, B_FALSE
, 0);
6131 dmu_objset_rele(os
, FTAG
);
6137 * zc_name name of filesystem
6138 * zc_value prefix name for snapshot
6139 * zc_cleanup_fd cleanup-on-exit file descriptor for calling process
6142 * zc_value short name of new snapshot
6145 zfs_ioc_tmp_snapshot(zfs_cmd_t
*zc
)
6151 zfs_file_t
*fp
= zfs_onexit_fd_hold(zc
->zc_cleanup_fd
, &minor
);
6153 return (SET_ERROR(EBADF
));
6155 snap_name
= kmem_asprintf("%s-%016llx", zc
->zc_value
,
6156 (u_longlong_t
)ddi_get_lbolt64());
6157 hold_name
= kmem_asprintf("%%%s", zc
->zc_value
);
6159 int error
= dsl_dataset_snapshot_tmp(zc
->zc_name
, snap_name
, minor
,
6162 (void) strlcpy(zc
->zc_value
, snap_name
,
6163 sizeof (zc
->zc_value
));
6164 kmem_strfree(snap_name
);
6165 kmem_strfree(hold_name
);
6166 zfs_onexit_fd_rele(fp
);
6172 * zc_name name of "to" snapshot
6173 * zc_value name of "from" snapshot
6174 * zc_cookie file descriptor to write diff data on
6177 * dmu_diff_record_t's to the file descriptor
6180 zfs_ioc_diff(zfs_cmd_t
*zc
)
6186 if ((fp
= zfs_file_get(zc
->zc_cookie
)) == NULL
)
6187 return (SET_ERROR(EBADF
));
6189 off
= zfs_file_off(fp
);
6190 error
= dmu_diff(zc
->zc_name
, zc
->zc_value
, fp
, &off
);
6198 zfs_ioc_smb_acl(zfs_cmd_t
*zc
)
6200 return (SET_ERROR(ENOTSUP
));
6205 * "holds" -> { snapname -> holdname (string), ... }
6206 * (optional) "cleanup_fd" -> fd (int32)
6210 * snapname -> error value (int32)
6214 static const zfs_ioc_key_t zfs_keys_hold
[] = {
6215 {"holds", DATA_TYPE_NVLIST
, 0},
6216 {"cleanup_fd", DATA_TYPE_INT32
, ZK_OPTIONAL
},
6220 zfs_ioc_hold(const char *pool
, nvlist_t
*args
, nvlist_t
*errlist
)
6225 int cleanup_fd
= -1;
6228 zfs_file_t
*fp
= NULL
;
6230 holds
= fnvlist_lookup_nvlist(args
, "holds");
6232 /* make sure the user didn't pass us any invalid (empty) tags */
6233 for (pair
= nvlist_next_nvpair(holds
, NULL
); pair
!= NULL
;
6234 pair
= nvlist_next_nvpair(holds
, pair
)) {
6237 error
= nvpair_value_string(pair
, &htag
);
6239 return (SET_ERROR(error
));
6241 if (strlen(htag
) == 0)
6242 return (SET_ERROR(EINVAL
));
6245 if (nvlist_lookup_int32(args
, "cleanup_fd", &cleanup_fd
) == 0) {
6246 fp
= zfs_onexit_fd_hold(cleanup_fd
, &minor
);
6248 return (SET_ERROR(EBADF
));
6251 error
= dsl_dataset_user_hold(holds
, minor
, errlist
);
6253 ASSERT3U(minor
, !=, 0);
6254 zfs_onexit_fd_rele(fp
);
6256 return (SET_ERROR(error
));
6260 * innvl is not used.
6263 * holdname -> time added (uint64 seconds since epoch)
6267 static const zfs_ioc_key_t zfs_keys_get_holds
[] = {
6272 zfs_ioc_get_holds(const char *snapname
, nvlist_t
*args
, nvlist_t
*outnvl
)
6275 return (dsl_dataset_get_holds(snapname
, outnvl
));
6280 * snapname -> { holdname, ... }
6285 * snapname -> error value (int32)
6289 static const zfs_ioc_key_t zfs_keys_release
[] = {
6290 {"<snapname>...", DATA_TYPE_NVLIST
, ZK_WILDCARDLIST
},
6294 zfs_ioc_release(const char *pool
, nvlist_t
*holds
, nvlist_t
*errlist
)
6297 return (dsl_dataset_user_release(holds
, errlist
));
6302 * zc_guid flags (ZEVENT_NONBLOCK)
6303 * zc_cleanup_fd zevent file descriptor
6306 * zc_nvlist_dst next nvlist event
6307 * zc_cookie dropped events since last get
6310 zfs_ioc_events_next(zfs_cmd_t
*zc
)
6313 nvlist_t
*event
= NULL
;
6315 uint64_t dropped
= 0;
6318 zfs_file_t
*fp
= zfs_zevent_fd_hold(zc
->zc_cleanup_fd
, &minor
, &ze
);
6320 return (SET_ERROR(EBADF
));
6323 error
= zfs_zevent_next(ze
, &event
,
6324 &zc
->zc_nvlist_dst_size
, &dropped
);
6325 if (event
!= NULL
) {
6326 zc
->zc_cookie
= dropped
;
6327 error
= put_nvlist(zc
, event
);
6331 if (zc
->zc_guid
& ZEVENT_NONBLOCK
)
6334 if ((error
== 0) || (error
!= ENOENT
))
6337 error
= zfs_zevent_wait(ze
);
6342 zfs_zevent_fd_rele(fp
);
6349 * zc_cookie cleared events count
6352 zfs_ioc_events_clear(zfs_cmd_t
*zc
)
6356 zfs_zevent_drain_all(&count
);
6357 zc
->zc_cookie
= count
;
6364 * zc_guid eid | ZEVENT_SEEK_START | ZEVENT_SEEK_END
6365 * zc_cleanup zevent file descriptor
6368 zfs_ioc_events_seek(zfs_cmd_t
*zc
)
6374 zfs_file_t
*fp
= zfs_zevent_fd_hold(zc
->zc_cleanup_fd
, &minor
, &ze
);
6376 return (SET_ERROR(EBADF
));
6378 error
= zfs_zevent_seek(ze
, zc
->zc_guid
);
6379 zfs_zevent_fd_rele(fp
);
6386 * zc_name name of later filesystem or snapshot
6387 * zc_value full name of old snapshot or bookmark
6390 * zc_cookie space in bytes
6391 * zc_objset_type compressed space in bytes
6392 * zc_perm_action uncompressed space in bytes
6395 zfs_ioc_space_written(zfs_cmd_t
*zc
)
6401 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
6404 error
= dsl_dataset_hold(dp
, zc
->zc_name
, FTAG
, &new);
6406 dsl_pool_rele(dp
, FTAG
);
6409 if (strchr(zc
->zc_value
, '#') != NULL
) {
6410 zfs_bookmark_phys_t bmp
;
6411 error
= dsl_bookmark_lookup(dp
, zc
->zc_value
,
6414 error
= dsl_dataset_space_written_bookmark(&bmp
, new,
6416 &zc
->zc_objset_type
, &zc
->zc_perm_action
);
6420 error
= dsl_dataset_hold(dp
, zc
->zc_value
, FTAG
, &old
);
6423 error
= dsl_dataset_space_written(old
, new,
6425 &zc
->zc_objset_type
, &zc
->zc_perm_action
);
6426 dsl_dataset_rele(old
, FTAG
);
6429 dsl_dataset_rele(new, FTAG
);
6430 dsl_pool_rele(dp
, FTAG
);
6436 * "firstsnap" -> snapshot name
6440 * "used" -> space in bytes
6441 * "compressed" -> compressed space in bytes
6442 * "uncompressed" -> uncompressed space in bytes
6445 static const zfs_ioc_key_t zfs_keys_space_snaps
[] = {
6446 {"firstsnap", DATA_TYPE_STRING
, 0},
6450 zfs_ioc_space_snaps(const char *lastsnap
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
6454 dsl_dataset_t
*new, *old
;
6455 const char *firstsnap
;
6456 uint64_t used
, comp
, uncomp
;
6458 firstsnap
= fnvlist_lookup_string(innvl
, "firstsnap");
6460 error
= dsl_pool_hold(lastsnap
, FTAG
, &dp
);
6464 error
= dsl_dataset_hold(dp
, lastsnap
, FTAG
, &new);
6465 if (error
== 0 && !new->ds_is_snapshot
) {
6466 dsl_dataset_rele(new, FTAG
);
6467 error
= SET_ERROR(EINVAL
);
6470 dsl_pool_rele(dp
, FTAG
);
6473 error
= dsl_dataset_hold(dp
, firstsnap
, FTAG
, &old
);
6474 if (error
== 0 && !old
->ds_is_snapshot
) {
6475 dsl_dataset_rele(old
, FTAG
);
6476 error
= SET_ERROR(EINVAL
);
6479 dsl_dataset_rele(new, FTAG
);
6480 dsl_pool_rele(dp
, FTAG
);
6484 error
= dsl_dataset_space_wouldfree(old
, new, &used
, &comp
, &uncomp
);
6485 dsl_dataset_rele(old
, FTAG
);
6486 dsl_dataset_rele(new, FTAG
);
6487 dsl_pool_rele(dp
, FTAG
);
6488 fnvlist_add_uint64(outnvl
, "used", used
);
6489 fnvlist_add_uint64(outnvl
, "compressed", comp
);
6490 fnvlist_add_uint64(outnvl
, "uncompressed", uncomp
);
6496 * "fd" -> file descriptor to write stream to (int32)
6497 * (optional) "fromsnap" -> full snap name to send an incremental from
6498 * (optional) "largeblockok" -> (value ignored)
6499 * indicates that blocks > 128KB are permitted
6500 * (optional) "embedok" -> (value ignored)
6501 * presence indicates DRR_WRITE_EMBEDDED records are permitted
6502 * (optional) "compressok" -> (value ignored)
6503 * presence indicates compressed DRR_WRITE records are permitted
6504 * (optional) "rawok" -> (value ignored)
6505 * presence indicates raw encrypted records should be used.
6506 * (optional) "savedok" -> (value ignored)
6507 * presence indicates we should send a partially received snapshot
6508 * (optional) "resume_object" and "resume_offset" -> (uint64)
6509 * if present, resume send stream from specified object and offset.
6510 * (optional) "redactbook" -> (string)
6511 * if present, use this bookmark's redaction list to generate a redacted
6517 static const zfs_ioc_key_t zfs_keys_send_new
[] = {
6518 {"fd", DATA_TYPE_INT32
, 0},
6519 {"fromsnap", DATA_TYPE_STRING
, ZK_OPTIONAL
},
6520 {"largeblockok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6521 {"embedok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6522 {"compressok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6523 {"rawok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6524 {"savedok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6525 {"resume_object", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
6526 {"resume_offset", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
6527 {"redactbook", DATA_TYPE_STRING
, ZK_OPTIONAL
},
6531 zfs_ioc_send_new(const char *snapname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
6536 const char *fromname
= NULL
;
6539 boolean_t largeblockok
;
6541 boolean_t compressok
;
6544 uint64_t resumeobj
= 0;
6545 uint64_t resumeoff
= 0;
6546 const char *redactbook
= NULL
;
6548 fd
= fnvlist_lookup_int32(innvl
, "fd");
6550 (void) nvlist_lookup_string(innvl
, "fromsnap", &fromname
);
6552 largeblockok
= nvlist_exists(innvl
, "largeblockok");
6553 embedok
= nvlist_exists(innvl
, "embedok");
6554 compressok
= nvlist_exists(innvl
, "compressok");
6555 rawok
= nvlist_exists(innvl
, "rawok");
6556 savedok
= nvlist_exists(innvl
, "savedok");
6558 (void) nvlist_lookup_uint64(innvl
, "resume_object", &resumeobj
);
6559 (void) nvlist_lookup_uint64(innvl
, "resume_offset", &resumeoff
);
6561 (void) nvlist_lookup_string(innvl
, "redactbook", &redactbook
);
6563 if ((fp
= zfs_file_get(fd
)) == NULL
)
6564 return (SET_ERROR(EBADF
));
6566 off
= zfs_file_off(fp
);
6568 dmu_send_outparams_t out
= {0};
6569 out
.dso_outfunc
= dump_bytes
;
6571 out
.dso_dryrun
= B_FALSE
;
6572 error
= dmu_send(snapname
, fromname
, embedok
, largeblockok
,
6573 compressok
, rawok
, savedok
, resumeobj
, resumeoff
,
6574 redactbook
, fd
, &off
, &out
);
6581 send_space_sum(objset_t
*os
, void *buf
, int len
, void *arg
)
6583 (void) os
, (void) buf
;
6584 uint64_t *size
= arg
;
6591 * Determine approximately how large a zfs send stream will be -- the number
6592 * of bytes that will be written to the fd supplied to zfs_ioc_send_new().
6595 * (optional) "from" -> full snap or bookmark name to send an incremental
6597 * (optional) "largeblockok" -> (value ignored)
6598 * indicates that blocks > 128KB are permitted
6599 * (optional) "embedok" -> (value ignored)
6600 * presence indicates DRR_WRITE_EMBEDDED records are permitted
6601 * (optional) "compressok" -> (value ignored)
6602 * presence indicates compressed DRR_WRITE records are permitted
6603 * (optional) "rawok" -> (value ignored)
6604 * presence indicates raw encrypted records should be used.
6605 * (optional) "resume_object" and "resume_offset" -> (uint64)
6606 * if present, resume send stream from specified object and offset.
6607 * (optional) "fd" -> file descriptor to use as a cookie for progress
6612 * "space" -> bytes of space (uint64)
6615 static const zfs_ioc_key_t zfs_keys_send_space
[] = {
6616 {"from", DATA_TYPE_STRING
, ZK_OPTIONAL
},
6617 {"fromsnap", DATA_TYPE_STRING
, ZK_OPTIONAL
},
6618 {"largeblockok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6619 {"embedok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6620 {"compressok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6621 {"rawok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6622 {"fd", DATA_TYPE_INT32
, ZK_OPTIONAL
},
6623 {"redactbook", DATA_TYPE_STRING
, ZK_OPTIONAL
},
6624 {"resume_object", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
6625 {"resume_offset", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
6626 {"bytes", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
6630 zfs_ioc_send_space(const char *snapname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
6633 dsl_dataset_t
*tosnap
;
6634 dsl_dataset_t
*fromsnap
= NULL
;
6636 const char *fromname
= NULL
;
6637 const char *redactlist_book
= NULL
;
6638 boolean_t largeblockok
;
6640 boolean_t compressok
;
6644 boolean_t full_estimate
= B_FALSE
;
6645 uint64_t resumeobj
= 0;
6646 uint64_t resumeoff
= 0;
6647 uint64_t resume_bytes
= 0;
6649 zfs_bookmark_phys_t zbm
= {0};
6651 error
= dsl_pool_hold(snapname
, FTAG
, &dp
);
6655 error
= dsl_dataset_hold(dp
, snapname
, FTAG
, &tosnap
);
6657 dsl_pool_rele(dp
, FTAG
);
6660 (void) nvlist_lookup_int32(innvl
, "fd", &fd
);
6662 largeblockok
= nvlist_exists(innvl
, "largeblockok");
6663 embedok
= nvlist_exists(innvl
, "embedok");
6664 compressok
= nvlist_exists(innvl
, "compressok");
6665 rawok
= nvlist_exists(innvl
, "rawok");
6666 savedok
= nvlist_exists(innvl
, "savedok");
6667 boolean_t from
= (nvlist_lookup_string(innvl
, "from", &fromname
) == 0);
6668 boolean_t altbook
= (nvlist_lookup_string(innvl
, "redactbook",
6669 &redactlist_book
) == 0);
6671 (void) nvlist_lookup_uint64(innvl
, "resume_object", &resumeobj
);
6672 (void) nvlist_lookup_uint64(innvl
, "resume_offset", &resumeoff
);
6673 (void) nvlist_lookup_uint64(innvl
, "bytes", &resume_bytes
);
6676 full_estimate
= B_TRUE
;
6678 if (strchr(fromname
, '#')) {
6679 error
= dsl_bookmark_lookup(dp
, fromname
, tosnap
, &zbm
);
6682 * dsl_bookmark_lookup() will fail with EXDEV if
6683 * the from-bookmark and tosnap are at the same txg.
6684 * However, it's valid to do a send (and therefore,
6685 * a send estimate) from and to the same time point,
6686 * if the bookmark is redacted (the incremental send
6687 * can change what's redacted on the target). In
6688 * this case, dsl_bookmark_lookup() fills in zbm
6689 * but returns EXDEV. Ignore this error.
6691 if (error
== EXDEV
&& zbm
.zbm_redaction_obj
!= 0 &&
6693 dsl_dataset_phys(tosnap
)->ds_guid
)
6697 dsl_dataset_rele(tosnap
, FTAG
);
6698 dsl_pool_rele(dp
, FTAG
);
6701 if (zbm
.zbm_redaction_obj
!= 0 || !(zbm
.zbm_flags
&
6702 ZBM_FLAG_HAS_FBN
)) {
6703 full_estimate
= B_TRUE
;
6705 } else if (strchr(fromname
, '@')) {
6706 error
= dsl_dataset_hold(dp
, fromname
, FTAG
, &fromsnap
);
6708 dsl_dataset_rele(tosnap
, FTAG
);
6709 dsl_pool_rele(dp
, FTAG
);
6713 if (!dsl_dataset_is_before(tosnap
, fromsnap
, 0)) {
6714 full_estimate
= B_TRUE
;
6715 dsl_dataset_rele(fromsnap
, FTAG
);
6719 * from is not properly formatted as a snapshot or
6722 dsl_dataset_rele(tosnap
, FTAG
);
6723 dsl_pool_rele(dp
, FTAG
);
6724 return (SET_ERROR(EINVAL
));
6728 if (full_estimate
) {
6729 dmu_send_outparams_t out
= {0};
6731 out
.dso_outfunc
= send_space_sum
;
6732 out
.dso_arg
= &space
;
6733 out
.dso_dryrun
= B_TRUE
;
6735 * We have to release these holds so dmu_send can take them. It
6736 * will do all the error checking we need.
6738 dsl_dataset_rele(tosnap
, FTAG
);
6739 dsl_pool_rele(dp
, FTAG
);
6740 error
= dmu_send(snapname
, fromname
, embedok
, largeblockok
,
6741 compressok
, rawok
, savedok
, resumeobj
, resumeoff
,
6742 redactlist_book
, fd
, &off
, &out
);
6744 error
= dmu_send_estimate_fast(tosnap
, fromsnap
,
6745 (from
&& strchr(fromname
, '#') != NULL
? &zbm
: NULL
),
6746 compressok
|| rawok
, savedok
, &space
);
6747 space
-= resume_bytes
;
6748 if (fromsnap
!= NULL
)
6749 dsl_dataset_rele(fromsnap
, FTAG
);
6750 dsl_dataset_rele(tosnap
, FTAG
);
6751 dsl_pool_rele(dp
, FTAG
);
6754 fnvlist_add_uint64(outnvl
, "space", space
);
6760 * Sync the currently open TXG to disk for the specified pool.
6761 * This is somewhat similar to 'zfs_sync()'.
6762 * For cases that do not result in error this ioctl will wait for
6763 * the currently open TXG to commit before returning back to the caller.
6766 * "force" -> when true, force uberblock update even if there is no dirty data.
6767 * In addition this will cause the vdev configuration to be written
6768 * out including updating the zpool cache file. (boolean_t)
6773 static const zfs_ioc_key_t zfs_keys_pool_sync
[] = {
6774 {"force", DATA_TYPE_BOOLEAN_VALUE
, 0},
6778 zfs_ioc_pool_sync(const char *pool
, nvlist_t
*innvl
, nvlist_t
*onvl
)
6782 boolean_t rc
, force
= B_FALSE
;
6785 if ((err
= spa_open(pool
, &spa
, FTAG
)) != 0)
6789 err
= nvlist_lookup_boolean_value(innvl
, "force", &rc
);
6795 spa_config_enter(spa
, SCL_CONFIG
, FTAG
, RW_WRITER
);
6796 vdev_config_dirty(spa
->spa_root_vdev
);
6797 spa_config_exit(spa
, SCL_CONFIG
, FTAG
);
6799 txg_wait_synced(spa_get_dsl(spa
), 0);
6801 spa_close(spa
, FTAG
);
6807 * Load a user's wrapping key into the kernel.
6809 * "hidden_args" -> { "wkeydata" -> value }
6810 * raw uint8_t array of encryption wrapping key data (32 bytes)
6811 * (optional) "noop" -> (value ignored)
6812 * presence indicated key should only be verified, not loaded
6815 static const zfs_ioc_key_t zfs_keys_load_key
[] = {
6816 {"hidden_args", DATA_TYPE_NVLIST
, 0},
6817 {"noop", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6821 zfs_ioc_load_key(const char *dsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
6825 dsl_crypto_params_t
*dcp
= NULL
;
6826 nvlist_t
*hidden_args
;
6827 boolean_t noop
= nvlist_exists(innvl
, "noop");
6829 if (strchr(dsname
, '@') != NULL
|| strchr(dsname
, '%') != NULL
) {
6830 ret
= SET_ERROR(EINVAL
);
6834 hidden_args
= fnvlist_lookup_nvlist(innvl
, ZPOOL_HIDDEN_ARGS
);
6836 ret
= dsl_crypto_params_create_nvlist(DCP_CMD_NONE
, NULL
,
6841 ret
= spa_keystore_load_wkey(dsname
, dcp
, noop
);
6845 dsl_crypto_params_free(dcp
, noop
);
6850 dsl_crypto_params_free(dcp
, B_TRUE
);
6855 * Unload a user's wrapping key from the kernel.
6856 * Both innvl and outnvl are unused.
6858 static const zfs_ioc_key_t zfs_keys_unload_key
[] = {
6863 zfs_ioc_unload_key(const char *dsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
6865 (void) innvl
, (void) outnvl
;
6868 if (strchr(dsname
, '@') != NULL
|| strchr(dsname
, '%') != NULL
) {
6869 ret
= (SET_ERROR(EINVAL
));
6873 ret
= spa_keystore_unload_wkey(dsname
);
6882 * Changes a user's wrapping key used to decrypt a dataset. The keyformat,
6883 * keylocation, pbkdf2salt, and pbkdf2iters properties can also be specified
6884 * here to change how the key is derived in userspace.
6887 * "hidden_args" (optional) -> { "wkeydata" -> value }
6888 * raw uint8_t array of new encryption wrapping key data (32 bytes)
6889 * "props" (optional) -> { prop -> value }
6894 static const zfs_ioc_key_t zfs_keys_change_key
[] = {
6895 {"crypt_cmd", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
6896 {"hidden_args", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
6897 {"props", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
6901 zfs_ioc_change_key(const char *dsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
6905 uint64_t cmd
= DCP_CMD_NONE
;
6906 dsl_crypto_params_t
*dcp
= NULL
;
6907 nvlist_t
*args
= NULL
, *hidden_args
= NULL
;
6909 if (strchr(dsname
, '@') != NULL
|| strchr(dsname
, '%') != NULL
) {
6910 ret
= (SET_ERROR(EINVAL
));
6914 (void) nvlist_lookup_uint64(innvl
, "crypt_cmd", &cmd
);
6915 (void) nvlist_lookup_nvlist(innvl
, "props", &args
);
6916 (void) nvlist_lookup_nvlist(innvl
, ZPOOL_HIDDEN_ARGS
, &hidden_args
);
6918 ret
= dsl_crypto_params_create_nvlist(cmd
, args
, hidden_args
, &dcp
);
6922 ret
= spa_keystore_change_key(dsname
, dcp
);
6926 dsl_crypto_params_free(dcp
, B_FALSE
);
6931 dsl_crypto_params_free(dcp
, B_TRUE
);
6935 static zfs_ioc_vec_t zfs_ioc_vec
[ZFS_IOC_LAST
- ZFS_IOC_FIRST
];
6938 zfs_ioctl_register_legacy(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
,
6939 zfs_secpolicy_func_t
*secpolicy
, zfs_ioc_namecheck_t namecheck
,
6940 boolean_t log_history
, zfs_ioc_poolcheck_t pool_check
)
6942 zfs_ioc_vec_t
*vec
= &zfs_ioc_vec
[ioc
- ZFS_IOC_FIRST
];
6944 ASSERT3U(ioc
, >=, ZFS_IOC_FIRST
);
6945 ASSERT3U(ioc
, <, ZFS_IOC_LAST
);
6946 ASSERT3P(vec
->zvec_legacy_func
, ==, NULL
);
6947 ASSERT3P(vec
->zvec_func
, ==, NULL
);
6949 vec
->zvec_legacy_func
= func
;
6950 vec
->zvec_secpolicy
= secpolicy
;
6951 vec
->zvec_namecheck
= namecheck
;
6952 vec
->zvec_allow_log
= log_history
;
6953 vec
->zvec_pool_check
= pool_check
;
6957 * See the block comment at the beginning of this file for details on
6958 * each argument to this function.
6961 zfs_ioctl_register(const char *name
, zfs_ioc_t ioc
, zfs_ioc_func_t
*func
,
6962 zfs_secpolicy_func_t
*secpolicy
, zfs_ioc_namecheck_t namecheck
,
6963 zfs_ioc_poolcheck_t pool_check
, boolean_t smush_outnvlist
,
6964 boolean_t allow_log
, const zfs_ioc_key_t
*nvl_keys
, size_t num_keys
)
6966 zfs_ioc_vec_t
*vec
= &zfs_ioc_vec
[ioc
- ZFS_IOC_FIRST
];
6968 ASSERT3U(ioc
, >=, ZFS_IOC_FIRST
);
6969 ASSERT3U(ioc
, <, ZFS_IOC_LAST
);
6970 ASSERT3P(vec
->zvec_legacy_func
, ==, NULL
);
6971 ASSERT3P(vec
->zvec_func
, ==, NULL
);
6973 /* if we are logging, the name must be valid */
6974 ASSERT(!allow_log
|| namecheck
!= NO_NAME
);
6976 vec
->zvec_name
= name
;
6977 vec
->zvec_func
= func
;
6978 vec
->zvec_secpolicy
= secpolicy
;
6979 vec
->zvec_namecheck
= namecheck
;
6980 vec
->zvec_pool_check
= pool_check
;
6981 vec
->zvec_smush_outnvlist
= smush_outnvlist
;
6982 vec
->zvec_allow_log
= allow_log
;
6983 vec
->zvec_nvl_keys
= nvl_keys
;
6984 vec
->zvec_nvl_key_count
= num_keys
;
6988 zfs_ioctl_register_pool(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
,
6989 zfs_secpolicy_func_t
*secpolicy
, boolean_t log_history
,
6990 zfs_ioc_poolcheck_t pool_check
)
6992 zfs_ioctl_register_legacy(ioc
, func
, secpolicy
,
6993 POOL_NAME
, log_history
, pool_check
);
6997 zfs_ioctl_register_dataset_nolog(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
,
6998 zfs_secpolicy_func_t
*secpolicy
, zfs_ioc_poolcheck_t pool_check
)
7000 zfs_ioctl_register_legacy(ioc
, func
, secpolicy
,
7001 DATASET_NAME
, B_FALSE
, pool_check
);
7005 zfs_ioctl_register_pool_modify(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
)
7007 zfs_ioctl_register_legacy(ioc
, func
, zfs_secpolicy_config
,
7008 POOL_NAME
, B_TRUE
, POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
);
7012 zfs_ioctl_register_pool_meta(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
,
7013 zfs_secpolicy_func_t
*secpolicy
)
7015 zfs_ioctl_register_legacy(ioc
, func
, secpolicy
,
7016 NO_NAME
, B_FALSE
, POOL_CHECK_NONE
);
7020 zfs_ioctl_register_dataset_read_secpolicy(zfs_ioc_t ioc
,
7021 zfs_ioc_legacy_func_t
*func
, zfs_secpolicy_func_t
*secpolicy
)
7023 zfs_ioctl_register_legacy(ioc
, func
, secpolicy
,
7024 DATASET_NAME
, B_FALSE
, POOL_CHECK_SUSPENDED
);
7028 zfs_ioctl_register_dataset_read(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
)
7030 zfs_ioctl_register_dataset_read_secpolicy(ioc
, func
,
7031 zfs_secpolicy_read
);
7035 zfs_ioctl_register_dataset_modify(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
,
7036 zfs_secpolicy_func_t
*secpolicy
)
7038 zfs_ioctl_register_legacy(ioc
, func
, secpolicy
,
7039 DATASET_NAME
, B_TRUE
, POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
);
7043 zfs_ioctl_init(void)
7045 zfs_ioctl_register("snapshot", ZFS_IOC_SNAPSHOT
,
7046 zfs_ioc_snapshot
, zfs_secpolicy_snapshot
, POOL_NAME
,
7047 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7048 zfs_keys_snapshot
, ARRAY_SIZE(zfs_keys_snapshot
));
7050 zfs_ioctl_register("log_history", ZFS_IOC_LOG_HISTORY
,
7051 zfs_ioc_log_history
, zfs_secpolicy_log_history
, NO_NAME
,
7052 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_FALSE
,
7053 zfs_keys_log_history
, ARRAY_SIZE(zfs_keys_log_history
));
7055 zfs_ioctl_register("space_snaps", ZFS_IOC_SPACE_SNAPS
,
7056 zfs_ioc_space_snaps
, zfs_secpolicy_read
, DATASET_NAME
,
7057 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
,
7058 zfs_keys_space_snaps
, ARRAY_SIZE(zfs_keys_space_snaps
));
7060 zfs_ioctl_register("send", ZFS_IOC_SEND_NEW
,
7061 zfs_ioc_send_new
, zfs_secpolicy_send_new
, DATASET_NAME
,
7062 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
,
7063 zfs_keys_send_new
, ARRAY_SIZE(zfs_keys_send_new
));
7065 zfs_ioctl_register("send_space", ZFS_IOC_SEND_SPACE
,
7066 zfs_ioc_send_space
, zfs_secpolicy_read
, DATASET_NAME
,
7067 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
,
7068 zfs_keys_send_space
, ARRAY_SIZE(zfs_keys_send_space
));
7070 zfs_ioctl_register("create", ZFS_IOC_CREATE
,
7071 zfs_ioc_create
, zfs_secpolicy_create_clone
, DATASET_NAME
,
7072 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7073 zfs_keys_create
, ARRAY_SIZE(zfs_keys_create
));
7075 zfs_ioctl_register("clone", ZFS_IOC_CLONE
,
7076 zfs_ioc_clone
, zfs_secpolicy_create_clone
, DATASET_NAME
,
7077 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7078 zfs_keys_clone
, ARRAY_SIZE(zfs_keys_clone
));
7080 zfs_ioctl_register("remap", ZFS_IOC_REMAP
,
7081 zfs_ioc_remap
, zfs_secpolicy_none
, DATASET_NAME
,
7082 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_TRUE
,
7083 zfs_keys_remap
, ARRAY_SIZE(zfs_keys_remap
));
7085 zfs_ioctl_register("destroy_snaps", ZFS_IOC_DESTROY_SNAPS
,
7086 zfs_ioc_destroy_snaps
, zfs_secpolicy_destroy_snaps
, POOL_NAME
,
7087 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7088 zfs_keys_destroy_snaps
, ARRAY_SIZE(zfs_keys_destroy_snaps
));
7090 zfs_ioctl_register("hold", ZFS_IOC_HOLD
,
7091 zfs_ioc_hold
, zfs_secpolicy_hold
, POOL_NAME
,
7092 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7093 zfs_keys_hold
, ARRAY_SIZE(zfs_keys_hold
));
7094 zfs_ioctl_register("release", ZFS_IOC_RELEASE
,
7095 zfs_ioc_release
, zfs_secpolicy_release
, POOL_NAME
,
7096 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7097 zfs_keys_release
, ARRAY_SIZE(zfs_keys_release
));
7099 zfs_ioctl_register("get_holds", ZFS_IOC_GET_HOLDS
,
7100 zfs_ioc_get_holds
, zfs_secpolicy_read
, DATASET_NAME
,
7101 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
,
7102 zfs_keys_get_holds
, ARRAY_SIZE(zfs_keys_get_holds
));
7104 zfs_ioctl_register("rollback", ZFS_IOC_ROLLBACK
,
7105 zfs_ioc_rollback
, zfs_secpolicy_rollback
, DATASET_NAME
,
7106 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_TRUE
,
7107 zfs_keys_rollback
, ARRAY_SIZE(zfs_keys_rollback
));
7109 zfs_ioctl_register("bookmark", ZFS_IOC_BOOKMARK
,
7110 zfs_ioc_bookmark
, zfs_secpolicy_bookmark
, POOL_NAME
,
7111 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7112 zfs_keys_bookmark
, ARRAY_SIZE(zfs_keys_bookmark
));
7114 zfs_ioctl_register("get_bookmarks", ZFS_IOC_GET_BOOKMARKS
,
7115 zfs_ioc_get_bookmarks
, zfs_secpolicy_read
, DATASET_NAME
,
7116 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
,
7117 zfs_keys_get_bookmarks
, ARRAY_SIZE(zfs_keys_get_bookmarks
));
7119 zfs_ioctl_register("get_bookmark_props", ZFS_IOC_GET_BOOKMARK_PROPS
,
7120 zfs_ioc_get_bookmark_props
, zfs_secpolicy_read
, ENTITY_NAME
,
7121 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
, zfs_keys_get_bookmark_props
,
7122 ARRAY_SIZE(zfs_keys_get_bookmark_props
));
7124 zfs_ioctl_register("destroy_bookmarks", ZFS_IOC_DESTROY_BOOKMARKS
,
7125 zfs_ioc_destroy_bookmarks
, zfs_secpolicy_destroy_bookmarks
,
7127 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7128 zfs_keys_destroy_bookmarks
,
7129 ARRAY_SIZE(zfs_keys_destroy_bookmarks
));
7131 zfs_ioctl_register("receive", ZFS_IOC_RECV_NEW
,
7132 zfs_ioc_recv_new
, zfs_secpolicy_recv
, DATASET_NAME
,
7133 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7134 zfs_keys_recv_new
, ARRAY_SIZE(zfs_keys_recv_new
));
7135 zfs_ioctl_register("load-key", ZFS_IOC_LOAD_KEY
,
7136 zfs_ioc_load_key
, zfs_secpolicy_load_key
,
7137 DATASET_NAME
, POOL_CHECK_SUSPENDED
, B_TRUE
, B_TRUE
,
7138 zfs_keys_load_key
, ARRAY_SIZE(zfs_keys_load_key
));
7139 zfs_ioctl_register("unload-key", ZFS_IOC_UNLOAD_KEY
,
7140 zfs_ioc_unload_key
, zfs_secpolicy_load_key
,
7141 DATASET_NAME
, POOL_CHECK_SUSPENDED
, B_TRUE
, B_TRUE
,
7142 zfs_keys_unload_key
, ARRAY_SIZE(zfs_keys_unload_key
));
7143 zfs_ioctl_register("change-key", ZFS_IOC_CHANGE_KEY
,
7144 zfs_ioc_change_key
, zfs_secpolicy_change_key
,
7145 DATASET_NAME
, POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
,
7146 B_TRUE
, B_TRUE
, zfs_keys_change_key
,
7147 ARRAY_SIZE(zfs_keys_change_key
));
7149 zfs_ioctl_register("sync", ZFS_IOC_POOL_SYNC
,
7150 zfs_ioc_pool_sync
, zfs_secpolicy_none
, POOL_NAME
,
7151 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_FALSE
,
7152 zfs_keys_pool_sync
, ARRAY_SIZE(zfs_keys_pool_sync
));
7153 zfs_ioctl_register("reopen", ZFS_IOC_POOL_REOPEN
, zfs_ioc_pool_reopen
,
7154 zfs_secpolicy_config
, POOL_NAME
, POOL_CHECK_SUSPENDED
, B_TRUE
,
7155 B_TRUE
, zfs_keys_pool_reopen
, ARRAY_SIZE(zfs_keys_pool_reopen
));
7157 zfs_ioctl_register("channel_program", ZFS_IOC_CHANNEL_PROGRAM
,
7158 zfs_ioc_channel_program
, zfs_secpolicy_config
,
7159 POOL_NAME
, POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
,
7160 B_TRUE
, zfs_keys_channel_program
,
7161 ARRAY_SIZE(zfs_keys_channel_program
));
7163 zfs_ioctl_register("redact", ZFS_IOC_REDACT
,
7164 zfs_ioc_redact
, zfs_secpolicy_config
, DATASET_NAME
,
7165 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7166 zfs_keys_redact
, ARRAY_SIZE(zfs_keys_redact
));
7168 zfs_ioctl_register("zpool_checkpoint", ZFS_IOC_POOL_CHECKPOINT
,
7169 zfs_ioc_pool_checkpoint
, zfs_secpolicy_config
, POOL_NAME
,
7170 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7171 zfs_keys_pool_checkpoint
, ARRAY_SIZE(zfs_keys_pool_checkpoint
));
7173 zfs_ioctl_register("zpool_discard_checkpoint",
7174 ZFS_IOC_POOL_DISCARD_CHECKPOINT
, zfs_ioc_pool_discard_checkpoint
,
7175 zfs_secpolicy_config
, POOL_NAME
,
7176 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7177 zfs_keys_pool_discard_checkpoint
,
7178 ARRAY_SIZE(zfs_keys_pool_discard_checkpoint
));
7180 zfs_ioctl_register("initialize", ZFS_IOC_POOL_INITIALIZE
,
7181 zfs_ioc_pool_initialize
, zfs_secpolicy_config
, POOL_NAME
,
7182 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7183 zfs_keys_pool_initialize
, ARRAY_SIZE(zfs_keys_pool_initialize
));
7185 zfs_ioctl_register("trim", ZFS_IOC_POOL_TRIM
,
7186 zfs_ioc_pool_trim
, zfs_secpolicy_config
, POOL_NAME
,
7187 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
7188 zfs_keys_pool_trim
, ARRAY_SIZE(zfs_keys_pool_trim
));
7190 zfs_ioctl_register("wait", ZFS_IOC_WAIT
,
7191 zfs_ioc_wait
, zfs_secpolicy_none
, POOL_NAME
,
7192 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_FALSE
,
7193 zfs_keys_pool_wait
, ARRAY_SIZE(zfs_keys_pool_wait
));
7195 zfs_ioctl_register("wait_fs", ZFS_IOC_WAIT_FS
,
7196 zfs_ioc_wait_fs
, zfs_secpolicy_none
, DATASET_NAME
,
7197 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_FALSE
,
7198 zfs_keys_fs_wait
, ARRAY_SIZE(zfs_keys_fs_wait
));
7200 zfs_ioctl_register("set_bootenv", ZFS_IOC_SET_BOOTENV
,
7201 zfs_ioc_set_bootenv
, zfs_secpolicy_config
, POOL_NAME
,
7202 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_TRUE
,
7203 zfs_keys_set_bootenv
, ARRAY_SIZE(zfs_keys_set_bootenv
));
7205 zfs_ioctl_register("get_bootenv", ZFS_IOC_GET_BOOTENV
,
7206 zfs_ioc_get_bootenv
, zfs_secpolicy_none
, POOL_NAME
,
7207 POOL_CHECK_SUSPENDED
, B_FALSE
, B_TRUE
,
7208 zfs_keys_get_bootenv
, ARRAY_SIZE(zfs_keys_get_bootenv
));
7210 zfs_ioctl_register("zpool_vdev_get_props", ZFS_IOC_VDEV_GET_PROPS
,
7211 zfs_ioc_vdev_get_props
, zfs_secpolicy_read
, POOL_NAME
,
7212 POOL_CHECK_NONE
, B_FALSE
, B_FALSE
, zfs_keys_vdev_get_props
,
7213 ARRAY_SIZE(zfs_keys_vdev_get_props
));
7215 zfs_ioctl_register("zpool_vdev_set_props", ZFS_IOC_VDEV_SET_PROPS
,
7216 zfs_ioc_vdev_set_props
, zfs_secpolicy_config
, POOL_NAME
,
7217 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_FALSE
,
7218 zfs_keys_vdev_set_props
, ARRAY_SIZE(zfs_keys_vdev_set_props
));
7220 /* IOCTLS that use the legacy function signature */
7222 zfs_ioctl_register_legacy(ZFS_IOC_POOL_FREEZE
, zfs_ioc_pool_freeze
,
7223 zfs_secpolicy_config
, NO_NAME
, B_FALSE
, POOL_CHECK_READONLY
);
7225 zfs_ioctl_register_pool(ZFS_IOC_POOL_CREATE
, zfs_ioc_pool_create
,
7226 zfs_secpolicy_config
, B_TRUE
, POOL_CHECK_NONE
);
7227 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_SCAN
,
7229 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_UPGRADE
,
7230 zfs_ioc_pool_upgrade
);
7231 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_ADD
,
7233 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_REMOVE
,
7234 zfs_ioc_vdev_remove
);
7235 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SET_STATE
,
7236 zfs_ioc_vdev_set_state
);
7237 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_ATTACH
,
7238 zfs_ioc_vdev_attach
);
7239 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_DETACH
,
7240 zfs_ioc_vdev_detach
);
7241 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SETPATH
,
7242 zfs_ioc_vdev_setpath
);
7243 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SETFRU
,
7244 zfs_ioc_vdev_setfru
);
7245 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_SET_PROPS
,
7246 zfs_ioc_pool_set_props
);
7247 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SPLIT
,
7248 zfs_ioc_vdev_split
);
7249 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_REGUID
,
7250 zfs_ioc_pool_reguid
);
7252 zfs_ioctl_register_pool_meta(ZFS_IOC_POOL_CONFIGS
,
7253 zfs_ioc_pool_configs
, zfs_secpolicy_none
);
7254 zfs_ioctl_register_pool_meta(ZFS_IOC_POOL_TRYIMPORT
,
7255 zfs_ioc_pool_tryimport
, zfs_secpolicy_config
);
7256 zfs_ioctl_register_pool_meta(ZFS_IOC_INJECT_FAULT
,
7257 zfs_ioc_inject_fault
, zfs_secpolicy_inject
);
7258 zfs_ioctl_register_pool_meta(ZFS_IOC_CLEAR_FAULT
,
7259 zfs_ioc_clear_fault
, zfs_secpolicy_inject
);
7260 zfs_ioctl_register_pool_meta(ZFS_IOC_INJECT_LIST_NEXT
,
7261 zfs_ioc_inject_list_next
, zfs_secpolicy_inject
);
7264 * pool destroy, and export don't log the history as part of
7265 * zfsdev_ioctl, but rather zfs_ioc_pool_export
7266 * does the logging of those commands.
7268 zfs_ioctl_register_pool(ZFS_IOC_POOL_DESTROY
, zfs_ioc_pool_destroy
,
7269 zfs_secpolicy_config
, B_FALSE
, POOL_CHECK_SUSPENDED
);
7270 zfs_ioctl_register_pool(ZFS_IOC_POOL_EXPORT
, zfs_ioc_pool_export
,
7271 zfs_secpolicy_config
, B_FALSE
, POOL_CHECK_SUSPENDED
);
7273 zfs_ioctl_register_pool(ZFS_IOC_POOL_STATS
, zfs_ioc_pool_stats
,
7274 zfs_secpolicy_read
, B_FALSE
, POOL_CHECK_NONE
);
7275 zfs_ioctl_register_pool(ZFS_IOC_POOL_GET_PROPS
, zfs_ioc_pool_get_props
,
7276 zfs_secpolicy_read
, B_FALSE
, POOL_CHECK_NONE
);
7278 zfs_ioctl_register_pool(ZFS_IOC_ERROR_LOG
, zfs_ioc_error_log
,
7279 zfs_secpolicy_inject
, B_FALSE
, POOL_CHECK_SUSPENDED
);
7280 zfs_ioctl_register_pool(ZFS_IOC_DSOBJ_TO_DSNAME
,
7281 zfs_ioc_dsobj_to_dsname
,
7282 zfs_secpolicy_diff
, B_FALSE
, POOL_CHECK_SUSPENDED
);
7283 zfs_ioctl_register_pool(ZFS_IOC_POOL_GET_HISTORY
,
7284 zfs_ioc_pool_get_history
,
7285 zfs_secpolicy_config
, B_FALSE
, POOL_CHECK_SUSPENDED
);
7287 zfs_ioctl_register_pool(ZFS_IOC_POOL_IMPORT
, zfs_ioc_pool_import
,
7288 zfs_secpolicy_config
, B_TRUE
, POOL_CHECK_NONE
);
7290 zfs_ioctl_register_pool(ZFS_IOC_CLEAR
, zfs_ioc_clear
,
7291 zfs_secpolicy_config
, B_TRUE
, POOL_CHECK_READONLY
);
7293 zfs_ioctl_register_dataset_read(ZFS_IOC_SPACE_WRITTEN
,
7294 zfs_ioc_space_written
);
7295 zfs_ioctl_register_dataset_read(ZFS_IOC_OBJSET_RECVD_PROPS
,
7296 zfs_ioc_objset_recvd_props
);
7297 zfs_ioctl_register_dataset_read(ZFS_IOC_NEXT_OBJ
,
7299 zfs_ioctl_register_dataset_read(ZFS_IOC_GET_FSACL
,
7301 zfs_ioctl_register_dataset_read(ZFS_IOC_OBJSET_STATS
,
7302 zfs_ioc_objset_stats
);
7303 zfs_ioctl_register_dataset_read(ZFS_IOC_OBJSET_ZPLPROPS
,
7304 zfs_ioc_objset_zplprops
);
7305 zfs_ioctl_register_dataset_read(ZFS_IOC_DATASET_LIST_NEXT
,
7306 zfs_ioc_dataset_list_next
);
7307 zfs_ioctl_register_dataset_read(ZFS_IOC_SNAPSHOT_LIST_NEXT
,
7308 zfs_ioc_snapshot_list_next
);
7309 zfs_ioctl_register_dataset_read(ZFS_IOC_SEND_PROGRESS
,
7310 zfs_ioc_send_progress
);
7312 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_DIFF
,
7313 zfs_ioc_diff
, zfs_secpolicy_diff
);
7314 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_OBJ_TO_STATS
,
7315 zfs_ioc_obj_to_stats
, zfs_secpolicy_diff
);
7316 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_OBJ_TO_PATH
,
7317 zfs_ioc_obj_to_path
, zfs_secpolicy_diff
);
7318 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_USERSPACE_ONE
,
7319 zfs_ioc_userspace_one
, zfs_secpolicy_userspace_one
);
7320 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_USERSPACE_MANY
,
7321 zfs_ioc_userspace_many
, zfs_secpolicy_userspace_many
);
7322 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_SEND
,
7323 zfs_ioc_send
, zfs_secpolicy_send
);
7325 zfs_ioctl_register_dataset_modify(ZFS_IOC_SET_PROP
, zfs_ioc_set_prop
,
7326 zfs_secpolicy_none
);
7327 zfs_ioctl_register_dataset_modify(ZFS_IOC_DESTROY
, zfs_ioc_destroy
,
7328 zfs_secpolicy_destroy
);
7329 zfs_ioctl_register_dataset_modify(ZFS_IOC_RENAME
, zfs_ioc_rename
,
7330 zfs_secpolicy_rename
);
7331 zfs_ioctl_register_dataset_modify(ZFS_IOC_RECV
, zfs_ioc_recv
,
7332 zfs_secpolicy_recv
);
7333 zfs_ioctl_register_dataset_modify(ZFS_IOC_PROMOTE
, zfs_ioc_promote
,
7334 zfs_secpolicy_promote
);
7335 zfs_ioctl_register_dataset_modify(ZFS_IOC_INHERIT_PROP
,
7336 zfs_ioc_inherit_prop
, zfs_secpolicy_inherit_prop
);
7337 zfs_ioctl_register_dataset_modify(ZFS_IOC_SET_FSACL
, zfs_ioc_set_fsacl
,
7338 zfs_secpolicy_set_fsacl
);
7340 zfs_ioctl_register_dataset_nolog(ZFS_IOC_SHARE
, zfs_ioc_share
,
7341 zfs_secpolicy_share
, POOL_CHECK_NONE
);
7342 zfs_ioctl_register_dataset_nolog(ZFS_IOC_SMB_ACL
, zfs_ioc_smb_acl
,
7343 zfs_secpolicy_smb_acl
, POOL_CHECK_NONE
);
7344 zfs_ioctl_register_dataset_nolog(ZFS_IOC_USERSPACE_UPGRADE
,
7345 zfs_ioc_userspace_upgrade
, zfs_secpolicy_userspace_upgrade
,
7346 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
);
7347 zfs_ioctl_register_dataset_nolog(ZFS_IOC_TMP_SNAPSHOT
,
7348 zfs_ioc_tmp_snapshot
, zfs_secpolicy_tmp_snapshot
,
7349 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
);
7351 zfs_ioctl_register_legacy(ZFS_IOC_EVENTS_NEXT
, zfs_ioc_events_next
,
7352 zfs_secpolicy_config
, NO_NAME
, B_FALSE
, POOL_CHECK_NONE
);
7353 zfs_ioctl_register_legacy(ZFS_IOC_EVENTS_CLEAR
, zfs_ioc_events_clear
,
7354 zfs_secpolicy_config
, NO_NAME
, B_FALSE
, POOL_CHECK_NONE
);
7355 zfs_ioctl_register_legacy(ZFS_IOC_EVENTS_SEEK
, zfs_ioc_events_seek
,
7356 zfs_secpolicy_config
, NO_NAME
, B_FALSE
, POOL_CHECK_NONE
);
7358 zfs_ioctl_init_os();
7362 * Verify that for non-legacy ioctls the input nvlist
7363 * pairs match against the expected input.
7365 * Possible errors are:
7366 * ZFS_ERR_IOC_ARG_UNAVAIL An unrecognized nvpair was encountered
7367 * ZFS_ERR_IOC_ARG_REQUIRED A required nvpair is missing
7368 * ZFS_ERR_IOC_ARG_BADTYPE Invalid type for nvpair
7371 zfs_check_input_nvpairs(nvlist_t
*innvl
, const zfs_ioc_vec_t
*vec
)
7373 const zfs_ioc_key_t
*nvl_keys
= vec
->zvec_nvl_keys
;
7374 boolean_t required_keys_found
= B_FALSE
;
7377 * examine each input pair
7379 for (nvpair_t
*pair
= nvlist_next_nvpair(innvl
, NULL
);
7380 pair
!= NULL
; pair
= nvlist_next_nvpair(innvl
, pair
)) {
7381 const char *name
= nvpair_name(pair
);
7382 data_type_t type
= nvpair_type(pair
);
7383 boolean_t identified
= B_FALSE
;
7386 * check pair against the documented names and type
7388 for (int k
= 0; k
< vec
->zvec_nvl_key_count
; k
++) {
7389 /* if not a wild card name, check for an exact match */
7390 if ((nvl_keys
[k
].zkey_flags
& ZK_WILDCARDLIST
) == 0 &&
7391 strcmp(nvl_keys
[k
].zkey_name
, name
) != 0)
7394 identified
= B_TRUE
;
7396 if (nvl_keys
[k
].zkey_type
!= DATA_TYPE_ANY
&&
7397 nvl_keys
[k
].zkey_type
!= type
) {
7398 return (SET_ERROR(ZFS_ERR_IOC_ARG_BADTYPE
));
7401 if (nvl_keys
[k
].zkey_flags
& ZK_OPTIONAL
)
7404 required_keys_found
= B_TRUE
;
7408 /* allow an 'optional' key, everything else is invalid */
7410 (strcmp(name
, "optional") != 0 ||
7411 type
!= DATA_TYPE_NVLIST
)) {
7412 return (SET_ERROR(ZFS_ERR_IOC_ARG_UNAVAIL
));
7416 /* verify that all required keys were found */
7417 for (int k
= 0; k
< vec
->zvec_nvl_key_count
; k
++) {
7418 if (nvl_keys
[k
].zkey_flags
& ZK_OPTIONAL
)
7421 if (nvl_keys
[k
].zkey_flags
& ZK_WILDCARDLIST
) {
7422 /* at least one non-optional key is expected here */
7423 if (!required_keys_found
)
7424 return (SET_ERROR(ZFS_ERR_IOC_ARG_REQUIRED
));
7428 if (!nvlist_exists(innvl
, nvl_keys
[k
].zkey_name
))
7429 return (SET_ERROR(ZFS_ERR_IOC_ARG_REQUIRED
));
7436 pool_status_check(const char *name
, zfs_ioc_namecheck_t type
,
7437 zfs_ioc_poolcheck_t check
)
7442 ASSERT(type
== POOL_NAME
|| type
== DATASET_NAME
||
7443 type
== ENTITY_NAME
);
7445 if (check
& POOL_CHECK_NONE
)
7448 error
= spa_open(name
, &spa
, FTAG
);
7450 if ((check
& POOL_CHECK_SUSPENDED
) && spa_suspended(spa
))
7451 error
= SET_ERROR(EAGAIN
);
7452 else if ((check
& POOL_CHECK_READONLY
) && !spa_writeable(spa
))
7453 error
= SET_ERROR(EROFS
);
7454 spa_close(spa
, FTAG
);
7460 zfsdev_getminor(zfs_file_t
*fp
, minor_t
*minorp
)
7462 zfsdev_state_t
*zs
, *fpd
;
7464 ASSERT(!MUTEX_HELD(&zfsdev_state_lock
));
7466 fpd
= zfs_file_private(fp
);
7468 return (SET_ERROR(EBADF
));
7470 mutex_enter(&zfsdev_state_lock
);
7472 for (zs
= &zfsdev_state_listhead
; zs
!= NULL
; zs
= zs
->zs_next
) {
7474 if (zs
->zs_minor
== -1)
7478 *minorp
= fpd
->zs_minor
;
7479 mutex_exit(&zfsdev_state_lock
);
7484 mutex_exit(&zfsdev_state_lock
);
7486 return (SET_ERROR(EBADF
));
7490 zfsdev_get_state(minor_t minor
, enum zfsdev_state_type which
)
7494 for (zs
= &zfsdev_state_listhead
; zs
!= NULL
; zs
= zs
->zs_next
) {
7495 if (zs
->zs_minor
== minor
) {
7499 return (zs
->zs_onexit
);
7501 return (zs
->zs_zevent
);
7512 * Find a free minor number. The zfsdev_state_list is expected to
7513 * be short since it is only a list of currently open file handles.
7516 zfsdev_minor_alloc(void)
7518 static minor_t last_minor
= 0;
7521 ASSERT(MUTEX_HELD(&zfsdev_state_lock
));
7523 for (m
= last_minor
+ 1; m
!= last_minor
; m
++) {
7524 if (m
> ZFSDEV_MAX_MINOR
)
7526 if (zfsdev_get_state(m
, ZST_ALL
) == NULL
) {
7536 zfsdev_state_init(void *priv
)
7538 zfsdev_state_t
*zs
, *zsprev
= NULL
;
7540 boolean_t newzs
= B_FALSE
;
7542 ASSERT(MUTEX_HELD(&zfsdev_state_lock
));
7544 minor
= zfsdev_minor_alloc();
7546 return (SET_ERROR(ENXIO
));
7548 for (zs
= &zfsdev_state_listhead
; zs
!= NULL
; zs
= zs
->zs_next
) {
7549 if (zs
->zs_minor
== -1)
7555 zs
= kmem_zalloc(sizeof (zfsdev_state_t
), KM_SLEEP
);
7559 zfsdev_private_set_state(priv
, zs
);
7561 zfs_onexit_init((zfs_onexit_t
**)&zs
->zs_onexit
);
7562 zfs_zevent_init((zfs_zevent_t
**)&zs
->zs_zevent
);
7565 * In order to provide for lock-free concurrent read access
7566 * to the minor list in zfsdev_get_state(), new entries
7567 * must be completely written before linking them into the
7568 * list whereas existing entries are already linked; the last
7569 * operation must be updating zs_minor (from -1 to the new
7573 zs
->zs_minor
= minor
;
7575 zsprev
->zs_next
= zs
;
7578 zs
->zs_minor
= minor
;
7585 zfsdev_state_destroy(void *priv
)
7587 zfsdev_state_t
*zs
= zfsdev_private_get_state(priv
);
7590 ASSERT3S(zs
->zs_minor
, >, 0);
7593 * The last reference to this zfsdev file descriptor is being dropped.
7594 * We don't have to worry about lookup grabbing this state object, and
7595 * zfsdev_state_init() will not try to reuse this object until it is
7596 * invalidated by setting zs_minor to -1. Invalidation must be done
7597 * last, with a memory barrier to ensure ordering. This lets us avoid
7598 * taking the global zfsdev state lock around destruction.
7600 zfs_onexit_destroy(zs
->zs_onexit
);
7601 zfs_zevent_destroy(zs
->zs_zevent
);
7602 zs
->zs_onexit
= NULL
;
7603 zs
->zs_zevent
= NULL
;
7609 zfsdev_ioctl_common(uint_t vecnum
, zfs_cmd_t
*zc
, int flag
)
7612 const zfs_ioc_vec_t
*vec
;
7613 char *saved_poolname
= NULL
;
7614 uint64_t max_nvlist_src_size
;
7615 size_t saved_poolname_len
= 0;
7616 nvlist_t
*innvl
= NULL
;
7617 fstrans_cookie_t cookie
;
7618 hrtime_t start_time
= gethrtime();
7622 if (vecnum
>= sizeof (zfs_ioc_vec
) / sizeof (zfs_ioc_vec
[0]))
7623 return (SET_ERROR(ZFS_ERR_IOC_CMD_UNAVAIL
));
7625 vec
= &zfs_ioc_vec
[vecnum
];
7628 * The registered ioctl list may be sparse, verify that either
7629 * a normal or legacy handler are registered.
7631 if (vec
->zvec_func
== NULL
&& vec
->zvec_legacy_func
== NULL
)
7632 return (SET_ERROR(ZFS_ERR_IOC_CMD_UNAVAIL
));
7634 zc
->zc_iflags
= flag
& FKIOCTL
;
7635 max_nvlist_src_size
= zfs_max_nvlist_src_size_os();
7636 if (zc
->zc_nvlist_src_size
> max_nvlist_src_size
) {
7638 * Make sure the user doesn't pass in an insane value for
7639 * zc_nvlist_src_size. We have to check, since we will end
7640 * up allocating that much memory inside of get_nvlist(). This
7641 * prevents a nefarious user from allocating tons of kernel
7644 * Also, we return EINVAL instead of ENOMEM here. The reason
7645 * being that returning ENOMEM from an ioctl() has a special
7646 * connotation; that the user's size value is too small and
7647 * needs to be expanded to hold the nvlist. See
7648 * zcmd_expand_dst_nvlist() for details.
7650 error
= SET_ERROR(EINVAL
); /* User's size too big */
7652 } else if (zc
->zc_nvlist_src_size
!= 0) {
7653 error
= get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
7654 zc
->zc_iflags
, &innvl
);
7660 * Ensure that all pool/dataset names are valid before we pass down to
7663 zc
->zc_name
[sizeof (zc
->zc_name
) - 1] = '\0';
7664 switch (vec
->zvec_namecheck
) {
7666 if (pool_namecheck(zc
->zc_name
, NULL
, NULL
) != 0)
7667 error
= SET_ERROR(EINVAL
);
7669 error
= pool_status_check(zc
->zc_name
,
7670 vec
->zvec_namecheck
, vec
->zvec_pool_check
);
7674 if (dataset_namecheck(zc
->zc_name
, NULL
, NULL
) != 0)
7675 error
= SET_ERROR(EINVAL
);
7677 error
= pool_status_check(zc
->zc_name
,
7678 vec
->zvec_namecheck
, vec
->zvec_pool_check
);
7682 if (entity_namecheck(zc
->zc_name
, NULL
, NULL
) != 0) {
7683 error
= SET_ERROR(EINVAL
);
7685 error
= pool_status_check(zc
->zc_name
,
7686 vec
->zvec_namecheck
, vec
->zvec_pool_check
);
7694 * Ensure that all input pairs are valid before we pass them down
7695 * to the lower layers.
7697 * The vectored functions can use fnvlist_lookup_{type} for any
7698 * required pairs since zfs_check_input_nvpairs() confirmed that
7699 * they exist and are of the correct type.
7701 if (error
== 0 && vec
->zvec_func
!= NULL
) {
7702 error
= zfs_check_input_nvpairs(innvl
, vec
);
7708 cookie
= spl_fstrans_mark();
7709 error
= vec
->zvec_secpolicy(zc
, innvl
, CRED());
7710 spl_fstrans_unmark(cookie
);
7716 /* legacy ioctls can modify zc_name */
7718 * Can't use kmem_strdup() as we might truncate the string and
7719 * kmem_strfree() would then free with incorrect size.
7721 saved_poolname_len
= strlen(zc
->zc_name
) + 1;
7722 saved_poolname
= kmem_alloc(saved_poolname_len
, KM_SLEEP
);
7724 strlcpy(saved_poolname
, zc
->zc_name
, saved_poolname_len
);
7725 saved_poolname
[strcspn(saved_poolname
, "/@#")] = '\0';
7727 if (vec
->zvec_func
!= NULL
) {
7731 nvlist_t
*lognv
= NULL
;
7733 ASSERT(vec
->zvec_legacy_func
== NULL
);
7736 * Add the innvl to the lognv before calling the func,
7737 * in case the func changes the innvl.
7739 if (vec
->zvec_allow_log
) {
7740 lognv
= fnvlist_alloc();
7741 fnvlist_add_string(lognv
, ZPOOL_HIST_IOCTL
,
7743 if (!nvlist_empty(innvl
)) {
7744 fnvlist_add_nvlist(lognv
, ZPOOL_HIST_INPUT_NVL
,
7749 outnvl
= fnvlist_alloc();
7750 cookie
= spl_fstrans_mark();
7751 error
= vec
->zvec_func(zc
->zc_name
, innvl
, outnvl
);
7752 spl_fstrans_unmark(cookie
);
7755 * Some commands can partially execute, modify state, and still
7756 * return an error. In these cases, attempt to record what
7760 (cmd
== ZFS_IOC_CHANNEL_PROGRAM
&& error
!= EINVAL
)) &&
7761 vec
->zvec_allow_log
&&
7762 spa_open(zc
->zc_name
, &spa
, FTAG
) == 0) {
7763 if (!nvlist_empty(outnvl
)) {
7764 size_t out_size
= fnvlist_size(outnvl
);
7765 if (out_size
> zfs_history_output_max
) {
7766 fnvlist_add_int64(lognv
,
7767 ZPOOL_HIST_OUTPUT_SIZE
, out_size
);
7769 fnvlist_add_nvlist(lognv
,
7770 ZPOOL_HIST_OUTPUT_NVL
, outnvl
);
7774 fnvlist_add_int64(lognv
, ZPOOL_HIST_ERRNO
,
7777 fnvlist_add_int64(lognv
, ZPOOL_HIST_ELAPSED_NS
,
7778 gethrtime() - start_time
);
7779 (void) spa_history_log_nvl(spa
, lognv
);
7780 spa_close(spa
, FTAG
);
7782 fnvlist_free(lognv
);
7784 if (!nvlist_empty(outnvl
) || zc
->zc_nvlist_dst_size
!= 0) {
7786 if (vec
->zvec_smush_outnvlist
) {
7787 smusherror
= nvlist_smush(outnvl
,
7788 zc
->zc_nvlist_dst_size
);
7790 if (smusherror
== 0)
7791 puterror
= put_nvlist(zc
, outnvl
);
7797 nvlist_free(outnvl
);
7799 cookie
= spl_fstrans_mark();
7800 error
= vec
->zvec_legacy_func(zc
);
7801 spl_fstrans_unmark(cookie
);
7806 if (error
== 0 && vec
->zvec_allow_log
) {
7807 char *s
= tsd_get(zfs_allow_log_key
);
7810 (void) tsd_set(zfs_allow_log_key
, kmem_strdup(saved_poolname
));
7812 if (saved_poolname
!= NULL
)
7813 kmem_free(saved_poolname
, saved_poolname_len
);
7823 if ((error
= zvol_init()) != 0)
7826 spa_init(SPA_MODE_READ
| SPA_MODE_WRITE
);
7831 mutex_init(&zfsdev_state_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
7832 zfsdev_state_listhead
.zs_minor
= -1;
7834 if ((error
= zfsdev_attach()) != 0)
7837 tsd_create(&zfs_fsyncer_key
, NULL
);
7838 tsd_create(&rrw_tsd_key
, rrw_tsd_destroy
);
7839 tsd_create(&zfs_allow_log_key
, zfs_allow_log_destroy
);
7853 zfsdev_state_t
*zs
, *zsnext
= NULL
;
7857 mutex_destroy(&zfsdev_state_lock
);
7859 for (zs
= &zfsdev_state_listhead
; zs
!= NULL
; zs
= zsnext
) {
7860 zsnext
= zs
->zs_next
;
7862 zfs_onexit_destroy(zs
->zs_onexit
);
7864 zfs_zevent_destroy(zs
->zs_zevent
);
7867 zfs_ereport_taskq_fini(); /* run before zfs_fini() on Linux */
7872 tsd_destroy(&zfs_fsyncer_key
);
7873 tsd_destroy(&rrw_tsd_key
);
7874 tsd_destroy(&zfs_allow_log_key
);
7877 ZFS_MODULE_PARAM(zfs
, zfs_
, max_nvlist_src_size
, U64
, ZMOD_RW
,
7878 "Maximum size in bytes allowed for src nvlist passed with ZFS ioctls");
7880 ZFS_MODULE_PARAM(zfs
, zfs_
, history_output_max
, U64
, ZMOD_RW
,
7881 "Maximum size in bytes of ZFS ioctl output that will be logged");