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
547674Snate@binkert.orgfrom m5.util import code_formatter
557674Snate@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
696143Snate@binkert.org            else:
706143Snate@binkert.org                yield src
714762Snate@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):
937065Snate@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
1136143Snate@binkert.orgclass PySource(SourceFile):
1146143Snate@binkert.org    '''Add a python source file to the named package'''
1155522Snate@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
1246143Snate@binkert.org        assert ext == 'py'
1256143Snate@binkert.org
1265522Snate@binkert.org        if package:
1275522Snate@binkert.org            path = package.split('.')
1285522Snate@binkert.org        else:
1295522Snate@binkert.org            path = []
1305604Snate@binkert.org
1315604Snate@binkert.org        modpath = path[:]
1326143Snate@binkert.org        if modname != '__init__':
1336143Snate@binkert.org            modpath += [ modname ]
1344762Snate@binkert.org        modpath = '.'.join(modpath)
1354762Snate@binkert.org
1366143Snate@binkert.org        arcpath = path + [ self.basename ]
1376727Ssteve.reinhardt@amd.com        abspath = self.snode.abspath
1386727Ssteve.reinhardt@amd.com        if not exists(abspath):
1396727Ssteve.reinhardt@amd.com            abspath = self.tnode.abspath
1404762Snate@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)
1456727Ssteve.reinhardt@amd.com        self.abspath = abspath
1466143Snate@binkert.org        self.compiled = File(self.filename + 'c')
1477674Snate@binkert.org        self.cpp = File(self.filename + '.cc')
1487674Snate@binkert.org        self.symname = PySource.invalid_sym_char.sub('_', modpath)
1495604Snate@binkert.org
1506143Snate@binkert.org        PySource.modules[modpath] = self
1516143Snate@binkert.org        PySource.tnodes[self.tnode] = self
1526143Snate@binkert.org        PySource.symnames[self.symname] = self
1534762Snate@binkert.org
1546143Snate@binkert.orgclass SimObject(PySource):
1554762Snate@binkert.org    '''Add a SimObject python file as a python source object and add
1564762Snate@binkert.org    it to a list of sim object modules'''
1574762Snate@binkert.org
1586143Snate@binkert.org    fixed = False
1596143Snate@binkert.org    modnames = []
1604762Snate@binkert.org
1616143Snate@binkert.org    def __init__(self, source):
1626143Snate@binkert.org        super(SimObject, self).__init__('m5.objects', source)
1636143Snate@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):
1694762Snate@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
1816143Snate@binkert.org        self.cc_source = Source(cc_file, swig=True)
1826143Snate@binkert.org        self.py_source = PySource(package, py_file)
183955SN/A
1845584Snate@binkert.orgunit_tests = []
1855584Snate@binkert.orgdef UnitTest(target, sources):
1865584Snate@binkert.org    if not isinstance(sources, (list, tuple)):
1875584Snate@binkert.org        sources = [ sources ]
1886143Snate@binkert.org
1896143Snate@binkert.org    sources = [ Source(src, skip_lib=True) for src in sources ]
1906143Snate@binkert.org    unit_tests.append((target, sources))
1915584Snate@binkert.org
1924382Sbinkertn@umich.edu# Children should have access
1934202Sbinkertn@umich.eduExport('Source')
1944382Sbinkertn@umich.eduExport('PySource')
1954382Sbinkertn@umich.eduExport('SimObject')
1964382Sbinkertn@umich.eduExport('SwigSource')
1975584Snate@binkert.orgExport('UnitTest')
1984382Sbinkertn@umich.edu
1994382Sbinkertn@umich.edu########################################################################
2004382Sbinkertn@umich.edu#
2015192Ssaidi@eecs.umich.edu# Trace Flags
2025192Ssaidi@eecs.umich.edu#
2035799Snate@binkert.orgtrace_flags = {}
2045799Snate@binkert.orgdef 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)
2085192Ssaidi@eecs.umich.edu
2095799Snate@binkert.orgdef CompoundFlag(name, flags, desc=None):
2105799Snate@binkert.org    if name in trace_flags:
2115192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2125192Ssaidi@eecs.umich.edu
2135192Ssaidi@eecs.umich.edu    compound = tuple(flags)
2145799Snate@binkert.org    trace_flags[name] = (name, compound, desc)
2155192Ssaidi@eecs.umich.edu
2165192Ssaidi@eecs.umich.eduExport('TraceFlag')
2175192Ssaidi@eecs.umich.eduExport('CompoundFlag')
2185192Ssaidi@eecs.umich.edu
2195192Ssaidi@eecs.umich.edu########################################################################
2205192Ssaidi@eecs.umich.edu#
2214382Sbinkertn@umich.edu# Set some compiler variables
2224382Sbinkertn@umich.edu#
2234382Sbinkertn@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.
2282667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
2292667Sstever@eecs.umich.edu
2305742Snate@binkert.orgfor extra_dir in extras_dir_list:
2315742Snate@binkert.org    env.Append(CPPPATH=Dir(extra_dir))
2325742Snate@binkert.org
2335793Snate@binkert.org# 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
2384382Sbinkertn@umich.edu########################################################################
2394762Snate@binkert.org#
2405344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories
2414382Sbinkertn@umich.edu#
2425341Sstever@gmail.com
2435742Snate@binkert.orghere = 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
2484762Snate@binkert.org
2495742Snate@binkert.org    if 'SConscript' in files:
2505742Snate@binkert.org        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
2517722Sgblack@eecs.umich.edu        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):
2565341Sstever@gmail.com        if 'SConscript' in files:
2575742Snate@binkert.org            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
2587722Sgblack@eecs.umich.edu            SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
2594773Snate@binkert.org
2606108Snate@binkert.orgfor opt in export_vars:
2611858SN/A    env.ConfigFile(opt)
2621085SN/A
2636658Snate@binkert.orgdef makeTheISA(source, target, env):
2646658Snate@binkert.org    isas = [ src.get_contents() for src in source ]
2657673Snate@binkert.org    target_isa = env['TARGET_ISA']
2666658Snate@binkert.org    def define(isa):
2676658Snate@binkert.org        return isa.upper() + '_ISA'
2686658Snate@binkert.org    
2696658Snate@binkert.org    def namespace(isa):
2706658Snate@binkert.org        return isa[0].upper() + isa[1:].lower() + 'ISA' 
2716658Snate@binkert.org
2726658Snate@binkert.org
2737673Snate@binkert.org    code = code_formatter()
2747673Snate@binkert.org    code('''\
2757673Snate@binkert.org#ifndef __CONFIG_THE_ISA_HH__
2767673Snate@binkert.org#define __CONFIG_THE_ISA_HH__
2777673Snate@binkert.org
2787673Snate@binkert.org''')
2797673Snate@binkert.org
2806658Snate@binkert.org    for i,isa in enumerate(isas):
2817673Snate@binkert.org        code('#define $0 $1', define(isa), i + 1)
2827673Snate@binkert.org
2837673Snate@binkert.org    code('''
2847673Snate@binkert.org
2857673Snate@binkert.org#define THE_ISA ${{define(target_isa)}}
2867673Snate@binkert.org#define TheISA ${{namespace(target_isa)}}
2877673Snate@binkert.org
2887673Snate@binkert.org#endif // __CONFIG_THE_ISA_HH__''')
2897673Snate@binkert.org
2907673Snate@binkert.org    code.write(str(target[0]))
2916658Snate@binkert.org
2926658Snate@binkert.orgenv.Command('config/the_isa.hh', map(Value, all_isa_list), makeTheISA)
2936658Snate@binkert.org
2944382Sbinkertn@umich.edu########################################################################
2954382Sbinkertn@umich.edu#
2964762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
2974762Snate@binkert.org# should all have been added in the SConscripts above
2984762Snate@binkert.org#
2996654Snate@binkert.orgSimObject.fixed = True
3006654Snate@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
3135517Snate@binkert.org        for module in self.installed:
3145517Snate@binkert.org            del sys.modules[module]
3155517Snate@binkert.org        self.installed = set()
3165517Snate@binkert.org
3175517Snate@binkert.org    def find_module(self, fullname, path):
3186654Snate@binkert.org        if fullname == 'm5.defines':
3195517Snate@binkert.org            return self
3205517Snate@binkert.org
3215517Snate@binkert.org        if fullname == 'm5.objects':
3225517Snate@binkert.org            return self
3235517Snate@binkert.org
3245517Snate@binkert.org        if fullname.startswith('m5.internal'):
3255517Snate@binkert.org            return None
3265517Snate@binkert.org
3276143Snate@binkert.org        source = self.modules.get(fullname, None)
3286654Snate@binkert.org        if source is not None and fullname.startswith('m5.objects'):
3295517Snate@binkert.org            return self
3305517Snate@binkert.org
3315517Snate@binkert.org        return None
3325517Snate@binkert.org
3335517Snate@binkert.org    def load_module(self, fullname):
3345517Snate@binkert.org        mod = imp.new_module(fullname)
3355517Snate@binkert.org        sys.modules[fullname] = mod
3365517Snate@binkert.org        self.installed.add(fullname)
3375517Snate@binkert.org
3385517Snate@binkert.org        mod.__loader__ = self
3395517Snate@binkert.org        if fullname == 'm5.objects':
3405517Snate@binkert.org            mod.__path__ = fullname.split('.')
3415517Snate@binkert.org            return mod
3425517Snate@binkert.org
3436654Snate@binkert.org        if fullname == 'm5.defines':
3446654Snate@binkert.org            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
3455517Snate@binkert.org            return mod
3465517Snate@binkert.org
3476143Snate@binkert.org        source = self.modules[fullname]
3486143Snate@binkert.org        if source.modname == '__init__':
3496143Snate@binkert.org            mod.__path__ = source.modpath
3506727Ssteve.reinhardt@amd.com        mod.__file__ = source.abspath
3515517Snate@binkert.org
3526727Ssteve.reinhardt@amd.com        exec file(source.abspath, 'r') in mod.__dict__
3535517Snate@binkert.org
3545517Snate@binkert.org        return mod
3555517Snate@binkert.org
3566654Snate@binkert.orgimport m5.SimObject
3576654Snate@binkert.orgimport m5.params
3587673Snate@binkert.orgfrom m5.util import code_formatter
3596654Snate@binkert.org
3606654Snate@binkert.orgm5.SimObject.clear()
3616654Snate@binkert.orgm5.params.clear()
3626654Snate@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
3655517Snate@binkert.org# else we won't know about them for the rest of the stuff.
3666143Snate@binkert.orgimporter = DictImporter(PySource.modules)
3675517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
3684762Snate@binkert.org
3695517Snate@binkert.org# import all sim objects so we can populate the all_objects list
3705517Snate@binkert.org# make sure that we're working with a list, then let's sort it
3716143Snate@binkert.orgfor modname in SimObject.modnames:
3726143Snate@binkert.org    exec('from m5.objects import %s' % modname)
3735517Snate@binkert.org
3745517Snate@binkert.org# we need to unload all of the currently imported modules so that they
3755517Snate@binkert.org# will be re-imported the next time the sconscript is run
3765517Snate@binkert.orgimporter.unload()
3775517Snate@binkert.orgsys.meta_path.remove(importer)
3785517Snate@binkert.org
3795517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
3805517Snate@binkert.orgall_enums = m5.params.allEnums
3815517Snate@binkert.org
3825517Snate@binkert.orgall_params = {}
3836143Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()):
3845517Snate@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
3915517Snate@binkert.org        if not hasattr(param, 'swig_decl'):
3925517Snate@binkert.org            continue
3935517Snate@binkert.org        pname = param.ptype_str
3945517Snate@binkert.org        if pname not in all_params:
3955517Snate@binkert.org            all_params[pname] = param
3964762Snate@binkert.org
3974762Snate@binkert.org########################################################################
3984762Snate@binkert.org#
3994762Snate@binkert.org# calculate extra dependencies
4004762Snate@binkert.org#
4014762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
4027675Snate@binkert.orgdepends = [ PySource.modules[dep].snode for dep in module_depends ]
4034762Snate@binkert.org
4044762Snate@binkert.org########################################################################
4054762Snate@binkert.org#
4064762Snate@binkert.org# Commands for the basic automatically generated python files
4074382Sbinkertn@umich.edu#
4084382Sbinkertn@umich.edu
4095517Snate@binkert.org# Generate Python file containing a dict specifying the current
4106654Snate@binkert.org# buildEnv flags.
4115517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
4125798Snate@binkert.org    build_env, hg_info = [ x.get_contents() for x in source ]
4136654Snate@binkert.org
4147673Snate@binkert.org    code = code_formatter()
4156654Snate@binkert.org    code("""
4166654Snate@binkert.orgimport m5.internal
4176654Snate@binkert.orgimport m5.util
4186654Snate@binkert.org
4196654Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env)
4206654Snate@binkert.orghgRev = '$hg_info'
4216654Snate@binkert.org
4226654Snate@binkert.orgcompileDate = m5.internal.core.compileDate
4236669Snate@binkert.org_globals = globals()
4246669Snate@binkert.orgfor key,val in m5.internal.core.__dict__.iteritems():
4256669Snate@binkert.org    if key.startswith('flag_'):
4266669Snate@binkert.org        flag = key[5:]
4276669Snate@binkert.org        _globals[flag] = val
4286669Snate@binkert.orgdel _globals
4296654Snate@binkert.org""")
4307673Snate@binkert.org    code.write(target[0].abspath)
4315517Snate@binkert.org
4325863Snate@binkert.orgdefines_info = [ Value(build_env), Value(env['HG_INFO']) ]
4335798Snate@binkert.org# Generate a file with all of the compile options in it
4345798Snate@binkert.orgenv.Command('python/m5/defines.py', defines_info, makeDefinesPyFile)
4355798Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
4365798Snate@binkert.org
4375517Snate@binkert.org# Generate python file containing info about the M5 source code
4385517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
4397673Snate@binkert.org    code = code_formatter()
4405517Snate@binkert.org    for src in source:
4415517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
4427673Snate@binkert.org        code('$src = ${{repr(data)}}')
4437673Snate@binkert.org    code.write(str(target[0]))
4445517Snate@binkert.org
4455798Snate@binkert.org# Generate a file that wraps the basic top level files
4465798Snate@binkert.orgenv.Command('python/m5/info.py',
4475798Snate@binkert.org            [ '#/AUTHORS', '#/LICENSE', '#/README', '#/RELEASE_NOTES' ],
4485798Snate@binkert.org            makeInfoPyFile)
4495798Snate@binkert.orgPySource('m5', 'python/m5/info.py')
4505798Snate@binkert.org
4514762Snate@binkert.org########################################################################
4524762Snate@binkert.org#
4534762Snate@binkert.org# Create all of the SimObject param headers and enum headers
4544762Snate@binkert.org#
4554762Snate@binkert.org
4565517Snate@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
4627673Snate@binkert.org    code = code_formatter()
4637673Snate@binkert.org    obj.cxx_decl(code)
4647673Snate@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
4727673Snate@binkert.org    code = code_formatter()
4737677Snate@binkert.org    code('%module(package="m5.internal") $0_${name}', param.file_ext)
4747673Snate@binkert.org    param.swig_decl(code)
4757673Snate@binkert.org    code.write(target[0].abspath)
4765517Snate@binkert.org
4775517Snate@binkert.orgdef createEnumStrings(target, source, env):
4785517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4795517Snate@binkert.org
4805517Snate@binkert.org    name = str(source[0].get_contents())
4815517Snate@binkert.org    obj = all_enums[name]
4825517Snate@binkert.org
4837673Snate@binkert.org    code = code_formatter()
4847673Snate@binkert.org    obj.cxx_def(code)
4857673Snate@binkert.org    code.write(target[0].abspath)
4865517Snate@binkert.org
4875517Snate@binkert.orgdef createEnumParam(target, source, env):
4885517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4895517Snate@binkert.org
4905517Snate@binkert.org    name = str(source[0].get_contents())
4915517Snate@binkert.org    obj = all_enums[name]
4925517Snate@binkert.org
4937673Snate@binkert.org    code = code_formatter()
4947673Snate@binkert.org    obj.cxx_decl(code)
4957673Snate@binkert.org    code.write(target[0].abspath)
4965517Snate@binkert.org
4977675Snate@binkert.orgdef createEnumSwig(target, source, env):
4987675Snate@binkert.org    assert len(target) == 1 and len(source) == 1
4997675Snate@binkert.org
5007675Snate@binkert.org    name = str(source[0].get_contents())
5017675Snate@binkert.org    obj = all_enums[name]
5027675Snate@binkert.org
5037675Snate@binkert.org    code = code_formatter()
5047675Snate@binkert.org    code('''\
5057677Snate@binkert.org%module(package="m5.internal") enum_$name
5067675Snate@binkert.org
5077675Snate@binkert.org%{
5087675Snate@binkert.org#include "enums/$name.hh"
5097675Snate@binkert.org%}
5107675Snate@binkert.org
5117675Snate@binkert.org%include "enums/$name.hh"
5127675Snate@binkert.org''')
5137675Snate@binkert.org    code.write(target[0].abspath)
5147675Snate@binkert.org
5154762Snate@binkert.org# Generate all of the SimObject param struct header files
5164762Snate@binkert.orgparams_hh_files = []
5176143Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()):
5186143Snate@binkert.org    py_source = PySource.modules[simobj.__module__]
5196143Snate@binkert.org    extra_deps = [ py_source.tnode ]
5204762Snate@binkert.org
5214762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
5224762Snate@binkert.org    params_hh_files.append(hh_file)
5235517Snate@binkert.org    env.Command(hh_file, Value(name), createSimObjectParam)
5244762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
5254762Snate@binkert.org
5264762Snate@binkert.org# Generate any parameter header files needed
5275463Snate@binkert.orgparams_i_files = []
5285517Snate@binkert.orgfor name,param in all_params.iteritems():
5297677Snate@binkert.org    i_file = File('python/m5/internal/%s_%s.i' % (param.file_ext, name))
5305463Snate@binkert.org    params_i_files.append(i_file)
5315517Snate@binkert.org    env.Command(i_file, Value(name), createSwigParam)
5324762Snate@binkert.org    env.Depends(i_file, depends)
5337677Snate@binkert.org    SwigSource('m5.internal', i_file)
5344762Snate@binkert.org
5354762Snate@binkert.org# Generate all enum header files
5366143Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()):
5376143Snate@binkert.org    py_source = PySource.modules[enum.__module__]
5386143Snate@binkert.org    extra_deps = [ py_source.tnode ]
5394762Snate@binkert.org
5404762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
5415517Snate@binkert.org    env.Command(cc_file, Value(name), createEnumStrings)
5424762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
5434762Snate@binkert.org    Source(cc_file)
5444762Snate@binkert.org
5454762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
5465517Snate@binkert.org    env.Command(hh_file, Value(name), createEnumParam)
5474762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
5484762Snate@binkert.org
5497677Snate@binkert.org    i_file = File('python/m5/internal/enum_%s.i' % name)
5507675Snate@binkert.org    env.Command(i_file, Value(name), createEnumSwig)
5517675Snate@binkert.org    env.Depends(i_file, depends + extra_deps)
5527677Snate@binkert.org    SwigSource('m5.internal', i_file)
5535517Snate@binkert.org
5547675Snate@binkert.orgdef buildParam(target, source, env):
5557675Snate@binkert.org    name = source[0].get_contents()
5567675Snate@binkert.org    obj = sim_objects[name]
5577675Snate@binkert.org    class_path = obj.cxx_class.split('::')
5587675Snate@binkert.org    classname = class_path[-1]
5597675Snate@binkert.org    namespaces = class_path[:-1]
5607675Snate@binkert.org    params = obj._params.local.values()
5615517Snate@binkert.org
5627673Snate@binkert.org    code = code_formatter()
5635517Snate@binkert.org
5647677Snate@binkert.org    code('%module(package="m5.internal") param_$name')
5657675Snate@binkert.org    code()
5667673Snate@binkert.org    code('%{')
5677675Snate@binkert.org    code('#include "params/$obj.hh"')
5687675Snate@binkert.org    for param in params:
5697675Snate@binkert.org        param.cxx_predecls(code)
5707673Snate@binkert.org    code('%}')
5717675Snate@binkert.org    code()
5725517Snate@binkert.org
5737675Snate@binkert.org    for param in params:
5747675Snate@binkert.org        param.swig_predecls(code)
5757673Snate@binkert.org
5767675Snate@binkert.org    code()
5777675Snate@binkert.org    if obj._base:
5787677Snate@binkert.org        code('%import "python/m5/internal/param_${{obj._base}}.i"')
5797675Snate@binkert.org    code()
5807675Snate@binkert.org    obj.swig_objdecls(code)
5817675Snate@binkert.org    code()
5825517Snate@binkert.org
5837675Snate@binkert.org    code('%include "params/$obj.hh"')
5845517Snate@binkert.org
5857673Snate@binkert.org    code.write(target[0].abspath)
5865517Snate@binkert.org
5877675Snate@binkert.orgfor name in sim_objects.iterkeys():
5887677Snate@binkert.org    params_file = File('python/m5/internal/param_%s.i' % name)
5897675Snate@binkert.org    env.Command(params_file, Value(name), buildParam)
5907675Snate@binkert.org    env.Depends(params_file, depends)
5917677Snate@binkert.org    SwigSource('m5.internal', params_file)
5924762Snate@binkert.org
5937674Snate@binkert.org# Generate the main swig init file
5947674Snate@binkert.orgdef makeEmbeddedSwigInit(target, source, env):
5957674Snate@binkert.org    code = code_formatter()
5967674Snate@binkert.org    module = source[0].get_contents()
5977674Snate@binkert.org    code('''\
5987674Snate@binkert.org#include "sim/init.hh"
5997674Snate@binkert.org
6007674Snate@binkert.orgextern "C" {
6017674Snate@binkert.org    void init_${module}();
6027674Snate@binkert.org}
6037674Snate@binkert.org
6047674Snate@binkert.orgEmbeddedSwig embed_swig_${module}(init_${module});
6057674Snate@binkert.org''')
6067674Snate@binkert.org    code.write(str(target[0]))
6077674Snate@binkert.org    
6084762Snate@binkert.org# Build all swig modules
6096143Snate@binkert.orgfor swig in SwigSource.all:
6106143Snate@binkert.org    env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
6114382Sbinkertn@umich.edu                '$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
6124382Sbinkertn@umich.edu                '-o ${TARGETS[0]} $SOURCES')
6137674Snate@binkert.org    init_file = 'python/swig/init_%s.cc' % swig.module
6147674Snate@binkert.org    env.Command(init_file, Value(swig.module), makeEmbeddedSwigInit)
6157674Snate@binkert.org    Source(init_file)
6166143Snate@binkert.org    env.Depends(swig.py_source.tnode, swig.tnode)
6176143Snate@binkert.org    env.Depends(swig.cc_source.tnode, swig.tnode)
6184382Sbinkertn@umich.edu
6196229Snate@binkert.orgdef getFlags(source_flags):
6206229Snate@binkert.org    flagsMap = {}
6216229Snate@binkert.org    flagsList = []
6226229Snate@binkert.org    for s in source_flags:
6236229Snate@binkert.org        val = eval(s.get_contents())
6246229Snate@binkert.org        name, compound, desc = val
6256229Snate@binkert.org        flagsList.append(val)
6266229Snate@binkert.org        flagsMap[name] = bool(compound)
6276229Snate@binkert.org    
6286229Snate@binkert.org    for name, compound, desc in flagsList:
6296229Snate@binkert.org        for flag in compound:
6306229Snate@binkert.org            if flag not in flagsMap:
6316229Snate@binkert.org                raise AttributeError, "Trace flag %s not found" % flag
6326229Snate@binkert.org            if flagsMap[flag]:
6336229Snate@binkert.org                raise AttributeError, \
6346229Snate@binkert.org                    "Compound flag can't point to another compound flag"
6356229Snate@binkert.org
6366229Snate@binkert.org    flagsList.sort()
6376229Snate@binkert.org    return flagsList
6386229Snate@binkert.org
6396229Snate@binkert.org
6405192Ssaidi@eecs.umich.edu# Generate traceflags.py
6415517Snate@binkert.orgdef traceFlagsPy(target, source, env):
6425517Snate@binkert.org    assert(len(target) == 1)
6437673Snate@binkert.org    code = code_formatter()
6445517Snate@binkert.org
6456229Snate@binkert.org    allFlags = getFlags(source)
6465799Snate@binkert.org
6477673Snate@binkert.org    code('basic = [')
6487673Snate@binkert.org    code.indent()
6495517Snate@binkert.org    for flag, compound, desc in allFlags:
6505517Snate@binkert.org        if not compound:
6517673Snate@binkert.org            code("'$flag',")
6527673Snate@binkert.org    code(']')
6537673Snate@binkert.org    code.dedent()
6547673Snate@binkert.org    code()
6555517Snate@binkert.org
6567673Snate@binkert.org    code('compound = [')
6577673Snate@binkert.org    code.indent()
6587673Snate@binkert.org    code("'All',")
6595517Snate@binkert.org    for flag, compound, desc in allFlags:
6605517Snate@binkert.org        if compound:
6617673Snate@binkert.org            code("'$flag',")
6627673Snate@binkert.org    code("]")
6637673Snate@binkert.org    code.dedent()
6647673Snate@binkert.org    code()
6655517Snate@binkert.org
6667673Snate@binkert.org    code("all = frozenset(basic + compound)")
6677673Snate@binkert.org    code()
6685517Snate@binkert.org
6697673Snate@binkert.org    code('compoundMap = {')
6707673Snate@binkert.org    code.indent()
6715517Snate@binkert.org    all = tuple([flag for flag,compound,desc in allFlags if not compound])
6727673Snate@binkert.org    code("'All' : $all,")
6735517Snate@binkert.org    for flag, compound, desc in allFlags:
6745517Snate@binkert.org        if compound:
6757673Snate@binkert.org            code("'$flag' : $compound,")
6767673Snate@binkert.org    code('}')
6777673Snate@binkert.org    code.dedent()
6787673Snate@binkert.org    code()
6795517Snate@binkert.org
6807673Snate@binkert.org    code('descriptions = {')
6817673Snate@binkert.org    code.indent()
6827673Snate@binkert.org    code("'All' : 'All flags',")
6835517Snate@binkert.org    for flag, compound, desc in allFlags:
6847673Snate@binkert.org        code("'$flag' : '$desc',")
6857673Snate@binkert.org    code("}")
6867673Snate@binkert.org    code.dedent()
6875517Snate@binkert.org
6887673Snate@binkert.org    code.write(str(target[0]))
6895517Snate@binkert.org
6905517Snate@binkert.orgdef traceFlagsCC(target, source, env):
6915517Snate@binkert.org    assert(len(target) == 1)
6925517Snate@binkert.org
6936229Snate@binkert.org    allFlags = getFlags(source)
6947673Snate@binkert.org    code = code_formatter()
6955517Snate@binkert.org
6965517Snate@binkert.org    # file header
6977673Snate@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
7045517Snate@binkert.orgusing namespace Trace;
7055517Snate@binkert.org
7065517Snate@binkert.orgconst char *Trace::flagStrings[] =
7077673Snate@binkert.org{''')
7085517Snate@binkert.org
7097673Snate@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:
7147673Snate@binkert.org            code('"$flag",')
7155517Snate@binkert.org
7167673Snate@binkert.org    code('"All",')
7175517Snate@binkert.org    for flag, compound, desc in allFlags:
7185517Snate@binkert.org        if compound:
7197673Snate@binkert.org            code('"$flag",')
7207673Snate@binkert.org    code.dedent()
7215517Snate@binkert.org
7227673Snate@binkert.org    code('''\
7237673Snate@binkert.org};
7245517Snate@binkert.org
7257673Snate@binkert.orgconst int Trace::numFlagStrings = ${{len(allFlags) + 1}};
7267673Snate@binkert.org
7277673Snate@binkert.org''')
7287673Snate@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])
7327673Snate@binkert.org    code('static const Flags AllMap[] = {')
7337673Snate@binkert.org    code.indent()
7345517Snate@binkert.org    for flag, compound, desc in allFlags:
7355517Snate@binkert.org        if not compound:
7367673Snate@binkert.org            code('$flag,')
7377673Snate@binkert.org    code.dedent()
7387673Snate@binkert.org    code('};')
7397673Snate@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
7447673Snate@binkert.org        code('static const Flags ${flag}Map[] = {')
7457673Snate@binkert.org        code.indent()
7465517Snate@binkert.org        for flag in compound:
7477673Snate@binkert.org            code('$flag,')
7487673Snate@binkert.org        code('(Flags)-1')
7497673Snate@binkert.org        code.dedent()
7507673Snate@binkert.org        code('};')
7517673Snate@binkert.org        code()
7525517Snate@binkert.org
7535517Snate@binkert.org    # Finally the compoundFlags[] array maps the compound flags
7545517Snate@binkert.org    # to their individual arrays/
7557673Snate@binkert.org    code('const Flags *Trace::compoundFlags[] = {')
7567673Snate@binkert.org    code.indent()
7577673Snate@binkert.org    code('AllMap,')
7585517Snate@binkert.org    for flag, compound, desc in allFlags:
7595517Snate@binkert.org        if compound:
7607673Snate@binkert.org            code('${flag}Map,')
7615517Snate@binkert.org    # file trailer
7627673Snate@binkert.org    code.dedent()
7637673Snate@binkert.org    code('};')
7645517Snate@binkert.org
7657673Snate@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
7706229Snate@binkert.org    allFlags = getFlags(source)
7717673Snate@binkert.org    code = code_formatter()
7725517Snate@binkert.org
7735517Snate@binkert.org    # file header boilerplate
7747673Snate@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
7867673Snate@binkert.orgenum Flags {''')
7875517Snate@binkert.org
7885517Snate@binkert.org    # Generate the enum.  Base flags come first, then compound flags.
7895517Snate@binkert.org    idx = 0
7907673Snate@binkert.org    code.indent()
7915517Snate@binkert.org    for flag, compound, desc in allFlags:
7925517Snate@binkert.org        if not compound:
7937673Snate@binkert.org            code('$flag = $idx,')
7945517Snate@binkert.org            idx += 1
7955517Snate@binkert.org
7965517Snate@binkert.org    numBaseFlags = idx
7977673Snate@binkert.org    code('NumFlags = $idx,')
7987673Snate@binkert.org    code.dedent()
7997673Snate@binkert.org    code()
8005517Snate@binkert.org
8015517Snate@binkert.org    # put a comment in here to separate base from compound flags
8027673Snate@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
8057673Snate@binkert.org// flags, and are used by changeFlag.''')
8065517Snate@binkert.org
8077673Snate@binkert.org    code.indent()
8087673Snate@binkert.org    code('All = $idx,')
8095517Snate@binkert.org    idx += 1
8105517Snate@binkert.org    for flag, compound, desc in allFlags:
8115517Snate@binkert.org        if compound:
8127673Snate@binkert.org            code('$flag = $idx,')
8135517Snate@binkert.org            idx += 1
8145517Snate@binkert.org
8155517Snate@binkert.org    numCompoundFlags = idx - numBaseFlags
8167673Snate@binkert.org    code('NumCompoundFlags = $numCompoundFlags')
8177673Snate@binkert.org    code.dedent()
8185517Snate@binkert.org
8195517Snate@binkert.org    # trailer boilerplate
8207673Snate@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__
8347673Snate@binkert.org''')
8355517Snate@binkert.org
8367673Snate@binkert.org    code.write(str(target[0]))
8375517Snate@binkert.org
8386143Snate@binkert.orgflags = map(Value, trace_flags.values())
8395517Snate@binkert.orgenv.Command('base/traceflags.py', flags, traceFlagsPy)
8405192Ssaidi@eecs.umich.eduPySource('m5', 'base/traceflags.py')
8415192Ssaidi@eecs.umich.edu
8425517Snate@binkert.orgenv.Command('base/traceflags.hh', flags, traceFlagsHH)
8435517Snate@binkert.orgenv.Command('base/traceflags.cc', flags, traceFlagsCC)
8445192Ssaidi@eecs.umich.eduSource('base/traceflags.cc')
8455192Ssaidi@eecs.umich.edu
8467674Snate@binkert.org# Embed python files.  All .py files that have been indicated by a
8475522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
8485522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
8497674Snate@binkert.org# byte code, compress it, and then generate a c++ file that
8507674Snate@binkert.org# inserts the result into an array.
8517674Snate@binkert.orgdef embedPyFile(target, source, env):
8527674Snate@binkert.org    def c_str(string):
8537674Snate@binkert.org        if string is None:
8547674Snate@binkert.org            return "0"
8557674Snate@binkert.org        return '"%s"' % string
8567674Snate@binkert.org
8575522Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
8585522Snate@binkert.org    it, compress it, and stick it into an asm file so the code appears
8595522Snate@binkert.org    as just bytes with a label in the data section'''
8605517Snate@binkert.org
8615522Snate@binkert.org    src = file(str(source[0]), 'r').read()
8625517Snate@binkert.org
8636143Snate@binkert.org    pysource = PySource.tnodes[source[0]]
8646727Ssteve.reinhardt@amd.com    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
8687674Snate@binkert.org    sym = pysource.symname
8695517Snate@binkert.org
8707673Snate@binkert.org    code = code_formatter()
8717673Snate@binkert.org    code('''\
8727674Snate@binkert.org#include "sim/init.hh"
8737673Snate@binkert.org
8747674Snate@binkert.orgnamespace {
8757674Snate@binkert.org
8767674Snate@binkert.orgconst char data_${sym}[] = {
8777674Snate@binkert.org''')
8787674Snate@binkert.org    code.indent()
8797674Snate@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])
8827674Snate@binkert.org        code(''.join('%d,' % d for d in x))
8837674Snate@binkert.org    code.dedent()
8847674Snate@binkert.org    
8857674Snate@binkert.org    code('''};
8867673Snate@binkert.org
8877674Snate@binkert.orgEmbeddedPython embedded_${sym}(
8887674Snate@binkert.org    ${{c_str(pysource.arcname)}},
8897674Snate@binkert.org    ${{c_str(pysource.abspath)}},
8907674Snate@binkert.org    ${{c_str(pysource.modpath)}},
8917674Snate@binkert.org    data_${sym},
8927674Snate@binkert.org    ${{len(data)}},
8937674Snate@binkert.org    ${{len(marshalled)}});
8947674Snate@binkert.org
8957674Snate@binkert.org/* namespace */ }
8967674Snate@binkert.org''')
8977673Snate@binkert.org    code.write(str(target[0]))
8985522Snate@binkert.org
8996143Snate@binkert.orgfor source in PySource.all:
9007674Snate@binkert.org    env.Command(source.cpp, source.tnode, embedPyFile)
9017674Snate@binkert.org    Source(source.cpp)
9024382Sbinkertn@umich.edu
9034382Sbinkertn@umich.edu########################################################################
9044382Sbinkertn@umich.edu#
9054382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
9064382Sbinkertn@umich.edu# a slightly different build environment.
9074382Sbinkertn@umich.edu#
9084382Sbinkertn@umich.edu
9094382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
9104382Sbinkertn@umich.eduenvList = []
9114382Sbinkertn@umich.edu
9126143Snate@binkert.orgdate_source = Source('base/date.cc', skip_lib=True)
913955SN/A
9142655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
9152655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
9162655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
9172655Sstever@eecs.umich.edu# build environment vars.
9182655Sstever@eecs.umich.edudef makeEnv(label, objsfx, strip = False, **kwargs):
9195601Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
9205601Snate@binkert.org    # name.  Use '_' instead.
9215601Snate@binkert.org    libname = 'm5_' + label
9225601Snate@binkert.org    exename = 'm5.' + label
9235522Snate@binkert.org
9245863Snate@binkert.org    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
9255601Snate@binkert.org    new_env.Label = label
9265601Snate@binkert.org    new_env.Append(**kwargs)
9275601Snate@binkert.org
9285863Snate@binkert.org    swig_env = new_env.Clone()
9296143Snate@binkert.org    swig_env.Append(CCFLAGS='-Werror')
9305559Snate@binkert.org    if env['GCC']:
9315559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-uninitialized')
9325559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-sign-compare')
9335559Snate@binkert.org        swig_env.Append(CCFLAGS='-Wno-parentheses')
9345601Snate@binkert.org
9356143Snate@binkert.org    werror_env = new_env.Clone()
9366143Snate@binkert.org    werror_env.Append(CCFLAGS='-Werror')
9376143Snate@binkert.org
9386143Snate@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
9436143Snate@binkert.org        if source.swig:
9446143Snate@binkert.org            env = swig_env
9456143Snate@binkert.org        elif source.Werror:
9466143Snate@binkert.org            env = werror_env
9476143Snate@binkert.org        else:
9486143Snate@binkert.org            env = new_env
9496143Snate@binkert.org
9506143Snate@binkert.org        if static:
9516143Snate@binkert.org            obj = env.StaticObject(source.tnode)
9526143Snate@binkert.org        else:
9536143Snate@binkert.org            obj = env.SharedObject(source.tnode)
9546143Snate@binkert.org
9556143Snate@binkert.org        if extra_deps:
9566143Snate@binkert.org            env.Depends(obj, extra_deps)
9576143Snate@binkert.org
9586143Snate@binkert.org        return obj
9596143Snate@binkert.org
9606143Snate@binkert.org    static_objs = [ make_obj(s, True) for s in Source.get(skip_lib=False)]
9616143Snate@binkert.org    shared_objs = [ make_obj(s, False) for s in Source.get(skip_lib=False)]
9626143Snate@binkert.org
9636143Snate@binkert.org    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
9646143Snate@binkert.org    static_objs.append(static_date)
9656143Snate@binkert.org    
9666143Snate@binkert.org    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
9676240Snate@binkert.org    shared_objs.append(shared_date)
9685554Snate@binkert.org
9695522Snate@binkert.org    # First make a library of everything but main() so other programs can
9705522Snate@binkert.org    # link against m5.
9715797Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
9725797Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
9735522Snate@binkert.org
9745584Snate@binkert.org    for target, sources in unit_tests:
9756143Snate@binkert.org        objs = [ make_obj(s, static=True) for s in sources ]
9765862Snate@binkert.org        new_env.Program("unittest/%s.%s" % (target, label), objs + static_objs)
9775584Snate@binkert.org
9785601Snate@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
9812655Sstever@eecs.umich.edu    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:
9874007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
9884596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
9894007Ssaidi@eecs.umich.edu        else:
9904596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
9916143Snate@binkert.org        targets = new_env.Command(exename, progname, cmd)
9925522Snate@binkert.org            
9935601Snate@binkert.org    new_env.M5Binary = targets[0]
9945601Snate@binkert.org    envList.append(new_env)
9952655Sstever@eecs.umich.edu
996955SN/A# Debug binary
9973918Ssaidi@eecs.umich.educcflags = {}
9983918Ssaidi@eecs.umich.eduif env['GCC']:
9993918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
10003918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-gstabs+'
10013918Ssaidi@eecs.umich.edu    else:
10023918Ssaidi@eecs.umich.edu        ccflags['debug'] = '-ggdb3'
10033918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O3'
10043918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-O3'
10053918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-O3 -g -pg'
10063918Ssaidi@eecs.umich.eduelif env['SUNCC']:
10073918Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g0'
10083918Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
10093918Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
10103918Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
10113940Ssaidi@eecs.umich.eduelif env['ICC']:
10123940Ssaidi@eecs.umich.edu    ccflags['debug'] = '-g -O0'
10133940Ssaidi@eecs.umich.edu    ccflags['opt'] = '-g -O'
10143942Ssaidi@eecs.umich.edu    ccflags['fast'] = '-fast'
10153940Ssaidi@eecs.umich.edu    ccflags['prof'] = '-fast -g -pg'
10163515Ssaidi@eecs.umich.eduelse:
10173918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
10184762Snate@binkert.org    Exit(1)
10193515Ssaidi@eecs.umich.edu
10202655Sstever@eecs.umich.edumakeEnv('debug', '.do',
10213918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['debug']),
10223619Sbinkertn@umich.edu        CPPDEFINES = ['DEBUG', 'TRACING_ON=1'])
1023955SN/A
1024955SN/A# Optimized binary
10252655Sstever@eecs.umich.edumakeEnv('opt', '.o',
10263918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['opt']),
10273619Sbinkertn@umich.edu        CPPDEFINES = ['TRACING_ON=1'])
1028955SN/A
1029955SN/A# "Fast" binary
10302655Sstever@eecs.umich.edumakeEnv('fast', '.fo', strip = True,
10313918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['fast']),
10323619Sbinkertn@umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'])
1033955SN/A
1034955SN/A# Profiled binary
10352655Sstever@eecs.umich.edumakeEnv('prof', '.po',
10363918Ssaidi@eecs.umich.edu        CCFLAGS = Split(ccflags['prof']),
10373683Sstever@eecs.umich.edu        CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
10382655Sstever@eecs.umich.edu        LINKFLAGS = '-pg')
10391869SN/A
10401869SN/AReturn('envList')
1041