#
# 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
import SCons
+from gem5_scons import Transform
+
# This file defines how to build a particular configuration of gem5
# based on variable settings in the 'env' build environment.
########################################################################
# Code for adding source files of various types
#
-# When specifying a source file of some type, a set of guards can be
-# specified for that file. When get() is used to find the files, if
-# get specifies a set of filters, only files that match those filters
-# will be accepted (unspecified filters on files are assumed to be
-# false). Current filters are:
-# main -- specifies the gem5 main() function
-# skip_lib -- do not put this file into the gem5 library
-# <unittest> -- unit tests use filters based on the unit test name
-#
-# A parent can now be specified for a source file and default filter
-# values will be retrieved recursively from parents (children override
-# parents).
-#
+# 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 apply_filter(self, f):
+ def match(source):
+ return f.predicate(source.tags)
+ return SourceList(filter(match, self))
+
+ def __getattr__(self, name):
+ func = source_filter_factories.get(name, None)
+ if not func:
+ raise AttributeError
+
+ @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
- particular type and has a get function for finding all functions
- of a certain type that match a set of guards'''
+ particular type.'''
def __init__(cls, name, bases, dict):
super(SourceMeta, cls).__init__(name, bases, dict)
- cls.all = []
-
- def get(cls, **guards):
- '''Find all files that match the specified guards. If a source
- file does not specify a flag, the default is False'''
- for src in cls.all:
- for flag,value in guards.iteritems():
- # if the flag is found and has a different value, skip
- # this file
- if src.all_guards.get(flag, False) != value:
- break
- else:
- yield src
+ cls.all = SourceList()
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 guards which
- describing which builds the source file applies to. A parent can
- also be specified to get default guards from'''
+ of those. A source file also specifies a set of tags which
+ describing arbitrary properties of the source file.'''
__metaclass__ = SourceMeta
- def __init__(self, source, parent=None, **guards):
- self.guards = guards
- self.parent = parent
+
+ 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 not isinstance(tags, set):
+ tags = set(tags)
+ self.tags = tags
+
+ if add_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)
return self.basename[:index], self.basename[index+1:]
- @property
- def all_guards(self):
- '''find all guards for this object getting default values
- recursively from its parents'''
- guards = {}
- if self.parent:
- guards.update(self.parent.guards)
- guards.update(self.guards)
- return guards
-
def __lt__(self, other): return self.filename < other.filename
def __le__(self, other): return self.filename <= other.filename
def __gt__(self, other): return self.filename > other.filename
def __ge__(self, other): return self.filename >= other.filename
def __eq__(self, other): return self.filename == other.filename
def __ne__(self, other): return self.filename != other.filename
-
+
class Source(SourceFile):
- '''Add a c/c++ source file to the build'''
- def __init__(self, source, swig = False, **guards):
- '''specify the source file, and any guards'''
- super(Source, self).__init__(source, **guards)
+ ungrouped_tag = 'No link group'
+ source_groups = set()
- self.swig = swig
+ _current_group_tag = ungrouped_tag
+
+ @staticmethod
+ def link_group_tag(group):
+ return 'link group: %s' % group
+
+ @classmethod
+ def set_group(cls, group):
+ new_tag = Source.link_group_tag(group)
+ Source._current_group_tag = new_tag
+ Source.source_groups.add(group)
+
+ def _add_link_group_tag(self):
+ 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):
+ '''specify the source file, and any tags'''
+ super(Source, self).__init__(source, tags, add_tags)
+ self._add_link_group_tag()
class PySource(SourceFile):
'''Add a python source file to the named package'''
modules = {}
tnodes = {}
symnames = {}
-
- def __init__(self, package, source, **guards):
- '''specify the python package, the source file, and any guards'''
- super(PySource, self).__init__(source, **guards)
+
+ def __init__(self, package, source, tags=None, add_tags=None):
+ '''specify the python package, the source file, and any tags'''
+ super(PySource, self).__init__(source, tags, add_tags)
modname,ext = self.extname
assert ext == 'py'
fixed = False
modnames = []
- def __init__(self, source, **guards):
- '''Specify the source file and any guards (automatically in
+ def __init__(self, source, tags=None, add_tags=None):
+ '''Specify the source file and any tags (automatically in
the m5.objects package)'''
- super(SimObject, self).__init__('m5.objects', source, **guards)
+ super(SimObject, self).__init__('m5.objects', source, tags, add_tags)
if self.fixed:
raise AttributeError, "Too late to call SimObject now."
bisect.insort_right(SimObject.modnames, self.modname)
-class SwigSource(SourceFile):
- '''Add a swig file to build'''
+class ProtoBuf(SourceFile):
+ '''Add a Protocol Buffer to build'''
- def __init__(self, package, source, **guards):
- '''Specify the python package, the source file, and any guards'''
- super(SwigSource, self).__init__(source, **guards)
+ def __init__(self, source, tags=None, add_tags=None):
+ '''Specify the source file, and any tags'''
+ super(ProtoBuf, self).__init__(source, tags, add_tags)
+ # Get the file name and the extension
modname,ext = self.extname
- assert ext == 'i'
-
- self.module = modname
- cc_file = joinpath(self.dirname, modname + '_wrap.cc')
- py_file = joinpath(self.dirname, modname + '.py')
+ assert ext == 'proto'
- self.cc_source = Source(cc_file, swig=True, parent=self)
- self.py_source = PySource(package, py_file, parent=self)
+ # 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')
-class UnitTest(object):
- '''Create a UnitTest'''
+exectuable_classes = []
+class ExecutableMeta(type):
+ '''Meta class for Executables.'''
all = []
- def __init__(self, target, *sources):
- '''Specify the target name and any sources. Sources that are
- not SourceFiles are evalued with Source(). All files are
- guarded with a guard of the same name as the UnitTest
- target.'''
- srcs = []
+ 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, skip_lib=True)
- src.guards[target] = True
+ src = Source(src, tags=[])
srcs.append(src)
self.sources = srcs
- self.target = target
- UnitTest.all.append(self)
+ 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)
+
+ 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)
+
+ 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('Source')
Export('PySource')
Export('SimObject')
-Export('SwigSource')
+Export('ProtoBuf')
+Export('Executable')
Export('UnitTest')
+Export('GTest')
########################################################################
#
if 'SConscript' in files:
build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
+ Source.set_group(build_dir)
SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
for extra_dir in extras_dir_list:
prefix_len = len(dirname(extra_dir)) + 1
+
+ # Also add the corresponding build directory to pick up generated
+ # include files.
+ env.Append(CPPPATH=Dir(joinpath(env['BUILDDIR'], extra_dir[prefix_len:])))
+
for root, dirs, files in os.walk(extra_dir, topdown=True):
# if build lives in the extras directory, don't walk down it
if 'build' in dirs:
target_isa = env['TARGET_ISA']
def define(isa):
return isa.upper() + '_ISA'
-
+
def namespace(isa):
- return isa[0].upper() + isa[1:].lower() + 'ISA'
+ return isa[0].upper() + isa[1:].lower() + 'ISA'
code = code_formatter()
''')
+ # create defines for the preprocessing and compile-time determination
for i,isa in enumerate(isas):
code('#define $0 $1', define(isa), i + 1)
+ code()
+
+ # 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))
+ code('};')
code('''
#define THE_ISA ${{define(target_isa)}}
#define TheISA ${{namespace(target_isa)}}
+#define THE_ISA_STR "${{target_isa}}"
#endif // __CONFIG_THE_ISA_HH__''')
env.Command('config/the_isa.hh', map(Value, all_isa_list),
MakeAction(makeTheISA, Transform("CFG ISA", 0)))
+def makeTheGPUISA(source, target, env):
+ isas = [ src.get_contents() for src in source ]
+ target_gpu_isa = env['TARGET_GPU_ISA']
+ def define(isa):
+ return isa.upper() + '_ISA'
+
+ def namespace(isa):
+ return isa[0].upper() + isa[1:].lower() + 'ISA'
+
+
+ code = code_formatter()
+ code('''\
+#ifndef __CONFIG_THE_GPU_ISA_HH__
+#define __CONFIG_THE_GPU_ISA_HH__
+
+''')
+
+ # create defines for the preprocessing and compile-time determination
+ for i,isa in enumerate(isas):
+ code('#define $0 $1', define(isa), i + 1)
+ code()
+
+ # 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))
+ code('};')
+
+ code('''
+
+#define THE_GPU_ISA ${{define(target_gpu_isa)}}
+#define TheGpuISA ${{namespace(target_gpu_isa)}}
+#define THE_GPU_ISA_STR "${{target_gpu_isa}}"
+
+#endif // __CONFIG_THE_GPU_ISA_HH__''')
+
+ code.write(str(target[0]))
+
+env.Command('config/the_gpu_isa.hh', map(Value, all_gpu_isa_list),
+ MakeAction(makeTheGPUISA, Transform("CFG ISA", 0)))
+
########################################################################
#
# Prevent any SimObjects from being added after this point, they
if fullname == 'm5.objects':
return self
- if fullname.startswith('m5.internal'):
+ if fullname.startswith('_m5'):
return None
source = self.modules.get(fullname, None)
sim_objects = m5.SimObject.allClasses
all_enums = m5.params.allEnums
-# Find param types that need to be explicitly wrapped with swig.
-# These will be recognized because the ParamDesc will have a
-# swig_decl() method. Most param types are based on types that don't
-# need this, either because they're based on native types (like Int)
-# or because they're SimObjects (which get swigged independently).
-# For now the only things handled here are VectorParam types.
-params_to_swig = {}
for name,obj in sorted(sim_objects.iteritems()):
for param in obj._params.local.values():
# load the ptype attribute now because it depends on the
# SimObject.allClasses will have been loaded
param.ptype
- if not hasattr(param, 'swig_decl'):
- continue
- pname = param.ptype_str
- if pname not in params_to_swig:
- params_to_swig[pname] = param
-
########################################################################
#
# calculate extra dependencies
#
module_depends = ["m5", "m5.SimObject", "m5.params"]
depends = [ PySource.modules[dep].snode for dep in module_depends ]
+depends.sort(key = lambda x: x.name)
########################################################################
#
code = code_formatter()
code("""
-import m5.internal
+import _m5.core
import m5.util
buildEnv = m5.util.SmartDict($build_env)
-compileDate = m5.internal.core.compileDate
+compileDate = _m5.core.compileDate
_globals = globals()
-for key,val in m5.internal.core.__dict__.iteritems():
+for key,val in _m5.core.__dict__.iteritems():
if key.startswith('flag_'):
flag = key[5:]
_globals[flag] = val
def createSimObjectParamStruct(target, source, env):
assert len(target) == 1 and len(source) == 1
- name = str(source[0].get_contents())
+ name = source[0].get_text_contents()
obj = sim_objects[name]
code = code_formatter()
obj.cxx_param_decl(code)
code.write(target[0].abspath)
-def createParamSwigWrapper(target, source, env):
- assert len(target) == 1 and len(source) == 1
+def createSimObjectCxxConfig(is_header):
+ def body(target, source, env):
+ assert len(target) == 1 and len(source) == 1
- name = str(source[0].get_contents())
- param = params_to_swig[name]
+ name = str(source[0].get_contents())
+ obj = sim_objects[name]
- code = code_formatter()
- param.swig_decl(code)
- code.write(target[0].abspath)
+ code = code_formatter()
+ obj.cxx_config_param_file(code, is_header)
+ code.write(target[0].abspath)
+ return body
def createEnumStrings(target, source, env):
- assert len(target) == 1 and len(source) == 1
+ assert len(target) == 1 and len(source) == 2
- name = str(source[0].get_contents())
+ name = source[0].get_text_contents()
+ use_python = source[1].read()
obj = all_enums[name]
code = code_formatter()
obj.cxx_def(code)
+ if use_python:
+ obj.pybind_def(code)
code.write(target[0].abspath)
def createEnumDecls(target, source, env):
assert len(target) == 1 and len(source) == 1
- name = str(source[0].get_contents())
+ name = source[0].get_text_contents()
obj = all_enums[name]
code = code_formatter()
obj.cxx_decl(code)
code.write(target[0].abspath)
-def createEnumSwigWrapper(target, source, env):
- assert len(target) == 1 and len(source) == 1
-
- name = str(source[0].get_contents())
- obj = all_enums[name]
-
- code = code_formatter()
- obj.swig_decl(code)
- code.write(target[0].abspath)
-
-def createSimObjectSwigWrapper(target, source, env):
- name = source[0].get_contents()
+def createSimObjectPyBindWrapper(target, source, env):
+ name = source[0].get_text_contents()
obj = sim_objects[name]
code = code_formatter()
- obj.swig_decl(code)
+ obj.pybind_decl(code)
code.write(target[0].abspath)
# Generate all of the SimObject param C++ struct header files
MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
env.Depends(hh_file, depends + extra_deps)
-# Generate any needed param SWIG wrapper files
-params_i_files = []
-for name,param in params_to_swig.iteritems():
- i_file = File('python/m5/internal/%s.i' % (param.swig_module_name()))
- params_i_files.append(i_file)
- env.Command(i_file, Value(name),
- MakeAction(createParamSwigWrapper, Transform("SW PARAM")))
- env.Depends(i_file, depends)
- SwigSource('m5.internal', i_file)
+# C++ parameter description files
+if GetOption('with_cxx_config'):
+ for name,simobj in sorted(sim_objects.iteritems()):
+ py_source = PySource.modules[simobj.__module__]
+ extra_deps = [ py_source.tnode ]
+
+ cxx_config_hh_file = File('cxx_config/%s.hh' % name)
+ cxx_config_cc_file = File('cxx_config/%s.cc' % name)
+ env.Command(cxx_config_hh_file, Value(name),
+ MakeAction(createSimObjectCxxConfig(True),
+ Transform("CXXCPRHH")))
+ env.Command(cxx_config_cc_file, Value(name),
+ MakeAction(createSimObjectCxxConfig(False),
+ Transform("CXXCPRCC")))
+ env.Depends(cxx_config_hh_file, depends + extra_deps +
+ [File('params/%s.hh' % name), File('sim/cxx_config.hh')])
+ env.Depends(cxx_config_cc_file, depends + extra_deps +
+ [cxx_config_hh_file])
+ Source(cxx_config_cc_file)
+
+ cxx_config_init_cc_file = File('cxx_config/init.cc')
+
+ def createCxxConfigInitCC(target, source, env):
+ assert len(target) == 1 and len(source) == 1
+
+ code = code_formatter()
+
+ for name,simobj in sorted(sim_objects.iteritems()):
+ 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()):
+ not_abstract = not hasattr(simobj, 'abstract') or \
+ not simobj.abstract
+ if not_abstract and 'type' in simobj.__dict__:
+ code('cxx_config_directory["${name}"] = '
+ '${name}CxxConfigParams::makeDirectoryEntry();')
+ code.dedent()
+ code('}')
+ code.write(target[0].abspath)
+
+ py_source = PySource.modules[simobj.__module__]
+ extra_deps = [ py_source.tnode ]
+ 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())
+ 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()):
extra_deps = [ py_source.tnode ]
cc_file = File('enums/%s.cc' % name)
- env.Command(cc_file, Value(name),
+ env.Command(cc_file, [Value(name), Value(env['USE_PYTHON'])],
MakeAction(createEnumStrings, Transform("ENUM STR")))
env.Depends(cc_file, depends + extra_deps)
Source(cc_file)
MakeAction(createEnumDecls, Transform("ENUMDECL")))
env.Depends(hh_file, depends + extra_deps)
- i_file = File('python/m5/internal/enum_%s.i' % name)
- env.Command(i_file, Value(name),
- MakeAction(createEnumSwigWrapper, Transform("ENUMSWIG")))
- env.Depends(i_file, depends + extra_deps)
- SwigSource('m5.internal', i_file)
-
-# Generate SimObject SWIG wrapper files
-for name in sim_objects.iterkeys():
- i_file = File('python/m5/internal/param_%s.i' % name)
- env.Command(i_file, Value(name),
- MakeAction(createSimObjectSwigWrapper, Transform("SO SWIG")))
- env.Depends(i_file, depends)
- SwigSource('m5.internal', i_file)
-
-# Generate the main swig init file
-def makeEmbeddedSwigInit(target, source, env):
- code = code_formatter()
- module = source[0].get_contents()
- code('''\
-#include "sim/init.hh"
-
-extern "C" {
- void init_${module}();
-}
-
-EmbeddedSwig embed_swig_${module}(init_${module});
-''')
- code.write(str(target[0]))
-
-# Build all swig modules
-for swig in SwigSource.all:
- env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
- MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
- '-o ${TARGETS[0]} $SOURCES', Transform("SWIG")))
- cc_file = str(swig.tnode)
- init_file = '%s/%s_init.cc' % (dirname(cc_file), basename(cc_file))
- env.Command(init_file, Value(swig.module),
- MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW")))
- Source(init_file, **swig.guards)
+# Generate SimObject Python bindings wrapper files
+if env['USE_PYTHON']:
+ for name,simobj in sorted(sim_objects.iteritems()):
+ py_source = PySource.modules[simobj.__module__]
+ extra_deps = [ py_source.tnode ]
+ cc_file = File('python/_m5/param_%s.cc' % name)
+ env.Command(cc_file, Value(name),
+ MakeAction(createSimObjectPyBindWrapper,
+ Transform("SO PyBind")))
+ 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
def makeDebugFlagCC(target, source, env):
assert(len(target) == 1 and len(source) == 1)
- val = eval(source[0].get_contents())
- name, compound, desc = val
- compound = list(sorted(compound))
-
code = code_formatter()
+ # delay definition of CompoundFlags until after all the definition
+ # of all constituent SimpleFlags
+ comp_code = code_formatter()
+
# file header
code('''
/*
- * DO NOT EDIT THIS FILE! Automatically generated
+ * DO NOT EDIT THIS FILE! Automatically generated by SCons.
*/
#include "base/debug.hh"
-''')
- for flag in compound:
- code('#include "debug/$flag.hh"')
- code()
- code('namespace Debug {')
- code()
+namespace Debug {
- if not compound:
- code('SimpleFlag $name("$name", "$desc");')
- else:
- code('CompoundFlag $name("$name", "$desc",')
- code.indent()
- last = len(compound) - 1
- for i,flag in enumerate(compound):
- if i != last:
- code('$flag,')
- else:
- code('$flag);')
- code.dedent()
+''')
+
+ for name, flag in sorted(source[0].read().iteritems()):
+ n, compound, desc = flag
+ assert n == name
+ if not compound:
+ code('SimpleFlag $name("$name", "$desc");')
+ else:
+ 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);')
+ comp_code.dedent()
+
+ code.append(comp_code)
code()
code('} // namespace Debug')
# file header boilerplate
code('''\
/*
- * DO NOT EDIT THIS FILE!
- *
- * Automatically generated by SCons
+ * DO NOT EDIT THIS FILE! Automatically generated by SCons.
*/
#ifndef __DEBUG_${name}_HH__
n, compound, desc = flag
assert n == name
- env.Command('debug/%s.hh' % name, Value(flag),
+ hh_file = 'debug/%s.hh' % name
+ env.Command(hh_file, Value(flag),
MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
- env.Command('debug/%s.cc' % name, Value(flag),
- MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
- Source('debug/%s.cc' % name)
+
+env.Command('debug/flags.cc', Value(debug_flags),
+ MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
+Source('debug/flags.cc')
+
+# version tags
+tags = \
+env.Command('sim/tags.cc', None,
+ MakeAction('util/cpt_upgrader.py --get-cc-file > $TARGET',
+ Transform("VER TAGS")))
+env.AlwaysBuild(tags)
# Embed python files. All .py files that have been indicated by a
# PySource() call in a SConscript need to be embedded into the M5
namespace {
-const char data_${sym}[] = {
+const uint8_t data_${sym}[] = {
''')
code.indent()
step = 16
x = array.array('B', data[i:i+step])
code(''.join('%d,' % d for d in x))
code.dedent()
-
+
code('''};
EmbeddedPython embedded_${sym}(
code.write(str(target[0]))
for source in PySource.all:
- env.Command(source.cpp, source.tnode,
+ env.Command(source.cpp, source.tnode,
MakeAction(embedPyFile, Transform("EMBED PY")))
- Source(source.cpp)
+ Source(source.cpp, tags=source.tags, add_tags='python')
########################################################################
#
#
# List of constructed environments to pass back to SConstruct
-envList = []
+date_source = Source('base/date.cc', tags=[])
-date_source = Source('base/date.cc', skip_lib=True)
+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(label, objsfx, strip = False, **kwargs):
+def makeEnv(env, label, objsfx, strip=False, disable_partial=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')
new_env.Label = label
new_env.Append(**kwargs)
- # Always consider warnings errors
- new_env.Append(CCFLAGS='-Werror')
-
- swig_env = new_env.Clone()
- if env['GCC']:
- swig_env.Append(CCFLAGS='-Wno-uninitialized')
- swig_env.Append(CCFLAGS='-Wno-sign-compare')
- swig_env.Append(CCFLAGS='-Wno-parentheses')
- swig_env.Append(CCFLAGS='-Wno-unused-label')
- if compareVersions(env['GCC_VERSION'], '4.6.0') != -1:
- swig_env.Append(CCFLAGS='-Wno-unused-but-set-variable')
- if env['CLANG']:
- swig_env.Append(CCFLAGS=['-Wno-unused-label'])
-
- def make_obj(source, static, extra_deps = None):
- '''This function adds the specified source to the correct
- build environment, and returns the corresponding SCons Object
- nodes'''
-
- if source.swig:
- env = swig_env
- else:
- env = new_env
- if static:
- obj = env.StaticObject(source.tnode)
- else:
- obj = env.SharedObject(source.tnode)
+ lib_sources = Source.all.with_tag('gem5 lib')
+
+ # Without Python, leave out all Python content from the library
+ # builds. The option doesn't affect gem5 built as a program
+ if GetOption('without_python'):
+ lib_sources = lib_sources.without_tag('python')
+
+ static_objs = []
+ shared_objs = []
+
+ for s in lib_sources.with_tag(Source.ungrouped_tag):
+ 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
- if extra_deps:
- env.Depends(obj, extra_deps)
+ group_static = [ s.static(new_env) for s in srcs ]
+ group_shared = [ s.shared(new_env) for s in srcs ]
- return obj
+ # If partial linking is disabled, add these sources to the build
+ # directly, and short circuit this loop.
+ if disable_partial:
+ static_objs.extend(group_static)
+ shared_objs.extend(group_shared)
+ continue
+
+ # Set up the static partially linked objects.
+ file_name = new_env.subst("${OBJPREFIX}lib${OBJSUFFIX}.partial")
+ target = File(joinpath(group, file_name))
+ partial = env.PartialStatic(target=target, source=group_static)
+ static_objs.extend(partial)
+
+ # Set up the shared partially linked objects.
+ file_name = new_env.subst("${SHOBJPREFIX}lib${SHOBJSUFFIX}.partial")
+ target = File(joinpath(group, file_name))
+ partial = env.PartialShared(target=target, source=group_shared)
+ shared_objs.extend(partial)
- static_objs = \
- [ make_obj(s, True) for s in Source.get(main=False, skip_lib=False) ]
- shared_objs = \
- [ make_obj(s, False) for s in Source.get(main=False, skip_lib=False) ]
+ 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 = make_obj(date_source, static=False, extra_deps=shared_objs)
- shared_objs.append(shared_date)
+ shared_date = date_source.shared(new_env)
+ 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 = [ make_obj(s, True) for s in Source.get(main=True) ]
+ # 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:
- flags = { test.target : True }
- test_sources = Source.get(**flags)
- test_objs = [ make_obj(s, static=True) for s in test_sources ]
- testname = "unittest/%s.%s" % (test.target, label)
- new_env.Program(testname, main_objs + 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]
- envList.append(new_env)
-
-# Debug binary
-ccflags = {}
-if env['GCC'] or env['CLANG']:
+ # 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'],
+ 'perf' : ['-g']}
+
+# Start out with the linker flags common to all linkers, i.e. -pg for
+# prof, and -lprofiler for perf. The -lprofile flag is surrounded by
+# no-as-needed and as-needed as the binutils linker is too clever and
+# simply doesn't link to the library otherwise.
+ldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'],
+ 'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']}
+
+# For Link Time Optimization, the optimisation flags used to compile
+# individual files are decoupled from those used at link time
+# (i.e. you can compile with -O3 and perform LTO with -O0), so we need
+# to also update the linker flags based on the target.
+if env['GCC']:
if sys.platform == 'sunos5':
- ccflags['debug'] = '-gstabs+'
+ ccflags['debug'] += ['-gstabs+']
else:
- ccflags['debug'] = '-ggdb3'
- ccflags['opt'] = '-g -O3'
- ccflags['fast'] = '-O3'
- ccflags['prof'] = '-O3 -g -pg'
-elif env['SUNCC']:
- ccflags['debug'] = '-g0'
- ccflags['opt'] = '-g -O'
- ccflags['fast'] = '-fast'
- ccflags['prof'] = '-fast -g -pg'
-elif env['ICC']:
- ccflags['debug'] = '-g -O0'
- ccflags['opt'] = '-g -O'
- ccflags['fast'] = '-fast'
- ccflags['prof'] = '-fast -g -pg'
+ ccflags['debug'] += ['-ggdb3']
+ ldflags['debug'] += ['-O0']
+ # opt, fast, prof and perf all share the same cc flags, also add
+ # the optimization to the ldflags as LTO defers the optimization
+ # to link time
+ for target in ['opt', 'fast', 'prof', 'perf']:
+ ccflags[target] += ['-O3']
+ ldflags[target] += ['-O3']
+
+ ccflags['fast'] += env['LTO_CCFLAGS']
+ ldflags['fast'] += env['LTO_LDFLAGS']
+elif env['CLANG']:
+ ccflags['debug'] += ['-g', '-O0']
+ # opt, fast, prof and perf all share the same cc flags
+ 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)
# need. We try to identify the needed environment for each target; if
# we can't, we fall back on instantiating all the environments just to
# be safe.
-target_types = ['debug', 'opt', 'fast', 'prof']
-obj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof'}
+target_types = ['debug', 'opt', 'fast', 'prof', 'perf']
+obj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
+ 'gpo' : 'perf'}
def identifyTarget(t):
ext = t.split('.')[-1]
# Debug binary
if 'debug' in needed_envs:
- makeEnv('debug', '.do',
+ makeEnv(env, 'debug', '.do',
CCFLAGS = Split(ccflags['debug']),
- CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
+ CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
+ LINKFLAGS = Split(ldflags['debug']))
# Optimized binary
if 'opt' in needed_envs:
- makeEnv('opt', '.o',
+ makeEnv(env, 'opt', '.o',
CCFLAGS = Split(ccflags['opt']),
- CPPDEFINES = ['TRACING_ON=1'])
+ CPPDEFINES = ['TRACING_ON=1'],
+ LINKFLAGS = Split(ldflags['opt']))
# "Fast" binary
if 'fast' in needed_envs:
- makeEnv('fast', '.fo', strip = True,
+ 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'])
+ CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
+ LINKFLAGS = Split(ldflags['fast']),
+ disable_partial=disable_partial)
-# Profiled binary
+# Profiled binary using gprof
if 'prof' in needed_envs:
- makeEnv('prof', '.po',
+ makeEnv(env, 'prof', '.po',
CCFLAGS = Split(ccflags['prof']),
CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
- LINKFLAGS = '-pg')
+ LINKFLAGS = Split(ldflags['prof']))
-Return('envList')
+# 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']))