Commit 15338253 authored by Jacek Kalwas's avatar Jacek Kalwas Committed by Jim Harris
Browse files

nvme: add spdk_nvme_build_name util function 



While making util fix reconnect build name with ns (ns was missing).

Change-Id: Iabf6d9eba8895b4232502d27c93d6139dc05cba0
Signed-off-by: default avatarJacek Kalwas <jacek.kalwas@nutanix.com>
Reviewed-on: https://review.spdk.io/c/spdk/spdk/+/25852


Reviewed-by: default avatarJim Harris <jim.harris@nvidia.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: default avatarAnkit Kumar <ankit.kumar@samsung.com>
Reviewed-by: default avatarKonrad Sztyber <ksztyber@nvidia.com>
Tested-by: default avatarSPDK Automated Test System <spdkbot@gmail.com>
Community-CI: Mellanox Build Bot
parent 91fd8438

app/spdk_nvme_perf/perf.c

+2 −46
Original line number Diff line number Diff line
@@ -1212,50 +1212,6 @@ static const struct ns_fn_table nvme_fn_table = { 
	.dump_transport_stats	= nvme_dump_transport_stats

};



static int

build_nvme_name(char *name, size_t length, struct spdk_nvme_ctrlr *ctrlr)

{

	const struct spdk_nvme_transport_id *trid;

	int res = 0;



	trid = spdk_nvme_ctrlr_get_transport_id(ctrlr);



	switch (trid->trtype) {

	case SPDK_NVME_TRANSPORT_PCIE:

		res = snprintf(name, length, "PCIE (%s)", trid->traddr);

		break;

	case SPDK_NVME_TRANSPORT_RDMA:

		res = snprintf(name, length, "RDMA (addr:%s subnqn:%s)", trid->traddr, trid->subnqn);

		break;

	case SPDK_NVME_TRANSPORT_TCP:

		res = snprintf(name, length, "TCP (addr:%s subnqn:%s)", trid->traddr, trid->subnqn);

		break;

	case SPDK_NVME_TRANSPORT_VFIOUSER:

		res = snprintf(name, length, "VFIOUSER (%s)", trid->traddr);

		break;

	case SPDK_NVME_TRANSPORT_CUSTOM:

		res = snprintf(name, length, "CUSTOM (%s)", trid->traddr);

		break;



	default:

		fprintf(stderr, "Unknown transport type %d\n", trid->trtype);

		break;

	}

	return res;

}



static void

build_nvme_ns_name(char *name, size_t length, struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid)

{

	int res = 0;



	res = build_nvme_name(name, length, ctrlr);

	if (res > 0) {

		snprintf(name + res, length - res, " NSID %u", nsid);

	}



}



static void

register_ns(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_ns *ns)

{
@@ -1363,7 +1319,7 @@ register_ns(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_ns *ns) 
		g_max_io_size_blocks = entry->io_size_blocks;

	}



	build_nvme_ns_name(entry->name, sizeof(entry->name), ctrlr, spdk_nvme_ns_get_id(ns));

	spdk_nvme_build_name(entry->name, sizeof(entry->name), ctrlr, ns);



	g_num_namespaces++;

	TAILQ_INSERT_TAIL(&g_namespaces, entry, link);
@@ -1443,7 +1399,7 @@ register_ctrlr(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_trid_entry *trid_ 
		exit(1);

	}



	build_nvme_name(entry->name, sizeof(entry->name), ctrlr);

	spdk_nvme_build_name(entry->name, sizeof(entry->name), ctrlr, NULL);



	entry->ctrlr = ctrlr;

	entry->trtype = trid_entry->trid.trtype;

examples/nvme/abort/abort.c

+2 −43
Original line number Diff line number Diff line
@@ -119,47 +119,6 @@ static TAILQ_HEAD(, _trid_entry) g_trid_list = TAILQ_HEAD_INITIALIZER(g_trid_lis 


static void io_complete(void *ctx, const struct spdk_nvme_cpl *cpl);



static int

build_nvme_name(char *name, size_t length, struct spdk_nvme_ctrlr *ctrlr)

{

	const struct spdk_nvme_transport_id *trid;

	int res = 0;



	trid = spdk_nvme_ctrlr_get_transport_id(ctrlr);



	switch (trid->trtype) {

	case SPDK_NVME_TRANSPORT_PCIE:

		res = snprintf(name, length, "PCIE (%s)", trid->traddr);

		break;

	case SPDK_NVME_TRANSPORT_RDMA:

		res = snprintf(name, length, "RDMA (addr:%s subnqn:%s)", trid->traddr, trid->subnqn);

		break;

	case SPDK_NVME_TRANSPORT_TCP:

		res = snprintf(name, length, "TCP (addr:%s subnqn:%s)", trid->traddr, trid->subnqn);

		break;

	case SPDK_NVME_TRANSPORT_CUSTOM:

		res = snprintf(name, length, "CUSTOM (%s)", trid->traddr);

		break;



	default:

		fprintf(stderr, "Unknown transport type %d\n", trid->trtype);

		break;

	}

	return res;

}



static void

build_nvme_ns_name(char *name, size_t length, struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid)

{

	int res = 0;



	res = build_nvme_name(name, length, ctrlr);

	if (res > 0) {

		snprintf(name + res, length - res, " NSID %u", nsid);

	}



}



static void

register_ns(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_ns *ns)

{
@@ -228,7 +187,7 @@ register_ns(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_ns *ns) 
		g_max_io_size_blocks = entry->io_size_blocks;

	}



	build_nvme_ns_name(entry->name, sizeof(entry->name), ctrlr, spdk_nvme_ns_get_id(ns));

	spdk_nvme_build_name(entry->name, sizeof(entry->name), ctrlr, ns);



	g_num_namespaces++;

	TAILQ_INSERT_TAIL(&g_namespaces, entry, link);
@@ -257,7 +216,7 @@ register_ctrlr(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_trid_entry *trid_ 
		exit(1);

	}



	build_nvme_name(entry->name, sizeof(entry->name), ctrlr);

	spdk_nvme_build_name(entry->name, sizeof(entry->name), ctrlr, NULL);



	entry->ctrlr = ctrlr;

	entry->trtype = trid_entry->trid.trtype;

examples/nvme/reconnect/reconnect.c

+2 −28
Original line number Diff line number Diff line
@@ -225,32 +225,6 @@ nvme_cleanup_ns_worker_ctx(struct ns_worker_ctx *ns_ctx) 
	free(ns_ctx->qpair);

}



