Skip to contentSkip to conversation

police: Add support for json output

PATCH Applied Roi Dayan 6 participants 17 messages Jun 7, 2021 – Jul 12, 2021

Subsystems (2)
lore
Share & tools
lore

Roi Dayan

author
#0 lore raw

PATCH v4 1/1 police: Add support for json output

Change to use the print wrappers instead of fprintf().

This is example output of the options part before this commit:

        "options": {
            "handle": 1,
            "in_hw": true,
            "actions": [ {
                    "order": 1 police 0x2 ,
                    "control_action": {
                        "type": "drop"
                    },
                    "control_action": {
                        "type": "continue"
                    }overhead 0b linklayer unspec
        ref 1 bind 1
,
                    "used_hw_stats": [ "delayed" ]
                } ]
        }

This is the output of the same dump with this commit:

        "options": {
            "handle": 1,
            "in_hw": true,
            "actions": [ {
                    "order": 1,
                    "kind": "police",
                    "index": 2,
                    "control_action": {
                        "type": "drop"
                    },
                    "control_action": {
                        "type": "continue"
                    },
                    "overhead": 0,
                    "linklayer": "unspec",
                    "ref": 1,
                    "bind": 1,
                    "used_hw_stats": [ "delayed" ]
                } ]
        }

---

Notes:
v2
- fix json output to match correctly the other actions i.e. output the action name in key 'kind' and unsigned for the index

v3
- print errors to stderr.
- return -1 on null key.

v4
- removed left over debug that was forgotten. sorry for that.

 tc/m_police.c | 30 +++++++++++++++++-------------
 1 file changed, 17 insertions(+), 13 deletions(-)
tc/m_police.c +17 -13
index 9ef0e40b861b..2594c08979e0 100644
@@ -278,18 +278,19 @@ static int print_police(struct action_util *a, FILE *f, struct rtattr *arg)
 	__u64 rate64, prate64;
 	__u64 pps64, ppsburst64;
 
+	print_string(PRINT_ANY, "kind", "%s", "police");
 	if (arg == NULL)
 		return 0;
 
 	parse_rtattr_nested(tb, TCA_POLICE_MAX, arg);
 
 	if (tb[TCA_POLICE_TBF] == NULL) {
-		fprintf(f, "[NULL police tbf]");
-		return 0;
+		fprintf(stderr, "[NULL police tbf]");
+		return -1;
 	}
 #ifndef STOOPID_8BYTE
 	if (RTA_PAYLOAD(tb[TCA_POLICE_TBF])  < sizeof(*p)) {
-		fprintf(f, "[truncated police tbf]");
+		fprintf(stderr, "[truncated police tbf]");
 		return -1;
 	}
 #endif
@@ -300,13 +301,13 @@ static int print_police(struct action_util *a, FILE *f, struct rtattr *arg)
 	    RTA_PAYLOAD(tb[TCA_POLICE_RATE64]) >= sizeof(rate64))
 		rate64 = rta_getattr_u64(tb[TCA_POLICE_RATE64]);
 
-	fprintf(f, " police 0x%x ", p->index);
+	print_uint(PRINT_ANY, "index", "\t index %u ", p->index);
 	tc_print_rate(PRINT_FP, NULL, "rate %s ", rate64);
 	buffer = tc_calc_xmitsize(rate64, p->burst);
 	print_size(PRINT_FP, NULL, "burst %s ", buffer);
 	print_size(PRINT_FP, NULL, "mtu %s ", p->mtu);
 	if (show_raw)
