Add lm-print* files, making json support optional

Author: NateThornton

plugins/lm/lm-nvme.c

@@ -35,6 +35,8 @@
 #define CREATE_CMD
 #include "lm-nvme.h"
 
+#include "lm-print.h"
+
 static inline const char *arg_str(const char * const *strings,
 		size_t array_size, size_t idx)
 {
@@ -417,206 +419,6 @@ static int lm_migration_send(int argc, char **argv, struct command *command, str
 	return err;
 }
 
-static void json_controller_state_data(struct nvme_lm_controller_state_data *data, size_t len)
-{
-	struct json_object *root = json_create_object();
-	struct json_object *nvmecs = json_create_object();
-	struct json_object *iosqs = json_create_array();
-	struct json_object *iocqs = json_create_array();
-
-	json_object_add_value_uint(root, "version",
-				   le16_to_cpu(data->hdr.ver));
-	json_object_add_value_uint(root, "controller state attributes",
-				   data->hdr.csattr);
-	json_object_add_value_uint128(root, "nvme controller state size",
-				      le128_to_cpu(data->hdr.nvmecss));
-	json_object_add_value_uint128(root, "vendor specific size",
-				      le128_to_cpu(data->hdr.vss));
-
-	json_object_add_value_object(root, "nvme controller state", nvmecs);
-
-	json_object_add_value_uint(nvmecs, "version",
-				   le16_to_cpu(data->data.hdr.ver));
-	json_object_add_value_uint(nvmecs, "number of io submission queues",
-				   le16_to_cpu(data->data.hdr.niosq));
-	json_object_add_value_uint(nvmecs, "number of io completion queues",
-				   le16_to_cpu(data->data.hdr.niocq));
-
-	json_object_add_value_array(nvmecs, "io submission queue list", iosqs);
-
-	for (int i = 0; i < data->data.hdr.niosq; i++) {
-		struct nvme_lm_io_submission_queue_data *sq = &data->data.sqs[i];
-		struct json_object *sq_obj = json_create_object();
-
-		json_object_add_value_uint64(sq_obj, "io submission prp entry 1",
-					     le64_to_cpu(sq->iosqprp1));
-		json_object_add_value_uint(sq_obj, "io submission queue size",
-					   le16_to_cpu(sq->iosqqsize));
-		json_object_add_value_uint(sq_obj, "io submission queue identifier",
-					   le16_to_cpu(sq->iosqqid));
-		json_object_add_value_uint(sq_obj, "io completion queue identifier",
-					   le16_to_cpu(sq->iosqcqid));
-		json_object_add_value_uint(sq_obj, "io submission queue attributes",
-					   le16_to_cpu(sq->iosqa));
-		json_object_add_value_uint(sq_obj, "io submission queue head pointer",
-					   le16_to_cpu(sq->iosqhp));
-		json_object_add_value_uint(sq_obj, "io submission queue tail pointer",
-					   le16_to_cpu(sq->iosqtp));
-
-		json_array_add_value_object(iosqs, sq_obj);
-	}
-
-	json_object_add_value_array(nvmecs, "io completion queue list", iocqs);
-
-	for (int i = 0; i < data->data.hdr.niocq; i++) {
-		struct nvme_lm_io_completion_queue_data *cq = &data->data.cqs[i];
-		struct json_object *cq_obj = json_create_object();
-
-		json_object_add_value_uint64(cq_obj, "io completion prp entry 1",
-					     le64_to_cpu(cq->iocqprp1));
-		json_object_add_value_uint(cq_obj, "io completion queue size",
-					   le16_to_cpu(cq->iocqqsize));
-		json_object_add_value_uint(cq_obj, "io completion queue identifier",
-					   le16_to_cpu(cq->iocqqid));
-		json_object_add_value_uint(cq_obj, "io completion queue head pointer",
-					   le16_to_cpu(cq->iocqhp));
-		json_object_add_value_uint(cq_obj, "io completion queue tail pointer",
-					   le16_to_cpu(cq->iocqtp));
-		json_object_add_value_uint(cq_obj, "io completion queue attributes",
-					   le32_to_cpu(cq->iocqa));
-
-		json_array_add_value_object(iocqs, cq_obj);
-	}
-
-	json_print_object(root, NULL);
-	printf("\n");
-	json_free_object(root);
-}
-
-static void show_controller_state_data(struct nvme_lm_controller_state_data *data, size_t len,
-				       __u32 offset, enum nvme_print_flags flags)
-{
-	if (flags & BINARY)
-		return d_raw((unsigned char *)data, len);
-
-	if (offset) {
-		nvme_show_error("Cannot parse non-zero offset");
-		return;
-	}
-
-	if (flags & JSON)
-		return json_controller_state_data(data, len);
-
-	int human = flags & VERBOSE;
-
-	if (sizeof(struct nvme_lm_controller_state_data_header) <= len) {
-		printf("Header:\n");
-		printf("%-45s: 0x%x\n", "Version (VER)", data->hdr.ver);
-		printf("%-45s: 0x%x\n", "Controller State Attributes (CSATTR)", data->hdr.csattr);
-		if (human)
-			printf("  [0:0] : 0x%x Controller %sSuspended\n",
-				data->hdr.csattr & 1, data->hdr.csattr & 1 ? "" : "NOT ");
-		printf("%-45s: %s\n", "NVMe Controller State Size (NVMECSS)",
-		       uint128_t_to_string(le128_to_cpu(data->hdr.nvmecss)));
-		printf("%-45s: %s\n", "Vendor Specific Size (VSS)",
-		       uint128_t_to_string(le128_to_cpu(data->hdr.vss)));
-
-		len -= sizeof(struct nvme_lm_controller_state_data_header);
-	} else {
-		fprintf(stderr, "WARNING: Header truncated\n");
-		len = 0;
-	}
-
-	if (!len)
-		return;
-
-	if (sizeof(struct nvme_lm_nvme_controller_state_data_header) <= len) {
-		int niosq = data->data.hdr.niosq;
-		int niocq = data->data.hdr.niocq;
-
-		printf("\nNVMe Controller State Data Structure:\n");
-		printf("%-45s: 0x%x\n", "Version (VER)",
-		       le16_to_cpu(data->data.hdr.ver));
-		printf("%-45s: %d\n", "Number of I/O Submission Queues (NIOSQ)",
-		       le16_to_cpu(niosq));
-		printf("%-45s: %d\n", "Number of I/O Completion Queues (NIOCQ)",
-		       le16_to_cpu(niocq));
-
-		len -= sizeof(struct nvme_lm_nvme_controller_state_data_header);
-
-		if (len < niosq * sizeof(struct nvme_lm_io_submission_queue_data)) {
-			fprintf(stderr, "WARNING: I/O Submission Queues truncated\n");
-			niosq = len / sizeof(struct nvme_lm_io_submission_queue_data);
-		}
-
-		for (int i = 0; i < niosq; ++i) {
-			struct nvme_lm_io_submission_queue_data *sq = &(data->data.sqs[i]);
-			__u16 iosqa = le16_to_cpu(sq->iosqa);
-
-			printf("\nNVMe I/O Submission Queue Data [%d]:\n", i);
-			printf("%-45s: 0x%lx\n", "PRP Entry 1 (IOSQPRP1)",
-			       le64_to_cpu(sq->iosqprp1));
-			printf("%-45s: 0x%x\n", "Queue Size (IOSQQSIZE)",
-			       le16_to_cpu(sq->iosqqsize));
-			printf("%-45s: 0x%x\n", "Identifier (IOSQQID)",
-			       le16_to_cpu(sq->iosqqid));
-			printf("%-45s: 0x%x\n", "Completion Queue Identifier (IOSQCQID)",
-			       le16_to_cpu(sq->iosqcqid));
-			printf("%-45s: 0x%x\n", "Attributes (IOSQA)", iosqa);
-			if (human) {
-				printf("  [2:1] : 0x%x Queue Priority (IOSQQPRIO)\n",
-				       NVME_GET(iosqa, LM_IOSQPRIO));
-				printf("  [0:0] : 0x%x Queue %sPhysically Contiguous (IOSQPC)\n",
-				       NVME_GET(iosqa, LM_IOSQPC),
-				       NVME_GET(iosqa, LM_IOSQPC) ? "" : "NOT ");
-			}
-			printf("%-45s: 0x%x\n", "I/O Submission Queue Head Pointer (IOSQHP)",
-			       le16_to_cpu(sq->iosqhp));
-			printf("%-45s: 0x%x\n", "I/O Submission Queue Tail Pointer (IOSQTP)",
-			       le16_to_cpu(sq->iosqtp));
-		}
-
-		len -= niosq * sizeof(struct nvme_lm_io_submission_queue_data);
-
-		if (len < niocq * sizeof(struct nvme_lm_io_completion_queue_data)) {
-			fprintf(stderr, "WARNING: I/O Completion Queues truncated\n");
-			niocq = len / sizeof(struct nvme_lm_io_completion_queue_data);
-		}
-
-		for (int i = 0; i < niocq; ++i) {
-			struct nvme_lm_io_completion_queue_data *cq = &data->data.cqs[niosq + i];
-			__u32 iocqa = le32_to_cpu(cq->iocqa);
-
-			printf("\nNVMe I/O Completion Queue Data [%d]:\n", i);
-			printf("%-45s: 0x%lx\n", "I/O Completion PRP Entry 1 (IOCQPRP1)",
-			       le64_to_cpu(cq->iocqprp1));
-			printf("%-45s: 0x%x\n", "I/O Completion Queue Size (IOCQQSIZE)",
-			       le16_to_cpu(cq->iocqqsize));
-			printf("%-45s: 0x%x\n", "I/O Completion Queue Identifier (IOCQQID)",
-			       le16_to_cpu(cq->iocqqid));
-			printf("%-45s: 0x%x\n", "I/O Completion Queue Head Pointer (IOSQHP)",
-			       le16_to_cpu(cq->iocqhp));
-			printf("%-45s: 0x%x\n", "I/O Completion Queue Tail Pointer (IOSQTP)",
-			       le16_to_cpu(cq->iocqtp));
-			printf("%-45s: 0x%x\n", "I/O Completion Queue Attributes (IOCQA)", iocqa);
-			if (human) {
-				printf("  [31:16] : 0x%x I/O Completion Queue Interrupt Vector "
-				       "(IOCQIV)\n",
-				       NVME_GET(iocqa, LM_IOCQIEN));
-				printf("  [2:2] : 0x%x Slot 0 Phase Tag (S0PT)\n",
-				       NVME_GET(iocqa, LM_S0PT));
-				printf("  [1:1] : 0x%x Interrupts %sEnabled (IOCQIEN)\n",
-				       NVME_GET(iocqa, LM_IOCQIEN),
-				       NVME_GET(iocqa, LM_IOCQIEN) ? "" : "NOT ");
-				printf("  [0:0] : 0x%x Queue %sPhysically Contiguous (IOCQPC)\n",
-				       NVME_GET(iocqa, LM_IOCQPC),
-				       NVME_GET(iocqa, LM_IOCQPC) ? "" : "NOT ");
-			}
-		}
-	} else
-		fprintf(stderr, "WARNING: NVMe Controller State Data Structure truncated\n");
-}
-
 static int lm_migration_recv(int argc, char **argv, struct command *command, struct plugin *plugin)
 {
 	const char *desc = "Migration Receive command is used to obtain information used to manage "
@@ -636,7 +438,7 @@ static int lm_migration_recv(int argc, char **argv, struct command *command, str
 	_cleanup_nvme_dev_ struct nvme_dev *dev = NULL;
 	_cleanup_file_ FILE *fd = NULL;
 	_cleanup_huge_ struct nvme_mem_huge mh = { 0, };
-	enum nvme_print_flags flags;
+	nvme_print_flags_t flags;
 	void *data = NULL;
 	int err = -1;
 
@@ -741,8 +543,8 @@ static int lm_migration_recv(int argc, char **argv, struct command *command, str
 				err = -errno;
 			}
 		} else {
-			show_controller_state_data((struct nvme_lm_controller_state_data *)data,
-						   (cfg.numd + 1) << 2, cfg.offset, flags);
+			lm_show_controller_state_data((struct nvme_lm_controller_state_data *)data,
+						      (cfg.numd + 1) << 2, cfg.offset, flags);
 		}
 	}
 
@@ -809,40 +611,14 @@ static int lm_set_cdq(int argc, char **argv, struct command *command, struct plu
 	return err;
 }
 
-static void json_lm_controller_data_queue(struct nvme_lm_ctrl_data_queue_fid_data *data)
-{
-	struct json_object *root = json_create_object();
-
-	json_object_add_value_uint(root, "head_pointer", le32_to_cpu(data->hp));
-	json_object_add_value_uint(root, "tail_pointer_trigger", le32_to_cpu(data->tpt));
-
-	json_print_object(root, NULL);
-	printf("\n");
-	json_free_object(root);
-}
-
-static void lm_show_controller_data_queue(struct nvme_lm_ctrl_data_queue_fid_data *data,
-					  enum nvme_print_flags flags)
-{
-	if (flags & JSON)
-		return json_lm_controller_data_queue(data);
-
-	if (flags & BINARY)
-		return d_raw((unsigned char *)data,
-			     sizeof(struct nvme_lm_ctrl_data_queue_fid_data));
-
-	printf("Head Pointer: 0x%x\n", le32_to_cpu(data->hp));
-	printf("Tail Pointer Trigger: 0x%x\n", le32_to_cpu(data->tpt));
-}
-
 static int lm_get_cdq(int argc, char **argv, struct command *command, struct plugin *plugin)
 {
 	const char *desc = "This Feature allows a host to retrieve the status of the head pointer "
 			   "of a CDQ and specify the configuration of a CDQ Tail event.";
 	const char *cdqid = "Controller Data Queue ID";
 
 	_cleanup_nvme_dev_ struct nvme_dev *dev = NULL;
-	enum nvme_print_flags flags;
+	nvme_print_flags_t flags;
 	int err = -1;
 
 	struct config {

plugins/lm/lm-print-binary.c

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include "lm-print.h"
+
+static void binary_controller_state_data(struct nvme_lm_controller_state_data *data, size_t len,
+					 __u32 offset)
+{
+	d_raw((unsigned char *)data, len);
+}
+
+static void binary_controller_data_queue(struct nvme_lm_ctrl_data_queue_fid_data *data)
+{
+	d_raw((unsigned char *)data, sizeof(*data));
+}
+
+static struct lm_print_ops binary_print_ops = {
+	.controller_state_data = binary_controller_state_data,
+	.controller_data_queue = binary_controller_data_queue,
+};
+
+struct lm_print_ops *lm_get_binary_print_ops(nvme_print_flags_t flags)
+{
+	binary_print_ops.flags = flags;
+	return &binary_print_ops;
+}