summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Sandberg <Andreas.Sandberg@ARM.com>2013-02-15 17:40:08 -0500
committerAndreas Sandberg <Andreas.Sandberg@ARM.com>2013-02-15 17:40:08 -0500
commite9f66dceac5ce2665001f9f74222964ef0aef74b (patch)
tree0c7ac355e9cfe1772676a76f2db8a8a61a59ec95
parent7f1263f1446b789e9f88685ae763ba575e81e454 (diff)
downloadgem5-e9f66dceac5ce2665001f9f74222964ef0aef74b.tar.xz
config: Cleanup CPU configuration
The CPUs supported by the configuration scripts used to be hard-coded. This was not ideal for several reasons. For example, the configuration scripts depend on all CPU models even though only a subset might have been compiled. This changeset adds a new module to the configuration scripts that automatically discovers the available CPU models from the compiled SimObjects. As a nice bonus, the use of introspection allows us to automatically generate a list of available CPU models suitable for printing. This list is augmented with the Python doc string from the underlying class if available.
-rw-r--r--configs/common/CpuConfig.py132
-rw-r--r--configs/common/Options.py12
-rw-r--r--configs/common/Simulation.py19
3 files changed, 147 insertions, 16 deletions
diff --git a/configs/common/CpuConfig.py b/configs/common/CpuConfig.py
new file mode 100644
index 000000000..6b8a21500
--- /dev/null
+++ b/configs/common/CpuConfig.py
@@ -0,0 +1,132 @@
+# Copyright (c) 2012 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.
+#
+# Authors: Andreas Sandberg
+
+import m5.objects
+import inspect
+import sys
+from textwrap import TextWrapper
+
+# Dictionary of mapping names of real CPU models to classes.
+_cpu_classes = {}
+
+# CPU aliases. The CPUs listed here might not be compiled, we make
+# sure they exist before we add them to the CPU list. A target may be
+# specified as a tuple, in which case the first available CPU model in
+# the tuple will be used as the target.
+_cpu_aliases_all = [
+ ("timing", "TimingSimpleCPU"),
+ ("atomic", "AtomicSimpleCPU"),
+ ("inorder", "InOrderCPU"),
+ ("detailed", "DerivO3CPU"),
+ ]
+
+# Filtered list of aliases. Only aliases for existing CPUs exist in
+# this list.
+_cpu_aliases = {}
+
+
+def is_cpu_class(cls):
+ """Determine if a class is a CPU 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.BaseCPU) and \
+ not cls.abstract and \
+ not issubclass(cls, m5.objects.CheckerCPU)
+ except TypeError:
+ return False
+
+def get(name):
+ """Get a CPU class from a user provided class name or alias."""
+
+ real_name = _cpu_aliases.get(name, name)
+
+ try:
+ cpu_class = _cpu_classes[real_name]
+ return cpu_class
+ except KeyError:
+ print "%s is not a valid CPU model." % (name,)
+ sys.exit(1)
+
+def print_cpu_list():
+ """Print a list of available CPU classes including their aliases."""
+
+ print "Available CPU classes:"
+ doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t")
+ for name, cls in _cpu_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 _cpu_aliases:
+ print "\nCPU aliases:"
+ for alias, target in _cpu_aliases.items():
+ print "\t%s => %s" % (alias, target)
+
+def cpu_names():
+ """Return a list of valid CPU names."""
+ return _cpu_classes.keys() + _cpu_aliases.keys()
+
+# The ARM detailed CPU is special in the sense that it doesn't exist
+# in the normal object hierarchy, so we have to add it manually.
+try:
+ from O3_ARM_v7a import O3_ARM_v7a_3
+ _cpu_classes["arm_detailed"] = O3_ARM_v7a_3
+except:
+ pass
+
+# Add all CPUs in the object hierarchy.
+for name, cls in inspect.getmembers(m5.objects, is_cpu_class):
+ _cpu_classes[name] = cls
+
+for alias, target in _cpu_aliases_all:
+ if isinstance(target, tuple):
+ # Some aliases contain a list of CPU model sorted in priority
+ # order. Use the first target that's available.
+ for t in target:
+ if t in _cpu_classes:
+ _cpu_aliases[alias] = t
+ break
+ elif target in _cpu_classes:
+ # Normal alias
+ _cpu_aliases[alias] = target
diff --git a/configs/common/Options.py b/configs/common/Options.py
index 794addb6a..63951950f 100644
--- a/configs/common/Options.py
+++ b/configs/common/Options.py
@@ -31,11 +31,19 @@ from m5.defines import buildEnv
from m5.objects import *
from Benchmarks import *
+import CpuConfig
+
+def _listCpuTypes(option, opt, value, parser):
+ CpuConfig.print_cpu_list()
+ sys.exit(0)
+
def addCommonOptions(parser):
# system options
+ parser.add_option("--list-cpu-types",
+ action="callback", callback=_listCpuTypes,
+ help="List available CPU types")
parser.add_option("--cpu-type", type="choice", default="atomic",
- choices = ["atomic", "timing", "detailed", "inorder",
- "arm_detailed"],
+ choices=CpuConfig.cpu_names(),
help = "type of cpu to run with")
parser.add_option("--checker", action="store_true");
parser.add_option("-n", "--num-cpus", type="int", default=1)
diff --git a/configs/common/Simulation.py b/configs/common/Simulation.py
index 70b21980e..d678c57a0 100644
--- a/configs/common/Simulation.py
+++ b/configs/common/Simulation.py
@@ -43,28 +43,19 @@ import sys
from os import getcwd
from os.path import join as joinpath
+import CpuConfig
+
import m5
from m5.defines import buildEnv
from m5.objects import *
from m5.util import *
-from O3_ARM_v7a import *
addToPath('../common')
def getCPUClass(cpu_type):
- """Returns the required cpu class and the mode of operation.
- """
-
- if cpu_type == "timing":
- return TimingSimpleCPU, 'timing'
- elif cpu_type == "detailed":
- return DerivO3CPU, 'timing'
- elif cpu_type == "arm_detailed":
- return O3_ARM_v7a_3, 'timing'
- elif cpu_type == "inorder":
- return InOrderCPU, 'timing'
- else:
- return AtomicSimpleCPU, 'atomic'
+ """Returns the required cpu class and the mode of operation."""
+ cls = CpuConfig.get(cpu_type)
+ return cls, cls.memory_mode()
def setCPUClass(options):
"""Returns two cpu classes and the initial mode of operation.