-		fprintf(f, "[%08x] ", p->burst);
+		print_hex(PRINT_FP, NULL, "[%08x] ", p->burst);
 
 	prate64 = p->peakrate.rate;
 	if (tb[TCA_POLICE_PEAKRATE64] &&
@@ -327,8 +328,8 @@ static int print_police(struct action_util *a, FILE *f, struct rtattr *arg)
 		pps64 = rta_getattr_u64(tb[TCA_POLICE_PKTRATE64]);
 		ppsburst64 = rta_getattr_u64(tb[TCA_POLICE_PKTBURST64]);
 		ppsburst64 = tc_calc_xmitsize(pps64, ppsburst64);
-		fprintf(f, "pkts_rate %llu ", pps64);
-		fprintf(f, "pkts_burst %llu ", ppsburst64);
+		print_u64(PRINT_ANY, "pkts_rate", "pkts_rate %llu ", pps64);
+		print_u64(PRINT_ANY, "pkts_burst", "pkts_burst %llu ", ppsburst64);
 	}
 
 	print_action_control(f, "action ", p->action, "");
@@ -337,14 +338,17 @@ static int print_police(struct action_util *a, FILE *f, struct rtattr *arg)
 		__u32 action = rta_getattr_u32(tb[TCA_POLICE_RESULT]);
 
 		print_action_control(f, "/", action, " ");
-	} else
-		fprintf(f, " ");
+	} else {
+		print_string(PRINT_FP, NULL, " ", NULL);
+	}
 
-	fprintf(f, "overhead %ub ", p->rate.overhead);
+	print_uint(PRINT_ANY, "overhead", "overhead %u ", p->rate.overhead);
 	linklayer = (p->rate.linklayer & TC_LINKLAYER_MASK);
 	if (linklayer > TC_LINKLAYER_ETHERNET || show_details)
-		fprintf(f, "linklayer %s ", sprint_linklayer(linklayer, b2));
-	fprintf(f, "\n\tref %d bind %d", p->refcnt, p->bindcnt);
+		print_string(PRINT_ANY, "linklayer", "linklayer %s ",
+			     sprint_linklayer(linklayer, b2));
+	print_int(PRINT_ANY, "ref", "ref %d ", p->refcnt);
+	print_int(PRINT_ANY, "bind", "bind %d ", p->bindcnt);
 	if (show_stats) {
 		if (tb[TCA_POLICE_TM]) {
 			struct tcf_t *tm = RTA_DATA(tb[TCA_POLICE_TM]);
@@ -352,7 +356,7 @@ static int print_police(struct action_util *a, FILE *f, struct rtattr *arg)
 			print_tm(f, tm);
 		}
 	}
-	fprintf(f, "\n");
+	print_nl();
 
 
 	return 0;
Signature · 1 line
2.21.0
Applied
#1 lore raw
Quoted 57 lines · Roi Dayan

Change to use the print wrappers instead of fprintf().

This is example output of the options part before this commit:

        "options": {
            "handle": 1,
            "in_hw": true,
            "actions": [ {
                    "order": 1 police 0x2 ,
                    "control_action": {
                        "type": "drop"
                    },
                    "control_action": {
                        "type": "continue"
                    }overhead 0b linklayer unspec
        ref 1 bind 1
,
                    "used_hw_stats": [ "delayed" ]
                } ]
        }

This is the output of the same dump with this commit:

        "options": {
            "handle": 1,
            "in_hw": true,
            "actions": [ {
                    "order": 1,
                    "kind": "police",
                    "index": 2,
                    "control_action": {
                        "type": "drop"
                    },
                    "control_action": {
                        "type": "continue"
                    },
                    "overhead": 0,
                    "linklayer": "unspec",
                    "ref": 1,
                    "bind": 1,
                    "used_hw_stats": [ "delayed" ]
                } ]
        }

---

Notes:
v2
- fix json output to match correctly the other actions i.e. output the action name in key 'kind' and unsigned for the index

v3
- print errors to stderr.
- return -1 on null key.

Quoted 6 lines

v4
- removed left over debug that was forgotten. sorry for that.

 tc/m_police.c | 30 +++++++++++++++++-------------
 1 file changed, 17 insertions(+), 13 deletions(-)

applied to iproute2-next

#2 lore raw
In reply to Roi Dayan
Quoted 47 lines · Roi Dayan

Change to use the print wrappers instead of fprintf().

