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: <41c166e8-d6a2-7be8-1d4e-6b2b1cc62f2a@intel.com>
Date:   Fri, 4 Aug 2023 13:39:48 -0700
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101
 Firefox/102.0 Thunderbird/102.13.0
Subject: Re: [PATCH v6 4/8] x86/resctrl: Add comments on RFTYPE flags
 hierarchy
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: <168980872063.1619861.420806535295905172.stgit@bmoger-ubuntu>
 <168980891501.1619861.11056885467637617879.stgit@bmoger-ubuntu>
From:   Reinette Chatre <reinette.chatre@intel.com>
In-Reply-To: <168980891501.1619861.11056885467637617879.stgit@bmoger-ubuntu>
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?U2MreDAray9MMzBtazR3clNjOWFSUGNRSmo5VkxXUk9qb1hEdzhSQWZDZy9l?=
 =?utf-8?B?dVZjMWcrNU5zNjFDQmJBdURPamRmK0FVTldlWXVEOW8wMTlZWXdSNThETXhx?=
 =?utf-8?B?SSt2WHJrT2xlR3pZQ1JzdjZsOHQxdC9LUkdFZm9CcElaZ29rcmh3VURFNCs5?=
 =?utf-8?B?KzRVYThxVUxZODN6aVdXY2RiM1U3aHBLaURKallJR29QVHlQUEdvcUdER1pG?=
 =?utf-8?B?aWJoOEhLcnloSkh3OE8wM0NMb0JRMVlwMUVtSHlrNXAvWC9kN2hHdWg0dzNX?=
 =?utf-8?B?R0lRYW81N3J4bk01TEdIN3NtSTBKSCtIZHZ5ekdrVlcxdndSZFEyYUtGTTBN?=
 =?utf-8?B?NHp6ZWYwemNWNVA2OEI1VkROQ3RXUE5YTzVTcnZpVXpIWTI0bEJMbE1NR3o2?=
 =?utf-8?B?SWdmSVJwbGViK3FIcVZOVDNVcHEzTE1RS0t0NmNrU0xYUHlmSTBLYk5XeVE0?=
 =?utf-8?B?SG1XYmt5VFVxQVQxL0ZvZmZkUk9kOEVwaVA2MUtLU3FlSTBySDNuaFIvekYr?=
 =?utf-8?B?NW83a2ZHWWo1NFQ4SlNSQk1DbnhERk5GRFBoWitNOWRNd2FDQ05PcXhENE14?=
 =?utf-8?B?dVNDVjB2dXdlYjMxdmZRd0ZxVm9kZ3dHMUZjUWl3SDB5MmVCdUltWlFSQnZV?=
 =?utf-8?B?NmNzYjZYNGdIa2h1cjJpY2dvOFpLaXlSdzJGdkdKVjZhNUc2cndKUFZlMHlI?=
 =?utf-8?B?UTR0Y0k5bmZ6WmJJNmNLMEo0Q0xpVEM4RHpLaDRUNlVtOGZNbGxrMmF6R3FG?=
 =?utf-8?B?VHJzdlRuTzZqVVBFNUp4bTR6d3dmSTIvYlVua21IeWR3U2gzM3VpRDI1NlVw?=
 =?utf-8?B?d2xSR2FNbzJRK0NVckhwQmZLaVo5RXJPcUVUWmJOYmZ0T0dYcjNDRWVBY0I3?=
 =?utf-8?B?MTdKeGNiSm8zUENxMVRXWmh1MTFpTjNGZDFVR01pOUhHdTlxTkRpTytnM29Z?=
 =?utf-8?B?ejVjU3o1Y2lRUnpKTVVybHA2ckpCbXZnYjNCTERqSTRMSnJxYks2dVRkVkNX?=
 =?utf-8?B?T1VuUFdaV1VzMnhGSUNmZFVjN01MQWs0MmVDTE95b0VaSU9uTjdxcHAvb1U0?=
 =?utf-8?B?USsreUZ6KzNGVEE5VzdvblFyekZmOUdYM0VBSmJDN3oyTXNEdy9pR3plT0tY?=
 =?utf-8?B?VUUwZFFoWDF3ZFAzL3JNNjI5MjZ4ak51MjZMMXNDbytpUGliMXBNdkZVV1JX?=
 =?utf-8?B?dGdwTCtYYWF3TVppbVhFbGc1SjFTa2QwV2t4cmZJaGQrTDRrSkxkbmJLS0Z0?=
 =?utf-8?B?RHFxWitVZXozQk82bkR1bzNpZFRMdTFZWUcraVJ2U0trUXVoNGxIK21uRXlY?=
 =?utf-8?B?VjB1VnNXT0VUN2tLa0pIeDFYYUFkZzBhTWV5UStrQmdmQjhJdXFGeU50bzVr?=
 =?utf-8?B?Mm1uMnV2MGNEWms2M0E0QVR1TXhnRENSZzVOZ2h0czRYSG9IUDhRTDczMXJn?=
 =?utf-8?B?eWtCWHRmcXF3TzBobHBTdU1QeU5XMFJtNFlNcCtwOEU0VTlhVnhCd2dOYTUz?=
 =?utf-8?B?VDRTOXEwekVCRXQ0UVJoMS9aZnBJbWVwZlNzWHZVMWU2Uko3NnFWR0VIa0lG?=
 =?utf-8?B?bjFOZDRzaTZobFFyRzE4aUFyeHduZ2xkalkyYWhveVd2WEZpVExYbHlsWlpn?=
 =?utf-8?B?bThxbkpadDRhQWMwbXBNM3lZekQ4dVhWSG5aV0piVW9Sd2g3aGYvVlhNMmVS?=
 =?utf-8?B?K3E3NlU5N3lBN01EeUxjNFkvTVJTaHBvQk9Rc2JyTlVIUkhYZG5QUEdFR1c3?=
 =?utf-8?B?dStSTzRwSWNuR0dFVmF6ZmNoR0wxT1lrVGJSeHVOaVYxWXJVTlJXZ29PYjEx?=
 =?utf-8?B?NTZiaUhrZkVNbzBvZzZCbURUTzdud2Ria2F4Si9vMk1UbVBjUUs3VDc1V2xL?=
 =?utf-8?B?OXhpSXdvYi8yc05ZcW1GUWtFeXZSUSs5eDc3ZmlUaUpSR3RPMWM0UGQ0TUlx?=
 =?utf-8?B?ZEhub1g5NUUvZWw1MjZsNFpJVER4U05ralBvMWgwTmROSDd1SG9MdGFVL09o?=
 =?utf-8?B?TlRZT3VqVmNGOXczRHI3Wkd4M1pQeElGbURaRUtyRllwcGtJWUMralpZMDBp?=
 =?utf-8?B?SU4xeWdpTGxhc3A3K3ErRCtmQmpiT21qNi94blo2U3c2N1ZuNVIwNk04WnZi?=
 =?utf-8?B?R3Y5bHh4QXBDa2ZEUWFDRXRzK09jaU1mRGhHNGFzdFR5QWdFN0o1T1lMS3pR?=
 =?utf-8?B?Q0E9PQ==?=
