Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:5 as permitted sender) client-ip=2620:137:e000::3:5;
Message-ID: <2da0c9a0-ebb4-f7fa-89f6-d32ce558fa00@intel.com>
Date:   Mon, 25 Sep 2023 16:30:22 -0700
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101
 Firefox/102.0 Thunderbird/102.15.1
Subject: Re: [PATCH v5 7/8] x86/resctrl: Update documentation with Sub-NUMA
 cluster changes
Content-Language: en-US
To:     Tony Luck <tony.luck@intel.com>, Fenghua Yu <fenghua.yu@intel.com>,
        "Peter Newman" <peternewman@google.com>,
        Jonathan Corbet <corbet@lwn.net>,
        "Shuah Khan" <skhan@linuxfoundation.org>, <x86@kernel.org>
CC:     Shaopeng Tan <tan.shaopeng@fujitsu.com>,
        James Morse <james.morse@arm.com>,
        Jamie Iles <quic_jiles@quicinc.com>,
        Babu Moger <babu.moger@amd.com>,
        Randy Dunlap <rdunlap@infradead.org>,
        <linux-kernel@vger.kernel.org>, <linux-doc@vger.kernel.org>,
        <patches@lists.linux.dev>
References: <20230722190740.326190-1-tony.luck@intel.com>
 <20230829234426.64421-1-tony.luck@intel.com>
 <20230829234426.64421-8-tony.luck@intel.com>
