bdev/opal: Add Opal vbdev (8466e2c6) · Commits · Public Repositories / spdk

module/bdev/nvme/Makefile

+1 −1

Original line number	Diff line number	Diff line
		@@ -36,7 +36,7 @@ include $(SPDK_ROOT_DIR)/mk/spdk.common.mk

		C_SRCS = bdev_nvme.c bdev_nvme_rpc.c nvme_rpc.c common.c
		ifeq ($(OS),Linux)
		C_SRCS += bdev_ftl.c bdev_ftl_rpc.c
		C_SRCS += bdev_ftl.c bdev_ftl_rpc.c vbdev_opal.c
		endif
		LIBNAME = bdev_nvme

module/bdev/nvme/vbdev_opal.c

0 → 100644

+531 −0

Original line number	Diff line number	Diff line
		/*-
		* BSD LICENSE
		*
		* Copyright (c) Intel Corporation.
		* All rights reserved.
		*
		* Redistribution and use in source and binary forms, with or without
		* modification, are permitted provided that the following conditions
		* are met:
		*
		* * Redistributions of source code must retain the above copyright
		* notice, this list of conditions and the following disclaimer.
		* * Redistributions in binary form must reproduce the above copyright
		* notice, this list of conditions and the following disclaimer in
		* the documentation and/or other materials provided with the
		* distribution.
		* * Neither the name of Intel Corporation nor the names of its
		* contributors may be used to endorse or promote products derived
		* from this software without specific prior written permission.
		*
		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		*/

		#include "spdk/opal.h"
		#include "spdk/bdev_module.h"
		#include "vbdev_opal.h"
		#include "spdk_internal/log.h"
		#include "spdk/string.h"

		/* OPAL locking range only supports operations on nsid=1 for now */
		#define NSID_SUPPORTED 1

		struct spdk_vbdev_opal_config {
		char *nvme_ctrlr_name;
		uint8_t locking_range_id;
		uint64_t range_start;
		uint64_t range_length;
		SPDK_BDEV_PART_TAILQ *part_tailq;
		struct vbdev_opal_part_base *opal_base;
		};

		struct opal_vbdev {
		char *name;
		struct nvme_bdev_ctrlr *nvme_ctrlr;
		struct spdk_opal_dev *opal_dev;
		struct spdk_bdev_part *bdev_part;
		struct spdk_vbdev_opal_config cfg;

		TAILQ_ENTRY(opal_vbdev) tailq;
		};

		static TAILQ_HEAD(, opal_vbdev) g_opal_vbdev =
		TAILQ_HEAD_INITIALIZER(g_opal_vbdev);

		struct vbdev_opal_bdev_io {
		struct spdk_io_channel *ch;
		struct spdk_bdev_io *bdev_io;
		struct spdk_bdev_io_wait_entry bdev_io_wait;
		};

		struct vbdev_opal_channel {
		struct spdk_bdev_part_channel part_ch;
		};

		struct vbdev_opal_part_base {
		char *nvme_ctrlr_name;
		struct spdk_bdev_part_base *part_base;
		int num_of_part;
		TAILQ_ENTRY(vbdev_opal_part_base) tailq;
		};

		static TAILQ_HEAD(, vbdev_opal_part_base) g_opal_base = TAILQ_HEAD_INITIALIZER(g_opal_base);

		static void _vbdev_opal_submit_request(struct spdk_io_channel _ch, struct spdk_bdev_io bdev_io);

		static void vbdev_opal_examine(struct spdk_bdev *bdev);

		static void
		vbdev_opal_delete(struct opal_vbdev *opal_bdev)
		{
		TAILQ_REMOVE(&g_opal_vbdev, opal_bdev, tailq);
		free(opal_bdev->name);
		free(opal_bdev->cfg.nvme_ctrlr_name);
		free(opal_bdev);
		opal_bdev = NULL;
		}

		static void
		vbdev_opal_clear(void)
		{
		struct opal_vbdev opal_bdev, tmp;

		TAILQ_FOREACH_SAFE(opal_bdev, &g_opal_vbdev, tailq, tmp) {
		vbdev_opal_delete(opal_bdev);
		}
		}

		static int
		vbdev_opal_init(void)
		{
		/* TODO */
		return 0;
		}

		static void
		vbdev_opal_fini(void)
		{
		vbdev_opal_clear();
		}

		static int
		vbdev_opal_get_ctx_size(void)
		{
		return sizeof(struct vbdev_opal_bdev_io);
		}

		/* delete all the config of the same base bdev */
		static void
		vbdev_opal_delete_all_base_config(struct vbdev_opal_part_base *base)
		{
		char *nvme_ctrlr_name = base->nvme_ctrlr_name;
		struct opal_vbdev bdev, tmp_bdev;

		TAILQ_FOREACH_SAFE(bdev, &g_opal_vbdev, tailq, tmp_bdev) {
		if (!strcmp(nvme_ctrlr_name, bdev->nvme_ctrlr->name)) {
		vbdev_opal_delete(bdev);
		}
		}
		}

		static int
		vbdev_opal_destruct(void *ctx)
		{
		struct spdk_bdev_part *part = ctx;

		return spdk_bdev_part_free(part);
		}

		static void
		vbdev_opal_base_free(void *ctx)
		{
		struct vbdev_opal_part_base *base = ctx;
		SPDK_BDEV_PART_TAILQ *part_tailq = spdk_bdev_part_base_get_tailq(base->part_base);

		free(part_tailq);
		free(base->nvme_ctrlr_name);
		free(base);
		}

		static void
		vbdev_opal_resubmit_io(void *arg)
		{
		struct vbdev_opal_bdev_io io_ctx = (struct vbdev_opal_bdev_io )arg;

		_vbdev_opal_submit_request(io_ctx->ch, io_ctx->bdev_io);
		}

		static void
		vbdev_opal_queue_io(struct vbdev_opal_bdev_io *io_ctx)
		{
		int rc;

		io_ctx->bdev_io_wait.bdev = io_ctx->bdev_io->bdev;
		io_ctx->bdev_io_wait.cb_fn = vbdev_opal_resubmit_io;
		io_ctx->bdev_io_wait.cb_arg = io_ctx;

		rc = spdk_bdev_queue_io_wait(io_ctx->bdev_io->bdev, io_ctx->ch, &io_ctx->bdev_io_wait);

		if (rc != 0) {
		SPDK_ERRLOG("Queue io failed in vbdev_opal_queue_io: %d\n", rc);
		spdk_bdev_io_complete(io_ctx->bdev_io, SPDK_BDEV_IO_STATUS_FAILED);
		}
		}

		static void
		_vbdev_opal_submit_request(struct spdk_io_channel _ch, struct spdk_bdev_io bdev_io)
		{
		struct vbdev_opal_channel *ch = spdk_io_channel_get_ctx(_ch);
		struct vbdev_opal_bdev_io io_ctx = (struct vbdev_opal_bdev_io )bdev_io->driver_ctx;
		int rc;

		rc = spdk_bdev_part_submit_request(&ch->part_ch, bdev_io);
		if (rc) {
		if (rc == -ENOMEM) {
		SPDK_DEBUGLOG(SPDK_LOG_VBDEV_OPAL, "opal: no memory, queue io.\n");
		io_ctx->ch = _ch;
		io_ctx->bdev_io = bdev_io;
		vbdev_opal_queue_io(io_ctx);
		} else {
		SPDK_ERRLOG("opal: error on io submission, rc=%d.\n", rc);
		spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED);
		}
		}
		}

		static void
		vbdev_opal_io_get_buf_cb(struct spdk_io_channel ch, struct spdk_bdev_io bdev_io, bool success)
		{
		if (!success) {
		spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED);
		return;
		}

		_vbdev_opal_submit_request(ch, bdev_io);
		}

		static void
		vbdev_opal_submit_request(struct spdk_io_channel ch, struct spdk_bdev_io bdev_io)
		{
		switch (bdev_io->type) {
		case SPDK_BDEV_IO_TYPE_READ:
		spdk_bdev_io_get_buf(bdev_io, vbdev_opal_io_get_buf_cb,
		bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen);
		break;
		default:
		_vbdev_opal_submit_request(ch, bdev_io);
		break;
		}
		}

		static int
		vbdev_opal_dump_info_json(void ctx, struct spdk_json_write_ctx w)
		{
		struct spdk_bdev_part *part = ctx;
		struct spdk_bdev *base_bdev = spdk_bdev_part_get_base_bdev(part);
		uint64_t offset = spdk_bdev_part_get_offset_blocks(part);

		spdk_json_write_named_object_begin(w, "opal");

		spdk_json_write_named_string(w, "base_bdev", spdk_bdev_get_name(base_bdev));
		spdk_json_write_named_uint64(w, "offset_blocks", offset);

		spdk_json_write_object_end(w);

		return 0;
		}

		static void
		vbdev_opal_base_bdev_hotremove_cb(void *_part_base)
		{
		struct spdk_bdev_part_base *part_base = _part_base;
		struct vbdev_opal_part_base *base = spdk_bdev_part_base_get_ctx(part_base);

		spdk_bdev_part_base_hotremove(part_base, spdk_bdev_part_base_get_tailq(part_base));
		vbdev_opal_delete_all_base_config(base);
		}

		static bool
		vbdev_opal_io_type_supported(void *ctx, enum spdk_bdev_io_type io_type)
		{
		struct spdk_bdev_part *part = ctx;
		struct spdk_bdev *base_bdev = spdk_bdev_part_get_base_bdev(part);

		return spdk_bdev_io_type_supported(base_bdev, io_type);
		}

		static struct spdk_bdev_fn_table opal_vbdev_fn_table = {
		.destruct = vbdev_opal_destruct,
		.submit_request = vbdev_opal_submit_request,
		.io_type_supported = vbdev_opal_io_type_supported,
		.dump_info_json = vbdev_opal_dump_info_json,
		.write_config_json = NULL,
		};

		static struct spdk_bdev_module opal_if = {
		.name = "opal",
		.module_init = vbdev_opal_init,
		.module_fini = vbdev_opal_fini,
		.get_ctx_size = vbdev_opal_get_ctx_size,
		.examine_config = vbdev_opal_examine,
		.config_json = NULL,
		};

		SPDK_BDEV_MODULE_REGISTER(opal, &opal_if)

		static void
		vbdev_opal_free_bdev(struct opal_vbdev *opal_bdev)
		{
		free(opal_bdev->cfg.nvme_ctrlr_name);
		free(opal_bdev);
		}

		int
		spdk_vbdev_opal_create(const char *nvme_ctrlr_name, uint32_t nsid, uint8_t locking_range_id,
		uint64_t range_start, uint64_t range_length, const char *password)
		{
		int rc;
		char *opal_vbdev_name;
		char *base_bdev_name;
		struct nvme_bdev_ctrlr *nvme_ctrlr;
		struct opal_vbdev *opal_bdev;
		struct vbdev_opal_part_base *opal_part_base;
		struct spdk_bdev_part *part_bdev;
		SPDK_BDEV_PART_TAILQ *part_tailq;
		struct spdk_vbdev_opal_config *cfg;

		if (nsid != NSID_SUPPORTED) {
		SPDK_ERRLOG("nsid %d not supported", nsid);
		return -EINVAL;
		}

		nvme_ctrlr = nvme_bdev_ctrlr_get_by_name(nvme_ctrlr_name);
		if (!nvme_ctrlr) {
		SPDK_ERRLOG("get nvme ctrlr failed\n");
		return -ENODEV;
		}

		if (nvme_ctrlr->opal_dev == NULL) {
		SPDK_ERRLOG("Opal not supported\n");
		return -ENODEV;
		}

		opal_bdev = calloc(1, sizeof(struct opal_vbdev));
		if (!opal_bdev) {
		SPDK_ERRLOG("allocation for opal_bdev failed\n");
		return -ENOMEM;
		}

		cfg = &opal_bdev->cfg;
		cfg->nvme_ctrlr_name = strdup(nvme_ctrlr_name);
		assert(cfg->nvme_ctrlr_name != NULL);

		cfg->locking_range_id = locking_range_id;
		cfg->range_start = range_start;
		cfg->range_length = range_length;

		opal_bdev->nvme_ctrlr = nvme_ctrlr;
		opal_bdev->opal_dev = nvme_ctrlr->opal_dev;
		if (!spdk_opal_supported(opal_bdev->opal_dev)) {
		SPDK_ERRLOG("Opal not supported\n");
		vbdev_opal_free_bdev(opal_bdev);
		return -EINVAL;
		}
		base_bdev_name = nvme_ctrlr->bdevs[nsid - 1].disk.name;

		/* traverse base list to see if part_base is already create for this base bdev */
		TAILQ_FOREACH(opal_part_base, &g_opal_base, tailq) {
		if (!strcmp(spdk_bdev_part_base_get_bdev_name(opal_part_base->part_base), base_bdev_name)) {
		cfg->opal_base = opal_part_base;
		}
		}

		/* If there is not a corresponding opal_part_base, a new opal_part_base will be created.
		For each new part_base, there will be one tailq to store all the parts of this base */
		if (cfg->opal_base == NULL) {
		part_tailq = calloc(1, sizeof(*part_tailq));
		if (part_tailq == NULL) {
		SPDK_ERRLOG("Could not allocate bdev_part_tailq\n");
		vbdev_opal_free_bdev(opal_bdev);
		return -ENOMEM;
		}

		TAILQ_INIT(part_tailq);
		cfg->part_tailq = part_tailq;
		opal_part_base = calloc(1, sizeof(*opal_part_base));
		if (opal_part_base == NULL) {
		SPDK_ERRLOG("Could not allocate opal_part_base\n");
		vbdev_opal_free_bdev(opal_bdev);
		free(part_tailq);
		return -ENOMEM;
		}

		opal_part_base->part_base = spdk_bdev_part_base_construct(spdk_bdev_get_by_name(base_bdev_name),
		vbdev_opal_base_bdev_hotremove_cb, &opal_if,
		&opal_vbdev_fn_table, part_tailq, vbdev_opal_base_free, opal_part_base,
		sizeof(struct vbdev_opal_channel), NULL, NULL);
		if (opal_part_base->part_base == NULL) {
		SPDK_ERRLOG("Could not allocate part_base\n");
		vbdev_opal_free_bdev(opal_bdev);
		free(part_tailq);
		free(opal_part_base);
		return -ENOMEM;
		}
		opal_part_base->num_of_part = 0;
		opal_part_base->nvme_ctrlr_name = strdup(cfg->nvme_ctrlr_name);
		assert(opal_part_base->nvme_ctrlr_name != NULL);

		cfg->opal_base = opal_part_base;
		TAILQ_INSERT_TAIL(&g_opal_base, opal_part_base, tailq);
		}

		part_bdev = calloc(1, sizeof(struct spdk_bdev_part));
		if (!part_bdev) {
		SPDK_ERRLOG("Could not allocate part_bdev\n");
		vbdev_opal_free_bdev(opal_bdev);
		return -ENOMEM;
		}

		TAILQ_INSERT_TAIL(&g_opal_vbdev, opal_bdev, tailq);
		opal_vbdev_name = spdk_sprintf_alloc("%sr%" PRIu8, base_bdev_name,
		cfg->locking_range_id); /* e.g.: nvme0n1r1 */
		if (opal_vbdev_name == NULL) {
		SPDK_ERRLOG("Could not allocate opal_vbdev_name\n");
		rc = -ENOMEM;
		goto err;
		}

		opal_bdev->name = opal_vbdev_name;
		rc = spdk_opal_cmd_setup_locking_range(opal_bdev->opal_dev, OPAL_ADMIN1,
		cfg->locking_range_id, cfg->range_start, cfg->range_length, password);
		if (rc) {
		SPDK_ERRLOG("Error construct %s\n", opal_vbdev_name);
		goto err;
		}

		rc = spdk_bdev_part_construct(part_bdev, cfg->opal_base->part_base, opal_vbdev_name,
		cfg->range_start, cfg->range_length, "Opal locking range");
		if (rc) {
		SPDK_ERRLOG("Could not allocate bdev part\n");
		goto err;
		}

		/* lock this bdev initially */
		rc = spdk_opal_cmd_lock_unlock(opal_bdev->opal_dev, OPAL_ADMIN1, OPAL_RWLOCK, locking_range_id,
		password);
		if (rc) {
		SPDK_ERRLOG("Error lock %s\n", opal_vbdev_name);
		goto err;
		}

		opal_bdev->bdev_part = part_bdev;
		cfg->opal_base->num_of_part++;
		return 0;

		err:
		vbdev_opal_delete(opal_bdev);
		free(part_bdev);
		return rc;
		}

		static void
		vbdev_opal_destruct_bdev(struct opal_vbdev *opal_bdev)
		{
		SPDK_BDEV_PART_TAILQ *opal_part_tailq;
		struct spdk_bdev_part *part;
		struct spdk_vbdev_opal_config *cfg = &opal_bdev->cfg;

		if (cfg->opal_base != NULL) {
		part = opal_bdev->bdev_part;
		opal_part_tailq = spdk_bdev_part_base_get_tailq(cfg->opal_base->part_base);
		if (opal_part_tailq == NULL) {
		SPDK_ERRLOG("Can't get tailq for this opal_base\n");
		return;
		}
		if (cfg->range_start == spdk_bdev_part_get_offset_blocks(part)) {
		if (cfg->opal_base->num_of_part <= 1) {
		/* if there is only one part for this base, we can remove the base now */
		spdk_bdev_part_base_hotremove(cfg->opal_base->part_base, opal_part_tailq);

		/* remove from the tailq vbdev_opal_part_base */
		TAILQ_REMOVE(&g_opal_base, cfg->opal_base, tailq);
		} else {
		spdk_bdev_unregister(spdk_bdev_part_get_bdev(part), NULL, NULL);
		cfg->opal_base->num_of_part--;
		}
		}
		}
		vbdev_opal_delete(opal_bdev);
		}

		int
		spdk_vbdev_opal_destruct(const char bdev_name, const char password)
		{
		struct spdk_vbdev_opal_config *cfg;
		struct nvme_bdev_ctrlr *nvme_ctrlr;
		int locking_range_id;
		int rc;
		struct opal_vbdev *opal_bdev;

		TAILQ_FOREACH(opal_bdev, &g_opal_vbdev, tailq) {
		if (strcmp(opal_bdev->name, bdev_name) == 0) {
		break;
		}
		}

		if (opal_bdev == NULL) {
		SPDK_ERRLOG("%s not found\n", bdev_name);
		rc = -ENODEV;
		goto err;
		}

		cfg = &opal_bdev->cfg;
		locking_range_id = cfg->locking_range_id;

		nvme_ctrlr = opal_bdev->nvme_ctrlr;
		if (nvme_ctrlr == NULL) {
		SPDK_ERRLOG("can't find nvme_ctrlr of %s\n", bdev_name);
		return -ENODEV;
		}

		/* secure erase locking range */
		rc = spdk_opal_cmd_erase_locking_range(nvme_ctrlr->opal_dev, OPAL_ADMIN1, locking_range_id,
		password);
		if (rc) {
		SPDK_ERRLOG("opal erase locking range failed\n");
		goto err;
		}

		/* reset the locking range to 0 */
		rc = spdk_opal_cmd_setup_locking_range(nvme_ctrlr->opal_dev, OPAL_ADMIN1, locking_range_id, 0,
		0, password);
		if (rc) {
		SPDK_ERRLOG("opal reset locking range failed\n");
		goto err;
		}

		vbdev_opal_destruct_bdev(opal_bdev);
		return 0;

		err:
		return rc;
		}

		static void
		vbdev_opal_examine(struct spdk_bdev *bdev)
		{
		/* TODO */
		spdk_bdev_module_examine_done(&opal_if);
		}

		SPDK_LOG_REGISTER_COMPONENT("vbdev_opal", SPDK_LOG_VBDEV_OPAL)

