SConscript revision 5522
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
395342Sstever@gmail.comfrom os.path import basename, 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_]')
644762Snate@binkert.org    def __init__(self, package, source):
654762Snate@binkert.org        filename = str(source)
664762Snate@binkert.org        pyname = basename(filename)
674762Snate@binkert.org        assert pyname.endswith('.py')
684762Snate@binkert.org        name = pyname[:-3]
695522Snate@binkert.org        if package:
705522Snate@binkert.org            path = package.split('.')
715522Snate@binkert.org        else:
725522Snate@binkert.org            path = []
734762Snate@binkert.org        modpath = path
744762Snate@binkert.org        if name != '__init__':
754762Snate@binkert.org            modpath += [name]
764762Snate@binkert.org        modpath = '.'.join(modpath)
774762Snate@binkert.org
785522Snate@binkert.org        arcpath = path + [ pyname ]
794762Snate@binkert.org        arcname = joinpath(*arcpath)
804762Snate@binkert.org
815522Snate@binkert.org        self.tnode = source
825522Snate@binkert.org        self.snode = source.srcnode()
834762Snate@binkert.org        self.pyname = pyname
844762Snate@binkert.org        self.package = package
854762Snate@binkert.org        self.modpath = modpath
864762Snate@binkert.org        self.arcname = arcname
874762Snate@binkert.org        self.filename = filename
884762Snate@binkert.org        self.compiled = File(filename + 'c')
895522Snate@binkert.org        self.assembly = File(filename + '.s')
905522Snate@binkert.org        self.symname = "PyEMB_" + self.invalid_sym_char.sub('_', modpath)
915522Snate@binkert.org        
924762Snate@binkert.org
934382Sbinkertn@umich.edu########################################################################
944762Snate@binkert.org# Code for adding source files of various types
954382Sbinkertn@umich.edu#
965522Snate@binkert.orgcc_lib_sources = []
974381Sbinkertn@umich.edudef Source(source):
985522Snate@binkert.org    '''Add a source file to the libm5 build'''
994762Snate@binkert.org    if not isinstance(source, SCons.Node.FS.File):
1004762Snate@binkert.org        source = File(source)
1014762Snate@binkert.org
1025522Snate@binkert.org    cc_lib_sources.append(source)
1035522Snate@binkert.org
1045522Snate@binkert.orgcc_bin_sources = []
1055522Snate@binkert.orgdef BinSource(source):
1065522Snate@binkert.org    '''Add a source file to the m5 binary build'''
1075522Snate@binkert.org    if not isinstance(source, SCons.Node.FS.File):
1085522Snate@binkert.org        source = File(source)
1095522Snate@binkert.org
1105522Snate@binkert.org    cc_bin_sources.append(source)
1114762Snate@binkert.org
1124762Snate@binkert.orgpy_sources = []
1134762Snate@binkert.orgdef PySource(package, source):
1144762Snate@binkert.org    '''Add a python source file to the named package'''
1154762Snate@binkert.org    if not isinstance(source, SCons.Node.FS.File):
1164762Snate@binkert.org        source = File(source)
1174762Snate@binkert.org
1184762Snate@binkert.org    source = PySourceFile(package, source)
1194762Snate@binkert.org    py_sources.append(source)
1204762Snate@binkert.org
1214762Snate@binkert.orgsim_objects_fixed = False
1224762Snate@binkert.orgsim_object_modfiles = set()
1234762Snate@binkert.orgdef SimObject(source):
1244762Snate@binkert.org    '''Add a SimObject python file as a python source object and add
1254762Snate@binkert.org    it to a list of sim object modules'''
1264762Snate@binkert.org
1274762Snate@binkert.org    if sim_objects_fixed:
1284762Snate@binkert.org        raise AttributeError, "Too late to call SimObject now."
1294762Snate@binkert.org
1304762Snate@binkert.org    if not isinstance(source, SCons.Node.FS.File):
1314762Snate@binkert.org        source = File(source)
1324762Snate@binkert.org
1334762Snate@binkert.org    PySource('m5.objects', source)
1344762Snate@binkert.org    modfile = basename(str(source))
1354762Snate@binkert.org    assert modfile.endswith('.py')
1364762Snate@binkert.org    modname = modfile[:-3]
1374762Snate@binkert.org    sim_object_modfiles.add(modname)
1384762Snate@binkert.org
1394762Snate@binkert.orgswig_sources = []
1404762Snate@binkert.orgdef SwigSource(package, source):
1414762Snate@binkert.org    '''Add a swig file to build'''
1424762Snate@binkert.org    if not isinstance(source, SCons.Node.FS.File):
1434762Snate@binkert.org        source = File(source)
1444762Snate@binkert.org    val = source,package
1454762Snate@binkert.org    swig_sources.append(val)
146955SN/A
1474382Sbinkertn@umich.edu# Children should have access
1484202Sbinkertn@umich.eduExport('Source')
1495522Snate@binkert.orgExport('BinSource')
1504382Sbinkertn@umich.eduExport('PySource')
1514382Sbinkertn@umich.eduExport('SimObject')
1524382Sbinkertn@umich.eduExport('SwigSource')
1534382Sbinkertn@umich.edu
1544382Sbinkertn@umich.edu########################################################################
1554382Sbinkertn@umich.edu#
1565192Ssaidi@eecs.umich.edu# Trace Flags
1575192Ssaidi@eecs.umich.edu#
1585192Ssaidi@eecs.umich.eduall_flags = {}
1595192Ssaidi@eecs.umich.edutrace_flags = []
1605192Ssaidi@eecs.umich.edudef TraceFlag(name, desc=''):
1615192Ssaidi@eecs.umich.edu    if name in all_flags:
1625192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
1635192Ssaidi@eecs.umich.edu    flag = (name, (), desc)
1645192Ssaidi@eecs.umich.edu    trace_flags.append(flag)
1655192Ssaidi@eecs.umich.edu    all_flags[name] = ()
1665192Ssaidi@eecs.umich.edu
1675192Ssaidi@eecs.umich.edudef CompoundFlag(name, flags, desc=''):
1685192Ssaidi@eecs.umich.edu    if name in all_flags:
1695192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
1705192Ssaidi@eecs.umich.edu
1715192Ssaidi@eecs.umich.edu    compound = tuple(flags)
1725192Ssaidi@eecs.umich.edu    for flag in compound:
1735192Ssaidi@eecs.umich.edu        if flag not in all_flags:
1745192Ssaidi@eecs.umich.edu            raise AttributeError, "Trace flag %s not found" % flag
1755192Ssaidi@eecs.umich.edu        if all_flags[flag]:
1765192Ssaidi@eecs.umich.edu            raise AttributeError, \
1775192Ssaidi@eecs.umich.edu                "Compound flag can't point to another compound flag"
1785192Ssaidi@eecs.umich.edu
1795192Ssaidi@eecs.umich.edu    flag = (name, compound, desc)
1805192Ssaidi@eecs.umich.edu    trace_flags.append(flag)
1815192Ssaidi@eecs.umich.edu    all_flags[name] = compound
1825192Ssaidi@eecs.umich.edu
1835192Ssaidi@eecs.umich.eduExport('TraceFlag')
1845192Ssaidi@eecs.umich.eduExport('CompoundFlag')
1855192Ssaidi@eecs.umich.edu
1865192Ssaidi@eecs.umich.edu########################################################################
1875192Ssaidi@eecs.umich.edu#
1884382Sbinkertn@umich.edu# Set some compiler variables
1894382Sbinkertn@umich.edu#
1904382Sbinkertn@umich.edu
1912667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
1922667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
1932667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
1942667Sstever@eecs.umich.edu# files.
1952667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
1962667Sstever@eecs.umich.edu
1972037SN/A# Add a flag defining what THE_ISA should be for all compilation
1982037SN/Aenv.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
1992037SN/A
2004382Sbinkertn@umich.edu########################################################################
2014762Snate@binkert.org#
2025344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories
2034382Sbinkertn@umich.edu#
2045341Sstever@gmail.com
2055341Sstever@gmail.comfor base_dir in base_dir_list:
2065341Sstever@gmail.com    here = Dir('.').srcnode().abspath
2075344Sstever@gmail.com    for root, dirs, files in os.walk(base_dir, topdown=True):
2085341Sstever@gmail.com        if root == here:
2095341Sstever@gmail.com            # we don't want to recurse back into this SConscript
2105341Sstever@gmail.com            continue
2114762Snate@binkert.org
2125341Sstever@gmail.com        if 'SConscript' in files:
2135344Sstever@gmail.com            build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
2145341Sstever@gmail.com            SConscript(joinpath(root, 'SConscript'), build_dir=build_dir)
2154773Snate@binkert.org
2161858SN/Afor opt in env.ExportOptions:
2171858SN/A    env.ConfigFile(opt)
2181085SN/A
2194382Sbinkertn@umich.edu########################################################################
2204382Sbinkertn@umich.edu#
2214762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
2224762Snate@binkert.org# should all have been added in the SConscripts above
2234762Snate@binkert.org#
2245517Snate@binkert.orgclass DictImporter(object):
2255517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
2265517Snate@binkert.org    map to arbitrary filenames.'''
2275517Snate@binkert.org    def __init__(self, modules):
2285517Snate@binkert.org        self.modules = modules
2295517Snate@binkert.org        self.installed = set()
2305517Snate@binkert.org
2315517Snate@binkert.org    def __del__(self):
2325517Snate@binkert.org        self.unload()
2335517Snate@binkert.org
2345517Snate@binkert.org    def unload(self):
2355517Snate@binkert.org        import sys
2365517Snate@binkert.org        for module in self.installed:
2375517Snate@binkert.org            del sys.modules[module]
2385517Snate@binkert.org        self.installed = set()
2395517Snate@binkert.org
2405517Snate@binkert.org    def find_module(self, fullname, path):
2415517Snate@binkert.org        if fullname == '__scons':
2425517Snate@binkert.org            return self
2435517Snate@binkert.org
2445517Snate@binkert.org        if fullname == 'm5.objects':
2455517Snate@binkert.org            return self
2465517Snate@binkert.org
2475517Snate@binkert.org        if fullname.startswith('m5.internal'):
2485517Snate@binkert.org            return None
2495517Snate@binkert.org
2505517Snate@binkert.org        if fullname in self.modules and exists(self.modules[fullname]):
2515517Snate@binkert.org            return self
2525517Snate@binkert.org
2535517Snate@binkert.org        return None
2545517Snate@binkert.org
2555517Snate@binkert.org    def load_module(self, fullname):
2565517Snate@binkert.org        mod = imp.new_module(fullname)
2575517Snate@binkert.org        sys.modules[fullname] = mod
2585517Snate@binkert.org        self.installed.add(fullname)
2595517Snate@binkert.org
2605517Snate@binkert.org        mod.__loader__ = self
2615517Snate@binkert.org        if fullname == 'm5.objects':
2625517Snate@binkert.org            mod.__path__ = fullname.split('.')
2635517Snate@binkert.org            return mod
2645517Snate@binkert.org
2655517Snate@binkert.org        if fullname == '__scons':
2665517Snate@binkert.org            mod.__dict__['m5_build_env'] = build_env
2675517Snate@binkert.org            return mod
2685517Snate@binkert.org
2695517Snate@binkert.org        srcfile = self.modules[fullname]
2705517Snate@binkert.org        if basename(srcfile) == '__init__.py':
2715517Snate@binkert.org            mod.__path__ = fullname.split('.')
2725517Snate@binkert.org        mod.__file__ = srcfile
2735517Snate@binkert.org
2745517Snate@binkert.org        exec file(srcfile, 'r') in mod.__dict__
2755517Snate@binkert.org
2765517Snate@binkert.org        return mod
2775517Snate@binkert.org
2785517Snate@binkert.orgpy_modules = {}
2795517Snate@binkert.orgfor source in py_sources:
2805522Snate@binkert.org    py_modules[source.modpath] = source.snode.abspath
2815517Snate@binkert.org
2825517Snate@binkert.org# install the python importer so we can grab stuff from the source
2835517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
2845517Snate@binkert.org# else we won't know about them for the rest of the stuff.
2854762Snate@binkert.orgsim_objects_fixed = True
2865517Snate@binkert.orgimporter = DictImporter(py_modules)
2875517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
2884762Snate@binkert.org
2895517Snate@binkert.orgimport m5
2904762Snate@binkert.org
2915517Snate@binkert.org# import all sim objects so we can populate the all_objects list
2925517Snate@binkert.org# make sure that we're working with a list, then let's sort it
2935517Snate@binkert.orgsim_objects = list(sim_object_modfiles)
2945517Snate@binkert.orgsim_objects.sort()
2955517Snate@binkert.orgfor simobj in sim_objects:
2965517Snate@binkert.org    exec('from m5.objects import %s' % simobj)
2975517Snate@binkert.org
2985517Snate@binkert.org# we need to unload all of the currently imported modules so that they
2995517Snate@binkert.org# will be re-imported the next time the sconscript is run
3005517Snate@binkert.orgimporter.unload()
3015517Snate@binkert.orgsys.meta_path.remove(importer)
3025517Snate@binkert.org
3035517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
3045517Snate@binkert.orgall_enums = m5.params.allEnums
3055517Snate@binkert.org
3065517Snate@binkert.orgall_params = {}
3075517Snate@binkert.orgfor name,obj in sim_objects.iteritems():
3085517Snate@binkert.org    for param in obj._params.local.values():
3095517Snate@binkert.org        if not hasattr(param, 'swig_decl'):
3105517Snate@binkert.org            continue
3115517Snate@binkert.org        pname = param.ptype_str
3125517Snate@binkert.org        if pname not in all_params:
3135517Snate@binkert.org            all_params[pname] = param
3144762Snate@binkert.org
3154762Snate@binkert.org########################################################################
3164762Snate@binkert.org#
3174762Snate@binkert.org# calculate extra dependencies
3184762Snate@binkert.org#
3194762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
3205517Snate@binkert.orgdepends = [ File(py_modules[dep]) for dep in module_depends ]
3214762Snate@binkert.org
3224762Snate@binkert.org########################################################################
3234762Snate@binkert.org#
3244762Snate@binkert.org# Commands for the basic automatically generated python files
3254382Sbinkertn@umich.edu#
3264382Sbinkertn@umich.edu
3275517Snate@binkert.org# Generate Python file containing a dict specifying the current
3285517Snate@binkert.org# build_env flags.
3295517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
3305517Snate@binkert.org    f = file(str(target[0]), 'w')
3315517Snate@binkert.org    print >>f, "m5_build_env = ", source[0]
3325517Snate@binkert.org    f.close()
3335517Snate@binkert.org
3345517Snate@binkert.org# Generate python file containing info about the M5 source code
3355517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
3365517Snate@binkert.org    f = file(str(target[0]), 'w')
3375517Snate@binkert.org    for src in source:
3385517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
3395517Snate@binkert.org        print >>f, "%s = %s" % (src, repr(data))
3405517Snate@binkert.org    f.close()
3415517Snate@binkert.org
3425517Snate@binkert.org# Generate the __init__.py file for m5.objects
3435517Snate@binkert.orgdef makeObjectsInitFile(target, source, env):
3445517Snate@binkert.org    f = file(str(target[0]), 'w')
3455517Snate@binkert.org    print >>f, 'from params import *'
3465517Snate@binkert.org    print >>f, 'from m5.SimObject import *'
3475517Snate@binkert.org    for module in source:
3485517Snate@binkert.org        print >>f, 'from %s import *' % module.get_contents()
3495517Snate@binkert.org    f.close()
3505517Snate@binkert.org
3514762Snate@binkert.org# Generate a file with all of the compile options in it
3525517Snate@binkert.orgenv.Command('python/m5/defines.py', Value(build_env), makeDefinesPyFile)
3534382Sbinkertn@umich.eduPySource('m5', 'python/m5/defines.py')
3544382Sbinkertn@umich.edu
3554762Snate@binkert.org# Generate a file that wraps the basic top level files
3564382Sbinkertn@umich.eduenv.Command('python/m5/info.py',
3574382Sbinkertn@umich.edu            [ '#/AUTHORS', '#/LICENSE', '#/README', '#/RELEASE_NOTES' ],
3585517Snate@binkert.org            makeInfoPyFile)
3594382Sbinkertn@umich.eduPySource('m5', 'python/m5/info.py')
3604382Sbinkertn@umich.edu
3614762Snate@binkert.org# Generate an __init__.py file for the objects package
3624382Sbinkertn@umich.eduenv.Command('python/m5/objects/__init__.py',
3634762Snate@binkert.org            [ Value(o) for o in sort_list(sim_object_modfiles) ],
3645517Snate@binkert.org            makeObjectsInitFile)
3654382Sbinkertn@umich.eduPySource('m5.objects', 'python/m5/objects/__init__.py')
3664382Sbinkertn@umich.edu
3674762Snate@binkert.org########################################################################
3684762Snate@binkert.org#
3694762Snate@binkert.org# Create all of the SimObject param headers and enum headers
3704762Snate@binkert.org#
3714762Snate@binkert.org
3725517Snate@binkert.orgdef createSimObjectParam(target, source, env):
3735517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
3745517Snate@binkert.org
3755517Snate@binkert.org    hh_file = file(target[0].abspath, 'w')
3765517Snate@binkert.org    name = str(source[0].get_contents())
3775517Snate@binkert.org    obj = sim_objects[name]
3785517Snate@binkert.org
3795517Snate@binkert.org    print >>hh_file, obj.cxx_decl()
3805517Snate@binkert.org
3815517Snate@binkert.orgdef createSwigParam(target, source, env):
3825517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
3835517Snate@binkert.org
3845517Snate@binkert.org    i_file = file(target[0].abspath, 'w')
3855517Snate@binkert.org    name = str(source[0].get_contents())
3865517Snate@binkert.org    param = all_params[name]
3875517Snate@binkert.org
3885517Snate@binkert.org    for line in param.swig_decl():
3895517Snate@binkert.org        print >>i_file, line
3905517Snate@binkert.org
3915517Snate@binkert.orgdef createEnumStrings(target, source, env):
3925517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
3935517Snate@binkert.org
3945517Snate@binkert.org    cc_file = file(target[0].abspath, 'w')
3955517Snate@binkert.org    name = str(source[0].get_contents())
3965517Snate@binkert.org    obj = all_enums[name]
3975517Snate@binkert.org
3985517Snate@binkert.org    print >>cc_file, obj.cxx_def()
3995517Snate@binkert.org    cc_file.close()
4005517Snate@binkert.org
4015517Snate@binkert.orgdef createEnumParam(target, source, env):
4025517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4035517Snate@binkert.org
4045517Snate@binkert.org    hh_file = file(target[0].abspath, 'w')
4055517Snate@binkert.org    name = str(source[0].get_contents())
4065517Snate@binkert.org    obj = all_enums[name]
4075517Snate@binkert.org
4085517Snate@binkert.org    print >>hh_file, obj.cxx_decl()
4095517Snate@binkert.org
4104762Snate@binkert.org# Generate all of the SimObject param struct header files
4114762Snate@binkert.orgparams_hh_files = []
4125517Snate@binkert.orgfor name,simobj in sim_objects.iteritems():
4135517Snate@binkert.org    extra_deps = [ File(py_modules[simobj.__module__]) ]
4144762Snate@binkert.org
4154762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
4164762Snate@binkert.org    params_hh_files.append(hh_file)
4175517Snate@binkert.org    env.Command(hh_file, Value(name), createSimObjectParam)
4184762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
4194762Snate@binkert.org
4204762Snate@binkert.org# Generate any parameter header files needed
4215463Snate@binkert.orgparams_i_files = []
4225517Snate@binkert.orgfor name,param in all_params.iteritems():
4234762Snate@binkert.org    if isinstance(param, m5.params.VectorParamDesc):
4244762Snate@binkert.org        ext = 'vptype'
4254762Snate@binkert.org    else:
4264762Snate@binkert.org        ext = 'ptype'
4274762Snate@binkert.org
4284762Snate@binkert.org    i_file = File('params/%s_%s.i' % (name, ext))
4295463Snate@binkert.org    params_i_files.append(i_file)
4305517Snate@binkert.org    env.Command(i_file, Value(name), createSwigParam)
4314762Snate@binkert.org    env.Depends(i_file, depends)
4324762Snate@binkert.org
4334762Snate@binkert.org# Generate all enum header files
4345517Snate@binkert.orgfor name,enum in all_enums.iteritems():
4355517Snate@binkert.org    extra_deps = [ File(py_modules[enum.__module__]) ]
4364762Snate@binkert.org
4374762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
4385517Snate@binkert.org    env.Command(cc_file, Value(name), createEnumStrings)
4394762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
4404762Snate@binkert.org    Source(cc_file)
4414762Snate@binkert.org
4424762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
4435517Snate@binkert.org    env.Command(hh_file, Value(name), createEnumParam)
4444762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
4454762Snate@binkert.org
4464762Snate@binkert.org# Build the big monolithic swigged params module (wraps all SimObject
4474762Snate@binkert.org# param structs and enum structs)
4485517Snate@binkert.orgdef buildParams(target, source, env):
4495517Snate@binkert.org    names = [ s.get_contents() for s in source ]
4505517Snate@binkert.org    objs = [ sim_objects[name] for name in names ]
4515517Snate@binkert.org    out = file(target[0].abspath, 'w')
4525517Snate@binkert.org
4535517Snate@binkert.org    ordered_objs = []
4545517Snate@binkert.org    obj_seen = set()
4555517Snate@binkert.org    def order_obj(obj):
4565517Snate@binkert.org        name = str(obj)
4575517Snate@binkert.org        if name in obj_seen:
4585517Snate@binkert.org            return
4595517Snate@binkert.org
4605517Snate@binkert.org        obj_seen.add(name)
4615517Snate@binkert.org        if str(obj) != 'SimObject':
4625517Snate@binkert.org            order_obj(obj.__bases__[0])
4635517Snate@binkert.org
4645517Snate@binkert.org        ordered_objs.append(obj)
4655517Snate@binkert.org
4665517Snate@binkert.org    for obj in objs:
4675517Snate@binkert.org        order_obj(obj)
4685517Snate@binkert.org
4695517Snate@binkert.org    enums = set()
4705517Snate@binkert.org    predecls = []
4715517Snate@binkert.org    pd_seen = set()
4725517Snate@binkert.org
4735517Snate@binkert.org    def add_pds(*pds):
4745517Snate@binkert.org        for pd in pds:
4755517Snate@binkert.org            if pd not in pd_seen:
4765517Snate@binkert.org                predecls.append(pd)
4775517Snate@binkert.org                pd_seen.add(pd)
4785517Snate@binkert.org
4795517Snate@binkert.org    for obj in ordered_objs:
4805517Snate@binkert.org        params = obj._params.local.values()
4815517Snate@binkert.org        for param in params:
4825517Snate@binkert.org            ptype = param.ptype
4835517Snate@binkert.org            if issubclass(ptype, m5.params.Enum):
4845517Snate@binkert.org                if ptype not in enums:
4855517Snate@binkert.org                    enums.add(ptype)
4865517Snate@binkert.org            pds = param.swig_predecls()
4875517Snate@binkert.org            if isinstance(pds, (list, tuple)):
4885517Snate@binkert.org                add_pds(*pds)
4895517Snate@binkert.org            else:
4905517Snate@binkert.org                add_pds(pds)
4915517Snate@binkert.org
4925517Snate@binkert.org    print >>out, '%module params'
4935517Snate@binkert.org
4945517Snate@binkert.org    print >>out, '%{'
4955517Snate@binkert.org    for obj in ordered_objs:
4965517Snate@binkert.org        print >>out, '#include "params/%s.hh"' % obj
4975517Snate@binkert.org    print >>out, '%}'
4985517Snate@binkert.org
4995517Snate@binkert.org    for pd in predecls:
5005517Snate@binkert.org        print >>out, pd
5015517Snate@binkert.org
5025517Snate@binkert.org    enums = list(enums)
5035517Snate@binkert.org    enums.sort()
5045517Snate@binkert.org    for enum in enums:
5055517Snate@binkert.org        print >>out, '%%include "enums/%s.hh"' % enum.__name__
5065517Snate@binkert.org    print >>out
5075517Snate@binkert.org
5085517Snate@binkert.org    for obj in ordered_objs:
5095517Snate@binkert.org        if obj.swig_objdecls:
5105517Snate@binkert.org            for decl in obj.swig_objdecls:
5115517Snate@binkert.org                print >>out, decl
5125517Snate@binkert.org            continue
5135517Snate@binkert.org
5145517Snate@binkert.org        code = ''
5155517Snate@binkert.org        base = obj.get_base()
5165517Snate@binkert.org
5175517Snate@binkert.org        code += '// stop swig from creating/wrapping default ctor/dtor\n'
5185517Snate@binkert.org        code += '%%nodefault %s;\n' % obj.cxx_class
5195517Snate@binkert.org        code += 'class %s ' % obj.cxx_class
5205517Snate@binkert.org        if base:
5215517Snate@binkert.org            code += ': public %s' % base
5225517Snate@binkert.org        code += ' {};\n'
5235517Snate@binkert.org
5245517Snate@binkert.org        klass = obj.cxx_class;
5255517Snate@binkert.org        if hasattr(obj, 'cxx_namespace'):
5265517Snate@binkert.org            new_code = 'namespace %s {\n' % obj.cxx_namespace
5275517Snate@binkert.org            new_code += code
5285517Snate@binkert.org            new_code += '}\n'
5295517Snate@binkert.org            code = new_code
5305517Snate@binkert.org            klass = '%s::%s' % (obj.cxx_namespace, klass)
5315517Snate@binkert.org
5325517Snate@binkert.org        print >>out, code
5335517Snate@binkert.org
5345517Snate@binkert.org    print >>out, '%%include "src/sim/sim_object_params.hh"' % obj
5355517Snate@binkert.org    for obj in ordered_objs:
5365517Snate@binkert.org        print >>out, '%%include "params/%s.hh"' % obj
5375517Snate@binkert.org
5384762Snate@binkert.orgparams_file = File('params/params.i')
5395517Snate@binkert.orgnames = sort_list(sim_objects.keys())
5405517Snate@binkert.orgenv.Command(params_file, [ Value(v) for v in names ], buildParams)
5415463Snate@binkert.orgenv.Depends(params_file, params_hh_files + params_i_files + depends)
5424762Snate@binkert.orgSwigSource('m5.objects', params_file)
5434762Snate@binkert.org
5444762Snate@binkert.org# Build all swig modules
5454382Sbinkertn@umich.eduswig_modules = []
5464762Snate@binkert.orgfor source,package in swig_sources:
5474382Sbinkertn@umich.edu    filename = str(source)
5484762Snate@binkert.org    assert filename.endswith('.i')
5494382Sbinkertn@umich.edu
5504762Snate@binkert.org    base = '.'.join(filename.split('.')[:-1])
5514762Snate@binkert.org    module = basename(base)
5524762Snate@binkert.org    cc_file = base + '_wrap.cc'
5534762Snate@binkert.org    py_file = base + '.py'
5544382Sbinkertn@umich.edu
5554382Sbinkertn@umich.edu    env.Command([cc_file, py_file], source,
5564382Sbinkertn@umich.edu                '$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
5574382Sbinkertn@umich.edu                '-o ${TARGETS[0]} $SOURCES')
5584382Sbinkertn@umich.edu    env.Depends(py_file, source)
5594382Sbinkertn@umich.edu    env.Depends(cc_file, source)
5604762Snate@binkert.org
5614382Sbinkertn@umich.edu    swig_modules.append(Value(module))
5624382Sbinkertn@umich.edu    Source(cc_file)
5634382Sbinkertn@umich.edu    PySource(package, py_file)
5644382Sbinkertn@umich.edu
5654762Snate@binkert.org# Generate the main swig init file
5665517Snate@binkert.orgdef makeSwigInit(target, source, env):
5675517Snate@binkert.org    f = file(str(target[0]), 'w')
5685517Snate@binkert.org    print >>f, 'extern "C" {'
5695517Snate@binkert.org    for module in source:
5705517Snate@binkert.org        print >>f, '    void init_%s();' % module.get_contents()
5715517Snate@binkert.org    print >>f, '}'
5725522Snate@binkert.org    print >>f, 'void initSwig() {'
5735517Snate@binkert.org    for module in source:
5745517Snate@binkert.org        print >>f, '    init_%s();' % module.get_contents()
5755517Snate@binkert.org    print >>f, '}'
5765517Snate@binkert.org    f.close()
5775517Snate@binkert.org
5785522Snate@binkert.orgenv.Command('python/swig/init.cc', swig_modules, makeSwigInit)
5795522Snate@binkert.orgSource('python/swig/init.cc')
5804382Sbinkertn@umich.edu
5815192Ssaidi@eecs.umich.edu# Generate traceflags.py
5825517Snate@binkert.orgdef traceFlagsPy(target, source, env):
5835517Snate@binkert.org    assert(len(target) == 1)
5845517Snate@binkert.org
5855517Snate@binkert.org    f = file(str(target[0]), 'w')
5865517Snate@binkert.org
5875517Snate@binkert.org    allFlags = []
5885517Snate@binkert.org    for s in source:
5895517Snate@binkert.org        val = eval(s.get_contents())
5905517Snate@binkert.org        allFlags.append(val)
5915517Snate@binkert.org
5925517Snate@binkert.org    print >>f, 'baseFlags = ['
5935517Snate@binkert.org    for flag, compound, desc in allFlags:
5945517Snate@binkert.org        if not compound:
5955517Snate@binkert.org            print >>f, "    '%s'," % flag
5965517Snate@binkert.org    print >>f, "    ]"
5975517Snate@binkert.org    print >>f
5985517Snate@binkert.org
5995517Snate@binkert.org    print >>f, 'compoundFlags = ['
6005517Snate@binkert.org    print >>f, "    'All',"
6015517Snate@binkert.org    for flag, compound, desc in allFlags:
6025517Snate@binkert.org        if compound:
6035517Snate@binkert.org            print >>f, "    '%s'," % flag
6045517Snate@binkert.org    print >>f, "    ]"
6055517Snate@binkert.org    print >>f
6065517Snate@binkert.org
6075517Snate@binkert.org    print >>f, "allFlags = frozenset(baseFlags + compoundFlags)"
6085517Snate@binkert.org    print >>f
6095517Snate@binkert.org
6105517Snate@binkert.org    print >>f, 'compoundFlagMap = {'
6115517Snate@binkert.org    all = tuple([flag for flag,compound,desc in allFlags if not compound])
6125517Snate@binkert.org    print >>f, "    'All' : %s," % (all, )
6135517Snate@binkert.org    for flag, compound, desc in allFlags:
6145517Snate@binkert.org        if compound:
6155517Snate@binkert.org            print >>f, "    '%s' : %s," % (flag, compound)
6165517Snate@binkert.org    print >>f, "    }"
6175517Snate@binkert.org    print >>f
6185517Snate@binkert.org
6195517Snate@binkert.org    print >>f, 'flagDescriptions = {'
6205517Snate@binkert.org    print >>f, "    'All' : 'All flags',"
6215517Snate@binkert.org    for flag, compound, desc in allFlags:
6225517Snate@binkert.org        print >>f, "    '%s' : '%s'," % (flag, desc)
6235517Snate@binkert.org    print >>f, "    }"
6245517Snate@binkert.org
6255517Snate@binkert.org    f.close()
6265517Snate@binkert.org
6275517Snate@binkert.orgdef traceFlagsCC(target, source, env):
6285517Snate@binkert.org    assert(len(target) == 1)
6295517Snate@binkert.org
6305517Snate@binkert.org    f = file(str(target[0]), 'w')
6315517Snate@binkert.org
6325517Snate@binkert.org    allFlags = []
6335517Snate@binkert.org    for s in source:
6345517Snate@binkert.org        val = eval(s.get_contents())
6355517Snate@binkert.org        allFlags.append(val)
6365517Snate@binkert.org
6375517Snate@binkert.org    # file header
6385517Snate@binkert.org    print >>f, '''
6395517Snate@binkert.org/*
6405517Snate@binkert.org * DO NOT EDIT THIS FILE! Automatically generated
6415517Snate@binkert.org */
6425517Snate@binkert.org
6435517Snate@binkert.org#include "base/traceflags.hh"
6445517Snate@binkert.org
6455517Snate@binkert.orgusing namespace Trace;
6465517Snate@binkert.org
6475517Snate@binkert.orgconst char *Trace::flagStrings[] =
6485517Snate@binkert.org{'''
6495517Snate@binkert.org
6505517Snate@binkert.org    # The string array is used by SimpleEnumParam to map the strings
6515517Snate@binkert.org    # provided by the user to enum values.
6525517Snate@binkert.org    for flag, compound, desc in allFlags:
6535517Snate@binkert.org        if not compound:
6545517Snate@binkert.org            print >>f, '    "%s",' % flag
6555517Snate@binkert.org
6565517Snate@binkert.org    print >>f, '    "All",'
6575517Snate@binkert.org    for flag, compound, desc in allFlags:
6585517Snate@binkert.org        if compound:
6595517Snate@binkert.org            print >>f, '    "%s",' % flag
6605517Snate@binkert.org
6615517Snate@binkert.org    print >>f, '};'
6625517Snate@binkert.org    print >>f
6635517Snate@binkert.org    print >>f, 'const int Trace::numFlagStrings = %d;' % (len(allFlags) + 1)
6645517Snate@binkert.org    print >>f
6655517Snate@binkert.org
6665517Snate@binkert.org    #
6675517Snate@binkert.org    # Now define the individual compound flag arrays.  There is an array
6685517Snate@binkert.org    # for each compound flag listing the component base flags.
6695517Snate@binkert.org    #
6705517Snate@binkert.org    all = tuple([flag for flag,compound,desc in allFlags if not compound])
6715517Snate@binkert.org    print >>f, 'static const Flags AllMap[] = {'
6725517Snate@binkert.org    for flag, compound, desc in allFlags:
6735517Snate@binkert.org        if not compound:
6745517Snate@binkert.org            print >>f, "    %s," % flag
6755517Snate@binkert.org    print >>f, '};'
6765517Snate@binkert.org    print >>f
6775517Snate@binkert.org
6785517Snate@binkert.org    for flag, compound, desc in allFlags:
6795517Snate@binkert.org        if not compound:
6805517Snate@binkert.org            continue
6815517Snate@binkert.org        print >>f, 'static const Flags %sMap[] = {' % flag
6825517Snate@binkert.org        for flag in compound:
6835517Snate@binkert.org            print >>f, "    %s," % flag
6845517Snate@binkert.org        print >>f, "    (Flags)-1"
6855517Snate@binkert.org        print >>f, '};'
6865517Snate@binkert.org        print >>f
6875517Snate@binkert.org
6885517Snate@binkert.org    #
6895517Snate@binkert.org    # Finally the compoundFlags[] array maps the compound flags
6905517Snate@binkert.org    # to their individual arrays/
6915517Snate@binkert.org    #
6925517Snate@binkert.org    print >>f, 'const Flags *Trace::compoundFlags[] ='
6935517Snate@binkert.org    print >>f, '{'
6945517Snate@binkert.org    print >>f, '    AllMap,'
6955517Snate@binkert.org    for flag, compound, desc in allFlags:
6965517Snate@binkert.org        if compound:
6975517Snate@binkert.org            print >>f, '    %sMap,' % flag
6985517Snate@binkert.org    # file trailer
6995517Snate@binkert.org    print >>f, '};'
7005517Snate@binkert.org
7015517Snate@binkert.org    f.close()
7025517Snate@binkert.org
7035517Snate@binkert.orgdef traceFlagsHH(target, source, env):
7045517Snate@binkert.org    assert(len(target) == 1)
7055517Snate@binkert.org
7065517Snate@binkert.org    f = file(str(target[0]), 'w')
7075517Snate@binkert.org
7085517Snate@binkert.org    allFlags = []
7095517Snate@binkert.org    for s in source:
7105517Snate@binkert.org        val = eval(s.get_contents())
7115517Snate@binkert.org        allFlags.append(val)
7125517Snate@binkert.org
7135517Snate@binkert.org    # file header boilerplate
7145517Snate@binkert.org    print >>f, '''
7155517Snate@binkert.org/*
7165517Snate@binkert.org * DO NOT EDIT THIS FILE!
7175517Snate@binkert.org *
7185517Snate@binkert.org * Automatically generated from traceflags.py
7195517Snate@binkert.org */
7205517Snate@binkert.org
7215517Snate@binkert.org#ifndef __BASE_TRACE_FLAGS_HH__
7225517Snate@binkert.org#define __BASE_TRACE_FLAGS_HH__
7235517Snate@binkert.org
7245517Snate@binkert.orgnamespace Trace {
7255517Snate@binkert.org
7265517Snate@binkert.orgenum Flags {'''
7275517Snate@binkert.org
7285517Snate@binkert.org    # Generate the enum.  Base flags come first, then compound flags.
7295517Snate@binkert.org    idx = 0
7305517Snate@binkert.org    for flag, compound, desc in allFlags:
7315517Snate@binkert.org        if not compound:
7325517Snate@binkert.org            print >>f, '    %s = %d,' % (flag, idx)
7335517Snate@binkert.org            idx += 1
7345517Snate@binkert.org
7355517Snate@binkert.org    numBaseFlags = idx
7365517Snate@binkert.org    print >>f, '    NumFlags = %d,' % idx
7375517Snate@binkert.org
7385517Snate@binkert.org    # put a comment in here to separate base from compound flags
7395517Snate@binkert.org    print >>f, '''
7405517Snate@binkert.org// The remaining enum values are *not* valid indices for Trace::flags.
7415517Snate@binkert.org// They are "compound" flags, which correspond to sets of base
7425517Snate@binkert.org// flags, and are used by changeFlag.'''
7435517Snate@binkert.org
7445517Snate@binkert.org    print >>f, '    All = %d,' % idx
7455517Snate@binkert.org    idx += 1
7465517Snate@binkert.org    for flag, compound, desc in allFlags:
7475517Snate@binkert.org        if compound:
7485517Snate@binkert.org            print >>f, '    %s = %d,' % (flag, idx)
7495517Snate@binkert.org            idx += 1
7505517Snate@binkert.org
7515517Snate@binkert.org    numCompoundFlags = idx - numBaseFlags
7525517Snate@binkert.org    print >>f, '    NumCompoundFlags = %d' % numCompoundFlags
7535517Snate@binkert.org
7545517Snate@binkert.org    # trailer boilerplate
7555517Snate@binkert.org    print >>f, '''\
7565517Snate@binkert.org}; // enum Flags
7575517Snate@binkert.org
7585517Snate@binkert.org// Array of strings for SimpleEnumParam
7595517Snate@binkert.orgextern const char *flagStrings[];
7605517Snate@binkert.orgextern const int numFlagStrings;
7615517Snate@binkert.org
7625517Snate@binkert.org// Array of arraay pointers: for each compound flag, gives the list of
7635517Snate@binkert.org// base flags to set.  Inidividual flag arrays are terminated by -1.
7645517Snate@binkert.orgextern const Flags *compoundFlags[];
7655517Snate@binkert.org
7665517Snate@binkert.org/* namespace Trace */ }
7675517Snate@binkert.org
7685517Snate@binkert.org#endif // __BASE_TRACE_FLAGS_HH__
7695517Snate@binkert.org'''
7705517Snate@binkert.org
7715517Snate@binkert.org    f.close()
7725517Snate@binkert.org
7735192Ssaidi@eecs.umich.eduflags = [ Value(f) for f in trace_flags ]
7745517Snate@binkert.orgenv.Command('base/traceflags.py', flags, traceFlagsPy)
7755192Ssaidi@eecs.umich.eduPySource('m5', 'base/traceflags.py')
7765192Ssaidi@eecs.umich.edu
7775517Snate@binkert.orgenv.Command('base/traceflags.hh', flags, traceFlagsHH)
7785517Snate@binkert.orgenv.Command('base/traceflags.cc', flags, traceFlagsCC)
7795192Ssaidi@eecs.umich.eduSource('base/traceflags.cc')
7805192Ssaidi@eecs.umich.edu
7815456Ssaidi@eecs.umich.edu# Generate program_info.cc
7825517Snate@binkert.orgdef programInfo(target, source, env):
7835517Snate@binkert.org    def gen_file(target, rev, node, date):
7845517Snate@binkert.org        pi_stats = file(target, 'w')
7855517Snate@binkert.org        print >>pi_stats, 'const char *hgRev = "%s:%s";' %  (rev, node)
7865517Snate@binkert.org        print >>pi_stats, 'const char *hgDate = "%s";' % date
7875517Snate@binkert.org        pi_stats.close()
7885517Snate@binkert.org
7895517Snate@binkert.org    target = str(target[0])
7905517Snate@binkert.org    scons_dir = str(source[0].get_contents())
7915517Snate@binkert.org    try:
7925517Snate@binkert.org        import mercurial.demandimport, mercurial.hg, mercurial.ui
7935517Snate@binkert.org        import mercurial.util, mercurial.node
7945517Snate@binkert.org        if not exists(scons_dir) or not isdir(scons_dir) or \
7955517Snate@binkert.org               not exists(joinpath(scons_dir, ".hg")):
7965517Snate@binkert.org            raise ValueError
7975517Snate@binkert.org        repo = mercurial.hg.repository(mercurial.ui.ui(), scons_dir)
7985517Snate@binkert.org        rev = mercurial.node.nullrev + repo.changelog.count()
7995517Snate@binkert.org        changenode = repo.changelog.node(rev)
8005517Snate@binkert.org        changes = repo.changelog.read(changenode)
8015517Snate@binkert.org        date = mercurial.util.datestr(changes[2])
8025517Snate@binkert.org
8035517Snate@binkert.org        gen_file(target, rev, mercurial.node.hex(changenode), date)
8045517Snate@binkert.org
8055517Snate@binkert.org        mercurial.demandimport.disable()
8065517Snate@binkert.org    except ImportError:
8075517Snate@binkert.org        gen_file(target, "Unknown", "Unknown", "Unknown")
8085517Snate@binkert.org
8095517Snate@binkert.org    except:
8105517Snate@binkert.org        print "in except"
8115517Snate@binkert.org        gen_file(target, "Unknown", "Unknown", "Unknown")
8125517Snate@binkert.org        mercurial.demandimport.disable()
8135517Snate@binkert.org
8145456Ssaidi@eecs.umich.eduenv.Command('base/program_info.cc',
8155461Snate@binkert.org            Value(str(SCons.Node.FS.default_fs.SConstruct_dir)),
8165517Snate@binkert.org            programInfo)
8175456Ssaidi@eecs.umich.edu
8185522Snate@binkert.org# embed python files.  All .py files that have been indicated by a
8195522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
8205522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
8215522Snate@binkert.org# byte code, compress it, and then generate an assembly file that
8225522Snate@binkert.org# inserts the result into the data section with symbols indicating the
8235522Snate@binkert.org# beginning, and end (and with the size at the end)
8245522Snate@binkert.orgpy_sources_tnodes = {}
8255522Snate@binkert.orgfor pysource in py_sources:
8265522Snate@binkert.org    py_sources_tnodes[pysource.tnode] = pysource
8275517Snate@binkert.org
8285522Snate@binkert.orgdef objectifyPyFile(target, source, env):
8295522Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
8305522Snate@binkert.org    it, compress it, and stick it into an asm file so the code appears
8315522Snate@binkert.org    as just bytes with a label in the data section'''
8325517Snate@binkert.org
8335522Snate@binkert.org    src = file(str(source[0]), 'r').read()
8345522Snate@binkert.org    dst = file(str(target[0]), 'w')
8355517Snate@binkert.org
8365522Snate@binkert.org    pysource = py_sources_tnodes[source[0]]
8375522Snate@binkert.org    compiled = compile(src, pysource.snode.path, 'exec')
8385522Snate@binkert.org    marshalled = marshal.dumps(compiled)
8395522Snate@binkert.org    compressed = zlib.compress(marshalled)
8405522Snate@binkert.org    data = compressed
8415517Snate@binkert.org
8425522Snate@binkert.org    # Some C/C++ compilers prepend an underscore to global symbol
8435522Snate@binkert.org    # names, so if they're going to do that, we need to prepend that
8445522Snate@binkert.org    # leading underscore to globals in the assembly file.
8455522Snate@binkert.org    if env['LEADING_UNDERSCORE']:
8465522Snate@binkert.org        sym = '_' + pysource.symname
8475522Snate@binkert.org    else:
8485522Snate@binkert.org        sym = pysource.symname
8495522Snate@binkert.org
8505522Snate@binkert.org    step = 16
8515522Snate@binkert.org    print >>dst, ".data"
8525522Snate@binkert.org    print >>dst, ".globl %s_beg" % sym
8535522Snate@binkert.org    print >>dst, ".globl %s_end" % sym
8545522Snate@binkert.org    print >>dst, "%s_beg:" % sym
8555522Snate@binkert.org    for i in xrange(0, len(data), step):
8565522Snate@binkert.org        x = array.array('B', data[i:i+step])
8575522Snate@binkert.org        print >>dst, ".byte", ','.join([str(d) for d in x])
8585522Snate@binkert.org    print >>dst, "%s_end:" % sym
8595522Snate@binkert.org    print >>dst, ".long %d" % len(marshalled)
8605522Snate@binkert.org
8614382Sbinkertn@umich.edufor source in py_sources:
8625522Snate@binkert.org    env.Command(source.assembly, source.tnode, objectifyPyFile)
8635522Snate@binkert.org    Source(source.assembly)
8644382Sbinkertn@umich.edu
8655522Snate@binkert.org# Generate init_python.cc which creates a bunch of EmbeddedPyModule
8665522Snate@binkert.org# structs that describe the embedded python code.  One such struct
8675522Snate@binkert.org# contains information about the importer that python uses to get at
8685522Snate@binkert.org# the embedded files, and then there's a list of all of the rest that
8695522Snate@binkert.org# the importer uses to load the rest on demand.
8705522Snate@binkert.orgpy_sources_symbols = {}
8715522Snate@binkert.orgfor pysource in py_sources:
8725522Snate@binkert.org    py_sources_symbols[pysource.symname] = pysource
8735522Snate@binkert.orgdef pythonInit(target, source, env):
8745522Snate@binkert.org    dst = file(str(target[0]), 'w')
8754382Sbinkertn@umich.edu
8765522Snate@binkert.org    def dump_mod(sym, endchar=','):
8775522Snate@binkert.org        pysource = py_sources_symbols[sym]
8785522Snate@binkert.org        print >>dst, '    { "%s",' % pysource.arcname
8795522Snate@binkert.org        print >>dst, '      "%s",' % pysource.modpath
8805522Snate@binkert.org        print >>dst, '       %s_beg, %s_end,' % (sym, sym)
8815522Snate@binkert.org        print >>dst, '       %s_end - %s_beg,' % (sym, sym)
8825522Snate@binkert.org        print >>dst, '       *(int *)%s_end }%s'  % (sym, endchar)
8835522Snate@binkert.org    
8845522Snate@binkert.org    print >>dst, '#include "sim/init.hh"'
8855522Snate@binkert.org
8865522Snate@binkert.org    for sym in source:
8875522Snate@binkert.org        sym = sym.get_contents()
8885522Snate@binkert.org        print >>dst, "extern const char %s_beg[], %s_end[];" % (sym, sym)
8895522Snate@binkert.org
8905522Snate@binkert.org    print >>dst, "const EmbeddedPyModule embeddedPyImporter = "
8915522Snate@binkert.org    dump_mod("PyEMB_importer", endchar=';');
8925522Snate@binkert.org    print >>dst
8935522Snate@binkert.org
8945522Snate@binkert.org    print >>dst, "const EmbeddedPyModule embeddedPyModules[] = {"
8955522Snate@binkert.org    for i,sym in enumerate(source):
8965522Snate@binkert.org        sym = sym.get_contents()
8975522Snate@binkert.org        if sym == "PyEMB_importer":
8985522Snate@binkert.org            # Skip the importer since we've already exported it
8995522Snate@binkert.org            continue
9005522Snate@binkert.org        dump_mod(sym)
9015522Snate@binkert.org    print >>dst, "    { 0, 0, 0, 0, 0, 0 }"
9025522Snate@binkert.org    print >>dst, "};"
9035522Snate@binkert.org
9045522Snate@binkert.orgsymbols = [Value(s.symname) for s in py_sources]
9055522Snate@binkert.orgenv.Command('sim/init_python.cc', symbols, pythonInit)
9065522Snate@binkert.orgSource('sim/init_python.cc')
9074382Sbinkertn@umich.edu
9084382Sbinkertn@umich.edu########################################################################
9094382Sbinkertn@umich.edu#
9104382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
9114382Sbinkertn@umich.edu# a slightly different build environment.
9124382Sbinkertn@umich.edu#
9134382Sbinkertn@umich.edu
9144382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
9154382Sbinkertn@umich.eduenvList = []
9164382Sbinkertn@umich.edu
917955SN/A# This function adds the specified sources to the given build
918955SN/A# environment, and returns a list of all the corresponding SCons
919955SN/A# Object nodes (including an extra one for date.cc).  We explicitly
920955SN/A# add the Object nodes so we can set up special dependencies for
9211108SN/A# date.cc.
922955SN/Adef make_objs(sources, env):
923955SN/A    objs = [env.Object(s) for s in sources]
9245456Ssaidi@eecs.umich.edu  
925955SN/A    # make date.cc depend on all other objects so it always gets
926955SN/A    # recompiled whenever anything else does
927955SN/A    date_obj = env.Object('base/date.cc')
9285456Ssaidi@eecs.umich.edu
9295456Ssaidi@eecs.umich.edu    # Make the generation of program_info.cc dependend on all 
9305456Ssaidi@eecs.umich.edu    # the other cc files and the compiling of program_info.cc 
9315456Ssaidi@eecs.umich.edu    # dependent on all the objects but program_info.o 
9325456Ssaidi@eecs.umich.edu    pinfo_obj = env.Object('base/program_info.cc')
9335456Ssaidi@eecs.umich.edu    env.Depends('base/program_info.cc', sources)
934955SN/A    env.Depends(date_obj, objs)
9355456Ssaidi@eecs.umich.edu    env.Depends(pinfo_obj, objs)
9365456Ssaidi@eecs.umich.edu    objs.extend([date_obj,pinfo_obj])
937955SN/A    return objs
938955SN/A
9392655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
9402655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
9412655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
9422655Sstever@eecs.umich.edu# build environment vars.
9432655Sstever@eecs.umich.edudef makeEnv(label, objsfx, strip = False, **kwargs):
9442655Sstever@eecs.umich.edu    newEnv = env.Copy(OBJSUFFIX=objsfx)
9452655Sstever@eecs.umich.edu    newEnv.Label = label
9462655Sstever@eecs.umich.edu    newEnv.Append(**kwargs)
9475522Snate@binkert.org
9485522Snate@binkert.org    # First make a library of everything but main() so other programs can
9495522Snate@binkert.org    # link against m5.
9505522Snate@binkert.org    #
9515522Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
9525522Snate@binkert.org    # name.  Use '_' instead.
9535522Snate@binkert.org    m5lib = newEnv.Library('m5_' + label, make_objs(cc_lib_sources, newEnv))
9545522Snate@binkert.org
9555522Snate@binkert.org    # Now link a stub with main() and the library.
9562655Sstever@eecs.umich.edu    exe = 'm5.' + label  # final executable
9575522Snate@binkert.org    objects = [newEnv.Object(s) for s in cc_bin_sources] + m5lib
9582655Sstever@eecs.umich.edu    if strip:
9595522Snate@binkert.org        unstripped_exe = exe + '.unstripped'
9605522Snate@binkert.org        newEnv.Program(unstripped_exe, objects)
9614007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
9624596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
9634007Ssaidi@eecs.umich.edu        else:
9644596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
9655522Snate@binkert.org        targets = newEnv.Command(exe, unstripped_exe, cmd)
9665522Snate@binkert.org    else:
9675522Snate@binkert.org        targets = newEnv.Program(exe, objects)
9685522Snate@binkert.org            
9692655Sstever@eecs.umich.edu    newEnv.M5Binary = targets[0]
9702655Sstever@eecs.umich.edu    envList.append(newEnv)
9712655Sstever@eecs.umich.edu
972955SN/A# Debug binary
9733918Ssaidi@eecs.umich.educcflags = {}
9743918Ssaidi@eecs.umich.eduif env['GCC']:
9753918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
9763918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-gstabs+'
9773918Ssaidi@eecs.umich.edu    else:
9783918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-ggdb3'
9793918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O3'
9803918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-O3'
9813918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-O3 -g -pg'
9823918Ssaidi@eecs.umich.eduelif env['SUNCC']:
9833918Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g0'
9843918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
9853918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
9863918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
9873940Ssaidi@eecs.umich.eduelif env['ICC']:
9883940Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g -O0'
9893940Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
9903942Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
9913940Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
9923515Ssaidi@eecs.umich.eduelse:
9933918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
9944762Snate@binkert.org    Exit(1)
9953515Ssaidi@eecs.umich.edu
9962655Sstever@eecs.umich.edumakeEnv('debug', '.do',
9973918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['debug']),
9983619Sbinkertn@umich.edu        CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
999955SN/A
1000955SN/A# Optimized binary
10012655Sstever@eecs.umich.edumakeEnv('opt', '.o',
10023918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['opt']),
10033619Sbinkertn@umich.edu        CPPDEFINES = ['TRACING_ON=1'])
1004955SN/A
1005955SN/A# "Fast" binary
10062655Sstever@eecs.umich.edumakeEnv('fast', '.fo', strip = True,
10073918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['fast']),
10083619Sbinkertn@umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
1009955SN/A
1010955SN/A# Profiled binary
10112655Sstever@eecs.umich.edumakeEnv('prof', '.po',
10123918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['prof']),
10133683Sstever@eecs.umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
10142655Sstever@eecs.umich.edu        LINKFLAGS = '-pg')
10151869SN/A
10161869SN/AReturn('envList')
1017