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: <ea72280d-cf15-b1e4-17d2-966de7f6394e@intel.com>
Date:   Wed, 4 Jan 2023 16:30:22 -0800
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101
 Firefox/102.0 Thunderbird/102.6.1
Subject: Re: [PATCH v10 13/13] Documentation/x86: Update resctrl.rst for new
 features
Content-Language: en-US
To:     Babu Moger <babu.moger@amd.com>, <corbet@lwn.net>,
        <tglx@linutronix.de>, <mingo@redhat.com>, <bp@alien8.de>
CC:     <fenghua.yu@intel.com>, <dave.hansen@linux.intel.com>,
        <x86@kernel.org>, <hpa@zytor.com>, <paulmck@kernel.org>,
        <akpm@linux-foundation.org>, <quic_neeraju@quicinc.com>,
        <rdunlap@infradead.org>, <damien.lemoal@opensource.wdc.com>,
        <songmuchun@bytedance.com>, <peterz@infradead.org>,
        <jpoimboe@kernel.org>, <pbonzini@redhat.com>,
        <chang.seok.bae@intel.com>, <pawan.kumar.gupta@linux.intel.com>,
        <jmattson@google.com>, <daniel.sneddon@linux.intel.com>,
        <sandipan.das@amd.com>, <tony.luck@intel.com>,
        <james.morse@arm.com>, <linux-doc@vger.kernel.org>,
        <linux-kernel@vger.kernel.org>, <bagasdotme@gmail.com>,
        <eranian@google.com>, <christophe.leroy@csgroup.eu>,
        <jarkko@kernel.org>, <adrian.hunter@intel.com>,
        <quic_jiles@quicinc.com>, <peternewman@google.com>
References: <20221222233127.910538-1-babu.moger@amd.com>
 <20221222233127.910538-14-babu.moger@amd.com>
