SConscript revision 5824
1955SN/A# -*- mode:python -*-
2955SN/A
31762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
4955SN/A# All rights reserved.
5955SN/A#
6955SN/A# Redistribution and use in source and binary forms, with or without
7955SN/A# modification, are permitted provided that the following conditions are
8955SN/A# met: redistributions of source code must retain the above copyright
9955SN/A# notice, this list of conditions and the following disclaimer;
10955SN/A# redistributions in binary form must reproduce the above copyright
11955SN/A# notice, this list of conditions and the following disclaimer in the
12955SN/A# documentation and/or other materials provided with the distribution;
13955SN/A# neither the name of the copyright holders nor the names of its
14955SN/A# contributors may be used to endorse or promote products derived from
15955SN/A# this software without specific prior written permission.
16955SN/A#
17955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
282665Ssaidi@eecs.umich.edu#
294762Snate@binkert.org# Authors: Nathan Binkert
30955SN/A
315522Snate@binkert.orgimport array
324762Snate@binkert.orgimport imp
335522Snate@binkert.orgimport marshal
34955SN/Aimport os
355522Snate@binkert.orgimport re
36955SN/Aimport sys
375522Snate@binkert.orgimport zlib
384202Sbinkertn@umich.edu
395742Snate@binkert.orgfrom os.path import basename, dirname, exists, isdir, isfile, join as joinpath
40955SN/A
414381Sbinkertn@umich.eduimport SCons
424381Sbinkertn@umich.edu
43955SN/A# This file defines how to build a particular configuration of M5
44955SN/A# based on variable settings in the 'env' build environment.
45955SN/A
464202Sbinkertn@umich.eduImport('*')
47955SN/A
484382Sbinkertn@umich.edu# Children need to see the environment
494382Sbinkertn@umich.eduExport('env')
504382Sbinkertn@umich.edu
515517Snate@binkert.orgbuild_env = dict([(opt, env[opt]) for opt in env.ExportOptions])
525517Snate@binkert.org
534762Snate@binkert.orgdef sort_list(_list):
544762Snate@binkert.org    """return a sorted copy of '_list'"""
554762Snate@binkert.org    if isinstance(_list, list):
564762Snate@binkert.org        _list = _list[:]
574762Snate@binkert.org    else:
584762Snate@binkert.org        _list = list(_list)
594762Snate@binkert.org    _list.sort()
604762Snate@binkert.org    return _list
614762Snate@binkert.org
624762Snate@binkert.orgclass PySourceFile(object):
635522Snate@binkert.org    invalid_sym_char = re.compile('[^A-z0-9_]')
645604Snate@binkert.org    def __init__(self, package, tnode):
655604Snate@binkert.org        snode = tnode.srcnode()
665604Snate@binkert.org        filename = str(tnode)
674762Snate@binkert.org        pyname = basename(filename)
684762Snate@binkert.org        assert pyname.endswith('.py')
694762Snate@binkert.org        name = pyname[:-3]
705522Snate@binkert.org        if package:
715522Snate@binkert.org            path = package.split('.')
725522Snate@binkert.org        else:
735522Snate@binkert.org            path = []
745604Snate@binkert.org
755604Snate@binkert.org        modpath = path[:]
764762Snate@binkert.org        if name != '__init__':
774762Snate@binkert.org            modpath += [name]
784762Snate@binkert.org        modpath = '.'.join(modpath)
794762Snate@binkert.org
805522Snate@binkert.org        arcpath = path + [ pyname ]
814762Snate@binkert.org        arcname = joinpath(*arcpath)
824762Snate@binkert.org
835604Snate@binkert.org        debugname = snode.abspath
845604Snate@binkert.org        if not exists(debugname):
855604Snate@binkert.org            debugname = tnode.abspath
865604Snate@binkert.org
875604Snate@binkert.org        self.tnode = tnode
885604Snate@binkert.org        self.snode = snode
894762Snate@binkert.org        self.pyname = pyname
904762Snate@binkert.org        self.package = package
914762Snate@binkert.org        self.modpath = modpath
924762Snate@binkert.org        self.arcname = arcname
935604Snate@binkert.org        self.debugname = debugname
944762Snate@binkert.org        self.compiled = File(filename + 'c')
955522Snate@binkert.org        self.assembly = File(filename + '.s')
965522Snate@binkert.org        self.symname = "PyEMB_" + self.invalid_sym_char.sub('_', modpath)
975522Snate@binkert.org        
984762Snate@binkert.org
994382Sbinkertn@umich.edu########################################################################
1004762Snate@binkert.org# Code for adding source files of various types
1014382Sbinkertn@umich.edu#
1025522Snate@binkert.orgcc_lib_sources = []
1034381Sbinkertn@umich.edudef Source(source):
1045522Snate@binkert.org    '''Add a source file to the libm5 build'''
1054762Snate@binkert.org    if not isinstance(source, SCons.Node.FS.File):
1064762Snate@binkert.org        source = File(source)
1074762Snate@binkert.org
1085522Snate@binkert.org    cc_lib_sources.append(source)
1095522Snate@binkert.org
1105522Snate@binkert.orgcc_bin_sources = []
1115522Snate@binkert.orgdef BinSource(source):
1125522Snate@binkert.org    '''Add a source file to the m5 binary build'''
1135522Snate@binkert.org    if not isinstance(source, SCons.Node.FS.File):
1145522Snate@binkert.org        source = File(source)
1155522Snate@binkert.org
1165522Snate@binkert.org    cc_bin_sources.append(source)
1174762Snate@binkert.org
1184762Snate@binkert.orgpy_sources = []
1194762Snate@binkert.orgdef PySource(package, source):
1204762Snate@binkert.org    '''Add a python source file to the named package'''
1214762Snate@binkert.org    if not isinstance(source, SCons.Node.FS.File):
1224762Snate@binkert.org        source = File(source)
1234762Snate@binkert.org
1244762Snate@binkert.org    source = PySourceFile(package, source)
1254762Snate@binkert.org    py_sources.append(source)
1264762Snate@binkert.org
1274762Snate@binkert.orgsim_objects_fixed = False
1284762Snate@binkert.orgsim_object_modfiles = set()
1294762Snate@binkert.orgdef SimObject(source):
1304762Snate@binkert.org    '''Add a SimObject python file as a python source object and add
1314762Snate@binkert.org    it to a list of sim object modules'''
1324762Snate@binkert.org
1334762Snate@binkert.org    if sim_objects_fixed:
1344762Snate@binkert.org        raise AttributeError, "Too late to call SimObject now."
1354762Snate@binkert.org
1364762Snate@binkert.org    if not isinstance(source, SCons.Node.FS.File):
1374762Snate@binkert.org        source = File(source)
1384762Snate@binkert.org
1394762Snate@binkert.org    PySource('m5.objects', source)
1404762Snate@binkert.org    modfile = basename(str(source))
1414762Snate@binkert.org    assert modfile.endswith('.py')
1424762Snate@binkert.org    modname = modfile[:-3]
1434762Snate@binkert.org    sim_object_modfiles.add(modname)
1444762Snate@binkert.org
1454762Snate@binkert.orgswig_sources = []
1464762Snate@binkert.orgdef SwigSource(package, source):
1474762Snate@binkert.org    '''Add a swig file to build'''
1484762Snate@binkert.org    if not isinstance(source, SCons.Node.FS.File):
1494762Snate@binkert.org        source = File(source)
1504762Snate@binkert.org    val = source,package
1514762Snate@binkert.org    swig_sources.append(val)
152955SN/A
1535584Snate@binkert.orgunit_tests = []
1545584Snate@binkert.orgdef UnitTest(target, sources):
1555584Snate@binkert.org    if not isinstance(sources, (list, tuple)):
1565584Snate@binkert.org        sources = [ sources ]
1575584Snate@binkert.org    
1585584Snate@binkert.org    srcs = []
1595584Snate@binkert.org    for source in sources:
1605584Snate@binkert.org        if not isinstance(source, SCons.Node.FS.File):
1615584Snate@binkert.org            source = File(source)
1625584Snate@binkert.org        srcs.append(source)
1635584Snate@binkert.org            
1645584Snate@binkert.org    unit_tests.append((target, srcs))
1655584Snate@binkert.org
1664382Sbinkertn@umich.edu# Children should have access
1674202Sbinkertn@umich.eduExport('Source')
1685522Snate@binkert.orgExport('BinSource')
1694382Sbinkertn@umich.eduExport('PySource')
1704382Sbinkertn@umich.eduExport('SimObject')
1714382Sbinkertn@umich.eduExport('SwigSource')
1725584Snate@binkert.orgExport('UnitTest')
1734382Sbinkertn@umich.edu
1744382Sbinkertn@umich.edu########################################################################
1754382Sbinkertn@umich.edu#
1765192Ssaidi@eecs.umich.edu# Trace Flags
1775192Ssaidi@eecs.umich.edu#
1785799Snate@binkert.orgtrace_flags = {}
1795799Snate@binkert.orgdef TraceFlag(name, desc=None):
1805799Snate@binkert.org    if name in trace_flags:
1815192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
1825799Snate@binkert.org    trace_flags[name] = (name, (), desc)
1835192Ssaidi@eecs.umich.edu
1845799Snate@binkert.orgdef CompoundFlag(name, flags, desc=None):
1855799Snate@binkert.org    if name in trace_flags:
1865192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
1875192Ssaidi@eecs.umich.edu
1885192Ssaidi@eecs.umich.edu    compound = tuple(flags)
1895192Ssaidi@eecs.umich.edu    for flag in compound:
1905799Snate@binkert.org        if flag not in trace_flags:
1915192Ssaidi@eecs.umich.edu            raise AttributeError, "Trace flag %s not found" % flag
1925799Snate@binkert.org        if trace_flags[flag][1]:
1935192Ssaidi@eecs.umich.edu            raise AttributeError, \
1945192Ssaidi@eecs.umich.edu                "Compound flag can't point to another compound flag"
1955192Ssaidi@eecs.umich.edu
1965799Snate@binkert.org    trace_flags[name] = (name, compound, desc)
1975192Ssaidi@eecs.umich.edu
1985192Ssaidi@eecs.umich.eduExport('TraceFlag')
1995192Ssaidi@eecs.umich.eduExport('CompoundFlag')
2005192Ssaidi@eecs.umich.edu
2015192Ssaidi@eecs.umich.edu########################################################################
2025192Ssaidi@eecs.umich.edu#
2034382Sbinkertn@umich.edu# Set some compiler variables
2044382Sbinkertn@umich.edu#
2054382Sbinkertn@umich.edu
2062667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
2072667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
2082667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
2092667Sstever@eecs.umich.edu# files.
2102667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
2112667Sstever@eecs.umich.edu
2125742Snate@binkert.orgfor extra_dir in extras_dir_list:
2135742Snate@binkert.org    env.Append(CPPPATH=Dir(extra_dir))
2145742Snate@binkert.org
2152037SN/A# Add a flag defining what THE_ISA should be for all compilation
2162037SN/Aenv.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
2172037SN/A
2185793Snate@binkert.org# Workaround for bug in SCons version > 0.97d20071212
2195793Snate@binkert.org# Scons bug id: 2006 M5 Bug id: 308 
2205793Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
2215793Snate@binkert.org    Dir(root[len(base_dir) + 1:])
2225793Snate@binkert.org
2234382Sbinkertn@umich.edu########################################################################
2244762Snate@binkert.org#
2255344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories
2264382Sbinkertn@umich.edu#
2275341Sstever@gmail.com
2285742Snate@binkert.orghere = Dir('.').srcnode().abspath
2295742Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
2305742Snate@binkert.org    if root == here:
2315742Snate@binkert.org        # we don't want to recurse back into this SConscript
2325742Snate@binkert.org        continue
2334762Snate@binkert.org
2345742Snate@binkert.org    if 'SConscript' in files:
2355742Snate@binkert.org        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
2365742Snate@binkert.org        SConscript(joinpath(root, 'SConscript'), build_dir=build_dir)
2375742Snate@binkert.org
2385742Snate@binkert.orgfor extra_dir in extras_dir_list:
2395742Snate@binkert.org    prefix_len = len(dirname(extra_dir)) + 1
2405742Snate@binkert.org    for root, dirs, files in os.walk(extra_dir, topdown=True):
2415341Sstever@gmail.com        if 'SConscript' in files:
2425742Snate@binkert.org            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
2435341Sstever@gmail.com            SConscript(joinpath(root, 'SConscript'), build_dir=build_dir)
2444773Snate@binkert.org
2451858SN/Afor opt in env.ExportOptions:
2461858SN/A    env.ConfigFile(opt)
2471085SN/A
2484382Sbinkertn@umich.edu########################################################################
2494382Sbinkertn@umich.edu#
2504762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
2514762Snate@binkert.org# should all have been added in the SConscripts above
2524762Snate@binkert.org#
2535517Snate@binkert.orgclass DictImporter(object):
2545517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
2555517Snate@binkert.org    map to arbitrary filenames.'''
2565517Snate@binkert.org    def __init__(self, modules):
2575517Snate@binkert.org        self.modules = modules
2585517Snate@binkert.org        self.installed = set()
2595517Snate@binkert.org
2605517Snate@binkert.org    def __del__(self):
2615517Snate@binkert.org        self.unload()
2625517Snate@binkert.org
2635517Snate@binkert.org    def unload(self):
2645517Snate@binkert.org        import sys
2655517Snate@binkert.org        for module in self.installed:
2665517Snate@binkert.org            del sys.modules[module]
2675517Snate@binkert.org        self.installed = set()
2685517Snate@binkert.org
2695517Snate@binkert.org    def find_module(self, fullname, path):
2705798Snate@binkert.org        if fullname == 'defines':
2715517Snate@binkert.org            return self
2725517Snate@binkert.org
2735517Snate@binkert.org        if fullname == 'm5.objects':
2745517Snate@binkert.org            return self
2755517Snate@binkert.org
2765517Snate@binkert.org        if fullname.startswith('m5.internal'):
2775517Snate@binkert.org            return None
2785517Snate@binkert.org
2795517Snate@binkert.org        if fullname in self.modules and exists(self.modules[fullname]):
2805517Snate@binkert.org            return self
2815517Snate@binkert.org
2825517Snate@binkert.org        return None
2835517Snate@binkert.org
2845517Snate@binkert.org    def load_module(self, fullname):
2855517Snate@binkert.org        mod = imp.new_module(fullname)
2865517Snate@binkert.org        sys.modules[fullname] = mod
2875517Snate@binkert.org        self.installed.add(fullname)
2885517Snate@binkert.org
2895517Snate@binkert.org        mod.__loader__ = self
2905517Snate@binkert.org        if fullname == 'm5.objects':
2915517Snate@binkert.org            mod.__path__ = fullname.split('.')
2925517Snate@binkert.org            return mod
2935517Snate@binkert.org
2945798Snate@binkert.org        if fullname == 'defines':
2955798Snate@binkert.org            mod.__dict__['buildEnv'] = build_env
2965517Snate@binkert.org            return mod
2975517Snate@binkert.org
2985517Snate@binkert.org        srcfile = self.modules[fullname]
2995517Snate@binkert.org        if basename(srcfile) == '__init__.py':
3005517Snate@binkert.org            mod.__path__ = fullname.split('.')
3015517Snate@binkert.org        mod.__file__ = srcfile
3025517Snate@binkert.org
3035517Snate@binkert.org        exec file(srcfile, 'r') in mod.__dict__
3045517Snate@binkert.org
3055517Snate@binkert.org        return mod
3065517Snate@binkert.org
3075517Snate@binkert.orgpy_modules = {}
3085517Snate@binkert.orgfor source in py_sources:
3095522Snate@binkert.org    py_modules[source.modpath] = source.snode.abspath
3105517Snate@binkert.org
3115517Snate@binkert.org# install the python importer so we can grab stuff from the source
3125517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
3135517Snate@binkert.org# else we won't know about them for the rest of the stuff.
3144762Snate@binkert.orgsim_objects_fixed = True
3155517Snate@binkert.orgimporter = DictImporter(py_modules)
3165517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
3174762Snate@binkert.org
3185517Snate@binkert.orgimport m5
3194762Snate@binkert.org
3205517Snate@binkert.org# import all sim objects so we can populate the all_objects list
3215517Snate@binkert.org# make sure that we're working with a list, then let's sort it
3225517Snate@binkert.orgsim_objects = list(sim_object_modfiles)
3235517Snate@binkert.orgsim_objects.sort()
3245517Snate@binkert.orgfor simobj in sim_objects:
3255517Snate@binkert.org    exec('from m5.objects import %s' % simobj)
3265517Snate@binkert.org
3275517Snate@binkert.org# we need to unload all of the currently imported modules so that they
3285517Snate@binkert.org# will be re-imported the next time the sconscript is run
3295517Snate@binkert.orgimporter.unload()
3305517Snate@binkert.orgsys.meta_path.remove(importer)
3315517Snate@binkert.org
3325517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
3335517Snate@binkert.orgall_enums = m5.params.allEnums
3345517Snate@binkert.org
3355517Snate@binkert.orgall_params = {}
3365517Snate@binkert.orgfor name,obj in sim_objects.iteritems():
3375517Snate@binkert.org    for param in obj._params.local.values():
3385517Snate@binkert.org        if not hasattr(param, 'swig_decl'):
3395517Snate@binkert.org            continue
3405517Snate@binkert.org        pname = param.ptype_str
3415517Snate@binkert.org        if pname not in all_params:
3425517Snate@binkert.org            all_params[pname] = param
3434762Snate@binkert.org
3444762Snate@binkert.org########################################################################
3454762Snate@binkert.org#
3464762Snate@binkert.org# calculate extra dependencies
3474762Snate@binkert.org#
3484762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
3495517Snate@binkert.orgdepends = [ File(py_modules[dep]) for dep in module_depends ]
3504762Snate@binkert.org
3514762Snate@binkert.org########################################################################
3524762Snate@binkert.org#
3534762Snate@binkert.org# Commands for the basic automatically generated python files
3544382Sbinkertn@umich.edu#
3554382Sbinkertn@umich.edu
3565798Snate@binkert.orgscons_dir = str(SCons.Node.FS.default_fs.SConstruct_dir)
3575798Snate@binkert.org
3585824Ssaidi@eecs.umich.eduhg_info = "Unknown"
3595798Snate@binkert.orghg_demandimport = False
3605798Snate@binkert.orgtry:
3615798Snate@binkert.org    if not exists(scons_dir) or not isdir(scons_dir) or \
3625798Snate@binkert.org           not exists(joinpath(scons_dir, ".hg")):
3635798Snate@binkert.org        raise ValueError(".hg directory not found")
3645824Ssaidi@eecs.umich.edu    import subprocess    
3655824Ssaidi@eecs.umich.edu    output = subprocess.Popen("hg id -n -i -t -b".split(), 
3665824Ssaidi@eecs.umich.edu                              stdout=subprocess.PIPE).communicate()[0]
3675824Ssaidi@eecs.umich.edu    hg_info = output.strip()
3685798Snate@binkert.orgexcept ImportError, e:
3695798Snate@binkert.org    print "Mercurial not found"
3705798Snate@binkert.orgexcept ValueError, e:
3715798Snate@binkert.org    print e
3725798Snate@binkert.orgexcept Exception, e:
3735798Snate@binkert.org    print "Other mercurial exception: %s" % e
3745798Snate@binkert.org
3755517Snate@binkert.org# Generate Python file containing a dict specifying the current
3765517Snate@binkert.org# build_env flags.
3775517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
3785517Snate@binkert.org    f = file(str(target[0]), 'w')
3795798Snate@binkert.org    build_env, hg_info = [ x.get_contents() for x in source ]
3805798Snate@binkert.org    print >>f, "buildEnv = %s" % build_env
3815824Ssaidi@eecs.umich.edu    print >>f, "hgRev = '%s'" % hg_info
3825517Snate@binkert.org    f.close()
3835517Snate@binkert.org
3845798Snate@binkert.orgdefines_info = [ Value(build_env), Value(hg_info) ]
3855798Snate@binkert.org# Generate a file with all of the compile options in it
3865798Snate@binkert.orgenv.Command('python/m5/defines.py', defines_info, makeDefinesPyFile)
3875798Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
3885798Snate@binkert.org
3895517Snate@binkert.org# Generate python file containing info about the M5 source code
3905517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
3915517Snate@binkert.org    f = file(str(target[0]), 'w')
3925517Snate@binkert.org    for src in source:
3935517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
3945517Snate@binkert.org        print >>f, "%s = %s" % (src, repr(data))
3955517Snate@binkert.org    f.close()
3965517Snate@binkert.org
3975798Snate@binkert.org# Generate a file that wraps the basic top level files
3985798Snate@binkert.orgenv.Command('python/m5/info.py',
3995798Snate@binkert.org            [ '#/AUTHORS', '#/LICENSE', '#/README', '#/RELEASE_NOTES' ],
4005798Snate@binkert.org            makeInfoPyFile)
4015798Snate@binkert.orgPySource('m5', 'python/m5/info.py')
4025798Snate@binkert.org
4035517Snate@binkert.org# Generate the __init__.py file for m5.objects
4045517Snate@binkert.orgdef makeObjectsInitFile(target, source, env):
4055517Snate@binkert.org    f = file(str(target[0]), 'w')
4065517Snate@binkert.org    print >>f, 'from params import *'
4075517Snate@binkert.org    print >>f, 'from m5.SimObject import *'
4085517Snate@binkert.org    for module in source:
4095517Snate@binkert.org        print >>f, 'from %s import *' % module.get_contents()
4105517Snate@binkert.org    f.close()
4115517Snate@binkert.org
4124762Snate@binkert.org# Generate an __init__.py file for the objects package
4134382Sbinkertn@umich.eduenv.Command('python/m5/objects/__init__.py',
4144762Snate@binkert.org            [ Value(o) for o in sort_list(sim_object_modfiles) ],
4155517Snate@binkert.org            makeObjectsInitFile)
4164382Sbinkertn@umich.eduPySource('m5.objects', 'python/m5/objects/__init__.py')
4174382Sbinkertn@umich.edu
4184762Snate@binkert.org########################################################################
4194762Snate@binkert.org#
4204762Snate@binkert.org# Create all of the SimObject param headers and enum headers
4214762Snate@binkert.org#
4224762Snate@binkert.org
4235517Snate@binkert.orgdef createSimObjectParam(target, source, env):
4245517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4255517Snate@binkert.org
4265517Snate@binkert.org    hh_file = file(target[0].abspath, 'w')
4275517Snate@binkert.org    name = str(source[0].get_contents())
4285517Snate@binkert.org    obj = sim_objects[name]
4295517Snate@binkert.org
4305517Snate@binkert.org    print >>hh_file, obj.cxx_decl()
4315517Snate@binkert.org
4325517Snate@binkert.orgdef createSwigParam(target, source, env):
4335517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4345517Snate@binkert.org
4355517Snate@binkert.org    i_file = file(target[0].abspath, 'w')
4365517Snate@binkert.org    name = str(source[0].get_contents())
4375517Snate@binkert.org    param = all_params[name]
4385517Snate@binkert.org
4395517Snate@binkert.org    for line in param.swig_decl():
4405517Snate@binkert.org        print >>i_file, line
4415517Snate@binkert.org
4425517Snate@binkert.orgdef createEnumStrings(target, source, env):
4435517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4445517Snate@binkert.org
4455517Snate@binkert.org    cc_file = file(target[0].abspath, 'w')
4465517Snate@binkert.org    name = str(source[0].get_contents())
4475517Snate@binkert.org    obj = all_enums[name]
4485517Snate@binkert.org
4495517Snate@binkert.org    print >>cc_file, obj.cxx_def()
4505517Snate@binkert.org    cc_file.close()
4515517Snate@binkert.org
4525517Snate@binkert.orgdef createEnumParam(target, source, env):
4535517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4545517Snate@binkert.org
4555517Snate@binkert.org    hh_file = file(target[0].abspath, 'w')
4565517Snate@binkert.org    name = str(source[0].get_contents())
4575517Snate@binkert.org    obj = all_enums[name]
4585517Snate@binkert.org
4595517Snate@binkert.org    print >>hh_file, obj.cxx_decl()
4605517Snate@binkert.org
4614762Snate@binkert.org# Generate all of the SimObject param struct header files
4624762Snate@binkert.orgparams_hh_files = []
4635517Snate@binkert.orgfor name,simobj in sim_objects.iteritems():
4645517Snate@binkert.org    extra_deps = [ File(py_modules[simobj.__module__]) ]
4654762Snate@binkert.org
4664762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
4674762Snate@binkert.org    params_hh_files.append(hh_file)
4685517Snate@binkert.org    env.Command(hh_file, Value(name), createSimObjectParam)
4694762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
4704762Snate@binkert.org
4714762Snate@binkert.org# Generate any parameter header files needed
4725463Snate@binkert.orgparams_i_files = []
4735517Snate@binkert.orgfor name,param in all_params.iteritems():
4744762Snate@binkert.org    if isinstance(param, m5.params.VectorParamDesc):
4754762Snate@binkert.org        ext = 'vptype'
4764762Snate@binkert.org    else:
4774762Snate@binkert.org        ext = 'ptype'
4784762Snate@binkert.org
4794762Snate@binkert.org    i_file = File('params/%s_%s.i' % (name, ext))
4805463Snate@binkert.org    params_i_files.append(i_file)
4815517Snate@binkert.org    env.Command(i_file, Value(name), createSwigParam)
4824762Snate@binkert.org    env.Depends(i_file, depends)
4834762Snate@binkert.org
4844762Snate@binkert.org# Generate all enum header files
4855517Snate@binkert.orgfor name,enum in all_enums.iteritems():
4865517Snate@binkert.org    extra_deps = [ File(py_modules[enum.__module__]) ]
4874762Snate@binkert.org
4884762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
4895517Snate@binkert.org    env.Command(cc_file, Value(name), createEnumStrings)
4904762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
4914762Snate@binkert.org    Source(cc_file)
4924762Snate@binkert.org
4934762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
4945517Snate@binkert.org    env.Command(hh_file, Value(name), createEnumParam)
4954762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
4964762Snate@binkert.org
4974762Snate@binkert.org# Build the big monolithic swigged params module (wraps all SimObject
4984762Snate@binkert.org# param structs and enum structs)
4995517Snate@binkert.orgdef buildParams(target, source, env):
5005517Snate@binkert.org    names = [ s.get_contents() for s in source ]
5015517Snate@binkert.org    objs = [ sim_objects[name] for name in names ]
5025517Snate@binkert.org    out = file(target[0].abspath, 'w')
5035517Snate@binkert.org
5045517Snate@binkert.org    ordered_objs = []
5055517Snate@binkert.org    obj_seen = set()
5065517Snate@binkert.org    def order_obj(obj):
5075517Snate@binkert.org        name = str(obj)
5085517Snate@binkert.org        if name in obj_seen:
5095517Snate@binkert.org            return
5105517Snate@binkert.org
5115517Snate@binkert.org        obj_seen.add(name)
5125517Snate@binkert.org        if str(obj) != 'SimObject':
5135517Snate@binkert.org            order_obj(obj.__bases__[0])
5145517Snate@binkert.org
5155517Snate@binkert.org        ordered_objs.append(obj)
5165517Snate@binkert.org
5175517Snate@binkert.org    for obj in objs:
5185517Snate@binkert.org        order_obj(obj)
5195517Snate@binkert.org
5205517Snate@binkert.org    enums = set()
5215517Snate@binkert.org    predecls = []
5225517Snate@binkert.org    pd_seen = set()
5235517Snate@binkert.org
5245517Snate@binkert.org    def add_pds(*pds):
5255517Snate@binkert.org        for pd in pds:
5265517Snate@binkert.org            if pd not in pd_seen:
5275517Snate@binkert.org                predecls.append(pd)
5285517Snate@binkert.org                pd_seen.add(pd)
5295517Snate@binkert.org
5305517Snate@binkert.org    for obj in ordered_objs:
5315517Snate@binkert.org        params = obj._params.local.values()
5325517Snate@binkert.org        for param in params:
5335517Snate@binkert.org            ptype = param.ptype
5345517Snate@binkert.org            if issubclass(ptype, m5.params.Enum):
5355517Snate@binkert.org                if ptype not in enums:
5365517Snate@binkert.org                    enums.add(ptype)
5375517Snate@binkert.org            pds = param.swig_predecls()
5385517Snate@binkert.org            if isinstance(pds, (list, tuple)):
5395517Snate@binkert.org                add_pds(*pds)
5405517Snate@binkert.org            else:
5415517Snate@binkert.org                add_pds(pds)
5425517Snate@binkert.org
5435517Snate@binkert.org    print >>out, '%module params'
5445517Snate@binkert.org
5455517Snate@binkert.org    print >>out, '%{'
5465517Snate@binkert.org    for obj in ordered_objs:
5475517Snate@binkert.org        print >>out, '#include "params/%s.hh"' % obj
5485517Snate@binkert.org    print >>out, '%}'
5495517Snate@binkert.org
5505517Snate@binkert.org    for pd in predecls:
5515517Snate@binkert.org        print >>out, pd
5525517Snate@binkert.org
5535517Snate@binkert.org    enums = list(enums)
5545517Snate@binkert.org    enums.sort()
5555517Snate@binkert.org    for enum in enums:
5565517Snate@binkert.org        print >>out, '%%include "enums/%s.hh"' % enum.__name__
5575517Snate@binkert.org    print >>out
5585517Snate@binkert.org
5595517Snate@binkert.org    for obj in ordered_objs:
5605517Snate@binkert.org        if obj.swig_objdecls:
5615517Snate@binkert.org            for decl in obj.swig_objdecls:
5625517Snate@binkert.org                print >>out, decl
5635517Snate@binkert.org            continue
5645517Snate@binkert.org
5655610Snate@binkert.org        class_path = obj.cxx_class.split('::')
5665623Snate@binkert.org        classname = class_path[-1]
5675623Snate@binkert.org        namespaces = class_path[:-1]
5685623Snate@binkert.org        namespaces.reverse()
5695610Snate@binkert.org
5705517Snate@binkert.org        code = ''
5715623Snate@binkert.org
5725623Snate@binkert.org        if namespaces:
5735623Snate@binkert.org            code += '// avoid name conflicts\n'
5745623Snate@binkert.org            sep_string = '_COLONS_'
5755623Snate@binkert.org            flat_name = sep_string.join(class_path)
5765623Snate@binkert.org            code += '%%rename(%s) %s;\n' % (flat_name, classname)
5775623Snate@binkert.org
5785517Snate@binkert.org        code += '// stop swig from creating/wrapping default ctor/dtor\n'
5795610Snate@binkert.org        code += '%%nodefault %s;\n' % classname
5805610Snate@binkert.org        code += 'class %s ' % classname
5815610Snate@binkert.org        if obj._base:
5825610Snate@binkert.org            code += ': public %s' % obj._base.cxx_class
5835517Snate@binkert.org        code += ' {};\n'
5845517Snate@binkert.org
5855610Snate@binkert.org        for ns in namespaces:
5865610Snate@binkert.org            new_code = 'namespace %s {\n' % ns
5875517Snate@binkert.org            new_code += code
5885517Snate@binkert.org            new_code += '}\n'
5895517Snate@binkert.org            code = new_code
5905517Snate@binkert.org
5915517Snate@binkert.org        print >>out, code
5925517Snate@binkert.org
5935517Snate@binkert.org    print >>out, '%%include "src/sim/sim_object_params.hh"' % obj
5945517Snate@binkert.org    for obj in ordered_objs:
5955517Snate@binkert.org        print >>out, '%%include "params/%s.hh"' % obj
5965517Snate@binkert.org
5974762Snate@binkert.orgparams_file = File('params/params.i')
5985517Snate@binkert.orgnames = sort_list(sim_objects.keys())
5995517Snate@binkert.orgenv.Command(params_file, [ Value(v) for v in names ], buildParams)
6005463Snate@binkert.orgenv.Depends(params_file, params_hh_files + params_i_files + depends)
6014762Snate@binkert.orgSwigSource('m5.objects', params_file)
6024762Snate@binkert.org
6034762Snate@binkert.org# Build all swig modules
6044382Sbinkertn@umich.eduswig_modules = []
6055554Snate@binkert.orgcc_swig_sources = []
6064762Snate@binkert.orgfor source,package in swig_sources:
6074382Sbinkertn@umich.edu    filename = str(source)
6084762Snate@binkert.org    assert filename.endswith('.i')
6094382Sbinkertn@umich.edu
6104762Snate@binkert.org    base = '.'.join(filename.split('.')[:-1])
6114762Snate@binkert.org    module = basename(base)
6124762Snate@binkert.org    cc_file = base + '_wrap.cc'
6134762Snate@binkert.org    py_file = base + '.py'
6144382Sbinkertn@umich.edu
6154382Sbinkertn@umich.edu    env.Command([cc_file, py_file], source,
6164382Sbinkertn@umich.edu                '$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
6174382Sbinkertn@umich.edu                '-o ${TARGETS[0]} $SOURCES')
6184382Sbinkertn@umich.edu    env.Depends(py_file, source)
6194382Sbinkertn@umich.edu    env.Depends(cc_file, source)
6204762Snate@binkert.org
6214382Sbinkertn@umich.edu    swig_modules.append(Value(module))
6225554Snate@binkert.org    cc_swig_sources.append(File(cc_file))
6234382Sbinkertn@umich.edu    PySource(package, py_file)
6244382Sbinkertn@umich.edu
6254762Snate@binkert.org# Generate the main swig init file
6265517Snate@binkert.orgdef makeSwigInit(target, source, env):
6275517Snate@binkert.org    f = file(str(target[0]), 'w')
6285517Snate@binkert.org    print >>f, 'extern "C" {'
6295517Snate@binkert.org    for module in source:
6305517Snate@binkert.org        print >>f, '    void init_%s();' % module.get_contents()
6315517Snate@binkert.org    print >>f, '}'
6325522Snate@binkert.org    print >>f, 'void initSwig() {'
6335517Snate@binkert.org    for module in source:
6345517Snate@binkert.org        print >>f, '    init_%s();' % module.get_contents()
6355517Snate@binkert.org    print >>f, '}'
6365517Snate@binkert.org    f.close()
6375517Snate@binkert.org
6385522Snate@binkert.orgenv.Command('python/swig/init.cc', swig_modules, makeSwigInit)
6395522Snate@binkert.orgSource('python/swig/init.cc')
6404382Sbinkertn@umich.edu
6415192Ssaidi@eecs.umich.edu# Generate traceflags.py
6425517Snate@binkert.orgdef traceFlagsPy(target, source, env):
6435517Snate@binkert.org    assert(len(target) == 1)
6445517Snate@binkert.org
6455517Snate@binkert.org    f = file(str(target[0]), 'w')
6465517Snate@binkert.org
6475517Snate@binkert.org    allFlags = []
6485517Snate@binkert.org    for s in source:
6495517Snate@binkert.org        val = eval(s.get_contents())
6505517Snate@binkert.org        allFlags.append(val)
6515517Snate@binkert.org
6525799Snate@binkert.org    allFlags.sort()
6535799Snate@binkert.org
6545799Snate@binkert.org    print >>f, 'basic = ['
6555517Snate@binkert.org    for flag, compound, desc in allFlags:
6565517Snate@binkert.org        if not compound:
6575517Snate@binkert.org            print >>f, "    '%s'," % flag
6585517Snate@binkert.org    print >>f, "    ]"
6595517Snate@binkert.org    print >>f
6605517Snate@binkert.org
6615799Snate@binkert.org    print >>f, 'compound = ['
6625517Snate@binkert.org    print >>f, "    'All',"
6635517Snate@binkert.org    for flag, compound, desc in allFlags:
6645517Snate@binkert.org        if compound:
6655517Snate@binkert.org            print >>f, "    '%s'," % flag
6665517Snate@binkert.org    print >>f, "    ]"
6675517Snate@binkert.org    print >>f
6685517Snate@binkert.org
6695799Snate@binkert.org    print >>f, "all = frozenset(basic + compound)"
6705517Snate@binkert.org    print >>f
6715517Snate@binkert.org
6725799Snate@binkert.org    print >>f, 'compoundMap = {'
6735517Snate@binkert.org    all = tuple([flag for flag,compound,desc in allFlags if not compound])
6745517Snate@binkert.org    print >>f, "    'All' : %s," % (all, )
6755517Snate@binkert.org    for flag, compound, desc in allFlags:
6765517Snate@binkert.org        if compound:
6775517Snate@binkert.org            print >>f, "    '%s' : %s," % (flag, compound)
6785517Snate@binkert.org    print >>f, "    }"
6795517Snate@binkert.org    print >>f
6805517Snate@binkert.org
6815799Snate@binkert.org    print >>f, 'descriptions = {'
6825517Snate@binkert.org    print >>f, "    'All' : 'All flags',"
6835517Snate@binkert.org    for flag, compound, desc in allFlags:
6845517Snate@binkert.org        print >>f, "    '%s' : '%s'," % (flag, desc)
6855517Snate@binkert.org    print >>f, "    }"
6865517Snate@binkert.org
6875517Snate@binkert.org    f.close()
6885517Snate@binkert.org
6895517Snate@binkert.orgdef traceFlagsCC(target, source, env):
6905517Snate@binkert.org    assert(len(target) == 1)
6915517Snate@binkert.org
6925517Snate@binkert.org    f = file(str(target[0]), 'w')
6935517Snate@binkert.org
6945517Snate@binkert.org    allFlags = []
6955517Snate@binkert.org    for s in source:
6965517Snate@binkert.org        val = eval(s.get_contents())
6975517Snate@binkert.org        allFlags.append(val)
6985517Snate@binkert.org
6995517Snate@binkert.org    # file header
7005517Snate@binkert.org    print >>f, '''
7015517Snate@binkert.org/*
7025517Snate@binkert.org * DO NOT EDIT THIS FILE! Automatically generated
7035517Snate@binkert.org */
7045517Snate@binkert.org
7055517Snate@binkert.org#include "base/traceflags.hh"
7065517Snate@binkert.org
7075517Snate@binkert.orgusing namespace Trace;
7085517Snate@binkert.org
7095517Snate@binkert.orgconst char *Trace::flagStrings[] =
7105517Snate@binkert.org{'''
7115517Snate@binkert.org
7125517Snate@binkert.org    # The string array is used by SimpleEnumParam to map the strings
7135517Snate@binkert.org    # provided by the user to enum values.
7145517Snate@binkert.org    for flag, compound, desc in allFlags:
7155517Snate@binkert.org        if not compound:
7165517Snate@binkert.org            print >>f, '    "%s",' % flag
7175517Snate@binkert.org
7185517Snate@binkert.org    print >>f, '    "All",'
7195517Snate@binkert.org    for flag, compound, desc in allFlags:
7205517Snate@binkert.org        if compound:
7215517Snate@binkert.org            print >>f, '    "%s",' % flag
7225517Snate@binkert.org
7235517Snate@binkert.org    print >>f, '};'
7245517Snate@binkert.org    print >>f
7255517Snate@binkert.org    print >>f, 'const int Trace::numFlagStrings = %d;' % (len(allFlags) + 1)
7265517Snate@binkert.org    print >>f
7275517Snate@binkert.org
7285517Snate@binkert.org    #
7295517Snate@binkert.org    # Now define the individual compound flag arrays.  There is an array
7305517Snate@binkert.org    # for each compound flag listing the component base flags.
7315517Snate@binkert.org    #
7325517Snate@binkert.org    all = tuple([flag for flag,compound,desc in allFlags if not compound])
7335517Snate@binkert.org    print >>f, 'static const Flags AllMap[] = {'
7345517Snate@binkert.org    for flag, compound, desc in allFlags:
7355517Snate@binkert.org        if not compound:
7365517Snate@binkert.org            print >>f, "    %s," % flag
7375517Snate@binkert.org    print >>f, '};'
7385517Snate@binkert.org    print >>f
7395517Snate@binkert.org
7405517Snate@binkert.org    for flag, compound, desc in allFlags:
7415517Snate@binkert.org        if not compound:
7425517Snate@binkert.org            continue
7435517Snate@binkert.org        print >>f, 'static const Flags %sMap[] = {' % flag
7445517Snate@binkert.org        for flag in compound:
7455517Snate@binkert.org            print >>f, "    %s," % flag
7465517Snate@binkert.org        print >>f, "    (Flags)-1"
7475517Snate@binkert.org        print >>f, '};'
7485517Snate@binkert.org        print >>f
7495517Snate@binkert.org
7505517Snate@binkert.org    #
7515517Snate@binkert.org    # Finally the compoundFlags[] array maps the compound flags
7525517Snate@binkert.org    # to their individual arrays/
7535517Snate@binkert.org    #
7545517Snate@binkert.org    print >>f, 'const Flags *Trace::compoundFlags[] ='
7555517Snate@binkert.org    print >>f, '{'
7565517Snate@binkert.org    print >>f, '    AllMap,'
7575517Snate@binkert.org    for flag, compound, desc in allFlags:
7585517Snate@binkert.org        if compound:
7595517Snate@binkert.org            print >>f, '    %sMap,' % flag
7605517Snate@binkert.org    # file trailer
7615517Snate@binkert.org    print >>f, '};'
7625517Snate@binkert.org
7635517Snate@binkert.org    f.close()
7645517Snate@binkert.org
7655517Snate@binkert.orgdef traceFlagsHH(target, source, env):
7665517Snate@binkert.org    assert(len(target) == 1)
7675517Snate@binkert.org
7685517Snate@binkert.org    f = file(str(target[0]), 'w')
7695517Snate@binkert.org
7705517Snate@binkert.org    allFlags = []
7715517Snate@binkert.org    for s in source:
7725517Snate@binkert.org        val = eval(s.get_contents())
7735517Snate@binkert.org        allFlags.append(val)
7745517Snate@binkert.org
7755517Snate@binkert.org    # file header boilerplate
7765517Snate@binkert.org    print >>f, '''
7775517Snate@binkert.org/*
7785517Snate@binkert.org * DO NOT EDIT THIS FILE!
7795517Snate@binkert.org *
7805517Snate@binkert.org * Automatically generated from traceflags.py
7815517Snate@binkert.org */
7825517Snate@binkert.org
7835517Snate@binkert.org#ifndef __BASE_TRACE_FLAGS_HH__
7845517Snate@binkert.org#define __BASE_TRACE_FLAGS_HH__
7855517Snate@binkert.org
7865517Snate@binkert.orgnamespace Trace {
7875517Snate@binkert.org
7885517Snate@binkert.orgenum Flags {'''
7895517Snate@binkert.org
7905517Snate@binkert.org    # Generate the enum.  Base flags come first, then compound flags.
7915517Snate@binkert.org    idx = 0
7925517Snate@binkert.org    for flag, compound, desc in allFlags:
7935517Snate@binkert.org        if not compound:
7945517Snate@binkert.org            print >>f, '    %s = %d,' % (flag, idx)
7955517Snate@binkert.org            idx += 1
7965517Snate@binkert.org
7975517Snate@binkert.org    numBaseFlags = idx
7985517Snate@binkert.org    print >>f, '    NumFlags = %d,' % idx
7995517Snate@binkert.org
8005517Snate@binkert.org    # put a comment in here to separate base from compound flags
8015517Snate@binkert.org    print >>f, '''
8025517Snate@binkert.org// The remaining enum values are *not* valid indices for Trace::flags.
8035517Snate@binkert.org// They are "compound" flags, which correspond to sets of base
8045517Snate@binkert.org// flags, and are used by changeFlag.'''
8055517Snate@binkert.org
8065517Snate@binkert.org    print >>f, '    All = %d,' % idx
8075517Snate@binkert.org    idx += 1
8085517Snate@binkert.org    for flag, compound, desc in allFlags:
8095517Snate@binkert.org        if compound:
8105517Snate@binkert.org            print >>f, '    %s = %d,' % (flag, idx)
8115517Snate@binkert.org            idx += 1
8125517Snate@binkert.org
8135517Snate@binkert.org    numCompoundFlags = idx - numBaseFlags
8145517Snate@binkert.org    print >>f, '    NumCompoundFlags = %d' % numCompoundFlags
8155517Snate@binkert.org
8165517Snate@binkert.org    # trailer boilerplate
8175517Snate@binkert.org    print >>f, '''\
8185517Snate@binkert.org}; // enum Flags
8195517Snate@binkert.org
8205517Snate@binkert.org// Array of strings for SimpleEnumParam
8215517Snate@binkert.orgextern const char *flagStrings[];
8225517Snate@binkert.orgextern const int numFlagStrings;
8235517Snate@binkert.org
8245517Snate@binkert.org// Array of arraay pointers: for each compound flag, gives the list of
8255517Snate@binkert.org// base flags to set.  Inidividual flag arrays are terminated by -1.
8265517Snate@binkert.orgextern const Flags *compoundFlags[];
8275517Snate@binkert.org
8285517Snate@binkert.org/* namespace Trace */ }
8295517Snate@binkert.org
8305517Snate@binkert.org#endif // __BASE_TRACE_FLAGS_HH__
8315517Snate@binkert.org'''
8325517Snate@binkert.org
8335517Snate@binkert.org    f.close()
8345517Snate@binkert.org
8355799Snate@binkert.orgflags = [ Value(f) for f in trace_flags.values() ]
8365517Snate@binkert.orgenv.Command('base/traceflags.py', flags, traceFlagsPy)
8375192Ssaidi@eecs.umich.eduPySource('m5', 'base/traceflags.py')
8385192Ssaidi@eecs.umich.edu
8395517Snate@binkert.orgenv.Command('base/traceflags.hh', flags, traceFlagsHH)
8405517Snate@binkert.orgenv.Command('base/traceflags.cc', flags, traceFlagsCC)
8415192Ssaidi@eecs.umich.eduSource('base/traceflags.cc')
8425192Ssaidi@eecs.umich.edu
8435522Snate@binkert.org# embed python files.  All .py files that have been indicated by a
8445522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
8455522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
8465522Snate@binkert.org# byte code, compress it, and then generate an assembly file that
8475522Snate@binkert.org# inserts the result into the data section with symbols indicating the
8485522Snate@binkert.org# beginning, and end (and with the size at the end)
8495522Snate@binkert.orgpy_sources_tnodes = {}
8505522Snate@binkert.orgfor pysource in py_sources:
8515522Snate@binkert.org    py_sources_tnodes[pysource.tnode] = pysource
8525517Snate@binkert.org
8535522Snate@binkert.orgdef objectifyPyFile(target, source, env):
8545522Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
8555522Snate@binkert.org    it, compress it, and stick it into an asm file so the code appears
8565522Snate@binkert.org    as just bytes with a label in the data section'''
8575517Snate@binkert.org
8585522Snate@binkert.org    src = file(str(source[0]), 'r').read()
8595522Snate@binkert.org    dst = file(str(target[0]), 'w')
8605517Snate@binkert.org
8615522Snate@binkert.org    pysource = py_sources_tnodes[source[0]]
8625604Snate@binkert.org    compiled = compile(src, pysource.debugname, 'exec')
8635522Snate@binkert.org    marshalled = marshal.dumps(compiled)
8645522Snate@binkert.org    compressed = zlib.compress(marshalled)
8655522Snate@binkert.org    data = compressed
8665517Snate@binkert.org
8675522Snate@binkert.org    # Some C/C++ compilers prepend an underscore to global symbol
8685522Snate@binkert.org    # names, so if they're going to do that, we need to prepend that
8695522Snate@binkert.org    # leading underscore to globals in the assembly file.
8705522Snate@binkert.org    if env['LEADING_UNDERSCORE']:
8715522Snate@binkert.org        sym = '_' + pysource.symname
8725522Snate@binkert.org    else:
8735522Snate@binkert.org        sym = pysource.symname
8745522Snate@binkert.org
8755522Snate@binkert.org    step = 16
8765522Snate@binkert.org    print >>dst, ".data"
8775522Snate@binkert.org    print >>dst, ".globl %s_beg" % sym
8785522Snate@binkert.org    print >>dst, ".globl %s_end" % sym
8795522Snate@binkert.org    print >>dst, "%s_beg:" % sym
8805522Snate@binkert.org    for i in xrange(0, len(data), step):
8815522Snate@binkert.org        x = array.array('B', data[i:i+step])
8825522Snate@binkert.org        print >>dst, ".byte", ','.join([str(d) for d in x])
8835522Snate@binkert.org    print >>dst, "%s_end:" % sym
8845522Snate@binkert.org    print >>dst, ".long %d" % len(marshalled)
8855522Snate@binkert.org
8864382Sbinkertn@umich.edufor source in py_sources:
8875522Snate@binkert.org    env.Command(source.assembly, source.tnode, objectifyPyFile)
8885522Snate@binkert.org    Source(source.assembly)
8894382Sbinkertn@umich.edu
8905522Snate@binkert.org# Generate init_python.cc which creates a bunch of EmbeddedPyModule
8915522Snate@binkert.org# structs that describe the embedded python code.  One such struct
8925522Snate@binkert.org# contains information about the importer that python uses to get at
8935522Snate@binkert.org# the embedded files, and then there's a list of all of the rest that
8945522Snate@binkert.org# the importer uses to load the rest on demand.
8955522Snate@binkert.orgpy_sources_symbols = {}
8965522Snate@binkert.orgfor pysource in py_sources:
8975522Snate@binkert.org    py_sources_symbols[pysource.symname] = pysource
8985522Snate@binkert.orgdef pythonInit(target, source, env):
8995522Snate@binkert.org    dst = file(str(target[0]), 'w')
9004382Sbinkertn@umich.edu
9015522Snate@binkert.org    def dump_mod(sym, endchar=','):
9025522Snate@binkert.org        pysource = py_sources_symbols[sym]
9035522Snate@binkert.org        print >>dst, '    { "%s",' % pysource.arcname
9045522Snate@binkert.org        print >>dst, '      "%s",' % pysource.modpath
9055522Snate@binkert.org        print >>dst, '       %s_beg, %s_end,' % (sym, sym)
9065522Snate@binkert.org        print >>dst, '       %s_end - %s_beg,' % (sym, sym)
9075522Snate@binkert.org        print >>dst, '       *(int *)%s_end }%s'  % (sym, endchar)
9085522Snate@binkert.org    
9095522Snate@binkert.org    print >>dst, '#include "sim/init.hh"'
9105522Snate@binkert.org
9115522Snate@binkert.org    for sym in source:
9125522Snate@binkert.org        sym = sym.get_contents()
9135522Snate@binkert.org        print >>dst, "extern const char %s_beg[], %s_end[];" % (sym, sym)
9145522Snate@binkert.org
9155522Snate@binkert.org    print >>dst, "const EmbeddedPyModule embeddedPyImporter = "
9165522Snate@binkert.org    dump_mod("PyEMB_importer", endchar=';');
9175522Snate@binkert.org    print >>dst
9185522Snate@binkert.org
9195522Snate@binkert.org    print >>dst, "const EmbeddedPyModule embeddedPyModules[] = {"
9205522Snate@binkert.org    for i,sym in enumerate(source):
9215522Snate@binkert.org        sym = sym.get_contents()
9225522Snate@binkert.org        if sym == "PyEMB_importer":
9235522Snate@binkert.org            # Skip the importer since we've already exported it
9245522Snate@binkert.org            continue
9255522Snate@binkert.org        dump_mod(sym)
9265522Snate@binkert.org    print >>dst, "    { 0, 0, 0, 0, 0, 0 }"
9275522Snate@binkert.org    print >>dst, "};"
9285522Snate@binkert.org
9295522Snate@binkert.orgsymbols = [Value(s.symname) for s in py_sources]
9305522Snate@binkert.orgenv.Command('sim/init_python.cc', symbols, pythonInit)
9315522Snate@binkert.orgSource('sim/init_python.cc')
9324382Sbinkertn@umich.edu
9334382Sbinkertn@umich.edu########################################################################
9344382Sbinkertn@umich.edu#
9354382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
9364382Sbinkertn@umich.edu# a slightly different build environment.
9374382Sbinkertn@umich.edu#
9384382Sbinkertn@umich.edu
9394382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
9404382Sbinkertn@umich.eduenvList = []
9414382Sbinkertn@umich.edu
942955SN/A# This function adds the specified sources to the given build
943955SN/A# environment, and returns a list of all the corresponding SCons
944955SN/A# Object nodes (including an extra one for date.cc).  We explicitly
945955SN/A# add the Object nodes so we can set up special dependencies for
9461108SN/A# date.cc.
9475601Snate@binkert.orgdef make_objs(sources, env, static):
9485601Snate@binkert.org    if static:
9495601Snate@binkert.org        XObject = env.StaticObject
9505601Snate@binkert.org    else:
9515601Snate@binkert.org        XObject = env.SharedObject
9525601Snate@binkert.org
9535601Snate@binkert.org    objs = [ XObject(s) for s in sources ]
9545456Ssaidi@eecs.umich.edu  
955955SN/A    # make date.cc depend on all other objects so it always gets
956955SN/A    # recompiled whenever anything else does
9575601Snate@binkert.org    date_obj = XObject('base/date.cc')
9585456Ssaidi@eecs.umich.edu
959955SN/A    env.Depends(date_obj, objs)
9605798Snate@binkert.org    objs.append(date_obj)
961955SN/A    return objs
962955SN/A
9632655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
9642655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
9652655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
9662655Sstever@eecs.umich.edu# build environment vars.
9672655Sstever@eecs.umich.edudef makeEnv(label, objsfx, strip = False, **kwargs):
9685601Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
9695601Snate@binkert.org    # name.  Use '_' instead.
9705601Snate@binkert.org    libname = 'm5_' + label
9715601Snate@binkert.org    exename = 'm5.' + label
9725522Snate@binkert.org
9735601Snate@binkert.org    new_env = env.Copy(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
9745601Snate@binkert.org    new_env.Label = label
9755601Snate@binkert.org    new_env.Append(**kwargs)
9765601Snate@binkert.org
9775601Snate@binkert.org    swig_env = new_env.Copy()
9785559Snate@binkert.org    if env['GCC']:
9795559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-uninitialized')
9805559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-sign-compare')
9815559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-parentheses')
9825601Snate@binkert.org
9835601Snate@binkert.org    static_objs = make_objs(cc_lib_sources, new_env, static=True)
9845601Snate@binkert.org    shared_objs = make_objs(cc_lib_sources, new_env, static=False)
9855601Snate@binkert.org    static_objs += [ swig_env.StaticObject(s) for s in cc_swig_sources ]
9865601Snate@binkert.org    shared_objs += [ swig_env.SharedObject(s) for s in cc_swig_sources ]
9875554Snate@binkert.org
9885522Snate@binkert.org    # First make a library of everything but main() so other programs can
9895522Snate@binkert.org    # link against m5.
9905797Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
9915797Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
9925522Snate@binkert.org
9935584Snate@binkert.org    for target, sources in unit_tests:
9945601Snate@binkert.org        objs = [ new_env.StaticObject(s) for s in sources ]
9955601Snate@binkert.org        new_env.Program("unittest/%s.%s" % (target, label), objs + static_lib)
9965584Snate@binkert.org
9975601Snate@binkert.org    # Now link a stub with main() and the static library.
9985601Snate@binkert.org    objects = [new_env.Object(s) for s in cc_bin_sources] + static_lib
9992655Sstever@eecs.umich.edu    if strip:
10005601Snate@binkert.org        unstripped_exe = exename + '.unstripped'
10015601Snate@binkert.org        new_env.Program(unstripped_exe, objects)
10024007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
10034596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
10044007Ssaidi@eecs.umich.edu        else:
10054596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
10065601Snate@binkert.org        targets = new_env.Command(exename, unstripped_exe, cmd)
10075522Snate@binkert.org    else:
10085601Snate@binkert.org        targets = new_env.Program(exename, objects)
10095522Snate@binkert.org            
10105601Snate@binkert.org    new_env.M5Binary = targets[0]
10115601Snate@binkert.org    envList.append(new_env)
10122655Sstever@eecs.umich.edu
1013955SN/A# Debug binary
10143918Ssaidi@eecs.umich.educcflags = {}
10153918Ssaidi@eecs.umich.eduif env['GCC']:
10163918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
10173918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-gstabs+'
10183918Ssaidi@eecs.umich.edu    else:
10193918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-ggdb3'
10203918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O3'
10213918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-O3'
10223918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-O3 -g -pg'
10233918Ssaidi@eecs.umich.eduelif env['SUNCC']:
10243918Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g0'
10253918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
10263918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
10273918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
10283940Ssaidi@eecs.umich.eduelif env['ICC']:
10293940Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g -O0'
10303940Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
10313942Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
10323940Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
10333515Ssaidi@eecs.umich.eduelse:
10343918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
10354762Snate@binkert.org    Exit(1)
10363515Ssaidi@eecs.umich.edu
10372655Sstever@eecs.umich.edumakeEnv('debug', '.do',
10383918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['debug']),
10393619Sbinkertn@umich.edu        CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
1040955SN/A
1041955SN/A# Optimized binary
10422655Sstever@eecs.umich.edumakeEnv('opt', '.o',
10433918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['opt']),
10443619Sbinkertn@umich.edu        CPPDEFINES = ['TRACING_ON=1'])
1045955SN/A
1046955SN/A# "Fast" binary
10472655Sstever@eecs.umich.edumakeEnv('fast', '.fo', strip = True,
10483918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['fast']),
10493619Sbinkertn@umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
1050955SN/A
1051955SN/A# Profiled binary
10522655Sstever@eecs.umich.edumakeEnv('prof', '.po',
10533918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['prof']),
10543683Sstever@eecs.umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
10552655Sstever@eecs.umich.edu        LINKFLAGS = '-pg')
10561869SN/A
10571869SN/AReturn('envList')
1058