Commit 26d44a12 authored by Jim Harris's avatar Jim Harris Committed by Tomasz Zawadzki
Browse files

trace: rename owner to owner_type 



We will be adding the real concept of an "owner" in upcoming patches. So change
the existing "owner" to "owner_type" which more accurate reflects its meaning.
For example, an "owner_type" can be OWNER_BDEV, but an actual "owner" would
be some specific bdev identified by its name.

Signed-off-by: default avatarJim Harris <jim.harris@samsung.com>
Change-Id: Ieb25eb5a574a88b3812291f2345796e5bb66a54f
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/22645


Reviewed-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: default avatarShuhei Matsumoto <smatsumoto@nvidia.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent 00918d5c

app/trace/trace.cpp

+4 −4
Original line number Diff line number Diff line
@@ -140,8 +140,8 @@ print_event(struct spdk_trace_parser_entry *entry, uint64_t tsc_rate, uint64_t t 
	if (g_print_tsc) {

		printf("(%9ju) ", e->tsc - tsc_offset);

	}

	if (g_file->owner[d->owner_type].id_prefix) {

		printf("%c%02d ", g_file->owner[d->owner_type].id_prefix, e->poller_id);

	if (g_file->owner_type[d->owner_type].id_prefix) {

		printf("%c%02d ", g_file->owner_type[d->owner_type].id_prefix, e->poller_id);

	} else {

		printf("%4s", " ");

	}
@@ -199,9 +199,9 @@ print_event_json(struct spdk_trace_parser_entry *entry, uint64_t tsc_rate, uint6 
	spdk_json_write_named_uint64(g_json, "tpoint", e->tpoint_id);

	spdk_json_write_named_uint64(g_json, "tsc", e->tsc);



	if (g_file->owner[d->owner_type].id_prefix) {

	if (g_file->owner_type[d->owner_type].id_prefix) {

		spdk_json_write_named_string_fmt(g_json, "poller", "%c%02d",

						 g_file->owner[d->owner_type].id_prefix,

						 g_file->owner_type[d->owner_type].id_prefix,

						 e->poller_id);

	}

	if (e->size != 0) {

doc/nvmf_tracing.md

+2 −2
Original line number Diff line number Diff line
@@ -219,10 +219,10 @@ SPDK_TRACE_REGISTER_FN(nvmf_trace, "nvmf_rdma", TRACE_GROUP_NVMF_RDMA) 
{

	spdk_trace_register_object(OBJECT_NVMF_RDMA_IO, 'r');

	spdk_trace_register_description("RDMA_REQ_NEW", TRACE_RDMA_REQUEST_STATE_NEW,

					OWNER_NONE, OBJECT_NVMF_RDMA_IO, 1,

					OWNER_TYPE_NONE, OBJECT_NVMF_RDMA_IO, 1,

					SPDK_TRACE_ARG_TYPE_PTR, "qpair");

	spdk_trace_register_description("RDMA_REQ_NEED_BUFFER", TRACE_RDMA_REQUEST_STATE_NEED_BUFFER,

					OWNER_NONE, OBJECT_NVMF_RDMA_IO, 0,

					OWNER_TYPE_NONE, OBJECT_NVMF_RDMA_IO, 0,

					SPDK_TRACE_ARG_TYPE_PTR, "qpair");

	...

}

include/spdk/trace.h

+6 −6
Original line number Diff line number Diff line
@@ -40,9 +40,9 @@ SPDK_STATIC_ASSERT(sizeof(struct spdk_trace_entry_buffer) == sizeof(struct spdk_ 
		   "Invalid size of trace entry buffer");



/* If type changes from a uint8_t, change this value. */

#define SPDK_TRACE_MAX_OWNER (UCHAR_MAX + 1)

#define SPDK_TRACE_MAX_OWNER_TYPE (UCHAR_MAX + 1)



struct spdk_trace_owner {

struct spdk_trace_owner_type {

	uint8_t	type;

	char	id_prefix;

};
@@ -121,7 +121,7 @@ struct spdk_trace_file { 
	uint64_t			tsc_rate;

	uint64_t			tpoint_mask[SPDK_TRACE_MAX_GROUP_ID];

	char				tname[SPDK_TRACE_MAX_LCORE][SPDK_TRACE_THREAD_NAME_LEN];

	struct spdk_trace_owner		owner[UCHAR_MAX + 1];

	struct spdk_trace_owner_type	owner_type[SPDK_TRACE_MAX_OWNER_TYPE];

	struct spdk_trace_object	object[UCHAR_MAX + 1];

	struct spdk_trace_tpoint	tpoint[SPDK_TRACE_MAX_TPOINT_ID];
@@ -301,16 +301,16 @@ int spdk_trace_unregister_user_thread(void); 
 */

void spdk_trace_cleanup(void);



#define OWNER_NONE 0

#define OWNER_TYPE_NONE 0

#define OBJECT_NONE 0



/**

 * Register the trace owner.

 * Register the trace owner type.

 *

 * \param type Type of the trace owner.

 * \param id_prefix Prefix of id for the trace owner.

 */

void spdk_trace_register_owner(uint8_t type, char id_prefix);

void spdk_trace_register_owner_type(uint8_t type, char id_prefix);



/**

 * Register the trace object.

include/spdk_internal/trace_defs.h

+8 −8
Original line number Diff line number Diff line
@@ -8,14 +8,14 @@ 
#define SPDK_INTERNAL_TRACE_DEFS



/* Owner definitions */

#define OWNER_ISCSI_CONN	0x1

#define OWNER_BDEV		0x2

#define OWNER_NVME_PCIE_QP	0x3

#define OWNER_NVME_TCP_QP	0x4

#define OWNER_SOCK		0x5

#define OWNER_SCSI_DEV		0x10

#define OWNER_FTL		0x20

#define OWNER_NVMF_TCP		0x30

#define OWNER_TYPE_ISCSI_CONN	0x1

#define OWNER_TYPE_BDEV		0x2

#define OWNER_TYPE_NVME_PCIE_QP	0x3

#define OWNER_TYPE_NVME_TCP_QP	0x4

#define OWNER_TYPE_SOCK		0x5

#define OWNER_TYPE_SCSI_DEV	0x10

#define OWNER_TYPE_FTL		0x20

#define OWNER_TYPE_NVMF_TCP	0x30



/* Object definitions */

#define OBJECT_ISCSI_PDU	0x1

lib/bdev/bdev.c

+5 −5
Original line number Diff line number Diff line
@@ -10359,7 +10359,7 @@ SPDK_TRACE_REGISTER_FN(bdev_trace, "bdev", TRACE_GROUP_BDEV) 
	struct spdk_trace_tpoint_opts opts[] = {

		{

			"BDEV_IO_START", TRACE_BDEV_IO_START,

			OWNER_BDEV, OBJECT_BDEV_IO, 1,

			OWNER_TYPE_BDEV, OBJECT_BDEV_IO, 1,

			{

				{ "type", SPDK_TRACE_ARG_TYPE_INT, 8 },

				{ "ctx", SPDK_TRACE_ARG_TYPE_PTR, 8 },
@@ -10370,12 +10370,12 @@ SPDK_TRACE_REGISTER_FN(bdev_trace, "bdev", TRACE_GROUP_BDEV) 
		},

		{

			"BDEV_IO_DONE", TRACE_BDEV_IO_DONE,

			OWNER_BDEV, OBJECT_BDEV_IO, 0,

			OWNER_TYPE_BDEV, OBJECT_BDEV_IO, 0,

			{{ "ctx", SPDK_TRACE_ARG_TYPE_PTR, 8 }}

		},

		{

			"BDEV_IOCH_CREATE", TRACE_BDEV_IOCH_CREATE,

			OWNER_BDEV, OBJECT_NONE, 1,

			OWNER_TYPE_BDEV, OBJECT_NONE, 1,

			{

				{ "name", SPDK_TRACE_ARG_TYPE_STR, 40 },

				{ "thread_id", SPDK_TRACE_ARG_TYPE_INT, 8}
@@ -10383,7 +10383,7 @@ SPDK_TRACE_REGISTER_FN(bdev_trace, "bdev", TRACE_GROUP_BDEV) 
		},

		{

			"BDEV_IOCH_DESTROY", TRACE_BDEV_IOCH_DESTROY,

			OWNER_BDEV, OBJECT_NONE, 0,

			OWNER_TYPE_BDEV, OBJECT_NONE, 0,

			{

				{ "name", SPDK_TRACE_ARG_TYPE_STR, 40 },

				{ "thread_id", SPDK_TRACE_ARG_TYPE_INT, 8}
@@ -10392,7 +10392,7 @@ SPDK_TRACE_REGISTER_FN(bdev_trace, "bdev", TRACE_GROUP_BDEV) 
	};





	spdk_trace_register_owner(OWNER_BDEV, 'b');

	spdk_trace_register_owner_type(OWNER_TYPE_BDEV, 'b');

	spdk_trace_register_object(OBJECT_BDEV_IO, 'i');

	spdk_trace_register_description_ext(opts, SPDK_COUNTOF(opts));

	spdk_trace_tpoint_register_relation(TRACE_BDEV_NVME_IO_START, OBJECT_BDEV_IO, 0);