From: Po Liu <Po.Liu@nxp.com>
To: davem@davemloft.net, linux-kernel@vger.kernel.org,
netdev@vger.kernel.org
Cc: vinicius.gomes@intel.com, po.liu@nxp.com, claudiu.manoil@nxp.com,
vladimir.oltean@nxp.com, alexandru.marginean@nxp.com,
xiaoliang.yang_1@nxp.com, roy.zang@nxp.com, mingkai.hu@nxp.com,
jerry.huang@nxp.com, leoyang.li@nxp.com,
michael.chan@broadcom.com, vishal@chelsio.com,
saeedm@mellanox.com, leon@kernel.org, jiri@mellanox.com,
idosch@mellanox.com, alexandre.belloni@bootlin.com,
UNGLinuxDriver@microchip.com, kuba@kernel.org, jhs@mojatatu.com,
xiyou.wangcong@gmail.com, simon.horman@netronome.com,
pablo@netfilter.org, moshe@mellanox.com, m-karicheri2@ti.com,
andre.guedes@linux.intel.com, stephen@networkplumber.org,
Po Liu <Po.Liu@nxp.com>
Subject: [v1,iproute2 2/2] iproute2: add gate action man page
Date: Tue, 24 Mar 2020 11:47:45 +0800 [thread overview]
Message-ID: <20200324034745.30979-8-Po.Liu@nxp.com> (raw)
In-Reply-To: <20200324034745.30979-1-Po.Liu@nxp.com>
Signed-off-by: Po Liu <Po.Liu@nxp.com>
---
man/man8/tc-gate.8 | 106 +++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 106 insertions(+)
create mode 100644 man/man8/tc-gate.8
diff --git a/man/man8/tc-gate.8 b/man/man8/tc-gate.8
new file mode 100644
index 0000000..2b2d101
--- /dev/null
+++ b/man/man8/tc-gate.8
@@ -0,0 +1,106 @@
+.TH GATE 8 "12 Mar 2020" "iproute2" "Linux"
+.SH NAME
+gate \- Stream Gate Action
+.SH SYNOPSIS
+.B tc " ... " action gate
+.ti +8
+.B [ base-time
+BASETIME ]
+.B [ clockid
+CLOCKID ]
+.ti +8
+.B sched-entry
+<gate state> <interval 1> <internal priority> <max octets>
+.ti +8
+.B sched-entry
+<gate state> <interval 2> <internal priority> <max octets>
+.ti +8
+.B sched-entry
+<gate state> <interval 3> <internal priority> <max octets>
+.ti +8
+.B ......
+.ti +8
+.B sched-entry
+<gate state> <interval N> <internal priority> <max octets>
+
+.SH DESCRIPTION
+GATE action would provide a gate list to control when traffic keep
+open/close state. when the gate open state, the flow could pass but
+not when gate state is close. The driver would repeat the gate list
+periodically. User also could assign a time point to start the gate
+list by the basetime parameter. if the basetime has passed current
+time, start time would calculate by the cycletime of the gate list.
+
+.SH PARAMETERS
+
+.TP
+base-time
+.br
+Specifies the instant in nanoseconds, defining the time when the schedule
+starts. If 'base-time' is a time in the past, the schedule will start at
+
+base-time + (N * cycle-time)
+
+where N is the smallest integer so the resulting time is greater than
+"now", and "cycle-time" is the sum of all the intervals of the entries
+in the schedule. Without base-time specified, will default to be 0.
+
+.TP
+clockid
+.br
+Specifies the clock to be used by qdisc's internal timer for measuring
+time and scheduling events. Not valid if using for offloading filter.
+For example, tc filter command with
+.B skip_sw parameter.
+
+.TP
+sched-entry
+.br
+There may multiple
+.B sched-entry
+parameters in a single schedule. Each one has the format:
+
+sched-entry <gate state> <interval> <internal priority> <max octets>
+
+.br
+<gate state> means gate states. 'OPEN' keep gate open, 'CLOSE' keep gate close.
+.br
+<interval> means how much nano seconds for this time slot.
+.br
+<internal priority> means internal priority value. Present of the
+internal receiving queue for this stream. "-1" means wildcard.
+.br
+<max octets> means how many octets size for this time slot. Dropped
+if overlimited. "-1" means wildcard.
+
+.SH EXAMPLES
+
+The following example shows tc filter frames source ip match to the
+192.168.0.20 will be passed at offset time 0 last 200000000ns and will
+be dropped at the offset time 200000000ns and last 100000000ns. Then
+run the gate periodically. The schedule will start at instant 200000000000
+using the reference CLOCK_TAI. The schedule is composed of three entries
+each of 300us duration.
+
+.EX
+# tc filter add dev eth0 parent ffff: protocol ip \\
+ flower skip_hw src_ip 192.168.0.20 \\
+ action gate index 2 clockid CLOCK_TAI \\
+ base-time 200000000000 \\
+ sched-entry OPEN 200000000 -1 -1 \\
+ sched-entry CLOSE 100000000 -1 -1
+
+.EE
+
+Following is an example to filter a stream source mac match to the
+10:00:80:00:00:00 will be dropped at any time.
+
+.EX
+#tc filter add dev eth0 parent ffff: protocol ip chain 14 \\
+ flower skip_sw dst_mac 10:00:80:00:00:00 \\
+ action gate index 12 sched-entry close 200000000 -1 -1
+
+.EE
+
+.SH AUTHORS
+Po Liu <Po.Liu@nxp.com>
--
2.17.1
next prev parent reply other threads:[~2020-03-24 4:08 UTC|newest]
Thread overview: 125+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-06 12:55 [RFC,net-next 0/9] Introduce a flow gate control action and apply IEEE Po Liu
2020-03-06 12:55 ` [RFC,net-next 1/9] net: qos offload add flow status with dropped count Po Liu
2020-03-06 12:56 ` [RFC,net-next 2/9] net: qos: introduce a gate control flow action Po Liu
2020-03-06 19:11 ` Jakub Kicinski
2020-03-07 6:05 ` [EXT] " Po Liu
2020-03-12 22:14 ` Vinicius Costa Gomes
2020-03-13 3:47 ` [EXT] " Po Liu
2020-03-13 18:36 ` Cong Wang
2020-03-14 4:09 ` [EXT] " Po Liu
2020-03-06 12:56 ` [RFC,net-next 3/9] net: schedule: add action gate offloading Po Liu
2020-03-06 19:02 ` Jakub Kicinski
2020-03-06 19:19 ` Jakub Kicinski
2020-03-07 4:38 ` [EXT] " Po Liu
2020-03-06 12:56 ` [RFC,net-next 4/9] net: enetc: add hw tc hw offload features for PSPF capability Po Liu
2020-03-06 12:56 ` [RFC,net-next 5/9] net: enetc: add tc flower psfp offload driver Po Liu
2020-03-12 22:14 ` Vinicius Costa Gomes
2020-03-13 5:59 ` [EXT] " Po Liu
2020-03-06 12:56 ` [RFC,net-next 6/9] net: qos: add tc police offloading action with max frame size limit Po Liu
2020-06-23 6:34 ` [v1,net-next 1/4] " Po Liu
2020-06-23 6:34 ` [v1,net-next 2/4] net: enetc: add support max frame size for tc flower offload Po Liu
2020-06-23 6:34 ` [v1,net-next 3/4] net: qos: police action add index for tc flower offloading Po Liu
2020-06-23 7:09 ` Ido Schimmel
2020-06-23 7:39 ` [EXT] " Po Liu
2020-06-23 10:08 ` Jamal Hadi Salim
2020-06-23 6:34 ` [v1,net-next 4/4] net: enetc add tc flower offload flow metering policing action Po Liu
2020-06-23 14:54 ` kernel test robot
2020-06-23 15:08 ` kernel test robot
2020-06-24 9:36 ` [v2,net-next 1/4] net: qos: add tc police offloading action with max frame size limit Po Liu
2020-06-24 9:36 ` [v2,net-next 2/4] net: enetc: add support max frame size for tc flower offload Po Liu
2020-06-25 5:04 ` David Miller
2020-06-24 9:36 ` [v2,net-next 3/4] net: qos: police action add index for tc flower offloading Po Liu
2020-06-25 5:04 ` David Miller
2020-06-24 9:36 ` [v2,net-next 4/4] net: enetc add tc flower offload flow metering policing action Po Liu
2020-06-25 5:04 ` David Miller
2020-06-25 5:04 ` [v2,net-next 1/4] net: qos: add tc police offloading action with max frame size limit David Miller
2020-06-23 7:01 ` [v1,net-next " Ido Schimmel
2020-03-06 12:56 ` [RFC,net-next 7/9] net: enetc: add support max frame size for tc flower offload Po Liu
2020-03-06 12:56 ` [RFC,net-next 8/9] net: qos: police action add index for tc flower offloading Po Liu
2020-06-21 10:04 ` Ido Schimmel
2020-03-06 12:56 ` [RFC,net-next 9/9] net: enetc add tc flower offload flow metering policing action Po Liu
2020-03-06 12:56 ` [RFC, iproute2-next] iproute2:tc:action: add a gate control action Po Liu
2020-03-24 3:47 ` [v1,net-next 0/5] Introduce a flow gate control action and apply IEEE Po Liu
2020-03-24 3:47 ` [v1,net-next 1/5] net: qos offload add flow status with dropped count Po Liu
2020-03-24 10:01 ` Jiri Pirko
2020-03-24 13:04 ` [EXT] " Po Liu
2020-03-24 3:47 ` [v1,net-next 2/5] net: qos: introduce a gate control flow action Po Liu
2020-03-24 10:19 ` Jiri Pirko
2020-03-24 10:28 ` [EXT] " Po Liu
2020-03-24 3:47 ` [v1,net-next 3/5] net: schedule: add action gate offloading Po Liu
2020-03-24 3:47 ` [v1,net-next 4/5] net: enetc: add hw tc hw offload features for PSPF capability Po Liu
2020-03-24 11:18 ` kbuild test robot
2020-03-24 12:14 ` Jiri Pirko
2020-03-24 3:47 ` [v1,net-next 5/5] net: enetc: add tc flower psfp offload driver Po Liu
2020-03-24 12:53 ` kbuild test robot
2020-03-24 3:47 ` [v1,iproute2 1/2] iproute2:tc:action: add a gate control action Po Liu
2020-03-24 21:59 ` Stephen Hemminger
2020-03-25 2:40 ` [EXT] " Po Liu
2020-03-24 3:47 ` Po Liu [this message]
2020-04-14 5:40 ` [v2,net-next 0/4] Introduce a flow gate control action and apply IEEE Po Liu
2020-04-14 5:40 ` [ v2,net-next 1/4] net: qos: introduce a gate control flow action Po Liu
2020-04-14 5:40 ` [ v2,net-next 2/4] net: schedule: add action gate offloading Po Liu
2020-04-14 5:40 ` [ v2,net-next 3/4] net: enetc: add hw tc hw offload features for PSPF capability Po Liu
2020-04-14 5:40 ` [ v2,net-next 4/4] net: enetc: add tc flower psfp offload driver Po Liu
2020-04-14 23:41 ` [v2,net-next 0/4] Introduce a flow gate control action and apply IEEE David Miller
2020-04-18 1:12 ` Po Liu
2020-04-18 1:12 ` [ v2,net-next 1/4] net: qos: introduce a gate control flow action Po Liu
2020-04-18 1:12 ` [ v2,net-next 2/4] net: schedule: add action gate offloading Po Liu
2020-04-18 1:12 ` [ v2,net-next 3/4] net: enetc: add hw tc hw offload features for PSPF capability Po Liu
2020-04-18 1:12 ` [ v2,net-next 4/4] net: enetc: add tc flower psfp offload driver Po Liu
2020-04-18 22:52 ` Vladimir Oltean
2020-04-19 1:44 ` [EXT] " Po Liu
2020-04-22 2:48 ` [v3,net-next 0/4] Introduce a flow gate control action and apply IEEE Po Liu
2020-04-22 2:48 ` [v3,net-next 1/4] net: qos: introduce a gate control flow action Po Liu
2020-04-22 13:23 ` Vlad Buslov
2020-04-23 3:14 ` [EXT] " Po Liu
2020-04-23 7:43 ` Vlad Buslov
2020-04-23 8:32 ` Po Liu
2020-04-23 9:15 ` Po Liu
2020-04-23 11:14 ` Vlad Buslov
2020-04-23 11:03 ` Vlad Buslov
2020-04-22 19:19 ` Allan W. Nielsen
2020-04-22 19:28 ` Vladimir Oltean
2020-04-22 20:05 ` Dave Taht
2020-04-23 3:29 ` [EXT] " Po Liu
2020-04-23 19:11 ` Allan W. Nielsen
2020-04-23 3:27 ` [EXT] " Po Liu
2020-04-23 17:38 ` Vinicius Costa Gomes
2020-04-23 19:17 ` Allan W. Nielsen
2020-04-24 3:23 ` [EXT] " Po Liu
2020-04-24 17:41 ` Vinicius Costa Gomes
2020-04-25 1:49 ` Po Liu
2020-04-22 2:48 ` [v3,net-next 2/4] net: schedule: add action gate offloading Po Liu
2020-04-22 14:14 ` Vlad Buslov
2020-04-22 2:48 ` [v3,net-next 3/4] net: enetc: add hw tc hw offload features for PSPF capability Po Liu
2020-04-22 2:48 ` [v3,net-next 4/4] net: enetc: add tc flower psfp offload driver Po Liu
2020-04-28 3:34 ` [v4,net-next 0/4] Introduce a flow gate control action and apply IEEE Po Liu
2020-04-28 3:34 ` [v4,net-next 1/4] net: qos: introduce a gate control flow action Po Liu
2020-04-29 17:04 ` Vlad Buslov
2020-04-30 0:52 ` [EXT] " Po Liu
2020-04-28 3:34 ` [v4,net-next 2/4] net: schedule: add action gate offloading Po Liu
2020-04-29 17:40 ` Vlad Buslov
2020-04-28 3:34 ` [v4,net-next 3/4] net: enetc: add hw tc hw offload features for PSPF capability Po Liu
2020-04-28 3:34 ` [v4,net-next 4/4] net: enetc: add tc flower psfp offload driver Po Liu
2020-05-01 0:53 ` [v5,net-next 0/4] Introduce a flow gate control action and apply IEEE Po Liu
2020-05-01 0:53 ` [v5,net-next 1/4] net: qos: introduce a gate control flow action Po Liu
2020-05-01 0:53 ` [v5,net-next 2/4] net: schedule: add action gate offloading Po Liu
2020-05-01 0:53 ` [v5,net-next 3/4] net: enetc: add hw tc hw offload features for PSPF capability Po Liu
2020-05-01 0:53 ` [v5,net-next 4/4] net: enetc: add tc flower psfp offload driver Po Liu
2020-05-03 6:32 ` [v3,iproute2 1/2] iproute2:tc:action: add a gate control action Po Liu
2020-05-03 6:32 ` [v3,iproute2 2/2] iproute2: add gate action man page Po Liu
2020-05-06 8:40 ` [v4,iproute2-next 1/2] iproute2-next:tc:action: add a gate control action Po Liu
2020-05-06 8:40 ` [v4,iproute2-next 2/2] iproute2-next: add gate action man page Po Liu
2020-05-08 7:02 ` [v5,iproute2-next 1/2] iproute2-next:tc:action: add a gate control action Po Liu
2020-05-08 7:02 ` [v5,iproute2-next 2/2] iproute2-next: add gate action man page Po Liu
2020-05-13 2:21 ` [v5,iproute2-next 1/2] iproute2-next:tc:action: add a gate control action David Ahern
2020-05-06 12:54 ` [v4,iproute2-next " Davide Caratti
2020-05-07 2:28 ` [EXT] " Po Liu
2020-05-06 15:21 ` Stephen Hemminger
2020-05-05 0:05 ` [v3,iproute2 1/2] iproute2:tc:action: " Stephen Hemminger
2020-05-05 0:06 ` Stephen Hemminger
2020-05-01 23:08 ` [v5,net-next 0/4] Introduce a flow gate control action and apply IEEE David Miller
2020-06-19 6:01 ` [v2,net-next] net: qos offload add flow status with dropped count Po Liu
2020-06-19 7:03 ` Simon Horman
2020-06-19 18:00 ` Vlad Buslov
2020-06-19 19:54 ` David Miller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200324034745.30979-8-Po.Liu@nxp.com \
--to=po.liu@nxp.com \
--cc=UNGLinuxDriver@microchip.com \
--cc=alexandre.belloni@bootlin.com \
--cc=alexandru.marginean@nxp.com \
--cc=andre.guedes@linux.intel.com \
--cc=claudiu.manoil@nxp.com \
--cc=davem@davemloft.net \
--cc=idosch@mellanox.com \
--cc=jerry.huang@nxp.com \
--cc=jhs@mojatatu.com \
--cc=jiri@mellanox.com \
--cc=kuba@kernel.org \
--cc=leon@kernel.org \
--cc=leoyang.li@nxp.com \
--cc=linux-kernel@vger.kernel.org \
--cc=m-karicheri2@ti.com \
--cc=michael.chan@broadcom.com \
--cc=mingkai.hu@nxp.com \
--cc=moshe@mellanox.com \
--cc=netdev@vger.kernel.org \
--cc=pablo@netfilter.org \
--cc=roy.zang@nxp.com \
--cc=saeedm@mellanox.com \
--cc=simon.horman@netronome.com \
--cc=stephen@networkplumber.org \
--cc=vinicius.gomes@intel.com \
--cc=vishal@chelsio.com \
--cc=vladimir.oltean@nxp.com \
--cc=xiaoliang.yang_1@nxp.com \
--cc=xiyou.wangcong@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).