1 # Copyright (c) 2012, 2015 ARM Limited
4 # Copyright (c) 2017, Centre National de la Recherche Scientifique (CNRS)
6 # The license below extends only to copyright in the software and shall
7 # not be construed as granting a license to any other intellectual
8 # property including but not limited to intellectual property relating
9 # to a hardware implementation of the functionality of the software
10 # licensed hereunder. You may use the software subject to the license
11 # terms below provided that you ensure that this notice is replicated
12 # unmodified and in its entirety in all distributions of the software,
13 # modified or unmodified, in source code or in binary form.
15 # Redistribution and use in source and binary forms, with or without
16 # modification, are permitted provided that the following conditions are
17 # met: redistributions of source code must retain the above copyright
18 # notice, this list of conditions and the following disclaimer;
19 # redistributions in binary form must reproduce the above copyright
20 # notice, this list of conditions and the following disclaimer in the
21 # documentation and/or other materials provided with the distribution;
22 # neither the name of the copyright holders nor the names of its
23 # contributors may be used to endorse or promote products derived from
24 # this software without specific prior written permission.
26 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 # Authors: Andreas Sandberg
41 from __future__
import print_function
46 from m5
.util
import fatal
47 from textwrap
import TextWrapper
49 # Dictionary of mapping names of real CPU models to classes.
50 _platform_classes
= {}
52 # Platform aliases. The platforms listed here might not be compiled,
53 # we make sure they exist before we add them to the platform list.
54 _platform_aliases_all
= [
55 ("RealView_PBX", "RealViewPBX"),
56 ("VExpress_GEM5", "VExpress_GEM5_V1"),
59 # Filtered list of aliases. Only aliases for existing platforms exist
61 _platform_aliases
= {}
63 def is_platform_class(cls
):
64 """Determine if a class is a Platform that can be instantiated"""
66 # We can't use the normal inspect.isclass because the ParamFactory
67 # and ProxyFactory classes have a tendency to confuse it.
69 return issubclass(cls
, m5
.objects
.Platform
) and \
71 except (TypeError, AttributeError):
75 """Get a platform class from a user provided class name."""
77 real_name
= _platform_aliases
.get(name
, name
)
80 return _platform_classes
[real_name
]
82 fatal("%s is not a valid Platform model." % (name
,))
84 def print_platform_list():
85 """Print a list of available Platform classes including their aliases."""
87 print("Available Platform classes:")
88 doc_wrapper
= TextWrapper(initial_indent
="\t\t", subsequent_indent
="\t\t")
89 for name
, cls
in _platform_classes
.items():
92 # Try to extract the class documentation from the class help
94 doc
= inspect
.getdoc(cls
)
96 for line
in doc_wrapper
.wrap(doc
):
100 print("\Platform aliases:")
101 for alias
, target
in _platform_aliases
.items():
102 print("\t%s => %s" % (alias
, target
))
104 def platform_names():
105 """Return a list of valid Platform names."""
106 return _platform_classes
.keys() + _platform_aliases
.keys()
108 # Add all Platforms in the object hierarchy.
109 for name
, cls
in inspect
.getmembers(m5
.objects
, is_platform_class
):
110 _platform_classes
[name
] = cls
112 for alias
, target
in _platform_aliases_all
:
113 if target
in _platform_classes
:
114 _platform_aliases
[alias
] = target