From:   Reinette Chatre <reinette.chatre@intel.com>
In-Reply-To: <20221222233127.910538-14-babu.moger@amd.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?VTdTWUNVTWJqMEZGQnpKUkl3c0JISmlkWmxmQVl1NlJiZXZnQUdqdWc5cTBo?=
 =?utf-8?B?UWJiUWJCeUxLbG1sZFVyZWVvRmg2aXZxTHM4YjVKcGwwbm5aNlJObENRQ2N1?=
 =?utf-8?B?a2FtM3FJZmUybzhnRWE5YjZnUnM0ZFQxZDdiaFY0b3FKWlJrOHQ3RVd2U2p1?=
 =?utf-8?B?WHBuNTJXRmRCcTFqdE9QS1hwdmd3Ti9lMUNRR2tYRlM3dzlURklSRTZ3SHg1?=
 =?utf-8?B?NVBvOXJ5ZnFaRDNLVEFoZmpqcUVjUHk4QWhJb2xsSVRIbkdqOGowcHJ2Y3Zk?=
 =?utf-8?B?RlBHdlhPWGJwYkdzK0lwU09pSmY0WUhEazRzMjBTR1A1YjQyWUdMdWFWOU5D?=
 =?utf-8?B?dVpncmlKenlnVktaWEtUS3VXTjN5MVlJVGVWdE5XTWhvdG1iQUlsSVViK0FF?=
 =?utf-8?B?VkY1L1BsODFhbXpRdmx3NjRBTk5rdHlmZmNxREdzUittZ0x5N1lwWnY1RnBZ?=
 =?utf-8?B?MVovUjVRRDQ1V0l0U1QxaFMybUJjUVBWWm1XUWp0YXE2MExPUmZRZ25CTE8y?=
 =?utf-8?B?Uncvd0d3R2JrN0NmMkQ5OSthRWE3akt3MFp0RzRlNmFCb3Z3SDgyV1lOQmhI?=
 =?utf-8?B?NG5xU1FnMkkza1gxeTNxRGNxWTkvYzl3T1FxNXZNWUlVQnFWck5MbGpWYi83?=
 =?utf-8?B?SzRkM3J6OHZNcWRmLzVFYmQ3cjdzcnZTM1lrN2NoamVoVHJTaHNjeEJmM2F3?=
 =?utf-8?B?L3lPYXNoOENRMC96ZHFKV3YzQmVQd1VGVFdBSEFnbk5zSW0wM05PVjFOVElR?=
 =?utf-8?B?MVRQZGEzb1VJM2pFRXl6MmhaekZESkhxeWhkUGVvVk5Pd2RwVEo1Tnp2azRQ?=
 =?utf-8?B?YmJmYVdtRmsyM2FBZWs5SGpEZWJnaEM1OGtzdWU0ZFIycnlac0p5eGt0bDY5?=
 =?utf-8?B?WTdLSkFLeEx0dlB0ZmRKV0RMb0ZKZmgwdWpqczVrdWUvMjdMTnRyR0VpY0dQ?=
 =?utf-8?B?Z0xycUZTSGQ4Slk0dTZvR1RxZXljTTNGWm9lRGxXcGhFUkplT09JVEN0bXp0?=
 =?utf-8?B?YU9WbldRWTFwVTdhaXBvOCtQRW1wSW85UnBwSzZ3dmxKRU12Snc5UnlWNVgr?=
 =?utf-8?B?ZTBKbVR6Q1dKM0pwYyt1WmFHQkpURTZyN3B6K3RMY3ByRFFDVEMyOVQ5cUds?=
 =?utf-8?B?ajB4WHRMYWZhalZZYTBUNnRZVDdoM2xTZ1NPU0pDZ2pleFhONkNZN3N3YVRS?=
 =?utf-8?B?OWNhTFFVa3JjMzh6ak9VYWs0MFY5VEFXQ0lWVXVxa25GclAxRFB2NmhKTldX?=
 =?utf-8?B?bW0wVkNFNHBMbndOa1d5ZFpHQmMzQXE0OXBrYVJzazlzTC9tNUF6TFloQWt3?=
 =?utf-8?B?aWt0L1BKWUlleWNRN1M0bUgrNUZySnNYRGVESVoweGdMUXRZUXNQejJFY1Az?=
 =?utf-8?B?V0p5YUNqZVdvOVdWQytPdm44ZmprcnZ2dytlQ1VOelg5NVQxSnFLYWc1aDVY?=
 =?utf-8?B?ODJQVXRNZGpUVUZENXhyZDN0WEd5U0w1aDFCSWg4SjFUNU1vR2hTQlZJdjk2?=
 =?utf-8?B?S01BZGZsdUw0VGJqM1U3SnQ1Slp4S3d1VFY5Nnk2ZHAweHlwRlVIVWhLMWhs?=
 =?utf-8?B?K0VjWmJPblA2dW0vL2RtL3UxRDkyZUNOdzhRcmJPVVE2WHkxa24yNUQrczBm?=
 =?utf-8?B?bTdaTE50Z2RoUXhPVWgrWG5XWGgzU25jY2xkY2N1djRPYURyV3RUcnMvblpB?=
 =?utf-8?B?cjRMeDQ5dS9vMnBUMVdUUWhnUEtEUlIvOWovREZwaTFIUnRVVnRSZjBkeUhh?=
 =?utf-8?B?Z0NkZEszVlc5OWIzOVRZcUxTTzh5REg3V2Mya21xblp2VTZyalpSaWlodjZX?=
 =?utf-8?B?bWZxVE1EazU2RTREMkZxbU1CTDFrZjU1cWtKVlNkUnRZR0ZlTlY1VHk5eWVo?=
 =?utf-8?B?aDlzeGNyMUNVT0xuR1lwTkx1WWJJMDdnamI2N1FGNHVwL3NkSU9vWnpOTmFi?=
 =?utf-8?B?RE5VWFhYNWNqaHVZakJhcmYwa2JTdnU4ODh6cmovYTZ4VTJ1QTJRL2EvTS9h?=
 =?utf-8?B?NEw2cWFIdGszYjRoVkRtaFlQRDAxMlY3cnRLYUFvM1BXK2FlMWFWL0JHNmg5?=
 =?utf-8?B?RVJycUI4dVQ1S0J0cVhsbW93Y2ZDakRQR0RuVDBEZFJ3KzBBUFpDM2JLRUdS?=
 =?utf-8?B?OUw5eU9ESTMyNEh3QmFOcmJzRG1pU1FrdlZFbnVVbzNMT0U2ZldWMTdobUYv?=
 =?utf-8?B?bWc9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 0d00e02a-626d-43e5-37b2-08daeeb40a8d
