From 34f850f80316201379d888bd72791be93aa5d06f Mon Sep 17 00:00:00 2001 From: "Daniel R. Carvalho" Date: Tue, 3 Sep 2019 15:45:19 +0200 Subject: [PATCH] configs: Port PlatformConfig to the common object list Port PlatformConfig to use the common object list. Change-Id: If62e596bf1f28b49994da3a2800450d163383755 Signed-off-by: Daniel R. Carvalho Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/20593 Tested-by: kokoro Reviewed-by: Andreas Sandberg Maintainer: Andreas Sandberg --- configs/common/FSConfig.py | 4 +- configs/common/ObjectList.py | 36 +++++++-- configs/common/Options.py | 5 +- configs/common/PlatformConfig.py | 115 ---------------------------- configs/example/arm/fs_bigLITTLE.py | 5 +- 5 files changed, 37 insertions(+), 128 deletions(-) delete mode 100644 configs/common/PlatformConfig.py diff --git a/configs/common/FSConfig.py b/configs/common/FSConfig.py index 2c9092262..bf09c4804 100644 --- a/configs/common/FSConfig.py +++ b/configs/common/FSConfig.py @@ -45,7 +45,7 @@ from __future__ import absolute_import from m5.objects import * from m5.util import * from .Benchmarks import * -from . import PlatformConfig +from . import ObjectList # Populate to reflect supported os types per target ISA os_types = { 'alpha' : [ 'linux' ], @@ -231,7 +231,7 @@ def makeArmSystem(mem_mode, machine_type, num_cpus=1, mdesc=None, self.mem_mode = mem_mode - platform_class = PlatformConfig.get(machine_type) + platform_class = ObjectList.platform_list.get(machine_type) # Resolve the real platform name, the original machine_type # variable might have been an alias. machine_type = platform_class.__name__ diff --git a/configs/common/ObjectList.py b/configs/common/ObjectList.py index 62e0db10f..c197439c5 100644 --- a/configs/common/ObjectList.py +++ b/configs/common/ObjectList.py @@ -63,8 +63,9 @@ class ObjectList(object): def get(self, name): """Get a sub class from a user provided class name or alias.""" + real_name = self._aliases.get(name, name) try: - sub_cls = self._sub_classes[name] + sub_cls = self._sub_classes[real_name] return sub_cls except KeyError: print("{} is not a valid sub-class of {}.".format(name, \ @@ -72,7 +73,7 @@ class ObjectList(object): raise def print(self): - """Print the list of available sub-classes.""" + """Print a list of available sub-classes and aliases.""" print("Available {} classes:".format(self.base_cls)) doc_wrapper = TextWrapper(initial_indent="\t\t", @@ -87,16 +88,28 @@ class ObjectList(object): for line in doc_wrapper.wrap(doc): print(line) + if self._aliases: + print("\Aliases:") + for alias, target in self._aliases.items(): + print("\t{} => {}".format(alias, target)) + def get_names(self): - """Return a list of valid sub-class names.""" - return list(self._sub_classes.keys()) + """Return a list of valid sub-class names and aliases.""" + return list(self._sub_classes.keys()) + list(self._aliases.keys()) def _add_objects(self): """Add all sub-classes of the base class in the object hierarchy.""" for name, cls in inspect.getmembers(m5.objects, self._is_obj_class): self._sub_classes[name] = cls - def __init__(self, base_cls): + def _add_aliases(self, aliases): + """Add all aliases of the sub-classes.""" + if aliases is not None: + for alias, target in aliases: + if target in self._sub_classes: + self._aliases[alias] = target + + def __init__(self, base_cls, aliases=None): # Base class that will be used to determine if models are of this # object class self.base_cls = base_cls @@ -104,6 +117,11 @@ class ObjectList(object): self._sub_classes = {} self._add_objects() + # Filtered list of aliases. Only aliases for existing objects exist + # in this list. + self._aliases = {} + self._add_aliases(aliases) + class CPUList(ObjectList): def _is_obj_class(self, cls): """Determine if a class is a CPU that can be instantiated""" @@ -141,6 +159,14 @@ hwp_list = ObjectList(m5.objects.BasePrefetcher) indirect_bp_list = ObjectList(m5.objects.IndirectPredictor) mem_list = ObjectList(m5.objects.AbstractMemory) +# Platform aliases. The platforms listed here might not be compiled, +# we make sure they exist before we add them to the platform list. +_platform_aliases_all = [ + ("RealView_PBX", "RealViewPBX"), + ("VExpress_GEM5", "VExpress_GEM5_V1"), + ] +platform_list = ObjectList(m5.objects.Platform, _platform_aliases_all) + def _subclass_tester(name): sub_class = getattr(m5.objects, name, None) diff --git a/configs/common/Options.py b/configs/common/Options.py index a1cbf4e70..86523ee64 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 PlatformConfig def _listCpuTypes(option, opt, value, parser): ObjectList.cpu_list.print() @@ -70,7 +69,7 @@ def _listMemTypes(option, opt, value, parser): sys.exit(0) def _listPlatformTypes(option, opt, value, parser): - PlatformConfig.print_platform_list() + ObjectList.platform_list.print() sys.exit(0) # Add the very basic options that work also in the case of the no ISA @@ -409,7 +408,7 @@ def addFSOptions(parser): action="callback", callback=_listPlatformTypes, help="List available platform types") parser.add_option("--machine-type", action="store", type="choice", - choices=PlatformConfig.platform_names(), + choices=ObjectList.platform_list.get_names(), default="VExpress_EMM") parser.add_option("--dtb-filename", action="store", type="string", help="Specifies device tree blob file to use with device-tree-"\ diff --git a/configs/common/PlatformConfig.py b/configs/common/PlatformConfig.py deleted file mode 100644 index 0c2ef3649..000000000 --- a/configs/common/PlatformConfig.py +++ /dev/null @@ -1,115 +0,0 @@ -# Copyright (c) 2012, 2015 ARM Limited -# All rights reserved. -# -# Copyright (c) 2017, Centre National de la Recherche Scientifique (CNRS) -# -# 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. -# -# Authors: Andreas Sandberg -# Pierre-Yves Peneau - -from __future__ import print_function -from __future__ import absolute_import - -import m5.objects -import inspect -import sys -from m5.util import fatal -from textwrap import TextWrapper - -# Dictionary of mapping names of real CPU models to classes. -_platform_classes = {} - -# Platform aliases. The platforms listed here might not be compiled, -# we make sure they exist before we add them to the platform list. -_platform_aliases_all = [ - ("RealView_PBX", "RealViewPBX"), - ("VExpress_GEM5", "VExpress_GEM5_V1"), - ] - -# Filtered list of aliases. Only aliases for existing platforms exist -# in this list. -_platform_aliases = {} - -def is_platform_class(cls): - """Determine if a class is a Platform 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.Platform) and \ - not cls.abstract - except (TypeError, AttributeError): - return False - -def get(name): - """Get a platform class from a user provided class name.""" - - real_name = _platform_aliases.get(name, name) - - try: - return _platform_classes[real_name] - except KeyError: - fatal("%s is not a valid Platform model." % (name,)) - -def print_platform_list(): - """Print a list of available Platform classes including their aliases.""" - - print("Available Platform classes:") - doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t") - for name, cls in _platform_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) - - if _platform_aliases: - print("\Platform aliases:") - for alias, target in _platform_aliases.items(): - print("\t%s => %s" % (alias, target)) - -def platform_names(): - """Return a list of valid Platform names.""" - return list(_platform_classes.keys()) + list(_platform_aliases.keys()) - -# Add all Platforms in the object hierarchy. -for name, cls in inspect.getmembers(m5.objects, is_platform_class): - _platform_classes[name] = cls - -for alias, target in _platform_aliases_all: - if target in _platform_classes: - _platform_aliases[alias] = target diff --git a/configs/example/arm/fs_bigLITTLE.py b/configs/example/arm/fs_bigLITTLE.py index a1ad2ce73..1407705b6 100644 --- a/configs/example/arm/fs_bigLITTLE.py +++ b/configs/example/arm/fs_bigLITTLE.py @@ -54,7 +54,6 @@ m5.util.addToPath("../../") from common import SysPaths from common import ObjectList -from common import PlatformConfig from common.cores.arm import ex5_big, ex5_LITTLE import devices @@ -117,7 +116,7 @@ class Ex5LittleCluster(devices.CpuCluster): def createSystem(caches, kernel, bootscript, machine_type="VExpress_GEM5", disks=[]): - platform = PlatformConfig.get(machine_type) + platform = ObjectList.platform_list.get(machine_type) m5.util.inform("Simulated platform: %s", platform.__name__) sys = devices.SimpleSystem(caches, default_mem_size, platform(), @@ -167,7 +166,7 @@ def addOptions(parser): parser.add_argument("--root", type=str, default="/dev/vda1", help="Specify the kernel CLI root= argument") parser.add_argument("--machine-type", type=str, - choices=PlatformConfig.platform_names(), + choices=ObjectList.platform_list.get_names(), default="VExpress_GEM5", help="Hardware platform class") parser.add_argument("--disk", action="append", type=str, default=[], -- 2.30.2