static void

build_nvme_name(char *name, size_t length, struct spdk_nvme_ctrlr *ctrlr)

{

	const struct spdk_nvme_transport_id *trid;



	trid = spdk_nvme_ctrlr_get_transport_id(ctrlr);



	switch (trid->trtype) {

	case SPDK_NVME_TRANSPORT_RDMA:

		snprintf(name, length, "RDMA (addr:%s subnqn:%s)", trid->traddr, trid->subnqn);

		break;

	case SPDK_NVME_TRANSPORT_TCP:

		snprintf(name, length, "TCP (addr:%s subnqn:%s)", trid->traddr, trid->subnqn);

		break;

	case SPDK_NVME_TRANSPORT_VFIOUSER:

		snprintf(name, length, "VFIOUSER (%s)", trid->traddr);

		break;

	case SPDK_NVME_TRANSPORT_CUSTOM:

		snprintf(name, length, "CUSTOM (%s)", trid->traddr);

		break;

	default:

		fprintf(stderr, "Unknown transport type %d\n", trid->trtype);

		break;

	}

}



static void

register_ns(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_ns *ns)

{
@@ -321,7 +295,7 @@ register_ns(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_ns *ns) 
		g_max_io_size_blocks = entry->io_size_blocks;

	}



	build_nvme_name(entry->name, sizeof(entry->name), ctrlr);

	spdk_nvme_build_name(entry->name, sizeof(entry->name), ctrlr, ns);



	g_num_namespaces++;

	TAILQ_INSERT_TAIL(&g_namespaces, entry, link);
@@ -367,7 +341,7 @@ register_ctrlr(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_trid_entry *trid_ 
	snprintf(entry->failover_trid.subnqn, SPDK_NVMF_NQN_MAX_LEN + 1, "%s", ctrlr_trid->subnqn);





	build_nvme_name(entry->name, sizeof(entry->name), ctrlr);

	spdk_nvme_build_name(entry->name, sizeof(entry->name), ctrlr, NULL);



	entry->ctrlr = ctrlr;

	entry->trtype = trid_entry->trid.trtype;

include/spdk_internal/nvme_util.h

+13 −0
Original line number Diff line number Diff line
@@ -52,4 +52,17 @@ void spdk_nvme_transport_id_usage(FILE *f, uint32_t opts); 
 */

int spdk_nvme_trid_entry_parse(struct spdk_nvme_trid_entry *trid_entry, const char *str);



/**

 * Builds NVMe name.

 *

 * \param name Pointer to a character string where NVMe name is meant to be built.

 * \param length Length of the given character string, plus the null terminator.

 * \param ctrlr NVMe controller.

 * \param ns Namespace (optional)

 *

 * \return Number of characters not including the terminating null character or negative on failure.

 */

int spdk_nvme_build_name(char *name, size_t length, struct spdk_nvme_ctrlr *ctrlr,

			 struct spdk_nvme_ns *ns);



#endif /* SPDK_INTERNAL_NVME_UTIL_H */

lib/nvme/nvme_util.c

+45 −0
Original line number Diff line number Diff line
@@ -129,3 +129,48 @@ spdk_nvme_trid_entry_parse(struct spdk_nvme_trid_entry *trid_entry, const char * 


	return 0;

}



int

spdk_nvme_build_name(char *name, size_t length, struct spdk_nvme_ctrlr *ctrlr,

		     struct spdk_nvme_ns *ns)

{

	const struct spdk_nvme_transport_id *trid;

	int res, res2 = 0;



	trid = spdk_nvme_ctrlr_get_transport_id(ctrlr);



	switch (trid->trtype) {

	case SPDK_NVME_TRANSPORT_PCIE:

		res = snprintf(name, length, "PCIE (%s)", trid->traddr);

		break;

	case SPDK_NVME_TRANSPORT_RDMA:

		res = snprintf(name, length, "RDMA (addr:%s subnqn:%s)", trid->traddr, trid->subnqn);

		break;

	case SPDK_NVME_TRANSPORT_TCP:

		res = snprintf(name, length, "TCP (addr:%s subnqn:%s)", trid->traddr, trid->subnqn);

		break;

	case SPDK_NVME_TRANSPORT_VFIOUSER:

		res = snprintf(name, length, "VFIOUSER (%s)", trid->traddr);

		break;

	case SPDK_NVME_TRANSPORT_CUSTOM:

		res = snprintf(name, length, "CUSTOM (%s)", trid->traddr);

		break;

	default:

		fprintf(stderr, "Unknown transport type %d\n", trid->trtype);

		res = -EINVAL;

	}



	if (res < 0) {

		return res;

	}



	if (ns) {

		res2 = snprintf(name + res, length - res, " NSID %u", spdk_nvme_ns_get_id(ns));

	}



	if (res2 < 0) {

		return res2;

	}



	return res + res2;

}