# -*- mode:python -*-
+# 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
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder. You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
# Copyright (c) 2004-2005 The Regents of The University of Michigan
# All rights reserved.
#
# 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 array
import bisect
+import distutils.spawn
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.
build_env = [(opt, env[opt]) for opt in export_vars]
-from m5.util import code_formatter, compareVersions
+from m5.util import code_formatter, compareVersions, readCommand
########################################################################
# Code for adding source files of various types
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]
def __eq__(self, other): return self.filename == other.filename
def __ne__(self, other): return self.filename != other.filename
+def blobToCpp(data, symbol, cpp_code, hpp_code=None, namespace=None):
+ '''
+ Convert bytes data into C++ .cpp and .hh uint8_t byte array
+ code containing that binary data.
+
+ :param data: binary data to be converted to C++
+ :param symbol: name of the symbol
+ :param cpp_code: append the generated cpp_code to this object
+ :param hpp_code: append the generated hpp_code to this object
+ If None, ignore it. Otherwise, also include it
+ in the .cpp file.
+ :param namespace: namespace to put the symbol into. If None,
+ don't put the symbols into any namespace.
+ '''
+ symbol_len_declaration = 'const std::size_t {}_len'.format(symbol)
+ symbol_declaration = 'const std::uint8_t {}[]'.format(symbol)
+ if hpp_code is not None:
+ cpp_code('''\
+#include "blobs/{}.hh"
+'''.format(symbol))
+ hpp_code('''\
+#include <cstddef>
+#include <cstdint>
+''')
+ if namespace is not None:
+ hpp_code('namespace {} {{'.format(namespace))
+ hpp_code('extern ' + symbol_len_declaration + ';')
+ hpp_code('extern ' + symbol_declaration + ';')
+ if namespace is not None:
+ hpp_code('}')
+ if namespace is not None:
+ cpp_code('namespace {} {{'.format(namespace))
+ 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 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_code('};')
+ if namespace is not None:
+ cpp_code('}')
+
+def Blob(blob_path, symbol):
+ '''
+ Embed an arbitrary blob into the gem5 executable,
+ and make it accessible to C++ as a byte array.
+ '''
+ blob_path = os.path.abspath(blob_path)
+ blob_out_dir = os.path.join(env['BUILDDIR'], 'blobs')
+ path_noext = joinpath(blob_out_dir, symbol)
+ cpp_path = path_noext + '.cc'
+ hpp_path = path_noext + '.hh'
+ def embedBlob(target, source, env):
+ 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')
+ cpp_path = str(target[0])
+ hpp_path = str(target[1])
+ cpp_dir = os.path.split(cpp_path)[0]
+ if not os.path.exists(cpp_dir):
+ os.makedirs(cpp_dir)
+ cpp_code.write(cpp_path)
+ hpp_code.write(hpp_path)
+ env.Command([cpp_path, hpp_path], blob_path,
+ 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)
+
+# This regular expression is simplistic and assumes that the import takes up
+# the entire line, doesn't have the keyword "public", uses double quotes, has
+# no whitespace at the end before or after the ;, and is all on one line. This
+# should still cover most cases, and a completely accurate scanner would be
+# MUCH more complex.
+protoc_import_re = re.compile(r'^import\s+\"(.*\.proto)\"\;$', re.M)
+
+def protoc_scanner(node, env, path):
+ deps = []
+ for imp in protoc_import_re.findall(node.get_text_contents()):
+ deps.append(Dir(env['BUILDDIR']).File(imp))
+ return deps
+
+env.Append(SCANNERS=Scanner(function=protoc_scanner, skeys=['.proto']))
+
+def protoc_emitter(target, source, env):
+ root, ext = os.path.splitext(source[0].get_abspath())
+ return [root + '.pb.cc', root + '.pb.h'], source
+
+env.Append(BUILDERS={'ProtoBufCC' : Builder(
+ action=MakeAction('${PROTOC} --cpp_out ${BUILDDIR} '
+ '--proto_path ${BUILDDIR} '
+ '${SOURCE.get_abspath()}',
+ Transform("PROTOC")),
+ emitter=protoc_emitter
+ )})
+
class ProtoBuf(SourceFile):
'''Add a Protocol Buffer to build'''
'''Specify the source file, and any tags'''
super(ProtoBuf, self).__init__(source, tags, add_tags)
+ if not env['HAVE_PROTOC'] or not env['HAVE_PROTOBUF']:
+ error('Got protobuf to build, but lacks support!')
+
# Get the file name and the extension
modname,ext = self.extname
assert ext == 'proto'
- # Currently, we stick to generating the C++ headers, so we
- # only need to track the source and header.
- self.cc_file = File(modname + '.pb.cc')
- self.hh_file = File(modname + '.pb.h')
+ self.cc_file, self.hh_file = env.ProtoBufCC(source=source)
-class UnitTest(object):
- '''Create a UnitTest'''
+ # Add the C++ source file
+ Source(self.cc_file, tags=self.tags,
+ append={'CXXFLAGS': '-Wno-array-bounds'})
+
+
+
+env['PROTOC_GRPC'] = distutils.spawn.find_executable('grpc_cpp_plugin')
+if env['PROTOC_GRPC']:
+ env.Append(LIBS=['grpc++'])
+
+def protoc_grpc_emitter(target, source, env):
+ root, ext = os.path.splitext(source[0].get_abspath())
+ return [root + '.grpc.pb.cc', root + '.grpc.pb.h'], source
+env.Append(BUILDERS={'GrpcProtoBufCC' : Builder(
+ action=MakeAction('${PROTOC} --grpc_out ${BUILDDIR} '
+ '--plugin=protoc-gen-grpc=${PROTOC_GRPC} '
+ '--proto_path ${BUILDDIR} '
+ '${SOURCE.get_abspath()}',
+ Transform("PROTOC")),
+ emitter=protoc_grpc_emitter
+ )})
+
+class GrpcProtoBuf(SourceFile):
+ '''Add a GRPC protocol buffer to the build'''
+
+ def __init__(self, source, tags=None, add_tags=None):
+ '''Specify the source file, and any tags'''
+
+ super(GrpcProtoBuf, self).__init__(source, tags, add_tags)
+
+ if not env['PROTOC_GRPC']:
+ error('No grpc_cpp_plugin found')
+
+ self.cc_file, self.hh_file = env.GrpcProtoBufCC(source=source)
+
+ # We still need to build the normal protobuf code too.
+ self.protobuf = ProtoBuf(source, tags=self.tags)
+
+ # Add the C++ source file.
+ Source(self.cc_file, tags=self.tags,
+ append={'CXXFLAGS': '-Wno-array-bounds'})
+
+
+exectuable_classes = []
+class ExecutableMeta(type):
+ '''Meta class for Executables.'''
all = []
- def __init__(self, target, *sources, **kwargs):
- '''Specify the target name and any sources. Sources that are
- not SourceFiles are evalued with Source(). All files are
- tagged with the name of the UnitTest target.'''
+
+ def __init__(cls, name, bases, d):
+ if not d.pop('abstract', False):
+ ExecutableMeta.all.append(cls)
+ super(ExecutableMeta, cls).__init__(name, bases, d)
+
+ cls.all = []
+
+@six.add_metaclass(ExecutableMeta)
+class Executable(object):
+ '''Base class for creating an executable from sources.'''
+
+ abstract = True
+
+ def __init__(self, target, *srcs_and_filts):
+ '''Specify the target name and any sources. Sources that are
+ not SourceFiles are evalued with Source().'''
+ super(Executable, self).__init__()
+ self.all.append(self)
+ self.target = target
+
+ isFilter = lambda arg: isinstance(arg, SourceFilter)
+ self.filters = filter(isFilter, srcs_and_filts)
+ sources = filter(lambda a: not isFilter(a), srcs_and_filts)
srcs = SourceList()
for src in sources:
if not isinstance(src, SourceFile):
- src = Source(src, tags=str(target))
+ src = Source(src, tags=[])
srcs.append(src)
self.sources = srcs
- self.target = target
+ self.dir = Dir('.')
+
+ def path(self, env):
+ return self.dir.File(self.target + '.' + env['EXE_SUFFIX'])
+
+ def srcs_to_objs(self, env, sources):
+ return list([ s.static(env) for s in sources ])
+
+ @classmethod
+ def declare_all(cls, env):
+ return list([ instance.declare(env) for instance in cls.all ])
+
+ def declare(self, env, objs=None):
+ 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')
+ if sys.platform == 'sunos5':
+ cmd = 'cp $SOURCE $TARGET; strip $TARGET'
+ else:
+ cmd = 'strip $SOURCE -o $TARGET'
+ env.Program(unstripped, objs)
+ return env.Command(stripped, unstripped,
+ MakeAction(cmd, Transform("STRIP")))
+ else:
+ return env.Program(self.path(env), objs)
+
+class UnitTest(Executable):
+ '''Create a UnitTest'''
+ def __init__(self, target, *srcs_and_filts, **kwargs):
+ super(UnitTest, self).__init__(target, *srcs_and_filts)
+
self.main = kwargs.get('main', False)
- self.all.append(self)
-class GTest(UnitTest):
+ def declare(self, env):
+ sources = list(self.sources)
+ for f in self.filters:
+ sources += Source.all.apply_filter(f)
+ objs = self.srcs_to_objs(env, sources) + env['STATIC_OBJS']
+ if self.main:
+ objs += env['MAIN_OBJS']
+ return super(UnitTest, self).declare(env, objs)
+
+class GTest(Executable):
'''Create a unit test based on the google test framework.'''
all = []
- def __init__(self, *args, **kwargs):
- isFilter = lambda arg: isinstance(arg, SourceFilter)
- self.filters = filter(isFilter, args)
- args = filter(lambda a: not isFilter(a), args)
- super(GTest, self).__init__(*args, **kwargs)
- self.dir = Dir('.')
+ def __init__(self, *srcs_and_filts, **kwargs):
+ super(GTest, self).__init__(*srcs_and_filts)
+
self.skip_lib = kwargs.pop('skip_lib', False)
+ @classmethod
+ def declare_all(cls, env):
+ env = env.Clone()
+ env.Append(LIBS=env['GTEST_LIBS'])
+ env.Append(CPPFLAGS=env['GTEST_CPPFLAGS'])
+ env['GTEST_LIB_SOURCES'] = Source.all.with_tag('gtest lib')
+ env['GTEST_OUT_DIR'] = \
+ Dir(env['BUILDDIR']).Dir('unittests.' + env['EXE_SUFFIX'])
+ return super(GTest, cls).declare_all(env)
+
+ def declare(self, env):
+ sources = list(self.sources)
+ if not self.skip_lib:
+ sources += env['GTEST_LIB_SOURCES']
+ for f in self.filters:
+ sources += Source.all.apply_filter(f)
+ objs = self.srcs_to_objs(env, sources)
+
+ binary = super(GTest, self).declare(env, objs)
+
+ out_dir = env['GTEST_OUT_DIR']
+ xml_file = out_dir.Dir(str(self.dir)).File(self.target + '.xml')
+ AlwaysBuild(env.Command(xml_file, binary,
+ "${SOURCES[0]} --gtest_output=xml:${TARGETS[0]}"))
+
+ return binary
+
+class Gem5(Executable):
+ '''Create a gem5 executable.'''
+
+ def __init__(self, target):
+ super(Gem5, self).__init__(target)
+
+ def declare(self, env):
+ objs = env['MAIN_OBJS'] + env['STATIC_OBJS']
+ return super(Gem5, self).declare(env, objs)
+
+
# Children should have access
+Export('Blob')
+Export('GdbXml')
Export('Source')
Export('PySource')
Export('SimObject')
Export('ProtoBuf')
+Export('GrpcProtoBuf')
+Export('Executable')
Export('UnitTest')
Export('GTest')
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:
return mod
if fullname == 'm5.defines':
- mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
+ mod.__dict__['buildEnv'] = dict(build_env)
return mod
source = self.modules[fullname]
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("""
import _m5.core
import m5.util
-buildEnv = m5.util.SmartDict($build_env)
+buildEnv = dict($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)
env.Depends(cc_file, depends + extra_deps)
Source(cc_file)
-# Build all protocol buffers if we have got protoc and protobuf available
-if 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} '
- '--proto_path ${SOURCE.dir} $SOURCE',
- Transform("PROTOC")))
-
- # Add the C++ source file
- Source(proto.cc_file, tags=proto.tags)
-elif ProtoBuf.all:
- print 'Got protobuf to build, but lacks support!'
- Exit(1)
-
#
# 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()
namespace {
-const uint8_t data_${sym}[] = {
''')
- code.indent()
- step = 16
- for i in xrange(0, len(data), step):
- x = array.array('B', data[i:i+step])
- code(''.join('%d,' % d for d in x))
- code.dedent()
+ blobToCpp(data, 'data_' + sym, code)
+ code('''\
- code('''};
EmbeddedPython embedded_${sym}(
${{c_str(pysource.arcname)}},
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')
########################################################################
# List of constructed environments to pass back to SConstruct
date_source = Source('base/date.cc', tags=[])
+gem5_binary = Gem5('gem5')
+
# Function to create a new build environment as clone of current
# 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
- exename = 'gem5.' + label
secondary_exename = 'm5.' + label
new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
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.Depends(shared_date, shared_objs)
shared_objs.extend(shared_date)
+ main_objs = [ s.static(new_env) for s in Source.all.with_tag('main') ]
+
# First make a library of everything but main() so other programs can
# link against m5.
static_lib = new_env.StaticLibrary(libname, static_objs)
shared_lib = new_env.SharedLibrary(libname, shared_objs)
- # Now link a stub with main() and the static library.
- main_objs = [ s.static(new_env) for s in Source.all.with_tag('main') ]
+ # Keep track of the object files generated so far so Executables can
+ # include them.
+ new_env['STATIC_OBJS'] = static_objs
+ new_env['SHARED_OBJS'] = shared_objs
+ new_env['MAIN_OBJS'] = main_objs
- for test in UnitTest.all:
- test_sources = Source.all.with_tag(str(test.target))
- test_objs = [ s.static(new_env) for s in test_sources ]
- if test.main:
- test_objs += main_objs
- path = 'unittest/%s.%s' % (test.target, label)
- new_env.Program(path, test_objs + static_objs)
-
- gtest_env = new_env.Clone()
- gtest_env.Append(LIBS=gtest_env['GTEST_LIBS'])
- gtest_env.Append(CPPFLAGS=gtest_env['GTEST_CPPFLAGS'])
- gtestlib_sources = Source.all.with_tag('gtest lib')
- gtest_out_dir = Dir(new_env['BUILDDIR']).Dir('unittests.%s' % label)
- for test in GTest.all:
- test_sources = list(test.sources)
- if not test.skip_lib:
- test_sources += gtestlib_sources
- for f in test.filters:
- test_sources += Source.all.apply_filter(f)
- test_objs = [ s.static(gtest_env) for s in test_sources ]
- test_binary = gtest_env.Program(
- test.dir.File('%s.%s' % (test.target, label)), test_objs)
-
- AlwaysBuild(gtest_env.Command(
- gtest_out_dir.File("%s/%s.xml" % (test.dir, test.target)),
- test_binary, "${SOURCES[0]} --gtest_output=xml:${TARGETS[0]}"))
-
- progname = exename
- if strip:
- progname += '.unstripped'
-
- targets = new_env.Program(progname, main_objs + static_objs)
-
- if strip:
- if sys.platform == 'sunos5':
- cmd = 'cp $SOURCE $TARGET; strip $TARGET'
- else:
- cmd = 'strip $SOURCE -o $TARGET'
- targets = new_env.Command(exename, progname,
- MakeAction(cmd, Transform("STRIP")))
+ new_env['STATIC_LIB'] = static_lib
+ new_env['SHARED_LIB'] = shared_lib
- new_env.Command(secondary_exename, exename,
- MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
+ # Record some settings for building Executables.
+ new_env['EXE_SUFFIX'] = label
+ new_env['STRIP_EXES'] = strip
- new_env.M5Binary = targets[0]
+ for cls in ExecutableMeta.all:
+ cls.declare_all(new_env)
- # 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)
+ new_env.M5Binary = File(gem5_binary.path(new_env))
+
+ new_env.Command(secondary_exename, new_env.M5Binary,
+ MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
# Start out with the compiler flags common to all compilers,
# i.e. they all use -g for opt and -g -pg for prof
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]
# "Fast" binary
if 'fast' in needed_envs:
- disable_partial = \
- 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:
projects / gem5.git / blobdiff