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: <99bfbeac-1454-a453-a2ef-36eee2aea34c@amd.com>
Date:   Wed, 28 Sep 2022 10:23:29 -0500
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.11.0
Reply-To: babu.moger@amd.com
Subject: Re: [PATCH v5 12/12] Documentation/x86: Update resctrl_ui.rst for new
 features
Content-Language: en-US
To:     Bagas Sanjaya <bagasdotme@gmail.com>
Cc:     corbet@lwn.net, reinette.chatre@intel.com, tglx@linutronix.de,
        mingo@redhat.com, bp@alien8.de, 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,
        eranian@google.com
References: <166431016617.373387.1968875281081252467.stgit@bmoger-ubuntu>
 <166431042060.373387.8454967155095795574.stgit@bmoger-ubuntu>
 <YzPMorJQFKPY+n4d@debian.me>
From:   "Moger, Babu" <babu.moger@amd.com>
In-Reply-To: <YzPMorJQFKPY+n4d@debian.me>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?NHA5QXNycTBQNGhHU0VwVldGZlFoVThPUTZDT2JUQnAvZ3F0WkVjRzBBdlZa?=
 =?utf-8?B?QkxrRmlzcXU2YkFZQXZhc3IxTTV1bmlKaG9kSzRoZHZxZW9LRysrY0xIdmtx?=
 =?utf-8?B?VnRwaFdjTVF6MkljN3FXU2Zra1JTMDFoL3ZPVVQvZ2dBS01LUW5UWjJ4VzZX?=
 =?utf-8?B?VjZNNUJ6cG1BZFRncWMyLzVMVFMwdjBVSGEwYWtHeHI4V1lBVm1kWERjYTZ4?=
 =?utf-8?B?dlREdzQ3c2M5ajh2SThrbUREbSt6R2VUTFdEeEZ5MTMzZkExNDhTUFp3cDEr?=
 =?utf-8?B?aHc5dHJWcThkL3FNN1ZFS3RwUzJoS3duT0Zic2Y0R1g3OVRUVWVleUlzak4x?=
 =?utf-8?B?SFpNcTRhdmZUMWpmUmFNQURzZmhrNVRIYmRWbnFDMk94U2hVZy9UVnhXc25i?=
 =?utf-8?B?ZU5lWHJEalBDcG1VZXl0YnRuLzVnMzhBazRxU3o0cENjOXZqK0o4cjhjYnF1?=
 =?utf-8?B?TkxkYmwrOU5Pei95WnU4MGtyTmJjc0xhMXk0b1pHd2NBTDkrVXVjMlJMRkFI?=
 =?utf-8?B?aU5SSXZUZkhxODFyZ3MvVjFBV3pEMnhRbW10U3paZWpLL052d3F4SmhnS1FB?=
 =?utf-8?B?U1NwZTVsV1lQSFdlNHRNOXhTaVBFRUJzZUtKR0dRaTMyYmtGOUdraDdycGw1?=
 =?utf-8?B?VllmcHJScmJBbnlSdHF6SndTQ0QyQnhqS0l0ZnExSTNXSVF6QU54dFcxTnJ6?=
 =?utf-8?B?cUd3Q3F0NGNJOTNHUlM5ckJSb1U1TGROcmEvSXZYSGswRzA2ZDlMbUE5VXBH?=
 =?utf-8?B?WHoxdGxVdEh1dlByT2wyUEFHQmRtVW5yUDd0dENXWWcveHBNb3ZqS3dwZHRL?=
 =?utf-8?B?TDUyTnk2amdwbzNWMmxmckprVmNvUWJZRWhJR1FSajJpbDNINjB4UTZRbUpX?=
 =?utf-8?B?bXdtbUxkUGNVMjFMcFBBb1lzVW5IWkY5UU4yT3lmM01MbTFFQ3J6RFdpV1B3?=
 =?utf-8?B?LzFoM0tlOEdiZVNTazE2aUgwYjlOOUtDNlhidFJoZGZsUFd6aHQ4UmE5Tnhu?=
 =?utf-8?B?VkQ3MTRwTXNoVTJBaFd6ZmpkOGo3eXk5Mkt3L0FqWkJ2dUpPYjBZWFFzQjZl?=
 =?utf-8?B?VG84QVRWNFFpSHcwOTRzT0lKY3QxWFRpOUNsa2Yyc1R6c1ZYY2wvR3pjcmNU?=
 =?utf-8?B?U1NRVGVIVEJ6NzE1Zms0a1I4N1c4Q1BpOHpmd1VKTENkbDdDY0I2bjFicXFX?=
 =?utf-8?B?TjcwUHgycmdnNjZLN1pRWGV2NWRmM1Vmc3d5S1dJQ0JmVUptSld2VDVQeG9L?=
 =?utf-8?B?dHN1Vm1mRDZNQnY2QzZEQWJmeVZXalpKVy9qSVF1YUQ0aDA4TGRoM0NlQXlj?=
 =?utf-8?B?eDlSYUNwTjNHYVFRdXFWMEVJdnRoMVVRN2ttMWM2bS9yV0JxdXU4TDRYZi85?=
 =?utf-8?B?cFdzdkFIUjY4N3FnelQzM1kreWxrbUs4MnZ2YXFlMlR0dmRRekJkbkVZL2J4?=
 =?utf-8?B?WE5jS1NiY29aM0hWOEx2eUo3SU80MThqamQwNWxVeUptUFJ4Y05nOFlLMDNH?=
 =?utf-8?B?OHg5OVhSYTlkOWlKZXJxWUhVSGoxN3c1YXNPRDVnQmsrUVVBSUJGTUlibE0z?=
 =?utf-8?B?VTFtY0dWM1dTeVpoMW1IUU54eUJmVWNTandlWXZTUFU5MlZsTzh6YjlmSXRw?=
 =?utf-8?B?T1pCNW12Smh5TGx1WHp4cVJqdEoyb3B5andSSFVoYnVhTHI2R2xCQzdKeGNE?=
 =?utf-8?B?S0pLRzRVMDB2TmVHMWxnZVVWblJNT3FXcGRkWG9tS2dIQXhXYmcvWUkybUh0?=
 =?utf-8?B?Mm9ta0lkSnhjanVCOU9TOWRma04zM2hNUTQyK0xyb1hiYkZ3ZXJ1b2o0eXBK?=
 =?utf-8?B?OWh3L2plVW0raTlWdWNQdU1CR2s3Z3Arb3Y0cmdiODNxUjhjbTlONy9GL1R6?=
 =?utf-8?B?SnNsdUZ6Qm50M3I3bDVaM1BzU3Y2NnFoRWsveE1aZjg4aGswMmRIWHZOREpv?=
 =?utf-8?B?WjRVWFJLbERWNXpSYjhVZld4eXlXeEYzTHQ4NW9DRVNFS0R3d1Z1OHp0TmRK?=
 =?utf-8?B?WDZ1a0p5VDBGUm9FcDFoZlB6RGJCSG9NekFrOXUxYlJvSDRwakQ3bUt2dWEw?=
 =?utf-8?B?c3NTdzFEZG04ejhna0ttd1ltT3NPZGpIa0IxS0xoQzQweGlOSkRLM2k4ZzNr?=
 =?utf-8?Q?MvKnlva3PCgoC4nWkYYTV90Cx?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 94be0cb2-2947-44d5-dcd7-08daa165691c