This is example output of the options part before this commit:

        "options": {
            "handle": 1,
            "in_hw": true,
            "actions": [ {
                    "order": 1 police 0x2 ,
                    "control_action": {
                        "type": "drop"
                    },
                    "control_action": {
                        "type": "continue"
                    }overhead 0b linklayer unspec
        ref 1 bind 1
,
                    "used_hw_stats": [ "delayed" ]
                } ]
        }

This is the output of the same dump with this commit:

        "options": {
            "handle": 1,
            "in_hw": true,
            "actions": [ {
                    "order": 1,
                    "kind": "police",
                    "index": 2,
                    "control_action": {
                        "type": "drop"
                    },
                    "control_action": {
                        "type": "continue"
                    },
                    "overhead": 0,
                    "linklayer": "unspec",
                    "ref": 1,
                    "bind": 1,
                    "used_hw_stats": [ "delayed" ]
                } ]
        }

---

[...]

tc/m_police.c static int print_police(struct action_util *a, FILE *f, struct rtattr *arg) · line 304

Quoted 7 lines
tc/m_police.c +1 -1
@@ -300,13 +301,13 @@ static int print_police(struct action_util *a, FILE *f, struct rtattr *arg)
 	    RTA_PAYLOAD(tb[TCA_POLICE_RATE64]) >= sizeof(rate64))
 		rate64 = rta_getattr_u64(tb[TCA_POLICE_RATE64]);
 
-	fprintf(f, " police 0x%x ", p->index);
+	print_uint(PRINT_ANY, "index", "\t index %u ", p->index);

Hi everyone,

This update break all policy checking in kernel tc selftest actions/police.json. As the new output would like

total acts 1

action order 0: police index 1 rate 1Kbit burst 10Kb mtu 2Kb action reclassify overhead 0 ref 1 bind 0

And the current test checks like

	"matchPattern": "action order [0-9]*:  police 0x1 rate 1Kbit burst 10Kb"

I plan to update the kselftest to mach the new output. But I have a question. Why need we add a "\t" before index output? Is it needed or could be removed?

Thanks
Hangbin

#12 lore raw
In reply to Roi Dayan

tc/m_police.c static int print_police(struct action_util *a, FILE *f, struct rtattr *arg) · line 304

Quoted 2 lines · On Mon, 7 Jun 2021 09:44:08 +0300 Roi Dayan <[email protected]> wrote:
tc/m_police.c +1 -1
-	fprintf(f, " police 0x%x ", p->index);
+	print_uint(PRINT_ANY, "index", "\t index %u ", p->index);

Why did output format have to change here? Why not:

	print_hex(PRINT_ANY, "police", " police %#x", p->index);
#16 lore raw
In reply to Roi Dayan

tc/m_police.c static int print_police(struct action_util *a, FILE *f, struct rtattr *arg) · line 352

Quoted 6 lines · On Mon, 7 Jun 2021 09:44:08 +0300 Roi Dayan <[email protected]> wrote:
tc/m_police.c +4 -1
-	fprintf(f, "\n\tref %d bind %d", p->refcnt, p->bindcnt);
+		print_string(PRINT_ANY, "linklayer", "linklayer %s ",
+			     sprint_linklayer(linklayer, b2));
+	print_int(PRINT_ANY, "ref", "ref %d ", p->refcnt);
+	print_int(PRINT_ANY, "bind", "bind %d ", p->bindcnt);
 	if (show_stats) {

This should add newline like original by using print_nl()

#13 lore raw
In reply to Stephen Hemminger
Quoted 10 lines · Stephen Hemminger

tc/m_police.c static int print_police(struct action_util *a, FILE *f, struct rtattr *arg) · line 304

Quoted 2 lines · On Mon, 7 Jun 2021 09:44:08 +0300 Roi Dayan <[email protected]> wrote:
tc/m_police.c +1 -1
-	fprintf(f, " police 0x%x ", p->index);
+	print_uint(PRINT_ANY, "index", "\t index %u ", p->index);

Why did output format have to change here? Why not:

	print_hex(PRINT_ANY, "police", " police %#x", p->index);

it should not have. I caught it in the first version in a review comment; missed it in v4 that was applied.

#3 lore raw
In reply to Hangbin Liu
Quoted 6 lines · Hangbin Liu
Quoted 5 lines · Roi Dayan

Change to use the print wrappers instead of fprintf().

---

hello Hangbin,

[...]

Quoted 5 lines
Quoted 5 lines
tc/m_police.c +0 -0
@@ -300,13 +301,13 @@ static int print_police(struct action_util *a, FILE *f, struct rtattr *arg)
 	    RTA_PAYLOAD(tb[TCA_POLICE_RATE64]) >= sizeof(rate64))
 		rate64 = rta_getattr_u64(tb[TCA_POLICE_RATE64]);
 
