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

nvme: add _string suffix for print utils 



This is to clearly show that the outputs of these functions are strings.

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


Reviewed-by: default avatarTomasz Zawadzki <tomasz@tzawadzki.com>
Community-CI: Mellanox Build Bot
Reviewed-by: default avatarJim Harris <jim.harris@nvidia.com>
Tested-by: default avatarSPDK Automated Test System <spdkbot@gmail.com>
parent 8ab2fc60

lib/nvme/nvme_qpair.c

+20 −20
Original line number Diff line number Diff line
@@ -140,7 +140,7 @@ nvme_get_string(const struct nvme_string *strings, uint16_t value) 
}



static void

nvme_get_sgl_unkeyed(char *buf, size_t size, struct spdk_nvme_cmd *cmd)

nvme_get_sgl_unkeyed_string(char *buf, size_t size, struct spdk_nvme_cmd *cmd)

{

	struct spdk_nvme_sgl_descriptor *sgl = &cmd->dptr.sgl1;
@@ -148,7 +148,7 @@ nvme_get_sgl_unkeyed(char *buf, size_t size, struct spdk_nvme_cmd *cmd) 
}



static void

nvme_get_sgl_keyed(char *buf, size_t size, struct spdk_nvme_cmd *cmd)

nvme_get_sgl_keyed_string(char *buf, size_t size, struct spdk_nvme_cmd *cmd)

{

	struct spdk_nvme_sgl_descriptor *sgl = &cmd->dptr.sgl1;
@@ -156,7 +156,7 @@ nvme_get_sgl_keyed(char *buf, size_t size, struct spdk_nvme_cmd *cmd) 
}



static void

nvme_get_sgl(char *buf, size_t size, struct spdk_nvme_cmd *cmd)

nvme_get_sgl_string(char *buf, size_t size, struct spdk_nvme_cmd *cmd)

{

	struct spdk_nvme_sgl_descriptor *sgl = &cmd->dptr.sgl1;

	int c;
@@ -166,31 +166,31 @@ nvme_get_sgl(char *buf, size_t size, struct spdk_nvme_cmd *cmd) 
	assert(c >= 0 && (size_t)c < size);



	if (sgl->generic.type == SPDK_NVME_SGL_TYPE_DATA_BLOCK) {

		nvme_get_sgl_unkeyed(buf + c, size - c, cmd);

		nvme_get_sgl_unkeyed_string(buf + c, size - c, cmd);

	}



	if (sgl->generic.type == SPDK_NVME_SGL_TYPE_KEYED_DATA_BLOCK) {

		nvme_get_sgl_keyed(buf + c, size - c, cmd);

		nvme_get_sgl_keyed_string(buf + c, size - c, cmd);

	}

}



static void

nvme_get_prp(char *buf, size_t size, struct spdk_nvme_cmd *cmd)

nvme_get_prp_string(char *buf, size_t size, struct spdk_nvme_cmd *cmd)

{

	snprintf(buf, size, "PRP1 0x%" PRIx64 " PRP2 0x%" PRIx64, cmd->dptr.prp.prp1, cmd->dptr.prp.prp2);

}



static void

nvme_get_dptr(char *buf, size_t size, struct spdk_nvme_cmd *cmd)

nvme_get_dptr_string(char *buf, size_t size, struct spdk_nvme_cmd *cmd)

