From: Gavin Shan <gshan@redhat.com>
To: Andrew Jones <drjones@redhat.com>
Cc: devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
rdunlap@infradead.org, robh+dt@kernel.org, shan.gavin@gmail.com
Subject: Re: [PATCH v4] Documentation, dt, numa: Add note to empty NUMA node
Date: Fri, 25 Jun 2021 18:36:48 +1000 [thread overview]
Message-ID: <41643136-798b-a0f3-aee7-b6af94a2fc67@redhat.com> (raw)
In-Reply-To: <20210625070656.j373hveemf5cdch4@gator>
On 6/25/21 5:06 PM, Andrew Jones wrote:
> On Fri, Jun 25, 2021 at 09:02:17AM +0200, Andrew Jones wrote:
>> On Fri, Jun 25, 2021 at 01:23:38PM +0800, Gavin Shan wrote:
>>> The empty memory nodes, where no memory resides in, are allowed.
>>> For these empty memory nodes, the 'len' of 'reg' property is zero.
>>> The NUMA node IDs are still valid and parsed, but memory can be
>>> added to them through hotplug afterwards. I finds difficulty to
>>> get where it's properly documented.
>>>
>>> So lets add note to empty memory nodes in the NUMA binding doc.
>>>
>>> Signed-off-by: Gavin Shan <gshan@redhat.com>
>>> ---
>>> Documentation/devicetree/bindings/numa.txt | 4 ++++
>>> 1 file changed, 4 insertions(+)
>>>
>>> diff --git a/Documentation/devicetree/bindings/numa.txt b/Documentation/devicetree/bindings/numa.txt
>>> index 21b35053ca5a..0fc882e44270 100644
>>> --- a/Documentation/devicetree/bindings/numa.txt
>>> +++ b/Documentation/devicetree/bindings/numa.txt
>>> @@ -109,6 +109,10 @@ Example:
>>> Dual socket system consists of 2 boards connected through ccn bus and
>>> each board having one socket/soc of 8 cpus, memory and pci bus.
>>>
>>> +Note that empty memory nodes, which no memory resides in, are allowed.
>>> +The NUMA node IDs in these empty memory nodes are still valid, but
>>> +memory can be added into them through hotplug afterwards.
>>
>> Please change the second sentence to:
>>
>> The NUMA node IDs in these empty memory nodes are still valid and
>> memory may be added into them through hotplug afterwards.
>>
>> But, this doesn't look like the right place for this paragraph. You're
>> adding the paragraph to the example section, but the example doesn't have
>> any empty memory nodes.
>>
>> I think the paragraph should be added to section "2 - numa-node-id" and an
>
> Or maybe even create a new section for it.
>
>> example empty memory node should be provided. Also, the commit message
>> talks about the length of 'reg' being zero, which is an important
>> distinction which should also be documented.
>>
Drew, thanks for your comments. Yeah, it sounds sensible to create
a new section for it and an example would be more helpful. Please
check if below changes are fine to you. I probably need Randy's review
again.
I'm trying to avoid too many revisions for this sort of trivial patch,
even though I already had. However, it's time frame for v5.14 and I'm
pushing this to be merged during the cycle.
--- a/Documentation/devicetree/bindings/numa.txt
+++ b/Documentation/devicetree/bindings/numa.txt
@@ -103,7 +103,65 @@ Example:
};
==============================================================================
-4 - Example dts
+4 - Empty memory node
+==============================================================================
+
+Empty memory nodes, which no memory resides in, are allowed. The 'length'
+field of 'reg' property is zero, but 'base-address' is dummy and invalid
+for these empty memory nodes. However, the NUMA node IDs and distance maps
+for them are still valid, but memory may be added into them through hotplug
+afterwards.
+
+Example:
+
+ memory@0 {
+ device_type = "memory";
+ reg = <0x0 0x0 0x0 0x80000000>;
+ numa-node-id = <0>;
+ };
+
+ memory@0x80000000 {
+ device_type = "memory";
+ reg = <0x0 0x80000000 0x0 0x80000000>;
+ numa-node-id = <1>;
+ };
+
+ /* Empty memory node */
+ memory@0x100000000 {
+ device_type = "memory";
+ reg = <0x1 0x0 0x0 0x0>;
+ numa-node-id = <2>;
+ };
+
+ /* Empty memory node */
+ memory@0x180000000 {
+ device_type = "memory";
+ reg = <0x1 0x80000000 0x0 0x0>;
+ numa-node-id = <3>;
+ };
+
+ distance-map {
+ compatible = "numa-distance-map-v1";
+ distance-matrix = <0 0 10>,
+ <0 1 20>,
+ <0 2 40>,
+ <0 3 20>,
+ <1 0 20>,
+ <1 1 10>,
+ <1 2 20>,
+ <1 3 40>,
+ <2 0 40>,
+ <2 1 20>,
+ <2 2 10>,
+ <2 3 20>,
+ <3 0 20>,
+ <3 1 40>,
+ <3 2 20>,
+ <3 3 10>;
+ };
+
+==============================================================================
+5 - Example dts
==============================================================================
Dual socket system consists of 2 boards connected through ccn bus and
Thanks,
Gavin
next prev parent reply other threads:[~2021-06-25 8:37 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-25 5:23 [PATCH v4] Documentation, dt, numa: Add note to empty NUMA node Gavin Shan
2021-06-25 5:29 ` Randy Dunlap
2021-06-25 7:02 ` Andrew Jones
2021-06-25 7:06 ` Andrew Jones
2021-06-25 8:36 ` Gavin Shan [this message]
2021-06-25 10:18 ` Andrew Jones
2021-06-25 11:14 ` Gavin Shan
2021-06-28 8:34 ` Andrew Jones
2021-06-28 9:38 ` Gavin Shan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=41643136-798b-a0f3-aee7-b6af94a2fc67@redhat.com \
--to=gshan@redhat.com \
--cc=devicetree@vger.kernel.org \
--cc=drjones@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=robh+dt@kernel.org \
--cc=shan.gavin@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).