SConscript revision 11294
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
6610453SAndrew.Bardsley@arm.com#     skip_no_python -- do not put this file into a no_python library
6710453SAndrew.Bardsley@arm.com#       as it embeds compiled Python
688233Snate@binkert.org#     <unittest> -- unit tests use filters based on the unit test name
698233Snate@binkert.org#
708233Snate@binkert.org# A parent can now be specified for a source file and default filter
718233Snate@binkert.org# values will be retrieved recursively from parents (children override
728233Snate@binkert.org# parents).
738233Snate@binkert.org#
746143Snate@binkert.orgclass SourceMeta(type):
758233Snate@binkert.org    '''Meta class for source files that keeps track of all files of a
768233Snate@binkert.org    particular type and has a get function for finding all functions
778233Snate@binkert.org    of a certain type that match a set of guards'''
786143Snate@binkert.org    def __init__(cls, name, bases, dict):
796143Snate@binkert.org        super(SourceMeta, cls).__init__(name, bases, dict)
806143Snate@binkert.org        cls.all = []
816143Snate@binkert.org        
828233Snate@binkert.org    def get(cls, **guards):
838233Snate@binkert.org        '''Find all files that match the specified guards.  If a source
848233Snate@binkert.org        file does not specify a flag, the default is False'''
856143Snate@binkert.org        for src in cls.all:
868233Snate@binkert.org            for flag,value in guards.iteritems():
878233Snate@binkert.org                # if the flag is found and has a different value, skip
888233Snate@binkert.org                # this file
898233Snate@binkert.org                if src.all_guards.get(flag, False) != value:
906143Snate@binkert.org                    break
916143Snate@binkert.org            else:
926143Snate@binkert.org                yield src
934762Snate@binkert.org
946143Snate@binkert.orgclass SourceFile(object):
958233Snate@binkert.org    '''Base object that encapsulates the notion of a source file.
968233Snate@binkert.org    This includes, the source node, target node, various manipulations
978233Snate@binkert.org    of those.  A source file also specifies a set of guards which
988233Snate@binkert.org    describing which builds the source file applies to.  A parent can
998233Snate@binkert.org    also be specified to get default guards from'''
1006143Snate@binkert.org    __metaclass__ = SourceMeta
1018233Snate@binkert.org    def __init__(self, source, parent=None, **guards):
1028233Snate@binkert.org        self.guards = guards
1038233Snate@binkert.org        self.parent = parent
1048233Snate@binkert.org
1056143Snate@binkert.org        tnode = source
1066143Snate@binkert.org        if not isinstance(source, SCons.Node.FS.File):
1076143Snate@binkert.org            tnode = File(source)
1086143Snate@binkert.org
1096143Snate@binkert.org        self.tnode = tnode
1106143Snate@binkert.org        self.snode = tnode.srcnode()
1116143Snate@binkert.org
1126143Snate@binkert.org        for base in type(self).__mro__:
1136143Snate@binkert.org            if issubclass(base, SourceFile):
1147065Snate@binkert.org                base.all.append(self)
1156143Snate@binkert.org
1168233Snate@binkert.org    @property
1178233Snate@binkert.org    def filename(self):
1188233Snate@binkert.org        return str(self.tnode)
1198233Snate@binkert.org
1208233Snate@binkert.org    @property
1218233Snate@binkert.org    def dirname(self):
1228233Snate@binkert.org        return dirname(self.filename)
1238233Snate@binkert.org
1248233Snate@binkert.org    @property
1258233Snate@binkert.org    def basename(self):
1268233Snate@binkert.org        return basename(self.filename)
1278233Snate@binkert.org
1288233Snate@binkert.org    @property
1298233Snate@binkert.org    def extname(self):
1308233Snate@binkert.org        index = self.basename.rfind('.')
1318233Snate@binkert.org        if index <= 0:
1328233Snate@binkert.org            # dot files aren't extensions
1338233Snate@binkert.org            return self.basename, None
1348233Snate@binkert.org
1358233Snate@binkert.org        return self.basename[:index], self.basename[index+1:]
1368233Snate@binkert.org
1378233Snate@binkert.org    @property
1388233Snate@binkert.org    def all_guards(self):
1398233Snate@binkert.org        '''find all guards for this object getting default values
1408233Snate@binkert.org        recursively from its parents'''
1418233Snate@binkert.org        guards = {}
1428233Snate@binkert.org        if self.parent:
1438233Snate@binkert.org            guards.update(self.parent.guards)
1448233Snate@binkert.org        guards.update(self.guards)
1458233Snate@binkert.org        return guards
1468233Snate@binkert.org
1476143Snate@binkert.org    def __lt__(self, other): return self.filename < other.filename
1486143Snate@binkert.org    def __le__(self, other): return self.filename <= other.filename
1496143Snate@binkert.org    def __gt__(self, other): return self.filename > other.filename
1506143Snate@binkert.org    def __ge__(self, other): return self.filename >= other.filename
1516143Snate@binkert.org    def __eq__(self, other): return self.filename == other.filename
1526143Snate@binkert.org    def __ne__(self, other): return self.filename != other.filename
1539982Satgutier@umich.edu
15410196SCurtis.Dunham@arm.com    @staticmethod
15510196SCurtis.Dunham@arm.com    def done():
15610196SCurtis.Dunham@arm.com        def disabled(cls, name, *ignored):
15710196SCurtis.Dunham@arm.com            raise RuntimeError("Additional SourceFile '%s'" % name,\
15810196SCurtis.Dunham@arm.com                  "declared, but targets deps are already fixed.")
15910196SCurtis.Dunham@arm.com        SourceFile.__init__ = disabled
16010196SCurtis.Dunham@arm.com
16110196SCurtis.Dunham@arm.com
1626143Snate@binkert.orgclass Source(SourceFile):
1636143Snate@binkert.org    '''Add a c/c++ source file to the build'''
1648945Ssteve.reinhardt@amd.com    def __init__(self, source, Werror=True, swig=False, **guards):
1658233Snate@binkert.org        '''specify the source file, and any guards'''
1668233Snate@binkert.org        super(Source, self).__init__(source, **guards)
1676143Snate@binkert.org
1688945Ssteve.reinhardt@amd.com        self.Werror = Werror
1696143Snate@binkert.org        self.swig = swig
1706143Snate@binkert.org
1716143Snate@binkert.orgclass PySource(SourceFile):
1726143Snate@binkert.org    '''Add a python source file to the named package'''
1735522Snate@binkert.org    invalid_sym_char = re.compile('[^A-z0-9_]')
1746143Snate@binkert.org    modules = {}
1756143Snate@binkert.org    tnodes = {}
1766143Snate@binkert.org    symnames = {}
1779982Satgutier@umich.edu
1788233Snate@binkert.org    def __init__(self, package, source, **guards):
1798233Snate@binkert.org        '''specify the python package, the source file, and any guards'''
1808233Snate@binkert.org        super(PySource, self).__init__(source, **guards)
1816143Snate@binkert.org
1826143Snate@binkert.org        modname,ext = self.extname
1836143Snate@binkert.org        assert ext == 'py'
1846143Snate@binkert.org
1855522Snate@binkert.org        if package:
1865522Snate@binkert.org            path = package.split('.')
1875522Snate@binkert.org        else:
1885522Snate@binkert.org            path = []
1895604Snate@binkert.org
1905604Snate@binkert.org        modpath = path[:]
1916143Snate@binkert.org        if modname != '__init__':
1926143Snate@binkert.org            modpath += [ modname ]
1934762Snate@binkert.org        modpath = '.'.join(modpath)
1944762Snate@binkert.org
1956143Snate@binkert.org        arcpath = path + [ self.basename ]
1966727Ssteve.reinhardt@amd.com        abspath = self.snode.abspath
1976727Ssteve.reinhardt@amd.com        if not exists(abspath):
1986727Ssteve.reinhardt@amd.com            abspath = self.tnode.abspath
1994762Snate@binkert.org
2006143Snate@binkert.org        self.package = package
2016143Snate@binkert.org        self.modname = modname
2026143Snate@binkert.org        self.modpath = modpath
2036143Snate@binkert.org        self.arcname = joinpath(*arcpath)
2046727Ssteve.reinhardt@amd.com        self.abspath = abspath
2056143Snate@binkert.org        self.compiled = File(self.filename + 'c')
2067674Snate@binkert.org        self.cpp = File(self.filename + '.cc')
2077674Snate@binkert.org        self.symname = PySource.invalid_sym_char.sub('_', modpath)
2085604Snate@binkert.org
2096143Snate@binkert.org        PySource.modules[modpath] = self
2106143Snate@binkert.org        PySource.tnodes[self.tnode] = self
2116143Snate@binkert.org        PySource.symnames[self.symname] = self
2124762Snate@binkert.org
2136143Snate@binkert.orgclass SimObject(PySource):
2144762Snate@binkert.org    '''Add a SimObject python file as a python source object and add
2154762Snate@binkert.org    it to a list of sim object modules'''
2164762Snate@binkert.org
2176143Snate@binkert.org    fixed = False
2186143Snate@binkert.org    modnames = []
2194762Snate@binkert.org
2208233Snate@binkert.org    def __init__(self, source, **guards):
2218233Snate@binkert.org        '''Specify the source file and any guards (automatically in
2228233Snate@binkert.org        the m5.objects package)'''
2238233Snate@binkert.org        super(SimObject, self).__init__('m5.objects', source, **guards)
2246143Snate@binkert.org        if self.fixed:
2256143Snate@binkert.org            raise AttributeError, "Too late to call SimObject now."
2264762Snate@binkert.org
2276143Snate@binkert.org        bisect.insort_right(SimObject.modnames, self.modname)
2284762Snate@binkert.org
2296143Snate@binkert.orgclass SwigSource(SourceFile):
2304762Snate@binkert.org    '''Add a swig file to build'''
2316143Snate@binkert.org
2328233Snate@binkert.org    def __init__(self, package, source, **guards):
2338233Snate@binkert.org        '''Specify the python package, the source file, and any guards'''
23410453SAndrew.Bardsley@arm.com        super(SwigSource, self).__init__(source, skip_no_python=True, **guards)
2356143Snate@binkert.org
2366143Snate@binkert.org        modname,ext = self.extname
2376143Snate@binkert.org        assert ext == 'i'
2386143Snate@binkert.org
2396143Snate@binkert.org        self.module = modname
2406143Snate@binkert.org        cc_file = joinpath(self.dirname, modname + '_wrap.cc')
2416143Snate@binkert.org        py_file = joinpath(self.dirname, modname + '.py')
2426143Snate@binkert.org
24310453SAndrew.Bardsley@arm.com        self.cc_source = Source(cc_file, swig=True, parent=self, **guards)
24410453SAndrew.Bardsley@arm.com        self.py_source = PySource(package, py_file, parent=self, **guards)
245955SN/A
2469396Sandreas.hansson@arm.comclass ProtoBuf(SourceFile):
2479396Sandreas.hansson@arm.com    '''Add a Protocol Buffer to build'''
2489396Sandreas.hansson@arm.com
2499396Sandreas.hansson@arm.com    def __init__(self, source, **guards):
2509396Sandreas.hansson@arm.com        '''Specify the source file, and any guards'''
2519396Sandreas.hansson@arm.com        super(ProtoBuf, self).__init__(source, **guards)
2529396Sandreas.hansson@arm.com
2539396Sandreas.hansson@arm.com        # Get the file name and the extension
2549396Sandreas.hansson@arm.com        modname,ext = self.extname
2559396Sandreas.hansson@arm.com        assert ext == 'proto'
2569396Sandreas.hansson@arm.com
2579396Sandreas.hansson@arm.com        # Currently, we stick to generating the C++ headers, so we
2589396Sandreas.hansson@arm.com        # only need to track the source and header.
2599930Sandreas.hansson@arm.com        self.cc_file = File(modname + '.pb.cc')
2609930Sandreas.hansson@arm.com        self.hh_file = File(modname + '.pb.h')
2619396Sandreas.hansson@arm.com
2628235Snate@binkert.orgclass UnitTest(object):
2638235Snate@binkert.org    '''Create a UnitTest'''
2646143Snate@binkert.org
2658235Snate@binkert.org    all = []
2669003SAli.Saidi@ARM.com    def __init__(self, target, *sources, **kwargs):
2678235Snate@binkert.org        '''Specify the target name and any sources.  Sources that are
2688235Snate@binkert.org        not SourceFiles are evalued with Source().  All files are
2698235Snate@binkert.org        guarded with a guard of the same name as the UnitTest
2708235Snate@binkert.org        target.'''
2718235Snate@binkert.org
2728235Snate@binkert.org        srcs = []
2738235Snate@binkert.org        for src in sources:
2748235Snate@binkert.org            if not isinstance(src, SourceFile):
2758235Snate@binkert.org                src = Source(src, skip_lib=True)
2768235Snate@binkert.org            src.guards[target] = True
2778235Snate@binkert.org            srcs.append(src)
2788235Snate@binkert.org
2798235Snate@binkert.org        self.sources = srcs
2808235Snate@binkert.org        self.target = target
2819003SAli.Saidi@ARM.com        self.main = kwargs.get('main', False)
2828235Snate@binkert.org        UnitTest.all.append(self)
2835584Snate@binkert.org
2844382Sbinkertn@umich.edu# Children should have access
2854202Sbinkertn@umich.eduExport('Source')
2864382Sbinkertn@umich.eduExport('PySource')
2874382Sbinkertn@umich.eduExport('SimObject')
2884382Sbinkertn@umich.eduExport('SwigSource')
2899396Sandreas.hansson@arm.comExport('ProtoBuf')
2905584Snate@binkert.orgExport('UnitTest')
2914382Sbinkertn@umich.edu
2924382Sbinkertn@umich.edu########################################################################
2934382Sbinkertn@umich.edu#
2948232Snate@binkert.org# Debug Flags
2955192Ssaidi@eecs.umich.edu#
2968232Snate@binkert.orgdebug_flags = {}
2978232Snate@binkert.orgdef DebugFlag(name, desc=None):
2988232Snate@binkert.org    if name in debug_flags:
2995192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
3008232Snate@binkert.org    debug_flags[name] = (name, (), desc)
3015192Ssaidi@eecs.umich.edu
3025799Snate@binkert.orgdef CompoundFlag(name, flags, desc=None):
3038232Snate@binkert.org    if name in debug_flags:
3045192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
3055192Ssaidi@eecs.umich.edu
3065192Ssaidi@eecs.umich.edu    compound = tuple(flags)
3078232Snate@binkert.org    debug_flags[name] = (name, compound, desc)
3085192Ssaidi@eecs.umich.edu
3098232Snate@binkert.orgExport('DebugFlag')
3105192Ssaidi@eecs.umich.eduExport('CompoundFlag')
3115192Ssaidi@eecs.umich.edu
3125192Ssaidi@eecs.umich.edu########################################################################
3135192Ssaidi@eecs.umich.edu#
3144382Sbinkertn@umich.edu# Set some compiler variables
3154382Sbinkertn@umich.edu#
3164382Sbinkertn@umich.edu
3172667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
3182667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
3192667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
3202667Sstever@eecs.umich.edu# files.
3212667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
3222667Sstever@eecs.umich.edu
3235742Snate@binkert.orgfor extra_dir in extras_dir_list:
3245742Snate@binkert.org    env.Append(CPPPATH=Dir(extra_dir))
3255742Snate@binkert.org
3265793Snate@binkert.org# Workaround for bug in SCons version > 0.97d20071212
3278334Snate@binkert.org# Scons bug id: 2006 gem5 Bug id: 308
3285793Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
3295793Snate@binkert.org    Dir(root[len(base_dir) + 1:])
3305793Snate@binkert.org
3314382Sbinkertn@umich.edu########################################################################
3324762Snate@binkert.org#
3335344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories
3344382Sbinkertn@umich.edu#
3355341Sstever@gmail.com
3365742Snate@binkert.orghere = Dir('.').srcnode().abspath
3375742Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
3385742Snate@binkert.org    if root == here:
3395742Snate@binkert.org        # we don't want to recurse back into this SConscript
3405742Snate@binkert.org        continue
3414762Snate@binkert.org
3425742Snate@binkert.org    if 'SConscript' in files:
3435742Snate@binkert.org        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
3447722Sgblack@eecs.umich.edu        SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
3455742Snate@binkert.org
3465742Snate@binkert.orgfor extra_dir in extras_dir_list:
3475742Snate@binkert.org    prefix_len = len(dirname(extra_dir)) + 1
3489930Sandreas.hansson@arm.com
3499930Sandreas.hansson@arm.com    # Also add the corresponding build directory to pick up generated
3509930Sandreas.hansson@arm.com    # include files.
3519930Sandreas.hansson@arm.com    env.Append(CPPPATH=Dir(joinpath(env['BUILDDIR'], extra_dir[prefix_len:])))
3529930Sandreas.hansson@arm.com
3535742Snate@binkert.org    for root, dirs, files in os.walk(extra_dir, topdown=True):
3548242Sbradley.danofsky@amd.com        # if build lives in the extras directory, don't walk down it
3558242Sbradley.danofsky@amd.com        if 'build' in dirs:
3568242Sbradley.danofsky@amd.com            dirs.remove('build')
3578242Sbradley.danofsky@amd.com
3585341Sstever@gmail.com        if 'SConscript' in files:
3595742Snate@binkert.org            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
3607722Sgblack@eecs.umich.edu            SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
3614773Snate@binkert.org
3626108Snate@binkert.orgfor opt in export_vars:
3631858SN/A    env.ConfigFile(opt)
3641085SN/A
3656658Snate@binkert.orgdef makeTheISA(source, target, env):
3666658Snate@binkert.org    isas = [ src.get_contents() for src in source ]
3677673Snate@binkert.org    target_isa = env['TARGET_ISA']
3686658Snate@binkert.org    def define(isa):
3696658Snate@binkert.org        return isa.upper() + '_ISA'
3706658Snate@binkert.org    
3716658Snate@binkert.org    def namespace(isa):
3726658Snate@binkert.org        return isa[0].upper() + isa[1:].lower() + 'ISA' 
3736658Snate@binkert.org
3746658Snate@binkert.org
3757673Snate@binkert.org    code = code_formatter()
3767673Snate@binkert.org    code('''\
3777673Snate@binkert.org#ifndef __CONFIG_THE_ISA_HH__
3787673Snate@binkert.org#define __CONFIG_THE_ISA_HH__
3797673Snate@binkert.org
3807673Snate@binkert.org''')
3817673Snate@binkert.org
38210467Sandreas.hansson@arm.com    # create defines for the preprocessing and compile-time determination
3836658Snate@binkert.org    for i,isa in enumerate(isas):
3847673Snate@binkert.org        code('#define $0 $1', define(isa), i + 1)
38510467Sandreas.hansson@arm.com    code()
38610467Sandreas.hansson@arm.com
38710467Sandreas.hansson@arm.com    # create an enum for any run-time determination of the ISA, we
38810467Sandreas.hansson@arm.com    # reuse the same name as the namespaces
38910467Sandreas.hansson@arm.com    code('enum class Arch {')
39010467Sandreas.hansson@arm.com    for i,isa in enumerate(isas):
39110467Sandreas.hansson@arm.com        if i + 1 == len(isas):
39210467Sandreas.hansson@arm.com            code('  $0 = $1', namespace(isa), define(isa))
39310467Sandreas.hansson@arm.com        else:
39410467Sandreas.hansson@arm.com            code('  $0 = $1,', namespace(isa), define(isa))
39510467Sandreas.hansson@arm.com    code('};')
3967673Snate@binkert.org
3977673Snate@binkert.org    code('''
3987673Snate@binkert.org
3997673Snate@binkert.org#define THE_ISA ${{define(target_isa)}}
4007673Snate@binkert.org#define TheISA ${{namespace(target_isa)}}
4019048SAli.Saidi@ARM.com#define THE_ISA_STR "${{target_isa}}"
4027673Snate@binkert.org
4037673Snate@binkert.org#endif // __CONFIG_THE_ISA_HH__''')
4047673Snate@binkert.org
4057673Snate@binkert.org    code.write(str(target[0]))
4066658Snate@binkert.org
4077756SAli.Saidi@ARM.comenv.Command('config/the_isa.hh', map(Value, all_isa_list),
4087816Ssteve.reinhardt@amd.com            MakeAction(makeTheISA, Transform("CFG ISA", 0)))
4096658Snate@binkert.org
4104382Sbinkertn@umich.edu########################################################################
4114382Sbinkertn@umich.edu#
4124762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
4134762Snate@binkert.org# should all have been added in the SConscripts above
4144762Snate@binkert.org#
4156654Snate@binkert.orgSimObject.fixed = True
4166654Snate@binkert.org
4175517Snate@binkert.orgclass DictImporter(object):
4185517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
4195517Snate@binkert.org    map to arbitrary filenames.'''
4205517Snate@binkert.org    def __init__(self, modules):
4215517Snate@binkert.org        self.modules = modules
4225517Snate@binkert.org        self.installed = set()
4235517Snate@binkert.org
4245517Snate@binkert.org    def __del__(self):
4255517Snate@binkert.org        self.unload()
4265517Snate@binkert.org
4275517Snate@binkert.org    def unload(self):
4285517Snate@binkert.org        import sys
4295517Snate@binkert.org        for module in self.installed:
4305517Snate@binkert.org            del sys.modules[module]
4315517Snate@binkert.org        self.installed = set()
4325517Snate@binkert.org
4335517Snate@binkert.org    def find_module(self, fullname, path):
4346654Snate@binkert.org        if fullname == 'm5.defines':
4355517Snate@binkert.org            return self
4365517Snate@binkert.org
4375517Snate@binkert.org        if fullname == 'm5.objects':
4385517Snate@binkert.org            return self
4395517Snate@binkert.org
4405517Snate@binkert.org        if fullname.startswith('m5.internal'):
4415517Snate@binkert.org            return None
4425517Snate@binkert.org
4436143Snate@binkert.org        source = self.modules.get(fullname, None)
4446654Snate@binkert.org        if source is not None and fullname.startswith('m5.objects'):
4455517Snate@binkert.org            return self
4465517Snate@binkert.org
4475517Snate@binkert.org        return None
4485517Snate@binkert.org
4495517Snate@binkert.org    def load_module(self, fullname):
4505517Snate@binkert.org        mod = imp.new_module(fullname)
4515517Snate@binkert.org        sys.modules[fullname] = mod
4525517Snate@binkert.org        self.installed.add(fullname)
4535517Snate@binkert.org
4545517Snate@binkert.org        mod.__loader__ = self
4555517Snate@binkert.org        if fullname == 'm5.objects':
4565517Snate@binkert.org            mod.__path__ = fullname.split('.')
4575517Snate@binkert.org            return mod
4585517Snate@binkert.org
4596654Snate@binkert.org        if fullname == 'm5.defines':
4606654Snate@binkert.org            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
4615517Snate@binkert.org            return mod
4625517Snate@binkert.org
4636143Snate@binkert.org        source = self.modules[fullname]
4646143Snate@binkert.org        if source.modname == '__init__':
4656143Snate@binkert.org            mod.__path__ = source.modpath
4666727Ssteve.reinhardt@amd.com        mod.__file__ = source.abspath
4675517Snate@binkert.org
4686727Ssteve.reinhardt@amd.com        exec file(source.abspath, 'r') in mod.__dict__
4695517Snate@binkert.org
4705517Snate@binkert.org        return mod
4715517Snate@binkert.org
4726654Snate@binkert.orgimport m5.SimObject
4736654Snate@binkert.orgimport m5.params
4747673Snate@binkert.orgfrom m5.util import code_formatter
4756654Snate@binkert.org
4766654Snate@binkert.orgm5.SimObject.clear()
4776654Snate@binkert.orgm5.params.clear()
4786654Snate@binkert.org
4795517Snate@binkert.org# install the python importer so we can grab stuff from the source
4805517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
4815517Snate@binkert.org# else we won't know about them for the rest of the stuff.
4826143Snate@binkert.orgimporter = DictImporter(PySource.modules)
4835517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
4844762Snate@binkert.org
4855517Snate@binkert.org# import all sim objects so we can populate the all_objects list
4865517Snate@binkert.org# make sure that we're working with a list, then let's sort it
4876143Snate@binkert.orgfor modname in SimObject.modnames:
4886143Snate@binkert.org    exec('from m5.objects import %s' % modname)
4895517Snate@binkert.org
4905517Snate@binkert.org# we need to unload all of the currently imported modules so that they
4915517Snate@binkert.org# will be re-imported the next time the sconscript is run
4925517Snate@binkert.orgimporter.unload()
4935517Snate@binkert.orgsys.meta_path.remove(importer)
4945517Snate@binkert.org
4955517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
4965517Snate@binkert.orgall_enums = m5.params.allEnums
4975517Snate@binkert.org
4989338SAndreas.Sandberg@arm.comif m5.SimObject.noCxxHeader:
4999338SAndreas.Sandberg@arm.com    print >> sys.stderr, \
5009338SAndreas.Sandberg@arm.com        "warning: At least one SimObject lacks a header specification. " \
5019338SAndreas.Sandberg@arm.com        "This can cause unexpected results in the generated SWIG " \
5029338SAndreas.Sandberg@arm.com        "wrappers."
5039338SAndreas.Sandberg@arm.com
5048596Ssteve.reinhardt@amd.com# Find param types that need to be explicitly wrapped with swig.
5058596Ssteve.reinhardt@amd.com# These will be recognized because the ParamDesc will have a
5068596Ssteve.reinhardt@amd.com# swig_decl() method.  Most param types are based on types that don't
5078596Ssteve.reinhardt@amd.com# need this, either because they're based on native types (like Int)
5088596Ssteve.reinhardt@amd.com# or because they're SimObjects (which get swigged independently).
5098596Ssteve.reinhardt@amd.com# For now the only things handled here are VectorParam types.
5108596Ssteve.reinhardt@amd.comparams_to_swig = {}
5116143Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()):
5125517Snate@binkert.org    for param in obj._params.local.values():
5136654Snate@binkert.org        # load the ptype attribute now because it depends on the
5146654Snate@binkert.org        # current version of SimObject.allClasses, but when scons
5156654Snate@binkert.org        # actually uses the value, all versions of
5166654Snate@binkert.org        # SimObject.allClasses will have been loaded
5176654Snate@binkert.org        param.ptype
5186654Snate@binkert.org
5195517Snate@binkert.org        if not hasattr(param, 'swig_decl'):
5205517Snate@binkert.org            continue
5215517Snate@binkert.org        pname = param.ptype_str
5228596Ssteve.reinhardt@amd.com        if pname not in params_to_swig:
5238596Ssteve.reinhardt@amd.com            params_to_swig[pname] = param
5244762Snate@binkert.org
5254762Snate@binkert.org########################################################################
5264762Snate@binkert.org#
5274762Snate@binkert.org# calculate extra dependencies
5284762Snate@binkert.org#
5294762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
5307675Snate@binkert.orgdepends = [ PySource.modules[dep].snode for dep in module_depends ]
53110584Sandreas.hansson@arm.comdepends.sort(key = lambda x: x.name)
5324762Snate@binkert.org
5334762Snate@binkert.org########################################################################
5344762Snate@binkert.org#
5354762Snate@binkert.org# Commands for the basic automatically generated python files
5364382Sbinkertn@umich.edu#
5374382Sbinkertn@umich.edu
5385517Snate@binkert.org# Generate Python file containing a dict specifying the current
5396654Snate@binkert.org# buildEnv flags.
5405517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
5418126Sgblack@eecs.umich.edu    build_env = source[0].get_contents()
5426654Snate@binkert.org
5437673Snate@binkert.org    code = code_formatter()
5446654Snate@binkert.org    code("""
5456654Snate@binkert.orgimport m5.internal
5466654Snate@binkert.orgimport m5.util
5476654Snate@binkert.org
5486654Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env)
5496654Snate@binkert.org
5506654Snate@binkert.orgcompileDate = m5.internal.core.compileDate
5516669Snate@binkert.org_globals = globals()
5526669Snate@binkert.orgfor key,val in m5.internal.core.__dict__.iteritems():
5536669Snate@binkert.org    if key.startswith('flag_'):
5546669Snate@binkert.org        flag = key[5:]
5556669Snate@binkert.org        _globals[flag] = val
5566669Snate@binkert.orgdel _globals
5576654Snate@binkert.org""")
5587673Snate@binkert.org    code.write(target[0].abspath)
5595517Snate@binkert.org
5608126Sgblack@eecs.umich.edudefines_info = Value(build_env)
5615798Snate@binkert.org# Generate a file with all of the compile options in it
5627756SAli.Saidi@ARM.comenv.Command('python/m5/defines.py', defines_info,
5637816Ssteve.reinhardt@amd.com            MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
5645798Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
5655798Snate@binkert.org
5665517Snate@binkert.org# Generate python file containing info about the M5 source code
5675517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
5687673Snate@binkert.org    code = code_formatter()
5695517Snate@binkert.org    for src in source:
5705517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
5717673Snate@binkert.org        code('$src = ${{repr(data)}}')
5727673Snate@binkert.org    code.write(str(target[0]))
5735517Snate@binkert.org
5745798Snate@binkert.org# Generate a file that wraps the basic top level files
5755798Snate@binkert.orgenv.Command('python/m5/info.py',
5768333Snate@binkert.org            [ '#/COPYING', '#/LICENSE', '#/README', ],
5777816Ssteve.reinhardt@amd.com            MakeAction(makeInfoPyFile, Transform("INFO")))
5785798Snate@binkert.orgPySource('m5', 'python/m5/info.py')
5795798Snate@binkert.org
5804762Snate@binkert.org########################################################################
5814762Snate@binkert.org#
5824762Snate@binkert.org# Create all of the SimObject param headers and enum headers
5834762Snate@binkert.org#
5844762Snate@binkert.org
5858596Ssteve.reinhardt@amd.comdef createSimObjectParamStruct(target, source, env):
5865517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5875517Snate@binkert.org
5885517Snate@binkert.org    name = str(source[0].get_contents())
5895517Snate@binkert.org    obj = sim_objects[name]
5905517Snate@binkert.org
5917673Snate@binkert.org    code = code_formatter()
5928596Ssteve.reinhardt@amd.com    obj.cxx_param_decl(code)
5937673Snate@binkert.org    code.write(target[0].abspath)
5945517Snate@binkert.org
59510458Sandreas.hansson@arm.comdef createSimObjectCxxConfig(is_header):
59610458Sandreas.hansson@arm.com    def body(target, source, env):
59710458Sandreas.hansson@arm.com        assert len(target) == 1 and len(source) == 1
59810458Sandreas.hansson@arm.com
59910458Sandreas.hansson@arm.com        name = str(source[0].get_contents())
60010458Sandreas.hansson@arm.com        obj = sim_objects[name]
60110458Sandreas.hansson@arm.com
60210458Sandreas.hansson@arm.com        code = code_formatter()
60310458Sandreas.hansson@arm.com        obj.cxx_config_param_file(code, is_header)
60410458Sandreas.hansson@arm.com        code.write(target[0].abspath)
60510458Sandreas.hansson@arm.com    return body
60610458Sandreas.hansson@arm.com
6078596Ssteve.reinhardt@amd.comdef createParamSwigWrapper(target, source, env):
6085517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6095517Snate@binkert.org
6105517Snate@binkert.org    name = str(source[0].get_contents())
6118596Ssteve.reinhardt@amd.com    param = params_to_swig[name]
6125517Snate@binkert.org
6137673Snate@binkert.org    code = code_formatter()
6147673Snate@binkert.org    param.swig_decl(code)
6157673Snate@binkert.org    code.write(target[0].abspath)
6165517Snate@binkert.org
6175517Snate@binkert.orgdef createEnumStrings(target, source, env):
6185517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6195517Snate@binkert.org
6205517Snate@binkert.org    name = str(source[0].get_contents())
6215517Snate@binkert.org    obj = all_enums[name]
6225517Snate@binkert.org
6237673Snate@binkert.org    code = code_formatter()
6247673Snate@binkert.org    obj.cxx_def(code)
6257673Snate@binkert.org    code.write(target[0].abspath)
6265517Snate@binkert.org
6278596Ssteve.reinhardt@amd.comdef createEnumDecls(target, source, env):
6285517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6295517Snate@binkert.org
6305517Snate@binkert.org    name = str(source[0].get_contents())
6315517Snate@binkert.org    obj = all_enums[name]
6325517Snate@binkert.org
6337673Snate@binkert.org    code = code_formatter()
6347673Snate@binkert.org    obj.cxx_decl(code)
6357673Snate@binkert.org    code.write(target[0].abspath)
6365517Snate@binkert.org
6378596Ssteve.reinhardt@amd.comdef createEnumSwigWrapper(target, source, env):
6387675Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6397675Snate@binkert.org
6407675Snate@binkert.org    name = str(source[0].get_contents())
6417675Snate@binkert.org    obj = all_enums[name]
6427675Snate@binkert.org
6437675Snate@binkert.org    code = code_formatter()
6448596Ssteve.reinhardt@amd.com    obj.swig_decl(code)
6457675Snate@binkert.org    code.write(target[0].abspath)
6467675Snate@binkert.org
6478596Ssteve.reinhardt@amd.comdef createSimObjectSwigWrapper(target, source, env):
6488596Ssteve.reinhardt@amd.com    name = source[0].get_contents()
6498596Ssteve.reinhardt@amd.com    obj = sim_objects[name]
6508596Ssteve.reinhardt@amd.com
6518596Ssteve.reinhardt@amd.com    code = code_formatter()
6528596Ssteve.reinhardt@amd.com    obj.swig_decl(code)
6538596Ssteve.reinhardt@amd.com    code.write(target[0].abspath)
6548596Ssteve.reinhardt@amd.com
65510454SCurtis.Dunham@arm.com# dummy target for generated code
65610454SCurtis.Dunham@arm.com# we start out with all the Source files so they get copied to build/*/ also.
65710454SCurtis.Dunham@arm.comSWIG = env.Dummy('swig', [s.tnode for s in Source.get()])
65810454SCurtis.Dunham@arm.com
6598596Ssteve.reinhardt@amd.com# Generate all of the SimObject param C++ struct header files
6604762Snate@binkert.orgparams_hh_files = []
6616143Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()):
6626143Snate@binkert.org    py_source = PySource.modules[simobj.__module__]
6636143Snate@binkert.org    extra_deps = [ py_source.tnode ]
6644762Snate@binkert.org
6654762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
6664762Snate@binkert.org    params_hh_files.append(hh_file)
6677756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
6688596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
6694762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
67010454SCurtis.Dunham@arm.com    env.Depends(SWIG, hh_file)
6714762Snate@binkert.org
67210458Sandreas.hansson@arm.com# C++ parameter description files
67310458Sandreas.hansson@arm.comif GetOption('with_cxx_config'):
67410458Sandreas.hansson@arm.com    for name,simobj in sorted(sim_objects.iteritems()):
67510458Sandreas.hansson@arm.com        py_source = PySource.modules[simobj.__module__]
67610458Sandreas.hansson@arm.com        extra_deps = [ py_source.tnode ]
67710458Sandreas.hansson@arm.com
67810458Sandreas.hansson@arm.com        cxx_config_hh_file = File('cxx_config/%s.hh' % name)
67910458Sandreas.hansson@arm.com        cxx_config_cc_file = File('cxx_config/%s.cc' % name)
68010458Sandreas.hansson@arm.com        env.Command(cxx_config_hh_file, Value(name),
68110458Sandreas.hansson@arm.com                    MakeAction(createSimObjectCxxConfig(True),
68210458Sandreas.hansson@arm.com                    Transform("CXXCPRHH")))
68310458Sandreas.hansson@arm.com        env.Command(cxx_config_cc_file, Value(name),
68410458Sandreas.hansson@arm.com                    MakeAction(createSimObjectCxxConfig(False),
68510458Sandreas.hansson@arm.com                    Transform("CXXCPRCC")))
68610458Sandreas.hansson@arm.com        env.Depends(cxx_config_hh_file, depends + extra_deps +
68710458Sandreas.hansson@arm.com                    [File('params/%s.hh' % name), File('sim/cxx_config.hh')])
68810458Sandreas.hansson@arm.com        env.Depends(cxx_config_cc_file, depends + extra_deps +
68910458Sandreas.hansson@arm.com                    [cxx_config_hh_file])
69010458Sandreas.hansson@arm.com        Source(cxx_config_cc_file)
69110458Sandreas.hansson@arm.com
69210458Sandreas.hansson@arm.com    cxx_config_init_cc_file = File('cxx_config/init.cc')
69310458Sandreas.hansson@arm.com
69410458Sandreas.hansson@arm.com    def createCxxConfigInitCC(target, source, env):
69510458Sandreas.hansson@arm.com        assert len(target) == 1 and len(source) == 1
69610458Sandreas.hansson@arm.com
69710458Sandreas.hansson@arm.com        code = code_formatter()
69810458Sandreas.hansson@arm.com
69910458Sandreas.hansson@arm.com        for name,simobj in sorted(sim_objects.iteritems()):
70010458Sandreas.hansson@arm.com            if not hasattr(simobj, 'abstract') or not simobj.abstract:
70110458Sandreas.hansson@arm.com                code('#include "cxx_config/${name}.hh"')
70210458Sandreas.hansson@arm.com        code()
70310458Sandreas.hansson@arm.com        code('void cxxConfigInit()')
70410458Sandreas.hansson@arm.com        code('{')
70510458Sandreas.hansson@arm.com        code.indent()
70610458Sandreas.hansson@arm.com        for name,simobj in sorted(sim_objects.iteritems()):
70710458Sandreas.hansson@arm.com            not_abstract = not hasattr(simobj, 'abstract') or \
70810458Sandreas.hansson@arm.com                not simobj.abstract
70910458Sandreas.hansson@arm.com            if not_abstract and 'type' in simobj.__dict__:
71010458Sandreas.hansson@arm.com                code('cxx_config_directory["${name}"] = '
71110458Sandreas.hansson@arm.com                     '${name}CxxConfigParams::makeDirectoryEntry();')
71210458Sandreas.hansson@arm.com        code.dedent()
71310458Sandreas.hansson@arm.com        code('}')
71410458Sandreas.hansson@arm.com        code.write(target[0].abspath)
71510458Sandreas.hansson@arm.com
71610458Sandreas.hansson@arm.com    py_source = PySource.modules[simobj.__module__]
71710458Sandreas.hansson@arm.com    extra_deps = [ py_source.tnode ]
71810458Sandreas.hansson@arm.com    env.Command(cxx_config_init_cc_file, Value(name),
71910458Sandreas.hansson@arm.com        MakeAction(createCxxConfigInitCC, Transform("CXXCINIT")))
72010458Sandreas.hansson@arm.com    cxx_param_hh_files = ["cxx_config/%s.hh" % simobj
72110584Sandreas.hansson@arm.com        for name,simobj in sorted(sim_objects.iteritems())
72210458Sandreas.hansson@arm.com        if not hasattr(simobj, 'abstract') or not simobj.abstract]
72310458Sandreas.hansson@arm.com    Depends(cxx_config_init_cc_file, cxx_param_hh_files +
72410458Sandreas.hansson@arm.com            [File('sim/cxx_config.hh')])
72510458Sandreas.hansson@arm.com    Source(cxx_config_init_cc_file)
72610458Sandreas.hansson@arm.com
7278596Ssteve.reinhardt@amd.com# Generate any needed param SWIG wrapper files
7285463Snate@binkert.orgparams_i_files = []
72910584Sandreas.hansson@arm.comfor name,param in sorted(params_to_swig.iteritems()):
7308596Ssteve.reinhardt@amd.com    i_file = File('python/m5/internal/%s.i' % (param.swig_module_name()))
7315463Snate@binkert.org    params_i_files.append(i_file)
7327756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
7338596Ssteve.reinhardt@amd.com                MakeAction(createParamSwigWrapper, Transform("SW PARAM")))
7344762Snate@binkert.org    env.Depends(i_file, depends)
73510454SCurtis.Dunham@arm.com    env.Depends(SWIG, i_file)
7367677Snate@binkert.org    SwigSource('m5.internal', i_file)
7374762Snate@binkert.org
7384762Snate@binkert.org# Generate all enum header files
7396143Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()):
7406143Snate@binkert.org    py_source = PySource.modules[enum.__module__]
7416143Snate@binkert.org    extra_deps = [ py_source.tnode ]
7424762Snate@binkert.org
7434762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
7447756SAli.Saidi@ARM.com    env.Command(cc_file, Value(name),
7457816Ssteve.reinhardt@amd.com                MakeAction(createEnumStrings, Transform("ENUM STR")))
7464762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
74710454SCurtis.Dunham@arm.com    env.Depends(SWIG, cc_file)
7484762Snate@binkert.org    Source(cc_file)
7494762Snate@binkert.org
7504762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
7517756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
7528596Ssteve.reinhardt@amd.com                MakeAction(createEnumDecls, Transform("ENUMDECL")))
7534762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
75410454SCurtis.Dunham@arm.com    env.Depends(SWIG, hh_file)
7554762Snate@binkert.org
7567677Snate@binkert.org    i_file = File('python/m5/internal/enum_%s.i' % name)
7577756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
7588596Ssteve.reinhardt@amd.com                MakeAction(createEnumSwigWrapper, Transform("ENUMSWIG")))
7597675Snate@binkert.org    env.Depends(i_file, depends + extra_deps)
76010454SCurtis.Dunham@arm.com    env.Depends(SWIG, i_file)
7617677Snate@binkert.org    SwigSource('m5.internal', i_file)
7625517Snate@binkert.org
7638596Ssteve.reinhardt@amd.com# Generate SimObject SWIG wrapper files
76410584Sandreas.hansson@arm.comfor name,simobj in sorted(sim_objects.iteritems()):
7659248SAndreas.Sandberg@arm.com    py_source = PySource.modules[simobj.__module__]
7669248SAndreas.Sandberg@arm.com    extra_deps = [ py_source.tnode ]
7678596Ssteve.reinhardt@amd.com    i_file = File('python/m5/internal/param_%s.i' % name)
7688596Ssteve.reinhardt@amd.com    env.Command(i_file, Value(name),
7698596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectSwigWrapper, Transform("SO SWIG")))
7709248SAndreas.Sandberg@arm.com    env.Depends(i_file, depends + extra_deps)
7718596Ssteve.reinhardt@amd.com    SwigSource('m5.internal', i_file)
7724762Snate@binkert.org
7737674Snate@binkert.org# Generate the main swig init file
7747674Snate@binkert.orgdef makeEmbeddedSwigInit(target, source, env):
7757674Snate@binkert.org    code = code_formatter()
7767674Snate@binkert.org    module = source[0].get_contents()
7777674Snate@binkert.org    code('''\
7787674Snate@binkert.org#include "sim/init.hh"
7797674Snate@binkert.org
7807674Snate@binkert.orgextern "C" {
7817674Snate@binkert.org    void init_${module}();
7827674Snate@binkert.org}
7837674Snate@binkert.org
7847674Snate@binkert.orgEmbeddedSwig embed_swig_${module}(init_${module});
7857674Snate@binkert.org''')
7867674Snate@binkert.org    code.write(str(target[0]))
7877674Snate@binkert.org    
7884762Snate@binkert.org# Build all swig modules
7896143Snate@binkert.orgfor swig in SwigSource.all:
7906143Snate@binkert.org    env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
7917756SAli.Saidi@ARM.com                MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
7927816Ssteve.reinhardt@amd.com                '-o ${TARGETS[0]} $SOURCES', Transform("SWIG")))
7938235Snate@binkert.org    cc_file = str(swig.tnode)
7948596Ssteve.reinhardt@amd.com    init_file = '%s/%s_init.cc' % (dirname(cc_file), basename(cc_file))
7957756SAli.Saidi@ARM.com    env.Command(init_file, Value(swig.module),
7967816Ssteve.reinhardt@amd.com                MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW")))
79710454SCurtis.Dunham@arm.com    env.Depends(SWIG, init_file)
7988235Snate@binkert.org    Source(init_file, **swig.guards)
7994382Sbinkertn@umich.edu
8009396Sandreas.hansson@arm.com# Build all protocol buffers if we have got protoc and protobuf available
8019396Sandreas.hansson@arm.comif env['HAVE_PROTOBUF']:
8029396Sandreas.hansson@arm.com    for proto in ProtoBuf.all:
8039396Sandreas.hansson@arm.com        # Use both the source and header as the target, and the .proto
8049396Sandreas.hansson@arm.com        # file as the source. When executing the protoc compiler, also
8059396Sandreas.hansson@arm.com        # specify the proto_path to avoid having the generated files
8069396Sandreas.hansson@arm.com        # include the path.
8079396Sandreas.hansson@arm.com        env.Command([proto.cc_file, proto.hh_file], proto.tnode,
8089396Sandreas.hansson@arm.com                    MakeAction('$PROTOC --cpp_out ${TARGET.dir} '
8099396Sandreas.hansson@arm.com                               '--proto_path ${SOURCE.dir} $SOURCE',
8109396Sandreas.hansson@arm.com                               Transform("PROTOC")))
8119396Sandreas.hansson@arm.com
81210454SCurtis.Dunham@arm.com        env.Depends(SWIG, [proto.cc_file, proto.hh_file])
8139396Sandreas.hansson@arm.com        # Add the C++ source file
8149396Sandreas.hansson@arm.com        Source(proto.cc_file, **proto.guards)
8159396Sandreas.hansson@arm.comelif ProtoBuf.all:
8169396Sandreas.hansson@arm.com    print 'Got protobuf to build, but lacks support!'
8179396Sandreas.hansson@arm.com    Exit(1)
8189396Sandreas.hansson@arm.com
8198232Snate@binkert.org#
8208232Snate@binkert.org# Handle debug flags
8218232Snate@binkert.org#
8228232Snate@binkert.orgdef makeDebugFlagCC(target, source, env):
8238232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
8246229Snate@binkert.org
82510455SCurtis.Dunham@arm.com    code = code_formatter()
8266229Snate@binkert.org
82710455SCurtis.Dunham@arm.com    # delay definition of CompoundFlags until after all the definition
82810455SCurtis.Dunham@arm.com    # of all constituent SimpleFlags
82910455SCurtis.Dunham@arm.com    comp_code = code_formatter()
8305517Snate@binkert.org
8315517Snate@binkert.org    # file header
8327673Snate@binkert.org    code('''
8335517Snate@binkert.org/*
83410455SCurtis.Dunham@arm.com * DO NOT EDIT THIS FILE! Automatically generated by SCons.
8355517Snate@binkert.org */
8365517Snate@binkert.org
8378232Snate@binkert.org#include "base/debug.hh"
83810455SCurtis.Dunham@arm.com
83910455SCurtis.Dunham@arm.comnamespace Debug {
84010455SCurtis.Dunham@arm.com
8417673Snate@binkert.org''')
8427673Snate@binkert.org
84310455SCurtis.Dunham@arm.com    for name, flag in sorted(source[0].read().iteritems()):
84410455SCurtis.Dunham@arm.com        n, compound, desc = flag
84510455SCurtis.Dunham@arm.com        assert n == name
8465517Snate@binkert.org
84710455SCurtis.Dunham@arm.com        if not compound:
84810455SCurtis.Dunham@arm.com            code('SimpleFlag $name("$name", "$desc");')
84910455SCurtis.Dunham@arm.com        else:
85010455SCurtis.Dunham@arm.com            comp_code('CompoundFlag $name("$name", "$desc",')
85110455SCurtis.Dunham@arm.com            comp_code.indent()
85210455SCurtis.Dunham@arm.com            last = len(compound) - 1
85310455SCurtis.Dunham@arm.com            for i,flag in enumerate(compound):
85410455SCurtis.Dunham@arm.com                if i != last:
85510685Sandreas.hansson@arm.com                    comp_code('&$flag,')
85610455SCurtis.Dunham@arm.com                else:
85710685Sandreas.hansson@arm.com                    comp_code('&$flag);')
85810455SCurtis.Dunham@arm.com            comp_code.dedent()
8595517Snate@binkert.org
86010455SCurtis.Dunham@arm.com    code.append(comp_code)
8618232Snate@binkert.org    code()
8628232Snate@binkert.org    code('} // namespace Debug')
8635517Snate@binkert.org
8647673Snate@binkert.org    code.write(str(target[0]))
8655517Snate@binkert.org
8668232Snate@binkert.orgdef makeDebugFlagHH(target, source, env):
8678232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
8685517Snate@binkert.org
8698232Snate@binkert.org    val = eval(source[0].get_contents())
8708232Snate@binkert.org    name, compound, desc = val
8718232Snate@binkert.org
8727673Snate@binkert.org    code = code_formatter()
8735517Snate@binkert.org
8745517Snate@binkert.org    # file header boilerplate
8757673Snate@binkert.org    code('''\
8765517Snate@binkert.org/*
87710455SCurtis.Dunham@arm.com * DO NOT EDIT THIS FILE! Automatically generated by SCons.
8785517Snate@binkert.org */
8795517Snate@binkert.org
8808232Snate@binkert.org#ifndef __DEBUG_${name}_HH__
8818232Snate@binkert.org#define __DEBUG_${name}_HH__
8825517Snate@binkert.org
8838232Snate@binkert.orgnamespace Debug {
8848232Snate@binkert.org''')
8855517Snate@binkert.org
8868232Snate@binkert.org    if compound:
8878232Snate@binkert.org        code('class CompoundFlag;')
8888232Snate@binkert.org    code('class SimpleFlag;')
8895517Snate@binkert.org
8908232Snate@binkert.org    if compound:
8918232Snate@binkert.org        code('extern CompoundFlag $name;')
8928232Snate@binkert.org        for flag in compound:
8938232Snate@binkert.org            code('extern SimpleFlag $flag;')
8948232Snate@binkert.org    else:
8958232Snate@binkert.org        code('extern SimpleFlag $name;')
8965517Snate@binkert.org
8978232Snate@binkert.org    code('''
8988232Snate@binkert.org}
8995517Snate@binkert.org
9008232Snate@binkert.org#endif // __DEBUG_${name}_HH__
9017673Snate@binkert.org''')
9025517Snate@binkert.org
9037673Snate@binkert.org    code.write(str(target[0]))
9045517Snate@binkert.org
9058232Snate@binkert.orgfor name,flag in sorted(debug_flags.iteritems()):
9068232Snate@binkert.org    n, compound, desc = flag
9078232Snate@binkert.org    assert n == name
9085192Ssaidi@eecs.umich.edu
90910454SCurtis.Dunham@arm.com    hh_file = 'debug/%s.hh' % name
91010454SCurtis.Dunham@arm.com    env.Command(hh_file, Value(flag),
9118232Snate@binkert.org                MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
91210455SCurtis.Dunham@arm.com    env.Depends(SWIG, hh_file)
91310455SCurtis.Dunham@arm.com
91410455SCurtis.Dunham@arm.comenv.Command('debug/flags.cc', Value(debug_flags),
91510455SCurtis.Dunham@arm.com            MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
91610455SCurtis.Dunham@arm.comenv.Depends(SWIG, 'debug/flags.cc')
91710455SCurtis.Dunham@arm.comSource('debug/flags.cc')
9185192Ssaidi@eecs.umich.edu
91911077SCurtis.Dunham@arm.com# version tags
92011077SCurtis.Dunham@arm.comenv.Command('sim/tags.cc', None,
92111077SCurtis.Dunham@arm.com            MakeAction('util/cpt_upgrader.py --get-cc-file > $TARGET',
92211077SCurtis.Dunham@arm.com                       Transform("VER TAGS")))
92311077SCurtis.Dunham@arm.com
9247674Snate@binkert.org# Embed python files.  All .py files that have been indicated by a
9255522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
9265522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
9277674Snate@binkert.org# byte code, compress it, and then generate a c++ file that
9287674Snate@binkert.org# inserts the result into an array.
9297674Snate@binkert.orgdef embedPyFile(target, source, env):
9307674Snate@binkert.org    def c_str(string):
9317674Snate@binkert.org        if string is None:
9327674Snate@binkert.org            return "0"
9337674Snate@binkert.org        return '"%s"' % string
9347674Snate@binkert.org
9355522Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
9365522Snate@binkert.org    it, compress it, and stick it into an asm file so the code appears
9375522Snate@binkert.org    as just bytes with a label in the data section'''
9385517Snate@binkert.org
9395522Snate@binkert.org    src = file(str(source[0]), 'r').read()
9405517Snate@binkert.org
9416143Snate@binkert.org    pysource = PySource.tnodes[source[0]]
9426727Ssteve.reinhardt@amd.com    compiled = compile(src, pysource.abspath, 'exec')
9435522Snate@binkert.org    marshalled = marshal.dumps(compiled)
9445522Snate@binkert.org    compressed = zlib.compress(marshalled)
9455522Snate@binkert.org    data = compressed
9467674Snate@binkert.org    sym = pysource.symname
9475517Snate@binkert.org
9487673Snate@binkert.org    code = code_formatter()
9497673Snate@binkert.org    code('''\
9507674Snate@binkert.org#include "sim/init.hh"
9517673Snate@binkert.org
9527674Snate@binkert.orgnamespace {
9537674Snate@binkert.org
9548946Sandreas.hansson@arm.comconst uint8_t data_${sym}[] = {
9557674Snate@binkert.org''')
9567674Snate@binkert.org    code.indent()
9577674Snate@binkert.org    step = 16
9585522Snate@binkert.org    for i in xrange(0, len(data), step):
9595522Snate@binkert.org        x = array.array('B', data[i:i+step])
9607674Snate@binkert.org        code(''.join('%d,' % d for d in x))
9617674Snate@binkert.org    code.dedent()
9627674Snate@binkert.org    
9637674Snate@binkert.org    code('''};
9647673Snate@binkert.org
9657674Snate@binkert.orgEmbeddedPython embedded_${sym}(
9667674Snate@binkert.org    ${{c_str(pysource.arcname)}},
9677674Snate@binkert.org    ${{c_str(pysource.abspath)}},
9687674Snate@binkert.org    ${{c_str(pysource.modpath)}},
9697674Snate@binkert.org    data_${sym},
9707674Snate@binkert.org    ${{len(data)}},
9717674Snate@binkert.org    ${{len(marshalled)}});
9727674Snate@binkert.org
9737811Ssteve.reinhardt@amd.com} // anonymous namespace
9747674Snate@binkert.org''')
9757673Snate@binkert.org    code.write(str(target[0]))
9765522Snate@binkert.org
9776143Snate@binkert.orgfor source in PySource.all:
97810453SAndrew.Bardsley@arm.com    env.Command(source.cpp, source.tnode,
9797816Ssteve.reinhardt@amd.com                MakeAction(embedPyFile, Transform("EMBED PY")))
98010454SCurtis.Dunham@arm.com    env.Depends(SWIG, source.cpp)
98110453SAndrew.Bardsley@arm.com    Source(source.cpp, skip_no_python=True)
9824382Sbinkertn@umich.edu
9834382Sbinkertn@umich.edu########################################################################
9844382Sbinkertn@umich.edu#
9854382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
9864382Sbinkertn@umich.edu# a slightly different build environment.
9874382Sbinkertn@umich.edu#
9884382Sbinkertn@umich.edu
9894382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
99010196SCurtis.Dunham@arm.comdate_source = Source('base/date.cc', skip_lib=True)
9914382Sbinkertn@umich.edu
99210196SCurtis.Dunham@arm.com# Capture this directory for the closure makeEnv, otherwise when it is
99310196SCurtis.Dunham@arm.com# called, it won't know what directory it should use.
99410196SCurtis.Dunham@arm.comvariant_dir = Dir('.').path
99510196SCurtis.Dunham@arm.comdef variant(*path):
99610196SCurtis.Dunham@arm.com    return os.path.join(variant_dir, *path)
99710196SCurtis.Dunham@arm.comdef variantd(*path):
99810196SCurtis.Dunham@arm.com    return variant(*path)+'/'
999955SN/A
10002655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
10012655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
10022655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
10032655Sstever@eecs.umich.edu# build environment vars.
100410196SCurtis.Dunham@arm.comdef makeEnv(env, label, objsfx, strip = False, **kwargs):
10055601Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
10065601Snate@binkert.org    # name.  Use '_' instead.
100710196SCurtis.Dunham@arm.com    libname = variant('gem5_' + label)
100810196SCurtis.Dunham@arm.com    exename = variant('gem5.' + label)
100910196SCurtis.Dunham@arm.com    secondary_exename = variant('m5.' + label)
10105522Snate@binkert.org
10115863Snate@binkert.org    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
10125601Snate@binkert.org    new_env.Label = label
10135601Snate@binkert.org    new_env.Append(**kwargs)
10145601Snate@binkert.org
10155863Snate@binkert.org    swig_env = new_env.Clone()
10169556Sandreas.hansson@arm.com
10179556Sandreas.hansson@arm.com    # Both gcc and clang have issues with unused labels and values in
10189556Sandreas.hansson@arm.com    # the SWIG generated code
10199556Sandreas.hansson@arm.com    swig_env.Append(CCFLAGS=['-Wno-unused-label', '-Wno-unused-value'])
10209556Sandreas.hansson@arm.com
10215559Snate@binkert.org    if env['GCC']:
10229556Sandreas.hansson@arm.com        # Depending on the SWIG version, we also need to supress
10239618Ssteve.reinhardt@amd.com        # warnings about uninitialized variables and missing field
10249618Ssteve.reinhardt@amd.com        # initializers.
10259618Ssteve.reinhardt@amd.com        swig_env.Append(CCFLAGS=['-Wno-uninitialized',
102610238Sandreas.hansson@arm.com                                 '-Wno-missing-field-initializers',
102710878Sandreas.hansson@arm.com                                 '-Wno-unused-but-set-variable',
102811294Sandreas.hansson@arm.com                                 '-Wno-maybe-uninitialized',
102911294Sandreas.hansson@arm.com                                 '-Wno-type-limits'])
103010457Sandreas.hansson@arm.com
103110457Sandreas.hansson@arm.com        # Only gcc >= 4.9 supports UBSan, so check both the version
103210457Sandreas.hansson@arm.com        # and the command-line option before adding the compiler and
103310457Sandreas.hansson@arm.com        # linker flags.
103410457Sandreas.hansson@arm.com        if GetOption('with_ubsan') and \
103510457Sandreas.hansson@arm.com                compareVersions(env['GCC_VERSION'], '4.9') >= 0:
103610457Sandreas.hansson@arm.com            new_env.Append(CCFLAGS='-fsanitize=undefined')
103710457Sandreas.hansson@arm.com            new_env.Append(LINKFLAGS='-fsanitize=undefined')
103810457Sandreas.hansson@arm.com
10398737Skoansin.tan@gmail.com    if env['CLANG']:
104011294Sandreas.hansson@arm.com        swig_env.Append(CCFLAGS=['-Wno-sometimes-uninitialized',
104111294Sandreas.hansson@arm.com                                 '-Wno-deprecated-register',
104211294Sandreas.hansson@arm.com                                 '-Wno-tautological-compare'])
104310278SAndreas.Sandberg@ARM.com
104410457Sandreas.hansson@arm.com        # All supported clang versions have support for UBSan, so if
104510457Sandreas.hansson@arm.com        # asked to use it, append the compiler and linker flags.
104610457Sandreas.hansson@arm.com        if GetOption('with_ubsan'):
104710457Sandreas.hansson@arm.com            new_env.Append(CCFLAGS='-fsanitize=undefined')
104810457Sandreas.hansson@arm.com            new_env.Append(LINKFLAGS='-fsanitize=undefined')
104910457Sandreas.hansson@arm.com
10508945Ssteve.reinhardt@amd.com    werror_env = new_env.Clone()
105110686SAndreas.Sandberg@ARM.com    # Treat warnings as errors but white list some warnings that we
105210686SAndreas.Sandberg@ARM.com    # want to allow (e.g., deprecation warnings).
105310686SAndreas.Sandberg@ARM.com    werror_env.Append(CCFLAGS=['-Werror',
105410686SAndreas.Sandberg@ARM.com                               '-Wno-error=deprecated-declarations',
105510686SAndreas.Sandberg@ARM.com                               '-Wno-error=deprecated',
105610686SAndreas.Sandberg@ARM.com                               ])
10578945Ssteve.reinhardt@amd.com
10586143Snate@binkert.org    def make_obj(source, static, extra_deps = None):
10596143Snate@binkert.org        '''This function adds the specified source to the correct
10606143Snate@binkert.org        build environment, and returns the corresponding SCons Object
10616143Snate@binkert.org        nodes'''
10626143Snate@binkert.org
10636143Snate@binkert.org        if source.swig:
10646143Snate@binkert.org            env = swig_env
10658945Ssteve.reinhardt@amd.com        elif source.Werror:
10668945Ssteve.reinhardt@amd.com            env = werror_env
10676143Snate@binkert.org        else:
10686143Snate@binkert.org            env = new_env
10696143Snate@binkert.org
10706143Snate@binkert.org        if static:
10716143Snate@binkert.org            obj = env.StaticObject(source.tnode)
10726143Snate@binkert.org        else:
10736143Snate@binkert.org            obj = env.SharedObject(source.tnode)
10746143Snate@binkert.org
10756143Snate@binkert.org        if extra_deps:
10766143Snate@binkert.org            env.Depends(obj, extra_deps)
10776143Snate@binkert.org
10786143Snate@binkert.org        return obj
10796143Snate@binkert.org
108010453SAndrew.Bardsley@arm.com    lib_guards = {'main': False, 'skip_lib': False}
108110453SAndrew.Bardsley@arm.com
108210453SAndrew.Bardsley@arm.com    # Without Python, leave out all SWIG and Python content from the
108310453SAndrew.Bardsley@arm.com    # library builds.  The option doesn't affect gem5 built as a program
108410453SAndrew.Bardsley@arm.com    if GetOption('without_python'):
108510453SAndrew.Bardsley@arm.com        lib_guards['skip_no_python'] = False
108610453SAndrew.Bardsley@arm.com
108710453SAndrew.Bardsley@arm.com    static_objs = [ make_obj(s, True) for s in Source.get(**lib_guards) ]
108810453SAndrew.Bardsley@arm.com    shared_objs = [ make_obj(s, False) for s in Source.get(**lib_guards) ]
10896143Snate@binkert.org
10906143Snate@binkert.org    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
10916143Snate@binkert.org    static_objs.append(static_date)
109210453SAndrew.Bardsley@arm.com
10936143Snate@binkert.org    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
10946240Snate@binkert.org    shared_objs.append(shared_date)
10955554Snate@binkert.org
10965522Snate@binkert.org    # First make a library of everything but main() so other programs can
10975522Snate@binkert.org    # link against m5.
10985797Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
10995797Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
11005522Snate@binkert.org
11015601Snate@binkert.org    # Now link a stub with main() and the static library.
11028233Snate@binkert.org    main_objs = [ make_obj(s, True) for s in Source.get(main=True) ]
11038233Snate@binkert.org
11048235Snate@binkert.org    for test in UnitTest.all:
11058235Snate@binkert.org        flags = { test.target : True }
11068235Snate@binkert.org        test_sources = Source.get(**flags)
11078235Snate@binkert.org        test_objs = [ make_obj(s, static=True) for s in test_sources ]
11089003SAli.Saidi@ARM.com        if test.main:
11099003SAli.Saidi@ARM.com            test_objs += main_objs
111010196SCurtis.Dunham@arm.com        path = variant('unittest/%s.%s' % (test.target, label))
111110196SCurtis.Dunham@arm.com        new_env.Program(path, test_objs + static_objs)
11128235Snate@binkert.org
11136143Snate@binkert.org    progname = exename
11142655Sstever@eecs.umich.edu    if strip:
11156143Snate@binkert.org        progname += '.unstripped'
11166143Snate@binkert.org
11178233Snate@binkert.org    targets = new_env.Program(progname, main_objs + static_objs)
11186143Snate@binkert.org
11196143Snate@binkert.org    if strip:
11204007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
11214596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
11224007Ssaidi@eecs.umich.edu        else:
11234596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
11247756SAli.Saidi@ARM.com        targets = new_env.Command(exename, progname,
11257816Ssteve.reinhardt@amd.com                    MakeAction(cmd, Transform("STRIP")))
11268334Snate@binkert.org
11278334Snate@binkert.org    new_env.Command(secondary_exename, exename,
11288334Snate@binkert.org            MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
11298334Snate@binkert.org
11305601Snate@binkert.org    new_env.M5Binary = targets[0]
113110196SCurtis.Dunham@arm.com    return new_env
11322655Sstever@eecs.umich.edu
11339225Sandreas.hansson@arm.com# Start out with the compiler flags common to all compilers,
11349225Sandreas.hansson@arm.com# i.e. they all use -g for opt and -g -pg for prof
11359226Sandreas.hansson@arm.comccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'],
11369226Sandreas.hansson@arm.com           'perf' : ['-g']}
11379225Sandreas.hansson@arm.com
11389226Sandreas.hansson@arm.com# Start out with the linker flags common to all linkers, i.e. -pg for
11399226Sandreas.hansson@arm.com# prof, and -lprofiler for perf. The -lprofile flag is surrounded by
11409226Sandreas.hansson@arm.com# no-as-needed and as-needed as the binutils linker is too clever and
11419226Sandreas.hansson@arm.com# simply doesn't link to the library otherwise.
11429226Sandreas.hansson@arm.comldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'],
11439226Sandreas.hansson@arm.com           'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']}
11449225Sandreas.hansson@arm.com
11459227Sandreas.hansson@arm.com# For Link Time Optimization, the optimisation flags used to compile
11469227Sandreas.hansson@arm.com# individual files are decoupled from those used at link time
11479227Sandreas.hansson@arm.com# (i.e. you can compile with -O3 and perform LTO with -O0), so we need
11489227Sandreas.hansson@arm.com# to also update the linker flags based on the target.
11498946Sandreas.hansson@arm.comif env['GCC']:
11503918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
11519225Sandreas.hansson@arm.com        ccflags['debug'] += ['-gstabs+']
11523918Ssaidi@eecs.umich.edu    else:
11539225Sandreas.hansson@arm.com        ccflags['debug'] += ['-ggdb3']
11549225Sandreas.hansson@arm.com    ldflags['debug'] += ['-O0']
11559227Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags, also add
11569227Sandreas.hansson@arm.com    # the optimization to the ldflags as LTO defers the optimization
11579227Sandreas.hansson@arm.com    # to link time
11589226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
11599225Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
11609227Sandreas.hansson@arm.com        ldflags[target] += ['-O3']
11619227Sandreas.hansson@arm.com
11629227Sandreas.hansson@arm.com    ccflags['fast'] += env['LTO_CCFLAGS']
11639227Sandreas.hansson@arm.com    ldflags['fast'] += env['LTO_LDFLAGS']
11648946Sandreas.hansson@arm.comelif env['CLANG']:
11659225Sandreas.hansson@arm.com    ccflags['debug'] += ['-g', '-O0']
11669226Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags
11679226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
11689226Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
11693515Ssaidi@eecs.umich.eduelse:
11703918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
11714762Snate@binkert.org    Exit(1)
11723515Ssaidi@eecs.umich.edu
11738881Smarc.orr@gmail.com
11748881Smarc.orr@gmail.com# To speed things up, we only instantiate the build environments we
11758881Smarc.orr@gmail.com# need.  We try to identify the needed environment for each target; if
11768881Smarc.orr@gmail.com# we can't, we fall back on instantiating all the environments just to
11778881Smarc.orr@gmail.com# be safe.
11789226Sandreas.hansson@arm.comtarget_types = ['debug', 'opt', 'fast', 'prof', 'perf']
11799226Sandreas.hansson@arm.comobj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
11809226Sandreas.hansson@arm.com              'gpo' : 'perf'}
11818881Smarc.orr@gmail.com
11828881Smarc.orr@gmail.comdef identifyTarget(t):
11838881Smarc.orr@gmail.com    ext = t.split('.')[-1]
11848881Smarc.orr@gmail.com    if ext in target_types:
11858881Smarc.orr@gmail.com        return ext
11868881Smarc.orr@gmail.com    if obj2target.has_key(ext):
11878881Smarc.orr@gmail.com        return obj2target[ext]
11888881Smarc.orr@gmail.com    match = re.search(r'/tests/([^/]+)/', t)
11898881Smarc.orr@gmail.com    if match and match.group(1) in target_types:
11908881Smarc.orr@gmail.com        return match.group(1)
11918881Smarc.orr@gmail.com    return 'all'
11928881Smarc.orr@gmail.com
11938881Smarc.orr@gmail.comneeded_envs = [identifyTarget(target) for target in BUILD_TARGETS]
11948881Smarc.orr@gmail.comif 'all' in needed_envs:
11958881Smarc.orr@gmail.com    needed_envs += target_types
11968881Smarc.orr@gmail.com
119710196SCurtis.Dunham@arm.comgem5_root = Dir('.').up().up().abspath
119810196SCurtis.Dunham@arm.comdef makeEnvirons(target, source, env):
119910196SCurtis.Dunham@arm.com    # cause any later Source() calls to be fatal, as a diagnostic.
120010196SCurtis.Dunham@arm.com    Source.done()
1201955SN/A
120210196SCurtis.Dunham@arm.com    envList = []
1203955SN/A
120410196SCurtis.Dunham@arm.com    # Debug binary
120510196SCurtis.Dunham@arm.com    if 'debug' in needed_envs:
120610196SCurtis.Dunham@arm.com        envList.append(
120710196SCurtis.Dunham@arm.com            makeEnv(env, 'debug', '.do',
120810196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['debug']),
120910196SCurtis.Dunham@arm.com                    CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
121010196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['debug'])))
1211955SN/A
121210196SCurtis.Dunham@arm.com    # Optimized binary
121310196SCurtis.Dunham@arm.com    if 'opt' in needed_envs:
121410196SCurtis.Dunham@arm.com        envList.append(
121510196SCurtis.Dunham@arm.com            makeEnv(env, 'opt', '.o',
121610196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['opt']),
121710196SCurtis.Dunham@arm.com                    CPPDEFINES = ['TRACING_ON=1'],
121810196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['opt'])))
12191869SN/A
122010196SCurtis.Dunham@arm.com    # "Fast" binary
122110196SCurtis.Dunham@arm.com    if 'fast' in needed_envs:
122210196SCurtis.Dunham@arm.com        envList.append(
122310196SCurtis.Dunham@arm.com            makeEnv(env, 'fast', '.fo', strip = True,
122410196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['fast']),
122510196SCurtis.Dunham@arm.com                    CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
122610196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['fast'])))
12279226Sandreas.hansson@arm.com
122810196SCurtis.Dunham@arm.com    # Profiled binary using gprof
122910196SCurtis.Dunham@arm.com    if 'prof' in needed_envs:
123010196SCurtis.Dunham@arm.com        envList.append(
123110196SCurtis.Dunham@arm.com            makeEnv(env, 'prof', '.po',
123210196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['prof']),
123310196SCurtis.Dunham@arm.com                    CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
123410196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['prof'])))
123510196SCurtis.Dunham@arm.com
123610196SCurtis.Dunham@arm.com    # Profiled binary using google-pprof
123710196SCurtis.Dunham@arm.com    if 'perf' in needed_envs:
123810196SCurtis.Dunham@arm.com        envList.append(
123910196SCurtis.Dunham@arm.com            makeEnv(env, 'perf', '.gpo',
124010196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['perf']),
124110196SCurtis.Dunham@arm.com                    CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
124210196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['perf'])))
124310196SCurtis.Dunham@arm.com
124410196SCurtis.Dunham@arm.com    # Set up the regression tests for each build.
124510196SCurtis.Dunham@arm.com    for e in envList:
124610196SCurtis.Dunham@arm.com        SConscript(os.path.join(gem5_root, 'tests', 'SConscript'),
124710196SCurtis.Dunham@arm.com                   variant_dir = variantd('tests', e.Label),
124810196SCurtis.Dunham@arm.com                   exports = { 'env' : e }, duplicate = False)
124910196SCurtis.Dunham@arm.com
125010196SCurtis.Dunham@arm.com# The MakeEnvirons Builder defers the full dependency collection until
125110196SCurtis.Dunham@arm.com# after processing the ISA definition (due to dynamically generated
125210196SCurtis.Dunham@arm.com# source files).  Add this dependency to all targets so they will wait
125310196SCurtis.Dunham@arm.com# until the environments are completely set up.  Otherwise, a second
125410196SCurtis.Dunham@arm.com# process (e.g. -j2 or higher) will try to compile the requested target,
125510196SCurtis.Dunham@arm.com# not know how, and fail.
125610196SCurtis.Dunham@arm.comenv.Append(BUILDERS = {'MakeEnvirons' :
125710196SCurtis.Dunham@arm.com                        Builder(action=MakeAction(makeEnvirons,
125810196SCurtis.Dunham@arm.com                                                  Transform("ENVIRONS", 1)))})
125910196SCurtis.Dunham@arm.com
126010196SCurtis.Dunham@arm.comisa_target = env['PHONY_BASE'] + '-deps'
126110196SCurtis.Dunham@arm.comenvirons   = env['PHONY_BASE'] + '-environs'
126210196SCurtis.Dunham@arm.comenv.Depends('#all-deps',     isa_target)
126310196SCurtis.Dunham@arm.comenv.Depends('#all-environs', environs)
126410196SCurtis.Dunham@arm.comenv.ScanISA(isa_target, File('arch/%s/generated/inc.d' % env['TARGET_ISA']))
126510196SCurtis.Dunham@arm.comenvSetup = env.MakeEnvirons(environs, isa_target)
126610196SCurtis.Dunham@arm.com
126710196SCurtis.Dunham@arm.com# make sure no -deps targets occur before all ISAs are complete
126810196SCurtis.Dunham@arm.comenv.Depends(isa_target, '#all-isas')
126910196SCurtis.Dunham@arm.com# likewise for -environs targets and all the -deps targets
127010196SCurtis.Dunham@arm.comenv.Depends(environs, '#all-deps')
1271