SConstruct revision 12243
1955SN/A# -*- mode:python -*-
2955SN/A
312230Sgiacomo.travaglini@arm.com# Copyright (c) 2013, 2015-2017 ARM Limited
49812Sandreas.hansson@arm.com# All rights reserved.
59812Sandreas.hansson@arm.com#
69812Sandreas.hansson@arm.com# The license below extends only to copyright in the software and shall
79812Sandreas.hansson@arm.com# not be construed as granting a license to any other intellectual
89812Sandreas.hansson@arm.com# property including but not limited to intellectual property relating
99812Sandreas.hansson@arm.com# to a hardware implementation of the functionality of the software
109812Sandreas.hansson@arm.com# licensed hereunder.  You may use the software subject to the license
119812Sandreas.hansson@arm.com# terms below provided that you ensure that this notice is replicated
129812Sandreas.hansson@arm.com# unmodified and in its entirety in all distributions of the software,
139812Sandreas.hansson@arm.com# modified or unmodified, in source code or in binary form.
149812Sandreas.hansson@arm.com#
157816Ssteve.reinhardt@amd.com# Copyright (c) 2011 Advanced Micro Devices, Inc.
165871Snate@binkert.org# Copyright (c) 2009 The Hewlett-Packard Development Company
171762SN/A# Copyright (c) 2004-2005 The Regents of The University of Michigan
18955SN/A# All rights reserved.
19955SN/A#
20955SN/A# Redistribution and use in source and binary forms, with or without
21955SN/A# modification, are permitted provided that the following conditions are
22955SN/A# met: redistributions of source code must retain the above copyright
23955SN/A# notice, this list of conditions and the following disclaimer;
24955SN/A# redistributions in binary form must reproduce the above copyright
25955SN/A# notice, this list of conditions and the following disclaimer in the
26955SN/A# documentation and/or other materials provided with the distribution;
27955SN/A# neither the name of the copyright holders nor the names of its
28955SN/A# contributors may be used to endorse or promote products derived from
29955SN/A# this software without specific prior written permission.
30955SN/A#
31955SN/A# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32955SN/A# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33955SN/A# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34955SN/A# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35955SN/A# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36955SN/A# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
37955SN/A# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
38955SN/A# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
39955SN/A# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40955SN/A# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
41955SN/A# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
422665Ssaidi@eecs.umich.edu#
432665Ssaidi@eecs.umich.edu# Authors: Steve Reinhardt
445863Snate@binkert.org#          Nathan Binkert
45955SN/A
46955SN/A###################################################
47955SN/A#
48955SN/A# SCons top-level build description (SConstruct) file.
49955SN/A#
508878Ssteve.reinhardt@amd.com# While in this directory ('gem5'), just type 'scons' to build the default
512632Sstever@eecs.umich.edu# configuration (see below), or type 'scons build/<CONFIG>/<binary>'
528878Ssteve.reinhardt@amd.com# to build some other configuration (e.g., 'build/ALPHA/gem5.opt' for
532632Sstever@eecs.umich.edu# the optimized full-system version).
54955SN/A#
558878Ssteve.reinhardt@amd.com# You can build gem5 in a different directory as long as there is a
562632Sstever@eecs.umich.edu# 'build/<CONFIG>' somewhere along the target path.  The build system
572761Sstever@eecs.umich.edu# expects that all configs under the same build directory are being
582632Sstever@eecs.umich.edu# built for the same host system.
592632Sstever@eecs.umich.edu#
602632Sstever@eecs.umich.edu# Examples:
612761Sstever@eecs.umich.edu#
622761Sstever@eecs.umich.edu#   The following two commands are equivalent.  The '-u' option tells
632761Sstever@eecs.umich.edu#   scons to search up the directory tree for this SConstruct file.
648878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5 ; scons build/ALPHA/gem5.debug
658878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5/build/ALPHA; scons -u gem5.debug
662761Sstever@eecs.umich.edu#
672761Sstever@eecs.umich.edu#   The following two commands are equivalent and demonstrate building
682761Sstever@eecs.umich.edu#   in a directory outside of the source tree.  The '-C' option tells
692761Sstever@eecs.umich.edu#   scons to chdir to the specified directory to find this SConstruct
702761Sstever@eecs.umich.edu#   file.
718878Ssteve.reinhardt@amd.com#   % cd <path-to-src>/gem5 ; scons /local/foo/build/ALPHA/gem5.debug
728878Ssteve.reinhardt@amd.com#   % cd /local/foo/build/ALPHA; scons -C <path-to-src>/gem5 gem5.debug
732632Sstever@eecs.umich.edu#
742632Sstever@eecs.umich.edu# You can use 'scons -H' to print scons options.  If you're in this
758878Ssteve.reinhardt@amd.com# 'gem5' directory (or use -u or -C to tell scons where to find this
768878Ssteve.reinhardt@amd.com# file), you can use 'scons -h' to print all the gem5-specific build
772632Sstever@eecs.umich.edu# options as well.
78955SN/A#
79955SN/A###################################################
80955SN/A
816654Snate@binkert.org# Global Python includes
8210196SCurtis.Dunham@arm.comimport itertools
83955SN/Aimport os
845396Ssaidi@eecs.umich.eduimport re
8511401Sandreas.sandberg@arm.comimport shutil
865863Snate@binkert.orgimport subprocess
875863Snate@binkert.orgimport sys
884202Sbinkertn@umich.edu
895863Snate@binkert.orgfrom os import mkdir, environ
905863Snate@binkert.orgfrom os.path import abspath, basename, dirname, expanduser, normpath
915863Snate@binkert.orgfrom os.path import exists,  isdir, isfile
925863Snate@binkert.orgfrom os.path import join as joinpath, split as splitpath
93955SN/A
946654Snate@binkert.org# SCons includes
955273Sstever@gmail.comimport SCons
965871Snate@binkert.orgimport SCons.Node
975273Sstever@gmail.com
986655Snate@binkert.orgextra_python_paths = [
998878Ssteve.reinhardt@amd.com    Dir('src/python').srcnode().abspath, # gem5 includes
1006655Snate@binkert.org    Dir('ext/ply').srcnode().abspath, # ply is used by several files
1016655Snate@binkert.org    ]
1029219Spower.jg@gmail.com
1036655Snate@binkert.orgsys.path[1:1] = extra_python_paths
1045871Snate@binkert.org
1056654Snate@binkert.orgfrom m5.util import compareVersions, readCommand
1068947Sandreas.hansson@arm.comfrom m5.util.terminal import get_termcap
1075396Ssaidi@eecs.umich.edu
1088120Sgblack@eecs.umich.eduhelp_texts = {
1098120Sgblack@eecs.umich.edu    "options" : "",
1108120Sgblack@eecs.umich.edu    "global_vars" : "",
1118120Sgblack@eecs.umich.edu    "local_vars" : ""
1128120Sgblack@eecs.umich.edu}
1138120Sgblack@eecs.umich.edu
1148120Sgblack@eecs.umich.eduExport("help_texts")
1158120Sgblack@eecs.umich.edu
1168879Ssteve.reinhardt@amd.com
1178879Ssteve.reinhardt@amd.com# There's a bug in scons in that (1) by default, the help texts from
1188879Ssteve.reinhardt@amd.com# AddOption() are supposed to be displayed when you type 'scons -h'
1198879Ssteve.reinhardt@amd.com# and (2) you can override the help displayed by 'scons -h' using the
1208879Ssteve.reinhardt@amd.com# Help() function, but these two features are incompatible: once
1218879Ssteve.reinhardt@amd.com# you've overridden the help text using Help(), there's no way to get
1228879Ssteve.reinhardt@amd.com# at the help texts from AddOptions.  See:
1238879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2356
1248879Ssteve.reinhardt@amd.com#     http://scons.tigris.org/issues/show_bug.cgi?id=2611
1258879Ssteve.reinhardt@amd.com# This hack lets us extract the help text from AddOptions and
1268879Ssteve.reinhardt@amd.com# re-inject it via Help().  Ideally someday this bug will be fixed and
1278879Ssteve.reinhardt@amd.com# we can just use AddOption directly.
1288879Ssteve.reinhardt@amd.comdef AddLocalOption(*args, **kwargs):
1298120Sgblack@eecs.umich.edu    col_width = 30
1308120Sgblack@eecs.umich.edu
1318120Sgblack@eecs.umich.edu    help = "  " + ", ".join(args)
1328120Sgblack@eecs.umich.edu    if "help" in kwargs:
1338120Sgblack@eecs.umich.edu        length = len(help)
1348120Sgblack@eecs.umich.edu        if length >= col_width:
1358120Sgblack@eecs.umich.edu            help += "\n" + " " * col_width
1368120Sgblack@eecs.umich.edu        else:
1378120Sgblack@eecs.umich.edu            help += " " * (col_width - length)
1388120Sgblack@eecs.umich.edu        help += kwargs["help"]
1398120Sgblack@eecs.umich.edu    help_texts["options"] += help + "\n"
1408120Sgblack@eecs.umich.edu
1418120Sgblack@eecs.umich.edu    AddOption(*args, **kwargs)
1428120Sgblack@eecs.umich.edu
1438879Ssteve.reinhardt@amd.comAddLocalOption('--colors', dest='use_colors', action='store_true',
1448879Ssteve.reinhardt@amd.com               help="Add color to abbreviated scons output")
1458879Ssteve.reinhardt@amd.comAddLocalOption('--no-colors', dest='use_colors', action='store_false',
1468879Ssteve.reinhardt@amd.com               help="Don't add color to abbreviated scons output")
14710458Sandreas.hansson@arm.comAddLocalOption('--with-cxx-config', dest='with_cxx_config',
14810458Sandreas.hansson@arm.com               action='store_true',
14910458Sandreas.hansson@arm.com               help="Build with support for C++-based configuration")
1508879Ssteve.reinhardt@amd.comAddLocalOption('--default', dest='default', type='string', action='store',
1518879Ssteve.reinhardt@amd.com               help='Override which build_opts file to use for defaults')
1528879Ssteve.reinhardt@amd.comAddLocalOption('--ignore-style', dest='ignore_style', action='store_true',
1538879Ssteve.reinhardt@amd.com               help='Disable style checking hooks')
1549227Sandreas.hansson@arm.comAddLocalOption('--no-lto', dest='no_lto', action='store_true',
1559227Sandreas.hansson@arm.com               help='Disable Link-Time Optimization for fast')
15612063Sgabeblack@google.comAddLocalOption('--force-lto', dest='force_lto', action='store_true',
15712063Sgabeblack@google.com               help='Use Link-Time Optimization instead of partial linking' +
15812063Sgabeblack@google.com                    ' when the compiler doesn\'t support using them together.')
1598879Ssteve.reinhardt@amd.comAddLocalOption('--update-ref', dest='update_ref', action='store_true',
1608879Ssteve.reinhardt@amd.com               help='Update test reference outputs')
1618879Ssteve.reinhardt@amd.comAddLocalOption('--verbose', dest='verbose', action='store_true',
1628879Ssteve.reinhardt@amd.com               help='Print full tool command lines')
16310453SAndrew.Bardsley@arm.comAddLocalOption('--without-python', dest='without_python',
16410453SAndrew.Bardsley@arm.com               action='store_true',
16510453SAndrew.Bardsley@arm.com               help='Build without Python configuration support')
16610456SCurtis.Dunham@arm.comAddLocalOption('--without-tcmalloc', dest='without_tcmalloc',
16710456SCurtis.Dunham@arm.com               action='store_true',
16810456SCurtis.Dunham@arm.com               help='Disable linking against tcmalloc')
16910457Sandreas.hansson@arm.comAddLocalOption('--with-ubsan', dest='with_ubsan', action='store_true',
17010457Sandreas.hansson@arm.com               help='Build with Undefined Behavior Sanitizer if available')
17111342Sandreas.hansson@arm.comAddLocalOption('--with-asan', dest='with_asan', action='store_true',
17211342Sandreas.hansson@arm.com               help='Build with Address Sanitizer if available')
1738120Sgblack@eecs.umich.edu
17412063Sgabeblack@google.comif GetOption('no_lto') and GetOption('force_lto'):
17512063Sgabeblack@google.com    print '--no-lto and --force-lto are mutually exclusive'
17612063Sgabeblack@google.com    Exit(1)
17712063Sgabeblack@google.com
1788947Sandreas.hansson@arm.comtermcap = get_termcap(GetOption('use_colors'))
1797816Ssteve.reinhardt@amd.com
1805871Snate@binkert.org########################################################################
1815871Snate@binkert.org#
1826121Snate@binkert.org# Set up the main build environment.
1835871Snate@binkert.org#
1845871Snate@binkert.org########################################################################
1859926Sstan.czerniawski@arm.com
18612243Sgabeblack@google.commain = Environment()
1871533SN/A
1889239Sandreas.hansson@arm.commain_dict_keys = main.Dictionary().keys()
1899239Sandreas.hansson@arm.com
1909239Sandreas.hansson@arm.com# Check that we have a C/C++ compiler
1919239Sandreas.hansson@arm.comif not ('CC' in main_dict_keys and 'CXX' in main_dict_keys):
1929239Sandreas.hansson@arm.com    print "No C++ compiler installed (package g++ on Ubuntu and RedHat)"
1939239Sandreas.hansson@arm.com    Exit(1)
1949239Sandreas.hansson@arm.com
1956655Snate@binkert.org# add useful python code PYTHONPATH so it can be used by subprocesses
1966655Snate@binkert.org# as well
1976655Snate@binkert.orgmain.AppendENVPath('PYTHONPATH', extra_python_paths)
1986655Snate@binkert.org
1995871Snate@binkert.org########################################################################
2005871Snate@binkert.org#
2015863Snate@binkert.org# Mercurial Stuff.
2025871Snate@binkert.org#
2038878Ssteve.reinhardt@amd.com# If the gem5 directory is a mercurial repository, we should do some
2045871Snate@binkert.org# extra things.
2055871Snate@binkert.org#
2065871Snate@binkert.org########################################################################
2075863Snate@binkert.org
2086121Snate@binkert.orghgdir = main.root.Dir(".hg")
2095863Snate@binkert.org
21011408Sandreas.sandberg@arm.com
21111408Sandreas.sandberg@arm.comstyle_message = """
2128336Ssteve.reinhardt@amd.comYou're missing the gem5 style hook, which automatically checks your code
21311469SCurtis.Dunham@arm.comagainst the gem5 style rules on %s.
21411469SCurtis.Dunham@arm.comThis script will now install the hook in your %s.
2158336Ssteve.reinhardt@amd.comPress enter to continue, or ctrl-c to abort: """
2164678Snate@binkert.org
21711887Sandreas.sandberg@arm.commercurial_style_message = """
21811887Sandreas.sandberg@arm.comYou're missing the gem5 style hook, which automatically checks your code
21911887Sandreas.sandberg@arm.comagainst the gem5 style rules on hg commit and qrefresh commands.
22011887Sandreas.sandberg@arm.comThis script will now install the hook in your .hg/hgrc file.
22111887Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
22211887Sandreas.sandberg@arm.com
22311887Sandreas.sandberg@arm.comgit_style_message = """
22411887Sandreas.sandberg@arm.comYou're missing the gem5 style or commit message hook. These hooks help
22511887Sandreas.sandberg@arm.comto ensure that your code follows gem5's style rules on git commit.
22611887Sandreas.sandberg@arm.comThis script will now install the hook in your .git/hooks/ directory.
22711887Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
22811408Sandreas.sandberg@arm.com
22911401Sandreas.sandberg@arm.commercurial_style_upgrade_message = """
23011401Sandreas.sandberg@arm.comYour Mercurial style hooks are not up-to-date. This script will now
23111401Sandreas.sandberg@arm.comtry to automatically update them. A backup of your hgrc will be saved
23211401Sandreas.sandberg@arm.comin .hg/hgrc.old.
23311401Sandreas.sandberg@arm.comPress enter to continue, or ctrl-c to abort: """
23411401Sandreas.sandberg@arm.com
2358336Ssteve.reinhardt@amd.commercurial_style_hook = """
2368336Ssteve.reinhardt@amd.com# The following lines were automatically added by gem5/SConstruct
2378336Ssteve.reinhardt@amd.com# to provide the gem5 style-checking hooks
2384678Snate@binkert.org[extensions]
23911401Sandreas.sandberg@arm.comhgstyle = %s/util/hgstyle.py
2404678Snate@binkert.org
2414678Snate@binkert.org[hooks]
24211401Sandreas.sandberg@arm.compretxncommit.style = python:hgstyle.check_style
24311401Sandreas.sandberg@arm.compre-qrefresh.style = python:hgstyle.check_style
2448336Ssteve.reinhardt@amd.com# End of SConstruct additions
2454678Snate@binkert.org
2468336Ssteve.reinhardt@amd.com""" % (main.root.abspath)
2478336Ssteve.reinhardt@amd.com
2488336Ssteve.reinhardt@amd.commercurial_lib_not_found = """
2498336Ssteve.reinhardt@amd.comMercurial libraries cannot be found, ignoring style hook.  If
2508336Ssteve.reinhardt@amd.comyou are a gem5 developer, please fix this and run the style
2518336Ssteve.reinhardt@amd.comhook. It is important.
2525871Snate@binkert.org"""
2535871Snate@binkert.org
2548336Ssteve.reinhardt@amd.com# Check for style hook and prompt for installation if it's not there.
25511408Sandreas.sandberg@arm.com# Skip this if --ignore-style was specified, there's no interactive
25611408Sandreas.sandberg@arm.com# terminal to prompt, or no recognized revision control system can be
25711408Sandreas.sandberg@arm.com# found.
25811408Sandreas.sandberg@arm.comignore_style = GetOption('ignore_style') or not sys.stdin.isatty()
25911408Sandreas.sandberg@arm.com
26011408Sandreas.sandberg@arm.com# Try wire up Mercurial to the style hooks
26111408Sandreas.sandberg@arm.comif not ignore_style and hgdir.exists():
2628336Ssteve.reinhardt@amd.com    style_hook = True
26311401Sandreas.sandberg@arm.com    style_hooks = tuple()
26411401Sandreas.sandberg@arm.com    hgrc = hgdir.File('hgrc')
26511401Sandreas.sandberg@arm.com    hgrc_old = hgdir.File('hgrc.old')
2665871Snate@binkert.org    try:
2678336Ssteve.reinhardt@amd.com        from mercurial import ui
2688336Ssteve.reinhardt@amd.com        ui = ui.ui()
26911401Sandreas.sandberg@arm.com        ui.readconfig(hgrc.abspath)
27011401Sandreas.sandberg@arm.com        style_hooks = (ui.config('hooks', 'pretxncommit.style', None),
27111401Sandreas.sandberg@arm.com                       ui.config('hooks', 'pre-qrefresh.style', None))
27211401Sandreas.sandberg@arm.com        style_hook = all(style_hooks)
27311401Sandreas.sandberg@arm.com        style_extension = ui.config('extensions', 'style', None)
2744678Snate@binkert.org    except ImportError:
2755871Snate@binkert.org        print mercurial_lib_not_found
2764678Snate@binkert.org
27711401Sandreas.sandberg@arm.com    if "python:style.check_style" in style_hooks:
27811401Sandreas.sandberg@arm.com        # Try to upgrade the style hooks
27911401Sandreas.sandberg@arm.com        print mercurial_style_upgrade_message
28011401Sandreas.sandberg@arm.com        # continue unless user does ctrl-c/ctrl-d etc.
28111401Sandreas.sandberg@arm.com        try:
28211401Sandreas.sandberg@arm.com            raw_input()
28311401Sandreas.sandberg@arm.com        except:
28411401Sandreas.sandberg@arm.com            print "Input exception, exiting scons.\n"
28511401Sandreas.sandberg@arm.com            sys.exit(1)
28611401Sandreas.sandberg@arm.com        shutil.copyfile(hgrc.abspath, hgrc_old.abspath)
28711401Sandreas.sandberg@arm.com        re_style_hook = re.compile(r"^([^=#]+)\.style\s*=\s*([^#\s]+).*")
28811401Sandreas.sandberg@arm.com        re_style_extension = re.compile("style\s*=\s*([^#\s]+).*")
28911450Sandreas.sandberg@arm.com        old, new = open(hgrc_old.abspath, 'r'), open(hgrc.abspath, 'w')
29011450Sandreas.sandberg@arm.com        for l in old:
29111450Sandreas.sandberg@arm.com            m_hook = re_style_hook.match(l)
29211450Sandreas.sandberg@arm.com            m_ext = re_style_extension.match(l)
29311450Sandreas.sandberg@arm.com            if m_hook:
29411450Sandreas.sandberg@arm.com                hook, check = m_hook.groups()
29511450Sandreas.sandberg@arm.com                if check != "python:style.check_style":
29611450Sandreas.sandberg@arm.com                    print "Warning: %s.style is using a non-default " \
29711450Sandreas.sandberg@arm.com                        "checker: %s" % (hook, check)
29811450Sandreas.sandberg@arm.com                if hook not in ("pretxncommit", "pre-qrefresh"):
29911450Sandreas.sandberg@arm.com                    print "Warning: Updating unknown style hook: %s" % hook
30011401Sandreas.sandberg@arm.com
30111450Sandreas.sandberg@arm.com                l = "%s.style = python:hgstyle.check_style\n" % hook
30211450Sandreas.sandberg@arm.com            elif m_ext and m_ext.group(1) == style_extension:
30311450Sandreas.sandberg@arm.com                l = "hgstyle = %s/util/hgstyle.py\n" % main.root.abspath
30411401Sandreas.sandberg@arm.com
30511450Sandreas.sandberg@arm.com            new.write(l)
30611401Sandreas.sandberg@arm.com    elif not style_hook:
3078336Ssteve.reinhardt@amd.com        print mercurial_style_message,
3088336Ssteve.reinhardt@amd.com        # continue unless user does ctrl-c/ctrl-d etc.
3098336Ssteve.reinhardt@amd.com        try:
3108336Ssteve.reinhardt@amd.com            raw_input()
3118336Ssteve.reinhardt@amd.com        except:
3128336Ssteve.reinhardt@amd.com            print "Input exception, exiting scons.\n"
3138336Ssteve.reinhardt@amd.com            sys.exit(1)
3148336Ssteve.reinhardt@amd.com        hgrc_path = '%s/.hg/hgrc' % main.root.abspath
3158336Ssteve.reinhardt@amd.com        print "Adding style hook to", hgrc_path, "\n"
3168336Ssteve.reinhardt@amd.com        try:
31711401Sandreas.sandberg@arm.com            with open(hgrc_path, 'a') as f:
31811401Sandreas.sandberg@arm.com                f.write(mercurial_style_hook)
3198336Ssteve.reinhardt@amd.com        except:
3208336Ssteve.reinhardt@amd.com            print "Error updating", hgrc_path
3218336Ssteve.reinhardt@amd.com            sys.exit(1)
3225871Snate@binkert.org
32311476Sandreas.sandberg@arm.comdef install_git_style_hooks():
32411476Sandreas.sandberg@arm.com    try:
32511476Sandreas.sandberg@arm.com        gitdir = Dir(readCommand(
32611476Sandreas.sandberg@arm.com            ["git", "rev-parse", "--git-dir"]).strip("\n"))
32711476Sandreas.sandberg@arm.com    except Exception, e:
32811476Sandreas.sandberg@arm.com        print "Warning: Failed to find git repo directory: %s" % e
32911476Sandreas.sandberg@arm.com        return
33011476Sandreas.sandberg@arm.com
33111476Sandreas.sandberg@arm.com    git_hooks = gitdir.Dir("hooks")
33211887Sandreas.sandberg@arm.com    def hook_exists(hook_name):
33311887Sandreas.sandberg@arm.com        hook = git_hooks.File(hook_name)
33411887Sandreas.sandberg@arm.com        return hook.exists()
33511408Sandreas.sandberg@arm.com
33611887Sandreas.sandberg@arm.com    def hook_install(hook_name, script):
33711887Sandreas.sandberg@arm.com        hook = git_hooks.File(hook_name)
33811887Sandreas.sandberg@arm.com        if hook.exists():
33911887Sandreas.sandberg@arm.com            print "Warning: Can't install %s, hook already exists." % hook_name
34011887Sandreas.sandberg@arm.com            return
34111887Sandreas.sandberg@arm.com
34211926Sgabeblack@google.com        if hook.islink():
34311926Sgabeblack@google.com            print "Warning: Removing broken symlink for hook %s." % hook_name
34411926Sgabeblack@google.com            os.unlink(hook.get_abspath())
34511926Sgabeblack@google.com
34611887Sandreas.sandberg@arm.com        if not git_hooks.exists():
34711887Sandreas.sandberg@arm.com            mkdir(git_hooks.get_abspath())
34811944Sandreas.sandberg@arm.com            git_hooks.clear()
34911887Sandreas.sandberg@arm.com
35011927Sgabeblack@google.com        abs_symlink_hooks = git_hooks.islink() and \
35111927Sgabeblack@google.com            os.path.isabs(os.readlink(git_hooks.get_abspath()))
35211927Sgabeblack@google.com
35311927Sgabeblack@google.com        # Use a relative symlink if the hooks live in the source directory,
35411927Sgabeblack@google.com        # and the hooks directory is not a symlink to an absolute path.
35511927Sgabeblack@google.com        if hook.is_under(main.root) and not abs_symlink_hooks:
35611887Sandreas.sandberg@arm.com            script_path = os.path.relpath(
35711928Sgabeblack@google.com                os.path.realpath(script.get_abspath()),
35811928Sgabeblack@google.com                os.path.realpath(hook.Dir(".").get_abspath()))
35911887Sandreas.sandberg@arm.com        else:
36011887Sandreas.sandberg@arm.com            script_path = script.get_abspath()
36111887Sandreas.sandberg@arm.com
36211887Sandreas.sandberg@arm.com        try:
36311887Sandreas.sandberg@arm.com            os.symlink(script_path, hook.get_abspath())
36411887Sandreas.sandberg@arm.com        except:
36511887Sandreas.sandberg@arm.com            print "Error updating git %s hook" % hook_name
36611887Sandreas.sandberg@arm.com            raise
36711887Sandreas.sandberg@arm.com
36811887Sandreas.sandberg@arm.com    if hook_exists("pre-commit") and hook_exists("commit-msg"):
36911476Sandreas.sandberg@arm.com        return
37011476Sandreas.sandberg@arm.com
37111408Sandreas.sandberg@arm.com    print git_style_message,
37211408Sandreas.sandberg@arm.com    try:
37311408Sandreas.sandberg@arm.com        raw_input()
37411408Sandreas.sandberg@arm.com    except:
37511408Sandreas.sandberg@arm.com        print "Input exception, exiting scons.\n"
37611408Sandreas.sandberg@arm.com        sys.exit(1)
37711408Sandreas.sandberg@arm.com
37811887Sandreas.sandberg@arm.com    git_style_script = File("util/git-pre-commit.py")
37911887Sandreas.sandberg@arm.com    git_msg_script = File("ext/git-commit-msg")
38011476Sandreas.sandberg@arm.com
38111887Sandreas.sandberg@arm.com    hook_install("pre-commit", git_style_script)
38211887Sandreas.sandberg@arm.com    hook_install("commit-msg", git_msg_script)
38311476Sandreas.sandberg@arm.com
38411476Sandreas.sandberg@arm.com# Try to wire up git to the style hooks
38511476Sandreas.sandberg@arm.comif not ignore_style and main.root.Entry(".git").exists():
38611476Sandreas.sandberg@arm.com    install_git_style_hooks()
3876121Snate@binkert.org
388955SN/A###################################################
389955SN/A#
3902632Sstever@eecs.umich.edu# Figure out which configurations to set up based on the path(s) of
3912632Sstever@eecs.umich.edu# the target(s).
392955SN/A#
393955SN/A###################################################
394955SN/A
395955SN/A# Find default configuration & binary.
3968878Ssteve.reinhardt@amd.comDefault(environ.get('M5_DEFAULT_BINARY', 'build/ALPHA/gem5.debug'))
397955SN/A
3982632Sstever@eecs.umich.edu# helper function: find last occurrence of element in list
3992632Sstever@eecs.umich.edudef rfind(l, elt, offs = -1):
4002632Sstever@eecs.umich.edu    for i in range(len(l)+offs, 0, -1):
4012632Sstever@eecs.umich.edu        if l[i] == elt:
4022632Sstever@eecs.umich.edu            return i
4032632Sstever@eecs.umich.edu    raise ValueError, "element not found"
4042632Sstever@eecs.umich.edu
4058268Ssteve.reinhardt@amd.com# Take a list of paths (or SCons Nodes) and return a list with all
4068268Ssteve.reinhardt@amd.com# paths made absolute and ~-expanded.  Paths will be interpreted
4078268Ssteve.reinhardt@amd.com# relative to the launch directory unless a different root is provided
4088268Ssteve.reinhardt@amd.comdef makePathListAbsolute(path_list, root=GetLaunchDir()):
4098268Ssteve.reinhardt@amd.com    return [abspath(joinpath(root, expanduser(str(p))))
4108268Ssteve.reinhardt@amd.com            for p in path_list]
4118268Ssteve.reinhardt@amd.com
4122632Sstever@eecs.umich.edu# Each target must have 'build' in the interior of the path; the
4132632Sstever@eecs.umich.edu# directory below this will determine the build parameters.  For
4142632Sstever@eecs.umich.edu# example, for target 'foo/bar/build/ALPHA_SE/arch/alpha/blah.do' we
4152632Sstever@eecs.umich.edu# recognize that ALPHA_SE specifies the configuration because it
4168268Ssteve.reinhardt@amd.com# follow 'build' in the build path.
4172632Sstever@eecs.umich.edu
4188268Ssteve.reinhardt@amd.com# The funky assignment to "[:]" is needed to replace the list contents
4198268Ssteve.reinhardt@amd.com# in place rather than reassign the symbol to a new list, which
4208268Ssteve.reinhardt@amd.com# doesn't work (obviously!).
4218268Ssteve.reinhardt@amd.comBUILD_TARGETS[:] = makePathListAbsolute(BUILD_TARGETS)
4223718Sstever@eecs.umich.edu
4232634Sstever@eecs.umich.edu# Generate a list of the unique build roots and configs that the
4242634Sstever@eecs.umich.edu# collected targets reference.
4255863Snate@binkert.orgvariant_paths = []
4262638Sstever@eecs.umich.edubuild_root = None
4278268Ssteve.reinhardt@amd.comfor t in BUILD_TARGETS:
4282632Sstever@eecs.umich.edu    path_dirs = t.split('/')
4292632Sstever@eecs.umich.edu    try:
4302632Sstever@eecs.umich.edu        build_top = rfind(path_dirs, 'build', -2)
4312632Sstever@eecs.umich.edu    except:
4322632Sstever@eecs.umich.edu        print "Error: no non-leaf 'build' dir found on target path", t
4331858SN/A        Exit(1)
4343716Sstever@eecs.umich.edu    this_build_root = joinpath('/',*path_dirs[:build_top+1])
4352638Sstever@eecs.umich.edu    if not build_root:
4362638Sstever@eecs.umich.edu        build_root = this_build_root
4372638Sstever@eecs.umich.edu    else:
4382638Sstever@eecs.umich.edu        if this_build_root != build_root:
4392638Sstever@eecs.umich.edu            print "Error: build targets not under same build root\n"\
4402638Sstever@eecs.umich.edu                  "  %s\n  %s" % (build_root, this_build_root)
4412638Sstever@eecs.umich.edu            Exit(1)
4425863Snate@binkert.org    variant_path = joinpath('/',*path_dirs[:build_top+2])
4435863Snate@binkert.org    if variant_path not in variant_paths:
4445863Snate@binkert.org        variant_paths.append(variant_path)
445955SN/A
4465341Sstever@gmail.com# Make sure build_root exists (might not if this is the first build there)
4475341Sstever@gmail.comif not isdir(build_root):
4485863Snate@binkert.org    mkdir(build_root)
4497756SAli.Saidi@ARM.commain['BUILDROOT'] = build_root
4505341Sstever@gmail.com
4516121Snate@binkert.orgExport('main')
4524494Ssaidi@eecs.umich.edu
4536121Snate@binkert.orgmain.SConsignFile(joinpath(build_root, "sconsign"))
4541105SN/A
4552667Sstever@eecs.umich.edu# Default duplicate option is to use hard links, but this messes up
4562667Sstever@eecs.umich.edu# when you use emacs to edit a file in the target dir, as emacs moves
4572667Sstever@eecs.umich.edu# file to file~ then copies to file, breaking the link.  Symbolic
4582667Sstever@eecs.umich.edu# (soft) links work better.
4596121Snate@binkert.orgmain.SetOption('duplicate', 'soft-copy')
4602667Sstever@eecs.umich.edu
4615341Sstever@gmail.com#
4625863Snate@binkert.org# Set up global sticky variables... these are common to an entire build
4635341Sstever@gmail.com# tree (not specific to a particular build like ALPHA_SE)
4645341Sstever@gmail.com#
4655341Sstever@gmail.com
4668120Sgblack@eecs.umich.eduglobal_vars_file = joinpath(build_root, 'variables.global')
4675341Sstever@gmail.com
4688120Sgblack@eecs.umich.eduglobal_vars = Variables(global_vars_file, args=ARGUMENTS)
4695341Sstever@gmail.com
4708120Sgblack@eecs.umich.eduglobal_vars.AddVariables(
4716121Snate@binkert.org    ('CC', 'C compiler', environ.get('CC', main['CC'])),
4726121Snate@binkert.org    ('CXX', 'C++ compiler', environ.get('CXX', main['CXX'])),
4739396Sandreas.hansson@arm.com    ('PROTOC', 'protoc tool', environ.get('PROTOC', 'protoc')),
4745397Ssaidi@eecs.umich.edu    ('BATCH', 'Use batch pool for build and tests', False),
4755397Ssaidi@eecs.umich.edu    ('BATCH_CMD', 'Batch pool submission command name', 'qdo'),
4767727SAli.Saidi@ARM.com    ('M5_BUILD_CACHE', 'Cache built objects in this directory', False),
4778268Ssteve.reinhardt@amd.com    ('EXTRAS', 'Add extra directories to the compilation', '')
4786168Snate@binkert.org    )
4795341Sstever@gmail.com
4808120Sgblack@eecs.umich.edu# Update main environment with values from ARGUMENTS & global_vars_file
4818120Sgblack@eecs.umich.eduglobal_vars.Update(main)
4828120Sgblack@eecs.umich.eduhelp_texts["global_vars"] += global_vars.GenerateHelpText(main)
4836814Sgblack@eecs.umich.edu
4845863Snate@binkert.org# Save sticky variable settings back to current variables file
4858120Sgblack@eecs.umich.eduglobal_vars.Save(global_vars_file, main)
4865341Sstever@gmail.com
4875863Snate@binkert.org# Parse EXTRAS variable to build list of all directories where we're
4888268Ssteve.reinhardt@amd.com# look for sources etc.  This list is exported as extras_dir_list.
4896121Snate@binkert.orgbase_dir = main.srcdir.abspath
4906121Snate@binkert.orgif main['EXTRAS']:
4918268Ssteve.reinhardt@amd.com    extras_dir_list = makePathListAbsolute(main['EXTRAS'].split(':'))
4925742Snate@binkert.orgelse:
4935742Snate@binkert.org    extras_dir_list = []
4945341Sstever@gmail.com
4955742Snate@binkert.orgExport('base_dir')
4965742Snate@binkert.orgExport('extras_dir_list')
4975341Sstever@gmail.com
4986017Snate@binkert.org# the ext directory should be on the #includes path
4996121Snate@binkert.orgmain.Append(CPPPATH=[Dir('ext')])
5006017Snate@binkert.org
50112158Sandreas.sandberg@arm.com# Add shared top-level headers
50212158Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('include'))
50312158Sandreas.sandberg@arm.com
5047816Ssteve.reinhardt@amd.comdef strip_build_path(path, env):
5057756SAli.Saidi@ARM.com    path = str(path)
5067756SAli.Saidi@ARM.com    variant_base = env['BUILDROOT'] + os.path.sep
5077756SAli.Saidi@ARM.com    if path.startswith(variant_base):
5087756SAli.Saidi@ARM.com        path = path[len(variant_base):]
5097756SAli.Saidi@ARM.com    elif path.startswith('build/'):
5107756SAli.Saidi@ARM.com        path = path[6:]
5117756SAli.Saidi@ARM.com    return path
5127756SAli.Saidi@ARM.com
5137816Ssteve.reinhardt@amd.com# Generate a string of the form:
5147816Ssteve.reinhardt@amd.com#   common/path/prefix/src1, src2 -> tgt1, tgt2
5157816Ssteve.reinhardt@amd.com# to print while building.
5167816Ssteve.reinhardt@amd.comclass Transform(object):
5177816Ssteve.reinhardt@amd.com    # all specific color settings should be here and nowhere else
5187816Ssteve.reinhardt@amd.com    tool_color = termcap.Normal
5197816Ssteve.reinhardt@amd.com    pfx_color = termcap.Yellow
5207816Ssteve.reinhardt@amd.com    srcs_color = termcap.Yellow + termcap.Bold
5217816Ssteve.reinhardt@amd.com    arrow_color = termcap.Blue + termcap.Bold
5227816Ssteve.reinhardt@amd.com    tgts_color = termcap.Yellow + termcap.Bold
5237756SAli.Saidi@ARM.com
5247816Ssteve.reinhardt@amd.com    def __init__(self, tool, max_sources=99):
5257816Ssteve.reinhardt@amd.com        self.format = self.tool_color + (" [%8s] " % tool) \
5267816Ssteve.reinhardt@amd.com                      + self.pfx_color + "%s" \
5277816Ssteve.reinhardt@amd.com                      + self.srcs_color + "%s" \
5287816Ssteve.reinhardt@amd.com                      + self.arrow_color + " -> " \
5297816Ssteve.reinhardt@amd.com                      + self.tgts_color + "%s" \
5307816Ssteve.reinhardt@amd.com                      + termcap.Normal
5317816Ssteve.reinhardt@amd.com        self.max_sources = max_sources
5327816Ssteve.reinhardt@amd.com
5337816Ssteve.reinhardt@amd.com    def __call__(self, target, source, env, for_signature=None):
5347816Ssteve.reinhardt@amd.com        # truncate source list according to max_sources param
5357816Ssteve.reinhardt@amd.com        source = source[0:self.max_sources]
5367816Ssteve.reinhardt@amd.com        def strip(f):
5377816Ssteve.reinhardt@amd.com            return strip_build_path(str(f), env)
5387816Ssteve.reinhardt@amd.com        if len(source) > 0:
5397816Ssteve.reinhardt@amd.com            srcs = map(strip, source)
5407816Ssteve.reinhardt@amd.com        else:
5417816Ssteve.reinhardt@amd.com            srcs = ['']
5427816Ssteve.reinhardt@amd.com        tgts = map(strip, target)
5437816Ssteve.reinhardt@amd.com        # surprisingly, os.path.commonprefix is a dumb char-by-char string
5447816Ssteve.reinhardt@amd.com        # operation that has nothing to do with paths.
5457816Ssteve.reinhardt@amd.com        com_pfx = os.path.commonprefix(srcs + tgts)
5467816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
5477816Ssteve.reinhardt@amd.com        if com_pfx:
5487816Ssteve.reinhardt@amd.com            # do some cleanup and sanity checking on common prefix
5497816Ssteve.reinhardt@amd.com            if com_pfx[-1] == ".":
5507816Ssteve.reinhardt@amd.com                # prefix matches all but file extension: ok
5517816Ssteve.reinhardt@amd.com                # back up one to change 'foo.cc -> o' to 'foo.cc -> .o'
5527816Ssteve.reinhardt@amd.com                com_pfx = com_pfx[0:-1]
5537816Ssteve.reinhardt@amd.com            elif com_pfx[-1] == "/":
5547816Ssteve.reinhardt@amd.com                # common prefix is directory path: OK
5557816Ssteve.reinhardt@amd.com                pass
5567816Ssteve.reinhardt@amd.com            else:
5577816Ssteve.reinhardt@amd.com                src0_len = len(srcs[0])
5587816Ssteve.reinhardt@amd.com                tgt0_len = len(tgts[0])
5597816Ssteve.reinhardt@amd.com                if src0_len == com_pfx_len:
5607816Ssteve.reinhardt@amd.com                    # source is a substring of target, OK
5617816Ssteve.reinhardt@amd.com                    pass
5627816Ssteve.reinhardt@amd.com                elif tgt0_len == com_pfx_len:
5637816Ssteve.reinhardt@amd.com                    # target is a substring of source, need to back up to
5647816Ssteve.reinhardt@amd.com                    # avoid empty string on RHS of arrow
5657816Ssteve.reinhardt@amd.com                    sep_idx = com_pfx.rfind(".")
5667816Ssteve.reinhardt@amd.com                    if sep_idx != -1:
5677816Ssteve.reinhardt@amd.com                        com_pfx = com_pfx[0:sep_idx]
5687816Ssteve.reinhardt@amd.com                    else:
5697816Ssteve.reinhardt@amd.com                        com_pfx = ''
5707816Ssteve.reinhardt@amd.com                elif src0_len > com_pfx_len and srcs[0][com_pfx_len] == ".":
5717816Ssteve.reinhardt@amd.com                    # still splitting at file extension: ok
5727816Ssteve.reinhardt@amd.com                    pass
5737816Ssteve.reinhardt@amd.com                else:
5747816Ssteve.reinhardt@amd.com                    # probably a fluke; ignore it
5757816Ssteve.reinhardt@amd.com                    com_pfx = ''
5767816Ssteve.reinhardt@amd.com        # recalculate length in case com_pfx was modified
5777816Ssteve.reinhardt@amd.com        com_pfx_len = len(com_pfx)
5787816Ssteve.reinhardt@amd.com        def fmt(files):
5797816Ssteve.reinhardt@amd.com            f = map(lambda s: s[com_pfx_len:], files)
5807816Ssteve.reinhardt@amd.com            return ', '.join(f)
5817816Ssteve.reinhardt@amd.com        return self.format % (com_pfx, fmt(srcs), fmt(tgts))
5827816Ssteve.reinhardt@amd.com
5837816Ssteve.reinhardt@amd.comExport('Transform')
5847816Ssteve.reinhardt@amd.com
5858947Sandreas.hansson@arm.com# enable the regression script to use the termcap
5868947Sandreas.hansson@arm.commain['TERMCAP'] = termcap
5877756SAli.Saidi@ARM.com
5888120Sgblack@eecs.umich.eduif GetOption('verbose'):
5897756SAli.Saidi@ARM.com    def MakeAction(action, string, *args, **kwargs):
5907756SAli.Saidi@ARM.com        return Action(action, *args, **kwargs)
5917756SAli.Saidi@ARM.comelse:
5927756SAli.Saidi@ARM.com    MakeAction = Action
5937816Ssteve.reinhardt@amd.com    main['CCCOMSTR']        = Transform("CC")
5947816Ssteve.reinhardt@amd.com    main['CXXCOMSTR']       = Transform("CXX")
5957816Ssteve.reinhardt@amd.com    main['ASCOMSTR']        = Transform("AS")
5967816Ssteve.reinhardt@amd.com    main['ARCOMSTR']        = Transform("AR", 0)
5977816Ssteve.reinhardt@amd.com    main['LINKCOMSTR']      = Transform("LINK", 0)
59811979Sgabeblack@google.com    main['SHLINKCOMSTR']    = Transform("SHLINK", 0)
5997816Ssteve.reinhardt@amd.com    main['RANLIBCOMSTR']    = Transform("RANLIB", 0)
6007816Ssteve.reinhardt@amd.com    main['M4COMSTR']        = Transform("M4")
6017816Ssteve.reinhardt@amd.com    main['SHCCCOMSTR']      = Transform("SHCC")
6027816Ssteve.reinhardt@amd.com    main['SHCXXCOMSTR']     = Transform("SHCXX")
6037756SAli.Saidi@ARM.comExport('MakeAction')
6047756SAli.Saidi@ARM.com
6059227Sandreas.hansson@arm.com# Initialize the Link-Time Optimization (LTO) flags
6069227Sandreas.hansson@arm.commain['LTO_CCFLAGS'] = []
6079227Sandreas.hansson@arm.commain['LTO_LDFLAGS'] = []
6089227Sandreas.hansson@arm.com
6099590Sandreas@sandberg.pp.se# According to the readme, tcmalloc works best if the compiler doesn't
6109590Sandreas@sandberg.pp.se# assume that we're using the builtin malloc and friends. These flags
6119590Sandreas@sandberg.pp.se# are compiler-specific, so we need to set them after we detect which
6129590Sandreas@sandberg.pp.se# compiler we're using.
6139590Sandreas@sandberg.pp.semain['TCMALLOC_CCFLAGS'] = []
6149590Sandreas@sandberg.pp.se
6156654Snate@binkert.orgCXX_version = readCommand([main['CXX'],'--version'], exception=False)
6166654Snate@binkert.orgCXX_V = readCommand([main['CXX'],'-V'], exception=False)
6175871Snate@binkert.org
6186121Snate@binkert.orgmain['GCC'] = CXX_version and CXX_version.find('g++') >= 0
6198946Sandreas.hansson@arm.commain['CLANG'] = CXX_version and CXX_version.find('clang') >= 0
6209419Sandreas.hansson@arm.comif main['GCC'] + main['CLANG'] > 1:
6213940Ssaidi@eecs.umich.edu    print 'Error: How can we have two at the same time?'
6223918Ssaidi@eecs.umich.edu    Exit(1)
6233918Ssaidi@eecs.umich.edu
6241858SN/A# Set up default C++ compiler flags
6259556Sandreas.hansson@arm.comif main['GCC'] or main['CLANG']:
6269556Sandreas.hansson@arm.com    # As gcc and clang share many flags, do the common parts here
6279556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-pipe'])
6289556Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-fno-strict-aliasing'])
62911294Sandreas.hansson@arm.com    # Enable -Wall and -Wextra and then disable the few warnings that
63011294Sandreas.hansson@arm.com    # we consistently violate
63111294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wall', '-Wundef', '-Wextra',
63211294Sandreas.hansson@arm.com                         '-Wno-sign-compare', '-Wno-unused-parameter'])
63310878Sandreas.hansson@arm.com    # We always compile using C++11
63410878Sandreas.hansson@arm.com    main.Append(CXXFLAGS=['-std=c++11'])
63511811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
63611811Sbaz21@cam.ac.uk        main.Append(CCFLAGS=['-I/usr/local/include'])
63711811Sbaz21@cam.ac.uk        main.Append(CXXFLAGS=['-I/usr/local/include'])
63811982Sgabeblack@google.com
63911982Sgabeblack@google.com    main['FILTER_PSHLINKFLAGS'] = lambda x: str(x).replace(' -shared', '')
64011982Sgabeblack@google.com    main['PSHLINKFLAGS'] = main.subst('${FILTER_PSHLINKFLAGS(SHLINKFLAGS)}')
64111982Sgabeblack@google.com    main['PLINKFLAGS'] = main.subst('${LINKFLAGS}')
64211992Sgabeblack@google.com    shared_partial_flags = ['-r', '-nostdlib']
64311982Sgabeblack@google.com    main.Append(PSHLINKFLAGS=shared_partial_flags)
64411982Sgabeblack@google.com    main.Append(PLINKFLAGS=shared_partial_flags)
6459556Sandreas.hansson@arm.comelse:
6469556Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
6479556Sandreas.hansson@arm.com    print "Don't know what compiler options to use for your compiler."
6489556Sandreas.hansson@arm.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
6499556Sandreas.hansson@arm.com    print termcap.Yellow + '       version:' + termcap.Normal,
6509556Sandreas.hansson@arm.com    if not CXX_version:
6519556Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
6529556Sandreas.hansson@arm.com               termcap.Normal
6539556Sandreas.hansson@arm.com    else:
6549556Sandreas.hansson@arm.com        print CXX_version.replace('\n', '<nl>')
6559556Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
6569556Sandreas.hansson@arm.com    print "       or clang, there appears to be something wrong with your"
6579556Sandreas.hansson@arm.com    print "       environment."
6589556Sandreas.hansson@arm.com    print "       "
6599556Sandreas.hansson@arm.com    print "       If you are trying to use a compiler other than those listed"
6609556Sandreas.hansson@arm.com    print "       above you will need to ease fix SConstruct and "
6619556Sandreas.hansson@arm.com    print "       src/SConscript to support that compiler."
6629556Sandreas.hansson@arm.com    Exit(1)
6639556Sandreas.hansson@arm.com
6646121Snate@binkert.orgif main['GCC']:
66511500Sandreas.hansson@arm.com    # Check for a supported version of gcc. >= 4.8 is chosen for its
66610238Sandreas.hansson@arm.com    # level of c++11 support. See
66710878Sandreas.hansson@arm.com    # http://gcc.gnu.org/projects/cxx0x.html for details.
6689420Sandreas.hansson@arm.com    gcc_version = readCommand([main['CXX'], '-dumpversion'], exception=False)
66911500Sandreas.hansson@arm.com    if compareVersions(gcc_version, "4.8") < 0:
67011500Sandreas.hansson@arm.com        print 'Error: gcc version 4.8 or newer required.'
6719420Sandreas.hansson@arm.com        print '       Installed version:', gcc_version
6729420Sandreas.hansson@arm.com        Exit(1)
6739420Sandreas.hansson@arm.com
6749420Sandreas.hansson@arm.com    main['GCC_VERSION'] = gcc_version
6759420Sandreas.hansson@arm.com
67612063Sgabeblack@google.com    if compareVersions(gcc_version, '4.9') >= 0:
67712063Sgabeblack@google.com        # Incremental linking with LTO is currently broken in gcc versions
67812063Sgabeblack@google.com        # 4.9 and above. A version where everything works completely hasn't
67912063Sgabeblack@google.com        # yet been identified.
68012063Sgabeblack@google.com        #
68112063Sgabeblack@google.com        # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=67548
68212063Sgabeblack@google.com        main['BROKEN_INCREMENTAL_LTO'] = True
68312063Sgabeblack@google.com    if compareVersions(gcc_version, '6.0') >= 0:
68412063Sgabeblack@google.com        # gcc versions 6.0 and greater accept an -flinker-output flag which
68512063Sgabeblack@google.com        # selects what type of output the linker should generate. This is
68612063Sgabeblack@google.com        # necessary for incremental lto to work, but is also broken in
68712063Sgabeblack@google.com        # current versions of gcc. It may not be necessary in future
68812063Sgabeblack@google.com        # versions. We add it here since it might be, and as a reminder that
68912063Sgabeblack@google.com        # it exists. It's excluded if lto is being forced.
69012063Sgabeblack@google.com        #
69112063Sgabeblack@google.com        # https://gcc.gnu.org/gcc-6/changes.html
69212063Sgabeblack@google.com        # https://gcc.gnu.org/ml/gcc-patches/2015-11/msg03161.html
69312063Sgabeblack@google.com        # https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69866
69412063Sgabeblack@google.com        if not GetOption('force_lto'):
69512063Sgabeblack@google.com            main.Append(PSHLINKFLAGS='-flinker-output=rel')
69612063Sgabeblack@google.com            main.Append(PLINKFLAGS='-flinker-output=rel')
69712063Sgabeblack@google.com
69810264Sandreas.hansson@arm.com    # gcc from version 4.8 and above generates "rep; ret" instructions
69910264Sandreas.hansson@arm.com    # to avoid performance penalties on certain AMD chips. Older
70010264Sandreas.hansson@arm.com    # assemblers detect this as an error, "Error: expecting string
70110264Sandreas.hansson@arm.com    # instruction after `rep'"
70211925Sgabeblack@google.com    as_version_raw = readCommand([main['AS'], '-v', '/dev/null',
70311925Sgabeblack@google.com                                  '-o', '/dev/null'],
70411500Sandreas.hansson@arm.com                                 exception=False).split()
70510264Sandreas.hansson@arm.com
70611500Sandreas.hansson@arm.com    # version strings may contain extra distro-specific
70711500Sandreas.hansson@arm.com    # qualifiers, so play it safe and keep only what comes before
70811500Sandreas.hansson@arm.com    # the first hyphen
70911500Sandreas.hansson@arm.com    as_version = as_version_raw[-1].split('-')[0] if as_version_raw else None
71010866Sandreas.hansson@arm.com
71111500Sandreas.hansson@arm.com    if not as_version or compareVersions(as_version, "2.23") < 0:
71211500Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
71311500Sandreas.hansson@arm.com            'Warning: This combination of gcc and binutils have' + \
71411500Sandreas.hansson@arm.com            ' known incompatibilities.\n' + \
71511500Sandreas.hansson@arm.com            '         If you encounter build problems, please update ' + \
71611500Sandreas.hansson@arm.com            'binutils to 2.23.' + \
71711500Sandreas.hansson@arm.com            termcap.Normal
71810264Sandreas.hansson@arm.com
71910457Sandreas.hansson@arm.com    # Make sure we warn if the user has requested to compile with the
72010457Sandreas.hansson@arm.com    # Undefined Benahvior Sanitizer and this version of gcc does not
72110457Sandreas.hansson@arm.com    # support it.
72210457Sandreas.hansson@arm.com    if GetOption('with_ubsan') and \
72310457Sandreas.hansson@arm.com            compareVersions(gcc_version, '4.9') < 0:
72410457Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
72510457Sandreas.hansson@arm.com            'Warning: UBSan is only supported using gcc 4.9 and later.' + \
72610457Sandreas.hansson@arm.com            termcap.Normal
72710457Sandreas.hansson@arm.com
72812063Sgabeblack@google.com    disable_lto = GetOption('no_lto')
72912063Sgabeblack@google.com    if not disable_lto and main.get('BROKEN_INCREMENTAL_LTO', False) and \
73012063Sgabeblack@google.com            not GetOption('force_lto'):
73112063Sgabeblack@google.com        print termcap.Yellow + termcap.Bold + \
73212063Sgabeblack@google.com            'Warning: Your compiler doesn\'t support incremental linking' + \
73312063Sgabeblack@google.com            ' and lto at the same time, so lto is being disabled. To force' + \
73412063Sgabeblack@google.com            ' lto on anyway, use the --force-lto option. That will disable' + \
73512063Sgabeblack@google.com            ' partial linking.' + \
73612063Sgabeblack@google.com            termcap.Normal
73712063Sgabeblack@google.com        disable_lto = True
73812063Sgabeblack@google.com
73910238Sandreas.hansson@arm.com    # Add the appropriate Link-Time Optimization (LTO) flags
74010238Sandreas.hansson@arm.com    # unless LTO is explicitly turned off. Note that these flags
74110238Sandreas.hansson@arm.com    # are only used by the fast target.
74212063Sgabeblack@google.com    if not disable_lto:
74310238Sandreas.hansson@arm.com        # Pass the LTO flag when compiling to produce GIMPLE
74410238Sandreas.hansson@arm.com        # output, we merely create the flags here and only append
74510416Sandreas.hansson@arm.com        # them later
74610238Sandreas.hansson@arm.com        main['LTO_CCFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
7479227Sandreas.hansson@arm.com
74810238Sandreas.hansson@arm.com        # Use the same amount of jobs for LTO as we are running
74910416Sandreas.hansson@arm.com        # scons with
75010416Sandreas.hansson@arm.com        main['LTO_LDFLAGS'] = ['-flto=%d' % GetOption('num_jobs')]
7519227Sandreas.hansson@arm.com
7529590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin-malloc', '-fno-builtin-calloc',
7539590Sandreas@sandberg.pp.se                                  '-fno-builtin-realloc', '-fno-builtin-free'])
7549590Sandreas@sandberg.pp.se
75511497SMatteo.Andreozzi@arm.com    # add option to check for undeclared overrides
75611497SMatteo.Andreozzi@arm.com    if compareVersions(gcc_version, "5.0") > 0:
75711497SMatteo.Andreozzi@arm.com        main.Append(CCFLAGS=['-Wno-error=suggest-override'])
75811497SMatteo.Andreozzi@arm.com
7598737Skoansin.tan@gmail.comelif main['CLANG']:
76010878Sandreas.hansson@arm.com    # Check for a supported version of clang, >= 3.1 is needed to
76111500Sandreas.hansson@arm.com    # support similar features as gcc 4.8. See
7629420Sandreas.hansson@arm.com    # http://clang.llvm.org/cxx_status.html for details
7638737Skoansin.tan@gmail.com    clang_version_re = re.compile(".* version (\d+\.\d+)")
76410106SMitch.Hayenga@arm.com    clang_version_match = clang_version_re.search(CXX_version)
7658737Skoansin.tan@gmail.com    if (clang_version_match):
7668737Skoansin.tan@gmail.com        clang_version = clang_version_match.groups()[0]
76710878Sandreas.hansson@arm.com        if compareVersions(clang_version, "3.1") < 0:
76810878Sandreas.hansson@arm.com            print 'Error: clang version 3.1 or newer required.'
7698737Skoansin.tan@gmail.com            print '       Installed version:', clang_version
7708737Skoansin.tan@gmail.com            Exit(1)
7718737Skoansin.tan@gmail.com    else:
7728737Skoansin.tan@gmail.com        print 'Error: Unable to determine clang version.'
7738737Skoansin.tan@gmail.com        Exit(1)
7748737Skoansin.tan@gmail.com
77511294Sandreas.hansson@arm.com    # clang has a few additional warnings that we disable, extraneous
7769556Sandreas.hansson@arm.com    # parantheses are allowed due to Ruby's printing of the AST,
7779556Sandreas.hansson@arm.com    # finally self assignments are allowed as the generated CPU code
7789556Sandreas.hansson@arm.com    # is relying on this
77911294Sandreas.hansson@arm.com    main.Append(CCFLAGS=['-Wno-parentheses',
78010278SAndreas.Sandberg@ARM.com                         '-Wno-self-assign',
78110278SAndreas.Sandberg@ARM.com                         # Some versions of libstdc++ (4.8?) seem to
78210278SAndreas.Sandberg@ARM.com                         # use struct hash and class hash
78310278SAndreas.Sandberg@ARM.com                         # interchangeably.
78410278SAndreas.Sandberg@ARM.com                         '-Wno-mismatched-tags',
78510278SAndreas.Sandberg@ARM.com                         ])
7869556Sandreas.hansson@arm.com
7879590Sandreas@sandberg.pp.se    main.Append(TCMALLOC_CCFLAGS=['-fno-builtin'])
7889590Sandreas@sandberg.pp.se
7899420Sandreas.hansson@arm.com    # On Mac OS X/Darwin we need to also use libc++ (part of XCode) as
7909846Sandreas.hansson@arm.com    # opposed to libstdc++, as the later is dated.
7919846Sandreas.hansson@arm.com    if sys.platform == "darwin":
7929846Sandreas.hansson@arm.com        main.Append(CXXFLAGS=['-stdlib=libc++'])
7939846Sandreas.hansson@arm.com        main.Append(LIBS=['c++'])
7948946Sandreas.hansson@arm.com
79511811Sbaz21@cam.ac.uk    # On FreeBSD we need libthr.
79611811Sbaz21@cam.ac.uk    if sys.platform.startswith('freebsd'):
79711811Sbaz21@cam.ac.uk        main.Append(LIBS=['thr'])
79811811Sbaz21@cam.ac.uk
7993918Ssaidi@eecs.umich.eduelse:
8009068SAli.Saidi@ARM.com    print termcap.Yellow + termcap.Bold + 'Error' + termcap.Normal,
8019068SAli.Saidi@ARM.com    print "Don't know what compiler options to use for your compiler."
8029068SAli.Saidi@ARM.com    print termcap.Yellow + '       compiler:' + termcap.Normal, main['CXX']
8039068SAli.Saidi@ARM.com    print termcap.Yellow + '       version:' + termcap.Normal,
8049068SAli.Saidi@ARM.com    if not CXX_version:
8059068SAli.Saidi@ARM.com        print termcap.Yellow + termcap.Bold + "COMMAND NOT FOUND!" +\
8069068SAli.Saidi@ARM.com               termcap.Normal
8079068SAli.Saidi@ARM.com    else:
8089068SAli.Saidi@ARM.com        print CXX_version.replace('\n', '<nl>')
8099419Sandreas.hansson@arm.com    print "       If you're trying to use a compiler other than GCC"
8109068SAli.Saidi@ARM.com    print "       or clang, there appears to be something wrong with your"
8119068SAli.Saidi@ARM.com    print "       environment."
8129068SAli.Saidi@ARM.com    print "       "
8139068SAli.Saidi@ARM.com    print "       If you are trying to use a compiler other than those listed"
8149068SAli.Saidi@ARM.com    print "       above you will need to ease fix SConstruct and "
8159068SAli.Saidi@ARM.com    print "       src/SConscript to support that compiler."
8163918Ssaidi@eecs.umich.edu    Exit(1)
8173918Ssaidi@eecs.umich.edu
8186157Snate@binkert.org# Set up common yacc/bison flags (needed for Ruby)
8196157Snate@binkert.orgmain['YACCFLAGS'] = '-d'
8206157Snate@binkert.orgmain['YACCHXXFILESUFFIX'] = '.hh'
8216157Snate@binkert.org
8225397Ssaidi@eecs.umich.edu# Do this after we save setting back, or else we'll tack on an
8235397Ssaidi@eecs.umich.edu# extra 'qdo' every time we run scons.
8246121Snate@binkert.orgif main['BATCH']:
8256121Snate@binkert.org    main['CC']     = main['BATCH_CMD'] + ' ' + main['CC']
8266121Snate@binkert.org    main['CXX']    = main['BATCH_CMD'] + ' ' + main['CXX']
8276121Snate@binkert.org    main['AS']     = main['BATCH_CMD'] + ' ' + main['AS']
8286121Snate@binkert.org    main['AR']     = main['BATCH_CMD'] + ' ' + main['AR']
8296121Snate@binkert.org    main['RANLIB'] = main['BATCH_CMD'] + ' ' + main['RANLIB']
8305397Ssaidi@eecs.umich.edu
8311851SN/Aif sys.platform == 'cygwin':
8321851SN/A    # cygwin has some header file issues...
8337739Sgblack@eecs.umich.edu    main.Append(CCFLAGS=["-Wno-uninitialized"])
834955SN/A
8359396Sandreas.hansson@arm.com# Check for the protobuf compiler
8369396Sandreas.hansson@arm.comprotoc_version = readCommand([main['PROTOC'], '--version'],
8379396Sandreas.hansson@arm.com                             exception='').split()
8389396Sandreas.hansson@arm.com
8399396Sandreas.hansson@arm.com# First two words should be "libprotoc x.y.z"
8409396Sandreas.hansson@arm.comif len(protoc_version) < 2 or protoc_version[0] != 'libprotoc':
8419396Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
8429396Sandreas.hansson@arm.com        'Warning: Protocol buffer compiler (protoc) not found.\n' + \
8439396Sandreas.hansson@arm.com        '         Please install protobuf-compiler for tracing support.' + \
8449396Sandreas.hansson@arm.com        termcap.Normal
8459396Sandreas.hansson@arm.com    main['PROTOC'] = False
8469396Sandreas.hansson@arm.comelse:
8479396Sandreas.hansson@arm.com    # Based on the availability of the compress stream wrappers,
8489396Sandreas.hansson@arm.com    # require 2.1.0
8499396Sandreas.hansson@arm.com    min_protoc_version = '2.1.0'
8509396Sandreas.hansson@arm.com    if compareVersions(protoc_version[1], min_protoc_version) < 0:
8519477Sandreas.hansson@arm.com        print termcap.Yellow + termcap.Bold + \
8529477Sandreas.hansson@arm.com            'Warning: protoc version', min_protoc_version, \
8539477Sandreas.hansson@arm.com            'or newer required.\n' + \
8549477Sandreas.hansson@arm.com            '         Installed version:', protoc_version[1], \
8559477Sandreas.hansson@arm.com            termcap.Normal
8569477Sandreas.hansson@arm.com        main['PROTOC'] = False
8579477Sandreas.hansson@arm.com    else:
8589477Sandreas.hansson@arm.com        # Attempt to determine the appropriate include path and
8599477Sandreas.hansson@arm.com        # library path using pkg-config, that means we also need to
8609477Sandreas.hansson@arm.com        # check for pkg-config. Note that it is possible to use
8619477Sandreas.hansson@arm.com        # protobuf without the involvement of pkg-config. Later on we
8629477Sandreas.hansson@arm.com        # check go a library config check and at that point the test
8639477Sandreas.hansson@arm.com        # will fail if libprotobuf cannot be found.
8649477Sandreas.hansson@arm.com        if readCommand(['pkg-config', '--version'], exception=''):
8659477Sandreas.hansson@arm.com            try:
8669477Sandreas.hansson@arm.com                # Attempt to establish what linking flags to add for protobuf
8679477Sandreas.hansson@arm.com                # using pkg-config
8689477Sandreas.hansson@arm.com                main.ParseConfig('pkg-config --cflags --libs-only-L protobuf')
8699477Sandreas.hansson@arm.com            except:
8709477Sandreas.hansson@arm.com                print termcap.Yellow + termcap.Bold + \
8719477Sandreas.hansson@arm.com                    'Warning: pkg-config could not get protobuf flags.' + \
8729477Sandreas.hansson@arm.com                    termcap.Normal
8739396Sandreas.hansson@arm.com
8742667Sstever@eecs.umich.edu
87510710Sandreas.hansson@arm.com# Check for 'timeout' from GNU coreutils. If present, regressions will
87610710Sandreas.hansson@arm.com# be run with a time limit. We require version 8.13 since we rely on
87710710Sandreas.hansson@arm.com# support for the '--foreground' option.
87811811Sbaz21@cam.ac.ukif sys.platform.startswith('freebsd'):
87911811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['gtimeout', '--version'],
88011811Sbaz21@cam.ac.uk                                exception='').splitlines()
88111811Sbaz21@cam.ac.ukelse:
88211811Sbaz21@cam.ac.uk    timeout_lines = readCommand(['timeout', '--version'],
88311811Sbaz21@cam.ac.uk                                exception='').splitlines()
88410710Sandreas.hansson@arm.com# Get the first line and tokenize it
88510710Sandreas.hansson@arm.comtimeout_version = timeout_lines[0].split() if timeout_lines else []
88610710Sandreas.hansson@arm.commain['TIMEOUT'] =  timeout_version and \
88710710Sandreas.hansson@arm.com    compareVersions(timeout_version[-1], '8.13') >= 0
88810384SCurtis.Dunham@arm.com
8899986Sandreas@sandberg.pp.se# Add a custom Check function to test for structure members.
8909986Sandreas@sandberg.pp.sedef CheckMember(context, include, decl, member, include_quotes="<>"):
8919986Sandreas@sandberg.pp.se    context.Message("Checking for member %s in %s..." %
8929986Sandreas@sandberg.pp.se                    (member, decl))
8939986Sandreas@sandberg.pp.se    text = """
8949986Sandreas@sandberg.pp.se#include %(header)s
8959986Sandreas@sandberg.pp.seint main(){
8969986Sandreas@sandberg.pp.se  %(decl)s test;
8979986Sandreas@sandberg.pp.se  (void)test.%(member)s;
8989986Sandreas@sandberg.pp.se  return 0;
8999986Sandreas@sandberg.pp.se};
9009986Sandreas@sandberg.pp.se""" % { "header" : include_quotes[0] + include + include_quotes[1],
9019986Sandreas@sandberg.pp.se        "decl" : decl,
9029986Sandreas@sandberg.pp.se        "member" : member,
9039986Sandreas@sandberg.pp.se        }
9049986Sandreas@sandberg.pp.se
9059986Sandreas@sandberg.pp.se    ret = context.TryCompile(text, extension=".cc")
9069986Sandreas@sandberg.pp.se    context.Result(ret)
9079986Sandreas@sandberg.pp.se    return ret
9089986Sandreas@sandberg.pp.se
9092638Sstever@eecs.umich.edu# Platform-specific configuration.  Note again that we assume that all
9102638Sstever@eecs.umich.edu# builds under a given build root run on the same host platform.
9116121Snate@binkert.orgconf = Configure(main,
9123716Sstever@eecs.umich.edu                 conf_dir = joinpath(build_root, '.scons_config'),
9135522Snate@binkert.org                 log_file = joinpath(build_root, 'scons_config.log'),
9149986Sandreas@sandberg.pp.se                 custom_tests = {
9159986Sandreas@sandberg.pp.se        'CheckMember' : CheckMember,
9169986Sandreas@sandberg.pp.se        })
9175522Snate@binkert.org
9185227Ssaidi@eecs.umich.edu# Check if we should compile a 64 bit binary on Mac OS X/Darwin
9195227Ssaidi@eecs.umich.edutry:
9205227Ssaidi@eecs.umich.edu    import platform
9215227Ssaidi@eecs.umich.edu    uname = platform.uname()
9226654Snate@binkert.org    if uname[0] == 'Darwin' and compareVersions(uname[2], '9.0.0') >= 0:
9236654Snate@binkert.org        if int(readCommand('sysctl -n hw.cpu64bit_capable')[0]):
9247769SAli.Saidi@ARM.com            main.Append(CCFLAGS=['-arch', 'x86_64'])
9257769SAli.Saidi@ARM.com            main.Append(CFLAGS=['-arch', 'x86_64'])
9267769SAli.Saidi@ARM.com            main.Append(LINKFLAGS=['-arch', 'x86_64'])
9277769SAli.Saidi@ARM.com            main.Append(ASFLAGS=['-arch', 'x86_64'])
9285227Ssaidi@eecs.umich.eduexcept:
9295227Ssaidi@eecs.umich.edu    pass
9305227Ssaidi@eecs.umich.edu
9315204Sstever@gmail.com# Recent versions of scons substitute a "Null" object for Configure()
9325204Sstever@gmail.com# when configuration isn't necessary, e.g., if the "--help" option is
9335204Sstever@gmail.com# present.  Unfortuantely this Null object always returns false,
9345204Sstever@gmail.com# breaking all our configuration checks.  We replace it with our own
9355204Sstever@gmail.com# more optimistic null object that returns True instead.
9365204Sstever@gmail.comif not conf:
9375204Sstever@gmail.com    def NullCheck(*args, **kwargs):
9385204Sstever@gmail.com        return True
9395204Sstever@gmail.com
9405204Sstever@gmail.com    class NullConf:
9415204Sstever@gmail.com        def __init__(self, env):
9425204Sstever@gmail.com            self.env = env
9435204Sstever@gmail.com        def Finish(self):
9445204Sstever@gmail.com            return self.env
9455204Sstever@gmail.com        def __getattr__(self, mname):
9465204Sstever@gmail.com            return NullCheck
9475204Sstever@gmail.com
9486121Snate@binkert.org    conf = NullConf(main)
9495204Sstever@gmail.com
9507727SAli.Saidi@ARM.com# Cache build files in the supplied directory.
9517727SAli.Saidi@ARM.comif main['M5_BUILD_CACHE']:
9527727SAli.Saidi@ARM.com    print 'Using build cache located at', main['M5_BUILD_CACHE']
9537727SAli.Saidi@ARM.com    CacheDir(main['M5_BUILD_CACHE'])
9547727SAli.Saidi@ARM.com
95511988Sandreas.sandberg@arm.commain['USE_PYTHON'] = not GetOption('without_python')
95611988Sandreas.sandberg@arm.comif main['USE_PYTHON']:
95710453SAndrew.Bardsley@arm.com    # Find Python include and library directories for embedding the
95810453SAndrew.Bardsley@arm.com    # interpreter. We rely on python-config to resolve the appropriate
95910453SAndrew.Bardsley@arm.com    # includes and linker flags. ParseConfig does not seem to understand
96010453SAndrew.Bardsley@arm.com    # the more exotic linker flags such as -Xlinker and -export-dynamic so
96110453SAndrew.Bardsley@arm.com    # we add them explicitly below. If you want to link in an alternate
96210453SAndrew.Bardsley@arm.com    # version of python, see above for instructions on how to invoke
96310453SAndrew.Bardsley@arm.com    # scons with the appropriate PATH set.
96410453SAndrew.Bardsley@arm.com    #
96510453SAndrew.Bardsley@arm.com    # First we check if python2-config exists, else we use python-config
96610453SAndrew.Bardsley@arm.com    python_config = readCommand(['which', 'python2-config'],
96710160Sandreas.hansson@arm.com                                exception='').strip()
96810453SAndrew.Bardsley@arm.com    if not os.path.exists(python_config):
96910453SAndrew.Bardsley@arm.com        python_config = readCommand(['which', 'python-config'],
97010453SAndrew.Bardsley@arm.com                                    exception='').strip()
97110453SAndrew.Bardsley@arm.com    py_includes = readCommand([python_config, '--includes'],
97210453SAndrew.Bardsley@arm.com                              exception='').split()
97310453SAndrew.Bardsley@arm.com    # Strip the -I from the include folders before adding them to the
97410453SAndrew.Bardsley@arm.com    # CPPPATH
97510453SAndrew.Bardsley@arm.com    main.Append(CPPPATH=map(lambda inc: inc[2:], py_includes))
9769812Sandreas.hansson@arm.com
97710453SAndrew.Bardsley@arm.com    # Read the linker flags and split them into libraries and other link
97810453SAndrew.Bardsley@arm.com    # flags. The libraries are added later through the call the CheckLib.
97910453SAndrew.Bardsley@arm.com    py_ld_flags = readCommand([python_config, '--ldflags'],
98010453SAndrew.Bardsley@arm.com        exception='').split()
98110453SAndrew.Bardsley@arm.com    py_libs = []
98210453SAndrew.Bardsley@arm.com    for lib in py_ld_flags:
98310453SAndrew.Bardsley@arm.com         if not lib.startswith('-l'):
98410453SAndrew.Bardsley@arm.com             main.Append(LINKFLAGS=[lib])
98510453SAndrew.Bardsley@arm.com         else:
98610453SAndrew.Bardsley@arm.com             lib = lib[2:]
98710453SAndrew.Bardsley@arm.com             if lib not in py_libs:
98810453SAndrew.Bardsley@arm.com                 py_libs.append(lib)
9897727SAli.Saidi@ARM.com
99010453SAndrew.Bardsley@arm.com    # verify that this stuff works
99110453SAndrew.Bardsley@arm.com    if not conf.CheckHeader('Python.h', '<>'):
99210453SAndrew.Bardsley@arm.com        print "Error: can't find Python.h header in", py_includes
99310453SAndrew.Bardsley@arm.com        print "Install Python headers (package python-dev on Ubuntu and RedHat)"
99410453SAndrew.Bardsley@arm.com        Exit(1)
9953118Sstever@eecs.umich.edu
99610453SAndrew.Bardsley@arm.com    for lib in py_libs:
99710453SAndrew.Bardsley@arm.com        if not conf.CheckLib(lib):
99810453SAndrew.Bardsley@arm.com            print "Error: can't find library %s required by python" % lib
99910453SAndrew.Bardsley@arm.com            Exit(1)
10003118Sstever@eecs.umich.edu
10013483Ssaidi@eecs.umich.edu# On Solaris you need to use libsocket for socket ops
10023494Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader(None, 'sys/socket.h', 'C++', 'accept(0,0,0);'):
10033494Ssaidi@eecs.umich.edu   if not conf.CheckLibWithHeader('socket', 'sys/socket.h', 'C++', 'accept(0,0,0);'):
10043483Ssaidi@eecs.umich.edu       print "Can't find library with socket calls (e.g. accept())"
10053483Ssaidi@eecs.umich.edu       Exit(1)
10063483Ssaidi@eecs.umich.edu
10073053Sstever@eecs.umich.edu# Check for zlib.  If the check passes, libz will be automatically
10083053Sstever@eecs.umich.edu# added to the LIBS environment variable.
10093918Ssaidi@eecs.umich.eduif not conf.CheckLibWithHeader('z', 'zlib.h', 'C++','zlibVersion();'):
10103053Sstever@eecs.umich.edu    print 'Error: did not find needed zlib compression library '\
10113053Sstever@eecs.umich.edu          'and/or zlib.h header file.'
10123053Sstever@eecs.umich.edu    print '       Please install zlib and try again.'
10133053Sstever@eecs.umich.edu    Exit(1)
10143053Sstever@eecs.umich.edu
10159396Sandreas.hansson@arm.com# If we have the protobuf compiler, also make sure we have the
10169396Sandreas.hansson@arm.com# development libraries. If the check passes, libprotobuf will be
10179396Sandreas.hansson@arm.com# automatically added to the LIBS environment variable. After
10189396Sandreas.hansson@arm.com# this, we can use the HAVE_PROTOBUF flag to determine if we have
10199396Sandreas.hansson@arm.com# got both protoc and libprotobuf available.
10209396Sandreas.hansson@arm.commain['HAVE_PROTOBUF'] = main['PROTOC'] and \
10219396Sandreas.hansson@arm.com    conf.CheckLibWithHeader('protobuf', 'google/protobuf/message.h',
10229396Sandreas.hansson@arm.com                            'C++', 'GOOGLE_PROTOBUF_VERIFY_VERSION;')
10239396Sandreas.hansson@arm.com
10249477Sandreas.hansson@arm.com# If we have the compiler but not the library, print another warning.
10259396Sandreas.hansson@arm.comif main['PROTOC'] and not main['HAVE_PROTOBUF']:
10269477Sandreas.hansson@arm.com    print termcap.Yellow + termcap.Bold + \
10279477Sandreas.hansson@arm.com        'Warning: did not find protocol buffer library and/or headers.\n' + \
10289477Sandreas.hansson@arm.com    '       Please install libprotobuf-dev for tracing support.' + \
10299477Sandreas.hansson@arm.com    termcap.Normal
10309396Sandreas.hansson@arm.com
10317840Snate@binkert.org# Check for librt.
10327865Sgblack@eecs.umich.eduhave_posix_clock = \
10337865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader(None, 'time.h', 'C',
10347865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);') or \
10357865Sgblack@eecs.umich.edu    conf.CheckLibWithHeader('rt', 'time.h', 'C',
10367865Sgblack@eecs.umich.edu                            'clock_nanosleep(0,0,NULL,NULL);')
10377840Snate@binkert.org
10389900Sandreas@sandberg.pp.sehave_posix_timers = \
10399900Sandreas@sandberg.pp.se    conf.CheckLibWithHeader([None, 'rt'], [ 'time.h', 'signal.h' ], 'C',
10409900Sandreas@sandberg.pp.se                            'timer_create(CLOCK_MONOTONIC, NULL, NULL);')
10419900Sandreas@sandberg.pp.se
104210456SCurtis.Dunham@arm.comif not GetOption('without_tcmalloc'):
104310456SCurtis.Dunham@arm.com    if conf.CheckLib('tcmalloc'):
104410456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
104510456SCurtis.Dunham@arm.com    elif conf.CheckLib('tcmalloc_minimal'):
104610456SCurtis.Dunham@arm.com        main.Append(CCFLAGS=main['TCMALLOC_CCFLAGS'])
104710456SCurtis.Dunham@arm.com    else:
104810456SCurtis.Dunham@arm.com        print termcap.Yellow + termcap.Bold + \
104910456SCurtis.Dunham@arm.com              "You can get a 12% performance improvement by "\
105010456SCurtis.Dunham@arm.com              "installing tcmalloc (libgoogle-perftools-dev package "\
105110456SCurtis.Dunham@arm.com              "on Ubuntu or RedHat)." + termcap.Normal
10529045SAli.Saidi@ARM.com
105311235Sandreas.sandberg@arm.com
105411235Sandreas.sandberg@arm.com# Detect back trace implementations. The last implementation in the
105511235Sandreas.sandberg@arm.com# list will be used by default.
105611235Sandreas.sandberg@arm.combacktrace_impls = [ "none" ]
105711235Sandreas.sandberg@arm.com
105811235Sandreas.sandberg@arm.comif conf.CheckLibWithHeader(None, 'execinfo.h', 'C',
105911235Sandreas.sandberg@arm.com                           'backtrace_symbols_fd((void*)0, 0, 0);'):
106011235Sandreas.sandberg@arm.com    backtrace_impls.append("glibc")
106111811Sbaz21@cam.ac.ukelif conf.CheckLibWithHeader('execinfo', 'execinfo.h', 'C',
106211811Sbaz21@cam.ac.uk                           'backtrace_symbols_fd((void*)0, 0, 0);'):
106311811Sbaz21@cam.ac.uk    # NetBSD and FreeBSD need libexecinfo.
106411811Sbaz21@cam.ac.uk    backtrace_impls.append("glibc")
106511811Sbaz21@cam.ac.uk    main.Append(LIBS=['execinfo'])
106611235Sandreas.sandberg@arm.com
106711235Sandreas.sandberg@arm.comif backtrace_impls[-1] == "none":
106811235Sandreas.sandberg@arm.com    default_backtrace_impl = "none"
106911235Sandreas.sandberg@arm.com    print termcap.Yellow + termcap.Bold + \
107011235Sandreas.sandberg@arm.com        "No suitable back trace implementation found." + \
107111235Sandreas.sandberg@arm.com        termcap.Normal
107211235Sandreas.sandberg@arm.com
10737840Snate@binkert.orgif not have_posix_clock:
10747840Snate@binkert.org    print "Can't find library for POSIX clocks."
10757840Snate@binkert.org
10761858SN/A# Check for <fenv.h> (C99 FP environment control)
10771858SN/Ahave_fenv = conf.CheckHeader('fenv.h', '<>')
10781858SN/Aif not have_fenv:
10791858SN/A    print "Warning: Header file <fenv.h> not found."
10801858SN/A    print "         This host has no IEEE FP rounding mode control."
10811858SN/A
108212230Sgiacomo.travaglini@arm.com# Check for <png.h> (libpng library needed if wanting to dump
108312230Sgiacomo.travaglini@arm.com# frame buffer image in png format)
108412230Sgiacomo.travaglini@arm.comhave_png = conf.CheckHeader('png.h', '<>')
108512230Sgiacomo.travaglini@arm.comif not have_png:
108612230Sgiacomo.travaglini@arm.com    print "Warning: Header file <png.h> not found."
108712230Sgiacomo.travaglini@arm.com    print "         This host has no libpng library."
108812230Sgiacomo.travaglini@arm.com    print "         Disabling support for PNG framebuffers."
108912230Sgiacomo.travaglini@arm.com
10909903Sandreas.hansson@arm.com# Check if we should enable KVM-based hardware virtualization. The API
10919903Sandreas.hansson@arm.com# we rely on exists since version 2.6.36 of the kernel, but somehow
10929903Sandreas.hansson@arm.com# the KVM_API_VERSION does not reflect the change. We test for one of
10939903Sandreas.hansson@arm.com# the types as a fall back.
109410841Sandreas.sandberg@arm.comhave_kvm = conf.CheckHeader('linux/kvm.h', '<>')
10959651SAndreas.Sandberg@ARM.comif not have_kvm:
10969903Sandreas.hansson@arm.com    print "Info: Compatible header file <linux/kvm.h> not found, " \
10979651SAndreas.Sandberg@ARM.com        "disabling KVM support."
10989651SAndreas.Sandberg@ARM.com
109912056Sgabeblack@google.com# Check if the TUN/TAP driver is available.
110012056Sgabeblack@google.comhave_tuntap = conf.CheckHeader('linux/if_tun.h', '<>')
110112056Sgabeblack@google.comif not have_tuntap:
110212056Sgabeblack@google.com    print "Info: Compatible header file <linux/if_tun.h> not found."
110312056Sgabeblack@google.com
110410841Sandreas.sandberg@arm.com# x86 needs support for xsave. We test for the structure here since we
110510841Sandreas.sandberg@arm.com# won't be able to run new tests by the time we know which ISA we're
110610841Sandreas.sandberg@arm.com# targeting.
110710841Sandreas.sandberg@arm.comhave_kvm_xsave = conf.CheckTypeSize('struct kvm_xsave',
110810841Sandreas.sandberg@arm.com                                    '#include <linux/kvm.h>') != 0
110910841Sandreas.sandberg@arm.com
11109651SAndreas.Sandberg@ARM.com# Check if the requested target ISA is compatible with the host
11119651SAndreas.Sandberg@ARM.comdef is_isa_kvm_compatible(isa):
11129651SAndreas.Sandberg@ARM.com    try:
11139651SAndreas.Sandberg@ARM.com        import platform
11149651SAndreas.Sandberg@ARM.com        host_isa = platform.machine()
11159651SAndreas.Sandberg@ARM.com    except:
11169651SAndreas.Sandberg@ARM.com        print "Warning: Failed to determine host ISA."
11179651SAndreas.Sandberg@ARM.com        return False
11189651SAndreas.Sandberg@ARM.com
111910841Sandreas.sandberg@arm.com    if not have_posix_timers:
112010841Sandreas.sandberg@arm.com        print "Warning: Can not enable KVM, host seems to lack support " \
112110841Sandreas.sandberg@arm.com            "for POSIX timers"
112210841Sandreas.sandberg@arm.com        return False
112310841Sandreas.sandberg@arm.com
112410841Sandreas.sandberg@arm.com    if isa == "arm":
112510860Sandreas.sandberg@arm.com        return host_isa in ( "armv7l", "aarch64" )
112610841Sandreas.sandberg@arm.com    elif isa == "x86":
112710841Sandreas.sandberg@arm.com        if host_isa != "x86_64":
112810841Sandreas.sandberg@arm.com            return False
112910841Sandreas.sandberg@arm.com
113010841Sandreas.sandberg@arm.com        if not have_kvm_xsave:
113110841Sandreas.sandberg@arm.com            print "KVM on x86 requires xsave support in kernel headers."
113210841Sandreas.sandberg@arm.com            return False
113310841Sandreas.sandberg@arm.com
113410841Sandreas.sandberg@arm.com        return True
113510841Sandreas.sandberg@arm.com    else:
113610841Sandreas.sandberg@arm.com        return False
11379651SAndreas.Sandberg@ARM.com
11389651SAndreas.Sandberg@ARM.com
11399986Sandreas@sandberg.pp.se# Check if the exclude_host attribute is available. We want this to
11409986Sandreas@sandberg.pp.se# get accurate instruction counts in KVM.
11419986Sandreas@sandberg.pp.semain['HAVE_PERF_ATTR_EXCLUDE_HOST'] = conf.CheckMember(
11429986Sandreas@sandberg.pp.se    'linux/perf_event.h', 'struct perf_event_attr', 'exclude_host')
11439986Sandreas@sandberg.pp.se
11449986Sandreas@sandberg.pp.se
11455863Snate@binkert.org######################################################################
11465863Snate@binkert.org#
11475863Snate@binkert.org# Finish the configuration
11485863Snate@binkert.org#
11496121Snate@binkert.orgmain = conf.Finish()
11501858SN/A
11515863Snate@binkert.org######################################################################
11525863Snate@binkert.org#
11535863Snate@binkert.org# Collect all non-global variables
11545863Snate@binkert.org#
11555863Snate@binkert.org
11562139SN/A# Define the universe of supported ISAs
11574202Sbinkertn@umich.eduall_isa_list = [ ]
115811308Santhony.gutierrez@amd.comall_gpu_isa_list = [ ]
11594202Sbinkertn@umich.eduExport('all_isa_list')
116011308Santhony.gutierrez@amd.comExport('all_gpu_isa_list')
11612139SN/A
11626994Snate@binkert.orgclass CpuModel(object):
11636994Snate@binkert.org    '''The CpuModel class encapsulates everything the ISA parser needs to
11646994Snate@binkert.org    know about a particular CPU model.'''
11656994Snate@binkert.org
11666994Snate@binkert.org    # Dict of available CPU model objects.  Accessible as CpuModel.dict.
11676994Snate@binkert.org    dict = {}
11686994Snate@binkert.org
11696994Snate@binkert.org    # Constructor.  Automatically adds models to CpuModel.dict.
117010319SAndreas.Sandberg@ARM.com    def __init__(self, name, default=False):
11716994Snate@binkert.org        self.name = name           # name of model
11726994Snate@binkert.org
11736994Snate@binkert.org        # This cpu is enabled by default
11746994Snate@binkert.org        self.default = default
11756994Snate@binkert.org
11766994Snate@binkert.org        # Add self to dict
11776994Snate@binkert.org        if name in CpuModel.dict:
11786994Snate@binkert.org            raise AttributeError, "CpuModel '%s' already registered" % name
11796994Snate@binkert.org        CpuModel.dict[name] = self
11806994Snate@binkert.org
11816994Snate@binkert.orgExport('CpuModel')
11822155SN/A
11835863Snate@binkert.org# Sticky variables get saved in the variables file so they persist from
11841869SN/A# one invocation to the next (unless overridden, in which case the new
11851869SN/A# value becomes sticky).
11865863Snate@binkert.orgsticky_vars = Variables(args=ARGUMENTS)
11875863Snate@binkert.orgExport('sticky_vars')
11884202Sbinkertn@umich.edu
11896108Snate@binkert.org# Sticky variables that should be exported
11906108Snate@binkert.orgexport_vars = []
11916108Snate@binkert.orgExport('export_vars')
11926108Snate@binkert.org
11939219Spower.jg@gmail.com# For Ruby
11949219Spower.jg@gmail.comall_protocols = []
11959219Spower.jg@gmail.comExport('all_protocols')
11969219Spower.jg@gmail.comprotocol_dirs = []
11979219Spower.jg@gmail.comExport('protocol_dirs')
11989219Spower.jg@gmail.comslicc_includes = []
11999219Spower.jg@gmail.comExport('slicc_includes')
12009219Spower.jg@gmail.com
12014202Sbinkertn@umich.edu# Walk the tree and execute all SConsopts scripts that wil add to the
12025863Snate@binkert.org# above variables
120310135SCurtis.Dunham@arm.comif GetOption('verbose'):
12048474Sgblack@eecs.umich.edu    print "Reading SConsopts"
12055742Snate@binkert.orgfor bdir in [ base_dir ] + extras_dir_list:
12068268Ssteve.reinhardt@amd.com    if not isdir(bdir):
12078268Ssteve.reinhardt@amd.com        print "Error: directory '%s' does not exist" % bdir
12088268Ssteve.reinhardt@amd.com        Exit(1)
12095742Snate@binkert.org    for root, dirs, files in os.walk(bdir):
12105341Sstever@gmail.com        if 'SConsopts' in files:
12118474Sgblack@eecs.umich.edu            if GetOption('verbose'):
12128474Sgblack@eecs.umich.edu                print "Reading", joinpath(root, 'SConsopts')
12135342Sstever@gmail.com            SConscript(joinpath(root, 'SConsopts'))
12144202Sbinkertn@umich.edu
12154202Sbinkertn@umich.eduall_isa_list.sort()
121611308Santhony.gutierrez@amd.comall_gpu_isa_list.sort()
12174202Sbinkertn@umich.edu
12185863Snate@binkert.orgsticky_vars.AddVariables(
12195863Snate@binkert.org    EnumVariable('TARGET_ISA', 'Target ISA', 'alpha', all_isa_list),
122011308Santhony.gutierrez@amd.com    EnumVariable('TARGET_GPU_ISA', 'Target GPU ISA', 'hsail', all_gpu_isa_list),
12216994Snate@binkert.org    ListVariable('CPU_MODELS', 'CPU models',
12226994Snate@binkert.org                 sorted(n for n,m in CpuModel.dict.iteritems() if m.default),
122310319SAndreas.Sandberg@ARM.com                 sorted(CpuModel.dict.keys())),
12245863Snate@binkert.org    BoolVariable('EFENCE', 'Link with Electric Fence malloc debugger',
12255863Snate@binkert.org                 False),
12265863Snate@binkert.org    BoolVariable('SS_COMPATIBLE_FP',
12275863Snate@binkert.org                 'Make floating-point results compatible with SimpleScalar',
12285863Snate@binkert.org                 False),
12295863Snate@binkert.org    BoolVariable('USE_SSE2',
12305863Snate@binkert.org                 'Compile for SSE2 (-msse2) to get IEEE FP on x86 hosts',
12315863Snate@binkert.org                 False),
12327840Snate@binkert.org    BoolVariable('USE_POSIX_CLOCK', 'Use POSIX Clocks', have_posix_clock),
12335863Snate@binkert.org    BoolVariable('USE_FENV', 'Use <fenv.h> IEEE mode control', have_fenv),
123412230Sgiacomo.travaglini@arm.com    BoolVariable('USE_PNG',  'Enable support for PNG images', have_png),
123512230Sgiacomo.travaglini@arm.com    BoolVariable('CP_ANNOTATE', 'Enable critical path annotation capability',
123612230Sgiacomo.travaglini@arm.com                 False),
123712230Sgiacomo.travaglini@arm.com    BoolVariable('USE_KVM', 'Enable hardware virtualized (KVM) CPU models',
123812230Sgiacomo.travaglini@arm.com                 have_kvm),
123912056Sgabeblack@google.com    BoolVariable('USE_TUNTAP',
124012056Sgabeblack@google.com                 'Enable using a tap device to bridge to the host network',
124112056Sgabeblack@google.com                 have_tuntap),
124211308Santhony.gutierrez@amd.com    BoolVariable('BUILD_GPU', 'Build the compute-GPU model', False),
12439219Spower.jg@gmail.com    EnumVariable('PROTOCOL', 'Coherence protocol for Ruby', 'None',
12449219Spower.jg@gmail.com                  all_protocols),
124511235Sandreas.sandberg@arm.com    EnumVariable('BACKTRACE_IMPL', 'Post-mortem dump implementation',
124611235Sandreas.sandberg@arm.com                 backtrace_impls[-1], backtrace_impls)
12471869SN/A    )
12481858SN/A
12495863Snate@binkert.org# These variables get exported to #defines in config/*.hh (see src/SConscript).
125011308Santhony.gutierrez@amd.comexport_vars += ['USE_FENV', 'SS_COMPATIBLE_FP', 'TARGET_ISA', 'TARGET_GPU_ISA',
125112061Sjason@lowepower.com                'CP_ANNOTATE', 'USE_POSIX_CLOCK', 'USE_KVM', 'USE_TUNTAP',
125212230Sgiacomo.travaglini@arm.com                'PROTOCOL', 'HAVE_PROTOBUF', 'HAVE_PERF_ATTR_EXCLUDE_HOST',
125312230Sgiacomo.travaglini@arm.com                'USE_PNG']
12541858SN/A
1255955SN/A###################################################
1256955SN/A#
12571869SN/A# Define a SCons builder for configuration flag headers.
12581869SN/A#
12591869SN/A###################################################
12601869SN/A
12611869SN/A# This function generates a config header file that #defines the
12625863Snate@binkert.org# variable symbol to the current variable setting (0 or 1).  The source
12635863Snate@binkert.org# operands are the name of the variable and a Value node containing the
12645863Snate@binkert.org# value of the variable.
12651869SN/Adef build_config_file(target, source, env):
12665863Snate@binkert.org    (variable, value) = [s.get_contents() for s in source]
12671869SN/A    f = file(str(target[0]), 'w')
12685863Snate@binkert.org    print >> f, '#define', variable, value
12691869SN/A    f.close()
12701869SN/A    return None
12711869SN/A
12721869SN/A# Combine the two functions into a scons Action object.
12738483Sgblack@eecs.umich.educonfig_action = MakeAction(build_config_file, Transform("CONFIG H", 2))
12741869SN/A
12751869SN/A# The emitter munges the source & target node lists to reflect what
12761869SN/A# we're really doing.
12771869SN/Adef config_emitter(target, source, env):
12785863Snate@binkert.org    # extract variable name from Builder arg
12795863Snate@binkert.org    variable = str(target[0])
12801869SN/A    # True target is config header file
12815863Snate@binkert.org    target = joinpath('config', variable.lower() + '.hh')
12825863Snate@binkert.org    val = env[variable]
12833356Sbinkertn@umich.edu    if isinstance(val, bool):
12843356Sbinkertn@umich.edu        # Force value to 0/1
12853356Sbinkertn@umich.edu        val = int(val)
12863356Sbinkertn@umich.edu    elif isinstance(val, str):
12873356Sbinkertn@umich.edu        val = '"' + val + '"'
12884781Snate@binkert.org
12895863Snate@binkert.org    # Sources are variable name & value (packaged in SCons Value nodes)
12905863Snate@binkert.org    return ([target], [Value(variable), Value(val)])
12911869SN/A
12921869SN/Aconfig_builder = Builder(emitter = config_emitter, action = config_action)
12931869SN/A
12946121Snate@binkert.orgmain.Append(BUILDERS = { 'ConfigFile' : config_builder })
12951869SN/A
129611982Sgabeblack@google.com###################################################
129711982Sgabeblack@google.com#
129811982Sgabeblack@google.com# Builders for static and shared partially linked object files.
129911982Sgabeblack@google.com#
130011982Sgabeblack@google.com###################################################
130111982Sgabeblack@google.com
130211982Sgabeblack@google.compartial_static_builder = Builder(action=SCons.Defaults.LinkAction,
130311982Sgabeblack@google.com                                 src_suffix='$OBJSUFFIX',
130411982Sgabeblack@google.com                                 src_builder=['StaticObject', 'Object'],
130511982Sgabeblack@google.com                                 LINKFLAGS='$PLINKFLAGS',
130611982Sgabeblack@google.com                                 LIBS='')
130711982Sgabeblack@google.com
130811982Sgabeblack@google.comdef partial_shared_emitter(target, source, env):
130911982Sgabeblack@google.com    for tgt in target:
131011982Sgabeblack@google.com        tgt.attributes.shared = 1
131111982Sgabeblack@google.com    return (target, source)
131211982Sgabeblack@google.compartial_shared_builder = Builder(action=SCons.Defaults.ShLinkAction,
131311982Sgabeblack@google.com                                 emitter=partial_shared_emitter,
131411982Sgabeblack@google.com                                 src_suffix='$SHOBJSUFFIX',
131511982Sgabeblack@google.com                                 src_builder='SharedObject',
131611982Sgabeblack@google.com                                 SHLINKFLAGS='$PSHLINKFLAGS',
131711982Sgabeblack@google.com                                 LIBS='')
131811982Sgabeblack@google.com
131911982Sgabeblack@google.commain.Append(BUILDERS = { 'PartialShared' : partial_shared_builder,
132011982Sgabeblack@google.com                         'PartialStatic' : partial_static_builder })
132111982Sgabeblack@google.com
132211978Sgabeblack@google.com# builds in ext are shared across all configs in the build root.
132311978Sgabeblack@google.comext_dir = abspath(joinpath(str(main.root), 'ext'))
132412034Sgabeblack@google.comext_build_dirs = []
132511978Sgabeblack@google.comfor root, dirs, files in os.walk(ext_dir):
132611978Sgabeblack@google.com    if 'SConscript' in files:
132711978Sgabeblack@google.com        build_dir = os.path.relpath(root, ext_dir)
132812034Sgabeblack@google.com        ext_build_dirs.append(build_dir)
132911978Sgabeblack@google.com        main.SConscript(joinpath(root, 'SConscript'),
133011978Sgabeblack@google.com                        variant_dir=joinpath(build_root, build_dir))
133110915Sandreas.sandberg@arm.com
133211986Sandreas.sandberg@arm.commain.Prepend(CPPPATH=Dir('ext/pybind11/include/'))
133311986Sandreas.sandberg@arm.com
13341869SN/A###################################################
13351869SN/A#
133612015Sgabeblack@google.com# This builder and wrapper method are used to set up a directory with
133712015Sgabeblack@google.com# switching headers. Those are headers which are in a generic location and
133812015Sgabeblack@google.com# that include more specific headers from a directory chosen at build time
133912015Sgabeblack@google.com# based on the current build settings.
13403546Sgblack@eecs.umich.edu#
13413546Sgblack@eecs.umich.edu###################################################
13423546Sgblack@eecs.umich.edu
134312015Sgabeblack@google.comdef build_switching_header(target, source, env):
134412015Sgabeblack@google.com    path = str(target[0])
134512015Sgabeblack@google.com    subdir = str(source[0])
134612015Sgabeblack@google.com    dp, fp = os.path.split(path)
134712015Sgabeblack@google.com    dp = os.path.relpath(os.path.realpath(dp),
134812015Sgabeblack@google.com                         os.path.realpath(env['BUILDDIR']))
134912015Sgabeblack@google.com    with open(path, 'w') as hdr:
135012015Sgabeblack@google.com        print >>hdr, '#include "%s/%s/%s"' % (dp, subdir, fp)
13513546Sgblack@eecs.umich.edu
135212015Sgabeblack@google.comswitching_header_action = MakeAction(build_switching_header,
135312015Sgabeblack@google.com                                     Transform('GENERATE'))
135410196SCurtis.Dunham@arm.com
135512015Sgabeblack@google.comswitching_header_builder = Builder(action=switching_header_action,
135612015Sgabeblack@google.com                                   source_factory=Value,
135712015Sgabeblack@google.com                                   single_source=True)
135812015Sgabeblack@google.com
135912015Sgabeblack@google.commain.Append(BUILDERS = { 'SwitchingHeader': switching_header_builder })
136012015Sgabeblack@google.com
136112015Sgabeblack@google.comdef switching_headers(self, headers, source):
136212015Sgabeblack@google.com    for header in headers:
136312015Sgabeblack@google.com        self.SwitchingHeader(header, source)
136412015Sgabeblack@google.com
136512015Sgabeblack@google.commain.AddMethod(switching_headers, 'SwitchingHeaders')
13663546Sgblack@eecs.umich.edu
13673546Sgblack@eecs.umich.edu###################################################
13683546Sgblack@eecs.umich.edu#
1369955SN/A# Define build environments for selected configurations.
1370955SN/A#
1371955SN/A###################################################
1372955SN/A
13735863Snate@binkert.orgfor variant_path in variant_paths:
137410135SCurtis.Dunham@arm.com    if not GetOption('silent'):
137510135SCurtis.Dunham@arm.com        print "Building in", variant_path
13765343Sstever@gmail.com
13775343Sstever@gmail.com    # Make a copy of the build-root environment to use for this config.
13786121Snate@binkert.org    env = main.Clone()
13795863Snate@binkert.org    env['BUILDDIR'] = variant_path
13804773Snate@binkert.org
13815863Snate@binkert.org    # variant_dir is the tail component of build path, and is used to
13822632Sstever@eecs.umich.edu    # determine the build parameters (e.g., 'ALPHA_SE')
13835863Snate@binkert.org    (build_root, variant_dir) = splitpath(variant_path)
13842023SN/A
13855863Snate@binkert.org    # Set env variables according to the build directory config.
13865863Snate@binkert.org    sticky_vars.files = []
13875863Snate@binkert.org    # Variables for $BUILD_ROOT/$VARIANT_DIR are stored in
13885863Snate@binkert.org    # $BUILD_ROOT/variables/$VARIANT_DIR so you can nuke
13895863Snate@binkert.org    # $BUILD_ROOT/$VARIANT_DIR without losing your variables settings.
13905863Snate@binkert.org    current_vars_file = joinpath(build_root, 'variables', variant_dir)
13915863Snate@binkert.org    if isfile(current_vars_file):
13925863Snate@binkert.org        sticky_vars.files.append(current_vars_file)
139310135SCurtis.Dunham@arm.com        if not GetOption('silent'):
139410135SCurtis.Dunham@arm.com            print "Using saved variables file %s" % current_vars_file
139512034Sgabeblack@google.com    elif variant_dir in ext_build_dirs:
139612034Sgabeblack@google.com        # Things in ext are built without a variant directory.
139712034Sgabeblack@google.com        continue
13982632Sstever@eecs.umich.edu    else:
13995863Snate@binkert.org        # Build dir-specific variables file doesn't exist.
14002023SN/A
14012632Sstever@eecs.umich.edu        # Make sure the directory is there so we can create it later
14025863Snate@binkert.org        opt_dir = dirname(current_vars_file)
14035342Sstever@gmail.com        if not isdir(opt_dir):
14045863Snate@binkert.org            mkdir(opt_dir)
14052632Sstever@eecs.umich.edu
14065863Snate@binkert.org        # Get default build variables from source tree.  Variables are
14075863Snate@binkert.org        # normally determined by name of $VARIANT_DIR, but can be
14088267Ssteve.reinhardt@amd.com        # overridden by '--default=' arg on command line.
14098120Sgblack@eecs.umich.edu        default = GetOption('default')
14108267Ssteve.reinhardt@amd.com        opts_dir = joinpath(main.root.abspath, 'build_opts')
14118267Ssteve.reinhardt@amd.com        if default:
14128267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(build_root, 'variables', default),
14138267Ssteve.reinhardt@amd.com                                  joinpath(opts_dir, default)]
14148267Ssteve.reinhardt@amd.com        else:
14158267Ssteve.reinhardt@amd.com            default_vars_files = [joinpath(opts_dir, variant_dir)]
14168267Ssteve.reinhardt@amd.com        existing_files = filter(isfile, default_vars_files)
14178267Ssteve.reinhardt@amd.com        if existing_files:
14188267Ssteve.reinhardt@amd.com            default_vars_file = existing_files[0]
14195863Snate@binkert.org            sticky_vars.files.append(default_vars_file)
14205863Snate@binkert.org            print "Variables file %s not found,\n  using defaults in %s" \
14215863Snate@binkert.org                  % (current_vars_file, default_vars_file)
14222632Sstever@eecs.umich.edu        else:
14238267Ssteve.reinhardt@amd.com            print "Error: cannot find variables file %s or " \
14248267Ssteve.reinhardt@amd.com                  "default file(s) %s" \
14258267Ssteve.reinhardt@amd.com                  % (current_vars_file, ' or '.join(default_vars_files))
14262632Sstever@eecs.umich.edu            Exit(1)
14271888SN/A
14285863Snate@binkert.org    # Apply current variable settings to env
14295863Snate@binkert.org    sticky_vars.Update(env)
14301858SN/A
14318120Sgblack@eecs.umich.edu    help_texts["local_vars"] += \
14328120Sgblack@eecs.umich.edu        "Build variables for %s:\n" % variant_dir \
14337756SAli.Saidi@ARM.com                 + sticky_vars.GenerateHelpText(env)
14342598SN/A
14355863Snate@binkert.org    # Process variable settings.
14361858SN/A
14371858SN/A    if not have_fenv and env['USE_FENV']:
14381858SN/A        print "Warning: <fenv.h> not available; " \
14395863Snate@binkert.org              "forcing USE_FENV to False in", variant_dir + "."
14401858SN/A        env['USE_FENV'] = False
14411858SN/A
14421858SN/A    if not env['USE_FENV']:
14435863Snate@binkert.org        print "Warning: No IEEE FP rounding mode control in", variant_dir + "."
14441871SN/A        print "         FP results may deviate slightly from other platforms."
14451858SN/A
144612230Sgiacomo.travaglini@arm.com    if not have_png and env['USE_PNG']:
144712230Sgiacomo.travaglini@arm.com        print "Warning: <png.h> not available; " \
144812230Sgiacomo.travaglini@arm.com              "forcing USE_PNG to False in", variant_dir + "."
144912230Sgiacomo.travaglini@arm.com        env['USE_PNG'] = False
145012230Sgiacomo.travaglini@arm.com
145112230Sgiacomo.travaglini@arm.com    if env['USE_PNG']:
145212230Sgiacomo.travaglini@arm.com        env.Append(LIBS=['png'])
145312230Sgiacomo.travaglini@arm.com
14541858SN/A    if env['EFENCE']:
14551858SN/A        env.Append(LIBS=['efence'])
14561858SN/A
14579651SAndreas.Sandberg@ARM.com    if env['USE_KVM']:
14589651SAndreas.Sandberg@ARM.com        if not have_kvm:
14599651SAndreas.Sandberg@ARM.com            print "Warning: Can not enable KVM, host seems to lack KVM support"
14609651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
14619651SAndreas.Sandberg@ARM.com        elif not is_isa_kvm_compatible(env['TARGET_ISA']):
14629651SAndreas.Sandberg@ARM.com            print "Info: KVM support disabled due to unsupported host and " \
14639651SAndreas.Sandberg@ARM.com                "target ISA combination"
14649651SAndreas.Sandberg@ARM.com            env['USE_KVM'] = False
14659651SAndreas.Sandberg@ARM.com
146612056Sgabeblack@google.com    if env['USE_TUNTAP']:
146712056Sgabeblack@google.com        if not have_tuntap:
146812056Sgabeblack@google.com            print "Warning: Can't connect EtherTap with a tap device."
146912056Sgabeblack@google.com            env['USE_TUNTAP'] = False
147012056Sgabeblack@google.com
147111798Santhony.gutierrez@amd.com    if env['BUILD_GPU']:
147211798Santhony.gutierrez@amd.com        env.Append(CPPDEFINES=['BUILD_GPU'])
147311798Santhony.gutierrez@amd.com
14749986Sandreas@sandberg.pp.se    # Warn about missing optional functionality
14759986Sandreas@sandberg.pp.se    if env['USE_KVM']:
14769986Sandreas@sandberg.pp.se        if not main['HAVE_PERF_ATTR_EXCLUDE_HOST']:
14779986Sandreas@sandberg.pp.se            print "Warning: perf_event headers lack support for the " \
14789986Sandreas@sandberg.pp.se                "exclude_host attribute. KVM instruction counts will " \
14799986Sandreas@sandberg.pp.se                "be inaccurate."
14809986Sandreas@sandberg.pp.se
14815863Snate@binkert.org    # Save sticky variable settings back to current variables file
14825863Snate@binkert.org    sticky_vars.Save(current_vars_file, env)
14831869SN/A
14841965SN/A    if env['USE_SSE2']:
14857739Sgblack@eecs.umich.edu        env.Append(CCFLAGS=['-msse2'])
14861965SN/A
14872761Sstever@eecs.umich.edu    # The src/SConscript file sets up the build rules in 'env' according
14885863Snate@binkert.org    # to the configured variables.  It returns a list of environments,
14891869SN/A    # one for each variant build (debug, opt, etc.)
149010196SCurtis.Dunham@arm.com    SConscript('src/SConscript', variant_dir = variant_path, exports = 'env')
14911869SN/A
14928120Sgblack@eecs.umich.edu# base help text
14938120Sgblack@eecs.umich.eduHelp('''
14948120Sgblack@eecs.umich.eduUsage: scons [scons options] [build variables] [target(s)]
14958120Sgblack@eecs.umich.edu
14968120Sgblack@eecs.umich.eduExtra scons options:
14978120Sgblack@eecs.umich.edu%(options)s
14988120Sgblack@eecs.umich.edu
14998120Sgblack@eecs.umich.eduGlobal build variables:
15008120Sgblack@eecs.umich.edu%(global_vars)s
15018120Sgblack@eecs.umich.edu
15028120Sgblack@eecs.umich.edu%(local_vars)s
15038120Sgblack@eecs.umich.edu''' % help_texts)
1504