Z.I.A. Error Message

Added error message support for assigning
an invalid provider to zia_provider.

Signed-off-by: Luke Beirne <[email protected]>

Author: Luke Beirne

contrib/pyzfs/libzfs_core/_constants.py

@@ -105,6 +105,7 @@ def enum(*sequential, **named):
         'ZFS_ERR_RESUME_EXISTS',
         'ZFS_ERR_CRYPTO_NOTSUP',
         'ZFS_ERR_RAIDZ_EXPAND_IN_PROGRESS',
+        'ZFS_ERR_ZIA_NONEXISTENT_PROVIDER',
     ],
     {}
 )

include/libzfs.h

@@ -160,6 +160,7 @@ typedef enum zfs_error {
 	EZFS_SHAREFAILED,	/* filesystem share failed */
 	EZFS_RAIDZ_EXPAND_IN_PROGRESS,	/* a raidz is currently expanding */
 	EZFS_ASHIFT_MISMATCH,   /* can't add vdevs with different ashifts */
+	EZFS_ZIA_NONEXISTENT_PROVIDER,   /* given provider does not exist */
 	EZFS_UNKNOWN
 } zfs_error_t;
 

include/sys/fs/zfs.h

@@ -1683,6 +1683,7 @@ typedef enum {
 	ZFS_ERR_RAIDZ_EXPAND_IN_PROGRESS,
 	ZFS_ERR_ASHIFT_MISMATCH,
 	ZFS_ERR_STREAM_LARGE_MICROZAP,
+	ZFS_ERR_ZIA_NONEXISTENT_PROVIDER,
 } zfs_errno_t;
 
 /*

lib/libzfs/libzfs_util.c

@@ -324,6 +324,8 @@ libzfs_error_description(libzfs_handle_t *hdl)
 	case EZFS_ASHIFT_MISMATCH:
 		return (dgettext(TEXT_DOMAIN, "adding devices with "
 		    "different physical sector sizes is not allowed"));
+	case EZFS_ZIA_NONEXISTENT_PROVIDER:
+		return (dgettext(TEXT_DOMAIN, "given provider does not exist"));
 	case EZFS_UNKNOWN:
 		return (dgettext(TEXT_DOMAIN, "unknown error"));
 	default:
@@ -776,6 +778,9 @@ zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
 	case ZFS_ERR_ASHIFT_MISMATCH:
 		zfs_verror(hdl, EZFS_ASHIFT_MISMATCH, fmt, ap);
 		break;
+	case ZFS_ERR_ZIA_NONEXISTENT_PROVIDER:
+		zfs_verror(hdl, EZFS_ZIA_NONEXISTENT_PROVIDER, fmt, ap);
+		break;
 	default:
 		zfs_error_aux(hdl, "%s", zfs_strerror(error));
 		zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);

module/zfs/spa.c

@@ -695,6 +695,7 @@ spa_prop_validate(spa_t *spa, nvlist_t *props)
 	int error = 0, reset_bootfs = 0;
 	uint64_t objnum = 0;
 	boolean_t has_feature = B_FALSE;
+	zia_props_t *zia_props = zia_get_props(spa);
 
 	elem = NULL;
 	while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
@@ -890,6 +891,40 @@ spa_prop_validate(spa_t *spa, nvlist_t *props)
 			break;
 
 		case ZPOOL_PROP_ZIA_PROVIDER:
+			strval = fnvpair_value_string(elem);
+			if (strncmp(strval, "NULL", 5) == 0 ||
+			    strncmp(strval, "off", 4) == 0) {
+				zia_put_provider(&zia_props->provider,
+				    spa->spa_root_vdev);
+				break;
+			}
+
+			void *new_provider = zia_get_provider(strval);
+			if (new_provider == NULL) {
+				error = SET_ERROR(ZFS_ERR_ZIA_NONEXISTENT_PROVIDER);
+				break;
+			}
+
+			if (zia_props->provider != NULL)
+				zia_put_provider(&zia_props->provider,
+				    spa->spa_root_vdev);
+
+			zia_props->provider = new_provider;
+			zia_props->can_offload = !!zia_props->provider;
+
+			/*
+			 * It is possible to enable disk_write or file_write
+			 * without passing a provider, or swapping one
+			 * provider with another while these flags are enabled.
+			 * In those cases, vdevs must be opened for the new
+			 * provider upon being passed.
+			 * The vdevs will be closed for the older provider
+			 * in zia_put_provider() first.
+			 */
+			ASSERT3P(spa->spa_root_vdev, !=, NULL);
+			if (zia_props->disk_write || zia_props->file_write)
+				zia_open_vdevs(spa->spa_root_vdev);
+			break;
 		case ZPOOL_PROP_ZIA_COMPRESS:
 		case ZPOOL_PROP_ZIA_DECOMPRESS:
 		case ZPOOL_PROP_ZIA_CHECKSUM:
@@ -9812,32 +9847,6 @@ spa_sync_props(void *arg, dmu_tx_t *tx)
 			break;
 		case ZPOOL_PROP_ZIA_PROVIDER:
 			strval = fnvpair_value_string(elem);
-			if (strncmp(strval, "NULL", 5) == 0 ||
-			    strncmp(strval, "off", 4) == 0) {
-				zia_put_provider(&zia_props->provider,
-				    spa->spa_root_vdev);
-				break;
-			}
-
-			if (zia_props->provider != NULL)
-				zia_put_provider(&zia_props->provider,
-				    spa->spa_root_vdev);
-			zia_props->provider = zia_get_provider(strval);
-			zia_props->can_offload = !!zia_props->provider;
-
-			/*
-			 * It is possible to enable disk_write or file_write
-			 * without passing a provider, or swapping one
-			 * provider with another while these flags are enabled.
-			 * In those cases, vdevs must be opened for the new
-			 * provider upon being passed.
-			 * The vdevs will be closed for the older provider
-			 * in zia_put_provider() first.
-			 */
-			ASSERT3P(spa->spa_root_vdev, !=, NULL);
-			if (zia_props->disk_write || zia_props->file_write)
-				zia_open_vdevs(spa->spa_root_vdev);
-
 			spa_history_log_internal(spa, "set", tx,
 			    "%s=%s", nvpair_name(elem), strval);
 			break;