X-MS-Exchange-CrossTenant-Network-Message-Id: f3bb1da7-efdb-4286-87c9-08db952af473
X-MS-Exchange-CrossTenant-AuthSource: SJ2PR11MB7573.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Aug 2023 20:39:52.7129
 (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: hUX3kFBELnYfTf/PYMIYC4F3i+hPHLknUpECfXsE17SVq2+Qz3SprbySkoCumjcNJR9jdI3HDZxvLqoY7q9ojzHP/BlZTDpDQH8UWWlYoCE=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR11MB5077
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-2.2 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_BLOCKED,SPF_HELO_NONE,SPF_NONE,URIBL_BLOCKED
        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 7/19/2023 4:21 PM, Babu Moger wrote:
> + *	------------------------------------------------------------------
> + *	--> RFTYPE_INFO
> + *	--> <info> directory
> + *		--> RFTYPE_TOP_INFO
> + *		    Files: last_cmd_status
> + *
> + *		--> RFTYPE_MON_INFO
> + *		--> <L3_MON> directory
> + *		    Files: max_threshold_occupancy, mon_features,
> + *		           num_rmids, mbm_total_bytes_config,
> + *		           mbm_locat_bytes_config

mbm_locat_bytes_config -> mbm_local_bytes_config

> + *
> + *		--> RFTYPE_CTRL_INFO
> + *			--> RFTYPE_RES_CACHE
> + *			--> <L2,L3> directory

Should this be "directories"?

> + *			    Files: bit_usage, cbm_mask, min_cbm_bits,
> + *			           num_closids, shareable_bits

Based on the hierarchy presented the files mentioned here may be expected
to be associated with RFTYPE_CTRL_INFO | RFTYPE_RES_CACHE.
For accuracy it may be better to move num_closids one level higher so
that it is only associated with RFTYPE_CTRL_INFO?

> + *
> + *			--> RFTYPE_RES_MB
> + *			--> <MB,SMBA> directory

directories?

> + *			    Files: bandwidth_gran, delay_linear,
> + * 			           min_bandwidth, num_closids,

Please remove space before tab for a clean checkpatch.pl run.

> + *			           thread_throttle_mode
> + *
> + *	base (root) directory structure

Since "base" refers to more than the root directory I think this can
just be "base directory structure".

> + *	------------------------------------------------------------------
> + *	--> RFTYPE_BASE (Files common for both MON and CTRL groups)
> + *	    Files: cpus, cpus_list, tasks
> + *
> + *	--> RFTYPE_CTRL_BASE (Files only for CTRL group)
> + *	    Files: mode, schemata, size
> + *
>   */
>  #define RFTYPE_INFO			BIT(0)
>  #define RFTYPE_BASE			BIT(1)
> 
> 

Reinette