nvme: add support for sanitize-ns command

Supported by NVMe 2.3.

Signed-off-by: Tokunori Ikegami <[email protected]>

Author: ikegami-t

libnvme/src/nvme/ioctl.h

@@ -4088,6 +4088,34 @@ nvme_init_sanitize_nvm(struct nvme_passthru_cmd *cmd,
 	cmd->cdw11 = ovrpat;
 }
 
+/**
+ * nvme_init_sanitize_ns() - Initialize passthru command to start a
+ * sanitize namespace operation
+ * @cmd:	Passthru command to use
+ * @sanact:	Sanitize action, see &enum nvme_sanitize_sanact
+ * @ause:	Set to allow unrestricted sanitize exit
+ * @emvs:	Set to enter media verification state
+ *
+ * Initializes the passthru command buffer for the Sanitize namespace command.
+ */
+static inline void
+nvme_init_sanitize_ns(struct nvme_passthru_cmd *cmd,
+		enum nvme_sanitize_sanact sanact, bool ause, bool emvs)
+{
+	memset(cmd, 0, sizeof(*cmd));
+
+	cmd->opcode = nvme_admin_sanitize_ns;
+	cmd->cdw10 = NVME_FIELD_ENCODE(sanact,
+			NVME_SANITIZE_CDW10_SANACT_SHIFT,
+			NVME_SANITIZE_CDW10_SANACT_MASK) |
+		      NVME_FIELD_ENCODE(ause,
+			NVME_SANITIZE_CDW10_AUSE_SHIFT,
+			NVME_SANITIZE_CDW10_AUSE_MASK) |
+		      NVME_FIELD_ENCODE(emvs,
+			NVME_SANITIZE_CDW10_EMVS_SHIFT,
+			NVME_SANITIZE_CDW10_EMVS_MASK);
+}
+
 /**
  * nvme_init_dev_self_test() - Initialize passthru command to start or
  * abort a self test

nvme-builtin.h

@@ -94,6 +94,8 @@ COMMAND_LIST(
 	ENTRY("verify", "Submit a verify command, return results", verify_cmd)
 	ENTRY("sanitize", "Submit a sanitize command", sanitize_cmd)
 	ENTRY("sanitize-log", "Retrieve sanitize log, show it", sanitize_log)
+	ENTRY("sanitize-ns", "Submit a sanitize namespace command",
+	      sanitize_ns_cmd)
 	ENTRY("reset", "Resets the controller", reset)
 	ENTRY("subsystem-reset", "Resets the subsystem", subsystem_reset)
 	ENTRY("ns-rescan", "Rescans the NVME namespaces", ns_rescan)

nvme.c

@@ -5565,6 +5565,88 @@ static int sanitize_cmd(int argc, char **argv, struct command *acmd, struct plug
 	return err;
 }
 
+static int sanitize_ns_cmd(int argc, char **argv, struct command *acmd,
+			   struct plugin *plugin)
+{
+	const char *desc = "Send a sanitize namespace command.";
+	const char *emvs_desc = "Enter media verification state.";
+	const char *ause_desc = "Allow unrestricted sanitize exit.";
+	const char *sanact_desc = "Sanitize action: 1 = Exit failure mode, "
+		"4 = Start a crypto erase namespace sanitize operation, "
+		"5 = Exit media verification state";
+
+	_cleanup_nvme_transport_handle_ struct nvme_transport_handle *hdl = NULL;
+	_cleanup_nvme_global_ctx_ struct nvme_global_ctx *ctx = NULL;
+	struct nvme_passthru_cmd cmd;
+	nvme_print_flags_t flags;
+	int err;
+
+	struct config {
+		bool	ause;
+		__u8	sanact;
+		bool	emvs;
+	};
+
+	struct config cfg = {
+		.ause		= false,
+		.sanact		= 0,
+		.emvs		= false,
+	};
+
+	OPT_VALS(sanact) = {
+		VAL_BYTE("exit-failure", NVME_SANITIZE_SANACT_EXIT_FAILURE),
+		VAL_BYTE("start-crypto-erase",
+			 NVME_SANITIZE_SANACT_START_CRYPTO_ERASE),
+		VAL_BYTE("exit-media-verification",
+			 NVME_SANITIZE_SANACT_EXIT_MEDIA_VERIF),
+		VAL_END()
+	};
+
+	NVME_ARGS(opts,
+		  OPT_FLAG("ause",   'u', &cfg.ause,   ause_desc),
+		  OPT_BYTE("sanact", 'a', &cfg.sanact, sanact_desc, sanact),
+		  OPT_FLAG("emvs",   'e', &cfg.emvs,   emvs_desc));
+
+	err = parse_and_open(&ctx, &hdl, argc, argv, desc, opts);
+	if (err)
+		return err;
+
+	err = validate_output_format(nvme_cfg.output_format, &flags);
+	if (err < 0) {
+		nvme_show_error("Invalid output format");
+		return err;
+	}
+
+	switch (cfg.sanact) {
+	case NVME_SANITIZE_SANACT_EXIT_FAILURE:
+	case NVME_SANITIZE_SANACT_START_CRYPTO_ERASE:
+	case NVME_SANITIZE_SANACT_EXIT_MEDIA_VERIF:
+		break;
+	default:
+		nvme_show_error("Invalid Sanitize Action");
+		return -EINVAL;
+	}
+
+	if (cfg.ause) {
+		if (cfg.sanact == NVME_SANITIZE_SANACT_EXIT_FAILURE) {
+			nvme_show_error("SANACT is Exit Failure Mode");
+			return -EINVAL;
+		} else if (cfg.sanact == NVME_SANITIZE_SANACT_EXIT_MEDIA_VERIF) {
+			nvme_show_error("SANACT is Exit Media Verification State");
+			return -EINVAL;
+		}
+	}
+
+	nvme_init_sanitize_ns(&cmd, cfg.sanact, cfg.ause, cfg.emvs);
+	err = nvme_submit_admin_passthru(hdl, &cmd);
+	if (err < 0)
+		nvme_show_error("sanitize ns: %s", nvme_strerror(err));
+	else if (err > 0)
+		nvme_show_status(err);
+
+	return err;
+}
+
 static int nvme_get_single_property(struct nvme_transport_handle *hdl, struct get_reg_config *cfg, __u64 *value)
 {
 	struct nvme_passthru_cmd cmd;