SConscript revision 9338
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
2368235Snate@binkert.orgclass UnitTest(object):
2378235Snate@binkert.org    '''Create a UnitTest'''
2386143Snate@binkert.org
2398235Snate@binkert.org    all = []
2409003SAli.Saidi@ARM.com    def __init__(self, target, *sources, **kwargs):
2418235Snate@binkert.org        '''Specify the target name and any sources.  Sources that are
2428235Snate@binkert.org        not SourceFiles are evalued with Source().  All files are
2438235Snate@binkert.org        guarded with a guard of the same name as the UnitTest
2448235Snate@binkert.org        target.'''
2458235Snate@binkert.org
2468235Snate@binkert.org        srcs = []
2478235Snate@binkert.org        for src in sources:
2488235Snate@binkert.org            if not isinstance(src, SourceFile):
2498235Snate@binkert.org                src = Source(src, skip_lib=True)
2508235Snate@binkert.org            src.guards[target] = True
2518235Snate@binkert.org            srcs.append(src)
2528235Snate@binkert.org
2538235Snate@binkert.org        self.sources = srcs
2548235Snate@binkert.org        self.target = target
2559003SAli.Saidi@ARM.com        self.main = kwargs.get('main', False)
2568235Snate@binkert.org        UnitTest.all.append(self)
2575584Snate@binkert.org
2584382Sbinkertn@umich.edu# Children should have access
2594202Sbinkertn@umich.eduExport('Source')
2604382Sbinkertn@umich.eduExport('PySource')
2614382Sbinkertn@umich.eduExport('SimObject')
2624382Sbinkertn@umich.eduExport('SwigSource')
2635584Snate@binkert.orgExport('UnitTest')
2644382Sbinkertn@umich.edu
2654382Sbinkertn@umich.edu########################################################################
2664382Sbinkertn@umich.edu#
2678232Snate@binkert.org# Debug Flags
2685192Ssaidi@eecs.umich.edu#
2698232Snate@binkert.orgdebug_flags = {}
2708232Snate@binkert.orgdef DebugFlag(name, desc=None):
2718232Snate@binkert.org    if name in debug_flags:
2725192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2738232Snate@binkert.org    debug_flags[name] = (name, (), desc)
2745192Ssaidi@eecs.umich.edu
2755799Snate@binkert.orgdef CompoundFlag(name, flags, desc=None):
2768232Snate@binkert.org    if name in debug_flags:
2775192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2785192Ssaidi@eecs.umich.edu
2795192Ssaidi@eecs.umich.edu    compound = tuple(flags)
2808232Snate@binkert.org    debug_flags[name] = (name, compound, desc)
2815192Ssaidi@eecs.umich.edu
2828232Snate@binkert.orgExport('DebugFlag')
2835192Ssaidi@eecs.umich.eduExport('CompoundFlag')
2845192Ssaidi@eecs.umich.edu
2855192Ssaidi@eecs.umich.edu########################################################################
2865192Ssaidi@eecs.umich.edu#
2874382Sbinkertn@umich.edu# Set some compiler variables
2884382Sbinkertn@umich.edu#
2894382Sbinkertn@umich.edu
2902667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
2912667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
2922667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
2932667Sstever@eecs.umich.edu# files.
2942667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
2952667Sstever@eecs.umich.edu
2965742Snate@binkert.orgfor extra_dir in extras_dir_list:
2975742Snate@binkert.org    env.Append(CPPPATH=Dir(extra_dir))
2985742Snate@binkert.org
2995793Snate@binkert.org# Workaround for bug in SCons version > 0.97d20071212
3008334Snate@binkert.org# Scons bug id: 2006 gem5 Bug id: 308
3015793Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
3025793Snate@binkert.org    Dir(root[len(base_dir) + 1:])
3035793Snate@binkert.org
3044382Sbinkertn@umich.edu########################################################################
3054762Snate@binkert.org#
3065344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories
3074382Sbinkertn@umich.edu#
3085341Sstever@gmail.com
3095742Snate@binkert.orghere = Dir('.').srcnode().abspath
3105742Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
3115742Snate@binkert.org    if root == here:
3125742Snate@binkert.org        # we don't want to recurse back into this SConscript
3135742Snate@binkert.org        continue
3144762Snate@binkert.org
3155742Snate@binkert.org    if 'SConscript' in files:
3165742Snate@binkert.org        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
3177722Sgblack@eecs.umich.edu        SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
3185742Snate@binkert.org
3195742Snate@binkert.orgfor extra_dir in extras_dir_list:
3205742Snate@binkert.org    prefix_len = len(dirname(extra_dir)) + 1
3215742Snate@binkert.org    for root, dirs, files in os.walk(extra_dir, topdown=True):
3228242Sbradley.danofsky@amd.com        # if build lives in the extras directory, don't walk down it
3238242Sbradley.danofsky@amd.com        if 'build' in dirs:
3248242Sbradley.danofsky@amd.com            dirs.remove('build')
3258242Sbradley.danofsky@amd.com
3265341Sstever@gmail.com        if 'SConscript' in files:
3275742Snate@binkert.org            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
3287722Sgblack@eecs.umich.edu            SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
3294773Snate@binkert.org
3306108Snate@binkert.orgfor opt in export_vars:
3311858SN/A    env.ConfigFile(opt)
3321085SN/A
3336658Snate@binkert.orgdef makeTheISA(source, target, env):
3346658Snate@binkert.org    isas = [ src.get_contents() for src in source ]
3357673Snate@binkert.org    target_isa = env['TARGET_ISA']
3366658Snate@binkert.org    def define(isa):
3376658Snate@binkert.org        return isa.upper() + '_ISA'
3386658Snate@binkert.org    
3396658Snate@binkert.org    def namespace(isa):
3406658Snate@binkert.org        return isa[0].upper() + isa[1:].lower() + 'ISA' 
3416658Snate@binkert.org
3426658Snate@binkert.org
3437673Snate@binkert.org    code = code_formatter()
3447673Snate@binkert.org    code('''\
3457673Snate@binkert.org#ifndef __CONFIG_THE_ISA_HH__
3467673Snate@binkert.org#define __CONFIG_THE_ISA_HH__
3477673Snate@binkert.org
3487673Snate@binkert.org''')
3497673Snate@binkert.org
3506658Snate@binkert.org    for i,isa in enumerate(isas):
3517673Snate@binkert.org        code('#define $0 $1', define(isa), i + 1)
3527673Snate@binkert.org
3537673Snate@binkert.org    code('''
3547673Snate@binkert.org
3557673Snate@binkert.org#define THE_ISA ${{define(target_isa)}}
3567673Snate@binkert.org#define TheISA ${{namespace(target_isa)}}
3579048SAli.Saidi@ARM.com#define THE_ISA_STR "${{target_isa}}"
3587673Snate@binkert.org
3597673Snate@binkert.org#endif // __CONFIG_THE_ISA_HH__''')
3607673Snate@binkert.org
3617673Snate@binkert.org    code.write(str(target[0]))
3626658Snate@binkert.org
3637756SAli.Saidi@ARM.comenv.Command('config/the_isa.hh', map(Value, all_isa_list),
3647816Ssteve.reinhardt@amd.com            MakeAction(makeTheISA, Transform("CFG ISA", 0)))
3656658Snate@binkert.org
3664382Sbinkertn@umich.edu########################################################################
3674382Sbinkertn@umich.edu#
3684762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
3694762Snate@binkert.org# should all have been added in the SConscripts above
3704762Snate@binkert.org#
3716654Snate@binkert.orgSimObject.fixed = True
3726654Snate@binkert.org
3735517Snate@binkert.orgclass DictImporter(object):
3745517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
3755517Snate@binkert.org    map to arbitrary filenames.'''
3765517Snate@binkert.org    def __init__(self, modules):
3775517Snate@binkert.org        self.modules = modules
3785517Snate@binkert.org        self.installed = set()
3795517Snate@binkert.org
3805517Snate@binkert.org    def __del__(self):
3815517Snate@binkert.org        self.unload()
3825517Snate@binkert.org
3835517Snate@binkert.org    def unload(self):
3845517Snate@binkert.org        import sys
3855517Snate@binkert.org        for module in self.installed:
3865517Snate@binkert.org            del sys.modules[module]
3875517Snate@binkert.org        self.installed = set()
3885517Snate@binkert.org
3895517Snate@binkert.org    def find_module(self, fullname, path):
3906654Snate@binkert.org        if fullname == 'm5.defines':
3915517Snate@binkert.org            return self
3925517Snate@binkert.org
3935517Snate@binkert.org        if fullname == 'm5.objects':
3945517Snate@binkert.org            return self
3955517Snate@binkert.org
3965517Snate@binkert.org        if fullname.startswith('m5.internal'):
3975517Snate@binkert.org            return None
3985517Snate@binkert.org
3996143Snate@binkert.org        source = self.modules.get(fullname, None)
4006654Snate@binkert.org        if source is not None and fullname.startswith('m5.objects'):
4015517Snate@binkert.org            return self
4025517Snate@binkert.org
4035517Snate@binkert.org        return None
4045517Snate@binkert.org
4055517Snate@binkert.org    def load_module(self, fullname):
4065517Snate@binkert.org        mod = imp.new_module(fullname)
4075517Snate@binkert.org        sys.modules[fullname] = mod
4085517Snate@binkert.org        self.installed.add(fullname)
4095517Snate@binkert.org
4105517Snate@binkert.org        mod.__loader__ = self
4115517Snate@binkert.org        if fullname == 'm5.objects':
4125517Snate@binkert.org            mod.__path__ = fullname.split('.')
4135517Snate@binkert.org            return mod
4145517Snate@binkert.org
4156654Snate@binkert.org        if fullname == 'm5.defines':
4166654Snate@binkert.org            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
4175517Snate@binkert.org            return mod
4185517Snate@binkert.org
4196143Snate@binkert.org        source = self.modules[fullname]
4206143Snate@binkert.org        if source.modname == '__init__':
4216143Snate@binkert.org            mod.__path__ = source.modpath
4226727Ssteve.reinhardt@amd.com        mod.__file__ = source.abspath
4235517Snate@binkert.org
4246727Ssteve.reinhardt@amd.com        exec file(source.abspath, 'r') in mod.__dict__
4255517Snate@binkert.org
4265517Snate@binkert.org        return mod
4275517Snate@binkert.org
4286654Snate@binkert.orgimport m5.SimObject
4296654Snate@binkert.orgimport m5.params
4307673Snate@binkert.orgfrom m5.util import code_formatter
4316654Snate@binkert.org
4326654Snate@binkert.orgm5.SimObject.clear()
4336654Snate@binkert.orgm5.params.clear()
4346654Snate@binkert.org
4355517Snate@binkert.org# install the python importer so we can grab stuff from the source
4365517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
4375517Snate@binkert.org# else we won't know about them for the rest of the stuff.
4386143Snate@binkert.orgimporter = DictImporter(PySource.modules)
4395517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
4404762Snate@binkert.org
4415517Snate@binkert.org# import all sim objects so we can populate the all_objects list
4425517Snate@binkert.org# make sure that we're working with a list, then let's sort it
4436143Snate@binkert.orgfor modname in SimObject.modnames:
4446143Snate@binkert.org    exec('from m5.objects import %s' % modname)
4455517Snate@binkert.org
4465517Snate@binkert.org# we need to unload all of the currently imported modules so that they
4475517Snate@binkert.org# will be re-imported the next time the sconscript is run
4485517Snate@binkert.orgimporter.unload()
4495517Snate@binkert.orgsys.meta_path.remove(importer)
4505517Snate@binkert.org
4515517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
4525517Snate@binkert.orgall_enums = m5.params.allEnums
4535517Snate@binkert.org
4549338SAndreas.Sandberg@arm.comif m5.SimObject.noCxxHeader:
4559338SAndreas.Sandberg@arm.com    print >> sys.stderr, \
4569338SAndreas.Sandberg@arm.com        "warning: At least one SimObject lacks a header specification. " \
4579338SAndreas.Sandberg@arm.com        "This can cause unexpected results in the generated SWIG " \
4589338SAndreas.Sandberg@arm.com        "wrappers."
4599338SAndreas.Sandberg@arm.com
4608596Ssteve.reinhardt@amd.com# Find param types that need to be explicitly wrapped with swig.
4618596Ssteve.reinhardt@amd.com# These will be recognized because the ParamDesc will have a
4628596Ssteve.reinhardt@amd.com# swig_decl() method.  Most param types are based on types that don't
4638596Ssteve.reinhardt@amd.com# need this, either because they're based on native types (like Int)
4648596Ssteve.reinhardt@amd.com# or because they're SimObjects (which get swigged independently).
4658596Ssteve.reinhardt@amd.com# For now the only things handled here are VectorParam types.
4668596Ssteve.reinhardt@amd.comparams_to_swig = {}
4676143Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()):
4685517Snate@binkert.org    for param in obj._params.local.values():
4696654Snate@binkert.org        # load the ptype attribute now because it depends on the
4706654Snate@binkert.org        # current version of SimObject.allClasses, but when scons
4716654Snate@binkert.org        # actually uses the value, all versions of
4726654Snate@binkert.org        # SimObject.allClasses will have been loaded
4736654Snate@binkert.org        param.ptype
4746654Snate@binkert.org
4755517Snate@binkert.org        if not hasattr(param, 'swig_decl'):
4765517Snate@binkert.org            continue
4775517Snate@binkert.org        pname = param.ptype_str
4788596Ssteve.reinhardt@amd.com        if pname not in params_to_swig:
4798596Ssteve.reinhardt@amd.com            params_to_swig[pname] = param
4804762Snate@binkert.org
4814762Snate@binkert.org########################################################################
4824762Snate@binkert.org#
4834762Snate@binkert.org# calculate extra dependencies
4844762Snate@binkert.org#
4854762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
4867675Snate@binkert.orgdepends = [ PySource.modules[dep].snode for dep in module_depends ]
4874762Snate@binkert.org
4884762Snate@binkert.org########################################################################
4894762Snate@binkert.org#
4904762Snate@binkert.org# Commands for the basic automatically generated python files
4914382Sbinkertn@umich.edu#
4924382Sbinkertn@umich.edu
4935517Snate@binkert.org# Generate Python file containing a dict specifying the current
4946654Snate@binkert.org# buildEnv flags.
4955517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
4968126Sgblack@eecs.umich.edu    build_env = source[0].get_contents()
4976654Snate@binkert.org
4987673Snate@binkert.org    code = code_formatter()
4996654Snate@binkert.org    code("""
5006654Snate@binkert.orgimport m5.internal
5016654Snate@binkert.orgimport m5.util
5026654Snate@binkert.org
5036654Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env)
5046654Snate@binkert.org
5056654Snate@binkert.orgcompileDate = m5.internal.core.compileDate
5066669Snate@binkert.org_globals = globals()
5076669Snate@binkert.orgfor key,val in m5.internal.core.__dict__.iteritems():
5086669Snate@binkert.org    if key.startswith('flag_'):
5096669Snate@binkert.org        flag = key[5:]
5106669Snate@binkert.org        _globals[flag] = val
5116669Snate@binkert.orgdel _globals
5126654Snate@binkert.org""")
5137673Snate@binkert.org    code.write(target[0].abspath)
5145517Snate@binkert.org
5158126Sgblack@eecs.umich.edudefines_info = Value(build_env)
5165798Snate@binkert.org# Generate a file with all of the compile options in it
5177756SAli.Saidi@ARM.comenv.Command('python/m5/defines.py', defines_info,
5187816Ssteve.reinhardt@amd.com            MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
5195798Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
5205798Snate@binkert.org
5215517Snate@binkert.org# Generate python file containing info about the M5 source code
5225517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
5237673Snate@binkert.org    code = code_formatter()
5245517Snate@binkert.org    for src in source:
5255517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
5267673Snate@binkert.org        code('$src = ${{repr(data)}}')
5277673Snate@binkert.org    code.write(str(target[0]))
5285517Snate@binkert.org
5295798Snate@binkert.org# Generate a file that wraps the basic top level files
5305798Snate@binkert.orgenv.Command('python/m5/info.py',
5318333Snate@binkert.org            [ '#/COPYING', '#/LICENSE', '#/README', ],
5327816Ssteve.reinhardt@amd.com            MakeAction(makeInfoPyFile, Transform("INFO")))
5335798Snate@binkert.orgPySource('m5', 'python/m5/info.py')
5345798Snate@binkert.org
5354762Snate@binkert.org########################################################################
5364762Snate@binkert.org#
5374762Snate@binkert.org# Create all of the SimObject param headers and enum headers
5384762Snate@binkert.org#
5394762Snate@binkert.org
5408596Ssteve.reinhardt@amd.comdef createSimObjectParamStruct(target, source, env):
5415517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5425517Snate@binkert.org
5435517Snate@binkert.org    name = str(source[0].get_contents())
5445517Snate@binkert.org    obj = sim_objects[name]
5455517Snate@binkert.org
5467673Snate@binkert.org    code = code_formatter()
5478596Ssteve.reinhardt@amd.com    obj.cxx_param_decl(code)
5487673Snate@binkert.org    code.write(target[0].abspath)
5495517Snate@binkert.org
5508596Ssteve.reinhardt@amd.comdef createParamSwigWrapper(target, source, env):
5515517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5525517Snate@binkert.org
5535517Snate@binkert.org    name = str(source[0].get_contents())
5548596Ssteve.reinhardt@amd.com    param = params_to_swig[name]
5555517Snate@binkert.org
5567673Snate@binkert.org    code = code_formatter()
5577673Snate@binkert.org    param.swig_decl(code)
5587673Snate@binkert.org    code.write(target[0].abspath)
5595517Snate@binkert.org
5605517Snate@binkert.orgdef createEnumStrings(target, source, env):
5615517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5625517Snate@binkert.org
5635517Snate@binkert.org    name = str(source[0].get_contents())
5645517Snate@binkert.org    obj = all_enums[name]
5655517Snate@binkert.org
5667673Snate@binkert.org    code = code_formatter()
5677673Snate@binkert.org    obj.cxx_def(code)
5687673Snate@binkert.org    code.write(target[0].abspath)
5695517Snate@binkert.org
5708596Ssteve.reinhardt@amd.comdef createEnumDecls(target, source, env):
5715517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5725517Snate@binkert.org
5735517Snate@binkert.org    name = str(source[0].get_contents())
5745517Snate@binkert.org    obj = all_enums[name]
5755517Snate@binkert.org
5767673Snate@binkert.org    code = code_formatter()
5777673Snate@binkert.org    obj.cxx_decl(code)
5787673Snate@binkert.org    code.write(target[0].abspath)
5795517Snate@binkert.org
5808596Ssteve.reinhardt@amd.comdef createEnumSwigWrapper(target, source, env):
5817675Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5827675Snate@binkert.org
5837675Snate@binkert.org    name = str(source[0].get_contents())
5847675Snate@binkert.org    obj = all_enums[name]
5857675Snate@binkert.org
5867675Snate@binkert.org    code = code_formatter()
5878596Ssteve.reinhardt@amd.com    obj.swig_decl(code)
5887675Snate@binkert.org    code.write(target[0].abspath)
5897675Snate@binkert.org
5908596Ssteve.reinhardt@amd.comdef createSimObjectSwigWrapper(target, source, env):
5918596Ssteve.reinhardt@amd.com    name = source[0].get_contents()
5928596Ssteve.reinhardt@amd.com    obj = sim_objects[name]
5938596Ssteve.reinhardt@amd.com
5948596Ssteve.reinhardt@amd.com    code = code_formatter()
5958596Ssteve.reinhardt@amd.com    obj.swig_decl(code)
5968596Ssteve.reinhardt@amd.com    code.write(target[0].abspath)
5978596Ssteve.reinhardt@amd.com
5988596Ssteve.reinhardt@amd.com# Generate all of the SimObject param C++ struct header files
5994762Snate@binkert.orgparams_hh_files = []
6006143Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()):
6016143Snate@binkert.org    py_source = PySource.modules[simobj.__module__]
6026143Snate@binkert.org    extra_deps = [ py_source.tnode ]
6034762Snate@binkert.org
6044762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
6054762Snate@binkert.org    params_hh_files.append(hh_file)
6067756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
6078596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
6084762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
6094762Snate@binkert.org
6108596Ssteve.reinhardt@amd.com# Generate any needed param SWIG wrapper files
6115463Snate@binkert.orgparams_i_files = []
6128596Ssteve.reinhardt@amd.comfor name,param in params_to_swig.iteritems():
6138596Ssteve.reinhardt@amd.com    i_file = File('python/m5/internal/%s.i' % (param.swig_module_name()))
6145463Snate@binkert.org    params_i_files.append(i_file)
6157756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
6168596Ssteve.reinhardt@amd.com                MakeAction(createParamSwigWrapper, Transform("SW PARAM")))
6174762Snate@binkert.org    env.Depends(i_file, depends)
6187677Snate@binkert.org    SwigSource('m5.internal', i_file)
6194762Snate@binkert.org
6204762Snate@binkert.org# Generate all enum header files
6216143Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()):
6226143Snate@binkert.org    py_source = PySource.modules[enum.__module__]
6236143Snate@binkert.org    extra_deps = [ py_source.tnode ]
6244762Snate@binkert.org
6254762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
6267756SAli.Saidi@ARM.com    env.Command(cc_file, Value(name),
6277816Ssteve.reinhardt@amd.com                MakeAction(createEnumStrings, Transform("ENUM STR")))
6284762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
6294762Snate@binkert.org    Source(cc_file)
6304762Snate@binkert.org
6314762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
6327756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
6338596Ssteve.reinhardt@amd.com                MakeAction(createEnumDecls, Transform("ENUMDECL")))
6344762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
6354762Snate@binkert.org
6367677Snate@binkert.org    i_file = File('python/m5/internal/enum_%s.i' % name)
6377756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
6388596Ssteve.reinhardt@amd.com                MakeAction(createEnumSwigWrapper, Transform("ENUMSWIG")))
6397675Snate@binkert.org    env.Depends(i_file, depends + extra_deps)
6407677Snate@binkert.org    SwigSource('m5.internal', i_file)
6415517Snate@binkert.org
6428596Ssteve.reinhardt@amd.com# Generate SimObject SWIG wrapper files
6439248SAndreas.Sandberg@arm.comfor name,simobj in sim_objects.iteritems():
6449248SAndreas.Sandberg@arm.com    py_source = PySource.modules[simobj.__module__]
6459248SAndreas.Sandberg@arm.com    extra_deps = [ py_source.tnode ]
6469248SAndreas.Sandberg@arm.com
6478596Ssteve.reinhardt@amd.com    i_file = File('python/m5/internal/param_%s.i' % name)
6488596Ssteve.reinhardt@amd.com    env.Command(i_file, Value(name),
6498596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectSwigWrapper, Transform("SO SWIG")))
6509248SAndreas.Sandberg@arm.com    env.Depends(i_file, depends + extra_deps)
6518596Ssteve.reinhardt@amd.com    SwigSource('m5.internal', i_file)
6524762Snate@binkert.org
6537674Snate@binkert.org# Generate the main swig init file
6547674Snate@binkert.orgdef makeEmbeddedSwigInit(target, source, env):
6557674Snate@binkert.org    code = code_formatter()
6567674Snate@binkert.org    module = source[0].get_contents()
6577674Snate@binkert.org    code('''\
6587674Snate@binkert.org#include "sim/init.hh"
6597674Snate@binkert.org
6607674Snate@binkert.orgextern "C" {
6617674Snate@binkert.org    void init_${module}();
6627674Snate@binkert.org}
6637674Snate@binkert.org
6647674Snate@binkert.orgEmbeddedSwig embed_swig_${module}(init_${module});
6657674Snate@binkert.org''')
6667674Snate@binkert.org    code.write(str(target[0]))
6677674Snate@binkert.org    
6684762Snate@binkert.org# Build all swig modules
6696143Snate@binkert.orgfor swig in SwigSource.all:
6706143Snate@binkert.org    env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
6717756SAli.Saidi@ARM.com                MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
6727816Ssteve.reinhardt@amd.com                '-o ${TARGETS[0]} $SOURCES', Transform("SWIG")))
6738235Snate@binkert.org    cc_file = str(swig.tnode)
6748596Ssteve.reinhardt@amd.com    init_file = '%s/%s_init.cc' % (dirname(cc_file), basename(cc_file))
6757756SAli.Saidi@ARM.com    env.Command(init_file, Value(swig.module),
6767816Ssteve.reinhardt@amd.com                MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW")))
6778235Snate@binkert.org    Source(init_file, **swig.guards)
6784382Sbinkertn@umich.edu
6798232Snate@binkert.org#
6808232Snate@binkert.org# Handle debug flags
6818232Snate@binkert.org#
6828232Snate@binkert.orgdef makeDebugFlagCC(target, source, env):
6838232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
6846229Snate@binkert.org
6858232Snate@binkert.org    val = eval(source[0].get_contents())
6868232Snate@binkert.org    name, compound, desc = val
6878232Snate@binkert.org    compound = list(sorted(compound))
6886229Snate@binkert.org
6897673Snate@binkert.org    code = code_formatter()
6905517Snate@binkert.org
6915517Snate@binkert.org    # file header
6927673Snate@binkert.org    code('''
6935517Snate@binkert.org/*
6945517Snate@binkert.org * DO NOT EDIT THIS FILE! Automatically generated
6955517Snate@binkert.org */
6965517Snate@binkert.org
6978232Snate@binkert.org#include "base/debug.hh"
6987673Snate@binkert.org''')
6997673Snate@binkert.org
7008232Snate@binkert.org    for flag in compound:
7018232Snate@binkert.org        code('#include "debug/$flag.hh"')
7028232Snate@binkert.org    code()
7038232Snate@binkert.org    code('namespace Debug {')
7047673Snate@binkert.org    code()
7055517Snate@binkert.org
7068232Snate@binkert.org    if not compound:
7078232Snate@binkert.org        code('SimpleFlag $name("$name", "$desc");')
7088232Snate@binkert.org    else:
7098232Snate@binkert.org        code('CompoundFlag $name("$name", "$desc",')
7107673Snate@binkert.org        code.indent()
7118232Snate@binkert.org        last = len(compound) - 1
7128232Snate@binkert.org        for i,flag in enumerate(compound):
7138232Snate@binkert.org            if i != last:
7148232Snate@binkert.org                code('$flag,')
7158232Snate@binkert.org            else:
7168232Snate@binkert.org                code('$flag);')
7177673Snate@binkert.org        code.dedent()
7185517Snate@binkert.org
7198232Snate@binkert.org    code()
7208232Snate@binkert.org    code('} // namespace Debug')
7215517Snate@binkert.org
7227673Snate@binkert.org    code.write(str(target[0]))
7235517Snate@binkert.org
7248232Snate@binkert.orgdef makeDebugFlagHH(target, source, env):
7258232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
7265517Snate@binkert.org
7278232Snate@binkert.org    val = eval(source[0].get_contents())
7288232Snate@binkert.org    name, compound, desc = val
7298232Snate@binkert.org
7307673Snate@binkert.org    code = code_formatter()
7315517Snate@binkert.org
7325517Snate@binkert.org    # file header boilerplate
7337673Snate@binkert.org    code('''\
7345517Snate@binkert.org/*
7355517Snate@binkert.org * DO NOT EDIT THIS FILE!
7365517Snate@binkert.org *
7378232Snate@binkert.org * Automatically generated by SCons
7385517Snate@binkert.org */
7395517Snate@binkert.org
7408232Snate@binkert.org#ifndef __DEBUG_${name}_HH__
7418232Snate@binkert.org#define __DEBUG_${name}_HH__
7425517Snate@binkert.org
7438232Snate@binkert.orgnamespace Debug {
7448232Snate@binkert.org''')
7455517Snate@binkert.org
7468232Snate@binkert.org    if compound:
7478232Snate@binkert.org        code('class CompoundFlag;')
7488232Snate@binkert.org    code('class SimpleFlag;')
7495517Snate@binkert.org
7508232Snate@binkert.org    if compound:
7518232Snate@binkert.org        code('extern CompoundFlag $name;')
7528232Snate@binkert.org        for flag in compound:
7538232Snate@binkert.org            code('extern SimpleFlag $flag;')
7548232Snate@binkert.org    else:
7558232Snate@binkert.org        code('extern SimpleFlag $name;')
7565517Snate@binkert.org
7578232Snate@binkert.org    code('''
7588232Snate@binkert.org}
7595517Snate@binkert.org
7608232Snate@binkert.org#endif // __DEBUG_${name}_HH__
7617673Snate@binkert.org''')
7625517Snate@binkert.org
7637673Snate@binkert.org    code.write(str(target[0]))
7645517Snate@binkert.org
7658232Snate@binkert.orgfor name,flag in sorted(debug_flags.iteritems()):
7668232Snate@binkert.org    n, compound, desc = flag
7678232Snate@binkert.org    assert n == name
7685192Ssaidi@eecs.umich.edu
7698232Snate@binkert.org    env.Command('debug/%s.hh' % name, Value(flag),
7708232Snate@binkert.org                MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
7718232Snate@binkert.org    env.Command('debug/%s.cc' % name, Value(flag),
7728232Snate@binkert.org                MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
7738232Snate@binkert.org    Source('debug/%s.cc' % name)
7745192Ssaidi@eecs.umich.edu
7757674Snate@binkert.org# Embed python files.  All .py files that have been indicated by a
7765522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
7775522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
7787674Snate@binkert.org# byte code, compress it, and then generate a c++ file that
7797674Snate@binkert.org# inserts the result into an array.
7807674Snate@binkert.orgdef embedPyFile(target, source, env):
7817674Snate@binkert.org    def c_str(string):
7827674Snate@binkert.org        if string is None:
7837674Snate@binkert.org            return "0"
7847674Snate@binkert.org        return '"%s"' % string
7857674Snate@binkert.org
7865522Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
7875522Snate@binkert.org    it, compress it, and stick it into an asm file so the code appears
7885522Snate@binkert.org    as just bytes with a label in the data section'''
7895517Snate@binkert.org
7905522Snate@binkert.org    src = file(str(source[0]), 'r').read()
7915517Snate@binkert.org
7926143Snate@binkert.org    pysource = PySource.tnodes[source[0]]
7936727Ssteve.reinhardt@amd.com    compiled = compile(src, pysource.abspath, 'exec')
7945522Snate@binkert.org    marshalled = marshal.dumps(compiled)
7955522Snate@binkert.org    compressed = zlib.compress(marshalled)
7965522Snate@binkert.org    data = compressed
7977674Snate@binkert.org    sym = pysource.symname
7985517Snate@binkert.org
7997673Snate@binkert.org    code = code_formatter()
8007673Snate@binkert.org    code('''\
8017674Snate@binkert.org#include "sim/init.hh"
8027673Snate@binkert.org
8037674Snate@binkert.orgnamespace {
8047674Snate@binkert.org
8058946Sandreas.hansson@arm.comconst uint8_t data_${sym}[] = {
8067674Snate@binkert.org''')
8077674Snate@binkert.org    code.indent()
8087674Snate@binkert.org    step = 16
8095522Snate@binkert.org    for i in xrange(0, len(data), step):
8105522Snate@binkert.org        x = array.array('B', data[i:i+step])
8117674Snate@binkert.org        code(''.join('%d,' % d for d in x))
8127674Snate@binkert.org    code.dedent()
8137674Snate@binkert.org    
8147674Snate@binkert.org    code('''};
8157673Snate@binkert.org
8167674Snate@binkert.orgEmbeddedPython embedded_${sym}(
8177674Snate@binkert.org    ${{c_str(pysource.arcname)}},
8187674Snate@binkert.org    ${{c_str(pysource.abspath)}},
8197674Snate@binkert.org    ${{c_str(pysource.modpath)}},
8207674Snate@binkert.org    data_${sym},
8217674Snate@binkert.org    ${{len(data)}},
8227674Snate@binkert.org    ${{len(marshalled)}});
8237674Snate@binkert.org
8247811Ssteve.reinhardt@amd.com} // anonymous namespace
8257674Snate@binkert.org''')
8267673Snate@binkert.org    code.write(str(target[0]))
8275522Snate@binkert.org
8286143Snate@binkert.orgfor source in PySource.all:
8297756SAli.Saidi@ARM.com    env.Command(source.cpp, source.tnode, 
8307816Ssteve.reinhardt@amd.com                MakeAction(embedPyFile, Transform("EMBED PY")))
8317674Snate@binkert.org    Source(source.cpp)
8324382Sbinkertn@umich.edu
8334382Sbinkertn@umich.edu########################################################################
8344382Sbinkertn@umich.edu#
8354382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
8364382Sbinkertn@umich.edu# a slightly different build environment.
8374382Sbinkertn@umich.edu#
8384382Sbinkertn@umich.edu
8394382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
8404382Sbinkertn@umich.eduenvList = []
8414382Sbinkertn@umich.edu
8426143Snate@binkert.orgdate_source = Source('base/date.cc', skip_lib=True)
843955SN/A
8442655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
8452655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
8462655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
8472655Sstever@eecs.umich.edu# build environment vars.
8482655Sstever@eecs.umich.edudef makeEnv(label, objsfx, strip = False, **kwargs):
8495601Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
8505601Snate@binkert.org    # name.  Use '_' instead.
8518334Snate@binkert.org    libname = 'gem5_' + label
8528334Snate@binkert.org    exename = 'gem5.' + label
8538334Snate@binkert.org    secondary_exename = 'm5.' + label
8545522Snate@binkert.org
8555863Snate@binkert.org    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
8565601Snate@binkert.org    new_env.Label = label
8575601Snate@binkert.org    new_env.Append(**kwargs)
8585601Snate@binkert.org
8595863Snate@binkert.org    swig_env = new_env.Clone()
8608945Ssteve.reinhardt@amd.com    swig_env.Append(CCFLAGS='-Werror')
8615559Snate@binkert.org    if env['GCC']:
8629175Sandreas.hansson@arm.com        swig_env.Append(CCFLAGS=['-Wno-uninitialized', '-Wno-sign-compare',
8639175Sandreas.hansson@arm.com                                 '-Wno-parentheses', '-Wno-unused-label',
8649175Sandreas.hansson@arm.com                                 '-Wno-unused-value'])
8658946Sandreas.hansson@arm.com        if compareVersions(env['GCC_VERSION'], '4.6') >= 0:
8668614Sgblack@eecs.umich.edu            swig_env.Append(CCFLAGS='-Wno-unused-but-set-variable')
8678737Skoansin.tan@gmail.com    if env['CLANG']:
8689175Sandreas.hansson@arm.com        swig_env.Append(CCFLAGS=['-Wno-unused-label', '-Wno-unused-value'])
8698945Ssteve.reinhardt@amd.com
8708945Ssteve.reinhardt@amd.com    werror_env = new_env.Clone()
8718945Ssteve.reinhardt@amd.com    werror_env.Append(CCFLAGS='-Werror')
8728945Ssteve.reinhardt@amd.com
8736143Snate@binkert.org    def make_obj(source, static, extra_deps = None):
8746143Snate@binkert.org        '''This function adds the specified source to the correct
8756143Snate@binkert.org        build environment, and returns the corresponding SCons Object
8766143Snate@binkert.org        nodes'''
8776143Snate@binkert.org
8786143Snate@binkert.org        if source.swig:
8796143Snate@binkert.org            env = swig_env
8808945Ssteve.reinhardt@amd.com        elif source.Werror:
8818945Ssteve.reinhardt@amd.com            env = werror_env
8826143Snate@binkert.org        else:
8836143Snate@binkert.org            env = new_env
8846143Snate@binkert.org
8856143Snate@binkert.org        if static:
8866143Snate@binkert.org            obj = env.StaticObject(source.tnode)
8876143Snate@binkert.org        else:
8886143Snate@binkert.org            obj = env.SharedObject(source.tnode)
8896143Snate@binkert.org
8906143Snate@binkert.org        if extra_deps:
8916143Snate@binkert.org            env.Depends(obj, extra_deps)
8926143Snate@binkert.org
8936143Snate@binkert.org        return obj
8946143Snate@binkert.org
8958594Snate@binkert.org    static_objs = \
8968594Snate@binkert.org        [ make_obj(s, True) for s in Source.get(main=False, skip_lib=False) ]
8978594Snate@binkert.org    shared_objs = \
8988594Snate@binkert.org        [ make_obj(s, False) for s in Source.get(main=False, skip_lib=False) ]
8996143Snate@binkert.org
9006143Snate@binkert.org    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
9016143Snate@binkert.org    static_objs.append(static_date)
9026143Snate@binkert.org    
9036143Snate@binkert.org    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
9046240Snate@binkert.org    shared_objs.append(shared_date)
9055554Snate@binkert.org
9065522Snate@binkert.org    # First make a library of everything but main() so other programs can
9075522Snate@binkert.org    # link against m5.
9085797Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
9095797Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
9105522Snate@binkert.org
9115601Snate@binkert.org    # Now link a stub with main() and the static library.
9128233Snate@binkert.org    main_objs = [ make_obj(s, True) for s in Source.get(main=True) ]
9138233Snate@binkert.org
9148235Snate@binkert.org    for test in UnitTest.all:
9158235Snate@binkert.org        flags = { test.target : True }
9168235Snate@binkert.org        test_sources = Source.get(**flags)
9178235Snate@binkert.org        test_objs = [ make_obj(s, static=True) for s in test_sources ]
9189003SAli.Saidi@ARM.com        if test.main:
9199003SAli.Saidi@ARM.com            test_objs += main_objs
9208235Snate@binkert.org        testname = "unittest/%s.%s" % (test.target, label)
9218942Sgblack@eecs.umich.edu        new_env.Program(testname, test_objs + static_objs)
9228235Snate@binkert.org
9236143Snate@binkert.org    progname = exename
9242655Sstever@eecs.umich.edu    if strip:
9256143Snate@binkert.org        progname += '.unstripped'
9266143Snate@binkert.org
9278233Snate@binkert.org    targets = new_env.Program(progname, main_objs + static_objs)
9286143Snate@binkert.org
9296143Snate@binkert.org    if strip:
9304007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
9314596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
9324007Ssaidi@eecs.umich.edu        else:
9334596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
9347756SAli.Saidi@ARM.com        targets = new_env.Command(exename, progname,
9357816Ssteve.reinhardt@amd.com                    MakeAction(cmd, Transform("STRIP")))
9368334Snate@binkert.org
9378334Snate@binkert.org    new_env.Command(secondary_exename, exename,
9388334Snate@binkert.org            MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
9398334Snate@binkert.org
9405601Snate@binkert.org    new_env.M5Binary = targets[0]
9415601Snate@binkert.org    envList.append(new_env)
9422655Sstever@eecs.umich.edu
9439225Sandreas.hansson@arm.com# Start out with the compiler flags common to all compilers,
9449225Sandreas.hansson@arm.com# i.e. they all use -g for opt and -g -pg for prof
9459226Sandreas.hansson@arm.comccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'],
9469226Sandreas.hansson@arm.com           'perf' : ['-g']}
9479225Sandreas.hansson@arm.com
9489226Sandreas.hansson@arm.com# Start out with the linker flags common to all linkers, i.e. -pg for
9499226Sandreas.hansson@arm.com# prof, and -lprofiler for perf. The -lprofile flag is surrounded by
9509226Sandreas.hansson@arm.com# no-as-needed and as-needed as the binutils linker is too clever and
9519226Sandreas.hansson@arm.com# simply doesn't link to the library otherwise.
9529226Sandreas.hansson@arm.comldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'],
9539226Sandreas.hansson@arm.com           'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']}
9549225Sandreas.hansson@arm.com
9559227Sandreas.hansson@arm.com# For Link Time Optimization, the optimisation flags used to compile
9569227Sandreas.hansson@arm.com# individual files are decoupled from those used at link time
9579227Sandreas.hansson@arm.com# (i.e. you can compile with -O3 and perform LTO with -O0), so we need
9589227Sandreas.hansson@arm.com# to also update the linker flags based on the target.
9598946Sandreas.hansson@arm.comif env['GCC']:
9603918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
9619225Sandreas.hansson@arm.com        ccflags['debug'] += ['-gstabs+']
9623918Ssaidi@eecs.umich.edu    else:
9639225Sandreas.hansson@arm.com        ccflags['debug'] += ['-ggdb3']
9649225Sandreas.hansson@arm.com    ldflags['debug'] += ['-O0']
9659227Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags, also add
9669227Sandreas.hansson@arm.com    # the optimization to the ldflags as LTO defers the optimization
9679227Sandreas.hansson@arm.com    # to link time
9689226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
9699225Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
9709227Sandreas.hansson@arm.com        ldflags[target] += ['-O3']
9719227Sandreas.hansson@arm.com
9729227Sandreas.hansson@arm.com    ccflags['fast'] += env['LTO_CCFLAGS']
9739227Sandreas.hansson@arm.com    ldflags['fast'] += env['LTO_LDFLAGS']
9749227Sandreas.hansson@arm.com
9753918Ssaidi@eecs.umich.eduelif env['SUNCC']:
9769225Sandreas.hansson@arm.com    ccflags['debug'] += ['-g0']
9779225Sandreas.hansson@arm.com    ccflags['opt'] += ['-O']
9789226Sandreas.hansson@arm.com    for target in ['fast', 'prof', 'perf']:
9799226Sandreas.hansson@arm.com        ccflags[target] += ['-fast']
9803940Ssaidi@eecs.umich.eduelif env['ICC']:
9819225Sandreas.hansson@arm.com    ccflags['debug'] += ['-g', '-O0']
9829225Sandreas.hansson@arm.com    ccflags['opt'] += ['-O']
9839226Sandreas.hansson@arm.com    for target in ['fast', 'prof', 'perf']:
9849226Sandreas.hansson@arm.com        ccflags[target] += ['-fast']
9858946Sandreas.hansson@arm.comelif env['CLANG']:
9869225Sandreas.hansson@arm.com    ccflags['debug'] += ['-g', '-O0']
9879226Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags
9889226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
9899226Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
9903515Ssaidi@eecs.umich.eduelse:
9913918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
9924762Snate@binkert.org    Exit(1)
9933515Ssaidi@eecs.umich.edu
9948881Smarc.orr@gmail.com
9958881Smarc.orr@gmail.com# To speed things up, we only instantiate the build environments we
9968881Smarc.orr@gmail.com# need.  We try to identify the needed environment for each target; if
9978881Smarc.orr@gmail.com# we can't, we fall back on instantiating all the environments just to
9988881Smarc.orr@gmail.com# be safe.
9999226Sandreas.hansson@arm.comtarget_types = ['debug', 'opt', 'fast', 'prof', 'perf']
10009226Sandreas.hansson@arm.comobj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
10019226Sandreas.hansson@arm.com              'gpo' : 'perf'}
10028881Smarc.orr@gmail.com
10038881Smarc.orr@gmail.comdef identifyTarget(t):
10048881Smarc.orr@gmail.com    ext = t.split('.')[-1]
10058881Smarc.orr@gmail.com    if ext in target_types:
10068881Smarc.orr@gmail.com        return ext
10078881Smarc.orr@gmail.com    if obj2target.has_key(ext):
10088881Smarc.orr@gmail.com        return obj2target[ext]
10098881Smarc.orr@gmail.com    match = re.search(r'/tests/([^/]+)/', t)
10108881Smarc.orr@gmail.com    if match and match.group(1) in target_types:
10118881Smarc.orr@gmail.com        return match.group(1)
10128881Smarc.orr@gmail.com    return 'all'
10138881Smarc.orr@gmail.com
10148881Smarc.orr@gmail.comneeded_envs = [identifyTarget(target) for target in BUILD_TARGETS]
10158881Smarc.orr@gmail.comif 'all' in needed_envs:
10168881Smarc.orr@gmail.com    needed_envs += target_types
10178881Smarc.orr@gmail.com
10188881Smarc.orr@gmail.com# Debug binary
10198881Smarc.orr@gmail.comif 'debug' in needed_envs:
10208881Smarc.orr@gmail.com    makeEnv('debug', '.do',
10218881Smarc.orr@gmail.com            CCFLAGS = Split(ccflags['debug']),
10229225Sandreas.hansson@arm.com            CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
10239225Sandreas.hansson@arm.com            LINKFLAGS = Split(ldflags['debug']))
1024955SN/A
1025955SN/A# Optimized binary
10268881Smarc.orr@gmail.comif 'opt' in needed_envs:
10278881Smarc.orr@gmail.com    makeEnv('opt', '.o',
10288881Smarc.orr@gmail.com            CCFLAGS = Split(ccflags['opt']),
10299225Sandreas.hansson@arm.com            CPPDEFINES = ['TRACING_ON=1'],
10309225Sandreas.hansson@arm.com            LINKFLAGS = Split(ldflags['opt']))
1031955SN/A
1032955SN/A# "Fast" binary
10338881Smarc.orr@gmail.comif 'fast' in needed_envs:
10348881Smarc.orr@gmail.com    makeEnv('fast', '.fo', strip = True,
10358881Smarc.orr@gmail.com            CCFLAGS = Split(ccflags['fast']),
10369225Sandreas.hansson@arm.com            CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
10379225Sandreas.hansson@arm.com            LINKFLAGS = Split(ldflags['fast']))
1038955SN/A
10399226Sandreas.hansson@arm.com# Profiled binary using gprof
10408881Smarc.orr@gmail.comif 'prof' in needed_envs:
10418881Smarc.orr@gmail.com    makeEnv('prof', '.po',
10428881Smarc.orr@gmail.com            CCFLAGS = Split(ccflags['prof']),
10438881Smarc.orr@gmail.com            CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
10449225Sandreas.hansson@arm.com            LINKFLAGS = Split(ldflags['prof']))
10451869SN/A
10469226Sandreas.hansson@arm.com# Profiled binary using google-pprof
10479226Sandreas.hansson@arm.comif 'perf' in needed_envs:
10489226Sandreas.hansson@arm.com    makeEnv('perf', '.gpo',
10499226Sandreas.hansson@arm.com            CCFLAGS = Split(ccflags['perf']),
10509226Sandreas.hansson@arm.com            CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
10519226Sandreas.hansson@arm.com            LINKFLAGS = Split(ldflags['perf']))
10529226Sandreas.hansson@arm.com
10531869SN/AReturn('envList')
1054