From:   Reinette Chatre <reinette.chatre@intel.com>
In-Reply-To: <20230829234426.64421-8-tony.luck@intel.com>
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?R0d1K1JodkVVK1hzdUdMS253cTIrVEN6M0prcyt1NzI0a3Y4ZnJiY2xPOXJm?=
 =?utf-8?B?TktVYXZic3JJTHhMSnBQMG9RQ05nSjFRNjZXdFRHREgxR0xqTWM4UjU0Vmdm?=
 =?utf-8?B?cW5EMTVaNzNIeUM2Z0VxTG5STjVQOFM3V24rS21ldzE0N2JCMjFhV0h0S0pv?=
 =?utf-8?B?QkhxS3plQ1pFNzRMWlN1ZDN6Sys0MjJQeTFRRjlsaW9RRjl3MXA1S3cxZUJl?=
 =?utf-8?B?ZGxnVTdkMDRmemJkRTQ1aHBvUXJmYWgyUVhyNkZTaXpNS3VjbXkwaXFLUmZB?=
 =?utf-8?B?QUdvR0dIcWlWaHNXdkdJaXY4N2VpVUd1VGNjTytGYy9MbHdwNVhSbW9xUnZw?=
 =?utf-8?B?M2dldDBCVHRES1pxcVl0YVROQ3RWVFBoRGVZcmJUOGhCMlFZbzA0NEJ2VExx?=
 =?utf-8?B?bncrVE5seEI5aUFSLzJtS2lXblcybE5LVEl5MWNIa2RGVEhTemdZTUppVDVq?=
 =?utf-8?B?N21PQWhxY3BKMEFJRlZ4QnJGdk1DZkgvRHNHZ2RWK3gydmRTbUV5THNrQlhu?=
 =?utf-8?B?OTFqSWRrdW5FSWNERk9PUzFya2NuTU50dCszYVB0R0hFajJZVk1RMTNOZFZ3?=
 =?utf-8?B?b1BuOFJqV1lla3JDSTdoUXYyRFlxaTQyRmNKbHVYWFJHTzBOVWRvR2Q1Y1pm?=
 =?utf-8?B?c2wzTmkwUjJ2TjlVem00VHNESjBCQjl0ejlRM0NMdU9oamVxYktMTVFhVEV4?=
 =?utf-8?B?QlYyZEV4WkdGYWF3bGd2b0lBWjBwSXgxNks5alZ6ZTZSNXBaYU9xenBnV1VU?=
 =?utf-8?B?UytydEliUGtYa3VwNG1uY012cytjbHB5NStDTlhnQksrcXd3Z3pmVEcrMGRD?=
 =?utf-8?B?R01UK1hvaXNxWTRwY3pieCtqWE1aNG9BeEVxWStUVEFqWW5CUjVmOTNPN3NO?=
 =?utf-8?B?RUl6M3h1QnBHMHNmNFBBY210NzNZL3RPeUtuc09sWXRiS3hyYkJvMnR4VXR3?=
 =?utf-8?B?SmJ4Q1RqUUE5NkpPdVBZdUVENDZtL1BLVW5BVDFyVEdlYWt1U2lCVnhkN000?=
 =?utf-8?B?Nk5HaXlYY21Ec2pseG9Uamp6bndNSElJcTlJU01id0ZFVGFjOGJVNHllRlBn?=
 =?utf-8?B?MVNUZXJIQzU4R1pPM29TZkl4MmQ0K3d6YlBSYWpoTFViMGRuWHhZREFMaVVR?=
 =?utf-8?B?UVFSVE1JL0o2ZlphQ29GVmpQdHBnejI4eFVQYW8zdDdibmR1UDRwaEV1Sjly?=
 =?utf-8?B?aTgvL1V1TlU0ODJzaHJENFdNdG1mQmRzMHRXaitFUzMzMXZyMjRwbG5oUkRW?=
 =?utf-8?B?eFdGRVdQNi9yK1FPTC82U3NVSW0vd1hnV0lVOHhIeUxCdGZ5VnJoRERXMFJv?=
 =?utf-8?B?aEhxNFhKaDFib0VWOEtNN0YvODRsajczcXBLVGZjdlBwT0ZkUEVlM1o2VFJD?=
 =?utf-8?B?RlVnd1I4YlExRlNOS3RDYnJrNlBZSUN0OVpEV2ZBNm5FMkZ0cHdWQlBQM1pi?=
 =?utf-8?B?dEhkczQ4SUgvNUQ4VnNCeFRZWDg3N3VmREl0TklvK3F1MmlEdTBzQXN1UnBB?=
 =?utf-8?B?T1hXYm1Gb1doODMrQnRIS1duUDVFakoyV0ZrSGVwMWRDajRjWDM0MDNUcFhz?=
 =?utf-8?B?MTkxYng0aXhLNk1LdVEzUW5XWTFsMk81cUxBSmNyUUVnMFhDaGJ4MDN1ZmZG?=
 =?utf-8?B?V3FzWDRybUhFS1dnMEY3UHlNWisrMmUyMGpMZlRHRmNXTWh1dUVjNUxQbWhz?=
 =?utf-8?B?WU56TTB5TC91ckVSNWdVRm42UVhyaUxGM2NuRCs2UVBMTldqUVZOa3doUVFS?=
 =?utf-8?B?SUg2MFRlZXVOZk9zV05MRDV6YlovdWc4L2Zoc2J2MGRuQzBXM2VzbVVKdnRn?=
 =?utf-8?B?QVlLcDROYXpQMWZDWUY4Qk5uZ2lEUW5aMVpJSFZtMGt0eWVRT0daTHI0ZUl2?=
 =?utf-8?B?eXB0UDR6YWYwL2FXZFN6T3grVU12NkdtYzM1UEFIVjV6MXc4U0RhMDVXSnlr?=
 =?utf-8?B?NjA4SXhad1U4WUxZWWJOTWplcmdmM0JnUHVtTEpVNUVnRkxpUzY1YWU4MURL?=
 =?utf-8?B?dVJmcWpIdGptZjJhR2NMS0xtR0dEWjM3MCtNOG93L3hMQWVDWUNoOFBXK1VZ?=
 =?utf-8?B?YVN0MGFqbEl4QUo5RTNxNW4vdjlGNnYvZHd3cStFOGNSdXMwczdDUjVVcWw1?=
 =?utf-8?B?KzRoZlVYVnB1NHJjYjJzaFA3aDFJV3hPb0VTYWpBOXk3MnFrd25DS25WVFVh?=
 =?utf-8?B?ckE9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: ebc69206-fa9d-49a9-4a92-08dbbe1f6522
