From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id 43CD6A0AC5 for <public@inbox.dpdk.org>; Wed, 1 May 2019 23:20:07 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 77CF614E8; Wed, 1 May 2019 23:20:06 +0200 (CEST) Received: from EUR04-VI1-obe.outbound.protection.outlook.com (mail-eopbgr80044.outbound.protection.outlook.com [40.107.8.44]) by dpdk.org (Postfix) with ESMTP id A1844137C for <dev@dpdk.org>; Wed, 1 May 2019 23:20:05 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=armh.onmicrosoft.com; s=selector1-arm-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=4Cbu2PbXsYDPVf8CEWE1EiwsCGqwwZqJYYhbYLyHXBs=; b=n6ByzgI2X7r1s0mNuR2jjSIdvmn3q/jzulz2yK/TCMk9aILv7p9hW/QS5rdufiGNJNzwpRHEIezR1ODUzOodxbXMKdIlDMWo4s5YiYI9O+m0pgYvGDOgzg5OxLhQp6CB5mRgBSGPn20Po3t7K9zzQ6vJlHUA9DzCs/U9HIl6Itw= Received: from VE1PR08MB5149.eurprd08.prod.outlook.com (20.179.30.152) by VE1PR08MB5053.eurprd08.prod.outlook.com (10.255.159.217) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1856.10; Wed, 1 May 2019 21:20:04 +0000 Received: from VE1PR08MB5149.eurprd08.prod.outlook.com ([fe80::9b6:3403:4386:78]) by VE1PR08MB5149.eurprd08.prod.outlook.com ([fe80::9b6:3403:4386:78%2]) with mapi id 15.20.1835.018; Wed, 1 May 2019 21:20:04 +0000 From: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com> To: "Mcnamara, John" <john.mcnamara@intel.com>, "Ananyev, Konstantin" <konstantin.ananyev@intel.com>, "stephen@networkplumber.org" <stephen@networkplumber.org>, "paulmck@linux.ibm.com" <paulmck@linux.ibm.com>, "Kovacevic, Marko" <marko.kovacevic@intel.com>, "dev@dpdk.org" <dev@dpdk.org> CC: "Gavin Hu (Arm Technology China)" <Gavin.Hu@arm.com>, Dharmik Thakkar <Dharmik.Thakkar@arm.com>, Malvika Gupta <Malvika.Gupta@arm.com>, Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>, nd <nd@arm.com>, nd <nd@arm.com> Thread-Topic: [dpdk-dev] [PATCH v9 3/4] doc/rcu: add lib_rcu documentation Thread-Index: AQHU/9G5T2Nf+Q1za0qFBlZG8//FHaZWJPGwgACiVJA= Date: Wed, 1 May 2019 21:20:04 +0000 Message-ID: <VE1PR08MB514964AE48868A15059AAAE2983B0@VE1PR08MB5149.eurprd08.prod.outlook.com> References: <20181122033055.3431-1-honnappa.nagarahalli@arm.com> <20190501035419.33524-1-honnappa.nagarahalli@arm.com> <20190501035419.33524-4-honnappa.nagarahalli@arm.com> <B27915DBBA3421428155699D51E4CFE23F609E03@IRSMSX103.ger.corp.intel.com> In-Reply-To: <B27915DBBA3421428155699D51E4CFE23F609E03@IRSMSX103.ger.corp.intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: authentication-results: spf=none (sender IP is ) smtp.mailfrom=Honnappa.Nagarahalli@arm.com; x-originating-ip: [217.140.111.135] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: bd754e1b-57de-4d16-f883-08d6ce7ac726 x-ms-office365-filtering-ht: Tenant x-microsoft-antispam: BCL:0; PCL:0; RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(5600141)(711020)(4605104)(4618075)(2017052603328)(7193020); SRVR:VE1PR08MB5053; x-ms-traffictypediagnostic: VE1PR08MB5053: x-ms-exchange-purlcount: 1 nodisclaimer: True x-microsoft-antispam-prvs: <VE1PR08MB50531D233D7F84A45DEE0ED6983B0@VE1PR08MB5053.eurprd08.prod.outlook.com> x-ms-oob-tlc-oobclassifiers: OLM:10000; x-forefront-prvs: 00246AB517 x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(376002)(366004)(346002)(136003)(39860400002)(396003)(199004)(189003)(486006)(76176011)(81166006)(73956011)(76116006)(81156014)(86362001)(229853002)(102836004)(66946007)(14454004)(8676002)(66476007)(66556008)(64756008)(66446008)(53936002)(5660300002)(478600001)(99286004)(11346002)(9686003)(446003)(25786009)(71200400001)(71190400001)(52536014)(7696005)(476003)(2201001)(72206003)(8936002)(966005)(2906002)(4326008)(186003)(26005)(305945005)(14444005)(6116002)(3846002)(6506007)(6246003)(55016002)(256004)(33656002)(66066001)(74316002)(110136005)(316002)(6306002)(68736007)(6436002)(54906003)(7736002)(2501003); DIR:OUT; SFP:1101; SCL:1; SRVR:VE1PR08MB5053; H:VE1PR08MB5149.eurprd08.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; received-spf: None (protection.outlook.com: arm.com does not designate permitted sender hosts) x-ms-exchange-senderadcheck: 1 x-microsoft-antispam-message-info: /xrkdtJcY2HJ20ihPAgCJfwbsfgZpyUzmOdebl5e5XMbGp5rdb2Ac9imd5V/UHZH76qVL3nAoRgbYME7u4uAfSb9vyHLQRU9K7knqZHxmrRObsUAN0fZOfhu9FyPb2R6i1YQZ1cPbtzAPSh2+IGObdIZYLjFXqPvuFGZkNcUjVB+lboWYPjdMpN7pgSD5px6frjIqtH/npKdmkJ84nGsqI61LgNuG8ukafang/9O3kJNvM5OP0ZzFvhYD79ITnUz6ePFxOUO2mmPQPayATQ0G3ORBujVQU5kKc9WVJnmxfZL6Iak6Af2PY+crY6KdS0F8LfdENnLyQ3ZtV1r7hvn0wlTDc874ihn/Y47cI1OxplfdpGh6q/JfzyjT3eE5L6h/ytUZy+yUCuBCj4z2FyLQgXUS1Rah4sDtsxMZ3UG/es= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-OriginatorOrg: arm.com X-MS-Exchange-CrossTenant-Network-Message-Id: bd754e1b-57de-4d16-f883-08d6ce7ac726 X-MS-Exchange-CrossTenant-originalarrivaltime: 01 May 2019 21:20:04.0935 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: f34e5979-57d9-4aaa-ad4d-b122a662184d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-Transport-CrossTenantHeadersStamped: VE1PR08MB5053 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 <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org> Message-ID: <20190501212004.qqig8be509QgL1CWlxM3TAYzV69qwgvDGIN2pqWST-0@z> > > Subject: [dpdk-dev] [PATCH v9 3/4] doc/rcu: add lib_rcu documentation > > > > Add lib_rcu QSBR API and programmer guide documentation. > > > > Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com> > > Reviewed-by: Marko Kovacevic <marko.kovacevic@intel.com> >=20 > Some minor comments below. Nothing blocking. Thanks John for the comments. Thomas, please let me know if you want me to re-spin. Otherwise, these will= be fixed as a follow up patch. >=20 >=20 > > > > +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. >=20 > These would be better as a bullet or number list. >=20 >=20 >=20 > > +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.* >=20 > The image would be better like this (as recommended in the docs: > http://doc.dpdk.org/guides/contributing/documentation.html#images) >=20 >=20 > .. _figure_quiescent_state: >=20 > .. figure:: img/rcu_general_info.* >=20 > Phases in the Quiescent State model. >=20 >=20 > However, it isn't worth a re-spin. I'll send you on a file with the sugge= sted > changes. >=20 >=20 > Acked-by: John McNamara <john.mcnamara@intel.com> >=20