From patchwork Sun Sep 8 22:49:43 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Honnappa Nagarahalli X-Patchwork-Id: 173348 Delivered-To: patch@linaro.org Received: by 2002:a05:6e02:ce:0:0:0:0 with SMTP id r14csp3621996ilq; Sun, 8 Sep 2019 15:50:39 -0700 (PDT) X-Google-Smtp-Source: APXvYqyGBT9S1f7tdISqNB576GkmtCjVdInQbFcwrF7pBAe4zizqGKmQFVVZqQ3icbJTaUVjHRXX X-Received: by 2002:adf:dd04:: with SMTP id a4mr16294228wrm.340.1567983039294; Sun, 08 Sep 2019 15:50:39 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1567983039; cv=none; d=google.com; s=arc-20160816; b=NI0GgiB1ll0yuHi9PmvbQJaRuDCZLy5U9MPpgqlvG7DxWbpF4uenamxrX2J9pXRCpO l/oyiknBzoRfa9FcqbTFvzDbzZG2/6TS4aKzHHNQROft8IqwaXy1EKORUhMYGm8tWdTV sD3RgRk/o+mvNr+qmQduAGJ82iqZG7RGOF8yPrOn1iv+cYqAdrDGRuuB9PkpsMeV/j6M SsXzGyV8PMmsT7qvyWQRixn5hzF2XchG2Mz8pI+YEcZCx3SrNclQ4/5Y0fQViPg4wOJo nnO4W2ogx81RWPUd8gxliydtnuUyhiKomBHDNA/hcloHppD9ImB/mxGD2YJMDvWwg1ET YKRA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:references:in-reply-to :message-id:date:cc:to:from; bh=kvfGr4DKZy5j3QNPzfpyjUtZMohBZzTnp1s3rclQedI=; b=CYxHP8SKCiEkDKzAbH1pwr9WhcWIB4XmhgkdYVZR9S9/StJnMvRzlIeMvDw4CCUNZd FCvLB8wHxl6y0HXDjLYm1DeHn0B0C6lAuc1tnECilMWvX1GjW/Lvyb2EnPH67RYmryb3 jdsZExm2kCASSz2xdbupJqyFeyqzJtiCBinyd6B9TvlLHGuRAfGFnQieXueTAB8tzSDY uvoYLYH2BYMghCQwqWxcNsdPtkADweecqSpGSzvOKrDgpSVhhk3gIDJ7CkB/nn0HOu6B YVREh+f7PQ8/HqSSU+YL+bYjQGNdaVf8Ud9g7KCXnciucVAlspjZ+0zX/rOg2GknEkU9 McgA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of dev-bounces@dpdk.org designates 92.243.14.124 as permitted sender) smtp.mailfrom=dev-bounces@dpdk.org Return-Path: Received: from dpdk.org (dpdk.org. [92.243.14.124]) by mx.google.com with ESMTP id s22si12068055wrb.204.2019.09.08.15.50.39; Sun, 08 Sep 2019 15:50:39 -0700 (PDT) Received-SPF: pass (google.com: domain of dev-bounces@dpdk.org designates 92.243.14.124 as permitted sender) client-ip=92.243.14.124; Authentication-Results: mx.google.com; spf=pass (google.com: domain of dev-bounces@dpdk.org designates 92.243.14.124 as permitted sender) smtp.mailfrom=dev-bounces@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id CA92A1E9C5; Mon, 9 Sep 2019 00:50:38 +0200 (CEST) Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by dpdk.org (Postfix) with ESMTP id 80B1C1E9AE; Mon, 9 Sep 2019 00:50:37 +0200 (CEST) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id DBB01337; Sun, 8 Sep 2019 15:50:36 -0700 (PDT) Received: from qc2400f-1.austin.arm.com (qc2400f-1.austin.arm.com [10.118.12.34]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id CAFBC3F67D; Sun, 8 Sep 2019 15:50:36 -0700 (PDT) From: Honnappa Nagarahalli To: honnappa.nagarahalli@arm.com, konstantin.ananyev@intel.com Cc: dev@dpdk.org, stable@dpdk.org Date: Sun, 8 Sep 2019 17:49:43 -0500 Message-Id: <20190908224949.34851-2-honnappa.nagarahalli@arm.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190908224949.34851-1-honnappa.nagarahalli@arm.com> References: <20190908224949.34851-1-honnappa.nagarahalli@arm.com> Subject: [dpdk-dev] [PATCH 1/7] doc/rcu: fix typos X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Fix typos. Fixes: 64994b56cfd7 ("rcu: add RCU library supporting QSBR mechanism") Cc: stable@dpdk.org Signed-off-by: Honnappa Nagarahalli Reviewed-by: Ruifeng Wang Reviewed-by: Gavin Hu --- doc/guides/prog_guide/rcu_lib.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) -- 2.17.1 diff --git a/doc/guides/prog_guide/rcu_lib.rst b/doc/guides/prog_guide/rcu_lib.rst index 8fe5b1f73..c019dfca8 100644 --- a/doc/guides/prog_guide/rcu_lib.rst +++ b/doc/guides/prog_guide/rcu_lib.rst @@ -37,8 +37,8 @@ What is Quiescent State ----------------------- Quiescent State can be defined as "any point in the thread execution where the -thread does not hold a reference to shared memory". It is up to the application -to determine its quiescent state. +thread does not hold a reference to shared memory". It is the responsibility of +the application to determine its quiescent state. Let us consider the following diagram: @@ -76,7 +76,7 @@ Factors affecting the RCU mechanism It is important to make sure that this library keeps the overhead of identifying the end of grace period and subsequent freeing of memory, -to a minimum. The following explains how grace period and critical +to a minimum. The following paras explain how grace period and critical section affect this overhead. The writer has to poll the readers to identify the end of grace period. @@ -91,14 +91,14 @@ critical sections smaller requires additional CPU cycles (due to additional reporting) in the readers. Hence, we need the characteristics of a small grace period and large critical -section. This library addresses this by allowing the writer to do -other work without having to block until the readers report their quiescent -state. +section. This library addresses these characteristics by allowing the writer +to do other work without having to block until the readers report their +quiescent state. RCU in DPDK ----------- -For DPDK applications, the start and end of a ``while(1)`` loop (where no +For DPDK applications, the beginning and end of a ``while(1)`` loop (where no references to shared data structures are kept) act as perfect quiescent states. This will combine all the shared data structure accesses into a single, large critical section which helps keep the overhead on the @@ -106,11 +106,11 @@ reader side to a minimum. DPDK supports a pipeline model of packet processing and service cores. In these use cases, a given data structure may not be used by all the -workers in the application. The writer does not have to wait for all -the workers to report their quiescent state. To provide the required -flexibility, this library has a concept of a QS variable. The application -can create one QS variable per data structure to help it track the -end of grace period for each data structure. This helps keep the grace +workers in the application. The writer has to wait only for the workers that +use the data structure to report their quiescent state. To provide the required +flexibility, this library has a concept of a QS variable. If required, the +application can create one QS variable per data structure to help it track the +end of grace period for each data structure. This helps keep the length of grace period to a minimum. How to use this library