Quoted 7 lines

tc/m_police.c static int print_police(struct action_util *a, FILE *f, struct rtattr *arg) · line 304

Quoted 2 lines
tc/m_police.c +1 -1
-	fprintf(f, " police 0x%x ", p->index);
+	print_uint(PRINT_ANY, "index", "\t index %u ", p->index);

Hi everyone,

This update break all policy checking in kernel tc selftest actions/police.json. As the new output would like

thanks for catching this!

Quoted 10 lines

total acts 1

action order 0: police index 1 rate 1Kbit burst 10Kb mtu 2Kb action reclassify overhead 0 ref 1 bind 0

And the current test checks like

	"matchPattern": "action order [0-9]*:  police 0x1 rate 1Kbit burst 10Kb"

I plan to update the kselftest to mach the new output.

my 2 cents:

what about using PRINT_FP / PRINT_JSON, so we fix the JSON output only to show "index", and preserve the human-readable printout iproute and kselftests? besides avoiding failures because of mismatching kselftests / iproute, this would preserve functionality of scripts that configure / dump the "police" action. WDYT?

thanks,

Signature · 1 line
davide
author
#14 lore raw
In reply to David Ahern
Quoted 9 lines · David Ahern
Quoted 8 lines · Stephen Hemminger

tc/m_police.c static int print_police(struct action_util *a, FILE *f, struct rtattr *arg) · line 304

Quoted 2 lines · On Mon, 7 Jun 2021 09:44:08 +0300 Roi Dayan <[email protected]> wrote:
tc/m_police.c +1 -1
-	fprintf(f, " police 0x%x ", p->index);
+	print_uint(PRINT_ANY, "index", "\t index %u ", p->index);

Why did output format have to change here? Why not:

Quoted 6 lines
Quoted 2 lines
	print_hex(PRINT_ANY, "police", " police %#x", p->index);

it should not have. I caught it in the first version in a review comment; missed it in v4 that was applied.

Hi,

I replied to your review in v0 that I wanted to match all the other actions output which output as unsigned.
Since I didn't get another reply I thought its ok to continue and sent another version which other changes that were required.

author
#15 lore raw
Quoted 19 lines · Roi Dayan
Quoted 7 lines · David Ahern
Quoted 6 lines · Stephen Hemminger
Quoted 2 lines · On Mon, 7 Jun 2021 09:44:08 +0300 Roi Dayan <[email protected]> wrote:

-    fprintf(f, " police 0x%x ", p->index);
+    print_uint(PRINT_ANY, "index", "\t index %u ", p->index);

Quoted 8 lines
Quoted 4 lines

Why did output format have to change here? Why not:

    print_hex(PRINT_ANY, "police", " police %#x", p->index);

it should not have. I caught it in the first version in a review comment; missed it in v4 that was applied.

Quoted 8 lines

Hi,

I replied to your review in v0 that I wanted to match all the other actions output which output as unsigned.
Since I didn't get another reply I thought its ok to continue and sent another version which other changes that were required.

beside the unsigned the json output in all other actions use "index" as far as I notice.
the action name, e.g. "police", being printed under "kind" also to match the other actions.
So I wanted the json output for police to match with same keys as the other actions. at least the keys "kind" and "index" which all have and not each action use different key.

