# -*- mode:python -*-
-# Copyright (c) 2018 ARM Limited
+# Copyright (c) 2018, 2020 ARM Limited
#
# The license below extends only to copyright in the software and shall
# not be construed as granting a license to any other intellectual
# 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: Nathan Binkert
from __future__ import print_function
import bisect
import functools
import imp
-import marshal
import os
import re
-import subprocess
+import six
import sys
import zlib
import SCons
-from gem5_scons import Transform
+from gem5_scons import Transform, warning, error
# This file defines how to build a particular configuration of gem5
# based on variable settings in the 'env' build environment.
super(SourceMeta, cls).__init__(name, bases, dict)
cls.all = SourceList()
+@six.add_metaclass(SourceMeta)
class SourceFile(object):
'''Base object that encapsulates the notion of a source file.
This includes, the source node, target node, various manipulations
of those. A source file also specifies a set of tags which
describing arbitrary properties of the source file.'''
- __metaclass__ = SourceMeta
static_objs = {}
shared_objs = {}
- def __init__(self, source, tags=None, add_tags=None):
+ def __init__(self, source, tags=None, add_tags=None, append=None):
if tags is None:
tags='gem5 lib'
- if isinstance(tags, basestring):
+ if isinstance(tags, six.string_types):
tags = set([tags])
if not isinstance(tags, set):
tags = set(tags)
self.tags = tags
if add_tags:
- if isinstance(add_tags, basestring):
+ if isinstance(add_tags, six.string_types):
add_tags = set([add_tags])
if not isinstance(add_tags, set):
add_tags = set(add_tags)
self.tags |= add_tags
+ self.append = append
+
tnode = source
if not isinstance(source, SCons.Node.FS.File):
tnode = File(source)
def static(self, env):
key = (self.tnode, env['OBJSUFFIX'])
+ if self.append:
+ env = env.Clone()
+ env.Append(**self.append)
if not key in self.static_objs:
self.static_objs[key] = env.StaticObject(self.tnode)
return self.static_objs[key]
def shared(self, env):
key = (self.tnode, env['OBJSUFFIX'])
+ if self.append:
+ env = env.Clone()
+ env.Append(**self.append)
if not key in self.shared_objs:
self.shared_objs[key] = env.SharedObject(self.tnode)
return self.shared_objs[key]
hpp_code('}')
if namespace is not None:
cpp_code('namespace {} {{'.format(namespace))
- cpp_code(symbol_len_declaration + ' = {};'.format(len(data)))
+ if hpp_code is not None:
+ cpp_code(symbol_len_declaration + ' = {};'.format(len(data)))
cpp_code(symbol_declaration + ' = {')
cpp_code.indent()
step = 16
- for i in xrange(0, len(data), step):
+ for i in six.moves.range(0, len(data), step):
x = array.array('B', data[i:i+step])
cpp_code(''.join('%d,' % d for d in x))
cpp_code.dedent()
cpp_path = path_noext + '.cc'
hpp_path = path_noext + '.hh'
def embedBlob(target, source, env):
- data = file(str(source[0]), 'r').read()
+ with open(str(source[0]), 'rb') as f:
+ data = f.read()
cpp_code = code_formatter()
hpp_code = code_formatter()
blobToCpp(data, symbol, cpp_code, hpp_code, namespace='Blobs')
MakeAction(embedBlob, Transform("EMBED BLOB")))
Source(cpp_path)
+def GdbXml(xml_id, symbol):
+ Blob(joinpath(gdb_xml_dir, xml_id), symbol)
+
class Source(SourceFile):
ungrouped_tag = 'No link group'
source_groups = set()
self.tags.add(Source._current_group_tag)
'''Add a c/c++ source file to the build'''
- def __init__(self, source, tags=None, add_tags=None):
+ def __init__(self, source, tags=None, add_tags=None, append=None):
'''specify the source file, and any tags'''
- super(Source, self).__init__(source, tags, add_tags)
+ super(Source, self).__init__(source, tags, add_tags, append)
self._add_link_group_tag()
class PySource(SourceFile):
the m5.objects package)'''
super(SimObject, self).__init__('m5.objects', source, tags, add_tags)
if self.fixed:
- raise AttributeError, "Too late to call SimObject now."
+ raise AttributeError("Too late to call SimObject now.")
bisect.insort_right(SimObject.modnames, self.modname)
cls.all = []
+@six.add_metaclass(ExecutableMeta)
class Executable(object):
'''Base class for creating an executable from sources.'''
- __metaclass__ = ExecutableMeta
abstract = True
if objs is None:
objs = self.srcs_to_objs(env, self.sources)
+ env = env.Clone()
+ env['BIN_RPATH_PREFIX'] = os.path.relpath(
+ env['BUILDDIR'], self.path(env).dir.abspath)
+
if env['STRIP_EXES']:
stripped = self.path(env)
unstripped = env.File(str(stripped) + '.unstripped')
def declare(self, env):
sources = list(self.sources)
for f in self.filters:
- sources = Source.all.apply_filter(f)
+ sources += Source.all.apply_filter(f)
objs = self.srcs_to_objs(env, sources) + env['STATIC_OBJS']
if self.main:
objs += env['MAIN_OBJS']
# Children should have access
Export('Blob')
+Export('GdbXml')
Export('Source')
Export('PySource')
Export('SimObject')
debug_flags = {}
def DebugFlag(name, desc=None):
if name in debug_flags:
- raise AttributeError, "Flag %s already specified" % name
+ raise AttributeError("Flag {} already specified".format(name))
debug_flags[name] = (name, (), desc)
def CompoundFlag(name, flags, desc=None):
if name in debug_flags:
- raise AttributeError, "Flag %s already specified" % name
+ raise AttributeError("Flag {} already specified".format(name))
compound = tuple(flags)
debug_flags[name] = (name, compound, desc)
if 'SConscript' in files:
build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
+ Source.set_group(build_dir)
SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
for opt in export_vars:
env.ConfigFile(opt)
def makeTheISA(source, target, env):
- isas = [ src.get_contents() for src in source ]
+ isas = [ src.get_contents().decode('utf-8') for src in source ]
target_isa = env['TARGET_ISA']
def define(isa):
- return isa.upper() + '_ISA'
+ return str(isa.upper()) + '_ISA'
def namespace(isa):
return isa[0].upper() + isa[1:].lower() + 'ISA'
# create an enum for any run-time determination of the ISA, we
# reuse the same name as the namespaces
code('enum class Arch {')
- for i,isa in enumerate(isas):
- if i + 1 == len(isas):
- code(' $0 = $1', namespace(isa), define(isa))
- else:
- code(' $0 = $1,', namespace(isa), define(isa))
+ for isa in isas:
+ code(' $0 = $1,', namespace(isa), define(isa))
code('};')
code('''
code.write(str(target[0]))
-env.Command('config/the_isa.hh', map(Value, all_isa_list),
+env.Command('config/the_isa.hh', list(map(Value, all_isa_list)),
MakeAction(makeTheISA, Transform("CFG ISA", 0)))
def makeTheGPUISA(source, target, env):
- isas = [ src.get_contents() for src in source ]
+ isas = [ src.get_contents().decode('utf-8') for src in source ]
target_gpu_isa = env['TARGET_GPU_ISA']
def define(isa):
- return isa.upper() + '_ISA'
+ return str(isa.upper()) + '_ISA'
def namespace(isa):
return isa[0].upper() + isa[1:].lower() + 'ISA'
# create an enum for any run-time determination of the ISA, we
# reuse the same name as the namespaces
code('enum class GPUArch {')
- for i,isa in enumerate(isas):
- if i + 1 == len(isas):
- code(' $0 = $1', namespace(isa), define(isa))
- else:
- code(' $0 = $1,', namespace(isa), define(isa))
+ for isa in isas:
+ code(' $0 = $1,', namespace(isa), define(isa))
code('};')
code('''
code.write(str(target[0]))
-env.Command('config/the_gpu_isa.hh', map(Value, all_gpu_isa_list),
+env.Command('config/the_gpu_isa.hh', list(map(Value, all_gpu_isa_list)),
MakeAction(makeTheGPUISA, Transform("CFG ISA", 0)))
########################################################################
self.modules = modules
self.installed = set()
- def __del__(self):
- self.unload()
-
def unload(self):
import sys
for module in self.installed:
mod.__path__ = source.modpath
mod.__file__ = source.abspath
- exec file(source.abspath, 'r') in mod.__dict__
+ compiled = compile(open(source.abspath).read(), source.abspath, 'exec')
+ exec(compiled, mod.__dict__)
return mod
sim_objects = m5.SimObject.allClasses
all_enums = m5.params.allEnums
-for name,obj in sorted(sim_objects.iteritems()):
+for name,obj in sorted(sim_objects.items()):
for param in obj._params.local.values():
# load the ptype attribute now because it depends on the
# current version of SimObject.allClasses, but when scons
# Generate Python file containing a dict specifying the current
# buildEnv flags.
def makeDefinesPyFile(target, source, env):
- build_env = source[0].get_contents()
+ build_env = source[0].get_contents().decode('utf-8')
code = code_formatter()
code("""
buildEnv = m5.util.SmartDict($build_env)
compileDate = _m5.core.compileDate
+gem5Version = _m5.core.gem5Version
_globals = globals()
-for key,val in _m5.core.__dict__.iteritems():
+for key,val in _m5.core.__dict__.items():
if key.startswith('flag_'):
flag = key[5:]
_globals[flag] = val
def makeInfoPyFile(target, source, env):
code = code_formatter()
for src in source:
- data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
+ with open(src.srcnode().abspath, 'r') as f:
+ data = ''.join(f)
code('$src = ${{repr(data)}}')
code.write(str(target[0]))
def body(target, source, env):
assert len(target) == 1 and len(source) == 1
- name = str(source[0].get_contents())
+ name = source[0].get_contents().decode('utf-8')
obj = sim_objects[name]
code = code_formatter()
# Generate all of the SimObject param C++ struct header files
params_hh_files = []
-for name,simobj in sorted(sim_objects.iteritems()):
+for name,simobj in sorted(sim_objects.items()):
+ # If this simobject's source changes, we need to regenerate the header.
py_source = PySource.modules[simobj.__module__]
extra_deps = [ py_source.tnode ]
+ # Get the params for just this SimObject, excluding base classes.
+ params = simobj._params.local.values()
+ # Extract the parameters' c++ types.
+ types = sorted(map(lambda p: p.ptype.cxx_type, params))
+ # If any of these types have changed, we need to regenerate the header.
+ extra_deps.append(Value(types))
+
hh_file = File('params/%s.hh' % name)
params_hh_files.append(hh_file)
env.Command(hh_file, Value(name),
# C++ parameter description files
if GetOption('with_cxx_config'):
- for name,simobj in sorted(sim_objects.iteritems()):
+ for name,simobj in sorted(sim_objects.items()):
py_source = PySource.modules[simobj.__module__]
extra_deps = [ py_source.tnode ]
code = code_formatter()
- for name,simobj in sorted(sim_objects.iteritems()):
+ for name,simobj in sorted(sim_objects.items()):
if not hasattr(simobj, 'abstract') or not simobj.abstract:
code('#include "cxx_config/${name}.hh"')
code()
code('void cxxConfigInit()')
code('{')
code.indent()
- for name,simobj in sorted(sim_objects.iteritems()):
+ for name,simobj in sorted(sim_objects.items()):
not_abstract = not hasattr(simobj, 'abstract') or \
not simobj.abstract
if not_abstract and 'type' in simobj.__dict__:
env.Command(cxx_config_init_cc_file, Value(name),
MakeAction(createCxxConfigInitCC, Transform("CXXCINIT")))
cxx_param_hh_files = ["cxx_config/%s.hh" % simobj
- for name,simobj in sorted(sim_objects.iteritems())
+ for name,simobj in sorted(sim_objects.items())
if not hasattr(simobj, 'abstract') or not simobj.abstract]
Depends(cxx_config_init_cc_file, cxx_param_hh_files +
[File('sim/cxx_config.hh')])
Source(cxx_config_init_cc_file)
# Generate all enum header files
-for name,enum in sorted(all_enums.iteritems()):
+for name,enum in sorted(all_enums.items()):
py_source = PySource.modules[enum.__module__]
extra_deps = [ py_source.tnode ]
# Generate SimObject Python bindings wrapper files
if env['USE_PYTHON']:
- for name,simobj in sorted(sim_objects.iteritems()):
+ for name,simobj in sorted(sim_objects.items()):
py_source = PySource.modules[simobj.__module__]
extra_deps = [ py_source.tnode ]
cc_file = File('python/_m5/param_%s.cc' % name)
Source(cc_file)
# Build all protocol buffers if we have got protoc and protobuf available
-if env['HAVE_PROTOBUF']:
+if env['HAVE_PROTOC'] and env['HAVE_PROTOBUF']:
for proto in ProtoBuf.all:
# Use both the source and header as the target, and the .proto
# file as the source. When executing the protoc compiler, also
# specify the proto_path to avoid having the generated files
# include the path.
env.Command([proto.cc_file, proto.hh_file], proto.tnode,
- MakeAction('$PROTOC --cpp_out ${TARGET.dir} '
+ MakeAction('${PROTOC} --cpp_out ${TARGET.dir} '
'--proto_path ${SOURCE.dir} $SOURCE',
Transform("PROTOC")))
# Add the C++ source file
- Source(proto.cc_file, tags=proto.tags)
+ Source(proto.cc_file, tags=proto.tags,
+ append={'CXXFLAGS': '-Wno-array-bounds'})
elif ProtoBuf.all:
- print('Got protobuf to build, but lacks support!')
- Exit(1)
+ error('Got protobuf to build, but lacks support!')
#
# Handle debug flags
''')
- for name, flag in sorted(source[0].read().iteritems()):
+ for name, flag in sorted(source[0].read().items()):
n, compound, desc = flag
assert n == name
if not compound:
code('SimpleFlag $name("$name", "$desc");')
else:
- comp_code('CompoundFlag $name("$name", "$desc",')
+ comp_code('CompoundFlag $name("$name", "$desc", {')
comp_code.indent()
- last = len(compound) - 1
- for i,flag in enumerate(compound):
- if i != last:
- comp_code('&$flag,')
- else:
- comp_code('&$flag);')
+ for flag in compound:
+ comp_code('&$flag,')
comp_code.dedent()
+ comp_code('});')
code.append(comp_code)
code()
code.write(str(target[0]))
-for name,flag in sorted(debug_flags.iteritems()):
+for name,flag in sorted(debug_flags.items()):
n, compound, desc = flag
assert n == name
Transform("VER TAGS")))
env.AlwaysBuild(tags)
+# Build a small helper that marshals the Python code using the same
+# version of Python as gem5. This is in an unorthodox location to
+# avoid building it for every variant.
+py_marshal = marshal_env.Program('marshal', 'python/marshal.cc')[0]
+
# Embed python files. All .py files that have been indicated by a
# PySource() call in a SConscript need to be embedded into the M5
# library. To do that, we compile the file to byte code, marshal the
return "0"
return '"%s"' % string
- '''Action function to compile a .py into a code object, marshal
- it, compress it, and stick it into an asm file so the code appears
- as just bytes with a label in the data section'''
+ '''Action function to compile a .py into a code object, marshal it,
+ compress it, and stick it into an asm file so the code appears as
+ just bytes with a label in the data section. The action takes two
+ sources:
- src = file(str(source[0]), 'r').read()
+ source[0]: Binary used to marshal Python sources
+ source[1]: Python script to marshal
+ '''
+
+ import subprocess
+
+ marshalled = subprocess.check_output(
+ [source[0].abspath, str(source[1])], env=env['ENV'])
- pysource = PySource.tnodes[source[0]]
- compiled = compile(src, pysource.abspath, 'exec')
- marshalled = marshal.dumps(compiled)
compressed = zlib.compress(marshalled)
data = compressed
+ pysource = PySource.tnodes[source[1]]
sym = pysource.symname
code = code_formatter()
code.write(str(target[0]))
for source in PySource.all:
- env.Command(source.cpp, source.tnode,
- MakeAction(embedPyFile, Transform("EMBED PY")))
+ marshal_env.Command(source.cpp, [ py_marshal, source.tnode ],
+ MakeAction(embedPyFile, Transform("EMBED PY")))
Source(source.cpp, tags=source.tags, add_tags='python')
########################################################################
# environment 'env' with modified object suffix and optional stripped
# binary. Additional keyword arguments are appended to corresponding
# build environment vars.
-def makeEnv(env, label, objsfx, strip=False, disable_partial=False, **kwargs):
+def makeEnv(env, label, objsfx, strip=False, **kwargs):
# SCons doesn't know to append a library suffix when there is a '.' in the
# name. Use '_' instead.
libname = 'gem5_' + label
group_static = [ s.static(new_env) for s in srcs ]
group_shared = [ s.shared(new_env) for s in srcs ]
+ # Disable partial linking if mixing it with LTO is broken and LTO
+ # is enabled.
+ #
+ # Also, up until Apple LLVM version 10.0.0 (clang-1000.11.45.5),
+ # partial linked objects do not expose symbols that are marked with
+ # the hidden visibility and consequently building gem5 on Mac OS
+ # fails. As a workaround, we disable partial linking, however, we
+ # may want to revisit in the future.
+ broken_inc_lto = env.get('BROKEN_INCREMENTAL_LTO', False)
+ forced_lto = GetOption('force_lto')
+ darwin = (env['PLATFORM'] == 'darwin')
+ disable_partial = (broken_inc_lto and forced_lto) or darwin
+
# If partial linking is disabled, add these sources to the build
# directly, and short circuit this loop.
if disable_partial:
new_env.Command(secondary_exename, new_env.M5Binary,
MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
- # Set up regression tests.
- SConscript(os.path.join(env.root.abspath, 'tests', 'SConscript'),
- variant_dir=Dir('tests').Dir(new_env.Label),
- exports={ 'env' : new_env }, duplicate=False)
-
# Start out with the compiler flags common to all compilers,
# i.e. they all use -g for opt and -g -pg for prof
ccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'],
for target in ['opt', 'fast', 'prof', 'perf']:
ccflags[target] += ['-O3']
else:
- print('Unknown compiler, please fix compiler options')
- Exit(1)
+ error('Unknown compiler, please fix compiler options')
# To speed things up, we only instantiate the build environments we
ext = t.split('.')[-1]
if ext in target_types:
return ext
- if obj2target.has_key(ext):
+ if ext in obj2target:
return obj2target[ext]
- match = re.search(r'/tests/([^/]+)/', t)
- if match and match.group(1) in target_types:
- return match.group(1)
return 'all'
needed_envs = [identifyTarget(target) for target in BUILD_TARGETS]
if 'all' in needed_envs:
needed_envs += target_types
-disable_partial = False
-if env['PLATFORM'] == 'darwin':
- # Up until Apple LLVM version 10.0.0 (clang-1000.11.45.5), partial
- # linked objects do not expose symbols that are marked with the
- # hidden visibility and consequently building gem5 on Mac OS
- # fails. As a workaround, we disable partial linking, however, we
- # may want to revisit in the future.
- disable_partial = True
-
# Debug binary
if 'debug' in needed_envs:
makeEnv(env, 'debug', '.do',
CCFLAGS = Split(ccflags['debug']),
CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
- LINKFLAGS = Split(ldflags['debug']),
- disable_partial=disable_partial)
+ LINKFLAGS = Split(ldflags['debug']))
# Optimized binary
if 'opt' in needed_envs:
makeEnv(env, 'opt', '.o',
CCFLAGS = Split(ccflags['opt']),
CPPDEFINES = ['TRACING_ON=1'],
- LINKFLAGS = Split(ldflags['opt']),
- disable_partial=disable_partial)
+ LINKFLAGS = Split(ldflags['opt']))
# "Fast" binary
if 'fast' in needed_envs:
- disable_partial = disable_partial and \
- env.get('BROKEN_INCREMENTAL_LTO', False) and \
- GetOption('force_lto')
makeEnv(env, 'fast', '.fo', strip = True,
CCFLAGS = Split(ccflags['fast']),
CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
- LINKFLAGS = Split(ldflags['fast']),
- disable_partial=disable_partial)
+ LINKFLAGS = Split(ldflags['fast']))
# Profiled binary using gprof
if 'prof' in needed_envs:
makeEnv(env, 'prof', '.po',
CCFLAGS = Split(ccflags['prof']),
CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
- LINKFLAGS = Split(ldflags['prof']),
- disable_partial=disable_partial)
+ LINKFLAGS = Split(ldflags['prof']))
# Profiled binary using google-pprof
if 'perf' in needed_envs:
makeEnv(env, 'perf', '.gpo',
CCFLAGS = Split(ccflags['perf']),
CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
- LINKFLAGS = Split(ldflags['perf']),
- disable_partial=disable_partial)
+ LINKFLAGS = Split(ldflags['perf']))
projects / gem5.git / blobdiff