X-MS-Exchange-CrossTenant-AuthSource: CY4PR11MB1862.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Jan 2023 00:30:26.6772
 (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: P25lWL1AkYJvXMvMVaeHQmKZ4iZ0AdusS8fomL1RAIzjNlA+L7ec9sSD/oPraOVQ5wgFhFQEismmy7gUHhU6xtp0Li3qKzdH/ulyYFFYof4=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DS0PR11MB7507
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-6.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,NICE_REPLY_A,
        RCVD_IN_DNSWL_MED,RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,
        SPF_NONE 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: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Hi Babu,

On 12/22/2022 3:31 PM, Babu Moger wrote:
> Update the documentation for the new features:
> 1. Slow Memory Bandwidth allocation (SMBA).
>    With this feature, the QOS  enforcement policies can be applied
>    to the external slow memory connected to the host. QOS enforcement
>    is accomplished by assigning a Class Of Service (COS) to a processor
>    and specifying allocations or limits for that COS for each resource
>    to be allocated.
> 
> 2. Bandwidth Monitoring Event Configuration (BMEC).
>    The bandwidth monitoring events mbm_total_bytes and mbm_local_bytes
>    are set to count all the total and local reads/writes respectively.
>    With the introduction of slow memory, the two counters are not
>    enough to count all the different types of memory events. With the
>    feature BMEC, the users have the option to configure mbm_total_bytes
>    and mbm_local_bytes to count the specific type of events.
> 
> Also add configuration instructions with examples.
> 
> Signed-off-by: Babu Moger <babu.moger@amd.com>
> ---
>  Documentation/x86/resctrl.rst | 141 +++++++++++++++++++++++++++++++++-
>  1 file changed, 139 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/x86/resctrl.rst b/Documentation/x86/resctrl.rst
> index 71a531061e4e..bea6cab06873 100644
> --- a/Documentation/x86/resctrl.rst
> +++ b/Documentation/x86/resctrl.rst
> @@ -17,14 +17,16 @@ AMD refers to this feature as AMD Platform Quality of Service(AMD QoS).
>  This feature is enabled by the CONFIG_X86_CPU_RESCTRL and the x86 /proc/cpuinfo
>  flag bits:
>  
> -=============================================	================================
> +===============================================	================================
>  RDT (Resource Director Technology) Allocation	"rdt_a"
>  CAT (Cache Allocation Technology)		"cat_l3", "cat_l2"
>  CDP (Code and Data Prioritization)		"cdp_l3", "cdp_l2"
>  CQM (Cache QoS Monitoring)			"cqm_llc", "cqm_occup_llc"
>  MBM (Memory Bandwidth Monitoring)		"cqm_mbm_total", "cqm_mbm_local"
>  MBA (Memory Bandwidth Allocation)		"mba"
> -=============================================	================================
> +SMBA (Slow Memory Bandwidth Allocation)         "smba"
> +BMEC (Bandwidth Monitoring Event Configuration) "bmec"
> +===============================================	================================
>  
>  To use the feature mount the file system::
>  
> @@ -161,6 +163,82 @@ with the following files:
>  "mon_features":
>  		Lists the monitoring events if
>  		monitoring is enabled for the resource.
> +		Example::
> +
> +			# cat /sys/fs/resctrl/info/L3_MON/mon_features
> +			llc_occupancy
> +			mbm_total_bytes
> +			mbm_local_bytes
> +
> +		If the system supports Bandwidth Monitoring Event
> +		Configuration (BMEC), then the bandwidth events will
> +		be configurable. The output will be::
> +
> +			# cat /sys/fs/resctrl/info/L3_MON/mon_features
> +			llc_occupancy
> +			mbm_total_bytes
> +			mbm_total_bytes_config
> +			mbm_local_bytes
> +			mbm_local_bytes_config
> +
> +"mbm_total_bytes_config", "mbm_local_bytes_config":
> +	Read/write files containing the configuration for the mbm_total_bytes
> +	and mbm_local_bytes events, respectively, when the Bandwidth
> +	Monitoring Event Configuration (BMEC) feature is supported.
> +	The event configuration settings are domain specific and affect
> +	all the CPUs in the domain. When an event configuration is changed,
> +	the bandwidth counters for all the RMIDs and the events will be
> +	cleared for that domain. The next read for every RMID will report

I think it needs to be emphasized that configuring one event impacts
all events. How about (please feel free to change): "When either event
configuration is changed, the bandwidth counters for all RMIDs of both
events (mbm_total_bytes as well as mbm_local_bytes) are cleared for that
domain. The next read ..."

> +	"Unavailable" and subsequent reads will report the valid value.
> +


Reinette