misc: Make PartitionFieldExtention private to Arm

The new ISA-agnostic interface is the PartitionManager.
We therefore make the PartitionFieldExtention private to the
Arm implementation of memory partitioning (FEAT_MPAM)

Any other partitioning implementation should override the
PartitionManager::readPacketPartitionID to provide a mean
for extracting partitioning data (partition_id) from the
incoming Packet.

With this commit we also define an MPAM MSC which is
supposed to be the partitioning manager for the
Memory System Component

Change-Id: I6959ace0c0cbca549dcc1aacd53dff223b5fe328
Signed-off-by: Giacomo Travaglini <giacomo.travaglini@arm.com>

src/arch/arm/SConscript

@@ -93,6 +93,7 @@ Source('fs_workload.cc', tags='arm isa')
 Source('regs/int.cc', tags='arm isa')
 Source('regs/misc.cc', tags='arm isa')
 Source('mmu.cc', tags='arm isa')
+Source('mpam.cc', tags='arm isa')
 Source('nativetrace.cc', tags='arm isa')
 Source('pagetable.cc', tags='arm isa')
 Source('pauth_helpers.cc', tags='arm isa')

src/arch/arm/mpam.cc

@@ -35,12 +35,9 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#include "partition_fields_extension.hh"
+#include "arch/arm/mpam.hh"
 
-namespace gem5
-{
-
-namespace partitioning_policy
+namespace gem5::ArmISA::mpam
 {
 
 std::unique_ptr<ExtensionBase>
@@ -73,17 +70,4 @@ PartitionFieldExtention::setPartitionMonitoringID(uint64_t id)
     this->_partitionMonitoringID = id;
 }
 
-uint64_t
-readPacketPartitionID (PacketPtr pkt)
-{
-    // get partition_id from PartitionFieldExtention
-    std::shared_ptr<PartitionFieldExtention> ext =
-        pkt->req->getExtension<PartitionFieldExtention>();
-
-    // use default value if extension is not set
-    return (ext != nullptr) ? ext->getPartitionID() : DEFAULT_PARTITION_ID;
-}
-
-} // namespace partitioning_policy
-
-} // namespace gem5
+} // namespace gem5::ArmISA::mpam

src/arch/arm/mpam.hh

@@ -35,17 +35,14 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __MEM_CACHE_TAGS_PARTITIONING_POLICIES_FIELD_EXTENTION_HH__
-#define __MEM_CACHE_TAGS_PARTITIONING_POLICIES_FIELD_EXTENTION_HH__
+#ifndef __ARCH_ARM_MPAM_HH__
+#define __ARCH_ARM_MPAM_HH__
 
 #include "base/extensible.hh"
 #include "mem/packet.hh"
 #include "mem/request.hh"
 
-namespace gem5
-{
-
-namespace partitioning_policy
+namespace gem5::ArmISA::mpam
 {
 
 const uint64_t DEFAULT_PARTITION_ID = 0;
@@ -87,16 +84,6 @@ class PartitionFieldExtention : public Extension<Request,
     uint64_t _partitionMonitoringID = DEFAULT_PARTITION_MONITORING_ID;
 };
 
-/**
-* Helper function to retrieve PartitionID from a packet; Returns packet
-* PartitionID if available or DEFAULT_PARTITION_ID if extention is not set
-* @param pkt pointer to packet (PacketPtr)
-* @return packet PartitionID.
-*/
-uint64_t readPacketPartitionID (PacketPtr pkt);
+} // namespace gem5::ArmISA::mpam
 
-} // namespace partitioning_policy
-
-} // namespace gem5
-
-#endif // __MEM_CACHE_TAGS_PARTITIONING_POLICIES_FIELD_EXTENTION_HH__
+#endif // __ARCH_ARM_MPAM_HH__

src/dev/arm/Mpam.py

@@ -0,0 +1,43 @@
+# Copyright (c) 2024 Arm Limited
+# All rights reserved.
+#
+# The license below extends only to copyright in the software and shall
+# not be construed as granting a license to any other intellectual
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder.  You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met: redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer;
+# redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution;
+# neither the name of the copyright holders nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from m5.objects.PartitioningPolicies import PartitionManager
+
+
+class MpamMSC(PartitionManager):
+    type = "MpamMSC"
+    abstract = True
+    cxx_header = "dev/arm/mpam.hh"
+    cxx_class = "gem5::mpam::MSC"

