configs: Port BPConfig to use the common object list

Port BPConfig to use the common object list.

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

6 files changed, 15 insertions, 155 deletions

diff --git a/configs/common/BPConfig.py b/configs/common/BPConfig.py
deleted file mode 100644
index e6fe1f9c0..000000000
--- a/configs/common/BPConfig.py
+++ /dev/null
@@ -1,139 +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.
-_bp_classes = {}
-
-
-def is_bp_class(cls):
-    """Determine if a class is a branch predictor 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.BranchPredictor) and \
-            not cls.abstract
-    except (TypeError, AttributeError):
-        return False
-
-def get(name):
-    """Get a BP class from a user provided class name or alias."""
-
-    try:
-        bp_class = _bp_classes[name]
-        return bp_class
-    except KeyError:
-        print("%s is not a valid BP model." % (name,))
-        sys.exit(1)
-
-def print_bp_list():
-    """Print a list of available BP classes."""
-
-    print("Available BranchPredictor classes:")
-    doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t")
-    for name, cls in _bp_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 bp_names():
-    """Return a list of valid Branch Predictor names."""
-    return list(_bp_classes.keys())
-
-# Add all BPs in the object hierarchy.
-for name, cls in inspect.getmembers(m5.objects, is_bp_class):
-    _bp_classes[name] = cls
-
-
-# The same for indirect branch predictors...
-# Dictionary of mapping names of real branch predictor models to classes.
-_indirect_bp_classes = {}
-
-
-def is_indirect_bp_class(cls):
-    """Determine if a class is an indirect branch predictor 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.IndirectPredictor) and \
-            not cls.abstract
-    except (TypeError, AttributeError):
-        return False
-
-def get_indirect(name):
-    """Get an Indirect BP class from a user provided class name or alias."""
-
-    try:
-        indirect_bp_class = _indirect_bp_classes[name]
-        return indirect_bp_class
-    except KeyError:
-        print("%s is not a valid indirect BP model." % (name,))
-        sys.exit(1)
-
-def print_indirect_bp_list():
-    """Print a list of available indirect BP classes."""
-
-    print("Available Indirect BranchPredictor classes:")
-    doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t")
-    for name, cls in _indirect_bp_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 indirect_bp_names():
-    """Return a list of valid Indirect Branch Predictor names."""
-    return _indirect_bp_classes.keys()
-
-# Add all indirect BPs in the object hierarchy.
-for name, cls in inspect.getmembers(m5.objects, is_indirect_bp_class):
-    _indirect_bp_classes[name] = cls
-
diff --git a/configs/common/ObjectList.py b/configs/common/ObjectList.py
index 31f8c4194..0b08b2392 100644
--- a/configs/common/ObjectList.py
+++ b/configs/common/ObjectList.py
@@ -135,7 +135,9 @@ class CPUList(ObjectList):
                     self._is_obj_class):
                     self._sub_classes[name] = cls
 
+bp_list = ObjectList(m5.objects.BranchPredictor)
 cpu_list = CPUList(m5.objects.BaseCPU)
+indirect_bp_list = ObjectList(m5.objects.IndirectPredictor)
 
 def _subclass_tester(name):
     sub_class = getattr(m5.objects, name, None)
diff --git a/configs/common/Options.py b/configs/common/Options.py
index 57ee562cc..ebcd74ed4 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 BPConfig
 from . import HWPConfig
 from . import MemConfig
 from . import PlatformConfig
@@ -57,7 +56,7 @@ def _listCpuTypes(option, opt, value, parser):
     sys.exit(0)
 
 def _listBPTypes(option, opt, value, parser):
-    BPConfig.print_bp_list()
+    ObjectList.bp_list.print()
     sys.exit(0)
 
 def _listHWPTypes(option, opt, value, parser):
@@ -65,7 +64,7 @@ def _listHWPTypes(option, opt, value, parser):
     sys.exit(0)
 
 def _listIndirectBPTypes(option, opt, value, parser):
-    BPConfig.print_indirect_bp_list()
+    ObjectList.indirect_bp_list.print()
     sys.exit(0)
 
 def _listMemTypes(option, opt, value, parser):
