From patchwork Thu Jun 15 18:10:02 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: SeongJae Park X-Patchwork-Id: 108680 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp837635vqr; Thu, 15 Jun 2023 11:32:43 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ59vgAB7lqj0YxEfLvph/+EFh5PXc4FAR0N2zl2S0uMGiSB5K2xhCRbLhqAs9/yiInhMKaj X-Received: by 2002:a05:6a00:2d0e:b0:666:7bc5:531c with SMTP id fa14-20020a056a002d0e00b006667bc5531cmr5488670pfb.24.1686853963640; Thu, 15 Jun 2023 11:32:43 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1686853963; cv=none; d=google.com; s=arc-20160816; b=zB2cqKPycFOlIV4s43JPfzvpmjBGiDkq65i9aUeODu9nDFul+DH5Rui4m6wgnIP/B0 Ju7R3Q9FMtXj6OOMNvOO7okSYMBcU40bCukBV3Wuo7X2GvpRByZF/MMVsb0A8PXxc6Rm RtzXlaBYaSlkf5NDUpvkzd9F5HY0t7fH6gQtyq4uHHAd687bmGwCcAC2MsB2TwqaAcJA b2k6ql73AbY6LRRuxCxHub+5idx71Ne7dHgGnGe1tG5atpL7oa+qD3vTdK68jhS2IH2P Esus1knziP1GsQkCz2zaAOgieKNvldqY3hsoQriJ7pAdlEjltAy/X8jTcuzoLrIPmXVT IwlA== 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=2fyEjJpA17f0rk8BRxwXcaYYxRsyKEc9xHuiT4Y0zJE=; b=kzwfiuC2bO3w/vrkjgk7a/gBEF6/gqt4IZReQCvBvP6+cRvn1FRnZTnmUul/3nCscZ wA/gccyzjmq0FXeS/p0SNwIjme2emtb5qdiRDHUfsvjIV0QWDRGXQqoy1b0xPz6OsfDs 2PfQv9rvoafUb4+gzf4wHvHt97UFOMgsRsSy0gCWuCy/rlfTkblWi1bz/MX6SKZ8Ikar HxZ4GpCBAIhPRGxRR+8005/kbsKS0iurLsQqyZDChOjwyFh0PKea3wsUve9xljlY5LM2 pt/2Zceh9D/pIcYKIOrKc6ZdqhLmuDn0xB1LppigHfOpxVJbyVWbpGVW3jf6F/1CSGeB VH2Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=CEZlK7GC; 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 bm18-20020a656e92000000b0052c7ad564e2si13839673pgb.707.2023.06.15.11.32.31; Thu, 15 Jun 2023 11:32:43 -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=CEZlK7GC; 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 S238307AbjFOSKX (ORCPT + 99 others); Thu, 15 Jun 2023 14:10:23 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:32970 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239387AbjFOSKM (ORCPT ); Thu, 15 Jun 2023 14:10:12 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2A2792960; Thu, 15 Jun 2023 11:10:12 -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 8905A6102A; Thu, 15 Jun 2023 18:10:11 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 586F0C433CB; Thu, 15 Jun 2023 18:10:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1686852611; bh=U6h6ZVnX1R+TPZKq+FI4cbLfEjWQ4SmBj/oLpCWrvdk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=CEZlK7GCdb9WE0sL23de54xVIUpj9JSjgpgizcOcQf65VgF3Y9YHrYcfE36RoYDCO jlJ9aTzLeztjAvJXhDxv2B5P0KPrtyFgHMch9XmU0P8ntPEwAdbRZmCJSEA8QNgIl5 GHORoF4RnwMkZBg4R3XkoY/ZgR7plNGJPf/PgBmAg9ybrQJQACTyOc2Apw12Ncvzvg 60BncB3GqgSNcWwqxv0UD1+YM+7dpRCKg5ewIUK+kNz1+D/h/iittKEKVOM2hw8HvI s8tNTMRPDrAQav5j4OXBCCjIkEO1czVyUaVt7d9u1bSqj3WJS02mZcylu0xF5xAEAB KfXc6WUzD9QgQ== 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 v3 1/3] Docs/RCU/rculist_nulls: Specify type of the object in examples Date: Thu, 15 Jun 2023 18:10:02 +0000 Message-Id: <20230615181004.86850-2-sj@kernel.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230615181004.86850-1-sj@kernel.org> References: <20230615181004.86850-1-sj@kernel.org> MIME-Version: 1.0 X-Spam-Status: No, score=-7.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_HI, 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?1768794581619921634?= X-GMAIL-MSGID: =?utf-8?q?1768794581619921634?= The type of 'obj' in example code of rculist_nulls.rst is implicit. Provide the specific type of it before the example code. Suggested-by: aul E. McKenney Link: https://lore.kernel.org/rcu/43943609-f80c-4b6a-9844-994eef800757@paulmck-laptop/ Signed-off-by: SeongJae Park --- Documentation/RCU/rculist_nulls.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/Documentation/RCU/rculist_nulls.rst b/Documentation/RCU/rculist_nulls.rst index 94a8bfe9f560..4b66e2fd2fb5 100644 --- a/Documentation/RCU/rculist_nulls.rst +++ b/Documentation/RCU/rculist_nulls.rst @@ -18,7 +18,16 @@ to solve following problem. Without 'nulls', a typical RCU linked list managing objects which are allocated with SLAB_TYPESAFE_BY_RCU kmem_cache can use the following -algorithms: +algorithms. Following examples assume 'obj' is a pointer to such +objects, which is having below type. + +:: + + struct object { + struct hlist_node obj_node; + refcount_t refcnt; + unsigned int key; + }; 1) Lookup algorithm ------------------- @@ -142,6 +151,9 @@ the beginning. If the object was moved to the same chain, then the reader doesn't care: It might occasionally scan the list again without harm. +Note that using hlist_nulls means the type of 'obj_node' field of +'struct object' becomes 'struct hlist_nulls_node'. + 1) lookup algorithm -------------------