configs: Port HWPConfig to the common object list

Port HWPConfig to use the common object list.

Change-Id: I86db6b872808f754193dbf5814dd6c951c8f1980
Signed-off-by: Daniel R. Carvalho <odanrc@yahoo.com.br>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/20591
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Andreas Sandberg <andreas.sandberg@arm.com>
Maintainer: Andreas Sandberg <andreas.sandberg@arm.com>

4 files changed, 9 insertions, 97 deletions

diff --git a/configs/common/CacheConfig.py b/configs/common/CacheConfig.py
index f705ab09a..98d0adfc5 100644
--- a/configs/common/CacheConfig.py
+++ b/configs/common/CacheConfig.py
@@ -47,7 +47,7 @@ from __future__ import absolute_import
 import m5
 from m5.objects import *
 from .Caches import *
-from . import HWPConfig
+from common import ObjectList
 
 def config_cache(options, system):
     if options.external_memory_system and (options.caches or options.l2cache):
@@ -106,7 +106,7 @@ def config_cache(options, system):
         system.l2.cpu_side = system.tol2bus.master
         system.l2.mem_side = system.membus.slave
         if options.l2_hwp_type:
-            hwpClass = HWPConfig.get(options.l2_hwp_type)
+            hwpClass = ObjectList.hwp_list.get(options.l2_hwp_type)
             if system.l2.prefetcher != "Null":
                 print("Warning: l2-hwp-type is set (", hwpClass, "), but",
                       "the current l2 has a default Hardware Prefetcher",
@@ -149,7 +149,7 @@ def config_cache(options, system):
                 dcache = dcache_mon
 
             if options.l1d_hwp_type:
-                hwpClass = HWPConfig.get(options.l1d_hwp_type)
+                hwpClass = ObjectList.hwp_list.get(options.l1d_hwp_type)
                 if dcache.prefetcher != m5.params.NULL:
                     print("Warning: l1d-hwp-type is set (", hwpClass, "), but",
                           "the current l1d has a default Hardware Prefetcher",
@@ -158,7 +158,7 @@ def config_cache(options, system):
                 dcache.prefetcher = hwpClass()
 
             if options.l1i_hwp_type:
-                hwpClass = HWPConfig.get(options.l1i_hwp_type)
+                hwpClass = ObjectList.hwp_list.get(options.l1i_hwp_type)
                 if icache.prefetcher != m5.params.NULL:
                     print("Warning: l1i-hwp-type is set (", hwpClass, "), but",
                           "the current l1i has a default Hardware Prefetcher",
diff --git a/configs/common/HWPConfig.py b/configs/common/HWPConfig.py
deleted file mode 100644
index dd8cafa2e..000000000
--- a/configs/common/HWPConfig.py
+++ /dev/null
@@ -1,88 +0,0 @@
-# Copyright (c) 2018 Metempsy Technology Consulting
-# All rights reserved.
-#
-# 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.
-#
-# Authors: Pau Cabre
-
-# This file is a copy of MemConfig.py / CpuConfig.py, but modified to
-# hanle branch predictors instead of memory controllers / CPUs
-
-from __future__ import print_function
-from __future__ import absolute_import
-
-from m5 import fatal
-import m5.objects
-import inspect
-import sys
-from textwrap import TextWrapper
-
-# Dictionary of mapping names of real branch predictor models to classes.
-_hwp_classes = {}
-
-
-def is_hwp_class(cls):
-    """Determine if a class is a prefetcher that can be instantiated"""
-
-    # We can't use the normal inspect.isclass because the ParamFactory
-    # and ProxyFactory classes have a tendency to confuse it.
-    try:
-        return issubclass(cls, m5.objects.BasePrefetcher) and \
-            not cls.abstract
-    except (TypeError, AttributeError):
-        return False
-
-def get(name):
-    """Get a HWP class from a user provided class name or alias."""
-
-    try:
-        hwp_class = _hwp_classes[name]
-        return hwp_class
-    except KeyError:
-        print("%s is not a valid HWP model." % (name,))
-        sys.exit(1)
-
-def print_hwp_list():
-    """Print a list of available HWP classes."""
-
-    print("Available Hardware Prefetcher classes:")
-    doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t")
-    for name, cls in _hwp_classes.items():
-        print("\t%s" % name)
-
-        # Try to extract the class documentation from the class help
-        # string.
-        doc = inspect.getdoc(cls)
-        if doc:
-            for line in doc_wrapper.wrap(doc):
-                print(line)
-
-def hwp_names():
-    """Return a list of valid Hardware Prefetcher names."""
-    return list(_hwp_classes.keys())
-
-# Add all HWPs in the object hierarchy.
-for name, cls in inspect.getmembers(m5.objects, is_hwp_class):
-    _hwp_classes[name] = cls
-
diff --git a/configs/common/ObjectList.py b/configs/common/ObjectList.py
index 0b08b2392..a8b2fcc21 100644
--- a/configs/common/ObjectList.py
+++ b/configs/common/ObjectList.py
@@ -137,6 +137,7 @@ class CPUList(ObjectList):
 
 bp_list = ObjectList(m5.objects.BranchPredictor)
 cpu_list = CPUList(m5.objects.BaseCPU)
+hwp_list = ObjectList(m5.objects.BasePrefetcher)
 indirect_bp_list = ObjectList(m5.objects.IndirectPredictor)
 
 def _subclass_tester(name):
diff --git a/configs/common/Options.py b/configs/common/Options.py
index ebcd74ed4..6afdc5a8a 100644
--- a/configs/common/Options.py
+++ b/configs/common/Options.py
@@ -47,7 +47,6 @@ from m5.objects import *
 
 from .Benchmarks import *
 from . import ObjectList
-from . import HWPConfig
 from . import MemConfig
 from . import PlatformConfig
 
@@ -60,7 +59,7 @@ def _listBPTypes(option, opt, value, parser):
     sys.exit(0)
 
 def _listHWPTypes(option, opt, value, parser):
-    HWPConfig.print_hwp_list()
+    ObjectList.hwp_list.print()
     sys.exit(0)
 
 def _listIndirectBPTypes(option, opt, value, parser):
@@ -184,21 +183,21 @@ def addCommonOptions(parser):
                       action="callback", callback=_listHWPTypes,
                       help="List available hardware prefetcher types")
     parser.add_option("--l1i-hwp-type", type="choice", default=None,
-                      choices=HWPConfig.hwp_names(),
+                      choices=ObjectList.hwp_list.get_names(),
                       help = """
                       type of hardware prefetcher to use with the L1
                       instruction cache.
                       (if not set, use the default prefetcher of
                       the selected cache)""")
     parser.add_option("--l1d-hwp-type", type="choice", default=None,
-                      choices=HWPConfig.hwp_names(),
+                      choices=ObjectList.hwp_list.get_names(),
                       help = """
                       type of hardware prefetcher to use with the L1
                       data cache.
                       (if not set, use the default prefetcher of
                       the selected cache)""")
     parser.add_option("--l2-hwp-type", type="choice", default=None,
-                      choices=HWPConfig.hwp_names(),
+                      choices=ObjectList.hwp_list.get_names(),
                       help = """
                       type of hardware prefetcher to use with the L2 cache.
                       (if not set, use the default prefetcher of