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;
Content-Type: text/plain;
        charset=utf-8
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3731.400.51.1.1\))
Subject: Re: [PATCH v3 1/3] Docs/RCU/rculist_nulls: Specify type of the object
 in examples
From:   Alan Huang <mmpgouride@gmail.com>
In-Reply-To: <20230615181004.86850-2-sj@kernel.org>
Date:   Sat, 17 Jun 2023 01:46:16 +0800
Cc:     paulmck@kernel.org, Joel Fernandes <joel@joelfernandes.org>,
        corbet@lwn.net, rcu@vger.kernel.org, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Content-Transfer-Encoding: quoted-printable
Message-Id: <390935BF-9EC0-4D88-A277-7B37D68CC6C7@gmail.com>
References: <20230615181004.86850-1-sj@kernel.org>
 <20230615181004.86850-2-sj@kernel.org>
To:     SeongJae Park <sj@kernel.org>
Precedence: bulk


> 2023=E5=B9=B46=E6=9C=8816=E6=97=A5 02:10=EF=BC=8CSeongJae Park =
<sj@kernel.org> =E5=86=99=E9=81=93=EF=BC=9A
>=20
> The type of 'obj' in example code of rculist_nulls.rst is implicit.
> Provide the specific type of it before the example code.
>=20
> Suggested-by: aul E. McKenney <paulmck@kernel.org>

Paul E. McKenney

> Link: =
https://lore.kernel.org/rcu/43943609-f80c-4b6a-9844-994eef800757@paulmck-l=
aptop/
> Signed-off-by: SeongJae Park <sj@kernel.org>
> ---
> Documentation/RCU/rculist_nulls.rst | 14 +++++++++++++-
> 1 file changed, 13 insertions(+), 1 deletion(-)
>=20
> 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.
>=20
> 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;

atomic_t

> +    unsigned int key;
> +  };
>=20
> 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.
>=20
> +Note that using hlist_nulls means the type of 'obj_node' field of
> +'struct object' becomes 'struct hlist_nulls_node'.
> +
>=20
> 1) lookup algorithm
> -------------------
> --=20
> 2.25.1
>=20