diff mbox series

[iproute2-next] tc: Add JSON output to tc-class

Message ID 20230105142013.243810-2-mtottenh@akamai.com (mailing list archive)
State Superseded
Delegated to: Stephen Hemminger
Headers show
Series [iproute2-next] tc: Add JSON output to tc-class | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Max Tottenham Jan. 5, 2023, 2:20 p.m. UTC 
* Add JSON formatted output to the `tc class show ...` command.
  * Add JSON formatted output for the htb qdisc classes.

Signed-off-by: Max Tottenham <mtottenh@akamai.com>
---
 tc/q_htb.c    | 43 +++++++++++++++++++++++++++----------------
 tc/tc_class.c | 29 ++++++++++++++++++-----------
 2 files changed, 45 insertions(+), 27 deletions(-)

Comments

Stephen Hemminger Jan. 6, 2023, 12:54 a.m. UTC | #1 
On Thu, 5 Jan 2023 09:20:13 -0500
Max Tottenham <mtottenh@akamai.com> wrote:

>   * Add JSON formatted output to the `tc class show ...` command.
>   * Add JSON formatted output for the htb qdisc classes.
> 
> Signed-off-by: Max Tottenham <mtottenh@akamai.com>
> ---

This should target main not next because it does not require
any kernel changes.

> 
> diff --git a/tc/q_htb.c b/tc/q_htb.c
> index b5f95f67..c4e36f27 100644
> --- a/tc/q_htb.c
> +++ b/tc/q_htb.c
> @@ -307,27 +307,36 @@ static int htb_print_opt(struct qdisc_util *qu, FILE *f, struct rtattr *opt)
>  		    RTA_PAYLOAD(tb[TCA_HTB_CEIL64]) >= sizeof(ceil64))
>  			ceil64 = rta_getattr_u64(tb[TCA_HTB_CEIL64]);
>  
> -		tc_print_rate(PRINT_FP, NULL, "rate %s ", rate64);
> +		tc_print_rate(PRINT_ANY, "rate", "rate %s ", rate64);
>  		if (hopt->rate.overhead)
> -			fprintf(f, "overhead %u ", hopt->rate.overhead);
> +			print_int(PRINT_ANY, "overhead", "overhead %u ", hopt->rate.overhead);

Should be print_uint() here.