@@ -172,14 +171,14 @@ def addCommonOptions(parser):
                       action="callback", callback=_listIndirectBPTypes,
                       help="List available indirect branch predictor types")
     parser.add_option("--bp-type", type="choice", default=None,
-                      choices=BPConfig.bp_names(),
+                      choices=ObjectList.bp_list.get_names(),
                       help = """
                       type of branch predictor to run with
                       (if not set, use the default branch predictor of
                       the selected CPU)""")
     parser.add_option("--indirect-bp-type", type="choice",
                       default="SimpleIndirectPredictor",
-                      choices=BPConfig.indirect_bp_names(),
+                      choices=ObjectList.indirect_bp_list.get_names(),
                       help = "type of indirect branch predictor to run with")
     parser.add_option("--list-hwp-types",
                       action="callback", callback=_listHWPTypes,
diff --git a/configs/common/Simulation.py b/configs/common/Simulation.py
index 457caf9aa..ceba1474a 100644
--- a/configs/common/Simulation.py
+++ b/configs/common/Simulation.py
@@ -48,7 +48,6 @@ from os.path import join as joinpath
 
 from common import CpuConfig
 from . import ObjectList
-from . import BPConfig
 from . import MemConfig
 
 import m5
@@ -482,11 +481,11 @@ def run(options, root, testsys, cpu_class):
             if options.checker:
                 switch_cpus[i].addCheckerCpu()
             if options.bp_type:
-                bpClass = BPConfig.get(options.bp_type)
+                bpClass = ObjectList.bp_list.get(options.bp_type)
                 switch_cpus[i].branchPred = bpClass()
             if options.indirect_bp_type:
-                IndirectBPClass = \
-                    BPConfig.get_indirect(options.indirect_bp_type)
+                IndirectBPClass = ObjectList.indirect_bp_list.get(
+                    options.indirect_bp_type)
                 switch_cpus[i].branchPred.indirectBranchPred = \
                     IndirectBPClass()
 
diff --git a/configs/example/fs.py b/configs/example/fs.py
index ee813ff5d..e1501e674 100644
--- a/configs/example/fs.py
+++ b/configs/example/fs.py
@@ -65,7 +65,6 @@ from common import CacheConfig
 from common import CpuConfig
 from common import MemConfig
 from common import ObjectList
-from common import BPConfig
 from common.Caches import *
 from common import Options
 
@@ -206,11 +205,11 @@ def build_test_system(np):
             if options.checker:
                 test_sys.cpu[i].addCheckerCpu()
             if options.bp_type:
-                bpClass = BPConfig.get(options.bp_type)
+                bpClass = ObjectList.bp_list.get(options.bp_type)
                 test_sys.cpu[i].branchPred = bpClass()
             if options.indirect_bp_type:
-                IndirectBPClass = \
-                    BPConfig.get_indirect(options.indirect_bp_type)
+                IndirectBPClass = ObjectList.indirect_bp_list.get(
+                    options.indirect_bp_type)
                 test_sys.cpu[i].branchPred.indirectBranchPred = \
                     IndirectBPClass()
             test_sys.cpu[i].createThreads()
diff --git a/configs/example/se.py b/configs/example/se.py
index e1396bfa2..1d4de1a85 100644
--- a/configs/example/se.py
+++ b/configs/example/se.py
@@ -63,7 +63,6 @@ from common import Simulation
 from common import CacheConfig
 from common import CpuConfig
 from common import ObjectList
-from common import BPConfig
 from common import MemConfig
 from common.FileSystemConfig import config_filesystem
 from common.Caches import *
@@ -238,11 +237,12 @@ for i in range(np):
         system.cpu[i].addCheckerCpu()
 
     if options.bp_type:
-        bpClass = BPConfig.get(options.bp_type)
+        bpClass = ObjectList.bp_list.get(options.bp_type)
         system.cpu[i].branchPred = bpClass()
 
     if options.indirect_bp_type:
-        indirectBPClass = BPConfig.get_indirect(options.indirect_bp_type)
+        indirectBPClass = \
+            ObjectList.indirect_bp_list.get(options.indirect_bp_type)
         system.cpu[i].branchPred.indirectBranchPred = indirectBPClass()
 
     system.cpu[i].createThreads()