PlatformConfig.py (11688:725fef71f376) PlatformConfig.py (11889:3e7a56472f08)
1# Copyright (c) 2012, 2015 ARM Limited
2# All rights reserved.
3#
1# Copyright (c) 2012, 2015 ARM Limited
2# All rights reserved.
3#
4# Copyright (c) 2017, Centre National de la Recherche Scientifique (CNRS)
5#
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
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.
14#
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.
25#
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.
37#
38# Authors: Andreas Sandberg
39# Pierre-Yves Peneau
37
38import m5.objects
39import inspect
40import sys
40
41import m5.objects
42import inspect
43import sys
44from m5.util import fatal
41from textwrap import TextWrapper
42
43# Dictionary of mapping names of real CPU models to classes.
44_platform_classes = {}
45
46# Platform aliases. The platforms listed here might not be compiled,
47# we make sure they exist before we add them to the platform list.
48_platform_aliases_all = [
49 ("RealView_EB", "RealViewEB"),
50 ("RealView_PBX", "RealViewPBX"),
51 ("VExpress_GEM5", "VExpress_GEM5_V1"),
52 ]
53
54# Filtered list of aliases. Only aliases for existing platforms exist
55# in this list.
56_platform_aliases = {}
57
58def is_platform_class(cls):
59 """Determine if a class is a Platform that can be instantiated"""
60
61 # We can't use the normal inspect.isclass because the ParamFactory
62 # and ProxyFactory classes have a tendency to confuse it.
63 try:
64 return issubclass(cls, m5.objects.Platform) and \
65 not cls.abstract
66 except (TypeError, AttributeError):
67 return False
68
69def get(name):
70 """Get a platform class from a user provided class name."""
71
72 real_name = _platform_aliases.get(name, name)
73
74 try:
75 return _platform_classes[real_name]
76 except KeyError:
45from textwrap import TextWrapper
46
47# Dictionary of mapping names of real CPU models to classes.
48_platform_classes = {}
49
50# Platform aliases. The platforms listed here might not be compiled,
51# we make sure they exist before we add them to the platform list.
52_platform_aliases_all = [
53 ("RealView_EB", "RealViewEB"),
54 ("RealView_PBX", "RealViewPBX"),
55 ("VExpress_GEM5", "VExpress_GEM5_V1"),
56 ]
57
58# Filtered list of aliases. Only aliases for existing platforms exist
59# in this list.
60_platform_aliases = {}
61
62def is_platform_class(cls):
63 """Determine if a class is a Platform 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.Platform) and \
69 not cls.abstract
70 except (TypeError, AttributeError):
71 return False
72
73def get(name):
74 """Get a platform class from a user provided class name."""
75
76 real_name = _platform_aliases.get(name, name)
77
78 try:
79 return _platform_classes[real_name]
80 except KeyError:
77 print "%s is not a valid Platform model." % (name,)
78 sys.exit(1)
81 fatal("%s is not a valid Platform model." % (name,))
79
80def print_platform_list():
81 """Print a list of available Platform classes including their aliases."""
82
83 print "Available Platform classes:"
84 doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t")
85 for name, cls in _platform_classes.items():
86 print "\t%s" % name
87
88 # Try to extract the class documentation from the class help
89 # string.
90 doc = inspect.getdoc(cls)
91 if doc:
92 for line in doc_wrapper.wrap(doc):
93 print line
94
95 if _platform_aliases:
96 print "\Platform aliases:"
97 for alias, target in _platform_aliases.items():
98 print "\t%s => %s" % (alias, target)
99
100def platform_names():
101 """Return a list of valid Platform names."""
102 return _platform_classes.keys() + _platform_aliases.keys()
103
104# Add all Platforms in the object hierarchy.
105for name, cls in inspect.getmembers(m5.objects, is_platform_class):
106 _platform_classes[name] = cls
107
108for alias, target in _platform_aliases_all:
109 if target in _platform_classes:
110 _platform_aliases[alias] = target
82
83def print_platform_list():
84 """Print a list of available Platform classes including their aliases."""
85
86 print "Available Platform classes:"
87 doc_wrapper = TextWrapper(initial_indent="\t\t", subsequent_indent="\t\t")
88 for name, cls in _platform_classes.items():
89 print "\t%s" % name
90
91 # Try to extract the class documentation from the class help
92 # string.
93 doc = inspect.getdoc(cls)
94 if doc:
95 for line in doc_wrapper.wrap(doc):
96 print line
97
98 if _platform_aliases:
99 print "\Platform aliases:"
100 for alias, target in _platform_aliases.items():
101 print "\t%s => %s" % (alias, target)
102
103def platform_names():
104 """Return a list of valid Platform names."""
105 return _platform_classes.keys() + _platform_aliases.keys()
106
107# Add all Platforms in the object hierarchy.
108for name, cls in inspect.getmembers(m5.objects, is_platform_class):
109 _platform_classes[name] = cls
110
111for alias, target in _platform_aliases_all:
112 if target in _platform_classes:
113 _platform_aliases[alias] = target