src/dev/arm/SConscript

@@ -49,6 +49,7 @@ SimObject('Gic.py', sim_objects=[
     'BaseGic', 'ArmInterruptPin', 'ArmSPI', 'ArmPPI', 'ArmSigInterruptPin',
     'GicV2', 'Gicv2mFrame', 'Gicv2m', 'VGic', 'Gicv3Its', 'Gicv3'],
     enums=['ArmInterruptType'], tags='arm isa')
+SimObject('Mpam.py', sim_objects=['MpamMSC'], tags='arm isa')
 SimObject('RealView.py', sim_objects=[
     'AmbaPioDevice', 'AmbaIntDevice', 'AmbaDmaDevice', 'A9SCU',
     'GenericArmPciHost', 'RealViewCtrl', 'RealViewOsc',
@@ -80,6 +81,7 @@ Source('gic_v3_cpu_interface.cc', tags='arm isa')
 Source('gic_v3_distributor.cc', tags='arm isa')
 Source('gic_v3_redistributor.cc', tags='arm isa')
 Source('gic_v3_its.cc', tags='arm isa')
+Source('mpam.cc', tags='arm isa')
 Source('pl011.cc', tags='arm isa')
 Source('pl111.cc', tags='arm isa')
 Source('hdlcd.cc', tags='arm isa')

src/dev/arm/mpam.cc

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2024 Arm Limited
+ * All rights reserved.
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "arch/arm/mpam.hh"
+#include "dev/arm/mpam.hh"
+
+namespace gem5::mpam
+{
+
+uint64_t
+MSC::readPacketPartitionID(PacketPtr pkt) const
+{
+    // get partition_id from PartitionFieldExtention
+    auto ext = pkt->req->getExtension<ArmISA::mpam::PartitionFieldExtention>();
+    // use default value if extension is not set
+    return (ext != nullptr) ? ext->getPartitionID() :
+        ArmISA::mpam::DEFAULT_PARTITION_ID;
+}
+
+} // namespace gem5::mpam

src/dev/arm/mpam.hh

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2024 Arm Limited
+ * All rights reserved.
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef __DEV_ARM_MPAM_HH__
+#define __DEV_ARM_MPAM_HH__
+
+#include "mem/cache/tags/partitioning_policies/partition_manager.hh"
+
+namespace gem5::mpam
+{
+
+/**
+ * This class implements a simple MPAM Memory System Component (MSC)
+ * partitioning controller. For further info refer to:
+ * https://developer.arm.com/documentation/ddi0598/latest/
+ */
+class MSC : public partitioning_policy::PartitionManager
+{
+  public:
+    using partitioning_policy::PartitionManager::PartitionManager;
+
+    /**
+    * Helper function to retrieve PartitionID from a packet; Returns packet
+    * PartitionID if available or DEFAULT_PARTITION_ID if extention is not set
+    * @param pkt pointer to packet (PacketPtr)
+    * @return packet PartitionID.
+    */
+    uint64_t readPacketPartitionID(PacketPtr pkt) const override;
+};
+
+} // namespace gem5::mpam
+
+#endif // __DEV_ARM_MPAM_HH__

src/mem/cache/tags/partitioning_policies/SConscript

@@ -49,5 +49,4 @@ Source('base_pp.cc')
 Source('max_capacity_pp.cc')
 Source('way_allocation.cc')
 Source('way_pp.cc')
-Source('partition_fields_extension.cc')
 Source('partition_manager.cc')

src/mem/cache/tags/partitioning_policies/base_pp.hh

@@ -54,12 +54,11 @@ namespace partitioning_policy
 /**
  * A Partitioning Policy is a cache partitioning mechanism that limits the
  * cache block allocations in a cache based on a PartitionID identifier. This
- * identifier may be set to any upstream memory request by attaching a
- * PartitionFieldExtention to it as so:
+ * identifier may be set to any upstream memory request by attaching the
+ * PartitionID to it. The way the partition ID is attached/extracted
+ * from the request depends on the partitioning manager.
  *
- * std::shared_ptr<PartitionFieldExtention> ext(PartitionFieldExtention);
- * ext->setPartitionID(PartitionID);
- * req->setExtension(ext);
+ * See the use of the PartitionFieldExtention in Arm as an example.
  *
  * When partitioning policies are in place, the allocatable cache blocks for
  * this memory request will be filtered based on its PartitionID.