# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
-# Authors: Steve Reinhardt
+# Authors: Nathan Binkert
+import array
+import bisect
+import imp
+import marshal
import os
+import re
import sys
-from os.path import isfile, join as joinpath
+import zlib
+
+from os.path import basename, dirname, exists, isdir, isfile, join as joinpath
+
+import SCons
# This file defines how to build a particular configuration of M5
# based on variable settings in the 'env' build environment.
-# Import build environment variable from SConstruct.
-Import('env')
+Import('*')
+
+# Children need to see the environment
+Export('env')
+
+build_env = [(opt, env[opt]) for opt in export_vars]
+
+from m5.util import code_formatter
+
+########################################################################
+# 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 m5 main() function
+# skip_lib -- do not put this file into the m5 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, **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
+
+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, 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()
+
+ 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
+
+class Source(SourceFile):
+ '''Add a c/c++ source file to the build'''
+ 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
+
+class PySource(SourceFile):
+ '''Add a python source file to the named package'''
+ invalid_sym_char = re.compile('[^A-z0-9_]')
+ 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)
+
+ modname,ext = self.extname
+ assert ext == 'py'
+
+ if package:
+ path = package.split('.')
+ else:
+ path = []
+
+ modpath = path[:]
+ if modname != '__init__':
+ modpath += [ modname ]
+ modpath = '.'.join(modpath)
+
+ arcpath = path + [ self.basename ]
+ abspath = self.snode.abspath
+ if not exists(abspath):
+ abspath = self.tnode.abspath
+
+ self.package = package
+ self.modname = modname
+ self.modpath = modpath
+ self.arcname = joinpath(*arcpath)
+ self.abspath = abspath
+ self.compiled = File(self.filename + 'c')
+ self.cpp = File(self.filename + '.cc')
+ self.symname = PySource.invalid_sym_char.sub('_', modpath)
+
+ PySource.modules[modpath] = self
+ PySource.tnodes[self.tnode] = self
+ PySource.symnames[self.symname] = self
+
+class SimObject(PySource):
+ '''Add a SimObject python file as a python source object and add
+ it to a list of sim object modules'''
+
+ fixed = False
+ modnames = []
+
+ 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'''
+
+ 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'
+
+ 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, parent=self)
+ self.py_source = PySource(package, py_file, parent=self)
+
+class UnitTest(object):
+ '''Create a UnitTest'''
+
+ 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 = []
+ 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')
+Export('PySource')
+Export('SimObject')
+Export('SwigSource')
+Export('UnitTest')
+
+########################################################################
+#
+# Debug Flags
+#
+debug_flags = {}
+def DebugFlag(name, desc=None):
+ if name in debug_flags:
+ raise AttributeError, "Flag %s already specified" % name
+ debug_flags[name] = (name, (), desc)
+TraceFlag = DebugFlag
+
+def CompoundFlag(name, flags, desc=None):
+ if name in debug_flags:
+ raise AttributeError, "Flag %s already specified" % name
+
+ compound = tuple(flags)
+ debug_flags[name] = (name, compound, desc)
-###################################################
+Export('DebugFlag')
+Export('TraceFlag')
+Export('CompoundFlag')
+
+########################################################################
#
-# Define needed sources.
+# Set some compiler variables
#
-###################################################
-
-# Base sources used by all configurations.
-
-base_sources = Split('''
- base/annotate.cc
- base/circlebuf.cc
- base/cprintf.cc
- base/fast_alloc.cc
- base/fifo_buffer.cc
- base/hostinfo.cc
- base/hybrid_pred.cc
- base/inifile.cc
- base/intmath.cc
- base/match.cc
- base/misc.cc
- base/output.cc
- base/pollevent.cc
- base/range.cc
- base/random.cc
- base/remote_gdb.cc
- base/sat_counter.cc
- base/socket.cc
- base/statistics.cc
- base/str.cc
- base/time.cc
- base/trace.cc
- base/traceflags.cc
- base/userinfo.cc
- base/compression/lzss_compression.cc
- base/loader/aout_object.cc
- base/loader/ecoff_object.cc
- base/loader/elf_object.cc
- base/loader/raw_object.cc
- base/loader/object_file.cc
- base/loader/symtab.cc
- base/stats/events.cc
- base/stats/statdb.cc
- base/stats/visit.cc
- base/stats/text.cc
-
- cpu/activity.cc
- cpu/base.cc
- cpu/cpuevent.cc
- cpu/exetrace.cc
- cpu/func_unit.cc
- cpu/op_class.cc
- cpu/pc_event.cc
- cpu/quiesce_event.cc
- cpu/static_inst.cc
- cpu/simple_thread.cc
- cpu/thread_state.cc
-
- mem/bridge.cc
- mem/bus.cc
- mem/dram.cc
- mem/mem_object.cc
- mem/packet.cc
- mem/physical.cc
- mem/port.cc
- mem/tport.cc
-
- mem/cache/base_cache.cc
- mem/cache/cache.cc
- mem/cache/coherence/coherence_protocol.cc
- mem/cache/coherence/uni_coherence.cc
- mem/cache/miss/blocking_buffer.cc
- mem/cache/miss/miss_buffer.cc
- mem/cache/miss/miss_queue.cc
- mem/cache/miss/mshr.cc
- mem/cache/miss/mshr_queue.cc
- mem/cache/prefetch/base_prefetcher.cc
- mem/cache/prefetch/ghb_prefetcher.cc
- mem/cache/prefetch/stride_prefetcher.cc
- mem/cache/prefetch/tagged_prefetcher.cc
- mem/cache/tags/base_tags.cc
- mem/cache/tags/fa_lru.cc
- mem/cache/tags/iic.cc
- mem/cache/tags/lru.cc
- mem/cache/tags/repl/gen.cc
- mem/cache/tags/repl/repl.cc
- mem/cache/tags/split.cc
- mem/cache/tags/split_lifo.cc
- mem/cache/tags/split_lru.cc
-
- mem/cache/cache_builder.cc
-
- python/swig/init.cc
- python/swig/debug_wrap.cc
- python/swig/main_wrap.cc
- python/swig/event_wrap.cc
- python/swig/random_wrap.cc
- python/swig/trace_wrap.cc
- python/swig/pyevent.cc
-
- sim/builder.cc
- sim/debug.cc
- sim/eventq.cc
- sim/faults.cc
- sim/main.cc
- sim/param.cc
- sim/root.cc
- sim/serialize.cc
- sim/sim_events.cc
- sim/sim_object.cc
- sim/startup.cc
- sim/stat_context.cc
- sim/stat_control.cc
- sim/system.cc
- ''')
-
-trace_reader_sources = Split('''
- cpu/trace/reader/mem_trace_reader.cc
- cpu/trace/reader/ibm_reader.cc
- cpu/trace/reader/itx_reader.cc
- cpu/trace/reader/m5_reader.cc
- cpu/trace/opt_cpu.cc
- cpu/trace/trace_cpu.cc
- ''')
-
-
-
-# MySql sources
-mysql_sources = Split('''
- base/mysql.cc
- base/stats/mysql.cc
- ''')
-
-# Full-system sources
-full_system_sources = Split('''
- base/crc.cc
- base/inet.cc
-
- cpu/intr_control.cc
- cpu/profile.cc
-
- dev/uart.cc
- dev/uart8250.cc
-
- mem/vport.cc
-
- sim/pseudo_inst.cc
- ''')
- #dev/sinic.cc
- #dev/i8254xGBe.cc
-
-if env['TARGET_ISA'] == 'alpha':
- full_system_sources += Split('''
- kern/tru64/dump_mbuf.cc
- kern/tru64/printf.cc
- kern/tru64/tru64_events.cc
- kern/tru64/tru64_syscalls.cc
- ''')
-
-# Syscall emulation (non-full-system) sources
-syscall_emulation_sources = Split('''
- mem/translating_port.cc
- mem/page_table.cc
- sim/process.cc
- sim/syscall_emul.cc
- ''')
-
-#if env['TARGET_ISA'] == 'alpha':
-# syscall_emulation_sources += Split('''
-# kern/tru64/tru64.cc
-# ''')
-
-memtest_sources = Split('''
- cpu/memtest/memtest.cc
- ''')
# Include file paths are rooted in this directory. SCons will
# automatically expand '.' to refer to both the source directory and
# files.
env.Append(CPPPATH=Dir('.'))
-# Add a flag defining what THE_ISA should be for all compilation
-env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
+for extra_dir in extras_dir_list:
+ env.Append(CPPPATH=Dir(extra_dir))
-arch_sources = SConscript(os.path.join('arch', 'SConscript'), exports = 'env')
+# Workaround for bug in SCons version > 0.97d20071212
+# Scons bug id: 2006 M5 Bug id: 308
+for root, dirs, files in os.walk(base_dir, topdown=True):
+ Dir(root[len(base_dir) + 1:])
-cpu_sources = SConscript(os.path.join('cpu', 'SConscript'), exports = 'env')
+########################################################################
+#
+# Walk the tree and execute all SConscripts in subdirectories
+#
-if env['FULL_SYSTEM']:
- dev_sources = SConscript(os.path.join('dev', 'SConscript'),
- exports = 'env')
- full_system_sources += dev_sources
+here = Dir('.').srcnode().abspath
+for root, dirs, files in os.walk(base_dir, topdown=True):
+ if root == here:
+ # we don't want to recurse back into this SConscript
+ continue
- kern_sources = SConscript(os.path.join('kern', 'SConscript'),
- exports = 'env')
- full_system_sources += kern_sources
+ if 'SConscript' in files:
+ build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
+ SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
-# Set up complete list of sources based on configuration.
-sources = base_sources + arch_sources + cpu_sources
+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')
-# encumbered should be last because we're adding to some of the other groups
-if isfile(joinpath(env['SRCDIR'], 'encumbered/SConscript')):
- sources += SConscript('encumbered/SConscript', exports = 'env')
+ if 'SConscript' in files:
+ build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
+ SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
+for opt in export_vars:
+ env.ConfigFile(opt)
-if env['FULL_SYSTEM']:
- sources += full_system_sources
-else:
- sources += syscall_emulation_sources
+def makeTheISA(source, target, env):
+ isas = [ src.get_contents() for src in source ]
+ target_isa = env['TARGET_ISA']
+ def define(isa):
+ return isa.upper() + '_ISA'
+
+ def namespace(isa):
+ return isa[0].upper() + isa[1:].lower() + 'ISA'
-if env['USE_MYSQL']:
- sources += mysql_sources
-for opt in env.ExportOptions:
- env.ConfigFile(opt)
+ code = code_formatter()
+ code('''\
+#ifndef __CONFIG_THE_ISA_HH__
+#define __CONFIG_THE_ISA_HH__
+
+''')
+
+ for i,isa in enumerate(isas):
+ code('#define $0 $1', define(isa), i + 1)
+
+ code('''
+
+#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)))
+
+########################################################################
+#
+# Prevent any SimObjects from being added after this point, they
+# should all have been added in the SConscripts above
+#
+SimObject.fixed = True
+
+class DictImporter(object):
+ '''This importer takes a dictionary of arbitrary module names that
+ map to arbitrary filenames.'''
+ def __init__(self, modules):
+ self.modules = modules
+ self.installed = set()
+
+ def __del__(self):
+ self.unload()
+
+ def unload(self):
+ import sys
+ for module in self.installed:
+ del sys.modules[module]
+ self.installed = set()
+
+ def find_module(self, fullname, path):
+ if fullname == 'm5.defines':
+ return self
+
+ if fullname == 'm5.objects':
+ return self
+
+ if fullname.startswith('m5.internal'):
+ return None
+
+ source = self.modules.get(fullname, None)
+ if source is not None and fullname.startswith('m5.objects'):
+ return self
+
+ return None
+
+ def load_module(self, fullname):
+ mod = imp.new_module(fullname)
+ sys.modules[fullname] = mod
+ self.installed.add(fullname)
+
+ mod.__loader__ = self
+ if fullname == 'm5.objects':
+ mod.__path__ = fullname.split('.')
+ return mod
+
+ if fullname == 'm5.defines':
+ mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
+ return mod
+
+ source = self.modules[fullname]
+ if source.modname == '__init__':
+ mod.__path__ = source.modpath
+ mod.__file__ = source.abspath
+
+ exec file(source.abspath, 'r') in mod.__dict__
+
+ return mod
+
+import m5.SimObject
+import m5.params
+from m5.util import code_formatter
+
+m5.SimObject.clear()
+m5.params.clear()
+
+# install the python importer so we can grab stuff from the source
+# tree itself. We can't have SimObjects added after this point or
+# else we won't know about them for the rest of the stuff.
+importer = DictImporter(PySource.modules)
+sys.meta_path[0:0] = [ importer ]
+
+# import all sim objects so we can populate the all_objects list
+# make sure that we're working with a list, then let's sort it
+for modname in SimObject.modnames:
+ exec('from m5.objects import %s' % modname)
+
+# we need to unload all of the currently imported modules so that they
+# will be re-imported the next time the sconscript is run
+importer.unload()
+sys.meta_path.remove(importer)
+
+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
+ # current version of SimObject.allClasses, but when scons
+ # actually uses the value, all versions of
+ # 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 ]
+
+########################################################################
+#
+# Commands for the basic automatically generated python files
+#
+
+# Generate Python file containing a dict specifying the current
+# buildEnv flags.
+def makeDefinesPyFile(target, source, env):
+ build_env = source[0].get_contents()
+
+ code = code_formatter()
+ code("""
+import m5.internal
+import m5.util
+
+buildEnv = m5.util.SmartDict($build_env)
+
+compileDate = m5.internal.core.compileDate
+_globals = globals()
+for key,val in m5.internal.core.__dict__.iteritems():
+ if key.startswith('flag_'):
+ flag = key[5:]
+ _globals[flag] = val
+del _globals
+""")
+ code.write(target[0].abspath)
+
+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)))
+PySource('m5', 'python/m5/defines.py')
+
+# Generate python file containing info about the M5 source code
+def makeInfoPyFile(target, source, env):
+ code = code_formatter()
+ for src in source:
+ data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
+ 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', ],
+ 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):
+ assert len(target) == 1 and len(source) == 1
+
+ name = str(source[0].get_contents())
+ obj = sim_objects[name]
+
+ code = code_formatter()
+ obj.cxx_decl(code)
+ code.write(target[0].abspath)
+
+def createSwigParam(target, source, env):
+ assert len(target) == 1 and len(source) == 1
+
+ name = str(source[0].get_contents())
+ param = all_params[name]
+
+ code = code_formatter()
+ code('%module(package="m5.internal") $0_${name}', param.file_ext)
+ param.swig_decl(code)
+ code.write(target[0].abspath)
+
+def createEnumStrings(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_def(code)
+ code.write(target[0].abspath)
+
+def createEnumParam(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 createEnumSwig(target, source, env):
+ assert len(target) == 1 and len(source) == 1
+
+ name = str(source[0].get_contents())
+ obj = all_enums[name]
+
+ code = code_formatter()
+ code('''\
+%module(package="m5.internal") enum_$name
+
+%{
+#include "enums/$name.hh"
+%}
+
+%include "enums/$name.hh"
+''')
+ code.write(target[0].abspath)
+
+# Generate all of the SimObject param struct header files
+params_hh_files = []
+for name,simobj in sorted(sim_objects.iteritems()):
+ py_source = PySource.modules[simobj.__module__]
+ extra_deps = [ py_source.tnode ]
+
+ hh_file = File('params/%s.hh' % name)
+ params_hh_files.append(hh_file)
+ env.Command(hh_file, Value(name),
+ MakeAction(createSimObjectParam, 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)
+
+# Generate all enum header files
+for name,enum in sorted(all_enums.iteritems()):
+ py_source = PySource.modules[enum.__module__]
+ extra_deps = [ py_source.tnode ]
+
+ cc_file = File('enums/%s.cc' % name)
+ 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),
+ MakeAction(createEnumParam, Transform("EN PARAM")))
+ 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")))
+ cc_file = str(swig.tnode)
+ init_file = '%s/init_%s.cc' % (dirname(cc_file), basename(cc_file))
+ env.Command(init_file, Value(swig.module),
+ MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW")))
+ Source(init_file, **swig.guards)
-###################################################
#
-# Special build rules.
+# Handle debug flags
#
-###################################################
-
-# base/traceflags.{cc,hh} are generated from base/traceflags.py.
-# $TARGET.base will expand to "<build-dir>/base/traceflags".
-env.Command(Split('base/traceflags.hh base/traceflags.cc'),
- 'base/traceflags.py',
- 'python $SOURCE $TARGET.base')
-
-SConscript('python/SConscript', exports = ['env'])
-
-# This function adds the specified sources to the given build
-# environment, and returns a list of all the corresponding SCons
-# Object nodes (including an extra one for date.cc). We explicitly
-# add the Object nodes so we can set up special dependencies for
-# date.cc.
-def make_objs(sources, env):
- objs = [env.Object(s) for s in sources]
- # make date.cc depend on all other objects so it always gets
- # recompiled whenever anything else does
- date_obj = env.Object('base/date.cc')
- env.Depends(date_obj, objs)
- objs.append(date_obj)
- return objs
-
-###################################################
+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
+ code('''
+/*
+ * DO NOT EDIT THIS FILE! Automatically generated
+ */
+
+#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()
+
+ code()
+ code('} // namespace Debug')
+
+ code.write(str(target[0]))
+
+def makeDebugFlagHH(target, source, env):
+ assert(len(target) == 1 and len(source) == 1)
+
+ val = eval(source[0].get_contents())
+ name, compound, desc = val
+
+ code = code_formatter()
+
+ # file header boilerplate
+ code('''\
+/*
+ * DO NOT EDIT THIS FILE!
+ *
+ * Automatically generated by SCons
+ */
+
+#ifndef __DEBUG_${name}_HH__
+#define __DEBUG_${name}_HH__
+
+namespace Debug {
+''')
+
+ if compound:
+ code('class CompoundFlag;')
+ code('class SimpleFlag;')
+
+ if compound:
+ code('extern CompoundFlag $name;')
+ for flag in compound:
+ code('extern SimpleFlag $flag;')
+ else:
+ code('extern SimpleFlag $name;')
+
+ code('''
+}
+
+#endif // __DEBUG_${name}_HH__
+''')
+
+ code.write(str(target[0]))
+
+for name,flag in sorted(debug_flags.iteritems()):
+ n, compound, desc = flag
+ assert n == name
+
+ 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
+# 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 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()
+
+ pysource = PySource.tnodes[source[0]]
+ compiled = compile(src, pysource.abspath, 'exec')
+ marshalled = marshal.dumps(compiled)
+ compressed = zlib.compress(marshalled)
+ data = compressed
+ sym = pysource.symname
+
+ code = code_formatter()
+ code('''\
+#include "sim/init.hh"
+
+namespace {
+
+const char data_${sym}[] = {
+''')
+ code.indent()
+ step = 16
+ for i in xrange(0, len(data), step):
+ x = array.array('B', data[i:i+step])
+ code(''.join('%d,' % d for d in x))
+ code.dedent()
+
+ 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]))
+
+for source in PySource.all:
+ env.Command(source.cpp, source.tnode,
+ MakeAction(embedPyFile, Transform("EMBED PY")))
+ Source(source.cpp)
+
+########################################################################
#
# Define binaries. Each different build type (debug, opt, etc.) gets
# a slightly different build environment.
#
-###################################################
# List of constructed environments to pass back to SConstruct
envList = []
+date_source = Source('base/date.cc', skip_lib=True)
+
# 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):
- newEnv = env.Copy(OBJSUFFIX=objsfx)
- newEnv.Label = label
- newEnv.Append(**kwargs)
- exe = 'm5.' + label # final executable
- bin = exe + '.bin' # executable w/o appended Python zip archive
- newEnv.Program(bin, make_objs(sources, newEnv))
+ # SCons doesn't know to append a library suffix when there is a '.' in the
+ # name. Use '_' instead.
+ libname = 'm5_' + label
+ exename = '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')
+
+ werror_env = new_env.Clone()
+ werror_env.Append(CCFLAGS='-Werror')
+
+ 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:
+ env = werror_env
+ else:
+ env = new_env
+
+ if static:
+ obj = env.StaticObject(source.tnode)
+ else:
+ obj = env.SharedObject(source.tnode)
+
+ if extra_deps:
+ env.Depends(obj, extra_deps)
+
+ return obj
+
+ sources = Source.get(main=False, skip_lib=False)
+ static_objs = [ make_obj(s, True) for s in sources ]
+ shared_objs = [ make_obj(s, False) for s in sources ]
+
+ 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)
+
+ # 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) ]
+
+ 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, main_objs + static_objs)
+
if strip:
- stripped_bin = bin + '.stripped'
if sys.platform == 'sunos5':
- newEnv.Command(stripped_bin, bin, 'cp $SOURCE $TARGET; strip $TARGET')
+ cmd = 'cp $SOURCE $TARGET; strip $TARGET'
else:
- newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
- bin = stripped_bin
- targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
- newEnv.M5Binary = targets[0]
- envList.append(newEnv)
+ cmd = 'strip $SOURCE -o $TARGET'
+ targets = new_env.Command(exename, progname,
+ MakeAction(cmd, Transform("STRIP")))
+
+ new_env.M5Binary = targets[0]
+ envList.append(new_env)
# Debug binary
ccflags = {}
ccflags['prof'] = '-fast -g -pg'
else:
print 'Unknown compiler, please fix compiler options'
- Exit(1)
+ Exit(1)
makeEnv('debug', '.do',
CCFLAGS = Split(ccflags['debug']),