>  		buffer = tc_calc_xmitsize(rate64, hopt->buffer);
>  
> -		tc_print_rate(PRINT_FP, NULL, "ceil %s ", ceil64);
> +		tc_print_rate(PRINT_ANY, "ceil", "ceil %s ", ceil64);
>  		cbuffer = tc_calc_xmitsize(ceil64, hopt->cbuffer);
>  		linklayer = (hopt->rate.linklayer & TC_LINKLAYER_MASK);
>  		if (linklayer > TC_LINKLAYER_ETHERNET || show_details)
> -			fprintf(f, "linklayer %s ", sprint_linklayer(linklayer, b3));
> +			print_string(PRINT_ANY, "linklayer", "linklayer %s ", sprint_linklayer(linklayer, b3));
>  		if (show_details) {
> -			print_size(PRINT_FP, NULL, "burst %s/", buffer);
> -			fprintf(f, "%u ", 1<<hopt->rate.cell_log);
> -			print_size(PRINT_FP, NULL, "mpu %s ", hopt->rate.mpu);
> -			print_size(PRINT_FP, NULL, "cburst %s/", cbuffer);
> -			fprintf(f, "%u ", 1<<hopt->ceil.cell_log);
> -			print_size(PRINT_FP, NULL, "mpu %s ", hopt->ceil.mpu);
> -			fprintf(f, "level %d ", (int)hopt->level);
> +			open_json_object("details");

The convention in iproute output is not to put extra details into
a sub object.

> +			char burst_buff[64] = {0};
> +			char rate_string[64] = {0};

These convention in iproute is to use SPRINT_BUF() macro and not to do unnecessary
initialization.

> +			sprint_size(buffer, burst_buff);
> +			snprintf(rate_string,  64, "%s/%u", burst_buff, 1<<hopt->rate.cell_log);

For an application using JSON best to make the size and cell_log two different objects.
This would also simplify the code since there would be one less temporary buffer.

> +
> +			print_string(PRINT_ANY, "burst", "burst %s ", rate_string);
> +			print_size(PRINT_ANY, "mpu_rate", "mpu %s ", hopt->rate.mpu);
> +
> +			sprint_size(cbuffer, burst_buff);
> +			snprintf(rate_string,  64, "%s/%u", burst_buff, 1<<hopt->ceil.cell_log);
> +			print_string(PRINT_ANY, "cburst", "cburst %s ", rate_string);
> +
> +			print_size(PRINT_ANY, "mpu_ceil", "mpu %s ", hopt->ceil.mpu);
> +			print_int(PRINT_ANY, "level", "level %d ", (int)hopt->level);
> +			close_json_object();
>  		} else {
> -			print_size(PRINT_FP, NULL, "burst %s ", buffer);
> -			print_size(PRINT_FP, NULL, "cburst %s ", cbuffer);
> +			print_size(PRINT_ANY, "burst", "burst %s ", buffer);
> +			print_size(PRINT_ANY, "cburst", "cburst %s", cbuffer);
>  		}
>  		if (show_raw)
>  			fprintf(f, "buffer [%08x] cbuffer [%08x] ",
> @@ -369,9 +378,11 @@ static int htb_print_xstats(struct qdisc_util *qu, FILE *f, struct rtattr *xstat
>  		return -1;
>  
>  	st = RTA_DATA(xstats);
> -	fprintf(f, " lended: %u borrowed: %u giants: %u\n",
> -		st->lends, st->borrows, st->giants);
> -	fprintf(f, " tokens: %d ctokens: %d\n", st->tokens, st->ctokens);
> +	print_uint(PRINT_ANY, "lended", " lended: %u ", st->lends);
> +	print_uint(PRINT_ANY, "borrowed", "borrowed: %u ", st->borrows);
> +	print_uint(PRINT_ANY, "giants", "giants: %u\n", st->giants);

Don't embed newline in format, instead use print_nl().
Then the command support single line mode.

> +	print_int(PRINT_ANY, "tokens", " tokens: %d ", st->tokens);
> +	print_int(PRINT_ANY, "ctokens", "ctokens: %d\n", st->ctokens);

Another case of print_nl()

>  	return 0;
>  }
>  
> diff --git a/tc/tc_class.c b/tc/tc_class.c
> index 1297d152..7788a667 100644
> --- a/tc/tc_class.c
> +++ b/tc/tc_class.c
> @@ -316,6 +316,8 @@ int print_class(struct nlmsghdr *n, void *arg)
>  		return -1;
>  	}
>  
> +	open_json_object(NULL);
> +
>  	if (show_graph) {
>  		graph_node_add(t->tcm_parent, t->tcm_handle, TCA_RTA(t), len);
>  		return 0;

Graph mode is not json ready.

> @@ -335,7 +337,7 @@ int print_class(struct nlmsghdr *n, void *arg)
>  	}
>  
>  	if (n->nlmsg_type == RTM_DELTCLASS)
> -		fprintf(fp, "deleted ");
> +		print_bool(PRINT_ANY, "deleted", "deleted ", true);

There are two ways of representing a flag: bool or using null.
Since this a presence style flag, the convention is to use print_null().


>  
>  	abuf[0] = 0;
>  	if (t->tcm_handle) {
> @@ -344,22 +346,24 @@ int print_class(struct nlmsghdr *n, void *arg)
>  		else
>  			print_tc_classid(abuf, sizeof(abuf), t->tcm_handle);
>  	}
> -	fprintf(fp, "class %s %s ", rta_getattr_str(tb[TCA_KIND]), abuf);
> +	print_string(PRINT_ANY, "class", "class %s ",  rta_getattr_str(tb[TCA_KIND]));
> +	print_string(PRINT_ANY, "handle", "%s ", abuf);
>  
>  	if (filter_ifindex == 0)
> -		fprintf(fp, "dev %s ", ll_index_to_name(t->tcm_ifindex));
> +		print_string(PRINT_ANY, "dev", "dev %s ", ll_index_to_name(t->tcm_ifindex));

