[PATCH v8 7/7] test-pmd: add a JSON packet output

[Stephen Hemminger <stephen@networkplumber.org>]

When doing automated testing it is useful to show packet meta
data in JSON.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 app/test-pmd/cmdline.c                      |   6 +-
 app/test-pmd/config.c                       |   3 +
 app/test-pmd/testpmd.h                      |   1 +
 app/test-pmd/util.c                         | 142 ++++++++++++++++++++
 doc/guides/testpmd_app_ug/testpmd_funcs.rst |   7 +-
 5 files changed, 153 insertions(+), 6 deletions(-)

diff --git a/app/test-pmd/cmdline.c b/app/test-pmd/cmdline.c
index 72be5a0c06..b06abda3fe 100644
--- a/app/test-pmd/cmdline.c
+++ b/app/test-pmd/cmdline.c
@@ -305,7 +305,7 @@ static void cmd_help_long_parsed(void *parsed_result,
 			"set output (filename)\n"
 			"    Set the packet debug log file\n\n"
 
-			"set format (dissect|hex|verbose)\n"
+			"set format (dissect|hex|json|verbose)\n"
 			"    Set the format of packet log\\n"
 
 			"set log global|(type) (level)\n"
@@ -3918,12 +3918,12 @@ static cmdline_parse_token_string_t cmd_set_format_set =
 static cmdline_parse_token_string_t cmd_set_format_output =
 	TOKEN_STRING_INITIALIZER(struct cmd_set_format_result, format, "format");
 static cmdline_parse_token_string_t cmd_set_format_value =
-	TOKEN_STRING_INITIALIZER(struct cmd_set_format_result, value, "dissect#hex#verbose");
+	TOKEN_STRING_INITIALIZER(struct cmd_set_format_result, value, "dissect#hex#json@verbose");
 
 static cmdline_parse_inst_t cmd_set_format = {
 	.f = cmd_set_format_parsed,
 	.data = NULL,
-	.help_str = "set format dissect|hex|verbose",
+	.help_str = "set format dissect|hex|json|verbose",
 	.tokens = {
 		(void *)&cmd_set_format_set,
 		(void *)&cmd_set_format_output,
diff --git a/app/test-pmd/config.c b/app/test-pmd/config.c
index c9b3eb7c2b..71bee7e1c2 100644
--- a/app/test-pmd/config.c
+++ b/app/test-pmd/config.c
@@ -6275,6 +6275,9 @@ set_output_format(const char *mode)
 		[OUTPUT_MODE_VERBOSE] = "verbose",
 		[OUTPUT_MODE_HEX]     = "hex",
 		[OUTPUT_MODE_DISSECT] = "dissect",
+#ifdef RTE_HAS_JANSSON
+		[OUTPUT_MODE_JSON]    = "json",
+#endif
 	};
 
 	printf("Change output format from %s to %s\n", formats[output_format], mode);
diff --git a/app/test-pmd/testpmd.h b/app/test-pmd/testpmd.h
index 66b0317b61..f8bf9b7126 100644
--- a/app/test-pmd/testpmd.h
+++ b/app/test-pmd/testpmd.h
@@ -492,6 +492,7 @@ enum output_mode {
 	OUTPUT_MODE_VERBOSE = 0,
 	OUTPUT_MODE_HEX,
 	OUTPUT_MODE_DISSECT,
+	OUTPUT_MODE_JSON,
 };
 
 extern uint8_t xstats_hide_zero; /**< Hide zero values for xstats display */
diff --git a/app/test-pmd/util.c b/app/test-pmd/util.c
index 392c444021..98a77bbc32 100644
--- a/app/test-pmd/util.c
+++ b/app/test-pmd/util.c
@@ -299,6 +299,143 @@ dump_pkt_verbose(FILE *outf, uint16_t port_id, uint16_t queue,
 	}
 }
 
+#ifdef RTE_HAS_JANSSON
+
+/* Encode offload flags as JSON array */
+static json_t *
+encode_ol_flags(uint64_t flags, int is_rx)
+{
+	json_t *ol_array = json_array();
+	unsigned int i;
+
+	if (is_rx)
+		flags &= ~RTE_MBUF_F_TX_OFFLOAD_MASK;
+	else
+		flags &= RTE_MBUF_F_TX_OFFLOAD_MASK;
+
+	for (i = 0; i < 64; i++) {
+		uint64_t mask = (uint64_t)1 << i;
+		const char *name;
+
+		if (!(mask & flags))
+			continue;
+
+		if (is_rx)
+			name = rte_get_rx_ol_flag_name(mask);
+		else
+			name = rte_get_tx_ol_flag_name(mask);
+		json_array_append_new(ol_array, json_string(name));
+	}
+	return ol_array;
+}
+
+/* Encode packet type fields as JSON object */
+static json_t *
+encode_ptype(uint32_t ptype)
+{
+	if ((ptype & RTE_PTYPE_ALL_MASK) == RTE_PTYPE_UNKNOWN)
+		return json_string("UNKNOWN");
+
+	json_t *ptypes = json_array();
+	if (ptype & RTE_PTYPE_L2_MASK)
+		json_array_append(ptypes, json_string(rte_get_ptype_l2_name(ptype)));
+	if (ptype & RTE_PTYPE_L3_MASK)
+		json_array_append(ptypes, json_string(rte_get_ptype_l3_name(ptype)));
+	if (ptype & RTE_PTYPE_L4_MASK)
+		json_array_append(ptypes, json_string(rte_get_ptype_l4_name(ptype)));
+	if (ptype & RTE_PTYPE_TUNNEL_MASK)
+		json_array_append(ptypes, json_string(rte_get_ptype_tunnel_name(ptype)));
+	if (ptype & RTE_PTYPE_INNER_L2_MASK)
+		json_array_append(ptypes, json_string(rte_get_ptype_inner_l2_name(ptype)));
+	if (ptype & RTE_PTYPE_INNER_L3_MASK)
+		json_array_append(ptypes, json_string(rte_get_ptype_inner_l3_name(ptype)));
+	if (ptype & RTE_PTYPE_INNER_L4_MASK)
+		json_array_append(ptypes, json_string(rte_get_ptype_inner_l4_name(ptype)));
+
+	return ptypes;
+}
+
+static void
+dump_pkt_json(FILE *outf, uint16_t port_id, uint16_t queue,
+	      struct rte_mbuf *pkts[], uint16_t nb_pkts, int is_rx)
+{
+	char buf[256];
+
+	for (uint16_t i = 0; i < nb_pkts; i++) {
+		const struct rte_mbuf *mb = pkts[i];
+		json_t *jobj = json_object();
+		const struct rte_ether_hdr *eth_hdr;
+		struct rte_ether_hdr _eth_hdr;
+		uint16_t eth_type;
+		uint64_t ol_flags = mb->ol_flags;
+		const char *reason = NULL;
+
+		json_object_set_new(jobj, "port", json_integer(port_id));
+		json_object_set_new(jobj, "queue", json_integer(queue));
+		json_object_set_new(jobj, "direction", json_string(is_rx ? "receive" : "send"));
+
+		if (rte_mbuf_check(mb, 1, &reason) < 0)
+			json_object_set_new(jobj, "invalid", json_string(reason));
+
+		eth_hdr = rte_pktmbuf_read(mb, 0, sizeof(_eth_hdr), &_eth_hdr);
+		eth_type = RTE_BE_TO_CPU_16(eth_hdr->ether_type);
+
+		rte_ether_format_addr(buf, sizeof(buf), &eth_hdr->dst_addr);
+		json_object_set_new(jobj, "dst", json_string(buf));
+		rte_ether_format_addr(buf, sizeof(buf), &eth_hdr->src_addr);
+		json_object_set_new(jobj, "src", json_string(buf));
+
+		snprintf(buf, sizeof(buf), "0x%04x", eth_type);
+		json_object_set_new(jobj, "type", json_string(buf));
+
+		json_object_set_new(jobj, "length", json_integer(mb->pkt_len));
+		json_object_set_new(jobj, "nb_segs", json_integer(mb->nb_segs));
+
+		if (ol_flags & RTE_MBUF_F_RX_RSS_HASH)
+			json_object_set_new(jobj, "rss_hash", json_integer(mb->hash.rss));
+
+		if (is_timestamp_enabled(mb))
+			json_object_set_new(jobj, "timestamp", json_integer(get_timestamp(mb)));
+
+		if ((is_rx && (ol_flags & RTE_MBUF_F_RX_QINQ) != 0) ||
+		    (!is_rx && (ol_flags & RTE_MBUF_F_TX_QINQ) != 0)) {
+			json_object_set_new(jobj, "vlan_tci", json_integer(mb->vlan_tci));
+			json_object_set_new(jobj, "vlan_outer_tci", json_integer(mb->vlan_tci_outer));
+		} else if ((is_rx && (ol_flags & RTE_MBUF_F_RX_VLAN) != 0) ||
+			   (!is_rx && (ol_flags & RTE_MBUF_F_TX_VLAN) != 0)) {
+			json_object_set_new(jobj, "vlan_tci", json_integer(mb->vlan_tci));
+		}
+
+		if (mb->packet_type)
+			json_object_set_new(jobj, "hw_ptype", encode_ptype(mb->packet_type));
+
+		struct rte_net_hdr_lens hdr_lens;
+		uint32_t sw_packet_type = rte_net_get_ptype(mb, &hdr_lens, RTE_PTYPE_ALL_MASK);
+		json_object_set_new(jobj, "sw_ptype", encode_ptype(sw_packet_type));
+
+		if (sw_packet_type & RTE_PTYPE_L2_MASK)
+			json_object_set_new(jobj, "l2_len", json_integer(hdr_lens.l2_len));
+		if (sw_packet_type & RTE_PTYPE_L3_MASK)
+			json_object_set_new(jobj, "l3_len", json_integer(hdr_lens.l3_len));
+		if (sw_packet_type & RTE_PTYPE_L4_MASK)
+			json_object_set_new(jobj, "l4_len", json_integer(hdr_lens.l4_len));
+		if (sw_packet_type & RTE_PTYPE_TUNNEL_MASK)
+			json_object_set_new(jobj, "tunnel_len", json_integer(hdr_lens.tunnel_len));
+		if (sw_packet_type & RTE_PTYPE_INNER_L2_MASK)
+			json_object_set_new(jobj, "inner_l2_len", json_integer(hdr_lens.inner_l2_len));
+		if (sw_packet_type & RTE_PTYPE_INNER_L3_MASK)
+			json_object_set_new(jobj, "inner_l3_len", json_integer(hdr_lens.inner_l3_len));
+		if (sw_packet_type & RTE_PTYPE_INNER_L4_MASK)
+			json_object_set_new(jobj, "inner_l4_len", json_integer(hdr_lens.inner_l4_len));
+
+		json_object_set_new(jobj, "ol_flags", encode_ol_flags(mb->ol_flags, is_rx));
+
+		json_dumpf(jobj, outf, JSON_INDENT(4));
+		json_decref(jobj);
+	}
+}
+#endif
+
 static void
 dump_pkt_hex(FILE *outf, struct rte_mbuf *pkts[], uint16_t nb_pkts)
 {
@@ -362,6 +499,11 @@ dump_pkt_burst(uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[],
 	case OUTPUT_MODE_DISSECT:
 		dump_pkt_brief(outf, port_id, queue, pkts, nb_pkts, is_rx);
 		break;
+#ifdef RTE_HAS_JANSSON
+	case OUTPUT_MODE_JSON:
+		dump_pkt_json(outf, port_id, queue, pkts, nb_pkts, is_rx);
+		break;
+#endif
 	default:
 		return;
 	}
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 705b3dc3d5..bb62960582 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -677,13 +677,14 @@ set format
 
 Chose the output format for packet debug log::
 
-   testpmd> set format dissect|hex|verbose
+   testpmd> set format dissect|hex|json|verbose
 
 Available formats are:
 
-* ``verbose`` print the packet meta data information
-* ``hex`` print the mbuf flags and data in hex
 * ``dissect`` print the packet in tshark summary format
+* ``hex`` print the mbuf flags and data in hex
+* ``json`` print the packet meta data in json
+* ``verbose`` print the packet meta data information
 
 
 set verbose
-- 
2.45.2