# -*- mode:python -*-
+# Copyright (c) 2018 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.
#
#
# Authors: Nathan Binkert
+from __future__ import print_function
+
import array
import bisect
+import functools
import imp
-import marshal
import os
import re
-import subprocess
import sys
import zlib
# When specifying a source file of some type, a set of tags can be
# specified for that file.
+class SourceFilter(object):
+ def __init__(self, predicate):
+ self.predicate = predicate
+
+ def __or__(self, other):
+ return SourceFilter(lambda tags: self.predicate(tags) or
+ other.predicate(tags))
+
+ def __and__(self, other):
+ return SourceFilter(lambda tags: self.predicate(tags) and
+ other.predicate(tags))
+
+def with_tags_that(predicate):
+ '''Return a list of sources with tags that satisfy a predicate.'''
+ return SourceFilter(predicate)
+
+def with_any_tags(*tags):
+ '''Return a list of sources with any of the supplied tags.'''
+ return SourceFilter(lambda stags: len(set(tags) & stags) > 0)
+
+def with_all_tags(*tags):
+ '''Return a list of sources with all of the supplied tags.'''
+ return SourceFilter(lambda stags: set(tags) <= stags)
+
+def with_tag(tag):
+ '''Return a list of sources with the supplied tag.'''
+ return SourceFilter(lambda stags: tag in stags)
+
+def without_tags(*tags):
+ '''Return a list of sources without any of the supplied tags.'''
+ return SourceFilter(lambda stags: len(set(tags) & stags) == 0)
+
+def without_tag(tag):
+ '''Return a list of sources with the supplied tag.'''
+ return SourceFilter(lambda stags: tag not in stags)
+
+source_filter_factories = {
+ 'with_tags_that': with_tags_that,
+ 'with_any_tags': with_any_tags,
+ 'with_all_tags': with_all_tags,
+ 'with_tag': with_tag,
+ 'without_tags': without_tags,
+ 'without_tag': without_tag,
+}
+
+Export(source_filter_factories)
+
class SourceList(list):
- def with_tags_that(self, predicate):
- '''Return a list of sources with tags that satisfy a predicate.'''
+ def apply_filter(self, f):
def match(source):
- return predicate(source.tags)
+ return f.predicate(source.tags)
return SourceList(filter(match, self))
- def with_any_tags(self, *tags):
- '''Return a list of sources with any of the supplied tags.'''
- return self.with_tags_that(lambda stags: len(tags & stags) > 0)
-
- def with_all_tags(self, *tags):
- '''Return a list of sources with all of the supplied tags.'''
- return self.with_tags_that(lambda stags: tags <= stags)
-
- def with_tag(self, tag):
- '''Return a list of sources with the supplied tag.'''
- return self.with_tags_that(lambda stags: tag in stags)
-
- def without_tags(self, *tags):
- '''Return a list of sources without any of the supplied tags.'''
- return self.with_tags_that(lambda stags: len(tags & stags) == 0)
+ def __getattr__(self, name):
+ func = source_filter_factories.get(name, None)
+ if not func:
+ raise AttributeError
- def without_tag(self, tag):
- '''Return a list of sources with the supplied tag.'''
- return self.with_tags_that(lambda stags: tag not in stags)
+ @functools.wraps(func)
+ def wrapper(*args, **kwargs):
+ return self.apply_filter(func(*args, **kwargs))
+ return wrapper
class SourceMeta(type):
'''Meta class for source files that keeps track of all files of a
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):
if tags is None:
tags='gem5 lib'
if isinstance(tags, basestring):
tags = set([tags])
- if isinstance(add_tags, basestring):
- add_tags = set([add_tags])
+ if not isinstance(tags, set):
+ tags = set(tags)
+ self.tags = tags
+
if add_tags:
- tags = tags | add_tags
- self.tags = set(tags)
+ if isinstance(add_tags, basestring):
+ add_tags = set([add_tags])
+ if not isinstance(add_tags, set):
+ add_tags = set(add_tags)
+ self.tags |= add_tags
tnode = source
if not isinstance(source, SCons.Node.FS.File):
if issubclass(base, SourceFile):
base.all.append(self)
+ def static(self, env):
+ key = (self.tnode, env['OBJSUFFIX'])
+ 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 not key in self.shared_objs:
+ self.shared_objs[key] = env.SharedObject(self.tnode)
+ return self.shared_objs[key]
+
@property
def filename(self):
return str(self.tnode)
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 xrange(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):
+ data = file(str(source[0]), 'r').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.cc_file = File(modname + '.pb.cc')
self.hh_file = File(modname + '.pb.h')
-class UnitTest(object):
- '''Create a UnitTest'''
+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 = []
+
+class Executable(object):
+ '''Base class for creating an executable from sources.'''
+ __metaclass__ = ExecutableMeta
+
+ 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)
- UnitTest.all.append(self)
+
+ 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, *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('Executable')
Export('UnitTest')
+Export('GTest')
########################################################################
#
compileDate = _m5.core.compileDate
_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
# Add the C++ source file
Source(proto.cc_file, tags=proto.tags)
elif ProtoBuf.all:
- print 'Got protobuf to build, but lacks support!'
+ print('Got protobuf to build, but lacks support!')
Exit(1)
#
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 = 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])])
- 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,
+ 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
# 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')
new_env.Label = label
new_env.Append(**kwargs)
- def make_obj(source, static, extra_deps=None):
- '''This function creates a scons node of the requested type, and sets
- up any additional dependencies.'''
-
- if static:
- obj = new_env.StaticObject(source.tnode)
- else:
- obj = new_env.SharedObject(source.tnode)
-
- if extra_deps:
- new_env.Depends(obj, extra_deps)
-
- return obj
-
lib_sources = Source.all.with_tag('gem5 lib')
# Without Python, leave out all Python content from the library
shared_objs = []
for s in lib_sources.with_tag(Source.ungrouped_tag):
- static_objs.append(make_obj(s, True))
- shared_objs.append(make_obj(s, False))
-
- partial_objs = []
+ static_objs.append(s.static(new_env))
+ shared_objs.append(s.shared(new_env))
for group in Source.source_groups:
srcs = lib_sources.with_tag(Source.link_group_tag(group))
if not srcs:
continue
+ group_static = [ s.static(new_env) for s in srcs ]
+ group_shared = [ s.shared(new_env) for s in srcs ]
+
# If partial linking is disabled, add these sources to the build
# directly, and short circuit this loop.
if disable_partial:
- for s in srcs:
- static_objs.append(make_obj(s, True))
- shared_objs.append(make_obj(s, False))
+ static_objs.extend(group_static)
+ shared_objs.extend(group_shared)
continue
# Set up the static partially linked objects.
- source_objs = [ make_obj(s, True) for s in srcs ]
file_name = new_env.subst("${OBJPREFIX}lib${OBJSUFFIX}.partial")
target = File(joinpath(group, file_name))
- partial = env.PartialStatic(target=target, source=source_objs)
- static_objs.append(partial)
+ partial = env.PartialStatic(target=target, source=group_static)
+ static_objs.extend(partial)
# Set up the shared partially linked objects.
- source_objs = [ make_obj(s, False) for s in srcs ]
file_name = new_env.subst("${SHOBJPREFIX}lib${SHOBJSUFFIX}.partial")
target = File(joinpath(group, file_name))
- partial = env.PartialShared(target=target, source=source_objs)
- shared_objs.append(partial)
+ partial = env.PartialShared(target=target, source=group_shared)
+ shared_objs.extend(partial)
+
+ static_date = date_source.static(new_env)
+ new_env.Depends(static_date, static_objs)
+ static_objs.extend(static_date)
- static_date = make_obj(date_source, static=True, extra_deps=static_objs)
- static_objs.append(static_date)
+ shared_date = date_source.shared(new_env)
+ new_env.Depends(shared_date, shared_objs)
+ shared_objs.extend(shared_date)
- shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
- shared_objs.append(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 = [ make_obj(s, True) 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 = [ make_obj(s, static=True) 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)
+ new_env['STATIC_LIB'] = static_lib
+ new_env['SHARED_LIB'] = shared_lib
- progname = exename
- if strip:
- progname += '.unstripped'
+ # Record some settings for building Executables.
+ new_env['EXE_SUFFIX'] = label
+ new_env['STRIP_EXES'] = strip
- targets = new_env.Program(progname, main_objs + static_objs)
+ for cls in ExecutableMeta.all:
+ cls.declare_all(new_env)
- 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.M5Binary = File(gem5_binary.path(new_env))
- new_env.Command(secondary_exename, exename,
+ new_env.Command(secondary_exename, new_env.M5Binary,
MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
- new_env.M5Binary = targets[0]
-
# Set up regression tests.
SConscript(os.path.join(env.root.abspath, 'tests', 'SConscript'),
variant_dir=Dir('tests').Dir(new_env.Label),
for target in ['opt', 'fast', 'prof', 'perf']:
ccflags[target] += ['-O3']
else:
- print 'Unknown compiler, please fix compiler options'
+ print('Unknown compiler, please fix compiler options')
Exit(1)
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:
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']))
+ LINKFLAGS = Split(ldflags['debug']),
+ disable_partial=disable_partial)
# Optimized binary
if 'opt' in needed_envs:
makeEnv(env, 'opt', '.o',
CCFLAGS = Split(ccflags['opt']),
CPPDEFINES = ['TRACING_ON=1'],
- LINKFLAGS = Split(ldflags['opt']))
+ LINKFLAGS = Split(ldflags['opt']),
+ disable_partial=disable_partial)
# "Fast" binary
if 'fast' in needed_envs:
- disable_partial = \
- env.get('BROKEN_INCREMENTAL_LTO', False) and \
- GetOption('force_lto')
+ disable_partial = disable_partial or \
+ (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'],
makeEnv(env, 'prof', '.po',
CCFLAGS = Split(ccflags['prof']),
CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
- LINKFLAGS = Split(ldflags['prof']))
+ LINKFLAGS = Split(ldflags['prof']),
+ disable_partial=disable_partial)
# 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']))
+ LINKFLAGS = Split(ldflags['perf']),
+ disable_partial=disable_partial)
projects / gem5.git / blobdiff