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, 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
+# <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).
+#
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):
+ 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 attr,value in kwargs.iteritems():
- if getattr(src, attr) != value:
+ 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 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)
+
+ 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
- self.extname = self.basename, None
- else:
- self.extname = self.basename[:index], self.basename[index+1:]
+ return self.basename, None
- for base in type(self).__mro__:
- if issubclass(base, SourceFile):
- bisect.insort_right(base.all, self)
+ 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
class Source(SourceFile):
'''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, swig=False, **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
class PySource(SourceFile):
'''Add a python source file to the named package'''
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'
self.arcname = joinpath(*arcpath)
self.abspath = abspath
self.compiled = File(self.filename + 'c')
- self.assembly = File(self.filename + '.s')
- self.symname = "PyEMB_" + PySource.invalid_sym_char.sub('_', modpath)
+ self.cpp = File(self.filename + '.cc')
+ self.symname = PySource.invalid_sym_char.sub('_', modpath)
PySource.modules[modpath] = self
PySource.tnodes[self.tnode] = self
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."
class SwigSource(SourceFile):
'''Add a swig file to build'''
- def __init__(self, package, source):
- super(SwigSource, self).__init__(source)
+ def __init__(self, package, source, **guards):
+ '''Specify the python package, the source file, and any guards'''
+ super(SwigSource, self).__init__(source, **guards)
modname,ext = self.extname
assert ext == 'i'
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)
+ self.cc_source = Source(cc_file, swig=True, parent=self)
+ self.py_source = PySource(package, py_file, parent=self)
+
+class UnitTest(object):
+ '''Create a UnitTest'''
-unit_tests = []
-def UnitTest(target, sources):
- if not isinstance(sources, (list, tuple)):
- sources = [ sources ]
+ 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.'''
- sources = [ Source(src, skip_lib=True) for src in sources ]
- unit_tests.append((target, sources))
+ 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
+ UnitTest.all.append(self)
# Children should have access
Export('Source')
########################################################################
#
-# 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:])
- SConscript(joinpath(root, 'SConscript'), build_dir=build_dir)
+ SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
for extra_dir in extras_dir_list:
prefix_len = len(dirname(extra_dir)) + 1
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'), build_dir=build_dir)
+ SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
for opt in export_vars:
env.ConfigFile(opt)
def makeTheISA(source, target, env):
- f = file(str(target[0]), 'w')
-
isas = [ src.get_contents() for src in source ]
- target = env['TARGET_ISA']
+ target_isa = env['TARGET_ISA']
def define(isa):
return isa.upper() + '_ISA'
return isa[0].upper() + isa[1:].lower() + 'ISA'
- print >>f, '#ifndef __CONFIG_THE_ISA_HH__'
- print >>f, '#define __CONFIG_THE_ISA_HH__'
- print >>f
+ code = code_formatter()
+ code('''\
+#ifndef __CONFIG_THE_ISA_HH__
+#define __CONFIG_THE_ISA_HH__
+
+''')
+
for i,isa in enumerate(isas):
- print >>f, '#define %s %d' % (define(isa), i + 1)
- print >>f
- print >>f, '#define THE_ISA %s' % (define(target))
- print >>f, '#define TheISA %s' % (namespace(target))
- print >>f
- print >>f, '#endif // __CONFIG_THE_ISA_HH__'
+ code('#define $0 $1', define(isa), i + 1)
+
+ code('''
-env.Command('config/the_isa.hh', map(Value, all_isa_list), makeTheISA)
+#define THE_ISA ${{define(target_isa)}}
+#define TheISA ${{namespace(target_isa)}}
+
+#endif // __CONFIG_THE_ISA_HH__''')
+
+ code.write(str(target[0]))
+
+env.Command('config/the_isa.hh', map(Value, all_isa_list),
+ MakeAction(makeTheISA, Transform("CFG ISA", 0)))
########################################################################
#
import m5.SimObject
import m5.params
+from m5.util import code_formatter
m5.SimObject.clear()
m5.params.clear()
sim_objects = m5.SimObject.allClasses
all_enums = m5.params.allEnums
-all_params = {}
+# 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
if not hasattr(param, 'swig_decl'):
continue
pname = param.ptype_str
- if pname not in all_params:
- all_params[pname] = param
+ 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].tnode for dep in module_depends ]
+depends = [ PySource.modules[dep].snode for dep in module_depends ]
########################################################################
#
# 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 = m5.util.code_formatter()
+ code = code_formatter()
code("""
import m5.internal
import m5.util
buildEnv = m5.util.SmartDict($build_env)
-hgRev = '$hg_info'
compileDate = m5.internal.core.compileDate
_globals = globals()
_globals[flag] = val
del _globals
""")
- code.write(str(target[0]))
+ 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, makeDefinesPyFile)
+env.Command('python/m5/defines.py', defines_info,
+ MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
PySource('m5', 'python/m5/defines.py')
# Generate python file containing info about the M5 source code
def makeInfoPyFile(target, source, env):
- f = file(str(target[0]), 'w')
+ code = code_formatter()
for src in source:
data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
- print >>f, "%s = %s" % (src, repr(data))
- f.close()
+ code('$src = ${{repr(data)}}')
+ code.write(str(target[0]))
# Generate a file that wraps the basic top level files
env.Command('python/m5/info.py',
- [ '#/AUTHORS', '#/LICENSE', '#/README', '#/RELEASE_NOTES' ],
- makeInfoPyFile)
+ [ '#/COPYING', '#/LICENSE', '#/README', ],
+ MakeAction(makeInfoPyFile, Transform("INFO")))
PySource('m5', 'python/m5/info.py')
-# Generate the __init__.py file for m5.objects
-def makeObjectsInitFile(target, source, env):
- f = file(str(target[0]), 'w')
- print >>f, 'from params import *'
- print >>f, 'from m5.SimObject import *'
- for module in source:
- print >>f, 'from %s import *' % module.get_contents()
- f.close()
-
-# Generate an __init__.py file for the objects package
-env.Command('python/m5/objects/__init__.py',
- map(Value, SimObject.modnames),
- makeObjectsInitFile)
-PySource('m5.objects', 'python/m5/objects/__init__.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
- hh_file = file(target[0].abspath, 'w')
name = str(source[0].get_contents())
obj = sim_objects[name]
- print >>hh_file, obj.cxx_decl()
- hh_file.close()
+ code = code_formatter()
+ obj.cxx_param_decl(code)
+ code.write(target[0].abspath)
-def createSwigParam(target, source, env):
+def createParamSwigWrapper(target, source, env):
assert len(target) == 1 and len(source) == 1
- i_file = file(target[0].abspath, 'w')
name = str(source[0].get_contents())
- param = all_params[name]
+ param = params_to_swig[name]
- for line in param.swig_decl():
- print >>i_file, line
- i_file.close()
+ code = code_formatter()
+ param.swig_decl(code)
+ code.write(target[0].abspath)
def createEnumStrings(target, source, env):
assert len(target) == 1 and len(source) == 1
- cc_file = file(target[0].abspath, 'w')
name = str(source[0].get_contents())
obj = all_enums[name]
- print >>cc_file, obj.cxx_def()
- cc_file.close()
+ code = code_formatter()
+ obj.cxx_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())
+ obj = all_enums[name]
+
+ code = code_formatter()
+ obj.cxx_decl(code)
+ code.write(target[0].abspath)
-def createEnumParam(target, source, env):
+def createEnumSwigWrapper(target, source, env):
assert len(target) == 1 and len(source) == 1
- hh_file = file(target[0].abspath, 'w')
name = str(source[0].get_contents())
obj = all_enums[name]
- print >>hh_file, obj.cxx_decl()
- hh_file.close()
+ code = code_formatter()
+ obj.swig_decl(code)
+ code.write(target[0].abspath)
+
+def createSimObjectSwigWrapper(target, source, env):
+ name = source[0].get_contents()
+ obj = sim_objects[name]
+
+ code = code_formatter()
+ obj.swig_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), createSimObjectParam)
+ env.Command(hh_file, Value(name),
+ MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
env.Depends(hh_file, depends + extra_deps)
-# Generate any parameter header files needed
+# Generate any needed param SWIG wrapper files
params_i_files = []
-for name,param in all_params.iteritems():
- i_file = File('params/%s_%s.i' % (name, param.file_ext))
+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), createSwigParam)
+ env.Command(i_file, Value(name),
+ MakeAction(createParamSwigWrapper, Transform("SW PARAM")))
env.Depends(i_file, depends)
+ SwigSource('m5.internal', i_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), createEnumStrings)
+ env.Command(cc_file, Value(name),
+ 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), createEnumParam)
+ env.Command(hh_file, Value(name),
+ MakeAction(createEnumDecls, Transform("ENUMDECL")))
env.Depends(hh_file, depends + extra_deps)
-# Build the big monolithic swigged params module (wraps all SimObject
-# param structs and enum structs)
-def buildParams(target, source, env):
- names = [ s.get_contents() for s in source ]
- objs = [ sim_objects[name] for name in names ]
- out = file(target[0].abspath, 'w')
-
- ordered_objs = []
- obj_seen = set()
- def order_obj(obj):
- name = str(obj)
- if name in obj_seen:
- return
-
- obj_seen.add(name)
- if str(obj) != 'SimObject':
- order_obj(obj.__bases__[0])
-
- ordered_objs.append(obj)
-
- for obj in objs:
- order_obj(obj)
-
- enums = set()
- predecls = []
- pd_seen = set()
-
- def add_pds(*pds):
- for pd in pds:
- if pd not in pd_seen:
- predecls.append(pd)
- pd_seen.add(pd)
-
- for obj in ordered_objs:
- params = obj._params.local.values()
- for param in params:
- ptype = param.ptype
- if issubclass(ptype, m5.params.Enum):
- if ptype not in enums:
- enums.add(ptype)
- pds = param.swig_predecls()
- if isinstance(pds, (list, tuple)):
- add_pds(*pds)
- else:
- add_pds(pds)
-
- print >>out, '%module params'
-
- print >>out, '%{'
- for obj in ordered_objs:
- print >>out, '#include "params/%s.hh"' % obj
- print >>out, '%}'
-
- for pd in predecls:
- print >>out, pd
-
- enums = list(enums)
- enums.sort()
- for enum in enums:
- print >>out, '%%include "enums/%s.hh"' % enum.__name__
- print >>out
-
- for obj in ordered_objs:
- if obj.swig_objdecls:
- for decl in obj.swig_objdecls:
- print >>out, decl
- continue
-
- class_path = obj.cxx_class.split('::')
- classname = class_path[-1]
- namespaces = class_path[:-1]
- namespaces.reverse()
-
- code = ''
-
- if namespaces:
- code += '// avoid name conflicts\n'
- sep_string = '_COLONS_'
- flat_name = sep_string.join(class_path)
- code += '%%rename(%s) %s;\n' % (flat_name, classname)
-
- code += '// stop swig from creating/wrapping default ctor/dtor\n'
- code += '%%nodefault %s;\n' % classname
- code += 'class %s ' % classname
- if obj._base:
- code += ': public %s' % obj._base.cxx_class
- code += ' {};\n'
-
- for ns in namespaces:
- new_code = 'namespace %s {\n' % ns
- new_code += code
- new_code += '}\n'
- code = new_code
-
- print >>out, code
-
- print >>out, '%%include "src/sim/sim_object_params.hh"' % obj
- for obj in ordered_objs:
- print >>out, '%%include "params/%s.hh"' % obj
-
-params_file = File('params/params.i')
-names = sorted(sim_objects.keys())
-env.Command(params_file, map(Value, names), buildParams)
-env.Depends(params_file, params_hh_files + params_i_files + depends)
-SwigSource('m5.objects', params_file)
+ 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,
- '$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
- '-o ${TARGETS[0]} $SOURCES')
- env.Depends(swig.py_source.tnode, swig.tnode)
- env.Depends(swig.cc_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 the main swig init file
-def makeSwigInit(target, source, env):
- f = file(str(target[0]), 'w')
- print >>f, 'extern "C" {'
- for module in source:
- print >>f, ' void init_%s();' % module.get_contents()
- print >>f, '}'
- print >>f, 'void initSwig() {'
- for module in source:
- print >>f, ' init_%s();' % module.get_contents()
- print >>f, '}'
- f.close()
-
-env.Command('python/swig/init.cc',
- map(Value, sorted(s.module for s in SwigSource.all)),
- makeSwigInit)
-Source('python/swig/init.cc')
-
-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 traceflags.py
-def traceFlagsPy(target, source, env):
- assert(len(target) == 1)
-
- f = file(str(target[0]), 'w')
-
- allFlags = getFlags(source)
-
- print >>f, 'basic = ['
- for flag, compound, desc in allFlags:
- if not compound:
- print >>f, " '%s'," % flag
- print >>f, " ]"
- print >>f
-
- print >>f, 'compound = ['
- print >>f, " 'All',"
- for flag, compound, desc in allFlags:
- if compound:
- print >>f, " '%s'," % flag
- print >>f, " ]"
- print >>f
-
- print >>f, "all = frozenset(basic + compound)"
- print >>f
-
- print >>f, 'compoundMap = {'
- all = tuple([flag for flag,compound,desc in allFlags if not compound])
- print >>f, " 'All' : %s," % (all, )
- for flag, compound, desc in allFlags:
- if compound:
- print >>f, " '%s' : %s," % (flag, compound)
- print >>f, " }"
- print >>f
-
- print >>f, 'descriptions = {'
- print >>f, " 'All' : 'All flags',"
- for flag, compound, desc in allFlags:
- print >>f, " '%s' : '%s'," % (flag, desc)
- print >>f, " }"
-
- f.close()
-
-def traceFlagsCC(target, source, env):
- assert(len(target) == 1)
-
- f = file(str(target[0]), 'w')
-
- allFlags = getFlags(source)
+#
+# 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()
# file header
- print >>f, '''
+ code('''
/*
* DO NOT EDIT THIS FILE! Automatically generated
*/
-#include "base/traceflags.hh"
-
-using namespace Trace;
-
-const char *Trace::flagStrings[] =
-{'''
-
- # 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:
- print >>f, ' "%s",' % flag
-
- print >>f, ' "All",'
- for flag, compound, desc in allFlags:
- if compound:
- print >>f, ' "%s",' % flag
-
- print >>f, '};'
- print >>f
- print >>f, 'const int Trace::numFlagStrings = %d;' % (len(allFlags) + 1)
- print >>f
-
- #
- # 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])
- print >>f, 'static const Flags AllMap[] = {'
- for flag, compound, desc in allFlags:
- if not compound:
- print >>f, " %s," % flag
- print >>f, '};'
- print >>f
-
- for flag, compound, desc in allFlags:
- if not compound:
- continue
- print >>f, 'static const Flags %sMap[] = {' % flag
- for flag in compound:
- print >>f, " %s," % flag
- print >>f, " (Flags)-1"
- print >>f, '};'
- print >>f
+#include "base/debug.hh"
+''')
+
+ for flag in compound:
+ code('#include "debug/$flag.hh"')
+ code()
+ code('namespace Debug {')
+ code()
+
+ 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()
- #
- # Finally the compoundFlags[] array maps the compound flags
- # to their individual arrays/
- #
- print >>f, 'const Flags *Trace::compoundFlags[] ='
- print >>f, '{'
- print >>f, ' AllMap,'
- for flag, compound, desc in allFlags:
- if compound:
- print >>f, ' %sMap,' % flag
- # file trailer
- print >>f, '};'
+ code()
+ code('} // namespace Debug')
- f.close()
+ 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)
- f = file(str(target[0]), 'w')
+ val = eval(source[0].get_contents())
+ name, compound, desc = val
- allFlags = getFlags(source)
+ code = code_formatter()
# file header boilerplate
- print >>f, '''
+ code('''\
/*
* DO NOT EDIT THIS FILE!
*
- * Automatically generated from traceflags.py
+ * Automatically generated by SCons
*/
-#ifndef __BASE_TRACE_FLAGS_HH__
-#define __BASE_TRACE_FLAGS_HH__
-
-namespace Trace {
-
-enum Flags {'''
-
- # Generate the enum. Base flags come first, then compound flags.
- idx = 0
- for flag, compound, desc in allFlags:
- if not compound:
- print >>f, ' %s = %d,' % (flag, idx)
- idx += 1
+#ifndef __DEBUG_${name}_HH__
+#define __DEBUG_${name}_HH__
- numBaseFlags = idx
- print >>f, ' NumFlags = %d,' % idx
+namespace Debug {
+''')
- # put a comment in here to separate base from compound flags
- print >>f, '''
-// 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.'''
+ if compound:
+ code('class CompoundFlag;')
+ code('class SimpleFlag;')
- print >>f, ' All = %d,' % idx
- idx += 1
- for flag, compound, desc in allFlags:
- if compound:
- print >>f, ' %s = %d,' % (flag, idx)
- idx += 1
-
- numCompoundFlags = idx - numBaseFlags
- print >>f, ' NumCompoundFlags = %d' % numCompoundFlags
-
- # trailer boilerplate
- print >>f, '''\
-}; // 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[];
+ if compound:
+ code('extern CompoundFlag $name;')
+ for flag in compound:
+ code('extern SimpleFlag $flag;')
+ else:
+ code('extern SimpleFlag $name;')
-/* namespace Trace */ }
+ code('''
+}
-#endif // __BASE_TRACE_FLAGS_HH__
-'''
+#endif // __DEBUG_${name}_HH__
+''')
- f.close()
+ code.write(str(target[0]))
-flags = map(Value, trace_flags.values())
-env.Command('base/traceflags.py', flags, traceFlagsPy)
-PySource('m5', 'base/traceflags.py')
+for name,flag in sorted(debug_flags.iteritems()):
+ n, compound, desc = flag
+ assert n == name
-env.Command('base/traceflags.hh', flags, traceFlagsHH)
-env.Command('base/traceflags.cc', flags, traceFlagsCC)
-Source('base/traceflags.cc')
+ env.Command('debug/%s.hh' % name, 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)
-# embed python files. All .py files that have been indicated by a
+# 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
-# byte code, compress it, and then generate an assembly file that
-# inserts the result into the data section with symbols indicating the
-# beginning, and end (and with the size at the end)
-def objectifyPyFile(target, source, env):
+# byte code, compress it, and then generate a c++ file that
+# inserts the result into an array.
+def embedPyFile(target, source, env):
+ def c_str(string):
+ if string is None:
+ 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'''
src = file(str(source[0]), 'r').read()
- dst = file(str(target[0]), 'w')
pysource = PySource.tnodes[source[0]]
compiled = compile(src, pysource.abspath, 'exec')
marshalled = marshal.dumps(compiled)
compressed = zlib.compress(marshalled)
data = compressed
+ sym = pysource.symname
- # Some C/C++ compilers prepend an underscore to global symbol
- # names, so if they're going to do that, we need to prepend that
- # leading underscore to globals in the assembly file.
- if env['LEADING_UNDERSCORE']:
- sym = '_' + pysource.symname
- else:
- sym = pysource.symname
+ code = code_formatter()
+ code('''\
+#include "sim/init.hh"
+namespace {
+
+const char data_${sym}[] = {
+''')
+ code.indent()
step = 16
- print >>dst, ".data"
- print >>dst, ".globl %s_beg" % sym
- print >>dst, ".globl %s_end" % sym
- print >>dst, "%s_beg:" % sym
for i in xrange(0, len(data), step):
x = array.array('B', data[i:i+step])
- print >>dst, ".byte", ','.join([str(d) for d in x])
- print >>dst, "%s_end:" % sym
- print >>dst, ".long %d" % len(marshalled)
-
-for source in PySource.all:
- env.Command(source.assembly, source.tnode, objectifyPyFile)
- Source(source.assembly)
-
-# Generate init_python.cc which creates a bunch of EmbeddedPyModule
-# structs that describe the embedded python code. One such struct
-# contains information about the importer that python uses to get at
-# the embedded files, and then there's a list of all of the rest that
-# the importer uses to load the rest on demand.
-def pythonInit(target, source, env):
- dst = file(str(target[0]), 'w')
-
- def dump_mod(sym, endchar=','):
- pysource = PySource.symnames[sym]
- print >>dst, ' { "%s",' % pysource.arcname
- print >>dst, ' "%s",' % pysource.modpath
- print >>dst, ' %s_beg, %s_end,' % (sym, sym)
- print >>dst, ' %s_end - %s_beg,' % (sym, sym)
- print >>dst, ' *(int *)%s_end }%s' % (sym, endchar)
+ code(''.join('%d,' % d for d in x))
+ code.dedent()
- print >>dst, '#include "sim/init.hh"'
-
- for sym in source:
- sym = sym.get_contents()
- print >>dst, "extern const char %s_beg[], %s_end[];" % (sym, sym)
-
- print >>dst, "const EmbeddedPyModule embeddedPyImporter = "
- dump_mod("PyEMB_importer", endchar=';');
- print >>dst
-
- print >>dst, "const EmbeddedPyModule embeddedPyModules[] = {"
- for i,sym in enumerate(source):
- sym = sym.get_contents()
- if sym == "PyEMB_importer":
- # Skip the importer since we've already exported it
- continue
- dump_mod(sym)
- print >>dst, " { 0, 0, 0, 0, 0, 0 }"
- print >>dst, "};"
-
+ code('''};
+
+EmbeddedPython embedded_${sym}(
+ ${{c_str(pysource.arcname)}},
+ ${{c_str(pysource.abspath)}},
+ ${{c_str(pysource.modpath)}},
+ data_${sym},
+ ${{len(data)}},
+ ${{len(marshalled)}});
+
+} // anonymous namespace
+''')
+ code.write(str(target[0]))
-env.Command('sim/init_python.cc',
- map(Value, (s.symname for s in PySource.all)),
- pythonInit)
-Source('sim/init_python.cc')
+for source in PySource.all:
+ env.Command(source.cpp, source.tnode,
+ MakeAction(embedPyFile, Transform("EMBED PY")))
+ Source(source.cpp)
########################################################################
#
def makeEnv(label, objsfx, strip = 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 = 'gem5_' + label
+ exename = 'gem5.' + label
+ secondary_exename = 'm5.' + label
new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
new_env.Label = label
swig_env.Append(CCFLAGS='-Wno-uninitialized')
swig_env.Append(CCFLAGS='-Wno-sign-compare')
swig_env.Append(CCFLAGS='-Wno-parentheses')
+ if compareVersions(env['GCC_VERSION'], '4.6.0') != -1:
+ swig_env.Append(CCFLAGS='-Wno-unused-label')
+ swig_env.Append(CCFLAGS='-Wno-unused-but-set-variable')
werror_env = new_env.Clone()
werror_env.Append(CCFLAGS='-Werror')
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)]
+ 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 = make_obj(date_source, static=True, extra_deps=static_objs)
static_objs.append(static_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 ]
+ testname = "unittest/%s.%s" % (test.target, label)
+ new_env.Program(testname, main_objs + 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 = 'cp $SOURCE $TARGET; strip $TARGET'
else:
cmd = 'strip $SOURCE -o $TARGET'
- targets = new_env.Command(exename, progname, cmd)
-
+ 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)