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;
Message-ID: <691aa8fc-43e1-7393-0092-f3198e5b34d6@amd.com>
Date:   Tue, 11 Apr 2023 16:27:50 +0530
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101
 Thunderbird/91.13.1
Subject: Re: [PATCH 2/2] x86/Documentation: Add documentation about cluster
Content-Language: en-US
To:     Bagas Sanjaya <bagasdotme@gmail.com>, linux-kernel@vger.kernel.org
Cc:     tglx@linutronix.de, mingo@redhat.com, bp@alien8.de,
        dave.hansen@linux.intel.com, hpa@zytor.com, corbet@lwn.net,
        jgross@suse.com, andrew.cooper3@citrix.com, peterz@infradead.org,
        Jason@zx2c4.com, thomas.lendacky@amd.com, puwen@hygon.cn,
        x86@kernel.org, linux-doc@vger.kernel.org
References: <20230410163527.1626-1-kprateek.nayak@amd.com>
 <20230410163527.1626-3-kprateek.nayak@amd.com> <ZDTa1PbEqcyrhJsU@debian.me>
From:   K Prateek Nayak <kprateek.nayak@amd.com>
In-Reply-To: <ZDTa1PbEqcyrhJsU@debian.me>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?TDJSNzhCSE94dFR6WTNaS3RrMUwvOWM4emJtWEE0TW9VbmlRMm1MZE5Kc3hY?=
 =?utf-8?B?UEZzSVpScnhkdlN5RmNueEo2WXZoekZWSUpyMnZxWGFiWWNlTHgrYXhKRUZT?=
 =?utf-8?B?dDN5Nm5YZlZiWDlZaVdXN2dVbTlFU25aSUJYSG9uanE0am0yR2tVeFJQWXE5?=
 =?utf-8?B?NU9jdVIwSWI4bE4remRsR2FYb0Z6akM4cHM5TGxCYnBmbFB4ZW9KTUtSMnRK?=
 =?utf-8?B?VFJ6ZEtuK0ZUUGN5VWp6UG1Lb21sUE52bERmN0ZwK0o2WU4wR3phdXhyRWJq?=
 =?utf-8?B?QmVpYkZNSkxob3AxS1lWcFpSWUNuNmk5TTE3OUdWdS95UzczbytnUXZ3NHRQ?=
 =?utf-8?B?MkZVeCtDb1NHNGErUjYxV2h3THhwR3RJNlZKWmR0VkhkcGFFTTA5SG1wdldw?=
 =?utf-8?B?K0tHN2F0Z0daTFhHa3NpQVhFem5lRzQrQWpCQi9ySmlnVjM4dnZtZEJsenVk?=
 =?utf-8?B?b0xlNGFOdjVHSzVmb2FwWERKSzBoNjJWRmpSZEgrOUZrbGxRYmY0NWJhNnY0?=
 =?utf-8?B?WWpoVmhka3AyNHBFdEk1ZG5STSs4QW5zMnROaTB4K3haSUZ4d1RBZmZTVGxr?=
 =?utf-8?B?bVJvMmxoZXRiRjhaR3JUbkxLSUtaT0dpU05ZcWtXM0d4OXNGaEhaSjZQSVZH?=
 =?utf-8?B?RVBuc0cwWG1UakRHdEVCZy9CY2tYRlBCWTcvM243eDJJZUFlZmxpOEM5cHZo?=
 =?utf-8?B?akRXN21pdjQ2dEhMK0NjUGJYLzBsa3ZDdndGazlVdWNqakZIb3VlR0xVbkRG?=
 =?utf-8?B?NzRRTDRBTkFFNEU5dDdaczMrYWozRzVuOHhBT0lOaFAwMVJsWXorckJYd2tx?=
 =?utf-8?B?SnA4M2dOTW1xV1JSM0srMXZpK3pRYmdlNGhveXlOSVJSdWFadzlqTGN0TzJ0?=
 =?utf-8?B?L2ZwQTU2V2FMR0xhcFJUdWhJVXRmblgydTRrdGZiVmJlMW1jc3A0RDlLaUdi?=
 =?utf-8?B?NjkzYmlRUFdWUWxqbzMzVnd5SFZoYTArN1ZTRGg4ek04Z2g2U0xGanhPWTFx?=
 =?utf-8?B?QmEzYnV5N1d2cEU0em1GRDRGVFNzYXlnVjVzSUVDZDVYMXpDdy9SWFRIaE5t?=
 =?utf-8?B?dzFjbTVmSFFxTmFyaTY4eWZHOVZDN1ZtbWMwTFBXK3Ava2dnRzlCbS81anYx?=
 =?utf-8?B?V0NOMmM2aWNBdkZqdEppNE1rNHU3RWIxd3J0dVd4U3B5d01WbjFrN3pSdGRu?=
 =?utf-8?B?K05pKzFHcndhemRnSTVrZEhUSnFTc040akZHNmFjM2xUNmEzRE9sSDVRWkFs?=
 =?utf-8?B?aVhmaUE1QkZ2cjI1NU95bFllRUZkbTNyUnpxc0JVdjZFTXVHVUJxSHBBcWRx?=
 =?utf-8?B?cE5ON2hPeHp5K0RkTWp3QkdXYXJ1UVJzMnMzMDhLbHdwRC8xa0ZHM3VKa2xR?=
 =?utf-8?B?MHFpdjVaMkhRK3g2SENHbUFLUzcrMlRIQUlReGtvV2lieUQ3T2xPODdsdWla?=
 =?utf-8?B?WHlGTVI2NEpjZEgyUS9xNHMrdG1wYkJQa2JtcHlzOENLYVV4R3RVQTNsc3JO?=
 =?utf-8?B?R1FOUklFQUp4TDFlMWRlZGhEc3pHVHVHdzVPcFVPMWFVeTI2TUZERlVkVHJK?=
 =?utf-8?B?VzJJbHAxVWVqQWVVdjBZWm5yK2trNXJPajZPSDN6ZDdrbG9CTW5RcjJBelZp?=
 =?utf-8?B?Q1JIb05vYWpENEg0MjVNL0J0bDlRUmhuVU4xY005QnduY1NSNVpqTXE1eWM1?=
 =?utf-8?B?WlVDaFAreUNEZHllY2d5WUhxTUJZSXg2b2d2a2MvdytmbEN6VHByaFRCWlBZ?=
 =?utf-8?B?NHJtRDdGS0RlcTlNeDRQWllMMXpLQjJSbjBGejlqZmJiYXhvditCV2VmeFZ5?=
 =?utf-8?B?L2NHL2w2cThFblBTam5vVWVWMVZRMWRJRnV0VXBYM0t2T3NrY3NaUG52WU5S?=
 =?utf-8?B?cFJXS1VxSGsycFVhZDlOdi9nWXpXR3F0alg1QVZraHBmODR0cE56YWVyUlNl?=
 =?utf-8?B?d1ZWVjRBSld3Yk9uS0JLQ0FFVk9CaXdvT0cxYWZ1NDdiYlBYMkJVcVcxLzUy?=
 =?utf-8?B?cVRabUwzK2p1bWVrNTc4a0JNd3NKVTc4cm1zL3lENzBiRkIxcXlNVHQwVUZZ?=
 =?utf-8?B?TE9NMHhUWENvOW43NkY1VmRjamowV2dxNFd3aFJ2OExjdm9OS25yaGhpREVE?=
 =?utf-8?Q?WYb1IWGnUIUQqd2ZhC6NH3n/r?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 0e2b550c-f3ba-420b-68f1-08db3a7b9f36
