CpuConfig.py revision 9520:ea7c03ae2d5e 
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
38import m5.objects
39import inspect
40import sys
41from 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    ("detailed", "DerivO3CPU"),
55    ]
56
57# Filtered list of aliases. Only aliases for existing CPUs exist in
58# this list.
59_cpu_aliases = {}
60
61
62def is_cpu_class(cls):
63    """Determine if a class is a CPU that can be instantiated"""
64
65    # We can't use the normal inspect.isclass because the ParamFactory
66    # and ProxyFactory classes have a tendency to confuse it.
67    try:
68        return issubclass(cls, m5.objects.BaseCPU) and \
69            not cls.abstract and \
70            not issubclass(cls, m5.objects.CheckerCPU)
71    except TypeError:
72        return False
73
74def get(name):
75    """Get a CPU class from a user provided class name or alias."""
76
77    real_name = _cpu_aliases.get(name, name)
78
79    try:
80        cpu_class = _cpu_classes[real_name]
81        return cpu_class
82    except KeyError:
83        print "%s is not a valid CPU model." % (name,)
84        sys.exit(1)
85
86def print_cpu_list():
87    """Print a list of available CPU classes including their aliases."""
88
89    print "Available CPU classes:"
90    doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t")
91    for name, cls in _cpu_classes.items():
92        print "\t%s" % name
93
94        # Try to extract the class documentation from the class help
95        # string.
96        doc = inspect.getdoc(cls)
97        if doc:
98            for line in doc_wrapper.wrap(doc):
99                print line
100
101    if _cpu_aliases:
102        print "\nCPU aliases:"
103        for alias, target in _cpu_aliases.items():
104            print "\t%s => %s" % (alias, target)
105
106def cpu_names():
107    """Return a list of valid CPU names."""
108    return _cpu_classes.keys() + _cpu_aliases.keys()
109
110# The ARM detailed CPU is special in the sense that it doesn't exist
111# in the normal object hierarchy, so we have to add it manually.
112try:
113    from O3_ARM_v7a import O3_ARM_v7a_3
114    _cpu_classes["arm_detailed"] = O3_ARM_v7a_3
115except:
116    pass
117
118# Add all CPUs in the object hierarchy.
119for name, cls in inspect.getmembers(m5.objects, is_cpu_class):
120    _cpu_classes[name] = cls
121
122for alias, target in _cpu_aliases_all:
123    if isinstance(target, tuple):
124        # Some aliases contain a list of CPU model sorted in priority
125        # order. Use the first target that's available.
126        for t in target:
127            if t in _cpu_classes:
128                _cpu_aliases[alias] = t
129                break
130    elif target in _cpu_classes:
131        # Normal alias
132        _cpu_aliases[alias] = target
133