configs/common/CpuConfig.py

   1 # Copyright (c) 2012 ARM Limited
   2 # All rights reserved.
   3 #
   4 # The license below extends only to copyright in the software and shall
   5 # not be construed as granting a license to any other intellectual
   6 # property including but not limited to intellectual property relating
   7 # to a hardware implementation of the functionality of the software
   8 # licensed hereunder.  You may use the software subject to the license
   9 # terms below provided that you ensure that this notice is replicated
  10 # unmodified and in its entirety in all distributions of the software,
  11 # modified or unmodified, in source code or in binary form.
  12 #
  13 # Redistribution and use in source and binary forms, with or without
  14 # modification, are permitted provided that the following conditions are
  15 # met: redistributions of source code must retain the above copyright
  16 # notice, this list of conditions and the following disclaimer;
  17 # redistributions in binary form must reproduce the above copyright
  18 # notice, this list of conditions and the following disclaimer in the
  19 # documentation and/or other materials provided with the distribution;
  20 # neither the name of the copyright holders nor the names of its
  21 # contributors may be used to endorse or promote products derived from
  22 # this software without specific prior written permission.
  23 #
  24 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35 #
  36 # Authors: Andreas Sandberg
  37
  38 import m5.objects
  39 import inspect
  40 import sys
  41 from textwrap import  TextWrapper
  42
  43 # Dictionary of mapping names of real CPU models to classes.
  44 _cpu_classes = {}
  45
  46 # CPU aliases. The CPUs listed here might not be compiled, we make
  47 # sure they exist before we add them to the CPU list. A target may be
  48 # specified as a tuple, in which case the first available CPU model in
  49 # the tuple will be used as the target.
  50 _cpu_aliases_all = [
  51     ("timing", "TimingSimpleCPU"),
  52     ("atomic", "AtomicSimpleCPU"),
  53     ("inorder", "InOrderCPU"),
  54     ("minor", "MinorCPU"),
  55     ("detailed", "DerivO3CPU"),
  56     ("kvm", ("ArmKvmCPU", "X86KvmCPU")),
  57     ]
  58
  59 # Filtered list of aliases. Only aliases for existing CPUs exist in
  60 # this list.
  61 _cpu_aliases = {}
  62
  63
  64 def is_cpu_class(cls):
  65     """Determine if a class is a CPU that can be instantiated"""
  66
  67     # We can't use the normal inspect.isclass because the ParamFactory
  68     # and ProxyFactory classes have a tendency to confuse it.
  69     try:
  70         return issubclass(cls, m5.objects.BaseCPU) and \
  71             not cls.abstract and \
  72             not issubclass(cls, m5.objects.CheckerCPU)
  73     except TypeError:
  74         return False
  75
  76 def get(name):
  77     """Get a CPU class from a user provided class name or alias."""
  78
  79     real_name = _cpu_aliases.get(name, name)
  80
  81     try:
  82         cpu_class = _cpu_classes[real_name]
  83         return cpu_class
  84     except KeyError:
  85         print "%s is not a valid CPU model." % (name,)
  86         sys.exit(1)
  87
  88 def print_cpu_list():
  89     """Print a list of available CPU classes including their aliases."""
  90
  91     print "Available CPU classes:"
  92     doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t")
  93     for name, cls in _cpu_classes.items():
  94         print "\t%s" % name
  95
  96         # Try to extract the class documentation from the class help
  97         # string.
  98         doc = inspect.getdoc(cls)
  99         if doc:
 100             for line in doc_wrapper.wrap(doc):
 101                 print line
 102
 103     if _cpu_aliases:
 104         print "\nCPU aliases:"
 105         for alias, target in _cpu_aliases.items():
 106             print "\t%s => %s" % (alias, target)
 107
 108 def cpu_names():
 109     """Return a list of valid CPU names."""
 110     return _cpu_classes.keys() + _cpu_aliases.keys()
 111
 112 # The ARM detailed CPU is special in the sense that it doesn't exist
 113 # in the normal object hierarchy, so we have to add it manually.
 114 try:
 115     from O3_ARM_v7a import O3_ARM_v7a_3
 116     _cpu_classes["arm_detailed"] = O3_ARM_v7a_3
 117 except:
 118     pass
 119
 120 # Add all CPUs in the object hierarchy.
 121 for name, cls in inspect.getmembers(m5.objects, is_cpu_class):
 122     _cpu_classes[name] = cls
 123
 124 for alias, target in _cpu_aliases_all:
 125     if isinstance(target, tuple):
 126         # Some aliases contain a list of CPU model sorted in priority
 127         # order. Use the first target that's available.
 128         for t in target:
 129             if t in _cpu_classes:
 130                 _cpu_aliases[alias] = t
 131                 break
 132     elif target in _cpu_classes:
 133         # Normal alias
 134         _cpu_aliases[alias] = target