X-MS-Exchange-CrossTenant-AuthSource: SJ2PR11MB7573.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Sep 2023 23:30:25.4137
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 57FlH8Gdt8T20nLIX0pJT2uMcf9i/7cKI+EnIDmChR0y3rdHJyoWdzlhGLU0aWlZNeJnm5NKpbntVE2BsO8xt95FGORDpGgD5slu3LTUBho=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA3PR11MB7611
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-2.3 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS
	autolearn=unavailable autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on groat.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (groat.vger.email [0.0.0.0]); Mon, 25 Sep 2023 16:30:43 -0700 (PDT)

Hi Tony,

On 8/29/2023 4:44 PM, Tony Luck wrote:
> With Sub-NUMA Cluster mode enabled the scope of monitoring resources is
> per-NODE instead of per-L3 cache. Suffixes of directories with "L3" in
> their name refer to Sub-NUMA nodes instead of L3 cache ids.
> 
> Users should be aware that SNC mode also affects the amount of L3 cache
> available for allocation within each SNC node.
> 
> Signed-off-by: Tony Luck <tony.luck@intel.com>
> ---
>  Documentation/arch/x86/resctrl.rst | 25 ++++++++++++++++++++++---
>  1 file changed, 22 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/arch/x86/resctrl.rst b/Documentation/arch/x86/resctrl.rst
> index cb05d90111b4..407764f43f25 100644
> --- a/Documentation/arch/x86/resctrl.rst
> +++ b/Documentation/arch/x86/resctrl.rst
> @@ -345,9 +345,15 @@ When control is enabled all CTRL_MON groups will also contain:
>  When monitoring is enabled all MON groups will also contain:
>  
>  "mon_data":
> -	This contains a set of files organized by L3 domain and by
> -	RDT event. E.g. on a system with two L3 domains there will
> -	be subdirectories "mon_L3_00" and "mon_L3_01".	Each of these
> +	This contains a set of files organized by L3 domain or by NUMA
> +	node (depending on whether Sub-NUMA Cluster (SNC) mode is disabled
> +	or enabled respectively) and by RDT event. E.g. on a system with
> +	SNC mode disabled with two L3 domains there will be subdirectories
> +	"mon_L3_00" and "mon_L3_01". The numerical suffix refers to the
> +	L3 cache id.  With SNC enabled the directory names are the same,
> +	but the numerical suffix refers to the node id.
> +        Mappings from node ids to CPUs are available in the
> +        /sys/devices/system/node/node*/cpulist files. Each of these

Please be consistent with tabs vs spaces.

>  	directories have one file per event (e.g. "llc_occupancy",
>  	"mbm_total_bytes", and "mbm_local_bytes"). In a MON group these
>  	files provide a read out of the current value of the event for
> @@ -452,6 +458,19 @@ and 0xA are not.  On a system with a 20-bit mask each bit represents 5%
>  of the capacity of the cache. You could partition the cache into four
>  equal parts with masks: 0x1f, 0x3e0, 0x7c00, 0xf8000.
>  
> +Notes on Sub-NUMA Cluster mode
> +==============================
> +When SNC mode is enabled the "llc_occupancy", "mbm_total_bytes", and
> +"mbm_local_bytes" will only give accurate results for well behaved NUMA
> +applications. I.e. those that perform the majority of memory accesses
> +to memory on the local NUMA node to the CPU where the task is executing.
> +

Following our discussion of the cover letter I believe this will change to
be specific about what user space can expect and what is actually "accurate".

> +The cache allocation feature still provides the same number of
> +bits in a mask to control allocation into the L3 cache. But each
> +of those ways has its capacity reduced because the cache is divided
> +between the SNC nodes. The values reported in the resctrl
> +"size" files are adjusted accordingly.
> +
>  Memory bandwidth Allocation and monitoring
>  ==========================================
>  

Reinette