X-MS-Exchange-CrossTenant-AuthSource: MW2PR12MB2379.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 11 Apr 2023 10:58:03.3284
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: fjPWmFcPnyA0ssXAVNnurPu5LAqXJJ/Mf0pU8IA8CFTeVPdbXO/hXyuX+RWshNvK9hlcKxbT1lt1yQ41w8q2Nw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO6PR12MB5473
X-Spam-Status: No, score=-1.4 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
        DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,NICE_REPLY_A,
        RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_NONE
        autolearn=unavailable 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: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Hello Bagas,

On 4/11/2023 9:28 AM, Bagas Sanjaya wrote:
> On Mon, Apr 10, 2023 at 10:05:27PM +0530, K Prateek Nayak wrote:
>> diff --git a/Documentation/x86/topology.rst b/Documentation/x86/topology.rst
>> index 7f58010ea86a..35991d8cdef1 100644
>> --- a/Documentation/x86/topology.rst
>> +++ b/Documentation/x86/topology.rst
>> @@ -33,6 +33,7 @@ historical nature and should be cleaned up.
>>  The topology of a system is described in the units of:
>>  
>>      - packages
>> +    - cluster
>>      - cores
>>      - threads
>>  
>> @@ -90,6 +91,27 @@ Package-related topology information in the kernel:
>>          Cache. In general, it is a number identifying an LLC uniquely on the
>>          system.
>>  
>> +
>> +Clusters
>> +========
>> +A cluster consists of 1 or more threads. It does not matter whether the threads
>> +are SMT- or CMT-type threads. All the threads of a cluster share the same L2
>> +cache.
>> +
>> +Cluster-related topology information in the kernel:
>> +
>> +  - cluster_id:
>> +
>> +    A per-CPU variable containing:
>> +
>> +      - On Intel, the common upper bits of APIC ID of the list of CPUs sharing
>> +        the L2 Cache with lower bits set to 0.
>> +
>> +      - On AMD, with Topology Extension, the common upper bits of the Extended
>> +        APIC ID of the list of CPUs sharing the L2 Cache, left shifted to
>> +        remove trailing 0s.
>> +
>> +
>>  Cores
>>  =====
>>  A core consists of 1 or more threads. It does not matter whether the threads
>> @@ -125,6 +147,11 @@ Thread-related topology information in the kernel:
>>  
>>      The number of online threads is also printed in /proc/cpuinfo "siblings."
>>  
>> +  - topology_cluster_cpumask():
>> +
>> +    The cpumask contains all online threads in the cluster to which a thread
>> +    belongs.
>> +
>>    - topology_sibling_cpumask():
>>  
>>      The cpumask contains all online threads in the core to which a thread
>> @@ -138,6 +165,10 @@ Thread-related topology information in the kernel:
>>  
>>      The physical package ID to which a thread belongs.
>>  
>> +  - topology_cluster_id();
>> +
>> +    The ID of the cluster to which a thread belongs.
>> +
>>    - topology_core_id();
>>  
>>      The ID of the core to which a thread belongs. It is also printed in /proc/cpuinfo
> 
> The doc LGTM, thanks!
> 
> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

Thank you for reviewing the patch :)

--
Thanks and Regards,
Prateek