SConscript revision 11548
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 = []
8111308Santhony.gutierrez@amd.com
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
23911548Sandreas.hansson@arm.com        self.package = package
2406143Snate@binkert.org        self.module = modname
2416143Snate@binkert.org        cc_file = joinpath(self.dirname, modname + '_wrap.cc')
2426143Snate@binkert.org        py_file = joinpath(self.dirname, modname + '.py')
2436143Snate@binkert.org
24410453SAndrew.Bardsley@arm.com        self.cc_source = Source(cc_file, swig=True, parent=self, **guards)
24510453SAndrew.Bardsley@arm.com        self.py_source = PySource(package, py_file, parent=self, **guards)
246955SN/A
2479396Sandreas.hansson@arm.comclass ProtoBuf(SourceFile):
2489396Sandreas.hansson@arm.com    '''Add a Protocol Buffer to build'''
2499396Sandreas.hansson@arm.com
2509396Sandreas.hansson@arm.com    def __init__(self, source, **guards):
2519396Sandreas.hansson@arm.com        '''Specify the source file, and any guards'''
2529396Sandreas.hansson@arm.com        super(ProtoBuf, self).__init__(source, **guards)
2539396Sandreas.hansson@arm.com
2549396Sandreas.hansson@arm.com        # Get the file name and the extension
2559396Sandreas.hansson@arm.com        modname,ext = self.extname
2569396Sandreas.hansson@arm.com        assert ext == 'proto'
2579396Sandreas.hansson@arm.com
2589396Sandreas.hansson@arm.com        # Currently, we stick to generating the C++ headers, so we
2599396Sandreas.hansson@arm.com        # only need to track the source and header.
2609930Sandreas.hansson@arm.com        self.cc_file = File(modname + '.pb.cc')
2619930Sandreas.hansson@arm.com        self.hh_file = File(modname + '.pb.h')
2629396Sandreas.hansson@arm.com
2638235Snate@binkert.orgclass UnitTest(object):
2648235Snate@binkert.org    '''Create a UnitTest'''
2656143Snate@binkert.org
2668235Snate@binkert.org    all = []
2679003SAli.Saidi@ARM.com    def __init__(self, target, *sources, **kwargs):
2688235Snate@binkert.org        '''Specify the target name and any sources.  Sources that are
2698235Snate@binkert.org        not SourceFiles are evalued with Source().  All files are
2708235Snate@binkert.org        guarded with a guard of the same name as the UnitTest
2718235Snate@binkert.org        target.'''
2728235Snate@binkert.org
2738235Snate@binkert.org        srcs = []
2748235Snate@binkert.org        for src in sources:
2758235Snate@binkert.org            if not isinstance(src, SourceFile):
2768235Snate@binkert.org                src = Source(src, skip_lib=True)
2778235Snate@binkert.org            src.guards[target] = True
2788235Snate@binkert.org            srcs.append(src)
2798235Snate@binkert.org
2808235Snate@binkert.org        self.sources = srcs
2818235Snate@binkert.org        self.target = target
2829003SAli.Saidi@ARM.com        self.main = kwargs.get('main', False)
2838235Snate@binkert.org        UnitTest.all.append(self)
2845584Snate@binkert.org
2854382Sbinkertn@umich.edu# Children should have access
2864202Sbinkertn@umich.eduExport('Source')
2874382Sbinkertn@umich.eduExport('PySource')
2884382Sbinkertn@umich.eduExport('SimObject')
2894382Sbinkertn@umich.eduExport('SwigSource')
2909396Sandreas.hansson@arm.comExport('ProtoBuf')
2915584Snate@binkert.orgExport('UnitTest')
2924382Sbinkertn@umich.edu
2934382Sbinkertn@umich.edu########################################################################
2944382Sbinkertn@umich.edu#
2958232Snate@binkert.org# Debug Flags
2965192Ssaidi@eecs.umich.edu#
2978232Snate@binkert.orgdebug_flags = {}
2988232Snate@binkert.orgdef DebugFlag(name, desc=None):
2998232Snate@binkert.org    if name in debug_flags:
3005192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
3018232Snate@binkert.org    debug_flags[name] = (name, (), desc)
3025192Ssaidi@eecs.umich.edu
3035799Snate@binkert.orgdef CompoundFlag(name, flags, desc=None):
3048232Snate@binkert.org    if name in debug_flags:
3055192Ssaidi@eecs.umich.edu        raise AttributeError, "Flag %s already specified" % name
3065192Ssaidi@eecs.umich.edu
3075192Ssaidi@eecs.umich.edu    compound = tuple(flags)
3088232Snate@binkert.org    debug_flags[name] = (name, compound, desc)
3095192Ssaidi@eecs.umich.edu
3108232Snate@binkert.orgExport('DebugFlag')
3115192Ssaidi@eecs.umich.eduExport('CompoundFlag')
3125192Ssaidi@eecs.umich.edu
3135192Ssaidi@eecs.umich.edu########################################################################
3145192Ssaidi@eecs.umich.edu#
3154382Sbinkertn@umich.edu# Set some compiler variables
3164382Sbinkertn@umich.edu#
3174382Sbinkertn@umich.edu
3182667Sstever@eecs.umich.edu# Include file paths are rooted in this directory.  SCons will
3192667Sstever@eecs.umich.edu# automatically expand '.' to refer to both the source directory and
3202667Sstever@eecs.umich.edu# the corresponding build directory to pick up generated include
3212667Sstever@eecs.umich.edu# files.
3222667Sstever@eecs.umich.eduenv.Append(CPPPATH=Dir('.'))
3232667Sstever@eecs.umich.edu
3245742Snate@binkert.orgfor extra_dir in extras_dir_list:
3255742Snate@binkert.org    env.Append(CPPPATH=Dir(extra_dir))
3265742Snate@binkert.org
3275793Snate@binkert.org# Workaround for bug in SCons version > 0.97d20071212
3288334Snate@binkert.org# Scons bug id: 2006 gem5 Bug id: 308
3295793Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
3305793Snate@binkert.org    Dir(root[len(base_dir) + 1:])
3315793Snate@binkert.org
3324382Sbinkertn@umich.edu########################################################################
3334762Snate@binkert.org#
3345344Sstever@gmail.com# Walk the tree and execute all SConscripts in subdirectories
3354382Sbinkertn@umich.edu#
3365341Sstever@gmail.com
3375742Snate@binkert.orghere = Dir('.').srcnode().abspath
3385742Snate@binkert.orgfor root, dirs, files in os.walk(base_dir, topdown=True):
3395742Snate@binkert.org    if root == here:
3405742Snate@binkert.org        # we don't want to recurse back into this SConscript
3415742Snate@binkert.org        continue
3424762Snate@binkert.org
3435742Snate@binkert.org    if 'SConscript' in files:
3445742Snate@binkert.org        build_dir = joinpath(env['BUILDDIR'], root[len(base_dir) + 1:])
3457722Sgblack@eecs.umich.edu        SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
3465742Snate@binkert.org
3475742Snate@binkert.orgfor extra_dir in extras_dir_list:
3485742Snate@binkert.org    prefix_len = len(dirname(extra_dir)) + 1
3499930Sandreas.hansson@arm.com
3509930Sandreas.hansson@arm.com    # Also add the corresponding build directory to pick up generated
3519930Sandreas.hansson@arm.com    # include files.
3529930Sandreas.hansson@arm.com    env.Append(CPPPATH=Dir(joinpath(env['BUILDDIR'], extra_dir[prefix_len:])))
3539930Sandreas.hansson@arm.com
3545742Snate@binkert.org    for root, dirs, files in os.walk(extra_dir, topdown=True):
3558242Sbradley.danofsky@amd.com        # if build lives in the extras directory, don't walk down it
3568242Sbradley.danofsky@amd.com        if 'build' in dirs:
3578242Sbradley.danofsky@amd.com            dirs.remove('build')
3588242Sbradley.danofsky@amd.com
3595341Sstever@gmail.com        if 'SConscript' in files:
3605742Snate@binkert.org            build_dir = joinpath(env['BUILDDIR'], root[prefix_len:])
3617722Sgblack@eecs.umich.edu            SConscript(joinpath(root, 'SConscript'), variant_dir=build_dir)
3624773Snate@binkert.org
3636108Snate@binkert.orgfor opt in export_vars:
3641858SN/A    env.ConfigFile(opt)
3651085SN/A
3666658Snate@binkert.orgdef makeTheISA(source, target, env):
3676658Snate@binkert.org    isas = [ src.get_contents() for src in source ]
3687673Snate@binkert.org    target_isa = env['TARGET_ISA']
3696658Snate@binkert.org    def define(isa):
3706658Snate@binkert.org        return isa.upper() + '_ISA'
37111308Santhony.gutierrez@amd.com
3726658Snate@binkert.org    def namespace(isa):
37311308Santhony.gutierrez@amd.com        return isa[0].upper() + isa[1:].lower() + 'ISA'
3746658Snate@binkert.org
3756658Snate@binkert.org
3767673Snate@binkert.org    code = code_formatter()
3777673Snate@binkert.org    code('''\
3787673Snate@binkert.org#ifndef __CONFIG_THE_ISA_HH__
3797673Snate@binkert.org#define __CONFIG_THE_ISA_HH__
3807673Snate@binkert.org
3817673Snate@binkert.org''')
3827673Snate@binkert.org
38310467Sandreas.hansson@arm.com    # create defines for the preprocessing and compile-time determination
3846658Snate@binkert.org    for i,isa in enumerate(isas):
3857673Snate@binkert.org        code('#define $0 $1', define(isa), i + 1)
38610467Sandreas.hansson@arm.com    code()
38710467Sandreas.hansson@arm.com
38810467Sandreas.hansson@arm.com    # create an enum for any run-time determination of the ISA, we
38910467Sandreas.hansson@arm.com    # reuse the same name as the namespaces
39010467Sandreas.hansson@arm.com    code('enum class Arch {')
39110467Sandreas.hansson@arm.com    for i,isa in enumerate(isas):
39210467Sandreas.hansson@arm.com        if i + 1 == len(isas):
39310467Sandreas.hansson@arm.com            code('  $0 = $1', namespace(isa), define(isa))
39410467Sandreas.hansson@arm.com        else:
39510467Sandreas.hansson@arm.com            code('  $0 = $1,', namespace(isa), define(isa))
39610467Sandreas.hansson@arm.com    code('};')
3977673Snate@binkert.org
3987673Snate@binkert.org    code('''
3997673Snate@binkert.org
4007673Snate@binkert.org#define THE_ISA ${{define(target_isa)}}
4017673Snate@binkert.org#define TheISA ${{namespace(target_isa)}}
4029048SAli.Saidi@ARM.com#define THE_ISA_STR "${{target_isa}}"
4037673Snate@binkert.org
4047673Snate@binkert.org#endif // __CONFIG_THE_ISA_HH__''')
4057673Snate@binkert.org
4067673Snate@binkert.org    code.write(str(target[0]))
4076658Snate@binkert.org
4087756SAli.Saidi@ARM.comenv.Command('config/the_isa.hh', map(Value, all_isa_list),
4097816Ssteve.reinhardt@amd.com            MakeAction(makeTheISA, Transform("CFG ISA", 0)))
4106658Snate@binkert.org
41111308Santhony.gutierrez@amd.comdef makeTheGPUISA(source, target, env):
41211308Santhony.gutierrez@amd.com    isas = [ src.get_contents() for src in source ]
41311308Santhony.gutierrez@amd.com    target_gpu_isa = env['TARGET_GPU_ISA']
41411308Santhony.gutierrez@amd.com    def define(isa):
41511308Santhony.gutierrez@amd.com        return isa.upper() + '_ISA'
41611308Santhony.gutierrez@amd.com
41711308Santhony.gutierrez@amd.com    def namespace(isa):
41811308Santhony.gutierrez@amd.com        return isa[0].upper() + isa[1:].lower() + 'ISA'
41911308Santhony.gutierrez@amd.com
42011308Santhony.gutierrez@amd.com
42111308Santhony.gutierrez@amd.com    code = code_formatter()
42211308Santhony.gutierrez@amd.com    code('''\
42311308Santhony.gutierrez@amd.com#ifndef __CONFIG_THE_GPU_ISA_HH__
42411308Santhony.gutierrez@amd.com#define __CONFIG_THE_GPU_ISA_HH__
42511308Santhony.gutierrez@amd.com
42611308Santhony.gutierrez@amd.com''')
42711308Santhony.gutierrez@amd.com
42811308Santhony.gutierrez@amd.com    # create defines for the preprocessing and compile-time determination
42911308Santhony.gutierrez@amd.com    for i,isa in enumerate(isas):
43011308Santhony.gutierrez@amd.com        code('#define $0 $1', define(isa), i + 1)
43111308Santhony.gutierrez@amd.com    code()
43211308Santhony.gutierrez@amd.com
43311308Santhony.gutierrez@amd.com    # create an enum for any run-time determination of the ISA, we
43411308Santhony.gutierrez@amd.com    # reuse the same name as the namespaces
43511308Santhony.gutierrez@amd.com    code('enum class GPUArch {')
43611308Santhony.gutierrez@amd.com    for i,isa in enumerate(isas):
43711308Santhony.gutierrez@amd.com        if i + 1 == len(isas):
43811308Santhony.gutierrez@amd.com            code('  $0 = $1', namespace(isa), define(isa))
43911308Santhony.gutierrez@amd.com        else:
44011308Santhony.gutierrez@amd.com            code('  $0 = $1,', namespace(isa), define(isa))
44111308Santhony.gutierrez@amd.com    code('};')
44211308Santhony.gutierrez@amd.com
44311308Santhony.gutierrez@amd.com    code('''
44411308Santhony.gutierrez@amd.com
44511308Santhony.gutierrez@amd.com#define THE_GPU_ISA ${{define(target_gpu_isa)}}
44611308Santhony.gutierrez@amd.com#define TheGpuISA ${{namespace(target_gpu_isa)}}
44711308Santhony.gutierrez@amd.com#define THE_GPU_ISA_STR "${{target_gpu_isa}}"
44811308Santhony.gutierrez@amd.com
44911308Santhony.gutierrez@amd.com#endif // __CONFIG_THE_GPU_ISA_HH__''')
45011308Santhony.gutierrez@amd.com
45111308Santhony.gutierrez@amd.com    code.write(str(target[0]))
45211308Santhony.gutierrez@amd.com
45311308Santhony.gutierrez@amd.comenv.Command('config/the_gpu_isa.hh', map(Value, all_gpu_isa_list),
45411308Santhony.gutierrez@amd.com            MakeAction(makeTheGPUISA, Transform("CFG ISA", 0)))
45511308Santhony.gutierrez@amd.com
4564382Sbinkertn@umich.edu########################################################################
4574382Sbinkertn@umich.edu#
4584762Snate@binkert.org# Prevent any SimObjects from being added after this point, they
4594762Snate@binkert.org# should all have been added in the SConscripts above
4604762Snate@binkert.org#
4616654Snate@binkert.orgSimObject.fixed = True
4626654Snate@binkert.org
4635517Snate@binkert.orgclass DictImporter(object):
4645517Snate@binkert.org    '''This importer takes a dictionary of arbitrary module names that
4655517Snate@binkert.org    map to arbitrary filenames.'''
4665517Snate@binkert.org    def __init__(self, modules):
4675517Snate@binkert.org        self.modules = modules
4685517Snate@binkert.org        self.installed = set()
4695517Snate@binkert.org
4705517Snate@binkert.org    def __del__(self):
4715517Snate@binkert.org        self.unload()
4725517Snate@binkert.org
4735517Snate@binkert.org    def unload(self):
4745517Snate@binkert.org        import sys
4755517Snate@binkert.org        for module in self.installed:
4765517Snate@binkert.org            del sys.modules[module]
4775517Snate@binkert.org        self.installed = set()
4785517Snate@binkert.org
4795517Snate@binkert.org    def find_module(self, fullname, path):
4806654Snate@binkert.org        if fullname == 'm5.defines':
4815517Snate@binkert.org            return self
4825517Snate@binkert.org
4835517Snate@binkert.org        if fullname == 'm5.objects':
4845517Snate@binkert.org            return self
4855517Snate@binkert.org
4865517Snate@binkert.org        if fullname.startswith('m5.internal'):
4875517Snate@binkert.org            return None
4885517Snate@binkert.org
4896143Snate@binkert.org        source = self.modules.get(fullname, None)
4906654Snate@binkert.org        if source is not None and fullname.startswith('m5.objects'):
4915517Snate@binkert.org            return self
4925517Snate@binkert.org
4935517Snate@binkert.org        return None
4945517Snate@binkert.org
4955517Snate@binkert.org    def load_module(self, fullname):
4965517Snate@binkert.org        mod = imp.new_module(fullname)
4975517Snate@binkert.org        sys.modules[fullname] = mod
4985517Snate@binkert.org        self.installed.add(fullname)
4995517Snate@binkert.org
5005517Snate@binkert.org        mod.__loader__ = self
5015517Snate@binkert.org        if fullname == 'm5.objects':
5025517Snate@binkert.org            mod.__path__ = fullname.split('.')
5035517Snate@binkert.org            return mod
5045517Snate@binkert.org
5056654Snate@binkert.org        if fullname == 'm5.defines':
5066654Snate@binkert.org            mod.__dict__['buildEnv'] = m5.util.SmartDict(build_env)
5075517Snate@binkert.org            return mod
5085517Snate@binkert.org
5096143Snate@binkert.org        source = self.modules[fullname]
5106143Snate@binkert.org        if source.modname == '__init__':
5116143Snate@binkert.org            mod.__path__ = source.modpath
5126727Ssteve.reinhardt@amd.com        mod.__file__ = source.abspath
5135517Snate@binkert.org
5146727Ssteve.reinhardt@amd.com        exec file(source.abspath, 'r') in mod.__dict__
5155517Snate@binkert.org
5165517Snate@binkert.org        return mod
5175517Snate@binkert.org
5186654Snate@binkert.orgimport m5.SimObject
5196654Snate@binkert.orgimport m5.params
5207673Snate@binkert.orgfrom m5.util import code_formatter
5216654Snate@binkert.org
5226654Snate@binkert.orgm5.SimObject.clear()
5236654Snate@binkert.orgm5.params.clear()
5246654Snate@binkert.org
5255517Snate@binkert.org# install the python importer so we can grab stuff from the source
5265517Snate@binkert.org# tree itself.  We can't have SimObjects added after this point or
5275517Snate@binkert.org# else we won't know about them for the rest of the stuff.
5286143Snate@binkert.orgimporter = DictImporter(PySource.modules)
5295517Snate@binkert.orgsys.meta_path[0:0] = [ importer ]
5304762Snate@binkert.org
5315517Snate@binkert.org# import all sim objects so we can populate the all_objects list
5325517Snate@binkert.org# make sure that we're working with a list, then let's sort it
5336143Snate@binkert.orgfor modname in SimObject.modnames:
5346143Snate@binkert.org    exec('from m5.objects import %s' % modname)
5355517Snate@binkert.org
5365517Snate@binkert.org# we need to unload all of the currently imported modules so that they
5375517Snate@binkert.org# will be re-imported the next time the sconscript is run
5385517Snate@binkert.orgimporter.unload()
5395517Snate@binkert.orgsys.meta_path.remove(importer)
5405517Snate@binkert.org
5415517Snate@binkert.orgsim_objects = m5.SimObject.allClasses
5425517Snate@binkert.orgall_enums = m5.params.allEnums
5435517Snate@binkert.org
5449338SAndreas.Sandberg@arm.comif m5.SimObject.noCxxHeader:
5459338SAndreas.Sandberg@arm.com    print >> sys.stderr, \
5469338SAndreas.Sandberg@arm.com        "warning: At least one SimObject lacks a header specification. " \
5479338SAndreas.Sandberg@arm.com        "This can cause unexpected results in the generated SWIG " \
5489338SAndreas.Sandberg@arm.com        "wrappers."
5499338SAndreas.Sandberg@arm.com
5508596Ssteve.reinhardt@amd.com# Find param types that need to be explicitly wrapped with swig.
5518596Ssteve.reinhardt@amd.com# These will be recognized because the ParamDesc will have a
5528596Ssteve.reinhardt@amd.com# swig_decl() method.  Most param types are based on types that don't
5538596Ssteve.reinhardt@amd.com# need this, either because they're based on native types (like Int)
5548596Ssteve.reinhardt@amd.com# or because they're SimObjects (which get swigged independently).
5558596Ssteve.reinhardt@amd.com# For now the only things handled here are VectorParam types.
5568596Ssteve.reinhardt@amd.comparams_to_swig = {}
5576143Snate@binkert.orgfor name,obj in sorted(sim_objects.iteritems()):
5585517Snate@binkert.org    for param in obj._params.local.values():
5596654Snate@binkert.org        # load the ptype attribute now because it depends on the
5606654Snate@binkert.org        # current version of SimObject.allClasses, but when scons
5616654Snate@binkert.org        # actually uses the value, all versions of
5626654Snate@binkert.org        # SimObject.allClasses will have been loaded
5636654Snate@binkert.org        param.ptype
5646654Snate@binkert.org
5655517Snate@binkert.org        if not hasattr(param, 'swig_decl'):
5665517Snate@binkert.org            continue
5675517Snate@binkert.org        pname = param.ptype_str
5688596Ssteve.reinhardt@amd.com        if pname not in params_to_swig:
5698596Ssteve.reinhardt@amd.com            params_to_swig[pname] = param
5704762Snate@binkert.org
5714762Snate@binkert.org########################################################################
5724762Snate@binkert.org#
5734762Snate@binkert.org# calculate extra dependencies
5744762Snate@binkert.org#
5754762Snate@binkert.orgmodule_depends = ["m5", "m5.SimObject", "m5.params"]
5767675Snate@binkert.orgdepends = [ PySource.modules[dep].snode for dep in module_depends ]
57710584Sandreas.hansson@arm.comdepends.sort(key = lambda x: x.name)
5784762Snate@binkert.org
5794762Snate@binkert.org########################################################################
5804762Snate@binkert.org#
5814762Snate@binkert.org# Commands for the basic automatically generated python files
5824382Sbinkertn@umich.edu#
5834382Sbinkertn@umich.edu
5845517Snate@binkert.org# Generate Python file containing a dict specifying the current
5856654Snate@binkert.org# buildEnv flags.
5865517Snate@binkert.orgdef makeDefinesPyFile(target, source, env):
5878126Sgblack@eecs.umich.edu    build_env = source[0].get_contents()
5886654Snate@binkert.org
5897673Snate@binkert.org    code = code_formatter()
5906654Snate@binkert.org    code("""
5916654Snate@binkert.orgimport m5.internal
5926654Snate@binkert.orgimport m5.util
5936654Snate@binkert.org
5946654Snate@binkert.orgbuildEnv = m5.util.SmartDict($build_env)
5956654Snate@binkert.org
5966654Snate@binkert.orgcompileDate = m5.internal.core.compileDate
5976669Snate@binkert.org_globals = globals()
5986669Snate@binkert.orgfor key,val in m5.internal.core.__dict__.iteritems():
5996669Snate@binkert.org    if key.startswith('flag_'):
6006669Snate@binkert.org        flag = key[5:]
6016669Snate@binkert.org        _globals[flag] = val
6026669Snate@binkert.orgdel _globals
6036654Snate@binkert.org""")
6047673Snate@binkert.org    code.write(target[0].abspath)
6055517Snate@binkert.org
6068126Sgblack@eecs.umich.edudefines_info = Value(build_env)
6075798Snate@binkert.org# Generate a file with all of the compile options in it
6087756SAli.Saidi@ARM.comenv.Command('python/m5/defines.py', defines_info,
6097816Ssteve.reinhardt@amd.com            MakeAction(makeDefinesPyFile, Transform("DEFINES", 0)))
6105798Snate@binkert.orgPySource('m5', 'python/m5/defines.py')
6115798Snate@binkert.org
6125517Snate@binkert.org# Generate python file containing info about the M5 source code
6135517Snate@binkert.orgdef makeInfoPyFile(target, source, env):
6147673Snate@binkert.org    code = code_formatter()
6155517Snate@binkert.org    for src in source:
6165517Snate@binkert.org        data = ''.join(file(src.srcnode().abspath, 'r').xreadlines())
6177673Snate@binkert.org        code('$src = ${{repr(data)}}')
6187673Snate@binkert.org    code.write(str(target[0]))
6195517Snate@binkert.org
6205798Snate@binkert.org# Generate a file that wraps the basic top level files
6215798Snate@binkert.orgenv.Command('python/m5/info.py',
6228333Snate@binkert.org            [ '#/COPYING', '#/LICENSE', '#/README', ],
6237816Ssteve.reinhardt@amd.com            MakeAction(makeInfoPyFile, Transform("INFO")))
6245798Snate@binkert.orgPySource('m5', 'python/m5/info.py')
6255798Snate@binkert.org
6264762Snate@binkert.org########################################################################
6274762Snate@binkert.org#
6284762Snate@binkert.org# Create all of the SimObject param headers and enum headers
6294762Snate@binkert.org#
6304762Snate@binkert.org
6318596Ssteve.reinhardt@amd.comdef createSimObjectParamStruct(target, source, env):
6325517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6335517Snate@binkert.org
6345517Snate@binkert.org    name = str(source[0].get_contents())
6355517Snate@binkert.org    obj = sim_objects[name]
6365517Snate@binkert.org
6377673Snate@binkert.org    code = code_formatter()
6388596Ssteve.reinhardt@amd.com    obj.cxx_param_decl(code)
6397673Snate@binkert.org    code.write(target[0].abspath)
6405517Snate@binkert.org
64110458Sandreas.hansson@arm.comdef createSimObjectCxxConfig(is_header):
64210458Sandreas.hansson@arm.com    def body(target, source, env):
64310458Sandreas.hansson@arm.com        assert len(target) == 1 and len(source) == 1
64410458Sandreas.hansson@arm.com
64510458Sandreas.hansson@arm.com        name = str(source[0].get_contents())
64610458Sandreas.hansson@arm.com        obj = sim_objects[name]
64710458Sandreas.hansson@arm.com
64810458Sandreas.hansson@arm.com        code = code_formatter()
64910458Sandreas.hansson@arm.com        obj.cxx_config_param_file(code, is_header)
65010458Sandreas.hansson@arm.com        code.write(target[0].abspath)
65110458Sandreas.hansson@arm.com    return body
65210458Sandreas.hansson@arm.com
6538596Ssteve.reinhardt@amd.comdef createParamSwigWrapper(target, source, env):
6545517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6555517Snate@binkert.org
6565517Snate@binkert.org    name = str(source[0].get_contents())
6578596Ssteve.reinhardt@amd.com    param = params_to_swig[name]
6585517Snate@binkert.org
6597673Snate@binkert.org    code = code_formatter()
6607673Snate@binkert.org    param.swig_decl(code)
6617673Snate@binkert.org    code.write(target[0].abspath)
6625517Snate@binkert.org
6635517Snate@binkert.orgdef createEnumStrings(target, source, env):
6645517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6655517Snate@binkert.org
6665517Snate@binkert.org    name = str(source[0].get_contents())
6675517Snate@binkert.org    obj = all_enums[name]
6685517Snate@binkert.org
6697673Snate@binkert.org    code = code_formatter()
6707673Snate@binkert.org    obj.cxx_def(code)
6717673Snate@binkert.org    code.write(target[0].abspath)
6725517Snate@binkert.org
6738596Ssteve.reinhardt@amd.comdef createEnumDecls(target, source, env):
6745517Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6755517Snate@binkert.org
6765517Snate@binkert.org    name = str(source[0].get_contents())
6775517Snate@binkert.org    obj = all_enums[name]
6785517Snate@binkert.org
6797673Snate@binkert.org    code = code_formatter()
6807673Snate@binkert.org    obj.cxx_decl(code)
6817673Snate@binkert.org    code.write(target[0].abspath)
6825517Snate@binkert.org
6838596Ssteve.reinhardt@amd.comdef createEnumSwigWrapper(target, source, env):
6847675Snate@binkert.org    assert len(target) == 1 and len(source) == 1
6857675Snate@binkert.org
6867675Snate@binkert.org    name = str(source[0].get_contents())
6877675Snate@binkert.org    obj = all_enums[name]
6887675Snate@binkert.org
6897675Snate@binkert.org    code = code_formatter()
6908596Ssteve.reinhardt@amd.com    obj.swig_decl(code)
6917675Snate@binkert.org    code.write(target[0].abspath)
6927675Snate@binkert.org
6938596Ssteve.reinhardt@amd.comdef createSimObjectSwigWrapper(target, source, env):
6948596Ssteve.reinhardt@amd.com    name = source[0].get_contents()
6958596Ssteve.reinhardt@amd.com    obj = sim_objects[name]
6968596Ssteve.reinhardt@amd.com
6978596Ssteve.reinhardt@amd.com    code = code_formatter()
6988596Ssteve.reinhardt@amd.com    obj.swig_decl(code)
6998596Ssteve.reinhardt@amd.com    code.write(target[0].abspath)
7008596Ssteve.reinhardt@amd.com
70110454SCurtis.Dunham@arm.com# dummy target for generated code
70210454SCurtis.Dunham@arm.com# we start out with all the Source files so they get copied to build/*/ also.
70310454SCurtis.Dunham@arm.comSWIG = env.Dummy('swig', [s.tnode for s in Source.get()])
70410454SCurtis.Dunham@arm.com
7058596Ssteve.reinhardt@amd.com# Generate all of the SimObject param C++ struct header files
7064762Snate@binkert.orgparams_hh_files = []
7076143Snate@binkert.orgfor name,simobj in sorted(sim_objects.iteritems()):
7086143Snate@binkert.org    py_source = PySource.modules[simobj.__module__]
7096143Snate@binkert.org    extra_deps = [ py_source.tnode ]
7104762Snate@binkert.org
7114762Snate@binkert.org    hh_file = File('params/%s.hh' % name)
7124762Snate@binkert.org    params_hh_files.append(hh_file)
7137756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
7148596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectParamStruct, Transform("SO PARAM")))
7154762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
71610454SCurtis.Dunham@arm.com    env.Depends(SWIG, hh_file)
7174762Snate@binkert.org
71810458Sandreas.hansson@arm.com# C++ parameter description files
71910458Sandreas.hansson@arm.comif GetOption('with_cxx_config'):
72010458Sandreas.hansson@arm.com    for name,simobj in sorted(sim_objects.iteritems()):
72110458Sandreas.hansson@arm.com        py_source = PySource.modules[simobj.__module__]
72210458Sandreas.hansson@arm.com        extra_deps = [ py_source.tnode ]
72310458Sandreas.hansson@arm.com
72410458Sandreas.hansson@arm.com        cxx_config_hh_file = File('cxx_config/%s.hh' % name)
72510458Sandreas.hansson@arm.com        cxx_config_cc_file = File('cxx_config/%s.cc' % name)
72610458Sandreas.hansson@arm.com        env.Command(cxx_config_hh_file, Value(name),
72710458Sandreas.hansson@arm.com                    MakeAction(createSimObjectCxxConfig(True),
72810458Sandreas.hansson@arm.com                    Transform("CXXCPRHH")))
72910458Sandreas.hansson@arm.com        env.Command(cxx_config_cc_file, Value(name),
73010458Sandreas.hansson@arm.com                    MakeAction(createSimObjectCxxConfig(False),
73110458Sandreas.hansson@arm.com                    Transform("CXXCPRCC")))
73210458Sandreas.hansson@arm.com        env.Depends(cxx_config_hh_file, depends + extra_deps +
73310458Sandreas.hansson@arm.com                    [File('params/%s.hh' % name), File('sim/cxx_config.hh')])
73410458Sandreas.hansson@arm.com        env.Depends(cxx_config_cc_file, depends + extra_deps +
73510458Sandreas.hansson@arm.com                    [cxx_config_hh_file])
73610458Sandreas.hansson@arm.com        Source(cxx_config_cc_file)
73710458Sandreas.hansson@arm.com
73810458Sandreas.hansson@arm.com    cxx_config_init_cc_file = File('cxx_config/init.cc')
73910458Sandreas.hansson@arm.com
74010458Sandreas.hansson@arm.com    def createCxxConfigInitCC(target, source, env):
74110458Sandreas.hansson@arm.com        assert len(target) == 1 and len(source) == 1
74210458Sandreas.hansson@arm.com
74310458Sandreas.hansson@arm.com        code = code_formatter()
74410458Sandreas.hansson@arm.com
74510458Sandreas.hansson@arm.com        for name,simobj in sorted(sim_objects.iteritems()):
74610458Sandreas.hansson@arm.com            if not hasattr(simobj, 'abstract') or not simobj.abstract:
74710458Sandreas.hansson@arm.com                code('#include "cxx_config/${name}.hh"')
74810458Sandreas.hansson@arm.com        code()
74910458Sandreas.hansson@arm.com        code('void cxxConfigInit()')
75010458Sandreas.hansson@arm.com        code('{')
75110458Sandreas.hansson@arm.com        code.indent()
75210458Sandreas.hansson@arm.com        for name,simobj in sorted(sim_objects.iteritems()):
75310458Sandreas.hansson@arm.com            not_abstract = not hasattr(simobj, 'abstract') or \
75410458Sandreas.hansson@arm.com                not simobj.abstract
75510458Sandreas.hansson@arm.com            if not_abstract and 'type' in simobj.__dict__:
75610458Sandreas.hansson@arm.com                code('cxx_config_directory["${name}"] = '
75710458Sandreas.hansson@arm.com                     '${name}CxxConfigParams::makeDirectoryEntry();')
75810458Sandreas.hansson@arm.com        code.dedent()
75910458Sandreas.hansson@arm.com        code('}')
76010458Sandreas.hansson@arm.com        code.write(target[0].abspath)
76110458Sandreas.hansson@arm.com
76210458Sandreas.hansson@arm.com    py_source = PySource.modules[simobj.__module__]
76310458Sandreas.hansson@arm.com    extra_deps = [ py_source.tnode ]
76410458Sandreas.hansson@arm.com    env.Command(cxx_config_init_cc_file, Value(name),
76510458Sandreas.hansson@arm.com        MakeAction(createCxxConfigInitCC, Transform("CXXCINIT")))
76610458Sandreas.hansson@arm.com    cxx_param_hh_files = ["cxx_config/%s.hh" % simobj
76710584Sandreas.hansson@arm.com        for name,simobj in sorted(sim_objects.iteritems())
76810458Sandreas.hansson@arm.com        if not hasattr(simobj, 'abstract') or not simobj.abstract]
76910458Sandreas.hansson@arm.com    Depends(cxx_config_init_cc_file, cxx_param_hh_files +
77010458Sandreas.hansson@arm.com            [File('sim/cxx_config.hh')])
77110458Sandreas.hansson@arm.com    Source(cxx_config_init_cc_file)
77210458Sandreas.hansson@arm.com
7738596Ssteve.reinhardt@amd.com# Generate any needed param SWIG wrapper files
7745463Snate@binkert.orgparams_i_files = []
77510584Sandreas.hansson@arm.comfor name,param in sorted(params_to_swig.iteritems()):
7768596Ssteve.reinhardt@amd.com    i_file = File('python/m5/internal/%s.i' % (param.swig_module_name()))
7775463Snate@binkert.org    params_i_files.append(i_file)
7787756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
7798596Ssteve.reinhardt@amd.com                MakeAction(createParamSwigWrapper, Transform("SW PARAM")))
7804762Snate@binkert.org    env.Depends(i_file, depends)
78110454SCurtis.Dunham@arm.com    env.Depends(SWIG, i_file)
7827677Snate@binkert.org    SwigSource('m5.internal', i_file)
7834762Snate@binkert.org
7844762Snate@binkert.org# Generate all enum header files
7856143Snate@binkert.orgfor name,enum in sorted(all_enums.iteritems()):
7866143Snate@binkert.org    py_source = PySource.modules[enum.__module__]
7876143Snate@binkert.org    extra_deps = [ py_source.tnode ]
7884762Snate@binkert.org
7894762Snate@binkert.org    cc_file = File('enums/%s.cc' % name)
7907756SAli.Saidi@ARM.com    env.Command(cc_file, Value(name),
7917816Ssteve.reinhardt@amd.com                MakeAction(createEnumStrings, Transform("ENUM STR")))
7924762Snate@binkert.org    env.Depends(cc_file, depends + extra_deps)
79310454SCurtis.Dunham@arm.com    env.Depends(SWIG, cc_file)
7944762Snate@binkert.org    Source(cc_file)
7954762Snate@binkert.org
7964762Snate@binkert.org    hh_file = File('enums/%s.hh' % name)
7977756SAli.Saidi@ARM.com    env.Command(hh_file, Value(name),
7988596Ssteve.reinhardt@amd.com                MakeAction(createEnumDecls, Transform("ENUMDECL")))
7994762Snate@binkert.org    env.Depends(hh_file, depends + extra_deps)
80010454SCurtis.Dunham@arm.com    env.Depends(SWIG, hh_file)
8014762Snate@binkert.org
8027677Snate@binkert.org    i_file = File('python/m5/internal/enum_%s.i' % name)
8037756SAli.Saidi@ARM.com    env.Command(i_file, Value(name),
8048596Ssteve.reinhardt@amd.com                MakeAction(createEnumSwigWrapper, Transform("ENUMSWIG")))
8057675Snate@binkert.org    env.Depends(i_file, depends + extra_deps)
80610454SCurtis.Dunham@arm.com    env.Depends(SWIG, i_file)
8077677Snate@binkert.org    SwigSource('m5.internal', i_file)
8085517Snate@binkert.org
8098596Ssteve.reinhardt@amd.com# Generate SimObject SWIG wrapper files
81010584Sandreas.hansson@arm.comfor name,simobj in sorted(sim_objects.iteritems()):
8119248SAndreas.Sandberg@arm.com    py_source = PySource.modules[simobj.__module__]
8129248SAndreas.Sandberg@arm.com    extra_deps = [ py_source.tnode ]
8138596Ssteve.reinhardt@amd.com    i_file = File('python/m5/internal/param_%s.i' % name)
8148596Ssteve.reinhardt@amd.com    env.Command(i_file, Value(name),
8158596Ssteve.reinhardt@amd.com                MakeAction(createSimObjectSwigWrapper, Transform("SO SWIG")))
8169248SAndreas.Sandberg@arm.com    env.Depends(i_file, depends + extra_deps)
8178596Ssteve.reinhardt@amd.com    SwigSource('m5.internal', i_file)
8184762Snate@binkert.org
8197674Snate@binkert.org# Generate the main swig init file
82011548Sandreas.hansson@arm.comdef makeEmbeddedSwigInit(package):
82111548Sandreas.hansson@arm.com    def body(target, source, env):
82211548Sandreas.hansson@arm.com        assert len(target) == 1 and len(source) == 1
8237674Snate@binkert.org
82411548Sandreas.hansson@arm.com        code = code_formatter()
82511548Sandreas.hansson@arm.com        module = source[0].get_contents()
82611548Sandreas.hansson@arm.com        # Provide the full context so that the swig-generated call to
82711548Sandreas.hansson@arm.com        # Py_InitModule ends up placing the embedded module in the
82811548Sandreas.hansson@arm.com        # right package.
82911548Sandreas.hansson@arm.com        context = str(package) + "._" + str(module)
83011548Sandreas.hansson@arm.com        code('''\
83111548Sandreas.hansson@arm.com        #include "sim/init.hh"
8327674Snate@binkert.org
83311548Sandreas.hansson@arm.com        extern "C" {
83411548Sandreas.hansson@arm.com            void init_${module}();
83511548Sandreas.hansson@arm.com        }
83611548Sandreas.hansson@arm.com
83711548Sandreas.hansson@arm.com        EmbeddedSwig embed_swig_${module}(init_${module}, "${context}");
83811548Sandreas.hansson@arm.com        ''')
83911548Sandreas.hansson@arm.com        code.write(str(target[0]))
84011548Sandreas.hansson@arm.com    return body
84111308Santhony.gutierrez@amd.com
8424762Snate@binkert.org# Build all swig modules
8436143Snate@binkert.orgfor swig in SwigSource.all:
8446143Snate@binkert.org    env.Command([swig.cc_source.tnode, swig.py_source.tnode], swig.tnode,
8457756SAli.Saidi@ARM.com                MakeAction('$SWIG $SWIGFLAGS -outdir ${TARGETS[1].dir} '
8467816Ssteve.reinhardt@amd.com                '-o ${TARGETS[0]} $SOURCES', Transform("SWIG")))
8478235Snate@binkert.org    cc_file = str(swig.tnode)
8488596Ssteve.reinhardt@amd.com    init_file = '%s/%s_init.cc' % (dirname(cc_file), basename(cc_file))
8497756SAli.Saidi@ARM.com    env.Command(init_file, Value(swig.module),
85011548Sandreas.hansson@arm.com                MakeAction(makeEmbeddedSwigInit(swig.package),
85111548Sandreas.hansson@arm.com                           Transform("EMBED SW")))
85210454SCurtis.Dunham@arm.com    env.Depends(SWIG, init_file)
8538235Snate@binkert.org    Source(init_file, **swig.guards)
8544382Sbinkertn@umich.edu
8559396Sandreas.hansson@arm.com# Build all protocol buffers if we have got protoc and protobuf available
8569396Sandreas.hansson@arm.comif env['HAVE_PROTOBUF']:
8579396Sandreas.hansson@arm.com    for proto in ProtoBuf.all:
8589396Sandreas.hansson@arm.com        # Use both the source and header as the target, and the .proto
8599396Sandreas.hansson@arm.com        # file as the source. When executing the protoc compiler, also
8609396Sandreas.hansson@arm.com        # specify the proto_path to avoid having the generated files
8619396Sandreas.hansson@arm.com        # include the path.
8629396Sandreas.hansson@arm.com        env.Command([proto.cc_file, proto.hh_file], proto.tnode,
8639396Sandreas.hansson@arm.com                    MakeAction('$PROTOC --cpp_out ${TARGET.dir} '
8649396Sandreas.hansson@arm.com                               '--proto_path ${SOURCE.dir} $SOURCE',
8659396Sandreas.hansson@arm.com                               Transform("PROTOC")))
8669396Sandreas.hansson@arm.com
86710454SCurtis.Dunham@arm.com        env.Depends(SWIG, [proto.cc_file, proto.hh_file])
8689396Sandreas.hansson@arm.com        # Add the C++ source file
8699396Sandreas.hansson@arm.com        Source(proto.cc_file, **proto.guards)
8709396Sandreas.hansson@arm.comelif ProtoBuf.all:
8719396Sandreas.hansson@arm.com    print 'Got protobuf to build, but lacks support!'
8729396Sandreas.hansson@arm.com    Exit(1)
8739396Sandreas.hansson@arm.com
8748232Snate@binkert.org#
8758232Snate@binkert.org# Handle debug flags
8768232Snate@binkert.org#
8778232Snate@binkert.orgdef makeDebugFlagCC(target, source, env):
8788232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
8796229Snate@binkert.org
88010455SCurtis.Dunham@arm.com    code = code_formatter()
8816229Snate@binkert.org
88210455SCurtis.Dunham@arm.com    # delay definition of CompoundFlags until after all the definition
88310455SCurtis.Dunham@arm.com    # of all constituent SimpleFlags
88410455SCurtis.Dunham@arm.com    comp_code = code_formatter()
8855517Snate@binkert.org
8865517Snate@binkert.org    # file header
8877673Snate@binkert.org    code('''
8885517Snate@binkert.org/*
88910455SCurtis.Dunham@arm.com * DO NOT EDIT THIS FILE! Automatically generated by SCons.
8905517Snate@binkert.org */
8915517Snate@binkert.org
8928232Snate@binkert.org#include "base/debug.hh"
89310455SCurtis.Dunham@arm.com
89410455SCurtis.Dunham@arm.comnamespace Debug {
89510455SCurtis.Dunham@arm.com
8967673Snate@binkert.org''')
8977673Snate@binkert.org
89810455SCurtis.Dunham@arm.com    for name, flag in sorted(source[0].read().iteritems()):
89910455SCurtis.Dunham@arm.com        n, compound, desc = flag
90010455SCurtis.Dunham@arm.com        assert n == name
9015517Snate@binkert.org
90210455SCurtis.Dunham@arm.com        if not compound:
90310455SCurtis.Dunham@arm.com            code('SimpleFlag $name("$name", "$desc");')
90410455SCurtis.Dunham@arm.com        else:
90510455SCurtis.Dunham@arm.com            comp_code('CompoundFlag $name("$name", "$desc",')
90610455SCurtis.Dunham@arm.com            comp_code.indent()
90710455SCurtis.Dunham@arm.com            last = len(compound) - 1
90810455SCurtis.Dunham@arm.com            for i,flag in enumerate(compound):
90910455SCurtis.Dunham@arm.com                if i != last:
91010685Sandreas.hansson@arm.com                    comp_code('&$flag,')
91110455SCurtis.Dunham@arm.com                else:
91210685Sandreas.hansson@arm.com                    comp_code('&$flag);')
91310455SCurtis.Dunham@arm.com            comp_code.dedent()
9145517Snate@binkert.org
91510455SCurtis.Dunham@arm.com    code.append(comp_code)
9168232Snate@binkert.org    code()
9178232Snate@binkert.org    code('} // namespace Debug')
9185517Snate@binkert.org
9197673Snate@binkert.org    code.write(str(target[0]))
9205517Snate@binkert.org
9218232Snate@binkert.orgdef makeDebugFlagHH(target, source, env):
9228232Snate@binkert.org    assert(len(target) == 1 and len(source) == 1)
9235517Snate@binkert.org
9248232Snate@binkert.org    val = eval(source[0].get_contents())
9258232Snate@binkert.org    name, compound, desc = val
9268232Snate@binkert.org
9277673Snate@binkert.org    code = code_formatter()
9285517Snate@binkert.org
9295517Snate@binkert.org    # file header boilerplate
9307673Snate@binkert.org    code('''\
9315517Snate@binkert.org/*
93210455SCurtis.Dunham@arm.com * DO NOT EDIT THIS FILE! Automatically generated by SCons.
9335517Snate@binkert.org */
9345517Snate@binkert.org
9358232Snate@binkert.org#ifndef __DEBUG_${name}_HH__
9368232Snate@binkert.org#define __DEBUG_${name}_HH__
9375517Snate@binkert.org
9388232Snate@binkert.orgnamespace Debug {
9398232Snate@binkert.org''')
9405517Snate@binkert.org
9418232Snate@binkert.org    if compound:
9428232Snate@binkert.org        code('class CompoundFlag;')
9438232Snate@binkert.org    code('class SimpleFlag;')
9445517Snate@binkert.org
9458232Snate@binkert.org    if compound:
9468232Snate@binkert.org        code('extern CompoundFlag $name;')
9478232Snate@binkert.org        for flag in compound:
9488232Snate@binkert.org            code('extern SimpleFlag $flag;')
9498232Snate@binkert.org    else:
9508232Snate@binkert.org        code('extern SimpleFlag $name;')
9515517Snate@binkert.org
9528232Snate@binkert.org    code('''
9538232Snate@binkert.org}
9545517Snate@binkert.org
9558232Snate@binkert.org#endif // __DEBUG_${name}_HH__
9567673Snate@binkert.org''')
9575517Snate@binkert.org
9587673Snate@binkert.org    code.write(str(target[0]))
9595517Snate@binkert.org
9608232Snate@binkert.orgfor name,flag in sorted(debug_flags.iteritems()):
9618232Snate@binkert.org    n, compound, desc = flag
9628232Snate@binkert.org    assert n == name
9635192Ssaidi@eecs.umich.edu
96410454SCurtis.Dunham@arm.com    hh_file = 'debug/%s.hh' % name
96510454SCurtis.Dunham@arm.com    env.Command(hh_file, Value(flag),
9668232Snate@binkert.org                MakeAction(makeDebugFlagHH, Transform("TRACING", 0)))
96710455SCurtis.Dunham@arm.com    env.Depends(SWIG, hh_file)
96810455SCurtis.Dunham@arm.com
96910455SCurtis.Dunham@arm.comenv.Command('debug/flags.cc', Value(debug_flags),
97010455SCurtis.Dunham@arm.com            MakeAction(makeDebugFlagCC, Transform("TRACING", 0)))
97110455SCurtis.Dunham@arm.comenv.Depends(SWIG, 'debug/flags.cc')
97210455SCurtis.Dunham@arm.comSource('debug/flags.cc')
9735192Ssaidi@eecs.umich.edu
97411077SCurtis.Dunham@arm.com# version tags
97511330SCurtis.Dunham@arm.comtags = \
97611077SCurtis.Dunham@arm.comenv.Command('sim/tags.cc', None,
97711077SCurtis.Dunham@arm.com            MakeAction('util/cpt_upgrader.py --get-cc-file > $TARGET',
97811077SCurtis.Dunham@arm.com                       Transform("VER TAGS")))
97911330SCurtis.Dunham@arm.comenv.AlwaysBuild(tags)
98011077SCurtis.Dunham@arm.com
9817674Snate@binkert.org# Embed python files.  All .py files that have been indicated by a
9825522Snate@binkert.org# PySource() call in a SConscript need to be embedded into the M5
9835522Snate@binkert.org# library.  To do that, we compile the file to byte code, marshal the
9847674Snate@binkert.org# byte code, compress it, and then generate a c++ file that
9857674Snate@binkert.org# inserts the result into an array.
9867674Snate@binkert.orgdef embedPyFile(target, source, env):
9877674Snate@binkert.org    def c_str(string):
9887674Snate@binkert.org        if string is None:
9897674Snate@binkert.org            return "0"
9907674Snate@binkert.org        return '"%s"' % string
9917674Snate@binkert.org
9925522Snate@binkert.org    '''Action function to compile a .py into a code object, marshal
9935522Snate@binkert.org    it, compress it, and stick it into an asm file so the code appears
9945522Snate@binkert.org    as just bytes with a label in the data section'''
9955517Snate@binkert.org
9965522Snate@binkert.org    src = file(str(source[0]), 'r').read()
9975517Snate@binkert.org
9986143Snate@binkert.org    pysource = PySource.tnodes[source[0]]
9996727Ssteve.reinhardt@amd.com    compiled = compile(src, pysource.abspath, 'exec')
10005522Snate@binkert.org    marshalled = marshal.dumps(compiled)
10015522Snate@binkert.org    compressed = zlib.compress(marshalled)
10025522Snate@binkert.org    data = compressed
10037674Snate@binkert.org    sym = pysource.symname
10045517Snate@binkert.org
10057673Snate@binkert.org    code = code_formatter()
10067673Snate@binkert.org    code('''\
10077674Snate@binkert.org#include "sim/init.hh"
10087673Snate@binkert.org
10097674Snate@binkert.orgnamespace {
10107674Snate@binkert.org
10118946Sandreas.hansson@arm.comconst uint8_t data_${sym}[] = {
10127674Snate@binkert.org''')
10137674Snate@binkert.org    code.indent()
10147674Snate@binkert.org    step = 16
10155522Snate@binkert.org    for i in xrange(0, len(data), step):
10165522Snate@binkert.org        x = array.array('B', data[i:i+step])
10177674Snate@binkert.org        code(''.join('%d,' % d for d in x))
10187674Snate@binkert.org    code.dedent()
101911308Santhony.gutierrez@amd.com
10207674Snate@binkert.org    code('''};
10217673Snate@binkert.org
10227674Snate@binkert.orgEmbeddedPython embedded_${sym}(
10237674Snate@binkert.org    ${{c_str(pysource.arcname)}},
10247674Snate@binkert.org    ${{c_str(pysource.abspath)}},
10257674Snate@binkert.org    ${{c_str(pysource.modpath)}},
10267674Snate@binkert.org    data_${sym},
10277674Snate@binkert.org    ${{len(data)}},
10287674Snate@binkert.org    ${{len(marshalled)}});
10297674Snate@binkert.org
10307811Ssteve.reinhardt@amd.com} // anonymous namespace
10317674Snate@binkert.org''')
10327673Snate@binkert.org    code.write(str(target[0]))
10335522Snate@binkert.org
10346143Snate@binkert.orgfor source in PySource.all:
103510453SAndrew.Bardsley@arm.com    env.Command(source.cpp, source.tnode,
10367816Ssteve.reinhardt@amd.com                MakeAction(embedPyFile, Transform("EMBED PY")))
103710454SCurtis.Dunham@arm.com    env.Depends(SWIG, source.cpp)
103810453SAndrew.Bardsley@arm.com    Source(source.cpp, skip_no_python=True)
10394382Sbinkertn@umich.edu
10404382Sbinkertn@umich.edu########################################################################
10414382Sbinkertn@umich.edu#
10424382Sbinkertn@umich.edu# Define binaries.  Each different build type (debug, opt, etc.) gets
10434382Sbinkertn@umich.edu# a slightly different build environment.
10444382Sbinkertn@umich.edu#
10454382Sbinkertn@umich.edu
10464382Sbinkertn@umich.edu# List of constructed environments to pass back to SConstruct
104710196SCurtis.Dunham@arm.comdate_source = Source('base/date.cc', skip_lib=True)
10484382Sbinkertn@umich.edu
104910196SCurtis.Dunham@arm.com# Capture this directory for the closure makeEnv, otherwise when it is
105010196SCurtis.Dunham@arm.com# called, it won't know what directory it should use.
105110196SCurtis.Dunham@arm.comvariant_dir = Dir('.').path
105210196SCurtis.Dunham@arm.comdef variant(*path):
105310196SCurtis.Dunham@arm.com    return os.path.join(variant_dir, *path)
105410196SCurtis.Dunham@arm.comdef variantd(*path):
105510196SCurtis.Dunham@arm.com    return variant(*path)+'/'
1056955SN/A
10572655Sstever@eecs.umich.edu# Function to create a new build environment as clone of current
10582655Sstever@eecs.umich.edu# environment 'env' with modified object suffix and optional stripped
10592655Sstever@eecs.umich.edu# binary.  Additional keyword arguments are appended to corresponding
10602655Sstever@eecs.umich.edu# build environment vars.
106110196SCurtis.Dunham@arm.comdef makeEnv(env, label, objsfx, strip = False, **kwargs):
10625601Snate@binkert.org    # SCons doesn't know to append a library suffix when there is a '.' in the
10635601Snate@binkert.org    # name.  Use '_' instead.
106410196SCurtis.Dunham@arm.com    libname = variant('gem5_' + label)
106510196SCurtis.Dunham@arm.com    exename = variant('gem5.' + label)
106610196SCurtis.Dunham@arm.com    secondary_exename = variant('m5.' + label)
10675522Snate@binkert.org
10685863Snate@binkert.org    new_env = env.Clone(OBJSUFFIX=objsfx, SHOBJSUFFIX=objsfx + 's')
10695601Snate@binkert.org    new_env.Label = label
10705601Snate@binkert.org    new_env.Append(**kwargs)
10715601Snate@binkert.org
10725863Snate@binkert.org    swig_env = new_env.Clone()
10739556Sandreas.hansson@arm.com
10749556Sandreas.hansson@arm.com    # Both gcc and clang have issues with unused labels and values in
10759556Sandreas.hansson@arm.com    # the SWIG generated code
10769556Sandreas.hansson@arm.com    swig_env.Append(CCFLAGS=['-Wno-unused-label', '-Wno-unused-value'])
10779556Sandreas.hansson@arm.com
10785559Snate@binkert.org    if env['GCC']:
10799556Sandreas.hansson@arm.com        # Depending on the SWIG version, we also need to supress
10809618Ssteve.reinhardt@amd.com        # warnings about uninitialized variables and missing field
10819618Ssteve.reinhardt@amd.com        # initializers.
10829618Ssteve.reinhardt@amd.com        swig_env.Append(CCFLAGS=['-Wno-uninitialized',
108310238Sandreas.hansson@arm.com                                 '-Wno-missing-field-initializers',
108410878Sandreas.hansson@arm.com                                 '-Wno-unused-but-set-variable',
108511294Sandreas.hansson@arm.com                                 '-Wno-maybe-uninitialized',
108611294Sandreas.hansson@arm.com                                 '-Wno-type-limits'])
108710457Sandreas.hansson@arm.com
108810457Sandreas.hansson@arm.com        # Only gcc >= 4.9 supports UBSan, so check both the version
108910457Sandreas.hansson@arm.com        # and the command-line option before adding the compiler and
109010457Sandreas.hansson@arm.com        # linker flags.
109110457Sandreas.hansson@arm.com        if GetOption('with_ubsan') and \
109210457Sandreas.hansson@arm.com                compareVersions(env['GCC_VERSION'], '4.9') >= 0:
109310457Sandreas.hansson@arm.com            new_env.Append(CCFLAGS='-fsanitize=undefined')
109410457Sandreas.hansson@arm.com            new_env.Append(LINKFLAGS='-fsanitize=undefined')
109510457Sandreas.hansson@arm.com
109611342Sandreas.hansson@arm.com        # The address sanitizer is available for gcc >= 4.8
109711500Sandreas.hansson@arm.com        if GetOption('with_asan'):
109811500Sandreas.hansson@arm.com            new_env.Append(CCFLAGS=['-fsanitize=address',
109911500Sandreas.hansson@arm.com                                    '-fno-omit-frame-pointer'])
110011342Sandreas.hansson@arm.com            new_env.Append(LINKFLAGS='-fsanitize=address')
110111342Sandreas.hansson@arm.com
11028737Skoansin.tan@gmail.com    if env['CLANG']:
110311294Sandreas.hansson@arm.com        swig_env.Append(CCFLAGS=['-Wno-sometimes-uninitialized',
110411294Sandreas.hansson@arm.com                                 '-Wno-deprecated-register',
110511294Sandreas.hansson@arm.com                                 '-Wno-tautological-compare'])
110610278SAndreas.Sandberg@ARM.com
110711342Sandreas.hansson@arm.com        # We require clang >= 3.1, so there is no need to check any
110811342Sandreas.hansson@arm.com        # versions here.
110910457Sandreas.hansson@arm.com        if GetOption('with_ubsan'):
111010457Sandreas.hansson@arm.com            new_env.Append(CCFLAGS='-fsanitize=undefined')
111110457Sandreas.hansson@arm.com            new_env.Append(LINKFLAGS='-fsanitize=undefined')
111210457Sandreas.hansson@arm.com
111311342Sandreas.hansson@arm.com        if GetOption('with_asan'):
111411500Sandreas.hansson@arm.com            new_env.Append(CCFLAGS=['-fsanitize=address',
111511500Sandreas.hansson@arm.com                                    '-fno-omit-frame-pointer'])
111611342Sandreas.hansson@arm.com            new_env.Append(LINKFLAGS='-fsanitize=address')
111711342Sandreas.hansson@arm.com
11188945Ssteve.reinhardt@amd.com    werror_env = new_env.Clone()
111910686SAndreas.Sandberg@ARM.com    # Treat warnings as errors but white list some warnings that we
112010686SAndreas.Sandberg@ARM.com    # want to allow (e.g., deprecation warnings).
112110686SAndreas.Sandberg@ARM.com    werror_env.Append(CCFLAGS=['-Werror',
112210686SAndreas.Sandberg@ARM.com                               '-Wno-error=deprecated-declarations',
112310686SAndreas.Sandberg@ARM.com                               '-Wno-error=deprecated',
112410686SAndreas.Sandberg@ARM.com                               ])
11258945Ssteve.reinhardt@amd.com
11266143Snate@binkert.org    def make_obj(source, static, extra_deps = None):
11276143Snate@binkert.org        '''This function adds the specified source to the correct
11286143Snate@binkert.org        build environment, and returns the corresponding SCons Object
11296143Snate@binkert.org        nodes'''
11306143Snate@binkert.org
11316143Snate@binkert.org        if source.swig:
11326143Snate@binkert.org            env = swig_env
11338945Ssteve.reinhardt@amd.com        elif source.Werror:
11348945Ssteve.reinhardt@amd.com            env = werror_env
11356143Snate@binkert.org        else:
11366143Snate@binkert.org            env = new_env
11376143Snate@binkert.org
11386143Snate@binkert.org        if static:
11396143Snate@binkert.org            obj = env.StaticObject(source.tnode)
11406143Snate@binkert.org        else:
11416143Snate@binkert.org            obj = env.SharedObject(source.tnode)
11426143Snate@binkert.org
11436143Snate@binkert.org        if extra_deps:
11446143Snate@binkert.org            env.Depends(obj, extra_deps)
11456143Snate@binkert.org
11466143Snate@binkert.org        return obj
11476143Snate@binkert.org
114810453SAndrew.Bardsley@arm.com    lib_guards = {'main': False, 'skip_lib': False}
114910453SAndrew.Bardsley@arm.com
115010453SAndrew.Bardsley@arm.com    # Without Python, leave out all SWIG and Python content from the
115110453SAndrew.Bardsley@arm.com    # library builds.  The option doesn't affect gem5 built as a program
115210453SAndrew.Bardsley@arm.com    if GetOption('without_python'):
115310453SAndrew.Bardsley@arm.com        lib_guards['skip_no_python'] = False
115410453SAndrew.Bardsley@arm.com
115510453SAndrew.Bardsley@arm.com    static_objs = [ make_obj(s, True) for s in Source.get(**lib_guards) ]
115610453SAndrew.Bardsley@arm.com    shared_objs = [ make_obj(s, False) for s in Source.get(**lib_guards) ]
11576143Snate@binkert.org
11586143Snate@binkert.org    static_date = make_obj(date_source, static=True, extra_deps=static_objs)
11596143Snate@binkert.org    static_objs.append(static_date)
116010453SAndrew.Bardsley@arm.com
11616143Snate@binkert.org    shared_date = make_obj(date_source, static=False, extra_deps=shared_objs)
11626240Snate@binkert.org    shared_objs.append(shared_date)
11635554Snate@binkert.org
11645522Snate@binkert.org    # First make a library of everything but main() so other programs can
11655522Snate@binkert.org    # link against m5.
11665797Snate@binkert.org    static_lib = new_env.StaticLibrary(libname, static_objs)
11675797Snate@binkert.org    shared_lib = new_env.SharedLibrary(libname, shared_objs)
11685522Snate@binkert.org
11695601Snate@binkert.org    # Now link a stub with main() and the static library.
11708233Snate@binkert.org    main_objs = [ make_obj(s, True) for s in Source.get(main=True) ]
11718233Snate@binkert.org
11728235Snate@binkert.org    for test in UnitTest.all:
11738235Snate@binkert.org        flags = { test.target : True }
11748235Snate@binkert.org        test_sources = Source.get(**flags)
11758235Snate@binkert.org        test_objs = [ make_obj(s, static=True) for s in test_sources ]
11769003SAli.Saidi@ARM.com        if test.main:
11779003SAli.Saidi@ARM.com            test_objs += main_objs
117810196SCurtis.Dunham@arm.com        path = variant('unittest/%s.%s' % (test.target, label))
117910196SCurtis.Dunham@arm.com        new_env.Program(path, test_objs + static_objs)
11808235Snate@binkert.org
11816143Snate@binkert.org    progname = exename
11822655Sstever@eecs.umich.edu    if strip:
11836143Snate@binkert.org        progname += '.unstripped'
11846143Snate@binkert.org
11858233Snate@binkert.org    targets = new_env.Program(progname, main_objs + static_objs)
11866143Snate@binkert.org
11876143Snate@binkert.org    if strip:
11884007Ssaidi@eecs.umich.edu        if sys.platform == 'sunos5':
11894596Sbinkertn@umich.edu            cmd = 'cp $SOURCE $TARGET; strip $TARGET'
11904007Ssaidi@eecs.umich.edu        else:
11914596Sbinkertn@umich.edu            cmd = 'strip $SOURCE -o $TARGET'
11927756SAli.Saidi@ARM.com        targets = new_env.Command(exename, progname,
11937816Ssteve.reinhardt@amd.com                    MakeAction(cmd, Transform("STRIP")))
11948334Snate@binkert.org
11958334Snate@binkert.org    new_env.Command(secondary_exename, exename,
11968334Snate@binkert.org            MakeAction('ln $SOURCE $TARGET', Transform("HARDLINK")))
11978334Snate@binkert.org
11985601Snate@binkert.org    new_env.M5Binary = targets[0]
119910196SCurtis.Dunham@arm.com    return new_env
12002655Sstever@eecs.umich.edu
12019225Sandreas.hansson@arm.com# Start out with the compiler flags common to all compilers,
12029225Sandreas.hansson@arm.com# i.e. they all use -g for opt and -g -pg for prof
12039226Sandreas.hansson@arm.comccflags = {'debug' : [], 'opt' : ['-g'], 'fast' : [], 'prof' : ['-g', '-pg'],
12049226Sandreas.hansson@arm.com           'perf' : ['-g']}
12059225Sandreas.hansson@arm.com
12069226Sandreas.hansson@arm.com# Start out with the linker flags common to all linkers, i.e. -pg for
12079226Sandreas.hansson@arm.com# prof, and -lprofiler for perf. The -lprofile flag is surrounded by
12089226Sandreas.hansson@arm.com# no-as-needed and as-needed as the binutils linker is too clever and
12099226Sandreas.hansson@arm.com# simply doesn't link to the library otherwise.
12109226Sandreas.hansson@arm.comldflags = {'debug' : [], 'opt' : [], 'fast' : [], 'prof' : ['-pg'],
12119226Sandreas.hansson@arm.com           'perf' : ['-Wl,--no-as-needed', '-lprofiler', '-Wl,--as-needed']}
12129225Sandreas.hansson@arm.com
12139227Sandreas.hansson@arm.com# For Link Time Optimization, the optimisation flags used to compile
12149227Sandreas.hansson@arm.com# individual files are decoupled from those used at link time
12159227Sandreas.hansson@arm.com# (i.e. you can compile with -O3 and perform LTO with -O0), so we need
12169227Sandreas.hansson@arm.com# to also update the linker flags based on the target.
12178946Sandreas.hansson@arm.comif env['GCC']:
12183918Ssaidi@eecs.umich.edu    if sys.platform == 'sunos5':
12199225Sandreas.hansson@arm.com        ccflags['debug'] += ['-gstabs+']
12203918Ssaidi@eecs.umich.edu    else:
12219225Sandreas.hansson@arm.com        ccflags['debug'] += ['-ggdb3']
12229225Sandreas.hansson@arm.com    ldflags['debug'] += ['-O0']
12239227Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags, also add
12249227Sandreas.hansson@arm.com    # the optimization to the ldflags as LTO defers the optimization
12259227Sandreas.hansson@arm.com    # to link time
12269226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
12279225Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
12289227Sandreas.hansson@arm.com        ldflags[target] += ['-O3']
12299227Sandreas.hansson@arm.com
12309227Sandreas.hansson@arm.com    ccflags['fast'] += env['LTO_CCFLAGS']
12319227Sandreas.hansson@arm.com    ldflags['fast'] += env['LTO_LDFLAGS']
12328946Sandreas.hansson@arm.comelif env['CLANG']:
12339225Sandreas.hansson@arm.com    ccflags['debug'] += ['-g', '-O0']
12349226Sandreas.hansson@arm.com    # opt, fast, prof and perf all share the same cc flags
12359226Sandreas.hansson@arm.com    for target in ['opt', 'fast', 'prof', 'perf']:
12369226Sandreas.hansson@arm.com        ccflags[target] += ['-O3']
12373515Ssaidi@eecs.umich.eduelse:
12383918Ssaidi@eecs.umich.edu    print 'Unknown compiler, please fix compiler options'
12394762Snate@binkert.org    Exit(1)
12403515Ssaidi@eecs.umich.edu
12418881Smarc.orr@gmail.com
12428881Smarc.orr@gmail.com# To speed things up, we only instantiate the build environments we
12438881Smarc.orr@gmail.com# need.  We try to identify the needed environment for each target; if
12448881Smarc.orr@gmail.com# we can't, we fall back on instantiating all the environments just to
12458881Smarc.orr@gmail.com# be safe.
12469226Sandreas.hansson@arm.comtarget_types = ['debug', 'opt', 'fast', 'prof', 'perf']
12479226Sandreas.hansson@arm.comobj2target = {'do': 'debug', 'o': 'opt', 'fo': 'fast', 'po': 'prof',
12489226Sandreas.hansson@arm.com              'gpo' : 'perf'}
12498881Smarc.orr@gmail.com
12508881Smarc.orr@gmail.comdef identifyTarget(t):
12518881Smarc.orr@gmail.com    ext = t.split('.')[-1]
12528881Smarc.orr@gmail.com    if ext in target_types:
12538881Smarc.orr@gmail.com        return ext
12548881Smarc.orr@gmail.com    if obj2target.has_key(ext):
12558881Smarc.orr@gmail.com        return obj2target[ext]
12568881Smarc.orr@gmail.com    match = re.search(r'/tests/([^/]+)/', t)
12578881Smarc.orr@gmail.com    if match and match.group(1) in target_types:
12588881Smarc.orr@gmail.com        return match.group(1)
12598881Smarc.orr@gmail.com    return 'all'
12608881Smarc.orr@gmail.com
12618881Smarc.orr@gmail.comneeded_envs = [identifyTarget(target) for target in BUILD_TARGETS]
12628881Smarc.orr@gmail.comif 'all' in needed_envs:
12638881Smarc.orr@gmail.com    needed_envs += target_types
12648881Smarc.orr@gmail.com
126510196SCurtis.Dunham@arm.comdef makeEnvirons(target, source, env):
126610196SCurtis.Dunham@arm.com    # cause any later Source() calls to be fatal, as a diagnostic.
126710196SCurtis.Dunham@arm.com    Source.done()
1268955SN/A
126910196SCurtis.Dunham@arm.com    envList = []
1270955SN/A
127110196SCurtis.Dunham@arm.com    # Debug binary
127210196SCurtis.Dunham@arm.com    if 'debug' in needed_envs:
127310196SCurtis.Dunham@arm.com        envList.append(
127410196SCurtis.Dunham@arm.com            makeEnv(env, 'debug', '.do',
127510196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['debug']),
127610196SCurtis.Dunham@arm.com                    CPPDEFINES = ['DEBUG', 'TRACING_ON=1'],
127710196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['debug'])))
1278955SN/A
127910196SCurtis.Dunham@arm.com    # Optimized binary
128010196SCurtis.Dunham@arm.com    if 'opt' in needed_envs:
128110196SCurtis.Dunham@arm.com        envList.append(
128210196SCurtis.Dunham@arm.com            makeEnv(env, 'opt', '.o',
128310196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['opt']),
128410196SCurtis.Dunham@arm.com                    CPPDEFINES = ['TRACING_ON=1'],
128510196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['opt'])))
12861869SN/A
128710196SCurtis.Dunham@arm.com    # "Fast" binary
128810196SCurtis.Dunham@arm.com    if 'fast' in needed_envs:
128910196SCurtis.Dunham@arm.com        envList.append(
129010196SCurtis.Dunham@arm.com            makeEnv(env, 'fast', '.fo', strip = True,
129110196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['fast']),
129210196SCurtis.Dunham@arm.com                    CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
129310196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['fast'])))
12949226Sandreas.hansson@arm.com
129510196SCurtis.Dunham@arm.com    # Profiled binary using gprof
129610196SCurtis.Dunham@arm.com    if 'prof' in needed_envs:
129710196SCurtis.Dunham@arm.com        envList.append(
129810196SCurtis.Dunham@arm.com            makeEnv(env, 'prof', '.po',
129910196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['prof']),
130010196SCurtis.Dunham@arm.com                    CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
130110196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['prof'])))
130210196SCurtis.Dunham@arm.com
130310196SCurtis.Dunham@arm.com    # Profiled binary using google-pprof
130410196SCurtis.Dunham@arm.com    if 'perf' in needed_envs:
130510196SCurtis.Dunham@arm.com        envList.append(
130610196SCurtis.Dunham@arm.com            makeEnv(env, 'perf', '.gpo',
130710196SCurtis.Dunham@arm.com                    CCFLAGS = Split(ccflags['perf']),
130810196SCurtis.Dunham@arm.com                    CPPDEFINES = ['NDEBUG', 'TRACING_ON=0'],
130910196SCurtis.Dunham@arm.com                    LINKFLAGS = Split(ldflags['perf'])))
131010196SCurtis.Dunham@arm.com
131110196SCurtis.Dunham@arm.com    # Set up the regression tests for each build.
131210196SCurtis.Dunham@arm.com    for e in envList:
131311370Ssteve.reinhardt@amd.com        SConscript(os.path.join(env.root.abspath, 'tests', 'SConscript'),
131410196SCurtis.Dunham@arm.com                   variant_dir = variantd('tests', e.Label),
131510196SCurtis.Dunham@arm.com                   exports = { 'env' : e }, duplicate = False)
131610196SCurtis.Dunham@arm.com
131710196SCurtis.Dunham@arm.com# The MakeEnvirons Builder defers the full dependency collection until
131810196SCurtis.Dunham@arm.com# after processing the ISA definition (due to dynamically generated
131910196SCurtis.Dunham@arm.com# source files).  Add this dependency to all targets so they will wait
132010196SCurtis.Dunham@arm.com# until the environments are completely set up.  Otherwise, a second
132110196SCurtis.Dunham@arm.com# process (e.g. -j2 or higher) will try to compile the requested target,
132210196SCurtis.Dunham@arm.com# not know how, and fail.
132310196SCurtis.Dunham@arm.comenv.Append(BUILDERS = {'MakeEnvirons' :
132410196SCurtis.Dunham@arm.com                        Builder(action=MakeAction(makeEnvirons,
132510196SCurtis.Dunham@arm.com                                                  Transform("ENVIRONS", 1)))})
132610196SCurtis.Dunham@arm.com
132710196SCurtis.Dunham@arm.comisa_target = env['PHONY_BASE'] + '-deps'
132810196SCurtis.Dunham@arm.comenvirons   = env['PHONY_BASE'] + '-environs'
132910196SCurtis.Dunham@arm.comenv.Depends('#all-deps',     isa_target)
133010196SCurtis.Dunham@arm.comenv.Depends('#all-environs', environs)
133110196SCurtis.Dunham@arm.comenv.ScanISA(isa_target, File('arch/%s/generated/inc.d' % env['TARGET_ISA']))
133210196SCurtis.Dunham@arm.comenvSetup = env.MakeEnvirons(environs, isa_target)
133310196SCurtis.Dunham@arm.com
133410196SCurtis.Dunham@arm.com# make sure no -deps targets occur before all ISAs are complete
133510196SCurtis.Dunham@arm.comenv.Depends(isa_target, '#all-isas')
133610196SCurtis.Dunham@arm.com# likewise for -environs targets and all the -deps targets
133710196SCurtis.Dunham@arm.comenv.Depends(environs, '#all-deps')
1338