Device name should be printed with color.

>  
>  	if (t->tcm_parent == TC_H_ROOT)
> -		fprintf(fp, "root ");
> +		print_bool(PRINT_ANY, "root", "root ", true);
>  	else {
>  		if (filter_qdisc)
>  			print_tc_classid(abuf, sizeof(abuf), TC_H_MIN(t->tcm_parent));
>  		else
>  			print_tc_classid(abuf, sizeof(abuf), t->tcm_parent);
> -		fprintf(fp, "parent %s ", abuf);
> +		print_string(PRINT_ANY, "parent", "parent %s ", abuf);
>  	}
>  	if (t->tcm_info)
> -		fprintf(fp, "leaf %x: ", t->tcm_info>>16);
> +		print_0xhex(PRINT_ANY, "leaf", "leaf %x", t->tcm_info>>16);
> +
>  	q = get_qdisc_kind(RTA_DATA(tb[TCA_KIND]));
>  	if (tb[TCA_OPTIONS]) {
>  		if (q && q->print_copt)
> @@ -367,19 +371,21 @@ int print_class(struct nlmsghdr *n, void *arg)
>  		else
>  			fprintf(stderr, "[cannot parse class parameters]");
>  	}
> -	fprintf(fp, "\n");
> +	print_string(PRINT_FP, NULL, "\n", NULL);

Use print_nl() instead.

>  	if (show_stats) {
>  		struct rtattr *xstats = NULL;
> -
> +		open_json_object("stats");

>  		if (tb[TCA_STATS] || tb[TCA_STATS2]) {
>  			print_tcstats_attr(fp, tb, " ", &xstats);
> -			fprintf(fp, "\n");
> +			print_string(PRINT_FP, NULL, "\n", NULL);
>  		}
>  		if (q && (xstats || tb[TCA_XSTATS]) && q->print_xstats) {
>  			q->print_xstats(q, fp, xstats ? : tb[TCA_XSTATS]);
> -			fprintf(fp, "\n");
> +			print_string(PRINT_FP, NULL, "\n", NULL);
>  		}
> +		close_json_object();
>  	}
> +	close_json_object();
>  	fflush(fp);
>  	return 0;
>  }
> @@ -450,11 +456,12 @@ static int tc_class_list(int argc, char **argv)
>  		perror("Cannot send dump request");
>  		return 1;
>  	}
> -
> +	new_json_obj(json);
>  	if (rtnl_dump_filter(&rth, print_class, stdout) < 0) {
>  		fprintf(stderr, "Dump terminated\n");
>  		return 1;
>  	}
> +	delete_json_obj();
>  
>  	if (show_graph)
>  		graph_cls_show(stdout, &buf[0], &root_cls_list, 0);
diff mbox series

Patch

diff --git a/tc/q_htb.c b/tc/q_htb.c
index b5f95f67..c4e36f27 100644
--- a/tc/q_htb.c
+++ b/tc/q_htb.c
@@ -307,27 +307,36 @@  static int htb_print_opt(struct qdisc_util *qu, FILE *f, struct rtattr *opt)
 		    RTA_PAYLOAD(tb[TCA_HTB_CEIL64]) >= sizeof(ceil64))
 			ceil64 = rta_getattr_u64(tb[TCA_HTB_CEIL64]);
 
-		tc_print_rate(PRINT_FP, NULL, "rate %s ", rate64);
+		tc_print_rate(PRINT_ANY, "rate", "rate %s ", rate64);
 		if (hopt->rate.overhead)
