Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.31 as permitted sender) client-ip=23.128.96.31;
Received-SPF: Pass (protection.outlook.com: domain of amd.com designates
 165.204.84.17 as permitted sender) receiver=protection.outlook.com;
 client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C
From:   Babu Moger <babu.moger@amd.com>
To:     <corbet@lwn.net>, <reinette.chatre@intel.com>,
        <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>, <babu.moger@amd.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>
Subject: [PATCH v13 04/10] x86/resctrl: Add comments on RFTYPE flags hierarchy
Date:   Fri, 13 Oct 2023 15:25:56 -0500
Message-ID: <20231013202602.2492645-5-babu.moger@amd.com>
In-Reply-To: <20231013202602.2492645-1-babu.moger@amd.com>
References: <20231013202602.2492645-1-babu.moger@amd.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Oct 2023 20:26:17.2280
 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: 7983b7a7-44fc-4373-b2e6-08dbcc2aa772
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d;Ip=[165.204.84.17];Helo=[SATLEXMB04.amd.com]
X-MS-Exchange-CrossTenant-AuthSource: DS1PEPF0001709A.namprd05.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR12MB5500
X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,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 morse.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 (morse.vger.email [0.0.0.0]); Fri, 13 Oct 2023 13:26:49 -0700 (PDT)

resctrl uses RFTYPE flags for creating resctrl directory structure.

Definitions and directory structures are not documented. Add
comments to improve the readability and help future additions.

Signed-off-by: Babu Moger <babu.moger@amd.com>
---
v13: Fixed the format issues in the documentation. Needed few minor format
     changes to address the syntax issues.(Reinette)
     Removed "Reviewed-by and Tested-by" flags as the patch has changed.

v12: Moved the comments from arch/x86/kernel/cpu/resctrl/internal.h
     to Documentation/arch/x86/resctrl.rst. (Boris)
---
 Documentation/arch/x86/resctrl.rst | 64 ++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)

diff --git a/Documentation/arch/x86/resctrl.rst b/Documentation/arch/x86/resctrl.rst
index 178ab1d8f747..1163da74f734 100644
--- a/Documentation/arch/x86/resctrl.rst
+++ b/Documentation/arch/x86/resctrl.rst
@@ -369,6 +369,70 @@ When monitoring is enabled all MON groups will also contain:
 	the sum for all tasks in the CTRL_MON group and all tasks in
 	MON groups. Please see example section for more details on usage.
 
+RESCTRL filesystem implementation notes
+=======================================
+RESCTRL filesystem has two main components
+	a. info
+	b. base
+
+	/sys/fs/resctrl/
+	|
+	-> info
+	|
+	|  (Top level directory named "info". Contains files that
+	|   provide details on control and monitoring resources")
+	|
+	-> base
+
+	   (Root directory associated with default resource group as
+	    well as directories created by user for MON and CTRL groups.
+	    Contains files to interact with MON and CTRL groups)
+
+	Note: resctrl uses flags for files, not for directories.
+	      Directories are created based on the resource type. Added
+	      directories below for better understanding. The RFTYPE flags
+	      are defined in arch/x86/kernel/cpu/resctrl/internal.h.
+
+	info directory structure
+
+	-> RFTYPE_INFO
+	   Directory: info
+
+	-> RFTYPE_TOP (Files in top level of info directory)
+	   File: last_cmd_status
+
+	-> RFTYPE_MON (Files for all monitoring resources)
+	   Directory: L3_MON
+	       Files: mon_features, num_rmids
+
+		-> RFTYPE_RES_CACHE (Files for cache monitoring resources)
+		   Directory: L3_MON
+		       Files: max_threshold_occupancy,
+		              mbm_total_bytes_config,
+		              mbm_local_bytes_config
+
+	-> RFTYPE_CTRL (Files for all control resources)
+	   Directories: L2, L3, MB, SMBA, L2CODE, L2DATA, L3CODE, L3DATA
+	          File: num_closids
+
+		-> RFTYPE_RES_CACHE (Files for cache control resources)
+		   Directories: L2, L3, L2CODE, L2DATA, L3CODE, L3DATA
+		         Files: bit_usage, cbm_mask, min_cbm_bits,
+		                 shareable_bits
+
+		-> RFTYPE_RES_MB (Files for memory control resources)
+		   Directories: MB, SMBA
+		         Files: bandwidth_gran, delay_linear,
+		                 min_bandwidth, thread_throttle_mode
+
+	base directory structure
+
+	-> RFTYPE_BASE (Files common for both MON and CTRL groups)
+	   Files: cpus, cpus_list, tasks
+
+		-> RFTYPE_CTRL (Files for CTRL group)
+		   Files: mode, schemata, size
+
 Resource allocation rules
 -------------------------
 
-- 
2.34.1