SConscript revision 11997
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
3711974Sgabeblack@google.comimport subprocess
38955SN/Aimport sys
395522Snate@binkert.orgimport zlib
404202Sbinkertn@umich.edu
415742Snate@binkert.orgfrom os.path import basename, dirname, exists, isdir, isfile, join as joinpath
42955SN/A
434381Sbinkertn@umich.eduimport SCons
444381Sbinkertn@umich.edu
458334Snate@binkert.org# This file defines how to build a particular configuration of gem5
46955SN/A# based on variable settings in the 'env' build environment.
47955SN/A
484202Sbinkertn@umich.eduImport('*')
49955SN/A
504382Sbinkertn@umich.edu# Children need to see the environment
514382Sbinkertn@umich.eduExport('env')
524382Sbinkertn@umich.edu
536654Snate@binkert.orgbuild_env = [(opt, env[opt]) for opt in export_vars]
545517Snate@binkert.org
558614Sgblack@eecs.umich.edufrom m5.util import code_formatter, compareVersions
567674Snate@binkert.org
576143Snate@binkert.org########################################################################
586143Snate@binkert.org# Code for adding source files of various types
596143Snate@binkert.org#
608233Snate@binkert.org# When specifying a source file of some type, a set of guards can be
618233Snate@binkert.org# specified for that file.  When get() is used to find the files, if
628233Snate@binkert.org# get specifies a set of filters, only files that match those filters
638233Snate@binkert.org# will be accepted (unspecified filters on files are assumed to be
648233Snate@binkert.org# false).  Current filters are:
658334Snate@binkert.org#     main -- specifies the gem5 main() function
668334Snate@binkert.org#     skip_lib -- do not put this file into the gem5 library
6710453SAndrew.Bardsley@arm.com#     skip_no_python -- do not put this file into a no_python library
6810453SAndrew.Bardsley@arm.com#       as it embeds compiled Python
698233Snate@binkert.org#     <unittest> -- unit tests use filters based on the unit test name
708233Snate@binkert.org#
718233Snate@binkert.org# A parent can now be specified for a source file and default filter
728233Snate@binkert.org# values will be retrieved recursively from parents (children override
738233Snate@binkert.org# parents).
748233Snate@binkert.org#
7511983Sgabeblack@google.comdef guarded_source_iterator(sources, **guards):
7611983Sgabeblack@google.com    '''Iterate over a set of sources, gated by a set of guards.'''
7711983Sgabeblack@google.com    for src in sources:
7811983Sgabeblack@google.com        for flag,value in guards.iteritems():
7911983Sgabeblack@google.com            # if the flag is found and has a different value, skip
8011983Sgabeblack@google.com            # this file
8111983Sgabeblack@google.com            if src.all_guards.get(flag, False) != value:
8211983Sgabeblack@google.com                break
8311983Sgabeblack@google.com        else:
8411983Sgabeblack@google.com            yield src
8511983Sgabeblack@google.com
866143Snate@binkert.orgclass SourceMeta(type):
878233Snate@binkert.org    '''Meta class for source files that keeps track of all files of a
888233Snate@binkert.org    particular type and has a get function for finding all functions
898233Snate@binkert.org    of a certain type that match a set of guards'''
906143Snate@binkert.org    def __init__(cls, name, bases, dict):
916143Snate@binkert.org        super(SourceMeta, cls).__init__(name, bases, dict)
926143Snate@binkert.org        cls.all = []
9311308Santhony.gutierrez@amd.com
948233Snate@binkert.org    def get(cls, **guards):
958233Snate@binkert.org        '''Find all files that match the specified guards.  If a source
968233Snate@binkert.org        file does not specify a flag, the default is False'''
9711983Sgabeblack@google.com        for s in guarded_source_iterator(cls.all, **guards):
9811983Sgabeblack@google.com            yield s
994762Snate@binkert.org
1006143Snate@binkert.orgclass SourceFile(object):
1018233Snate@binkert.org    '''Base object that encapsulates the notion of a source file.
1028233Snate@binkert.org    This includes, the source node, target node, various manipulations
1038233Snate@binkert.org    of those.  A source file also specifies a set of guards which
1048233Snate@binkert.org    describing which builds the source file applies to.  A parent can
1058233Snate@binkert.org    also be specified to get default guards from'''
1066143Snate@binkert.org    __metaclass__ = SourceMeta
1078233Snate@binkert.org    def __init__(self, source, parent=None, **guards):
1088233Snate@binkert.org        self.guards = guards
1098233Snate@binkert.org        self.parent = parent
1108233Snate@binkert.org
1116143Snate@binkert.org        tnode = source
1126143Snate@binkert.org        if not isinstance(source, SCons.Node.FS.File):
1136143Snate@binkert.org            tnode = File(source)
1146143Snate@binkert.org
1156143Snate@binkert.org        self.tnode = tnode
1166143Snate@binkert.org        self.snode = tnode.srcnode()
1176143Snate@binkert.org
1186143Snate@binkert.org        for base in type(self).__mro__:
1196143Snate@binkert.org            if issubclass(base, SourceFile):
1207065Snate@binkert.org                base.all.append(self)
1216143Snate@binkert.org
1228233Snate@binkert.org    @property
1238233Snate@binkert.org    def filename(self):
1248233Snate@binkert.org        return str(self.tnode)
1258233Snate@binkert.org
1268233Snate@binkert.org    @property
1278233Snate@binkert.org    def dirname(self):
1288233Snate@binkert.org        return dirname(self.filename)
1298233Snate@binkert.org
1308233Snate@binkert.org    @property
1318233Snate@binkert.org    def basename(self):
1328233Snate@binkert.org        return basename(self.filename)
1338233Snate@binkert.org
1348233Snate@binkert.org    @property
1358233Snate@binkert.org    def extname(self):
1368233Snate@binkert.org        index = self.basename.rfind('.')
1378233Snate@binkert.org        if index <= 0:
1388233Snate@binkert.org            # dot files aren't extensions
1398233Snate@binkert.org            return self.basename, None
1408233Snate@binkert.org
1418233Snate@binkert.org        return self.basename[:index], self.basename[index+1:]
1428233Snate@binkert.org
1438233Snate@binkert.org    @property
1448233Snate@binkert.org    def all_guards(self):
1458233Snate@binkert.org        '''find all guards for this object getting default values
1468233Snate@binkert.org        recursively from its parents'''
1478233Snate@binkert.org        guards = {}
1488233Snate@binkert.org        if self.parent:
1498233Snate@binkert.org            guards.update(self.parent.guards)
1508233Snate@binkert.org        guards.update(self.guards)
1518233Snate@binkert.org        return guards
1528233Snate@binkert.org
1536143Snate@binkert.org    def __lt__(self, other): return self.filename < other.filename
1546143Snate@binkert.org    def __le__(self, other): return self.filename <= other.filename
1556143Snate@binkert.org    def __gt__(self, other): return self.filename > other.filename
1566143Snate@binkert.org    def __ge__(self, other): return self.filename >= other.filename
1576143Snate@binkert.org    def __eq__(self, other): return self.filename == other.filename
1586143Snate@binkert.org    def __ne__(self, other): return self.filename != other.filename
1599982Satgutier@umich.edu
16010196SCurtis.Dunham@arm.com    @staticmethod
16110196SCurtis.Dunham@arm.com    def done():
16210196SCurtis.Dunham@arm.com        def disabled(cls, name, *ignored):
16310196SCurtis.Dunham@arm.com            raise RuntimeError("Additional SourceFile '%s'" % name,\
16410196SCurtis.Dunham@arm.com                  "declared, but targets deps are already fixed.")
16510196SCurtis.Dunham@arm.com        SourceFile.__init__ = disabled
16610196SCurtis.Dunham@arm.com
16710196SCurtis.Dunham@arm.com
1686143Snate@binkert.orgclass Source(SourceFile):
16911983Sgabeblack@google.com    current_group = None
17011983Sgabeblack@google.com    source_groups = { None : [] }
17111983Sgabeblack@google.com
17211983Sgabeblack@google.com    @classmethod
17311983Sgabeblack@google.com    def set_group(cls, group):
17411983Sgabeblack@google.com        if not group in Source.source_groups:
17511983Sgabeblack@google.com            Source.source_groups[group] = []
17611983Sgabeblack@google.com        Source.current_group = group
17711983Sgabeblack@google.com
1786143Snate@binkert.org    '''Add a c/c++ source file to the build'''
17911988Sandreas.sandberg@arm.com    def __init__(self, source, Werror=True, **guards):
1808233Snate@binkert.org        '''specify the source file, and any guards'''
1818233Snate@binkert.org        super(Source, self).__init__(source, **guards)
1826143Snate@binkert.org
1838945Ssteve.reinhardt@amd.com        self.Werror = Werror
1846143Snate@binkert.org
18511983Sgabeblack@google.com        Source.source_groups[Source.current_group].append(self)
18611983Sgabeblack@google.com
1876143Snate@binkert.orgclass PySource(SourceFile):
1886143Snate@binkert.org    '''Add a python source file to the named package'''
1895522Snate@binkert.org    invalid_sym_char = re.compile('[^A-z0-9_]')
1906143Snate@binkert.org    modules = {}
1916143Snate@binkert.org    tnodes = {}
1926143Snate@binkert.org    symnames = {}
1939982Satgutier@umich.edu
1948233Snate@binkert.org    def __init__(self, package, source, **guards):
1958233Snate@binkert.org        '''specify the python package, the source file, and any guards'''
1968233Snate@binkert.org        super(PySource, self).__init__(source, **guards)
1976143Snate@binkert.org
1986143Snate@binkert.org        modname,ext = self.extname
1996143Snate@binkert.org        assert ext == 'py'
2006143Snate@binkert.org
2015522Snate@binkert.org        if package:
2025522Snate@binkert.org            path = package.split('.')
2035522Snate@binkert.org        else:
2045522Snate@binkert.org            path = []
2055604Snate@binkert.org
2065604Snate@binkert.org        modpath = path[:]
2076143Snate@binkert.org        if modname != '__init__':
2086143Snate@binkert.org            modpath += [ modname ]
2094762Snate@binkert.org        modpath = '.'.join(modpath)
2104762Snate@binkert.org
2116143Snate@binkert.org        arcpath = path + [ self.basename ]
2126727Ssteve.reinhardt@amd.com        abspath = self.snode.abspath
2136727Ssteve.reinhardt@amd.com        if not exists(abspath):
2146727Ssteve.reinhardt@amd.com            abspath = self.tnode.abspath
2154762Snate@binkert.org
2166143Snate@binkert.org        self.package = package
2176143Snate@binkert.org        self.modname = modname
2186143Snate@binkert.org        self.modpath = modpath
2196143Snate@binkert.org        self.arcname = joinpath(*arcpath)
2206727Ssteve.reinhardt@amd.com        self.abspath = abspath
2216143Snate@binkert.org        self.compiled = File(self.filename + 'c')
2227674Snate@binkert.org        self.cpp = File(self.filename + '.cc')
2237674Snate@binkert.org        self.symname = PySource.invalid_sym_char.sub('_', modpath)
2245604Snate@binkert.org
2256143Snate@binkert.org        PySource.modules[modpath] = self
2266143Snate@binkert.org        PySource.tnodes[self.tnode] = self
2276143Snate@binkert.org        PySource.symnames[self.symname] = self
2284762Snate@binkert.org
2296143Snate@binkert.orgclass SimObject(PySource):
2304762Snate@binkert.org    '''Add a SimObject python file as a python source object and add
2314762Snate@binkert.org    it to a list of sim object modules'''
2324762Snate@binkert.org
2336143Snate@binkert.org    fixed = False
2346143Snate@binkert.org    modnames = []
2354762Snate@binkert.org
2368233Snate@binkert.org    def __init__(self, source, **guards):
2378233Snate@binkert.org        '''Specify the source file and any guards (automatically in
2388233Snate@binkert.org        the m5.objects package)'''
2398233Snate@binkert.org        super(SimObject, self).__init__('m5.objects', source, **guards)
2406143Snate@binkert.org        if self.fixed:
2416143Snate@binkert.org            raise AttributeError, "Too late to call SimObject now."
2424762Snate@binkert.org
2436143Snate@binkert.org        bisect.insort_right(SimObject.modnames, self.modname)
2444762Snate@binkert.org
2459396Sandreas.hansson@arm.comclass ProtoBuf(SourceFile):
2469396Sandreas.hansson@arm.com    '''Add a Protocol Buffer to build'''
2479396Sandreas.hansson@arm.com
2489396Sandreas.hansson@arm.com    def __init__(self, source, **guards):
2499396Sandreas.hansson@arm.com        '''Specify the source file, and any guards'''
2509396Sandreas.hansson@arm.com        super(ProtoBuf, self).__init__(source, **guards)
2519396Sandreas.hansson@arm.com
2529396Sandreas.hansson@arm.com        # Get the file name and the extension
2539396Sandreas.hansson@arm.com        modname,ext = self.extname
2549396Sandreas.hansson@arm.com        assert ext == 'proto'
2559396Sandreas.hansson@arm.com
2569396Sandreas.hansson@arm.com        # Currently, we stick to generating the C++ headers, so we
2579396Sandreas.hansson@arm.com        # only need to track the source and header.
2589930Sandreas.hansson@arm.com        self.cc_file = File(modname + '.pb.cc')
2599930Sandreas.hansson@arm.com        self.hh_file = File(modname + '.pb.h')
2609396Sandreas.hansson@arm.com
2618235Snate@binkert.orgclass UnitTest(object):
2628235Snate@binkert.org    '''Create a UnitTest'''
2636143Snate@binkert.org
2648235Snate@binkert.org    all = []
2659003SAli.Saidi@ARM.com    def __init__(self, target, *sources, **kwargs):
2668235Snate@binkert.org        '''Specify the target name and any sources.  Sources that are
2678235Snate@binkert.org        not SourceFiles are evalued with Source().  All files are
2688235Snate@binkert.org        guarded with a guard of the same name as the UnitTest
2698235Snate@binkert.org        target.'''
2708235Snate@binkert.org
2718235Snate@binkert.org        srcs = []
2728235Snate@binkert.org        for src in sources:
2738235Snate@binkert.org            if not isinstance(src, SourceFile):
2748235Snate@binkert.org                src = Source(src, skip_lib=True)
2758235Snate@binkert.org            src.guards[target] = True
2768235Snate@binkert.org            srcs.append(src)
2778235Snate@binkert.org
2788235Snate@binkert.org        self.sources = srcs
2798235Snate@binkert.org        self.target = target
2809003SAli.Saidi@ARM.com        self.main = kwargs.get('main', False)
2818235Snate@binkert.org        UnitTest.all.append(self)
2825584Snate@binkert.org
2834382Sbinkertn@umich.edu# Children should have access
2844202Sbinkertn@umich.eduExport('Source')
2854382Sbinkertn@umich.eduExport('PySource')
2864382Sbinkertn@umich.eduExport('SimObject')
2879396Sandreas.hansson@arm.comExport('ProtoBuf')
2885584Snate@binkert.orgExport('UnitTest')
2894382Sbinkertn@umich.edu
2904382Sbinkertn@umich.edu########################################################################
2914382Sbinkertn@umich.edu#
2928232Snate@binkert.org# Debug Flags
2935192Ssaidi@eecs.umich.edu#
2948232Snate@binkert.orgdebug_flags = {}
2958232Snate@binkert.orgdef DebugFlag(name, desc=None):
2968232Snate@binkert.org    if name in debug_flags:
2975192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
2988232Snate@binkert.org    debug_flags[name] = (name, (), desc)
2995192Ssaidi@eecs.umich.edu
3005799Snate@binkert.orgdef CompoundFlag(name, flags, desc=None):
3018232Snate@binkert.org    if name in debug_flags:
3025192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
3035192Ssaidi@eecs.umich.edu
3045192Ssaidi@eecs.umich.edu    compound = tuple(flags)
3058232Snate@binkert.org    debug_flags[name] = (name, compound, desc)
3065192Ssaidi@eecs.umich.edu
3078232Snate@binkert.orgExport('DebugFlag')
3085192Ssaidi@eecs.umich.eduExport('CompoundFlag')
3095192Ssaidi@eecs.umich.edu
3105192Ssaidi@eecs.umich.edu########################################################################
3115192Ssaidi@eecs.umich.edu#
3124382Sbinkertn@umich.edu# Set some compiler variables
3134382Sbinkertn@umich.edu#
3144382Sbinkertn@umich.edu
3152667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
3162667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
3172667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
3182667Sstever@eecs.umich.edu# files.
3192667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
3202667Sstever@eecs.umich.edu
3215742Snate@binkert.orgfor extra_dir in extras_dir_list:
3225742Snate@binkert.org    env.Append(CPPPATH=Dir(extra_dir))
3235742Snate@binkert.org
3245793Snate@binkert.org# Workaround for bug in SCons version > 0.97d20071212
3258334Snate@binkert.org# Scons bug id: 2006 gem5 Bug id: 308
3265793Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
3275793Snate@binkert.org    Dir(root[len(base_dir) + 1:])
3285793Snate@binkert.org
3294382Sbinkertn@umich.edu########################################################################
3304762Snate@binkert.org#
3315344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories
3324382Sbinkertn@umich.edu#
3335341Sstever@gmail.com
3345742Snate@binkert.orghere = Dir('.').srcnode().abspath
3355742Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
3365742Snate@binkert.org    if root == here:
3375742Snate@binkert.org        # we don't want to recurse back into this SConscript
3385742Snate@binkert.org        continue
3394762Snate@binkert.org
3405742Snate@binkert.org    if 'SConscript' in files:
3415742Snate@binkert.org        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
34211984Sgabeblack@google.com        Source.set_group(build_dir)
3437722Sgblack@eecs.umich.edu        SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
3445742Snate@binkert.org
3455742Snate@binkert.orgfor extra_dir in extras_dir_list:
3465742Snate@binkert.org    prefix_len = len(dirname(extra_dir)) + 1
3479930Sandreas.hansson@arm.com
3489930Sandreas.hansson@arm.com    # Also add the corresponding build directory to pick up generated
3499930Sandreas.hansson@arm.com    # include files.
3509930Sandreas.hansson@arm.com    env.Append(CPPPATH=Dir(joinpath(env['BUILDDIR'], extra_dir[prefix_len:])))
3519930Sandreas.hansson@arm.com
3525742Snate@binkert.org    for root, dirs, files in os.walk(extra_dir, topdown=True):
3538242Sbradley.danofsky@amd.com        # if build lives in the extras directory, don't walk down it
3548242Sbradley.danofsky@amd.com        if 'build' in dirs:
3558242Sbradley.danofsky@amd.com            dirs.remove('build')
3568242Sbradley.danofsky@amd.com
3575341Sstever@gmail.com        if 'SConscript' in files:
3585742Snate@binkert.org            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
3597722Sgblack@eecs.umich.edu            SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
3604773Snate@binkert.org
3616108Snate@binkert.orgfor opt in export_vars:
3621858SN/A    env.ConfigFile(opt)
3631085SN/A
3646658Snate@binkert.orgdef makeTheISA(source, target, env):
3656658Snate@binkert.org    isas = [ src.get_contents() for src in source ]
3667673Snate@binkert.org    target_isa = env['TARGET_ISA']
3676658Snate@binkert.org    def define(isa):
3686658Snate@binkert.org        return isa.upper() + '_ISA'
36911308Santhony.gutierrez@amd.com
3706658Snate@binkert.org    def namespace(isa):
37111308Santhony.gutierrez@amd.com        return isa[0].upper() + isa[1:].lower() + 'ISA'
3726658Snate@binkert.org
3736658Snate@binkert.org
3747673Snate@binkert.org    code = code_formatter()
3757673Snate@binkert.org    code('''\
3767673Snate@binkert.org#ifndef __CONFIG_THE_ISA_HH__
3777673Snate@binkert.org#define __CONFIG_THE_ISA_HH__
3787673Snate@binkert.org
3797673Snate@binkert.org''')
3807673Snate@binkert.org
38110467Sandreas.hansson@arm.com    # create defines for the preprocessing and compile-time determination
3826658Snate@binkert.org    for i,isa in enumerate(isas):
3837673Snate@binkert.org        code('#define $0 $1', define(isa), i + 1)
38410467Sandreas.hansson@arm.com    code()
38510467Sandreas.hansson@arm.com
38610467Sandreas.hansson@arm.com    # create an enum for any run-time determination of the ISA, we
38710467Sandreas.hansson@arm.com    # reuse the same name as the namespaces
38810467Sandreas.hansson@arm.com    code('enum class Arch {')
38910467Sandreas.hansson@arm.com    for i,isa in enumerate(isas):
39010467Sandreas.hansson@arm.com        if i + 1 == len(isas):
39110467Sandreas.hansson@arm.com            code('  $0 = $1', namespace(isa), define(isa))
39210467Sandreas.hansson@arm.com        else:
39310467Sandreas.hansson@arm.com            code('  $0 = $1,', namespace(isa), define(isa))
39410467Sandreas.hansson@arm.com    code('};')
3957673Snate@binkert.org
3967673Snate@binkert.org    code('''
3977673Snate@binkert.org
3987673Snate@binkert.org#define THE_ISA ${{define(target_isa)}}
3997673Snate@binkert.org#define TheISA ${{namespace(target_isa)}}
4009048SAli.Saidi@ARM.com#define THE_ISA_STR "${{target_isa}}"
4017673Snate@binkert.org
4027673Snate@binkert.org#endif // __CONFIG_THE_ISA_HH__''')
4037673Snate@binkert.org
4047673Snate@binkert.org    code.write(str(target[0]))
4056658Snate@binkert.org
4067756SAli.Saidi@ARM.comenv.Command('config/the_isa.hh', map(Value, all_isa_list),
4077816Ssteve.reinhardt@amd.com            MakeAction(makeTheISA, Transform("CFG ISA", 0)))
4086658Snate@binkert.org
40911308Santhony.gutierrez@amd.comdef makeTheGPUISA(source, target, env):
41011308Santhony.gutierrez@amd.com    isas = [ src.get_contents() for src in source ]
41111308Santhony.gutierrez@amd.com    target_gpu_isa = env['TARGET_GPU_ISA']
41211308Santhony.gutierrez@amd.com    def define(isa):
41311308Santhony.gutierrez@amd.com        return isa.upper() + '_ISA'
41411308Santhony.gutierrez@amd.com
41511308Santhony.gutierrez@amd.com    def namespace(isa):
41611308Santhony.gutierrez@amd.com        return isa[0].upper() + isa[1:].lower() + 'ISA'
41711308Santhony.gutierrez@amd.com
41811308Santhony.gutierrez@amd.com
41911308Santhony.gutierrez@amd.com    code = code_formatter()
42011308Santhony.gutierrez@amd.com    code('''\
42111308Santhony.gutierrez@amd.com#ifndef __CONFIG_THE_GPU_ISA_HH__
42211308Santhony.gutierrez@amd.com#define __CONFIG_THE_GPU_ISA_HH__
42311308Santhony.gutierrez@amd.com
42411308Santhony.gutierrez@amd.com''')
42511308Santhony.gutierrez@amd.com
42611308Santhony.gutierrez@amd.com    # create defines for the preprocessing and compile-time determination
42711308Santhony.gutierrez@amd.com    for i,isa in enumerate(isas):
42811308Santhony.gutierrez@amd.com        code('#define $0 $1', define(isa), i + 1)
42911308Santhony.gutierrez@amd.com    code()
43011308Santhony.gutierrez@amd.com
43111308Santhony.gutierrez@amd.com    # create an enum for any run-time determination of the ISA, we
43211308Santhony.gutierrez@amd.com    # reuse the same name as the namespaces
43311308Santhony.gutierrez@amd.com    code('enum class GPUArch {')
43411308Santhony.gutierrez@amd.com    for i,isa in enumerate(isas):
43511308Santhony.gutierrez@amd.com        if i + 1 == len(isas):
43611308Santhony.gutierrez@amd.com            code('  $0 = $1', namespace(isa), define(isa))
43711308Santhony.gutierrez@amd.com        else:
43811308Santhony.gutierrez@amd.com            code('  $0 = $1,', namespace(isa), define(isa))
43911308Santhony.gutierrez@amd.com    code('};')
44011308Santhony.gutierrez@amd.com
44111308Santhony.gutierrez@amd.com    code('''
44211308Santhony.gutierrez@amd.com
44311308Santhony.gutierrez@amd.com#define THE_GPU_ISA ${{define(target_gpu_isa)}}
44411308Santhony.gutierrez@amd.com#define TheGpuISA ${{namespace(target_gpu_isa)}}
44511308Santhony.gutierrez@amd.com#define THE_GPU_ISA_STR "${{target_gpu_isa}}"
44611308Santhony.gutierrez@amd.com
44711308Santhony.gutierrez@amd.com#endif // __CONFIG_THE_GPU_ISA_HH__''')
44811308Santhony.gutierrez@amd.com
44911308Santhony.gutierrez@amd.com    code.write(str(target[0]))
45011308Santhony.gutierrez@amd.com
45111308Santhony.gutierrez@amd.comenv.Command('config/the_gpu_isa.hh', map(Value, all_gpu_isa_list),
45211308Santhony.gutierrez@amd.com            MakeAction(makeTheGPUISA, Transform("CFG ISA", 0)))
45311308Santhony.gutierrez@amd.com
4544382Sbinkertn@umich.edu########################################################################
4554382Sbinkertn@umich.edu#
4564762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
4574762Snate@binkert.org# should all have been added in the SConscripts above
4584762Snate@binkert.org#
4596654Snate@binkert.orgSimObject.fixed = True
4606654Snate@binkert.org
4615517Snate@binkert.orgclass DictImporter(object):
4625517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
4635517Snate@binkert.org    map to arbitrary filenames.'''
4645517Snate@binkert.org    def __init__(self, modules):
4655517Snate@binkert.org        self.modules = modules
4665517Snate@binkert.org        self.installed = set()
4675517Snate@binkert.org
4685517Snate@binkert.org    def __del__(self):
4695517Snate@binkert.org        self.unload()
4705517Snate@binkert.org
4715517Snate@binkert.org    def unload(self):
4725517Snate@binkert.org        import sys
4735517Snate@binkert.org        for module in self.installed:
4745517Snate@binkert.org            del sys.modules[module]
4755517Snate@binkert.org        self.installed = set()
4765517Snate@binkert.org
4775517Snate@binkert.org    def find_module(self, fullname, path):
4786654Snate@binkert.org        if fullname == 'm5.defines':
4795517Snate@binkert.org            return self
4805517Snate@binkert.org
4815517Snate@binkert.org        if fullname == 'm5.objects':
4825517Snate@binkert.org            return self
4835517Snate@binkert.org
48411802Sandreas.sandberg@arm.com        if fullname.startswith('_m5'):
4855517Snate@binkert.org            return None
4865517Snate@binkert.org
4876143Snate@binkert.org        source = self.modules.get(fullname, None)
4886654Snate@binkert.org        if source is not None and fullname.startswith('m5.objects'):
4895517Snate@binkert.org            return self
4905517Snate@binkert.org
4915517Snate@binkert.org        return None
4925517Snate@binkert.org
4935517Snate@binkert.org    def load_module(self, fullname):
4945517Snate@binkert.org        mod = imp.new_module(fullname)
4955517Snate@binkert.org        sys.modules[fullname] = mod
4965517Snate@binkert.org        self.installed.add(fullname)
4975517Snate@binkert.org
4985517Snate@binkert.org        mod.__loader__ = self
4995517Snate@binkert.org        if fullname == 'm5.objects':
5005517Snate@binkert.org            mod.__path__ = fullname.split('.')
5015517Snate@binkert.org            return mod
5025517Snate@binkert.org
5036654Snate@binkert.org        if fullname == 'm5.defines':
5046654Snate@binkert.org            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
5055517Snate@binkert.org            return mod
5065517Snate@binkert.org
5076143Snate@binkert.org        source = self.modules[fullname]
5086143Snate@binkert.org        if source.modname == '__init__':
5096143Snate@binkert.org            mod.__path__ = source.modpath
5106727Ssteve.reinhardt@amd.com        mod.__file__ = source.abspath
5115517Snate@binkert.org
5126727Ssteve.reinhardt@amd.com        exec file(source.abspath, 'r') in mod.__dict__
5135517Snate@binkert.org
5145517Snate@binkert.org        return mod
5155517Snate@binkert.org
5166654Snate@binkert.orgimport m5.SimObject
5176654Snate@binkert.orgimport m5.params
5187673Snate@binkert.orgfrom m5.util import code_formatter
5196654Snate@binkert.org
5206654Snate@binkert.orgm5.SimObject.clear()
5216654Snate@binkert.orgm5.params.clear()
5226654Snate@binkert.org
5235517Snate@binkert.org# install the python importer so we can grab stuff from the source
5245517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
5255517Snate@binkert.org# else we won't know about them for the rest of the stuff.
5266143Snate@binkert.orgimporter = DictImporter(PySource.modules)
5275517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
5284762Snate@binkert.org
5295517Snate@binkert.org# import all sim objects so we can populate the all_objects list
5305517Snate@binkert.org# make sure that we're working with a list, then let's sort it
5316143Snate@binkert.orgfor modname in SimObject.modnames:
5326143Snate@binkert.org    exec('from m5.objects import %s' % modname)
5335517Snate@binkert.org
5345517Snate@binkert.org# we need to unload all of the currently imported modules so that they
5355517Snate@binkert.org# will be re-imported the next time the sconscript is run
5365517Snate@binkert.orgimporter.unload()
5375517Snate@binkert.orgsys.meta_path.remove(importer)
5385517Snate@binkert.org
5395517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
5405517Snate@binkert.orgall_enums = m5.params.allEnums
5415517Snate@binkert.org
5426143Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()):
5435517Snate@binkert.org    for param in obj._params.local.values():
5446654Snate@binkert.org        # load the ptype attribute now because it depends on the
5456654Snate@binkert.org        # current version of SimObject.allClasses, but when scons
5466654Snate@binkert.org        # actually uses the value, all versions of
5476654Snate@binkert.org        # SimObject.allClasses will have been loaded
5486654Snate@binkert.org        param.ptype
5496654Snate@binkert.org
5504762Snate@binkert.org########################################################################
5514762Snate@binkert.org#
5524762Snate@binkert.org# calculate extra dependencies
5534762Snate@binkert.org#
5544762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
5557675Snate@binkert.orgdepends = [ PySource.modules[dep].snode for dep in module_depends ]
55610584Sandreas.hansson@arm.comdepends.sort(key = lambda x: x.name)
5574762Snate@binkert.org
5584762Snate@binkert.org########################################################################
5594762Snate@binkert.org#
5604762Snate@binkert.org# Commands for the basic automatically generated python files
5614382Sbinkertn@umich.edu#
5624382Sbinkertn@umich.edu
5635517Snate@binkert.org# Generate Python file containing a dict specifying the current
5646654Snate@binkert.org# buildEnv flags.
5655517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
5668126Sgblack@eecs.umich.edu    build_env = source[0].get_contents()
5676654Snate@binkert.org
5687673Snate@binkert.org    code = code_formatter()
5696654Snate@binkert.org    code("""
57011802Sandreas.sandberg@arm.comimport _m5.core
5716654Snate@binkert.orgimport m5.util
5726654Snate@binkert.org
5736654Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env)
5746654Snate@binkert.org
57511802Sandreas.sandberg@arm.comcompileDate = _m5.core.compileDate
5766669Snate@binkert.org_globals = globals()
57711802Sandreas.sandberg@arm.comfor key,val in _m5.core.__dict__.iteritems():
5786669Snate@binkert.org    if key.startswith('flag_'):
5796669Snate@binkert.org        flag = key[5:]
5806669Snate@binkert.org        _globals[flag] = val
5816669Snate@binkert.orgdel _globals
5826654Snate@binkert.org""")
5837673Snate@binkert.org    code.write(target[0].abspath)
5845517Snate@binkert.org
5858126Sgblack@eecs.umich.edudefines_info = Value(build_env)
5865798Snate@binkert.org# Generate a file with all of the compile options in it
5877756SAli.Saidi@ARM.comenv.Command('python/m5/defines.py', defines_info,
5887816Ssteve.reinhardt@amd.com            MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
5895798Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
5905798Snate@binkert.org
5915517Snate@binkert.org# Generate python file containing info about the M5 source code
5925517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
5937673Snate@binkert.org    code = code_formatter()
5945517Snate@binkert.org    for src in source:
5955517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
5967673Snate@binkert.org        code('$src = ${{repr(data)}}')
5977673Snate@binkert.org    code.write(str(target[0]))
5985517Snate@binkert.org
5995798Snate@binkert.org# Generate a file that wraps the basic top level files
6005798Snate@binkert.orgenv.Command('python/m5/info.py',
6018333Snate@binkert.org            [ '#/COPYING', '#/LICENSE', '#/README', ],
6027816Ssteve.reinhardt@amd.com            MakeAction(makeInfoPyFile, Transform("INFO")))
6035798Snate@binkert.orgPySource('m5', 'python/m5/info.py')
6045798Snate@binkert.org
6054762Snate@binkert.org########################################################################
6064762Snate@binkert.org#
6074762Snate@binkert.org# Create all of the SimObject param headers and enum headers
6084762Snate@binkert.org#
6094762Snate@binkert.org
6108596Ssteve.reinhardt@amd.comdef createSimObjectParamStruct(target, source, env):
6115517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6125517Snate@binkert.org
61311997Sgabeblack@google.com    name = source[0].get_text_contents()
6145517Snate@binkert.org    obj = sim_objects[name]
6155517Snate@binkert.org
6167673Snate@binkert.org    code = code_formatter()
6178596Ssteve.reinhardt@amd.com    obj.cxx_param_decl(code)
6187673Snate@binkert.org    code.write(target[0].abspath)
6195517Snate@binkert.org
62010458Sandreas.hansson@arm.comdef createSimObjectCxxConfig(is_header):
62110458Sandreas.hansson@arm.com    def body(target, source, env):
62210458Sandreas.hansson@arm.com        assert len(target) == 1 and len(source) == 1
62310458Sandreas.hansson@arm.com
62410458Sandreas.hansson@arm.com        name = str(source[0].get_contents())
62510458Sandreas.hansson@arm.com        obj = sim_objects[name]
62610458Sandreas.hansson@arm.com
62710458Sandreas.hansson@arm.com        code = code_formatter()
62810458Sandreas.hansson@arm.com        obj.cxx_config_param_file(code, is_header)
62910458Sandreas.hansson@arm.com        code.write(target[0].abspath)
63010458Sandreas.hansson@arm.com    return body
63110458Sandreas.hansson@arm.com
6325517Snate@binkert.orgdef createEnumStrings(target, source, env):
63311996Sgabeblack@google.com    assert len(target) == 1 and len(source) == 2
6345517Snate@binkert.org
63511997Sgabeblack@google.com    name = source[0].get_text_contents()
63611996Sgabeblack@google.com    use_python = source[1].read()
6375517Snate@binkert.org    obj = all_enums[name]
6385517Snate@binkert.org
6397673Snate@binkert.org    code = code_formatter()
6407673Snate@binkert.org    obj.cxx_def(code)
64111996Sgabeblack@google.com    if use_python:
64211988Sandreas.sandberg@arm.com        obj.pybind_def(code)
6437673Snate@binkert.org    code.write(target[0].abspath)
6445517Snate@binkert.org
6458596Ssteve.reinhardt@amd.comdef createEnumDecls(target, source, env):
6465517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6475517Snate@binkert.org
64811997Sgabeblack@google.com    name = source[0].get_text_contents()
6495517Snate@binkert.org    obj = all_enums[name]
6505517Snate@binkert.org
6517673Snate@binkert.org    code = code_formatter()
6527673Snate@binkert.org    obj.cxx_decl(code)
6537673Snate@binkert.org    code.write(target[0].abspath)
6545517Snate@binkert.org
65511988Sandreas.sandberg@arm.comdef createSimObjectPyBindWrapper(target, source, env):
65611997Sgabeblack@google.com    name = source[0].get_text_contents()
6578596Ssteve.reinhardt@amd.com    obj = sim_objects[name]
6588596Ssteve.reinhardt@amd.com
6598596Ssteve.reinhardt@amd.com    code = code_formatter()
66011988Sandreas.sandberg@arm.com    obj.pybind_decl(code)
6618596Ssteve.reinhardt@amd.com    code.write(target[0].abspath)
6628596Ssteve.reinhardt@amd.com
6638596Ssteve.reinhardt@amd.com# Generate all of the SimObject param C++ struct header files
6644762Snate@binkert.orgparams_hh_files = []
6656143Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()):
6666143Snate@binkert.org    py_source = PySource.modules[simobj.__module__]
6676143Snate@binkert.org    extra_deps = [ py_source.tnode ]
6684762Snate@binkert.org
6694762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
6704762Snate@binkert.org    params_hh_files.append(hh_file)
6717756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
6728596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
6734762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
6744762Snate@binkert.org
67510458Sandreas.hansson@arm.com# C++ parameter description files
67610458Sandreas.hansson@arm.comif GetOption('with_cxx_config'):
67710458Sandreas.hansson@arm.com    for name,simobj in sorted(sim_objects.iteritems()):
67810458Sandreas.hansson@arm.com        py_source = PySource.modules[simobj.__module__]
67910458Sandreas.hansson@arm.com        extra_deps = [ py_source.tnode ]
68010458Sandreas.hansson@arm.com
68110458Sandreas.hansson@arm.com        cxx_config_hh_file = File('cxx_config/%s.hh' % name)
68210458Sandreas.hansson@arm.com        cxx_config_cc_file = File('cxx_config/%s.cc' % name)
68310458Sandreas.hansson@arm.com        env.Command(cxx_config_hh_file, Value(name),
68410458Sandreas.hansson@arm.com                    MakeAction(createSimObjectCxxConfig(True),
68510458Sandreas.hansson@arm.com                    Transform("CXXCPRHH")))
68610458Sandreas.hansson@arm.com        env.Command(cxx_config_cc_file, Value(name),
68710458Sandreas.hansson@arm.com                    MakeAction(createSimObjectCxxConfig(False),
68810458Sandreas.hansson@arm.com                    Transform("CXXCPRCC")))
68910458Sandreas.hansson@arm.com        env.Depends(cxx_config_hh_file, depends + extra_deps +
69010458Sandreas.hansson@arm.com                    [File('params/%s.hh' % name), File('sim/cxx_config.hh')])
69110458Sandreas.hansson@arm.com        env.Depends(cxx_config_cc_file, depends + extra_deps +
69210458Sandreas.hansson@arm.com                    [cxx_config_hh_file])
69310458Sandreas.hansson@arm.com        Source(cxx_config_cc_file)
69410458Sandreas.hansson@arm.com
69510458Sandreas.hansson@arm.com    cxx_config_init_cc_file = File('cxx_config/init.cc')
69610458Sandreas.hansson@arm.com
69710458Sandreas.hansson@arm.com    def createCxxConfigInitCC(target, source, env):
69810458Sandreas.hansson@arm.com        assert len(target) == 1 and len(source) == 1
69910458Sandreas.hansson@arm.com
70010458Sandreas.hansson@arm.com        code = code_formatter()
70110458Sandreas.hansson@arm.com
70210458Sandreas.hansson@arm.com        for name,simobj in sorted(sim_objects.iteritems()):
70310458Sandreas.hansson@arm.com            if not hasattr(simobj, 'abstract') or not simobj.abstract:
70410458Sandreas.hansson@arm.com                code('#include "cxx_config/${name}.hh"')
70510458Sandreas.hansson@arm.com        code()
70610458Sandreas.hansson@arm.com        code('void cxxConfigInit()')
70710458Sandreas.hansson@arm.com        code('{')
70810458Sandreas.hansson@arm.com        code.indent()
70910458Sandreas.hansson@arm.com        for name,simobj in sorted(sim_objects.iteritems()):
71010458Sandreas.hansson@arm.com            not_abstract = not hasattr(simobj, 'abstract') or \
71110458Sandreas.hansson@arm.com                not simobj.abstract
71210458Sandreas.hansson@arm.com            if not_abstract and 'type' in simobj.__dict__:
71310458Sandreas.hansson@arm.com                code('cxx_config_directory["${name}"] = '
71410458Sandreas.hansson@arm.com                     '${name}CxxConfigParams::makeDirectoryEntry();')
71510458Sandreas.hansson@arm.com        code.dedent()
71610458Sandreas.hansson@arm.com        code('}')
71710458Sandreas.hansson@arm.com        code.write(target[0].abspath)
71810458Sandreas.hansson@arm.com
71910458Sandreas.hansson@arm.com    py_source = PySource.modules[simobj.__module__]
72010458Sandreas.hansson@arm.com    extra_deps = [ py_source.tnode ]
72110458Sandreas.hansson@arm.com    env.Command(cxx_config_init_cc_file, Value(name),
72210458Sandreas.hansson@arm.com        MakeAction(createCxxConfigInitCC, Transform("CXXCINIT")))
72310458Sandreas.hansson@arm.com    cxx_param_hh_files = ["cxx_config/%s.hh" % simobj
72410584Sandreas.hansson@arm.com        for name,simobj in sorted(sim_objects.iteritems())
72510458Sandreas.hansson@arm.com        if not hasattr(simobj, 'abstract') or not simobj.abstract]
72610458Sandreas.hansson@arm.com    Depends(cxx_config_init_cc_file, cxx_param_hh_files +
72710458Sandreas.hansson@arm.com            [File('sim/cxx_config.hh')])
72810458Sandreas.hansson@arm.com    Source(cxx_config_init_cc_file)
72910458Sandreas.hansson@arm.com
7304762Snate@binkert.org# Generate all enum header files
7316143Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()):
7326143Snate@binkert.org    py_source = PySource.modules[enum.__module__]
7336143Snate@binkert.org    extra_deps = [ py_source.tnode ]
7344762Snate@binkert.org
7354762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
73611996Sgabeblack@google.com    env.Command(cc_file, [Value(name), Value(env['USE_PYTHON'])],
7377816Ssteve.reinhardt@amd.com                MakeAction(createEnumStrings, Transform("ENUM STR")))
7384762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
7394762Snate@binkert.org    Source(cc_file)
7404762Snate@binkert.org
7414762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
7427756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
7438596Ssteve.reinhardt@amd.com                MakeAction(createEnumDecls, Transform("ENUMDECL")))
7444762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
7454762Snate@binkert.org
74611988Sandreas.sandberg@arm.com# Generate SimObject Python bindings wrapper files
74711988Sandreas.sandberg@arm.comif env['USE_PYTHON']:
74811988Sandreas.sandberg@arm.com    for name,simobj in sorted(sim_objects.iteritems()):
74911988Sandreas.sandberg@arm.com        py_source = PySource.modules[simobj.__module__]
75011988Sandreas.sandberg@arm.com        extra_deps = [ py_source.tnode ]
75111988Sandreas.sandberg@arm.com        cc_file = File('python/_m5/param_%s.cc' % name)
75211988Sandreas.sandberg@arm.com        env.Command(cc_file, Value(name),
75311988Sandreas.sandberg@arm.com                    MakeAction(createSimObjectPyBindWrapper,
75411988Sandreas.sandberg@arm.com                               Transform("SO PyBind")))
75511988Sandreas.sandberg@arm.com        env.Depends(cc_file, depends + extra_deps)
75611988Sandreas.sandberg@arm.com        Source(cc_file)
7574382Sbinkertn@umich.edu
7589396Sandreas.hansson@arm.com# Build all protocol buffers if we have got protoc and protobuf available
7599396Sandreas.hansson@arm.comif env['HAVE_PROTOBUF']:
7609396Sandreas.hansson@arm.com    for proto in ProtoBuf.all:
7619396Sandreas.hansson@arm.com        # Use both the source and header as the target, and the .proto
7629396Sandreas.hansson@arm.com        # file as the source. When executing the protoc compiler, also
7639396Sandreas.hansson@arm.com        # specify the proto_path to avoid having the generated files
7649396Sandreas.hansson@arm.com        # include the path.
7659396Sandreas.hansson@arm.com        env.Command([proto.cc_file, proto.hh_file], proto.tnode,
7669396Sandreas.hansson@arm.com                    MakeAction('$PROTOC --cpp_out ${TARGET.dir} '
7679396Sandreas.hansson@arm.com                               '--proto_path ${SOURCE.dir} $SOURCE',
7689396Sandreas.hansson@arm.com                               Transform("PROTOC")))
7699396Sandreas.hansson@arm.com
7709396Sandreas.hansson@arm.com        # Add the C++ source file
7719396Sandreas.hansson@arm.com        Source(proto.cc_file, **proto.guards)
7729396Sandreas.hansson@arm.comelif ProtoBuf.all:
7739396Sandreas.hansson@arm.com    print 'Got protobuf to build, but lacks support!'
7749396Sandreas.hansson@arm.com    Exit(1)
7759396Sandreas.hansson@arm.com
7768232Snate@binkert.org#
7778232Snate@binkert.org# Handle debug flags
7788232Snate@binkert.org#
7798232Snate@binkert.orgdef makeDebugFlagCC(target, source, env):
7808232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
7816229Snate@binkert.org
78210455SCurtis.Dunham@arm.com    code = code_formatter()
7836229Snate@binkert.org
78410455SCurtis.Dunham@arm.com    # delay definition of CompoundFlags until after all the definition
78510455SCurtis.Dunham@arm.com    # of all constituent SimpleFlags
78610455SCurtis.Dunham@arm.com    comp_code = code_formatter()
7875517Snate@binkert.org
7885517Snate@binkert.org    # file header
7897673Snate@binkert.org    code('''
7905517Snate@binkert.org/*
79110455SCurtis.Dunham@arm.com * DO NOT EDIT THIS FILE! Automatically generated by SCons.
7925517Snate@binkert.org */
7935517Snate@binkert.org
7948232Snate@binkert.org#include "base/debug.hh"
79510455SCurtis.Dunham@arm.com
79610455SCurtis.Dunham@arm.comnamespace Debug {
79710455SCurtis.Dunham@arm.com
7987673Snate@binkert.org''')
7997673Snate@binkert.org
80010455SCurtis.Dunham@arm.com    for name, flag in sorted(source[0].read().iteritems()):
80110455SCurtis.Dunham@arm.com        n, compound, desc = flag
80210455SCurtis.Dunham@arm.com        assert n == name
8035517Snate@binkert.org
80410455SCurtis.Dunham@arm.com        if not compound:
80510455SCurtis.Dunham@arm.com            code('SimpleFlag $name("$name", "$desc");')
80610455SCurtis.Dunham@arm.com        else:
80710455SCurtis.Dunham@arm.com            comp_code('CompoundFlag $name("$name", "$desc",')
80810455SCurtis.Dunham@arm.com            comp_code.indent()
80910455SCurtis.Dunham@arm.com            last = len(compound) - 1
81010455SCurtis.Dunham@arm.com            for i,flag in enumerate(compound):
81110455SCurtis.Dunham@arm.com                if i != last:
81210685Sandreas.hansson@arm.com                    comp_code('&$flag,')
81310455SCurtis.Dunham@arm.com                else:
81410685Sandreas.hansson@arm.com                    comp_code('&$flag);')
81510455SCurtis.Dunham@arm.com            comp_code.dedent()
8165517Snate@binkert.org
81710455SCurtis.Dunham@arm.com    code.append(comp_code)
8188232Snate@binkert.org    code()
8198232Snate@binkert.org    code('} // namespace Debug')
8205517Snate@binkert.org
8217673Snate@binkert.org    code.write(str(target[0]))
8225517Snate@binkert.org
8238232Snate@binkert.orgdef makeDebugFlagHH(target, source, env):
8248232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
8255517Snate@binkert.org
8268232Snate@binkert.org    val = eval(source[0].get_contents())
8278232Snate@binkert.org    name, compound, desc = val
8288232Snate@binkert.org
8297673Snate@binkert.org    code = code_formatter()
8305517Snate@binkert.org
8315517Snate@binkert.org    # file header boilerplate
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#ifndef __DEBUG_${name}_HH__
8388232Snate@binkert.org#define __DEBUG_${name}_HH__
8395517Snate@binkert.org
8408232Snate@binkert.orgnamespace Debug {
8418232Snate@binkert.org''')
8425517Snate@binkert.org
8438232Snate@binkert.org    if compound:
8448232Snate@binkert.org        code('class CompoundFlag;')
8458232Snate@binkert.org    code('class SimpleFlag;')
8465517Snate@binkert.org
8478232Snate@binkert.org    if compound:
8488232Snate@binkert.org        code('extern CompoundFlag $name;')
8498232Snate@binkert.org        for flag in compound:
8508232Snate@binkert.org            code('extern SimpleFlag $flag;')
8518232Snate@binkert.org    else:
8528232Snate@binkert.org        code('extern SimpleFlag $name;')
8535517Snate@binkert.org
8548232Snate@binkert.org    code('''
8558232Snate@binkert.org}
8565517Snate@binkert.org
8578232Snate@binkert.org#endif // __DEBUG_${name}_HH__
8587673Snate@binkert.org''')
8595517Snate@binkert.org
8607673Snate@binkert.org    code.write(str(target[0]))
8615517Snate@binkert.org
8628232Snate@binkert.orgfor name,flag in sorted(debug_flags.iteritems()):
8638232Snate@binkert.org    n, compound, desc = flag
8648232Snate@binkert.org    assert n == name
8655192Ssaidi@eecs.umich.edu
86610454SCurtis.Dunham@arm.com    hh_file = 'debug/%s.hh' % name
86710454SCurtis.Dunham@arm.com    env.Command(hh_file, Value(flag),
8688232Snate@binkert.org                MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
86910455SCurtis.Dunham@arm.com
87010455SCurtis.Dunham@arm.comenv.Command('debug/flags.cc', Value(debug_flags),
87110455SCurtis.Dunham@arm.com            MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
87210455SCurtis.Dunham@arm.comSource('debug/flags.cc')
8735192Ssaidi@eecs.umich.edu
87411077SCurtis.Dunham@arm.com# version tags
87511330SCurtis.Dunham@arm.comtags = \
87611077SCurtis.Dunham@arm.comenv.Command('sim/tags.cc', None,
87711077SCurtis.Dunham@arm.com            MakeAction('util/cpt_upgrader.py --get-cc-file > $TARGET',
87811077SCurtis.Dunham@arm.com                       Transform("VER TAGS")))
87911330SCurtis.Dunham@arm.comenv.AlwaysBuild(tags)
88011077SCurtis.Dunham@arm.com
8817674Snate@binkert.org# Embed python files.  All .py files that have been indicated by a
8825522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
8835522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
8847674Snate@binkert.org# byte code, compress it, and then generate a c++ file that
8857674Snate@binkert.org# inserts the result into an array.
8867674Snate@binkert.orgdef embedPyFile(target, source, env):
8877674Snate@binkert.org    def c_str(string):
8887674Snate@binkert.org        if string is None:
8897674Snate@binkert.org            return "0"
8907674Snate@binkert.org        return '"%s"' % string
8917674Snate@binkert.org
8925522Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
8935522Snate@binkert.org    it, compress it, and stick it into an asm file so the code appears
8945522Snate@binkert.org    as just bytes with a label in the data section'''
8955517Snate@binkert.org
8965522Snate@binkert.org    src = file(str(source[0]), 'r').read()
8975517Snate@binkert.org
8986143Snate@binkert.org    pysource = PySource.tnodes[source[0]]
8996727Ssteve.reinhardt@amd.com    compiled = compile(src, pysource.abspath, 'exec')
9005522Snate@binkert.org    marshalled = marshal.dumps(compiled)
9015522Snate@binkert.org    compressed = zlib.compress(marshalled)
9025522Snate@binkert.org    data = compressed
9037674Snate@binkert.org    sym = pysource.symname
9045517Snate@binkert.org
9057673Snate@binkert.org    code = code_formatter()
9067673Snate@binkert.org    code('''\
9077674Snate@binkert.org#include "sim/init.hh"
9087673Snate@binkert.org
9097674Snate@binkert.orgnamespace {
9107674Snate@binkert.org
9118946Sandreas.hansson@arm.comconst uint8_t data_${sym}[] = {
9127674Snate@binkert.org''')
9137674Snate@binkert.org    code.indent()
9147674Snate@binkert.org    step = 16
9155522Snate@binkert.org    for i in xrange(0, len(data), step):
9165522Snate@binkert.org        x = array.array('B', data[i:i+step])
9177674Snate@binkert.org        code(''.join('%d,' % d for d in x))
9187674Snate@binkert.org    code.dedent()
91911308Santhony.gutierrez@amd.com
9207674Snate@binkert.org    code('''};
9217673Snate@binkert.org
9227674Snate@binkert.orgEmbeddedPython embedded_${sym}(
9237674Snate@binkert.org    ${{c_str(pysource.arcname)}},
9247674Snate@binkert.org    ${{c_str(pysource.abspath)}},
9257674Snate@binkert.org    ${{c_str(pysource.modpath)}},
9267674Snate@binkert.org    data_${sym},
9277674Snate@binkert.org    ${{len(data)}},
9287674Snate@binkert.org    ${{len(marshalled)}});
9297674Snate@binkert.org
9307811Ssteve.reinhardt@amd.com} // anonymous namespace
9317674Snate@binkert.org''')
9327673Snate@binkert.org    code.write(str(target[0]))
9335522Snate@binkert.org
9346143Snate@binkert.orgfor source in PySource.all:
93510453SAndrew.Bardsley@arm.com    env.Command(source.cpp, source.tnode,
9367816Ssteve.reinhardt@amd.com                MakeAction(embedPyFile, Transform("EMBED PY")))
93710453SAndrew.Bardsley@arm.com    Source(source.cpp, skip_no_python=True)
9384382Sbinkertn@umich.edu
9394382Sbinkertn@umich.edu########################################################################
9404382Sbinkertn@umich.edu#
9414382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
9424382Sbinkertn@umich.edu# a slightly different build environment.
9434382Sbinkertn@umich.edu#
9444382Sbinkertn@umich.edu
9454382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
94610196SCurtis.Dunham@arm.comdate_source = Source('base/date.cc', skip_lib=True)
9474382Sbinkertn@umich.edu
94810196SCurtis.Dunham@arm.com# Capture this directory for the closure makeEnv, otherwise when it is
94910196SCurtis.Dunham@arm.com# called, it won't know what directory it should use.
95010196SCurtis.Dunham@arm.comvariant_dir = Dir('.').path
95110196SCurtis.Dunham@arm.comdef variant(*path):
95210196SCurtis.Dunham@arm.com    return os.path.join(variant_dir, *path)
95310196SCurtis.Dunham@arm.comdef variantd(*path):
95410196SCurtis.Dunham@arm.com    return variant(*path)+'/'
955955SN/A
9562655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
9572655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
9582655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
9592655Sstever@eecs.umich.edu# build environment vars.
96010196SCurtis.Dunham@arm.comdef makeEnv(env, label, objsfx, strip = False, **kwargs):
9615601Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
9625601Snate@binkert.org    # name.  Use '_' instead.
96310196SCurtis.Dunham@arm.com    libname = variant('gem5_' + label)
96410196SCurtis.Dunham@arm.com    exename = variant('gem5.' + label)
96510196SCurtis.Dunham@arm.com    secondary_exename = variant('m5.' + label)
9665522Snate@binkert.org
9675863Snate@binkert.org    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
9685601Snate@binkert.org    new_env.Label = label
9695601Snate@binkert.org    new_env.Append(**kwargs)
9705601Snate@binkert.org
9715559Snate@binkert.org    if env['GCC']:
97211718Sjoseph.gross@amd.com        # The address sanitizer is available for gcc >= 4.8
97311718Sjoseph.gross@amd.com        if GetOption('with_asan'):
97411718Sjoseph.gross@amd.com            if GetOption('with_ubsan') and \
97511718Sjoseph.gross@amd.com                    compareVersions(env['GCC_VERSION'], '4.9') >= 0:
97611718Sjoseph.gross@amd.com                new_env.Append(CCFLAGS=['-fsanitize=address,undefined',
97711718Sjoseph.gross@amd.com                                        '-fno-omit-frame-pointer'])
97811718Sjoseph.gross@amd.com                new_env.Append(LINKFLAGS='-fsanitize=address,undefined')
97911718Sjoseph.gross@amd.com            else:
98011718Sjoseph.gross@amd.com                new_env.Append(CCFLAGS=['-fsanitize=address',
98111718Sjoseph.gross@amd.com                                        '-fno-omit-frame-pointer'])
98211718Sjoseph.gross@amd.com                new_env.Append(LINKFLAGS='-fsanitize=address')
98310457Sandreas.hansson@arm.com        # Only gcc >= 4.9 supports UBSan, so check both the version
98410457Sandreas.hansson@arm.com        # and the command-line option before adding the compiler and
98510457Sandreas.hansson@arm.com        # linker flags.
98611718Sjoseph.gross@amd.com        elif GetOption('with_ubsan') and \
98710457Sandreas.hansson@arm.com                compareVersions(env['GCC_VERSION'], '4.9') >= 0:
98810457Sandreas.hansson@arm.com            new_env.Append(CCFLAGS='-fsanitize=undefined')
98910457Sandreas.hansson@arm.com            new_env.Append(LINKFLAGS='-fsanitize=undefined')
99010457Sandreas.hansson@arm.com
99111342Sandreas.hansson@arm.com
9928737Skoansin.tan@gmail.com    if env['CLANG']:
99311342Sandreas.hansson@arm.com        # We require clang >= 3.1, so there is no need to check any
99411342Sandreas.hansson@arm.com        # versions here.
99510457Sandreas.hansson@arm.com        if GetOption('with_ubsan'):
99611718Sjoseph.gross@amd.com            if GetOption('with_asan'):
99711718Sjoseph.gross@amd.com                new_env.Append(CCFLAGS=['-fsanitize=address,undefined',
99811718Sjoseph.gross@amd.com                                        '-fno-omit-frame-pointer'])
99911718Sjoseph.gross@amd.com                new_env.Append(LINKFLAGS='-fsanitize=address,undefined')
100011718Sjoseph.gross@amd.com            else:
100111718Sjoseph.gross@amd.com                new_env.Append(CCFLAGS='-fsanitize=undefined')
100211718Sjoseph.gross@amd.com                new_env.Append(LINKFLAGS='-fsanitize=undefined')
100310457Sandreas.hansson@arm.com
100411718Sjoseph.gross@amd.com        elif GetOption('with_asan'):
100511500Sandreas.hansson@arm.com            new_env.Append(CCFLAGS=['-fsanitize=address',
100611500Sandreas.hansson@arm.com                                    '-fno-omit-frame-pointer'])
100711342Sandreas.hansson@arm.com            new_env.Append(LINKFLAGS='-fsanitize=address')
100811342Sandreas.hansson@arm.com
10098945Ssteve.reinhardt@amd.com    werror_env = new_env.Clone()
101010686SAndreas.Sandberg@ARM.com    # Treat warnings as errors but white list some warnings that we
101110686SAndreas.Sandberg@ARM.com    # want to allow (e.g., deprecation warnings).
101210686SAndreas.Sandberg@ARM.com    werror_env.Append(CCFLAGS=['-Werror',
101310686SAndreas.Sandberg@ARM.com                               '-Wno-error=deprecated-declarations',
101410686SAndreas.Sandberg@ARM.com                               '-Wno-error=deprecated',
101510686SAndreas.Sandberg@ARM.com                               ])
10168945Ssteve.reinhardt@amd.com
10176143Snate@binkert.org    def make_obj(source, static, extra_deps = None):
10186143Snate@binkert.org        '''This function adds the specified source to the correct
10196143Snate@binkert.org        build environment, and returns the corresponding SCons Object
10206143Snate@binkert.org        nodes'''
10216143Snate@binkert.org
102211988Sandreas.sandberg@arm.com        if source.Werror:
10238945Ssteve.reinhardt@amd.com            env = werror_env
10246143Snate@binkert.org        else:
10256143Snate@binkert.org            env = new_env
10266143Snate@binkert.org
10276143Snate@binkert.org        if static:
10286143Snate@binkert.org            obj = env.StaticObject(source.tnode)
10296143Snate@binkert.org        else:
10306143Snate@binkert.org            obj = env.SharedObject(source.tnode)
10316143Snate@binkert.org
10326143Snate@binkert.org        if extra_deps:
10336143Snate@binkert.org            env.Depends(obj, extra_deps)
10346143Snate@binkert.org
10356143Snate@binkert.org        return obj
10366143Snate@binkert.org
103710453SAndrew.Bardsley@arm.com    lib_guards = {'main': False, 'skip_lib': False}
103810453SAndrew.Bardsley@arm.com
103911988Sandreas.sandberg@arm.com    # Without Python, leave out all Python content from the library
104011988Sandreas.sandberg@arm.com    # builds.  The option doesn't affect gem5 built as a program
104110453SAndrew.Bardsley@arm.com    if GetOption('without_python'):
104210453SAndrew.Bardsley@arm.com        lib_guards['skip_no_python'] = False
104310453SAndrew.Bardsley@arm.com
104411983Sgabeblack@google.com    static_objs = []
104511983Sgabeblack@google.com    shared_objs = []
104611983Sgabeblack@google.com    for s in guarded_source_iterator(Source.source_groups[None], **lib_guards):
104711983Sgabeblack@google.com        static_objs.append(make_obj(s, True))
104811983Sgabeblack@google.com        shared_objs.append(make_obj(s, False))
104911983Sgabeblack@google.com
105011983Sgabeblack@google.com    partial_objs = []
105111983Sgabeblack@google.com    for group, all_srcs in Source.source_groups.iteritems():
105211983Sgabeblack@google.com        # If these are the ungrouped source files, skip them.
105311983Sgabeblack@google.com        if not group:
105411983Sgabeblack@google.com            continue
105511983Sgabeblack@google.com
105611983Sgabeblack@google.com        # Get a list of the source files compatible with the current guards.
105711983Sgabeblack@google.com        srcs = [ s for s in guarded_source_iterator(all_srcs, **lib_guards) ]
105811983Sgabeblack@google.com        # If there aren't any left, skip this group.
105911983Sgabeblack@google.com        if not srcs:
106011983Sgabeblack@google.com            continue
106111983Sgabeblack@google.com
106211983Sgabeblack@google.com        # Set up the static partially linked objects.
106311983Sgabeblack@google.com        source_objs = [ make_obj(s, True) for s in srcs ]
106411983Sgabeblack@google.com        file_name = new_env.subst("${OBJPREFIX}lib${OBJSUFFIX}.partial")
106511983Sgabeblack@google.com        target = File(joinpath(group, file_name))
106611983Sgabeblack@google.com        partial = env.PartialStatic(target=target, source=source_objs)
106711983Sgabeblack@google.com        static_objs.append(partial)
106811983Sgabeblack@google.com
106911983Sgabeblack@google.com        # Set up the shared partially linked objects.
107011983Sgabeblack@google.com        source_objs = [ make_obj(s, False) for s in srcs ]
107111983Sgabeblack@google.com        file_name = new_env.subst("${SHOBJPREFIX}lib${SHOBJSUFFIX}.partial")
107211983Sgabeblack@google.com        target = File(joinpath(group, file_name))
107311983Sgabeblack@google.com        partial = env.PartialShared(target=target, source=source_objs)
107411983Sgabeblack@google.com        shared_objs.append(partial)
10756143Snate@binkert.org
10766143Snate@binkert.org    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
10776143Snate@binkert.org    static_objs.append(static_date)
107810453SAndrew.Bardsley@arm.com
10796143Snate@binkert.org    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
10806240Snate@binkert.org    shared_objs.append(shared_date)
10815554Snate@binkert.org
10825522Snate@binkert.org    # First make a library of everything but main() so other programs can
10835522Snate@binkert.org    # link against m5.
10845797Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
10855797Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
10865522Snate@binkert.org
10875601Snate@binkert.org    # Now link a stub with main() and the static library.
10888233Snate@binkert.org    main_objs = [ make_obj(s, True) for s in Source.get(main=True) ]
10898233Snate@binkert.org
10908235Snate@binkert.org    for test in UnitTest.all:
10918235Snate@binkert.org        flags = { test.target : True }
10928235Snate@binkert.org        test_sources = Source.get(**flags)
10938235Snate@binkert.org        test_objs = [ make_obj(s, static=True) for s in test_sources ]
10949003SAli.Saidi@ARM.com        if test.main:
10959003SAli.Saidi@ARM.com            test_objs += main_objs
109610196SCurtis.Dunham@arm.com        path = variant('unittest/%s.%s' % (test.target, label))
109710196SCurtis.Dunham@arm.com        new_env.Program(path, test_objs + static_objs)
10988235Snate@binkert.org
10996143Snate@binkert.org    progname = exename
11002655Sstever@eecs.umich.edu    if strip:
11016143Snate@binkert.org        progname += '.unstripped'
11026143Snate@binkert.org
110311985Sgabeblack@google.com    targets = new_env.Program(progname, main_objs + static_objs)
11046143Snate@binkert.org
11056143Snate@binkert.org    if strip:
11064007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
11074596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
11084007Ssaidi@eecs.umich.edu        else:
11094596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
11107756SAli.Saidi@ARM.com        targets = new_env.Command(exename, progname,
11117816Ssteve.reinhardt@amd.com                    MakeAction(cmd, Transform("STRIP")))
11128334Snate@binkert.org
11138334Snate@binkert.org    new_env.Command(secondary_exename, exename,
11148334Snate@binkert.org            MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
11158334Snate@binkert.org
11165601Snate@binkert.org    new_env.M5Binary = targets[0]
111711993Sgabeblack@google.com
111811993Sgabeblack@google.com    # Set up regression tests.
111911993Sgabeblack@google.com    SConscript(os.path.join(env.root.abspath, 'tests', 'SConscript'),
112011993Sgabeblack@google.com               variant_dir=variantd('tests', new_env.Label),
112111993Sgabeblack@google.com               exports={ 'env' : new_env }, duplicate=False)
11222655Sstever@eecs.umich.edu
11239225Sandreas.hansson@arm.com# Start out with the compiler flags common to all compilers,
11249225Sandreas.hansson@arm.com# i.e. they all use -g for opt and -g -pg for prof
11259226Sandreas.hansson@arm.comccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'],
11269226Sandreas.hansson@arm.com           'perf' : ['-g']}
11279225Sandreas.hansson@arm.com
11289226Sandreas.hansson@arm.com# Start out with the linker flags common to all linkers, i.e. -pg for
11299226Sandreas.hansson@arm.com# prof, and -lprofiler for perf. The -lprofile flag is surrounded by
11309226Sandreas.hansson@arm.com# no-as-needed and as-needed as the binutils linker is too clever and
11319226Sandreas.hansson@arm.com# simply doesn't link to the library otherwise.
11329226Sandreas.hansson@arm.comldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'],
11339226Sandreas.hansson@arm.com           'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']}
11349225Sandreas.hansson@arm.com
11359227Sandreas.hansson@arm.com# For Link Time Optimization, the optimisation flags used to compile
11369227Sandreas.hansson@arm.com# individual files are decoupled from those used at link time
11379227Sandreas.hansson@arm.com# (i.e. you can compile with -O3 and perform LTO with -O0), so we need
11389227Sandreas.hansson@arm.com# to also update the linker flags based on the target.
11398946Sandreas.hansson@arm.comif env['GCC']:
11403918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
11419225Sandreas.hansson@arm.com        ccflags['debug'] += ['-gstabs+']
11423918Ssaidi@eecs.umich.edu    else:
11439225Sandreas.hansson@arm.com        ccflags['debug'] += ['-ggdb3']
11449225Sandreas.hansson@arm.com    ldflags['debug'] += ['-O0']
11459227Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags, also add
11469227Sandreas.hansson@arm.com    # the optimization to the ldflags as LTO defers the optimization
11479227Sandreas.hansson@arm.com    # to link time
11489226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
11499225Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
11509227Sandreas.hansson@arm.com        ldflags[target] += ['-O3']
11519227Sandreas.hansson@arm.com
11529227Sandreas.hansson@arm.com    ccflags['fast'] += env['LTO_CCFLAGS']
11539227Sandreas.hansson@arm.com    ldflags['fast'] += env['LTO_LDFLAGS']
11548946Sandreas.hansson@arm.comelif env['CLANG']:
11559225Sandreas.hansson@arm.com    ccflags['debug'] += ['-g', '-O0']
11569226Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags
11579226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
11589226Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
11593515Ssaidi@eecs.umich.eduelse:
11603918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
11614762Snate@binkert.org    Exit(1)
11623515Ssaidi@eecs.umich.edu
11638881Smarc.orr@gmail.com
11648881Smarc.orr@gmail.com# To speed things up, we only instantiate the build environments we
11658881Smarc.orr@gmail.com# need.  We try to identify the needed environment for each target; if
11668881Smarc.orr@gmail.com# we can't, we fall back on instantiating all the environments just to
11678881Smarc.orr@gmail.com# be safe.
11689226Sandreas.hansson@arm.comtarget_types = ['debug', 'opt', 'fast', 'prof', 'perf']
11699226Sandreas.hansson@arm.comobj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
11709226Sandreas.hansson@arm.com              'gpo' : 'perf'}
11718881Smarc.orr@gmail.com
11728881Smarc.orr@gmail.comdef identifyTarget(t):
11738881Smarc.orr@gmail.com    ext = t.split('.')[-1]
11748881Smarc.orr@gmail.com    if ext in target_types:
11758881Smarc.orr@gmail.com        return ext
11768881Smarc.orr@gmail.com    if obj2target.has_key(ext):
11778881Smarc.orr@gmail.com        return obj2target[ext]
11788881Smarc.orr@gmail.com    match = re.search(r'/tests/([^/]+)/', t)
11798881Smarc.orr@gmail.com    if match and match.group(1) in target_types:
11808881Smarc.orr@gmail.com        return match.group(1)
11818881Smarc.orr@gmail.com    return 'all'
11828881Smarc.orr@gmail.com
11838881Smarc.orr@gmail.comneeded_envs = [identifyTarget(target) for target in BUILD_TARGETS]
11848881Smarc.orr@gmail.comif 'all' in needed_envs:
11858881Smarc.orr@gmail.com    needed_envs += target_types
11868881Smarc.orr@gmail.com
118710196SCurtis.Dunham@arm.comdef makeEnvirons(target, source, env):
118810196SCurtis.Dunham@arm.com    # cause any later Source() calls to be fatal, as a diagnostic.
118910196SCurtis.Dunham@arm.com    Source.done()
1190955SN/A
119110196SCurtis.Dunham@arm.com    # Debug binary
119210196SCurtis.Dunham@arm.com    if 'debug' in needed_envs:
119311993Sgabeblack@google.com        makeEnv(env, 'debug', '.do',
119411993Sgabeblack@google.com                CCFLAGS = Split(ccflags['debug']),
119511993Sgabeblack@google.com                CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
119611993Sgabeblack@google.com                LINKFLAGS = Split(ldflags['debug']))
1197955SN/A
119810196SCurtis.Dunham@arm.com    # Optimized binary
119910196SCurtis.Dunham@arm.com    if 'opt' in needed_envs:
120011993Sgabeblack@google.com        makeEnv(env, 'opt', '.o',
120111993Sgabeblack@google.com                CCFLAGS = Split(ccflags['opt']),
120211993Sgabeblack@google.com                CPPDEFINES = ['TRACING_ON=1'],
120311993Sgabeblack@google.com                LINKFLAGS = Split(ldflags['opt']))
12041869SN/A
120510196SCurtis.Dunham@arm.com    # "Fast" binary
120610196SCurtis.Dunham@arm.com    if 'fast' in needed_envs:
120711993Sgabeblack@google.com        makeEnv(env, 'fast', '.fo', strip = True,
120811993Sgabeblack@google.com                CCFLAGS = Split(ccflags['fast']),
120911993Sgabeblack@google.com                CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
121011993Sgabeblack@google.com                LINKFLAGS = Split(ldflags['fast']))
12119226Sandreas.hansson@arm.com
121210196SCurtis.Dunham@arm.com    # Profiled binary using gprof
121310196SCurtis.Dunham@arm.com    if 'prof' in needed_envs:
121411993Sgabeblack@google.com        makeEnv(env, 'prof', '.po',
121511993Sgabeblack@google.com                CCFLAGS = Split(ccflags['prof']),
121611993Sgabeblack@google.com                CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
121711993Sgabeblack@google.com                LINKFLAGS = Split(ldflags['prof']))
121810196SCurtis.Dunham@arm.com
121910196SCurtis.Dunham@arm.com    # Profiled binary using google-pprof
122010196SCurtis.Dunham@arm.com    if 'perf' in needed_envs:
122111993Sgabeblack@google.com        makeEnv(env, 'perf', '.gpo',
122211993Sgabeblack@google.com                CCFLAGS = Split(ccflags['perf']),
122311993Sgabeblack@google.com                CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
122411993Sgabeblack@google.com                LINKFLAGS = Split(ldflags['perf']))
122510196SCurtis.Dunham@arm.com
122610196SCurtis.Dunham@arm.com# The MakeEnvirons Builder defers the full dependency collection until
122710196SCurtis.Dunham@arm.com# after processing the ISA definition (due to dynamically generated
122810196SCurtis.Dunham@arm.com# source files).  Add this dependency to all targets so they will wait
122910196SCurtis.Dunham@arm.com# until the environments are completely set up.  Otherwise, a second
123010196SCurtis.Dunham@arm.com# process (e.g. -j2 or higher) will try to compile the requested target,
123110196SCurtis.Dunham@arm.com# not know how, and fail.
123210196SCurtis.Dunham@arm.comenv.Append(BUILDERS = {'MakeEnvirons' :
123310196SCurtis.Dunham@arm.com                        Builder(action=MakeAction(makeEnvirons,
123410196SCurtis.Dunham@arm.com                                                  Transform("ENVIRONS", 1)))})
123510196SCurtis.Dunham@arm.com
123610196SCurtis.Dunham@arm.comisa_target = env['PHONY_BASE'] + '-deps'
123710196SCurtis.Dunham@arm.comenvirons   = env['PHONY_BASE'] + '-environs'
123810196SCurtis.Dunham@arm.comenv.Depends('#all-deps',     isa_target)
123910196SCurtis.Dunham@arm.comenv.Depends('#all-environs', environs)
124010196SCurtis.Dunham@arm.comenv.ScanISA(isa_target, File('arch/%s/generated/inc.d' % env['TARGET_ISA']))
124110196SCurtis.Dunham@arm.comenvSetup = env.MakeEnvirons(environs, isa_target)
124210196SCurtis.Dunham@arm.com
124310196SCurtis.Dunham@arm.com# make sure no -deps targets occur before all ISAs are complete
124410196SCurtis.Dunham@arm.comenv.Depends(isa_target, '#all-isas')
124510196SCurtis.Dunham@arm.com# likewise for -environs targets and all the -deps targets
124610196SCurtis.Dunham@arm.comenv.Depends(environs, '#all-deps')
1247