import marshal
import os
import re
+import subprocess
import sys
import zlib
import SCons
-# This file defines how to build a particular configuration of M5
+# This file defines how to build a particular configuration of gem5
# based on variable settings in the 'env' build environment.
Import('*')
build_env = [(opt, env[opt]) for opt in export_vars]
-from m5.util import code_formatter
+from m5.util import code_formatter, compareVersions
########################################################################
# 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
+# skip_no_python -- do not put this file into a no_python library
+# as it embeds compiled Python
+# <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).
+#
+def guarded_source_iterator(sources, **guards):
+ '''Iterate over a set of sources, gated by a set of guards.'''
+ for src in sources:
+ 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
+
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'''
def __init__(cls, name, bases, dict):
super(SourceMeta, cls).__init__(name, bases, dict)
cls.all = []
-
- def get(cls, **kwargs):
- for src in cls.all:
- for attr,value in kwargs.iteritems():
- if getattr(src, attr) != value:
- break
- else:
- yield src
+
+ 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 s in guarded_source_iterator(cls.all, **guards):
+ yield s
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'''
__metaclass__ = SourceMeta
- def __init__(self, source):
+ def __init__(self, source, parent=None, **guards):
+ self.guards = guards
+ self.parent = parent
+
tnode = source
if not isinstance(source, SCons.Node.FS.File):
tnode = File(source)
self.tnode = tnode
self.snode = tnode.srcnode()
- self.filename = str(tnode)
- self.dirname = dirname(self.filename)
- self.basename = basename(self.filename)
- index = self.basename.rfind('.')
- if index <= 0:
- # dot files aren't extensions
- self.extname = self.basename, None
- else:
- self.extname = self.basename[:index], self.basename[index+1:]
for base in type(self).__mro__:
if issubclass(base, SourceFile):
base.all.append(self)
+ @property
+ def filename(self):
+ return str(self.tnode)
+
+ @property
+ def dirname(self):
+ return dirname(self.filename)
+
+ @property
+ def basename(self):
+ return basename(self.filename)
+
+ @property
+ def extname(self):
+ index = self.basename.rfind('.')
+ if index <= 0:
+ # dot files aren't extensions
+ return self.basename, None
+
+ 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
-
+
+ @staticmethod
+ def done():
+ def disabled(cls, name, *ignored):
+ raise RuntimeError("Additional SourceFile '%s'" % name,\
+ "declared, but targets deps are already fixed.")
+ SourceFile.__init__ = disabled
+
+
class Source(SourceFile):
+ current_group = None
+ source_groups = { None : [] }
+
+ @classmethod
+ def set_group(cls, group):
+ if not group in Source.source_groups:
+ Source.source_groups[group] = []
+ Source.current_group = group
+
'''Add a c/c++ source file to the build'''
- def __init__(self, source, Werror=True, swig=False, bin_only=False,
- skip_lib=False):
- super(Source, self).__init__(source)
+ def __init__(self, source, Werror=True, **guards):
+ '''specify the source file, and any guards'''
+ super(Source, self).__init__(source, **guards)
self.Werror = Werror
- self.swig = swig
- self.bin_only = bin_only
- self.skip_lib = bin_only or skip_lib
+
+ Source.source_groups[Source.current_group].append(self)
class PySource(SourceFile):
'''Add a python source file to the named package'''
modules = {}
tnodes = {}
symnames = {}
-
- def __init__(self, package, source):
- super(PySource, self).__init__(source)
+
+ def __init__(self, package, source, **guards):
+ '''specify the python package, the source file, and any guards'''
+ super(PySource, self).__init__(source, **guards)
modname,ext = self.extname
assert ext == 'py'
fixed = False
modnames = []
- def __init__(self, source):
- super(SimObject, self).__init__('m5.objects', source)
+ def __init__(self, source, **guards):
+ '''Specify the source file and any guards (automatically in
+ the m5.objects package)'''
+ super(SimObject, self).__init__('m5.objects', source, **guards)
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):
- super(SwigSource, self).__init__(source)
+ def __init__(self, source, **guards):
+ '''Specify the source file, and any guards'''
+ super(ProtoBuf, self).__init__(source, **guards)
+ # 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')
-
- self.cc_source = Source(cc_file, swig=True)
- self.py_source = PySource(package, py_file)
-
-unit_tests = []
-def UnitTest(target, sources):
- if not isinstance(sources, (list, tuple)):
- sources = [ sources ]
-
- sources = [ Source(src, skip_lib=True) for src in sources ]
- unit_tests.append((target, sources))
+ 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')
+
+class UnitTest(object):
+ '''Create a UnitTest'''
+
+ 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
+ guarded with a guard of the same name as the UnitTest
+ target.'''
+
+ srcs = []
+ for src in sources:
+ if not isinstance(src, SourceFile):
+ src = Source(src, skip_lib=True)
+ src.guards[target] = True
+ srcs.append(src)
+
+ self.sources = srcs
+ self.target = target
+ self.main = kwargs.get('main', False)
+ UnitTest.all.append(self)
# Children should have access
Export('Source')
Export('PySource')
Export('SimObject')
-Export('SwigSource')
+Export('ProtoBuf')
Export('UnitTest')
########################################################################
#
-# Trace Flags
+# Debug Flags
#
-trace_flags = {}
-def TraceFlag(name, desc=None):
- if name in trace_flags:
+debug_flags = {}
+def DebugFlag(name, desc=None):
+ if name in debug_flags:
raise AttributeError, "Flag %s already specified" % name
- trace_flags[name] = (name, (), desc)
+ debug_flags[name] = (name, (), desc)
def CompoundFlag(name, flags, desc=None):
- if name in trace_flags:
+ if name in debug_flags:
raise AttributeError, "Flag %s already specified" % name
compound = tuple(flags)
- trace_flags[name] = (name, compound, desc)
+ debug_flags[name] = (name, compound, desc)
-Export('TraceFlag')
+Export('DebugFlag')
Export('CompoundFlag')
########################################################################
env.Append(CPPPATH=Dir(extra_dir))
# Workaround for bug in SCons version > 0.97d20071212
-# Scons bug id: 2006 M5 Bug id: 308
+# Scons bug id: 2006 gem5 Bug id: 308
for root, dirs, files in os.walk(base_dir, topdown=True):
Dir(root[len(base_dir) + 1:])
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:
+ dirs.remove('build')
+
if 'SConscript' in files:
build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
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
-all_params = {}
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 all_params:
- all_params[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)
########################################################################
#
# Generate Python file containing a dict specifying the current
# buildEnv flags.
def makeDefinesPyFile(target, source, env):
- build_env, hg_info = [ x.get_contents() for x in source ]
+ build_env = source[0].get_contents()
code = code_formatter()
code("""
-import m5.internal
+import _m5.core
import m5.util
buildEnv = m5.util.SmartDict($build_env)
-hgRev = '$hg_info'
-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
""")
code.write(target[0].abspath)
-defines_info = [ Value(build_env), Value(env['HG_INFO']) ]
+defines_info = Value(build_env)
# Generate a file with all of the compile options in it
env.Command('python/m5/defines.py', defines_info,
MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
# Generate a file that wraps the basic top level files
env.Command('python/m5/info.py',
- [ '#/AUTHORS', '#/LICENSE', '#/README', ],
+ [ '#/COPYING', '#/LICENSE', '#/README', ],
MakeAction(makeInfoPyFile, Transform("INFO")))
PySource('m5', 'python/m5/info.py')
# Create all of the SimObject param headers and enum headers
#
-def createSimObjectParam(target, source, env):
+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_decl(code)
+ obj.cxx_param_decl(code)
code.write(target[0].abspath)
-def createSwigParam(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 = all_params[name]
+ name = str(source[0].get_contents())
+ obj = sim_objects[name]
- code = code_formatter()
- code('%module(package="m5.internal") $0_${name}', param.file_ext)
- 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 createEnumParam(target, source, env):
+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 createEnumSwig(target, source, env):
- assert len(target) == 1 and len(source) == 1
-
- name = str(source[0].get_contents())
- obj = all_enums[name]
+def createSimObjectPyBindWrapper(target, source, env):
+ name = source[0].get_text_contents()
+ obj = sim_objects[name]
code = code_formatter()
- code('''\
-%module(package="m5.internal") enum_$name
-
-%{
-#include "enums/$name.hh"
-%}
-
-%include "enums/$name.hh"
-''')
+ obj.pybind_decl(code)
code.write(target[0].abspath)
-# Generate all of the SimObject param struct header files
+# Generate all of the SimObject param C++ struct header files
params_hh_files = []
for name,simobj in sorted(sim_objects.iteritems()):
py_source = PySource.modules[simobj.__module__]
hh_file = File('params/%s.hh' % name)
params_hh_files.append(hh_file)
env.Command(hh_file, Value(name),
- MakeAction(createSimObjectParam, Transform("SO PARAM")))
+ MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
env.Depends(hh_file, depends + extra_deps)
-# Generate any parameter header files needed
-params_i_files = []
-for name,param in all_params.iteritems():
- i_file = File('python/m5/internal/%s_%s.i' % (param.file_ext, name))
- params_i_files.append(i_file)
- env.Command(i_file, Value(name),
- MakeAction(createSwigParam, 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)
hh_file = File('enums/%s.hh' % name)
env.Command(hh_file, Value(name),
- MakeAction(createEnumParam, Transform("EN PARAM")))
+ 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(createEnumSwig, Transform("ENUMSWIG")))
- env.Depends(i_file, depends + extra_deps)
- SwigSource('m5.internal', i_file)
-
-def buildParam(target, source, env):
- name = source[0].get_contents()
- obj = sim_objects[name]
- class_path = obj.cxx_class.split('::')
- classname = class_path[-1]
- namespaces = class_path[:-1]
- params = obj._params.local.values()
-
- code = code_formatter()
-
- code('%module(package="m5.internal") param_$name')
- code()
- code('%{')
- code('#include "params/$obj.hh"')
- for param in params:
- param.cxx_predecls(code)
- code('%}')
- code()
-
- for param in params:
- param.swig_predecls(code)
-
- code()
- if obj._base:
- code('%import "python/m5/internal/param_${{obj._base}}.i"')
- code()
- obj.swig_objdecls(code)
- code()
-
- code('%include "params/$obj.hh"')
-
- code.write(target[0].abspath)
-
-for name in sim_objects.iterkeys():
- params_file = File('python/m5/internal/param_%s.i' % name)
- env.Command(params_file, Value(name),
- MakeAction(buildParam, Transform("BLDPARAM")))
- env.Depends(params_file, depends)
- SwigSource('m5.internal', params_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")))
- init_file = 'python/swig/init_%s.cc' % swig.module
- env.Command(init_file, Value(swig.module),
- MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW")))
- Source(init_file)
-
-def getFlags(source_flags):
- flagsMap = {}
- flagsList = []
- for s in source_flags:
- val = eval(s.get_contents())
- name, compound, desc = val
- flagsList.append(val)
- flagsMap[name] = bool(compound)
-
- for name, compound, desc in flagsList:
- for flag in compound:
- if flag not in flagsMap:
- raise AttributeError, "Trace flag %s not found" % flag
- if flagsMap[flag]:
- raise AttributeError, \
- "Compound flag can't point to another compound flag"
-
- flagsList.sort()
- return flagsList
+# 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, **proto.guards)
+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)
-# Generate traceflags.py
-def traceFlagsPy(target, source, env):
- assert(len(target) == 1)
code = code_formatter()
- allFlags = getFlags(source)
-
- code('basic = [')
- code.indent()
- for flag, compound, desc in allFlags:
- if not compound:
- code("'$flag',")
- code(']')
- code.dedent()
- code()
-
- code('compound = [')
- code.indent()
- code("'All',")
- for flag, compound, desc in allFlags:
- if compound:
- code("'$flag',")
- code("]")
- code.dedent()
- code()
-
- code("all = frozenset(basic + compound)")
- code()
-
- code('compoundMap = {')
- code.indent()
- all = tuple([flag for flag,compound,desc in allFlags if not compound])
- code("'All' : $all,")
- for flag, compound, desc in allFlags:
- if compound:
- code("'$flag' : $compound,")
- code('}')
- code.dedent()
- code()
-
- code('descriptions = {')
- code.indent()
- code("'All' : 'All flags',")
- for flag, compound, desc in allFlags:
- code("'$flag' : '$desc',")
- code("}")
- code.dedent()
-
- code.write(str(target[0]))
-
-def traceFlagsCC(target, source, env):
- assert(len(target) == 1)
-
- allFlags = getFlags(source)
- 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/traceflags.hh"
-
-using namespace Trace;
-
-const char *Trace::flagStrings[] =
-{''')
-
- code.indent()
- # The string array is used by SimpleEnumParam to map the strings
- # provided by the user to enum values.
- for flag, compound, desc in allFlags:
- if not compound:
- code('"$flag",')
-
- code('"All",')
- for flag, compound, desc in allFlags:
- if compound:
- code('"$flag",')
- code.dedent()
+#include "base/debug.hh"
- code('''\
-};
-
-const int Trace::numFlagStrings = ${{len(allFlags) + 1}};
+namespace Debug {
''')
- # Now define the individual compound flag arrays. There is an array
- # for each compound flag listing the component base flags.
- all = tuple([flag for flag,compound,desc in allFlags if not compound])
- code('static const Flags AllMap[] = {')
- code.indent()
- for flag, compound, desc in allFlags:
- if not compound:
- code('$flag,')
- code.dedent()
- code('};')
- code()
+ for name, flag in sorted(source[0].read().iteritems()):
+ n, compound, desc = flag
+ assert n == name
- for flag, compound, desc in allFlags:
if not compound:
- continue
- code('static const Flags ${flag}Map[] = {')
- code.indent()
- for flag in compound:
- code('$flag,')
- code('(Flags)-1')
- code.dedent()
- code('};')
- code()
-
- # Finally the compoundFlags[] array maps the compound flags
- # to their individual arrays/
- code('const Flags *Trace::compoundFlags[] = {')
- code.indent()
- code('AllMap,')
- for flag, compound, desc in allFlags:
- if compound:
- code('${flag}Map,')
- # file trailer
- code.dedent()
- code('};')
+ 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')
code.write(str(target[0]))
-def traceFlagsHH(target, source, env):
- assert(len(target) == 1)
+def makeDebugFlagHH(target, source, env):
+ assert(len(target) == 1 and len(source) == 1)
+
+ val = eval(source[0].get_contents())
+ name, compound, desc = val
- allFlags = getFlags(source)
code = code_formatter()
# file header boilerplate
code('''\
/*
- * DO NOT EDIT THIS FILE!
- *
- * Automatically generated from traceflags.py
+ * DO NOT EDIT THIS FILE! Automatically generated by SCons.
*/
-#ifndef __BASE_TRACE_FLAGS_HH__
-#define __BASE_TRACE_FLAGS_HH__
+#ifndef __DEBUG_${name}_HH__
+#define __DEBUG_${name}_HH__
-namespace Trace {
+namespace Debug {
+''')
-enum Flags {''')
+ if compound:
+ code('class CompoundFlag;')
+ code('class SimpleFlag;')
- # Generate the enum. Base flags come first, then compound flags.
- idx = 0
- code.indent()
- for flag, compound, desc in allFlags:
- if not compound:
- code('$flag = $idx,')
- idx += 1
-
- numBaseFlags = idx
- code('NumFlags = $idx,')
- code.dedent()
- code()
+ if compound:
+ code('extern CompoundFlag $name;')
+ for flag in compound:
+ code('extern SimpleFlag $flag;')
+ else:
+ code('extern SimpleFlag $name;')
- # put a comment in here to separate base from compound flags
code('''
-// The remaining enum values are *not* valid indices for Trace::flags.
-// They are "compound" flags, which correspond to sets of base
-// flags, and are used by changeFlag.''')
-
- code.indent()
- code('All = $idx,')
- idx += 1
- for flag, compound, desc in allFlags:
- if compound:
- code('$flag = $idx,')
- idx += 1
-
- numCompoundFlags = idx - numBaseFlags
- code('NumCompoundFlags = $numCompoundFlags')
- code.dedent()
-
- # trailer boilerplate
- code('''\
-}; // enum Flags
-
-// Array of strings for SimpleEnumParam
-extern const char *flagStrings[];
-extern const int numFlagStrings;
-
-// Array of arraay pointers: for each compound flag, gives the list of
-// base flags to set. Inidividual flag arrays are terminated by -1.
-extern const Flags *compoundFlags[];
-
-} // namespace Trace
+}
-#endif // __BASE_TRACE_FLAGS_HH__
+#endif // __DEBUG_${name}_HH__
''')
code.write(str(target[0]))
-flags = map(Value, trace_flags.values())
-env.Command('base/traceflags.py', flags,
- MakeAction(traceFlagsPy, Transform("TRACING", 0)))
-PySource('m5', 'base/traceflags.py')
+for name,flag in sorted(debug_flags.iteritems()):
+ n, compound, desc = flag
+ assert n == name
+
+ hh_file = 'debug/%s.hh' % name
+ env.Command(hh_file, Value(flag),
+ MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
-env.Command('base/traceflags.hh', flags,
- MakeAction(traceFlagsHH, Transform("TRACING", 0)))
-env.Command('base/traceflags.cc', flags,
- MakeAction(traceFlagsCC, Transform("TRACING", 0)))
-Source('base/traceflags.cc')
+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, skip_no_python=True)
########################################################################
#
#
# List of constructed environments to pass back to SConstruct
-envList = []
-
date_source = Source('base/date.cc', skip_lib=True)
+# Capture this directory for the closure makeEnv, otherwise when it is
+# called, it won't know what directory it should use.
+variant_dir = Dir('.').path
+def variant(*path):
+ return os.path.join(variant_dir, *path)
+def variantd(*path):
+ return variant(*path)+'/'
+
# 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 = 'm5_' + label
- exename = 'm5.' + label
+ libname = variant('gem5_' + label)
+ exename = variant('gem5.' + label)
+ secondary_exename = variant('m5.' + label)
new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
new_env.Label = label
new_env.Append(**kwargs)
- swig_env = new_env.Clone()
- swig_env.Append(CCFLAGS='-Werror')
if env['GCC']:
- swig_env.Append(CCFLAGS='-Wno-uninitialized')
- swig_env.Append(CCFLAGS='-Wno-sign-compare')
- swig_env.Append(CCFLAGS='-Wno-parentheses')
+ # The address sanitizer is available for gcc >= 4.8
+ if GetOption('with_asan'):
+ if GetOption('with_ubsan') and \
+ compareVersions(env['GCC_VERSION'], '4.9') >= 0:
+ new_env.Append(CCFLAGS=['-fsanitize=address,undefined',
+ '-fno-omit-frame-pointer'])
+ new_env.Append(LINKFLAGS='-fsanitize=address,undefined')
+ else:
+ new_env.Append(CCFLAGS=['-fsanitize=address',
+ '-fno-omit-frame-pointer'])
+ new_env.Append(LINKFLAGS='-fsanitize=address')
+ # Only gcc >= 4.9 supports UBSan, so check both the version
+ # and the command-line option before adding the compiler and
+ # linker flags.
+ elif GetOption('with_ubsan') and \
+ compareVersions(env['GCC_VERSION'], '4.9') >= 0:
+ new_env.Append(CCFLAGS='-fsanitize=undefined')
+ new_env.Append(LINKFLAGS='-fsanitize=undefined')
+
+
+ if env['CLANG']:
+ # We require clang >= 3.1, so there is no need to check any
+ # versions here.
+ if GetOption('with_ubsan'):
+ if GetOption('with_asan'):
+ new_env.Append(CCFLAGS=['-fsanitize=address,undefined',
+ '-fno-omit-frame-pointer'])
+ new_env.Append(LINKFLAGS='-fsanitize=address,undefined')
+ else:
+ new_env.Append(CCFLAGS='-fsanitize=undefined')
+ new_env.Append(LINKFLAGS='-fsanitize=undefined')
+
+ elif GetOption('with_asan'):
+ new_env.Append(CCFLAGS=['-fsanitize=address',
+ '-fno-omit-frame-pointer'])
+ new_env.Append(LINKFLAGS='-fsanitize=address')
werror_env = new_env.Clone()
- werror_env.Append(CCFLAGS='-Werror')
+ # Treat warnings as errors but white list some warnings that we
+ # want to allow (e.g., deprecation warnings).
+ werror_env.Append(CCFLAGS=['-Werror',
+ '-Wno-error=deprecated-declarations',
+ '-Wno-error=deprecated',
+ ])
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
- elif source.Werror:
+ if source.Werror:
env = werror_env
else:
env = new_env
return obj
- static_objs = [ make_obj(s, True) for s in Source.get(skip_lib=False)]
- shared_objs = [ make_obj(s, False) for s in Source.get(skip_lib=False)]
+ lib_guards = {'main': False, 'skip_lib': False}
+
+ # 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_guards['skip_no_python'] = False
+
+ static_objs = []
+ shared_objs = []
+ for s in guarded_source_iterator(Source.source_groups[None], **lib_guards):
+ static_objs.append(make_obj(s, True))
+ shared_objs.append(make_obj(s, False))
+
+ partial_objs = []
+ for group, all_srcs in Source.source_groups.iteritems():
+ # If these are the ungrouped source files, skip them.
+ if not group:
+ continue
+
+ # Get a list of the source files compatible with the current guards.
+ srcs = [ s for s in guarded_source_iterator(all_srcs, **lib_guards) ]
+ # If there aren't any left, skip this group.
+ if not srcs:
+ continue
+
+ # 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))
+ 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)
+
+ # 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)
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)
static_lib = new_env.StaticLibrary(libname, static_objs)
shared_lib = new_env.SharedLibrary(libname, shared_objs)
- for target, sources in unit_tests:
- objs = [ make_obj(s, static=True) for s in sources ]
- new_env.Program("unittest/%s.%s" % (target, label), objs + static_objs)
-
# Now link a stub with main() and the static library.
- bin_objs = [make_obj(s, True) for s in Source.get(bin_only=True) ]
+ main_objs = [ make_obj(s, True) for s in Source.get(main=True) ]
+
+ 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 ]
+ if test.main:
+ test_objs += main_objs
+ path = variant('unittest/%s.%s' % (test.target, label))
+ new_env.Program(path, test_objs + static_objs)
+
progname = exename
if strip:
progname += '.unstripped'
- targets = new_env.Program(progname, bin_objs + static_objs)
+ targets = new_env.Program(progname, main_objs + static_objs)
if strip:
if sys.platform == 'sunos5':
cmd = 'strip $SOURCE -o $TARGET'
targets = new_env.Command(exename, progname,
MakeAction(cmd, Transform("STRIP")))
-
+
+ new_env.Command(secondary_exename, exename,
+ MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
+
new_env.M5Binary = targets[0]
- envList.append(new_env)
-# Debug binary
-ccflags = {}
+ # Set up regression tests.
+ SConscript(os.path.join(env.root.abspath, 'tests', 'SConscript'),
+ variant_dir=variantd('tests', 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'
Exit(1)
-makeEnv('debug', '.do',
- CCFLAGS = Split(ccflags['debug']),
- CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
-
-# Optimized binary
-makeEnv('opt', '.o',
- CCFLAGS = Split(ccflags['opt']),
- CPPDEFINES = ['TRACING_ON=1'])
-
-# "Fast" binary
-makeEnv('fast', '.fo', strip = True,
- CCFLAGS = Split(ccflags['fast']),
- CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
-
-# Profiled binary
-makeEnv('prof', '.po',
- CCFLAGS = Split(ccflags['prof']),
- CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
- LINKFLAGS = '-pg')
-Return('envList')
+# To speed things up, we only instantiate the build environments we
+# 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', 'perf']
+obj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
+ 'gpo' : 'perf'}
+
+def identifyTarget(t):
+ ext = t.split('.')[-1]
+ if ext in target_types:
+ return ext
+ if obj2target.has_key(ext):
+ 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
+
+def makeEnvirons(target, source, env):
+ # cause any later Source() calls to be fatal, as a diagnostic.
+ Source.done()
+
+ # Debug binary
+ if 'debug' in needed_envs:
+ makeEnv(env, 'debug', '.do',
+ CCFLAGS = Split(ccflags['debug']),
+ CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
+ 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']))
+
+ # "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)
+
+ # 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']))
+
+ # 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']))
+
+# The MakeEnvirons Builder defers the full dependency collection until
+# after processing the ISA definition (due to dynamically generated
+# source files). Add this dependency to all targets so they will wait
+# until the environments are completely set up. Otherwise, a second
+# process (e.g. -j2 or higher) will try to compile the requested target,
+# not know how, and fail.
+env.Append(BUILDERS = {'MakeEnvirons' :
+ Builder(action=MakeAction(makeEnvirons,
+ Transform("ENVIRONS", 1)))})
+
+isa_target = '#${VARIANT_NAME}-deps'
+environs = '#${VARIANT_NAME}-environs'
+env.Depends('#all-deps', isa_target)
+env.Depends('#all-environs', environs)
+env.ScanISA(isa_target, File('arch/%s/generated/inc.d' % env['TARGET_ISA']))
+envSetup = env.MakeEnvirons(environs, isa_target)
+
+# make sure no -deps targets occur before all ISAs are complete
+env.Depends(isa_target, '#all-isas')
+# likewise for -environs targets and all the -deps targets
+env.Depends(environs, '#all-deps')
projects / gem5.git / blobdiff