From patchwork Mon Feb 12 18:13:02 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 872260 X-Patchwork-Delegate: ian.stokes@intel.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=openvswitch.org (client-ip=140.211.169.12; helo=mail.linuxfoundation.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Authentication-Results: ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="LG4idvw6"; dkim-atps=neutral Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3zgDZQ6Z9qz9t32 for ; Tue, 13 Feb 2018 05:23:42 +1100 (AEDT) Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id C50E5E9B; Mon, 12 Feb 2018 18:22:28 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@mail.linuxfoundation.org Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id F15F3EA7 for ; Mon, 12 Feb 2018 18:22:26 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from weasel.tulip.relay.mailchannels.net (weasel.tulip.relay.mailchannels.net [23.83.218.247]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id 09E9C401 for ; Mon, 12 Feb 2018 18:22:24 +0000 (UTC) X-Sender-Id: 5xi41l16bi|x-authuser|stephen@that.guru Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id EB27C5C18BA; Mon, 12 Feb 2018 18:13:18 +0000 (UTC) Received: from one.mxroute.com (unknown [100.96.14.37]) (Authenticated sender: 5xi41l16bi) by relay.mailchannels.net (Postfix) with ESMTPA id 5806C5C0AE3; Mon, 12 Feb 2018 18:13:18 +0000 (UTC) X-Sender-Id: 5xi41l16bi|x-authuser|stephen@that.guru Received: from one.mxroute.com (one-outgoing.mxroute.com [172.18.47.25]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.13.1); Mon, 12 Feb 2018 18:13:18 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: 5xi41l16bi|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: 5xi41l16bi X-Rock-Daffy: 4cc864e40378fe1d_1518459198767_4047146397 X-MC-Loop-Signature: 1518459198767:819084145 X-MC-Ingress-Time: 1518459198767 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=default; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=oZbEc7Vi5X8VYjSMD6Xxj4Jk87aFA+iYUMRt2J3MD60=; b=LG4idvw6TX/cYoldDmFfx1lmju eDtNeEFKPIi4ky5bYs32BPe40ifLw+pLz/LYl5yN/F4k2iUW+y2I+sxZ8ih8Dj7Plo9DWRNbnakxs Un1O8+ze3TF4of5sNDT5xdUgNuZB0hB2gMiLyEI/KJ8caUFJbCjlLLQDjYj7FR6euQA2bT8LluP30 qPuxBR1xPsMIeESskU3Di0ODXmWga2KQSZRXz3e30ITS4P1PkbVMEwt7TdSa3jW7UUuHGuUoU5LtG R2nNQ8Gno6WVsKITclYHNBXmMKu5Q11kI5vz3jPDTx+C+WB9CQ/nbVqYRpXau032YFdgvoZODejaB J97ummQg==; From: Stephen Finucane To: dev@openvswitch.org Date: Mon, 12 Feb 2018 18:13:02 +0000 Message-Id: <20180212181306.6674-5-stephen@that.guru> X-Mailer: git-send-email 2.14.3 In-Reply-To: <20180212181306.6674-1-stephen@that.guru> References: <20180212181306.6674-1-stephen@that.guru> X-AuthUser: stephen@that.guru X-Spam-Status: No, score=-1.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, T_DKIM_INVALID autolearn=no version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [PATCH 4/8] doc: Move "QoS" guide to its own document X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: ovs-dev-bounces@openvswitch.org Errors-To: ovs-dev-bounces@openvswitch.org Again, this stuff is too detailed for a high-level howto. Signed-off-by: Stephen Finucane --- 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`. 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 ` 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 ` 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 +------------ + +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