| Message ID | 20180416143026.24561-6-stephen@that.guru |
|---|---|
| State | Changes Requested |
| Delegated to: | Ian Stokes |
| Headers | show |
| Series | Split up the DPDK how-to | expand |
> Again, this stuff is too detailed for a high-level howto. > > Signed-off-by: Stephen Finucane <stephen@that.guru> > --- > v2: > - Keep flow control section in 'phy' document > --- > Documentation/howto/dpdk.rst | 42 -------------------- > Documentation/topics/dpdk/index.rst | 1 + > Documentation/topics/dpdk/phy.rst | 2 + > Documentation/topics/dpdk/qos.rst | 76 > +++++++++++++++++++++++++++++++++++++ > 4 files changed, 79 insertions(+), 42 deletions(-) create mode 100644 > Documentation/topics/dpdk/qos.rst > > diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst > index 9cb76b7e1..3e04d8627 100644 > --- a/Documentation/howto/dpdk.rst > +++ b/Documentation/howto/dpdk.rst > @@ -85,48 +85,6 @@ To stop ovs-vswitchd & delete bridge, run:: > $ ovs-appctl -t ovsdb-server exit > $ ovs-vsctl del-br br0 > > -QoS > ---- > - > -Assuming you have a vhost-user port transmitting traffic consisting of > packets -of size 64 bytes, the following command would limit the egress > transmission -rate of the port to ~1,000,000 packets per second:: > - > - $ ovs-vsctl set port vhost-user0 qos=@newqos -- \ > - --id=@newqos create qos type=egress-policer other- > config:cir=46000000 \ > - other-config:cbs=2048` > - > -To examine the QoS configuration of the port, run:: > - > - $ ovs-appctl -t ovs-vswitchd qos/show vhost-user0 > - > -To clear the QoS configuration from the port and ovsdb, run:: > - > - $ ovs-vsctl destroy QoS vhost-user0 -- clear Port vhost-user0 qos > - > -Refer to vswitch.xml for more details on egress-policer. > - > -Rate Limiting > --------------- > - > -Here is an example on Ingress Policing usage. Assuming you have a vhost- > user -port receiving traffic consisting of packets of size 64 bytes, the > following -command would limit the reception rate of the port to > ~1,000,000 packets per > -second:: > - > - $ ovs-vsctl set interface vhost-user0 ingress_policing_rate=368000 \ > - ingress_policing_burst=1000` > - > -To examine the ingress policer configuration of the port:: > - > - $ ovs-vsctl list interface vhost-user0 > - > -To clear the ingress policer configuration from the port:: > - > - $ ovs-vsctl set interface vhost-user0 ingress_policing_rate=0 > - > -Refer to vswitch.xml for more details on ingress-policer. > - > pdump > ----- > > diff --git a/Documentation/topics/dpdk/index.rst > b/Documentation/topics/dpdk/index.rst > index c1e6ea78c..d3c1e2099 100644 > --- a/Documentation/topics/dpdk/index.rst > +++ b/Documentation/topics/dpdk/index.rst > @@ -36,3 +36,4 @@ The DPDK Datapath > /topics/dpdk/ring > /topics/dpdk/vdev > /topics/dpdk/pmd > + /topics/dpdk/qos > diff --git a/Documentation/topics/dpdk/phy.rst > b/Documentation/topics/dpdk/phy.rst > index 929f394ea..581984b63 100644 > --- a/Documentation/topics/dpdk/phy.rst > +++ b/Documentation/topics/dpdk/phy.rst > @@ -126,6 +126,8 @@ DPDK acceleration. It is possible to configure > multiple Rx queues for ``dpdk`` ports, thus ensuring this is not a > bottleneck for performance. For information on configuring PMD threads, > refer to :doc:`pmd`. > > +.. _dpdk-phy-flow-control: > + > Flow Control > ------------ > > diff --git a/Documentation/topics/dpdk/qos.rst > b/Documentation/topics/dpdk/qos.rst > new file mode 100644 > index 000000000..b42140515 > --- /dev/null > +++ b/Documentation/topics/dpdk/qos.rst Compilation error, qos.rst not listed in Documentation/automake.mk Egress and ingress policing was introduced in OVS 2.6 for version change tag. Wasn't available prior to this. Other than that LGTM. Ian > @@ -0,0 +1,76 @@ > +.. > + Licensed under the Apache License, Version 2.0 (the "License"); you > may > + not use this file except in compliance with the License. You may > obtain > + a copy of the License at > + > + http://www.apache.org/licenses/LICENSE-2.0 > + > + Unless required by applicable law or agreed to in writing, software > + distributed under the License is distributed on an "AS IS" BASIS, > WITHOUT > + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. > See the > + License for the specific language governing permissions and > limitations > + under the License. > + > + Convention for heading levels in Open vSwitch documentation: > + > + ======= Heading 0 (reserved for the title in a document) > + ------- Heading 1 > + ~~~~~~~ Heading 2 > + +++++++ Heading 3 > + ''''''' Heading 4 > + > + Avoid deeper levels because they do not render well. > + > +======================== > +Quality of Service (QoS) > +======================== > + > +It is possible to apply both ingress and egress limiting when using the > +DPDK datapath. These are referred to as *QoS* and *Rate Limiting*, > respectively. > + > +QoS (Egress Policing) > +--------------------- > + > +Assuming you have a :doc:`vhost-user port <vhost-user>` transmitting > +traffic consisting of packets of size 64 bytes, the following command > +would limit the egress transmission rate of the port to ~1,000,000 > packets per second:: > + > + $ ovs-vsctl set port vhost-user0 qos=@newqos -- \ > + --id=@newqos create qos type=egress-policer other- > config:cir=46000000 \ > + other-config:cbs=2048` > + > +To examine the QoS configuration of the port, run:: > + > + $ ovs-appctl -t ovs-vswitchd qos/show vhost-user0 > + > +To clear the QoS configuration from the port and ovsdb, run:: > + > + $ ovs-vsctl destroy QoS vhost-user0 -- clear Port vhost-user0 qos > + > +Refer to ``vswitch.xml`` for more details on egress policer. > + > +Rate Limiting (Ingress Policing) > +-------------------------------- > + > +Assuming you have a :doc:`vhost-user port <vhost-user>` receiving > +traffic consisting of packets of size 64 bytes, the following command > +would limit the reception rate of the port to ~1,000,000 packets per > second:: > + > + $ ovs-vsctl set interface vhost-user0 ingress_policing_rate=368000 \ > + ingress_policing_burst=1000` > + > +To examine the ingress policer configuration of the port:: > + > + $ ovs-vsctl list interface vhost-user0 > + > +To clear the ingress policer configuration from the port:: > + > + $ ovs-vsctl set interface vhost-user0 ingress_policing_rate=0 > + > +Refer to ``vswitch.xml`` for more details on ingress policer. > + > +Flow Control > +------------ > + > +Flow control is available for :doc:`DPDK physical ports <phy>`. For > +more information, refer to :ref:`dpdk-phy-flow-control`. > -- > 2.14.3
diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst index 9cb76b7e1..3e04d8627 100644 --- a/Documentation/howto/dpdk.rst +++ b/Documentation/howto/dpdk.rst @@ -85,48 +85,6 @@ To stop ovs-vswitchd & delete bridge, run:: $ ovs-appctl -t ovsdb-server exit $ ovs-vsctl del-br br0 -QoS ---- - -Assuming you have a vhost-user port transmitting traffic consisting of packets -of size 64 bytes, the following command would limit the egress transmission -rate of the port to ~1,000,000 packets per second:: - - $ ovs-vsctl set port vhost-user0 qos=@newqos -- \ - --id=@newqos create qos type=egress-policer other-config:cir=46000000 \ - other-config:cbs=2048` - -To examine the QoS configuration of the port, run:: - - $ ovs-appctl -t ovs-vswitchd qos/show vhost-user0 - -To clear the QoS configuration from the port and ovsdb, run:: - - $ ovs-vsctl destroy QoS vhost-user0 -- clear Port vhost-user0 qos - -Refer to vswitch.xml for more details on egress-policer. - -Rate Limiting --------------- - -Here is an example on Ingress Policing usage. Assuming you have a vhost-user -port receiving traffic consisting of packets of size 64 bytes, the following -command would limit the reception rate of the port to ~1,000,000 packets per -second:: - - $ ovs-vsctl set interface vhost-user0 ingress_policing_rate=368000 \ - ingress_policing_burst=1000` - -To examine the ingress policer configuration of the port:: - - $ ovs-vsctl list interface vhost-user0 - -To clear the ingress policer configuration from the port:: - - $ ovs-vsctl set interface vhost-user0 ingress_policing_rate=0 - -Refer to vswitch.xml for more details on ingress-policer. - pdump ----- diff --git a/Documentation/topics/dpdk/index.rst b/Documentation/topics/dpdk/index.rst index c1e6ea78c..d3c1e2099 100644 --- a/Documentation/topics/dpdk/index.rst +++ b/Documentation/topics/dpdk/index.rst @@ -36,3 +36,4 @@ The DPDK Datapath /topics/dpdk/ring /topics/dpdk/vdev /topics/dpdk/pmd + /topics/dpdk/qos diff --git a/Documentation/topics/dpdk/phy.rst b/Documentation/topics/dpdk/phy.rst index 929f394ea..581984b63 100644 --- a/Documentation/topics/dpdk/phy.rst +++ b/Documentation/topics/dpdk/phy.rst @@ -126,6 +126,8 @@ DPDK acceleration. It is possible to configure multiple Rx queues for ``dpdk`` ports, thus ensuring this is not a bottleneck for performance. For information on configuring PMD threads, refer to :doc:`pmd`. +.. _dpdk-phy-flow-control: + Flow Control ------------ diff --git a/Documentation/topics/dpdk/qos.rst b/Documentation/topics/dpdk/qos.rst new file mode 100644 index 000000000..b42140515 --- /dev/null +++ b/Documentation/topics/dpdk/qos.rst @@ -0,0 +1,76 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + + Convention for heading levels in Open vSwitch documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ~~~~~~~ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + +======================== +Quality of Service (QoS) +======================== + +It is possible to apply both ingress and egress limiting when using the DPDK +datapath. These are referred to as *QoS* and *Rate Limiting*, respectively. + +QoS (Egress Policing) +--------------------- + +Assuming you have a :doc:`vhost-user port <vhost-user>` transmitting traffic +consisting of packets of size 64 bytes, the following command would limit the +egress transmission rate of the port to ~1,000,000 packets per second:: + + $ ovs-vsctl set port vhost-user0 qos=@newqos -- \ + --id=@newqos create qos type=egress-policer other-config:cir=46000000 \ + other-config:cbs=2048` + +To examine the QoS configuration of the port, run:: + + $ ovs-appctl -t ovs-vswitchd qos/show vhost-user0 + +To clear the QoS configuration from the port and ovsdb, run:: + + $ ovs-vsctl destroy QoS vhost-user0 -- clear Port vhost-user0 qos + +Refer to ``vswitch.xml`` for more details on egress policer. + +Rate Limiting (Ingress Policing) +-------------------------------- + +Assuming you have a :doc:`vhost-user port <vhost-user>` receiving traffic +consisting of packets of size 64 bytes, the following command would limit the +reception rate of the port to ~1,000,000 packets per second:: + + $ ovs-vsctl set interface vhost-user0 ingress_policing_rate=368000 \ + ingress_policing_burst=1000` + +To examine the ingress policer configuration of the port:: + + $ ovs-vsctl list interface vhost-user0 + +To clear the ingress policer configuration from the port:: + + $ ovs-vsctl set interface vhost-user0 ingress_policing_rate=0 + +Refer to ``vswitch.xml`` for more details on ingress policer. + +Flow Control +------------ + +Flow control is available for :doc:`DPDK physical ports <phy>`. For more +information, refer to :ref:`dpdk-phy-flow-control`.
Again, this stuff is too detailed for a high-level howto. Signed-off-by: Stephen Finucane <stephen@that.guru> --- v2: - Keep flow control section in 'phy' document --- Documentation/howto/dpdk.rst | 42 -------------------- Documentation/topics/dpdk/index.rst | 1 + Documentation/topics/dpdk/phy.rst | 2 + Documentation/topics/dpdk/qos.rst | 76 +++++++++++++++++++++++++++++++++++++ 4 files changed, 79 insertions(+), 42 deletions(-) create mode 100644 Documentation/topics/dpdk/qos.rst