-			fprintf(f, "overhead %u ", hopt->rate.overhead);
+			print_int(PRINT_ANY, "overhead", "overhead %u ", hopt->rate.overhead);
 		buffer = tc_calc_xmitsize(rate64, hopt->buffer);
 
-		tc_print_rate(PRINT_FP, NULL, "ceil %s ", ceil64);
+		tc_print_rate(PRINT_ANY, "ceil", "ceil %s ", ceil64);
 		cbuffer = tc_calc_xmitsize(ceil64, hopt->cbuffer);
 		linklayer = (hopt->rate.linklayer & TC_LINKLAYER_MASK);
 		if (linklayer > TC_LINKLAYER_ETHERNET || show_details)
-			fprintf(f, "linklayer %s ", sprint_linklayer(linklayer, b3));
+			print_string(PRINT_ANY, "linklayer", "linklayer %s ", sprint_linklayer(linklayer, b3));
 		if (show_details) {
-			print_size(PRINT_FP, NULL, "burst %s/", buffer);
-			fprintf(f, "%u ", 1<<hopt->rate.cell_log);
-			print_size(PRINT_FP, NULL, "mpu %s ", hopt->rate.mpu);
-			print_size(PRINT_FP, NULL, "cburst %s/", cbuffer);
-			fprintf(f, "%u ", 1<<hopt->ceil.cell_log);
-			print_size(PRINT_FP, NULL, "mpu %s ", hopt->ceil.mpu);
-			fprintf(f, "level %d ", (int)hopt->level);
+			open_json_object("details");
+			char burst_buff[64] = {0};
+			char rate_string[64] = {0};
+			sprint_size(buffer, burst_buff);
+			snprintf(rate_string,  64, "%s/%u", burst_buff, 1<<hopt->rate.cell_log);
+
+			print_string(PRINT_ANY, "burst", "burst %s ", rate_string);
+			print_size(PRINT_ANY, "mpu_rate", "mpu %s ", hopt->rate.mpu);
+
+			sprint_size(cbuffer, burst_buff);
+			snprintf(rate_string,  64, "%s/%u", burst_buff, 1<<hopt->ceil.cell_log);
+			print_string(PRINT_ANY, "cburst", "cburst %s ", rate_string);
+
+			print_size(PRINT_ANY, "mpu_ceil", "mpu %s ", hopt->ceil.mpu);
+			print_int(PRINT_ANY, "level", "level %d ", (int)hopt->level);
+			close_json_object();
 		} else {
-			print_size(PRINT_FP, NULL, "burst %s ", buffer);
-			print_size(PRINT_FP, NULL, "cburst %s ", cbuffer);
+			print_size(PRINT_ANY, "burst", "burst %s ", buffer);
+			print_size(PRINT_ANY, "cburst", "cburst %s", cbuffer);
 		}
 		if (show_raw)
 			fprintf(f, "buffer [%08x] cbuffer [%08x] ",
@@ -369,9 +378,11 @@  static int htb_print_xstats(struct qdisc_util *qu, FILE *f, struct rtattr *xstat
 		return -1;
 
 	st = RTA_DATA(xstats);
-	fprintf(f, " lended: %u borrowed: %u giants: %u\n",
-		st->lends, st->borrows, st->giants);
-	fprintf(f, " tokens: %d ctokens: %d\n", st->tokens, st->ctokens);
+	print_uint(PRINT_ANY, "lended", " lended: %u ", st->lends);
+	print_uint(PRINT_ANY, "borrowed", "borrowed: %u ", st->borrows);
+	print_uint(PRINT_ANY, "giants", "giants: %u\n", st->giants);
+	print_int(PRINT_ANY, "tokens", " tokens: %d ", st->tokens);
+	print_int(PRINT_ANY, "ctokens", "ctokens: %d\n", st->ctokens);
 	return 0;
 }
 
diff --git a/tc/tc_class.c b/tc/tc_class.c
index 1297d152..7788a667 100644
--- a/tc/tc_class.c
+++ b/tc/tc_class.c
@@ -316,6 +316,8 @@  int print_class(struct nlmsghdr *n, void *arg)
 		return -1;
 	}
 
