Commit 6f227249 authored by GangCao's avatar GangCao Committed by Jim Harris
Browse files

nvme: add a new opts_size parameter for default ctrlr opts 



Add a new parameter for the default ctrlr opts initialization.
This is to make sure future compatibility when SPDK components
are built as a shared library. User's version and SPDK's version
may be in different size.

The change here is to make sure the backward compatibility when
new fields are added in the struct spdk_nvme_ctrlr_opts.

Change-Id: Icfc9640993cb06063b825d4df5835d920dd374e5
Signed-off-by: default avatarGangCao <gang.cao@intel.com>
Reviewed-on: https://review.gerrithub.io/380846


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent e960eb47

lib/nvme/nvme.c

+1 −1
Original line number Diff line number Diff line
@@ -320,7 +320,7 @@ nvme_ctrlr_probe(const struct spdk_nvme_transport_id *trid, void *devhandle, 
	struct spdk_nvme_ctrlr *ctrlr;

	struct spdk_nvme_ctrlr_opts opts;



	spdk_nvme_ctrlr_opts_set_defaults(&opts);

	spdk_nvme_ctrlr_opts_set_defaults(&opts, sizeof(opts));



	if (probe_cb(cb_ctx, trid, &opts)) {

		ctrlr = nvme_transport_ctrlr_construct(trid, &opts, devhandle);

lib/nvme/nvme_ctrlr.c

+54 −14
Original line number Diff line number Diff line
@@ -78,25 +78,65 @@ nvme_ctrlr_set_cc(struct spdk_nvme_ctrlr *ctrlr, const union spdk_nvme_cc_regist 
}



void

spdk_nvme_ctrlr_opts_set_defaults(struct spdk_nvme_ctrlr_opts *opts)

spdk_nvme_ctrlr_opts_set_defaults(struct spdk_nvme_ctrlr_opts *opts, size_t opts_size)

{

	char host_id_str[37];



	assert(opts);



	memset(opts, 0, opts_size);



#define FIELD_OK(field) \

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



	if (FIELD_OK(num_io_queues)) {

		opts->num_io_queues = DEFAULT_MAX_IO_QUEUES;

	}



	if (FIELD_OK(use_cmb_sqs)) {

		opts->use_cmb_sqs = true;

	}



	if (FIELD_OK(arb_mechanism)) {

		opts->arb_mechanism = SPDK_NVME_CC_AMS_RR;

	}



	if (FIELD_OK(keep_alive_timeout_ms)) {

		opts->keep_alive_timeout_ms = 10 * 1000;

	}



	if (FIELD_OK(io_queue_size)) {

		opts->io_queue_size = DEFAULT_IO_QUEUE_SIZE;

	}



	if (FIELD_OK(io_queue_requests)) {

		opts->io_queue_requests = DEFAULT_IO_QUEUE_REQUESTS;

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

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

	}



	if (FIELD_OK(host_id)) {

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

	}



	if (FIELD_OK(extended_host_id)) {

		memcpy(opts->extended_host_id, g_spdk_nvme_driver->default_extended_host_id,

		       sizeof(opts->extended_host_id));

	uuid_unparse(opts->extended_host_id, host_id_str);

	}



	if (FIELD_OK(hostnqn)) {

		uuid_unparse(g_spdk_nvme_driver->default_extended_host_id, host_id_str);

		snprintf(opts->hostnqn, sizeof(opts->hostnqn), "2014-08.org.nvmexpress:uuid:%s", host_id_str);

	}



	if (FIELD_OK(src_addr)) {

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

	}



	if (FIELD_OK(src_svcid)) {

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

	}

#undef FIELD_OK

}



/**

 * This function will be called when the process allocates the IO qpair.

 * Note: the ctrlr_lock must be held when calling this function.

lib/nvme/nvme_internal.h

+1 −1
Original line number Diff line number Diff line
@@ -587,7 +587,7 @@ void nvme_free_request(struct nvme_request *req); 
void	nvme_request_remove_child(struct nvme_request *parent, struct nvme_request *child);

uint64_t nvme_get_quirks(const struct spdk_pci_id *id);



void	spdk_nvme_ctrlr_opts_set_defaults(struct spdk_nvme_ctrlr_opts *opts);

void	spdk_nvme_ctrlr_opts_set_defaults(struct spdk_nvme_ctrlr_opts *opts, size_t opts_size);



int	nvme_robust_mutex_init_shared(pthread_mutex_t *mtx);

int	nvme_robust_mutex_init_recursive_shared(pthread_mutex_t *mtx);

lib/nvme/nvme_rdma.c

+1 −1
Original line number Diff line number Diff line
@@ -1192,7 +1192,7 @@ nvme_rdma_ctrlr_scan(const struct spdk_nvme_transport_id *discovery_trid, 
		return rc;

	}



	spdk_nvme_ctrlr_opts_set_defaults(&discovery_opts);

	spdk_nvme_ctrlr_opts_set_defaults(&discovery_opts, sizeof(discovery_opts));

	/* For discovery_ctrlr set the timeout to 0 */

	discovery_opts.keep_alive_timeout_ms = 0;

test/unit/lib/nvme/nvme.c/nvme_ut.c

+1 −1
Original line number Diff line number Diff line
@@ -95,7 +95,7 @@ nvme_ctrlr_destruct(struct spdk_nvme_ctrlr *ctrlr) 
}



void

spdk_nvme_ctrlr_opts_set_defaults(struct spdk_nvme_ctrlr_opts *opts)

spdk_nvme_ctrlr_opts_set_defaults(struct spdk_nvme_ctrlr_opts *opts, size_t opts_size)

{

	memset(opts, 0, sizeof(*opts));

}