module/bdev/nvme/vbdev_opal.h

0 → 100644

+45 −0

Original line number	Diff line number	Diff line
		/*-
		* BSD LICENSE
		*
		* Copyright (c) Intel Corporation.
		* All rights reserved.
		*
		* Redistribution and use in source and binary forms, with or without
		* modification, are permitted provided that the following conditions
		* are met:
		*
		* * Redistributions of source code must retain the above copyright
		* notice, this list of conditions and the following disclaimer.
		* * Redistributions in binary form must reproduce the above copyright
		* notice, this list of conditions and the following disclaimer in
		* the documentation and/or other materials provided with the
		* distribution.
		* * Neither the name of Intel Corporation nor the names of its
		* contributors may be used to endorse or promote products derived
		* from this software without specific prior written permission.
		*
		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		*/
		#ifndef SPDK_VBDEV_OPAL_H
		#define SPDK_VBDEV_OPAL_H

		#include "spdk/bdev_module.h"
		#include "bdev_nvme.h"
		#include "common.h"

		int spdk_vbdev_opal_create(const char *nvme_ctrlr_name, uint32_t nsid, uint8_t locking_range_id,
		uint64_t range_start, uint64_t range_length, const char *password);

		int spdk_vbdev_opal_destruct(const char bdev_name, const char password);

		#endif