From patchwork Fri Jun 16 23:36:25 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 109388 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp1702286vqr; Fri, 16 Jun 2023 17:35:00 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ4trPgwuB8e5eWQQ1aBQkg2QCXBFJPiMPlK2vDrOS+8fMdR1NSCGHXmVGvZM7EbG0MxGfP6 X-Received: by 2002:a17:902:f542:b0:1ac:b449:3528 with SMTP id h2-20020a170902f54200b001acb4493528mr4403751plf.46.1686962100335; Fri, 16 Jun 2023 17:35:00 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1686962100; cv=none; d=google.com; s=arc-20160816; b=YLib7SPS7UMR4SXEa+TWQAhQfOtYfYzsINEhzOiXZ1wrsVbIggGzkz31YCfYqQlU6x 722M8gppc5JLRYUagbq16ELGW7ZNiinzd47QlVGyonsL1sWulO0HZnw5ffEN2CCMgl95 X7L2AlKkzjw49SgeoDoYr8OBDp7Ux4OobKFZZHt0zUIJC5yD/1wx8E08SyjEt1yv6FpX 6KUmMkVQfo4ZayImvs5uZQgdJ7wxEETDEFloPMbXgkTrZvsOo0Z8pF2eh3/+fSeM9Upd WPaz4xQm/wqXekh2ijaUY3OMPxIVQBpGv4Hzd5/Lkuk/VN4FT0cvIvzHE3hOi6wpYHJD ik/A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=4AHQs7DO+kcT0HI+qJXK1jku3gcMsAa3e0krNKzTkvw=; b=kizNu1eyypxI5NutXRL2vD4ve3m8XeK9Y9oHtYkIzcK4NnLfXz39Dh7YZjYgBHF8Hw oLPG1ElGpF5yjvq8VcfxbG2ItmRIN22kTczGzs0bV6Uhsu9EdiM2rsCGk217HSO7HcqK 7sB2hs6svi5JCykNpai9GKC1xIv215G88ZBEdLWBGGvzmvvUvDto989wzSqJX0BbCujA ed+F+PUumpIh/AeacBzN1YwhIop34+c0pDgbfup3yOUytWKfmM7jsvJmmkG0/YWIhXL+ 8a8VkqpAGREph3D+//djVih4Rev4SsjuTx39bG7u22CAxBmhnXRcuULJ5wm6y3buEARz yKQA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b="ia/JrTVm"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id w14-20020a170902e88e00b001a979e702b2si1227985plg.416.2023.06.16.17.34.38; Fri, 16 Jun 2023 17:35:00 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b="ia/JrTVm"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1345823AbjFPXgo (ORCPT + 99 others); Fri, 16 Jun 2023 19:36:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49334 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1345789AbjFPXgj (ORCPT ); Fri, 16 Jun 2023 19:36:39 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4D6303AB8; Fri, 16 Jun 2023 16:36:34 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id CA76A62F12; Fri, 16 Jun 2023 23:36:33 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 940BEC433CA; Fri, 16 Jun 2023 23:36:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1686958593; bh=lBWgs+90Gck3vESACjS/SXnoZhAGTUFxSPAqJdGmdaU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=ia/JrTVmfO6NJ9ySd38aUtF/rqESYfPNIJAzKeZrON1qg4fubp0SM+oq1uibr+yYp oLu7MUKEaUVTJ//Bmrkv2EyBFocI6vbRHHhG9dx9Jhs2/FgmSJC9rmUYaz83TsYZ72 zApvWG0oRnHFRPrUy8qpQieYJaSaEnvma8sxapHlng01nW7xa58jf+RpMAFtI2LYI2 Y6R8dRwPcnoTxzqn3R4RnMNAbhgqgusnSk1hVhobDOGKGwI9JEtxBDCWkpRcK+VEHD xvBgu0QmlVfOlSG/Hyb2n/VLIwUI+/KjIGZmnoMMFCQ6nz+rv70V6odz/EEW/N6irU wmXoZENqEeHDw== From: SeongJae Park To: paulmck@kernel.org Cc: SeongJae Park , joel@joelfernandes.org, mmpgouride@gmail.com, corbet@lwn.net, rcu@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v4 2/3] Docs/RCU/rculist_nulls: Fix hlist_[nulls]_head field names of 'obj' Date: Fri, 16 Jun 2023 23:36:25 +0000 Message-Id: <20230616233626.83906-3-sj@kernel.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230616233626.83906-1-sj@kernel.org> References: <20230616233626.83906-1-sj@kernel.org> MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1768907971465738488?= X-GMAIL-MSGID: =?utf-8?q?1768907971465738488?= The example code snippets on rculist_nulls.rst are assuming 'obj' to have the 'hlist_head' or 'hlist_nulls_head' field named 'obj_node', but a sentence and some code snippets are wrongly calling 'obj->obj_node.next' as 'obj->obj_next', or 'obj->obj_node' as 'member'. Fix it. Signed-off-by: SeongJae Park --- Documentation/RCU/rculist_nulls.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/RCU/rculist_nulls.rst b/Documentation/RCU/rculist_nulls.rst index a6827cc31791..4afa11f2c906 100644 --- a/Documentation/RCU/rculist_nulls.rst +++ b/Documentation/RCU/rculist_nulls.rst @@ -63,7 +63,7 @@ but a version with an additional memory barrier (smp_rmb()) struct hlist_node *node, *next; for (pos = rcu_dereference((head)->first); pos && ({ next = pos->next; smp_rmb(); prefetch(next); 1; }) && - ({ obj = hlist_entry(pos, typeof(*obj), member); 1; }); + ({ obj = hlist_entry(pos, typeof(*obj), obj_node); 1; }); pos = rcu_dereference(next)) if (obj->key == key) return obj; @@ -75,7 +75,7 @@ And note the traditional hlist_for_each_entry_rcu() misses this smp_rmb():: struct hlist_node *node; for (pos = rcu_dereference((head)->first); pos && ({ prefetch(pos->next); 1; }) && - ({ obj = hlist_entry(pos, typeof(*obj), member); 1; }); + ({ obj = hlist_entry(pos, typeof(*obj), obj_node); 1; }); pos = rcu_dereference(pos->next)) if (obj->key == key) return obj; @@ -95,7 +95,7 @@ Quoting Corey Minyard:: 2) Insertion algorithm ---------------------- -We need to make sure a reader cannot read the new 'obj->obj_next' value +We need to make sure a reader cannot read the new 'obj->obj_node.next' value and previous value of 'obj->key'. Otherwise, an item could be deleted from a chain, and inserted into another chain. If new chain was empty before the move, 'next' pointer is NULL, and lockless reader can not @@ -163,7 +163,7 @@ Note that using hlist_nulls means the type of 'obj_node' field of head = &table[slot]; begin: rcu_read_lock(); - hlist_nulls_for_each_entry_rcu(obj, node, head, member) { + hlist_nulls_for_each_entry_rcu(obj, node, head, obj_node) { if (obj->key == key) { if (!try_get_ref(obj)) { // might fail for free objects rcu_read_unlock();