4 * This file and its contents are supplied under the terms of the
5 * Common Development and Distribution License ("CDDL"), version 1.0.
6 * You may only use this file in accordance with the terms of version
9 * A full copy of the text of the CDDL should have accompanied this
10 * source. A copy of the CDDL is also available via the Internet at
11 * http://www.illumos.org/license/CDDL.
17 * Copyright (c) 2016, 2017 by Delphix. All rights reserved.
26 #include <sys/dsl_prop.h>
27 #include <sys/dsl_synctask.h>
28 #include <sys/dsl_dataset.h>
29 #include <sys/dsl_dir.h>
30 #include <sys/dmu_objset.h>
31 #include <sys/mntent.h>
32 #include <sys/sunddi.h>
35 #include <sys/zcp_iter.h>
36 #include <sys/zcp_global.h>
37 #include <sys/zfs_ioctl.h>
38 #include <sys/zfs_znode.h>
42 #include <sys/zfs_vfsops.h>
46 get_objset_type(dsl_dataset_t *ds, zfs_type_t *type)
50 error = dmu_objset_from_ds(ds, &os);
53 if (ds->ds_is_snapshot) {
54 *type = ZFS_TYPE_SNAPSHOT;
56 switch (os->os_phys->os_type) {
58 *type = ZFS_TYPE_FILESYSTEM;
61 *type = ZFS_TYPE_VOLUME;
71 * Returns the string name of ds's type in str (a buffer which should be
72 * at least 12 bytes long).
75 get_objset_type_name(dsl_dataset_t *ds, char *str)
79 error = get_objset_type(ds, &type);
83 case ZFS_TYPE_SNAPSHOT:
84 (void) strcpy(str, "snapshot");
86 case ZFS_TYPE_FILESYSTEM:
87 (void) strcpy(str, "filesystem");
90 (void) strcpy(str, "volume");
99 * Determines the source of a property given its setpoint and
100 * property type. It pushes the source to the lua stack.
103 get_prop_src(lua_State *state, const char *setpoint, zfs_prop_t prop)
105 if (zfs_prop_readonly(prop) || (prop == ZFS_PROP_VERSION)) {
109 if (strcmp("", setpoint) == 0) {
114 (void) lua_pushstring(state, src);
119 * Given an error encountered while getting properties, either longjmp's for
120 * a fatal error or pushes nothing to the stack for a non fatal one.
123 zcp_handle_error(lua_State *state, const char *dataset_name,
124 const char *property_name, int error)
126 ASSERT3S(error, !=, 0);
127 if (error == ENOENT) {
129 } else if (error == EINVAL) {
130 return (luaL_error(state,
131 "property '%s' is not a valid property on dataset '%s'",
132 property_name, dataset_name));
133 } else if (error == EIO) {
134 return (luaL_error(state,
135 "I/O error while retrieving property '%s' on dataset '%s'",
136 property_name, dataset_name));
138 return (luaL_error(state, "unexpected error %d while "
139 "retrieving property '%s' on dataset '%s'",
140 error, property_name, dataset_name));
145 * Look up a user defined property in the zap object. If it exists, push it
146 * and the setpoint onto the stack, otherwise don't push anything.
149 zcp_get_user_prop(lua_State *state, dsl_pool_t *dp, const char *dataset_name,
150 const char *property_name)
154 char setpoint[ZFS_MAX_DATASET_NAME_LEN];
156 * zcp_dataset_hold will either successfully return the requested
157 * dataset or throw a lua error and longjmp out of the zfs.get_prop call
160 dsl_dataset_t *ds = zcp_dataset_hold(state, dp, dataset_name, FTAG);
162 return (1); /* not reached; zcp_dataset_hold() longjmp'd */
164 buf = kmem_alloc(ZAP_MAXVALUELEN, KM_SLEEP);
165 error = dsl_prop_get_ds(ds, property_name, 1, ZAP_MAXVALUELEN,
167 dsl_dataset_rele(ds, FTAG);
170 kmem_free(buf, ZAP_MAXVALUELEN);
171 return (zcp_handle_error(state, dataset_name, property_name,
174 (void) lua_pushstring(state, buf);
175 (void) lua_pushstring(state, setpoint);
176 kmem_free(buf, ZAP_MAXVALUELEN);
181 * Check if the property we're looking for is stored in the ds_dir. If so,
182 * return it in the 'val' argument. Return 0 on success and ENOENT and if
183 * the property is not present.
186 get_dsl_dir_prop(dsl_dataset_t *ds, zfs_prop_t zfs_prop,
189 dsl_dir_t *dd = ds->ds_dir;
190 mutex_enter(&dd->dd_lock);
192 case ZFS_PROP_USEDSNAP:
193 *val = dsl_dir_get_usedsnap(dd);
195 case ZFS_PROP_USEDCHILD:
196 *val = dsl_dir_get_usedchild(dd);
198 case ZFS_PROP_USEDDS:
199 *val = dsl_dir_get_usedds(dd);
201 case ZFS_PROP_USEDREFRESERV:
202 *val = dsl_dir_get_usedrefreserv(dd);
204 case ZFS_PROP_LOGICALUSED:
205 *val = dsl_dir_get_logicalused(dd);
208 mutex_exit(&dd->dd_lock);
211 mutex_exit(&dd->dd_lock);
216 * Takes a dataset, a property, a value and that value's setpoint as
217 * found in the ZAP. Checks if the property has been changed in the vfs.
218 * If so, val and setpoint will be overwritten with updated content.
219 * Otherwise, they are left unchanged.
222 get_temporary_prop(dsl_dataset_t *ds, zfs_prop_t zfs_prop, uint64_t *val,
236 error = dmu_objset_from_ds(ds, &os);
240 error = getzfsvfs_impl(os, &vfsp);
248 if (vfs_optionisset(vfsp, MNTOPT_NOATIME, NULL))
250 if (vfs_optionisset(vfsp, MNTOPT_ATIME, NULL))
253 case ZFS_PROP_DEVICES:
254 if (vfs_optionisset(vfsp, MNTOPT_NODEVICES, NULL))
256 if (vfs_optionisset(vfsp, MNTOPT_DEVICES, NULL))
260 if (vfs_optionisset(vfsp, MNTOPT_NOEXEC, NULL))
262 if (vfs_optionisset(vfsp, MNTOPT_EXEC, NULL))
265 case ZFS_PROP_SETUID:
266 if (vfs_optionisset(vfsp, MNTOPT_NOSETUID, NULL))
268 if (vfs_optionisset(vfsp, MNTOPT_SETUID, NULL))
271 case ZFS_PROP_READONLY:
272 if (vfs_optionisset(vfsp, MNTOPT_RW, NULL))
274 if (vfs_optionisset(vfsp, MNTOPT_RO, NULL))
278 if (vfs_optionisset(vfsp, MNTOPT_NOXATTR, NULL))
280 if (vfs_optionisset(vfsp, MNTOPT_XATTR, NULL))
283 case ZFS_PROP_NBMAND:
284 if (vfs_optionisset(vfsp, MNTOPT_NONBMAND, NULL))
286 if (vfs_optionisset(vfsp, MNTOPT_NBMAND, NULL))
304 (void) strcpy(setpoint, "temporary");
312 * Check if the property we're looking for is stored at the dsl_dataset or
313 * dsl_dir level. If so, push the property value and source onto the lua stack
314 * and return 0. If it is not present or a failure occurs in lookup, return a
315 * non-zero error value.
318 get_special_prop(lua_State *state, dsl_dataset_t *ds, const char *dsname,
324 char *strval = kmem_alloc(ZAP_MAXVALUELEN, KM_SLEEP);
325 char setpoint[ZFS_MAX_DATASET_NAME_LEN] =
326 "Internal error - setpoint not determined";
328 zprop_type_t prop_type = zfs_prop_get_type(zfs_prop);
329 (void) get_objset_type(ds, &ds_type);
332 case ZFS_PROP_REFRATIO:
333 numval = dsl_get_refratio(ds);
336 numval = dsl_get_used(ds);
338 case ZFS_PROP_CLONES: {
339 nvlist_t *clones = fnvlist_alloc();
340 error = get_clones_stat_impl(ds, clones);
342 /* push list to lua stack */
343 VERIFY0(zcp_nvlist_to_lua(state, clones, NULL, 0));
345 (void) lua_pushnil(state);
348 kmem_free(strval, ZAP_MAXVALUELEN);
351 case ZFS_PROP_COMPRESSRATIO:
352 numval = dsl_get_compressratio(ds);
354 case ZFS_PROP_CREATION:
355 numval = dsl_get_creation(ds);
357 case ZFS_PROP_REFERENCED:
358 numval = dsl_get_referenced(ds);
360 case ZFS_PROP_AVAILABLE:
361 numval = dsl_get_available(ds);
363 case ZFS_PROP_LOGICALREFERENCED:
364 numval = dsl_get_logicalreferenced(ds);
366 case ZFS_PROP_CREATETXG:
367 numval = dsl_get_creationtxg(ds);
370 numval = dsl_get_guid(ds);
372 case ZFS_PROP_UNIQUE:
373 numval = dsl_get_unique(ds);
375 case ZFS_PROP_OBJSETID:
376 numval = dsl_get_objsetid(ds);
378 case ZFS_PROP_ORIGIN:
379 dsl_dir_get_origin(ds->ds_dir, strval);
381 case ZFS_PROP_USERACCOUNTING:
382 error = dmu_objset_from_ds(ds, &os);
384 numval = dmu_objset_userspace_present(os);
386 case ZFS_PROP_WRITTEN:
387 error = dsl_get_written(ds, &numval);
390 error = get_objset_type_name(ds, strval);
392 case ZFS_PROP_PREV_SNAP:
393 error = dsl_get_prev_snap(ds, strval);
396 dsl_dataset_name(ds, strval);
398 case ZFS_PROP_MOUNTPOINT:
399 error = dsl_get_mountpoint(ds, dsname, strval, setpoint);
401 case ZFS_PROP_VERSION:
402 /* should be a snapshot or filesystem */
403 ASSERT(ds_type != ZFS_TYPE_VOLUME);
404 error = dmu_objset_from_ds(ds, &os);
405 /* look in the master node for the version */
407 error = zap_lookup(os, MASTER_NODE_OBJ, ZPL_VERSION_STR,
408 sizeof (numval), 1, &numval);
411 case ZFS_PROP_DEFER_DESTROY:
412 numval = dsl_get_defer_destroy(ds);
414 case ZFS_PROP_USERREFS:
415 numval = dsl_get_userrefs(ds);
417 case ZFS_PROP_FILESYSTEM_COUNT:
418 error = dsl_dir_get_filesystem_count(ds->ds_dir, &numval);
419 (void) strcpy(setpoint, "");
421 case ZFS_PROP_SNAPSHOT_COUNT:
422 error = dsl_dir_get_snapshot_count(ds->ds_dir, &numval);
423 (void) strcpy(setpoint, "");
425 case ZFS_PROP_REMAPTXG:
426 error = dsl_dir_get_remaptxg(ds->ds_dir, &numval);
428 case ZFS_PROP_NUMCLONES:
429 numval = dsl_get_numclones(ds);
431 case ZFS_PROP_INCONSISTENT:
432 numval = dsl_get_inconsistent(ds);
434 case ZFS_PROP_RECEIVE_RESUME_TOKEN: {
435 char *token = get_receive_resume_stats_impl(ds);
436 VERIFY3U(strlcpy(strval, token, ZAP_MAXVALUELEN), <,
439 if (strcmp(strval, "") == 0) {
440 token = get_child_receive_stats(ds);
441 VERIFY3U(strlcpy(strval, token, ZAP_MAXVALUELEN), <,
444 if (strcmp(strval, "") == 0)
449 case ZFS_PROP_VOLSIZE:
450 ASSERT(ds_type == ZFS_TYPE_VOLUME);
451 error = dmu_objset_from_ds(ds, &os);
453 error = zap_lookup(os, ZVOL_ZAP_OBJ, "size",
454 sizeof (numval), 1, &numval);
457 (void) strcpy(setpoint, dsname);
460 case ZFS_PROP_VOLBLOCKSIZE: {
461 ASSERT(ds_type == ZFS_TYPE_VOLUME);
462 dmu_object_info_t doi;
463 error = dmu_objset_from_ds(ds, &os);
465 error = dmu_object_info(os, ZVOL_OBJ, &doi);
467 numval = doi.doi_data_block_size;
472 /* Did not match these props, check in the dsl_dir */
473 error = get_dsl_dir_prop(ds, zfs_prop, &numval);
476 kmem_free(strval, ZAP_MAXVALUELEN);
481 case PROP_TYPE_NUMBER: {
482 (void) lua_pushnumber(state, numval);
485 case PROP_TYPE_STRING: {
486 (void) lua_pushstring(state, strval);
489 case PROP_TYPE_INDEX: {
491 error = zfs_prop_index_to_string(zfs_prop, numval, &propval);
493 kmem_free(strval, ZAP_MAXVALUELEN);
496 (void) lua_pushstring(state, propval);
500 kmem_free(strval, ZAP_MAXVALUELEN);
502 /* Push the source to the stack */
503 get_prop_src(state, setpoint, zfs_prop);
508 * Look up a property and its source in the zap object. If the value is
509 * present and successfully retrieved, push the value and source on the
510 * lua stack and return 0. On failure, return a non-zero error value.
513 get_zap_prop(lua_State *state, dsl_dataset_t *ds, zfs_prop_t zfs_prop)
516 char setpoint[ZFS_MAX_DATASET_NAME_LEN];
517 char *strval = kmem_alloc(ZAP_MAXVALUELEN, KM_SLEEP);
519 const char *prop_name = zfs_prop_to_name(zfs_prop);
520 zprop_type_t prop_type = zfs_prop_get_type(zfs_prop);
522 if (prop_type == PROP_TYPE_STRING) {
523 /* Push value to lua stack */
524 error = dsl_prop_get_ds(ds, prop_name, 1,
525 ZAP_MAXVALUELEN, strval, setpoint);
527 (void) lua_pushstring(state, strval);
529 error = dsl_prop_get_ds(ds, prop_name, sizeof (numval),
530 1, &numval, setpoint);
532 /* Fill in temorary value for prop, if applicable */
533 (void) get_temporary_prop(ds, zfs_prop, &numval, setpoint);
535 /* Push value to lua stack */
536 if (prop_type == PROP_TYPE_INDEX) {
538 error = zfs_prop_index_to_string(zfs_prop, numval,
541 (void) lua_pushstring(state, propval);
544 (void) lua_pushnumber(state, numval);
547 kmem_free(strval, ZAP_MAXVALUELEN);
549 get_prop_src(state, setpoint, zfs_prop);
554 * Determine whether property is valid for a given dataset
557 prop_valid_for_ds(dsl_dataset_t *ds, zfs_prop_t zfs_prop)
562 /* properties not supported */
563 if ((zfs_prop == ZFS_PROP_ISCSIOPTIONS) ||
564 (zfs_prop == ZFS_PROP_MOUNTED))
567 /* if we want the origin prop, ds must be a clone */
568 if ((zfs_prop == ZFS_PROP_ORIGIN) && (!dsl_dir_is_clone(ds->ds_dir)))
571 error = get_objset_type(ds, &zfs_type);
574 return (zfs_prop_valid_for_type(zfs_prop, zfs_type));
578 * Look up a given dataset property. On success return 2, the number of
579 * values pushed to the lua stack (property value and source). On a fatal
580 * error, longjmp. On a non fatal error push nothing.
583 zcp_get_system_prop(lua_State *state, dsl_pool_t *dp, const char *dataset_name,
588 * zcp_dataset_hold will either successfully return the requested
589 * dataset or throw a lua error and longjmp out of the zfs.get_prop call
592 dsl_dataset_t *ds = zcp_dataset_hold(state, dp, dataset_name, FTAG);
594 return (1); /* not reached; zcp_dataset_hold() longjmp'd */
596 /* Check that the property is valid for the given dataset */
597 const char *prop_name = zfs_prop_to_name(zfs_prop);
598 if (!prop_valid_for_ds(ds, zfs_prop)) {
599 dsl_dataset_rele(ds, FTAG);
603 /* Check if the property can be accessed directly */
604 error = get_special_prop(state, ds, dataset_name, zfs_prop);
606 dsl_dataset_rele(ds, FTAG);
607 /* The value and source have been pushed by get_special_prop */
610 if (error != ENOENT) {
611 dsl_dataset_rele(ds, FTAG);
612 return (zcp_handle_error(state, dataset_name,
616 /* If we were unable to find it, look in the zap object */
617 error = get_zap_prop(state, ds, zfs_prop);
618 dsl_dataset_rele(ds, FTAG);
620 return (zcp_handle_error(state, dataset_name,
623 /* The value and source have been pushed by get_zap_prop */
627 static zfs_userquota_prop_t
628 get_userquota_prop(const char *prop_name)
630 zfs_userquota_prop_t type;
631 /* Figure out the property type ({user|group}{quota|used}) */
632 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
633 if (strncmp(prop_name, zfs_userquota_prop_prefixes[type],
634 strlen(zfs_userquota_prop_prefixes[type])) == 0)
642 * Given the name of a zfs_userquota_prop, this function determines the
643 * prop type as well as the numeric group/user ids based on the string
644 * following the '@' in the property name. On success, returns 0. On failure,
645 * returns a non-zero error.
646 * 'domain' must be free'd by caller using strfree()
649 parse_userquota_prop(const char *prop_name, zfs_userquota_prop_t *type,
650 char **domain, uint64_t *rid)
652 char *cp, *end, *domain_val;
654 *type = get_userquota_prop(prop_name);
655 if (*type >= ZFS_NUM_USERQUOTA_PROPS)
659 cp = strchr(prop_name, '@') + 1;
660 if (strncmp(cp, "S-1-", 4) == 0) {
662 * It's a numeric SID (eg "S-1-234-567-89") and we want to
663 * seperate the domain id and the rid
665 int domain_len = strrchr(cp, '-') - cp;
666 domain_val = kmem_alloc(domain_len + 1, KM_SLEEP);
667 (void) strncpy(domain_val, cp, domain_len);
668 domain_val[domain_len] = '\0';
669 cp += domain_len + 1;
671 (void) ddi_strtoll(cp, &end, 10, (longlong_t *)rid);
677 /* It's only a user/group ID (eg "12345"), just get the rid */
679 (void) ddi_strtoll(cp, &end, 10, (longlong_t *)rid);
683 *domain = domain_val;
688 * Look up {user|group}{quota|used} property for given dataset. On success
689 * push the value (quota or used amount) and the setpoint. On failure, push
693 zcp_get_userquota_prop(lua_State *state, dsl_pool_t *dp,
694 const char *dataset_name, const char *prop_name)
699 zfs_userquota_prop_t type;
704 dsl_dataset_t *ds = zcp_dataset_hold(state, dp, dataset_name, FTAG);
706 return (1); /* not reached; zcp_dataset_hold() longjmp'd */
708 error = parse_userquota_prop(prop_name, &type, &domain, &rid);
710 error = dmu_objset_from_ds(ds, &os);
712 zfsvfs = kmem_zalloc(sizeof (zfsvfs_t), KM_SLEEP);
713 error = zfsvfs_create_impl(&zfvp, zfsvfs, os);
715 error = zfs_userspace_one(zfvp, type, domain,
723 dsl_dataset_rele(ds, FTAG);
725 if ((value == 0) && ((type == ZFS_PROP_USERQUOTA) ||
726 (type == ZFS_PROP_GROUPQUOTA)))
729 return (zcp_handle_error(state, dataset_name,
733 (void) lua_pushnumber(state, value);
734 (void) lua_pushstring(state, dataset_name);
740 * Determines the name of the snapshot referenced in the written property
741 * name. Returns snapshot name in snap_name, a buffer that must be at least
742 * as large as ZFS_MAX_DATASET_NAME_LEN
745 parse_written_prop(const char *dataset_name, const char *prop_name,
748 ASSERT(zfs_prop_written(prop_name));
749 const char *name = prop_name + ZFS_WRITTEN_PROP_PREFIX_LEN;
750 if (strchr(name, '@') == NULL) {
751 (void) sprintf(snap_name, "%s@%s", dataset_name, name);
753 (void) strcpy(snap_name, name);
758 * Look up written@ property for given dataset. On success
759 * push the value and the setpoint. If error is fatal, we will
760 * longjmp, otherwise push nothing.
763 zcp_get_written_prop(lua_State *state, dsl_pool_t *dp,
764 const char *dataset_name, const char *prop_name)
766 char snap_name[ZFS_MAX_DATASET_NAME_LEN];
767 uint64_t used, comp, uncomp;
771 parse_written_prop(dataset_name, prop_name, snap_name);
772 dsl_dataset_t *new = zcp_dataset_hold(state, dp, dataset_name, FTAG);
774 return (1); /* not reached; zcp_dataset_hold() longjmp'd */
776 error = dsl_dataset_hold(dp, snap_name, FTAG, &old);
778 dsl_dataset_rele(new, FTAG);
779 return (zcp_dataset_hold_error(state, dp, snap_name,
782 error = dsl_dataset_space_written(old, new,
783 &used, &comp, &uncomp);
785 dsl_dataset_rele(old, FTAG);
786 dsl_dataset_rele(new, FTAG);
789 return (zcp_handle_error(state, dataset_name,
792 (void) lua_pushnumber(state, used);
793 (void) lua_pushstring(state, dataset_name);
797 static int zcp_get_prop(lua_State *state);
798 static zcp_lib_info_t zcp_get_prop_info = {
800 .func = zcp_get_prop,
802 { .za_name = "dataset", .za_lua_type = LUA_TSTRING},
803 { .za_name = "property", .za_lua_type = LUA_TSTRING},
812 zcp_get_prop(lua_State *state)
814 const char *dataset_name;
815 const char *property_name;
816 dsl_pool_t *dp = zcp_run_info(state)->zri_pool;
817 zcp_lib_info_t *libinfo = &zcp_get_prop_info;
819 zcp_parse_args(state, libinfo->name, libinfo->pargs, libinfo->kwargs);
821 dataset_name = lua_tostring(state, 1);
822 property_name = lua_tostring(state, 2);
824 /* User defined property */
825 if (zfs_prop_user(property_name)) {
826 return (zcp_get_user_prop(state, dp,
827 dataset_name, property_name));
829 /* userspace property */
830 if (zfs_prop_userquota(property_name)) {
832 return (zcp_get_userquota_prop(state, dp,
833 dataset_name, property_name));
835 return (luaL_error(state,
836 "user quota properties only supported in kernel mode",
840 /* written@ property */
841 if (zfs_prop_written(property_name)) {
842 return (zcp_get_written_prop(state, dp,
843 dataset_name, property_name));
846 zfs_prop_t zfs_prop = zfs_name_to_prop(property_name);
847 /* Valid system property */
848 if (zfs_prop != ZPROP_INVAL) {
849 return (zcp_get_system_prop(state, dp, dataset_name,
853 /* Invalid property name */
854 return (luaL_error(state,
855 "'%s' is not a valid property", property_name));
859 zcp_load_get_lib(lua_State *state)
861 lua_pushcclosure(state, zcp_get_prop_info.func, 0);
862 lua_setfield(state, -2, zcp_get_prop_info.name);