SConscript revision 9930
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
448334Snate@binkert.org# This file defines how to build a particular configuration of gem5
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
548614Sgblack@eecs.umich.edufrom m5.util import code_formatter, compareVersions
557674Snate@binkert.org
566143Snate@binkert.org########################################################################
576143Snate@binkert.org# Code for adding source files of various types
586143Snate@binkert.org#
598233Snate@binkert.org# When specifying a source file of some type, a set of guards can be
608233Snate@binkert.org# specified for that file.  When get() is used to find the files, if
618233Snate@binkert.org# get specifies a set of filters, only files that match those filters
628233Snate@binkert.org# will be accepted (unspecified filters on files are assumed to be
638233Snate@binkert.org# false).  Current filters are:
648334Snate@binkert.org#     main -- specifies the gem5 main() function
658334Snate@binkert.org#     skip_lib -- do not put this file into the gem5 library
668233Snate@binkert.org#     <unittest> -- unit tests use filters based on the unit test name
678233Snate@binkert.org#
688233Snate@binkert.org# A parent can now be specified for a source file and default filter
698233Snate@binkert.org# values will be retrieved recursively from parents (children override
708233Snate@binkert.org# parents).
718233Snate@binkert.org#
726143Snate@binkert.orgclass SourceMeta(type):
738233Snate@binkert.org    '''Meta class for source files that keeps track of all files of a
748233Snate@binkert.org    particular type and has a get function for finding all functions
758233Snate@binkert.org    of a certain type that match a set of guards'''
766143Snate@binkert.org    def __init__(cls, name, bases, dict):
776143Snate@binkert.org        super(SourceMeta, cls).__init__(name, bases, dict)
786143Snate@binkert.org        cls.all = []
796143Snate@binkert.org        
808233Snate@binkert.org    def get(cls, **guards):
818233Snate@binkert.org        '''Find all files that match the specified guards.  If a source
828233Snate@binkert.org        file does not specify a flag, the default is False'''
836143Snate@binkert.org        for src in cls.all:
848233Snate@binkert.org            for flag,value in guards.iteritems():
858233Snate@binkert.org                # if the flag is found and has a different value, skip
868233Snate@binkert.org                # this file
878233Snate@binkert.org                if src.all_guards.get(flag, False) != value:
886143Snate@binkert.org                    break
896143Snate@binkert.org            else:
906143Snate@binkert.org                yield src
914762Snate@binkert.org
926143Snate@binkert.orgclass SourceFile(object):
938233Snate@binkert.org    '''Base object that encapsulates the notion of a source file.
948233Snate@binkert.org    This includes, the source node, target node, various manipulations
958233Snate@binkert.org    of those.  A source file also specifies a set of guards which
968233Snate@binkert.org    describing which builds the source file applies to.  A parent can
978233Snate@binkert.org    also be specified to get default guards from'''
986143Snate@binkert.org    __metaclass__ = SourceMeta
998233Snate@binkert.org    def __init__(self, source, parent=None, **guards):
1008233Snate@binkert.org        self.guards = guards
1018233Snate@binkert.org        self.parent = parent
1028233Snate@binkert.org
1036143Snate@binkert.org        tnode = source
1046143Snate@binkert.org        if not isinstance(source, SCons.Node.FS.File):
1056143Snate@binkert.org            tnode = File(source)
1066143Snate@binkert.org
1076143Snate@binkert.org        self.tnode = tnode
1086143Snate@binkert.org        self.snode = tnode.srcnode()
1096143Snate@binkert.org
1106143Snate@binkert.org        for base in type(self).__mro__:
1116143Snate@binkert.org            if issubclass(base, SourceFile):
1127065Snate@binkert.org                base.all.append(self)
1136143Snate@binkert.org
1148233Snate@binkert.org    @property
1158233Snate@binkert.org    def filename(self):
1168233Snate@binkert.org        return str(self.tnode)
1178233Snate@binkert.org
1188233Snate@binkert.org    @property
1198233Snate@binkert.org    def dirname(self):
1208233Snate@binkert.org        return dirname(self.filename)
1218233Snate@binkert.org
1228233Snate@binkert.org    @property
1238233Snate@binkert.org    def basename(self):
1248233Snate@binkert.org        return basename(self.filename)
1258233Snate@binkert.org
1268233Snate@binkert.org    @property
1278233Snate@binkert.org    def extname(self):
1288233Snate@binkert.org        index = self.basename.rfind('.')
1298233Snate@binkert.org        if index <= 0:
1308233Snate@binkert.org            # dot files aren't extensions
1318233Snate@binkert.org            return self.basename, None
1328233Snate@binkert.org
1338233Snate@binkert.org        return self.basename[:index], self.basename[index+1:]
1348233Snate@binkert.org
1358233Snate@binkert.org    @property
1368233Snate@binkert.org    def all_guards(self):
1378233Snate@binkert.org        '''find all guards for this object getting default values
1388233Snate@binkert.org        recursively from its parents'''
1398233Snate@binkert.org        guards = {}
1408233Snate@binkert.org        if self.parent:
1418233Snate@binkert.org            guards.update(self.parent.guards)
1428233Snate@binkert.org        guards.update(self.guards)
1438233Snate@binkert.org        return guards
1448233Snate@binkert.org
1456143Snate@binkert.org    def __lt__(self, other): return self.filename < other.filename
1466143Snate@binkert.org    def __le__(self, other): return self.filename <= other.filename
1476143Snate@binkert.org    def __gt__(self, other): return self.filename > other.filename
1486143Snate@binkert.org    def __ge__(self, other): return self.filename >= other.filename
1496143Snate@binkert.org    def __eq__(self, other): return self.filename == other.filename
1506143Snate@binkert.org    def __ne__(self, other): return self.filename != other.filename
1516143Snate@binkert.org        
1526143Snate@binkert.orgclass Source(SourceFile):
1536143Snate@binkert.org    '''Add a c/c++ source file to the build'''
1548945Ssteve.reinhardt@amd.com    def __init__(self, source, Werror=True, swig=False, **guards):
1558233Snate@binkert.org        '''specify the source file, and any guards'''
1568233Snate@binkert.org        super(Source, self).__init__(source, **guards)
1576143Snate@binkert.org
1588945Ssteve.reinhardt@amd.com        self.Werror = Werror
1596143Snate@binkert.org        self.swig = swig
1606143Snate@binkert.org
1616143Snate@binkert.orgclass PySource(SourceFile):
1626143Snate@binkert.org    '''Add a python source file to the named package'''
1635522Snate@binkert.org    invalid_sym_char = re.compile('[^A-z0-9_]')
1646143Snate@binkert.org    modules = {}
1656143Snate@binkert.org    tnodes = {}
1666143Snate@binkert.org    symnames = {}
1676143Snate@binkert.org    
1688233Snate@binkert.org    def __init__(self, package, source, **guards):
1698233Snate@binkert.org        '''specify the python package, the source file, and any guards'''
1708233Snate@binkert.org        super(PySource, self).__init__(source, **guards)
1716143Snate@binkert.org
1726143Snate@binkert.org        modname,ext = self.extname
1736143Snate@binkert.org        assert ext == 'py'
1746143Snate@binkert.org
1755522Snate@binkert.org        if package:
1765522Snate@binkert.org            path = package.split('.')
1775522Snate@binkert.org        else:
1785522Snate@binkert.org            path = []
1795604Snate@binkert.org
1805604Snate@binkert.org        modpath = path[:]
1816143Snate@binkert.org        if modname != '__init__':
1826143Snate@binkert.org            modpath += [ modname ]
1834762Snate@binkert.org        modpath = '.'.join(modpath)
1844762Snate@binkert.org
1856143Snate@binkert.org        arcpath = path + [ self.basename ]
1866727Ssteve.reinhardt@amd.com        abspath = self.snode.abspath
1876727Ssteve.reinhardt@amd.com        if not exists(abspath):
1886727Ssteve.reinhardt@amd.com            abspath = self.tnode.abspath
1894762Snate@binkert.org
1906143Snate@binkert.org        self.package = package
1916143Snate@binkert.org        self.modname = modname
1926143Snate@binkert.org        self.modpath = modpath
1936143Snate@binkert.org        self.arcname = joinpath(*arcpath)
1946727Ssteve.reinhardt@amd.com        self.abspath = abspath
1956143Snate@binkert.org        self.compiled = File(self.filename + 'c')
1967674Snate@binkert.org        self.cpp = File(self.filename + '.cc')
1977674Snate@binkert.org        self.symname = PySource.invalid_sym_char.sub('_', modpath)
1985604Snate@binkert.org
1996143Snate@binkert.org        PySource.modules[modpath] = self
2006143Snate@binkert.org        PySource.tnodes[self.tnode] = self
2016143Snate@binkert.org        PySource.symnames[self.symname] = self
2024762Snate@binkert.org
2036143Snate@binkert.orgclass SimObject(PySource):
2044762Snate@binkert.org    '''Add a SimObject python file as a python source object and add
2054762Snate@binkert.org    it to a list of sim object modules'''
2064762Snate@binkert.org
2076143Snate@binkert.org    fixed = False
2086143Snate@binkert.org    modnames = []
2094762Snate@binkert.org
2108233Snate@binkert.org    def __init__(self, source, **guards):
2118233Snate@binkert.org        '''Specify the source file and any guards (automatically in
2128233Snate@binkert.org        the m5.objects package)'''
2138233Snate@binkert.org        super(SimObject, self).__init__('m5.objects', source, **guards)
2146143Snate@binkert.org        if self.fixed:
2156143Snate@binkert.org            raise AttributeError, "Too late to call SimObject now."
2164762Snate@binkert.org
2176143Snate@binkert.org        bisect.insort_right(SimObject.modnames, self.modname)
2184762Snate@binkert.org
2196143Snate@binkert.orgclass SwigSource(SourceFile):
2204762Snate@binkert.org    '''Add a swig file to build'''
2216143Snate@binkert.org
2228233Snate@binkert.org    def __init__(self, package, source, **guards):
2238233Snate@binkert.org        '''Specify the python package, the source file, and any guards'''
2248233Snate@binkert.org        super(SwigSource, self).__init__(source, **guards)
2256143Snate@binkert.org
2266143Snate@binkert.org        modname,ext = self.extname
2276143Snate@binkert.org        assert ext == 'i'
2286143Snate@binkert.org
2296143Snate@binkert.org        self.module = modname
2306143Snate@binkert.org        cc_file = joinpath(self.dirname, modname + '_wrap.cc')
2316143Snate@binkert.org        py_file = joinpath(self.dirname, modname + '.py')
2326143Snate@binkert.org
2338233Snate@binkert.org        self.cc_source = Source(cc_file, swig=True, parent=self)
2348233Snate@binkert.org        self.py_source = PySource(package, py_file, parent=self)
235955SN/A
2369396Sandreas.hansson@arm.comclass ProtoBuf(SourceFile):
2379396Sandreas.hansson@arm.com    '''Add a Protocol Buffer to build'''
2389396Sandreas.hansson@arm.com
2399396Sandreas.hansson@arm.com    def __init__(self, source, **guards):
2409396Sandreas.hansson@arm.com        '''Specify the source file, and any guards'''
2419396Sandreas.hansson@arm.com        super(ProtoBuf, self).__init__(source, **guards)
2429396Sandreas.hansson@arm.com
2439396Sandreas.hansson@arm.com        # Get the file name and the extension
2449396Sandreas.hansson@arm.com        modname,ext = self.extname
2459396Sandreas.hansson@arm.com        assert ext == 'proto'
2469396Sandreas.hansson@arm.com
2479396Sandreas.hansson@arm.com        # Currently, we stick to generating the C++ headers, so we
2489396Sandreas.hansson@arm.com        # only need to track the source and header.
2499930Sandreas.hansson@arm.com        self.cc_file = File(modname + '.pb.cc')
2509930Sandreas.hansson@arm.com        self.hh_file = File(modname + '.pb.h')
2519396Sandreas.hansson@arm.com
2528235Snate@binkert.orgclass UnitTest(object):
2538235Snate@binkert.org    '''Create a UnitTest'''
2546143Snate@binkert.org
2558235Snate@binkert.org    all = []
2569003SAli.Saidi@ARM.com    def __init__(self, target, *sources, **kwargs):
2578235Snate@binkert.org        '''Specify the target name and any sources.  Sources that are
2588235Snate@binkert.org        not SourceFiles are evalued with Source().  All files are
2598235Snate@binkert.org        guarded with a guard of the same name as the UnitTest
2608235Snate@binkert.org        target.'''
2618235Snate@binkert.org
2628235Snate@binkert.org        srcs = []
2638235Snate@binkert.org        for src in sources:
2648235Snate@binkert.org            if not isinstance(src, SourceFile):
2658235Snate@binkert.org                src = Source(src, skip_lib=True)
2668235Snate@binkert.org            src.guards[target] = True
2678235Snate@binkert.org            srcs.append(src)
2688235Snate@binkert.org
2698235Snate@binkert.org        self.sources = srcs
2708235Snate@binkert.org        self.target = target
2719003SAli.Saidi@ARM.com        self.main = kwargs.get('main', False)
2728235Snate@binkert.org        UnitTest.all.append(self)
2735584Snate@binkert.org
2744382Sbinkertn@umich.edu# Children should have access
2754202Sbinkertn@umich.eduExport('Source')
2764382Sbinkertn@umich.eduExport('PySource')
2774382Sbinkertn@umich.eduExport('SimObject')
2784382Sbinkertn@umich.eduExport('SwigSource')
2799396Sandreas.hansson@arm.comExport('ProtoBuf')
2805584Snate@binkert.orgExport('UnitTest')
2814382Sbinkertn@umich.edu
2824382Sbinkertn@umich.edu########################################################################
2834382Sbinkertn@umich.edu#
2848232Snate@binkert.org# Debug Flags
2855192Ssaidi@eecs.umich.edu#
2868232Snate@binkert.orgdebug_flags = {}
2878232Snate@binkert.orgdef DebugFlag(name, desc=None):
2888232Snate@binkert.org    if name in debug_flags:
2895192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2908232Snate@binkert.org    debug_flags[name] = (name, (), desc)
2915192Ssaidi@eecs.umich.edu
2925799Snate@binkert.orgdef CompoundFlag(name, flags, desc=None):
2938232Snate@binkert.org    if name in debug_flags:
2945192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2955192Ssaidi@eecs.umich.edu
2965192Ssaidi@eecs.umich.edu    compound = tuple(flags)
2978232Snate@binkert.org    debug_flags[name] = (name, compound, desc)
2985192Ssaidi@eecs.umich.edu
2998232Snate@binkert.orgExport('DebugFlag')
3005192Ssaidi@eecs.umich.eduExport('CompoundFlag')
3015192Ssaidi@eecs.umich.edu
3025192Ssaidi@eecs.umich.edu########################################################################
3035192Ssaidi@eecs.umich.edu#
3044382Sbinkertn@umich.edu# Set some compiler variables
3054382Sbinkertn@umich.edu#
3064382Sbinkertn@umich.edu
3072667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
3082667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
3092667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
3102667Sstever@eecs.umich.edu# files.
3112667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
3122667Sstever@eecs.umich.edu
3135742Snate@binkert.orgfor extra_dir in extras_dir_list:
3145742Snate@binkert.org    env.Append(CPPPATH=Dir(extra_dir))
3155742Snate@binkert.org
3165793Snate@binkert.org# Workaround for bug in SCons version > 0.97d20071212
3178334Snate@binkert.org# Scons bug id: 2006 gem5 Bug id: 308
3185793Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
3195793Snate@binkert.org    Dir(root[len(base_dir) + 1:])
3205793Snate@binkert.org
3214382Sbinkertn@umich.edu########################################################################
3224762Snate@binkert.org#
3235344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories
3244382Sbinkertn@umich.edu#
3255341Sstever@gmail.com
3265742Snate@binkert.orghere = Dir('.').srcnode().abspath
3275742Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
3285742Snate@binkert.org    if root == here:
3295742Snate@binkert.org        # we don't want to recurse back into this SConscript
3305742Snate@binkert.org        continue
3314762Snate@binkert.org
3325742Snate@binkert.org    if 'SConscript' in files:
3335742Snate@binkert.org        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
3347722Sgblack@eecs.umich.edu        SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
3355742Snate@binkert.org
3365742Snate@binkert.orgfor extra_dir in extras_dir_list:
3375742Snate@binkert.org    prefix_len = len(dirname(extra_dir)) + 1
3389930Sandreas.hansson@arm.com
3399930Sandreas.hansson@arm.com    # Also add the corresponding build directory to pick up generated
3409930Sandreas.hansson@arm.com    # include files.
3419930Sandreas.hansson@arm.com    env.Append(CPPPATH=Dir(joinpath(env['BUILDDIR'], extra_dir[prefix_len:])))
3429930Sandreas.hansson@arm.com
3435742Snate@binkert.org    for root, dirs, files in os.walk(extra_dir, topdown=True):
3448242Sbradley.danofsky@amd.com        # if build lives in the extras directory, don't walk down it
3458242Sbradley.danofsky@amd.com        if 'build' in dirs:
3468242Sbradley.danofsky@amd.com            dirs.remove('build')
3478242Sbradley.danofsky@amd.com
3485341Sstever@gmail.com        if 'SConscript' in files:
3495742Snate@binkert.org            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
3507722Sgblack@eecs.umich.edu            SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
3514773Snate@binkert.org
3526108Snate@binkert.orgfor opt in export_vars:
3531858SN/A    env.ConfigFile(opt)
3541085SN/A
3556658Snate@binkert.orgdef makeTheISA(source, target, env):
3566658Snate@binkert.org    isas = [ src.get_contents() for src in source ]
3577673Snate@binkert.org    target_isa = env['TARGET_ISA']
3586658Snate@binkert.org    def define(isa):
3596658Snate@binkert.org        return isa.upper() + '_ISA'
3606658Snate@binkert.org    
3616658Snate@binkert.org    def namespace(isa):
3626658Snate@binkert.org        return isa[0].upper() + isa[1:].lower() + 'ISA' 
3636658Snate@binkert.org
3646658Snate@binkert.org
3657673Snate@binkert.org    code = code_formatter()
3667673Snate@binkert.org    code('''\
3677673Snate@binkert.org#ifndef __CONFIG_THE_ISA_HH__
3687673Snate@binkert.org#define __CONFIG_THE_ISA_HH__
3697673Snate@binkert.org
3707673Snate@binkert.org''')
3717673Snate@binkert.org
3726658Snate@binkert.org    for i,isa in enumerate(isas):
3737673Snate@binkert.org        code('#define $0 $1', define(isa), i + 1)
3747673Snate@binkert.org
3757673Snate@binkert.org    code('''
3767673Snate@binkert.org
3777673Snate@binkert.org#define THE_ISA ${{define(target_isa)}}
3787673Snate@binkert.org#define TheISA ${{namespace(target_isa)}}
3799048SAli.Saidi@ARM.com#define THE_ISA_STR "${{target_isa}}"
3807673Snate@binkert.org
3817673Snate@binkert.org#endif // __CONFIG_THE_ISA_HH__''')
3827673Snate@binkert.org
3837673Snate@binkert.org    code.write(str(target[0]))
3846658Snate@binkert.org
3857756SAli.Saidi@ARM.comenv.Command('config/the_isa.hh', map(Value, all_isa_list),
3867816Ssteve.reinhardt@amd.com            MakeAction(makeTheISA, Transform("CFG ISA", 0)))
3876658Snate@binkert.org
3884382Sbinkertn@umich.edu########################################################################
3894382Sbinkertn@umich.edu#
3904762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
3914762Snate@binkert.org# should all have been added in the SConscripts above
3924762Snate@binkert.org#
3936654Snate@binkert.orgSimObject.fixed = True
3946654Snate@binkert.org
3955517Snate@binkert.orgclass DictImporter(object):
3965517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
3975517Snate@binkert.org    map to arbitrary filenames.'''
3985517Snate@binkert.org    def __init__(self, modules):
3995517Snate@binkert.org        self.modules = modules
4005517Snate@binkert.org        self.installed = set()
4015517Snate@binkert.org
4025517Snate@binkert.org    def __del__(self):
4035517Snate@binkert.org        self.unload()
4045517Snate@binkert.org
4055517Snate@binkert.org    def unload(self):
4065517Snate@binkert.org        import sys
4075517Snate@binkert.org        for module in self.installed:
4085517Snate@binkert.org            del sys.modules[module]
4095517Snate@binkert.org        self.installed = set()
4105517Snate@binkert.org
4115517Snate@binkert.org    def find_module(self, fullname, path):
4126654Snate@binkert.org        if fullname == 'm5.defines':
4135517Snate@binkert.org            return self
4145517Snate@binkert.org
4155517Snate@binkert.org        if fullname == 'm5.objects':
4165517Snate@binkert.org            return self
4175517Snate@binkert.org
4185517Snate@binkert.org        if fullname.startswith('m5.internal'):
4195517Snate@binkert.org            return None
4205517Snate@binkert.org
4216143Snate@binkert.org        source = self.modules.get(fullname, None)
4226654Snate@binkert.org        if source is not None and fullname.startswith('m5.objects'):
4235517Snate@binkert.org            return self
4245517Snate@binkert.org
4255517Snate@binkert.org        return None
4265517Snate@binkert.org
4275517Snate@binkert.org    def load_module(self, fullname):
4285517Snate@binkert.org        mod = imp.new_module(fullname)
4295517Snate@binkert.org        sys.modules[fullname] = mod
4305517Snate@binkert.org        self.installed.add(fullname)
4315517Snate@binkert.org
4325517Snate@binkert.org        mod.__loader__ = self
4335517Snate@binkert.org        if fullname == 'm5.objects':
4345517Snate@binkert.org            mod.__path__ = fullname.split('.')
4355517Snate@binkert.org            return mod
4365517Snate@binkert.org
4376654Snate@binkert.org        if fullname == 'm5.defines':
4386654Snate@binkert.org            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
4395517Snate@binkert.org            return mod
4405517Snate@binkert.org
4416143Snate@binkert.org        source = self.modules[fullname]
4426143Snate@binkert.org        if source.modname == '__init__':
4436143Snate@binkert.org            mod.__path__ = source.modpath
4446727Ssteve.reinhardt@amd.com        mod.__file__ = source.abspath
4455517Snate@binkert.org
4466727Ssteve.reinhardt@amd.com        exec file(source.abspath, 'r') in mod.__dict__
4475517Snate@binkert.org
4485517Snate@binkert.org        return mod
4495517Snate@binkert.org
4506654Snate@binkert.orgimport m5.SimObject
4516654Snate@binkert.orgimport m5.params
4527673Snate@binkert.orgfrom m5.util import code_formatter
4536654Snate@binkert.org
4546654Snate@binkert.orgm5.SimObject.clear()
4556654Snate@binkert.orgm5.params.clear()
4566654Snate@binkert.org
4575517Snate@binkert.org# install the python importer so we can grab stuff from the source
4585517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
4595517Snate@binkert.org# else we won't know about them for the rest of the stuff.
4606143Snate@binkert.orgimporter = DictImporter(PySource.modules)
4615517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
4624762Snate@binkert.org
4635517Snate@binkert.org# import all sim objects so we can populate the all_objects list
4645517Snate@binkert.org# make sure that we're working with a list, then let's sort it
4656143Snate@binkert.orgfor modname in SimObject.modnames:
4666143Snate@binkert.org    exec('from m5.objects import %s' % modname)
4675517Snate@binkert.org
4685517Snate@binkert.org# we need to unload all of the currently imported modules so that they
4695517Snate@binkert.org# will be re-imported the next time the sconscript is run
4705517Snate@binkert.orgimporter.unload()
4715517Snate@binkert.orgsys.meta_path.remove(importer)
4725517Snate@binkert.org
4735517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
4745517Snate@binkert.orgall_enums = m5.params.allEnums
4755517Snate@binkert.org
4769338SAndreas.Sandberg@arm.comif m5.SimObject.noCxxHeader:
4779338SAndreas.Sandberg@arm.com    print >> sys.stderr, \
4789338SAndreas.Sandberg@arm.com        "warning: At least one SimObject lacks a header specification. " \
4799338SAndreas.Sandberg@arm.com        "This can cause unexpected results in the generated SWIG " \
4809338SAndreas.Sandberg@arm.com        "wrappers."
4819338SAndreas.Sandberg@arm.com
4828596Ssteve.reinhardt@amd.com# Find param types that need to be explicitly wrapped with swig.
4838596Ssteve.reinhardt@amd.com# These will be recognized because the ParamDesc will have a
4848596Ssteve.reinhardt@amd.com# swig_decl() method.  Most param types are based on types that don't
4858596Ssteve.reinhardt@amd.com# need this, either because they're based on native types (like Int)
4868596Ssteve.reinhardt@amd.com# or because they're SimObjects (which get swigged independently).
4878596Ssteve.reinhardt@amd.com# For now the only things handled here are VectorParam types.
4888596Ssteve.reinhardt@amd.comparams_to_swig = {}
4896143Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()):
4905517Snate@binkert.org    for param in obj._params.local.values():
4916654Snate@binkert.org        # load the ptype attribute now because it depends on the
4926654Snate@binkert.org        # current version of SimObject.allClasses, but when scons
4936654Snate@binkert.org        # actually uses the value, all versions of
4946654Snate@binkert.org        # SimObject.allClasses will have been loaded
4956654Snate@binkert.org        param.ptype
4966654Snate@binkert.org
4975517Snate@binkert.org        if not hasattr(param, 'swig_decl'):
4985517Snate@binkert.org            continue
4995517Snate@binkert.org        pname = param.ptype_str
5008596Ssteve.reinhardt@amd.com        if pname not in params_to_swig:
5018596Ssteve.reinhardt@amd.com            params_to_swig[pname] = param
5024762Snate@binkert.org
5034762Snate@binkert.org########################################################################
5044762Snate@binkert.org#
5054762Snate@binkert.org# calculate extra dependencies
5064762Snate@binkert.org#
5074762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
5087675Snate@binkert.orgdepends = [ PySource.modules[dep].snode for dep in module_depends ]
5094762Snate@binkert.org
5104762Snate@binkert.org########################################################################
5114762Snate@binkert.org#
5124762Snate@binkert.org# Commands for the basic automatically generated python files
5134382Sbinkertn@umich.edu#
5144382Sbinkertn@umich.edu
5155517Snate@binkert.org# Generate Python file containing a dict specifying the current
5166654Snate@binkert.org# buildEnv flags.
5175517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
5188126Sgblack@eecs.umich.edu    build_env = source[0].get_contents()
5196654Snate@binkert.org
5207673Snate@binkert.org    code = code_formatter()
5216654Snate@binkert.org    code("""
5226654Snate@binkert.orgimport m5.internal
5236654Snate@binkert.orgimport m5.util
5246654Snate@binkert.org
5256654Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env)
5266654Snate@binkert.org
5276654Snate@binkert.orgcompileDate = m5.internal.core.compileDate
5286669Snate@binkert.org_globals = globals()
5296669Snate@binkert.orgfor key,val in m5.internal.core.__dict__.iteritems():
5306669Snate@binkert.org    if key.startswith('flag_'):
5316669Snate@binkert.org        flag = key[5:]
5326669Snate@binkert.org        _globals[flag] = val
5336669Snate@binkert.orgdel _globals
5346654Snate@binkert.org""")
5357673Snate@binkert.org    code.write(target[0].abspath)
5365517Snate@binkert.org
5378126Sgblack@eecs.umich.edudefines_info = Value(build_env)
5385798Snate@binkert.org# Generate a file with all of the compile options in it
5397756SAli.Saidi@ARM.comenv.Command('python/m5/defines.py', defines_info,
5407816Ssteve.reinhardt@amd.com            MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
5415798Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
5425798Snate@binkert.org
5435517Snate@binkert.org# Generate python file containing info about the M5 source code
5445517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
5457673Snate@binkert.org    code = code_formatter()
5465517Snate@binkert.org    for src in source:
5475517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
5487673Snate@binkert.org        code('$src = ${{repr(data)}}')
5497673Snate@binkert.org    code.write(str(target[0]))
5505517Snate@binkert.org
5515798Snate@binkert.org# Generate a file that wraps the basic top level files
5525798Snate@binkert.orgenv.Command('python/m5/info.py',
5538333Snate@binkert.org            [ '#/COPYING', '#/LICENSE', '#/README', ],
5547816Ssteve.reinhardt@amd.com            MakeAction(makeInfoPyFile, Transform("INFO")))
5555798Snate@binkert.orgPySource('m5', 'python/m5/info.py')
5565798Snate@binkert.org
5574762Snate@binkert.org########################################################################
5584762Snate@binkert.org#
5594762Snate@binkert.org# Create all of the SimObject param headers and enum headers
5604762Snate@binkert.org#
5614762Snate@binkert.org
5628596Ssteve.reinhardt@amd.comdef createSimObjectParamStruct(target, source, env):
5635517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5645517Snate@binkert.org
5655517Snate@binkert.org    name = str(source[0].get_contents())
5665517Snate@binkert.org    obj = sim_objects[name]
5675517Snate@binkert.org
5687673Snate@binkert.org    code = code_formatter()
5698596Ssteve.reinhardt@amd.com    obj.cxx_param_decl(code)
5707673Snate@binkert.org    code.write(target[0].abspath)
5715517Snate@binkert.org
5728596Ssteve.reinhardt@amd.comdef createParamSwigWrapper(target, source, env):
5735517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5745517Snate@binkert.org
5755517Snate@binkert.org    name = str(source[0].get_contents())
5768596Ssteve.reinhardt@amd.com    param = params_to_swig[name]
5775517Snate@binkert.org
5787673Snate@binkert.org    code = code_formatter()
5797673Snate@binkert.org    param.swig_decl(code)
5807673Snate@binkert.org    code.write(target[0].abspath)
5815517Snate@binkert.org
5825517Snate@binkert.orgdef createEnumStrings(target, source, env):
5835517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5845517Snate@binkert.org
5855517Snate@binkert.org    name = str(source[0].get_contents())
5865517Snate@binkert.org    obj = all_enums[name]
5875517Snate@binkert.org
5887673Snate@binkert.org    code = code_formatter()
5897673Snate@binkert.org    obj.cxx_def(code)
5907673Snate@binkert.org    code.write(target[0].abspath)
5915517Snate@binkert.org
5928596Ssteve.reinhardt@amd.comdef createEnumDecls(target, source, env):
5935517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5945517Snate@binkert.org
5955517Snate@binkert.org    name = str(source[0].get_contents())
5965517Snate@binkert.org    obj = all_enums[name]
5975517Snate@binkert.org
5987673Snate@binkert.org    code = code_formatter()
5997673Snate@binkert.org    obj.cxx_decl(code)
6007673Snate@binkert.org    code.write(target[0].abspath)
6015517Snate@binkert.org
6028596Ssteve.reinhardt@amd.comdef createEnumSwigWrapper(target, source, env):
6037675Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6047675Snate@binkert.org
6057675Snate@binkert.org    name = str(source[0].get_contents())
6067675Snate@binkert.org    obj = all_enums[name]
6077675Snate@binkert.org
6087675Snate@binkert.org    code = code_formatter()
6098596Ssteve.reinhardt@amd.com    obj.swig_decl(code)
6107675Snate@binkert.org    code.write(target[0].abspath)
6117675Snate@binkert.org
6128596Ssteve.reinhardt@amd.comdef createSimObjectSwigWrapper(target, source, env):
6138596Ssteve.reinhardt@amd.com    name = source[0].get_contents()
6148596Ssteve.reinhardt@amd.com    obj = sim_objects[name]
6158596Ssteve.reinhardt@amd.com
6168596Ssteve.reinhardt@amd.com    code = code_formatter()
6178596Ssteve.reinhardt@amd.com    obj.swig_decl(code)
6188596Ssteve.reinhardt@amd.com    code.write(target[0].abspath)
6198596Ssteve.reinhardt@amd.com
6208596Ssteve.reinhardt@amd.com# Generate all of the SimObject param C++ struct header files
6214762Snate@binkert.orgparams_hh_files = []
6226143Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()):
6236143Snate@binkert.org    py_source = PySource.modules[simobj.__module__]
6246143Snate@binkert.org    extra_deps = [ py_source.tnode ]
6254762Snate@binkert.org
6264762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
6274762Snate@binkert.org    params_hh_files.append(hh_file)
6287756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
6298596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
6304762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
6314762Snate@binkert.org
6328596Ssteve.reinhardt@amd.com# Generate any needed param SWIG wrapper files
6335463Snate@binkert.orgparams_i_files = []
6348596Ssteve.reinhardt@amd.comfor name,param in params_to_swig.iteritems():
6358596Ssteve.reinhardt@amd.com    i_file = File('python/m5/internal/%s.i' % (param.swig_module_name()))
6365463Snate@binkert.org    params_i_files.append(i_file)
6377756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
6388596Ssteve.reinhardt@amd.com                MakeAction(createParamSwigWrapper, Transform("SW PARAM")))
6394762Snate@binkert.org    env.Depends(i_file, depends)
6407677Snate@binkert.org    SwigSource('m5.internal', i_file)
6414762Snate@binkert.org
6424762Snate@binkert.org# Generate all enum header files
6436143Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()):
6446143Snate@binkert.org    py_source = PySource.modules[enum.__module__]
6456143Snate@binkert.org    extra_deps = [ py_source.tnode ]
6464762Snate@binkert.org
6474762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
6487756SAli.Saidi@ARM.com    env.Command(cc_file, Value(name),
6497816Ssteve.reinhardt@amd.com                MakeAction(createEnumStrings, Transform("ENUM STR")))
6504762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
6514762Snate@binkert.org    Source(cc_file)
6524762Snate@binkert.org
6534762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
6547756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
6558596Ssteve.reinhardt@amd.com                MakeAction(createEnumDecls, Transform("ENUMDECL")))
6564762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
6574762Snate@binkert.org
6587677Snate@binkert.org    i_file = File('python/m5/internal/enum_%s.i' % name)
6597756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
6608596Ssteve.reinhardt@amd.com                MakeAction(createEnumSwigWrapper, Transform("ENUMSWIG")))
6617675Snate@binkert.org    env.Depends(i_file, depends + extra_deps)
6627677Snate@binkert.org    SwigSource('m5.internal', i_file)
6635517Snate@binkert.org
6648596Ssteve.reinhardt@amd.com# Generate SimObject SWIG wrapper files
6659248SAndreas.Sandberg@arm.comfor name,simobj in sim_objects.iteritems():
6669248SAndreas.Sandberg@arm.com    py_source = PySource.modules[simobj.__module__]
6679248SAndreas.Sandberg@arm.com    extra_deps = [ py_source.tnode ]
6689248SAndreas.Sandberg@arm.com
6698596Ssteve.reinhardt@amd.com    i_file = File('python/m5/internal/param_%s.i' % name)
6708596Ssteve.reinhardt@amd.com    env.Command(i_file, Value(name),
6718596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectSwigWrapper, Transform("SO SWIG")))
6729248SAndreas.Sandberg@arm.com    env.Depends(i_file, depends + extra_deps)
6738596Ssteve.reinhardt@amd.com    SwigSource('m5.internal', i_file)
6744762Snate@binkert.org
6757674Snate@binkert.org# Generate the main swig init file
6767674Snate@binkert.orgdef makeEmbeddedSwigInit(target, source, env):
6777674Snate@binkert.org    code = code_formatter()
6787674Snate@binkert.org    module = source[0].get_contents()
6797674Snate@binkert.org    code('''\
6807674Snate@binkert.org#include "sim/init.hh"
6817674Snate@binkert.org
6827674Snate@binkert.orgextern "C" {
6837674Snate@binkert.org    void init_${module}();
6847674Snate@binkert.org}
6857674Snate@binkert.org
6867674Snate@binkert.orgEmbeddedSwig embed_swig_${module}(init_${module});
6877674Snate@binkert.org''')
6887674Snate@binkert.org    code.write(str(target[0]))
6897674Snate@binkert.org    
6904762Snate@binkert.org# Build all swig modules
6916143Snate@binkert.orgfor swig in SwigSource.all:
6926143Snate@binkert.org    env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
6937756SAli.Saidi@ARM.com                MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
6947816Ssteve.reinhardt@amd.com                '-o ${TARGETS[0]} $SOURCES', Transform("SWIG")))
6958235Snate@binkert.org    cc_file = str(swig.tnode)
6968596Ssteve.reinhardt@amd.com    init_file = '%s/%s_init.cc' % (dirname(cc_file), basename(cc_file))
6977756SAli.Saidi@ARM.com    env.Command(init_file, Value(swig.module),
6987816Ssteve.reinhardt@amd.com                MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW")))
6998235Snate@binkert.org    Source(init_file, **swig.guards)
7004382Sbinkertn@umich.edu
7019396Sandreas.hansson@arm.com# Build all protocol buffers if we have got protoc and protobuf available
7029396Sandreas.hansson@arm.comif env['HAVE_PROTOBUF']:
7039396Sandreas.hansson@arm.com    for proto in ProtoBuf.all:
7049396Sandreas.hansson@arm.com        # Use both the source and header as the target, and the .proto
7059396Sandreas.hansson@arm.com        # file as the source. When executing the protoc compiler, also
7069396Sandreas.hansson@arm.com        # specify the proto_path to avoid having the generated files
7079396Sandreas.hansson@arm.com        # include the path.
7089396Sandreas.hansson@arm.com        env.Command([proto.cc_file, proto.hh_file], proto.tnode,
7099396Sandreas.hansson@arm.com                    MakeAction('$PROTOC --cpp_out ${TARGET.dir} '
7109396Sandreas.hansson@arm.com                               '--proto_path ${SOURCE.dir} $SOURCE',
7119396Sandreas.hansson@arm.com                               Transform("PROTOC")))
7129396Sandreas.hansson@arm.com
7139396Sandreas.hansson@arm.com        # Add the C++ source file
7149396Sandreas.hansson@arm.com        Source(proto.cc_file, **proto.guards)
7159396Sandreas.hansson@arm.comelif ProtoBuf.all:
7169396Sandreas.hansson@arm.com    print 'Got protobuf to build, but lacks support!'
7179396Sandreas.hansson@arm.com    Exit(1)
7189396Sandreas.hansson@arm.com
7198232Snate@binkert.org#
7208232Snate@binkert.org# Handle debug flags
7218232Snate@binkert.org#
7228232Snate@binkert.orgdef makeDebugFlagCC(target, source, env):
7238232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
7246229Snate@binkert.org
7258232Snate@binkert.org    val = eval(source[0].get_contents())
7268232Snate@binkert.org    name, compound, desc = val
7278232Snate@binkert.org    compound = list(sorted(compound))
7286229Snate@binkert.org
7297673Snate@binkert.org    code = code_formatter()
7305517Snate@binkert.org
7315517Snate@binkert.org    # file header
7327673Snate@binkert.org    code('''
7335517Snate@binkert.org/*
7345517Snate@binkert.org * DO NOT EDIT THIS FILE! Automatically generated
7355517Snate@binkert.org */
7365517Snate@binkert.org
7378232Snate@binkert.org#include "base/debug.hh"
7387673Snate@binkert.org''')
7397673Snate@binkert.org
7408232Snate@binkert.org    for flag in compound:
7418232Snate@binkert.org        code('#include "debug/$flag.hh"')
7428232Snate@binkert.org    code()
7438232Snate@binkert.org    code('namespace Debug {')
7447673Snate@binkert.org    code()
7455517Snate@binkert.org
7468232Snate@binkert.org    if not compound:
7478232Snate@binkert.org        code('SimpleFlag $name("$name", "$desc");')
7488232Snate@binkert.org    else:
7498232Snate@binkert.org        code('CompoundFlag $name("$name", "$desc",')
7507673Snate@binkert.org        code.indent()
7518232Snate@binkert.org        last = len(compound) - 1
7528232Snate@binkert.org        for i,flag in enumerate(compound):
7538232Snate@binkert.org            if i != last:
7548232Snate@binkert.org                code('$flag,')
7558232Snate@binkert.org            else:
7568232Snate@binkert.org                code('$flag);')
7577673Snate@binkert.org        code.dedent()
7585517Snate@binkert.org
7598232Snate@binkert.org    code()
7608232Snate@binkert.org    code('} // namespace Debug')
7615517Snate@binkert.org
7627673Snate@binkert.org    code.write(str(target[0]))
7635517Snate@binkert.org
7648232Snate@binkert.orgdef makeDebugFlagHH(target, source, env):
7658232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
7665517Snate@binkert.org
7678232Snate@binkert.org    val = eval(source[0].get_contents())
7688232Snate@binkert.org    name, compound, desc = val
7698232Snate@binkert.org
7707673Snate@binkert.org    code = code_formatter()
7715517Snate@binkert.org
7725517Snate@binkert.org    # file header boilerplate
7737673Snate@binkert.org    code('''\
7745517Snate@binkert.org/*
7755517Snate@binkert.org * DO NOT EDIT THIS FILE!
7765517Snate@binkert.org *
7778232Snate@binkert.org * Automatically generated by SCons
7785517Snate@binkert.org */
7795517Snate@binkert.org
7808232Snate@binkert.org#ifndef __DEBUG_${name}_HH__
7818232Snate@binkert.org#define __DEBUG_${name}_HH__
7825517Snate@binkert.org
7838232Snate@binkert.orgnamespace Debug {
7848232Snate@binkert.org''')
7855517Snate@binkert.org
7868232Snate@binkert.org    if compound:
7878232Snate@binkert.org        code('class CompoundFlag;')
7888232Snate@binkert.org    code('class SimpleFlag;')
7895517Snate@binkert.org
7908232Snate@binkert.org    if compound:
7918232Snate@binkert.org        code('extern CompoundFlag $name;')
7928232Snate@binkert.org        for flag in compound:
7938232Snate@binkert.org            code('extern SimpleFlag $flag;')
7948232Snate@binkert.org    else:
7958232Snate@binkert.org        code('extern SimpleFlag $name;')
7965517Snate@binkert.org
7978232Snate@binkert.org    code('''
7988232Snate@binkert.org}
7995517Snate@binkert.org
8008232Snate@binkert.org#endif // __DEBUG_${name}_HH__
8017673Snate@binkert.org''')
8025517Snate@binkert.org
8037673Snate@binkert.org    code.write(str(target[0]))
8045517Snate@binkert.org
8058232Snate@binkert.orgfor name,flag in sorted(debug_flags.iteritems()):
8068232Snate@binkert.org    n, compound, desc = flag
8078232Snate@binkert.org    assert n == name
8085192Ssaidi@eecs.umich.edu
8098232Snate@binkert.org    env.Command('debug/%s.hh' % name, Value(flag),
8108232Snate@binkert.org                MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
8118232Snate@binkert.org    env.Command('debug/%s.cc' % name, Value(flag),
8128232Snate@binkert.org                MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
8138232Snate@binkert.org    Source('debug/%s.cc' % name)
8145192Ssaidi@eecs.umich.edu
8157674Snate@binkert.org# Embed python files.  All .py files that have been indicated by a
8165522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
8175522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
8187674Snate@binkert.org# byte code, compress it, and then generate a c++ file that
8197674Snate@binkert.org# inserts the result into an array.
8207674Snate@binkert.orgdef embedPyFile(target, source, env):
8217674Snate@binkert.org    def c_str(string):
8227674Snate@binkert.org        if string is None:
8237674Snate@binkert.org            return "0"
8247674Snate@binkert.org        return '"%s"' % string
8257674Snate@binkert.org
8265522Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
8275522Snate@binkert.org    it, compress it, and stick it into an asm file so the code appears
8285522Snate@binkert.org    as just bytes with a label in the data section'''
8295517Snate@binkert.org
8305522Snate@binkert.org    src = file(str(source[0]), 'r').read()
8315517Snate@binkert.org
8326143Snate@binkert.org    pysource = PySource.tnodes[source[0]]
8336727Ssteve.reinhardt@amd.com    compiled = compile(src, pysource.abspath, 'exec')
8345522Snate@binkert.org    marshalled = marshal.dumps(compiled)
8355522Snate@binkert.org    compressed = zlib.compress(marshalled)
8365522Snate@binkert.org    data = compressed
8377674Snate@binkert.org    sym = pysource.symname
8385517Snate@binkert.org
8397673Snate@binkert.org    code = code_formatter()
8407673Snate@binkert.org    code('''\
8417674Snate@binkert.org#include "sim/init.hh"
8427673Snate@binkert.org
8437674Snate@binkert.orgnamespace {
8447674Snate@binkert.org
8458946Sandreas.hansson@arm.comconst uint8_t data_${sym}[] = {
8467674Snate@binkert.org''')
8477674Snate@binkert.org    code.indent()
8487674Snate@binkert.org    step = 16
8495522Snate@binkert.org    for i in xrange(0, len(data), step):
8505522Snate@binkert.org        x = array.array('B', data[i:i+step])
8517674Snate@binkert.org        code(''.join('%d,' % d for d in x))
8527674Snate@binkert.org    code.dedent()
8537674Snate@binkert.org    
8547674Snate@binkert.org    code('''};
8557673Snate@binkert.org
8567674Snate@binkert.orgEmbeddedPython embedded_${sym}(
8577674Snate@binkert.org    ${{c_str(pysource.arcname)}},
8587674Snate@binkert.org    ${{c_str(pysource.abspath)}},
8597674Snate@binkert.org    ${{c_str(pysource.modpath)}},
8607674Snate@binkert.org    data_${sym},
8617674Snate@binkert.org    ${{len(data)}},
8627674Snate@binkert.org    ${{len(marshalled)}});
8637674Snate@binkert.org
8647811Ssteve.reinhardt@amd.com} // anonymous namespace
8657674Snate@binkert.org''')
8667673Snate@binkert.org    code.write(str(target[0]))
8675522Snate@binkert.org
8686143Snate@binkert.orgfor source in PySource.all:
8697756SAli.Saidi@ARM.com    env.Command(source.cpp, source.tnode, 
8707816Ssteve.reinhardt@amd.com                MakeAction(embedPyFile, Transform("EMBED PY")))
8717674Snate@binkert.org    Source(source.cpp)
8724382Sbinkertn@umich.edu
8734382Sbinkertn@umich.edu########################################################################
8744382Sbinkertn@umich.edu#
8754382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
8764382Sbinkertn@umich.edu# a slightly different build environment.
8774382Sbinkertn@umich.edu#
8784382Sbinkertn@umich.edu
8794382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
8804382Sbinkertn@umich.eduenvList = []
8814382Sbinkertn@umich.edu
8826143Snate@binkert.orgdate_source = Source('base/date.cc', skip_lib=True)
883955SN/A
8842655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
8852655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
8862655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
8872655Sstever@eecs.umich.edu# build environment vars.
8882655Sstever@eecs.umich.edudef makeEnv(label, objsfx, strip = False, **kwargs):
8895601Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
8905601Snate@binkert.org    # name.  Use '_' instead.
8918334Snate@binkert.org    libname = 'gem5_' + label
8928334Snate@binkert.org    exename = 'gem5.' + label
8938334Snate@binkert.org    secondary_exename = 'm5.' + label
8945522Snate@binkert.org
8955863Snate@binkert.org    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
8965601Snate@binkert.org    new_env.Label = label
8975601Snate@binkert.org    new_env.Append(**kwargs)
8985601Snate@binkert.org
8995863Snate@binkert.org    swig_env = new_env.Clone()
9009556Sandreas.hansson@arm.com
9019556Sandreas.hansson@arm.com    # Both gcc and clang have issues with unused labels and values in
9029556Sandreas.hansson@arm.com    # the SWIG generated code
9039556Sandreas.hansson@arm.com    swig_env.Append(CCFLAGS=['-Wno-unused-label', '-Wno-unused-value'])
9049556Sandreas.hansson@arm.com
9059556Sandreas.hansson@arm.com    # Add additional warnings here that should not be applied to
9069556Sandreas.hansson@arm.com    # the SWIG generated code
9079556Sandreas.hansson@arm.com    new_env.Append(CXXFLAGS='-Wmissing-declarations')
9089556Sandreas.hansson@arm.com
9095559Snate@binkert.org    if env['GCC']:
9109556Sandreas.hansson@arm.com        # Depending on the SWIG version, we also need to supress
9119618Ssteve.reinhardt@amd.com        # warnings about uninitialized variables and missing field
9129618Ssteve.reinhardt@amd.com        # initializers.
9139618Ssteve.reinhardt@amd.com        swig_env.Append(CCFLAGS=['-Wno-uninitialized',
9149618Ssteve.reinhardt@amd.com                                 '-Wno-missing-field-initializers'])
9159556Sandreas.hansson@arm.com
9168946Sandreas.hansson@arm.com        if compareVersions(env['GCC_VERSION'], '4.6') >= 0:
9178614Sgblack@eecs.umich.edu            swig_env.Append(CCFLAGS='-Wno-unused-but-set-variable')
9189554Sandreas.hansson@arm.com
9199556Sandreas.hansson@arm.com        # If gcc supports it, also warn for deletion of derived
9209556Sandreas.hansson@arm.com        # classes with non-virtual desctructors. For gcc >= 4.7 we
9219556Sandreas.hansson@arm.com        # also have to disable warnings about the SWIG code having
9229556Sandreas.hansson@arm.com        # potentially uninitialized variables.
9239555Sandreas.hansson@arm.com        if compareVersions(env['GCC_VERSION'], '4.7') >= 0:
9249555Sandreas.hansson@arm.com            new_env.Append(CXXFLAGS='-Wdelete-non-virtual-dtor')
9259556Sandreas.hansson@arm.com            swig_env.Append(CCFLAGS='-Wno-maybe-uninitialized')
9268737Skoansin.tan@gmail.com    if env['CLANG']:
9279556Sandreas.hansson@arm.com        # Always enable the warning for deletion of derived classes
9289556Sandreas.hansson@arm.com        # with non-virtual destructors
9299556Sandreas.hansson@arm.com        new_env.Append(CXXFLAGS=['-Wdelete-non-virtual-dtor'])
9309554Sandreas.hansson@arm.com
9318945Ssteve.reinhardt@amd.com    werror_env = new_env.Clone()
9328945Ssteve.reinhardt@amd.com    werror_env.Append(CCFLAGS='-Werror')
9338945Ssteve.reinhardt@amd.com
9346143Snate@binkert.org    def make_obj(source, static, extra_deps = None):
9356143Snate@binkert.org        '''This function adds the specified source to the correct
9366143Snate@binkert.org        build environment, and returns the corresponding SCons Object
9376143Snate@binkert.org        nodes'''
9386143Snate@binkert.org
9396143Snate@binkert.org        if source.swig:
9406143Snate@binkert.org            env = swig_env
9418945Ssteve.reinhardt@amd.com        elif source.Werror:
9428945Ssteve.reinhardt@amd.com            env = werror_env
9436143Snate@binkert.org        else:
9446143Snate@binkert.org            env = new_env
9456143Snate@binkert.org
9466143Snate@binkert.org        if static:
9476143Snate@binkert.org            obj = env.StaticObject(source.tnode)
9486143Snate@binkert.org        else:
9496143Snate@binkert.org            obj = env.SharedObject(source.tnode)
9506143Snate@binkert.org
9516143Snate@binkert.org        if extra_deps:
9526143Snate@binkert.org            env.Depends(obj, extra_deps)
9536143Snate@binkert.org
9546143Snate@binkert.org        return obj
9556143Snate@binkert.org
9568594Snate@binkert.org    static_objs = \
9578594Snate@binkert.org        [ make_obj(s, True) for s in Source.get(main=False, skip_lib=False) ]
9588594Snate@binkert.org    shared_objs = \
9598594Snate@binkert.org        [ make_obj(s, False) for s in Source.get(main=False, skip_lib=False) ]
9606143Snate@binkert.org
9616143Snate@binkert.org    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
9626143Snate@binkert.org    static_objs.append(static_date)
9636143Snate@binkert.org    
9646143Snate@binkert.org    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
9656240Snate@binkert.org    shared_objs.append(shared_date)
9665554Snate@binkert.org
9675522Snate@binkert.org    # First make a library of everything but main() so other programs can
9685522Snate@binkert.org    # link against m5.
9695797Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
9705797Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
9715522Snate@binkert.org
9725601Snate@binkert.org    # Now link a stub with main() and the static library.
9738233Snate@binkert.org    main_objs = [ make_obj(s, True) for s in Source.get(main=True) ]
9748233Snate@binkert.org
9758235Snate@binkert.org    for test in UnitTest.all:
9768235Snate@binkert.org        flags = { test.target : True }
9778235Snate@binkert.org        test_sources = Source.get(**flags)
9788235Snate@binkert.org        test_objs = [ make_obj(s, static=True) for s in test_sources ]
9799003SAli.Saidi@ARM.com        if test.main:
9809003SAli.Saidi@ARM.com            test_objs += main_objs
9818235Snate@binkert.org        testname = "unittest/%s.%s" % (test.target, label)
9828942Sgblack@eecs.umich.edu        new_env.Program(testname, test_objs + static_objs)
9838235Snate@binkert.org
9846143Snate@binkert.org    progname = exename
9852655Sstever@eecs.umich.edu    if strip:
9866143Snate@binkert.org        progname += '.unstripped'
9876143Snate@binkert.org
9888233Snate@binkert.org    targets = new_env.Program(progname, main_objs + static_objs)
9896143Snate@binkert.org
9906143Snate@binkert.org    if strip:
9914007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
9924596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
9934007Ssaidi@eecs.umich.edu        else:
9944596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
9957756SAli.Saidi@ARM.com        targets = new_env.Command(exename, progname,
9967816Ssteve.reinhardt@amd.com                    MakeAction(cmd, Transform("STRIP")))
9978334Snate@binkert.org
9988334Snate@binkert.org    new_env.Command(secondary_exename, exename,
9998334Snate@binkert.org            MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
10008334Snate@binkert.org
10015601Snate@binkert.org    new_env.M5Binary = targets[0]
10025601Snate@binkert.org    envList.append(new_env)
10032655Sstever@eecs.umich.edu
10049225Sandreas.hansson@arm.com# Start out with the compiler flags common to all compilers,
10059225Sandreas.hansson@arm.com# i.e. they all use -g for opt and -g -pg for prof
10069226Sandreas.hansson@arm.comccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'],
10079226Sandreas.hansson@arm.com           'perf' : ['-g']}
10089225Sandreas.hansson@arm.com
10099226Sandreas.hansson@arm.com# Start out with the linker flags common to all linkers, i.e. -pg for
10109226Sandreas.hansson@arm.com# prof, and -lprofiler for perf. The -lprofile flag is surrounded by
10119226Sandreas.hansson@arm.com# no-as-needed and as-needed as the binutils linker is too clever and
10129226Sandreas.hansson@arm.com# simply doesn't link to the library otherwise.
10139226Sandreas.hansson@arm.comldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'],
10149226Sandreas.hansson@arm.com           'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']}
10159225Sandreas.hansson@arm.com
10169227Sandreas.hansson@arm.com# For Link Time Optimization, the optimisation flags used to compile
10179227Sandreas.hansson@arm.com# individual files are decoupled from those used at link time
10189227Sandreas.hansson@arm.com# (i.e. you can compile with -O3 and perform LTO with -O0), so we need
10199227Sandreas.hansson@arm.com# to also update the linker flags based on the target.
10208946Sandreas.hansson@arm.comif env['GCC']:
10213918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
10229225Sandreas.hansson@arm.com        ccflags['debug'] += ['-gstabs+']
10233918Ssaidi@eecs.umich.edu    else:
10249225Sandreas.hansson@arm.com        ccflags['debug'] += ['-ggdb3']
10259225Sandreas.hansson@arm.com    ldflags['debug'] += ['-O0']
10269227Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags, also add
10279227Sandreas.hansson@arm.com    # the optimization to the ldflags as LTO defers the optimization
10289227Sandreas.hansson@arm.com    # to link time
10299226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
10309225Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
10319227Sandreas.hansson@arm.com        ldflags[target] += ['-O3']
10329227Sandreas.hansson@arm.com
10339227Sandreas.hansson@arm.com    ccflags['fast'] += env['LTO_CCFLAGS']
10349227Sandreas.hansson@arm.com    ldflags['fast'] += env['LTO_LDFLAGS']
10358946Sandreas.hansson@arm.comelif env['CLANG']:
10369225Sandreas.hansson@arm.com    ccflags['debug'] += ['-g', '-O0']
10379226Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags
10389226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
10399226Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
10403515Ssaidi@eecs.umich.eduelse:
10413918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
10424762Snate@binkert.org    Exit(1)
10433515Ssaidi@eecs.umich.edu
10448881Smarc.orr@gmail.com
10458881Smarc.orr@gmail.com# To speed things up, we only instantiate the build environments we
10468881Smarc.orr@gmail.com# need.  We try to identify the needed environment for each target; if
10478881Smarc.orr@gmail.com# we can't, we fall back on instantiating all the environments just to
10488881Smarc.orr@gmail.com# be safe.
10499226Sandreas.hansson@arm.comtarget_types = ['debug', 'opt', 'fast', 'prof', 'perf']
10509226Sandreas.hansson@arm.comobj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
10519226Sandreas.hansson@arm.com              'gpo' : 'perf'}
10528881Smarc.orr@gmail.com
10538881Smarc.orr@gmail.comdef identifyTarget(t):
10548881Smarc.orr@gmail.com    ext = t.split('.')[-1]
10558881Smarc.orr@gmail.com    if ext in target_types:
10568881Smarc.orr@gmail.com        return ext
10578881Smarc.orr@gmail.com    if obj2target.has_key(ext):
10588881Smarc.orr@gmail.com        return obj2target[ext]
10598881Smarc.orr@gmail.com    match = re.search(r'/tests/([^/]+)/', t)
10608881Smarc.orr@gmail.com    if match and match.group(1) in target_types:
10618881Smarc.orr@gmail.com        return match.group(1)
10628881Smarc.orr@gmail.com    return 'all'
10638881Smarc.orr@gmail.com
10648881Smarc.orr@gmail.comneeded_envs = [identifyTarget(target) for target in BUILD_TARGETS]
10658881Smarc.orr@gmail.comif 'all' in needed_envs:
10668881Smarc.orr@gmail.com    needed_envs += target_types
10678881Smarc.orr@gmail.com
10688881Smarc.orr@gmail.com# Debug binary
10698881Smarc.orr@gmail.comif 'debug' in needed_envs:
10708881Smarc.orr@gmail.com    makeEnv('debug', '.do',
10718881Smarc.orr@gmail.com            CCFLAGS = Split(ccflags['debug']),
10729225Sandreas.hansson@arm.com            CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
10739225Sandreas.hansson@arm.com            LINKFLAGS = Split(ldflags['debug']))
1074955SN/A
1075955SN/A# Optimized binary
10768881Smarc.orr@gmail.comif 'opt' in needed_envs:
10778881Smarc.orr@gmail.com    makeEnv('opt', '.o',
10788881Smarc.orr@gmail.com            CCFLAGS = Split(ccflags['opt']),
10799225Sandreas.hansson@arm.com            CPPDEFINES = ['TRACING_ON=1'],
10809225Sandreas.hansson@arm.com            LINKFLAGS = Split(ldflags['opt']))
1081955SN/A
1082955SN/A# "Fast" binary
10838881Smarc.orr@gmail.comif 'fast' in needed_envs:
10848881Smarc.orr@gmail.com    makeEnv('fast', '.fo', strip = True,
10858881Smarc.orr@gmail.com            CCFLAGS = Split(ccflags['fast']),
10869225Sandreas.hansson@arm.com            CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
10879225Sandreas.hansson@arm.com            LINKFLAGS = Split(ldflags['fast']))
1088955SN/A
10899226Sandreas.hansson@arm.com# Profiled binary using gprof
10908881Smarc.orr@gmail.comif 'prof' in needed_envs:
10918881Smarc.orr@gmail.com    makeEnv('prof', '.po',
10928881Smarc.orr@gmail.com            CCFLAGS = Split(ccflags['prof']),
10938881Smarc.orr@gmail.com            CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
10949225Sandreas.hansson@arm.com            LINKFLAGS = Split(ldflags['prof']))
10951869SN/A
10969226Sandreas.hansson@arm.com# Profiled binary using google-pprof
10979226Sandreas.hansson@arm.comif 'perf' in needed_envs:
10989226Sandreas.hansson@arm.com    makeEnv('perf', '.gpo',
10999226Sandreas.hansson@arm.com            CCFLAGS = Split(ccflags['perf']),
11009226Sandreas.hansson@arm.com            CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
11019226Sandreas.hansson@arm.com            LINKFLAGS = Split(ldflags['perf']))
11029226Sandreas.hansson@arm.com
11031869SN/AReturn('envList')
1104