+	open_json_object(NULL);
+
 	if (show_graph) {
 		graph_node_add(t->tcm_parent, t->tcm_handle, TCA_RTA(t), len);
 		return 0;
@@ -335,7 +337,7 @@  int print_class(struct nlmsghdr *n, void *arg)
 	}
 
 	if (n->nlmsg_type == RTM_DELTCLASS)
-		fprintf(fp, "deleted ");
+		print_bool(PRINT_ANY, "deleted", "deleted ", true);
 
 	abuf[0] = 0;
 	if (t->tcm_handle) {
@@ -344,22 +346,24 @@  int print_class(struct nlmsghdr *n, void *arg)
 		else
 			print_tc_classid(abuf, sizeof(abuf), t->tcm_handle);
 	}
-	fprintf(fp, "class %s %s ", rta_getattr_str(tb[TCA_KIND]), abuf);
+	print_string(PRINT_ANY, "class", "class %s ",  rta_getattr_str(tb[TCA_KIND]));
+	print_string(PRINT_ANY, "handle", "%s ", abuf);
 
 	if (filter_ifindex == 0)
-		fprintf(fp, "dev %s ", ll_index_to_name(t->tcm_ifindex));
+		print_string(PRINT_ANY, "dev", "dev %s ", ll_index_to_name(t->tcm_ifindex));
 
 	if (t->tcm_parent == TC_H_ROOT)
-		fprintf(fp, "root ");
+		print_bool(PRINT_ANY, "root", "root ", true);
 	else {
 		if (filter_qdisc)
 			print_tc_classid(abuf, sizeof(abuf), TC_H_MIN(t->tcm_parent));
 		else
 			print_tc_classid(abuf, sizeof(abuf), t->tcm_parent);
-		fprintf(fp, "parent %s ", abuf);
+		print_string(PRINT_ANY, "parent", "parent %s ", abuf);
 	}
 	if (t->tcm_info)
-		fprintf(fp, "leaf %x: ", t->tcm_info>>16);
+		print_0xhex(PRINT_ANY, "leaf", "leaf %x", t->tcm_info>>16);
+
 	q = get_qdisc_kind(RTA_DATA(tb[TCA_KIND]));
 	if (tb[TCA_OPTIONS]) {
 		if (q && q->print_copt)
@@ -367,19 +371,21 @@  int print_class(struct nlmsghdr *n, void *arg)
 		else
 			fprintf(stderr, "[cannot parse class parameters]");
 	}
-	fprintf(fp, "\n");
+	print_string(PRINT_FP, NULL, "\n", NULL);
 	if (show_stats) {
 		struct rtattr *xstats = NULL;
-
+		open_json_object("stats");
 		if (tb[TCA_STATS] || tb[TCA_STATS2]) {
 			print_tcstats_attr(fp, tb, " ", &xstats);
-			fprintf(fp, "\n");
+			print_string(PRINT_FP, NULL, "\n", NULL);
 		}
 		if (q && (xstats || tb[TCA_XSTATS]) && q->print_xstats) {
 			q->print_xstats(q, fp, xstats ? : tb[TCA_XSTATS]);
-			fprintf(fp, "\n");
+			print_string(PRINT_FP, NULL, "\n", NULL);
 		}
+		close_json_object();
 	}
+	close_json_object();
 	fflush(fp);
 	return 0;
 }
@@ -450,11 +456,12 @@  static int tc_class_list(int argc, char **argv)
 		perror("Cannot send dump request");
 		return 1;
 	}
-
+	new_json_obj(json);
 	if (rtnl_dump_filter(&rth, print_class, stdout) < 0) {
 		fprintf(stderr, "Dump terminated\n");
 		return 1;
 	}
+	delete_json_obj();
 
 	if (show_graph)
 		graph_cls_show(stdout, &buf[0], &root_cls_list, 0);