X-MS-Exchange-CrossTenant-AuthSource: MW3PR12MB4553.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 28 Sep 2022 15:23:35.5624
 (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: fanooIKYOmj6uOYYcbLDnj3ROUeBEQ4KTiHK95b3eXWpdxfgxD/h+dVviMWJapkC
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR12MB6539
X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,NICE_REPLY_A,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS 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 Sanjaya,


On 9/27/22 23:25, Bagas Sanjaya wrote:
> On Tue, Sep 27, 2022 at 03:27:00PM -0500, Babu Moger wrote:
>> +        Following are the types of events supported:
>> +
>> +        ====    ========================================================
>> +        Bits    Description
>> +        ====    ========================================================
>> +        6       Dirty Victims from the QOS domain to all types of memory
>> +        5       Reads to slow memory in the non-local NUMA domain
>> +        4       Reads to slow memory in the local NUMA domain
>> +        3       Non-temporal writes to non-local NUMA domain
>> +        2       Non-temporal writes to local NUMA domain
>> +        1       Reads to memory in the non-local NUMA domain
>> +        0       Reads to memory in the local NUMA domain
>> +        ====    ========================================================
>> +
>> +        By default, the mbm_total_bytes configuration is set to 0x7f to count
>> +        all the event types and the mbm_local_bytes configuration is set to
>> +        0x15 to count all the local memory events.
>> +
>> +        Example::
>> +
>> +            To view the current configuration, run the command.
>> +            # cat /sys/fs/resctrl/info/L3_MON/mbm_total_config
>> +            0:0x7f;1:0x7f;2:0x7f;3:0x7f
>> +
>> +            # cat /sys/fs/resctrl/info/L3_MON/mbm_local_config
>> +            0:0x15;1:0x15;3:0x15;4:0x15
>> +
>> +            To change the mbm_total_bytes to count only reads on domain 0,
>> +            run the command. The bits 0,1,4 and 5 needs to set.
>> +
>> +            # echo  "0:0x33" > /sys/fs/resctrl/info/L3_MON/mbm_total_config
>> +
>> +            # cat /sys/fs/resctrl/info/L3_MON/mbm_total_config
>> +            0:0x33;1:0x7f;2:0x7f;3:0x7f
>> +
>> +            To change the mbm_local_bytes to count all the slow memory reads on
>> +            domain 1, run the command. The bits 4 and 5 needs to set.
>> +
>> +            # echo  "1:0x30" > /sys/fs/resctrl/info/L3_MON/mbm_local_config
>> +
>> +            # cat /sys/fs/resctrl/info/L3_MON/mbm_local_config
>> +            0:0x15;1:0x30;3:0x15;4:0x15
>>  
> Hi Babu,
>
> The description text for each snippets above shouldn't in the code
> block. Also, split the block into three code blocks in the lists:
Did you mean, I need to remove similar texts from code?
>
> ---- >8 ----
> diff --git a/Documentation/x86/resctrl.rst b/Documentation/x86/resctrl.rst
> index b4fe54f219b6f3..ec578b069276ce 100644
> --- a/Documentation/x86/resctrl.rst
> +++ b/Documentation/x86/resctrl.rst
> @@ -206,25 +206,26 @@ with the following files:
>          all the event types and the mbm_local_bytes configuration is set to
>          0x15 to count all the local memory events.
>  
> -        Example::
> +        Examples:
> +
> +        * To view the current configuration::
>  
> -            To view the current configuration, run the command.
>              # cat /sys/fs/resctrl/info/L3_MON/mbm_total_config
>              0:0x7f;1:0x7f;2:0x7f;3:0x7f
>  
>              # cat /sys/fs/resctrl/info/L3_MON/mbm_local_config
>              0:0x15;1:0x15;3:0x15;4:0x15
>  
> -            To change the mbm_total_bytes to count only reads on domain 0,
> -            run the command. The bits 0,1,4 and 5 needs to set.
> +        * To change the mbm_total_bytes to count only reads on domain 0
> +          (the bits 0, 1, 4 and 5 needs to be set)::
>  
>              # echo  "0:0x33" > /sys/fs/resctrl/info/L3_MON/mbm_total_config
>  
>              # cat /sys/fs/resctrl/info/L3_MON/mbm_total_config
>              0:0x33;1:0x7f;2:0x7f;3:0x7f
>  
> -            To change the mbm_local_bytes to count all the slow memory reads on
> -            domain 1, run the command. The bits 4 and 5 needs to set.
> +        * To change the mbm_local_bytes to count all the slow memory reads on
> +          domain 1 (the bits 4 and 5 needs to be set)::
>  
>              # echo  "1:0x30" > /sys/fs/resctrl/info/L3_MON/mbm_local_config
>  

Thanks for the diff. I cannot get this right for some reason. I will
probably send the diff before the final series.


>
> Also, there isn't description of mapping from bits from the supported events
> table to the bytes input for mbm_{total,local}_config.

It is already there. Is that not clear?

+        Following are the types of events supported:
+
+        ====    ========================================================
+        Bits    Description
+        ====    ========================================================
+        6       Dirty Victims from the QOS domain to all types of memory
+        5       Reads to slow memory in the non-local NUMA domain
+        4       Reads to slow memory in the local NUMA domain
+        3       Non-temporal writes to non-local NUMA domain
+        2       Non-temporal writes to local NUMA domain
+        1       Reads to memory in the non-local NUMA domain
+        0       Reads to memory in the local NUMA domain
+        ====    ========================================================


>
>> +Slow Memory b/w domain is L3 cache.
>> +::
>> +
>> +	SMBA:<cache_id0>=bandwidth0;<cache_id1>=bandwidth1;...
>> +
> What b/w stands for in the context above?
b/w is bandwidth. I will correct it.
>
>>  Reading/writing the schemata file
>>  ---------------------------------
>>  Reading the schemata file will show the state of all resources
>> @@ -479,6 +567,44 @@ which you wish to change.  E.g.
>>    L3DATA:0=fffff;1=fffff;2=3c0;3=fffff
>>    L3CODE:0=fffff;1=fffff;2=fffff;3=fffff
>>  
>> +Reading/writing the schemata file (on AMD systems)
>> +--------------------------------------------------
>> +Reading the schemata file will show the state of all resources
>> +on all domains. When writing the memory bandwidth allocation you
>> +only need to specify those values in an absolute number expressed
>> +in 1/8 GB/s increments. To allocate bandwidth limit of 2GB, you
>> +need to specify the value 16 (16 * 1/8 = 2).  E.g.
>> <snipped>...
>> +Reading the schemata file will show the state of all resources
>> +on all domains. When writing the memory bandwidth allocation you
>> +only need to specify those values in an absolute number expressed
>> +in 1/8 GB/s increments. To allocate bandwidth limit of 8GB, you
>> +need to specify the value 64 (64 * 1/8 = 8).  E.g.
> s/E.g./For example:/

Thanks

Babu Moger