From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id 7F3DAA0AC5 for ; Wed, 1 May 2019 13:38:04 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 601E432A5; Wed, 1 May 2019 13:38:03 +0200 (CEST) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id CC8C61F28 for ; Wed, 1 May 2019 13:38:01 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga008.jf.intel.com ([10.7.209.65]) by fmsmga102.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 01 May 2019 04:38:00 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.60,417,1549958400"; d="scan'208";a="138974623" Received: from irsmsx102.ger.corp.intel.com ([163.33.3.155]) by orsmga008.jf.intel.com with ESMTP; 01 May 2019 04:37:58 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.30]) by IRSMSX102.ger.corp.intel.com ([169.254.2.21]) with mapi id 14.03.0415.000; Wed, 1 May 2019 12:37:57 +0100 From: "Mcnamara, John" To: Honnappa Nagarahalli , "Ananyev, Konstantin" , "stephen@networkplumber.org" , "paulmck@linux.ibm.com" , "Kovacevic, Marko" , "dev@dpdk.org" CC: "gavin.hu@arm.com" , "dharmik.thakkar@arm.com" , "malvika.gupta@arm.com" Thread-Topic: [dpdk-dev] [PATCH v9 3/4] doc/rcu: add lib_rcu documentation Thread-Index: AQHU/9G5T2Nf+Q1za0qFBlZG8//FHaZWJPGw Date: Wed, 1 May 2019 11:37:56 +0000 Message-ID: References: <20181122033055.3431-1-honnappa.nagarahalli@arm.com> <20190501035419.33524-1-honnappa.nagarahalli@arm.com> <20190501035419.33524-4-honnappa.nagarahalli@arm.com> In-Reply-To: <20190501035419.33524-4-honnappa.nagarahalli@arm.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_NT x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiMjk3YzUxOTQtMmFkYy00MjlmLThmM2ItNDY5NzgxN2QzZDk5IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiVXNjTCtyOEpBVFJjYmhKS25ZQndGWGtYKzBnSmVaQlZkOFcxcjFQTHdXVUIzK3F1alwvc0tRdnNcL0o3K2xZUmJ3In0= dlp-product: dlpe-windows dlp-version: 11.0.600.7 dlp-reaction: no-action x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v9 3/4] doc/rcu: add lib_rcu documentation 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" Message-ID: <20190501113756._DfhdbCH1U0V5s7HgIjlwsPxXFv4aWyzsPDKQH6Cssg@z> > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Honnappa Nagarahalli > Sent: Wednesday, May 1, 2019 4:54 AM > To: Ananyev, Konstantin ; > stephen@networkplumber.org; paulmck@linux.ibm.com; Kovacevic, Marko > ; dev@dpdk.org > Cc: honnappa.nagarahalli@arm.com; gavin.hu@arm.com; > dharmik.thakkar@arm.com; malvika.gupta@arm.com > Subject: [dpdk-dev] [PATCH v9 3/4] doc/rcu: add lib_rcu documentation >=20 > Add lib_rcu QSBR API and programmer guide documentation. >=20 > Signed-off-by: Honnappa Nagarahalli > Reviewed-by: Marko Kovacevic Some minor comments below. Nothing blocking. > > +Delete: in this step, the writer removes the reference to the element > +from the data structure but does not return the associated memory to > +the allocator. This will ensure that new readers will not get a > +reference to the removed element. Removing the reference is an atomic > operation. > + > +Free(Reclaim): in this step, the writer returns the memory to the > +memory allocator, only after knowing that all the readers have stopped > +referencing the deleted element. These would be better as a bullet or number list. > +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. > + > +Let us consider the following diagram: > + > +.. figure:: img/rcu_general_info.* The image would be better like this (as recommended in the docs: http://doc= .dpdk.org/guides/contributing/documentation.html#images) .. _figure_quiescent_state: .. figure:: img/rcu_general_info.* Phases in the Quiescent State model. However, it isn't worth a re-spin. I'll send you on a file with the suggest= ed changes. Acked-by: John McNamara