From patchwork Tue Jul 12 09:44:43 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Shreyansh Jain X-Patchwork-Id: 14781 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 085FD2B91; Tue, 12 Jul 2016 11:44:17 +0200 (CEST) Received: from NAM02-CY1-obe.outbound.protection.outlook.com (mail-cys01nam02on0060.outbound.protection.outlook.com [104.47.37.60]) by dpdk.org (Postfix) with ESMTP id E1509E6D for ; Tue, 12 Jul 2016 11:44:14 +0200 (CEST) Received: from BN3PR0301CA0024.namprd03.prod.outlook.com (10.160.180.162) by BLUPR0301MB1985.namprd03.prod.outlook.com (10.164.22.11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.528.16; Tue, 12 Jul 2016 09:44:13 +0000 Received: from BY2FFO11OLC004.protection.gbl (2a01:111:f400:7c0c::178) by BN3PR0301CA0024.outlook.office365.com (2a01:111:e400:4000::34) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.528.16 via Frontend Transport; Tue, 12 Jul 2016 09:44:13 +0000 Authentication-Results: spf=fail (sender IP is 192.88.168.50) smtp.mailfrom=nxp.com; 6wind.com; dkim=none (message not signed) header.d=none; 6wind.com; dmarc=fail action=none header.from=nxp.com; Received-SPF: Fail (protection.outlook.com: domain of nxp.com does not designate 192.88.168.50 as permitted sender) receiver=protection.outlook.com; client-ip=192.88.168.50; helo=tx30smr01.am.freescale.net; Received: from tx30smr01.am.freescale.net (192.88.168.50) by BY2FFO11OLC004.mail.protection.outlook.com (10.1.15.184) with Microsoft SMTP Server (TLS) id 15.1.534.7 via Frontend Transport; Tue, 12 Jul 2016 09:44:12 +0000 Received: from Tophie.ap.freescale.net (Tophie.ap.freescale.net [10.232.14.199]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id u6C9i96R004497; Tue, 12 Jul 2016 02:44:10 -0700 From: Shreyansh Jain To: CC: , Date: Tue, 12 Jul 2016 15:14:43 +0530 Message-ID: <1468316683-2184-1-git-send-email-shreyansh.jain@nxp.com> X-Mailer: git-send-email 2.7.4 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131127902531837632; (91ab9b29-cfa4-454e-5278-08d120cd25b8); () X-Forefront-Antispam-Report: CIP:192.88.168.50; IPV:NLI; CTRY:US; EFV:NLI; SFV:NSPM; SFS:(10009020)(6009001)(7916002)(2980300002)(1109001)(1110001)(339900001)(199003)(189002)(50466002)(48376002)(68736007)(7846002)(36756003)(356003)(47776003)(81166006)(81156014)(6806005)(104016004)(8676002)(8936002)(19580405001)(50226002)(86362001)(19580395003)(4326007)(189998001)(2906002)(85426001)(33646002)(106466001)(92566002)(5003940100001)(97736004)(110136002)(11100500001)(77096005)(87936001)(305945005)(50986999)(586003)(105606002)(229853001)(2351001); DIR:OUT; SFP:1101; SCL:1; SRVR:BLUPR0301MB1985; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; A:1; MX:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BY2FFO11OLC004; 1:Uv5Fwm8zPf/2T4jOPSvgVJ9YpQzGRp1+RhaIr9xF/Yiv+FnzdHsQiKVK3c7ilr24pgYC3fqcWSTYoXB7e74+aZQwV3QR0cdYCS9puFMGJuEGOVQzjzHRln4ndKdGuh/LBVN2A9uA1Mv/ZNmPVocXnuaQeaq36CkbKtSxlqQeXHFYyRHijur72kxyfw3Kj8kXsYK+O1ULmwnypcqTPS0FEZnaLDpAwjlg4IdN94YSAhoYL9n8gE+NWpvFE1yC+UYGqcv788JZMtZjNcHQUnSLpJWegijlPY8oaT7rq+yDNx/UC4Oyz7PZhcbZ28lVk9tllS9MCPVQeivtPv0KgQTpaLieTMn8W/K8hDefGTgiSDS4wrM0z021icDW4cy0N7Hol5sstnB1rzwNQXzNHuzwKUWzteCEp5TugyFB0r4D7fSKNDAutbg33vk/xvVy6nQLZGxOV3o1P42n/LurRkvzgvF8ySCfQBS3GbR/aMPNaabr6sXlokpLQZKCXrxacd2nx31Xlo7wKNmgFtHJ3X+i3PD9M42KGgndanOqzytuQfj6Yl9Of2Zn0yBV0xic1x/umYlTfmMTmFpD7oZ87VmcGQ== MIME-Version: 1.0 X-MS-Office365-Filtering-Correlation-Id: 460ce1ba-f32e-443d-5ec0-08d3aa391504 X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB1985; 2:7DhGPlXlAQltlXeFe/GOIzU6MXmxL9AZRpA3ug89g3AAAz7fY476MBQVpFJuK507esklnm+TVfal+OqctrDmjWZJG6sRC9N0z9a1YPDWgfpnROTxs7OSeTgmV/nKiXbpgmHiJmFM7nfiSf6IST4kbRliRffhlPHmwaQ/lbsjvmiM9DQ7OkCpwDdnFR62McD4; 3:VHL+Dh7BkawH/K6ScSGSlCA1tmDAXWr/u88RzmOGaZP2Zg01b+PhvDdUs/g+F+QAOONs//F5vtJBAxO9ro+hcChY9wpQ4m/YjQkYSkdJqS53OCSZxUuz18XtvV83Wby2kYlPl2VGI0JZQbDGFqKHs9Ytg092bToS5Arfyr53HiePqT6kmWtt4IvwS6QDF3u4KV63H4zrqnSMurmoR4Vo4uQQoAdiuaZbhQB0xAbHmPQ= X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BLUPR0301MB1985; X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB1985; 25:41qVCKHKz4ot2u4HuKbp6D6JHfWbQ9d8HTWzY6a+7glVPuyDRsBcTsR7wEMDNAmUrf38QihP4hHZT6B11+IneE5UxQOuFYGDKfc+S2rc7x6DI6JgaCtR2ETn/O9Cz8wQCgRLJDxqbSp2LnLgjbuzgKZauTlNH6YBjOr6tnnAnOvyyOTqQQF+CvrMA2bdWMmHeHuaS6puJ6gLrO+uBUiSz0N/PMrMdruB6aSq0dy7LZvVKSMfTqBoFczfTr8AGV0EBl7x8gzPNG+J+8cQx7bkP12igd0072V1q0Zjfrbloz4XIVdHwFCmHmdARu6/h1185ATycBVmxTbMex2vPknpbqSDjZBN3lkjQ5gUD/iKP5pidKQm+UsZwOAvxsuwMyZVpTflLIzwqlKZiJdXfgNJlIFWrePwOzlMhu1cf0kJUg6DrVDOej2A57xvxOVT6hnMWFIPFgHMJWhVvLWyZBlOyH8jGJBczbK8Za4RJ1/MjYNThjVImzvnCHKTofwrXHnYxV7+ssIlLYgbImBjZ3fosvdQnMKb/XJ1bEGDXXi0XGsRLb85bkQmZ6j9WZnMYhXYSrI2wivf5ATSRU8BxhsZ1nQ0HwYZwd9VGOkVLdv5OFE3biMl04IObCAB/M5mI5UerqaV6Dmm4sD0IBNB/VnFIRhfiMKpEOXN59vW5spBFnp5Cq0vqs4QhSpMCjNYK2uPdMrFbFHq5nvqUqSIFBL3KcE6Bv/WvdEqZe17V6nusrU=; 31:wb0C9HQvMB2R5wY9NLTENd3i+oRtn4umBdeEcJuH4p5erGZ1p6bRnp3Ct7T8XeBXB98VglI1FciuA5fhHCYq6+TdkFkw2qFCz71VuebhIyEScsLqQCrxNeH+/6emjXvXp12qsw+f9WfC6sCj2Yi8vfLzV1S1ZMrtcxxaLItE5G9q6yG/vsqmfWF5iz2YdrD50vzVJqhalPQ4jRBX+KDa7g== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(185117386973197); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(601004)(2401047)(13024025)(13023025)(13017025)(13015025)(13018025)(5005006)(8121501046)(10201501046)(3002001)(6055026); SRVR:BLUPR0301MB1985; BCL:0; PCL:0; RULEID:(400006); SRVR:BLUPR0301MB1985; X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB1985; 4:myMiGO+lpjTEoIQ2aLS4cWPjZ4XL5oVllqPhFKZG38gr1/U/GsSlAapZ4oMNgbml2+LvttNTkI3nN3RyB8ar0bBistSb3LkCuTpL5utx7WLAiTSk9GY5Xl6dDeYg40EJCMStCNg9O1kTEGIpLdKjTkrswWFK8BCHZTIl5Iwcg8GuNIm3ulKmeGPjcfuHNZ8nELKfhvnLm6HauRXASOcVbKU32KObkfzYYES1vIkLHckAH2KraoQ5vD1PzYlJ2lujiiibBkUxnvBER20qTSHtSIJJOMKTMGmpsyNQ+cwIzsVDqfndQyv8T9/bJ9eEGfvzeLIVUVSThP6uSsg9/ZNvDdV2QCxmN/R/7iTzjdMhs6W5pNQuy07uWr9itXQlYFIyNvr8s8GjkSdGkWANN3TfugY69BqTcQXls2C/aYR1b0NH27Z14+oVU2qRoW402B10cN5ULcNjLQuvQX4njdUQZzdoO0DkTVGhwD6JFWuy66VnDVc1TnwSjSqoJ/px5TvbQtjBqI3FJ6LlSOXzejQ+TA== X-Forefront-PRVS: 0001227049 X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; BLUPR0301MB1985; 23:nGp8qgTMMvUNxU3fmvQgQz4Evbu7xyFHW7BKVUB?= =?us-ascii?Q?TuQsinacPupRcEQGoBKc2zy4e5lPV8iFdrFzB/T48xpiQU+n68vUqEBF3Qcv?= =?us-ascii?Q?n0gRPiu0MTd4S3PeLklVKexAbr0vZTCz94ankfQrFDjGc9LacnrOdmSnHNkd?= =?us-ascii?Q?0UP2vq/Mt7hpy1dcUoUU0uYUHn9hh+7yn3J38IipJBTCdklqC7Hg3fDFC8cO?= =?us-ascii?Q?QIh/08C9RYOQZKo1tp4mv+gaAhFVJHvvW6C9TAHS7zduIwzfa93Zk4L33Yts?= =?us-ascii?Q?43UAm5ZSLjzt0wY3/zn3v+MCBoFjQALmOB0Elqtt+OZ++qOCc6x159DPOSmu?= =?us-ascii?Q?oVNKbBhefsPLXs1RUSad3tCZbsgw9nteAFYRzAORpbLvoMkxj1mX5QJcg50L?= =?us-ascii?Q?w+VXpqseSRpCfoquSgWvpsBGvZxjvZwyL5wlFtVy6/U2JGWgzQu3NQsi00/j?= =?us-ascii?Q?rokOUEOdjUishNtjaMKaFuTX6N6mzidrxE4wqnbJoqwvqoXw7h/bR8/CPglG?= =?us-ascii?Q?YZ89SL355lYe7W+j89XJjDmabUBC6ZicvHjtTQ+oMfS4K4v1DcAYtXicSkJ9?= =?us-ascii?Q?YQxJSbUIQUII0nDz6vmi1ygcflJSXDSn5Kpg/Nv3xLT+KS49DpwnOY72XXs1?= =?us-ascii?Q?qUy/ouuC91itGdv33B+sGm93hwC3lG9XgOMAr7+7W2VvWOw/WkFsRI2tRA9C?= =?us-ascii?Q?yof75rXjyx3OqxEr8Hi2nK3AoEjzyWs/XsHQwoS/5I9Q9lAnupHdJfoZYQyA?= =?us-ascii?Q?3QrESyOdyPnSBTVTHWHj2rLvuLzHtAPTpLYsF0UFIHftRI0y8BjmQY3/3f9z?= =?us-ascii?Q?GuqSJ8TQ+lgFLtFACacVyAzRHlQqU5aZibpLGMYfB1ClhtB8c8kXaeMCHueL?= =?us-ascii?Q?IUOsj7VbU01Jgrfp3LpDLINKxCWCP+vQq8M4q+Y4ldx/9BoSiEBkIaB2zXCw?= =?us-ascii?Q?R1uLWvZnHb3hM5fNDRI6fNGASIhGW5MMfwxXS6ushwWLla0FBnbKuHdJk2Hd?= =?us-ascii?Q?RXvWNnBx4sJ8HpQvsQWAR9sCpgYgBdKKXdCmvj48dtIKBwZAfk4d+oQIGmDk?= =?us-ascii?Q?RDzwFMfnYmZ2sJxXew6+N1P/msE4N?= X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB1985; 6:VYS5QuCySAAve/9JvbXj71izCnX1NVgXGouGC2IsVuZVlOFYrnTg70q8toNSTP9kUt2MJ8TEIgBqit12dwOSBl7xCZ5wpXTesXTp8VVxNu4vCmiCrWgEmRNAPnQoO2epPlyyCPNZDd8APcJrfrrjsYdSZU/O+u91HT5xZNECT7Gs4XLVElfv19lQd5lh/RF48CdhdIxRlsuiL6TXd+wFgf2v2IWt3ev2MLXHlujozjnDOlqZdDMaExycbPlIouz1imSX69sG6qGg1yBZXG9z7vufOtj3cLTAsyGzCxwbwkI=; 5:6N5fEyz0hvHpRqPyXmP8+AZNB2+xJFRtNwGbgw4mpJdr7l/q+QqIGoYKloxdVYHlYqdOg65dHesjnVGG1Ss3zvhi/ErNUl6T0higHD7LF4v5FPLUsOUpNt7qxI3XU9/Ged0CNAvZWOp5KVlWs5XJUs+bO8JqeLWfMgGdRQV8cIA=; 24:oCh4oo0xTjurEkgnJSAbH+RVMdBGylgjmPLxzGrFRla7RiukVCcQ+fcUYinnnrMYre51Q/Uixm7FeDVb5vUfGVnQR4PONjuQVleVDUg8qGc=; 7:QjDLKngAxtIF7X8lpH9W/Gs1MY2ZgyldwYm484LDYhqta1m5IczoqHE752ogAh1XQmBK+6D3uc4yDx7zU9lgaFHO7493oJLoHq2DUesbkin3EMbVBhy21Zz9YiKCraieMkfPPt+H845I28bGBsflUFHtbJbgkUXm/2lSaQPMt2e/3u+CoDlGQbs7fonrHOZK/kyuRiKXYZ1+7fVRK0j3gRq1ro0iF9b/cjh2MINnpE5wWOeUy6yGpqByVIJkHUVv SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Jul 2016 09:44:12.9809 (UTC) X-MS-Exchange-CrossTenant-Id: 5afe0b00-7697-4969-b663-5eab37d5f47e X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=5afe0b00-7697-4969-b663-5eab37d5f47e; Ip=[192.88.168.50]; Helo=[tx30smr01.am.freescale.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: BLUPR0301MB1985 Subject: [dpdk-dev] [PATCH] doc: fix consumer/producer mixup in Ring lib doc X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Signed-off-by: Shreyansh Jain Acked-by: John McNamara --- doc/guides/prog_guide/ring_lib.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/guides/prog_guide/ring_lib.rst b/doc/guides/prog_guide/ring_lib.rst index 3b92a8f..5cf4ce2 100644 --- a/doc/guides/prog_guide/ring_lib.rst +++ b/doc/guides/prog_guide/ring_lib.rst @@ -252,7 +252,7 @@ In this example, only the producer head and tail (prod_head and prod_tail) are m The initial state is to have a prod_head and prod_tail pointing at the same location. -Multiple Consumer Enqueue First Step +Multiple Producers Enqueue First Step ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ On both cores, *ring->prod_head* and ring->cons_tail are copied in local variables. @@ -266,10 +266,10 @@ If there is not enough room in the ring (this is detected by checking cons_tail) .. figure:: img/ring-mp-enqueue1.* - Multiple consumer enqueue first step + Multiple producer enqueue first step -Multiple Consumer Enqueue Second Step +Multiple Producers Enqueue Second Step ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The second step is to modify ring->prod_head in the ring structure to point to the same location as prod_next. @@ -288,10 +288,10 @@ In the figure, the operation succeeded on core 1, and step one restarted on core .. figure:: img/ring-mp-enqueue2.* - Multiple consumer enqueue second step + Multiple producer enqueue second step -Multiple Consumer Enqueue Third Step +Multiple Producers Enqueue Third Step ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The CAS operation is retried on core 2 with success. @@ -303,10 +303,10 @@ The core 1 updates one element of the ring(obj4), and the core 2 updates another .. figure:: img/ring-mp-enqueue3.* - Multiple consumer enqueue third step + Multiple producer enqueue third step -Multiple Consumer Enqueue Fourth Step +Multiple Producers Enqueue Fourth Step ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Each core now wants to update ring->prod_tail. @@ -318,10 +318,10 @@ This is only true on core 1. The operation is finished on core 1. .. figure:: img/ring-mp-enqueue4.* - Multiple consumer enqueue fourth step + Multiple producer enqueue fourth step -Multiple Consumer Enqueue Last Step +Multiple Producers Enqueue Last Step ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Once ring->prod_tail is updated by core 1, core 2 is allowed to update it too. @@ -332,7 +332,7 @@ The operation is also finished on core 2. .. figure:: img/ring-mp-enqueue5.* - Multiple consumer enqueue last step + Multiple producer enqueue last step Modulo 32-bit Indexes