Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/824155/?format=api
{ "id": 824155, "url": "http://patchwork.ozlabs.org/api/patches/824155/?format=api", "web_url": "http://patchwork.ozlabs.org/project/intel-wired-lan/patch/20171011004652.15630-3-vinicius.gomes@intel.com/", "project": { "id": 46, "url": "http://patchwork.ozlabs.org/api/projects/46/?format=api", "name": "Intel Wired Ethernet development", "link_name": "intel-wired-lan", "list_id": "intel-wired-lan.osuosl.org", "list_email": "intel-wired-lan@osuosl.org", "web_url": "", "scm_url": "", "webscm_url": "", "list_archive_url": "", "list_archive_url_format": "", "commit_url_format": "" }, "msgid": "<20171011004652.15630-3-vinicius.gomes@intel.com>", "list_archive_url": null, "date": "2017-10-11T00:46:52", "name": "[iproute2,net-next,v2,3/3] man: Add initial manpage for tc-cbs(8)", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "414196a650bf70adf593ab48615c923cbca76bc0", "submitter": { "id": 72272, "url": "http://patchwork.ozlabs.org/api/people/72272/?format=api", "name": "Vinicius Costa Gomes", "email": "vinicius.gomes@intel.com" }, "delegate": { "id": 68, "url": "http://patchwork.ozlabs.org/api/users/68/?format=api", "username": "jtkirshe", "first_name": "Jeff", "last_name": "Kirsher", "email": "jeffrey.t.kirsher@intel.com" }, "mbox": "http://patchwork.ozlabs.org/project/intel-wired-lan/patch/20171011004652.15630-3-vinicius.gomes@intel.com/mbox/", "series": [ { "id": 7490, "url": "http://patchwork.ozlabs.org/api/series/7490/?format=api", "web_url": "http://patchwork.ozlabs.org/project/intel-wired-lan/list/?series=7490", "date": "2017-10-11T00:46:50", "name": "[iproute2,net-next,v2,1/3] update headers with CBS API [ONLY FOR TESTING]", "version": 2, "mbox": "http://patchwork.ozlabs.org/series/7490/mbox/" } ], "comments": "http://patchwork.ozlabs.org/api/patches/824155/comments/", "check": "pending", "checks": "http://patchwork.ozlabs.org/api/patches/824155/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<intel-wired-lan-bounces@osuosl.org>", "X-Original-To": [ "incoming@patchwork.ozlabs.org", "intel-wired-lan@lists.osuosl.org" ], "Delivered-To": [ "patchwork-incoming@bilbo.ozlabs.org", "intel-wired-lan@lists.osuosl.org" ], "Authentication-Results": "ozlabs.org;\n\tspf=pass (mailfrom) smtp.mailfrom=osuosl.org\n\t(client-ip=140.211.166.137; helo=fraxinus.osuosl.org;\n\tenvelope-from=intel-wired-lan-bounces@osuosl.org;\n\treceiver=<UNKNOWN>)", "Received": [ "from fraxinus.osuosl.org (smtp4.osuosl.org [140.211.166.137])\n\t(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))\n\t(No client certificate requested)\n\tby ozlabs.org (Postfix) with ESMTPS id 3yBb0d5B7Bz9t5x\n\tfor <incoming@patchwork.ozlabs.org>;\n\tWed, 11 Oct 2017 11:47:13 +1100 (AEDT)", "from localhost (localhost [127.0.0.1])\n\tby fraxinus.osuosl.org (Postfix) with ESMTP id 1B50B88BA0;\n\tWed, 11 Oct 2017 00:47:12 +0000 (UTC)", "from fraxinus.osuosl.org ([127.0.0.1])\n\tby localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024)\n\twith ESMTP id Vx7ZHLksMAJK; Wed, 11 Oct 2017 00:47:10 +0000 (UTC)", "from ash.osuosl.org (ash.osuosl.org [140.211.166.34])\n\tby fraxinus.osuosl.org (Postfix) with ESMTP id 8E0E688B67;\n\tWed, 11 Oct 2017 00:47:10 +0000 (UTC)", "from whitealder.osuosl.org (smtp1.osuosl.org [140.211.166.138])\n\tby ash.osuosl.org (Postfix) with ESMTP id 2CAF71C0FDB\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tWed, 11 Oct 2017 00:47:09 +0000 (UTC)", "from localhost (localhost [127.0.0.1])\n\tby whitealder.osuosl.org (Postfix) with ESMTP id 2742589012\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tWed, 11 Oct 2017 00:47:09 +0000 (UTC)", "from whitealder.osuosl.org ([127.0.0.1])\n\tby localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024)\n\twith ESMTP id lcKxeH4FsOqy for <intel-wired-lan@lists.osuosl.org>;\n\tWed, 11 Oct 2017 00:47:08 +0000 (UTC)", "from mga02.intel.com (mga02.intel.com [134.134.136.20])\n\tby whitealder.osuosl.org (Postfix) with ESMTPS id A619B89520\n\tfor <intel-wired-lan@lists.osuosl.org>;\n\tWed, 11 Oct 2017 00:47:08 +0000 (UTC)", "from fmsmga003.fm.intel.com ([10.253.24.29])\n\tby orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t10 Oct 2017 17:47:08 -0700", "from ellie.jf.intel.com (HELO localhost.localdomain)\n\t([10.24.13.71])\n\tby FMSMGA003.fm.intel.com with ESMTP; 10 Oct 2017 17:47:07 -0700" ], "X-Virus-Scanned": [ "amavisd-new at osuosl.org", "amavisd-new at osuosl.org" ], "X-Greylist": "domain auto-whitelisted by SQLgrey-1.7.6", "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.43,359,1503385200\"; d=\"scan'208\";a=\"908716157\"", "From": "Vinicius Costa Gomes <vinicius.gomes@intel.com>", "To": "netdev@vger.kernel.org,\n\tintel-wired-lan@lists.osuosl.org", "Date": "Tue, 10 Oct 2017 17:46:52 -0700", "Message-Id": "<20171011004652.15630-3-vinicius.gomes@intel.com>", "X-Mailer": "git-send-email 2.14.2", "In-Reply-To": "<20171011004652.15630-1-vinicius.gomes@intel.com>", "References": "<20171011004652.15630-1-vinicius.gomes@intel.com>", "Cc": "rodney.cummings@ni.com, andre.guedes@intel.com, jiri@resnulli.us,\n\tivan.briano@intel.com, richardcochran@gmail.com, henrik@austad.us,\n\tjhs@mojatatu.com, levipearson@gmail.com, boon.leong.ong@intel.com,\n\txiyou.wangcong@gmail.com, jesus.sanchez-palencia@intel.com", "Subject": "[Intel-wired-lan] [iproute2 net-next v2 3/3] man: Add initial\n\tmanpage for tc-cbs(8)", "X-BeenThere": "intel-wired-lan@osuosl.org", "X-Mailman-Version": "2.1.18-1", "Precedence": "list", "List-Id": "Intel Wired Ethernet Linux Kernel Driver Development\n\t<intel-wired-lan.osuosl.org>", "List-Unsubscribe": "<https://lists.osuosl.org/mailman/options/intel-wired-lan>, \n\t<mailto:intel-wired-lan-request@osuosl.org?subject=unsubscribe>", "List-Archive": "<http://lists.osuosl.org/pipermail/intel-wired-lan/>", "List-Post": "<mailto:intel-wired-lan@osuosl.org>", "List-Help": "<mailto:intel-wired-lan-request@osuosl.org?subject=help>", "List-Subscribe": "<https://lists.osuosl.org/mailman/listinfo/intel-wired-lan>, \n\t<mailto:intel-wired-lan-request@osuosl.org?subject=subscribe>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=\"us-ascii\"", "Content-Transfer-Encoding": "7bit", "Errors-To": "intel-wired-lan-bounces@osuosl.org", "Sender": "\"Intel-wired-lan\" <intel-wired-lan-bounces@osuosl.org>" }, "content": "Signed-off-by: Vinicius Costa Gomes <vinicius.gomes@intel.com>\n---\n man/man8/tc-cbs.8 | 112 ++++++++++++++++++++++++++++++++++++++++++++++++++++++\n 1 file changed, 112 insertions(+)\n create mode 100644 man/man8/tc-cbs.8", "diff": "diff --git a/man/man8/tc-cbs.8 b/man/man8/tc-cbs.8\nnew file mode 100644\nindex 00000000..97e00c84\n--- /dev/null\n+++ b/man/man8/tc-cbs.8\n@@ -0,0 +1,112 @@\n+.TH CBS 8 \"18 Sept 2017\" \"iproute2\" \"Linux\"\n+.SH NAME\n+CBS \\- Credit Based Shaper (CBS) Qdisc\n+.SH SYNOPSIS\n+.B tc qdisc ... dev\n+dev\n+.B parent\n+classid\n+.B [ handle\n+major:\n+.B ] cbs idleslope\n+idleslope\n+.B sendslope\n+sendslope\n+.B hicredit\n+hicredit\n+.B locredit\n+locredit\n+.B [ offload\n+0|1\n+.B ]\n+\n+.SH DESCRIPTION\n+The CBS (Credit Based Shaper) qdisc implements the shaping algorithm\n+defined by the IEEE 802.1Q-2014 Section 8.6.8.2, which applies a well\n+defined rate limiting method to the traffic.\n+\n+This queueing discipline is intended to be used by TSN (Time Sensitive\n+Networking) applications, the CBS parameters are derived directly by\n+what is described by the Annex L of the IEEE 802.1Q-2014\n+Sepcification. The algorithm and how it affects the latency are\n+detailed there.\n+\n+CBS is meant to be installed under another qdisc that maps packet\n+flows to traffic classes, one example is\n+.BR mqprio(8).\n+\n+.SH PARAMETERS\n+.TP\n+idleslope\n+Idleslope is the rate of credits that is accumulated (in kilobits per\n+second) when there is at least one packet waiting for transmission.\n+Packets are transmitted when the current value of credits is equal or\n+greater than zero. When there is no packet to be transmitted the\n+amount of credits is set to zero. This is the main tunable of the CBS\n+algorithm.\n+.TP\n+sendslope\n+Sendslope is the rate of credits that is depleted (it should be a\n+negative number of kilobits per second) when a transmission is\n+ocurring. It can be calculated as follows, (IEEE 802.1Q-2014 Section\n+8.6.8.2 item g):\n+\n+sendslope = idleslope - port_transmit_rate\n+\n+.TP\n+hicredit\n+Hicredit defines the maximum amount of credits (in bytes) that can be\n+accumulated. Hicredit depends on the characteristics of interfering\n+traffic, 'max_interference_size' is the maximum size of any burst of\n+traffic that can delay the transmission of a frame that is available\n+for transmission for this traffic class, (IEEE 802.1Q-2014 Annex L,\n+Equation L-3):\n+\n+hicredit = max_interference_size * (idleslope / port_transmit_rate)\n+\n+.TP\n+locredit\n+Locredit is the minimum amount of credits that can be reached. It is a\n+function of the traffic flowing through this qdisc (IEEE 802.1Q-2014\n+Annex L, Equation L-2):\n+\n+locredit = max_frame_size * (sendslope / port_transmit_rate)\n+\n+.TP\n+offload\n+When\n+.B offload\n+is 1,\n+.BR cbs(8)\n+will try to configure the network interface so the CBS algorithm runs\n+in the controller. The default is 0.\n+\n+.SH EXAMPLES\n+\n+CBS is used to enforce a Quality of Service by limiting the data rate\n+of a traffic class, to separate packets into traffic classes the user\n+may choose\n+.BR mqprio(8),\n+and configure it like this:\n+\n+.EX\n+# tc qdisc add dev eth0 handle 100: parent root mqprio num_tc 3 \\\\\n+\tmap 2 2 1 0 2 2 2 2 2 2 2 2 2 2 2 2 \\\\\n+\tqueues 1@0 1@1 2@2 \\\\\n+\thw 0\n+.EE\n+.P\n+To replace the current queuing disciple by CBS in the current queueing\n+discipline connected to traffic class number 0, issue:\n+.P\n+.EX\n+# tc qdisc replace dev eth0 parent 100:4 cbs \\\\\n+\tlocredit -1470 hicredit 30 sendslope -980000 idleslope 20000\n+.EE\n+\n+These values are obtained from the following parameters, idleslope is\n+20mbit/s, the transmission rate is 1Gbit/s and the maximum interfering\n+frame size is 1500 bytes.\n+\n+.SH AUTHORS\n+Vinicius Costa Gomes <vinicius.gomes@intel.com>\n", "prefixes": [ "iproute2", "net-next", "v2", "3/3" ] }