#4 lore raw
In reply to Davide Caratti
Quoted 6 lines · Davide Caratti

my 2 cents:

what about using PRINT_FP / PRINT_JSON, so we fix the JSON output only to show "index", and preserve the human-readable printout iproute and kselftests? besides avoiding failures because of mismatching kselftests / iproute, this would preserve functionality of scripts that configure / dump the "police" action. WDYT?

+1

author
#5 lore raw
Quoted 10 lines · Hangbin Liu
Quoted 6 lines · Davide Caratti

my 2 cents:

what about using PRINT_FP / PRINT_JSON, so we fix the JSON output only to show "index", and preserve the human-readable printout iproute and kselftests? besides avoiding failures because of mismatching kselftests / iproute, this would preserve functionality of scripts that configure / dump the "police" action. WDYT?

+1

why not fix the kselftest to look for the correct output?

all actions output unsigned as the index.
though I did find an issue with the fp output that you pasted that I missed.

action order 0: police index 1 rate 1Kbit burst 10Kb mtu 2Kb
action reclassify overhead 0 ref 1 bind 0

You asked about the \t before index and actually there is a missing print_nl() call before printing index and the rest as in the other actions.

then the match should be something like this

	"matchPattern": "action order [0-9]*: police.*index 0x1 rate 1Kbit 

burst 10Kb"

author
#6 lore raw
Quoted 26 lines · Roi Dayan
Quoted 10 lines · Hangbin Liu
Quoted 6 lines · Davide Caratti

my 2 cents:

what about using PRINT_FP / PRINT_JSON, so we fix the JSON output only to show "index", and preserve the human-readable printout iproute and kselftests? besides avoiding failures because of mismatching kselftests / iproute, this would preserve functionality of scripts that configure / dump the "police" action. WDYT?

+1

why not fix the kselftest to look for the correct output?

all actions output unsigned as the index.
though I did find an issue with the fp output that you pasted that I missed.

        action order 0: police   index 1 rate 1Kbit burst 10Kb mtu 2Kb
action reclassify overhead 0 ref 1 bind 0

Quoted 8 lines

You asked about the \t before index and actually there is a missing print_nl() call before printing index and the rest as in the other actions.

then the match should be something like this

    "matchPattern": "action order [0-9]*: police.*index 0x1 rate 1Kbit
burst 10Kb"

actually its

"matchPattern": "action order [0-9]*: police.*index 1 rate 1Kbit
burst 10Kb"

also i found some selftest fail for "overhead" matching as i used print_uint() instead of print_size().

let me send a fix for this with fix for the kselftest of police.json i think its better to have the consistent output of all actions instead of police using hex for the instance number.

#7 lore raw
In reply to Roi Dayan
Quoted 14 lines · Roi Dayan
Quoted 11 lines · Hangbin Liu
Quoted 9 lines · Davide Caratti

my 2 cents:

what about using PRINT_FP / PRINT_JSON, so we fix the JSON output only to show "index", and
preserve the human-readable printout iproute and kselftests? besides avoiding failures because
of mismatching kselftests / iproute, this would preserve functionality of scripts that
configure / dump the "police" action. WDYT?

Quoted 5 lines
Quoted 2 lines

+1

why not fix the kselftest to look for the correct output?

That is but 1 user. The general rule is that you do not change the output like you did.

author
#8 lore raw
Quoted 15 lines · David Ahern
Quoted 14 lines · Roi Dayan
Quoted 11 lines · Hangbin Liu
Quoted 9 lines · Davide Caratti

my 2 cents:

what about using PRINT_FP / PRINT_JSON, so we fix the JSON output only to show "index", and
preserve the human-readable printout iproute and kselftests? besides avoiding failures because
of mismatching kselftests / iproute, this would preserve functionality of scripts that
configure / dump the "police" action. WDYT?

Quoted 9 lines
Quoted 5 lines
Quoted 2 lines

+1

why not fix the kselftest to look for the correct output?

That is but 1 user. The general rule is that you do not change the output like you did.

