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 http://www.opensolaris.org/os/licensing.
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 * Portions Copyright 2012 Pawel Jakub Dawidek <pawel@dawidek.net>
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, 2018 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) 2017, loli10K <ezomori.nozomu@gmail.com>. All rights reserved.
37 * Copyright (c) 2017 Datto Inc. All rights reserved.
38 * Copyright 2017 RackTop Systems.
39 * Copyright (c) 2017 Open-E, Inc. All Rights Reserved.
45 * This file handles the ioctls to /dev/zfs, used for configuring ZFS storage
46 * pools and filesystems, e.g. with /sbin/zfs and /sbin/zpool.
48 * There are two ways that we handle ioctls: the legacy way where almost
49 * all of the logic is in the ioctl callback, and the new way where most
50 * of the marshalling is handled in the common entry point, zfsdev_ioctl().
52 * Non-legacy ioctls should be registered by calling
53 * zfs_ioctl_register() from zfs_ioctl_init(). The ioctl is invoked
54 * from userland by lzc_ioctl().
56 * The registration arguments are as follows:
59 * The name of the ioctl. This is used for history logging. If the
60 * ioctl returns successfully (the callback returns 0), and allow_log
61 * is true, then a history log entry will be recorded with the input &
62 * output nvlists. The log entry can be printed with "zpool history -i".
65 * The ioctl request number, which userland will pass to ioctl(2).
66 * We want newer versions of libzfs and libzfs_core to run against
67 * existing zfs kernel modules (i.e. a deferred reboot after an update).
68 * Therefore the ioctl numbers cannot change from release to release.
70 * zfs_secpolicy_func_t *secpolicy
71 * This function will be called before the zfs_ioc_func_t, to
72 * determine if this operation is permitted. It should return EPERM
73 * on failure, and 0 on success. Checks include determining if the
74 * dataset is visible in this zone, and if the user has either all
75 * zfs privileges in the zone (SYS_MOUNT), or has been granted permission
76 * to do this operation on this dataset with "zfs allow".
78 * zfs_ioc_namecheck_t namecheck
79 * This specifies what to expect in the zfs_cmd_t:zc_name -- a pool
80 * name, a dataset name, or nothing. If the name is not well-formed,
81 * the ioctl will fail and the callback will not be called.
82 * Therefore, the callback can assume that the name is well-formed
83 * (e.g. is null-terminated, doesn't have more than one '@' character,
84 * doesn't have invalid characters).
86 * zfs_ioc_poolcheck_t pool_check
87 * This specifies requirements on the pool state. If the pool does
88 * not meet them (is suspended or is readonly), the ioctl will fail
89 * and the callback will not be called. If any checks are specified
90 * (i.e. it is not POOL_CHECK_NONE), namecheck must not be NO_NAME.
91 * Multiple checks can be or-ed together (e.g. POOL_CHECK_SUSPENDED |
92 * POOL_CHECK_READONLY).
94 * zfs_ioc_key_t *nvl_keys
95 * The list of expected/allowable innvl input keys. This list is used
96 * to validate the nvlist input to the ioctl.
98 * boolean_t smush_outnvlist
99 * If smush_outnvlist is true, then the output is presumed to be a
100 * list of errors, and it will be "smushed" down to fit into the
101 * caller's buffer, by removing some entries and replacing them with a
102 * single "N_MORE_ERRORS" entry indicating how many were removed. See
103 * nvlist_smush() for details. If smush_outnvlist is false, and the
104 * outnvlist does not fit into the userland-provided buffer, then the
105 * ioctl will fail with ENOMEM.
107 * zfs_ioc_func_t *func
108 * The callback function that will perform the operation.
110 * The callback should return 0 on success, or an error number on
111 * failure. If the function fails, the userland ioctl will return -1,
112 * and errno will be set to the callback's return value. The callback
113 * will be called with the following arguments:
116 * The name of the pool or dataset to operate on, from
117 * zfs_cmd_t:zc_name. The 'namecheck' argument specifies the
118 * expected type (pool, dataset, or none).
121 * The input nvlist, deserialized from zfs_cmd_t:zc_nvlist_src. Or
122 * NULL if no input nvlist was provided. Changes to this nvlist are
123 * ignored. If the input nvlist could not be deserialized, the
124 * ioctl will fail and the callback will not be called.
127 * The output nvlist, initially empty. The callback can fill it in,
128 * and it will be returned to userland by serializing it into
129 * zfs_cmd_t:zc_nvlist_dst. If it is non-empty, and serialization
130 * fails (e.g. because the caller didn't supply a large enough
131 * buffer), then the overall ioctl will fail. See the
132 * 'smush_nvlist' argument above for additional behaviors.
134 * There are two typical uses of the output nvlist:
135 * - To return state, e.g. property values. In this case,
136 * smush_outnvlist should be false. If the buffer was not large
137 * enough, the caller will reallocate a larger buffer and try
140 * - To return multiple errors from an ioctl which makes on-disk
141 * changes. In this case, smush_outnvlist should be true.
142 * Ioctls which make on-disk modifications should generally not
143 * use the outnvl if they succeed, because the caller can not
144 * distinguish between the operation failing, and
145 * deserialization failing.
147 * IOCTL Interface Errors
149 * The following ioctl input errors can be returned:
150 * ZFS_ERR_IOC_CMD_UNAVAIL the ioctl number is not supported by kernel
151 * ZFS_ERR_IOC_ARG_UNAVAIL an input argument is not supported by kernel
152 * ZFS_ERR_IOC_ARG_REQUIRED a required input argument is missing
153 * ZFS_ERR_IOC_ARG_BADTYPE an input argument has an invalid type
156 #include <sys/types.h>
157 #include <sys/param.h>
158 #include <sys/errno.h>
160 #include <sys/file.h>
161 #include <sys/kmem.h>
162 #include <sys/cmn_err.h>
163 #include <sys/stat.h>
164 #include <sys/zfs_ioctl.h>
165 #include <sys/zfs_vfsops.h>
166 #include <sys/zfs_znode.h>
169 #include <sys/spa_impl.h>
170 #include <sys/vdev.h>
171 #include <sys/vdev_impl.h>
173 #include <sys/dsl_dir.h>
174 #include <sys/dsl_dataset.h>
175 #include <sys/dsl_prop.h>
176 #include <sys/dsl_deleg.h>
177 #include <sys/dmu_objset.h>
178 #include <sys/dmu_impl.h>
179 #include <sys/dmu_tx.h>
180 #include <sys/sunddi.h>
181 #include <sys/policy.h>
182 #include <sys/zone.h>
183 #include <sys/nvpair.h>
184 #include <sys/pathname.h>
186 #include <sys/fs/zfs.h>
187 #include <sys/zfs_ctldir.h>
188 #include <sys/zfs_dir.h>
189 #include <sys/zfs_onexit.h>
190 #include <sys/zvol.h>
191 #include <sys/dsl_scan.h>
192 #include <sys/fm/util.h>
193 #include <sys/dsl_crypt.h>
195 #include <sys/dmu_recv.h>
196 #include <sys/dmu_send.h>
197 #include <sys/dsl_destroy.h>
198 #include <sys/dsl_bookmark.h>
199 #include <sys/dsl_userhold.h>
200 #include <sys/zfeature.h>
202 #include <sys/zio_checksum.h>
203 #include <sys/vdev_removal.h>
204 #include <sys/zfs_sysfs.h>
205 #include <sys/vdev_impl.h>
206 #include <sys/vdev_initialize.h>
208 #include <linux/miscdevice.h>
209 #include <linux/slab.h>
211 #include "zfs_namecheck.h"
212 #include "zfs_prop.h"
213 #include "zfs_deleg.h"
214 #include "zfs_comutil.h"
216 #include <sys/lua/lua.h>
217 #include <sys/lua/lauxlib.h>
220 * Limit maximum nvlist size. We don't want users passing in insane values
221 * for zc->zc_nvlist_src_size, since we will need to allocate that much memory.
223 #define MAX_NVLIST_SRC_SIZE KMALLOC_MAX_SIZE
225 kmutex_t zfsdev_state_lock
;
226 zfsdev_state_t
*zfsdev_state_list
;
228 extern void zfs_init(void);
229 extern void zfs_fini(void);
231 uint_t zfs_fsyncer_key
;
232 extern uint_t rrw_tsd_key
;
233 static uint_t zfs_allow_log_key
;
235 typedef int zfs_ioc_legacy_func_t(zfs_cmd_t
*);
236 typedef int zfs_ioc_func_t(const char *, nvlist_t
*, nvlist_t
*);
237 typedef int zfs_secpolicy_func_t(zfs_cmd_t
*, nvlist_t
*, cred_t
*);
240 * IOC Keys are used to document and validate user->kernel interface inputs.
241 * See zfs_keys_recv_new for an example declaration. Any key name that is not
242 * listed will be rejected as input.
244 * The keyname 'optional' is always allowed, and must be an nvlist if present.
245 * Arguments which older kernels can safely ignore can be placed under the
248 * When adding new keys to an existing ioc for new functionality, consider:
249 * - adding an entry into zfs_sysfs.c zfs_features[] list
250 * - updating the libzfs_input_check.c test utility
252 * Note: in the ZK_WILDCARDLIST case, the name serves as documentation
253 * for the expected name (bookmark, snapshot, property, etc) but there
254 * is no validation in the preflight zfs_check_input_nvpairs() check.
257 ZK_OPTIONAL
= 1 << 0, /* pair is optional */
258 ZK_WILDCARDLIST
= 1 << 1, /* one or more unspecified key names */
261 /* DATA_TYPE_ANY is used when zkey_type can vary. */
262 #define DATA_TYPE_ANY DATA_TYPE_UNKNOWN
264 typedef struct zfs_ioc_key
{
265 const char *zkey_name
;
266 data_type_t zkey_type
;
267 ioc_key_flag_t zkey_flags
;
274 } zfs_ioc_namecheck_t
;
277 POOL_CHECK_NONE
= 1 << 0,
278 POOL_CHECK_SUSPENDED
= 1 << 1,
279 POOL_CHECK_READONLY
= 1 << 2,
280 } zfs_ioc_poolcheck_t
;
282 typedef struct zfs_ioc_vec
{
283 zfs_ioc_legacy_func_t
*zvec_legacy_func
;
284 zfs_ioc_func_t
*zvec_func
;
285 zfs_secpolicy_func_t
*zvec_secpolicy
;
286 zfs_ioc_namecheck_t zvec_namecheck
;
287 boolean_t zvec_allow_log
;
288 zfs_ioc_poolcheck_t zvec_pool_check
;
289 boolean_t zvec_smush_outnvlist
;
290 const char *zvec_name
;
291 const zfs_ioc_key_t
*zvec_nvl_keys
;
292 size_t zvec_nvl_key_count
;
295 /* This array is indexed by zfs_userquota_prop_t */
296 static const char *userquota_perms
[] = {
297 ZFS_DELEG_PERM_USERUSED
,
298 ZFS_DELEG_PERM_USERQUOTA
,
299 ZFS_DELEG_PERM_GROUPUSED
,
300 ZFS_DELEG_PERM_GROUPQUOTA
,
301 ZFS_DELEG_PERM_USEROBJUSED
,
302 ZFS_DELEG_PERM_USEROBJQUOTA
,
303 ZFS_DELEG_PERM_GROUPOBJUSED
,
304 ZFS_DELEG_PERM_GROUPOBJQUOTA
,
305 ZFS_DELEG_PERM_PROJECTUSED
,
306 ZFS_DELEG_PERM_PROJECTQUOTA
,
307 ZFS_DELEG_PERM_PROJECTOBJUSED
,
308 ZFS_DELEG_PERM_PROJECTOBJQUOTA
,
311 static int zfs_ioc_userspace_upgrade(zfs_cmd_t
*zc
);
312 static int zfs_ioc_id_quota_upgrade(zfs_cmd_t
*zc
);
313 static int zfs_check_settable(const char *name
, nvpair_t
*property
,
315 static int zfs_check_clearable(char *dataset
, nvlist_t
*props
,
317 static int zfs_fill_zplprops_root(uint64_t, nvlist_t
*, nvlist_t
*,
319 int zfs_set_prop_nvlist(const char *, zprop_source_t
, nvlist_t
*, nvlist_t
*);
320 static int get_nvlist(uint64_t nvl
, uint64_t size
, int iflag
, nvlist_t
**nvp
);
323 history_str_free(char *buf
)
325 kmem_free(buf
, HIS_MAX_RECORD_LEN
);
329 history_str_get(zfs_cmd_t
*zc
)
333 if (zc
->zc_history
== 0)
336 buf
= kmem_alloc(HIS_MAX_RECORD_LEN
, KM_SLEEP
);
337 if (copyinstr((void *)(uintptr_t)zc
->zc_history
,
338 buf
, HIS_MAX_RECORD_LEN
, NULL
) != 0) {
339 history_str_free(buf
);
343 buf
[HIS_MAX_RECORD_LEN
-1] = '\0';
349 * Check to see if the named dataset is currently defined as bootable
352 zfs_is_bootfs(const char *name
)
356 if (dmu_objset_hold(name
, FTAG
, &os
) == 0) {
358 ret
= (dmu_objset_id(os
) == spa_bootfs(dmu_objset_spa(os
)));
359 dmu_objset_rele(os
, FTAG
);
366 * Return non-zero if the spa version is less than requested version.
369 zfs_earlier_version(const char *name
, int version
)
373 if (spa_open(name
, &spa
, FTAG
) == 0) {
374 if (spa_version(spa
) < version
) {
375 spa_close(spa
, FTAG
);
378 spa_close(spa
, FTAG
);
384 * Return TRUE if the ZPL version is less than requested version.
387 zpl_earlier_version(const char *name
, int version
)
390 boolean_t rc
= B_TRUE
;
392 if (dmu_objset_hold(name
, FTAG
, &os
) == 0) {
395 if (dmu_objset_type(os
) != DMU_OST_ZFS
) {
396 dmu_objset_rele(os
, FTAG
);
399 /* XXX reading from non-owned objset */
400 if (zfs_get_zplprop(os
, ZFS_PROP_VERSION
, &zplversion
) == 0)
401 rc
= zplversion
< version
;
402 dmu_objset_rele(os
, FTAG
);
408 zfs_log_history(zfs_cmd_t
*zc
)
413 if ((buf
= history_str_get(zc
)) == NULL
)
416 if (spa_open(zc
->zc_name
, &spa
, FTAG
) == 0) {
417 if (spa_version(spa
) >= SPA_VERSION_ZPOOL_HISTORY
)
418 (void) spa_history_log(spa
, buf
);
419 spa_close(spa
, FTAG
);
421 history_str_free(buf
);
425 * Policy for top-level read operations (list pools). Requires no privileges,
426 * and can be used in the local zone, as there is no associated dataset.
430 zfs_secpolicy_none(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
436 * Policy for dataset read operations (list children, get statistics). Requires
437 * no privileges, but must be visible in the local zone.
441 zfs_secpolicy_read(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
443 if (INGLOBALZONE(curproc
) ||
444 zone_dataset_visible(zc
->zc_name
, NULL
))
447 return (SET_ERROR(ENOENT
));
451 zfs_dozonecheck_impl(const char *dataset
, uint64_t zoned
, cred_t
*cr
)
456 * The dataset must be visible by this zone -- check this first
457 * so they don't see EPERM on something they shouldn't know about.
459 if (!INGLOBALZONE(curproc
) &&
460 !zone_dataset_visible(dataset
, &writable
))
461 return (SET_ERROR(ENOENT
));
463 if (INGLOBALZONE(curproc
)) {
465 * If the fs is zoned, only root can access it from the
468 if (secpolicy_zfs(cr
) && zoned
)
469 return (SET_ERROR(EPERM
));
472 * If we are in a local zone, the 'zoned' property must be set.
475 return (SET_ERROR(EPERM
));
477 /* must be writable by this zone */
479 return (SET_ERROR(EPERM
));
485 zfs_dozonecheck(const char *dataset
, cred_t
*cr
)
489 if (dsl_prop_get_integer(dataset
, "zoned", &zoned
, NULL
))
490 return (SET_ERROR(ENOENT
));
492 return (zfs_dozonecheck_impl(dataset
, zoned
, cr
));
496 zfs_dozonecheck_ds(const char *dataset
, dsl_dataset_t
*ds
, cred_t
*cr
)
500 if (dsl_prop_get_int_ds(ds
, "zoned", &zoned
))
501 return (SET_ERROR(ENOENT
));
503 return (zfs_dozonecheck_impl(dataset
, zoned
, cr
));
507 zfs_secpolicy_write_perms_ds(const char *name
, dsl_dataset_t
*ds
,
508 const char *perm
, cred_t
*cr
)
512 error
= zfs_dozonecheck_ds(name
, ds
, cr
);
514 error
= secpolicy_zfs(cr
);
516 error
= dsl_deleg_access_impl(ds
, perm
, cr
);
522 zfs_secpolicy_write_perms(const char *name
, const char *perm
, cred_t
*cr
)
529 * First do a quick check for root in the global zone, which
530 * is allowed to do all write_perms. This ensures that zfs_ioc_*
531 * will get to handle nonexistent datasets.
533 if (INGLOBALZONE(curproc
) && secpolicy_zfs(cr
) == 0)
536 error
= dsl_pool_hold(name
, FTAG
, &dp
);
540 error
= dsl_dataset_hold(dp
, name
, FTAG
, &ds
);
542 dsl_pool_rele(dp
, FTAG
);
546 error
= zfs_secpolicy_write_perms_ds(name
, ds
, perm
, cr
);
548 dsl_dataset_rele(ds
, FTAG
);
549 dsl_pool_rele(dp
, FTAG
);
554 * Policy for setting the security label property.
556 * Returns 0 for success, non-zero for access and other errors.
559 zfs_set_slabel_policy(const char *name
, char *strval
, cred_t
*cr
)
562 char ds_hexsl
[MAXNAMELEN
];
563 bslabel_t ds_sl
, new_sl
;
564 boolean_t new_default
= FALSE
;
566 int needed_priv
= -1;
569 /* First get the existing dataset label. */
570 error
= dsl_prop_get(name
, zfs_prop_to_name(ZFS_PROP_MLSLABEL
),
571 1, sizeof (ds_hexsl
), &ds_hexsl
, NULL
);
573 return (SET_ERROR(EPERM
));
575 if (strcasecmp(strval
, ZFS_MLSLABEL_DEFAULT
) == 0)
578 /* The label must be translatable */
579 if (!new_default
&& (hexstr_to_label(strval
, &new_sl
) != 0))
580 return (SET_ERROR(EINVAL
));
583 * In a non-global zone, disallow attempts to set a label that
584 * doesn't match that of the zone; otherwise no other checks
587 if (!INGLOBALZONE(curproc
)) {
588 if (new_default
|| !blequal(&new_sl
, CR_SL(CRED())))
589 return (SET_ERROR(EPERM
));
594 * For global-zone datasets (i.e., those whose zoned property is
595 * "off", verify that the specified new label is valid for the
598 if (dsl_prop_get_integer(name
,
599 zfs_prop_to_name(ZFS_PROP_ZONED
), &zoned
, NULL
))
600 return (SET_ERROR(EPERM
));
602 if (zfs_check_global_label(name
, strval
) != 0)
603 return (SET_ERROR(EPERM
));
607 * If the existing dataset label is nondefault, check if the
608 * dataset is mounted (label cannot be changed while mounted).
609 * Get the zfsvfs_t; if there isn't one, then the dataset isn't
610 * mounted (or isn't a dataset, doesn't exist, ...).
612 if (strcasecmp(ds_hexsl
, ZFS_MLSLABEL_DEFAULT
) != 0) {
614 static char *setsl_tag
= "setsl_tag";
617 * Try to own the dataset; abort if there is any error,
618 * (e.g., already mounted, in use, or other error).
620 error
= dmu_objset_own(name
, DMU_OST_ZFS
, B_TRUE
, B_TRUE
,
623 return (SET_ERROR(EPERM
));
625 dmu_objset_disown(os
, B_TRUE
, setsl_tag
);
628 needed_priv
= PRIV_FILE_DOWNGRADE_SL
;
632 if (hexstr_to_label(strval
, &new_sl
) != 0)
633 return (SET_ERROR(EPERM
));
635 if (blstrictdom(&ds_sl
, &new_sl
))
636 needed_priv
= PRIV_FILE_DOWNGRADE_SL
;
637 else if (blstrictdom(&new_sl
, &ds_sl
))
638 needed_priv
= PRIV_FILE_UPGRADE_SL
;
640 /* dataset currently has a default label */
642 needed_priv
= PRIV_FILE_UPGRADE_SL
;
646 if (needed_priv
!= -1)
647 return (PRIV_POLICY(cr
, needed_priv
, B_FALSE
, EPERM
, NULL
));
650 return (SET_ERROR(ENOTSUP
));
651 #endif /* HAVE_MLSLABEL */
655 zfs_secpolicy_setprop(const char *dsname
, zfs_prop_t prop
, nvpair_t
*propval
,
661 * Check permissions for special properties.
668 * Disallow setting of 'zoned' from within a local zone.
670 if (!INGLOBALZONE(curproc
))
671 return (SET_ERROR(EPERM
));
675 case ZFS_PROP_FILESYSTEM_LIMIT
:
676 case ZFS_PROP_SNAPSHOT_LIMIT
:
677 if (!INGLOBALZONE(curproc
)) {
679 char setpoint
[ZFS_MAX_DATASET_NAME_LEN
];
681 * Unprivileged users are allowed to modify the
682 * limit on things *under* (ie. contained by)
683 * the thing they own.
685 if (dsl_prop_get_integer(dsname
, "zoned", &zoned
,
687 return (SET_ERROR(EPERM
));
688 if (!zoned
|| strlen(dsname
) <= strlen(setpoint
))
689 return (SET_ERROR(EPERM
));
693 case ZFS_PROP_MLSLABEL
:
694 if (!is_system_labeled())
695 return (SET_ERROR(EPERM
));
697 if (nvpair_value_string(propval
, &strval
) == 0) {
700 err
= zfs_set_slabel_policy(dsname
, strval
, CRED());
707 return (zfs_secpolicy_write_perms(dsname
, zfs_prop_to_name(prop
), cr
));
712 zfs_secpolicy_set_fsacl(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
716 error
= zfs_dozonecheck(zc
->zc_name
, cr
);
721 * permission to set permissions will be evaluated later in
722 * dsl_deleg_can_allow()
729 zfs_secpolicy_rollback(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
731 return (zfs_secpolicy_write_perms(zc
->zc_name
,
732 ZFS_DELEG_PERM_ROLLBACK
, cr
));
737 zfs_secpolicy_send(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
745 * Generate the current snapshot name from the given objsetid, then
746 * use that name for the secpolicy/zone checks.
748 cp
= strchr(zc
->zc_name
, '@');
750 return (SET_ERROR(EINVAL
));
751 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
755 error
= dsl_dataset_hold_obj(dp
, zc
->zc_sendobj
, FTAG
, &ds
);
757 dsl_pool_rele(dp
, FTAG
);
761 dsl_dataset_name(ds
, zc
->zc_name
);
763 error
= zfs_secpolicy_write_perms_ds(zc
->zc_name
, ds
,
764 ZFS_DELEG_PERM_SEND
, cr
);
765 dsl_dataset_rele(ds
, FTAG
);
766 dsl_pool_rele(dp
, FTAG
);
773 zfs_secpolicy_send_new(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
775 return (zfs_secpolicy_write_perms(zc
->zc_name
,
776 ZFS_DELEG_PERM_SEND
, cr
));
780 zfs_secpolicy_share(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
782 return (SET_ERROR(ENOTSUP
));
786 zfs_secpolicy_smb_acl(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
788 return (SET_ERROR(ENOTSUP
));
792 zfs_get_parent(const char *datasetname
, char *parent
, int parentsize
)
797 * Remove the @bla or /bla from the end of the name to get the parent.
799 (void) strncpy(parent
, datasetname
, parentsize
);
800 cp
= strrchr(parent
, '@');
804 cp
= strrchr(parent
, '/');
806 return (SET_ERROR(ENOENT
));
814 zfs_secpolicy_destroy_perms(const char *name
, cred_t
*cr
)
818 if ((error
= zfs_secpolicy_write_perms(name
,
819 ZFS_DELEG_PERM_MOUNT
, cr
)) != 0)
822 return (zfs_secpolicy_write_perms(name
, ZFS_DELEG_PERM_DESTROY
, cr
));
827 zfs_secpolicy_destroy(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
829 return (zfs_secpolicy_destroy_perms(zc
->zc_name
, cr
));
833 * Destroying snapshots with delegated permissions requires
834 * descendant mount and destroy permissions.
838 zfs_secpolicy_destroy_snaps(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
841 nvpair_t
*pair
, *nextpair
;
844 snaps
= fnvlist_lookup_nvlist(innvl
, "snaps");
846 for (pair
= nvlist_next_nvpair(snaps
, NULL
); pair
!= NULL
;
848 nextpair
= nvlist_next_nvpair(snaps
, pair
);
849 error
= zfs_secpolicy_destroy_perms(nvpair_name(pair
), cr
);
850 if (error
== ENOENT
) {
852 * Ignore any snapshots that don't exist (we consider
853 * them "already destroyed"). Remove the name from the
854 * nvl here in case the snapshot is created between
855 * now and when we try to destroy it (in which case
856 * we don't want to destroy it since we haven't
857 * checked for permission).
859 fnvlist_remove_nvpair(snaps
, pair
);
870 zfs_secpolicy_rename_perms(const char *from
, const char *to
, cred_t
*cr
)
872 char parentname
[ZFS_MAX_DATASET_NAME_LEN
];
875 if ((error
= zfs_secpolicy_write_perms(from
,
876 ZFS_DELEG_PERM_RENAME
, cr
)) != 0)
879 if ((error
= zfs_secpolicy_write_perms(from
,
880 ZFS_DELEG_PERM_MOUNT
, cr
)) != 0)
883 if ((error
= zfs_get_parent(to
, parentname
,
884 sizeof (parentname
))) != 0)
887 if ((error
= zfs_secpolicy_write_perms(parentname
,
888 ZFS_DELEG_PERM_CREATE
, cr
)) != 0)
891 if ((error
= zfs_secpolicy_write_perms(parentname
,
892 ZFS_DELEG_PERM_MOUNT
, cr
)) != 0)
900 zfs_secpolicy_rename(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
902 return (zfs_secpolicy_rename_perms(zc
->zc_name
, zc
->zc_value
, cr
));
907 zfs_secpolicy_promote(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
910 dsl_dataset_t
*clone
;
913 error
= zfs_secpolicy_write_perms(zc
->zc_name
,
914 ZFS_DELEG_PERM_PROMOTE
, cr
);
918 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
922 error
= dsl_dataset_hold(dp
, zc
->zc_name
, FTAG
, &clone
);
925 char parentname
[ZFS_MAX_DATASET_NAME_LEN
];
926 dsl_dataset_t
*origin
= NULL
;
930 error
= dsl_dataset_hold_obj(dd
->dd_pool
,
931 dsl_dir_phys(dd
)->dd_origin_obj
, FTAG
, &origin
);
933 dsl_dataset_rele(clone
, FTAG
);
934 dsl_pool_rele(dp
, FTAG
);
938 error
= zfs_secpolicy_write_perms_ds(zc
->zc_name
, clone
,
939 ZFS_DELEG_PERM_MOUNT
, cr
);
941 dsl_dataset_name(origin
, parentname
);
943 error
= zfs_secpolicy_write_perms_ds(parentname
, origin
,
944 ZFS_DELEG_PERM_PROMOTE
, cr
);
946 dsl_dataset_rele(clone
, FTAG
);
947 dsl_dataset_rele(origin
, FTAG
);
949 dsl_pool_rele(dp
, FTAG
);
955 zfs_secpolicy_recv(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
959 if ((error
= zfs_secpolicy_write_perms(zc
->zc_name
,
960 ZFS_DELEG_PERM_RECEIVE
, cr
)) != 0)
963 if ((error
= zfs_secpolicy_write_perms(zc
->zc_name
,
964 ZFS_DELEG_PERM_MOUNT
, cr
)) != 0)
967 return (zfs_secpolicy_write_perms(zc
->zc_name
,
968 ZFS_DELEG_PERM_CREATE
, cr
));
973 zfs_secpolicy_recv_new(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
975 return (zfs_secpolicy_recv(zc
, innvl
, cr
));
979 zfs_secpolicy_snapshot_perms(const char *name
, cred_t
*cr
)
981 return (zfs_secpolicy_write_perms(name
,
982 ZFS_DELEG_PERM_SNAPSHOT
, cr
));
986 * Check for permission to create each snapshot in the nvlist.
990 zfs_secpolicy_snapshot(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
996 snaps
= fnvlist_lookup_nvlist(innvl
, "snaps");
998 for (pair
= nvlist_next_nvpair(snaps
, NULL
); pair
!= NULL
;
999 pair
= nvlist_next_nvpair(snaps
, pair
)) {
1000 char *name
= nvpair_name(pair
);
1001 char *atp
= strchr(name
, '@');
1004 error
= SET_ERROR(EINVAL
);
1008 error
= zfs_secpolicy_snapshot_perms(name
, cr
);
1017 * Check for permission to create each bookmark in the nvlist.
1021 zfs_secpolicy_bookmark(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1025 for (nvpair_t
*pair
= nvlist_next_nvpair(innvl
, NULL
);
1026 pair
!= NULL
; pair
= nvlist_next_nvpair(innvl
, pair
)) {
1027 char *name
= nvpair_name(pair
);
1028 char *hashp
= strchr(name
, '#');
1030 if (hashp
== NULL
) {
1031 error
= SET_ERROR(EINVAL
);
1035 error
= zfs_secpolicy_write_perms(name
,
1036 ZFS_DELEG_PERM_BOOKMARK
, cr
);
1046 zfs_secpolicy_remap(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1048 return (zfs_secpolicy_write_perms(zc
->zc_name
,
1049 ZFS_DELEG_PERM_REMAP
, cr
));
1054 zfs_secpolicy_destroy_bookmarks(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1056 nvpair_t
*pair
, *nextpair
;
1059 for (pair
= nvlist_next_nvpair(innvl
, NULL
); pair
!= NULL
;
1061 char *name
= nvpair_name(pair
);
1062 char *hashp
= strchr(name
, '#');
1063 nextpair
= nvlist_next_nvpair(innvl
, pair
);
1065 if (hashp
== NULL
) {
1066 error
= SET_ERROR(EINVAL
);
1071 error
= zfs_secpolicy_write_perms(name
,
1072 ZFS_DELEG_PERM_DESTROY
, cr
);
1074 if (error
== ENOENT
) {
1076 * Ignore any filesystems that don't exist (we consider
1077 * their bookmarks "already destroyed"). Remove
1078 * the name from the nvl here in case the filesystem
1079 * is created between now and when we try to destroy
1080 * the bookmark (in which case we don't want to
1081 * destroy it since we haven't checked for permission).
1083 fnvlist_remove_nvpair(innvl
, pair
);
1095 zfs_secpolicy_log_history(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1098 * Even root must have a proper TSD so that we know what pool
1101 if (tsd_get(zfs_allow_log_key
) == NULL
)
1102 return (SET_ERROR(EPERM
));
1107 zfs_secpolicy_create_clone(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1109 char parentname
[ZFS_MAX_DATASET_NAME_LEN
];
1113 if ((error
= zfs_get_parent(zc
->zc_name
, parentname
,
1114 sizeof (parentname
))) != 0)
1117 if (nvlist_lookup_string(innvl
, "origin", &origin
) == 0 &&
1118 (error
= zfs_secpolicy_write_perms(origin
,
1119 ZFS_DELEG_PERM_CLONE
, cr
)) != 0)
1122 if ((error
= zfs_secpolicy_write_perms(parentname
,
1123 ZFS_DELEG_PERM_CREATE
, cr
)) != 0)
1126 return (zfs_secpolicy_write_perms(parentname
,
1127 ZFS_DELEG_PERM_MOUNT
, cr
));
1131 * Policy for pool operations - create/destroy pools, add vdevs, etc. Requires
1132 * SYS_CONFIG privilege, which is not available in a local zone.
1136 zfs_secpolicy_config(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1138 if (secpolicy_sys_config(cr
, B_FALSE
) != 0)
1139 return (SET_ERROR(EPERM
));
1145 * Policy for object to name lookups.
1149 zfs_secpolicy_diff(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1153 if ((error
= secpolicy_sys_config(cr
, B_FALSE
)) == 0)
1156 error
= zfs_secpolicy_write_perms(zc
->zc_name
, ZFS_DELEG_PERM_DIFF
, cr
);
1161 * Policy for fault injection. Requires all privileges.
1165 zfs_secpolicy_inject(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1167 return (secpolicy_zinject(cr
));
1172 zfs_secpolicy_inherit_prop(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1174 zfs_prop_t prop
= zfs_name_to_prop(zc
->zc_value
);
1176 if (prop
== ZPROP_INVAL
) {
1177 if (!zfs_prop_user(zc
->zc_value
))
1178 return (SET_ERROR(EINVAL
));
1179 return (zfs_secpolicy_write_perms(zc
->zc_name
,
1180 ZFS_DELEG_PERM_USERPROP
, cr
));
1182 return (zfs_secpolicy_setprop(zc
->zc_name
, prop
,
1188 zfs_secpolicy_userspace_one(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1190 int err
= zfs_secpolicy_read(zc
, innvl
, cr
);
1194 if (zc
->zc_objset_type
>= ZFS_NUM_USERQUOTA_PROPS
)
1195 return (SET_ERROR(EINVAL
));
1197 if (zc
->zc_value
[0] == 0) {
1199 * They are asking about a posix uid/gid. If it's
1200 * themself, allow it.
1202 if (zc
->zc_objset_type
== ZFS_PROP_USERUSED
||
1203 zc
->zc_objset_type
== ZFS_PROP_USERQUOTA
||
1204 zc
->zc_objset_type
== ZFS_PROP_USEROBJUSED
||
1205 zc
->zc_objset_type
== ZFS_PROP_USEROBJQUOTA
) {
1206 if (zc
->zc_guid
== crgetuid(cr
))
1208 } else if (zc
->zc_objset_type
== ZFS_PROP_GROUPUSED
||
1209 zc
->zc_objset_type
== ZFS_PROP_GROUPQUOTA
||
1210 zc
->zc_objset_type
== ZFS_PROP_GROUPOBJUSED
||
1211 zc
->zc_objset_type
== ZFS_PROP_GROUPOBJQUOTA
) {
1212 if (groupmember(zc
->zc_guid
, cr
))
1215 /* else is for project quota/used */
1218 return (zfs_secpolicy_write_perms(zc
->zc_name
,
1219 userquota_perms
[zc
->zc_objset_type
], cr
));
1223 zfs_secpolicy_userspace_many(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1225 int err
= zfs_secpolicy_read(zc
, innvl
, cr
);
1229 if (zc
->zc_objset_type
>= ZFS_NUM_USERQUOTA_PROPS
)
1230 return (SET_ERROR(EINVAL
));
1232 return (zfs_secpolicy_write_perms(zc
->zc_name
,
1233 userquota_perms
[zc
->zc_objset_type
], cr
));
1238 zfs_secpolicy_userspace_upgrade(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1240 return (zfs_secpolicy_setprop(zc
->zc_name
, ZFS_PROP_VERSION
,
1246 zfs_secpolicy_hold(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1252 holds
= fnvlist_lookup_nvlist(innvl
, "holds");
1254 for (pair
= nvlist_next_nvpair(holds
, NULL
); pair
!= NULL
;
1255 pair
= nvlist_next_nvpair(holds
, pair
)) {
1256 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
1257 error
= dmu_fsname(nvpair_name(pair
), fsname
);
1260 error
= zfs_secpolicy_write_perms(fsname
,
1261 ZFS_DELEG_PERM_HOLD
, cr
);
1270 zfs_secpolicy_release(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1275 for (pair
= nvlist_next_nvpair(innvl
, NULL
); pair
!= NULL
;
1276 pair
= nvlist_next_nvpair(innvl
, pair
)) {
1277 char fsname
[ZFS_MAX_DATASET_NAME_LEN
];
1278 error
= dmu_fsname(nvpair_name(pair
), fsname
);
1281 error
= zfs_secpolicy_write_perms(fsname
,
1282 ZFS_DELEG_PERM_RELEASE
, cr
);
1290 * Policy for allowing temporary snapshots to be taken or released
1293 zfs_secpolicy_tmp_snapshot(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1296 * A temporary snapshot is the same as a snapshot,
1297 * hold, destroy and release all rolled into one.
1298 * Delegated diff alone is sufficient that we allow this.
1302 if ((error
= zfs_secpolicy_write_perms(zc
->zc_name
,
1303 ZFS_DELEG_PERM_DIFF
, cr
)) == 0)
1306 error
= zfs_secpolicy_snapshot_perms(zc
->zc_name
, cr
);
1308 if (innvl
!= NULL
) {
1310 error
= zfs_secpolicy_hold(zc
, innvl
, cr
);
1312 error
= zfs_secpolicy_release(zc
, innvl
, cr
);
1314 error
= zfs_secpolicy_destroy(zc
, innvl
, cr
);
1320 zfs_secpolicy_load_key(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1322 return (zfs_secpolicy_write_perms(zc
->zc_name
,
1323 ZFS_DELEG_PERM_LOAD_KEY
, cr
));
1327 zfs_secpolicy_change_key(zfs_cmd_t
*zc
, nvlist_t
*innvl
, cred_t
*cr
)
1329 return (zfs_secpolicy_write_perms(zc
->zc_name
,
1330 ZFS_DELEG_PERM_CHANGE_KEY
, cr
));
1334 * Returns the nvlist as specified by the user in the zfs_cmd_t.
1337 get_nvlist(uint64_t nvl
, uint64_t size
, int iflag
, nvlist_t
**nvp
)
1341 nvlist_t
*list
= NULL
;
1344 * Read in and unpack the user-supplied nvlist.
1347 return (SET_ERROR(EINVAL
));
1349 packed
= vmem_alloc(size
, KM_SLEEP
);
1351 if ((error
= ddi_copyin((void *)(uintptr_t)nvl
, packed
, size
,
1353 vmem_free(packed
, size
);
1354 return (SET_ERROR(EFAULT
));
1357 if ((error
= nvlist_unpack(packed
, size
, &list
, 0)) != 0) {
1358 vmem_free(packed
, size
);
1362 vmem_free(packed
, size
);
1369 * Reduce the size of this nvlist until it can be serialized in 'max' bytes.
1370 * Entries will be removed from the end of the nvlist, and one int32 entry
1371 * named "N_MORE_ERRORS" will be added indicating how many entries were
1375 nvlist_smush(nvlist_t
*errors
, size_t max
)
1379 size
= fnvlist_size(errors
);
1382 nvpair_t
*more_errors
;
1386 return (SET_ERROR(ENOMEM
));
1388 fnvlist_add_int32(errors
, ZPROP_N_MORE_ERRORS
, 0);
1389 more_errors
= nvlist_prev_nvpair(errors
, NULL
);
1392 nvpair_t
*pair
= nvlist_prev_nvpair(errors
,
1394 fnvlist_remove_nvpair(errors
, pair
);
1396 size
= fnvlist_size(errors
);
1397 } while (size
> max
);
1399 fnvlist_remove_nvpair(errors
, more_errors
);
1400 fnvlist_add_int32(errors
, ZPROP_N_MORE_ERRORS
, n
);
1401 ASSERT3U(fnvlist_size(errors
), <=, max
);
1408 put_nvlist(zfs_cmd_t
*zc
, nvlist_t
*nvl
)
1410 char *packed
= NULL
;
1414 size
= fnvlist_size(nvl
);
1416 if (size
> zc
->zc_nvlist_dst_size
) {
1417 error
= SET_ERROR(ENOMEM
);
1419 packed
= fnvlist_pack(nvl
, &size
);
1420 if (ddi_copyout(packed
, (void *)(uintptr_t)zc
->zc_nvlist_dst
,
1421 size
, zc
->zc_iflags
) != 0)
1422 error
= SET_ERROR(EFAULT
);
1423 fnvlist_pack_free(packed
, size
);
1426 zc
->zc_nvlist_dst_size
= size
;
1427 zc
->zc_nvlist_dst_filled
= B_TRUE
;
1432 getzfsvfs_impl(objset_t
*os
, zfsvfs_t
**zfvp
)
1435 if (dmu_objset_type(os
) != DMU_OST_ZFS
) {
1436 return (SET_ERROR(EINVAL
));
1439 mutex_enter(&os
->os_user_ptr_lock
);
1440 *zfvp
= dmu_objset_get_user(os
);
1441 /* bump s_active only when non-zero to prevent umount race */
1442 if (*zfvp
== NULL
|| (*zfvp
)->z_sb
== NULL
||
1443 !atomic_inc_not_zero(&((*zfvp
)->z_sb
->s_active
))) {
1444 error
= SET_ERROR(ESRCH
);
1446 mutex_exit(&os
->os_user_ptr_lock
);
1451 getzfsvfs(const char *dsname
, zfsvfs_t
**zfvp
)
1456 error
= dmu_objset_hold(dsname
, FTAG
, &os
);
1460 error
= getzfsvfs_impl(os
, zfvp
);
1461 dmu_objset_rele(os
, FTAG
);
1466 * Find a zfsvfs_t for a mounted filesystem, or create our own, in which
1467 * case its z_sb will be NULL, and it will be opened as the owner.
1468 * If 'writer' is set, the z_teardown_lock will be held for RW_WRITER,
1469 * which prevents all inode ops from running.
1472 zfsvfs_hold(const char *name
, void *tag
, zfsvfs_t
**zfvp
, boolean_t writer
)
1476 if (getzfsvfs(name
, zfvp
) != 0)
1477 error
= zfsvfs_create(name
, B_FALSE
, zfvp
);
1479 rrm_enter(&(*zfvp
)->z_teardown_lock
, (writer
) ? RW_WRITER
:
1481 if ((*zfvp
)->z_unmounted
) {
1483 * XXX we could probably try again, since the unmounting
1484 * thread should be just about to disassociate the
1485 * objset from the zfsvfs.
1487 rrm_exit(&(*zfvp
)->z_teardown_lock
, tag
);
1488 return (SET_ERROR(EBUSY
));
1495 zfsvfs_rele(zfsvfs_t
*zfsvfs
, void *tag
)
1497 rrm_exit(&zfsvfs
->z_teardown_lock
, tag
);
1500 deactivate_super(zfsvfs
->z_sb
);
1502 dmu_objset_disown(zfsvfs
->z_os
, B_TRUE
, zfsvfs
);
1503 zfsvfs_free(zfsvfs
);
1508 zfs_ioc_pool_create(zfs_cmd_t
*zc
)
1511 nvlist_t
*config
, *props
= NULL
;
1512 nvlist_t
*rootprops
= NULL
;
1513 nvlist_t
*zplprops
= NULL
;
1514 dsl_crypto_params_t
*dcp
= NULL
;
1515 char *spa_name
= zc
->zc_name
;
1517 if ((error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
1518 zc
->zc_iflags
, &config
)))
1521 if (zc
->zc_nvlist_src_size
!= 0 && (error
=
1522 get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
1523 zc
->zc_iflags
, &props
))) {
1524 nvlist_free(config
);
1529 nvlist_t
*nvl
= NULL
;
1530 nvlist_t
*hidden_args
= NULL
;
1531 uint64_t version
= SPA_VERSION
;
1534 (void) nvlist_lookup_uint64(props
,
1535 zpool_prop_to_name(ZPOOL_PROP_VERSION
), &version
);
1536 if (!SPA_VERSION_IS_SUPPORTED(version
)) {
1537 error
= SET_ERROR(EINVAL
);
1538 goto pool_props_bad
;
1540 (void) nvlist_lookup_nvlist(props
, ZPOOL_ROOTFS_PROPS
, &nvl
);
1542 error
= nvlist_dup(nvl
, &rootprops
, KM_SLEEP
);
1544 nvlist_free(config
);
1548 (void) nvlist_remove_all(props
, ZPOOL_ROOTFS_PROPS
);
1551 (void) nvlist_lookup_nvlist(props
, ZPOOL_HIDDEN_ARGS
,
1553 error
= dsl_crypto_params_create_nvlist(DCP_CMD_NONE
,
1554 rootprops
, hidden_args
, &dcp
);
1556 nvlist_free(config
);
1560 (void) nvlist_remove_all(props
, ZPOOL_HIDDEN_ARGS
);
1562 VERIFY(nvlist_alloc(&zplprops
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
1563 error
= zfs_fill_zplprops_root(version
, rootprops
,
1566 goto pool_props_bad
;
1568 if (nvlist_lookup_string(props
,
1569 zpool_prop_to_name(ZPOOL_PROP_TNAME
), &tname
) == 0)
1573 error
= spa_create(zc
->zc_name
, config
, props
, zplprops
, dcp
);
1576 * Set the remaining root properties
1578 if (!error
&& (error
= zfs_set_prop_nvlist(spa_name
,
1579 ZPROP_SRC_LOCAL
, rootprops
, NULL
)) != 0)
1580 (void) spa_destroy(spa_name
);
1583 nvlist_free(rootprops
);
1584 nvlist_free(zplprops
);
1585 nvlist_free(config
);
1587 dsl_crypto_params_free(dcp
, !!error
);
1593 zfs_ioc_pool_destroy(zfs_cmd_t
*zc
)
1596 zfs_log_history(zc
);
1597 error
= spa_destroy(zc
->zc_name
);
1603 zfs_ioc_pool_import(zfs_cmd_t
*zc
)
1605 nvlist_t
*config
, *props
= NULL
;
1609 if ((error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
1610 zc
->zc_iflags
, &config
)) != 0)
1613 if (zc
->zc_nvlist_src_size
!= 0 && (error
=
1614 get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
1615 zc
->zc_iflags
, &props
))) {
1616 nvlist_free(config
);
1620 if (nvlist_lookup_uint64(config
, ZPOOL_CONFIG_POOL_GUID
, &guid
) != 0 ||
1621 guid
!= zc
->zc_guid
)
1622 error
= SET_ERROR(EINVAL
);
1624 error
= spa_import(zc
->zc_name
, config
, props
, zc
->zc_cookie
);
1626 if (zc
->zc_nvlist_dst
!= 0) {
1629 if ((err
= put_nvlist(zc
, config
)) != 0)
1633 nvlist_free(config
);
1640 zfs_ioc_pool_export(zfs_cmd_t
*zc
)
1643 boolean_t force
= (boolean_t
)zc
->zc_cookie
;
1644 boolean_t hardforce
= (boolean_t
)zc
->zc_guid
;
1646 zfs_log_history(zc
);
1647 error
= spa_export(zc
->zc_name
, NULL
, force
, hardforce
);
1653 zfs_ioc_pool_configs(zfs_cmd_t
*zc
)
1658 if ((configs
= spa_all_configs(&zc
->zc_cookie
)) == NULL
)
1659 return (SET_ERROR(EEXIST
));
1661 error
= put_nvlist(zc
, configs
);
1663 nvlist_free(configs
);
1670 * zc_name name of the pool
1673 * zc_cookie real errno
1674 * zc_nvlist_dst config nvlist
1675 * zc_nvlist_dst_size size of config nvlist
1678 zfs_ioc_pool_stats(zfs_cmd_t
*zc
)
1684 error
= spa_get_stats(zc
->zc_name
, &config
, zc
->zc_value
,
1685 sizeof (zc
->zc_value
));
1687 if (config
!= NULL
) {
1688 ret
= put_nvlist(zc
, config
);
1689 nvlist_free(config
);
1692 * The config may be present even if 'error' is non-zero.
1693 * In this case we return success, and preserve the real errno
1696 zc
->zc_cookie
= error
;
1705 * Try to import the given pool, returning pool stats as appropriate so that
1706 * user land knows which devices are available and overall pool health.
1709 zfs_ioc_pool_tryimport(zfs_cmd_t
*zc
)
1711 nvlist_t
*tryconfig
, *config
= NULL
;
1714 if ((error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
1715 zc
->zc_iflags
, &tryconfig
)) != 0)
1718 config
= spa_tryimport(tryconfig
);
1720 nvlist_free(tryconfig
);
1723 return (SET_ERROR(EINVAL
));
1725 error
= put_nvlist(zc
, config
);
1726 nvlist_free(config
);
1733 * zc_name name of the pool
1734 * zc_cookie scan func (pool_scan_func_t)
1735 * zc_flags scrub pause/resume flag (pool_scrub_cmd_t)
1738 zfs_ioc_pool_scan(zfs_cmd_t
*zc
)
1743 if (zc
->zc_flags
>= POOL_SCRUB_FLAGS_END
)
1744 return (SET_ERROR(EINVAL
));
1746 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
1749 if (zc
->zc_flags
== POOL_SCRUB_PAUSE
)
1750 error
= spa_scrub_pause_resume(spa
, POOL_SCRUB_PAUSE
);
1751 else if (zc
->zc_cookie
== POOL_SCAN_NONE
)
1752 error
= spa_scan_stop(spa
);
1754 error
= spa_scan(spa
, zc
->zc_cookie
);
1756 spa_close(spa
, FTAG
);
1762 zfs_ioc_pool_freeze(zfs_cmd_t
*zc
)
1767 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
1770 spa_close(spa
, FTAG
);
1776 zfs_ioc_pool_upgrade(zfs_cmd_t
*zc
)
1781 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
1784 if (zc
->zc_cookie
< spa_version(spa
) ||
1785 !SPA_VERSION_IS_SUPPORTED(zc
->zc_cookie
)) {
1786 spa_close(spa
, FTAG
);
1787 return (SET_ERROR(EINVAL
));
1790 spa_upgrade(spa
, zc
->zc_cookie
);
1791 spa_close(spa
, FTAG
);
1797 zfs_ioc_pool_get_history(zfs_cmd_t
*zc
)
1804 if ((size
= zc
->zc_history_len
) == 0)
1805 return (SET_ERROR(EINVAL
));
1807 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
1810 if (spa_version(spa
) < SPA_VERSION_ZPOOL_HISTORY
) {
1811 spa_close(spa
, FTAG
);
1812 return (SET_ERROR(ENOTSUP
));
1815 hist_buf
= vmem_alloc(size
, KM_SLEEP
);
1816 if ((error
= spa_history_get(spa
, &zc
->zc_history_offset
,
1817 &zc
->zc_history_len
, hist_buf
)) == 0) {
1818 error
= ddi_copyout(hist_buf
,
1819 (void *)(uintptr_t)zc
->zc_history
,
1820 zc
->zc_history_len
, zc
->zc_iflags
);
1823 spa_close(spa
, FTAG
);
1824 vmem_free(hist_buf
, size
);
1829 zfs_ioc_pool_reguid(zfs_cmd_t
*zc
)
1834 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
1836 error
= spa_change_guid(spa
);
1837 spa_close(spa
, FTAG
);
1843 zfs_ioc_dsobj_to_dsname(zfs_cmd_t
*zc
)
1845 return (dsl_dsobj_to_dsname(zc
->zc_name
, zc
->zc_obj
, zc
->zc_value
));
1850 * zc_name name of filesystem
1851 * zc_obj object to find
1854 * zc_value name of object
1857 zfs_ioc_obj_to_path(zfs_cmd_t
*zc
)
1862 /* XXX reading from objset not owned */
1863 if ((error
= dmu_objset_hold_flags(zc
->zc_name
, B_TRUE
,
1866 if (dmu_objset_type(os
) != DMU_OST_ZFS
) {
1867 dmu_objset_rele_flags(os
, B_TRUE
, FTAG
);
1868 return (SET_ERROR(EINVAL
));
1870 error
= zfs_obj_to_path(os
, zc
->zc_obj
, zc
->zc_value
,
1871 sizeof (zc
->zc_value
));
1872 dmu_objset_rele_flags(os
, B_TRUE
, FTAG
);
1879 * zc_name name of filesystem
1880 * zc_obj object to find
1883 * zc_stat stats on object
1884 * zc_value path to object
1887 zfs_ioc_obj_to_stats(zfs_cmd_t
*zc
)
1892 /* XXX reading from objset not owned */
1893 if ((error
= dmu_objset_hold_flags(zc
->zc_name
, B_TRUE
,
1896 if (dmu_objset_type(os
) != DMU_OST_ZFS
) {
1897 dmu_objset_rele_flags(os
, B_TRUE
, FTAG
);
1898 return (SET_ERROR(EINVAL
));
1900 error
= zfs_obj_to_stats(os
, zc
->zc_obj
, &zc
->zc_stat
, zc
->zc_value
,
1901 sizeof (zc
->zc_value
));
1902 dmu_objset_rele_flags(os
, B_TRUE
, FTAG
);
1908 zfs_ioc_vdev_add(zfs_cmd_t
*zc
)
1914 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
1918 error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
1919 zc
->zc_iflags
, &config
);
1921 error
= spa_vdev_add(spa
, config
);
1922 nvlist_free(config
);
1924 spa_close(spa
, FTAG
);
1930 * zc_name name of the pool
1931 * zc_guid guid of vdev to remove
1932 * zc_cookie cancel removal
1935 zfs_ioc_vdev_remove(zfs_cmd_t
*zc
)
1940 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
1943 if (zc
->zc_cookie
!= 0) {
1944 error
= spa_vdev_remove_cancel(spa
);
1946 error
= spa_vdev_remove(spa
, zc
->zc_guid
, B_FALSE
);
1948 spa_close(spa
, FTAG
);
1953 zfs_ioc_vdev_set_state(zfs_cmd_t
*zc
)
1957 vdev_state_t newstate
= VDEV_STATE_UNKNOWN
;
1959 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
1961 switch (zc
->zc_cookie
) {
1962 case VDEV_STATE_ONLINE
:
1963 error
= vdev_online(spa
, zc
->zc_guid
, zc
->zc_obj
, &newstate
);
1966 case VDEV_STATE_OFFLINE
:
1967 error
= vdev_offline(spa
, zc
->zc_guid
, zc
->zc_obj
);
1970 case VDEV_STATE_FAULTED
:
1971 if (zc
->zc_obj
!= VDEV_AUX_ERR_EXCEEDED
&&
1972 zc
->zc_obj
!= VDEV_AUX_EXTERNAL
&&
1973 zc
->zc_obj
!= VDEV_AUX_EXTERNAL_PERSIST
)
1974 zc
->zc_obj
= VDEV_AUX_ERR_EXCEEDED
;
1976 error
= vdev_fault(spa
, zc
->zc_guid
, zc
->zc_obj
);
1979 case VDEV_STATE_DEGRADED
:
1980 if (zc
->zc_obj
!= VDEV_AUX_ERR_EXCEEDED
&&
1981 zc
->zc_obj
!= VDEV_AUX_EXTERNAL
)
1982 zc
->zc_obj
= VDEV_AUX_ERR_EXCEEDED
;
1984 error
= vdev_degrade(spa
, zc
->zc_guid
, zc
->zc_obj
);
1988 error
= SET_ERROR(EINVAL
);
1990 zc
->zc_cookie
= newstate
;
1991 spa_close(spa
, FTAG
);
1996 zfs_ioc_vdev_attach(zfs_cmd_t
*zc
)
1999 int replacing
= zc
->zc_cookie
;
2003 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
2006 if ((error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
2007 zc
->zc_iflags
, &config
)) == 0) {
2008 error
= spa_vdev_attach(spa
, zc
->zc_guid
, config
, replacing
);
2009 nvlist_free(config
);
2012 spa_close(spa
, FTAG
);
2017 zfs_ioc_vdev_detach(zfs_cmd_t
*zc
)
2022 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
2025 error
= spa_vdev_detach(spa
, zc
->zc_guid
, 0, B_FALSE
);
2027 spa_close(spa
, FTAG
);
2032 zfs_ioc_vdev_split(zfs_cmd_t
*zc
)
2035 nvlist_t
*config
, *props
= NULL
;
2037 boolean_t exp
= !!(zc
->zc_cookie
& ZPOOL_EXPORT_AFTER_SPLIT
);
2039 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
2042 if ((error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
2043 zc
->zc_iflags
, &config
))) {
2044 spa_close(spa
, FTAG
);
2048 if (zc
->zc_nvlist_src_size
!= 0 && (error
=
2049 get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
2050 zc
->zc_iflags
, &props
))) {
2051 spa_close(spa
, FTAG
);
2052 nvlist_free(config
);
2056 error
= spa_vdev_split_mirror(spa
, zc
->zc_string
, config
, props
, exp
);
2058 spa_close(spa
, FTAG
);
2060 nvlist_free(config
);
2067 zfs_ioc_vdev_setpath(zfs_cmd_t
*zc
)
2070 char *path
= zc
->zc_value
;
2071 uint64_t guid
= zc
->zc_guid
;
2074 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
2078 error
= spa_vdev_setpath(spa
, guid
, path
);
2079 spa_close(spa
, FTAG
);
2084 zfs_ioc_vdev_setfru(zfs_cmd_t
*zc
)
2087 char *fru
= zc
->zc_value
;
2088 uint64_t guid
= zc
->zc_guid
;
2091 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
2095 error
= spa_vdev_setfru(spa
, guid
, fru
);
2096 spa_close(spa
, FTAG
);
2101 zfs_ioc_objset_stats_impl(zfs_cmd_t
*zc
, objset_t
*os
)
2106 dmu_objset_fast_stat(os
, &zc
->zc_objset_stats
);
2108 if (zc
->zc_nvlist_dst
!= 0 &&
2109 (error
= dsl_prop_get_all(os
, &nv
)) == 0) {
2110 dmu_objset_stats(os
, nv
);
2112 * NB: zvol_get_stats() will read the objset contents,
2113 * which we aren't supposed to do with a
2114 * DS_MODE_USER hold, because it could be
2115 * inconsistent. So this is a bit of a workaround...
2116 * XXX reading with out owning
2118 if (!zc
->zc_objset_stats
.dds_inconsistent
&&
2119 dmu_objset_type(os
) == DMU_OST_ZVOL
) {
2120 error
= zvol_get_stats(os
, nv
);
2128 error
= put_nvlist(zc
, nv
);
2137 * zc_name name of filesystem
2138 * zc_nvlist_dst_size size of buffer for property nvlist
2141 * zc_objset_stats stats
2142 * zc_nvlist_dst property nvlist
2143 * zc_nvlist_dst_size size of property nvlist
2146 zfs_ioc_objset_stats(zfs_cmd_t
*zc
)
2151 error
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
);
2153 error
= zfs_ioc_objset_stats_impl(zc
, os
);
2154 dmu_objset_rele(os
, FTAG
);
2162 * zc_name name of filesystem
2163 * zc_nvlist_dst_size size of buffer for property nvlist
2166 * zc_nvlist_dst received property nvlist
2167 * zc_nvlist_dst_size size of received property nvlist
2169 * Gets received properties (distinct from local properties on or after
2170 * SPA_VERSION_RECVD_PROPS) for callers who want to differentiate received from
2171 * local property values.
2174 zfs_ioc_objset_recvd_props(zfs_cmd_t
*zc
)
2180 * Without this check, we would return local property values if the
2181 * caller has not already received properties on or after
2182 * SPA_VERSION_RECVD_PROPS.
2184 if (!dsl_prop_get_hasrecvd(zc
->zc_name
))
2185 return (SET_ERROR(ENOTSUP
));
2187 if (zc
->zc_nvlist_dst
!= 0 &&
2188 (error
= dsl_prop_get_received(zc
->zc_name
, &nv
)) == 0) {
2189 error
= put_nvlist(zc
, nv
);
2197 nvl_add_zplprop(objset_t
*os
, nvlist_t
*props
, zfs_prop_t prop
)
2203 * zfs_get_zplprop() will either find a value or give us
2204 * the default value (if there is one).
2206 if ((error
= zfs_get_zplprop(os
, prop
, &value
)) != 0)
2208 VERIFY(nvlist_add_uint64(props
, zfs_prop_to_name(prop
), value
) == 0);
2214 * zc_name name of filesystem
2215 * zc_nvlist_dst_size size of buffer for zpl property nvlist
2218 * zc_nvlist_dst zpl property nvlist
2219 * zc_nvlist_dst_size size of zpl property nvlist
2222 zfs_ioc_objset_zplprops(zfs_cmd_t
*zc
)
2227 /* XXX reading without owning */
2228 if ((err
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
)))
2231 dmu_objset_fast_stat(os
, &zc
->zc_objset_stats
);
2234 * NB: nvl_add_zplprop() will read the objset contents,
2235 * which we aren't supposed to do with a DS_MODE_USER
2236 * hold, because it could be inconsistent.
2238 if (zc
->zc_nvlist_dst
!= 0 &&
2239 !zc
->zc_objset_stats
.dds_inconsistent
&&
2240 dmu_objset_type(os
) == DMU_OST_ZFS
) {
2243 VERIFY(nvlist_alloc(&nv
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
2244 if ((err
= nvl_add_zplprop(os
, nv
, ZFS_PROP_VERSION
)) == 0 &&
2245 (err
= nvl_add_zplprop(os
, nv
, ZFS_PROP_NORMALIZE
)) == 0 &&
2246 (err
= nvl_add_zplprop(os
, nv
, ZFS_PROP_UTF8ONLY
)) == 0 &&
2247 (err
= nvl_add_zplprop(os
, nv
, ZFS_PROP_CASE
)) == 0)
2248 err
= put_nvlist(zc
, nv
);
2251 err
= SET_ERROR(ENOENT
);
2253 dmu_objset_rele(os
, FTAG
);
2259 * zc_name name of filesystem
2260 * zc_cookie zap cursor
2261 * zc_nvlist_dst_size size of buffer for property nvlist
2264 * zc_name name of next filesystem
2265 * zc_cookie zap cursor
2266 * zc_objset_stats stats
2267 * zc_nvlist_dst property nvlist
2268 * zc_nvlist_dst_size size of property nvlist
2271 zfs_ioc_dataset_list_next(zfs_cmd_t
*zc
)
2276 size_t orig_len
= strlen(zc
->zc_name
);
2279 if ((error
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
))) {
2280 if (error
== ENOENT
)
2281 error
= SET_ERROR(ESRCH
);
2285 p
= strrchr(zc
->zc_name
, '/');
2286 if (p
== NULL
|| p
[1] != '\0')
2287 (void) strlcat(zc
->zc_name
, "/", sizeof (zc
->zc_name
));
2288 p
= zc
->zc_name
+ strlen(zc
->zc_name
);
2291 error
= dmu_dir_list_next(os
,
2292 sizeof (zc
->zc_name
) - (p
- zc
->zc_name
), p
,
2293 NULL
, &zc
->zc_cookie
);
2294 if (error
== ENOENT
)
2295 error
= SET_ERROR(ESRCH
);
2296 } while (error
== 0 && zfs_dataset_name_hidden(zc
->zc_name
));
2297 dmu_objset_rele(os
, FTAG
);
2300 * If it's an internal dataset (ie. with a '$' in its name),
2301 * don't try to get stats for it, otherwise we'll return ENOENT.
2303 if (error
== 0 && strchr(zc
->zc_name
, '$') == NULL
) {
2304 error
= zfs_ioc_objset_stats(zc
); /* fill in the stats */
2305 if (error
== ENOENT
) {
2306 /* We lost a race with destroy, get the next one. */
2307 zc
->zc_name
[orig_len
] = '\0';
2316 * zc_name name of filesystem
2317 * zc_cookie zap cursor
2318 * zc_nvlist_dst_size size of buffer for property nvlist
2321 * zc_name name of next snapshot
2322 * zc_objset_stats stats
2323 * zc_nvlist_dst property nvlist
2324 * zc_nvlist_dst_size size of property nvlist
2327 zfs_ioc_snapshot_list_next(zfs_cmd_t
*zc
)
2332 error
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
);
2334 return (error
== ENOENT
? ESRCH
: error
);
2338 * A dataset name of maximum length cannot have any snapshots,
2339 * so exit immediately.
2341 if (strlcat(zc
->zc_name
, "@", sizeof (zc
->zc_name
)) >=
2342 ZFS_MAX_DATASET_NAME_LEN
) {
2343 dmu_objset_rele(os
, FTAG
);
2344 return (SET_ERROR(ESRCH
));
2347 error
= dmu_snapshot_list_next(os
,
2348 sizeof (zc
->zc_name
) - strlen(zc
->zc_name
),
2349 zc
->zc_name
+ strlen(zc
->zc_name
), &zc
->zc_obj
, &zc
->zc_cookie
,
2352 if (error
== 0 && !zc
->zc_simple
) {
2354 dsl_pool_t
*dp
= os
->os_dsl_dataset
->ds_dir
->dd_pool
;
2356 error
= dsl_dataset_hold_obj(dp
, zc
->zc_obj
, FTAG
, &ds
);
2360 error
= dmu_objset_from_ds(ds
, &ossnap
);
2362 error
= zfs_ioc_objset_stats_impl(zc
, ossnap
);
2363 dsl_dataset_rele(ds
, FTAG
);
2365 } else if (error
== ENOENT
) {
2366 error
= SET_ERROR(ESRCH
);
2369 dmu_objset_rele(os
, FTAG
);
2370 /* if we failed, undo the @ that we tacked on to zc_name */
2372 *strchr(zc
->zc_name
, '@') = '\0';
2377 zfs_prop_set_userquota(const char *dsname
, nvpair_t
*pair
)
2379 const char *propname
= nvpair_name(pair
);
2381 unsigned int vallen
;
2384 zfs_userquota_prop_t type
;
2390 if (nvpair_type(pair
) == DATA_TYPE_NVLIST
) {
2392 VERIFY(nvpair_value_nvlist(pair
, &attrs
) == 0);
2393 if (nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
2395 return (SET_ERROR(EINVAL
));
2399 * A correctly constructed propname is encoded as
2400 * userquota@<rid>-<domain>.
2402 if ((dash
= strchr(propname
, '-')) == NULL
||
2403 nvpair_value_uint64_array(pair
, &valary
, &vallen
) != 0 ||
2405 return (SET_ERROR(EINVAL
));
2412 err
= zfsvfs_hold(dsname
, FTAG
, &zfsvfs
, B_FALSE
);
2414 err
= zfs_set_userquota(zfsvfs
, type
, domain
, rid
, quota
);
2415 zfsvfs_rele(zfsvfs
, FTAG
);
2422 * If the named property is one that has a special function to set its value,
2423 * return 0 on success and a positive error code on failure; otherwise if it is
2424 * not one of the special properties handled by this function, return -1.
2426 * XXX: It would be better for callers of the property interface if we handled
2427 * these special cases in dsl_prop.c (in the dsl layer).
2430 zfs_prop_set_special(const char *dsname
, zprop_source_t source
,
2433 const char *propname
= nvpair_name(pair
);
2434 zfs_prop_t prop
= zfs_name_to_prop(propname
);
2435 uint64_t intval
= 0;
2436 char *strval
= NULL
;
2439 if (prop
== ZPROP_INVAL
) {
2440 if (zfs_prop_userquota(propname
))
2441 return (zfs_prop_set_userquota(dsname
, pair
));
2445 if (nvpair_type(pair
) == DATA_TYPE_NVLIST
) {
2447 VERIFY(nvpair_value_nvlist(pair
, &attrs
) == 0);
2448 VERIFY(nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
2452 /* all special properties are numeric except for keylocation */
2453 if (zfs_prop_get_type(prop
) == PROP_TYPE_STRING
) {
2454 strval
= fnvpair_value_string(pair
);
2456 intval
= fnvpair_value_uint64(pair
);
2460 case ZFS_PROP_QUOTA
:
2461 err
= dsl_dir_set_quota(dsname
, source
, intval
);
2463 case ZFS_PROP_REFQUOTA
:
2464 err
= dsl_dataset_set_refquota(dsname
, source
, intval
);
2466 case ZFS_PROP_FILESYSTEM_LIMIT
:
2467 case ZFS_PROP_SNAPSHOT_LIMIT
:
2468 if (intval
== UINT64_MAX
) {
2469 /* clearing the limit, just do it */
2472 err
= dsl_dir_activate_fs_ss_limit(dsname
);
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_KEYLOCATION
:
2482 err
= dsl_crypto_can_set_keylocation(dsname
, strval
);
2485 * Set err to -1 to force the zfs_set_prop_nvlist code down the
2486 * default path to set the value in the nvlist.
2491 case ZFS_PROP_RESERVATION
:
2492 err
= dsl_dir_set_reservation(dsname
, source
, intval
);
2494 case ZFS_PROP_REFRESERVATION
:
2495 err
= dsl_dataset_set_refreservation(dsname
, source
, intval
);
2497 case ZFS_PROP_VOLSIZE
:
2498 err
= zvol_set_volsize(dsname
, intval
);
2500 case ZFS_PROP_SNAPDEV
:
2501 err
= zvol_set_snapdev(dsname
, source
, intval
);
2503 case ZFS_PROP_VOLMODE
:
2504 err
= zvol_set_volmode(dsname
, source
, intval
);
2506 case ZFS_PROP_VERSION
:
2510 if ((err
= zfsvfs_hold(dsname
, FTAG
, &zfsvfs
, B_TRUE
)) != 0)
2513 err
= zfs_set_version(zfsvfs
, intval
);
2514 zfsvfs_rele(zfsvfs
, FTAG
);
2516 if (err
== 0 && intval
>= ZPL_VERSION_USERSPACE
) {
2519 zc
= kmem_zalloc(sizeof (zfs_cmd_t
), KM_SLEEP
);
2520 (void) strcpy(zc
->zc_name
, dsname
);
2521 (void) zfs_ioc_userspace_upgrade(zc
);
2522 (void) zfs_ioc_id_quota_upgrade(zc
);
2523 kmem_free(zc
, sizeof (zfs_cmd_t
));
2535 * This function is best effort. If it fails to set any of the given properties,
2536 * it continues to set as many as it can and returns the last error
2537 * encountered. If the caller provides a non-NULL errlist, it will be filled in
2538 * with the list of names of all the properties that failed along with the
2539 * corresponding error numbers.
2541 * If every property is set successfully, zero is returned and errlist is not
2545 zfs_set_prop_nvlist(const char *dsname
, zprop_source_t source
, nvlist_t
*nvl
,
2554 nvlist_t
*genericnvl
= fnvlist_alloc();
2555 nvlist_t
*retrynvl
= fnvlist_alloc();
2558 while ((pair
= nvlist_next_nvpair(nvl
, pair
)) != NULL
) {
2559 const char *propname
= nvpair_name(pair
);
2560 zfs_prop_t prop
= zfs_name_to_prop(propname
);
2563 /* decode the property value */
2565 if (nvpair_type(pair
) == DATA_TYPE_NVLIST
) {
2567 attrs
= fnvpair_value_nvlist(pair
);
2568 if (nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
2570 err
= SET_ERROR(EINVAL
);
2573 /* Validate value type */
2574 if (err
== 0 && source
== ZPROP_SRC_INHERITED
) {
2575 /* inherited properties are expected to be booleans */
2576 if (nvpair_type(propval
) != DATA_TYPE_BOOLEAN
)
2577 err
= SET_ERROR(EINVAL
);
2578 } else if (err
== 0 && prop
== ZPROP_INVAL
) {
2579 if (zfs_prop_user(propname
)) {
2580 if (nvpair_type(propval
) != DATA_TYPE_STRING
)
2581 err
= SET_ERROR(EINVAL
);
2582 } else if (zfs_prop_userquota(propname
)) {
2583 if (nvpair_type(propval
) !=
2584 DATA_TYPE_UINT64_ARRAY
)
2585 err
= SET_ERROR(EINVAL
);
2587 err
= SET_ERROR(EINVAL
);
2589 } else if (err
== 0) {
2590 if (nvpair_type(propval
) == DATA_TYPE_STRING
) {
2591 if (zfs_prop_get_type(prop
) != PROP_TYPE_STRING
)
2592 err
= SET_ERROR(EINVAL
);
2593 } else if (nvpair_type(propval
) == DATA_TYPE_UINT64
) {
2596 intval
= fnvpair_value_uint64(propval
);
2598 switch (zfs_prop_get_type(prop
)) {
2599 case PROP_TYPE_NUMBER
:
2601 case PROP_TYPE_STRING
:
2602 err
= SET_ERROR(EINVAL
);
2604 case PROP_TYPE_INDEX
:
2605 if (zfs_prop_index_to_string(prop
,
2606 intval
, &unused
) != 0)
2607 err
= SET_ERROR(EINVAL
);
2611 "unknown property type");
2614 err
= SET_ERROR(EINVAL
);
2618 /* Validate permissions */
2620 err
= zfs_check_settable(dsname
, pair
, CRED());
2623 if (source
== ZPROP_SRC_INHERITED
)
2624 err
= -1; /* does not need special handling */
2626 err
= zfs_prop_set_special(dsname
, source
,
2630 * For better performance we build up a list of
2631 * properties to set in a single transaction.
2633 err
= nvlist_add_nvpair(genericnvl
, pair
);
2634 } else if (err
!= 0 && nvl
!= retrynvl
) {
2636 * This may be a spurious error caused by
2637 * receiving quota and reservation out of order.
2638 * Try again in a second pass.
2640 err
= nvlist_add_nvpair(retrynvl
, pair
);
2645 if (errlist
!= NULL
)
2646 fnvlist_add_int32(errlist
, propname
, err
);
2651 if (nvl
!= retrynvl
&& !nvlist_empty(retrynvl
)) {
2656 if (!nvlist_empty(genericnvl
) &&
2657 dsl_props_set(dsname
, source
, genericnvl
) != 0) {
2659 * If this fails, we still want to set as many properties as we
2660 * can, so try setting them individually.
2663 while ((pair
= nvlist_next_nvpair(genericnvl
, pair
)) != NULL
) {
2664 const char *propname
= nvpair_name(pair
);
2668 if (nvpair_type(pair
) == DATA_TYPE_NVLIST
) {
2670 attrs
= fnvpair_value_nvlist(pair
);
2671 propval
= fnvlist_lookup_nvpair(attrs
,
2675 if (nvpair_type(propval
) == DATA_TYPE_STRING
) {
2676 strval
= fnvpair_value_string(propval
);
2677 err
= dsl_prop_set_string(dsname
, propname
,
2679 } else if (nvpair_type(propval
) == DATA_TYPE_BOOLEAN
) {
2680 err
= dsl_prop_inherit(dsname
, propname
,
2683 intval
= fnvpair_value_uint64(propval
);
2684 err
= dsl_prop_set_int(dsname
, propname
, source
,
2689 if (errlist
!= NULL
) {
2690 fnvlist_add_int32(errlist
, propname
,
2697 nvlist_free(genericnvl
);
2698 nvlist_free(retrynvl
);
2704 * Check that all the properties are valid user properties.
2707 zfs_check_userprops(const char *fsname
, nvlist_t
*nvl
)
2709 nvpair_t
*pair
= NULL
;
2712 while ((pair
= nvlist_next_nvpair(nvl
, pair
)) != NULL
) {
2713 const char *propname
= nvpair_name(pair
);
2715 if (!zfs_prop_user(propname
) ||
2716 nvpair_type(pair
) != DATA_TYPE_STRING
)
2717 return (SET_ERROR(EINVAL
));
2719 if ((error
= zfs_secpolicy_write_perms(fsname
,
2720 ZFS_DELEG_PERM_USERPROP
, CRED())))
2723 if (strlen(propname
) >= ZAP_MAXNAMELEN
)
2724 return (SET_ERROR(ENAMETOOLONG
));
2726 if (strlen(fnvpair_value_string(pair
)) >= ZAP_MAXVALUELEN
)
2727 return (SET_ERROR(E2BIG
));
2733 props_skip(nvlist_t
*props
, nvlist_t
*skipped
, nvlist_t
**newprops
)
2737 VERIFY(nvlist_alloc(newprops
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
2740 while ((pair
= nvlist_next_nvpair(props
, pair
)) != NULL
) {
2741 if (nvlist_exists(skipped
, nvpair_name(pair
)))
2744 VERIFY(nvlist_add_nvpair(*newprops
, pair
) == 0);
2749 clear_received_props(const char *dsname
, nvlist_t
*props
,
2753 nvlist_t
*cleared_props
= NULL
;
2754 props_skip(props
, skipped
, &cleared_props
);
2755 if (!nvlist_empty(cleared_props
)) {
2757 * Acts on local properties until the dataset has received
2758 * properties at least once on or after SPA_VERSION_RECVD_PROPS.
2760 zprop_source_t flags
= (ZPROP_SRC_NONE
|
2761 (dsl_prop_get_hasrecvd(dsname
) ? ZPROP_SRC_RECEIVED
: 0));
2762 err
= zfs_set_prop_nvlist(dsname
, flags
, cleared_props
, NULL
);
2764 nvlist_free(cleared_props
);
2770 * zc_name name of filesystem
2771 * zc_value name of property to set
2772 * zc_nvlist_src{_size} nvlist of properties to apply
2773 * zc_cookie received properties flag
2776 * zc_nvlist_dst{_size} error for each unapplied received property
2779 zfs_ioc_set_prop(zfs_cmd_t
*zc
)
2782 boolean_t received
= zc
->zc_cookie
;
2783 zprop_source_t source
= (received
? ZPROP_SRC_RECEIVED
:
2788 if ((error
= get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
2789 zc
->zc_iflags
, &nvl
)) != 0)
2793 nvlist_t
*origprops
;
2795 if (dsl_prop_get_received(zc
->zc_name
, &origprops
) == 0) {
2796 (void) clear_received_props(zc
->zc_name
,
2798 nvlist_free(origprops
);
2801 error
= dsl_prop_set_hasrecvd(zc
->zc_name
);
2804 errors
= fnvlist_alloc();
2806 error
= zfs_set_prop_nvlist(zc
->zc_name
, source
, nvl
, errors
);
2808 if (zc
->zc_nvlist_dst
!= 0 && errors
!= NULL
) {
2809 (void) put_nvlist(zc
, errors
);
2812 nvlist_free(errors
);
2819 * zc_name name of filesystem
2820 * zc_value name of property to inherit
2821 * zc_cookie revert to received value if TRUE
2826 zfs_ioc_inherit_prop(zfs_cmd_t
*zc
)
2828 const char *propname
= zc
->zc_value
;
2829 zfs_prop_t prop
= zfs_name_to_prop(propname
);
2830 boolean_t received
= zc
->zc_cookie
;
2831 zprop_source_t source
= (received
2832 ? ZPROP_SRC_NONE
/* revert to received value, if any */
2833 : ZPROP_SRC_INHERITED
); /* explicitly inherit */
2841 * Only check this in the non-received case. We want to allow
2842 * 'inherit -S' to revert non-inheritable properties like quota
2843 * and reservation to the received or default values even though
2844 * they are not considered inheritable.
2846 if (prop
!= ZPROP_INVAL
&& !zfs_prop_inheritable(prop
))
2847 return (SET_ERROR(EINVAL
));
2850 if (prop
== ZPROP_INVAL
) {
2851 if (!zfs_prop_user(propname
))
2852 return (SET_ERROR(EINVAL
));
2854 type
= PROP_TYPE_STRING
;
2855 } else if (prop
== ZFS_PROP_VOLSIZE
|| prop
== ZFS_PROP_VERSION
) {
2856 return (SET_ERROR(EINVAL
));
2858 type
= zfs_prop_get_type(prop
);
2862 * zfs_prop_set_special() expects properties in the form of an
2863 * nvpair with type info.
2865 dummy
= fnvlist_alloc();
2868 case PROP_TYPE_STRING
:
2869 VERIFY(0 == nvlist_add_string(dummy
, propname
, ""));
2871 case PROP_TYPE_NUMBER
:
2872 case PROP_TYPE_INDEX
:
2873 VERIFY(0 == nvlist_add_uint64(dummy
, propname
, 0));
2876 err
= SET_ERROR(EINVAL
);
2880 pair
= nvlist_next_nvpair(dummy
, NULL
);
2882 err
= SET_ERROR(EINVAL
);
2884 err
= zfs_prop_set_special(zc
->zc_name
, source
, pair
);
2885 if (err
== -1) /* property is not "special", needs handling */
2886 err
= dsl_prop_inherit(zc
->zc_name
, zc
->zc_value
,
2896 zfs_ioc_pool_set_props(zfs_cmd_t
*zc
)
2903 if ((error
= get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
2904 zc
->zc_iflags
, &props
)))
2908 * If the only property is the configfile, then just do a spa_lookup()
2909 * to handle the faulted case.
2911 pair
= nvlist_next_nvpair(props
, NULL
);
2912 if (pair
!= NULL
&& strcmp(nvpair_name(pair
),
2913 zpool_prop_to_name(ZPOOL_PROP_CACHEFILE
)) == 0 &&
2914 nvlist_next_nvpair(props
, pair
) == NULL
) {
2915 mutex_enter(&spa_namespace_lock
);
2916 if ((spa
= spa_lookup(zc
->zc_name
)) != NULL
) {
2917 spa_configfile_set(spa
, props
, B_FALSE
);
2918 spa_write_cachefile(spa
, B_FALSE
, B_TRUE
);
2920 mutex_exit(&spa_namespace_lock
);
2927 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0) {
2932 error
= spa_prop_set(spa
, props
);
2935 spa_close(spa
, FTAG
);
2941 zfs_ioc_pool_get_props(zfs_cmd_t
*zc
)
2945 nvlist_t
*nvp
= NULL
;
2947 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0) {
2949 * If the pool is faulted, there may be properties we can still
2950 * get (such as altroot and cachefile), so attempt to get them
2953 mutex_enter(&spa_namespace_lock
);
2954 if ((spa
= spa_lookup(zc
->zc_name
)) != NULL
)
2955 error
= spa_prop_get(spa
, &nvp
);
2956 mutex_exit(&spa_namespace_lock
);
2958 error
= spa_prop_get(spa
, &nvp
);
2959 spa_close(spa
, FTAG
);
2962 if (error
== 0 && zc
->zc_nvlist_dst
!= 0)
2963 error
= put_nvlist(zc
, nvp
);
2965 error
= SET_ERROR(EFAULT
);
2973 * zc_name name of filesystem
2974 * zc_nvlist_src{_size} nvlist of delegated permissions
2975 * zc_perm_action allow/unallow flag
2980 zfs_ioc_set_fsacl(zfs_cmd_t
*zc
)
2983 nvlist_t
*fsaclnv
= NULL
;
2985 if ((error
= get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
2986 zc
->zc_iflags
, &fsaclnv
)) != 0)
2990 * Verify nvlist is constructed correctly
2992 if ((error
= zfs_deleg_verify_nvlist(fsaclnv
)) != 0) {
2993 nvlist_free(fsaclnv
);
2994 return (SET_ERROR(EINVAL
));
2998 * If we don't have PRIV_SYS_MOUNT, then validate
2999 * that user is allowed to hand out each permission in
3003 error
= secpolicy_zfs(CRED());
3005 if (zc
->zc_perm_action
== B_FALSE
) {
3006 error
= dsl_deleg_can_allow(zc
->zc_name
,
3009 error
= dsl_deleg_can_unallow(zc
->zc_name
,
3015 error
= dsl_deleg_set(zc
->zc_name
, fsaclnv
, zc
->zc_perm_action
);
3017 nvlist_free(fsaclnv
);
3023 * zc_name name of filesystem
3026 * zc_nvlist_src{_size} nvlist of delegated permissions
3029 zfs_ioc_get_fsacl(zfs_cmd_t
*zc
)
3034 if ((error
= dsl_deleg_get(zc
->zc_name
, &nvp
)) == 0) {
3035 error
= put_nvlist(zc
, nvp
);
3044 zfs_create_cb(objset_t
*os
, void *arg
, cred_t
*cr
, dmu_tx_t
*tx
)
3046 zfs_creat_t
*zct
= arg
;
3048 zfs_create_fs(os
, cr
, zct
->zct_zplprops
, tx
);
3051 #define ZFS_PROP_UNDEFINED ((uint64_t)-1)
3055 * os parent objset pointer (NULL if root fs)
3056 * fuids_ok fuids allowed in this version of the spa?
3057 * sa_ok SAs allowed in this version of the spa?
3058 * createprops list of properties requested by creator
3061 * zplprops values for the zplprops we attach to the master node object
3062 * is_ci true if requested file system will be purely case-insensitive
3064 * Determine the settings for utf8only, normalization and
3065 * casesensitivity. Specific values may have been requested by the
3066 * creator and/or we can inherit values from the parent dataset. If
3067 * the file system is of too early a vintage, a creator can not
3068 * request settings for these properties, even if the requested
3069 * setting is the default value. We don't actually want to create dsl
3070 * properties for these, so remove them from the source nvlist after
3074 zfs_fill_zplprops_impl(objset_t
*os
, uint64_t zplver
,
3075 boolean_t fuids_ok
, boolean_t sa_ok
, nvlist_t
*createprops
,
3076 nvlist_t
*zplprops
, boolean_t
*is_ci
)
3078 uint64_t sense
= ZFS_PROP_UNDEFINED
;
3079 uint64_t norm
= ZFS_PROP_UNDEFINED
;
3080 uint64_t u8
= ZFS_PROP_UNDEFINED
;
3083 ASSERT(zplprops
!= NULL
);
3085 if (os
!= NULL
&& os
->os_phys
->os_type
!= DMU_OST_ZFS
)
3086 return (SET_ERROR(EINVAL
));
3089 * Pull out creator prop choices, if any.
3092 (void) nvlist_lookup_uint64(createprops
,
3093 zfs_prop_to_name(ZFS_PROP_VERSION
), &zplver
);
3094 (void) nvlist_lookup_uint64(createprops
,
3095 zfs_prop_to_name(ZFS_PROP_NORMALIZE
), &norm
);
3096 (void) nvlist_remove_all(createprops
,
3097 zfs_prop_to_name(ZFS_PROP_NORMALIZE
));
3098 (void) nvlist_lookup_uint64(createprops
,
3099 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
), &u8
);
3100 (void) nvlist_remove_all(createprops
,
3101 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
));
3102 (void) nvlist_lookup_uint64(createprops
,
3103 zfs_prop_to_name(ZFS_PROP_CASE
), &sense
);
3104 (void) nvlist_remove_all(createprops
,
3105 zfs_prop_to_name(ZFS_PROP_CASE
));
3109 * If the zpl version requested is whacky or the file system
3110 * or pool is version is too "young" to support normalization
3111 * and the creator tried to set a value for one of the props,
3114 if ((zplver
< ZPL_VERSION_INITIAL
|| zplver
> ZPL_VERSION
) ||
3115 (zplver
>= ZPL_VERSION_FUID
&& !fuids_ok
) ||
3116 (zplver
>= ZPL_VERSION_SA
&& !sa_ok
) ||
3117 (zplver
< ZPL_VERSION_NORMALIZATION
&&
3118 (norm
!= ZFS_PROP_UNDEFINED
|| u8
!= ZFS_PROP_UNDEFINED
||
3119 sense
!= ZFS_PROP_UNDEFINED
)))
3120 return (SET_ERROR(ENOTSUP
));
3123 * Put the version in the zplprops
3125 VERIFY(nvlist_add_uint64(zplprops
,
3126 zfs_prop_to_name(ZFS_PROP_VERSION
), zplver
) == 0);
3128 if (norm
== ZFS_PROP_UNDEFINED
&&
3129 (error
= zfs_get_zplprop(os
, ZFS_PROP_NORMALIZE
, &norm
)) != 0)
3131 VERIFY(nvlist_add_uint64(zplprops
,
3132 zfs_prop_to_name(ZFS_PROP_NORMALIZE
), norm
) == 0);
3135 * If we're normalizing, names must always be valid UTF-8 strings.
3139 if (u8
== ZFS_PROP_UNDEFINED
&&
3140 (error
= zfs_get_zplprop(os
, ZFS_PROP_UTF8ONLY
, &u8
)) != 0)
3142 VERIFY(nvlist_add_uint64(zplprops
,
3143 zfs_prop_to_name(ZFS_PROP_UTF8ONLY
), u8
) == 0);
3145 if (sense
== ZFS_PROP_UNDEFINED
&&
3146 (error
= zfs_get_zplprop(os
, ZFS_PROP_CASE
, &sense
)) != 0)
3148 VERIFY(nvlist_add_uint64(zplprops
,
3149 zfs_prop_to_name(ZFS_PROP_CASE
), sense
) == 0);
3152 *is_ci
= (sense
== ZFS_CASE_INSENSITIVE
);
3158 zfs_fill_zplprops(const char *dataset
, nvlist_t
*createprops
,
3159 nvlist_t
*zplprops
, boolean_t
*is_ci
)
3161 boolean_t fuids_ok
, sa_ok
;
3162 uint64_t zplver
= ZPL_VERSION
;
3163 objset_t
*os
= NULL
;
3164 char parentname
[ZFS_MAX_DATASET_NAME_LEN
];
3170 (void) strlcpy(parentname
, dataset
, sizeof (parentname
));
3171 cp
= strrchr(parentname
, '/');
3175 if ((error
= spa_open(dataset
, &spa
, FTAG
)) != 0)
3178 spa_vers
= spa_version(spa
);
3179 spa_close(spa
, FTAG
);
3181 zplver
= zfs_zpl_version_map(spa_vers
);
3182 fuids_ok
= (zplver
>= ZPL_VERSION_FUID
);
3183 sa_ok
= (zplver
>= ZPL_VERSION_SA
);
3186 * Open parent object set so we can inherit zplprop values.
3188 if ((error
= dmu_objset_hold(parentname
, FTAG
, &os
)) != 0)
3191 error
= zfs_fill_zplprops_impl(os
, zplver
, fuids_ok
, sa_ok
, createprops
,
3193 dmu_objset_rele(os
, FTAG
);
3198 zfs_fill_zplprops_root(uint64_t spa_vers
, nvlist_t
*createprops
,
3199 nvlist_t
*zplprops
, boolean_t
*is_ci
)
3203 uint64_t zplver
= ZPL_VERSION
;
3206 zplver
= zfs_zpl_version_map(spa_vers
);
3207 fuids_ok
= (zplver
>= ZPL_VERSION_FUID
);
3208 sa_ok
= (zplver
>= ZPL_VERSION_SA
);
3210 error
= zfs_fill_zplprops_impl(NULL
, zplver
, fuids_ok
, sa_ok
,
3211 createprops
, zplprops
, is_ci
);
3217 * "type" -> dmu_objset_type_t (int32)
3218 * (optional) "props" -> { prop -> value }
3219 * (optional) "hidden_args" -> { "wkeydata" -> value }
3220 * raw uint8_t array of encryption wrapping key data (32 bytes)
3223 * outnvl: propname -> error code (int32)
3226 static const zfs_ioc_key_t zfs_keys_create
[] = {
3227 {"type", DATA_TYPE_INT32
, 0},
3228 {"props", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
3229 {"hidden_args", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
3233 zfs_ioc_create(const char *fsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3236 zfs_creat_t zct
= { 0 };
3237 nvlist_t
*nvprops
= NULL
;
3238 nvlist_t
*hidden_args
= NULL
;
3239 void (*cbfunc
)(objset_t
*os
, void *arg
, cred_t
*cr
, dmu_tx_t
*tx
);
3240 dmu_objset_type_t type
;
3241 boolean_t is_insensitive
= B_FALSE
;
3242 dsl_crypto_params_t
*dcp
= NULL
;
3244 type
= (dmu_objset_type_t
)fnvlist_lookup_int32(innvl
, "type");
3245 (void) nvlist_lookup_nvlist(innvl
, "props", &nvprops
);
3246 (void) nvlist_lookup_nvlist(innvl
, ZPOOL_HIDDEN_ARGS
, &hidden_args
);
3250 cbfunc
= zfs_create_cb
;
3254 cbfunc
= zvol_create_cb
;
3261 if (strchr(fsname
, '@') ||
3262 strchr(fsname
, '%'))
3263 return (SET_ERROR(EINVAL
));
3265 zct
.zct_props
= nvprops
;
3268 return (SET_ERROR(EINVAL
));
3270 if (type
== DMU_OST_ZVOL
) {
3271 uint64_t volsize
, volblocksize
;
3273 if (nvprops
== NULL
)
3274 return (SET_ERROR(EINVAL
));
3275 if (nvlist_lookup_uint64(nvprops
,
3276 zfs_prop_to_name(ZFS_PROP_VOLSIZE
), &volsize
) != 0)
3277 return (SET_ERROR(EINVAL
));
3279 if ((error
= nvlist_lookup_uint64(nvprops
,
3280 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE
),
3281 &volblocksize
)) != 0 && error
!= ENOENT
)
3282 return (SET_ERROR(EINVAL
));
3285 volblocksize
= zfs_prop_default_numeric(
3286 ZFS_PROP_VOLBLOCKSIZE
);
3288 if ((error
= zvol_check_volblocksize(fsname
,
3289 volblocksize
)) != 0 ||
3290 (error
= zvol_check_volsize(volsize
,
3291 volblocksize
)) != 0)
3293 } else if (type
== DMU_OST_ZFS
) {
3297 * We have to have normalization and
3298 * case-folding flags correct when we do the
3299 * file system creation, so go figure them out
3302 VERIFY(nvlist_alloc(&zct
.zct_zplprops
,
3303 NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
3304 error
= zfs_fill_zplprops(fsname
, nvprops
,
3305 zct
.zct_zplprops
, &is_insensitive
);
3307 nvlist_free(zct
.zct_zplprops
);
3312 error
= dsl_crypto_params_create_nvlist(DCP_CMD_NONE
, nvprops
,
3315 nvlist_free(zct
.zct_zplprops
);
3319 error
= dmu_objset_create(fsname
, type
,
3320 is_insensitive
? DS_FLAG_CI_DATASET
: 0, dcp
, cbfunc
, &zct
);
3322 nvlist_free(zct
.zct_zplprops
);
3323 dsl_crypto_params_free(dcp
, !!error
);
3326 * It would be nice to do this atomically.
3329 error
= zfs_set_prop_nvlist(fsname
, ZPROP_SRC_LOCAL
,
3336 * Volumes will return EBUSY and cannot be destroyed
3337 * until all asynchronous minor handling has completed.
3338 * Wait for the spa_zvol_taskq to drain then retry.
3340 error2
= dsl_destroy_head(fsname
);
3341 while ((error2
== EBUSY
) && (type
== DMU_OST_ZVOL
)) {
3342 error2
= spa_open(fsname
, &spa
, FTAG
);
3344 taskq_wait(spa
->spa_zvol_taskq
);
3345 spa_close(spa
, FTAG
);
3347 error2
= dsl_destroy_head(fsname
);
3356 * "origin" -> name of origin snapshot
3357 * (optional) "props" -> { prop -> value }
3358 * (optional) "hidden_args" -> { "wkeydata" -> value }
3359 * raw uint8_t array of encryption wrapping key data (32 bytes)
3363 * outnvl: propname -> error code (int32)
3365 static const zfs_ioc_key_t zfs_keys_clone
[] = {
3366 {"origin", DATA_TYPE_STRING
, 0},
3367 {"props", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
3368 {"hidden_args", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
3372 zfs_ioc_clone(const char *fsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3375 nvlist_t
*nvprops
= NULL
;
3378 origin_name
= fnvlist_lookup_string(innvl
, "origin");
3379 (void) nvlist_lookup_nvlist(innvl
, "props", &nvprops
);
3381 if (strchr(fsname
, '@') ||
3382 strchr(fsname
, '%'))
3383 return (SET_ERROR(EINVAL
));
3385 if (dataset_namecheck(origin_name
, NULL
, NULL
) != 0)
3386 return (SET_ERROR(EINVAL
));
3388 error
= dmu_objset_clone(fsname
, origin_name
);
3391 * It would be nice to do this atomically.
3394 error
= zfs_set_prop_nvlist(fsname
, ZPROP_SRC_LOCAL
,
3397 (void) dsl_destroy_head(fsname
);
3402 static const zfs_ioc_key_t zfs_keys_remap
[] = {
3408 zfs_ioc_remap(const char *fsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3410 if (strchr(fsname
, '@') ||
3411 strchr(fsname
, '%'))
3412 return (SET_ERROR(EINVAL
));
3414 return (dmu_objset_remap_indirects(fsname
));
3419 * "snaps" -> { snapshot1, snapshot2 }
3420 * (optional) "props" -> { prop -> value (string) }
3423 * outnvl: snapshot -> error code (int32)
3425 static const zfs_ioc_key_t zfs_keys_snapshot
[] = {
3426 {"snaps", DATA_TYPE_NVLIST
, 0},
3427 {"props", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
3431 zfs_ioc_snapshot(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3434 nvlist_t
*props
= NULL
;
3438 (void) nvlist_lookup_nvlist(innvl
, "props", &props
);
3439 if ((error
= zfs_check_userprops(poolname
, props
)) != 0)
3442 if (!nvlist_empty(props
) &&
3443 zfs_earlier_version(poolname
, SPA_VERSION_SNAP_PROPS
))
3444 return (SET_ERROR(ENOTSUP
));
3446 snaps
= fnvlist_lookup_nvlist(innvl
, "snaps");
3447 poollen
= strlen(poolname
);
3448 for (pair
= nvlist_next_nvpair(snaps
, NULL
); pair
!= NULL
;
3449 pair
= nvlist_next_nvpair(snaps
, pair
)) {
3450 const char *name
= nvpair_name(pair
);
3451 const char *cp
= strchr(name
, '@');
3454 * The snap name must contain an @, and the part after it must
3455 * contain only valid characters.
3458 zfs_component_namecheck(cp
+ 1, NULL
, NULL
) != 0)
3459 return (SET_ERROR(EINVAL
));
3462 * The snap must be in the specified pool.
3464 if (strncmp(name
, poolname
, poollen
) != 0 ||
3465 (name
[poollen
] != '/' && name
[poollen
] != '@'))
3466 return (SET_ERROR(EXDEV
));
3468 /* This must be the only snap of this fs. */
3469 for (nvpair_t
*pair2
= nvlist_next_nvpair(snaps
, pair
);
3470 pair2
!= NULL
; pair2
= nvlist_next_nvpair(snaps
, pair2
)) {
3471 if (strncmp(name
, nvpair_name(pair2
), cp
- name
+ 1)
3473 return (SET_ERROR(EXDEV
));
3478 error
= dsl_dataset_snapshot(snaps
, props
, outnvl
);
3484 * innvl: "message" -> string
3486 static const zfs_ioc_key_t zfs_keys_log_history
[] = {
3487 {"message", DATA_TYPE_STRING
, 0},
3492 zfs_ioc_log_history(const char *unused
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3500 * The poolname in the ioctl is not set, we get it from the TSD,
3501 * which was set at the end of the last successful ioctl that allows
3502 * logging. The secpolicy func already checked that it is set.
3503 * Only one log ioctl is allowed after each successful ioctl, so
3504 * we clear the TSD here.
3506 poolname
= tsd_get(zfs_allow_log_key
);
3507 if (poolname
== NULL
)
3508 return (SET_ERROR(EINVAL
));
3509 (void) tsd_set(zfs_allow_log_key
, NULL
);
3510 error
= spa_open(poolname
, &spa
, FTAG
);
3515 message
= fnvlist_lookup_string(innvl
, "message");
3517 if (spa_version(spa
) < SPA_VERSION_ZPOOL_HISTORY
) {
3518 spa_close(spa
, FTAG
);
3519 return (SET_ERROR(ENOTSUP
));
3522 error
= spa_history_log(spa
, message
);
3523 spa_close(spa
, FTAG
);
3528 * The dp_config_rwlock must not be held when calling this, because the
3529 * unmount may need to write out data.
3531 * This function is best-effort. Callers must deal gracefully if it
3532 * remains mounted (or is remounted after this call).
3534 * Returns 0 if the argument is not a snapshot, or it is not currently a
3535 * filesystem, or we were able to unmount it. Returns error code otherwise.
3538 zfs_unmount_snap(const char *snapname
)
3540 if (strchr(snapname
, '@') == NULL
)
3543 (void) zfsctl_snapshot_unmount((char *)snapname
, MNT_FORCE
);
3548 zfs_unmount_snap_cb(const char *snapname
, void *arg
)
3550 zfs_unmount_snap(snapname
);
3555 * When a clone is destroyed, its origin may also need to be destroyed,
3556 * in which case it must be unmounted. This routine will do that unmount
3560 zfs_destroy_unmount_origin(const char *fsname
)
3566 error
= dmu_objset_hold(fsname
, FTAG
, &os
);
3569 ds
= dmu_objset_ds(os
);
3570 if (dsl_dir_is_clone(ds
->ds_dir
) && DS_IS_DEFER_DESTROY(ds
->ds_prev
)) {
3571 char originname
[ZFS_MAX_DATASET_NAME_LEN
];
3572 dsl_dataset_name(ds
->ds_prev
, originname
);
3573 dmu_objset_rele(os
, FTAG
);
3574 zfs_unmount_snap(originname
);
3576 dmu_objset_rele(os
, FTAG
);
3582 * "snaps" -> { snapshot1, snapshot2 }
3583 * (optional boolean) "defer"
3586 * outnvl: snapshot -> error code (int32)
3588 static const zfs_ioc_key_t zfs_keys_destroy_snaps
[] = {
3589 {"snaps", DATA_TYPE_NVLIST
, 0},
3590 {"defer", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
3595 zfs_ioc_destroy_snaps(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3601 snaps
= fnvlist_lookup_nvlist(innvl
, "snaps");
3602 defer
= nvlist_exists(innvl
, "defer");
3604 for (pair
= nvlist_next_nvpair(snaps
, NULL
); pair
!= NULL
;
3605 pair
= nvlist_next_nvpair(snaps
, pair
)) {
3606 zfs_unmount_snap(nvpair_name(pair
));
3609 return (dsl_destroy_snapshots_nvl(snaps
, defer
, outnvl
));
3613 * Create bookmarks. Bookmark names are of the form <fs>#<bmark>.
3614 * All bookmarks must be in the same pool.
3617 * bookmark1 -> snapshot1, bookmark2 -> snapshot2
3620 * outnvl: bookmark -> error code (int32)
3623 static const zfs_ioc_key_t zfs_keys_bookmark
[] = {
3624 {"<bookmark>...", DATA_TYPE_STRING
, ZK_WILDCARDLIST
},
3629 zfs_ioc_bookmark(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3631 for (nvpair_t
*pair
= nvlist_next_nvpair(innvl
, NULL
);
3632 pair
!= NULL
; pair
= nvlist_next_nvpair(innvl
, pair
)) {
3636 * Verify the snapshot argument.
3638 if (nvpair_value_string(pair
, &snap_name
) != 0)
3639 return (SET_ERROR(EINVAL
));
3642 /* Verify that the keys (bookmarks) are unique */
3643 for (nvpair_t
*pair2
= nvlist_next_nvpair(innvl
, pair
);
3644 pair2
!= NULL
; pair2
= nvlist_next_nvpair(innvl
, pair2
)) {
3645 if (strcmp(nvpair_name(pair
), nvpair_name(pair2
)) == 0)
3646 return (SET_ERROR(EINVAL
));
3650 return (dsl_bookmark_create(innvl
, outnvl
));
3655 * property 1, property 2, ...
3659 * bookmark name 1 -> { property 1, property 2, ... },
3660 * bookmark name 2 -> { property 1, property 2, ... }
3664 static const zfs_ioc_key_t zfs_keys_get_bookmarks
[] = {
3665 {"<property>...", DATA_TYPE_BOOLEAN
, ZK_WILDCARDLIST
| ZK_OPTIONAL
},
3669 zfs_ioc_get_bookmarks(const char *fsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3671 return (dsl_get_bookmarks(fsname
, innvl
, outnvl
));
3676 * bookmark name 1, bookmark name 2
3679 * outnvl: bookmark -> error code (int32)
3682 static const zfs_ioc_key_t zfs_keys_destroy_bookmarks
[] = {
3683 {"<bookmark>...", DATA_TYPE_BOOLEAN
, ZK_WILDCARDLIST
},
3687 zfs_ioc_destroy_bookmarks(const char *poolname
, nvlist_t
*innvl
,
3692 poollen
= strlen(poolname
);
3693 for (nvpair_t
*pair
= nvlist_next_nvpair(innvl
, NULL
);
3694 pair
!= NULL
; pair
= nvlist_next_nvpair(innvl
, pair
)) {
3695 const char *name
= nvpair_name(pair
);
3696 const char *cp
= strchr(name
, '#');
3699 * The bookmark name must contain an #, and the part after it
3700 * must contain only valid characters.
3703 zfs_component_namecheck(cp
+ 1, NULL
, NULL
) != 0)
3704 return (SET_ERROR(EINVAL
));
3707 * The bookmark must be in the specified pool.
3709 if (strncmp(name
, poolname
, poollen
) != 0 ||
3710 (name
[poollen
] != '/' && name
[poollen
] != '#'))
3711 return (SET_ERROR(EXDEV
));
3714 error
= dsl_bookmark_destroy(innvl
, outnvl
);
3718 static const zfs_ioc_key_t zfs_keys_channel_program
[] = {
3719 {"program", DATA_TYPE_STRING
, 0},
3720 {"arg", DATA_TYPE_ANY
, 0},
3721 {"sync", DATA_TYPE_BOOLEAN_VALUE
, ZK_OPTIONAL
},
3722 {"instrlimit", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
3723 {"memlimit", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
3727 zfs_ioc_channel_program(const char *poolname
, nvlist_t
*innvl
,
3731 uint64_t instrlimit
, memlimit
;
3732 boolean_t sync_flag
;
3733 nvpair_t
*nvarg
= NULL
;
3735 program
= fnvlist_lookup_string(innvl
, ZCP_ARG_PROGRAM
);
3736 if (0 != nvlist_lookup_boolean_value(innvl
, ZCP_ARG_SYNC
, &sync_flag
)) {
3739 if (0 != nvlist_lookup_uint64(innvl
, ZCP_ARG_INSTRLIMIT
, &instrlimit
)) {
3740 instrlimit
= ZCP_DEFAULT_INSTRLIMIT
;
3742 if (0 != nvlist_lookup_uint64(innvl
, ZCP_ARG_MEMLIMIT
, &memlimit
)) {
3743 memlimit
= ZCP_DEFAULT_MEMLIMIT
;
3745 nvarg
= fnvlist_lookup_nvpair(innvl
, ZCP_ARG_ARGLIST
);
3747 if (instrlimit
== 0 || instrlimit
> zfs_lua_max_instrlimit
)
3749 if (memlimit
== 0 || memlimit
> zfs_lua_max_memlimit
)
3752 return (zcp_eval(poolname
, program
, sync_flag
, instrlimit
, memlimit
,
3760 static const zfs_ioc_key_t zfs_keys_pool_checkpoint
[] = {
3766 zfs_ioc_pool_checkpoint(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3768 return (spa_checkpoint(poolname
));
3775 static const zfs_ioc_key_t zfs_keys_pool_discard_checkpoint
[] = {
3781 zfs_ioc_pool_discard_checkpoint(const char *poolname
, nvlist_t
*innvl
,
3784 return (spa_checkpoint_discard(poolname
));
3789 * zc_name name of dataset to destroy
3790 * zc_defer_destroy mark for deferred destroy
3795 zfs_ioc_destroy(zfs_cmd_t
*zc
)
3798 dmu_objset_type_t ost
;
3801 err
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
);
3804 ost
= dmu_objset_type(os
);
3805 dmu_objset_rele(os
, FTAG
);
3807 if (ost
== DMU_OST_ZFS
)
3808 zfs_unmount_snap(zc
->zc_name
);
3810 if (strchr(zc
->zc_name
, '@')) {
3811 err
= dsl_destroy_snapshot(zc
->zc_name
, zc
->zc_defer_destroy
);
3813 err
= dsl_destroy_head(zc
->zc_name
);
3814 if (err
== EEXIST
) {
3816 * It is possible that the given DS may have
3817 * hidden child (%recv) datasets - "leftovers"
3818 * resulting from the previously interrupted
3821 * 6 extra bytes for /%recv
3823 char namebuf
[ZFS_MAX_DATASET_NAME_LEN
+ 6];
3825 if (snprintf(namebuf
, sizeof (namebuf
), "%s/%s",
3826 zc
->zc_name
, recv_clone_name
) >=
3828 return (SET_ERROR(EINVAL
));
3831 * Try to remove the hidden child (%recv) and after
3832 * that try to remove the target dataset.
3833 * If the hidden child (%recv) does not exist
3834 * the original error (EEXIST) will be returned
3836 err
= dsl_destroy_head(namebuf
);
3838 err
= dsl_destroy_head(zc
->zc_name
);
3839 else if (err
== ENOENT
)
3840 err
= SET_ERROR(EEXIST
);
3850 * guid 1, guid 2, ...
3852 * func: POOL_INITIALIZE_{CANCEL|DO|SUSPEND}
3856 * [func: EINVAL (if provided command type didn't make sense)],
3858 * guid1: errno, (see function body for possible errnos)
3864 static const zfs_ioc_key_t zfs_keys_pool_initialize
[] = {
3865 {ZPOOL_INITIALIZE_COMMAND
, DATA_TYPE_UINT64
, 0},
3866 {ZPOOL_INITIALIZE_VDEVS
, DATA_TYPE_NVLIST
, 0}
3870 zfs_ioc_pool_initialize(const char *poolname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3875 error
= spa_open(poolname
, &spa
, FTAG
);
3880 if (nvlist_lookup_uint64(innvl
, ZPOOL_INITIALIZE_COMMAND
,
3882 spa_close(spa
, FTAG
);
3883 return (SET_ERROR(EINVAL
));
3885 if (!(cmd_type
== POOL_INITIALIZE_CANCEL
||
3886 cmd_type
== POOL_INITIALIZE_DO
||
3887 cmd_type
== POOL_INITIALIZE_SUSPEND
)) {
3888 spa_close(spa
, FTAG
);
3889 return (SET_ERROR(EINVAL
));
3892 nvlist_t
*vdev_guids
;
3893 if (nvlist_lookup_nvlist(innvl
, ZPOOL_INITIALIZE_VDEVS
,
3894 &vdev_guids
) != 0) {
3895 spa_close(spa
, FTAG
);
3896 return (SET_ERROR(EINVAL
));
3899 nvlist_t
*vdev_errlist
= fnvlist_alloc();
3900 int total_errors
= 0;
3902 for (nvpair_t
*pair
= nvlist_next_nvpair(vdev_guids
, NULL
);
3903 pair
!= NULL
; pair
= nvlist_next_nvpair(vdev_guids
, pair
)) {
3904 uint64_t vdev_guid
= fnvpair_value_uint64(pair
);
3906 error
= spa_vdev_initialize(spa
, vdev_guid
, cmd_type
);
3908 char guid_as_str
[MAXNAMELEN
];
3910 (void) snprintf(guid_as_str
, sizeof (guid_as_str
),
3911 "%llu", (unsigned long long)vdev_guid
);
3912 fnvlist_add_int64(vdev_errlist
, guid_as_str
, error
);
3916 if (fnvlist_size(vdev_errlist
) > 0) {
3917 fnvlist_add_nvlist(outnvl
, ZPOOL_INITIALIZE_VDEVS
,
3920 fnvlist_free(vdev_errlist
);
3922 spa_close(spa
, FTAG
);
3923 return (total_errors
> 0 ? EINVAL
: 0);
3927 * fsname is name of dataset to rollback (to most recent snapshot)
3929 * innvl may contain name of expected target snapshot
3931 * outnvl: "target" -> name of most recent snapshot
3934 static const zfs_ioc_key_t zfs_keys_rollback
[] = {
3935 {"target", DATA_TYPE_STRING
, ZK_OPTIONAL
},
3940 zfs_ioc_rollback(const char *fsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
3944 char *target
= NULL
;
3947 (void) nvlist_lookup_string(innvl
, "target", &target
);
3948 if (target
!= NULL
) {
3949 const char *cp
= strchr(target
, '@');
3952 * The snap name must contain an @, and the part after it must
3953 * contain only valid characters.
3956 zfs_component_namecheck(cp
+ 1, NULL
, NULL
) != 0)
3957 return (SET_ERROR(EINVAL
));
3960 if (getzfsvfs(fsname
, &zfsvfs
) == 0) {
3963 ds
= dmu_objset_ds(zfsvfs
->z_os
);
3964 error
= zfs_suspend_fs(zfsvfs
);
3968 error
= dsl_dataset_rollback(fsname
, target
, zfsvfs
,
3970 resume_err
= zfs_resume_fs(zfsvfs
, ds
);
3971 error
= error
? error
: resume_err
;
3973 deactivate_super(zfsvfs
->z_sb
);
3974 } else if ((zv
= zvol_suspend(fsname
)) != NULL
) {
3975 error
= dsl_dataset_rollback(fsname
, target
, zvol_tag(zv
),
3979 error
= dsl_dataset_rollback(fsname
, target
, NULL
, outnvl
);
3985 recursive_unmount(const char *fsname
, void *arg
)
3987 const char *snapname
= arg
;
3990 fullname
= kmem_asprintf("%s@%s", fsname
, snapname
);
3991 zfs_unmount_snap(fullname
);
3999 * zc_name old name of dataset
4000 * zc_value new name of dataset
4001 * zc_cookie recursive flag (only valid for snapshots)
4006 zfs_ioc_rename(zfs_cmd_t
*zc
)
4009 dmu_objset_type_t ost
;
4010 boolean_t recursive
= zc
->zc_cookie
& 1;
4014 /* "zfs rename" from and to ...%recv datasets should both fail */
4015 zc
->zc_name
[sizeof (zc
->zc_name
) - 1] = '\0';
4016 zc
->zc_value
[sizeof (zc
->zc_value
) - 1] = '\0';
4017 if (dataset_namecheck(zc
->zc_name
, NULL
, NULL
) != 0 ||
4018 dataset_namecheck(zc
->zc_value
, NULL
, NULL
) != 0 ||
4019 strchr(zc
->zc_name
, '%') || strchr(zc
->zc_value
, '%'))
4020 return (SET_ERROR(EINVAL
));
4022 err
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
);
4025 ost
= dmu_objset_type(os
);
4026 dmu_objset_rele(os
, FTAG
);
4028 at
= strchr(zc
->zc_name
, '@');
4030 /* snaps must be in same fs */
4033 if (strncmp(zc
->zc_name
, zc
->zc_value
, at
- zc
->zc_name
+ 1))
4034 return (SET_ERROR(EXDEV
));
4036 if (ost
== DMU_OST_ZFS
) {
4037 error
= dmu_objset_find(zc
->zc_name
,
4038 recursive_unmount
, at
+ 1,
4039 recursive
? DS_FIND_CHILDREN
: 0);
4045 error
= dsl_dataset_rename_snapshot(zc
->zc_name
,
4046 at
+ 1, strchr(zc
->zc_value
, '@') + 1, recursive
);
4051 return (dsl_dir_rename(zc
->zc_name
, zc
->zc_value
));
4056 zfs_check_settable(const char *dsname
, nvpair_t
*pair
, cred_t
*cr
)
4058 const char *propname
= nvpair_name(pair
);
4059 boolean_t issnap
= (strchr(dsname
, '@') != NULL
);
4060 zfs_prop_t prop
= zfs_name_to_prop(propname
);
4064 if (prop
== ZPROP_INVAL
) {
4065 if (zfs_prop_user(propname
)) {
4066 if ((err
= zfs_secpolicy_write_perms(dsname
,
4067 ZFS_DELEG_PERM_USERPROP
, cr
)))
4072 if (!issnap
&& zfs_prop_userquota(propname
)) {
4073 const char *perm
= NULL
;
4074 const char *uq_prefix
=
4075 zfs_userquota_prop_prefixes
[ZFS_PROP_USERQUOTA
];
4076 const char *gq_prefix
=
4077 zfs_userquota_prop_prefixes
[ZFS_PROP_GROUPQUOTA
];
4078 const char *uiq_prefix
=
4079 zfs_userquota_prop_prefixes
[ZFS_PROP_USEROBJQUOTA
];
4080 const char *giq_prefix
=
4081 zfs_userquota_prop_prefixes
[ZFS_PROP_GROUPOBJQUOTA
];
4082 const char *pq_prefix
=
4083 zfs_userquota_prop_prefixes
[ZFS_PROP_PROJECTQUOTA
];
4084 const char *piq_prefix
= zfs_userquota_prop_prefixes
[\
4085 ZFS_PROP_PROJECTOBJQUOTA
];
4087 if (strncmp(propname
, uq_prefix
,
4088 strlen(uq_prefix
)) == 0) {
4089 perm
= ZFS_DELEG_PERM_USERQUOTA
;
4090 } else if (strncmp(propname
, uiq_prefix
,
4091 strlen(uiq_prefix
)) == 0) {
4092 perm
= ZFS_DELEG_PERM_USEROBJQUOTA
;
4093 } else if (strncmp(propname
, gq_prefix
,
4094 strlen(gq_prefix
)) == 0) {
4095 perm
= ZFS_DELEG_PERM_GROUPQUOTA
;
4096 } else if (strncmp(propname
, giq_prefix
,
4097 strlen(giq_prefix
)) == 0) {
4098 perm
= ZFS_DELEG_PERM_GROUPOBJQUOTA
;
4099 } else if (strncmp(propname
, pq_prefix
,
4100 strlen(pq_prefix
)) == 0) {
4101 perm
= ZFS_DELEG_PERM_PROJECTQUOTA
;
4102 } else if (strncmp(propname
, piq_prefix
,
4103 strlen(piq_prefix
)) == 0) {
4104 perm
= ZFS_DELEG_PERM_PROJECTOBJQUOTA
;
4106 /* {USER|GROUP|PROJECT}USED are read-only */
4107 return (SET_ERROR(EINVAL
));
4110 if ((err
= zfs_secpolicy_write_perms(dsname
, perm
, cr
)))
4115 return (SET_ERROR(EINVAL
));
4119 return (SET_ERROR(EINVAL
));
4121 if (nvpair_type(pair
) == DATA_TYPE_NVLIST
) {
4123 * dsl_prop_get_all_impl() returns properties in this
4127 VERIFY(nvpair_value_nvlist(pair
, &attrs
) == 0);
4128 VERIFY(nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
4133 * Check that this value is valid for this pool version
4136 case ZFS_PROP_COMPRESSION
:
4138 * If the user specified gzip compression, make sure
4139 * the SPA supports it. We ignore any errors here since
4140 * we'll catch them later.
4142 if (nvpair_value_uint64(pair
, &intval
) == 0) {
4143 if (intval
>= ZIO_COMPRESS_GZIP_1
&&
4144 intval
<= ZIO_COMPRESS_GZIP_9
&&
4145 zfs_earlier_version(dsname
,
4146 SPA_VERSION_GZIP_COMPRESSION
)) {
4147 return (SET_ERROR(ENOTSUP
));
4150 if (intval
== ZIO_COMPRESS_ZLE
&&
4151 zfs_earlier_version(dsname
,
4152 SPA_VERSION_ZLE_COMPRESSION
))
4153 return (SET_ERROR(ENOTSUP
));
4155 if (intval
== ZIO_COMPRESS_LZ4
) {
4158 if ((err
= spa_open(dsname
, &spa
, FTAG
)) != 0)
4161 if (!spa_feature_is_enabled(spa
,
4162 SPA_FEATURE_LZ4_COMPRESS
)) {
4163 spa_close(spa
, FTAG
);
4164 return (SET_ERROR(ENOTSUP
));
4166 spa_close(spa
, FTAG
);
4170 * If this is a bootable dataset then
4171 * verify that the compression algorithm
4172 * is supported for booting. We must return
4173 * something other than ENOTSUP since it
4174 * implies a downrev pool version.
4176 if (zfs_is_bootfs(dsname
) &&
4177 !BOOTFS_COMPRESS_VALID(intval
)) {
4178 return (SET_ERROR(ERANGE
));
4183 case ZFS_PROP_COPIES
:
4184 if (zfs_earlier_version(dsname
, SPA_VERSION_DITTO_BLOCKS
))
4185 return (SET_ERROR(ENOTSUP
));
4188 case ZFS_PROP_VOLBLOCKSIZE
:
4189 case ZFS_PROP_RECORDSIZE
:
4190 /* Record sizes above 128k need the feature to be enabled */
4191 if (nvpair_value_uint64(pair
, &intval
) == 0 &&
4192 intval
> SPA_OLD_MAXBLOCKSIZE
) {
4196 * We don't allow setting the property above 1MB,
4197 * unless the tunable has been changed.
4199 if (intval
> zfs_max_recordsize
||
4200 intval
> SPA_MAXBLOCKSIZE
)
4201 return (SET_ERROR(ERANGE
));
4203 if ((err
= spa_open(dsname
, &spa
, FTAG
)) != 0)
4206 if (!spa_feature_is_enabled(spa
,
4207 SPA_FEATURE_LARGE_BLOCKS
)) {
4208 spa_close(spa
, FTAG
);
4209 return (SET_ERROR(ENOTSUP
));
4211 spa_close(spa
, FTAG
);
4215 case ZFS_PROP_DNODESIZE
:
4216 /* Dnode sizes above 512 need the feature to be enabled */
4217 if (nvpair_value_uint64(pair
, &intval
) == 0 &&
4218 intval
!= ZFS_DNSIZE_LEGACY
) {
4222 * If this is a bootable dataset then
4223 * we don't allow large (>512B) dnodes,
4224 * because GRUB doesn't support them.
4226 if (zfs_is_bootfs(dsname
) &&
4227 intval
!= ZFS_DNSIZE_LEGACY
) {
4228 return (SET_ERROR(EDOM
));
4231 if ((err
= spa_open(dsname
, &spa
, FTAG
)) != 0)
4234 if (!spa_feature_is_enabled(spa
,
4235 SPA_FEATURE_LARGE_DNODE
)) {
4236 spa_close(spa
, FTAG
);
4237 return (SET_ERROR(ENOTSUP
));
4239 spa_close(spa
, FTAG
);
4243 case ZFS_PROP_SPECIAL_SMALL_BLOCKS
:
4245 * This property could require the allocation classes
4246 * feature to be active for setting, however we allow
4247 * it so that tests of settable properties succeed.
4248 * The CLI will issue a warning in this case.
4252 case ZFS_PROP_SHARESMB
:
4253 if (zpl_earlier_version(dsname
, ZPL_VERSION_FUID
))
4254 return (SET_ERROR(ENOTSUP
));
4257 case ZFS_PROP_ACLINHERIT
:
4258 if (nvpair_type(pair
) == DATA_TYPE_UINT64
&&
4259 nvpair_value_uint64(pair
, &intval
) == 0) {
4260 if (intval
== ZFS_ACL_PASSTHROUGH_X
&&
4261 zfs_earlier_version(dsname
,
4262 SPA_VERSION_PASSTHROUGH_X
))
4263 return (SET_ERROR(ENOTSUP
));
4266 case ZFS_PROP_CHECKSUM
:
4267 case ZFS_PROP_DEDUP
:
4269 spa_feature_t feature
;
4273 /* dedup feature version checks */
4274 if (prop
== ZFS_PROP_DEDUP
&&
4275 zfs_earlier_version(dsname
, SPA_VERSION_DEDUP
))
4276 return (SET_ERROR(ENOTSUP
));
4278 if (nvpair_type(pair
) == DATA_TYPE_UINT64
&&
4279 nvpair_value_uint64(pair
, &intval
) == 0) {
4280 /* check prop value is enabled in features */
4281 feature
= zio_checksum_to_feature(
4282 intval
& ZIO_CHECKSUM_MASK
);
4283 if (feature
== SPA_FEATURE_NONE
)
4286 if ((err
= spa_open(dsname
, &spa
, FTAG
)) != 0)
4289 if (!spa_feature_is_enabled(spa
, feature
)) {
4290 spa_close(spa
, FTAG
);
4291 return (SET_ERROR(ENOTSUP
));
4293 spa_close(spa
, FTAG
);
4302 return (zfs_secpolicy_setprop(dsname
, prop
, pair
, CRED()));
4306 * Removes properties from the given props list that fail permission checks
4307 * needed to clear them and to restore them in case of a receive error. For each
4308 * property, make sure we have both set and inherit permissions.
4310 * Returns the first error encountered if any permission checks fail. If the
4311 * caller provides a non-NULL errlist, it also gives the complete list of names
4312 * of all the properties that failed a permission check along with the
4313 * corresponding error numbers. The caller is responsible for freeing the
4316 * If every property checks out successfully, zero is returned and the list
4317 * pointed at by errlist is NULL.
4320 zfs_check_clearable(char *dataset
, nvlist_t
*props
, nvlist_t
**errlist
)
4323 nvpair_t
*pair
, *next_pair
;
4330 VERIFY(nvlist_alloc(&errors
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
4332 zc
= kmem_alloc(sizeof (zfs_cmd_t
), KM_SLEEP
);
4333 (void) strlcpy(zc
->zc_name
, dataset
, sizeof (zc
->zc_name
));
4334 pair
= nvlist_next_nvpair(props
, NULL
);
4335 while (pair
!= NULL
) {
4336 next_pair
= nvlist_next_nvpair(props
, pair
);
4338 (void) strlcpy(zc
->zc_value
, nvpair_name(pair
),
4339 sizeof (zc
->zc_value
));
4340 if ((err
= zfs_check_settable(dataset
, pair
, CRED())) != 0 ||
4341 (err
= zfs_secpolicy_inherit_prop(zc
, NULL
, CRED())) != 0) {
4342 VERIFY(nvlist_remove_nvpair(props
, pair
) == 0);
4343 VERIFY(nvlist_add_int32(errors
,
4344 zc
->zc_value
, err
) == 0);
4348 kmem_free(zc
, sizeof (zfs_cmd_t
));
4350 if ((pair
= nvlist_next_nvpair(errors
, NULL
)) == NULL
) {
4351 nvlist_free(errors
);
4354 VERIFY(nvpair_value_int32(pair
, &rv
) == 0);
4357 if (errlist
== NULL
)
4358 nvlist_free(errors
);
4366 propval_equals(nvpair_t
*p1
, nvpair_t
*p2
)
4368 if (nvpair_type(p1
) == DATA_TYPE_NVLIST
) {
4369 /* dsl_prop_get_all_impl() format */
4371 VERIFY(nvpair_value_nvlist(p1
, &attrs
) == 0);
4372 VERIFY(nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
4376 if (nvpair_type(p2
) == DATA_TYPE_NVLIST
) {
4378 VERIFY(nvpair_value_nvlist(p2
, &attrs
) == 0);
4379 VERIFY(nvlist_lookup_nvpair(attrs
, ZPROP_VALUE
,
4383 if (nvpair_type(p1
) != nvpair_type(p2
))
4386 if (nvpair_type(p1
) == DATA_TYPE_STRING
) {
4387 char *valstr1
, *valstr2
;
4389 VERIFY(nvpair_value_string(p1
, (char **)&valstr1
) == 0);
4390 VERIFY(nvpair_value_string(p2
, (char **)&valstr2
) == 0);
4391 return (strcmp(valstr1
, valstr2
) == 0);
4393 uint64_t intval1
, intval2
;
4395 VERIFY(nvpair_value_uint64(p1
, &intval1
) == 0);
4396 VERIFY(nvpair_value_uint64(p2
, &intval2
) == 0);
4397 return (intval1
== intval2
);
4402 * Remove properties from props if they are not going to change (as determined
4403 * by comparison with origprops). Remove them from origprops as well, since we
4404 * do not need to clear or restore properties that won't change.
4407 props_reduce(nvlist_t
*props
, nvlist_t
*origprops
)
4409 nvpair_t
*pair
, *next_pair
;
4411 if (origprops
== NULL
)
4412 return; /* all props need to be received */
4414 pair
= nvlist_next_nvpair(props
, NULL
);
4415 while (pair
!= NULL
) {
4416 const char *propname
= nvpair_name(pair
);
4419 next_pair
= nvlist_next_nvpair(props
, pair
);
4421 if ((nvlist_lookup_nvpair(origprops
, propname
,
4422 &match
) != 0) || !propval_equals(pair
, match
))
4423 goto next
; /* need to set received value */
4425 /* don't clear the existing received value */
4426 (void) nvlist_remove_nvpair(origprops
, match
);
4427 /* don't bother receiving the property */
4428 (void) nvlist_remove_nvpair(props
, pair
);
4435 * Extract properties that cannot be set PRIOR to the receipt of a dataset.
4436 * For example, refquota cannot be set until after the receipt of a dataset,
4437 * because in replication streams, an older/earlier snapshot may exceed the
4438 * refquota. We want to receive the older/earlier snapshot, but setting
4439 * refquota pre-receipt will set the dsl's ACTUAL quota, which will prevent
4440 * the older/earlier snapshot from being received (with EDQUOT).
4442 * The ZFS test "zfs_receive_011_pos" demonstrates such a scenario.
4444 * libzfs will need to be judicious handling errors encountered by props
4445 * extracted by this function.
4448 extract_delay_props(nvlist_t
*props
)
4450 nvlist_t
*delayprops
;
4451 nvpair_t
*nvp
, *tmp
;
4452 static const zfs_prop_t delayable
[] = {
4454 ZFS_PROP_KEYLOCATION
,
4459 VERIFY(nvlist_alloc(&delayprops
, NV_UNIQUE_NAME
, KM_SLEEP
) == 0);
4461 for (nvp
= nvlist_next_nvpair(props
, NULL
); nvp
!= NULL
;
4462 nvp
= nvlist_next_nvpair(props
, nvp
)) {
4464 * strcmp() is safe because zfs_prop_to_name() always returns
4467 for (i
= 0; delayable
[i
] != 0; i
++) {
4468 if (strcmp(zfs_prop_to_name(delayable
[i
]),
4469 nvpair_name(nvp
)) == 0) {
4473 if (delayable
[i
] != 0) {
4474 tmp
= nvlist_prev_nvpair(props
, nvp
);
4475 VERIFY(nvlist_add_nvpair(delayprops
, nvp
) == 0);
4476 VERIFY(nvlist_remove_nvpair(props
, nvp
) == 0);
4481 if (nvlist_empty(delayprops
)) {
4482 nvlist_free(delayprops
);
4485 return (delayprops
);
4489 static boolean_t zfs_ioc_recv_inject_err
;
4493 * nvlist 'errors' is always allocated. It will contain descriptions of
4494 * encountered errors, if any. It's the callers responsibility to free.
4497 zfs_ioc_recv_impl(char *tofs
, char *tosnap
, char *origin
, nvlist_t
*recvprops
,
4498 nvlist_t
*localprops
, nvlist_t
*hidden_args
, boolean_t force
,
4499 boolean_t resumable
, int input_fd
, dmu_replay_record_t
*begin_record
,
4500 int cleanup_fd
, uint64_t *read_bytes
, uint64_t *errflags
,
4501 uint64_t *action_handle
, nvlist_t
**errors
)
4503 dmu_recv_cookie_t drc
;
4505 int props_error
= 0;
4507 nvlist_t
*local_delayprops
= NULL
;
4508 nvlist_t
*recv_delayprops
= NULL
;
4509 nvlist_t
*origprops
= NULL
; /* existing properties */
4510 nvlist_t
*origrecvd
= NULL
; /* existing received properties */
4511 boolean_t first_recvd_props
= B_FALSE
;
4516 *errors
= fnvlist_alloc();
4518 input_fp
= getf(input_fd
);
4519 if (input_fp
== NULL
)
4520 return (SET_ERROR(EBADF
));
4522 error
= dmu_recv_begin(tofs
, tosnap
, begin_record
, force
,
4523 resumable
, localprops
, hidden_args
, origin
, &drc
);
4528 * Set properties before we receive the stream so that they are applied
4529 * to the new data. Note that we must call dmu_recv_stream() if
4530 * dmu_recv_begin() succeeds.
4532 if (recvprops
!= NULL
&& !drc
.drc_newfs
) {
4533 if (spa_version(dsl_dataset_get_spa(drc
.drc_ds
)) >=
4534 SPA_VERSION_RECVD_PROPS
&&
4535 !dsl_prop_get_hasrecvd(tofs
))
4536 first_recvd_props
= B_TRUE
;
4539 * If new received properties are supplied, they are to
4540 * completely replace the existing received properties,
4541 * so stash away the existing ones.
4543 if (dsl_prop_get_received(tofs
, &origrecvd
) == 0) {
4544 nvlist_t
*errlist
= NULL
;
4546 * Don't bother writing a property if its value won't
4547 * change (and avoid the unnecessary security checks).
4549 * The first receive after SPA_VERSION_RECVD_PROPS is a
4550 * special case where we blow away all local properties
4553 if (!first_recvd_props
)
4554 props_reduce(recvprops
, origrecvd
);
4555 if (zfs_check_clearable(tofs
, origrecvd
, &errlist
) != 0)
4556 (void) nvlist_merge(*errors
, errlist
, 0);
4557 nvlist_free(errlist
);
4559 if (clear_received_props(tofs
, origrecvd
,
4560 first_recvd_props
? NULL
: recvprops
) != 0)
4561 *errflags
|= ZPROP_ERR_NOCLEAR
;
4563 *errflags
|= ZPROP_ERR_NOCLEAR
;
4568 * Stash away existing properties so we can restore them on error unless
4569 * we're doing the first receive after SPA_VERSION_RECVD_PROPS, in which
4570 * case "origrecvd" will take care of that.
4572 if (localprops
!= NULL
&& !drc
.drc_newfs
&& !first_recvd_props
) {
4574 if (dmu_objset_hold(tofs
, FTAG
, &os
) == 0) {
4575 if (dsl_prop_get_all(os
, &origprops
) != 0) {
4576 *errflags
|= ZPROP_ERR_NOCLEAR
;
4578 dmu_objset_rele(os
, FTAG
);
4580 *errflags
|= ZPROP_ERR_NOCLEAR
;
4584 if (recvprops
!= NULL
) {
4585 props_error
= dsl_prop_set_hasrecvd(tofs
);
4587 if (props_error
== 0) {
4588 recv_delayprops
= extract_delay_props(recvprops
);
4589 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_RECEIVED
,
4590 recvprops
, *errors
);
4594 if (localprops
!= NULL
) {
4595 nvlist_t
*oprops
= fnvlist_alloc();
4596 nvlist_t
*xprops
= fnvlist_alloc();
4597 nvpair_t
*nvp
= NULL
;
4599 while ((nvp
= nvlist_next_nvpair(localprops
, nvp
)) != NULL
) {
4600 if (nvpair_type(nvp
) == DATA_TYPE_BOOLEAN
) {
4602 const char *name
= nvpair_name(nvp
);
4603 zfs_prop_t prop
= zfs_name_to_prop(name
);
4604 if (prop
!= ZPROP_INVAL
) {
4605 if (!zfs_prop_inheritable(prop
))
4607 } else if (!zfs_prop_user(name
))
4609 fnvlist_add_boolean(xprops
, name
);
4611 /* -o property=value */
4612 fnvlist_add_nvpair(oprops
, nvp
);
4616 local_delayprops
= extract_delay_props(oprops
);
4617 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_LOCAL
,
4619 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_INHERITED
,
4622 nvlist_free(oprops
);
4623 nvlist_free(xprops
);
4626 off
= input_fp
->f_offset
;
4627 error
= dmu_recv_stream(&drc
, input_fp
->f_vnode
, &off
, cleanup_fd
,
4631 zfsvfs_t
*zfsvfs
= NULL
;
4632 zvol_state_t
*zv
= NULL
;
4634 if (getzfsvfs(tofs
, &zfsvfs
) == 0) {
4639 ds
= dmu_objset_ds(zfsvfs
->z_os
);
4640 error
= zfs_suspend_fs(zfsvfs
);
4642 * If the suspend fails, then the recv_end will
4643 * likely also fail, and clean up after itself.
4645 end_err
= dmu_recv_end(&drc
, zfsvfs
);
4647 error
= zfs_resume_fs(zfsvfs
, ds
);
4648 error
= error
? error
: end_err
;
4649 deactivate_super(zfsvfs
->z_sb
);
4650 } else if ((zv
= zvol_suspend(tofs
)) != NULL
) {
4651 error
= dmu_recv_end(&drc
, zvol_tag(zv
));
4654 error
= dmu_recv_end(&drc
, NULL
);
4657 /* Set delayed properties now, after we're done receiving. */
4658 if (recv_delayprops
!= NULL
&& error
== 0) {
4659 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_RECEIVED
,
4660 recv_delayprops
, *errors
);
4662 if (local_delayprops
!= NULL
&& error
== 0) {
4663 (void) zfs_set_prop_nvlist(tofs
, ZPROP_SRC_LOCAL
,
4664 local_delayprops
, *errors
);
4669 * Merge delayed props back in with initial props, in case
4670 * we're DEBUG and zfs_ioc_recv_inject_err is set (which means
4671 * we have to make sure clear_received_props() includes
4672 * the delayed properties).
4674 * Since zfs_ioc_recv_inject_err is only in DEBUG kernels,
4675 * using ASSERT() will be just like a VERIFY.
4677 if (recv_delayprops
!= NULL
) {
4678 ASSERT(nvlist_merge(recvprops
, recv_delayprops
, 0) == 0);
4679 nvlist_free(recv_delayprops
);
4681 if (local_delayprops
!= NULL
) {
4682 ASSERT(nvlist_merge(localprops
, local_delayprops
, 0) == 0);
4683 nvlist_free(local_delayprops
);
4686 *read_bytes
= off
- input_fp
->f_offset
;
4687 if (VOP_SEEK(input_fp
->f_vnode
, input_fp
->f_offset
, &off
, NULL
) == 0)
4688 input_fp
->f_offset
= off
;
4691 if (zfs_ioc_recv_inject_err
) {
4692 zfs_ioc_recv_inject_err
= B_FALSE
;
4698 * On error, restore the original props.
4700 if (error
!= 0 && recvprops
!= NULL
&& !drc
.drc_newfs
) {
4701 if (clear_received_props(tofs
, recvprops
, NULL
) != 0) {
4703 * We failed to clear the received properties.
4704 * Since we may have left a $recvd value on the
4705 * system, we can't clear the $hasrecvd flag.
4707 *errflags
|= ZPROP_ERR_NORESTORE
;
4708 } else if (first_recvd_props
) {
4709 dsl_prop_unset_hasrecvd(tofs
);
4712 if (origrecvd
== NULL
&& !drc
.drc_newfs
) {
4713 /* We failed to stash the original properties. */
4714 *errflags
|= ZPROP_ERR_NORESTORE
;
4718 * dsl_props_set() will not convert RECEIVED to LOCAL on or
4719 * after SPA_VERSION_RECVD_PROPS, so we need to specify LOCAL
4720 * explicitly if we're restoring local properties cleared in the
4721 * first new-style receive.
4723 if (origrecvd
!= NULL
&&
4724 zfs_set_prop_nvlist(tofs
, (first_recvd_props
?
4725 ZPROP_SRC_LOCAL
: ZPROP_SRC_RECEIVED
),
4726 origrecvd
, NULL
) != 0) {
4728 * We stashed the original properties but failed to
4731 *errflags
|= ZPROP_ERR_NORESTORE
;
4734 if (error
!= 0 && localprops
!= NULL
&& !drc
.drc_newfs
&&
4735 !first_recvd_props
) {
4737 nvlist_t
*inheritprops
;
4740 if (origprops
== NULL
) {
4741 /* We failed to stash the original properties. */
4742 *errflags
|= ZPROP_ERR_NORESTORE
;
4746 /* Restore original props */
4747 setprops
= fnvlist_alloc();
4748 inheritprops
= fnvlist_alloc();
4750 while ((nvp
= nvlist_next_nvpair(localprops
, nvp
)) != NULL
) {
4751 const char *name
= nvpair_name(nvp
);
4755 if (!nvlist_exists(origprops
, name
)) {
4757 * Property was not present or was explicitly
4758 * inherited before the receive, restore this.
4760 fnvlist_add_boolean(inheritprops
, name
);
4763 attrs
= fnvlist_lookup_nvlist(origprops
, name
);
4764 source
= fnvlist_lookup_string(attrs
, ZPROP_SOURCE
);
4766 /* Skip received properties */
4767 if (strcmp(source
, ZPROP_SOURCE_VAL_RECVD
) == 0)
4770 if (strcmp(source
, tofs
) == 0) {
4771 /* Property was locally set */
4772 fnvlist_add_nvlist(setprops
, name
, attrs
);
4774 /* Property was implicitly inherited */
4775 fnvlist_add_boolean(inheritprops
, name
);
4779 if (zfs_set_prop_nvlist(tofs
, ZPROP_SRC_LOCAL
, setprops
,
4781 *errflags
|= ZPROP_ERR_NORESTORE
;
4782 if (zfs_set_prop_nvlist(tofs
, ZPROP_SRC_INHERITED
, inheritprops
,
4784 *errflags
|= ZPROP_ERR_NORESTORE
;
4786 nvlist_free(setprops
);
4787 nvlist_free(inheritprops
);
4791 nvlist_free(origrecvd
);
4792 nvlist_free(origprops
);
4795 error
= props_error
;
4802 * zc_name name of containing filesystem (unused)
4803 * zc_nvlist_src{_size} nvlist of properties to apply
4804 * zc_nvlist_conf{_size} nvlist of properties to exclude
4805 * (DATA_TYPE_BOOLEAN) and override (everything else)
4806 * zc_value name of snapshot to create
4807 * zc_string name of clone origin (if DRR_FLAG_CLONE)
4808 * zc_cookie file descriptor to recv from
4809 * zc_begin_record the BEGIN record of the stream (not byteswapped)
4810 * zc_guid force flag
4811 * zc_cleanup_fd cleanup-on-exit file descriptor
4812 * zc_action_handle handle for this guid/ds mapping (or zero on first call)
4815 * zc_cookie number of bytes read
4816 * zc_obj zprop_errflags_t
4817 * zc_action_handle handle for this guid/ds mapping
4818 * zc_nvlist_dst{_size} error for each unapplied received property
4821 zfs_ioc_recv(zfs_cmd_t
*zc
)
4823 dmu_replay_record_t begin_record
;
4824 nvlist_t
*errors
= NULL
;
4825 nvlist_t
*recvdprops
= NULL
;
4826 nvlist_t
*localprops
= NULL
;
4827 char *origin
= NULL
;
4829 char tofs
[ZFS_MAX_DATASET_NAME_LEN
];
4832 if (dataset_namecheck(zc
->zc_value
, NULL
, NULL
) != 0 ||
4833 strchr(zc
->zc_value
, '@') == NULL
||
4834 strchr(zc
->zc_value
, '%'))
4835 return (SET_ERROR(EINVAL
));
4837 (void) strlcpy(tofs
, zc
->zc_value
, sizeof (tofs
));
4838 tosnap
= strchr(tofs
, '@');
4841 if (zc
->zc_nvlist_src
!= 0 &&
4842 (error
= get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
4843 zc
->zc_iflags
, &recvdprops
)) != 0)
4846 if (zc
->zc_nvlist_conf
!= 0 &&
4847 (error
= get_nvlist(zc
->zc_nvlist_conf
, zc
->zc_nvlist_conf_size
,
4848 zc
->zc_iflags
, &localprops
)) != 0)
4851 if (zc
->zc_string
[0])
4852 origin
= zc
->zc_string
;
4854 begin_record
.drr_type
= DRR_BEGIN
;
4855 begin_record
.drr_payloadlen
= 0;
4856 begin_record
.drr_u
.drr_begin
= zc
->zc_begin_record
;
4858 error
= zfs_ioc_recv_impl(tofs
, tosnap
, origin
, recvdprops
, localprops
,
4859 NULL
, zc
->zc_guid
, B_FALSE
, zc
->zc_cookie
, &begin_record
,
4860 zc
->zc_cleanup_fd
, &zc
->zc_cookie
, &zc
->zc_obj
,
4861 &zc
->zc_action_handle
, &errors
);
4862 nvlist_free(recvdprops
);
4863 nvlist_free(localprops
);
4866 * Now that all props, initial and delayed, are set, report the prop
4867 * errors to the caller.
4869 if (zc
->zc_nvlist_dst_size
!= 0 && errors
!= NULL
&&
4870 (nvlist_smush(errors
, zc
->zc_nvlist_dst_size
) != 0 ||
4871 put_nvlist(zc
, errors
) != 0)) {
4873 * Caller made zc->zc_nvlist_dst less than the minimum expected
4874 * size or supplied an invalid address.
4876 error
= SET_ERROR(EINVAL
);
4879 nvlist_free(errors
);
4886 * "snapname" -> full name of the snapshot to create
4887 * (optional) "props" -> received properties to set (nvlist)
4888 * (optional) "localprops" -> override and exclude properties (nvlist)
4889 * (optional) "origin" -> name of clone origin (DRR_FLAG_CLONE)
4890 * "begin_record" -> non-byteswapped dmu_replay_record_t
4891 * "input_fd" -> file descriptor to read stream from (int32)
4892 * (optional) "force" -> force flag (value ignored)
4893 * (optional) "resumable" -> resumable flag (value ignored)
4894 * (optional) "cleanup_fd" -> cleanup-on-exit file descriptor
4895 * (optional) "action_handle" -> handle for this guid/ds mapping
4896 * (optional) "hidden_args" -> { "wkeydata" -> value }
4900 * "read_bytes" -> number of bytes read
4901 * "error_flags" -> zprop_errflags_t
4902 * "action_handle" -> handle for this guid/ds mapping
4903 * "errors" -> error for each unapplied received property (nvlist)
4906 static const zfs_ioc_key_t zfs_keys_recv_new
[] = {
4907 {"snapname", DATA_TYPE_STRING
, 0},
4908 {"props", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
4909 {"localprops", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
4910 {"origin", DATA_TYPE_STRING
, ZK_OPTIONAL
},
4911 {"begin_record", DATA_TYPE_BYTE_ARRAY
, 0},
4912 {"input_fd", DATA_TYPE_INT32
, 0},
4913 {"force", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
4914 {"resumable", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
4915 {"cleanup_fd", DATA_TYPE_INT32
, ZK_OPTIONAL
},
4916 {"action_handle", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
4917 {"hidden_args", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
4921 zfs_ioc_recv_new(const char *fsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
4923 dmu_replay_record_t
*begin_record
;
4924 uint_t begin_record_size
;
4925 nvlist_t
*errors
= NULL
;
4926 nvlist_t
*recvprops
= NULL
;
4927 nvlist_t
*localprops
= NULL
;
4928 nvlist_t
*hidden_args
= NULL
;
4930 char *origin
= NULL
;
4932 char tofs
[ZFS_MAX_DATASET_NAME_LEN
];
4934 boolean_t resumable
;
4935 uint64_t action_handle
= 0;
4936 uint64_t read_bytes
= 0;
4937 uint64_t errflags
= 0;
4939 int cleanup_fd
= -1;
4942 snapname
= fnvlist_lookup_string(innvl
, "snapname");
4944 if (dataset_namecheck(snapname
, NULL
, NULL
) != 0 ||
4945 strchr(snapname
, '@') == NULL
||
4946 strchr(snapname
, '%'))
4947 return (SET_ERROR(EINVAL
));
4949 (void) strcpy(tofs
, snapname
);
4950 tosnap
= strchr(tofs
, '@');
4953 error
= nvlist_lookup_string(innvl
, "origin", &origin
);
4954 if (error
&& error
!= ENOENT
)
4957 error
= nvlist_lookup_byte_array(innvl
, "begin_record",
4958 (uchar_t
**)&begin_record
, &begin_record_size
);
4959 if (error
!= 0 || begin_record_size
!= sizeof (*begin_record
))
4960 return (SET_ERROR(EINVAL
));
4962 input_fd
= fnvlist_lookup_int32(innvl
, "input_fd");
4964 force
= nvlist_exists(innvl
, "force");
4965 resumable
= nvlist_exists(innvl
, "resumable");
4967 error
= nvlist_lookup_int32(innvl
, "cleanup_fd", &cleanup_fd
);
4968 if (error
&& error
!= ENOENT
)
4971 error
= nvlist_lookup_uint64(innvl
, "action_handle", &action_handle
);
4972 if (error
&& error
!= ENOENT
)
4975 /* we still use "props" here for backwards compatibility */
4976 error
= nvlist_lookup_nvlist(innvl
, "props", &recvprops
);
4977 if (error
&& error
!= ENOENT
)
4980 error
= nvlist_lookup_nvlist(innvl
, "localprops", &localprops
);
4981 if (error
&& error
!= ENOENT
)
4984 error
= nvlist_lookup_nvlist(innvl
, ZPOOL_HIDDEN_ARGS
, &hidden_args
);
4985 if (error
&& error
!= ENOENT
)
4988 error
= zfs_ioc_recv_impl(tofs
, tosnap
, origin
, recvprops
, localprops
,
4989 hidden_args
, force
, resumable
, input_fd
, begin_record
, cleanup_fd
,
4990 &read_bytes
, &errflags
, &action_handle
, &errors
);
4992 fnvlist_add_uint64(outnvl
, "read_bytes", read_bytes
);
4993 fnvlist_add_uint64(outnvl
, "error_flags", errflags
);
4994 fnvlist_add_uint64(outnvl
, "action_handle", action_handle
);
4995 fnvlist_add_nvlist(outnvl
, "errors", errors
);
4997 nvlist_free(errors
);
4998 nvlist_free(recvprops
);
4999 nvlist_free(localprops
);
5006 * zc_name name of snapshot to send
5007 * zc_cookie file descriptor to send stream to
5008 * zc_obj fromorigin flag (mutually exclusive with zc_fromobj)
5009 * zc_sendobj objsetid of snapshot to send
5010 * zc_fromobj objsetid of incremental fromsnap (may be zero)
5011 * zc_guid if set, estimate size of stream only. zc_cookie is ignored.
5012 * output size in zc_objset_type.
5013 * zc_flags lzc_send_flags
5016 * zc_objset_type estimated size, if zc_guid is set
5018 * NOTE: This is no longer the preferred interface, any new functionality
5019 * should be added to zfs_ioc_send_new() instead.
5022 zfs_ioc_send(zfs_cmd_t
*zc
)
5026 boolean_t estimate
= (zc
->zc_guid
!= 0);
5027 boolean_t embedok
= (zc
->zc_flags
& 0x1);
5028 boolean_t large_block_ok
= (zc
->zc_flags
& 0x2);
5029 boolean_t compressok
= (zc
->zc_flags
& 0x4);
5030 boolean_t rawok
= (zc
->zc_flags
& 0x8);
5032 if (zc
->zc_obj
!= 0) {
5034 dsl_dataset_t
*tosnap
;
5036 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
5040 error
= dsl_dataset_hold_obj(dp
, zc
->zc_sendobj
, FTAG
, &tosnap
);
5042 dsl_pool_rele(dp
, FTAG
);
5046 if (dsl_dir_is_clone(tosnap
->ds_dir
))
5048 dsl_dir_phys(tosnap
->ds_dir
)->dd_origin_obj
;
5049 dsl_dataset_rele(tosnap
, FTAG
);
5050 dsl_pool_rele(dp
, FTAG
);
5055 dsl_dataset_t
*tosnap
;
5056 dsl_dataset_t
*fromsnap
= NULL
;
5058 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
5062 error
= dsl_dataset_hold_obj(dp
, zc
->zc_sendobj
,
5065 dsl_pool_rele(dp
, FTAG
);
5069 if (zc
->zc_fromobj
!= 0) {
5070 error
= dsl_dataset_hold_obj(dp
, zc
->zc_fromobj
,
5073 dsl_dataset_rele(tosnap
, FTAG
);
5074 dsl_pool_rele(dp
, FTAG
);
5079 error
= dmu_send_estimate(tosnap
, fromsnap
, compressok
|| rawok
,
5080 &zc
->zc_objset_type
);
5082 if (fromsnap
!= NULL
)
5083 dsl_dataset_rele(fromsnap
, FTAG
);
5084 dsl_dataset_rele(tosnap
, FTAG
);
5085 dsl_pool_rele(dp
, FTAG
);
5087 file_t
*fp
= getf(zc
->zc_cookie
);
5089 return (SET_ERROR(EBADF
));
5092 error
= dmu_send_obj(zc
->zc_name
, zc
->zc_sendobj
,
5093 zc
->zc_fromobj
, embedok
, large_block_ok
, compressok
, rawok
,
5094 zc
->zc_cookie
, fp
->f_vnode
, &off
);
5096 if (VOP_SEEK(fp
->f_vnode
, fp
->f_offset
, &off
, NULL
) == 0)
5098 releasef(zc
->zc_cookie
);
5105 * zc_name name of snapshot on which to report progress
5106 * zc_cookie file descriptor of send stream
5109 * zc_cookie number of bytes written in send stream thus far
5112 zfs_ioc_send_progress(zfs_cmd_t
*zc
)
5116 dmu_sendarg_t
*dsp
= NULL
;
5119 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
5123 error
= dsl_dataset_hold(dp
, zc
->zc_name
, FTAG
, &ds
);
5125 dsl_pool_rele(dp
, FTAG
);
5129 mutex_enter(&ds
->ds_sendstream_lock
);
5132 * Iterate over all the send streams currently active on this dataset.
5133 * If there's one which matches the specified file descriptor _and_ the
5134 * stream was started by the current process, return the progress of
5138 for (dsp
= list_head(&ds
->ds_sendstreams
); dsp
!= NULL
;
5139 dsp
= list_next(&ds
->ds_sendstreams
, dsp
)) {
5140 if (dsp
->dsa_outfd
== zc
->zc_cookie
&&
5141 dsp
->dsa_proc
->group_leader
== curproc
->group_leader
)
5146 zc
->zc_cookie
= *(dsp
->dsa_off
);
5148 error
= SET_ERROR(ENOENT
);
5150 mutex_exit(&ds
->ds_sendstream_lock
);
5151 dsl_dataset_rele(ds
, FTAG
);
5152 dsl_pool_rele(dp
, FTAG
);
5157 zfs_ioc_inject_fault(zfs_cmd_t
*zc
)
5161 error
= zio_inject_fault(zc
->zc_name
, (int)zc
->zc_guid
, &id
,
5162 &zc
->zc_inject_record
);
5165 zc
->zc_guid
= (uint64_t)id
;
5171 zfs_ioc_clear_fault(zfs_cmd_t
*zc
)
5173 return (zio_clear_fault((int)zc
->zc_guid
));
5177 zfs_ioc_inject_list_next(zfs_cmd_t
*zc
)
5179 int id
= (int)zc
->zc_guid
;
5182 error
= zio_inject_list_next(&id
, zc
->zc_name
, sizeof (zc
->zc_name
),
5183 &zc
->zc_inject_record
);
5191 zfs_ioc_error_log(zfs_cmd_t
*zc
)
5195 size_t count
= (size_t)zc
->zc_nvlist_dst_size
;
5197 if ((error
= spa_open(zc
->zc_name
, &spa
, FTAG
)) != 0)
5200 error
= spa_get_errlog(spa
, (void *)(uintptr_t)zc
->zc_nvlist_dst
,
5203 zc
->zc_nvlist_dst_size
= count
;
5205 zc
->zc_nvlist_dst_size
= spa_get_errlog_size(spa
);
5207 spa_close(spa
, FTAG
);
5213 zfs_ioc_clear(zfs_cmd_t
*zc
)
5220 * On zpool clear we also fix up missing slogs
5222 mutex_enter(&spa_namespace_lock
);
5223 spa
= spa_lookup(zc
->zc_name
);
5225 mutex_exit(&spa_namespace_lock
);
5226 return (SET_ERROR(EIO
));
5228 if (spa_get_log_state(spa
) == SPA_LOG_MISSING
) {
5229 /* we need to let spa_open/spa_load clear the chains */
5230 spa_set_log_state(spa
, SPA_LOG_CLEAR
);
5232 spa
->spa_last_open_failed
= 0;
5233 mutex_exit(&spa_namespace_lock
);
5235 if (zc
->zc_cookie
& ZPOOL_NO_REWIND
) {
5236 error
= spa_open(zc
->zc_name
, &spa
, FTAG
);
5239 nvlist_t
*config
= NULL
;
5241 if (zc
->zc_nvlist_src
== 0)
5242 return (SET_ERROR(EINVAL
));
5244 if ((error
= get_nvlist(zc
->zc_nvlist_src
,
5245 zc
->zc_nvlist_src_size
, zc
->zc_iflags
, &policy
)) == 0) {
5246 error
= spa_open_rewind(zc
->zc_name
, &spa
, FTAG
,
5248 if (config
!= NULL
) {
5251 if ((err
= put_nvlist(zc
, config
)) != 0)
5253 nvlist_free(config
);
5255 nvlist_free(policy
);
5262 spa_vdev_state_enter(spa
, SCL_NONE
);
5264 if (zc
->zc_guid
== 0) {
5267 vd
= spa_lookup_by_guid(spa
, zc
->zc_guid
, B_TRUE
);
5269 (void) spa_vdev_state_exit(spa
, NULL
, ENODEV
);
5270 spa_close(spa
, FTAG
);
5271 return (SET_ERROR(ENODEV
));
5275 vdev_clear(spa
, vd
);
5277 (void) spa_vdev_state_exit(spa
, spa_suspended(spa
) ?
5278 NULL
: spa
->spa_root_vdev
, 0);
5281 * Resume any suspended I/Os.
5283 if (zio_resume(spa
) != 0)
5284 error
= SET_ERROR(EIO
);
5286 spa_close(spa
, FTAG
);
5292 * Reopen all the vdevs associated with the pool.
5295 * "scrub_restart" -> when true and scrub is running, allow to restart
5296 * scrub as the side effect of the reopen (boolean).
5301 static const zfs_ioc_key_t zfs_keys_pool_reopen
[] = {
5302 {"scrub_restart", DATA_TYPE_BOOLEAN_VALUE
, 0},
5307 zfs_ioc_pool_reopen(const char *pool
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
5311 boolean_t scrub_restart
= B_TRUE
;
5314 scrub_restart
= fnvlist_lookup_boolean_value(innvl
,
5318 error
= spa_open(pool
, &spa
, FTAG
);
5322 spa_vdev_state_enter(spa
, SCL_NONE
);
5325 * If the scrub_restart flag is B_FALSE and a scrub is already
5326 * in progress then set spa_scrub_reopen flag to B_TRUE so that
5327 * we don't restart the scrub as a side effect of the reopen.
5328 * Otherwise, let vdev_open() decided if a resilver is required.
5331 spa
->spa_scrub_reopen
= (!scrub_restart
&&
5332 dsl_scan_scrubbing(spa
->spa_dsl_pool
));
5333 vdev_reopen(spa
->spa_root_vdev
);
5334 spa
->spa_scrub_reopen
= B_FALSE
;
5336 (void) spa_vdev_state_exit(spa
, NULL
, 0);
5337 spa_close(spa
, FTAG
);
5343 * zc_name name of filesystem
5346 * zc_string name of conflicting snapshot, if there is one
5349 zfs_ioc_promote(zfs_cmd_t
*zc
)
5352 dsl_dataset_t
*ds
, *ods
;
5353 char origin
[ZFS_MAX_DATASET_NAME_LEN
];
5357 zc
->zc_name
[sizeof (zc
->zc_name
) - 1] = '\0';
5358 if (dataset_namecheck(zc
->zc_name
, NULL
, NULL
) != 0 ||
5359 strchr(zc
->zc_name
, '%'))
5360 return (SET_ERROR(EINVAL
));
5362 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
5366 error
= dsl_dataset_hold(dp
, zc
->zc_name
, FTAG
, &ds
);
5368 dsl_pool_rele(dp
, FTAG
);
5372 if (!dsl_dir_is_clone(ds
->ds_dir
)) {
5373 dsl_dataset_rele(ds
, FTAG
);
5374 dsl_pool_rele(dp
, FTAG
);
5375 return (SET_ERROR(EINVAL
));
5378 error
= dsl_dataset_hold_obj(dp
,
5379 dsl_dir_phys(ds
->ds_dir
)->dd_origin_obj
, FTAG
, &ods
);
5381 dsl_dataset_rele(ds
, FTAG
);
5382 dsl_pool_rele(dp
, FTAG
);
5386 dsl_dataset_name(ods
, origin
);
5387 dsl_dataset_rele(ods
, FTAG
);
5388 dsl_dataset_rele(ds
, FTAG
);
5389 dsl_pool_rele(dp
, FTAG
);
5392 * We don't need to unmount *all* the origin fs's snapshots, but
5395 cp
= strchr(origin
, '@');
5398 (void) dmu_objset_find(origin
,
5399 zfs_unmount_snap_cb
, NULL
, DS_FIND_SNAPSHOTS
);
5400 return (dsl_dataset_promote(zc
->zc_name
, zc
->zc_string
));
5404 * Retrieve a single {user|group|project}{used|quota}@... property.
5407 * zc_name name of filesystem
5408 * zc_objset_type zfs_userquota_prop_t
5409 * zc_value domain name (eg. "S-1-234-567-89")
5410 * zc_guid RID/UID/GID
5413 * zc_cookie property value
5416 zfs_ioc_userspace_one(zfs_cmd_t
*zc
)
5421 if (zc
->zc_objset_type
>= ZFS_NUM_USERQUOTA_PROPS
)
5422 return (SET_ERROR(EINVAL
));
5424 error
= zfsvfs_hold(zc
->zc_name
, FTAG
, &zfsvfs
, B_FALSE
);
5428 error
= zfs_userspace_one(zfsvfs
,
5429 zc
->zc_objset_type
, zc
->zc_value
, zc
->zc_guid
, &zc
->zc_cookie
);
5430 zfsvfs_rele(zfsvfs
, FTAG
);
5437 * zc_name name of filesystem
5438 * zc_cookie zap cursor
5439 * zc_objset_type zfs_userquota_prop_t
5440 * zc_nvlist_dst[_size] buffer to fill (not really an nvlist)
5443 * zc_nvlist_dst[_size] data buffer (array of zfs_useracct_t)
5444 * zc_cookie zap cursor
5447 zfs_ioc_userspace_many(zfs_cmd_t
*zc
)
5450 int bufsize
= zc
->zc_nvlist_dst_size
;
5453 return (SET_ERROR(ENOMEM
));
5455 int error
= zfsvfs_hold(zc
->zc_name
, FTAG
, &zfsvfs
, B_FALSE
);
5459 void *buf
= vmem_alloc(bufsize
, KM_SLEEP
);
5461 error
= zfs_userspace_many(zfsvfs
, zc
->zc_objset_type
, &zc
->zc_cookie
,
5462 buf
, &zc
->zc_nvlist_dst_size
);
5465 error
= xcopyout(buf
,
5466 (void *)(uintptr_t)zc
->zc_nvlist_dst
,
5467 zc
->zc_nvlist_dst_size
);
5469 vmem_free(buf
, bufsize
);
5470 zfsvfs_rele(zfsvfs
, FTAG
);
5477 * zc_name name of filesystem
5483 zfs_ioc_userspace_upgrade(zfs_cmd_t
*zc
)
5489 if (getzfsvfs(zc
->zc_name
, &zfsvfs
) == 0) {
5490 if (!dmu_objset_userused_enabled(zfsvfs
->z_os
)) {
5492 * If userused is not enabled, it may be because the
5493 * objset needs to be closed & reopened (to grow the
5494 * objset_phys_t). Suspend/resume the fs will do that.
5496 dsl_dataset_t
*ds
, *newds
;
5498 ds
= dmu_objset_ds(zfsvfs
->z_os
);
5499 error
= zfs_suspend_fs(zfsvfs
);
5501 dmu_objset_refresh_ownership(ds
, &newds
,
5503 error
= zfs_resume_fs(zfsvfs
, newds
);
5507 error
= dmu_objset_userspace_upgrade(zfsvfs
->z_os
);
5508 deactivate_super(zfsvfs
->z_sb
);
5510 /* XXX kind of reading contents without owning */
5511 error
= dmu_objset_hold_flags(zc
->zc_name
, B_TRUE
, FTAG
, &os
);
5515 error
= dmu_objset_userspace_upgrade(os
);
5516 dmu_objset_rele_flags(os
, B_TRUE
, FTAG
);
5524 * zc_name name of filesystem
5530 zfs_ioc_id_quota_upgrade(zfs_cmd_t
*zc
)
5535 error
= dmu_objset_hold_flags(zc
->zc_name
, B_TRUE
, FTAG
, &os
);
5539 if (dmu_objset_userobjspace_upgradable(os
) ||
5540 dmu_objset_projectquota_upgradable(os
)) {
5541 mutex_enter(&os
->os_upgrade_lock
);
5542 if (os
->os_upgrade_id
== 0) {
5543 /* clear potential error code and retry */
5544 os
->os_upgrade_status
= 0;
5545 mutex_exit(&os
->os_upgrade_lock
);
5547 dmu_objset_id_quota_upgrade(os
);
5549 mutex_exit(&os
->os_upgrade_lock
);
5552 dsl_pool_rele(dmu_objset_pool(os
), FTAG
);
5554 taskq_wait_id(os
->os_spa
->spa_upgrade_taskq
, os
->os_upgrade_id
);
5555 error
= os
->os_upgrade_status
;
5557 dsl_pool_rele(dmu_objset_pool(os
), FTAG
);
5560 dsl_dataset_rele_flags(dmu_objset_ds(os
), DS_HOLD_FLAG_DECRYPT
, FTAG
);
5566 zfs_ioc_share(zfs_cmd_t
*zc
)
5568 return (SET_ERROR(ENOSYS
));
5571 ace_t full_access
[] = {
5572 {(uid_t
)-1, ACE_ALL_PERMS
, ACE_EVERYONE
, 0}
5577 * zc_name name of containing filesystem
5578 * zc_obj object # beyond which we want next in-use object #
5581 * zc_obj next in-use object #
5584 zfs_ioc_next_obj(zfs_cmd_t
*zc
)
5586 objset_t
*os
= NULL
;
5589 error
= dmu_objset_hold(zc
->zc_name
, FTAG
, &os
);
5593 error
= dmu_object_next(os
, &zc
->zc_obj
, B_FALSE
, 0);
5595 dmu_objset_rele(os
, FTAG
);
5601 * zc_name name of filesystem
5602 * zc_value prefix name for snapshot
5603 * zc_cleanup_fd cleanup-on-exit file descriptor for calling process
5606 * zc_value short name of new snapshot
5609 zfs_ioc_tmp_snapshot(zfs_cmd_t
*zc
)
5616 error
= zfs_onexit_fd_hold(zc
->zc_cleanup_fd
, &minor
);
5620 snap_name
= kmem_asprintf("%s-%016llx", zc
->zc_value
,
5621 (u_longlong_t
)ddi_get_lbolt64());
5622 hold_name
= kmem_asprintf("%%%s", zc
->zc_value
);
5624 error
= dsl_dataset_snapshot_tmp(zc
->zc_name
, snap_name
, minor
,
5627 (void) strlcpy(zc
->zc_value
, snap_name
,
5628 sizeof (zc
->zc_value
));
5631 zfs_onexit_fd_rele(zc
->zc_cleanup_fd
);
5637 * zc_name name of "to" snapshot
5638 * zc_value name of "from" snapshot
5639 * zc_cookie file descriptor to write diff data on
5642 * dmu_diff_record_t's to the file descriptor
5645 zfs_ioc_diff(zfs_cmd_t
*zc
)
5651 fp
= getf(zc
->zc_cookie
);
5653 return (SET_ERROR(EBADF
));
5657 error
= dmu_diff(zc
->zc_name
, zc
->zc_value
, fp
->f_vnode
, &off
);
5659 if (VOP_SEEK(fp
->f_vnode
, fp
->f_offset
, &off
, NULL
) == 0)
5661 releasef(zc
->zc_cookie
);
5667 zfs_ioc_smb_acl(zfs_cmd_t
*zc
)
5669 return (SET_ERROR(ENOTSUP
));
5674 * "holds" -> { snapname -> holdname (string), ... }
5675 * (optional) "cleanup_fd" -> fd (int32)
5679 * snapname -> error value (int32)
5683 static const zfs_ioc_key_t zfs_keys_hold
[] = {
5684 {"holds", DATA_TYPE_NVLIST
, 0},
5685 {"cleanup_fd", DATA_TYPE_INT32
, ZK_OPTIONAL
},
5690 zfs_ioc_hold(const char *pool
, nvlist_t
*args
, nvlist_t
*errlist
)
5694 int cleanup_fd
= -1;
5698 holds
= fnvlist_lookup_nvlist(args
, "holds");
5700 /* make sure the user didn't pass us any invalid (empty) tags */
5701 for (pair
= nvlist_next_nvpair(holds
, NULL
); pair
!= NULL
;
5702 pair
= nvlist_next_nvpair(holds
, pair
)) {
5705 error
= nvpair_value_string(pair
, &htag
);
5707 return (SET_ERROR(error
));
5709 if (strlen(htag
) == 0)
5710 return (SET_ERROR(EINVAL
));
5713 if (nvlist_lookup_int32(args
, "cleanup_fd", &cleanup_fd
) == 0) {
5714 error
= zfs_onexit_fd_hold(cleanup_fd
, &minor
);
5719 error
= dsl_dataset_user_hold(holds
, minor
, errlist
);
5721 zfs_onexit_fd_rele(cleanup_fd
);
5726 * innvl is not used.
5729 * holdname -> time added (uint64 seconds since epoch)
5733 static const zfs_ioc_key_t zfs_keys_get_holds
[] = {
5739 zfs_ioc_get_holds(const char *snapname
, nvlist_t
*args
, nvlist_t
*outnvl
)
5741 return (dsl_dataset_get_holds(snapname
, outnvl
));
5746 * snapname -> { holdname, ... }
5751 * snapname -> error value (int32)
5755 static const zfs_ioc_key_t zfs_keys_release
[] = {
5756 {"<snapname>...", DATA_TYPE_NVLIST
, ZK_WILDCARDLIST
},
5761 zfs_ioc_release(const char *pool
, nvlist_t
*holds
, nvlist_t
*errlist
)
5763 return (dsl_dataset_user_release(holds
, errlist
));
5768 * zc_guid flags (ZEVENT_NONBLOCK)
5769 * zc_cleanup_fd zevent file descriptor
5772 * zc_nvlist_dst next nvlist event
5773 * zc_cookie dropped events since last get
5776 zfs_ioc_events_next(zfs_cmd_t
*zc
)
5779 nvlist_t
*event
= NULL
;
5781 uint64_t dropped
= 0;
5784 error
= zfs_zevent_fd_hold(zc
->zc_cleanup_fd
, &minor
, &ze
);
5789 error
= zfs_zevent_next(ze
, &event
,
5790 &zc
->zc_nvlist_dst_size
, &dropped
);
5791 if (event
!= NULL
) {
5792 zc
->zc_cookie
= dropped
;
5793 error
= put_nvlist(zc
, event
);
5797 if (zc
->zc_guid
& ZEVENT_NONBLOCK
)
5800 if ((error
== 0) || (error
!= ENOENT
))
5803 error
= zfs_zevent_wait(ze
);
5808 zfs_zevent_fd_rele(zc
->zc_cleanup_fd
);
5815 * zc_cookie cleared events count
5818 zfs_ioc_events_clear(zfs_cmd_t
*zc
)
5822 zfs_zevent_drain_all(&count
);
5823 zc
->zc_cookie
= count
;
5830 * zc_guid eid | ZEVENT_SEEK_START | ZEVENT_SEEK_END
5831 * zc_cleanup zevent file descriptor
5834 zfs_ioc_events_seek(zfs_cmd_t
*zc
)
5840 error
= zfs_zevent_fd_hold(zc
->zc_cleanup_fd
, &minor
, &ze
);
5844 error
= zfs_zevent_seek(ze
, zc
->zc_guid
);
5845 zfs_zevent_fd_rele(zc
->zc_cleanup_fd
);
5852 * zc_name name of new filesystem or snapshot
5853 * zc_value full name of old snapshot
5856 * zc_cookie space in bytes
5857 * zc_objset_type compressed space in bytes
5858 * zc_perm_action uncompressed space in bytes
5861 zfs_ioc_space_written(zfs_cmd_t
*zc
)
5865 dsl_dataset_t
*new, *old
;
5867 error
= dsl_pool_hold(zc
->zc_name
, FTAG
, &dp
);
5870 error
= dsl_dataset_hold(dp
, zc
->zc_name
, FTAG
, &new);
5872 dsl_pool_rele(dp
, FTAG
);
5875 error
= dsl_dataset_hold(dp
, zc
->zc_value
, FTAG
, &old
);
5877 dsl_dataset_rele(new, FTAG
);
5878 dsl_pool_rele(dp
, FTAG
);
5882 error
= dsl_dataset_space_written(old
, new, &zc
->zc_cookie
,
5883 &zc
->zc_objset_type
, &zc
->zc_perm_action
);
5884 dsl_dataset_rele(old
, FTAG
);
5885 dsl_dataset_rele(new, FTAG
);
5886 dsl_pool_rele(dp
, FTAG
);
5892 * "firstsnap" -> snapshot name
5896 * "used" -> space in bytes
5897 * "compressed" -> compressed space in bytes
5898 * "uncompressed" -> uncompressed space in bytes
5901 static const zfs_ioc_key_t zfs_keys_space_snaps
[] = {
5902 {"firstsnap", DATA_TYPE_STRING
, 0},
5906 zfs_ioc_space_snaps(const char *lastsnap
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
5910 dsl_dataset_t
*new, *old
;
5912 uint64_t used
, comp
, uncomp
;
5914 firstsnap
= fnvlist_lookup_string(innvl
, "firstsnap");
5916 error
= dsl_pool_hold(lastsnap
, FTAG
, &dp
);
5920 error
= dsl_dataset_hold(dp
, lastsnap
, FTAG
, &new);
5921 if (error
== 0 && !new->ds_is_snapshot
) {
5922 dsl_dataset_rele(new, FTAG
);
5923 error
= SET_ERROR(EINVAL
);
5926 dsl_pool_rele(dp
, FTAG
);
5929 error
= dsl_dataset_hold(dp
, firstsnap
, FTAG
, &old
);
5930 if (error
== 0 && !old
->ds_is_snapshot
) {
5931 dsl_dataset_rele(old
, FTAG
);
5932 error
= SET_ERROR(EINVAL
);
5935 dsl_dataset_rele(new, FTAG
);
5936 dsl_pool_rele(dp
, FTAG
);
5940 error
= dsl_dataset_space_wouldfree(old
, new, &used
, &comp
, &uncomp
);
5941 dsl_dataset_rele(old
, FTAG
);
5942 dsl_dataset_rele(new, FTAG
);
5943 dsl_pool_rele(dp
, FTAG
);
5944 fnvlist_add_uint64(outnvl
, "used", used
);
5945 fnvlist_add_uint64(outnvl
, "compressed", comp
);
5946 fnvlist_add_uint64(outnvl
, "uncompressed", uncomp
);
5952 * "fd" -> file descriptor to write stream to (int32)
5953 * (optional) "fromsnap" -> full snap name to send an incremental from
5954 * (optional) "largeblockok" -> (value ignored)
5955 * indicates that blocks > 128KB are permitted
5956 * (optional) "embedok" -> (value ignored)
5957 * presence indicates DRR_WRITE_EMBEDDED records are permitted
5958 * (optional) "compressok" -> (value ignored)
5959 * presence indicates compressed DRR_WRITE records are permitted
5960 * (optional) "rawok" -> (value ignored)
5961 * presence indicates raw encrypted records should be used.
5962 * (optional) "resume_object" and "resume_offset" -> (uint64)
5963 * if present, resume send stream from specified object and offset.
5968 static const zfs_ioc_key_t zfs_keys_send_new
[] = {
5969 {"fd", DATA_TYPE_INT32
, 0},
5970 {"fromsnap", DATA_TYPE_STRING
, ZK_OPTIONAL
},
5971 {"largeblockok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
5972 {"embedok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
5973 {"compressok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
5974 {"rawok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
5975 {"resume_object", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
5976 {"resume_offset", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
5981 zfs_ioc_send_new(const char *snapname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
5985 char *fromname
= NULL
;
5988 boolean_t largeblockok
;
5990 boolean_t compressok
;
5992 uint64_t resumeobj
= 0;
5993 uint64_t resumeoff
= 0;
5995 fd
= fnvlist_lookup_int32(innvl
, "fd");
5997 (void) nvlist_lookup_string(innvl
, "fromsnap", &fromname
);
5999 largeblockok
= nvlist_exists(innvl
, "largeblockok");
6000 embedok
= nvlist_exists(innvl
, "embedok");
6001 compressok
= nvlist_exists(innvl
, "compressok");
6002 rawok
= nvlist_exists(innvl
, "rawok");
6004 (void) nvlist_lookup_uint64(innvl
, "resume_object", &resumeobj
);
6005 (void) nvlist_lookup_uint64(innvl
, "resume_offset", &resumeoff
);
6007 if ((fp
= getf(fd
)) == NULL
)
6008 return (SET_ERROR(EBADF
));
6011 error
= dmu_send(snapname
, fromname
, embedok
, largeblockok
, compressok
,
6012 rawok
, fd
, resumeobj
, resumeoff
, fp
->f_vnode
, &off
);
6014 if (VOP_SEEK(fp
->f_vnode
, fp
->f_offset
, &off
, NULL
) == 0)
6022 * Determine approximately how large a zfs send stream will be -- the number
6023 * of bytes that will be written to the fd supplied to zfs_ioc_send_new().
6026 * (optional) "from" -> full snap or bookmark name to send an incremental
6028 * (optional) "largeblockok" -> (value ignored)
6029 * indicates that blocks > 128KB are permitted
6030 * (optional) "embedok" -> (value ignored)
6031 * presence indicates DRR_WRITE_EMBEDDED records are permitted
6032 * (optional) "compressok" -> (value ignored)
6033 * presence indicates compressed DRR_WRITE records are permitted
6034 * (optional) "rawok" -> (value ignored)
6035 * presence indicates raw encrypted records should be used.
6039 * "space" -> bytes of space (uint64)
6042 static const zfs_ioc_key_t zfs_keys_send_space
[] = {
6043 {"from", DATA_TYPE_STRING
, ZK_OPTIONAL
},
6044 {"fromsnap", DATA_TYPE_STRING
, ZK_OPTIONAL
},
6045 {"largeblockok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6046 {"embedok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6047 {"compressok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6048 {"rawok", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6052 zfs_ioc_send_space(const char *snapname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
6055 dsl_dataset_t
*tosnap
;
6058 boolean_t compressok
;
6062 error
= dsl_pool_hold(snapname
, FTAG
, &dp
);
6066 error
= dsl_dataset_hold(dp
, snapname
, FTAG
, &tosnap
);
6068 dsl_pool_rele(dp
, FTAG
);
6072 compressok
= nvlist_exists(innvl
, "compressok");
6073 rawok
= nvlist_exists(innvl
, "rawok");
6075 error
= nvlist_lookup_string(innvl
, "from", &fromname
);
6077 if (strchr(fromname
, '@') != NULL
) {
6079 * If from is a snapshot, hold it and use the more
6080 * efficient dmu_send_estimate to estimate send space
6081 * size using deadlists.
6083 dsl_dataset_t
*fromsnap
;
6084 error
= dsl_dataset_hold(dp
, fromname
, FTAG
, &fromsnap
);
6087 error
= dmu_send_estimate(tosnap
, fromsnap
,
6088 compressok
|| rawok
, &space
);
6089 dsl_dataset_rele(fromsnap
, FTAG
);
6090 } else if (strchr(fromname
, '#') != NULL
) {
6092 * If from is a bookmark, fetch the creation TXG of the
6093 * snapshot it was created from and use that to find
6094 * blocks that were born after it.
6096 zfs_bookmark_phys_t frombm
;
6098 error
= dsl_bookmark_lookup(dp
, fromname
, tosnap
,
6102 error
= dmu_send_estimate_from_txg(tosnap
,
6103 frombm
.zbm_creation_txg
, compressok
|| rawok
,
6107 * from is not properly formatted as a snapshot or
6110 error
= SET_ERROR(EINVAL
);
6115 * If estimating the size of a full send, use dmu_send_estimate.
6117 error
= dmu_send_estimate(tosnap
, NULL
, compressok
|| rawok
,
6121 fnvlist_add_uint64(outnvl
, "space", space
);
6124 dsl_dataset_rele(tosnap
, FTAG
);
6125 dsl_pool_rele(dp
, FTAG
);
6130 * Sync the currently open TXG to disk for the specified pool.
6131 * This is somewhat similar to 'zfs_sync()'.
6132 * For cases that do not result in error this ioctl will wait for
6133 * the currently open TXG to commit before returning back to the caller.
6136 * "force" -> when true, force uberblock update even if there is no dirty data.
6137 * In addition this will cause the vdev configuration to be written
6138 * out including updating the zpool cache file. (boolean_t)
6143 static const zfs_ioc_key_t zfs_keys_pool_sync
[] = {
6144 {"force", DATA_TYPE_BOOLEAN_VALUE
, 0},
6149 zfs_ioc_pool_sync(const char *pool
, nvlist_t
*innvl
, nvlist_t
*onvl
)
6152 boolean_t force
= B_FALSE
;
6155 if ((err
= spa_open(pool
, &spa
, FTAG
)) != 0)
6159 force
= fnvlist_lookup_boolean_value(innvl
, "force");
6162 spa_config_enter(spa
, SCL_CONFIG
, FTAG
, RW_WRITER
);
6163 vdev_config_dirty(spa
->spa_root_vdev
);
6164 spa_config_exit(spa
, SCL_CONFIG
, FTAG
);
6166 txg_wait_synced(spa_get_dsl(spa
), 0);
6168 spa_close(spa
, FTAG
);
6174 * Load a user's wrapping key into the kernel.
6176 * "hidden_args" -> { "wkeydata" -> value }
6177 * raw uint8_t array of encryption wrapping key data (32 bytes)
6178 * (optional) "noop" -> (value ignored)
6179 * presence indicated key should only be verified, not loaded
6182 static const zfs_ioc_key_t zfs_keys_load_key
[] = {
6183 {"hidden_args", DATA_TYPE_NVLIST
, 0},
6184 {"noop", DATA_TYPE_BOOLEAN
, ZK_OPTIONAL
},
6189 zfs_ioc_load_key(const char *dsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
6192 dsl_crypto_params_t
*dcp
= NULL
;
6193 nvlist_t
*hidden_args
;
6194 boolean_t noop
= nvlist_exists(innvl
, "noop");
6196 if (strchr(dsname
, '@') != NULL
|| strchr(dsname
, '%') != NULL
) {
6197 ret
= SET_ERROR(EINVAL
);
6201 hidden_args
= fnvlist_lookup_nvlist(innvl
, ZPOOL_HIDDEN_ARGS
);
6203 ret
= dsl_crypto_params_create_nvlist(DCP_CMD_NONE
, NULL
,
6208 ret
= spa_keystore_load_wkey(dsname
, dcp
, noop
);
6212 dsl_crypto_params_free(dcp
, noop
);
6217 dsl_crypto_params_free(dcp
, B_TRUE
);
6222 * Unload a user's wrapping key from the kernel.
6223 * Both innvl and outnvl are unused.
6225 static const zfs_ioc_key_t zfs_keys_unload_key
[] = {
6231 zfs_ioc_unload_key(const char *dsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
6235 if (strchr(dsname
, '@') != NULL
|| strchr(dsname
, '%') != NULL
) {
6236 ret
= (SET_ERROR(EINVAL
));
6240 ret
= spa_keystore_unload_wkey(dsname
);
6249 * Changes a user's wrapping key used to decrypt a dataset. The keyformat,
6250 * keylocation, pbkdf2salt, and pbkdf2iters properties can also be specified
6251 * here to change how the key is derived in userspace.
6254 * "hidden_args" (optional) -> { "wkeydata" -> value }
6255 * raw uint8_t array of new encryption wrapping key data (32 bytes)
6256 * "props" (optional) -> { prop -> value }
6261 static const zfs_ioc_key_t zfs_keys_change_key
[] = {
6262 {"crypt_cmd", DATA_TYPE_UINT64
, ZK_OPTIONAL
},
6263 {"hidden_args", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
6264 {"props", DATA_TYPE_NVLIST
, ZK_OPTIONAL
},
6269 zfs_ioc_change_key(const char *dsname
, nvlist_t
*innvl
, nvlist_t
*outnvl
)
6272 uint64_t cmd
= DCP_CMD_NONE
;
6273 dsl_crypto_params_t
*dcp
= NULL
;
6274 nvlist_t
*args
= NULL
, *hidden_args
= NULL
;
6276 if (strchr(dsname
, '@') != NULL
|| strchr(dsname
, '%') != NULL
) {
6277 ret
= (SET_ERROR(EINVAL
));
6281 (void) nvlist_lookup_uint64(innvl
, "crypt_cmd", &cmd
);
6282 (void) nvlist_lookup_nvlist(innvl
, "props", &args
);
6283 (void) nvlist_lookup_nvlist(innvl
, ZPOOL_HIDDEN_ARGS
, &hidden_args
);
6285 ret
= dsl_crypto_params_create_nvlist(cmd
, args
, hidden_args
, &dcp
);
6289 ret
= spa_keystore_change_key(dsname
, dcp
);
6293 dsl_crypto_params_free(dcp
, B_FALSE
);
6298 dsl_crypto_params_free(dcp
, B_TRUE
);
6302 static zfs_ioc_vec_t zfs_ioc_vec
[ZFS_IOC_LAST
- ZFS_IOC_FIRST
];
6305 zfs_ioctl_register_legacy(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
,
6306 zfs_secpolicy_func_t
*secpolicy
, zfs_ioc_namecheck_t namecheck
,
6307 boolean_t log_history
, zfs_ioc_poolcheck_t pool_check
)
6309 zfs_ioc_vec_t
*vec
= &zfs_ioc_vec
[ioc
- ZFS_IOC_FIRST
];
6311 ASSERT3U(ioc
, >=, ZFS_IOC_FIRST
);
6312 ASSERT3U(ioc
, <, ZFS_IOC_LAST
);
6313 ASSERT3P(vec
->zvec_legacy_func
, ==, NULL
);
6314 ASSERT3P(vec
->zvec_func
, ==, NULL
);
6316 vec
->zvec_legacy_func
= func
;
6317 vec
->zvec_secpolicy
= secpolicy
;
6318 vec
->zvec_namecheck
= namecheck
;
6319 vec
->zvec_allow_log
= log_history
;
6320 vec
->zvec_pool_check
= pool_check
;
6324 * See the block comment at the beginning of this file for details on
6325 * each argument to this function.
6328 zfs_ioctl_register(const char *name
, zfs_ioc_t ioc
, zfs_ioc_func_t
*func
,
6329 zfs_secpolicy_func_t
*secpolicy
, zfs_ioc_namecheck_t namecheck
,
6330 zfs_ioc_poolcheck_t pool_check
, boolean_t smush_outnvlist
,
6331 boolean_t allow_log
, const zfs_ioc_key_t
*nvl_keys
, size_t num_keys
)
6333 zfs_ioc_vec_t
*vec
= &zfs_ioc_vec
[ioc
- ZFS_IOC_FIRST
];
6335 ASSERT3U(ioc
, >=, ZFS_IOC_FIRST
);
6336 ASSERT3U(ioc
, <, ZFS_IOC_LAST
);
6337 ASSERT3P(vec
->zvec_legacy_func
, ==, NULL
);
6338 ASSERT3P(vec
->zvec_func
, ==, NULL
);
6340 /* if we are logging, the name must be valid */
6341 ASSERT(!allow_log
|| namecheck
!= NO_NAME
);
6343 vec
->zvec_name
= name
;
6344 vec
->zvec_func
= func
;
6345 vec
->zvec_secpolicy
= secpolicy
;
6346 vec
->zvec_namecheck
= namecheck
;
6347 vec
->zvec_pool_check
= pool_check
;
6348 vec
->zvec_smush_outnvlist
= smush_outnvlist
;
6349 vec
->zvec_allow_log
= allow_log
;
6350 vec
->zvec_nvl_keys
= nvl_keys
;
6351 vec
->zvec_nvl_key_count
= num_keys
;
6355 zfs_ioctl_register_pool(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
,
6356 zfs_secpolicy_func_t
*secpolicy
, boolean_t log_history
,
6357 zfs_ioc_poolcheck_t pool_check
)
6359 zfs_ioctl_register_legacy(ioc
, func
, secpolicy
,
6360 POOL_NAME
, log_history
, pool_check
);
6364 zfs_ioctl_register_dataset_nolog(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
,
6365 zfs_secpolicy_func_t
*secpolicy
, zfs_ioc_poolcheck_t pool_check
)
6367 zfs_ioctl_register_legacy(ioc
, func
, secpolicy
,
6368 DATASET_NAME
, B_FALSE
, pool_check
);
6372 zfs_ioctl_register_pool_modify(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
)
6374 zfs_ioctl_register_legacy(ioc
, func
, zfs_secpolicy_config
,
6375 POOL_NAME
, B_TRUE
, POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
);
6379 zfs_ioctl_register_pool_meta(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
,
6380 zfs_secpolicy_func_t
*secpolicy
)
6382 zfs_ioctl_register_legacy(ioc
, func
, secpolicy
,
6383 NO_NAME
, B_FALSE
, POOL_CHECK_NONE
);
6387 zfs_ioctl_register_dataset_read_secpolicy(zfs_ioc_t ioc
,
6388 zfs_ioc_legacy_func_t
*func
, zfs_secpolicy_func_t
*secpolicy
)
6390 zfs_ioctl_register_legacy(ioc
, func
, secpolicy
,
6391 DATASET_NAME
, B_FALSE
, POOL_CHECK_SUSPENDED
);
6395 zfs_ioctl_register_dataset_read(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
)
6397 zfs_ioctl_register_dataset_read_secpolicy(ioc
, func
,
6398 zfs_secpolicy_read
);
6402 zfs_ioctl_register_dataset_modify(zfs_ioc_t ioc
, zfs_ioc_legacy_func_t
*func
,
6403 zfs_secpolicy_func_t
*secpolicy
)
6405 zfs_ioctl_register_legacy(ioc
, func
, secpolicy
,
6406 DATASET_NAME
, B_TRUE
, POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
);
6410 zfs_ioctl_init(void)
6412 zfs_ioctl_register("snapshot", ZFS_IOC_SNAPSHOT
,
6413 zfs_ioc_snapshot
, zfs_secpolicy_snapshot
, POOL_NAME
,
6414 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6415 zfs_keys_snapshot
, ARRAY_SIZE(zfs_keys_snapshot
));
6417 zfs_ioctl_register("log_history", ZFS_IOC_LOG_HISTORY
,
6418 zfs_ioc_log_history
, zfs_secpolicy_log_history
, NO_NAME
,
6419 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_FALSE
,
6420 zfs_keys_log_history
, ARRAY_SIZE(zfs_keys_log_history
));
6422 zfs_ioctl_register("space_snaps", ZFS_IOC_SPACE_SNAPS
,
6423 zfs_ioc_space_snaps
, zfs_secpolicy_read
, DATASET_NAME
,
6424 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
,
6425 zfs_keys_space_snaps
, ARRAY_SIZE(zfs_keys_space_snaps
));
6427 zfs_ioctl_register("send", ZFS_IOC_SEND_NEW
,
6428 zfs_ioc_send_new
, zfs_secpolicy_send_new
, DATASET_NAME
,
6429 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
,
6430 zfs_keys_send_new
, ARRAY_SIZE(zfs_keys_send_new
));
6432 zfs_ioctl_register("send_space", ZFS_IOC_SEND_SPACE
,
6433 zfs_ioc_send_space
, zfs_secpolicy_read
, DATASET_NAME
,
6434 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
,
6435 zfs_keys_send_space
, ARRAY_SIZE(zfs_keys_send_space
));
6437 zfs_ioctl_register("create", ZFS_IOC_CREATE
,
6438 zfs_ioc_create
, zfs_secpolicy_create_clone
, DATASET_NAME
,
6439 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6440 zfs_keys_create
, ARRAY_SIZE(zfs_keys_create
));
6442 zfs_ioctl_register("clone", ZFS_IOC_CLONE
,
6443 zfs_ioc_clone
, zfs_secpolicy_create_clone
, DATASET_NAME
,
6444 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6445 zfs_keys_clone
, ARRAY_SIZE(zfs_keys_clone
));
6447 zfs_ioctl_register("remap", ZFS_IOC_REMAP
,
6448 zfs_ioc_remap
, zfs_secpolicy_remap
, DATASET_NAME
,
6449 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_TRUE
,
6450 zfs_keys_remap
, ARRAY_SIZE(zfs_keys_remap
));
6452 zfs_ioctl_register("destroy_snaps", ZFS_IOC_DESTROY_SNAPS
,
6453 zfs_ioc_destroy_snaps
, zfs_secpolicy_destroy_snaps
, POOL_NAME
,
6454 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6455 zfs_keys_destroy_snaps
, ARRAY_SIZE(zfs_keys_destroy_snaps
));
6457 zfs_ioctl_register("hold", ZFS_IOC_HOLD
,
6458 zfs_ioc_hold
, zfs_secpolicy_hold
, POOL_NAME
,
6459 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6460 zfs_keys_hold
, ARRAY_SIZE(zfs_keys_hold
));
6461 zfs_ioctl_register("release", ZFS_IOC_RELEASE
,
6462 zfs_ioc_release
, zfs_secpolicy_release
, POOL_NAME
,
6463 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6464 zfs_keys_release
, ARRAY_SIZE(zfs_keys_release
));
6466 zfs_ioctl_register("get_holds", ZFS_IOC_GET_HOLDS
,
6467 zfs_ioc_get_holds
, zfs_secpolicy_read
, DATASET_NAME
,
6468 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
,
6469 zfs_keys_get_holds
, ARRAY_SIZE(zfs_keys_get_holds
));
6471 zfs_ioctl_register("rollback", ZFS_IOC_ROLLBACK
,
6472 zfs_ioc_rollback
, zfs_secpolicy_rollback
, DATASET_NAME
,
6473 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_TRUE
,
6474 zfs_keys_rollback
, ARRAY_SIZE(zfs_keys_rollback
));
6476 zfs_ioctl_register("bookmark", ZFS_IOC_BOOKMARK
,
6477 zfs_ioc_bookmark
, zfs_secpolicy_bookmark
, POOL_NAME
,
6478 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6479 zfs_keys_bookmark
, ARRAY_SIZE(zfs_keys_bookmark
));
6481 zfs_ioctl_register("get_bookmarks", ZFS_IOC_GET_BOOKMARKS
,
6482 zfs_ioc_get_bookmarks
, zfs_secpolicy_read
, DATASET_NAME
,
6483 POOL_CHECK_SUSPENDED
, B_FALSE
, B_FALSE
,
6484 zfs_keys_get_bookmarks
, ARRAY_SIZE(zfs_keys_get_bookmarks
));
6486 zfs_ioctl_register("destroy_bookmarks", ZFS_IOC_DESTROY_BOOKMARKS
,
6487 zfs_ioc_destroy_bookmarks
, zfs_secpolicy_destroy_bookmarks
,
6489 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6490 zfs_keys_destroy_bookmarks
,
6491 ARRAY_SIZE(zfs_keys_destroy_bookmarks
));
6493 zfs_ioctl_register("receive", ZFS_IOC_RECV_NEW
,
6494 zfs_ioc_recv_new
, zfs_secpolicy_recv_new
, DATASET_NAME
,
6495 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6496 zfs_keys_recv_new
, ARRAY_SIZE(zfs_keys_recv_new
));
6497 zfs_ioctl_register("load-key", ZFS_IOC_LOAD_KEY
,
6498 zfs_ioc_load_key
, zfs_secpolicy_load_key
,
6499 DATASET_NAME
, POOL_CHECK_SUSPENDED
, B_TRUE
, B_TRUE
,
6500 zfs_keys_load_key
, ARRAY_SIZE(zfs_keys_load_key
));
6501 zfs_ioctl_register("unload-key", ZFS_IOC_UNLOAD_KEY
,
6502 zfs_ioc_unload_key
, zfs_secpolicy_load_key
,
6503 DATASET_NAME
, POOL_CHECK_SUSPENDED
, B_TRUE
, B_TRUE
,
6504 zfs_keys_unload_key
, ARRAY_SIZE(zfs_keys_unload_key
));
6505 zfs_ioctl_register("change-key", ZFS_IOC_CHANGE_KEY
,
6506 zfs_ioc_change_key
, zfs_secpolicy_change_key
,
6507 DATASET_NAME
, POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
,
6508 B_TRUE
, B_TRUE
, zfs_keys_change_key
,
6509 ARRAY_SIZE(zfs_keys_change_key
));
6511 zfs_ioctl_register("sync", ZFS_IOC_POOL_SYNC
,
6512 zfs_ioc_pool_sync
, zfs_secpolicy_none
, POOL_NAME
,
6513 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_FALSE
, B_FALSE
,
6514 zfs_keys_pool_sync
, ARRAY_SIZE(zfs_keys_pool_sync
));
6515 zfs_ioctl_register("reopen", ZFS_IOC_POOL_REOPEN
, zfs_ioc_pool_reopen
,
6516 zfs_secpolicy_config
, POOL_NAME
, POOL_CHECK_SUSPENDED
, B_TRUE
,
6517 B_TRUE
, zfs_keys_pool_reopen
, ARRAY_SIZE(zfs_keys_pool_reopen
));
6519 zfs_ioctl_register("channel_program", ZFS_IOC_CHANNEL_PROGRAM
,
6520 zfs_ioc_channel_program
, zfs_secpolicy_config
,
6521 POOL_NAME
, POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
,
6522 B_TRUE
, zfs_keys_channel_program
,
6523 ARRAY_SIZE(zfs_keys_channel_program
));
6525 zfs_ioctl_register("zpool_checkpoint", ZFS_IOC_POOL_CHECKPOINT
,
6526 zfs_ioc_pool_checkpoint
, zfs_secpolicy_config
, POOL_NAME
,
6527 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6528 zfs_keys_pool_checkpoint
, ARRAY_SIZE(zfs_keys_pool_checkpoint
));
6530 zfs_ioctl_register("zpool_discard_checkpoint",
6531 ZFS_IOC_POOL_DISCARD_CHECKPOINT
, zfs_ioc_pool_discard_checkpoint
,
6532 zfs_secpolicy_config
, POOL_NAME
,
6533 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6534 zfs_keys_pool_discard_checkpoint
,
6535 ARRAY_SIZE(zfs_keys_pool_discard_checkpoint
));
6537 zfs_ioctl_register("initialize", ZFS_IOC_POOL_INITIALIZE
,
6538 zfs_ioc_pool_initialize
, zfs_secpolicy_config
, POOL_NAME
,
6539 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
, B_TRUE
, B_TRUE
,
6540 zfs_keys_pool_initialize
, ARRAY_SIZE(zfs_keys_pool_initialize
));
6542 /* IOCTLS that use the legacy function signature */
6544 zfs_ioctl_register_legacy(ZFS_IOC_POOL_FREEZE
, zfs_ioc_pool_freeze
,
6545 zfs_secpolicy_config
, NO_NAME
, B_FALSE
, POOL_CHECK_READONLY
);
6547 zfs_ioctl_register_pool(ZFS_IOC_POOL_CREATE
, zfs_ioc_pool_create
,
6548 zfs_secpolicy_config
, B_TRUE
, POOL_CHECK_NONE
);
6549 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_SCAN
,
6551 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_UPGRADE
,
6552 zfs_ioc_pool_upgrade
);
6553 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_ADD
,
6555 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_REMOVE
,
6556 zfs_ioc_vdev_remove
);
6557 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SET_STATE
,
6558 zfs_ioc_vdev_set_state
);
6559 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_ATTACH
,
6560 zfs_ioc_vdev_attach
);
6561 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_DETACH
,
6562 zfs_ioc_vdev_detach
);
6563 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SETPATH
,
6564 zfs_ioc_vdev_setpath
);
6565 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SETFRU
,
6566 zfs_ioc_vdev_setfru
);
6567 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_SET_PROPS
,
6568 zfs_ioc_pool_set_props
);
6569 zfs_ioctl_register_pool_modify(ZFS_IOC_VDEV_SPLIT
,
6570 zfs_ioc_vdev_split
);
6571 zfs_ioctl_register_pool_modify(ZFS_IOC_POOL_REGUID
,
6572 zfs_ioc_pool_reguid
);
6574 zfs_ioctl_register_pool_meta(ZFS_IOC_POOL_CONFIGS
,
6575 zfs_ioc_pool_configs
, zfs_secpolicy_none
);
6576 zfs_ioctl_register_pool_meta(ZFS_IOC_POOL_TRYIMPORT
,
6577 zfs_ioc_pool_tryimport
, zfs_secpolicy_config
);
6578 zfs_ioctl_register_pool_meta(ZFS_IOC_INJECT_FAULT
,
6579 zfs_ioc_inject_fault
, zfs_secpolicy_inject
);
6580 zfs_ioctl_register_pool_meta(ZFS_IOC_CLEAR_FAULT
,
6581 zfs_ioc_clear_fault
, zfs_secpolicy_inject
);
6582 zfs_ioctl_register_pool_meta(ZFS_IOC_INJECT_LIST_NEXT
,
6583 zfs_ioc_inject_list_next
, zfs_secpolicy_inject
);
6586 * pool destroy, and export don't log the history as part of
6587 * zfsdev_ioctl, but rather zfs_ioc_pool_export
6588 * does the logging of those commands.
6590 zfs_ioctl_register_pool(ZFS_IOC_POOL_DESTROY
, zfs_ioc_pool_destroy
,
6591 zfs_secpolicy_config
, B_FALSE
, POOL_CHECK_SUSPENDED
);
6592 zfs_ioctl_register_pool(ZFS_IOC_POOL_EXPORT
, zfs_ioc_pool_export
,
6593 zfs_secpolicy_config
, B_FALSE
, POOL_CHECK_SUSPENDED
);
6595 zfs_ioctl_register_pool(ZFS_IOC_POOL_STATS
, zfs_ioc_pool_stats
,
6596 zfs_secpolicy_read
, B_FALSE
, POOL_CHECK_NONE
);
6597 zfs_ioctl_register_pool(ZFS_IOC_POOL_GET_PROPS
, zfs_ioc_pool_get_props
,
6598 zfs_secpolicy_read
, B_FALSE
, POOL_CHECK_NONE
);
6600 zfs_ioctl_register_pool(ZFS_IOC_ERROR_LOG
, zfs_ioc_error_log
,
6601 zfs_secpolicy_inject
, B_FALSE
, POOL_CHECK_SUSPENDED
);
6602 zfs_ioctl_register_pool(ZFS_IOC_DSOBJ_TO_DSNAME
,
6603 zfs_ioc_dsobj_to_dsname
,
6604 zfs_secpolicy_diff
, B_FALSE
, POOL_CHECK_SUSPENDED
);
6605 zfs_ioctl_register_pool(ZFS_IOC_POOL_GET_HISTORY
,
6606 zfs_ioc_pool_get_history
,
6607 zfs_secpolicy_config
, B_FALSE
, POOL_CHECK_SUSPENDED
);
6609 zfs_ioctl_register_pool(ZFS_IOC_POOL_IMPORT
, zfs_ioc_pool_import
,
6610 zfs_secpolicy_config
, B_TRUE
, POOL_CHECK_NONE
);
6612 zfs_ioctl_register_pool(ZFS_IOC_CLEAR
, zfs_ioc_clear
,
6613 zfs_secpolicy_config
, B_TRUE
, POOL_CHECK_READONLY
);
6615 zfs_ioctl_register_dataset_read(ZFS_IOC_SPACE_WRITTEN
,
6616 zfs_ioc_space_written
);
6617 zfs_ioctl_register_dataset_read(ZFS_IOC_OBJSET_RECVD_PROPS
,
6618 zfs_ioc_objset_recvd_props
);
6619 zfs_ioctl_register_dataset_read(ZFS_IOC_NEXT_OBJ
,
6621 zfs_ioctl_register_dataset_read(ZFS_IOC_GET_FSACL
,
6623 zfs_ioctl_register_dataset_read(ZFS_IOC_OBJSET_STATS
,
6624 zfs_ioc_objset_stats
);
6625 zfs_ioctl_register_dataset_read(ZFS_IOC_OBJSET_ZPLPROPS
,
6626 zfs_ioc_objset_zplprops
);
6627 zfs_ioctl_register_dataset_read(ZFS_IOC_DATASET_LIST_NEXT
,
6628 zfs_ioc_dataset_list_next
);
6629 zfs_ioctl_register_dataset_read(ZFS_IOC_SNAPSHOT_LIST_NEXT
,
6630 zfs_ioc_snapshot_list_next
);
6631 zfs_ioctl_register_dataset_read(ZFS_IOC_SEND_PROGRESS
,
6632 zfs_ioc_send_progress
);
6634 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_DIFF
,
6635 zfs_ioc_diff
, zfs_secpolicy_diff
);
6636 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_OBJ_TO_STATS
,
6637 zfs_ioc_obj_to_stats
, zfs_secpolicy_diff
);
6638 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_OBJ_TO_PATH
,
6639 zfs_ioc_obj_to_path
, zfs_secpolicy_diff
);
6640 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_USERSPACE_ONE
,
6641 zfs_ioc_userspace_one
, zfs_secpolicy_userspace_one
);
6642 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_USERSPACE_MANY
,
6643 zfs_ioc_userspace_many
, zfs_secpolicy_userspace_many
);
6644 zfs_ioctl_register_dataset_read_secpolicy(ZFS_IOC_SEND
,
6645 zfs_ioc_send
, zfs_secpolicy_send
);
6647 zfs_ioctl_register_dataset_modify(ZFS_IOC_SET_PROP
, zfs_ioc_set_prop
,
6648 zfs_secpolicy_none
);
6649 zfs_ioctl_register_dataset_modify(ZFS_IOC_DESTROY
, zfs_ioc_destroy
,
6650 zfs_secpolicy_destroy
);
6651 zfs_ioctl_register_dataset_modify(ZFS_IOC_RENAME
, zfs_ioc_rename
,
6652 zfs_secpolicy_rename
);
6653 zfs_ioctl_register_dataset_modify(ZFS_IOC_RECV
, zfs_ioc_recv
,
6654 zfs_secpolicy_recv
);
6655 zfs_ioctl_register_dataset_modify(ZFS_IOC_PROMOTE
, zfs_ioc_promote
,
6656 zfs_secpolicy_promote
);
6657 zfs_ioctl_register_dataset_modify(ZFS_IOC_INHERIT_PROP
,
6658 zfs_ioc_inherit_prop
, zfs_secpolicy_inherit_prop
);
6659 zfs_ioctl_register_dataset_modify(ZFS_IOC_SET_FSACL
, zfs_ioc_set_fsacl
,
6660 zfs_secpolicy_set_fsacl
);
6662 zfs_ioctl_register_dataset_nolog(ZFS_IOC_SHARE
, zfs_ioc_share
,
6663 zfs_secpolicy_share
, POOL_CHECK_NONE
);
6664 zfs_ioctl_register_dataset_nolog(ZFS_IOC_SMB_ACL
, zfs_ioc_smb_acl
,
6665 zfs_secpolicy_smb_acl
, POOL_CHECK_NONE
);
6666 zfs_ioctl_register_dataset_nolog(ZFS_IOC_USERSPACE_UPGRADE
,
6667 zfs_ioc_userspace_upgrade
, zfs_secpolicy_userspace_upgrade
,
6668 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
);
6669 zfs_ioctl_register_dataset_nolog(ZFS_IOC_TMP_SNAPSHOT
,
6670 zfs_ioc_tmp_snapshot
, zfs_secpolicy_tmp_snapshot
,
6671 POOL_CHECK_SUSPENDED
| POOL_CHECK_READONLY
);
6676 zfs_ioctl_register_legacy(ZFS_IOC_EVENTS_NEXT
, zfs_ioc_events_next
,
6677 zfs_secpolicy_config
, NO_NAME
, B_FALSE
, POOL_CHECK_NONE
);
6678 zfs_ioctl_register_legacy(ZFS_IOC_EVENTS_CLEAR
, zfs_ioc_events_clear
,
6679 zfs_secpolicy_config
, NO_NAME
, B_FALSE
, POOL_CHECK_NONE
);
6680 zfs_ioctl_register_legacy(ZFS_IOC_EVENTS_SEEK
, zfs_ioc_events_seek
,
6681 zfs_secpolicy_config
, NO_NAME
, B_FALSE
, POOL_CHECK_NONE
);
6685 * Verify that for non-legacy ioctls the input nvlist
6686 * pairs match against the expected input.
6688 * Possible errors are:
6689 * ZFS_ERR_IOC_ARG_UNAVAIL An unrecognized nvpair was encountered
6690 * ZFS_ERR_IOC_ARG_REQUIRED A required nvpair is missing
6691 * ZFS_ERR_IOC_ARG_BADTYPE Invalid type for nvpair
6694 zfs_check_input_nvpairs(nvlist_t
*innvl
, const zfs_ioc_vec_t
*vec
)
6696 const zfs_ioc_key_t
*nvl_keys
= vec
->zvec_nvl_keys
;
6697 boolean_t required_keys_found
= B_FALSE
;
6700 * examine each input pair
6702 for (nvpair_t
*pair
= nvlist_next_nvpair(innvl
, NULL
);
6703 pair
!= NULL
; pair
= nvlist_next_nvpair(innvl
, pair
)) {
6704 char *name
= nvpair_name(pair
);
6705 data_type_t type
= nvpair_type(pair
);
6706 boolean_t identified
= B_FALSE
;
6709 * check pair against the documented names and type
6711 for (int k
= 0; k
< vec
->zvec_nvl_key_count
; k
++) {
6712 /* if not a wild card name, check for an exact match */
6713 if ((nvl_keys
[k
].zkey_flags
& ZK_WILDCARDLIST
) == 0 &&
6714 strcmp(nvl_keys
[k
].zkey_name
, name
) != 0)
6717 identified
= B_TRUE
;
6719 if (nvl_keys
[k
].zkey_type
!= DATA_TYPE_ANY
&&
6720 nvl_keys
[k
].zkey_type
!= type
) {
6721 return (SET_ERROR(ZFS_ERR_IOC_ARG_BADTYPE
));
6724 if (nvl_keys
[k
].zkey_flags
& ZK_OPTIONAL
)
6727 required_keys_found
= B_TRUE
;
6731 /* allow an 'optional' key, everything else is invalid */
6733 (strcmp(name
, "optional") != 0 ||
6734 type
!= DATA_TYPE_NVLIST
)) {
6735 return (SET_ERROR(ZFS_ERR_IOC_ARG_UNAVAIL
));
6739 /* verify that all required keys were found */
6740 for (int k
= 0; k
< vec
->zvec_nvl_key_count
; k
++) {
6741 if (nvl_keys
[k
].zkey_flags
& ZK_OPTIONAL
)
6744 if (nvl_keys
[k
].zkey_flags
& ZK_WILDCARDLIST
) {
6745 /* at least one non-optionial key is expected here */
6746 if (!required_keys_found
)
6747 return (SET_ERROR(ZFS_ERR_IOC_ARG_REQUIRED
));
6751 if (!nvlist_exists(innvl
, nvl_keys
[k
].zkey_name
))
6752 return (SET_ERROR(ZFS_ERR_IOC_ARG_REQUIRED
));
6759 pool_status_check(const char *name
, zfs_ioc_namecheck_t type
,
6760 zfs_ioc_poolcheck_t check
)
6765 ASSERT(type
== POOL_NAME
|| type
== DATASET_NAME
);
6767 if (check
& POOL_CHECK_NONE
)
6770 error
= spa_open(name
, &spa
, FTAG
);
6772 if ((check
& POOL_CHECK_SUSPENDED
) && spa_suspended(spa
))
6773 error
= SET_ERROR(EAGAIN
);
6774 else if ((check
& POOL_CHECK_READONLY
) && !spa_writeable(spa
))
6775 error
= SET_ERROR(EROFS
);
6776 spa_close(spa
, FTAG
);
6782 zfsdev_get_state_impl(minor_t minor
, enum zfsdev_state_type which
)
6786 for (zs
= zfsdev_state_list
; zs
!= NULL
; zs
= zs
->zs_next
) {
6787 if (zs
->zs_minor
== minor
) {
6791 return (zs
->zs_onexit
);
6793 return (zs
->zs_zevent
);
6804 zfsdev_get_state(minor_t minor
, enum zfsdev_state_type which
)
6808 ptr
= zfsdev_get_state_impl(minor
, which
);
6814 zfsdev_getminor(struct file
*filp
, minor_t
*minorp
)
6816 zfsdev_state_t
*zs
, *fpd
;
6818 ASSERT(filp
!= NULL
);
6819 ASSERT(!MUTEX_HELD(&zfsdev_state_lock
));
6821 fpd
= filp
->private_data
;
6823 return (SET_ERROR(EBADF
));
6825 mutex_enter(&zfsdev_state_lock
);
6827 for (zs
= zfsdev_state_list
; zs
!= NULL
; zs
= zs
->zs_next
) {
6829 if (zs
->zs_minor
== -1)
6833 *minorp
= fpd
->zs_minor
;
6834 mutex_exit(&zfsdev_state_lock
);
6839 mutex_exit(&zfsdev_state_lock
);
6841 return (SET_ERROR(EBADF
));
6845 * Find a free minor number. The zfsdev_state_list is expected to
6846 * be short since it is only a list of currently open file handles.
6849 zfsdev_minor_alloc(void)
6851 static minor_t last_minor
= 0;
6854 ASSERT(MUTEX_HELD(&zfsdev_state_lock
));
6856 for (m
= last_minor
+ 1; m
!= last_minor
; m
++) {
6857 if (m
> ZFSDEV_MAX_MINOR
)
6859 if (zfsdev_get_state_impl(m
, ZST_ALL
) == NULL
) {
6869 zfsdev_state_init(struct file
*filp
)
6871 zfsdev_state_t
*zs
, *zsprev
= NULL
;
6873 boolean_t newzs
= B_FALSE
;
6875 ASSERT(MUTEX_HELD(&zfsdev_state_lock
));
6877 minor
= zfsdev_minor_alloc();
6879 return (SET_ERROR(ENXIO
));
6881 for (zs
= zfsdev_state_list
; zs
!= NULL
; zs
= zs
->zs_next
) {
6882 if (zs
->zs_minor
== -1)
6888 zs
= kmem_zalloc(sizeof (zfsdev_state_t
), KM_SLEEP
);
6893 filp
->private_data
= zs
;
6895 zfs_onexit_init((zfs_onexit_t
**)&zs
->zs_onexit
);
6896 zfs_zevent_init((zfs_zevent_t
**)&zs
->zs_zevent
);
6900 * In order to provide for lock-free concurrent read access
6901 * to the minor list in zfsdev_get_state_impl(), new entries
6902 * must be completely written before linking them into the
6903 * list whereas existing entries are already linked; the last
6904 * operation must be updating zs_minor (from -1 to the new
6908 zs
->zs_minor
= minor
;
6910 zsprev
->zs_next
= zs
;
6913 zs
->zs_minor
= minor
;
6920 zfsdev_state_destroy(struct file
*filp
)
6924 ASSERT(MUTEX_HELD(&zfsdev_state_lock
));
6925 ASSERT(filp
->private_data
!= NULL
);
6927 zs
= filp
->private_data
;
6929 zfs_onexit_destroy(zs
->zs_onexit
);
6930 zfs_zevent_destroy(zs
->zs_zevent
);
6936 zfsdev_open(struct inode
*ino
, struct file
*filp
)
6940 mutex_enter(&zfsdev_state_lock
);
6941 error
= zfsdev_state_init(filp
);
6942 mutex_exit(&zfsdev_state_lock
);
6948 zfsdev_release(struct inode
*ino
, struct file
*filp
)
6952 mutex_enter(&zfsdev_state_lock
);
6953 error
= zfsdev_state_destroy(filp
);
6954 mutex_exit(&zfsdev_state_lock
);
6960 zfsdev_ioctl(struct file
*filp
, unsigned cmd
, unsigned long arg
)
6964 int error
, rc
, flag
= 0;
6965 const zfs_ioc_vec_t
*vec
;
6966 char *saved_poolname
= NULL
;
6967 nvlist_t
*innvl
= NULL
;
6968 fstrans_cookie_t cookie
;
6970 vecnum
= cmd
- ZFS_IOC_FIRST
;
6971 if (vecnum
>= sizeof (zfs_ioc_vec
) / sizeof (zfs_ioc_vec
[0]))
6972 return (-SET_ERROR(ZFS_ERR_IOC_CMD_UNAVAIL
));
6973 vec
= &zfs_ioc_vec
[vecnum
];
6976 * The registered ioctl list may be sparse, verify that either
6977 * a normal or legacy handler are registered.
6979 if (vec
->zvec_func
== NULL
&& vec
->zvec_legacy_func
== NULL
)
6980 return (-SET_ERROR(ZFS_ERR_IOC_CMD_UNAVAIL
));
6982 zc
= kmem_zalloc(sizeof (zfs_cmd_t
), KM_SLEEP
);
6984 error
= ddi_copyin((void *)arg
, zc
, sizeof (zfs_cmd_t
), flag
);
6986 error
= SET_ERROR(EFAULT
);
6990 zc
->zc_iflags
= flag
& FKIOCTL
;
6991 if (zc
->zc_nvlist_src_size
> MAX_NVLIST_SRC_SIZE
) {
6993 * Make sure the user doesn't pass in an insane value for
6994 * zc_nvlist_src_size. We have to check, since we will end
6995 * up allocating that much memory inside of get_nvlist(). This
6996 * prevents a nefarious user from allocating tons of kernel
6999 * Also, we return EINVAL instead of ENOMEM here. The reason
7000 * being that returning ENOMEM from an ioctl() has a special
7001 * connotation; that the user's size value is too small and
7002 * needs to be expanded to hold the nvlist. See
7003 * zcmd_expand_dst_nvlist() for details.
7005 error
= SET_ERROR(EINVAL
); /* User's size too big */
7007 } else if (zc
->zc_nvlist_src_size
!= 0) {
7008 error
= get_nvlist(zc
->zc_nvlist_src
, zc
->zc_nvlist_src_size
,
7009 zc
->zc_iflags
, &innvl
);
7015 * Ensure that all pool/dataset names are valid before we pass down to
7018 zc
->zc_name
[sizeof (zc
->zc_name
) - 1] = '\0';
7019 switch (vec
->zvec_namecheck
) {
7021 if (pool_namecheck(zc
->zc_name
, NULL
, NULL
) != 0)
7022 error
= SET_ERROR(EINVAL
);
7024 error
= pool_status_check(zc
->zc_name
,
7025 vec
->zvec_namecheck
, vec
->zvec_pool_check
);
7029 if (dataset_namecheck(zc
->zc_name
, NULL
, NULL
) != 0)
7030 error
= SET_ERROR(EINVAL
);
7032 error
= pool_status_check(zc
->zc_name
,
7033 vec
->zvec_namecheck
, vec
->zvec_pool_check
);
7041 * Ensure that all input pairs are valid before we pass them down
7042 * to the lower layers.
7044 * The vectored functions can use fnvlist_lookup_{type} for any
7045 * required pairs since zfs_check_input_nvpairs() confirmed that
7046 * they exist and are of the correct type.
7048 if (error
== 0 && vec
->zvec_func
!= NULL
) {
7049 error
= zfs_check_input_nvpairs(innvl
, vec
);
7055 cookie
= spl_fstrans_mark();
7056 error
= vec
->zvec_secpolicy(zc
, innvl
, CRED());
7057 spl_fstrans_unmark(cookie
);
7063 /* legacy ioctls can modify zc_name */
7064 saved_poolname
= strdup(zc
->zc_name
);
7065 if (saved_poolname
== NULL
) {
7066 error
= SET_ERROR(ENOMEM
);
7069 saved_poolname
[strcspn(saved_poolname
, "/@#")] = '\0';
7072 if (vec
->zvec_func
!= NULL
) {
7076 nvlist_t
*lognv
= NULL
;
7078 ASSERT(vec
->zvec_legacy_func
== NULL
);
7081 * Add the innvl to the lognv before calling the func,
7082 * in case the func changes the innvl.
7084 if (vec
->zvec_allow_log
) {
7085 lognv
= fnvlist_alloc();
7086 fnvlist_add_string(lognv
, ZPOOL_HIST_IOCTL
,
7088 if (!nvlist_empty(innvl
)) {
7089 fnvlist_add_nvlist(lognv
, ZPOOL_HIST_INPUT_NVL
,
7094 outnvl
= fnvlist_alloc();
7095 cookie
= spl_fstrans_mark();
7096 error
= vec
->zvec_func(zc
->zc_name
, innvl
, outnvl
);
7097 spl_fstrans_unmark(cookie
);
7100 * Some commands can partially execute, modify state, and still
7101 * return an error. In these cases, attempt to record what
7105 (cmd
== ZFS_IOC_CHANNEL_PROGRAM
&& error
!= EINVAL
)) &&
7106 vec
->zvec_allow_log
&&
7107 spa_open(zc
->zc_name
, &spa
, FTAG
) == 0) {
7108 if (!nvlist_empty(outnvl
)) {
7109 fnvlist_add_nvlist(lognv
, ZPOOL_HIST_OUTPUT_NVL
,
7113 fnvlist_add_int64(lognv
, ZPOOL_HIST_ERRNO
,
7116 (void) spa_history_log_nvl(spa
, lognv
);
7117 spa_close(spa
, FTAG
);
7119 fnvlist_free(lognv
);
7121 if (!nvlist_empty(outnvl
) || zc
->zc_nvlist_dst_size
!= 0) {
7123 if (vec
->zvec_smush_outnvlist
) {
7124 smusherror
= nvlist_smush(outnvl
,
7125 zc
->zc_nvlist_dst_size
);
7127 if (smusherror
== 0)
7128 puterror
= put_nvlist(zc
, outnvl
);
7134 nvlist_free(outnvl
);
7136 cookie
= spl_fstrans_mark();
7137 error
= vec
->zvec_legacy_func(zc
);
7138 spl_fstrans_unmark(cookie
);
7143 rc
= ddi_copyout(zc
, (void *)arg
, sizeof (zfs_cmd_t
), flag
);
7144 if (error
== 0 && rc
!= 0)
7145 error
= SET_ERROR(EFAULT
);
7146 if (error
== 0 && vec
->zvec_allow_log
) {
7147 char *s
= tsd_get(zfs_allow_log_key
);
7150 (void) tsd_set(zfs_allow_log_key
, saved_poolname
);
7152 if (saved_poolname
!= NULL
)
7153 strfree(saved_poolname
);
7156 kmem_free(zc
, sizeof (zfs_cmd_t
));
7160 #ifdef CONFIG_COMPAT
7162 zfsdev_compat_ioctl(struct file
*filp
, unsigned cmd
, unsigned long arg
)
7164 return (zfsdev_ioctl(filp
, cmd
, arg
));
7167 #define zfsdev_compat_ioctl NULL
7170 static const struct file_operations zfsdev_fops
= {
7171 .open
= zfsdev_open
,
7172 .release
= zfsdev_release
,
7173 .unlocked_ioctl
= zfsdev_ioctl
,
7174 .compat_ioctl
= zfsdev_compat_ioctl
,
7175 .owner
= THIS_MODULE
,
7178 static struct miscdevice zfs_misc
= {
7179 .minor
= ZFS_DEVICE_MINOR
,
7181 .fops
= &zfsdev_fops
,
7184 MODULE_ALIAS_MISCDEV(ZFS_DEVICE_MINOR
);
7185 MODULE_ALIAS("devname:zfs");
7192 mutex_init(&zfsdev_state_lock
, NULL
, MUTEX_DEFAULT
, NULL
);
7193 zfsdev_state_list
= kmem_zalloc(sizeof (zfsdev_state_t
), KM_SLEEP
);
7194 zfsdev_state_list
->zs_minor
= -1;
7196 error
= misc_register(&zfs_misc
);
7197 if (error
== -EBUSY
) {
7199 * Fallback to dynamic minor allocation in the event of a
7200 * collision with a reserved minor in linux/miscdevice.h.
7201 * In this case the kernel modules must be manually loaded.
7203 printk(KERN_INFO
"ZFS: misc_register() with static minor %d "
7204 "failed %d, retrying with MISC_DYNAMIC_MINOR\n",
7205 ZFS_DEVICE_MINOR
, error
);
7207 zfs_misc
.minor
= MISC_DYNAMIC_MINOR
;
7208 error
= misc_register(&zfs_misc
);
7212 printk(KERN_INFO
"ZFS: misc_register() failed %d\n", error
);
7220 zfsdev_state_t
*zs
, *zsprev
= NULL
;
7222 misc_deregister(&zfs_misc
);
7223 mutex_destroy(&zfsdev_state_lock
);
7225 for (zs
= zfsdev_state_list
; zs
!= NULL
; zs
= zs
->zs_next
) {
7227 kmem_free(zsprev
, sizeof (zfsdev_state_t
));
7231 kmem_free(zsprev
, sizeof (zfsdev_state_t
));
7235 zfs_allow_log_destroy(void *arg
)
7237 char *poolname
= arg
;
7239 if (poolname
!= NULL
)
7244 #define ZFS_DEBUG_STR " (DEBUG mode)"
7246 #define ZFS_DEBUG_STR ""
7254 error
= -vn_set_pwd("/");
7257 "ZFS: Warning unable to set pwd to '/': %d\n", error
);
7261 if ((error
= -zvol_init()) != 0)
7264 spa_init(FREAD
| FWRITE
);
7270 if ((error
= zfs_attach()) != 0)
7273 tsd_create(&zfs_fsyncer_key
, NULL
);
7274 tsd_create(&rrw_tsd_key
, rrw_tsd_destroy
);
7275 tsd_create(&zfs_allow_log_key
, zfs_allow_log_destroy
);
7277 printk(KERN_NOTICE
"ZFS: Loaded module v%s-%s%s, "
7278 "ZFS pool version %s, ZFS filesystem version %s\n",
7279 ZFS_META_VERSION
, ZFS_META_RELEASE
, ZFS_DEBUG_STR
,
7280 SPA_VERSION_STRING
, ZPL_VERSION_STRING
);
7281 #ifndef CONFIG_FS_POSIX_ACL
7282 printk(KERN_NOTICE
"ZFS: Posix ACLs disabled by kernel\n");
7283 #endif /* CONFIG_FS_POSIX_ACL */
7292 printk(KERN_NOTICE
"ZFS: Failed to Load ZFS Filesystem v%s-%s%s"
7293 ", rc = %d\n", ZFS_META_VERSION
, ZFS_META_RELEASE
,
7294 ZFS_DEBUG_STR
, error
);
7308 tsd_destroy(&zfs_fsyncer_key
);
7309 tsd_destroy(&rrw_tsd_key
);
7310 tsd_destroy(&zfs_allow_log_key
);
7312 printk(KERN_NOTICE
"ZFS: Unloaded module v%s-%s%s\n",
7313 ZFS_META_VERSION
, ZFS_META_RELEASE
, ZFS_DEBUG_STR
);
7316 #if defined(_KERNEL)
7320 MODULE_DESCRIPTION("ZFS");
7321 MODULE_AUTHOR(ZFS_META_AUTHOR
);
7322 MODULE_LICENSE(ZFS_META_LICENSE
);
7323 MODULE_VERSION(ZFS_META_VERSION
"-" ZFS_META_RELEASE
);