From 5dccfc9ce00b980b81fea7204b5764544a895f0e Mon Sep 17 00:00:00 2001 From: Ivan Vecera Date: Wed, 31 May 2017 15:43:43 +0200 Subject: [PATCH 165/169] tc: man: Add man entry for the matchall classifier. Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=1435624 Upstream status: iproute2.git commit 0501294bca39a commit 0501294bca39a19090dae302dc491684470b1a0d Author: Yotam Gigi Date: Wed Aug 31 09:28:27 2016 +0200 tc: man: Add man entry for the matchall classifier. In addition to providing information about the mathcall filter and its configurations, the man entry contains examples for creating port mirorring entries. Signed-off-by: Yotam Gigi Signed-off-by: Jiri Pirko Signed-off-by: Ivan Vecera --- man/man8/Makefile | 2 +- man/man8/tc-matchall.8 | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++ man/man8/tc.8 | 5 ++++ 3 files changed, 82 insertions(+), 1 deletion(-) create mode 100644 man/man8/tc-matchall.8 diff --git a/man/man8/Makefile b/man/man8/Makefile index 8d73f1ea..93b4cdc9 100644 --- a/man/man8/Makefile +++ b/man/man8/Makefile @@ -12,7 +12,7 @@ MAN8PAGES = $(TARGETS) ip.8 arpd.8 lnstat.8 routel.8 rtacct.8 rtmon.8 rtpr.8 ss. ip-netns.8 ip-ntable.8 ip-rule.8 ip-tunnel.8 ip-xfrm.8 \ ip-tcp_metrics.8 ip-netconf.8 ip-token.8 \ tc-basic.8 tc-cgroup.8 tc-flow.8 tc-flower.8 tc-fw.8 tc-route.8 \ - tc-tcindex.8 tc-u32.8 \ + tc-tcindex.8 tc-u32.8 tc-matchall.8 \ tc-csum.8 tc-mirred.8 tc-nat.8 tc-pedit.8 tc-police.8 \ tc-simple.8 tc-skbedit.8 tc-xt.8 diff --git a/man/man8/tc-matchall.8 b/man/man8/tc-matchall.8 new file mode 100644 index 00000000..f9209226 --- /dev/null +++ b/man/man8/tc-matchall.8 @@ -0,0 +1,76 @@ +.TH "Match-all classifier in tc" 8 "21 Oct 2015" "iproute2" "Linux" + +.SH NAME +matchall \- traffic control filter that matches every packet +.SH SYNOPSIS +.in +8 +.ti -8 +.BR tc " " filter " ... " matchall " [ " +.BR skip_sw " | " skip_hw +.R " ] [ " +.B action +.IR ACTION_SPEC " ] [ " +.B classid +.IR CLASSID " ]" +.SH DESCRIPTION +The +.B matchall +filter allows to classify every packet that flows on the port and run a +action on it. +.SH OPTIONS +.TP +.BI action " ACTION_SPEC" +Apply an action from the generic actions framework on matching packets. +.TP +.BI classid " CLASSID" +Push matching packets into the class identified by +.IR CLASSID . +.TP +.BI skip_sw +Do not process filter by software. If hardware has no offload support for this +filter, or TC offload is not enabled for the interface, operation will fail. +.TP +.BI skip_hw +Do not process filter by hardware. +.SH EXAMPLES +To create ingress mirroring from port eth1 to port eth2: +.RS +.EX + +tc qdisc add dev eth1 handle ffff: ingress +tc filter add dev eth1 parent ffff: \\ + matchall skip_sw \\ + action mirred egress mirror \\ + dev eth2 +.EE +.RE + +The first command creats an ingress qdisc with handle +.BR ffff: +on device +.BR eth1 +where the second command attaches a matchall filters on it that mirrors the +packets to device eth2. + +To create egress mirroring from port eth1 to port eth2: +.EX + +tc qdisc add dev eth1 handle 1: root prio +tc filter add dev eth1 parent 1: \\ + matchall skip_sw \\ + action mirred egress mirror \\ + dev eth2 +.EE +.RE + +The first command creats an egress qdisc with handle +.BR 1: +that replaces the root qdisc on device +.BR eth1 +where the second command attaches a matchall filters on it that mirrors the +packets to device eth2. + + +.EE +.SH SEE ALSO +.BR tc (8), diff --git a/man/man8/tc.8 b/man/man8/tc.8 index ee3479eb..42121b0c 100644 --- a/man/man8/tc.8 +++ b/man/man8/tc.8 @@ -184,6 +184,11 @@ u32 Generic filtering on arbitrary packet data, assisted by syntax to abstract common operations. See .BR tc-u32 (8) for details. +.TP +matchall +Traffic control filter that matches every packet. See +.BR tc-matchall (8) +for details. .SH CLASSLESS QDISCS The classless qdiscs are: -- 2.13.0