Commit d2b9b2af authored by Shuhei Matsumoto's avatar Shuhei Matsumoto Committed by Tomasz Zawadzki
Browse files

nvmf: Add ABI compatibility check to spdk_nvmf_ns_opts 



The next patch will add anagrpid to spdk_nvmf_ns_opts. This patch
is for the upcoming change and futhre potential changesto ensure the
ABI compatibility.

Signed-off-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Change-Id: Ibe1024a27ea4ab823d40d775470cde78b9eb8d2c
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9112


Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
parent 85bf4c81

CHANGELOG.md

+3 −0
Original line number Diff line number Diff line
@@ -7,6 +7,9 @@ 
Added `oncs` to `struct spdk_nvmf_ctrlr_data` so that the transport layer

can decide support RESERVATION feature or not.



An `opts_size` element was added in the `spdk_nvmf_ns_opts` structure to solve the

ABI compatibility issue between different SPDK version.



### bdev



New API `spdk_bdev_get_memory_domains` has been added, it allows to get SPDK memory domains used by bdev.

include/spdk/nvmf.h

+8 −0
Original line number Diff line number Diff line
@@ -721,6 +721,14 @@ struct spdk_nvmf_ns_opts { 
	 * Fill with 0s if not specified.

	 */

	struct spdk_uuid uuid;



	/**

	 * The size of spdk_nvmf_ns_opts according to the caller of this library is used for ABI

	 * compatibility.  The library uses this field to know how many fields in this structure

	 * are valid.  And the library will populate any remaining fields with default values.

	 * New added fields should be put at the end of the struct.

	 */

	size_t opts_size;

};



/**

lib/nvmf/subsystem.c

+71 −2
Original line number Diff line number Diff line
@@ -36,6 +36,7 @@ 
#include "nvmf_internal.h"

#include "transport.h"



#include "spdk/assert.h"

#include "spdk/likely.h"

#include "spdk/string.h"

#include "spdk/trace.h"
@@ -1362,8 +1363,76 @@ nvmf_ns_event(enum spdk_bdev_event_type type, 
void

spdk_nvmf_ns_opts_get_defaults(struct spdk_nvmf_ns_opts *opts, size_t opts_size)

{

	/* All current fields are set to 0 by default. */

	if (!opts) {

		SPDK_ERRLOG("opts should not be NULL.\n");

		return;

	}



	if (!opts_size) {

		SPDK_ERRLOG("opts_size should not be zero.\n");

		return;

	}



	memset(opts, 0, opts_size);

	opts->opts_size = opts_size;



#define FIELD_OK(field) \

	offsetof(struct spdk_nvmf_ns_opts, field) + sizeof(opts->field) <= opts_size



#define SET_FIELD(field, value) \

	if (FIELD_OK(field)) { \

		opts->field = value; \

	} \



	/* All current fields are set to 0 by default. */

	SET_FIELD(nsid, 0);

	if (FIELD_OK(nguid)) {

		memset(opts->nguid, 0, sizeof(opts->nguid));

	}

	if (FIELD_OK(eui64)) {

		memset(opts->eui64, 0, sizeof(opts->eui64));

	}

	if (FIELD_OK(uuid)) {

		memset(&opts->uuid, 0, sizeof(opts->uuid));

	}



#undef FIELD_OK

#undef SET_FIELD

}



static void

nvmf_ns_opts_copy(struct spdk_nvmf_ns_opts *opts,

		  const struct spdk_nvmf_ns_opts *user_opts,

		  size_t opts_size)

{

#define FIELD_OK(field)	\

	offsetof(struct spdk_nvmf_ns_opts, field) + sizeof(opts->field) <= user_opts->opts_size



#define SET_FIELD(field) \

	if (FIELD_OK(field)) { \

		opts->field = user_opts->field;	\

	} \



	SET_FIELD(nsid);

	if (FIELD_OK(nguid)) {

		memcpy(opts->nguid, user_opts->nguid, sizeof(opts->nguid));

	}

	if (FIELD_OK(eui64)) {

		memcpy(opts->eui64, user_opts->eui64, sizeof(opts->eui64));

	}

	if (FIELD_OK(uuid)) {

		memcpy(&opts->uuid, &user_opts->uuid, sizeof(opts->uuid));

	}



	opts->opts_size = user_opts->opts_size;



	/* We should not remove this statement, but need to update the assert statement

	 * if we add a new field, and also add a corresponding SET_FIELD statement.

	 */

	SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_ns_opts) == 56, "Incorrect size");



#undef FIELD_OK

#undef SET_FIELD

}



/* Dummy bdev module used to to claim bdevs. */
@@ -1394,7 +1463,7 @@ spdk_nvmf_subsystem_add_ns_ext(struct spdk_nvmf_subsystem *subsystem, const char 


	spdk_nvmf_ns_opts_get_defaults(&opts, sizeof(opts));

	if (user_opts) {

		memcpy(&opts, user_opts, spdk_min(sizeof(opts), opts_size));

		nvmf_ns_opts_copy(&opts, user_opts, opts_size);

	}



	if (opts.nsid == SPDK_NVME_GLOBAL_NS_TAG) {