but the output was "broken" and not consistent with all actions. we are not fixing this kind of thing?
so to continue with the suggestion to use print_fp and keep police action output broken and print_json for the json output? just to be sure before submitting change back to old output for fp.

...

        action order 1:  police 0x1 rate 1Mbit burst 20Kb mtu 2Kb 

action reclassify overhead 0b

- print_string(PRINT_ANY, "kind", "%s", "police");
+ print_string(PRINT_JSON, "kind", "%s", "police");

-       print_uint(PRINT_ANY, "index", "\tindex %u ", p->index);
+       print_hex(PRINT_FP, NULL, " police 0x%x ", p->index);
+       print_uint(PRINT_JSON, "index", NULL, p->index);
#9 lore raw
Quoted 22 lines · Roi Dayan
Quoted 19 lines · David Ahern
Quoted 18 lines · Roi Dayan
Quoted 13 lines · Hangbin Liu
Quoted 9 lines · Davide Caratti

my 2 cents:

what about using PRINT_FP / PRINT_JSON, so we fix the JSON output only to show "index", and
preserve the human-readable printout iproute and kselftests? besides avoiding failures because
of mismatching kselftests / iproute, this would preserve functionality of scripts that
configure / dump the "police" action. WDYT?

+1

Quoted 8 lines
Quoted 5 lines
Quoted 1 line

why not fix the kselftest to look for the correct output?

That is but 1 user. The general rule is that you do not change the output like you did.

but the output was "broken" and not consistent with all actions. we are not fixing this kind of thing?

It has been in hex since 2004, and you can not decide in 2021 that it is 'broken' and change it.

Quoted 12 lines

so to continue with the suggestion to use print_fp and keep police action output broken and print_json for the json output? just to be sure before submitting change back to old output for fp.

...
        action order 1:  police 0x1 rate 1Mbit burst 20Kb mtu 2Kb action reclassify overhead 0b

Quoted 8 lines

-       print_string(PRINT_ANY, "kind", "%s", "police"); +       print_string(PRINT_JSON, "kind", "%s", "police");

-       print_uint(PRINT_ANY, "index", "\tindex %u ", p->index); +       print_hex(PRINT_FP, NULL, " police 0x%x ", p->index); +       print_uint(PRINT_JSON, "index", NULL, p->index);

Jamal: opinions?

#10 lore raw
Quoted 10 lines · David Ahern
Quoted 10 lines

...
        action order 1:  police 0x1 rate 1Mbit burst 20Kb mtu 2Kb action
reclassify overhead 0b

-       print_string(PRINT_ANY, "kind", "%s", "police"); +       print_string(PRINT_JSON, "kind", "%s", "police");

Quoted 7 lines
Quoted 5 lines

-       print_uint(PRINT_ANY, "index", "\tindex %u ", p->index); +       print_hex(PRINT_FP, NULL, " police 0x%x ", p->index); +       print_uint(PRINT_JSON, "index", NULL, p->index);

Jamal: opinions?

Looks good to me. Roi please run the kernel tests to make sure nothing breaks.

cheers,
jamal

author
#11 lore raw
Quoted 18 lines · Jamal Hadi Salim
Quoted 16 lines · David Ahern
Quoted 15 lines

...
         action order 1:  police 0x1 rate 1Mbit burst 20Kb mtu 2Kb action reclassify overhead 0b

-       print_string(PRINT_ANY, "kind", "%s", "police"); +       print_string(PRINT_JSON, "kind", "%s", "police");

-       print_uint(PRINT_ANY, "index", "\tindex %u ", p->index); +       print_hex(PRINT_FP, NULL, " police 0x%x ", p->index); +       print_uint(PRINT_JSON, "index", NULL, p->index);

Quoted 8 lines
Quoted 1 line

Jamal: opinions?

Looks good to me. Roi please run the kernel tests to make sure nothing breaks.

cheers,
jamal

ok
I sent patch titled "police: Fix normal output back to what it was" I ran the tdc tests and passed.