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 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,
234 error = dmu_objset_from_ds(ds, &os);
238 error = getzfsvfs_impl(os, &zfvp);
246 if (vfs_optionisset(vfsp, MNTOPT_NOATIME, NULL))
248 if (vfs_optionisset(vfsp, MNTOPT_ATIME, NULL))
251 case ZFS_PROP_DEVICES:
252 if (vfs_optionisset(vfsp, MNTOPT_NODEVICES, NULL))
254 if (vfs_optionisset(vfsp, MNTOPT_DEVICES, NULL))
258 if (vfs_optionisset(vfsp, MNTOPT_NOEXEC, NULL))
260 if (vfs_optionisset(vfsp, MNTOPT_EXEC, NULL))
263 case ZFS_PROP_SETUID:
264 if (vfs_optionisset(vfsp, MNTOPT_NOSETUID, NULL))
266 if (vfs_optionisset(vfsp, MNTOPT_SETUID, NULL))
269 case ZFS_PROP_READONLY:
270 if (vfs_optionisset(vfsp, MNTOPT_RW, NULL))
272 if (vfs_optionisset(vfsp, MNTOPT_RO, NULL))
276 if (vfs_optionisset(vfsp, MNTOPT_NOXATTR, NULL))
278 if (vfs_optionisset(vfsp, MNTOPT_XATTR, NULL))
281 case ZFS_PROP_NBMAND:
282 if (vfs_optionisset(vfsp, MNTOPT_NONBMAND, NULL))
284 if (vfs_optionisset(vfsp, MNTOPT_NBMAND, NULL))
302 (void) strcpy(setpoint, "temporary");
310 * Check if the property we're looking for is stored at the dsl_dataset or
311 * dsl_dir level. If so, push the property value and source onto the lua stack
312 * and return 0. If it is not present or a failure occurs in lookup, return a
313 * non-zero error value.
316 get_special_prop(lua_State *state, dsl_dataset_t *ds, const char *dsname,
322 char *strval = kmem_alloc(ZAP_MAXVALUELEN, KM_SLEEP);
323 char setpoint[ZFS_MAX_DATASET_NAME_LEN] =
324 "Internal error - setpoint not determined";
326 zprop_type_t prop_type = zfs_prop_get_type(zfs_prop);
327 (void) get_objset_type(ds, &ds_type);
330 case ZFS_PROP_REFRATIO:
331 numval = dsl_get_refratio(ds);
334 numval = dsl_get_used(ds);
336 case ZFS_PROP_CLONES: {
337 nvlist_t *clones = fnvlist_alloc();
338 error = get_clones_stat_impl(ds, clones);
340 /* push list to lua stack */
341 VERIFY0(zcp_nvlist_to_lua(state, clones, NULL, 0));
343 (void) lua_pushnil(state);
346 kmem_free(strval, ZAP_MAXVALUELEN);
349 case ZFS_PROP_COMPRESSRATIO:
350 numval = dsl_get_compressratio(ds);
352 case ZFS_PROP_CREATION:
353 numval = dsl_get_creation(ds);
355 case ZFS_PROP_REFERENCED:
356 numval = dsl_get_referenced(ds);
358 case ZFS_PROP_AVAILABLE:
359 numval = dsl_get_available(ds);
361 case ZFS_PROP_LOGICALREFERENCED:
362 numval = dsl_get_logicalreferenced(ds);
364 case ZFS_PROP_CREATETXG:
365 numval = dsl_get_creationtxg(ds);
368 numval = dsl_get_guid(ds);
370 case ZFS_PROP_UNIQUE:
371 numval = dsl_get_unique(ds);
373 case ZFS_PROP_OBJSETID:
374 numval = dsl_get_objsetid(ds);
376 case ZFS_PROP_ORIGIN:
377 dsl_dir_get_origin(ds->ds_dir, strval);
379 case ZFS_PROP_USERACCOUNTING:
380 error = dmu_objset_from_ds(ds, &os);
382 numval = dmu_objset_userspace_present(os);
384 case ZFS_PROP_WRITTEN:
385 error = dsl_get_written(ds, &numval);
388 error = get_objset_type_name(ds, strval);
390 case ZFS_PROP_PREV_SNAP:
391 error = dsl_get_prev_snap(ds, strval);
394 dsl_dataset_name(ds, strval);
396 case ZFS_PROP_MOUNTPOINT:
397 error = dsl_get_mountpoint(ds, dsname, strval, setpoint);
399 case ZFS_PROP_VERSION:
400 /* should be a snapshot or filesystem */
401 ASSERT(ds_type != ZFS_TYPE_VOLUME);
402 error = dmu_objset_from_ds(ds, &os);
403 /* look in the master node for the version */
405 error = zap_lookup(os, MASTER_NODE_OBJ, ZPL_VERSION_STR,
406 sizeof (numval), 1, &numval);
409 case ZFS_PROP_DEFER_DESTROY:
410 numval = dsl_get_defer_destroy(ds);
412 case ZFS_PROP_USERREFS:
413 numval = dsl_get_userrefs(ds);
415 case ZFS_PROP_FILESYSTEM_COUNT:
416 error = dsl_dir_get_filesystem_count(ds->ds_dir, &numval);
417 (void) strcpy(setpoint, "");
419 case ZFS_PROP_SNAPSHOT_COUNT:
420 error = dsl_dir_get_snapshot_count(ds->ds_dir, &numval);
421 (void) strcpy(setpoint, "");
423 case ZFS_PROP_REMAPTXG:
424 error = dsl_dir_get_remaptxg(ds->ds_dir, &numval);
426 case ZFS_PROP_NUMCLONES:
427 numval = dsl_get_numclones(ds);
429 case ZFS_PROP_INCONSISTENT:
430 numval = dsl_get_inconsistent(ds);
432 case ZFS_PROP_RECEIVE_RESUME_TOKEN:
433 VERIFY3U(strlcpy(strval, get_receive_resume_stats_impl(ds),
434 ZAP_MAXVALUELEN), <, ZAP_MAXVALUELEN);
435 if (strcmp(strval, "") == 0) {
436 VERIFY3U(strlcpy(strval, get_child_receive_stats(ds),
437 ZAP_MAXVALUELEN), <, ZAP_MAXVALUELEN);
438 if (strcmp(strval, "") == 0)
442 case ZFS_PROP_VOLSIZE:
443 ASSERT(ds_type == ZFS_TYPE_VOLUME);
444 error = dmu_objset_from_ds(ds, &os);
446 error = zap_lookup(os, ZVOL_ZAP_OBJ, "size",
447 sizeof (numval), 1, &numval);
450 (void) strcpy(setpoint, dsname);
453 case ZFS_PROP_VOLBLOCKSIZE: {
454 ASSERT(ds_type == ZFS_TYPE_VOLUME);
455 dmu_object_info_t doi;
456 error = dmu_objset_from_ds(ds, &os);
458 error = dmu_object_info(os, ZVOL_OBJ, &doi);
460 numval = doi.doi_data_block_size;
465 /* Did not match these props, check in the dsl_dir */
466 error = get_dsl_dir_prop(ds, zfs_prop, &numval);
469 kmem_free(strval, ZAP_MAXVALUELEN);
474 case PROP_TYPE_NUMBER: {
475 (void) lua_pushnumber(state, numval);
478 case PROP_TYPE_STRING: {
479 (void) lua_pushstring(state, strval);
482 case PROP_TYPE_INDEX: {
484 error = zfs_prop_index_to_string(zfs_prop, numval, &propval);
486 kmem_free(strval, ZAP_MAXVALUELEN);
489 (void) lua_pushstring(state, propval);
493 kmem_free(strval, ZAP_MAXVALUELEN);
495 /* Push the source to the stack */
496 get_prop_src(state, setpoint, zfs_prop);
501 * Look up a property and its source in the zap object. If the value is
502 * present and successfully retrieved, push the value and source on the
503 * lua stack and return 0. On failure, return a non-zero error value.
506 get_zap_prop(lua_State *state, dsl_dataset_t *ds, zfs_prop_t zfs_prop)
509 char setpoint[ZFS_MAX_DATASET_NAME_LEN];
510 char *strval = kmem_alloc(ZAP_MAXVALUELEN, KM_SLEEP);
512 const char *prop_name = zfs_prop_to_name(zfs_prop);
513 zprop_type_t prop_type = zfs_prop_get_type(zfs_prop);
515 if (prop_type == PROP_TYPE_STRING) {
516 /* Push value to lua stack */
517 error = dsl_prop_get_ds(ds, prop_name, 1,
518 ZAP_MAXVALUELEN, strval, setpoint);
520 (void) lua_pushstring(state, strval);
522 error = dsl_prop_get_ds(ds, prop_name, sizeof (numval),
523 1, &numval, setpoint);
525 /* Fill in temorary value for prop, if applicable */
526 (void) get_temporary_prop(ds, zfs_prop, &numval, setpoint);
528 /* Push value to lua stack */
529 if (prop_type == PROP_TYPE_INDEX) {
531 error = zfs_prop_index_to_string(zfs_prop, numval,
534 (void) lua_pushstring(state, propval);
537 (void) lua_pushnumber(state, numval);
540 kmem_free(strval, ZAP_MAXVALUELEN);
542 get_prop_src(state, setpoint, zfs_prop);
547 * Determine whether property is valid for a given dataset
550 prop_valid_for_ds(dsl_dataset_t *ds, zfs_prop_t zfs_prop)
555 /* properties not supported */
556 if ((zfs_prop == ZFS_PROP_ISCSIOPTIONS) ||
557 (zfs_prop == ZFS_PROP_MOUNTED))
560 /* if we want the origin prop, ds must be a clone */
561 if ((zfs_prop == ZFS_PROP_ORIGIN) && (!dsl_dir_is_clone(ds->ds_dir)))
564 error = get_objset_type(ds, &zfs_type);
567 return (zfs_prop_valid_for_type(zfs_prop, zfs_type));
571 * Look up a given dataset property. On success return 2, the number of
572 * values pushed to the lua stack (property value and source). On a fatal
573 * error, longjmp. On a non fatal error push nothing.
576 zcp_get_system_prop(lua_State *state, dsl_pool_t *dp, const char *dataset_name,
581 * zcp_dataset_hold will either successfully return the requested
582 * dataset or throw a lua error and longjmp out of the zfs.get_prop call
585 dsl_dataset_t *ds = zcp_dataset_hold(state, dp, dataset_name, FTAG);
587 return (1); /* not reached; zcp_dataset_hold() longjmp'd */
589 /* Check that the property is valid for the given dataset */
590 const char *prop_name = zfs_prop_to_name(zfs_prop);
591 if (!prop_valid_for_ds(ds, zfs_prop)) {
592 dsl_dataset_rele(ds, FTAG);
596 /* Check if the property can be accessed directly */
597 error = get_special_prop(state, ds, dataset_name, zfs_prop);
599 dsl_dataset_rele(ds, FTAG);
600 /* The value and source have been pushed by get_special_prop */
603 if (error != ENOENT) {
604 dsl_dataset_rele(ds, FTAG);
605 return (zcp_handle_error(state, dataset_name,
609 /* If we were unable to find it, look in the zap object */
610 error = get_zap_prop(state, ds, zfs_prop);
611 dsl_dataset_rele(ds, FTAG);
613 return (zcp_handle_error(state, dataset_name,
616 /* The value and source have been pushed by get_zap_prop */
620 static zfs_userquota_prop_t
621 get_userquota_prop(const char *prop_name)
623 zfs_userquota_prop_t type;
624 /* Figure out the property type ({user|group}{quota|used}) */
625 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
626 if (strncmp(prop_name, zfs_userquota_prop_prefixes[type],
627 strlen(zfs_userquota_prop_prefixes[type])) == 0)
635 * Given the name of a zfs_userquota_prop, this function determines the
636 * prop type as well as the numeric group/user ids based on the string
637 * following the '@' in the property name. On success, returns 0. On failure,
638 * returns a non-zero error.
639 * 'domain' must be free'd by caller using strfree()
642 parse_userquota_prop(const char *prop_name, zfs_userquota_prop_t *type,
643 char **domain, uint64_t *rid)
645 char *cp, *end, *domain_val;
647 *type = get_userquota_prop(prop_name);
648 if (*type >= ZFS_NUM_USERQUOTA_PROPS)
652 cp = strchr(prop_name, '@') + 1;
653 if (strncmp(cp, "S-1-", 4) == 0) {
655 * It's a numeric SID (eg "S-1-234-567-89") and we want to
656 * seperate the domain id and the rid
658 int domain_len = strrchr(cp, '-') - cp;
659 domain_val = kmem_alloc(domain_len + 1, KM_SLEEP);
660 (void) strncpy(domain_val, cp, domain_len);
661 domain_val[domain_len] = '\0';
662 cp += domain_len + 1;
664 (void) ddi_strtoll(cp, &end, 10, (longlong_t *)rid);
670 /* It's only a user/group ID (eg "12345"), just get the rid */
672 (void) ddi_strtoll(cp, &end, 10, (longlong_t *)rid);
676 *domain = domain_val;
681 * Look up {user|group}{quota|used} property for given dataset. On success
682 * push the value (quota or used amount) and the setpoint. On failure, push
686 zcp_get_userquota_prop(lua_State *state, dsl_pool_t *dp,
687 const char *dataset_name, const char *prop_name)
692 zfs_userquota_prop_t type;
697 dsl_dataset_t *ds = zcp_dataset_hold(state, dp, dataset_name, FTAG);
699 return (1); /* not reached; zcp_dataset_hold() longjmp'd */
701 error = parse_userquota_prop(prop_name, &type, &domain, &rid);
703 error = dmu_objset_from_ds(ds, &os);
705 zfsvfs = kmem_zalloc(sizeof (zfsvfs_t), KM_SLEEP);
706 error = zfsvfs_create_impl(&zfvp, zfsvfs, os);
708 error = zfs_userspace_one(zfvp, type, domain,
716 dsl_dataset_rele(ds, FTAG);
718 if ((value == 0) && ((type == ZFS_PROP_USERQUOTA) ||
719 (type == ZFS_PROP_GROUPQUOTA)))
722 return (zcp_handle_error(state, dataset_name,
726 (void) lua_pushnumber(state, value);
727 (void) lua_pushstring(state, dataset_name);
733 * Determines the name of the snapshot referenced in the written property
734 * name. Returns snapshot name in snap_name, a buffer that must be at least
735 * as large as ZFS_MAX_DATASET_NAME_LEN
738 parse_written_prop(const char *dataset_name, const char *prop_name,
741 ASSERT(zfs_prop_written(prop_name));
742 const char *name = prop_name + ZFS_WRITTEN_PROP_PREFIX_LEN;
743 if (strchr(name, '@') == NULL) {
744 (void) sprintf(snap_name, "%s@%s", dataset_name, name);
746 (void) strcpy(snap_name, name);
751 * Look up written@ property for given dataset. On success
752 * push the value and the setpoint. If error is fatal, we will
753 * longjmp, otherwise push nothing.
756 zcp_get_written_prop(lua_State *state, dsl_pool_t *dp,
757 const char *dataset_name, const char *prop_name)
759 char snap_name[ZFS_MAX_DATASET_NAME_LEN];
760 uint64_t used, comp, uncomp;
764 parse_written_prop(dataset_name, prop_name, snap_name);
765 dsl_dataset_t *new = zcp_dataset_hold(state, dp, dataset_name, FTAG);
767 return (1); /* not reached; zcp_dataset_hold() longjmp'd */
769 error = dsl_dataset_hold(dp, snap_name, FTAG, &old);
771 dsl_dataset_rele(new, FTAG);
772 return (zcp_dataset_hold_error(state, dp, snap_name,
775 error = dsl_dataset_space_written(old, new,
776 &used, &comp, &uncomp);
778 dsl_dataset_rele(old, FTAG);
779 dsl_dataset_rele(new, FTAG);
782 return (zcp_handle_error(state, dataset_name,
785 (void) lua_pushnumber(state, used);
786 (void) lua_pushstring(state, dataset_name);
790 static int zcp_get_prop(lua_State *state);
791 static zcp_lib_info_t zcp_get_prop_info = {
793 .func = zcp_get_prop,
795 { .za_name = "dataset", .za_lua_type = LUA_TSTRING},
796 { .za_name = "property", .za_lua_type = LUA_TSTRING},
805 zcp_get_prop(lua_State *state)
807 const char *dataset_name;
808 const char *property_name;
809 dsl_pool_t *dp = zcp_run_info(state)->zri_pool;
810 zcp_lib_info_t *libinfo = &zcp_get_prop_info;
812 zcp_parse_args(state, libinfo->name, libinfo->pargs, libinfo->kwargs);
814 dataset_name = lua_tostring(state, 1);
815 property_name = lua_tostring(state, 2);
817 /* User defined property */
818 if (zfs_prop_user(property_name)) {
819 return (zcp_get_user_prop(state, dp,
820 dataset_name, property_name));
822 /* userspace property */
823 if (zfs_prop_userquota(property_name)) {
825 return (zcp_get_userquota_prop(state, dp,
826 dataset_name, property_name));
828 return (luaL_error(state,
829 "user quota properties only supported in kernel mode",
833 /* written@ property */
834 if (zfs_prop_written(property_name)) {
835 return (zcp_get_written_prop(state, dp,
836 dataset_name, property_name));
839 zfs_prop_t zfs_prop = zfs_name_to_prop(property_name);
840 /* Valid system property */
841 if (zfs_prop != ZPROP_INVAL) {
842 return (zcp_get_system_prop(state, dp, dataset_name,
846 /* Invalid property name */
847 return (luaL_error(state,
848 "'%s' is not a valid property", property_name));
852 zcp_load_get_lib(lua_State *state)
854 lua_pushcclosure(state, zcp_get_prop_info.func, 0);
855 lua_setfield(state, -2, zcp_get_prop_info.name);