SConscript revision 7722
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
326143Snate@binkert.orgimport bisect
334762Snate@binkert.orgimport imp
345522Snate@binkert.orgimport marshal
35955SN/Aimport os
365522Snate@binkert.orgimport re
37955SN/Aimport sys
385522Snate@binkert.orgimport zlib
394202Sbinkertn@umich.edu
405742Snate@binkert.orgfrom os.path import basename, dirname, exists, isdir, isfile, join as joinpath
41955SN/A
424381Sbinkertn@umich.eduimport SCons
434381Sbinkertn@umich.edu
44955SN/A# This file defines how to build a particular configuration of M5
45955SN/A# based on variable settings in the 'env' build environment.
46955SN/A
474202Sbinkertn@umich.eduImport('*')
48955SN/A
494382Sbinkertn@umich.edu# Children need to see the environment
504382Sbinkertn@umich.eduExport('env')
514382Sbinkertn@umich.edu
526654Snate@binkert.orgbuild_env = [(opt, env[opt]) for opt in export_vars]
535517Snate@binkert.org
546143Snate@binkert.orgfrom m5.util import code_formatter
556143Snate@binkert.org
566143Snate@binkert.org########################################################################
576143Snate@binkert.org# Code for adding source files of various types
586143Snate@binkert.org#
596143Snate@binkert.orgclass SourceMeta(type):
606143Snate@binkert.org    def __init__(cls, name, bases, dict):
616143Snate@binkert.org        super(SourceMeta, cls).__init__(name, bases, dict)
626143Snate@binkert.org        cls.all = []
636143Snate@binkert.org        
646143Snate@binkert.org    def get(cls, **kwargs):
656143Snate@binkert.org        for src in cls.all:
666143Snate@binkert.org            for attr,value in kwargs.iteritems():
676143Snate@binkert.org                if getattr(src, attr) != value:
686143Snate@binkert.org                    break
694762Snate@binkert.org            else:
706143Snate@binkert.org                yield src
716143Snate@binkert.org
726143Snate@binkert.orgclass SourceFile(object):
736143Snate@binkert.org    __metaclass__ = SourceMeta
746143Snate@binkert.org    def __init__(self, source):
756143Snate@binkert.org        tnode = source
766143Snate@binkert.org        if not isinstance(source, SCons.Node.FS.File):
776143Snate@binkert.org            tnode = File(source)
786143Snate@binkert.org
796143Snate@binkert.org        self.tnode = tnode
806143Snate@binkert.org        self.snode = tnode.srcnode()
816143Snate@binkert.org        self.filename = str(tnode)
826143Snate@binkert.org        self.dirname = dirname(self.filename)
836143Snate@binkert.org        self.basename = basename(self.filename)
846143Snate@binkert.org        index = self.basename.rfind('.')
856143Snate@binkert.org        if index <= 0:
866143Snate@binkert.org            # dot files aren't extensions
876143Snate@binkert.org            self.extname = self.basename, None
886143Snate@binkert.org        else:
896143Snate@binkert.org            self.extname = self.basename[:index], self.basename[index+1:]
906143Snate@binkert.org
916143Snate@binkert.org        for base in type(self).__mro__:
926143Snate@binkert.org            if issubclass(base, SourceFile):
936143Snate@binkert.org                base.all.append(self)
946143Snate@binkert.org
956143Snate@binkert.org    def __lt__(self, other): return self.filename < other.filename
966143Snate@binkert.org    def __le__(self, other): return self.filename <= other.filename
976143Snate@binkert.org    def __gt__(self, other): return self.filename > other.filename
986143Snate@binkert.org    def __ge__(self, other): return self.filename >= other.filename
996143Snate@binkert.org    def __eq__(self, other): return self.filename == other.filename
1006143Snate@binkert.org    def __ne__(self, other): return self.filename != other.filename
1016143Snate@binkert.org        
1026143Snate@binkert.orgclass Source(SourceFile):
1036143Snate@binkert.org    '''Add a c/c++ source file to the build'''
1046143Snate@binkert.org    def __init__(self, source, Werror=True, swig=False, bin_only=False,
1056143Snate@binkert.org                 skip_lib=False):
1066143Snate@binkert.org        super(Source, self).__init__(source)
1076143Snate@binkert.org
1086143Snate@binkert.org        self.Werror = Werror
1096143Snate@binkert.org        self.swig = swig
1106143Snate@binkert.org        self.bin_only = bin_only
1116143Snate@binkert.org        self.skip_lib = bin_only or skip_lib
1126143Snate@binkert.org
1135522Snate@binkert.orgclass PySource(SourceFile):
1146143Snate@binkert.org    '''Add a python source file to the named package'''
1156143Snate@binkert.org    invalid_sym_char = re.compile('[^A-z0-9_]')
1166143Snate@binkert.org    modules = {}
1176143Snate@binkert.org    tnodes = {}
1186143Snate@binkert.org    symnames = {}
1196143Snate@binkert.org    
1206143Snate@binkert.org    def __init__(self, package, source):
1216143Snate@binkert.org        super(PySource, self).__init__(source)
1226143Snate@binkert.org
1236143Snate@binkert.org        modname,ext = self.extname
1245522Snate@binkert.org        assert ext == 'py'
1255522Snate@binkert.org
1265522Snate@binkert.org        if package:
1275522Snate@binkert.org            path = package.split('.')
1285604Snate@binkert.org        else:
1295604Snate@binkert.org            path = []
1306143Snate@binkert.org
1316143Snate@binkert.org        modpath = path[:]
1324762Snate@binkert.org        if modname != '__init__':
1334762Snate@binkert.org            modpath += [ modname ]
1346143Snate@binkert.org        modpath = '.'.join(modpath)
1356143Snate@binkert.org
1366143Snate@binkert.org        arcpath = path + [ self.basename ]
1376143Snate@binkert.org        abspath = self.snode.abspath
1384762Snate@binkert.org        if not exists(abspath):
1396143Snate@binkert.org            abspath = self.tnode.abspath
1406143Snate@binkert.org
1416143Snate@binkert.org        self.package = package
1426143Snate@binkert.org        self.modname = modname
1436143Snate@binkert.org        self.modpath = modpath
1446143Snate@binkert.org        self.arcname = joinpath(*arcpath)
1456143Snate@binkert.org        self.abspath = abspath
1466143Snate@binkert.org        self.compiled = File(self.filename + 'c')
1475604Snate@binkert.org        self.cpp = File(self.filename + '.cc')
1486143Snate@binkert.org        self.symname = PySource.invalid_sym_char.sub('_', modpath)
1496143Snate@binkert.org
1506143Snate@binkert.org        PySource.modules[modpath] = self
1514762Snate@binkert.org        PySource.tnodes[self.tnode] = self
1526143Snate@binkert.org        PySource.symnames[self.symname] = self
1534762Snate@binkert.org
1544762Snate@binkert.orgclass SimObject(PySource):
1554762Snate@binkert.org    '''Add a SimObject python file as a python source object and add
1566143Snate@binkert.org    it to a list of sim object modules'''
1576143Snate@binkert.org
1584762Snate@binkert.org    fixed = False
1596143Snate@binkert.org    modnames = []
1606143Snate@binkert.org
1616143Snate@binkert.org    def __init__(self, source):
1626143Snate@binkert.org        super(SimObject, self).__init__('m5.objects', source)
1634762Snate@binkert.org        if self.fixed:
1646143Snate@binkert.org            raise AttributeError, "Too late to call SimObject now."
1654762Snate@binkert.org
1666143Snate@binkert.org        bisect.insort_right(SimObject.modnames, self.modname)
1674762Snate@binkert.org
1686143Snate@binkert.orgclass SwigSource(SourceFile):
1696143Snate@binkert.org    '''Add a swig file to build'''
1706143Snate@binkert.org
1716143Snate@binkert.org    def __init__(self, package, source):
1726143Snate@binkert.org        super(SwigSource, self).__init__(source)
1736143Snate@binkert.org
1746143Snate@binkert.org        modname,ext = self.extname
1756143Snate@binkert.org        assert ext == 'i'
1766143Snate@binkert.org
1776143Snate@binkert.org        self.module = modname
1786143Snate@binkert.org        cc_file = joinpath(self.dirname, modname + '_wrap.cc')
1796143Snate@binkert.org        py_file = joinpath(self.dirname, modname + '.py')
1806143Snate@binkert.org
181955SN/A        self.cc_source = Source(cc_file, swig=True)
1825584Snate@binkert.org        self.py_source = PySource(package, py_file)
1835584Snate@binkert.org
1845584Snate@binkert.orgunit_tests = []
1855584Snate@binkert.orgdef UnitTest(target, sources):
1866143Snate@binkert.org    if not isinstance(sources, (list, tuple)):
1876143Snate@binkert.org        sources = [ sources ]
1886143Snate@binkert.org
1895584Snate@binkert.org    sources = [ Source(src, skip_lib=True) for src in sources ]
1904382Sbinkertn@umich.edu    unit_tests.append((target, sources))
1914202Sbinkertn@umich.edu
1924382Sbinkertn@umich.edu# Children should have access
1934382Sbinkertn@umich.eduExport('Source')
1944382Sbinkertn@umich.eduExport('PySource')
1955584Snate@binkert.orgExport('SimObject')
1964382Sbinkertn@umich.eduExport('SwigSource')
1974382Sbinkertn@umich.eduExport('UnitTest')
1984382Sbinkertn@umich.edu
1995192Ssaidi@eecs.umich.edu########################################################################
2005192Ssaidi@eecs.umich.edu#
2015799Snate@binkert.org# Trace Flags
2025799Snate@binkert.org#
2035799Snate@binkert.orgtrace_flags = {}
2045192Ssaidi@eecs.umich.edudef TraceFlag(name, desc=None):
2055799Snate@binkert.org    if name in trace_flags:
2065192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2075799Snate@binkert.org    trace_flags[name] = (name, (), desc)
2085799Snate@binkert.org
2095192Ssaidi@eecs.umich.edudef CompoundFlag(name, flags, desc=None):
2105192Ssaidi@eecs.umich.edu    if name in trace_flags:
2115192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2125799Snate@binkert.org
2135192Ssaidi@eecs.umich.edu    compound = tuple(flags)
2145192Ssaidi@eecs.umich.edu    trace_flags[name] = (name, compound, desc)
2155192Ssaidi@eecs.umich.edu
2165192Ssaidi@eecs.umich.eduExport('TraceFlag')
2175192Ssaidi@eecs.umich.eduExport('CompoundFlag')
2185192Ssaidi@eecs.umich.edu
2194382Sbinkertn@umich.edu########################################################################
2204382Sbinkertn@umich.edu#
2214382Sbinkertn@umich.edu# Set some compiler variables
2222667Sstever@eecs.umich.edu#
2232667Sstever@eecs.umich.edu
2242667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
2252667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
2262667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
2272667Sstever@eecs.umich.edu# files.
2285742Snate@binkert.orgenv.Append(CPPPATH=Dir('.'))
2295742Snate@binkert.org
2305742Snate@binkert.orgfor extra_dir in extras_dir_list:
2312037SN/A    env.Append(CPPPATH=Dir(extra_dir))
2322037SN/A
2332037SN/A# Workaround for bug in SCons version > 0.97d20071212
2345793Snate@binkert.org# Scons bug id: 2006 M5 Bug id: 308 
2355793Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
2365793Snate@binkert.org    Dir(root[len(base_dir) + 1:])
2375793Snate@binkert.org
2385793Snate@binkert.org########################################################################
2394382Sbinkertn@umich.edu#
2404762Snate@binkert.org# Walk the tree and execute all SConscripts in subdirectories
2415344Sstever@gmail.com#
2424382Sbinkertn@umich.edu
2435341Sstever@gmail.comhere = Dir('.').srcnode().abspath
2445742Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
2455742Snate@binkert.org    if root == here:
2465742Snate@binkert.org        # we don't want to recurse back into this SConscript
2475742Snate@binkert.org        continue
2485742Snate@binkert.org
2494762Snate@binkert.org    if 'SConscript' in files:
2505742Snate@binkert.org        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
2515742Snate@binkert.org        SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
2525742Snate@binkert.org
2535742Snate@binkert.orgfor extra_dir in extras_dir_list:
2545742Snate@binkert.org    prefix_len = len(dirname(extra_dir)) + 1
2555742Snate@binkert.org    for root, dirs, files in os.walk(extra_dir, topdown=True):
2565742Snate@binkert.org        if 'SConscript' in files:
2575341Sstever@gmail.com            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
2585742Snate@binkert.org            SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
2595341Sstever@gmail.com
2604773Snate@binkert.orgfor opt in export_vars:
2616108Snate@binkert.org    env.ConfigFile(opt)
2621858SN/A
2631085SN/Adef makeTheISA(source, target, env):
2644382Sbinkertn@umich.edu    isas = [ src.get_contents() for src in source ]
2654382Sbinkertn@umich.edu    target_isa = env['TARGET_ISA']
2664762Snate@binkert.org    def define(isa):
2674762Snate@binkert.org        return isa.upper() + '_ISA'
2684762Snate@binkert.org    
2696654Snate@binkert.org    def namespace(isa):
2706654Snate@binkert.org        return isa[0].upper() + isa[1:].lower() + 'ISA' 
2715517Snate@binkert.org
2725517Snate@binkert.org
2735517Snate@binkert.org    code = code_formatter()
2745517Snate@binkert.org    code('''\
2755517Snate@binkert.org#ifndef __CONFIG_THE_ISA_HH__
2765517Snate@binkert.org#define __CONFIG_THE_ISA_HH__
2775517Snate@binkert.org
2785517Snate@binkert.org''')
2795517Snate@binkert.org
2805517Snate@binkert.org    for i,isa in enumerate(isas):
2815517Snate@binkert.org        code('#define $0 $1', define(isa), i + 1)
2825517Snate@binkert.org
2835517Snate@binkert.org    code('''
2845517Snate@binkert.org
2855517Snate@binkert.org#define THE_ISA ${{define(target_isa)}}
2865517Snate@binkert.org#define TheISA ${{namespace(target_isa)}}
2875517Snate@binkert.org
2886654Snate@binkert.org#endif // __CONFIG_THE_ISA_HH__''')
2895517Snate@binkert.org
2905517Snate@binkert.org    code.write(str(target[0]))
2915517Snate@binkert.org
2925517Snate@binkert.orgenv.Command('config/the_isa.hh', map(Value, all_isa_list), makeTheISA)
2935517Snate@binkert.org
2945517Snate@binkert.org########################################################################
2955517Snate@binkert.org#
2965517Snate@binkert.org# Prevent any SimObjects from being added after this point, they
2976143Snate@binkert.org# should all have been added in the SConscripts above
2986654Snate@binkert.org#
2995517Snate@binkert.orgSimObject.fixed = True
3005517Snate@binkert.org
3015517Snate@binkert.orgclass DictImporter(object):
3025517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
3035517Snate@binkert.org    map to arbitrary filenames.'''
3045517Snate@binkert.org    def __init__(self, modules):
3055517Snate@binkert.org        self.modules = modules
3065517Snate@binkert.org        self.installed = set()
3075517Snate@binkert.org
3085517Snate@binkert.org    def __del__(self):
3095517Snate@binkert.org        self.unload()
3105517Snate@binkert.org
3115517Snate@binkert.org    def unload(self):
3125517Snate@binkert.org        import sys
3136654Snate@binkert.org        for module in self.installed:
3146654Snate@binkert.org            del sys.modules[module]
3155517Snate@binkert.org        self.installed = set()
3165517Snate@binkert.org
3176143Snate@binkert.org    def find_module(self, fullname, path):
3186143Snate@binkert.org        if fullname == 'm5.defines':
3196143Snate@binkert.org            return self
3206143Snate@binkert.org
3215517Snate@binkert.org        if fullname == 'm5.objects':
3226143Snate@binkert.org            return self
3235517Snate@binkert.org
3245517Snate@binkert.org        if fullname.startswith('m5.internal'):
3255517Snate@binkert.org            return None
3266654Snate@binkert.org
3276654Snate@binkert.org        source = self.modules.get(fullname, None)
3286654Snate@binkert.org        if source is not None and fullname.startswith('m5.objects'):
3296654Snate@binkert.org            return self
3306654Snate@binkert.org
3316654Snate@binkert.org        return None
3325517Snate@binkert.org
3335517Snate@binkert.org    def load_module(self, fullname):
3345517Snate@binkert.org        mod = imp.new_module(fullname)
3356143Snate@binkert.org        sys.modules[fullname] = mod
3365517Snate@binkert.org        self.installed.add(fullname)
3374762Snate@binkert.org
3385517Snate@binkert.org        mod.__loader__ = self
3395517Snate@binkert.org        if fullname == 'm5.objects':
3406143Snate@binkert.org            mod.__path__ = fullname.split('.')
3416143Snate@binkert.org            return mod
3425517Snate@binkert.org
3435517Snate@binkert.org        if fullname == 'm5.defines':
3445517Snate@binkert.org            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
3455517Snate@binkert.org            return mod
3465517Snate@binkert.org
3475517Snate@binkert.org        source = self.modules[fullname]
3485517Snate@binkert.org        if source.modname == '__init__':
3495517Snate@binkert.org            mod.__path__ = source.modpath
3505517Snate@binkert.org        mod.__file__ = source.abspath
3515517Snate@binkert.org
3526143Snate@binkert.org        exec file(source.abspath, 'r') in mod.__dict__
3535517Snate@binkert.org
3546654Snate@binkert.org        return mod
3556654Snate@binkert.org
3566654Snate@binkert.orgimport m5.SimObject
3576654Snate@binkert.orgimport m5.params
3586654Snate@binkert.orgfrom m5.util import code_formatter
3596654Snate@binkert.org
3605517Snate@binkert.orgm5.SimObject.clear()
3615517Snate@binkert.orgm5.params.clear()
3625517Snate@binkert.org
3635517Snate@binkert.org# install the python importer so we can grab stuff from the source
3645517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
3654762Snate@binkert.org# else we won't know about them for the rest of the stuff.
3664762Snate@binkert.orgimporter = DictImporter(PySource.modules)
3674762Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
3684762Snate@binkert.org
3694762Snate@binkert.org# import all sim objects so we can populate the all_objects list
3704762Snate@binkert.org# make sure that we're working with a list, then let's sort it
3716143Snate@binkert.orgfor modname in SimObject.modnames:
3724762Snate@binkert.org    exec('from m5.objects import %s' % modname)
3734762Snate@binkert.org
3744762Snate@binkert.org# we need to unload all of the currently imported modules so that they
3754762Snate@binkert.org# will be re-imported the next time the sconscript is run
3764382Sbinkertn@umich.eduimporter.unload()
3774382Sbinkertn@umich.edusys.meta_path.remove(importer)
3785517Snate@binkert.org
3796654Snate@binkert.orgsim_objects = m5.SimObject.allClasses
3805517Snate@binkert.orgall_enums = m5.params.allEnums
3815798Snate@binkert.org
3826654Snate@binkert.orgall_params = {}
3836654Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()):
3846654Snate@binkert.org    for param in obj._params.local.values():
3856654Snate@binkert.org        # load the ptype attribute now because it depends on the
3866654Snate@binkert.org        # current version of SimObject.allClasses, but when scons
3876654Snate@binkert.org        # actually uses the value, all versions of
3886654Snate@binkert.org        # SimObject.allClasses will have been loaded
3896654Snate@binkert.org        param.ptype
3906654Snate@binkert.org
3916654Snate@binkert.org        if not hasattr(param, 'swig_decl'):
3926654Snate@binkert.org            continue
3936654Snate@binkert.org        pname = param.ptype_str
3946654Snate@binkert.org        if pname not in all_params:
3956654Snate@binkert.org            all_params[pname] = param
3966654Snate@binkert.org
3975517Snate@binkert.org########################################################################
3985863Snate@binkert.org#
3995798Snate@binkert.org# calculate extra dependencies
4005798Snate@binkert.org#
4015798Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
4025798Snate@binkert.orgdepends = [ PySource.modules[dep].snode for dep in module_depends ]
4035517Snate@binkert.org
4045517Snate@binkert.org########################################################################
4055517Snate@binkert.org#
4065517Snate@binkert.org# Commands for the basic automatically generated python files
4075517Snate@binkert.org#
4085517Snate@binkert.org
4095517Snate@binkert.org# Generate Python file containing a dict specifying the current
4105517Snate@binkert.org# buildEnv flags.
4115798Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
4125798Snate@binkert.org    build_env, hg_info = [ x.get_contents() for x in source ]
4135798Snate@binkert.org
4145798Snate@binkert.org    code = code_formatter()
4155798Snate@binkert.org    code("""
4165798Snate@binkert.orgimport m5.internal
4175517Snate@binkert.orgimport m5.util
4185517Snate@binkert.org
4195517Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env)
4205517Snate@binkert.orghgRev = '$hg_info'
4215517Snate@binkert.org
4225517Snate@binkert.orgcompileDate = m5.internal.core.compileDate
4235517Snate@binkert.org_globals = globals()
4245517Snate@binkert.orgfor key,val in m5.internal.core.__dict__.iteritems():
4255517Snate@binkert.org    if key.startswith('flag_'):
4264762Snate@binkert.org        flag = key[5:]
4274382Sbinkertn@umich.edu        _globals[flag] = val
4286143Snate@binkert.orgdel _globals
4295517Snate@binkert.org""")
4304382Sbinkertn@umich.edu    code.write(target[0].abspath)
4314382Sbinkertn@umich.edu
4324762Snate@binkert.orgdefines_info = [ Value(build_env), Value(env['HG_INFO']) ]
4334762Snate@binkert.org# Generate a file with all of the compile options in it
4344762Snate@binkert.orgenv.Command('python/m5/defines.py', defines_info, makeDefinesPyFile)
4354762Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
4364762Snate@binkert.org
4375517Snate@binkert.org# Generate python file containing info about the M5 source code
4385517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
4395517Snate@binkert.org    code = code_formatter()
4405517Snate@binkert.org    for src in source:
4415517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
4425517Snate@binkert.org        code('$src = ${{repr(data)}}')
4435517Snate@binkert.org    code.write(str(target[0]))
4445517Snate@binkert.org
4456143Snate@binkert.org# Generate a file that wraps the basic top level files
4465517Snate@binkert.orgenv.Command('python/m5/info.py',
4475517Snate@binkert.org            [ '#/AUTHORS', '#/LICENSE', '#/README', '#/RELEASE_NOTES' ],
4485517Snate@binkert.org            makeInfoPyFile)
4495517Snate@binkert.orgPySource('m5', 'python/m5/info.py')
4505517Snate@binkert.org
4515517Snate@binkert.org########################################################################
4525517Snate@binkert.org#
4535517Snate@binkert.org# Create all of the SimObject param headers and enum headers
4545517Snate@binkert.org#
4555517Snate@binkert.org
4566143Snate@binkert.orgdef createSimObjectParam(target, source, env):
4575517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4585517Snate@binkert.org
4595517Snate@binkert.org    name = str(source[0].get_contents())
4605517Snate@binkert.org    obj = sim_objects[name]
4615517Snate@binkert.org
4625517Snate@binkert.org    code = code_formatter()
4635517Snate@binkert.org    obj.cxx_decl(code)
4645517Snate@binkert.org    code.write(target[0].abspath)
4655517Snate@binkert.org
4665517Snate@binkert.orgdef createSwigParam(target, source, env):
4675517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4685517Snate@binkert.org
4695517Snate@binkert.org    name = str(source[0].get_contents())
4705517Snate@binkert.org    param = all_params[name]
4715517Snate@binkert.org
4725517Snate@binkert.org    code = code_formatter()
4735517Snate@binkert.org    code('%module(package="m5.internal") $0_${name}', param.file_ext)
4745517Snate@binkert.org    param.swig_decl(code)
4755517Snate@binkert.org    code.write(target[0].abspath)
4766143Snate@binkert.org
4775517Snate@binkert.orgdef createEnumStrings(target, source, env):
4784762Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4794762Snate@binkert.org
4806143Snate@binkert.org    name = str(source[0].get_contents())
4816143Snate@binkert.org    obj = all_enums[name]
4826143Snate@binkert.org
4834762Snate@binkert.org    code = code_formatter()
4844762Snate@binkert.org    obj.cxx_def(code)
4854762Snate@binkert.org    code.write(target[0].abspath)
4865517Snate@binkert.org
4874762Snate@binkert.orgdef createEnumParam(target, source, env):
4884762Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4894762Snate@binkert.org
4905463Snate@binkert.org    name = str(source[0].get_contents())
4915517Snate@binkert.org    obj = all_enums[name]
4924762Snate@binkert.org
4934762Snate@binkert.org    code = code_formatter()
4944762Snate@binkert.org    obj.cxx_decl(code)
4954762Snate@binkert.org    code.write(target[0].abspath)
4964762Snate@binkert.org
4974762Snate@binkert.orgdef createEnumSwig(target, source, env):
4985463Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4995517Snate@binkert.org
5004762Snate@binkert.org    name = str(source[0].get_contents())
5014762Snate@binkert.org    obj = all_enums[name]
5024762Snate@binkert.org
5036143Snate@binkert.org    code = code_formatter()
5046143Snate@binkert.org    code('''\
5056143Snate@binkert.org%module(package="m5.internal") enum_$name
5064762Snate@binkert.org
5074762Snate@binkert.org%{
5085517Snate@binkert.org#include "enums/$name.hh"
5094762Snate@binkert.org%}
5104762Snate@binkert.org
5114762Snate@binkert.org%include "enums/$name.hh"
5124762Snate@binkert.org''')
5135517Snate@binkert.org    code.write(target[0].abspath)
5144762Snate@binkert.org
5154762Snate@binkert.org# Generate all of the SimObject param struct header files
5164762Snate@binkert.orgparams_hh_files = []
5174762Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()):
5185517Snate@binkert.org    py_source = PySource.modules[simobj.__module__]
5195517Snate@binkert.org    extra_deps = [ py_source.tnode ]
5205517Snate@binkert.org
5215517Snate@binkert.org    hh_file = File('params/%s.hh' % name)
5225517Snate@binkert.org    params_hh_files.append(hh_file)
5235517Snate@binkert.org    env.Command(hh_file, Value(name), createSimObjectParam)
5245517Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
5255517Snate@binkert.org
5265517Snate@binkert.org# Generate any parameter header files needed
5275517Snate@binkert.orgparams_i_files = []
5285517Snate@binkert.orgfor name,param in all_params.iteritems():
5295517Snate@binkert.org    i_file = File('python/m5/internal/%s_%s.i' % (param.file_ext, name))
5305517Snate@binkert.org    params_i_files.append(i_file)
5315517Snate@binkert.org    env.Command(i_file, Value(name), createSwigParam)
5325517Snate@binkert.org    env.Depends(i_file, depends)
5335517Snate@binkert.org    SwigSource('m5.internal', i_file)
5345517Snate@binkert.org
5355517Snate@binkert.org# Generate all enum header files
5365517Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()):
5375517Snate@binkert.org    py_source = PySource.modules[enum.__module__]
5385517Snate@binkert.org    extra_deps = [ py_source.tnode ]
5395517Snate@binkert.org
5405517Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
5415517Snate@binkert.org    env.Command(cc_file, Value(name), createEnumStrings)
5425517Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
5435517Snate@binkert.org    Source(cc_file)
5445517Snate@binkert.org
5455517Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
5465517Snate@binkert.org    env.Command(hh_file, Value(name), createEnumParam)
5475517Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
5485517Snate@binkert.org
5495517Snate@binkert.org    i_file = File('python/m5/internal/enum_%s.i' % name)
5505517Snate@binkert.org    env.Command(i_file, Value(name), createEnumSwig)
5515517Snate@binkert.org    env.Depends(i_file, depends + extra_deps)
5525517Snate@binkert.org    SwigSource('m5.internal', i_file)
5535517Snate@binkert.org
5545517Snate@binkert.orgdef buildParam(target, source, env):
5555517Snate@binkert.org    name = source[0].get_contents()
5565517Snate@binkert.org    obj = sim_objects[name]
5575517Snate@binkert.org    class_path = obj.cxx_class.split('::')
5585517Snate@binkert.org    classname = class_path[-1]
5595517Snate@binkert.org    namespaces = class_path[:-1]
5605517Snate@binkert.org    params = obj._params.local.values()
5615517Snate@binkert.org
5625517Snate@binkert.org    code = code_formatter()
5635517Snate@binkert.org
5645517Snate@binkert.org    code('%module(package="m5.internal") param_$name')
5655517Snate@binkert.org    code()
5665517Snate@binkert.org    code('%{')
5675517Snate@binkert.org    code('#include "params/$obj.hh"')
5685517Snate@binkert.org    for param in params:
5695517Snate@binkert.org        param.cxx_predecls(code)
5705517Snate@binkert.org    code('%}')
5715517Snate@binkert.org    code()
5725517Snate@binkert.org
5735517Snate@binkert.org    for param in params:
5745517Snate@binkert.org        param.swig_predecls(code)
5755517Snate@binkert.org
5765517Snate@binkert.org    code()
5775517Snate@binkert.org    if obj._base:
5785517Snate@binkert.org        code('%import "python/m5/internal/param_${{obj._base}}.i"')
5795517Snate@binkert.org    code()
5805517Snate@binkert.org    obj.swig_objdecls(code)
5815517Snate@binkert.org    code()
5825517Snate@binkert.org
5835517Snate@binkert.org    code('%include "params/$obj.hh"')
5845610Snate@binkert.org
5855623Snate@binkert.org    code.write(target[0].abspath)
5865623Snate@binkert.org
5875623Snate@binkert.orgfor name in sim_objects.iterkeys():
5885610Snate@binkert.org    params_file = File('python/m5/internal/param_%s.i' % name)
5895517Snate@binkert.org    env.Command(params_file, Value(name), buildParam)
5905623Snate@binkert.org    env.Depends(params_file, depends)
5915623Snate@binkert.org    SwigSource('m5.internal', params_file)
5925623Snate@binkert.org
5935623Snate@binkert.org# Generate the main swig init file
5945623Snate@binkert.orgdef makeEmbeddedSwigInit(target, source, env):
5955623Snate@binkert.org    code = code_formatter()
5965623Snate@binkert.org    module = source[0].get_contents()
5975517Snate@binkert.org    code('''\
5985610Snate@binkert.org#include "sim/init.hh"
5995610Snate@binkert.org
6005610Snate@binkert.orgextern "C" {
6015610Snate@binkert.org    void init_${module}();
6025517Snate@binkert.org}
6035517Snate@binkert.org
6045610Snate@binkert.orgEmbeddedSwig embed_swig_${module}(init_${module});
6055610Snate@binkert.org''')
6065517Snate@binkert.org    code.write(str(target[0]))
6075517Snate@binkert.org    
6085517Snate@binkert.org# Build all swig modules
6095517Snate@binkert.orgfor swig in SwigSource.all:
6105517Snate@binkert.org    env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
6115517Snate@binkert.org                '$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
6125517Snate@binkert.org                '-o ${TARGETS[0]} $SOURCES')
6135517Snate@binkert.org    init_file = 'python/swig/init_%s.cc' % swig.module
6145517Snate@binkert.org    env.Command(init_file, Value(swig.module), makeEmbeddedSwigInit)
6155517Snate@binkert.org    Source(init_file)
6164762Snate@binkert.org    env.Depends(swig.py_source.tnode, swig.tnode)
6176143Snate@binkert.org    env.Depends(swig.cc_source.tnode, swig.tnode)
6186143Snate@binkert.org
6195463Snate@binkert.orgdef getFlags(source_flags):
6204762Snate@binkert.org    flagsMap = {}
6214762Snate@binkert.org    flagsList = []
6224762Snate@binkert.org    for s in source_flags:
6236143Snate@binkert.org        val = eval(s.get_contents())
6246143Snate@binkert.org        name, compound, desc = val
6254382Sbinkertn@umich.edu        flagsList.append(val)
6264382Sbinkertn@umich.edu        flagsMap[name] = bool(compound)
6276143Snate@binkert.org    
6286143Snate@binkert.org    for name, compound, desc in flagsList:
6294382Sbinkertn@umich.edu        for flag in compound:
6304762Snate@binkert.org            if flag not in flagsMap:
6315517Snate@binkert.org                raise AttributeError, "Trace flag %s not found" % flag
6325517Snate@binkert.org            if flagsMap[flag]:
6335517Snate@binkert.org                raise AttributeError, \
6345517Snate@binkert.org                    "Compound flag can't point to another compound flag"
6355517Snate@binkert.org
6365517Snate@binkert.org    flagsList.sort()
6375522Snate@binkert.org    return flagsList
6385517Snate@binkert.org
6395517Snate@binkert.org
6405517Snate@binkert.org# Generate traceflags.py
6415517Snate@binkert.orgdef traceFlagsPy(target, source, env):
6425517Snate@binkert.org    assert(len(target) == 1)
6436143Snate@binkert.org    code = code_formatter()
6446143Snate@binkert.org
6456143Snate@binkert.org    allFlags = getFlags(source)
6465522Snate@binkert.org
6474382Sbinkertn@umich.edu    code('basic = [')
6486229Snate@binkert.org    code.indent()
6496229Snate@binkert.org    for flag, compound, desc in allFlags:
6506229Snate@binkert.org        if not compound:
6516229Snate@binkert.org            code("'$flag',")
6526229Snate@binkert.org    code(']')
6536229Snate@binkert.org    code.dedent()
6546229Snate@binkert.org    code()
6556229Snate@binkert.org
6566229Snate@binkert.org    code('compound = [')
6576229Snate@binkert.org    code.indent()
6586229Snate@binkert.org    code("'All',")
6596229Snate@binkert.org    for flag, compound, desc in allFlags:
6606229Snate@binkert.org        if compound:
6616229Snate@binkert.org            code("'$flag',")
6626229Snate@binkert.org    code("]")
6636229Snate@binkert.org    code.dedent()
6646229Snate@binkert.org    code()
6656229Snate@binkert.org
6666229Snate@binkert.org    code("all = frozenset(basic + compound)")
6676229Snate@binkert.org    code()
6686229Snate@binkert.org
6695192Ssaidi@eecs.umich.edu    code('compoundMap = {')
6705517Snate@binkert.org    code.indent()
6715517Snate@binkert.org    all = tuple([flag for flag,compound,desc in allFlags if not compound])
6725517Snate@binkert.org    code("'All' : $all,")
6735517Snate@binkert.org    for flag, compound, desc in allFlags:
6746229Snate@binkert.org        if compound:
6756229Snate@binkert.org            code("'$flag' : $compound,")
6765799Snate@binkert.org    code('}')
6775799Snate@binkert.org    code.dedent()
6785517Snate@binkert.org    code()
6795517Snate@binkert.org
6805517Snate@binkert.org    code('descriptions = {')
6815517Snate@binkert.org    code.indent()
6825517Snate@binkert.org    code("'All' : 'All flags',")
6835517Snate@binkert.org    for flag, compound, desc in allFlags:
6845799Snate@binkert.org        code("'$flag' : '$desc',")
6855517Snate@binkert.org    code("}")
6865517Snate@binkert.org    code.dedent()
6875517Snate@binkert.org
6885517Snate@binkert.org    code.write(str(target[0]))
6895517Snate@binkert.org
6905517Snate@binkert.orgdef traceFlagsCC(target, source, env):
6915517Snate@binkert.org    assert(len(target) == 1)
6925799Snate@binkert.org
6935517Snate@binkert.org    allFlags = getFlags(source)
6945517Snate@binkert.org    code = code_formatter()
6955799Snate@binkert.org
6965517Snate@binkert.org    # file header
6975517Snate@binkert.org    code('''
6985517Snate@binkert.org/*
6995517Snate@binkert.org * DO NOT EDIT THIS FILE! Automatically generated
7005517Snate@binkert.org */
7015517Snate@binkert.org
7025517Snate@binkert.org#include "base/traceflags.hh"
7035517Snate@binkert.org
7045799Snate@binkert.orgusing namespace Trace;
7055517Snate@binkert.org
7065517Snate@binkert.orgconst char *Trace::flagStrings[] =
7075517Snate@binkert.org{''')
7085517Snate@binkert.org
7095517Snate@binkert.org    code.indent()
7105517Snate@binkert.org    # The string array is used by SimpleEnumParam to map the strings
7115517Snate@binkert.org    # provided by the user to enum values.
7125517Snate@binkert.org    for flag, compound, desc in allFlags:
7135517Snate@binkert.org        if not compound:
7145517Snate@binkert.org            code('"$flag",')
7155517Snate@binkert.org
7165517Snate@binkert.org    code('"All",')
7176229Snate@binkert.org    for flag, compound, desc in allFlags:
7185517Snate@binkert.org        if compound:
7195517Snate@binkert.org            code('"$flag",')
7205517Snate@binkert.org    code.dedent()
7215517Snate@binkert.org
7225517Snate@binkert.org    code('''\
7235517Snate@binkert.org};
7245517Snate@binkert.org
7255517Snate@binkert.orgconst int Trace::numFlagStrings = ${{len(allFlags) + 1}};
7265517Snate@binkert.org
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    all = tuple([flag for flag,compound,desc in allFlags if not compound])
7325517Snate@binkert.org    code('static const Flags AllMap[] = {')
7335517Snate@binkert.org    code.indent()
7345517Snate@binkert.org    for flag, compound, desc in allFlags:
7355517Snate@binkert.org        if not compound:
7365517Snate@binkert.org            code('$flag,')
7375517Snate@binkert.org    code.dedent()
7385517Snate@binkert.org    code('};')
7395517Snate@binkert.org    code()
7405517Snate@binkert.org
7415517Snate@binkert.org    for flag, compound, desc in allFlags:
7425517Snate@binkert.org        if not compound:
7435517Snate@binkert.org            continue
7445517Snate@binkert.org        code('static const Flags ${flag}Map[] = {')
7455517Snate@binkert.org        code.indent()
7465517Snate@binkert.org        for flag in compound:
7475517Snate@binkert.org            code('$flag,')
7485517Snate@binkert.org        code('(Flags)-1')
7495517Snate@binkert.org        code.dedent()
7505517Snate@binkert.org        code('};')
7515517Snate@binkert.org        code()
7525517Snate@binkert.org
7535517Snate@binkert.org    # Finally the compoundFlags[] array maps the compound flags
7545517Snate@binkert.org    # to their individual arrays/
7555517Snate@binkert.org    code('const Flags *Trace::compoundFlags[] = {')
7565517Snate@binkert.org    code.indent()
7575517Snate@binkert.org    code('AllMap,')
7585517Snate@binkert.org    for flag, compound, desc in allFlags:
7595517Snate@binkert.org        if compound:
7605517Snate@binkert.org            code('${flag}Map,')
7615517Snate@binkert.org    # file trailer
7625517Snate@binkert.org    code.dedent()
7635517Snate@binkert.org    code('};')
7645517Snate@binkert.org
7655517Snate@binkert.org    code.write(str(target[0]))
7665517Snate@binkert.org
7675517Snate@binkert.orgdef traceFlagsHH(target, source, env):
7685517Snate@binkert.org    assert(len(target) == 1)
7695517Snate@binkert.org
7705517Snate@binkert.org    allFlags = getFlags(source)
7715517Snate@binkert.org    code = code_formatter()
7725517Snate@binkert.org
7735517Snate@binkert.org    # file header boilerplate
7745517Snate@binkert.org    code('''\
7755517Snate@binkert.org/*
7765517Snate@binkert.org * DO NOT EDIT THIS FILE!
7775517Snate@binkert.org *
7785517Snate@binkert.org * Automatically generated from traceflags.py
7795517Snate@binkert.org */
7805517Snate@binkert.org
7815517Snate@binkert.org#ifndef __BASE_TRACE_FLAGS_HH__
7825517Snate@binkert.org#define __BASE_TRACE_FLAGS_HH__
7835517Snate@binkert.org
7845517Snate@binkert.orgnamespace Trace {
7855517Snate@binkert.org
7865517Snate@binkert.orgenum Flags {''')
7875517Snate@binkert.org
7885517Snate@binkert.org    # Generate the enum.  Base flags come first, then compound flags.
7895517Snate@binkert.org    idx = 0
7906229Snate@binkert.org    code.indent()
7915517Snate@binkert.org    for flag, compound, desc in allFlags:
7925517Snate@binkert.org        if not compound:
7935517Snate@binkert.org            code('$flag = $idx,')
7945517Snate@binkert.org            idx += 1
7955517Snate@binkert.org
7965517Snate@binkert.org    numBaseFlags = idx
7975517Snate@binkert.org    code('NumFlags = $idx,')
7985517Snate@binkert.org    code.dedent()
7995517Snate@binkert.org    code()
8005517Snate@binkert.org
8015517Snate@binkert.org    # put a comment in here to separate base from compound flags
8025517Snate@binkert.org    code('''
8035517Snate@binkert.org// The remaining enum values are *not* valid indices for Trace::flags.
8045517Snate@binkert.org// They are "compound" flags, which correspond to sets of base
8055517Snate@binkert.org// flags, and are used by changeFlag.''')
8065517Snate@binkert.org
8075517Snate@binkert.org    code.indent()
8085517Snate@binkert.org    code('All = $idx,')
8095517Snate@binkert.org    idx += 1
8105517Snate@binkert.org    for flag, compound, desc in allFlags:
8115517Snate@binkert.org        if compound:
8125517Snate@binkert.org            code('$flag = $idx,')
8135517Snate@binkert.org            idx += 1
8145517Snate@binkert.org
8155517Snate@binkert.org    numCompoundFlags = idx - numBaseFlags
8165517Snate@binkert.org    code('NumCompoundFlags = $numCompoundFlags')
8175517Snate@binkert.org    code.dedent()
8185517Snate@binkert.org
8195517Snate@binkert.org    # trailer boilerplate
8205517Snate@binkert.org    code('''\
8215517Snate@binkert.org}; // enum Flags
8225517Snate@binkert.org
8235517Snate@binkert.org// Array of strings for SimpleEnumParam
8245517Snate@binkert.orgextern const char *flagStrings[];
8255517Snate@binkert.orgextern const int numFlagStrings;
8265517Snate@binkert.org
8275517Snate@binkert.org// Array of arraay pointers: for each compound flag, gives the list of
8285517Snate@binkert.org// base flags to set.  Inidividual flag arrays are terminated by -1.
8295517Snate@binkert.orgextern const Flags *compoundFlags[];
8305517Snate@binkert.org
8315517Snate@binkert.org/* namespace Trace */ }
8325517Snate@binkert.org
8335517Snate@binkert.org#endif // __BASE_TRACE_FLAGS_HH__
8345517Snate@binkert.org''')
8355517Snate@binkert.org
8365517Snate@binkert.org    code.write(str(target[0]))
8375517Snate@binkert.org
8385517Snate@binkert.orgflags = map(Value, trace_flags.values())
8395517Snate@binkert.orgenv.Command('base/traceflags.py', flags, traceFlagsPy)
8405517Snate@binkert.orgPySource('m5', 'base/traceflags.py')
8415517Snate@binkert.org
8425517Snate@binkert.orgenv.Command('base/traceflags.hh', flags, traceFlagsHH)
8435517Snate@binkert.orgenv.Command('base/traceflags.cc', flags, traceFlagsCC)
8445517Snate@binkert.orgSource('base/traceflags.cc')
8455517Snate@binkert.org
8465517Snate@binkert.org# Embed python files.  All .py files that have been indicated by a
8475517Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
8485517Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
8495517Snate@binkert.org# byte code, compress it, and then generate a c++ file that
8505517Snate@binkert.org# inserts the result into an array.
8515517Snate@binkert.orgdef embedPyFile(target, source, env):
8526143Snate@binkert.org    def c_str(string):
8535517Snate@binkert.org        if string is None:
8545192Ssaidi@eecs.umich.edu            return "0"
8555192Ssaidi@eecs.umich.edu        return '"%s"' % string
8565517Snate@binkert.org
8575517Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
8585192Ssaidi@eecs.umich.edu    it, compress it, and stick it into an asm file so the code appears
8595192Ssaidi@eecs.umich.edu    as just bytes with a label in the data section'''
8605522Snate@binkert.org
8615522Snate@binkert.org    src = file(str(source[0]), 'r').read()
8625522Snate@binkert.org
8635522Snate@binkert.org    pysource = PySource.tnodes[source[0]]
8645522Snate@binkert.org    compiled = compile(src, pysource.abspath, 'exec')
8655522Snate@binkert.org    marshalled = marshal.dumps(compiled)
8665522Snate@binkert.org    compressed = zlib.compress(marshalled)
8675522Snate@binkert.org    data = compressed
8685522Snate@binkert.org    sym = pysource.symname
8695522Snate@binkert.org
8705517Snate@binkert.org    code = code_formatter()
8715522Snate@binkert.org    code('''\
8725522Snate@binkert.org#include "sim/init.hh"
8735517Snate@binkert.org
8746143Snate@binkert.orgnamespace {
8755604Snate@binkert.org
8765522Snate@binkert.orgconst char data_${sym}[] = {
8775522Snate@binkert.org''')
8785522Snate@binkert.org    code.indent()
8795517Snate@binkert.org    step = 16
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        code(''.join('%d,' % d for d in x))
8835522Snate@binkert.org    code.dedent()
8845522Snate@binkert.org    
8855522Snate@binkert.org    code('''};
8865522Snate@binkert.org
8875522Snate@binkert.orgEmbeddedPython embedded_${sym}(
8885522Snate@binkert.org    ${{c_str(pysource.arcname)}},
8895522Snate@binkert.org    ${{c_str(pysource.abspath)}},
8905522Snate@binkert.org    ${{c_str(pysource.modpath)}},
8915522Snate@binkert.org    data_${sym},
8925522Snate@binkert.org    ${{len(data)}},
8935522Snate@binkert.org    ${{len(marshalled)}});
8945522Snate@binkert.org
8955522Snate@binkert.org/* namespace */ }
8965522Snate@binkert.org''')
8975522Snate@binkert.org    code.write(str(target[0]))
8985522Snate@binkert.org
8996143Snate@binkert.orgfor source in PySource.all:
9005522Snate@binkert.org    env.Command(source.cpp, source.tnode, embedPyFile)
9015522Snate@binkert.org    Source(source.cpp)
9024382Sbinkertn@umich.edu
9035522Snate@binkert.org########################################################################
9045522Snate@binkert.org#
9055522Snate@binkert.org# Define binaries.  Each different build type (debug, opt, etc.) gets
9065522Snate@binkert.org# a slightly different build environment.
9075522Snate@binkert.org#
9085522Snate@binkert.org
9095522Snate@binkert.org# List of constructed environments to pass back to SConstruct
9104382Sbinkertn@umich.eduenvList = []
9115522Snate@binkert.org
9126143Snate@binkert.orgdate_source = Source('base/date.cc', skip_lib=True)
9135522Snate@binkert.org
9145522Snate@binkert.org# Function to create a new build environment as clone of current
9155522Snate@binkert.org# environment 'env' with modified object suffix and optional stripped
9165522Snate@binkert.org# binary.  Additional keyword arguments are appended to corresponding
9175522Snate@binkert.org# build environment vars.
9185522Snate@binkert.orgdef makeEnv(label, objsfx, strip = False, **kwargs):
9195522Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
9205522Snate@binkert.org    # name.  Use '_' instead.
9215522Snate@binkert.org    libname = 'm5_' + label
9225522Snate@binkert.org    exename = 'm5.' + label
9235522Snate@binkert.org
9245522Snate@binkert.org    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
9255522Snate@binkert.org    new_env.Label = label
9265522Snate@binkert.org    new_env.Append(**kwargs)
9275522Snate@binkert.org
9285522Snate@binkert.org    swig_env = new_env.Clone()
9295522Snate@binkert.org    swig_env.Append(CCFLAGS='-Werror')
9305522Snate@binkert.org    if env['GCC']:
9315522Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-uninitialized')
9325522Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-sign-compare')
9335522Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-parentheses')
9345522Snate@binkert.org
9355522Snate@binkert.org    werror_env = new_env.Clone()
9365522Snate@binkert.org    werror_env.Append(CCFLAGS='-Werror')
9375522Snate@binkert.org
9385522Snate@binkert.org    def make_obj(source, static, extra_deps = None):
9396143Snate@binkert.org        '''This function adds the specified source to the correct
9406143Snate@binkert.org        build environment, and returns the corresponding SCons Object
9416143Snate@binkert.org        nodes'''
9426143Snate@binkert.org
9435522Snate@binkert.org        if source.swig:
9444382Sbinkertn@umich.edu            env = swig_env
9454382Sbinkertn@umich.edu        elif source.Werror:
9464382Sbinkertn@umich.edu            env = werror_env
9474382Sbinkertn@umich.edu        else:
9484382Sbinkertn@umich.edu            env = new_env
9494382Sbinkertn@umich.edu
9504382Sbinkertn@umich.edu        if static:
9514382Sbinkertn@umich.edu            obj = env.StaticObject(source.tnode)
9524382Sbinkertn@umich.edu        else:
9534382Sbinkertn@umich.edu            obj = env.SharedObject(source.tnode)
9546143Snate@binkert.org
955955SN/A        if extra_deps:
9562655Sstever@eecs.umich.edu            env.Depends(obj, extra_deps)
9572655Sstever@eecs.umich.edu
9582655Sstever@eecs.umich.edu        return obj
9592655Sstever@eecs.umich.edu
9602655Sstever@eecs.umich.edu    static_objs = [ make_obj(s, True) for s in Source.get(skip_lib=False)]
9615601Snate@binkert.org    shared_objs = [ make_obj(s, False) for s in Source.get(skip_lib=False)]
9625601Snate@binkert.org
9635601Snate@binkert.org    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
9645601Snate@binkert.org    static_objs.append(static_date)
9655522Snate@binkert.org    
9665863Snate@binkert.org    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
9675601Snate@binkert.org    shared_objs.append(shared_date)
9685601Snate@binkert.org
9695601Snate@binkert.org    # First make a library of everything but main() so other programs can
9705863Snate@binkert.org    # link against m5.
9716143Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
9725559Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
9735559Snate@binkert.org
9745559Snate@binkert.org    for target, sources in unit_tests:
9755559Snate@binkert.org        objs = [ make_obj(s, static=True) for s in sources ]
9765601Snate@binkert.org        new_env.Program("unittest/%s.%s" % (target, label), objs + static_objs)
9776143Snate@binkert.org
9786143Snate@binkert.org    # Now link a stub with main() and the static library.
9796143Snate@binkert.org    bin_objs = [make_obj(s, True) for s in Source.get(bin_only=True) ]
9806143Snate@binkert.org    progname = exename
9816143Snate@binkert.org    if strip:
9826143Snate@binkert.org        progname += '.unstripped'
9836143Snate@binkert.org
9846143Snate@binkert.org    targets = new_env.Program(progname, bin_objs + static_objs)
9856143Snate@binkert.org
9866143Snate@binkert.org    if strip:
9876143Snate@binkert.org        if sys.platform == 'sunos5':
9886143Snate@binkert.org            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
9896143Snate@binkert.org        else:
9906143Snate@binkert.org            cmd = 'strip $SOURCE -o $TARGET'
9916143Snate@binkert.org        targets = new_env.Command(exename, progname, cmd)
9926143Snate@binkert.org            
9936143Snate@binkert.org    new_env.M5Binary = targets[0]
9946143Snate@binkert.org    envList.append(new_env)
9956143Snate@binkert.org
9966143Snate@binkert.org# Debug binary
9976143Snate@binkert.orgccflags = {}
9986143Snate@binkert.orgif env['GCC']:
9996143Snate@binkert.org    if sys.platform == 'sunos5':
10006143Snate@binkert.org        ccflags['debug'] = '-gstabs+'
10016143Snate@binkert.org    else:
10026143Snate@binkert.org        ccflags['debug'] = '-ggdb3'
10036143Snate@binkert.org    ccflags['opt'] = '-g -O3'
10046143Snate@binkert.org    ccflags['fast'] = '-O3'
10056143Snate@binkert.org    ccflags['prof'] = '-O3 -g -pg'
10066143Snate@binkert.orgelif env['SUNCC']:
10076143Snate@binkert.org    ccflags['debug'] = '-g0'
10086143Snate@binkert.org    ccflags['opt'] = '-g -O'
10096240Snate@binkert.org    ccflags['fast'] = '-fast'
10105554Snate@binkert.org    ccflags['prof'] = '-fast -g -pg'
10115522Snate@binkert.orgelif env['ICC']:
10125522Snate@binkert.org    ccflags['debug'] = '-g -O0'
10135797Snate@binkert.org    ccflags['opt'] = '-g -O'
10145797Snate@binkert.org    ccflags['fast'] = '-fast'
10155522Snate@binkert.org    ccflags['prof'] = '-fast -g -pg'
10165584Snate@binkert.orgelse:
10176143Snate@binkert.org    print 'Unknown compiler, please fix compiler options'
10185862Snate@binkert.org    Exit(1)
10195584Snate@binkert.org
10205601Snate@binkert.orgmakeEnv('debug', '.do',
10216143Snate@binkert.org        CCFLAGS = Split(ccflags['debug']),
10226143Snate@binkert.org        CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
10232655Sstever@eecs.umich.edu
10246143Snate@binkert.org# Optimized binary
10256143Snate@binkert.orgmakeEnv('opt', '.o',
10266143Snate@binkert.org        CCFLAGS = Split(ccflags['opt']),
10276143Snate@binkert.org        CPPDEFINES = ['TRACING_ON=1'])
10286143Snate@binkert.org
10294007Ssaidi@eecs.umich.edu# "Fast" binary
10304596Sbinkertn@umich.edumakeEnv('fast', '.fo', strip = True,
10314007Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['fast']),
10324596Sbinkertn@umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
10336143Snate@binkert.org
10345522Snate@binkert.org# Profiled binary
10355601Snate@binkert.orgmakeEnv('prof', '.po',
10365601Snate@binkert.org        CCFLAGS = Split(ccflags['prof']),
10372655Sstever@eecs.umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
1038955SN/A        LINKFLAGS = '-pg')
10393918Ssaidi@eecs.umich.edu
10403918Ssaidi@eecs.umich.eduReturn('envList')
10413918Ssaidi@eecs.umich.edu