> Again, this stuff is too detailed for a high-level howto. > > Signed-off-by: Stephen Finucane <[email protected]> > --- > Documentation/howto/dpdk.rst | 70 ------------------------- > Documentation/topics/dpdk/index.rst | 1 + > Documentation/topics/dpdk/phy.rst | 6 +++ > Documentation/topics/dpdk/qos.rst | 100 > ++++++++++++++++++++++++++++++++++++ > 4 files changed, 107 insertions(+), 70 deletions(-) create mode 100644 > Documentation/topics/dpdk/qos.rst > > diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst > index 4d993a0eb..608dde814 100644 > --- a/Documentation/howto/dpdk.rst > +++ b/Documentation/howto/dpdk.rst > @@ -85,76 +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. > - > -Flow Control > ------------- > - > -Flow control can be enabled only on DPDK physical ports. To enable flow > control -support at tx side while adding a port, run:: > - > - $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \ > - options:dpdk-devargs=0000:01:00.0 options:tx-flow-ctrl=true > - > -Similarly, to enable rx flow control, run:: > - > - $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \ > - options:dpdk-devargs=0000:01:00.0 options:rx-flow-ctrl=true > - > -To enable flow control auto-negotiation, run:: > - > - $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \ > - options:dpdk-devargs=0000:01:00.0 options:flow-ctrl-autoneg=true > - > -To turn ON the tx flow control at run time for an existing port, run:: > - > - $ ovs-vsctl set Interface dpdk-p0 options:tx-flow-ctrl=true > - > -The flow control parameters can be turned off by setting ``false`` to the > -respective parameter. To disable the flow control at tx side, run:: > - > - $ ovs-vsctl set Interface dpdk-p0 options:tx-flow-ctrl=false > - > pdump > ----- > > diff --git a/Documentation/topics/dpdk/index.rst > b/Documentation/topics/dpdk/index.rst > index dfde88377..fe4d97b8b 100644 > --- a/Documentation/topics/dpdk/index.rst > +++ b/Documentation/topics/dpdk/index.rst > @@ -32,3 +32,4 @@ The DPDK Datapath > vhost-user > ring > pmd > + qos > diff --git a/Documentation/topics/dpdk/phy.rst > b/Documentation/topics/dpdk/phy.rst > index 507dac869..93aff628c 100644 > --- a/Documentation/topics/dpdk/phy.rst > +++ b/Documentation/topics/dpdk/phy.rst > @@ -210,3 +210,9 @@ More information on the different types of virtual > DPDK PMDs can be found in the `DPDK documentation`__. > > __ http://dpdk.org/doc/guides/nics/overview.html > + > +Flow Control > +------------ > + > +Flow control is available for DPDK physical ports. For more > +information, refer to :ref:`dpdk-flow-control`.
Ah, I see you add a section for flow control here, disregard previous comment in patch 3. > diff --git a/Documentation/topics/dpdk/qos.rst > b/Documentation/topics/dpdk/qos.rst > new file mode 100644 > index 000000000..c19e01db7 > --- /dev/null > +++ b/Documentation/topics/dpdk/qos.rst > @@ -0,0 +1,100 @@ > +.. > + 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. > + > +.. _dpdk-flow-control: > + > +Flow Control > +------------ Hmmm, not so sure this belongs here, as it's a phy port functionality I would keep it as part of that doc. Ian > + > +Flow control can be enabled only on DPDK physical ports. To enable flow > +control support at Tx side while adding a port, run:: > + > + $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \ > + options:dpdk-devargs=0000:01:00.0 options:tx-flow-ctrl=true > + > +Similarly, to enable Rx flow control, run:: > + > + $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \ > + options:dpdk-devargs=0000:01:00.0 options:rx-flow-ctrl=true > + > +To enable flow control auto-negotiation, run:: > + > + $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \ > + options:dpdk-devargs=0000:01:00.0 > + options:flow-ctrl-autoneg=true > + > +To turn ON the Tx flow control at run time for an existing port, run:: > + > + $ ovs-vsctl set Interface dpdk-p0 options:tx-flow-ctrl=true > + > +The flow control parameters can be turned off by setting ``false`` to > +the respective parameter. To disable the flow control at Tx side, run:: > + > + $ ovs-vsctl set Interface dpdk-p0 options:tx-flow-ctrl=false > -- > 2.14.3 > > _______________________________________________ > dev mailing list > [email protected] > https://mail.openvswitch.org/mailman/listinfo/ovs-dev _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