{

	if (spdk_nvme_opc_get_data_transfer(cmd->opc) != SPDK_NVME_DATA_NONE) {

		switch (cmd->psdt) {

		case SPDK_NVME_PSDT_PRP:

			nvme_get_prp(buf, size, cmd);

			nvme_get_prp_string(buf, size, cmd);

			break;

		case SPDK_NVME_PSDT_SGL_MPTR_CONTIG:

		case SPDK_NVME_PSDT_SGL_MPTR_SGL:

			nvme_get_sgl(buf, size, cmd);

			nvme_get_sgl_string(buf, size, cmd);

			break;

		default:

			;
@@ -199,14 +199,14 @@ nvme_get_dptr(char *buf, size_t size, struct spdk_nvme_cmd *cmd) 
}



static void

nvme_get_admin_qpair_command(char *buf, size_t size, uint16_t qid, struct spdk_nvme_cmd *cmd)

nvme_get_admin_qpair_command_string(char *buf, size_t size, uint16_t qid, struct spdk_nvme_cmd *cmd)

{

	struct spdk_nvmf_capsule_cmd *fcmd = (void *)cmd;

	char dptr[NVME_CMD_DPTR_STR_SIZE] = {'\0'};



	assert(cmd != NULL);



	nvme_get_dptr(dptr, sizeof(dptr), cmd);

	nvme_get_dptr_string(dptr, sizeof(dptr), cmd);



	switch ((int)cmd->opc) {

	case SPDK_NVME_OPC_SET_FEATURES:
@@ -236,18 +236,18 @@ nvme_admin_qpair_print_command(uint16_t qid, struct spdk_nvme_cmd *cmd) 
{

	char buf[NVME_CMD_STR_SIZE] = {'\0'};



	nvme_get_admin_qpair_command(buf, sizeof(buf), qid, cmd);

	nvme_get_admin_qpair_command_string(buf, sizeof(buf), qid, cmd);

	SPDK_NOTICELOG("%s\n", buf);

}



static void

nvme_get_io_qpair_command(char *buf, size_t size, uint16_t qid, struct spdk_nvme_cmd *cmd)

nvme_get_io_qpair_command_string(char *buf, size_t size, uint16_t qid, struct spdk_nvme_cmd *cmd)

{

	char dptr[NVME_CMD_DPTR_STR_SIZE] = {'\0'};



	assert(cmd != NULL);



	nvme_get_dptr(dptr, sizeof(dptr), cmd);

	nvme_get_dptr_string(dptr, sizeof(dptr), cmd);



	switch ((int)cmd->opc) {

	case SPDK_NVME_OPC_WRITE:
@@ -278,7 +278,7 @@ nvme_io_qpair_print_command(uint16_t qid, struct spdk_nvme_cmd *cmd) 
{

	char buf[NVME_CMD_STR_SIZE] = {'\0'};



	nvme_get_io_qpair_command(buf, sizeof(buf), qid, cmd);

	nvme_get_io_qpair_command_string(buf, sizeof(buf), qid, cmd);

	SPDK_NOTICELOG("%s\n", buf);

}
@@ -302,9 +302,9 @@ spdk_nvme_qpair_print_command(struct spdk_nvme_qpair *qpair, struct spdk_nvme_cm 
	assert(qpair != NULL);



	if (qpair->id == 0 || cmd->opc == SPDK_NVME_OPC_FABRIC) {

		nvme_get_admin_qpair_command(buf, sizeof(buf), qpair->id, cmd);

		nvme_get_admin_qpair_command_string(buf, sizeof(buf), qpair->id, cmd);

	} else {

		nvme_get_io_qpair_command(buf, sizeof(buf), qpair->id, cmd);

		nvme_get_io_qpair_command_string(buf, sizeof(buf), qpair->id, cmd);

	}



	NVME_QPAIR_NOTICELOG(qpair, "%s\n", buf);
@@ -492,7 +492,7 @@ spdk_nvme_cpl_get_status_type_string(const struct spdk_nvme_status *status) 
}



static void

nvme_get_completion(char *buf, size_t size, uint16_t qid, struct spdk_nvme_cpl *cpl)

nvme_get_completion_string(char *buf, size_t size, uint16_t qid, struct spdk_nvme_cpl *cpl)

{

	assert(cpl != NULL);
@@ -514,7 +514,7 @@ spdk_nvme_print_completion(uint16_t qid, struct spdk_nvme_cpl *cpl) 
		SPDK_ERRLOG("sqid %u doesn't match qid\n", cpl->sqid);

	}



	nvme_get_completion(buf, sizeof(buf), qid, cpl);

	nvme_get_completion_string(buf, sizeof(buf), qid, cpl);

	SPDK_NOTICELOG("%s\n", buf);

}
@@ -527,7 +527,7 @@ spdk_nvme_qpair_print_completion(struct spdk_nvme_qpair *qpair, struct spdk_nvme 
		NVME_QPAIR_ERRLOG(qpair, "sqid %u doesn't match qid\n", cpl->sqid);

	}



	nvme_get_completion(buf, sizeof(buf), qpair->id, cpl);

	nvme_get_completion_string(buf, sizeof(buf), qpair->id, cpl);

	NVME_QPAIR_NOTICELOG(qpair, "%s\n", buf);

}

test/unit/lib/nvme/nvme_qpair.c/nvme_qpair_ut.c

+4 −4
Original line number Diff line number Diff line
@@ -717,13 +717,13 @@ test_nvme_get_sgl_print_info(void) 
	cmd.dptr.sgl1.keyed.length = 0x1000;

	cmd.dptr.sgl1.keyed.key = 0xababccdd;



	nvme_get_sgl_keyed(buf, NVME_CMD_DPTR_STR_SIZE, &cmd);

	nvme_get_sgl_keyed_string(buf, NVME_CMD_DPTR_STR_SIZE, &cmd);

	CU_ASSERT(!strncmp(buf, " len:0x1000 key:0xababccdd", NVME_CMD_DPTR_STR_SIZE));



	memset(&cmd.dptr.sgl1, 0, sizeof(cmd.dptr.sgl1));

	cmd.dptr.sgl1.unkeyed.length = 0x1000;



	nvme_get_sgl_unkeyed(buf, NVME_CMD_DPTR_STR_SIZE, &cmd);

	nvme_get_sgl_unkeyed_string(buf, NVME_CMD_DPTR_STR_SIZE, &cmd);

	CU_ASSERT(!strncmp(buf, " len:0x1000", NVME_CMD_DPTR_STR_SIZE));



	memset(&cmd.dptr.sgl1, 0, sizeof(cmd.dptr.sgl1));
@@ -732,7 +732,7 @@ test_nvme_get_sgl_print_info(void) 
	cmd.dptr.sgl1.address = 0xdeadbeef;

	cmd.dptr.sgl1.unkeyed.length = 0x1000;



	nvme_get_sgl(buf, NVME_CMD_DPTR_STR_SIZE, &cmd);

	nvme_get_sgl_string(buf, NVME_CMD_DPTR_STR_SIZE, &cmd);

	CU_ASSERT(!strncmp(buf, "SGL DATA BLOCK ADDRESS 0xdeadbeef len:0x1000",

			   NVME_CMD_DPTR_STR_SIZE));
@@ -743,7 +743,7 @@ test_nvme_get_sgl_print_info(void) 
	cmd.dptr.sgl1.keyed.length = 0x1000;

	cmd.dptr.sgl1.keyed.key = 0xababccdd;



	nvme_get_sgl(buf, NVME_CMD_DPTR_STR_SIZE, &cmd);

	nvme_get_sgl_string(buf, NVME_CMD_DPTR_STR_SIZE, &cmd);

	CU_ASSERT(!strncmp(buf, "SGL KEYED DATA BLOCK ADDRESS 0xdeadbeef len:0x1000 key:0xababccdd",

			   NVME_CMD_DPTR_STR_SIZE));

}