SConscript revision 10457
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
3826658Snate@binkert.org    for i,isa in enumerate(isas):
3837673Snate@binkert.org        code('#define $0 $1', define(isa), i + 1)
3847673Snate@binkert.org
3857673Snate@binkert.org    code('''
3867673Snate@binkert.org
3877673Snate@binkert.org#define THE_ISA ${{define(target_isa)}}
3887673Snate@binkert.org#define TheISA ${{namespace(target_isa)}}
3899048SAli.Saidi@ARM.com#define THE_ISA_STR "${{target_isa}}"
3907673Snate@binkert.org
3917673Snate@binkert.org#endif // __CONFIG_THE_ISA_HH__''')
3927673Snate@binkert.org
3937673Snate@binkert.org    code.write(str(target[0]))
3946658Snate@binkert.org
3957756SAli.Saidi@ARM.comenv.Command('config/the_isa.hh', map(Value, all_isa_list),
3967816Ssteve.reinhardt@amd.com            MakeAction(makeTheISA, Transform("CFG ISA", 0)))
3976658Snate@binkert.org
3984382Sbinkertn@umich.edu########################################################################
3994382Sbinkertn@umich.edu#
4004762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
4014762Snate@binkert.org# should all have been added in the SConscripts above
4024762Snate@binkert.org#
4036654Snate@binkert.orgSimObject.fixed = True
4046654Snate@binkert.org
4055517Snate@binkert.orgclass DictImporter(object):
4065517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
4075517Snate@binkert.org    map to arbitrary filenames.'''
4085517Snate@binkert.org    def __init__(self, modules):
4095517Snate@binkert.org        self.modules = modules
4105517Snate@binkert.org        self.installed = set()
4115517Snate@binkert.org
4125517Snate@binkert.org    def __del__(self):
4135517Snate@binkert.org        self.unload()
4145517Snate@binkert.org
4155517Snate@binkert.org    def unload(self):
4165517Snate@binkert.org        import sys
4175517Snate@binkert.org        for module in self.installed:
4185517Snate@binkert.org            del sys.modules[module]
4195517Snate@binkert.org        self.installed = set()
4205517Snate@binkert.org
4215517Snate@binkert.org    def find_module(self, fullname, path):
4226654Snate@binkert.org        if fullname == 'm5.defines':
4235517Snate@binkert.org            return self
4245517Snate@binkert.org
4255517Snate@binkert.org        if fullname == 'm5.objects':
4265517Snate@binkert.org            return self
4275517Snate@binkert.org
4285517Snate@binkert.org        if fullname.startswith('m5.internal'):
4295517Snate@binkert.org            return None
4305517Snate@binkert.org
4316143Snate@binkert.org        source = self.modules.get(fullname, None)
4326654Snate@binkert.org        if source is not None and fullname.startswith('m5.objects'):
4335517Snate@binkert.org            return self
4345517Snate@binkert.org
4355517Snate@binkert.org        return None
4365517Snate@binkert.org
4375517Snate@binkert.org    def load_module(self, fullname):
4385517Snate@binkert.org        mod = imp.new_module(fullname)
4395517Snate@binkert.org        sys.modules[fullname] = mod
4405517Snate@binkert.org        self.installed.add(fullname)
4415517Snate@binkert.org
4425517Snate@binkert.org        mod.__loader__ = self
4435517Snate@binkert.org        if fullname == 'm5.objects':
4445517Snate@binkert.org            mod.__path__ = fullname.split('.')
4455517Snate@binkert.org            return mod
4465517Snate@binkert.org
4476654Snate@binkert.org        if fullname == 'm5.defines':
4486654Snate@binkert.org            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
4495517Snate@binkert.org            return mod
4505517Snate@binkert.org
4516143Snate@binkert.org        source = self.modules[fullname]
4526143Snate@binkert.org        if source.modname == '__init__':
4536143Snate@binkert.org            mod.__path__ = source.modpath
4546727Ssteve.reinhardt@amd.com        mod.__file__ = source.abspath
4555517Snate@binkert.org
4566727Ssteve.reinhardt@amd.com        exec file(source.abspath, 'r') in mod.__dict__
4575517Snate@binkert.org
4585517Snate@binkert.org        return mod
4595517Snate@binkert.org
4606654Snate@binkert.orgimport m5.SimObject
4616654Snate@binkert.orgimport m5.params
4627673Snate@binkert.orgfrom m5.util import code_formatter
4636654Snate@binkert.org
4646654Snate@binkert.orgm5.SimObject.clear()
4656654Snate@binkert.orgm5.params.clear()
4666654Snate@binkert.org
4675517Snate@binkert.org# install the python importer so we can grab stuff from the source
4685517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
4695517Snate@binkert.org# else we won't know about them for the rest of the stuff.
4706143Snate@binkert.orgimporter = DictImporter(PySource.modules)
4715517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
4724762Snate@binkert.org
4735517Snate@binkert.org# import all sim objects so we can populate the all_objects list
4745517Snate@binkert.org# make sure that we're working with a list, then let's sort it
4756143Snate@binkert.orgfor modname in SimObject.modnames:
4766143Snate@binkert.org    exec('from m5.objects import %s' % modname)
4775517Snate@binkert.org
4785517Snate@binkert.org# we need to unload all of the currently imported modules so that they
4795517Snate@binkert.org# will be re-imported the next time the sconscript is run
4805517Snate@binkert.orgimporter.unload()
4815517Snate@binkert.orgsys.meta_path.remove(importer)
4825517Snate@binkert.org
4835517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
4845517Snate@binkert.orgall_enums = m5.params.allEnums
4855517Snate@binkert.org
4869338SAndreas.Sandberg@arm.comif m5.SimObject.noCxxHeader:
4879338SAndreas.Sandberg@arm.com    print >> sys.stderr, \
4889338SAndreas.Sandberg@arm.com        "warning: At least one SimObject lacks a header specification. " \
4899338SAndreas.Sandberg@arm.com        "This can cause unexpected results in the generated SWIG " \
4909338SAndreas.Sandberg@arm.com        "wrappers."
4919338SAndreas.Sandberg@arm.com
4928596Ssteve.reinhardt@amd.com# Find param types that need to be explicitly wrapped with swig.
4938596Ssteve.reinhardt@amd.com# These will be recognized because the ParamDesc will have a
4948596Ssteve.reinhardt@amd.com# swig_decl() method.  Most param types are based on types that don't
4958596Ssteve.reinhardt@amd.com# need this, either because they're based on native types (like Int)
4968596Ssteve.reinhardt@amd.com# or because they're SimObjects (which get swigged independently).
4978596Ssteve.reinhardt@amd.com# For now the only things handled here are VectorParam types.
4988596Ssteve.reinhardt@amd.comparams_to_swig = {}
4996143Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()):
5005517Snate@binkert.org    for param in obj._params.local.values():
5016654Snate@binkert.org        # load the ptype attribute now because it depends on the
5026654Snate@binkert.org        # current version of SimObject.allClasses, but when scons
5036654Snate@binkert.org        # actually uses the value, all versions of
5046654Snate@binkert.org        # SimObject.allClasses will have been loaded
5056654Snate@binkert.org        param.ptype
5066654Snate@binkert.org
5075517Snate@binkert.org        if not hasattr(param, 'swig_decl'):
5085517Snate@binkert.org            continue
5095517Snate@binkert.org        pname = param.ptype_str
5108596Ssteve.reinhardt@amd.com        if pname not in params_to_swig:
5118596Ssteve.reinhardt@amd.com            params_to_swig[pname] = param
5124762Snate@binkert.org
5134762Snate@binkert.org########################################################################
5144762Snate@binkert.org#
5154762Snate@binkert.org# calculate extra dependencies
5164762Snate@binkert.org#
5174762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
5187675Snate@binkert.orgdepends = [ PySource.modules[dep].snode for dep in module_depends ]
5194762Snate@binkert.org
5204762Snate@binkert.org########################################################################
5214762Snate@binkert.org#
5224762Snate@binkert.org# Commands for the basic automatically generated python files
5234382Sbinkertn@umich.edu#
5244382Sbinkertn@umich.edu
5255517Snate@binkert.org# Generate Python file containing a dict specifying the current
5266654Snate@binkert.org# buildEnv flags.
5275517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
5288126Sgblack@eecs.umich.edu    build_env = source[0].get_contents()
5296654Snate@binkert.org
5307673Snate@binkert.org    code = code_formatter()
5316654Snate@binkert.org    code("""
5326654Snate@binkert.orgimport m5.internal
5336654Snate@binkert.orgimport m5.util
5346654Snate@binkert.org
5356654Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env)
5366654Snate@binkert.org
5376654Snate@binkert.orgcompileDate = m5.internal.core.compileDate
5386669Snate@binkert.org_globals = globals()
5396669Snate@binkert.orgfor key,val in m5.internal.core.__dict__.iteritems():
5406669Snate@binkert.org    if key.startswith('flag_'):
5416669Snate@binkert.org        flag = key[5:]
5426669Snate@binkert.org        _globals[flag] = val
5436669Snate@binkert.orgdel _globals
5446654Snate@binkert.org""")
5457673Snate@binkert.org    code.write(target[0].abspath)
5465517Snate@binkert.org
5478126Sgblack@eecs.umich.edudefines_info = Value(build_env)
5485798Snate@binkert.org# Generate a file with all of the compile options in it
5497756SAli.Saidi@ARM.comenv.Command('python/m5/defines.py', defines_info,
5507816Ssteve.reinhardt@amd.com            MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
5515798Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
5525798Snate@binkert.org
5535517Snate@binkert.org# Generate python file containing info about the M5 source code
5545517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
5557673Snate@binkert.org    code = code_formatter()
5565517Snate@binkert.org    for src in source:
5575517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
5587673Snate@binkert.org        code('$src = ${{repr(data)}}')
5597673Snate@binkert.org    code.write(str(target[0]))
5605517Snate@binkert.org
5615798Snate@binkert.org# Generate a file that wraps the basic top level files
5625798Snate@binkert.orgenv.Command('python/m5/info.py',
5638333Snate@binkert.org            [ '#/COPYING', '#/LICENSE', '#/README', ],
5647816Ssteve.reinhardt@amd.com            MakeAction(makeInfoPyFile, Transform("INFO")))
5655798Snate@binkert.orgPySource('m5', 'python/m5/info.py')
5665798Snate@binkert.org
5674762Snate@binkert.org########################################################################
5684762Snate@binkert.org#
5694762Snate@binkert.org# Create all of the SimObject param headers and enum headers
5704762Snate@binkert.org#
5714762Snate@binkert.org
5728596Ssteve.reinhardt@amd.comdef createSimObjectParamStruct(target, source, env):
5735517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5745517Snate@binkert.org
5755517Snate@binkert.org    name = str(source[0].get_contents())
5765517Snate@binkert.org    obj = sim_objects[name]
5775517Snate@binkert.org
5787673Snate@binkert.org    code = code_formatter()
5798596Ssteve.reinhardt@amd.com    obj.cxx_param_decl(code)
5807673Snate@binkert.org    code.write(target[0].abspath)
5815517Snate@binkert.org
5828596Ssteve.reinhardt@amd.comdef createParamSwigWrapper(target, source, env):
5835517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5845517Snate@binkert.org
5855517Snate@binkert.org    name = str(source[0].get_contents())
5868596Ssteve.reinhardt@amd.com    param = params_to_swig[name]
5875517Snate@binkert.org
5887673Snate@binkert.org    code = code_formatter()
5897673Snate@binkert.org    param.swig_decl(code)
5907673Snate@binkert.org    code.write(target[0].abspath)
5915517Snate@binkert.org
5925517Snate@binkert.orgdef createEnumStrings(target, source, env):
5935517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
5945517Snate@binkert.org
5955517Snate@binkert.org    name = str(source[0].get_contents())
5965517Snate@binkert.org    obj = all_enums[name]
5975517Snate@binkert.org
5987673Snate@binkert.org    code = code_formatter()
5997673Snate@binkert.org    obj.cxx_def(code)
6007673Snate@binkert.org    code.write(target[0].abspath)
6015517Snate@binkert.org
6028596Ssteve.reinhardt@amd.comdef createEnumDecls(target, source, env):
6035517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6045517Snate@binkert.org
6055517Snate@binkert.org    name = str(source[0].get_contents())
6065517Snate@binkert.org    obj = all_enums[name]
6075517Snate@binkert.org
6087673Snate@binkert.org    code = code_formatter()
6097673Snate@binkert.org    obj.cxx_decl(code)
6107673Snate@binkert.org    code.write(target[0].abspath)
6115517Snate@binkert.org
6128596Ssteve.reinhardt@amd.comdef createEnumSwigWrapper(target, source, env):
6137675Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6147675Snate@binkert.org
6157675Snate@binkert.org    name = str(source[0].get_contents())
6167675Snate@binkert.org    obj = all_enums[name]
6177675Snate@binkert.org
6187675Snate@binkert.org    code = code_formatter()
6198596Ssteve.reinhardt@amd.com    obj.swig_decl(code)
6207675Snate@binkert.org    code.write(target[0].abspath)
6217675Snate@binkert.org
6228596Ssteve.reinhardt@amd.comdef createSimObjectSwigWrapper(target, source, env):
6238596Ssteve.reinhardt@amd.com    name = source[0].get_contents()
6248596Ssteve.reinhardt@amd.com    obj = sim_objects[name]
6258596Ssteve.reinhardt@amd.com
6268596Ssteve.reinhardt@amd.com    code = code_formatter()
6278596Ssteve.reinhardt@amd.com    obj.swig_decl(code)
6288596Ssteve.reinhardt@amd.com    code.write(target[0].abspath)
6298596Ssteve.reinhardt@amd.com
63010454SCurtis.Dunham@arm.com# dummy target for generated code
63110454SCurtis.Dunham@arm.com# we start out with all the Source files so they get copied to build/*/ also.
63210454SCurtis.Dunham@arm.comSWIG = env.Dummy('swig', [s.tnode for s in Source.get()])
63310454SCurtis.Dunham@arm.com
6348596Ssteve.reinhardt@amd.com# Generate all of the SimObject param C++ struct header files
6354762Snate@binkert.orgparams_hh_files = []
6366143Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()):
6376143Snate@binkert.org    py_source = PySource.modules[simobj.__module__]
6386143Snate@binkert.org    extra_deps = [ py_source.tnode ]
6394762Snate@binkert.org
6404762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
6414762Snate@binkert.org    params_hh_files.append(hh_file)
6427756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
6438596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
6444762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
64510454SCurtis.Dunham@arm.com    env.Depends(SWIG, hh_file)
6464762Snate@binkert.org
6478596Ssteve.reinhardt@amd.com# Generate any needed param SWIG wrapper files
6485463Snate@binkert.orgparams_i_files = []
6498596Ssteve.reinhardt@amd.comfor name,param in params_to_swig.iteritems():
6508596Ssteve.reinhardt@amd.com    i_file = File('python/m5/internal/%s.i' % (param.swig_module_name()))
6515463Snate@binkert.org    params_i_files.append(i_file)
6527756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
6538596Ssteve.reinhardt@amd.com                MakeAction(createParamSwigWrapper, Transform("SW PARAM")))
6544762Snate@binkert.org    env.Depends(i_file, depends)
65510454SCurtis.Dunham@arm.com    env.Depends(SWIG, i_file)
6567677Snate@binkert.org    SwigSource('m5.internal', i_file)
6574762Snate@binkert.org
6584762Snate@binkert.org# Generate all enum header files
6596143Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()):
6606143Snate@binkert.org    py_source = PySource.modules[enum.__module__]
6616143Snate@binkert.org    extra_deps = [ py_source.tnode ]
6624762Snate@binkert.org
6634762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
6647756SAli.Saidi@ARM.com    env.Command(cc_file, Value(name),
6657816Ssteve.reinhardt@amd.com                MakeAction(createEnumStrings, Transform("ENUM STR")))
6664762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
66710454SCurtis.Dunham@arm.com    env.Depends(SWIG, cc_file)
6684762Snate@binkert.org    Source(cc_file)
6694762Snate@binkert.org
6704762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
6717756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
6728596Ssteve.reinhardt@amd.com                MakeAction(createEnumDecls, Transform("ENUMDECL")))
6734762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
67410454SCurtis.Dunham@arm.com    env.Depends(SWIG, hh_file)
6754762Snate@binkert.org
6767677Snate@binkert.org    i_file = File('python/m5/internal/enum_%s.i' % name)
6777756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
6788596Ssteve.reinhardt@amd.com                MakeAction(createEnumSwigWrapper, Transform("ENUMSWIG")))
6797675Snate@binkert.org    env.Depends(i_file, depends + extra_deps)
68010454SCurtis.Dunham@arm.com    env.Depends(SWIG, i_file)
6817677Snate@binkert.org    SwigSource('m5.internal', i_file)
6825517Snate@binkert.org
6838596Ssteve.reinhardt@amd.com# Generate SimObject SWIG wrapper files
6849248SAndreas.Sandberg@arm.comfor name,simobj in sim_objects.iteritems():
6859248SAndreas.Sandberg@arm.com    py_source = PySource.modules[simobj.__module__]
6869248SAndreas.Sandberg@arm.com    extra_deps = [ py_source.tnode ]
6879248SAndreas.Sandberg@arm.com
6888596Ssteve.reinhardt@amd.com    i_file = File('python/m5/internal/param_%s.i' % name)
6898596Ssteve.reinhardt@amd.com    env.Command(i_file, Value(name),
6908596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectSwigWrapper, Transform("SO SWIG")))
6919248SAndreas.Sandberg@arm.com    env.Depends(i_file, depends + extra_deps)
6928596Ssteve.reinhardt@amd.com    SwigSource('m5.internal', i_file)
6934762Snate@binkert.org
6947674Snate@binkert.org# Generate the main swig init file
6957674Snate@binkert.orgdef makeEmbeddedSwigInit(target, source, env):
6967674Snate@binkert.org    code = code_formatter()
6977674Snate@binkert.org    module = source[0].get_contents()
6987674Snate@binkert.org    code('''\
6997674Snate@binkert.org#include "sim/init.hh"
7007674Snate@binkert.org
7017674Snate@binkert.orgextern "C" {
7027674Snate@binkert.org    void init_${module}();
7037674Snate@binkert.org}
7047674Snate@binkert.org
7057674Snate@binkert.orgEmbeddedSwig embed_swig_${module}(init_${module});
7067674Snate@binkert.org''')
7077674Snate@binkert.org    code.write(str(target[0]))
7087674Snate@binkert.org    
7094762Snate@binkert.org# Build all swig modules
7106143Snate@binkert.orgfor swig in SwigSource.all:
7116143Snate@binkert.org    env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
7127756SAli.Saidi@ARM.com                MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
7137816Ssteve.reinhardt@amd.com                '-o ${TARGETS[0]} $SOURCES', Transform("SWIG")))
7148235Snate@binkert.org    cc_file = str(swig.tnode)
7158596Ssteve.reinhardt@amd.com    init_file = '%s/%s_init.cc' % (dirname(cc_file), basename(cc_file))
7167756SAli.Saidi@ARM.com    env.Command(init_file, Value(swig.module),
7177816Ssteve.reinhardt@amd.com                MakeAction(makeEmbeddedSwigInit, Transform("EMBED SW")))
71810454SCurtis.Dunham@arm.com    env.Depends(SWIG, init_file)
7198235Snate@binkert.org    Source(init_file, **swig.guards)
7204382Sbinkertn@umich.edu
7219396Sandreas.hansson@arm.com# Build all protocol buffers if we have got protoc and protobuf available
7229396Sandreas.hansson@arm.comif env['HAVE_PROTOBUF']:
7239396Sandreas.hansson@arm.com    for proto in ProtoBuf.all:
7249396Sandreas.hansson@arm.com        # Use both the source and header as the target, and the .proto
7259396Sandreas.hansson@arm.com        # file as the source. When executing the protoc compiler, also
7269396Sandreas.hansson@arm.com        # specify the proto_path to avoid having the generated files
7279396Sandreas.hansson@arm.com        # include the path.
7289396Sandreas.hansson@arm.com        env.Command([proto.cc_file, proto.hh_file], proto.tnode,
7299396Sandreas.hansson@arm.com                    MakeAction('$PROTOC --cpp_out ${TARGET.dir} '
7309396Sandreas.hansson@arm.com                               '--proto_path ${SOURCE.dir} $SOURCE',
7319396Sandreas.hansson@arm.com                               Transform("PROTOC")))
7329396Sandreas.hansson@arm.com
73310454SCurtis.Dunham@arm.com        env.Depends(SWIG, [proto.cc_file, proto.hh_file])
7349396Sandreas.hansson@arm.com        # Add the C++ source file
7359396Sandreas.hansson@arm.com        Source(proto.cc_file, **proto.guards)
7369396Sandreas.hansson@arm.comelif ProtoBuf.all:
7379396Sandreas.hansson@arm.com    print 'Got protobuf to build, but lacks support!'
7389396Sandreas.hansson@arm.com    Exit(1)
7399396Sandreas.hansson@arm.com
7408232Snate@binkert.org#
7418232Snate@binkert.org# Handle debug flags
7428232Snate@binkert.org#
7438232Snate@binkert.orgdef makeDebugFlagCC(target, source, env):
7448232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
7456229Snate@binkert.org
74610455SCurtis.Dunham@arm.com    code = code_formatter()
7476229Snate@binkert.org
74810455SCurtis.Dunham@arm.com    # delay definition of CompoundFlags until after all the definition
74910455SCurtis.Dunham@arm.com    # of all constituent SimpleFlags
75010455SCurtis.Dunham@arm.com    comp_code = code_formatter()
7515517Snate@binkert.org
7525517Snate@binkert.org    # file header
7537673Snate@binkert.org    code('''
7545517Snate@binkert.org/*
75510455SCurtis.Dunham@arm.com * DO NOT EDIT THIS FILE! Automatically generated by SCons.
7565517Snate@binkert.org */
7575517Snate@binkert.org
7588232Snate@binkert.org#include "base/debug.hh"
75910455SCurtis.Dunham@arm.com
76010455SCurtis.Dunham@arm.comnamespace Debug {
76110455SCurtis.Dunham@arm.com
7627673Snate@binkert.org''')
7637673Snate@binkert.org
76410455SCurtis.Dunham@arm.com    for name, flag in sorted(source[0].read().iteritems()):
76510455SCurtis.Dunham@arm.com        n, compound, desc = flag
76610455SCurtis.Dunham@arm.com        assert n == name
7675517Snate@binkert.org
76810455SCurtis.Dunham@arm.com        if not compound:
76910455SCurtis.Dunham@arm.com            code('SimpleFlag $name("$name", "$desc");')
77010455SCurtis.Dunham@arm.com        else:
77110455SCurtis.Dunham@arm.com            comp_code('CompoundFlag $name("$name", "$desc",')
77210455SCurtis.Dunham@arm.com            comp_code.indent()
77310455SCurtis.Dunham@arm.com            last = len(compound) - 1
77410455SCurtis.Dunham@arm.com            for i,flag in enumerate(compound):
77510455SCurtis.Dunham@arm.com                if i != last:
77610455SCurtis.Dunham@arm.com                    comp_code('$flag,')
77710455SCurtis.Dunham@arm.com                else:
77810455SCurtis.Dunham@arm.com                    comp_code('$flag);')
77910455SCurtis.Dunham@arm.com            comp_code.dedent()
7805517Snate@binkert.org
78110455SCurtis.Dunham@arm.com    code.append(comp_code)
7828232Snate@binkert.org    code()
7838232Snate@binkert.org    code('} // namespace Debug')
7845517Snate@binkert.org
7857673Snate@binkert.org    code.write(str(target[0]))
7865517Snate@binkert.org
7878232Snate@binkert.orgdef makeDebugFlagHH(target, source, env):
7888232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
7895517Snate@binkert.org
7908232Snate@binkert.org    val = eval(source[0].get_contents())
7918232Snate@binkert.org    name, compound, desc = val
7928232Snate@binkert.org
7937673Snate@binkert.org    code = code_formatter()
7945517Snate@binkert.org
7955517Snate@binkert.org    # file header boilerplate
7967673Snate@binkert.org    code('''\
7975517Snate@binkert.org/*
79810455SCurtis.Dunham@arm.com * DO NOT EDIT THIS FILE! Automatically generated by SCons.
7995517Snate@binkert.org */
8005517Snate@binkert.org
8018232Snate@binkert.org#ifndef __DEBUG_${name}_HH__
8028232Snate@binkert.org#define __DEBUG_${name}_HH__
8035517Snate@binkert.org
8048232Snate@binkert.orgnamespace Debug {
8058232Snate@binkert.org''')
8065517Snate@binkert.org
8078232Snate@binkert.org    if compound:
8088232Snate@binkert.org        code('class CompoundFlag;')
8098232Snate@binkert.org    code('class SimpleFlag;')
8105517Snate@binkert.org
8118232Snate@binkert.org    if compound:
8128232Snate@binkert.org        code('extern CompoundFlag $name;')
8138232Snate@binkert.org        for flag in compound:
8148232Snate@binkert.org            code('extern SimpleFlag $flag;')
8158232Snate@binkert.org    else:
8168232Snate@binkert.org        code('extern SimpleFlag $name;')
8175517Snate@binkert.org
8188232Snate@binkert.org    code('''
8198232Snate@binkert.org}
8205517Snate@binkert.org
8218232Snate@binkert.org#endif // __DEBUG_${name}_HH__
8227673Snate@binkert.org''')
8235517Snate@binkert.org
8247673Snate@binkert.org    code.write(str(target[0]))
8255517Snate@binkert.org
8268232Snate@binkert.orgfor name,flag in sorted(debug_flags.iteritems()):
8278232Snate@binkert.org    n, compound, desc = flag
8288232Snate@binkert.org    assert n == name
8295192Ssaidi@eecs.umich.edu
83010454SCurtis.Dunham@arm.com    hh_file = 'debug/%s.hh' % name
83110454SCurtis.Dunham@arm.com    env.Command(hh_file, Value(flag),
8328232Snate@binkert.org                MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
83310455SCurtis.Dunham@arm.com    env.Depends(SWIG, hh_file)
83410455SCurtis.Dunham@arm.com
83510455SCurtis.Dunham@arm.comenv.Command('debug/flags.cc', Value(debug_flags),
83610455SCurtis.Dunham@arm.com            MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
83710455SCurtis.Dunham@arm.comenv.Depends(SWIG, 'debug/flags.cc')
83810455SCurtis.Dunham@arm.comSource('debug/flags.cc')
8395192Ssaidi@eecs.umich.edu
8407674Snate@binkert.org# Embed python files.  All .py files that have been indicated by a
8415522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
8425522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
8437674Snate@binkert.org# byte code, compress it, and then generate a c++ file that
8447674Snate@binkert.org# inserts the result into an array.
8457674Snate@binkert.orgdef embedPyFile(target, source, env):
8467674Snate@binkert.org    def c_str(string):
8477674Snate@binkert.org        if string is None:
8487674Snate@binkert.org            return "0"
8497674Snate@binkert.org        return '"%s"' % string
8507674Snate@binkert.org
8515522Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
8525522Snate@binkert.org    it, compress it, and stick it into an asm file so the code appears
8535522Snate@binkert.org    as just bytes with a label in the data section'''
8545517Snate@binkert.org
8555522Snate@binkert.org    src = file(str(source[0]), 'r').read()
8565517Snate@binkert.org
8576143Snate@binkert.org    pysource = PySource.tnodes[source[0]]
8586727Ssteve.reinhardt@amd.com    compiled = compile(src, pysource.abspath, 'exec')
8595522Snate@binkert.org    marshalled = marshal.dumps(compiled)
8605522Snate@binkert.org    compressed = zlib.compress(marshalled)
8615522Snate@binkert.org    data = compressed
8627674Snate@binkert.org    sym = pysource.symname
8635517Snate@binkert.org
8647673Snate@binkert.org    code = code_formatter()
8657673Snate@binkert.org    code('''\
8667674Snate@binkert.org#include "sim/init.hh"
8677673Snate@binkert.org
8687674Snate@binkert.orgnamespace {
8697674Snate@binkert.org
8708946Sandreas.hansson@arm.comconst uint8_t data_${sym}[] = {
8717674Snate@binkert.org''')
8727674Snate@binkert.org    code.indent()
8737674Snate@binkert.org    step = 16
8745522Snate@binkert.org    for i in xrange(0, len(data), step):
8755522Snate@binkert.org        x = array.array('B', data[i:i+step])
8767674Snate@binkert.org        code(''.join('%d,' % d for d in x))
8777674Snate@binkert.org    code.dedent()
8787674Snate@binkert.org    
8797674Snate@binkert.org    code('''};
8807673Snate@binkert.org
8817674Snate@binkert.orgEmbeddedPython embedded_${sym}(
8827674Snate@binkert.org    ${{c_str(pysource.arcname)}},
8837674Snate@binkert.org    ${{c_str(pysource.abspath)}},
8847674Snate@binkert.org    ${{c_str(pysource.modpath)}},
8857674Snate@binkert.org    data_${sym},
8867674Snate@binkert.org    ${{len(data)}},
8877674Snate@binkert.org    ${{len(marshalled)}});
8887674Snate@binkert.org
8897811Ssteve.reinhardt@amd.com} // anonymous namespace
8907674Snate@binkert.org''')
8917673Snate@binkert.org    code.write(str(target[0]))
8925522Snate@binkert.org
8936143Snate@binkert.orgfor source in PySource.all:
89410453SAndrew.Bardsley@arm.com    env.Command(source.cpp, source.tnode,
8957816Ssteve.reinhardt@amd.com                MakeAction(embedPyFile, Transform("EMBED PY")))
89610454SCurtis.Dunham@arm.com    env.Depends(SWIG, source.cpp)
89710453SAndrew.Bardsley@arm.com    Source(source.cpp, skip_no_python=True)
8984382Sbinkertn@umich.edu
8994382Sbinkertn@umich.edu########################################################################
9004382Sbinkertn@umich.edu#
9014382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
9024382Sbinkertn@umich.edu# a slightly different build environment.
9034382Sbinkertn@umich.edu#
9044382Sbinkertn@umich.edu
9054382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
90610196SCurtis.Dunham@arm.comdate_source = Source('base/date.cc', skip_lib=True)
9074382Sbinkertn@umich.edu
90810196SCurtis.Dunham@arm.com# Capture this directory for the closure makeEnv, otherwise when it is
90910196SCurtis.Dunham@arm.com# called, it won't know what directory it should use.
91010196SCurtis.Dunham@arm.comvariant_dir = Dir('.').path
91110196SCurtis.Dunham@arm.comdef variant(*path):
91210196SCurtis.Dunham@arm.com    return os.path.join(variant_dir, *path)
91310196SCurtis.Dunham@arm.comdef variantd(*path):
91410196SCurtis.Dunham@arm.com    return variant(*path)+'/'
915955SN/A
9162655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
9172655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
9182655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
9192655Sstever@eecs.umich.edu# build environment vars.
92010196SCurtis.Dunham@arm.comdef makeEnv(env, label, objsfx, strip = False, **kwargs):
9215601Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
9225601Snate@binkert.org    # name.  Use '_' instead.
92310196SCurtis.Dunham@arm.com    libname = variant('gem5_' + label)
92410196SCurtis.Dunham@arm.com    exename = variant('gem5.' + label)
92510196SCurtis.Dunham@arm.com    secondary_exename = variant('m5.' + label)
9265522Snate@binkert.org
9275863Snate@binkert.org    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
9285601Snate@binkert.org    new_env.Label = label
9295601Snate@binkert.org    new_env.Append(**kwargs)
9305601Snate@binkert.org
9315863Snate@binkert.org    swig_env = new_env.Clone()
9329556Sandreas.hansson@arm.com
9339556Sandreas.hansson@arm.com    # Both gcc and clang have issues with unused labels and values in
9349556Sandreas.hansson@arm.com    # the SWIG generated code
9359556Sandreas.hansson@arm.com    swig_env.Append(CCFLAGS=['-Wno-unused-label', '-Wno-unused-value'])
9369556Sandreas.hansson@arm.com
9379556Sandreas.hansson@arm.com    # Add additional warnings here that should not be applied to
9389556Sandreas.hansson@arm.com    # the SWIG generated code
9399556Sandreas.hansson@arm.com    new_env.Append(CXXFLAGS='-Wmissing-declarations')
9409556Sandreas.hansson@arm.com
9415559Snate@binkert.org    if env['GCC']:
9429556Sandreas.hansson@arm.com        # Depending on the SWIG version, we also need to supress
9439618Ssteve.reinhardt@amd.com        # warnings about uninitialized variables and missing field
9449618Ssteve.reinhardt@amd.com        # initializers.
9459618Ssteve.reinhardt@amd.com        swig_env.Append(CCFLAGS=['-Wno-uninitialized',
94610238Sandreas.hansson@arm.com                                 '-Wno-missing-field-initializers',
94710238Sandreas.hansson@arm.com                                 '-Wno-unused-but-set-variable'])
9489554Sandreas.hansson@arm.com
9499556Sandreas.hansson@arm.com        # If gcc supports it, also warn for deletion of derived
9509556Sandreas.hansson@arm.com        # classes with non-virtual desctructors. For gcc >= 4.7 we
9519556Sandreas.hansson@arm.com        # also have to disable warnings about the SWIG code having
9529556Sandreas.hansson@arm.com        # potentially uninitialized variables.
9539555Sandreas.hansson@arm.com        if compareVersions(env['GCC_VERSION'], '4.7') >= 0:
9549555Sandreas.hansson@arm.com            new_env.Append(CXXFLAGS='-Wdelete-non-virtual-dtor')
9559556Sandreas.hansson@arm.com            swig_env.Append(CCFLAGS='-Wno-maybe-uninitialized')
95610457Sandreas.hansson@arm.com
95710457Sandreas.hansson@arm.com        # Only gcc >= 4.9 supports UBSan, so check both the version
95810457Sandreas.hansson@arm.com        # and the command-line option before adding the compiler and
95910457Sandreas.hansson@arm.com        # linker flags.
96010457Sandreas.hansson@arm.com        if GetOption('with_ubsan') and \
96110457Sandreas.hansson@arm.com                compareVersions(env['GCC_VERSION'], '4.9') >= 0:
96210457Sandreas.hansson@arm.com            new_env.Append(CCFLAGS='-fsanitize=undefined')
96310457Sandreas.hansson@arm.com            new_env.Append(LINKFLAGS='-fsanitize=undefined')
96410457Sandreas.hansson@arm.com
9658737Skoansin.tan@gmail.com    if env['CLANG']:
9669556Sandreas.hansson@arm.com        # Always enable the warning for deletion of derived classes
9679556Sandreas.hansson@arm.com        # with non-virtual destructors
9689556Sandreas.hansson@arm.com        new_env.Append(CXXFLAGS=['-Wdelete-non-virtual-dtor'])
9699554Sandreas.hansson@arm.com
97010278SAndreas.Sandberg@ARM.com        swig_env.Append(CCFLAGS=[
97110278SAndreas.Sandberg@ARM.com                # Some versions of SWIG can return uninitialized values
97210278SAndreas.Sandberg@ARM.com                '-Wno-sometimes-uninitialized',
97310278SAndreas.Sandberg@ARM.com                # Register storage is requested in a lot of places in
97410278SAndreas.Sandberg@ARM.com                # SWIG-generated code.
97510278SAndreas.Sandberg@ARM.com                '-Wno-deprecated-register',
97610278SAndreas.Sandberg@ARM.com                ])
97710278SAndreas.Sandberg@ARM.com
97810457Sandreas.hansson@arm.com        # All supported clang versions have support for UBSan, so if
97910457Sandreas.hansson@arm.com        # asked to use it, append the compiler and linker flags.
98010457Sandreas.hansson@arm.com        if GetOption('with_ubsan'):
98110457Sandreas.hansson@arm.com            new_env.Append(CCFLAGS='-fsanitize=undefined')
98210457Sandreas.hansson@arm.com            new_env.Append(LINKFLAGS='-fsanitize=undefined')
98310457Sandreas.hansson@arm.com
9848945Ssteve.reinhardt@amd.com    werror_env = new_env.Clone()
9858945Ssteve.reinhardt@amd.com    werror_env.Append(CCFLAGS='-Werror')
9868945Ssteve.reinhardt@amd.com
9876143Snate@binkert.org    def make_obj(source, static, extra_deps = None):
9886143Snate@binkert.org        '''This function adds the specified source to the correct
9896143Snate@binkert.org        build environment, and returns the corresponding SCons Object
9906143Snate@binkert.org        nodes'''
9916143Snate@binkert.org
9926143Snate@binkert.org        if source.swig:
9936143Snate@binkert.org            env = swig_env
9948945Ssteve.reinhardt@amd.com        elif source.Werror:
9958945Ssteve.reinhardt@amd.com            env = werror_env
9966143Snate@binkert.org        else:
9976143Snate@binkert.org            env = new_env
9986143Snate@binkert.org
9996143Snate@binkert.org        if static:
10006143Snate@binkert.org            obj = env.StaticObject(source.tnode)
10016143Snate@binkert.org        else:
10026143Snate@binkert.org            obj = env.SharedObject(source.tnode)
10036143Snate@binkert.org
10046143Snate@binkert.org        if extra_deps:
10056143Snate@binkert.org            env.Depends(obj, extra_deps)
10066143Snate@binkert.org
10076143Snate@binkert.org        return obj
10086143Snate@binkert.org
100910453SAndrew.Bardsley@arm.com    lib_guards = {'main': False, 'skip_lib': False}
101010453SAndrew.Bardsley@arm.com
101110453SAndrew.Bardsley@arm.com    # Without Python, leave out all SWIG and Python content from the
101210453SAndrew.Bardsley@arm.com    # library builds.  The option doesn't affect gem5 built as a program
101310453SAndrew.Bardsley@arm.com    if GetOption('without_python'):
101410453SAndrew.Bardsley@arm.com        lib_guards['skip_no_python'] = False
101510453SAndrew.Bardsley@arm.com
101610453SAndrew.Bardsley@arm.com    static_objs = [ make_obj(s, True) for s in Source.get(**lib_guards) ]
101710453SAndrew.Bardsley@arm.com    shared_objs = [ make_obj(s, False) for s in Source.get(**lib_guards) ]
10186143Snate@binkert.org
10196143Snate@binkert.org    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
10206143Snate@binkert.org    static_objs.append(static_date)
102110453SAndrew.Bardsley@arm.com
10226143Snate@binkert.org    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
10236240Snate@binkert.org    shared_objs.append(shared_date)
10245554Snate@binkert.org
10255522Snate@binkert.org    # First make a library of everything but main() so other programs can
10265522Snate@binkert.org    # link against m5.
10275797Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
10285797Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
10295522Snate@binkert.org
10305601Snate@binkert.org    # Now link a stub with main() and the static library.
10318233Snate@binkert.org    main_objs = [ make_obj(s, True) for s in Source.get(main=True) ]
10328233Snate@binkert.org
10338235Snate@binkert.org    for test in UnitTest.all:
10348235Snate@binkert.org        flags = { test.target : True }
10358235Snate@binkert.org        test_sources = Source.get(**flags)
10368235Snate@binkert.org        test_objs = [ make_obj(s, static=True) for s in test_sources ]
10379003SAli.Saidi@ARM.com        if test.main:
10389003SAli.Saidi@ARM.com            test_objs += main_objs
103910196SCurtis.Dunham@arm.com        path = variant('unittest/%s.%s' % (test.target, label))
104010196SCurtis.Dunham@arm.com        new_env.Program(path, test_objs + static_objs)
10418235Snate@binkert.org
10426143Snate@binkert.org    progname = exename
10432655Sstever@eecs.umich.edu    if strip:
10446143Snate@binkert.org        progname += '.unstripped'
10456143Snate@binkert.org
10468233Snate@binkert.org    targets = new_env.Program(progname, main_objs + static_objs)
10476143Snate@binkert.org
10486143Snate@binkert.org    if strip:
10494007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
10504596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
10514007Ssaidi@eecs.umich.edu        else:
10524596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
10537756SAli.Saidi@ARM.com        targets = new_env.Command(exename, progname,
10547816Ssteve.reinhardt@amd.com                    MakeAction(cmd, Transform("STRIP")))
10558334Snate@binkert.org
10568334Snate@binkert.org    new_env.Command(secondary_exename, exename,
10578334Snate@binkert.org            MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
10588334Snate@binkert.org
10595601Snate@binkert.org    new_env.M5Binary = targets[0]
106010196SCurtis.Dunham@arm.com    return new_env
10612655Sstever@eecs.umich.edu
10629225Sandreas.hansson@arm.com# Start out with the compiler flags common to all compilers,
10639225Sandreas.hansson@arm.com# i.e. they all use -g for opt and -g -pg for prof
10649226Sandreas.hansson@arm.comccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'],
10659226Sandreas.hansson@arm.com           'perf' : ['-g']}
10669225Sandreas.hansson@arm.com
10679226Sandreas.hansson@arm.com# Start out with the linker flags common to all linkers, i.e. -pg for
10689226Sandreas.hansson@arm.com# prof, and -lprofiler for perf. The -lprofile flag is surrounded by
10699226Sandreas.hansson@arm.com# no-as-needed and as-needed as the binutils linker is too clever and
10709226Sandreas.hansson@arm.com# simply doesn't link to the library otherwise.
10719226Sandreas.hansson@arm.comldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'],
10729226Sandreas.hansson@arm.com           'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']}
10739225Sandreas.hansson@arm.com
10749227Sandreas.hansson@arm.com# For Link Time Optimization, the optimisation flags used to compile
10759227Sandreas.hansson@arm.com# individual files are decoupled from those used at link time
10769227Sandreas.hansson@arm.com# (i.e. you can compile with -O3 and perform LTO with -O0), so we need
10779227Sandreas.hansson@arm.com# to also update the linker flags based on the target.
10788946Sandreas.hansson@arm.comif env['GCC']:
10793918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
10809225Sandreas.hansson@arm.com        ccflags['debug'] += ['-gstabs+']
10813918Ssaidi@eecs.umich.edu    else:
10829225Sandreas.hansson@arm.com        ccflags['debug'] += ['-ggdb3']
10839225Sandreas.hansson@arm.com    ldflags['debug'] += ['-O0']
10849227Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags, also add
10859227Sandreas.hansson@arm.com    # the optimization to the ldflags as LTO defers the optimization
10869227Sandreas.hansson@arm.com    # to link time
10879226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
10889225Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
10899227Sandreas.hansson@arm.com        ldflags[target] += ['-O3']
10909227Sandreas.hansson@arm.com
10919227Sandreas.hansson@arm.com    ccflags['fast'] += env['LTO_CCFLAGS']
10929227Sandreas.hansson@arm.com    ldflags['fast'] += env['LTO_LDFLAGS']
10938946Sandreas.hansson@arm.comelif env['CLANG']:
10949225Sandreas.hansson@arm.com    ccflags['debug'] += ['-g', '-O0']
10959226Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags
10969226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
10979226Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
10983515Ssaidi@eecs.umich.eduelse:
10993918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
11004762Snate@binkert.org    Exit(1)
11013515Ssaidi@eecs.umich.edu
11028881Smarc.orr@gmail.com
11038881Smarc.orr@gmail.com# To speed things up, we only instantiate the build environments we
11048881Smarc.orr@gmail.com# need.  We try to identify the needed environment for each target; if
11058881Smarc.orr@gmail.com# we can't, we fall back on instantiating all the environments just to
11068881Smarc.orr@gmail.com# be safe.
11079226Sandreas.hansson@arm.comtarget_types = ['debug', 'opt', 'fast', 'prof', 'perf']
11089226Sandreas.hansson@arm.comobj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
11099226Sandreas.hansson@arm.com              'gpo' : 'perf'}
11108881Smarc.orr@gmail.com
11118881Smarc.orr@gmail.comdef identifyTarget(t):
11128881Smarc.orr@gmail.com    ext = t.split('.')[-1]
11138881Smarc.orr@gmail.com    if ext in target_types:
11148881Smarc.orr@gmail.com        return ext
11158881Smarc.orr@gmail.com    if obj2target.has_key(ext):
11168881Smarc.orr@gmail.com        return obj2target[ext]
11178881Smarc.orr@gmail.com    match = re.search(r'/tests/([^/]+)/', t)
11188881Smarc.orr@gmail.com    if match and match.group(1) in target_types:
11198881Smarc.orr@gmail.com        return match.group(1)
11208881Smarc.orr@gmail.com    return 'all'
11218881Smarc.orr@gmail.com
11228881Smarc.orr@gmail.comneeded_envs = [identifyTarget(target) for target in BUILD_TARGETS]
11238881Smarc.orr@gmail.comif 'all' in needed_envs:
11248881Smarc.orr@gmail.com    needed_envs += target_types
11258881Smarc.orr@gmail.com
112610196SCurtis.Dunham@arm.comgem5_root = Dir('.').up().up().abspath
112710196SCurtis.Dunham@arm.comdef makeEnvirons(target, source, env):
112810196SCurtis.Dunham@arm.com    # cause any later Source() calls to be fatal, as a diagnostic.
112910196SCurtis.Dunham@arm.com    Source.done()
1130955SN/A
113110196SCurtis.Dunham@arm.com    envList = []
1132955SN/A
113310196SCurtis.Dunham@arm.com    # Debug binary
113410196SCurtis.Dunham@arm.com    if 'debug' in needed_envs:
113510196SCurtis.Dunham@arm.com        envList.append(
113610196SCurtis.Dunham@arm.com            makeEnv(env, 'debug', '.do',
113710196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['debug']),
113810196SCurtis.Dunham@arm.com                    CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
113910196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['debug'])))
1140955SN/A
114110196SCurtis.Dunham@arm.com    # Optimized binary
114210196SCurtis.Dunham@arm.com    if 'opt' in needed_envs:
114310196SCurtis.Dunham@arm.com        envList.append(
114410196SCurtis.Dunham@arm.com            makeEnv(env, 'opt', '.o',
114510196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['opt']),
114610196SCurtis.Dunham@arm.com                    CPPDEFINES = ['TRACING_ON=1'],
114710196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['opt'])))
11481869SN/A
114910196SCurtis.Dunham@arm.com    # "Fast" binary
115010196SCurtis.Dunham@arm.com    if 'fast' in needed_envs:
115110196SCurtis.Dunham@arm.com        envList.append(
115210196SCurtis.Dunham@arm.com            makeEnv(env, 'fast', '.fo', strip = True,
115310196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['fast']),
115410196SCurtis.Dunham@arm.com                    CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
115510196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['fast'])))
11569226Sandreas.hansson@arm.com
115710196SCurtis.Dunham@arm.com    # Profiled binary using gprof
115810196SCurtis.Dunham@arm.com    if 'prof' in needed_envs:
115910196SCurtis.Dunham@arm.com        envList.append(
116010196SCurtis.Dunham@arm.com            makeEnv(env, 'prof', '.po',
116110196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['prof']),
116210196SCurtis.Dunham@arm.com                    CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
116310196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['prof'])))
116410196SCurtis.Dunham@arm.com
116510196SCurtis.Dunham@arm.com    # Profiled binary using google-pprof
116610196SCurtis.Dunham@arm.com    if 'perf' in needed_envs:
116710196SCurtis.Dunham@arm.com        envList.append(
116810196SCurtis.Dunham@arm.com            makeEnv(env, 'perf', '.gpo',
116910196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['perf']),
117010196SCurtis.Dunham@arm.com                    CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
117110196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['perf'])))
117210196SCurtis.Dunham@arm.com
117310196SCurtis.Dunham@arm.com    # Set up the regression tests for each build.
117410196SCurtis.Dunham@arm.com    for e in envList:
117510196SCurtis.Dunham@arm.com        SConscript(os.path.join(gem5_root, 'tests', 'SConscript'),
117610196SCurtis.Dunham@arm.com                   variant_dir = variantd('tests', e.Label),
117710196SCurtis.Dunham@arm.com                   exports = { 'env' : e }, duplicate = False)
117810196SCurtis.Dunham@arm.com
117910196SCurtis.Dunham@arm.com# The MakeEnvirons Builder defers the full dependency collection until
118010196SCurtis.Dunham@arm.com# after processing the ISA definition (due to dynamically generated
118110196SCurtis.Dunham@arm.com# source files).  Add this dependency to all targets so they will wait
118210196SCurtis.Dunham@arm.com# until the environments are completely set up.  Otherwise, a second
118310196SCurtis.Dunham@arm.com# process (e.g. -j2 or higher) will try to compile the requested target,
118410196SCurtis.Dunham@arm.com# not know how, and fail.
118510196SCurtis.Dunham@arm.comenv.Append(BUILDERS = {'MakeEnvirons' :
118610196SCurtis.Dunham@arm.com                        Builder(action=MakeAction(makeEnvirons,
118710196SCurtis.Dunham@arm.com                                                  Transform("ENVIRONS", 1)))})
118810196SCurtis.Dunham@arm.com
118910196SCurtis.Dunham@arm.comisa_target = env['PHONY_BASE'] + '-deps'
119010196SCurtis.Dunham@arm.comenvirons   = env['PHONY_BASE'] + '-environs'
119110196SCurtis.Dunham@arm.comenv.Depends('#all-deps',     isa_target)
119210196SCurtis.Dunham@arm.comenv.Depends('#all-environs', environs)
119310196SCurtis.Dunham@arm.comenv.ScanISA(isa_target, File('arch/%s/generated/inc.d' % env['TARGET_ISA']))
119410196SCurtis.Dunham@arm.comenvSetup = env.MakeEnvirons(environs, isa_target)
119510196SCurtis.Dunham@arm.com
119610196SCurtis.Dunham@arm.com# make sure no -deps targets occur before all ISAs are complete
119710196SCurtis.Dunham@arm.comenv.Depends(isa_target, '#all-isas')
119810196SCurtis.Dunham@arm.com# likewise for -environs targets and all the -deps targets
119910196SCurtis.Dunham@arm.comenv.Depends(environs, '#all-deps')
1200